255
196
(copied, failures).
257
198
if self.base == from_branch.base:
199
raise Exception("can't fetch from a branch to itself %s, %s" %
200
(self.base, to_branch.base))
260
nested_pb = ui.ui_factory.nested_progress_bar()
202
pb = bzrlib.ui.ui_factory.progress_bar()
265
204
from_branch.lock_read()
267
206
if last_revision is None:
268
207
pb.update('get source history')
269
last_revision = from_branch.last_revision()
270
last_revision = _mod_revision.ensure_null(last_revision)
208
from_history = from_branch.revision_history()
210
last_revision = from_history[-1]
212
# no history in the source branch
213
last_revision = NULL_REVISION
271
214
return self.repository.fetch(from_branch.repository,
272
215
revision_id=last_revision,
275
if nested_pb is not None:
277
218
from_branch.unlock()
279
def get_bound_location(self):
280
"""Return the URL of the branch we are bound to.
282
Older format branches cannot bind, please be sure to use a metadir
287
def get_old_bound_location(self):
288
"""Return the URL of the branch we used to be bound to
290
raise errors.UpgradeRequired(self.base)
292
def get_commit_builder(self, parents, config=None, timestamp=None,
293
timezone=None, committer=None, revprops=None,
295
"""Obtain a CommitBuilder for this branch.
297
:param parents: Revision ids of the parents of the new revision.
298
:param config: Optional configuration to use.
299
:param timestamp: Optional timestamp recorded for commit.
300
:param timezone: Optional timezone for timestamp.
301
:param committer: Optional committer to set for commit.
302
:param revprops: Optional dictionary of revision properties.
303
:param revision_id: Optional revision id.
307
config = self.get_config()
309
return self.repository.get_commit_builder(self, parents, config,
310
timestamp, timezone, committer, revprops, revision_id)
312
def get_master_branch(self, possible_transports=None):
313
"""Return the branch we are bound to.
315
:return: Either a Branch, or None
319
def get_revision_delta(self, revno):
320
"""Return the delta for one revision.
322
The delta is relative to its mainline predecessor, or the
323
empty tree for revision 1.
325
rh = self.revision_history()
326
if not (1 <= revno <= len(rh)):
327
raise errors.InvalidRevisionNumber(revno)
328
return self.repository.get_revision_delta(rh[revno-1])
330
def get_stacked_on_url(self):
331
"""Get the URL this branch is stacked against.
333
:raises NotStacked: If the branch is not stacked.
334
:raises UnstackableBranchFormat: If the branch does not support
337
raise NotImplementedError(self.get_stacked_on_url)
220
def get_root_id(self):
221
"""Return the id of this branches root"""
222
raise NotImplementedError('get_root_id is abstract')
339
224
def print_file(self, file, revision_id):
340
225
"""Print `file` to stdout."""
341
raise NotImplementedError(self.print_file)
226
raise NotImplementedError('print_file is abstract')
228
def append_revision(self, *revision_ids):
229
raise NotImplementedError('append_revision is abstract')
343
231
def set_revision_history(self, rev_history):
344
raise NotImplementedError(self.set_revision_history)
346
def set_stacked_on_url(self, url):
347
"""Set the URL this branch is stacked against.
349
:raises UnstackableBranchFormat: If the branch does not support
351
:raises UnstackableRepositoryFormat: If the repository does not support
354
raise NotImplementedError(self.set_stacked_on_url)
356
def _cache_revision_history(self, rev_history):
357
"""Set the cached revision history to rev_history.
359
The revision_history method will use this cache to avoid regenerating
360
the revision history.
362
This API is semi-public; it only for use by subclasses, all other code
363
should consider it to be private.
365
self._revision_history_cache = rev_history
367
def _cache_revision_id_to_revno(self, revision_id_to_revno):
368
"""Set the cached revision_id => revno map to revision_id_to_revno.
370
This API is semi-public; it only for use by subclasses, all other code
371
should consider it to be private.
373
self._revision_id_to_revno_cache = revision_id_to_revno
375
def _clear_cached_state(self):
376
"""Clear any cached data on this branch, e.g. cached revision history.
378
This means the next call to revision_history will need to call
379
_gen_revision_history.
381
This API is semi-public; it only for use by subclasses, all other code
382
should consider it to be private.
384
self._revision_history_cache = None
385
self._revision_id_to_revno_cache = None
386
self._last_revision_info_cache = None
388
def _gen_revision_history(self):
389
"""Return sequence of revision hashes on to this branch.
391
Unlike revision_history, this method always regenerates or rereads the
392
revision history, i.e. it does not cache the result, so repeated calls
395
Concrete subclasses should override this instead of revision_history so
396
that subclasses do not need to deal with caching logic.
398
This API is semi-public; it only for use by subclasses, all other code
399
should consider it to be private.
401
raise NotImplementedError(self._gen_revision_history)
232
raise NotImplementedError('set_revision_history is abstract')
404
234
def revision_history(self):
405
"""Return sequence of revision ids on this branch.
407
This method will cache the revision history for as long as it is safe to
410
if 'evil' in debug.debug_flags:
411
mutter_callsite(3, "revision_history scales with history.")
412
if self._revision_history_cache is not None:
413
history = self._revision_history_cache
415
history = self._gen_revision_history()
416
self._cache_revision_history(history)
235
"""Return sequence of revision hashes on to this branch."""
236
raise NotImplementedError('revision_history is abstract')
420
239
"""Return current revision number for this branch.
468
290
common_index = min(self_len, other_len) -1
469
291
if common_index >= 0 and \
470
292
self_history[common_index] != other_history[common_index]:
471
raise errors.DivergedBranches(self, other)
293
raise DivergedBranches(self, other)
473
295
if stop_revision is None:
474
296
stop_revision = other_len
298
assert isinstance(stop_revision, int)
476
299
if stop_revision > other_len:
477
raise errors.NoSuchRevision(self, stop_revision)
300
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
478
301
return other_history[self_len:stop_revision]
481
def update_revisions(self, other, stop_revision=None, overwrite=False,
483
"""Pull in new perfect-fit revisions.
485
:param other: Another Branch to pull from
486
:param stop_revision: Updated until the given revision
487
:param overwrite: Always set the branch pointer, rather than checking
488
to see if it is a proper descendant.
489
:param graph: A Graph object that can be used to query history
490
information. This can be None.
495
other_revno, other_last_revision = other.last_revision_info()
496
stop_revno = None # unknown
497
if stop_revision is None:
498
stop_revision = other_last_revision
499
if _mod_revision.is_null(stop_revision):
500
# if there are no commits, we're done.
502
stop_revno = other_revno
504
# what's the current last revision, before we fetch [and change it
506
last_rev = _mod_revision.ensure_null(self.last_revision())
507
# we fetch here so that we don't process data twice in the common
508
# case of having something to pull, and so that the check for
509
# already merged can operate on the just fetched graph, which will
510
# be cached in memory.
511
self.fetch(other, stop_revision)
512
# Check to see if one is an ancestor of the other
515
graph = self.repository.get_graph()
516
if self._check_if_descendant_or_diverged(
517
stop_revision, last_rev, graph, other):
518
# stop_revision is a descendant of last_rev, but we aren't
519
# overwriting, so we're done.
521
if stop_revno is None:
523
graph = self.repository.get_graph()
524
this_revno, this_last_revision = self.last_revision_info()
525
stop_revno = graph.find_distance_to_null(stop_revision,
526
[(other_last_revision, other_revno),
527
(this_last_revision, this_revno)])
528
self.set_last_revision_info(stop_revno, stop_revision)
303
def update_revisions(self, other, stop_revision=None):
304
"""Pull in new perfect-fit revisions."""
305
raise NotImplementedError('update_revisions is abstract')
307
def pullable_revisions(self, other, stop_revision):
308
raise NotImplementedError('pullable_revisions is abstract')
532
310
def revision_id_to_revno(self, revision_id):
533
311
"""Given a revision id, return its revno"""
534
if _mod_revision.is_null(revision_id):
312
if revision_id is None:
536
314
history = self.revision_history()
538
316
return history.index(revision_id) + 1
539
317
except ValueError:
540
raise errors.NoSuchRevision(self, revision_id)
318
raise bzrlib.errors.NoSuchRevision(self, revision_id)
542
320
def get_rev_id(self, revno, history=None):
543
321
"""Find the revision id of the specified revno."""
545
return _mod_revision.NULL_REVISION
546
324
if history is None:
547
325
history = self.revision_history()
548
if revno <= 0 or revno > len(history):
549
raise errors.NoSuchRevision(self, revno)
326
elif revno <= 0 or revno > len(history):
327
raise bzrlib.errors.NoSuchRevision(self, revno)
550
328
return history[revno - 1]
552
def pull(self, source, overwrite=False, stop_revision=None,
553
possible_transports=None, _override_hook_target=None):
554
"""Mirror source into this branch.
556
This branch is considered to be 'local', having low latency.
558
:returns: PullResult instance
560
raise NotImplementedError(self.pull)
562
def push(self, target, overwrite=False, stop_revision=None):
563
"""Mirror this branch into target.
565
This branch is considered to be 'local', having low latency.
567
raise NotImplementedError(self.push)
330
def pull(self, source, overwrite=False, stop_revision=None):
331
raise NotImplementedError('pull is abstract')
569
333
def basis_tree(self):
570
"""Return `Tree` object for last revision."""
334
"""Return `Tree` object for last revision.
336
If there are no revisions yet, return an `EmptyTree`.
571
338
return self.repository.revision_tree(self.last_revision())
340
def rename_one(self, from_rel, to_rel):
343
This can change the directory or the filename or both.
345
raise NotImplementedError('rename_one is abstract')
347
def move(self, from_paths, to_name):
350
to_name must exist as a versioned directory.
352
If to_name exists and is a directory, the files are moved into
353
it, keeping their old names. If it is a directory,
355
Note that to_name is only the last component of the new name;
356
this doesn't change the directory.
358
This returns a list of (from_path, to_path) pairs for each
361
raise NotImplementedError('move is abstract')
573
363
def get_parent(self):
574
364
"""Return the parent location of the branch.
666
394
Zero (the NULL revision) is considered invalid
668
396
if revno < 1 or revno > self.revno():
669
raise errors.InvalidRevisionNumber(revno)
397
raise InvalidRevisionNumber(revno)
672
def clone(self, to_bzrdir, revision_id=None):
400
def clone(self, *args, **kwargs):
673
401
"""Clone this branch into to_bzrdir preserving all semantic values.
675
403
revision_id: if not None, the revision history in the new branch will
676
404
be truncated to end with revision_id.
678
result = to_bzrdir.create_branch()
406
# for API compatability, until 0.8 releases we provide the old api:
407
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
408
# after 0.8 releases, the *args and **kwargs should be changed:
409
# def clone(self, to_bzrdir, revision_id=None):
410
if (kwargs.get('to_location', None) or
411
kwargs.get('revision', None) or
412
kwargs.get('basis_branch', None) or
413
(len(args) and isinstance(args[0], basestring))):
414
# backwards compatability api:
415
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
416
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
419
basis_branch = args[2]
421
basis_branch = kwargs.get('basis_branch', None)
423
basis = basis_branch.bzrdir
428
revision_id = args[1]
430
revision_id = kwargs.get('revision', None)
435
# no default to raise if not provided.
436
url = kwargs.get('to_location')
437
return self.bzrdir.clone(url,
438
revision_id=revision_id,
439
basis=basis).open_branch()
441
# generate args by hand
443
revision_id = args[1]
445
revision_id = kwargs.get('revision_id', None)
449
# no default to raise if not provided.
450
to_bzrdir = kwargs.get('to_bzrdir')
451
result = self._format.initialize(to_bzrdir)
679
452
self.copy_content_into(result, revision_id=revision_id)
683
456
def sprout(self, to_bzrdir, revision_id=None):
684
457
"""Create a new line of development from the branch, into to_bzrdir.
686
to_bzrdir controls the branch format.
688
459
revision_id: if not None, the revision history in the new branch will
689
460
be truncated to end with revision_id.
691
result = to_bzrdir.create_branch()
462
result = self._format.initialize(to_bzrdir)
692
463
self.copy_content_into(result, revision_id=revision_id)
693
464
result.set_parent(self.bzrdir.root_transport.base)
696
def _synchronize_history(self, destination, revision_id):
697
"""Synchronize last revision and revision history between branches.
699
This version is most efficient when the destination is also a
700
BzrBranch5, but works for BzrBranch6 as long as the revision
701
history is the true lefthand parent history, and all of the revisions
702
are in the destination's repository. If not, set_revision_history
705
:param destination: The branch to copy the history into
706
:param revision_id: The revision-id to truncate history at. May
707
be None to copy complete history.
468
def copy_content_into(self, destination, revision_id=None):
469
"""Copy the content of self into destination.
471
revision_id: if not None, the revision history in the new branch will
472
be truncated to end with revision_id.
709
if revision_id == _mod_revision.NULL_REVISION:
712
new_history = self.revision_history()
713
if revision_id is not None and new_history != []:
474
new_history = self.revision_history()
475
if revision_id is not None:
715
477
new_history = new_history[:new_history.index(revision_id) + 1]
716
478
except ValueError:
717
479
rev = self.repository.get_revision(revision_id)
718
480
new_history = rev.get_history(self.repository)[1:]
719
481
destination.set_revision_history(new_history)
722
def copy_content_into(self, destination, revision_id=None):
723
"""Copy the content of self into destination.
725
revision_id: if not None, the revision history in the new branch will
726
be truncated to end with revision_id.
728
self._synchronize_history(destination, revision_id)
730
parent = self.get_parent()
731
except errors.InaccessibleParent, e:
732
mutter('parent was not accessible to copy: %s', e)
735
destination.set_parent(parent)
736
self.tags.merge_to(destination.tags)
740
"""Check consistency of the branch.
742
In particular this checks that revisions given in the revision-history
743
do actually match up in the revision graph, and that they're all
744
present in the repository.
746
Callers will typically also want to check the repository.
748
:return: A BranchCheckResult.
750
mainline_parent_id = None
751
last_revno, last_revision_id = self.last_revision_info()
752
real_rev_history = list(self.repository.iter_reverse_revision_history(
754
real_rev_history.reverse()
755
if len(real_rev_history) != last_revno:
756
raise errors.BzrCheckError('revno does not match len(mainline)'
757
' %s != %s' % (last_revno, len(real_rev_history)))
758
# TODO: We should probably also check that real_rev_history actually
759
# matches self.revision_history()
760
for revision_id in real_rev_history:
762
revision = self.repository.get_revision(revision_id)
763
except errors.NoSuchRevision, e:
764
raise errors.BzrCheckError("mainline revision {%s} not in repository"
766
# In general the first entry on the revision history has no parents.
767
# But it's not illegal for it to have parents listed; this can happen
768
# in imports from Arch when the parents weren't reachable.
769
if mainline_parent_id is not None:
770
if mainline_parent_id not in revision.parent_ids:
771
raise errors.BzrCheckError("previous revision {%s} not listed among "
773
% (mainline_parent_id, revision_id))
774
mainline_parent_id = revision_id
775
return BranchCheckResult(self)
777
def _get_checkout_format(self):
778
"""Return the most suitable metadir for a checkout of this branch.
779
Weaves are used if this branch's repository uses weaves.
781
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
782
from bzrlib.repofmt import weaverepo
783
format = bzrdir.BzrDirMetaFormat1()
784
format.repository_format = weaverepo.RepositoryFormat7()
786
format = self.repository.bzrdir.checkout_metadir()
787
format.set_branch_format(self._format)
790
def create_checkout(self, to_location, revision_id=None,
791
lightweight=False, accelerator_tree=None,
793
"""Create a checkout of a branch.
795
:param to_location: The url to produce the checkout at
796
:param revision_id: The revision to check out
797
:param lightweight: If True, produce a lightweight checkout, otherwise,
798
produce a bound branch (heavyweight checkout)
799
:param accelerator_tree: A tree which can be used for retrieving file
800
contents more quickly than the revision tree, i.e. a workingtree.
801
The revision tree will be used for cases where accelerator_tree's
802
content is different.
803
:param hardlink: If true, hard-link files from accelerator_tree,
805
:return: The tree of the created checkout
807
t = transport.get_transport(to_location)
810
format = self._get_checkout_format()
811
checkout = format.initialize_on_transport(t)
812
from_branch = BranchReferenceFormat().initialize(checkout, self)
814
format = self._get_checkout_format()
815
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
816
to_location, force_new_tree=False, format=format)
817
checkout = checkout_branch.bzrdir
818
checkout_branch.bind(self)
819
# pull up to the specified revision_id to set the initial
820
# branch tip correctly, and seed it with history.
821
checkout_branch.pull(self, stop_revision=revision_id)
823
tree = checkout.create_workingtree(revision_id,
824
from_branch=from_branch,
825
accelerator_tree=accelerator_tree,
827
basis_tree = tree.basis_tree()
828
basis_tree.lock_read()
830
for path, file_id in basis_tree.iter_references():
831
reference_parent = self.reference_parent(file_id, path)
832
reference_parent.create_checkout(tree.abspath(path),
833
basis_tree.get_reference_revision(file_id, path),
840
def reconcile(self, thorough=True):
841
"""Make sure the data stored in this branch is consistent."""
842
from bzrlib.reconcile import BranchReconciler
843
reconciler = BranchReconciler(self, thorough=thorough)
844
reconciler.reconcile()
847
def reference_parent(self, file_id, path):
848
"""Return the parent branch for a tree-reference file_id
849
:param file_id: The file_id of the tree reference
850
:param path: The path of the file_id in the tree
851
:return: A branch associated with the file_id
853
# FIXME should provide multiple branches, based on config
854
return Branch.open(self.bzrdir.root_transport.clone(path).base)
856
def supports_tags(self):
857
return self._format.supports_tags()
859
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
861
"""Ensure that revision_b is a descendant of revision_a.
863
This is a helper function for update_revisions.
865
:raises: DivergedBranches if revision_b has diverged from revision_a.
866
:returns: True if revision_b is a descendant of revision_a.
868
relation = self._revision_relations(revision_a, revision_b, graph)
869
if relation == 'b_descends_from_a':
871
elif relation == 'diverged':
872
raise errors.DivergedBranches(self, other_branch)
873
elif relation == 'a_descends_from_b':
876
raise AssertionError("invalid relation: %r" % (relation,))
878
def _revision_relations(self, revision_a, revision_b, graph):
879
"""Determine the relationship between two revisions.
881
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
883
heads = graph.heads([revision_a, revision_b])
884
if heads == set([revision_b]):
885
return 'b_descends_from_a'
886
elif heads == set([revision_a, revision_b]):
887
# These branches have diverged
889
elif heads == set([revision_a]):
890
return 'a_descends_from_b'
892
raise AssertionError("invalid heads: %r" % (heads,))
482
parent = self.get_parent()
484
destination.set_parent(parent)
895
487
class BranchFormat(object):
1035
558
def set_default_format(klass, format):
1036
559
klass._default_format = format
1038
def supports_stacking(self):
1039
"""True if this format records a stacked-on branch."""
1043
562
def unregister_format(klass, format):
563
assert klass._formats[format.get_format_string()] is format
1044
564
del klass._formats[format.get_format_string()]
1047
return self.get_format_string().rstrip()
1049
def supports_tags(self):
1050
"""True if this format supports tags stored in the branch"""
1051
return False # by default
1054
class BranchHooks(Hooks):
1055
"""A dictionary mapping hook name to a list of callables for branch hooks.
1057
e.g. ['set_rh'] Is the list of items to be called when the
1058
set_revision_history function is invoked.
1062
"""Create the default hooks.
1064
These are all empty initially, because by default nothing should get
1067
Hooks.__init__(self)
1068
# Introduced in 0.15:
1069
# invoked whenever the revision history has been set
1070
# with set_revision_history. The api signature is
1071
# (branch, revision_history), and the branch will
1074
# Invoked after a branch is opened. The api signature is (branch).
1076
# invoked after a push operation completes.
1077
# the api signature is
1079
# containing the members
1080
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1081
# where local is the local target branch or None, master is the target
1082
# master branch, and the rest should be self explanatory. The source
1083
# is read locked and the target branches write locked. Source will
1084
# be the local low-latency branch.
1085
self['post_push'] = []
1086
# invoked after a pull operation completes.
1087
# the api signature is
1089
# containing the members
1090
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1091
# where local is the local branch or None, master is the target
1092
# master branch, and the rest should be self explanatory. The source
1093
# is read locked and the target branches write locked. The local
1094
# branch is the low-latency branch.
1095
self['post_pull'] = []
1096
# invoked before a commit operation takes place.
1097
# the api signature is
1098
# (local, master, old_revno, old_revid, future_revno, future_revid,
1099
# tree_delta, future_tree).
1100
# old_revid is NULL_REVISION for the first commit to a branch
1101
# tree_delta is a TreeDelta object describing changes from the basis
1102
# revision, hooks MUST NOT modify this delta
1103
# future_tree is an in-memory tree obtained from
1104
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1105
self['pre_commit'] = []
1106
# invoked after a commit operation completes.
1107
# the api signature is
1108
# (local, master, old_revno, old_revid, new_revno, new_revid)
1109
# old_revid is NULL_REVISION for the first commit to a branch.
1110
self['post_commit'] = []
1111
# invoked after a uncommit operation completes.
1112
# the api signature is
1113
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1114
# local is the local branch or None, master is the target branch,
1115
# and an empty branch recieves new_revno of 0, new_revid of None.
1116
self['post_uncommit'] = []
1118
# Invoked before the tip of a branch changes.
1119
# the api signature is
1120
# (params) where params is a ChangeBranchTipParams with the members
1121
# (branch, old_revno, new_revno, old_revid, new_revid)
1122
self['pre_change_branch_tip'] = []
1124
# Invoked after the tip of a branch changes.
1125
# the api signature is
1126
# (params) where params is a ChangeBranchTipParams with the members
1127
# (branch, old_revno, new_revno, old_revid, new_revid)
1128
self['post_change_branch_tip'] = []
1131
# install the default hooks into the Branch class.
1132
Branch.hooks = BranchHooks()
1135
class ChangeBranchTipParams(object):
1136
"""Object holding parameters passed to *_change_branch_tip hooks.
1138
There are 5 fields that hooks may wish to access:
1140
:ivar branch: the branch being changed
1141
:ivar old_revno: revision number before the change
1142
:ivar new_revno: revision number after the change
1143
:ivar old_revid: revision id before the change
1144
:ivar new_revid: revision id after the change
1146
The revid fields are strings. The revno fields are integers.
1149
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1150
"""Create a group of ChangeBranchTip parameters.
1152
:param branch: The branch being changed.
1153
:param old_revno: Revision number before the change.
1154
:param new_revno: Revision number after the change.
1155
:param old_revid: Tip revision id before the change.
1156
:param new_revid: Tip revision id after the change.
1158
self.branch = branch
1159
self.old_revno = old_revno
1160
self.new_revno = new_revno
1161
self.old_revid = old_revid
1162
self.new_revid = new_revid
1164
def __eq__(self, other):
1165
return self.__dict__ == other.__dict__
1168
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1169
self.__class__.__name__, self.branch,
1170
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1173
567
class BzrBranchFormat4(BranchFormat):
1174
568
"""Bzr branch format 4.
1208
606
a_bzrdir=a_bzrdir,
1209
607
_repository=a_bzrdir.open_repository())
1212
return "Bazaar-NG branch format 4"
1215
class BranchFormatMetadir(BranchFormat):
1216
"""Common logic for meta-dir based branch formats."""
1218
def _branch_class(self):
1219
"""What class to instantiate on open calls."""
1220
raise NotImplementedError(self._branch_class)
1222
def open(self, a_bzrdir, _found=False):
1223
"""Return the branch object for a_bzrdir.
1225
_found is a private parameter, do not use it. It is used to indicate
1226
if format probing has already be done.
1229
format = BranchFormat.find_format(a_bzrdir)
1230
if format.__class__ != self.__class__:
1231
raise AssertionError("wrong format %r found for %r" %
1234
transport = a_bzrdir.get_branch_transport(None)
1235
control_files = lockable_files.LockableFiles(transport, 'lock',
1237
return self._branch_class()(_format=self,
1238
_control_files=control_files,
1240
_repository=a_bzrdir.find_repository())
1241
except errors.NoSuchFile:
1242
raise errors.NotBranchError(path=transport.base)
1245
super(BranchFormatMetadir, self).__init__()
1246
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1248
def supports_tags(self):
1252
class BzrBranchFormat5(BranchFormatMetadir):
610
class BzrBranchFormat5(BranchFormat):
1253
611
"""Bzr branch format 5.
1255
613
This format has:
1256
614
- a revision-history file.
1257
615
- a format string
1258
- a lock dir guarding the branch itself
1259
- all of this stored in a branch/ subdirectory
1260
617
- works with shared repositories.
1262
This format is new in bzr 0.8.
1265
def _branch_class(self):
1268
620
def get_format_string(self):
1269
621
"""See BranchFormat.get_format_string()."""
1270
622
return "Bazaar-NG branch format 5\n"
1272
def get_format_description(self):
1273
"""See BranchFormat.get_format_description()."""
1274
return "Branch format 5"
1276
624
def initialize(self, a_bzrdir):
1277
625
"""Create a branch of this format in a_bzrdir."""
626
mutter('creating branch in %s', a_bzrdir.transport.base)
627
branch_transport = a_bzrdir.get_branch_transport(self)
1278
629
utf8_files = [('revision-history', ''),
1279
630
('branch-name', ''),
1281
return self._initialize_helper(a_bzrdir, utf8_files)
1283
def supports_tags(self):
1287
class BzrBranchFormat6(BranchFormatMetadir):
1288
"""Branch format with last-revision and tags.
1290
Unlike previous formats, this has no explicit revision history. Instead,
1291
this just stores the last-revision, and the left-hand history leading
1292
up to there is the history.
1294
This format was introduced in bzr 0.15
1295
and became the default in 0.91.
1298
def _branch_class(self):
1301
def get_format_string(self):
1302
"""See BranchFormat.get_format_string()."""
1303
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1305
def get_format_description(self):
1306
"""See BranchFormat.get_format_description()."""
1307
return "Branch format 6"
1309
def initialize(self, a_bzrdir):
1310
"""Create a branch of this format in a_bzrdir."""
1311
utf8_files = [('last-revision', '0 null:\n'),
1312
('branch.conf', ''),
1315
return self._initialize_helper(a_bzrdir, utf8_files)
1318
class BzrBranchFormat7(BranchFormatMetadir):
1319
"""Branch format with last-revision, tags, and a stacked location pointer.
1321
The stacked location pointer is passed down to the repository and requires
1322
a repository format with supports_external_lookups = True.
1324
This format was introduced in bzr 1.6.
1327
def _branch_class(self):
1330
def get_format_string(self):
1331
"""See BranchFormat.get_format_string()."""
1332
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1334
def get_format_description(self):
1335
"""See BranchFormat.get_format_description()."""
1336
return "Branch format 7"
1338
def initialize(self, a_bzrdir):
1339
"""Create a branch of this format in a_bzrdir."""
1340
utf8_files = [('last-revision', '0 null:\n'),
1341
('branch.conf', ''),
1344
return self._initialize_helper(a_bzrdir, utf8_files)
633
branch_transport.put(lock_file, StringIO()) # TODO get the file mode from the bzrdir lock files., mode=file_mode)
634
control_files = LockableFiles(branch_transport, 'lock')
635
control_files.lock_write()
636
control_files.put_utf8('format', self.get_format_string())
638
for file, content in utf8_files:
639
control_files.put_utf8(file, content)
641
control_files.unlock()
642
return self.open(a_bzrdir, _found=True, )
1346
644
def __init__(self):
1347
super(BzrBranchFormat7, self).__init__()
1348
self._matchingbzrdir.repository_format = \
1349
RepositoryFormatKnitPack5RichRoot()
1351
def supports_stacking(self):
645
super(BzrBranchFormat5, self).__init__()
646
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
648
def open(self, a_bzrdir, _found=False):
649
"""Return the branch object for a_bzrdir
651
_found is a private parameter, do not use it. It is used to indicate
652
if format probing has already be done.
655
format = BranchFormat.find_format(a_bzrdir)
656
assert format.__class__ == self.__class__
657
transport = a_bzrdir.get_branch_transport(None)
658
control_files = LockableFiles(transport, 'lock')
659
return BzrBranch(_format=self,
660
_control_files=control_files,
662
_repository=a_bzrdir.find_repository())
1355
665
class BranchReferenceFormat(BranchFormat):
1458
743
Note that it's "local" in the context of the filesystem; it doesn't
1459
744
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1460
745
it's writable, and can be accessed via the normal filesystem API.
1462
:ivar _transport: Transport for file operations on this branch's
1463
control files, typically pointing to the .bzr/branch directory.
1464
:ivar repository: Repository for this branch.
1465
:ivar base: The url of the base directory for this branch; the one
1466
containing the .bzr directory.
747
# We actually expect this class to be somewhat short-lived; part of its
748
# purpose is to try to isolate what bits of the branch logic are tied to
749
# filesystem access, so that in a later step, we can extricate them to
750
# a separarte ("storage") class.
751
_inventory_weave = None
1469
def __init__(self, _format=None,
753
# Map some sort of prefix into a namespace
754
# stuff like "revno:10", "revid:", etc.
755
# This should match a prefix with a function which accepts
756
REVISION_NAMESPACES = {}
758
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
759
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1470
760
_control_files=None, a_bzrdir=None, _repository=None):
1471
"""Create new branch object at a particular location."""
761
"""Create new branch object at a particular location.
763
transport -- A Transport object, defining how to access files.
765
init -- If True, create new control files in a previously
766
unversioned directory. If False, the branch must already
769
relax_version_check -- If true, the usual check for the branch
770
version is not applied. This is intended only for
771
upgrade/recovery type use; it's not guaranteed that
772
all operations will work on old format branches.
1472
774
if a_bzrdir is None:
1473
raise ValueError('a_bzrdir must be supplied')
775
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1475
777
self.bzrdir = a_bzrdir
1476
self._base = self.bzrdir.transport.clone('..').base
1477
# XXX: We should be able to just do
1478
# self.base = self.bzrdir.root_transport.base
1479
# but this does not quite work yet -- mbp 20080522
778
self._transport = self.bzrdir.transport.clone('..')
779
self._base = self._transport.base
1480
780
self._format = _format
1481
781
if _control_files is None:
1482
raise ValueError('BzrBranch _control_files is None')
782
raise BzrBadParameterMissing('_control_files')
1483
783
self.control_files = _control_files
1484
self._transport = _control_files._transport
784
if deprecated_passed(init):
785
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
786
"deprecated as of bzr 0.8. Please use Branch.create().",
790
# this is slower than before deprecation, oh well never mind.
792
self._initialize(transport.base)
793
self._check_format(_format)
794
if deprecated_passed(relax_version_check):
795
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
796
"relax_version_check parameter is deprecated as of bzr 0.8. "
797
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
801
if (not relax_version_check
802
and not self._format.is_supported()):
803
raise errors.UnsupportedFormatError(
804
'sorry, branch format %r not supported' % fmt,
805
['use a different bzr version',
806
'or remove the .bzr directory'
807
' and "bzr init" again'])
808
if deprecated_passed(transport):
809
warn("BzrBranch.__init__(transport=XXX...): The transport "
810
"parameter is deprecated as of bzr 0.8. "
811
"Please use Branch.open, or bzrdir.open_branch().",
1485
814
self.repository = _repository
1486
Branch.__init__(self)
1488
816
def __str__(self):
1489
817
return '%s(%r)' % (self.__class__.__name__, self.base)
1491
819
__repr__ = __str__
822
# TODO: It might be best to do this somewhere else,
823
# but it is nice for a Branch object to automatically
824
# cache it's information.
825
# Alternatively, we could have the Transport objects cache requests
826
# See the earlier discussion about how major objects (like Branch)
827
# should never expect their __del__ function to run.
828
# XXX: cache_root seems to be unused, 2006-01-13 mbp
829
if hasattr(self, 'cache_root') and self.cache_root is not None:
831
shutil.rmtree(self.cache_root)
834
self.cache_root = None
1493
836
def _get_base(self):
1494
"""Returns the directory containing the control directory."""
1495
837
return self._base
1497
839
base = property(_get_base, doc="The URL for the root of this branch.")
1499
def is_locked(self):
1500
return self.control_files.is_locked()
1502
def lock_write(self, token=None):
1503
repo_token = self.repository.lock_write()
1505
token = self.control_files.lock_write(token=token)
1507
self.repository.unlock()
841
def _finish_transaction(self):
842
"""Exit the current transaction."""
843
return self.control_files._finish_transaction()
845
def get_transaction(self):
846
"""Return the current active transaction.
848
If no transaction is active, this returns a passthrough object
849
for which all data is immediately flushed and no caching happens.
851
# this is an explicit function so that we can do tricky stuff
852
# when the storage in rev_storage is elsewhere.
853
# we probably need to hook the two 'lock a location' and
854
# 'have a transaction' together more delicately, so that
855
# we can have two locks (branch and storage) and one transaction
856
# ... and finishing the transaction unlocks both, but unlocking
857
# does not. - RBC 20051121
858
return self.control_files.get_transaction()
860
def _set_transaction(self, transaction):
861
"""Set a new active transaction."""
862
return self.control_files._set_transaction(transaction)
864
def abspath(self, name):
865
"""See Branch.abspath."""
866
return self.control_files._transport.abspath(name)
868
def _check_format(self, format):
869
"""Identify the branch format if needed.
871
The format is stored as a reference to the format object in
872
self._format for code that needs to check it later.
874
The format parameter is either None or the branch format class
875
used to open this branch.
877
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
880
format = BzrBranchFormat.find_format(self.bzrdir)
881
self._format = format
882
mutter("got branch format %s", self._format)
885
def get_root_id(self):
886
"""See Branch.get_root_id."""
887
tree = self.repository.revision_tree(self.last_revision())
888
return tree.inventory.root.file_id
890
def lock_write(self):
891
# TODO: test for failed two phase locks. This is known broken.
892
self.control_files.lock_write()
893
self.repository.lock_write()
1511
895
def lock_read(self):
896
# TODO: test for failed two phase locks. This is known broken.
897
self.control_files.lock_read()
1512
898
self.repository.lock_read()
1514
self.control_files.lock_read()
1516
self.repository.unlock()
1519
900
def unlock(self):
1520
901
# TODO: test for failed two phase locks. This is known broken.
1522
self.control_files.unlock()
1524
self.repository.unlock()
1525
if not self.control_files.is_locked():
1526
# we just released the lock
1527
self._clear_cached_state()
902
self.repository.unlock()
903
self.control_files.unlock()
1529
905
def peek_lock_mode(self):
1530
906
if self.control_files._lock_count == 0:
1533
909
return self.control_files._lock_mode
1535
def get_physical_lock_status(self):
1536
return self.control_files.get_physical_lock_status()
1538
911
@needs_read_lock
1539
912
def print_file(self, file, revision_id):
1540
913
"""See Branch.print_file."""
1541
914
return self.repository.print_file(file, revision_id)
1543
def _write_revision_history(self, history):
1544
"""Factored out of set_revision_history.
1546
This performs the actual writing to disk.
1547
It is intended to be called by BzrBranch5.set_revision_history."""
1548
self._transport.put_bytes(
1549
'revision-history', '\n'.join(history),
1550
mode=self.bzrdir._get_file_mode())
917
def append_revision(self, *revision_ids):
918
"""See Branch.append_revision."""
919
for revision_id in revision_ids:
920
mutter("add {%s} to revision-history" % revision_id)
921
rev_history = self.revision_history()
922
rev_history.extend(revision_ids)
923
self.set_revision_history(rev_history)
1552
925
@needs_write_lock
1553
926
def set_revision_history(self, rev_history):
1554
927
"""See Branch.set_revision_history."""
1555
if 'evil' in debug.debug_flags:
1556
mutter_callsite(3, "set_revision_history scales with history.")
1557
check_not_reserved_id = _mod_revision.check_not_reserved_id
1558
for rev_id in rev_history:
1559
check_not_reserved_id(rev_id)
1560
if Branch.hooks['post_change_branch_tip']:
1561
# Don't calculate the last_revision_info() if there are no hooks
1563
old_revno, old_revid = self.last_revision_info()
1564
if len(rev_history) == 0:
1565
revid = _mod_revision.NULL_REVISION
928
self.control_files.put_utf8(
929
'revision-history', '\n'.join(rev_history))
931
def get_revision_delta(self, revno):
932
"""Return the delta for one revision.
934
The delta is relative to its mainline predecessor, or the
935
empty tree for revision 1.
937
assert isinstance(revno, int)
938
rh = self.revision_history()
939
if not (1 <= revno <= len(rh)):
940
raise InvalidRevisionNumber(revno)
942
# revno is 1-based; list is 0-based
944
new_tree = self.repository.revision_tree(rh[revno-1])
946
old_tree = EmptyTree()
1567
revid = rev_history[-1]
1568
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1569
self._write_revision_history(rev_history)
1570
self._clear_cached_state()
1571
self._cache_revision_history(rev_history)
1572
for hook in Branch.hooks['set_rh']:
1573
hook(self, rev_history)
1574
if Branch.hooks['post_change_branch_tip']:
1575
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1577
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1578
"""Run the pre_change_branch_tip hooks."""
1579
hooks = Branch.hooks['pre_change_branch_tip']
948
old_tree = self.repository.revision_tree(rh[revno-2])
949
return compare_trees(old_tree, new_tree)
952
def revision_history(self):
953
"""See Branch.revision_history."""
954
# FIXME are transactions bound to control files ? RBC 20051121
955
transaction = self.get_transaction()
956
history = transaction.map.find_revision_history()
957
if history is not None:
958
mutter("cache hit for revision-history in %s", self)
960
history = [l.rstrip('\r\n') for l in
961
self.control_files.get_utf8('revision-history').readlines()]
962
transaction.map.add_revision_history(history)
963
# this call is disabled because revision_history is
964
# not really an object yet, and the transaction is for objects.
965
# transaction.register_clean(history, precious=True)
968
def update_revisions(self, other, stop_revision=None):
969
"""See Branch.update_revisions."""
970
if stop_revision is None:
971
stop_revision = other.last_revision()
972
### Should this be checking is_ancestor instead of revision_history?
973
if (stop_revision is not None and
974
stop_revision in self.revision_history()):
1582
old_revno, old_revid = self.last_revision_info()
1583
params = ChangeBranchTipParams(
1584
self, old_revno, new_revno, old_revid, new_revid)
976
self.fetch(other, stop_revision)
977
pullable_revs = self.pullable_revisions(other, stop_revision)
978
if len(pullable_revs) > 0:
979
self.append_revision(*pullable_revs)
981
def pullable_revisions(self, other, stop_revision):
982
"""See Branch.pullable_revisions."""
983
other_revno = other.revision_id_to_revno(stop_revision)
985
return self.missing_revisions(other, other_revno)
986
except DivergedBranches, e:
1588
except errors.TipChangeRejected:
1591
exc_info = sys.exc_info()
1592
hook_name = Branch.hooks.get_hook_name(hook)
1593
raise errors.HookFailed(
1594
'pre_change_branch_tip', hook_name, exc_info)
1596
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1597
"""Run the post_change_branch_tip hooks."""
1598
hooks = Branch.hooks['post_change_branch_tip']
1601
new_revno, new_revid = self.last_revision_info()
1602
params = ChangeBranchTipParams(
1603
self, old_revno, new_revno, old_revid, new_revid)
1608
def set_last_revision_info(self, revno, revision_id):
1609
"""Set the last revision of this branch.
1611
The caller is responsible for checking that the revno is correct
1612
for this revision id.
1614
It may be possible to set the branch last revision to an id not
1615
present in the repository. However, branches can also be
1616
configured to check constraints on history, in which case this may not
1619
revision_id = _mod_revision.ensure_null(revision_id)
1620
# this old format stores the full history, but this api doesn't
1621
# provide it, so we must generate, and might as well check it's
1623
history = self._lefthand_history(revision_id)
1624
if len(history) != revno:
1625
raise AssertionError('%d != %d' % (len(history), revno))
1626
self.set_revision_history(history)
1628
def _gen_revision_history(self):
1629
history = self._transport.get_bytes('revision-history').split('\n')
1630
if history[-1:] == ['']:
1631
# There shouldn't be a trailing newline, but just in case.
1635
def _lefthand_history(self, revision_id, last_rev=None,
1637
if 'evil' in debug.debug_flags:
1638
mutter_callsite(4, "_lefthand_history scales with history.")
1639
# stop_revision must be a descendant of last_revision
1640
graph = self.repository.get_graph()
1641
if last_rev is not None:
1642
if not graph.is_ancestor(last_rev, revision_id):
1643
# our previous tip is not merged into stop_revision
1644
raise errors.DivergedBranches(self, other_branch)
1645
# make a new revision history from the graph
1646
parents_map = graph.get_parent_map([revision_id])
1647
if revision_id not in parents_map:
1648
raise errors.NoSuchRevision(self, revision_id)
1649
current_rev_id = revision_id
1651
check_not_reserved_id = _mod_revision.check_not_reserved_id
1652
# Do not include ghosts or graph origin in revision_history
1653
while (current_rev_id in parents_map and
1654
len(parents_map[current_rev_id]) > 0):
1655
check_not_reserved_id(current_rev_id)
1656
new_history.append(current_rev_id)
1657
current_rev_id = parents_map[current_rev_id][0]
1658
parents_map = graph.get_parent_map([current_rev_id])
1659
new_history.reverse()
1663
def generate_revision_history(self, revision_id, last_rev=None,
1665
"""Create a new revision history that will finish with revision_id.
1667
:param revision_id: the new tip to use.
1668
:param last_rev: The previous last_revision. If not None, then this
1669
must be a ancestory of revision_id, or DivergedBranches is raised.
1670
:param other_branch: The other branch that DivergedBranches should
1671
raise with respect to.
1673
self.set_revision_history(self._lefthand_history(revision_id,
1674
last_rev, other_branch))
988
pullable_revs = get_intervening_revisions(self.last_revision(),
991
assert self.last_revision() not in pullable_revs
993
except bzrlib.errors.NotAncestor:
994
if is_ancestor(self.last_revision(), stop_revision, self):
1676
999
def basis_tree(self):
1677
1000
"""See Branch.basis_tree."""
1678
1001
return self.repository.revision_tree(self.last_revision())
1003
@deprecated_method(zero_eight)
1004
def working_tree(self):
1005
"""Create a Working tree object for this branch."""
1006
from bzrlib.workingtree import WorkingTree
1007
from bzrlib.transport.local import LocalTransport
1008
if (self.base.find('://') != -1 or
1009
not isinstance(self._transport, LocalTransport)):
1010
raise NoWorkingTree(self.base)
1011
return self.bzrdir.open_workingtree()
1680
1013
@needs_write_lock
1681
def pull(self, source, overwrite=False, stop_revision=None,
1682
_hook_master=None, run_hooks=True, possible_transports=None,
1683
_override_hook_target=None):
1686
:param _hook_master: Private parameter - set the branch to
1687
be supplied as the master to pull hooks.
1688
:param run_hooks: Private parameter - if false, this branch
1689
is being called because it's the master of the primary branch,
1690
so it should not run its hooks.
1691
:param _override_hook_target: Private parameter - set the branch to be
1692
supplied as the target_branch to pull hooks.
1694
result = PullResult()
1695
result.source_branch = source
1696
if _override_hook_target is None:
1697
result.target_branch = self
1699
result.target_branch = _override_hook_target
1014
def pull(self, source, overwrite=False, stop_revision=None):
1015
"""See Branch.pull."""
1700
1016
source.lock_read()
1702
# We assume that during 'pull' the local repository is closer than
1704
graph = self.repository.get_graph(source.repository)
1705
result.old_revno, result.old_revid = self.last_revision_info()
1706
self.update_revisions(source, stop_revision, overwrite=overwrite,
1708
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1709
result.new_revno, result.new_revid = self.last_revision_info()
1711
result.master_branch = _hook_master
1712
result.local_branch = result.target_branch
1714
result.master_branch = result.target_branch
1715
result.local_branch = None
1717
for hook in Branch.hooks['post_pull']:
1018
old_count = len(self.revision_history())
1020
self.update_revisions(source,stop_revision)
1021
except DivergedBranches:
1025
self.set_revision_history(source.revision_history())
1026
new_count = len(self.revision_history())
1027
return new_count - old_count
1720
1029
source.unlock()
1723
def _get_parent_location(self):
1031
def get_parent(self):
1032
"""See Branch.get_parent."""
1724
1034
_locs = ['parent', 'pull', 'x-pull']
1725
1035
for l in _locs:
1727
return self._transport.get_bytes(l).strip('\n')
1728
except errors.NoSuchFile:
1037
return self.control_files.get_utf8(l).read().strip('\n')
1733
def push(self, target, overwrite=False, stop_revision=None,
1734
_override_hook_source_branch=None):
1737
This is the basic concrete implementation of push()
1739
:param _override_hook_source_branch: If specified, run
1740
the hooks passing this Branch as the source, rather than self.
1741
This is for use of RemoteBranch, where push is delegated to the
1742
underlying vfs-based Branch.
1744
# TODO: Public option to disable running hooks - should be trivial but
1746
return _run_with_write_locked_target(
1747
target, self._push_with_bound_branches, target, overwrite,
1749
_override_hook_source_branch=_override_hook_source_branch)
1751
def _push_with_bound_branches(self, target, overwrite,
1753
_override_hook_source_branch=None):
1754
"""Push from self into target, and into target's master if any.
1756
This is on the base BzrBranch class even though it doesn't support
1757
bound branches because the *target* might be bound.
1760
if _override_hook_source_branch:
1761
result.source_branch = _override_hook_source_branch
1762
for hook in Branch.hooks['post_push']:
1765
bound_location = target.get_bound_location()
1766
if bound_location and target.base != bound_location:
1767
# there is a master branch.
1769
# XXX: Why the second check? Is it even supported for a branch to
1770
# be bound to itself? -- mbp 20070507
1771
master_branch = target.get_master_branch()
1772
master_branch.lock_write()
1774
# push into the master from this branch.
1775
self._basic_push(master_branch, overwrite, stop_revision)
1776
# and push into the target branch from this. Note that we push from
1777
# this branch again, because its considered the highest bandwidth
1779
result = self._basic_push(target, overwrite, stop_revision)
1780
result.master_branch = master_branch
1781
result.local_branch = target
1785
master_branch.unlock()
1788
result = self._basic_push(target, overwrite, stop_revision)
1789
# TODO: Why set master_branch and local_branch if there's no
1790
# binding? Maybe cleaner to just leave them unset? -- mbp
1792
result.master_branch = target
1793
result.local_branch = None
1797
def _basic_push(self, target, overwrite, stop_revision):
1798
"""Basic implementation of push without bound branches or hooks.
1800
Must be called with self read locked and target write locked.
1802
result = PushResult()
1803
result.source_branch = self
1804
result.target_branch = target
1805
result.old_revno, result.old_revid = target.last_revision_info()
1806
if result.old_revid != self.last_revision():
1807
# We assume that during 'push' this repository is closer than
1809
graph = self.repository.get_graph(target.repository)
1810
target.update_revisions(self, stop_revision, overwrite=overwrite,
1812
if self._push_should_merge_tags():
1813
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1814
result.new_revno, result.new_revid = target.last_revision_info()
1817
def _push_should_merge_tags(self):
1818
"""Should _basic_push merge this branch's tags into the target?
1820
The default implementation returns False if this branch has no tags,
1821
and True the rest of the time. Subclasses may override this.
1823
return self.tags.supports_tags() and self.tags.get_tag_dict()
1825
def get_parent(self):
1826
"""See Branch.get_parent."""
1827
parent = self._get_parent_location()
1830
# This is an old-format absolute path to a local branch
1831
# turn it into a url
1832
if parent.startswith('/'):
1833
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1835
return urlutils.join(self.base[:-1], parent)
1836
except errors.InvalidURLJoin, e:
1837
raise errors.InaccessibleParent(parent, self.base)
1839
def get_stacked_on_url(self):
1840
raise errors.UnstackableBranchFormat(self._format, self.base)
1042
def get_push_location(self):
1043
"""See Branch.get_push_location."""
1044
config = bzrlib.config.BranchConfig(self)
1045
push_loc = config.get_user_option('push_location')
1842
1048
def set_push_location(self, location):
1843
1049
"""See Branch.set_push_location."""
1844
self.get_config().set_user_option(
1845
'push_location', location,
1846
store=_mod_config.STORE_LOCATION_NORECURSE)
1050
config = bzrlib.config.LocationConfig(self.base)
1051
config.set_user_option('push_location', location)
1848
1053
@needs_write_lock
1849
1054
def set_parent(self, url):
1851
1056
# TODO: Maybe delete old location files?
1852
1057
# URLs should never be unicode, even on the local fs,
1853
1058
# FIXUP this and get_parent in a future branch format bump:
1854
# read and rewrite the file. RBC 20060125
1856
if isinstance(url, unicode):
1858
url = url.encode('ascii')
1859
except UnicodeEncodeError:
1860
raise errors.InvalidURL(url,
1861
"Urls must be 7-bit ascii, "
1862
"use bzrlib.urlutils.escape")
1863
url = urlutils.relative_url(self.base, url)
1864
self._set_parent_location(url)
1866
def _set_parent_location(self, url):
1868
self._transport.delete('parent')
1870
self._transport.put_bytes('parent', url + '\n',
1871
mode=self.bzrdir._get_file_mode())
1873
def set_stacked_on_url(self, url):
1874
raise errors.UnstackableBranchFormat(self._format, self.base)
1877
class BzrBranch5(BzrBranch):
1878
"""A format 5 branch. This supports new features over plain branches.
1880
It has support for a master_branch which is the data for bound branches.
1884
def pull(self, source, overwrite=False, stop_revision=None,
1885
run_hooks=True, possible_transports=None,
1886
_override_hook_target=None):
1887
"""Pull from source into self, updating my master if any.
1889
:param run_hooks: Private parameter - if false, this branch
1890
is being called because it's the master of the primary branch,
1891
so it should not run its hooks.
1893
bound_location = self.get_bound_location()
1894
master_branch = None
1895
if bound_location and source.base != bound_location:
1896
# not pulling from master, so we need to update master.
1897
master_branch = self.get_master_branch(possible_transports)
1898
master_branch.lock_write()
1901
# pull from source into master.
1902
master_branch.pull(source, overwrite, stop_revision,
1904
return super(BzrBranch5, self).pull(source, overwrite,
1905
stop_revision, _hook_master=master_branch,
1906
run_hooks=run_hooks,
1907
_override_hook_target=_override_hook_target)
1910
master_branch.unlock()
1912
def get_bound_location(self):
1914
return self._transport.get_bytes('bound')[:-1]
1915
except errors.NoSuchFile:
1919
def get_master_branch(self, possible_transports=None):
1920
"""Return the branch we are bound to.
1922
:return: Either a Branch, or None
1924
This could memoise the branch, but if thats done
1925
it must be revalidated on each new lock.
1926
So for now we just don't memoise it.
1927
# RBC 20060304 review this decision.
1929
bound_loc = self.get_bound_location()
1933
return Branch.open(bound_loc,
1934
possible_transports=possible_transports)
1935
except (errors.NotBranchError, errors.ConnectionError), e:
1936
raise errors.BoundBranchConnectionFailure(
1940
def set_bound_location(self, location):
1941
"""Set the target where this branch is bound to.
1943
:param location: URL to the target branch
1946
self._transport.put_bytes('bound', location+'\n',
1947
mode=self.bzrdir._get_file_mode())
1950
self._transport.delete('bound')
1951
except errors.NoSuchFile:
1956
def bind(self, other):
1957
"""Bind this branch to the branch other.
1959
This does not push or pull data between the branches, though it does
1960
check for divergence to raise an error when the branches are not
1961
either the same, or one a prefix of the other. That behaviour may not
1962
be useful, so that check may be removed in future.
1964
:param other: The branch to bind to
1967
# TODO: jam 20051230 Consider checking if the target is bound
1968
# It is debatable whether you should be able to bind to
1969
# a branch which is itself bound.
1970
# Committing is obviously forbidden,
1971
# but binding itself may not be.
1972
# Since we *have* to check at commit time, we don't
1973
# *need* to check here
1975
# we want to raise diverged if:
1976
# last_rev is not in the other_last_rev history, AND
1977
# other_last_rev is not in our history, and do it without pulling
1979
self.set_bound_location(other.base)
1983
"""If bound, unbind"""
1984
return self.set_bound_location(None)
1987
def update(self, possible_transports=None):
1988
"""Synchronise this branch with the master branch if any.
1990
:return: None or the last_revision that was pivoted out during the
1993
master = self.get_master_branch(possible_transports)
1994
if master is not None:
1995
old_tip = _mod_revision.ensure_null(self.last_revision())
1996
self.pull(master, overwrite=True)
1997
if self.repository.get_graph().is_ancestor(old_tip,
1998
_mod_revision.ensure_null(self.last_revision())):
2004
class BzrBranch7(BzrBranch5):
2005
"""A branch with support for a fallback repository."""
2007
def _get_fallback_repository(self, url):
2008
"""Get the repository we fallback to at url."""
2009
url = urlutils.join(self.base, url)
2010
return bzrdir.BzrDir.open(url).open_branch().repository
2012
def _activate_fallback_location(self, url):
2013
"""Activate the branch/repository from url as a fallback repository."""
2014
self.repository.add_fallback_repository(
2015
self._get_fallback_repository(url))
2017
def _open_hook(self):
2019
url = self.get_stacked_on_url()
2020
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2021
errors.UnstackableBranchFormat):
2024
self._activate_fallback_location(url)
2026
def _check_stackable_repo(self):
2027
if not self.repository._format.supports_external_lookups:
2028
raise errors.UnstackableRepositoryFormat(self.repository._format,
2029
self.repository.base)
2031
def __init__(self, *args, **kwargs):
2032
super(BzrBranch7, self).__init__(*args, **kwargs)
2033
self._last_revision_info_cache = None
2034
self._partial_revision_history_cache = []
2036
def _clear_cached_state(self):
2037
super(BzrBranch7, self)._clear_cached_state()
2038
self._last_revision_info_cache = None
2039
self._partial_revision_history_cache = []
2041
def _last_revision_info(self):
2042
revision_string = self._transport.get_bytes('last-revision')
2043
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2044
revision_id = cache_utf8.get_cached_utf8(revision_id)
2046
return revno, revision_id
2048
def _write_last_revision_info(self, revno, revision_id):
2049
"""Simply write out the revision id, with no checks.
2051
Use set_last_revision_info to perform this safely.
2053
Does not update the revision_history cache.
2054
Intended to be called by set_last_revision_info and
2055
_write_revision_history.
2057
revision_id = _mod_revision.ensure_null(revision_id)
2058
out_string = '%d %s\n' % (revno, revision_id)
2059
self._transport.put_bytes('last-revision', out_string,
2060
mode=self.bzrdir._get_file_mode())
2063
def set_last_revision_info(self, revno, revision_id):
2064
revision_id = _mod_revision.ensure_null(revision_id)
2065
old_revno, old_revid = self.last_revision_info()
2066
if self._get_append_revisions_only():
2067
self._check_history_violation(revision_id)
2068
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2069
self._write_last_revision_info(revno, revision_id)
2070
self._clear_cached_state()
2071
self._last_revision_info_cache = revno, revision_id
2072
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2074
def _check_history_violation(self, revision_id):
2075
last_revision = _mod_revision.ensure_null(self.last_revision())
2076
if _mod_revision.is_null(last_revision):
2078
if last_revision not in self._lefthand_history(revision_id):
2079
raise errors.AppendRevisionsOnlyViolation(self.base)
2081
def _gen_revision_history(self):
2082
"""Generate the revision history from last revision
2084
last_revno, last_revision = self.last_revision_info()
2085
self._extend_partial_history(stop_index=last_revno-1)
2086
return list(reversed(self._partial_revision_history_cache))
2088
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2089
"""Extend the partial history to include a given index
2091
If a stop_index is supplied, stop when that index has been reached.
2092
If a stop_revision is supplied, stop when that revision is
2093
encountered. Otherwise, stop when the beginning of history is
2096
:param stop_index: The index which should be present. When it is
2097
present, history extension will stop.
2098
:param revision_id: The revision id which should be present. When
2099
it is encountered, history extension will stop.
2101
repo = self.repository
2102
if len(self._partial_revision_history_cache) == 0:
2103
iterator = repo.iter_reverse_revision_history(self.last_revision())
2105
start_revision = self._partial_revision_history_cache[-1]
2106
iterator = repo.iter_reverse_revision_history(start_revision)
2107
#skip the last revision in the list
2108
next_revision = iterator.next()
2109
for revision_id in iterator:
2110
self._partial_revision_history_cache.append(revision_id)
2111
if (stop_index is not None and
2112
len(self._partial_revision_history_cache) > stop_index):
2114
if revision_id == stop_revision:
2117
def _write_revision_history(self, history):
2118
"""Factored out of set_revision_history.
2120
This performs the actual writing to disk, with format-specific checks.
2121
It is intended to be called by BzrBranch5.set_revision_history.
2123
if len(history) == 0:
2124
last_revision = 'null:'
2126
if history != self._lefthand_history(history[-1]):
2127
raise errors.NotLefthandHistory(history)
2128
last_revision = history[-1]
2129
if self._get_append_revisions_only():
2130
self._check_history_violation(last_revision)
2131
self._write_last_revision_info(len(history), last_revision)
2134
def _set_parent_location(self, url):
2135
"""Set the parent branch"""
2136
self._set_config_location('parent_location', url, make_relative=True)
2139
def _get_parent_location(self):
2140
"""Set the parent branch"""
2141
return self._get_config_location('parent_location')
2143
def set_push_location(self, location):
2144
"""See Branch.set_push_location."""
2145
self._set_config_location('push_location', location)
2147
def set_bound_location(self, location):
2148
"""See Branch.set_push_location."""
2150
config = self.get_config()
2151
if location is None:
2152
if config.get_user_option('bound') != 'True':
2155
config.set_user_option('bound', 'False', warn_masked=True)
2158
self._set_config_location('bound_location', location,
2160
config.set_user_option('bound', 'True', warn_masked=True)
2163
def _get_bound_location(self, bound):
2164
"""Return the bound location in the config file.
2166
Return None if the bound parameter does not match"""
2167
config = self.get_config()
2168
config_bound = (config.get_user_option('bound') == 'True')
2169
if config_bound != bound:
2171
return self._get_config_location('bound_location', config=config)
2173
def get_bound_location(self):
2174
"""See Branch.set_push_location."""
2175
return self._get_bound_location(True)
2177
def get_old_bound_location(self):
2178
"""See Branch.get_old_bound_location"""
2179
return self._get_bound_location(False)
2181
def get_stacked_on_url(self):
2182
# you can always ask for the URL; but you might not be able to use it
2183
# if the repo can't support stacking.
2184
## self._check_stackable_repo()
2185
stacked_url = self._get_config_location('stacked_on_location')
2186
if stacked_url is None:
2187
raise errors.NotStacked(self)
2190
def set_append_revisions_only(self, enabled):
2195
self.get_config().set_user_option('append_revisions_only', value,
2198
def set_stacked_on_url(self, url):
2199
self._check_stackable_repo()
2202
old_url = self.get_stacked_on_url()
2203
except (errors.NotStacked, errors.UnstackableBranchFormat,
2204
errors.UnstackableRepositoryFormat):
2207
# repositories don't offer an interface to remove fallback
2208
# repositories today; take the conceptually simpler option and just
2210
self.repository = self.bzrdir.find_repository()
2211
# for every revision reference the branch has, ensure it is pulled
2213
source_repository = self._get_fallback_repository(old_url)
2214
for revision_id in chain([self.last_revision()],
2215
self.tags.get_reverse_tag_dict()):
2216
self.repository.fetch(source_repository, revision_id,
2219
self._activate_fallback_location(url)
2220
# write this out after the repository is stacked to avoid setting a
2221
# stacked config that doesn't work.
2222
self._set_config_location('stacked_on_location', url)
2224
def _get_append_revisions_only(self):
2225
value = self.get_config().get_user_option('append_revisions_only')
2226
return value == 'True'
2228
def _synchronize_history(self, destination, revision_id):
2229
"""Synchronize last revision and revision history between branches.
2231
This version is most efficient when the destination is also a
2232
BzrBranch6, but works for BzrBranch5, as long as the destination's
2233
repository contains all the lefthand ancestors of the intended
2234
last_revision. If not, set_last_revision_info will fail.
2236
:param destination: The branch to copy the history into
2237
:param revision_id: The revision-id to truncate history at. May
2238
be None to copy complete history.
2240
source_revno, source_revision_id = self.last_revision_info()
1059
# read and rewrite the file, and have the new format code read
1060
# using .get not .get_utf8. RBC 20060125
1061
self.control_files.put_utf8('parent', url + '\n')
1063
def tree_config(self):
1064
return TreeConfig(self)
1066
def _get_truncated_history(self, revision_id):
1067
history = self.revision_history()
2241
1068
if revision_id is None:
2242
revno, revision_id = source_revno, source_revision_id
2243
elif source_revision_id == revision_id:
2244
# we know the revno without needing to walk all of history
2245
revno = source_revno
2247
# To figure out the revno for a random revision, we need to build
2248
# the revision history, and count its length.
2249
# We don't care about the order, just how long it is.
2250
# Alternatively, we could start at the current location, and count
2251
# backwards. But there is no guarantee that we will find it since
2252
# it may be a merged revision.
2253
revno = len(list(self.repository.iter_reverse_revision_history(
2255
destination.set_last_revision_info(revno, revision_id)
2257
def _make_tags(self):
2258
return BasicTags(self)
2261
def generate_revision_history(self, revision_id, last_rev=None,
2263
"""See BzrBranch5.generate_revision_history"""
2264
history = self._lefthand_history(revision_id, last_rev, other_branch)
2265
revno = len(history)
2266
self.set_last_revision_info(revno, revision_id)
2269
def get_rev_id(self, revno, history=None):
2270
"""Find the revision id of the specified revno."""
2272
return _mod_revision.NULL_REVISION
2274
last_revno, last_revision_id = self.last_revision_info()
2275
if revno <= 0 or revno > last_revno:
2276
raise errors.NoSuchRevision(self, revno)
2278
if history is not None:
2279
return history[revno - 1]
2281
index = last_revno - revno
2282
if len(self._partial_revision_history_cache) <= index:
2283
self._extend_partial_history(stop_index=index)
2284
if len(self._partial_revision_history_cache) > index:
2285
return self._partial_revision_history_cache[index]
2287
raise errors.NoSuchRevision(self, revno)
2290
def revision_id_to_revno(self, revision_id):
2291
"""Given a revision id, return its revno"""
2292
if _mod_revision.is_null(revision_id):
2295
index = self._partial_revision_history_cache.index(revision_id)
1071
idx = history.index(revision_id)
2296
1072
except ValueError:
2297
self._extend_partial_history(stop_revision=revision_id)
2298
index = len(self._partial_revision_history_cache) - 1
2299
if self._partial_revision_history_cache[index] != revision_id:
2300
raise errors.NoSuchRevision(self, revision_id)
2301
return self.revno() - index
2304
class BzrBranch6(BzrBranch7):
2305
"""See BzrBranchFormat6 for the capabilities of this branch.
2307
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2311
def get_stacked_on_url(self):
2312
raise errors.UnstackableBranchFormat(self._format, self.base)
2314
def set_stacked_on_url(self, url):
2315
raise errors.UnstackableBranchFormat(self._format, self.base)
2318
######################################################################
2319
# results of operations
2322
class _Result(object):
2324
def _show_tag_conficts(self, to_file):
2325
if not getattr(self, 'tag_conflicts', None):
2327
to_file.write('Conflicting tags:\n')
2328
for name, value1, value2 in self.tag_conflicts:
2329
to_file.write(' %s\n' % (name, ))
2332
class PullResult(_Result):
2333
"""Result of a Branch.pull operation.
2335
:ivar old_revno: Revision number before pull.
2336
:ivar new_revno: Revision number after pull.
2337
:ivar old_revid: Tip revision id before pull.
2338
:ivar new_revid: Tip revision id after pull.
2339
:ivar source_branch: Source (local) branch object.
2340
:ivar master_branch: Master branch of the target, or the target if no
2342
:ivar local_branch: target branch if there is a Master, else None
2343
:ivar target_branch: Target/destination branch object.
2344
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2348
# DEPRECATED: pull used to return the change in revno
2349
return self.new_revno - self.old_revno
2351
def report(self, to_file):
2353
if self.old_revid == self.new_revid:
2354
to_file.write('No revisions to pull.\n')
2356
to_file.write('Now on revision %d.\n' % self.new_revno)
2357
self._show_tag_conficts(to_file)
2360
class PushResult(_Result):
2361
"""Result of a Branch.push operation.
2363
:ivar old_revno: Revision number before push.
2364
:ivar new_revno: Revision number after push.
2365
:ivar old_revid: Tip revision id before push.
2366
:ivar new_revid: Tip revision id after push.
2367
:ivar source_branch: Source branch object.
2368
:ivar master_branch: Master branch of the target, or None.
2369
:ivar target_branch: Target/destination branch object.
2373
# DEPRECATED: push used to return the change in revno
2374
return self.new_revno - self.old_revno
2376
def report(self, to_file):
2377
"""Write a human-readable description of the result."""
2378
if self.old_revid == self.new_revid:
2379
to_file.write('No new revisions to push.\n')
2381
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2382
self._show_tag_conficts(to_file)
2385
class BranchCheckResult(object):
2386
"""Results of checking branch consistency.
2391
def __init__(self, branch):
2392
self.branch = branch
2394
def report_results(self, verbose):
2395
"""Report the check results via trace.note.
2397
:param verbose: Requests more detailed display of what was checked,
2400
note('checked branch %s format %s',
2402
self.branch._format)
2405
class Converter5to6(object):
2406
"""Perform an in-place upgrade of format 5 to format 6"""
2408
def convert(self, branch):
2409
# Data for 5 and 6 can peacefully coexist.
2410
format = BzrBranchFormat6()
2411
new_branch = format.open(branch.bzrdir, _found=True)
2413
# Copy source data into target
2414
new_branch._write_last_revision_info(*branch.last_revision_info())
2415
new_branch.set_parent(branch.get_parent())
2416
new_branch.set_bound_location(branch.get_bound_location())
2417
new_branch.set_push_location(branch.get_push_location())
2419
# New branch has no tags by default
2420
new_branch.tags._set_tag_dict({})
2422
# Copying done; now update target format
2423
new_branch._transport.put_bytes('format',
2424
format.get_format_string(),
2425
mode=new_branch.bzrdir._get_file_mode())
2427
# Clean up old files
2428
new_branch._transport.delete('revision-history')
2430
branch.set_parent(None)
2431
except errors.NoSuchFile:
2433
branch.set_bound_location(None)
2436
class Converter6to7(object):
2437
"""Perform an in-place upgrade of format 6 to format 7"""
2439
def convert(self, branch):
2440
format = BzrBranchFormat7()
2441
branch._set_config_location('stacked_on_location', '')
2442
# update target format
2443
branch._transport.put_bytes('format', format.get_format_string())
2447
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2448
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2451
_run_with_write_locked_target will attempt to release the lock it acquires.
2453
If an exception is raised by callable, then that exception *will* be
2454
propagated, even if the unlock attempt raises its own error. Thus
2455
_run_with_write_locked_target should be preferred to simply doing::
2459
return callable(*args, **kwargs)
1073
raise InvalidRevisionId(revision_id=revision, branch=self)
1074
return history[:idx+1]
1077
def _clone_weave(self, to_location, revision=None, basis_branch=None):
1079
from bzrlib.workingtree import WorkingTree
1080
assert isinstance(to_location, basestring)
1081
if basis_branch is not None:
1082
note("basis_branch is not supported for fast weave copy yet.")
1084
history = self._get_truncated_history(revision)
1085
if not bzrlib.osutils.lexists(to_location):
1086
os.mkdir(to_location)
1087
bzrdir_to = self.bzrdir._format.initialize(to_location)
1088
self.repository.clone(bzrdir_to)
1089
branch_to = bzrdir_to.create_branch()
1090
mutter("copy branch from %s to %s", self, branch_to)
1092
# FIXME duplicate code with base .clone().
1093
# .. would template method be useful here? RBC 20051207
1094
branch_to.set_parent(self.base)
1095
branch_to.append_revision(*history)
1096
WorkingTree.create(branch_to, branch_to.base)
1101
class BranchTestProviderAdapter(object):
1102
"""A tool to generate a suite testing multiple branch formats at once.
1104
This is done by copying the test once for each transport and injecting
1105
the transport_server, transport_readonly_server, and branch_format
1106
classes into each copy. Each copy is also given a new id() to make it
1110
def __init__(self, transport_server, transport_readonly_server, formats):
1111
self._transport_server = transport_server
1112
self._transport_readonly_server = transport_readonly_server
1113
self._formats = formats
2464
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2465
# should share code?
2468
result = callable(*args, **kwargs)
2470
exc_info = sys.exc_info()
2474
raise exc_info[0], exc_info[1], exc_info[2]
1115
def adapt(self, test):
1116
result = TestSuite()
1117
for branch_format, bzrdir_format in self._formats:
1118
new_test = deepcopy(test)
1119
new_test.transport_server = self._transport_server
1120
new_test.transport_readonly_server = self._transport_readonly_server
1121
new_test.bzrdir_format = bzrdir_format
1122
new_test.branch_format = branch_format
1123
def make_new_test_id():
1124
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1125
return lambda: new_id
1126
new_test.id = make_new_test_id()
1127
result.addTest(new_test)
1131
######################################################################
1135
@deprecated_function(zero_eight)
1136
def ScratchBranch(*args, **kwargs):
1137
"""See bzrlib.bzrdir.ScratchDir."""
1138
d = ScratchDir(*args, **kwargs)
1139
return d.open_branch()
1142
@deprecated_function(zero_eight)
1143
def is_control_file(*args, **kwargs):
1144
"""See bzrlib.workingtree.is_control_file."""
1145
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
