24
27
from bzrlib import (
30
config as _mod_config,
35
revision as _mod_revision,
36
from bzrlib.config import TreeConfig
42
from bzrlib.config import BranchConfig, TreeConfig
43
from bzrlib.lockable_files import LockableFiles, TransportLock
44
from bzrlib.tag import (
37
50
from bzrlib.decorators import needs_read_lock, needs_write_lock
38
import bzrlib.errors as errors
39
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
40
HistoryMissing, InvalidRevisionId,
41
InvalidRevisionNumber, LockError, NoSuchFile,
51
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
52
HistoryMissing, InvalidRevisionId,
53
InvalidRevisionNumber, LockError, NoSuchFile,
42
54
NoSuchRevision, NoWorkingTree, NotVersionedError,
43
NotBranchError, UninitializableFormat,
44
UnlistableStore, UnlistableBranch,
55
NotBranchError, UninitializableFormat,
56
UnlistableStore, UnlistableBranch,
46
from bzrlib.lockable_files import LockableFiles, TransportLock
58
from bzrlib.hooks import Hooks
47
59
from bzrlib.symbol_versioning import (deprecated_function,
49
61
DEPRECATED_PARAMETER,
51
zero_eight, zero_nine,
63
zero_eight, zero_nine, zero_sixteen,
53
65
from bzrlib.trace import mutter, note
56
68
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
57
69
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
58
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
70
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
61
73
# TODO: Maybe include checks for common corruption of newlines, etc?
176
203
def get_physical_lock_status(self):
177
204
raise NotImplementedError(self.get_physical_lock_status)
207
def get_revision_id_to_revno_map(self):
208
"""Return the revision_id => dotted revno map.
210
This will be regenerated on demand, but will be cached.
212
:return: A dictionary mapping revision_id => dotted revno.
213
This dictionary should not be modified by the caller.
215
if self._revision_id_to_revno_cache is not None:
216
mapping = self._revision_id_to_revno_cache
218
mapping = self._gen_revno_map()
219
self._cache_revision_id_to_revno(mapping)
220
# TODO: jam 20070417 Since this is being cached, should we be returning
222
# I would rather not, and instead just declare that users should not
223
# modify the return value.
226
def _gen_revno_map(self):
227
"""Create a new mapping from revision ids to dotted revnos.
229
Dotted revnos are generated based on the current tip in the revision
231
This is the worker function for get_revision_id_to_revno_map, which
232
just caches the return value.
234
:return: A dictionary mapping revision_id => dotted revno.
236
last_revision = self.last_revision()
237
revision_graph = self.repository.get_revision_graph(last_revision)
238
merge_sorted_revisions = tsort.merge_sort(
243
revision_id_to_revno = dict((rev_id, revno)
244
for seq_num, rev_id, depth, revno, end_of_merge
245
in merge_sorted_revisions)
246
return revision_id_to_revno
248
def leave_lock_in_place(self):
249
"""Tell this branch object not to release the physical lock when this
252
If lock_write doesn't return a token, then this method is not supported.
254
self.control_files.leave_in_place()
256
def dont_leave_lock_in_place(self):
257
"""Tell this branch object to release the physical lock when this
258
object is unlocked, even if it didn't originally acquire it.
260
If lock_write doesn't return a token, then this method is not supported.
262
self.control_files.dont_leave_in_place()
179
264
def abspath(self, name):
180
265
"""Return absolute filename for something in the branch
291
383
def set_revision_history(self, rev_history):
292
384
raise NotImplementedError(self.set_revision_history)
386
def _cache_revision_history(self, rev_history):
387
"""Set the cached revision history to rev_history.
389
The revision_history method will use this cache to avoid regenerating
390
the revision history.
392
This API is semi-public; it only for use by subclasses, all other code
393
should consider it to be private.
395
self._revision_history_cache = rev_history
397
def _cache_revision_id_to_revno(self, revision_id_to_revno):
398
"""Set the cached revision_id => revno map to revision_id_to_revno.
400
This API is semi-public; it only for use by subclasses, all other code
401
should consider it to be private.
403
self._revision_id_to_revno_cache = revision_id_to_revno
405
def _clear_cached_state(self):
406
"""Clear any cached data on this branch, e.g. cached revision history.
408
This means the next call to revision_history will need to call
409
_gen_revision_history.
411
This API is semi-public; it only for use by subclasses, all other code
412
should consider it to be private.
414
self._revision_history_cache = None
415
self._revision_id_to_revno_cache = None
417
def _gen_revision_history(self):
418
"""Return sequence of revision hashes on to this branch.
420
Unlike revision_history, this method always regenerates or rereads the
421
revision history, i.e. it does not cache the result, so repeated calls
424
Concrete subclasses should override this instead of revision_history so
425
that subclasses do not need to deal with caching logic.
427
This API is semi-public; it only for use by subclasses, all other code
428
should consider it to be private.
430
raise NotImplementedError(self._gen_revision_history)
294
433
def revision_history(self):
295
"""Return sequence of revision hashes on to this branch."""
296
raise NotImplementedError('revision_history is abstract')
434
"""Return sequence of revision hashes on to this branch.
436
This method will cache the revision history for as long as it is safe to
439
if self._revision_history_cache is not None:
440
history = self._revision_history_cache
442
history = self._gen_revision_history()
443
self._cache_revision_history(history)
299
447
"""Return current revision number for this branch.
460
673
raise InvalidRevisionNumber(revno)
463
def clone(self, *args, **kwargs):
676
def clone(self, to_bzrdir, revision_id=None):
464
677
"""Clone this branch into to_bzrdir preserving all semantic values.
466
679
revision_id: if not None, the revision history in the new branch will
467
680
be truncated to end with revision_id.
469
# for API compatibility, until 0.8 releases we provide the old api:
470
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
471
# after 0.8 releases, the *args and **kwargs should be changed:
472
# def clone(self, to_bzrdir, revision_id=None):
473
if (kwargs.get('to_location', None) or
474
kwargs.get('revision', None) or
475
kwargs.get('basis_branch', None) or
476
(len(args) and isinstance(args[0], basestring))):
477
# backwards compatibility api:
478
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
479
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
482
basis_branch = args[2]
484
basis_branch = kwargs.get('basis_branch', None)
486
basis = basis_branch.bzrdir
491
revision_id = args[1]
493
revision_id = kwargs.get('revision', None)
498
# no default to raise if not provided.
499
url = kwargs.get('to_location')
500
return self.bzrdir.clone(url,
501
revision_id=revision_id,
502
basis=basis).open_branch()
504
# generate args by hand
506
revision_id = args[1]
508
revision_id = kwargs.get('revision_id', None)
512
# no default to raise if not provided.
513
to_bzrdir = kwargs.get('to_bzrdir')
514
682
result = self._format.initialize(to_bzrdir)
515
683
self.copy_content_into(result, revision_id=revision_id)
527
695
result.set_parent(self.bzrdir.root_transport.base)
531
def copy_content_into(self, destination, revision_id=None):
532
"""Copy the content of self into destination.
534
revision_id: if not None, the revision history in the new branch will
535
be truncated to end with revision_id.
698
def _synchronize_history(self, destination, revision_id):
699
"""Synchronize last revision and revision history between branches.
701
This version is most efficient when the destination is also a
702
BzrBranch5, but works for BzrBranch6 as long as the revision
703
history is the true lefthand parent history, and all of the revisions
704
are in the destination's repository. If not, set_revision_history
707
:param destination: The branch to copy the history into
708
:param revision_id: The revision-id to truncate history at. May
709
be None to copy complete history.
537
711
new_history = self.revision_history()
538
712
if revision_id is not None:
713
revision_id = osutils.safe_revision_id(revision_id)
540
715
new_history = new_history[:new_history.index(revision_id) + 1]
541
716
except ValueError:
542
717
rev = self.repository.get_revision(revision_id)
543
718
new_history = rev.get_history(self.repository)[1:]
544
719
destination.set_revision_history(new_history)
722
def copy_content_into(self, destination, revision_id=None):
723
"""Copy the content of self into destination.
725
revision_id: if not None, the revision history in the new branch will
726
be truncated to end with revision_id.
728
self._synchronize_history(destination, revision_id)
546
730
parent = self.get_parent()
547
731
except errors.InaccessibleParent, e:
590
788
produce a bound branch (heavyweight checkout)
591
789
:return: The tree of the created checkout
791
t = transport.get_transport(to_location)
594
t = transport.get_transport(to_location)
597
except errors.FileExists:
599
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
794
format = self._get_checkout_format()
795
checkout = format.initialize_on_transport(t)
600
796
BranchReferenceFormat().initialize(checkout, self)
798
format = self._get_checkout_format()
602
799
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
603
to_location, force_new_tree=False)
800
to_location, force_new_tree=False, format=format)
604
801
checkout = checkout_branch.bzrdir
605
802
checkout_branch.bind(self)
606
if revision_id is not None:
607
rh = checkout_branch.revision_history()
608
new_rh = rh[:rh.index(revision_id) + 1]
609
checkout_branch.set_revision_history(new_rh)
610
return checkout.create_workingtree(revision_id)
803
# pull up to the specified revision_id to set the initial
804
# branch tip correctly, and seed it with history.
805
checkout_branch.pull(self, stop_revision=revision_id)
806
tree = checkout.create_workingtree(revision_id)
807
basis_tree = tree.basis_tree()
808
basis_tree.lock_read()
810
for path, file_id in basis_tree.iter_references():
811
reference_parent = self.reference_parent(file_id, path)
812
reference_parent.create_checkout(tree.abspath(path),
813
basis_tree.get_reference_revision(file_id, path),
819
def reference_parent(self, file_id, path):
820
"""Return the parent branch for a tree-reference file_id
821
:param file_id: The file_id of the tree reference
822
:param path: The path of the file_id in the tree
823
:return: A branch associated with the file_id
825
# FIXME should provide multiple branches, based on config
826
return Branch.open(self.bzrdir.root_transport.clone(path).base)
828
def supports_tags(self):
829
return self._format.supports_tags()
613
832
class BranchFormat(object):
651
870
"""Return the current default format."""
652
871
return klass._default_format
873
def get_reference(self, a_bzrdir):
874
"""Get the target reference of the branch in a_bzrdir.
876
format probing must have been completed before calling
877
this method - it is assumed that the format of the branch
878
in a_bzrdir is correct.
880
:param a_bzrdir: The bzrdir to get the branch data from.
881
:return: None if the branch is not a reference branch.
654
885
def get_format_string(self):
655
886
"""Return the ASCII format string that identifies this format."""
656
887
raise NotImplementedError(self.get_format_string)
658
889
def get_format_description(self):
659
890
"""Return the short format description for this format."""
660
raise NotImplementedError(self.get_format_string)
891
raise NotImplementedError(self.get_format_description)
893
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
895
"""Initialize a branch in a bzrdir, with specified files
897
:param a_bzrdir: The bzrdir to initialize the branch in
898
:param utf8_files: The files to create as a list of
899
(filename, content) tuples
900
:param set_format: If True, set the format with
901
self.get_format_string. (BzrBranch4 has its format set
903
:return: a branch in this format
905
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
906
branch_transport = a_bzrdir.get_branch_transport(self)
908
'metadir': ('lock', lockdir.LockDir),
909
'branch4': ('branch-lock', lockable_files.TransportLock),
911
lock_name, lock_class = lock_map[lock_type]
912
control_files = lockable_files.LockableFiles(branch_transport,
913
lock_name, lock_class)
914
control_files.create_lock()
915
control_files.lock_write()
917
control_files.put_utf8('format', self.get_format_string())
919
for file, content in utf8_files:
920
control_files.put_utf8(file, content)
922
control_files.unlock()
923
return self.open(a_bzrdir, _found=True)
662
925
def initialize(self, a_bzrdir):
663
926
"""Create a branch of this format in a_bzrdir."""
696
959
def __str__(self):
697
960
return self.get_format_string().rstrip()
962
def supports_tags(self):
963
"""True if this format supports tags stored in the branch"""
964
return False # by default
966
# XXX: Probably doesn't really belong here -- mbp 20070212
967
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
969
branch_transport = a_bzrdir.get_branch_transport(self)
970
control_files = lockable_files.LockableFiles(branch_transport,
971
lock_filename, lock_class)
972
control_files.create_lock()
973
control_files.lock_write()
975
for filename, content in utf8_files:
976
control_files.put_utf8(filename, content)
978
control_files.unlock()
981
class BranchHooks(Hooks):
982
"""A dictionary mapping hook name to a list of callables for branch hooks.
984
e.g. ['set_rh'] Is the list of items to be called when the
985
set_revision_history function is invoked.
989
"""Create the default hooks.
991
These are all empty initially, because by default nothing should get
995
# Introduced in 0.15:
996
# invoked whenever the revision history has been set
997
# with set_revision_history. The api signature is
998
# (branch, revision_history), and the branch will
1001
# invoked after a push operation completes.
1002
# the api signature is
1004
# containing the members
1005
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1006
# where local is the local target branch or None, master is the target
1007
# master branch, and the rest should be self explanatory. The source
1008
# is read locked and the target branches write locked. Source will
1009
# be the local low-latency branch.
1010
self['post_push'] = []
1011
# invoked after a pull operation completes.
1012
# the api signature is
1014
# containing the members
1015
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1016
# where local is the local branch or None, master is the target
1017
# master branch, and the rest should be self explanatory. The source
1018
# is read locked and the target branches write locked. The local
1019
# branch is the low-latency branch.
1020
self['post_pull'] = []
1021
# invoked after a commit operation completes.
1022
# the api signature is
1023
# (local, master, old_revno, old_revid, new_revno, new_revid)
1024
# old_revid is NULL_REVISION for the first commit to a branch.
1025
self['post_commit'] = []
1026
# invoked after a uncommit operation completes.
1027
# the api signature is
1028
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1029
# local is the local branch or None, master is the target branch,
1030
# and an empty branch recieves new_revno of 0, new_revid of None.
1031
self['post_uncommit'] = []
1034
# install the default hooks into the Branch class.
1035
Branch.hooks = BranchHooks()
700
1038
class BzrBranchFormat4(BranchFormat):
701
1039
"""Bzr branch format 4.
802
1119
format = BranchFormat.find_format(a_bzrdir)
803
1120
assert format.__class__ == self.__class__
1122
transport = a_bzrdir.get_branch_transport(None)
1123
control_files = lockable_files.LockableFiles(transport, 'lock',
1125
return BzrBranch5(_format=self,
1126
_control_files=control_files,
1128
_repository=a_bzrdir.find_repository())
1130
raise NotBranchError(path=transport.base)
1133
class BzrBranchFormat6(BzrBranchFormat5):
1134
"""Branch format with last-revision
1136
Unlike previous formats, this has no explicit revision history. Instead,
1137
this just stores the last-revision, and the left-hand history leading
1138
up to there is the history.
1140
This format was introduced in bzr 0.15
1143
def get_format_string(self):
1144
"""See BranchFormat.get_format_string()."""
1145
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1147
def get_format_description(self):
1148
"""See BranchFormat.get_format_description()."""
1149
return "Branch format 6"
1151
def initialize(self, a_bzrdir):
1152
"""Create a branch of this format in a_bzrdir."""
1153
utf8_files = [('last-revision', '0 null:\n'),
1154
('branch-name', ''),
1155
('branch.conf', ''),
1158
return self._initialize_helper(a_bzrdir, utf8_files)
1160
def open(self, a_bzrdir, _found=False):
1161
"""Return the branch object for a_bzrdir
1163
_found is a private parameter, do not use it. It is used to indicate
1164
if format probing has already be done.
1167
format = BranchFormat.find_format(a_bzrdir)
1168
assert format.__class__ == self.__class__
804
1169
transport = a_bzrdir.get_branch_transport(None)
805
control_files = LockableFiles(transport, 'lock', lockdir.LockDir)
806
return BzrBranch5(_format=self,
1170
control_files = lockable_files.LockableFiles(transport, 'lock',
1172
return BzrBranch6(_format=self,
807
1173
_control_files=control_files,
808
1174
a_bzrdir=a_bzrdir,
809
1175
_repository=a_bzrdir.find_repository())
812
return "Bazaar-NG Metadir branch format 5"
1177
def supports_tags(self):
815
1181
class BranchReferenceFormat(BranchFormat):
899
1272
it's writable, and can be accessed via the normal filesystem API.
902
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
903
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1275
def __init__(self, _format=None,
904
1276
_control_files=None, a_bzrdir=None, _repository=None):
905
"""Create new branch object at a particular location.
907
transport -- A Transport object, defining how to access files.
909
init -- If True, create new control files in a previously
910
unversioned directory. If False, the branch must already
913
relax_version_check -- If true, the usual check for the branch
914
version is not applied. This is intended only for
915
upgrade/recovery type use; it's not guaranteed that
916
all operations will work on old format branches.
1277
"""Create new branch object at a particular location."""
1278
Branch.__init__(self)
918
1279
if a_bzrdir is None:
919
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1280
raise ValueError('a_bzrdir must be supplied')
921
1282
self.bzrdir = a_bzrdir
922
self._transport = self.bzrdir.transport.clone('..')
923
self._base = self._transport.base
1283
# self._transport used to point to the directory containing the
1284
# control directory, but was not used - now it's just the transport
1285
# for the branch control files. mbp 20070212
1286
self._base = self.bzrdir.transport.clone('..').base
924
1287
self._format = _format
925
1288
if _control_files is None:
926
1289
raise ValueError('BzrBranch _control_files is None')
927
1290
self.control_files = _control_files
928
if deprecated_passed(init):
929
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
930
"deprecated as of bzr 0.8. Please use Branch.create().",
934
# this is slower than before deprecation, oh well never mind.
936
self._initialize(transport.base)
937
self._check_format(_format)
938
if deprecated_passed(relax_version_check):
939
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
940
"relax_version_check parameter is deprecated as of bzr 0.8. "
941
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
945
if (not relax_version_check
946
and not self._format.is_supported()):
947
raise errors.UnsupportedFormatError(format=fmt)
948
if deprecated_passed(transport):
949
warn("BzrBranch.__init__(transport=XXX...): The transport "
950
"parameter is deprecated as of bzr 0.8. "
951
"Please use Branch.open, or bzrdir.open_branch().",
1291
self._transport = _control_files._transport
954
1292
self.repository = _repository
956
1294
def __str__(self):
959
1297
__repr__ = __str__
962
# TODO: It might be best to do this somewhere else,
963
# but it is nice for a Branch object to automatically
964
# cache it's information.
965
# Alternatively, we could have the Transport objects cache requests
966
# See the earlier discussion about how major objects (like Branch)
967
# should never expect their __del__ function to run.
968
# XXX: cache_root seems to be unused, 2006-01-13 mbp
969
if hasattr(self, 'cache_root') and self.cache_root is not None:
971
osutils.rmtree(self.cache_root)
974
self.cache_root = None
976
1299
def _get_base(self):
1300
"""Returns the directory containing the control directory."""
977
1301
return self._base
979
1303
base = property(_get_base, doc="The URL for the root of this branch.")
981
def _finish_transaction(self):
982
"""Exit the current transaction."""
983
return self.control_files._finish_transaction()
985
def get_transaction(self):
986
"""Return the current active transaction.
988
If no transaction is active, this returns a passthrough object
989
for which all data is immediately flushed and no caching happens.
991
# this is an explicit function so that we can do tricky stuff
992
# when the storage in rev_storage is elsewhere.
993
# we probably need to hook the two 'lock a location' and
994
# 'have a transaction' together more delicately, so that
995
# we can have two locks (branch and storage) and one transaction
996
# ... and finishing the transaction unlocks both, but unlocking
997
# does not. - RBC 20051121
998
return self.control_files.get_transaction()
1000
def _set_transaction(self, transaction):
1001
"""Set a new active transaction."""
1002
return self.control_files._set_transaction(transaction)
1004
1305
def abspath(self, name):
1005
1306
"""See Branch.abspath."""
1006
1307
return self.control_files._transport.abspath(name)
1008
def _check_format(self, format):
1009
"""Identify the branch format if needed.
1011
The format is stored as a reference to the format object in
1012
self._format for code that needs to check it later.
1014
The format parameter is either None or the branch format class
1015
used to open this branch.
1017
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1020
format = BranchFormat.find_format(self.bzrdir)
1021
self._format = format
1022
mutter("got branch format %s", self._format)
1310
@deprecated_method(zero_sixteen)
1024
1311
@needs_read_lock
1025
1312
def get_root_id(self):
1026
1313
"""See Branch.get_root_id."""
1070
1361
@needs_write_lock
1071
1362
def append_revision(self, *revision_ids):
1072
1363
"""See Branch.append_revision."""
1364
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1073
1365
for revision_id in revision_ids:
1366
_mod_revision.check_not_reserved_id(revision_id)
1074
1367
mutter("add {%s} to revision-history" % revision_id)
1075
1368
rev_history = self.revision_history()
1076
1369
rev_history.extend(revision_ids)
1077
1370
self.set_revision_history(rev_history)
1372
def _write_revision_history(self, history):
1373
"""Factored out of set_revision_history.
1375
This performs the actual writing to disk.
1376
It is intended to be called by BzrBranch5.set_revision_history."""
1377
self.control_files.put_bytes(
1378
'revision-history', '\n'.join(history))
1079
1380
@needs_write_lock
1080
1381
def set_revision_history(self, rev_history):
1081
1382
"""See Branch.set_revision_history."""
1082
self.control_files.put_utf8(
1083
'revision-history', '\n'.join(rev_history))
1084
transaction = self.get_transaction()
1085
history = transaction.map.find_revision_history()
1086
if history is not None:
1087
# update the revision history in the identity map.
1088
history[:] = list(rev_history)
1089
# this call is disabled because revision_history is
1090
# not really an object yet, and the transaction is for objects.
1091
# transaction.register_dirty(history)
1093
transaction.map.add_revision_history(rev_history)
1094
# this call is disabled because revision_history is
1095
# not really an object yet, and the transaction is for objects.
1096
# transaction.register_clean(history)
1099
def revision_history(self):
1100
"""See Branch.revision_history."""
1101
transaction = self.get_transaction()
1102
history = transaction.map.find_revision_history()
1103
if history is not None:
1104
# mutter("cache hit for revision-history in %s", self)
1105
return list(history)
1106
decode_utf8 = cache_utf8.decode
1107
history = [decode_utf8(l.rstrip('\r\n')) for l in
1108
self.control_files.get('revision-history').readlines()]
1109
transaction.map.add_revision_history(history)
1110
# this call is disabled because revision_history is
1111
# not really an object yet, and the transaction is for objects.
1112
# transaction.register_clean(history, precious=True)
1113
return list(history)
1383
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1384
self._clear_cached_state()
1385
self._write_revision_history(rev_history)
1386
self._cache_revision_history(rev_history)
1387
for hook in Branch.hooks['set_rh']:
1388
hook(self, rev_history)
1115
1390
@needs_write_lock
1116
def generate_revision_history(self, revision_id, last_rev=None,
1118
"""Create a new revision history that will finish with revision_id.
1120
:param revision_id: the new tip to use.
1121
:param last_rev: The previous last_revision. If not None, then this
1122
must be a ancestory of revision_id, or DivergedBranches is raised.
1123
:param other_branch: The other branch that DivergedBranches should
1124
raise with respect to.
1391
def set_last_revision_info(self, revno, revision_id):
1392
revision_id = osutils.safe_revision_id(revision_id)
1393
history = self._lefthand_history(revision_id)
1394
assert len(history) == revno, '%d != %d' % (len(history), revno)
1395
self.set_revision_history(history)
1397
def _gen_revision_history(self):
1398
history = self.control_files.get('revision-history').read().split('\n')
1399
if history[-1:] == ['']:
1400
# There shouldn't be a trailing newline, but just in case.
1404
def _lefthand_history(self, revision_id, last_rev=None,
1126
1406
# stop_revision must be a descendant of last_revision
1127
1407
stop_graph = self.repository.get_revision_graph(revision_id)
1128
1408
if last_rev is not None and last_rev not in stop_graph:
1181
1478
return self.bzrdir.open_workingtree()
1183
1480
@needs_write_lock
1184
def pull(self, source, overwrite=False, stop_revision=None):
1185
"""See Branch.pull."""
1481
def pull(self, source, overwrite=False, stop_revision=None,
1482
_hook_master=None, run_hooks=True):
1485
:param _hook_master: Private parameter - set the branch to
1486
be supplied as the master to push hooks.
1487
:param run_hooks: Private parameter - if false, this branch
1488
is being called because it's the master of the primary branch,
1489
so it should not run its hooks.
1491
result = PullResult()
1492
result.source_branch = source
1493
result.target_branch = self
1186
1494
source.lock_read()
1188
old_count = len(self.revision_history())
1496
result.old_revno, result.old_revid = self.last_revision_info()
1190
self.update_revisions(source,stop_revision)
1498
self.update_revisions(source, stop_revision)
1191
1499
except DivergedBranches:
1192
1500
if not overwrite:
1195
self.set_revision_history(source.revision_history())
1196
new_count = len(self.revision_history())
1197
return new_count - old_count
1503
if stop_revision is None:
1504
stop_revision = source.last_revision()
1505
self.generate_revision_history(stop_revision)
1506
result.tag_conflicts = source.tags.merge_to(self.tags)
1507
result.new_revno, result.new_revid = self.last_revision_info()
1509
result.master_branch = _hook_master
1510
result.local_branch = self
1512
result.master_branch = self
1513
result.local_branch = None
1515
for hook in Branch.hooks['post_pull']:
1199
1518
source.unlock()
1521
def _get_parent_location(self):
1522
_locs = ['parent', 'pull', 'x-pull']
1525
return self.control_files.get(l).read().strip('\n')
1531
def push(self, target, overwrite=False, stop_revision=None,
1532
_override_hook_source_branch=None):
1535
This is the basic concrete implementation of push()
1537
:param _override_hook_source_branch: If specified, run
1538
the hooks passing this Branch as the source, rather than self.
1539
This is for use of RemoteBranch, where push is delegated to the
1540
underlying vfs-based Branch.
1542
# TODO: Public option to disable running hooks - should be trivial but
1546
result = self._push_with_bound_branches(target, overwrite,
1548
_override_hook_source_branch=_override_hook_source_branch)
1553
def _push_with_bound_branches(self, target, overwrite,
1555
_override_hook_source_branch=None):
1556
"""Push from self into target, and into target's master if any.
1558
This is on the base BzrBranch class even though it doesn't support
1559
bound branches because the *target* might be bound.
1562
if _override_hook_source_branch:
1563
result.source_branch = _override_hook_source_branch
1564
for hook in Branch.hooks['post_push']:
1567
bound_location = target.get_bound_location()
1568
if bound_location and target.base != bound_location:
1569
# there is a master branch.
1571
# XXX: Why the second check? Is it even supported for a branch to
1572
# be bound to itself? -- mbp 20070507
1573
master_branch = target.get_master_branch()
1574
master_branch.lock_write()
1576
# push into the master from this branch.
1577
self._basic_push(master_branch, overwrite, stop_revision)
1578
# and push into the target branch from this. Note that we push from
1579
# this branch again, because its considered the highest bandwidth
1581
result = self._basic_push(target, overwrite, stop_revision)
1582
result.master_branch = master_branch
1583
result.local_branch = target
1587
master_branch.unlock()
1590
result = self._basic_push(target, overwrite, stop_revision)
1591
# TODO: Why set master_branch and local_branch if there's no
1592
# binding? Maybe cleaner to just leave them unset? -- mbp
1594
result.master_branch = target
1595
result.local_branch = None
1599
def _basic_push(self, target, overwrite, stop_revision):
1600
"""Basic implementation of push without bound branches or hooks.
1602
Must be called with self read locked and target write locked.
1604
result = PushResult()
1605
result.source_branch = self
1606
result.target_branch = target
1607
result.old_revno, result.old_revid = target.last_revision_info()
1609
target.update_revisions(self, stop_revision)
1610
except DivergedBranches:
1614
target.set_revision_history(self.revision_history())
1615
result.tag_conflicts = self.tags.merge_to(target.tags)
1616
result.new_revno, result.new_revid = target.last_revision_info()
1201
1619
def get_parent(self):
1202
1620
"""See Branch.get_parent."""
1204
_locs = ['parent', 'pull', 'x-pull']
1205
1622
assert self.base[-1] == '/'
1208
parent = self.control_files.get(l).read().strip('\n')
1211
# This is an old-format absolute path to a local branch
1212
# turn it into a url
1213
if parent.startswith('/'):
1214
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1216
return urlutils.join(self.base[:-1], parent)
1217
except errors.InvalidURLJoin, e:
1218
raise errors.InaccessibleParent(parent, self.base)
1221
def get_push_location(self):
1222
"""See Branch.get_push_location."""
1223
push_loc = self.get_config().get_user_option('push_location')
1623
parent = self._get_parent_location()
1626
# This is an old-format absolute path to a local branch
1627
# turn it into a url
1628
if parent.startswith('/'):
1629
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1631
return urlutils.join(self.base[:-1], parent)
1632
except errors.InvalidURLJoin, e:
1633
raise errors.InaccessibleParent(parent, self.base)
1226
1635
def set_push_location(self, location):
1227
1636
"""See Branch.set_push_location."""
1228
self.get_config().set_user_option('push_location', location,
1637
self.get_config().set_user_option(
1638
'push_location', location,
1639
store=_mod_config.STORE_LOCATION_NORECURSE)
1231
1641
@needs_write_lock
1232
1642
def set_parent(self, url):
1340
1774
# but binding itself may not be.
1341
1775
# Since we *have* to check at commit time, we don't
1342
1776
# *need* to check here
1345
# we are now equal to or a suffix of other.
1347
# Since we have 'pulled' from the remote location,
1348
# now we should try to pull in the opposite direction
1349
# in case the local tree has more revisions than the
1351
# There may be a different check you could do here
1352
# rather than actually trying to install revisions remotely.
1353
# TODO: capture an exception which indicates the remote branch
1355
# If it is up-to-date, this probably should not be a failure
1357
# lock other for write so the revision-history syncing cannot race
1361
# if this does not error, other now has the same last rev we do
1362
# it can only error if the pull from other was concurrent with
1363
# a commit to other from someone else.
1365
# until we ditch revision-history, we need to sync them up:
1366
self.set_revision_history(other.revision_history())
1367
# now other and self are up to date with each other and have the
1368
# same revision-history.
1778
# we want to raise diverged if:
1779
# last_rev is not in the other_last_rev history, AND
1780
# other_last_rev is not in our history, and do it without pulling
1782
last_rev = self.last_revision()
1783
if last_rev is not None:
1786
other_last_rev = other.last_revision()
1787
if other_last_rev is not None:
1788
# neither branch is new, we have to do some work to
1789
# ascertain diversion.
1790
remote_graph = other.repository.get_revision_graph(
1792
local_graph = self.repository.get_revision_graph(last_rev)
1793
if (last_rev not in remote_graph and
1794
other_last_rev not in local_graph):
1795
raise errors.DivergedBranches(self, other)
1372
1798
self.set_bound_location(other.base)
1374
1800
@needs_write_lock
1822
class BzrBranchExperimental(BzrBranch5):
1823
"""Bzr experimental branch format
1826
- a revision-history file.
1828
- a lock dir guarding the branch itself
1829
- all of this stored in a branch/ subdirectory
1830
- works with shared repositories.
1831
- a tag dictionary in the branch
1833
This format is new in bzr 0.15, but shouldn't be used for real data,
1836
This class acts as it's own BranchFormat.
1839
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1842
def get_format_string(cls):
1843
"""See BranchFormat.get_format_string()."""
1844
return "Bazaar-NG branch format experimental\n"
1847
def get_format_description(cls):
1848
"""See BranchFormat.get_format_description()."""
1849
return "Experimental branch format"
1852
def get_reference(cls, a_bzrdir):
1853
"""Get the target reference of the branch in a_bzrdir.
1855
format probing must have been completed before calling
1856
this method - it is assumed that the format of the branch
1857
in a_bzrdir is correct.
1859
:param a_bzrdir: The bzrdir to get the branch data from.
1860
:return: None if the branch is not a reference branch.
1865
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1867
branch_transport = a_bzrdir.get_branch_transport(cls)
1868
control_files = lockable_files.LockableFiles(branch_transport,
1869
lock_filename, lock_class)
1870
control_files.create_lock()
1871
control_files.lock_write()
1873
for filename, content in utf8_files:
1874
control_files.put_utf8(filename, content)
1876
control_files.unlock()
1879
def initialize(cls, a_bzrdir):
1880
"""Create a branch of this format in a_bzrdir."""
1881
utf8_files = [('format', cls.get_format_string()),
1882
('revision-history', ''),
1883
('branch-name', ''),
1886
cls._initialize_control_files(a_bzrdir, utf8_files,
1887
'lock', lockdir.LockDir)
1888
return cls.open(a_bzrdir, _found=True)
1891
def open(cls, a_bzrdir, _found=False):
1892
"""Return the branch object for a_bzrdir
1894
_found is a private parameter, do not use it. It is used to indicate
1895
if format probing has already be done.
1898
format = BranchFormat.find_format(a_bzrdir)
1899
assert format.__class__ == cls
1900
transport = a_bzrdir.get_branch_transport(None)
1901
control_files = lockable_files.LockableFiles(transport, 'lock',
1903
return cls(_format=cls,
1904
_control_files=control_files,
1906
_repository=a_bzrdir.find_repository())
1909
def is_supported(cls):
1912
def _make_tags(self):
1913
return BasicTags(self)
1916
def supports_tags(cls):
1920
BranchFormat.register_format(BzrBranchExperimental)
1923
class BzrBranch6(BzrBranch5):
1926
def last_revision_info(self):
1927
revision_string = self.control_files.get('last-revision').read()
1928
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1929
revision_id = cache_utf8.get_cached_utf8(revision_id)
1931
return revno, revision_id
1933
def last_revision(self):
1934
"""Return last revision id, or None"""
1935
revision_id = self.last_revision_info()[1]
1936
if revision_id == _mod_revision.NULL_REVISION:
1940
def _write_last_revision_info(self, revno, revision_id):
1941
"""Simply write out the revision id, with no checks.
1943
Use set_last_revision_info to perform this safely.
1945
Does not update the revision_history cache.
1946
Intended to be called by set_last_revision_info and
1947
_write_revision_history.
1949
if revision_id is None:
1950
revision_id = 'null:'
1951
out_string = '%d %s\n' % (revno, revision_id)
1952
self.control_files.put_bytes('last-revision', out_string)
1955
def set_last_revision_info(self, revno, revision_id):
1956
revision_id = osutils.safe_revision_id(revision_id)
1957
if self._get_append_revisions_only():
1958
self._check_history_violation(revision_id)
1959
self._write_last_revision_info(revno, revision_id)
1960
self._clear_cached_state()
1962
def _check_history_violation(self, revision_id):
1963
last_revision = self.last_revision()
1964
if last_revision is None:
1966
if last_revision not in self._lefthand_history(revision_id):
1967
raise errors.AppendRevisionsOnlyViolation(self.base)
1969
def _gen_revision_history(self):
1970
"""Generate the revision history from last revision
1972
history = list(self.repository.iter_reverse_revision_history(
1973
self.last_revision()))
1977
def _write_revision_history(self, history):
1978
"""Factored out of set_revision_history.
1980
This performs the actual writing to disk, with format-specific checks.
1981
It is intended to be called by BzrBranch5.set_revision_history.
1983
if len(history) == 0:
1984
last_revision = 'null:'
1986
if history != self._lefthand_history(history[-1]):
1987
raise errors.NotLefthandHistory(history)
1988
last_revision = history[-1]
1989
if self._get_append_revisions_only():
1990
self._check_history_violation(last_revision)
1991
self._write_last_revision_info(len(history), last_revision)
1994
def append_revision(self, *revision_ids):
1995
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1996
if len(revision_ids) == 0:
1998
prev_revno, prev_revision = self.last_revision_info()
1999
for revision in self.repository.get_revisions(revision_ids):
2000
if prev_revision == _mod_revision.NULL_REVISION:
2001
if revision.parent_ids != []:
2002
raise errors.NotLeftParentDescendant(self, prev_revision,
2003
revision.revision_id)
2005
if revision.parent_ids[0] != prev_revision:
2006
raise errors.NotLeftParentDescendant(self, prev_revision,
2007
revision.revision_id)
2008
prev_revision = revision.revision_id
2009
self.set_last_revision_info(prev_revno + len(revision_ids),
2013
def _set_parent_location(self, url):
2014
"""Set the parent branch"""
2015
self._set_config_location('parent_location', url, make_relative=True)
2018
def _get_parent_location(self):
2019
"""Set the parent branch"""
2020
return self._get_config_location('parent_location')
2022
def set_push_location(self, location):
2023
"""See Branch.set_push_location."""
2024
self._set_config_location('push_location', location)
2026
def set_bound_location(self, location):
2027
"""See Branch.set_push_location."""
2029
config = self.get_config()
2030
if location is None:
2031
if config.get_user_option('bound') != 'True':
2034
config.set_user_option('bound', 'False')
2037
self._set_config_location('bound_location', location,
2039
config.set_user_option('bound', 'True')
2042
def _get_bound_location(self, bound):
2043
"""Return the bound location in the config file.
2045
Return None if the bound parameter does not match"""
2046
config = self.get_config()
2047
config_bound = (config.get_user_option('bound') == 'True')
2048
if config_bound != bound:
2050
return self._get_config_location('bound_location', config=config)
2052
def get_bound_location(self):
2053
"""See Branch.set_push_location."""
2054
return self._get_bound_location(True)
2056
def get_old_bound_location(self):
2057
"""See Branch.get_old_bound_location"""
2058
return self._get_bound_location(False)
2060
def set_append_revisions_only(self, enabled):
2065
self.get_config().set_user_option('append_revisions_only', value)
2067
def _get_append_revisions_only(self):
2068
value = self.get_config().get_user_option('append_revisions_only')
2069
return value == 'True'
2071
def _synchronize_history(self, destination, revision_id):
2072
"""Synchronize last revision and revision history between branches.
2074
This version is most efficient when the destination is also a
2075
BzrBranch6, but works for BzrBranch5, as long as the destination's
2076
repository contains all the lefthand ancestors of the intended
2077
last_revision. If not, set_last_revision_info will fail.
2079
:param destination: The branch to copy the history into
2080
:param revision_id: The revision-id to truncate history at. May
2081
be None to copy complete history.
2083
if revision_id is None:
2084
revno, revision_id = self.last_revision_info()
2086
revno = self.revision_id_to_revno(revision_id)
2087
destination.set_last_revision_info(revno, revision_id)
2089
def _make_tags(self):
2090
return BasicTags(self)
1396
2093
class BranchTestProviderAdapter(object):
1397
2094
"""A tool to generate a suite testing multiple branch formats at once.
1416
2114
new_test.bzrdir_format = bzrdir_format
1417
2115
new_test.branch_format = branch_format
1418
2116
def make_new_test_id():
1419
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
2117
# the format can be either a class or an instance
2118
name = getattr(branch_format, '__name__',
2119
branch_format.__class__.__name__)
2120
new_id = "%s(%s)" % (new_test.id(), name)
1420
2121
return lambda: new_id
1421
2122
new_test.id = make_new_test_id()
1422
2123
result.addTest(new_test)
2127
######################################################################
2128
# results of operations
2131
class _Result(object):
2133
def _show_tag_conficts(self, to_file):
2134
if not getattr(self, 'tag_conflicts', None):
2136
to_file.write('Conflicting tags:\n')
2137
for name, value1, value2 in self.tag_conflicts:
2138
to_file.write(' %s\n' % (name, ))
2141
class PullResult(_Result):
2142
"""Result of a Branch.pull operation.
2144
:ivar old_revno: Revision number before pull.
2145
:ivar new_revno: Revision number after pull.
2146
:ivar old_revid: Tip revision id before pull.
2147
:ivar new_revid: Tip revision id after pull.
2148
:ivar source_branch: Source (local) branch object.
2149
:ivar master_branch: Master branch of the target, or None.
2150
:ivar target_branch: Target/destination branch object.
2154
# DEPRECATED: pull used to return the change in revno
2155
return self.new_revno - self.old_revno
2157
def report(self, to_file):
2158
if self.old_revid == self.new_revid:
2159
to_file.write('No revisions to pull.\n')
2161
to_file.write('Now on revision %d.\n' % self.new_revno)
2162
self._show_tag_conficts(to_file)
2165
class PushResult(_Result):
2166
"""Result of a Branch.push operation.
2168
:ivar old_revno: Revision number before push.
2169
:ivar new_revno: Revision number after push.
2170
:ivar old_revid: Tip revision id before push.
2171
:ivar new_revid: Tip revision id after push.
2172
:ivar source_branch: Source branch object.
2173
:ivar master_branch: Master branch of the target, or None.
2174
:ivar target_branch: Target/destination branch object.
2178
# DEPRECATED: push used to return the change in revno
2179
return self.new_revno - self.old_revno
2181
def report(self, to_file):
2182
"""Write a human-readable description of the result."""
2183
if self.old_revid == self.new_revid:
2184
to_file.write('No new revisions to push.\n')
2186
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2187
self._show_tag_conficts(to_file)
1426
2190
class BranchCheckResult(object):
1427
2191
"""Results of checking branch consistency.
added
removed
bzrlib/branch.py
