481
650
if revno < 1 or revno > self.revno():
482
651
raise InvalidRevisionNumber(revno)
484
def sign_revision(self, revision_id, gpg_strategy):
485
raise NotImplementedError('sign_revision is abstract')
487
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
488
raise NotImplementedError('store_revision_signature is abstract')
654
def clone(self, to_bzrdir, revision_id=None):
655
"""Clone this branch into to_bzrdir preserving all semantic values.
657
revision_id: if not None, the revision history in the new branch will
658
be truncated to end with revision_id.
660
result = self._format.initialize(to_bzrdir)
661
self.copy_content_into(result, revision_id=revision_id)
665
def sprout(self, to_bzrdir, revision_id=None):
666
"""Create a new line of development from the branch, into to_bzrdir.
668
revision_id: if not None, the revision history in the new branch will
669
be truncated to end with revision_id.
671
result = self._format.initialize(to_bzrdir)
672
self.copy_content_into(result, revision_id=revision_id)
673
result.set_parent(self.bzrdir.root_transport.base)
676
def _synchronize_history(self, destination, revision_id):
677
"""Synchronize last revision and revision history between branches.
679
This version is most efficient when the destination is also a
680
BzrBranch5, but works for BzrBranch6 as long as the revision
681
history is the true lefthand parent history, and all of the revisions
682
are in the destination's repository. If not, set_revision_history
685
:param destination: The branch to copy the history into
686
:param revision_id: The revision-id to truncate history at. May
687
be None to copy complete history.
689
if revision_id == _mod_revision.NULL_REVISION:
691
new_history = self.revision_history()
692
if revision_id is not None and new_history != []:
693
revision_id = osutils.safe_revision_id(revision_id)
695
new_history = new_history[:new_history.index(revision_id) + 1]
697
rev = self.repository.get_revision(revision_id)
698
new_history = rev.get_history(self.repository)[1:]
699
destination.set_revision_history(new_history)
702
def copy_content_into(self, destination, revision_id=None):
703
"""Copy the content of self into destination.
705
revision_id: if not None, the revision history in the new branch will
706
be truncated to end with revision_id.
708
self._synchronize_history(destination, revision_id)
710
parent = self.get_parent()
711
except errors.InaccessibleParent, e:
712
mutter('parent was not accessible to copy: %s', e)
715
destination.set_parent(parent)
716
self.tags.merge_to(destination.tags)
720
"""Check consistency of the branch.
722
In particular this checks that revisions given in the revision-history
723
do actually match up in the revision graph, and that they're all
724
present in the repository.
726
Callers will typically also want to check the repository.
728
:return: A BranchCheckResult.
730
mainline_parent_id = None
731
for revision_id in self.revision_history():
733
revision = self.repository.get_revision(revision_id)
734
except errors.NoSuchRevision, e:
735
raise errors.BzrCheckError("mainline revision {%s} not in repository"
737
# In general the first entry on the revision history has no parents.
738
# But it's not illegal for it to have parents listed; this can happen
739
# in imports from Arch when the parents weren't reachable.
740
if mainline_parent_id is not None:
741
if mainline_parent_id not in revision.parent_ids:
742
raise errors.BzrCheckError("previous revision {%s} not listed among "
744
% (mainline_parent_id, revision_id))
745
mainline_parent_id = revision_id
746
return BranchCheckResult(self)
748
def _get_checkout_format(self):
749
"""Return the most suitable metadir for a checkout of this branch.
750
Weaves are used if this branch's repository uses weaves.
752
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
753
from bzrlib.repofmt import weaverepo
754
format = bzrdir.BzrDirMetaFormat1()
755
format.repository_format = weaverepo.RepositoryFormat7()
757
format = self.repository.bzrdir.checkout_metadir()
758
format.set_branch_format(self._format)
761
def create_checkout(self, to_location, revision_id=None,
763
"""Create a checkout of a branch.
765
:param to_location: The url to produce the checkout at
766
:param revision_id: The revision to check out
767
:param lightweight: If True, produce a lightweight checkout, otherwise,
768
produce a bound branch (heavyweight checkout)
769
:return: The tree of the created checkout
771
t = transport.get_transport(to_location)
774
format = self._get_checkout_format()
775
checkout = format.initialize_on_transport(t)
776
BranchReferenceFormat().initialize(checkout, self)
778
format = self._get_checkout_format()
779
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
780
to_location, force_new_tree=False, format=format)
781
checkout = checkout_branch.bzrdir
782
checkout_branch.bind(self)
783
# pull up to the specified revision_id to set the initial
784
# branch tip correctly, and seed it with history.
785
checkout_branch.pull(self, stop_revision=revision_id)
786
tree = checkout.create_workingtree(revision_id)
787
basis_tree = tree.basis_tree()
788
basis_tree.lock_read()
790
for path, file_id in basis_tree.iter_references():
791
reference_parent = self.reference_parent(file_id, path)
792
reference_parent.create_checkout(tree.abspath(path),
793
basis_tree.get_reference_revision(file_id, path),
799
def reference_parent(self, file_id, path):
800
"""Return the parent branch for a tree-reference file_id
801
:param file_id: The file_id of the tree reference
802
:param path: The path of the file_id in the tree
803
:return: A branch associated with the file_id
805
# FIXME should provide multiple branches, based on config
806
return Branch.open(self.bzrdir.root_transport.clone(path).base)
808
def supports_tags(self):
809
return self._format.supports_tags()
812
class BranchFormat(object):
813
"""An encapsulation of the initialization and open routines for a format.
815
Formats provide three things:
816
* An initialization routine,
820
Formats are placed in an dict by their format string for reference
821
during branch opening. Its not required that these be instances, they
822
can be classes themselves with class methods - it simply depends on
823
whether state is needed for a given format or not.
825
Once a format is deprecated, just deprecate the initialize and open
826
methods on the format class. Do not deprecate the object, as the
827
object will be created every time regardless.
830
_default_format = None
831
"""The default format used for new branches."""
834
"""The known formats."""
836
def __eq__(self, other):
837
return self.__class__ is other.__class__
839
def __ne__(self, other):
840
return not (self == other)
843
def find_format(klass, a_bzrdir):
844
"""Return the format for the branch object in a_bzrdir."""
846
transport = a_bzrdir.get_branch_transport(None)
847
format_string = transport.get("format").read()
848
return klass._formats[format_string]
850
raise NotBranchError(path=transport.base)
852
raise errors.UnknownFormatError(format=format_string)
855
def get_default_format(klass):
856
"""Return the current default format."""
857
return klass._default_format
859
def get_reference(self, a_bzrdir):
860
"""Get the target reference of the branch in a_bzrdir.
862
format probing must have been completed before calling
863
this method - it is assumed that the format of the branch
864
in a_bzrdir is correct.
866
:param a_bzrdir: The bzrdir to get the branch data from.
867
:return: None if the branch is not a reference branch.
871
def get_format_string(self):
872
"""Return the ASCII format string that identifies this format."""
873
raise NotImplementedError(self.get_format_string)
875
def get_format_description(self):
876
"""Return the short format description for this format."""
877
raise NotImplementedError(self.get_format_description)
879
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
881
"""Initialize a branch in a bzrdir, with specified files
883
:param a_bzrdir: The bzrdir to initialize the branch in
884
:param utf8_files: The files to create as a list of
885
(filename, content) tuples
886
:param set_format: If True, set the format with
887
self.get_format_string. (BzrBranch4 has its format set
889
:return: a branch in this format
891
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
892
branch_transport = a_bzrdir.get_branch_transport(self)
894
'metadir': ('lock', lockdir.LockDir),
895
'branch4': ('branch-lock', lockable_files.TransportLock),
897
lock_name, lock_class = lock_map[lock_type]
898
control_files = lockable_files.LockableFiles(branch_transport,
899
lock_name, lock_class)
900
control_files.create_lock()
901
control_files.lock_write()
903
control_files.put_utf8('format', self.get_format_string())
905
for file, content in utf8_files:
906
control_files.put_utf8(file, content)
908
control_files.unlock()
909
return self.open(a_bzrdir, _found=True)
911
def initialize(self, a_bzrdir):
912
"""Create a branch of this format in a_bzrdir."""
913
raise NotImplementedError(self.initialize)
915
def is_supported(self):
916
"""Is this format supported?
918
Supported formats can be initialized and opened.
919
Unsupported formats may not support initialization or committing or
920
some other features depending on the reason for not being supported.
924
def open(self, a_bzrdir, _found=False):
925
"""Return the branch object for a_bzrdir
927
_found is a private parameter, do not use it. It is used to indicate
928
if format probing has already be done.
930
raise NotImplementedError(self.open)
933
def register_format(klass, format):
934
klass._formats[format.get_format_string()] = format
937
def set_default_format(klass, format):
938
klass._default_format = format
941
def unregister_format(klass, format):
942
assert klass._formats[format.get_format_string()] is format
943
del klass._formats[format.get_format_string()]
946
return self.get_format_string().rstrip()
948
def supports_tags(self):
949
"""True if this format supports tags stored in the branch"""
950
return False # by default
952
# XXX: Probably doesn't really belong here -- mbp 20070212
953
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
955
branch_transport = a_bzrdir.get_branch_transport(self)
956
control_files = lockable_files.LockableFiles(branch_transport,
957
lock_filename, lock_class)
958
control_files.create_lock()
959
control_files.lock_write()
961
for filename, content in utf8_files:
962
control_files.put_utf8(filename, content)
964
control_files.unlock()
967
class BranchHooks(Hooks):
968
"""A dictionary mapping hook name to a list of callables for branch hooks.
970
e.g. ['set_rh'] Is the list of items to be called when the
971
set_revision_history function is invoked.
975
"""Create the default hooks.
977
These are all empty initially, because by default nothing should get
981
# Introduced in 0.15:
982
# invoked whenever the revision history has been set
983
# with set_revision_history. The api signature is
984
# (branch, revision_history), and the branch will
987
# invoked after a push operation completes.
988
# the api signature is
990
# containing the members
991
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
992
# where local is the local target branch or None, master is the target
993
# master branch, and the rest should be self explanatory. The source
994
# is read locked and the target branches write locked. Source will
995
# be the local low-latency branch.
996
self['post_push'] = []
997
# invoked after a pull operation completes.
998
# the api signature is
1000
# containing the members
1001
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1002
# where local is the local branch or None, master is the target
1003
# master branch, and the rest should be self explanatory. The source
1004
# is read locked and the target branches write locked. The local
1005
# branch is the low-latency branch.
1006
self['post_pull'] = []
1007
# invoked before a commit operation takes place.
1008
# the api signature is
1009
# (local, master, old_revno, old_revid, future_revno, future_revid,
1010
# tree_delta, future_tree).
1011
# old_revid is NULL_REVISION for the first commit to a branch
1012
# tree_delta is a TreeDelta object describing changes from the basis
1013
# revision, hooks MUST NOT modify this delta
1014
# future_tree is an in-memory tree obtained from
1015
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1016
self['pre_commit'] = []
1017
# invoked after a commit operation completes.
1018
# the api signature is
1019
# (local, master, old_revno, old_revid, new_revno, new_revid)
1020
# old_revid is NULL_REVISION for the first commit to a branch.
1021
self['post_commit'] = []
1022
# invoked after a uncommit operation completes.
1023
# the api signature is
1024
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1025
# local is the local branch or None, master is the target branch,
1026
# and an empty branch recieves new_revno of 0, new_revid of None.
1027
self['post_uncommit'] = []
1030
# install the default hooks into the Branch class.
1031
Branch.hooks = BranchHooks()
1034
class BzrBranchFormat4(BranchFormat):
1035
"""Bzr branch format 4.
1038
- a revision-history file.
1039
- a branch-lock lock file [ to be shared with the bzrdir ]
1042
def get_format_description(self):
1043
"""See BranchFormat.get_format_description()."""
1044
return "Branch format 4"
1046
def initialize(self, a_bzrdir):
1047
"""Create a branch of this format in a_bzrdir."""
1048
utf8_files = [('revision-history', ''),
1049
('branch-name', ''),
1051
return self._initialize_helper(a_bzrdir, utf8_files,
1052
lock_type='branch4', set_format=False)
1055
super(BzrBranchFormat4, self).__init__()
1056
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1058
def open(self, a_bzrdir, _found=False):
1059
"""Return the branch object for a_bzrdir
1061
_found is a private parameter, do not use it. It is used to indicate
1062
if format probing has already be done.
1065
# we are being called directly and must probe.
1066
raise NotImplementedError
1067
return BzrBranch(_format=self,
1068
_control_files=a_bzrdir._control_files,
1070
_repository=a_bzrdir.open_repository())
1073
return "Bazaar-NG branch format 4"
1076
class BzrBranchFormat5(BranchFormat):
1077
"""Bzr branch format 5.
1080
- a revision-history file.
1082
- a lock dir guarding the branch itself
1083
- all of this stored in a branch/ subdirectory
1084
- works with shared repositories.
1086
This format is new in bzr 0.8.
1089
def get_format_string(self):
1090
"""See BranchFormat.get_format_string()."""
1091
return "Bazaar-NG branch format 5\n"
1093
def get_format_description(self):
1094
"""See BranchFormat.get_format_description()."""
1095
return "Branch format 5"
1097
def initialize(self, a_bzrdir):
1098
"""Create a branch of this format in a_bzrdir."""
1099
utf8_files = [('revision-history', ''),
1100
('branch-name', ''),
1102
return self._initialize_helper(a_bzrdir, utf8_files)
1105
super(BzrBranchFormat5, self).__init__()
1106
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1108
def open(self, a_bzrdir, _found=False):
1109
"""Return the branch object for a_bzrdir
1111
_found is a private parameter, do not use it. It is used to indicate
1112
if format probing has already be done.
1115
format = BranchFormat.find_format(a_bzrdir)
1116
assert format.__class__ == self.__class__
1118
transport = a_bzrdir.get_branch_transport(None)
1119
control_files = lockable_files.LockableFiles(transport, 'lock',
1121
return BzrBranch5(_format=self,
1122
_control_files=control_files,
1124
_repository=a_bzrdir.find_repository())
1126
raise NotBranchError(path=transport.base)
1129
class BzrBranchFormat6(BzrBranchFormat5):
1130
"""Branch format with last-revision and tags.
1132
Unlike previous formats, this has no explicit revision history. Instead,
1133
this just stores the last-revision, and the left-hand history leading
1134
up to there is the history.
1136
This format was introduced in bzr 0.15
1137
and became the default in 0.91.
1140
def get_format_string(self):
1141
"""See BranchFormat.get_format_string()."""
1142
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1144
def get_format_description(self):
1145
"""See BranchFormat.get_format_description()."""
1146
return "Branch format 6"
1148
def initialize(self, a_bzrdir):
1149
"""Create a branch of this format in a_bzrdir."""
1150
utf8_files = [('last-revision', '0 null:\n'),
1151
('branch-name', ''),
1152
('branch.conf', ''),
1155
return self._initialize_helper(a_bzrdir, utf8_files)
1157
def open(self, a_bzrdir, _found=False):
1158
"""Return the branch object for a_bzrdir
1160
_found is a private parameter, do not use it. It is used to indicate
1161
if format probing has already be done.
1164
format = BranchFormat.find_format(a_bzrdir)
1165
assert format.__class__ == self.__class__
1166
transport = a_bzrdir.get_branch_transport(None)
1167
control_files = lockable_files.LockableFiles(transport, 'lock',
1169
return BzrBranch6(_format=self,
1170
_control_files=control_files,
1172
_repository=a_bzrdir.find_repository())
1174
def supports_tags(self):
1178
class BranchReferenceFormat(BranchFormat):
1179
"""Bzr branch reference format.
1181
Branch references are used in implementing checkouts, they
1182
act as an alias to the real branch which is at some other url.
1189
def get_format_string(self):
1190
"""See BranchFormat.get_format_string()."""
1191
return "Bazaar-NG Branch Reference Format 1\n"
1193
def get_format_description(self):
1194
"""See BranchFormat.get_format_description()."""
1195
return "Checkout reference format 1"
1197
def get_reference(self, a_bzrdir):
1198
"""See BranchFormat.get_reference()."""
1199
transport = a_bzrdir.get_branch_transport(None)
1200
return transport.get('location').read()
1202
def initialize(self, a_bzrdir, target_branch=None):
1203
"""Create a branch of this format in a_bzrdir."""
1204
if target_branch is None:
1205
# this format does not implement branch itself, thus the implicit
1206
# creation contract must see it as uninitializable
1207
raise errors.UninitializableFormat(self)
1208
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1209
branch_transport = a_bzrdir.get_branch_transport(self)
1210
branch_transport.put_bytes('location',
1211
target_branch.bzrdir.root_transport.base)
1212
branch_transport.put_bytes('format', self.get_format_string())
1213
return self.open(a_bzrdir, _found=True)
1216
super(BranchReferenceFormat, self).__init__()
1217
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1219
def _make_reference_clone_function(format, a_branch):
1220
"""Create a clone() routine for a branch dynamically."""
1221
def clone(to_bzrdir, revision_id=None):
1222
"""See Branch.clone()."""
1223
return format.initialize(to_bzrdir, a_branch)
1224
# cannot obey revision_id limits when cloning a reference ...
1225
# FIXME RBC 20060210 either nuke revision_id for clone, or
1226
# emit some sort of warning/error to the caller ?!
1229
def open(self, a_bzrdir, _found=False, location=None):
1230
"""Return the branch that the branch reference in a_bzrdir points at.
1232
_found is a private parameter, do not use it. It is used to indicate
1233
if format probing has already be done.
1236
format = BranchFormat.find_format(a_bzrdir)
1237
assert format.__class__ == self.__class__
1238
if location is None:
1239
location = self.get_reference(a_bzrdir)
1240
real_bzrdir = bzrdir.BzrDir.open(location)
1241
result = real_bzrdir.open_branch()
1242
# this changes the behaviour of result.clone to create a new reference
1243
# rather than a copy of the content of the branch.
1244
# I did not use a proxy object because that needs much more extensive
1245
# testing, and we are only changing one behaviour at the moment.
1246
# If we decide to alter more behaviours - i.e. the implicit nickname
1247
# then this should be refactored to introduce a tested proxy branch
1248
# and a subclass of that for use in overriding clone() and ....
1250
result.clone = self._make_reference_clone_function(result)
1254
# formats which have no format string are not discoverable
1255
# and not independently creatable, so are not registered.
1256
__format5 = BzrBranchFormat5()
1257
__format6 = BzrBranchFormat6()
1258
BranchFormat.register_format(__format5)
1259
BranchFormat.register_format(BranchReferenceFormat())
1260
BranchFormat.register_format(__format6)
1261
BranchFormat.set_default_format(__format6)
1262
_legacy_formats = [BzrBranchFormat4(),
490
1265
class BzrBranch(Branch):
491
1266
"""A branch stored in the actual filesystem.
493
1268
Note that it's "local" in the context of the filesystem; it doesn't
494
1269
really matter if it's on an nfs/smb/afs/coda/... share, as long as
495
1270
it's writable, and can be accessed via the normal filesystem API.
501
If _lock_mode is true, a positive count of the number of times the
505
Lock object from bzrlib.lock.
507
# We actually expect this class to be somewhat short-lived; part of its
508
# purpose is to try to isolate what bits of the branch logic are tied to
509
# filesystem access, so that in a later step, we can extricate them to
510
# a separarte ("storage") class.
514
_inventory_weave = None
515
# If set to False (by a plugin, etc) BzrBranch will not set the
516
# mode on created files or directories
517
_set_file_mode = True
520
# Map some sort of prefix into a namespace
521
# stuff like "revno:10", "revid:", etc.
522
# This should match a prefix with a function which accepts
523
REVISION_NAMESPACES = {}
525
def push_stores(self, branch_to):
526
"""See Branch.push_stores."""
527
if (self._branch_format != branch_to._branch_format
528
or self._branch_format != 4):
529
from bzrlib.fetch import greedy_fetch
530
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
531
self, self._branch_format, branch_to, branch_to._branch_format)
532
greedy_fetch(to_branch=branch_to, from_branch=self,
533
revision=self.last_revision())
536
store_pairs = ((self.text_store, branch_to.text_store),
537
(self.inventory_store, branch_to.inventory_store),
538
(self.revision_store, branch_to.revision_store))
540
for from_store, to_store in store_pairs:
541
copy_all(from_store, to_store)
542
except UnlistableStore:
543
raise UnlistableBranch(from_store)
545
def __init__(self, transport, init=False,
546
relax_version_check=False):
547
"""Create new branch object at a particular location.
549
transport -- A Transport object, defining how to access files.
551
init -- If True, create new control files in a previously
552
unversioned directory. If False, the branch must already
555
relax_version_check -- If true, the usual check for the branch
556
version is not applied. This is intended only for
557
upgrade/recovery type use; it's not guaranteed that
558
all operations will work on old format branches.
560
In the test suite, creation of new trees is tested using the
561
`ScratchBranch` class.
563
assert isinstance(transport, Transport), \
564
"%r is not a Transport" % transport
565
self._transport = transport
568
self._check_format(relax_version_check)
571
def get_store(name, compressed=True, prefixed=False):
572
relpath = self._rel_controlfilename(unicode(name))
573
store = TextStore(self._transport.clone(relpath),
574
dir_mode=self._dir_mode,
575
file_mode=self._file_mode,
577
compressed=compressed)
580
def get_weave(name, prefixed=False):
581
relpath = self._rel_controlfilename(unicode(name))
582
ws = WeaveStore(self._transport.clone(relpath),
584
dir_mode=self._dir_mode,
585
file_mode=self._file_mode)
586
if self._transport.should_cache():
587
ws.enable_cache = True
590
if self._branch_format == 4:
591
self.inventory_store = get_store('inventory-store')
592
self.text_store = get_store('text-store')
593
self.revision_store = get_store('revision-store')
594
elif self._branch_format == 5:
595
self.control_weaves = get_weave(u'')
596
self.weave_store = get_weave(u'weaves')
597
self.revision_store = get_store(u'revision-store', compressed=False)
598
elif self._branch_format == 6:
599
self.control_weaves = get_weave(u'')
600
self.weave_store = get_weave(u'weaves', prefixed=True)
601
self.revision_store = get_store(u'revision-store', compressed=False,
603
self.revision_store.register_suffix('sig')
604
self._transaction = None
1273
def __init__(self, _format=None,
1274
_control_files=None, a_bzrdir=None, _repository=None):
1275
"""Create new branch object at a particular location."""
1276
Branch.__init__(self)
1277
if a_bzrdir is None:
1278
raise ValueError('a_bzrdir must be supplied')
1280
self.bzrdir = a_bzrdir
1281
# self._transport used to point to the directory containing the
1282
# control directory, but was not used - now it's just the transport
1283
# for the branch control files. mbp 20070212
1284
self._base = self.bzrdir.transport.clone('..').base
1285
self._format = _format
1286
if _control_files is None:
1287
raise ValueError('BzrBranch _control_files is None')
1288
self.control_files = _control_files
1289
self._transport = _control_files._transport
1290
self.repository = _repository
606
1292
def __str__(self):
607
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
1293
return '%s(%r)' % (self.__class__.__name__, self.base)
609
1295
__repr__ = __str__
612
if self._lock_mode or self._lock:
613
# XXX: This should show something every time, and be suitable for
614
# headless operation and embedding
615
warn("branch %r was not explicitly unlocked" % self)
618
# TODO: It might be best to do this somewhere else,
619
# but it is nice for a Branch object to automatically
620
# cache it's information.
621
# Alternatively, we could have the Transport objects cache requests
622
# See the earlier discussion about how major objects (like Branch)
623
# should never expect their __del__ function to run.
624
if hasattr(self, 'cache_root') and self.cache_root is not None:
626
shutil.rmtree(self.cache_root)
629
self.cache_root = None
631
1297
def _get_base(self):
633
return self._transport.base
1298
"""Returns the directory containing the control directory."""
636
1301
base = property(_get_base, doc="The URL for the root of this branch.")
638
def _finish_transaction(self):
639
"""Exit the current transaction."""
640
if self._transaction is None:
641
raise errors.LockError('Branch %s is not in a transaction' %
643
transaction = self._transaction
644
self._transaction = None
647
def get_transaction(self):
648
"""See Branch.get_transaction."""
649
if self._transaction is None:
650
return transactions.PassThroughTransaction()
652
return self._transaction
654
def _set_transaction(self, new_transaction):
655
"""Set a new active transaction."""
656
if self._transaction is not None:
657
raise errors.LockError('Branch %s is in a transaction already.' %
659
self._transaction = new_transaction
661
def lock_write(self):
662
#mutter("lock write: %s (%s)", self, self._lock_count)
663
# TODO: Upgrade locking to support using a Transport,
664
# and potentially a remote locking protocol
666
if self._lock_mode != 'w':
667
raise LockError("can't upgrade to a write lock from %r" %
669
self._lock_count += 1
671
self._lock = self._transport.lock_write(
672
self._rel_controlfilename('branch-lock'))
673
self._lock_mode = 'w'
675
self._set_transaction(transactions.PassThroughTransaction())
678
#mutter("lock read: %s (%s)", self, self._lock_count)
680
assert self._lock_mode in ('r', 'w'), \
681
"invalid lock mode %r" % self._lock_mode
682
self._lock_count += 1
684
self._lock = self._transport.lock_read(
685
self._rel_controlfilename('branch-lock'))
686
self._lock_mode = 'r'
688
self._set_transaction(transactions.ReadOnlyTransaction())
689
# 5K may be excessive, but hey, its a knob.
690
self.get_transaction().set_cache_size(5000)
693
#mutter("unlock: %s (%s)", self, self._lock_count)
694
if not self._lock_mode:
695
raise LockError('branch %r is not locked' % (self))
697
if self._lock_count > 1:
698
self._lock_count -= 1
700
self._finish_transaction()
703
self._lock_mode = self._lock_count = None
705
1303
def abspath(self, name):
706
1304
"""See Branch.abspath."""
707
return self._transport.abspath(name)
709
def _rel_controlfilename(self, file_or_path):
710
if not isinstance(file_or_path, basestring):
711
file_or_path = u'/'.join(file_or_path)
712
if file_or_path == '':
714
return bzrlib.transport.urlescape(bzrlib.BZRDIR + u'/' + file_or_path)
716
def controlfilename(self, file_or_path):
717
"""See Branch.controlfilename."""
718
return self._transport.abspath(self._rel_controlfilename(file_or_path))
720
def controlfile(self, file_or_path, mode='r'):
721
"""See Branch.controlfile."""
724
relpath = self._rel_controlfilename(file_or_path)
725
#TODO: codecs.open() buffers linewise, so it was overloaded with
726
# a much larger buffer, do we need to do the same for getreader/getwriter?
728
return self._transport.get(relpath)
730
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
732
# XXX: Do we really want errors='replace'? Perhaps it should be
733
# an error, or at least reported, if there's incorrectly-encoded
734
# data inside a file.
735
# <https://launchpad.net/products/bzr/+bug/3823>
736
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
738
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
740
raise BzrError("invalid controlfile mode %r" % mode)
742
def put_controlfile(self, path, f, encode=True):
743
"""See Branch.put_controlfile."""
744
self.put_controlfiles([(path, f)], encode=encode)
746
def put_controlfiles(self, files, encode=True):
747
"""See Branch.put_controlfiles."""
750
for path, f in files:
752
if isinstance(f, basestring):
753
f = f.encode('utf-8', 'replace')
755
f = codecs.getwriter('utf-8')(f, errors='replace')
756
path = self._rel_controlfilename(path)
757
ctrl_files.append((path, f))
758
self._transport.put_multi(ctrl_files, mode=self._file_mode)
760
def _find_modes(self, path=None):
761
"""Determine the appropriate modes for files and directories."""
764
path = self._rel_controlfilename('')
765
st = self._transport.stat(path)
766
except errors.TransportNotPossible:
767
self._dir_mode = 0755
768
self._file_mode = 0644
770
self._dir_mode = st.st_mode & 07777
771
# Remove the sticky and execute bits for files
772
self._file_mode = self._dir_mode & ~07111
773
if not self._set_dir_mode:
774
self._dir_mode = None
775
if not self._set_file_mode:
776
self._file_mode = None
778
def _make_control(self):
779
from bzrlib.inventory import Inventory
780
from bzrlib.weavefile import write_weave_v5
781
from bzrlib.weave import Weave
783
# Create an empty inventory
785
# if we want per-tree root ids then this is the place to set
786
# them; they're not needed for now and so ommitted for
788
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
789
empty_inv = sio.getvalue()
791
bzrlib.weavefile.write_weave_v5(Weave(), sio)
792
empty_weave = sio.getvalue()
794
cfn = self._rel_controlfilename
795
# Since we don't have a .bzr directory, inherit the
796
# mode from the root directory
797
self._find_modes(u'.')
799
dirs = ['', 'revision-store', 'weaves']
801
"This is a Bazaar-NG control directory.\n"
802
"Do not change any files in this directory.\n"),
803
('branch-format', BZR_BRANCH_FORMAT_6),
804
('revision-history', ''),
807
('pending-merges', ''),
808
('inventory', empty_inv),
809
('inventory.weave', empty_weave),
810
('ancestry.weave', empty_weave)
812
self._transport.mkdir_multi([cfn(d) for d in dirs], mode=self._dir_mode)
813
self.put_controlfiles(files)
814
mutter('created control directory in ' + self._transport.base)
816
def _check_format(self, relax_version_check):
817
"""Check this branch format is supported.
819
The format level is stored, as an integer, in
820
self._branch_format for code that needs to check it later.
822
In the future, we might need different in-memory Branch
823
classes to support downlevel branches. But not yet.
826
fmt = self.controlfile('branch-format', 'r').read()
828
raise NotBranchError(path=self.base)
829
mutter("got branch format %r", fmt)
830
if fmt == BZR_BRANCH_FORMAT_6:
831
self._branch_format = 6
832
elif fmt == BZR_BRANCH_FORMAT_5:
833
self._branch_format = 5
834
elif fmt == BZR_BRANCH_FORMAT_4:
835
self._branch_format = 4
837
if (not relax_version_check
838
and self._branch_format not in (5, 6)):
839
raise errors.UnsupportedFormatError(
840
'sorry, branch format %r not supported' % fmt,
841
['use a different bzr version',
842
'or remove the .bzr directory'
843
' and "bzr init" again'])
1305
return self.control_files._transport.abspath(name)
1308
@deprecated_method(zero_sixteen)
845
1309
@needs_read_lock
846
1310
def get_root_id(self):
847
1311
"""See Branch.get_root_id."""
848
inv = self.get_inventory(self.last_revision())
849
return inv.root.file_id
1312
tree = self.repository.revision_tree(self.last_revision())
1313
return tree.inventory.root.file_id
1315
def is_locked(self):
1316
return self.control_files.is_locked()
1318
def lock_write(self, token=None):
1319
repo_token = self.repository.lock_write()
1321
token = self.control_files.lock_write(token=token)
1323
self.repository.unlock()
1327
def lock_read(self):
1328
self.repository.lock_read()
1330
self.control_files.lock_read()
1332
self.repository.unlock()
1336
# TODO: test for failed two phase locks. This is known broken.
1338
self.control_files.unlock()
1340
self.repository.unlock()
1341
if not self.control_files.is_locked():
1342
# we just released the lock
1343
self._clear_cached_state()
1345
def peek_lock_mode(self):
1346
if self.control_files._lock_count == 0:
1349
return self.control_files._lock_mode
1351
def get_physical_lock_status(self):
1352
return self.control_files.get_physical_lock_status()
851
1354
@needs_read_lock
852
1355
def print_file(self, file, revision_id):
853
1356
"""See Branch.print_file."""
854
tree = self.revision_tree(revision_id)
855
# use inventory as it was in that revision
856
file_id = tree.inventory.path2id(file)
859
revno = self.revision_id_to_revno(revision_id)
860
except errors.NoSuchRevision:
861
# TODO: This should not be BzrError,
862
# but NoSuchFile doesn't fit either
863
raise BzrError('%r is not present in revision %s'
864
% (file, revision_id))
866
raise BzrError('%r is not present in revision %s'
868
tree.print_file(file_id)
871
def append_revision(self, *revision_ids):
872
"""See Branch.append_revision."""
873
for revision_id in revision_ids:
874
mutter("add {%s} to revision-history" % revision_id)
875
rev_history = self.revision_history()
876
rev_history.extend(revision_ids)
877
self.set_revision_history(rev_history)
1357
return self.repository.print_file(file, revision_id)
1359
def _write_revision_history(self, history):
1360
"""Factored out of set_revision_history.
1362
This performs the actual writing to disk.
1363
It is intended to be called by BzrBranch5.set_revision_history."""
1364
self.control_files.put_bytes(
1365
'revision-history', '\n'.join(history))
879
1367
@needs_write_lock
880
1368
def set_revision_history(self, rev_history):
881
1369
"""See Branch.set_revision_history."""
882
old_revision = self.last_revision()
883
new_revision = rev_history[-1]
884
self.put_controlfile('revision-history', '\n'.join(rev_history))
886
self.working_tree().set_last_revision(new_revision, old_revision)
887
except NoWorkingTree:
888
mutter('Unable to set_last_revision without a working tree.')
890
def has_revision(self, revision_id):
891
"""See Branch.has_revision."""
892
return (revision_id is None
893
or self.revision_store.has_id(revision_id))
896
def _get_revision_xml_file(self, revision_id):
897
if not revision_id or not isinstance(revision_id, basestring):
898
raise InvalidRevisionId(revision_id=revision_id, branch=self)
900
return self.revision_store.get(revision_id)
901
except (IndexError, KeyError):
902
raise bzrlib.errors.NoSuchRevision(self, revision_id)
904
def get_revision_xml(self, revision_id):
905
"""See Branch.get_revision_xml."""
906
return self._get_revision_xml_file(revision_id).read()
908
def get_revision(self, revision_id):
909
"""See Branch.get_revision."""
910
xml_file = self._get_revision_xml_file(revision_id)
913
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
914
except SyntaxError, e:
915
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
919
assert r.revision_id == revision_id
922
def get_revision_sha1(self, revision_id):
923
"""See Branch.get_revision_sha1."""
924
# In the future, revision entries will be signed. At that
925
# point, it is probably best *not* to include the signature
926
# in the revision hash. Because that lets you re-sign
927
# the revision, (add signatures/remove signatures) and still
928
# have all hash pointers stay consistent.
929
# But for now, just hash the contents.
930
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
932
def get_ancestry(self, revision_id):
933
"""See Branch.get_ancestry."""
934
if revision_id is None:
936
w = self._get_inventory_weave()
937
return [None] + map(w.idx_to_name,
938
w.inclusions([w.lookup(revision_id)]))
940
def _get_inventory_weave(self):
941
return self.control_weaves.get_weave('inventory',
942
self.get_transaction())
944
def get_inventory(self, revision_id):
945
"""See Branch.get_inventory."""
946
xml = self.get_inventory_xml(revision_id)
947
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
949
def get_inventory_xml(self, revision_id):
950
"""See Branch.get_inventory_xml."""
952
assert isinstance(revision_id, basestring), type(revision_id)
953
iw = self._get_inventory_weave()
954
return iw.get_text(iw.lookup(revision_id))
956
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
958
def get_inventory_sha1(self, revision_id):
959
"""See Branch.get_inventory_sha1."""
960
return self.get_revision(revision_id).inventory_sha1
962
def get_revision_inventory(self, revision_id):
963
"""See Branch.get_revision_inventory."""
964
# TODO: Unify this with get_inventory()
965
# bzr 0.0.6 and later imposes the constraint that the inventory_id
966
# must be the same as its revision, so this is trivial.
967
if revision_id == None:
968
# This does not make sense: if there is no revision,
969
# then it is the current tree inventory surely ?!
970
# and thus get_root_id() is something that looks at the last
971
# commit on the branch, and the get_root_id is an inventory check.
972
raise NotImplementedError
973
# return Inventory(self.get_root_id())
975
return self.get_inventory(revision_id)
978
def revision_history(self):
979
"""See Branch.revision_history."""
980
transaction = self.get_transaction()
981
history = transaction.map.find_revision_history()
982
if history is not None:
983
mutter("cache hit for revision-history in %s", self)
985
history = [l.rstrip('\r\n') for l in
986
self.controlfile('revision-history', 'r').readlines()]
987
transaction.map.add_revision_history(history)
988
# this call is disabled because revision_history is
989
# not really an object yet, and the transaction is for objects.
990
# transaction.register_clean(history, precious=True)
1370
if 'evil' in debug.debug_flags:
1371
mutter_callsite(3, "set_revision_history scales with history.")
1372
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1373
self._clear_cached_state()
1374
self._write_revision_history(rev_history)
1375
self._cache_revision_history(rev_history)
1376
for hook in Branch.hooks['set_rh']:
1377
hook(self, rev_history)
1380
def set_last_revision_info(self, revno, revision_id):
1381
"""Set the last revision of this branch.
1383
The caller is responsible for checking that the revno is correct
1384
for this revision id.
1386
It may be possible to set the branch last revision to an id not
1387
present in the repository. However, branches can also be
1388
configured to check constraints on history, in which case this may not
1391
revision_id = osutils.safe_revision_id(revision_id)
1392
history = self._lefthand_history(revision_id)
1393
assert len(history) == revno, '%d != %d' % (len(history), revno)
1394
self.set_revision_history(history)
1396
def _gen_revision_history(self):
1397
history = self.control_files.get('revision-history').read().split('\n')
1398
if history[-1:] == ['']:
1399
# There shouldn't be a trailing newline, but just in case.
1403
def _lefthand_history(self, revision_id, last_rev=None,
1405
if 'evil' in debug.debug_flags:
1406
mutter_callsite(4, "_lefthand_history scales with history.")
1407
# stop_revision must be a descendant of last_revision
1408
stop_graph = self.repository.get_revision_graph(revision_id)
1409
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1410
and last_rev not in stop_graph):
1411
# our previous tip is not merged into stop_revision
1412
raise errors.DivergedBranches(self, other_branch)
1413
# make a new revision history from the graph
1414
current_rev_id = revision_id
1416
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1417
new_history.append(current_rev_id)
1418
current_rev_id_parents = stop_graph[current_rev_id]
1420
current_rev_id = current_rev_id_parents[0]
1422
current_rev_id = None
1423
new_history.reverse()
1427
def generate_revision_history(self, revision_id, last_rev=None,
1429
"""Create a new revision history that will finish with revision_id.
1431
:param revision_id: the new tip to use.
1432
:param last_rev: The previous last_revision. If not None, then this
1433
must be a ancestory of revision_id, or DivergedBranches is raised.
1434
:param other_branch: The other branch that DivergedBranches should
1435
raise with respect to.
1437
revision_id = osutils.safe_revision_id(revision_id)
1438
self.set_revision_history(self._lefthand_history(revision_id,
1439
last_rev, other_branch))
993
1442
def update_revisions(self, other, stop_revision=None):
994
1443
"""See Branch.update_revisions."""
995
from bzrlib.fetch import greedy_fetch
996
if stop_revision is None:
997
stop_revision = other.last_revision()
998
### Should this be checking is_ancestor instead of revision_history?
999
if (stop_revision is not None and
1000
stop_revision in self.revision_history()):
1002
greedy_fetch(to_branch=self, from_branch=other,
1003
revision=stop_revision)
1004
pullable_revs = self.pullable_revisions(other, stop_revision)
1005
if len(pullable_revs) > 0:
1006
self.append_revision(*pullable_revs)
1008
def pullable_revisions(self, other, stop_revision):
1009
"""See Branch.pullable_revisions."""
1010
other_revno = other.revision_id_to_revno(stop_revision)
1012
return self.missing_revisions(other, other_revno)
1013
except DivergedBranches, e:
1015
pullable_revs = get_intervening_revisions(self.last_revision(),
1016
stop_revision, self)
1017
assert self.last_revision() not in pullable_revs
1018
return pullable_revs
1019
except bzrlib.errors.NotAncestor:
1020
if is_ancestor(self.last_revision(), stop_revision, self):
1025
def revision_tree(self, revision_id):
1026
"""See Branch.revision_tree."""
1027
# TODO: refactor this to use an existing revision object
1028
# so we don't need to read it in twice.
1029
if revision_id == None or revision_id == NULL_REVISION:
1032
inv = self.get_revision_inventory(revision_id)
1033
return RevisionTree(self, inv, revision_id)
1446
if stop_revision is None:
1447
stop_revision = other.last_revision()
1448
if stop_revision is None:
1449
# if there are no commits, we're done.
1452
stop_revision = osutils.safe_revision_id(stop_revision)
1453
# whats the current last revision, before we fetch [and change it
1455
last_rev = _mod_revision.ensure_null(self.last_revision())
1456
# we fetch here so that we don't process data twice in the common
1457
# case of having something to pull, and so that the check for
1458
# already merged can operate on the just fetched graph, which will
1459
# be cached in memory.
1460
self.fetch(other, stop_revision)
1461
if self.repository.get_graph().is_ancestor(stop_revision,
1464
self.generate_revision_history(stop_revision, last_rev=last_rev,
1035
1469
def basis_tree(self):
1036
1470
"""See Branch.basis_tree."""
1038
revision_id = self.revision_history()[-1]
1039
xml = self.working_tree().read_basis_inventory(revision_id)
1040
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
1041
return RevisionTree(self, inv, revision_id)
1042
except (IndexError, NoSuchFile, NoWorkingTree), e:
1043
return self.revision_tree(self.last_revision())
1045
def working_tree(self):
1046
"""See Branch.working_tree."""
1047
from bzrlib.workingtree import WorkingTree
1048
if self._transport.base.find('://') != -1:
1049
raise NoWorkingTree(self.base)
1050
return WorkingTree(self.base, branch=self)
1471
return self.repository.revision_tree(self.last_revision())
1052
1473
@needs_write_lock
1053
def pull(self, source, overwrite=False):
1054
"""See Branch.pull."""
1474
def pull(self, source, overwrite=False, stop_revision=None,
1475
_hook_master=None, run_hooks=True, possible_transports=None):
1478
:param _hook_master: Private parameter - set the branch to
1479
be supplied as the master to push hooks.
1480
:param run_hooks: Private parameter - if false, this branch
1481
is being called because it's the master of the primary branch,
1482
so it should not run its hooks.
1484
result = PullResult()
1485
result.source_branch = source
1486
result.target_branch = self
1055
1487
source.lock_read()
1057
old_count = len(self.revision_history())
1489
result.old_revno, result.old_revid = self.last_revision_info()
1059
self.update_revisions(source)
1491
self.update_revisions(source, stop_revision)
1060
1492
except DivergedBranches:
1061
1493
if not overwrite:
1064
self.set_revision_history(source.revision_history())
1065
new_count = len(self.revision_history())
1066
return new_count - old_count
1496
if stop_revision is None:
1497
stop_revision = source.last_revision()
1498
self.generate_revision_history(stop_revision)
1499
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1500
result.new_revno, result.new_revid = self.last_revision_info()
1502
result.master_branch = _hook_master
1503
result.local_branch = self
1505
result.master_branch = self
1506
result.local_branch = None
1508
for hook in Branch.hooks['post_pull']:
1068
1511
source.unlock()
1070
def get_parent(self):
1071
"""See Branch.get_parent."""
1514
def _get_parent_location(self):
1073
1515
_locs = ['parent', 'pull', 'x-pull']
1074
1516
for l in _locs:
1076
return self.controlfile(l, 'r').read().strip('\n')
1518
return self.control_files.get(l).read().strip('\n')
1077
1519
except NoSuchFile:
1081
def get_push_location(self):
1082
"""See Branch.get_push_location."""
1083
config = bzrlib.config.BranchConfig(self)
1084
push_loc = config.get_user_option('push_location')
1524
def push(self, target, overwrite=False, stop_revision=None,
1525
_override_hook_source_branch=None):
1528
This is the basic concrete implementation of push()
1530
:param _override_hook_source_branch: If specified, run
1531
the hooks passing this Branch as the source, rather than self.
1532
This is for use of RemoteBranch, where push is delegated to the
1533
underlying vfs-based Branch.
1535
# TODO: Public option to disable running hooks - should be trivial but
1539
result = self._push_with_bound_branches(target, overwrite,
1541
_override_hook_source_branch=_override_hook_source_branch)
1546
def _push_with_bound_branches(self, target, overwrite,
1548
_override_hook_source_branch=None):
1549
"""Push from self into target, and into target's master if any.
1551
This is on the base BzrBranch class even though it doesn't support
1552
bound branches because the *target* might be bound.
1555
if _override_hook_source_branch:
1556
result.source_branch = _override_hook_source_branch
1557
for hook in Branch.hooks['post_push']:
1560
bound_location = target.get_bound_location()
1561
if bound_location and target.base != bound_location:
1562
# there is a master branch.
1564
# XXX: Why the second check? Is it even supported for a branch to
1565
# be bound to itself? -- mbp 20070507
1566
master_branch = target.get_master_branch()
1567
master_branch.lock_write()
1569
# push into the master from this branch.
1570
self._basic_push(master_branch, overwrite, stop_revision)
1571
# and push into the target branch from this. Note that we push from
1572
# this branch again, because its considered the highest bandwidth
1574
result = self._basic_push(target, overwrite, stop_revision)
1575
result.master_branch = master_branch
1576
result.local_branch = target
1580
master_branch.unlock()
1583
result = self._basic_push(target, overwrite, stop_revision)
1584
# TODO: Why set master_branch and local_branch if there's no
1585
# binding? Maybe cleaner to just leave them unset? -- mbp
1587
result.master_branch = target
1588
result.local_branch = None
1592
def _basic_push(self, target, overwrite, stop_revision):
1593
"""Basic implementation of push without bound branches or hooks.
1595
Must be called with self read locked and target write locked.
1597
result = PushResult()
1598
result.source_branch = self
1599
result.target_branch = target
1600
result.old_revno, result.old_revid = target.last_revision_info()
1602
target.update_revisions(self, stop_revision)
1603
except DivergedBranches:
1607
target.set_revision_history(self.revision_history())
1608
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1609
result.new_revno, result.new_revid = target.last_revision_info()
1612
def get_parent(self):
1613
"""See Branch.get_parent."""
1615
assert self.base[-1] == '/'
1616
parent = self._get_parent_location()
1619
# This is an old-format absolute path to a local branch
1620
# turn it into a url
1621
if parent.startswith('/'):
1622
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1624
return urlutils.join(self.base[:-1], parent)
1625
except errors.InvalidURLJoin, e:
1626
raise errors.InaccessibleParent(parent, self.base)
1087
1628
def set_push_location(self, location):
1088
1629
"""See Branch.set_push_location."""
1089
config = bzrlib.config.LocationConfig(self.base)
1090
config.set_user_option('push_location', location)
1630
self.get_config().set_user_option(
1631
'push_location', location,
1632
store=_mod_config.STORE_LOCATION_NORECURSE)
1092
1634
@needs_write_lock
1093
1635
def set_parent(self, url):
1094
1636
"""See Branch.set_parent."""
1095
1637
# TODO: Maybe delete old location files?
1096
from bzrlib.atomicfile import AtomicFile
1097
f = AtomicFile(self.controlfilename('parent'))
1638
# URLs should never be unicode, even on the local fs,
1639
# FIXUP this and get_parent in a future branch format bump:
1640
# read and rewrite the file, and have the new format code read
1641
# using .get not .get_utf8. RBC 20060125
1643
if isinstance(url, unicode):
1645
url = url.encode('ascii')
1646
except UnicodeEncodeError:
1647
raise errors.InvalidURL(url,
1648
"Urls must be 7-bit ascii, "
1649
"use bzrlib.urlutils.escape")
1650
url = urlutils.relative_url(self.base, url)
1651
self._set_parent_location(url)
1653
def _set_parent_location(self, url):
1655
self.control_files._transport.delete('parent')
1657
assert isinstance(url, str)
1658
self.control_files.put_bytes('parent', url + '\n')
1661
class BzrBranch5(BzrBranch):
1662
"""A format 5 branch. This supports new features over plain branches.
1664
It has support for a master_branch which is the data for bound branches.
1672
super(BzrBranch5, self).__init__(_format=_format,
1673
_control_files=_control_files,
1675
_repository=_repository)
1678
def pull(self, source, overwrite=False, stop_revision=None,
1679
run_hooks=True, possible_transports=None):
1680
"""Pull from source into self, updating my master if any.
1682
:param run_hooks: Private parameter - if false, this branch
1683
is being called because it's the master of the primary branch,
1684
so it should not run its hooks.
1686
bound_location = self.get_bound_location()
1687
master_branch = None
1688
if bound_location and source.base != bound_location:
1689
# not pulling from master, so we need to update master.
1690
master_branch = self.get_master_branch(possible_transports)
1691
master_branch.lock_write()
1694
# pull from source into master.
1695
master_branch.pull(source, overwrite, stop_revision,
1697
return super(BzrBranch5, self).pull(source, overwrite,
1698
stop_revision, _hook_master=master_branch,
1699
run_hooks=run_hooks)
1104
def tree_config(self):
1105
return TreeConfig(self)
1107
def sign_revision(self, revision_id, gpg_strategy):
1108
"""See Branch.sign_revision."""
1109
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1110
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1702
master_branch.unlock()
1704
def get_bound_location(self):
1706
return self.control_files.get_utf8('bound').read()[:-1]
1707
except errors.NoSuchFile:
1711
def get_master_branch(self, possible_transports=None):
1712
"""Return the branch we are bound to.
1714
:return: Either a Branch, or None
1716
This could memoise the branch, but if thats done
1717
it must be revalidated on each new lock.
1718
So for now we just don't memoise it.
1719
# RBC 20060304 review this decision.
1721
bound_loc = self.get_bound_location()
1725
return Branch.open(bound_loc,
1726
possible_transports=possible_transports)
1727
except (errors.NotBranchError, errors.ConnectionError), e:
1728
raise errors.BoundBranchConnectionFailure(
1112
1731
@needs_write_lock
1113
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1114
"""See Branch.store_revision_signature."""
1115
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1119
class ScratchBranch(BzrBranch):
1120
"""Special test class: a branch that cleans up after itself.
1122
>>> b = ScratchBranch()
1126
>>> b._transport.__del__()
1131
def __init__(self, files=[], dirs=[], transport=None):
1132
"""Make a test branch.
1134
This creates a temporary directory and runs init-tree in it.
1136
If any files are listed, they are created in the working copy.
1732
def set_bound_location(self, location):
1733
"""Set the target where this branch is bound to.
1735
:param location: URL to the target branch
1138
if transport is None:
1139
transport = bzrlib.transport.local.ScratchTransport()
1140
super(ScratchBranch, self).__init__(transport, init=True)
1738
self.control_files.put_utf8('bound', location+'\n')
1142
super(ScratchBranch, self).__init__(transport)
1145
self._transport.mkdir(d)
1148
self._transport.put(f, 'content of %s' % f)
1153
>>> orig = ScratchBranch(files=["file1", "file2"])
1154
>>> clone = orig.clone()
1155
>>> if os.name != 'nt':
1156
... os.path.samefile(orig.base, clone.base)
1158
... orig.base == clone.base
1161
>>> os.path.isfile(pathjoin(clone.base, "file1"))
1164
from shutil import copytree
1165
from bzrlib.osutils import mkdtemp
1168
copytree(self.base, base, symlinks=True)
1169
return ScratchBranch(
1170
transport=bzrlib.transport.local.ScratchTransport(base))
1173
######################################################################
1177
def is_control_file(filename):
1178
## FIXME: better check
1179
filename = normpath(filename)
1180
while filename != '':
1181
head, tail = os.path.split(filename)
1182
## mutter('check %r for control file' % ((head, tail), ))
1183
if tail == bzrlib.BZRDIR:
1741
self.control_files._transport.delete('bound')
1185
if filename == head:
1747
def bind(self, other):
1748
"""Bind this branch to the branch other.
1750
This does not push or pull data between the branches, though it does
1751
check for divergence to raise an error when the branches are not
1752
either the same, or one a prefix of the other. That behaviour may not
1753
be useful, so that check may be removed in future.
1755
:param other: The branch to bind to
1758
# TODO: jam 20051230 Consider checking if the target is bound
1759
# It is debatable whether you should be able to bind to
1760
# a branch which is itself bound.
1761
# Committing is obviously forbidden,
1762
# but binding itself may not be.
1763
# Since we *have* to check at commit time, we don't
1764
# *need* to check here
1766
# we want to raise diverged if:
1767
# last_rev is not in the other_last_rev history, AND
1768
# other_last_rev is not in our history, and do it without pulling
1770
last_rev = _mod_revision.ensure_null(self.last_revision())
1771
if last_rev != _mod_revision.NULL_REVISION:
1774
other_last_rev = other.last_revision()
1775
if not _mod_revision.is_null(other_last_rev):
1776
# neither branch is new, we have to do some work to
1777
# ascertain diversion.
1778
remote_graph = other.repository.get_revision_graph(
1780
local_graph = self.repository.get_revision_graph(last_rev)
1781
if (last_rev not in remote_graph and
1782
other_last_rev not in local_graph):
1783
raise errors.DivergedBranches(self, other)
1786
self.set_bound_location(other.base)
1790
"""If bound, unbind"""
1791
return self.set_bound_location(None)
1794
def update(self, possible_transports=None):
1795
"""Synchronise this branch with the master branch if any.
1797
:return: None or the last_revision that was pivoted out during the
1800
master = self.get_master_branch(possible_transports)
1801
if master is not None:
1802
old_tip = _mod_revision.ensure_null(self.last_revision())
1803
self.pull(master, overwrite=True)
1804
if self.repository.get_graph().is_ancestor(old_tip,
1805
_mod_revision.ensure_null(self.last_revision())):
1811
class BzrBranchExperimental(BzrBranch5):
1812
"""Bzr experimental branch format
1815
- a revision-history file.
1817
- a lock dir guarding the branch itself
1818
- all of this stored in a branch/ subdirectory
1819
- works with shared repositories.
1820
- a tag dictionary in the branch
1822
This format is new in bzr 0.15, but shouldn't be used for real data,
1825
This class acts as it's own BranchFormat.
1828
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1831
def get_format_string(cls):
1832
"""See BranchFormat.get_format_string()."""
1833
return "Bazaar-NG branch format experimental\n"
1836
def get_format_description(cls):
1837
"""See BranchFormat.get_format_description()."""
1838
return "Experimental branch format"
1841
def get_reference(cls, a_bzrdir):
1842
"""Get the target reference of the branch in a_bzrdir.
1844
format probing must have been completed before calling
1845
this method - it is assumed that the format of the branch
1846
in a_bzrdir is correct.
1848
:param a_bzrdir: The bzrdir to get the branch data from.
1849
:return: None if the branch is not a reference branch.
1854
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1856
branch_transport = a_bzrdir.get_branch_transport(cls)
1857
control_files = lockable_files.LockableFiles(branch_transport,
1858
lock_filename, lock_class)
1859
control_files.create_lock()
1860
control_files.lock_write()
1862
for filename, content in utf8_files:
1863
control_files.put_utf8(filename, content)
1865
control_files.unlock()
1868
def initialize(cls, a_bzrdir):
1869
"""Create a branch of this format in a_bzrdir."""
1870
utf8_files = [('format', cls.get_format_string()),
1871
('revision-history', ''),
1872
('branch-name', ''),
1875
cls._initialize_control_files(a_bzrdir, utf8_files,
1876
'lock', lockdir.LockDir)
1877
return cls.open(a_bzrdir, _found=True)
1880
def open(cls, a_bzrdir, _found=False):
1881
"""Return the branch object for a_bzrdir
1883
_found is a private parameter, do not use it. It is used to indicate
1884
if format probing has already be done.
1887
format = BranchFormat.find_format(a_bzrdir)
1888
assert format.__class__ == cls
1889
transport = a_bzrdir.get_branch_transport(None)
1890
control_files = lockable_files.LockableFiles(transport, 'lock',
1892
return cls(_format=cls,
1893
_control_files=control_files,
1895
_repository=a_bzrdir.find_repository())
1898
def is_supported(cls):
1901
def _make_tags(self):
1902
return BasicTags(self)
1905
def supports_tags(cls):
1909
BranchFormat.register_format(BzrBranchExperimental)
1912
class BzrBranch6(BzrBranch5):
1915
def last_revision_info(self):
1916
revision_string = self.control_files.get('last-revision').read()
1917
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1918
revision_id = cache_utf8.get_cached_utf8(revision_id)
1920
return revno, revision_id
1922
def last_revision(self):
1923
"""Return last revision id, or None"""
1924
revision_id = self.last_revision_info()[1]
1927
def _write_last_revision_info(self, revno, revision_id):
1928
"""Simply write out the revision id, with no checks.
1930
Use set_last_revision_info to perform this safely.
1932
Does not update the revision_history cache.
1933
Intended to be called by set_last_revision_info and
1934
_write_revision_history.
1936
if revision_id is None:
1937
revision_id = 'null:'
1938
out_string = '%d %s\n' % (revno, revision_id)
1939
self.control_files.put_bytes('last-revision', out_string)
1942
def set_last_revision_info(self, revno, revision_id):
1943
revision_id = osutils.safe_revision_id(revision_id)
1944
if self._get_append_revisions_only():
1945
self._check_history_violation(revision_id)
1946
self._write_last_revision_info(revno, revision_id)
1947
self._clear_cached_state()
1949
def _check_history_violation(self, revision_id):
1950
last_revision = _mod_revision.ensure_null(self.last_revision())
1951
if _mod_revision.is_null(last_revision):
1953
if last_revision not in self._lefthand_history(revision_id):
1954
raise errors.AppendRevisionsOnlyViolation(self.base)
1956
def _gen_revision_history(self):
1957
"""Generate the revision history from last revision
1959
history = list(self.repository.iter_reverse_revision_history(
1960
self.last_revision()))
1964
def _write_revision_history(self, history):
1965
"""Factored out of set_revision_history.
1967
This performs the actual writing to disk, with format-specific checks.
1968
It is intended to be called by BzrBranch5.set_revision_history.
1970
if len(history) == 0:
1971
last_revision = 'null:'
1973
if history != self._lefthand_history(history[-1]):
1974
raise errors.NotLefthandHistory(history)
1975
last_revision = history[-1]
1976
if self._get_append_revisions_only():
1977
self._check_history_violation(last_revision)
1978
self._write_last_revision_info(len(history), last_revision)
1981
def _set_parent_location(self, url):
1982
"""Set the parent branch"""
1983
self._set_config_location('parent_location', url, make_relative=True)
1986
def _get_parent_location(self):
1987
"""Set the parent branch"""
1988
return self._get_config_location('parent_location')
1990
def set_push_location(self, location):
1991
"""See Branch.set_push_location."""
1992
self._set_config_location('push_location', location)
1994
def set_bound_location(self, location):
1995
"""See Branch.set_push_location."""
1997
config = self.get_config()
1998
if location is None:
1999
if config.get_user_option('bound') != 'True':
2002
config.set_user_option('bound', 'False', warn_masked=True)
2005
self._set_config_location('bound_location', location,
2007
config.set_user_option('bound', 'True', warn_masked=True)
2010
def _get_bound_location(self, bound):
2011
"""Return the bound location in the config file.
2013
Return None if the bound parameter does not match"""
2014
config = self.get_config()
2015
config_bound = (config.get_user_option('bound') == 'True')
2016
if config_bound != bound:
2018
return self._get_config_location('bound_location', config=config)
2020
def get_bound_location(self):
2021
"""See Branch.set_push_location."""
2022
return self._get_bound_location(True)
2024
def get_old_bound_location(self):
2025
"""See Branch.get_old_bound_location"""
2026
return self._get_bound_location(False)
2028
def set_append_revisions_only(self, enabled):
2033
self.get_config().set_user_option('append_revisions_only', value,
2036
def _get_append_revisions_only(self):
2037
value = self.get_config().get_user_option('append_revisions_only')
2038
return value == 'True'
2040
def _synchronize_history(self, destination, revision_id):
2041
"""Synchronize last revision and revision history between branches.
2043
This version is most efficient when the destination is also a
2044
BzrBranch6, but works for BzrBranch5, as long as the destination's
2045
repository contains all the lefthand ancestors of the intended
2046
last_revision. If not, set_last_revision_info will fail.
2048
:param destination: The branch to copy the history into
2049
:param revision_id: The revision-id to truncate history at. May
2050
be None to copy complete history.
2052
source_revno, source_revision_id = self.last_revision_info()
2053
if revision_id is None:
2054
revno, revision_id = source_revno, source_revision_id
2055
elif source_revision_id == revision_id:
2056
# we know the revno without needing to walk all of history
2057
revno = source_revno
2059
# To figure out the revno for a random revision, we need to build
2060
# the revision history, and count its length.
2061
# We don't care about the order, just how long it is.
2062
# Alternatively, we could start at the current location, and count
2063
# backwards. But there is no guarantee that we will find it since
2064
# it may be a merged revision.
2065
revno = len(list(self.repository.iter_reverse_revision_history(
2067
destination.set_last_revision_info(revno, revision_id)
2069
def _make_tags(self):
2070
return BasicTags(self)
2073
######################################################################
2074
# results of operations
2077
class _Result(object):
2079
def _show_tag_conficts(self, to_file):
2080
if not getattr(self, 'tag_conflicts', None):
2082
to_file.write('Conflicting tags:\n')
2083
for name, value1, value2 in self.tag_conflicts:
2084
to_file.write(' %s\n' % (name, ))
2087
class PullResult(_Result):
2088
"""Result of a Branch.pull operation.
2090
:ivar old_revno: Revision number before pull.
2091
:ivar new_revno: Revision number after pull.
2092
:ivar old_revid: Tip revision id before pull.
2093
:ivar new_revid: Tip revision id after pull.
2094
:ivar source_branch: Source (local) branch object.
2095
:ivar master_branch: Master branch of the target, or None.
2096
:ivar target_branch: Target/destination branch object.
2100
# DEPRECATED: pull used to return the change in revno
2101
return self.new_revno - self.old_revno
2103
def report(self, to_file):
2104
if self.old_revid == self.new_revid:
2105
to_file.write('No revisions to pull.\n')
2107
to_file.write('Now on revision %d.\n' % self.new_revno)
2108
self._show_tag_conficts(to_file)
2111
class PushResult(_Result):
2112
"""Result of a Branch.push operation.
2114
:ivar old_revno: Revision number before push.
2115
:ivar new_revno: Revision number after push.
2116
:ivar old_revid: Tip revision id before push.
2117
:ivar new_revid: Tip revision id after push.
2118
:ivar source_branch: Source branch object.
2119
:ivar master_branch: Master branch of the target, or None.
2120
:ivar target_branch: Target/destination branch object.
2124
# DEPRECATED: push used to return the change in revno
2125
return self.new_revno - self.old_revno
2127
def report(self, to_file):
2128
"""Write a human-readable description of the result."""
2129
if self.old_revid == self.new_revid:
2130
to_file.write('No new revisions to push.\n')
2132
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2133
self._show_tag_conficts(to_file)
2136
class BranchCheckResult(object):
2137
"""Results of checking branch consistency.
2142
def __init__(self, branch):
2143
self.branch = branch
2145
def report_results(self, verbose):
2146
"""Report the check results via trace.note.
2148
:param verbose: Requests more detailed display of what was checked,
2151
note('checked branch %s format %s',
2153
self.branch._format)
2156
class Converter5to6(object):
2157
"""Perform an in-place upgrade of format 5 to format 6"""
2159
def convert(self, branch):
2160
# Data for 5 and 6 can peacefully coexist.
2161
format = BzrBranchFormat6()
2162
new_branch = format.open(branch.bzrdir, _found=True)
2164
# Copy source data into target
2165
new_branch.set_last_revision_info(*branch.last_revision_info())
2166
new_branch.set_parent(branch.get_parent())
2167
new_branch.set_bound_location(branch.get_bound_location())
2168
new_branch.set_push_location(branch.get_push_location())
2170
# New branch has no tags by default
2171
new_branch.tags._set_tag_dict({})
2173
# Copying done; now update target format
2174
new_branch.control_files.put_utf8('format',
2175
format.get_format_string())
2177
# Clean up old files
2178
new_branch.control_files._transport.delete('revision-history')
2180
branch.set_parent(None)
2183
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
