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,
50
from bzrlib.repository import Repository
51
from bzrlib.revision import (
56
from bzrlib.store import copy_all
57
from bzrlib.symbol_versioning import *
58
from bzrlib.textui import show_status
63
59
from bzrlib.trace import mutter, note
60
import bzrlib.transactions as transactions
61
from bzrlib.transport import Transport, get_transport
62
from bzrlib.tree import EmptyTree, RevisionTree
64
import bzrlib.urlutils as urlutils
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?
157
151
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
159
@deprecated_function(zero_eight)
160
153
def setup_caching(self, cache_root):
161
154
"""Subclasses that care about caching should override this, and set
162
155
up cached stores located under cache_root.
164
NOTE: This is unused.
168
def get_config(self):
169
return BranchConfig(self)
157
# seems to be unused, 2006-01-13 mbp
158
warn('%s is deprecated' % self.setup_caching)
159
self.cache_root = cache_root
171
161
def _get_nick(self):
172
return self.get_config().get_nickname()
162
cfg = self.tree_config()
163
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
174
165
def _set_nick(self, nick):
175
self.get_config().set_user_option('nickname', nick)
166
cfg = self.tree_config()
167
cfg.set_option(nick, "nickname")
168
assert cfg.get_option("nickname") == nick
177
170
nick = property(_get_nick, _set_nick)
179
172
def is_locked(self):
180
raise NotImplementedError(self.is_locked)
173
raise NotImplementedError('is_locked is abstract')
182
175
def lock_write(self):
183
raise NotImplementedError(self.lock_write)
176
raise NotImplementedError('lock_write is abstract')
185
178
def lock_read(self):
186
raise NotImplementedError(self.lock_read)
179
raise NotImplementedError('lock_read is abstract')
188
181
def unlock(self):
189
raise NotImplementedError(self.unlock)
182
raise NotImplementedError('unlock is abstract')
191
184
def peek_lock_mode(self):
192
185
"""Return lock mode for the Branch: 'r', 'w' or None"""
193
186
raise NotImplementedError(self.peek_lock_mode)
195
188
def get_physical_lock_status(self):
196
raise NotImplementedError(self.get_physical_lock_status)
199
def get_revision_id_to_revno_map(self):
200
"""Return the revision_id => dotted revno map.
202
This will be regenerated on demand, but will be cached.
204
:return: A dictionary mapping revision_id => dotted revno.
205
This dictionary should not be modified by the caller.
207
if self._revision_id_to_revno_cache is not None:
208
mapping = self._revision_id_to_revno_cache
210
mapping = self._gen_revno_map()
211
self._cache_revision_id_to_revno(mapping)
212
# TODO: jam 20070417 Since this is being cached, should we be returning
214
# I would rather not, and instead just declare that users should not
215
# modify the return value.
218
def _gen_revno_map(self):
219
"""Create a new mapping from revision ids to dotted revnos.
221
Dotted revnos are generated based on the current tip in the revision
223
This is the worker function for get_revision_id_to_revno_map, which
224
just caches the return value.
226
:return: A dictionary mapping revision_id => dotted revno.
228
last_revision = self.last_revision()
229
revision_graph = self.repository.get_revision_graph(last_revision)
230
merge_sorted_revisions = tsort.merge_sort(
235
revision_id_to_revno = dict((rev_id, revno)
236
for seq_num, rev_id, depth, revno, end_of_merge
237
in merge_sorted_revisions)
238
return revision_id_to_revno
240
def leave_lock_in_place(self):
241
"""Tell this branch object not to release the physical lock when this
244
If lock_write doesn't return a token, then this method is not supported.
246
self.control_files.leave_in_place()
248
def dont_leave_lock_in_place(self):
249
"""Tell this branch object to release the physical lock when this
250
object is unlocked, even if it didn't originally acquire it.
252
If lock_write doesn't return a token, then this method is not supported.
254
self.control_files.dont_leave_in_place()
189
raise NotImplementedError('get_physical_lock_status is abstract')
256
191
def abspath(self, name):
257
192
"""Return absolute filename for something in the branch
347
def get_revision_delta(self, revno):
348
"""Return the delta for one revision.
350
The delta is relative to its mainline predecessor, or the
351
empty tree for revision 1.
353
assert isinstance(revno, int)
354
rh = self.revision_history()
355
if not (1 <= revno <= len(rh)):
356
raise InvalidRevisionNumber(revno)
357
return self.repository.get_revision_delta(rh[revno-1])
359
@deprecated_method(zero_sixteen)
360
260
def get_root_id(self):
361
"""Return the id of this branches root
363
Deprecated: branches don't have root ids-- trees do.
364
Use basis_tree().get_root_id() instead.
366
raise NotImplementedError(self.get_root_id)
261
"""Return the id of this branches root"""
262
raise NotImplementedError('get_root_id is abstract')
368
264
def print_file(self, file, revision_id):
369
265
"""Print `file` to stdout."""
370
raise NotImplementedError(self.print_file)
266
raise NotImplementedError('print_file is abstract')
372
268
def append_revision(self, *revision_ids):
373
raise NotImplementedError(self.append_revision)
269
raise NotImplementedError('append_revision is abstract')
375
271
def set_revision_history(self, rev_history):
376
raise NotImplementedError(self.set_revision_history)
378
def _cache_revision_history(self, rev_history):
379
"""Set the cached revision history to rev_history.
381
The revision_history method will use this cache to avoid regenerating
382
the revision history.
384
This API is semi-public; it only for use by subclasses, all other code
385
should consider it to be private.
387
self._revision_history_cache = rev_history
389
def _cache_revision_id_to_revno(self, revision_id_to_revno):
390
"""Set the cached revision_id => revno map to revision_id_to_revno.
392
This API is semi-public; it only for use by subclasses, all other code
393
should consider it to be private.
395
self._revision_id_to_revno_cache = revision_id_to_revno
397
def _clear_cached_state(self):
398
"""Clear any cached data on this branch, e.g. cached revision history.
400
This means the next call to revision_history will need to call
401
_gen_revision_history.
403
This API is semi-public; it only for use by subclasses, all other code
404
should consider it to be private.
406
self._revision_history_cache = None
407
self._revision_id_to_revno_cache = None
409
def _gen_revision_history(self):
410
"""Return sequence of revision hashes on to this branch.
412
Unlike revision_history, this method always regenerates or rereads the
413
revision history, i.e. it does not cache the result, so repeated calls
416
Concrete subclasses should override this instead of revision_history so
417
that subclasses do not need to deal with caching logic.
419
This API is semi-public; it only for use by subclasses, all other code
420
should consider it to be private.
422
raise NotImplementedError(self._gen_revision_history)
272
raise NotImplementedError('set_revision_history is abstract')
425
274
def revision_history(self):
426
"""Return sequence of revision hashes on to this branch.
428
This method will cache the revision history for as long as it is safe to
431
if self._revision_history_cache is not None:
432
history = self._revision_history_cache
434
history = self._gen_revision_history()
435
self._cache_revision_history(history)
275
"""Return sequence of revision hashes on to this branch."""
276
raise NotImplementedError('revision_history is abstract')
439
279
"""Return current revision number for this branch.
687
518
result.set_parent(self.bzrdir.root_transport.base)
690
def _synchronize_history(self, destination, revision_id):
691
"""Synchronize last revision and revision history between branches.
693
This version is most efficient when the destination is also a
694
BzrBranch5, but works for BzrBranch6 as long as the revision
695
history is the true lefthand parent history, and all of the revisions
696
are in the destination's repository. If not, set_revision_history
699
:param destination: The branch to copy the history into
700
:param revision_id: The revision-id to truncate history at. May
701
be None to copy complete history.
522
def copy_content_into(self, destination, revision_id=None):
523
"""Copy the content of self into destination.
525
revision_id: if not None, the revision history in the new branch will
526
be truncated to end with revision_id.
703
528
new_history = self.revision_history()
704
529
if revision_id is not None:
705
revision_id = osutils.safe_revision_id(revision_id)
707
531
new_history = new_history[:new_history.index(revision_id) + 1]
708
532
except ValueError:
709
533
rev = self.repository.get_revision(revision_id)
710
534
new_history = rev.get_history(self.repository)[1:]
711
535
destination.set_revision_history(new_history)
714
def copy_content_into(self, destination, revision_id=None):
715
"""Copy the content of self into destination.
717
revision_id: if not None, the revision history in the new branch will
718
be truncated to end with revision_id.
720
self._synchronize_history(destination, revision_id)
722
parent = self.get_parent()
723
except errors.InaccessibleParent, e:
724
mutter('parent was not accessible to copy: %s', e)
727
destination.set_parent(parent)
728
self.tags.merge_to(destination.tags)
732
"""Check consistency of the branch.
734
In particular this checks that revisions given in the revision-history
735
do actually match up in the revision graph, and that they're all
736
present in the repository.
738
Callers will typically also want to check the repository.
740
:return: A BranchCheckResult.
742
mainline_parent_id = None
743
for revision_id in self.revision_history():
745
revision = self.repository.get_revision(revision_id)
746
except errors.NoSuchRevision, e:
747
raise errors.BzrCheckError("mainline revision {%s} not in repository"
749
# In general the first entry on the revision history has no parents.
750
# But it's not illegal for it to have parents listed; this can happen
751
# in imports from Arch when the parents weren't reachable.
752
if mainline_parent_id is not None:
753
if mainline_parent_id not in revision.parent_ids:
754
raise errors.BzrCheckError("previous revision {%s} not listed among "
756
% (mainline_parent_id, revision_id))
757
mainline_parent_id = revision_id
758
return BranchCheckResult(self)
760
def _get_checkout_format(self):
761
"""Return the most suitable metadir for a checkout of this branch.
762
Weaves are used if this branch's repository uses weaves.
764
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
765
from bzrlib.repofmt import weaverepo
766
format = bzrdir.BzrDirMetaFormat1()
767
format.repository_format = weaverepo.RepositoryFormat7()
769
format = self.repository.bzrdir.checkout_metadir()
770
format.set_branch_format(self._format)
773
def create_checkout(self, to_location, revision_id=None,
775
"""Create a checkout of a branch.
777
:param to_location: The url to produce the checkout at
778
:param revision_id: The revision to check out
779
:param lightweight: If True, produce a lightweight checkout, otherwise,
780
produce a bound branch (heavyweight checkout)
781
:return: The tree of the created checkout
783
t = transport.get_transport(to_location)
786
format = self._get_checkout_format()
787
checkout = format.initialize_on_transport(t)
788
BranchReferenceFormat().initialize(checkout, self)
790
format = self._get_checkout_format()
791
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
792
to_location, force_new_tree=False, format=format)
793
checkout = checkout_branch.bzrdir
794
checkout_branch.bind(self)
795
# pull up to the specified revision_id to set the initial
796
# branch tip correctly, and seed it with history.
797
checkout_branch.pull(self, stop_revision=revision_id)
798
tree = checkout.create_workingtree(revision_id)
799
basis_tree = tree.basis_tree()
800
basis_tree.lock_read()
802
for path, file_id in basis_tree.iter_references():
803
reference_parent = self.reference_parent(file_id, path)
804
reference_parent.create_checkout(tree.abspath(path),
805
basis_tree.get_reference_revision(file_id, path),
811
def reference_parent(self, file_id, path):
812
"""Return the parent branch for a tree-reference file_id
813
:param file_id: The file_id of the tree reference
814
:param path: The path of the file_id in the tree
815
:return: A branch associated with the file_id
817
# FIXME should provide multiple branches, based on config
818
return Branch.open(self.bzrdir.root_transport.clone(path).base)
820
def supports_tags(self):
821
return self._format.supports_tags()
536
parent = self.get_parent()
538
destination.set_parent(parent)
824
541
class BranchFormat(object):
957
624
def __str__(self):
958
625
return self.get_format_string().rstrip()
960
def supports_tags(self):
961
"""True if this format supports tags stored in the branch"""
962
return False # by default
964
# XXX: Probably doesn't really belong here -- mbp 20070212
965
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
967
branch_transport = a_bzrdir.get_branch_transport(self)
968
control_files = lockable_files.LockableFiles(branch_transport,
969
lock_filename, lock_class)
970
control_files.create_lock()
971
control_files.lock_write()
973
for filename, content in utf8_files:
974
control_files.put_utf8(filename, content)
976
control_files.unlock()
979
class BranchHooks(Hooks):
980
"""A dictionary mapping hook name to a list of callables for branch hooks.
982
e.g. ['set_rh'] Is the list of items to be called when the
983
set_revision_history function is invoked.
987
"""Create the default hooks.
989
These are all empty initially, because by default nothing should get
993
# Introduced in 0.15:
994
# invoked whenever the revision history has been set
995
# with set_revision_history. The api signature is
996
# (branch, revision_history), and the branch will
999
# invoked after a push operation completes.
1000
# the api signature is
1002
# containing the members
1003
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1004
# where local is the local target branch or None, master is the target
1005
# master branch, and the rest should be self explanatory. The source
1006
# is read locked and the target branches write locked. Source will
1007
# be the local low-latency branch.
1008
self['post_push'] = []
1009
# invoked after a pull 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 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. The local
1017
# branch is the low-latency branch.
1018
self['post_pull'] = []
1019
# invoked after a commit operation completes.
1020
# the api signature is
1021
# (local, master, old_revno, old_revid, new_revno, new_revid)
1022
# old_revid is NULL_REVISION for the first commit to a branch.
1023
self['post_commit'] = []
1024
# invoked after a uncommit operation completes.
1025
# the api signature is
1026
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1027
# local is the local branch or None, master is the target branch,
1028
# and an empty branch recieves new_revno of 0, new_revid of None.
1029
self['post_uncommit'] = []
1032
# install the default hooks into the Branch class.
1033
Branch.hooks = BranchHooks()
1036
628
class BzrBranchFormat4(BranchFormat):
1037
629
"""Bzr branch format 4.
1270
827
it's writable, and can be accessed via the normal filesystem API.
1273
def __init__(self, _format=None,
830
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
831
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1274
832
_control_files=None, a_bzrdir=None, _repository=None):
1275
"""Create new branch object at a particular location."""
1276
Branch.__init__(self)
833
"""Create new branch object at a particular location.
835
transport -- A Transport object, defining how to access files.
837
init -- If True, create new control files in a previously
838
unversioned directory. If False, the branch must already
841
relax_version_check -- If true, the usual check for the branch
842
version is not applied. This is intended only for
843
upgrade/recovery type use; it's not guaranteed that
844
all operations will work on old format branches.
1277
846
if a_bzrdir is None:
1278
raise ValueError('a_bzrdir must be supplied')
847
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1280
849
self.bzrdir = a_bzrdir
1281
# self._transport used to point to the directory containing the
1282
# control directory, but was not used - now it's just the transport
1283
# for the branch control files. mbp 20070212
1284
self._base = self.bzrdir.transport.clone('..').base
850
self._transport = self.bzrdir.transport.clone('..')
851
self._base = self._transport.base
1285
852
self._format = _format
1286
853
if _control_files is None:
1287
raise ValueError('BzrBranch _control_files is None')
854
raise BzrBadParameterMissing('_control_files')
1288
855
self.control_files = _control_files
1289
self._transport = _control_files._transport
856
if deprecated_passed(init):
857
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
858
"deprecated as of bzr 0.8. Please use Branch.create().",
862
# this is slower than before deprecation, oh well never mind.
864
self._initialize(transport.base)
865
self._check_format(_format)
866
if deprecated_passed(relax_version_check):
867
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
868
"relax_version_check parameter is deprecated as of bzr 0.8. "
869
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
873
if (not relax_version_check
874
and not self._format.is_supported()):
875
raise errors.UnsupportedFormatError(
876
'sorry, branch format %r not supported' % fmt,
877
['use a different bzr version',
878
'or remove the .bzr directory'
879
' and "bzr init" again'])
880
if deprecated_passed(transport):
881
warn("BzrBranch.__init__(transport=XXX...): The transport "
882
"parameter is deprecated as of bzr 0.8. "
883
"Please use Branch.open, or bzrdir.open_branch().",
1290
886
self.repository = _repository
1292
888
def __str__(self):
1359
996
@needs_write_lock
1360
997
def append_revision(self, *revision_ids):
1361
998
"""See Branch.append_revision."""
1362
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1363
999
for revision_id in revision_ids:
1364
_mod_revision.check_not_reserved_id(revision_id)
1365
1000
mutter("add {%s} to revision-history" % revision_id)
1366
1001
rev_history = self.revision_history()
1367
1002
rev_history.extend(revision_ids)
1368
1003
self.set_revision_history(rev_history)
1370
def _write_revision_history(self, history):
1371
"""Factored out of set_revision_history.
1373
This performs the actual writing to disk.
1374
It is intended to be called by BzrBranch5.set_revision_history."""
1375
self.control_files.put_bytes(
1376
'revision-history', '\n'.join(history))
1378
1005
@needs_write_lock
1379
1006
def set_revision_history(self, rev_history):
1380
1007
"""See Branch.set_revision_history."""
1381
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1382
self._clear_cached_state()
1383
self._write_revision_history(rev_history)
1384
self._cache_revision_history(rev_history)
1385
for hook in Branch.hooks['set_rh']:
1386
hook(self, rev_history)
1389
def set_last_revision_info(self, revno, revision_id):
1390
revision_id = osutils.safe_revision_id(revision_id)
1391
history = self._lefthand_history(revision_id)
1392
assert len(history) == revno, '%d != %d' % (len(history), revno)
1393
self.set_revision_history(history)
1395
def _gen_revision_history(self):
1396
history = self.control_files.get('revision-history').read().split('\n')
1397
if history[-1:] == ['']:
1398
# There shouldn't be a trailing newline, but just in case.
1402
def _lefthand_history(self, revision_id, last_rev=None,
1404
# stop_revision must be a descendant of last_revision
1405
stop_graph = self.repository.get_revision_graph(revision_id)
1406
if last_rev is not None and last_rev not in stop_graph:
1407
# our previous tip is not merged into stop_revision
1408
raise errors.DivergedBranches(self, other_branch)
1409
# make a new revision history from the graph
1410
current_rev_id = revision_id
1412
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1413
new_history.append(current_rev_id)
1414
current_rev_id_parents = stop_graph[current_rev_id]
1416
current_rev_id = current_rev_id_parents[0]
1418
current_rev_id = None
1419
new_history.reverse()
1423
def generate_revision_history(self, revision_id, last_rev=None,
1425
"""Create a new revision history that will finish with revision_id.
1427
:param revision_id: the new tip to use.
1428
:param last_rev: The previous last_revision. If not None, then this
1429
must be a ancestory of revision_id, or DivergedBranches is raised.
1430
:param other_branch: The other branch that DivergedBranches should
1431
raise with respect to.
1008
self.control_files.put_utf8(
1009
'revision-history', '\n'.join(rev_history))
1010
transaction = self.get_transaction()
1011
history = transaction.map.find_revision_history()
1012
if history is not None:
1013
# update the revision history in the identity map.
1014
history[:] = list(rev_history)
1015
# this call is disabled because revision_history is
1016
# not really an object yet, and the transaction is for objects.
1017
# transaction.register_dirty(history)
1019
transaction.map.add_revision_history(rev_history)
1020
# this call is disabled because revision_history is
1021
# not really an object yet, and the transaction is for objects.
1022
# transaction.register_clean(history)
1024
def get_revision_delta(self, revno):
1025
"""Return the delta for one revision.
1027
The delta is relative to its mainline predecessor, or the
1028
empty tree for revision 1.
1433
revision_id = osutils.safe_revision_id(revision_id)
1434
self.set_revision_history(self._lefthand_history(revision_id,
1435
last_rev, other_branch))
1030
assert isinstance(revno, int)
1031
rh = self.revision_history()
1032
if not (1 <= revno <= len(rh)):
1033
raise InvalidRevisionNumber(revno)
1035
# revno is 1-based; list is 0-based
1037
new_tree = self.repository.revision_tree(rh[revno-1])
1039
old_tree = EmptyTree()
1041
old_tree = self.repository.revision_tree(rh[revno-2])
1042
return compare_trees(old_tree, new_tree)
1045
def revision_history(self):
1046
"""See Branch.revision_history."""
1047
transaction = self.get_transaction()
1048
history = transaction.map.find_revision_history()
1049
if history is not None:
1050
mutter("cache hit for revision-history in %s", self)
1051
return list(history)
1052
history = [l.rstrip('\r\n') for l in
1053
self.control_files.get_utf8('revision-history').readlines()]
1054
transaction.map.add_revision_history(history)
1055
# this call is disabled because revision_history is
1056
# not really an object yet, and the transaction is for objects.
1057
# transaction.register_clean(history, precious=True)
1058
return list(history)
1437
1060
@needs_write_lock
1438
1061
def update_revisions(self, other, stop_revision=None):
1477
1112
return self.bzrdir.open_workingtree()
1479
1114
@needs_write_lock
1480
def pull(self, source, overwrite=False, stop_revision=None,
1481
_hook_master=None, run_hooks=True):
1484
:param _hook_master: Private parameter - set the branch to
1485
be supplied as the master to push hooks.
1486
:param run_hooks: Private parameter - if false, this branch
1487
is being called because it's the master of the primary branch,
1488
so it should not run its hooks.
1490
result = PullResult()
1491
result.source_branch = source
1492
result.target_branch = self
1115
def pull(self, source, overwrite=False, stop_revision=None):
1116
"""See Branch.pull."""
1493
1117
source.lock_read()
1495
result.old_revno, result.old_revid = self.last_revision_info()
1119
old_count = len(self.revision_history())
1497
self.update_revisions(source, stop_revision)
1121
self.update_revisions(source,stop_revision)
1498
1122
except DivergedBranches:
1499
1123
if not overwrite:
1502
if stop_revision is None:
1503
stop_revision = source.last_revision()
1504
self.generate_revision_history(stop_revision)
1505
result.tag_conflicts = source.tags.merge_to(self.tags)
1506
result.new_revno, result.new_revid = self.last_revision_info()
1508
result.master_branch = _hook_master
1509
result.local_branch = self
1511
result.master_branch = self
1512
result.local_branch = None
1514
for hook in Branch.hooks['post_pull']:
1126
self.set_revision_history(source.revision_history())
1127
new_count = len(self.revision_history())
1128
return new_count - old_count
1517
1130
source.unlock()
1520
def _get_parent_location(self):
1132
def get_parent(self):
1133
"""See Branch.get_parent."""
1521
1135
_locs = ['parent', 'pull', 'x-pull']
1136
assert self.base[-1] == '/'
1522
1137
for l in _locs:
1524
return self.control_files.get(l).read().strip('\n')
1139
return urlutils.join(self.base[:-1],
1140
self.control_files.get(l).read().strip('\n'))
1525
1141
except NoSuchFile:
1530
def push(self, target, overwrite=False, stop_revision=None,
1531
_override_hook_source_branch=None):
1534
This is the basic concrete implementation of push()
1536
:param _override_hook_source_branch: If specified, run
1537
the hooks passing this Branch as the source, rather than self.
1538
This is for use of RemoteBranch, where push is delegated to the
1539
underlying vfs-based Branch.
1541
# TODO: Public option to disable running hooks - should be trivial but
1545
result = self._push_with_bound_branches(target, overwrite,
1547
_override_hook_source_branch=_override_hook_source_branch)
1552
def _push_with_bound_branches(self, target, overwrite,
1554
_override_hook_source_branch=None):
1555
"""Push from self into target, and into target's master if any.
1557
This is on the base BzrBranch class even though it doesn't support
1558
bound branches because the *target* might be bound.
1561
if _override_hook_source_branch:
1562
result.source_branch = _override_hook_source_branch
1563
for hook in Branch.hooks['post_push']:
1566
bound_location = target.get_bound_location()
1567
if bound_location and target.base != bound_location:
1568
# there is a master branch.
1570
# XXX: Why the second check? Is it even supported for a branch to
1571
# be bound to itself? -- mbp 20070507
1572
master_branch = target.get_master_branch()
1573
master_branch.lock_write()
1575
# push into the master from this branch.
1576
self._basic_push(master_branch, overwrite, stop_revision)
1577
# and push into the target branch from this. Note that we push from
1578
# this branch again, because its considered the highest bandwidth
1580
result = self._basic_push(target, overwrite, stop_revision)
1581
result.master_branch = master_branch
1582
result.local_branch = target
1586
master_branch.unlock()
1589
result = self._basic_push(target, overwrite, stop_revision)
1590
# TODO: Why set master_branch and local_branch if there's no
1591
# binding? Maybe cleaner to just leave them unset? -- mbp
1593
result.master_branch = target
1594
result.local_branch = None
1598
def _basic_push(self, target, overwrite, stop_revision):
1599
"""Basic implementation of push without bound branches or hooks.
1601
Must be called with self read locked and target write locked.
1603
result = PushResult()
1604
result.source_branch = self
1605
result.target_branch = target
1606
result.old_revno, result.old_revid = target.last_revision_info()
1608
target.update_revisions(self, stop_revision)
1609
except DivergedBranches:
1613
target.set_revision_history(self.revision_history())
1614
result.tag_conflicts = self.tags.merge_to(target.tags)
1615
result.new_revno, result.new_revid = target.last_revision_info()
1618
def get_parent(self):
1619
"""See Branch.get_parent."""
1621
assert self.base[-1] == '/'
1622
parent = self._get_parent_location()
1625
# This is an old-format absolute path to a local branch
1626
# turn it into a url
1627
if parent.startswith('/'):
1628
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1630
return urlutils.join(self.base[:-1], parent)
1631
except errors.InvalidURLJoin, e:
1632
raise errors.InaccessibleParent(parent, self.base)
1145
def get_push_location(self):
1146
"""See Branch.get_push_location."""
1147
config = bzrlib.config.BranchConfig(self)
1148
push_loc = config.get_user_option('push_location')
1634
1151
def set_push_location(self, location):
1635
1152
"""See Branch.set_push_location."""
1636
self.get_config().set_user_option(
1637
'push_location', location,
1638
store=_mod_config.STORE_LOCATION_NORECURSE)
1153
config = bzrlib.config.LocationConfig(self.base)
1154
config.set_user_option('push_location', location)
1640
1156
@needs_write_lock
1641
1157
def set_parent(self, url):
1812
1309
if master is not None:
1813
1310
old_tip = self.last_revision()
1814
1311
self.pull(master, overwrite=True)
1815
if old_tip in self.repository.get_ancestry(self.last_revision(),
1312
if old_tip in self.repository.get_ancestry(self.last_revision()):
1822
class BzrBranchExperimental(BzrBranch5):
1823
"""Bzr experimental branch format
1826
- a revision-history file.
1828
- a lock dir guarding the branch itself
1829
- all of this stored in a branch/ subdirectory
1830
- works with shared repositories.
1831
- a tag dictionary in the branch
1833
This format is new in bzr 0.15, but shouldn't be used for real data,
1836
This class acts as it's own BranchFormat.
1318
class BranchTestProviderAdapter(object):
1319
"""A tool to generate a suite testing multiple branch formats at once.
1321
This is done by copying the test once for each transport and injecting
1322
the transport_server, transport_readonly_server, and branch_format
1323
classes into each copy. Each copy is also given a new id() to make it
1839
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1842
def get_format_string(cls):
1843
"""See BranchFormat.get_format_string()."""
1844
return "Bazaar-NG branch format experimental\n"
1847
def get_format_description(cls):
1848
"""See BranchFormat.get_format_description()."""
1849
return "Experimental branch format"
1852
def get_reference(cls, a_bzrdir):
1853
"""Get the target reference of the branch in a_bzrdir.
1855
format probing must have been completed before calling
1856
this method - it is assumed that the format of the branch
1857
in a_bzrdir is correct.
1859
:param a_bzrdir: The bzrdir to get the branch data from.
1860
:return: None if the branch is not a reference branch.
1865
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1867
branch_transport = a_bzrdir.get_branch_transport(cls)
1868
control_files = lockable_files.LockableFiles(branch_transport,
1869
lock_filename, lock_class)
1870
control_files.create_lock()
1871
control_files.lock_write()
1873
for filename, content in utf8_files:
1874
control_files.put_utf8(filename, content)
1876
control_files.unlock()
1879
def initialize(cls, a_bzrdir):
1880
"""Create a branch of this format in a_bzrdir."""
1881
utf8_files = [('format', cls.get_format_string()),
1882
('revision-history', ''),
1883
('branch-name', ''),
1886
cls._initialize_control_files(a_bzrdir, utf8_files,
1887
'lock', lockdir.LockDir)
1888
return cls.open(a_bzrdir, _found=True)
1891
def open(cls, a_bzrdir, _found=False):
1892
"""Return the branch object for a_bzrdir
1894
_found is a private parameter, do not use it. It is used to indicate
1895
if format probing has already be done.
1898
format = BranchFormat.find_format(a_bzrdir)
1899
assert format.__class__ == cls
1900
transport = a_bzrdir.get_branch_transport(None)
1901
control_files = lockable_files.LockableFiles(transport, 'lock',
1903
return cls(_format=cls,
1904
_control_files=control_files,
1906
_repository=a_bzrdir.find_repository())
1909
def is_supported(cls):
1912
def _make_tags(self):
1913
return BasicTags(self)
1916
def supports_tags(cls):
1920
BranchFormat.register_format(BzrBranchExperimental)
1923
class BzrBranch6(BzrBranch5):
1926
def last_revision_info(self):
1927
revision_string = self.control_files.get('last-revision').read()
1928
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1929
revision_id = cache_utf8.get_cached_utf8(revision_id)
1931
return revno, revision_id
1933
def last_revision(self):
1934
"""Return last revision id, or None"""
1935
revision_id = self.last_revision_info()[1]
1936
if revision_id == _mod_revision.NULL_REVISION:
1940
def _write_last_revision_info(self, revno, revision_id):
1941
"""Simply write out the revision id, with no checks.
1943
Use set_last_revision_info to perform this safely.
1945
Does not update the revision_history cache.
1946
Intended to be called by set_last_revision_info and
1947
_write_revision_history.
1949
if revision_id is None:
1950
revision_id = 'null:'
1951
out_string = '%d %s\n' % (revno, revision_id)
1952
self.control_files.put_bytes('last-revision', out_string)
1955
def set_last_revision_info(self, revno, revision_id):
1956
revision_id = osutils.safe_revision_id(revision_id)
1957
if self._get_append_revisions_only():
1958
self._check_history_violation(revision_id)
1959
self._write_last_revision_info(revno, revision_id)
1960
self._clear_cached_state()
1962
def _check_history_violation(self, revision_id):
1963
last_revision = self.last_revision()
1964
if last_revision is None:
1966
if last_revision not in self._lefthand_history(revision_id):
1967
raise errors.AppendRevisionsOnlyViolation(self.base)
1969
def _gen_revision_history(self):
1970
"""Generate the revision history from last revision
1972
history = list(self.repository.iter_reverse_revision_history(
1973
self.last_revision()))
1977
def _write_revision_history(self, history):
1978
"""Factored out of set_revision_history.
1980
This performs the actual writing to disk, with format-specific checks.
1981
It is intended to be called by BzrBranch5.set_revision_history.
1983
if len(history) == 0:
1984
last_revision = 'null:'
1986
if history != self._lefthand_history(history[-1]):
1987
raise errors.NotLefthandHistory(history)
1988
last_revision = history[-1]
1989
if self._get_append_revisions_only():
1990
self._check_history_violation(last_revision)
1991
self._write_last_revision_info(len(history), last_revision)
1994
def append_revision(self, *revision_ids):
1995
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1996
if len(revision_ids) == 0:
1998
prev_revno, prev_revision = self.last_revision_info()
1999
for revision in self.repository.get_revisions(revision_ids):
2000
if prev_revision == _mod_revision.NULL_REVISION:
2001
if revision.parent_ids != []:
2002
raise errors.NotLeftParentDescendant(self, prev_revision,
2003
revision.revision_id)
2005
if revision.parent_ids[0] != prev_revision:
2006
raise errors.NotLeftParentDescendant(self, prev_revision,
2007
revision.revision_id)
2008
prev_revision = revision.revision_id
2009
self.set_last_revision_info(prev_revno + len(revision_ids),
2013
def _set_parent_location(self, url):
2014
"""Set the parent branch"""
2015
self._set_config_location('parent_location', url, make_relative=True)
2018
def _get_parent_location(self):
2019
"""Set the parent branch"""
2020
return self._get_config_location('parent_location')
2022
def set_push_location(self, location):
2023
"""See Branch.set_push_location."""
2024
self._set_config_location('push_location', location)
2026
def set_bound_location(self, location):
2027
"""See Branch.set_push_location."""
2029
config = self.get_config()
2030
if location is None:
2031
if config.get_user_option('bound') != 'True':
2034
config.set_user_option('bound', 'False')
2037
self._set_config_location('bound_location', location,
2039
config.set_user_option('bound', 'True')
2042
def _get_bound_location(self, bound):
2043
"""Return the bound location in the config file.
2045
Return None if the bound parameter does not match"""
2046
config = self.get_config()
2047
config_bound = (config.get_user_option('bound') == 'True')
2048
if config_bound != bound:
2050
return self._get_config_location('bound_location', config=config)
2052
def get_bound_location(self):
2053
"""See Branch.set_push_location."""
2054
return self._get_bound_location(True)
2056
def get_old_bound_location(self):
2057
"""See Branch.get_old_bound_location"""
2058
return self._get_bound_location(False)
2060
def set_append_revisions_only(self, enabled):
2065
self.get_config().set_user_option('append_revisions_only', value)
2067
def _get_append_revisions_only(self):
2068
value = self.get_config().get_user_option('append_revisions_only')
2069
return value == 'True'
2071
def _synchronize_history(self, destination, revision_id):
2072
"""Synchronize last revision and revision history between branches.
2074
This version is most efficient when the destination is also a
2075
BzrBranch6, but works for BzrBranch5, as long as the destination's
2076
repository contains all the lefthand ancestors of the intended
2077
last_revision. If not, set_last_revision_info will fail.
2079
:param destination: The branch to copy the history into
2080
:param revision_id: The revision-id to truncate history at. May
2081
be None to copy complete history.
2083
if revision_id is None:
2084
revno, revision_id = self.last_revision_info()
2086
# To figure out the revno for a random revision, we need to build
2087
# the revision history, and count its length.
2088
# We don't care about the order, just how long it is.
2089
# Alternatively, we could start at the current location, and count
2090
# backwards. But there is no guarantee that we will find it since
2091
# it may be a merged revision.
2092
revno = len(list(self.repository.iter_reverse_revision_history(
2094
destination.set_last_revision_info(revno, revision_id)
2096
def _make_tags(self):
2097
return BasicTags(self)
1327
def __init__(self, transport_server, transport_readonly_server, formats):
1328
self._transport_server = transport_server
1329
self._transport_readonly_server = transport_readonly_server
1330
self._formats = formats
1332
def adapt(self, test):
1333
result = TestSuite()
1334
for branch_format, bzrdir_format in self._formats:
1335
new_test = deepcopy(test)
1336
new_test.transport_server = self._transport_server
1337
new_test.transport_readonly_server = self._transport_readonly_server
1338
new_test.bzrdir_format = bzrdir_format
1339
new_test.branch_format = branch_format
1340
def make_new_test_id():
1341
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1342
return lambda: new_id
1343
new_test.id = make_new_test_id()
1344
result.addTest(new_test)
2100
1348
######################################################################
2101
# results of operations
2104
class _Result(object):
2106
def _show_tag_conficts(self, to_file):
2107
if not getattr(self, 'tag_conflicts', None):
2109
to_file.write('Conflicting tags:\n')
2110
for name, value1, value2 in self.tag_conflicts:
2111
to_file.write(' %s\n' % (name, ))
2114
class PullResult(_Result):
2115
"""Result of a Branch.pull operation.
2117
:ivar old_revno: Revision number before pull.
2118
:ivar new_revno: Revision number after pull.
2119
:ivar old_revid: Tip revision id before pull.
2120
:ivar new_revid: Tip revision id after pull.
2121
:ivar source_branch: Source (local) branch object.
2122
:ivar master_branch: Master branch of the target, or None.
2123
:ivar target_branch: Target/destination branch object.
2127
# DEPRECATED: pull used to return the change in revno
2128
return self.new_revno - self.old_revno
2130
def report(self, to_file):
2131
if self.old_revid == self.new_revid:
2132
to_file.write('No revisions to pull.\n')
2134
to_file.write('Now on revision %d.\n' % self.new_revno)
2135
self._show_tag_conficts(to_file)
2138
class PushResult(_Result):
2139
"""Result of a Branch.push operation.
2141
:ivar old_revno: Revision number before push.
2142
:ivar new_revno: Revision number after push.
2143
:ivar old_revid: Tip revision id before push.
2144
:ivar new_revid: Tip revision id after push.
2145
:ivar source_branch: Source branch object.
2146
:ivar master_branch: Master branch of the target, or None.
2147
:ivar target_branch: Target/destination branch object.
2151
# DEPRECATED: push used to return the change in revno
2152
return self.new_revno - self.old_revno
2154
def report(self, to_file):
2155
"""Write a human-readable description of the result."""
2156
if self.old_revid == self.new_revid:
2157
to_file.write('No new revisions to push.\n')
2159
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2160
self._show_tag_conficts(to_file)
2163
class BranchCheckResult(object):
2164
"""Results of checking branch consistency.
2169
def __init__(self, branch):
2170
self.branch = branch
2172
def report_results(self, verbose):
2173
"""Report the check results via trace.note.
2175
:param verbose: Requests more detailed display of what was checked,
2178
note('checked branch %s format %s',
2180
self.branch._format)
2183
class Converter5to6(object):
2184
"""Perform an in-place upgrade of format 5 to format 6"""
2186
def convert(self, branch):
2187
# Data for 5 and 6 can peacefully coexist.
2188
format = BzrBranchFormat6()
2189
new_branch = format.open(branch.bzrdir, _found=True)
2191
# Copy source data into target
2192
new_branch.set_last_revision_info(*branch.last_revision_info())
2193
new_branch.set_parent(branch.get_parent())
2194
new_branch.set_bound_location(branch.get_bound_location())
2195
new_branch.set_push_location(branch.get_push_location())
2197
# New branch has no tags by default
2198
new_branch.tags._set_tag_dict({})
2200
# Copying done; now update target format
2201
new_branch.control_files.put_utf8('format',
2202
format.get_format_string())
2204
# Clean up old files
2205
new_branch.control_files._transport.delete('revision-history')
2207
branch.set_parent(None)
2210
branch.set_bound_location(None)
1352
@deprecated_function(zero_eight)
1353
def ScratchBranch(*args, **kwargs):
1354
"""See bzrlib.bzrdir.ScratchDir."""
1355
d = ScratchDir(*args, **kwargs)
1356
return d.open_branch()
1359
@deprecated_function(zero_eight)
1360
def is_control_file(*args, **kwargs):
1361
"""See bzrlib.workingtree.is_control_file."""
1362
return bzrlib.workingtree.is_control_file(*args, **kwargs)