1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from itertools import chain
26
config as _mod_config,
32
revision as _mod_revision,
38
from bzrlib.config import BranchConfig
39
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
40
from bzrlib.tag import (
46
from bzrlib.decorators import needs_read_lock, needs_write_lock
47
from bzrlib.hooks import Hooks
48
from bzrlib.symbol_versioning import (
52
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
55
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
56
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
57
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
60
# TODO: Maybe include checks for common corruption of newlines, etc?
62
# TODO: Some operations like log might retrieve the same revisions
63
# repeatedly to calculate deltas. We could perhaps have a weakref
64
# cache in memory to make this faster. In general anything can be
65
# cached in memory between lock and unlock operations. .. nb thats
66
# what the transaction identity map provides
69
######################################################################
73
"""Branch holding a history of revisions.
76
Base directory/url of the branch.
78
hooks: An instance of BranchHooks.
80
# this is really an instance variable - FIXME move it there
84
# override this to set the strategy for storing tags
86
return DisabledTags(self)
88
def __init__(self, *ignored, **ignored_too):
89
self.tags = self._make_tags()
90
self._revision_history_cache = None
91
self._revision_id_to_revno_cache = None
92
self._partial_revision_id_to_revno_cache = {}
93
self._last_revision_info_cache = None
95
hooks = Branch.hooks['open']
100
"""Called by init to allow simpler extension of the base class."""
102
def break_lock(self):
103
"""Break a lock if one is present from another instance.
105
Uses the ui factory to ask for confirmation if the lock may be from
108
This will probe the repository for its lock as well.
110
self.control_files.break_lock()
111
self.repository.break_lock()
112
master = self.get_master_branch()
113
if master is not None:
117
def open(base, _unsupported=False, possible_transports=None):
118
"""Open the branch rooted at base.
120
For instance, if the branch is at URL/.bzr/branch,
121
Branch.open(URL) -> a Branch instance.
123
control = bzrdir.BzrDir.open(base, _unsupported,
124
possible_transports=possible_transports)
125
return control.open_branch(_unsupported)
128
def open_from_transport(transport, _unsupported=False):
129
"""Open the branch rooted at transport"""
130
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
131
return control.open_branch(_unsupported)
134
def open_containing(url, possible_transports=None):
135
"""Open an existing branch which contains url.
137
This probes for a branch at url, and searches upwards from there.
139
Basically we keep looking up until we find the control directory or
140
run into the root. If there isn't one, raises NotBranchError.
141
If there is one and it is either an unrecognised format or an unsupported
142
format, UnknownFormatError or UnsupportedFormatError are raised.
143
If there is one, it is returned, along with the unused portion of url.
145
control, relpath = bzrdir.BzrDir.open_containing(url,
147
return control.open_branch(), relpath
149
def get_config(self):
150
return BranchConfig(self)
152
def _get_nick(self, local=False, possible_transports=None):
153
config = self.get_config()
154
# explicit overrides master, but don't look for master if local is True
155
if not local and not config.has_explicit_nickname():
157
master = self.get_master_branch(possible_transports)
158
if master is not None:
159
# return the master branch value
161
except errors.BzrError, e:
162
# Silently fall back to local implicit nick if the master is
164
mutter("Could not connect to bound branch, "
165
"falling back to local nick.\n " + str(e))
166
return config.get_nickname()
168
def _set_nick(self, nick):
169
self.get_config().set_user_option('nickname', nick, warn_masked=True)
171
nick = property(_get_nick, _set_nick)
174
raise NotImplementedError(self.is_locked)
176
def lock_write(self):
177
raise NotImplementedError(self.lock_write)
180
raise NotImplementedError(self.lock_read)
183
raise NotImplementedError(self.unlock)
185
def peek_lock_mode(self):
186
"""Return lock mode for the Branch: 'r', 'w' or None"""
187
raise NotImplementedError(self.peek_lock_mode)
189
def get_physical_lock_status(self):
190
raise NotImplementedError(self.get_physical_lock_status)
193
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
194
"""Return the revision_id for a dotted revno.
196
:param revno: a tuple like (1,) or (1,1,2)
197
:param _cache_reverse: a private parameter enabling storage
198
of the reverse mapping in a top level cache. (This should
199
only be done in selective circumstances as we want to
200
avoid having the mapping cached multiple times.)
201
:return: the revision_id
202
:raises errors.NoSuchRevision: if the revno doesn't exist
204
rev_id = self._do_dotted_revno_to_revision_id(revno)
206
self._partial_revision_id_to_revno_cache[rev_id] = revno
209
def _do_dotted_revno_to_revision_id(self, revno):
210
"""Worker function for dotted_revno_to_revision_id.
212
Subclasses should override this if they wish to
213
provide a more efficient implementation.
216
return self.get_rev_id(revno[0])
217
revision_id_to_revno = self.get_revision_id_to_revno_map()
218
revision_ids = [revision_id for revision_id, this_revno
219
in revision_id_to_revno.iteritems()
220
if revno == this_revno]
221
if len(revision_ids) == 1:
222
return revision_ids[0]
224
revno_str = '.'.join(map(str, revno))
225
raise errors.NoSuchRevision(self, revno_str)
228
def revision_id_to_dotted_revno(self, revision_id):
229
"""Given a revision id, return its dotted revno.
231
:return: a tuple like (1,) or (400,1,3).
233
return self._do_revision_id_to_dotted_revno(revision_id)
235
def _do_revision_id_to_dotted_revno(self, revision_id):
236
"""Worker function for revision_id_to_revno."""
237
# Try the caches if they are loaded
238
result = self._partial_revision_id_to_revno_cache.get(revision_id)
239
if result is not None:
241
if self._revision_id_to_revno_cache:
242
result = self._revision_id_to_revno_cache.get(revision_id)
244
raise errors.NoSuchRevision(self, revision_id)
245
# Try the mainline as it's optimised
247
revno = self.revision_id_to_revno(revision_id)
249
except errors.NoSuchRevision:
250
# We need to load and use the full revno map after all
251
result = self.get_revision_id_to_revno_map().get(revision_id)
253
raise errors.NoSuchRevision(self, revision_id)
257
def get_revision_id_to_revno_map(self):
258
"""Return the revision_id => dotted revno map.
260
This will be regenerated on demand, but will be cached.
262
:return: A dictionary mapping revision_id => dotted revno.
263
This dictionary should not be modified by the caller.
265
if self._revision_id_to_revno_cache is not None:
266
mapping = self._revision_id_to_revno_cache
268
mapping = self._gen_revno_map()
269
self._cache_revision_id_to_revno(mapping)
270
# TODO: jam 20070417 Since this is being cached, should we be returning
272
# I would rather not, and instead just declare that users should not
273
# modify the return value.
276
def _gen_revno_map(self):
277
"""Create a new mapping from revision ids to dotted revnos.
279
Dotted revnos are generated based on the current tip in the revision
281
This is the worker function for get_revision_id_to_revno_map, which
282
just caches the return value.
284
:return: A dictionary mapping revision_id => dotted revno.
286
last_revision = self.last_revision()
287
revision_graph = repository._old_get_graph(self.repository,
289
merge_sorted_revisions = tsort.merge_sort(
294
revision_id_to_revno = dict((rev_id, revno)
295
for seq_num, rev_id, depth, revno, end_of_merge
296
in merge_sorted_revisions)
297
return revision_id_to_revno
299
def leave_lock_in_place(self):
300
"""Tell this branch object not to release the physical lock when this
303
If lock_write doesn't return a token, then this method is not supported.
305
self.control_files.leave_in_place()
307
def dont_leave_lock_in_place(self):
308
"""Tell this branch object to release the physical lock when this
309
object is unlocked, even if it didn't originally acquire it.
311
If lock_write doesn't return a token, then this method is not supported.
313
self.control_files.dont_leave_in_place()
315
def bind(self, other):
316
"""Bind the local branch the other branch.
318
:param other: The branch to bind to
321
raise errors.UpgradeRequired(self.base)
324
def fetch(self, from_branch, last_revision=None, pb=None):
325
"""Copy revisions from from_branch into this branch.
327
:param from_branch: Where to copy from.
328
:param last_revision: What revision to stop at (None for at the end
330
:param pb: An optional progress bar to use.
332
Returns the copied revision count and the failed revisions in a tuple:
335
if self.base == from_branch.base:
338
nested_pb = ui.ui_factory.nested_progress_bar()
343
from_branch.lock_read()
345
if last_revision is None:
346
pb.update('get source history')
347
last_revision = from_branch.last_revision()
348
last_revision = _mod_revision.ensure_null(last_revision)
349
return self.repository.fetch(from_branch.repository,
350
revision_id=last_revision,
353
if nested_pb is not None:
357
def get_bound_location(self):
358
"""Return the URL of the branch we are bound to.
360
Older format branches cannot bind, please be sure to use a metadir
365
def get_old_bound_location(self):
366
"""Return the URL of the branch we used to be bound to
368
raise errors.UpgradeRequired(self.base)
370
def get_commit_builder(self, parents, config=None, timestamp=None,
371
timezone=None, committer=None, revprops=None,
373
"""Obtain a CommitBuilder for this branch.
375
:param parents: Revision ids of the parents of the new revision.
376
:param config: Optional configuration to use.
377
:param timestamp: Optional timestamp recorded for commit.
378
:param timezone: Optional timezone for timestamp.
379
:param committer: Optional committer to set for commit.
380
:param revprops: Optional dictionary of revision properties.
381
:param revision_id: Optional revision id.
385
config = self.get_config()
387
return self.repository.get_commit_builder(self, parents, config,
388
timestamp, timezone, committer, revprops, revision_id)
390
def get_master_branch(self, possible_transports=None):
391
"""Return the branch we are bound to.
393
:return: Either a Branch, or None
397
def get_revision_delta(self, revno):
398
"""Return the delta for one revision.
400
The delta is relative to its mainline predecessor, or the
401
empty tree for revision 1.
403
rh = self.revision_history()
404
if not (1 <= revno <= len(rh)):
405
raise errors.InvalidRevisionNumber(revno)
406
return self.repository.get_revision_delta(rh[revno-1])
408
def get_stacked_on_url(self):
409
"""Get the URL this branch is stacked against.
411
:raises NotStacked: If the branch is not stacked.
412
:raises UnstackableBranchFormat: If the branch does not support
415
raise NotImplementedError(self.get_stacked_on_url)
417
def print_file(self, file, revision_id):
418
"""Print `file` to stdout."""
419
raise NotImplementedError(self.print_file)
421
def set_revision_history(self, rev_history):
422
raise NotImplementedError(self.set_revision_history)
424
def set_stacked_on_url(self, url):
425
"""Set the URL this branch is stacked against.
427
:raises UnstackableBranchFormat: If the branch does not support
429
:raises UnstackableRepositoryFormat: If the repository does not support
432
raise NotImplementedError(self.set_stacked_on_url)
434
def _cache_revision_history(self, rev_history):
435
"""Set the cached revision history to rev_history.
437
The revision_history method will use this cache to avoid regenerating
438
the revision history.
440
This API is semi-public; it only for use by subclasses, all other code
441
should consider it to be private.
443
self._revision_history_cache = rev_history
445
def _cache_revision_id_to_revno(self, revision_id_to_revno):
446
"""Set the cached revision_id => revno map to revision_id_to_revno.
448
This API is semi-public; it only for use by subclasses, all other code
449
should consider it to be private.
451
self._revision_id_to_revno_cache = revision_id_to_revno
453
def _clear_cached_state(self):
454
"""Clear any cached data on this branch, e.g. cached revision history.
456
This means the next call to revision_history will need to call
457
_gen_revision_history.
459
This API is semi-public; it only for use by subclasses, all other code
460
should consider it to be private.
462
self._revision_history_cache = None
463
self._revision_id_to_revno_cache = None
464
self._last_revision_info_cache = None
466
def _gen_revision_history(self):
467
"""Return sequence of revision hashes on to this branch.
469
Unlike revision_history, this method always regenerates or rereads the
470
revision history, i.e. it does not cache the result, so repeated calls
473
Concrete subclasses should override this instead of revision_history so
474
that subclasses do not need to deal with caching logic.
476
This API is semi-public; it only for use by subclasses, all other code
477
should consider it to be private.
479
raise NotImplementedError(self._gen_revision_history)
482
def revision_history(self):
483
"""Return sequence of revision ids on this branch.
485
This method will cache the revision history for as long as it is safe to
488
if 'evil' in debug.debug_flags:
489
mutter_callsite(3, "revision_history scales with history.")
490
if self._revision_history_cache is not None:
491
history = self._revision_history_cache
493
history = self._gen_revision_history()
494
self._cache_revision_history(history)
498
"""Return current revision number for this branch.
500
That is equivalent to the number of revisions committed to
503
return self.last_revision_info()[0]
506
"""Older format branches cannot bind or unbind."""
507
raise errors.UpgradeRequired(self.base)
509
def set_append_revisions_only(self, enabled):
510
"""Older format branches are never restricted to append-only"""
511
raise errors.UpgradeRequired(self.base)
513
def last_revision(self):
514
"""Return last revision id, or NULL_REVISION."""
515
return self.last_revision_info()[1]
518
def last_revision_info(self):
519
"""Return information about the last revision.
521
:return: A tuple (revno, revision_id).
523
if self._last_revision_info_cache is None:
524
self._last_revision_info_cache = self._last_revision_info()
525
return self._last_revision_info_cache
527
def _last_revision_info(self):
528
rh = self.revision_history()
531
return (revno, rh[-1])
533
return (0, _mod_revision.NULL_REVISION)
535
@deprecated_method(deprecated_in((1, 6, 0)))
536
def missing_revisions(self, other, stop_revision=None):
537
"""Return a list of new revisions that would perfectly fit.
539
If self and other have not diverged, return a list of the revisions
540
present in other, but missing from self.
542
self_history = self.revision_history()
543
self_len = len(self_history)
544
other_history = other.revision_history()
545
other_len = len(other_history)
546
common_index = min(self_len, other_len) -1
547
if common_index >= 0 and \
548
self_history[common_index] != other_history[common_index]:
549
raise errors.DivergedBranches(self, other)
551
if stop_revision is None:
552
stop_revision = other_len
554
if stop_revision > other_len:
555
raise errors.NoSuchRevision(self, stop_revision)
556
return other_history[self_len:stop_revision]
559
def update_revisions(self, other, stop_revision=None, overwrite=False,
561
"""Pull in new perfect-fit revisions.
563
:param other: Another Branch to pull from
564
:param stop_revision: Updated until the given revision
565
:param overwrite: Always set the branch pointer, rather than checking
566
to see if it is a proper descendant.
567
:param graph: A Graph object that can be used to query history
568
information. This can be None.
573
other_revno, other_last_revision = other.last_revision_info()
574
stop_revno = None # unknown
575
if stop_revision is None:
576
stop_revision = other_last_revision
577
if _mod_revision.is_null(stop_revision):
578
# if there are no commits, we're done.
580
stop_revno = other_revno
582
# what's the current last revision, before we fetch [and change it
584
last_rev = _mod_revision.ensure_null(self.last_revision())
585
# we fetch here so that we don't process data twice in the common
586
# case of having something to pull, and so that the check for
587
# already merged can operate on the just fetched graph, which will
588
# be cached in memory.
589
self.fetch(other, stop_revision)
590
# Check to see if one is an ancestor of the other
593
graph = self.repository.get_graph()
594
if self._check_if_descendant_or_diverged(
595
stop_revision, last_rev, graph, other):
596
# stop_revision is a descendant of last_rev, but we aren't
597
# overwriting, so we're done.
599
if stop_revno is None:
601
graph = self.repository.get_graph()
602
this_revno, this_last_revision = self.last_revision_info()
603
stop_revno = graph.find_distance_to_null(stop_revision,
604
[(other_last_revision, other_revno),
605
(this_last_revision, this_revno)])
606
self.set_last_revision_info(stop_revno, stop_revision)
610
def revision_id_to_revno(self, revision_id):
611
"""Given a revision id, return its revno"""
612
if _mod_revision.is_null(revision_id):
614
history = self.revision_history()
616
return history.index(revision_id) + 1
618
raise errors.NoSuchRevision(self, revision_id)
620
def get_rev_id(self, revno, history=None):
621
"""Find the revision id of the specified revno."""
623
return _mod_revision.NULL_REVISION
625
history = self.revision_history()
626
if revno <= 0 or revno > len(history):
627
raise errors.NoSuchRevision(self, revno)
628
return history[revno - 1]
630
def pull(self, source, overwrite=False, stop_revision=None,
631
possible_transports=None, _override_hook_target=None):
632
"""Mirror source into this branch.
634
This branch is considered to be 'local', having low latency.
636
:returns: PullResult instance
638
raise NotImplementedError(self.pull)
640
def push(self, target, overwrite=False, stop_revision=None):
641
"""Mirror this branch into target.
643
This branch is considered to be 'local', having low latency.
645
raise NotImplementedError(self.push)
647
def basis_tree(self):
648
"""Return `Tree` object for last revision."""
649
return self.repository.revision_tree(self.last_revision())
651
def get_parent(self):
652
"""Return the parent location of the branch.
654
This is the default location for push/pull/missing. The usual
655
pattern is that the user can override it by specifying a
658
raise NotImplementedError(self.get_parent)
660
def _set_config_location(self, name, url, config=None,
661
make_relative=False):
663
config = self.get_config()
667
url = urlutils.relative_url(self.base, url)
668
config.set_user_option(name, url, warn_masked=True)
670
def _get_config_location(self, name, config=None):
672
config = self.get_config()
673
location = config.get_user_option(name)
678
def get_submit_branch(self):
679
"""Return the submit location of the branch.
681
This is the default location for bundle. The usual
682
pattern is that the user can override it by specifying a
685
return self.get_config().get_user_option('submit_branch')
687
def set_submit_branch(self, location):
688
"""Return the submit location of the branch.
690
This is the default location for bundle. The usual
691
pattern is that the user can override it by specifying a
694
self.get_config().set_user_option('submit_branch', location,
697
def get_public_branch(self):
698
"""Return the public location of the branch.
700
This is is used by merge directives.
702
return self._get_config_location('public_branch')
704
def set_public_branch(self, location):
705
"""Return the submit location of the branch.
707
This is the default location for bundle. The usual
708
pattern is that the user can override it by specifying a
711
self._set_config_location('public_branch', location)
713
def get_push_location(self):
714
"""Return the None or the location to push this branch to."""
715
push_loc = self.get_config().get_user_option('push_location')
718
def set_push_location(self, location):
719
"""Set a new push location for this branch."""
720
raise NotImplementedError(self.set_push_location)
722
def set_parent(self, url):
723
raise NotImplementedError(self.set_parent)
727
"""Synchronise this branch with the master branch if any.
729
:return: None or the last_revision pivoted out during the update.
733
def check_revno(self, revno):
735
Check whether a revno corresponds to any revision.
736
Zero (the NULL revision) is considered valid.
739
self.check_real_revno(revno)
741
def check_real_revno(self, revno):
743
Check whether a revno corresponds to a real revision.
744
Zero (the NULL revision) is considered invalid
746
if revno < 1 or revno > self.revno():
747
raise errors.InvalidRevisionNumber(revno)
750
def clone(self, to_bzrdir, revision_id=None):
751
"""Clone this branch into to_bzrdir preserving all semantic values.
753
revision_id: if not None, the revision history in the new branch will
754
be truncated to end with revision_id.
756
result = to_bzrdir.create_branch()
757
self.copy_content_into(result, revision_id=revision_id)
761
def sprout(self, to_bzrdir, revision_id=None):
762
"""Create a new line of development from the branch, into to_bzrdir.
764
to_bzrdir controls the branch format.
766
revision_id: if not None, the revision history in the new branch will
767
be truncated to end with revision_id.
769
result = to_bzrdir.create_branch()
770
self.copy_content_into(result, revision_id=revision_id)
771
result.set_parent(self.bzrdir.root_transport.base)
774
def _synchronize_history(self, destination, revision_id):
775
"""Synchronize last revision and revision history between branches.
777
This version is most efficient when the destination is also a
778
BzrBranch6, but works for BzrBranch5, as long as the destination's
779
repository contains all the lefthand ancestors of the intended
780
last_revision. If not, set_last_revision_info will fail.
782
:param destination: The branch to copy the history into
783
:param revision_id: The revision-id to truncate history at. May
784
be None to copy complete history.
786
source_revno, source_revision_id = self.last_revision_info()
787
if revision_id is None:
788
revno, revision_id = source_revno, source_revision_id
789
elif source_revision_id == revision_id:
790
# we know the revno without needing to walk all of history
793
# To figure out the revno for a random revision, we need to build
794
# the revision history, and count its length.
795
# We don't care about the order, just how long it is.
796
# Alternatively, we could start at the current location, and count
797
# backwards. But there is no guarantee that we will find it since
798
# it may be a merged revision.
799
revno = len(list(self.repository.iter_reverse_revision_history(
801
destination.set_last_revision_info(revno, revision_id)
804
def copy_content_into(self, destination, revision_id=None):
805
"""Copy the content of self into destination.
807
revision_id: if not None, the revision history in the new branch will
808
be truncated to end with revision_id.
810
self._synchronize_history(destination, revision_id)
812
parent = self.get_parent()
813
except errors.InaccessibleParent, e:
814
mutter('parent was not accessible to copy: %s', e)
817
destination.set_parent(parent)
818
self.tags.merge_to(destination.tags)
822
"""Check consistency of the branch.
824
In particular this checks that revisions given in the revision-history
825
do actually match up in the revision graph, and that they're all
826
present in the repository.
828
Callers will typically also want to check the repository.
830
:return: A BranchCheckResult.
832
mainline_parent_id = None
833
last_revno, last_revision_id = self.last_revision_info()
834
real_rev_history = list(self.repository.iter_reverse_revision_history(
836
real_rev_history.reverse()
837
if len(real_rev_history) != last_revno:
838
raise errors.BzrCheckError('revno does not match len(mainline)'
839
' %s != %s' % (last_revno, len(real_rev_history)))
840
# TODO: We should probably also check that real_rev_history actually
841
# matches self.revision_history()
842
for revision_id in real_rev_history:
844
revision = self.repository.get_revision(revision_id)
845
except errors.NoSuchRevision, e:
846
raise errors.BzrCheckError("mainline revision {%s} not in repository"
848
# In general the first entry on the revision history has no parents.
849
# But it's not illegal for it to have parents listed; this can happen
850
# in imports from Arch when the parents weren't reachable.
851
if mainline_parent_id is not None:
852
if mainline_parent_id not in revision.parent_ids:
853
raise errors.BzrCheckError("previous revision {%s} not listed among "
855
% (mainline_parent_id, revision_id))
856
mainline_parent_id = revision_id
857
return BranchCheckResult(self)
859
def _get_checkout_format(self):
860
"""Return the most suitable metadir for a checkout of this branch.
861
Weaves are used if this branch's repository uses weaves.
863
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
864
from bzrlib.repofmt import weaverepo
865
format = bzrdir.BzrDirMetaFormat1()
866
format.repository_format = weaverepo.RepositoryFormat7()
868
format = self.repository.bzrdir.checkout_metadir()
869
format.set_branch_format(self._format)
872
def create_checkout(self, to_location, revision_id=None,
873
lightweight=False, accelerator_tree=None,
875
"""Create a checkout of a branch.
877
:param to_location: The url to produce the checkout at
878
:param revision_id: The revision to check out
879
:param lightweight: If True, produce a lightweight checkout, otherwise,
880
produce a bound branch (heavyweight checkout)
881
:param accelerator_tree: A tree which can be used for retrieving file
882
contents more quickly than the revision tree, i.e. a workingtree.
883
The revision tree will be used for cases where accelerator_tree's
884
content is different.
885
:param hardlink: If true, hard-link files from accelerator_tree,
887
:return: The tree of the created checkout
889
t = transport.get_transport(to_location)
892
format = self._get_checkout_format()
893
checkout = format.initialize_on_transport(t)
894
from_branch = BranchReferenceFormat().initialize(checkout, self)
896
format = self._get_checkout_format()
897
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
898
to_location, force_new_tree=False, format=format)
899
checkout = checkout_branch.bzrdir
900
checkout_branch.bind(self)
901
# pull up to the specified revision_id to set the initial
902
# branch tip correctly, and seed it with history.
903
checkout_branch.pull(self, stop_revision=revision_id)
905
tree = checkout.create_workingtree(revision_id,
906
from_branch=from_branch,
907
accelerator_tree=accelerator_tree,
909
basis_tree = tree.basis_tree()
910
basis_tree.lock_read()
912
for path, file_id in basis_tree.iter_references():
913
reference_parent = self.reference_parent(file_id, path)
914
reference_parent.create_checkout(tree.abspath(path),
915
basis_tree.get_reference_revision(file_id, path),
922
def reconcile(self, thorough=True):
923
"""Make sure the data stored in this branch is consistent."""
924
from bzrlib.reconcile import BranchReconciler
925
reconciler = BranchReconciler(self, thorough=thorough)
926
reconciler.reconcile()
929
def reference_parent(self, file_id, path):
930
"""Return the parent branch for a tree-reference file_id
931
:param file_id: The file_id of the tree reference
932
:param path: The path of the file_id in the tree
933
:return: A branch associated with the file_id
935
# FIXME should provide multiple branches, based on config
936
return Branch.open(self.bzrdir.root_transport.clone(path).base)
938
def supports_tags(self):
939
return self._format.supports_tags()
941
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
943
"""Ensure that revision_b is a descendant of revision_a.
945
This is a helper function for update_revisions.
947
:raises: DivergedBranches if revision_b has diverged from revision_a.
948
:returns: True if revision_b is a descendant of revision_a.
950
relation = self._revision_relations(revision_a, revision_b, graph)
951
if relation == 'b_descends_from_a':
953
elif relation == 'diverged':
954
raise errors.DivergedBranches(self, other_branch)
955
elif relation == 'a_descends_from_b':
958
raise AssertionError("invalid relation: %r" % (relation,))
960
def _revision_relations(self, revision_a, revision_b, graph):
961
"""Determine the relationship between two revisions.
963
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
965
heads = graph.heads([revision_a, revision_b])
966
if heads == set([revision_b]):
967
return 'b_descends_from_a'
968
elif heads == set([revision_a, revision_b]):
969
# These branches have diverged
971
elif heads == set([revision_a]):
972
return 'a_descends_from_b'
974
raise AssertionError("invalid heads: %r" % (heads,))
977
class BranchFormat(object):
978
"""An encapsulation of the initialization and open routines for a format.
980
Formats provide three things:
981
* An initialization routine,
985
Formats are placed in an dict by their format string for reference
986
during branch opening. Its not required that these be instances, they
987
can be classes themselves with class methods - it simply depends on
988
whether state is needed for a given format or not.
990
Once a format is deprecated, just deprecate the initialize and open
991
methods on the format class. Do not deprecate the object, as the
992
object will be created every time regardless.
995
_default_format = None
996
"""The default format used for new branches."""
999
"""The known formats."""
1001
def __eq__(self, other):
1002
return self.__class__ is other.__class__
1004
def __ne__(self, other):
1005
return not (self == other)
1008
def find_format(klass, a_bzrdir):
1009
"""Return the format for the branch object in a_bzrdir."""
1011
transport = a_bzrdir.get_branch_transport(None)
1012
format_string = transport.get("format").read()
1013
return klass._formats[format_string]
1014
except errors.NoSuchFile:
1015
raise errors.NotBranchError(path=transport.base)
1017
raise errors.UnknownFormatError(format=format_string, kind='branch')
1020
def get_default_format(klass):
1021
"""Return the current default format."""
1022
return klass._default_format
1024
def get_reference(self, a_bzrdir):
1025
"""Get the target reference of the branch in a_bzrdir.
1027
format probing must have been completed before calling
1028
this method - it is assumed that the format of the branch
1029
in a_bzrdir is correct.
1031
:param a_bzrdir: The bzrdir to get the branch data from.
1032
:return: None if the branch is not a reference branch.
1037
def set_reference(self, a_bzrdir, to_branch):
1038
"""Set the target reference of the branch in a_bzrdir.
1040
format probing must have been completed before calling
1041
this method - it is assumed that the format of the branch
1042
in a_bzrdir is correct.
1044
:param a_bzrdir: The bzrdir to set the branch reference for.
1045
:param to_branch: branch that the checkout is to reference
1047
raise NotImplementedError(self.set_reference)
1049
def get_format_string(self):
1050
"""Return the ASCII format string that identifies this format."""
1051
raise NotImplementedError(self.get_format_string)
1053
def get_format_description(self):
1054
"""Return the short format description for this format."""
1055
raise NotImplementedError(self.get_format_description)
1057
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1059
"""Initialize a branch in a bzrdir, with specified files
1061
:param a_bzrdir: The bzrdir to initialize the branch in
1062
:param utf8_files: The files to create as a list of
1063
(filename, content) tuples
1064
:param set_format: If True, set the format with
1065
self.get_format_string. (BzrBranch4 has its format set
1067
:return: a branch in this format
1069
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1070
branch_transport = a_bzrdir.get_branch_transport(self)
1072
'metadir': ('lock', lockdir.LockDir),
1073
'branch4': ('branch-lock', lockable_files.TransportLock),
1075
lock_name, lock_class = lock_map[lock_type]
1076
control_files = lockable_files.LockableFiles(branch_transport,
1077
lock_name, lock_class)
1078
control_files.create_lock()
1079
control_files.lock_write()
1081
utf8_files += [('format', self.get_format_string())]
1083
for (filename, content) in utf8_files:
1084
branch_transport.put_bytes(
1086
mode=a_bzrdir._get_file_mode())
1088
control_files.unlock()
1089
return self.open(a_bzrdir, _found=True)
1091
def initialize(self, a_bzrdir):
1092
"""Create a branch of this format in a_bzrdir."""
1093
raise NotImplementedError(self.initialize)
1095
def is_supported(self):
1096
"""Is this format supported?
1098
Supported formats can be initialized and opened.
1099
Unsupported formats may not support initialization or committing or
1100
some other features depending on the reason for not being supported.
1104
def open(self, a_bzrdir, _found=False):
1105
"""Return the branch object for a_bzrdir
1107
_found is a private parameter, do not use it. It is used to indicate
1108
if format probing has already be done.
1110
raise NotImplementedError(self.open)
1113
def register_format(klass, format):
1114
klass._formats[format.get_format_string()] = format
1117
def set_default_format(klass, format):
1118
klass._default_format = format
1120
def supports_stacking(self):
1121
"""True if this format records a stacked-on branch."""
1125
def unregister_format(klass, format):
1126
del klass._formats[format.get_format_string()]
1129
return self.get_format_string().rstrip()
1131
def supports_tags(self):
1132
"""True if this format supports tags stored in the branch"""
1133
return False # by default
1136
class BranchHooks(Hooks):
1137
"""A dictionary mapping hook name to a list of callables for branch hooks.
1139
e.g. ['set_rh'] Is the list of items to be called when the
1140
set_revision_history function is invoked.
1144
"""Create the default hooks.
1146
These are all empty initially, because by default nothing should get
1149
Hooks.__init__(self)
1150
# Introduced in 0.15:
1151
# invoked whenever the revision history has been set
1152
# with set_revision_history. The api signature is
1153
# (branch, revision_history), and the branch will
1156
# Invoked after a branch is opened. The api signature is (branch).
1158
# invoked after a push operation completes.
1159
# the api signature is
1161
# containing the members
1162
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1163
# where local is the local target branch or None, master is the target
1164
# master branch, and the rest should be self explanatory. The source
1165
# is read locked and the target branches write locked. Source will
1166
# be the local low-latency branch.
1167
self['post_push'] = []
1168
# invoked after a pull operation completes.
1169
# the api signature is
1171
# containing the members
1172
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1173
# where local is the local branch or None, master is the target
1174
# master branch, and the rest should be self explanatory. The source
1175
# is read locked and the target branches write locked. The local
1176
# branch is the low-latency branch.
1177
self['post_pull'] = []
1178
# invoked before a commit operation takes place.
1179
# the api signature is
1180
# (local, master, old_revno, old_revid, future_revno, future_revid,
1181
# tree_delta, future_tree).
1182
# old_revid is NULL_REVISION for the first commit to a branch
1183
# tree_delta is a TreeDelta object describing changes from the basis
1184
# revision, hooks MUST NOT modify this delta
1185
# future_tree is an in-memory tree obtained from
1186
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1187
self['pre_commit'] = []
1188
# invoked after a commit operation completes.
1189
# the api signature is
1190
# (local, master, old_revno, old_revid, new_revno, new_revid)
1191
# old_revid is NULL_REVISION for the first commit to a branch.
1192
self['post_commit'] = []
1193
# invoked after a uncommit operation completes.
1194
# the api signature is
1195
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1196
# local is the local branch or None, master is the target branch,
1197
# and an empty branch recieves new_revno of 0, new_revid of None.
1198
self['post_uncommit'] = []
1200
# Invoked before the tip of a branch changes.
1201
# the api signature is
1202
# (params) where params is a ChangeBranchTipParams with the members
1203
# (branch, old_revno, new_revno, old_revid, new_revid)
1204
self['pre_change_branch_tip'] = []
1206
# Invoked after the tip of a branch changes.
1207
# the api signature is
1208
# (params) where params is a ChangeBranchTipParams with the members
1209
# (branch, old_revno, new_revno, old_revid, new_revid)
1210
self['post_change_branch_tip'] = []
1212
# Invoked when a stacked branch activates its fallback locations and
1213
# allows the transformation of the url of said location.
1214
# the api signature is
1215
# (branch, url) where branch is the branch having its fallback
1216
# location activated and url is the url for the fallback location.
1217
# The hook should return a url.
1218
self['transform_fallback_location'] = []
1221
# install the default hooks into the Branch class.
1222
Branch.hooks = BranchHooks()
1225
class ChangeBranchTipParams(object):
1226
"""Object holding parameters passed to *_change_branch_tip hooks.
1228
There are 5 fields that hooks may wish to access:
1230
:ivar branch: the branch being changed
1231
:ivar old_revno: revision number before the change
1232
:ivar new_revno: revision number after the change
1233
:ivar old_revid: revision id before the change
1234
:ivar new_revid: revision id after the change
1236
The revid fields are strings. The revno fields are integers.
1239
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1240
"""Create a group of ChangeBranchTip parameters.
1242
:param branch: The branch being changed.
1243
:param old_revno: Revision number before the change.
1244
:param new_revno: Revision number after the change.
1245
:param old_revid: Tip revision id before the change.
1246
:param new_revid: Tip revision id after the change.
1248
self.branch = branch
1249
self.old_revno = old_revno
1250
self.new_revno = new_revno
1251
self.old_revid = old_revid
1252
self.new_revid = new_revid
1254
def __eq__(self, other):
1255
return self.__dict__ == other.__dict__
1258
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1259
self.__class__.__name__, self.branch,
1260
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1263
class BzrBranchFormat4(BranchFormat):
1264
"""Bzr branch format 4.
1267
- a revision-history file.
1268
- a branch-lock lock file [ to be shared with the bzrdir ]
1271
def get_format_description(self):
1272
"""See BranchFormat.get_format_description()."""
1273
return "Branch format 4"
1275
def initialize(self, a_bzrdir):
1276
"""Create a branch of this format in a_bzrdir."""
1277
utf8_files = [('revision-history', ''),
1278
('branch-name', ''),
1280
return self._initialize_helper(a_bzrdir, utf8_files,
1281
lock_type='branch4', set_format=False)
1284
super(BzrBranchFormat4, self).__init__()
1285
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1287
def open(self, a_bzrdir, _found=False):
1288
"""Return the branch object for a_bzrdir
1290
_found is a private parameter, do not use it. It is used to indicate
1291
if format probing has already be done.
1294
# we are being called directly and must probe.
1295
raise NotImplementedError
1296
return BzrBranch(_format=self,
1297
_control_files=a_bzrdir._control_files,
1299
_repository=a_bzrdir.open_repository())
1302
return "Bazaar-NG branch format 4"
1305
class BranchFormatMetadir(BranchFormat):
1306
"""Common logic for meta-dir based branch formats."""
1308
def _branch_class(self):
1309
"""What class to instantiate on open calls."""
1310
raise NotImplementedError(self._branch_class)
1312
def open(self, a_bzrdir, _found=False):
1313
"""Return the branch object for a_bzrdir.
1315
_found is a private parameter, do not use it. It is used to indicate
1316
if format probing has already be done.
1319
format = BranchFormat.find_format(a_bzrdir)
1320
if format.__class__ != self.__class__:
1321
raise AssertionError("wrong format %r found for %r" %
1324
transport = a_bzrdir.get_branch_transport(None)
1325
control_files = lockable_files.LockableFiles(transport, 'lock',
1327
return self._branch_class()(_format=self,
1328
_control_files=control_files,
1330
_repository=a_bzrdir.find_repository())
1331
except errors.NoSuchFile:
1332
raise errors.NotBranchError(path=transport.base)
1335
super(BranchFormatMetadir, self).__init__()
1336
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1337
self._matchingbzrdir.set_branch_format(self)
1339
def supports_tags(self):
1343
class BzrBranchFormat5(BranchFormatMetadir):
1344
"""Bzr branch format 5.
1347
- a revision-history file.
1349
- a lock dir guarding the branch itself
1350
- all of this stored in a branch/ subdirectory
1351
- works with shared repositories.
1353
This format is new in bzr 0.8.
1356
def _branch_class(self):
1359
def get_format_string(self):
1360
"""See BranchFormat.get_format_string()."""
1361
return "Bazaar-NG branch format 5\n"
1363
def get_format_description(self):
1364
"""See BranchFormat.get_format_description()."""
1365
return "Branch format 5"
1367
def initialize(self, a_bzrdir):
1368
"""Create a branch of this format in a_bzrdir."""
1369
utf8_files = [('revision-history', ''),
1370
('branch-name', ''),
1372
return self._initialize_helper(a_bzrdir, utf8_files)
1374
def supports_tags(self):
1378
class BzrBranchFormat6(BranchFormatMetadir):
1379
"""Branch format with last-revision and tags.
1381
Unlike previous formats, this has no explicit revision history. Instead,
1382
this just stores the last-revision, and the left-hand history leading
1383
up to there is the history.
1385
This format was introduced in bzr 0.15
1386
and became the default in 0.91.
1389
def _branch_class(self):
1392
def get_format_string(self):
1393
"""See BranchFormat.get_format_string()."""
1394
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1396
def get_format_description(self):
1397
"""See BranchFormat.get_format_description()."""
1398
return "Branch format 6"
1400
def initialize(self, a_bzrdir):
1401
"""Create a branch of this format in a_bzrdir."""
1402
utf8_files = [('last-revision', '0 null:\n'),
1403
('branch.conf', ''),
1406
return self._initialize_helper(a_bzrdir, utf8_files)
1409
class BzrBranchFormat7(BranchFormatMetadir):
1410
"""Branch format with last-revision, tags, and a stacked location pointer.
1412
The stacked location pointer is passed down to the repository and requires
1413
a repository format with supports_external_lookups = True.
1415
This format was introduced in bzr 1.6.
1418
def _branch_class(self):
1421
def get_format_string(self):
1422
"""See BranchFormat.get_format_string()."""
1423
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1425
def get_format_description(self):
1426
"""See BranchFormat.get_format_description()."""
1427
return "Branch format 7"
1429
def initialize(self, a_bzrdir):
1430
"""Create a branch of this format in a_bzrdir."""
1431
utf8_files = [('last-revision', '0 null:\n'),
1432
('branch.conf', ''),
1435
return self._initialize_helper(a_bzrdir, utf8_files)
1438
super(BzrBranchFormat7, self).__init__()
1439
self._matchingbzrdir.repository_format = \
1440
RepositoryFormatKnitPack5RichRoot()
1442
def supports_stacking(self):
1446
class BranchReferenceFormat(BranchFormat):
1447
"""Bzr branch reference format.
1449
Branch references are used in implementing checkouts, they
1450
act as an alias to the real branch which is at some other url.
1457
def get_format_string(self):
1458
"""See BranchFormat.get_format_string()."""
1459
return "Bazaar-NG Branch Reference Format 1\n"
1461
def get_format_description(self):
1462
"""See BranchFormat.get_format_description()."""
1463
return "Checkout reference format 1"
1465
def get_reference(self, a_bzrdir):
1466
"""See BranchFormat.get_reference()."""
1467
transport = a_bzrdir.get_branch_transport(None)
1468
return transport.get('location').read()
1470
def set_reference(self, a_bzrdir, to_branch):
1471
"""See BranchFormat.set_reference()."""
1472
transport = a_bzrdir.get_branch_transport(None)
1473
location = transport.put_bytes('location', to_branch.base)
1475
def initialize(self, a_bzrdir, target_branch=None):
1476
"""Create a branch of this format in a_bzrdir."""
1477
if target_branch is None:
1478
# this format does not implement branch itself, thus the implicit
1479
# creation contract must see it as uninitializable
1480
raise errors.UninitializableFormat(self)
1481
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1482
branch_transport = a_bzrdir.get_branch_transport(self)
1483
branch_transport.put_bytes('location',
1484
target_branch.bzrdir.root_transport.base)
1485
branch_transport.put_bytes('format', self.get_format_string())
1487
a_bzrdir, _found=True,
1488
possible_transports=[target_branch.bzrdir.root_transport])
1491
super(BranchReferenceFormat, self).__init__()
1492
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1493
self._matchingbzrdir.set_branch_format(self)
1495
def _make_reference_clone_function(format, a_branch):
1496
"""Create a clone() routine for a branch dynamically."""
1497
def clone(to_bzrdir, revision_id=None):
1498
"""See Branch.clone()."""
1499
return format.initialize(to_bzrdir, a_branch)
1500
# cannot obey revision_id limits when cloning a reference ...
1501
# FIXME RBC 20060210 either nuke revision_id for clone, or
1502
# emit some sort of warning/error to the caller ?!
1505
def open(self, a_bzrdir, _found=False, location=None,
1506
possible_transports=None):
1507
"""Return the branch that the branch reference in a_bzrdir points at.
1509
_found is a private parameter, do not use it. It is used to indicate
1510
if format probing has already be done.
1513
format = BranchFormat.find_format(a_bzrdir)
1514
if format.__class__ != self.__class__:
1515
raise AssertionError("wrong format %r found for %r" %
1517
if location is None:
1518
location = self.get_reference(a_bzrdir)
1519
real_bzrdir = bzrdir.BzrDir.open(
1520
location, possible_transports=possible_transports)
1521
result = real_bzrdir.open_branch()
1522
# this changes the behaviour of result.clone to create a new reference
1523
# rather than a copy of the content of the branch.
1524
# I did not use a proxy object because that needs much more extensive
1525
# testing, and we are only changing one behaviour at the moment.
1526
# If we decide to alter more behaviours - i.e. the implicit nickname
1527
# then this should be refactored to introduce a tested proxy branch
1528
# and a subclass of that for use in overriding clone() and ....
1530
result.clone = self._make_reference_clone_function(result)
1534
# formats which have no format string are not discoverable
1535
# and not independently creatable, so are not registered.
1536
__format5 = BzrBranchFormat5()
1537
__format6 = BzrBranchFormat6()
1538
__format7 = BzrBranchFormat7()
1539
BranchFormat.register_format(__format5)
1540
BranchFormat.register_format(BranchReferenceFormat())
1541
BranchFormat.register_format(__format6)
1542
BranchFormat.register_format(__format7)
1543
BranchFormat.set_default_format(__format6)
1544
_legacy_formats = [BzrBranchFormat4(),
1547
class BzrBranch(Branch):
1548
"""A branch stored in the actual filesystem.
1550
Note that it's "local" in the context of the filesystem; it doesn't
1551
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1552
it's writable, and can be accessed via the normal filesystem API.
1554
:ivar _transport: Transport for file operations on this branch's
1555
control files, typically pointing to the .bzr/branch directory.
1556
:ivar repository: Repository for this branch.
1557
:ivar base: The url of the base directory for this branch; the one
1558
containing the .bzr directory.
1561
def __init__(self, _format=None,
1562
_control_files=None, a_bzrdir=None, _repository=None):
1563
"""Create new branch object at a particular location."""
1564
if a_bzrdir is None:
1565
raise ValueError('a_bzrdir must be supplied')
1567
self.bzrdir = a_bzrdir
1568
self._base = self.bzrdir.transport.clone('..').base
1569
# XXX: We should be able to just do
1570
# self.base = self.bzrdir.root_transport.base
1571
# but this does not quite work yet -- mbp 20080522
1572
self._format = _format
1573
if _control_files is None:
1574
raise ValueError('BzrBranch _control_files is None')
1575
self.control_files = _control_files
1576
self._transport = _control_files._transport
1577
self.repository = _repository
1578
Branch.__init__(self)
1581
return '%s(%r)' % (self.__class__.__name__, self.base)
1585
def _get_base(self):
1586
"""Returns the directory containing the control directory."""
1589
base = property(_get_base, doc="The URL for the root of this branch.")
1591
def is_locked(self):
1592
return self.control_files.is_locked()
1594
def lock_write(self, token=None):
1595
repo_token = self.repository.lock_write()
1597
token = self.control_files.lock_write(token=token)
1599
self.repository.unlock()
1603
def lock_read(self):
1604
self.repository.lock_read()
1606
self.control_files.lock_read()
1608
self.repository.unlock()
1612
# TODO: test for failed two phase locks. This is known broken.
1614
self.control_files.unlock()
1616
self.repository.unlock()
1617
if not self.control_files.is_locked():
1618
# we just released the lock
1619
self._clear_cached_state()
1621
def peek_lock_mode(self):
1622
if self.control_files._lock_count == 0:
1625
return self.control_files._lock_mode
1627
def get_physical_lock_status(self):
1628
return self.control_files.get_physical_lock_status()
1631
def print_file(self, file, revision_id):
1632
"""See Branch.print_file."""
1633
return self.repository.print_file(file, revision_id)
1635
def _write_revision_history(self, history):
1636
"""Factored out of set_revision_history.
1638
This performs the actual writing to disk.
1639
It is intended to be called by BzrBranch5.set_revision_history."""
1640
self._transport.put_bytes(
1641
'revision-history', '\n'.join(history),
1642
mode=self.bzrdir._get_file_mode())
1645
def set_revision_history(self, rev_history):
1646
"""See Branch.set_revision_history."""
1647
if 'evil' in debug.debug_flags:
1648
mutter_callsite(3, "set_revision_history scales with history.")
1649
check_not_reserved_id = _mod_revision.check_not_reserved_id
1650
for rev_id in rev_history:
1651
check_not_reserved_id(rev_id)
1652
if Branch.hooks['post_change_branch_tip']:
1653
# Don't calculate the last_revision_info() if there are no hooks
1655
old_revno, old_revid = self.last_revision_info()
1656
if len(rev_history) == 0:
1657
revid = _mod_revision.NULL_REVISION
1659
revid = rev_history[-1]
1660
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1661
self._write_revision_history(rev_history)
1662
self._clear_cached_state()
1663
self._cache_revision_history(rev_history)
1664
for hook in Branch.hooks['set_rh']:
1665
hook(self, rev_history)
1666
if Branch.hooks['post_change_branch_tip']:
1667
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1669
def _synchronize_history(self, destination, revision_id):
1670
"""Synchronize last revision and revision history between branches.
1672
This version is most efficient when the destination is also a
1673
BzrBranch5, but works for BzrBranch6 as long as the revision
1674
history is the true lefthand parent history, and all of the revisions
1675
are in the destination's repository. If not, set_revision_history
1678
:param destination: The branch to copy the history into
1679
:param revision_id: The revision-id to truncate history at. May
1680
be None to copy complete history.
1682
if not isinstance(destination._format, BzrBranchFormat5):
1683
super(BzrBranch, self)._synchronize_history(
1684
destination, revision_id)
1686
if revision_id == _mod_revision.NULL_REVISION:
1689
new_history = self.revision_history()
1690
if revision_id is not None and new_history != []:
1692
new_history = new_history[:new_history.index(revision_id) + 1]
1694
rev = self.repository.get_revision(revision_id)
1695
new_history = rev.get_history(self.repository)[1:]
1696
destination.set_revision_history(new_history)
1698
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1699
"""Run the pre_change_branch_tip hooks."""
1700
hooks = Branch.hooks['pre_change_branch_tip']
1703
old_revno, old_revid = self.last_revision_info()
1704
params = ChangeBranchTipParams(
1705
self, old_revno, new_revno, old_revid, new_revid)
1709
except errors.TipChangeRejected:
1712
exc_info = sys.exc_info()
1713
hook_name = Branch.hooks.get_hook_name(hook)
1714
raise errors.HookFailed(
1715
'pre_change_branch_tip', hook_name, exc_info)
1717
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1718
"""Run the post_change_branch_tip hooks."""
1719
hooks = Branch.hooks['post_change_branch_tip']
1722
new_revno, new_revid = self.last_revision_info()
1723
params = ChangeBranchTipParams(
1724
self, old_revno, new_revno, old_revid, new_revid)
1729
def set_last_revision_info(self, revno, revision_id):
1730
"""Set the last revision of this branch.
1732
The caller is responsible for checking that the revno is correct
1733
for this revision id.
1735
It may be possible to set the branch last revision to an id not
1736
present in the repository. However, branches can also be
1737
configured to check constraints on history, in which case this may not
1740
revision_id = _mod_revision.ensure_null(revision_id)
1741
# this old format stores the full history, but this api doesn't
1742
# provide it, so we must generate, and might as well check it's
1744
history = self._lefthand_history(revision_id)
1745
if len(history) != revno:
1746
raise AssertionError('%d != %d' % (len(history), revno))
1747
self.set_revision_history(history)
1749
def _gen_revision_history(self):
1750
history = self._transport.get_bytes('revision-history').split('\n')
1751
if history[-1:] == ['']:
1752
# There shouldn't be a trailing newline, but just in case.
1756
def _lefthand_history(self, revision_id, last_rev=None,
1758
if 'evil' in debug.debug_flags:
1759
mutter_callsite(4, "_lefthand_history scales with history.")
1760
# stop_revision must be a descendant of last_revision
1761
graph = self.repository.get_graph()
1762
if last_rev is not None:
1763
if not graph.is_ancestor(last_rev, revision_id):
1764
# our previous tip is not merged into stop_revision
1765
raise errors.DivergedBranches(self, other_branch)
1766
# make a new revision history from the graph
1767
parents_map = graph.get_parent_map([revision_id])
1768
if revision_id not in parents_map:
1769
raise errors.NoSuchRevision(self, revision_id)
1770
current_rev_id = revision_id
1772
check_not_reserved_id = _mod_revision.check_not_reserved_id
1773
# Do not include ghosts or graph origin in revision_history
1774
while (current_rev_id in parents_map and
1775
len(parents_map[current_rev_id]) > 0):
1776
check_not_reserved_id(current_rev_id)
1777
new_history.append(current_rev_id)
1778
current_rev_id = parents_map[current_rev_id][0]
1779
parents_map = graph.get_parent_map([current_rev_id])
1780
new_history.reverse()
1784
def generate_revision_history(self, revision_id, last_rev=None,
1786
"""Create a new revision history that will finish with revision_id.
1788
:param revision_id: the new tip to use.
1789
:param last_rev: The previous last_revision. If not None, then this
1790
must be a ancestory of revision_id, or DivergedBranches is raised.
1791
:param other_branch: The other branch that DivergedBranches should
1792
raise with respect to.
1794
self.set_revision_history(self._lefthand_history(revision_id,
1795
last_rev, other_branch))
1797
def basis_tree(self):
1798
"""See Branch.basis_tree."""
1799
return self.repository.revision_tree(self.last_revision())
1802
def pull(self, source, overwrite=False, stop_revision=None,
1803
_hook_master=None, run_hooks=True, possible_transports=None,
1804
_override_hook_target=None):
1807
:param _hook_master: Private parameter - set the branch to
1808
be supplied as the master to pull hooks.
1809
:param run_hooks: Private parameter - if false, this branch
1810
is being called because it's the master of the primary branch,
1811
so it should not run its hooks.
1812
:param _override_hook_target: Private parameter - set the branch to be
1813
supplied as the target_branch to pull hooks.
1815
result = PullResult()
1816
result.source_branch = source
1817
if _override_hook_target is None:
1818
result.target_branch = self
1820
result.target_branch = _override_hook_target
1823
# We assume that during 'pull' the local repository is closer than
1825
graph = self.repository.get_graph(source.repository)
1826
result.old_revno, result.old_revid = self.last_revision_info()
1827
self.update_revisions(source, stop_revision, overwrite=overwrite,
1829
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1830
result.new_revno, result.new_revid = self.last_revision_info()
1832
result.master_branch = _hook_master
1833
result.local_branch = result.target_branch
1835
result.master_branch = result.target_branch
1836
result.local_branch = None
1838
for hook in Branch.hooks['post_pull']:
1844
def _get_parent_location(self):
1845
_locs = ['parent', 'pull', 'x-pull']
1848
return self._transport.get_bytes(l).strip('\n')
1849
except errors.NoSuchFile:
1854
def push(self, target, overwrite=False, stop_revision=None,
1855
_override_hook_source_branch=None):
1858
This is the basic concrete implementation of push()
1860
:param _override_hook_source_branch: If specified, run
1861
the hooks passing this Branch as the source, rather than self.
1862
This is for use of RemoteBranch, where push is delegated to the
1863
underlying vfs-based Branch.
1865
# TODO: Public option to disable running hooks - should be trivial but
1867
return _run_with_write_locked_target(
1868
target, self._push_with_bound_branches, target, overwrite,
1870
_override_hook_source_branch=_override_hook_source_branch)
1872
def _push_with_bound_branches(self, target, overwrite,
1874
_override_hook_source_branch=None):
1875
"""Push from self into target, and into target's master if any.
1877
This is on the base BzrBranch class even though it doesn't support
1878
bound branches because the *target* might be bound.
1881
if _override_hook_source_branch:
1882
result.source_branch = _override_hook_source_branch
1883
for hook in Branch.hooks['post_push']:
1886
bound_location = target.get_bound_location()
1887
if bound_location and target.base != bound_location:
1888
# there is a master branch.
1890
# XXX: Why the second check? Is it even supported for a branch to
1891
# be bound to itself? -- mbp 20070507
1892
master_branch = target.get_master_branch()
1893
master_branch.lock_write()
1895
# push into the master from this branch.
1896
self._basic_push(master_branch, overwrite, stop_revision)
1897
# and push into the target branch from this. Note that we push from
1898
# this branch again, because its considered the highest bandwidth
1900
result = self._basic_push(target, overwrite, stop_revision)
1901
result.master_branch = master_branch
1902
result.local_branch = target
1906
master_branch.unlock()
1909
result = self._basic_push(target, overwrite, stop_revision)
1910
# TODO: Why set master_branch and local_branch if there's no
1911
# binding? Maybe cleaner to just leave them unset? -- mbp
1913
result.master_branch = target
1914
result.local_branch = None
1918
def _basic_push(self, target, overwrite, stop_revision):
1919
"""Basic implementation of push without bound branches or hooks.
1921
Must be called with self read locked and target write locked.
1923
result = PushResult()
1924
result.source_branch = self
1925
result.target_branch = target
1926
result.old_revno, result.old_revid = target.last_revision_info()
1927
if result.old_revid != self.last_revision():
1928
# We assume that during 'push' this repository is closer than
1930
graph = self.repository.get_graph(target.repository)
1931
target.update_revisions(self, stop_revision, overwrite=overwrite,
1933
if self._push_should_merge_tags():
1934
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1935
result.new_revno, result.new_revid = target.last_revision_info()
1938
def _push_should_merge_tags(self):
1939
"""Should _basic_push merge this branch's tags into the target?
1941
The default implementation returns False if this branch has no tags,
1942
and True the rest of the time. Subclasses may override this.
1944
return self.tags.supports_tags() and self.tags.get_tag_dict()
1946
def get_parent(self):
1947
"""See Branch.get_parent."""
1948
parent = self._get_parent_location()
1951
# This is an old-format absolute path to a local branch
1952
# turn it into a url
1953
if parent.startswith('/'):
1954
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1956
return urlutils.join(self.base[:-1], parent)
1957
except errors.InvalidURLJoin, e:
1958
raise errors.InaccessibleParent(parent, self.base)
1960
def get_stacked_on_url(self):
1961
raise errors.UnstackableBranchFormat(self._format, self.base)
1963
def set_push_location(self, location):
1964
"""See Branch.set_push_location."""
1965
self.get_config().set_user_option(
1966
'push_location', location,
1967
store=_mod_config.STORE_LOCATION_NORECURSE)
1970
def set_parent(self, url):
1971
"""See Branch.set_parent."""
1972
# TODO: Maybe delete old location files?
1973
# URLs should never be unicode, even on the local fs,
1974
# FIXUP this and get_parent in a future branch format bump:
1975
# read and rewrite the file. RBC 20060125
1977
if isinstance(url, unicode):
1979
url = url.encode('ascii')
1980
except UnicodeEncodeError:
1981
raise errors.InvalidURL(url,
1982
"Urls must be 7-bit ascii, "
1983
"use bzrlib.urlutils.escape")
1984
url = urlutils.relative_url(self.base, url)
1985
self._set_parent_location(url)
1987
def _set_parent_location(self, url):
1989
self._transport.delete('parent')
1991
self._transport.put_bytes('parent', url + '\n',
1992
mode=self.bzrdir._get_file_mode())
1994
def set_stacked_on_url(self, url):
1995
raise errors.UnstackableBranchFormat(self._format, self.base)
1998
class BzrBranch5(BzrBranch):
1999
"""A format 5 branch. This supports new features over plain branches.
2001
It has support for a master_branch which is the data for bound branches.
2005
def pull(self, source, overwrite=False, stop_revision=None,
2006
run_hooks=True, possible_transports=None,
2007
_override_hook_target=None):
2008
"""Pull from source into self, updating my master if any.
2010
:param run_hooks: Private parameter - if false, this branch
2011
is being called because it's the master of the primary branch,
2012
so it should not run its hooks.
2014
bound_location = self.get_bound_location()
2015
master_branch = None
2016
if bound_location and source.base != bound_location:
2017
# not pulling from master, so we need to update master.
2018
master_branch = self.get_master_branch(possible_transports)
2019
master_branch.lock_write()
2022
# pull from source into master.
2023
master_branch.pull(source, overwrite, stop_revision,
2025
return super(BzrBranch5, self).pull(source, overwrite,
2026
stop_revision, _hook_master=master_branch,
2027
run_hooks=run_hooks,
2028
_override_hook_target=_override_hook_target)
2031
master_branch.unlock()
2033
def get_bound_location(self):
2035
return self._transport.get_bytes('bound')[:-1]
2036
except errors.NoSuchFile:
2040
def get_master_branch(self, possible_transports=None):
2041
"""Return the branch we are bound to.
2043
:return: Either a Branch, or None
2045
This could memoise the branch, but if thats done
2046
it must be revalidated on each new lock.
2047
So for now we just don't memoise it.
2048
# RBC 20060304 review this decision.
2050
bound_loc = self.get_bound_location()
2054
return Branch.open(bound_loc,
2055
possible_transports=possible_transports)
2056
except (errors.NotBranchError, errors.ConnectionError), e:
2057
raise errors.BoundBranchConnectionFailure(
2061
def set_bound_location(self, location):
2062
"""Set the target where this branch is bound to.
2064
:param location: URL to the target branch
2067
self._transport.put_bytes('bound', location+'\n',
2068
mode=self.bzrdir._get_file_mode())
2071
self._transport.delete('bound')
2072
except errors.NoSuchFile:
2077
def bind(self, other):
2078
"""Bind this branch to the branch other.
2080
This does not push or pull data between the branches, though it does
2081
check for divergence to raise an error when the branches are not
2082
either the same, or one a prefix of the other. That behaviour may not
2083
be useful, so that check may be removed in future.
2085
:param other: The branch to bind to
2088
# TODO: jam 20051230 Consider checking if the target is bound
2089
# It is debatable whether you should be able to bind to
2090
# a branch which is itself bound.
2091
# Committing is obviously forbidden,
2092
# but binding itself may not be.
2093
# Since we *have* to check at commit time, we don't
2094
# *need* to check here
2096
# we want to raise diverged if:
2097
# last_rev is not in the other_last_rev history, AND
2098
# other_last_rev is not in our history, and do it without pulling
2100
self.set_bound_location(other.base)
2104
"""If bound, unbind"""
2105
return self.set_bound_location(None)
2108
def update(self, possible_transports=None):
2109
"""Synchronise this branch with the master branch if any.
2111
:return: None or the last_revision that was pivoted out during the
2114
master = self.get_master_branch(possible_transports)
2115
if master is not None:
2116
old_tip = _mod_revision.ensure_null(self.last_revision())
2117
self.pull(master, overwrite=True)
2118
if self.repository.get_graph().is_ancestor(old_tip,
2119
_mod_revision.ensure_null(self.last_revision())):
2125
class BzrBranch7(BzrBranch5):
2126
"""A branch with support for a fallback repository."""
2128
def _get_fallback_repository(self, url):
2129
"""Get the repository we fallback to at url."""
2130
url = urlutils.join(self.base, url)
2131
a_bzrdir = bzrdir.BzrDir.open(url,
2132
possible_transports=[self._transport])
2133
return a_bzrdir.open_branch().repository
2135
def _activate_fallback_location(self, url):
2136
"""Activate the branch/repository from url as a fallback repository."""
2137
self.repository.add_fallback_repository(
2138
self._get_fallback_repository(url))
2140
def _open_hook(self):
2142
url = self.get_stacked_on_url()
2143
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2144
errors.UnstackableBranchFormat):
2147
for hook in Branch.hooks['transform_fallback_location']:
2148
url = hook(self, url)
2150
hook_name = Branch.hooks.get_hook_name(hook)
2151
raise AssertionError(
2152
"'transform_fallback_location' hook %s returned "
2153
"None, not a URL." % hook_name)
2154
self._activate_fallback_location(url)
2156
def _check_stackable_repo(self):
2157
if not self.repository._format.supports_external_lookups:
2158
raise errors.UnstackableRepositoryFormat(self.repository._format,
2159
self.repository.base)
2161
def __init__(self, *args, **kwargs):
2162
super(BzrBranch7, self).__init__(*args, **kwargs)
2163
self._last_revision_info_cache = None
2164
self._partial_revision_history_cache = []
2166
def _clear_cached_state(self):
2167
super(BzrBranch7, self)._clear_cached_state()
2168
self._last_revision_info_cache = None
2169
self._partial_revision_history_cache = []
2171
def _last_revision_info(self):
2172
revision_string = self._transport.get_bytes('last-revision')
2173
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2174
revision_id = cache_utf8.get_cached_utf8(revision_id)
2176
return revno, revision_id
2178
def _write_last_revision_info(self, revno, revision_id):
2179
"""Simply write out the revision id, with no checks.
2181
Use set_last_revision_info to perform this safely.
2183
Does not update the revision_history cache.
2184
Intended to be called by set_last_revision_info and
2185
_write_revision_history.
2187
revision_id = _mod_revision.ensure_null(revision_id)
2188
out_string = '%d %s\n' % (revno, revision_id)
2189
self._transport.put_bytes('last-revision', out_string,
2190
mode=self.bzrdir._get_file_mode())
2193
def set_last_revision_info(self, revno, revision_id):
2194
revision_id = _mod_revision.ensure_null(revision_id)
2195
old_revno, old_revid = self.last_revision_info()
2196
if self._get_append_revisions_only():
2197
self._check_history_violation(revision_id)
2198
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2199
self._write_last_revision_info(revno, revision_id)
2200
self._clear_cached_state()
2201
self._last_revision_info_cache = revno, revision_id
2202
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2204
def _synchronize_history(self, destination, revision_id):
2205
"""Synchronize last revision and revision history between branches.
2207
:see: Branch._synchronize_history
2209
# XXX: The base Branch has a fast implementation of this method based
2210
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2211
# that uses set_revision_history. This class inherits from BzrBranch5,
2212
# but wants the fast implementation, so it calls
2213
# Branch._synchronize_history directly.
2214
Branch._synchronize_history(self, destination, revision_id)
2216
def _check_history_violation(self, revision_id):
2217
last_revision = _mod_revision.ensure_null(self.last_revision())
2218
if _mod_revision.is_null(last_revision):
2220
if last_revision not in self._lefthand_history(revision_id):
2221
raise errors.AppendRevisionsOnlyViolation(self.base)
2223
def _gen_revision_history(self):
2224
"""Generate the revision history from last revision
2226
last_revno, last_revision = self.last_revision_info()
2227
self._extend_partial_history(stop_index=last_revno-1)
2228
return list(reversed(self._partial_revision_history_cache))
2230
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2231
"""Extend the partial history to include a given index
2233
If a stop_index is supplied, stop when that index has been reached.
2234
If a stop_revision is supplied, stop when that revision is
2235
encountered. Otherwise, stop when the beginning of history is
2238
:param stop_index: The index which should be present. When it is
2239
present, history extension will stop.
2240
:param revision_id: The revision id which should be present. When
2241
it is encountered, history extension will stop.
2243
repo = self.repository
2244
if len(self._partial_revision_history_cache) == 0:
2245
iterator = repo.iter_reverse_revision_history(self.last_revision())
2247
start_revision = self._partial_revision_history_cache[-1]
2248
iterator = repo.iter_reverse_revision_history(start_revision)
2249
#skip the last revision in the list
2250
next_revision = iterator.next()
2251
for revision_id in iterator:
2252
self._partial_revision_history_cache.append(revision_id)
2253
if (stop_index is not None and
2254
len(self._partial_revision_history_cache) > stop_index):
2256
if revision_id == stop_revision:
2259
def _write_revision_history(self, history):
2260
"""Factored out of set_revision_history.
2262
This performs the actual writing to disk, with format-specific checks.
2263
It is intended to be called by BzrBranch5.set_revision_history.
2265
if len(history) == 0:
2266
last_revision = 'null:'
2268
if history != self._lefthand_history(history[-1]):
2269
raise errors.NotLefthandHistory(history)
2270
last_revision = history[-1]
2271
if self._get_append_revisions_only():
2272
self._check_history_violation(last_revision)
2273
self._write_last_revision_info(len(history), last_revision)
2276
def _set_parent_location(self, url):
2277
"""Set the parent branch"""
2278
self._set_config_location('parent_location', url, make_relative=True)
2281
def _get_parent_location(self):
2282
"""Set the parent branch"""
2283
return self._get_config_location('parent_location')
2285
def set_push_location(self, location):
2286
"""See Branch.set_push_location."""
2287
self._set_config_location('push_location', location)
2289
def set_bound_location(self, location):
2290
"""See Branch.set_push_location."""
2292
config = self.get_config()
2293
if location is None:
2294
if config.get_user_option('bound') != 'True':
2297
config.set_user_option('bound', 'False', warn_masked=True)
2300
self._set_config_location('bound_location', location,
2302
config.set_user_option('bound', 'True', warn_masked=True)
2305
def _get_bound_location(self, bound):
2306
"""Return the bound location in the config file.
2308
Return None if the bound parameter does not match"""
2309
config = self.get_config()
2310
config_bound = (config.get_user_option('bound') == 'True')
2311
if config_bound != bound:
2313
return self._get_config_location('bound_location', config=config)
2315
def get_bound_location(self):
2316
"""See Branch.set_push_location."""
2317
return self._get_bound_location(True)
2319
def get_old_bound_location(self):
2320
"""See Branch.get_old_bound_location"""
2321
return self._get_bound_location(False)
2323
def get_stacked_on_url(self):
2324
# you can always ask for the URL; but you might not be able to use it
2325
# if the repo can't support stacking.
2326
## self._check_stackable_repo()
2327
stacked_url = self._get_config_location('stacked_on_location')
2328
if stacked_url is None:
2329
raise errors.NotStacked(self)
2332
def set_append_revisions_only(self, enabled):
2337
self.get_config().set_user_option('append_revisions_only', value,
2340
def set_stacked_on_url(self, url):
2341
self._check_stackable_repo()
2344
old_url = self.get_stacked_on_url()
2345
except (errors.NotStacked, errors.UnstackableBranchFormat,
2346
errors.UnstackableRepositoryFormat):
2349
# repositories don't offer an interface to remove fallback
2350
# repositories today; take the conceptually simpler option and just
2352
self.repository = self.bzrdir.find_repository()
2353
# for every revision reference the branch has, ensure it is pulled
2355
source_repository = self._get_fallback_repository(old_url)
2356
for revision_id in chain([self.last_revision()],
2357
self.tags.get_reverse_tag_dict()):
2358
self.repository.fetch(source_repository, revision_id,
2361
self._activate_fallback_location(url)
2362
# write this out after the repository is stacked to avoid setting a
2363
# stacked config that doesn't work.
2364
self._set_config_location('stacked_on_location', url)
2366
def _get_append_revisions_only(self):
2367
value = self.get_config().get_user_option('append_revisions_only')
2368
return value == 'True'
2370
def _make_tags(self):
2371
return BasicTags(self)
2374
def generate_revision_history(self, revision_id, last_rev=None,
2376
"""See BzrBranch5.generate_revision_history"""
2377
history = self._lefthand_history(revision_id, last_rev, other_branch)
2378
revno = len(history)
2379
self.set_last_revision_info(revno, revision_id)
2382
def get_rev_id(self, revno, history=None):
2383
"""Find the revision id of the specified revno."""
2385
return _mod_revision.NULL_REVISION
2387
last_revno, last_revision_id = self.last_revision_info()
2388
if revno <= 0 or revno > last_revno:
2389
raise errors.NoSuchRevision(self, revno)
2391
if history is not None:
2392
return history[revno - 1]
2394
index = last_revno - revno
2395
if len(self._partial_revision_history_cache) <= index:
2396
self._extend_partial_history(stop_index=index)
2397
if len(self._partial_revision_history_cache) > index:
2398
return self._partial_revision_history_cache[index]
2400
raise errors.NoSuchRevision(self, revno)
2403
def revision_id_to_revno(self, revision_id):
2404
"""Given a revision id, return its revno"""
2405
if _mod_revision.is_null(revision_id):
2408
index = self._partial_revision_history_cache.index(revision_id)
2410
self._extend_partial_history(stop_revision=revision_id)
2411
index = len(self._partial_revision_history_cache) - 1
2412
if self._partial_revision_history_cache[index] != revision_id:
2413
raise errors.NoSuchRevision(self, revision_id)
2414
return self.revno() - index
2417
class BzrBranch6(BzrBranch7):
2418
"""See BzrBranchFormat6 for the capabilities of this branch.
2420
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2424
def get_stacked_on_url(self):
2425
raise errors.UnstackableBranchFormat(self._format, self.base)
2427
def set_stacked_on_url(self, url):
2428
raise errors.UnstackableBranchFormat(self._format, self.base)
2431
######################################################################
2432
# results of operations
2435
class _Result(object):
2437
def _show_tag_conficts(self, to_file):
2438
if not getattr(self, 'tag_conflicts', None):
2440
to_file.write('Conflicting tags:\n')
2441
for name, value1, value2 in self.tag_conflicts:
2442
to_file.write(' %s\n' % (name, ))
2445
class PullResult(_Result):
2446
"""Result of a Branch.pull operation.
2448
:ivar old_revno: Revision number before pull.
2449
:ivar new_revno: Revision number after pull.
2450
:ivar old_revid: Tip revision id before pull.
2451
:ivar new_revid: Tip revision id after pull.
2452
:ivar source_branch: Source (local) branch object.
2453
:ivar master_branch: Master branch of the target, or the target if no
2455
:ivar local_branch: target branch if there is a Master, else None
2456
:ivar target_branch: Target/destination branch object.
2457
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2461
# DEPRECATED: pull used to return the change in revno
2462
return self.new_revno - self.old_revno
2464
def report(self, to_file):
2466
if self.old_revid == self.new_revid:
2467
to_file.write('No revisions to pull.\n')
2469
to_file.write('Now on revision %d.\n' % self.new_revno)
2470
self._show_tag_conficts(to_file)
2473
class PushResult(_Result):
2474
"""Result of a Branch.push operation.
2476
:ivar old_revno: Revision number before push.
2477
:ivar new_revno: Revision number after push.
2478
:ivar old_revid: Tip revision id before push.
2479
:ivar new_revid: Tip revision id after push.
2480
:ivar source_branch: Source branch object.
2481
:ivar master_branch: Master branch of the target, or None.
2482
:ivar target_branch: Target/destination branch object.
2486
# DEPRECATED: push used to return the change in revno
2487
return self.new_revno - self.old_revno
2489
def report(self, to_file):
2490
"""Write a human-readable description of the result."""
2491
if self.old_revid == self.new_revid:
2492
to_file.write('No new revisions to push.\n')
2494
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2495
self._show_tag_conficts(to_file)
2498
class BranchCheckResult(object):
2499
"""Results of checking branch consistency.
2504
def __init__(self, branch):
2505
self.branch = branch
2507
def report_results(self, verbose):
2508
"""Report the check results via trace.note.
2510
:param verbose: Requests more detailed display of what was checked,
2513
note('checked branch %s format %s',
2515
self.branch._format)
2518
class Converter5to6(object):
2519
"""Perform an in-place upgrade of format 5 to format 6"""
2521
def convert(self, branch):
2522
# Data for 5 and 6 can peacefully coexist.
2523
format = BzrBranchFormat6()
2524
new_branch = format.open(branch.bzrdir, _found=True)
2526
# Copy source data into target
2527
new_branch._write_last_revision_info(*branch.last_revision_info())
2528
new_branch.set_parent(branch.get_parent())
2529
new_branch.set_bound_location(branch.get_bound_location())
2530
new_branch.set_push_location(branch.get_push_location())
2532
# New branch has no tags by default
2533
new_branch.tags._set_tag_dict({})
2535
# Copying done; now update target format
2536
new_branch._transport.put_bytes('format',
2537
format.get_format_string(),
2538
mode=new_branch.bzrdir._get_file_mode())
2540
# Clean up old files
2541
new_branch._transport.delete('revision-history')
2543
branch.set_parent(None)
2544
except errors.NoSuchFile:
2546
branch.set_bound_location(None)
2549
class Converter6to7(object):
2550
"""Perform an in-place upgrade of format 6 to format 7"""
2552
def convert(self, branch):
2553
format = BzrBranchFormat7()
2554
branch._set_config_location('stacked_on_location', '')
2555
# update target format
2556
branch._transport.put_bytes('format', format.get_format_string())
2560
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2561
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2564
_run_with_write_locked_target will attempt to release the lock it acquires.
2566
If an exception is raised by callable, then that exception *will* be
2567
propagated, even if the unlock attempt raises its own error. Thus
2568
_run_with_write_locked_target should be preferred to simply doing::
2572
return callable(*args, **kwargs)
2577
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2578
# should share code?
2581
result = callable(*args, **kwargs)
2583
exc_info = sys.exc_info()
2587
raise exc_info[0], exc_info[1], exc_info[2]
added
removed
bzrlib/branch.py
