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