15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from copy import deepcopy
18
19
from cStringIO import StringIO
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
24
from unittest import TestSuite
22
25
from warnings import warn
28
config as _mod_config,
33
revision as _mod_revision,
40
from bzrlib.config import BranchConfig, TreeConfig
28
import bzrlib.bzrdir as bzrdir
29
from bzrlib.config import TreeConfig
30
from bzrlib.decorators import needs_read_lock, needs_write_lock
31
from bzrlib.delta import compare_trees
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError,
36
UninitializableFormat,
38
UnlistableBranch, NoSuchFile, NotVersionedError,
40
import bzrlib.inventory as inventory
41
from bzrlib.inventory import Inventory
41
42
from bzrlib.lockable_files import LockableFiles, TransportLock
42
from bzrlib.tag import (
48
from bzrlib.decorators import needs_read_lock, needs_write_lock
49
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
50
HistoryMissing, InvalidRevisionId,
51
InvalidRevisionNumber, LockError, NoSuchFile,
52
NoSuchRevision, NoWorkingTree, NotVersionedError,
53
NotBranchError, UninitializableFormat,
54
UnlistableStore, UnlistableBranch,
56
from bzrlib.hooks import Hooks
57
from bzrlib.symbol_versioning import (deprecated_function,
61
zero_eight, zero_nine, zero_sixteen,
43
from bzrlib.lockdir import LockDir
44
from bzrlib.osutils import (isdir, quotefn,
45
rename, splitpath, sha_file,
46
file_kind, abspath, normpath, pathjoin,
49
from bzrlib.textui import show_status
63
50
from bzrlib.trace import mutter, note
51
from bzrlib.tree import EmptyTree, RevisionTree
52
from bzrlib.repository import Repository
53
from bzrlib.revision import (
54
get_intervening_revisions,
59
from bzrlib.store import copy_all
60
from bzrlib.symbol_versioning import *
61
import bzrlib.transactions as transactions
62
from bzrlib.transport import Transport, get_transport
63
from bzrlib.tree import EmptyTree, RevisionTree
66
68
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
67
69
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
68
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
70
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
71
73
# TODO: Maybe include checks for common corruption of newlines, etc?
164
137
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
166
@deprecated_function(zero_eight)
167
139
def setup_caching(self, cache_root):
168
140
"""Subclasses that care about caching should override this, and set
169
141
up cached stores located under cache_root.
171
NOTE: This is unused.
175
def get_config(self):
176
return BranchConfig(self)
143
# seems to be unused, 2006-01-13 mbp
144
warn('%s is deprecated' % self.setup_caching)
145
self.cache_root = cache_root
178
147
def _get_nick(self):
179
return self.get_config().get_nickname()
148
cfg = self.tree_config()
149
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
181
151
def _set_nick(self, nick):
182
self.get_config().set_user_option('nickname', nick, warn_masked=True)
152
cfg = self.tree_config()
153
cfg.set_option(nick, "nickname")
154
assert cfg.get_option("nickname") == nick
184
156
nick = property(_get_nick, _set_nick)
187
raise NotImplementedError(self.is_locked)
189
158
def lock_write(self):
190
raise NotImplementedError(self.lock_write)
159
raise NotImplementedError('lock_write is abstract')
192
161
def lock_read(self):
193
raise NotImplementedError(self.lock_read)
162
raise NotImplementedError('lock_read is abstract')
195
164
def unlock(self):
196
raise NotImplementedError(self.unlock)
165
raise NotImplementedError('unlock is abstract')
198
167
def peek_lock_mode(self):
199
168
"""Return lock mode for the Branch: 'r', 'w' or None"""
200
169
raise NotImplementedError(self.peek_lock_mode)
202
def get_physical_lock_status(self):
203
raise NotImplementedError(self.get_physical_lock_status)
206
def get_revision_id_to_revno_map(self):
207
"""Return the revision_id => dotted revno map.
209
This will be regenerated on demand, but will be cached.
211
:return: A dictionary mapping revision_id => dotted revno.
212
This dictionary should not be modified by the caller.
214
if self._revision_id_to_revno_cache is not None:
215
mapping = self._revision_id_to_revno_cache
217
mapping = self._gen_revno_map()
218
self._cache_revision_id_to_revno(mapping)
219
# TODO: jam 20070417 Since this is being cached, should we be returning
221
# I would rather not, and instead just declare that users should not
222
# modify the return value.
225
def _gen_revno_map(self):
226
"""Create a new mapping from revision ids to dotted revnos.
228
Dotted revnos are generated based on the current tip in the revision
230
This is the worker function for get_revision_id_to_revno_map, which
231
just caches the return value.
233
:return: A dictionary mapping revision_id => dotted revno.
235
last_revision = self.last_revision()
236
revision_graph = self.repository.get_revision_graph(last_revision)
237
merge_sorted_revisions = tsort.merge_sort(
242
revision_id_to_revno = dict((rev_id, revno)
243
for seq_num, rev_id, depth, revno, end_of_merge
244
in merge_sorted_revisions)
245
return revision_id_to_revno
247
def leave_lock_in_place(self):
248
"""Tell this branch object not to release the physical lock when this
251
If lock_write doesn't return a token, then this method is not supported.
253
self.control_files.leave_in_place()
255
def dont_leave_lock_in_place(self):
256
"""Tell this branch object to release the physical lock when this
257
object is unlocked, even if it didn't originally acquire it.
259
If lock_write doesn't return a token, then this method is not supported.
261
self.control_files.dont_leave_in_place()
263
171
def abspath(self, name):
264
172
"""Return absolute filename for something in the branch
266
174
XXX: Robert Collins 20051017 what is this used for? why is it a branch
267
175
method and not a tree method.
269
raise NotImplementedError(self.abspath)
177
raise NotImplementedError('abspath is abstract')
271
179
def bind(self, other):
272
180
"""Bind the local branch the other branch.
354
def get_revision_delta(self, revno):
355
"""Return the delta for one revision.
357
The delta is relative to its mainline predecessor, or the
358
empty tree for revision 1.
360
assert isinstance(revno, int)
361
rh = self.revision_history()
362
if not (1 <= revno <= len(rh)):
363
raise InvalidRevisionNumber(revno)
364
return self.repository.get_revision_delta(rh[revno-1])
366
@deprecated_method(zero_sixteen)
367
240
def get_root_id(self):
368
"""Return the id of this branches root
370
Deprecated: branches don't have root ids-- trees do.
371
Use basis_tree().get_root_id() instead.
373
raise NotImplementedError(self.get_root_id)
241
"""Return the id of this branches root"""
242
raise NotImplementedError('get_root_id is abstract')
375
244
def print_file(self, file, revision_id):
376
245
"""Print `file` to stdout."""
377
raise NotImplementedError(self.print_file)
246
raise NotImplementedError('print_file is abstract')
379
248
def append_revision(self, *revision_ids):
380
raise NotImplementedError(self.append_revision)
249
raise NotImplementedError('append_revision is abstract')
382
251
def set_revision_history(self, rev_history):
383
raise NotImplementedError(self.set_revision_history)
385
def _cache_revision_history(self, rev_history):
386
"""Set the cached revision history to rev_history.
388
The revision_history method will use this cache to avoid regenerating
389
the revision history.
391
This API is semi-public; it only for use by subclasses, all other code
392
should consider it to be private.
394
self._revision_history_cache = rev_history
396
def _cache_revision_id_to_revno(self, revision_id_to_revno):
397
"""Set the cached revision_id => revno map to revision_id_to_revno.
399
This API is semi-public; it only for use by subclasses, all other code
400
should consider it to be private.
402
self._revision_id_to_revno_cache = revision_id_to_revno
404
def _clear_cached_state(self):
405
"""Clear any cached data on this branch, e.g. cached revision history.
407
This means the next call to revision_history will need to call
408
_gen_revision_history.
410
This API is semi-public; it only for use by subclasses, all other code
411
should consider it to be private.
413
self._revision_history_cache = None
414
self._revision_id_to_revno_cache = None
416
def _gen_revision_history(self):
417
"""Return sequence of revision hashes on to this branch.
419
Unlike revision_history, this method always regenerates or rereads the
420
revision history, i.e. it does not cache the result, so repeated calls
423
Concrete subclasses should override this instead of revision_history so
424
that subclasses do not need to deal with caching logic.
426
This API is semi-public; it only for use by subclasses, all other code
427
should consider it to be private.
429
raise NotImplementedError(self._gen_revision_history)
252
raise NotImplementedError('set_revision_history is abstract')
432
254
def revision_history(self):
433
"""Return sequence of revision hashes on to this branch.
435
This method will cache the revision history for as long as it is safe to
438
if self._revision_history_cache is not None:
439
history = self._revision_history_cache
441
history = self._gen_revision_history()
442
self._cache_revision_history(history)
255
"""Return sequence of revision hashes on to this branch."""
256
raise NotImplementedError('revision_history is abstract')
446
259
"""Return current revision number for this branch.
695
501
result.set_parent(self.bzrdir.root_transport.base)
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.
505
def copy_content_into(self, destination, revision_id=None):
506
"""Copy the content of self into destination.
508
revision_id: if not None, the revision history in the new branch will
509
be truncated to end with revision_id.
711
if revision_id == _mod_revision.NULL_REVISION:
713
511
new_history = self.revision_history()
714
if revision_id is not None and new_history != []:
715
revision_id = osutils.safe_revision_id(revision_id)
512
if revision_id is not None:
717
514
new_history = new_history[:new_history.index(revision_id) + 1]
718
515
except ValueError:
719
516
rev = self.repository.get_revision(revision_id)
720
517
new_history = rev.get_history(self.repository)[1:]
721
518
destination.set_revision_history(new_history)
724
def copy_content_into(self, destination, revision_id=None):
725
"""Copy the content of self into destination.
727
revision_id: if not None, the revision history in the new branch will
728
be truncated to end with revision_id.
730
self._synchronize_history(destination, revision_id)
732
parent = self.get_parent()
733
except errors.InaccessibleParent, e:
734
mutter('parent was not accessible to copy: %s', e)
737
destination.set_parent(parent)
738
self.tags.merge_to(destination.tags)
742
"""Check consistency of the branch.
744
In particular this checks that revisions given in the revision-history
745
do actually match up in the revision graph, and that they're all
746
present in the repository.
748
Callers will typically also want to check the repository.
750
:return: A BranchCheckResult.
752
mainline_parent_id = None
753
for revision_id in self.revision_history():
755
revision = self.repository.get_revision(revision_id)
756
except errors.NoSuchRevision, e:
757
raise errors.BzrCheckError("mainline revision {%s} not in repository"
759
# In general the first entry on the revision history has no parents.
760
# But it's not illegal for it to have parents listed; this can happen
761
# in imports from Arch when the parents weren't reachable.
762
if mainline_parent_id is not None:
763
if mainline_parent_id not in revision.parent_ids:
764
raise errors.BzrCheckError("previous revision {%s} not listed among "
766
% (mainline_parent_id, revision_id))
767
mainline_parent_id = revision_id
768
return BranchCheckResult(self)
770
def _get_checkout_format(self):
771
"""Return the most suitable metadir for a checkout of this branch.
772
Weaves are used if this branch's repository uses weaves.
774
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
775
from bzrlib.repofmt import weaverepo
776
format = bzrdir.BzrDirMetaFormat1()
777
format.repository_format = weaverepo.RepositoryFormat7()
779
format = self.repository.bzrdir.checkout_metadir()
780
format.set_branch_format(self._format)
783
def create_checkout(self, to_location, revision_id=None,
785
"""Create a checkout of a branch.
787
:param to_location: The url to produce the checkout at
788
:param revision_id: The revision to check out
789
:param lightweight: If True, produce a lightweight checkout, otherwise,
790
produce a bound branch (heavyweight checkout)
791
:return: The tree of the created checkout
793
t = transport.get_transport(to_location)
796
format = self._get_checkout_format()
797
checkout = format.initialize_on_transport(t)
798
BranchReferenceFormat().initialize(checkout, self)
800
format = self._get_checkout_format()
801
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
802
to_location, force_new_tree=False, format=format)
803
checkout = checkout_branch.bzrdir
804
checkout_branch.bind(self)
805
# pull up to the specified revision_id to set the initial
806
# branch tip correctly, and seed it with history.
807
checkout_branch.pull(self, stop_revision=revision_id)
808
tree = checkout.create_workingtree(revision_id)
809
basis_tree = tree.basis_tree()
810
basis_tree.lock_read()
812
for path, file_id in basis_tree.iter_references():
813
reference_parent = self.reference_parent(file_id, path)
814
reference_parent.create_checkout(tree.abspath(path),
815
basis_tree.get_reference_revision(file_id, path),
821
def reference_parent(self, file_id, path):
822
"""Return the parent branch for a tree-reference file_id
823
:param file_id: The file_id of the tree reference
824
:param path: The path of the file_id in the tree
825
:return: A branch associated with the file_id
827
# FIXME should provide multiple branches, based on config
828
return Branch.open(self.bzrdir.root_transport.clone(path).base)
830
def supports_tags(self):
831
return self._format.supports_tags()
519
parent = self.get_parent()
521
destination.set_parent(parent)
834
524
class BranchFormat(object):
967
603
def __str__(self):
968
604
return self.get_format_string().rstrip()
970
def supports_tags(self):
971
"""True if this format supports tags stored in the branch"""
972
return False # by default
974
# XXX: Probably doesn't really belong here -- mbp 20070212
975
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
977
branch_transport = a_bzrdir.get_branch_transport(self)
978
control_files = lockable_files.LockableFiles(branch_transport,
979
lock_filename, lock_class)
980
control_files.create_lock()
981
control_files.lock_write()
983
for filename, content in utf8_files:
984
control_files.put_utf8(filename, content)
986
control_files.unlock()
989
class BranchHooks(Hooks):
990
"""A dictionary mapping hook name to a list of callables for branch hooks.
992
e.g. ['set_rh'] Is the list of items to be called when the
993
set_revision_history function is invoked.
997
"""Create the default hooks.
999
These are all empty initially, because by default nothing should get
1002
Hooks.__init__(self)
1003
# Introduced in 0.15:
1004
# invoked whenever the revision history has been set
1005
# with set_revision_history. The api signature is
1006
# (branch, revision_history), and the branch will
1009
# invoked after a push operation completes.
1010
# the api signature is
1012
# containing the members
1013
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1014
# where local is the local target branch or None, master is the target
1015
# master branch, and the rest should be self explanatory. The source
1016
# is read locked and the target branches write locked. Source will
1017
# be the local low-latency branch.
1018
self['post_push'] = []
1019
# invoked after a pull operation completes.
1020
# the api signature is
1022
# containing the members
1023
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1024
# where local is the local branch or None, master is the target
1025
# master branch, and the rest should be self explanatory. The source
1026
# is read locked and the target branches write locked. The local
1027
# branch is the low-latency branch.
1028
self['post_pull'] = []
1029
# invoked after a commit operation completes.
1030
# the api signature is
1031
# (local, master, old_revno, old_revid, new_revno, new_revid)
1032
# old_revid is NULL_REVISION for the first commit to a branch.
1033
self['post_commit'] = []
1034
# invoked after a uncommit operation completes.
1035
# the api signature is
1036
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1037
# local is the local branch or None, master is the target branch,
1038
# and an empty branch recieves new_revno of 0, new_revid of None.
1039
self['post_uncommit'] = []
1042
# install the default hooks into the Branch class.
1043
Branch.hooks = BranchHooks()
1046
607
class BzrBranchFormat4(BranchFormat):
1047
608
"""Bzr branch format 4.
1280
794
it's writable, and can be accessed via the normal filesystem API.
1283
def __init__(self, _format=None,
797
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
798
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1284
799
_control_files=None, a_bzrdir=None, _repository=None):
1285
"""Create new branch object at a particular location."""
1286
Branch.__init__(self)
800
"""Create new branch object at a particular location.
802
transport -- A Transport object, defining how to access files.
804
init -- If True, create new control files in a previously
805
unversioned directory. If False, the branch must already
808
relax_version_check -- If true, the usual check for the branch
809
version is not applied. This is intended only for
810
upgrade/recovery type use; it's not guaranteed that
811
all operations will work on old format branches.
1287
813
if a_bzrdir is None:
1288
raise ValueError('a_bzrdir must be supplied')
814
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1290
816
self.bzrdir = a_bzrdir
1291
# self._transport used to point to the directory containing the
1292
# control directory, but was not used - now it's just the transport
1293
# for the branch control files. mbp 20070212
1294
self._base = self.bzrdir.transport.clone('..').base
817
self._transport = self.bzrdir.transport.clone('..')
818
self._base = self._transport.base
1295
819
self._format = _format
1296
820
if _control_files is None:
1297
raise ValueError('BzrBranch _control_files is None')
821
raise BzrBadParameterMissing('_control_files')
1298
822
self.control_files = _control_files
1299
self._transport = _control_files._transport
823
if deprecated_passed(init):
824
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
825
"deprecated as of bzr 0.8. Please use Branch.create().",
829
# this is slower than before deprecation, oh well never mind.
831
self._initialize(transport.base)
832
self._check_format(_format)
833
if deprecated_passed(relax_version_check):
834
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
835
"relax_version_check parameter is deprecated as of bzr 0.8. "
836
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
840
if (not relax_version_check
841
and not self._format.is_supported()):
842
raise errors.UnsupportedFormatError(
843
'sorry, branch format %r not supported' % fmt,
844
['use a different bzr version',
845
'or remove the .bzr directory'
846
' and "bzr init" again'])
847
if deprecated_passed(transport):
848
warn("BzrBranch.__init__(transport=XXX...): The transport "
849
"parameter is deprecated as of bzr 0.8. "
850
"Please use Branch.open, or bzrdir.open_branch().",
1300
853
self.repository = _repository
1302
855
def __str__(self):
1305
858
__repr__ = __str__
861
# TODO: It might be best to do this somewhere else,
862
# but it is nice for a Branch object to automatically
863
# cache it's information.
864
# Alternatively, we could have the Transport objects cache requests
865
# See the earlier discussion about how major objects (like Branch)
866
# should never expect their __del__ function to run.
867
# XXX: cache_root seems to be unused, 2006-01-13 mbp
868
if hasattr(self, 'cache_root') and self.cache_root is not None:
870
shutil.rmtree(self.cache_root)
873
self.cache_root = None
1307
875
def _get_base(self):
1308
"""Returns the directory containing the control directory."""
1309
876
return self._base
1311
878
base = property(_get_base, doc="The URL for the root of this branch.")
880
def _finish_transaction(self):
881
"""Exit the current transaction."""
882
return self.control_files._finish_transaction()
884
def get_transaction(self):
885
"""Return the current active transaction.
887
If no transaction is active, this returns a passthrough object
888
for which all data is immediately flushed and no caching happens.
890
# this is an explicit function so that we can do tricky stuff
891
# when the storage in rev_storage is elsewhere.
892
# we probably need to hook the two 'lock a location' and
893
# 'have a transaction' together more delicately, so that
894
# we can have two locks (branch and storage) and one transaction
895
# ... and finishing the transaction unlocks both, but unlocking
896
# does not. - RBC 20051121
897
return self.control_files.get_transaction()
899
def _set_transaction(self, transaction):
900
"""Set a new active transaction."""
901
return self.control_files._set_transaction(transaction)
1313
903
def abspath(self, name):
1314
904
"""See Branch.abspath."""
1315
905
return self.control_files._transport.abspath(name)
1318
@deprecated_method(zero_sixteen)
907
def _check_format(self, format):
908
"""Identify the branch format if needed.
910
The format is stored as a reference to the format object in
911
self._format for code that needs to check it later.
913
The format parameter is either None or the branch format class
914
used to open this branch.
916
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
919
format = BzrBranchFormat.find_format(self.bzrdir)
920
self._format = format
921
mutter("got branch format %s", self._format)
1319
923
@needs_read_lock
1320
924
def get_root_id(self):
1321
925
"""See Branch.get_root_id."""
1322
926
tree = self.repository.revision_tree(self.last_revision())
1323
927
return tree.inventory.root.file_id
1325
def is_locked(self):
1326
return self.control_files.is_locked()
1328
def lock_write(self, token=None):
1329
repo_token = self.repository.lock_write()
1331
token = self.control_files.lock_write(token=token)
1333
self.repository.unlock()
929
def lock_write(self):
930
# TODO: test for failed two phase locks. This is known broken.
931
self.control_files.lock_write()
932
self.repository.lock_write()
1337
934
def lock_read(self):
935
# TODO: test for failed two phase locks. This is known broken.
936
self.control_files.lock_read()
1338
937
self.repository.lock_read()
1340
self.control_files.lock_read()
1342
self.repository.unlock()
1345
939
def unlock(self):
1346
940
# TODO: test for failed two phase locks. This is known broken.
1348
self.control_files.unlock()
1350
self.repository.unlock()
1351
if not self.control_files.is_locked():
1352
# we just released the lock
1353
self._clear_cached_state()
941
self.repository.unlock()
942
self.control_files.unlock()
1355
944
def peek_lock_mode(self):
1356
945
if self.control_files._lock_count == 0:
1369
955
@needs_write_lock
1370
956
def append_revision(self, *revision_ids):
1371
957
"""See Branch.append_revision."""
1372
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1373
958
for revision_id in revision_ids:
1374
_mod_revision.check_not_reserved_id(revision_id)
1375
959
mutter("add {%s} to revision-history" % revision_id)
1376
960
rev_history = self.revision_history()
1377
961
rev_history.extend(revision_ids)
1378
962
self.set_revision_history(rev_history)
1380
def _write_revision_history(self, history):
1381
"""Factored out of set_revision_history.
1383
This performs the actual writing to disk.
1384
It is intended to be called by BzrBranch5.set_revision_history."""
1385
self.control_files.put_bytes(
1386
'revision-history', '\n'.join(history))
1388
964
@needs_write_lock
1389
965
def set_revision_history(self, rev_history):
1390
966
"""See Branch.set_revision_history."""
1391
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1392
self._clear_cached_state()
1393
self._write_revision_history(rev_history)
1394
self._cache_revision_history(rev_history)
1395
for hook in Branch.hooks['set_rh']:
1396
hook(self, rev_history)
1399
def set_last_revision_info(self, revno, revision_id):
1400
revision_id = osutils.safe_revision_id(revision_id)
1401
history = self._lefthand_history(revision_id)
1402
assert len(history) == revno, '%d != %d' % (len(history), revno)
1403
self.set_revision_history(history)
1405
def _gen_revision_history(self):
1406
history = self.control_files.get('revision-history').read().split('\n')
1407
if history[-1:] == ['']:
1408
# There shouldn't be a trailing newline, but just in case.
1412
def _lefthand_history(self, revision_id, last_rev=None,
1414
# stop_revision must be a descendant of last_revision
1415
stop_graph = self.repository.get_revision_graph(revision_id)
1416
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1417
and last_rev not in stop_graph):
1418
# our previous tip is not merged into stop_revision
1419
raise errors.DivergedBranches(self, other_branch)
1420
# make a new revision history from the graph
1421
current_rev_id = revision_id
1423
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1424
new_history.append(current_rev_id)
1425
current_rev_id_parents = stop_graph[current_rev_id]
1427
current_rev_id = current_rev_id_parents[0]
1429
current_rev_id = None
1430
new_history.reverse()
1434
def generate_revision_history(self, revision_id, last_rev=None,
1436
"""Create a new revision history that will finish with revision_id.
1438
:param revision_id: the new tip to use.
1439
:param last_rev: The previous last_revision. If not None, then this
1440
must be a ancestory of revision_id, or DivergedBranches is raised.
1441
:param other_branch: The other branch that DivergedBranches should
1442
raise with respect to.
967
self.control_files.put_utf8(
968
'revision-history', '\n'.join(rev_history))
969
transaction = self.get_transaction()
970
history = transaction.map.find_revision_history()
971
if history is not None:
972
# update the revision history in the identity map.
973
history[:] = list(rev_history)
974
# this call is disabled because revision_history is
975
# not really an object yet, and the transaction is for objects.
976
# transaction.register_dirty(history)
978
transaction.map.add_revision_history(rev_history)
979
# this call is disabled because revision_history is
980
# not really an object yet, and the transaction is for objects.
981
# transaction.register_clean(history)
983
def get_revision_delta(self, revno):
984
"""Return the delta for one revision.
986
The delta is relative to its mainline predecessor, or the
987
empty tree for revision 1.
1444
revision_id = osutils.safe_revision_id(revision_id)
1445
self.set_revision_history(self._lefthand_history(revision_id,
1446
last_rev, other_branch))
989
assert isinstance(revno, int)
990
rh = self.revision_history()
991
if not (1 <= revno <= len(rh)):
992
raise InvalidRevisionNumber(revno)
994
# revno is 1-based; list is 0-based
996
new_tree = self.repository.revision_tree(rh[revno-1])
998
old_tree = EmptyTree()
1000
old_tree = self.repository.revision_tree(rh[revno-2])
1001
return compare_trees(old_tree, new_tree)
1004
def revision_history(self):
1005
"""See Branch.revision_history."""
1006
transaction = self.get_transaction()
1007
history = transaction.map.find_revision_history()
1008
if history is not None:
1009
mutter("cache hit for revision-history in %s", self)
1010
return list(history)
1011
history = [l.rstrip('\r\n') for l in
1012
self.control_files.get_utf8('revision-history').readlines()]
1013
transaction.map.add_revision_history(history)
1014
# this call is disabled because revision_history is
1015
# not really an object yet, and the transaction is for objects.
1016
# transaction.register_clean(history, precious=True)
1017
return list(history)
1449
1019
def update_revisions(self, other, stop_revision=None):
1450
1020
"""See Branch.update_revisions."""
1021
if stop_revision is None:
1022
stop_revision = other.last_revision()
1023
### Should this be checking is_ancestor instead of revision_history?
1024
if (stop_revision is not None and
1025
stop_revision in self.revision_history()):
1027
self.fetch(other, stop_revision)
1028
pullable_revs = self.pullable_revisions(other, stop_revision)
1029
if len(pullable_revs) > 0:
1030
self.append_revision(*pullable_revs)
1032
def pullable_revisions(self, other, stop_revision):
1033
other_revno = other.revision_id_to_revno(stop_revision)
1453
if stop_revision is None:
1454
stop_revision = other.last_revision()
1455
if stop_revision is None:
1456
# if there are no commits, we're done.
1459
stop_revision = osutils.safe_revision_id(stop_revision)
1460
# whats the current last revision, before we fetch [and change it
1462
last_rev = _mod_revision.ensure_null(self.last_revision())
1463
# we fetch here regardless of whether we need to so that we pickup
1465
self.fetch(other, stop_revision)
1466
my_ancestry = self.repository.get_ancestry(last_rev,
1468
if stop_revision in my_ancestry:
1469
# last_revision is a descendant of stop_revision
1471
self.generate_revision_history(stop_revision, last_rev=last_rev,
1035
return self.missing_revisions(other, other_revno)
1036
except DivergedBranches, e:
1038
pullable_revs = get_intervening_revisions(self.last_revision(),
1041
assert self.last_revision() not in pullable_revs
1042
return pullable_revs
1043
except bzrlib.errors.NotAncestor:
1044
if is_ancestor(self.last_revision(), stop_revision, self):
1476
1049
def basis_tree(self):
1477
1050
"""See Branch.basis_tree."""
1478
1051
return self.repository.revision_tree(self.last_revision())
1488
1061
return self.bzrdir.open_workingtree()
1490
1063
@needs_write_lock
1491
def pull(self, source, overwrite=False, stop_revision=None,
1492
_hook_master=None, run_hooks=True):
1495
:param _hook_master: Private parameter - set the branch to
1496
be supplied as the master to push hooks.
1497
:param run_hooks: Private parameter - if false, this branch
1498
is being called because it's the master of the primary branch,
1499
so it should not run its hooks.
1501
result = PullResult()
1502
result.source_branch = source
1503
result.target_branch = self
1064
def pull(self, source, overwrite=False, stop_revision=None):
1065
"""See Branch.pull."""
1504
1066
source.lock_read()
1506
result.old_revno, result.old_revid = self.last_revision_info()
1068
old_count = len(self.revision_history())
1508
self.update_revisions(source, stop_revision)
1070
self.update_revisions(source,stop_revision)
1509
1071
except DivergedBranches:
1510
1072
if not overwrite:
1513
if stop_revision is None:
1514
stop_revision = source.last_revision()
1515
self.generate_revision_history(stop_revision)
1516
result.tag_conflicts = source.tags.merge_to(self.tags)
1517
result.new_revno, result.new_revid = self.last_revision_info()
1519
result.master_branch = _hook_master
1520
result.local_branch = self
1522
result.master_branch = self
1523
result.local_branch = None
1525
for hook in Branch.hooks['post_pull']:
1075
self.set_revision_history(source.revision_history())
1076
new_count = len(self.revision_history())
1077
return new_count - old_count
1528
1079
source.unlock()
1531
def _get_parent_location(self):
1081
def get_parent(self):
1082
"""See Branch.get_parent."""
1532
1084
_locs = ['parent', 'pull', 'x-pull']
1533
1085
for l in _locs:
1535
return self.control_files.get(l).read().strip('\n')
1087
return self.control_files.get_utf8(l).read().strip('\n')
1536
1088
except NoSuchFile:
1541
def push(self, target, overwrite=False, stop_revision=None,
1542
_override_hook_source_branch=None):
1545
This is the basic concrete implementation of push()
1547
:param _override_hook_source_branch: If specified, run
1548
the hooks passing this Branch as the source, rather than self.
1549
This is for use of RemoteBranch, where push is delegated to the
1550
underlying vfs-based Branch.
1552
# TODO: Public option to disable running hooks - should be trivial but
1556
result = self._push_with_bound_branches(target, overwrite,
1558
_override_hook_source_branch=_override_hook_source_branch)
1563
def _push_with_bound_branches(self, target, overwrite,
1565
_override_hook_source_branch=None):
1566
"""Push from self into target, and into target's master if any.
1568
This is on the base BzrBranch class even though it doesn't support
1569
bound branches because the *target* might be bound.
1572
if _override_hook_source_branch:
1573
result.source_branch = _override_hook_source_branch
1574
for hook in Branch.hooks['post_push']:
1577
bound_location = target.get_bound_location()
1578
if bound_location and target.base != bound_location:
1579
# there is a master branch.
1581
# XXX: Why the second check? Is it even supported for a branch to
1582
# be bound to itself? -- mbp 20070507
1583
master_branch = target.get_master_branch()
1584
master_branch.lock_write()
1586
# push into the master from this branch.
1587
self._basic_push(master_branch, overwrite, stop_revision)
1588
# and push into the target branch from this. Note that we push from
1589
# this branch again, because its considered the highest bandwidth
1591
result = self._basic_push(target, overwrite, stop_revision)
1592
result.master_branch = master_branch
1593
result.local_branch = target
1597
master_branch.unlock()
1600
result = self._basic_push(target, overwrite, stop_revision)
1601
# TODO: Why set master_branch and local_branch if there's no
1602
# binding? Maybe cleaner to just leave them unset? -- mbp
1604
result.master_branch = target
1605
result.local_branch = None
1609
def _basic_push(self, target, overwrite, stop_revision):
1610
"""Basic implementation of push without bound branches or hooks.
1612
Must be called with self read locked and target write locked.
1614
result = PushResult()
1615
result.source_branch = self
1616
result.target_branch = target
1617
result.old_revno, result.old_revid = target.last_revision_info()
1619
target.update_revisions(self, stop_revision)
1620
except DivergedBranches:
1624
target.set_revision_history(self.revision_history())
1625
result.tag_conflicts = self.tags.merge_to(target.tags)
1626
result.new_revno, result.new_revid = target.last_revision_info()
1629
def get_parent(self):
1630
"""See Branch.get_parent."""
1632
assert self.base[-1] == '/'
1633
parent = self._get_parent_location()
1636
# This is an old-format absolute path to a local branch
1637
# turn it into a url
1638
if parent.startswith('/'):
1639
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1641
return urlutils.join(self.base[:-1], parent)
1642
except errors.InvalidURLJoin, e:
1643
raise errors.InaccessibleParent(parent, self.base)
1092
def get_push_location(self):
1093
"""See Branch.get_push_location."""
1094
config = bzrlib.config.BranchConfig(self)
1095
push_loc = config.get_user_option('push_location')
1645
1098
def set_push_location(self, location):
1646
1099
"""See Branch.set_push_location."""
1647
self.get_config().set_user_option(
1648
'push_location', location,
1649
store=_mod_config.STORE_LOCATION_NORECURSE)
1100
config = bzrlib.config.LocationConfig(self.base)
1101
config.set_user_option('push_location', location)
1651
1103
@needs_write_lock
1652
1104
def set_parent(self, url):
1823
1244
if master is not None:
1824
1245
old_tip = self.last_revision()
1825
1246
self.pull(master, overwrite=True)
1826
if old_tip in self.repository.get_ancestry(
1827
_mod_revision.ensure_null(self.last_revision()),
1247
if old_tip in self.repository.get_ancestry(self.last_revision()):
1834
class BzrBranchExperimental(BzrBranch5):
1835
"""Bzr experimental branch format
1838
- a revision-history file.
1840
- a lock dir guarding the branch itself
1841
- all of this stored in a branch/ subdirectory
1842
- works with shared repositories.
1843
- a tag dictionary in the branch
1845
This format is new in bzr 0.15, but shouldn't be used for real data,
1848
This class acts as it's own BranchFormat.
1253
class BranchTestProviderAdapter(object):
1254
"""A tool to generate a suite testing multiple branch formats at once.
1256
This is done by copying the test once for each transport and injecting
1257
the transport_server, transport_readonly_server, and branch_format
1258
classes into each copy. Each copy is also given a new id() to make it
1851
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1854
def get_format_string(cls):
1855
"""See BranchFormat.get_format_string()."""
1856
return "Bazaar-NG branch format experimental\n"
1859
def get_format_description(cls):
1860
"""See BranchFormat.get_format_description()."""
1861
return "Experimental branch format"
1864
def get_reference(cls, a_bzrdir):
1865
"""Get the target reference of the branch in a_bzrdir.
1867
format probing must have been completed before calling
1868
this method - it is assumed that the format of the branch
1869
in a_bzrdir is correct.
1871
:param a_bzrdir: The bzrdir to get the branch data from.
1872
:return: None if the branch is not a reference branch.
1877
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1879
branch_transport = a_bzrdir.get_branch_transport(cls)
1880
control_files = lockable_files.LockableFiles(branch_transport,
1881
lock_filename, lock_class)
1882
control_files.create_lock()
1883
control_files.lock_write()
1885
for filename, content in utf8_files:
1886
control_files.put_utf8(filename, content)
1888
control_files.unlock()
1891
def initialize(cls, a_bzrdir):
1892
"""Create a branch of this format in a_bzrdir."""
1893
utf8_files = [('format', cls.get_format_string()),
1894
('revision-history', ''),
1895
('branch-name', ''),
1898
cls._initialize_control_files(a_bzrdir, utf8_files,
1899
'lock', lockdir.LockDir)
1900
return cls.open(a_bzrdir, _found=True)
1903
def open(cls, a_bzrdir, _found=False):
1904
"""Return the branch object for a_bzrdir
1906
_found is a private parameter, do not use it. It is used to indicate
1907
if format probing has already be done.
1910
format = BranchFormat.find_format(a_bzrdir)
1911
assert format.__class__ == cls
1912
transport = a_bzrdir.get_branch_transport(None)
1913
control_files = lockable_files.LockableFiles(transport, 'lock',
1915
return cls(_format=cls,
1916
_control_files=control_files,
1918
_repository=a_bzrdir.find_repository())
1921
def is_supported(cls):
1924
def _make_tags(self):
1925
return BasicTags(self)
1928
def supports_tags(cls):
1932
BranchFormat.register_format(BzrBranchExperimental)
1935
class BzrBranch6(BzrBranch5):
1938
def last_revision_info(self):
1939
revision_string = self.control_files.get('last-revision').read()
1940
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1941
revision_id = cache_utf8.get_cached_utf8(revision_id)
1943
return revno, revision_id
1945
def last_revision(self):
1946
"""Return last revision id, or None"""
1947
revision_id = self.last_revision_info()[1]
1948
if revision_id == _mod_revision.NULL_REVISION:
1952
def _write_last_revision_info(self, revno, revision_id):
1953
"""Simply write out the revision id, with no checks.
1955
Use set_last_revision_info to perform this safely.
1957
Does not update the revision_history cache.
1958
Intended to be called by set_last_revision_info and
1959
_write_revision_history.
1961
if revision_id is None:
1962
revision_id = 'null:'
1963
out_string = '%d %s\n' % (revno, revision_id)
1964
self.control_files.put_bytes('last-revision', out_string)
1967
def set_last_revision_info(self, revno, revision_id):
1968
revision_id = osutils.safe_revision_id(revision_id)
1969
if self._get_append_revisions_only():
1970
self._check_history_violation(revision_id)
1971
self._write_last_revision_info(revno, revision_id)
1972
self._clear_cached_state()
1974
def _check_history_violation(self, revision_id):
1975
last_revision = _mod_revision.ensure_null(self.last_revision())
1976
if _mod_revision.is_null(last_revision):
1978
if last_revision not in self._lefthand_history(revision_id):
1979
raise errors.AppendRevisionsOnlyViolation(self.base)
1981
def _gen_revision_history(self):
1982
"""Generate the revision history from last revision
1984
history = list(self.repository.iter_reverse_revision_history(
1985
self.last_revision()))
1989
def _write_revision_history(self, history):
1990
"""Factored out of set_revision_history.
1992
This performs the actual writing to disk, with format-specific checks.
1993
It is intended to be called by BzrBranch5.set_revision_history.
1995
if len(history) == 0:
1996
last_revision = 'null:'
1998
if history != self._lefthand_history(history[-1]):
1999
raise errors.NotLefthandHistory(history)
2000
last_revision = history[-1]
2001
if self._get_append_revisions_only():
2002
self._check_history_violation(last_revision)
2003
self._write_last_revision_info(len(history), last_revision)
2006
def append_revision(self, *revision_ids):
2007
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
2008
if len(revision_ids) == 0:
2010
prev_revno, prev_revision = self.last_revision_info()
2011
for revision in self.repository.get_revisions(revision_ids):
2012
if prev_revision == _mod_revision.NULL_REVISION:
2013
if revision.parent_ids != []:
2014
raise errors.NotLeftParentDescendant(self, prev_revision,
2015
revision.revision_id)
2017
if revision.parent_ids[0] != prev_revision:
2018
raise errors.NotLeftParentDescendant(self, prev_revision,
2019
revision.revision_id)
2020
prev_revision = revision.revision_id
2021
self.set_last_revision_info(prev_revno + len(revision_ids),
2025
def _set_parent_location(self, url):
2026
"""Set the parent branch"""
2027
self._set_config_location('parent_location', url, make_relative=True)
2030
def _get_parent_location(self):
2031
"""Set the parent branch"""
2032
return self._get_config_location('parent_location')
2034
def set_push_location(self, location):
2035
"""See Branch.set_push_location."""
2036
self._set_config_location('push_location', location)
2038
def set_bound_location(self, location):
2039
"""See Branch.set_push_location."""
2041
config = self.get_config()
2042
if location is None:
2043
if config.get_user_option('bound') != 'True':
2046
config.set_user_option('bound', 'False', warn_masked=True)
2049
self._set_config_location('bound_location', location,
2051
config.set_user_option('bound', 'True', warn_masked=True)
2054
def _get_bound_location(self, bound):
2055
"""Return the bound location in the config file.
2057
Return None if the bound parameter does not match"""
2058
config = self.get_config()
2059
config_bound = (config.get_user_option('bound') == 'True')
2060
if config_bound != bound:
2062
return self._get_config_location('bound_location', config=config)
2064
def get_bound_location(self):
2065
"""See Branch.set_push_location."""
2066
return self._get_bound_location(True)
2068
def get_old_bound_location(self):
2069
"""See Branch.get_old_bound_location"""
2070
return self._get_bound_location(False)
2072
def set_append_revisions_only(self, enabled):
2077
self.get_config().set_user_option('append_revisions_only', value,
2080
def _get_append_revisions_only(self):
2081
value = self.get_config().get_user_option('append_revisions_only')
2082
return value == 'True'
2084
def _synchronize_history(self, destination, revision_id):
2085
"""Synchronize last revision and revision history between branches.
2087
This version is most efficient when the destination is also a
2088
BzrBranch6, but works for BzrBranch5, as long as the destination's
2089
repository contains all the lefthand ancestors of the intended
2090
last_revision. If not, set_last_revision_info will fail.
2092
:param destination: The branch to copy the history into
2093
:param revision_id: The revision-id to truncate history at. May
2094
be None to copy complete history.
2096
if revision_id is None:
2097
revno, revision_id = self.last_revision_info()
2099
# To figure out the revno for a random revision, we need to build
2100
# the revision history, and count its length.
2101
# We don't care about the order, just how long it is.
2102
# Alternatively, we could start at the current location, and count
2103
# backwards. But there is no guarantee that we will find it since
2104
# it may be a merged revision.
2105
revno = len(list(self.repository.iter_reverse_revision_history(
2107
destination.set_last_revision_info(revno, revision_id)
2109
def _make_tags(self):
2110
return BasicTags(self)
1262
def __init__(self, transport_server, transport_readonly_server, formats):
1263
self._transport_server = transport_server
1264
self._transport_readonly_server = transport_readonly_server
1265
self._formats = formats
1267
def adapt(self, test):
1268
result = TestSuite()
1269
for branch_format, bzrdir_format in self._formats:
1270
new_test = deepcopy(test)
1271
new_test.transport_server = self._transport_server
1272
new_test.transport_readonly_server = self._transport_readonly_server
1273
new_test.bzrdir_format = bzrdir_format
1274
new_test.branch_format = branch_format
1275
def make_new_test_id():
1276
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1277
return lambda: new_id
1278
new_test.id = make_new_test_id()
1279
result.addTest(new_test)
2113
1283
######################################################################
2114
# results of operations
2117
class _Result(object):
2119
def _show_tag_conficts(self, to_file):
2120
if not getattr(self, 'tag_conflicts', None):
2122
to_file.write('Conflicting tags:\n')
2123
for name, value1, value2 in self.tag_conflicts:
2124
to_file.write(' %s\n' % (name, ))
2127
class PullResult(_Result):
2128
"""Result of a Branch.pull operation.
2130
:ivar old_revno: Revision number before pull.
2131
:ivar new_revno: Revision number after pull.
2132
:ivar old_revid: Tip revision id before pull.
2133
:ivar new_revid: Tip revision id after pull.
2134
:ivar source_branch: Source (local) branch object.
2135
:ivar master_branch: Master branch of the target, or None.
2136
:ivar target_branch: Target/destination branch object.
2140
# DEPRECATED: pull used to return the change in revno
2141
return self.new_revno - self.old_revno
2143
def report(self, to_file):
2144
if self.old_revid == self.new_revid:
2145
to_file.write('No revisions to pull.\n')
2147
to_file.write('Now on revision %d.\n' % self.new_revno)
2148
self._show_tag_conficts(to_file)
2151
class PushResult(_Result):
2152
"""Result of a Branch.push operation.
2154
:ivar old_revno: Revision number before push.
2155
:ivar new_revno: Revision number after push.
2156
:ivar old_revid: Tip revision id before push.
2157
:ivar new_revid: Tip revision id after push.
2158
:ivar source_branch: Source branch object.
2159
:ivar master_branch: Master branch of the target, or None.
2160
:ivar target_branch: Target/destination branch object.
2164
# DEPRECATED: push used to return the change in revno
2165
return self.new_revno - self.old_revno
2167
def report(self, to_file):
2168
"""Write a human-readable description of the result."""
2169
if self.old_revid == self.new_revid:
2170
to_file.write('No new revisions to push.\n')
2172
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2173
self._show_tag_conficts(to_file)
2176
class BranchCheckResult(object):
2177
"""Results of checking branch consistency.
2182
def __init__(self, branch):
2183
self.branch = branch
2185
def report_results(self, verbose):
2186
"""Report the check results via trace.note.
2188
:param verbose: Requests more detailed display of what was checked,
2191
note('checked branch %s format %s',
2193
self.branch._format)
2196
class Converter5to6(object):
2197
"""Perform an in-place upgrade of format 5 to format 6"""
2199
def convert(self, branch):
2200
# Data for 5 and 6 can peacefully coexist.
2201
format = BzrBranchFormat6()
2202
new_branch = format.open(branch.bzrdir, _found=True)
2204
# Copy source data into target
2205
new_branch.set_last_revision_info(*branch.last_revision_info())
2206
new_branch.set_parent(branch.get_parent())
2207
new_branch.set_bound_location(branch.get_bound_location())
2208
new_branch.set_push_location(branch.get_push_location())
2210
# New branch has no tags by default
2211
new_branch.tags._set_tag_dict({})
2213
# Copying done; now update target format
2214
new_branch.control_files.put_utf8('format',
2215
format.get_format_string())
2217
# Clean up old files
2218
new_branch.control_files._transport.delete('revision-history')
2220
branch.set_parent(None)
2223
branch.set_bound_location(None)
1287
@deprecated_function(zero_eight)
1288
def ScratchBranch(*args, **kwargs):
1289
"""See bzrlib.bzrdir.ScratchDir."""
1290
d = ScratchDir(*args, **kwargs)
1291
return d.open_branch()
1294
@deprecated_function(zero_eight)
1295
def is_control_file(*args, **kwargs):
1296
"""See bzrlib.workingtree.is_control_file."""
1297
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
