1
# Copyright (C) 2005-2010 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,
33
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TransportConfig
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
from bzrlib.hooks import HookPoint, Hooks
51
from bzrlib.inter import InterObject
52
from bzrlib.lock import _RelockDebugMixin
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
61
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
62
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
class Branch(bzrdir.ControlComponent):
67
"""Branch holding a history of revisions.
70
Base directory/url of the branch; using control_url and
71
control_transport is more standardized.
73
hooks: An instance of BranchHooks.
75
# this is really an instance variable - FIXME move it there
80
def control_transport(self):
81
return self._transport
84
def user_transport(self):
85
return self.bzrdir.user_transport
87
def __init__(self, *ignored, **ignored_too):
88
self.tags = self._format.make_tags(self)
89
self._revision_history_cache = None
90
self._revision_id_to_revno_cache = None
91
self._partial_revision_id_to_revno_cache = {}
92
self._partial_revision_history_cache = []
93
self._last_revision_info_cache = None
94
self._merge_sorted_revisions_cache = None
96
hooks = Branch.hooks['open']
100
def _open_hook(self):
101
"""Called by init to allow simpler extension of the base class."""
103
def _activate_fallback_location(self, url):
104
"""Activate the branch/repository from url as a fallback repository."""
105
repo = self._get_fallback_repository(url)
106
if repo.has_same_location(self.repository):
107
raise errors.UnstackableLocationError(self.user_url, url)
108
self.repository.add_fallback_repository(repo)
110
def break_lock(self):
111
"""Break a lock if one is present from another instance.
113
Uses the ui factory to ask for confirmation if the lock may be from
116
This will probe the repository for its lock as well.
118
self.control_files.break_lock()
119
self.repository.break_lock()
120
master = self.get_master_branch()
121
if master is not None:
124
def _check_stackable_repo(self):
125
if not self.repository._format.supports_external_lookups:
126
raise errors.UnstackableRepositoryFormat(self.repository._format,
127
self.repository.base)
129
def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
"""Extend the partial history to include a given index
132
If a stop_index is supplied, stop when that index has been reached.
133
If a stop_revision is supplied, stop when that revision is
134
encountered. Otherwise, stop when the beginning of history is
137
:param stop_index: The index which should be present. When it is
138
present, history extension will stop.
139
:param stop_revision: The revision id which should be present. When
140
it is encountered, history extension will stop.
142
if len(self._partial_revision_history_cache) == 0:
143
self._partial_revision_history_cache = [self.last_revision()]
144
repository._iter_for_revno(
145
self.repository, self._partial_revision_history_cache,
146
stop_index=stop_index, stop_revision=stop_revision)
147
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
self._partial_revision_history_cache.pop()
150
def _get_check_refs(self):
151
"""Get the references needed for check().
155
revid = self.last_revision()
156
return [('revision-existence', revid), ('lefthand-distance', revid)]
159
def open(base, _unsupported=False, possible_transports=None):
160
"""Open the branch rooted at base.
162
For instance, if the branch is at URL/.bzr/branch,
163
Branch.open(URL) -> a Branch instance.
165
control = bzrdir.BzrDir.open(base, _unsupported,
166
possible_transports=possible_transports)
167
return control.open_branch(unsupported=_unsupported)
170
def open_from_transport(transport, name=None, _unsupported=False):
171
"""Open the branch rooted at transport"""
172
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
return control.open_branch(name=name, unsupported=_unsupported)
176
def open_containing(url, possible_transports=None):
177
"""Open an existing branch which contains url.
179
This probes for a branch at url, and searches upwards from there.
181
Basically we keep looking up until we find the control directory or
182
run into the root. If there isn't one, raises NotBranchError.
183
If there is one and it is either an unrecognised format or an unsupported
184
format, UnknownFormatError or UnsupportedFormatError are raised.
185
If there is one, it is returned, along with the unused portion of url.
187
control, relpath = bzrdir.BzrDir.open_containing(url,
189
return control.open_branch(), relpath
191
def _push_should_merge_tags(self):
192
"""Should _basic_push merge this branch's tags into the target?
194
The default implementation returns False if this branch has no tags,
195
and True the rest of the time. Subclasses may override this.
197
return self.supports_tags() and self.tags.get_tag_dict()
199
def get_config(self):
200
return BranchConfig(self)
202
def _get_config(self):
203
"""Get the concrete config for just the config in this branch.
205
This is not intended for client use; see Branch.get_config for the
210
:return: An object supporting get_option and set_option.
212
raise NotImplementedError(self._get_config)
214
def _get_fallback_repository(self, url):
215
"""Get the repository we fallback to at url."""
216
url = urlutils.join(self.base, url)
217
a_branch = Branch.open(url,
218
possible_transports=[self.bzrdir.root_transport])
219
return a_branch.repository
221
def _get_tags_bytes(self):
222
"""Get the bytes of a serialised tags dict.
224
Note that not all branches support tags, nor do all use the same tags
225
logic: this method is specific to BasicTags. Other tag implementations
226
may use the same method name and behave differently, safely, because
227
of the double-dispatch via
228
format.make_tags->tags_instance->get_tags_dict.
230
:return: The bytes of the tags file.
231
:seealso: Branch._set_tags_bytes.
233
return self._transport.get_bytes('tags')
235
def _get_nick(self, local=False, possible_transports=None):
236
config = self.get_config()
237
# explicit overrides master, but don't look for master if local is True
238
if not local and not config.has_explicit_nickname():
240
master = self.get_master_branch(possible_transports)
241
if master is not None:
242
# return the master branch value
244
except errors.BzrError, e:
245
# Silently fall back to local implicit nick if the master is
247
mutter("Could not connect to bound branch, "
248
"falling back to local nick.\n " + str(e))
249
return config.get_nickname()
251
def _set_nick(self, nick):
252
self.get_config().set_user_option('nickname', nick, warn_masked=True)
254
nick = property(_get_nick, _set_nick)
257
raise NotImplementedError(self.is_locked)
259
def _lefthand_history(self, revision_id, last_rev=None,
261
if 'evil' in debug.debug_flags:
262
mutter_callsite(4, "_lefthand_history scales with history.")
263
# stop_revision must be a descendant of last_revision
264
graph = self.repository.get_graph()
265
if last_rev is not None:
266
if not graph.is_ancestor(last_rev, revision_id):
267
# our previous tip is not merged into stop_revision
268
raise errors.DivergedBranches(self, other_branch)
269
# make a new revision history from the graph
270
parents_map = graph.get_parent_map([revision_id])
271
if revision_id not in parents_map:
272
raise errors.NoSuchRevision(self, revision_id)
273
current_rev_id = revision_id
275
check_not_reserved_id = _mod_revision.check_not_reserved_id
276
# Do not include ghosts or graph origin in revision_history
277
while (current_rev_id in parents_map and
278
len(parents_map[current_rev_id]) > 0):
279
check_not_reserved_id(current_rev_id)
280
new_history.append(current_rev_id)
281
current_rev_id = parents_map[current_rev_id][0]
282
parents_map = graph.get_parent_map([current_rev_id])
283
new_history.reverse()
286
def lock_write(self):
287
raise NotImplementedError(self.lock_write)
290
raise NotImplementedError(self.lock_read)
293
raise NotImplementedError(self.unlock)
295
def peek_lock_mode(self):
296
"""Return lock mode for the Branch: 'r', 'w' or None"""
297
raise NotImplementedError(self.peek_lock_mode)
299
def get_physical_lock_status(self):
300
raise NotImplementedError(self.get_physical_lock_status)
303
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
304
"""Return the revision_id for a dotted revno.
306
:param revno: a tuple like (1,) or (1,1,2)
307
:param _cache_reverse: a private parameter enabling storage
308
of the reverse mapping in a top level cache. (This should
309
only be done in selective circumstances as we want to
310
avoid having the mapping cached multiple times.)
311
:return: the revision_id
312
:raises errors.NoSuchRevision: if the revno doesn't exist
314
rev_id = self._do_dotted_revno_to_revision_id(revno)
316
self._partial_revision_id_to_revno_cache[rev_id] = revno
319
def _do_dotted_revno_to_revision_id(self, revno):
320
"""Worker function for dotted_revno_to_revision_id.
322
Subclasses should override this if they wish to
323
provide a more efficient implementation.
326
return self.get_rev_id(revno[0])
327
revision_id_to_revno = self.get_revision_id_to_revno_map()
328
revision_ids = [revision_id for revision_id, this_revno
329
in revision_id_to_revno.iteritems()
330
if revno == this_revno]
331
if len(revision_ids) == 1:
332
return revision_ids[0]
334
revno_str = '.'.join(map(str, revno))
335
raise errors.NoSuchRevision(self, revno_str)
338
def revision_id_to_dotted_revno(self, revision_id):
339
"""Given a revision id, return its dotted revno.
341
:return: a tuple like (1,) or (400,1,3).
343
return self._do_revision_id_to_dotted_revno(revision_id)
345
def _do_revision_id_to_dotted_revno(self, revision_id):
346
"""Worker function for revision_id_to_revno."""
347
# Try the caches if they are loaded
348
result = self._partial_revision_id_to_revno_cache.get(revision_id)
349
if result is not None:
351
if self._revision_id_to_revno_cache:
352
result = self._revision_id_to_revno_cache.get(revision_id)
354
raise errors.NoSuchRevision(self, revision_id)
355
# Try the mainline as it's optimised
357
revno = self.revision_id_to_revno(revision_id)
359
except errors.NoSuchRevision:
360
# We need to load and use the full revno map after all
361
result = self.get_revision_id_to_revno_map().get(revision_id)
363
raise errors.NoSuchRevision(self, revision_id)
367
def get_revision_id_to_revno_map(self):
368
"""Return the revision_id => dotted revno map.
370
This will be regenerated on demand, but will be cached.
372
:return: A dictionary mapping revision_id => dotted revno.
373
This dictionary should not be modified by the caller.
375
if self._revision_id_to_revno_cache is not None:
376
mapping = self._revision_id_to_revno_cache
378
mapping = self._gen_revno_map()
379
self._cache_revision_id_to_revno(mapping)
380
# TODO: jam 20070417 Since this is being cached, should we be returning
382
# I would rather not, and instead just declare that users should not
383
# modify the return value.
386
def _gen_revno_map(self):
387
"""Create a new mapping from revision ids to dotted revnos.
389
Dotted revnos are generated based on the current tip in the revision
391
This is the worker function for get_revision_id_to_revno_map, which
392
just caches the return value.
394
:return: A dictionary mapping revision_id => dotted revno.
396
revision_id_to_revno = dict((rev_id, revno)
397
for rev_id, depth, revno, end_of_merge
398
in self.iter_merge_sorted_revisions())
399
return revision_id_to_revno
402
def iter_merge_sorted_revisions(self, start_revision_id=None,
403
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
404
"""Walk the revisions for a branch in merge sorted order.
406
Merge sorted order is the output from a merge-aware,
407
topological sort, i.e. all parents come before their
408
children going forward; the opposite for reverse.
410
:param start_revision_id: the revision_id to begin walking from.
411
If None, the branch tip is used.
412
:param stop_revision_id: the revision_id to terminate the walk
413
after. If None, the rest of history is included.
414
:param stop_rule: if stop_revision_id is not None, the precise rule
415
to use for termination:
416
* 'exclude' - leave the stop revision out of the result (default)
417
* 'include' - the stop revision is the last item in the result
418
* 'with-merges' - include the stop revision and all of its
419
merged revisions in the result
420
:param direction: either 'reverse' or 'forward':
421
* reverse means return the start_revision_id first, i.e.
422
start at the most recent revision and go backwards in history
423
* forward returns tuples in the opposite order to reverse.
424
Note in particular that forward does *not* do any intelligent
425
ordering w.r.t. depth as some clients of this API may like.
426
(If required, that ought to be done at higher layers.)
428
:return: an iterator over (revision_id, depth, revno, end_of_merge)
431
* revision_id: the unique id of the revision
432
* depth: How many levels of merging deep this node has been
434
* revno_sequence: This field provides a sequence of
435
revision numbers for all revisions. The format is:
436
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
437
branch that the revno is on. From left to right the REVNO numbers
438
are the sequence numbers within that branch of the revision.
439
* end_of_merge: When True the next node (earlier in history) is
440
part of a different merge.
442
# Note: depth and revno values are in the context of the branch so
443
# we need the full graph to get stable numbers, regardless of the
445
if self._merge_sorted_revisions_cache is None:
446
last_revision = self.last_revision()
447
known_graph = self.repository.get_known_graph_ancestry(
449
self._merge_sorted_revisions_cache = known_graph.merge_sort(
451
filtered = self._filter_merge_sorted_revisions(
452
self._merge_sorted_revisions_cache, start_revision_id,
453
stop_revision_id, stop_rule)
454
# Make sure we don't return revisions that are not part of the
455
# start_revision_id ancestry.
456
filtered = self._filter_non_ancestors(filtered)
457
if direction == 'reverse':
459
if direction == 'forward':
460
return reversed(list(filtered))
462
raise ValueError('invalid direction %r' % direction)
464
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
465
start_revision_id, stop_revision_id, stop_rule):
466
"""Iterate over an inclusive range of sorted revisions."""
467
rev_iter = iter(merge_sorted_revisions)
468
if start_revision_id is not None:
469
for node in rev_iter:
470
rev_id = node.key[-1]
471
if rev_id != start_revision_id:
474
# The decision to include the start or not
475
# depends on the stop_rule if a stop is provided
476
# so pop this node back into the iterator
477
rev_iter = chain(iter([node]), rev_iter)
479
if stop_revision_id is None:
481
for node in rev_iter:
482
rev_id = node.key[-1]
483
yield (rev_id, node.merge_depth, node.revno,
485
elif stop_rule == 'exclude':
486
for node in rev_iter:
487
rev_id = node.key[-1]
488
if rev_id == stop_revision_id:
490
yield (rev_id, node.merge_depth, node.revno,
492
elif stop_rule == 'include':
493
for node in rev_iter:
494
rev_id = node.key[-1]
495
yield (rev_id, node.merge_depth, node.revno,
497
if rev_id == stop_revision_id:
499
elif stop_rule == 'with-merges':
500
stop_rev = self.repository.get_revision(stop_revision_id)
501
if stop_rev.parent_ids:
502
left_parent = stop_rev.parent_ids[0]
504
left_parent = _mod_revision.NULL_REVISION
505
# left_parent is the actual revision we want to stop logging at,
506
# since we want to show the merged revisions after the stop_rev too
507
reached_stop_revision_id = False
508
revision_id_whitelist = []
509
for node in rev_iter:
510
rev_id = node.key[-1]
511
if rev_id == left_parent:
512
# reached the left parent after the stop_revision
514
if (not reached_stop_revision_id or
515
rev_id in revision_id_whitelist):
516
yield (rev_id, node.merge_depth, node.revno,
518
if reached_stop_revision_id or rev_id == stop_revision_id:
519
# only do the merged revs of rev_id from now on
520
rev = self.repository.get_revision(rev_id)
522
reached_stop_revision_id = True
523
revision_id_whitelist.extend(rev.parent_ids)
525
raise ValueError('invalid stop_rule %r' % stop_rule)
527
def _filter_non_ancestors(self, rev_iter):
528
# If we started from a dotted revno, we want to consider it as a tip
529
# and don't want to yield revisions that are not part of its
530
# ancestry. Given the order guaranteed by the merge sort, we will see
531
# uninteresting descendants of the first parent of our tip before the
533
first = rev_iter.next()
534
(rev_id, merge_depth, revno, end_of_merge) = first
537
# We start at a mainline revision so by definition, all others
538
# revisions in rev_iter are ancestors
539
for node in rev_iter:
544
pmap = self.repository.get_parent_map([rev_id])
545
parents = pmap.get(rev_id, [])
547
whitelist.update(parents)
549
# If there is no parents, there is nothing of interest left
551
# FIXME: It's hard to test this scenario here as this code is never
552
# called in that case. -- vila 20100322
555
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
557
if rev_id in whitelist:
558
pmap = self.repository.get_parent_map([rev_id])
559
parents = pmap.get(rev_id, [])
560
whitelist.remove(rev_id)
561
whitelist.update(parents)
563
# We've reached the mainline, there is nothing left to
567
# A revision that is not part of the ancestry of our
570
yield (rev_id, merge_depth, revno, end_of_merge)
572
def leave_lock_in_place(self):
573
"""Tell this branch object not to release the physical lock when this
576
If lock_write doesn't return a token, then this method is not supported.
578
self.control_files.leave_in_place()
580
def dont_leave_lock_in_place(self):
581
"""Tell this branch object to release the physical lock when this
582
object is unlocked, even if it didn't originally acquire it.
584
If lock_write doesn't return a token, then this method is not supported.
586
self.control_files.dont_leave_in_place()
588
def bind(self, other):
589
"""Bind the local branch the other branch.
591
:param other: The branch to bind to
594
raise errors.UpgradeRequired(self.user_url)
596
def set_append_revisions_only(self, enabled):
597
if not self._format.supports_set_append_revisions_only():
598
raise errors.UpgradeRequired(self.user_url)
603
self.get_config().set_user_option('append_revisions_only', value,
606
def set_reference_info(self, file_id, tree_path, branch_location):
607
"""Set the branch location to use for a tree reference."""
608
raise errors.UnsupportedOperation(self.set_reference_info, self)
610
def get_reference_info(self, file_id):
611
"""Get the tree_path and branch_location for a tree reference."""
612
raise errors.UnsupportedOperation(self.get_reference_info, self)
615
def fetch(self, from_branch, last_revision=None, pb=None):
616
"""Copy revisions from from_branch into this branch.
618
:param from_branch: Where to copy from.
619
:param last_revision: What revision to stop at (None for at the end
621
:param pb: An optional progress bar to use.
624
if self.base == from_branch.base:
627
symbol_versioning.warn(
628
symbol_versioning.deprecated_in((1, 14, 0))
629
% "pb parameter to fetch()")
630
from_branch.lock_read()
632
if last_revision is None:
633
last_revision = from_branch.last_revision()
634
last_revision = _mod_revision.ensure_null(last_revision)
635
return self.repository.fetch(from_branch.repository,
636
revision_id=last_revision,
641
def get_bound_location(self):
642
"""Return the URL of the branch we are bound to.
644
Older format branches cannot bind, please be sure to use a metadir
649
def get_old_bound_location(self):
650
"""Return the URL of the branch we used to be bound to
652
raise errors.UpgradeRequired(self.user_url)
654
def get_commit_builder(self, parents, config=None, timestamp=None,
655
timezone=None, committer=None, revprops=None,
657
"""Obtain a CommitBuilder for this branch.
659
:param parents: Revision ids of the parents of the new revision.
660
:param config: Optional configuration to use.
661
:param timestamp: Optional timestamp recorded for commit.
662
:param timezone: Optional timezone for timestamp.
663
:param committer: Optional committer to set for commit.
664
:param revprops: Optional dictionary of revision properties.
665
:param revision_id: Optional revision id.
669
config = self.get_config()
671
return self.repository.get_commit_builder(self, parents, config,
672
timestamp, timezone, committer, revprops, revision_id)
674
def get_master_branch(self, possible_transports=None):
675
"""Return the branch we are bound to.
677
:return: Either a Branch, or None
681
def get_revision_delta(self, revno):
682
"""Return the delta for one revision.
684
The delta is relative to its mainline predecessor, or the
685
empty tree for revision 1.
687
rh = self.revision_history()
688
if not (1 <= revno <= len(rh)):
689
raise errors.InvalidRevisionNumber(revno)
690
return self.repository.get_revision_delta(rh[revno-1])
692
def get_stacked_on_url(self):
693
"""Get the URL this branch is stacked against.
695
:raises NotStacked: If the branch is not stacked.
696
:raises UnstackableBranchFormat: If the branch does not support
699
raise NotImplementedError(self.get_stacked_on_url)
701
def print_file(self, file, revision_id):
702
"""Print `file` to stdout."""
703
raise NotImplementedError(self.print_file)
705
def set_revision_history(self, rev_history):
706
raise NotImplementedError(self.set_revision_history)
709
def set_parent(self, url):
710
"""See Branch.set_parent."""
711
# TODO: Maybe delete old location files?
712
# URLs should never be unicode, even on the local fs,
713
# FIXUP this and get_parent in a future branch format bump:
714
# read and rewrite the file. RBC 20060125
716
if isinstance(url, unicode):
718
url = url.encode('ascii')
719
except UnicodeEncodeError:
720
raise errors.InvalidURL(url,
721
"Urls must be 7-bit ascii, "
722
"use bzrlib.urlutils.escape")
723
url = urlutils.relative_url(self.base, url)
724
self._set_parent_location(url)
727
def set_stacked_on_url(self, url):
728
"""Set the URL this branch is stacked against.
730
:raises UnstackableBranchFormat: If the branch does not support
732
:raises UnstackableRepositoryFormat: If the repository does not support
735
if not self._format.supports_stacking():
736
raise errors.UnstackableBranchFormat(self._format, self.user_url)
737
# XXX: Changing from one fallback repository to another does not check
738
# that all the data you need is present in the new fallback.
739
# Possibly it should.
740
self._check_stackable_repo()
743
old_url = self.get_stacked_on_url()
744
except (errors.NotStacked, errors.UnstackableBranchFormat,
745
errors.UnstackableRepositoryFormat):
749
self._activate_fallback_location(url)
750
# write this out after the repository is stacked to avoid setting a
751
# stacked config that doesn't work.
752
self._set_config_location('stacked_on_location', url)
755
"""Change a branch to be unstacked, copying data as needed.
757
Don't call this directly, use set_stacked_on_url(None).
759
pb = ui.ui_factory.nested_progress_bar()
761
pb.update("Unstacking")
762
# The basic approach here is to fetch the tip of the branch,
763
# including all available ghosts, from the existing stacked
764
# repository into a new repository object without the fallbacks.
766
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
767
# correct for CHKMap repostiories
768
old_repository = self.repository
769
if len(old_repository._fallback_repositories) != 1:
770
raise AssertionError("can't cope with fallback repositories "
771
"of %r" % (self.repository,))
772
# unlock it, including unlocking the fallback
773
old_repository.unlock()
774
old_repository.lock_read()
776
# Repositories don't offer an interface to remove fallback
777
# repositories today; take the conceptually simpler option and just
778
# reopen it. We reopen it starting from the URL so that we
779
# get a separate connection for RemoteRepositories and can
780
# stream from one of them to the other. This does mean doing
781
# separate SSH connection setup, but unstacking is not a
782
# common operation so it's tolerable.
783
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
784
new_repository = new_bzrdir.find_repository()
785
self.repository = new_repository
786
if self.repository._fallback_repositories:
787
raise AssertionError("didn't expect %r to have "
788
"fallback_repositories"
789
% (self.repository,))
790
# this is not paired with an unlock because it's just restoring
791
# the previous state; the lock's released when set_stacked_on_url
793
self.repository.lock_write()
794
# XXX: If you unstack a branch while it has a working tree
795
# with a pending merge, the pending-merged revisions will no
796
# longer be present. You can (probably) revert and remerge.
798
# XXX: This only fetches up to the tip of the repository; it
799
# doesn't bring across any tags. That's fairly consistent
800
# with how branch works, but perhaps not ideal.
801
self.repository.fetch(old_repository,
802
revision_id=self.last_revision(),
805
old_repository.unlock()
809
def _set_tags_bytes(self, bytes):
810
"""Mirror method for _get_tags_bytes.
812
:seealso: Branch._get_tags_bytes.
814
return _run_with_write_locked_target(self, self._transport.put_bytes,
817
def _cache_revision_history(self, rev_history):
818
"""Set the cached revision history to rev_history.
820
The revision_history method will use this cache to avoid regenerating
821
the revision history.
823
This API is semi-public; it only for use by subclasses, all other code
824
should consider it to be private.
826
self._revision_history_cache = rev_history
828
def _cache_revision_id_to_revno(self, revision_id_to_revno):
829
"""Set the cached revision_id => revno map to revision_id_to_revno.
831
This API is semi-public; it only for use by subclasses, all other code
832
should consider it to be private.
834
self._revision_id_to_revno_cache = revision_id_to_revno
836
def _clear_cached_state(self):
837
"""Clear any cached data on this branch, e.g. cached revision history.
839
This means the next call to revision_history will need to call
840
_gen_revision_history.
842
This API is semi-public; it only for use by subclasses, all other code
843
should consider it to be private.
845
self._revision_history_cache = None
846
self._revision_id_to_revno_cache = None
847
self._last_revision_info_cache = None
848
self._merge_sorted_revisions_cache = None
849
self._partial_revision_history_cache = []
850
self._partial_revision_id_to_revno_cache = {}
852
def _gen_revision_history(self):
853
"""Return sequence of revision hashes on to this branch.
855
Unlike revision_history, this method always regenerates or rereads the
856
revision history, i.e. it does not cache the result, so repeated calls
859
Concrete subclasses should override this instead of revision_history so
860
that subclasses do not need to deal with caching logic.
862
This API is semi-public; it only for use by subclasses, all other code
863
should consider it to be private.
865
raise NotImplementedError(self._gen_revision_history)
868
def revision_history(self):
869
"""Return sequence of revision ids on this branch.
871
This method will cache the revision history for as long as it is safe to
874
if 'evil' in debug.debug_flags:
875
mutter_callsite(3, "revision_history scales with history.")
876
if self._revision_history_cache is not None:
877
history = self._revision_history_cache
879
history = self._gen_revision_history()
880
self._cache_revision_history(history)
884
"""Return current revision number for this branch.
886
That is equivalent to the number of revisions committed to
889
return self.last_revision_info()[0]
892
"""Older format branches cannot bind or unbind."""
893
raise errors.UpgradeRequired(self.user_url)
895
def last_revision(self):
896
"""Return last revision id, or NULL_REVISION."""
897
return self.last_revision_info()[1]
900
def last_revision_info(self):
901
"""Return information about the last revision.
903
:return: A tuple (revno, revision_id).
905
if self._last_revision_info_cache is None:
906
self._last_revision_info_cache = self._last_revision_info()
907
return self._last_revision_info_cache
909
def _last_revision_info(self):
910
rh = self.revision_history()
913
return (revno, rh[-1])
915
return (0, _mod_revision.NULL_REVISION)
917
@deprecated_method(deprecated_in((1, 6, 0)))
918
def missing_revisions(self, other, stop_revision=None):
919
"""Return a list of new revisions that would perfectly fit.
921
If self and other have not diverged, return a list of the revisions
922
present in other, but missing from self.
924
self_history = self.revision_history()
925
self_len = len(self_history)
926
other_history = other.revision_history()
927
other_len = len(other_history)
928
common_index = min(self_len, other_len) -1
929
if common_index >= 0 and \
930
self_history[common_index] != other_history[common_index]:
931
raise errors.DivergedBranches(self, other)
933
if stop_revision is None:
934
stop_revision = other_len
936
if stop_revision > other_len:
937
raise errors.NoSuchRevision(self, stop_revision)
938
return other_history[self_len:stop_revision]
941
def update_revisions(self, other, stop_revision=None, overwrite=False,
943
"""Pull in new perfect-fit revisions.
945
:param other: Another Branch to pull from
946
:param stop_revision: Updated until the given revision
947
:param overwrite: Always set the branch pointer, rather than checking
948
to see if it is a proper descendant.
949
:param graph: A Graph object that can be used to query history
950
information. This can be None.
953
return InterBranch.get(other, self).update_revisions(stop_revision,
956
def import_last_revision_info(self, source_repo, revno, revid):
957
"""Set the last revision info, importing from another repo if necessary.
959
This is used by the bound branch code to upload a revision to
960
the master branch first before updating the tip of the local branch.
962
:param source_repo: Source repository to optionally fetch from
963
:param revno: Revision number of the new tip
964
:param revid: Revision id of the new tip
966
if not self.repository.has_same_location(source_repo):
967
self.repository.fetch(source_repo, revision_id=revid)
968
self.set_last_revision_info(revno, revid)
970
def revision_id_to_revno(self, revision_id):
971
"""Given a revision id, return its revno"""
972
if _mod_revision.is_null(revision_id):
974
history = self.revision_history()
976
return history.index(revision_id) + 1
978
raise errors.NoSuchRevision(self, revision_id)
981
def get_rev_id(self, revno, history=None):
982
"""Find the revision id of the specified revno."""
984
return _mod_revision.NULL_REVISION
985
last_revno, last_revid = self.last_revision_info()
986
if revno == last_revno:
988
if revno <= 0 or revno > last_revno:
989
raise errors.NoSuchRevision(self, revno)
990
distance_from_last = last_revno - revno
991
if len(self._partial_revision_history_cache) <= distance_from_last:
992
self._extend_partial_history(distance_from_last)
993
return self._partial_revision_history_cache[distance_from_last]
996
def pull(self, source, overwrite=False, stop_revision=None,
997
possible_transports=None, *args, **kwargs):
998
"""Mirror source into this branch.
1000
This branch is considered to be 'local', having low latency.
1002
:returns: PullResult instance
1004
return InterBranch.get(source, self).pull(overwrite=overwrite,
1005
stop_revision=stop_revision,
1006
possible_transports=possible_transports, *args, **kwargs)
1008
def push(self, target, overwrite=False, stop_revision=None, *args,
1010
"""Mirror this branch into target.
1012
This branch is considered to be 'local', having low latency.
1014
return InterBranch.get(self, target).push(overwrite, stop_revision,
1017
def lossy_push(self, target, stop_revision=None):
1018
"""Push deltas into another branch.
1020
:note: This does not, like push, retain the revision ids from
1021
the source branch and will, rather than adding bzr-specific
1022
metadata, push only those semantics of the revision that can be
1023
natively represented by this branch' VCS.
1025
:param target: Target branch
1026
:param stop_revision: Revision to push, defaults to last revision.
1027
:return: BranchPushResult with an extra member revidmap:
1028
A dictionary mapping revision ids from the target branch
1029
to new revision ids in the target branch, for each
1030
revision that was pushed.
1032
inter = InterBranch.get(self, target)
1033
lossy_push = getattr(inter, "lossy_push", None)
1034
if lossy_push is None:
1035
raise errors.LossyPushToSameVCS(self, target)
1036
return lossy_push(stop_revision)
1038
def basis_tree(self):
1039
"""Return `Tree` object for last revision."""
1040
return self.repository.revision_tree(self.last_revision())
1042
def get_parent(self):
1043
"""Return the parent location of the branch.
1045
This is the default location for pull/missing. The usual
1046
pattern is that the user can override it by specifying a
1049
parent = self._get_parent_location()
1052
# This is an old-format absolute path to a local branch
1053
# turn it into a url
1054
if parent.startswith('/'):
1055
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1057
return urlutils.join(self.base[:-1], parent)
1058
except errors.InvalidURLJoin, e:
1059
raise errors.InaccessibleParent(parent, self.user_url)
1061
def _get_parent_location(self):
1062
raise NotImplementedError(self._get_parent_location)
1064
def _set_config_location(self, name, url, config=None,
1065
make_relative=False):
1067
config = self.get_config()
1071
url = urlutils.relative_url(self.base, url)
1072
config.set_user_option(name, url, warn_masked=True)
1074
def _get_config_location(self, name, config=None):
1076
config = self.get_config()
1077
location = config.get_user_option(name)
1082
def get_child_submit_format(self):
1083
"""Return the preferred format of submissions to this branch."""
1084
return self.get_config().get_user_option("child_submit_format")
1086
def get_submit_branch(self):
1087
"""Return the submit location of the branch.
1089
This is the default location for bundle. The usual
1090
pattern is that the user can override it by specifying a
1093
return self.get_config().get_user_option('submit_branch')
1095
def set_submit_branch(self, location):
1096
"""Return the submit location of the branch.
1098
This is the default location for bundle. The usual
1099
pattern is that the user can override it by specifying a
1102
self.get_config().set_user_option('submit_branch', location,
1105
def get_public_branch(self):
1106
"""Return the public location of the branch.
1108
This is used by merge directives.
1110
return self._get_config_location('public_branch')
1112
def set_public_branch(self, location):
1113
"""Return the submit location of the branch.
1115
This is the default location for bundle. The usual
1116
pattern is that the user can override it by specifying a
1119
self._set_config_location('public_branch', location)
1121
def get_push_location(self):
1122
"""Return the None or the location to push this branch to."""
1123
push_loc = self.get_config().get_user_option('push_location')
1126
def set_push_location(self, location):
1127
"""Set a new push location for this branch."""
1128
raise NotImplementedError(self.set_push_location)
1130
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1131
"""Run the post_change_branch_tip hooks."""
1132
hooks = Branch.hooks['post_change_branch_tip']
1135
new_revno, new_revid = self.last_revision_info()
1136
params = ChangeBranchTipParams(
1137
self, old_revno, new_revno, old_revid, new_revid)
1141
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1142
"""Run the pre_change_branch_tip hooks."""
1143
hooks = Branch.hooks['pre_change_branch_tip']
1146
old_revno, old_revid = self.last_revision_info()
1147
params = ChangeBranchTipParams(
1148
self, old_revno, new_revno, old_revid, new_revid)
1154
"""Synchronise this branch with the master branch if any.
1156
:return: None or the last_revision pivoted out during the update.
1160
def check_revno(self, revno):
1162
Check whether a revno corresponds to any revision.
1163
Zero (the NULL revision) is considered valid.
1166
self.check_real_revno(revno)
1168
def check_real_revno(self, revno):
1170
Check whether a revno corresponds to a real revision.
1171
Zero (the NULL revision) is considered invalid
1173
if revno < 1 or revno > self.revno():
1174
raise errors.InvalidRevisionNumber(revno)
1177
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1178
"""Clone this branch into to_bzrdir preserving all semantic values.
1180
Most API users will want 'create_clone_on_transport', which creates a
1181
new bzrdir and branch on the fly.
1183
revision_id: if not None, the revision history in the new branch will
1184
be truncated to end with revision_id.
1186
result = to_bzrdir.create_branch()
1189
if repository_policy is not None:
1190
repository_policy.configure_branch(result)
1191
self.copy_content_into(result, revision_id=revision_id)
1197
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1198
"""Create a new line of development from the branch, into to_bzrdir.
1200
to_bzrdir controls the branch format.
1202
revision_id: if not None, the revision history in the new branch will
1203
be truncated to end with revision_id.
1205
if (repository_policy is not None and
1206
repository_policy.requires_stacking()):
1207
to_bzrdir._format.require_stacking(_skip_repo=True)
1208
result = to_bzrdir.create_branch()
1211
if repository_policy is not None:
1212
repository_policy.configure_branch(result)
1213
self.copy_content_into(result, revision_id=revision_id)
1214
result.set_parent(self.bzrdir.root_transport.base)
1219
def _synchronize_history(self, destination, revision_id):
1220
"""Synchronize last revision and revision history between branches.
1222
This version is most efficient when the destination is also a
1223
BzrBranch6, but works for BzrBranch5, as long as the destination's
1224
repository contains all the lefthand ancestors of the intended
1225
last_revision. If not, set_last_revision_info will fail.
1227
:param destination: The branch to copy the history into
1228
:param revision_id: The revision-id to truncate history at. May
1229
be None to copy complete history.
1231
source_revno, source_revision_id = self.last_revision_info()
1232
if revision_id is None:
1233
revno, revision_id = source_revno, source_revision_id
1235
graph = self.repository.get_graph()
1237
revno = graph.find_distance_to_null(revision_id,
1238
[(source_revision_id, source_revno)])
1239
except errors.GhostRevisionsHaveNoRevno:
1240
# Default to 1, if we can't find anything else
1242
destination.set_last_revision_info(revno, revision_id)
1245
def copy_content_into(self, destination, revision_id=None):
1246
"""Copy the content of self into destination.
1248
revision_id: if not None, the revision history in the new branch will
1249
be truncated to end with revision_id.
1251
self.update_references(destination)
1252
self._synchronize_history(destination, revision_id)
1254
parent = self.get_parent()
1255
except errors.InaccessibleParent, e:
1256
mutter('parent was not accessible to copy: %s', e)
1259
destination.set_parent(parent)
1260
if self._push_should_merge_tags():
1261
self.tags.merge_to(destination.tags)
1263
def update_references(self, target):
1264
if not getattr(self._format, 'supports_reference_locations', False):
1266
reference_dict = self._get_all_reference_info()
1267
if len(reference_dict) == 0:
1269
old_base = self.base
1270
new_base = target.base
1271
target_reference_dict = target._get_all_reference_info()
1272
for file_id, (tree_path, branch_location) in (
1273
reference_dict.items()):
1274
branch_location = urlutils.rebase_url(branch_location,
1276
target_reference_dict.setdefault(
1277
file_id, (tree_path, branch_location))
1278
target._set_all_reference_info(target_reference_dict)
1281
def check(self, refs):
1282
"""Check consistency of the branch.
1284
In particular this checks that revisions given in the revision-history
1285
do actually match up in the revision graph, and that they're all
1286
present in the repository.
1288
Callers will typically also want to check the repository.
1290
:param refs: Calculated refs for this branch as specified by
1291
branch._get_check_refs()
1292
:return: A BranchCheckResult.
1294
result = BranchCheckResult(self)
1295
last_revno, last_revision_id = self.last_revision_info()
1296
actual_revno = refs[('lefthand-distance', last_revision_id)]
1297
if actual_revno != last_revno:
1298
result.errors.append(errors.BzrCheckError(
1299
'revno does not match len(mainline) %s != %s' % (
1300
last_revno, actual_revno)))
1301
# TODO: We should probably also check that self.revision_history
1302
# matches the repository for older branch formats.
1303
# If looking for the code that cross-checks repository parents against
1304
# the iter_reverse_revision_history output, that is now a repository
1308
def _get_checkout_format(self):
1309
"""Return the most suitable metadir for a checkout of this branch.
1310
Weaves are used if this branch's repository uses weaves.
1312
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1313
from bzrlib.repofmt import weaverepo
1314
format = bzrdir.BzrDirMetaFormat1()
1315
format.repository_format = weaverepo.RepositoryFormat7()
1317
format = self.repository.bzrdir.checkout_metadir()
1318
format.set_branch_format(self._format)
1321
def create_clone_on_transport(self, to_transport, revision_id=None,
1322
stacked_on=None, create_prefix=False, use_existing_dir=False):
1323
"""Create a clone of this branch and its bzrdir.
1325
:param to_transport: The transport to clone onto.
1326
:param revision_id: The revision id to use as tip in the new branch.
1327
If None the tip is obtained from this branch.
1328
:param stacked_on: An optional URL to stack the clone on.
1329
:param create_prefix: Create any missing directories leading up to
1331
:param use_existing_dir: Use an existing directory if one exists.
1333
# XXX: Fix the bzrdir API to allow getting the branch back from the
1334
# clone call. Or something. 20090224 RBC/spiv.
1335
if revision_id is None:
1336
revision_id = self.last_revision()
1337
dir_to = self.bzrdir.clone_on_transport(to_transport,
1338
revision_id=revision_id, stacked_on=stacked_on,
1339
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1340
return dir_to.open_branch()
1342
def create_checkout(self, to_location, revision_id=None,
1343
lightweight=False, accelerator_tree=None,
1345
"""Create a checkout of a branch.
1347
:param to_location: The url to produce the checkout at
1348
:param revision_id: The revision to check out
1349
:param lightweight: If True, produce a lightweight checkout, otherwise,
1350
produce a bound branch (heavyweight checkout)
1351
:param accelerator_tree: A tree which can be used for retrieving file
1352
contents more quickly than the revision tree, i.e. a workingtree.
1353
The revision tree will be used for cases where accelerator_tree's
1354
content is different.
1355
:param hardlink: If true, hard-link files from accelerator_tree,
1357
:return: The tree of the created checkout
1359
t = transport.get_transport(to_location)
1362
format = self._get_checkout_format()
1363
checkout = format.initialize_on_transport(t)
1364
from_branch = BranchReferenceFormat().initialize(checkout,
1367
format = self._get_checkout_format()
1368
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1369
to_location, force_new_tree=False, format=format)
1370
checkout = checkout_branch.bzrdir
1371
checkout_branch.bind(self)
1372
# pull up to the specified revision_id to set the initial
1373
# branch tip correctly, and seed it with history.
1374
checkout_branch.pull(self, stop_revision=revision_id)
1376
tree = checkout.create_workingtree(revision_id,
1377
from_branch=from_branch,
1378
accelerator_tree=accelerator_tree,
1380
basis_tree = tree.basis_tree()
1381
basis_tree.lock_read()
1383
for path, file_id in basis_tree.iter_references():
1384
reference_parent = self.reference_parent(file_id, path)
1385
reference_parent.create_checkout(tree.abspath(path),
1386
basis_tree.get_reference_revision(file_id, path),
1393
def reconcile(self, thorough=True):
1394
"""Make sure the data stored in this branch is consistent."""
1395
from bzrlib.reconcile import BranchReconciler
1396
reconciler = BranchReconciler(self, thorough=thorough)
1397
reconciler.reconcile()
1400
def reference_parent(self, file_id, path, possible_transports=None):
1401
"""Return the parent branch for a tree-reference file_id
1402
:param file_id: The file_id of the tree reference
1403
:param path: The path of the file_id in the tree
1404
:return: A branch associated with the file_id
1406
# FIXME should provide multiple branches, based on config
1407
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1408
possible_transports=possible_transports)
1410
def supports_tags(self):
1411
return self._format.supports_tags()
1413
def automatic_tag_name(self, revision_id):
1414
"""Try to automatically find the tag name for a revision.
1416
:param revision_id: Revision id of the revision.
1417
:return: A tag name or None if no tag name could be determined.
1419
for hook in Branch.hooks['automatic_tag_name']:
1420
ret = hook(self, revision_id)
1425
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1427
"""Ensure that revision_b is a descendant of revision_a.
1429
This is a helper function for update_revisions.
1431
:raises: DivergedBranches if revision_b has diverged from revision_a.
1432
:returns: True if revision_b is a descendant of revision_a.
1434
relation = self._revision_relations(revision_a, revision_b, graph)
1435
if relation == 'b_descends_from_a':
1437
elif relation == 'diverged':
1438
raise errors.DivergedBranches(self, other_branch)
1439
elif relation == 'a_descends_from_b':
1442
raise AssertionError("invalid relation: %r" % (relation,))
1444
def _revision_relations(self, revision_a, revision_b, graph):
1445
"""Determine the relationship between two revisions.
1447
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1449
heads = graph.heads([revision_a, revision_b])
1450
if heads == set([revision_b]):
1451
return 'b_descends_from_a'
1452
elif heads == set([revision_a, revision_b]):
1453
# These branches have diverged
1455
elif heads == set([revision_a]):
1456
return 'a_descends_from_b'
1458
raise AssertionError("invalid heads: %r" % (heads,))
1461
class BranchFormat(object):
1462
"""An encapsulation of the initialization and open routines for a format.
1464
Formats provide three things:
1465
* An initialization routine,
1469
Formats are placed in an dict by their format string for reference
1470
during branch opening. Its not required that these be instances, they
1471
can be classes themselves with class methods - it simply depends on
1472
whether state is needed for a given format or not.
1474
Once a format is deprecated, just deprecate the initialize and open
1475
methods on the format class. Do not deprecate the object, as the
1476
object will be created every time regardless.
1479
_default_format = None
1480
"""The default format used for new branches."""
1483
"""The known formats."""
1485
can_set_append_revisions_only = True
1487
def __eq__(self, other):
1488
return self.__class__ is other.__class__
1490
def __ne__(self, other):
1491
return not (self == other)
1494
def find_format(klass, a_bzrdir, name=None):
1495
"""Return the format for the branch object in a_bzrdir."""
1497
transport = a_bzrdir.get_branch_transport(None, name=name)
1498
format_string = transport.get_bytes("format")
1499
return klass._formats[format_string]
1500
except errors.NoSuchFile:
1501
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1503
raise errors.UnknownFormatError(format=format_string, kind='branch')
1506
def get_default_format(klass):
1507
"""Return the current default format."""
1508
return klass._default_format
1510
def get_reference(self, a_bzrdir):
1511
"""Get the target reference of the branch in a_bzrdir.
1513
format probing must have been completed before calling
1514
this method - it is assumed that the format of the branch
1515
in a_bzrdir is correct.
1517
:param a_bzrdir: The bzrdir to get the branch data from.
1518
:return: None if the branch is not a reference branch.
1523
def set_reference(self, a_bzrdir, to_branch):
1524
"""Set the target reference of the branch in a_bzrdir.
1526
format probing must have been completed before calling
1527
this method - it is assumed that the format of the branch
1528
in a_bzrdir is correct.
1530
:param a_bzrdir: The bzrdir to set the branch reference for.
1531
:param to_branch: branch that the checkout is to reference
1533
raise NotImplementedError(self.set_reference)
1535
def get_format_string(self):
1536
"""Return the ASCII format string that identifies this format."""
1537
raise NotImplementedError(self.get_format_string)
1539
def get_format_description(self):
1540
"""Return the short format description for this format."""
1541
raise NotImplementedError(self.get_format_description)
1543
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1544
hooks = Branch.hooks['post_branch_init']
1547
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1551
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1552
lock_type='metadir', set_format=True):
1553
"""Initialize a branch in a bzrdir, with specified files
1555
:param a_bzrdir: The bzrdir to initialize the branch in
1556
:param utf8_files: The files to create as a list of
1557
(filename, content) tuples
1558
:param name: Name of colocated branch to create, if any
1559
:param set_format: If True, set the format with
1560
self.get_format_string. (BzrBranch4 has its format set
1562
:return: a branch in this format
1564
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1565
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1567
'metadir': ('lock', lockdir.LockDir),
1568
'branch4': ('branch-lock', lockable_files.TransportLock),
1570
lock_name, lock_class = lock_map[lock_type]
1571
control_files = lockable_files.LockableFiles(branch_transport,
1572
lock_name, lock_class)
1573
control_files.create_lock()
1575
control_files.lock_write()
1576
except errors.LockContention:
1577
if lock_type != 'branch4':
1583
utf8_files += [('format', self.get_format_string())]
1585
for (filename, content) in utf8_files:
1586
branch_transport.put_bytes(
1588
mode=a_bzrdir._get_file_mode())
1591
control_files.unlock()
1592
branch = self.open(a_bzrdir, name, _found=True)
1593
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1596
def initialize(self, a_bzrdir, name=None):
1597
"""Create a branch of this format in a_bzrdir.
1599
:param name: Name of the colocated branch to create.
1601
raise NotImplementedError(self.initialize)
1603
def is_supported(self):
1604
"""Is this format supported?
1606
Supported formats can be initialized and opened.
1607
Unsupported formats may not support initialization or committing or
1608
some other features depending on the reason for not being supported.
1612
def make_tags(self, branch):
1613
"""Create a tags object for branch.
1615
This method is on BranchFormat, because BranchFormats are reflected
1616
over the wire via network_name(), whereas full Branch instances require
1617
multiple VFS method calls to operate at all.
1619
The default implementation returns a disabled-tags instance.
1621
Note that it is normal for branch to be a RemoteBranch when using tags
1624
return DisabledTags(branch)
1626
def network_name(self):
1627
"""A simple byte string uniquely identifying this format for RPC calls.
1629
MetaDir branch formats use their disk format string to identify the
1630
repository over the wire. All in one formats such as bzr < 0.8, and
1631
foreign formats like svn/git and hg should use some marker which is
1632
unique and immutable.
1634
raise NotImplementedError(self.network_name)
1636
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1637
"""Return the branch object for a_bzrdir
1639
:param a_bzrdir: A BzrDir that contains a branch.
1640
:param name: Name of colocated branch to open
1641
:param _found: a private parameter, do not use it. It is used to
1642
indicate if format probing has already be done.
1643
:param ignore_fallbacks: when set, no fallback branches will be opened
1644
(if there are any). Default is to open fallbacks.
1646
raise NotImplementedError(self.open)
1649
def register_format(klass, format):
1650
"""Register a metadir format."""
1651
klass._formats[format.get_format_string()] = format
1652
# Metadir formats have a network name of their format string, and get
1653
# registered as class factories.
1654
network_format_registry.register(format.get_format_string(), format.__class__)
1657
def set_default_format(klass, format):
1658
klass._default_format = format
1660
def supports_set_append_revisions_only(self):
1661
"""True if this format supports set_append_revisions_only."""
1664
def supports_stacking(self):
1665
"""True if this format records a stacked-on branch."""
1669
def unregister_format(klass, format):
1670
del klass._formats[format.get_format_string()]
1673
return self.get_format_description().rstrip()
1675
def supports_tags(self):
1676
"""True if this format supports tags stored in the branch"""
1677
return False # by default
1680
class BranchHooks(Hooks):
1681
"""A dictionary mapping hook name to a list of callables for branch hooks.
1683
e.g. ['set_rh'] Is the list of items to be called when the
1684
set_revision_history function is invoked.
1688
"""Create the default hooks.
1690
These are all empty initially, because by default nothing should get
1693
Hooks.__init__(self)
1694
self.create_hook(HookPoint('set_rh',
1695
"Invoked whenever the revision history has been set via "
1696
"set_revision_history. The api signature is (branch, "
1697
"revision_history), and the branch will be write-locked. "
1698
"The set_rh hook can be expensive for bzr to trigger, a better "
1699
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1700
self.create_hook(HookPoint('open',
1701
"Called with the Branch object that has been opened after a "
1702
"branch is opened.", (1, 8), None))
1703
self.create_hook(HookPoint('post_push',
1704
"Called after a push operation completes. post_push is called "
1705
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1706
"bzr client.", (0, 15), None))
1707
self.create_hook(HookPoint('post_pull',
1708
"Called after a pull operation completes. post_pull is called "
1709
"with a bzrlib.branch.PullResult object and only runs in the "
1710
"bzr client.", (0, 15), None))
1711
self.create_hook(HookPoint('pre_commit',
1712
"Called after a commit is calculated but before it is is "
1713
"completed. pre_commit is called with (local, master, old_revno, "
1714
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1715
"). old_revid is NULL_REVISION for the first commit to a branch, "
1716
"tree_delta is a TreeDelta object describing changes from the "
1717
"basis revision. hooks MUST NOT modify this delta. "
1718
" future_tree is an in-memory tree obtained from "
1719
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1720
"tree.", (0,91), None))
1721
self.create_hook(HookPoint('post_commit',
1722
"Called in the bzr client after a commit has completed. "
1723
"post_commit is called with (local, master, old_revno, old_revid, "
1724
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1725
"commit to a branch.", (0, 15), None))
1726
self.create_hook(HookPoint('post_uncommit',
1727
"Called in the bzr client after an uncommit completes. "
1728
"post_uncommit is called with (local, master, old_revno, "
1729
"old_revid, new_revno, new_revid) where local is the local branch "
1730
"or None, master is the target branch, and an empty branch "
1731
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1732
self.create_hook(HookPoint('pre_change_branch_tip',
1733
"Called in bzr client and server before a change to the tip of a "
1734
"branch is made. pre_change_branch_tip is called with a "
1735
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1736
"commit, uncommit will all trigger this hook.", (1, 6), None))
1737
self.create_hook(HookPoint('post_change_branch_tip',
1738
"Called in bzr client and server after a change to the tip of a "
1739
"branch is made. post_change_branch_tip is called with a "
1740
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1741
"commit, uncommit will all trigger this hook.", (1, 4), None))
1742
self.create_hook(HookPoint('transform_fallback_location',
1743
"Called when a stacked branch is activating its fallback "
1744
"locations. transform_fallback_location is called with (branch, "
1745
"url), and should return a new url. Returning the same url "
1746
"allows it to be used as-is, returning a different one can be "
1747
"used to cause the branch to stack on a closer copy of that "
1748
"fallback_location. Note that the branch cannot have history "
1749
"accessing methods called on it during this hook because the "
1750
"fallback locations have not been activated. When there are "
1751
"multiple hooks installed for transform_fallback_location, "
1752
"all are called with the url returned from the previous hook."
1753
"The order is however undefined.", (1, 9), None))
1754
self.create_hook(HookPoint('automatic_tag_name',
1755
"Called to determine an automatic tag name for a revision."
1756
"automatic_tag_name is called with (branch, revision_id) and "
1757
"should return a tag name or None if no tag name could be "
1758
"determined. The first non-None tag name returned will be used.",
1760
self.create_hook(HookPoint('post_branch_init',
1761
"Called after new branch initialization completes. "
1762
"post_branch_init is called with a "
1763
"bzrlib.branch.BranchInitHookParams. "
1764
"Note that init, branch and checkout (both heavyweight and "
1765
"lightweight) will all trigger this hook.", (2, 2), None))
1766
self.create_hook(HookPoint('post_switch',
1767
"Called after a checkout switches branch. "
1768
"post_switch is called with a "
1769
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1773
# install the default hooks into the Branch class.
1774
Branch.hooks = BranchHooks()
1777
class ChangeBranchTipParams(object):
1778
"""Object holding parameters passed to *_change_branch_tip hooks.
1780
There are 5 fields that hooks may wish to access:
1782
:ivar branch: the branch being changed
1783
:ivar old_revno: revision number before the change
1784
:ivar new_revno: revision number after the change
1785
:ivar old_revid: revision id before the change
1786
:ivar new_revid: revision id after the change
1788
The revid fields are strings. The revno fields are integers.
1791
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1792
"""Create a group of ChangeBranchTip parameters.
1794
:param branch: The branch being changed.
1795
:param old_revno: Revision number before the change.
1796
:param new_revno: Revision number after the change.
1797
:param old_revid: Tip revision id before the change.
1798
:param new_revid: Tip revision id after the change.
1800
self.branch = branch
1801
self.old_revno = old_revno
1802
self.new_revno = new_revno
1803
self.old_revid = old_revid
1804
self.new_revid = new_revid
1806
def __eq__(self, other):
1807
return self.__dict__ == other.__dict__
1810
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1811
self.__class__.__name__, self.branch,
1812
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1815
class BranchInitHookParams(object):
1816
"""Object holding parameters passed to *_branch_init hooks.
1818
There are 4 fields that hooks may wish to access:
1820
:ivar format: the branch format
1821
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1822
:ivar name: name of colocated branch, if any (or None)
1823
:ivar branch: the branch created
1825
Note that for lightweight checkouts, the bzrdir and format fields refer to
1826
the checkout, hence they are different from the corresponding fields in
1827
branch, which refer to the original branch.
1830
def __init__(self, format, a_bzrdir, name, branch):
1831
"""Create a group of BranchInitHook parameters.
1833
:param format: the branch format
1834
:param a_bzrdir: the BzrDir where the branch will be/has been
1836
:param name: name of colocated branch, if any (or None)
1837
:param branch: the branch created
1839
Note that for lightweight checkouts, the bzrdir and format fields refer
1840
to the checkout, hence they are different from the corresponding fields
1841
in branch, which refer to the original branch.
1843
self.format = format
1844
self.bzrdir = a_bzrdir
1846
self.branch = branch
1848
def __eq__(self, other):
1849
return self.__dict__ == other.__dict__
1853
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1855
return "<%s of format:%s bzrdir:%s>" % (
1856
self.__class__.__name__, self.branch,
1857
self.format, self.bzrdir)
1860
class SwitchHookParams(object):
1861
"""Object holding parameters passed to *_switch hooks.
1863
There are 4 fields that hooks may wish to access:
1865
:ivar control_dir: BzrDir of the checkout to change
1866
:ivar to_branch: branch that the checkout is to reference
1867
:ivar force: skip the check for local commits in a heavy checkout
1868
:ivar revision_id: revision ID to switch to (or None)
1871
def __init__(self, control_dir, to_branch, force, revision_id):
1872
"""Create a group of SwitchHook parameters.
1874
:param control_dir: BzrDir of the checkout to change
1875
:param to_branch: branch that the checkout is to reference
1876
:param force: skip the check for local commits in a heavy checkout
1877
:param revision_id: revision ID to switch to (or None)
1879
self.control_dir = control_dir
1880
self.to_branch = to_branch
1882
self.revision_id = revision_id
1884
def __eq__(self, other):
1885
return self.__dict__ == other.__dict__
1888
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1889
self.control_dir, self.to_branch,
1893
class BzrBranchFormat4(BranchFormat):
1894
"""Bzr branch format 4.
1897
- a revision-history file.
1898
- a branch-lock lock file [ to be shared with the bzrdir ]
1901
def get_format_description(self):
1902
"""See BranchFormat.get_format_description()."""
1903
return "Branch format 4"
1905
def initialize(self, a_bzrdir, name=None):
1906
"""Create a branch of this format in a_bzrdir."""
1907
utf8_files = [('revision-history', ''),
1908
('branch-name', ''),
1910
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1911
lock_type='branch4', set_format=False)
1914
super(BzrBranchFormat4, self).__init__()
1915
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1917
def network_name(self):
1918
"""The network name for this format is the control dirs disk label."""
1919
return self._matchingbzrdir.get_format_string()
1921
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1922
"""See BranchFormat.open()."""
1924
# we are being called directly and must probe.
1925
raise NotImplementedError
1926
return BzrBranch(_format=self,
1927
_control_files=a_bzrdir._control_files,
1930
_repository=a_bzrdir.open_repository())
1933
return "Bazaar-NG branch format 4"
1936
class BranchFormatMetadir(BranchFormat):
1937
"""Common logic for meta-dir based branch formats."""
1939
def _branch_class(self):
1940
"""What class to instantiate on open calls."""
1941
raise NotImplementedError(self._branch_class)
1943
def network_name(self):
1944
"""A simple byte string uniquely identifying this format for RPC calls.
1946
Metadir branch formats use their format string.
1948
return self.get_format_string()
1950
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1951
"""See BranchFormat.open()."""
1953
format = BranchFormat.find_format(a_bzrdir, name=name)
1954
if format.__class__ != self.__class__:
1955
raise AssertionError("wrong format %r found for %r" %
1957
transport = a_bzrdir.get_branch_transport(None, name=name)
1959
control_files = lockable_files.LockableFiles(transport, 'lock',
1961
return self._branch_class()(_format=self,
1962
_control_files=control_files,
1965
_repository=a_bzrdir.find_repository(),
1966
ignore_fallbacks=ignore_fallbacks)
1967
except errors.NoSuchFile:
1968
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1971
super(BranchFormatMetadir, self).__init__()
1972
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1973
self._matchingbzrdir.set_branch_format(self)
1975
def supports_tags(self):
1979
class BzrBranchFormat5(BranchFormatMetadir):
1980
"""Bzr branch format 5.
1983
- a revision-history file.
1985
- a lock dir guarding the branch itself
1986
- all of this stored in a branch/ subdirectory
1987
- works with shared repositories.
1989
This format is new in bzr 0.8.
1992
def _branch_class(self):
1995
def get_format_string(self):
1996
"""See BranchFormat.get_format_string()."""
1997
return "Bazaar-NG branch format 5\n"
1999
def get_format_description(self):
2000
"""See BranchFormat.get_format_description()."""
2001
return "Branch format 5"
2003
def initialize(self, a_bzrdir, name=None):
2004
"""Create a branch of this format in a_bzrdir."""
2005
utf8_files = [('revision-history', ''),
2006
('branch-name', ''),
2008
return self._initialize_helper(a_bzrdir, utf8_files, name)
2010
def supports_tags(self):
2014
class BzrBranchFormat6(BranchFormatMetadir):
2015
"""Branch format with last-revision and tags.
2017
Unlike previous formats, this has no explicit revision history. Instead,
2018
this just stores the last-revision, and the left-hand history leading
2019
up to there is the history.
2021
This format was introduced in bzr 0.15
2022
and became the default in 0.91.
2025
def _branch_class(self):
2028
def get_format_string(self):
2029
"""See BranchFormat.get_format_string()."""
2030
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2032
def get_format_description(self):
2033
"""See BranchFormat.get_format_description()."""
2034
return "Branch format 6"
2036
def initialize(self, a_bzrdir, name=None):
2037
"""Create a branch of this format in a_bzrdir."""
2038
utf8_files = [('last-revision', '0 null:\n'),
2039
('branch.conf', ''),
2042
return self._initialize_helper(a_bzrdir, utf8_files, name)
2044
def make_tags(self, branch):
2045
"""See bzrlib.branch.BranchFormat.make_tags()."""
2046
return BasicTags(branch)
2048
def supports_set_append_revisions_only(self):
2052
class BzrBranchFormat8(BranchFormatMetadir):
2053
"""Metadir format supporting storing locations of subtree branches."""
2055
def _branch_class(self):
2058
def get_format_string(self):
2059
"""See BranchFormat.get_format_string()."""
2060
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2062
def get_format_description(self):
2063
"""See BranchFormat.get_format_description()."""
2064
return "Branch format 8"
2066
def initialize(self, a_bzrdir, name=None):
2067
"""Create a branch of this format in a_bzrdir."""
2068
utf8_files = [('last-revision', '0 null:\n'),
2069
('branch.conf', ''),
2073
return self._initialize_helper(a_bzrdir, utf8_files, name)
2076
super(BzrBranchFormat8, self).__init__()
2077
self._matchingbzrdir.repository_format = \
2078
RepositoryFormatKnitPack5RichRoot()
2080
def make_tags(self, branch):
2081
"""See bzrlib.branch.BranchFormat.make_tags()."""
2082
return BasicTags(branch)
2084
def supports_set_append_revisions_only(self):
2087
def supports_stacking(self):
2090
supports_reference_locations = True
2093
class BzrBranchFormat7(BzrBranchFormat8):
2094
"""Branch format with last-revision, tags, and a stacked location pointer.
2096
The stacked location pointer is passed down to the repository and requires
2097
a repository format with supports_external_lookups = True.
2099
This format was introduced in bzr 1.6.
2102
def initialize(self, a_bzrdir, name=None):
2103
"""Create a branch of this format in a_bzrdir."""
2104
utf8_files = [('last-revision', '0 null:\n'),
2105
('branch.conf', ''),
2108
return self._initialize_helper(a_bzrdir, utf8_files, name)
2110
def _branch_class(self):
2113
def get_format_string(self):
2114
"""See BranchFormat.get_format_string()."""
2115
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2117
def get_format_description(self):
2118
"""See BranchFormat.get_format_description()."""
2119
return "Branch format 7"
2121
def supports_set_append_revisions_only(self):
2124
supports_reference_locations = False
2127
class BranchReferenceFormat(BranchFormat):
2128
"""Bzr branch reference format.
2130
Branch references are used in implementing checkouts, they
2131
act as an alias to the real branch which is at some other url.
2138
def get_format_string(self):
2139
"""See BranchFormat.get_format_string()."""
2140
return "Bazaar-NG Branch Reference Format 1\n"
2142
def get_format_description(self):
2143
"""See BranchFormat.get_format_description()."""
2144
return "Checkout reference format 1"
2146
def get_reference(self, a_bzrdir):
2147
"""See BranchFormat.get_reference()."""
2148
transport = a_bzrdir.get_branch_transport(None)
2149
return transport.get_bytes('location')
2151
def set_reference(self, a_bzrdir, to_branch):
2152
"""See BranchFormat.set_reference()."""
2153
transport = a_bzrdir.get_branch_transport(None)
2154
location = transport.put_bytes('location', to_branch.base)
2156
def initialize(self, a_bzrdir, name=None, target_branch=None):
2157
"""Create a branch of this format in a_bzrdir."""
2158
if target_branch is None:
2159
# this format does not implement branch itself, thus the implicit
2160
# creation contract must see it as uninitializable
2161
raise errors.UninitializableFormat(self)
2162
mutter('creating branch reference in %s', a_bzrdir.user_url)
2163
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2164
branch_transport.put_bytes('location',
2165
target_branch.bzrdir.user_url)
2166
branch_transport.put_bytes('format', self.get_format_string())
2168
a_bzrdir, name, _found=True,
2169
possible_transports=[target_branch.bzrdir.root_transport])
2170
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2174
super(BranchReferenceFormat, self).__init__()
2175
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2176
self._matchingbzrdir.set_branch_format(self)
2178
def _make_reference_clone_function(format, a_branch):
2179
"""Create a clone() routine for a branch dynamically."""
2180
def clone(to_bzrdir, revision_id=None,
2181
repository_policy=None):
2182
"""See Branch.clone()."""
2183
return format.initialize(to_bzrdir, target_branch=a_branch)
2184
# cannot obey revision_id limits when cloning a reference ...
2185
# FIXME RBC 20060210 either nuke revision_id for clone, or
2186
# emit some sort of warning/error to the caller ?!
2189
def open(self, a_bzrdir, name=None, _found=False, location=None,
2190
possible_transports=None, ignore_fallbacks=False):
2191
"""Return the branch that the branch reference in a_bzrdir points at.
2193
:param a_bzrdir: A BzrDir that contains a branch.
2194
:param name: Name of colocated branch to open, if any
2195
:param _found: a private parameter, do not use it. It is used to
2196
indicate if format probing has already be done.
2197
:param ignore_fallbacks: when set, no fallback branches will be opened
2198
(if there are any). Default is to open fallbacks.
2199
:param location: The location of the referenced branch. If
2200
unspecified, this will be determined from the branch reference in
2202
:param possible_transports: An optional reusable transports list.
2205
format = BranchFormat.find_format(a_bzrdir, name=name)
2206
if format.__class__ != self.__class__:
2207
raise AssertionError("wrong format %r found for %r" %
2209
if location is None:
2210
location = self.get_reference(a_bzrdir)
2211
real_bzrdir = bzrdir.BzrDir.open(
2212
location, possible_transports=possible_transports)
2213
result = real_bzrdir.open_branch(name=name,
2214
ignore_fallbacks=ignore_fallbacks)
2215
# this changes the behaviour of result.clone to create a new reference
2216
# rather than a copy of the content of the branch.
2217
# I did not use a proxy object because that needs much more extensive
2218
# testing, and we are only changing one behaviour at the moment.
2219
# If we decide to alter more behaviours - i.e. the implicit nickname
2220
# then this should be refactored to introduce a tested proxy branch
2221
# and a subclass of that for use in overriding clone() and ....
2223
result.clone = self._make_reference_clone_function(result)
2227
network_format_registry = registry.FormatRegistry()
2228
"""Registry of formats indexed by their network name.
2230
The network name for a branch format is an identifier that can be used when
2231
referring to formats with smart server operations. See
2232
BranchFormat.network_name() for more detail.
2236
# formats which have no format string are not discoverable
2237
# and not independently creatable, so are not registered.
2238
__format5 = BzrBranchFormat5()
2239
__format6 = BzrBranchFormat6()
2240
__format7 = BzrBranchFormat7()
2241
__format8 = BzrBranchFormat8()
2242
BranchFormat.register_format(__format5)
2243
BranchFormat.register_format(BranchReferenceFormat())
2244
BranchFormat.register_format(__format6)
2245
BranchFormat.register_format(__format7)
2246
BranchFormat.register_format(__format8)
2247
BranchFormat.set_default_format(__format7)
2248
_legacy_formats = [BzrBranchFormat4(),
2250
network_format_registry.register(
2251
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2254
class BzrBranch(Branch, _RelockDebugMixin):
2255
"""A branch stored in the actual filesystem.
2257
Note that it's "local" in the context of the filesystem; it doesn't
2258
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2259
it's writable, and can be accessed via the normal filesystem API.
2261
:ivar _transport: Transport for file operations on this branch's
2262
control files, typically pointing to the .bzr/branch directory.
2263
:ivar repository: Repository for this branch.
2264
:ivar base: The url of the base directory for this branch; the one
2265
containing the .bzr directory.
2266
:ivar name: Optional colocated branch name as it exists in the control
2270
def __init__(self, _format=None,
2271
_control_files=None, a_bzrdir=None, name=None,
2272
_repository=None, ignore_fallbacks=False):
2273
"""Create new branch object at a particular location."""
2274
if a_bzrdir is None:
2275
raise ValueError('a_bzrdir must be supplied')
2277
self.bzrdir = a_bzrdir
2278
self._base = self.bzrdir.transport.clone('..').base
2280
# XXX: We should be able to just do
2281
# self.base = self.bzrdir.root_transport.base
2282
# but this does not quite work yet -- mbp 20080522
2283
self._format = _format
2284
if _control_files is None:
2285
raise ValueError('BzrBranch _control_files is None')
2286
self.control_files = _control_files
2287
self._transport = _control_files._transport
2288
self.repository = _repository
2289
Branch.__init__(self)
2292
if self.name is None:
2293
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2295
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2300
def _get_base(self):
2301
"""Returns the directory containing the control directory."""
2304
base = property(_get_base, doc="The URL for the root of this branch.")
2306
def _get_config(self):
2307
return TransportConfig(self._transport, 'branch.conf')
2309
def is_locked(self):
2310
return self.control_files.is_locked()
2312
def lock_write(self, token=None):
2313
if not self.is_locked():
2314
self._note_lock('w')
2315
# All-in-one needs to always unlock/lock.
2316
repo_control = getattr(self.repository, 'control_files', None)
2317
if self.control_files == repo_control or not self.is_locked():
2318
self.repository._warn_if_deprecated(self)
2319
self.repository.lock_write()
2324
return self.control_files.lock_write(token=token)
2327
self.repository.unlock()
2330
def lock_read(self):
2331
if not self.is_locked():
2332
self._note_lock('r')
2333
# All-in-one needs to always unlock/lock.
2334
repo_control = getattr(self.repository, 'control_files', None)
2335
if self.control_files == repo_control or not self.is_locked():
2336
self.repository._warn_if_deprecated(self)
2337
self.repository.lock_read()
2342
self.control_files.lock_read()
2345
self.repository.unlock()
2348
@only_raises(errors.LockNotHeld, errors.LockBroken)
2351
self.control_files.unlock()
2353
# All-in-one needs to always unlock/lock.
2354
repo_control = getattr(self.repository, 'control_files', None)
2355
if (self.control_files == repo_control or
2356
not self.control_files.is_locked()):
2357
self.repository.unlock()
2358
if not self.control_files.is_locked():
2359
# we just released the lock
2360
self._clear_cached_state()
2362
def peek_lock_mode(self):
2363
if self.control_files._lock_count == 0:
2366
return self.control_files._lock_mode
2368
def get_physical_lock_status(self):
2369
return self.control_files.get_physical_lock_status()
2372
def print_file(self, file, revision_id):
2373
"""See Branch.print_file."""
2374
return self.repository.print_file(file, revision_id)
2376
def _write_revision_history(self, history):
2377
"""Factored out of set_revision_history.
2379
This performs the actual writing to disk.
2380
It is intended to be called by BzrBranch5.set_revision_history."""
2381
self._transport.put_bytes(
2382
'revision-history', '\n'.join(history),
2383
mode=self.bzrdir._get_file_mode())
2386
def set_revision_history(self, rev_history):
2387
"""See Branch.set_revision_history."""
2388
if 'evil' in debug.debug_flags:
2389
mutter_callsite(3, "set_revision_history scales with history.")
2390
check_not_reserved_id = _mod_revision.check_not_reserved_id
2391
for rev_id in rev_history:
2392
check_not_reserved_id(rev_id)
2393
if Branch.hooks['post_change_branch_tip']:
2394
# Don't calculate the last_revision_info() if there are no hooks
2396
old_revno, old_revid = self.last_revision_info()
2397
if len(rev_history) == 0:
2398
revid = _mod_revision.NULL_REVISION
2400
revid = rev_history[-1]
2401
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2402
self._write_revision_history(rev_history)
2403
self._clear_cached_state()
2404
self._cache_revision_history(rev_history)
2405
for hook in Branch.hooks['set_rh']:
2406
hook(self, rev_history)
2407
if Branch.hooks['post_change_branch_tip']:
2408
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2410
def _synchronize_history(self, destination, revision_id):
2411
"""Synchronize last revision and revision history between branches.
2413
This version is most efficient when the destination is also a
2414
BzrBranch5, but works for BzrBranch6 as long as the revision
2415
history is the true lefthand parent history, and all of the revisions
2416
are in the destination's repository. If not, set_revision_history
2419
:param destination: The branch to copy the history into
2420
:param revision_id: The revision-id to truncate history at. May
2421
be None to copy complete history.
2423
if not isinstance(destination._format, BzrBranchFormat5):
2424
super(BzrBranch, self)._synchronize_history(
2425
destination, revision_id)
2427
if revision_id == _mod_revision.NULL_REVISION:
2430
new_history = self.revision_history()
2431
if revision_id is not None and new_history != []:
2433
new_history = new_history[:new_history.index(revision_id) + 1]
2435
rev = self.repository.get_revision(revision_id)
2436
new_history = rev.get_history(self.repository)[1:]
2437
destination.set_revision_history(new_history)
2440
def set_last_revision_info(self, revno, revision_id):
2441
"""Set the last revision of this branch.
2443
The caller is responsible for checking that the revno is correct
2444
for this revision id.
2446
It may be possible to set the branch last revision to an id not
2447
present in the repository. However, branches can also be
2448
configured to check constraints on history, in which case this may not
2451
revision_id = _mod_revision.ensure_null(revision_id)
2452
# this old format stores the full history, but this api doesn't
2453
# provide it, so we must generate, and might as well check it's
2455
history = self._lefthand_history(revision_id)
2456
if len(history) != revno:
2457
raise AssertionError('%d != %d' % (len(history), revno))
2458
self.set_revision_history(history)
2460
def _gen_revision_history(self):
2461
history = self._transport.get_bytes('revision-history').split('\n')
2462
if history[-1:] == ['']:
2463
# There shouldn't be a trailing newline, but just in case.
2468
def generate_revision_history(self, revision_id, last_rev=None,
2470
"""Create a new revision history that will finish with revision_id.
2472
:param revision_id: the new tip to use.
2473
:param last_rev: The previous last_revision. If not None, then this
2474
must be a ancestory of revision_id, or DivergedBranches is raised.
2475
:param other_branch: The other branch that DivergedBranches should
2476
raise with respect to.
2478
self.set_revision_history(self._lefthand_history(revision_id,
2479
last_rev, other_branch))
2481
def basis_tree(self):
2482
"""See Branch.basis_tree."""
2483
return self.repository.revision_tree(self.last_revision())
2485
def _get_parent_location(self):
2486
_locs = ['parent', 'pull', 'x-pull']
2489
return self._transport.get_bytes(l).strip('\n')
2490
except errors.NoSuchFile:
2494
def _basic_push(self, target, overwrite, stop_revision):
2495
"""Basic implementation of push without bound branches or hooks.
2497
Must be called with source read locked and target write locked.
2499
result = BranchPushResult()
2500
result.source_branch = self
2501
result.target_branch = target
2502
result.old_revno, result.old_revid = target.last_revision_info()
2503
self.update_references(target)
2504
if result.old_revid != self.last_revision():
2505
# We assume that during 'push' this repository is closer than
2507
graph = self.repository.get_graph(target.repository)
2508
target.update_revisions(self, stop_revision,
2509
overwrite=overwrite, graph=graph)
2510
if self._push_should_merge_tags():
2511
result.tag_conflicts = self.tags.merge_to(target.tags,
2513
result.new_revno, result.new_revid = target.last_revision_info()
2516
def get_stacked_on_url(self):
2517
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2519
def set_push_location(self, location):
2520
"""See Branch.set_push_location."""
2521
self.get_config().set_user_option(
2522
'push_location', location,
2523
store=_mod_config.STORE_LOCATION_NORECURSE)
2525
def _set_parent_location(self, url):
2527
self._transport.delete('parent')
2529
self._transport.put_bytes('parent', url + '\n',
2530
mode=self.bzrdir._get_file_mode())
2533
class BzrBranch5(BzrBranch):
2534
"""A format 5 branch. This supports new features over plain branches.
2536
It has support for a master_branch which is the data for bound branches.
2539
def get_bound_location(self):
2541
return self._transport.get_bytes('bound')[:-1]
2542
except errors.NoSuchFile:
2546
def get_master_branch(self, possible_transports=None):
2547
"""Return the branch we are bound to.
2549
:return: Either a Branch, or None
2551
This could memoise the branch, but if thats done
2552
it must be revalidated on each new lock.
2553
So for now we just don't memoise it.
2554
# RBC 20060304 review this decision.
2556
bound_loc = self.get_bound_location()
2560
return Branch.open(bound_loc,
2561
possible_transports=possible_transports)
2562
except (errors.NotBranchError, errors.ConnectionError), e:
2563
raise errors.BoundBranchConnectionFailure(
2567
def set_bound_location(self, location):
2568
"""Set the target where this branch is bound to.
2570
:param location: URL to the target branch
2573
self._transport.put_bytes('bound', location+'\n',
2574
mode=self.bzrdir._get_file_mode())
2577
self._transport.delete('bound')
2578
except errors.NoSuchFile:
2583
def bind(self, other):
2584
"""Bind this branch to the branch other.
2586
This does not push or pull data between the branches, though it does
2587
check for divergence to raise an error when the branches are not
2588
either the same, or one a prefix of the other. That behaviour may not
2589
be useful, so that check may be removed in future.
2591
:param other: The branch to bind to
2594
# TODO: jam 20051230 Consider checking if the target is bound
2595
# It is debatable whether you should be able to bind to
2596
# a branch which is itself bound.
2597
# Committing is obviously forbidden,
2598
# but binding itself may not be.
2599
# Since we *have* to check at commit time, we don't
2600
# *need* to check here
2602
# we want to raise diverged if:
2603
# last_rev is not in the other_last_rev history, AND
2604
# other_last_rev is not in our history, and do it without pulling
2606
self.set_bound_location(other.base)
2610
"""If bound, unbind"""
2611
return self.set_bound_location(None)
2614
def update(self, possible_transports=None):
2615
"""Synchronise this branch with the master branch if any.
2617
:return: None or the last_revision that was pivoted out during the
2620
master = self.get_master_branch(possible_transports)
2621
if master is not None:
2622
old_tip = _mod_revision.ensure_null(self.last_revision())
2623
self.pull(master, overwrite=True)
2624
if self.repository.get_graph().is_ancestor(old_tip,
2625
_mod_revision.ensure_null(self.last_revision())):
2631
class BzrBranch8(BzrBranch5):
2632
"""A branch that stores tree-reference locations."""
2634
def _open_hook(self):
2635
if self._ignore_fallbacks:
2638
url = self.get_stacked_on_url()
2639
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2640
errors.UnstackableBranchFormat):
2643
for hook in Branch.hooks['transform_fallback_location']:
2644
url = hook(self, url)
2646
hook_name = Branch.hooks.get_hook_name(hook)
2647
raise AssertionError(
2648
"'transform_fallback_location' hook %s returned "
2649
"None, not a URL." % hook_name)
2650
self._activate_fallback_location(url)
2652
def __init__(self, *args, **kwargs):
2653
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2654
super(BzrBranch8, self).__init__(*args, **kwargs)
2655
self._last_revision_info_cache = None
2656
self._reference_info = None
2658
def _clear_cached_state(self):
2659
super(BzrBranch8, self)._clear_cached_state()
2660
self._last_revision_info_cache = None
2661
self._reference_info = None
2663
def _last_revision_info(self):
2664
revision_string = self._transport.get_bytes('last-revision')
2665
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2666
revision_id = cache_utf8.get_cached_utf8(revision_id)
2668
return revno, revision_id
2670
def _write_last_revision_info(self, revno, revision_id):
2671
"""Simply write out the revision id, with no checks.
2673
Use set_last_revision_info to perform this safely.
2675
Does not update the revision_history cache.
2676
Intended to be called by set_last_revision_info and
2677
_write_revision_history.
2679
revision_id = _mod_revision.ensure_null(revision_id)
2680
out_string = '%d %s\n' % (revno, revision_id)
2681
self._transport.put_bytes('last-revision', out_string,
2682
mode=self.bzrdir._get_file_mode())
2685
def set_last_revision_info(self, revno, revision_id):
2686
revision_id = _mod_revision.ensure_null(revision_id)
2687
old_revno, old_revid = self.last_revision_info()
2688
if self._get_append_revisions_only():
2689
self._check_history_violation(revision_id)
2690
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2691
self._write_last_revision_info(revno, revision_id)
2692
self._clear_cached_state()
2693
self._last_revision_info_cache = revno, revision_id
2694
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2696
def _synchronize_history(self, destination, revision_id):
2697
"""Synchronize last revision and revision history between branches.
2699
:see: Branch._synchronize_history
2701
# XXX: The base Branch has a fast implementation of this method based
2702
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2703
# that uses set_revision_history. This class inherits from BzrBranch5,
2704
# but wants the fast implementation, so it calls
2705
# Branch._synchronize_history directly.
2706
Branch._synchronize_history(self, destination, revision_id)
2708
def _check_history_violation(self, revision_id):
2709
last_revision = _mod_revision.ensure_null(self.last_revision())
2710
if _mod_revision.is_null(last_revision):
2712
if last_revision not in self._lefthand_history(revision_id):
2713
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2715
def _gen_revision_history(self):
2716
"""Generate the revision history from last revision
2718
last_revno, last_revision = self.last_revision_info()
2719
self._extend_partial_history(stop_index=last_revno-1)
2720
return list(reversed(self._partial_revision_history_cache))
2722
def _write_revision_history(self, history):
2723
"""Factored out of set_revision_history.
2725
This performs the actual writing to disk, with format-specific checks.
2726
It is intended to be called by BzrBranch5.set_revision_history.
2728
if len(history) == 0:
2729
last_revision = 'null:'
2731
if history != self._lefthand_history(history[-1]):
2732
raise errors.NotLefthandHistory(history)
2733
last_revision = history[-1]
2734
if self._get_append_revisions_only():
2735
self._check_history_violation(last_revision)
2736
self._write_last_revision_info(len(history), last_revision)
2739
def _set_parent_location(self, url):
2740
"""Set the parent branch"""
2741
self._set_config_location('parent_location', url, make_relative=True)
2744
def _get_parent_location(self):
2745
"""Set the parent branch"""
2746
return self._get_config_location('parent_location')
2749
def _set_all_reference_info(self, info_dict):
2750
"""Replace all reference info stored in a branch.
2752
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2755
writer = rio.RioWriter(s)
2756
for key, (tree_path, branch_location) in info_dict.iteritems():
2757
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2758
branch_location=branch_location)
2759
writer.write_stanza(stanza)
2760
self._transport.put_bytes('references', s.getvalue())
2761
self._reference_info = info_dict
2764
def _get_all_reference_info(self):
2765
"""Return all the reference info stored in a branch.
2767
:return: A dict of {file_id: (tree_path, branch_location)}
2769
if self._reference_info is not None:
2770
return self._reference_info
2771
rio_file = self._transport.get('references')
2773
stanzas = rio.read_stanzas(rio_file)
2774
info_dict = dict((s['file_id'], (s['tree_path'],
2775
s['branch_location'])) for s in stanzas)
2778
self._reference_info = info_dict
2781
def set_reference_info(self, file_id, tree_path, branch_location):
2782
"""Set the branch location to use for a tree reference.
2784
:param file_id: The file-id of the tree reference.
2785
:param tree_path: The path of the tree reference in the tree.
2786
:param branch_location: The location of the branch to retrieve tree
2789
info_dict = self._get_all_reference_info()
2790
info_dict[file_id] = (tree_path, branch_location)
2791
if None in (tree_path, branch_location):
2792
if tree_path is not None:
2793
raise ValueError('tree_path must be None when branch_location'
2795
if branch_location is not None:
2796
raise ValueError('branch_location must be None when tree_path'
2798
del info_dict[file_id]
2799
self._set_all_reference_info(info_dict)
2801
def get_reference_info(self, file_id):
2802
"""Get the tree_path and branch_location for a tree reference.
2804
:return: a tuple of (tree_path, branch_location)
2806
return self._get_all_reference_info().get(file_id, (None, None))
2808
def reference_parent(self, file_id, path, possible_transports=None):
2809
"""Return the parent branch for a tree-reference file_id.
2811
:param file_id: The file_id of the tree reference
2812
:param path: The path of the file_id in the tree
2813
:return: A branch associated with the file_id
2815
branch_location = self.get_reference_info(file_id)[1]
2816
if branch_location is None:
2817
return Branch.reference_parent(self, file_id, path,
2818
possible_transports)
2819
branch_location = urlutils.join(self.user_url, branch_location)
2820
return Branch.open(branch_location,
2821
possible_transports=possible_transports)
2823
def set_push_location(self, location):
2824
"""See Branch.set_push_location."""
2825
self._set_config_location('push_location', location)
2827
def set_bound_location(self, location):
2828
"""See Branch.set_push_location."""
2830
config = self.get_config()
2831
if location is None:
2832
if config.get_user_option('bound') != 'True':
2835
config.set_user_option('bound', 'False', warn_masked=True)
2838
self._set_config_location('bound_location', location,
2840
config.set_user_option('bound', 'True', warn_masked=True)
2843
def _get_bound_location(self, bound):
2844
"""Return the bound location in the config file.
2846
Return None if the bound parameter does not match"""
2847
config = self.get_config()
2848
config_bound = (config.get_user_option('bound') == 'True')
2849
if config_bound != bound:
2851
return self._get_config_location('bound_location', config=config)
2853
def get_bound_location(self):
2854
"""See Branch.set_push_location."""
2855
return self._get_bound_location(True)
2857
def get_old_bound_location(self):
2858
"""See Branch.get_old_bound_location"""
2859
return self._get_bound_location(False)
2861
def get_stacked_on_url(self):
2862
# you can always ask for the URL; but you might not be able to use it
2863
# if the repo can't support stacking.
2864
## self._check_stackable_repo()
2865
stacked_url = self._get_config_location('stacked_on_location')
2866
if stacked_url is None:
2867
raise errors.NotStacked(self)
2870
def _get_append_revisions_only(self):
2871
return self.get_config(
2872
).get_user_option_as_bool('append_revisions_only')
2875
def generate_revision_history(self, revision_id, last_rev=None,
2877
"""See BzrBranch5.generate_revision_history"""
2878
history = self._lefthand_history(revision_id, last_rev, other_branch)
2879
revno = len(history)
2880
self.set_last_revision_info(revno, revision_id)
2883
def get_rev_id(self, revno, history=None):
2884
"""Find the revision id of the specified revno."""
2886
return _mod_revision.NULL_REVISION
2888
last_revno, last_revision_id = self.last_revision_info()
2889
if revno <= 0 or revno > last_revno:
2890
raise errors.NoSuchRevision(self, revno)
2892
if history is not None:
2893
return history[revno - 1]
2895
index = last_revno - revno
2896
if len(self._partial_revision_history_cache) <= index:
2897
self._extend_partial_history(stop_index=index)
2898
if len(self._partial_revision_history_cache) > index:
2899
return self._partial_revision_history_cache[index]
2901
raise errors.NoSuchRevision(self, revno)
2904
def revision_id_to_revno(self, revision_id):
2905
"""Given a revision id, return its revno"""
2906
if _mod_revision.is_null(revision_id):
2909
index = self._partial_revision_history_cache.index(revision_id)
2911
self._extend_partial_history(stop_revision=revision_id)
2912
index = len(self._partial_revision_history_cache) - 1
2913
if self._partial_revision_history_cache[index] != revision_id:
2914
raise errors.NoSuchRevision(self, revision_id)
2915
return self.revno() - index
2918
class BzrBranch7(BzrBranch8):
2919
"""A branch with support for a fallback repository."""
2921
def set_reference_info(self, file_id, tree_path, branch_location):
2922
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2924
def get_reference_info(self, file_id):
2925
Branch.get_reference_info(self, file_id)
2927
def reference_parent(self, file_id, path, possible_transports=None):
2928
return Branch.reference_parent(self, file_id, path,
2929
possible_transports)
2932
class BzrBranch6(BzrBranch7):
2933
"""See BzrBranchFormat6 for the capabilities of this branch.
2935
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2939
def get_stacked_on_url(self):
2940
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2943
######################################################################
2944
# results of operations
2947
class _Result(object):
2949
def _show_tag_conficts(self, to_file):
2950
if not getattr(self, 'tag_conflicts', None):
2952
to_file.write('Conflicting tags:\n')
2953
for name, value1, value2 in self.tag_conflicts:
2954
to_file.write(' %s\n' % (name, ))
2957
class PullResult(_Result):
2958
"""Result of a Branch.pull operation.
2960
:ivar old_revno: Revision number before pull.
2961
:ivar new_revno: Revision number after pull.
2962
:ivar old_revid: Tip revision id before pull.
2963
:ivar new_revid: Tip revision id after pull.
2964
:ivar source_branch: Source (local) branch object. (read locked)
2965
:ivar master_branch: Master branch of the target, or the target if no
2967
:ivar local_branch: target branch if there is a Master, else None
2968
:ivar target_branch: Target/destination branch object. (write locked)
2969
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2973
# DEPRECATED: pull used to return the change in revno
2974
return self.new_revno - self.old_revno
2976
def report(self, to_file):
2978
if self.old_revid == self.new_revid:
2979
to_file.write('No revisions to pull.\n')
2981
to_file.write('Now on revision %d.\n' % self.new_revno)
2982
self._show_tag_conficts(to_file)
2985
class BranchPushResult(_Result):
2986
"""Result of a Branch.push operation.
2988
:ivar old_revno: Revision number (eg 10) of the target before push.
2989
:ivar new_revno: Revision number (eg 12) of the target after push.
2990
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2992
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2994
:ivar source_branch: Source branch object that the push was from. This is
2995
read locked, and generally is a local (and thus low latency) branch.
2996
:ivar master_branch: If target is a bound branch, the master branch of
2997
target, or target itself. Always write locked.
2998
:ivar target_branch: The direct Branch where data is being sent (write
3000
:ivar local_branch: If the target is a bound branch this will be the
3001
target, otherwise it will be None.
3005
# DEPRECATED: push used to return the change in revno
3006
return self.new_revno - self.old_revno
3008
def report(self, to_file):
3009
"""Write a human-readable description of the result."""
3010
if self.old_revid == self.new_revid:
3011
note('No new revisions to push.')
3013
note('Pushed up to revision %d.' % self.new_revno)
3014
self._show_tag_conficts(to_file)
3017
class BranchCheckResult(object):
3018
"""Results of checking branch consistency.
3023
def __init__(self, branch):
3024
self.branch = branch
3027
def report_results(self, verbose):
3028
"""Report the check results via trace.note.
3030
:param verbose: Requests more detailed display of what was checked,
3033
note('checked branch %s format %s', self.branch.user_url,
3034
self.branch._format)
3035
for error in self.errors:
3036
note('found error:%s', error)
3039
class Converter5to6(object):
3040
"""Perform an in-place upgrade of format 5 to format 6"""
3042
def convert(self, branch):
3043
# Data for 5 and 6 can peacefully coexist.
3044
format = BzrBranchFormat6()
3045
new_branch = format.open(branch.bzrdir, _found=True)
3047
# Copy source data into target
3048
new_branch._write_last_revision_info(*branch.last_revision_info())
3049
new_branch.set_parent(branch.get_parent())
3050
new_branch.set_bound_location(branch.get_bound_location())
3051
new_branch.set_push_location(branch.get_push_location())
3053
# New branch has no tags by default
3054
new_branch.tags._set_tag_dict({})
3056
# Copying done; now update target format
3057
new_branch._transport.put_bytes('format',
3058
format.get_format_string(),
3059
mode=new_branch.bzrdir._get_file_mode())
3061
# Clean up old files
3062
new_branch._transport.delete('revision-history')
3064
branch.set_parent(None)
3065
except errors.NoSuchFile:
3067
branch.set_bound_location(None)
3070
class Converter6to7(object):
3071
"""Perform an in-place upgrade of format 6 to format 7"""
3073
def convert(self, branch):
3074
format = BzrBranchFormat7()
3075
branch._set_config_location('stacked_on_location', '')
3076
# update target format
3077
branch._transport.put_bytes('format', format.get_format_string())
3080
class Converter7to8(object):
3081
"""Perform an in-place upgrade of format 6 to format 7"""
3083
def convert(self, branch):
3084
format = BzrBranchFormat8()
3085
branch._transport.put_bytes('references', '')
3086
# update target format
3087
branch._transport.put_bytes('format', format.get_format_string())
3090
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3091
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3094
_run_with_write_locked_target will attempt to release the lock it acquires.
3096
If an exception is raised by callable, then that exception *will* be
3097
propagated, even if the unlock attempt raises its own error. Thus
3098
_run_with_write_locked_target should be preferred to simply doing::
3102
return callable(*args, **kwargs)
3107
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3108
# should share code?
3111
result = callable(*args, **kwargs)
3113
exc_info = sys.exc_info()
3117
raise exc_info[0], exc_info[1], exc_info[2]
3123
class InterBranch(InterObject):
3124
"""This class represents operations taking place between two branches.
3126
Its instances have methods like pull() and push() and contain
3127
references to the source and target repositories these operations
3128
can be carried out on.
3132
"""The available optimised InterBranch types."""
3135
def _get_branch_formats_to_test():
3136
"""Return a tuple with the Branch formats to use when testing."""
3137
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3139
def pull(self, overwrite=False, stop_revision=None,
3140
possible_transports=None, local=False):
3141
"""Mirror source into target branch.
3143
The target branch is considered to be 'local', having low latency.
3145
:returns: PullResult instance
3147
raise NotImplementedError(self.pull)
3149
def update_revisions(self, stop_revision=None, overwrite=False,
3151
"""Pull in new perfect-fit revisions.
3153
:param stop_revision: Updated until the given revision
3154
:param overwrite: Always set the branch pointer, rather than checking
3155
to see if it is a proper descendant.
3156
:param graph: A Graph object that can be used to query history
3157
information. This can be None.
3160
raise NotImplementedError(self.update_revisions)
3162
def push(self, overwrite=False, stop_revision=None,
3163
_override_hook_source_branch=None):
3164
"""Mirror the source branch into the target branch.
3166
The source branch is considered to be 'local', having low latency.
3168
raise NotImplementedError(self.push)
3171
class GenericInterBranch(InterBranch):
3172
"""InterBranch implementation that uses public Branch functions.
3176
def _get_branch_formats_to_test():
3177
return BranchFormat._default_format, BranchFormat._default_format
3179
def update_revisions(self, stop_revision=None, overwrite=False,
3181
"""See InterBranch.update_revisions()."""
3182
self.source.lock_read()
3184
other_revno, other_last_revision = self.source.last_revision_info()
3185
stop_revno = None # unknown
3186
if stop_revision is None:
3187
stop_revision = other_last_revision
3188
if _mod_revision.is_null(stop_revision):
3189
# if there are no commits, we're done.
3191
stop_revno = other_revno
3193
# what's the current last revision, before we fetch [and change it
3195
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3196
# we fetch here so that we don't process data twice in the common
3197
# case of having something to pull, and so that the check for
3198
# already merged can operate on the just fetched graph, which will
3199
# be cached in memory.
3200
self.target.fetch(self.source, stop_revision)
3201
# Check to see if one is an ancestor of the other
3204
graph = self.target.repository.get_graph()
3205
if self.target._check_if_descendant_or_diverged(
3206
stop_revision, last_rev, graph, self.source):
3207
# stop_revision is a descendant of last_rev, but we aren't
3208
# overwriting, so we're done.
3210
if stop_revno is None:
3212
graph = self.target.repository.get_graph()
3213
this_revno, this_last_revision = \
3214
self.target.last_revision_info()
3215
stop_revno = graph.find_distance_to_null(stop_revision,
3216
[(other_last_revision, other_revno),
3217
(this_last_revision, this_revno)])
3218
self.target.set_last_revision_info(stop_revno, stop_revision)
3220
self.source.unlock()
3222
def pull(self, overwrite=False, stop_revision=None,
3223
possible_transports=None, _hook_master=None, run_hooks=True,
3224
_override_hook_target=None, local=False):
3227
:param _hook_master: Private parameter - set the branch to
3228
be supplied as the master to pull hooks.
3229
:param run_hooks: Private parameter - if false, this branch
3230
is being called because it's the master of the primary branch,
3231
so it should not run its hooks.
3232
:param _override_hook_target: Private parameter - set the branch to be
3233
supplied as the target_branch to pull hooks.
3234
:param local: Only update the local branch, and not the bound branch.
3236
# This type of branch can't be bound.
3238
raise errors.LocalRequiresBoundBranch()
3239
result = PullResult()
3240
result.source_branch = self.source
3241
if _override_hook_target is None:
3242
result.target_branch = self.target
3244
result.target_branch = _override_hook_target
3245
self.source.lock_read()
3247
# We assume that during 'pull' the target repository is closer than
3249
self.source.update_references(self.target)
3250
graph = self.target.repository.get_graph(self.source.repository)
3251
# TODO: Branch formats should have a flag that indicates
3252
# that revno's are expensive, and pull() should honor that flag.
3254
result.old_revno, result.old_revid = \
3255
self.target.last_revision_info()
3256
self.target.update_revisions(self.source, stop_revision,
3257
overwrite=overwrite, graph=graph)
3258
# TODO: The old revid should be specified when merging tags,
3259
# so a tags implementation that versions tags can only
3260
# pull in the most recent changes. -- JRV20090506
3261
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3263
result.new_revno, result.new_revid = self.target.last_revision_info()
3265
result.master_branch = _hook_master
3266
result.local_branch = result.target_branch
3268
result.master_branch = result.target_branch
3269
result.local_branch = None
3271
for hook in Branch.hooks['post_pull']:
3274
self.source.unlock()
3277
def push(self, overwrite=False, stop_revision=None,
3278
_override_hook_source_branch=None):
3279
"""See InterBranch.push.
3281
This is the basic concrete implementation of push()
3283
:param _override_hook_source_branch: If specified, run
3284
the hooks passing this Branch as the source, rather than self.
3285
This is for use of RemoteBranch, where push is delegated to the
3286
underlying vfs-based Branch.
3288
# TODO: Public option to disable running hooks - should be trivial but
3290
self.source.lock_read()
3292
return _run_with_write_locked_target(
3293
self.target, self._push_with_bound_branches, overwrite,
3295
_override_hook_source_branch=_override_hook_source_branch)
3297
self.source.unlock()
3299
def _push_with_bound_branches(self, overwrite, stop_revision,
3300
_override_hook_source_branch=None):
3301
"""Push from source into target, and into target's master if any.
3304
if _override_hook_source_branch:
3305
result.source_branch = _override_hook_source_branch
3306
for hook in Branch.hooks['post_push']:
3309
bound_location = self.target.get_bound_location()
3310
if bound_location and self.target.base != bound_location:
3311
# there is a master branch.
3313
# XXX: Why the second check? Is it even supported for a branch to
3314
# be bound to itself? -- mbp 20070507
3315
master_branch = self.target.get_master_branch()
3316
master_branch.lock_write()
3318
# push into the master from the source branch.
3319
self.source._basic_push(master_branch, overwrite, stop_revision)
3320
# and push into the target branch from the source. Note that we
3321
# push from the source branch again, because its considered the
3322
# highest bandwidth repository.
3323
result = self.source._basic_push(self.target, overwrite,
3325
result.master_branch = master_branch
3326
result.local_branch = self.target
3330
master_branch.unlock()
3333
result = self.source._basic_push(self.target, overwrite,
3335
# TODO: Why set master_branch and local_branch if there's no
3336
# binding? Maybe cleaner to just leave them unset? -- mbp
3338
result.master_branch = self.target
3339
result.local_branch = None
3344
def is_compatible(self, source, target):
3345
# GenericBranch uses the public API, so always compatible
3349
class InterToBranch5(GenericInterBranch):
3352
def _get_branch_formats_to_test():
3353
return BranchFormat._default_format, BzrBranchFormat5()
3355
def pull(self, overwrite=False, stop_revision=None,
3356
possible_transports=None, run_hooks=True,
3357
_override_hook_target=None, local=False):
3358
"""Pull from source into self, updating my master if any.
3360
:param run_hooks: Private parameter - if false, this branch
3361
is being called because it's the master of the primary branch,
3362
so it should not run its hooks.
3364
bound_location = self.target.get_bound_location()
3365
if local and not bound_location:
3366
raise errors.LocalRequiresBoundBranch()
3367
master_branch = None
3368
if not local and bound_location and self.source.user_url != bound_location:
3369
# not pulling from master, so we need to update master.
3370
master_branch = self.target.get_master_branch(possible_transports)
3371
master_branch.lock_write()
3374
# pull from source into master.
3375
master_branch.pull(self.source, overwrite, stop_revision,
3377
return super(InterToBranch5, self).pull(overwrite,
3378
stop_revision, _hook_master=master_branch,
3379
run_hooks=run_hooks,
3380
_override_hook_target=_override_hook_target)
3383
master_branch.unlock()
3386
InterBranch.register_optimiser(GenericInterBranch)
3387
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
