319
271
The delta is relative to its mainline predecessor, or the
320
272
empty tree for revision 1.
274
assert isinstance(revno, int)
322
275
rh = self.revision_history()
323
276
if not (1 <= revno <= len(rh)):
324
raise errors.InvalidRevisionNumber(revno)
277
raise InvalidRevisionNumber(revno)
325
278
return self.repository.get_revision_delta(rh[revno-1])
280
def get_root_id(self):
281
"""Return the id of this branches root"""
282
raise NotImplementedError(self.get_root_id)
327
284
def print_file(self, file, revision_id):
328
285
"""Print `file` to stdout."""
329
286
raise NotImplementedError(self.print_file)
288
def append_revision(self, *revision_ids):
289
raise NotImplementedError(self.append_revision)
331
291
def set_revision_history(self, rev_history):
332
292
raise NotImplementedError(self.set_revision_history)
334
def _cache_revision_history(self, rev_history):
335
"""Set the cached revision history to rev_history.
337
The revision_history method will use this cache to avoid regenerating
338
the revision history.
340
This API is semi-public; it only for use by subclasses, all other code
341
should consider it to be private.
343
self._revision_history_cache = rev_history
345
def _cache_revision_id_to_revno(self, revision_id_to_revno):
346
"""Set the cached revision_id => revno map to revision_id_to_revno.
348
This API is semi-public; it only for use by subclasses, all other code
349
should consider it to be private.
351
self._revision_id_to_revno_cache = revision_id_to_revno
353
def _clear_cached_state(self):
354
"""Clear any cached data on this branch, e.g. cached revision history.
356
This means the next call to revision_history will need to call
357
_gen_revision_history.
359
This API is semi-public; it only for use by subclasses, all other code
360
should consider it to be private.
362
self._revision_history_cache = None
363
self._revision_id_to_revno_cache = None
365
def _gen_revision_history(self):
366
"""Return sequence of revision hashes on to this branch.
368
Unlike revision_history, this method always regenerates or rereads the
369
revision history, i.e. it does not cache the result, so repeated calls
372
Concrete subclasses should override this instead of revision_history so
373
that subclasses do not need to deal with caching logic.
375
This API is semi-public; it only for use by subclasses, all other code
376
should consider it to be private.
378
raise NotImplementedError(self._gen_revision_history)
381
294
def revision_history(self):
382
"""Return sequence of revision ids on this branch.
384
This method will cache the revision history for as long as it is safe to
387
if 'evil' in debug.debug_flags:
388
mutter_callsite(3, "revision_history scales with history.")
389
if self._revision_history_cache is not None:
390
history = self._revision_history_cache
392
history = self._gen_revision_history()
393
self._cache_revision_history(history)
295
"""Return sequence of revision hashes on to this branch."""
296
raise NotImplementedError('revision_history is abstract')
397
299
"""Return current revision number for this branch.
721
580
mainline_parent_id = revision_id
722
581
return BranchCheckResult(self)
724
def _get_checkout_format(self):
725
"""Return the most suitable metadir for a checkout of this branch.
726
Weaves are used if this branch's repository uses weaves.
728
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
729
from bzrlib.repofmt import weaverepo
730
format = bzrdir.BzrDirMetaFormat1()
731
format.repository_format = weaverepo.RepositoryFormat7()
733
format = self.repository.bzrdir.checkout_metadir()
734
format.set_branch_format(self._format)
737
def create_checkout(self, to_location, revision_id=None,
738
lightweight=False, accelerator_tree=None,
583
def create_checkout(self, to_location, revision_id=None,
740
585
"""Create a checkout of a branch.
742
587
:param to_location: The url to produce the checkout at
743
588
:param revision_id: The revision to check out
744
589
:param lightweight: If True, produce a lightweight checkout, otherwise,
745
590
produce a bound branch (heavyweight checkout)
746
:param accelerator_tree: A tree which can be used for retrieving file
747
contents more quickly than the revision tree, i.e. a workingtree.
748
The revision tree will be used for cases where accelerator_tree's
749
content is different.
750
:param hardlink: If true, hard-link files from accelerator_tree,
752
591
:return: The tree of the created checkout
754
t = transport.get_transport(to_location)
757
format = self._get_checkout_format()
758
checkout = format.initialize_on_transport(t)
759
from_branch = BranchReferenceFormat().initialize(checkout, self)
594
t = transport.get_transport(to_location)
597
except errors.FileExists:
599
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
600
BranchReferenceFormat().initialize(checkout, self)
761
format = self._get_checkout_format()
762
602
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
763
to_location, force_new_tree=False, format=format)
603
to_location, force_new_tree=False)
764
604
checkout = checkout_branch.bzrdir
765
605
checkout_branch.bind(self)
766
# pull up to the specified revision_id to set the initial
767
# branch tip correctly, and seed it with history.
768
checkout_branch.pull(self, stop_revision=revision_id)
770
tree = checkout.create_workingtree(revision_id,
771
from_branch=from_branch,
772
accelerator_tree=accelerator_tree,
774
basis_tree = tree.basis_tree()
775
basis_tree.lock_read()
777
for path, file_id in basis_tree.iter_references():
778
reference_parent = self.reference_parent(file_id, path)
779
reference_parent.create_checkout(tree.abspath(path),
780
basis_tree.get_reference_revision(file_id, path),
787
def reconcile(self, thorough=True):
788
"""Make sure the data stored in this branch is consistent."""
789
from bzrlib.reconcile import BranchReconciler
790
reconciler = BranchReconciler(self, thorough=thorough)
791
reconciler.reconcile()
794
def reference_parent(self, file_id, path):
795
"""Return the parent branch for a tree-reference file_id
796
:param file_id: The file_id of the tree reference
797
:param path: The path of the file_id in the tree
798
:return: A branch associated with the file_id
800
# FIXME should provide multiple branches, based on config
801
return Branch.open(self.bzrdir.root_transport.clone(path).base)
803
def supports_tags(self):
804
return self._format.supports_tags()
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)
807
613
class BranchFormat(object):
841
641
transport = a_bzrdir.get_branch_transport(None)
842
642
format_string = transport.get("format").read()
843
643
return klass._formats[format_string]
844
except errors.NoSuchFile:
845
raise errors.NotBranchError(path=transport.base)
645
raise NotBranchError(path=transport.base)
847
raise errors.UnknownFormatError(format=format_string, kind='branch')
647
raise errors.UnknownFormatError(format=format_string)
850
650
def get_default_format(klass):
851
651
"""Return the current default format."""
852
652
return klass._default_format
854
def get_reference(self, a_bzrdir):
855
"""Get the target reference of the branch in a_bzrdir.
857
format probing must have been completed before calling
858
this method - it is assumed that the format of the branch
859
in a_bzrdir is correct.
861
:param a_bzrdir: The bzrdir to get the branch data from.
862
:return: None if the branch is not a reference branch.
867
def set_reference(self, a_bzrdir, to_branch):
868
"""Set the target reference of the branch in a_bzrdir.
870
format probing must have been completed before calling
871
this method - it is assumed that the format of the branch
872
in a_bzrdir is correct.
874
:param a_bzrdir: The bzrdir to set the branch reference for.
875
:param to_branch: branch that the checkout is to reference
877
raise NotImplementedError(self.set_reference)
879
654
def get_format_string(self):
880
655
"""Return the ASCII format string that identifies this format."""
881
656
raise NotImplementedError(self.get_format_string)
883
658
def get_format_description(self):
884
659
"""Return the short format description for this format."""
885
raise NotImplementedError(self.get_format_description)
887
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
889
"""Initialize a branch in a bzrdir, with specified files
891
:param a_bzrdir: The bzrdir to initialize the branch in
892
:param utf8_files: The files to create as a list of
893
(filename, content) tuples
894
:param set_format: If True, set the format with
895
self.get_format_string. (BzrBranch4 has its format set
897
:return: a branch in this format
899
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
900
branch_transport = a_bzrdir.get_branch_transport(self)
902
'metadir': ('lock', lockdir.LockDir),
903
'branch4': ('branch-lock', lockable_files.TransportLock),
905
lock_name, lock_class = lock_map[lock_type]
906
control_files = lockable_files.LockableFiles(branch_transport,
907
lock_name, lock_class)
908
control_files.create_lock()
909
control_files.lock_write()
911
utf8_files += [('format', self.get_format_string())]
913
for (filename, content) in utf8_files:
914
branch_transport.put_bytes(
916
mode=control_files._file_mode)
918
control_files.unlock()
919
return self.open(a_bzrdir, _found=True)
660
raise NotImplementedError(self.get_format_string)
921
662
def initialize(self, a_bzrdir):
922
663
"""Create a branch of this format in a_bzrdir."""
951
692
def unregister_format(klass, format):
693
assert klass._formats[format.get_format_string()] is format
952
694
del klass._formats[format.get_format_string()]
954
696
def __str__(self):
955
697
return self.get_format_string().rstrip()
957
def supports_tags(self):
958
"""True if this format supports tags stored in the branch"""
959
return False # by default
962
class BranchHooks(Hooks):
963
"""A dictionary mapping hook name to a list of callables for branch hooks.
965
e.g. ['set_rh'] Is the list of items to be called when the
966
set_revision_history function is invoked.
970
"""Create the default hooks.
972
These are all empty initially, because by default nothing should get
976
# Introduced in 0.15:
977
# invoked whenever the revision history has been set
978
# with set_revision_history. The api signature is
979
# (branch, revision_history), and the branch will
982
# invoked after a push operation completes.
983
# the api signature is
985
# containing the members
986
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
987
# where local is the local target branch or None, master is the target
988
# master branch, and the rest should be self explanatory. The source
989
# is read locked and the target branches write locked. Source will
990
# be the local low-latency branch.
991
self['post_push'] = []
992
# invoked after a pull operation completes.
993
# the api signature is
995
# containing the members
996
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
997
# where local is the local branch or None, master is the target
998
# master branch, and the rest should be self explanatory. The source
999
# is read locked and the target branches write locked. The local
1000
# branch is the low-latency branch.
1001
self['post_pull'] = []
1002
# invoked before a commit operation takes place.
1003
# the api signature is
1004
# (local, master, old_revno, old_revid, future_revno, future_revid,
1005
# tree_delta, future_tree).
1006
# old_revid is NULL_REVISION for the first commit to a branch
1007
# tree_delta is a TreeDelta object describing changes from the basis
1008
# revision, hooks MUST NOT modify this delta
1009
# future_tree is an in-memory tree obtained from
1010
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1011
self['pre_commit'] = []
1012
# invoked after a commit operation completes.
1013
# the api signature is
1014
# (local, master, old_revno, old_revid, new_revno, new_revid)
1015
# old_revid is NULL_REVISION for the first commit to a branch.
1016
self['post_commit'] = []
1017
# invoked after a uncommit operation completes.
1018
# the api signature is
1019
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1020
# local is the local branch or None, master is the target branch,
1021
# and an empty branch recieves new_revno of 0, new_revid of None.
1022
self['post_uncommit'] = []
1024
# Invoked after the tip of a branch changes.
1025
# the api signature is
1026
# (params) where params is a ChangeBranchTipParams with the members
1027
# (branch, old_revno, new_revno, old_revid, new_revid)
1028
self['post_change_branch_tip'] = []
1031
# install the default hooks into the Branch class.
1032
Branch.hooks = BranchHooks()
1035
class ChangeBranchTipParams(object):
1036
"""Object holding parameters passed to *_change_branch_tip hooks.
1038
There are 5 fields that hooks may wish to access:
1040
:ivar branch: the branch being changed
1041
:ivar old_revno: revision number before the change
1042
:ivar new_revno: revision number after the change
1043
:ivar old_revid: revision id before the change
1044
:ivar new_revid: revision id after the change
1046
The revid fields are strings. The revno fields are integers.
1049
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1050
"""Create a group of ChangeBranchTip parameters.
1052
:param branch: The branch being changed.
1053
:param old_revno: Revision number before the change.
1054
:param new_revno: Revision number after the change.
1055
:param old_revid: Tip revision id before the change.
1056
:param new_revid: Tip revision id after the change.
1058
self.branch = branch
1059
self.old_revno = old_revno
1060
self.new_revno = new_revno
1061
self.old_revid = old_revid
1062
self.new_revid = new_revid
1065
700
class BzrBranchFormat4(BranchFormat):
1066
701
"""Bzr branch format 4.
1146
802
format = BranchFormat.find_format(a_bzrdir)
1147
if format.__class__ != self.__class__:
1148
raise AssertionError("wrong format %r found for %r" %
1151
transport = a_bzrdir.get_branch_transport(None)
1152
control_files = lockable_files.LockableFiles(transport, 'lock',
1154
return BzrBranch5(_format=self,
1155
_control_files=control_files,
1157
_repository=a_bzrdir.find_repository())
1158
except errors.NoSuchFile:
1159
raise errors.NotBranchError(path=transport.base)
1162
class BzrBranchFormat6(BzrBranchFormat5):
1163
"""Branch format with last-revision and tags.
1165
Unlike previous formats, this has no explicit revision history. Instead,
1166
this just stores the last-revision, and the left-hand history leading
1167
up to there is the history.
1169
This format was introduced in bzr 0.15
1170
and became the default in 0.91.
1173
def get_format_string(self):
1174
"""See BranchFormat.get_format_string()."""
1175
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1177
def get_format_description(self):
1178
"""See BranchFormat.get_format_description()."""
1179
return "Branch format 6"
1181
def initialize(self, a_bzrdir):
1182
"""Create a branch of this format in a_bzrdir."""
1183
utf8_files = [('last-revision', '0 null:\n'),
1184
('branch.conf', ''),
1187
return self._initialize_helper(a_bzrdir, utf8_files)
1189
def open(self, a_bzrdir, _found=False):
1190
"""Return the branch object for a_bzrdir
1192
_found is a private parameter, do not use it. It is used to indicate
1193
if format probing has already be done.
1196
format = BranchFormat.find_format(a_bzrdir)
1197
if format.__class__ != self.__class__:
1198
raise AssertionError("wrong format %r found for %r" %
803
assert format.__class__ == self.__class__
1200
804
transport = a_bzrdir.get_branch_transport(None)
1201
control_files = lockable_files.LockableFiles(transport, 'lock',
1203
return BzrBranch6(_format=self,
805
control_files = LockableFiles(transport, 'lock', lockdir.LockDir)
806
return BzrBranch5(_format=self,
1204
807
_control_files=control_files,
1205
808
a_bzrdir=a_bzrdir,
1206
809
_repository=a_bzrdir.find_repository())
1208
def supports_tags(self):
812
return "Bazaar-NG Metadir branch format 5"
1212
815
class BranchReferenceFormat(BranchFormat):
1313
897
Note that it's "local" in the context of the filesystem; it doesn't
1314
898
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1315
899
it's writable, and can be accessed via the normal filesystem API.
1317
:ivar _transport: Transport for file operations on this branch's
1318
control files, typically pointing to the .bzr/branch directory.
1319
:ivar repository: Repository for this branch.
1320
:ivar base: The url of the base directory for this branch; the one
1321
containing the .bzr directory.
1324
def __init__(self, _format=None,
902
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
903
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1325
904
_control_files=None, a_bzrdir=None, _repository=None):
1326
"""Create new branch object at a particular location."""
1327
Branch.__init__(self)
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.
1328
918
if a_bzrdir is None:
1329
raise ValueError('a_bzrdir must be supplied')
919
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1331
921
self.bzrdir = a_bzrdir
1332
self._base = self.bzrdir.transport.clone('..').base
1333
# XXX: We should be able to just do
1334
# self.base = self.bzrdir.root_transport.base
1335
# but this does not quite work yet -- mbp 20080522
922
self._transport = self.bzrdir.transport.clone('..')
923
self._base = self._transport.base
1336
924
self._format = _format
1337
925
if _control_files is None:
1338
926
raise ValueError('BzrBranch _control_files is None')
1339
927
self.control_files = _control_files
1340
self._transport = _control_files._transport
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().",
1341
954
self.repository = _repository
1343
956
def __str__(self):
1346
959
__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
1348
976
def _get_base(self):
1349
"""Returns the directory containing the control directory."""
1350
977
return self._base
1352
979
base = property(_get_base, doc="The URL for the root of this branch.")
1354
@deprecated_method(deprecated_in((0, 16, 0)))
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)
1355
1004
def abspath(self, name):
1356
1005
"""See Branch.abspath."""
1357
return self._transport.abspath(name)
1006
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)
1025
def get_root_id(self):
1026
"""See Branch.get_root_id."""
1027
tree = self.repository.revision_tree(self.last_revision())
1028
return tree.inventory.root.file_id
1359
1030
def is_locked(self):
1360
1031
return self.control_files.is_locked()
1362
def lock_write(self, token=None):
1363
repo_token = self.repository.lock_write()
1033
def lock_write(self):
1034
self.repository.lock_write()
1365
token = self.control_files.lock_write(token=token)
1036
self.control_files.lock_write()
1367
1038
self.repository.unlock()
1371
1041
def lock_read(self):
1372
1042
self.repository.lock_read()
1400
1067
"""See Branch.print_file."""
1401
1068
return self.repository.print_file(file, revision_id)
1403
def _write_revision_history(self, history):
1404
"""Factored out of set_revision_history.
1406
This performs the actual writing to disk.
1407
It is intended to be called by BzrBranch5.set_revision_history."""
1408
self._transport.put_bytes(
1409
'revision-history', '\n'.join(history),
1410
mode=self.control_files._file_mode)
1071
def append_revision(self, *revision_ids):
1072
"""See Branch.append_revision."""
1073
for revision_id in revision_ids:
1074
mutter("add {%s} to revision-history" % revision_id)
1075
rev_history = self.revision_history()
1076
rev_history.extend(revision_ids)
1077
self.set_revision_history(rev_history)
1412
1079
@needs_write_lock
1413
1080
def set_revision_history(self, rev_history):
1414
1081
"""See Branch.set_revision_history."""
1415
if 'evil' in debug.debug_flags:
1416
mutter_callsite(3, "set_revision_history scales with history.")
1417
self._write_revision_history(rev_history)
1418
self._clear_cached_state()
1419
self._cache_revision_history(rev_history)
1420
for hook in Branch.hooks['set_rh']:
1421
hook(self, rev_history)
1423
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1424
"""Run the post_change_branch_tip hooks."""
1425
hooks = Branch.hooks['post_change_branch_tip']
1428
new_revno, new_revid = self.last_revision_info()
1429
params = ChangeBranchTipParams(
1430
self, old_revno, new_revno, old_revid, new_revid)
1435
def set_last_revision_info(self, revno, revision_id):
1436
"""Set the last revision of this branch.
1438
The caller is responsible for checking that the revno is correct
1439
for this revision id.
1441
It may be possible to set the branch last revision to an id not
1442
present in the repository. However, branches can also be
1443
configured to check constraints on history, in which case this may not
1446
revision_id = _mod_revision.ensure_null(revision_id)
1447
old_revno, old_revid = self.last_revision_info()
1448
# this old format stores the full history, but this api doesn't
1449
# provide it, so we must generate, and might as well check it's
1451
history = self._lefthand_history(revision_id)
1452
if len(history) != revno:
1453
raise AssertionError('%d != %d' % (len(history), revno))
1454
self.set_revision_history(history)
1455
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1457
def _gen_revision_history(self):
1458
history = self._transport.get_bytes('revision-history').split('\n')
1459
if history[-1:] == ['']:
1460
# There shouldn't be a trailing newline, but just in case.
1464
def _lefthand_history(self, revision_id, last_rev=None,
1466
if 'evil' in debug.debug_flags:
1467
mutter_callsite(4, "_lefthand_history scales with history.")
1468
# stop_revision must be a descendant of last_revision
1469
graph = self.repository.get_graph()
1470
if last_rev is not None:
1471
if not graph.is_ancestor(last_rev, revision_id):
1472
# our previous tip is not merged into stop_revision
1473
raise errors.DivergedBranches(self, other_branch)
1474
# make a new revision history from the graph
1475
parents_map = graph.get_parent_map([revision_id])
1476
if revision_id not in parents_map:
1477
raise errors.NoSuchRevision(self, revision_id)
1478
current_rev_id = revision_id
1480
# Do not include ghosts or graph origin in revision_history
1481
while (current_rev_id in parents_map and
1482
len(parents_map[current_rev_id]) > 0):
1483
new_history.append(current_rev_id)
1484
current_rev_id = parents_map[current_rev_id][0]
1485
parents_map = graph.get_parent_map([current_rev_id])
1486
new_history.reverse()
1490
def generate_revision_history(self, revision_id, last_rev=None,
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)
1116
def generate_revision_history(self, revision_id, last_rev=None,
1491
1117
other_branch=None):
1492
1118
"""Create a new revision history that will finish with revision_id.
1494
1120
:param revision_id: the new tip to use.
1495
1121
:param last_rev: The previous last_revision. If not None, then this
1496
1122
must be a ancestory of revision_id, or DivergedBranches is raised.
1497
1123
:param other_branch: The other branch that DivergedBranches should
1498
1124
raise with respect to.
1500
self.set_revision_history(self._lefthand_history(revision_id,
1501
last_rev, other_branch))
1126
# stop_revision must be a descendant of last_revision
1127
stop_graph = self.repository.get_revision_graph(revision_id)
1128
if last_rev is not None and last_rev not in stop_graph:
1129
# our previous tip is not merged into stop_revision
1130
raise errors.DivergedBranches(self, other_branch)
1131
# make a new revision history from the graph
1132
current_rev_id = revision_id
1134
while current_rev_id not in (None, revision.NULL_REVISION):
1135
new_history.append(current_rev_id)
1136
current_rev_id_parents = stop_graph[current_rev_id]
1138
current_rev_id = current_rev_id_parents[0]
1140
current_rev_id = None
1141
new_history.reverse()
1142
self.set_revision_history(new_history)
1503
1144
@needs_write_lock
1504
def update_revisions(self, other, stop_revision=None, overwrite=False):
1145
def update_revisions(self, other, stop_revision=None):
1505
1146
"""See Branch.update_revisions."""
1506
1147
other.lock_read()
1508
other_last_revno, other_last_revision = other.last_revision_info()
1509
1149
if stop_revision is None:
1510
stop_revision = other_last_revision
1511
if _mod_revision.is_null(stop_revision):
1150
stop_revision = other.last_revision()
1151
if stop_revision is None:
1512
1152
# if there are no commits, we're done.
1514
1154
# whats the current last revision, before we fetch [and change it
1516
last_rev = _mod_revision.ensure_null(self.last_revision())
1517
# we fetch here so that we don't process data twice in the common
1518
# case of having something to pull, and so that the check for
1519
# already merged can operate on the just fetched graph, which will
1520
# be cached in memory.
1156
last_rev = self.last_revision()
1157
# we fetch here regardless of whether we need to so that we pickup
1521
1159
self.fetch(other, stop_revision)
1522
# Check to see if one is an ancestor of the other
1524
heads = self.repository.get_graph().heads([stop_revision,
1526
if heads == set([last_rev]):
1527
# The current revision is a decendent of the target,
1530
elif heads == set([stop_revision, last_rev]):
1531
# These branches have diverged
1532
raise errors.DivergedBranches(self, other)
1533
elif heads != set([stop_revision]):
1534
raise AssertionError("invalid heads: %r" % heads)
1535
if other_last_revision == stop_revision:
1536
self.set_last_revision_info(other_last_revno,
1537
other_last_revision)
1539
# TODO: jam 2007-11-29 Is there a way to determine the
1540
# revno without searching all of history??
1542
self.generate_revision_history(stop_revision)
1544
self.generate_revision_history(stop_revision,
1545
last_rev=last_rev, other_branch=other)
1160
my_ancestry = self.repository.get_ancestry(last_rev)
1161
if stop_revision in my_ancestry:
1162
# last_revision is a descendant of stop_revision
1164
self.generate_revision_history(stop_revision, last_rev=last_rev,
1550
1170
"""See Branch.basis_tree."""
1551
1171
return self.repository.revision_tree(self.last_revision())
1173
@deprecated_method(zero_eight)
1174
def working_tree(self):
1175
"""Create a Working tree object for this branch."""
1177
from bzrlib.transport.local import LocalTransport
1178
if (self.base.find('://') != -1 or
1179
not isinstance(self._transport, LocalTransport)):
1180
raise NoWorkingTree(self.base)
1181
return self.bzrdir.open_workingtree()
1553
1183
@needs_write_lock
1554
def pull(self, source, overwrite=False, stop_revision=None,
1555
_hook_master=None, run_hooks=True, possible_transports=None):
1558
:param _hook_master: Private parameter - set the branch to
1559
be supplied as the master to push hooks.
1560
:param run_hooks: Private parameter - if false, this branch
1561
is being called because it's the master of the primary branch,
1562
so it should not run its hooks.
1564
result = PullResult()
1565
result.source_branch = source
1566
result.target_branch = self
1184
def pull(self, source, overwrite=False, stop_revision=None):
1185
"""See Branch.pull."""
1567
1186
source.lock_read()
1569
result.old_revno, result.old_revid = self.last_revision_info()
1570
self.update_revisions(source, stop_revision, overwrite=overwrite)
1571
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1572
result.new_revno, result.new_revid = self.last_revision_info()
1574
result.master_branch = _hook_master
1575
result.local_branch = self
1577
result.master_branch = self
1578
result.local_branch = None
1580
for hook in Branch.hooks['post_pull']:
1188
old_count = len(self.revision_history())
1190
self.update_revisions(source,stop_revision)
1191
except DivergedBranches:
1195
self.set_revision_history(source.revision_history())
1196
new_count = len(self.revision_history())
1197
return new_count - old_count
1583
1199
source.unlock()
1586
def _get_parent_location(self):
1201
def get_parent(self):
1202
"""See Branch.get_parent."""
1587
1204
_locs = ['parent', 'pull', 'x-pull']
1205
assert self.base[-1] == '/'
1588
1206
for l in _locs:
1590
return self._transport.get_bytes(l).strip('\n')
1591
except errors.NoSuchFile:
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)
1596
def push(self, target, overwrite=False, stop_revision=None,
1597
_override_hook_source_branch=None):
1600
This is the basic concrete implementation of push()
1602
:param _override_hook_source_branch: If specified, run
1603
the hooks passing this Branch as the source, rather than self.
1604
This is for use of RemoteBranch, where push is delegated to the
1605
underlying vfs-based Branch.
1607
# TODO: Public option to disable running hooks - should be trivial but
1611
result = self._push_with_bound_branches(target, overwrite,
1613
_override_hook_source_branch=_override_hook_source_branch)
1618
def _push_with_bound_branches(self, target, overwrite,
1620
_override_hook_source_branch=None):
1621
"""Push from self into target, and into target's master if any.
1623
This is on the base BzrBranch class even though it doesn't support
1624
bound branches because the *target* might be bound.
1627
if _override_hook_source_branch:
1628
result.source_branch = _override_hook_source_branch
1629
for hook in Branch.hooks['post_push']:
1632
bound_location = target.get_bound_location()
1633
if bound_location and target.base != bound_location:
1634
# there is a master branch.
1636
# XXX: Why the second check? Is it even supported for a branch to
1637
# be bound to itself? -- mbp 20070507
1638
master_branch = target.get_master_branch()
1639
master_branch.lock_write()
1641
# push into the master from this branch.
1642
self._basic_push(master_branch, overwrite, stop_revision)
1643
# and push into the target branch from this. Note that we push from
1644
# this branch again, because its considered the highest bandwidth
1646
result = self._basic_push(target, overwrite, stop_revision)
1647
result.master_branch = master_branch
1648
result.local_branch = target
1652
master_branch.unlock()
1655
result = self._basic_push(target, overwrite, stop_revision)
1656
# TODO: Why set master_branch and local_branch if there's no
1657
# binding? Maybe cleaner to just leave them unset? -- mbp
1659
result.master_branch = target
1660
result.local_branch = None
1664
def _basic_push(self, target, overwrite, stop_revision):
1665
"""Basic implementation of push without bound branches or hooks.
1667
Must be called with self read locked and target write locked.
1669
result = PushResult()
1670
result.source_branch = self
1671
result.target_branch = target
1672
result.old_revno, result.old_revid = target.last_revision_info()
1673
target.update_revisions(self, stop_revision, overwrite)
1674
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1675
result.new_revno, result.new_revid = target.last_revision_info()
1678
def get_parent(self):
1679
"""See Branch.get_parent."""
1680
parent = self._get_parent_location()
1683
# This is an old-format absolute path to a local branch
1684
# turn it into a url
1685
if parent.startswith('/'):
1686
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1688
return urlutils.join(self.base[:-1], parent)
1689
except errors.InvalidURLJoin, e:
1690
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')
1692
1226
def set_push_location(self, location):
1693
1227
"""See Branch.set_push_location."""
1694
self.get_config().set_user_option(
1695
'push_location', location,
1696
store=_mod_config.STORE_LOCATION_NORECURSE)
1228
self.get_config().set_user_option('push_location', location,
1698
1231
@needs_write_lock
1699
1232
def set_parent(self, url):
1839
1377
return self.set_bound_location(None)
1841
1379
@needs_write_lock
1842
def update(self, possible_transports=None):
1843
1381
"""Synchronise this branch with the master branch if any.
1845
1383
:return: None or the last_revision that was pivoted out during the
1848
master = self.get_master_branch(possible_transports)
1386
master = self.get_master_branch()
1849
1387
if master is not None:
1850
old_tip = _mod_revision.ensure_null(self.last_revision())
1388
old_tip = self.last_revision()
1851
1389
self.pull(master, overwrite=True)
1852
if self.repository.get_graph().is_ancestor(old_tip,
1853
_mod_revision.ensure_null(self.last_revision())):
1390
if old_tip in self.repository.get_ancestry(self.last_revision()):
1859
class BzrBranch6(BzrBranch5):
1861
def __init__(self, *args, **kwargs):
1862
super(BzrBranch6, self).__init__(*args, **kwargs)
1863
self._last_revision_info_cache = None
1864
self._partial_revision_history_cache = []
1866
def _clear_cached_state(self):
1867
super(BzrBranch6, self)._clear_cached_state()
1868
self._last_revision_info_cache = None
1869
self._partial_revision_history_cache = []
1872
def last_revision_info(self):
1873
"""Return information about the last revision.
1875
:return: A tuple (revno, revision_id).
1877
if self._last_revision_info_cache is None:
1878
self._last_revision_info_cache = self._last_revision_info()
1879
return self._last_revision_info_cache
1881
def _last_revision_info(self):
1882
revision_string = self._transport.get_bytes('last-revision')
1883
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1884
revision_id = cache_utf8.get_cached_utf8(revision_id)
1886
return revno, revision_id
1888
def _write_last_revision_info(self, revno, revision_id):
1889
"""Simply write out the revision id, with no checks.
1891
Use set_last_revision_info to perform this safely.
1893
Does not update the revision_history cache.
1894
Intended to be called by set_last_revision_info and
1895
_write_revision_history.
1897
revision_id = _mod_revision.ensure_null(revision_id)
1898
out_string = '%d %s\n' % (revno, revision_id)
1899
self._transport.put_bytes('last-revision', out_string,
1900
mode=self.control_files._file_mode)
1903
def set_last_revision_info(self, revno, revision_id):
1904
revision_id = _mod_revision.ensure_null(revision_id)
1905
old_revno, old_revid = self.last_revision_info()
1906
if self._get_append_revisions_only():
1907
self._check_history_violation(revision_id)
1908
self._write_last_revision_info(revno, revision_id)
1909
self._clear_cached_state()
1910
self._last_revision_info_cache = revno, revision_id
1911
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1913
def _check_history_violation(self, revision_id):
1914
last_revision = _mod_revision.ensure_null(self.last_revision())
1915
if _mod_revision.is_null(last_revision):
1917
if last_revision not in self._lefthand_history(revision_id):
1918
raise errors.AppendRevisionsOnlyViolation(self.base)
1920
def _gen_revision_history(self):
1921
"""Generate the revision history from last revision
1923
self._extend_partial_history()
1924
return list(reversed(self._partial_revision_history_cache))
1926
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1927
"""Extend the partial history to include a given index
1929
If a stop_index is supplied, stop when that index has been reached.
1930
If a stop_revision is supplied, stop when that revision is
1931
encountered. Otherwise, stop when the beginning of history is
1934
:param stop_index: The index which should be present. When it is
1935
present, history extension will stop.
1936
:param revision_id: The revision id which should be present. When
1937
it is encountered, history extension will stop.
1939
repo = self.repository
1940
if len(self._partial_revision_history_cache) == 0:
1941
iterator = repo.iter_reverse_revision_history(self.last_revision())
1943
start_revision = self._partial_revision_history_cache[-1]
1944
iterator = repo.iter_reverse_revision_history(start_revision)
1945
#skip the last revision in the list
1946
next_revision = iterator.next()
1947
for revision_id in iterator:
1948
self._partial_revision_history_cache.append(revision_id)
1949
if (stop_index is not None and
1950
len(self._partial_revision_history_cache) > stop_index):
1952
if revision_id == stop_revision:
1955
def _write_revision_history(self, history):
1956
"""Factored out of set_revision_history.
1958
This performs the actual writing to disk, with format-specific checks.
1959
It is intended to be called by BzrBranch5.set_revision_history.
1961
if len(history) == 0:
1962
last_revision = 'null:'
1964
if history != self._lefthand_history(history[-1]):
1965
raise errors.NotLefthandHistory(history)
1966
last_revision = history[-1]
1967
if self._get_append_revisions_only():
1968
self._check_history_violation(last_revision)
1969
self._write_last_revision_info(len(history), last_revision)
1972
def _set_parent_location(self, url):
1973
"""Set the parent branch"""
1974
self._set_config_location('parent_location', url, make_relative=True)
1977
def _get_parent_location(self):
1978
"""Set the parent branch"""
1979
return self._get_config_location('parent_location')
1981
def set_push_location(self, location):
1982
"""See Branch.set_push_location."""
1983
self._set_config_location('push_location', location)
1985
def set_bound_location(self, location):
1986
"""See Branch.set_push_location."""
1988
config = self.get_config()
1989
if location is None:
1990
if config.get_user_option('bound') != 'True':
1993
config.set_user_option('bound', 'False', warn_masked=True)
1996
self._set_config_location('bound_location', location,
1998
config.set_user_option('bound', 'True', warn_masked=True)
2001
def _get_bound_location(self, bound):
2002
"""Return the bound location in the config file.
2004
Return None if the bound parameter does not match"""
2005
config = self.get_config()
2006
config_bound = (config.get_user_option('bound') == 'True')
2007
if config_bound != bound:
2009
return self._get_config_location('bound_location', config=config)
2011
def get_bound_location(self):
2012
"""See Branch.set_push_location."""
2013
return self._get_bound_location(True)
2015
def get_old_bound_location(self):
2016
"""See Branch.get_old_bound_location"""
2017
return self._get_bound_location(False)
2019
def set_append_revisions_only(self, enabled):
2024
self.get_config().set_user_option('append_revisions_only', value,
2027
def _get_append_revisions_only(self):
2028
value = self.get_config().get_user_option('append_revisions_only')
2029
return value == 'True'
2031
def _synchronize_history(self, destination, revision_id):
2032
"""Synchronize last revision and revision history between branches.
2034
This version is most efficient when the destination is also a
2035
BzrBranch6, but works for BzrBranch5, as long as the destination's
2036
repository contains all the lefthand ancestors of the intended
2037
last_revision. If not, set_last_revision_info will fail.
2039
:param destination: The branch to copy the history into
2040
:param revision_id: The revision-id to truncate history at. May
2041
be None to copy complete history.
2043
source_revno, source_revision_id = self.last_revision_info()
2044
if revision_id is None:
2045
revno, revision_id = source_revno, source_revision_id
2046
elif source_revision_id == revision_id:
2047
# we know the revno without needing to walk all of history
2048
revno = source_revno
2050
# To figure out the revno for a random revision, we need to build
2051
# the revision history, and count its length.
2052
# We don't care about the order, just how long it is.
2053
# Alternatively, we could start at the current location, and count
2054
# backwards. But there is no guarantee that we will find it since
2055
# it may be a merged revision.
2056
revno = len(list(self.repository.iter_reverse_revision_history(
2058
destination.set_last_revision_info(revno, revision_id)
2060
def _make_tags(self):
2061
return BasicTags(self)
2064
def generate_revision_history(self, revision_id, last_rev=None,
2066
"""See BzrBranch5.generate_revision_history"""
2067
history = self._lefthand_history(revision_id, last_rev, other_branch)
2068
revno = len(history)
2069
self.set_last_revision_info(revno, revision_id)
2072
def get_rev_id(self, revno, history=None):
2073
"""Find the revision id of the specified revno."""
2075
return _mod_revision.NULL_REVISION
2077
last_revno, last_revision_id = self.last_revision_info()
2078
if revno <= 0 or revno > last_revno:
2079
raise errors.NoSuchRevision(self, revno)
2081
if history is not None:
2082
return history[revno - 1]
2084
index = last_revno - revno
2085
if len(self._partial_revision_history_cache) <= index:
2086
self._extend_partial_history(stop_index=index)
2087
if len(self._partial_revision_history_cache) > index:
2088
return self._partial_revision_history_cache[index]
2090
raise errors.NoSuchRevision(self, revno)
2093
def revision_id_to_revno(self, revision_id):
2094
"""Given a revision id, return its revno"""
2095
if _mod_revision.is_null(revision_id):
2098
index = self._partial_revision_history_cache.index(revision_id)
2100
self._extend_partial_history(stop_revision=revision_id)
2101
index = len(self._partial_revision_history_cache) - 1
2102
if self._partial_revision_history_cache[index] != revision_id:
2103
raise errors.NoSuchRevision(self, revision_id)
2104
return self.revno() - index
2107
######################################################################
2108
# results of operations
2111
class _Result(object):
2113
def _show_tag_conficts(self, to_file):
2114
if not getattr(self, 'tag_conflicts', None):
2116
to_file.write('Conflicting tags:\n')
2117
for name, value1, value2 in self.tag_conflicts:
2118
to_file.write(' %s\n' % (name, ))
2121
class PullResult(_Result):
2122
"""Result of a Branch.pull operation.
2124
:ivar old_revno: Revision number before pull.
2125
:ivar new_revno: Revision number after pull.
2126
:ivar old_revid: Tip revision id before pull.
2127
:ivar new_revid: Tip revision id after pull.
2128
:ivar source_branch: Source (local) branch object.
2129
:ivar master_branch: Master branch of the target, or None.
2130
:ivar target_branch: Target/destination branch object.
2134
# DEPRECATED: pull used to return the change in revno
2135
return self.new_revno - self.old_revno
2137
def report(self, to_file):
2139
if self.old_revid == self.new_revid:
2140
to_file.write('No revisions to pull.\n')
2142
to_file.write('Now on revision %d.\n' % self.new_revno)
2143
self._show_tag_conficts(to_file)
2146
class PushResult(_Result):
2147
"""Result of a Branch.push operation.
2149
:ivar old_revno: Revision number before push.
2150
:ivar new_revno: Revision number after push.
2151
:ivar old_revid: Tip revision id before push.
2152
:ivar new_revid: Tip revision id after push.
2153
:ivar source_branch: Source branch object.
2154
:ivar master_branch: Master branch of the target, or None.
2155
:ivar target_branch: Target/destination branch object.
2159
# DEPRECATED: push used to return the change in revno
2160
return self.new_revno - self.old_revno
2162
def report(self, to_file):
2163
"""Write a human-readable description of the result."""
2164
if self.old_revid == self.new_revid:
2165
to_file.write('No new revisions to push.\n')
2167
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2168
self._show_tag_conficts(to_file)
1396
class BranchTestProviderAdapter(object):
1397
"""A tool to generate a suite testing multiple branch formats at once.
1399
This is done by copying the test once for each transport and injecting
1400
the transport_server, transport_readonly_server, and branch_format
1401
classes into each copy. Each copy is also given a new id() to make it
1405
def __init__(self, transport_server, transport_readonly_server, formats):
1406
self._transport_server = transport_server
1407
self._transport_readonly_server = transport_readonly_server
1408
self._formats = formats
1410
def adapt(self, test):
1411
result = TestSuite()
1412
for branch_format, bzrdir_format in self._formats:
1413
new_test = deepcopy(test)
1414
new_test.transport_server = self._transport_server
1415
new_test.transport_readonly_server = self._transport_readonly_server
1416
new_test.bzrdir_format = bzrdir_format
1417
new_test.branch_format = branch_format
1418
def make_new_test_id():
1419
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1420
return lambda: new_id
1421
new_test.id = make_new_test_id()
1422
result.addTest(new_test)
2171
1426
class BranchCheckResult(object):
added
removed
bzrlib/branch.py
