1
# Copyright (C) 2005-2011 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
from cStringIO import StringIO
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from itertools import chain
27
config as _mod_config,
36
revision as _mod_revision,
44
from bzrlib.config import BranchConfig, TransportConfig
45
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
46
from bzrlib.tag import (
55
from bzrlib.decorators import (
60
from bzrlib.hooks import Hooks
61
from bzrlib.inter import InterObject
62
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
63
from bzrlib import registry
64
from bzrlib.symbol_versioning import (
68
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
71
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
72
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
73
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
76
class Branch(controldir.ControlComponent):
77
"""Branch holding a history of revisions.
80
Base directory/url of the branch; using control_url and
81
control_transport is more standardized.
82
:ivar hooks: An instance of BranchHooks.
83
:ivar _master_branch_cache: cached result of get_master_branch, see
86
# this is really an instance variable - FIXME move it there
91
def control_transport(self):
92
return self._transport
95
def user_transport(self):
96
return self.bzrdir.user_transport
98
def __init__(self, *ignored, **ignored_too):
99
self.tags = self._format.make_tags(self)
100
self._revision_history_cache = None
101
self._revision_id_to_revno_cache = None
102
self._partial_revision_id_to_revno_cache = {}
103
self._partial_revision_history_cache = []
104
self._tags_bytes = None
105
self._last_revision_info_cache = None
106
self._master_branch_cache = None
107
self._merge_sorted_revisions_cache = None
109
hooks = Branch.hooks['open']
113
def _open_hook(self):
114
"""Called by init to allow simpler extension of the base class."""
116
def _activate_fallback_location(self, url):
117
"""Activate the branch/repository from url as a fallback repository."""
118
for existing_fallback_repo in self.repository._fallback_repositories:
119
if existing_fallback_repo.user_url == url:
120
# This fallback is already configured. This probably only
121
# happens because BzrDir.sprout is a horrible mess. To avoid
122
# confusing _unstack we don't add this a second time.
123
mutter('duplicate activation of fallback %r on %r', url, self)
125
repo = self._get_fallback_repository(url)
126
if repo.has_same_location(self.repository):
127
raise errors.UnstackableLocationError(self.user_url, url)
128
self.repository.add_fallback_repository(repo)
130
def break_lock(self):
131
"""Break a lock if one is present from another instance.
133
Uses the ui factory to ask for confirmation if the lock may be from
136
This will probe the repository for its lock as well.
138
self.control_files.break_lock()
139
self.repository.break_lock()
140
master = self.get_master_branch()
141
if master is not None:
144
def _check_stackable_repo(self):
145
if not self.repository._format.supports_external_lookups:
146
raise errors.UnstackableRepositoryFormat(self.repository._format,
147
self.repository.base)
149
def _extend_partial_history(self, stop_index=None, stop_revision=None):
150
"""Extend the partial history to include a given index
152
If a stop_index is supplied, stop when that index has been reached.
153
If a stop_revision is supplied, stop when that revision is
154
encountered. Otherwise, stop when the beginning of history is
157
:param stop_index: The index which should be present. When it is
158
present, history extension will stop.
159
:param stop_revision: The revision id which should be present. When
160
it is encountered, history extension will stop.
162
if len(self._partial_revision_history_cache) == 0:
163
self._partial_revision_history_cache = [self.last_revision()]
164
repository._iter_for_revno(
165
self.repository, self._partial_revision_history_cache,
166
stop_index=stop_index, stop_revision=stop_revision)
167
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
168
self._partial_revision_history_cache.pop()
170
def _get_check_refs(self):
171
"""Get the references needed for check().
175
revid = self.last_revision()
176
return [('revision-existence', revid), ('lefthand-distance', revid)]
179
def open(base, _unsupported=False, possible_transports=None):
180
"""Open the branch rooted at base.
182
For instance, if the branch is at URL/.bzr/branch,
183
Branch.open(URL) -> a Branch instance.
185
control = bzrdir.BzrDir.open(base, _unsupported,
186
possible_transports=possible_transports)
187
return control.open_branch(unsupported=_unsupported)
190
def open_from_transport(transport, name=None, _unsupported=False):
191
"""Open the branch rooted at transport"""
192
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
193
return control.open_branch(name=name, unsupported=_unsupported)
196
def open_containing(url, possible_transports=None):
197
"""Open an existing branch which contains url.
199
This probes for a branch at url, and searches upwards from there.
201
Basically we keep looking up until we find the control directory or
202
run into the root. If there isn't one, raises NotBranchError.
203
If there is one and it is either an unrecognised format or an unsupported
204
format, UnknownFormatError or UnsupportedFormatError are raised.
205
If there is one, it is returned, along with the unused portion of url.
207
control, relpath = bzrdir.BzrDir.open_containing(url,
209
return control.open_branch(), relpath
211
def _push_should_merge_tags(self):
212
"""Should _basic_push merge this branch's tags into the target?
214
The default implementation returns False if this branch has no tags,
215
and True the rest of the time. Subclasses may override this.
217
return self.supports_tags() and self.tags.get_tag_dict()
219
def get_config(self):
220
"""Get a bzrlib.config.BranchConfig for this Branch.
222
This can then be used to get and set configuration options for the
225
:return: A bzrlib.config.BranchConfig.
227
return BranchConfig(self)
229
def _get_config(self):
230
"""Get the concrete config for just the config in this branch.
232
This is not intended for client use; see Branch.get_config for the
237
:return: An object supporting get_option and set_option.
239
raise NotImplementedError(self._get_config)
241
def _get_fallback_repository(self, url):
242
"""Get the repository we fallback to at url."""
243
url = urlutils.join(self.base, url)
244
a_branch = Branch.open(url,
245
possible_transports=[self.bzrdir.root_transport])
246
return a_branch.repository
249
def _get_tags_bytes(self):
250
"""Get the bytes of a serialised tags dict.
252
Note that not all branches support tags, nor do all use the same tags
253
logic: this method is specific to BasicTags. Other tag implementations
254
may use the same method name and behave differently, safely, because
255
of the double-dispatch via
256
format.make_tags->tags_instance->get_tags_dict.
258
:return: The bytes of the tags file.
259
:seealso: Branch._set_tags_bytes.
261
if self._tags_bytes is None:
262
self._tags_bytes = self._transport.get_bytes('tags')
263
return self._tags_bytes
265
def _get_nick(self, local=False, possible_transports=None):
266
config = self.get_config()
267
# explicit overrides master, but don't look for master if local is True
268
if not local and not config.has_explicit_nickname():
270
master = self.get_master_branch(possible_transports)
271
if master and self.user_url == master.user_url:
272
raise errors.RecursiveBind(self.user_url)
273
if master is not None:
274
# return the master branch value
276
except errors.RecursiveBind, e:
278
except errors.BzrError, e:
279
# Silently fall back to local implicit nick if the master is
281
mutter("Could not connect to bound branch, "
282
"falling back to local nick.\n " + str(e))
283
return config.get_nickname()
285
def _set_nick(self, nick):
286
self.get_config().set_user_option('nickname', nick, warn_masked=True)
288
nick = property(_get_nick, _set_nick)
291
raise NotImplementedError(self.is_locked)
293
def _lefthand_history(self, revision_id, last_rev=None,
295
if 'evil' in debug.debug_flags:
296
mutter_callsite(4, "_lefthand_history scales with history.")
297
# stop_revision must be a descendant of last_revision
298
graph = self.repository.get_graph()
299
if last_rev is not None:
300
if not graph.is_ancestor(last_rev, revision_id):
301
# our previous tip is not merged into stop_revision
302
raise errors.DivergedBranches(self, other_branch)
303
# make a new revision history from the graph
304
parents_map = graph.get_parent_map([revision_id])
305
if revision_id not in parents_map:
306
raise errors.NoSuchRevision(self, revision_id)
307
current_rev_id = revision_id
309
check_not_reserved_id = _mod_revision.check_not_reserved_id
310
# Do not include ghosts or graph origin in revision_history
311
while (current_rev_id in parents_map and
312
len(parents_map[current_rev_id]) > 0):
313
check_not_reserved_id(current_rev_id)
314
new_history.append(current_rev_id)
315
current_rev_id = parents_map[current_rev_id][0]
316
parents_map = graph.get_parent_map([current_rev_id])
317
new_history.reverse()
320
def lock_write(self, token=None):
321
"""Lock the branch for write operations.
323
:param token: A token to permit reacquiring a previously held and
325
:return: A BranchWriteLockResult.
327
raise NotImplementedError(self.lock_write)
330
"""Lock the branch for read operations.
332
:return: A bzrlib.lock.LogicalLockResult.
334
raise NotImplementedError(self.lock_read)
337
raise NotImplementedError(self.unlock)
339
def peek_lock_mode(self):
340
"""Return lock mode for the Branch: 'r', 'w' or None"""
341
raise NotImplementedError(self.peek_lock_mode)
343
def get_physical_lock_status(self):
344
raise NotImplementedError(self.get_physical_lock_status)
347
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
348
"""Return the revision_id for a dotted revno.
350
:param revno: a tuple like (1,) or (1,1,2)
351
:param _cache_reverse: a private parameter enabling storage
352
of the reverse mapping in a top level cache. (This should
353
only be done in selective circumstances as we want to
354
avoid having the mapping cached multiple times.)
355
:return: the revision_id
356
:raises errors.NoSuchRevision: if the revno doesn't exist
358
rev_id = self._do_dotted_revno_to_revision_id(revno)
360
self._partial_revision_id_to_revno_cache[rev_id] = revno
363
def _do_dotted_revno_to_revision_id(self, revno):
364
"""Worker function for dotted_revno_to_revision_id.
366
Subclasses should override this if they wish to
367
provide a more efficient implementation.
370
return self.get_rev_id(revno[0])
371
revision_id_to_revno = self.get_revision_id_to_revno_map()
372
revision_ids = [revision_id for revision_id, this_revno
373
in revision_id_to_revno.iteritems()
374
if revno == this_revno]
375
if len(revision_ids) == 1:
376
return revision_ids[0]
378
revno_str = '.'.join(map(str, revno))
379
raise errors.NoSuchRevision(self, revno_str)
382
def revision_id_to_dotted_revno(self, revision_id):
383
"""Given a revision id, return its dotted revno.
385
:return: a tuple like (1,) or (400,1,3).
387
return self._do_revision_id_to_dotted_revno(revision_id)
389
def _do_revision_id_to_dotted_revno(self, revision_id):
390
"""Worker function for revision_id_to_revno."""
391
# Try the caches if they are loaded
392
result = self._partial_revision_id_to_revno_cache.get(revision_id)
393
if result is not None:
395
if self._revision_id_to_revno_cache:
396
result = self._revision_id_to_revno_cache.get(revision_id)
398
raise errors.NoSuchRevision(self, revision_id)
399
# Try the mainline as it's optimised
401
revno = self.revision_id_to_revno(revision_id)
403
except errors.NoSuchRevision:
404
# We need to load and use the full revno map after all
405
result = self.get_revision_id_to_revno_map().get(revision_id)
407
raise errors.NoSuchRevision(self, revision_id)
411
def get_revision_id_to_revno_map(self):
412
"""Return the revision_id => dotted revno map.
414
This will be regenerated on demand, but will be cached.
416
:return: A dictionary mapping revision_id => dotted revno.
417
This dictionary should not be modified by the caller.
419
if self._revision_id_to_revno_cache is not None:
420
mapping = self._revision_id_to_revno_cache
422
mapping = self._gen_revno_map()
423
self._cache_revision_id_to_revno(mapping)
424
# TODO: jam 20070417 Since this is being cached, should we be returning
426
# I would rather not, and instead just declare that users should not
427
# modify the return value.
430
def _gen_revno_map(self):
431
"""Create a new mapping from revision ids to dotted revnos.
433
Dotted revnos are generated based on the current tip in the revision
435
This is the worker function for get_revision_id_to_revno_map, which
436
just caches the return value.
438
:return: A dictionary mapping revision_id => dotted revno.
440
revision_id_to_revno = dict((rev_id, revno)
441
for rev_id, depth, revno, end_of_merge
442
in self.iter_merge_sorted_revisions())
443
return revision_id_to_revno
446
def iter_merge_sorted_revisions(self, start_revision_id=None,
447
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
448
"""Walk the revisions for a branch in merge sorted order.
450
Merge sorted order is the output from a merge-aware,
451
topological sort, i.e. all parents come before their
452
children going forward; the opposite for reverse.
454
:param start_revision_id: the revision_id to begin walking from.
455
If None, the branch tip is used.
456
:param stop_revision_id: the revision_id to terminate the walk
457
after. If None, the rest of history is included.
458
:param stop_rule: if stop_revision_id is not None, the precise rule
459
to use for termination:
460
* 'exclude' - leave the stop revision out of the result (default)
461
* 'include' - the stop revision is the last item in the result
462
* 'with-merges' - include the stop revision and all of its
463
merged revisions in the result
464
* 'with-merges-without-common-ancestry' - filter out revisions
465
that are in both ancestries
466
:param direction: either 'reverse' or 'forward':
467
* reverse means return the start_revision_id first, i.e.
468
start at the most recent revision and go backwards in history
469
* forward returns tuples in the opposite order to reverse.
470
Note in particular that forward does *not* do any intelligent
471
ordering w.r.t. depth as some clients of this API may like.
472
(If required, that ought to be done at higher layers.)
474
:return: an iterator over (revision_id, depth, revno, end_of_merge)
477
* revision_id: the unique id of the revision
478
* depth: How many levels of merging deep this node has been
480
* revno_sequence: This field provides a sequence of
481
revision numbers for all revisions. The format is:
482
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
483
branch that the revno is on. From left to right the REVNO numbers
484
are the sequence numbers within that branch of the revision.
485
* end_of_merge: When True the next node (earlier in history) is
486
part of a different merge.
488
# Note: depth and revno values are in the context of the branch so
489
# we need the full graph to get stable numbers, regardless of the
491
if self._merge_sorted_revisions_cache is None:
492
last_revision = self.last_revision()
493
known_graph = self.repository.get_known_graph_ancestry(
495
self._merge_sorted_revisions_cache = known_graph.merge_sort(
497
filtered = self._filter_merge_sorted_revisions(
498
self._merge_sorted_revisions_cache, start_revision_id,
499
stop_revision_id, stop_rule)
500
# Make sure we don't return revisions that are not part of the
501
# start_revision_id ancestry.
502
filtered = self._filter_start_non_ancestors(filtered)
503
if direction == 'reverse':
505
if direction == 'forward':
506
return reversed(list(filtered))
508
raise ValueError('invalid direction %r' % direction)
510
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
511
start_revision_id, stop_revision_id, stop_rule):
512
"""Iterate over an inclusive range of sorted revisions."""
513
rev_iter = iter(merge_sorted_revisions)
514
if start_revision_id is not None:
515
for node in rev_iter:
516
rev_id = node.key[-1]
517
if rev_id != start_revision_id:
520
# The decision to include the start or not
521
# depends on the stop_rule if a stop is provided
522
# so pop this node back into the iterator
523
rev_iter = chain(iter([node]), rev_iter)
525
if stop_revision_id is None:
527
for node in rev_iter:
528
rev_id = node.key[-1]
529
yield (rev_id, node.merge_depth, node.revno,
531
elif stop_rule == 'exclude':
532
for node in rev_iter:
533
rev_id = node.key[-1]
534
if rev_id == stop_revision_id:
536
yield (rev_id, node.merge_depth, node.revno,
538
elif stop_rule == 'include':
539
for node in rev_iter:
540
rev_id = node.key[-1]
541
yield (rev_id, node.merge_depth, node.revno,
543
if rev_id == stop_revision_id:
545
elif stop_rule == 'with-merges-without-common-ancestry':
546
# We want to exclude all revisions that are already part of the
547
# stop_revision_id ancestry.
548
graph = self.repository.get_graph()
549
ancestors = graph.find_unique_ancestors(start_revision_id,
551
for node in rev_iter:
552
rev_id = node.key[-1]
553
if rev_id not in ancestors:
555
yield (rev_id, node.merge_depth, node.revno,
557
elif stop_rule == 'with-merges':
558
stop_rev = self.repository.get_revision(stop_revision_id)
559
if stop_rev.parent_ids:
560
left_parent = stop_rev.parent_ids[0]
562
left_parent = _mod_revision.NULL_REVISION
563
# left_parent is the actual revision we want to stop logging at,
564
# since we want to show the merged revisions after the stop_rev too
565
reached_stop_revision_id = False
566
revision_id_whitelist = []
567
for node in rev_iter:
568
rev_id = node.key[-1]
569
if rev_id == left_parent:
570
# reached the left parent after the stop_revision
572
if (not reached_stop_revision_id or
573
rev_id in revision_id_whitelist):
574
yield (rev_id, node.merge_depth, node.revno,
576
if reached_stop_revision_id or rev_id == stop_revision_id:
577
# only do the merged revs of rev_id from now on
578
rev = self.repository.get_revision(rev_id)
580
reached_stop_revision_id = True
581
revision_id_whitelist.extend(rev.parent_ids)
583
raise ValueError('invalid stop_rule %r' % stop_rule)
585
def _filter_start_non_ancestors(self, rev_iter):
586
# If we started from a dotted revno, we want to consider it as a tip
587
# and don't want to yield revisions that are not part of its
588
# ancestry. Given the order guaranteed by the merge sort, we will see
589
# uninteresting descendants of the first parent of our tip before the
591
first = rev_iter.next()
592
(rev_id, merge_depth, revno, end_of_merge) = first
595
# We start at a mainline revision so by definition, all others
596
# revisions in rev_iter are ancestors
597
for node in rev_iter:
602
pmap = self.repository.get_parent_map([rev_id])
603
parents = pmap.get(rev_id, [])
605
whitelist.update(parents)
607
# If there is no parents, there is nothing of interest left
609
# FIXME: It's hard to test this scenario here as this code is never
610
# called in that case. -- vila 20100322
613
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
615
if rev_id in whitelist:
616
pmap = self.repository.get_parent_map([rev_id])
617
parents = pmap.get(rev_id, [])
618
whitelist.remove(rev_id)
619
whitelist.update(parents)
621
# We've reached the mainline, there is nothing left to
625
# A revision that is not part of the ancestry of our
628
yield (rev_id, merge_depth, revno, end_of_merge)
630
def leave_lock_in_place(self):
631
"""Tell this branch object not to release the physical lock when this
634
If lock_write doesn't return a token, then this method is not supported.
636
self.control_files.leave_in_place()
638
def dont_leave_lock_in_place(self):
639
"""Tell this branch object to release the physical lock when this
640
object is unlocked, even if it didn't originally acquire it.
642
If lock_write doesn't return a token, then this method is not supported.
644
self.control_files.dont_leave_in_place()
646
def bind(self, other):
647
"""Bind the local branch the other branch.
649
:param other: The branch to bind to
652
raise errors.UpgradeRequired(self.user_url)
654
def set_append_revisions_only(self, enabled):
655
if not self._format.supports_set_append_revisions_only():
656
raise errors.UpgradeRequired(self.user_url)
661
self.get_config().set_user_option('append_revisions_only', value,
664
def set_reference_info(self, file_id, tree_path, branch_location):
665
"""Set the branch location to use for a tree reference."""
666
raise errors.UnsupportedOperation(self.set_reference_info, self)
668
def get_reference_info(self, file_id):
669
"""Get the tree_path and branch_location for a tree reference."""
670
raise errors.UnsupportedOperation(self.get_reference_info, self)
673
def fetch(self, from_branch, last_revision=None, fetch_spec=None):
674
"""Copy revisions from from_branch into this branch.
676
:param from_branch: Where to copy from.
677
:param last_revision: What revision to stop at (None for at the end
679
:param fetch_spec: If specified, a SearchResult or
680
PendingAncestryResult that describes which revisions to copy. This
681
allows copying multiple heads at once. Mutually exclusive with
685
return InterBranch.get(from_branch, self).fetch(last_revision,
688
def get_bound_location(self):
689
"""Return the URL of the branch we are bound to.
691
Older format branches cannot bind, please be sure to use a metadir
696
def get_old_bound_location(self):
697
"""Return the URL of the branch we used to be bound to
699
raise errors.UpgradeRequired(self.user_url)
701
def get_commit_builder(self, parents, config=None, timestamp=None,
702
timezone=None, committer=None, revprops=None,
704
"""Obtain a CommitBuilder for this branch.
706
:param parents: Revision ids of the parents of the new revision.
707
:param config: Optional configuration to use.
708
:param timestamp: Optional timestamp recorded for commit.
709
:param timezone: Optional timezone for timestamp.
710
:param committer: Optional committer to set for commit.
711
:param revprops: Optional dictionary of revision properties.
712
:param revision_id: Optional revision id.
716
config = self.get_config()
718
return self.repository.get_commit_builder(self, parents, config,
719
timestamp, timezone, committer, revprops, revision_id)
721
def get_master_branch(self, possible_transports=None):
722
"""Return the branch we are bound to.
724
:return: Either a Branch, or None
728
def get_revision_delta(self, revno):
729
"""Return the delta for one revision.
731
The delta is relative to its mainline predecessor, or the
732
empty tree for revision 1.
734
rh = self.revision_history()
735
if not (1 <= revno <= len(rh)):
736
raise errors.InvalidRevisionNumber(revno)
737
return self.repository.get_revision_delta(rh[revno-1])
739
def get_stacked_on_url(self):
740
"""Get the URL this branch is stacked against.
742
:raises NotStacked: If the branch is not stacked.
743
:raises UnstackableBranchFormat: If the branch does not support
746
raise NotImplementedError(self.get_stacked_on_url)
748
def print_file(self, file, revision_id):
749
"""Print `file` to stdout."""
750
raise NotImplementedError(self.print_file)
752
def set_revision_history(self, rev_history):
753
raise NotImplementedError(self.set_revision_history)
756
def set_parent(self, url):
757
"""See Branch.set_parent."""
758
# TODO: Maybe delete old location files?
759
# URLs should never be unicode, even on the local fs,
760
# FIXUP this and get_parent in a future branch format bump:
761
# read and rewrite the file. RBC 20060125
763
if isinstance(url, unicode):
765
url = url.encode('ascii')
766
except UnicodeEncodeError:
767
raise errors.InvalidURL(url,
768
"Urls must be 7-bit ascii, "
769
"use bzrlib.urlutils.escape")
770
url = urlutils.relative_url(self.base, url)
771
self._set_parent_location(url)
774
def set_stacked_on_url(self, url):
775
"""Set the URL this branch is stacked against.
777
:raises UnstackableBranchFormat: If the branch does not support
779
:raises UnstackableRepositoryFormat: If the repository does not support
782
if not self._format.supports_stacking():
783
raise errors.UnstackableBranchFormat(self._format, self.user_url)
784
# XXX: Changing from one fallback repository to another does not check
785
# that all the data you need is present in the new fallback.
786
# Possibly it should.
787
self._check_stackable_repo()
790
old_url = self.get_stacked_on_url()
791
except (errors.NotStacked, errors.UnstackableBranchFormat,
792
errors.UnstackableRepositoryFormat):
796
self._activate_fallback_location(url)
797
# write this out after the repository is stacked to avoid setting a
798
# stacked config that doesn't work.
799
self._set_config_location('stacked_on_location', url)
802
"""Change a branch to be unstacked, copying data as needed.
804
Don't call this directly, use set_stacked_on_url(None).
806
pb = ui.ui_factory.nested_progress_bar()
808
pb.update("Unstacking")
809
# The basic approach here is to fetch the tip of the branch,
810
# including all available ghosts, from the existing stacked
811
# repository into a new repository object without the fallbacks.
813
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
814
# correct for CHKMap repostiories
815
old_repository = self.repository
816
if len(old_repository._fallback_repositories) != 1:
817
raise AssertionError("can't cope with fallback repositories "
818
"of %r (fallbacks: %r)" % (old_repository,
819
old_repository._fallback_repositories))
820
# Open the new repository object.
821
# Repositories don't offer an interface to remove fallback
822
# repositories today; take the conceptually simpler option and just
823
# reopen it. We reopen it starting from the URL so that we
824
# get a separate connection for RemoteRepositories and can
825
# stream from one of them to the other. This does mean doing
826
# separate SSH connection setup, but unstacking is not a
827
# common operation so it's tolerable.
828
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
829
new_repository = new_bzrdir.find_repository()
830
if new_repository._fallback_repositories:
831
raise AssertionError("didn't expect %r to have "
832
"fallback_repositories"
833
% (self.repository,))
834
# Replace self.repository with the new repository.
835
# Do our best to transfer the lock state (i.e. lock-tokens and
836
# lock count) of self.repository to the new repository.
837
lock_token = old_repository.lock_write().repository_token
838
self.repository = new_repository
839
if isinstance(self, remote.RemoteBranch):
840
# Remote branches can have a second reference to the old
841
# repository that need to be replaced.
842
if self._real_branch is not None:
843
self._real_branch.repository = new_repository
844
self.repository.lock_write(token=lock_token)
845
if lock_token is not None:
846
old_repository.leave_lock_in_place()
847
old_repository.unlock()
848
if lock_token is not None:
849
# XXX: self.repository.leave_lock_in_place() before this
850
# function will not be preserved. Fortunately that doesn't
851
# affect the current default format (2a), and would be a
852
# corner-case anyway.
853
# - Andrew Bennetts, 2010/06/30
854
self.repository.dont_leave_lock_in_place()
858
old_repository.unlock()
859
except errors.LockNotHeld:
862
if old_lock_count == 0:
863
raise AssertionError(
864
'old_repository should have been locked at least once.')
865
for i in range(old_lock_count-1):
866
self.repository.lock_write()
867
# Fetch from the old repository into the new.
868
old_repository.lock_read()
870
# XXX: If you unstack a branch while it has a working tree
871
# with a pending merge, the pending-merged revisions will no
872
# longer be present. You can (probably) revert and remerge.
874
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
875
except errors.TagsNotSupported:
876
tags_to_fetch = set()
877
fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
878
old_repository, required_ids=[self.last_revision()],
879
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
880
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
882
old_repository.unlock()
886
def _set_tags_bytes(self, bytes):
887
"""Mirror method for _get_tags_bytes.
889
:seealso: Branch._get_tags_bytes.
891
return _run_with_write_locked_target(self, self._set_tags_bytes_locked,
894
def _set_tags_bytes_locked(self, bytes):
895
self._tags_bytes = bytes
896
return self._transport.put_bytes('tags', bytes)
898
def _cache_revision_history(self, rev_history):
899
"""Set the cached revision history to rev_history.
901
The revision_history method will use this cache to avoid regenerating
902
the revision history.
904
This API is semi-public; it only for use by subclasses, all other code
905
should consider it to be private.
907
self._revision_history_cache = rev_history
909
def _cache_revision_id_to_revno(self, revision_id_to_revno):
910
"""Set the cached revision_id => revno map to revision_id_to_revno.
912
This API is semi-public; it only for use by subclasses, all other code
913
should consider it to be private.
915
self._revision_id_to_revno_cache = revision_id_to_revno
917
def _clear_cached_state(self):
918
"""Clear any cached data on this branch, e.g. cached revision history.
920
This means the next call to revision_history will need to call
921
_gen_revision_history.
923
This API is semi-public; it only for use by subclasses, all other code
924
should consider it to be private.
926
self._revision_history_cache = None
927
self._revision_id_to_revno_cache = None
928
self._last_revision_info_cache = None
929
self._master_branch_cache = None
930
self._merge_sorted_revisions_cache = None
931
self._partial_revision_history_cache = []
932
self._partial_revision_id_to_revno_cache = {}
933
self._tags_bytes = None
935
def _gen_revision_history(self):
936
"""Return sequence of revision hashes on to this branch.
938
Unlike revision_history, this method always regenerates or rereads the
939
revision history, i.e. it does not cache the result, so repeated calls
942
Concrete subclasses should override this instead of revision_history so
943
that subclasses do not need to deal with caching logic.
945
This API is semi-public; it only for use by subclasses, all other code
946
should consider it to be private.
948
raise NotImplementedError(self._gen_revision_history)
951
def revision_history(self):
952
"""Return sequence of revision ids on this branch.
954
This method will cache the revision history for as long as it is safe to
957
if 'evil' in debug.debug_flags:
958
mutter_callsite(3, "revision_history scales with history.")
959
if self._revision_history_cache is not None:
960
history = self._revision_history_cache
962
history = self._gen_revision_history()
963
self._cache_revision_history(history)
967
"""Return current revision number for this branch.
969
That is equivalent to the number of revisions committed to
972
return self.last_revision_info()[0]
975
"""Older format branches cannot bind or unbind."""
976
raise errors.UpgradeRequired(self.user_url)
978
def last_revision(self):
979
"""Return last revision id, or NULL_REVISION."""
980
return self.last_revision_info()[1]
983
def last_revision_info(self):
984
"""Return information about the last revision.
986
:return: A tuple (revno, revision_id).
988
if self._last_revision_info_cache is None:
989
self._last_revision_info_cache = self._last_revision_info()
990
return self._last_revision_info_cache
992
def _last_revision_info(self):
993
rh = self.revision_history()
996
return (revno, rh[-1])
998
return (0, _mod_revision.NULL_REVISION)
1000
def update_revisions(self, other, stop_revision=None, overwrite=False,
1001
graph=None, fetch_tags=True):
1002
"""Pull in new perfect-fit revisions.
1004
:param other: Another Branch to pull from
1005
:param stop_revision: Updated until the given revision
1006
:param overwrite: Always set the branch pointer, rather than checking
1007
to see if it is a proper descendant.
1008
:param graph: A Graph object that can be used to query history
1009
information. This can be None.
1010
:param fetch_tags: Flag that specifies if tags from other should be
1014
return InterBranch.get(other, self).update_revisions(stop_revision,
1015
overwrite, graph, fetch_tags=fetch_tags)
1017
@deprecated_method(deprecated_in((2, 4, 0)))
1018
def import_last_revision_info(self, source_repo, revno, revid):
1019
"""Set the last revision info, importing from another repo if necessary.
1021
:param source_repo: Source repository to optionally fetch from
1022
:param revno: Revision number of the new tip
1023
:param revid: Revision id of the new tip
1025
if not self.repository.has_same_location(source_repo):
1026
self.repository.fetch(source_repo, revision_id=revid)
1027
self.set_last_revision_info(revno, revid)
1029
def import_last_revision_info_and_tags(self, source, revno, revid):
1030
"""Set the last revision info, importing from another repo if necessary.
1032
This is used by the bound branch code to upload a revision to
1033
the master branch first before updating the tip of the local branch.
1034
Revisions referenced by source's tags are also transferred.
1036
:param source: Source branch to optionally fetch from
1037
:param revno: Revision number of the new tip
1038
:param revid: Revision id of the new tip
1040
if not self.repository.has_same_location(source.repository):
1042
tags_to_fetch = set(source.tags.get_reverse_tag_dict())
1043
except errors.TagsNotSupported:
1044
tags_to_fetch = set()
1045
fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
1046
source.repository, [revid],
1047
if_present_ids=tags_to_fetch).execute()
1048
self.repository.fetch(source.repository, fetch_spec=fetch_spec)
1049
self.set_last_revision_info(revno, revid)
1051
def revision_id_to_revno(self, revision_id):
1052
"""Given a revision id, return its revno"""
1053
if _mod_revision.is_null(revision_id):
1055
history = self.revision_history()
1057
return history.index(revision_id) + 1
1059
raise errors.NoSuchRevision(self, revision_id)
1062
def get_rev_id(self, revno, history=None):
1063
"""Find the revision id of the specified revno."""
1065
return _mod_revision.NULL_REVISION
1066
last_revno, last_revid = self.last_revision_info()
1067
if revno == last_revno:
1069
if revno <= 0 or revno > last_revno:
1070
raise errors.NoSuchRevision(self, revno)
1071
distance_from_last = last_revno - revno
1072
if len(self._partial_revision_history_cache) <= distance_from_last:
1073
self._extend_partial_history(distance_from_last)
1074
return self._partial_revision_history_cache[distance_from_last]
1076
def pull(self, source, overwrite=False, stop_revision=None,
1077
possible_transports=None, *args, **kwargs):
1078
"""Mirror source into this branch.
1080
This branch is considered to be 'local', having low latency.
1082
:returns: PullResult instance
1084
return InterBranch.get(source, self).pull(overwrite=overwrite,
1085
stop_revision=stop_revision,
1086
possible_transports=possible_transports, *args, **kwargs)
1088
def push(self, target, overwrite=False, stop_revision=None, *args,
1090
"""Mirror this branch into target.
1092
This branch is considered to be 'local', having low latency.
1094
return InterBranch.get(self, target).push(overwrite, stop_revision,
1097
def lossy_push(self, target, stop_revision=None):
1098
"""Push deltas into another branch.
1100
:note: This does not, like push, retain the revision ids from
1101
the source branch and will, rather than adding bzr-specific
1102
metadata, push only those semantics of the revision that can be
1103
natively represented by this branch' VCS.
1105
:param target: Target branch
1106
:param stop_revision: Revision to push, defaults to last revision.
1107
:return: BranchPushResult with an extra member revidmap:
1108
A dictionary mapping revision ids from the target branch
1109
to new revision ids in the target branch, for each
1110
revision that was pushed.
1112
inter = InterBranch.get(self, target)
1113
lossy_push = getattr(inter, "lossy_push", None)
1114
if lossy_push is None:
1115
raise errors.LossyPushToSameVCS(self, target)
1116
return lossy_push(stop_revision)
1118
def basis_tree(self):
1119
"""Return `Tree` object for last revision."""
1120
return self.repository.revision_tree(self.last_revision())
1122
def get_parent(self):
1123
"""Return the parent location of the branch.
1125
This is the default location for pull/missing. The usual
1126
pattern is that the user can override it by specifying a
1129
parent = self._get_parent_location()
1132
# This is an old-format absolute path to a local branch
1133
# turn it into a url
1134
if parent.startswith('/'):
1135
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1137
return urlutils.join(self.base[:-1], parent)
1138
except errors.InvalidURLJoin, e:
1139
raise errors.InaccessibleParent(parent, self.user_url)
1141
def _get_parent_location(self):
1142
raise NotImplementedError(self._get_parent_location)
1144
def _set_config_location(self, name, url, config=None,
1145
make_relative=False):
1147
config = self.get_config()
1151
url = urlutils.relative_url(self.base, url)
1152
config.set_user_option(name, url, warn_masked=True)
1154
def _get_config_location(self, name, config=None):
1156
config = self.get_config()
1157
location = config.get_user_option(name)
1162
def get_child_submit_format(self):
1163
"""Return the preferred format of submissions to this branch."""
1164
return self.get_config().get_user_option("child_submit_format")
1166
def get_submit_branch(self):
1167
"""Return the submit location of the branch.
1169
This is the default location for bundle. The usual
1170
pattern is that the user can override it by specifying a
1173
return self.get_config().get_user_option('submit_branch')
1175
def set_submit_branch(self, location):
1176
"""Return the submit location of the branch.
1178
This is the default location for bundle. The usual
1179
pattern is that the user can override it by specifying a
1182
self.get_config().set_user_option('submit_branch', location,
1185
def get_public_branch(self):
1186
"""Return the public location of the branch.
1188
This is used by merge directives.
1190
return self._get_config_location('public_branch')
1192
def set_public_branch(self, location):
1193
"""Return the submit location of the branch.
1195
This is the default location for bundle. The usual
1196
pattern is that the user can override it by specifying a
1199
self._set_config_location('public_branch', location)
1201
def get_push_location(self):
1202
"""Return the None or the location to push this branch to."""
1203
push_loc = self.get_config().get_user_option('push_location')
1206
def set_push_location(self, location):
1207
"""Set a new push location for this branch."""
1208
raise NotImplementedError(self.set_push_location)
1210
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1211
"""Run the post_change_branch_tip hooks."""
1212
hooks = Branch.hooks['post_change_branch_tip']
1215
new_revno, new_revid = self.last_revision_info()
1216
params = ChangeBranchTipParams(
1217
self, old_revno, new_revno, old_revid, new_revid)
1221
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1222
"""Run the pre_change_branch_tip hooks."""
1223
hooks = Branch.hooks['pre_change_branch_tip']
1226
old_revno, old_revid = self.last_revision_info()
1227
params = ChangeBranchTipParams(
1228
self, old_revno, new_revno, old_revid, new_revid)
1234
"""Synchronise this branch with the master branch if any.
1236
:return: None or the last_revision pivoted out during the update.
1240
def check_revno(self, revno):
1242
Check whether a revno corresponds to any revision.
1243
Zero (the NULL revision) is considered valid.
1246
self.check_real_revno(revno)
1248
def check_real_revno(self, revno):
1250
Check whether a revno corresponds to a real revision.
1251
Zero (the NULL revision) is considered invalid
1253
if revno < 1 or revno > self.revno():
1254
raise errors.InvalidRevisionNumber(revno)
1257
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1258
"""Clone this branch into to_bzrdir preserving all semantic values.
1260
Most API users will want 'create_clone_on_transport', which creates a
1261
new bzrdir and branch on the fly.
1263
revision_id: if not None, the revision history in the new branch will
1264
be truncated to end with revision_id.
1266
result = to_bzrdir.create_branch()
1269
if repository_policy is not None:
1270
repository_policy.configure_branch(result)
1271
self.copy_content_into(result, revision_id=revision_id)
1277
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1279
"""Create a new line of development from the branch, into to_bzrdir.
1281
to_bzrdir controls the branch format.
1283
revision_id: if not None, the revision history in the new branch will
1284
be truncated to end with revision_id.
1286
if (repository_policy is not None and
1287
repository_policy.requires_stacking()):
1288
to_bzrdir._format.require_stacking(_skip_repo=True)
1289
result = to_bzrdir.create_branch(repository=repository)
1292
if repository_policy is not None:
1293
repository_policy.configure_branch(result)
1294
self.copy_content_into(result, revision_id=revision_id)
1295
result.set_parent(self.bzrdir.root_transport.base)
1300
def _synchronize_history(self, destination, revision_id):
1301
"""Synchronize last revision and revision history between branches.
1303
This version is most efficient when the destination is also a
1304
BzrBranch6, but works for BzrBranch5, as long as the destination's
1305
repository contains all the lefthand ancestors of the intended
1306
last_revision. If not, set_last_revision_info will fail.
1308
:param destination: The branch to copy the history into
1309
:param revision_id: The revision-id to truncate history at. May
1310
be None to copy complete history.
1312
source_revno, source_revision_id = self.last_revision_info()
1313
if revision_id is None:
1314
revno, revision_id = source_revno, source_revision_id
1316
graph = self.repository.get_graph()
1318
revno = graph.find_distance_to_null(revision_id,
1319
[(source_revision_id, source_revno)])
1320
except errors.GhostRevisionsHaveNoRevno:
1321
# Default to 1, if we can't find anything else
1323
destination.set_last_revision_info(revno, revision_id)
1325
def copy_content_into(self, destination, revision_id=None):
1326
"""Copy the content of self into destination.
1328
revision_id: if not None, the revision history in the new branch will
1329
be truncated to end with revision_id.
1331
return InterBranch.get(self, destination).copy_content_into(
1332
revision_id=revision_id)
1334
def update_references(self, target):
1335
if not getattr(self._format, 'supports_reference_locations', False):
1337
reference_dict = self._get_all_reference_info()
1338
if len(reference_dict) == 0:
1340
old_base = self.base
1341
new_base = target.base
1342
target_reference_dict = target._get_all_reference_info()
1343
for file_id, (tree_path, branch_location) in (
1344
reference_dict.items()):
1345
branch_location = urlutils.rebase_url(branch_location,
1347
target_reference_dict.setdefault(
1348
file_id, (tree_path, branch_location))
1349
target._set_all_reference_info(target_reference_dict)
1352
def check(self, refs):
1353
"""Check consistency of the branch.
1355
In particular this checks that revisions given in the revision-history
1356
do actually match up in the revision graph, and that they're all
1357
present in the repository.
1359
Callers will typically also want to check the repository.
1361
:param refs: Calculated refs for this branch as specified by
1362
branch._get_check_refs()
1363
:return: A BranchCheckResult.
1365
result = BranchCheckResult(self)
1366
last_revno, last_revision_id = self.last_revision_info()
1367
actual_revno = refs[('lefthand-distance', last_revision_id)]
1368
if actual_revno != last_revno:
1369
result.errors.append(errors.BzrCheckError(
1370
'revno does not match len(mainline) %s != %s' % (
1371
last_revno, actual_revno)))
1372
# TODO: We should probably also check that self.revision_history
1373
# matches the repository for older branch formats.
1374
# If looking for the code that cross-checks repository parents against
1375
# the iter_reverse_revision_history output, that is now a repository
1379
def _get_checkout_format(self):
1380
"""Return the most suitable metadir for a checkout of this branch.
1381
Weaves are used if this branch's repository uses weaves.
1383
format = self.repository.bzrdir.checkout_metadir()
1384
format.set_branch_format(self._format)
1387
def create_clone_on_transport(self, to_transport, revision_id=None,
1388
stacked_on=None, create_prefix=False, use_existing_dir=False,
1390
"""Create a clone of this branch and its bzrdir.
1392
:param to_transport: The transport to clone onto.
1393
:param revision_id: The revision id to use as tip in the new branch.
1394
If None the tip is obtained from this branch.
1395
:param stacked_on: An optional URL to stack the clone on.
1396
:param create_prefix: Create any missing directories leading up to
1398
:param use_existing_dir: Use an existing directory if one exists.
1400
# XXX: Fix the bzrdir API to allow getting the branch back from the
1401
# clone call. Or something. 20090224 RBC/spiv.
1402
# XXX: Should this perhaps clone colocated branches as well,
1403
# rather than just the default branch? 20100319 JRV
1404
if revision_id is None:
1405
revision_id = self.last_revision()
1406
dir_to = self.bzrdir.clone_on_transport(to_transport,
1407
revision_id=revision_id, stacked_on=stacked_on,
1408
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1410
return dir_to.open_branch()
1412
def create_checkout(self, to_location, revision_id=None,
1413
lightweight=False, accelerator_tree=None,
1415
"""Create a checkout of a branch.
1417
:param to_location: The url to produce the checkout at
1418
:param revision_id: The revision to check out
1419
:param lightweight: If True, produce a lightweight checkout, otherwise,
1420
produce a bound branch (heavyweight checkout)
1421
:param accelerator_tree: A tree which can be used for retrieving file
1422
contents more quickly than the revision tree, i.e. a workingtree.
1423
The revision tree will be used for cases where accelerator_tree's
1424
content is different.
1425
:param hardlink: If true, hard-link files from accelerator_tree,
1427
:return: The tree of the created checkout
1429
t = transport.get_transport(to_location)
1432
format = self._get_checkout_format()
1433
checkout = format.initialize_on_transport(t)
1434
from_branch = BranchReferenceFormat().initialize(checkout,
1437
format = self._get_checkout_format()
1438
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1439
to_location, force_new_tree=False, format=format)
1440
checkout = checkout_branch.bzrdir
1441
checkout_branch.bind(self)
1442
# pull up to the specified revision_id to set the initial
1443
# branch tip correctly, and seed it with history.
1444
checkout_branch.pull(self, stop_revision=revision_id)
1446
tree = checkout.create_workingtree(revision_id,
1447
from_branch=from_branch,
1448
accelerator_tree=accelerator_tree,
1450
basis_tree = tree.basis_tree()
1451
basis_tree.lock_read()
1453
for path, file_id in basis_tree.iter_references():
1454
reference_parent = self.reference_parent(file_id, path)
1455
reference_parent.create_checkout(tree.abspath(path),
1456
basis_tree.get_reference_revision(file_id, path),
1463
def reconcile(self, thorough=True):
1464
"""Make sure the data stored in this branch is consistent."""
1465
from bzrlib.reconcile import BranchReconciler
1466
reconciler = BranchReconciler(self, thorough=thorough)
1467
reconciler.reconcile()
1470
def reference_parent(self, file_id, path, possible_transports=None):
1471
"""Return the parent branch for a tree-reference file_id
1472
:param file_id: The file_id of the tree reference
1473
:param path: The path of the file_id in the tree
1474
:return: A branch associated with the file_id
1476
# FIXME should provide multiple branches, based on config
1477
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1478
possible_transports=possible_transports)
1480
def supports_tags(self):
1481
return self._format.supports_tags()
1483
def automatic_tag_name(self, revision_id):
1484
"""Try to automatically find the tag name for a revision.
1486
:param revision_id: Revision id of the revision.
1487
:return: A tag name or None if no tag name could be determined.
1489
for hook in Branch.hooks['automatic_tag_name']:
1490
ret = hook(self, revision_id)
1495
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1497
"""Ensure that revision_b is a descendant of revision_a.
1499
This is a helper function for update_revisions.
1501
:raises: DivergedBranches if revision_b has diverged from revision_a.
1502
:returns: True if revision_b is a descendant of revision_a.
1504
relation = self._revision_relations(revision_a, revision_b, graph)
1505
if relation == 'b_descends_from_a':
1507
elif relation == 'diverged':
1508
raise errors.DivergedBranches(self, other_branch)
1509
elif relation == 'a_descends_from_b':
1512
raise AssertionError("invalid relation: %r" % (relation,))
1514
def _revision_relations(self, revision_a, revision_b, graph):
1515
"""Determine the relationship between two revisions.
1517
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1519
heads = graph.heads([revision_a, revision_b])
1520
if heads == set([revision_b]):
1521
return 'b_descends_from_a'
1522
elif heads == set([revision_a, revision_b]):
1523
# These branches have diverged
1525
elif heads == set([revision_a]):
1526
return 'a_descends_from_b'
1528
raise AssertionError("invalid heads: %r" % (heads,))
1530
def heads_to_fetch(self):
1531
"""Return the heads that must and that should be fetched to copy this
1532
branch into another repo.
1534
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1535
set of heads that must be fetched. if_present_fetch is a set of
1536
heads that must be fetched if present, but no error is necessary if
1537
they are not present.
1539
# For bzr native formats must_fetch is just the tip, and if_present_fetch
1541
must_fetch = set([self.last_revision()])
1543
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1544
except errors.TagsNotSupported:
1545
if_present_fetch = set()
1546
must_fetch.discard(_mod_revision.NULL_REVISION)
1547
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1548
return must_fetch, if_present_fetch
1551
class BranchFormat(controldir.ControlComponentFormat):
1552
"""An encapsulation of the initialization and open routines for a format.
1554
Formats provide three things:
1555
* An initialization routine,
1559
Formats are placed in an dict by their format string for reference
1560
during branch opening. It's not required that these be instances, they
1561
can be classes themselves with class methods - it simply depends on
1562
whether state is needed for a given format or not.
1564
Once a format is deprecated, just deprecate the initialize and open
1565
methods on the format class. Do not deprecate the object, as the
1566
object will be created every time regardless.
1569
can_set_append_revisions_only = True
1571
def __eq__(self, other):
1572
return self.__class__ is other.__class__
1574
def __ne__(self, other):
1575
return not (self == other)
1578
def find_format(klass, a_bzrdir, name=None):
1579
"""Return the format for the branch object in a_bzrdir."""
1581
transport = a_bzrdir.get_branch_transport(None, name=name)
1582
format_string = transport.get_bytes("format")
1583
return format_registry.get(format_string)
1584
except errors.NoSuchFile:
1585
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1587
raise errors.UnknownFormatError(format=format_string, kind='branch')
1590
@deprecated_method(deprecated_in((2, 4, 0)))
1591
def get_default_format(klass):
1592
"""Return the current default format."""
1593
return format_registry.get_default()
1596
@deprecated_method(deprecated_in((2, 4, 0)))
1597
def get_formats(klass):
1598
"""Get all the known formats.
1600
Warning: This triggers a load of all lazy registered formats: do not
1601
use except when that is desireed.
1603
return format_registry._get_all()
1605
def get_reference(self, a_bzrdir, name=None):
1606
"""Get the target reference of the branch in a_bzrdir.
1608
format probing must have been completed before calling
1609
this method - it is assumed that the format of the branch
1610
in a_bzrdir is correct.
1612
:param a_bzrdir: The bzrdir to get the branch data from.
1613
:param name: Name of the colocated branch to fetch
1614
:return: None if the branch is not a reference branch.
1619
def set_reference(self, a_bzrdir, name, to_branch):
1620
"""Set the target reference of the branch in a_bzrdir.
1622
format probing must have been completed before calling
1623
this method - it is assumed that the format of the branch
1624
in a_bzrdir is correct.
1626
:param a_bzrdir: The bzrdir to set the branch reference for.
1627
:param name: Name of colocated branch to set, None for default
1628
:param to_branch: branch that the checkout is to reference
1630
raise NotImplementedError(self.set_reference)
1632
def get_format_string(self):
1633
"""Return the ASCII format string that identifies this format."""
1634
raise NotImplementedError(self.get_format_string)
1636
def get_format_description(self):
1637
"""Return the short format description for this format."""
1638
raise NotImplementedError(self.get_format_description)
1640
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1641
hooks = Branch.hooks['post_branch_init']
1644
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1648
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1650
"""Initialize a branch in a bzrdir, with specified files
1652
:param a_bzrdir: The bzrdir to initialize the branch in
1653
:param utf8_files: The files to create as a list of
1654
(filename, content) tuples
1655
:param name: Name of colocated branch to create, if any
1656
:return: a branch in this format
1658
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1659
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1660
control_files = lockable_files.LockableFiles(branch_transport,
1661
'lock', lockdir.LockDir)
1662
control_files.create_lock()
1663
control_files.lock_write()
1665
utf8_files += [('format', self.get_format_string())]
1666
for (filename, content) in utf8_files:
1667
branch_transport.put_bytes(
1669
mode=a_bzrdir._get_file_mode())
1671
control_files.unlock()
1672
branch = self.open(a_bzrdir, name, _found=True,
1673
found_repository=repository)
1674
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1677
def initialize(self, a_bzrdir, name=None, repository=None):
1678
"""Create a branch of this format in a_bzrdir.
1680
:param name: Name of the colocated branch to create.
1682
raise NotImplementedError(self.initialize)
1684
def is_supported(self):
1685
"""Is this format supported?
1687
Supported formats can be initialized and opened.
1688
Unsupported formats may not support initialization or committing or
1689
some other features depending on the reason for not being supported.
1693
def make_tags(self, branch):
1694
"""Create a tags object for branch.
1696
This method is on BranchFormat, because BranchFormats are reflected
1697
over the wire via network_name(), whereas full Branch instances require
1698
multiple VFS method calls to operate at all.
1700
The default implementation returns a disabled-tags instance.
1702
Note that it is normal for branch to be a RemoteBranch when using tags
1705
return DisabledTags(branch)
1707
def network_name(self):
1708
"""A simple byte string uniquely identifying this format for RPC calls.
1710
MetaDir branch formats use their disk format string to identify the
1711
repository over the wire. All in one formats such as bzr < 0.8, and
1712
foreign formats like svn/git and hg should use some marker which is
1713
unique and immutable.
1715
raise NotImplementedError(self.network_name)
1717
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1718
found_repository=None):
1719
"""Return the branch object for a_bzrdir
1721
:param a_bzrdir: A BzrDir that contains a branch.
1722
:param name: Name of colocated branch to open
1723
:param _found: a private parameter, do not use it. It is used to
1724
indicate if format probing has already be done.
1725
:param ignore_fallbacks: when set, no fallback branches will be opened
1726
(if there are any). Default is to open fallbacks.
1728
raise NotImplementedError(self.open)
1731
@deprecated_method(deprecated_in((2, 4, 0)))
1732
def register_format(klass, format):
1733
"""Register a metadir format.
1735
See MetaDirBranchFormatFactory for the ability to register a format
1736
without loading the code the format needs until it is actually used.
1738
format_registry.register(format)
1741
@deprecated_method(deprecated_in((2, 4, 0)))
1742
def set_default_format(klass, format):
1743
format_registry.set_default(format)
1745
def supports_set_append_revisions_only(self):
1746
"""True if this format supports set_append_revisions_only."""
1749
def supports_stacking(self):
1750
"""True if this format records a stacked-on branch."""
1753
def supports_leaving_lock(self):
1754
"""True if this format supports leaving locks in place."""
1755
return False # by default
1758
@deprecated_method(deprecated_in((2, 4, 0)))
1759
def unregister_format(klass, format):
1760
format_registry.remove(format)
1763
return self.get_format_description().rstrip()
1765
def supports_tags(self):
1766
"""True if this format supports tags stored in the branch"""
1767
return False # by default
1770
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1771
"""A factory for a BranchFormat object, permitting simple lazy registration.
1773
While none of the built in BranchFormats are lazy registered yet,
1774
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1775
use it, and the bzr-loom plugin uses it as well (see
1776
bzrlib.plugins.loom.formats).
1779
def __init__(self, format_string, module_name, member_name):
1780
"""Create a MetaDirBranchFormatFactory.
1782
:param format_string: The format string the format has.
1783
:param module_name: Module to load the format class from.
1784
:param member_name: Attribute name within the module for the format class.
1786
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1787
self._format_string = format_string
1789
def get_format_string(self):
1790
"""See BranchFormat.get_format_string."""
1791
return self._format_string
1794
"""Used for network_format_registry support."""
1795
return self.get_obj()()
1798
class BranchHooks(Hooks):
1799
"""A dictionary mapping hook name to a list of callables for branch hooks.
1801
e.g. ['set_rh'] Is the list of items to be called when the
1802
set_revision_history function is invoked.
1806
"""Create the default hooks.
1808
These are all empty initially, because by default nothing should get
1811
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1812
self.add_hook('set_rh',
1813
"Invoked whenever the revision history has been set via "
1814
"set_revision_history. The api signature is (branch, "
1815
"revision_history), and the branch will be write-locked. "
1816
"The set_rh hook can be expensive for bzr to trigger, a better "
1817
"hook to use is Branch.post_change_branch_tip.", (0, 15))
1818
self.add_hook('open',
1819
"Called with the Branch object that has been opened after a "
1820
"branch is opened.", (1, 8))
1821
self.add_hook('post_push',
1822
"Called after a push operation completes. post_push is called "
1823
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1824
"bzr client.", (0, 15))
1825
self.add_hook('post_pull',
1826
"Called after a pull operation completes. post_pull is called "
1827
"with a bzrlib.branch.PullResult object and only runs in the "
1828
"bzr client.", (0, 15))
1829
self.add_hook('pre_commit',
1830
"Called after a commit is calculated but before it is "
1831
"completed. pre_commit is called with (local, master, old_revno, "
1832
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1833
"). old_revid is NULL_REVISION for the first commit to a branch, "
1834
"tree_delta is a TreeDelta object describing changes from the "
1835
"basis revision. hooks MUST NOT modify this delta. "
1836
" future_tree is an in-memory tree obtained from "
1837
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1839
self.add_hook('post_commit',
1840
"Called in the bzr client after a commit has completed. "
1841
"post_commit is called with (local, master, old_revno, old_revid, "
1842
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1843
"commit to a branch.", (0, 15))
1844
self.add_hook('post_uncommit',
1845
"Called in the bzr client after an uncommit completes. "
1846
"post_uncommit is called with (local, master, old_revno, "
1847
"old_revid, new_revno, new_revid) where local is the local branch "
1848
"or None, master is the target branch, and an empty branch "
1849
"receives new_revno of 0, new_revid of None.", (0, 15))
1850
self.add_hook('pre_change_branch_tip',
1851
"Called in bzr client and server before a change to the tip of a "
1852
"branch is made. pre_change_branch_tip is called with a "
1853
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1854
"commit, uncommit will all trigger this hook.", (1, 6))
1855
self.add_hook('post_change_branch_tip',
1856
"Called in bzr client and server after a change to the tip of a "
1857
"branch is made. post_change_branch_tip is called with a "
1858
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1859
"commit, uncommit will all trigger this hook.", (1, 4))
1860
self.add_hook('transform_fallback_location',
1861
"Called when a stacked branch is activating its fallback "
1862
"locations. transform_fallback_location is called with (branch, "
1863
"url), and should return a new url. Returning the same url "
1864
"allows it to be used as-is, returning a different one can be "
1865
"used to cause the branch to stack on a closer copy of that "
1866
"fallback_location. Note that the branch cannot have history "
1867
"accessing methods called on it during this hook because the "
1868
"fallback locations have not been activated. When there are "
1869
"multiple hooks installed for transform_fallback_location, "
1870
"all are called with the url returned from the previous hook."
1871
"The order is however undefined.", (1, 9))
1872
self.add_hook('automatic_tag_name',
1873
"Called to determine an automatic tag name for a revision. "
1874
"automatic_tag_name is called with (branch, revision_id) and "
1875
"should return a tag name or None if no tag name could be "
1876
"determined. The first non-None tag name returned will be used.",
1878
self.add_hook('post_branch_init',
1879
"Called after new branch initialization completes. "
1880
"post_branch_init is called with a "
1881
"bzrlib.branch.BranchInitHookParams. "
1882
"Note that init, branch and checkout (both heavyweight and "
1883
"lightweight) will all trigger this hook.", (2, 2))
1884
self.add_hook('post_switch',
1885
"Called after a checkout switches branch. "
1886
"post_switch is called with a "
1887
"bzrlib.branch.SwitchHookParams.", (2, 2))
1891
# install the default hooks into the Branch class.
1892
Branch.hooks = BranchHooks()
1895
class ChangeBranchTipParams(object):
1896
"""Object holding parameters passed to *_change_branch_tip hooks.
1898
There are 5 fields that hooks may wish to access:
1900
:ivar branch: the branch being changed
1901
:ivar old_revno: revision number before the change
1902
:ivar new_revno: revision number after the change
1903
:ivar old_revid: revision id before the change
1904
:ivar new_revid: revision id after the change
1906
The revid fields are strings. The revno fields are integers.
1909
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1910
"""Create a group of ChangeBranchTip parameters.
1912
:param branch: The branch being changed.
1913
:param old_revno: Revision number before the change.
1914
:param new_revno: Revision number after the change.
1915
:param old_revid: Tip revision id before the change.
1916
:param new_revid: Tip revision id after the change.
1918
self.branch = branch
1919
self.old_revno = old_revno
1920
self.new_revno = new_revno
1921
self.old_revid = old_revid
1922
self.new_revid = new_revid
1924
def __eq__(self, other):
1925
return self.__dict__ == other.__dict__
1928
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1929
self.__class__.__name__, self.branch,
1930
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1933
class BranchInitHookParams(object):
1934
"""Object holding parameters passed to *_branch_init hooks.
1936
There are 4 fields that hooks may wish to access:
1938
:ivar format: the branch format
1939
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1940
:ivar name: name of colocated branch, if any (or None)
1941
:ivar branch: the branch created
1943
Note that for lightweight checkouts, the bzrdir and format fields refer to
1944
the checkout, hence they are different from the corresponding fields in
1945
branch, which refer to the original branch.
1948
def __init__(self, format, a_bzrdir, name, branch):
1949
"""Create a group of BranchInitHook parameters.
1951
:param format: the branch format
1952
:param a_bzrdir: the BzrDir where the branch will be/has been
1954
:param name: name of colocated branch, if any (or None)
1955
:param branch: the branch created
1957
Note that for lightweight checkouts, the bzrdir and format fields refer
1958
to the checkout, hence they are different from the corresponding fields
1959
in branch, which refer to the original branch.
1961
self.format = format
1962
self.bzrdir = a_bzrdir
1964
self.branch = branch
1966
def __eq__(self, other):
1967
return self.__dict__ == other.__dict__
1970
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1973
class SwitchHookParams(object):
1974
"""Object holding parameters passed to *_switch hooks.
1976
There are 4 fields that hooks may wish to access:
1978
:ivar control_dir: BzrDir of the checkout to change
1979
:ivar to_branch: branch that the checkout is to reference
1980
:ivar force: skip the check for local commits in a heavy checkout
1981
:ivar revision_id: revision ID to switch to (or None)
1984
def __init__(self, control_dir, to_branch, force, revision_id):
1985
"""Create a group of SwitchHook parameters.
1987
:param control_dir: BzrDir of the checkout to change
1988
:param to_branch: branch that the checkout is to reference
1989
:param force: skip the check for local commits in a heavy checkout
1990
:param revision_id: revision ID to switch to (or None)
1992
self.control_dir = control_dir
1993
self.to_branch = to_branch
1995
self.revision_id = revision_id
1997
def __eq__(self, other):
1998
return self.__dict__ == other.__dict__
2001
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
2002
self.control_dir, self.to_branch,
2006
class BranchFormatMetadir(BranchFormat):
2007
"""Common logic for meta-dir based branch formats."""
2009
def _branch_class(self):
2010
"""What class to instantiate on open calls."""
2011
raise NotImplementedError(self._branch_class)
2013
def network_name(self):
2014
"""A simple byte string uniquely identifying this format for RPC calls.
2016
Metadir branch formats use their format string.
2018
return self.get_format_string()
2020
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2021
found_repository=None):
2022
"""See BranchFormat.open()."""
2024
format = BranchFormat.find_format(a_bzrdir, name=name)
2025
if format.__class__ != self.__class__:
2026
raise AssertionError("wrong format %r found for %r" %
2028
transport = a_bzrdir.get_branch_transport(None, name=name)
2030
control_files = lockable_files.LockableFiles(transport, 'lock',
2032
if found_repository is None:
2033
found_repository = a_bzrdir.find_repository()
2034
return self._branch_class()(_format=self,
2035
_control_files=control_files,
2038
_repository=found_repository,
2039
ignore_fallbacks=ignore_fallbacks)
2040
except errors.NoSuchFile:
2041
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2044
super(BranchFormatMetadir, self).__init__()
2045
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2046
self._matchingbzrdir.set_branch_format(self)
2048
def supports_tags(self):
2051
def supports_leaving_lock(self):
2055
class BzrBranchFormat5(BranchFormatMetadir):
2056
"""Bzr branch format 5.
2059
- a revision-history file.
2061
- a lock dir guarding the branch itself
2062
- all of this stored in a branch/ subdirectory
2063
- works with shared repositories.
2065
This format is new in bzr 0.8.
2068
def _branch_class(self):
2071
def get_format_string(self):
2072
"""See BranchFormat.get_format_string()."""
2073
return "Bazaar-NG branch format 5\n"
2075
def get_format_description(self):
2076
"""See BranchFormat.get_format_description()."""
2077
return "Branch format 5"
2079
def initialize(self, a_bzrdir, name=None, repository=None):
2080
"""Create a branch of this format in a_bzrdir."""
2081
utf8_files = [('revision-history', ''),
2082
('branch-name', ''),
2084
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2086
def supports_tags(self):
2090
class BzrBranchFormat6(BranchFormatMetadir):
2091
"""Branch format with last-revision and tags.
2093
Unlike previous formats, this has no explicit revision history. Instead,
2094
this just stores the last-revision, and the left-hand history leading
2095
up to there is the history.
2097
This format was introduced in bzr 0.15
2098
and became the default in 0.91.
2101
def _branch_class(self):
2104
def get_format_string(self):
2105
"""See BranchFormat.get_format_string()."""
2106
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2108
def get_format_description(self):
2109
"""See BranchFormat.get_format_description()."""
2110
return "Branch format 6"
2112
def initialize(self, a_bzrdir, name=None, repository=None):
2113
"""Create a branch of this format in a_bzrdir."""
2114
utf8_files = [('last-revision', '0 null:\n'),
2115
('branch.conf', ''),
2118
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2120
def make_tags(self, branch):
2121
"""See bzrlib.branch.BranchFormat.make_tags()."""
2122
return BasicTags(branch)
2124
def supports_set_append_revisions_only(self):
2128
class BzrBranchFormat8(BranchFormatMetadir):
2129
"""Metadir format supporting storing locations of subtree branches."""
2131
def _branch_class(self):
2134
def get_format_string(self):
2135
"""See BranchFormat.get_format_string()."""
2136
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2138
def get_format_description(self):
2139
"""See BranchFormat.get_format_description()."""
2140
return "Branch format 8"
2142
def initialize(self, a_bzrdir, name=None, repository=None):
2143
"""Create a branch of this format in a_bzrdir."""
2144
utf8_files = [('last-revision', '0 null:\n'),
2145
('branch.conf', ''),
2149
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2152
super(BzrBranchFormat8, self).__init__()
2153
self._matchingbzrdir.repository_format = \
2154
RepositoryFormatKnitPack5RichRoot()
2156
def make_tags(self, branch):
2157
"""See bzrlib.branch.BranchFormat.make_tags()."""
2158
return BasicTags(branch)
2160
def supports_set_append_revisions_only(self):
2163
def supports_stacking(self):
2166
supports_reference_locations = True
2169
class BzrBranchFormat7(BzrBranchFormat8):
2170
"""Branch format with last-revision, tags, and a stacked location pointer.
2172
The stacked location pointer is passed down to the repository and requires
2173
a repository format with supports_external_lookups = True.
2175
This format was introduced in bzr 1.6.
2178
def initialize(self, a_bzrdir, name=None, repository=None):
2179
"""Create a branch of this format in a_bzrdir."""
2180
utf8_files = [('last-revision', '0 null:\n'),
2181
('branch.conf', ''),
2184
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2186
def _branch_class(self):
2189
def get_format_string(self):
2190
"""See BranchFormat.get_format_string()."""
2191
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2193
def get_format_description(self):
2194
"""See BranchFormat.get_format_description()."""
2195
return "Branch format 7"
2197
def supports_set_append_revisions_only(self):
2200
supports_reference_locations = False
2203
class BranchReferenceFormat(BranchFormat):
2204
"""Bzr branch reference format.
2206
Branch references are used in implementing checkouts, they
2207
act as an alias to the real branch which is at some other url.
2214
def get_format_string(self):
2215
"""See BranchFormat.get_format_string()."""
2216
return "Bazaar-NG Branch Reference Format 1\n"
2218
def get_format_description(self):
2219
"""See BranchFormat.get_format_description()."""
2220
return "Checkout reference format 1"
2222
def get_reference(self, a_bzrdir, name=None):
2223
"""See BranchFormat.get_reference()."""
2224
transport = a_bzrdir.get_branch_transport(None, name=name)
2225
return transport.get_bytes('location')
2227
def set_reference(self, a_bzrdir, name, to_branch):
2228
"""See BranchFormat.set_reference()."""
2229
transport = a_bzrdir.get_branch_transport(None, name=name)
2230
location = transport.put_bytes('location', to_branch.base)
2232
def initialize(self, a_bzrdir, name=None, target_branch=None,
2234
"""Create a branch of this format in a_bzrdir."""
2235
if target_branch is None:
2236
# this format does not implement branch itself, thus the implicit
2237
# creation contract must see it as uninitializable
2238
raise errors.UninitializableFormat(self)
2239
mutter('creating branch reference in %s', a_bzrdir.user_url)
2240
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2241
branch_transport.put_bytes('location',
2242
target_branch.bzrdir.user_url)
2243
branch_transport.put_bytes('format', self.get_format_string())
2245
a_bzrdir, name, _found=True,
2246
possible_transports=[target_branch.bzrdir.root_transport])
2247
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2251
super(BranchReferenceFormat, self).__init__()
2252
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2253
self._matchingbzrdir.set_branch_format(self)
2255
def _make_reference_clone_function(format, a_branch):
2256
"""Create a clone() routine for a branch dynamically."""
2257
def clone(to_bzrdir, revision_id=None,
2258
repository_policy=None):
2259
"""See Branch.clone()."""
2260
return format.initialize(to_bzrdir, target_branch=a_branch)
2261
# cannot obey revision_id limits when cloning a reference ...
2262
# FIXME RBC 20060210 either nuke revision_id for clone, or
2263
# emit some sort of warning/error to the caller ?!
2266
def open(self, a_bzrdir, name=None, _found=False, location=None,
2267
possible_transports=None, ignore_fallbacks=False,
2268
found_repository=None):
2269
"""Return the branch that the branch reference in a_bzrdir points at.
2271
:param a_bzrdir: A BzrDir that contains a branch.
2272
:param name: Name of colocated branch to open, if any
2273
:param _found: a private parameter, do not use it. It is used to
2274
indicate if format probing has already be done.
2275
:param ignore_fallbacks: when set, no fallback branches will be opened
2276
(if there are any). Default is to open fallbacks.
2277
:param location: The location of the referenced branch. If
2278
unspecified, this will be determined from the branch reference in
2280
:param possible_transports: An optional reusable transports list.
2283
format = BranchFormat.find_format(a_bzrdir, name=name)
2284
if format.__class__ != self.__class__:
2285
raise AssertionError("wrong format %r found for %r" %
2287
if location is None:
2288
location = self.get_reference(a_bzrdir, name)
2289
real_bzrdir = bzrdir.BzrDir.open(
2290
location, possible_transports=possible_transports)
2291
result = real_bzrdir.open_branch(name=name,
2292
ignore_fallbacks=ignore_fallbacks)
2293
# this changes the behaviour of result.clone to create a new reference
2294
# rather than a copy of the content of the branch.
2295
# I did not use a proxy object because that needs much more extensive
2296
# testing, and we are only changing one behaviour at the moment.
2297
# If we decide to alter more behaviours - i.e. the implicit nickname
2298
# then this should be refactored to introduce a tested proxy branch
2299
# and a subclass of that for use in overriding clone() and ....
2301
result.clone = self._make_reference_clone_function(result)
2305
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2306
"""Branch format registry."""
2308
def __init__(self, other_registry=None):
2309
super(BranchFormatRegistry, self).__init__(other_registry)
2310
self._default_format = None
2312
def set_default(self, format):
2313
self._default_format = format
2315
def get_default(self):
2316
return self._default_format
2319
network_format_registry = registry.FormatRegistry()
2320
"""Registry of formats indexed by their network name.
2322
The network name for a branch format is an identifier that can be used when
2323
referring to formats with smart server operations. See
2324
BranchFormat.network_name() for more detail.
2327
format_registry = BranchFormatRegistry(network_format_registry)
2330
# formats which have no format string are not discoverable
2331
# and not independently creatable, so are not registered.
2332
__format5 = BzrBranchFormat5()
2333
__format6 = BzrBranchFormat6()
2334
__format7 = BzrBranchFormat7()
2335
__format8 = BzrBranchFormat8()
2336
format_registry.register(__format5)
2337
format_registry.register(BranchReferenceFormat())
2338
format_registry.register(__format6)
2339
format_registry.register(__format7)
2340
format_registry.register(__format8)
2341
format_registry.set_default(__format7)
2344
class BranchWriteLockResult(LogicalLockResult):
2345
"""The result of write locking a branch.
2347
:ivar branch_token: The token obtained from the underlying branch lock, or
2349
:ivar unlock: A callable which will unlock the lock.
2352
def __init__(self, unlock, branch_token):
2353
LogicalLockResult.__init__(self, unlock)
2354
self.branch_token = branch_token
2357
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2361
class BzrBranch(Branch, _RelockDebugMixin):
2362
"""A branch stored in the actual filesystem.
2364
Note that it's "local" in the context of the filesystem; it doesn't
2365
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2366
it's writable, and can be accessed via the normal filesystem API.
2368
:ivar _transport: Transport for file operations on this branch's
2369
control files, typically pointing to the .bzr/branch directory.
2370
:ivar repository: Repository for this branch.
2371
:ivar base: The url of the base directory for this branch; the one
2372
containing the .bzr directory.
2373
:ivar name: Optional colocated branch name as it exists in the control
2377
def __init__(self, _format=None,
2378
_control_files=None, a_bzrdir=None, name=None,
2379
_repository=None, ignore_fallbacks=False):
2380
"""Create new branch object at a particular location."""
2381
if a_bzrdir is None:
2382
raise ValueError('a_bzrdir must be supplied')
2384
self.bzrdir = a_bzrdir
2385
self._base = self.bzrdir.transport.clone('..').base
2387
# XXX: We should be able to just do
2388
# self.base = self.bzrdir.root_transport.base
2389
# but this does not quite work yet -- mbp 20080522
2390
self._format = _format
2391
if _control_files is None:
2392
raise ValueError('BzrBranch _control_files is None')
2393
self.control_files = _control_files
2394
self._transport = _control_files._transport
2395
self.repository = _repository
2396
Branch.__init__(self)
2399
if self.name is None:
2400
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2402
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2407
def _get_base(self):
2408
"""Returns the directory containing the control directory."""
2411
base = property(_get_base, doc="The URL for the root of this branch.")
2413
def _get_config(self):
2414
return TransportConfig(self._transport, 'branch.conf')
2416
def is_locked(self):
2417
return self.control_files.is_locked()
2419
def lock_write(self, token=None):
2420
"""Lock the branch for write operations.
2422
:param token: A token to permit reacquiring a previously held and
2424
:return: A BranchWriteLockResult.
2426
if not self.is_locked():
2427
self._note_lock('w')
2428
# All-in-one needs to always unlock/lock.
2429
repo_control = getattr(self.repository, 'control_files', None)
2430
if self.control_files == repo_control or not self.is_locked():
2431
self.repository._warn_if_deprecated(self)
2432
self.repository.lock_write()
2437
return BranchWriteLockResult(self.unlock,
2438
self.control_files.lock_write(token=token))
2441
self.repository.unlock()
2444
def lock_read(self):
2445
"""Lock the branch for read operations.
2447
:return: A bzrlib.lock.LogicalLockResult.
2449
if not self.is_locked():
2450
self._note_lock('r')
2451
# All-in-one needs to always unlock/lock.
2452
repo_control = getattr(self.repository, 'control_files', None)
2453
if self.control_files == repo_control or not self.is_locked():
2454
self.repository._warn_if_deprecated(self)
2455
self.repository.lock_read()
2460
self.control_files.lock_read()
2461
return LogicalLockResult(self.unlock)
2464
self.repository.unlock()
2467
@only_raises(errors.LockNotHeld, errors.LockBroken)
2470
self.control_files.unlock()
2472
# All-in-one needs to always unlock/lock.
2473
repo_control = getattr(self.repository, 'control_files', None)
2474
if (self.control_files == repo_control or
2475
not self.control_files.is_locked()):
2476
self.repository.unlock()
2477
if not self.control_files.is_locked():
2478
# we just released the lock
2479
self._clear_cached_state()
2481
def peek_lock_mode(self):
2482
if self.control_files._lock_count == 0:
2485
return self.control_files._lock_mode
2487
def get_physical_lock_status(self):
2488
return self.control_files.get_physical_lock_status()
2491
def print_file(self, file, revision_id):
2492
"""See Branch.print_file."""
2493
return self.repository.print_file(file, revision_id)
2495
def _write_revision_history(self, history):
2496
"""Factored out of set_revision_history.
2498
This performs the actual writing to disk.
2499
It is intended to be called by BzrBranch5.set_revision_history."""
2500
self._transport.put_bytes(
2501
'revision-history', '\n'.join(history),
2502
mode=self.bzrdir._get_file_mode())
2505
def set_revision_history(self, rev_history):
2506
"""See Branch.set_revision_history."""
2507
if 'evil' in debug.debug_flags:
2508
mutter_callsite(3, "set_revision_history scales with history.")
2509
check_not_reserved_id = _mod_revision.check_not_reserved_id
2510
for rev_id in rev_history:
2511
check_not_reserved_id(rev_id)
2512
if Branch.hooks['post_change_branch_tip']:
2513
# Don't calculate the last_revision_info() if there are no hooks
2515
old_revno, old_revid = self.last_revision_info()
2516
if len(rev_history) == 0:
2517
revid = _mod_revision.NULL_REVISION
2519
revid = rev_history[-1]
2520
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2521
self._write_revision_history(rev_history)
2522
self._clear_cached_state()
2523
self._cache_revision_history(rev_history)
2524
for hook in Branch.hooks['set_rh']:
2525
hook(self, rev_history)
2526
if Branch.hooks['post_change_branch_tip']:
2527
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2529
def _synchronize_history(self, destination, revision_id):
2530
"""Synchronize last revision and revision history between branches.
2532
This version is most efficient when the destination is also a
2533
BzrBranch5, but works for BzrBranch6 as long as the revision
2534
history is the true lefthand parent history, and all of the revisions
2535
are in the destination's repository. If not, set_revision_history
2538
:param destination: The branch to copy the history into
2539
:param revision_id: The revision-id to truncate history at. May
2540
be None to copy complete history.
2542
if not isinstance(destination._format, BzrBranchFormat5):
2543
super(BzrBranch, self)._synchronize_history(
2544
destination, revision_id)
2546
if revision_id == _mod_revision.NULL_REVISION:
2549
new_history = self.revision_history()
2550
if revision_id is not None and new_history != []:
2552
new_history = new_history[:new_history.index(revision_id) + 1]
2554
rev = self.repository.get_revision(revision_id)
2555
new_history = rev.get_history(self.repository)[1:]
2556
destination.set_revision_history(new_history)
2559
def set_last_revision_info(self, revno, revision_id):
2560
"""Set the last revision of this branch.
2562
The caller is responsible for checking that the revno is correct
2563
for this revision id.
2565
It may be possible to set the branch last revision to an id not
2566
present in the repository. However, branches can also be
2567
configured to check constraints on history, in which case this may not
2570
revision_id = _mod_revision.ensure_null(revision_id)
2571
# this old format stores the full history, but this api doesn't
2572
# provide it, so we must generate, and might as well check it's
2574
history = self._lefthand_history(revision_id)
2575
if len(history) != revno:
2576
raise AssertionError('%d != %d' % (len(history), revno))
2577
self.set_revision_history(history)
2579
def _gen_revision_history(self):
2580
history = self._transport.get_bytes('revision-history').split('\n')
2581
if history[-1:] == ['']:
2582
# There shouldn't be a trailing newline, but just in case.
2587
def generate_revision_history(self, revision_id, last_rev=None,
2589
"""Create a new revision history that will finish with revision_id.
2591
:param revision_id: the new tip to use.
2592
:param last_rev: The previous last_revision. If not None, then this
2593
must be a ancestory of revision_id, or DivergedBranches is raised.
2594
:param other_branch: The other branch that DivergedBranches should
2595
raise with respect to.
2597
self.set_revision_history(self._lefthand_history(revision_id,
2598
last_rev, other_branch))
2600
def basis_tree(self):
2601
"""See Branch.basis_tree."""
2602
return self.repository.revision_tree(self.last_revision())
2604
def _get_parent_location(self):
2605
_locs = ['parent', 'pull', 'x-pull']
2608
return self._transport.get_bytes(l).strip('\n')
2609
except errors.NoSuchFile:
2613
def _basic_push(self, target, overwrite, stop_revision):
2614
"""Basic implementation of push without bound branches or hooks.
2616
Must be called with source read locked and target write locked.
2618
result = BranchPushResult()
2619
result.source_branch = self
2620
result.target_branch = target
2621
result.old_revno, result.old_revid = target.last_revision_info()
2622
self.update_references(target)
2623
if result.old_revid != stop_revision:
2624
# We assume that during 'push' this repository is closer than
2626
graph = self.repository.get_graph(target.repository)
2627
target.update_revisions(self, stop_revision,
2628
overwrite=overwrite, graph=graph)
2629
if self._push_should_merge_tags():
2630
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2631
result.new_revno, result.new_revid = target.last_revision_info()
2634
def get_stacked_on_url(self):
2635
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2637
def set_push_location(self, location):
2638
"""See Branch.set_push_location."""
2639
self.get_config().set_user_option(
2640
'push_location', location,
2641
store=_mod_config.STORE_LOCATION_NORECURSE)
2643
def _set_parent_location(self, url):
2645
self._transport.delete('parent')
2647
self._transport.put_bytes('parent', url + '\n',
2648
mode=self.bzrdir._get_file_mode())
2651
class BzrBranch5(BzrBranch):
2652
"""A format 5 branch. This supports new features over plain branches.
2654
It has support for a master_branch which is the data for bound branches.
2657
def get_bound_location(self):
2659
return self._transport.get_bytes('bound')[:-1]
2660
except errors.NoSuchFile:
2664
def get_master_branch(self, possible_transports=None):
2665
"""Return the branch we are bound to.
2667
:return: Either a Branch, or None
2669
if self._master_branch_cache is None:
2670
self._master_branch_cache = self._get_master_branch(
2671
possible_transports)
2672
return self._master_branch_cache
2674
def _get_master_branch(self, possible_transports):
2675
bound_loc = self.get_bound_location()
2679
return Branch.open(bound_loc,
2680
possible_transports=possible_transports)
2681
except (errors.NotBranchError, errors.ConnectionError), e:
2682
raise errors.BoundBranchConnectionFailure(
2686
def set_bound_location(self, location):
2687
"""Set the target where this branch is bound to.
2689
:param location: URL to the target branch
2691
self._master_branch_cache = None
2693
self._transport.put_bytes('bound', location+'\n',
2694
mode=self.bzrdir._get_file_mode())
2697
self._transport.delete('bound')
2698
except errors.NoSuchFile:
2703
def bind(self, other):
2704
"""Bind this branch to the branch other.
2706
This does not push or pull data between the branches, though it does
2707
check for divergence to raise an error when the branches are not
2708
either the same, or one a prefix of the other. That behaviour may not
2709
be useful, so that check may be removed in future.
2711
:param other: The branch to bind to
2714
# TODO: jam 20051230 Consider checking if the target is bound
2715
# It is debatable whether you should be able to bind to
2716
# a branch which is itself bound.
2717
# Committing is obviously forbidden,
2718
# but binding itself may not be.
2719
# Since we *have* to check at commit time, we don't
2720
# *need* to check here
2722
# we want to raise diverged if:
2723
# last_rev is not in the other_last_rev history, AND
2724
# other_last_rev is not in our history, and do it without pulling
2726
self.set_bound_location(other.base)
2730
"""If bound, unbind"""
2731
return self.set_bound_location(None)
2734
def update(self, possible_transports=None):
2735
"""Synchronise this branch with the master branch if any.
2737
:return: None or the last_revision that was pivoted out during the
2740
master = self.get_master_branch(possible_transports)
2741
if master is not None:
2742
old_tip = _mod_revision.ensure_null(self.last_revision())
2743
self.pull(master, overwrite=True)
2744
if self.repository.get_graph().is_ancestor(old_tip,
2745
_mod_revision.ensure_null(self.last_revision())):
2751
class BzrBranch8(BzrBranch5):
2752
"""A branch that stores tree-reference locations."""
2754
def _open_hook(self):
2755
if self._ignore_fallbacks:
2758
url = self.get_stacked_on_url()
2759
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2760
errors.UnstackableBranchFormat):
2763
for hook in Branch.hooks['transform_fallback_location']:
2764
url = hook(self, url)
2766
hook_name = Branch.hooks.get_hook_name(hook)
2767
raise AssertionError(
2768
"'transform_fallback_location' hook %s returned "
2769
"None, not a URL." % hook_name)
2770
self._activate_fallback_location(url)
2772
def __init__(self, *args, **kwargs):
2773
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2774
super(BzrBranch8, self).__init__(*args, **kwargs)
2775
self._last_revision_info_cache = None
2776
self._reference_info = None
2778
def _clear_cached_state(self):
2779
super(BzrBranch8, self)._clear_cached_state()
2780
self._last_revision_info_cache = None
2781
self._reference_info = None
2783
def _last_revision_info(self):
2784
revision_string = self._transport.get_bytes('last-revision')
2785
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2786
revision_id = cache_utf8.get_cached_utf8(revision_id)
2788
return revno, revision_id
2790
def _write_last_revision_info(self, revno, revision_id):
2791
"""Simply write out the revision id, with no checks.
2793
Use set_last_revision_info to perform this safely.
2795
Does not update the revision_history cache.
2796
Intended to be called by set_last_revision_info and
2797
_write_revision_history.
2799
revision_id = _mod_revision.ensure_null(revision_id)
2800
out_string = '%d %s\n' % (revno, revision_id)
2801
self._transport.put_bytes('last-revision', out_string,
2802
mode=self.bzrdir._get_file_mode())
2805
def set_last_revision_info(self, revno, revision_id):
2806
revision_id = _mod_revision.ensure_null(revision_id)
2807
old_revno, old_revid = self.last_revision_info()
2808
if self._get_append_revisions_only():
2809
self._check_history_violation(revision_id)
2810
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2811
self._write_last_revision_info(revno, revision_id)
2812
self._clear_cached_state()
2813
self._last_revision_info_cache = revno, revision_id
2814
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2816
def _synchronize_history(self, destination, revision_id):
2817
"""Synchronize last revision and revision history between branches.
2819
:see: Branch._synchronize_history
2821
# XXX: The base Branch has a fast implementation of this method based
2822
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2823
# that uses set_revision_history. This class inherits from BzrBranch5,
2824
# but wants the fast implementation, so it calls
2825
# Branch._synchronize_history directly.
2826
Branch._synchronize_history(self, destination, revision_id)
2828
def _check_history_violation(self, revision_id):
2829
last_revision = _mod_revision.ensure_null(self.last_revision())
2830
if _mod_revision.is_null(last_revision):
2832
if last_revision not in self._lefthand_history(revision_id):
2833
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2835
def _gen_revision_history(self):
2836
"""Generate the revision history from last revision
2838
last_revno, last_revision = self.last_revision_info()
2839
self._extend_partial_history(stop_index=last_revno-1)
2840
return list(reversed(self._partial_revision_history_cache))
2842
def _write_revision_history(self, history):
2843
"""Factored out of set_revision_history.
2845
This performs the actual writing to disk, with format-specific checks.
2846
It is intended to be called by BzrBranch5.set_revision_history.
2848
if len(history) == 0:
2849
last_revision = 'null:'
2851
if history != self._lefthand_history(history[-1]):
2852
raise errors.NotLefthandHistory(history)
2853
last_revision = history[-1]
2854
if self._get_append_revisions_only():
2855
self._check_history_violation(last_revision)
2856
self._write_last_revision_info(len(history), last_revision)
2859
def _set_parent_location(self, url):
2860
"""Set the parent branch"""
2861
self._set_config_location('parent_location', url, make_relative=True)
2864
def _get_parent_location(self):
2865
"""Set the parent branch"""
2866
return self._get_config_location('parent_location')
2869
def _set_all_reference_info(self, info_dict):
2870
"""Replace all reference info stored in a branch.
2872
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2875
writer = rio.RioWriter(s)
2876
for key, (tree_path, branch_location) in info_dict.iteritems():
2877
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2878
branch_location=branch_location)
2879
writer.write_stanza(stanza)
2880
self._transport.put_bytes('references', s.getvalue())
2881
self._reference_info = info_dict
2884
def _get_all_reference_info(self):
2885
"""Return all the reference info stored in a branch.
2887
:return: A dict of {file_id: (tree_path, branch_location)}
2889
if self._reference_info is not None:
2890
return self._reference_info
2891
rio_file = self._transport.get('references')
2893
stanzas = rio.read_stanzas(rio_file)
2894
info_dict = dict((s['file_id'], (s['tree_path'],
2895
s['branch_location'])) for s in stanzas)
2898
self._reference_info = info_dict
2901
def set_reference_info(self, file_id, tree_path, branch_location):
2902
"""Set the branch location to use for a tree reference.
2904
:param file_id: The file-id of the tree reference.
2905
:param tree_path: The path of the tree reference in the tree.
2906
:param branch_location: The location of the branch to retrieve tree
2909
info_dict = self._get_all_reference_info()
2910
info_dict[file_id] = (tree_path, branch_location)
2911
if None in (tree_path, branch_location):
2912
if tree_path is not None:
2913
raise ValueError('tree_path must be None when branch_location'
2915
if branch_location is not None:
2916
raise ValueError('branch_location must be None when tree_path'
2918
del info_dict[file_id]
2919
self._set_all_reference_info(info_dict)
2921
def get_reference_info(self, file_id):
2922
"""Get the tree_path and branch_location for a tree reference.
2924
:return: a tuple of (tree_path, branch_location)
2926
return self._get_all_reference_info().get(file_id, (None, None))
2928
def reference_parent(self, file_id, path, possible_transports=None):
2929
"""Return the parent branch for a tree-reference file_id.
2931
:param file_id: The file_id of the tree reference
2932
:param path: The path of the file_id in the tree
2933
:return: A branch associated with the file_id
2935
branch_location = self.get_reference_info(file_id)[1]
2936
if branch_location is None:
2937
return Branch.reference_parent(self, file_id, path,
2938
possible_transports)
2939
branch_location = urlutils.join(self.user_url, branch_location)
2940
return Branch.open(branch_location,
2941
possible_transports=possible_transports)
2943
def set_push_location(self, location):
2944
"""See Branch.set_push_location."""
2945
self._set_config_location('push_location', location)
2947
def set_bound_location(self, location):
2948
"""See Branch.set_push_location."""
2949
self._master_branch_cache = None
2951
config = self.get_config()
2952
if location is None:
2953
if config.get_user_option('bound') != 'True':
2956
config.set_user_option('bound', 'False', warn_masked=True)
2959
self._set_config_location('bound_location', location,
2961
config.set_user_option('bound', 'True', warn_masked=True)
2964
def _get_bound_location(self, bound):
2965
"""Return the bound location in the config file.
2967
Return None if the bound parameter does not match"""
2968
config = self.get_config()
2969
config_bound = (config.get_user_option('bound') == 'True')
2970
if config_bound != bound:
2972
return self._get_config_location('bound_location', config=config)
2974
def get_bound_location(self):
2975
"""See Branch.set_push_location."""
2976
return self._get_bound_location(True)
2978
def get_old_bound_location(self):
2979
"""See Branch.get_old_bound_location"""
2980
return self._get_bound_location(False)
2982
def get_stacked_on_url(self):
2983
# you can always ask for the URL; but you might not be able to use it
2984
# if the repo can't support stacking.
2985
## self._check_stackable_repo()
2986
stacked_url = self._get_config_location('stacked_on_location')
2987
if stacked_url is None:
2988
raise errors.NotStacked(self)
2991
def _get_append_revisions_only(self):
2992
return self.get_config(
2993
).get_user_option_as_bool('append_revisions_only')
2996
def generate_revision_history(self, revision_id, last_rev=None,
2998
"""See BzrBranch5.generate_revision_history"""
2999
history = self._lefthand_history(revision_id, last_rev, other_branch)
3000
revno = len(history)
3001
self.set_last_revision_info(revno, revision_id)
3004
def get_rev_id(self, revno, history=None):
3005
"""Find the revision id of the specified revno."""
3007
return _mod_revision.NULL_REVISION
3009
last_revno, last_revision_id = self.last_revision_info()
3010
if revno <= 0 or revno > last_revno:
3011
raise errors.NoSuchRevision(self, revno)
3013
if history is not None:
3014
return history[revno - 1]
3016
index = last_revno - revno
3017
if len(self._partial_revision_history_cache) <= index:
3018
self._extend_partial_history(stop_index=index)
3019
if len(self._partial_revision_history_cache) > index:
3020
return self._partial_revision_history_cache[index]
3022
raise errors.NoSuchRevision(self, revno)
3025
def revision_id_to_revno(self, revision_id):
3026
"""Given a revision id, return its revno"""
3027
if _mod_revision.is_null(revision_id):
3030
index = self._partial_revision_history_cache.index(revision_id)
3033
self._extend_partial_history(stop_revision=revision_id)
3034
except errors.RevisionNotPresent, e:
3035
raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
3036
index = len(self._partial_revision_history_cache) - 1
3037
if self._partial_revision_history_cache[index] != revision_id:
3038
raise errors.NoSuchRevision(self, revision_id)
3039
return self.revno() - index
3042
class BzrBranch7(BzrBranch8):
3043
"""A branch with support for a fallback repository."""
3045
def set_reference_info(self, file_id, tree_path, branch_location):
3046
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3048
def get_reference_info(self, file_id):
3049
Branch.get_reference_info(self, file_id)
3051
def reference_parent(self, file_id, path, possible_transports=None):
3052
return Branch.reference_parent(self, file_id, path,
3053
possible_transports)
3056
class BzrBranch6(BzrBranch7):
3057
"""See BzrBranchFormat6 for the capabilities of this branch.
3059
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3063
def get_stacked_on_url(self):
3064
raise errors.UnstackableBranchFormat(self._format, self.user_url)
3067
######################################################################
3068
# results of operations
3071
class _Result(object):
3073
def _show_tag_conficts(self, to_file):
3074
if not getattr(self, 'tag_conflicts', None):
3076
to_file.write('Conflicting tags:\n')
3077
for name, value1, value2 in self.tag_conflicts:
3078
to_file.write(' %s\n' % (name, ))
3081
class PullResult(_Result):
3082
"""Result of a Branch.pull operation.
3084
:ivar old_revno: Revision number before pull.
3085
:ivar new_revno: Revision number after pull.
3086
:ivar old_revid: Tip revision id before pull.
3087
:ivar new_revid: Tip revision id after pull.
3088
:ivar source_branch: Source (local) branch object. (read locked)
3089
:ivar master_branch: Master branch of the target, or the target if no
3091
:ivar local_branch: target branch if there is a Master, else None
3092
:ivar target_branch: Target/destination branch object. (write locked)
3093
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3096
@deprecated_method(deprecated_in((2, 3, 0)))
3098
"""Return the relative change in revno.
3100
:deprecated: Use `new_revno` and `old_revno` instead.
3102
return self.new_revno - self.old_revno
3104
def report(self, to_file):
3106
if self.old_revid == self.new_revid:
3107
to_file.write('No revisions to pull.\n')
3109
to_file.write('Now on revision %d.\n' % self.new_revno)
3110
self._show_tag_conficts(to_file)
3113
class BranchPushResult(_Result):
3114
"""Result of a Branch.push operation.
3116
:ivar old_revno: Revision number (eg 10) of the target before push.
3117
:ivar new_revno: Revision number (eg 12) of the target after push.
3118
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3120
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3122
:ivar source_branch: Source branch object that the push was from. This is
3123
read locked, and generally is a local (and thus low latency) branch.
3124
:ivar master_branch: If target is a bound branch, the master branch of
3125
target, or target itself. Always write locked.
3126
:ivar target_branch: The direct Branch where data is being sent (write
3128
:ivar local_branch: If the target is a bound branch this will be the
3129
target, otherwise it will be None.
3132
@deprecated_method(deprecated_in((2, 3, 0)))
3134
"""Return the relative change in revno.
3136
:deprecated: Use `new_revno` and `old_revno` instead.
3138
return self.new_revno - self.old_revno
3140
def report(self, to_file):
3141
"""Write a human-readable description of the result."""
3142
if self.old_revid == self.new_revid:
3143
note('No new revisions to push.')
3145
note('Pushed up to revision %d.' % self.new_revno)
3146
self._show_tag_conficts(to_file)
3149
class BranchCheckResult(object):
3150
"""Results of checking branch consistency.
3155
def __init__(self, branch):
3156
self.branch = branch
3159
def report_results(self, verbose):
3160
"""Report the check results via trace.note.
3162
:param verbose: Requests more detailed display of what was checked,
3165
note('checked branch %s format %s', self.branch.user_url,
3166
self.branch._format)
3167
for error in self.errors:
3168
note('found error:%s', error)
3171
class Converter5to6(object):
3172
"""Perform an in-place upgrade of format 5 to format 6"""
3174
def convert(self, branch):
3175
# Data for 5 and 6 can peacefully coexist.
3176
format = BzrBranchFormat6()
3177
new_branch = format.open(branch.bzrdir, _found=True)
3179
# Copy source data into target
3180
new_branch._write_last_revision_info(*branch.last_revision_info())
3181
new_branch.set_parent(branch.get_parent())
3182
new_branch.set_bound_location(branch.get_bound_location())
3183
new_branch.set_push_location(branch.get_push_location())
3185
# New branch has no tags by default
3186
new_branch.tags._set_tag_dict({})
3188
# Copying done; now update target format
3189
new_branch._transport.put_bytes('format',
3190
format.get_format_string(),
3191
mode=new_branch.bzrdir._get_file_mode())
3193
# Clean up old files
3194
new_branch._transport.delete('revision-history')
3196
branch.set_parent(None)
3197
except errors.NoSuchFile:
3199
branch.set_bound_location(None)
3202
class Converter6to7(object):
3203
"""Perform an in-place upgrade of format 6 to format 7"""
3205
def convert(self, branch):
3206
format = BzrBranchFormat7()
3207
branch._set_config_location('stacked_on_location', '')
3208
# update target format
3209
branch._transport.put_bytes('format', format.get_format_string())
3212
class Converter7to8(object):
3213
"""Perform an in-place upgrade of format 6 to format 7"""
3215
def convert(self, branch):
3216
format = BzrBranchFormat8()
3217
branch._transport.put_bytes('references', '')
3218
# update target format
3219
branch._transport.put_bytes('format', format.get_format_string())
3222
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3223
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3226
_run_with_write_locked_target will attempt to release the lock it acquires.
3228
If an exception is raised by callable, then that exception *will* be
3229
propagated, even if the unlock attempt raises its own error. Thus
3230
_run_with_write_locked_target should be preferred to simply doing::
3234
return callable(*args, **kwargs)
3239
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3240
# should share code?
3243
result = callable(*args, **kwargs)
3245
exc_info = sys.exc_info()
3249
raise exc_info[0], exc_info[1], exc_info[2]
3255
class InterBranch(InterObject):
3256
"""This class represents operations taking place between two branches.
3258
Its instances have methods like pull() and push() and contain
3259
references to the source and target repositories these operations
3260
can be carried out on.
3264
"""The available optimised InterBranch types."""
3267
def _get_branch_formats_to_test(klass):
3268
"""Return an iterable of format tuples for testing.
3270
:return: An iterable of (from_format, to_format) to use when testing
3271
this InterBranch class. Each InterBranch class should define this
3274
raise NotImplementedError(klass._get_branch_formats_to_test)
3277
def pull(self, overwrite=False, stop_revision=None,
3278
possible_transports=None, local=False):
3279
"""Mirror source into target branch.
3281
The target branch is considered to be 'local', having low latency.
3283
:returns: PullResult instance
3285
raise NotImplementedError(self.pull)
3288
def update_revisions(self, stop_revision=None, overwrite=False,
3289
graph=None, fetch_tags=True):
3290
"""Pull in new perfect-fit revisions.
3292
:param stop_revision: Updated until the given revision
3293
:param overwrite: Always set the branch pointer, rather than checking
3294
to see if it is a proper descendant.
3295
:param graph: A Graph object that can be used to query history
3296
information. This can be None.
3297
:param fetch_tags: Flag that specifies if tags from source should be
3301
raise NotImplementedError(self.update_revisions)
3304
def push(self, overwrite=False, stop_revision=None,
3305
_override_hook_source_branch=None):
3306
"""Mirror the source branch into the target branch.
3308
The source branch is considered to be 'local', having low latency.
3310
raise NotImplementedError(self.push)
3313
def copy_content_into(self, revision_id=None):
3314
"""Copy the content of source into target
3316
revision_id: if not None, the revision history in the new branch will
3317
be truncated to end with revision_id.
3319
raise NotImplementedError(self.copy_content_into)
3322
def fetch(self, stop_revision=None, fetch_spec=None):
3325
:param stop_revision: Last revision to fetch
3326
:param fetch_spec: Fetch spec.
3328
raise NotImplementedError(self.fetch)
3331
class GenericInterBranch(InterBranch):
3332
"""InterBranch implementation that uses public Branch functions."""
3335
def is_compatible(klass, source, target):
3336
# GenericBranch uses the public API, so always compatible
3340
def _get_branch_formats_to_test(klass):
3341
return [(format_registry.get_default(), format_registry.get_default())]
3344
def unwrap_format(klass, format):
3345
if isinstance(format, remote.RemoteBranchFormat):
3346
format._ensure_real()
3347
return format._custom_format
3351
def copy_content_into(self, revision_id=None):
3352
"""Copy the content of source into target
3354
revision_id: if not None, the revision history in the new branch will
3355
be truncated to end with revision_id.
3357
self.source.update_references(self.target)
3358
self.source._synchronize_history(self.target, revision_id)
3360
parent = self.source.get_parent()
3361
except errors.InaccessibleParent, e:
3362
mutter('parent was not accessible to copy: %s', e)
3365
self.target.set_parent(parent)
3366
if self.source._push_should_merge_tags():
3367
self.source.tags.merge_to(self.target.tags)
3370
def fetch(self, stop_revision=None, fetch_spec=None):
3371
if fetch_spec is not None and stop_revision is not None:
3372
raise AssertionError(
3373
"fetch_spec and last_revision are mutually exclusive.")
3374
if self.target.base == self.source.base:
3376
self.source.lock_read()
3378
if stop_revision is None and fetch_spec is None:
3379
stop_revision = self.source.last_revision()
3380
stop_revision = _mod_revision.ensure_null(stop_revision)
3381
return self.target.repository.fetch(self.source.repository,
3382
revision_id=stop_revision, fetch_spec=fetch_spec)
3384
self.source.unlock()
3387
def update_revisions(self, stop_revision=None, overwrite=False,
3388
graph=None, fetch_tags=True):
3389
"""See InterBranch.update_revisions()."""
3390
other_revno, other_last_revision = self.source.last_revision_info()
3391
stop_revno = None # unknown
3392
if stop_revision is None:
3393
stop_revision = other_last_revision
3394
if _mod_revision.is_null(stop_revision):
3395
# if there are no commits, we're done.
3397
stop_revno = other_revno
3399
# what's the current last revision, before we fetch [and change it
3401
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3402
# we fetch here so that we don't process data twice in the common
3403
# case of having something to pull, and so that the check for
3404
# already merged can operate on the just fetched graph, which will
3405
# be cached in memory.
3407
fetch_spec_factory = fetch.FetchSpecFactory()
3408
fetch_spec_factory.source_branch = self.source
3409
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3410
fetch_spec_factory.source_repo = self.source.repository
3411
fetch_spec_factory.target_repo = self.target.repository
3412
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3413
fetch_spec = fetch_spec_factory.make_fetch_spec()
3415
fetch_spec = _mod_graph.NotInOtherForRevs(self.target.repository,
3416
self.source.repository, revision_ids=[stop_revision]).execute()
3417
self.target.fetch(self.source, fetch_spec=fetch_spec)
3418
# Check to see if one is an ancestor of the other
3421
graph = self.target.repository.get_graph()
3422
if self.target._check_if_descendant_or_diverged(
3423
stop_revision, last_rev, graph, self.source):
3424
# stop_revision is a descendant of last_rev, but we aren't
3425
# overwriting, so we're done.
3427
if stop_revno is None:
3429
graph = self.target.repository.get_graph()
3430
this_revno, this_last_revision = \
3431
self.target.last_revision_info()
3432
stop_revno = graph.find_distance_to_null(stop_revision,
3433
[(other_last_revision, other_revno),
3434
(this_last_revision, this_revno)])
3435
self.target.set_last_revision_info(stop_revno, stop_revision)
3438
def pull(self, overwrite=False, stop_revision=None,
3439
possible_transports=None, run_hooks=True,
3440
_override_hook_target=None, local=False):
3441
"""Pull from source into self, updating my master if any.
3443
:param run_hooks: Private parameter - if false, this branch
3444
is being called because it's the master of the primary branch,
3445
so it should not run its hooks.
3447
bound_location = self.target.get_bound_location()
3448
if local and not bound_location:
3449
raise errors.LocalRequiresBoundBranch()
3450
master_branch = None
3451
source_is_master = (self.source.user_url == bound_location)
3452
if not local and bound_location and not source_is_master:
3453
# not pulling from master, so we need to update master.
3454
master_branch = self.target.get_master_branch(possible_transports)
3455
master_branch.lock_write()
3458
# pull from source into master.
3459
master_branch.pull(self.source, overwrite, stop_revision,
3461
return self._pull(overwrite,
3462
stop_revision, _hook_master=master_branch,
3463
run_hooks=run_hooks,
3464
_override_hook_target=_override_hook_target,
3465
merge_tags_to_master=not source_is_master)
3468
master_branch.unlock()
3470
def push(self, overwrite=False, stop_revision=None,
3471
_override_hook_source_branch=None):
3472
"""See InterBranch.push.
3474
This is the basic concrete implementation of push()
3476
:param _override_hook_source_branch: If specified, run
3477
the hooks passing this Branch as the source, rather than self.
3478
This is for use of RemoteBranch, where push is delegated to the
3479
underlying vfs-based Branch.
3481
# TODO: Public option to disable running hooks - should be trivial but
3483
self.source.lock_read()
3485
return _run_with_write_locked_target(
3486
self.target, self._push_with_bound_branches, overwrite,
3488
_override_hook_source_branch=_override_hook_source_branch)
3490
self.source.unlock()
3492
def _push_with_bound_branches(self, overwrite, stop_revision,
3493
_override_hook_source_branch=None):
3494
"""Push from source into target, and into target's master if any.
3497
if _override_hook_source_branch:
3498
result.source_branch = _override_hook_source_branch
3499
for hook in Branch.hooks['post_push']:
3502
bound_location = self.target.get_bound_location()
3503
if bound_location and self.target.base != bound_location:
3504
# there is a master branch.
3506
# XXX: Why the second check? Is it even supported for a branch to
3507
# be bound to itself? -- mbp 20070507
3508
master_branch = self.target.get_master_branch()
3509
master_branch.lock_write()
3511
# push into the master from the source branch.
3512
self.source._basic_push(master_branch, overwrite, stop_revision)
3513
# and push into the target branch from the source. Note that we
3514
# push from the source branch again, because it's considered the
3515
# highest bandwidth repository.
3516
result = self.source._basic_push(self.target, overwrite,
3518
result.master_branch = master_branch
3519
result.local_branch = self.target
3523
master_branch.unlock()
3526
result = self.source._basic_push(self.target, overwrite,
3528
# TODO: Why set master_branch and local_branch if there's no
3529
# binding? Maybe cleaner to just leave them unset? -- mbp
3531
result.master_branch = self.target
3532
result.local_branch = None
3536
def _pull(self, overwrite=False, stop_revision=None,
3537
possible_transports=None, _hook_master=None, run_hooks=True,
3538
_override_hook_target=None, local=False,
3539
merge_tags_to_master=True):
3542
This function is the core worker, used by GenericInterBranch.pull to
3543
avoid duplication when pulling source->master and source->local.
3545
:param _hook_master: Private parameter - set the branch to
3546
be supplied as the master to pull hooks.
3547
:param run_hooks: Private parameter - if false, this branch
3548
is being called because it's the master of the primary branch,
3549
so it should not run its hooks.
3550
is being called because it's the master of the primary branch,
3551
so it should not run its hooks.
3552
:param _override_hook_target: Private parameter - set the branch to be
3553
supplied as the target_branch to pull hooks.
3554
:param local: Only update the local branch, and not the bound branch.
3556
# This type of branch can't be bound.
3558
raise errors.LocalRequiresBoundBranch()
3559
result = PullResult()
3560
result.source_branch = self.source
3561
if _override_hook_target is None:
3562
result.target_branch = self.target
3564
result.target_branch = _override_hook_target
3565
self.source.lock_read()
3567
# We assume that during 'pull' the target repository is closer than
3569
self.source.update_references(self.target)
3570
graph = self.target.repository.get_graph(self.source.repository)
3571
# TODO: Branch formats should have a flag that indicates
3572
# that revno's are expensive, and pull() should honor that flag.
3574
result.old_revno, result.old_revid = \
3575
self.target.last_revision_info()
3576
self.target.update_revisions(self.source, stop_revision,
3577
overwrite=overwrite, graph=graph)
3578
# TODO: The old revid should be specified when merging tags,
3579
# so a tags implementation that versions tags can only
3580
# pull in the most recent changes. -- JRV20090506
3581
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3582
overwrite, ignore_master=not merge_tags_to_master)
3583
result.new_revno, result.new_revid = self.target.last_revision_info()
3585
result.master_branch = _hook_master
3586
result.local_branch = result.target_branch
3588
result.master_branch = result.target_branch
3589
result.local_branch = None
3591
for hook in Branch.hooks['post_pull']:
3594
self.source.unlock()
3598
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
