1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from itertools import chain
26
config as _mod_config,
32
revision as _mod_revision,
39
from bzrlib.config import BranchConfig, TransportConfig
40
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
41
from bzrlib.tag import (
47
from bzrlib.decorators import needs_read_lock, needs_write_lock
48
from bzrlib.hooks import HookPoint, Hooks
49
from bzrlib.inter import InterObject
50
from bzrlib import registry
51
from bzrlib.symbol_versioning import (
55
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
58
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
59
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
60
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
63
# TODO: Maybe include checks for common corruption of newlines, etc?
65
# TODO: Some operations like log might retrieve the same revisions
66
# repeatedly to calculate deltas. We could perhaps have a weakref
67
# cache in memory to make this faster. In general anything can be
68
# cached in memory between lock and unlock operations. .. nb thats
69
# what the transaction identity map provides
72
######################################################################
76
"""Branch holding a history of revisions.
79
Base directory/url of the branch.
81
hooks: An instance of BranchHooks.
83
# this is really an instance variable - FIXME move it there
87
def __init__(self, *ignored, **ignored_too):
88
self.tags = self._format.make_tags(self)
89
self._revision_history_cache = None
90
self._revision_id_to_revno_cache = None
91
self._partial_revision_id_to_revno_cache = {}
92
self._last_revision_info_cache = None
93
self._merge_sorted_revisions_cache = None
95
hooks = Branch.hooks['open']
100
"""Called by init to allow simpler extension of the base class."""
102
def _activate_fallback_location(self, url):
103
"""Activate the branch/repository from url as a fallback repository."""
104
self.repository.add_fallback_repository(
105
self._get_fallback_repository(url))
107
def break_lock(self):
108
"""Break a lock if one is present from another instance.
110
Uses the ui factory to ask for confirmation if the lock may be from
113
This will probe the repository for its lock as well.
115
self.control_files.break_lock()
116
self.repository.break_lock()
117
master = self.get_master_branch()
118
if master is not None:
121
def _check_stackable_repo(self):
122
if not self.repository._format.supports_external_lookups:
123
raise errors.UnstackableRepositoryFormat(self.repository._format,
124
self.repository.base)
127
def open(base, _unsupported=False, possible_transports=None):
128
"""Open the branch rooted at base.
130
For instance, if the branch is at URL/.bzr/branch,
131
Branch.open(URL) -> a Branch instance.
133
control = bzrdir.BzrDir.open(base, _unsupported,
134
possible_transports=possible_transports)
135
return control.open_branch(_unsupported)
138
def open_from_transport(transport, _unsupported=False):
139
"""Open the branch rooted at transport"""
140
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
141
return control.open_branch(_unsupported)
144
def open_containing(url, possible_transports=None):
145
"""Open an existing branch which contains url.
147
This probes for a branch at url, and searches upwards from there.
149
Basically we keep looking up until we find the control directory or
150
run into the root. If there isn't one, raises NotBranchError.
151
If there is one and it is either an unrecognised format or an unsupported
152
format, UnknownFormatError or UnsupportedFormatError are raised.
153
If there is one, it is returned, along with the unused portion of url.
155
control, relpath = bzrdir.BzrDir.open_containing(url,
157
return control.open_branch(), relpath
159
def _push_should_merge_tags(self):
160
"""Should _basic_push merge this branch's tags into the target?
162
The default implementation returns False if this branch has no tags,
163
and True the rest of the time. Subclasses may override this.
165
return self.supports_tags() and self.tags.get_tag_dict()
167
def get_config(self):
168
return BranchConfig(self)
170
def _get_config(self):
171
"""Get the concrete config for just the config in this branch.
173
This is not intended for client use; see Branch.get_config for the
178
:return: An object supporting get_option and set_option.
180
raise NotImplementedError(self._get_config)
182
def _get_fallback_repository(self, url):
183
"""Get the repository we fallback to at url."""
184
url = urlutils.join(self.base, url)
185
a_bzrdir = bzrdir.BzrDir.open(url,
186
possible_transports=[self.bzrdir.root_transport])
187
return a_bzrdir.open_branch().repository
189
def _get_tags_bytes(self):
190
"""Get the bytes of a serialised tags dict.
192
Note that not all branches support tags, nor do all use the same tags
193
logic: this method is specific to BasicTags. Other tag implementations
194
may use the same method name and behave differently, safely, because
195
of the double-dispatch via
196
format.make_tags->tags_instance->get_tags_dict.
198
:return: The bytes of the tags file.
199
:seealso: Branch._set_tags_bytes.
201
return self._transport.get_bytes('tags')
203
def _get_nick(self, local=False, possible_transports=None):
204
config = self.get_config()
205
# explicit overrides master, but don't look for master if local is True
206
if not local and not config.has_explicit_nickname():
208
master = self.get_master_branch(possible_transports)
209
if master is not None:
210
# return the master branch value
212
except errors.BzrError, e:
213
# Silently fall back to local implicit nick if the master is
215
mutter("Could not connect to bound branch, "
216
"falling back to local nick.\n " + str(e))
217
return config.get_nickname()
219
def _set_nick(self, nick):
220
self.get_config().set_user_option('nickname', nick, warn_masked=True)
222
nick = property(_get_nick, _set_nick)
225
raise NotImplementedError(self.is_locked)
227
def _lefthand_history(self, revision_id, last_rev=None,
229
if 'evil' in debug.debug_flags:
230
mutter_callsite(4, "_lefthand_history scales with history.")
231
# stop_revision must be a descendant of last_revision
232
graph = self.repository.get_graph()
233
if last_rev is not None:
234
if not graph.is_ancestor(last_rev, revision_id):
235
# our previous tip is not merged into stop_revision
236
raise errors.DivergedBranches(self, other_branch)
237
# make a new revision history from the graph
238
parents_map = graph.get_parent_map([revision_id])
239
if revision_id not in parents_map:
240
raise errors.NoSuchRevision(self, revision_id)
241
current_rev_id = revision_id
243
check_not_reserved_id = _mod_revision.check_not_reserved_id
244
# Do not include ghosts or graph origin in revision_history
245
while (current_rev_id in parents_map and
246
len(parents_map[current_rev_id]) > 0):
247
check_not_reserved_id(current_rev_id)
248
new_history.append(current_rev_id)
249
current_rev_id = parents_map[current_rev_id][0]
250
parents_map = graph.get_parent_map([current_rev_id])
251
new_history.reverse()
254
def lock_write(self):
255
raise NotImplementedError(self.lock_write)
258
raise NotImplementedError(self.lock_read)
261
raise NotImplementedError(self.unlock)
263
def peek_lock_mode(self):
264
"""Return lock mode for the Branch: 'r', 'w' or None"""
265
raise NotImplementedError(self.peek_lock_mode)
267
def get_physical_lock_status(self):
268
raise NotImplementedError(self.get_physical_lock_status)
271
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
272
"""Return the revision_id for a dotted revno.
274
:param revno: a tuple like (1,) or (1,1,2)
275
:param _cache_reverse: a private parameter enabling storage
276
of the reverse mapping in a top level cache. (This should
277
only be done in selective circumstances as we want to
278
avoid having the mapping cached multiple times.)
279
:return: the revision_id
280
:raises errors.NoSuchRevision: if the revno doesn't exist
282
rev_id = self._do_dotted_revno_to_revision_id(revno)
284
self._partial_revision_id_to_revno_cache[rev_id] = revno
287
def _do_dotted_revno_to_revision_id(self, revno):
288
"""Worker function for dotted_revno_to_revision_id.
290
Subclasses should override this if they wish to
291
provide a more efficient implementation.
294
return self.get_rev_id(revno[0])
295
revision_id_to_revno = self.get_revision_id_to_revno_map()
296
revision_ids = [revision_id for revision_id, this_revno
297
in revision_id_to_revno.iteritems()
298
if revno == this_revno]
299
if len(revision_ids) == 1:
300
return revision_ids[0]
302
revno_str = '.'.join(map(str, revno))
303
raise errors.NoSuchRevision(self, revno_str)
306
def revision_id_to_dotted_revno(self, revision_id):
307
"""Given a revision id, return its dotted revno.
309
:return: a tuple like (1,) or (400,1,3).
311
return self._do_revision_id_to_dotted_revno(revision_id)
313
def _do_revision_id_to_dotted_revno(self, revision_id):
314
"""Worker function for revision_id_to_revno."""
315
# Try the caches if they are loaded
316
result = self._partial_revision_id_to_revno_cache.get(revision_id)
317
if result is not None:
319
if self._revision_id_to_revno_cache:
320
result = self._revision_id_to_revno_cache.get(revision_id)
322
raise errors.NoSuchRevision(self, revision_id)
323
# Try the mainline as it's optimised
325
revno = self.revision_id_to_revno(revision_id)
327
except errors.NoSuchRevision:
328
# We need to load and use the full revno map after all
329
result = self.get_revision_id_to_revno_map().get(revision_id)
331
raise errors.NoSuchRevision(self, revision_id)
335
def get_revision_id_to_revno_map(self):
336
"""Return the revision_id => dotted revno map.
338
This will be regenerated on demand, but will be cached.
340
:return: A dictionary mapping revision_id => dotted revno.
341
This dictionary should not be modified by the caller.
343
if self._revision_id_to_revno_cache is not None:
344
mapping = self._revision_id_to_revno_cache
346
mapping = self._gen_revno_map()
347
self._cache_revision_id_to_revno(mapping)
348
# TODO: jam 20070417 Since this is being cached, should we be returning
350
# I would rather not, and instead just declare that users should not
351
# modify the return value.
354
def _gen_revno_map(self):
355
"""Create a new mapping from revision ids to dotted revnos.
357
Dotted revnos are generated based on the current tip in the revision
359
This is the worker function for get_revision_id_to_revno_map, which
360
just caches the return value.
362
:return: A dictionary mapping revision_id => dotted revno.
364
revision_id_to_revno = dict((rev_id, revno)
365
for rev_id, depth, revno, end_of_merge
366
in self.iter_merge_sorted_revisions())
367
return revision_id_to_revno
370
def iter_merge_sorted_revisions(self, start_revision_id=None,
371
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
372
"""Walk the revisions for a branch in merge sorted order.
374
Merge sorted order is the output from a merge-aware,
375
topological sort, i.e. all parents come before their
376
children going forward; the opposite for reverse.
378
:param start_revision_id: the revision_id to begin walking from.
379
If None, the branch tip is used.
380
:param stop_revision_id: the revision_id to terminate the walk
381
after. If None, the rest of history is included.
382
:param stop_rule: if stop_revision_id is not None, the precise rule
383
to use for termination:
384
* 'exclude' - leave the stop revision out of the result (default)
385
* 'include' - the stop revision is the last item in the result
386
* 'with-merges' - include the stop revision and all of its
387
merged revisions in the result
388
:param direction: either 'reverse' or 'forward':
389
* reverse means return the start_revision_id first, i.e.
390
start at the most recent revision and go backwards in history
391
* forward returns tuples in the opposite order to reverse.
392
Note in particular that forward does *not* do any intelligent
393
ordering w.r.t. depth as some clients of this API may like.
394
(If required, that ought to be done at higher layers.)
396
:return: an iterator over (revision_id, depth, revno, end_of_merge)
399
* revision_id: the unique id of the revision
400
* depth: How many levels of merging deep this node has been
402
* revno_sequence: This field provides a sequence of
403
revision numbers for all revisions. The format is:
404
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
405
branch that the revno is on. From left to right the REVNO numbers
406
are the sequence numbers within that branch of the revision.
407
* end_of_merge: When True the next node (earlier in history) is
408
part of a different merge.
410
# Note: depth and revno values are in the context of the branch so
411
# we need the full graph to get stable numbers, regardless of the
413
if self._merge_sorted_revisions_cache is None:
414
last_revision = self.last_revision()
415
graph = self.repository.get_graph()
416
parent_map = dict(((key, value) for key, value in
417
graph.iter_ancestry([last_revision]) if value is not None))
418
revision_graph = repository._strip_NULL_ghosts(parent_map)
419
revs = tsort.merge_sort(revision_graph, last_revision, None,
421
# Drop the sequence # before caching
422
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
424
filtered = self._filter_merge_sorted_revisions(
425
self._merge_sorted_revisions_cache, start_revision_id,
426
stop_revision_id, stop_rule)
427
if direction == 'reverse':
429
if direction == 'forward':
430
return reversed(list(filtered))
432
raise ValueError('invalid direction %r' % direction)
434
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
435
start_revision_id, stop_revision_id, stop_rule):
436
"""Iterate over an inclusive range of sorted revisions."""
437
rev_iter = iter(merge_sorted_revisions)
438
if start_revision_id is not None:
439
for rev_id, depth, revno, end_of_merge in rev_iter:
440
if rev_id != start_revision_id:
443
# The decision to include the start or not
444
# depends on the stop_rule if a stop is provided
446
iter([(rev_id, depth, revno, end_of_merge)]),
449
if stop_revision_id is None:
450
for rev_id, depth, revno, end_of_merge in rev_iter:
451
yield rev_id, depth, revno, end_of_merge
452
elif stop_rule == 'exclude':
453
for rev_id, depth, revno, end_of_merge in rev_iter:
454
if rev_id == stop_revision_id:
456
yield rev_id, depth, revno, end_of_merge
457
elif stop_rule == 'include':
458
for rev_id, depth, revno, end_of_merge in rev_iter:
459
yield rev_id, depth, revno, end_of_merge
460
if rev_id == stop_revision_id:
462
elif stop_rule == 'with-merges':
463
stop_rev = self.repository.get_revision(stop_revision_id)
464
if stop_rev.parent_ids:
465
left_parent = stop_rev.parent_ids[0]
467
left_parent = _mod_revision.NULL_REVISION
468
for rev_id, depth, revno, end_of_merge in rev_iter:
469
if rev_id == left_parent:
471
yield rev_id, depth, revno, end_of_merge
473
raise ValueError('invalid stop_rule %r' % stop_rule)
475
def leave_lock_in_place(self):
476
"""Tell this branch object not to release the physical lock when this
479
If lock_write doesn't return a token, then this method is not supported.
481
self.control_files.leave_in_place()
483
def dont_leave_lock_in_place(self):
484
"""Tell this branch object to release the physical lock when this
485
object is unlocked, even if it didn't originally acquire it.
487
If lock_write doesn't return a token, then this method is not supported.
489
self.control_files.dont_leave_in_place()
491
def bind(self, other):
492
"""Bind the local branch the other branch.
494
:param other: The branch to bind to
497
raise errors.UpgradeRequired(self.base)
500
def fetch(self, from_branch, last_revision=None, pb=None):
501
"""Copy revisions from from_branch into this branch.
503
:param from_branch: Where to copy from.
504
:param last_revision: What revision to stop at (None for at the end
506
:param pb: An optional progress bar to use.
509
if self.base == from_branch.base:
512
symbol_versioning.warn(
513
symbol_versioning.deprecated_in((1, 14, 0))
514
% "pb parameter to fetch()")
515
from_branch.lock_read()
517
if last_revision is None:
518
last_revision = from_branch.last_revision()
519
last_revision = _mod_revision.ensure_null(last_revision)
520
return self.repository.fetch(from_branch.repository,
521
revision_id=last_revision,
526
def get_bound_location(self):
527
"""Return the URL of the branch we are bound to.
529
Older format branches cannot bind, please be sure to use a metadir
534
def get_old_bound_location(self):
535
"""Return the URL of the branch we used to be bound to
537
raise errors.UpgradeRequired(self.base)
539
def get_commit_builder(self, parents, config=None, timestamp=None,
540
timezone=None, committer=None, revprops=None,
542
"""Obtain a CommitBuilder for this branch.
544
:param parents: Revision ids of the parents of the new revision.
545
:param config: Optional configuration to use.
546
:param timestamp: Optional timestamp recorded for commit.
547
:param timezone: Optional timezone for timestamp.
548
:param committer: Optional committer to set for commit.
549
:param revprops: Optional dictionary of revision properties.
550
:param revision_id: Optional revision id.
554
config = self.get_config()
556
return self.repository.get_commit_builder(self, parents, config,
557
timestamp, timezone, committer, revprops, revision_id)
559
def get_master_branch(self, possible_transports=None):
560
"""Return the branch we are bound to.
562
:return: Either a Branch, or None
566
def get_revision_delta(self, revno):
567
"""Return the delta for one revision.
569
The delta is relative to its mainline predecessor, or the
570
empty tree for revision 1.
572
rh = self.revision_history()
573
if not (1 <= revno <= len(rh)):
574
raise errors.InvalidRevisionNumber(revno)
575
return self.repository.get_revision_delta(rh[revno-1])
577
def get_stacked_on_url(self):
578
"""Get the URL this branch is stacked against.
580
:raises NotStacked: If the branch is not stacked.
581
:raises UnstackableBranchFormat: If the branch does not support
584
raise NotImplementedError(self.get_stacked_on_url)
586
def print_file(self, file, revision_id):
587
"""Print `file` to stdout."""
588
raise NotImplementedError(self.print_file)
590
def set_revision_history(self, rev_history):
591
raise NotImplementedError(self.set_revision_history)
593
def set_stacked_on_url(self, url):
594
"""Set the URL this branch is stacked against.
596
:raises UnstackableBranchFormat: If the branch does not support
598
:raises UnstackableRepositoryFormat: If the repository does not support
601
if not self._format.supports_stacking():
602
raise errors.UnstackableBranchFormat(self._format, self.base)
603
self._check_stackable_repo()
606
old_url = self.get_stacked_on_url()
607
except (errors.NotStacked, errors.UnstackableBranchFormat,
608
errors.UnstackableRepositoryFormat):
611
# repositories don't offer an interface to remove fallback
612
# repositories today; take the conceptually simpler option and just
614
self.repository = self.bzrdir.find_repository()
615
# for every revision reference the branch has, ensure it is pulled
617
source_repository = self._get_fallback_repository(old_url)
618
for revision_id in chain([self.last_revision()],
619
self.tags.get_reverse_tag_dict()):
620
self.repository.fetch(source_repository, revision_id,
623
self._activate_fallback_location(url)
624
# write this out after the repository is stacked to avoid setting a
625
# stacked config that doesn't work.
626
self._set_config_location('stacked_on_location', url)
629
def _set_tags_bytes(self, bytes):
630
"""Mirror method for _get_tags_bytes.
632
:seealso: Branch._get_tags_bytes.
634
return _run_with_write_locked_target(self, self._transport.put_bytes,
637
def _cache_revision_history(self, rev_history):
638
"""Set the cached revision history to rev_history.
640
The revision_history method will use this cache to avoid regenerating
641
the revision history.
643
This API is semi-public; it only for use by subclasses, all other code
644
should consider it to be private.
646
self._revision_history_cache = rev_history
648
def _cache_revision_id_to_revno(self, revision_id_to_revno):
649
"""Set the cached revision_id => revno map to revision_id_to_revno.
651
This API is semi-public; it only for use by subclasses, all other code
652
should consider it to be private.
654
self._revision_id_to_revno_cache = revision_id_to_revno
656
def _clear_cached_state(self):
657
"""Clear any cached data on this branch, e.g. cached revision history.
659
This means the next call to revision_history will need to call
660
_gen_revision_history.
662
This API is semi-public; it only for use by subclasses, all other code
663
should consider it to be private.
665
self._revision_history_cache = None
666
self._revision_id_to_revno_cache = None
667
self._last_revision_info_cache = None
668
self._merge_sorted_revisions_cache = None
670
def _gen_revision_history(self):
671
"""Return sequence of revision hashes on to this branch.
673
Unlike revision_history, this method always regenerates or rereads the
674
revision history, i.e. it does not cache the result, so repeated calls
677
Concrete subclasses should override this instead of revision_history so
678
that subclasses do not need to deal with caching logic.
680
This API is semi-public; it only for use by subclasses, all other code
681
should consider it to be private.
683
raise NotImplementedError(self._gen_revision_history)
686
def revision_history(self):
687
"""Return sequence of revision ids on this branch.
689
This method will cache the revision history for as long as it is safe to
692
if 'evil' in debug.debug_flags:
693
mutter_callsite(3, "revision_history scales with history.")
694
if self._revision_history_cache is not None:
695
history = self._revision_history_cache
697
history = self._gen_revision_history()
698
self._cache_revision_history(history)
702
"""Return current revision number for this branch.
704
That is equivalent to the number of revisions committed to
707
return self.last_revision_info()[0]
710
"""Older format branches cannot bind or unbind."""
711
raise errors.UpgradeRequired(self.base)
713
def set_append_revisions_only(self, enabled):
714
"""Older format branches are never restricted to append-only"""
715
raise errors.UpgradeRequired(self.base)
717
def last_revision(self):
718
"""Return last revision id, or NULL_REVISION."""
719
return self.last_revision_info()[1]
722
def last_revision_info(self):
723
"""Return information about the last revision.
725
:return: A tuple (revno, revision_id).
727
if self._last_revision_info_cache is None:
728
self._last_revision_info_cache = self._last_revision_info()
729
return self._last_revision_info_cache
731
def _last_revision_info(self):
732
rh = self.revision_history()
735
return (revno, rh[-1])
737
return (0, _mod_revision.NULL_REVISION)
739
@deprecated_method(deprecated_in((1, 6, 0)))
740
def missing_revisions(self, other, stop_revision=None):
741
"""Return a list of new revisions that would perfectly fit.
743
If self and other have not diverged, return a list of the revisions
744
present in other, but missing from self.
746
self_history = self.revision_history()
747
self_len = len(self_history)
748
other_history = other.revision_history()
749
other_len = len(other_history)
750
common_index = min(self_len, other_len) -1
751
if common_index >= 0 and \
752
self_history[common_index] != other_history[common_index]:
753
raise errors.DivergedBranches(self, other)
755
if stop_revision is None:
756
stop_revision = other_len
758
if stop_revision > other_len:
759
raise errors.NoSuchRevision(self, stop_revision)
760
return other_history[self_len:stop_revision]
763
def update_revisions(self, other, stop_revision=None, overwrite=False,
765
"""Pull in new perfect-fit revisions.
767
:param other: Another Branch to pull from
768
:param stop_revision: Updated until the given revision
769
:param overwrite: Always set the branch pointer, rather than checking
770
to see if it is a proper descendant.
771
:param graph: A Graph object that can be used to query history
772
information. This can be None.
775
return InterBranch.get(other, self).update_revisions(stop_revision,
778
def import_last_revision_info(self, source_repo, revno, revid):
779
"""Set the last revision info, importing from another repo if necessary.
781
This is used by the bound branch code to upload a revision to
782
the master branch first before updating the tip of the local branch.
784
:param source_repo: Source repository to optionally fetch from
785
:param revno: Revision number of the new tip
786
:param revid: Revision id of the new tip
788
if not self.repository.has_same_location(source_repo):
789
self.repository.fetch(source_repo, revision_id=revid)
790
self.set_last_revision_info(revno, revid)
792
def revision_id_to_revno(self, revision_id):
793
"""Given a revision id, return its revno"""
794
if _mod_revision.is_null(revision_id):
796
history = self.revision_history()
798
return history.index(revision_id) + 1
800
raise errors.NoSuchRevision(self, revision_id)
802
def get_rev_id(self, revno, history=None):
803
"""Find the revision id of the specified revno."""
805
return _mod_revision.NULL_REVISION
807
history = self.revision_history()
808
if revno <= 0 or revno > len(history):
809
raise errors.NoSuchRevision(self, revno)
810
return history[revno - 1]
812
def pull(self, source, overwrite=False, stop_revision=None,
813
possible_transports=None, _override_hook_target=None):
814
"""Mirror source into this branch.
816
This branch is considered to be 'local', having low latency.
818
:returns: PullResult instance
820
raise NotImplementedError(self.pull)
822
def push(self, target, overwrite=False, stop_revision=None):
823
"""Mirror this branch into target.
825
This branch is considered to be 'local', having low latency.
827
raise NotImplementedError(self.push)
829
def basis_tree(self):
830
"""Return `Tree` object for last revision."""
831
return self.repository.revision_tree(self.last_revision())
833
def get_parent(self):
834
"""Return the parent location of the branch.
836
This is the default location for pull/missing. The usual
837
pattern is that the user can override it by specifying a
840
parent = self._get_parent_location()
843
# This is an old-format absolute path to a local branch
845
if parent.startswith('/'):
846
parent = urlutils.local_path_to_url(parent.decode('utf8'))
848
return urlutils.join(self.base[:-1], parent)
849
except errors.InvalidURLJoin, e:
850
raise errors.InaccessibleParent(parent, self.base)
852
def _get_parent_location(self):
853
raise NotImplementedError(self._get_parent_location)
855
def _set_config_location(self, name, url, config=None,
856
make_relative=False):
858
config = self.get_config()
862
url = urlutils.relative_url(self.base, url)
863
config.set_user_option(name, url, warn_masked=True)
865
def _get_config_location(self, name, config=None):
867
config = self.get_config()
868
location = config.get_user_option(name)
873
def get_submit_branch(self):
874
"""Return the submit location of the branch.
876
This is the default location for bundle. The usual
877
pattern is that the user can override it by specifying a
880
return self.get_config().get_user_option('submit_branch')
882
def set_submit_branch(self, location):
883
"""Return the submit location of the branch.
885
This is the default location for bundle. The usual
886
pattern is that the user can override it by specifying a
889
self.get_config().set_user_option('submit_branch', location,
892
def get_public_branch(self):
893
"""Return the public location of the branch.
895
This is used by merge directives.
897
return self._get_config_location('public_branch')
899
def set_public_branch(self, location):
900
"""Return the submit location of the branch.
902
This is the default location for bundle. The usual
903
pattern is that the user can override it by specifying a
906
self._set_config_location('public_branch', location)
908
def get_push_location(self):
909
"""Return the None or the location to push this branch to."""
910
push_loc = self.get_config().get_user_option('push_location')
913
def set_push_location(self, location):
914
"""Set a new push location for this branch."""
915
raise NotImplementedError(self.set_push_location)
917
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
918
"""Run the post_change_branch_tip hooks."""
919
hooks = Branch.hooks['post_change_branch_tip']
922
new_revno, new_revid = self.last_revision_info()
923
params = ChangeBranchTipParams(
924
self, old_revno, new_revno, old_revid, new_revid)
928
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
929
"""Run the pre_change_branch_tip hooks."""
930
hooks = Branch.hooks['pre_change_branch_tip']
933
old_revno, old_revid = self.last_revision_info()
934
params = ChangeBranchTipParams(
935
self, old_revno, new_revno, old_revid, new_revid)
939
except errors.TipChangeRejected:
942
exc_info = sys.exc_info()
943
hook_name = Branch.hooks.get_hook_name(hook)
944
raise errors.HookFailed(
945
'pre_change_branch_tip', hook_name, exc_info)
947
def set_parent(self, url):
948
raise NotImplementedError(self.set_parent)
952
"""Synchronise this branch with the master branch if any.
954
:return: None or the last_revision pivoted out during the update.
958
def check_revno(self, revno):
960
Check whether a revno corresponds to any revision.
961
Zero (the NULL revision) is considered valid.
964
self.check_real_revno(revno)
966
def check_real_revno(self, revno):
968
Check whether a revno corresponds to a real revision.
969
Zero (the NULL revision) is considered invalid
971
if revno < 1 or revno > self.revno():
972
raise errors.InvalidRevisionNumber(revno)
975
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
976
"""Clone this branch into to_bzrdir preserving all semantic values.
978
Most API users will want 'create_clone_on_transport', which creates a
979
new bzrdir and branch on the fly.
981
revision_id: if not None, the revision history in the new branch will
982
be truncated to end with revision_id.
984
result = to_bzrdir.create_branch()
985
if repository_policy is not None:
986
repository_policy.configure_branch(result)
987
self.copy_content_into(result, revision_id=revision_id)
991
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
992
"""Create a new line of development from the branch, into to_bzrdir.
994
to_bzrdir controls the branch format.
996
revision_id: if not None, the revision history in the new branch will
997
be truncated to end with revision_id.
999
result = to_bzrdir.create_branch()
1000
if repository_policy is not None:
1001
repository_policy.configure_branch(result)
1002
self.copy_content_into(result, revision_id=revision_id)
1003
result.set_parent(self.bzrdir.root_transport.base)
1006
def _synchronize_history(self, destination, revision_id):
1007
"""Synchronize last revision and revision history between branches.
1009
This version is most efficient when the destination is also a
1010
BzrBranch6, but works for BzrBranch5, as long as the destination's
1011
repository contains all the lefthand ancestors of the intended
1012
last_revision. If not, set_last_revision_info will fail.
1014
:param destination: The branch to copy the history into
1015
:param revision_id: The revision-id to truncate history at. May
1016
be None to copy complete history.
1018
source_revno, source_revision_id = self.last_revision_info()
1019
if revision_id is None:
1020
revno, revision_id = source_revno, source_revision_id
1021
elif source_revision_id == revision_id:
1022
# we know the revno without needing to walk all of history
1023
revno = source_revno
1025
# To figure out the revno for a random revision, we need to build
1026
# the revision history, and count its length.
1027
# We don't care about the order, just how long it is.
1029
revno = len(list(self.repository.iter_reverse_revision_history(
1031
except errors.RevisionNotPresent:
1032
# One of the left hand side ancestors is a ghost
1033
# we could start at the current location, and count
1034
# backwards. But there is no guarantee that we will find the
1035
# revno since we may be looking at a merged revision id
1037
# Default to 1, if we can't find anything else
1039
for distance, revid in enumerate(
1040
self.repository.iter_reverse_revision_history(
1041
source_revision_id)):
1042
if revid == revision_id:
1043
revno = source_revno - distance
1047
destination.set_last_revision_info(revno, revision_id)
1050
def copy_content_into(self, destination, revision_id=None):
1051
"""Copy the content of self into destination.
1053
revision_id: if not None, the revision history in the new branch will
1054
be truncated to end with revision_id.
1056
self._synchronize_history(destination, revision_id)
1058
parent = self.get_parent()
1059
except errors.InaccessibleParent, e:
1060
mutter('parent was not accessible to copy: %s', e)
1063
destination.set_parent(parent)
1064
if self._push_should_merge_tags():
1065
self.tags.merge_to(destination.tags)
1069
"""Check consistency of the branch.
1071
In particular this checks that revisions given in the revision-history
1072
do actually match up in the revision graph, and that they're all
1073
present in the repository.
1075
Callers will typically also want to check the repository.
1077
:return: A BranchCheckResult.
1079
mainline_parent_id = None
1080
last_revno, last_revision_id = self.last_revision_info()
1081
real_rev_history = list(self.repository.iter_reverse_revision_history(
1083
real_rev_history.reverse()
1084
if len(real_rev_history) != last_revno:
1085
raise errors.BzrCheckError('revno does not match len(mainline)'
1086
' %s != %s' % (last_revno, len(real_rev_history)))
1087
# TODO: We should probably also check that real_rev_history actually
1088
# matches self.revision_history()
1089
for revision_id in real_rev_history:
1091
revision = self.repository.get_revision(revision_id)
1092
except errors.NoSuchRevision, e:
1093
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1095
# In general the first entry on the revision history has no parents.
1096
# But it's not illegal for it to have parents listed; this can happen
1097
# in imports from Arch when the parents weren't reachable.
1098
if mainline_parent_id is not None:
1099
if mainline_parent_id not in revision.parent_ids:
1100
raise errors.BzrCheckError("previous revision {%s} not listed among "
1102
% (mainline_parent_id, revision_id))
1103
mainline_parent_id = revision_id
1104
return BranchCheckResult(self)
1106
def _get_checkout_format(self):
1107
"""Return the most suitable metadir for a checkout of this branch.
1108
Weaves are used if this branch's repository uses weaves.
1110
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1111
from bzrlib.repofmt import weaverepo
1112
format = bzrdir.BzrDirMetaFormat1()
1113
format.repository_format = weaverepo.RepositoryFormat7()
1115
format = self.repository.bzrdir.checkout_metadir()
1116
format.set_branch_format(self._format)
1119
def create_clone_on_transport(self, to_transport, revision_id=None,
1121
"""Create a clone of this branch and its bzrdir.
1123
:param to_transport: The transport to clone onto.
1124
:param revision_id: The revision id to use as tip in the new branch.
1125
If None the tip is obtained from this branch.
1126
:param stacked_on: An optional URL to stack the clone on.
1128
# XXX: Fix the bzrdir API to allow getting the branch back from the
1129
# clone call. Or something. 20090224 RBC/spiv.
1130
dir_to = self.bzrdir.clone_on_transport(to_transport,
1131
revision_id=revision_id, stacked_on=stacked_on)
1132
return dir_to.open_branch()
1134
def create_checkout(self, to_location, revision_id=None,
1135
lightweight=False, accelerator_tree=None,
1137
"""Create a checkout of a branch.
1139
:param to_location: The url to produce the checkout at
1140
:param revision_id: The revision to check out
1141
:param lightweight: If True, produce a lightweight checkout, otherwise,
1142
produce a bound branch (heavyweight checkout)
1143
:param accelerator_tree: A tree which can be used for retrieving file
1144
contents more quickly than the revision tree, i.e. a workingtree.
1145
The revision tree will be used for cases where accelerator_tree's
1146
content is different.
1147
:param hardlink: If true, hard-link files from accelerator_tree,
1149
:return: The tree of the created checkout
1151
t = transport.get_transport(to_location)
1154
format = self._get_checkout_format()
1155
checkout = format.initialize_on_transport(t)
1156
from_branch = BranchReferenceFormat().initialize(checkout, self)
1158
format = self._get_checkout_format()
1159
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1160
to_location, force_new_tree=False, format=format)
1161
checkout = checkout_branch.bzrdir
1162
checkout_branch.bind(self)
1163
# pull up to the specified revision_id to set the initial
1164
# branch tip correctly, and seed it with history.
1165
checkout_branch.pull(self, stop_revision=revision_id)
1167
tree = checkout.create_workingtree(revision_id,
1168
from_branch=from_branch,
1169
accelerator_tree=accelerator_tree,
1171
basis_tree = tree.basis_tree()
1172
basis_tree.lock_read()
1174
for path, file_id in basis_tree.iter_references():
1175
reference_parent = self.reference_parent(file_id, path)
1176
reference_parent.create_checkout(tree.abspath(path),
1177
basis_tree.get_reference_revision(file_id, path),
1184
def reconcile(self, thorough=True):
1185
"""Make sure the data stored in this branch is consistent."""
1186
from bzrlib.reconcile import BranchReconciler
1187
reconciler = BranchReconciler(self, thorough=thorough)
1188
reconciler.reconcile()
1191
def reference_parent(self, file_id, path):
1192
"""Return the parent branch for a tree-reference file_id
1193
:param file_id: The file_id of the tree reference
1194
:param path: The path of the file_id in the tree
1195
:return: A branch associated with the file_id
1197
# FIXME should provide multiple branches, based on config
1198
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1200
def supports_tags(self):
1201
return self._format.supports_tags()
1203
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1205
"""Ensure that revision_b is a descendant of revision_a.
1207
This is a helper function for update_revisions.
1209
:raises: DivergedBranches if revision_b has diverged from revision_a.
1210
:returns: True if revision_b is a descendant of revision_a.
1212
relation = self._revision_relations(revision_a, revision_b, graph)
1213
if relation == 'b_descends_from_a':
1215
elif relation == 'diverged':
1216
raise errors.DivergedBranches(self, other_branch)
1217
elif relation == 'a_descends_from_b':
1220
raise AssertionError("invalid relation: %r" % (relation,))
1222
def _revision_relations(self, revision_a, revision_b, graph):
1223
"""Determine the relationship between two revisions.
1225
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1227
heads = graph.heads([revision_a, revision_b])
1228
if heads == set([revision_b]):
1229
return 'b_descends_from_a'
1230
elif heads == set([revision_a, revision_b]):
1231
# These branches have diverged
1233
elif heads == set([revision_a]):
1234
return 'a_descends_from_b'
1236
raise AssertionError("invalid heads: %r" % (heads,))
1239
class BranchFormat(object):
1240
"""An encapsulation of the initialization and open routines for a format.
1242
Formats provide three things:
1243
* An initialization routine,
1247
Formats are placed in an dict by their format string for reference
1248
during branch opening. Its not required that these be instances, they
1249
can be classes themselves with class methods - it simply depends on
1250
whether state is needed for a given format or not.
1252
Once a format is deprecated, just deprecate the initialize and open
1253
methods on the format class. Do not deprecate the object, as the
1254
object will be created every time regardless.
1257
_default_format = None
1258
"""The default format used for new branches."""
1261
"""The known formats."""
1263
def __eq__(self, other):
1264
return self.__class__ is other.__class__
1266
def __ne__(self, other):
1267
return not (self == other)
1270
def find_format(klass, a_bzrdir):
1271
"""Return the format for the branch object in a_bzrdir."""
1273
transport = a_bzrdir.get_branch_transport(None)
1274
format_string = transport.get("format").read()
1275
return klass._formats[format_string]
1276
except errors.NoSuchFile:
1277
raise errors.NotBranchError(path=transport.base)
1279
raise errors.UnknownFormatError(format=format_string, kind='branch')
1282
def get_default_format(klass):
1283
"""Return the current default format."""
1284
return klass._default_format
1286
def get_reference(self, a_bzrdir):
1287
"""Get the target reference of the branch in a_bzrdir.
1289
format probing must have been completed before calling
1290
this method - it is assumed that the format of the branch
1291
in a_bzrdir is correct.
1293
:param a_bzrdir: The bzrdir to get the branch data from.
1294
:return: None if the branch is not a reference branch.
1299
def set_reference(self, a_bzrdir, to_branch):
1300
"""Set the target reference of the branch in a_bzrdir.
1302
format probing must have been completed before calling
1303
this method - it is assumed that the format of the branch
1304
in a_bzrdir is correct.
1306
:param a_bzrdir: The bzrdir to set the branch reference for.
1307
:param to_branch: branch that the checkout is to reference
1309
raise NotImplementedError(self.set_reference)
1311
def get_format_string(self):
1312
"""Return the ASCII format string that identifies this format."""
1313
raise NotImplementedError(self.get_format_string)
1315
def get_format_description(self):
1316
"""Return the short format description for this format."""
1317
raise NotImplementedError(self.get_format_description)
1319
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1321
"""Initialize a branch in a bzrdir, with specified files
1323
:param a_bzrdir: The bzrdir to initialize the branch in
1324
:param utf8_files: The files to create as a list of
1325
(filename, content) tuples
1326
:param set_format: If True, set the format with
1327
self.get_format_string. (BzrBranch4 has its format set
1329
:return: a branch in this format
1331
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1332
branch_transport = a_bzrdir.get_branch_transport(self)
1334
'metadir': ('lock', lockdir.LockDir),
1335
'branch4': ('branch-lock', lockable_files.TransportLock),
1337
lock_name, lock_class = lock_map[lock_type]
1338
control_files = lockable_files.LockableFiles(branch_transport,
1339
lock_name, lock_class)
1340
control_files.create_lock()
1341
control_files.lock_write()
1343
utf8_files += [('format', self.get_format_string())]
1345
for (filename, content) in utf8_files:
1346
branch_transport.put_bytes(
1348
mode=a_bzrdir._get_file_mode())
1350
control_files.unlock()
1351
return self.open(a_bzrdir, _found=True)
1353
def initialize(self, a_bzrdir):
1354
"""Create a branch of this format in a_bzrdir."""
1355
raise NotImplementedError(self.initialize)
1357
def is_supported(self):
1358
"""Is this format supported?
1360
Supported formats can be initialized and opened.
1361
Unsupported formats may not support initialization or committing or
1362
some other features depending on the reason for not being supported.
1366
def make_tags(self, branch):
1367
"""Create a tags object for branch.
1369
This method is on BranchFormat, because BranchFormats are reflected
1370
over the wire via network_name(), whereas full Branch instances require
1371
multiple VFS method calls to operate at all.
1373
The default implementation returns a disabled-tags instance.
1375
Note that it is normal for branch to be a RemoteBranch when using tags
1378
return DisabledTags(branch)
1380
def network_name(self):
1381
"""A simple byte string uniquely identifying this format for RPC calls.
1383
MetaDir branch formats use their disk format string to identify the
1384
repository over the wire. All in one formats such as bzr < 0.8, and
1385
foreign formats like svn/git and hg should use some marker which is
1386
unique and immutable.
1388
raise NotImplementedError(self.network_name)
1390
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1391
"""Return the branch object for a_bzrdir
1393
:param a_bzrdir: A BzrDir that contains a branch.
1394
:param _found: a private parameter, do not use it. It is used to
1395
indicate if format probing has already be done.
1396
:param ignore_fallbacks: when set, no fallback branches will be opened
1397
(if there are any). Default is to open fallbacks.
1399
raise NotImplementedError(self.open)
1402
def register_format(klass, format):
1403
"""Register a metadir format."""
1404
klass._formats[format.get_format_string()] = format
1405
# Metadir formats have a network name of their format string, and get
1406
# registered as class factories.
1407
network_format_registry.register(format.get_format_string(), format.__class__)
1410
def set_default_format(klass, format):
1411
klass._default_format = format
1413
def supports_stacking(self):
1414
"""True if this format records a stacked-on branch."""
1418
def unregister_format(klass, format):
1419
del klass._formats[format.get_format_string()]
1422
return self.get_format_description().rstrip()
1424
def supports_tags(self):
1425
"""True if this format supports tags stored in the branch"""
1426
return False # by default
1429
class BranchHooks(Hooks):
1430
"""A dictionary mapping hook name to a list of callables for branch hooks.
1432
e.g. ['set_rh'] Is the list of items to be called when the
1433
set_revision_history function is invoked.
1437
"""Create the default hooks.
1439
These are all empty initially, because by default nothing should get
1442
Hooks.__init__(self)
1443
self.create_hook(HookPoint('set_rh',
1444
"Invoked whenever the revision history has been set via "
1445
"set_revision_history. The api signature is (branch, "
1446
"revision_history), and the branch will be write-locked. "
1447
"The set_rh hook can be expensive for bzr to trigger, a better "
1448
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1449
self.create_hook(HookPoint('open',
1450
"Called with the Branch object that has been opened after a "
1451
"branch is opened.", (1, 8), None))
1452
self.create_hook(HookPoint('post_push',
1453
"Called after a push operation completes. post_push is called "
1454
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1455
"bzr client.", (0, 15), None))
1456
self.create_hook(HookPoint('post_pull',
1457
"Called after a pull operation completes. post_pull is called "
1458
"with a bzrlib.branch.PullResult object and only runs in the "
1459
"bzr client.", (0, 15), None))
1460
self.create_hook(HookPoint('pre_commit',
1461
"Called after a commit is calculated but before it is is "
1462
"completed. pre_commit is called with (local, master, old_revno, "
1463
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1464
"). old_revid is NULL_REVISION for the first commit to a branch, "
1465
"tree_delta is a TreeDelta object describing changes from the "
1466
"basis revision. hooks MUST NOT modify this delta. "
1467
" future_tree is an in-memory tree obtained from "
1468
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1469
"tree.", (0,91), None))
1470
self.create_hook(HookPoint('post_commit',
1471
"Called in the bzr client after a commit has completed. "
1472
"post_commit is called with (local, master, old_revno, old_revid, "
1473
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1474
"commit to a branch.", (0, 15), None))
1475
self.create_hook(HookPoint('post_uncommit',
1476
"Called in the bzr client after an uncommit completes. "
1477
"post_uncommit is called with (local, master, old_revno, "
1478
"old_revid, new_revno, new_revid) where local is the local branch "
1479
"or None, master is the target branch, and an empty branch "
1480
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1481
self.create_hook(HookPoint('pre_change_branch_tip',
1482
"Called in bzr client and server before a change to the tip of a "
1483
"branch is made. pre_change_branch_tip is called with a "
1484
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1485
"commit, uncommit will all trigger this hook.", (1, 6), None))
1486
self.create_hook(HookPoint('post_change_branch_tip',
1487
"Called in bzr client and server after a change to the tip of a "
1488
"branch is made. post_change_branch_tip is called with a "
1489
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1490
"commit, uncommit will all trigger this hook.", (1, 4), None))
1491
self.create_hook(HookPoint('transform_fallback_location',
1492
"Called when a stacked branch is activating its fallback "
1493
"locations. transform_fallback_location is called with (branch, "
1494
"url), and should return a new url. Returning the same url "
1495
"allows it to be used as-is, returning a different one can be "
1496
"used to cause the branch to stack on a closer copy of that "
1497
"fallback_location. Note that the branch cannot have history "
1498
"accessing methods called on it during this hook because the "
1499
"fallback locations have not been activated. When there are "
1500
"multiple hooks installed for transform_fallback_location, "
1501
"all are called with the url returned from the previous hook."
1502
"The order is however undefined.", (1, 9), None))
1505
# install the default hooks into the Branch class.
1506
Branch.hooks = BranchHooks()
1509
class ChangeBranchTipParams(object):
1510
"""Object holding parameters passed to *_change_branch_tip hooks.
1512
There are 5 fields that hooks may wish to access:
1514
:ivar branch: the branch being changed
1515
:ivar old_revno: revision number before the change
1516
:ivar new_revno: revision number after the change
1517
:ivar old_revid: revision id before the change
1518
:ivar new_revid: revision id after the change
1520
The revid fields are strings. The revno fields are integers.
1523
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1524
"""Create a group of ChangeBranchTip parameters.
1526
:param branch: The branch being changed.
1527
:param old_revno: Revision number before the change.
1528
:param new_revno: Revision number after the change.
1529
:param old_revid: Tip revision id before the change.
1530
:param new_revid: Tip revision id after the change.
1532
self.branch = branch
1533
self.old_revno = old_revno
1534
self.new_revno = new_revno
1535
self.old_revid = old_revid
1536
self.new_revid = new_revid
1538
def __eq__(self, other):
1539
return self.__dict__ == other.__dict__
1542
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1543
self.__class__.__name__, self.branch,
1544
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1547
class BzrBranchFormat4(BranchFormat):
1548
"""Bzr branch format 4.
1551
- a revision-history file.
1552
- a branch-lock lock file [ to be shared with the bzrdir ]
1555
def get_format_description(self):
1556
"""See BranchFormat.get_format_description()."""
1557
return "Branch format 4"
1559
def initialize(self, a_bzrdir):
1560
"""Create a branch of this format in a_bzrdir."""
1561
utf8_files = [('revision-history', ''),
1562
('branch-name', ''),
1564
return self._initialize_helper(a_bzrdir, utf8_files,
1565
lock_type='branch4', set_format=False)
1568
super(BzrBranchFormat4, self).__init__()
1569
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1571
def network_name(self):
1572
"""The network name for this format is the control dirs disk label."""
1573
return self._matchingbzrdir.get_format_string()
1575
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1576
"""See BranchFormat.open()."""
1578
# we are being called directly and must probe.
1579
raise NotImplementedError
1580
return BzrBranch(_format=self,
1581
_control_files=a_bzrdir._control_files,
1583
_repository=a_bzrdir.open_repository())
1586
return "Bazaar-NG branch format 4"
1589
class BranchFormatMetadir(BranchFormat):
1590
"""Common logic for meta-dir based branch formats."""
1592
def _branch_class(self):
1593
"""What class to instantiate on open calls."""
1594
raise NotImplementedError(self._branch_class)
1596
def network_name(self):
1597
"""A simple byte string uniquely identifying this format for RPC calls.
1599
Metadir branch formats use their format string.
1601
return self.get_format_string()
1603
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1604
"""See BranchFormat.open()."""
1606
format = BranchFormat.find_format(a_bzrdir)
1607
if format.__class__ != self.__class__:
1608
raise AssertionError("wrong format %r found for %r" %
1611
transport = a_bzrdir.get_branch_transport(None)
1612
control_files = lockable_files.LockableFiles(transport, 'lock',
1614
return self._branch_class()(_format=self,
1615
_control_files=control_files,
1617
_repository=a_bzrdir.find_repository(),
1618
ignore_fallbacks=ignore_fallbacks)
1619
except errors.NoSuchFile:
1620
raise errors.NotBranchError(path=transport.base)
1623
super(BranchFormatMetadir, self).__init__()
1624
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1625
self._matchingbzrdir.set_branch_format(self)
1627
def supports_tags(self):
1631
class BzrBranchFormat5(BranchFormatMetadir):
1632
"""Bzr branch format 5.
1635
- a revision-history file.
1637
- a lock dir guarding the branch itself
1638
- all of this stored in a branch/ subdirectory
1639
- works with shared repositories.
1641
This format is new in bzr 0.8.
1644
def _branch_class(self):
1647
def get_format_string(self):
1648
"""See BranchFormat.get_format_string()."""
1649
return "Bazaar-NG branch format 5\n"
1651
def get_format_description(self):
1652
"""See BranchFormat.get_format_description()."""
1653
return "Branch format 5"
1655
def initialize(self, a_bzrdir):
1656
"""Create a branch of this format in a_bzrdir."""
1657
utf8_files = [('revision-history', ''),
1658
('branch-name', ''),
1660
return self._initialize_helper(a_bzrdir, utf8_files)
1662
def supports_tags(self):
1666
class BzrBranchFormat6(BranchFormatMetadir):
1667
"""Branch format with last-revision and tags.
1669
Unlike previous formats, this has no explicit revision history. Instead,
1670
this just stores the last-revision, and the left-hand history leading
1671
up to there is the history.
1673
This format was introduced in bzr 0.15
1674
and became the default in 0.91.
1677
def _branch_class(self):
1680
def get_format_string(self):
1681
"""See BranchFormat.get_format_string()."""
1682
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1684
def get_format_description(self):
1685
"""See BranchFormat.get_format_description()."""
1686
return "Branch format 6"
1688
def initialize(self, a_bzrdir):
1689
"""Create a branch of this format in a_bzrdir."""
1690
utf8_files = [('last-revision', '0 null:\n'),
1691
('branch.conf', ''),
1694
return self._initialize_helper(a_bzrdir, utf8_files)
1696
def make_tags(self, branch):
1697
"""See bzrlib.branch.BranchFormat.make_tags()."""
1698
return BasicTags(branch)
1702
class BzrBranchFormat7(BranchFormatMetadir):
1703
"""Branch format with last-revision, tags, and a stacked location pointer.
1705
The stacked location pointer is passed down to the repository and requires
1706
a repository format with supports_external_lookups = True.
1708
This format was introduced in bzr 1.6.
1711
def _branch_class(self):
1714
def get_format_string(self):
1715
"""See BranchFormat.get_format_string()."""
1716
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1718
def get_format_description(self):
1719
"""See BranchFormat.get_format_description()."""
1720
return "Branch format 7"
1722
def initialize(self, a_bzrdir):
1723
"""Create a branch of this format in a_bzrdir."""
1724
utf8_files = [('last-revision', '0 null:\n'),
1725
('branch.conf', ''),
1728
return self._initialize_helper(a_bzrdir, utf8_files)
1731
super(BzrBranchFormat7, self).__init__()
1732
self._matchingbzrdir.repository_format = \
1733
RepositoryFormatKnitPack5RichRoot()
1735
def make_tags(self, branch):
1736
"""See bzrlib.branch.BranchFormat.make_tags()."""
1737
return BasicTags(branch)
1739
def supports_stacking(self):
1743
class BranchReferenceFormat(BranchFormat):
1744
"""Bzr branch reference format.
1746
Branch references are used in implementing checkouts, they
1747
act as an alias to the real branch which is at some other url.
1754
def get_format_string(self):
1755
"""See BranchFormat.get_format_string()."""
1756
return "Bazaar-NG Branch Reference Format 1\n"
1758
def get_format_description(self):
1759
"""See BranchFormat.get_format_description()."""
1760
return "Checkout reference format 1"
1762
def get_reference(self, a_bzrdir):
1763
"""See BranchFormat.get_reference()."""
1764
transport = a_bzrdir.get_branch_transport(None)
1765
return transport.get('location').read()
1767
def set_reference(self, a_bzrdir, to_branch):
1768
"""See BranchFormat.set_reference()."""
1769
transport = a_bzrdir.get_branch_transport(None)
1770
location = transport.put_bytes('location', to_branch.base)
1772
def initialize(self, a_bzrdir, target_branch=None):
1773
"""Create a branch of this format in a_bzrdir."""
1774
if target_branch is None:
1775
# this format does not implement branch itself, thus the implicit
1776
# creation contract must see it as uninitializable
1777
raise errors.UninitializableFormat(self)
1778
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1779
branch_transport = a_bzrdir.get_branch_transport(self)
1780
branch_transport.put_bytes('location',
1781
target_branch.bzrdir.root_transport.base)
1782
branch_transport.put_bytes('format', self.get_format_string())
1784
a_bzrdir, _found=True,
1785
possible_transports=[target_branch.bzrdir.root_transport])
1788
super(BranchReferenceFormat, self).__init__()
1789
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1790
self._matchingbzrdir.set_branch_format(self)
1792
def _make_reference_clone_function(format, a_branch):
1793
"""Create a clone() routine for a branch dynamically."""
1794
def clone(to_bzrdir, revision_id=None,
1795
repository_policy=None):
1796
"""See Branch.clone()."""
1797
return format.initialize(to_bzrdir, a_branch)
1798
# cannot obey revision_id limits when cloning a reference ...
1799
# FIXME RBC 20060210 either nuke revision_id for clone, or
1800
# emit some sort of warning/error to the caller ?!
1803
def open(self, a_bzrdir, _found=False, location=None,
1804
possible_transports=None, ignore_fallbacks=False):
1805
"""Return the branch that the branch reference in a_bzrdir points at.
1807
:param a_bzrdir: A BzrDir that contains a branch.
1808
:param _found: a private parameter, do not use it. It is used to
1809
indicate if format probing has already be done.
1810
:param ignore_fallbacks: when set, no fallback branches will be opened
1811
(if there are any). Default is to open fallbacks.
1812
:param location: The location of the referenced branch. If
1813
unspecified, this will be determined from the branch reference in
1815
:param possible_transports: An optional reusable transports list.
1818
format = BranchFormat.find_format(a_bzrdir)
1819
if format.__class__ != self.__class__:
1820
raise AssertionError("wrong format %r found for %r" %
1822
if location is None:
1823
location = self.get_reference(a_bzrdir)
1824
real_bzrdir = bzrdir.BzrDir.open(
1825
location, possible_transports=possible_transports)
1826
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1827
# this changes the behaviour of result.clone to create a new reference
1828
# rather than a copy of the content of the branch.
1829
# I did not use a proxy object because that needs much more extensive
1830
# testing, and we are only changing one behaviour at the moment.
1831
# If we decide to alter more behaviours - i.e. the implicit nickname
1832
# then this should be refactored to introduce a tested proxy branch
1833
# and a subclass of that for use in overriding clone() and ....
1835
result.clone = self._make_reference_clone_function(result)
1839
network_format_registry = registry.FormatRegistry()
1840
"""Registry of formats indexed by their network name.
1842
The network name for a branch format is an identifier that can be used when
1843
referring to formats with smart server operations. See
1844
BranchFormat.network_name() for more detail.
1848
# formats which have no format string are not discoverable
1849
# and not independently creatable, so are not registered.
1850
__format5 = BzrBranchFormat5()
1851
__format6 = BzrBranchFormat6()
1852
__format7 = BzrBranchFormat7()
1853
BranchFormat.register_format(__format5)
1854
BranchFormat.register_format(BranchReferenceFormat())
1855
BranchFormat.register_format(__format6)
1856
BranchFormat.register_format(__format7)
1857
BranchFormat.set_default_format(__format6)
1858
_legacy_formats = [BzrBranchFormat4(),
1860
network_format_registry.register(
1861
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1864
class BzrBranch(Branch):
1865
"""A branch stored in the actual filesystem.
1867
Note that it's "local" in the context of the filesystem; it doesn't
1868
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1869
it's writable, and can be accessed via the normal filesystem API.
1871
:ivar _transport: Transport for file operations on this branch's
1872
control files, typically pointing to the .bzr/branch directory.
1873
:ivar repository: Repository for this branch.
1874
:ivar base: The url of the base directory for this branch; the one
1875
containing the .bzr directory.
1878
def __init__(self, _format=None,
1879
_control_files=None, a_bzrdir=None, _repository=None,
1880
ignore_fallbacks=False):
1881
"""Create new branch object at a particular location."""
1882
if a_bzrdir is None:
1883
raise ValueError('a_bzrdir must be supplied')
1885
self.bzrdir = a_bzrdir
1886
self._base = self.bzrdir.transport.clone('..').base
1887
# XXX: We should be able to just do
1888
# self.base = self.bzrdir.root_transport.base
1889
# but this does not quite work yet -- mbp 20080522
1890
self._format = _format
1891
if _control_files is None:
1892
raise ValueError('BzrBranch _control_files is None')
1893
self.control_files = _control_files
1894
self._transport = _control_files._transport
1895
self.repository = _repository
1896
Branch.__init__(self)
1899
return '%s(%r)' % (self.__class__.__name__, self.base)
1903
def _get_base(self):
1904
"""Returns the directory containing the control directory."""
1907
base = property(_get_base, doc="The URL for the root of this branch.")
1909
def _get_config(self):
1910
return TransportConfig(self._transport, 'branch.conf')
1912
def is_locked(self):
1913
return self.control_files.is_locked()
1915
def lock_write(self, token=None):
1916
repo_token = self.repository.lock_write()
1918
token = self.control_files.lock_write(token=token)
1920
self.repository.unlock()
1924
def lock_read(self):
1925
self.repository.lock_read()
1927
self.control_files.lock_read()
1929
self.repository.unlock()
1933
# TODO: test for failed two phase locks. This is known broken.
1935
self.control_files.unlock()
1937
self.repository.unlock()
1938
if not self.control_files.is_locked():
1939
# we just released the lock
1940
self._clear_cached_state()
1942
def peek_lock_mode(self):
1943
if self.control_files._lock_count == 0:
1946
return self.control_files._lock_mode
1948
def get_physical_lock_status(self):
1949
return self.control_files.get_physical_lock_status()
1952
def print_file(self, file, revision_id):
1953
"""See Branch.print_file."""
1954
return self.repository.print_file(file, revision_id)
1956
def _write_revision_history(self, history):
1957
"""Factored out of set_revision_history.
1959
This performs the actual writing to disk.
1960
It is intended to be called by BzrBranch5.set_revision_history."""
1961
self._transport.put_bytes(
1962
'revision-history', '\n'.join(history),
1963
mode=self.bzrdir._get_file_mode())
1966
def set_revision_history(self, rev_history):
1967
"""See Branch.set_revision_history."""
1968
if 'evil' in debug.debug_flags:
1969
mutter_callsite(3, "set_revision_history scales with history.")
1970
check_not_reserved_id = _mod_revision.check_not_reserved_id
1971
for rev_id in rev_history:
1972
check_not_reserved_id(rev_id)
1973
if Branch.hooks['post_change_branch_tip']:
1974
# Don't calculate the last_revision_info() if there are no hooks
1976
old_revno, old_revid = self.last_revision_info()
1977
if len(rev_history) == 0:
1978
revid = _mod_revision.NULL_REVISION
1980
revid = rev_history[-1]
1981
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1982
self._write_revision_history(rev_history)
1983
self._clear_cached_state()
1984
self._cache_revision_history(rev_history)
1985
for hook in Branch.hooks['set_rh']:
1986
hook(self, rev_history)
1987
if Branch.hooks['post_change_branch_tip']:
1988
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1990
def _synchronize_history(self, destination, revision_id):
1991
"""Synchronize last revision and revision history between branches.
1993
This version is most efficient when the destination is also a
1994
BzrBranch5, but works for BzrBranch6 as long as the revision
1995
history is the true lefthand parent history, and all of the revisions
1996
are in the destination's repository. If not, set_revision_history
1999
:param destination: The branch to copy the history into
2000
:param revision_id: The revision-id to truncate history at. May
2001
be None to copy complete history.
2003
if not isinstance(destination._format, BzrBranchFormat5):
2004
super(BzrBranch, self)._synchronize_history(
2005
destination, revision_id)
2007
if revision_id == _mod_revision.NULL_REVISION:
2010
new_history = self.revision_history()
2011
if revision_id is not None and new_history != []:
2013
new_history = new_history[:new_history.index(revision_id) + 1]
2015
rev = self.repository.get_revision(revision_id)
2016
new_history = rev.get_history(self.repository)[1:]
2017
destination.set_revision_history(new_history)
2020
def set_last_revision_info(self, revno, revision_id):
2021
"""Set the last revision of this branch.
2023
The caller is responsible for checking that the revno is correct
2024
for this revision id.
2026
It may be possible to set the branch last revision to an id not
2027
present in the repository. However, branches can also be
2028
configured to check constraints on history, in which case this may not
2031
revision_id = _mod_revision.ensure_null(revision_id)
2032
# this old format stores the full history, but this api doesn't
2033
# provide it, so we must generate, and might as well check it's
2035
history = self._lefthand_history(revision_id)
2036
if len(history) != revno:
2037
raise AssertionError('%d != %d' % (len(history), revno))
2038
self.set_revision_history(history)
2040
def _gen_revision_history(self):
2041
history = self._transport.get_bytes('revision-history').split('\n')
2042
if history[-1:] == ['']:
2043
# There shouldn't be a trailing newline, but just in case.
2048
def generate_revision_history(self, revision_id, last_rev=None,
2050
"""Create a new revision history that will finish with revision_id.
2052
:param revision_id: the new tip to use.
2053
:param last_rev: The previous last_revision. If not None, then this
2054
must be a ancestory of revision_id, or DivergedBranches is raised.
2055
:param other_branch: The other branch that DivergedBranches should
2056
raise with respect to.
2058
self.set_revision_history(self._lefthand_history(revision_id,
2059
last_rev, other_branch))
2061
def basis_tree(self):
2062
"""See Branch.basis_tree."""
2063
return self.repository.revision_tree(self.last_revision())
2066
def pull(self, source, overwrite=False, stop_revision=None,
2067
_hook_master=None, run_hooks=True, possible_transports=None,
2068
_override_hook_target=None):
2071
:param _hook_master: Private parameter - set the branch to
2072
be supplied as the master to pull hooks.
2073
:param run_hooks: Private parameter - if false, this branch
2074
is being called because it's the master of the primary branch,
2075
so it should not run its hooks.
2076
:param _override_hook_target: Private parameter - set the branch to be
2077
supplied as the target_branch to pull hooks.
2079
result = PullResult()
2080
result.source_branch = source
2081
if _override_hook_target is None:
2082
result.target_branch = self
2084
result.target_branch = _override_hook_target
2087
# We assume that during 'pull' the local repository is closer than
2089
graph = self.repository.get_graph(source.repository)
2090
result.old_revno, result.old_revid = self.last_revision_info()
2091
self.update_revisions(source, stop_revision, overwrite=overwrite,
2093
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2094
result.new_revno, result.new_revid = self.last_revision_info()
2096
result.master_branch = _hook_master
2097
result.local_branch = result.target_branch
2099
result.master_branch = result.target_branch
2100
result.local_branch = None
2102
for hook in Branch.hooks['post_pull']:
2108
def _get_parent_location(self):
2109
_locs = ['parent', 'pull', 'x-pull']
2112
return self._transport.get_bytes(l).strip('\n')
2113
except errors.NoSuchFile:
2118
def push(self, target, overwrite=False, stop_revision=None,
2119
_override_hook_source_branch=None):
2122
This is the basic concrete implementation of push()
2124
:param _override_hook_source_branch: If specified, run
2125
the hooks passing this Branch as the source, rather than self.
2126
This is for use of RemoteBranch, where push is delegated to the
2127
underlying vfs-based Branch.
2129
# TODO: Public option to disable running hooks - should be trivial but
2131
return _run_with_write_locked_target(
2132
target, self._push_with_bound_branches, target, overwrite,
2134
_override_hook_source_branch=_override_hook_source_branch)
2136
def _push_with_bound_branches(self, target, overwrite,
2138
_override_hook_source_branch=None):
2139
"""Push from self into target, and into target's master if any.
2141
This is on the base BzrBranch class even though it doesn't support
2142
bound branches because the *target* might be bound.
2145
if _override_hook_source_branch:
2146
result.source_branch = _override_hook_source_branch
2147
for hook in Branch.hooks['post_push']:
2150
bound_location = target.get_bound_location()
2151
if bound_location and target.base != bound_location:
2152
# there is a master branch.
2154
# XXX: Why the second check? Is it even supported for a branch to
2155
# be bound to itself? -- mbp 20070507
2156
master_branch = target.get_master_branch()
2157
master_branch.lock_write()
2159
# push into the master from this branch.
2160
self._basic_push(master_branch, overwrite, stop_revision)
2161
# and push into the target branch from this. Note that we push from
2162
# this branch again, because its considered the highest bandwidth
2164
result = self._basic_push(target, overwrite, stop_revision)
2165
result.master_branch = master_branch
2166
result.local_branch = target
2170
master_branch.unlock()
2173
result = self._basic_push(target, overwrite, stop_revision)
2174
# TODO: Why set master_branch and local_branch if there's no
2175
# binding? Maybe cleaner to just leave them unset? -- mbp
2177
result.master_branch = target
2178
result.local_branch = None
2182
def _basic_push(self, target, overwrite, stop_revision):
2183
"""Basic implementation of push without bound branches or hooks.
2185
Must be called with self read locked and target write locked.
2187
result = BranchPushResult()
2188
result.source_branch = self
2189
result.target_branch = target
2190
result.old_revno, result.old_revid = target.last_revision_info()
2191
if result.old_revid != self.last_revision():
2192
# We assume that during 'push' this repository is closer than
2194
graph = self.repository.get_graph(target.repository)
2195
target.update_revisions(self, stop_revision, overwrite=overwrite,
2197
if self._push_should_merge_tags():
2198
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2199
result.new_revno, result.new_revid = target.last_revision_info()
2202
def get_stacked_on_url(self):
2203
raise errors.UnstackableBranchFormat(self._format, self.base)
2205
def set_push_location(self, location):
2206
"""See Branch.set_push_location."""
2207
self.get_config().set_user_option(
2208
'push_location', location,
2209
store=_mod_config.STORE_LOCATION_NORECURSE)
2212
def set_parent(self, url):
2213
"""See Branch.set_parent."""
2214
# TODO: Maybe delete old location files?
2215
# URLs should never be unicode, even on the local fs,
2216
# FIXUP this and get_parent in a future branch format bump:
2217
# read and rewrite the file. RBC 20060125
2219
if isinstance(url, unicode):
2221
url = url.encode('ascii')
2222
except UnicodeEncodeError:
2223
raise errors.InvalidURL(url,
2224
"Urls must be 7-bit ascii, "
2225
"use bzrlib.urlutils.escape")
2226
url = urlutils.relative_url(self.base, url)
2227
self._set_parent_location(url)
2229
def _set_parent_location(self, url):
2231
self._transport.delete('parent')
2233
self._transport.put_bytes('parent', url + '\n',
2234
mode=self.bzrdir._get_file_mode())
2237
class BzrBranch5(BzrBranch):
2238
"""A format 5 branch. This supports new features over plain branches.
2240
It has support for a master_branch which is the data for bound branches.
2244
def pull(self, source, overwrite=False, stop_revision=None,
2245
run_hooks=True, possible_transports=None,
2246
_override_hook_target=None):
2247
"""Pull from source into self, updating my master if any.
2249
:param run_hooks: Private parameter - if false, this branch
2250
is being called because it's the master of the primary branch,
2251
so it should not run its hooks.
2253
bound_location = self.get_bound_location()
2254
master_branch = None
2255
if bound_location and source.base != bound_location:
2256
# not pulling from master, so we need to update master.
2257
master_branch = self.get_master_branch(possible_transports)
2258
master_branch.lock_write()
2261
# pull from source into master.
2262
master_branch.pull(source, overwrite, stop_revision,
2264
return super(BzrBranch5, self).pull(source, overwrite,
2265
stop_revision, _hook_master=master_branch,
2266
run_hooks=run_hooks,
2267
_override_hook_target=_override_hook_target)
2270
master_branch.unlock()
2272
def get_bound_location(self):
2274
return self._transport.get_bytes('bound')[:-1]
2275
except errors.NoSuchFile:
2279
def get_master_branch(self, possible_transports=None):
2280
"""Return the branch we are bound to.
2282
:return: Either a Branch, or None
2284
This could memoise the branch, but if thats done
2285
it must be revalidated on each new lock.
2286
So for now we just don't memoise it.
2287
# RBC 20060304 review this decision.
2289
bound_loc = self.get_bound_location()
2293
return Branch.open(bound_loc,
2294
possible_transports=possible_transports)
2295
except (errors.NotBranchError, errors.ConnectionError), e:
2296
raise errors.BoundBranchConnectionFailure(
2300
def set_bound_location(self, location):
2301
"""Set the target where this branch is bound to.
2303
:param location: URL to the target branch
2306
self._transport.put_bytes('bound', location+'\n',
2307
mode=self.bzrdir._get_file_mode())
2310
self._transport.delete('bound')
2311
except errors.NoSuchFile:
2316
def bind(self, other):
2317
"""Bind this branch to the branch other.
2319
This does not push or pull data between the branches, though it does
2320
check for divergence to raise an error when the branches are not
2321
either the same, or one a prefix of the other. That behaviour may not
2322
be useful, so that check may be removed in future.
2324
:param other: The branch to bind to
2327
# TODO: jam 20051230 Consider checking if the target is bound
2328
# It is debatable whether you should be able to bind to
2329
# a branch which is itself bound.
2330
# Committing is obviously forbidden,
2331
# but binding itself may not be.
2332
# Since we *have* to check at commit time, we don't
2333
# *need* to check here
2335
# we want to raise diverged if:
2336
# last_rev is not in the other_last_rev history, AND
2337
# other_last_rev is not in our history, and do it without pulling
2339
self.set_bound_location(other.base)
2343
"""If bound, unbind"""
2344
return self.set_bound_location(None)
2347
def update(self, possible_transports=None):
2348
"""Synchronise this branch with the master branch if any.
2350
:return: None or the last_revision that was pivoted out during the
2353
master = self.get_master_branch(possible_transports)
2354
if master is not None:
2355
old_tip = _mod_revision.ensure_null(self.last_revision())
2356
self.pull(master, overwrite=True)
2357
if self.repository.get_graph().is_ancestor(old_tip,
2358
_mod_revision.ensure_null(self.last_revision())):
2364
class BzrBranch7(BzrBranch5):
2365
"""A branch with support for a fallback repository."""
2367
def _open_hook(self):
2368
if self._ignore_fallbacks:
2371
url = self.get_stacked_on_url()
2372
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2373
errors.UnstackableBranchFormat):
2376
for hook in Branch.hooks['transform_fallback_location']:
2377
url = hook(self, url)
2379
hook_name = Branch.hooks.get_hook_name(hook)
2380
raise AssertionError(
2381
"'transform_fallback_location' hook %s returned "
2382
"None, not a URL." % hook_name)
2383
self._activate_fallback_location(url)
2385
def __init__(self, *args, **kwargs):
2386
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2387
super(BzrBranch7, self).__init__(*args, **kwargs)
2388
self._last_revision_info_cache = None
2389
self._partial_revision_history_cache = []
2391
def _clear_cached_state(self):
2392
super(BzrBranch7, self)._clear_cached_state()
2393
self._last_revision_info_cache = None
2394
self._partial_revision_history_cache = []
2396
def _last_revision_info(self):
2397
revision_string = self._transport.get_bytes('last-revision')
2398
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2399
revision_id = cache_utf8.get_cached_utf8(revision_id)
2401
return revno, revision_id
2403
def _write_last_revision_info(self, revno, revision_id):
2404
"""Simply write out the revision id, with no checks.
2406
Use set_last_revision_info to perform this safely.
2408
Does not update the revision_history cache.
2409
Intended to be called by set_last_revision_info and
2410
_write_revision_history.
2412
revision_id = _mod_revision.ensure_null(revision_id)
2413
out_string = '%d %s\n' % (revno, revision_id)
2414
self._transport.put_bytes('last-revision', out_string,
2415
mode=self.bzrdir._get_file_mode())
2418
def set_last_revision_info(self, revno, revision_id):
2419
revision_id = _mod_revision.ensure_null(revision_id)
2420
old_revno, old_revid = self.last_revision_info()
2421
if self._get_append_revisions_only():
2422
self._check_history_violation(revision_id)
2423
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2424
self._write_last_revision_info(revno, revision_id)
2425
self._clear_cached_state()
2426
self._last_revision_info_cache = revno, revision_id
2427
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2429
def _synchronize_history(self, destination, revision_id):
2430
"""Synchronize last revision and revision history between branches.
2432
:see: Branch._synchronize_history
2434
# XXX: The base Branch has a fast implementation of this method based
2435
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2436
# that uses set_revision_history. This class inherits from BzrBranch5,
2437
# but wants the fast implementation, so it calls
2438
# Branch._synchronize_history directly.
2439
Branch._synchronize_history(self, destination, revision_id)
2441
def _check_history_violation(self, revision_id):
2442
last_revision = _mod_revision.ensure_null(self.last_revision())
2443
if _mod_revision.is_null(last_revision):
2445
if last_revision not in self._lefthand_history(revision_id):
2446
raise errors.AppendRevisionsOnlyViolation(self.base)
2448
def _gen_revision_history(self):
2449
"""Generate the revision history from last revision
2451
last_revno, last_revision = self.last_revision_info()
2452
self._extend_partial_history(stop_index=last_revno-1)
2453
return list(reversed(self._partial_revision_history_cache))
2455
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2456
"""Extend the partial history to include a given index
2458
If a stop_index is supplied, stop when that index has been reached.
2459
If a stop_revision is supplied, stop when that revision is
2460
encountered. Otherwise, stop when the beginning of history is
2463
:param stop_index: The index which should be present. When it is
2464
present, history extension will stop.
2465
:param revision_id: The revision id which should be present. When
2466
it is encountered, history extension will stop.
2468
repo = self.repository
2469
if len(self._partial_revision_history_cache) == 0:
2470
iterator = repo.iter_reverse_revision_history(self.last_revision())
2472
start_revision = self._partial_revision_history_cache[-1]
2473
iterator = repo.iter_reverse_revision_history(start_revision)
2474
#skip the last revision in the list
2475
next_revision = iterator.next()
2476
for revision_id in iterator:
2477
self._partial_revision_history_cache.append(revision_id)
2478
if (stop_index is not None and
2479
len(self._partial_revision_history_cache) > stop_index):
2481
if revision_id == stop_revision:
2484
def _write_revision_history(self, history):
2485
"""Factored out of set_revision_history.
2487
This performs the actual writing to disk, with format-specific checks.
2488
It is intended to be called by BzrBranch5.set_revision_history.
2490
if len(history) == 0:
2491
last_revision = 'null:'
2493
if history != self._lefthand_history(history[-1]):
2494
raise errors.NotLefthandHistory(history)
2495
last_revision = history[-1]
2496
if self._get_append_revisions_only():
2497
self._check_history_violation(last_revision)
2498
self._write_last_revision_info(len(history), last_revision)
2501
def _set_parent_location(self, url):
2502
"""Set the parent branch"""
2503
self._set_config_location('parent_location', url, make_relative=True)
2506
def _get_parent_location(self):
2507
"""Set the parent branch"""
2508
return self._get_config_location('parent_location')
2510
def set_push_location(self, location):
2511
"""See Branch.set_push_location."""
2512
self._set_config_location('push_location', location)
2514
def set_bound_location(self, location):
2515
"""See Branch.set_push_location."""
2517
config = self.get_config()
2518
if location is None:
2519
if config.get_user_option('bound') != 'True':
2522
config.set_user_option('bound', 'False', warn_masked=True)
2525
self._set_config_location('bound_location', location,
2527
config.set_user_option('bound', 'True', warn_masked=True)
2530
def _get_bound_location(self, bound):
2531
"""Return the bound location in the config file.
2533
Return None if the bound parameter does not match"""
2534
config = self.get_config()
2535
config_bound = (config.get_user_option('bound') == 'True')
2536
if config_bound != bound:
2538
return self._get_config_location('bound_location', config=config)
2540
def get_bound_location(self):
2541
"""See Branch.set_push_location."""
2542
return self._get_bound_location(True)
2544
def get_old_bound_location(self):
2545
"""See Branch.get_old_bound_location"""
2546
return self._get_bound_location(False)
2548
def get_stacked_on_url(self):
2549
# you can always ask for the URL; but you might not be able to use it
2550
# if the repo can't support stacking.
2551
## self._check_stackable_repo()
2552
stacked_url = self._get_config_location('stacked_on_location')
2553
if stacked_url is None:
2554
raise errors.NotStacked(self)
2557
def set_append_revisions_only(self, enabled):
2562
self.get_config().set_user_option('append_revisions_only', value,
2565
def _get_append_revisions_only(self):
2566
value = self.get_config().get_user_option('append_revisions_only')
2567
return value == 'True'
2570
def generate_revision_history(self, revision_id, last_rev=None,
2572
"""See BzrBranch5.generate_revision_history"""
2573
history = self._lefthand_history(revision_id, last_rev, other_branch)
2574
revno = len(history)
2575
self.set_last_revision_info(revno, revision_id)
2578
def get_rev_id(self, revno, history=None):
2579
"""Find the revision id of the specified revno."""
2581
return _mod_revision.NULL_REVISION
2583
last_revno, last_revision_id = self.last_revision_info()
2584
if revno <= 0 or revno > last_revno:
2585
raise errors.NoSuchRevision(self, revno)
2587
if history is not None:
2588
return history[revno - 1]
2590
index = last_revno - revno
2591
if len(self._partial_revision_history_cache) <= index:
2592
self._extend_partial_history(stop_index=index)
2593
if len(self._partial_revision_history_cache) > index:
2594
return self._partial_revision_history_cache[index]
2596
raise errors.NoSuchRevision(self, revno)
2599
def revision_id_to_revno(self, revision_id):
2600
"""Given a revision id, return its revno"""
2601
if _mod_revision.is_null(revision_id):
2604
index = self._partial_revision_history_cache.index(revision_id)
2606
self._extend_partial_history(stop_revision=revision_id)
2607
index = len(self._partial_revision_history_cache) - 1
2608
if self._partial_revision_history_cache[index] != revision_id:
2609
raise errors.NoSuchRevision(self, revision_id)
2610
return self.revno() - index
2613
class BzrBranch6(BzrBranch7):
2614
"""See BzrBranchFormat6 for the capabilities of this branch.
2616
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2620
def get_stacked_on_url(self):
2621
raise errors.UnstackableBranchFormat(self._format, self.base)
2624
######################################################################
2625
# results of operations
2628
class _Result(object):
2630
def _show_tag_conficts(self, to_file):
2631
if not getattr(self, 'tag_conflicts', None):
2633
to_file.write('Conflicting tags:\n')
2634
for name, value1, value2 in self.tag_conflicts:
2635
to_file.write(' %s\n' % (name, ))
2638
class PullResult(_Result):
2639
"""Result of a Branch.pull operation.
2641
:ivar old_revno: Revision number before pull.
2642
:ivar new_revno: Revision number after pull.
2643
:ivar old_revid: Tip revision id before pull.
2644
:ivar new_revid: Tip revision id after pull.
2645
:ivar source_branch: Source (local) branch object. (read locked)
2646
:ivar master_branch: Master branch of the target, or the target if no
2648
:ivar local_branch: target branch if there is a Master, else None
2649
:ivar target_branch: Target/destination branch object. (write locked)
2650
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2654
# DEPRECATED: pull used to return the change in revno
2655
return self.new_revno - self.old_revno
2657
def report(self, to_file):
2659
if self.old_revid == self.new_revid:
2660
to_file.write('No revisions to pull.\n')
2662
to_file.write('Now on revision %d.\n' % self.new_revno)
2663
self._show_tag_conficts(to_file)
2666
class BranchPushResult(_Result):
2667
"""Result of a Branch.push operation.
2669
:ivar old_revno: Revision number (eg 10) of the target before push.
2670
:ivar new_revno: Revision number (eg 12) of the target after push.
2671
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2673
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2675
:ivar source_branch: Source branch object that the push was from. This is
2676
read locked, and generally is a local (and thus low latency) branch.
2677
:ivar master_branch: If target is a bound branch, the master branch of
2678
target, or target itself. Always write locked.
2679
:ivar target_branch: The direct Branch where data is being sent (write
2681
:ivar local_branch: If the target is a bound branch this will be the
2682
target, otherwise it will be None.
2686
# DEPRECATED: push used to return the change in revno
2687
return self.new_revno - self.old_revno
2689
def report(self, to_file):
2690
"""Write a human-readable description of the result."""
2691
if self.old_revid == self.new_revid:
2692
note('No new revisions to push.')
2694
note('Pushed up to revision %d.' % self.new_revno)
2695
self._show_tag_conficts(to_file)
2698
class BranchCheckResult(object):
2699
"""Results of checking branch consistency.
2704
def __init__(self, branch):
2705
self.branch = branch
2707
def report_results(self, verbose):
2708
"""Report the check results via trace.note.
2710
:param verbose: Requests more detailed display of what was checked,
2713
note('checked branch %s format %s',
2715
self.branch._format)
2718
class Converter5to6(object):
2719
"""Perform an in-place upgrade of format 5 to format 6"""
2721
def convert(self, branch):
2722
# Data for 5 and 6 can peacefully coexist.
2723
format = BzrBranchFormat6()
2724
new_branch = format.open(branch.bzrdir, _found=True)
2726
# Copy source data into target
2727
new_branch._write_last_revision_info(*branch.last_revision_info())
2728
new_branch.set_parent(branch.get_parent())
2729
new_branch.set_bound_location(branch.get_bound_location())
2730
new_branch.set_push_location(branch.get_push_location())
2732
# New branch has no tags by default
2733
new_branch.tags._set_tag_dict({})
2735
# Copying done; now update target format
2736
new_branch._transport.put_bytes('format',
2737
format.get_format_string(),
2738
mode=new_branch.bzrdir._get_file_mode())
2740
# Clean up old files
2741
new_branch._transport.delete('revision-history')
2743
branch.set_parent(None)
2744
except errors.NoSuchFile:
2746
branch.set_bound_location(None)
2749
class Converter6to7(object):
2750
"""Perform an in-place upgrade of format 6 to format 7"""
2752
def convert(self, branch):
2753
format = BzrBranchFormat7()
2754
branch._set_config_location('stacked_on_location', '')
2755
# update target format
2756
branch._transport.put_bytes('format', format.get_format_string())
2760
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2761
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2764
_run_with_write_locked_target will attempt to release the lock it acquires.
2766
If an exception is raised by callable, then that exception *will* be
2767
propagated, even if the unlock attempt raises its own error. Thus
2768
_run_with_write_locked_target should be preferred to simply doing::
2772
return callable(*args, **kwargs)
2777
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2778
# should share code?
2781
result = callable(*args, **kwargs)
2783
exc_info = sys.exc_info()
2787
raise exc_info[0], exc_info[1], exc_info[2]
2793
class InterBranch(InterObject):
2794
"""This class represents operations taking place between two branches.
2796
Its instances have methods like pull() and push() and contain
2797
references to the source and target repositories these operations
2798
can be carried out on.
2802
"""The available optimised InterBranch types."""
2805
def _get_branch_formats_to_test():
2806
"""Return a tuple with the Branch formats to use when testing."""
2807
raise NotImplementedError(self._get_branch_formats_to_test)
2809
def update_revisions(self, stop_revision=None, overwrite=False,
2811
"""Pull in new perfect-fit revisions.
2813
:param stop_revision: Updated until the given revision
2814
:param overwrite: Always set the branch pointer, rather than checking
2815
to see if it is a proper descendant.
2816
:param graph: A Graph object that can be used to query history
2817
information. This can be None.
2820
raise NotImplementedError(self.update_revisions)
2823
class GenericInterBranch(InterBranch):
2824
"""InterBranch implementation that uses public Branch functions.
2828
def _get_branch_formats_to_test():
2829
return BranchFormat._default_format, BranchFormat._default_format
2831
def update_revisions(self, stop_revision=None, overwrite=False,
2833
"""See InterBranch.update_revisions()."""
2834
self.source.lock_read()
2836
other_revno, other_last_revision = self.source.last_revision_info()
2837
stop_revno = None # unknown
2838
if stop_revision is None:
2839
stop_revision = other_last_revision
2840
if _mod_revision.is_null(stop_revision):
2841
# if there are no commits, we're done.
2843
stop_revno = other_revno
2845
# what's the current last revision, before we fetch [and change it
2847
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2848
# we fetch here so that we don't process data twice in the common
2849
# case of having something to pull, and so that the check for
2850
# already merged can operate on the just fetched graph, which will
2851
# be cached in memory.
2852
self.target.fetch(self.source, stop_revision)
2853
# Check to see if one is an ancestor of the other
2856
graph = self.target.repository.get_graph()
2857
if self.target._check_if_descendant_or_diverged(
2858
stop_revision, last_rev, graph, self.source):
2859
# stop_revision is a descendant of last_rev, but we aren't
2860
# overwriting, so we're done.
2862
if stop_revno is None:
2864
graph = self.target.repository.get_graph()
2865
this_revno, this_last_revision = \
2866
self.target.last_revision_info()
2867
stop_revno = graph.find_distance_to_null(stop_revision,
2868
[(other_last_revision, other_revno),
2869
(this_last_revision, this_revno)])
2870
self.target.set_last_revision_info(stop_revno, stop_revision)
2872
self.source.unlock()
2875
def is_compatible(self, source, target):
2876
# GenericBranch uses the public API, so always compatible
2880
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
