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, possible_transports=None):
152
config = self.get_config()
153
if not config.has_explicit_nickname(): # explicit overrides master
155
master = self.get_master_branch(possible_transports)
156
if master is not None:
157
# return the master branch value
159
except errors.BzrError, e:
160
# Silently fall back to local implicit nick if the master is
162
mutter("Could not connect to bound branch, "
163
"falling back to local nick.\n " + str(e))
164
return config.get_nickname()
166
def _set_nick(self, nick):
167
self.get_config().set_user_option('nickname', nick, warn_masked=True)
169
nick = property(_get_nick, _set_nick)
172
raise NotImplementedError(self.is_locked)
174
def lock_write(self):
175
raise NotImplementedError(self.lock_write)
178
raise NotImplementedError(self.lock_read)
181
raise NotImplementedError(self.unlock)
183
def peek_lock_mode(self):
184
"""Return lock mode for the Branch: 'r', 'w' or None"""
185
raise NotImplementedError(self.peek_lock_mode)
187
def get_physical_lock_status(self):
188
raise NotImplementedError(self.get_physical_lock_status)
191
def get_revision_id_to_revno_map(self):
192
"""Return the revision_id => dotted revno map.
194
This will be regenerated on demand, but will be cached.
196
:return: A dictionary mapping revision_id => dotted revno.
197
This dictionary should not be modified by the caller.
199
if self._revision_id_to_revno_cache is not None:
200
mapping = self._revision_id_to_revno_cache
202
mapping = self._gen_revno_map()
203
self._cache_revision_id_to_revno(mapping)
204
# TODO: jam 20070417 Since this is being cached, should we be returning
206
# I would rather not, and instead just declare that users should not
207
# modify the return value.
210
def _gen_revno_map(self):
211
"""Create a new mapping from revision ids to dotted revnos.
213
Dotted revnos are generated based on the current tip in the revision
215
This is the worker function for get_revision_id_to_revno_map, which
216
just caches the return value.
218
:return: A dictionary mapping revision_id => dotted revno.
220
last_revision = self.last_revision()
221
revision_graph = repository._old_get_graph(self.repository,
223
merge_sorted_revisions = tsort.merge_sort(
228
revision_id_to_revno = dict((rev_id, revno)
229
for seq_num, rev_id, depth, revno, end_of_merge
230
in merge_sorted_revisions)
231
return revision_id_to_revno
233
def leave_lock_in_place(self):
234
"""Tell this branch object not to release the physical lock when this
237
If lock_write doesn't return a token, then this method is not supported.
239
self.control_files.leave_in_place()
241
def dont_leave_lock_in_place(self):
242
"""Tell this branch object to release the physical lock when this
243
object is unlocked, even if it didn't originally acquire it.
245
If lock_write doesn't return a token, then this method is not supported.
247
self.control_files.dont_leave_in_place()
249
def bind(self, other):
250
"""Bind the local branch the other branch.
252
:param other: The branch to bind to
255
raise errors.UpgradeRequired(self.base)
258
def fetch(self, from_branch, last_revision=None, pb=None):
259
"""Copy revisions from from_branch into this branch.
261
:param from_branch: Where to copy from.
262
:param last_revision: What revision to stop at (None for at the end
264
:param pb: An optional progress bar to use.
266
Returns the copied revision count and the failed revisions in a tuple:
269
if self.base == from_branch.base:
272
nested_pb = ui.ui_factory.nested_progress_bar()
277
from_branch.lock_read()
279
if last_revision is None:
280
pb.update('get source history')
281
last_revision = from_branch.last_revision()
282
last_revision = _mod_revision.ensure_null(last_revision)
283
return self.repository.fetch(from_branch.repository,
284
revision_id=last_revision,
287
if nested_pb is not None:
291
def get_bound_location(self):
292
"""Return the URL of the branch we are bound to.
294
Older format branches cannot bind, please be sure to use a metadir
299
def get_old_bound_location(self):
300
"""Return the URL of the branch we used to be bound to
302
raise errors.UpgradeRequired(self.base)
304
def get_commit_builder(self, parents, config=None, timestamp=None,
305
timezone=None, committer=None, revprops=None,
307
"""Obtain a CommitBuilder for this branch.
309
:param parents: Revision ids of the parents of the new revision.
310
:param config: Optional configuration to use.
311
:param timestamp: Optional timestamp recorded for commit.
312
:param timezone: Optional timezone for timestamp.
313
:param committer: Optional committer to set for commit.
314
:param revprops: Optional dictionary of revision properties.
315
:param revision_id: Optional revision id.
319
config = self.get_config()
321
return self.repository.get_commit_builder(self, parents, config,
322
timestamp, timezone, committer, revprops, revision_id)
324
def get_master_branch(self, possible_transports=None):
325
"""Return the branch we are bound to.
327
:return: Either a Branch, or None
331
def get_revision_delta(self, revno):
332
"""Return the delta for one revision.
334
The delta is relative to its mainline predecessor, or the
335
empty tree for revision 1.
337
rh = self.revision_history()
338
if not (1 <= revno <= len(rh)):
339
raise errors.InvalidRevisionNumber(revno)
340
return self.repository.get_revision_delta(rh[revno-1])
342
def get_stacked_on_url(self):
343
"""Get the URL this branch is stacked against.
345
:raises NotStacked: If the branch is not stacked.
346
:raises UnstackableBranchFormat: If the branch does not support
349
raise NotImplementedError(self.get_stacked_on_url)
351
def print_file(self, file, revision_id):
352
"""Print `file` to stdout."""
353
raise NotImplementedError(self.print_file)
355
def set_revision_history(self, rev_history):
356
raise NotImplementedError(self.set_revision_history)
358
def set_stacked_on_url(self, url):
359
"""Set the URL this branch is stacked against.
361
:raises UnstackableBranchFormat: If the branch does not support
363
:raises UnstackableRepositoryFormat: If the repository does not support
366
raise NotImplementedError(self.set_stacked_on_url)
368
def _cache_revision_history(self, rev_history):
369
"""Set the cached revision history to rev_history.
371
The revision_history method will use this cache to avoid regenerating
372
the revision history.
374
This API is semi-public; it only for use by subclasses, all other code
375
should consider it to be private.
377
self._revision_history_cache = rev_history
379
def _cache_revision_id_to_revno(self, revision_id_to_revno):
380
"""Set the cached revision_id => revno map to revision_id_to_revno.
382
This API is semi-public; it only for use by subclasses, all other code
383
should consider it to be private.
385
self._revision_id_to_revno_cache = revision_id_to_revno
387
def _clear_cached_state(self):
388
"""Clear any cached data on this branch, e.g. cached revision history.
390
This means the next call to revision_history will need to call
391
_gen_revision_history.
393
This API is semi-public; it only for use by subclasses, all other code
394
should consider it to be private.
396
self._revision_history_cache = None
397
self._revision_id_to_revno_cache = None
398
self._last_revision_info_cache = None
400
def _gen_revision_history(self):
401
"""Return sequence of revision hashes on to this branch.
403
Unlike revision_history, this method always regenerates or rereads the
404
revision history, i.e. it does not cache the result, so repeated calls
407
Concrete subclasses should override this instead of revision_history so
408
that subclasses do not need to deal with caching logic.
410
This API is semi-public; it only for use by subclasses, all other code
411
should consider it to be private.
413
raise NotImplementedError(self._gen_revision_history)
416
def revision_history(self):
417
"""Return sequence of revision ids on this branch.
419
This method will cache the revision history for as long as it is safe to
422
if 'evil' in debug.debug_flags:
423
mutter_callsite(3, "revision_history scales with history.")
424
if self._revision_history_cache is not None:
425
history = self._revision_history_cache
427
history = self._gen_revision_history()
428
self._cache_revision_history(history)
432
"""Return current revision number for this branch.
434
That is equivalent to the number of revisions committed to
437
return self.last_revision_info()[0]
440
"""Older format branches cannot bind or unbind."""
441
raise errors.UpgradeRequired(self.base)
443
def set_append_revisions_only(self, enabled):
444
"""Older format branches are never restricted to append-only"""
445
raise errors.UpgradeRequired(self.base)
447
def last_revision(self):
448
"""Return last revision id, or NULL_REVISION."""
449
return self.last_revision_info()[1]
452
def last_revision_info(self):
453
"""Return information about the last revision.
455
:return: A tuple (revno, revision_id).
457
if self._last_revision_info_cache is None:
458
self._last_revision_info_cache = self._last_revision_info()
459
return self._last_revision_info_cache
461
def _last_revision_info(self):
462
rh = self.revision_history()
465
return (revno, rh[-1])
467
return (0, _mod_revision.NULL_REVISION)
469
@deprecated_method(deprecated_in((1, 6, 0)))
470
def missing_revisions(self, other, stop_revision=None):
471
"""Return a list of new revisions that would perfectly fit.
473
If self and other have not diverged, return a list of the revisions
474
present in other, but missing from self.
476
self_history = self.revision_history()
477
self_len = len(self_history)
478
other_history = other.revision_history()
479
other_len = len(other_history)
480
common_index = min(self_len, other_len) -1
481
if common_index >= 0 and \
482
self_history[common_index] != other_history[common_index]:
483
raise errors.DivergedBranches(self, other)
485
if stop_revision is None:
486
stop_revision = other_len
488
if stop_revision > other_len:
489
raise errors.NoSuchRevision(self, stop_revision)
490
return other_history[self_len:stop_revision]
493
def update_revisions(self, other, stop_revision=None, overwrite=False,
495
"""Pull in new perfect-fit revisions.
497
:param other: Another Branch to pull from
498
:param stop_revision: Updated until the given revision
499
:param overwrite: Always set the branch pointer, rather than checking
500
to see if it is a proper descendant.
501
:param graph: A Graph object that can be used to query history
502
information. This can be None.
507
other_revno, other_last_revision = other.last_revision_info()
508
stop_revno = None # unknown
509
if stop_revision is None:
510
stop_revision = other_last_revision
511
if _mod_revision.is_null(stop_revision):
512
# if there are no commits, we're done.
514
stop_revno = other_revno
516
# what's the current last revision, before we fetch [and change it
518
last_rev = _mod_revision.ensure_null(self.last_revision())
519
# we fetch here so that we don't process data twice in the common
520
# case of having something to pull, and so that the check for
521
# already merged can operate on the just fetched graph, which will
522
# be cached in memory.
523
self.fetch(other, stop_revision)
524
# Check to see if one is an ancestor of the other
527
graph = self.repository.get_graph()
528
if self._check_if_descendant_or_diverged(
529
stop_revision, last_rev, graph, other):
530
# stop_revision is a descendant of last_rev, but we aren't
531
# overwriting, so we're done.
533
if stop_revno is None:
535
graph = self.repository.get_graph()
536
this_revno, this_last_revision = self.last_revision_info()
537
stop_revno = graph.find_distance_to_null(stop_revision,
538
[(other_last_revision, other_revno),
539
(this_last_revision, this_revno)])
540
self.set_last_revision_info(stop_revno, stop_revision)
544
def revision_id_to_revno(self, revision_id):
545
"""Given a revision id, return its revno"""
546
if _mod_revision.is_null(revision_id):
548
history = self.revision_history()
550
return history.index(revision_id) + 1
552
raise errors.NoSuchRevision(self, revision_id)
554
def get_rev_id(self, revno, history=None):
555
"""Find the revision id of the specified revno."""
557
return _mod_revision.NULL_REVISION
559
history = self.revision_history()
560
if revno <= 0 or revno > len(history):
561
raise errors.NoSuchRevision(self, revno)
562
return history[revno - 1]
564
def pull(self, source, overwrite=False, stop_revision=None,
565
possible_transports=None, _override_hook_target=None):
566
"""Mirror source into this branch.
568
This branch is considered to be 'local', having low latency.
570
:returns: PullResult instance
572
raise NotImplementedError(self.pull)
574
def push(self, target, overwrite=False, stop_revision=None):
575
"""Mirror this branch into target.
577
This branch is considered to be 'local', having low latency.
579
raise NotImplementedError(self.push)
581
def basis_tree(self):
582
"""Return `Tree` object for last revision."""
583
return self.repository.revision_tree(self.last_revision())
585
def get_parent(self):
586
"""Return the parent location of the branch.
588
This is the default location for push/pull/missing. The usual
589
pattern is that the user can override it by specifying a
592
raise NotImplementedError(self.get_parent)
594
def _set_config_location(self, name, url, config=None,
595
make_relative=False):
597
config = self.get_config()
601
url = urlutils.relative_url(self.base, url)
602
config.set_user_option(name, url, warn_masked=True)
604
def _get_config_location(self, name, config=None):
606
config = self.get_config()
607
location = config.get_user_option(name)
612
def get_submit_branch(self):
613
"""Return the submit location of the branch.
615
This is the default location for bundle. The usual
616
pattern is that the user can override it by specifying a
619
return self.get_config().get_user_option('submit_branch')
621
def set_submit_branch(self, location):
622
"""Return the submit location of the branch.
624
This is the default location for bundle. The usual
625
pattern is that the user can override it by specifying a
628
self.get_config().set_user_option('submit_branch', location,
631
def get_public_branch(self):
632
"""Return the public location of the branch.
634
This is is used by merge directives.
636
return self._get_config_location('public_branch')
638
def set_public_branch(self, location):
639
"""Return the submit location of the branch.
641
This is the default location for bundle. The usual
642
pattern is that the user can override it by specifying a
645
self._set_config_location('public_branch', location)
647
def get_push_location(self):
648
"""Return the None or the location to push this branch to."""
649
push_loc = self.get_config().get_user_option('push_location')
652
def set_push_location(self, location):
653
"""Set a new push location for this branch."""
654
raise NotImplementedError(self.set_push_location)
656
def set_parent(self, url):
657
raise NotImplementedError(self.set_parent)
661
"""Synchronise this branch with the master branch if any.
663
:return: None or the last_revision pivoted out during the update.
667
def check_revno(self, revno):
669
Check whether a revno corresponds to any revision.
670
Zero (the NULL revision) is considered valid.
673
self.check_real_revno(revno)
675
def check_real_revno(self, revno):
677
Check whether a revno corresponds to a real revision.
678
Zero (the NULL revision) is considered invalid
680
if revno < 1 or revno > self.revno():
681
raise errors.InvalidRevisionNumber(revno)
684
def clone(self, to_bzrdir, revision_id=None):
685
"""Clone this branch into to_bzrdir preserving all semantic values.
687
revision_id: if not None, the revision history in the new branch will
688
be truncated to end with revision_id.
690
result = to_bzrdir.create_branch()
691
self.copy_content_into(result, revision_id=revision_id)
695
def sprout(self, to_bzrdir, revision_id=None):
696
"""Create a new line of development from the branch, into to_bzrdir.
698
to_bzrdir controls the branch format.
700
revision_id: if not None, the revision history in the new branch will
701
be truncated to end with revision_id.
703
result = to_bzrdir.create_branch()
704
self.copy_content_into(result, revision_id=revision_id)
705
result.set_parent(self.bzrdir.root_transport.base)
708
def _synchronize_history(self, destination, revision_id):
709
"""Synchronize last revision and revision history between branches.
711
This version is most efficient when the destination is also a
712
BzrBranch6, but works for BzrBranch5, as long as the destination's
713
repository contains all the lefthand ancestors of the intended
714
last_revision. If not, set_last_revision_info will fail.
716
:param destination: The branch to copy the history into
717
:param revision_id: The revision-id to truncate history at. May
718
be None to copy complete history.
720
source_revno, source_revision_id = self.last_revision_info()
721
if revision_id is None:
722
revno, revision_id = source_revno, source_revision_id
723
elif source_revision_id == revision_id:
724
# we know the revno without needing to walk all of history
727
# To figure out the revno for a random revision, we need to build
728
# the revision history, and count its length.
729
# We don't care about the order, just how long it is.
730
# Alternatively, we could start at the current location, and count
731
# backwards. But there is no guarantee that we will find it since
732
# it may be a merged revision.
733
revno = len(list(self.repository.iter_reverse_revision_history(
735
destination.set_last_revision_info(revno, revision_id)
738
def copy_content_into(self, destination, revision_id=None):
739
"""Copy the content of self into destination.
741
revision_id: if not None, the revision history in the new branch will
742
be truncated to end with revision_id.
744
self._synchronize_history(destination, revision_id)
746
parent = self.get_parent()
747
except errors.InaccessibleParent, e:
748
mutter('parent was not accessible to copy: %s', e)
751
destination.set_parent(parent)
752
self.tags.merge_to(destination.tags)
756
"""Check consistency of the branch.
758
In particular this checks that revisions given in the revision-history
759
do actually match up in the revision graph, and that they're all
760
present in the repository.
762
Callers will typically also want to check the repository.
764
:return: A BranchCheckResult.
766
mainline_parent_id = None
767
last_revno, last_revision_id = self.last_revision_info()
768
real_rev_history = list(self.repository.iter_reverse_revision_history(
770
real_rev_history.reverse()
771
if len(real_rev_history) != last_revno:
772
raise errors.BzrCheckError('revno does not match len(mainline)'
773
' %s != %s' % (last_revno, len(real_rev_history)))
774
# TODO: We should probably also check that real_rev_history actually
775
# matches self.revision_history()
776
for revision_id in real_rev_history:
778
revision = self.repository.get_revision(revision_id)
779
except errors.NoSuchRevision, e:
780
raise errors.BzrCheckError("mainline revision {%s} not in repository"
782
# In general the first entry on the revision history has no parents.
783
# But it's not illegal for it to have parents listed; this can happen
784
# in imports from Arch when the parents weren't reachable.
785
if mainline_parent_id is not None:
786
if mainline_parent_id not in revision.parent_ids:
787
raise errors.BzrCheckError("previous revision {%s} not listed among "
789
% (mainline_parent_id, revision_id))
790
mainline_parent_id = revision_id
791
return BranchCheckResult(self)
793
def _get_checkout_format(self):
794
"""Return the most suitable metadir for a checkout of this branch.
795
Weaves are used if this branch's repository uses weaves.
797
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
798
from bzrlib.repofmt import weaverepo
799
format = bzrdir.BzrDirMetaFormat1()
800
format.repository_format = weaverepo.RepositoryFormat7()
802
format = self.repository.bzrdir.checkout_metadir()
803
format.set_branch_format(self._format)
806
def create_checkout(self, to_location, revision_id=None,
807
lightweight=False, accelerator_tree=None,
809
"""Create a checkout of a branch.
811
:param to_location: The url to produce the checkout at
812
:param revision_id: The revision to check out
813
:param lightweight: If True, produce a lightweight checkout, otherwise,
814
produce a bound branch (heavyweight checkout)
815
:param accelerator_tree: A tree which can be used for retrieving file
816
contents more quickly than the revision tree, i.e. a workingtree.
817
The revision tree will be used for cases where accelerator_tree's
818
content is different.
819
:param hardlink: If true, hard-link files from accelerator_tree,
821
:return: The tree of the created checkout
823
t = transport.get_transport(to_location)
826
format = self._get_checkout_format()
827
checkout = format.initialize_on_transport(t)
828
from_branch = BranchReferenceFormat().initialize(checkout, self)
830
format = self._get_checkout_format()
831
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
832
to_location, force_new_tree=False, format=format)
833
checkout = checkout_branch.bzrdir
834
checkout_branch.bind(self)
835
# pull up to the specified revision_id to set the initial
836
# branch tip correctly, and seed it with history.
837
checkout_branch.pull(self, stop_revision=revision_id)
839
tree = checkout.create_workingtree(revision_id,
840
from_branch=from_branch,
841
accelerator_tree=accelerator_tree,
843
basis_tree = tree.basis_tree()
844
basis_tree.lock_read()
846
for path, file_id in basis_tree.iter_references():
847
reference_parent = self.reference_parent(file_id, path)
848
reference_parent.create_checkout(tree.abspath(path),
849
basis_tree.get_reference_revision(file_id, path),
856
def reconcile(self, thorough=True):
857
"""Make sure the data stored in this branch is consistent."""
858
from bzrlib.reconcile import BranchReconciler
859
reconciler = BranchReconciler(self, thorough=thorough)
860
reconciler.reconcile()
863
def reference_parent(self, file_id, path):
864
"""Return the parent branch for a tree-reference file_id
865
:param file_id: The file_id of the tree reference
866
:param path: The path of the file_id in the tree
867
:return: A branch associated with the file_id
869
# FIXME should provide multiple branches, based on config
870
return Branch.open(self.bzrdir.root_transport.clone(path).base)
872
def supports_tags(self):
873
return self._format.supports_tags()
875
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
877
"""Ensure that revision_b is a descendant of revision_a.
879
This is a helper function for update_revisions.
881
:raises: DivergedBranches if revision_b has diverged from revision_a.
882
:returns: True if revision_b is a descendant of revision_a.
884
relation = self._revision_relations(revision_a, revision_b, graph)
885
if relation == 'b_descends_from_a':
887
elif relation == 'diverged':
888
raise errors.DivergedBranches(self, other_branch)
889
elif relation == 'a_descends_from_b':
892
raise AssertionError("invalid relation: %r" % (relation,))
894
def _revision_relations(self, revision_a, revision_b, graph):
895
"""Determine the relationship between two revisions.
897
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
899
heads = graph.heads([revision_a, revision_b])
900
if heads == set([revision_b]):
901
return 'b_descends_from_a'
902
elif heads == set([revision_a, revision_b]):
903
# These branches have diverged
905
elif heads == set([revision_a]):
906
return 'a_descends_from_b'
908
raise AssertionError("invalid heads: %r" % (heads,))
911
class BranchFormat(object):
912
"""An encapsulation of the initialization and open routines for a format.
914
Formats provide three things:
915
* An initialization routine,
919
Formats are placed in an dict by their format string for reference
920
during branch opening. Its not required that these be instances, they
921
can be classes themselves with class methods - it simply depends on
922
whether state is needed for a given format or not.
924
Once a format is deprecated, just deprecate the initialize and open
925
methods on the format class. Do not deprecate the object, as the
926
object will be created every time regardless.
929
_default_format = None
930
"""The default format used for new branches."""
933
"""The known formats."""
935
def __eq__(self, other):
936
return self.__class__ is other.__class__
938
def __ne__(self, other):
939
return not (self == other)
942
def find_format(klass, a_bzrdir):
943
"""Return the format for the branch object in a_bzrdir."""
945
transport = a_bzrdir.get_branch_transport(None)
946
format_string = transport.get("format").read()
947
return klass._formats[format_string]
948
except errors.NoSuchFile:
949
raise errors.NotBranchError(path=transport.base)
951
raise errors.UnknownFormatError(format=format_string, kind='branch')
954
def get_default_format(klass):
955
"""Return the current default format."""
956
return klass._default_format
958
def get_reference(self, a_bzrdir):
959
"""Get the target reference of the branch in a_bzrdir.
961
format probing must have been completed before calling
962
this method - it is assumed that the format of the branch
963
in a_bzrdir is correct.
965
:param a_bzrdir: The bzrdir to get the branch data from.
966
:return: None if the branch is not a reference branch.
971
def set_reference(self, a_bzrdir, to_branch):
972
"""Set the target reference of the branch in a_bzrdir.
974
format probing must have been completed before calling
975
this method - it is assumed that the format of the branch
976
in a_bzrdir is correct.
978
:param a_bzrdir: The bzrdir to set the branch reference for.
979
:param to_branch: branch that the checkout is to reference
981
raise NotImplementedError(self.set_reference)
983
def get_format_string(self):
984
"""Return the ASCII format string that identifies this format."""
985
raise NotImplementedError(self.get_format_string)
987
def get_format_description(self):
988
"""Return the short format description for this format."""
989
raise NotImplementedError(self.get_format_description)
991
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
993
"""Initialize a branch in a bzrdir, with specified files
995
:param a_bzrdir: The bzrdir to initialize the branch in
996
:param utf8_files: The files to create as a list of
997
(filename, content) tuples
998
:param set_format: If True, set the format with
999
self.get_format_string. (BzrBranch4 has its format set
1001
:return: a branch in this format
1003
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1004
branch_transport = a_bzrdir.get_branch_transport(self)
1006
'metadir': ('lock', lockdir.LockDir),
1007
'branch4': ('branch-lock', lockable_files.TransportLock),
1009
lock_name, lock_class = lock_map[lock_type]
1010
control_files = lockable_files.LockableFiles(branch_transport,
1011
lock_name, lock_class)
1012
control_files.create_lock()
1013
control_files.lock_write()
1015
utf8_files += [('format', self.get_format_string())]
1017
for (filename, content) in utf8_files:
1018
branch_transport.put_bytes(
1020
mode=a_bzrdir._get_file_mode())
1022
control_files.unlock()
1023
return self.open(a_bzrdir, _found=True)
1025
def initialize(self, a_bzrdir):
1026
"""Create a branch of this format in a_bzrdir."""
1027
raise NotImplementedError(self.initialize)
1029
def is_supported(self):
1030
"""Is this format supported?
1032
Supported formats can be initialized and opened.
1033
Unsupported formats may not support initialization or committing or
1034
some other features depending on the reason for not being supported.
1038
def open(self, a_bzrdir, _found=False):
1039
"""Return the branch object for a_bzrdir
1041
_found is a private parameter, do not use it. It is used to indicate
1042
if format probing has already be done.
1044
raise NotImplementedError(self.open)
1047
def register_format(klass, format):
1048
klass._formats[format.get_format_string()] = format
1051
def set_default_format(klass, format):
1052
klass._default_format = format
1054
def supports_stacking(self):
1055
"""True if this format records a stacked-on branch."""
1059
def unregister_format(klass, format):
1060
del klass._formats[format.get_format_string()]
1063
return self.get_format_string().rstrip()
1065
def supports_tags(self):
1066
"""True if this format supports tags stored in the branch"""
1067
return False # by default
1070
class BranchHooks(Hooks):
1071
"""A dictionary mapping hook name to a list of callables for branch hooks.
1073
e.g. ['set_rh'] Is the list of items to be called when the
1074
set_revision_history function is invoked.
1078
"""Create the default hooks.
1080
These are all empty initially, because by default nothing should get
1083
Hooks.__init__(self)
1084
# Introduced in 0.15:
1085
# invoked whenever the revision history has been set
1086
# with set_revision_history. The api signature is
1087
# (branch, revision_history), and the branch will
1090
# Invoked after a branch is opened. The api signature is (branch).
1092
# invoked after a push operation completes.
1093
# the api signature is
1095
# containing the members
1096
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1097
# where local is the local target branch or None, master is the target
1098
# master branch, and the rest should be self explanatory. The source
1099
# is read locked and the target branches write locked. Source will
1100
# be the local low-latency branch.
1101
self['post_push'] = []
1102
# invoked after a pull operation completes.
1103
# the api signature is
1105
# containing the members
1106
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1107
# where local is the local branch or None, master is the target
1108
# master branch, and the rest should be self explanatory. The source
1109
# is read locked and the target branches write locked. The local
1110
# branch is the low-latency branch.
1111
self['post_pull'] = []
1112
# invoked before a commit operation takes place.
1113
# the api signature is
1114
# (local, master, old_revno, old_revid, future_revno, future_revid,
1115
# tree_delta, future_tree).
1116
# old_revid is NULL_REVISION for the first commit to a branch
1117
# tree_delta is a TreeDelta object describing changes from the basis
1118
# revision, hooks MUST NOT modify this delta
1119
# future_tree is an in-memory tree obtained from
1120
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1121
self['pre_commit'] = []
1122
# invoked after a commit operation completes.
1123
# the api signature is
1124
# (local, master, old_revno, old_revid, new_revno, new_revid)
1125
# old_revid is NULL_REVISION for the first commit to a branch.
1126
self['post_commit'] = []
1127
# invoked after a uncommit operation completes.
1128
# the api signature is
1129
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1130
# local is the local branch or None, master is the target branch,
1131
# and an empty branch recieves new_revno of 0, new_revid of None.
1132
self['post_uncommit'] = []
1134
# Invoked before the tip of a branch changes.
1135
# the api signature is
1136
# (params) where params is a ChangeBranchTipParams with the members
1137
# (branch, old_revno, new_revno, old_revid, new_revid)
1138
self['pre_change_branch_tip'] = []
1140
# Invoked after the tip of a branch changes.
1141
# the api signature is
1142
# (params) where params is a ChangeBranchTipParams with the members
1143
# (branch, old_revno, new_revno, old_revid, new_revid)
1144
self['post_change_branch_tip'] = []
1146
# Invoked when a stacked branch activates its fallback locations and
1147
# allows the transformation of the url of said location.
1148
# the api signature is
1149
# (branch, url) where branch is the branch having its fallback
1150
# location activated and url is the url for the fallback location.
1151
# The hook should return a url.
1152
self['transform_fallback_location'] = []
1155
# install the default hooks into the Branch class.
1156
Branch.hooks = BranchHooks()
1159
class ChangeBranchTipParams(object):
1160
"""Object holding parameters passed to *_change_branch_tip hooks.
1162
There are 5 fields that hooks may wish to access:
1164
:ivar branch: the branch being changed
1165
:ivar old_revno: revision number before the change
1166
:ivar new_revno: revision number after the change
1167
:ivar old_revid: revision id before the change
1168
:ivar new_revid: revision id after the change
1170
The revid fields are strings. The revno fields are integers.
1173
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1174
"""Create a group of ChangeBranchTip parameters.
1176
:param branch: The branch being changed.
1177
:param old_revno: Revision number before the change.
1178
:param new_revno: Revision number after the change.
1179
:param old_revid: Tip revision id before the change.
1180
:param new_revid: Tip revision id after the change.
1182
self.branch = branch
1183
self.old_revno = old_revno
1184
self.new_revno = new_revno
1185
self.old_revid = old_revid
1186
self.new_revid = new_revid
1188
def __eq__(self, other):
1189
return self.__dict__ == other.__dict__
1192
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1193
self.__class__.__name__, self.branch,
1194
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1197
class BzrBranchFormat4(BranchFormat):
1198
"""Bzr branch format 4.
1201
- a revision-history file.
1202
- a branch-lock lock file [ to be shared with the bzrdir ]
1205
def get_format_description(self):
1206
"""See BranchFormat.get_format_description()."""
1207
return "Branch format 4"
1209
def initialize(self, a_bzrdir):
1210
"""Create a branch of this format in a_bzrdir."""
1211
utf8_files = [('revision-history', ''),
1212
('branch-name', ''),
1214
return self._initialize_helper(a_bzrdir, utf8_files,
1215
lock_type='branch4', set_format=False)
1218
super(BzrBranchFormat4, self).__init__()
1219
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1221
def open(self, a_bzrdir, _found=False):
1222
"""Return the branch object for a_bzrdir
1224
_found is a private parameter, do not use it. It is used to indicate
1225
if format probing has already be done.
1228
# we are being called directly and must probe.
1229
raise NotImplementedError
1230
return BzrBranch(_format=self,
1231
_control_files=a_bzrdir._control_files,
1233
_repository=a_bzrdir.open_repository())
1236
return "Bazaar-NG branch format 4"
1239
class BranchFormatMetadir(BranchFormat):
1240
"""Common logic for meta-dir based branch formats."""
1242
def _branch_class(self):
1243
"""What class to instantiate on open calls."""
1244
raise NotImplementedError(self._branch_class)
1246
def open(self, a_bzrdir, _found=False):
1247
"""Return the branch object for a_bzrdir.
1249
_found is a private parameter, do not use it. It is used to indicate
1250
if format probing has already be done.
1253
format = BranchFormat.find_format(a_bzrdir)
1254
if format.__class__ != self.__class__:
1255
raise AssertionError("wrong format %r found for %r" %
1258
transport = a_bzrdir.get_branch_transport(None)
1259
control_files = lockable_files.LockableFiles(transport, 'lock',
1261
return self._branch_class()(_format=self,
1262
_control_files=control_files,
1264
_repository=a_bzrdir.find_repository())
1265
except errors.NoSuchFile:
1266
raise errors.NotBranchError(path=transport.base)
1269
super(BranchFormatMetadir, self).__init__()
1270
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1272
def supports_tags(self):
1276
class BzrBranchFormat5(BranchFormatMetadir):
1277
"""Bzr branch format 5.
1280
- a revision-history file.
1282
- a lock dir guarding the branch itself
1283
- all of this stored in a branch/ subdirectory
1284
- works with shared repositories.
1286
This format is new in bzr 0.8.
1289
def _branch_class(self):
1292
def get_format_string(self):
1293
"""See BranchFormat.get_format_string()."""
1294
return "Bazaar-NG branch format 5\n"
1296
def get_format_description(self):
1297
"""See BranchFormat.get_format_description()."""
1298
return "Branch format 5"
1300
def initialize(self, a_bzrdir):
1301
"""Create a branch of this format in a_bzrdir."""
1302
utf8_files = [('revision-history', ''),
1303
('branch-name', ''),
1305
return self._initialize_helper(a_bzrdir, utf8_files)
1307
def supports_tags(self):
1311
class BzrBranchFormat6(BranchFormatMetadir):
1312
"""Branch format with last-revision and tags.
1314
Unlike previous formats, this has no explicit revision history. Instead,
1315
this just stores the last-revision, and the left-hand history leading
1316
up to there is the history.
1318
This format was introduced in bzr 0.15
1319
and became the default in 0.91.
1322
def _branch_class(self):
1325
def get_format_string(self):
1326
"""See BranchFormat.get_format_string()."""
1327
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1329
def get_format_description(self):
1330
"""See BranchFormat.get_format_description()."""
1331
return "Branch format 6"
1333
def initialize(self, a_bzrdir):
1334
"""Create a branch of this format in a_bzrdir."""
1335
utf8_files = [('last-revision', '0 null:\n'),
1336
('branch.conf', ''),
1339
return self._initialize_helper(a_bzrdir, utf8_files)
1342
class BzrBranchFormat7(BranchFormatMetadir):
1343
"""Branch format with last-revision, tags, and a stacked location pointer.
1345
The stacked location pointer is passed down to the repository and requires
1346
a repository format with supports_external_lookups = True.
1348
This format was introduced in bzr 1.6.
1351
def _branch_class(self):
1354
def get_format_string(self):
1355
"""See BranchFormat.get_format_string()."""
1356
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1358
def get_format_description(self):
1359
"""See BranchFormat.get_format_description()."""
1360
return "Branch format 7"
1362
def initialize(self, a_bzrdir):
1363
"""Create a branch of this format in a_bzrdir."""
1364
utf8_files = [('last-revision', '0 null:\n'),
1365
('branch.conf', ''),
1368
return self._initialize_helper(a_bzrdir, utf8_files)
1371
super(BzrBranchFormat7, self).__init__()
1372
self._matchingbzrdir.repository_format = \
1373
RepositoryFormatKnitPack5RichRoot()
1375
def supports_stacking(self):
1379
class BranchReferenceFormat(BranchFormat):
1380
"""Bzr branch reference format.
1382
Branch references are used in implementing checkouts, they
1383
act as an alias to the real branch which is at some other url.
1390
def get_format_string(self):
1391
"""See BranchFormat.get_format_string()."""
1392
return "Bazaar-NG Branch Reference Format 1\n"
1394
def get_format_description(self):
1395
"""See BranchFormat.get_format_description()."""
1396
return "Checkout reference format 1"
1398
def get_reference(self, a_bzrdir):
1399
"""See BranchFormat.get_reference()."""
1400
transport = a_bzrdir.get_branch_transport(None)
1401
return transport.get('location').read()
1403
def set_reference(self, a_bzrdir, to_branch):
1404
"""See BranchFormat.set_reference()."""
1405
transport = a_bzrdir.get_branch_transport(None)
1406
location = transport.put_bytes('location', to_branch.base)
1408
def initialize(self, a_bzrdir, target_branch=None):
1409
"""Create a branch of this format in a_bzrdir."""
1410
if target_branch is None:
1411
# this format does not implement branch itself, thus the implicit
1412
# creation contract must see it as uninitializable
1413
raise errors.UninitializableFormat(self)
1414
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1415
branch_transport = a_bzrdir.get_branch_transport(self)
1416
branch_transport.put_bytes('location',
1417
target_branch.bzrdir.root_transport.base)
1418
branch_transport.put_bytes('format', self.get_format_string())
1420
a_bzrdir, _found=True,
1421
possible_transports=[target_branch.bzrdir.root_transport])
1424
super(BranchReferenceFormat, self).__init__()
1425
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1427
def _make_reference_clone_function(format, a_branch):
1428
"""Create a clone() routine for a branch dynamically."""
1429
def clone(to_bzrdir, revision_id=None):
1430
"""See Branch.clone()."""
1431
return format.initialize(to_bzrdir, a_branch)
1432
# cannot obey revision_id limits when cloning a reference ...
1433
# FIXME RBC 20060210 either nuke revision_id for clone, or
1434
# emit some sort of warning/error to the caller ?!
1437
def open(self, a_bzrdir, _found=False, location=None,
1438
possible_transports=None):
1439
"""Return the branch that the branch reference in a_bzrdir points at.
1441
_found is a private parameter, do not use it. It is used to indicate
1442
if format probing has already be done.
1445
format = BranchFormat.find_format(a_bzrdir)
1446
if format.__class__ != self.__class__:
1447
raise AssertionError("wrong format %r found for %r" %
1449
if location is None:
1450
location = self.get_reference(a_bzrdir)
1451
real_bzrdir = bzrdir.BzrDir.open(
1452
location, possible_transports=possible_transports)
1453
result = real_bzrdir.open_branch()
1454
# this changes the behaviour of result.clone to create a new reference
1455
# rather than a copy of the content of the branch.
1456
# I did not use a proxy object because that needs much more extensive
1457
# testing, and we are only changing one behaviour at the moment.
1458
# If we decide to alter more behaviours - i.e. the implicit nickname
1459
# then this should be refactored to introduce a tested proxy branch
1460
# and a subclass of that for use in overriding clone() and ....
1462
result.clone = self._make_reference_clone_function(result)
1466
# formats which have no format string are not discoverable
1467
# and not independently creatable, so are not registered.
1468
__format5 = BzrBranchFormat5()
1469
__format6 = BzrBranchFormat6()
1470
__format7 = BzrBranchFormat7()
1471
BranchFormat.register_format(__format5)
1472
BranchFormat.register_format(BranchReferenceFormat())
1473
BranchFormat.register_format(__format6)
1474
BranchFormat.register_format(__format7)
1475
BranchFormat.set_default_format(__format6)
1476
_legacy_formats = [BzrBranchFormat4(),
1479
class BzrBranch(Branch):
1480
"""A branch stored in the actual filesystem.
1482
Note that it's "local" in the context of the filesystem; it doesn't
1483
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1484
it's writable, and can be accessed via the normal filesystem API.
1486
:ivar _transport: Transport for file operations on this branch's
1487
control files, typically pointing to the .bzr/branch directory.
1488
:ivar repository: Repository for this branch.
1489
:ivar base: The url of the base directory for this branch; the one
1490
containing the .bzr directory.
1493
def __init__(self, _format=None,
1494
_control_files=None, a_bzrdir=None, _repository=None):
1495
"""Create new branch object at a particular location."""
1496
if a_bzrdir is None:
1497
raise ValueError('a_bzrdir must be supplied')
1499
self.bzrdir = a_bzrdir
1500
self._base = self.bzrdir.transport.clone('..').base
1501
# XXX: We should be able to just do
1502
# self.base = self.bzrdir.root_transport.base
1503
# but this does not quite work yet -- mbp 20080522
1504
self._format = _format
1505
if _control_files is None:
1506
raise ValueError('BzrBranch _control_files is None')
1507
self.control_files = _control_files
1508
self._transport = _control_files._transport
1509
self.repository = _repository
1510
Branch.__init__(self)
1513
return '%s(%r)' % (self.__class__.__name__, self.base)
1517
def _get_base(self):
1518
"""Returns the directory containing the control directory."""
1521
base = property(_get_base, doc="The URL for the root of this branch.")
1523
def is_locked(self):
1524
return self.control_files.is_locked()
1526
def lock_write(self, token=None):
1527
repo_token = self.repository.lock_write()
1529
token = self.control_files.lock_write(token=token)
1531
self.repository.unlock()
1535
def lock_read(self):
1536
self.repository.lock_read()
1538
self.control_files.lock_read()
1540
self.repository.unlock()
1544
# TODO: test for failed two phase locks. This is known broken.
1546
self.control_files.unlock()
1548
self.repository.unlock()
1549
if not self.control_files.is_locked():
1550
# we just released the lock
1551
self._clear_cached_state()
1553
def peek_lock_mode(self):
1554
if self.control_files._lock_count == 0:
1557
return self.control_files._lock_mode
1559
def get_physical_lock_status(self):
1560
return self.control_files.get_physical_lock_status()
1563
def print_file(self, file, revision_id):
1564
"""See Branch.print_file."""
1565
return self.repository.print_file(file, revision_id)
1567
def _write_revision_history(self, history):
1568
"""Factored out of set_revision_history.
1570
This performs the actual writing to disk.
1571
It is intended to be called by BzrBranch5.set_revision_history."""
1572
self._transport.put_bytes(
1573
'revision-history', '\n'.join(history),
1574
mode=self.bzrdir._get_file_mode())
1577
def set_revision_history(self, rev_history):
1578
"""See Branch.set_revision_history."""
1579
if 'evil' in debug.debug_flags:
1580
mutter_callsite(3, "set_revision_history scales with history.")
1581
check_not_reserved_id = _mod_revision.check_not_reserved_id
1582
for rev_id in rev_history:
1583
check_not_reserved_id(rev_id)
1584
if Branch.hooks['post_change_branch_tip']:
1585
# Don't calculate the last_revision_info() if there are no hooks
1587
old_revno, old_revid = self.last_revision_info()
1588
if len(rev_history) == 0:
1589
revid = _mod_revision.NULL_REVISION
1591
revid = rev_history[-1]
1592
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1593
self._write_revision_history(rev_history)
1594
self._clear_cached_state()
1595
self._cache_revision_history(rev_history)
1596
for hook in Branch.hooks['set_rh']:
1597
hook(self, rev_history)
1598
if Branch.hooks['post_change_branch_tip']:
1599
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1601
def _synchronize_history(self, destination, revision_id):
1602
"""Synchronize last revision and revision history between branches.
1604
This version is most efficient when the destination is also a
1605
BzrBranch5, but works for BzrBranch6 as long as the revision
1606
history is the true lefthand parent history, and all of the revisions
1607
are in the destination's repository. If not, set_revision_history
1610
:param destination: The branch to copy the history into
1611
:param revision_id: The revision-id to truncate history at. May
1612
be None to copy complete history.
1614
if revision_id == _mod_revision.NULL_REVISION:
1617
new_history = self.revision_history()
1618
if revision_id is not None and new_history != []:
1620
new_history = new_history[:new_history.index(revision_id) + 1]
1622
rev = self.repository.get_revision(revision_id)
1623
new_history = rev.get_history(self.repository)[1:]
1624
destination.set_revision_history(new_history)
1626
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1627
"""Run the pre_change_branch_tip hooks."""
1628
hooks = Branch.hooks['pre_change_branch_tip']
1631
old_revno, old_revid = self.last_revision_info()
1632
params = ChangeBranchTipParams(
1633
self, old_revno, new_revno, old_revid, new_revid)
1637
except errors.TipChangeRejected:
1640
exc_info = sys.exc_info()
1641
hook_name = Branch.hooks.get_hook_name(hook)
1642
raise errors.HookFailed(
1643
'pre_change_branch_tip', hook_name, exc_info)
1645
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1646
"""Run the post_change_branch_tip hooks."""
1647
hooks = Branch.hooks['post_change_branch_tip']
1650
new_revno, new_revid = self.last_revision_info()
1651
params = ChangeBranchTipParams(
1652
self, old_revno, new_revno, old_revid, new_revid)
1657
def set_last_revision_info(self, revno, revision_id):
1658
"""Set the last revision of this branch.
1660
The caller is responsible for checking that the revno is correct
1661
for this revision id.
1663
It may be possible to set the branch last revision to an id not
1664
present in the repository. However, branches can also be
1665
configured to check constraints on history, in which case this may not
1668
revision_id = _mod_revision.ensure_null(revision_id)
1669
# this old format stores the full history, but this api doesn't
1670
# provide it, so we must generate, and might as well check it's
1672
history = self._lefthand_history(revision_id)
1673
if len(history) != revno:
1674
raise AssertionError('%d != %d' % (len(history), revno))
1675
self.set_revision_history(history)
1677
def _gen_revision_history(self):
1678
history = self._transport.get_bytes('revision-history').split('\n')
1679
if history[-1:] == ['']:
1680
# There shouldn't be a trailing newline, but just in case.
1684
def _lefthand_history(self, revision_id, last_rev=None,
1686
if 'evil' in debug.debug_flags:
1687
mutter_callsite(4, "_lefthand_history scales with history.")
1688
# stop_revision must be a descendant of last_revision
1689
graph = self.repository.get_graph()
1690
if last_rev is not None:
1691
if not graph.is_ancestor(last_rev, revision_id):
1692
# our previous tip is not merged into stop_revision
1693
raise errors.DivergedBranches(self, other_branch)
1694
# make a new revision history from the graph
1695
parents_map = graph.get_parent_map([revision_id])
1696
if revision_id not in parents_map:
1697
raise errors.NoSuchRevision(self, revision_id)
1698
current_rev_id = revision_id
1700
check_not_reserved_id = _mod_revision.check_not_reserved_id
1701
# Do not include ghosts or graph origin in revision_history
1702
while (current_rev_id in parents_map and
1703
len(parents_map[current_rev_id]) > 0):
1704
check_not_reserved_id(current_rev_id)
1705
new_history.append(current_rev_id)
1706
current_rev_id = parents_map[current_rev_id][0]
1707
parents_map = graph.get_parent_map([current_rev_id])
1708
new_history.reverse()
1712
def generate_revision_history(self, revision_id, last_rev=None,
1714
"""Create a new revision history that will finish with revision_id.
1716
:param revision_id: the new tip to use.
1717
:param last_rev: The previous last_revision. If not None, then this
1718
must be a ancestory of revision_id, or DivergedBranches is raised.
1719
:param other_branch: The other branch that DivergedBranches should
1720
raise with respect to.
1722
self.set_revision_history(self._lefthand_history(revision_id,
1723
last_rev, other_branch))
1725
def basis_tree(self):
1726
"""See Branch.basis_tree."""
1727
return self.repository.revision_tree(self.last_revision())
1730
def pull(self, source, overwrite=False, stop_revision=None,
1731
_hook_master=None, run_hooks=True, possible_transports=None,
1732
_override_hook_target=None):
1735
:param _hook_master: Private parameter - set the branch to
1736
be supplied as the master to pull hooks.
1737
:param run_hooks: Private parameter - if false, this branch
1738
is being called because it's the master of the primary branch,
1739
so it should not run its hooks.
1740
:param _override_hook_target: Private parameter - set the branch to be
1741
supplied as the target_branch to pull hooks.
1743
result = PullResult()
1744
result.source_branch = source
1745
if _override_hook_target is None:
1746
result.target_branch = self
1748
result.target_branch = _override_hook_target
1751
# We assume that during 'pull' the local repository is closer than
1753
graph = self.repository.get_graph(source.repository)
1754
result.old_revno, result.old_revid = self.last_revision_info()
1755
self.update_revisions(source, stop_revision, overwrite=overwrite,
1757
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1758
result.new_revno, result.new_revid = self.last_revision_info()
1760
result.master_branch = _hook_master
1761
result.local_branch = result.target_branch
1763
result.master_branch = result.target_branch
1764
result.local_branch = None
1766
for hook in Branch.hooks['post_pull']:
1772
def _get_parent_location(self):
1773
_locs = ['parent', 'pull', 'x-pull']
1776
return self._transport.get_bytes(l).strip('\n')
1777
except errors.NoSuchFile:
1782
def push(self, target, overwrite=False, stop_revision=None,
1783
_override_hook_source_branch=None):
1786
This is the basic concrete implementation of push()
1788
:param _override_hook_source_branch: If specified, run
1789
the hooks passing this Branch as the source, rather than self.
1790
This is for use of RemoteBranch, where push is delegated to the
1791
underlying vfs-based Branch.
1793
# TODO: Public option to disable running hooks - should be trivial but
1795
return _run_with_write_locked_target(
1796
target, self._push_with_bound_branches, target, overwrite,
1798
_override_hook_source_branch=_override_hook_source_branch)
1800
def _push_with_bound_branches(self, target, overwrite,
1802
_override_hook_source_branch=None):
1803
"""Push from self into target, and into target's master if any.
1805
This is on the base BzrBranch class even though it doesn't support
1806
bound branches because the *target* might be bound.
1809
if _override_hook_source_branch:
1810
result.source_branch = _override_hook_source_branch
1811
for hook in Branch.hooks['post_push']:
1814
bound_location = target.get_bound_location()
1815
if bound_location and target.base != bound_location:
1816
# there is a master branch.
1818
# XXX: Why the second check? Is it even supported for a branch to
1819
# be bound to itself? -- mbp 20070507
1820
master_branch = target.get_master_branch()
1821
master_branch.lock_write()
1823
# push into the master from this branch.
1824
self._basic_push(master_branch, overwrite, stop_revision)
1825
# and push into the target branch from this. Note that we push from
1826
# this branch again, because its considered the highest bandwidth
1828
result = self._basic_push(target, overwrite, stop_revision)
1829
result.master_branch = master_branch
1830
result.local_branch = target
1834
master_branch.unlock()
1837
result = self._basic_push(target, overwrite, stop_revision)
1838
# TODO: Why set master_branch and local_branch if there's no
1839
# binding? Maybe cleaner to just leave them unset? -- mbp
1841
result.master_branch = target
1842
result.local_branch = None
1846
def _basic_push(self, target, overwrite, stop_revision):
1847
"""Basic implementation of push without bound branches or hooks.
1849
Must be called with self read locked and target write locked.
1851
result = PushResult()
1852
result.source_branch = self
1853
result.target_branch = target
1854
result.old_revno, result.old_revid = target.last_revision_info()
1855
if result.old_revid != self.last_revision():
1856
# We assume that during 'push' this repository is closer than
1858
graph = self.repository.get_graph(target.repository)
1859
target.update_revisions(self, stop_revision, overwrite=overwrite,
1861
if self._push_should_merge_tags():
1862
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1863
result.new_revno, result.new_revid = target.last_revision_info()
1866
def _push_should_merge_tags(self):
1867
"""Should _basic_push merge this branch's tags into the target?
1869
The default implementation returns False if this branch has no tags,
1870
and True the rest of the time. Subclasses may override this.
1872
return self.tags.supports_tags() and self.tags.get_tag_dict()
1874
def get_parent(self):
1875
"""See Branch.get_parent."""
1876
parent = self._get_parent_location()
1879
# This is an old-format absolute path to a local branch
1880
# turn it into a url
1881
if parent.startswith('/'):
1882
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1884
return urlutils.join(self.base[:-1], parent)
1885
except errors.InvalidURLJoin, e:
1886
raise errors.InaccessibleParent(parent, self.base)
1888
def get_stacked_on_url(self):
1889
raise errors.UnstackableBranchFormat(self._format, self.base)
1891
def set_push_location(self, location):
1892
"""See Branch.set_push_location."""
1893
self.get_config().set_user_option(
1894
'push_location', location,
1895
store=_mod_config.STORE_LOCATION_NORECURSE)
1898
def set_parent(self, url):
1899
"""See Branch.set_parent."""
1900
# TODO: Maybe delete old location files?
1901
# URLs should never be unicode, even on the local fs,
1902
# FIXUP this and get_parent in a future branch format bump:
1903
# read and rewrite the file. RBC 20060125
1905
if isinstance(url, unicode):
1907
url = url.encode('ascii')
1908
except UnicodeEncodeError:
1909
raise errors.InvalidURL(url,
1910
"Urls must be 7-bit ascii, "
1911
"use bzrlib.urlutils.escape")
1912
url = urlutils.relative_url(self.base, url)
1913
self._set_parent_location(url)
1915
def _set_parent_location(self, url):
1917
self._transport.delete('parent')
1919
self._transport.put_bytes('parent', url + '\n',
1920
mode=self.bzrdir._get_file_mode())
1922
def set_stacked_on_url(self, url):
1923
raise errors.UnstackableBranchFormat(self._format, self.base)
1926
class BzrBranch5(BzrBranch):
1927
"""A format 5 branch. This supports new features over plain branches.
1929
It has support for a master_branch which is the data for bound branches.
1933
def pull(self, source, overwrite=False, stop_revision=None,
1934
run_hooks=True, possible_transports=None,
1935
_override_hook_target=None):
1936
"""Pull from source into self, updating my master if any.
1938
:param run_hooks: Private parameter - if false, this branch
1939
is being called because it's the master of the primary branch,
1940
so it should not run its hooks.
1942
bound_location = self.get_bound_location()
1943
master_branch = None
1944
if bound_location and source.base != bound_location:
1945
# not pulling from master, so we need to update master.
1946
master_branch = self.get_master_branch(possible_transports)
1947
master_branch.lock_write()
1950
# pull from source into master.
1951
master_branch.pull(source, overwrite, stop_revision,
1953
return super(BzrBranch5, self).pull(source, overwrite,
1954
stop_revision, _hook_master=master_branch,
1955
run_hooks=run_hooks,
1956
_override_hook_target=_override_hook_target)
1959
master_branch.unlock()
1961
def get_bound_location(self):
1963
return self._transport.get_bytes('bound')[:-1]
1964
except errors.NoSuchFile:
1968
def get_master_branch(self, possible_transports=None):
1969
"""Return the branch we are bound to.
1971
:return: Either a Branch, or None
1973
This could memoise the branch, but if thats done
1974
it must be revalidated on each new lock.
1975
So for now we just don't memoise it.
1976
# RBC 20060304 review this decision.
1978
bound_loc = self.get_bound_location()
1982
return Branch.open(bound_loc,
1983
possible_transports=possible_transports)
1984
except (errors.NotBranchError, errors.ConnectionError), e:
1985
raise errors.BoundBranchConnectionFailure(
1989
def set_bound_location(self, location):
1990
"""Set the target where this branch is bound to.
1992
:param location: URL to the target branch
1995
self._transport.put_bytes('bound', location+'\n',
1996
mode=self.bzrdir._get_file_mode())
1999
self._transport.delete('bound')
2000
except errors.NoSuchFile:
2005
def bind(self, other):
2006
"""Bind this branch to the branch other.
2008
This does not push or pull data between the branches, though it does
2009
check for divergence to raise an error when the branches are not
2010
either the same, or one a prefix of the other. That behaviour may not
2011
be useful, so that check may be removed in future.
2013
:param other: The branch to bind to
2016
# TODO: jam 20051230 Consider checking if the target is bound
2017
# It is debatable whether you should be able to bind to
2018
# a branch which is itself bound.
2019
# Committing is obviously forbidden,
2020
# but binding itself may not be.
2021
# Since we *have* to check at commit time, we don't
2022
# *need* to check here
2024
# we want to raise diverged if:
2025
# last_rev is not in the other_last_rev history, AND
2026
# other_last_rev is not in our history, and do it without pulling
2028
self.set_bound_location(other.base)
2032
"""If bound, unbind"""
2033
return self.set_bound_location(None)
2036
def update(self, possible_transports=None):
2037
"""Synchronise this branch with the master branch if any.
2039
:return: None or the last_revision that was pivoted out during the
2042
master = self.get_master_branch(possible_transports)
2043
if master is not None:
2044
old_tip = _mod_revision.ensure_null(self.last_revision())
2045
self.pull(master, overwrite=True)
2046
if self.repository.get_graph().is_ancestor(old_tip,
2047
_mod_revision.ensure_null(self.last_revision())):
2053
class BzrBranch7(BzrBranch5):
2054
"""A branch with support for a fallback repository."""
2056
def _get_fallback_repository(self, url):
2057
"""Get the repository we fallback to at url."""
2058
url = urlutils.join(self.base, url)
2059
return bzrdir.BzrDir.open(url).open_branch().repository
2061
def _activate_fallback_location(self, url):
2062
"""Activate the branch/repository from url as a fallback repository."""
2063
self.repository.add_fallback_repository(
2064
self._get_fallback_repository(url))
2066
def _open_hook(self):
2068
url = self.get_stacked_on_url()
2069
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2070
errors.UnstackableBranchFormat):
2073
for hook in Branch.hooks['transform_fallback_location']:
2074
url = hook(self, url)
2076
hook_name = Branch.hooks.get_hook_name(hook)
2077
raise AssertionError(
2078
"'transform_fallback_location' hook %s returned "
2079
"None, not a URL." % hook_name)
2080
self._activate_fallback_location(url)
2082
def _check_stackable_repo(self):
2083
if not self.repository._format.supports_external_lookups:
2084
raise errors.UnstackableRepositoryFormat(self.repository._format,
2085
self.repository.base)
2087
def __init__(self, *args, **kwargs):
2088
super(BzrBranch7, self).__init__(*args, **kwargs)
2089
self._last_revision_info_cache = None
2090
self._partial_revision_history_cache = []
2092
def _clear_cached_state(self):
2093
super(BzrBranch7, self)._clear_cached_state()
2094
self._last_revision_info_cache = None
2095
self._partial_revision_history_cache = []
2097
def _last_revision_info(self):
2098
revision_string = self._transport.get_bytes('last-revision')
2099
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2100
revision_id = cache_utf8.get_cached_utf8(revision_id)
2102
return revno, revision_id
2104
def _write_last_revision_info(self, revno, revision_id):
2105
"""Simply write out the revision id, with no checks.
2107
Use set_last_revision_info to perform this safely.
2109
Does not update the revision_history cache.
2110
Intended to be called by set_last_revision_info and
2111
_write_revision_history.
2113
revision_id = _mod_revision.ensure_null(revision_id)
2114
out_string = '%d %s\n' % (revno, revision_id)
2115
self._transport.put_bytes('last-revision', out_string,
2116
mode=self.bzrdir._get_file_mode())
2119
def set_last_revision_info(self, revno, revision_id):
2120
revision_id = _mod_revision.ensure_null(revision_id)
2121
old_revno, old_revid = self.last_revision_info()
2122
if self._get_append_revisions_only():
2123
self._check_history_violation(revision_id)
2124
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2125
self._write_last_revision_info(revno, revision_id)
2126
self._clear_cached_state()
2127
self._last_revision_info_cache = revno, revision_id
2128
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2130
def _synchronize_history(self, destination, revision_id):
2131
"""Synchronize last revision and revision history between branches.
2133
:see: Branch._synchronize_history
2135
# XXX: The base Branch has a fast implementation of this method based
2136
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2137
# that uses set_revision_history. This class inherits from BzrBranch5,
2138
# but wants the fast implementation, so it calls
2139
# Branch._synchronize_history directly.
2140
Branch._synchronize_history(self, destination, revision_id)
2142
def _check_history_violation(self, revision_id):
2143
last_revision = _mod_revision.ensure_null(self.last_revision())
2144
if _mod_revision.is_null(last_revision):
2146
if last_revision not in self._lefthand_history(revision_id):
2147
raise errors.AppendRevisionsOnlyViolation(self.base)
2149
def _gen_revision_history(self):
2150
"""Generate the revision history from last revision
2152
last_revno, last_revision = self.last_revision_info()
2153
self._extend_partial_history(stop_index=last_revno-1)
2154
return list(reversed(self._partial_revision_history_cache))
2156
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2157
"""Extend the partial history to include a given index
2159
If a stop_index is supplied, stop when that index has been reached.
2160
If a stop_revision is supplied, stop when that revision is
2161
encountered. Otherwise, stop when the beginning of history is
2164
:param stop_index: The index which should be present. When it is
2165
present, history extension will stop.
2166
:param revision_id: The revision id which should be present. When
2167
it is encountered, history extension will stop.
2169
repo = self.repository
2170
if len(self._partial_revision_history_cache) == 0:
2171
iterator = repo.iter_reverse_revision_history(self.last_revision())
2173
start_revision = self._partial_revision_history_cache[-1]
2174
iterator = repo.iter_reverse_revision_history(start_revision)
2175
#skip the last revision in the list
2176
next_revision = iterator.next()
2177
for revision_id in iterator:
2178
self._partial_revision_history_cache.append(revision_id)
2179
if (stop_index is not None and
2180
len(self._partial_revision_history_cache) > stop_index):
2182
if revision_id == stop_revision:
2185
def _write_revision_history(self, history):
2186
"""Factored out of set_revision_history.
2188
This performs the actual writing to disk, with format-specific checks.
2189
It is intended to be called by BzrBranch5.set_revision_history.
2191
if len(history) == 0:
2192
last_revision = 'null:'
2194
if history != self._lefthand_history(history[-1]):
2195
raise errors.NotLefthandHistory(history)
2196
last_revision = history[-1]
2197
if self._get_append_revisions_only():
2198
self._check_history_violation(last_revision)
2199
self._write_last_revision_info(len(history), last_revision)
2202
def _set_parent_location(self, url):
2203
"""Set the parent branch"""
2204
self._set_config_location('parent_location', url, make_relative=True)
2207
def _get_parent_location(self):
2208
"""Set the parent branch"""
2209
return self._get_config_location('parent_location')
2211
def set_push_location(self, location):
2212
"""See Branch.set_push_location."""
2213
self._set_config_location('push_location', location)
2215
def set_bound_location(self, location):
2216
"""See Branch.set_push_location."""
2218
config = self.get_config()
2219
if location is None:
2220
if config.get_user_option('bound') != 'True':
2223
config.set_user_option('bound', 'False', warn_masked=True)
2226
self._set_config_location('bound_location', location,
2228
config.set_user_option('bound', 'True', warn_masked=True)
2231
def _get_bound_location(self, bound):
2232
"""Return the bound location in the config file.
2234
Return None if the bound parameter does not match"""
2235
config = self.get_config()
2236
config_bound = (config.get_user_option('bound') == 'True')
2237
if config_bound != bound:
2239
return self._get_config_location('bound_location', config=config)
2241
def get_bound_location(self):
2242
"""See Branch.set_push_location."""
2243
return self._get_bound_location(True)
2245
def get_old_bound_location(self):
2246
"""See Branch.get_old_bound_location"""
2247
return self._get_bound_location(False)
2249
def get_stacked_on_url(self):
2250
# you can always ask for the URL; but you might not be able to use it
2251
# if the repo can't support stacking.
2252
## self._check_stackable_repo()
2253
stacked_url = self._get_config_location('stacked_on_location')
2254
if stacked_url is None:
2255
raise errors.NotStacked(self)
2258
def set_append_revisions_only(self, enabled):
2263
self.get_config().set_user_option('append_revisions_only', value,
2266
def set_stacked_on_url(self, url):
2267
self._check_stackable_repo()
2270
old_url = self.get_stacked_on_url()
2271
except (errors.NotStacked, errors.UnstackableBranchFormat,
2272
errors.UnstackableRepositoryFormat):
2275
# repositories don't offer an interface to remove fallback
2276
# repositories today; take the conceptually simpler option and just
2278
self.repository = self.bzrdir.find_repository()
2279
# for every revision reference the branch has, ensure it is pulled
2281
source_repository = self._get_fallback_repository(old_url)
2282
for revision_id in chain([self.last_revision()],
2283
self.tags.get_reverse_tag_dict()):
2284
self.repository.fetch(source_repository, revision_id,
2287
self._activate_fallback_location(url)
2288
# write this out after the repository is stacked to avoid setting a
2289
# stacked config that doesn't work.
2290
self._set_config_location('stacked_on_location', url)
2292
def _get_append_revisions_only(self):
2293
value = self.get_config().get_user_option('append_revisions_only')
2294
return value == 'True'
2296
def _make_tags(self):
2297
return BasicTags(self)
2300
def generate_revision_history(self, revision_id, last_rev=None,
2302
"""See BzrBranch5.generate_revision_history"""
2303
history = self._lefthand_history(revision_id, last_rev, other_branch)
2304
revno = len(history)
2305
self.set_last_revision_info(revno, revision_id)
2308
def get_rev_id(self, revno, history=None):
2309
"""Find the revision id of the specified revno."""
2311
return _mod_revision.NULL_REVISION
2313
last_revno, last_revision_id = self.last_revision_info()
2314
if revno <= 0 or revno > last_revno:
2315
raise errors.NoSuchRevision(self, revno)
2317
if history is not None:
2318
return history[revno - 1]
2320
index = last_revno - revno
2321
if len(self._partial_revision_history_cache) <= index:
2322
self._extend_partial_history(stop_index=index)
2323
if len(self._partial_revision_history_cache) > index:
2324
return self._partial_revision_history_cache[index]
2326
raise errors.NoSuchRevision(self, revno)
2329
def revision_id_to_revno(self, revision_id):
2330
"""Given a revision id, return its revno"""
2331
if _mod_revision.is_null(revision_id):
2334
index = self._partial_revision_history_cache.index(revision_id)
2336
self._extend_partial_history(stop_revision=revision_id)
2337
index = len(self._partial_revision_history_cache) - 1
2338
if self._partial_revision_history_cache[index] != revision_id:
2339
raise errors.NoSuchRevision(self, revision_id)
2340
return self.revno() - index
2343
class BzrBranch6(BzrBranch7):
2344
"""See BzrBranchFormat6 for the capabilities of this branch.
2346
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2350
def get_stacked_on_url(self):
2351
raise errors.UnstackableBranchFormat(self._format, self.base)
2353
def set_stacked_on_url(self, url):
2354
raise errors.UnstackableBranchFormat(self._format, self.base)
2357
######################################################################
2358
# results of operations
2361
class _Result(object):
2363
def _show_tag_conficts(self, to_file):
2364
if not getattr(self, 'tag_conflicts', None):
2366
to_file.write('Conflicting tags:\n')
2367
for name, value1, value2 in self.tag_conflicts:
2368
to_file.write(' %s\n' % (name, ))
2371
class PullResult(_Result):
2372
"""Result of a Branch.pull operation.
2374
:ivar old_revno: Revision number before pull.
2375
:ivar new_revno: Revision number after pull.
2376
:ivar old_revid: Tip revision id before pull.
2377
:ivar new_revid: Tip revision id after pull.
2378
:ivar source_branch: Source (local) branch object.
2379
:ivar master_branch: Master branch of the target, or the target if no
2381
:ivar local_branch: target branch if there is a Master, else None
2382
:ivar target_branch: Target/destination branch object.
2383
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2387
# DEPRECATED: pull used to return the change in revno
2388
return self.new_revno - self.old_revno
2390
def report(self, to_file):
2392
if self.old_revid == self.new_revid:
2393
to_file.write('No revisions to pull.\n')
2395
to_file.write('Now on revision %d.\n' % self.new_revno)
2396
self._show_tag_conficts(to_file)
2399
class PushResult(_Result):
2400
"""Result of a Branch.push operation.
2402
:ivar old_revno: Revision number before push.
2403
:ivar new_revno: Revision number after push.
2404
:ivar old_revid: Tip revision id before push.
2405
:ivar new_revid: Tip revision id after push.
2406
:ivar source_branch: Source branch object.
2407
:ivar master_branch: Master branch of the target, or None.
2408
:ivar target_branch: Target/destination branch object.
2412
# DEPRECATED: push used to return the change in revno
2413
return self.new_revno - self.old_revno
2415
def report(self, to_file):
2416
"""Write a human-readable description of the result."""
2417
if self.old_revid == self.new_revid:
2418
to_file.write('No new revisions to push.\n')
2420
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2421
self._show_tag_conficts(to_file)
2424
class BranchCheckResult(object):
2425
"""Results of checking branch consistency.
2430
def __init__(self, branch):
2431
self.branch = branch
2433
def report_results(self, verbose):
2434
"""Report the check results via trace.note.
2436
:param verbose: Requests more detailed display of what was checked,
2439
note('checked branch %s format %s',
2441
self.branch._format)
2444
class Converter5to6(object):
2445
"""Perform an in-place upgrade of format 5 to format 6"""
2447
def convert(self, branch):
2448
# Data for 5 and 6 can peacefully coexist.
2449
format = BzrBranchFormat6()
2450
new_branch = format.open(branch.bzrdir, _found=True)
2452
# Copy source data into target
2453
new_branch._write_last_revision_info(*branch.last_revision_info())
2454
new_branch.set_parent(branch.get_parent())
2455
new_branch.set_bound_location(branch.get_bound_location())
2456
new_branch.set_push_location(branch.get_push_location())
2458
# New branch has no tags by default
2459
new_branch.tags._set_tag_dict({})
2461
# Copying done; now update target format
2462
new_branch._transport.put_bytes('format',
2463
format.get_format_string(),
2464
mode=new_branch.bzrdir._get_file_mode())
2466
# Clean up old files
2467
new_branch._transport.delete('revision-history')
2469
branch.set_parent(None)
2470
except errors.NoSuchFile:
2472
branch.set_bound_location(None)
2475
class Converter6to7(object):
2476
"""Perform an in-place upgrade of format 6 to format 7"""
2478
def convert(self, branch):
2479
format = BzrBranchFormat7()
2480
branch._set_config_location('stacked_on_location', '')
2481
# update target format
2482
branch._transport.put_bytes('format', format.get_format_string())
2486
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2487
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2490
_run_with_write_locked_target will attempt to release the lock it acquires.
2492
If an exception is raised by callable, then that exception *will* be
2493
propagated, even if the unlock attempt raises its own error. Thus
2494
_run_with_write_locked_target should be preferred to simply doing::
2498
return callable(*args, **kwargs)
2503
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2504
# should share code?
2507
result = callable(*args, **kwargs)
2509
exc_info = sys.exc_info()
2513
raise exc_info[0], exc_info[1], exc_info[2]
added
removed
bzrlib/branch.py
