13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from copy import deepcopy
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
18
from cStringIO import StringIO
20
from unittest import TestSuite
21
from warnings import warn
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from itertools import chain
24
24
from bzrlib import (
27
config as _mod_config,
33
revision as _mod_revision,
36
from bzrlib.config import TreeConfig
37
from bzrlib.decorators import needs_read_lock, needs_write_lock
38
import bzrlib.errors as errors
39
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
40
HistoryMissing, InvalidRevisionId,
41
InvalidRevisionNumber, LockError, NoSuchFile,
42
NoSuchRevision, NoWorkingTree, NotVersionedError,
43
NotBranchError, UninitializableFormat,
44
UnlistableStore, UnlistableBranch,
46
from bzrlib.lockable_files import LockableFiles, TransportLock
47
from bzrlib.symbol_versioning import (deprecated_function,
51
zero_eight, zero_nine,
53
from bzrlib.trace import mutter, note
41
from bzrlib.config import BranchConfig, TransportConfig
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
from bzrlib.hooks import HookPoint, Hooks
51
from bzrlib.inter import InterObject
52
from bzrlib.lock import _RelockDebugMixin
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
56
61
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
57
62
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
58
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
61
# TODO: Maybe include checks for common corruption of newlines, etc?
63
# TODO: Some operations like log might retrieve the same revisions
64
# repeatedly to calculate deltas. We could perhaps have a weakref
65
# cache in memory to make this faster. In general anything can be
66
# cached in memory between lock and unlock operations. .. nb thats
67
# what the transaction identity map provides
70
######################################################################
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
class Branch(bzrdir.ControlComponent):
74
67
"""Branch holding a history of revisions.
77
Base directory/url of the branch.
70
Base directory/url of the branch; using control_url and
71
control_transport is more standardized.
73
hooks: An instance of BranchHooks.
79
75
# this is really an instance variable - FIXME move it there
80
def control_transport(self):
81
return self._transport
84
def user_transport(self):
85
return self.bzrdir.user_transport
83
87
def __init__(self, *ignored, **ignored_too):
84
raise NotImplementedError('The Branch class is abstract')
88
self.tags = self._format.make_tags(self)
89
self._revision_history_cache = None
90
self._revision_id_to_revno_cache = None
91
self._partial_revision_id_to_revno_cache = {}
92
self._partial_revision_history_cache = []
93
self._last_revision_info_cache = None
94
self._merge_sorted_revisions_cache = None
96
hooks = Branch.hooks['open']
100
def _open_hook(self):
101
"""Called by init to allow simpler extension of the base class."""
103
def _activate_fallback_location(self, url):
104
"""Activate the branch/repository from url as a fallback repository."""
105
repo = self._get_fallback_repository(url)
106
if repo.has_same_location(self.repository):
107
raise errors.UnstackableLocationError(self.user_url, url)
108
self.repository.add_fallback_repository(repo)
86
110
def break_lock(self):
87
111
"""Break a lock if one is present from another instance.
97
121
if master is not None:
98
122
master.break_lock()
101
@deprecated_method(zero_eight)
102
def open_downlevel(base):
103
"""Open a branch which may be of an old format."""
104
return Branch.open(base, _unsupported=True)
107
def open(base, _unsupported=False):
124
def _check_stackable_repo(self):
125
if not self.repository._format.supports_external_lookups:
126
raise errors.UnstackableRepositoryFormat(self.repository._format,
127
self.repository.base)
129
def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
"""Extend the partial history to include a given index
132
If a stop_index is supplied, stop when that index has been reached.
133
If a stop_revision is supplied, stop when that revision is
134
encountered. Otherwise, stop when the beginning of history is
137
:param stop_index: The index which should be present. When it is
138
present, history extension will stop.
139
:param stop_revision: The revision id which should be present. When
140
it is encountered, history extension will stop.
142
if len(self._partial_revision_history_cache) == 0:
143
self._partial_revision_history_cache = [self.last_revision()]
144
repository._iter_for_revno(
145
self.repository, self._partial_revision_history_cache,
146
stop_index=stop_index, stop_revision=stop_revision)
147
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
self._partial_revision_history_cache.pop()
150
def _get_check_refs(self):
151
"""Get the references needed for check().
155
revid = self.last_revision()
156
return [('revision-existence', revid), ('lefthand-distance', revid)]
159
def open(base, _unsupported=False, possible_transports=None):
108
160
"""Open the branch rooted at base.
110
162
For instance, if the branch is at URL/.bzr/branch,
111
163
Branch.open(URL) -> a Branch instance.
113
control = bzrdir.BzrDir.open(base, _unsupported)
114
return control.open_branch(_unsupported)
117
def open_containing(url):
165
control = bzrdir.BzrDir.open(base, _unsupported,
166
possible_transports=possible_transports)
167
return control.open_branch(unsupported=_unsupported)
170
def open_from_transport(transport, name=None, _unsupported=False):
171
"""Open the branch rooted at transport"""
172
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
return control.open_branch(name=name, unsupported=_unsupported)
176
def open_containing(url, possible_transports=None):
118
177
"""Open an existing branch which contains url.
120
179
This probes for a branch at url, and searches upwards from there.
122
181
Basically we keep looking up until we find the control directory or
123
182
run into the root. If there isn't one, raises NotBranchError.
124
If there is one and it is either an unrecognised format or an unsupported
183
If there is one and it is either an unrecognised format or an unsupported
125
184
format, UnknownFormatError or UnsupportedFormatError are raised.
126
185
If there is one, it is returned, along with the unused portion of url.
128
control, relpath = bzrdir.BzrDir.open_containing(url)
187
control, relpath = bzrdir.BzrDir.open_containing(url,
129
189
return control.open_branch(), relpath
132
@deprecated_function(zero_eight)
133
def initialize(base):
134
"""Create a new working tree and branch, rooted at 'base' (url)
136
NOTE: This will soon be deprecated in favour of creation
139
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
141
@deprecated_function(zero_eight)
142
def setup_caching(self, cache_root):
143
"""Subclasses that care about caching should override this, and set
144
up cached stores located under cache_root.
146
NOTE: This is unused.
191
def _push_should_merge_tags(self):
192
"""Should _basic_push merge this branch's tags into the target?
194
The default implementation returns False if this branch has no tags,
195
and True the rest of the time. Subclasses may override this.
197
return self.supports_tags() and self.tags.get_tag_dict()
150
199
def get_config(self):
151
return bzrlib.config.BranchConfig(self)
154
return self.get_config().get_nickname()
200
return BranchConfig(self)
202
def _get_config(self):
203
"""Get the concrete config for just the config in this branch.
205
This is not intended for client use; see Branch.get_config for the
210
:return: An object supporting get_option and set_option.
212
raise NotImplementedError(self._get_config)
214
def _get_fallback_repository(self, url):
215
"""Get the repository we fallback to at url."""
216
url = urlutils.join(self.base, url)
217
a_branch = Branch.open(url,
218
possible_transports=[self.bzrdir.root_transport])
219
return a_branch.repository
221
def _get_tags_bytes(self):
222
"""Get the bytes of a serialised tags dict.
224
Note that not all branches support tags, nor do all use the same tags
225
logic: this method is specific to BasicTags. Other tag implementations
226
may use the same method name and behave differently, safely, because
227
of the double-dispatch via
228
format.make_tags->tags_instance->get_tags_dict.
230
:return: The bytes of the tags file.
231
:seealso: Branch._set_tags_bytes.
233
return self._transport.get_bytes('tags')
235
def _get_nick(self, local=False, possible_transports=None):
236
config = self.get_config()
237
# explicit overrides master, but don't look for master if local is True
238
if not local and not config.has_explicit_nickname():
240
master = self.get_master_branch(possible_transports)
241
if master is not None:
242
# return the master branch value
244
except errors.BzrError, e:
245
# Silently fall back to local implicit nick if the master is
247
mutter("Could not connect to bound branch, "
248
"falling back to local nick.\n " + str(e))
249
return config.get_nickname()
156
251
def _set_nick(self, nick):
157
self.get_config().set_user_option('nickname', nick)
252
self.get_config().set_user_option('nickname', nick, warn_masked=True)
159
254
nick = property(_get_nick, _set_nick)
161
256
def is_locked(self):
162
257
raise NotImplementedError(self.is_locked)
259
def _lefthand_history(self, revision_id, last_rev=None,
261
if 'evil' in debug.debug_flags:
262
mutter_callsite(4, "_lefthand_history scales with history.")
263
# stop_revision must be a descendant of last_revision
264
graph = self.repository.get_graph()
265
if last_rev is not None:
266
if not graph.is_ancestor(last_rev, revision_id):
267
# our previous tip is not merged into stop_revision
268
raise errors.DivergedBranches(self, other_branch)
269
# make a new revision history from the graph
270
parents_map = graph.get_parent_map([revision_id])
271
if revision_id not in parents_map:
272
raise errors.NoSuchRevision(self, revision_id)
273
current_rev_id = revision_id
275
check_not_reserved_id = _mod_revision.check_not_reserved_id
276
# Do not include ghosts or graph origin in revision_history
277
while (current_rev_id in parents_map and
278
len(parents_map[current_rev_id]) > 0):
279
check_not_reserved_id(current_rev_id)
280
new_history.append(current_rev_id)
281
current_rev_id = parents_map[current_rev_id][0]
282
parents_map = graph.get_parent_map([current_rev_id])
283
new_history.reverse()
164
286
def lock_write(self):
165
287
raise NotImplementedError(self.lock_write)
177
299
def get_physical_lock_status(self):
178
300
raise NotImplementedError(self.get_physical_lock_status)
180
def abspath(self, name):
181
"""Return absolute filename for something in the branch
183
XXX: Robert Collins 20051017 what is this used for? why is it a branch
184
method and not a tree method.
186
raise NotImplementedError(self.abspath)
303
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
304
"""Return the revision_id for a dotted revno.
306
:param revno: a tuple like (1,) or (1,1,2)
307
:param _cache_reverse: a private parameter enabling storage
308
of the reverse mapping in a top level cache. (This should
309
only be done in selective circumstances as we want to
310
avoid having the mapping cached multiple times.)
311
:return: the revision_id
312
:raises errors.NoSuchRevision: if the revno doesn't exist
314
rev_id = self._do_dotted_revno_to_revision_id(revno)
316
self._partial_revision_id_to_revno_cache[rev_id] = revno
319
def _do_dotted_revno_to_revision_id(self, revno):
320
"""Worker function for dotted_revno_to_revision_id.
322
Subclasses should override this if they wish to
323
provide a more efficient implementation.
326
return self.get_rev_id(revno[0])
327
revision_id_to_revno = self.get_revision_id_to_revno_map()
328
revision_ids = [revision_id for revision_id, this_revno
329
in revision_id_to_revno.iteritems()
330
if revno == this_revno]
331
if len(revision_ids) == 1:
332
return revision_ids[0]
334
revno_str = '.'.join(map(str, revno))
335
raise errors.NoSuchRevision(self, revno_str)
338
def revision_id_to_dotted_revno(self, revision_id):
339
"""Given a revision id, return its dotted revno.
341
:return: a tuple like (1,) or (400,1,3).
343
return self._do_revision_id_to_dotted_revno(revision_id)
345
def _do_revision_id_to_dotted_revno(self, revision_id):
346
"""Worker function for revision_id_to_revno."""
347
# Try the caches if they are loaded
348
result = self._partial_revision_id_to_revno_cache.get(revision_id)
349
if result is not None:
351
if self._revision_id_to_revno_cache:
352
result = self._revision_id_to_revno_cache.get(revision_id)
354
raise errors.NoSuchRevision(self, revision_id)
355
# Try the mainline as it's optimised
357
revno = self.revision_id_to_revno(revision_id)
359
except errors.NoSuchRevision:
360
# We need to load and use the full revno map after all
361
result = self.get_revision_id_to_revno_map().get(revision_id)
363
raise errors.NoSuchRevision(self, revision_id)
367
def get_revision_id_to_revno_map(self):
368
"""Return the revision_id => dotted revno map.
370
This will be regenerated on demand, but will be cached.
372
:return: A dictionary mapping revision_id => dotted revno.
373
This dictionary should not be modified by the caller.
375
if self._revision_id_to_revno_cache is not None:
376
mapping = self._revision_id_to_revno_cache
378
mapping = self._gen_revno_map()
379
self._cache_revision_id_to_revno(mapping)
380
# TODO: jam 20070417 Since this is being cached, should we be returning
382
# I would rather not, and instead just declare that users should not
383
# modify the return value.
386
def _gen_revno_map(self):
387
"""Create a new mapping from revision ids to dotted revnos.
389
Dotted revnos are generated based on the current tip in the revision
391
This is the worker function for get_revision_id_to_revno_map, which
392
just caches the return value.
394
:return: A dictionary mapping revision_id => dotted revno.
396
revision_id_to_revno = dict((rev_id, revno)
397
for rev_id, depth, revno, end_of_merge
398
in self.iter_merge_sorted_revisions())
399
return revision_id_to_revno
402
def iter_merge_sorted_revisions(self, start_revision_id=None,
403
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
404
"""Walk the revisions for a branch in merge sorted order.
406
Merge sorted order is the output from a merge-aware,
407
topological sort, i.e. all parents come before their
408
children going forward; the opposite for reverse.
410
:param start_revision_id: the revision_id to begin walking from.
411
If None, the branch tip is used.
412
:param stop_revision_id: the revision_id to terminate the walk
413
after. If None, the rest of history is included.
414
:param stop_rule: if stop_revision_id is not None, the precise rule
415
to use for termination:
416
* 'exclude' - leave the stop revision out of the result (default)
417
* 'include' - the stop revision is the last item in the result
418
* 'with-merges' - include the stop revision and all of its
419
merged revisions in the result
420
* 'with-merges-without-common-ancestry' - filter out revisions
421
that are in both ancestries
422
:param direction: either 'reverse' or 'forward':
423
* reverse means return the start_revision_id first, i.e.
424
start at the most recent revision and go backwards in history
425
* forward returns tuples in the opposite order to reverse.
426
Note in particular that forward does *not* do any intelligent
427
ordering w.r.t. depth as some clients of this API may like.
428
(If required, that ought to be done at higher layers.)
430
:return: an iterator over (revision_id, depth, revno, end_of_merge)
433
* revision_id: the unique id of the revision
434
* depth: How many levels of merging deep this node has been
436
* revno_sequence: This field provides a sequence of
437
revision numbers for all revisions. The format is:
438
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
439
branch that the revno is on. From left to right the REVNO numbers
440
are the sequence numbers within that branch of the revision.
441
* end_of_merge: When True the next node (earlier in history) is
442
part of a different merge.
444
# Note: depth and revno values are in the context of the branch so
445
# we need the full graph to get stable numbers, regardless of the
447
if self._merge_sorted_revisions_cache is None:
448
last_revision = self.last_revision()
449
known_graph = self.repository.get_known_graph_ancestry(
451
self._merge_sorted_revisions_cache = known_graph.merge_sort(
453
filtered = self._filter_merge_sorted_revisions(
454
self._merge_sorted_revisions_cache, start_revision_id,
455
stop_revision_id, stop_rule)
456
# Make sure we don't return revisions that are not part of the
457
# start_revision_id ancestry.
458
filtered = self._filter_start_non_ancestors(filtered)
459
if direction == 'reverse':
461
if direction == 'forward':
462
return reversed(list(filtered))
464
raise ValueError('invalid direction %r' % direction)
466
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
467
start_revision_id, stop_revision_id, stop_rule):
468
"""Iterate over an inclusive range of sorted revisions."""
469
rev_iter = iter(merge_sorted_revisions)
470
if start_revision_id is not None:
471
for node in rev_iter:
472
rev_id = node.key[-1]
473
if rev_id != start_revision_id:
476
# The decision to include the start or not
477
# depends on the stop_rule if a stop is provided
478
# so pop this node back into the iterator
479
rev_iter = chain(iter([node]), rev_iter)
481
if stop_revision_id is None:
483
for node in rev_iter:
484
rev_id = node.key[-1]
485
yield (rev_id, node.merge_depth, node.revno,
487
elif stop_rule == 'exclude':
488
for node in rev_iter:
489
rev_id = node.key[-1]
490
if rev_id == stop_revision_id:
492
yield (rev_id, node.merge_depth, node.revno,
494
elif stop_rule == 'include':
495
for node in rev_iter:
496
rev_id = node.key[-1]
497
yield (rev_id, node.merge_depth, node.revno,
499
if rev_id == stop_revision_id:
501
elif stop_rule == 'with-merges-without-common-ancestry':
502
# We want to exclude all revisions that are already part of the
503
# stop_revision_id ancestry.
504
graph = self.repository.get_graph()
505
ancestors = graph.find_unique_ancestors(start_revision_id,
507
for node in rev_iter:
508
rev_id = node.key[-1]
509
if rev_id not in ancestors:
511
yield (rev_id, node.merge_depth, node.revno,
513
elif stop_rule == 'with-merges':
514
stop_rev = self.repository.get_revision(stop_revision_id)
515
if stop_rev.parent_ids:
516
left_parent = stop_rev.parent_ids[0]
518
left_parent = _mod_revision.NULL_REVISION
519
# left_parent is the actual revision we want to stop logging at,
520
# since we want to show the merged revisions after the stop_rev too
521
reached_stop_revision_id = False
522
revision_id_whitelist = []
523
for node in rev_iter:
524
rev_id = node.key[-1]
525
if rev_id == left_parent:
526
# reached the left parent after the stop_revision
528
if (not reached_stop_revision_id or
529
rev_id in revision_id_whitelist):
530
yield (rev_id, node.merge_depth, node.revno,
532
if reached_stop_revision_id or rev_id == stop_revision_id:
533
# only do the merged revs of rev_id from now on
534
rev = self.repository.get_revision(rev_id)
536
reached_stop_revision_id = True
537
revision_id_whitelist.extend(rev.parent_ids)
539
raise ValueError('invalid stop_rule %r' % stop_rule)
541
def _filter_start_non_ancestors(self, rev_iter):
542
# If we started from a dotted revno, we want to consider it as a tip
543
# and don't want to yield revisions that are not part of its
544
# ancestry. Given the order guaranteed by the merge sort, we will see
545
# uninteresting descendants of the first parent of our tip before the
547
first = rev_iter.next()
548
(rev_id, merge_depth, revno, end_of_merge) = first
551
# We start at a mainline revision so by definition, all others
552
# revisions in rev_iter are ancestors
553
for node in rev_iter:
558
pmap = self.repository.get_parent_map([rev_id])
559
parents = pmap.get(rev_id, [])
561
whitelist.update(parents)
563
# If there is no parents, there is nothing of interest left
565
# FIXME: It's hard to test this scenario here as this code is never
566
# called in that case. -- vila 20100322
569
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
571
if rev_id in whitelist:
572
pmap = self.repository.get_parent_map([rev_id])
573
parents = pmap.get(rev_id, [])
574
whitelist.remove(rev_id)
575
whitelist.update(parents)
577
# We've reached the mainline, there is nothing left to
581
# A revision that is not part of the ancestry of our
584
yield (rev_id, merge_depth, revno, end_of_merge)
586
def leave_lock_in_place(self):
587
"""Tell this branch object not to release the physical lock when this
590
If lock_write doesn't return a token, then this method is not supported.
592
self.control_files.leave_in_place()
594
def dont_leave_lock_in_place(self):
595
"""Tell this branch object to release the physical lock when this
596
object is unlocked, even if it didn't originally acquire it.
598
If lock_write doesn't return a token, then this method is not supported.
600
self.control_files.dont_leave_in_place()
188
602
def bind(self, other):
189
603
"""Bind the local branch the other branch.
272
698
The delta is relative to its mainline predecessor, or the
273
699
empty tree for revision 1.
275
assert isinstance(revno, int)
276
701
rh = self.revision_history()
277
702
if not (1 <= revno <= len(rh)):
278
raise InvalidRevisionNumber(revno)
703
raise errors.InvalidRevisionNumber(revno)
279
704
return self.repository.get_revision_delta(rh[revno-1])
281
def get_root_id(self):
282
"""Return the id of this branches root"""
283
raise NotImplementedError(self.get_root_id)
706
def get_stacked_on_url(self):
707
"""Get the URL this branch is stacked against.
709
:raises NotStacked: If the branch is not stacked.
710
:raises UnstackableBranchFormat: If the branch does not support
713
raise NotImplementedError(self.get_stacked_on_url)
285
715
def print_file(self, file, revision_id):
286
716
"""Print `file` to stdout."""
287
717
raise NotImplementedError(self.print_file)
289
def append_revision(self, *revision_ids):
290
raise NotImplementedError(self.append_revision)
292
719
def set_revision_history(self, rev_history):
293
720
raise NotImplementedError(self.set_revision_history)
723
def set_parent(self, url):
724
"""See Branch.set_parent."""
725
# TODO: Maybe delete old location files?
726
# URLs should never be unicode, even on the local fs,
727
# FIXUP this and get_parent in a future branch format bump:
728
# read and rewrite the file. RBC 20060125
730
if isinstance(url, unicode):
732
url = url.encode('ascii')
733
except UnicodeEncodeError:
734
raise errors.InvalidURL(url,
735
"Urls must be 7-bit ascii, "
736
"use bzrlib.urlutils.escape")
737
url = urlutils.relative_url(self.base, url)
738
self._set_parent_location(url)
741
def set_stacked_on_url(self, url):
742
"""Set the URL this branch is stacked against.
744
:raises UnstackableBranchFormat: If the branch does not support
746
:raises UnstackableRepositoryFormat: If the repository does not support
749
if not self._format.supports_stacking():
750
raise errors.UnstackableBranchFormat(self._format, self.user_url)
751
# XXX: Changing from one fallback repository to another does not check
752
# that all the data you need is present in the new fallback.
753
# Possibly it should.
754
self._check_stackable_repo()
757
old_url = self.get_stacked_on_url()
758
except (errors.NotStacked, errors.UnstackableBranchFormat,
759
errors.UnstackableRepositoryFormat):
763
self._activate_fallback_location(url)
764
# write this out after the repository is stacked to avoid setting a
765
# stacked config that doesn't work.
766
self._set_config_location('stacked_on_location', url)
769
"""Change a branch to be unstacked, copying data as needed.
771
Don't call this directly, use set_stacked_on_url(None).
773
pb = ui.ui_factory.nested_progress_bar()
775
pb.update("Unstacking")
776
# The basic approach here is to fetch the tip of the branch,
777
# including all available ghosts, from the existing stacked
778
# repository into a new repository object without the fallbacks.
780
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
781
# correct for CHKMap repostiories
782
old_repository = self.repository
783
if len(old_repository._fallback_repositories) != 1:
784
raise AssertionError("can't cope with fallback repositories "
785
"of %r" % (self.repository,))
786
# unlock it, including unlocking the fallback
787
old_repository.unlock()
788
old_repository.lock_read()
790
# Repositories don't offer an interface to remove fallback
791
# repositories today; take the conceptually simpler option and just
792
# reopen it. We reopen it starting from the URL so that we
793
# get a separate connection for RemoteRepositories and can
794
# stream from one of them to the other. This does mean doing
795
# separate SSH connection setup, but unstacking is not a
796
# common operation so it's tolerable.
797
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
798
new_repository = new_bzrdir.find_repository()
799
self.repository = new_repository
800
if self.repository._fallback_repositories:
801
raise AssertionError("didn't expect %r to have "
802
"fallback_repositories"
803
% (self.repository,))
804
# this is not paired with an unlock because it's just restoring
805
# the previous state; the lock's released when set_stacked_on_url
807
self.repository.lock_write()
808
# XXX: If you unstack a branch while it has a working tree
809
# with a pending merge, the pending-merged revisions will no
810
# longer be present. You can (probably) revert and remerge.
812
# XXX: This only fetches up to the tip of the repository; it
813
# doesn't bring across any tags. That's fairly consistent
814
# with how branch works, but perhaps not ideal.
815
self.repository.fetch(old_repository,
816
revision_id=self.last_revision(),
819
old_repository.unlock()
823
def _set_tags_bytes(self, bytes):
824
"""Mirror method for _get_tags_bytes.
826
:seealso: Branch._get_tags_bytes.
828
return _run_with_write_locked_target(self, self._transport.put_bytes,
831
def _cache_revision_history(self, rev_history):
832
"""Set the cached revision history to rev_history.
834
The revision_history method will use this cache to avoid regenerating
835
the revision history.
837
This API is semi-public; it only for use by subclasses, all other code
838
should consider it to be private.
840
self._revision_history_cache = rev_history
842
def _cache_revision_id_to_revno(self, revision_id_to_revno):
843
"""Set the cached revision_id => revno map to revision_id_to_revno.
845
This API is semi-public; it only for use by subclasses, all other code
846
should consider it to be private.
848
self._revision_id_to_revno_cache = revision_id_to_revno
850
def _clear_cached_state(self):
851
"""Clear any cached data on this branch, e.g. cached revision history.
853
This means the next call to revision_history will need to call
854
_gen_revision_history.
856
This API is semi-public; it only for use by subclasses, all other code
857
should consider it to be private.
859
self._revision_history_cache = None
860
self._revision_id_to_revno_cache = None
861
self._last_revision_info_cache = None
862
self._merge_sorted_revisions_cache = None
863
self._partial_revision_history_cache = []
864
self._partial_revision_id_to_revno_cache = {}
866
def _gen_revision_history(self):
867
"""Return sequence of revision hashes on to this branch.
869
Unlike revision_history, this method always regenerates or rereads the
870
revision history, i.e. it does not cache the result, so repeated calls
873
Concrete subclasses should override this instead of revision_history so
874
that subclasses do not need to deal with caching logic.
876
This API is semi-public; it only for use by subclasses, all other code
877
should consider it to be private.
879
raise NotImplementedError(self._gen_revision_history)
295
882
def revision_history(self):
296
"""Return sequence of revision hashes on to this branch."""
297
raise NotImplementedError('revision_history is abstract')
883
"""Return sequence of revision ids on this branch.
885
This method will cache the revision history for as long as it is safe to
888
if 'evil' in debug.debug_flags:
889
mutter_callsite(3, "revision_history scales with history.")
890
if self._revision_history_cache is not None:
891
history = self._revision_history_cache
893
history = self._gen_revision_history()
894
self._cache_revision_history(history)
300
898
"""Return current revision number for this branch.
329
942
common_index = min(self_len, other_len) -1
330
943
if common_index >= 0 and \
331
944
self_history[common_index] != other_history[common_index]:
332
raise DivergedBranches(self, other)
945
raise errors.DivergedBranches(self, other)
334
947
if stop_revision is None:
335
948
stop_revision = other_len
337
assert isinstance(stop_revision, int)
338
950
if stop_revision > other_len:
339
951
raise errors.NoSuchRevision(self, stop_revision)
340
952
return other_history[self_len:stop_revision]
342
def update_revisions(self, other, stop_revision=None):
955
def update_revisions(self, other, stop_revision=None, overwrite=False,
343
957
"""Pull in new perfect-fit revisions.
345
959
:param other: Another Branch to pull from
346
960
:param stop_revision: Updated until the given revision
961
:param overwrite: Always set the branch pointer, rather than checking
962
to see if it is a proper descendant.
963
:param graph: A Graph object that can be used to query history
964
information. This can be None.
349
raise NotImplementedError(self.update_revisions)
967
return InterBranch.get(other, self).update_revisions(stop_revision,
970
def import_last_revision_info(self, source_repo, revno, revid):
971
"""Set the last revision info, importing from another repo if necessary.
973
This is used by the bound branch code to upload a revision to
974
the master branch first before updating the tip of the local branch.
976
:param source_repo: Source repository to optionally fetch from
977
:param revno: Revision number of the new tip
978
:param revid: Revision id of the new tip
980
if not self.repository.has_same_location(source_repo):
981
self.repository.fetch(source_repo, revision_id=revid)
982
self.set_last_revision_info(revno, revid)
351
984
def revision_id_to_revno(self, revision_id):
352
985
"""Given a revision id, return its revno"""
353
if revision_id is None:
986
if _mod_revision.is_null(revision_id):
355
988
history = self.revision_history()
357
990
return history.index(revision_id) + 1
358
991
except ValueError:
359
raise bzrlib.errors.NoSuchRevision(self, revision_id)
992
raise errors.NoSuchRevision(self, revision_id)
361
995
def get_rev_id(self, revno, history=None):
362
996
"""Find the revision id of the specified revno."""
366
history = self.revision_history()
367
if revno <= 0 or revno > len(history):
368
raise bzrlib.errors.NoSuchRevision(self, revno)
369
return history[revno - 1]
371
def pull(self, source, overwrite=False, stop_revision=None):
372
raise NotImplementedError(self.pull)
998
return _mod_revision.NULL_REVISION
999
last_revno, last_revid = self.last_revision_info()
1000
if revno == last_revno:
1002
if revno <= 0 or revno > last_revno:
1003
raise errors.NoSuchRevision(self, revno)
1004
distance_from_last = last_revno - revno
1005
if len(self._partial_revision_history_cache) <= distance_from_last:
1006
self._extend_partial_history(distance_from_last)
1007
return self._partial_revision_history_cache[distance_from_last]
1010
def pull(self, source, overwrite=False, stop_revision=None,
1011
possible_transports=None, *args, **kwargs):
1012
"""Mirror source into this branch.
1014
This branch is considered to be 'local', having low latency.
1016
:returns: PullResult instance
1018
return InterBranch.get(source, self).pull(overwrite=overwrite,
1019
stop_revision=stop_revision,
1020
possible_transports=possible_transports, *args, **kwargs)
1022
def push(self, target, overwrite=False, stop_revision=None, *args,
1024
"""Mirror this branch into target.
1026
This branch is considered to be 'local', having low latency.
1028
return InterBranch.get(self, target).push(overwrite, stop_revision,
1031
def lossy_push(self, target, stop_revision=None):
1032
"""Push deltas into another branch.
1034
:note: This does not, like push, retain the revision ids from
1035
the source branch and will, rather than adding bzr-specific
1036
metadata, push only those semantics of the revision that can be
1037
natively represented by this branch' VCS.
1039
:param target: Target branch
1040
:param stop_revision: Revision to push, defaults to last revision.
1041
:return: BranchPushResult with an extra member revidmap:
1042
A dictionary mapping revision ids from the target branch
1043
to new revision ids in the target branch, for each
1044
revision that was pushed.
1046
inter = InterBranch.get(self, target)
1047
lossy_push = getattr(inter, "lossy_push", None)
1048
if lossy_push is None:
1049
raise errors.LossyPushToSameVCS(self, target)
1050
return lossy_push(stop_revision)
374
1052
def basis_tree(self):
375
1053
"""Return `Tree` object for last revision."""
376
1054
return self.repository.revision_tree(self.last_revision())
378
def rename_one(self, from_rel, to_rel):
381
This can change the directory or the filename or both.
383
raise NotImplementedError(self.rename_one)
385
def move(self, from_paths, to_name):
388
to_name must exist as a versioned directory.
390
If to_name exists and is a directory, the files are moved into
391
it, keeping their old names. If it is a directory,
393
Note that to_name is only the last component of the new name;
394
this doesn't change the directory.
396
This returns a list of (from_path, to_path) pairs for each
399
raise NotImplementedError(self.move)
401
1056
def get_parent(self):
402
1057
"""Return the parent location of the branch.
404
This is the default location for push/pull/missing. The usual
1059
This is the default location for pull/missing. The usual
405
1060
pattern is that the user can override it by specifying a
408
raise NotImplementedError(self.get_parent)
1063
parent = self._get_parent_location()
1066
# This is an old-format absolute path to a local branch
1067
# turn it into a url
1068
if parent.startswith('/'):
1069
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1071
return urlutils.join(self.base[:-1], parent)
1072
except errors.InvalidURLJoin, e:
1073
raise errors.InaccessibleParent(parent, self.user_url)
1075
def _get_parent_location(self):
1076
raise NotImplementedError(self._get_parent_location)
1078
def _set_config_location(self, name, url, config=None,
1079
make_relative=False):
1081
config = self.get_config()
1085
url = urlutils.relative_url(self.base, url)
1086
config.set_user_option(name, url, warn_masked=True)
1088
def _get_config_location(self, name, config=None):
1090
config = self.get_config()
1091
location = config.get_user_option(name)
1096
def get_child_submit_format(self):
1097
"""Return the preferred format of submissions to this branch."""
1098
return self.get_config().get_user_option("child_submit_format")
410
1100
def get_submit_branch(self):
411
1101
"""Return the submit location of the branch.
453
1180
self.check_real_revno(revno)
455
1182
def check_real_revno(self, revno):
457
1184
Check whether a revno corresponds to a real revision.
458
1185
Zero (the NULL revision) is considered invalid
460
1187
if revno < 1 or revno > self.revno():
461
raise InvalidRevisionNumber(revno)
1188
raise errors.InvalidRevisionNumber(revno)
463
1190
@needs_read_lock
464
def clone(self, *args, **kwargs):
1191
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
465
1192
"""Clone this branch into to_bzrdir preserving all semantic values.
1194
Most API users will want 'create_clone_on_transport', which creates a
1195
new bzrdir and branch on the fly.
467
1197
revision_id: if not None, the revision history in the new branch will
468
1198
be truncated to end with revision_id.
470
# for API compatibility, until 0.8 releases we provide the old api:
471
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
472
# after 0.8 releases, the *args and **kwargs should be changed:
473
# def clone(self, to_bzrdir, revision_id=None):
474
if (kwargs.get('to_location', None) or
475
kwargs.get('revision', None) or
476
kwargs.get('basis_branch', None) or
477
(len(args) and isinstance(args[0], basestring))):
478
# backwards compatibility api:
479
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
480
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
483
basis_branch = args[2]
485
basis_branch = kwargs.get('basis_branch', None)
487
basis = basis_branch.bzrdir
492
revision_id = args[1]
494
revision_id = kwargs.get('revision', None)
499
# no default to raise if not provided.
500
url = kwargs.get('to_location')
501
return self.bzrdir.clone(url,
502
revision_id=revision_id,
503
basis=basis).open_branch()
505
# generate args by hand
507
revision_id = args[1]
509
revision_id = kwargs.get('revision_id', None)
513
# no default to raise if not provided.
514
to_bzrdir = kwargs.get('to_bzrdir')
515
result = self._format.initialize(to_bzrdir)
516
self.copy_content_into(result, revision_id=revision_id)
1200
result = to_bzrdir.create_branch()
1203
if repository_policy is not None:
1204
repository_policy.configure_branch(result)
1205
self.copy_content_into(result, revision_id=revision_id)
519
1210
@needs_read_lock
520
def sprout(self, to_bzrdir, revision_id=None):
1211
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
521
1212
"""Create a new line of development from the branch, into to_bzrdir.
1214
to_bzrdir controls the branch format.
523
1216
revision_id: if not None, the revision history in the new branch will
524
1217
be truncated to end with revision_id.
526
result = self._format.initialize(to_bzrdir)
527
self.copy_content_into(result, revision_id=revision_id)
528
result.set_parent(self.bzrdir.root_transport.base)
1219
if (repository_policy is not None and
1220
repository_policy.requires_stacking()):
1221
to_bzrdir._format.require_stacking(_skip_repo=True)
1222
result = to_bzrdir.create_branch()
1225
if repository_policy is not None:
1226
repository_policy.configure_branch(result)
1227
self.copy_content_into(result, revision_id=revision_id)
1228
result.set_parent(self.bzrdir.root_transport.base)
1233
def _synchronize_history(self, destination, revision_id):
1234
"""Synchronize last revision and revision history between branches.
1236
This version is most efficient when the destination is also a
1237
BzrBranch6, but works for BzrBranch5, as long as the destination's
1238
repository contains all the lefthand ancestors of the intended
1239
last_revision. If not, set_last_revision_info will fail.
1241
:param destination: The branch to copy the history into
1242
:param revision_id: The revision-id to truncate history at. May
1243
be None to copy complete history.
1245
source_revno, source_revision_id = self.last_revision_info()
1246
if revision_id is None:
1247
revno, revision_id = source_revno, source_revision_id
1249
graph = self.repository.get_graph()
1251
revno = graph.find_distance_to_null(revision_id,
1252
[(source_revision_id, source_revno)])
1253
except errors.GhostRevisionsHaveNoRevno:
1254
# Default to 1, if we can't find anything else
1256
destination.set_last_revision_info(revno, revision_id)
531
1258
@needs_read_lock
532
1259
def copy_content_into(self, destination, revision_id=None):
533
1260
"""Copy the content of self into destination.
552
1273
destination.set_parent(parent)
1274
if self._push_should_merge_tags():
1275
self.tags.merge_to(destination.tags)
1277
def update_references(self, target):
1278
if not getattr(self._format, 'supports_reference_locations', False):
1280
reference_dict = self._get_all_reference_info()
1281
if len(reference_dict) == 0:
1283
old_base = self.base
1284
new_base = target.base
1285
target_reference_dict = target._get_all_reference_info()
1286
for file_id, (tree_path, branch_location) in (
1287
reference_dict.items()):
1288
branch_location = urlutils.rebase_url(branch_location,
1290
target_reference_dict.setdefault(
1291
file_id, (tree_path, branch_location))
1292
target._set_all_reference_info(target_reference_dict)
554
1294
@needs_read_lock
1295
def check(self, refs):
556
1296
"""Check consistency of the branch.
558
1298
In particular this checks that revisions given in the revision-history
559
do actually match up in the revision graph, and that they're all
1299
do actually match up in the revision graph, and that they're all
560
1300
present in the repository.
562
1302
Callers will typically also want to check the repository.
1304
:param refs: Calculated refs for this branch as specified by
1305
branch._get_check_refs()
564
1306
:return: A BranchCheckResult.
566
mainline_parent_id = None
567
for revision_id in self.revision_history():
569
revision = self.repository.get_revision(revision_id)
570
except errors.NoSuchRevision, e:
571
raise errors.BzrCheckError("mainline revision {%s} not in repository"
573
# In general the first entry on the revision history has no parents.
574
# But it's not illegal for it to have parents listed; this can happen
575
# in imports from Arch when the parents weren't reachable.
576
if mainline_parent_id is not None:
577
if mainline_parent_id not in revision.parent_ids:
578
raise errors.BzrCheckError("previous revision {%s} not listed among "
580
% (mainline_parent_id, revision_id))
581
mainline_parent_id = revision_id
582
return BranchCheckResult(self)
1308
result = BranchCheckResult(self)
1309
last_revno, last_revision_id = self.last_revision_info()
1310
actual_revno = refs[('lefthand-distance', last_revision_id)]
1311
if actual_revno != last_revno:
1312
result.errors.append(errors.BzrCheckError(
1313
'revno does not match len(mainline) %s != %s' % (
1314
last_revno, actual_revno)))
1315
# TODO: We should probably also check that self.revision_history
1316
# matches the repository for older branch formats.
1317
# If looking for the code that cross-checks repository parents against
1318
# the iter_reverse_revision_history output, that is now a repository
584
1322
def _get_checkout_format(self):
585
1323
"""Return the most suitable metadir for a checkout of this branch.
586
Weaves are used if this branch's repostory uses weaves.
1324
Weaves are used if this branch's repository uses weaves.
588
1326
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
589
from bzrlib import repository
1327
from bzrlib.repofmt import weaverepo
590
1328
format = bzrdir.BzrDirMetaFormat1()
591
format.repository_format = repository.RepositoryFormat7()
1329
format.repository_format = weaverepo.RepositoryFormat7()
593
format = self.repository.bzrdir.cloning_metadir()
1331
format = self.repository.bzrdir.checkout_metadir()
1332
format.set_branch_format(self._format)
596
def create_checkout(self, to_location, revision_id=None,
1335
def create_clone_on_transport(self, to_transport, revision_id=None,
1336
stacked_on=None, create_prefix=False, use_existing_dir=False):
1337
"""Create a clone of this branch and its bzrdir.
1339
:param to_transport: The transport to clone onto.
1340
:param revision_id: The revision id to use as tip in the new branch.
1341
If None the tip is obtained from this branch.
1342
:param stacked_on: An optional URL to stack the clone on.
1343
:param create_prefix: Create any missing directories leading up to
1345
:param use_existing_dir: Use an existing directory if one exists.
1347
# XXX: Fix the bzrdir API to allow getting the branch back from the
1348
# clone call. Or something. 20090224 RBC/spiv.
1349
if revision_id is None:
1350
revision_id = self.last_revision()
1351
dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
revision_id=revision_id, stacked_on=stacked_on,
1353
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1354
return dir_to.open_branch()
1356
def create_checkout(self, to_location, revision_id=None,
1357
lightweight=False, accelerator_tree=None,
598
1359
"""Create a checkout of a branch.
600
1361
:param to_location: The url to produce the checkout at
601
1362
:param revision_id: The revision to check out
602
1363
:param lightweight: If True, produce a lightweight checkout, otherwise,
603
1364
produce a bound branch (heavyweight checkout)
1365
:param accelerator_tree: A tree which can be used for retrieving file
1366
contents more quickly than the revision tree, i.e. a workingtree.
1367
The revision tree will be used for cases where accelerator_tree's
1368
content is different.
1369
:param hardlink: If true, hard-link files from accelerator_tree,
604
1371
:return: The tree of the created checkout
606
1373
t = transport.get_transport(to_location)
609
except errors.FileExists:
612
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
613
BranchReferenceFormat().initialize(checkout, self)
1376
format = self._get_checkout_format()
1377
checkout = format.initialize_on_transport(t)
1378
from_branch = BranchReferenceFormat().initialize(checkout,
615
1381
format = self._get_checkout_format()
616
1382
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
617
1383
to_location, force_new_tree=False, format=format)
618
1384
checkout = checkout_branch.bzrdir
619
1385
checkout_branch.bind(self)
620
if revision_id is not None:
621
rh = checkout_branch.revision_history()
622
new_rh = rh[:rh.index(revision_id) + 1]
623
checkout_branch.set_revision_history(new_rh)
624
return checkout.create_workingtree(revision_id)
1386
# pull up to the specified revision_id to set the initial
1387
# branch tip correctly, and seed it with history.
1388
checkout_branch.pull(self, stop_revision=revision_id)
1390
tree = checkout.create_workingtree(revision_id,
1391
from_branch=from_branch,
1392
accelerator_tree=accelerator_tree,
1394
basis_tree = tree.basis_tree()
1395
basis_tree.lock_read()
1397
for path, file_id in basis_tree.iter_references():
1398
reference_parent = self.reference_parent(file_id, path)
1399
reference_parent.create_checkout(tree.abspath(path),
1400
basis_tree.get_reference_revision(file_id, path),
1407
def reconcile(self, thorough=True):
1408
"""Make sure the data stored in this branch is consistent."""
1409
from bzrlib.reconcile import BranchReconciler
1410
reconciler = BranchReconciler(self, thorough=thorough)
1411
reconciler.reconcile()
1414
def reference_parent(self, file_id, path, possible_transports=None):
1415
"""Return the parent branch for a tree-reference file_id
1416
:param file_id: The file_id of the tree reference
1417
:param path: The path of the file_id in the tree
1418
:return: A branch associated with the file_id
1420
# FIXME should provide multiple branches, based on config
1421
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1422
possible_transports=possible_transports)
1424
def supports_tags(self):
1425
return self._format.supports_tags()
1427
def automatic_tag_name(self, revision_id):
1428
"""Try to automatically find the tag name for a revision.
1430
:param revision_id: Revision id of the revision.
1431
:return: A tag name or None if no tag name could be determined.
1433
for hook in Branch.hooks['automatic_tag_name']:
1434
ret = hook(self, revision_id)
1439
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1441
"""Ensure that revision_b is a descendant of revision_a.
1443
This is a helper function for update_revisions.
1445
:raises: DivergedBranches if revision_b has diverged from revision_a.
1446
:returns: True if revision_b is a descendant of revision_a.
1448
relation = self._revision_relations(revision_a, revision_b, graph)
1449
if relation == 'b_descends_from_a':
1451
elif relation == 'diverged':
1452
raise errors.DivergedBranches(self, other_branch)
1453
elif relation == 'a_descends_from_b':
1456
raise AssertionError("invalid relation: %r" % (relation,))
1458
def _revision_relations(self, revision_a, revision_b, graph):
1459
"""Determine the relationship between two revisions.
1461
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1463
heads = graph.heads([revision_a, revision_b])
1464
if heads == set([revision_b]):
1465
return 'b_descends_from_a'
1466
elif heads == set([revision_a, revision_b]):
1467
# These branches have diverged
1469
elif heads == set([revision_a]):
1470
return 'a_descends_from_b'
1472
raise AssertionError("invalid heads: %r" % (heads,))
627
1475
class BranchFormat(object):
649
1497
"""The known formats."""
1499
can_set_append_revisions_only = True
1501
def __eq__(self, other):
1502
return self.__class__ is other.__class__
1504
def __ne__(self, other):
1505
return not (self == other)
652
def find_format(klass, a_bzrdir):
1508
def find_format(klass, a_bzrdir, name=None):
653
1509
"""Return the format for the branch object in a_bzrdir."""
655
transport = a_bzrdir.get_branch_transport(None)
656
format_string = transport.get("format").read()
1511
transport = a_bzrdir.get_branch_transport(None, name=name)
1512
format_string = transport.get_bytes("format")
657
1513
return klass._formats[format_string]
659
raise NotBranchError(path=transport.base)
1514
except errors.NoSuchFile:
1515
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
660
1516
except KeyError:
661
raise errors.UnknownFormatError(format=format_string)
1517
raise errors.UnknownFormatError(format=format_string, kind='branch')
664
1520
def get_default_format(klass):
665
1521
"""Return the current default format."""
666
1522
return klass._default_format
1524
def get_reference(self, a_bzrdir):
1525
"""Get the target reference of the branch in a_bzrdir.
1527
format probing must have been completed before calling
1528
this method - it is assumed that the format of the branch
1529
in a_bzrdir is correct.
1531
:param a_bzrdir: The bzrdir to get the branch data from.
1532
:return: None if the branch is not a reference branch.
1537
def set_reference(self, a_bzrdir, to_branch):
1538
"""Set the target reference of the branch in a_bzrdir.
1540
format probing must have been completed before calling
1541
this method - it is assumed that the format of the branch
1542
in a_bzrdir is correct.
1544
:param a_bzrdir: The bzrdir to set the branch reference for.
1545
:param to_branch: branch that the checkout is to reference
1547
raise NotImplementedError(self.set_reference)
668
1549
def get_format_string(self):
669
1550
"""Return the ASCII format string that identifies this format."""
670
1551
raise NotImplementedError(self.get_format_string)
672
1553
def get_format_description(self):
673
1554
"""Return the short format description for this format."""
674
raise NotImplementedError(self.get_format_string)
676
def initialize(self, a_bzrdir):
677
"""Create a branch of this format in a_bzrdir."""
1555
raise NotImplementedError(self.get_format_description)
1557
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1558
hooks = Branch.hooks['post_branch_init']
1561
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1565
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
lock_type='metadir', set_format=True):
1567
"""Initialize a branch in a bzrdir, with specified files
1569
:param a_bzrdir: The bzrdir to initialize the branch in
1570
:param utf8_files: The files to create as a list of
1571
(filename, content) tuples
1572
:param name: Name of colocated branch to create, if any
1573
:param set_format: If True, set the format with
1574
self.get_format_string. (BzrBranch4 has its format set
1576
:return: a branch in this format
1578
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1581
'metadir': ('lock', lockdir.LockDir),
1582
'branch4': ('branch-lock', lockable_files.TransportLock),
1584
lock_name, lock_class = lock_map[lock_type]
1585
control_files = lockable_files.LockableFiles(branch_transport,
1586
lock_name, lock_class)
1587
control_files.create_lock()
1589
control_files.lock_write()
1590
except errors.LockContention:
1591
if lock_type != 'branch4':
1597
utf8_files += [('format', self.get_format_string())]
1599
for (filename, content) in utf8_files:
1600
branch_transport.put_bytes(
1602
mode=a_bzrdir._get_file_mode())
1605
control_files.unlock()
1606
branch = self.open(a_bzrdir, name, _found=True)
1607
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1610
def initialize(self, a_bzrdir, name=None):
1611
"""Create a branch of this format in a_bzrdir.
1613
:param name: Name of the colocated branch to create.
678
1615
raise NotImplementedError(self.initialize)
680
1617
def is_supported(self):
681
1618
"""Is this format supported?
683
1620
Supported formats can be initialized and opened.
684
Unsupported formats may not support initialization or committing or
1621
Unsupported formats may not support initialization or committing or
685
1622
some other features depending on the reason for not being supported.
689
def open(self, a_bzrdir, _found=False):
1626
def make_tags(self, branch):
1627
"""Create a tags object for branch.
1629
This method is on BranchFormat, because BranchFormats are reflected
1630
over the wire via network_name(), whereas full Branch instances require
1631
multiple VFS method calls to operate at all.
1633
The default implementation returns a disabled-tags instance.
1635
Note that it is normal for branch to be a RemoteBranch when using tags
1638
return DisabledTags(branch)
1640
def network_name(self):
1641
"""A simple byte string uniquely identifying this format for RPC calls.
1643
MetaDir branch formats use their disk format string to identify the
1644
repository over the wire. All in one formats such as bzr < 0.8, and
1645
foreign formats like svn/git and hg should use some marker which is
1646
unique and immutable.
1648
raise NotImplementedError(self.network_name)
1650
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
690
1651
"""Return the branch object for a_bzrdir
692
_found is a private parameter, do not use it. It is used to indicate
693
if format probing has already be done.
1653
:param a_bzrdir: A BzrDir that contains a branch.
1654
:param name: Name of colocated branch to open
1655
:param _found: a private parameter, do not use it. It is used to
1656
indicate if format probing has already be done.
1657
:param ignore_fallbacks: when set, no fallback branches will be opened
1658
(if there are any). Default is to open fallbacks.
695
1660
raise NotImplementedError(self.open)
698
1663
def register_format(klass, format):
1664
"""Register a metadir format."""
699
1665
klass._formats[format.get_format_string()] = format
1666
# Metadir formats have a network name of their format string, and get
1667
# registered as class factories.
1668
network_format_registry.register(format.get_format_string(), format.__class__)
702
1671
def set_default_format(klass, format):
703
1672
klass._default_format = format
1674
def supports_set_append_revisions_only(self):
1675
"""True if this format supports set_append_revisions_only."""
1678
def supports_stacking(self):
1679
"""True if this format records a stacked-on branch."""
706
1683
def unregister_format(klass, format):
707
assert klass._formats[format.get_format_string()] is format
708
1684
del klass._formats[format.get_format_string()]
710
1686
def __str__(self):
711
return self.get_format_string().rstrip()
1687
return self.get_format_description().rstrip()
1689
def supports_tags(self):
1690
"""True if this format supports tags stored in the branch"""
1691
return False # by default
1694
class BranchHooks(Hooks):
1695
"""A dictionary mapping hook name to a list of callables for branch hooks.
1697
e.g. ['set_rh'] Is the list of items to be called when the
1698
set_revision_history function is invoked.
1702
"""Create the default hooks.
1704
These are all empty initially, because by default nothing should get
1707
Hooks.__init__(self)
1708
self.create_hook(HookPoint('set_rh',
1709
"Invoked whenever the revision history has been set via "
1710
"set_revision_history. The api signature is (branch, "
1711
"revision_history), and the branch will be write-locked. "
1712
"The set_rh hook can be expensive for bzr to trigger, a better "
1713
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1714
self.create_hook(HookPoint('open',
1715
"Called with the Branch object that has been opened after a "
1716
"branch is opened.", (1, 8), None))
1717
self.create_hook(HookPoint('post_push',
1718
"Called after a push operation completes. post_push is called "
1719
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
"bzr client.", (0, 15), None))
1721
self.create_hook(HookPoint('post_pull',
1722
"Called after a pull operation completes. post_pull is called "
1723
"with a bzrlib.branch.PullResult object and only runs in the "
1724
"bzr client.", (0, 15), None))
1725
self.create_hook(HookPoint('pre_commit',
1726
"Called after a commit is calculated but before it is is "
1727
"completed. pre_commit is called with (local, master, old_revno, "
1728
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
"). old_revid is NULL_REVISION for the first commit to a branch, "
1730
"tree_delta is a TreeDelta object describing changes from the "
1731
"basis revision. hooks MUST NOT modify this delta. "
1732
" future_tree is an in-memory tree obtained from "
1733
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
"tree.", (0,91), None))
1735
self.create_hook(HookPoint('post_commit',
1736
"Called in the bzr client after a commit has completed. "
1737
"post_commit is called with (local, master, old_revno, old_revid, "
1738
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1739
"commit to a branch.", (0, 15), None))
1740
self.create_hook(HookPoint('post_uncommit',
1741
"Called in the bzr client after an uncommit completes. "
1742
"post_uncommit is called with (local, master, old_revno, "
1743
"old_revid, new_revno, new_revid) where local is the local branch "
1744
"or None, master is the target branch, and an empty branch "
1745
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1746
self.create_hook(HookPoint('pre_change_branch_tip',
1747
"Called in bzr client and server before a change to the tip of a "
1748
"branch is made. pre_change_branch_tip is called with a "
1749
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1750
"commit, uncommit will all trigger this hook.", (1, 6), None))
1751
self.create_hook(HookPoint('post_change_branch_tip',
1752
"Called in bzr client and server after a change to the tip of a "
1753
"branch is made. post_change_branch_tip is called with a "
1754
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1755
"commit, uncommit will all trigger this hook.", (1, 4), None))
1756
self.create_hook(HookPoint('transform_fallback_location',
1757
"Called when a stacked branch is activating its fallback "
1758
"locations. transform_fallback_location is called with (branch, "
1759
"url), and should return a new url. Returning the same url "
1760
"allows it to be used as-is, returning a different one can be "
1761
"used to cause the branch to stack on a closer copy of that "
1762
"fallback_location. Note that the branch cannot have history "
1763
"accessing methods called on it during this hook because the "
1764
"fallback locations have not been activated. When there are "
1765
"multiple hooks installed for transform_fallback_location, "
1766
"all are called with the url returned from the previous hook."
1767
"The order is however undefined.", (1, 9), None))
1768
self.create_hook(HookPoint('automatic_tag_name',
1769
"Called to determine an automatic tag name for a revision."
1770
"automatic_tag_name is called with (branch, revision_id) and "
1771
"should return a tag name or None if no tag name could be "
1772
"determined. The first non-None tag name returned will be used.",
1774
self.create_hook(HookPoint('post_branch_init',
1775
"Called after new branch initialization completes. "
1776
"post_branch_init is called with a "
1777
"bzrlib.branch.BranchInitHookParams. "
1778
"Note that init, branch and checkout (both heavyweight and "
1779
"lightweight) will all trigger this hook.", (2, 2), None))
1780
self.create_hook(HookPoint('post_switch',
1781
"Called after a checkout switches branch. "
1782
"post_switch is called with a "
1783
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1787
# install the default hooks into the Branch class.
1788
Branch.hooks = BranchHooks()
1791
class ChangeBranchTipParams(object):
1792
"""Object holding parameters passed to *_change_branch_tip hooks.
1794
There are 5 fields that hooks may wish to access:
1796
:ivar branch: the branch being changed
1797
:ivar old_revno: revision number before the change
1798
:ivar new_revno: revision number after the change
1799
:ivar old_revid: revision id before the change
1800
:ivar new_revid: revision id after the change
1802
The revid fields are strings. The revno fields are integers.
1805
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1806
"""Create a group of ChangeBranchTip parameters.
1808
:param branch: The branch being changed.
1809
:param old_revno: Revision number before the change.
1810
:param new_revno: Revision number after the change.
1811
:param old_revid: Tip revision id before the change.
1812
:param new_revid: Tip revision id after the change.
1814
self.branch = branch
1815
self.old_revno = old_revno
1816
self.new_revno = new_revno
1817
self.old_revid = old_revid
1818
self.new_revid = new_revid
1820
def __eq__(self, other):
1821
return self.__dict__ == other.__dict__
1824
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1825
self.__class__.__name__, self.branch,
1826
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1829
class BranchInitHookParams(object):
1830
"""Object holding parameters passed to *_branch_init hooks.
1832
There are 4 fields that hooks may wish to access:
1834
:ivar format: the branch format
1835
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1836
:ivar name: name of colocated branch, if any (or None)
1837
:ivar branch: the branch created
1839
Note that for lightweight checkouts, the bzrdir and format fields refer to
1840
the checkout, hence they are different from the corresponding fields in
1841
branch, which refer to the original branch.
1844
def __init__(self, format, a_bzrdir, name, branch):
1845
"""Create a group of BranchInitHook parameters.
1847
:param format: the branch format
1848
:param a_bzrdir: the BzrDir where the branch will be/has been
1850
:param name: name of colocated branch, if any (or None)
1851
:param branch: the branch created
1853
Note that for lightweight checkouts, the bzrdir and format fields refer
1854
to the checkout, hence they are different from the corresponding fields
1855
in branch, which refer to the original branch.
1857
self.format = format
1858
self.bzrdir = a_bzrdir
1860
self.branch = branch
1862
def __eq__(self, other):
1863
return self.__dict__ == other.__dict__
1867
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1869
return "<%s of format:%s bzrdir:%s>" % (
1870
self.__class__.__name__, self.branch,
1871
self.format, self.bzrdir)
1874
class SwitchHookParams(object):
1875
"""Object holding parameters passed to *_switch hooks.
1877
There are 4 fields that hooks may wish to access:
1879
:ivar control_dir: BzrDir of the checkout to change
1880
:ivar to_branch: branch that the checkout is to reference
1881
:ivar force: skip the check for local commits in a heavy checkout
1882
:ivar revision_id: revision ID to switch to (or None)
1885
def __init__(self, control_dir, to_branch, force, revision_id):
1886
"""Create a group of SwitchHook parameters.
1888
:param control_dir: BzrDir of the checkout to change
1889
:param to_branch: branch that the checkout is to reference
1890
:param force: skip the check for local commits in a heavy checkout
1891
:param revision_id: revision ID to switch to (or None)
1893
self.control_dir = control_dir
1894
self.to_branch = to_branch
1896
self.revision_id = revision_id
1898
def __eq__(self, other):
1899
return self.__dict__ == other.__dict__
1902
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1903
self.control_dir, self.to_branch,
714
1907
class BzrBranchFormat4(BranchFormat):
723
1916
"""See BranchFormat.get_format_description()."""
724
1917
return "Branch format 4"
726
def initialize(self, a_bzrdir):
1919
def initialize(self, a_bzrdir, name=None):
727
1920
"""Create a branch of this format in a_bzrdir."""
728
mutter('creating branch in %s', a_bzrdir.transport.base)
729
branch_transport = a_bzrdir.get_branch_transport(self)
730
1921
utf8_files = [('revision-history', ''),
731
1922
('branch-name', ''),
733
control_files = LockableFiles(branch_transport, 'branch-lock',
735
control_files.create_lock()
736
control_files.lock_write()
738
for file, content in utf8_files:
739
control_files.put_utf8(file, content)
741
control_files.unlock()
742
return self.open(a_bzrdir, _found=True)
1924
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1925
lock_type='branch4', set_format=False)
744
1927
def __init__(self):
745
1928
super(BzrBranchFormat4, self).__init__()
746
1929
self._matchingbzrdir = bzrdir.BzrDirFormat6()
748
def open(self, a_bzrdir, _found=False):
749
"""Return the branch object for a_bzrdir
1931
def network_name(self):
1932
"""The network name for this format is the control dirs disk label."""
1933
return self._matchingbzrdir.get_format_string()
751
_found is a private parameter, do not use it. It is used to indicate
752
if format probing has already be done.
1935
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1936
"""See BranchFormat.open()."""
755
1938
# we are being called directly and must probe.
756
1939
raise NotImplementedError
757
1940
return BzrBranch(_format=self,
758
1941
_control_files=a_bzrdir._control_files,
759
1942
a_bzrdir=a_bzrdir,
760
1944
_repository=a_bzrdir.open_repository())
762
1946
def __str__(self):
763
1947
return "Bazaar-NG branch format 4"
766
class BzrBranchFormat5(BranchFormat):
1950
class BranchFormatMetadir(BranchFormat):
1951
"""Common logic for meta-dir based branch formats."""
1953
def _branch_class(self):
1954
"""What class to instantiate on open calls."""
1955
raise NotImplementedError(self._branch_class)
1957
def network_name(self):
1958
"""A simple byte string uniquely identifying this format for RPC calls.
1960
Metadir branch formats use their format string.
1962
return self.get_format_string()
1964
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1965
"""See BranchFormat.open()."""
1967
format = BranchFormat.find_format(a_bzrdir, name=name)
1968
if format.__class__ != self.__class__:
1969
raise AssertionError("wrong format %r found for %r" %
1971
transport = a_bzrdir.get_branch_transport(None, name=name)
1973
control_files = lockable_files.LockableFiles(transport, 'lock',
1975
return self._branch_class()(_format=self,
1976
_control_files=control_files,
1979
_repository=a_bzrdir.find_repository(),
1980
ignore_fallbacks=ignore_fallbacks)
1981
except errors.NoSuchFile:
1982
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1985
super(BranchFormatMetadir, self).__init__()
1986
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1987
self._matchingbzrdir.set_branch_format(self)
1989
def supports_tags(self):
1993
class BzrBranchFormat5(BranchFormatMetadir):
767
1994
"""Bzr branch format 5.
769
1996
This format has:
783
2013
def get_format_description(self):
784
2014
"""See BranchFormat.get_format_description()."""
785
2015
return "Branch format 5"
787
def initialize(self, a_bzrdir):
2017
def initialize(self, a_bzrdir, name=None):
788
2018
"""Create a branch of this format in a_bzrdir."""
789
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
790
branch_transport = a_bzrdir.get_branch_transport(self)
791
2019
utf8_files = [('revision-history', ''),
792
2020
('branch-name', ''),
794
control_files = LockableFiles(branch_transport, 'lock', lockdir.LockDir)
795
control_files.create_lock()
796
control_files.lock_write()
797
control_files.put_utf8('format', self.get_format_string())
799
for file, content in utf8_files:
800
control_files.put_utf8(file, content)
802
control_files.unlock()
803
return self.open(a_bzrdir, _found=True, )
2022
return self._initialize_helper(a_bzrdir, utf8_files, name)
2024
def supports_tags(self):
2028
class BzrBranchFormat6(BranchFormatMetadir):
2029
"""Branch format with last-revision and tags.
2031
Unlike previous formats, this has no explicit revision history. Instead,
2032
this just stores the last-revision, and the left-hand history leading
2033
up to there is the history.
2035
This format was introduced in bzr 0.15
2036
and became the default in 0.91.
2039
def _branch_class(self):
2042
def get_format_string(self):
2043
"""See BranchFormat.get_format_string()."""
2044
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2046
def get_format_description(self):
2047
"""See BranchFormat.get_format_description()."""
2048
return "Branch format 6"
2050
def initialize(self, a_bzrdir, name=None):
2051
"""Create a branch of this format in a_bzrdir."""
2052
utf8_files = [('last-revision', '0 null:\n'),
2053
('branch.conf', ''),
2056
return self._initialize_helper(a_bzrdir, utf8_files, name)
2058
def make_tags(self, branch):
2059
"""See bzrlib.branch.BranchFormat.make_tags()."""
2060
return BasicTags(branch)
2062
def supports_set_append_revisions_only(self):
2066
class BzrBranchFormat8(BranchFormatMetadir):
2067
"""Metadir format supporting storing locations of subtree branches."""
2069
def _branch_class(self):
2072
def get_format_string(self):
2073
"""See BranchFormat.get_format_string()."""
2074
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2076
def get_format_description(self):
2077
"""See BranchFormat.get_format_description()."""
2078
return "Branch format 8"
2080
def initialize(self, a_bzrdir, name=None):
2081
"""Create a branch of this format in a_bzrdir."""
2082
utf8_files = [('last-revision', '0 null:\n'),
2083
('branch.conf', ''),
2087
return self._initialize_helper(a_bzrdir, utf8_files, name)
805
2089
def __init__(self):
806
super(BzrBranchFormat5, self).__init__()
807
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
809
def open(self, a_bzrdir, _found=False):
810
"""Return the branch object for a_bzrdir
812
_found is a private parameter, do not use it. It is used to indicate
813
if format probing has already be done.
816
format = BranchFormat.find_format(a_bzrdir)
817
assert format.__class__ == self.__class__
818
transport = a_bzrdir.get_branch_transport(None)
819
control_files = LockableFiles(transport, 'lock', lockdir.LockDir)
820
return BzrBranch5(_format=self,
821
_control_files=control_files,
823
_repository=a_bzrdir.find_repository())
826
return "Bazaar-NG Metadir branch format 5"
2090
super(BzrBranchFormat8, self).__init__()
2091
self._matchingbzrdir.repository_format = \
2092
RepositoryFormatKnitPack5RichRoot()
2094
def make_tags(self, branch):
2095
"""See bzrlib.branch.BranchFormat.make_tags()."""
2096
return BasicTags(branch)
2098
def supports_set_append_revisions_only(self):
2101
def supports_stacking(self):
2104
supports_reference_locations = True
2107
class BzrBranchFormat7(BzrBranchFormat8):
2108
"""Branch format with last-revision, tags, and a stacked location pointer.
2110
The stacked location pointer is passed down to the repository and requires
2111
a repository format with supports_external_lookups = True.
2113
This format was introduced in bzr 1.6.
2116
def initialize(self, a_bzrdir, name=None):
2117
"""Create a branch of this format in a_bzrdir."""
2118
utf8_files = [('last-revision', '0 null:\n'),
2119
('branch.conf', ''),
2122
return self._initialize_helper(a_bzrdir, utf8_files, name)
2124
def _branch_class(self):
2127
def get_format_string(self):
2128
"""See BranchFormat.get_format_string()."""
2129
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2131
def get_format_description(self):
2132
"""See BranchFormat.get_format_description()."""
2133
return "Branch format 7"
2135
def supports_set_append_revisions_only(self):
2138
supports_reference_locations = False
829
2141
class BranchReferenceFormat(BranchFormat):
844
2156
def get_format_description(self):
845
2157
"""See BranchFormat.get_format_description()."""
846
2158
return "Checkout reference format 1"
848
def initialize(self, a_bzrdir, target_branch=None):
2160
def get_reference(self, a_bzrdir):
2161
"""See BranchFormat.get_reference()."""
2162
transport = a_bzrdir.get_branch_transport(None)
2163
return transport.get_bytes('location')
2165
def set_reference(self, a_bzrdir, to_branch):
2166
"""See BranchFormat.set_reference()."""
2167
transport = a_bzrdir.get_branch_transport(None)
2168
location = transport.put_bytes('location', to_branch.base)
2170
def initialize(self, a_bzrdir, name=None, target_branch=None):
849
2171
"""Create a branch of this format in a_bzrdir."""
850
2172
if target_branch is None:
851
2173
# this format does not implement branch itself, thus the implicit
852
2174
# creation contract must see it as uninitializable
853
2175
raise errors.UninitializableFormat(self)
854
mutter('creating branch reference in %s', a_bzrdir.transport.base)
855
branch_transport = a_bzrdir.get_branch_transport(self)
2176
mutter('creating branch reference in %s', a_bzrdir.user_url)
2177
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
856
2178
branch_transport.put_bytes('location',
857
target_branch.bzrdir.root_transport.base)
2179
target_branch.bzrdir.user_url)
858
2180
branch_transport.put_bytes('format', self.get_format_string())
859
return self.open(a_bzrdir, _found=True)
2182
a_bzrdir, name, _found=True,
2183
possible_transports=[target_branch.bzrdir.root_transport])
2184
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
861
2187
def __init__(self):
862
2188
super(BranchReferenceFormat, self).__init__()
863
2189
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2190
self._matchingbzrdir.set_branch_format(self)
865
2192
def _make_reference_clone_function(format, a_branch):
866
2193
"""Create a clone() routine for a branch dynamically."""
867
def clone(to_bzrdir, revision_id=None):
2194
def clone(to_bzrdir, revision_id=None,
2195
repository_policy=None):
868
2196
"""See Branch.clone()."""
869
return format.initialize(to_bzrdir, a_branch)
2197
return format.initialize(to_bzrdir, target_branch=a_branch)
870
2198
# cannot obey revision_id limits when cloning a reference ...
871
2199
# FIXME RBC 20060210 either nuke revision_id for clone, or
872
2200
# emit some sort of warning/error to the caller ?!
875
def open(self, a_bzrdir, _found=False):
2203
def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
possible_transports=None, ignore_fallbacks=False):
876
2205
"""Return the branch that the branch reference in a_bzrdir points at.
878
_found is a private parameter, do not use it. It is used to indicate
879
if format probing has already be done.
2207
:param a_bzrdir: A BzrDir that contains a branch.
2208
:param name: Name of colocated branch to open, if any
2209
:param _found: a private parameter, do not use it. It is used to
2210
indicate if format probing has already be done.
2211
:param ignore_fallbacks: when set, no fallback branches will be opened
2212
(if there are any). Default is to open fallbacks.
2213
:param location: The location of the referenced branch. If
2214
unspecified, this will be determined from the branch reference in
2216
:param possible_transports: An optional reusable transports list.
882
format = BranchFormat.find_format(a_bzrdir)
883
assert format.__class__ == self.__class__
884
transport = a_bzrdir.get_branch_transport(None)
885
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
886
result = real_bzrdir.open_branch()
2219
format = BranchFormat.find_format(a_bzrdir, name=name)
2220
if format.__class__ != self.__class__:
2221
raise AssertionError("wrong format %r found for %r" %
2223
if location is None:
2224
location = self.get_reference(a_bzrdir)
2225
real_bzrdir = bzrdir.BzrDir.open(
2226
location, possible_transports=possible_transports)
2227
result = real_bzrdir.open_branch(name=name,
2228
ignore_fallbacks=ignore_fallbacks)
887
2229
# this changes the behaviour of result.clone to create a new reference
888
2230
# rather than a copy of the content of the branch.
889
2231
# I did not use a proxy object because that needs much more extensive
2241
network_format_registry = registry.FormatRegistry()
2242
"""Registry of formats indexed by their network name.
2244
The network name for a branch format is an identifier that can be used when
2245
referring to formats with smart server operations. See
2246
BranchFormat.network_name() for more detail.
899
2250
# formats which have no format string are not discoverable
900
2251
# and not independently creatable, so are not registered.
901
__default_format = BzrBranchFormat5()
902
BranchFormat.register_format(__default_format)
2252
__format5 = BzrBranchFormat5()
2253
__format6 = BzrBranchFormat6()
2254
__format7 = BzrBranchFormat7()
2255
__format8 = BzrBranchFormat8()
2256
BranchFormat.register_format(__format5)
903
2257
BranchFormat.register_format(BranchReferenceFormat())
904
BranchFormat.set_default_format(__default_format)
2258
BranchFormat.register_format(__format6)
2259
BranchFormat.register_format(__format7)
2260
BranchFormat.register_format(__format8)
2261
BranchFormat.set_default_format(__format7)
905
2262
_legacy_formats = [BzrBranchFormat4(),
908
class BzrBranch(Branch):
2264
network_format_registry.register(
2265
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2268
class BzrBranch(Branch, _RelockDebugMixin):
909
2269
"""A branch stored in the actual filesystem.
911
2271
Note that it's "local" in the context of the filesystem; it doesn't
912
2272
really matter if it's on an nfs/smb/afs/coda/... share, as long as
913
2273
it's writable, and can be accessed via the normal filesystem API.
2275
:ivar _transport: Transport for file operations on this branch's
2276
control files, typically pointing to the .bzr/branch directory.
2277
:ivar repository: Repository for this branch.
2278
:ivar base: The url of the base directory for this branch; the one
2279
containing the .bzr directory.
2280
:ivar name: Optional colocated branch name as it exists in the control
916
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
917
relax_version_check=DEPRECATED_PARAMETER, _format=None,
918
_control_files=None, a_bzrdir=None, _repository=None):
919
"""Create new branch object at a particular location.
921
transport -- A Transport object, defining how to access files.
923
init -- If True, create new control files in a previously
924
unversioned directory. If False, the branch must already
927
relax_version_check -- If true, the usual check for the branch
928
version is not applied. This is intended only for
929
upgrade/recovery type use; it's not guaranteed that
930
all operations will work on old format branches.
2284
def __init__(self, _format=None,
2285
_control_files=None, a_bzrdir=None, name=None,
2286
_repository=None, ignore_fallbacks=False):
2287
"""Create new branch object at a particular location."""
932
2288
if a_bzrdir is None:
933
self.bzrdir = bzrdir.BzrDir.open(transport.base)
2289
raise ValueError('a_bzrdir must be supplied')
935
2291
self.bzrdir = a_bzrdir
936
self._transport = self.bzrdir.transport.clone('..')
937
self._base = self._transport.base
2292
self._base = self.bzrdir.transport.clone('..').base
2294
# XXX: We should be able to just do
2295
# self.base = self.bzrdir.root_transport.base
2296
# but this does not quite work yet -- mbp 20080522
938
2297
self._format = _format
939
2298
if _control_files is None:
940
2299
raise ValueError('BzrBranch _control_files is None')
941
2300
self.control_files = _control_files
942
if deprecated_passed(init):
943
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
944
"deprecated as of bzr 0.8. Please use Branch.create().",
948
# this is slower than before deprecation, oh well never mind.
950
self._initialize(transport.base)
951
self._check_format(_format)
952
if deprecated_passed(relax_version_check):
953
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
954
"relax_version_check parameter is deprecated as of bzr 0.8. "
955
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
959
if (not relax_version_check
960
and not self._format.is_supported()):
961
raise errors.UnsupportedFormatError(format=fmt)
962
if deprecated_passed(transport):
963
warn("BzrBranch.__init__(transport=XXX...): The transport "
964
"parameter is deprecated as of bzr 0.8. "
965
"Please use Branch.open, or bzrdir.open_branch().",
2301
self._transport = _control_files._transport
968
2302
self.repository = _repository
2303
Branch.__init__(self)
970
2305
def __str__(self):
971
return '%s(%r)' % (self.__class__.__name__, self.base)
2306
if self.name is None:
2307
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2309
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
973
2312
__repr__ = __str__
975
2314
def _get_base(self):
2315
"""Returns the directory containing the control directory."""
976
2316
return self._base
978
2318
base = property(_get_base, doc="The URL for the root of this branch.")
980
def _finish_transaction(self):
981
"""Exit the current transaction."""
982
return self.control_files._finish_transaction()
984
def get_transaction(self):
985
"""Return the current active transaction.
987
If no transaction is active, this returns a passthrough object
988
for which all data is immediately flushed and no caching happens.
990
# this is an explicit function so that we can do tricky stuff
991
# when the storage in rev_storage is elsewhere.
992
# we probably need to hook the two 'lock a location' and
993
# 'have a transaction' together more delicately, so that
994
# we can have two locks (branch and storage) and one transaction
995
# ... and finishing the transaction unlocks both, but unlocking
996
# does not. - RBC 20051121
997
return self.control_files.get_transaction()
999
def _set_transaction(self, transaction):
1000
"""Set a new active transaction."""
1001
return self.control_files._set_transaction(transaction)
1003
def abspath(self, name):
1004
"""See Branch.abspath."""
1005
return self.control_files._transport.abspath(name)
1007
def _check_format(self, format):
1008
"""Identify the branch format if needed.
1010
The format is stored as a reference to the format object in
1011
self._format for code that needs to check it later.
1013
The format parameter is either None or the branch format class
1014
used to open this branch.
1016
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1019
format = BranchFormat.find_format(self.bzrdir)
1020
self._format = format
1021
mutter("got branch format %s", self._format)
1024
def get_root_id(self):
1025
"""See Branch.get_root_id."""
1026
tree = self.repository.revision_tree(self.last_revision())
1027
return tree.inventory.root.file_id
2320
def _get_config(self):
2321
return TransportConfig(self._transport, 'branch.conf')
1029
2323
def is_locked(self):
1030
2324
return self.control_files.is_locked()
1032
def lock_write(self):
1033
self.repository.lock_write()
2326
def lock_write(self, token=None):
2327
if not self.is_locked():
2328
self._note_lock('w')
2329
# All-in-one needs to always unlock/lock.
2330
repo_control = getattr(self.repository, 'control_files', None)
2331
if self.control_files == repo_control or not self.is_locked():
2332
self.repository._warn_if_deprecated(self)
2333
self.repository.lock_write()
1035
self.control_files.lock_write()
2338
return self.control_files.lock_write(token=token)
1037
self.repository.unlock()
2341
self.repository.unlock()
1040
2344
def lock_read(self):
1041
self.repository.lock_read()
2345
if not self.is_locked():
2346
self._note_lock('r')
2347
# All-in-one needs to always unlock/lock.
2348
repo_control = getattr(self.repository, 'control_files', None)
2349
if self.control_files == repo_control or not self.is_locked():
2350
self.repository._warn_if_deprecated(self)
2351
self.repository.lock_read()
1043
2356
self.control_files.lock_read()
1045
self.repository.unlock()
2359
self.repository.unlock()
2362
@only_raises(errors.LockNotHeld, errors.LockBroken)
1048
2363
def unlock(self):
1049
# TODO: test for failed two phase locks. This is known broken.
1051
2365
self.control_files.unlock()
1053
self.repository.unlock()
2367
# All-in-one needs to always unlock/lock.
2368
repo_control = getattr(self.repository, 'control_files', None)
2369
if (self.control_files == repo_control or
2370
not self.control_files.is_locked()):
2371
self.repository.unlock()
2372
if not self.control_files.is_locked():
2373
# we just released the lock
2374
self._clear_cached_state()
1055
2376
def peek_lock_mode(self):
1056
2377
if self.control_files._lock_count == 0:
1066
2387
"""See Branch.print_file."""
1067
2388
return self.repository.print_file(file, revision_id)
1070
def append_revision(self, *revision_ids):
1071
"""See Branch.append_revision."""
1072
for revision_id in revision_ids:
1073
mutter("add {%s} to revision-history" % revision_id)
1074
rev_history = self.revision_history()
1075
rev_history.extend(revision_ids)
1076
self.set_revision_history(rev_history)
2390
def _write_revision_history(self, history):
2391
"""Factored out of set_revision_history.
2393
This performs the actual writing to disk.
2394
It is intended to be called by BzrBranch5.set_revision_history."""
2395
self._transport.put_bytes(
2396
'revision-history', '\n'.join(history),
2397
mode=self.bzrdir._get_file_mode())
1078
2399
@needs_write_lock
1079
2400
def set_revision_history(self, rev_history):
1080
2401
"""See Branch.set_revision_history."""
1081
self.control_files.put_utf8(
1082
'revision-history', '\n'.join(rev_history))
1083
transaction = self.get_transaction()
1084
history = transaction.map.find_revision_history()
1085
if history is not None:
1086
# update the revision history in the identity map.
1087
history[:] = list(rev_history)
1088
# this call is disabled because revision_history is
1089
# not really an object yet, and the transaction is for objects.
1090
# transaction.register_dirty(history)
1092
transaction.map.add_revision_history(rev_history)
1093
# this call is disabled because revision_history is
1094
# not really an object yet, and the transaction is for objects.
1095
# transaction.register_clean(history)
1098
def revision_history(self):
1099
"""See Branch.revision_history."""
1100
transaction = self.get_transaction()
1101
history = transaction.map.find_revision_history()
1102
if history is not None:
1103
# mutter("cache hit for revision-history in %s", self)
1104
return list(history)
1105
decode_utf8 = cache_utf8.decode
1106
history = [decode_utf8(l.rstrip('\r\n')) for l in
1107
self.control_files.get('revision-history').readlines()]
1108
transaction.map.add_revision_history(history)
1109
# this call is disabled because revision_history is
1110
# not really an object yet, and the transaction is for objects.
1111
# transaction.register_clean(history, precious=True)
1112
return list(history)
1115
def generate_revision_history(self, revision_id, last_rev=None,
2402
if 'evil' in debug.debug_flags:
2403
mutter_callsite(3, "set_revision_history scales with history.")
2404
check_not_reserved_id = _mod_revision.check_not_reserved_id
2405
for rev_id in rev_history:
2406
check_not_reserved_id(rev_id)
2407
if Branch.hooks['post_change_branch_tip']:
2408
# Don't calculate the last_revision_info() if there are no hooks
2410
old_revno, old_revid = self.last_revision_info()
2411
if len(rev_history) == 0:
2412
revid = _mod_revision.NULL_REVISION
2414
revid = rev_history[-1]
2415
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2416
self._write_revision_history(rev_history)
2417
self._clear_cached_state()
2418
self._cache_revision_history(rev_history)
2419
for hook in Branch.hooks['set_rh']:
2420
hook(self, rev_history)
2421
if Branch.hooks['post_change_branch_tip']:
2422
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2424
def _synchronize_history(self, destination, revision_id):
2425
"""Synchronize last revision and revision history between branches.
2427
This version is most efficient when the destination is also a
2428
BzrBranch5, but works for BzrBranch6 as long as the revision
2429
history is the true lefthand parent history, and all of the revisions
2430
are in the destination's repository. If not, set_revision_history
2433
:param destination: The branch to copy the history into
2434
:param revision_id: The revision-id to truncate history at. May
2435
be None to copy complete history.
2437
if not isinstance(destination._format, BzrBranchFormat5):
2438
super(BzrBranch, self)._synchronize_history(
2439
destination, revision_id)
2441
if revision_id == _mod_revision.NULL_REVISION:
2444
new_history = self.revision_history()
2445
if revision_id is not None and new_history != []:
2447
new_history = new_history[:new_history.index(revision_id) + 1]
2449
rev = self.repository.get_revision(revision_id)
2450
new_history = rev.get_history(self.repository)[1:]
2451
destination.set_revision_history(new_history)
2454
def set_last_revision_info(self, revno, revision_id):
2455
"""Set the last revision of this branch.
2457
The caller is responsible for checking that the revno is correct
2458
for this revision id.
2460
It may be possible to set the branch last revision to an id not
2461
present in the repository. However, branches can also be
2462
configured to check constraints on history, in which case this may not
2465
revision_id = _mod_revision.ensure_null(revision_id)
2466
# this old format stores the full history, but this api doesn't
2467
# provide it, so we must generate, and might as well check it's
2469
history = self._lefthand_history(revision_id)
2470
if len(history) != revno:
2471
raise AssertionError('%d != %d' % (len(history), revno))
2472
self.set_revision_history(history)
2474
def _gen_revision_history(self):
2475
history = self._transport.get_bytes('revision-history').split('\n')
2476
if history[-1:] == ['']:
2477
# There shouldn't be a trailing newline, but just in case.
2482
def generate_revision_history(self, revision_id, last_rev=None,
1116
2483
other_branch=None):
1117
2484
"""Create a new revision history that will finish with revision_id.
1119
2486
:param revision_id: the new tip to use.
1120
2487
:param last_rev: The previous last_revision. If not None, then this
1121
2488
must be a ancestory of revision_id, or DivergedBranches is raised.
1122
2489
:param other_branch: The other branch that DivergedBranches should
1123
2490
raise with respect to.
1125
# stop_revision must be a descendant of last_revision
1126
stop_graph = self.repository.get_revision_graph(revision_id)
1127
if last_rev is not None and last_rev not in stop_graph:
1128
# our previous tip is not merged into stop_revision
1129
raise errors.DivergedBranches(self, other_branch)
1130
# make a new revision history from the graph
1131
current_rev_id = revision_id
1133
while current_rev_id not in (None, revision.NULL_REVISION):
1134
new_history.append(current_rev_id)
1135
current_rev_id_parents = stop_graph[current_rev_id]
1137
current_rev_id = current_rev_id_parents[0]
1139
current_rev_id = None
1140
new_history.reverse()
1141
self.set_revision_history(new_history)
1144
def update_revisions(self, other, stop_revision=None):
1145
"""See Branch.update_revisions."""
1148
if stop_revision is None:
1149
stop_revision = other.last_revision()
1150
if stop_revision is None:
1151
# if there are no commits, we're done.
1153
# whats the current last revision, before we fetch [and change it
1155
last_rev = self.last_revision()
1156
# we fetch here regardless of whether we need to so that we pickup
1158
self.fetch(other, stop_revision)
1159
my_ancestry = self.repository.get_ancestry(last_rev)
1160
if stop_revision in my_ancestry:
1161
# last_revision is a descendant of stop_revision
1163
self.generate_revision_history(stop_revision, last_rev=last_rev,
2492
self.set_revision_history(self._lefthand_history(revision_id,
2493
last_rev, other_branch))
1168
2495
def basis_tree(self):
1169
2496
"""See Branch.basis_tree."""
1170
2497
return self.repository.revision_tree(self.last_revision())
1172
@deprecated_method(zero_eight)
1173
def working_tree(self):
1174
"""Create a Working tree object for this branch."""
1176
from bzrlib.transport.local import LocalTransport
1177
if (self.base.find('://') != -1 or
1178
not isinstance(self._transport, LocalTransport)):
1179
raise NoWorkingTree(self.base)
1180
return self.bzrdir.open_workingtree()
1183
def pull(self, source, overwrite=False, stop_revision=None):
1184
"""See Branch.pull."""
1187
old_count = len(self.revision_history())
1189
self.update_revisions(source,stop_revision)
1190
except DivergedBranches:
1194
self.set_revision_history(source.revision_history())
1195
new_count = len(self.revision_history())
1196
return new_count - old_count
1200
def get_parent(self):
1201
"""See Branch.get_parent."""
2499
def _get_parent_location(self):
1203
2500
_locs = ['parent', 'pull', 'x-pull']
1204
assert self.base[-1] == '/'
1205
2501
for l in _locs:
1207
parent = self.control_files.get(l).read().strip('\n')
1210
# This is an old-format absolute path to a local branch
1211
# turn it into a url
1212
if parent.startswith('/'):
1213
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1215
return urlutils.join(self.base[:-1], parent)
1216
except errors.InvalidURLJoin, e:
1217
raise errors.InaccessibleParent(parent, self.base)
2503
return self._transport.get_bytes(l).strip('\n')
2504
except errors.NoSuchFile:
1220
def get_push_location(self):
1221
"""See Branch.get_push_location."""
1222
push_loc = self.get_config().get_user_option('push_location')
2508
def _basic_push(self, target, overwrite, stop_revision):
2509
"""Basic implementation of push without bound branches or hooks.
2511
Must be called with source read locked and target write locked.
2513
result = BranchPushResult()
2514
result.source_branch = self
2515
result.target_branch = target
2516
result.old_revno, result.old_revid = target.last_revision_info()
2517
self.update_references(target)
2518
if result.old_revid != self.last_revision():
2519
# We assume that during 'push' this repository is closer than
2521
graph = self.repository.get_graph(target.repository)
2522
target.update_revisions(self, stop_revision,
2523
overwrite=overwrite, graph=graph)
2524
if self._push_should_merge_tags():
2525
result.tag_conflicts = self.tags.merge_to(target.tags,
2527
result.new_revno, result.new_revid = target.last_revision_info()
2530
def get_stacked_on_url(self):
2531
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1225
2533
def set_push_location(self, location):
1226
2534
"""See Branch.set_push_location."""
1227
self.get_config().set_user_option('push_location', location,
2535
self.get_config().set_user_option(
2536
'push_location', location,
2537
store=_mod_config.STORE_LOCATION_NORECURSE)
1231
def set_parent(self, url):
1232
"""See Branch.set_parent."""
1233
# TODO: Maybe delete old location files?
1234
# URLs should never be unicode, even on the local fs,
1235
# FIXUP this and get_parent in a future branch format bump:
1236
# read and rewrite the file, and have the new format code read
1237
# using .get not .get_utf8. RBC 20060125
2539
def _set_parent_location(self, url):
1238
2540
if url is None:
1239
self.control_files._transport.delete('parent')
2541
self._transport.delete('parent')
1241
if isinstance(url, unicode):
1243
url = url.encode('ascii')
1244
except UnicodeEncodeError:
1245
raise bzrlib.errors.InvalidURL(url,
1246
"Urls must be 7-bit ascii, "
1247
"use bzrlib.urlutils.escape")
1249
url = urlutils.relative_url(self.base, url)
1250
self.control_files.put('parent', StringIO(url + '\n'))
1252
@deprecated_function(zero_nine)
1253
def tree_config(self):
1254
"""DEPRECATED; call get_config instead.
1255
TreeConfig has become part of BranchConfig."""
1256
return TreeConfig(self)
2543
self._transport.put_bytes('parent', url + '\n',
2544
mode=self.bzrdir._get_file_mode())
1259
2547
class BzrBranch5(BzrBranch):
1260
"""A format 5 branch. This supports new features over plan branches.
2548
"""A format 5 branch. This supports new features over plain branches.
1262
2550
It has support for a master_branch which is the data for bound branches.
1270
super(BzrBranch5, self).__init__(_format=_format,
1271
_control_files=_control_files,
1273
_repository=_repository)
1276
def pull(self, source, overwrite=False, stop_revision=None):
1277
"""Updates branch.pull to be bound branch aware."""
1278
bound_location = self.get_bound_location()
1279
if source.base != bound_location:
1280
# not pulling from master, so we need to update master.
1281
master_branch = self.get_master_branch()
1283
master_branch.pull(source)
1284
source = master_branch
1285
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1287
2553
def get_bound_location(self):
1289
return self.control_files.get_utf8('bound').read()[:-1]
2555
return self._transport.get_bytes('bound')[:-1]
1290
2556
except errors.NoSuchFile:
1293
2559
@needs_read_lock
1294
def get_master_branch(self):
2560
def get_master_branch(self, possible_transports=None):
1295
2561
"""Return the branch we are bound to.
1297
2563
:return: Either a Branch, or None
1299
2565
This could memoise the branch, but if thats done
1376
2625
return self.set_bound_location(None)
1378
2627
@needs_write_lock
1380
"""Synchronise this branch with the master branch if any.
2628
def update(self, possible_transports=None):
2629
"""Synchronise this branch with the master branch if any.
1382
2631
:return: None or the last_revision that was pivoted out during the
1385
master = self.get_master_branch()
2634
master = self.get_master_branch(possible_transports)
1386
2635
if master is not None:
1387
old_tip = self.last_revision()
2636
old_tip = _mod_revision.ensure_null(self.last_revision())
1388
2637
self.pull(master, overwrite=True)
1389
if old_tip in self.repository.get_ancestry(self.last_revision()):
2638
if self.repository.get_graph().is_ancestor(old_tip,
2639
_mod_revision.ensure_null(self.last_revision())):
1395
class BranchTestProviderAdapter(object):
1396
"""A tool to generate a suite testing multiple branch formats at once.
1398
This is done by copying the test once for each transport and injecting
1399
the transport_server, transport_readonly_server, and branch_format
1400
classes into each copy. Each copy is also given a new id() to make it
1404
def __init__(self, transport_server, transport_readonly_server, formats):
1405
self._transport_server = transport_server
1406
self._transport_readonly_server = transport_readonly_server
1407
self._formats = formats
1409
def adapt(self, test):
1410
result = TestSuite()
1411
for branch_format, bzrdir_format in self._formats:
1412
new_test = deepcopy(test)
1413
new_test.transport_server = self._transport_server
1414
new_test.transport_readonly_server = self._transport_readonly_server
1415
new_test.bzrdir_format = bzrdir_format
1416
new_test.branch_format = branch_format
1417
def make_new_test_id():
1418
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1419
return lambda: new_id
1420
new_test.id = make_new_test_id()
1421
result.addTest(new_test)
2645
class BzrBranch8(BzrBranch5):
2646
"""A branch that stores tree-reference locations."""
2648
def _open_hook(self):
2649
if self._ignore_fallbacks:
2652
url = self.get_stacked_on_url()
2653
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2654
errors.UnstackableBranchFormat):
2657
for hook in Branch.hooks['transform_fallback_location']:
2658
url = hook(self, url)
2660
hook_name = Branch.hooks.get_hook_name(hook)
2661
raise AssertionError(
2662
"'transform_fallback_location' hook %s returned "
2663
"None, not a URL." % hook_name)
2664
self._activate_fallback_location(url)
2666
def __init__(self, *args, **kwargs):
2667
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2668
super(BzrBranch8, self).__init__(*args, **kwargs)
2669
self._last_revision_info_cache = None
2670
self._reference_info = None
2672
def _clear_cached_state(self):
2673
super(BzrBranch8, self)._clear_cached_state()
2674
self._last_revision_info_cache = None
2675
self._reference_info = None
2677
def _last_revision_info(self):
2678
revision_string = self._transport.get_bytes('last-revision')
2679
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2680
revision_id = cache_utf8.get_cached_utf8(revision_id)
2682
return revno, revision_id
2684
def _write_last_revision_info(self, revno, revision_id):
2685
"""Simply write out the revision id, with no checks.
2687
Use set_last_revision_info to perform this safely.
2689
Does not update the revision_history cache.
2690
Intended to be called by set_last_revision_info and
2691
_write_revision_history.
2693
revision_id = _mod_revision.ensure_null(revision_id)
2694
out_string = '%d %s\n' % (revno, revision_id)
2695
self._transport.put_bytes('last-revision', out_string,
2696
mode=self.bzrdir._get_file_mode())
2699
def set_last_revision_info(self, revno, revision_id):
2700
revision_id = _mod_revision.ensure_null(revision_id)
2701
old_revno, old_revid = self.last_revision_info()
2702
if self._get_append_revisions_only():
2703
self._check_history_violation(revision_id)
2704
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2705
self._write_last_revision_info(revno, revision_id)
2706
self._clear_cached_state()
2707
self._last_revision_info_cache = revno, revision_id
2708
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2710
def _synchronize_history(self, destination, revision_id):
2711
"""Synchronize last revision and revision history between branches.
2713
:see: Branch._synchronize_history
2715
# XXX: The base Branch has a fast implementation of this method based
2716
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2717
# that uses set_revision_history. This class inherits from BzrBranch5,
2718
# but wants the fast implementation, so it calls
2719
# Branch._synchronize_history directly.
2720
Branch._synchronize_history(self, destination, revision_id)
2722
def _check_history_violation(self, revision_id):
2723
last_revision = _mod_revision.ensure_null(self.last_revision())
2724
if _mod_revision.is_null(last_revision):
2726
if last_revision not in self._lefthand_history(revision_id):
2727
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2729
def _gen_revision_history(self):
2730
"""Generate the revision history from last revision
2732
last_revno, last_revision = self.last_revision_info()
2733
self._extend_partial_history(stop_index=last_revno-1)
2734
return list(reversed(self._partial_revision_history_cache))
2736
def _write_revision_history(self, history):
2737
"""Factored out of set_revision_history.
2739
This performs the actual writing to disk, with format-specific checks.
2740
It is intended to be called by BzrBranch5.set_revision_history.
2742
if len(history) == 0:
2743
last_revision = 'null:'
2745
if history != self._lefthand_history(history[-1]):
2746
raise errors.NotLefthandHistory(history)
2747
last_revision = history[-1]
2748
if self._get_append_revisions_only():
2749
self._check_history_violation(last_revision)
2750
self._write_last_revision_info(len(history), last_revision)
2753
def _set_parent_location(self, url):
2754
"""Set the parent branch"""
2755
self._set_config_location('parent_location', url, make_relative=True)
2758
def _get_parent_location(self):
2759
"""Set the parent branch"""
2760
return self._get_config_location('parent_location')
2763
def _set_all_reference_info(self, info_dict):
2764
"""Replace all reference info stored in a branch.
2766
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2769
writer = rio.RioWriter(s)
2770
for key, (tree_path, branch_location) in info_dict.iteritems():
2771
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2772
branch_location=branch_location)
2773
writer.write_stanza(stanza)
2774
self._transport.put_bytes('references', s.getvalue())
2775
self._reference_info = info_dict
2778
def _get_all_reference_info(self):
2779
"""Return all the reference info stored in a branch.
2781
:return: A dict of {file_id: (tree_path, branch_location)}
2783
if self._reference_info is not None:
2784
return self._reference_info
2785
rio_file = self._transport.get('references')
2787
stanzas = rio.read_stanzas(rio_file)
2788
info_dict = dict((s['file_id'], (s['tree_path'],
2789
s['branch_location'])) for s in stanzas)
2792
self._reference_info = info_dict
2795
def set_reference_info(self, file_id, tree_path, branch_location):
2796
"""Set the branch location to use for a tree reference.
2798
:param file_id: The file-id of the tree reference.
2799
:param tree_path: The path of the tree reference in the tree.
2800
:param branch_location: The location of the branch to retrieve tree
2803
info_dict = self._get_all_reference_info()
2804
info_dict[file_id] = (tree_path, branch_location)
2805
if None in (tree_path, branch_location):
2806
if tree_path is not None:
2807
raise ValueError('tree_path must be None when branch_location'
2809
if branch_location is not None:
2810
raise ValueError('branch_location must be None when tree_path'
2812
del info_dict[file_id]
2813
self._set_all_reference_info(info_dict)
2815
def get_reference_info(self, file_id):
2816
"""Get the tree_path and branch_location for a tree reference.
2818
:return: a tuple of (tree_path, branch_location)
2820
return self._get_all_reference_info().get(file_id, (None, None))
2822
def reference_parent(self, file_id, path, possible_transports=None):
2823
"""Return the parent branch for a tree-reference file_id.
2825
:param file_id: The file_id of the tree reference
2826
:param path: The path of the file_id in the tree
2827
:return: A branch associated with the file_id
2829
branch_location = self.get_reference_info(file_id)[1]
2830
if branch_location is None:
2831
return Branch.reference_parent(self, file_id, path,
2832
possible_transports)
2833
branch_location = urlutils.join(self.user_url, branch_location)
2834
return Branch.open(branch_location,
2835
possible_transports=possible_transports)
2837
def set_push_location(self, location):
2838
"""See Branch.set_push_location."""
2839
self._set_config_location('push_location', location)
2841
def set_bound_location(self, location):
2842
"""See Branch.set_push_location."""
2844
config = self.get_config()
2845
if location is None:
2846
if config.get_user_option('bound') != 'True':
2849
config.set_user_option('bound', 'False', warn_masked=True)
2852
self._set_config_location('bound_location', location,
2854
config.set_user_option('bound', 'True', warn_masked=True)
2857
def _get_bound_location(self, bound):
2858
"""Return the bound location in the config file.
2860
Return None if the bound parameter does not match"""
2861
config = self.get_config()
2862
config_bound = (config.get_user_option('bound') == 'True')
2863
if config_bound != bound:
2865
return self._get_config_location('bound_location', config=config)
2867
def get_bound_location(self):
2868
"""See Branch.set_push_location."""
2869
return self._get_bound_location(True)
2871
def get_old_bound_location(self):
2872
"""See Branch.get_old_bound_location"""
2873
return self._get_bound_location(False)
2875
def get_stacked_on_url(self):
2876
# you can always ask for the URL; but you might not be able to use it
2877
# if the repo can't support stacking.
2878
## self._check_stackable_repo()
2879
stacked_url = self._get_config_location('stacked_on_location')
2880
if stacked_url is None:
2881
raise errors.NotStacked(self)
2884
def _get_append_revisions_only(self):
2885
return self.get_config(
2886
).get_user_option_as_bool('append_revisions_only')
2889
def generate_revision_history(self, revision_id, last_rev=None,
2891
"""See BzrBranch5.generate_revision_history"""
2892
history = self._lefthand_history(revision_id, last_rev, other_branch)
2893
revno = len(history)
2894
self.set_last_revision_info(revno, revision_id)
2897
def get_rev_id(self, revno, history=None):
2898
"""Find the revision id of the specified revno."""
2900
return _mod_revision.NULL_REVISION
2902
last_revno, last_revision_id = self.last_revision_info()
2903
if revno <= 0 or revno > last_revno:
2904
raise errors.NoSuchRevision(self, revno)
2906
if history is not None:
2907
return history[revno - 1]
2909
index = last_revno - revno
2910
if len(self._partial_revision_history_cache) <= index:
2911
self._extend_partial_history(stop_index=index)
2912
if len(self._partial_revision_history_cache) > index:
2913
return self._partial_revision_history_cache[index]
2915
raise errors.NoSuchRevision(self, revno)
2918
def revision_id_to_revno(self, revision_id):
2919
"""Given a revision id, return its revno"""
2920
if _mod_revision.is_null(revision_id):
2923
index = self._partial_revision_history_cache.index(revision_id)
2925
self._extend_partial_history(stop_revision=revision_id)
2926
index = len(self._partial_revision_history_cache) - 1
2927
if self._partial_revision_history_cache[index] != revision_id:
2928
raise errors.NoSuchRevision(self, revision_id)
2929
return self.revno() - index
2932
class BzrBranch7(BzrBranch8):
2933
"""A branch with support for a fallback repository."""
2935
def set_reference_info(self, file_id, tree_path, branch_location):
2936
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2938
def get_reference_info(self, file_id):
2939
Branch.get_reference_info(self, file_id)
2941
def reference_parent(self, file_id, path, possible_transports=None):
2942
return Branch.reference_parent(self, file_id, path,
2943
possible_transports)
2946
class BzrBranch6(BzrBranch7):
2947
"""See BzrBranchFormat6 for the capabilities of this branch.
2949
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2953
def get_stacked_on_url(self):
2954
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2957
######################################################################
2958
# results of operations
2961
class _Result(object):
2963
def _show_tag_conficts(self, to_file):
2964
if not getattr(self, 'tag_conflicts', None):
2966
to_file.write('Conflicting tags:\n')
2967
for name, value1, value2 in self.tag_conflicts:
2968
to_file.write(' %s\n' % (name, ))
2971
class PullResult(_Result):
2972
"""Result of a Branch.pull operation.
2974
:ivar old_revno: Revision number before pull.
2975
:ivar new_revno: Revision number after pull.
2976
:ivar old_revid: Tip revision id before pull.
2977
:ivar new_revid: Tip revision id after pull.
2978
:ivar source_branch: Source (local) branch object. (read locked)
2979
:ivar master_branch: Master branch of the target, or the target if no
2981
:ivar local_branch: target branch if there is a Master, else None
2982
:ivar target_branch: Target/destination branch object. (write locked)
2983
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2987
# DEPRECATED: pull used to return the change in revno
2988
return self.new_revno - self.old_revno
2990
def report(self, to_file):
2992
if self.old_revid == self.new_revid:
2993
to_file.write('No revisions to pull.\n')
2995
to_file.write('Now on revision %d.\n' % self.new_revno)
2996
self._show_tag_conficts(to_file)
2999
class BranchPushResult(_Result):
3000
"""Result of a Branch.push operation.
3002
:ivar old_revno: Revision number (eg 10) of the target before push.
3003
:ivar new_revno: Revision number (eg 12) of the target after push.
3004
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3006
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3008
:ivar source_branch: Source branch object that the push was from. This is
3009
read locked, and generally is a local (and thus low latency) branch.
3010
:ivar master_branch: If target is a bound branch, the master branch of
3011
target, or target itself. Always write locked.
3012
:ivar target_branch: The direct Branch where data is being sent (write
3014
:ivar local_branch: If the target is a bound branch this will be the
3015
target, otherwise it will be None.
3019
# DEPRECATED: push used to return the change in revno
3020
return self.new_revno - self.old_revno
3022
def report(self, to_file):
3023
"""Write a human-readable description of the result."""
3024
if self.old_revid == self.new_revid:
3025
note('No new revisions to push.')
3027
note('Pushed up to revision %d.' % self.new_revno)
3028
self._show_tag_conficts(to_file)
1425
3031
class BranchCheckResult(object):
1431
3037
def __init__(self, branch):
1432
3038
self.branch = branch
1434
3041
def report_results(self, verbose):
1435
3042
"""Report the check results via trace.note.
1437
3044
:param verbose: Requests more detailed display of what was checked,
1440
note('checked branch %s format %s',
1442
self.branch._format)
1445
######################################################################
1449
@deprecated_function(zero_eight)
1450
def is_control_file(*args, **kwargs):
1451
"""See bzrlib.workingtree.is_control_file."""
1452
return bzrlib.workingtree.is_control_file(*args, **kwargs)
3047
note('checked branch %s format %s', self.branch.user_url,
3048
self.branch._format)
3049
for error in self.errors:
3050
note('found error:%s', error)
3053
class Converter5to6(object):
3054
"""Perform an in-place upgrade of format 5 to format 6"""
3056
def convert(self, branch):
3057
# Data for 5 and 6 can peacefully coexist.
3058
format = BzrBranchFormat6()
3059
new_branch = format.open(branch.bzrdir, _found=True)
3061
# Copy source data into target
3062
new_branch._write_last_revision_info(*branch.last_revision_info())
3063
new_branch.set_parent(branch.get_parent())
3064
new_branch.set_bound_location(branch.get_bound_location())
3065
new_branch.set_push_location(branch.get_push_location())
3067
# New branch has no tags by default
3068
new_branch.tags._set_tag_dict({})
3070
# Copying done; now update target format
3071
new_branch._transport.put_bytes('format',
3072
format.get_format_string(),
3073
mode=new_branch.bzrdir._get_file_mode())
3075
# Clean up old files
3076
new_branch._transport.delete('revision-history')
3078
branch.set_parent(None)
3079
except errors.NoSuchFile:
3081
branch.set_bound_location(None)
3084
class Converter6to7(object):
3085
"""Perform an in-place upgrade of format 6 to format 7"""
3087
def convert(self, branch):
3088
format = BzrBranchFormat7()
3089
branch._set_config_location('stacked_on_location', '')
3090
# update target format
3091
branch._transport.put_bytes('format', format.get_format_string())
3094
class Converter7to8(object):
3095
"""Perform an in-place upgrade of format 6 to format 7"""
3097
def convert(self, branch):
3098
format = BzrBranchFormat8()
3099
branch._transport.put_bytes('references', '')
3100
# update target format
3101
branch._transport.put_bytes('format', format.get_format_string())
3104
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3105
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3108
_run_with_write_locked_target will attempt to release the lock it acquires.
3110
If an exception is raised by callable, then that exception *will* be
3111
propagated, even if the unlock attempt raises its own error. Thus
3112
_run_with_write_locked_target should be preferred to simply doing::
3116
return callable(*args, **kwargs)
3121
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3122
# should share code?
3125
result = callable(*args, **kwargs)
3127
exc_info = sys.exc_info()
3131
raise exc_info[0], exc_info[1], exc_info[2]
3137
class InterBranch(InterObject):
3138
"""This class represents operations taking place between two branches.
3140
Its instances have methods like pull() and push() and contain
3141
references to the source and target repositories these operations
3142
can be carried out on.
3146
"""The available optimised InterBranch types."""
3149
def _get_branch_formats_to_test():
3150
"""Return a tuple with the Branch formats to use when testing."""
3151
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3153
def pull(self, overwrite=False, stop_revision=None,
3154
possible_transports=None, local=False):
3155
"""Mirror source into target branch.
3157
The target branch is considered to be 'local', having low latency.
3159
:returns: PullResult instance
3161
raise NotImplementedError(self.pull)
3163
def update_revisions(self, stop_revision=None, overwrite=False,
3165
"""Pull in new perfect-fit revisions.
3167
:param stop_revision: Updated until the given revision
3168
:param overwrite: Always set the branch pointer, rather than checking
3169
to see if it is a proper descendant.
3170
:param graph: A Graph object that can be used to query history
3171
information. This can be None.
3174
raise NotImplementedError(self.update_revisions)
3176
def push(self, overwrite=False, stop_revision=None,
3177
_override_hook_source_branch=None):
3178
"""Mirror the source branch into the target branch.
3180
The source branch is considered to be 'local', having low latency.
3182
raise NotImplementedError(self.push)
3185
class GenericInterBranch(InterBranch):
3186
"""InterBranch implementation that uses public Branch functions.
3190
def _get_branch_formats_to_test():
3191
return BranchFormat._default_format, BranchFormat._default_format
3193
def update_revisions(self, stop_revision=None, overwrite=False,
3195
"""See InterBranch.update_revisions()."""
3196
self.source.lock_read()
3198
other_revno, other_last_revision = self.source.last_revision_info()
3199
stop_revno = None # unknown
3200
if stop_revision is None:
3201
stop_revision = other_last_revision
3202
if _mod_revision.is_null(stop_revision):
3203
# if there are no commits, we're done.
3205
stop_revno = other_revno
3207
# what's the current last revision, before we fetch [and change it
3209
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3210
# we fetch here so that we don't process data twice in the common
3211
# case of having something to pull, and so that the check for
3212
# already merged can operate on the just fetched graph, which will
3213
# be cached in memory.
3214
self.target.fetch(self.source, stop_revision)
3215
# Check to see if one is an ancestor of the other
3218
graph = self.target.repository.get_graph()
3219
if self.target._check_if_descendant_or_diverged(
3220
stop_revision, last_rev, graph, self.source):
3221
# stop_revision is a descendant of last_rev, but we aren't
3222
# overwriting, so we're done.
3224
if stop_revno is None:
3226
graph = self.target.repository.get_graph()
3227
this_revno, this_last_revision = \
3228
self.target.last_revision_info()
3229
stop_revno = graph.find_distance_to_null(stop_revision,
3230
[(other_last_revision, other_revno),
3231
(this_last_revision, this_revno)])
3232
self.target.set_last_revision_info(stop_revno, stop_revision)
3234
self.source.unlock()
3236
def pull(self, overwrite=False, stop_revision=None,
3237
possible_transports=None, _hook_master=None, run_hooks=True,
3238
_override_hook_target=None, local=False):
3241
:param _hook_master: Private parameter - set the branch to
3242
be supplied as the master to pull hooks.
3243
:param run_hooks: Private parameter - if false, this branch
3244
is being called because it's the master of the primary branch,
3245
so it should not run its hooks.
3246
:param _override_hook_target: Private parameter - set the branch to be
3247
supplied as the target_branch to pull hooks.
3248
:param local: Only update the local branch, and not the bound branch.
3250
# This type of branch can't be bound.
3252
raise errors.LocalRequiresBoundBranch()
3253
result = PullResult()
3254
result.source_branch = self.source
3255
if _override_hook_target is None:
3256
result.target_branch = self.target
3258
result.target_branch = _override_hook_target
3259
self.source.lock_read()
3261
# We assume that during 'pull' the target repository is closer than
3263
self.source.update_references(self.target)
3264
graph = self.target.repository.get_graph(self.source.repository)
3265
# TODO: Branch formats should have a flag that indicates
3266
# that revno's are expensive, and pull() should honor that flag.
3268
result.old_revno, result.old_revid = \
3269
self.target.last_revision_info()
3270
self.target.update_revisions(self.source, stop_revision,
3271
overwrite=overwrite, graph=graph)
3272
# TODO: The old revid should be specified when merging tags,
3273
# so a tags implementation that versions tags can only
3274
# pull in the most recent changes. -- JRV20090506
3275
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3277
result.new_revno, result.new_revid = self.target.last_revision_info()
3279
result.master_branch = _hook_master
3280
result.local_branch = result.target_branch
3282
result.master_branch = result.target_branch
3283
result.local_branch = None
3285
for hook in Branch.hooks['post_pull']:
3288
self.source.unlock()
3291
def push(self, overwrite=False, stop_revision=None,
3292
_override_hook_source_branch=None):
3293
"""See InterBranch.push.
3295
This is the basic concrete implementation of push()
3297
:param _override_hook_source_branch: If specified, run
3298
the hooks passing this Branch as the source, rather than self.
3299
This is for use of RemoteBranch, where push is delegated to the
3300
underlying vfs-based Branch.
3302
# TODO: Public option to disable running hooks - should be trivial but
3304
self.source.lock_read()
3306
return _run_with_write_locked_target(
3307
self.target, self._push_with_bound_branches, overwrite,
3309
_override_hook_source_branch=_override_hook_source_branch)
3311
self.source.unlock()
3313
def _push_with_bound_branches(self, overwrite, stop_revision,
3314
_override_hook_source_branch=None):
3315
"""Push from source into target, and into target's master if any.
3318
if _override_hook_source_branch:
3319
result.source_branch = _override_hook_source_branch
3320
for hook in Branch.hooks['post_push']:
3323
bound_location = self.target.get_bound_location()
3324
if bound_location and self.target.base != bound_location:
3325
# there is a master branch.
3327
# XXX: Why the second check? Is it even supported for a branch to
3328
# be bound to itself? -- mbp 20070507
3329
master_branch = self.target.get_master_branch()
3330
master_branch.lock_write()
3332
# push into the master from the source branch.
3333
self.source._basic_push(master_branch, overwrite, stop_revision)
3334
# and push into the target branch from the source. Note that we
3335
# push from the source branch again, because its considered the
3336
# highest bandwidth repository.
3337
result = self.source._basic_push(self.target, overwrite,
3339
result.master_branch = master_branch
3340
result.local_branch = self.target
3344
master_branch.unlock()
3347
result = self.source._basic_push(self.target, overwrite,
3349
# TODO: Why set master_branch and local_branch if there's no
3350
# binding? Maybe cleaner to just leave them unset? -- mbp
3352
result.master_branch = self.target
3353
result.local_branch = None
3358
def is_compatible(self, source, target):
3359
# GenericBranch uses the public API, so always compatible
3363
class InterToBranch5(GenericInterBranch):
3366
def _get_branch_formats_to_test():
3367
return BranchFormat._default_format, BzrBranchFormat5()
3369
def pull(self, overwrite=False, stop_revision=None,
3370
possible_transports=None, run_hooks=True,
3371
_override_hook_target=None, local=False):
3372
"""Pull from source into self, updating my master if any.
3374
:param run_hooks: Private parameter - if false, this branch
3375
is being called because it's the master of the primary branch,
3376
so it should not run its hooks.
3378
bound_location = self.target.get_bound_location()
3379
if local and not bound_location:
3380
raise errors.LocalRequiresBoundBranch()
3381
master_branch = None
3382
if not local and bound_location and self.source.user_url != bound_location:
3383
# not pulling from master, so we need to update master.
3384
master_branch = self.target.get_master_branch(possible_transports)
3385
master_branch.lock_write()
3388
# pull from source into master.
3389
master_branch.pull(self.source, overwrite, stop_revision,
3391
return super(InterToBranch5, self).pull(overwrite,
3392
stop_revision, _hook_master=master_branch,
3393
run_hooks=run_hooks,
3394
_override_hook_target=_override_hook_target)
3397
master_branch.unlock()
3400
InterBranch.register_optimiser(GenericInterBranch)
3401
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
