1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
|
# Copyright (C) 2005-2012 Canonical Ltd
# Copyright (C) 2017 Breezy Developers
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
from __future__ import absolute_import
import sys
from ..lazy_import import lazy_import
lazy_import(globals(), """
from breezy import (
cache_utf8,
config as _mod_config,
lockable_files,
lockdir,
rio,
shelf,
tag as _mod_tag,
)
""")
from . import bzrdir
from .. import (
controldir,
errors,
revision as _mod_revision,
urlutils,
)
from ..branch import (
Branch,
BranchFormat,
BranchWriteLockResult,
format_registry,
UnstackableBranchFormat,
)
from ..decorators import (
only_raises,
)
from ..lock import _RelockDebugMixin, LogicalLockResult
from ..sixish import (
BytesIO,
text_type,
viewitems,
)
from ..trace import (
mutter,
)
class BzrBranch(Branch, _RelockDebugMixin):
"""A branch stored in the actual filesystem.
Note that it's "local" in the context of the filesystem; it doesn't
really matter if it's on an nfs/smb/afs/coda/... share, as long as
it's writable, and can be accessed via the normal filesystem API.
:ivar _transport: Transport for file operations on this branch's
control files, typically pointing to the .bzr/branch directory.
:ivar repository: Repository for this branch.
:ivar base: The url of the base directory for this branch; the one
containing the .bzr directory.
:ivar name: Optional colocated branch name as it exists in the control
directory.
"""
def __init__(self, _format=None,
_control_files=None, a_controldir=None, name=None,
_repository=None, ignore_fallbacks=False,
possible_transports=None):
"""Create new branch object at a particular location."""
if a_controldir is None:
raise ValueError('a_controldir must be supplied')
if name is None:
raise ValueError('name must be supplied')
self.controldir = a_controldir
self._user_transport = self.controldir.transport.clone('..')
if name != u"":
self._user_transport.set_segment_parameter(
"branch", urlutils.escape(name))
self._base = self._user_transport.base
self.name = name
self._format = _format
if _control_files is None:
raise ValueError('BzrBranch _control_files is None')
self.control_files = _control_files
self._transport = _control_files._transport
self.repository = _repository
self.conf_store = None
Branch.__init__(self, possible_transports)
self._tags_bytes = None
def __str__(self):
return '%s(%s)' % (self.__class__.__name__, self.user_url)
__repr__ = __str__
def _get_base(self):
"""Returns the directory containing the control directory."""
return self._base
base = property(_get_base, doc="The URL for the root of this branch.")
@property
def user_transport(self):
return self._user_transport
def _get_config(self):
"""Get the concrete config for just the config in this branch.
This is not intended for client use; see Branch.get_config for the
public API.
Added in 1.14.
:return: An object supporting get_option and set_option.
"""
return _mod_config.TransportConfig(self._transport, 'branch.conf')
def _get_config_store(self):
if self.conf_store is None:
self.conf_store = _mod_config.BranchStore(self)
return self.conf_store
def _uncommitted_branch(self):
"""Return the branch that may contain uncommitted changes."""
master = self.get_master_branch()
if master is not None:
return master
else:
return self
def store_uncommitted(self, creator):
"""Store uncommitted changes from a ShelfCreator.
:param creator: The ShelfCreator containing uncommitted changes, or
None to delete any stored changes.
:raises: ChangesAlreadyStored if the branch already has changes.
"""
branch = self._uncommitted_branch()
if creator is None:
branch._transport.delete('stored-transform')
return
if branch._transport.has('stored-transform'):
raise errors.ChangesAlreadyStored
transform = BytesIO()
creator.write_shelf(transform)
transform.seek(0)
branch._transport.put_file('stored-transform', transform)
def get_unshelver(self, tree):
"""Return a shelf.Unshelver for this branch and tree.
:param tree: The tree to use to construct the Unshelver.
:return: an Unshelver or None if no changes are stored.
"""
branch = self._uncommitted_branch()
try:
transform = branch._transport.get('stored-transform')
except errors.NoSuchFile:
return None
return shelf.Unshelver.from_tree_and_shelf(tree, transform)
def is_locked(self):
return self.control_files.is_locked()
def lock_write(self, token=None):
"""Lock the branch for write operations.
:param token: A token to permit reacquiring a previously held and
preserved lock.
:return: A BranchWriteLockResult.
"""
if not self.is_locked():
self._note_lock('w')
self.repository._warn_if_deprecated(self)
self.repository.lock_write()
took_lock = True
else:
took_lock = False
try:
return BranchWriteLockResult(
self.unlock,
self.control_files.lock_write(token=token))
except BaseException:
if took_lock:
self.repository.unlock()
raise
def lock_read(self):
"""Lock the branch for read operations.
:return: A breezy.lock.LogicalLockResult.
"""
if not self.is_locked():
self._note_lock('r')
self.repository._warn_if_deprecated(self)
self.repository.lock_read()
took_lock = True
else:
took_lock = False
try:
self.control_files.lock_read()
return LogicalLockResult(self.unlock)
except BaseException:
if took_lock:
self.repository.unlock()
raise
@only_raises(errors.LockNotHeld, errors.LockBroken)
def unlock(self):
if self.control_files._lock_count == 1 and self.conf_store is not None:
self.conf_store.save_changes()
try:
self.control_files.unlock()
finally:
if not self.control_files.is_locked():
self.repository.unlock()
# we just released the lock
self._clear_cached_state()
def peek_lock_mode(self):
if self.control_files._lock_count == 0:
return None
else:
return self.control_files._lock_mode
def get_physical_lock_status(self):
return self.control_files.get_physical_lock_status()
def set_last_revision_info(self, revno, revision_id):
if not revision_id or not isinstance(revision_id, bytes):
raise errors.InvalidRevisionId(
revision_id=revision_id, branch=self)
revision_id = _mod_revision.ensure_null(revision_id)
with self.lock_write():
old_revno, old_revid = self.last_revision_info()
if self.get_append_revisions_only():
self._check_history_violation(revision_id)
self._run_pre_change_branch_tip_hooks(revno, revision_id)
self._write_last_revision_info(revno, revision_id)
self._clear_cached_state()
self._last_revision_info_cache = revno, revision_id
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
def basis_tree(self):
"""See Branch.basis_tree."""
return self.repository.revision_tree(self.last_revision())
def _get_parent_location(self):
_locs = ['parent', 'pull', 'x-pull']
for l in _locs:
try:
contents = self._transport.get_bytes(l)
except errors.NoSuchFile:
pass
else:
return contents.strip(b'\n').decode('utf-8')
return None
def get_stacked_on_url(self):
raise UnstackableBranchFormat(self._format, self.user_url)
def set_push_location(self, location):
"""See Branch.set_push_location."""
self.get_config().set_user_option(
'push_location', location,
store=_mod_config.STORE_LOCATION_NORECURSE)
def _set_parent_location(self, url):
if url is None:
self._transport.delete('parent')
else:
if isinstance(url, text_type):
url = url.encode('utf-8')
self._transport.put_bytes('parent', url + b'\n',
mode=self.controldir._get_file_mode())
def unbind(self):
"""If bound, unbind"""
with self.lock_write():
return self.set_bound_location(None)
def bind(self, other):
"""Bind this branch to the branch other.
This does not push or pull data between the branches, though it does
check for divergence to raise an error when the branches are not
either the same, or one a prefix of the other. That behaviour may not
be useful, so that check may be removed in future.
:param other: The branch to bind to
:type other: Branch
"""
# TODO: jam 20051230 Consider checking if the target is bound
# It is debatable whether you should be able to bind to
# a branch which is itself bound.
# Committing is obviously forbidden,
# but binding itself may not be.
# Since we *have* to check at commit time, we don't
# *need* to check here
# we want to raise diverged if:
# last_rev is not in the other_last_rev history, AND
# other_last_rev is not in our history, and do it without pulling
# history around
with self.lock_write():
self.set_bound_location(other.base)
def get_bound_location(self):
try:
return self._transport.get_bytes('bound')[:-1].decode('utf-8')
except errors.NoSuchFile:
return None
def get_master_branch(self, possible_transports=None):
"""Return the branch we are bound to.
:return: Either a Branch, or None
"""
with self.lock_read():
if self._master_branch_cache is None:
self._master_branch_cache = self._get_master_branch(
possible_transports)
return self._master_branch_cache
def _get_master_branch(self, possible_transports):
bound_loc = self.get_bound_location()
if not bound_loc:
return None
try:
return Branch.open(bound_loc,
possible_transports=possible_transports)
except (errors.NotBranchError, errors.ConnectionError) as e:
raise errors.BoundBranchConnectionFailure(
self, bound_loc, e)
def set_bound_location(self, location):
"""Set the target where this branch is bound to.
:param location: URL to the target branch
"""
with self.lock_write():
self._master_branch_cache = None
if location:
self._transport.put_bytes(
'bound', location.encode('utf-8') + b'\n',
mode=self.controldir._get_file_mode())
else:
try:
self._transport.delete('bound')
except errors.NoSuchFile:
return False
return True
def update(self, possible_transports=None):
"""Synchronise this branch with the master branch if any.
:return: None or the last_revision that was pivoted out during the
update.
"""
with self.lock_write():
master = self.get_master_branch(possible_transports)
if master is not None:
old_tip = _mod_revision.ensure_null(self.last_revision())
self.pull(master, overwrite=True)
if self.repository.get_graph().is_ancestor(
old_tip, _mod_revision.ensure_null(
self.last_revision())):
return None
return old_tip
return None
def _read_last_revision_info(self):
revision_string = self._transport.get_bytes('last-revision')
revno, revision_id = revision_string.rstrip(b'\n').split(b' ', 1)
revision_id = cache_utf8.get_cached_utf8(revision_id)
revno = int(revno)
return revno, revision_id
def _write_last_revision_info(self, revno, revision_id):
"""Simply write out the revision id, with no checks.
Use set_last_revision_info to perform this safely.
Does not update the revision_history cache.
"""
revision_id = _mod_revision.ensure_null(revision_id)
out_string = b'%d %s\n' % (revno, revision_id)
self._transport.put_bytes('last-revision', out_string,
mode=self.controldir._get_file_mode())
def update_feature_flags(self, updated_flags):
"""Update the feature flags for this branch.
:param updated_flags: Dictionary mapping feature names to necessities
A necessity can be None to indicate the feature should be removed
"""
with self.lock_write():
self._format._update_feature_flags(updated_flags)
self.control_transport.put_bytes(
'format', self._format.as_string())
def _get_tags_bytes(self):
"""Get the bytes of a serialised tags dict.
Note that not all branches support tags, nor do all use the same tags
logic: this method is specific to BasicTags. Other tag implementations
may use the same method name and behave differently, safely, because
of the double-dispatch via
format.make_tags->tags_instance->get_tags_dict.
:return: The bytes of the tags file.
:seealso: Branch._set_tags_bytes.
"""
with self.lock_read():
if self._tags_bytes is None:
self._tags_bytes = self._transport.get_bytes('tags')
return self._tags_bytes
def _set_tags_bytes(self, bytes):
"""Mirror method for _get_tags_bytes.
:seealso: Branch._get_tags_bytes.
"""
with self.lock_write():
self._tags_bytes = bytes
return self._transport.put_bytes('tags', bytes)
def _clear_cached_state(self):
super(BzrBranch, self)._clear_cached_state()
self._tags_bytes = None
def reconcile(self, thorough=True):
"""Make sure the data stored in this branch is consistent."""
from .reconcile import BranchReconciler
with self.lock_write():
reconciler = BranchReconciler(self, thorough=thorough)
return reconciler.reconcile()
class BzrBranch8(BzrBranch):
"""A branch that stores tree-reference locations."""
def _open_hook(self, possible_transports=None):
if self._ignore_fallbacks:
return
if possible_transports is None:
possible_transports = [self.controldir.root_transport]
try:
url = self.get_stacked_on_url()
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
UnstackableBranchFormat):
pass
else:
for hook in Branch.hooks['transform_fallback_location']:
url = hook(self, url)
if url is None:
hook_name = Branch.hooks.get_hook_name(hook)
raise AssertionError(
"'transform_fallback_location' hook %s returned "
"None, not a URL." % hook_name)
self._activate_fallback_location(
url, possible_transports=possible_transports)
def __init__(self, *args, **kwargs):
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
super(BzrBranch8, self).__init__(*args, **kwargs)
self._last_revision_info_cache = None
self._reference_info = None
def _clear_cached_state(self):
super(BzrBranch8, self)._clear_cached_state()
self._last_revision_info_cache = None
self._reference_info = None
def _check_history_violation(self, revision_id):
current_revid = self.last_revision()
last_revision = _mod_revision.ensure_null(current_revid)
if _mod_revision.is_null(last_revision):
return
graph = self.repository.get_graph()
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
if lh_ancestor == current_revid:
return
raise errors.AppendRevisionsOnlyViolation(self.user_url)
def _gen_revision_history(self):
"""Generate the revision history from last revision
"""
last_revno, last_revision = self.last_revision_info()
self._extend_partial_history(stop_index=last_revno - 1)
return list(reversed(self._partial_revision_history_cache))
def _set_parent_location(self, url):
"""Set the parent branch"""
with self.lock_write():
self._set_config_location(
'parent_location', url, make_relative=True)
def _get_parent_location(self):
"""Set the parent branch"""
with self.lock_read():
return self._get_config_location('parent_location')
def _set_all_reference_info(self, info_dict):
"""Replace all reference info stored in a branch.
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
"""
s = BytesIO()
writer = rio.RioWriter(s)
for tree_path, (branch_location, file_id) in viewitems(info_dict):
stanza = rio.Stanza(tree_path=tree_path,
branch_location=branch_location)
if file_id is not None:
stanza.add('file_id', file_id)
writer.write_stanza(stanza)
with self.lock_write():
self._transport.put_bytes('references', s.getvalue())
self._reference_info = info_dict
def _get_all_reference_info(self):
"""Return all the reference info stored in a branch.
:return: A dict of {tree_path: (branch_location, file_id)}
"""
with self.lock_read():
if self._reference_info is not None:
return self._reference_info
with self._transport.get('references') as rio_file:
stanzas = rio.read_stanzas(rio_file)
info_dict = {
s['tree_path']: (
s['branch_location'],
s['file_id'].encode('ascii')
if 'file_id' in s else None)
for s in stanzas}
self._reference_info = info_dict
return info_dict
def set_reference_info(self, tree_path, branch_location, file_id=None):
"""Set the branch location to use for a tree reference.
:param tree_path: The path of the tree reference in the tree.
:param branch_location: The location of the branch to retrieve tree
references from.
:param file_id: The file-id of the tree reference.
"""
info_dict = self._get_all_reference_info()
info_dict[tree_path] = (branch_location, file_id)
if branch_location is None:
del info_dict[tree_path]
self._set_all_reference_info(info_dict)
def get_reference_info(self, path):
"""Get the tree_path and branch_location for a tree reference.
:return: a tuple of (branch_location, file_id)
"""
return self._get_all_reference_info().get(path, (None, None))
def reference_parent(self, path, file_id=None, possible_transports=None):
"""Return the parent branch for a tree-reference file_id.
:param file_id: The file_id of the tree reference
:param path: The path of the file_id in the tree
:return: A branch associated with the file_id
"""
branch_location = self.get_reference_info(path)[0]
if branch_location is None:
return Branch.reference_parent(self, path, file_id,
possible_transports)
branch_location = urlutils.join(self.user_url, branch_location)
return Branch.open(branch_location,
possible_transports=possible_transports)
def set_push_location(self, location):
"""See Branch.set_push_location."""
self._set_config_location('push_location', location)
def set_bound_location(self, location):
"""See Branch.set_push_location."""
self._master_branch_cache = None
conf = self.get_config_stack()
if location is None:
if not conf.get('bound'):
return False
else:
conf.set('bound', 'False')
return True
else:
self._set_config_location('bound_location', location,
config=conf)
conf.set('bound', 'True')
return True
def _get_bound_location(self, bound):
"""Return the bound location in the config file.
Return None if the bound parameter does not match"""
conf = self.get_config_stack()
if conf.get('bound') != bound:
return None
return self._get_config_location('bound_location', config=conf)
def get_bound_location(self):
"""See Branch.get_bound_location."""
return self._get_bound_location(True)
def get_old_bound_location(self):
"""See Branch.get_old_bound_location"""
return self._get_bound_location(False)
def get_stacked_on_url(self):
# you can always ask for the URL; but you might not be able to use it
# if the repo can't support stacking.
# self._check_stackable_repo()
# stacked_on_location is only ever defined in branch.conf, so don't
# waste effort reading the whole stack of config files.
conf = _mod_config.BranchOnlyStack(self)
stacked_url = self._get_config_location('stacked_on_location',
config=conf)
if stacked_url is None:
raise errors.NotStacked(self)
# TODO(jelmer): Clean this up for pad.lv/1696545
if sys.version_info[0] == 2:
return stacked_url.encode('utf-8')
else:
return stacked_url
def get_rev_id(self, revno, history=None):
"""Find the revision id of the specified revno."""
if revno == 0:
return _mod_revision.NULL_REVISION
with self.lock_read():
last_revno, last_revision_id = self.last_revision_info()
if revno <= 0 or revno > last_revno:
raise errors.RevnoOutOfBounds(revno, (0, last_revno))
if history is not None:
return history[revno - 1]
index = last_revno - revno
if len(self._partial_revision_history_cache) <= index:
self._extend_partial_history(stop_index=index)
if len(self._partial_revision_history_cache) > index:
return self._partial_revision_history_cache[index]
else:
raise errors.NoSuchRevision(self, revno)
def revision_id_to_revno(self, revision_id):
"""Given a revision id, return its revno"""
if _mod_revision.is_null(revision_id):
return 0
with self.lock_read():
try:
index = self._partial_revision_history_cache.index(revision_id)
except ValueError:
try:
self._extend_partial_history(stop_revision=revision_id)
except errors.RevisionNotPresent as e:
raise errors.GhostRevisionsHaveNoRevno(
revision_id, e.revision_id)
index = len(self._partial_revision_history_cache) - 1
if index < 0:
raise errors.NoSuchRevision(self, revision_id)
if self._partial_revision_history_cache[index] != revision_id:
raise errors.NoSuchRevision(self, revision_id)
return self.revno() - index
class BzrBranch7(BzrBranch8):
"""A branch with support for a fallback repository."""
def set_reference_info(self, tree_path, branch_location, file_id=None):
Branch.set_reference_info(self, file_id, tree_path, branch_location)
def get_reference_info(self, path):
Branch.get_reference_info(self, path)
def reference_parent(self, path, file_id=None, possible_transports=None):
return Branch.reference_parent(
self, path, file_id, possible_transports)
class BzrBranch6(BzrBranch7):
"""See BzrBranchFormat6 for the capabilities of this branch.
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
i.e. stacking.
"""
def get_stacked_on_url(self):
raise UnstackableBranchFormat(self._format, self.user_url)
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
"""Base class for branch formats that live in meta directories.
"""
def __init__(self):
BranchFormat.__init__(self)
bzrdir.BzrFormat.__init__(self)
@classmethod
def find_format(klass, controldir, name=None):
"""Return the format for the branch object in controldir."""
try:
transport = controldir.get_branch_transport(None, name=name)
except errors.NoSuchFile:
raise errors.NotBranchError(path=name, controldir=controldir)
try:
format_string = transport.get_bytes("format")
except errors.NoSuchFile:
raise errors.NotBranchError(
path=transport.base, controldir=controldir)
return klass._find_format(format_registry, 'branch', format_string)
def _branch_class(self):
"""What class to instantiate on open calls."""
raise NotImplementedError(self._branch_class)
def _get_initial_config(self, append_revisions_only=None):
if append_revisions_only:
return b"append_revisions_only = True\n"
else:
# Avoid writing anything if append_revisions_only is disabled,
# as that is the default.
return b""
def _initialize_helper(self, a_controldir, utf8_files, name=None,
repository=None):
"""Initialize a branch in a control dir, with specified files
:param a_controldir: The bzrdir to initialize the branch in
:param utf8_files: The files to create as a list of
(filename, content) tuples
:param name: Name of colocated branch to create, if any
:return: a branch in this format
"""
if name is None:
name = a_controldir._get_selected_branch()
mutter('creating branch %r in %s', self, a_controldir.user_url)
branch_transport = a_controldir.get_branch_transport(self, name=name)
control_files = lockable_files.LockableFiles(branch_transport,
'lock', lockdir.LockDir)
control_files.create_lock()
control_files.lock_write()
try:
utf8_files += [('format', self.as_string())]
for (filename, content) in utf8_files:
branch_transport.put_bytes(
filename, content,
mode=a_controldir._get_file_mode())
finally:
control_files.unlock()
branch = self.open(a_controldir, name, _found=True,
found_repository=repository)
self._run_post_branch_init_hooks(a_controldir, name, branch)
return branch
def open(self, a_controldir, name=None, _found=False,
ignore_fallbacks=False, found_repository=None,
possible_transports=None):
"""See BranchFormat.open()."""
if name is None:
name = a_controldir._get_selected_branch()
if not _found:
format = BranchFormatMetadir.find_format(a_controldir, name=name)
if format.__class__ != self.__class__:
raise AssertionError("wrong format %r found for %r" %
(format, self))
transport = a_controldir.get_branch_transport(None, name=name)
try:
control_files = lockable_files.LockableFiles(transport, 'lock',
lockdir.LockDir)
if found_repository is None:
found_repository = a_controldir.find_repository()
return self._branch_class()(
_format=self, _control_files=control_files, name=name,
a_controldir=a_controldir, _repository=found_repository,
ignore_fallbacks=ignore_fallbacks,
possible_transports=possible_transports)
except errors.NoSuchFile:
raise errors.NotBranchError(
path=transport.base, controldir=a_controldir)
@property
def _matchingcontroldir(self):
ret = bzrdir.BzrDirMetaFormat1()
ret.set_branch_format(self)
return ret
def supports_tags(self):
return True
def supports_leaving_lock(self):
return True
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
basedir=None):
BranchFormat.check_support_status(
self, allow_unsupported=allow_unsupported,
recommend_upgrade=recommend_upgrade, basedir=basedir)
bzrdir.BzrFormat.check_support_status(
self, allow_unsupported=allow_unsupported,
recommend_upgrade=recommend_upgrade, basedir=basedir)
class BzrBranchFormat6(BranchFormatMetadir):
"""Branch format with last-revision and tags.
Unlike previous formats, this has no explicit revision history. Instead,
this just stores the last-revision, and the left-hand history leading
up to there is the history.
This format was introduced in bzr 0.15
and became the default in 0.91.
"""
def _branch_class(self):
return BzrBranch6
@classmethod
def get_format_string(cls):
"""See BranchFormat.get_format_string()."""
return b"Bazaar Branch Format 6 (bzr 0.15)\n"
def get_format_description(self):
"""See BranchFormat.get_format_description()."""
return "Branch format 6"
def initialize(self, a_controldir, name=None, repository=None,
append_revisions_only=None):
"""Create a branch of this format in a_controldir."""
utf8_files = [
('last-revision', b'0 null:\n'),
('branch.conf', self._get_initial_config(append_revisions_only)),
('tags', b''),
]
return self._initialize_helper(
a_controldir, utf8_files, name, repository)
def make_tags(self, branch):
"""See breezy.branch.BranchFormat.make_tags()."""
return _mod_tag.BasicTags(branch)
def supports_set_append_revisions_only(self):
return True
class BzrBranchFormat8(BranchFormatMetadir):
"""Metadir format supporting storing locations of subtree branches."""
def _branch_class(self):
return BzrBranch8
@classmethod
def get_format_string(cls):
"""See BranchFormat.get_format_string()."""
return b"Bazaar Branch Format 8 (needs bzr 1.15)\n"
def get_format_description(self):
"""See BranchFormat.get_format_description()."""
return "Branch format 8"
def initialize(self, a_controldir, name=None, repository=None,
append_revisions_only=None):
"""Create a branch of this format in a_controldir."""
utf8_files = [('last-revision', b'0 null:\n'),
('branch.conf',
self._get_initial_config(append_revisions_only)),
('tags', b''),
('references', b'')
]
return self._initialize_helper(
a_controldir, utf8_files, name, repository)
def make_tags(self, branch):
"""See breezy.branch.BranchFormat.make_tags()."""
return _mod_tag.BasicTags(branch)
def supports_set_append_revisions_only(self):
return True
def supports_stacking(self):
return True
supports_reference_locations = True
class BzrBranchFormat7(BranchFormatMetadir):
"""Branch format with last-revision, tags, and a stacked location pointer.
The stacked location pointer is passed down to the repository and requires
a repository format with supports_external_lookups = True.
This format was introduced in bzr 1.6.
"""
def initialize(self, a_controldir, name=None, repository=None,
append_revisions_only=None):
"""Create a branch of this format in a_controldir."""
utf8_files = [('last-revision', b'0 null:\n'),
('branch.conf',
self._get_initial_config(append_revisions_only)),
('tags', b''),
]
return self._initialize_helper(
a_controldir, utf8_files, name, repository)
def _branch_class(self):
return BzrBranch7
@classmethod
def get_format_string(cls):
"""See BranchFormat.get_format_string()."""
return b"Bazaar Branch Format 7 (needs bzr 1.6)\n"
def get_format_description(self):
"""See BranchFormat.get_format_description()."""
return "Branch format 7"
def supports_set_append_revisions_only(self):
return True
def supports_stacking(self):
return True
def make_tags(self, branch):
"""See breezy.branch.BranchFormat.make_tags()."""
return _mod_tag.BasicTags(branch)
supports_reference_locations = False
class BranchReferenceFormat(BranchFormatMetadir):
"""Bzr branch reference format.
Branch references are used in implementing checkouts, they
act as an alias to the real branch which is at some other url.
This format has:
- A location file
- a format string
"""
@classmethod
def get_format_string(cls):
"""See BranchFormat.get_format_string()."""
return b"Bazaar-NG Branch Reference Format 1\n"
def get_format_description(self):
"""See BranchFormat.get_format_description()."""
return "Checkout reference format 1"
def get_reference(self, a_controldir, name=None):
"""See BranchFormat.get_reference()."""
transport = a_controldir.get_branch_transport(None, name=name)
url = urlutils.split_segment_parameters(a_controldir.user_url)[0]
return urlutils.join(
url, transport.get_bytes('location').decode('utf-8'))
def _write_reference(self, a_controldir, transport, to_branch):
to_url = to_branch.user_url
# Ideally, we'd write a relative path here for the benefit of colocated
# branches - so that moving a control directory doesn't break
# any references to colocated branches. Unfortunately, bzr
# does not support relative URLs. See pad.lv/1803845 -- jelmer
# to_url = urlutils.relative_url(
# a_controldir.user_url, to_branch.user_url)
transport.put_bytes('location', to_url.encode('utf-8'))
def set_reference(self, a_controldir, name, to_branch):
"""See BranchFormat.set_reference()."""
transport = a_controldir.get_branch_transport(None, name=name)
self._write_reference(a_controldir, transport, to_branch)
def initialize(self, a_controldir, name=None, target_branch=None,
repository=None, append_revisions_only=None):
"""Create a branch of this format in a_controldir."""
if target_branch is None:
# this format does not implement branch itself, thus the implicit
# creation contract must see it as uninitializable
raise errors.UninitializableFormat(self)
mutter('creating branch reference in %s', a_controldir.user_url)
if a_controldir._format.fixed_components:
raise errors.IncompatibleFormat(self, a_controldir._format)
if name is None:
name = a_controldir._get_selected_branch()
branch_transport = a_controldir.get_branch_transport(self, name=name)
self._write_reference(a_controldir, branch_transport, target_branch)
branch_transport.put_bytes('format', self.as_string())
branch = self.open(a_controldir, name, _found=True,
possible_transports=[target_branch.controldir.root_transport])
self._run_post_branch_init_hooks(a_controldir, name, branch)
return branch
def _make_reference_clone_function(format, a_branch):
"""Create a clone() routine for a branch dynamically."""
def clone(to_bzrdir, revision_id=None,
repository_policy=None):
"""See Branch.clone()."""
return format.initialize(to_bzrdir, target_branch=a_branch)
# cannot obey revision_id limits when cloning a reference ...
# FIXME RBC 20060210 either nuke revision_id for clone, or
# emit some sort of warning/error to the caller ?!
return clone
def open(self, a_controldir, name=None, _found=False, location=None,
possible_transports=None, ignore_fallbacks=False,
found_repository=None):
"""Return the branch that the branch reference in a_controldir points at.
:param a_controldir: A BzrDir that contains a branch.
:param name: Name of colocated branch to open, if any
:param _found: a private parameter, do not use it. It is used to
indicate if format probing has already be done.
:param ignore_fallbacks: when set, no fallback branches will be opened
(if there are any). Default is to open fallbacks.
:param location: The location of the referenced branch. If
unspecified, this will be determined from the branch reference in
a_controldir.
:param possible_transports: An optional reusable transports list.
"""
if name is None:
name = a_controldir._get_selected_branch()
if not _found:
format = BranchFormatMetadir.find_format(a_controldir, name=name)
if format.__class__ != self.__class__:
raise AssertionError("wrong format %r found for %r" %
(format, self))
if location is None:
location = self.get_reference(a_controldir, name)
real_bzrdir = controldir.ControlDir.open(
location, possible_transports=possible_transports)
result = real_bzrdir.open_branch(
ignore_fallbacks=ignore_fallbacks,
possible_transports=possible_transports)
# this changes the behaviour of result.clone to create a new reference
# rather than a copy of the content of the branch.
# I did not use a proxy object because that needs much more extensive
# testing, and we are only changing one behaviour at the moment.
# If we decide to alter more behaviours - i.e. the implicit nickname
# then this should be refactored to introduce a tested proxy branch
# and a subclass of that for use in overriding clone() and ....
# - RBC 20060210
result.clone = self._make_reference_clone_function(result)
return result
class Converter5to6(object):
"""Perform an in-place upgrade of format 5 to format 6"""
def convert(self, branch):
# Data for 5 and 6 can peacefully coexist.
format = BzrBranchFormat6()
new_branch = format.open(branch.controldir, _found=True)
# Copy source data into target
new_branch._write_last_revision_info(*branch.last_revision_info())
with new_branch.lock_write():
new_branch.set_parent(branch.get_parent())
new_branch.set_bound_location(branch.get_bound_location())
new_branch.set_push_location(branch.get_push_location())
# New branch has no tags by default
new_branch.tags._set_tag_dict({})
# Copying done; now update target format
new_branch._transport.put_bytes(
'format', format.as_string(),
mode=new_branch.controldir._get_file_mode())
# Clean up old files
new_branch._transport.delete('revision-history')
with branch.lock_write():
try:
branch.set_parent(None)
except errors.NoSuchFile:
pass
branch.set_bound_location(None)
class Converter6to7(object):
"""Perform an in-place upgrade of format 6 to format 7"""
def convert(self, branch):
format = BzrBranchFormat7()
branch._set_config_location('stacked_on_location', '')
# update target format
branch._transport.put_bytes('format', format.as_string())
class Converter7to8(object):
"""Perform an in-place upgrade of format 7 to format 8"""
def convert(self, branch):
format = BzrBranchFormat8()
branch._transport.put_bytes('references', b'')
# update target format
branch._transport.put_bytes('format', format.as_string())
|