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._last_revision_info_cache = None
94
hooks = Branch.hooks['open']
99
"""Called by init to allow simpler extension of the base class."""
101
def break_lock(self):
102
"""Break a lock if one is present from another instance.
104
Uses the ui factory to ask for confirmation if the lock may be from
107
This will probe the repository for its lock as well.
109
self.control_files.break_lock()
110
self.repository.break_lock()
111
master = self.get_master_branch()
112
if master is not None:
116
def open(base, _unsupported=False, possible_transports=None):
117
"""Open the branch rooted at base.
119
For instance, if the branch is at URL/.bzr/branch,
120
Branch.open(URL) -> a Branch instance.
122
control = bzrdir.BzrDir.open(base, _unsupported,
123
possible_transports=possible_transports)
124
return control.open_branch(_unsupported)
127
def open_from_transport(transport, _unsupported=False):
128
"""Open the branch rooted at transport"""
129
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
130
return control.open_branch(_unsupported)
133
def open_containing(url, possible_transports=None):
134
"""Open an existing branch which contains url.
136
This probes for a branch at url, and searches upwards from there.
138
Basically we keep looking up until we find the control directory or
139
run into the root. If there isn't one, raises NotBranchError.
140
If there is one and it is either an unrecognised format or an unsupported
141
format, UnknownFormatError or UnsupportedFormatError are raised.
142
If there is one, it is returned, along with the unused portion of url.
144
control, relpath = bzrdir.BzrDir.open_containing(url,
146
return control.open_branch(), relpath
148
def get_config(self):
149
return BranchConfig(self)
151
def _get_nick(self, local=False, possible_transports=None):
152
config = self.get_config()
153
# explicit overrides master, but don't look for master if local is True
154
if not local and not config.has_explicit_nickname():
156
master = self.get_master_branch(possible_transports)
157
if master is not None:
158
# return the master branch value
160
except errors.BzrError, e:
161
# Silently fall back to local implicit nick if the master is
163
mutter("Could not connect to bound branch, "
164
"falling back to local nick.\n " + str(e))
165
return config.get_nickname()
167
def _set_nick(self, nick):
168
self.get_config().set_user_option('nickname', nick, warn_masked=True)
170
nick = property(_get_nick, _set_nick)
173
raise NotImplementedError(self.is_locked)
175
def lock_write(self):
176
raise NotImplementedError(self.lock_write)
179
raise NotImplementedError(self.lock_read)
182
raise NotImplementedError(self.unlock)
184
def peek_lock_mode(self):
185
"""Return lock mode for the Branch: 'r', 'w' or None"""
186
raise NotImplementedError(self.peek_lock_mode)
188
def get_physical_lock_status(self):
189
raise NotImplementedError(self.get_physical_lock_status)
192
def get_revision_id_to_revno_map(self):
193
"""Return the revision_id => dotted revno map.
195
This will be regenerated on demand, but will be cached.
197
:return: A dictionary mapping revision_id => dotted revno.
198
This dictionary should not be modified by the caller.
200
if self._revision_id_to_revno_cache is not None:
201
mapping = self._revision_id_to_revno_cache
203
mapping = self._gen_revno_map()
204
self._cache_revision_id_to_revno(mapping)
205
# TODO: jam 20070417 Since this is being cached, should we be returning
207
# I would rather not, and instead just declare that users should not
208
# modify the return value.
211
def _gen_revno_map(self):
212
"""Create a new mapping from revision ids to dotted revnos.
214
Dotted revnos are generated based on the current tip in the revision
216
This is the worker function for get_revision_id_to_revno_map, which
217
just caches the return value.
219
:return: A dictionary mapping revision_id => dotted revno.
221
last_revision = self.last_revision()
222
revision_graph = repository._old_get_graph(self.repository,
224
merge_sorted_revisions = tsort.merge_sort(
229
revision_id_to_revno = dict((rev_id, revno)
230
for seq_num, rev_id, depth, revno, end_of_merge
231
in merge_sorted_revisions)
232
return revision_id_to_revno
234
def leave_lock_in_place(self):
235
"""Tell this branch object not to release the physical lock when this
238
If lock_write doesn't return a token, then this method is not supported.
240
self.control_files.leave_in_place()
242
def dont_leave_lock_in_place(self):
243
"""Tell this branch object to release the physical lock when this
244
object is unlocked, even if it didn't originally acquire it.
246
If lock_write doesn't return a token, then this method is not supported.
248
self.control_files.dont_leave_in_place()
250
def bind(self, other):
251
"""Bind the local branch the other branch.
253
:param other: The branch to bind to
256
raise errors.UpgradeRequired(self.base)
259
def fetch(self, from_branch, last_revision=None, pb=None):
260
"""Copy revisions from from_branch into this branch.
262
:param from_branch: Where to copy from.
263
:param last_revision: What revision to stop at (None for at the end
265
:param pb: An optional progress bar to use.
267
Returns the copied revision count and the failed revisions in a tuple:
270
if self.base == from_branch.base:
273
nested_pb = ui.ui_factory.nested_progress_bar()
278
from_branch.lock_read()
280
if last_revision is None:
281
pb.update('get source history')
282
last_revision = from_branch.last_revision()
283
last_revision = _mod_revision.ensure_null(last_revision)
284
return self.repository.fetch(from_branch.repository,
285
revision_id=last_revision,
288
if nested_pb is not None:
292
def get_bound_location(self):
293
"""Return the URL of the branch we are bound to.
295
Older format branches cannot bind, please be sure to use a metadir
300
def get_old_bound_location(self):
301
"""Return the URL of the branch we used to be bound to
303
raise errors.UpgradeRequired(self.base)
305
def get_commit_builder(self, parents, config=None, timestamp=None,
306
timezone=None, committer=None, revprops=None,
308
"""Obtain a CommitBuilder for this branch.
310
:param parents: Revision ids of the parents of the new revision.
311
:param config: Optional configuration to use.
312
:param timestamp: Optional timestamp recorded for commit.
313
:param timezone: Optional timezone for timestamp.
314
:param committer: Optional committer to set for commit.
315
:param revprops: Optional dictionary of revision properties.
316
:param revision_id: Optional revision id.
320
config = self.get_config()
322
return self.repository.get_commit_builder(self, parents, config,
323
timestamp, timezone, committer, revprops, revision_id)
325
def get_master_branch(self, possible_transports=None):
326
"""Return the branch we are bound to.
328
:return: Either a Branch, or None
332
def get_revision_delta(self, revno):
333
"""Return the delta for one revision.
335
The delta is relative to its mainline predecessor, or the
336
empty tree for revision 1.
338
rh = self.revision_history()
339
if not (1 <= revno <= len(rh)):
340
raise errors.InvalidRevisionNumber(revno)
341
return self.repository.get_revision_delta(rh[revno-1])
343
def get_stacked_on_url(self):
344
"""Get the URL this branch is stacked against.
346
:raises NotStacked: If the branch is not stacked.
347
:raises UnstackableBranchFormat: If the branch does not support
350
raise NotImplementedError(self.get_stacked_on_url)
352
def print_file(self, file, revision_id):
353
"""Print `file` to stdout."""
354
raise NotImplementedError(self.print_file)
356
def set_revision_history(self, rev_history):
357
raise NotImplementedError(self.set_revision_history)
359
def set_stacked_on_url(self, url):
360
"""Set the URL this branch is stacked against.
362
:raises UnstackableBranchFormat: If the branch does not support
364
:raises UnstackableRepositoryFormat: If the repository does not support
367
raise NotImplementedError(self.set_stacked_on_url)
369
def _cache_revision_history(self, rev_history):
370
"""Set the cached revision history to rev_history.
372
The revision_history method will use this cache to avoid regenerating
373
the revision history.
375
This API is semi-public; it only for use by subclasses, all other code
376
should consider it to be private.
378
self._revision_history_cache = rev_history
380
def _cache_revision_id_to_revno(self, revision_id_to_revno):
381
"""Set the cached revision_id => revno map to revision_id_to_revno.
383
This API is semi-public; it only for use by subclasses, all other code
384
should consider it to be private.
386
self._revision_id_to_revno_cache = revision_id_to_revno
388
def _clear_cached_state(self):
389
"""Clear any cached data on this branch, e.g. cached revision history.
391
This means the next call to revision_history will need to call
392
_gen_revision_history.
394
This API is semi-public; it only for use by subclasses, all other code
395
should consider it to be private.
397
self._revision_history_cache = None
398
self._revision_id_to_revno_cache = None
399
self._last_revision_info_cache = None
401
def _gen_revision_history(self):
402
"""Return sequence of revision hashes on to this branch.
404
Unlike revision_history, this method always regenerates or rereads the
405
revision history, i.e. it does not cache the result, so repeated calls
408
Concrete subclasses should override this instead of revision_history so
409
that subclasses do not need to deal with caching logic.
411
This API is semi-public; it only for use by subclasses, all other code
412
should consider it to be private.
414
raise NotImplementedError(self._gen_revision_history)
417
def revision_history(self):
418
"""Return sequence of revision ids on this branch.
420
This method will cache the revision history for as long as it is safe to
423
if 'evil' in debug.debug_flags:
424
mutter_callsite(3, "revision_history scales with history.")
425
if self._revision_history_cache is not None:
426
history = self._revision_history_cache
428
history = self._gen_revision_history()
429
self._cache_revision_history(history)
433
"""Return current revision number for this branch.
435
That is equivalent to the number of revisions committed to
438
return self.last_revision_info()[0]
441
"""Older format branches cannot bind or unbind."""
442
raise errors.UpgradeRequired(self.base)
444
def set_append_revisions_only(self, enabled):
445
"""Older format branches are never restricted to append-only"""
446
raise errors.UpgradeRequired(self.base)
448
def last_revision(self):
449
"""Return last revision id, or NULL_REVISION."""
450
return self.last_revision_info()[1]
453
def last_revision_info(self):
454
"""Return information about the last revision.
456
:return: A tuple (revno, revision_id).
458
if self._last_revision_info_cache is None:
459
self._last_revision_info_cache = self._last_revision_info()
460
return self._last_revision_info_cache
462
def _last_revision_info(self):
463
rh = self.revision_history()
466
return (revno, rh[-1])
468
return (0, _mod_revision.NULL_REVISION)
470
@deprecated_method(deprecated_in((1, 6, 0)))
471
def missing_revisions(self, other, stop_revision=None):
472
"""Return a list of new revisions that would perfectly fit.
474
If self and other have not diverged, return a list of the revisions
475
present in other, but missing from self.
477
self_history = self.revision_history()
478
self_len = len(self_history)
479
other_history = other.revision_history()
480
other_len = len(other_history)
481
common_index = min(self_len, other_len) -1
482
if common_index >= 0 and \
483
self_history[common_index] != other_history[common_index]:
484
raise errors.DivergedBranches(self, other)
486
if stop_revision is None:
487
stop_revision = other_len
489
if stop_revision > other_len:
490
raise errors.NoSuchRevision(self, stop_revision)
491
return other_history[self_len:stop_revision]
494
def update_revisions(self, other, stop_revision=None, overwrite=False,
496
"""Pull in new perfect-fit revisions.
498
:param other: Another Branch to pull from
499
:param stop_revision: Updated until the given revision
500
:param overwrite: Always set the branch pointer, rather than checking
501
to see if it is a proper descendant.
502
:param graph: A Graph object that can be used to query history
503
information. This can be None.
508
other_revno, other_last_revision = other.last_revision_info()
509
stop_revno = None # unknown
510
if stop_revision is None:
511
stop_revision = other_last_revision
512
if _mod_revision.is_null(stop_revision):
513
# if there are no commits, we're done.
515
stop_revno = other_revno
517
# what's the current last revision, before we fetch [and change it
519
last_rev = _mod_revision.ensure_null(self.last_revision())
520
# we fetch here so that we don't process data twice in the common
521
# case of having something to pull, and so that the check for
522
# already merged can operate on the just fetched graph, which will
523
# be cached in memory.
524
self.fetch(other, stop_revision)
525
# Check to see if one is an ancestor of the other
528
graph = self.repository.get_graph()
529
if self._check_if_descendant_or_diverged(
530
stop_revision, last_rev, graph, other):
531
# stop_revision is a descendant of last_rev, but we aren't
532
# overwriting, so we're done.
534
if stop_revno is None:
536
graph = self.repository.get_graph()
537
this_revno, this_last_revision = self.last_revision_info()
538
stop_revno = graph.find_distance_to_null(stop_revision,
539
[(other_last_revision, other_revno),
540
(this_last_revision, this_revno)])
541
self.set_last_revision_info(stop_revno, stop_revision)
545
def revision_id_to_revno(self, revision_id):
546
"""Given a revision id, return its revno"""
547
if _mod_revision.is_null(revision_id):
549
history = self.revision_history()
551
return history.index(revision_id) + 1
553
raise errors.NoSuchRevision(self, revision_id)
555
def get_rev_id(self, revno, history=None):
556
"""Find the revision id of the specified revno."""
558
return _mod_revision.NULL_REVISION
560
history = self.revision_history()
561
if revno <= 0 or revno > len(history):
562
raise errors.NoSuchRevision(self, revno)
563
return history[revno - 1]
565
def pull(self, source, overwrite=False, stop_revision=None,
566
possible_transports=None, _override_hook_target=None):
567
"""Mirror source into this branch.
569
This branch is considered to be 'local', having low latency.
571
:returns: PullResult instance
573
raise NotImplementedError(self.pull)
575
def push(self, target, overwrite=False, stop_revision=None):
576
"""Mirror this branch into target.
578
This branch is considered to be 'local', having low latency.
580
raise NotImplementedError(self.push)
582
def basis_tree(self):
583
"""Return `Tree` object for last revision."""
584
return self.repository.revision_tree(self.last_revision())
586
def get_parent(self):
587
"""Return the parent location of the branch.
589
This is the default location for push/pull/missing. The usual
590
pattern is that the user can override it by specifying a
593
raise NotImplementedError(self.get_parent)
595
def _set_config_location(self, name, url, config=None,
596
make_relative=False):
598
config = self.get_config()
602
url = urlutils.relative_url(self.base, url)
603
config.set_user_option(name, url, warn_masked=True)
605
def _get_config_location(self, name, config=None):
607
config = self.get_config()
608
location = config.get_user_option(name)
613
def get_submit_branch(self):
614
"""Return the submit location of the branch.
616
This is the default location for bundle. The usual
617
pattern is that the user can override it by specifying a
620
return self.get_config().get_user_option('submit_branch')
622
def set_submit_branch(self, location):
623
"""Return the submit location of the branch.
625
This is the default location for bundle. The usual
626
pattern is that the user can override it by specifying a
629
self.get_config().set_user_option('submit_branch', location,
632
def get_public_branch(self):
633
"""Return the public location of the branch.
635
This is is used by merge directives.
637
return self._get_config_location('public_branch')
639
def set_public_branch(self, location):
640
"""Return the submit location of the branch.
642
This is the default location for bundle. The usual
643
pattern is that the user can override it by specifying a
646
self._set_config_location('public_branch', location)
648
def get_push_location(self):
649
"""Return the None or the location to push this branch to."""
650
push_loc = self.get_config().get_user_option('push_location')
653
def set_push_location(self, location):
654
"""Set a new push location for this branch."""
655
raise NotImplementedError(self.set_push_location)
657
def set_parent(self, url):
658
raise NotImplementedError(self.set_parent)
662
"""Synchronise this branch with the master branch if any.
664
:return: None or the last_revision pivoted out during the update.
668
def check_revno(self, revno):
670
Check whether a revno corresponds to any revision.
671
Zero (the NULL revision) is considered valid.
674
self.check_real_revno(revno)
676
def check_real_revno(self, revno):
678
Check whether a revno corresponds to a real revision.
679
Zero (the NULL revision) is considered invalid
681
if revno < 1 or revno > self.revno():
682
raise errors.InvalidRevisionNumber(revno)
685
def clone(self, to_bzrdir, revision_id=None):
686
"""Clone this branch into to_bzrdir preserving all semantic values.
688
revision_id: if not None, the revision history in the new branch will
689
be truncated to end with revision_id.
691
result = to_bzrdir.create_branch()
692
self.copy_content_into(result, revision_id=revision_id)
696
def sprout(self, to_bzrdir, revision_id=None):
697
"""Create a new line of development from the branch, into to_bzrdir.
699
to_bzrdir controls the branch format.
701
revision_id: if not None, the revision history in the new branch will
702
be truncated to end with revision_id.
704
result = to_bzrdir.create_branch()
705
self.copy_content_into(result, revision_id=revision_id)
706
result.set_parent(self.bzrdir.root_transport.base)
709
def _synchronize_history(self, destination, revision_id):
710
"""Synchronize last revision and revision history between branches.
712
This version is most efficient when the destination is also a
713
BzrBranch6, but works for BzrBranch5, as long as the destination's
714
repository contains all the lefthand ancestors of the intended
715
last_revision. If not, set_last_revision_info will fail.
717
:param destination: The branch to copy the history into
718
:param revision_id: The revision-id to truncate history at. May
719
be None to copy complete history.
721
source_revno, source_revision_id = self.last_revision_info()
722
if revision_id is None:
723
revno, revision_id = source_revno, source_revision_id
724
elif source_revision_id == revision_id:
725
# we know the revno without needing to walk all of history
728
# To figure out the revno for a random revision, we need to build
729
# the revision history, and count its length.
730
# We don't care about the order, just how long it is.
731
# Alternatively, we could start at the current location, and count
732
# backwards. But there is no guarantee that we will find it since
733
# it may be a merged revision.
734
revno = len(list(self.repository.iter_reverse_revision_history(
736
destination.set_last_revision_info(revno, revision_id)
739
def copy_content_into(self, destination, revision_id=None):
740
"""Copy the content of self into destination.
742
revision_id: if not None, the revision history in the new branch will
743
be truncated to end with revision_id.
745
self._synchronize_history(destination, revision_id)
747
parent = self.get_parent()
748
except errors.InaccessibleParent, e:
749
mutter('parent was not accessible to copy: %s', e)
752
destination.set_parent(parent)
753
self.tags.merge_to(destination.tags)
757
"""Check consistency of the branch.
759
In particular this checks that revisions given in the revision-history
760
do actually match up in the revision graph, and that they're all
761
present in the repository.
763
Callers will typically also want to check the repository.
765
:return: A BranchCheckResult.
767
mainline_parent_id = None
768
last_revno, last_revision_id = self.last_revision_info()
769
real_rev_history = list(self.repository.iter_reverse_revision_history(
771
real_rev_history.reverse()
772
if len(real_rev_history) != last_revno:
773
raise errors.BzrCheckError('revno does not match len(mainline)'
774
' %s != %s' % (last_revno, len(real_rev_history)))
775
# TODO: We should probably also check that real_rev_history actually
776
# matches self.revision_history()
777
for revision_id in real_rev_history:
779
revision = self.repository.get_revision(revision_id)
780
except errors.NoSuchRevision, e:
781
raise errors.BzrCheckError("mainline revision {%s} not in repository"
783
# In general the first entry on the revision history has no parents.
784
# But it's not illegal for it to have parents listed; this can happen
785
# in imports from Arch when the parents weren't reachable.
786
if mainline_parent_id is not None:
787
if mainline_parent_id not in revision.parent_ids:
788
raise errors.BzrCheckError("previous revision {%s} not listed among "
790
% (mainline_parent_id, revision_id))
791
mainline_parent_id = revision_id
792
return BranchCheckResult(self)
794
def _get_checkout_format(self):
795
"""Return the most suitable metadir for a checkout of this branch.
796
Weaves are used if this branch's repository uses weaves.
798
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
799
from bzrlib.repofmt import weaverepo
800
format = bzrdir.BzrDirMetaFormat1()
801
format.repository_format = weaverepo.RepositoryFormat7()
803
format = self.repository.bzrdir.checkout_metadir()
804
format.set_branch_format(self._format)
807
def create_checkout(self, to_location, revision_id=None,
808
lightweight=False, accelerator_tree=None,
810
"""Create a checkout of a branch.
812
:param to_location: The url to produce the checkout at
813
:param revision_id: The revision to check out
814
:param lightweight: If True, produce a lightweight checkout, otherwise,
815
produce a bound branch (heavyweight checkout)
816
:param accelerator_tree: A tree which can be used for retrieving file
817
contents more quickly than the revision tree, i.e. a workingtree.
818
The revision tree will be used for cases where accelerator_tree's
819
content is different.
820
:param hardlink: If true, hard-link files from accelerator_tree,
822
:return: The tree of the created checkout
824
t = transport.get_transport(to_location)
827
format = self._get_checkout_format()
828
checkout = format.initialize_on_transport(t)
829
from_branch = BranchReferenceFormat().initialize(checkout, self)
831
format = self._get_checkout_format()
832
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
833
to_location, force_new_tree=False, format=format)
834
checkout = checkout_branch.bzrdir
835
checkout_branch.bind(self)
836
# pull up to the specified revision_id to set the initial
837
# branch tip correctly, and seed it with history.
838
checkout_branch.pull(self, stop_revision=revision_id)
840
tree = checkout.create_workingtree(revision_id,
841
from_branch=from_branch,
842
accelerator_tree=accelerator_tree,
844
basis_tree = tree.basis_tree()
845
basis_tree.lock_read()
847
for path, file_id in basis_tree.iter_references():
848
reference_parent = self.reference_parent(file_id, path)
849
reference_parent.create_checkout(tree.abspath(path),
850
basis_tree.get_reference_revision(file_id, path),
857
def reconcile(self, thorough=True):
858
"""Make sure the data stored in this branch is consistent."""
859
from bzrlib.reconcile import BranchReconciler
860
reconciler = BranchReconciler(self, thorough=thorough)
861
reconciler.reconcile()
864
def reference_parent(self, file_id, path):
865
"""Return the parent branch for a tree-reference file_id
866
:param file_id: The file_id of the tree reference
867
:param path: The path of the file_id in the tree
868
:return: A branch associated with the file_id
870
# FIXME should provide multiple branches, based on config
871
return Branch.open(self.bzrdir.root_transport.clone(path).base)
873
def supports_tags(self):
874
return self._format.supports_tags()
876
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
878
"""Ensure that revision_b is a descendant of revision_a.
880
This is a helper function for update_revisions.
882
:raises: DivergedBranches if revision_b has diverged from revision_a.
883
:returns: True if revision_b is a descendant of revision_a.
885
relation = self._revision_relations(revision_a, revision_b, graph)
886
if relation == 'b_descends_from_a':
888
elif relation == 'diverged':
889
raise errors.DivergedBranches(self, other_branch)
890
elif relation == 'a_descends_from_b':
893
raise AssertionError("invalid relation: %r" % (relation,))
895
def _revision_relations(self, revision_a, revision_b, graph):
896
"""Determine the relationship between two revisions.
898
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
900
heads = graph.heads([revision_a, revision_b])
901
if heads == set([revision_b]):
902
return 'b_descends_from_a'
903
elif heads == set([revision_a, revision_b]):
904
# These branches have diverged
906
elif heads == set([revision_a]):
907
return 'a_descends_from_b'
909
raise AssertionError("invalid heads: %r" % (heads,))
912
class BranchFormat(object):
913
"""An encapsulation of the initialization and open routines for a format.
915
Formats provide three things:
916
* An initialization routine,
920
Formats are placed in an dict by their format string for reference
921
during branch opening. Its not required that these be instances, they
922
can be classes themselves with class methods - it simply depends on
923
whether state is needed for a given format or not.
925
Once a format is deprecated, just deprecate the initialize and open
926
methods on the format class. Do not deprecate the object, as the
927
object will be created every time regardless.
930
_default_format = None
931
"""The default format used for new branches."""
934
"""The known formats."""
936
def __eq__(self, other):
937
return self.__class__ is other.__class__
939
def __ne__(self, other):
940
return not (self == other)
943
def find_format(klass, a_bzrdir):
944
"""Return the format for the branch object in a_bzrdir."""
946
transport = a_bzrdir.get_branch_transport(None)
947
format_string = transport.get("format").read()
948
return klass._formats[format_string]
949
except errors.NoSuchFile:
950
raise errors.NotBranchError(path=transport.base)
952
raise errors.UnknownFormatError(format=format_string, kind='branch')
955
def get_default_format(klass):
956
"""Return the current default format."""
957
return klass._default_format
959
def get_reference(self, a_bzrdir):
960
"""Get the target reference of the branch in a_bzrdir.
962
format probing must have been completed before calling
963
this method - it is assumed that the format of the branch
964
in a_bzrdir is correct.
966
:param a_bzrdir: The bzrdir to get the branch data from.
967
:return: None if the branch is not a reference branch.
972
def set_reference(self, a_bzrdir, to_branch):
973
"""Set the target reference of the branch in a_bzrdir.
975
format probing must have been completed before calling
976
this method - it is assumed that the format of the branch
977
in a_bzrdir is correct.
979
:param a_bzrdir: The bzrdir to set the branch reference for.
980
:param to_branch: branch that the checkout is to reference
982
raise NotImplementedError(self.set_reference)
984
def get_format_string(self):
985
"""Return the ASCII format string that identifies this format."""
986
raise NotImplementedError(self.get_format_string)
988
def get_format_description(self):
989
"""Return the short format description for this format."""
990
raise NotImplementedError(self.get_format_description)
992
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
994
"""Initialize a branch in a bzrdir, with specified files
996
:param a_bzrdir: The bzrdir to initialize the branch in
997
:param utf8_files: The files to create as a list of
998
(filename, content) tuples
999
:param set_format: If True, set the format with
1000
self.get_format_string. (BzrBranch4 has its format set
1002
:return: a branch in this format
1004
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1005
branch_transport = a_bzrdir.get_branch_transport(self)
1007
'metadir': ('lock', lockdir.LockDir),
1008
'branch4': ('branch-lock', lockable_files.TransportLock),
1010
lock_name, lock_class = lock_map[lock_type]
1011
control_files = lockable_files.LockableFiles(branch_transport,
1012
lock_name, lock_class)
1013
control_files.create_lock()
1014
control_files.lock_write()
1016
utf8_files += [('format', self.get_format_string())]
1018
for (filename, content) in utf8_files:
1019
branch_transport.put_bytes(
1021
mode=a_bzrdir._get_file_mode())
1023
control_files.unlock()
1024
return self.open(a_bzrdir, _found=True)
1026
def initialize(self, a_bzrdir):
1027
"""Create a branch of this format in a_bzrdir."""
1028
raise NotImplementedError(self.initialize)
1030
def is_supported(self):
1031
"""Is this format supported?
1033
Supported formats can be initialized and opened.
1034
Unsupported formats may not support initialization or committing or
1035
some other features depending on the reason for not being supported.
1039
def open(self, a_bzrdir, _found=False):
1040
"""Return the branch object for a_bzrdir
1042
_found is a private parameter, do not use it. It is used to indicate
1043
if format probing has already be done.
1045
raise NotImplementedError(self.open)
1048
def register_format(klass, format):
1049
klass._formats[format.get_format_string()] = format
1052
def set_default_format(klass, format):
1053
klass._default_format = format
1055
def supports_stacking(self):
1056
"""True if this format records a stacked-on branch."""
1060
def unregister_format(klass, format):
1061
del klass._formats[format.get_format_string()]
1064
return self.get_format_string().rstrip()
1066
def supports_tags(self):
1067
"""True if this format supports tags stored in the branch"""
1068
return False # by default
1071
class BranchHooks(Hooks):
1072
"""A dictionary mapping hook name to a list of callables for branch hooks.
1074
e.g. ['set_rh'] Is the list of items to be called when the
1075
set_revision_history function is invoked.
1079
"""Create the default hooks.
1081
These are all empty initially, because by default nothing should get
1084
Hooks.__init__(self)
1085
# Introduced in 0.15:
1086
# invoked whenever the revision history has been set
1087
# with set_revision_history. The api signature is
1088
# (branch, revision_history), and the branch will
1091
# Invoked after a branch is opened. The api signature is (branch).
1093
# invoked after a push operation completes.
1094
# the api signature is
1096
# containing the members
1097
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1098
# where local is the local target branch or None, master is the target
1099
# master branch, and the rest should be self explanatory. The source
1100
# is read locked and the target branches write locked. Source will
1101
# be the local low-latency branch.
1102
self['post_push'] = []
1103
# invoked after a pull operation completes.
1104
# the api signature is
1106
# containing the members
1107
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1108
# where local is the local branch or None, master is the target
1109
# master branch, and the rest should be self explanatory. The source
1110
# is read locked and the target branches write locked. The local
1111
# branch is the low-latency branch.
1112
self['post_pull'] = []
1113
# invoked before a commit operation takes place.
1114
# the api signature is
1115
# (local, master, old_revno, old_revid, future_revno, future_revid,
1116
# tree_delta, future_tree).
1117
# old_revid is NULL_REVISION for the first commit to a branch
1118
# tree_delta is a TreeDelta object describing changes from the basis
1119
# revision, hooks MUST NOT modify this delta
1120
# future_tree is an in-memory tree obtained from
1121
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1122
self['pre_commit'] = []
1123
# invoked after a commit operation completes.
1124
# the api signature is
1125
# (local, master, old_revno, old_revid, new_revno, new_revid)
1126
# old_revid is NULL_REVISION for the first commit to a branch.
1127
self['post_commit'] = []
1128
# invoked after a uncommit operation completes.
1129
# the api signature is
1130
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1131
# local is the local branch or None, master is the target branch,
1132
# and an empty branch recieves new_revno of 0, new_revid of None.
1133
self['post_uncommit'] = []
1135
# Invoked before the tip of a branch changes.
1136
# the api signature is
1137
# (params) where params is a ChangeBranchTipParams with the members
1138
# (branch, old_revno, new_revno, old_revid, new_revid)
1139
self['pre_change_branch_tip'] = []
1141
# Invoked after the tip of a branch changes.
1142
# the api signature is
1143
# (params) where params is a ChangeBranchTipParams with the members
1144
# (branch, old_revno, new_revno, old_revid, new_revid)
1145
self['post_change_branch_tip'] = []
1147
# Invoked when a stacked branch activates its fallback locations and
1148
# allows the transformation of the url of said location.
1149
# the api signature is
1150
# (branch, url) where branch is the branch having its fallback
1151
# location activated and url is the url for the fallback location.
1152
# The hook should return a url.
1153
self['transform_fallback_location'] = []
1156
# install the default hooks into the Branch class.
1157
Branch.hooks = BranchHooks()
1160
class ChangeBranchTipParams(object):
1161
"""Object holding parameters passed to *_change_branch_tip hooks.
1163
There are 5 fields that hooks may wish to access:
1165
:ivar branch: the branch being changed
1166
:ivar old_revno: revision number before the change
1167
:ivar new_revno: revision number after the change
1168
:ivar old_revid: revision id before the change
1169
:ivar new_revid: revision id after the change
1171
The revid fields are strings. The revno fields are integers.
1174
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1175
"""Create a group of ChangeBranchTip parameters.
1177
:param branch: The branch being changed.
1178
:param old_revno: Revision number before the change.
1179
:param new_revno: Revision number after the change.
1180
:param old_revid: Tip revision id before the change.
1181
:param new_revid: Tip revision id after the change.
1183
self.branch = branch
1184
self.old_revno = old_revno
1185
self.new_revno = new_revno
1186
self.old_revid = old_revid
1187
self.new_revid = new_revid
1189
def __eq__(self, other):
1190
return self.__dict__ == other.__dict__
1193
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1194
self.__class__.__name__, self.branch,
1195
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1198
class BzrBranchFormat4(BranchFormat):
1199
"""Bzr branch format 4.
1202
- a revision-history file.
1203
- a branch-lock lock file [ to be shared with the bzrdir ]
1206
def get_format_description(self):
1207
"""See BranchFormat.get_format_description()."""
1208
return "Branch format 4"
1210
def initialize(self, a_bzrdir):
1211
"""Create a branch of this format in a_bzrdir."""
1212
utf8_files = [('revision-history', ''),
1213
('branch-name', ''),
1215
return self._initialize_helper(a_bzrdir, utf8_files,
1216
lock_type='branch4', set_format=False)
1219
super(BzrBranchFormat4, self).__init__()
1220
self._matchingbzrdir = bzrdir.BzrDirFormat6()
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
# we are being called directly and must probe.
1230
raise NotImplementedError
1231
return BzrBranch(_format=self,
1232
_control_files=a_bzrdir._control_files,
1234
_repository=a_bzrdir.open_repository())
1237
return "Bazaar-NG branch format 4"
1240
class BranchFormatMetadir(BranchFormat):
1241
"""Common logic for meta-dir based branch formats."""
1243
def _branch_class(self):
1244
"""What class to instantiate on open calls."""
1245
raise NotImplementedError(self._branch_class)
1247
def open(self, a_bzrdir, _found=False):
1248
"""Return the branch object for a_bzrdir.
1250
_found is a private parameter, do not use it. It is used to indicate
1251
if format probing has already be done.
1254
format = BranchFormat.find_format(a_bzrdir)
1255
if format.__class__ != self.__class__:
1256
raise AssertionError("wrong format %r found for %r" %
1259
transport = a_bzrdir.get_branch_transport(None)
1260
control_files = lockable_files.LockableFiles(transport, 'lock',
1262
return self._branch_class()(_format=self,
1263
_control_files=control_files,
1265
_repository=a_bzrdir.find_repository())
1266
except errors.NoSuchFile:
1267
raise errors.NotBranchError(path=transport.base)
1270
super(BranchFormatMetadir, self).__init__()
1271
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1272
self._matchingbzrdir.set_branch_format(self)
1274
def supports_tags(self):
1278
class BzrBranchFormat5(BranchFormatMetadir):
1279
"""Bzr branch format 5.
1282
- a revision-history file.
1284
- a lock dir guarding the branch itself
1285
- all of this stored in a branch/ subdirectory
1286
- works with shared repositories.
1288
This format is new in bzr 0.8.
1291
def _branch_class(self):
1294
def get_format_string(self):
1295
"""See BranchFormat.get_format_string()."""
1296
return "Bazaar-NG branch format 5\n"
1298
def get_format_description(self):
1299
"""See BranchFormat.get_format_description()."""
1300
return "Branch format 5"
1302
def initialize(self, a_bzrdir):
1303
"""Create a branch of this format in a_bzrdir."""
1304
utf8_files = [('revision-history', ''),
1305
('branch-name', ''),
1307
return self._initialize_helper(a_bzrdir, utf8_files)
1309
def supports_tags(self):
1313
class BzrBranchFormat6(BranchFormatMetadir):
1314
"""Branch format with last-revision and tags.
1316
Unlike previous formats, this has no explicit revision history. Instead,
1317
this just stores the last-revision, and the left-hand history leading
1318
up to there is the history.
1320
This format was introduced in bzr 0.15
1321
and became the default in 0.91.
1324
def _branch_class(self):
1327
def get_format_string(self):
1328
"""See BranchFormat.get_format_string()."""
1329
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1331
def get_format_description(self):
1332
"""See BranchFormat.get_format_description()."""
1333
return "Branch format 6"
1335
def initialize(self, a_bzrdir):
1336
"""Create a branch of this format in a_bzrdir."""
1337
utf8_files = [('last-revision', '0 null:\n'),
1338
('branch.conf', ''),
1341
return self._initialize_helper(a_bzrdir, utf8_files)
1344
class BzrBranchFormat7(BranchFormatMetadir):
1345
"""Branch format with last-revision, tags, and a stacked location pointer.
1347
The stacked location pointer is passed down to the repository and requires
1348
a repository format with supports_external_lookups = True.
1350
This format was introduced in bzr 1.6.
1353
def _branch_class(self):
1356
def get_format_string(self):
1357
"""See BranchFormat.get_format_string()."""
1358
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1360
def get_format_description(self):
1361
"""See BranchFormat.get_format_description()."""
1362
return "Branch format 7"
1364
def initialize(self, a_bzrdir):
1365
"""Create a branch of this format in a_bzrdir."""
1366
utf8_files = [('last-revision', '0 null:\n'),
1367
('branch.conf', ''),
1370
return self._initialize_helper(a_bzrdir, utf8_files)
1373
super(BzrBranchFormat7, self).__init__()
1374
self._matchingbzrdir.repository_format = \
1375
RepositoryFormatKnitPack5RichRoot()
1377
def supports_stacking(self):
1381
class BranchReferenceFormat(BranchFormat):
1382
"""Bzr branch reference format.
1384
Branch references are used in implementing checkouts, they
1385
act as an alias to the real branch which is at some other url.
1392
def get_format_string(self):
1393
"""See BranchFormat.get_format_string()."""
1394
return "Bazaar-NG Branch Reference Format 1\n"
1396
def get_format_description(self):
1397
"""See BranchFormat.get_format_description()."""
1398
return "Checkout reference format 1"
1400
def get_reference(self, a_bzrdir):
1401
"""See BranchFormat.get_reference()."""
1402
transport = a_bzrdir.get_branch_transport(None)
1403
return transport.get('location').read()
1405
def set_reference(self, a_bzrdir, to_branch):
1406
"""See BranchFormat.set_reference()."""
1407
transport = a_bzrdir.get_branch_transport(None)
1408
location = transport.put_bytes('location', to_branch.base)
1410
def initialize(self, a_bzrdir, target_branch=None):
1411
"""Create a branch of this format in a_bzrdir."""
1412
if target_branch is None:
1413
# this format does not implement branch itself, thus the implicit
1414
# creation contract must see it as uninitializable
1415
raise errors.UninitializableFormat(self)
1416
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1417
branch_transport = a_bzrdir.get_branch_transport(self)
1418
branch_transport.put_bytes('location',
1419
target_branch.bzrdir.root_transport.base)
1420
branch_transport.put_bytes('format', self.get_format_string())
1422
a_bzrdir, _found=True,
1423
possible_transports=[target_branch.bzrdir.root_transport])
1426
super(BranchReferenceFormat, self).__init__()
1427
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1428
self._matchingbzrdir.set_branch_format(self)
1430
def _make_reference_clone_function(format, a_branch):
1431
"""Create a clone() routine for a branch dynamically."""
1432
def clone(to_bzrdir, revision_id=None):
1433
"""See Branch.clone()."""
1434
return format.initialize(to_bzrdir, a_branch)
1435
# cannot obey revision_id limits when cloning a reference ...
1436
# FIXME RBC 20060210 either nuke revision_id for clone, or
1437
# emit some sort of warning/error to the caller ?!
1440
def open(self, a_bzrdir, _found=False, location=None,
1441
possible_transports=None):
1442
"""Return the branch that the branch reference in a_bzrdir points at.
1444
_found is a private parameter, do not use it. It is used to indicate
1445
if format probing has already be done.
1448
format = BranchFormat.find_format(a_bzrdir)
1449
if format.__class__ != self.__class__:
1450
raise AssertionError("wrong format %r found for %r" %
1452
if location is None:
1453
location = self.get_reference(a_bzrdir)
1454
real_bzrdir = bzrdir.BzrDir.open(
1455
location, possible_transports=possible_transports)
1456
result = real_bzrdir.open_branch()
1457
# this changes the behaviour of result.clone to create a new reference
1458
# rather than a copy of the content of the branch.
1459
# I did not use a proxy object because that needs much more extensive
1460
# testing, and we are only changing one behaviour at the moment.
1461
# If we decide to alter more behaviours - i.e. the implicit nickname
1462
# then this should be refactored to introduce a tested proxy branch
1463
# and a subclass of that for use in overriding clone() and ....
1465
result.clone = self._make_reference_clone_function(result)
1469
# formats which have no format string are not discoverable
1470
# and not independently creatable, so are not registered.
1471
__format5 = BzrBranchFormat5()
1472
__format6 = BzrBranchFormat6()
1473
__format7 = BzrBranchFormat7()
1474
BranchFormat.register_format(__format5)
1475
BranchFormat.register_format(BranchReferenceFormat())
1476
BranchFormat.register_format(__format6)
1477
BranchFormat.register_format(__format7)
1478
BranchFormat.set_default_format(__format6)
1479
_legacy_formats = [BzrBranchFormat4(),
1482
class BzrBranch(Branch):
1483
"""A branch stored in the actual filesystem.
1485
Note that it's "local" in the context of the filesystem; it doesn't
1486
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1487
it's writable, and can be accessed via the normal filesystem API.
1489
:ivar _transport: Transport for file operations on this branch's
1490
control files, typically pointing to the .bzr/branch directory.
1491
:ivar repository: Repository for this branch.
1492
:ivar base: The url of the base directory for this branch; the one
1493
containing the .bzr directory.
1496
def __init__(self, _format=None,
1497
_control_files=None, a_bzrdir=None, _repository=None):
1498
"""Create new branch object at a particular location."""
1499
if a_bzrdir is None:
1500
raise ValueError('a_bzrdir must be supplied')
1502
self.bzrdir = a_bzrdir
1503
self._base = self.bzrdir.transport.clone('..').base
1504
# XXX: We should be able to just do
1505
# self.base = self.bzrdir.root_transport.base
1506
# but this does not quite work yet -- mbp 20080522
1507
self._format = _format
1508
if _control_files is None:
1509
raise ValueError('BzrBranch _control_files is None')
1510
self.control_files = _control_files
1511
self._transport = _control_files._transport
1512
self.repository = _repository
1513
Branch.__init__(self)
1516
return '%s(%r)' % (self.__class__.__name__, self.base)
1520
def _get_base(self):
1521
"""Returns the directory containing the control directory."""
1524
base = property(_get_base, doc="The URL for the root of this branch.")
1526
def is_locked(self):
1527
return self.control_files.is_locked()
1529
def lock_write(self, token=None):
1530
repo_token = self.repository.lock_write()
1532
token = self.control_files.lock_write(token=token)
1534
self.repository.unlock()
1538
def lock_read(self):
1539
self.repository.lock_read()
1541
self.control_files.lock_read()
1543
self.repository.unlock()
1547
# TODO: test for failed two phase locks. This is known broken.
1549
self.control_files.unlock()
1551
self.repository.unlock()
1552
if not self.control_files.is_locked():
1553
# we just released the lock
1554
self._clear_cached_state()
1556
def peek_lock_mode(self):
1557
if self.control_files._lock_count == 0:
1560
return self.control_files._lock_mode
1562
def get_physical_lock_status(self):
1563
return self.control_files.get_physical_lock_status()
1566
def print_file(self, file, revision_id):
1567
"""See Branch.print_file."""
1568
return self.repository.print_file(file, revision_id)
1570
def _write_revision_history(self, history):
1571
"""Factored out of set_revision_history.
1573
This performs the actual writing to disk.
1574
It is intended to be called by BzrBranch5.set_revision_history."""
1575
self._transport.put_bytes(
1576
'revision-history', '\n'.join(history),
1577
mode=self.bzrdir._get_file_mode())
1580
def set_revision_history(self, rev_history):
1581
"""See Branch.set_revision_history."""
1582
if 'evil' in debug.debug_flags:
1583
mutter_callsite(3, "set_revision_history scales with history.")
1584
check_not_reserved_id = _mod_revision.check_not_reserved_id
1585
for rev_id in rev_history:
1586
check_not_reserved_id(rev_id)
1587
if Branch.hooks['post_change_branch_tip']:
1588
# Don't calculate the last_revision_info() if there are no hooks
1590
old_revno, old_revid = self.last_revision_info()
1591
if len(rev_history) == 0:
1592
revid = _mod_revision.NULL_REVISION
1594
revid = rev_history[-1]
1595
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1596
self._write_revision_history(rev_history)
1597
self._clear_cached_state()
1598
self._cache_revision_history(rev_history)
1599
for hook in Branch.hooks['set_rh']:
1600
hook(self, rev_history)
1601
if Branch.hooks['post_change_branch_tip']:
1602
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1604
def _synchronize_history(self, destination, revision_id):
1605
"""Synchronize last revision and revision history between branches.
1607
This version is most efficient when the destination is also a
1608
BzrBranch5, but works for BzrBranch6 as long as the revision
1609
history is the true lefthand parent history, and all of the revisions
1610
are in the destination's repository. If not, set_revision_history
1613
:param destination: The branch to copy the history into
1614
:param revision_id: The revision-id to truncate history at. May
1615
be None to copy complete history.
1617
if not isinstance(destination._format, BzrBranchFormat5):
1618
super(BzrBranch, self)._synchronize_history(
1619
destination, revision_id)
1621
if revision_id == _mod_revision.NULL_REVISION:
1624
new_history = self.revision_history()
1625
if revision_id is not None and new_history != []:
1627
new_history = new_history[:new_history.index(revision_id) + 1]
1629
rev = self.repository.get_revision(revision_id)
1630
new_history = rev.get_history(self.repository)[1:]
1631
destination.set_revision_history(new_history)
1633
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1634
"""Run the pre_change_branch_tip hooks."""
1635
hooks = Branch.hooks['pre_change_branch_tip']
1638
old_revno, old_revid = self.last_revision_info()
1639
params = ChangeBranchTipParams(
1640
self, old_revno, new_revno, old_revid, new_revid)
1644
except errors.TipChangeRejected:
1647
exc_info = sys.exc_info()
1648
hook_name = Branch.hooks.get_hook_name(hook)
1649
raise errors.HookFailed(
1650
'pre_change_branch_tip', hook_name, exc_info)
1652
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1653
"""Run the post_change_branch_tip hooks."""
1654
hooks = Branch.hooks['post_change_branch_tip']
1657
new_revno, new_revid = self.last_revision_info()
1658
params = ChangeBranchTipParams(
1659
self, old_revno, new_revno, old_revid, new_revid)
1664
def set_last_revision_info(self, revno, revision_id):
1665
"""Set the last revision of this branch.
1667
The caller is responsible for checking that the revno is correct
1668
for this revision id.
1670
It may be possible to set the branch last revision to an id not
1671
present in the repository. However, branches can also be
1672
configured to check constraints on history, in which case this may not
1675
revision_id = _mod_revision.ensure_null(revision_id)
1676
# this old format stores the full history, but this api doesn't
1677
# provide it, so we must generate, and might as well check it's
1679
history = self._lefthand_history(revision_id)
1680
if len(history) != revno:
1681
raise AssertionError('%d != %d' % (len(history), revno))
1682
self.set_revision_history(history)
1684
def _gen_revision_history(self):
1685
history = self._transport.get_bytes('revision-history').split('\n')
1686
if history[-1:] == ['']:
1687
# There shouldn't be a trailing newline, but just in case.
1691
def _lefthand_history(self, revision_id, last_rev=None,
1693
if 'evil' in debug.debug_flags:
1694
mutter_callsite(4, "_lefthand_history scales with history.")
1695
# stop_revision must be a descendant of last_revision
1696
graph = self.repository.get_graph()
1697
if last_rev is not None:
1698
if not graph.is_ancestor(last_rev, revision_id):
1699
# our previous tip is not merged into stop_revision
1700
raise errors.DivergedBranches(self, other_branch)
1701
# make a new revision history from the graph
1702
parents_map = graph.get_parent_map([revision_id])
1703
if revision_id not in parents_map:
1704
raise errors.NoSuchRevision(self, revision_id)
1705
current_rev_id = revision_id
1707
check_not_reserved_id = _mod_revision.check_not_reserved_id
1708
# Do not include ghosts or graph origin in revision_history
1709
while (current_rev_id in parents_map and
1710
len(parents_map[current_rev_id]) > 0):
1711
check_not_reserved_id(current_rev_id)
1712
new_history.append(current_rev_id)
1713
current_rev_id = parents_map[current_rev_id][0]
1714
parents_map = graph.get_parent_map([current_rev_id])
1715
new_history.reverse()
1719
def generate_revision_history(self, revision_id, last_rev=None,
1721
"""Create a new revision history that will finish with revision_id.
1723
:param revision_id: the new tip to use.
1724
:param last_rev: The previous last_revision. If not None, then this
1725
must be a ancestory of revision_id, or DivergedBranches is raised.
1726
:param other_branch: The other branch that DivergedBranches should
1727
raise with respect to.
1729
self.set_revision_history(self._lefthand_history(revision_id,
1730
last_rev, other_branch))
1732
def basis_tree(self):
1733
"""See Branch.basis_tree."""
1734
return self.repository.revision_tree(self.last_revision())
1737
def pull(self, source, overwrite=False, stop_revision=None,
1738
_hook_master=None, run_hooks=True, possible_transports=None,
1739
_override_hook_target=None):
1742
:param _hook_master: Private parameter - set the branch to
1743
be supplied as the master to pull hooks.
1744
:param run_hooks: Private parameter - if false, this branch
1745
is being called because it's the master of the primary branch,
1746
so it should not run its hooks.
1747
:param _override_hook_target: Private parameter - set the branch to be
1748
supplied as the target_branch to pull hooks.
1750
result = PullResult()
1751
result.source_branch = source
1752
if _override_hook_target is None:
1753
result.target_branch = self
1755
result.target_branch = _override_hook_target
1758
# We assume that during 'pull' the local repository is closer than
1760
graph = self.repository.get_graph(source.repository)
1761
result.old_revno, result.old_revid = self.last_revision_info()
1762
self.update_revisions(source, stop_revision, overwrite=overwrite,
1764
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1765
result.new_revno, result.new_revid = self.last_revision_info()
1767
result.master_branch = _hook_master
1768
result.local_branch = result.target_branch
1770
result.master_branch = result.target_branch
1771
result.local_branch = None
1773
for hook in Branch.hooks['post_pull']:
1779
def _get_parent_location(self):
1780
_locs = ['parent', 'pull', 'x-pull']
1783
return self._transport.get_bytes(l).strip('\n')
1784
except errors.NoSuchFile:
1789
def push(self, target, overwrite=False, stop_revision=None,
1790
_override_hook_source_branch=None):
1793
This is the basic concrete implementation of push()
1795
:param _override_hook_source_branch: If specified, run
1796
the hooks passing this Branch as the source, rather than self.
1797
This is for use of RemoteBranch, where push is delegated to the
1798
underlying vfs-based Branch.
1800
# TODO: Public option to disable running hooks - should be trivial but
1802
return _run_with_write_locked_target(
1803
target, self._push_with_bound_branches, target, overwrite,
1805
_override_hook_source_branch=_override_hook_source_branch)
1807
def _push_with_bound_branches(self, target, overwrite,
1809
_override_hook_source_branch=None):
1810
"""Push from self into target, and into target's master if any.
1812
This is on the base BzrBranch class even though it doesn't support
1813
bound branches because the *target* might be bound.
1816
if _override_hook_source_branch:
1817
result.source_branch = _override_hook_source_branch
1818
for hook in Branch.hooks['post_push']:
1821
bound_location = target.get_bound_location()
1822
if bound_location and target.base != bound_location:
1823
# there is a master branch.
1825
# XXX: Why the second check? Is it even supported for a branch to
1826
# be bound to itself? -- mbp 20070507
1827
master_branch = target.get_master_branch()
1828
master_branch.lock_write()
1830
# push into the master from this branch.
1831
self._basic_push(master_branch, overwrite, stop_revision)
1832
# and push into the target branch from this. Note that we push from
1833
# this branch again, because its considered the highest bandwidth
1835
result = self._basic_push(target, overwrite, stop_revision)
1836
result.master_branch = master_branch
1837
result.local_branch = target
1841
master_branch.unlock()
1844
result = self._basic_push(target, overwrite, stop_revision)
1845
# TODO: Why set master_branch and local_branch if there's no
1846
# binding? Maybe cleaner to just leave them unset? -- mbp
1848
result.master_branch = target
1849
result.local_branch = None
1853
def _basic_push(self, target, overwrite, stop_revision):
1854
"""Basic implementation of push without bound branches or hooks.
1856
Must be called with self read locked and target write locked.
1858
result = PushResult()
1859
result.source_branch = self
1860
result.target_branch = target
1861
result.old_revno, result.old_revid = target.last_revision_info()
1862
if result.old_revid != self.last_revision():
1863
# We assume that during 'push' this repository is closer than
1865
graph = self.repository.get_graph(target.repository)
1866
target.update_revisions(self, stop_revision, overwrite=overwrite,
1868
if self._push_should_merge_tags():
1869
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1870
result.new_revno, result.new_revid = target.last_revision_info()
1873
def _push_should_merge_tags(self):
1874
"""Should _basic_push merge this branch's tags into the target?
1876
The default implementation returns False if this branch has no tags,
1877
and True the rest of the time. Subclasses may override this.
1879
return self.tags.supports_tags() and self.tags.get_tag_dict()
1881
def get_parent(self):
1882
"""See Branch.get_parent."""
1883
parent = self._get_parent_location()
1886
# This is an old-format absolute path to a local branch
1887
# turn it into a url
1888
if parent.startswith('/'):
1889
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1891
return urlutils.join(self.base[:-1], parent)
1892
except errors.InvalidURLJoin, e:
1893
raise errors.InaccessibleParent(parent, self.base)
1895
def get_stacked_on_url(self):
1896
raise errors.UnstackableBranchFormat(self._format, self.base)
1898
def set_push_location(self, location):
1899
"""See Branch.set_push_location."""
1900
self.get_config().set_user_option(
1901
'push_location', location,
1902
store=_mod_config.STORE_LOCATION_NORECURSE)
1905
def set_parent(self, url):
1906
"""See Branch.set_parent."""
1907
# TODO: Maybe delete old location files?
1908
# URLs should never be unicode, even on the local fs,
1909
# FIXUP this and get_parent in a future branch format bump:
1910
# read and rewrite the file. RBC 20060125
1912
if isinstance(url, unicode):
1914
url = url.encode('ascii')
1915
except UnicodeEncodeError:
1916
raise errors.InvalidURL(url,
1917
"Urls must be 7-bit ascii, "
1918
"use bzrlib.urlutils.escape")
1919
url = urlutils.relative_url(self.base, url)
1920
self._set_parent_location(url)
1922
def _set_parent_location(self, url):
1924
self._transport.delete('parent')
1926
self._transport.put_bytes('parent', url + '\n',
1927
mode=self.bzrdir._get_file_mode())
1929
def set_stacked_on_url(self, url):
1930
raise errors.UnstackableBranchFormat(self._format, self.base)
1933
class BzrBranch5(BzrBranch):
1934
"""A format 5 branch. This supports new features over plain branches.
1936
It has support for a master_branch which is the data for bound branches.
1940
def pull(self, source, overwrite=False, stop_revision=None,
1941
run_hooks=True, possible_transports=None,
1942
_override_hook_target=None):
1943
"""Pull from source into self, updating my master if any.
1945
:param run_hooks: Private parameter - if false, this branch
1946
is being called because it's the master of the primary branch,
1947
so it should not run its hooks.
1949
bound_location = self.get_bound_location()
1950
master_branch = None
1951
if bound_location and source.base != bound_location:
1952
# not pulling from master, so we need to update master.
1953
master_branch = self.get_master_branch(possible_transports)
1954
master_branch.lock_write()
1957
# pull from source into master.
1958
master_branch.pull(source, overwrite, stop_revision,
1960
return super(BzrBranch5, self).pull(source, overwrite,
1961
stop_revision, _hook_master=master_branch,
1962
run_hooks=run_hooks,
1963
_override_hook_target=_override_hook_target)
1966
master_branch.unlock()
1968
def get_bound_location(self):
1970
return self._transport.get_bytes('bound')[:-1]
1971
except errors.NoSuchFile:
1975
def get_master_branch(self, possible_transports=None):
1976
"""Return the branch we are bound to.
1978
:return: Either a Branch, or None
1980
This could memoise the branch, but if thats done
1981
it must be revalidated on each new lock.
1982
So for now we just don't memoise it.
1983
# RBC 20060304 review this decision.
1985
bound_loc = self.get_bound_location()
1989
return Branch.open(bound_loc,
1990
possible_transports=possible_transports)
1991
except (errors.NotBranchError, errors.ConnectionError), e:
1992
raise errors.BoundBranchConnectionFailure(
1996
def set_bound_location(self, location):
1997
"""Set the target where this branch is bound to.
1999
:param location: URL to the target branch
2002
self._transport.put_bytes('bound', location+'\n',
2003
mode=self.bzrdir._get_file_mode())
2006
self._transport.delete('bound')
2007
except errors.NoSuchFile:
2012
def bind(self, other):
2013
"""Bind this branch to the branch other.
2015
This does not push or pull data between the branches, though it does
2016
check for divergence to raise an error when the branches are not
2017
either the same, or one a prefix of the other. That behaviour may not
2018
be useful, so that check may be removed in future.
2020
:param other: The branch to bind to
2023
# TODO: jam 20051230 Consider checking if the target is bound
2024
# It is debatable whether you should be able to bind to
2025
# a branch which is itself bound.
2026
# Committing is obviously forbidden,
2027
# but binding itself may not be.
2028
# Since we *have* to check at commit time, we don't
2029
# *need* to check here
2031
# we want to raise diverged if:
2032
# last_rev is not in the other_last_rev history, AND
2033
# other_last_rev is not in our history, and do it without pulling
2035
self.set_bound_location(other.base)
2039
"""If bound, unbind"""
2040
return self.set_bound_location(None)
2043
def update(self, possible_transports=None):
2044
"""Synchronise this branch with the master branch if any.
2046
:return: None or the last_revision that was pivoted out during the
2049
master = self.get_master_branch(possible_transports)
2050
if master is not None:
2051
old_tip = _mod_revision.ensure_null(self.last_revision())
2052
self.pull(master, overwrite=True)
2053
if self.repository.get_graph().is_ancestor(old_tip,
2054
_mod_revision.ensure_null(self.last_revision())):
2060
class BzrBranch7(BzrBranch5):
2061
"""A branch with support for a fallback repository."""
2063
def _get_fallback_repository(self, url):
2064
"""Get the repository we fallback to at url."""
2065
url = urlutils.join(self.base, url)
2066
a_bzrdir = bzrdir.BzrDir.open(url,
2067
possible_transports=[self._transport])
2068
return a_bzrdir.open_branch().repository
2070
def _activate_fallback_location(self, url):
2071
"""Activate the branch/repository from url as a fallback repository."""
2072
self.repository.add_fallback_repository(
2073
self._get_fallback_repository(url))
2075
def _open_hook(self):
2077
url = self.get_stacked_on_url()
2078
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2079
errors.UnstackableBranchFormat):
2082
for hook in Branch.hooks['transform_fallback_location']:
2083
url = hook(self, url)
2085
hook_name = Branch.hooks.get_hook_name(hook)
2086
raise AssertionError(
2087
"'transform_fallback_location' hook %s returned "
2088
"None, not a URL." % hook_name)
2089
self._activate_fallback_location(url)
2091
def _check_stackable_repo(self):
2092
if not self.repository._format.supports_external_lookups:
2093
raise errors.UnstackableRepositoryFormat(self.repository._format,
2094
self.repository.base)
2096
def __init__(self, *args, **kwargs):
2097
super(BzrBranch7, self).__init__(*args, **kwargs)
2098
self._last_revision_info_cache = None
2099
self._partial_revision_history_cache = []
2101
def _clear_cached_state(self):
2102
super(BzrBranch7, self)._clear_cached_state()
2103
self._last_revision_info_cache = None
2104
self._partial_revision_history_cache = []
2106
def _last_revision_info(self):
2107
revision_string = self._transport.get_bytes('last-revision')
2108
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2109
revision_id = cache_utf8.get_cached_utf8(revision_id)
2111
return revno, revision_id
2113
def _write_last_revision_info(self, revno, revision_id):
2114
"""Simply write out the revision id, with no checks.
2116
Use set_last_revision_info to perform this safely.
2118
Does not update the revision_history cache.
2119
Intended to be called by set_last_revision_info and
2120
_write_revision_history.
2122
revision_id = _mod_revision.ensure_null(revision_id)
2123
out_string = '%d %s\n' % (revno, revision_id)
2124
self._transport.put_bytes('last-revision', out_string,
2125
mode=self.bzrdir._get_file_mode())
2128
def set_last_revision_info(self, revno, revision_id):
2129
revision_id = _mod_revision.ensure_null(revision_id)
2130
old_revno, old_revid = self.last_revision_info()
2131
if self._get_append_revisions_only():
2132
self._check_history_violation(revision_id)
2133
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2134
self._write_last_revision_info(revno, revision_id)
2135
self._clear_cached_state()
2136
self._last_revision_info_cache = revno, revision_id
2137
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2139
def _synchronize_history(self, destination, revision_id):
2140
"""Synchronize last revision and revision history between branches.
2142
:see: Branch._synchronize_history
2144
# XXX: The base Branch has a fast implementation of this method based
2145
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2146
# that uses set_revision_history. This class inherits from BzrBranch5,
2147
# but wants the fast implementation, so it calls
2148
# Branch._synchronize_history directly.
2149
Branch._synchronize_history(self, destination, revision_id)
2151
def _check_history_violation(self, revision_id):
2152
last_revision = _mod_revision.ensure_null(self.last_revision())
2153
if _mod_revision.is_null(last_revision):
2155
if last_revision not in self._lefthand_history(revision_id):
2156
raise errors.AppendRevisionsOnlyViolation(self.base)
2158
def _gen_revision_history(self):
2159
"""Generate the revision history from last revision
2161
last_revno, last_revision = self.last_revision_info()
2162
self._extend_partial_history(stop_index=last_revno-1)
2163
return list(reversed(self._partial_revision_history_cache))
2165
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2166
"""Extend the partial history to include a given index
2168
If a stop_index is supplied, stop when that index has been reached.
2169
If a stop_revision is supplied, stop when that revision is
2170
encountered. Otherwise, stop when the beginning of history is
2173
:param stop_index: The index which should be present. When it is
2174
present, history extension will stop.
2175
:param revision_id: The revision id which should be present. When
2176
it is encountered, history extension will stop.
2178
repo = self.repository
2179
if len(self._partial_revision_history_cache) == 0:
2180
iterator = repo.iter_reverse_revision_history(self.last_revision())
2182
start_revision = self._partial_revision_history_cache[-1]
2183
iterator = repo.iter_reverse_revision_history(start_revision)
2184
#skip the last revision in the list
2185
next_revision = iterator.next()
2186
for revision_id in iterator:
2187
self._partial_revision_history_cache.append(revision_id)
2188
if (stop_index is not None and
2189
len(self._partial_revision_history_cache) > stop_index):
2191
if revision_id == stop_revision:
2194
def _write_revision_history(self, history):
2195
"""Factored out of set_revision_history.
2197
This performs the actual writing to disk, with format-specific checks.
2198
It is intended to be called by BzrBranch5.set_revision_history.
2200
if len(history) == 0:
2201
last_revision = 'null:'
2203
if history != self._lefthand_history(history[-1]):
2204
raise errors.NotLefthandHistory(history)
2205
last_revision = history[-1]
2206
if self._get_append_revisions_only():
2207
self._check_history_violation(last_revision)
2208
self._write_last_revision_info(len(history), last_revision)
2211
def _set_parent_location(self, url):
2212
"""Set the parent branch"""
2213
self._set_config_location('parent_location', url, make_relative=True)
2216
def _get_parent_location(self):
2217
"""Set the parent branch"""
2218
return self._get_config_location('parent_location')
2220
def set_push_location(self, location):
2221
"""See Branch.set_push_location."""
2222
self._set_config_location('push_location', location)
2224
def set_bound_location(self, location):
2225
"""See Branch.set_push_location."""
2227
config = self.get_config()
2228
if location is None:
2229
if config.get_user_option('bound') != 'True':
2232
config.set_user_option('bound', 'False', warn_masked=True)
2235
self._set_config_location('bound_location', location,
2237
config.set_user_option('bound', 'True', warn_masked=True)
2240
def _get_bound_location(self, bound):
2241
"""Return the bound location in the config file.
2243
Return None if the bound parameter does not match"""
2244
config = self.get_config()
2245
config_bound = (config.get_user_option('bound') == 'True')
2246
if config_bound != bound:
2248
return self._get_config_location('bound_location', config=config)
2250
def get_bound_location(self):
2251
"""See Branch.set_push_location."""
2252
return self._get_bound_location(True)
2254
def get_old_bound_location(self):
2255
"""See Branch.get_old_bound_location"""
2256
return self._get_bound_location(False)
2258
def get_stacked_on_url(self):
2259
# you can always ask for the URL; but you might not be able to use it
2260
# if the repo can't support stacking.
2261
## self._check_stackable_repo()
2262
stacked_url = self._get_config_location('stacked_on_location')
2263
if stacked_url is None:
2264
raise errors.NotStacked(self)
2267
def set_append_revisions_only(self, enabled):
2272
self.get_config().set_user_option('append_revisions_only', value,
2275
def set_stacked_on_url(self, url):
2276
self._check_stackable_repo()
2279
old_url = self.get_stacked_on_url()
2280
except (errors.NotStacked, errors.UnstackableBranchFormat,
2281
errors.UnstackableRepositoryFormat):
2284
# repositories don't offer an interface to remove fallback
2285
# repositories today; take the conceptually simpler option and just
2287
self.repository = self.bzrdir.find_repository()
2288
# for every revision reference the branch has, ensure it is pulled
2290
source_repository = self._get_fallback_repository(old_url)
2291
for revision_id in chain([self.last_revision()],
2292
self.tags.get_reverse_tag_dict()):
2293
self.repository.fetch(source_repository, revision_id,
2296
self._activate_fallback_location(url)
2297
# write this out after the repository is stacked to avoid setting a
2298
# stacked config that doesn't work.
2299
self._set_config_location('stacked_on_location', url)
2301
def _get_append_revisions_only(self):
2302
value = self.get_config().get_user_option('append_revisions_only')
2303
return value == 'True'
2305
def _make_tags(self):
2306
return BasicTags(self)
2309
def generate_revision_history(self, revision_id, last_rev=None,
2311
"""See BzrBranch5.generate_revision_history"""
2312
history = self._lefthand_history(revision_id, last_rev, other_branch)
2313
revno = len(history)
2314
self.set_last_revision_info(revno, revision_id)
2317
def get_rev_id(self, revno, history=None):
2318
"""Find the revision id of the specified revno."""
2320
return _mod_revision.NULL_REVISION
2322
last_revno, last_revision_id = self.last_revision_info()
2323
if revno <= 0 or revno > last_revno:
2324
raise errors.NoSuchRevision(self, revno)
2326
if history is not None:
2327
return history[revno - 1]
2329
index = last_revno - revno
2330
if len(self._partial_revision_history_cache) <= index:
2331
self._extend_partial_history(stop_index=index)
2332
if len(self._partial_revision_history_cache) > index:
2333
return self._partial_revision_history_cache[index]
2335
raise errors.NoSuchRevision(self, revno)
2338
def revision_id_to_revno(self, revision_id):
2339
"""Given a revision id, return its revno"""
2340
if _mod_revision.is_null(revision_id):
2343
index = self._partial_revision_history_cache.index(revision_id)
2345
self._extend_partial_history(stop_revision=revision_id)
2346
index = len(self._partial_revision_history_cache) - 1
2347
if self._partial_revision_history_cache[index] != revision_id:
2348
raise errors.NoSuchRevision(self, revision_id)
2349
return self.revno() - index
2352
class BzrBranch6(BzrBranch7):
2353
"""See BzrBranchFormat6 for the capabilities of this branch.
2355
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2359
def get_stacked_on_url(self):
2360
raise errors.UnstackableBranchFormat(self._format, self.base)
2362
def set_stacked_on_url(self, url):
2363
raise errors.UnstackableBranchFormat(self._format, self.base)
2366
######################################################################
2367
# results of operations
2370
class _Result(object):
2372
def _show_tag_conficts(self, to_file):
2373
if not getattr(self, 'tag_conflicts', None):
2375
to_file.write('Conflicting tags:\n')
2376
for name, value1, value2 in self.tag_conflicts:
2377
to_file.write(' %s\n' % (name, ))
2380
class PullResult(_Result):
2381
"""Result of a Branch.pull operation.
2383
:ivar old_revno: Revision number before pull.
2384
:ivar new_revno: Revision number after pull.
2385
:ivar old_revid: Tip revision id before pull.
2386
:ivar new_revid: Tip revision id after pull.
2387
:ivar source_branch: Source (local) branch object.
2388
:ivar master_branch: Master branch of the target, or the target if no
2390
:ivar local_branch: target branch if there is a Master, else None
2391
:ivar target_branch: Target/destination branch object.
2392
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2396
# DEPRECATED: pull used to return the change in revno
2397
return self.new_revno - self.old_revno
2399
def report(self, to_file):
2401
if self.old_revid == self.new_revid:
2402
to_file.write('No revisions to pull.\n')
2404
to_file.write('Now on revision %d.\n' % self.new_revno)
2405
self._show_tag_conficts(to_file)
2408
class PushResult(_Result):
2409
"""Result of a Branch.push operation.
2411
:ivar old_revno: Revision number before push.
2412
:ivar new_revno: Revision number after push.
2413
:ivar old_revid: Tip revision id before push.
2414
:ivar new_revid: Tip revision id after push.
2415
:ivar source_branch: Source branch object.
2416
:ivar master_branch: Master branch of the target, or None.
2417
:ivar target_branch: Target/destination branch object.
2421
# DEPRECATED: push used to return the change in revno
2422
return self.new_revno - self.old_revno
2424
def report(self, to_file):
2425
"""Write a human-readable description of the result."""
2426
if self.old_revid == self.new_revid:
2427
to_file.write('No new revisions to push.\n')
2429
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2430
self._show_tag_conficts(to_file)
2433
class BranchCheckResult(object):
2434
"""Results of checking branch consistency.
2439
def __init__(self, branch):
2440
self.branch = branch
2442
def report_results(self, verbose):
2443
"""Report the check results via trace.note.
2445
:param verbose: Requests more detailed display of what was checked,
2448
note('checked branch %s format %s',
2450
self.branch._format)
2453
class Converter5to6(object):
2454
"""Perform an in-place upgrade of format 5 to format 6"""
2456
def convert(self, branch):
2457
# Data for 5 and 6 can peacefully coexist.
2458
format = BzrBranchFormat6()
2459
new_branch = format.open(branch.bzrdir, _found=True)
2461
# Copy source data into target
2462
new_branch._write_last_revision_info(*branch.last_revision_info())
2463
new_branch.set_parent(branch.get_parent())
2464
new_branch.set_bound_location(branch.get_bound_location())
2465
new_branch.set_push_location(branch.get_push_location())
2467
# New branch has no tags by default
2468
new_branch.tags._set_tag_dict({})
2470
# Copying done; now update target format
2471
new_branch._transport.put_bytes('format',
2472
format.get_format_string(),
2473
mode=new_branch.bzrdir._get_file_mode())
2475
# Clean up old files
2476
new_branch._transport.delete('revision-history')
2478
branch.set_parent(None)
2479
except errors.NoSuchFile:
2481
branch.set_bound_location(None)
2484
class Converter6to7(object):
2485
"""Perform an in-place upgrade of format 6 to format 7"""
2487
def convert(self, branch):
2488
format = BzrBranchFormat7()
2489
branch._set_config_location('stacked_on_location', '')
2490
# update target format
2491
branch._transport.put_bytes('format', format.get_format_string())
2495
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2496
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2499
_run_with_write_locked_target will attempt to release the lock it acquires.
2501
If an exception is raised by callable, then that exception *will* be
2502
propagated, even if the unlock attempt raises its own error. Thus
2503
_run_with_write_locked_target should be preferred to simply doing::
2507
return callable(*args, **kwargs)
2512
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2513
# should share code?
2516
result = callable(*args, **kwargs)
2518
exc_info = sys.exc_info()
2522
raise exc_info[0], exc_info[1], exc_info[2]
added
removed
bzrlib/branch.py
