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
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
18
21
from cStringIO import StringIO
20
23
from bzrlib.lazy_import import lazy_import
21
24
lazy_import(globals(), """
22
from copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
27
26
from bzrlib import (
30
config as _mod_config,
35
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
from bzrlib.tag import (
31
config as _mod_config,
40
revision as _mod_revision,
49
from bzrlib.i18n import gettext, ngettext
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
51
HistoryMissing, InvalidRevisionId,
52
InvalidRevisionNumber, LockError, NoSuchFile,
53
NoSuchRevision, NoWorkingTree, NotVersionedError,
54
NotBranchError, UninitializableFormat,
55
UnlistableStore, UnlistableBranch,
57
from bzrlib.symbol_versioning import (deprecated_function,
61
zero_eight, zero_nine,
63
from bzrlib.trace import mutter, note
66
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
67
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
68
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
71
# TODO: Maybe include checks for common corruption of newlines, etc?
73
# TODO: Some operations like log might retrieve the same revisions
74
# repeatedly to calculate deltas. We could perhaps have a weakref
75
# cache in memory to make this faster. In general anything can be
76
# cached in memory between lock and unlock operations. .. nb thats
77
# what the transaction identity map provides
80
######################################################################
52
# Explicitly import bzrlib.bzrdir so that the BzrProber
53
# is guaranteed to be registered.
60
from bzrlib.decorators import (
65
from bzrlib.hooks import Hooks
66
from bzrlib.inter import InterObject
67
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
68
from bzrlib import registry
69
from bzrlib.symbol_versioning import (
73
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
76
class Branch(controldir.ControlComponent):
84
77
"""Branch holding a history of revisions.
87
Base directory/url of the branch.
89
hooks: An instance of BranchHooks.
80
Base directory/url of the branch; using control_url and
81
control_transport is more standardized.
82
:ivar hooks: An instance of BranchHooks.
83
:ivar _master_branch_cache: cached result of get_master_branch, see
91
86
# this is really an instance variable - FIXME move it there
95
# override this to set the strategy for storing tags
97
return DisabledTags(self)
99
def __init__(self, *ignored, **ignored_too):
100
self.tags = self._make_tags()
91
def control_transport(self):
92
return self._transport
95
def user_transport(self):
96
return self.bzrdir.user_transport
98
def __init__(self, possible_transports=None):
99
self.tags = self._format.make_tags(self)
100
self._revision_history_cache = None
101
self._revision_id_to_revno_cache = None
102
self._partial_revision_id_to_revno_cache = {}
103
self._partial_revision_history_cache = []
104
self._tags_bytes = None
105
self._last_revision_info_cache = None
106
self._master_branch_cache = None
107
self._merge_sorted_revisions_cache = None
108
self._open_hook(possible_transports)
109
hooks = Branch.hooks['open']
113
def _open_hook(self, possible_transports):
114
"""Called by init to allow simpler extension of the base class."""
116
def _activate_fallback_location(self, url, possible_transports):
117
"""Activate the branch/repository from url as a fallback repository."""
118
for existing_fallback_repo in self.repository._fallback_repositories:
119
if existing_fallback_repo.user_url == url:
120
# This fallback is already configured. This probably only
121
# happens because ControlDir.sprout is a horrible mess. To avoid
122
# confusing _unstack we don't add this a second time.
123
mutter('duplicate activation of fallback %r on %r', url, self)
125
repo = self._get_fallback_repository(url, possible_transports)
126
if repo.has_same_location(self.repository):
127
raise errors.UnstackableLocationError(self.user_url, url)
128
self.repository.add_fallback_repository(repo)
102
130
def break_lock(self):
103
131
"""Break a lock if one is present from another instance.
113
141
if master is not None:
114
142
master.break_lock()
117
@deprecated_method(zero_eight)
118
def open_downlevel(base):
119
"""Open a branch which may be of an old format."""
120
return Branch.open(base, _unsupported=True)
123
def open(base, _unsupported=False):
144
def _check_stackable_repo(self):
145
if not self.repository._format.supports_external_lookups:
146
raise errors.UnstackableRepositoryFormat(self.repository._format,
147
self.repository.base)
149
def _extend_partial_history(self, stop_index=None, stop_revision=None):
150
"""Extend the partial history to include a given index
152
If a stop_index is supplied, stop when that index has been reached.
153
If a stop_revision is supplied, stop when that revision is
154
encountered. Otherwise, stop when the beginning of history is
157
:param stop_index: The index which should be present. When it is
158
present, history extension will stop.
159
:param stop_revision: The revision id which should be present. When
160
it is encountered, history extension will stop.
162
if len(self._partial_revision_history_cache) == 0:
163
self._partial_revision_history_cache = [self.last_revision()]
164
repository._iter_for_revno(
165
self.repository, self._partial_revision_history_cache,
166
stop_index=stop_index, stop_revision=stop_revision)
167
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
168
self._partial_revision_history_cache.pop()
170
def _get_check_refs(self):
171
"""Get the references needed for check().
175
revid = self.last_revision()
176
return [('revision-existence', revid), ('lefthand-distance', revid)]
179
def open(base, _unsupported=False, possible_transports=None):
124
180
"""Open the branch rooted at base.
126
182
For instance, if the branch is at URL/.bzr/branch,
127
183
Branch.open(URL) -> a Branch instance.
129
control = bzrdir.BzrDir.open(base, _unsupported)
130
return control.open_branch(_unsupported)
133
def open_containing(url):
185
control = controldir.ControlDir.open(base,
186
possible_transports=possible_transports, _unsupported=_unsupported)
187
return control.open_branch(unsupported=_unsupported,
188
possible_transports=possible_transports)
191
def open_from_transport(transport, name=None, _unsupported=False,
192
possible_transports=None):
193
"""Open the branch rooted at transport"""
194
control = controldir.ControlDir.open_from_transport(transport, _unsupported)
195
return control.open_branch(name=name, unsupported=_unsupported,
196
possible_transports=possible_transports)
199
def open_containing(url, possible_transports=None):
134
200
"""Open an existing branch which contains url.
136
202
This probes for a branch at url, and searches upwards from there.
138
204
Basically we keep looking up until we find the control directory or
139
205
run into the root. If there isn't one, raises NotBranchError.
140
If there is one and it is either an unrecognised format or an unsupported
206
If there is one and it is either an unrecognised format or an unsupported
141
207
format, UnknownFormatError or UnsupportedFormatError are raised.
142
208
If there is one, it is returned, along with the unused portion of url.
144
control, relpath = bzrdir.BzrDir.open_containing(url)
145
return control.open_branch(), relpath
148
@deprecated_function(zero_eight)
149
def initialize(base):
150
"""Create a new working tree and branch, rooted at 'base' (url)
152
NOTE: This will soon be deprecated in favour of creation
155
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
157
@deprecated_function(zero_eight)
158
def setup_caching(self, cache_root):
159
"""Subclasses that care about caching should override this, and set
160
up cached stores located under cache_root.
162
NOTE: This is unused.
210
control, relpath = controldir.ControlDir.open_containing(url,
212
branch = control.open_branch(possible_transports=possible_transports)
213
return (branch, relpath)
215
def _push_should_merge_tags(self):
216
"""Should _basic_push merge this branch's tags into the target?
218
The default implementation returns False if this branch has no tags,
219
and True the rest of the time. Subclasses may override this.
221
return self.supports_tags() and self.tags.get_tag_dict()
166
223
def get_config(self):
167
return BranchConfig(self)
170
return self.get_config().get_nickname()
224
"""Get a bzrlib.config.BranchConfig for this Branch.
226
This can then be used to get and set configuration options for the
229
:return: A bzrlib.config.BranchConfig.
231
return _mod_config.BranchConfig(self)
233
def get_config_stack(self):
234
"""Get a bzrlib.config.BranchStack for this Branch.
236
This can then be used to get and set configuration options for the
239
:return: A bzrlib.config.BranchStack.
241
return _mod_config.BranchStack(self)
243
def _get_config(self):
244
"""Get the concrete config for just the config in this branch.
246
This is not intended for client use; see Branch.get_config for the
251
:return: An object supporting get_option and set_option.
253
raise NotImplementedError(self._get_config)
255
def store_uncommitted(self, creator):
256
"""Store uncommitted changes from a ShelfCreator.
258
:param creator: The ShelfCreator containing uncommitted changes, or
259
None to delete any stored changes.
260
:raises: ChangesAlreadyStored if the branch already has changes.
262
raise NotImplementedError(self.store_uncommitted)
264
def get_unshelver(self, tree):
265
"""Return a shelf.Unshelver for this branch and tree.
267
:param tree: The tree to use to construct the Unshelver.
268
:return: an Unshelver or None if no changes are stored.
270
raise NotImplementedError(self.get_unshelver)
272
def _get_fallback_repository(self, url, possible_transports):
273
"""Get the repository we fallback to at url."""
274
url = urlutils.join(self.base, url)
275
a_branch = Branch.open(url, possible_transports=possible_transports)
276
return a_branch.repository
279
def _get_tags_bytes(self):
280
"""Get the bytes of a serialised tags dict.
282
Note that not all branches support tags, nor do all use the same tags
283
logic: this method is specific to BasicTags. Other tag implementations
284
may use the same method name and behave differently, safely, because
285
of the double-dispatch via
286
format.make_tags->tags_instance->get_tags_dict.
288
:return: The bytes of the tags file.
289
:seealso: Branch._set_tags_bytes.
291
if self._tags_bytes is None:
292
self._tags_bytes = self._transport.get_bytes('tags')
293
return self._tags_bytes
295
def _get_nick(self, local=False, possible_transports=None):
296
config = self.get_config()
297
# explicit overrides master, but don't look for master if local is True
298
if not local and not config.has_explicit_nickname():
300
master = self.get_master_branch(possible_transports)
301
if master and self.user_url == master.user_url:
302
raise errors.RecursiveBind(self.user_url)
303
if master is not None:
304
# return the master branch value
306
except errors.RecursiveBind, e:
308
except errors.BzrError, e:
309
# Silently fall back to local implicit nick if the master is
311
mutter("Could not connect to bound branch, "
312
"falling back to local nick.\n " + str(e))
313
return config.get_nickname()
172
315
def _set_nick(self, nick):
173
self.get_config().set_user_option('nickname', nick)
316
self.get_config().set_user_option('nickname', nick, warn_masked=True)
175
318
nick = property(_get_nick, _set_nick)
177
320
def is_locked(self):
178
321
raise NotImplementedError(self.is_locked)
180
def lock_write(self):
323
def _lefthand_history(self, revision_id, last_rev=None,
325
if 'evil' in debug.debug_flags:
326
mutter_callsite(4, "_lefthand_history scales with history.")
327
# stop_revision must be a descendant of last_revision
328
graph = self.repository.get_graph()
329
if last_rev is not None:
330
if not graph.is_ancestor(last_rev, revision_id):
331
# our previous tip is not merged into stop_revision
332
raise errors.DivergedBranches(self, other_branch)
333
# make a new revision history from the graph
334
parents_map = graph.get_parent_map([revision_id])
335
if revision_id not in parents_map:
336
raise errors.NoSuchRevision(self, revision_id)
337
current_rev_id = revision_id
339
check_not_reserved_id = _mod_revision.check_not_reserved_id
340
# Do not include ghosts or graph origin in revision_history
341
while (current_rev_id in parents_map and
342
len(parents_map[current_rev_id]) > 0):
343
check_not_reserved_id(current_rev_id)
344
new_history.append(current_rev_id)
345
current_rev_id = parents_map[current_rev_id][0]
346
parents_map = graph.get_parent_map([current_rev_id])
347
new_history.reverse()
350
def lock_write(self, token=None):
351
"""Lock the branch for write operations.
353
:param token: A token to permit reacquiring a previously held and
355
:return: A BranchWriteLockResult.
181
357
raise NotImplementedError(self.lock_write)
183
359
def lock_read(self):
360
"""Lock the branch for read operations.
362
:return: A bzrlib.lock.LogicalLockResult.
184
364
raise NotImplementedError(self.lock_read)
186
366
def unlock(self):
193
373
def get_physical_lock_status(self):
194
374
raise NotImplementedError(self.get_physical_lock_status)
196
def abspath(self, name):
197
"""Return absolute filename for something in the branch
199
XXX: Robert Collins 20051017 what is this used for? why is it a branch
200
method and not a tree method.
202
raise NotImplementedError(self.abspath)
377
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
378
"""Return the revision_id for a dotted revno.
380
:param revno: a tuple like (1,) or (1,1,2)
381
:param _cache_reverse: a private parameter enabling storage
382
of the reverse mapping in a top level cache. (This should
383
only be done in selective circumstances as we want to
384
avoid having the mapping cached multiple times.)
385
:return: the revision_id
386
:raises errors.NoSuchRevision: if the revno doesn't exist
388
rev_id = self._do_dotted_revno_to_revision_id(revno)
390
self._partial_revision_id_to_revno_cache[rev_id] = revno
393
def _do_dotted_revno_to_revision_id(self, revno):
394
"""Worker function for dotted_revno_to_revision_id.
396
Subclasses should override this if they wish to
397
provide a more efficient implementation.
400
return self.get_rev_id(revno[0])
401
revision_id_to_revno = self.get_revision_id_to_revno_map()
402
revision_ids = [revision_id for revision_id, this_revno
403
in revision_id_to_revno.iteritems()
404
if revno == this_revno]
405
if len(revision_ids) == 1:
406
return revision_ids[0]
408
revno_str = '.'.join(map(str, revno))
409
raise errors.NoSuchRevision(self, revno_str)
412
def revision_id_to_dotted_revno(self, revision_id):
413
"""Given a revision id, return its dotted revno.
415
:return: a tuple like (1,) or (400,1,3).
417
return self._do_revision_id_to_dotted_revno(revision_id)
419
def _do_revision_id_to_dotted_revno(self, revision_id):
420
"""Worker function for revision_id_to_revno."""
421
# Try the caches if they are loaded
422
result = self._partial_revision_id_to_revno_cache.get(revision_id)
423
if result is not None:
425
if self._revision_id_to_revno_cache:
426
result = self._revision_id_to_revno_cache.get(revision_id)
428
raise errors.NoSuchRevision(self, revision_id)
429
# Try the mainline as it's optimised
431
revno = self.revision_id_to_revno(revision_id)
433
except errors.NoSuchRevision:
434
# We need to load and use the full revno map after all
435
result = self.get_revision_id_to_revno_map().get(revision_id)
437
raise errors.NoSuchRevision(self, revision_id)
441
def get_revision_id_to_revno_map(self):
442
"""Return the revision_id => dotted revno map.
444
This will be regenerated on demand, but will be cached.
446
:return: A dictionary mapping revision_id => dotted revno.
447
This dictionary should not be modified by the caller.
449
if self._revision_id_to_revno_cache is not None:
450
mapping = self._revision_id_to_revno_cache
452
mapping = self._gen_revno_map()
453
self._cache_revision_id_to_revno(mapping)
454
# TODO: jam 20070417 Since this is being cached, should we be returning
456
# I would rather not, and instead just declare that users should not
457
# modify the return value.
460
def _gen_revno_map(self):
461
"""Create a new mapping from revision ids to dotted revnos.
463
Dotted revnos are generated based on the current tip in the revision
465
This is the worker function for get_revision_id_to_revno_map, which
466
just caches the return value.
468
:return: A dictionary mapping revision_id => dotted revno.
470
revision_id_to_revno = dict((rev_id, revno)
471
for rev_id, depth, revno, end_of_merge
472
in self.iter_merge_sorted_revisions())
473
return revision_id_to_revno
476
def iter_merge_sorted_revisions(self, start_revision_id=None,
477
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
478
"""Walk the revisions for a branch in merge sorted order.
480
Merge sorted order is the output from a merge-aware,
481
topological sort, i.e. all parents come before their
482
children going forward; the opposite for reverse.
484
:param start_revision_id: the revision_id to begin walking from.
485
If None, the branch tip is used.
486
:param stop_revision_id: the revision_id to terminate the walk
487
after. If None, the rest of history is included.
488
:param stop_rule: if stop_revision_id is not None, the precise rule
489
to use for termination:
491
* 'exclude' - leave the stop revision out of the result (default)
492
* 'include' - the stop revision is the last item in the result
493
* 'with-merges' - include the stop revision and all of its
494
merged revisions in the result
495
* 'with-merges-without-common-ancestry' - filter out revisions
496
that are in both ancestries
497
:param direction: either 'reverse' or 'forward':
499
* reverse means return the start_revision_id first, i.e.
500
start at the most recent revision and go backwards in history
501
* forward returns tuples in the opposite order to reverse.
502
Note in particular that forward does *not* do any intelligent
503
ordering w.r.t. depth as some clients of this API may like.
504
(If required, that ought to be done at higher layers.)
506
:return: an iterator over (revision_id, depth, revno, end_of_merge)
509
* revision_id: the unique id of the revision
510
* depth: How many levels of merging deep this node has been
512
* revno_sequence: This field provides a sequence of
513
revision numbers for all revisions. The format is:
514
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
515
branch that the revno is on. From left to right the REVNO numbers
516
are the sequence numbers within that branch of the revision.
517
* end_of_merge: When True the next node (earlier in history) is
518
part of a different merge.
520
# Note: depth and revno values are in the context of the branch so
521
# we need the full graph to get stable numbers, regardless of the
523
if self._merge_sorted_revisions_cache is None:
524
last_revision = self.last_revision()
525
known_graph = self.repository.get_known_graph_ancestry(
527
self._merge_sorted_revisions_cache = known_graph.merge_sort(
529
filtered = self._filter_merge_sorted_revisions(
530
self._merge_sorted_revisions_cache, start_revision_id,
531
stop_revision_id, stop_rule)
532
# Make sure we don't return revisions that are not part of the
533
# start_revision_id ancestry.
534
filtered = self._filter_start_non_ancestors(filtered)
535
if direction == 'reverse':
537
if direction == 'forward':
538
return reversed(list(filtered))
540
raise ValueError('invalid direction %r' % direction)
542
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
543
start_revision_id, stop_revision_id, stop_rule):
544
"""Iterate over an inclusive range of sorted revisions."""
545
rev_iter = iter(merge_sorted_revisions)
546
if start_revision_id is not None:
547
for node in rev_iter:
549
if rev_id != start_revision_id:
552
# The decision to include the start or not
553
# depends on the stop_rule if a stop is provided
554
# so pop this node back into the iterator
555
rev_iter = itertools.chain(iter([node]), rev_iter)
557
if stop_revision_id is None:
559
for node in rev_iter:
561
yield (rev_id, node.merge_depth, node.revno,
563
elif stop_rule == 'exclude':
564
for node in rev_iter:
566
if rev_id == stop_revision_id:
568
yield (rev_id, node.merge_depth, node.revno,
570
elif stop_rule == 'include':
571
for node in rev_iter:
573
yield (rev_id, node.merge_depth, node.revno,
575
if rev_id == stop_revision_id:
577
elif stop_rule == 'with-merges-without-common-ancestry':
578
# We want to exclude all revisions that are already part of the
579
# stop_revision_id ancestry.
580
graph = self.repository.get_graph()
581
ancestors = graph.find_unique_ancestors(start_revision_id,
583
for node in rev_iter:
585
if rev_id not in ancestors:
587
yield (rev_id, node.merge_depth, node.revno,
589
elif stop_rule == 'with-merges':
590
stop_rev = self.repository.get_revision(stop_revision_id)
591
if stop_rev.parent_ids:
592
left_parent = stop_rev.parent_ids[0]
594
left_parent = _mod_revision.NULL_REVISION
595
# left_parent is the actual revision we want to stop logging at,
596
# since we want to show the merged revisions after the stop_rev too
597
reached_stop_revision_id = False
598
revision_id_whitelist = []
599
for node in rev_iter:
601
if rev_id == left_parent:
602
# reached the left parent after the stop_revision
604
if (not reached_stop_revision_id or
605
rev_id in revision_id_whitelist):
606
yield (rev_id, node.merge_depth, node.revno,
608
if reached_stop_revision_id or rev_id == stop_revision_id:
609
# only do the merged revs of rev_id from now on
610
rev = self.repository.get_revision(rev_id)
612
reached_stop_revision_id = True
613
revision_id_whitelist.extend(rev.parent_ids)
615
raise ValueError('invalid stop_rule %r' % stop_rule)
617
def _filter_start_non_ancestors(self, rev_iter):
618
# If we started from a dotted revno, we want to consider it as a tip
619
# and don't want to yield revisions that are not part of its
620
# ancestry. Given the order guaranteed by the merge sort, we will see
621
# uninteresting descendants of the first parent of our tip before the
623
first = rev_iter.next()
624
(rev_id, merge_depth, revno, end_of_merge) = first
627
# We start at a mainline revision so by definition, all others
628
# revisions in rev_iter are ancestors
629
for node in rev_iter:
634
pmap = self.repository.get_parent_map([rev_id])
635
parents = pmap.get(rev_id, [])
637
whitelist.update(parents)
639
# If there is no parents, there is nothing of interest left
641
# FIXME: It's hard to test this scenario here as this code is never
642
# called in that case. -- vila 20100322
645
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
647
if rev_id in whitelist:
648
pmap = self.repository.get_parent_map([rev_id])
649
parents = pmap.get(rev_id, [])
650
whitelist.remove(rev_id)
651
whitelist.update(parents)
653
# We've reached the mainline, there is nothing left to
657
# A revision that is not part of the ancestry of our
660
yield (rev_id, merge_depth, revno, end_of_merge)
662
def leave_lock_in_place(self):
663
"""Tell this branch object not to release the physical lock when this
666
If lock_write doesn't return a token, then this method is not supported.
668
self.control_files.leave_in_place()
670
def dont_leave_lock_in_place(self):
671
"""Tell this branch object to release the physical lock when this
672
object is unlocked, even if it didn't originally acquire it.
674
If lock_write doesn't return a token, then this method is not supported.
676
self.control_files.dont_leave_in_place()
204
678
def bind(self, other):
205
679
"""Bind the local branch the other branch.
269
740
:param committer: Optional committer to set for commit.
270
741
:param revprops: Optional dictionary of revision properties.
271
742
:param revision_id: Optional revision id.
743
:param lossy: Whether to discard data that can not be natively
744
represented, when pushing to a foreign VCS
275
config = self.get_config()
277
return self.repository.get_commit_builder(self, parents, config,
278
timestamp, timezone, committer, revprops, revision_id)
280
def get_master_branch(self):
747
if config_stack is None:
748
config_stack = self.get_config_stack()
750
return self.repository.get_commit_builder(self, parents, config_stack,
751
timestamp, timezone, committer, revprops, revision_id,
754
def get_master_branch(self, possible_transports=None):
281
755
"""Return the branch we are bound to.
283
757
:return: Either a Branch, or None
761
@deprecated_method(deprecated_in((2, 5, 0)))
287
762
def get_revision_delta(self, revno):
288
763
"""Return the delta for one revision.
290
765
The delta is relative to its mainline predecessor, or the
291
766
empty tree for revision 1.
293
assert isinstance(revno, int)
294
rh = self.revision_history()
295
if not (1 <= revno <= len(rh)):
296
raise InvalidRevisionNumber(revno)
297
return self.repository.get_revision_delta(rh[revno-1])
299
def get_root_id(self):
300
"""Return the id of this branches root"""
301
raise NotImplementedError(self.get_root_id)
769
revid = self.get_rev_id(revno)
770
except errors.NoSuchRevision:
771
raise errors.InvalidRevisionNumber(revno)
772
return self.repository.get_revision_delta(revid)
774
def get_stacked_on_url(self):
775
"""Get the URL this branch is stacked against.
777
:raises NotStacked: If the branch is not stacked.
778
:raises UnstackableBranchFormat: If the branch does not support
781
raise NotImplementedError(self.get_stacked_on_url)
303
783
def print_file(self, file, revision_id):
304
784
"""Print `file` to stdout."""
305
785
raise NotImplementedError(self.print_file)
307
def append_revision(self, *revision_ids):
308
raise NotImplementedError(self.append_revision)
310
def set_revision_history(self, rev_history):
311
raise NotImplementedError(self.set_revision_history)
313
def revision_history(self):
314
"""Return sequence of revision hashes on to this branch."""
315
raise NotImplementedError(self.revision_history)
788
def set_last_revision_info(self, revno, revision_id):
789
"""Set the last revision of this branch.
791
The caller is responsible for checking that the revno is correct
792
for this revision id.
794
It may be possible to set the branch last revision to an id not
795
present in the repository. However, branches can also be
796
configured to check constraints on history, in which case this may not
799
raise NotImplementedError(self.set_last_revision_info)
802
def generate_revision_history(self, revision_id, last_rev=None,
804
"""See Branch.generate_revision_history"""
805
graph = self.repository.get_graph()
806
(last_revno, last_revid) = self.last_revision_info()
807
known_revision_ids = [
808
(last_revid, last_revno),
809
(_mod_revision.NULL_REVISION, 0),
811
if last_rev is not None:
812
if not graph.is_ancestor(last_rev, revision_id):
813
# our previous tip is not merged into stop_revision
814
raise errors.DivergedBranches(self, other_branch)
815
revno = graph.find_distance_to_null(revision_id, known_revision_ids)
816
self.set_last_revision_info(revno, revision_id)
819
def set_parent(self, url):
820
"""See Branch.set_parent."""
821
# TODO: Maybe delete old location files?
822
# URLs should never be unicode, even on the local fs,
823
# FIXUP this and get_parent in a future branch format bump:
824
# read and rewrite the file. RBC 20060125
826
if isinstance(url, unicode):
828
url = url.encode('ascii')
829
except UnicodeEncodeError:
830
raise errors.InvalidURL(url,
831
"Urls must be 7-bit ascii, "
832
"use bzrlib.urlutils.escape")
833
url = urlutils.relative_url(self.base, url)
834
self._set_parent_location(url)
837
def set_stacked_on_url(self, url):
838
"""Set the URL this branch is stacked against.
840
:raises UnstackableBranchFormat: If the branch does not support
842
:raises UnstackableRepositoryFormat: If the repository does not support
845
if not self._format.supports_stacking():
846
raise errors.UnstackableBranchFormat(self._format, self.user_url)
847
# XXX: Changing from one fallback repository to another does not check
848
# that all the data you need is present in the new fallback.
849
# Possibly it should.
850
self._check_stackable_repo()
853
old_url = self.get_stacked_on_url()
854
except (errors.NotStacked, errors.UnstackableBranchFormat,
855
errors.UnstackableRepositoryFormat):
859
self._activate_fallback_location(url,
860
possible_transports=[self.bzrdir.root_transport])
861
# write this out after the repository is stacked to avoid setting a
862
# stacked config that doesn't work.
863
self._set_config_location('stacked_on_location', url)
866
"""Change a branch to be unstacked, copying data as needed.
868
Don't call this directly, use set_stacked_on_url(None).
870
pb = ui.ui_factory.nested_progress_bar()
872
pb.update(gettext("Unstacking"))
873
# The basic approach here is to fetch the tip of the branch,
874
# including all available ghosts, from the existing stacked
875
# repository into a new repository object without the fallbacks.
877
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
878
# correct for CHKMap repostiories
879
old_repository = self.repository
880
if len(old_repository._fallback_repositories) != 1:
881
raise AssertionError("can't cope with fallback repositories "
882
"of %r (fallbacks: %r)" % (old_repository,
883
old_repository._fallback_repositories))
884
# Open the new repository object.
885
# Repositories don't offer an interface to remove fallback
886
# repositories today; take the conceptually simpler option and just
887
# reopen it. We reopen it starting from the URL so that we
888
# get a separate connection for RemoteRepositories and can
889
# stream from one of them to the other. This does mean doing
890
# separate SSH connection setup, but unstacking is not a
891
# common operation so it's tolerable.
892
new_bzrdir = controldir.ControlDir.open(
893
self.bzrdir.root_transport.base)
894
new_repository = new_bzrdir.find_repository()
895
if new_repository._fallback_repositories:
896
raise AssertionError("didn't expect %r to have "
897
"fallback_repositories"
898
% (self.repository,))
899
# Replace self.repository with the new repository.
900
# Do our best to transfer the lock state (i.e. lock-tokens and
901
# lock count) of self.repository to the new repository.
902
lock_token = old_repository.lock_write().repository_token
903
self.repository = new_repository
904
if isinstance(self, remote.RemoteBranch):
905
# Remote branches can have a second reference to the old
906
# repository that need to be replaced.
907
if self._real_branch is not None:
908
self._real_branch.repository = new_repository
909
self.repository.lock_write(token=lock_token)
910
if lock_token is not None:
911
old_repository.leave_lock_in_place()
912
old_repository.unlock()
913
if lock_token is not None:
914
# XXX: self.repository.leave_lock_in_place() before this
915
# function will not be preserved. Fortunately that doesn't
916
# affect the current default format (2a), and would be a
917
# corner-case anyway.
918
# - Andrew Bennetts, 2010/06/30
919
self.repository.dont_leave_lock_in_place()
923
old_repository.unlock()
924
except errors.LockNotHeld:
927
if old_lock_count == 0:
928
raise AssertionError(
929
'old_repository should have been locked at least once.')
930
for i in range(old_lock_count-1):
931
self.repository.lock_write()
932
# Fetch from the old repository into the new.
933
old_repository.lock_read()
935
# XXX: If you unstack a branch while it has a working tree
936
# with a pending merge, the pending-merged revisions will no
937
# longer be present. You can (probably) revert and remerge.
939
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
940
except errors.TagsNotSupported:
941
tags_to_fetch = set()
942
fetch_spec = vf_search.NotInOtherForRevs(self.repository,
943
old_repository, required_ids=[self.last_revision()],
944
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
945
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
947
old_repository.unlock()
951
def _set_tags_bytes(self, bytes):
952
"""Mirror method for _get_tags_bytes.
954
:seealso: Branch._get_tags_bytes.
956
op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
957
op.add_cleanup(self.lock_write().unlock)
958
return op.run_simple(bytes)
960
def _set_tags_bytes_locked(self, bytes):
961
self._tags_bytes = bytes
962
return self._transport.put_bytes('tags', bytes)
964
def _cache_revision_history(self, rev_history):
965
"""Set the cached revision history to rev_history.
967
The revision_history method will use this cache to avoid regenerating
968
the revision history.
970
This API is semi-public; it only for use by subclasses, all other code
971
should consider it to be private.
973
self._revision_history_cache = rev_history
975
def _cache_revision_id_to_revno(self, revision_id_to_revno):
976
"""Set the cached revision_id => revno map to revision_id_to_revno.
978
This API is semi-public; it only for use by subclasses, all other code
979
should consider it to be private.
981
self._revision_id_to_revno_cache = revision_id_to_revno
983
def _clear_cached_state(self):
984
"""Clear any cached data on this branch, e.g. cached revision history.
986
This means the next call to revision_history will need to call
987
_gen_revision_history.
989
This API is semi-public; it is only for use by subclasses, all other
990
code should consider it to be private.
992
self._revision_history_cache = None
993
self._revision_id_to_revno_cache = None
994
self._last_revision_info_cache = None
995
self._master_branch_cache = None
996
self._merge_sorted_revisions_cache = None
997
self._partial_revision_history_cache = []
998
self._partial_revision_id_to_revno_cache = {}
999
self._tags_bytes = None
1001
def _gen_revision_history(self):
1002
"""Return sequence of revision hashes on to this branch.
1004
Unlike revision_history, this method always regenerates or rereads the
1005
revision history, i.e. it does not cache the result, so repeated calls
1008
Concrete subclasses should override this instead of revision_history so
1009
that subclasses do not need to deal with caching logic.
1011
This API is semi-public; it only for use by subclasses, all other code
1012
should consider it to be private.
1014
raise NotImplementedError(self._gen_revision_history)
1016
def _revision_history(self):
1017
if 'evil' in debug.debug_flags:
1018
mutter_callsite(3, "revision_history scales with history.")
1019
if self._revision_history_cache is not None:
1020
history = self._revision_history_cache
1022
history = self._gen_revision_history()
1023
self._cache_revision_history(history)
1024
return list(history)
317
1026
def revno(self):
318
1027
"""Return current revision number for this branch.
320
1029
That is equivalent to the number of revisions committed to
323
return len(self.revision_history())
1032
return self.last_revision_info()[0]
325
1034
def unbind(self):
326
1035
"""Older format branches cannot bind or unbind."""
327
raise errors.UpgradeRequired(self.base)
329
def set_append_revisions_only(self, enabled):
330
"""Older format branches are never restricted to append-only"""
331
raise errors.UpgradeRequired(self.base)
1036
raise errors.UpgradeRequired(self.user_url)
333
1038
def last_revision(self):
334
"""Return last revision id, or None"""
335
ph = self.revision_history()
1039
"""Return last revision id, or NULL_REVISION."""
1040
return self.last_revision_info()[1]
341
1043
def last_revision_info(self):
342
1044
"""Return information about the last revision.
344
:return: A tuple (revno, last_revision_id).
346
rh = self.revision_history()
349
return (revno, rh[-1])
351
return (0, _mod_revision.NULL_REVISION)
353
def missing_revisions(self, other, stop_revision=None):
354
"""Return a list of new revisions that would perfectly fit.
356
If self and other have not diverged, return a list of the revisions
357
present in other, but missing from self.
359
self_history = self.revision_history()
360
self_len = len(self_history)
361
other_history = other.revision_history()
362
other_len = len(other_history)
363
common_index = min(self_len, other_len) -1
364
if common_index >= 0 and \
365
self_history[common_index] != other_history[common_index]:
366
raise DivergedBranches(self, other)
368
if stop_revision is None:
369
stop_revision = other_len
371
assert isinstance(stop_revision, int)
372
if stop_revision > other_len:
373
raise errors.NoSuchRevision(self, stop_revision)
374
return other_history[self_len:stop_revision]
376
def update_revisions(self, other, stop_revision=None):
377
"""Pull in new perfect-fit revisions.
379
:param other: Another Branch to pull from
380
:param stop_revision: Updated until the given revision
383
raise NotImplementedError(self.update_revisions)
1046
:return: A tuple (revno, revision_id).
1048
if self._last_revision_info_cache is None:
1049
self._last_revision_info_cache = self._read_last_revision_info()
1050
return self._last_revision_info_cache
1052
def _read_last_revision_info(self):
1053
raise NotImplementedError(self._read_last_revision_info)
1055
def import_last_revision_info_and_tags(self, source, revno, revid,
1057
"""Set the last revision info, importing from another repo if necessary.
1059
This is used by the bound branch code to upload a revision to
1060
the master branch first before updating the tip of the local branch.
1061
Revisions referenced by source's tags are also transferred.
1063
:param source: Source branch to optionally fetch from
1064
:param revno: Revision number of the new tip
1065
:param revid: Revision id of the new tip
1066
:param lossy: Whether to discard metadata that can not be
1067
natively represented
1068
:return: Tuple with the new revision number and revision id
1069
(should only be different from the arguments when lossy=True)
1071
if not self.repository.has_same_location(source.repository):
1072
self.fetch(source, revid)
1073
self.set_last_revision_info(revno, revid)
1074
return (revno, revid)
385
1076
def revision_id_to_revno(self, revision_id):
386
1077
"""Given a revision id, return its revno"""
387
if revision_id is None:
1078
if _mod_revision.is_null(revision_id):
389
revision_id = osutils.safe_revision_id(revision_id)
390
history = self.revision_history()
1080
history = self._revision_history()
392
1082
return history.index(revision_id) + 1
393
1083
except ValueError:
394
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1084
raise errors.NoSuchRevision(self, revision_id)
396
1087
def get_rev_id(self, revno, history=None):
397
1088
"""Find the revision id of the specified revno."""
401
history = self.revision_history()
402
if revno <= 0 or revno > len(history):
403
raise bzrlib.errors.NoSuchRevision(self, revno)
404
return history[revno - 1]
1090
return _mod_revision.NULL_REVISION
1091
last_revno, last_revid = self.last_revision_info()
1092
if revno == last_revno:
1094
if revno <= 0 or revno > last_revno:
1095
raise errors.NoSuchRevision(self, revno)
1096
distance_from_last = last_revno - revno
1097
if len(self._partial_revision_history_cache) <= distance_from_last:
1098
self._extend_partial_history(distance_from_last)
1099
return self._partial_revision_history_cache[distance_from_last]
406
def pull(self, source, overwrite=False, stop_revision=None):
1101
def pull(self, source, overwrite=False, stop_revision=None,
1102
possible_transports=None, *args, **kwargs):
407
1103
"""Mirror source into this branch.
409
1105
This branch is considered to be 'local', having low latency.
411
1107
:returns: PullResult instance
413
raise NotImplementedError(self.pull)
1109
return InterBranch.get(source, self).pull(overwrite=overwrite,
1110
stop_revision=stop_revision,
1111
possible_transports=possible_transports, *args, **kwargs)
415
def push(self, target, overwrite=False, stop_revision=None):
1113
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
416
1115
"""Mirror this branch into target.
418
1117
This branch is considered to be 'local', having low latency.
420
raise NotImplementedError(self.push)
1119
return InterBranch.get(self, target).push(overwrite, stop_revision,
1120
lossy, *args, **kwargs)
422
1122
def basis_tree(self):
423
1123
"""Return `Tree` object for last revision."""
424
1124
return self.repository.revision_tree(self.last_revision())
426
def rename_one(self, from_rel, to_rel):
429
This can change the directory or the filename or both.
431
raise NotImplementedError(self.rename_one)
433
def move(self, from_paths, to_name):
436
to_name must exist as a versioned directory.
438
If to_name exists and is a directory, the files are moved into
439
it, keeping their old names. If it is a directory,
441
Note that to_name is only the last component of the new name;
442
this doesn't change the directory.
444
This returns a list of (from_path, to_path) pairs for each
447
raise NotImplementedError(self.move)
449
1126
def get_parent(self):
450
1127
"""Return the parent location of the branch.
452
This is the default location for push/pull/missing. The usual
1129
This is the default location for pull/missing. The usual
453
1130
pattern is that the user can override it by specifying a
456
raise NotImplementedError(self.get_parent)
1133
parent = self._get_parent_location()
1136
# This is an old-format absolute path to a local branch
1137
# turn it into a url
1138
if parent.startswith('/'):
1139
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1141
return urlutils.join(self.base[:-1], parent)
1142
except errors.InvalidURLJoin, e:
1143
raise errors.InaccessibleParent(parent, self.user_url)
1145
def _get_parent_location(self):
1146
raise NotImplementedError(self._get_parent_location)
1148
def _set_config_location(self, name, url, config=None,
1149
make_relative=False):
1151
config = self.get_config_stack()
1155
url = urlutils.relative_url(self.base, url)
1156
config.set(name, url)
1158
def _get_config_location(self, name, config=None):
1160
config = self.get_config_stack()
1161
location = config.get(name)
1166
def get_child_submit_format(self):
1167
"""Return the preferred format of submissions to this branch."""
1168
return self.get_config_stack().get('child_submit_format')
458
1170
def get_submit_branch(self):
459
1171
"""Return the submit location of the branch.
501
1248
self.check_real_revno(revno)
503
1250
def check_real_revno(self, revno):
505
1252
Check whether a revno corresponds to a real revision.
506
1253
Zero (the NULL revision) is considered invalid
508
1255
if revno < 1 or revno > self.revno():
509
raise InvalidRevisionNumber(revno)
1256
raise errors.InvalidRevisionNumber(revno)
511
1258
@needs_read_lock
512
def clone(self, *args, **kwargs):
1259
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
513
1260
"""Clone this branch into to_bzrdir preserving all semantic values.
1262
Most API users will want 'create_clone_on_transport', which creates a
1263
new bzrdir and branch on the fly.
515
1265
revision_id: if not None, the revision history in the new branch will
516
1266
be truncated to end with revision_id.
518
# for API compatibility, until 0.8 releases we provide the old api:
519
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
520
# after 0.8 releases, the *args and **kwargs should be changed:
521
# def clone(self, to_bzrdir, revision_id=None):
522
if (kwargs.get('to_location', None) or
523
kwargs.get('revision', None) or
524
kwargs.get('basis_branch', None) or
525
(len(args) and isinstance(args[0], basestring))):
526
# backwards compatibility api:
527
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
528
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
531
basis_branch = args[2]
533
basis_branch = kwargs.get('basis_branch', None)
535
basis = basis_branch.bzrdir
540
revision_id = args[1]
542
revision_id = kwargs.get('revision', None)
547
# no default to raise if not provided.
548
url = kwargs.get('to_location')
549
return self.bzrdir.clone(url,
550
revision_id=revision_id,
551
basis=basis).open_branch()
553
# generate args by hand
555
revision_id = args[1]
557
revision_id = kwargs.get('revision_id', None)
561
# no default to raise if not provided.
562
to_bzrdir = kwargs.get('to_bzrdir')
563
result = self._format.initialize(to_bzrdir)
564
self.copy_content_into(result, revision_id=revision_id)
1268
result = to_bzrdir.create_branch()
1271
if repository_policy is not None:
1272
repository_policy.configure_branch(result)
1273
self.copy_content_into(result, revision_id=revision_id)
567
1278
@needs_read_lock
568
def sprout(self, to_bzrdir, revision_id=None):
1279
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
569
1281
"""Create a new line of development from the branch, into to_bzrdir.
1283
to_bzrdir controls the branch format.
571
1285
revision_id: if not None, the revision history in the new branch will
572
1286
be truncated to end with revision_id.
574
result = self._format.initialize(to_bzrdir)
575
self.copy_content_into(result, revision_id=revision_id)
576
result.set_parent(self.bzrdir.root_transport.base)
1288
if (repository_policy is not None and
1289
repository_policy.requires_stacking()):
1290
to_bzrdir._format.require_stacking(_skip_repo=True)
1291
result = to_bzrdir.create_branch(repository=repository)
1294
if repository_policy is not None:
1295
repository_policy.configure_branch(result)
1296
self.copy_content_into(result, revision_id=revision_id)
1297
master_url = self.get_bound_location()
1298
if master_url is None:
1299
result.set_parent(self.bzrdir.root_transport.base)
1301
result.set_parent(master_url)
579
1306
def _synchronize_history(self, destination, revision_id):
580
1307
"""Synchronize last revision and revision history between branches.
582
1309
This version is most efficient when the destination is also a
583
BzrBranch5, but works for BzrBranch6 as long as the revision
584
history is the true lefthand parent history, and all of the revisions
585
are in the destination's repository. If not, set_revision_history
1310
BzrBranch6, but works for BzrBranch5, as long as the destination's
1311
repository contains all the lefthand ancestors of the intended
1312
last_revision. If not, set_last_revision_info will fail.
588
1314
:param destination: The branch to copy the history into
589
1315
:param revision_id: The revision-id to truncate history at. May
590
1316
be None to copy complete history.
592
new_history = self.revision_history()
593
if revision_id is not None:
594
revision_id = osutils.safe_revision_id(revision_id)
1318
source_revno, source_revision_id = self.last_revision_info()
1319
if revision_id is None:
1320
revno, revision_id = source_revno, source_revision_id
1322
graph = self.repository.get_graph()
596
new_history = new_history[:new_history.index(revision_id) + 1]
598
rev = self.repository.get_revision(revision_id)
599
new_history = rev.get_history(self.repository)[1:]
600
destination.set_revision_history(new_history)
1324
revno = graph.find_distance_to_null(revision_id,
1325
[(source_revision_id, source_revno)])
1326
except errors.GhostRevisionsHaveNoRevno:
1327
# Default to 1, if we can't find anything else
1329
destination.set_last_revision_info(revno, revision_id)
603
1331
def copy_content_into(self, destination, revision_id=None):
604
1332
"""Copy the content of self into destination.
606
1334
revision_id: if not None, the revision history in the new branch will
607
1335
be truncated to end with revision_id.
609
self._synchronize_history(destination, revision_id)
611
parent = self.get_parent()
612
except errors.InaccessibleParent, e:
613
mutter('parent was not accessible to copy: %s', e)
616
destination.set_parent(parent)
1337
return InterBranch.get(self, destination).copy_content_into(
1338
revision_id=revision_id)
1340
def update_references(self, target):
1341
if not getattr(self._format, 'supports_reference_locations', False):
1343
reference_dict = self._get_all_reference_info()
1344
if len(reference_dict) == 0:
1346
old_base = self.base
1347
new_base = target.base
1348
target_reference_dict = target._get_all_reference_info()
1349
for file_id, (tree_path, branch_location) in (
1350
reference_dict.items()):
1351
branch_location = urlutils.rebase_url(branch_location,
1353
target_reference_dict.setdefault(
1354
file_id, (tree_path, branch_location))
1355
target._set_all_reference_info(target_reference_dict)
618
1357
@needs_read_lock
1358
def check(self, refs):
620
1359
"""Check consistency of the branch.
622
1361
In particular this checks that revisions given in the revision-history
623
do actually match up in the revision graph, and that they're all
1362
do actually match up in the revision graph, and that they're all
624
1363
present in the repository.
626
1365
Callers will typically also want to check the repository.
1367
:param refs: Calculated refs for this branch as specified by
1368
branch._get_check_refs()
628
1369
:return: A BranchCheckResult.
630
mainline_parent_id = None
631
for revision_id in self.revision_history():
633
revision = self.repository.get_revision(revision_id)
634
except errors.NoSuchRevision, e:
635
raise errors.BzrCheckError("mainline revision {%s} not in repository"
637
# In general the first entry on the revision history has no parents.
638
# But it's not illegal for it to have parents listed; this can happen
639
# in imports from Arch when the parents weren't reachable.
640
if mainline_parent_id is not None:
641
if mainline_parent_id not in revision.parent_ids:
642
raise errors.BzrCheckError("previous revision {%s} not listed among "
644
% (mainline_parent_id, revision_id))
645
mainline_parent_id = revision_id
646
return BranchCheckResult(self)
1371
result = BranchCheckResult(self)
1372
last_revno, last_revision_id = self.last_revision_info()
1373
actual_revno = refs[('lefthand-distance', last_revision_id)]
1374
if actual_revno != last_revno:
1375
result.errors.append(errors.BzrCheckError(
1376
'revno does not match len(mainline) %s != %s' % (
1377
last_revno, actual_revno)))
1378
# TODO: We should probably also check that self.revision_history
1379
# matches the repository for older branch formats.
1380
# If looking for the code that cross-checks repository parents against
1381
# the Graph.iter_lefthand_ancestry output, that is now a repository
648
def _get_checkout_format(self):
1385
def _get_checkout_format(self, lightweight=False):
649
1386
"""Return the most suitable metadir for a checkout of this branch.
650
Weaves are used if this branch's repostory uses weaves.
1387
Weaves are used if this branch's repository uses weaves.
652
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
653
from bzrlib.repofmt import weaverepo
654
format = bzrdir.BzrDirMetaFormat1()
655
format.repository_format = weaverepo.RepositoryFormat7()
657
format = self.repository.bzrdir.checkout_metadir()
658
format.branch_format = self._format
1389
format = self.repository.bzrdir.checkout_metadir()
1390
format.set_branch_format(self._format)
1393
def create_clone_on_transport(self, to_transport, revision_id=None,
1394
stacked_on=None, create_prefix=False, use_existing_dir=False,
1396
"""Create a clone of this branch and its bzrdir.
1398
:param to_transport: The transport to clone onto.
1399
:param revision_id: The revision id to use as tip in the new branch.
1400
If None the tip is obtained from this branch.
1401
:param stacked_on: An optional URL to stack the clone on.
1402
:param create_prefix: Create any missing directories leading up to
1404
:param use_existing_dir: Use an existing directory if one exists.
1406
# XXX: Fix the bzrdir API to allow getting the branch back from the
1407
# clone call. Or something. 20090224 RBC/spiv.
1408
# XXX: Should this perhaps clone colocated branches as well,
1409
# rather than just the default branch? 20100319 JRV
1410
if revision_id is None:
1411
revision_id = self.last_revision()
1412
dir_to = self.bzrdir.clone_on_transport(to_transport,
1413
revision_id=revision_id, stacked_on=stacked_on,
1414
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1416
return dir_to.open_branch()
661
1418
def create_checkout(self, to_location, revision_id=None,
1419
lightweight=False, accelerator_tree=None,
663
1421
"""Create a checkout of a branch.
665
1423
:param to_location: The url to produce the checkout at
666
1424
:param revision_id: The revision to check out
667
1425
:param lightweight: If True, produce a lightweight checkout, otherwise,
668
produce a bound branch (heavyweight checkout)
1426
produce a bound branch (heavyweight checkout)
1427
:param accelerator_tree: A tree which can be used for retrieving file
1428
contents more quickly than the revision tree, i.e. a workingtree.
1429
The revision tree will be used for cases where accelerator_tree's
1430
content is different.
1431
:param hardlink: If true, hard-link files from accelerator_tree,
669
1433
:return: The tree of the created checkout
671
1435
t = transport.get_transport(to_location)
1437
format = self._get_checkout_format(lightweight=lightweight)
674
except errors.FileExists:
1439
checkout = format.initialize_on_transport(t)
1440
except errors.AlreadyControlDirError:
1441
# It's fine if the control directory already exists,
1442
# as long as there is no existing branch and working tree.
1443
checkout = controldir.ControlDir.open_from_transport(t)
1445
checkout.open_branch()
1446
except errors.NotBranchError:
1449
raise errors.AlreadyControlDirError(t.base)
1450
if checkout.control_transport.base == self.bzrdir.control_transport.base:
1451
# When checking out to the same control directory,
1452
# always create a lightweight checkout
677
format = self._get_checkout_format()
678
checkout = format.initialize_on_transport(t)
679
BranchReferenceFormat().initialize(checkout, self)
1456
from_branch = checkout.set_branch_reference(target_branch=self)
681
format = self._get_checkout_format()
682
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
683
to_location, force_new_tree=False, format=format)
684
checkout = checkout_branch.bzrdir
1458
policy = checkout.determine_repository_policy()
1459
repo = policy.acquire_repository()[0]
1460
checkout_branch = checkout.create_branch()
685
1461
checkout_branch.bind(self)
686
# pull up to the specified revision_id to set the initial
1462
# pull up to the specified revision_id to set the initial
687
1463
# branch tip correctly, and seed it with history.
688
1464
checkout_branch.pull(self, stop_revision=revision_id)
689
tree = checkout.create_workingtree(revision_id)
1466
tree = checkout.create_workingtree(revision_id,
1467
from_branch=from_branch,
1468
accelerator_tree=accelerator_tree,
690
1470
basis_tree = tree.basis_tree()
691
1471
basis_tree.lock_read()
699
1479
basis_tree.unlock()
702
def reference_parent(self, file_id, path):
1483
def reconcile(self, thorough=True):
1484
"""Make sure the data stored in this branch is consistent."""
1485
from bzrlib.reconcile import BranchReconciler
1486
reconciler = BranchReconciler(self, thorough=thorough)
1487
reconciler.reconcile()
1490
def reference_parent(self, file_id, path, possible_transports=None):
703
1491
"""Return the parent branch for a tree-reference file_id
704
1493
:param file_id: The file_id of the tree reference
705
1494
:param path: The path of the file_id in the tree
706
1495
:return: A branch associated with the file_id
708
1497
# FIXME should provide multiple branches, based on config
709
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1498
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1499
possible_transports=possible_transports)
711
1501
def supports_tags(self):
712
1502
return self._format.supports_tags()
715
class BranchFormat(object):
1504
def automatic_tag_name(self, revision_id):
1505
"""Try to automatically find the tag name for a revision.
1507
:param revision_id: Revision id of the revision.
1508
:return: A tag name or None if no tag name could be determined.
1510
for hook in Branch.hooks['automatic_tag_name']:
1511
ret = hook(self, revision_id)
1516
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1518
"""Ensure that revision_b is a descendant of revision_a.
1520
This is a helper function for update_revisions.
1522
:raises: DivergedBranches if revision_b has diverged from revision_a.
1523
:returns: True if revision_b is a descendant of revision_a.
1525
relation = self._revision_relations(revision_a, revision_b, graph)
1526
if relation == 'b_descends_from_a':
1528
elif relation == 'diverged':
1529
raise errors.DivergedBranches(self, other_branch)
1530
elif relation == 'a_descends_from_b':
1533
raise AssertionError("invalid relation: %r" % (relation,))
1535
def _revision_relations(self, revision_a, revision_b, graph):
1536
"""Determine the relationship between two revisions.
1538
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1540
heads = graph.heads([revision_a, revision_b])
1541
if heads == set([revision_b]):
1542
return 'b_descends_from_a'
1543
elif heads == set([revision_a, revision_b]):
1544
# These branches have diverged
1546
elif heads == set([revision_a]):
1547
return 'a_descends_from_b'
1549
raise AssertionError("invalid heads: %r" % (heads,))
1551
def heads_to_fetch(self):
1552
"""Return the heads that must and that should be fetched to copy this
1553
branch into another repo.
1555
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1556
set of heads that must be fetched. if_present_fetch is a set of
1557
heads that must be fetched if present, but no error is necessary if
1558
they are not present.
1560
# For bzr native formats must_fetch is just the tip, and
1561
# if_present_fetch are the tags.
1562
must_fetch = set([self.last_revision()])
1563
if_present_fetch = set()
1564
if self.get_config_stack().get('branch.fetch_tags'):
1566
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1567
except errors.TagsNotSupported:
1569
must_fetch.discard(_mod_revision.NULL_REVISION)
1570
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1571
return must_fetch, if_present_fetch
1574
class BranchFormat(controldir.ControlComponentFormat):
716
1575
"""An encapsulation of the initialization and open routines for a format.
718
1577
Formats provide three things:
719
1578
* An initialization routine,
1579
* a format description
721
1580
* an open routine.
723
Formats are placed in an dict by their format string for reference
724
during branch opening. Its not required that these be instances, they
725
can be classes themselves with class methods - it simply depends on
1582
Formats are placed in an dict by their format string for reference
1583
during branch opening. It's not required that these be instances, they
1584
can be classes themselves with class methods - it simply depends on
726
1585
whether state is needed for a given format or not.
728
1587
Once a format is deprecated, just deprecate the initialize and open
729
methods on the format class. Do not deprecate the object, as the
1588
methods on the format class. Do not deprecate the object, as the
730
1589
object will be created every time regardless.
733
_default_format = None
734
"""The default format used for new branches."""
737
"""The known formats."""
740
def find_format(klass, a_bzrdir):
741
"""Return the format for the branch object in a_bzrdir."""
743
transport = a_bzrdir.get_branch_transport(None)
744
format_string = transport.get("format").read()
745
return klass._formats[format_string]
747
raise NotBranchError(path=transport.base)
749
raise errors.UnknownFormatError(format=format_string)
752
def get_default_format(klass):
753
"""Return the current default format."""
754
return klass._default_format
756
def get_format_string(self):
757
"""Return the ASCII format string that identifies this format."""
758
raise NotImplementedError(self.get_format_string)
1592
def __eq__(self, other):
1593
return self.__class__ is other.__class__
1595
def __ne__(self, other):
1596
return not (self == other)
1598
def get_reference(self, controldir, name=None):
1599
"""Get the target reference of the branch in controldir.
1601
format probing must have been completed before calling
1602
this method - it is assumed that the format of the branch
1603
in controldir is correct.
1605
:param controldir: The controldir to get the branch data from.
1606
:param name: Name of the colocated branch to fetch
1607
:return: None if the branch is not a reference branch.
1612
def set_reference(self, controldir, name, to_branch):
1613
"""Set the target reference of the branch in controldir.
1615
format probing must have been completed before calling
1616
this method - it is assumed that the format of the branch
1617
in controldir is correct.
1619
:param controldir: The controldir to set the branch reference for.
1620
:param name: Name of colocated branch to set, None for default
1621
:param to_branch: branch that the checkout is to reference
1623
raise NotImplementedError(self.set_reference)
760
1625
def get_format_description(self):
761
1626
"""Return the short format description for this format."""
762
1627
raise NotImplementedError(self.get_format_description)
764
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
766
"""Initialize a branch in a bzrdir, with specified files
768
:param a_bzrdir: The bzrdir to initialize the branch in
769
:param utf8_files: The files to create as a list of
770
(filename, content) tuples
771
:param set_format: If True, set the format with
772
self.get_format_string. (BzrBranch4 has its format set
774
:return: a branch in this format
1629
def _run_post_branch_init_hooks(self, controldir, name, branch):
1630
hooks = Branch.hooks['post_branch_init']
1633
params = BranchInitHookParams(self, controldir, name, branch)
1637
def initialize(self, controldir, name=None, repository=None,
1638
append_revisions_only=None):
1639
"""Create a branch of this format in controldir.
1641
:param name: Name of the colocated branch to create.
776
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
777
branch_transport = a_bzrdir.get_branch_transport(self)
779
'metadir': ('lock', lockdir.LockDir),
780
'branch4': ('branch-lock', lockable_files.TransportLock),
782
lock_name, lock_class = lock_map[lock_type]
783
control_files = lockable_files.LockableFiles(branch_transport,
784
lock_name, lock_class)
785
control_files.create_lock()
786
control_files.lock_write()
788
control_files.put_utf8('format', self.get_format_string())
790
for file, content in utf8_files:
791
control_files.put_utf8(file, content)
793
control_files.unlock()
794
return self.open(a_bzrdir, _found=True)
796
def initialize(self, a_bzrdir):
797
"""Create a branch of this format in a_bzrdir."""
798
1643
raise NotImplementedError(self.initialize)
800
1645
def is_supported(self):
801
1646
"""Is this format supported?
803
1648
Supported formats can be initialized and opened.
804
Unsupported formats may not support initialization or committing or
1649
Unsupported formats may not support initialization or committing or
805
1650
some other features depending on the reason for not being supported.
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.
1654
def make_tags(self, branch):
1655
"""Create a tags object for branch.
1657
This method is on BranchFormat, because BranchFormats are reflected
1658
over the wire via network_name(), whereas full Branch instances require
1659
multiple VFS method calls to operate at all.
1661
The default implementation returns a disabled-tags instance.
1663
Note that it is normal for branch to be a RemoteBranch when using tags
1666
return _mod_tag.DisabledTags(branch)
1668
def network_name(self):
1669
"""A simple byte string uniquely identifying this format for RPC calls.
1671
MetaDir branch formats use their disk format string to identify the
1672
repository over the wire. All in one formats such as bzr < 0.8, and
1673
foreign formats like svn/git and hg should use some marker which is
1674
unique and immutable.
1676
raise NotImplementedError(self.network_name)
1678
def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1679
found_repository=None, possible_transports=None):
1680
"""Return the branch object for controldir.
1682
:param controldir: A ControlDir that contains a branch.
1683
:param name: Name of colocated branch to open
1684
:param _found: a private parameter, do not use it. It is used to
1685
indicate if format probing has already be done.
1686
:param ignore_fallbacks: when set, no fallback branches will be opened
1687
(if there are any). Default is to open fallbacks.
815
1689
raise NotImplementedError(self.open)
818
def register_format(klass, format):
819
klass._formats[format.get_format_string()] = format
822
def set_default_format(klass, format):
823
klass._default_format = format
826
def unregister_format(klass, format):
827
assert klass._formats[format.get_format_string()] is format
828
del klass._formats[format.get_format_string()]
1691
def supports_set_append_revisions_only(self):
1692
"""True if this format supports set_append_revisions_only."""
1695
def supports_stacking(self):
1696
"""True if this format records a stacked-on branch."""
1699
def supports_leaving_lock(self):
1700
"""True if this format supports leaving locks in place."""
1701
return False # by default
830
1703
def __str__(self):
831
return self.get_format_string().rstrip()
1704
return self.get_format_description().rstrip()
833
1706
def supports_tags(self):
834
1707
"""True if this format supports tags stored in the branch"""
835
1708
return False # by default
837
# XXX: Probably doesn't really belong here -- mbp 20070212
838
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
840
branch_transport = a_bzrdir.get_branch_transport(self)
841
control_files = lockable_files.LockableFiles(branch_transport,
842
lock_filename, lock_class)
843
control_files.create_lock()
844
control_files.lock_write()
846
for filename, content in utf8_files:
847
control_files.put_utf8(filename, content)
849
control_files.unlock()
852
class BranchHooks(dict):
1710
def tags_are_versioned(self):
1711
"""Whether the tag container for this branch versions tags."""
1714
def supports_tags_referencing_ghosts(self):
1715
"""True if tags can reference ghost revisions."""
1719
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1720
"""A factory for a BranchFormat object, permitting simple lazy registration.
1722
While none of the built in BranchFormats are lazy registered yet,
1723
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1724
use it, and the bzr-loom plugin uses it as well (see
1725
bzrlib.plugins.loom.formats).
1728
def __init__(self, format_string, module_name, member_name):
1729
"""Create a MetaDirBranchFormatFactory.
1731
:param format_string: The format string the format has.
1732
:param module_name: Module to load the format class from.
1733
:param member_name: Attribute name within the module for the format class.
1735
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1736
self._format_string = format_string
1738
def get_format_string(self):
1739
"""See BranchFormat.get_format_string."""
1740
return self._format_string
1743
"""Used for network_format_registry support."""
1744
return self.get_obj()()
1747
class BranchHooks(Hooks):
853
1748
"""A dictionary mapping hook name to a list of callables for branch hooks.
855
e.g. ['set_rh'] Is the list of items to be called when the
856
set_revision_history function is invoked.
1750
e.g. ['post_push'] Is the list of items to be called when the
1751
push function is invoked.
859
1754
def __init__(self):
862
1757
These are all empty initially, because by default nothing should get
866
# Introduced in 0.15:
867
# invoked whenever the revision history has been set
868
# with set_revision_history. The api signature is
869
# (branch, revision_history), and the branch will
872
# invoked after a push operation completes.
873
# the api signature is
875
# containing the members
876
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
877
# where local is the local branch or None, master is the target
878
# master branch, and the rest should be self explanatory. The source
879
# is read locked and the target branches write locked. Source will
880
# be the local low-latency branch.
881
self['post_push'] = []
882
# invoked after a pull operation completes.
883
# the api signature is
885
# containing the members
886
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
887
# where local is the local branch or None, master is the target
888
# master branch, and the rest should be self explanatory. The source
889
# is read locked and the target branches write locked. The local
890
# branch is the low-latency branch.
891
self['post_pull'] = []
892
# invoked after a commit operation completes.
893
# the api signature is
894
# (local, master, old_revno, old_revid, new_revno, new_revid)
895
# old_revid is NULL_REVISION for the first commit to a branch.
896
self['post_commit'] = []
897
# invoked after a uncommit operation completes.
898
# the api signature is
899
# (local, master, old_revno, old_revid, new_revno, new_revid) where
900
# local is the local branch or None, master is the target branch,
901
# and an empty branch recieves new_revno of 0, new_revid of None.
902
self['post_uncommit'] = []
904
def install_hook(self, hook_name, a_callable):
905
"""Install a_callable in to the hook hook_name.
907
:param hook_name: A hook name. See the __init__ method of BranchHooks
908
for the complete list of hooks.
909
:param a_callable: The callable to be invoked when the hook triggers.
910
The exact signature will depend on the hook - see the __init__
911
method of BranchHooks for details on each hook.
914
self[hook_name].append(a_callable)
916
raise errors.UnknownHook('branch', hook_name)
1760
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1761
self.add_hook('open',
1762
"Called with the Branch object that has been opened after a "
1763
"branch is opened.", (1, 8))
1764
self.add_hook('post_push',
1765
"Called after a push operation completes. post_push is called "
1766
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1767
"bzr client.", (0, 15))
1768
self.add_hook('post_pull',
1769
"Called after a pull operation completes. post_pull is called "
1770
"with a bzrlib.branch.PullResult object and only runs in the "
1771
"bzr client.", (0, 15))
1772
self.add_hook('pre_commit',
1773
"Called after a commit is calculated but before it is "
1774
"completed. pre_commit is called with (local, master, old_revno, "
1775
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1776
"). old_revid is NULL_REVISION for the first commit to a branch, "
1777
"tree_delta is a TreeDelta object describing changes from the "
1778
"basis revision. hooks MUST NOT modify this delta. "
1779
" future_tree is an in-memory tree obtained from "
1780
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1782
self.add_hook('post_commit',
1783
"Called in the bzr client after a commit has completed. "
1784
"post_commit is called with (local, master, old_revno, old_revid, "
1785
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1786
"commit to a branch.", (0, 15))
1787
self.add_hook('post_uncommit',
1788
"Called in the bzr client after an uncommit completes. "
1789
"post_uncommit is called with (local, master, old_revno, "
1790
"old_revid, new_revno, new_revid) where local is the local branch "
1791
"or None, master is the target branch, and an empty branch "
1792
"receives new_revno of 0, new_revid of None.", (0, 15))
1793
self.add_hook('pre_change_branch_tip',
1794
"Called in bzr client and server before a change to the tip of a "
1795
"branch is made. pre_change_branch_tip is called with a "
1796
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1797
"commit, uncommit will all trigger this hook.", (1, 6))
1798
self.add_hook('post_change_branch_tip',
1799
"Called in bzr client and server after a change to the tip of a "
1800
"branch is made. post_change_branch_tip is called with a "
1801
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1802
"commit, uncommit will all trigger this hook.", (1, 4))
1803
self.add_hook('transform_fallback_location',
1804
"Called when a stacked branch is activating its fallback "
1805
"locations. transform_fallback_location is called with (branch, "
1806
"url), and should return a new url. Returning the same url "
1807
"allows it to be used as-is, returning a different one can be "
1808
"used to cause the branch to stack on a closer copy of that "
1809
"fallback_location. Note that the branch cannot have history "
1810
"accessing methods called on it during this hook because the "
1811
"fallback locations have not been activated. When there are "
1812
"multiple hooks installed for transform_fallback_location, "
1813
"all are called with the url returned from the previous hook."
1814
"The order is however undefined.", (1, 9))
1815
self.add_hook('automatic_tag_name',
1816
"Called to determine an automatic tag name for a revision. "
1817
"automatic_tag_name is called with (branch, revision_id) and "
1818
"should return a tag name or None if no tag name could be "
1819
"determined. The first non-None tag name returned will be used.",
1821
self.add_hook('post_branch_init',
1822
"Called after new branch initialization completes. "
1823
"post_branch_init is called with a "
1824
"bzrlib.branch.BranchInitHookParams. "
1825
"Note that init, branch and checkout (both heavyweight and "
1826
"lightweight) will all trigger this hook.", (2, 2))
1827
self.add_hook('post_switch',
1828
"Called after a checkout switches branch. "
1829
"post_switch is called with a "
1830
"bzrlib.branch.SwitchHookParams.", (2, 2))
919
1834
# install the default hooks into the Branch class.
920
1835
Branch.hooks = BranchHooks()
923
class BzrBranchFormat4(BranchFormat):
924
"""Bzr branch format 4.
927
- a revision-history file.
928
- a branch-lock lock file [ to be shared with the bzrdir ]
931
def get_format_description(self):
932
"""See BranchFormat.get_format_description()."""
933
return "Branch format 4"
935
def initialize(self, a_bzrdir):
936
"""Create a branch of this format in a_bzrdir."""
937
utf8_files = [('revision-history', ''),
940
return self._initialize_helper(a_bzrdir, utf8_files,
941
lock_type='branch4', set_format=False)
944
super(BzrBranchFormat4, self).__init__()
945
self._matchingbzrdir = bzrdir.BzrDirFormat6()
947
def open(self, a_bzrdir, _found=False):
948
"""Return the branch object for a_bzrdir
950
_found is a private parameter, do not use it. It is used to indicate
951
if format probing has already be done.
954
# we are being called directly and must probe.
955
raise NotImplementedError
956
return BzrBranch(_format=self,
957
_control_files=a_bzrdir._control_files,
959
_repository=a_bzrdir.open_repository())
962
return "Bazaar-NG branch format 4"
965
class BzrBranchFormat5(BranchFormat):
966
"""Bzr branch format 5.
969
- a revision-history file.
971
- a lock dir guarding the branch itself
972
- all of this stored in a branch/ subdirectory
973
- works with shared repositories.
975
This format is new in bzr 0.8.
978
def get_format_string(self):
979
"""See BranchFormat.get_format_string()."""
980
return "Bazaar-NG branch format 5\n"
982
def get_format_description(self):
983
"""See BranchFormat.get_format_description()."""
984
return "Branch format 5"
986
def initialize(self, a_bzrdir):
987
"""Create a branch of this format in a_bzrdir."""
988
utf8_files = [('revision-history', ''),
991
return self._initialize_helper(a_bzrdir, utf8_files)
994
super(BzrBranchFormat5, self).__init__()
995
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
997
def open(self, a_bzrdir, _found=False):
998
"""Return the branch object for a_bzrdir
1000
_found is a private parameter, do not use it. It is used to indicate
1001
if format probing has already be done.
1004
format = BranchFormat.find_format(a_bzrdir)
1005
assert format.__class__ == self.__class__
1006
transport = a_bzrdir.get_branch_transport(None)
1007
control_files = lockable_files.LockableFiles(transport, 'lock',
1009
return BzrBranch5(_format=self,
1010
_control_files=control_files,
1012
_repository=a_bzrdir.find_repository())
1015
class BzrBranchFormat6(BzrBranchFormat5):
1016
"""Branch format with last-revision
1838
class ChangeBranchTipParams(object):
1839
"""Object holding parameters passed to `*_change_branch_tip` hooks.
1841
There are 5 fields that hooks may wish to access:
1843
:ivar branch: the branch being changed
1844
:ivar old_revno: revision number before the change
1845
:ivar new_revno: revision number after the change
1846
:ivar old_revid: revision id before the change
1847
:ivar new_revid: revision id after the change
1849
The revid fields are strings. The revno fields are integers.
1852
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1853
"""Create a group of ChangeBranchTip parameters.
1855
:param branch: The branch being changed.
1856
:param old_revno: Revision number before the change.
1857
:param new_revno: Revision number after the change.
1858
:param old_revid: Tip revision id before the change.
1859
:param new_revid: Tip revision id after the change.
1861
self.branch = branch
1862
self.old_revno = old_revno
1863
self.new_revno = new_revno
1864
self.old_revid = old_revid
1865
self.new_revid = new_revid
1867
def __eq__(self, other):
1868
return self.__dict__ == other.__dict__
1871
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1872
self.__class__.__name__, self.branch,
1873
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1876
class BranchInitHookParams(object):
1877
"""Object holding parameters passed to `*_branch_init` hooks.
1879
There are 4 fields that hooks may wish to access:
1881
:ivar format: the branch format
1882
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1883
:ivar name: name of colocated branch, if any (or None)
1884
:ivar branch: the branch created
1886
Note that for lightweight checkouts, the bzrdir and format fields refer to
1887
the checkout, hence they are different from the corresponding fields in
1888
branch, which refer to the original branch.
1891
def __init__(self, format, controldir, name, branch):
1892
"""Create a group of BranchInitHook parameters.
1894
:param format: the branch format
1895
:param controldir: the ControlDir where the branch will be/has been
1897
:param name: name of colocated branch, if any (or None)
1898
:param branch: the branch created
1900
Note that for lightweight checkouts, the bzrdir and format fields refer
1901
to the checkout, hence they are different from the corresponding fields
1902
in branch, which refer to the original branch.
1904
self.format = format
1905
self.bzrdir = controldir
1907
self.branch = branch
1909
def __eq__(self, other):
1910
return self.__dict__ == other.__dict__
1913
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1916
class SwitchHookParams(object):
1917
"""Object holding parameters passed to `*_switch` hooks.
1919
There are 4 fields that hooks may wish to access:
1921
:ivar control_dir: ControlDir of the checkout to change
1922
:ivar to_branch: branch that the checkout is to reference
1923
:ivar force: skip the check for local commits in a heavy checkout
1924
:ivar revision_id: revision ID to switch to (or None)
1927
def __init__(self, control_dir, to_branch, force, revision_id):
1928
"""Create a group of SwitchHook parameters.
1930
:param control_dir: ControlDir of the checkout to change
1931
:param to_branch: branch that the checkout is to reference
1932
:param force: skip the check for local commits in a heavy checkout
1933
:param revision_id: revision ID to switch to (or None)
1935
self.control_dir = control_dir
1936
self.to_branch = to_branch
1938
self.revision_id = revision_id
1940
def __eq__(self, other):
1941
return self.__dict__ == other.__dict__
1944
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1945
self.control_dir, self.to_branch,
1949
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
1950
"""Base class for branch formats that live in meta directories.
1954
BranchFormat.__init__(self)
1955
bzrdir.BzrFormat.__init__(self)
1958
def find_format(klass, controldir, name=None):
1959
"""Return the format for the branch object in controldir."""
1961
transport = controldir.get_branch_transport(None, name=name)
1962
except errors.NoSuchFile:
1963
raise errors.NotBranchError(path=name, bzrdir=controldir)
1965
format_string = transport.get_bytes("format")
1966
except errors.NoSuchFile:
1967
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
1968
return klass._find_format(format_registry, 'branch', format_string)
1970
def _branch_class(self):
1971
"""What class to instantiate on open calls."""
1972
raise NotImplementedError(self._branch_class)
1974
def _get_initial_config(self, append_revisions_only=None):
1975
if append_revisions_only:
1976
return "append_revisions_only = True\n"
1978
# Avoid writing anything if append_revisions_only is disabled,
1979
# as that is the default.
1982
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1984
"""Initialize a branch in a control dir, with specified files
1986
:param a_bzrdir: The bzrdir to initialize the branch in
1987
:param utf8_files: The files to create as a list of
1988
(filename, content) tuples
1989
:param name: Name of colocated branch to create, if any
1990
:return: a branch in this format
1993
name = a_bzrdir._get_selected_branch()
1994
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1995
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1996
control_files = lockable_files.LockableFiles(branch_transport,
1997
'lock', lockdir.LockDir)
1998
control_files.create_lock()
1999
control_files.lock_write()
2001
utf8_files += [('format', self.as_string())]
2002
for (filename, content) in utf8_files:
2003
branch_transport.put_bytes(
2005
mode=a_bzrdir._get_file_mode())
2007
control_files.unlock()
2008
branch = self.open(a_bzrdir, name, _found=True,
2009
found_repository=repository)
2010
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2013
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2014
found_repository=None, possible_transports=None):
2015
"""See BranchFormat.open()."""
2017
name = a_bzrdir._get_selected_branch()
2019
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2020
if format.__class__ != self.__class__:
2021
raise AssertionError("wrong format %r found for %r" %
2023
transport = a_bzrdir.get_branch_transport(None, name=name)
2025
control_files = lockable_files.LockableFiles(transport, 'lock',
2027
if found_repository is None:
2028
found_repository = a_bzrdir.find_repository()
2029
return self._branch_class()(_format=self,
2030
_control_files=control_files,
2033
_repository=found_repository,
2034
ignore_fallbacks=ignore_fallbacks,
2035
possible_transports=possible_transports)
2036
except errors.NoSuchFile:
2037
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2040
def _matchingbzrdir(self):
2041
ret = bzrdir.BzrDirMetaFormat1()
2042
ret.set_branch_format(self)
2045
def supports_tags(self):
2048
def supports_leaving_lock(self):
2051
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
2053
BranchFormat.check_support_status(self,
2054
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
2056
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
2057
recommend_upgrade=recommend_upgrade, basedir=basedir)
2060
class BzrBranchFormat6(BranchFormatMetadir):
2061
"""Branch format with last-revision and tags.
1018
2063
Unlike previous formats, this has no explicit revision history. Instead,
1019
2064
this just stores the last-revision, and the left-hand history leading
1020
2065
up to there is the history.
1022
2067
This format was introduced in bzr 0.15
2068
and became the default in 0.91.
1025
def get_format_string(self):
2071
def _branch_class(self):
2075
def get_format_string(cls):
1026
2076
"""See BranchFormat.get_format_string()."""
1027
2077
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1030
2080
"""See BranchFormat.get_format_description()."""
1031
2081
return "Branch format 6"
1033
def initialize(self, a_bzrdir):
1034
"""Create a branch of this format in a_bzrdir."""
1035
utf8_files = [('last-revision', '0 null:\n'),
1036
('branch-name', ''),
1037
('branch.conf', ''),
1040
return self._initialize_helper(a_bzrdir, utf8_files)
1042
def open(self, a_bzrdir, _found=False):
1043
"""Return the branch object for a_bzrdir
1045
_found is a private parameter, do not use it. It is used to indicate
1046
if format probing has already be done.
1049
format = BranchFormat.find_format(a_bzrdir)
1050
assert format.__class__ == self.__class__
1051
transport = a_bzrdir.get_branch_transport(None)
1052
control_files = lockable_files.LockableFiles(transport, 'lock',
1054
return BzrBranch6(_format=self,
1055
_control_files=control_files,
1057
_repository=a_bzrdir.find_repository())
1059
def supports_tags(self):
1063
class BranchReferenceFormat(BranchFormat):
2083
def initialize(self, a_bzrdir, name=None, repository=None,
2084
append_revisions_only=None):
2085
"""Create a branch of this format in a_bzrdir."""
2086
utf8_files = [('last-revision', '0 null:\n'),
2088
self._get_initial_config(append_revisions_only)),
2091
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2093
def make_tags(self, branch):
2094
"""See bzrlib.branch.BranchFormat.make_tags()."""
2095
return _mod_tag.BasicTags(branch)
2097
def supports_set_append_revisions_only(self):
2101
class BzrBranchFormat8(BranchFormatMetadir):
2102
"""Metadir format supporting storing locations of subtree branches."""
2104
def _branch_class(self):
2108
def get_format_string(cls):
2109
"""See BranchFormat.get_format_string()."""
2110
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2112
def get_format_description(self):
2113
"""See BranchFormat.get_format_description()."""
2114
return "Branch format 8"
2116
def initialize(self, a_bzrdir, name=None, repository=None,
2117
append_revisions_only=None):
2118
"""Create a branch of this format in a_bzrdir."""
2119
utf8_files = [('last-revision', '0 null:\n'),
2121
self._get_initial_config(append_revisions_only)),
2125
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2127
def make_tags(self, branch):
2128
"""See bzrlib.branch.BranchFormat.make_tags()."""
2129
return _mod_tag.BasicTags(branch)
2131
def supports_set_append_revisions_only(self):
2134
def supports_stacking(self):
2137
supports_reference_locations = True
2140
class BzrBranchFormat7(BranchFormatMetadir):
2141
"""Branch format with last-revision, tags, and a stacked location pointer.
2143
The stacked location pointer is passed down to the repository and requires
2144
a repository format with supports_external_lookups = True.
2146
This format was introduced in bzr 1.6.
2149
def initialize(self, a_bzrdir, name=None, repository=None,
2150
append_revisions_only=None):
2151
"""Create a branch of this format in a_bzrdir."""
2152
utf8_files = [('last-revision', '0 null:\n'),
2154
self._get_initial_config(append_revisions_only)),
2157
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2159
def _branch_class(self):
2163
def get_format_string(cls):
2164
"""See BranchFormat.get_format_string()."""
2165
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2167
def get_format_description(self):
2168
"""See BranchFormat.get_format_description()."""
2169
return "Branch format 7"
2171
def supports_set_append_revisions_only(self):
2174
def supports_stacking(self):
2177
def make_tags(self, branch):
2178
"""See bzrlib.branch.BranchFormat.make_tags()."""
2179
return _mod_tag.BasicTags(branch)
2181
supports_reference_locations = False
2184
class BranchReferenceFormat(BranchFormatMetadir):
1064
2185
"""Bzr branch reference format.
1066
2187
Branch references are used in implementing checkouts, they
1071
2192
- a format string
1074
def get_format_string(self):
2196
def get_format_string(cls):
1075
2197
"""See BranchFormat.get_format_string()."""
1076
2198
return "Bazaar-NG Branch Reference Format 1\n"
1078
2200
def get_format_description(self):
1079
2201
"""See BranchFormat.get_format_description()."""
1080
2202
return "Checkout reference format 1"
1082
def initialize(self, a_bzrdir, target_branch=None):
2204
def get_reference(self, a_bzrdir, name=None):
2205
"""See BranchFormat.get_reference()."""
2206
transport = a_bzrdir.get_branch_transport(None, name=name)
2207
return transport.get_bytes('location')
2209
def set_reference(self, a_bzrdir, name, to_branch):
2210
"""See BranchFormat.set_reference()."""
2211
transport = a_bzrdir.get_branch_transport(None, name=name)
2212
location = transport.put_bytes('location', to_branch.base)
2214
def initialize(self, a_bzrdir, name=None, target_branch=None,
2215
repository=None, append_revisions_only=None):
1083
2216
"""Create a branch of this format in a_bzrdir."""
1084
2217
if target_branch is None:
1085
2218
# this format does not implement branch itself, thus the implicit
1086
2219
# creation contract must see it as uninitializable
1087
2220
raise errors.UninitializableFormat(self)
1088
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1089
branch_transport = a_bzrdir.get_branch_transport(self)
2221
mutter('creating branch reference in %s', a_bzrdir.user_url)
2222
if a_bzrdir._format.fixed_components:
2223
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2225
name = a_bzrdir._get_selected_branch()
2226
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1090
2227
branch_transport.put_bytes('location',
1091
target_branch.bzrdir.root_transport.base)
1092
branch_transport.put_bytes('format', self.get_format_string())
1093
return self.open(a_bzrdir, _found=True)
1096
super(BranchReferenceFormat, self).__init__()
1097
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2228
target_branch.user_url)
2229
branch_transport.put_bytes('format', self.as_string())
2230
branch = self.open(a_bzrdir, name, _found=True,
2231
possible_transports=[target_branch.bzrdir.root_transport])
2232
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1099
2235
def _make_reference_clone_function(format, a_branch):
1100
2236
"""Create a clone() routine for a branch dynamically."""
1101
def clone(to_bzrdir, revision_id=None):
2237
def clone(to_bzrdir, revision_id=None,
2238
repository_policy=None):
1102
2239
"""See Branch.clone()."""
1103
return format.initialize(to_bzrdir, a_branch)
2240
return format.initialize(to_bzrdir, target_branch=a_branch)
1104
2241
# cannot obey revision_id limits when cloning a reference ...
1105
2242
# FIXME RBC 20060210 either nuke revision_id for clone, or
1106
2243
# emit some sort of warning/error to the caller ?!
1109
def open(self, a_bzrdir, _found=False):
2246
def open(self, a_bzrdir, name=None, _found=False, location=None,
2247
possible_transports=None, ignore_fallbacks=False,
2248
found_repository=None):
1110
2249
"""Return the branch that the branch reference in a_bzrdir points at.
1112
_found is a private parameter, do not use it. It is used to indicate
1113
if format probing has already be done.
2251
:param a_bzrdir: A BzrDir that contains a branch.
2252
:param name: Name of colocated branch to open, if any
2253
:param _found: a private parameter, do not use it. It is used to
2254
indicate if format probing has already be done.
2255
:param ignore_fallbacks: when set, no fallback branches will be opened
2256
(if there are any). Default is to open fallbacks.
2257
:param location: The location of the referenced branch. If
2258
unspecified, this will be determined from the branch reference in
2260
:param possible_transports: An optional reusable transports list.
2263
name = a_bzrdir._get_selected_branch()
1116
format = BranchFormat.find_format(a_bzrdir)
1117
assert format.__class__ == self.__class__
1118
transport = a_bzrdir.get_branch_transport(None)
1119
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1120
result = real_bzrdir.open_branch()
2265
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2266
if format.__class__ != self.__class__:
2267
raise AssertionError("wrong format %r found for %r" %
2269
if location is None:
2270
location = self.get_reference(a_bzrdir, name)
2271
real_bzrdir = controldir.ControlDir.open(
2272
location, possible_transports=possible_transports)
2273
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks,
2274
possible_transports=possible_transports)
1121
2275
# this changes the behaviour of result.clone to create a new reference
1122
2276
# rather than a copy of the content of the branch.
1123
2277
# I did not use a proxy object because that needs much more extensive
2287
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2288
"""Branch format registry."""
2290
def __init__(self, other_registry=None):
2291
super(BranchFormatRegistry, self).__init__(other_registry)
2292
self._default_format = None
2294
def set_default(self, format):
2295
self._default_format = format
2297
def get_default(self):
2298
return self._default_format
2301
network_format_registry = registry.FormatRegistry()
2302
"""Registry of formats indexed by their network name.
2304
The network name for a branch format is an identifier that can be used when
2305
referring to formats with smart server operations. See
2306
BranchFormat.network_name() for more detail.
2309
format_registry = BranchFormatRegistry(network_format_registry)
1133
2312
# formats which have no format string are not discoverable
1134
2313
# and not independently creatable, so are not registered.
1135
__default_format = BzrBranchFormat5()
1136
BranchFormat.register_format(__default_format)
1137
BranchFormat.register_format(BranchReferenceFormat())
1138
BranchFormat.register_format(BzrBranchFormat6())
1139
BranchFormat.set_default_format(__default_format)
1140
_legacy_formats = [BzrBranchFormat4(),
1143
class BzrBranch(Branch):
2314
__format6 = BzrBranchFormat6()
2315
__format7 = BzrBranchFormat7()
2316
__format8 = BzrBranchFormat8()
2317
format_registry.register_lazy(
2318
"Bazaar-NG branch format 5\n", "bzrlib.branchfmt.fullhistory", "BzrBranchFormat5")
2319
format_registry.register(BranchReferenceFormat())
2320
format_registry.register(__format6)
2321
format_registry.register(__format7)
2322
format_registry.register(__format8)
2323
format_registry.set_default(__format7)
2326
class BranchWriteLockResult(LogicalLockResult):
2327
"""The result of write locking a branch.
2329
:ivar branch_token: The token obtained from the underlying branch lock, or
2331
:ivar unlock: A callable which will unlock the lock.
2334
def __init__(self, unlock, branch_token):
2335
LogicalLockResult.__init__(self, unlock)
2336
self.branch_token = branch_token
2339
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2343
class BzrBranch(Branch, _RelockDebugMixin):
1144
2344
"""A branch stored in the actual filesystem.
1146
2346
Note that it's "local" in the context of the filesystem; it doesn't
1147
2347
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1148
2348
it's writable, and can be accessed via the normal filesystem API.
2350
:ivar _transport: Transport for file operations on this branch's
2351
control files, typically pointing to the .bzr/branch directory.
2352
:ivar repository: Repository for this branch.
2353
:ivar base: The url of the base directory for this branch; the one
2354
containing the .bzr directory.
2355
:ivar name: Optional colocated branch name as it exists in the control
1151
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1152
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1153
_control_files=None, a_bzrdir=None, _repository=None):
1154
"""Create new branch object at a particular location.
1156
transport -- A Transport object, defining how to access files.
1158
init -- If True, create new control files in a previously
1159
unversioned directory. If False, the branch must already
1162
relax_version_check -- If true, the usual check for the branch
1163
version is not applied. This is intended only for
1164
upgrade/recovery type use; it's not guaranteed that
1165
all operations will work on old format branches.
1167
Branch.__init__(self)
2359
def __init__(self, _format=None,
2360
_control_files=None, a_bzrdir=None, name=None,
2361
_repository=None, ignore_fallbacks=False,
2362
possible_transports=None):
2363
"""Create new branch object at a particular location."""
1168
2364
if a_bzrdir is None:
1169
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1171
self.bzrdir = a_bzrdir
1172
# self._transport used to point to the directory containing the
1173
# control directory, but was not used - now it's just the transport
1174
# for the branch control files. mbp 20070212
1175
self._base = self.bzrdir.transport.clone('..').base
2365
raise ValueError('a_bzrdir must be supplied')
2367
raise ValueError('name must be supplied')
2368
self.bzrdir = a_bzrdir
2369
self._user_transport = self.bzrdir.transport.clone('..')
2371
self._user_transport.set_segment_parameter(
2372
"branch", urlutils.escape(name))
2373
self._base = self._user_transport.base
1176
2375
self._format = _format
1177
2376
if _control_files is None:
1178
2377
raise ValueError('BzrBranch _control_files is None')
1179
2378
self.control_files = _control_files
1180
2379
self._transport = _control_files._transport
1181
if deprecated_passed(init):
1182
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1183
"deprecated as of bzr 0.8. Please use Branch.create().",
1187
# this is slower than before deprecation, oh well never mind.
1188
# -> its deprecated.
1189
self._initialize(transport.base)
1190
self._check_format(_format)
1191
if deprecated_passed(relax_version_check):
1192
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1193
"relax_version_check parameter is deprecated as of bzr 0.8. "
1194
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1198
if (not relax_version_check
1199
and not self._format.is_supported()):
1200
raise errors.UnsupportedFormatError(format=fmt)
1201
if deprecated_passed(transport):
1202
warn("BzrBranch.__init__(transport=XXX...): The transport "
1203
"parameter is deprecated as of bzr 0.8. "
1204
"Please use Branch.open, or bzrdir.open_branch().",
1207
2380
self.repository = _repository
2381
self.conf_store = None
2382
Branch.__init__(self, possible_transports)
1209
2384
def __str__(self):
1210
return '%s(%r)' % (self.__class__.__name__, self.base)
2385
return '%s(%s)' % (self.__class__.__name__, self.user_url)
1212
2387
__repr__ = __str__
1218
2393
base = property(_get_base, doc="The URL for the root of this branch.")
1220
def _finish_transaction(self):
1221
"""Exit the current transaction."""
1222
return self.control_files._finish_transaction()
1224
def get_transaction(self):
1225
"""Return the current active transaction.
1227
If no transaction is active, this returns a passthrough object
1228
for which all data is immediately flushed and no caching happens.
1230
# this is an explicit function so that we can do tricky stuff
1231
# when the storage in rev_storage is elsewhere.
1232
# we probably need to hook the two 'lock a location' and
1233
# 'have a transaction' together more delicately, so that
1234
# we can have two locks (branch and storage) and one transaction
1235
# ... and finishing the transaction unlocks both, but unlocking
1236
# does not. - RBC 20051121
1237
return self.control_files.get_transaction()
1239
def _set_transaction(self, transaction):
1240
"""Set a new active transaction."""
1241
return self.control_files._set_transaction(transaction)
1243
def abspath(self, name):
1244
"""See Branch.abspath."""
1245
return self.control_files._transport.abspath(name)
1247
def _check_format(self, format):
1248
"""Identify the branch format if needed.
1250
The format is stored as a reference to the format object in
1251
self._format for code that needs to check it later.
1253
The format parameter is either None or the branch format class
1254
used to open this branch.
1256
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1259
format = BranchFormat.find_format(self.bzrdir)
1260
self._format = format
1261
mutter("got branch format %s", self._format)
1264
def get_root_id(self):
1265
"""See Branch.get_root_id."""
1266
tree = self.repository.revision_tree(self.last_revision())
1267
return tree.inventory.root.file_id
2396
def user_transport(self):
2397
return self._user_transport
2399
def _get_config(self):
2400
return _mod_config.TransportConfig(self._transport, 'branch.conf')
2402
def _get_config_store(self):
2403
if self.conf_store is None:
2404
self.conf_store = _mod_config.BranchStore(self)
2405
return self.conf_store
2407
def _uncommitted_branch(self):
2408
"""Return the branch that may contain uncommitted changes."""
2409
master = self.get_master_branch()
2410
if master is not None:
2415
def store_uncommitted(self, creator):
2416
"""Store uncommitted changes from a ShelfCreator.
2418
:param creator: The ShelfCreator containing uncommitted changes, or
2419
None to delete any stored changes.
2420
:raises: ChangesAlreadyStored if the branch already has changes.
2422
branch = self._uncommitted_branch()
2424
branch._transport.delete('stored-transform')
2426
if branch._transport.has('stored-transform'):
2427
raise errors.ChangesAlreadyStored
2428
transform = StringIO()
2429
creator.write_shelf(transform)
2431
branch._transport.put_file('stored-transform', transform)
2433
def get_unshelver(self, tree):
2434
"""Return a shelf.Unshelver for this branch and tree.
2436
:param tree: The tree to use to construct the Unshelver.
2437
:return: an Unshelver or None if no changes are stored.
2439
branch = self._uncommitted_branch()
2441
transform = branch._transport.get('stored-transform')
2442
except errors.NoSuchFile:
2444
return shelf.Unshelver.from_tree_and_shelf(tree, transform)
1269
2446
def is_locked(self):
1270
2447
return self.control_files.is_locked()
1272
def lock_write(self):
1273
self.repository.lock_write()
2449
def lock_write(self, token=None):
2450
"""Lock the branch for write operations.
2452
:param token: A token to permit reacquiring a previously held and
2454
:return: A BranchWriteLockResult.
2456
if not self.is_locked():
2457
self._note_lock('w')
2458
self.repository._warn_if_deprecated(self)
2459
self.repository.lock_write()
1275
self.control_files.lock_write()
2464
return BranchWriteLockResult(self.unlock,
2465
self.control_files.lock_write(token=token))
1277
self.repository.unlock()
2468
self.repository.unlock()
1280
2471
def lock_read(self):
1281
self.repository.lock_read()
2472
"""Lock the branch for read operations.
2474
:return: A bzrlib.lock.LogicalLockResult.
2476
if not self.is_locked():
2477
self._note_lock('r')
2478
self.repository._warn_if_deprecated(self)
2479
self.repository.lock_read()
1283
2484
self.control_files.lock_read()
2485
return LogicalLockResult(self.unlock)
1285
self.repository.unlock()
2488
self.repository.unlock()
2491
@only_raises(errors.LockNotHeld, errors.LockBroken)
1288
2492
def unlock(self):
1289
# TODO: test for failed two phase locks. This is known broken.
2493
if self.control_files._lock_count == 1 and self.conf_store is not None:
2494
self.conf_store.save_changes()
1291
2496
self.control_files.unlock()
1293
self.repository.unlock()
2498
if not self.control_files.is_locked():
2499
self.repository.unlock()
2500
# we just released the lock
2501
self._clear_cached_state()
1295
2503
def peek_lock_mode(self):
1296
2504
if self.control_files._lock_count == 0:
1307
2515
return self.repository.print_file(file, revision_id)
1309
2517
@needs_write_lock
1310
def append_revision(self, *revision_ids):
1311
"""See Branch.append_revision."""
1312
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1313
for revision_id in revision_ids:
1314
_mod_revision.check_not_reserved_id(revision_id)
1315
mutter("add {%s} to revision-history" % revision_id)
1316
rev_history = self.revision_history()
1317
rev_history.extend(revision_ids)
1318
self.set_revision_history(rev_history)
1320
def _write_revision_history(self, history):
1321
"""Factored out of set_revision_history.
1323
This performs the actual writing to disk.
1324
It is intended to be called by BzrBranch5.set_revision_history."""
1325
self.control_files.put_bytes(
1326
'revision-history', '\n'.join(history))
1329
def set_revision_history(self, rev_history):
1330
"""See Branch.set_revision_history."""
1331
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1332
self._write_revision_history(rev_history)
1333
transaction = self.get_transaction()
1334
history = transaction.map.find_revision_history()
1335
if history is not None:
1336
# update the revision history in the identity map.
1337
history[:] = list(rev_history)
1338
# this call is disabled because revision_history is
1339
# not really an object yet, and the transaction is for objects.
1340
# transaction.register_dirty(history)
1342
transaction.map.add_revision_history(rev_history)
1343
# this call is disabled because revision_history is
1344
# not really an object yet, and the transaction is for objects.
1345
# transaction.register_clean(history)
1346
for hook in Branch.hooks['set_rh']:
1347
hook(self, rev_history)
1350
2518
def set_last_revision_info(self, revno, revision_id):
1351
revision_id = osutils.safe_revision_id(revision_id)
1352
history = self._lefthand_history(revision_id)
1353
assert len(history) == revno, '%d != %d' % (len(history), revno)
1354
self.set_revision_history(history)
1356
def _gen_revision_history(self):
1357
history = self.control_files.get('revision-history').read().split('\n')
1358
if history[-1:] == ['']:
1359
# There shouldn't be a trailing newline, but just in case.
1364
def revision_history(self):
1365
"""See Branch.revision_history."""
1366
transaction = self.get_transaction()
1367
history = transaction.map.find_revision_history()
1368
if history is not None:
1369
# mutter("cache hit for revision-history in %s", self)
1370
return list(history)
1371
history = self._gen_revision_history()
1372
transaction.map.add_revision_history(history)
1373
# this call is disabled because revision_history is
1374
# not really an object yet, and the transaction is for objects.
1375
# transaction.register_clean(history, precious=True)
1376
return list(history)
1378
def _lefthand_history(self, revision_id, last_rev=None,
1380
# stop_revision must be a descendant of last_revision
1381
stop_graph = self.repository.get_revision_graph(revision_id)
1382
if last_rev is not None and last_rev not in stop_graph:
1383
# our previous tip is not merged into stop_revision
1384
raise errors.DivergedBranches(self, other_branch)
1385
# make a new revision history from the graph
1386
current_rev_id = revision_id
1388
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1389
new_history.append(current_rev_id)
1390
current_rev_id_parents = stop_graph[current_rev_id]
1392
current_rev_id = current_rev_id_parents[0]
1394
current_rev_id = None
1395
new_history.reverse()
1399
def generate_revision_history(self, revision_id, last_rev=None,
1401
"""Create a new revision history that will finish with revision_id.
1403
:param revision_id: the new tip to use.
1404
:param last_rev: The previous last_revision. If not None, then this
1405
must be a ancestory of revision_id, or DivergedBranches is raised.
1406
:param other_branch: The other branch that DivergedBranches should
1407
raise with respect to.
1409
revision_id = osutils.safe_revision_id(revision_id)
1410
self.set_revision_history(self._lefthand_history(revision_id,
1411
last_rev, other_branch))
1414
def update_revisions(self, other, stop_revision=None):
1415
"""See Branch.update_revisions."""
1418
if stop_revision is None:
1419
stop_revision = other.last_revision()
1420
if stop_revision is None:
1421
# if there are no commits, we're done.
1424
stop_revision = osutils.safe_revision_id(stop_revision)
1425
# whats the current last revision, before we fetch [and change it
1427
last_rev = self.last_revision()
1428
# we fetch here regardless of whether we need to so that we pickup
1430
self.fetch(other, stop_revision)
1431
my_ancestry = self.repository.get_ancestry(last_rev)
1432
if stop_revision in my_ancestry:
1433
# last_revision is a descendant of stop_revision
1435
self.generate_revision_history(stop_revision, last_rev=last_rev,
2519
if not revision_id or not isinstance(revision_id, basestring):
2520
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2521
revision_id = _mod_revision.ensure_null(revision_id)
2522
old_revno, old_revid = self.last_revision_info()
2523
if self.get_append_revisions_only():
2524
self._check_history_violation(revision_id)
2525
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2526
self._write_last_revision_info(revno, revision_id)
2527
self._clear_cached_state()
2528
self._last_revision_info_cache = revno, revision_id
2529
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1440
2531
def basis_tree(self):
1441
2532
"""See Branch.basis_tree."""
1442
2533
return self.repository.revision_tree(self.last_revision())
1444
@deprecated_method(zero_eight)
1445
def working_tree(self):
1446
"""Create a Working tree object for this branch."""
1448
from bzrlib.transport.local import LocalTransport
1449
if (self.base.find('://') != -1 or
1450
not isinstance(self._transport, LocalTransport)):
1451
raise NoWorkingTree(self.base)
1452
return self.bzrdir.open_workingtree()
1455
def pull(self, source, overwrite=False, stop_revision=None,
1456
_hook_master=None, _run_hooks=True):
1459
:param _hook_master: Private parameter - set the branch to
1460
be supplied as the master to push hooks.
1461
:param _run_hooks: Private parameter - allow disabling of
1462
hooks, used when pushing to a master branch.
1464
result = PullResult()
1465
result.source_branch = source
1466
result.target_branch = self
1469
result.old_revno, result.old_revid = self.last_revision_info()
1471
self.update_revisions(source, stop_revision)
1472
except DivergedBranches:
1476
if stop_revision is None:
1477
stop_revision = source.last_revision()
1478
self.generate_revision_history(stop_revision)
1479
result.tag_conflicts = source.tags.merge_to(self.tags)
1480
result.new_revno, result.new_revid = self.last_revision_info()
1482
result.master_branch = _hook_master
1483
result.local_branch = self
1485
result.master_branch = self
1486
result.local_branch = None
1488
for hook in Branch.hooks['post_pull']:
1494
2535
def _get_parent_location(self):
1495
2536
_locs = ['parent', 'pull', 'x-pull']
1496
2537
for l in _locs:
1498
return self.control_files.get(l).read().strip('\n')
2539
return self._transport.get_bytes(l).strip('\n')
2540
except errors.NoSuchFile:
1504
def push(self, target, overwrite=False, stop_revision=None,
1505
_hook_master=None, _run_hooks=True):
1508
:param _hook_master: Private parameter - set the branch to
1509
be supplied as the master to push hooks.
1510
:param _run_hooks: Private parameter - allow disabling of
1511
hooks, used when pushing to a master branch.
1513
result = PushResult()
1514
result.source_branch = self
1515
result.target_branch = target
1518
result.old_revno, result.old_revid = target.last_revision_info()
1520
target.update_revisions(self, stop_revision)
1521
except DivergedBranches:
1525
target.set_revision_history(self.revision_history())
1526
result.tag_conflicts = self.tags.merge_to(target.tags)
1527
result.new_revno, result.new_revid = target.last_revision_info()
1529
result.master_branch = _hook_master
1530
result.local_branch = target
1532
result.master_branch = target
1533
result.local_branch = None
1535
for hook in Branch.hooks['post_push']:
1541
def get_parent(self):
1542
"""See Branch.get_parent."""
1544
assert self.base[-1] == '/'
1545
parent = self._get_parent_location()
1548
# This is an old-format absolute path to a local branch
1549
# turn it into a url
1550
if parent.startswith('/'):
1551
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1553
return urlutils.join(self.base[:-1], parent)
1554
except errors.InvalidURLJoin, e:
1555
raise errors.InaccessibleParent(parent, self.base)
1557
def get_push_location(self):
1558
"""See Branch.get_push_location."""
1559
push_loc = self.get_config().get_user_option('push_location')
2544
def get_stacked_on_url(self):
2545
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1562
2547
def set_push_location(self, location):
1563
2548
"""See Branch.set_push_location."""
1565
2550
'push_location', location,
1566
2551
store=_mod_config.STORE_LOCATION_NORECURSE)
1569
def set_parent(self, url):
1570
"""See Branch.set_parent."""
1571
# TODO: Maybe delete old location files?
1572
# URLs should never be unicode, even on the local fs,
1573
# FIXUP this and get_parent in a future branch format bump:
1574
# read and rewrite the file, and have the new format code read
1575
# using .get not .get_utf8. RBC 20060125
1577
if isinstance(url, unicode):
1579
url = url.encode('ascii')
1580
except UnicodeEncodeError:
1581
raise bzrlib.errors.InvalidURL(url,
1582
"Urls must be 7-bit ascii, "
1583
"use bzrlib.urlutils.escape")
1584
url = urlutils.relative_url(self.base, url)
1585
self._set_parent_location(url)
1587
2553
def _set_parent_location(self, url):
1588
2554
if url is None:
1589
self.control_files._transport.delete('parent')
1591
assert isinstance(url, str)
1592
self.control_files.put_bytes('parent', url + '\n')
1594
@deprecated_function(zero_nine)
1595
def tree_config(self):
1596
"""DEPRECATED; call get_config instead.
1597
TreeConfig has become part of BranchConfig."""
1598
return TreeConfig(self)
1601
class BzrBranch5(BzrBranch):
1602
"""A format 5 branch. This supports new features over plan branches.
1604
It has support for a master_branch which is the data for bound branches.
1612
super(BzrBranch5, self).__init__(_format=_format,
1613
_control_files=_control_files,
1615
_repository=_repository)
1618
def pull(self, source, overwrite=False, stop_revision=None,
1620
"""Extends branch.pull to be bound branch aware.
1622
:param _run_hooks: Private parameter used to force hook running
1623
off during bound branch double-pushing.
1625
bound_location = self.get_bound_location()
1626
master_branch = None
1627
if bound_location and source.base != bound_location:
1628
# not pulling from master, so we need to update master.
1629
master_branch = self.get_master_branch()
1630
master_branch.lock_write()
1633
# pull from source into master.
1634
master_branch.pull(source, overwrite, stop_revision,
1636
return super(BzrBranch5, self).pull(source, overwrite,
1637
stop_revision, _hook_master=master_branch,
1638
_run_hooks=_run_hooks)
1641
master_branch.unlock()
1644
def push(self, target, overwrite=False, stop_revision=None):
1645
"""Updates branch.push to be bound branch aware."""
1646
bound_location = target.get_bound_location()
1647
master_branch = None
1648
if bound_location and target.base != bound_location:
1649
# not pushing to master, so we need to update master.
1650
master_branch = target.get_master_branch()
1651
master_branch.lock_write()
1654
# push into the master from this branch.
1655
super(BzrBranch5, self).push(master_branch, overwrite,
1656
stop_revision, _run_hooks=False)
1657
# and push into the target branch from this. Note that we push from
1658
# this branch again, because its considered the highest bandwidth
1660
return super(BzrBranch5, self).push(target, overwrite,
1661
stop_revision, _hook_master=master_branch)
1664
master_branch.unlock()
1666
def get_bound_location(self):
1668
return self.control_files.get_utf8('bound').read()[:-1]
1669
except errors.NoSuchFile:
1673
def get_master_branch(self):
1674
"""Return the branch we are bound to.
1676
:return: Either a Branch, or None
1678
This could memoise the branch, but if thats done
1679
it must be revalidated on each new lock.
1680
So for now we just don't memoise it.
1681
# RBC 20060304 review this decision.
1683
bound_loc = self.get_bound_location()
1687
return Branch.open(bound_loc)
1688
except (errors.NotBranchError, errors.ConnectionError), e:
1689
raise errors.BoundBranchConnectionFailure(
1693
def set_bound_location(self, location):
1694
"""Set the target where this branch is bound to.
1696
:param location: URL to the target branch
1699
self.control_files.put_utf8('bound', location+'\n')
1702
self.control_files._transport.delete('bound')
2555
self._transport.delete('parent')
2557
self._transport.put_bytes('parent', url + '\n',
2558
mode=self.bzrdir._get_file_mode())
2562
"""If bound, unbind"""
2563
return self.set_bound_location(None)
1707
2565
@needs_write_lock
1708
2566
def bind(self, other):
1728
2586
# last_rev is not in the other_last_rev history, AND
1729
2587
# other_last_rev is not in our history, and do it without pulling
1730
2588
# history around
1731
last_rev = self.last_revision()
1732
if last_rev is not None:
1735
other_last_rev = other.last_revision()
1736
if other_last_rev is not None:
1737
# neither branch is new, we have to do some work to
1738
# ascertain diversion.
1739
remote_graph = other.repository.get_revision_graph(
1741
local_graph = self.repository.get_revision_graph(last_rev)
1742
if (last_rev not in remote_graph and
1743
other_last_rev not in local_graph):
1744
raise errors.DivergedBranches(self, other)
1747
2589
self.set_bound_location(other.base)
1751
"""If bound, unbind"""
1752
return self.set_bound_location(None)
1756
"""Synchronise this branch with the master branch if any.
2591
def get_bound_location(self):
2593
return self._transport.get_bytes('bound')[:-1]
2594
except errors.NoSuchFile:
2598
def get_master_branch(self, possible_transports=None):
2599
"""Return the branch we are bound to.
2601
:return: Either a Branch, or None
2603
if self._master_branch_cache is None:
2604
self._master_branch_cache = self._get_master_branch(
2605
possible_transports)
2606
return self._master_branch_cache
2608
def _get_master_branch(self, possible_transports):
2609
bound_loc = self.get_bound_location()
2613
return Branch.open(bound_loc,
2614
possible_transports=possible_transports)
2615
except (errors.NotBranchError, errors.ConnectionError), e:
2616
raise errors.BoundBranchConnectionFailure(
2620
def set_bound_location(self, location):
2621
"""Set the target where this branch is bound to.
2623
:param location: URL to the target branch
2625
self._master_branch_cache = None
2627
self._transport.put_bytes('bound', location+'\n',
2628
mode=self.bzrdir._get_file_mode())
2631
self._transport.delete('bound')
2632
except errors.NoSuchFile:
2637
def update(self, possible_transports=None):
2638
"""Synchronise this branch with the master branch if any.
1758
2640
:return: None or the last_revision that was pivoted out during the
1761
master = self.get_master_branch()
2643
master = self.get_master_branch(possible_transports)
1762
2644
if master is not None:
1763
old_tip = self.last_revision()
2645
old_tip = _mod_revision.ensure_null(self.last_revision())
1764
2646
self.pull(master, overwrite=True)
1765
if old_tip in self.repository.get_ancestry(self.last_revision()):
2647
if self.repository.get_graph().is_ancestor(old_tip,
2648
_mod_revision.ensure_null(self.last_revision())):
1771
class BzrBranchExperimental(BzrBranch5):
1772
"""Bzr experimental branch format
1775
- a revision-history file.
1777
- a lock dir guarding the branch itself
1778
- all of this stored in a branch/ subdirectory
1779
- works with shared repositories.
1780
- a tag dictionary in the branch
1782
This format is new in bzr 0.15, but shouldn't be used for real data,
1785
This class acts as it's own BranchFormat.
1788
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1791
def get_format_string(cls):
1792
"""See BranchFormat.get_format_string()."""
1793
return "Bazaar-NG branch format experimental\n"
1796
def get_format_description(cls):
1797
"""See BranchFormat.get_format_description()."""
1798
return "Experimental branch format"
1801
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1803
branch_transport = a_bzrdir.get_branch_transport(cls)
1804
control_files = lockable_files.LockableFiles(branch_transport,
1805
lock_filename, lock_class)
1806
control_files.create_lock()
1807
control_files.lock_write()
1809
for filename, content in utf8_files:
1810
control_files.put_utf8(filename, content)
1812
control_files.unlock()
1815
def initialize(cls, a_bzrdir):
1816
"""Create a branch of this format in a_bzrdir."""
1817
utf8_files = [('format', cls.get_format_string()),
1818
('revision-history', ''),
1819
('branch-name', ''),
1822
cls._initialize_control_files(a_bzrdir, utf8_files,
1823
'lock', lockdir.LockDir)
1824
return cls.open(a_bzrdir, _found=True)
1827
def open(cls, a_bzrdir, _found=False):
1828
"""Return the branch object for a_bzrdir
1830
_found is a private parameter, do not use it. It is used to indicate
1831
if format probing has already be done.
1834
format = BranchFormat.find_format(a_bzrdir)
1835
assert format.__class__ == cls
1836
transport = a_bzrdir.get_branch_transport(None)
1837
control_files = lockable_files.LockableFiles(transport, 'lock',
1839
return cls(_format=cls,
1840
_control_files=control_files,
1842
_repository=a_bzrdir.find_repository())
1845
def is_supported(cls):
1848
def _make_tags(self):
1849
return BasicTags(self)
1852
def supports_tags(cls):
1856
BranchFormat.register_format(BzrBranchExperimental)
1859
class BzrBranch6(BzrBranch5):
1862
def last_revision_info(self):
1863
revision_string = self.control_files.get('last-revision').read()
2653
def _read_last_revision_info(self):
2654
revision_string = self._transport.get_bytes('last-revision')
1864
2655
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1865
2656
revision_id = cache_utf8.get_cached_utf8(revision_id)
1866
2657
revno = int(revno)
1867
2658
return revno, revision_id
1869
def last_revision(self):
1870
"""Return last revision id, or None"""
1871
revision_id = self.last_revision_info()[1]
1872
if revision_id == _mod_revision.NULL_REVISION:
1876
2660
def _write_last_revision_info(self, revno, revision_id):
1877
2661
"""Simply write out the revision id, with no checks.
1879
2663
Use set_last_revision_info to perform this safely.
1881
2665
Does not update the revision_history cache.
1882
Intended to be called by set_last_revision_info and
1883
_write_revision_history.
1885
if revision_id is None:
1886
revision_id = 'null:'
2667
revision_id = _mod_revision.ensure_null(revision_id)
1887
2668
out_string = '%d %s\n' % (revno, revision_id)
1888
self.control_files.put_bytes('last-revision', out_string)
2669
self._transport.put_bytes('last-revision', out_string,
2670
mode=self.bzrdir._get_file_mode())
1890
2672
@needs_write_lock
1891
def set_last_revision_info(self, revno, revision_id):
1892
revision_id = osutils.safe_revision_id(revision_id)
1893
if self._get_append_revisions_only():
1894
self._check_history_violation(revision_id)
1895
self._write_last_revision_info(revno, revision_id)
1896
transaction = self.get_transaction()
1897
cached_history = transaction.map.find_revision_history()
1898
if cached_history is not None:
1899
transaction.map.remove_object(cached_history)
2673
def update_feature_flags(self, updated_flags):
2674
"""Update the feature flags for this branch.
2676
:param updated_flags: Dictionary mapping feature names to necessities
2677
A necessity can be None to indicate the feature should be removed
2679
self._format._update_feature_flags(updated_flags)
2680
self.control_transport.put_bytes('format', self._format.as_string())
2683
class BzrBranch8(BzrBranch):
2684
"""A branch that stores tree-reference locations."""
2686
def _open_hook(self, possible_transports=None):
2687
if self._ignore_fallbacks:
2689
if possible_transports is None:
2690
possible_transports = [self.bzrdir.root_transport]
2692
url = self.get_stacked_on_url()
2693
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2694
errors.UnstackableBranchFormat):
2697
for hook in Branch.hooks['transform_fallback_location']:
2698
url = hook(self, url)
2700
hook_name = Branch.hooks.get_hook_name(hook)
2701
raise AssertionError(
2702
"'transform_fallback_location' hook %s returned "
2703
"None, not a URL." % hook_name)
2704
self._activate_fallback_location(url,
2705
possible_transports=possible_transports)
2707
def __init__(self, *args, **kwargs):
2708
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2709
super(BzrBranch8, self).__init__(*args, **kwargs)
2710
self._last_revision_info_cache = None
2711
self._reference_info = None
2713
def _clear_cached_state(self):
2714
super(BzrBranch8, self)._clear_cached_state()
2715
self._last_revision_info_cache = None
2716
self._reference_info = None
1901
2718
def _check_history_violation(self, revision_id):
1902
last_revision = self.last_revision()
1903
if last_revision is None:
2719
current_revid = self.last_revision()
2720
last_revision = _mod_revision.ensure_null(current_revid)
2721
if _mod_revision.is_null(last_revision):
1905
if last_revision not in self._lefthand_history(revision_id):
1906
raise errors.AppendRevisionsOnlyViolation(self.base)
2723
graph = self.repository.get_graph()
2724
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2725
if lh_ancestor == current_revid:
2727
raise errors.AppendRevisionsOnlyViolation(self.user_url)
1908
2729
def _gen_revision_history(self):
1909
2730
"""Generate the revision history from last revision
1911
history = list(self.repository.iter_reverse_revision_history(
1912
self.last_revision()))
1916
def _write_revision_history(self, history):
1917
"""Factored out of set_revision_history.
1919
This performs the actual writing to disk, with format-specific checks.
1920
It is intended to be called by BzrBranch5.set_revision_history.
1922
if len(history) == 0:
1923
last_revision = 'null:'
1925
if history != self._lefthand_history(history[-1]):
1926
raise errors.NotLefthandHistory(history)
1927
last_revision = history[-1]
1928
if self._get_append_revisions_only():
1929
self._check_history_violation(last_revision)
1930
self._write_last_revision_info(len(history), last_revision)
1933
def append_revision(self, *revision_ids):
1934
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1935
if len(revision_ids) == 0:
1937
prev_revno, prev_revision = self.last_revision_info()
1938
for revision in self.repository.get_revisions(revision_ids):
1939
if prev_revision == _mod_revision.NULL_REVISION:
1940
if revision.parent_ids != []:
1941
raise errors.NotLeftParentDescendant(self, prev_revision,
1942
revision.revision_id)
1944
if revision.parent_ids[0] != prev_revision:
1945
raise errors.NotLeftParentDescendant(self, prev_revision,
1946
revision.revision_id)
1947
prev_revision = revision.revision_id
1948
self.set_last_revision_info(prev_revno + len(revision_ids),
1951
def _set_config_location(self, name, url, config=None,
1952
make_relative=False):
1954
config = self.get_config()
1958
url = urlutils.relative_url(self.base, url)
1959
config.set_user_option(name, url)
1962
def _get_config_location(self, name, config=None):
1964
config = self.get_config()
1965
location = config.get_user_option(name)
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))
1970
2736
@needs_write_lock
1971
2737
def _set_parent_location(self, url):
1977
2743
"""Set the parent branch"""
1978
2744
return self._get_config_location('parent_location')
2747
def _set_all_reference_info(self, info_dict):
2748
"""Replace all reference info stored in a branch.
2750
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2753
writer = rio.RioWriter(s)
2754
for key, (tree_path, branch_location) in info_dict.iteritems():
2755
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2756
branch_location=branch_location)
2757
writer.write_stanza(stanza)
2758
self._transport.put_bytes('references', s.getvalue())
2759
self._reference_info = info_dict
2762
def _get_all_reference_info(self):
2763
"""Return all the reference info stored in a branch.
2765
:return: A dict of {file_id: (tree_path, branch_location)}
2767
if self._reference_info is not None:
2768
return self._reference_info
2769
rio_file = self._transport.get('references')
2771
stanzas = rio.read_stanzas(rio_file)
2772
info_dict = dict((s['file_id'], (s['tree_path'],
2773
s['branch_location'])) for s in stanzas)
2776
self._reference_info = info_dict
2779
def set_reference_info(self, file_id, tree_path, branch_location):
2780
"""Set the branch location to use for a tree reference.
2782
:param file_id: The file-id of the tree reference.
2783
:param tree_path: The path of the tree reference in the tree.
2784
:param branch_location: The location of the branch to retrieve tree
2787
info_dict = self._get_all_reference_info()
2788
info_dict[file_id] = (tree_path, branch_location)
2789
if None in (tree_path, branch_location):
2790
if tree_path is not None:
2791
raise ValueError('tree_path must be None when branch_location'
2793
if branch_location is not None:
2794
raise ValueError('branch_location must be None when tree_path'
2796
del info_dict[file_id]
2797
self._set_all_reference_info(info_dict)
2799
def get_reference_info(self, file_id):
2800
"""Get the tree_path and branch_location for a tree reference.
2802
:return: a tuple of (tree_path, branch_location)
2804
return self._get_all_reference_info().get(file_id, (None, None))
2806
def reference_parent(self, file_id, path, possible_transports=None):
2807
"""Return the parent branch for a tree-reference file_id.
2809
:param file_id: The file_id of the tree reference
2810
:param path: The path of the file_id in the tree
2811
:return: A branch associated with the file_id
2813
branch_location = self.get_reference_info(file_id)[1]
2814
if branch_location is None:
2815
return Branch.reference_parent(self, file_id, path,
2816
possible_transports)
2817
branch_location = urlutils.join(self.user_url, branch_location)
2818
return Branch.open(branch_location,
2819
possible_transports=possible_transports)
1980
2821
def set_push_location(self, location):
1981
2822
"""See Branch.set_push_location."""
1982
2823
self._set_config_location('push_location', location)
1984
2825
def set_bound_location(self, location):
1985
2826
"""See Branch.set_push_location."""
2827
self._master_branch_cache = None
1987
config = self.get_config()
2829
conf = self.get_config_stack()
1988
2830
if location is None:
1989
if config.get_user_option('bound') != 'True':
2831
if not conf.get('bound'):
1992
config.set_user_option('bound', 'False')
2834
conf.set('bound', 'False')
1995
2837
self._set_config_location('bound_location', location,
1997
config.set_user_option('bound', 'True')
2839
conf.set('bound', 'True')
2000
2842
def _get_bound_location(self, bound):
2001
2843
"""Return the bound location in the config file.
2003
2845
Return None if the bound parameter does not match"""
2004
config = self.get_config()
2005
config_bound = (config.get_user_option('bound') == 'True')
2006
if config_bound != bound:
2846
conf = self.get_config_stack()
2847
if conf.get('bound') != bound:
2008
return self._get_config_location('bound_location', config=config)
2849
return self._get_config_location('bound_location', config=conf)
2010
2851
def get_bound_location(self):
2011
"""See Branch.set_push_location."""
2852
"""See Branch.get_bound_location."""
2012
2853
return self._get_bound_location(True)
2014
2855
def get_old_bound_location(self):
2015
2856
"""See Branch.get_old_bound_location"""
2016
2857
return self._get_bound_location(False)
2018
def set_append_revisions_only(self, enabled):
2023
self.get_config().set_user_option('append_revisions_only', value)
2025
def _get_append_revisions_only(self):
2026
value = self.get_config().get_user_option('append_revisions_only')
2027
return value == 'True'
2029
def _synchronize_history(self, destination, revision_id):
2030
"""Synchronize last revision and revision history between branches.
2032
This version is most efficient when the destination is also a
2033
BzrBranch6, but works for BzrBranch5, as long as the destination's
2034
repository contains all the lefthand ancestors of the intended
2035
last_revision. If not, set_last_revision_info will fail.
2037
:param destination: The branch to copy the history into
2038
:param revision_id: The revision-id to truncate history at. May
2039
be None to copy complete history.
2041
if revision_id is None:
2042
revno, revision_id = self.last_revision_info()
2044
revno = self.revision_id_to_revno(revision_id)
2045
destination.set_last_revision_info(revno, revision_id)
2047
def _make_tags(self):
2048
return BasicTags(self)
2051
class BranchTestProviderAdapter(object):
2052
"""A tool to generate a suite testing multiple branch formats at once.
2054
This is done by copying the test once for each transport and injecting
2055
the transport_server, transport_readonly_server, and branch_format
2056
classes into each copy. Each copy is also given a new id() to make it
2859
def get_stacked_on_url(self):
2860
# you can always ask for the URL; but you might not be able to use it
2861
# if the repo can't support stacking.
2862
## self._check_stackable_repo()
2863
# stacked_on_location is only ever defined in branch.conf, so don't
2864
# waste effort reading the whole stack of config files.
2865
conf = _mod_config.BranchOnlyStack(self)
2866
stacked_url = self._get_config_location('stacked_on_location',
2868
if stacked_url is None:
2869
raise errors.NotStacked(self)
2870
return stacked_url.encode('utf-8')
2873
def get_rev_id(self, revno, history=None):
2874
"""Find the revision id of the specified revno."""
2876
return _mod_revision.NULL_REVISION
2878
last_revno, last_revision_id = self.last_revision_info()
2879
if revno <= 0 or revno > last_revno:
2880
raise errors.NoSuchRevision(self, revno)
2882
if history is not None:
2883
return history[revno - 1]
2885
index = last_revno - revno
2886
if len(self._partial_revision_history_cache) <= index:
2887
self._extend_partial_history(stop_index=index)
2888
if len(self._partial_revision_history_cache) > index:
2889
return self._partial_revision_history_cache[index]
2891
raise errors.NoSuchRevision(self, revno)
2894
def revision_id_to_revno(self, revision_id):
2895
"""Given a revision id, return its revno"""
2896
if _mod_revision.is_null(revision_id):
2899
index = self._partial_revision_history_cache.index(revision_id)
2902
self._extend_partial_history(stop_revision=revision_id)
2903
except errors.RevisionNotPresent, e:
2904
raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2905
index = len(self._partial_revision_history_cache) - 1
2907
raise errors.NoSuchRevision(self, revision_id)
2908
if self._partial_revision_history_cache[index] != revision_id:
2909
raise errors.NoSuchRevision(self, revision_id)
2910
return self.revno() - index
2913
class BzrBranch7(BzrBranch8):
2914
"""A branch with support for a fallback repository."""
2916
def set_reference_info(self, file_id, tree_path, branch_location):
2917
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2919
def get_reference_info(self, file_id):
2920
Branch.get_reference_info(self, file_id)
2922
def reference_parent(self, file_id, path, possible_transports=None):
2923
return Branch.reference_parent(self, file_id, path,
2924
possible_transports)
2927
class BzrBranch6(BzrBranch7):
2928
"""See BzrBranchFormat6 for the capabilities of this branch.
2930
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2060
def __init__(self, transport_server, transport_readonly_server, formats):
2061
self._transport_server = transport_server
2062
self._transport_readonly_server = transport_readonly_server
2063
self._formats = formats
2065
def adapt(self, test):
2066
result = TestSuite()
2067
for branch_format, bzrdir_format in self._formats:
2068
new_test = deepcopy(test)
2069
new_test.transport_server = self._transport_server
2070
new_test.transport_readonly_server = self._transport_readonly_server
2071
new_test.bzrdir_format = bzrdir_format
2072
new_test.branch_format = branch_format
2073
def make_new_test_id():
2074
# the format can be either a class or an instance
2075
name = getattr(branch_format, '__name__',
2076
branch_format.__class__.__name__)
2077
new_id = "%s(%s)" % (new_test.id(), name)
2078
return lambda: new_id
2079
new_test.id = make_new_test_id()
2080
result.addTest(new_test)
2934
def get_stacked_on_url(self):
2935
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2084
2938
######################################################################
2102
2956
:ivar new_revno: Revision number after pull.
2103
2957
:ivar old_revid: Tip revision id before pull.
2104
2958
:ivar new_revid: Tip revision id after pull.
2105
:ivar source_branch: Source (local) branch object.
2106
:ivar master_branch: Master branch of the target, or None.
2107
:ivar target_branch: Target/destination branch object.
2959
:ivar source_branch: Source (local) branch object. (read locked)
2960
:ivar master_branch: Master branch of the target, or the target if no
2962
:ivar local_branch: target branch if there is a Master, else None
2963
:ivar target_branch: Target/destination branch object. (write locked)
2964
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2965
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
2111
# DEPRECATED: pull used to return the change in revno
2112
return self.new_revno - self.old_revno
2114
2968
def report(self, to_file):
2115
if self.old_revid == self.new_revid:
2116
to_file.write('No revisions to pull.\n')
2118
to_file.write('Now on revision %d.\n' % self.new_revno)
2969
tag_conflicts = getattr(self, "tag_conflicts", None)
2970
tag_updates = getattr(self, "tag_updates", None)
2972
if self.old_revid != self.new_revid:
2973
to_file.write('Now on revision %d.\n' % self.new_revno)
2975
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
2976
if self.old_revid == self.new_revid and not tag_updates:
2977
if not tag_conflicts:
2978
to_file.write('No revisions or tags to pull.\n')
2980
to_file.write('No revisions to pull.\n')
2119
2981
self._show_tag_conficts(to_file)
2122
class PushResult(_Result):
2984
class BranchPushResult(_Result):
2123
2985
"""Result of a Branch.push operation.
2125
:ivar old_revno: Revision number before push.
2126
:ivar new_revno: Revision number after push.
2127
:ivar old_revid: Tip revision id before push.
2128
:ivar new_revid: Tip revision id after push.
2129
:ivar source_branch: Source branch object.
2130
:ivar master_branch: Master branch of the target, or None.
2131
:ivar target_branch: Target/destination branch object.
2987
:ivar old_revno: Revision number (eg 10) of the target before push.
2988
:ivar new_revno: Revision number (eg 12) of the target after push.
2989
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2991
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2993
:ivar source_branch: Source branch object that the push was from. This is
2994
read locked, and generally is a local (and thus low latency) branch.
2995
:ivar master_branch: If target is a bound branch, the master branch of
2996
target, or target itself. Always write locked.
2997
:ivar target_branch: The direct Branch where data is being sent (write
2999
:ivar local_branch: If the target is a bound branch this will be the
3000
target, otherwise it will be None.
2135
# DEPRECATED: push used to return the change in revno
2136
return self.new_revno - self.old_revno
2138
3003
def report(self, to_file):
2139
"""Write a human-readable description of the result."""
2140
if self.old_revid == self.new_revid:
2141
to_file.write('No new revisions to push.\n')
2143
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
3004
# TODO: This function gets passed a to_file, but then
3005
# ignores it and calls note() instead. This is also
3006
# inconsistent with PullResult(), which writes to stdout.
3007
# -- JRV20110901, bug #838853
3008
tag_conflicts = getattr(self, "tag_conflicts", None)
3009
tag_updates = getattr(self, "tag_updates", None)
3011
if self.old_revid != self.new_revid:
3012
note(gettext('Pushed up to revision %d.') % self.new_revno)
3014
note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3015
if self.old_revid == self.new_revid and not tag_updates:
3016
if not tag_conflicts:
3017
note(gettext('No new revisions or tags to push.'))
3019
note(gettext('No new revisions to push.'))
2144
3020
self._show_tag_conficts(to_file)
2173
3051
new_branch = format.open(branch.bzrdir, _found=True)
2175
3053
# Copy source data into target
2176
new_branch.set_last_revision_info(*branch.last_revision_info())
2177
new_branch.set_parent(branch.get_parent())
2178
new_branch.set_bound_location(branch.get_bound_location())
2179
new_branch.set_push_location(branch.get_push_location())
3054
new_branch._write_last_revision_info(*branch.last_revision_info())
3055
new_branch.lock_write()
3057
new_branch.set_parent(branch.get_parent())
3058
new_branch.set_bound_location(branch.get_bound_location())
3059
new_branch.set_push_location(branch.get_push_location())
2181
3063
# New branch has no tags by default
2182
3064
new_branch.tags._set_tag_dict({})
2184
3066
# Copying done; now update target format
2185
new_branch.control_files.put_utf8('format',
2186
format.get_format_string())
3067
new_branch._transport.put_bytes('format',
3069
mode=new_branch.bzrdir._get_file_mode())
2188
3071
# Clean up old files
2189
new_branch.control_files._transport.delete('revision-history')
2191
branch.set_parent(None)
2194
branch.set_bound_location(None)
3072
new_branch._transport.delete('revision-history')
3076
branch.set_parent(None)
3077
except errors.NoSuchFile:
3079
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.as_string())
3094
class Converter7to8(object):
3095
"""Perform an in-place upgrade of format 7 to format 8"""
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.as_string())
3104
class InterBranch(InterObject):
3105
"""This class represents operations taking place between two branches.
3107
Its instances have methods like pull() and push() and contain
3108
references to the source and target repositories these operations
3109
can be carried out on.
3113
"""The available optimised InterBranch types."""
3116
def _get_branch_formats_to_test(klass):
3117
"""Return an iterable of format tuples for testing.
3119
:return: An iterable of (from_format, to_format) to use when testing
3120
this InterBranch class. Each InterBranch class should define this
3123
raise NotImplementedError(klass._get_branch_formats_to_test)
3126
def pull(self, overwrite=False, stop_revision=None,
3127
possible_transports=None, local=False):
3128
"""Mirror source into target branch.
3130
The target branch is considered to be 'local', having low latency.
3132
:returns: PullResult instance
3134
raise NotImplementedError(self.pull)
3137
def push(self, overwrite=False, stop_revision=None, lossy=False,
3138
_override_hook_source_branch=None):
3139
"""Mirror the source branch into the target branch.
3141
The source branch is considered to be 'local', having low latency.
3143
raise NotImplementedError(self.push)
3146
def copy_content_into(self, revision_id=None):
3147
"""Copy the content of source into target
3149
revision_id: if not None, the revision history in the new branch will
3150
be truncated to end with revision_id.
3152
raise NotImplementedError(self.copy_content_into)
3155
def fetch(self, stop_revision=None, limit=None):
3158
:param stop_revision: Last revision to fetch
3159
:param limit: Optional rough limit of revisions to fetch
3161
raise NotImplementedError(self.fetch)
3164
def _fix_overwrite_type(overwrite):
3165
if isinstance(overwrite, bool):
3167
return ["history", "tags"]
3173
class GenericInterBranch(InterBranch):
3174
"""InterBranch implementation that uses public Branch functions."""
3177
def is_compatible(klass, source, target):
3178
# GenericBranch uses the public API, so always compatible
3182
def _get_branch_formats_to_test(klass):
3183
return [(format_registry.get_default(), format_registry.get_default())]
3186
def unwrap_format(klass, format):
3187
if isinstance(format, remote.RemoteBranchFormat):
3188
format._ensure_real()
3189
return format._custom_format
3193
def copy_content_into(self, revision_id=None):
3194
"""Copy the content of source into target
3196
revision_id: if not None, the revision history in the new branch will
3197
be truncated to end with revision_id.
3199
self.source.update_references(self.target)
3200
self.source._synchronize_history(self.target, revision_id)
3202
parent = self.source.get_parent()
3203
except errors.InaccessibleParent, e:
3204
mutter('parent was not accessible to copy: %s', e)
3207
self.target.set_parent(parent)
3208
if self.source._push_should_merge_tags():
3209
self.source.tags.merge_to(self.target.tags)
3212
def fetch(self, stop_revision=None, limit=None):
3213
if self.target.base == self.source.base:
3215
self.source.lock_read()
3217
fetch_spec_factory = fetch.FetchSpecFactory()
3218
fetch_spec_factory.source_branch = self.source
3219
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3220
fetch_spec_factory.source_repo = self.source.repository
3221
fetch_spec_factory.target_repo = self.target.repository
3222
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3223
fetch_spec_factory.limit = limit
3224
fetch_spec = fetch_spec_factory.make_fetch_spec()
3225
return self.target.repository.fetch(self.source.repository,
3226
fetch_spec=fetch_spec)
3228
self.source.unlock()
3231
def _update_revisions(self, stop_revision=None, overwrite=False,
3233
other_revno, other_last_revision = self.source.last_revision_info()
3234
stop_revno = None # unknown
3235
if stop_revision is None:
3236
stop_revision = other_last_revision
3237
if _mod_revision.is_null(stop_revision):
3238
# if there are no commits, we're done.
3240
stop_revno = other_revno
3242
# what's the current last revision, before we fetch [and change it
3244
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3245
# we fetch here so that we don't process data twice in the common
3246
# case of having something to pull, and so that the check for
3247
# already merged can operate on the just fetched graph, which will
3248
# be cached in memory.
3249
self.fetch(stop_revision=stop_revision)
3250
# Check to see if one is an ancestor of the other
3253
graph = self.target.repository.get_graph()
3254
if self.target._check_if_descendant_or_diverged(
3255
stop_revision, last_rev, graph, self.source):
3256
# stop_revision is a descendant of last_rev, but we aren't
3257
# overwriting, so we're done.
3259
if stop_revno is None:
3261
graph = self.target.repository.get_graph()
3262
this_revno, this_last_revision = \
3263
self.target.last_revision_info()
3264
stop_revno = graph.find_distance_to_null(stop_revision,
3265
[(other_last_revision, other_revno),
3266
(this_last_revision, this_revno)])
3267
self.target.set_last_revision_info(stop_revno, stop_revision)
3270
def pull(self, overwrite=False, stop_revision=None,
3271
possible_transports=None, run_hooks=True,
3272
_override_hook_target=None, local=False):
3273
"""Pull from source into self, updating my master if any.
3275
:param run_hooks: Private parameter - if false, this branch
3276
is being called because it's the master of the primary branch,
3277
so it should not run its hooks.
3279
bound_location = self.target.get_bound_location()
3280
if local and not bound_location:
3281
raise errors.LocalRequiresBoundBranch()
3282
master_branch = None
3283
source_is_master = False
3285
# bound_location comes from a config file, some care has to be
3286
# taken to relate it to source.user_url
3287
normalized = urlutils.normalize_url(bound_location)
3289
relpath = self.source.user_transport.relpath(normalized)
3290
source_is_master = (relpath == '')
3291
except (errors.PathNotChild, errors.InvalidURL):
3292
source_is_master = False
3293
if not local and bound_location and not source_is_master:
3294
# not pulling from master, so we need to update master.
3295
master_branch = self.target.get_master_branch(possible_transports)
3296
master_branch.lock_write()
3299
# pull from source into master.
3300
master_branch.pull(self.source, overwrite, stop_revision,
3302
return self._pull(overwrite,
3303
stop_revision, _hook_master=master_branch,
3304
run_hooks=run_hooks,
3305
_override_hook_target=_override_hook_target,
3306
merge_tags_to_master=not source_is_master)
3309
master_branch.unlock()
3311
def push(self, overwrite=False, stop_revision=None, lossy=False,
3312
_override_hook_source_branch=None):
3313
"""See InterBranch.push.
3315
This is the basic concrete implementation of push()
3317
:param _override_hook_source_branch: If specified, run the hooks
3318
passing this Branch as the source, rather than self. This is for
3319
use of RemoteBranch, where push is delegated to the underlying
3323
raise errors.LossyPushToSameVCS(self.source, self.target)
3324
# TODO: Public option to disable running hooks - should be trivial but
3327
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3328
op.add_cleanup(self.source.lock_read().unlock)
3329
op.add_cleanup(self.target.lock_write().unlock)
3330
return op.run(overwrite, stop_revision,
3331
_override_hook_source_branch=_override_hook_source_branch)
3333
def _basic_push(self, overwrite, stop_revision):
3334
"""Basic implementation of push without bound branches or hooks.
3336
Must be called with source read locked and target write locked.
3338
result = BranchPushResult()
3339
result.source_branch = self.source
3340
result.target_branch = self.target
3341
result.old_revno, result.old_revid = self.target.last_revision_info()
3342
self.source.update_references(self.target)
3343
overwrite = _fix_overwrite_type(overwrite)
3344
if result.old_revid != stop_revision:
3345
# We assume that during 'push' this repository is closer than
3347
graph = self.source.repository.get_graph(self.target.repository)
3348
self._update_revisions(stop_revision,
3349
overwrite=("history" in overwrite),
3351
if self.source._push_should_merge_tags():
3352
result.tag_updates, result.tag_conflicts = (
3353
self.source.tags.merge_to(
3354
self.target.tags, "tags" in overwrite))
3355
result.new_revno, result.new_revid = self.target.last_revision_info()
3358
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3359
_override_hook_source_branch=None):
3360
"""Push from source into target, and into target's master if any.
3363
if _override_hook_source_branch:
3364
result.source_branch = _override_hook_source_branch
3365
for hook in Branch.hooks['post_push']:
3368
bound_location = self.target.get_bound_location()
3369
if bound_location and self.target.base != bound_location:
3370
# there is a master branch.
3372
# XXX: Why the second check? Is it even supported for a branch to
3373
# be bound to itself? -- mbp 20070507
3374
master_branch = self.target.get_master_branch()
3375
master_branch.lock_write()
3376
operation.add_cleanup(master_branch.unlock)
3377
# push into the master from the source branch.
3378
master_inter = InterBranch.get(self.source, master_branch)
3379
master_inter._basic_push(overwrite, stop_revision)
3380
# and push into the target branch from the source. Note that
3381
# we push from the source branch again, because it's considered
3382
# the highest bandwidth repository.
3383
result = self._basic_push(overwrite, stop_revision)
3384
result.master_branch = master_branch
3385
result.local_branch = self.target
3387
master_branch = None
3389
result = self._basic_push(overwrite, stop_revision)
3390
# TODO: Why set master_branch and local_branch if there's no
3391
# binding? Maybe cleaner to just leave them unset? -- mbp
3393
result.master_branch = self.target
3394
result.local_branch = None
3398
def _pull(self, overwrite=False, stop_revision=None,
3399
possible_transports=None, _hook_master=None, run_hooks=True,
3400
_override_hook_target=None, local=False,
3401
merge_tags_to_master=True):
3404
This function is the core worker, used by GenericInterBranch.pull to
3405
avoid duplication when pulling source->master and source->local.
3407
:param _hook_master: Private parameter - set the branch to
3408
be supplied as the master to pull hooks.
3409
:param run_hooks: Private parameter - if false, this branch
3410
is being called because it's the master of the primary branch,
3411
so it should not run its hooks.
3412
is being called because it's the master of the primary branch,
3413
so it should not run its hooks.
3414
:param _override_hook_target: Private parameter - set the branch to be
3415
supplied as the target_branch to pull hooks.
3416
:param local: Only update the local branch, and not the bound branch.
3418
# This type of branch can't be bound.
3420
raise errors.LocalRequiresBoundBranch()
3421
result = PullResult()
3422
result.source_branch = self.source
3423
if _override_hook_target is None:
3424
result.target_branch = self.target
3426
result.target_branch = _override_hook_target
3427
self.source.lock_read()
3429
# We assume that during 'pull' the target repository is closer than
3431
self.source.update_references(self.target)
3432
graph = self.target.repository.get_graph(self.source.repository)
3433
# TODO: Branch formats should have a flag that indicates
3434
# that revno's are expensive, and pull() should honor that flag.
3436
result.old_revno, result.old_revid = \
3437
self.target.last_revision_info()
3438
overwrite = _fix_overwrite_type(overwrite)
3439
self._update_revisions(stop_revision,
3440
overwrite=("history" in overwrite),
3442
# TODO: The old revid should be specified when merging tags,
3443
# so a tags implementation that versions tags can only
3444
# pull in the most recent changes. -- JRV20090506
3445
result.tag_updates, result.tag_conflicts = (
3446
self.source.tags.merge_to(self.target.tags,
3447
"tags" in overwrite,
3448
ignore_master=not merge_tags_to_master))
3449
result.new_revno, result.new_revid = self.target.last_revision_info()
3451
result.master_branch = _hook_master
3452
result.local_branch = result.target_branch
3454
result.master_branch = result.target_branch
3455
result.local_branch = None
3457
for hook in Branch.hooks['post_pull']:
3460
self.source.unlock()
3464
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
