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,
34
revision as _mod_revision,
42
from bzrlib.config import BranchConfig, TransportConfig
43
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
44
from bzrlib.tag import (
50
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
51
from bzrlib.hooks import HookPoint, Hooks
52
from bzrlib.inter import InterObject
53
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
54
from bzrlib import registry
55
from bzrlib.symbol_versioning import (
59
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
62
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
63
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
64
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
67
class Branch(bzrdir.ControlComponent):
68
"""Branch holding a history of revisions.
71
Base directory/url of the branch; using control_url and
72
control_transport is more standardized.
74
hooks: An instance of BranchHooks.
76
# this is really an instance variable - FIXME move it there
81
def control_transport(self):
82
return self._transport
85
def user_transport(self):
86
return self.bzrdir.user_transport
88
def __init__(self, *ignored, **ignored_too):
89
self.tags = self._format.make_tags(self)
90
self._revision_history_cache = None
91
self._revision_id_to_revno_cache = None
92
self._partial_revision_id_to_revno_cache = {}
93
self._partial_revision_history_cache = []
94
self._last_revision_info_cache = None
95
self._merge_sorted_revisions_cache = None
97
hooks = Branch.hooks['open']
101
def _open_hook(self):
102
"""Called by init to allow simpler extension of the base class."""
104
def _activate_fallback_location(self, url):
105
"""Activate the branch/repository from url as a fallback repository."""
106
repo = self._get_fallback_repository(url)
107
if repo.has_same_location(self.repository):
108
raise errors.UnstackableLocationError(self.user_url, url)
109
self.repository.add_fallback_repository(repo)
111
def break_lock(self):
112
"""Break a lock if one is present from another instance.
114
Uses the ui factory to ask for confirmation if the lock may be from
117
This will probe the repository for its lock as well.
119
self.control_files.break_lock()
120
self.repository.break_lock()
121
master = self.get_master_branch()
122
if master is not None:
125
def _check_stackable_repo(self):
126
if not self.repository._format.supports_external_lookups:
127
raise errors.UnstackableRepositoryFormat(self.repository._format,
128
self.repository.base)
130
def _extend_partial_history(self, stop_index=None, stop_revision=None):
131
"""Extend the partial history to include a given index
133
If a stop_index is supplied, stop when that index has been reached.
134
If a stop_revision is supplied, stop when that revision is
135
encountered. Otherwise, stop when the beginning of history is
138
:param stop_index: The index which should be present. When it is
139
present, history extension will stop.
140
:param stop_revision: The revision id which should be present. When
141
it is encountered, history extension will stop.
143
if len(self._partial_revision_history_cache) == 0:
144
self._partial_revision_history_cache = [self.last_revision()]
145
repository._iter_for_revno(
146
self.repository, self._partial_revision_history_cache,
147
stop_index=stop_index, stop_revision=stop_revision)
148
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
149
self._partial_revision_history_cache.pop()
151
def _get_check_refs(self):
152
"""Get the references needed for check().
156
revid = self.last_revision()
157
return [('revision-existence', revid), ('lefthand-distance', revid)]
160
def open(base, _unsupported=False, possible_transports=None):
161
"""Open the branch rooted at base.
163
For instance, if the branch is at URL/.bzr/branch,
164
Branch.open(URL) -> a Branch instance.
166
control = bzrdir.BzrDir.open(base, _unsupported,
167
possible_transports=possible_transports)
168
return control.open_branch(unsupported=_unsupported)
171
def open_from_transport(transport, name=None, _unsupported=False):
172
"""Open the branch rooted at transport"""
173
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
174
return control.open_branch(name=name, unsupported=_unsupported)
177
def open_containing(url, possible_transports=None):
178
"""Open an existing branch which contains url.
180
This probes for a branch at url, and searches upwards from there.
182
Basically we keep looking up until we find the control directory or
183
run into the root. If there isn't one, raises NotBranchError.
184
If there is one and it is either an unrecognised format or an unsupported
185
format, UnknownFormatError or UnsupportedFormatError are raised.
186
If there is one, it is returned, along with the unused portion of url.
188
control, relpath = bzrdir.BzrDir.open_containing(url,
190
return control.open_branch(), relpath
192
def _push_should_merge_tags(self):
193
"""Should _basic_push merge this branch's tags into the target?
195
The default implementation returns False if this branch has no tags,
196
and True the rest of the time. Subclasses may override this.
198
return self.supports_tags() and self.tags.get_tag_dict()
200
def get_config(self):
201
"""Get a bzrlib.config.BranchConfig for this Branch.
203
This can then be used to get and set configuration options for the
206
:return: A bzrlib.config.BranchConfig.
208
return BranchConfig(self)
210
def _get_config(self):
211
"""Get the concrete config for just the config in this branch.
213
This is not intended for client use; see Branch.get_config for the
218
:return: An object supporting get_option and set_option.
220
raise NotImplementedError(self._get_config)
222
def _get_fallback_repository(self, url):
223
"""Get the repository we fallback to at url."""
224
url = urlutils.join(self.base, url)
225
a_branch = Branch.open(url,
226
possible_transports=[self.bzrdir.root_transport])
227
return a_branch.repository
229
def _get_tags_bytes(self):
230
"""Get the bytes of a serialised tags dict.
232
Note that not all branches support tags, nor do all use the same tags
233
logic: this method is specific to BasicTags. Other tag implementations
234
may use the same method name and behave differently, safely, because
235
of the double-dispatch via
236
format.make_tags->tags_instance->get_tags_dict.
238
:return: The bytes of the tags file.
239
:seealso: Branch._set_tags_bytes.
241
return self._transport.get_bytes('tags')
243
def _get_nick(self, local=False, possible_transports=None):
244
config = self.get_config()
245
# explicit overrides master, but don't look for master if local is True
246
if not local and not config.has_explicit_nickname():
248
master = self.get_master_branch(possible_transports)
249
if master is not None:
250
# return the master branch value
252
except errors.BzrError, e:
253
# Silently fall back to local implicit nick if the master is
255
mutter("Could not connect to bound branch, "
256
"falling back to local nick.\n " + str(e))
257
return config.get_nickname()
259
def _set_nick(self, nick):
260
self.get_config().set_user_option('nickname', nick, warn_masked=True)
262
nick = property(_get_nick, _set_nick)
265
raise NotImplementedError(self.is_locked)
267
def _lefthand_history(self, revision_id, last_rev=None,
269
if 'evil' in debug.debug_flags:
270
mutter_callsite(4, "_lefthand_history scales with history.")
271
# stop_revision must be a descendant of last_revision
272
graph = self.repository.get_graph()
273
if last_rev is not None:
274
if not graph.is_ancestor(last_rev, revision_id):
275
# our previous tip is not merged into stop_revision
276
raise errors.DivergedBranches(self, other_branch)
277
# make a new revision history from the graph
278
parents_map = graph.get_parent_map([revision_id])
279
if revision_id not in parents_map:
280
raise errors.NoSuchRevision(self, revision_id)
281
current_rev_id = revision_id
283
check_not_reserved_id = _mod_revision.check_not_reserved_id
284
# Do not include ghosts or graph origin in revision_history
285
while (current_rev_id in parents_map and
286
len(parents_map[current_rev_id]) > 0):
287
check_not_reserved_id(current_rev_id)
288
new_history.append(current_rev_id)
289
current_rev_id = parents_map[current_rev_id][0]
290
parents_map = graph.get_parent_map([current_rev_id])
291
new_history.reverse()
294
def lock_write(self, token=None):
295
"""Lock the branch for write operations.
297
:param token: A token to permit reacquiring a previously held and
299
:return: A BranchWriteLockResult.
301
raise NotImplementedError(self.lock_write)
304
"""Lock the branch for read operations.
306
:return: A bzrlib.lock.LogicalLockResult.
308
raise NotImplementedError(self.lock_read)
311
raise NotImplementedError(self.unlock)
313
def peek_lock_mode(self):
314
"""Return lock mode for the Branch: 'r', 'w' or None"""
315
raise NotImplementedError(self.peek_lock_mode)
317
def get_physical_lock_status(self):
318
raise NotImplementedError(self.get_physical_lock_status)
321
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
322
"""Return the revision_id for a dotted revno.
324
:param revno: a tuple like (1,) or (1,1,2)
325
:param _cache_reverse: a private parameter enabling storage
326
of the reverse mapping in a top level cache. (This should
327
only be done in selective circumstances as we want to
328
avoid having the mapping cached multiple times.)
329
:return: the revision_id
330
:raises errors.NoSuchRevision: if the revno doesn't exist
332
rev_id = self._do_dotted_revno_to_revision_id(revno)
334
self._partial_revision_id_to_revno_cache[rev_id] = revno
337
def _do_dotted_revno_to_revision_id(self, revno):
338
"""Worker function for dotted_revno_to_revision_id.
340
Subclasses should override this if they wish to
341
provide a more efficient implementation.
344
return self.get_rev_id(revno[0])
345
revision_id_to_revno = self.get_revision_id_to_revno_map()
346
revision_ids = [revision_id for revision_id, this_revno
347
in revision_id_to_revno.iteritems()
348
if revno == this_revno]
349
if len(revision_ids) == 1:
350
return revision_ids[0]
352
revno_str = '.'.join(map(str, revno))
353
raise errors.NoSuchRevision(self, revno_str)
356
def revision_id_to_dotted_revno(self, revision_id):
357
"""Given a revision id, return its dotted revno.
359
:return: a tuple like (1,) or (400,1,3).
361
return self._do_revision_id_to_dotted_revno(revision_id)
363
def _do_revision_id_to_dotted_revno(self, revision_id):
364
"""Worker function for revision_id_to_revno."""
365
# Try the caches if they are loaded
366
result = self._partial_revision_id_to_revno_cache.get(revision_id)
367
if result is not None:
369
if self._revision_id_to_revno_cache:
370
result = self._revision_id_to_revno_cache.get(revision_id)
372
raise errors.NoSuchRevision(self, revision_id)
373
# Try the mainline as it's optimised
375
revno = self.revision_id_to_revno(revision_id)
377
except errors.NoSuchRevision:
378
# We need to load and use the full revno map after all
379
result = self.get_revision_id_to_revno_map().get(revision_id)
381
raise errors.NoSuchRevision(self, revision_id)
385
def get_revision_id_to_revno_map(self):
386
"""Return the revision_id => dotted revno map.
388
This will be regenerated on demand, but will be cached.
390
:return: A dictionary mapping revision_id => dotted revno.
391
This dictionary should not be modified by the caller.
393
if self._revision_id_to_revno_cache is not None:
394
mapping = self._revision_id_to_revno_cache
396
mapping = self._gen_revno_map()
397
self._cache_revision_id_to_revno(mapping)
398
# TODO: jam 20070417 Since this is being cached, should we be returning
400
# I would rather not, and instead just declare that users should not
401
# modify the return value.
404
def _gen_revno_map(self):
405
"""Create a new mapping from revision ids to dotted revnos.
407
Dotted revnos are generated based on the current tip in the revision
409
This is the worker function for get_revision_id_to_revno_map, which
410
just caches the return value.
412
:return: A dictionary mapping revision_id => dotted revno.
414
revision_id_to_revno = dict((rev_id, revno)
415
for rev_id, depth, revno, end_of_merge
416
in self.iter_merge_sorted_revisions())
417
return revision_id_to_revno
420
def iter_merge_sorted_revisions(self, start_revision_id=None,
421
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
422
"""Walk the revisions for a branch in merge sorted order.
424
Merge sorted order is the output from a merge-aware,
425
topological sort, i.e. all parents come before their
426
children going forward; the opposite for reverse.
428
:param start_revision_id: the revision_id to begin walking from.
429
If None, the branch tip is used.
430
:param stop_revision_id: the revision_id to terminate the walk
431
after. If None, the rest of history is included.
432
:param stop_rule: if stop_revision_id is not None, the precise rule
433
to use for termination:
434
* 'exclude' - leave the stop revision out of the result (default)
435
* 'include' - the stop revision is the last item in the result
436
* 'with-merges' - include the stop revision and all of its
437
merged revisions in the result
438
* 'with-merges-without-common-ancestry' - filter out revisions
439
that are in both ancestries
440
:param direction: either 'reverse' or 'forward':
441
* reverse means return the start_revision_id first, i.e.
442
start at the most recent revision and go backwards in history
443
* forward returns tuples in the opposite order to reverse.
444
Note in particular that forward does *not* do any intelligent
445
ordering w.r.t. depth as some clients of this API may like.
446
(If required, that ought to be done at higher layers.)
448
:return: an iterator over (revision_id, depth, revno, end_of_merge)
451
* revision_id: the unique id of the revision
452
* depth: How many levels of merging deep this node has been
454
* revno_sequence: This field provides a sequence of
455
revision numbers for all revisions. The format is:
456
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
457
branch that the revno is on. From left to right the REVNO numbers
458
are the sequence numbers within that branch of the revision.
459
* end_of_merge: When True the next node (earlier in history) is
460
part of a different merge.
462
# Note: depth and revno values are in the context of the branch so
463
# we need the full graph to get stable numbers, regardless of the
465
if self._merge_sorted_revisions_cache is None:
466
last_revision = self.last_revision()
467
known_graph = self.repository.get_known_graph_ancestry(
469
self._merge_sorted_revisions_cache = known_graph.merge_sort(
471
filtered = self._filter_merge_sorted_revisions(
472
self._merge_sorted_revisions_cache, start_revision_id,
473
stop_revision_id, stop_rule)
474
# Make sure we don't return revisions that are not part of the
475
# start_revision_id ancestry.
476
filtered = self._filter_start_non_ancestors(filtered)
477
if direction == 'reverse':
479
if direction == 'forward':
480
return reversed(list(filtered))
482
raise ValueError('invalid direction %r' % direction)
484
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
485
start_revision_id, stop_revision_id, stop_rule):
486
"""Iterate over an inclusive range of sorted revisions."""
487
rev_iter = iter(merge_sorted_revisions)
488
if start_revision_id is not None:
489
for node in rev_iter:
490
rev_id = node.key[-1]
491
if rev_id != start_revision_id:
494
# The decision to include the start or not
495
# depends on the stop_rule if a stop is provided
496
# so pop this node back into the iterator
497
rev_iter = chain(iter([node]), rev_iter)
499
if stop_revision_id is None:
501
for node in rev_iter:
502
rev_id = node.key[-1]
503
yield (rev_id, node.merge_depth, node.revno,
505
elif stop_rule == 'exclude':
506
for node in rev_iter:
507
rev_id = node.key[-1]
508
if rev_id == stop_revision_id:
510
yield (rev_id, node.merge_depth, node.revno,
512
elif stop_rule == 'include':
513
for node in rev_iter:
514
rev_id = node.key[-1]
515
yield (rev_id, node.merge_depth, node.revno,
517
if rev_id == stop_revision_id:
519
elif stop_rule == 'with-merges-without-common-ancestry':
520
# We want to exclude all revisions that are already part of the
521
# stop_revision_id ancestry.
522
graph = self.repository.get_graph()
523
ancestors = graph.find_unique_ancestors(start_revision_id,
525
for node in rev_iter:
526
rev_id = node.key[-1]
527
if rev_id not in ancestors:
529
yield (rev_id, node.merge_depth, node.revno,
531
elif stop_rule == 'with-merges':
532
stop_rev = self.repository.get_revision(stop_revision_id)
533
if stop_rev.parent_ids:
534
left_parent = stop_rev.parent_ids[0]
536
left_parent = _mod_revision.NULL_REVISION
537
# left_parent is the actual revision we want to stop logging at,
538
# since we want to show the merged revisions after the stop_rev too
539
reached_stop_revision_id = False
540
revision_id_whitelist = []
541
for node in rev_iter:
542
rev_id = node.key[-1]
543
if rev_id == left_parent:
544
# reached the left parent after the stop_revision
546
if (not reached_stop_revision_id or
547
rev_id in revision_id_whitelist):
548
yield (rev_id, node.merge_depth, node.revno,
550
if reached_stop_revision_id or rev_id == stop_revision_id:
551
# only do the merged revs of rev_id from now on
552
rev = self.repository.get_revision(rev_id)
554
reached_stop_revision_id = True
555
revision_id_whitelist.extend(rev.parent_ids)
557
raise ValueError('invalid stop_rule %r' % stop_rule)
559
def _filter_start_non_ancestors(self, rev_iter):
560
# If we started from a dotted revno, we want to consider it as a tip
561
# and don't want to yield revisions that are not part of its
562
# ancestry. Given the order guaranteed by the merge sort, we will see
563
# uninteresting descendants of the first parent of our tip before the
565
first = rev_iter.next()
566
(rev_id, merge_depth, revno, end_of_merge) = first
569
# We start at a mainline revision so by definition, all others
570
# revisions in rev_iter are ancestors
571
for node in rev_iter:
576
pmap = self.repository.get_parent_map([rev_id])
577
parents = pmap.get(rev_id, [])
579
whitelist.update(parents)
581
# If there is no parents, there is nothing of interest left
583
# FIXME: It's hard to test this scenario here as this code is never
584
# called in that case. -- vila 20100322
587
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
589
if rev_id in whitelist:
590
pmap = self.repository.get_parent_map([rev_id])
591
parents = pmap.get(rev_id, [])
592
whitelist.remove(rev_id)
593
whitelist.update(parents)
595
# We've reached the mainline, there is nothing left to
599
# A revision that is not part of the ancestry of our
602
yield (rev_id, merge_depth, revno, end_of_merge)
604
def leave_lock_in_place(self):
605
"""Tell this branch object not to release the physical lock when this
608
If lock_write doesn't return a token, then this method is not supported.
610
self.control_files.leave_in_place()
612
def dont_leave_lock_in_place(self):
613
"""Tell this branch object to release the physical lock when this
614
object is unlocked, even if it didn't originally acquire it.
616
If lock_write doesn't return a token, then this method is not supported.
618
self.control_files.dont_leave_in_place()
620
def bind(self, other):
621
"""Bind the local branch the other branch.
623
:param other: The branch to bind to
626
raise errors.UpgradeRequired(self.user_url)
628
def set_append_revisions_only(self, enabled):
629
if not self._format.supports_set_append_revisions_only():
630
raise errors.UpgradeRequired(self.user_url)
635
self.get_config().set_user_option('append_revisions_only', value,
638
def set_reference_info(self, file_id, tree_path, branch_location):
639
"""Set the branch location to use for a tree reference."""
640
raise errors.UnsupportedOperation(self.set_reference_info, self)
642
def get_reference_info(self, file_id):
643
"""Get the tree_path and branch_location for a tree reference."""
644
raise errors.UnsupportedOperation(self.get_reference_info, self)
647
def fetch(self, from_branch, last_revision=None, pb=None):
648
"""Copy revisions from from_branch into this branch.
650
:param from_branch: Where to copy from.
651
:param last_revision: What revision to stop at (None for at the end
653
:param pb: An optional progress bar to use.
656
if self.base == from_branch.base:
659
symbol_versioning.warn(
660
symbol_versioning.deprecated_in((1, 14, 0))
661
% "pb parameter to fetch()")
662
from_branch.lock_read()
664
if last_revision is None:
665
last_revision = from_branch.last_revision()
666
last_revision = _mod_revision.ensure_null(last_revision)
667
return self.repository.fetch(from_branch.repository,
668
revision_id=last_revision,
673
def get_bound_location(self):
674
"""Return the URL of the branch we are bound to.
676
Older format branches cannot bind, please be sure to use a metadir
681
def get_old_bound_location(self):
682
"""Return the URL of the branch we used to be bound to
684
raise errors.UpgradeRequired(self.user_url)
686
def get_commit_builder(self, parents, config=None, timestamp=None,
687
timezone=None, committer=None, revprops=None,
689
"""Obtain a CommitBuilder for this branch.
691
:param parents: Revision ids of the parents of the new revision.
692
:param config: Optional configuration to use.
693
:param timestamp: Optional timestamp recorded for commit.
694
:param timezone: Optional timezone for timestamp.
695
:param committer: Optional committer to set for commit.
696
:param revprops: Optional dictionary of revision properties.
697
:param revision_id: Optional revision id.
701
config = self.get_config()
703
return self.repository.get_commit_builder(self, parents, config,
704
timestamp, timezone, committer, revprops, revision_id)
706
def get_master_branch(self, possible_transports=None):
707
"""Return the branch we are bound to.
709
:return: Either a Branch, or None
713
def get_revision_delta(self, revno):
714
"""Return the delta for one revision.
716
The delta is relative to its mainline predecessor, or the
717
empty tree for revision 1.
719
rh = self.revision_history()
720
if not (1 <= revno <= len(rh)):
721
raise errors.InvalidRevisionNumber(revno)
722
return self.repository.get_revision_delta(rh[revno-1])
724
def get_stacked_on_url(self):
725
"""Get the URL this branch is stacked against.
727
:raises NotStacked: If the branch is not stacked.
728
:raises UnstackableBranchFormat: If the branch does not support
731
raise NotImplementedError(self.get_stacked_on_url)
733
def print_file(self, file, revision_id):
734
"""Print `file` to stdout."""
735
raise NotImplementedError(self.print_file)
737
def set_revision_history(self, rev_history):
738
raise NotImplementedError(self.set_revision_history)
741
def set_parent(self, url):
742
"""See Branch.set_parent."""
743
# TODO: Maybe delete old location files?
744
# URLs should never be unicode, even on the local fs,
745
# FIXUP this and get_parent in a future branch format bump:
746
# read and rewrite the file. RBC 20060125
748
if isinstance(url, unicode):
750
url = url.encode('ascii')
751
except UnicodeEncodeError:
752
raise errors.InvalidURL(url,
753
"Urls must be 7-bit ascii, "
754
"use bzrlib.urlutils.escape")
755
url = urlutils.relative_url(self.base, url)
756
self._set_parent_location(url)
759
def set_stacked_on_url(self, url):
760
"""Set the URL this branch is stacked against.
762
:raises UnstackableBranchFormat: If the branch does not support
764
:raises UnstackableRepositoryFormat: If the repository does not support
767
if not self._format.supports_stacking():
768
raise errors.UnstackableBranchFormat(self._format, self.user_url)
769
# XXX: Changing from one fallback repository to another does not check
770
# that all the data you need is present in the new fallback.
771
# Possibly it should.
772
self._check_stackable_repo()
775
old_url = self.get_stacked_on_url()
776
except (errors.NotStacked, errors.UnstackableBranchFormat,
777
errors.UnstackableRepositoryFormat):
781
self._activate_fallback_location(url)
782
# write this out after the repository is stacked to avoid setting a
783
# stacked config that doesn't work.
784
self._set_config_location('stacked_on_location', url)
787
"""Change a branch to be unstacked, copying data as needed.
789
Don't call this directly, use set_stacked_on_url(None).
791
pb = ui.ui_factory.nested_progress_bar()
793
pb.update("Unstacking")
794
# The basic approach here is to fetch the tip of the branch,
795
# including all available ghosts, from the existing stacked
796
# repository into a new repository object without the fallbacks.
798
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
799
# correct for CHKMap repostiories
800
old_repository = self.repository
801
if len(old_repository._fallback_repositories) != 1:
802
raise AssertionError("can't cope with fallback repositories "
803
"of %r" % (self.repository,))
804
# unlock it, including unlocking the fallback
805
old_repository.unlock()
806
old_repository.lock_read()
808
# Repositories don't offer an interface to remove fallback
809
# repositories today; take the conceptually simpler option and just
810
# reopen it. We reopen it starting from the URL so that we
811
# get a separate connection for RemoteRepositories and can
812
# stream from one of them to the other. This does mean doing
813
# separate SSH connection setup, but unstacking is not a
814
# common operation so it's tolerable.
815
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
816
new_repository = new_bzrdir.find_repository()
817
self.repository = new_repository
818
if self.repository._fallback_repositories:
819
raise AssertionError("didn't expect %r to have "
820
"fallback_repositories"
821
% (self.repository,))
822
# this is not paired with an unlock because it's just restoring
823
# the previous state; the lock's released when set_stacked_on_url
825
self.repository.lock_write()
826
# XXX: If you unstack a branch while it has a working tree
827
# with a pending merge, the pending-merged revisions will no
828
# longer be present. You can (probably) revert and remerge.
830
# XXX: This only fetches up to the tip of the repository; it
831
# doesn't bring across any tags. That's fairly consistent
832
# with how branch works, but perhaps not ideal.
833
self.repository.fetch(old_repository,
834
revision_id=self.last_revision(),
837
old_repository.unlock()
841
def _set_tags_bytes(self, bytes):
842
"""Mirror method for _get_tags_bytes.
844
:seealso: Branch._get_tags_bytes.
846
return _run_with_write_locked_target(self, self._transport.put_bytes,
849
def _cache_revision_history(self, rev_history):
850
"""Set the cached revision history to rev_history.
852
The revision_history method will use this cache to avoid regenerating
853
the revision history.
855
This API is semi-public; it only for use by subclasses, all other code
856
should consider it to be private.
858
self._revision_history_cache = rev_history
860
def _cache_revision_id_to_revno(self, revision_id_to_revno):
861
"""Set the cached revision_id => revno map to revision_id_to_revno.
863
This API is semi-public; it only for use by subclasses, all other code
864
should consider it to be private.
866
self._revision_id_to_revno_cache = revision_id_to_revno
868
def _clear_cached_state(self):
869
"""Clear any cached data on this branch, e.g. cached revision history.
871
This means the next call to revision_history will need to call
872
_gen_revision_history.
874
This API is semi-public; it only for use by subclasses, all other code
875
should consider it to be private.
877
self._revision_history_cache = None
878
self._revision_id_to_revno_cache = None
879
self._last_revision_info_cache = None
880
self._merge_sorted_revisions_cache = None
881
self._partial_revision_history_cache = []
882
self._partial_revision_id_to_revno_cache = {}
884
def _gen_revision_history(self):
885
"""Return sequence of revision hashes on to this branch.
887
Unlike revision_history, this method always regenerates or rereads the
888
revision history, i.e. it does not cache the result, so repeated calls
891
Concrete subclasses should override this instead of revision_history so
892
that subclasses do not need to deal with caching logic.
894
This API is semi-public; it only for use by subclasses, all other code
895
should consider it to be private.
897
raise NotImplementedError(self._gen_revision_history)
900
def revision_history(self):
901
"""Return sequence of revision ids on this branch.
903
This method will cache the revision history for as long as it is safe to
906
if 'evil' in debug.debug_flags:
907
mutter_callsite(3, "revision_history scales with history.")
908
if self._revision_history_cache is not None:
909
history = self._revision_history_cache
911
history = self._gen_revision_history()
912
self._cache_revision_history(history)
916
"""Return current revision number for this branch.
918
That is equivalent to the number of revisions committed to
921
return self.last_revision_info()[0]
924
"""Older format branches cannot bind or unbind."""
925
raise errors.UpgradeRequired(self.user_url)
927
def last_revision(self):
928
"""Return last revision id, or NULL_REVISION."""
929
return self.last_revision_info()[1]
932
def last_revision_info(self):
933
"""Return information about the last revision.
935
:return: A tuple (revno, revision_id).
937
if self._last_revision_info_cache is None:
938
self._last_revision_info_cache = self._last_revision_info()
939
return self._last_revision_info_cache
941
def _last_revision_info(self):
942
rh = self.revision_history()
945
return (revno, rh[-1])
947
return (0, _mod_revision.NULL_REVISION)
949
@deprecated_method(deprecated_in((1, 6, 0)))
950
def missing_revisions(self, other, stop_revision=None):
951
"""Return a list of new revisions that would perfectly fit.
953
If self and other have not diverged, return a list of the revisions
954
present in other, but missing from self.
956
self_history = self.revision_history()
957
self_len = len(self_history)
958
other_history = other.revision_history()
959
other_len = len(other_history)
960
common_index = min(self_len, other_len) -1
961
if common_index >= 0 and \
962
self_history[common_index] != other_history[common_index]:
963
raise errors.DivergedBranches(self, other)
965
if stop_revision is None:
966
stop_revision = other_len
968
if stop_revision > other_len:
969
raise errors.NoSuchRevision(self, stop_revision)
970
return other_history[self_len:stop_revision]
972
def update_revisions(self, other, stop_revision=None, overwrite=False,
974
"""Pull in new perfect-fit revisions.
976
:param other: Another Branch to pull from
977
:param stop_revision: Updated until the given revision
978
:param overwrite: Always set the branch pointer, rather than checking
979
to see if it is a proper descendant.
980
:param graph: A Graph object that can be used to query history
981
information. This can be None.
984
return InterBranch.get(other, self).update_revisions(stop_revision,
987
def import_last_revision_info(self, source_repo, revno, revid):
988
"""Set the last revision info, importing from another repo if necessary.
990
This is used by the bound branch code to upload a revision to
991
the master branch first before updating the tip of the local branch.
993
:param source_repo: Source repository to optionally fetch from
994
:param revno: Revision number of the new tip
995
:param revid: Revision id of the new tip
997
if not self.repository.has_same_location(source_repo):
998
self.repository.fetch(source_repo, revision_id=revid)
999
self.set_last_revision_info(revno, revid)
1001
def revision_id_to_revno(self, revision_id):
1002
"""Given a revision id, return its revno"""
1003
if _mod_revision.is_null(revision_id):
1005
history = self.revision_history()
1007
return history.index(revision_id) + 1
1009
raise errors.NoSuchRevision(self, revision_id)
1012
def get_rev_id(self, revno, history=None):
1013
"""Find the revision id of the specified revno."""
1015
return _mod_revision.NULL_REVISION
1016
last_revno, last_revid = self.last_revision_info()
1017
if revno == last_revno:
1019
if revno <= 0 or revno > last_revno:
1020
raise errors.NoSuchRevision(self, revno)
1021
distance_from_last = last_revno - revno
1022
if len(self._partial_revision_history_cache) <= distance_from_last:
1023
self._extend_partial_history(distance_from_last)
1024
return self._partial_revision_history_cache[distance_from_last]
1026
def pull(self, source, overwrite=False, stop_revision=None,
1027
possible_transports=None, *args, **kwargs):
1028
"""Mirror source into this branch.
1030
This branch is considered to be 'local', having low latency.
1032
:returns: PullResult instance
1034
return InterBranch.get(source, self).pull(overwrite=overwrite,
1035
stop_revision=stop_revision,
1036
possible_transports=possible_transports, *args, **kwargs)
1038
def push(self, target, overwrite=False, stop_revision=None, *args,
1040
"""Mirror this branch into target.
1042
This branch is considered to be 'local', having low latency.
1044
return InterBranch.get(self, target).push(overwrite, stop_revision,
1047
def lossy_push(self, target, stop_revision=None):
1048
"""Push deltas into another branch.
1050
:note: This does not, like push, retain the revision ids from
1051
the source branch and will, rather than adding bzr-specific
1052
metadata, push only those semantics of the revision that can be
1053
natively represented by this branch' VCS.
1055
:param target: Target branch
1056
:param stop_revision: Revision to push, defaults to last revision.
1057
:return: BranchPushResult with an extra member revidmap:
1058
A dictionary mapping revision ids from the target branch
1059
to new revision ids in the target branch, for each
1060
revision that was pushed.
1062
inter = InterBranch.get(self, target)
1063
lossy_push = getattr(inter, "lossy_push", None)
1064
if lossy_push is None:
1065
raise errors.LossyPushToSameVCS(self, target)
1066
return lossy_push(stop_revision)
1068
def basis_tree(self):
1069
"""Return `Tree` object for last revision."""
1070
return self.repository.revision_tree(self.last_revision())
1072
def get_parent(self):
1073
"""Return the parent location of the branch.
1075
This is the default location for pull/missing. The usual
1076
pattern is that the user can override it by specifying a
1079
parent = self._get_parent_location()
1082
# This is an old-format absolute path to a local branch
1083
# turn it into a url
1084
if parent.startswith('/'):
1085
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1087
return urlutils.join(self.base[:-1], parent)
1088
except errors.InvalidURLJoin, e:
1089
raise errors.InaccessibleParent(parent, self.user_url)
1091
def _get_parent_location(self):
1092
raise NotImplementedError(self._get_parent_location)
1094
def _set_config_location(self, name, url, config=None,
1095
make_relative=False):
1097
config = self.get_config()
1101
url = urlutils.relative_url(self.base, url)
1102
config.set_user_option(name, url, warn_masked=True)
1104
def _get_config_location(self, name, config=None):
1106
config = self.get_config()
1107
location = config.get_user_option(name)
1112
def get_child_submit_format(self):
1113
"""Return the preferred format of submissions to this branch."""
1114
return self.get_config().get_user_option("child_submit_format")
1116
def get_submit_branch(self):
1117
"""Return the submit location of the branch.
1119
This is the default location for bundle. The usual
1120
pattern is that the user can override it by specifying a
1123
return self.get_config().get_user_option('submit_branch')
1125
def set_submit_branch(self, location):
1126
"""Return the submit location of the branch.
1128
This is the default location for bundle. The usual
1129
pattern is that the user can override it by specifying a
1132
self.get_config().set_user_option('submit_branch', location,
1135
def get_public_branch(self):
1136
"""Return the public location of the branch.
1138
This is used by merge directives.
1140
return self._get_config_location('public_branch')
1142
def set_public_branch(self, location):
1143
"""Return the submit location of the branch.
1145
This is the default location for bundle. The usual
1146
pattern is that the user can override it by specifying a
1149
self._set_config_location('public_branch', location)
1151
def get_push_location(self):
1152
"""Return the None or the location to push this branch to."""
1153
push_loc = self.get_config().get_user_option('push_location')
1156
def set_push_location(self, location):
1157
"""Set a new push location for this branch."""
1158
raise NotImplementedError(self.set_push_location)
1160
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1161
"""Run the post_change_branch_tip hooks."""
1162
hooks = Branch.hooks['post_change_branch_tip']
1165
new_revno, new_revid = self.last_revision_info()
1166
params = ChangeBranchTipParams(
1167
self, old_revno, new_revno, old_revid, new_revid)
1171
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1172
"""Run the pre_change_branch_tip hooks."""
1173
hooks = Branch.hooks['pre_change_branch_tip']
1176
old_revno, old_revid = self.last_revision_info()
1177
params = ChangeBranchTipParams(
1178
self, old_revno, new_revno, old_revid, new_revid)
1184
"""Synchronise this branch with the master branch if any.
1186
:return: None or the last_revision pivoted out during the update.
1190
def check_revno(self, revno):
1192
Check whether a revno corresponds to any revision.
1193
Zero (the NULL revision) is considered valid.
1196
self.check_real_revno(revno)
1198
def check_real_revno(self, revno):
1200
Check whether a revno corresponds to a real revision.
1201
Zero (the NULL revision) is considered invalid
1203
if revno < 1 or revno > self.revno():
1204
raise errors.InvalidRevisionNumber(revno)
1207
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1208
"""Clone this branch into to_bzrdir preserving all semantic values.
1210
Most API users will want 'create_clone_on_transport', which creates a
1211
new bzrdir and branch on the fly.
1213
revision_id: if not None, the revision history in the new branch will
1214
be truncated to end with revision_id.
1216
result = to_bzrdir.create_branch()
1219
if repository_policy is not None:
1220
repository_policy.configure_branch(result)
1221
self.copy_content_into(result, revision_id=revision_id)
1227
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1228
"""Create a new line of development from the branch, into to_bzrdir.
1230
to_bzrdir controls the branch format.
1232
revision_id: if not None, the revision history in the new branch will
1233
be truncated to end with revision_id.
1235
if (repository_policy is not None and
1236
repository_policy.requires_stacking()):
1237
to_bzrdir._format.require_stacking(_skip_repo=True)
1238
result = to_bzrdir.create_branch()
1241
if repository_policy is not None:
1242
repository_policy.configure_branch(result)
1243
self.copy_content_into(result, revision_id=revision_id)
1244
result.set_parent(self.bzrdir.root_transport.base)
1249
def _synchronize_history(self, destination, revision_id):
1250
"""Synchronize last revision and revision history between branches.
1252
This version is most efficient when the destination is also a
1253
BzrBranch6, but works for BzrBranch5, as long as the destination's
1254
repository contains all the lefthand ancestors of the intended
1255
last_revision. If not, set_last_revision_info will fail.
1257
:param destination: The branch to copy the history into
1258
:param revision_id: The revision-id to truncate history at. May
1259
be None to copy complete history.
1261
source_revno, source_revision_id = self.last_revision_info()
1262
if revision_id is None:
1263
revno, revision_id = source_revno, source_revision_id
1265
graph = self.repository.get_graph()
1267
revno = graph.find_distance_to_null(revision_id,
1268
[(source_revision_id, source_revno)])
1269
except errors.GhostRevisionsHaveNoRevno:
1270
# Default to 1, if we can't find anything else
1272
destination.set_last_revision_info(revno, revision_id)
1274
def copy_content_into(self, destination, revision_id=None):
1275
"""Copy the content of self into destination.
1277
revision_id: if not None, the revision history in the new branch will
1278
be truncated to end with revision_id.
1280
return InterBranch.get(self, destination).copy_content_into(
1281
revision_id=revision_id)
1283
def update_references(self, target):
1284
if not getattr(self._format, 'supports_reference_locations', False):
1286
reference_dict = self._get_all_reference_info()
1287
if len(reference_dict) == 0:
1289
old_base = self.base
1290
new_base = target.base
1291
target_reference_dict = target._get_all_reference_info()
1292
for file_id, (tree_path, branch_location) in (
1293
reference_dict.items()):
1294
branch_location = urlutils.rebase_url(branch_location,
1296
target_reference_dict.setdefault(
1297
file_id, (tree_path, branch_location))
1298
target._set_all_reference_info(target_reference_dict)
1301
def check(self, refs):
1302
"""Check consistency of the branch.
1304
In particular this checks that revisions given in the revision-history
1305
do actually match up in the revision graph, and that they're all
1306
present in the repository.
1308
Callers will typically also want to check the repository.
1310
:param refs: Calculated refs for this branch as specified by
1311
branch._get_check_refs()
1312
:return: A BranchCheckResult.
1314
result = BranchCheckResult(self)
1315
last_revno, last_revision_id = self.last_revision_info()
1316
actual_revno = refs[('lefthand-distance', last_revision_id)]
1317
if actual_revno != last_revno:
1318
result.errors.append(errors.BzrCheckError(
1319
'revno does not match len(mainline) %s != %s' % (
1320
last_revno, actual_revno)))
1321
# TODO: We should probably also check that self.revision_history
1322
# matches the repository for older branch formats.
1323
# If looking for the code that cross-checks repository parents against
1324
# the iter_reverse_revision_history output, that is now a repository
1328
def _get_checkout_format(self):
1329
"""Return the most suitable metadir for a checkout of this branch.
1330
Weaves are used if this branch's repository uses weaves.
1332
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1333
from bzrlib.repofmt import weaverepo
1334
format = bzrdir.BzrDirMetaFormat1()
1335
format.repository_format = weaverepo.RepositoryFormat7()
1337
format = self.repository.bzrdir.checkout_metadir()
1338
format.set_branch_format(self._format)
1341
def create_clone_on_transport(self, to_transport, revision_id=None,
1342
stacked_on=None, create_prefix=False, use_existing_dir=False):
1343
"""Create a clone of this branch and its bzrdir.
1345
:param to_transport: The transport to clone onto.
1346
:param revision_id: The revision id to use as tip in the new branch.
1347
If None the tip is obtained from this branch.
1348
:param stacked_on: An optional URL to stack the clone on.
1349
:param create_prefix: Create any missing directories leading up to
1351
:param use_existing_dir: Use an existing directory if one exists.
1353
# XXX: Fix the bzrdir API to allow getting the branch back from the
1354
# clone call. Or something. 20090224 RBC/spiv.
1355
# XXX: Should this perhaps clone colocated branches as well,
1356
# rather than just the default branch? 20100319 JRV
1357
if revision_id is None:
1358
revision_id = self.last_revision()
1359
dir_to = self.bzrdir.clone_on_transport(to_transport,
1360
revision_id=revision_id, stacked_on=stacked_on,
1361
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1362
return dir_to.open_branch()
1364
def create_checkout(self, to_location, revision_id=None,
1365
lightweight=False, accelerator_tree=None,
1367
"""Create a checkout of a branch.
1369
:param to_location: The url to produce the checkout at
1370
:param revision_id: The revision to check out
1371
:param lightweight: If True, produce a lightweight checkout, otherwise,
1372
produce a bound branch (heavyweight checkout)
1373
:param accelerator_tree: A tree which can be used for retrieving file
1374
contents more quickly than the revision tree, i.e. a workingtree.
1375
The revision tree will be used for cases where accelerator_tree's
1376
content is different.
1377
:param hardlink: If true, hard-link files from accelerator_tree,
1379
:return: The tree of the created checkout
1381
t = transport.get_transport(to_location)
1384
format = self._get_checkout_format()
1385
checkout = format.initialize_on_transport(t)
1386
from_branch = BranchReferenceFormat().initialize(checkout,
1389
format = self._get_checkout_format()
1390
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1391
to_location, force_new_tree=False, format=format)
1392
checkout = checkout_branch.bzrdir
1393
checkout_branch.bind(self)
1394
# pull up to the specified revision_id to set the initial
1395
# branch tip correctly, and seed it with history.
1396
checkout_branch.pull(self, stop_revision=revision_id)
1398
tree = checkout.create_workingtree(revision_id,
1399
from_branch=from_branch,
1400
accelerator_tree=accelerator_tree,
1402
basis_tree = tree.basis_tree()
1403
basis_tree.lock_read()
1405
for path, file_id in basis_tree.iter_references():
1406
reference_parent = self.reference_parent(file_id, path)
1407
reference_parent.create_checkout(tree.abspath(path),
1408
basis_tree.get_reference_revision(file_id, path),
1415
def reconcile(self, thorough=True):
1416
"""Make sure the data stored in this branch is consistent."""
1417
from bzrlib.reconcile import BranchReconciler
1418
reconciler = BranchReconciler(self, thorough=thorough)
1419
reconciler.reconcile()
1422
def reference_parent(self, file_id, path, possible_transports=None):
1423
"""Return the parent branch for a tree-reference file_id
1424
:param file_id: The file_id of the tree reference
1425
:param path: The path of the file_id in the tree
1426
:return: A branch associated with the file_id
1428
# FIXME should provide multiple branches, based on config
1429
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1430
possible_transports=possible_transports)
1432
def supports_tags(self):
1433
return self._format.supports_tags()
1435
def automatic_tag_name(self, revision_id):
1436
"""Try to automatically find the tag name for a revision.
1438
:param revision_id: Revision id of the revision.
1439
:return: A tag name or None if no tag name could be determined.
1441
for hook in Branch.hooks['automatic_tag_name']:
1442
ret = hook(self, revision_id)
1447
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1449
"""Ensure that revision_b is a descendant of revision_a.
1451
This is a helper function for update_revisions.
1453
:raises: DivergedBranches if revision_b has diverged from revision_a.
1454
:returns: True if revision_b is a descendant of revision_a.
1456
relation = self._revision_relations(revision_a, revision_b, graph)
1457
if relation == 'b_descends_from_a':
1459
elif relation == 'diverged':
1460
raise errors.DivergedBranches(self, other_branch)
1461
elif relation == 'a_descends_from_b':
1464
raise AssertionError("invalid relation: %r" % (relation,))
1466
def _revision_relations(self, revision_a, revision_b, graph):
1467
"""Determine the relationship between two revisions.
1469
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1471
heads = graph.heads([revision_a, revision_b])
1472
if heads == set([revision_b]):
1473
return 'b_descends_from_a'
1474
elif heads == set([revision_a, revision_b]):
1475
# These branches have diverged
1477
elif heads == set([revision_a]):
1478
return 'a_descends_from_b'
1480
raise AssertionError("invalid heads: %r" % (heads,))
1483
class BranchFormat(object):
1484
"""An encapsulation of the initialization and open routines for a format.
1486
Formats provide three things:
1487
* An initialization routine,
1491
Formats are placed in an dict by their format string for reference
1492
during branch opening. Its not required that these be instances, they
1493
can be classes themselves with class methods - it simply depends on
1494
whether state is needed for a given format or not.
1496
Once a format is deprecated, just deprecate the initialize and open
1497
methods on the format class. Do not deprecate the object, as the
1498
object will be created every time regardless.
1501
_default_format = None
1502
"""The default format used for new branches."""
1505
"""The known formats."""
1507
can_set_append_revisions_only = True
1509
def __eq__(self, other):
1510
return self.__class__ is other.__class__
1512
def __ne__(self, other):
1513
return not (self == other)
1516
def find_format(klass, a_bzrdir, name=None):
1517
"""Return the format for the branch object in a_bzrdir."""
1519
transport = a_bzrdir.get_branch_transport(None, name=name)
1520
format_string = transport.get_bytes("format")
1521
format = klass._formats[format_string]
1522
if isinstance(format, MetaDirBranchFormatFactory):
1525
except errors.NoSuchFile:
1526
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1528
raise errors.UnknownFormatError(format=format_string, kind='branch')
1531
def get_default_format(klass):
1532
"""Return the current default format."""
1533
return klass._default_format
1536
def get_formats(klass):
1537
"""Get all the known formats.
1539
Warning: This triggers a load of all lazy registered formats: do not
1540
use except when that is desireed.
1543
for fmt in klass._formats.values():
1544
if isinstance(fmt, MetaDirBranchFormatFactory):
1549
def get_reference(self, a_bzrdir, name=None):
1550
"""Get the target reference of the branch in a_bzrdir.
1552
format probing must have been completed before calling
1553
this method - it is assumed that the format of the branch
1554
in a_bzrdir is correct.
1556
:param a_bzrdir: The bzrdir to get the branch data from.
1557
:param name: Name of the colocated branch to fetch
1558
:return: None if the branch is not a reference branch.
1563
def set_reference(self, a_bzrdir, name, to_branch):
1564
"""Set the target reference of the branch in a_bzrdir.
1566
format probing must have been completed before calling
1567
this method - it is assumed that the format of the branch
1568
in a_bzrdir is correct.
1570
:param a_bzrdir: The bzrdir to set the branch reference for.
1571
:param name: Name of colocated branch to set, None for default
1572
:param to_branch: branch that the checkout is to reference
1574
raise NotImplementedError(self.set_reference)
1576
def get_format_string(self):
1577
"""Return the ASCII format string that identifies this format."""
1578
raise NotImplementedError(self.get_format_string)
1580
def get_format_description(self):
1581
"""Return the short format description for this format."""
1582
raise NotImplementedError(self.get_format_description)
1584
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1585
hooks = Branch.hooks['post_branch_init']
1588
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1592
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1593
lock_type='metadir', set_format=True):
1594
"""Initialize a branch in a bzrdir, with specified files
1596
:param a_bzrdir: The bzrdir to initialize the branch in
1597
:param utf8_files: The files to create as a list of
1598
(filename, content) tuples
1599
:param name: Name of colocated branch to create, if any
1600
:param set_format: If True, set the format with
1601
self.get_format_string. (BzrBranch4 has its format set
1603
:return: a branch in this format
1605
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1606
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1608
'metadir': ('lock', lockdir.LockDir),
1609
'branch4': ('branch-lock', lockable_files.TransportLock),
1611
lock_name, lock_class = lock_map[lock_type]
1612
control_files = lockable_files.LockableFiles(branch_transport,
1613
lock_name, lock_class)
1614
control_files.create_lock()
1616
control_files.lock_write()
1617
except errors.LockContention:
1618
if lock_type != 'branch4':
1624
utf8_files += [('format', self.get_format_string())]
1626
for (filename, content) in utf8_files:
1627
branch_transport.put_bytes(
1629
mode=a_bzrdir._get_file_mode())
1632
control_files.unlock()
1633
branch = self.open(a_bzrdir, name, _found=True)
1634
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1637
def initialize(self, a_bzrdir, name=None):
1638
"""Create a branch of this format in a_bzrdir.
1640
:param name: Name of the colocated branch to create.
1642
raise NotImplementedError(self.initialize)
1644
def is_supported(self):
1645
"""Is this format supported?
1647
Supported formats can be initialized and opened.
1648
Unsupported formats may not support initialization or committing or
1649
some other features depending on the reason for not being supported.
1653
def make_tags(self, branch):
1654
"""Create a tags object for branch.
1656
This method is on BranchFormat, because BranchFormats are reflected
1657
over the wire via network_name(), whereas full Branch instances require
1658
multiple VFS method calls to operate at all.
1660
The default implementation returns a disabled-tags instance.
1662
Note that it is normal for branch to be a RemoteBranch when using tags
1665
return DisabledTags(branch)
1667
def network_name(self):
1668
"""A simple byte string uniquely identifying this format for RPC calls.
1670
MetaDir branch formats use their disk format string to identify the
1671
repository over the wire. All in one formats such as bzr < 0.8, and
1672
foreign formats like svn/git and hg should use some marker which is
1673
unique and immutable.
1675
raise NotImplementedError(self.network_name)
1677
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1678
"""Return the branch object for a_bzrdir
1680
:param a_bzrdir: A BzrDir that contains a branch.
1681
:param name: Name of colocated branch to open
1682
:param _found: a private parameter, do not use it. It is used to
1683
indicate if format probing has already be done.
1684
:param ignore_fallbacks: when set, no fallback branches will be opened
1685
(if there are any). Default is to open fallbacks.
1687
raise NotImplementedError(self.open)
1690
def register_format(klass, format):
1691
"""Register a metadir format.
1693
See MetaDirBranchFormatFactory for the ability to register a format
1694
without loading the code the format needs until it is actually used.
1696
klass._formats[format.get_format_string()] = format
1697
# Metadir formats have a network name of their format string, and get
1698
# registered as factories.
1699
if isinstance(format, MetaDirBranchFormatFactory):
1700
network_format_registry.register(format.get_format_string(), format)
1702
network_format_registry.register(format.get_format_string(),
1706
def set_default_format(klass, format):
1707
klass._default_format = format
1709
def supports_set_append_revisions_only(self):
1710
"""True if this format supports set_append_revisions_only."""
1713
def supports_stacking(self):
1714
"""True if this format records a stacked-on branch."""
1718
def unregister_format(klass, format):
1719
del klass._formats[format.get_format_string()]
1722
return self.get_format_description().rstrip()
1724
def supports_tags(self):
1725
"""True if this format supports tags stored in the branch"""
1726
return False # by default
1729
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1730
"""A factory for a BranchFormat object, permitting simple lazy registration.
1732
While none of the built in BranchFormats are lazy registered yet,
1733
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1734
use it, and the bzr-loom plugin uses it as well (see
1735
bzrlib.plugins.loom.formats).
1738
def __init__(self, format_string, module_name, member_name):
1739
"""Create a MetaDirBranchFormatFactory.
1741
:param format_string: The format string the format has.
1742
:param module_name: Module to load the format class from.
1743
:param member_name: Attribute name within the module for the format class.
1745
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1746
self._format_string = format_string
1748
def get_format_string(self):
1749
"""See BranchFormat.get_format_string."""
1750
return self._format_string
1753
"""Used for network_format_registry support."""
1754
return self.get_obj()()
1757
class BranchHooks(Hooks):
1758
"""A dictionary mapping hook name to a list of callables for branch hooks.
1760
e.g. ['set_rh'] Is the list of items to be called when the
1761
set_revision_history function is invoked.
1765
"""Create the default hooks.
1767
These are all empty initially, because by default nothing should get
1770
Hooks.__init__(self)
1771
self.create_hook(HookPoint('set_rh',
1772
"Invoked whenever the revision history has been set via "
1773
"set_revision_history. The api signature is (branch, "
1774
"revision_history), and the branch will be write-locked. "
1775
"The set_rh hook can be expensive for bzr to trigger, a better "
1776
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1777
self.create_hook(HookPoint('open',
1778
"Called with the Branch object that has been opened after a "
1779
"branch is opened.", (1, 8), None))
1780
self.create_hook(HookPoint('post_push',
1781
"Called after a push operation completes. post_push is called "
1782
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1783
"bzr client.", (0, 15), None))
1784
self.create_hook(HookPoint('post_pull',
1785
"Called after a pull operation completes. post_pull is called "
1786
"with a bzrlib.branch.PullResult object and only runs in the "
1787
"bzr client.", (0, 15), None))
1788
self.create_hook(HookPoint('pre_commit',
1789
"Called after a commit is calculated but before it is is "
1790
"completed. pre_commit is called with (local, master, old_revno, "
1791
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1792
"). old_revid is NULL_REVISION for the first commit to a branch, "
1793
"tree_delta is a TreeDelta object describing changes from the "
1794
"basis revision. hooks MUST NOT modify this delta. "
1795
" future_tree is an in-memory tree obtained from "
1796
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1797
"tree.", (0,91), None))
1798
self.create_hook(HookPoint('post_commit',
1799
"Called in the bzr client after a commit has completed. "
1800
"post_commit is called with (local, master, old_revno, old_revid, "
1801
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1802
"commit to a branch.", (0, 15), None))
1803
self.create_hook(HookPoint('post_uncommit',
1804
"Called in the bzr client after an uncommit completes. "
1805
"post_uncommit is called with (local, master, old_revno, "
1806
"old_revid, new_revno, new_revid) where local is the local branch "
1807
"or None, master is the target branch, and an empty branch "
1808
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1809
self.create_hook(HookPoint('pre_change_branch_tip',
1810
"Called in bzr client and server before a change to the tip of a "
1811
"branch is made. pre_change_branch_tip is called with a "
1812
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1813
"commit, uncommit will all trigger this hook.", (1, 6), None))
1814
self.create_hook(HookPoint('post_change_branch_tip',
1815
"Called in bzr client and server after a change to the tip of a "
1816
"branch is made. post_change_branch_tip is called with a "
1817
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1818
"commit, uncommit will all trigger this hook.", (1, 4), None))
1819
self.create_hook(HookPoint('transform_fallback_location',
1820
"Called when a stacked branch is activating its fallback "
1821
"locations. transform_fallback_location is called with (branch, "
1822
"url), and should return a new url. Returning the same url "
1823
"allows it to be used as-is, returning a different one can be "
1824
"used to cause the branch to stack on a closer copy of that "
1825
"fallback_location. Note that the branch cannot have history "
1826
"accessing methods called on it during this hook because the "
1827
"fallback locations have not been activated. When there are "
1828
"multiple hooks installed for transform_fallback_location, "
1829
"all are called with the url returned from the previous hook."
1830
"The order is however undefined.", (1, 9), None))
1831
self.create_hook(HookPoint('automatic_tag_name',
1832
"Called to determine an automatic tag name for a revision."
1833
"automatic_tag_name is called with (branch, revision_id) and "
1834
"should return a tag name or None if no tag name could be "
1835
"determined. The first non-None tag name returned will be used.",
1837
self.create_hook(HookPoint('post_branch_init',
1838
"Called after new branch initialization completes. "
1839
"post_branch_init is called with a "
1840
"bzrlib.branch.BranchInitHookParams. "
1841
"Note that init, branch and checkout (both heavyweight and "
1842
"lightweight) will all trigger this hook.", (2, 2), None))
1843
self.create_hook(HookPoint('post_switch',
1844
"Called after a checkout switches branch. "
1845
"post_switch is called with a "
1846
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1850
# install the default hooks into the Branch class.
1851
Branch.hooks = BranchHooks()
1854
class ChangeBranchTipParams(object):
1855
"""Object holding parameters passed to *_change_branch_tip hooks.
1857
There are 5 fields that hooks may wish to access:
1859
:ivar branch: the branch being changed
1860
:ivar old_revno: revision number before the change
1861
:ivar new_revno: revision number after the change
1862
:ivar old_revid: revision id before the change
1863
:ivar new_revid: revision id after the change
1865
The revid fields are strings. The revno fields are integers.
1868
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1869
"""Create a group of ChangeBranchTip parameters.
1871
:param branch: The branch being changed.
1872
:param old_revno: Revision number before the change.
1873
:param new_revno: Revision number after the change.
1874
:param old_revid: Tip revision id before the change.
1875
:param new_revid: Tip revision id after the change.
1877
self.branch = branch
1878
self.old_revno = old_revno
1879
self.new_revno = new_revno
1880
self.old_revid = old_revid
1881
self.new_revid = new_revid
1883
def __eq__(self, other):
1884
return self.__dict__ == other.__dict__
1887
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1888
self.__class__.__name__, self.branch,
1889
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1892
class BranchInitHookParams(object):
1893
"""Object holding parameters passed to *_branch_init hooks.
1895
There are 4 fields that hooks may wish to access:
1897
:ivar format: the branch format
1898
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1899
:ivar name: name of colocated branch, if any (or None)
1900
:ivar branch: the branch created
1902
Note that for lightweight checkouts, the bzrdir and format fields refer to
1903
the checkout, hence they are different from the corresponding fields in
1904
branch, which refer to the original branch.
1907
def __init__(self, format, a_bzrdir, name, branch):
1908
"""Create a group of BranchInitHook parameters.
1910
:param format: the branch format
1911
:param a_bzrdir: the BzrDir where the branch will be/has been
1913
:param name: name of colocated branch, if any (or None)
1914
:param branch: the branch created
1916
Note that for lightweight checkouts, the bzrdir and format fields refer
1917
to the checkout, hence they are different from the corresponding fields
1918
in branch, which refer to the original branch.
1920
self.format = format
1921
self.bzrdir = a_bzrdir
1923
self.branch = branch
1925
def __eq__(self, other):
1926
return self.__dict__ == other.__dict__
1930
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1932
return "<%s of format:%s bzrdir:%s>" % (
1933
self.__class__.__name__, self.branch,
1934
self.format, self.bzrdir)
1937
class SwitchHookParams(object):
1938
"""Object holding parameters passed to *_switch hooks.
1940
There are 4 fields that hooks may wish to access:
1942
:ivar control_dir: BzrDir of the checkout to change
1943
:ivar to_branch: branch that the checkout is to reference
1944
:ivar force: skip the check for local commits in a heavy checkout
1945
:ivar revision_id: revision ID to switch to (or None)
1948
def __init__(self, control_dir, to_branch, force, revision_id):
1949
"""Create a group of SwitchHook parameters.
1951
:param control_dir: BzrDir of the checkout to change
1952
:param to_branch: branch that the checkout is to reference
1953
:param force: skip the check for local commits in a heavy checkout
1954
:param revision_id: revision ID to switch to (or None)
1956
self.control_dir = control_dir
1957
self.to_branch = to_branch
1959
self.revision_id = revision_id
1961
def __eq__(self, other):
1962
return self.__dict__ == other.__dict__
1965
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1966
self.control_dir, self.to_branch,
1970
class BzrBranchFormat4(BranchFormat):
1971
"""Bzr branch format 4.
1974
- a revision-history file.
1975
- a branch-lock lock file [ to be shared with the bzrdir ]
1978
def get_format_description(self):
1979
"""See BranchFormat.get_format_description()."""
1980
return "Branch format 4"
1982
def initialize(self, a_bzrdir, name=None):
1983
"""Create a branch of this format in a_bzrdir."""
1984
utf8_files = [('revision-history', ''),
1985
('branch-name', ''),
1987
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1988
lock_type='branch4', set_format=False)
1991
super(BzrBranchFormat4, self).__init__()
1992
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1994
def network_name(self):
1995
"""The network name for this format is the control dirs disk label."""
1996
return self._matchingbzrdir.get_format_string()
1998
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1999
"""See BranchFormat.open()."""
2001
# we are being called directly and must probe.
2002
raise NotImplementedError
2003
return BzrBranch(_format=self,
2004
_control_files=a_bzrdir._control_files,
2007
_repository=a_bzrdir.open_repository())
2010
return "Bazaar-NG branch format 4"
2013
class BranchFormatMetadir(BranchFormat):
2014
"""Common logic for meta-dir based branch formats."""
2016
def _branch_class(self):
2017
"""What class to instantiate on open calls."""
2018
raise NotImplementedError(self._branch_class)
2020
def network_name(self):
2021
"""A simple byte string uniquely identifying this format for RPC calls.
2023
Metadir branch formats use their format string.
2025
return self.get_format_string()
2027
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2028
"""See BranchFormat.open()."""
2030
format = BranchFormat.find_format(a_bzrdir, name=name)
2031
if format.__class__ != self.__class__:
2032
raise AssertionError("wrong format %r found for %r" %
2034
transport = a_bzrdir.get_branch_transport(None, name=name)
2036
control_files = lockable_files.LockableFiles(transport, 'lock',
2038
return self._branch_class()(_format=self,
2039
_control_files=control_files,
2042
_repository=a_bzrdir.find_repository(),
2043
ignore_fallbacks=ignore_fallbacks)
2044
except errors.NoSuchFile:
2045
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2048
super(BranchFormatMetadir, self).__init__()
2049
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2050
self._matchingbzrdir.set_branch_format(self)
2052
def supports_tags(self):
2056
class BzrBranchFormat5(BranchFormatMetadir):
2057
"""Bzr branch format 5.
2060
- a revision-history file.
2062
- a lock dir guarding the branch itself
2063
- all of this stored in a branch/ subdirectory
2064
- works with shared repositories.
2066
This format is new in bzr 0.8.
2069
def _branch_class(self):
2072
def get_format_string(self):
2073
"""See BranchFormat.get_format_string()."""
2074
return "Bazaar-NG branch format 5\n"
2076
def get_format_description(self):
2077
"""See BranchFormat.get_format_description()."""
2078
return "Branch format 5"
2080
def initialize(self, a_bzrdir, name=None):
2081
"""Create a branch of this format in a_bzrdir."""
2082
utf8_files = [('revision-history', ''),
2083
('branch-name', ''),
2085
return self._initialize_helper(a_bzrdir, utf8_files, name)
2087
def supports_tags(self):
2091
class BzrBranchFormat6(BranchFormatMetadir):
2092
"""Branch format with last-revision and tags.
2094
Unlike previous formats, this has no explicit revision history. Instead,
2095
this just stores the last-revision, and the left-hand history leading
2096
up to there is the history.
2098
This format was introduced in bzr 0.15
2099
and became the default in 0.91.
2102
def _branch_class(self):
2105
def get_format_string(self):
2106
"""See BranchFormat.get_format_string()."""
2107
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2109
def get_format_description(self):
2110
"""See BranchFormat.get_format_description()."""
2111
return "Branch format 6"
2113
def initialize(self, a_bzrdir, name=None):
2114
"""Create a branch of this format in a_bzrdir."""
2115
utf8_files = [('last-revision', '0 null:\n'),
2116
('branch.conf', ''),
2119
return self._initialize_helper(a_bzrdir, utf8_files, name)
2121
def make_tags(self, branch):
2122
"""See bzrlib.branch.BranchFormat.make_tags()."""
2123
return BasicTags(branch)
2125
def supports_set_append_revisions_only(self):
2129
class BzrBranchFormat8(BranchFormatMetadir):
2130
"""Metadir format supporting storing locations of subtree branches."""
2132
def _branch_class(self):
2135
def get_format_string(self):
2136
"""See BranchFormat.get_format_string()."""
2137
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2139
def get_format_description(self):
2140
"""See BranchFormat.get_format_description()."""
2141
return "Branch format 8"
2143
def initialize(self, a_bzrdir, name=None):
2144
"""Create a branch of this format in a_bzrdir."""
2145
utf8_files = [('last-revision', '0 null:\n'),
2146
('branch.conf', ''),
2150
return self._initialize_helper(a_bzrdir, utf8_files, name)
2153
super(BzrBranchFormat8, self).__init__()
2154
self._matchingbzrdir.repository_format = \
2155
RepositoryFormatKnitPack5RichRoot()
2157
def make_tags(self, branch):
2158
"""See bzrlib.branch.BranchFormat.make_tags()."""
2159
return BasicTags(branch)
2161
def supports_set_append_revisions_only(self):
2164
def supports_stacking(self):
2167
supports_reference_locations = True
2170
class BzrBranchFormat7(BzrBranchFormat8):
2171
"""Branch format with last-revision, tags, and a stacked location pointer.
2173
The stacked location pointer is passed down to the repository and requires
2174
a repository format with supports_external_lookups = True.
2176
This format was introduced in bzr 1.6.
2179
def initialize(self, a_bzrdir, name=None):
2180
"""Create a branch of this format in a_bzrdir."""
2181
utf8_files = [('last-revision', '0 null:\n'),
2182
('branch.conf', ''),
2185
return self._initialize_helper(a_bzrdir, utf8_files, name)
2187
def _branch_class(self):
2190
def get_format_string(self):
2191
"""See BranchFormat.get_format_string()."""
2192
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2194
def get_format_description(self):
2195
"""See BranchFormat.get_format_description()."""
2196
return "Branch format 7"
2198
def supports_set_append_revisions_only(self):
2201
supports_reference_locations = False
2204
class BranchReferenceFormat(BranchFormat):
2205
"""Bzr branch reference format.
2207
Branch references are used in implementing checkouts, they
2208
act as an alias to the real branch which is at some other url.
2215
def get_format_string(self):
2216
"""See BranchFormat.get_format_string()."""
2217
return "Bazaar-NG Branch Reference Format 1\n"
2219
def get_format_description(self):
2220
"""See BranchFormat.get_format_description()."""
2221
return "Checkout reference format 1"
2223
def get_reference(self, a_bzrdir, name=None):
2224
"""See BranchFormat.get_reference()."""
2225
transport = a_bzrdir.get_branch_transport(None, name=name)
2226
return transport.get_bytes('location')
2228
def set_reference(self, a_bzrdir, name, to_branch):
2229
"""See BranchFormat.set_reference()."""
2230
transport = a_bzrdir.get_branch_transport(None, name=name)
2231
location = transport.put_bytes('location', to_branch.base)
2233
def initialize(self, a_bzrdir, name=None, target_branch=None):
2234
"""Create a branch of this format in a_bzrdir."""
2235
if target_branch is None:
2236
# this format does not implement branch itself, thus the implicit
2237
# creation contract must see it as uninitializable
2238
raise errors.UninitializableFormat(self)
2239
mutter('creating branch reference in %s', a_bzrdir.user_url)
2240
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2241
branch_transport.put_bytes('location',
2242
target_branch.bzrdir.user_url)
2243
branch_transport.put_bytes('format', self.get_format_string())
2245
a_bzrdir, name, _found=True,
2246
possible_transports=[target_branch.bzrdir.root_transport])
2247
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2251
super(BranchReferenceFormat, self).__init__()
2252
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2253
self._matchingbzrdir.set_branch_format(self)
2255
def _make_reference_clone_function(format, a_branch):
2256
"""Create a clone() routine for a branch dynamically."""
2257
def clone(to_bzrdir, revision_id=None,
2258
repository_policy=None):
2259
"""See Branch.clone()."""
2260
return format.initialize(to_bzrdir, target_branch=a_branch)
2261
# cannot obey revision_id limits when cloning a reference ...
2262
# FIXME RBC 20060210 either nuke revision_id for clone, or
2263
# emit some sort of warning/error to the caller ?!
2266
def open(self, a_bzrdir, name=None, _found=False, location=None,
2267
possible_transports=None, ignore_fallbacks=False):
2268
"""Return the branch that the branch reference in a_bzrdir points at.
2270
:param a_bzrdir: A BzrDir that contains a branch.
2271
:param name: Name of colocated branch to open, if any
2272
:param _found: a private parameter, do not use it. It is used to
2273
indicate if format probing has already be done.
2274
:param ignore_fallbacks: when set, no fallback branches will be opened
2275
(if there are any). Default is to open fallbacks.
2276
:param location: The location of the referenced branch. If
2277
unspecified, this will be determined from the branch reference in
2279
:param possible_transports: An optional reusable transports list.
2282
format = BranchFormat.find_format(a_bzrdir, name=name)
2283
if format.__class__ != self.__class__:
2284
raise AssertionError("wrong format %r found for %r" %
2286
if location is None:
2287
location = self.get_reference(a_bzrdir, name)
2288
real_bzrdir = bzrdir.BzrDir.open(
2289
location, possible_transports=possible_transports)
2290
result = real_bzrdir.open_branch(name=name,
2291
ignore_fallbacks=ignore_fallbacks)
2292
# this changes the behaviour of result.clone to create a new reference
2293
# rather than a copy of the content of the branch.
2294
# I did not use a proxy object because that needs much more extensive
2295
# testing, and we are only changing one behaviour at the moment.
2296
# If we decide to alter more behaviours - i.e. the implicit nickname
2297
# then this should be refactored to introduce a tested proxy branch
2298
# and a subclass of that for use in overriding clone() and ....
2300
result.clone = self._make_reference_clone_function(result)
2304
network_format_registry = registry.FormatRegistry()
2305
"""Registry of formats indexed by their network name.
2307
The network name for a branch format is an identifier that can be used when
2308
referring to formats with smart server operations. See
2309
BranchFormat.network_name() for more detail.
2313
# formats which have no format string are not discoverable
2314
# and not independently creatable, so are not registered.
2315
__format5 = BzrBranchFormat5()
2316
__format6 = BzrBranchFormat6()
2317
__format7 = BzrBranchFormat7()
2318
__format8 = BzrBranchFormat8()
2319
BranchFormat.register_format(__format5)
2320
BranchFormat.register_format(BranchReferenceFormat())
2321
BranchFormat.register_format(__format6)
2322
BranchFormat.register_format(__format7)
2323
BranchFormat.register_format(__format8)
2324
BranchFormat.set_default_format(__format7)
2325
_legacy_formats = [BzrBranchFormat4(),
2327
network_format_registry.register(
2328
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2331
class BranchWriteLockResult(LogicalLockResult):
2332
"""The result of write locking a branch.
2334
:ivar branch_token: The token obtained from the underlying branch lock, or
2336
:ivar unlock: A callable which will unlock the lock.
2339
def __init__(self, unlock, branch_token):
2340
LogicalLockResult.__init__(self, unlock)
2341
self.branch_token = branch_token
2344
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2348
class BzrBranch(Branch, _RelockDebugMixin):
2349
"""A branch stored in the actual filesystem.
2351
Note that it's "local" in the context of the filesystem; it doesn't
2352
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2353
it's writable, and can be accessed via the normal filesystem API.
2355
:ivar _transport: Transport for file operations on this branch's
2356
control files, typically pointing to the .bzr/branch directory.
2357
:ivar repository: Repository for this branch.
2358
:ivar base: The url of the base directory for this branch; the one
2359
containing the .bzr directory.
2360
:ivar name: Optional colocated branch name as it exists in the control
2364
def __init__(self, _format=None,
2365
_control_files=None, a_bzrdir=None, name=None,
2366
_repository=None, ignore_fallbacks=False):
2367
"""Create new branch object at a particular location."""
2368
if a_bzrdir is None:
2369
raise ValueError('a_bzrdir must be supplied')
2371
self.bzrdir = a_bzrdir
2372
self._base = self.bzrdir.transport.clone('..').base
2374
# XXX: We should be able to just do
2375
# self.base = self.bzrdir.root_transport.base
2376
# but this does not quite work yet -- mbp 20080522
2377
self._format = _format
2378
if _control_files is None:
2379
raise ValueError('BzrBranch _control_files is None')
2380
self.control_files = _control_files
2381
self._transport = _control_files._transport
2382
self.repository = _repository
2383
Branch.__init__(self)
2386
if self.name is None:
2387
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2389
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2394
def _get_base(self):
2395
"""Returns the directory containing the control directory."""
2398
base = property(_get_base, doc="The URL for the root of this branch.")
2400
def _get_config(self):
2401
return TransportConfig(self._transport, 'branch.conf')
2403
def is_locked(self):
2404
return self.control_files.is_locked()
2406
def lock_write(self, token=None):
2407
"""Lock the branch for write operations.
2409
:param token: A token to permit reacquiring a previously held and
2411
:return: A BranchWriteLockResult.
2413
if not self.is_locked():
2414
self._note_lock('w')
2415
# All-in-one needs to always unlock/lock.
2416
repo_control = getattr(self.repository, 'control_files', None)
2417
if self.control_files == repo_control or not self.is_locked():
2418
self.repository._warn_if_deprecated(self)
2419
self.repository.lock_write()
2424
return BranchWriteLockResult(self.unlock,
2425
self.control_files.lock_write(token=token))
2428
self.repository.unlock()
2431
def lock_read(self):
2432
"""Lock the branch for read operations.
2434
:return: A bzrlib.lock.LogicalLockResult.
2436
if not self.is_locked():
2437
self._note_lock('r')
2438
# All-in-one needs to always unlock/lock.
2439
repo_control = getattr(self.repository, 'control_files', None)
2440
if self.control_files == repo_control or not self.is_locked():
2441
self.repository._warn_if_deprecated(self)
2442
self.repository.lock_read()
2447
self.control_files.lock_read()
2448
return LogicalLockResult(self.unlock)
2451
self.repository.unlock()
2454
@only_raises(errors.LockNotHeld, errors.LockBroken)
2457
self.control_files.unlock()
2459
# All-in-one needs to always unlock/lock.
2460
repo_control = getattr(self.repository, 'control_files', None)
2461
if (self.control_files == repo_control or
2462
not self.control_files.is_locked()):
2463
self.repository.unlock()
2464
if not self.control_files.is_locked():
2465
# we just released the lock
2466
self._clear_cached_state()
2468
def peek_lock_mode(self):
2469
if self.control_files._lock_count == 0:
2472
return self.control_files._lock_mode
2474
def get_physical_lock_status(self):
2475
return self.control_files.get_physical_lock_status()
2478
def print_file(self, file, revision_id):
2479
"""See Branch.print_file."""
2480
return self.repository.print_file(file, revision_id)
2482
def _write_revision_history(self, history):
2483
"""Factored out of set_revision_history.
2485
This performs the actual writing to disk.
2486
It is intended to be called by BzrBranch5.set_revision_history."""
2487
self._transport.put_bytes(
2488
'revision-history', '\n'.join(history),
2489
mode=self.bzrdir._get_file_mode())
2492
def set_revision_history(self, rev_history):
2493
"""See Branch.set_revision_history."""
2494
if 'evil' in debug.debug_flags:
2495
mutter_callsite(3, "set_revision_history scales with history.")
2496
check_not_reserved_id = _mod_revision.check_not_reserved_id
2497
for rev_id in rev_history:
2498
check_not_reserved_id(rev_id)
2499
if Branch.hooks['post_change_branch_tip']:
2500
# Don't calculate the last_revision_info() if there are no hooks
2502
old_revno, old_revid = self.last_revision_info()
2503
if len(rev_history) == 0:
2504
revid = _mod_revision.NULL_REVISION
2506
revid = rev_history[-1]
2507
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2508
self._write_revision_history(rev_history)
2509
self._clear_cached_state()
2510
self._cache_revision_history(rev_history)
2511
for hook in Branch.hooks['set_rh']:
2512
hook(self, rev_history)
2513
if Branch.hooks['post_change_branch_tip']:
2514
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2516
def _synchronize_history(self, destination, revision_id):
2517
"""Synchronize last revision and revision history between branches.
2519
This version is most efficient when the destination is also a
2520
BzrBranch5, but works for BzrBranch6 as long as the revision
2521
history is the true lefthand parent history, and all of the revisions
2522
are in the destination's repository. If not, set_revision_history
2525
:param destination: The branch to copy the history into
2526
:param revision_id: The revision-id to truncate history at. May
2527
be None to copy complete history.
2529
if not isinstance(destination._format, BzrBranchFormat5):
2530
super(BzrBranch, self)._synchronize_history(
2531
destination, revision_id)
2533
if revision_id == _mod_revision.NULL_REVISION:
2536
new_history = self.revision_history()
2537
if revision_id is not None and new_history != []:
2539
new_history = new_history[:new_history.index(revision_id) + 1]
2541
rev = self.repository.get_revision(revision_id)
2542
new_history = rev.get_history(self.repository)[1:]
2543
destination.set_revision_history(new_history)
2546
def set_last_revision_info(self, revno, revision_id):
2547
"""Set the last revision of this branch.
2549
The caller is responsible for checking that the revno is correct
2550
for this revision id.
2552
It may be possible to set the branch last revision to an id not
2553
present in the repository. However, branches can also be
2554
configured to check constraints on history, in which case this may not
2557
revision_id = _mod_revision.ensure_null(revision_id)
2558
# this old format stores the full history, but this api doesn't
2559
# provide it, so we must generate, and might as well check it's
2561
history = self._lefthand_history(revision_id)
2562
if len(history) != revno:
2563
raise AssertionError('%d != %d' % (len(history), revno))
2564
self.set_revision_history(history)
2566
def _gen_revision_history(self):
2567
history = self._transport.get_bytes('revision-history').split('\n')
2568
if history[-1:] == ['']:
2569
# There shouldn't be a trailing newline, but just in case.
2574
def generate_revision_history(self, revision_id, last_rev=None,
2576
"""Create a new revision history that will finish with revision_id.
2578
:param revision_id: the new tip to use.
2579
:param last_rev: The previous last_revision. If not None, then this
2580
must be a ancestory of revision_id, or DivergedBranches is raised.
2581
:param other_branch: The other branch that DivergedBranches should
2582
raise with respect to.
2584
self.set_revision_history(self._lefthand_history(revision_id,
2585
last_rev, other_branch))
2587
def basis_tree(self):
2588
"""See Branch.basis_tree."""
2589
return self.repository.revision_tree(self.last_revision())
2591
def _get_parent_location(self):
2592
_locs = ['parent', 'pull', 'x-pull']
2595
return self._transport.get_bytes(l).strip('\n')
2596
except errors.NoSuchFile:
2600
def _basic_push(self, target, overwrite, stop_revision):
2601
"""Basic implementation of push without bound branches or hooks.
2603
Must be called with source read locked and target write locked.
2605
result = BranchPushResult()
2606
result.source_branch = self
2607
result.target_branch = target
2608
result.old_revno, result.old_revid = target.last_revision_info()
2609
self.update_references(target)
2610
if result.old_revid != self.last_revision():
2611
# We assume that during 'push' this repository is closer than
2613
graph = self.repository.get_graph(target.repository)
2614
target.update_revisions(self, stop_revision,
2615
overwrite=overwrite, graph=graph)
2616
if self._push_should_merge_tags():
2617
result.tag_conflicts = self.tags.merge_to(target.tags,
2619
result.new_revno, result.new_revid = target.last_revision_info()
2622
def get_stacked_on_url(self):
2623
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2625
def set_push_location(self, location):
2626
"""See Branch.set_push_location."""
2627
self.get_config().set_user_option(
2628
'push_location', location,
2629
store=_mod_config.STORE_LOCATION_NORECURSE)
2631
def _set_parent_location(self, url):
2633
self._transport.delete('parent')
2635
self._transport.put_bytes('parent', url + '\n',
2636
mode=self.bzrdir._get_file_mode())
2639
class BzrBranch5(BzrBranch):
2640
"""A format 5 branch. This supports new features over plain branches.
2642
It has support for a master_branch which is the data for bound branches.
2645
def get_bound_location(self):
2647
return self._transport.get_bytes('bound')[:-1]
2648
except errors.NoSuchFile:
2652
def get_master_branch(self, possible_transports=None):
2653
"""Return the branch we are bound to.
2655
:return: Either a Branch, or None
2657
This could memoise the branch, but if thats done
2658
it must be revalidated on each new lock.
2659
So for now we just don't memoise it.
2660
# RBC 20060304 review this decision.
2662
bound_loc = self.get_bound_location()
2666
return Branch.open(bound_loc,
2667
possible_transports=possible_transports)
2668
except (errors.NotBranchError, errors.ConnectionError), e:
2669
raise errors.BoundBranchConnectionFailure(
2673
def set_bound_location(self, location):
2674
"""Set the target where this branch is bound to.
2676
:param location: URL to the target branch
2679
self._transport.put_bytes('bound', location+'\n',
2680
mode=self.bzrdir._get_file_mode())
2683
self._transport.delete('bound')
2684
except errors.NoSuchFile:
2689
def bind(self, other):
2690
"""Bind this branch to the branch other.
2692
This does not push or pull data between the branches, though it does
2693
check for divergence to raise an error when the branches are not
2694
either the same, or one a prefix of the other. That behaviour may not
2695
be useful, so that check may be removed in future.
2697
:param other: The branch to bind to
2700
# TODO: jam 20051230 Consider checking if the target is bound
2701
# It is debatable whether you should be able to bind to
2702
# a branch which is itself bound.
2703
# Committing is obviously forbidden,
2704
# but binding itself may not be.
2705
# Since we *have* to check at commit time, we don't
2706
# *need* to check here
2708
# we want to raise diverged if:
2709
# last_rev is not in the other_last_rev history, AND
2710
# other_last_rev is not in our history, and do it without pulling
2712
self.set_bound_location(other.base)
2716
"""If bound, unbind"""
2717
return self.set_bound_location(None)
2720
def update(self, possible_transports=None):
2721
"""Synchronise this branch with the master branch if any.
2723
:return: None or the last_revision that was pivoted out during the
2726
master = self.get_master_branch(possible_transports)
2727
if master is not None:
2728
old_tip = _mod_revision.ensure_null(self.last_revision())
2729
self.pull(master, overwrite=True)
2730
if self.repository.get_graph().is_ancestor(old_tip,
2731
_mod_revision.ensure_null(self.last_revision())):
2737
class BzrBranch8(BzrBranch5):
2738
"""A branch that stores tree-reference locations."""
2740
def _open_hook(self):
2741
if self._ignore_fallbacks:
2744
url = self.get_stacked_on_url()
2745
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2746
errors.UnstackableBranchFormat):
2749
for hook in Branch.hooks['transform_fallback_location']:
2750
url = hook(self, url)
2752
hook_name = Branch.hooks.get_hook_name(hook)
2753
raise AssertionError(
2754
"'transform_fallback_location' hook %s returned "
2755
"None, not a URL." % hook_name)
2756
self._activate_fallback_location(url)
2758
def __init__(self, *args, **kwargs):
2759
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2760
super(BzrBranch8, self).__init__(*args, **kwargs)
2761
self._last_revision_info_cache = None
2762
self._reference_info = None
2764
def _clear_cached_state(self):
2765
super(BzrBranch8, self)._clear_cached_state()
2766
self._last_revision_info_cache = None
2767
self._reference_info = None
2769
def _last_revision_info(self):
2770
revision_string = self._transport.get_bytes('last-revision')
2771
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2772
revision_id = cache_utf8.get_cached_utf8(revision_id)
2774
return revno, revision_id
2776
def _write_last_revision_info(self, revno, revision_id):
2777
"""Simply write out the revision id, with no checks.
2779
Use set_last_revision_info to perform this safely.
2781
Does not update the revision_history cache.
2782
Intended to be called by set_last_revision_info and
2783
_write_revision_history.
2785
revision_id = _mod_revision.ensure_null(revision_id)
2786
out_string = '%d %s\n' % (revno, revision_id)
2787
self._transport.put_bytes('last-revision', out_string,
2788
mode=self.bzrdir._get_file_mode())
2791
def set_last_revision_info(self, revno, revision_id):
2792
revision_id = _mod_revision.ensure_null(revision_id)
2793
old_revno, old_revid = self.last_revision_info()
2794
if self._get_append_revisions_only():
2795
self._check_history_violation(revision_id)
2796
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2797
self._write_last_revision_info(revno, revision_id)
2798
self._clear_cached_state()
2799
self._last_revision_info_cache = revno, revision_id
2800
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2802
def _synchronize_history(self, destination, revision_id):
2803
"""Synchronize last revision and revision history between branches.
2805
:see: Branch._synchronize_history
2807
# XXX: The base Branch has a fast implementation of this method based
2808
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2809
# that uses set_revision_history. This class inherits from BzrBranch5,
2810
# but wants the fast implementation, so it calls
2811
# Branch._synchronize_history directly.
2812
Branch._synchronize_history(self, destination, revision_id)
2814
def _check_history_violation(self, revision_id):
2815
last_revision = _mod_revision.ensure_null(self.last_revision())
2816
if _mod_revision.is_null(last_revision):
2818
if last_revision not in self._lefthand_history(revision_id):
2819
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2821
def _gen_revision_history(self):
2822
"""Generate the revision history from last revision
2824
last_revno, last_revision = self.last_revision_info()
2825
self._extend_partial_history(stop_index=last_revno-1)
2826
return list(reversed(self._partial_revision_history_cache))
2828
def _write_revision_history(self, history):
2829
"""Factored out of set_revision_history.
2831
This performs the actual writing to disk, with format-specific checks.
2832
It is intended to be called by BzrBranch5.set_revision_history.
2834
if len(history) == 0:
2835
last_revision = 'null:'
2837
if history != self._lefthand_history(history[-1]):
2838
raise errors.NotLefthandHistory(history)
2839
last_revision = history[-1]
2840
if self._get_append_revisions_only():
2841
self._check_history_violation(last_revision)
2842
self._write_last_revision_info(len(history), last_revision)
2845
def _set_parent_location(self, url):
2846
"""Set the parent branch"""
2847
self._set_config_location('parent_location', url, make_relative=True)
2850
def _get_parent_location(self):
2851
"""Set the parent branch"""
2852
return self._get_config_location('parent_location')
2855
def _set_all_reference_info(self, info_dict):
2856
"""Replace all reference info stored in a branch.
2858
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2861
writer = rio.RioWriter(s)
2862
for key, (tree_path, branch_location) in info_dict.iteritems():
2863
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2864
branch_location=branch_location)
2865
writer.write_stanza(stanza)
2866
self._transport.put_bytes('references', s.getvalue())
2867
self._reference_info = info_dict
2870
def _get_all_reference_info(self):
2871
"""Return all the reference info stored in a branch.
2873
:return: A dict of {file_id: (tree_path, branch_location)}
2875
if self._reference_info is not None:
2876
return self._reference_info
2877
rio_file = self._transport.get('references')
2879
stanzas = rio.read_stanzas(rio_file)
2880
info_dict = dict((s['file_id'], (s['tree_path'],
2881
s['branch_location'])) for s in stanzas)
2884
self._reference_info = info_dict
2887
def set_reference_info(self, file_id, tree_path, branch_location):
2888
"""Set the branch location to use for a tree reference.
2890
:param file_id: The file-id of the tree reference.
2891
:param tree_path: The path of the tree reference in the tree.
2892
:param branch_location: The location of the branch to retrieve tree
2895
info_dict = self._get_all_reference_info()
2896
info_dict[file_id] = (tree_path, branch_location)
2897
if None in (tree_path, branch_location):
2898
if tree_path is not None:
2899
raise ValueError('tree_path must be None when branch_location'
2901
if branch_location is not None:
2902
raise ValueError('branch_location must be None when tree_path'
2904
del info_dict[file_id]
2905
self._set_all_reference_info(info_dict)
2907
def get_reference_info(self, file_id):
2908
"""Get the tree_path and branch_location for a tree reference.
2910
:return: a tuple of (tree_path, branch_location)
2912
return self._get_all_reference_info().get(file_id, (None, None))
2914
def reference_parent(self, file_id, path, possible_transports=None):
2915
"""Return the parent branch for a tree-reference file_id.
2917
:param file_id: The file_id of the tree reference
2918
:param path: The path of the file_id in the tree
2919
:return: A branch associated with the file_id
2921
branch_location = self.get_reference_info(file_id)[1]
2922
if branch_location is None:
2923
return Branch.reference_parent(self, file_id, path,
2924
possible_transports)
2925
branch_location = urlutils.join(self.user_url, branch_location)
2926
return Branch.open(branch_location,
2927
possible_transports=possible_transports)
2929
def set_push_location(self, location):
2930
"""See Branch.set_push_location."""
2931
self._set_config_location('push_location', location)
2933
def set_bound_location(self, location):
2934
"""See Branch.set_push_location."""
2936
config = self.get_config()
2937
if location is None:
2938
if config.get_user_option('bound') != 'True':
2941
config.set_user_option('bound', 'False', warn_masked=True)
2944
self._set_config_location('bound_location', location,
2946
config.set_user_option('bound', 'True', warn_masked=True)
2949
def _get_bound_location(self, bound):
2950
"""Return the bound location in the config file.
2952
Return None if the bound parameter does not match"""
2953
config = self.get_config()
2954
config_bound = (config.get_user_option('bound') == 'True')
2955
if config_bound != bound:
2957
return self._get_config_location('bound_location', config=config)
2959
def get_bound_location(self):
2960
"""See Branch.set_push_location."""
2961
return self._get_bound_location(True)
2963
def get_old_bound_location(self):
2964
"""See Branch.get_old_bound_location"""
2965
return self._get_bound_location(False)
2967
def get_stacked_on_url(self):
2968
# you can always ask for the URL; but you might not be able to use it
2969
# if the repo can't support stacking.
2970
## self._check_stackable_repo()
2971
stacked_url = self._get_config_location('stacked_on_location')
2972
if stacked_url is None:
2973
raise errors.NotStacked(self)
2976
def _get_append_revisions_only(self):
2977
return self.get_config(
2978
).get_user_option_as_bool('append_revisions_only')
2981
def generate_revision_history(self, revision_id, last_rev=None,
2983
"""See BzrBranch5.generate_revision_history"""
2984
history = self._lefthand_history(revision_id, last_rev, other_branch)
2985
revno = len(history)
2986
self.set_last_revision_info(revno, revision_id)
2989
def get_rev_id(self, revno, history=None):
2990
"""Find the revision id of the specified revno."""
2992
return _mod_revision.NULL_REVISION
2994
last_revno, last_revision_id = self.last_revision_info()
2995
if revno <= 0 or revno > last_revno:
2996
raise errors.NoSuchRevision(self, revno)
2998
if history is not None:
2999
return history[revno - 1]
3001
index = last_revno - revno
3002
if len(self._partial_revision_history_cache) <= index:
3003
self._extend_partial_history(stop_index=index)
3004
if len(self._partial_revision_history_cache) > index:
3005
return self._partial_revision_history_cache[index]
3007
raise errors.NoSuchRevision(self, revno)
3010
def revision_id_to_revno(self, revision_id):
3011
"""Given a revision id, return its revno"""
3012
if _mod_revision.is_null(revision_id):
3015
index = self._partial_revision_history_cache.index(revision_id)
3017
self._extend_partial_history(stop_revision=revision_id)
3018
index = len(self._partial_revision_history_cache) - 1
3019
if self._partial_revision_history_cache[index] != revision_id:
3020
raise errors.NoSuchRevision(self, revision_id)
3021
return self.revno() - index
3024
class BzrBranch7(BzrBranch8):
3025
"""A branch with support for a fallback repository."""
3027
def set_reference_info(self, file_id, tree_path, branch_location):
3028
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3030
def get_reference_info(self, file_id):
3031
Branch.get_reference_info(self, file_id)
3033
def reference_parent(self, file_id, path, possible_transports=None):
3034
return Branch.reference_parent(self, file_id, path,
3035
possible_transports)
3038
class BzrBranch6(BzrBranch7):
3039
"""See BzrBranchFormat6 for the capabilities of this branch.
3041
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3045
def get_stacked_on_url(self):
3046
raise errors.UnstackableBranchFormat(self._format, self.user_url)
3049
######################################################################
3050
# results of operations
3053
class _Result(object):
3055
def _show_tag_conficts(self, to_file):
3056
if not getattr(self, 'tag_conflicts', None):
3058
to_file.write('Conflicting tags:\n')
3059
for name, value1, value2 in self.tag_conflicts:
3060
to_file.write(' %s\n' % (name, ))
3063
class PullResult(_Result):
3064
"""Result of a Branch.pull operation.
3066
:ivar old_revno: Revision number before pull.
3067
:ivar new_revno: Revision number after pull.
3068
:ivar old_revid: Tip revision id before pull.
3069
:ivar new_revid: Tip revision id after pull.
3070
:ivar source_branch: Source (local) branch object. (read locked)
3071
:ivar master_branch: Master branch of the target, or the target if no
3073
:ivar local_branch: target branch if there is a Master, else None
3074
:ivar target_branch: Target/destination branch object. (write locked)
3075
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3079
# DEPRECATED: pull used to return the change in revno
3080
return self.new_revno - self.old_revno
3082
def report(self, to_file):
3084
if self.old_revid == self.new_revid:
3085
to_file.write('No revisions to pull.\n')
3087
to_file.write('Now on revision %d.\n' % self.new_revno)
3088
self._show_tag_conficts(to_file)
3091
class BranchPushResult(_Result):
3092
"""Result of a Branch.push operation.
3094
:ivar old_revno: Revision number (eg 10) of the target before push.
3095
:ivar new_revno: Revision number (eg 12) of the target after push.
3096
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3098
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3100
:ivar source_branch: Source branch object that the push was from. This is
3101
read locked, and generally is a local (and thus low latency) branch.
3102
:ivar master_branch: If target is a bound branch, the master branch of
3103
target, or target itself. Always write locked.
3104
:ivar target_branch: The direct Branch where data is being sent (write
3106
:ivar local_branch: If the target is a bound branch this will be the
3107
target, otherwise it will be None.
3111
# DEPRECATED: push used to return the change in revno
3112
return self.new_revno - self.old_revno
3114
def report(self, to_file):
3115
"""Write a human-readable description of the result."""
3116
if self.old_revid == self.new_revid:
3117
note('No new revisions to push.')
3119
note('Pushed up to revision %d.' % self.new_revno)
3120
self._show_tag_conficts(to_file)
3123
class BranchCheckResult(object):
3124
"""Results of checking branch consistency.
3129
def __init__(self, branch):
3130
self.branch = branch
3133
def report_results(self, verbose):
3134
"""Report the check results via trace.note.
3136
:param verbose: Requests more detailed display of what was checked,
3139
note('checked branch %s format %s', self.branch.user_url,
3140
self.branch._format)
3141
for error in self.errors:
3142
note('found error:%s', error)
3145
class Converter5to6(object):
3146
"""Perform an in-place upgrade of format 5 to format 6"""
3148
def convert(self, branch):
3149
# Data for 5 and 6 can peacefully coexist.
3150
format = BzrBranchFormat6()
3151
new_branch = format.open(branch.bzrdir, _found=True)
3153
# Copy source data into target
3154
new_branch._write_last_revision_info(*branch.last_revision_info())
3155
new_branch.set_parent(branch.get_parent())
3156
new_branch.set_bound_location(branch.get_bound_location())
3157
new_branch.set_push_location(branch.get_push_location())
3159
# New branch has no tags by default
3160
new_branch.tags._set_tag_dict({})
3162
# Copying done; now update target format
3163
new_branch._transport.put_bytes('format',
3164
format.get_format_string(),
3165
mode=new_branch.bzrdir._get_file_mode())
3167
# Clean up old files
3168
new_branch._transport.delete('revision-history')
3170
branch.set_parent(None)
3171
except errors.NoSuchFile:
3173
branch.set_bound_location(None)
3176
class Converter6to7(object):
3177
"""Perform an in-place upgrade of format 6 to format 7"""
3179
def convert(self, branch):
3180
format = BzrBranchFormat7()
3181
branch._set_config_location('stacked_on_location', '')
3182
# update target format
3183
branch._transport.put_bytes('format', format.get_format_string())
3186
class Converter7to8(object):
3187
"""Perform an in-place upgrade of format 6 to format 7"""
3189
def convert(self, branch):
3190
format = BzrBranchFormat8()
3191
branch._transport.put_bytes('references', '')
3192
# update target format
3193
branch._transport.put_bytes('format', format.get_format_string())
3196
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3197
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3200
_run_with_write_locked_target will attempt to release the lock it acquires.
3202
If an exception is raised by callable, then that exception *will* be
3203
propagated, even if the unlock attempt raises its own error. Thus
3204
_run_with_write_locked_target should be preferred to simply doing::
3208
return callable(*args, **kwargs)
3213
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3214
# should share code?
3217
result = callable(*args, **kwargs)
3219
exc_info = sys.exc_info()
3223
raise exc_info[0], exc_info[1], exc_info[2]
3229
class InterBranch(InterObject):
3230
"""This class represents operations taking place between two branches.
3232
Its instances have methods like pull() and push() and contain
3233
references to the source and target repositories these operations
3234
can be carried out on.
3238
"""The available optimised InterBranch types."""
3241
def _get_branch_formats_to_test(klass):
3242
"""Return an iterable of format tuples for testing.
3244
:return: An iterable of (from_format, to_format) to use when testing
3245
this InterBranch class. Each InterBranch class should define this
3248
raise NotImplementedError(klass._get_branch_formats_to_test)
3251
def pull(self, overwrite=False, stop_revision=None,
3252
possible_transports=None, local=False):
3253
"""Mirror source into target branch.
3255
The target branch is considered to be 'local', having low latency.
3257
:returns: PullResult instance
3259
raise NotImplementedError(self.pull)
3262
def update_revisions(self, stop_revision=None, overwrite=False,
3264
"""Pull in new perfect-fit revisions.
3266
:param stop_revision: Updated until the given revision
3267
:param overwrite: Always set the branch pointer, rather than checking
3268
to see if it is a proper descendant.
3269
:param graph: A Graph object that can be used to query history
3270
information. This can be None.
3273
raise NotImplementedError(self.update_revisions)
3276
def push(self, overwrite=False, stop_revision=None,
3277
_override_hook_source_branch=None):
3278
"""Mirror the source branch into the target branch.
3280
The source branch is considered to be 'local', having low latency.
3282
raise NotImplementedError(self.push)
3285
class GenericInterBranch(InterBranch):
3286
"""InterBranch implementation that uses public Branch functions."""
3289
def is_compatible(klass, source, target):
3290
# GenericBranch uses the public API, so always compatible
3294
def _get_branch_formats_to_test(klass):
3295
return [(BranchFormat._default_format, BranchFormat._default_format)]
3298
def unwrap_format(klass, format):
3299
if isinstance(format, remote.RemoteBranchFormat):
3300
format._ensure_real()
3301
return format._custom_format
3305
def copy_content_into(self, revision_id=None):
3306
"""Copy the content of source into target
3308
revision_id: if not None, the revision history in the new branch will
3309
be truncated to end with revision_id.
3311
self.source.update_references(self.target)
3312
self.source._synchronize_history(self.target, revision_id)
3314
parent = self.source.get_parent()
3315
except errors.InaccessibleParent, e:
3316
mutter('parent was not accessible to copy: %s', e)
3319
self.target.set_parent(parent)
3320
if self.source._push_should_merge_tags():
3321
self.source.tags.merge_to(self.target.tags)
3324
def update_revisions(self, stop_revision=None, overwrite=False,
3326
"""See InterBranch.update_revisions()."""
3327
other_revno, other_last_revision = self.source.last_revision_info()
3328
stop_revno = None # unknown
3329
if stop_revision is None:
3330
stop_revision = other_last_revision
3331
if _mod_revision.is_null(stop_revision):
3332
# if there are no commits, we're done.
3334
stop_revno = other_revno
3336
# what's the current last revision, before we fetch [and change it
3338
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3339
# we fetch here so that we don't process data twice in the common
3340
# case of having something to pull, and so that the check for
3341
# already merged can operate on the just fetched graph, which will
3342
# be cached in memory.
3343
self.target.fetch(self.source, stop_revision)
3344
# Check to see if one is an ancestor of the other
3347
graph = self.target.repository.get_graph()
3348
if self.target._check_if_descendant_or_diverged(
3349
stop_revision, last_rev, graph, self.source):
3350
# stop_revision is a descendant of last_rev, but we aren't
3351
# overwriting, so we're done.
3353
if stop_revno is None:
3355
graph = self.target.repository.get_graph()
3356
this_revno, this_last_revision = \
3357
self.target.last_revision_info()
3358
stop_revno = graph.find_distance_to_null(stop_revision,
3359
[(other_last_revision, other_revno),
3360
(this_last_revision, this_revno)])
3361
self.target.set_last_revision_info(stop_revno, stop_revision)
3364
def pull(self, overwrite=False, stop_revision=None,
3365
possible_transports=None, run_hooks=True,
3366
_override_hook_target=None, local=False):
3367
"""Pull from source into self, updating my master if any.
3369
:param run_hooks: Private parameter - if false, this branch
3370
is being called because it's the master of the primary branch,
3371
so it should not run its hooks.
3373
bound_location = self.target.get_bound_location()
3374
if local and not bound_location:
3375
raise errors.LocalRequiresBoundBranch()
3376
master_branch = None
3377
if not local and bound_location and self.source.user_url != bound_location:
3378
# not pulling from master, so we need to update master.
3379
master_branch = self.target.get_master_branch(possible_transports)
3380
master_branch.lock_write()
3383
# pull from source into master.
3384
master_branch.pull(self.source, overwrite, stop_revision,
3386
return self._pull(overwrite,
3387
stop_revision, _hook_master=master_branch,
3388
run_hooks=run_hooks,
3389
_override_hook_target=_override_hook_target)
3392
master_branch.unlock()
3394
def push(self, overwrite=False, stop_revision=None,
3395
_override_hook_source_branch=None):
3396
"""See InterBranch.push.
3398
This is the basic concrete implementation of push()
3400
:param _override_hook_source_branch: If specified, run
3401
the hooks passing this Branch as the source, rather than self.
3402
This is for use of RemoteBranch, where push is delegated to the
3403
underlying vfs-based Branch.
3405
# TODO: Public option to disable running hooks - should be trivial but
3407
self.source.lock_read()
3409
return _run_with_write_locked_target(
3410
self.target, self._push_with_bound_branches, overwrite,
3412
_override_hook_source_branch=_override_hook_source_branch)
3414
self.source.unlock()
3416
def _push_with_bound_branches(self, overwrite, stop_revision,
3417
_override_hook_source_branch=None):
3418
"""Push from source into target, and into target's master if any.
3421
if _override_hook_source_branch:
3422
result.source_branch = _override_hook_source_branch
3423
for hook in Branch.hooks['post_push']:
3426
bound_location = self.target.get_bound_location()
3427
if bound_location and self.target.base != bound_location:
3428
# there is a master branch.
3430
# XXX: Why the second check? Is it even supported for a branch to
3431
# be bound to itself? -- mbp 20070507
3432
master_branch = self.target.get_master_branch()
3433
master_branch.lock_write()
3435
# push into the master from the source branch.
3436
self.source._basic_push(master_branch, overwrite, stop_revision)
3437
# and push into the target branch from the source. Note that we
3438
# push from the source branch again, because its considered the
3439
# highest bandwidth repository.
3440
result = self.source._basic_push(self.target, overwrite,
3442
result.master_branch = master_branch
3443
result.local_branch = self.target
3447
master_branch.unlock()
3450
result = self.source._basic_push(self.target, overwrite,
3452
# TODO: Why set master_branch and local_branch if there's no
3453
# binding? Maybe cleaner to just leave them unset? -- mbp
3455
result.master_branch = self.target
3456
result.local_branch = None
3460
def _pull(self, overwrite=False, stop_revision=None,
3461
possible_transports=None, _hook_master=None, run_hooks=True,
3462
_override_hook_target=None, local=False):
3465
This function is the core worker, used by GenericInterBranch.pull to
3466
avoid duplication when pulling source->master and source->local.
3468
:param _hook_master: Private parameter - set the branch to
3469
be supplied as the master to pull hooks.
3470
:param run_hooks: Private parameter - if false, this branch
3471
is being called because it's the master of the primary branch,
3472
so it should not run its hooks.
3473
:param _override_hook_target: Private parameter - set the branch to be
3474
supplied as the target_branch to pull hooks.
3475
:param local: Only update the local branch, and not the bound branch.
3477
# This type of branch can't be bound.
3479
raise errors.LocalRequiresBoundBranch()
3480
result = PullResult()
3481
result.source_branch = self.source
3482
if _override_hook_target is None:
3483
result.target_branch = self.target
3485
result.target_branch = _override_hook_target
3486
self.source.lock_read()
3488
# We assume that during 'pull' the target repository is closer than
3490
self.source.update_references(self.target)
3491
graph = self.target.repository.get_graph(self.source.repository)
3492
# TODO: Branch formats should have a flag that indicates
3493
# that revno's are expensive, and pull() should honor that flag.
3495
result.old_revno, result.old_revid = \
3496
self.target.last_revision_info()
3497
self.target.update_revisions(self.source, stop_revision,
3498
overwrite=overwrite, graph=graph)
3499
# TODO: The old revid should be specified when merging tags,
3500
# so a tags implementation that versions tags can only
3501
# pull in the most recent changes. -- JRV20090506
3502
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3504
result.new_revno, result.new_revid = self.target.last_revision_info()
3506
result.master_branch = _hook_master
3507
result.local_branch = result.target_branch
3509
result.master_branch = result.target_branch
3510
result.local_branch = None
3512
for hook in Branch.hooks['post_pull']:
3515
self.source.unlock()
3519
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
