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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
18
from cStringIO import StringIO
21
20
from bzrlib.lazy_import import lazy_import
22
21
lazy_import(globals(), """
23
from itertools import chain
22
from warnings import warn
24
25
from bzrlib import (
27
28
config as _mod_config,
33
33
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TransportConfig
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
40
from bzrlib.config import BranchConfig, TreeConfig
41
from bzrlib.lockable_files import LockableFiles, TransportLock
43
42
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
from bzrlib.hooks import HookPoint, Hooks
51
from bzrlib.inter import InterObject
52
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
48
from bzrlib.decorators import needs_read_lock, needs_write_lock
49
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
50
HistoryMissing, InvalidRevisionId,
51
InvalidRevisionNumber, LockError, NoSuchFile,
52
NoSuchRevision, NoWorkingTree, NotVersionedError,
53
NotBranchError, UninitializableFormat,
54
UnlistableStore, UnlistableBranch,
56
from bzrlib.hooks import Hooks
57
from bzrlib.symbol_versioning import (deprecated_function,
61
zero_eight, zero_nine, zero_sixteen,
63
from bzrlib.trace import mutter, note
61
66
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
121
115
if master is not None:
122
116
master.break_lock()
124
def _check_stackable_repo(self):
125
if not self.repository._format.supports_external_lookups:
126
raise errors.UnstackableRepositoryFormat(self.repository._format,
127
self.repository.base)
129
def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
"""Extend the partial history to include a given index
132
If a stop_index is supplied, stop when that index has been reached.
133
If a stop_revision is supplied, stop when that revision is
134
encountered. Otherwise, stop when the beginning of history is
137
:param stop_index: The index which should be present. When it is
138
present, history extension will stop.
139
:param stop_revision: The revision id which should be present. When
140
it is encountered, history extension will stop.
142
if len(self._partial_revision_history_cache) == 0:
143
self._partial_revision_history_cache = [self.last_revision()]
144
repository._iter_for_revno(
145
self.repository, self._partial_revision_history_cache,
146
stop_index=stop_index, stop_revision=stop_revision)
147
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
self._partial_revision_history_cache.pop()
150
def _get_check_refs(self):
151
"""Get the references needed for check().
155
revid = self.last_revision()
156
return [('revision-existence', revid), ('lefthand-distance', revid)]
159
def open(base, _unsupported=False, possible_transports=None):
119
@deprecated_method(zero_eight)
120
def open_downlevel(base):
121
"""Open a branch which may be of an old format."""
122
return Branch.open(base, _unsupported=True)
125
def open(base, _unsupported=False):
160
126
"""Open the branch rooted at base.
162
128
For instance, if the branch is at URL/.bzr/branch,
163
129
Branch.open(URL) -> a Branch instance.
165
control = bzrdir.BzrDir.open(base, _unsupported,
166
possible_transports=possible_transports)
167
return control.open_branch(unsupported=_unsupported)
131
control = bzrdir.BzrDir.open(base, _unsupported)
132
return control.open_branch(_unsupported)
170
def open_from_transport(transport, name=None, _unsupported=False):
135
def open_from_transport(transport, _unsupported=False):
171
136
"""Open the branch rooted at transport"""
172
137
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
return control.open_branch(name=name, unsupported=_unsupported)
138
return control.open_branch(_unsupported)
176
141
def open_containing(url, possible_transports=None):
177
142
"""Open an existing branch which contains url.
179
144
This probes for a branch at url, and searches upwards from there.
181
146
Basically we keep looking up until we find the control directory or
182
147
run into the root. If there isn't one, raises NotBranchError.
183
If there is one and it is either an unrecognised format or an unsupported
148
If there is one and it is either an unrecognised format or an unsupported
184
149
format, UnknownFormatError or UnsupportedFormatError are raised.
185
150
If there is one, it is returned, along with the unused portion of url.
188
153
possible_transports)
189
154
return control.open_branch(), relpath
191
def _push_should_merge_tags(self):
192
"""Should _basic_push merge this branch's tags into the target?
194
The default implementation returns False if this branch has no tags,
195
and True the rest of the time. Subclasses may override this.
197
return self.supports_tags() and self.tags.get_tag_dict()
157
@deprecated_function(zero_eight)
158
def initialize(base):
159
"""Create a new working tree and branch, rooted at 'base' (url)
161
NOTE: This will soon be deprecated in favour of creation
164
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
166
@deprecated_function(zero_eight)
167
def setup_caching(self, cache_root):
168
"""Subclasses that care about caching should override this, and set
169
up cached stores located under cache_root.
171
NOTE: This is unused.
199
175
def get_config(self):
200
176
return BranchConfig(self)
202
def _get_config(self):
203
"""Get the concrete config for just the config in this branch.
205
This is not intended for client use; see Branch.get_config for the
210
:return: An object supporting get_option and set_option.
212
raise NotImplementedError(self._get_config)
214
def _get_fallback_repository(self, url):
215
"""Get the repository we fallback to at url."""
216
url = urlutils.join(self.base, url)
217
a_branch = Branch.open(url,
218
possible_transports=[self.bzrdir.root_transport])
219
return a_branch.repository
221
def _get_tags_bytes(self):
222
"""Get the bytes of a serialised tags dict.
224
Note that not all branches support tags, nor do all use the same tags
225
logic: this method is specific to BasicTags. Other tag implementations
226
may use the same method name and behave differently, safely, because
227
of the double-dispatch via
228
format.make_tags->tags_instance->get_tags_dict.
230
:return: The bytes of the tags file.
231
:seealso: Branch._set_tags_bytes.
233
return self._transport.get_bytes('tags')
235
def _get_nick(self, local=False, possible_transports=None):
236
config = self.get_config()
237
# explicit overrides master, but don't look for master if local is True
238
if not local and not config.has_explicit_nickname():
240
master = self.get_master_branch(possible_transports)
241
if master is not None:
242
# return the master branch value
244
except errors.BzrError, e:
245
# Silently fall back to local implicit nick if the master is
247
mutter("Could not connect to bound branch, "
248
"falling back to local nick.\n " + str(e))
249
return config.get_nickname()
179
return self.get_config().get_nickname()
251
181
def _set_nick(self, nick):
252
182
self.get_config().set_user_option('nickname', nick, warn_masked=True)
310
203
raise NotImplementedError(self.get_physical_lock_status)
313
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
314
"""Return the revision_id for a dotted revno.
316
:param revno: a tuple like (1,) or (1,1,2)
317
:param _cache_reverse: a private parameter enabling storage
318
of the reverse mapping in a top level cache. (This should
319
only be done in selective circumstances as we want to
320
avoid having the mapping cached multiple times.)
321
:return: the revision_id
322
:raises errors.NoSuchRevision: if the revno doesn't exist
324
rev_id = self._do_dotted_revno_to_revision_id(revno)
326
self._partial_revision_id_to_revno_cache[rev_id] = revno
329
def _do_dotted_revno_to_revision_id(self, revno):
330
"""Worker function for dotted_revno_to_revision_id.
332
Subclasses should override this if they wish to
333
provide a more efficient implementation.
336
return self.get_rev_id(revno[0])
337
revision_id_to_revno = self.get_revision_id_to_revno_map()
338
revision_ids = [revision_id for revision_id, this_revno
339
in revision_id_to_revno.iteritems()
340
if revno == this_revno]
341
if len(revision_ids) == 1:
342
return revision_ids[0]
344
revno_str = '.'.join(map(str, revno))
345
raise errors.NoSuchRevision(self, revno_str)
348
def revision_id_to_dotted_revno(self, revision_id):
349
"""Given a revision id, return its dotted revno.
351
:return: a tuple like (1,) or (400,1,3).
353
return self._do_revision_id_to_dotted_revno(revision_id)
355
def _do_revision_id_to_dotted_revno(self, revision_id):
356
"""Worker function for revision_id_to_revno."""
357
# Try the caches if they are loaded
358
result = self._partial_revision_id_to_revno_cache.get(revision_id)
359
if result is not None:
361
if self._revision_id_to_revno_cache:
362
result = self._revision_id_to_revno_cache.get(revision_id)
364
raise errors.NoSuchRevision(self, revision_id)
365
# Try the mainline as it's optimised
367
revno = self.revision_id_to_revno(revision_id)
369
except errors.NoSuchRevision:
370
# We need to load and use the full revno map after all
371
result = self.get_revision_id_to_revno_map().get(revision_id)
373
raise errors.NoSuchRevision(self, revision_id)
377
206
def get_revision_id_to_revno_map(self):
378
207
"""Return the revision_id => dotted revno map.
404
233
:return: A dictionary mapping revision_id => dotted revno.
235
last_revision = self.last_revision()
236
revision_graph = self.repository.get_revision_graph(last_revision)
237
merge_sorted_revisions = tsort.merge_sort(
406
242
revision_id_to_revno = dict((rev_id, revno)
407
for rev_id, depth, revno, end_of_merge
408
in self.iter_merge_sorted_revisions())
243
for seq_num, rev_id, depth, revno, end_of_merge
244
in merge_sorted_revisions)
409
245
return revision_id_to_revno
412
def iter_merge_sorted_revisions(self, start_revision_id=None,
413
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
414
"""Walk the revisions for a branch in merge sorted order.
416
Merge sorted order is the output from a merge-aware,
417
topological sort, i.e. all parents come before their
418
children going forward; the opposite for reverse.
420
:param start_revision_id: the revision_id to begin walking from.
421
If None, the branch tip is used.
422
:param stop_revision_id: the revision_id to terminate the walk
423
after. If None, the rest of history is included.
424
:param stop_rule: if stop_revision_id is not None, the precise rule
425
to use for termination:
426
* 'exclude' - leave the stop revision out of the result (default)
427
* 'include' - the stop revision is the last item in the result
428
* 'with-merges' - include the stop revision and all of its
429
merged revisions in the result
430
* 'with-merges-without-common-ancestry' - filter out revisions
431
that are in both ancestries
432
:param direction: either 'reverse' or 'forward':
433
* reverse means return the start_revision_id first, i.e.
434
start at the most recent revision and go backwards in history
435
* forward returns tuples in the opposite order to reverse.
436
Note in particular that forward does *not* do any intelligent
437
ordering w.r.t. depth as some clients of this API may like.
438
(If required, that ought to be done at higher layers.)
440
:return: an iterator over (revision_id, depth, revno, end_of_merge)
443
* revision_id: the unique id of the revision
444
* depth: How many levels of merging deep this node has been
446
* revno_sequence: This field provides a sequence of
447
revision numbers for all revisions. The format is:
448
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
449
branch that the revno is on. From left to right the REVNO numbers
450
are the sequence numbers within that branch of the revision.
451
* end_of_merge: When True the next node (earlier in history) is
452
part of a different merge.
454
# Note: depth and revno values are in the context of the branch so
455
# we need the full graph to get stable numbers, regardless of the
457
if self._merge_sorted_revisions_cache is None:
458
last_revision = self.last_revision()
459
known_graph = self.repository.get_known_graph_ancestry(
461
self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
filtered = self._filter_merge_sorted_revisions(
464
self._merge_sorted_revisions_cache, start_revision_id,
465
stop_revision_id, stop_rule)
466
# Make sure we don't return revisions that are not part of the
467
# start_revision_id ancestry.
468
filtered = self._filter_start_non_ancestors(filtered)
469
if direction == 'reverse':
471
if direction == 'forward':
472
return reversed(list(filtered))
474
raise ValueError('invalid direction %r' % direction)
476
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
477
start_revision_id, stop_revision_id, stop_rule):
478
"""Iterate over an inclusive range of sorted revisions."""
479
rev_iter = iter(merge_sorted_revisions)
480
if start_revision_id is not None:
481
for node in rev_iter:
482
rev_id = node.key[-1]
483
if rev_id != start_revision_id:
486
# The decision to include the start or not
487
# depends on the stop_rule if a stop is provided
488
# so pop this node back into the iterator
489
rev_iter = chain(iter([node]), rev_iter)
491
if stop_revision_id is None:
493
for node in rev_iter:
494
rev_id = node.key[-1]
495
yield (rev_id, node.merge_depth, node.revno,
497
elif stop_rule == 'exclude':
498
for node in rev_iter:
499
rev_id = node.key[-1]
500
if rev_id == stop_revision_id:
502
yield (rev_id, node.merge_depth, node.revno,
504
elif stop_rule == 'include':
505
for node in rev_iter:
506
rev_id = node.key[-1]
507
yield (rev_id, node.merge_depth, node.revno,
509
if rev_id == stop_revision_id:
511
elif stop_rule == 'with-merges-without-common-ancestry':
512
# We want to exclude all revisions that are already part of the
513
# stop_revision_id ancestry.
514
graph = self.repository.get_graph()
515
ancestors = graph.find_unique_ancestors(start_revision_id,
517
for node in rev_iter:
518
rev_id = node.key[-1]
519
if rev_id not in ancestors:
521
yield (rev_id, node.merge_depth, node.revno,
523
elif stop_rule == 'with-merges':
524
stop_rev = self.repository.get_revision(stop_revision_id)
525
if stop_rev.parent_ids:
526
left_parent = stop_rev.parent_ids[0]
528
left_parent = _mod_revision.NULL_REVISION
529
# left_parent is the actual revision we want to stop logging at,
530
# since we want to show the merged revisions after the stop_rev too
531
reached_stop_revision_id = False
532
revision_id_whitelist = []
533
for node in rev_iter:
534
rev_id = node.key[-1]
535
if rev_id == left_parent:
536
# reached the left parent after the stop_revision
538
if (not reached_stop_revision_id or
539
rev_id in revision_id_whitelist):
540
yield (rev_id, node.merge_depth, node.revno,
542
if reached_stop_revision_id or rev_id == stop_revision_id:
543
# only do the merged revs of rev_id from now on
544
rev = self.repository.get_revision(rev_id)
546
reached_stop_revision_id = True
547
revision_id_whitelist.extend(rev.parent_ids)
549
raise ValueError('invalid stop_rule %r' % stop_rule)
551
def _filter_start_non_ancestors(self, rev_iter):
552
# If we started from a dotted revno, we want to consider it as a tip
553
# and don't want to yield revisions that are not part of its
554
# ancestry. Given the order guaranteed by the merge sort, we will see
555
# uninteresting descendants of the first parent of our tip before the
557
first = rev_iter.next()
558
(rev_id, merge_depth, revno, end_of_merge) = first
561
# We start at a mainline revision so by definition, all others
562
# revisions in rev_iter are ancestors
563
for node in rev_iter:
568
pmap = self.repository.get_parent_map([rev_id])
569
parents = pmap.get(rev_id, [])
571
whitelist.update(parents)
573
# If there is no parents, there is nothing of interest left
575
# FIXME: It's hard to test this scenario here as this code is never
576
# called in that case. -- vila 20100322
579
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
if rev_id in whitelist:
582
pmap = self.repository.get_parent_map([rev_id])
583
parents = pmap.get(rev_id, [])
584
whitelist.remove(rev_id)
585
whitelist.update(parents)
587
# We've reached the mainline, there is nothing left to
591
# A revision that is not part of the ancestry of our
594
yield (rev_id, merge_depth, revno, end_of_merge)
596
247
def leave_lock_in_place(self):
597
248
"""Tell this branch object not to release the physical lock when this
598
249
object is unlocked.
600
251
If lock_write doesn't return a token, then this method is not supported.
602
253
self.control_files.leave_in_place()
708
357
The delta is relative to its mainline predecessor, or the
709
358
empty tree for revision 1.
360
assert isinstance(revno, int)
711
361
rh = self.revision_history()
712
362
if not (1 <= revno <= len(rh)):
713
raise errors.InvalidRevisionNumber(revno)
363
raise InvalidRevisionNumber(revno)
714
364
return self.repository.get_revision_delta(rh[revno-1])
716
def get_stacked_on_url(self):
717
"""Get the URL this branch is stacked against.
366
@deprecated_method(zero_sixteen)
367
def get_root_id(self):
368
"""Return the id of this branches root
719
:raises NotStacked: If the branch is not stacked.
720
:raises UnstackableBranchFormat: If the branch does not support
370
Deprecated: branches don't have root ids-- trees do.
371
Use basis_tree().get_root_id() instead.
723
raise NotImplementedError(self.get_stacked_on_url)
373
raise NotImplementedError(self.get_root_id)
725
375
def print_file(self, file, revision_id):
726
376
"""Print `file` to stdout."""
727
377
raise NotImplementedError(self.print_file)
379
def append_revision(self, *revision_ids):
380
raise NotImplementedError(self.append_revision)
729
382
def set_revision_history(self, rev_history):
730
383
raise NotImplementedError(self.set_revision_history)
733
def set_parent(self, url):
734
"""See Branch.set_parent."""
735
# TODO: Maybe delete old location files?
736
# URLs should never be unicode, even on the local fs,
737
# FIXUP this and get_parent in a future branch format bump:
738
# read and rewrite the file. RBC 20060125
740
if isinstance(url, unicode):
742
url = url.encode('ascii')
743
except UnicodeEncodeError:
744
raise errors.InvalidURL(url,
745
"Urls must be 7-bit ascii, "
746
"use bzrlib.urlutils.escape")
747
url = urlutils.relative_url(self.base, url)
748
self._set_parent_location(url)
751
def set_stacked_on_url(self, url):
752
"""Set the URL this branch is stacked against.
754
:raises UnstackableBranchFormat: If the branch does not support
756
:raises UnstackableRepositoryFormat: If the repository does not support
759
if not self._format.supports_stacking():
760
raise errors.UnstackableBranchFormat(self._format, self.user_url)
761
# XXX: Changing from one fallback repository to another does not check
762
# that all the data you need is present in the new fallback.
763
# Possibly it should.
764
self._check_stackable_repo()
767
old_url = self.get_stacked_on_url()
768
except (errors.NotStacked, errors.UnstackableBranchFormat,
769
errors.UnstackableRepositoryFormat):
773
self._activate_fallback_location(url)
774
# write this out after the repository is stacked to avoid setting a
775
# stacked config that doesn't work.
776
self._set_config_location('stacked_on_location', url)
779
"""Change a branch to be unstacked, copying data as needed.
781
Don't call this directly, use set_stacked_on_url(None).
783
pb = ui.ui_factory.nested_progress_bar()
785
pb.update("Unstacking")
786
# The basic approach here is to fetch the tip of the branch,
787
# including all available ghosts, from the existing stacked
788
# repository into a new repository object without the fallbacks.
790
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
791
# correct for CHKMap repostiories
792
old_repository = self.repository
793
if len(old_repository._fallback_repositories) != 1:
794
raise AssertionError("can't cope with fallback repositories "
795
"of %r" % (self.repository,))
796
# unlock it, including unlocking the fallback
797
old_repository.unlock()
798
old_repository.lock_read()
800
# Repositories don't offer an interface to remove fallback
801
# repositories today; take the conceptually simpler option and just
802
# reopen it. We reopen it starting from the URL so that we
803
# get a separate connection for RemoteRepositories and can
804
# stream from one of them to the other. This does mean doing
805
# separate SSH connection setup, but unstacking is not a
806
# common operation so it's tolerable.
807
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
808
new_repository = new_bzrdir.find_repository()
809
self.repository = new_repository
810
if self.repository._fallback_repositories:
811
raise AssertionError("didn't expect %r to have "
812
"fallback_repositories"
813
% (self.repository,))
814
# this is not paired with an unlock because it's just restoring
815
# the previous state; the lock's released when set_stacked_on_url
817
self.repository.lock_write()
818
# XXX: If you unstack a branch while it has a working tree
819
# with a pending merge, the pending-merged revisions will no
820
# longer be present. You can (probably) revert and remerge.
822
# XXX: This only fetches up to the tip of the repository; it
823
# doesn't bring across any tags. That's fairly consistent
824
# with how branch works, but perhaps not ideal.
825
self.repository.fetch(old_repository,
826
revision_id=self.last_revision(),
829
old_repository.unlock()
833
def _set_tags_bytes(self, bytes):
834
"""Mirror method for _get_tags_bytes.
836
:seealso: Branch._get_tags_bytes.
838
return _run_with_write_locked_target(self, self._transport.put_bytes,
841
385
def _cache_revision_history(self, rev_history):
842
386
"""Set the cached revision history to rev_history.
952
491
common_index = min(self_len, other_len) -1
953
492
if common_index >= 0 and \
954
493
self_history[common_index] != other_history[common_index]:
955
raise errors.DivergedBranches(self, other)
494
raise DivergedBranches(self, other)
957
496
if stop_revision is None:
958
497
stop_revision = other_len
499
assert isinstance(stop_revision, int)
960
500
if stop_revision > other_len:
961
501
raise errors.NoSuchRevision(self, stop_revision)
962
502
return other_history[self_len:stop_revision]
965
def update_revisions(self, other, stop_revision=None, overwrite=False,
504
def update_revisions(self, other, stop_revision=None):
967
505
"""Pull in new perfect-fit revisions.
969
507
:param other: Another Branch to pull from
970
508
:param stop_revision: Updated until the given revision
971
:param overwrite: Always set the branch pointer, rather than checking
972
to see if it is a proper descendant.
973
:param graph: A Graph object that can be used to query history
974
information. This can be None.
977
return InterBranch.get(other, self).update_revisions(stop_revision,
980
def import_last_revision_info(self, source_repo, revno, revid):
981
"""Set the last revision info, importing from another repo if necessary.
983
This is used by the bound branch code to upload a revision to
984
the master branch first before updating the tip of the local branch.
986
:param source_repo: Source repository to optionally fetch from
987
:param revno: Revision number of the new tip
988
:param revid: Revision id of the new tip
990
if not self.repository.has_same_location(source_repo):
991
self.repository.fetch(source_repo, revision_id=revid)
992
self.set_last_revision_info(revno, revid)
511
raise NotImplementedError(self.update_revisions)
994
513
def revision_id_to_revno(self, revision_id):
995
514
"""Given a revision id, return its revno"""
996
515
if _mod_revision.is_null(revision_id):
517
revision_id = osutils.safe_revision_id(revision_id)
998
518
history = self.revision_history()
1000
520
return history.index(revision_id) + 1
1001
521
except ValueError:
1002
522
raise errors.NoSuchRevision(self, revision_id)
1005
524
def get_rev_id(self, revno, history=None):
1006
525
"""Find the revision id of the specified revno."""
1008
return _mod_revision.NULL_REVISION
1009
last_revno, last_revid = self.last_revision_info()
1010
if revno == last_revno:
1012
if revno <= 0 or revno > last_revno:
529
history = self.revision_history()
530
if revno <= 0 or revno > len(history):
1013
531
raise errors.NoSuchRevision(self, revno)
1014
distance_from_last = last_revno - revno
1015
if len(self._partial_revision_history_cache) <= distance_from_last:
1016
self._extend_partial_history(distance_from_last)
1017
return self._partial_revision_history_cache[distance_from_last]
532
return history[revno - 1]
1020
def pull(self, source, overwrite=False, stop_revision=None,
1021
possible_transports=None, *args, **kwargs):
534
def pull(self, source, overwrite=False, stop_revision=None):
1022
535
"""Mirror source into this branch.
1024
537
This branch is considered to be 'local', having low latency.
1026
539
:returns: PullResult instance
1028
return InterBranch.get(source, self).pull(overwrite=overwrite,
1029
stop_revision=stop_revision,
1030
possible_transports=possible_transports, *args, **kwargs)
541
raise NotImplementedError(self.pull)
1032
def push(self, target, overwrite=False, stop_revision=None, *args,
543
def push(self, target, overwrite=False, stop_revision=None):
1034
544
"""Mirror this branch into target.
1036
546
This branch is considered to be 'local', having low latency.
1038
return InterBranch.get(self, target).push(overwrite, stop_revision,
1041
def lossy_push(self, target, stop_revision=None):
1042
"""Push deltas into another branch.
1044
:note: This does not, like push, retain the revision ids from
1045
the source branch and will, rather than adding bzr-specific
1046
metadata, push only those semantics of the revision that can be
1047
natively represented by this branch' VCS.
1049
:param target: Target branch
1050
:param stop_revision: Revision to push, defaults to last revision.
1051
:return: BranchPushResult with an extra member revidmap:
1052
A dictionary mapping revision ids from the target branch
1053
to new revision ids in the target branch, for each
1054
revision that was pushed.
1056
inter = InterBranch.get(self, target)
1057
lossy_push = getattr(inter, "lossy_push", None)
1058
if lossy_push is None:
1059
raise errors.LossyPushToSameVCS(self, target)
1060
return lossy_push(stop_revision)
548
raise NotImplementedError(self.push)
1062
550
def basis_tree(self):
1063
551
"""Return `Tree` object for last revision."""
1064
552
return self.repository.revision_tree(self.last_revision())
554
def rename_one(self, from_rel, to_rel):
557
This can change the directory or the filename or both.
559
raise NotImplementedError(self.rename_one)
561
def move(self, from_paths, to_name):
564
to_name must exist as a versioned directory.
566
If to_name exists and is a directory, the files are moved into
567
it, keeping their old names. If it is a directory,
569
Note that to_name is only the last component of the new name;
570
this doesn't change the directory.
572
This returns a list of (from_path, to_path) pairs for each
575
raise NotImplementedError(self.move)
1066
577
def get_parent(self):
1067
578
"""Return the parent location of the branch.
1069
This is the default location for pull/missing. The usual
580
This is the default location for push/pull/missing. The usual
1070
581
pattern is that the user can override it by specifying a
1073
parent = self._get_parent_location()
1076
# This is an old-format absolute path to a local branch
1077
# turn it into a url
1078
if parent.startswith('/'):
1079
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1081
return urlutils.join(self.base[:-1], parent)
1082
except errors.InvalidURLJoin, e:
1083
raise errors.InaccessibleParent(parent, self.user_url)
1085
def _get_parent_location(self):
1086
raise NotImplementedError(self._get_parent_location)
584
raise NotImplementedError(self.get_parent)
1088
586
def _set_config_location(self, name, url, config=None,
1089
587
make_relative=False):
1190
665
self.check_real_revno(revno)
1192
667
def check_real_revno(self, revno):
1194
669
Check whether a revno corresponds to a real revision.
1195
670
Zero (the NULL revision) is considered invalid
1197
672
if revno < 1 or revno > self.revno():
1198
raise errors.InvalidRevisionNumber(revno)
673
raise InvalidRevisionNumber(revno)
1200
675
@needs_read_lock
1201
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
676
def clone(self, to_bzrdir, revision_id=None):
1202
677
"""Clone this branch into to_bzrdir preserving all semantic values.
1204
Most API users will want 'create_clone_on_transport', which creates a
1205
new bzrdir and branch on the fly.
1207
679
revision_id: if not None, the revision history in the new branch will
1208
680
be truncated to end with revision_id.
1210
result = to_bzrdir.create_branch()
1213
if repository_policy is not None:
1214
repository_policy.configure_branch(result)
1215
self.copy_content_into(result, revision_id=revision_id)
682
result = self._format.initialize(to_bzrdir)
683
self.copy_content_into(result, revision_id=revision_id)
1220
686
@needs_read_lock
1221
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
687
def sprout(self, to_bzrdir, revision_id=None):
1222
688
"""Create a new line of development from the branch, into to_bzrdir.
1224
to_bzrdir controls the branch format.
1226
690
revision_id: if not None, the revision history in the new branch will
1227
691
be truncated to end with revision_id.
1229
if (repository_policy is not None and
1230
repository_policy.requires_stacking()):
1231
to_bzrdir._format.require_stacking(_skip_repo=True)
1232
result = to_bzrdir.create_branch()
1235
if repository_policy is not None:
1236
repository_policy.configure_branch(result)
1237
self.copy_content_into(result, revision_id=revision_id)
1238
result.set_parent(self.bzrdir.root_transport.base)
693
result = self._format.initialize(to_bzrdir)
694
self.copy_content_into(result, revision_id=revision_id)
695
result.set_parent(self.bzrdir.root_transport.base)
1243
698
def _synchronize_history(self, destination, revision_id):
1244
699
"""Synchronize last revision and revision history between branches.
1246
701
This version is most efficient when the destination is also a
1247
BzrBranch6, but works for BzrBranch5, as long as the destination's
1248
repository contains all the lefthand ancestors of the intended
1249
last_revision. If not, set_last_revision_info will fail.
702
BzrBranch5, but works for BzrBranch6 as long as the revision
703
history is the true lefthand parent history, and all of the revisions
704
are in the destination's repository. If not, set_revision_history
1251
707
:param destination: The branch to copy the history into
1252
708
:param revision_id: The revision-id to truncate history at. May
1253
709
be None to copy complete history.
1255
source_revno, source_revision_id = self.last_revision_info()
1256
if revision_id is None:
1257
revno, revision_id = source_revno, source_revision_id
1259
graph = self.repository.get_graph()
711
if revision_id == _mod_revision.NULL_REVISION:
713
new_history = self.revision_history()
714
if revision_id is not None and new_history != []:
715
revision_id = osutils.safe_revision_id(revision_id)
1261
revno = graph.find_distance_to_null(revision_id,
1262
[(source_revision_id, source_revno)])
1263
except errors.GhostRevisionsHaveNoRevno:
1264
# Default to 1, if we can't find anything else
1266
destination.set_last_revision_info(revno, revision_id)
717
new_history = new_history[:new_history.index(revision_id) + 1]
719
rev = self.repository.get_revision(revision_id)
720
new_history = rev.get_history(self.repository)[1:]
721
destination.set_revision_history(new_history)
1268
723
@needs_read_lock
1269
724
def copy_content_into(self, destination, revision_id=None):
1283
737
destination.set_parent(parent)
1284
if self._push_should_merge_tags():
1285
self.tags.merge_to(destination.tags)
1287
def update_references(self, target):
1288
if not getattr(self._format, 'supports_reference_locations', False):
1290
reference_dict = self._get_all_reference_info()
1291
if len(reference_dict) == 0:
1293
old_base = self.base
1294
new_base = target.base
1295
target_reference_dict = target._get_all_reference_info()
1296
for file_id, (tree_path, branch_location) in (
1297
reference_dict.items()):
1298
branch_location = urlutils.rebase_url(branch_location,
1300
target_reference_dict.setdefault(
1301
file_id, (tree_path, branch_location))
1302
target._set_all_reference_info(target_reference_dict)
738
self.tags.merge_to(destination.tags)
1304
740
@needs_read_lock
1305
def check(self, refs):
1306
742
"""Check consistency of the branch.
1308
744
In particular this checks that revisions given in the revision-history
1309
do actually match up in the revision graph, and that they're all
745
do actually match up in the revision graph, and that they're all
1310
746
present in the repository.
1312
748
Callers will typically also want to check the repository.
1314
:param refs: Calculated refs for this branch as specified by
1315
branch._get_check_refs()
1316
750
:return: A BranchCheckResult.
1318
result = BranchCheckResult(self)
1319
last_revno, last_revision_id = self.last_revision_info()
1320
actual_revno = refs[('lefthand-distance', last_revision_id)]
1321
if actual_revno != last_revno:
1322
result.errors.append(errors.BzrCheckError(
1323
'revno does not match len(mainline) %s != %s' % (
1324
last_revno, actual_revno)))
1325
# TODO: We should probably also check that self.revision_history
1326
# matches the repository for older branch formats.
1327
# If looking for the code that cross-checks repository parents against
1328
# the iter_reverse_revision_history output, that is now a repository
752
mainline_parent_id = None
753
for revision_id in self.revision_history():
755
revision = self.repository.get_revision(revision_id)
756
except errors.NoSuchRevision, e:
757
raise errors.BzrCheckError("mainline revision {%s} not in repository"
759
# In general the first entry on the revision history has no parents.
760
# But it's not illegal for it to have parents listed; this can happen
761
# in imports from Arch when the parents weren't reachable.
762
if mainline_parent_id is not None:
763
if mainline_parent_id not in revision.parent_ids:
764
raise errors.BzrCheckError("previous revision {%s} not listed among "
766
% (mainline_parent_id, revision_id))
767
mainline_parent_id = revision_id
768
return BranchCheckResult(self)
1332
770
def _get_checkout_format(self):
1333
771
"""Return the most suitable metadir for a checkout of this branch.
1413
818
basis_tree.unlock()
1417
def reconcile(self, thorough=True):
1418
"""Make sure the data stored in this branch is consistent."""
1419
from bzrlib.reconcile import BranchReconciler
1420
reconciler = BranchReconciler(self, thorough=thorough)
1421
reconciler.reconcile()
1424
def reference_parent(self, file_id, path, possible_transports=None):
821
def reference_parent(self, file_id, path):
1425
822
"""Return the parent branch for a tree-reference file_id
1426
823
:param file_id: The file_id of the tree reference
1427
824
:param path: The path of the file_id in the tree
1428
825
:return: A branch associated with the file_id
1430
827
# FIXME should provide multiple branches, based on config
1431
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1432
possible_transports=possible_transports)
828
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1434
830
def supports_tags(self):
1435
831
return self._format.supports_tags()
1437
def automatic_tag_name(self, revision_id):
1438
"""Try to automatically find the tag name for a revision.
1440
:param revision_id: Revision id of the revision.
1441
:return: A tag name or None if no tag name could be determined.
1443
for hook in Branch.hooks['automatic_tag_name']:
1444
ret = hook(self, revision_id)
1449
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1451
"""Ensure that revision_b is a descendant of revision_a.
1453
This is a helper function for update_revisions.
1455
:raises: DivergedBranches if revision_b has diverged from revision_a.
1456
:returns: True if revision_b is a descendant of revision_a.
1458
relation = self._revision_relations(revision_a, revision_b, graph)
1459
if relation == 'b_descends_from_a':
1461
elif relation == 'diverged':
1462
raise errors.DivergedBranches(self, other_branch)
1463
elif relation == 'a_descends_from_b':
1466
raise AssertionError("invalid relation: %r" % (relation,))
1468
def _revision_relations(self, revision_a, revision_b, graph):
1469
"""Determine the relationship between two revisions.
1471
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1473
heads = graph.heads([revision_a, revision_b])
1474
if heads == set([revision_b]):
1475
return 'b_descends_from_a'
1476
elif heads == set([revision_a, revision_b]):
1477
# These branches have diverged
1479
elif heads == set([revision_a]):
1480
return 'a_descends_from_b'
1482
raise AssertionError("invalid heads: %r" % (heads,))
1485
834
class BranchFormat(object):
1486
835
"""An encapsulation of the initialization and open routines for a format.
1595
920
control_files = lockable_files.LockableFiles(branch_transport,
1596
921
lock_name, lock_class)
1597
922
control_files.create_lock()
1599
control_files.lock_write()
1600
except errors.LockContention:
1601
if lock_type != 'branch4':
923
control_files.lock_write()
1607
utf8_files += [('format', self.get_format_string())]
925
control_files.put_utf8('format', self.get_format_string())
1609
for (filename, content) in utf8_files:
1610
branch_transport.put_bytes(
1612
mode=a_bzrdir._get_file_mode())
927
for file, content in utf8_files:
928
control_files.put_utf8(file, content)
1615
control_files.unlock()
1616
branch = self.open(a_bzrdir, name, _found=True)
1617
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
930
control_files.unlock()
931
return self.open(a_bzrdir, _found=True)
1620
def initialize(self, a_bzrdir, name=None):
1621
"""Create a branch of this format in a_bzrdir.
1623
:param name: Name of the colocated branch to create.
933
def initialize(self, a_bzrdir):
934
"""Create a branch of this format in a_bzrdir."""
1625
935
raise NotImplementedError(self.initialize)
1627
937
def is_supported(self):
1628
938
"""Is this format supported?
1630
940
Supported formats can be initialized and opened.
1631
Unsupported formats may not support initialization or committing or
941
Unsupported formats may not support initialization or committing or
1632
942
some other features depending on the reason for not being supported.
1636
def make_tags(self, branch):
1637
"""Create a tags object for branch.
1639
This method is on BranchFormat, because BranchFormats are reflected
1640
over the wire via network_name(), whereas full Branch instances require
1641
multiple VFS method calls to operate at all.
1643
The default implementation returns a disabled-tags instance.
1645
Note that it is normal for branch to be a RemoteBranch when using tags
1648
return DisabledTags(branch)
1650
def network_name(self):
1651
"""A simple byte string uniquely identifying this format for RPC calls.
1653
MetaDir branch formats use their disk format string to identify the
1654
repository over the wire. All in one formats such as bzr < 0.8, and
1655
foreign formats like svn/git and hg should use some marker which is
1656
unique and immutable.
1658
raise NotImplementedError(self.network_name)
1660
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
946
def open(self, a_bzrdir, _found=False):
1661
947
"""Return the branch object for a_bzrdir
1663
:param a_bzrdir: A BzrDir that contains a branch.
1664
:param name: Name of colocated branch to open
1665
:param _found: a private parameter, do not use it. It is used to
1666
indicate if format probing has already be done.
1667
:param ignore_fallbacks: when set, no fallback branches will be opened
1668
(if there are any). Default is to open fallbacks.
949
_found is a private parameter, do not use it. It is used to indicate
950
if format probing has already be done.
1670
952
raise NotImplementedError(self.open)
1673
955
def register_format(klass, format):
1674
"""Register a metadir format."""
1675
956
klass._formats[format.get_format_string()] = format
1676
# Metadir formats have a network name of their format string, and get
1677
# registered as class factories.
1678
network_format_registry.register(format.get_format_string(), format.__class__)
1681
959
def set_default_format(klass, format):
1682
960
klass._default_format = format
1684
def supports_set_append_revisions_only(self):
1685
"""True if this format supports set_append_revisions_only."""
1688
def supports_stacking(self):
1689
"""True if this format records a stacked-on branch."""
1693
963
def unregister_format(klass, format):
964
assert klass._formats[format.get_format_string()] is format
1694
965
del klass._formats[format.get_format_string()]
1696
967
def __str__(self):
1697
return self.get_format_description().rstrip()
968
return self.get_format_string().rstrip()
1699
970
def supports_tags(self):
1700
971
"""True if this format supports tags stored in the branch"""
1701
972
return False # by default
974
# XXX: Probably doesn't really belong here -- mbp 20070212
975
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
977
branch_transport = a_bzrdir.get_branch_transport(self)
978
control_files = lockable_files.LockableFiles(branch_transport,
979
lock_filename, lock_class)
980
control_files.create_lock()
981
control_files.lock_write()
983
for filename, content in utf8_files:
984
control_files.put_utf8(filename, content)
986
control_files.unlock()
1704
989
class BranchHooks(Hooks):
1705
990
"""A dictionary mapping hook name to a list of callables for branch hooks.
1707
992
e.g. ['set_rh'] Is the list of items to be called when the
1708
993
set_revision_history function is invoked.
1717
1002
Hooks.__init__(self)
1718
self.create_hook(HookPoint('set_rh',
1719
"Invoked whenever the revision history has been set via "
1720
"set_revision_history. The api signature is (branch, "
1721
"revision_history), and the branch will be write-locked. "
1722
"The set_rh hook can be expensive for bzr to trigger, a better "
1723
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1724
self.create_hook(HookPoint('open',
1725
"Called with the Branch object that has been opened after a "
1726
"branch is opened.", (1, 8), None))
1727
self.create_hook(HookPoint('post_push',
1728
"Called after a push operation completes. post_push is called "
1729
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1730
"bzr client.", (0, 15), None))
1731
self.create_hook(HookPoint('post_pull',
1732
"Called after a pull operation completes. post_pull is called "
1733
"with a bzrlib.branch.PullResult object and only runs in the "
1734
"bzr client.", (0, 15), None))
1735
self.create_hook(HookPoint('pre_commit',
1736
"Called after a commit is calculated but before it is is "
1737
"completed. pre_commit is called with (local, master, old_revno, "
1738
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1739
"). old_revid is NULL_REVISION for the first commit to a branch, "
1740
"tree_delta is a TreeDelta object describing changes from the "
1741
"basis revision. hooks MUST NOT modify this delta. "
1742
" future_tree is an in-memory tree obtained from "
1743
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1744
"tree.", (0,91), None))
1745
self.create_hook(HookPoint('post_commit',
1746
"Called in the bzr client after a commit has completed. "
1747
"post_commit is called with (local, master, old_revno, old_revid, "
1748
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1749
"commit to a branch.", (0, 15), None))
1750
self.create_hook(HookPoint('post_uncommit',
1751
"Called in the bzr client after an uncommit completes. "
1752
"post_uncommit is called with (local, master, old_revno, "
1753
"old_revid, new_revno, new_revid) where local is the local branch "
1754
"or None, master is the target branch, and an empty branch "
1755
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1756
self.create_hook(HookPoint('pre_change_branch_tip',
1757
"Called in bzr client and server before a change to the tip of a "
1758
"branch is made. pre_change_branch_tip is called with a "
1759
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1760
"commit, uncommit will all trigger this hook.", (1, 6), None))
1761
self.create_hook(HookPoint('post_change_branch_tip',
1762
"Called in bzr client and server after a change to the tip of a "
1763
"branch is made. post_change_branch_tip is called with a "
1764
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1765
"commit, uncommit will all trigger this hook.", (1, 4), None))
1766
self.create_hook(HookPoint('transform_fallback_location',
1767
"Called when a stacked branch is activating its fallback "
1768
"locations. transform_fallback_location is called with (branch, "
1769
"url), and should return a new url. Returning the same url "
1770
"allows it to be used as-is, returning a different one can be "
1771
"used to cause the branch to stack on a closer copy of that "
1772
"fallback_location. Note that the branch cannot have history "
1773
"accessing methods called on it during this hook because the "
1774
"fallback locations have not been activated. When there are "
1775
"multiple hooks installed for transform_fallback_location, "
1776
"all are called with the url returned from the previous hook."
1777
"The order is however undefined.", (1, 9), None))
1778
self.create_hook(HookPoint('automatic_tag_name',
1779
"Called to determine an automatic tag name for a revision."
1780
"automatic_tag_name is called with (branch, revision_id) and "
1781
"should return a tag name or None if no tag name could be "
1782
"determined. The first non-None tag name returned will be used.",
1784
self.create_hook(HookPoint('post_branch_init',
1785
"Called after new branch initialization completes. "
1786
"post_branch_init is called with a "
1787
"bzrlib.branch.BranchInitHookParams. "
1788
"Note that init, branch and checkout (both heavyweight and "
1789
"lightweight) will all trigger this hook.", (2, 2), None))
1790
self.create_hook(HookPoint('post_switch',
1791
"Called after a checkout switches branch. "
1792
"post_switch is called with a "
1793
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1003
# Introduced in 0.15:
1004
# invoked whenever the revision history has been set
1005
# with set_revision_history. The api signature is
1006
# (branch, revision_history), and the branch will
1009
# invoked after a push operation completes.
1010
# the api signature is
1012
# containing the members
1013
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1014
# where local is the local target branch or None, master is the target
1015
# master branch, and the rest should be self explanatory. The source
1016
# is read locked and the target branches write locked. Source will
1017
# be the local low-latency branch.
1018
self['post_push'] = []
1019
# invoked after a pull operation completes.
1020
# the api signature is
1022
# containing the members
1023
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1024
# where local is the local branch or None, master is the target
1025
# master branch, and the rest should be self explanatory. The source
1026
# is read locked and the target branches write locked. The local
1027
# branch is the low-latency branch.
1028
self['post_pull'] = []
1029
# invoked after a commit operation completes.
1030
# the api signature is
1031
# (local, master, old_revno, old_revid, new_revno, new_revid)
1032
# old_revid is NULL_REVISION for the first commit to a branch.
1033
self['post_commit'] = []
1034
# invoked after a uncommit operation completes.
1035
# the api signature is
1036
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1037
# local is the local branch or None, master is the target branch,
1038
# and an empty branch recieves new_revno of 0, new_revid of None.
1039
self['post_uncommit'] = []
1797
1042
# install the default hooks into the Branch class.
1798
1043
Branch.hooks = BranchHooks()
1801
class ChangeBranchTipParams(object):
1802
"""Object holding parameters passed to *_change_branch_tip hooks.
1804
There are 5 fields that hooks may wish to access:
1806
:ivar branch: the branch being changed
1807
:ivar old_revno: revision number before the change
1808
:ivar new_revno: revision number after the change
1809
:ivar old_revid: revision id before the change
1810
:ivar new_revid: revision id after the change
1812
The revid fields are strings. The revno fields are integers.
1815
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1816
"""Create a group of ChangeBranchTip parameters.
1818
:param branch: The branch being changed.
1819
:param old_revno: Revision number before the change.
1820
:param new_revno: Revision number after the change.
1821
:param old_revid: Tip revision id before the change.
1822
:param new_revid: Tip revision id after the change.
1824
self.branch = branch
1825
self.old_revno = old_revno
1826
self.new_revno = new_revno
1827
self.old_revid = old_revid
1828
self.new_revid = new_revid
1830
def __eq__(self, other):
1831
return self.__dict__ == other.__dict__
1834
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1835
self.__class__.__name__, self.branch,
1836
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1839
class BranchInitHookParams(object):
1840
"""Object holding parameters passed to *_branch_init hooks.
1842
There are 4 fields that hooks may wish to access:
1844
:ivar format: the branch format
1845
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1846
:ivar name: name of colocated branch, if any (or None)
1847
:ivar branch: the branch created
1849
Note that for lightweight checkouts, the bzrdir and format fields refer to
1850
the checkout, hence they are different from the corresponding fields in
1851
branch, which refer to the original branch.
1854
def __init__(self, format, a_bzrdir, name, branch):
1855
"""Create a group of BranchInitHook parameters.
1857
:param format: the branch format
1858
:param a_bzrdir: the BzrDir where the branch will be/has been
1860
:param name: name of colocated branch, if any (or None)
1861
:param branch: the branch created
1863
Note that for lightweight checkouts, the bzrdir and format fields refer
1864
to the checkout, hence they are different from the corresponding fields
1865
in branch, which refer to the original branch.
1867
self.format = format
1868
self.bzrdir = a_bzrdir
1870
self.branch = branch
1872
def __eq__(self, other):
1873
return self.__dict__ == other.__dict__
1877
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1879
return "<%s of format:%s bzrdir:%s>" % (
1880
self.__class__.__name__, self.branch,
1881
self.format, self.bzrdir)
1884
class SwitchHookParams(object):
1885
"""Object holding parameters passed to *_switch hooks.
1887
There are 4 fields that hooks may wish to access:
1889
:ivar control_dir: BzrDir of the checkout to change
1890
:ivar to_branch: branch that the checkout is to reference
1891
:ivar force: skip the check for local commits in a heavy checkout
1892
:ivar revision_id: revision ID to switch to (or None)
1895
def __init__(self, control_dir, to_branch, force, revision_id):
1896
"""Create a group of SwitchHook parameters.
1898
:param control_dir: BzrDir of the checkout to change
1899
:param to_branch: branch that the checkout is to reference
1900
:param force: skip the check for local commits in a heavy checkout
1901
:param revision_id: revision ID to switch to (or None)
1903
self.control_dir = control_dir
1904
self.to_branch = to_branch
1906
self.revision_id = revision_id
1908
def __eq__(self, other):
1909
return self.__dict__ == other.__dict__
1912
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1913
self.control_dir, self.to_branch,
1917
1046
class BzrBranchFormat4(BranchFormat):
1918
1047
"""Bzr branch format 4.
1926
1055
"""See BranchFormat.get_format_description()."""
1927
1056
return "Branch format 4"
1929
def initialize(self, a_bzrdir, name=None):
1058
def initialize(self, a_bzrdir):
1930
1059
"""Create a branch of this format in a_bzrdir."""
1931
1060
utf8_files = [('revision-history', ''),
1932
1061
('branch-name', ''),
1934
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1063
return self._initialize_helper(a_bzrdir, utf8_files,
1935
1064
lock_type='branch4', set_format=False)
1937
1066
def __init__(self):
1938
1067
super(BzrBranchFormat4, self).__init__()
1939
1068
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1941
def network_name(self):
1942
"""The network name for this format is the control dirs disk label."""
1943
return self._matchingbzrdir.get_format_string()
1070
def open(self, a_bzrdir, _found=False):
1071
"""Return the branch object for a_bzrdir
1945
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1946
"""See BranchFormat.open()."""
1073
_found is a private parameter, do not use it. It is used to indicate
1074
if format probing has already be done.
1948
1077
# we are being called directly and must probe.
1949
1078
raise NotImplementedError
1950
1079
return BzrBranch(_format=self,
1951
1080
_control_files=a_bzrdir._control_files,
1952
1081
a_bzrdir=a_bzrdir,
1954
1082
_repository=a_bzrdir.open_repository())
1956
1084
def __str__(self):
1957
1085
return "Bazaar-NG branch format 4"
1960
class BranchFormatMetadir(BranchFormat):
1961
"""Common logic for meta-dir based branch formats."""
1963
def _branch_class(self):
1964
"""What class to instantiate on open calls."""
1965
raise NotImplementedError(self._branch_class)
1967
def network_name(self):
1968
"""A simple byte string uniquely identifying this format for RPC calls.
1970
Metadir branch formats use their format string.
1088
class BzrBranchFormat5(BranchFormat):
1089
"""Bzr branch format 5.
1092
- a revision-history file.
1094
- a lock dir guarding the branch itself
1095
- all of this stored in a branch/ subdirectory
1096
- works with shared repositories.
1098
This format is new in bzr 0.8.
1101
def get_format_string(self):
1102
"""See BranchFormat.get_format_string()."""
1103
return "Bazaar-NG branch format 5\n"
1105
def get_format_description(self):
1106
"""See BranchFormat.get_format_description()."""
1107
return "Branch format 5"
1109
def initialize(self, a_bzrdir):
1110
"""Create a branch of this format in a_bzrdir."""
1111
utf8_files = [('revision-history', ''),
1112
('branch-name', ''),
1114
return self._initialize_helper(a_bzrdir, utf8_files)
1117
super(BzrBranchFormat5, self).__init__()
1118
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1120
def open(self, a_bzrdir, _found=False):
1121
"""Return the branch object for a_bzrdir
1123
_found is a private parameter, do not use it. It is used to indicate
1124
if format probing has already be done.
1972
return self.get_format_string()
1974
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1975
"""See BranchFormat.open()."""
1977
format = BranchFormat.find_format(a_bzrdir, name=name)
1978
if format.__class__ != self.__class__:
1979
raise AssertionError("wrong format %r found for %r" %
1981
transport = a_bzrdir.get_branch_transport(None, name=name)
1127
format = BranchFormat.find_format(a_bzrdir)
1128
assert format.__class__ == self.__class__
1130
transport = a_bzrdir.get_branch_transport(None)
1983
1131
control_files = lockable_files.LockableFiles(transport, 'lock',
1984
1132
lockdir.LockDir)
1985
return self._branch_class()(_format=self,
1133
return BzrBranch5(_format=self,
1986
1134
_control_files=control_files,
1988
1135
a_bzrdir=a_bzrdir,
1989
_repository=a_bzrdir.find_repository(),
1990
ignore_fallbacks=ignore_fallbacks)
1991
except errors.NoSuchFile:
1992
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1995
super(BranchFormatMetadir, self).__init__()
1996
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1997
self._matchingbzrdir.set_branch_format(self)
1999
def supports_tags(self):
2003
class BzrBranchFormat5(BranchFormatMetadir):
2004
"""Bzr branch format 5.
2007
- a revision-history file.
2009
- a lock dir guarding the branch itself
2010
- all of this stored in a branch/ subdirectory
2011
- works with shared repositories.
2013
This format is new in bzr 0.8.
2016
def _branch_class(self):
2019
def get_format_string(self):
2020
"""See BranchFormat.get_format_string()."""
2021
return "Bazaar-NG branch format 5\n"
2023
def get_format_description(self):
2024
"""See BranchFormat.get_format_description()."""
2025
return "Branch format 5"
2027
def initialize(self, a_bzrdir, name=None):
2028
"""Create a branch of this format in a_bzrdir."""
2029
utf8_files = [('revision-history', ''),
2030
('branch-name', ''),
2032
return self._initialize_helper(a_bzrdir, utf8_files, name)
2034
def supports_tags(self):
2038
class BzrBranchFormat6(BranchFormatMetadir):
2039
"""Branch format with last-revision and tags.
1136
_repository=a_bzrdir.find_repository())
1138
raise NotBranchError(path=transport.base)
1141
class BzrBranchFormat6(BzrBranchFormat5):
1142
"""Branch format with last-revision
2041
1144
Unlike previous formats, this has no explicit revision history. Instead,
2042
1145
this just stores the last-revision, and the left-hand history leading
2043
1146
up to there is the history.
2045
1148
This format was introduced in bzr 0.15
2046
and became the default in 0.91.
2049
def _branch_class(self):
2052
1151
def get_format_string(self):
2053
1152
"""See BranchFormat.get_format_string()."""
2054
1153
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2057
1156
"""See BranchFormat.get_format_description()."""
2058
1157
return "Branch format 6"
2060
def initialize(self, a_bzrdir, name=None):
2061
"""Create a branch of this format in a_bzrdir."""
2062
utf8_files = [('last-revision', '0 null:\n'),
2063
('branch.conf', ''),
2066
return self._initialize_helper(a_bzrdir, utf8_files, name)
2068
def make_tags(self, branch):
2069
"""See bzrlib.branch.BranchFormat.make_tags()."""
2070
return BasicTags(branch)
2072
def supports_set_append_revisions_only(self):
2076
class BzrBranchFormat8(BranchFormatMetadir):
2077
"""Metadir format supporting storing locations of subtree branches."""
2079
def _branch_class(self):
2082
def get_format_string(self):
2083
"""See BranchFormat.get_format_string()."""
2084
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2086
def get_format_description(self):
2087
"""See BranchFormat.get_format_description()."""
2088
return "Branch format 8"
2090
def initialize(self, a_bzrdir, name=None):
2091
"""Create a branch of this format in a_bzrdir."""
2092
utf8_files = [('last-revision', '0 null:\n'),
2093
('branch.conf', ''),
2097
return self._initialize_helper(a_bzrdir, utf8_files, name)
2100
super(BzrBranchFormat8, self).__init__()
2101
self._matchingbzrdir.repository_format = \
2102
RepositoryFormatKnitPack5RichRoot()
2104
def make_tags(self, branch):
2105
"""See bzrlib.branch.BranchFormat.make_tags()."""
2106
return BasicTags(branch)
2108
def supports_set_append_revisions_only(self):
2111
def supports_stacking(self):
2114
supports_reference_locations = True
2117
class BzrBranchFormat7(BzrBranchFormat8):
2118
"""Branch format with last-revision, tags, and a stacked location pointer.
2120
The stacked location pointer is passed down to the repository and requires
2121
a repository format with supports_external_lookups = True.
2123
This format was introduced in bzr 1.6.
2126
def initialize(self, a_bzrdir, name=None):
2127
"""Create a branch of this format in a_bzrdir."""
2128
utf8_files = [('last-revision', '0 null:\n'),
2129
('branch.conf', ''),
2132
return self._initialize_helper(a_bzrdir, utf8_files, name)
2134
def _branch_class(self):
2137
def get_format_string(self):
2138
"""See BranchFormat.get_format_string()."""
2139
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2141
def get_format_description(self):
2142
"""See BranchFormat.get_format_description()."""
2143
return "Branch format 7"
2145
def supports_set_append_revisions_only(self):
2148
supports_reference_locations = False
1159
def initialize(self, a_bzrdir):
1160
"""Create a branch of this format in a_bzrdir."""
1161
utf8_files = [('last-revision', '0 null:\n'),
1162
('branch-name', ''),
1163
('branch.conf', ''),
1166
return self._initialize_helper(a_bzrdir, utf8_files)
1168
def open(self, a_bzrdir, _found=False):
1169
"""Return the branch object for a_bzrdir
1171
_found is a private parameter, do not use it. It is used to indicate
1172
if format probing has already be done.
1175
format = BranchFormat.find_format(a_bzrdir)
1176
assert format.__class__ == self.__class__
1177
transport = a_bzrdir.get_branch_transport(None)
1178
control_files = lockable_files.LockableFiles(transport, 'lock',
1180
return BzrBranch6(_format=self,
1181
_control_files=control_files,
1183
_repository=a_bzrdir.find_repository())
1185
def supports_tags(self):
2151
1189
class BranchReferenceFormat(BranchFormat):
2166
1204
def get_format_description(self):
2167
1205
"""See BranchFormat.get_format_description()."""
2168
1206
return "Checkout reference format 1"
2170
1208
def get_reference(self, a_bzrdir):
2171
1209
"""See BranchFormat.get_reference()."""
2172
1210
transport = a_bzrdir.get_branch_transport(None)
2173
return transport.get_bytes('location')
2175
def set_reference(self, a_bzrdir, to_branch):
2176
"""See BranchFormat.set_reference()."""
2177
transport = a_bzrdir.get_branch_transport(None)
2178
location = transport.put_bytes('location', to_branch.base)
2180
def initialize(self, a_bzrdir, name=None, target_branch=None):
1211
return transport.get('location').read()
1213
def initialize(self, a_bzrdir, target_branch=None):
2181
1214
"""Create a branch of this format in a_bzrdir."""
2182
1215
if target_branch is None:
2183
1216
# this format does not implement branch itself, thus the implicit
2184
1217
# creation contract must see it as uninitializable
2185
1218
raise errors.UninitializableFormat(self)
2186
mutter('creating branch reference in %s', a_bzrdir.user_url)
2187
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1219
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1220
branch_transport = a_bzrdir.get_branch_transport(self)
2188
1221
branch_transport.put_bytes('location',
2189
target_branch.bzrdir.user_url)
1222
target_branch.bzrdir.root_transport.base)
2190
1223
branch_transport.put_bytes('format', self.get_format_string())
2192
a_bzrdir, name, _found=True,
2193
possible_transports=[target_branch.bzrdir.root_transport])
2194
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1224
return self.open(a_bzrdir, _found=True)
2197
1226
def __init__(self):
2198
1227
super(BranchReferenceFormat, self).__init__()
2199
1228
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2200
self._matchingbzrdir.set_branch_format(self)
2202
1230
def _make_reference_clone_function(format, a_branch):
2203
1231
"""Create a clone() routine for a branch dynamically."""
2204
def clone(to_bzrdir, revision_id=None,
2205
repository_policy=None):
1232
def clone(to_bzrdir, revision_id=None):
2206
1233
"""See Branch.clone()."""
2207
return format.initialize(to_bzrdir, target_branch=a_branch)
1234
return format.initialize(to_bzrdir, a_branch)
2208
1235
# cannot obey revision_id limits when cloning a reference ...
2209
1236
# FIXME RBC 20060210 either nuke revision_id for clone, or
2210
1237
# emit some sort of warning/error to the caller ?!
2213
def open(self, a_bzrdir, name=None, _found=False, location=None,
2214
possible_transports=None, ignore_fallbacks=False):
1240
def open(self, a_bzrdir, _found=False, location=None):
2215
1241
"""Return the branch that the branch reference in a_bzrdir points at.
2217
:param a_bzrdir: A BzrDir that contains a branch.
2218
:param name: Name of colocated branch to open, if any
2219
:param _found: a private parameter, do not use it. It is used to
2220
indicate if format probing has already be done.
2221
:param ignore_fallbacks: when set, no fallback branches will be opened
2222
(if there are any). Default is to open fallbacks.
2223
:param location: The location of the referenced branch. If
2224
unspecified, this will be determined from the branch reference in
2226
:param possible_transports: An optional reusable transports list.
1243
_found is a private parameter, do not use it. It is used to indicate
1244
if format probing has already be done.
2229
format = BranchFormat.find_format(a_bzrdir, name=name)
2230
if format.__class__ != self.__class__:
2231
raise AssertionError("wrong format %r found for %r" %
1247
format = BranchFormat.find_format(a_bzrdir)
1248
assert format.__class__ == self.__class__
2233
1249
if location is None:
2234
1250
location = self.get_reference(a_bzrdir)
2235
real_bzrdir = bzrdir.BzrDir.open(
2236
location, possible_transports=possible_transports)
2237
result = real_bzrdir.open_branch(name=name,
2238
ignore_fallbacks=ignore_fallbacks)
1251
real_bzrdir = bzrdir.BzrDir.open(location)
1252
result = real_bzrdir.open_branch()
2239
1253
# this changes the behaviour of result.clone to create a new reference
2240
1254
# rather than a copy of the content of the branch.
2241
1255
# I did not use a proxy object because that needs much more extensive
2251
network_format_registry = registry.FormatRegistry()
2252
"""Registry of formats indexed by their network name.
2254
The network name for a branch format is an identifier that can be used when
2255
referring to formats with smart server operations. See
2256
BranchFormat.network_name() for more detail.
2260
1265
# formats which have no format string are not discoverable
2261
1266
# and not independently creatable, so are not registered.
2262
__format5 = BzrBranchFormat5()
2263
__format6 = BzrBranchFormat6()
2264
__format7 = BzrBranchFormat7()
2265
__format8 = BzrBranchFormat8()
2266
BranchFormat.register_format(__format5)
1267
__default_format = BzrBranchFormat5()
1268
BranchFormat.register_format(__default_format)
2267
1269
BranchFormat.register_format(BranchReferenceFormat())
2268
BranchFormat.register_format(__format6)
2269
BranchFormat.register_format(__format7)
2270
BranchFormat.register_format(__format8)
2271
BranchFormat.set_default_format(__format7)
1270
BranchFormat.register_format(BzrBranchFormat6())
1271
BranchFormat.set_default_format(__default_format)
2272
1272
_legacy_formats = [BzrBranchFormat4(),
2274
network_format_registry.register(
2275
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2278
class BranchWriteLockResult(LogicalLockResult):
2279
"""The result of write locking a branch.
2281
:ivar branch_token: The token obtained from the underlying branch lock, or
2283
:ivar unlock: A callable which will unlock the lock.
2286
def __init__(self, unlock, branch_token):
2287
LogicalLockResult.__init__(self, unlock)
2288
self.branch_token = branch_token
2291
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2295
class BzrBranch(Branch, _RelockDebugMixin):
1275
class BzrBranch(Branch):
2296
1276
"""A branch stored in the actual filesystem.
2298
1278
Note that it's "local" in the context of the filesystem; it doesn't
2299
1279
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2300
1280
it's writable, and can be accessed via the normal filesystem API.
2302
:ivar _transport: Transport for file operations on this branch's
2303
control files, typically pointing to the .bzr/branch directory.
2304
:ivar repository: Repository for this branch.
2305
:ivar base: The url of the base directory for this branch; the one
2306
containing the .bzr directory.
2307
:ivar name: Optional colocated branch name as it exists in the control
2311
1283
def __init__(self, _format=None,
2312
_control_files=None, a_bzrdir=None, name=None,
2313
_repository=None, ignore_fallbacks=False):
1284
_control_files=None, a_bzrdir=None, _repository=None):
2314
1285
"""Create new branch object at a particular location."""
1286
Branch.__init__(self)
2315
1287
if a_bzrdir is None:
2316
1288
raise ValueError('a_bzrdir must be supplied')
2318
1290
self.bzrdir = a_bzrdir
1291
# self._transport used to point to the directory containing the
1292
# control directory, but was not used - now it's just the transport
1293
# for the branch control files. mbp 20070212
2319
1294
self._base = self.bzrdir.transport.clone('..').base
2321
# XXX: We should be able to just do
2322
# self.base = self.bzrdir.root_transport.base
2323
# but this does not quite work yet -- mbp 20080522
2324
1295
self._format = _format
2325
1296
if _control_files is None:
2326
1297
raise ValueError('BzrBranch _control_files is None')
2327
1298
self.control_files = _control_files
2328
1299
self._transport = _control_files._transport
2329
1300
self.repository = _repository
2330
Branch.__init__(self)
2332
1302
def __str__(self):
2333
if self.name is None:
2334
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2336
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
1303
return '%s(%r)' % (self.__class__.__name__, self.base)
2339
1305
__repr__ = __str__
2345
1311
base = property(_get_base, doc="The URL for the root of this branch.")
2347
def _get_config(self):
2348
return TransportConfig(self._transport, 'branch.conf')
1313
def abspath(self, name):
1314
"""See Branch.abspath."""
1315
return self.control_files._transport.abspath(name)
1318
@deprecated_method(zero_sixteen)
1320
def get_root_id(self):
1321
"""See Branch.get_root_id."""
1322
tree = self.repository.revision_tree(self.last_revision())
1323
return tree.inventory.root.file_id
2350
1325
def is_locked(self):
2351
1326
return self.control_files.is_locked()
2353
1328
def lock_write(self, token=None):
2354
"""Lock the branch for write operations.
2356
:param token: A token to permit reacquiring a previously held and
2358
:return: A BranchWriteLockResult.
2360
if not self.is_locked():
2361
self._note_lock('w')
2362
# All-in-one needs to always unlock/lock.
2363
repo_control = getattr(self.repository, 'control_files', None)
2364
if self.control_files == repo_control or not self.is_locked():
2365
self.repository._warn_if_deprecated(self)
2366
self.repository.lock_write()
1329
repo_token = self.repository.lock_write()
2371
return BranchWriteLockResult(self.unlock,
2372
self.control_files.lock_write(token=token))
1331
token = self.control_files.lock_write(token=token)
2375
self.repository.unlock()
1333
self.repository.unlock()
2378
1337
def lock_read(self):
2379
"""Lock the branch for read operations.
2381
:return: A bzrlib.lock.LogicalLockResult.
2383
if not self.is_locked():
2384
self._note_lock('r')
2385
# All-in-one needs to always unlock/lock.
2386
repo_control = getattr(self.repository, 'control_files', None)
2387
if self.control_files == repo_control or not self.is_locked():
2388
self.repository._warn_if_deprecated(self)
2389
self.repository.lock_read()
1338
self.repository.lock_read()
2394
1340
self.control_files.lock_read()
2395
return LogicalLockResult(self.unlock)
2398
self.repository.unlock()
1342
self.repository.unlock()
2401
@only_raises(errors.LockNotHeld, errors.LockBroken)
2402
1345
def unlock(self):
1346
# TODO: test for failed two phase locks. This is known broken.
2404
1348
self.control_files.unlock()
2406
# All-in-one needs to always unlock/lock.
2407
repo_control = getattr(self.repository, 'control_files', None)
2408
if (self.control_files == repo_control or
2409
not self.control_files.is_locked()):
2410
self.repository.unlock()
2411
if not self.control_files.is_locked():
2412
# we just released the lock
2413
self._clear_cached_state()
1350
self.repository.unlock()
1351
if not self.control_files.is_locked():
1352
# we just released the lock
1353
self._clear_cached_state()
2415
1355
def peek_lock_mode(self):
2416
1356
if self.control_files._lock_count == 0:
2426
1366
"""See Branch.print_file."""
2427
1367
return self.repository.print_file(file, revision_id)
1370
def append_revision(self, *revision_ids):
1371
"""See Branch.append_revision."""
1372
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1373
for revision_id in revision_ids:
1374
_mod_revision.check_not_reserved_id(revision_id)
1375
mutter("add {%s} to revision-history" % revision_id)
1376
rev_history = self.revision_history()
1377
rev_history.extend(revision_ids)
1378
self.set_revision_history(rev_history)
2429
1380
def _write_revision_history(self, history):
2430
1381
"""Factored out of set_revision_history.
2432
1383
This performs the actual writing to disk.
2433
1384
It is intended to be called by BzrBranch5.set_revision_history."""
2434
self._transport.put_bytes(
2435
'revision-history', '\n'.join(history),
2436
mode=self.bzrdir._get_file_mode())
1385
self.control_files.put_bytes(
1386
'revision-history', '\n'.join(history))
2438
1388
@needs_write_lock
2439
1389
def set_revision_history(self, rev_history):
2440
1390
"""See Branch.set_revision_history."""
2441
if 'evil' in debug.debug_flags:
2442
mutter_callsite(3, "set_revision_history scales with history.")
2443
check_not_reserved_id = _mod_revision.check_not_reserved_id
2444
for rev_id in rev_history:
2445
check_not_reserved_id(rev_id)
2446
if Branch.hooks['post_change_branch_tip']:
2447
# Don't calculate the last_revision_info() if there are no hooks
2449
old_revno, old_revid = self.last_revision_info()
2450
if len(rev_history) == 0:
2451
revid = _mod_revision.NULL_REVISION
2453
revid = rev_history[-1]
2454
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1391
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1392
self._clear_cached_state()
2455
1393
self._write_revision_history(rev_history)
2456
self._clear_cached_state()
2457
1394
self._cache_revision_history(rev_history)
2458
1395
for hook in Branch.hooks['set_rh']:
2459
1396
hook(self, rev_history)
2460
if Branch.hooks['post_change_branch_tip']:
2461
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2463
def _synchronize_history(self, destination, revision_id):
2464
"""Synchronize last revision and revision history between branches.
2466
This version is most efficient when the destination is also a
2467
BzrBranch5, but works for BzrBranch6 as long as the revision
2468
history is the true lefthand parent history, and all of the revisions
2469
are in the destination's repository. If not, set_revision_history
2472
:param destination: The branch to copy the history into
2473
:param revision_id: The revision-id to truncate history at. May
2474
be None to copy complete history.
2476
if not isinstance(destination._format, BzrBranchFormat5):
2477
super(BzrBranch, self)._synchronize_history(
2478
destination, revision_id)
2480
if revision_id == _mod_revision.NULL_REVISION:
2483
new_history = self.revision_history()
2484
if revision_id is not None and new_history != []:
2486
new_history = new_history[:new_history.index(revision_id) + 1]
2488
rev = self.repository.get_revision(revision_id)
2489
new_history = rev.get_history(self.repository)[1:]
2490
destination.set_revision_history(new_history)
2492
1398
@needs_write_lock
2493
1399
def set_last_revision_info(self, revno, revision_id):
2494
"""Set the last revision of this branch.
2496
The caller is responsible for checking that the revno is correct
2497
for this revision id.
2499
It may be possible to set the branch last revision to an id not
2500
present in the repository. However, branches can also be
2501
configured to check constraints on history, in which case this may not
2504
revision_id = _mod_revision.ensure_null(revision_id)
2505
# this old format stores the full history, but this api doesn't
2506
# provide it, so we must generate, and might as well check it's
1400
revision_id = osutils.safe_revision_id(revision_id)
2508
1401
history = self._lefthand_history(revision_id)
2509
if len(history) != revno:
2510
raise AssertionError('%d != %d' % (len(history), revno))
1402
assert len(history) == revno, '%d != %d' % (len(history), revno)
2511
1403
self.set_revision_history(history)
2513
1405
def _gen_revision_history(self):
2514
history = self._transport.get_bytes('revision-history').split('\n')
1406
history = self.control_files.get('revision-history').read().split('\n')
2515
1407
if history[-1:] == ['']:
2516
1408
# There shouldn't be a trailing newline, but just in case.
1412
def _lefthand_history(self, revision_id, last_rev=None,
1414
# stop_revision must be a descendant of last_revision
1415
stop_graph = self.repository.get_revision_graph(revision_id)
1416
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1417
and last_rev not in stop_graph):
1418
# our previous tip is not merged into stop_revision
1419
raise errors.DivergedBranches(self, other_branch)
1420
# make a new revision history from the graph
1421
current_rev_id = revision_id
1423
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1424
new_history.append(current_rev_id)
1425
current_rev_id_parents = stop_graph[current_rev_id]
1427
current_rev_id = current_rev_id_parents[0]
1429
current_rev_id = None
1430
new_history.reverse()
2520
1433
@needs_write_lock
2521
1434
def generate_revision_history(self, revision_id, last_rev=None,
2522
1435
other_branch=None):
2528
1441
:param other_branch: The other branch that DivergedBranches should
2529
1442
raise with respect to.
1444
revision_id = osutils.safe_revision_id(revision_id)
2531
1445
self.set_revision_history(self._lefthand_history(revision_id,
2532
1446
last_rev, other_branch))
1449
def update_revisions(self, other, stop_revision=None):
1450
"""See Branch.update_revisions."""
1453
if stop_revision is None:
1454
stop_revision = other.last_revision()
1455
if stop_revision is None:
1456
# if there are no commits, we're done.
1459
stop_revision = osutils.safe_revision_id(stop_revision)
1460
# whats the current last revision, before we fetch [and change it
1462
last_rev = _mod_revision.ensure_null(self.last_revision())
1463
# we fetch here regardless of whether we need to so that we pickup
1465
self.fetch(other, stop_revision)
1466
if self.repository.get_graph().is_ancestor(stop_revision,
1469
self.generate_revision_history(stop_revision, last_rev=last_rev,
2534
1474
def basis_tree(self):
2535
1475
"""See Branch.basis_tree."""
2536
1476
return self.repository.revision_tree(self.last_revision())
1478
@deprecated_method(zero_eight)
1479
def working_tree(self):
1480
"""Create a Working tree object for this branch."""
1482
from bzrlib.transport.local import LocalTransport
1483
if (self.base.find('://') != -1 or
1484
not isinstance(self._transport, LocalTransport)):
1485
raise NoWorkingTree(self.base)
1486
return self.bzrdir.open_workingtree()
1489
def pull(self, source, overwrite=False, stop_revision=None,
1490
_hook_master=None, run_hooks=True):
1493
:param _hook_master: Private parameter - set the branch to
1494
be supplied as the master to push hooks.
1495
:param run_hooks: Private parameter - if false, this branch
1496
is being called because it's the master of the primary branch,
1497
so it should not run its hooks.
1499
result = PullResult()
1500
result.source_branch = source
1501
result.target_branch = self
1504
result.old_revno, result.old_revid = self.last_revision_info()
1506
self.update_revisions(source, stop_revision)
1507
except DivergedBranches:
1511
if stop_revision is None:
1512
stop_revision = source.last_revision()
1513
self.generate_revision_history(stop_revision)
1514
result.tag_conflicts = source.tags.merge_to(self.tags)
1515
result.new_revno, result.new_revid = self.last_revision_info()
1517
result.master_branch = _hook_master
1518
result.local_branch = self
1520
result.master_branch = self
1521
result.local_branch = None
1523
for hook in Branch.hooks['post_pull']:
2538
1529
def _get_parent_location(self):
2539
1530
_locs = ['parent', 'pull', 'x-pull']
2540
1531
for l in _locs:
2542
return self._transport.get_bytes(l).strip('\n')
2543
except errors.NoSuchFile:
1533
return self.control_files.get(l).read().strip('\n')
1539
def push(self, target, overwrite=False, stop_revision=None,
1540
_override_hook_source_branch=None):
1543
This is the basic concrete implementation of push()
1545
:param _override_hook_source_branch: If specified, run
1546
the hooks passing this Branch as the source, rather than self.
1547
This is for use of RemoteBranch, where push is delegated to the
1548
underlying vfs-based Branch.
1550
# TODO: Public option to disable running hooks - should be trivial but
1554
result = self._push_with_bound_branches(target, overwrite,
1556
_override_hook_source_branch=_override_hook_source_branch)
1561
def _push_with_bound_branches(self, target, overwrite,
1563
_override_hook_source_branch=None):
1564
"""Push from self into target, and into target's master if any.
1566
This is on the base BzrBranch class even though it doesn't support
1567
bound branches because the *target* might be bound.
1570
if _override_hook_source_branch:
1571
result.source_branch = _override_hook_source_branch
1572
for hook in Branch.hooks['post_push']:
1575
bound_location = target.get_bound_location()
1576
if bound_location and target.base != bound_location:
1577
# there is a master branch.
1579
# XXX: Why the second check? Is it even supported for a branch to
1580
# be bound to itself? -- mbp 20070507
1581
master_branch = target.get_master_branch()
1582
master_branch.lock_write()
1584
# push into the master from this branch.
1585
self._basic_push(master_branch, overwrite, stop_revision)
1586
# and push into the target branch from this. Note that we push from
1587
# this branch again, because its considered the highest bandwidth
1589
result = self._basic_push(target, overwrite, stop_revision)
1590
result.master_branch = master_branch
1591
result.local_branch = target
1595
master_branch.unlock()
1598
result = self._basic_push(target, overwrite, stop_revision)
1599
# TODO: Why set master_branch and local_branch if there's no
1600
# binding? Maybe cleaner to just leave them unset? -- mbp
1602
result.master_branch = target
1603
result.local_branch = None
2547
1607
def _basic_push(self, target, overwrite, stop_revision):
2548
1608
"""Basic implementation of push without bound branches or hooks.
2550
Must be called with source read locked and target write locked.
1610
Must be called with self read locked and target write locked.
2552
result = BranchPushResult()
1612
result = PushResult()
2553
1613
result.source_branch = self
2554
1614
result.target_branch = target
2555
1615
result.old_revno, result.old_revid = target.last_revision_info()
2556
self.update_references(target)
2557
if result.old_revid != self.last_revision():
2558
# We assume that during 'push' this repository is closer than
2560
graph = self.repository.get_graph(target.repository)
2561
target.update_revisions(self, stop_revision,
2562
overwrite=overwrite, graph=graph)
2563
if self._push_should_merge_tags():
2564
result.tag_conflicts = self.tags.merge_to(target.tags,
1617
target.update_revisions(self, stop_revision)
1618
except DivergedBranches:
1622
target.set_revision_history(self.revision_history())
1623
result.tag_conflicts = self.tags.merge_to(target.tags)
2566
1624
result.new_revno, result.new_revid = target.last_revision_info()
2569
def get_stacked_on_url(self):
2570
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1627
def get_parent(self):
1628
"""See Branch.get_parent."""
1630
assert self.base[-1] == '/'
1631
parent = self._get_parent_location()
1634
# This is an old-format absolute path to a local branch
1635
# turn it into a url
1636
if parent.startswith('/'):
1637
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1639
return urlutils.join(self.base[:-1], parent)
1640
except errors.InvalidURLJoin, e:
1641
raise errors.InaccessibleParent(parent, self.base)
2572
1643
def set_push_location(self, location):
2573
1644
"""See Branch.set_push_location."""
2575
1646
'push_location', location,
2576
1647
store=_mod_config.STORE_LOCATION_NORECURSE)
1650
def set_parent(self, url):
1651
"""See Branch.set_parent."""
1652
# TODO: Maybe delete old location files?
1653
# URLs should never be unicode, even on the local fs,
1654
# FIXUP this and get_parent in a future branch format bump:
1655
# read and rewrite the file, and have the new format code read
1656
# using .get not .get_utf8. RBC 20060125
1658
if isinstance(url, unicode):
1660
url = url.encode('ascii')
1661
except UnicodeEncodeError:
1662
raise errors.InvalidURL(url,
1663
"Urls must be 7-bit ascii, "
1664
"use bzrlib.urlutils.escape")
1665
url = urlutils.relative_url(self.base, url)
1666
self._set_parent_location(url)
2578
1668
def _set_parent_location(self, url):
2579
1669
if url is None:
2580
self._transport.delete('parent')
1670
self.control_files._transport.delete('parent')
2582
self._transport.put_bytes('parent', url + '\n',
2583
mode=self.bzrdir._get_file_mode())
1672
assert isinstance(url, str)
1673
self.control_files.put_bytes('parent', url + '\n')
1675
@deprecated_function(zero_nine)
1676
def tree_config(self):
1677
"""DEPRECATED; call get_config instead.
1678
TreeConfig has become part of BranchConfig."""
1679
return TreeConfig(self)
2586
1682
class BzrBranch5(BzrBranch):
2587
"""A format 5 branch. This supports new features over plain branches.
1683
"""A format 5 branch. This supports new features over plan branches.
2589
1685
It has support for a master_branch which is the data for bound branches.
1693
super(BzrBranch5, self).__init__(_format=_format,
1694
_control_files=_control_files,
1696
_repository=_repository)
1699
def pull(self, source, overwrite=False, stop_revision=None,
1701
"""Pull from source into self, updating my master if any.
1703
:param run_hooks: Private parameter - if false, this branch
1704
is being called because it's the master of the primary branch,
1705
so it should not run its hooks.
1707
bound_location = self.get_bound_location()
1708
master_branch = None
1709
if bound_location and source.base != bound_location:
1710
# not pulling from master, so we need to update master.
1711
master_branch = self.get_master_branch()
1712
master_branch.lock_write()
1715
# pull from source into master.
1716
master_branch.pull(source, overwrite, stop_revision,
1718
return super(BzrBranch5, self).pull(source, overwrite,
1719
stop_revision, _hook_master=master_branch,
1720
run_hooks=run_hooks)
1723
master_branch.unlock()
2592
1725
def get_bound_location(self):
2594
return self._transport.get_bytes('bound')[:-1]
1727
return self.control_files.get_utf8('bound').read()[:-1]
2595
1728
except errors.NoSuchFile:
2598
1731
@needs_read_lock
2599
def get_master_branch(self, possible_transports=None):
1732
def get_master_branch(self):
2600
1733
"""Return the branch we are bound to.
2602
1735
:return: Either a Branch, or None
2604
1737
This could memoise the branch, but if thats done
2684
class BzrBranch8(BzrBranch5):
2685
"""A branch that stores tree-reference locations."""
2687
def _open_hook(self):
2688
if self._ignore_fallbacks:
1831
class BzrBranchExperimental(BzrBranch5):
1832
"""Bzr experimental branch format
1835
- a revision-history file.
1837
- a lock dir guarding the branch itself
1838
- all of this stored in a branch/ subdirectory
1839
- works with shared repositories.
1840
- a tag dictionary in the branch
1842
This format is new in bzr 0.15, but shouldn't be used for real data,
1845
This class acts as it's own BranchFormat.
1848
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1851
def get_format_string(cls):
1852
"""See BranchFormat.get_format_string()."""
1853
return "Bazaar-NG branch format experimental\n"
1856
def get_format_description(cls):
1857
"""See BranchFormat.get_format_description()."""
1858
return "Experimental branch format"
1861
def get_reference(cls, a_bzrdir):
1862
"""Get the target reference of the branch in a_bzrdir.
1864
format probing must have been completed before calling
1865
this method - it is assumed that the format of the branch
1866
in a_bzrdir is correct.
1868
:param a_bzrdir: The bzrdir to get the branch data from.
1869
:return: None if the branch is not a reference branch.
1874
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1876
branch_transport = a_bzrdir.get_branch_transport(cls)
1877
control_files = lockable_files.LockableFiles(branch_transport,
1878
lock_filename, lock_class)
1879
control_files.create_lock()
1880
control_files.lock_write()
2691
url = self.get_stacked_on_url()
2692
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2693
errors.UnstackableBranchFormat):
2696
for hook in Branch.hooks['transform_fallback_location']:
2697
url = hook(self, url)
2699
hook_name = Branch.hooks.get_hook_name(hook)
2700
raise AssertionError(
2701
"'transform_fallback_location' hook %s returned "
2702
"None, not a URL." % hook_name)
2703
self._activate_fallback_location(url)
2705
def __init__(self, *args, **kwargs):
2706
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2707
super(BzrBranch8, self).__init__(*args, **kwargs)
2708
self._last_revision_info_cache = None
2709
self._reference_info = None
2711
def _clear_cached_state(self):
2712
super(BzrBranch8, self)._clear_cached_state()
2713
self._last_revision_info_cache = None
2714
self._reference_info = None
2716
def _last_revision_info(self):
2717
revision_string = self._transport.get_bytes('last-revision')
1882
for filename, content in utf8_files:
1883
control_files.put_utf8(filename, content)
1885
control_files.unlock()
1888
def initialize(cls, a_bzrdir):
1889
"""Create a branch of this format in a_bzrdir."""
1890
utf8_files = [('format', cls.get_format_string()),
1891
('revision-history', ''),
1892
('branch-name', ''),
1895
cls._initialize_control_files(a_bzrdir, utf8_files,
1896
'lock', lockdir.LockDir)
1897
return cls.open(a_bzrdir, _found=True)
1900
def open(cls, a_bzrdir, _found=False):
1901
"""Return the branch object for a_bzrdir
1903
_found is a private parameter, do not use it. It is used to indicate
1904
if format probing has already be done.
1907
format = BranchFormat.find_format(a_bzrdir)
1908
assert format.__class__ == cls
1909
transport = a_bzrdir.get_branch_transport(None)
1910
control_files = lockable_files.LockableFiles(transport, 'lock',
1912
return cls(_format=cls,
1913
_control_files=control_files,
1915
_repository=a_bzrdir.find_repository())
1918
def is_supported(cls):
1921
def _make_tags(self):
1922
return BasicTags(self)
1925
def supports_tags(cls):
1929
BranchFormat.register_format(BzrBranchExperimental)
1932
class BzrBranch6(BzrBranch5):
1935
def last_revision_info(self):
1936
revision_string = self.control_files.get('last-revision').read()
2718
1937
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2719
1938
revision_id = cache_utf8.get_cached_utf8(revision_id)
2720
1939
revno = int(revno)
2721
1940
return revno, revision_id
1942
def last_revision(self):
1943
"""Return last revision id, or None"""
1944
revision_id = self.last_revision_info()[1]
1945
if revision_id == _mod_revision.NULL_REVISION:
2723
1949
def _write_last_revision_info(self, revno, revision_id):
2724
1950
"""Simply write out the revision id, with no checks.
2729
1955
Intended to be called by set_last_revision_info and
2730
1956
_write_revision_history.
2732
revision_id = _mod_revision.ensure_null(revision_id)
1958
if revision_id is None:
1959
revision_id = 'null:'
2733
1960
out_string = '%d %s\n' % (revno, revision_id)
2734
self._transport.put_bytes('last-revision', out_string,
2735
mode=self.bzrdir._get_file_mode())
1961
self.control_files.put_bytes('last-revision', out_string)
2737
1963
@needs_write_lock
2738
1964
def set_last_revision_info(self, revno, revision_id):
2739
revision_id = _mod_revision.ensure_null(revision_id)
2740
old_revno, old_revid = self.last_revision_info()
1965
revision_id = osutils.safe_revision_id(revision_id)
2741
1966
if self._get_append_revisions_only():
2742
1967
self._check_history_violation(revision_id)
2743
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2744
1968
self._write_last_revision_info(revno, revision_id)
2745
1969
self._clear_cached_state()
2746
self._last_revision_info_cache = revno, revision_id
2747
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2749
def _synchronize_history(self, destination, revision_id):
2750
"""Synchronize last revision and revision history between branches.
2752
:see: Branch._synchronize_history
2754
# XXX: The base Branch has a fast implementation of this method based
2755
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2756
# that uses set_revision_history. This class inherits from BzrBranch5,
2757
# but wants the fast implementation, so it calls
2758
# Branch._synchronize_history directly.
2759
Branch._synchronize_history(self, destination, revision_id)
2761
1971
def _check_history_violation(self, revision_id):
2762
1972
last_revision = _mod_revision.ensure_null(self.last_revision())
2763
1973
if _mod_revision.is_null(last_revision):
2765
1975
if last_revision not in self._lefthand_history(revision_id):
2766
raise errors.AppendRevisionsOnlyViolation(self.user_url)
1976
raise errors.AppendRevisionsOnlyViolation(self.base)
2768
1978
def _gen_revision_history(self):
2769
1979
"""Generate the revision history from last revision
2771
last_revno, last_revision = self.last_revision_info()
2772
self._extend_partial_history(stop_index=last_revno-1)
2773
return list(reversed(self._partial_revision_history_cache))
1981
history = list(self.repository.iter_reverse_revision_history(
1982
self.last_revision()))
2775
1986
def _write_revision_history(self, history):
2776
1987
"""Factored out of set_revision_history.
2798
2028
"""Set the parent branch"""
2799
2029
return self._get_config_location('parent_location')
2802
def _set_all_reference_info(self, info_dict):
2803
"""Replace all reference info stored in a branch.
2805
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2808
writer = rio.RioWriter(s)
2809
for key, (tree_path, branch_location) in info_dict.iteritems():
2810
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2811
branch_location=branch_location)
2812
writer.write_stanza(stanza)
2813
self._transport.put_bytes('references', s.getvalue())
2814
self._reference_info = info_dict
2817
def _get_all_reference_info(self):
2818
"""Return all the reference info stored in a branch.
2820
:return: A dict of {file_id: (tree_path, branch_location)}
2822
if self._reference_info is not None:
2823
return self._reference_info
2824
rio_file = self._transport.get('references')
2826
stanzas = rio.read_stanzas(rio_file)
2827
info_dict = dict((s['file_id'], (s['tree_path'],
2828
s['branch_location'])) for s in stanzas)
2831
self._reference_info = info_dict
2834
def set_reference_info(self, file_id, tree_path, branch_location):
2835
"""Set the branch location to use for a tree reference.
2837
:param file_id: The file-id of the tree reference.
2838
:param tree_path: The path of the tree reference in the tree.
2839
:param branch_location: The location of the branch to retrieve tree
2842
info_dict = self._get_all_reference_info()
2843
info_dict[file_id] = (tree_path, branch_location)
2844
if None in (tree_path, branch_location):
2845
if tree_path is not None:
2846
raise ValueError('tree_path must be None when branch_location'
2848
if branch_location is not None:
2849
raise ValueError('branch_location must be None when tree_path'
2851
del info_dict[file_id]
2852
self._set_all_reference_info(info_dict)
2854
def get_reference_info(self, file_id):
2855
"""Get the tree_path and branch_location for a tree reference.
2857
:return: a tuple of (tree_path, branch_location)
2859
return self._get_all_reference_info().get(file_id, (None, None))
2861
def reference_parent(self, file_id, path, possible_transports=None):
2862
"""Return the parent branch for a tree-reference file_id.
2864
:param file_id: The file_id of the tree reference
2865
:param path: The path of the file_id in the tree
2866
:return: A branch associated with the file_id
2868
branch_location = self.get_reference_info(file_id)[1]
2869
if branch_location is None:
2870
return Branch.reference_parent(self, file_id, path,
2871
possible_transports)
2872
branch_location = urlutils.join(self.user_url, branch_location)
2873
return Branch.open(branch_location,
2874
possible_transports=possible_transports)
2876
2031
def set_push_location(self, location):
2877
2032
"""See Branch.set_push_location."""
2878
2033
self._set_config_location('push_location', location)
2911
2066
"""See Branch.get_old_bound_location"""
2912
2067
return self._get_bound_location(False)
2914
def get_stacked_on_url(self):
2915
# you can always ask for the URL; but you might not be able to use it
2916
# if the repo can't support stacking.
2917
## self._check_stackable_repo()
2918
stacked_url = self._get_config_location('stacked_on_location')
2919
if stacked_url is None:
2920
raise errors.NotStacked(self)
2069
def set_append_revisions_only(self, enabled):
2074
self.get_config().set_user_option('append_revisions_only', value,
2923
2077
def _get_append_revisions_only(self):
2924
return self.get_config(
2925
).get_user_option_as_bool('append_revisions_only')
2928
def generate_revision_history(self, revision_id, last_rev=None,
2930
"""See BzrBranch5.generate_revision_history"""
2931
history = self._lefthand_history(revision_id, last_rev, other_branch)
2932
revno = len(history)
2933
self.set_last_revision_info(revno, revision_id)
2936
def get_rev_id(self, revno, history=None):
2937
"""Find the revision id of the specified revno."""
2939
return _mod_revision.NULL_REVISION
2941
last_revno, last_revision_id = self.last_revision_info()
2942
if revno <= 0 or revno > last_revno:
2943
raise errors.NoSuchRevision(self, revno)
2945
if history is not None:
2946
return history[revno - 1]
2948
index = last_revno - revno
2949
if len(self._partial_revision_history_cache) <= index:
2950
self._extend_partial_history(stop_index=index)
2951
if len(self._partial_revision_history_cache) > index:
2952
return self._partial_revision_history_cache[index]
2078
value = self.get_config().get_user_option('append_revisions_only')
2079
return value == 'True'
2081
def _synchronize_history(self, destination, revision_id):
2082
"""Synchronize last revision and revision history between branches.
2084
This version is most efficient when the destination is also a
2085
BzrBranch6, but works for BzrBranch5, as long as the destination's
2086
repository contains all the lefthand ancestors of the intended
2087
last_revision. If not, set_last_revision_info will fail.
2089
:param destination: The branch to copy the history into
2090
:param revision_id: The revision-id to truncate history at. May
2091
be None to copy complete history.
2093
if revision_id is None:
2094
revno, revision_id = self.last_revision_info()
2954
raise errors.NoSuchRevision(self, revno)
2957
def revision_id_to_revno(self, revision_id):
2958
"""Given a revision id, return its revno"""
2959
if _mod_revision.is_null(revision_id):
2962
index = self._partial_revision_history_cache.index(revision_id)
2964
self._extend_partial_history(stop_revision=revision_id)
2965
index = len(self._partial_revision_history_cache) - 1
2966
if self._partial_revision_history_cache[index] != revision_id:
2967
raise errors.NoSuchRevision(self, revision_id)
2968
return self.revno() - index
2971
class BzrBranch7(BzrBranch8):
2972
"""A branch with support for a fallback repository."""
2974
def set_reference_info(self, file_id, tree_path, branch_location):
2975
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2977
def get_reference_info(self, file_id):
2978
Branch.get_reference_info(self, file_id)
2980
def reference_parent(self, file_id, path, possible_transports=None):
2981
return Branch.reference_parent(self, file_id, path,
2982
possible_transports)
2985
class BzrBranch6(BzrBranch7):
2986
"""See BzrBranchFormat6 for the capabilities of this branch.
2988
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2992
def get_stacked_on_url(self):
2993
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2096
# To figure out the revno for a random revision, we need to build
2097
# the revision history, and count its length.
2098
# We don't care about the order, just how long it is.
2099
# Alternatively, we could start at the current location, and count
2100
# backwards. But there is no guarantee that we will find it since
2101
# it may be a merged revision.
2102
revno = len(list(self.repository.iter_reverse_revision_history(
2104
destination.set_last_revision_info(revno, revision_id)
2106
def _make_tags(self):
2107
return BasicTags(self)
2996
2110
######################################################################
3107
2208
new_branch.tags._set_tag_dict({})
3109
2210
# Copying done; now update target format
3110
new_branch._transport.put_bytes('format',
3111
format.get_format_string(),
3112
mode=new_branch.bzrdir._get_file_mode())
2211
new_branch.control_files.put_utf8('format',
2212
format.get_format_string())
3114
2214
# Clean up old files
3115
new_branch._transport.delete('revision-history')
2215
new_branch.control_files._transport.delete('revision-history')
3117
2217
branch.set_parent(None)
3118
except errors.NoSuchFile:
3120
2220
branch.set_bound_location(None)
3123
class Converter6to7(object):
3124
"""Perform an in-place upgrade of format 6 to format 7"""
3126
def convert(self, branch):
3127
format = BzrBranchFormat7()
3128
branch._set_config_location('stacked_on_location', '')
3129
# update target format
3130
branch._transport.put_bytes('format', format.get_format_string())
3133
class Converter7to8(object):
3134
"""Perform an in-place upgrade of format 6 to format 7"""
3136
def convert(self, branch):
3137
format = BzrBranchFormat8()
3138
branch._transport.put_bytes('references', '')
3139
# update target format
3140
branch._transport.put_bytes('format', format.get_format_string())
3143
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3144
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3147
_run_with_write_locked_target will attempt to release the lock it acquires.
3149
If an exception is raised by callable, then that exception *will* be
3150
propagated, even if the unlock attempt raises its own error. Thus
3151
_run_with_write_locked_target should be preferred to simply doing::
3155
return callable(*args, **kwargs)
3160
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3161
# should share code?
3164
result = callable(*args, **kwargs)
3166
exc_info = sys.exc_info()
3170
raise exc_info[0], exc_info[1], exc_info[2]
3176
class InterBranch(InterObject):
3177
"""This class represents operations taking place between two branches.
3179
Its instances have methods like pull() and push() and contain
3180
references to the source and target repositories these operations
3181
can be carried out on.
3185
"""The available optimised InterBranch types."""
3188
def _get_branch_formats_to_test():
3189
"""Return a tuple with the Branch formats to use when testing."""
3190
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3192
def pull(self, overwrite=False, stop_revision=None,
3193
possible_transports=None, local=False):
3194
"""Mirror source into target branch.
3196
The target branch is considered to be 'local', having low latency.
3198
:returns: PullResult instance
3200
raise NotImplementedError(self.pull)
3202
def update_revisions(self, stop_revision=None, overwrite=False,
3204
"""Pull in new perfect-fit revisions.
3206
:param stop_revision: Updated until the given revision
3207
:param overwrite: Always set the branch pointer, rather than checking
3208
to see if it is a proper descendant.
3209
:param graph: A Graph object that can be used to query history
3210
information. This can be None.
3213
raise NotImplementedError(self.update_revisions)
3215
def push(self, overwrite=False, stop_revision=None,
3216
_override_hook_source_branch=None):
3217
"""Mirror the source branch into the target branch.
3219
The source branch is considered to be 'local', having low latency.
3221
raise NotImplementedError(self.push)
3224
class GenericInterBranch(InterBranch):
3225
"""InterBranch implementation that uses public Branch functions.
3229
def _get_branch_formats_to_test():
3230
return BranchFormat._default_format, BranchFormat._default_format
3232
def update_revisions(self, stop_revision=None, overwrite=False,
3234
"""See InterBranch.update_revisions()."""
3235
self.source.lock_read()
3237
other_revno, other_last_revision = self.source.last_revision_info()
3238
stop_revno = None # unknown
3239
if stop_revision is None:
3240
stop_revision = other_last_revision
3241
if _mod_revision.is_null(stop_revision):
3242
# if there are no commits, we're done.
3244
stop_revno = other_revno
3246
# what's the current last revision, before we fetch [and change it
3248
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3249
# we fetch here so that we don't process data twice in the common
3250
# case of having something to pull, and so that the check for
3251
# already merged can operate on the just fetched graph, which will
3252
# be cached in memory.
3253
self.target.fetch(self.source, stop_revision)
3254
# Check to see if one is an ancestor of the other
3257
graph = self.target.repository.get_graph()
3258
if self.target._check_if_descendant_or_diverged(
3259
stop_revision, last_rev, graph, self.source):
3260
# stop_revision is a descendant of last_rev, but we aren't
3261
# overwriting, so we're done.
3263
if stop_revno is None:
3265
graph = self.target.repository.get_graph()
3266
this_revno, this_last_revision = \
3267
self.target.last_revision_info()
3268
stop_revno = graph.find_distance_to_null(stop_revision,
3269
[(other_last_revision, other_revno),
3270
(this_last_revision, this_revno)])
3271
self.target.set_last_revision_info(stop_revno, stop_revision)
3273
self.source.unlock()
3275
def pull(self, overwrite=False, stop_revision=None,
3276
possible_transports=None, _hook_master=None, run_hooks=True,
3277
_override_hook_target=None, local=False):
3280
:param _hook_master: Private parameter - set the branch to
3281
be supplied as the master to pull hooks.
3282
:param run_hooks: Private parameter - if false, this branch
3283
is being called because it's the master of the primary branch,
3284
so it should not run its hooks.
3285
:param _override_hook_target: Private parameter - set the branch to be
3286
supplied as the target_branch to pull hooks.
3287
:param local: Only update the local branch, and not the bound branch.
3289
# This type of branch can't be bound.
3291
raise errors.LocalRequiresBoundBranch()
3292
result = PullResult()
3293
result.source_branch = self.source
3294
if _override_hook_target is None:
3295
result.target_branch = self.target
3297
result.target_branch = _override_hook_target
3298
self.source.lock_read()
3300
# We assume that during 'pull' the target repository is closer than
3302
self.source.update_references(self.target)
3303
graph = self.target.repository.get_graph(self.source.repository)
3304
# TODO: Branch formats should have a flag that indicates
3305
# that revno's are expensive, and pull() should honor that flag.
3307
result.old_revno, result.old_revid = \
3308
self.target.last_revision_info()
3309
self.target.update_revisions(self.source, stop_revision,
3310
overwrite=overwrite, graph=graph)
3311
# TODO: The old revid should be specified when merging tags,
3312
# so a tags implementation that versions tags can only
3313
# pull in the most recent changes. -- JRV20090506
3314
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3316
result.new_revno, result.new_revid = self.target.last_revision_info()
3318
result.master_branch = _hook_master
3319
result.local_branch = result.target_branch
3321
result.master_branch = result.target_branch
3322
result.local_branch = None
3324
for hook in Branch.hooks['post_pull']:
3327
self.source.unlock()
3330
def push(self, overwrite=False, stop_revision=None,
3331
_override_hook_source_branch=None):
3332
"""See InterBranch.push.
3334
This is the basic concrete implementation of push()
3336
:param _override_hook_source_branch: If specified, run
3337
the hooks passing this Branch as the source, rather than self.
3338
This is for use of RemoteBranch, where push is delegated to the
3339
underlying vfs-based Branch.
3341
# TODO: Public option to disable running hooks - should be trivial but
3343
self.source.lock_read()
3345
return _run_with_write_locked_target(
3346
self.target, self._push_with_bound_branches, overwrite,
3348
_override_hook_source_branch=_override_hook_source_branch)
3350
self.source.unlock()
3352
def _push_with_bound_branches(self, overwrite, stop_revision,
3353
_override_hook_source_branch=None):
3354
"""Push from source into target, and into target's master if any.
3357
if _override_hook_source_branch:
3358
result.source_branch = _override_hook_source_branch
3359
for hook in Branch.hooks['post_push']:
3362
bound_location = self.target.get_bound_location()
3363
if bound_location and self.target.base != bound_location:
3364
# there is a master branch.
3366
# XXX: Why the second check? Is it even supported for a branch to
3367
# be bound to itself? -- mbp 20070507
3368
master_branch = self.target.get_master_branch()
3369
master_branch.lock_write()
3371
# push into the master from the source branch.
3372
self.source._basic_push(master_branch, overwrite, stop_revision)
3373
# and push into the target branch from the source. Note that we
3374
# push from the source branch again, because its considered the
3375
# highest bandwidth repository.
3376
result = self.source._basic_push(self.target, overwrite,
3378
result.master_branch = master_branch
3379
result.local_branch = self.target
3383
master_branch.unlock()
3386
result = self.source._basic_push(self.target, overwrite,
3388
# TODO: Why set master_branch and local_branch if there's no
3389
# binding? Maybe cleaner to just leave them unset? -- mbp
3391
result.master_branch = self.target
3392
result.local_branch = None
3397
def is_compatible(self, source, target):
3398
# GenericBranch uses the public API, so always compatible
3402
class InterToBranch5(GenericInterBranch):
3405
def _get_branch_formats_to_test():
3406
return BranchFormat._default_format, BzrBranchFormat5()
3408
def pull(self, overwrite=False, stop_revision=None,
3409
possible_transports=None, run_hooks=True,
3410
_override_hook_target=None, local=False):
3411
"""Pull from source into self, updating my master if any.
3413
:param run_hooks: Private parameter - if false, this branch
3414
is being called because it's the master of the primary branch,
3415
so it should not run its hooks.
3417
bound_location = self.target.get_bound_location()
3418
if local and not bound_location:
3419
raise errors.LocalRequiresBoundBranch()
3420
master_branch = None
3421
if not local and bound_location and self.source.user_url != bound_location:
3422
# not pulling from master, so we need to update master.
3423
master_branch = self.target.get_master_branch(possible_transports)
3424
master_branch.lock_write()
3427
# pull from source into master.
3428
master_branch.pull(self.source, overwrite, stop_revision,
3430
return super(InterToBranch5, self).pull(overwrite,
3431
stop_revision, _hook_master=master_branch,
3432
run_hooks=run_hooks,
3433
_override_hook_target=_override_hook_target)
3436
master_branch.unlock()
3439
InterBranch.register_optimiser(GenericInterBranch)
3440
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
