13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
19
from .lazy_import import lazy_import
20
lazy_import(globals(), """
24
config as _mod_config,
28
revision as _mod_revision,
34
from breezy.bzr import (
39
from breezy.i18n import gettext, ngettext
47
from .hooks import Hooks
48
from .inter import InterObject
49
from .lock import LogicalLockResult
54
from .trace import mutter, mutter_callsite, note, is_quiet, warning
57
class UnstackableBranchFormat(errors.BzrError):
59
_fmt = ("The branch '%(url)s'(%(format)s) is not a stackable format. "
60
"You will need to upgrade the branch to permit branch stacking.")
62
def __init__(self, format, url):
63
errors.BzrError.__init__(self)
68
class Branch(controldir.ControlComponent):
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from copy import deepcopy
19
from cStringIO import StringIO
24
from unittest import TestSuite
25
from warnings import warn
28
import bzrlib.bzrdir as bzrdir
29
from bzrlib.config import TreeConfig
30
from bzrlib.decorators import needs_read_lock, needs_write_lock
31
from bzrlib.delta import compare_trees
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError,
36
UninitializableFormat,
38
UnlistableBranch, NoSuchFile, NotVersionedError,
40
import bzrlib.inventory as inventory
41
from bzrlib.inventory import Inventory
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
from bzrlib.lockdir import LockDir
44
from bzrlib.osutils import (isdir, quotefn,
45
rename, splitpath, sha_file,
46
file_kind, abspath, normpath, pathjoin,
49
from bzrlib.textui import show_status
50
from bzrlib.trace import mutter, note
51
from bzrlib.tree import EmptyTree, RevisionTree
52
from bzrlib.repository import Repository
53
from bzrlib.revision import (
54
get_intervening_revisions,
59
from bzrlib.store import copy_all
60
from bzrlib.symbol_versioning import *
61
import bzrlib.transactions as transactions
62
from bzrlib.transport import Transport, get_transport
63
from bzrlib.tree import EmptyTree, RevisionTree
68
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
69
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
70
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
73
# TODO: Maybe include checks for common corruption of newlines, etc?
75
# TODO: Some operations like log might retrieve the same revisions
76
# repeatedly to calculate deltas. We could perhaps have a weakref
77
# cache in memory to make this faster. In general anything can be
78
# cached in memory between lock and unlock operations. .. nb thats
79
# what the transaction identity map provides
82
######################################################################
69
86
"""Branch holding a history of revisions.
72
Base directory/url of the branch; using control_url and
73
control_transport is more standardized.
74
:ivar hooks: An instance of BranchHooks.
75
:ivar _master_branch_cache: cached result of get_master_branch, see
89
Base directory/url of the branch.
78
91
# this is really an instance variable - FIXME move it there
83
def control_transport(self):
84
return self._transport
87
def user_transport(self):
88
return self.controldir.user_transport
90
def __init__(self, possible_transports=None):
91
self.tags = self._format.make_tags(self)
92
self._revision_history_cache = None
93
self._revision_id_to_revno_cache = None
94
self._partial_revision_id_to_revno_cache = {}
95
self._partial_revision_history_cache = []
96
self._last_revision_info_cache = None
97
self._master_branch_cache = None
98
self._merge_sorted_revisions_cache = None
99
self._open_hook(possible_transports)
100
hooks = Branch.hooks['open']
104
def _open_hook(self, possible_transports):
105
"""Called by init to allow simpler extension of the base class."""
107
def _activate_fallback_location(self, url, possible_transports):
108
"""Activate the branch/repository from url as a fallback repository."""
109
for existing_fallback_repo in self.repository._fallback_repositories:
110
if existing_fallback_repo.user_url == url:
111
# This fallback is already configured. This probably only
112
# happens because ControlDir.sprout is a horrible mess. To
113
# avoid confusing _unstack we don't add this a second time.
114
mutter('duplicate activation of fallback %r on %r', url, self)
116
repo = self._get_fallback_repository(url, possible_transports)
117
if repo.has_same_location(self.repository):
118
raise errors.UnstackableLocationError(self.user_url, url)
119
self.repository.add_fallback_repository(repo)
121
def break_lock(self):
122
"""Break a lock if one is present from another instance.
124
Uses the ui factory to ask for confirmation if the lock may be from
127
This will probe the repository for its lock as well.
129
self.control_files.break_lock()
130
self.repository.break_lock()
131
master = self.get_master_branch()
132
if master is not None:
135
def _check_stackable_repo(self):
136
if not self.repository._format.supports_external_lookups:
137
raise errors.UnstackableRepositoryFormat(
138
self.repository._format, self.repository.base)
140
def _extend_partial_history(self, stop_index=None, stop_revision=None):
141
"""Extend the partial history to include a given index
143
If a stop_index is supplied, stop when that index has been reached.
144
If a stop_revision is supplied, stop when that revision is
145
encountered. Otherwise, stop when the beginning of history is
148
:param stop_index: The index which should be present. When it is
149
present, history extension will stop.
150
:param stop_revision: The revision id which should be present. When
151
it is encountered, history extension will stop.
153
if len(self._partial_revision_history_cache) == 0:
154
self._partial_revision_history_cache = [self.last_revision()]
155
repository._iter_for_revno(
156
self.repository, self._partial_revision_history_cache,
157
stop_index=stop_index, stop_revision=stop_revision)
158
if self._partial_revision_history_cache[-1] == \
159
_mod_revision.NULL_REVISION:
160
self._partial_revision_history_cache.pop()
162
def _get_check_refs(self):
163
"""Get the references needed for check().
167
revid = self.last_revision()
168
return [('revision-existence', revid), ('lefthand-distance', revid)]
171
def open(base, _unsupported=False, possible_transports=None):
172
"""Open the branch rooted at base.
174
For instance, if the branch is at URL/.bzr/branch,
175
Branch.open(URL) -> a Branch instance.
177
control = controldir.ControlDir.open(
178
base, possible_transports=possible_transports,
179
_unsupported=_unsupported)
180
return control.open_branch(
181
unsupported=_unsupported,
182
possible_transports=possible_transports)
185
def open_from_transport(transport, name=None, _unsupported=False,
186
possible_transports=None):
187
"""Open the branch rooted at transport"""
188
control = controldir.ControlDir.open_from_transport(
189
transport, _unsupported)
190
return control.open_branch(
191
name=name, unsupported=_unsupported,
192
possible_transports=possible_transports)
195
def open_containing(url, possible_transports=None):
95
def __init__(self, *ignored, **ignored_too):
96
raise NotImplementedError('The Branch class is abstract')
99
@deprecated_method(zero_eight)
100
def open_downlevel(base):
101
"""Open a branch which may be of an old format."""
102
return Branch.open(base, _unsupported=True)
105
def open(base, _unsupported=False):
106
"""Open the repository rooted at base.
108
For instance, if the repository is at URL/.bzr/repository,
109
Repository.open(URL) -> a Repository instance.
111
control = bzrdir.BzrDir.open(base, _unsupported)
112
return control.open_branch(_unsupported)
115
def open_containing(url):
196
116
"""Open an existing branch which contains url.
198
118
This probes for a branch at url, and searches upwards from there.
200
120
Basically we keep looking up until we find the control directory or
201
121
run into the root. If there isn't one, raises NotBranchError.
202
If there is one and it is either an unrecognised format or an
203
unsupported format, UnknownFormatError or UnsupportedFormatError are
204
raised. If there is one, it is returned, along with the unused portion
207
control, relpath = controldir.ControlDir.open_containing(
208
url, possible_transports)
209
branch = control.open_branch(possible_transports=possible_transports)
210
return (branch, relpath)
212
def _push_should_merge_tags(self):
213
"""Should _basic_push merge this branch's tags into the target?
215
The default implementation returns False if this branch has no tags,
216
and True the rest of the time. Subclasses may override this.
218
return self.supports_tags() and self.tags.get_tag_dict()
220
def get_config(self):
221
"""Get a breezy.config.BranchConfig for this Branch.
223
This can then be used to get and set configuration options for the
226
:return: A breezy.config.BranchConfig.
228
return _mod_config.BranchConfig(self)
230
def get_config_stack(self):
231
"""Get a breezy.config.BranchStack for this Branch.
233
This can then be used to get and set configuration options for the
236
:return: A breezy.config.BranchStack.
238
return _mod_config.BranchStack(self)
240
def store_uncommitted(self, creator):
241
"""Store uncommitted changes from a ShelfCreator.
243
:param creator: The ShelfCreator containing uncommitted changes, or
244
None to delete any stored changes.
245
:raises: ChangesAlreadyStored if the branch already has changes.
247
raise NotImplementedError(self.store_uncommitted)
249
def get_unshelver(self, tree):
250
"""Return a shelf.Unshelver for this branch and tree.
252
:param tree: The tree to use to construct the Unshelver.
253
:return: an Unshelver or None if no changes are stored.
255
raise NotImplementedError(self.get_unshelver)
257
def _get_fallback_repository(self, url, possible_transports):
258
"""Get the repository we fallback to at url."""
259
url = urlutils.join(self.base, url)
260
a_branch = Branch.open(url, possible_transports=possible_transports)
261
return a_branch.repository
263
def _get_nick(self, local=False, possible_transports=None):
264
config = self.get_config()
265
# explicit overrides master, but don't look for master if local is True
266
if not local and not config.has_explicit_nickname():
268
master = self.get_master_branch(possible_transports)
269
if master and self.user_url == master.user_url:
270
raise errors.RecursiveBind(self.user_url)
271
if master is not None:
272
# return the master branch value
274
except errors.RecursiveBind as e:
276
except errors.BzrError as e:
277
# Silently fall back to local implicit nick if the master is
279
mutter("Could not connect to bound branch, "
280
"falling back to local nick.\n " + str(e))
281
return config.get_nickname()
122
If there is one and it is either an unrecognised format or an unsupported
123
format, UnknownFormatError or UnsupportedFormatError are raised.
124
If there is one, it is returned, along with the unused portion of url.
126
control, relpath = bzrdir.BzrDir.open_containing(url)
127
return control.open_branch(), relpath
130
@deprecated_function(zero_eight)
131
def initialize(base):
132
"""Create a new working tree and branch, rooted at 'base' (url)
134
NOTE: This will soon be deprecated in favour of creation
137
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
139
def setup_caching(self, cache_root):
140
"""Subclasses that care about caching should override this, and set
141
up cached stores located under cache_root.
143
# seems to be unused, 2006-01-13 mbp
144
warn('%s is deprecated' % self.setup_caching)
145
self.cache_root = cache_root
148
cfg = self.tree_config()
149
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
283
151
def _set_nick(self, nick):
284
self.get_config().set_user_option('nickname', nick, warn_masked=True)
152
cfg = self.tree_config()
153
cfg.set_option(nick, "nickname")
154
assert cfg.get_option("nickname") == nick
286
156
nick = property(_get_nick, _set_nick)
289
raise NotImplementedError(self.is_locked)
291
def _lefthand_history(self, revision_id, last_rev=None,
293
if 'evil' in debug.debug_flags:
294
mutter_callsite(4, "_lefthand_history scales with history.")
295
# stop_revision must be a descendant of last_revision
296
graph = self.repository.get_graph()
297
if last_rev is not None:
298
if not graph.is_ancestor(last_rev, revision_id):
299
# our previous tip is not merged into stop_revision
300
raise errors.DivergedBranches(self, other_branch)
301
# make a new revision history from the graph
302
parents_map = graph.get_parent_map([revision_id])
303
if revision_id not in parents_map:
304
raise errors.NoSuchRevision(self, revision_id)
305
current_rev_id = revision_id
307
check_not_reserved_id = _mod_revision.check_not_reserved_id
308
# Do not include ghosts or graph origin in revision_history
309
while (current_rev_id in parents_map
310
and len(parents_map[current_rev_id]) > 0):
311
check_not_reserved_id(current_rev_id)
312
new_history.append(current_rev_id)
313
current_rev_id = parents_map[current_rev_id][0]
314
parents_map = graph.get_parent_map([current_rev_id])
315
new_history.reverse()
318
def lock_write(self, token=None):
319
"""Lock the branch for write operations.
321
:param token: A token to permit reacquiring a previously held and
323
:return: A BranchWriteLockResult.
325
raise NotImplementedError(self.lock_write)
158
def lock_write(self):
159
raise NotImplementedError('lock_write is abstract')
327
161
def lock_read(self):
328
"""Lock the branch for read operations.
330
:return: A breezy.lock.LogicalLockResult.
332
raise NotImplementedError(self.lock_read)
162
raise NotImplementedError('lock_read is abstract')
334
164
def unlock(self):
335
raise NotImplementedError(self.unlock)
165
raise NotImplementedError('unlock is abstract')
337
167
def peek_lock_mode(self):
338
168
"""Return lock mode for the Branch: 'r', 'w' or None"""
339
169
raise NotImplementedError(self.peek_lock_mode)
341
def get_physical_lock_status(self):
342
raise NotImplementedError(self.get_physical_lock_status)
344
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
345
"""Return the revision_id for a dotted revno.
347
:param revno: a tuple like (1,) or (1,1,2)
348
:param _cache_reverse: a private parameter enabling storage
349
of the reverse mapping in a top level cache. (This should
350
only be done in selective circumstances as we want to
351
avoid having the mapping cached multiple times.)
352
:return: the revision_id
353
:raises errors.NoSuchRevision: if the revno doesn't exist
355
with self.lock_read():
356
rev_id = self._do_dotted_revno_to_revision_id(revno)
358
self._partial_revision_id_to_revno_cache[rev_id] = revno
361
def _do_dotted_revno_to_revision_id(self, revno):
362
"""Worker function for dotted_revno_to_revision_id.
364
Subclasses should override this if they wish to
365
provide a more efficient implementation.
369
return self.get_rev_id(revno[0])
370
except errors.RevisionNotPresent as e:
371
raise errors.GhostRevisionsHaveNoRevno(revno[0], e.revision_id)
372
revision_id_to_revno = self.get_revision_id_to_revno_map()
373
revision_ids = [revision_id for revision_id, this_revno
374
in viewitems(revision_id_to_revno)
375
if revno == this_revno]
376
if len(revision_ids) == 1:
377
return revision_ids[0]
379
revno_str = '.'.join(map(str, revno))
380
raise errors.NoSuchRevision(self, revno_str)
382
def revision_id_to_dotted_revno(self, revision_id):
383
"""Given a revision id, return its dotted revno.
385
:return: a tuple like (1,) or (400,1,3).
387
with self.lock_read():
388
return self._do_revision_id_to_dotted_revno(revision_id)
390
def _do_revision_id_to_dotted_revno(self, revision_id):
391
"""Worker function for revision_id_to_revno."""
392
# Try the caches if they are loaded
393
result = self._partial_revision_id_to_revno_cache.get(revision_id)
394
if result is not None:
396
if self._revision_id_to_revno_cache:
397
result = self._revision_id_to_revno_cache.get(revision_id)
399
raise errors.NoSuchRevision(self, revision_id)
400
# Try the mainline as it's optimised
402
revno = self.revision_id_to_revno(revision_id)
404
except errors.NoSuchRevision:
405
# We need to load and use the full revno map after all
406
result = self.get_revision_id_to_revno_map().get(revision_id)
408
raise errors.NoSuchRevision(self, revision_id)
411
def get_revision_id_to_revno_map(self):
412
"""Return the revision_id => dotted revno map.
414
This will be regenerated on demand, but will be cached.
416
:return: A dictionary mapping revision_id => dotted revno.
417
This dictionary should not be modified by the caller.
419
if 'evil' in debug.debug_flags:
421
3, "get_revision_id_to_revno_map scales with ancestry.")
422
with self.lock_read():
423
if self._revision_id_to_revno_cache is not None:
424
mapping = self._revision_id_to_revno_cache
426
mapping = self._gen_revno_map()
427
self._cache_revision_id_to_revno(mapping)
428
# TODO: jam 20070417 Since this is being cached, should we be
430
# I would rather not, and instead just declare that users should
431
# not modify the return value.
434
def _gen_revno_map(self):
435
"""Create a new mapping from revision ids to dotted revnos.
437
Dotted revnos are generated based on the current tip in the revision
439
This is the worker function for get_revision_id_to_revno_map, which
440
just caches the return value.
442
:return: A dictionary mapping revision_id => dotted revno.
444
revision_id_to_revno = {
445
rev_id: revno for rev_id, depth, revno, end_of_merge
446
in self.iter_merge_sorted_revisions()}
447
return revision_id_to_revno
449
def iter_merge_sorted_revisions(self, start_revision_id=None,
450
stop_revision_id=None,
451
stop_rule='exclude', direction='reverse'):
452
"""Walk the revisions for a branch in merge sorted order.
454
Merge sorted order is the output from a merge-aware,
455
topological sort, i.e. all parents come before their
456
children going forward; the opposite for reverse.
458
:param start_revision_id: the revision_id to begin walking from.
459
If None, the branch tip is used.
460
:param stop_revision_id: the revision_id to terminate the walk
461
after. If None, the rest of history is included.
462
:param stop_rule: if stop_revision_id is not None, the precise rule
463
to use for termination:
465
* 'exclude' - leave the stop revision out of the result (default)
466
* 'include' - the stop revision is the last item in the result
467
* 'with-merges' - include the stop revision and all of its
468
merged revisions in the result
469
* 'with-merges-without-common-ancestry' - filter out revisions
470
that are in both ancestries
471
:param direction: either 'reverse' or 'forward':
473
* reverse means return the start_revision_id first, i.e.
474
start at the most recent revision and go backwards in history
475
* forward returns tuples in the opposite order to reverse.
476
Note in particular that forward does *not* do any intelligent
477
ordering w.r.t. depth as some clients of this API may like.
478
(If required, that ought to be done at higher layers.)
480
:return: an iterator over (revision_id, depth, revno, end_of_merge)
483
* revision_id: the unique id of the revision
484
* depth: How many levels of merging deep this node has been
486
* revno_sequence: This field provides a sequence of
487
revision numbers for all revisions. The format is:
488
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
489
branch that the revno is on. From left to right the REVNO numbers
490
are the sequence numbers within that branch of the revision.
491
* end_of_merge: When True the next node (earlier in history) is
492
part of a different merge.
494
with self.lock_read():
495
# Note: depth and revno values are in the context of the branch so
496
# we need the full graph to get stable numbers, regardless of the
498
if self._merge_sorted_revisions_cache is None:
499
last_revision = self.last_revision()
500
known_graph = self.repository.get_known_graph_ancestry(
502
self._merge_sorted_revisions_cache = known_graph.merge_sort(
504
filtered = self._filter_merge_sorted_revisions(
505
self._merge_sorted_revisions_cache, start_revision_id,
506
stop_revision_id, stop_rule)
507
# Make sure we don't return revisions that are not part of the
508
# start_revision_id ancestry.
509
filtered = self._filter_start_non_ancestors(filtered)
510
if direction == 'reverse':
512
if direction == 'forward':
513
return reversed(list(filtered))
515
raise ValueError('invalid direction %r' % direction)
517
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
518
start_revision_id, stop_revision_id,
520
"""Iterate over an inclusive range of sorted revisions."""
521
rev_iter = iter(merge_sorted_revisions)
522
if start_revision_id is not None:
523
for node in rev_iter:
525
if rev_id != start_revision_id:
528
# The decision to include the start or not
529
# depends on the stop_rule if a stop is provided
530
# so pop this node back into the iterator
531
rev_iter = itertools.chain(iter([node]), rev_iter)
533
if stop_revision_id is None:
535
for node in rev_iter:
537
yield (rev_id, node.merge_depth, node.revno,
539
elif stop_rule == 'exclude':
540
for node in rev_iter:
542
if rev_id == stop_revision_id:
544
yield (rev_id, node.merge_depth, node.revno,
546
elif stop_rule == 'include':
547
for node in rev_iter:
549
yield (rev_id, node.merge_depth, node.revno,
551
if rev_id == stop_revision_id:
553
elif stop_rule == 'with-merges-without-common-ancestry':
554
# We want to exclude all revisions that are already part of the
555
# stop_revision_id ancestry.
556
graph = self.repository.get_graph()
557
ancestors = graph.find_unique_ancestors(start_revision_id,
559
for node in rev_iter:
561
if rev_id not in ancestors:
563
yield (rev_id, node.merge_depth, node.revno,
565
elif stop_rule == 'with-merges':
566
stop_rev = self.repository.get_revision(stop_revision_id)
567
if stop_rev.parent_ids:
568
left_parent = stop_rev.parent_ids[0]
570
left_parent = _mod_revision.NULL_REVISION
571
# left_parent is the actual revision we want to stop logging at,
572
# since we want to show the merged revisions after the stop_rev too
573
reached_stop_revision_id = False
574
revision_id_whitelist = []
575
for node in rev_iter:
577
if rev_id == left_parent:
578
# reached the left parent after the stop_revision
580
if (not reached_stop_revision_id
581
or rev_id in revision_id_whitelist):
582
yield (rev_id, node.merge_depth, node.revno,
584
if reached_stop_revision_id or rev_id == stop_revision_id:
585
# only do the merged revs of rev_id from now on
586
rev = self.repository.get_revision(rev_id)
588
reached_stop_revision_id = True
589
revision_id_whitelist.extend(rev.parent_ids)
591
raise ValueError('invalid stop_rule %r' % stop_rule)
593
def _filter_start_non_ancestors(self, rev_iter):
594
# If we started from a dotted revno, we want to consider it as a tip
595
# and don't want to yield revisions that are not part of its
596
# ancestry. Given the order guaranteed by the merge sort, we will see
597
# uninteresting descendants of the first parent of our tip before the
600
first = next(rev_iter)
601
except StopIteration:
603
(rev_id, merge_depth, revno, end_of_merge) = first
606
# We start at a mainline revision so by definition, all others
607
# revisions in rev_iter are ancestors
608
for node in rev_iter:
613
pmap = self.repository.get_parent_map([rev_id])
614
parents = pmap.get(rev_id, [])
616
whitelist.update(parents)
618
# If there is no parents, there is nothing of interest left
620
# FIXME: It's hard to test this scenario here as this code is never
621
# called in that case. -- vila 20100322
624
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
626
if rev_id in whitelist:
627
pmap = self.repository.get_parent_map([rev_id])
628
parents = pmap.get(rev_id, [])
629
whitelist.remove(rev_id)
630
whitelist.update(parents)
632
# We've reached the mainline, there is nothing left to
636
# A revision that is not part of the ancestry of our
639
yield (rev_id, merge_depth, revno, end_of_merge)
641
def leave_lock_in_place(self):
642
"""Tell this branch object not to release the physical lock when this
645
If lock_write doesn't return a token, then this method is not
648
self.control_files.leave_in_place()
650
def dont_leave_lock_in_place(self):
651
"""Tell this branch object to release the physical lock when this
652
object is unlocked, even if it didn't originally acquire it.
654
If lock_write doesn't return a token, then this method is not
657
self.control_files.dont_leave_in_place()
171
def abspath(self, name):
172
"""Return absolute filename for something in the branch
174
XXX: Robert Collins 20051017 what is this used for? why is it a branch
175
method and not a tree method.
177
raise NotImplementedError('abspath is abstract')
659
179
def bind(self, other):
660
180
"""Bind the local branch the other branch.
1187
423
self.check_real_revno(revno)
1189
425
def check_real_revno(self, revno):
1191
427
Check whether a revno corresponds to a real revision.
1192
428
Zero (the NULL revision) is considered invalid
1194
430
if revno < 1 or revno > self.revno():
1195
raise errors.InvalidRevisionNumber(revno)
1197
def clone(self, to_controldir, revision_id=None, name=None,
1198
repository_policy=None, tag_selector=None):
1199
"""Clone this branch into to_controldir preserving all semantic values.
1201
Most API users will want 'create_clone_on_transport', which creates a
1202
new bzrdir and branch on the fly.
1204
revision_id: if not None, the revision history in the new branch will
1205
be truncated to end with revision_id.
1207
result = to_controldir.create_branch(name=name)
1208
with self.lock_read(), result.lock_write():
1209
if repository_policy is not None:
1210
repository_policy.configure_branch(result)
1211
self.copy_content_into(
1212
result, revision_id=revision_id, tag_selector=tag_selector)
1215
def sprout(self, to_controldir, revision_id=None, repository_policy=None,
1216
repository=None, lossy=False, tag_selector=None):
1217
"""Create a new line of development from the branch, into to_controldir.
1219
to_controldir controls the branch format.
1221
revision_id: if not None, the revision history in the new branch will
1222
be truncated to end with revision_id.
1224
if (repository_policy is not None
1225
and repository_policy.requires_stacking()):
1226
to_controldir._format.require_stacking(_skip_repo=True)
1227
result = to_controldir.create_branch(repository=repository)
1229
raise errors.LossyPushToSameVCS(self, result)
1230
with self.lock_read(), result.lock_write():
1231
if repository_policy is not None:
1232
repository_policy.configure_branch(result)
1233
self.copy_content_into(
1234
result, revision_id=revision_id, tag_selector=tag_selector)
1235
master_url = self.get_bound_location()
1236
if master_url is None:
1237
result.set_parent(self.user_url)
1239
result.set_parent(master_url)
1242
def _synchronize_history(self, destination, revision_id):
1243
"""Synchronize last revision and revision history between branches.
1245
This version is most efficient when the destination is also a
1246
BzrBranch6, but works for BzrBranch5, as long as the destination's
1247
repository contains all the lefthand ancestors of the intended
1248
last_revision. If not, set_last_revision_info will fail.
1250
:param destination: The branch to copy the history into
1251
:param revision_id: The revision-id to truncate history at. May
1252
be None to copy complete history.
1254
source_revno, source_revision_id = self.last_revision_info()
1255
if revision_id is None:
1256
revno, revision_id = source_revno, source_revision_id
1258
graph = self.repository.get_graph()
1260
revno = graph.find_distance_to_null(
1261
revision_id, [(source_revision_id, source_revno)])
1262
except errors.GhostRevisionsHaveNoRevno:
1263
# Default to 1, if we can't find anything else
1265
destination.set_last_revision_info(revno, revision_id)
1267
def copy_content_into(self, destination, revision_id=None, tag_selector=None):
431
raise InvalidRevisionNumber(revno)
434
def clone(self, *args, **kwargs):
435
"""Clone this branch into to_bzrdir preserving all semantic values.
437
revision_id: if not None, the revision history in the new branch will
438
be truncated to end with revision_id.
440
# for API compatability, until 0.8 releases we provide the old api:
441
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
442
# after 0.8 releases, the *args and **kwargs should be changed:
443
# def clone(self, to_bzrdir, revision_id=None):
444
if (kwargs.get('to_location', None) or
445
kwargs.get('revision', None) or
446
kwargs.get('basis_branch', None) or
447
(len(args) and isinstance(args[0], basestring))):
448
# backwards compatability api:
449
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
450
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
453
basis_branch = args[2]
455
basis_branch = kwargs.get('basis_branch', None)
457
basis = basis_branch.bzrdir
462
revision_id = args[1]
464
revision_id = kwargs.get('revision', None)
469
# no default to raise if not provided.
470
url = kwargs.get('to_location')
471
return self.bzrdir.clone(url,
472
revision_id=revision_id,
473
basis=basis).open_branch()
475
# generate args by hand
477
revision_id = args[1]
479
revision_id = kwargs.get('revision_id', None)
483
# no default to raise if not provided.
484
to_bzrdir = kwargs.get('to_bzrdir')
485
result = self._format.initialize(to_bzrdir)
486
self.copy_content_into(result, revision_id=revision_id)
490
def sprout(self, to_bzrdir, revision_id=None):
491
"""Create a new line of development from the branch, into to_bzrdir.
493
revision_id: if not None, the revision history in the new branch will
494
be truncated to end with revision_id.
496
result = self._format.initialize(to_bzrdir)
497
self.copy_content_into(result, revision_id=revision_id)
498
result.set_parent(self.bzrdir.root_transport.base)
502
def copy_content_into(self, destination, revision_id=None):
1268
503
"""Copy the content of self into destination.
1270
505
revision_id: if not None, the revision history in the new branch will
1271
506
be truncated to end with revision_id.
1272
tag_selector: Optional callback that receives a tag name
1273
and should return a boolean to indicate whether a tag should be copied
1275
return InterBranch.get(self, destination).copy_content_into(
1276
revision_id=revision_id, tag_selector=tag_selector)
1278
def update_references(self, target):
1279
if not self._format.supports_reference_locations:
1281
return InterBranch.get(self, target).update_references()
1283
def check(self, refs):
1284
"""Check consistency of the branch.
1286
In particular this checks that revisions given in the revision-history
1287
do actually match up in the revision graph, and that they're all
1288
present in the repository.
1290
Callers will typically also want to check the repository.
1292
:param refs: Calculated refs for this branch as specified by
1293
branch._get_check_refs()
1294
:return: A BranchCheckResult.
1296
with self.lock_read():
1297
result = BranchCheckResult(self)
1298
last_revno, last_revision_id = self.last_revision_info()
1299
actual_revno = refs[('lefthand-distance', last_revision_id)]
1300
if actual_revno != last_revno:
1301
result.errors.append(errors.BzrCheckError(
1302
'revno does not match len(mainline) %s != %s' % (
1303
last_revno, actual_revno)))
1304
# TODO: We should probably also check that self.revision_history
1305
# matches the repository for older branch formats.
1306
# If looking for the code that cross-checks repository parents
1307
# against the Graph.iter_lefthand_ancestry output, that is now a
1308
# repository specific check.
1311
def _get_checkout_format(self, lightweight=False):
1312
"""Return the most suitable metadir for a checkout of this branch.
1313
Weaves are used if this branch's repository uses weaves.
1315
format = self.repository.controldir.checkout_metadir()
1316
format.set_branch_format(self._format)
1319
def create_clone_on_transport(self, to_transport, revision_id=None,
1320
stacked_on=None, create_prefix=False,
1321
use_existing_dir=False, no_tree=None,
1323
"""Create a clone of this branch and its bzrdir.
1325
:param to_transport: The transport to clone onto.
1326
:param revision_id: The revision id to use as tip in the new branch.
1327
If None the tip is obtained from this branch.
1328
:param stacked_on: An optional URL to stack the clone on.
1329
:param create_prefix: Create any missing directories leading up to
1331
:param use_existing_dir: Use an existing directory if one exists.
1333
# XXX: Fix the bzrdir API to allow getting the branch back from the
1334
# clone call. Or something. 20090224 RBC/spiv.
1335
# XXX: Should this perhaps clone colocated branches as well,
1336
# rather than just the default branch? 20100319 JRV
1337
if revision_id is None:
1338
revision_id = self.last_revision()
1339
dir_to = self.controldir.clone_on_transport(
1340
to_transport, revision_id=revision_id, stacked_on=stacked_on,
1341
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1342
no_tree=no_tree, tag_selector=tag_selector)
1343
return dir_to.open_branch()
1345
def create_checkout(self, to_location, revision_id=None,
1346
lightweight=False, accelerator_tree=None,
1347
hardlink=False, recurse_nested=True):
1348
"""Create a checkout of a branch.
1350
:param to_location: The url to produce the checkout at
1351
:param revision_id: The revision to check out
1352
:param lightweight: If True, produce a lightweight checkout, otherwise,
1353
produce a bound branch (heavyweight checkout)
1354
:param accelerator_tree: A tree which can be used for retrieving file
1355
contents more quickly than the revision tree, i.e. a workingtree.
1356
The revision tree will be used for cases where accelerator_tree's
1357
content is different.
1358
:param hardlink: If true, hard-link files from accelerator_tree,
1360
:param recurse_nested: Whether to recurse into nested trees
1361
:return: The tree of the created checkout
1363
t = transport.get_transport(to_location)
1365
format = self._get_checkout_format(lightweight=lightweight)
1367
checkout = format.initialize_on_transport(t)
1368
except errors.AlreadyControlDirError:
1369
# It's fine if the control directory already exists,
1370
# as long as there is no existing branch and working tree.
1371
checkout = controldir.ControlDir.open_from_transport(t)
1373
checkout.open_branch()
1374
except errors.NotBranchError:
1377
raise errors.AlreadyControlDirError(t.base)
1378
if (checkout.control_transport.base
1379
== self.controldir.control_transport.base):
1380
# When checking out to the same control directory,
1381
# always create a lightweight checkout
1385
from_branch = checkout.set_branch_reference(target_branch=self)
1387
policy = checkout.determine_repository_policy()
1388
policy.acquire_repository()
1389
checkout_branch = checkout.create_branch()
1390
checkout_branch.bind(self)
1391
# pull up to the specified revision_id to set the initial
1392
# branch tip correctly, and seed it with history.
1393
checkout_branch.pull(self, stop_revision=revision_id)
1395
tree = checkout.create_workingtree(revision_id,
1396
from_branch=from_branch,
1397
accelerator_tree=accelerator_tree,
1399
basis_tree = tree.basis_tree()
1400
with basis_tree.lock_read():
1401
for path in basis_tree.iter_references():
1402
reference_parent = tree.reference_parent(path)
1403
if reference_parent is None:
1404
warning('Branch location for %s unknown.', path)
1406
reference_parent.create_checkout(
1408
basis_tree.get_reference_revision(path), lightweight)
1411
def reconcile(self, thorough=True):
1412
"""Make sure the data stored in this branch is consistent.
1414
:return: A `ReconcileResult` object.
1416
raise NotImplementedError(self.reconcile)
1418
def supports_tags(self):
1419
return self._format.supports_tags()
1421
def automatic_tag_name(self, revision_id):
1422
"""Try to automatically find the tag name for a revision.
1424
:param revision_id: Revision id of the revision.
1425
:return: A tag name or None if no tag name could be determined.
1427
for hook in Branch.hooks['automatic_tag_name']:
1428
ret = hook(self, revision_id)
1433
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1435
"""Ensure that revision_b is a descendant of revision_a.
1437
This is a helper function for update_revisions.
1439
:raises: DivergedBranches if revision_b has diverged from revision_a.
1440
:returns: True if revision_b is a descendant of revision_a.
1442
relation = self._revision_relations(revision_a, revision_b, graph)
1443
if relation == 'b_descends_from_a':
1445
elif relation == 'diverged':
1446
raise errors.DivergedBranches(self, other_branch)
1447
elif relation == 'a_descends_from_b':
1450
raise AssertionError("invalid relation: %r" % (relation,))
1452
def _revision_relations(self, revision_a, revision_b, graph):
1453
"""Determine the relationship between two revisions.
1455
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1457
heads = graph.heads([revision_a, revision_b])
1458
if heads == {revision_b}:
1459
return 'b_descends_from_a'
1460
elif heads == {revision_a, revision_b}:
1461
# These branches have diverged
1463
elif heads == {revision_a}:
1464
return 'a_descends_from_b'
1466
raise AssertionError("invalid heads: %r" % (heads,))
1468
def heads_to_fetch(self):
1469
"""Return the heads that must and that should be fetched to copy this
1470
branch into another repo.
1472
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1473
set of heads that must be fetched. if_present_fetch is a set of
1474
heads that must be fetched if present, but no error is necessary if
1475
they are not present.
1477
# For bzr native formats must_fetch is just the tip, and
1478
# if_present_fetch are the tags.
1479
must_fetch = {self.last_revision()}
1480
if_present_fetch = set()
1481
if self.get_config_stack().get('branch.fetch_tags'):
1483
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1484
except errors.TagsNotSupported:
1486
must_fetch.discard(_mod_revision.NULL_REVISION)
1487
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1488
return must_fetch, if_present_fetch
1490
def create_memorytree(self):
1491
"""Create a memory tree for this branch.
1493
:return: An in-memory MutableTree instance
1495
return memorytree.MemoryTree.create_on_branch(self)
1498
class BranchFormat(controldir.ControlComponentFormat):
508
new_history = self.revision_history()
509
if revision_id is not None:
511
new_history = new_history[:new_history.index(revision_id) + 1]
513
rev = self.repository.get_revision(revision_id)
514
new_history = rev.get_history(self.repository)[1:]
515
destination.set_revision_history(new_history)
516
parent = self.get_parent()
518
destination.set_parent(parent)
521
class BranchFormat(object):
1499
522
"""An encapsulation of the initialization and open routines for a format.
1501
524
Formats provide three things:
1502
525
* An initialization routine,
1503
* a format description
1504
527
* an open routine.
1506
Formats are placed in an dict by their format string for reference
1507
during branch opening. It's not required that these be instances, they
1508
can be classes themselves with class methods - it simply depends on
529
Formats are placed in an dict by their format string for reference
530
during branch opening. Its not required that these be instances, they
531
can be classes themselves with class methods - it simply depends on
1509
532
whether state is needed for a given format or not.
1511
534
Once a format is deprecated, just deprecate the initialize and open
1512
methods on the format class. Do not deprecate the object, as the
535
methods on the format class. Do not deprecate the object, as the
1513
536
object will be created every time regardless.
1516
def __eq__(self, other):
1517
return self.__class__ is other.__class__
1519
def __ne__(self, other):
1520
return not (self == other)
1522
def get_reference(self, controldir, name=None):
1523
"""Get the target reference of the branch in controldir.
1525
format probing must have been completed before calling
1526
this method - it is assumed that the format of the branch
1527
in controldir is correct.
1529
:param controldir: The controldir to get the branch data from.
1530
:param name: Name of the colocated branch to fetch
1531
:return: None if the branch is not a reference branch.
1536
def set_reference(self, controldir, name, to_branch):
1537
"""Set the target reference of the branch in controldir.
1539
format probing must have been completed before calling
1540
this method - it is assumed that the format of the branch
1541
in controldir is correct.
1543
:param controldir: The controldir to set the branch reference for.
1544
:param name: Name of colocated branch to set, None for default
1545
:param to_branch: branch that the checkout is to reference
1547
raise NotImplementedError(self.set_reference)
539
_default_format = None
540
"""The default format used for new branches."""
543
"""The known formats."""
546
def find_format(klass, a_bzrdir):
547
"""Return the format for the branch object in a_bzrdir."""
549
transport = a_bzrdir.get_branch_transport(None)
550
format_string = transport.get("format").read()
551
return klass._formats[format_string]
553
raise NotBranchError(path=transport.base)
555
raise errors.UnknownFormatError(format_string)
558
def get_default_format(klass):
559
"""Return the current default format."""
560
return klass._default_format
562
def get_format_string(self):
563
"""Return the ASCII format string that identifies this format."""
564
raise NotImplementedError(self.get_format_string)
1549
566
def get_format_description(self):
1550
567
"""Return the short format description for this format."""
1551
raise NotImplementedError(self.get_format_description)
1553
def _run_post_branch_init_hooks(self, controldir, name, branch):
1554
hooks = Branch.hooks['post_branch_init']
1557
params = BranchInitHookParams(self, controldir, name, branch)
1561
def initialize(self, controldir, name=None, repository=None,
1562
append_revisions_only=None):
1563
"""Create a branch of this format in controldir.
1565
:param name: Name of the colocated branch to create.
1567
raise NotImplementedError(self.initialize)
568
raise NotImplementedError(self.get_format_string)
570
def initialize(self, a_bzrdir):
571
"""Create a branch of this format in a_bzrdir."""
572
raise NotImplementedError(self.initialized)
1569
574
def is_supported(self):
1570
575
"""Is this format supported?
1572
577
Supported formats can be initialized and opened.
1573
Unsupported formats may not support initialization or committing or
578
Unsupported formats may not support initialization or committing or
1574
579
some other features depending on the reason for not being supported.
1578
def make_tags(self, branch):
1579
"""Create a tags object for branch.
1581
This method is on BranchFormat, because BranchFormats are reflected
1582
over the wire via network_name(), whereas full Branch instances require
1583
multiple VFS method calls to operate at all.
1585
The default implementation returns a disabled-tags instance.
1587
Note that it is normal for branch to be a RemoteBranch when using tags
1590
return _mod_tag.DisabledTags(branch)
1592
def network_name(self):
1593
"""A simple byte string uniquely identifying this format for RPC calls.
1595
MetaDir branch formats use their disk format string to identify the
1596
repository over the wire. All in one formats such as bzr < 0.8, and
1597
foreign formats like svn/git and hg should use some marker which is
1598
unique and immutable.
1600
raise NotImplementedError(self.network_name)
1602
def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1603
found_repository=None, possible_transports=None):
1604
"""Return the branch object for controldir.
1606
:param controldir: A ControlDir that contains a branch.
1607
:param name: Name of colocated branch to open
1608
:param _found: a private parameter, do not use it. It is used to
1609
indicate if format probing has already be done.
1610
:param ignore_fallbacks: when set, no fallback branches will be opened
1611
(if there are any). Default is to open fallbacks.
583
def open(self, a_bzrdir, _found=False):
584
"""Return the branch object for a_bzrdir
586
_found is a private parameter, do not use it. It is used to indicate
587
if format probing has already be done.
1613
589
raise NotImplementedError(self.open)
1615
def supports_set_append_revisions_only(self):
1616
"""True if this format supports set_append_revisions_only."""
1619
def supports_stacking(self):
1620
"""True if this format records a stacked-on branch."""
1623
def supports_leaving_lock(self):
1624
"""True if this format supports leaving locks in place."""
1625
return False # by default
1628
return self.get_format_description().rstrip()
1630
def supports_tags(self):
1631
"""True if this format supports tags stored in the branch"""
1632
return False # by default
1634
def tags_are_versioned(self):
1635
"""Whether the tag container for this branch versions tags."""
1638
def supports_tags_referencing_ghosts(self):
1639
"""True if tags can reference ghost revisions."""
1642
def supports_store_uncommitted(self):
1643
"""True if uncommitted changes can be stored in this branch."""
1646
def stores_revno(self):
1647
"""True if this branch format store revision numbers."""
1651
class BranchHooks(Hooks):
1652
"""A dictionary mapping hook name to a list of callables for branch hooks.
1654
e.g. ['post_push'] Is the list of items to be called when the
1655
push function is invoked.
1659
"""Create the default hooks.
1661
These are all empty initially, because by default nothing should get
1664
Hooks.__init__(self, "breezy.branch", "Branch.hooks")
1667
"Called with the Branch object that has been opened after a "
1668
"branch is opened.", (1, 8))
1671
"Called after a push operation completes. post_push is called "
1672
"with a breezy.branch.BranchPushResult object and only runs in "
1673
"the bzr client.", (0, 15))
1676
"Called after a pull operation completes. post_pull is called "
1677
"with a breezy.branch.PullResult object and only runs in the "
1678
"bzr client.", (0, 15))
1681
"Called after a commit is calculated but before it is "
1682
"completed. pre_commit is called with (local, master, old_revno, "
1683
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1684
"). old_revid is NULL_REVISION for the first commit to a branch, "
1685
"tree_delta is a TreeDelta object describing changes from the "
1686
"basis revision. hooks MUST NOT modify this delta. "
1687
" future_tree is an in-memory tree obtained from "
1688
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1692
"Called in the bzr client after a commit has completed. "
1693
"post_commit is called with (local, master, old_revno, old_revid, "
1694
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1695
"commit to a branch.", (0, 15))
1698
"Called in the bzr client after an uncommit completes. "
1699
"post_uncommit is called with (local, master, old_revno, "
1700
"old_revid, new_revno, new_revid) where local is the local branch "
1701
"or None, master is the target branch, and an empty branch "
1702
"receives new_revno of 0, new_revid of None.", (0, 15))
1704
'pre_change_branch_tip',
1705
"Called in bzr client and server before a change to the tip of a "
1706
"branch is made. pre_change_branch_tip is called with a "
1707
"breezy.branch.ChangeBranchTipParams. Note that push, pull, "
1708
"commit, uncommit will all trigger this hook.", (1, 6))
1710
'post_change_branch_tip',
1711
"Called in bzr client and server after a change to the tip of a "
1712
"branch is made. post_change_branch_tip is called with a "
1713
"breezy.branch.ChangeBranchTipParams. Note that push, pull, "
1714
"commit, uncommit will all trigger this hook.", (1, 4))
1716
'transform_fallback_location',
1717
"Called when a stacked branch is activating its fallback "
1718
"locations. transform_fallback_location is called with (branch, "
1719
"url), and should return a new url. Returning the same url "
1720
"allows it to be used as-is, returning a different one can be "
1721
"used to cause the branch to stack on a closer copy of that "
1722
"fallback_location. Note that the branch cannot have history "
1723
"accessing methods called on it during this hook because the "
1724
"fallback locations have not been activated. When there are "
1725
"multiple hooks installed for transform_fallback_location, "
1726
"all are called with the url returned from the previous hook."
1727
"The order is however undefined.", (1, 9))
1729
'automatic_tag_name',
1730
"Called to determine an automatic tag name for a revision. "
1731
"automatic_tag_name is called with (branch, revision_id) and "
1732
"should return a tag name or None if no tag name could be "
1733
"determined. The first non-None tag name returned will be used.",
1737
"Called after new branch initialization completes. "
1738
"post_branch_init is called with a "
1739
"breezy.branch.BranchInitHookParams. "
1740
"Note that init, branch and checkout (both heavyweight and "
1741
"lightweight) will all trigger this hook.", (2, 2))
1744
"Called after a checkout switches branch. "
1745
"post_switch is called with a "
1746
"breezy.branch.SwitchHookParams.", (2, 2))
1749
# install the default hooks into the Branch class.
1750
Branch.hooks = BranchHooks()
1753
class ChangeBranchTipParams(object):
1754
"""Object holding parameters passed to `*_change_branch_tip` hooks.
1756
There are 5 fields that hooks may wish to access:
1758
:ivar branch: the branch being changed
1759
:ivar old_revno: revision number before the change
1760
:ivar new_revno: revision number after the change
1761
:ivar old_revid: revision id before the change
1762
:ivar new_revid: revision id after the change
1764
The revid fields are strings. The revno fields are integers.
1767
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1768
"""Create a group of ChangeBranchTip parameters.
1770
:param branch: The branch being changed.
1771
:param old_revno: Revision number before the change.
1772
:param new_revno: Revision number after the change.
1773
:param old_revid: Tip revision id before the change.
1774
:param new_revid: Tip revision id after the change.
1776
self.branch = branch
1777
self.old_revno = old_revno
1778
self.new_revno = new_revno
1779
self.old_revid = old_revid
1780
self.new_revid = new_revid
1782
def __eq__(self, other):
1783
return self.__dict__ == other.__dict__
1786
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1787
self.__class__.__name__, self.branch,
1788
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1791
class BranchInitHookParams(object):
1792
"""Object holding parameters passed to `*_branch_init` hooks.
1794
There are 4 fields that hooks may wish to access:
1796
:ivar format: the branch format
1797
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1798
:ivar name: name of colocated branch, if any (or None)
1799
:ivar branch: the branch created
1801
Note that for lightweight checkouts, the bzrdir and format fields refer to
1802
the checkout, hence they are different from the corresponding fields in
1803
branch, which refer to the original branch.
1806
def __init__(self, format, controldir, name, branch):
1807
"""Create a group of BranchInitHook parameters.
1809
:param format: the branch format
1810
:param controldir: the ControlDir where the branch will be/has been
1812
:param name: name of colocated branch, if any (or None)
1813
:param branch: the branch created
1815
Note that for lightweight checkouts, the bzrdir and format fields refer
1816
to the checkout, hence they are different from the corresponding fields
1817
in branch, which refer to the original branch.
1819
self.format = format
1820
self.controldir = controldir
1822
self.branch = branch
1824
def __eq__(self, other):
1825
return self.__dict__ == other.__dict__
1828
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1831
class SwitchHookParams(object):
1832
"""Object holding parameters passed to `*_switch` hooks.
1834
There are 4 fields that hooks may wish to access:
1836
:ivar control_dir: ControlDir of the checkout to change
1837
:ivar to_branch: branch that the checkout is to reference
1838
:ivar force: skip the check for local commits in a heavy checkout
1839
:ivar revision_id: revision ID to switch to (or None)
1842
def __init__(self, control_dir, to_branch, force, revision_id):
1843
"""Create a group of SwitchHook parameters.
1845
:param control_dir: ControlDir of the checkout to change
1846
:param to_branch: branch that the checkout is to reference
1847
:param force: skip the check for local commits in a heavy checkout
1848
:param revision_id: revision ID to switch to (or None)
1850
self.control_dir = control_dir
1851
self.to_branch = to_branch
1853
self.revision_id = revision_id
1855
def __eq__(self, other):
1856
return self.__dict__ == other.__dict__
1859
return "<%s for %s to (%s, %s)>" % (
1860
self.__class__.__name__, self.control_dir, self.to_branch,
1864
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
1865
"""Branch format registry."""
1867
def __init__(self, other_registry=None):
1868
super(BranchFormatRegistry, self).__init__(other_registry)
1869
self._default_format = None
1870
self._default_format_key = None
1872
def get_default(self):
1873
"""Return the current default format."""
1874
if (self._default_format_key is not None
1875
and self._default_format is None):
1876
self._default_format = self.get(self._default_format_key)
1877
return self._default_format
1879
def set_default(self, format):
1880
"""Set the default format."""
1881
self._default_format = format
1882
self._default_format_key = None
1884
def set_default_key(self, format_string):
1885
"""Set the default format by its format string."""
1886
self._default_format_key = format_string
1887
self._default_format = None
1890
network_format_registry = registry.FormatRegistry()
1891
"""Registry of formats indexed by their network name.
1893
The network name for a branch format is an identifier that can be used when
1894
referring to formats with smart server operations. See
1895
BranchFormat.network_name() for more detail.
1898
format_registry = BranchFormatRegistry(network_format_registry)
592
def register_format(klass, format):
593
klass._formats[format.get_format_string()] = format
596
def set_default_format(klass, format):
597
klass._default_format = format
600
def unregister_format(klass, format):
601
assert klass._formats[format.get_format_string()] is format
602
del klass._formats[format.get_format_string()]
605
return self.get_format_string().rstrip()
608
class BzrBranchFormat4(BranchFormat):
609
"""Bzr branch format 4.
612
- a revision-history file.
613
- a branch-lock lock file [ to be shared with the bzrdir ]
616
def get_format_description(self):
617
"""See BranchFormat.get_format_description()."""
618
return "Branch format 4"
620
def initialize(self, a_bzrdir):
621
"""Create a branch of this format in a_bzrdir."""
622
mutter('creating branch in %s', a_bzrdir.transport.base)
623
branch_transport = a_bzrdir.get_branch_transport(self)
624
utf8_files = [('revision-history', ''),
627
control_files = LockableFiles(branch_transport, 'branch-lock',
629
control_files.create_lock()
630
control_files.lock_write()
632
for file, content in utf8_files:
633
control_files.put_utf8(file, content)
635
control_files.unlock()
636
return self.open(a_bzrdir, _found=True)
639
super(BzrBranchFormat4, self).__init__()
640
self._matchingbzrdir = bzrdir.BzrDirFormat6()
642
def open(self, a_bzrdir, _found=False):
643
"""Return the branch object for a_bzrdir
645
_found is a private parameter, do not use it. It is used to indicate
646
if format probing has already be done.
649
# we are being called directly and must probe.
650
raise NotImplementedError
651
return BzrBranch(_format=self,
652
_control_files=a_bzrdir._control_files,
654
_repository=a_bzrdir.open_repository())
657
return "Bazaar-NG branch format 4"
660
class BzrBranchFormat5(BranchFormat):
661
"""Bzr branch format 5.
664
- a revision-history file.
666
- a lock dir guarding the branch itself
667
- all of this stored in a branch/ subdirectory
668
- works with shared repositories.
670
This format is new in bzr 0.8.
673
def get_format_string(self):
674
"""See BranchFormat.get_format_string()."""
675
return "Bazaar-NG branch format 5\n"
677
def get_format_description(self):
678
"""See BranchFormat.get_format_description()."""
679
return "Branch format 5"
681
def initialize(self, a_bzrdir):
682
"""Create a branch of this format in a_bzrdir."""
683
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
684
branch_transport = a_bzrdir.get_branch_transport(self)
685
utf8_files = [('revision-history', ''),
688
control_files = LockableFiles(branch_transport, 'lock', LockDir)
689
control_files.create_lock()
690
control_files.lock_write()
691
control_files.put_utf8('format', self.get_format_string())
693
for file, content in utf8_files:
694
control_files.put_utf8(file, content)
696
control_files.unlock()
697
return self.open(a_bzrdir, _found=True, )
700
super(BzrBranchFormat5, self).__init__()
701
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
703
def open(self, a_bzrdir, _found=False):
704
"""Return the branch object for a_bzrdir
706
_found is a private parameter, do not use it. It is used to indicate
707
if format probing has already be done.
710
format = BranchFormat.find_format(a_bzrdir)
711
assert format.__class__ == self.__class__
712
transport = a_bzrdir.get_branch_transport(None)
713
control_files = LockableFiles(transport, 'lock', LockDir)
714
return BzrBranch5(_format=self,
715
_control_files=control_files,
717
_repository=a_bzrdir.find_repository())
720
return "Bazaar-NG Metadir branch format 5"
723
class BranchReferenceFormat(BranchFormat):
724
"""Bzr branch reference format.
726
Branch references are used in implementing checkouts, they
727
act as an alias to the real branch which is at some other url.
734
def get_format_string(self):
735
"""See BranchFormat.get_format_string()."""
736
return "Bazaar-NG Branch Reference Format 1\n"
738
def get_format_description(self):
739
"""See BranchFormat.get_format_description()."""
740
return "Checkout reference format 1"
742
def initialize(self, a_bzrdir, target_branch=None):
743
"""Create a branch of this format in a_bzrdir."""
744
if target_branch is None:
745
# this format does not implement branch itself, thus the implicit
746
# creation contract must see it as uninitializable
747
raise errors.UninitializableFormat(self)
748
mutter('creating branch reference in %s', a_bzrdir.transport.base)
749
branch_transport = a_bzrdir.get_branch_transport(self)
750
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
751
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
752
branch_transport.put('format', StringIO(self.get_format_string()))
753
return self.open(a_bzrdir, _found=True)
756
super(BranchReferenceFormat, self).__init__()
757
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
759
def _make_reference_clone_function(format, a_branch):
760
"""Create a clone() routine for a branch dynamically."""
761
def clone(to_bzrdir, revision_id=None):
762
"""See Branch.clone()."""
763
return format.initialize(to_bzrdir, a_branch)
764
# cannot obey revision_id limits when cloning a reference ...
765
# FIXME RBC 20060210 either nuke revision_id for clone, or
766
# emit some sort of warning/error to the caller ?!
769
def open(self, a_bzrdir, _found=False):
770
"""Return the branch that the branch reference in a_bzrdir points at.
772
_found is a private parameter, do not use it. It is used to indicate
773
if format probing has already be done.
776
format = BranchFormat.find_format(a_bzrdir)
777
assert format.__class__ == self.__class__
778
transport = a_bzrdir.get_branch_transport(None)
779
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
780
result = real_bzrdir.open_branch()
781
# this changes the behaviour of result.clone to create a new reference
782
# rather than a copy of the content of the branch.
783
# I did not use a proxy object because that needs much more extensive
784
# testing, and we are only changing one behaviour at the moment.
785
# If we decide to alter more behaviours - i.e. the implicit nickname
786
# then this should be refactored to introduce a tested proxy branch
787
# and a subclass of that for use in overriding clone() and ....
789
result.clone = self._make_reference_clone_function(result)
1901
793
# formats which have no format string are not discoverable
1902
794
# and not independently creatable, so are not registered.
1903
format_registry.register_lazy(
1904
b"Bazaar-NG branch format 5\n", "breezy.bzr.fullhistory",
1906
format_registry.register_lazy(
1907
b"Bazaar Branch Format 6 (bzr 0.15)\n",
1908
"breezy.bzr.branch", "BzrBranchFormat6")
1909
format_registry.register_lazy(
1910
b"Bazaar Branch Format 7 (needs bzr 1.6)\n",
1911
"breezy.bzr.branch", "BzrBranchFormat7")
1912
format_registry.register_lazy(
1913
b"Bazaar Branch Format 8 (needs bzr 1.15)\n",
1914
"breezy.bzr.branch", "BzrBranchFormat8")
1915
format_registry.register_lazy(
1916
b"Bazaar-NG Branch Reference Format 1\n",
1917
"breezy.bzr.branch", "BranchReferenceFormat")
1919
format_registry.set_default_key(b"Bazaar Branch Format 7 (needs bzr 1.6)\n")
1922
class BranchWriteLockResult(LogicalLockResult):
1923
"""The result of write locking a branch.
1925
:ivar token: The token obtained from the underlying branch lock, or
1927
:ivar unlock: A callable which will unlock the lock.
1931
return "BranchWriteLockResult(%r, %r)" % (self.unlock, self.token)
1934
######################################################################
1935
# results of operations
1938
class _Result(object):
1940
def _show_tag_conficts(self, to_file):
1941
if not getattr(self, 'tag_conflicts', None):
1943
to_file.write('Conflicting tags:\n')
1944
for name, value1, value2 in self.tag_conflicts:
1945
to_file.write(' %s\n' % (name, ))
1948
class PullResult(_Result):
1949
"""Result of a Branch.pull operation.
1951
:ivar old_revno: Revision number before pull.
1952
:ivar new_revno: Revision number after pull.
1953
:ivar old_revid: Tip revision id before pull.
1954
:ivar new_revid: Tip revision id after pull.
1955
:ivar source_branch: Source (local) branch object. (read locked)
1956
:ivar master_branch: Master branch of the target, or the target if no
1958
:ivar local_branch: target branch if there is a Master, else None
1959
:ivar target_branch: Target/destination branch object. (write locked)
1960
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
1961
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
1964
def report(self, to_file):
1965
tag_conflicts = getattr(self, "tag_conflicts", None)
1966
tag_updates = getattr(self, "tag_updates", None)
1968
if self.old_revid != self.new_revid:
1969
to_file.write('Now on revision %d.\n' % self.new_revno)
1971
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
1972
if self.old_revid == self.new_revid and not tag_updates:
1973
if not tag_conflicts:
1974
to_file.write('No revisions or tags to pull.\n')
1976
to_file.write('No revisions to pull.\n')
1977
self._show_tag_conficts(to_file)
1980
class BranchPushResult(_Result):
1981
"""Result of a Branch.push operation.
1983
:ivar old_revno: Revision number (eg 10) of the target before push.
1984
:ivar new_revno: Revision number (eg 12) of the target after push.
1985
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
1987
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
1989
:ivar source_branch: Source branch object that the push was from. This is
1990
read locked, and generally is a local (and thus low latency) branch.
1991
:ivar master_branch: If target is a bound branch, the master branch of
1992
target, or target itself. Always write locked.
1993
:ivar target_branch: The direct Branch where data is being sent (write
1995
:ivar local_branch: If the target is a bound branch this will be the
1996
target, otherwise it will be None.
1999
def report(self, to_file):
2000
# TODO: This function gets passed a to_file, but then
2001
# ignores it and calls note() instead. This is also
2002
# inconsistent with PullResult(), which writes to stdout.
2003
# -- JRV20110901, bug #838853
2004
tag_conflicts = getattr(self, "tag_conflicts", None)
2005
tag_updates = getattr(self, "tag_updates", None)
2007
if self.old_revid != self.new_revid:
2008
if self.new_revno is not None:
2009
note(gettext('Pushed up to revision %d.'),
2012
note(gettext('Pushed up to revision id %s.'),
2013
self.new_revid.decode('utf-8'))
2015
note(ngettext('%d tag updated.', '%d tags updated.',
2016
len(tag_updates)) % len(tag_updates))
2017
if self.old_revid == self.new_revid and not tag_updates:
2018
if not tag_conflicts:
2019
note(gettext('No new revisions or tags to push.'))
2021
note(gettext('No new revisions to push.'))
2022
self._show_tag_conficts(to_file)
2025
class BranchCheckResult(object):
2026
"""Results of checking branch consistency.
2031
def __init__(self, branch):
2032
self.branch = branch
2035
def report_results(self, verbose):
2036
"""Report the check results via trace.note.
2038
:param verbose: Requests more detailed display of what was checked,
2041
note(gettext('checked branch {0} format {1}').format(
2042
self.branch.user_url, self.branch._format))
2043
for error in self.errors:
2044
note(gettext('found error:%s'), error)
2047
class InterBranch(InterObject):
2048
"""This class represents operations taking place between two branches.
2050
Its instances have methods like pull() and push() and contain
2051
references to the source and target repositories these operations
2052
can be carried out on.
2056
"""The available optimised InterBranch types."""
2059
def _get_branch_formats_to_test(klass):
2060
"""Return an iterable of format tuples for testing.
2062
:return: An iterable of (from_format, to_format) to use when testing
2063
this InterBranch class. Each InterBranch class should define this
2066
raise NotImplementedError(klass._get_branch_formats_to_test)
2068
def pull(self, overwrite=False, stop_revision=None,
2069
possible_transports=None, local=False, tag_selector=None):
2070
"""Mirror source into target branch.
2072
The target branch is considered to be 'local', having low latency.
2074
:returns: PullResult instance
2076
raise NotImplementedError(self.pull)
2078
def push(self, overwrite=False, stop_revision=None, lossy=False,
2079
_override_hook_source_branch=None, tag_selector=None):
2080
"""Mirror the source branch into the target branch.
2082
The source branch is considered to be 'local', having low latency.
2084
raise NotImplementedError(self.push)
2086
def copy_content_into(self, revision_id=None, tag_selector=None):
2087
"""Copy the content of source into target
2090
if not None, the revision history in the new branch will
2091
be truncated to end with revision_id.
2092
:param tag_selector: Optional callback that can decide
2093
to copy or not copy tags.
2095
raise NotImplementedError(self.copy_content_into)
2097
def fetch(self, stop_revision=None, limit=None, lossy=False):
2100
:param stop_revision: Last revision to fetch
2101
:param limit: Optional rough limit of revisions to fetch
2102
:return: FetchResult object
2104
raise NotImplementedError(self.fetch)
2106
def update_references(self):
2107
"""Import reference information from source to target.
2109
raise NotImplementedError(self.update_references)
2112
def _fix_overwrite_type(overwrite):
2113
if isinstance(overwrite, bool):
2115
return ["history", "tags"]
795
__default_format = BzrBranchFormat5()
796
BranchFormat.register_format(__default_format)
797
BranchFormat.register_format(BranchReferenceFormat())
798
BranchFormat.set_default_format(__default_format)
799
_legacy_formats = [BzrBranchFormat4(),
802
class BzrBranch(Branch):
803
"""A branch stored in the actual filesystem.
805
Note that it's "local" in the context of the filesystem; it doesn't
806
really matter if it's on an nfs/smb/afs/coda/... share, as long as
807
it's writable, and can be accessed via the normal filesystem API.
810
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
811
relax_version_check=DEPRECATED_PARAMETER, _format=None,
812
_control_files=None, a_bzrdir=None, _repository=None):
813
"""Create new branch object at a particular location.
815
transport -- A Transport object, defining how to access files.
817
init -- If True, create new control files in a previously
818
unversioned directory. If False, the branch must already
821
relax_version_check -- If true, the usual check for the branch
822
version is not applied. This is intended only for
823
upgrade/recovery type use; it's not guaranteed that
824
all operations will work on old format branches.
827
self.bzrdir = bzrdir.BzrDir.open(transport.base)
2121
class GenericInterBranch(InterBranch):
2122
"""InterBranch implementation that uses public Branch functions."""
2125
def is_compatible(klass, source, target):
2126
# GenericBranch uses the public API, so always compatible
2130
def _get_branch_formats_to_test(klass):
2131
return [(format_registry.get_default(), format_registry.get_default())]
2134
def unwrap_format(klass, format):
2135
if isinstance(format, remote.RemoteBranchFormat):
2136
format._ensure_real()
2137
return format._custom_format
2140
def copy_content_into(self, revision_id=None, tag_selector=None):
2141
"""Copy the content of source into target
2143
revision_id: if not None, the revision history in the new branch will
2144
be truncated to end with revision_id.
2146
with self.source.lock_read(), self.target.lock_write():
2147
self.source._synchronize_history(self.target, revision_id)
2148
self.update_references()
829
self.bzrdir = a_bzrdir
830
self._transport = self.bzrdir.transport.clone('..')
831
self._base = self._transport.base
832
self._format = _format
833
if _control_files is None:
834
raise BzrBadParameterMissing('_control_files')
835
self.control_files = _control_files
836
if deprecated_passed(init):
837
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
838
"deprecated as of bzr 0.8. Please use Branch.create().",
842
# this is slower than before deprecation, oh well never mind.
844
self._initialize(transport.base)
845
self._check_format(_format)
846
if deprecated_passed(relax_version_check):
847
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
848
"relax_version_check parameter is deprecated as of bzr 0.8. "
849
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
853
if (not relax_version_check
854
and not self._format.is_supported()):
855
raise errors.UnsupportedFormatError(
856
'sorry, branch format %r not supported' % fmt,
857
['use a different bzr version',
858
'or remove the .bzr directory'
859
' and "bzr init" again'])
860
if deprecated_passed(transport):
861
warn("BzrBranch.__init__(transport=XXX...): The transport "
862
"parameter is deprecated as of bzr 0.8. "
863
"Please use Branch.open, or bzrdir.open_branch().",
866
self.repository = _repository
869
return '%s(%r)' % (self.__class__.__name__, self.base)
874
# TODO: It might be best to do this somewhere else,
875
# but it is nice for a Branch object to automatically
876
# cache it's information.
877
# Alternatively, we could have the Transport objects cache requests
878
# See the earlier discussion about how major objects (like Branch)
879
# should never expect their __del__ function to run.
880
# XXX: cache_root seems to be unused, 2006-01-13 mbp
881
if hasattr(self, 'cache_root') and self.cache_root is not None:
2150
parent = self.source.get_parent()
2151
except errors.InaccessibleParent as e:
2152
mutter('parent was not accessible to copy: %s', str(e))
2155
self.target.set_parent(parent)
2156
if self.source._push_should_merge_tags():
2157
self.source.tags.merge_to(self.target.tags, selector=tag_selector)
2159
def fetch(self, stop_revision=None, limit=None, lossy=False):
2160
if self.target.base == self.source.base:
2162
with self.source.lock_read(), self.target.lock_write():
2163
fetch_spec_factory = fetch.FetchSpecFactory()
2164
fetch_spec_factory.source_branch = self.source
2165
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
2166
fetch_spec_factory.source_repo = self.source.repository
2167
fetch_spec_factory.target_repo = self.target.repository
2168
fetch_spec_factory.target_repo_kind = (
2169
fetch.TargetRepoKinds.PREEXISTING)
2170
fetch_spec_factory.limit = limit
2171
fetch_spec = fetch_spec_factory.make_fetch_spec()
2172
return self.target.repository.fetch(
2173
self.source.repository,
2175
fetch_spec=fetch_spec)
2177
def _update_revisions(self, stop_revision=None, overwrite=False,
2179
with self.source.lock_read(), self.target.lock_write():
2180
other_revno, other_last_revision = self.source.last_revision_info()
2181
stop_revno = None # unknown
883
shutil.rmtree(self.cache_root)
886
self.cache_root = None
891
base = property(_get_base, doc="The URL for the root of this branch.")
893
def _finish_transaction(self):
894
"""Exit the current transaction."""
895
return self.control_files._finish_transaction()
897
def get_transaction(self):
898
"""Return the current active transaction.
900
If no transaction is active, this returns a passthrough object
901
for which all data is immediately flushed and no caching happens.
903
# this is an explicit function so that we can do tricky stuff
904
# when the storage in rev_storage is elsewhere.
905
# we probably need to hook the two 'lock a location' and
906
# 'have a transaction' together more delicately, so that
907
# we can have two locks (branch and storage) and one transaction
908
# ... and finishing the transaction unlocks both, but unlocking
909
# does not. - RBC 20051121
910
return self.control_files.get_transaction()
912
def _set_transaction(self, transaction):
913
"""Set a new active transaction."""
914
return self.control_files._set_transaction(transaction)
916
def abspath(self, name):
917
"""See Branch.abspath."""
918
return self.control_files._transport.abspath(name)
920
def _check_format(self, format):
921
"""Identify the branch format if needed.
923
The format is stored as a reference to the format object in
924
self._format for code that needs to check it later.
926
The format parameter is either None or the branch format class
927
used to open this branch.
929
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
932
format = BzrBranchFormat.find_format(self.bzrdir)
933
self._format = format
934
mutter("got branch format %s", self._format)
937
def get_root_id(self):
938
"""See Branch.get_root_id."""
939
tree = self.repository.revision_tree(self.last_revision())
940
return tree.inventory.root.file_id
942
def lock_write(self):
943
# TODO: test for failed two phase locks. This is known broken.
944
self.control_files.lock_write()
945
self.repository.lock_write()
948
# TODO: test for failed two phase locks. This is known broken.
949
self.control_files.lock_read()
950
self.repository.lock_read()
953
# TODO: test for failed two phase locks. This is known broken.
954
self.repository.unlock()
955
self.control_files.unlock()
957
def peek_lock_mode(self):
958
if self.control_files._lock_count == 0:
961
return self.control_files._lock_mode
964
def print_file(self, file, revision_id):
965
"""See Branch.print_file."""
966
return self.repository.print_file(file, revision_id)
969
def append_revision(self, *revision_ids):
970
"""See Branch.append_revision."""
971
for revision_id in revision_ids:
972
mutter("add {%s} to revision-history" % revision_id)
973
rev_history = self.revision_history()
974
rev_history.extend(revision_ids)
975
self.set_revision_history(rev_history)
978
def set_revision_history(self, rev_history):
979
"""See Branch.set_revision_history."""
980
self.control_files.put_utf8(
981
'revision-history', '\n'.join(rev_history))
982
transaction = self.get_transaction()
983
history = transaction.map.find_revision_history()
984
if history is not None:
985
# update the revision history in the identity map.
986
history[:] = list(rev_history)
987
# this call is disabled because revision_history is
988
# not really an object yet, and the transaction is for objects.
989
# transaction.register_dirty(history)
991
transaction.map.add_revision_history(rev_history)
992
# this call is disabled because revision_history is
993
# not really an object yet, and the transaction is for objects.
994
# transaction.register_clean(history)
996
def get_revision_delta(self, revno):
997
"""Return the delta for one revision.
999
The delta is relative to its mainline predecessor, or the
1000
empty tree for revision 1.
1002
assert isinstance(revno, int)
1003
rh = self.revision_history()
1004
if not (1 <= revno <= len(rh)):
1005
raise InvalidRevisionNumber(revno)
1007
# revno is 1-based; list is 0-based
1009
new_tree = self.repository.revision_tree(rh[revno-1])
1011
old_tree = EmptyTree()
1013
old_tree = self.repository.revision_tree(rh[revno-2])
1014
return compare_trees(old_tree, new_tree)
1017
def revision_history(self):
1018
"""See Branch.revision_history."""
1019
transaction = self.get_transaction()
1020
history = transaction.map.find_revision_history()
1021
if history is not None:
1022
mutter("cache hit for revision-history in %s", self)
1023
return list(history)
1024
history = [l.rstrip('\r\n') for l in
1025
self.control_files.get_utf8('revision-history').readlines()]
1026
transaction.map.add_revision_history(history)
1027
# this call is disabled because revision_history is
1028
# not really an object yet, and the transaction is for objects.
1029
# transaction.register_clean(history, precious=True)
1030
return list(history)
1033
def update_revisions(self, other, stop_revision=None):
1034
"""See Branch.update_revisions."""
2182
1037
if stop_revision is None:
2183
stop_revision = other_last_revision
2184
if _mod_revision.is_null(stop_revision):
1038
stop_revision = other.last_revision()
1039
if stop_revision is None:
2185
1040
# if there are no commits, we're done.
2187
stop_revno = other_revno
2189
# what's the current last revision, before we fetch [and change it
1042
# whats the current last revision, before we fetch [and change it
2191
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2192
# we fetch here so that we don't process data twice in the common
2193
# case of having something to pull, and so that the check for
2194
# already merged can operate on the just fetched graph, which will
2195
# be cached in memory.
2196
self.fetch(stop_revision=stop_revision)
2197
# Check to see if one is an ancestor of the other
2200
graph = self.target.repository.get_graph()
2201
if self.target._check_if_descendant_or_diverged(
2202
stop_revision, last_rev, graph, self.source):
2203
# stop_revision is a descendant of last_rev, but we aren't
2204
# overwriting, so we're done.
2206
if stop_revno is None:
2208
graph = self.target.repository.get_graph()
2209
this_revno, this_last_revision = \
2210
self.target.last_revision_info()
2211
stop_revno = graph.find_distance_to_null(
2212
stop_revision, [(other_last_revision, other_revno),
2213
(this_last_revision, this_revno)])
2214
self.target.set_last_revision_info(stop_revno, stop_revision)
2216
def pull(self, overwrite=False, stop_revision=None,
2217
possible_transports=None, run_hooks=True,
2218
_override_hook_target=None, local=False,
2220
"""Pull from source into self, updating my master if any.
2222
:param run_hooks: Private parameter - if false, this branch
2223
is being called because it's the master of the primary branch,
2224
so it should not run its hooks.
2226
with cleanup.ExitStack() as exit_stack:
2227
exit_stack.enter_context(self.target.lock_write())
2228
bound_location = self.target.get_bound_location()
2229
if local and not bound_location:
2230
raise errors.LocalRequiresBoundBranch()
2231
master_branch = None
2232
source_is_master = False
2234
# bound_location comes from a config file, some care has to be
2235
# taken to relate it to source.user_url
2236
normalized = urlutils.normalize_url(bound_location)
1044
last_rev = self.last_revision()
1045
# we fetch here regardless of whether we need to so that we pickup
1047
self.fetch(other, stop_revision)
1048
my_ancestry = self.repository.get_ancestry(last_rev)
1049
if stop_revision in my_ancestry:
1050
# last_revision is a descendant of stop_revision
1052
# stop_revision must be a descendant of last_revision
1053
stop_graph = self.repository.get_revision_graph(stop_revision)
1054
if last_rev is not None and last_rev not in stop_graph:
1055
# our previous tip is not merged into stop_revision
1056
raise errors.DivergedBranches(self, other)
1057
# make a new revision history from the graph
1058
current_rev_id = stop_revision
1060
while current_rev_id not in (None, NULL_REVISION):
1061
new_history.append(current_rev_id)
1062
current_rev_id_parents = stop_graph[current_rev_id]
2238
relpath = self.source.user_transport.relpath(normalized)
2239
source_is_master = (relpath == '')
2240
except (errors.PathNotChild, urlutils.InvalidURL):
2241
source_is_master = False
2242
if not local and bound_location and not source_is_master:
2243
# not pulling from master, so we need to update master.
2244
master_branch = self.target.get_master_branch(
2245
possible_transports)
2246
exit_stack.enter_context(master_branch.lock_write())
1064
current_rev_id = current_rev_id_parents[0]
1066
current_rev_id = None
1067
new_history.reverse()
1068
self.set_revision_history(new_history)
1072
@deprecated_method(zero_eight)
1073
def pullable_revisions(self, other, stop_revision):
1074
"""Please use bzrlib.missing instead."""
1075
other_revno = other.revision_id_to_revno(stop_revision)
1077
return self.missing_revisions(other, other_revno)
1078
except DivergedBranches, e:
1080
pullable_revs = get_intervening_revisions(self.last_revision(),
1083
assert self.last_revision() not in pullable_revs
1084
return pullable_revs
1085
except bzrlib.errors.NotAncestor:
1086
if is_ancestor(self.last_revision(), stop_revision, self):
1091
def basis_tree(self):
1092
"""See Branch.basis_tree."""
1093
return self.repository.revision_tree(self.last_revision())
1095
@deprecated_method(zero_eight)
1096
def working_tree(self):
1097
"""Create a Working tree object for this branch."""
1098
from bzrlib.workingtree import WorkingTree
1099
from bzrlib.transport.local import LocalTransport
1100
if (self.base.find('://') != -1 or
1101
not isinstance(self._transport, LocalTransport)):
1102
raise NoWorkingTree(self.base)
1103
return self.bzrdir.open_workingtree()
1106
def pull(self, source, overwrite=False, stop_revision=None):
1107
"""See Branch.pull."""
1110
old_count = len(self.revision_history())
1112
self.update_revisions(source,stop_revision)
1113
except DivergedBranches:
1117
self.set_revision_history(source.revision_history())
1118
new_count = len(self.revision_history())
1119
return new_count - old_count
1123
def get_parent(self):
1124
"""See Branch.get_parent."""
1126
_locs = ['parent', 'pull', 'x-pull']
1129
return self.control_files.get_utf8(l).read().strip('\n')
1134
def get_push_location(self):
1135
"""See Branch.get_push_location."""
1136
config = bzrlib.config.BranchConfig(self)
1137
push_loc = config.get_user_option('push_location')
1140
def set_push_location(self, location):
1141
"""See Branch.set_push_location."""
1142
config = bzrlib.config.LocationConfig(self.base)
1143
config.set_user_option('push_location', location)
1146
def set_parent(self, url):
1147
"""See Branch.set_parent."""
1148
# TODO: Maybe delete old location files?
1149
# URLs should never be unicode, even on the local fs,
1150
# FIXUP this and get_parent in a future branch format bump:
1151
# read and rewrite the file, and have the new format code read
1152
# using .get not .get_utf8. RBC 20060125
1154
self.control_files._transport.delete('parent')
1156
self.control_files.put_utf8('parent', url + '\n')
1158
def tree_config(self):
1159
return TreeConfig(self)
1162
class BzrBranch5(BzrBranch):
1163
"""A format 5 branch. This supports new features over plan branches.
1165
It has support for a master_branch which is the data for bound branches.
1173
super(BzrBranch5, self).__init__(_format=_format,
1174
_control_files=_control_files,
1176
_repository=_repository)
1179
def pull(self, source, overwrite=False, stop_revision=None):
1180
"""Updates branch.pull to be bound branch aware."""
1181
bound_location = self.get_bound_location()
1182
if source.base != bound_location:
1183
# not pulling from master, so we need to update master.
1184
master_branch = self.get_master_branch()
2247
1185
if master_branch:
2248
# pull from source into master.
2250
self.source, overwrite, stop_revision, run_hooks=False,
2251
tag_selector=tag_selector)
2253
overwrite, stop_revision, _hook_master=master_branch,
2254
run_hooks=run_hooks,
2255
_override_hook_target=_override_hook_target,
2256
merge_tags_to_master=not source_is_master,
2257
tag_selector=tag_selector)
2259
def push(self, overwrite=False, stop_revision=None, lossy=False,
2260
_override_hook_source_branch=None, tag_selector=None):
2261
"""See InterBranch.push.
2263
This is the basic concrete implementation of push()
2265
:param _override_hook_source_branch: If specified, run the hooks
2266
passing this Branch as the source, rather than self. This is for
2267
use of RemoteBranch, where push is delegated to the underlying
2271
raise errors.LossyPushToSameVCS(self.source, self.target)
2272
# TODO: Public option to disable running hooks - should be trivial but
2276
if _override_hook_source_branch:
2277
result.source_branch = _override_hook_source_branch
2278
for hook in Branch.hooks['post_push']:
2281
with self.source.lock_read(), self.target.lock_write():
2282
bound_location = self.target.get_bound_location()
2283
if bound_location and self.target.base != bound_location:
2284
# there is a master branch.
2286
# XXX: Why the second check? Is it even supported for a branch
2287
# to be bound to itself? -- mbp 20070507
2288
master_branch = self.target.get_master_branch()
2289
with master_branch.lock_write():
2290
# push into the master from the source branch.
2291
master_inter = InterBranch.get(self.source, master_branch)
2292
master_inter._basic_push(
2293
overwrite, stop_revision, tag_selector=tag_selector)
2294
# and push into the target branch from the source. Note
2295
# that we push from the source branch again, because it's
2296
# considered the highest bandwidth repository.
2297
result = self._basic_push(
2298
overwrite, stop_revision, tag_selector=tag_selector)
2299
result.master_branch = master_branch
2300
result.local_branch = self.target
2303
master_branch = None
2305
result = self._basic_push(
2306
overwrite, stop_revision, tag_selector=tag_selector)
2307
# TODO: Why set master_branch and local_branch if there's no
2308
# binding? Maybe cleaner to just leave them unset? -- mbp
2310
result.master_branch = self.target
2311
result.local_branch = None
2315
def _basic_push(self, overwrite, stop_revision, tag_selector=None):
2316
"""Basic implementation of push without bound branches or hooks.
2318
Must be called with source read locked and target write locked.
2320
result = BranchPushResult()
2321
result.source_branch = self.source
2322
result.target_branch = self.target
2323
result.old_revno, result.old_revid = self.target.last_revision_info()
2324
overwrite = _fix_overwrite_type(overwrite)
2325
if result.old_revid != stop_revision:
2326
# We assume that during 'push' this repository is closer than
2328
graph = self.source.repository.get_graph(self.target.repository)
2329
self._update_revisions(
2330
stop_revision, overwrite=("history" in overwrite), graph=graph)
2331
if self.source._push_should_merge_tags():
2332
result.tag_updates, result.tag_conflicts = (
2333
self.source.tags.merge_to(
2334
self.target.tags, "tags" in overwrite, selector=tag_selector))
2335
self.update_references()
2336
result.new_revno, result.new_revid = self.target.last_revision_info()
2339
def _pull(self, overwrite=False, stop_revision=None,
2340
possible_transports=None, _hook_master=None, run_hooks=True,
2341
_override_hook_target=None, local=False,
2342
merge_tags_to_master=True, tag_selector=None):
2345
This function is the core worker, used by GenericInterBranch.pull to
2346
avoid duplication when pulling source->master and source->local.
2348
:param _hook_master: Private parameter - set the branch to
2349
be supplied as the master to pull hooks.
2350
:param run_hooks: Private parameter - if false, this branch
2351
is being called because it's the master of the primary branch,
2352
so it should not run its hooks.
2353
is being called because it's the master of the primary branch,
2354
so it should not run its hooks.
2355
:param _override_hook_target: Private parameter - set the branch to be
2356
supplied as the target_branch to pull hooks.
2357
:param local: Only update the local branch, and not the bound branch.
2359
# This type of branch can't be bound.
2361
raise errors.LocalRequiresBoundBranch()
2362
result = PullResult()
2363
result.source_branch = self.source
2364
if _override_hook_target is None:
2365
result.target_branch = self.target
1186
master_branch.pull(source)
1187
source = master_branch
1188
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1190
def get_bound_location(self):
1192
return self.control_files.get_utf8('bound').read()[:-1]
1193
except errors.NoSuchFile:
1197
def get_master_branch(self):
1198
"""Return the branch we are bound to.
1200
:return: Either a Branch, or None
1202
This could memoise the branch, but if thats done
1203
it must be revalidated on each new lock.
1204
So for now we just dont memoise it.
1205
# RBC 20060304 review this decision.
1207
bound_loc = self.get_bound_location()
1211
return Branch.open(bound_loc)
1212
except (errors.NotBranchError, errors.ConnectionError), e:
1213
raise errors.BoundBranchConnectionFailure(
1217
def set_bound_location(self, location):
1218
"""Set the target where this branch is bound to.
1220
:param location: URL to the target branch
1223
self.control_files.put_utf8('bound', location+'\n')
2367
result.target_branch = _override_hook_target
2368
with self.source.lock_read():
2369
# We assume that during 'pull' the target repository is closer than
2371
graph = self.target.repository.get_graph(self.source.repository)
2372
# TODO: Branch formats should have a flag that indicates
2373
# that revno's are expensive, and pull() should honor that flag.
2375
result.old_revno, result.old_revid = \
2376
self.target.last_revision_info()
2377
overwrite = _fix_overwrite_type(overwrite)
2378
self._update_revisions(
2379
stop_revision, overwrite=("history" in overwrite), graph=graph)
2380
# TODO: The old revid should be specified when merging tags,
2381
# so a tags implementation that versions tags can only
2382
# pull in the most recent changes. -- JRV20090506
2383
result.tag_updates, result.tag_conflicts = (
2384
self.source.tags.merge_to(
2385
self.target.tags, "tags" in overwrite,
2386
ignore_master=not merge_tags_to_master,
2387
selector=tag_selector))
2388
self.update_references()
2389
result.new_revno, result.new_revid = (
2390
self.target.last_revision_info())
2392
result.master_branch = _hook_master
2393
result.local_branch = result.target_branch
2395
result.master_branch = result.target_branch
2396
result.local_branch = None
2398
for hook in Branch.hooks['post_pull']:
2402
def update_references(self):
2403
if not getattr(self.source._format, 'supports_reference_locations', False):
2405
reference_dict = self.source._get_all_reference_info()
2406
if len(reference_dict) == 0:
2408
old_base = self.source.base
2409
new_base = self.target.base
2410
target_reference_dict = self.target._get_all_reference_info()
2411
for tree_path, (branch_location, file_id) in viewitems(reference_dict):
2413
branch_location = urlutils.rebase_url(branch_location,
2415
except urlutils.InvalidRebaseURLs:
2416
# Fall back to absolute URL
2417
branch_location = urlutils.join(old_base, branch_location)
2418
target_reference_dict.setdefault(
2419
tree_path, (branch_location, file_id))
2420
self.target._set_all_reference_info(target_reference_dict)
2423
InterBranch.register_optimiser(GenericInterBranch)
1226
self.control_files._transport.delete('bound')
1232
def bind(self, other):
1233
"""Bind the local branch the other branch.
1235
:param other: The branch to bind to
1238
# TODO: jam 20051230 Consider checking if the target is bound
1239
# It is debatable whether you should be able to bind to
1240
# a branch which is itself bound.
1241
# Committing is obviously forbidden,
1242
# but binding itself may not be.
1243
# Since we *have* to check at commit time, we don't
1244
# *need* to check here
1247
# we are now equal to or a suffix of other.
1249
# Since we have 'pulled' from the remote location,
1250
# now we should try to pull in the opposite direction
1251
# in case the local tree has more revisions than the
1253
# There may be a different check you could do here
1254
# rather than actually trying to install revisions remotely.
1255
# TODO: capture an exception which indicates the remote branch
1257
# If it is up-to-date, this probably should not be a failure
1259
# lock other for write so the revision-history syncing cannot race
1263
# if this does not error, other now has the same last rev we do
1264
# it can only error if the pull from other was concurrent with
1265
# a commit to other from someone else.
1267
# until we ditch revision-history, we need to sync them up:
1268
self.set_revision_history(other.revision_history())
1269
# now other and self are up to date with each other and have the
1270
# same revision-history.
1274
self.set_bound_location(other.base)
1278
"""If bound, unbind"""
1279
return self.set_bound_location(None)
1283
"""Synchronise this branch with the master branch if any.
1285
:return: None or the last_revision that was pivoted out during the
1288
master = self.get_master_branch()
1289
if master is not None:
1290
old_tip = self.last_revision()
1291
self.pull(master, overwrite=True)
1292
if old_tip in self.repository.get_ancestry(self.last_revision()):
1298
class BranchTestProviderAdapter(object):
1299
"""A tool to generate a suite testing multiple branch formats at once.
1301
This is done by copying the test once for each transport and injecting
1302
the transport_server, transport_readonly_server, and branch_format
1303
classes into each copy. Each copy is also given a new id() to make it
1307
def __init__(self, transport_server, transport_readonly_server, formats):
1308
self._transport_server = transport_server
1309
self._transport_readonly_server = transport_readonly_server
1310
self._formats = formats
1312
def adapt(self, test):
1313
result = TestSuite()
1314
for branch_format, bzrdir_format in self._formats:
1315
new_test = deepcopy(test)
1316
new_test.transport_server = self._transport_server
1317
new_test.transport_readonly_server = self._transport_readonly_server
1318
new_test.bzrdir_format = bzrdir_format
1319
new_test.branch_format = branch_format
1320
def make_new_test_id():
1321
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1322
return lambda: new_id
1323
new_test.id = make_new_test_id()
1324
result.addTest(new_test)
1328
######################################################################
1332
@deprecated_function(zero_eight)
1333
def ScratchBranch(*args, **kwargs):
1334
"""See bzrlib.bzrdir.ScratchDir."""
1335
d = ScratchDir(*args, **kwargs)
1336
return d.open_branch()
1339
@deprecated_function(zero_eight)
1340
def is_control_file(*args, **kwargs):
1341
"""See bzrlib.workingtree.is_control_file."""
1342
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
