13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
18
from cStringIO import StringIO
21
20
from bzrlib.lazy_import import lazy_import
22
21
lazy_import(globals(), """
23
from itertools import chain
22
from warnings import warn
24
25
from bzrlib import (
27
28
config as _mod_config,
34
33
revision as _mod_revision,
42
from bzrlib.config import BranchConfig, TransportConfig
43
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
40
from bzrlib.config import BranchConfig, TreeConfig
41
from bzrlib.lockable_files import LockableFiles, TransportLock
44
42
from bzrlib.tag import (
50
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
51
from bzrlib.hooks import HookPoint, Hooks
52
from bzrlib.inter import InterObject
53
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
54
from bzrlib import registry
55
from bzrlib.symbol_versioning import (
59
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
48
from bzrlib.decorators import needs_read_lock, needs_write_lock
49
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
50
HistoryMissing, InvalidRevisionId,
51
InvalidRevisionNumber, LockError, NoSuchFile,
52
NoSuchRevision, NoWorkingTree, NotVersionedError,
53
NotBranchError, UninitializableFormat,
54
UnlistableStore, UnlistableBranch,
56
from bzrlib.hooks import Hooks
57
from bzrlib.symbol_versioning import (deprecated_function,
61
zero_eight, zero_nine, zero_sixteen,
63
from bzrlib.trace import mutter, note
62
66
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
122
115
if master is not None:
123
116
master.break_lock()
125
def _check_stackable_repo(self):
126
if not self.repository._format.supports_external_lookups:
127
raise errors.UnstackableRepositoryFormat(self.repository._format,
128
self.repository.base)
130
def _extend_partial_history(self, stop_index=None, stop_revision=None):
131
"""Extend the partial history to include a given index
133
If a stop_index is supplied, stop when that index has been reached.
134
If a stop_revision is supplied, stop when that revision is
135
encountered. Otherwise, stop when the beginning of history is
138
:param stop_index: The index which should be present. When it is
139
present, history extension will stop.
140
:param stop_revision: The revision id which should be present. When
141
it is encountered, history extension will stop.
143
if len(self._partial_revision_history_cache) == 0:
144
self._partial_revision_history_cache = [self.last_revision()]
145
repository._iter_for_revno(
146
self.repository, self._partial_revision_history_cache,
147
stop_index=stop_index, stop_revision=stop_revision)
148
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
149
self._partial_revision_history_cache.pop()
151
def _get_check_refs(self):
152
"""Get the references needed for check().
156
revid = self.last_revision()
157
return [('revision-existence', revid), ('lefthand-distance', revid)]
160
def open(base, _unsupported=False, possible_transports=None):
119
@deprecated_method(zero_eight)
120
def open_downlevel(base):
121
"""Open a branch which may be of an old format."""
122
return Branch.open(base, _unsupported=True)
125
def open(base, _unsupported=False):
161
126
"""Open the branch rooted at base.
163
128
For instance, if the branch is at URL/.bzr/branch,
164
129
Branch.open(URL) -> a Branch instance.
166
control = bzrdir.BzrDir.open(base, _unsupported,
167
possible_transports=possible_transports)
168
return control.open_branch(unsupported=_unsupported)
131
control = bzrdir.BzrDir.open(base, _unsupported)
132
return control.open_branch(_unsupported)
171
def open_from_transport(transport, name=None, _unsupported=False):
135
def open_from_transport(transport, _unsupported=False):
172
136
"""Open the branch rooted at transport"""
173
137
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
174
return control.open_branch(name=name, unsupported=_unsupported)
138
return control.open_branch(_unsupported)
177
141
def open_containing(url, possible_transports=None):
178
142
"""Open an existing branch which contains url.
180
144
This probes for a branch at url, and searches upwards from there.
182
146
Basically we keep looking up until we find the control directory or
183
147
run into the root. If there isn't one, raises NotBranchError.
184
If there is one and it is either an unrecognised format or an unsupported
148
If there is one and it is either an unrecognised format or an unsupported
185
149
format, UnknownFormatError or UnsupportedFormatError are raised.
186
150
If there is one, it is returned, along with the unused portion of url.
189
153
possible_transports)
190
154
return control.open_branch(), relpath
192
def _push_should_merge_tags(self):
193
"""Should _basic_push merge this branch's tags into the target?
195
The default implementation returns False if this branch has no tags,
196
and True the rest of the time. Subclasses may override this.
198
return self.supports_tags() and self.tags.get_tag_dict()
157
@deprecated_function(zero_eight)
158
def initialize(base):
159
"""Create a new working tree and branch, rooted at 'base' (url)
161
NOTE: This will soon be deprecated in favour of creation
164
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
166
@deprecated_function(zero_eight)
167
def setup_caching(self, cache_root):
168
"""Subclasses that care about caching should override this, and set
169
up cached stores located under cache_root.
171
NOTE: This is unused.
200
175
def get_config(self):
201
"""Get a bzrlib.config.BranchConfig for this Branch.
203
This can then be used to get and set configuration options for the
206
:return: A bzrlib.config.BranchConfig.
208
176
return BranchConfig(self)
210
def _get_config(self):
211
"""Get the concrete config for just the config in this branch.
213
This is not intended for client use; see Branch.get_config for the
218
:return: An object supporting get_option and set_option.
220
raise NotImplementedError(self._get_config)
222
def _get_fallback_repository(self, url):
223
"""Get the repository we fallback to at url."""
224
url = urlutils.join(self.base, url)
225
a_branch = Branch.open(url,
226
possible_transports=[self.bzrdir.root_transport])
227
return a_branch.repository
229
def _get_tags_bytes(self):
230
"""Get the bytes of a serialised tags dict.
232
Note that not all branches support tags, nor do all use the same tags
233
logic: this method is specific to BasicTags. Other tag implementations
234
may use the same method name and behave differently, safely, because
235
of the double-dispatch via
236
format.make_tags->tags_instance->get_tags_dict.
238
:return: The bytes of the tags file.
239
:seealso: Branch._set_tags_bytes.
241
return self._transport.get_bytes('tags')
243
def _get_nick(self, local=False, possible_transports=None):
244
config = self.get_config()
245
# explicit overrides master, but don't look for master if local is True
246
if not local and not config.has_explicit_nickname():
248
master = self.get_master_branch(possible_transports)
249
if master and self.user_url == master.user_url:
250
raise errors.RecursiveBind(self.user_url)
251
if master is not None:
252
# return the master branch value
254
except errors.RecursiveBind, e:
256
except errors.BzrError, e:
257
# Silently fall back to local implicit nick if the master is
259
mutter("Could not connect to bound branch, "
260
"falling back to local nick.\n " + str(e))
261
return config.get_nickname()
179
return self.get_config().get_nickname()
263
181
def _set_nick(self, nick):
264
182
self.get_config().set_user_option('nickname', nick, warn_masked=True)
322
203
raise NotImplementedError(self.get_physical_lock_status)
325
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
326
"""Return the revision_id for a dotted revno.
328
:param revno: a tuple like (1,) or (1,1,2)
329
:param _cache_reverse: a private parameter enabling storage
330
of the reverse mapping in a top level cache. (This should
331
only be done in selective circumstances as we want to
332
avoid having the mapping cached multiple times.)
333
:return: the revision_id
334
:raises errors.NoSuchRevision: if the revno doesn't exist
336
rev_id = self._do_dotted_revno_to_revision_id(revno)
338
self._partial_revision_id_to_revno_cache[rev_id] = revno
341
def _do_dotted_revno_to_revision_id(self, revno):
342
"""Worker function for dotted_revno_to_revision_id.
344
Subclasses should override this if they wish to
345
provide a more efficient implementation.
348
return self.get_rev_id(revno[0])
349
revision_id_to_revno = self.get_revision_id_to_revno_map()
350
revision_ids = [revision_id for revision_id, this_revno
351
in revision_id_to_revno.iteritems()
352
if revno == this_revno]
353
if len(revision_ids) == 1:
354
return revision_ids[0]
356
revno_str = '.'.join(map(str, revno))
357
raise errors.NoSuchRevision(self, revno_str)
360
def revision_id_to_dotted_revno(self, revision_id):
361
"""Given a revision id, return its dotted revno.
363
:return: a tuple like (1,) or (400,1,3).
365
return self._do_revision_id_to_dotted_revno(revision_id)
367
def _do_revision_id_to_dotted_revno(self, revision_id):
368
"""Worker function for revision_id_to_revno."""
369
# Try the caches if they are loaded
370
result = self._partial_revision_id_to_revno_cache.get(revision_id)
371
if result is not None:
373
if self._revision_id_to_revno_cache:
374
result = self._revision_id_to_revno_cache.get(revision_id)
376
raise errors.NoSuchRevision(self, revision_id)
377
# Try the mainline as it's optimised
379
revno = self.revision_id_to_revno(revision_id)
381
except errors.NoSuchRevision:
382
# We need to load and use the full revno map after all
383
result = self.get_revision_id_to_revno_map().get(revision_id)
385
raise errors.NoSuchRevision(self, revision_id)
389
206
def get_revision_id_to_revno_map(self):
390
207
"""Return the revision_id => dotted revno map.
416
233
:return: A dictionary mapping revision_id => dotted revno.
235
last_revision = self.last_revision()
236
revision_graph = self.repository.get_revision_graph(last_revision)
237
merge_sorted_revisions = tsort.merge_sort(
418
242
revision_id_to_revno = dict((rev_id, revno)
419
for rev_id, depth, revno, end_of_merge
420
in self.iter_merge_sorted_revisions())
243
for seq_num, rev_id, depth, revno, end_of_merge
244
in merge_sorted_revisions)
421
245
return revision_id_to_revno
424
def iter_merge_sorted_revisions(self, start_revision_id=None,
425
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
426
"""Walk the revisions for a branch in merge sorted order.
428
Merge sorted order is the output from a merge-aware,
429
topological sort, i.e. all parents come before their
430
children going forward; the opposite for reverse.
432
:param start_revision_id: the revision_id to begin walking from.
433
If None, the branch tip is used.
434
:param stop_revision_id: the revision_id to terminate the walk
435
after. If None, the rest of history is included.
436
:param stop_rule: if stop_revision_id is not None, the precise rule
437
to use for termination:
438
* 'exclude' - leave the stop revision out of the result (default)
439
* 'include' - the stop revision is the last item in the result
440
* 'with-merges' - include the stop revision and all of its
441
merged revisions in the result
442
* 'with-merges-without-common-ancestry' - filter out revisions
443
that are in both ancestries
444
:param direction: either 'reverse' or 'forward':
445
* reverse means return the start_revision_id first, i.e.
446
start at the most recent revision and go backwards in history
447
* forward returns tuples in the opposite order to reverse.
448
Note in particular that forward does *not* do any intelligent
449
ordering w.r.t. depth as some clients of this API may like.
450
(If required, that ought to be done at higher layers.)
452
:return: an iterator over (revision_id, depth, revno, end_of_merge)
455
* revision_id: the unique id of the revision
456
* depth: How many levels of merging deep this node has been
458
* revno_sequence: This field provides a sequence of
459
revision numbers for all revisions. The format is:
460
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
461
branch that the revno is on. From left to right the REVNO numbers
462
are the sequence numbers within that branch of the revision.
463
* end_of_merge: When True the next node (earlier in history) is
464
part of a different merge.
466
# Note: depth and revno values are in the context of the branch so
467
# we need the full graph to get stable numbers, regardless of the
469
if self._merge_sorted_revisions_cache is None:
470
last_revision = self.last_revision()
471
known_graph = self.repository.get_known_graph_ancestry(
473
self._merge_sorted_revisions_cache = known_graph.merge_sort(
475
filtered = self._filter_merge_sorted_revisions(
476
self._merge_sorted_revisions_cache, start_revision_id,
477
stop_revision_id, stop_rule)
478
# Make sure we don't return revisions that are not part of the
479
# start_revision_id ancestry.
480
filtered = self._filter_start_non_ancestors(filtered)
481
if direction == 'reverse':
483
if direction == 'forward':
484
return reversed(list(filtered))
486
raise ValueError('invalid direction %r' % direction)
488
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
489
start_revision_id, stop_revision_id, stop_rule):
490
"""Iterate over an inclusive range of sorted revisions."""
491
rev_iter = iter(merge_sorted_revisions)
492
if start_revision_id is not None:
493
for node in rev_iter:
494
rev_id = node.key[-1]
495
if rev_id != start_revision_id:
498
# The decision to include the start or not
499
# depends on the stop_rule if a stop is provided
500
# so pop this node back into the iterator
501
rev_iter = chain(iter([node]), rev_iter)
503
if stop_revision_id is None:
505
for node in rev_iter:
506
rev_id = node.key[-1]
507
yield (rev_id, node.merge_depth, node.revno,
509
elif stop_rule == 'exclude':
510
for node in rev_iter:
511
rev_id = node.key[-1]
512
if rev_id == stop_revision_id:
514
yield (rev_id, node.merge_depth, node.revno,
516
elif stop_rule == 'include':
517
for node in rev_iter:
518
rev_id = node.key[-1]
519
yield (rev_id, node.merge_depth, node.revno,
521
if rev_id == stop_revision_id:
523
elif stop_rule == 'with-merges-without-common-ancestry':
524
# We want to exclude all revisions that are already part of the
525
# stop_revision_id ancestry.
526
graph = self.repository.get_graph()
527
ancestors = graph.find_unique_ancestors(start_revision_id,
529
for node in rev_iter:
530
rev_id = node.key[-1]
531
if rev_id not in ancestors:
533
yield (rev_id, node.merge_depth, node.revno,
535
elif stop_rule == 'with-merges':
536
stop_rev = self.repository.get_revision(stop_revision_id)
537
if stop_rev.parent_ids:
538
left_parent = stop_rev.parent_ids[0]
540
left_parent = _mod_revision.NULL_REVISION
541
# left_parent is the actual revision we want to stop logging at,
542
# since we want to show the merged revisions after the stop_rev too
543
reached_stop_revision_id = False
544
revision_id_whitelist = []
545
for node in rev_iter:
546
rev_id = node.key[-1]
547
if rev_id == left_parent:
548
# reached the left parent after the stop_revision
550
if (not reached_stop_revision_id or
551
rev_id in revision_id_whitelist):
552
yield (rev_id, node.merge_depth, node.revno,
554
if reached_stop_revision_id or rev_id == stop_revision_id:
555
# only do the merged revs of rev_id from now on
556
rev = self.repository.get_revision(rev_id)
558
reached_stop_revision_id = True
559
revision_id_whitelist.extend(rev.parent_ids)
561
raise ValueError('invalid stop_rule %r' % stop_rule)
563
def _filter_start_non_ancestors(self, rev_iter):
564
# If we started from a dotted revno, we want to consider it as a tip
565
# and don't want to yield revisions that are not part of its
566
# ancestry. Given the order guaranteed by the merge sort, we will see
567
# uninteresting descendants of the first parent of our tip before the
569
first = rev_iter.next()
570
(rev_id, merge_depth, revno, end_of_merge) = first
573
# We start at a mainline revision so by definition, all others
574
# revisions in rev_iter are ancestors
575
for node in rev_iter:
580
pmap = self.repository.get_parent_map([rev_id])
581
parents = pmap.get(rev_id, [])
583
whitelist.update(parents)
585
# If there is no parents, there is nothing of interest left
587
# FIXME: It's hard to test this scenario here as this code is never
588
# called in that case. -- vila 20100322
591
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
593
if rev_id in whitelist:
594
pmap = self.repository.get_parent_map([rev_id])
595
parents = pmap.get(rev_id, [])
596
whitelist.remove(rev_id)
597
whitelist.update(parents)
599
# We've reached the mainline, there is nothing left to
603
# A revision that is not part of the ancestry of our
606
yield (rev_id, merge_depth, revno, end_of_merge)
608
247
def leave_lock_in_place(self):
609
248
"""Tell this branch object not to release the physical lock when this
610
249
object is unlocked.
612
251
If lock_write doesn't return a token, then this method is not supported.
614
253
self.control_files.leave_in_place()
720
357
The delta is relative to its mainline predecessor, or the
721
358
empty tree for revision 1.
360
assert isinstance(revno, int)
723
361
rh = self.revision_history()
724
362
if not (1 <= revno <= len(rh)):
725
raise errors.InvalidRevisionNumber(revno)
363
raise InvalidRevisionNumber(revno)
726
364
return self.repository.get_revision_delta(rh[revno-1])
728
def get_stacked_on_url(self):
729
"""Get the URL this branch is stacked against.
366
@deprecated_method(zero_sixteen)
367
def get_root_id(self):
368
"""Return the id of this branches root
731
:raises NotStacked: If the branch is not stacked.
732
:raises UnstackableBranchFormat: If the branch does not support
370
Deprecated: branches don't have root ids-- trees do.
371
Use basis_tree().get_root_id() instead.
735
raise NotImplementedError(self.get_stacked_on_url)
373
raise NotImplementedError(self.get_root_id)
737
375
def print_file(self, file, revision_id):
738
376
"""Print `file` to stdout."""
739
377
raise NotImplementedError(self.print_file)
379
def append_revision(self, *revision_ids):
380
raise NotImplementedError(self.append_revision)
741
382
def set_revision_history(self, rev_history):
742
383
raise NotImplementedError(self.set_revision_history)
745
def set_parent(self, url):
746
"""See Branch.set_parent."""
747
# TODO: Maybe delete old location files?
748
# URLs should never be unicode, even on the local fs,
749
# FIXUP this and get_parent in a future branch format bump:
750
# read and rewrite the file. RBC 20060125
752
if isinstance(url, unicode):
754
url = url.encode('ascii')
755
except UnicodeEncodeError:
756
raise errors.InvalidURL(url,
757
"Urls must be 7-bit ascii, "
758
"use bzrlib.urlutils.escape")
759
url = urlutils.relative_url(self.base, url)
760
self._set_parent_location(url)
763
def set_stacked_on_url(self, url):
764
"""Set the URL this branch is stacked against.
766
:raises UnstackableBranchFormat: If the branch does not support
768
:raises UnstackableRepositoryFormat: If the repository does not support
771
if not self._format.supports_stacking():
772
raise errors.UnstackableBranchFormat(self._format, self.user_url)
773
# XXX: Changing from one fallback repository to another does not check
774
# that all the data you need is present in the new fallback.
775
# Possibly it should.
776
self._check_stackable_repo()
779
old_url = self.get_stacked_on_url()
780
except (errors.NotStacked, errors.UnstackableBranchFormat,
781
errors.UnstackableRepositoryFormat):
785
self._activate_fallback_location(url)
786
# write this out after the repository is stacked to avoid setting a
787
# stacked config that doesn't work.
788
self._set_config_location('stacked_on_location', url)
791
"""Change a branch to be unstacked, copying data as needed.
793
Don't call this directly, use set_stacked_on_url(None).
795
pb = ui.ui_factory.nested_progress_bar()
797
pb.update("Unstacking")
798
# The basic approach here is to fetch the tip of the branch,
799
# including all available ghosts, from the existing stacked
800
# repository into a new repository object without the fallbacks.
802
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
803
# correct for CHKMap repostiories
804
old_repository = self.repository
805
if len(old_repository._fallback_repositories) != 1:
806
raise AssertionError("can't cope with fallback repositories "
807
"of %r" % (self.repository,))
808
# Open the new repository object.
809
# Repositories don't offer an interface to remove fallback
810
# repositories today; take the conceptually simpler option and just
811
# reopen it. We reopen it starting from the URL so that we
812
# get a separate connection for RemoteRepositories and can
813
# stream from one of them to the other. This does mean doing
814
# separate SSH connection setup, but unstacking is not a
815
# common operation so it's tolerable.
816
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
817
new_repository = new_bzrdir.find_repository()
818
if new_repository._fallback_repositories:
819
raise AssertionError("didn't expect %r to have "
820
"fallback_repositories"
821
% (self.repository,))
822
# Replace self.repository with the new repository.
823
# Do our best to transfer the lock state (i.e. lock-tokens and
824
# lock count) of self.repository to the new repository.
825
lock_token = old_repository.lock_write().repository_token
826
self.repository = new_repository
827
if isinstance(self, remote.RemoteBranch):
828
# Remote branches can have a second reference to the old
829
# repository that need to be replaced.
830
if self._real_branch is not None:
831
self._real_branch.repository = new_repository
832
self.repository.lock_write(token=lock_token)
833
if lock_token is not None:
834
old_repository.leave_lock_in_place()
835
old_repository.unlock()
836
if lock_token is not None:
837
# XXX: self.repository.leave_lock_in_place() before this
838
# function will not be preserved. Fortunately that doesn't
839
# affect the current default format (2a), and would be a
840
# corner-case anyway.
841
# - Andrew Bennetts, 2010/06/30
842
self.repository.dont_leave_lock_in_place()
846
old_repository.unlock()
847
except errors.LockNotHeld:
850
if old_lock_count == 0:
851
raise AssertionError(
852
'old_repository should have been locked at least once.')
853
for i in range(old_lock_count-1):
854
self.repository.lock_write()
855
# Fetch from the old repository into the new.
856
old_repository.lock_read()
858
# XXX: If you unstack a branch while it has a working tree
859
# with a pending merge, the pending-merged revisions will no
860
# longer be present. You can (probably) revert and remerge.
862
# XXX: This only fetches up to the tip of the repository; it
863
# doesn't bring across any tags. That's fairly consistent
864
# with how branch works, but perhaps not ideal.
865
self.repository.fetch(old_repository,
866
revision_id=self.last_revision(),
869
old_repository.unlock()
873
def _set_tags_bytes(self, bytes):
874
"""Mirror method for _get_tags_bytes.
876
:seealso: Branch._get_tags_bytes.
878
return _run_with_write_locked_target(self, self._transport.put_bytes,
881
385
def _cache_revision_history(self, rev_history):
882
386
"""Set the cached revision history to rev_history.
992
491
common_index = min(self_len, other_len) -1
993
492
if common_index >= 0 and \
994
493
self_history[common_index] != other_history[common_index]:
995
raise errors.DivergedBranches(self, other)
494
raise DivergedBranches(self, other)
997
496
if stop_revision is None:
998
497
stop_revision = other_len
499
assert isinstance(stop_revision, int)
1000
500
if stop_revision > other_len:
1001
501
raise errors.NoSuchRevision(self, stop_revision)
1002
502
return other_history[self_len:stop_revision]
1004
def update_revisions(self, other, stop_revision=None, overwrite=False,
504
def update_revisions(self, other, stop_revision=None):
1006
505
"""Pull in new perfect-fit revisions.
1008
507
:param other: Another Branch to pull from
1009
508
:param stop_revision: Updated until the given revision
1010
:param overwrite: Always set the branch pointer, rather than checking
1011
to see if it is a proper descendant.
1012
:param graph: A Graph object that can be used to query history
1013
information. This can be None.
1016
return InterBranch.get(other, self).update_revisions(stop_revision,
1019
def import_last_revision_info(self, source_repo, revno, revid):
1020
"""Set the last revision info, importing from another repo if necessary.
1022
This is used by the bound branch code to upload a revision to
1023
the master branch first before updating the tip of the local branch.
1025
:param source_repo: Source repository to optionally fetch from
1026
:param revno: Revision number of the new tip
1027
:param revid: Revision id of the new tip
1029
if not self.repository.has_same_location(source_repo):
1030
self.repository.fetch(source_repo, revision_id=revid)
1031
self.set_last_revision_info(revno, revid)
511
raise NotImplementedError(self.update_revisions)
1033
513
def revision_id_to_revno(self, revision_id):
1034
514
"""Given a revision id, return its revno"""
1035
515
if _mod_revision.is_null(revision_id):
517
revision_id = osutils.safe_revision_id(revision_id)
1037
518
history = self.revision_history()
1039
520
return history.index(revision_id) + 1
1040
521
except ValueError:
1041
522
raise errors.NoSuchRevision(self, revision_id)
1044
524
def get_rev_id(self, revno, history=None):
1045
525
"""Find the revision id of the specified revno."""
1047
return _mod_revision.NULL_REVISION
1048
last_revno, last_revid = self.last_revision_info()
1049
if revno == last_revno:
1051
if revno <= 0 or revno > last_revno:
529
history = self.revision_history()
530
if revno <= 0 or revno > len(history):
1052
531
raise errors.NoSuchRevision(self, revno)
1053
distance_from_last = last_revno - revno
1054
if len(self._partial_revision_history_cache) <= distance_from_last:
1055
self._extend_partial_history(distance_from_last)
1056
return self._partial_revision_history_cache[distance_from_last]
532
return history[revno - 1]
1058
def pull(self, source, overwrite=False, stop_revision=None,
1059
possible_transports=None, *args, **kwargs):
534
def pull(self, source, overwrite=False, stop_revision=None):
1060
535
"""Mirror source into this branch.
1062
537
This branch is considered to be 'local', having low latency.
1064
539
:returns: PullResult instance
1066
return InterBranch.get(source, self).pull(overwrite=overwrite,
1067
stop_revision=stop_revision,
1068
possible_transports=possible_transports, *args, **kwargs)
541
raise NotImplementedError(self.pull)
1070
def push(self, target, overwrite=False, stop_revision=None, *args,
543
def push(self, target, overwrite=False, stop_revision=None):
1072
544
"""Mirror this branch into target.
1074
546
This branch is considered to be 'local', having low latency.
1076
return InterBranch.get(self, target).push(overwrite, stop_revision,
1079
def lossy_push(self, target, stop_revision=None):
1080
"""Push deltas into another branch.
1082
:note: This does not, like push, retain the revision ids from
1083
the source branch and will, rather than adding bzr-specific
1084
metadata, push only those semantics of the revision that can be
1085
natively represented by this branch' VCS.
1087
:param target: Target branch
1088
:param stop_revision: Revision to push, defaults to last revision.
1089
:return: BranchPushResult with an extra member revidmap:
1090
A dictionary mapping revision ids from the target branch
1091
to new revision ids in the target branch, for each
1092
revision that was pushed.
1094
inter = InterBranch.get(self, target)
1095
lossy_push = getattr(inter, "lossy_push", None)
1096
if lossy_push is None:
1097
raise errors.LossyPushToSameVCS(self, target)
1098
return lossy_push(stop_revision)
548
raise NotImplementedError(self.push)
1100
550
def basis_tree(self):
1101
551
"""Return `Tree` object for last revision."""
1102
552
return self.repository.revision_tree(self.last_revision())
554
def rename_one(self, from_rel, to_rel):
557
This can change the directory or the filename or both.
559
raise NotImplementedError(self.rename_one)
561
def move(self, from_paths, to_name):
564
to_name must exist as a versioned directory.
566
If to_name exists and is a directory, the files are moved into
567
it, keeping their old names. If it is a directory,
569
Note that to_name is only the last component of the new name;
570
this doesn't change the directory.
572
This returns a list of (from_path, to_path) pairs for each
575
raise NotImplementedError(self.move)
1104
577
def get_parent(self):
1105
578
"""Return the parent location of the branch.
1107
This is the default location for pull/missing. The usual
580
This is the default location for push/pull/missing. The usual
1108
581
pattern is that the user can override it by specifying a
1111
parent = self._get_parent_location()
1114
# This is an old-format absolute path to a local branch
1115
# turn it into a url
1116
if parent.startswith('/'):
1117
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1119
return urlutils.join(self.base[:-1], parent)
1120
except errors.InvalidURLJoin, e:
1121
raise errors.InaccessibleParent(parent, self.user_url)
1123
def _get_parent_location(self):
1124
raise NotImplementedError(self._get_parent_location)
584
raise NotImplementedError(self.get_parent)
1126
586
def _set_config_location(self, name, url, config=None,
1127
587
make_relative=False):
1228
665
self.check_real_revno(revno)
1230
667
def check_real_revno(self, revno):
1232
669
Check whether a revno corresponds to a real revision.
1233
670
Zero (the NULL revision) is considered invalid
1235
672
if revno < 1 or revno > self.revno():
1236
raise errors.InvalidRevisionNumber(revno)
673
raise InvalidRevisionNumber(revno)
1238
675
@needs_read_lock
1239
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
676
def clone(self, to_bzrdir, revision_id=None):
1240
677
"""Clone this branch into to_bzrdir preserving all semantic values.
1242
Most API users will want 'create_clone_on_transport', which creates a
1243
new bzrdir and branch on the fly.
1245
679
revision_id: if not None, the revision history in the new branch will
1246
680
be truncated to end with revision_id.
1248
result = to_bzrdir.create_branch()
1251
if repository_policy is not None:
1252
repository_policy.configure_branch(result)
1253
self.copy_content_into(result, revision_id=revision_id)
682
result = self._format.initialize(to_bzrdir)
683
self.copy_content_into(result, revision_id=revision_id)
1258
686
@needs_read_lock
1259
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
687
def sprout(self, to_bzrdir, revision_id=None):
1260
688
"""Create a new line of development from the branch, into to_bzrdir.
1262
to_bzrdir controls the branch format.
1264
690
revision_id: if not None, the revision history in the new branch will
1265
691
be truncated to end with revision_id.
1267
if (repository_policy is not None and
1268
repository_policy.requires_stacking()):
1269
to_bzrdir._format.require_stacking(_skip_repo=True)
1270
result = to_bzrdir.create_branch()
1273
if repository_policy is not None:
1274
repository_policy.configure_branch(result)
1275
self.copy_content_into(result, revision_id=revision_id)
1276
result.set_parent(self.bzrdir.root_transport.base)
693
result = self._format.initialize(to_bzrdir)
694
self.copy_content_into(result, revision_id=revision_id)
695
result.set_parent(self.bzrdir.root_transport.base)
1281
698
def _synchronize_history(self, destination, revision_id):
1282
699
"""Synchronize last revision and revision history between branches.
1284
701
This version is most efficient when the destination is also a
1285
BzrBranch6, but works for BzrBranch5, as long as the destination's
1286
repository contains all the lefthand ancestors of the intended
1287
last_revision. If not, set_last_revision_info will fail.
702
BzrBranch5, but works for BzrBranch6 as long as the revision
703
history is the true lefthand parent history, and all of the revisions
704
are in the destination's repository. If not, set_revision_history
1289
707
:param destination: The branch to copy the history into
1290
708
:param revision_id: The revision-id to truncate history at. May
1291
709
be None to copy complete history.
1293
source_revno, source_revision_id = self.last_revision_info()
1294
if revision_id is None:
1295
revno, revision_id = source_revno, source_revision_id
1297
graph = self.repository.get_graph()
711
if revision_id == _mod_revision.NULL_REVISION:
713
new_history = self.revision_history()
714
if revision_id is not None and new_history != []:
715
revision_id = osutils.safe_revision_id(revision_id)
1299
revno = graph.find_distance_to_null(revision_id,
1300
[(source_revision_id, source_revno)])
1301
except errors.GhostRevisionsHaveNoRevno:
1302
# Default to 1, if we can't find anything else
1304
destination.set_last_revision_info(revno, revision_id)
717
new_history = new_history[:new_history.index(revision_id) + 1]
719
rev = self.repository.get_revision(revision_id)
720
new_history = rev.get_history(self.repository)[1:]
721
destination.set_revision_history(new_history)
1306
724
def copy_content_into(self, destination, revision_id=None):
1307
725
"""Copy the content of self into destination.
1309
727
revision_id: if not None, the revision history in the new branch will
1310
728
be truncated to end with revision_id.
1312
return InterBranch.get(self, destination).copy_content_into(
1313
revision_id=revision_id)
1315
def update_references(self, target):
1316
if not getattr(self._format, 'supports_reference_locations', False):
1318
reference_dict = self._get_all_reference_info()
1319
if len(reference_dict) == 0:
1321
old_base = self.base
1322
new_base = target.base
1323
target_reference_dict = target._get_all_reference_info()
1324
for file_id, (tree_path, branch_location) in (
1325
reference_dict.items()):
1326
branch_location = urlutils.rebase_url(branch_location,
1328
target_reference_dict.setdefault(
1329
file_id, (tree_path, branch_location))
1330
target._set_all_reference_info(target_reference_dict)
730
self._synchronize_history(destination, revision_id)
732
parent = self.get_parent()
733
except errors.InaccessibleParent, e:
734
mutter('parent was not accessible to copy: %s', e)
737
destination.set_parent(parent)
738
self.tags.merge_to(destination.tags)
1332
740
@needs_read_lock
1333
def check(self, refs):
1334
742
"""Check consistency of the branch.
1336
744
In particular this checks that revisions given in the revision-history
1337
do actually match up in the revision graph, and that they're all
745
do actually match up in the revision graph, and that they're all
1338
746
present in the repository.
1340
748
Callers will typically also want to check the repository.
1342
:param refs: Calculated refs for this branch as specified by
1343
branch._get_check_refs()
1344
750
:return: A BranchCheckResult.
1346
result = BranchCheckResult(self)
1347
last_revno, last_revision_id = self.last_revision_info()
1348
actual_revno = refs[('lefthand-distance', last_revision_id)]
1349
if actual_revno != last_revno:
1350
result.errors.append(errors.BzrCheckError(
1351
'revno does not match len(mainline) %s != %s' % (
1352
last_revno, actual_revno)))
1353
# TODO: We should probably also check that self.revision_history
1354
# matches the repository for older branch formats.
1355
# If looking for the code that cross-checks repository parents against
1356
# the iter_reverse_revision_history output, that is now a repository
752
mainline_parent_id = None
753
for revision_id in self.revision_history():
755
revision = self.repository.get_revision(revision_id)
756
except errors.NoSuchRevision, e:
757
raise errors.BzrCheckError("mainline revision {%s} not in repository"
759
# In general the first entry on the revision history has no parents.
760
# But it's not illegal for it to have parents listed; this can happen
761
# in imports from Arch when the parents weren't reachable.
762
if mainline_parent_id is not None:
763
if mainline_parent_id not in revision.parent_ids:
764
raise errors.BzrCheckError("previous revision {%s} not listed among "
766
% (mainline_parent_id, revision_id))
767
mainline_parent_id = revision_id
768
return BranchCheckResult(self)
1360
770
def _get_checkout_format(self):
1361
771
"""Return the most suitable metadir for a checkout of this branch.
1443
818
basis_tree.unlock()
1447
def reconcile(self, thorough=True):
1448
"""Make sure the data stored in this branch is consistent."""
1449
from bzrlib.reconcile import BranchReconciler
1450
reconciler = BranchReconciler(self, thorough=thorough)
1451
reconciler.reconcile()
1454
def reference_parent(self, file_id, path, possible_transports=None):
821
def reference_parent(self, file_id, path):
1455
822
"""Return the parent branch for a tree-reference file_id
1456
823
:param file_id: The file_id of the tree reference
1457
824
:param path: The path of the file_id in the tree
1458
825
:return: A branch associated with the file_id
1460
827
# FIXME should provide multiple branches, based on config
1461
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1462
possible_transports=possible_transports)
828
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1464
830
def supports_tags(self):
1465
831
return self._format.supports_tags()
1467
def automatic_tag_name(self, revision_id):
1468
"""Try to automatically find the tag name for a revision.
1470
:param revision_id: Revision id of the revision.
1471
:return: A tag name or None if no tag name could be determined.
1473
for hook in Branch.hooks['automatic_tag_name']:
1474
ret = hook(self, revision_id)
1479
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1481
"""Ensure that revision_b is a descendant of revision_a.
1483
This is a helper function for update_revisions.
1485
:raises: DivergedBranches if revision_b has diverged from revision_a.
1486
:returns: True if revision_b is a descendant of revision_a.
1488
relation = self._revision_relations(revision_a, revision_b, graph)
1489
if relation == 'b_descends_from_a':
1491
elif relation == 'diverged':
1492
raise errors.DivergedBranches(self, other_branch)
1493
elif relation == 'a_descends_from_b':
1496
raise AssertionError("invalid relation: %r" % (relation,))
1498
def _revision_relations(self, revision_a, revision_b, graph):
1499
"""Determine the relationship between two revisions.
1501
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1503
heads = graph.heads([revision_a, revision_b])
1504
if heads == set([revision_b]):
1505
return 'b_descends_from_a'
1506
elif heads == set([revision_a, revision_b]):
1507
# These branches have diverged
1509
elif heads == set([revision_a]):
1510
return 'a_descends_from_b'
1512
raise AssertionError("invalid heads: %r" % (heads,))
1515
834
class BranchFormat(object):
1516
835
"""An encapsulation of the initialization and open routines for a format.
1644
920
control_files = lockable_files.LockableFiles(branch_transport,
1645
921
lock_name, lock_class)
1646
922
control_files.create_lock()
1648
control_files.lock_write()
1649
except errors.LockContention:
1650
if lock_type != 'branch4':
923
control_files.lock_write()
1656
utf8_files += [('format', self.get_format_string())]
925
control_files.put_utf8('format', self.get_format_string())
1658
for (filename, content) in utf8_files:
1659
branch_transport.put_bytes(
1661
mode=a_bzrdir._get_file_mode())
927
for file, content in utf8_files:
928
control_files.put_utf8(file, content)
1664
control_files.unlock()
1665
branch = self.open(a_bzrdir, name, _found=True)
1666
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
930
control_files.unlock()
931
return self.open(a_bzrdir, _found=True)
1669
def initialize(self, a_bzrdir, name=None):
1670
"""Create a branch of this format in a_bzrdir.
1672
:param name: Name of the colocated branch to create.
933
def initialize(self, a_bzrdir):
934
"""Create a branch of this format in a_bzrdir."""
1674
935
raise NotImplementedError(self.initialize)
1676
937
def is_supported(self):
1677
938
"""Is this format supported?
1679
940
Supported formats can be initialized and opened.
1680
Unsupported formats may not support initialization or committing or
941
Unsupported formats may not support initialization or committing or
1681
942
some other features depending on the reason for not being supported.
1685
def make_tags(self, branch):
1686
"""Create a tags object for branch.
1688
This method is on BranchFormat, because BranchFormats are reflected
1689
over the wire via network_name(), whereas full Branch instances require
1690
multiple VFS method calls to operate at all.
1692
The default implementation returns a disabled-tags instance.
1694
Note that it is normal for branch to be a RemoteBranch when using tags
1697
return DisabledTags(branch)
1699
def network_name(self):
1700
"""A simple byte string uniquely identifying this format for RPC calls.
1702
MetaDir branch formats use their disk format string to identify the
1703
repository over the wire. All in one formats such as bzr < 0.8, and
1704
foreign formats like svn/git and hg should use some marker which is
1705
unique and immutable.
1707
raise NotImplementedError(self.network_name)
1709
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
946
def open(self, a_bzrdir, _found=False):
1710
947
"""Return the branch object for a_bzrdir
1712
:param a_bzrdir: A BzrDir that contains a branch.
1713
:param name: Name of colocated branch to open
1714
:param _found: a private parameter, do not use it. It is used to
1715
indicate if format probing has already be done.
1716
:param ignore_fallbacks: when set, no fallback branches will be opened
1717
(if there are any). Default is to open fallbacks.
949
_found is a private parameter, do not use it. It is used to indicate
950
if format probing has already be done.
1719
952
raise NotImplementedError(self.open)
1722
955
def register_format(klass, format):
1723
"""Register a metadir format.
1725
See MetaDirBranchFormatFactory for the ability to register a format
1726
without loading the code the format needs until it is actually used.
1728
956
klass._formats[format.get_format_string()] = format
1729
# Metadir formats have a network name of their format string, and get
1730
# registered as factories.
1731
if isinstance(format, MetaDirBranchFormatFactory):
1732
network_format_registry.register(format.get_format_string(), format)
1734
network_format_registry.register(format.get_format_string(),
1738
959
def set_default_format(klass, format):
1739
960
klass._default_format = format
1741
def supports_set_append_revisions_only(self):
1742
"""True if this format supports set_append_revisions_only."""
1745
def supports_stacking(self):
1746
"""True if this format records a stacked-on branch."""
1750
963
def unregister_format(klass, format):
964
assert klass._formats[format.get_format_string()] is format
1751
965
del klass._formats[format.get_format_string()]
1753
967
def __str__(self):
1754
return self.get_format_description().rstrip()
968
return self.get_format_string().rstrip()
1756
970
def supports_tags(self):
1757
971
"""True if this format supports tags stored in the branch"""
1758
972
return False # by default
1761
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1762
"""A factory for a BranchFormat object, permitting simple lazy registration.
1764
While none of the built in BranchFormats are lazy registered yet,
1765
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1766
use it, and the bzr-loom plugin uses it as well (see
1767
bzrlib.plugins.loom.formats).
1770
def __init__(self, format_string, module_name, member_name):
1771
"""Create a MetaDirBranchFormatFactory.
1773
:param format_string: The format string the format has.
1774
:param module_name: Module to load the format class from.
1775
:param member_name: Attribute name within the module for the format class.
1777
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1778
self._format_string = format_string
1780
def get_format_string(self):
1781
"""See BranchFormat.get_format_string."""
1782
return self._format_string
1785
"""Used for network_format_registry support."""
1786
return self.get_obj()()
974
# XXX: Probably doesn't really belong here -- mbp 20070212
975
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
977
branch_transport = a_bzrdir.get_branch_transport(self)
978
control_files = lockable_files.LockableFiles(branch_transport,
979
lock_filename, lock_class)
980
control_files.create_lock()
981
control_files.lock_write()
983
for filename, content in utf8_files:
984
control_files.put_utf8(filename, content)
986
control_files.unlock()
1789
989
class BranchHooks(Hooks):
1790
990
"""A dictionary mapping hook name to a list of callables for branch hooks.
1792
992
e.g. ['set_rh'] Is the list of items to be called when the
1793
993
set_revision_history function is invoked.
1802
1002
Hooks.__init__(self)
1803
self.create_hook(HookPoint('set_rh',
1804
"Invoked whenever the revision history has been set via "
1805
"set_revision_history. The api signature is (branch, "
1806
"revision_history), and the branch will be write-locked. "
1807
"The set_rh hook can be expensive for bzr to trigger, a better "
1808
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1809
self.create_hook(HookPoint('open',
1810
"Called with the Branch object that has been opened after a "
1811
"branch is opened.", (1, 8), None))
1812
self.create_hook(HookPoint('post_push',
1813
"Called after a push operation completes. post_push is called "
1814
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1815
"bzr client.", (0, 15), None))
1816
self.create_hook(HookPoint('post_pull',
1817
"Called after a pull operation completes. post_pull is called "
1818
"with a bzrlib.branch.PullResult object and only runs in the "
1819
"bzr client.", (0, 15), None))
1820
self.create_hook(HookPoint('pre_commit',
1821
"Called after a commit is calculated but before it is is "
1822
"completed. pre_commit is called with (local, master, old_revno, "
1823
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1824
"). old_revid is NULL_REVISION for the first commit to a branch, "
1825
"tree_delta is a TreeDelta object describing changes from the "
1826
"basis revision. hooks MUST NOT modify this delta. "
1827
" future_tree is an in-memory tree obtained from "
1828
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1829
"tree.", (0,91), None))
1830
self.create_hook(HookPoint('post_commit',
1831
"Called in the bzr client after a commit has completed. "
1832
"post_commit is called with (local, master, old_revno, old_revid, "
1833
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1834
"commit to a branch.", (0, 15), None))
1835
self.create_hook(HookPoint('post_uncommit',
1836
"Called in the bzr client after an uncommit completes. "
1837
"post_uncommit is called with (local, master, old_revno, "
1838
"old_revid, new_revno, new_revid) where local is the local branch "
1839
"or None, master is the target branch, and an empty branch "
1840
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1841
self.create_hook(HookPoint('pre_change_branch_tip',
1842
"Called in bzr client and server before a change to the tip of a "
1843
"branch is made. pre_change_branch_tip is called with a "
1844
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1845
"commit, uncommit will all trigger this hook.", (1, 6), None))
1846
self.create_hook(HookPoint('post_change_branch_tip',
1847
"Called in bzr client and server after a change to the tip of a "
1848
"branch is made. post_change_branch_tip is called with a "
1849
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1850
"commit, uncommit will all trigger this hook.", (1, 4), None))
1851
self.create_hook(HookPoint('transform_fallback_location',
1852
"Called when a stacked branch is activating its fallback "
1853
"locations. transform_fallback_location is called with (branch, "
1854
"url), and should return a new url. Returning the same url "
1855
"allows it to be used as-is, returning a different one can be "
1856
"used to cause the branch to stack on a closer copy of that "
1857
"fallback_location. Note that the branch cannot have history "
1858
"accessing methods called on it during this hook because the "
1859
"fallback locations have not been activated. When there are "
1860
"multiple hooks installed for transform_fallback_location, "
1861
"all are called with the url returned from the previous hook."
1862
"The order is however undefined.", (1, 9), None))
1863
self.create_hook(HookPoint('automatic_tag_name',
1864
"Called to determine an automatic tag name for a revision. "
1865
"automatic_tag_name is called with (branch, revision_id) and "
1866
"should return a tag name or None if no tag name could be "
1867
"determined. The first non-None tag name returned will be used.",
1869
self.create_hook(HookPoint('post_branch_init',
1870
"Called after new branch initialization completes. "
1871
"post_branch_init is called with a "
1872
"bzrlib.branch.BranchInitHookParams. "
1873
"Note that init, branch and checkout (both heavyweight and "
1874
"lightweight) will all trigger this hook.", (2, 2), None))
1875
self.create_hook(HookPoint('post_switch',
1876
"Called after a checkout switches branch. "
1877
"post_switch is called with a "
1878
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1003
# Introduced in 0.15:
1004
# invoked whenever the revision history has been set
1005
# with set_revision_history. The api signature is
1006
# (branch, revision_history), and the branch will
1009
# invoked after a push operation completes.
1010
# the api signature is
1012
# containing the members
1013
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1014
# where local is the local target branch or None, master is the target
1015
# master branch, and the rest should be self explanatory. The source
1016
# is read locked and the target branches write locked. Source will
1017
# be the local low-latency branch.
1018
self['post_push'] = []
1019
# invoked after a pull operation completes.
1020
# the api signature is
1022
# containing the members
1023
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1024
# where local is the local branch or None, master is the target
1025
# master branch, and the rest should be self explanatory. The source
1026
# is read locked and the target branches write locked. The local
1027
# branch is the low-latency branch.
1028
self['post_pull'] = []
1029
# invoked after a commit operation completes.
1030
# the api signature is
1031
# (local, master, old_revno, old_revid, new_revno, new_revid)
1032
# old_revid is NULL_REVISION for the first commit to a branch.
1033
self['post_commit'] = []
1034
# invoked after a uncommit operation completes.
1035
# the api signature is
1036
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1037
# local is the local branch or None, master is the target branch,
1038
# and an empty branch recieves new_revno of 0, new_revid of None.
1039
self['post_uncommit'] = []
1882
1042
# install the default hooks into the Branch class.
1883
1043
Branch.hooks = BranchHooks()
1886
class ChangeBranchTipParams(object):
1887
"""Object holding parameters passed to *_change_branch_tip hooks.
1889
There are 5 fields that hooks may wish to access:
1891
:ivar branch: the branch being changed
1892
:ivar old_revno: revision number before the change
1893
:ivar new_revno: revision number after the change
1894
:ivar old_revid: revision id before the change
1895
:ivar new_revid: revision id after the change
1897
The revid fields are strings. The revno fields are integers.
1900
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1901
"""Create a group of ChangeBranchTip parameters.
1903
:param branch: The branch being changed.
1904
:param old_revno: Revision number before the change.
1905
:param new_revno: Revision number after the change.
1906
:param old_revid: Tip revision id before the change.
1907
:param new_revid: Tip revision id after the change.
1909
self.branch = branch
1910
self.old_revno = old_revno
1911
self.new_revno = new_revno
1912
self.old_revid = old_revid
1913
self.new_revid = new_revid
1915
def __eq__(self, other):
1916
return self.__dict__ == other.__dict__
1919
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1920
self.__class__.__name__, self.branch,
1921
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1924
class BranchInitHookParams(object):
1925
"""Object holding parameters passed to *_branch_init hooks.
1927
There are 4 fields that hooks may wish to access:
1929
:ivar format: the branch format
1930
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1931
:ivar name: name of colocated branch, if any (or None)
1932
:ivar branch: the branch created
1934
Note that for lightweight checkouts, the bzrdir and format fields refer to
1935
the checkout, hence they are different from the corresponding fields in
1936
branch, which refer to the original branch.
1939
def __init__(self, format, a_bzrdir, name, branch):
1940
"""Create a group of BranchInitHook parameters.
1942
:param format: the branch format
1943
:param a_bzrdir: the BzrDir where the branch will be/has been
1945
:param name: name of colocated branch, if any (or None)
1946
:param branch: the branch created
1948
Note that for lightweight checkouts, the bzrdir and format fields refer
1949
to the checkout, hence they are different from the corresponding fields
1950
in branch, which refer to the original branch.
1952
self.format = format
1953
self.bzrdir = a_bzrdir
1955
self.branch = branch
1957
def __eq__(self, other):
1958
return self.__dict__ == other.__dict__
1962
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1964
return "<%s of format:%s bzrdir:%s>" % (
1965
self.__class__.__name__, self.branch,
1966
self.format, self.bzrdir)
1969
class SwitchHookParams(object):
1970
"""Object holding parameters passed to *_switch hooks.
1972
There are 4 fields that hooks may wish to access:
1974
:ivar control_dir: BzrDir of the checkout to change
1975
:ivar to_branch: branch that the checkout is to reference
1976
:ivar force: skip the check for local commits in a heavy checkout
1977
:ivar revision_id: revision ID to switch to (or None)
1980
def __init__(self, control_dir, to_branch, force, revision_id):
1981
"""Create a group of SwitchHook parameters.
1983
:param control_dir: BzrDir of the checkout to change
1984
:param to_branch: branch that the checkout is to reference
1985
:param force: skip the check for local commits in a heavy checkout
1986
:param revision_id: revision ID to switch to (or None)
1988
self.control_dir = control_dir
1989
self.to_branch = to_branch
1991
self.revision_id = revision_id
1993
def __eq__(self, other):
1994
return self.__dict__ == other.__dict__
1997
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1998
self.control_dir, self.to_branch,
2002
1046
class BzrBranchFormat4(BranchFormat):
2003
1047
"""Bzr branch format 4.
2011
1055
"""See BranchFormat.get_format_description()."""
2012
1056
return "Branch format 4"
2014
def initialize(self, a_bzrdir, name=None):
1058
def initialize(self, a_bzrdir):
2015
1059
"""Create a branch of this format in a_bzrdir."""
2016
1060
utf8_files = [('revision-history', ''),
2017
1061
('branch-name', ''),
2019
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1063
return self._initialize_helper(a_bzrdir, utf8_files,
2020
1064
lock_type='branch4', set_format=False)
2022
1066
def __init__(self):
2023
1067
super(BzrBranchFormat4, self).__init__()
2024
1068
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2026
def network_name(self):
2027
"""The network name for this format is the control dirs disk label."""
2028
return self._matchingbzrdir.get_format_string()
1070
def open(self, a_bzrdir, _found=False):
1071
"""Return the branch object for a_bzrdir
2030
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2031
"""See BranchFormat.open()."""
1073
_found is a private parameter, do not use it. It is used to indicate
1074
if format probing has already be done.
2033
1077
# we are being called directly and must probe.
2034
1078
raise NotImplementedError
2035
1079
return BzrBranch(_format=self,
2036
1080
_control_files=a_bzrdir._control_files,
2037
1081
a_bzrdir=a_bzrdir,
2039
1082
_repository=a_bzrdir.open_repository())
2041
1084
def __str__(self):
2042
1085
return "Bazaar-NG branch format 4"
2045
class BranchFormatMetadir(BranchFormat):
2046
"""Common logic for meta-dir based branch formats."""
2048
def _branch_class(self):
2049
"""What class to instantiate on open calls."""
2050
raise NotImplementedError(self._branch_class)
2052
def network_name(self):
2053
"""A simple byte string uniquely identifying this format for RPC calls.
2055
Metadir branch formats use their format string.
1088
class BzrBranchFormat5(BranchFormat):
1089
"""Bzr branch format 5.
1092
- a revision-history file.
1094
- a lock dir guarding the branch itself
1095
- all of this stored in a branch/ subdirectory
1096
- works with shared repositories.
1098
This format is new in bzr 0.8.
1101
def get_format_string(self):
1102
"""See BranchFormat.get_format_string()."""
1103
return "Bazaar-NG branch format 5\n"
1105
def get_format_description(self):
1106
"""See BranchFormat.get_format_description()."""
1107
return "Branch format 5"
1109
def initialize(self, a_bzrdir):
1110
"""Create a branch of this format in a_bzrdir."""
1111
utf8_files = [('revision-history', ''),
1112
('branch-name', ''),
1114
return self._initialize_helper(a_bzrdir, utf8_files)
1117
super(BzrBranchFormat5, self).__init__()
1118
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1120
def open(self, a_bzrdir, _found=False):
1121
"""Return the branch object for a_bzrdir
1123
_found is a private parameter, do not use it. It is used to indicate
1124
if format probing has already be done.
2057
return self.get_format_string()
2059
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2060
"""See BranchFormat.open()."""
2062
format = BranchFormat.find_format(a_bzrdir, name=name)
2063
if format.__class__ != self.__class__:
2064
raise AssertionError("wrong format %r found for %r" %
2066
transport = a_bzrdir.get_branch_transport(None, name=name)
1127
format = BranchFormat.find_format(a_bzrdir)
1128
assert format.__class__ == self.__class__
1130
transport = a_bzrdir.get_branch_transport(None)
2068
1131
control_files = lockable_files.LockableFiles(transport, 'lock',
2069
1132
lockdir.LockDir)
2070
return self._branch_class()(_format=self,
1133
return BzrBranch5(_format=self,
2071
1134
_control_files=control_files,
2073
1135
a_bzrdir=a_bzrdir,
2074
_repository=a_bzrdir.find_repository(),
2075
ignore_fallbacks=ignore_fallbacks)
2076
except errors.NoSuchFile:
2077
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2080
super(BranchFormatMetadir, self).__init__()
2081
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2082
self._matchingbzrdir.set_branch_format(self)
2084
def supports_tags(self):
2088
class BzrBranchFormat5(BranchFormatMetadir):
2089
"""Bzr branch format 5.
2092
- a revision-history file.
2094
- a lock dir guarding the branch itself
2095
- all of this stored in a branch/ subdirectory
2096
- works with shared repositories.
2098
This format is new in bzr 0.8.
2101
def _branch_class(self):
2104
def get_format_string(self):
2105
"""See BranchFormat.get_format_string()."""
2106
return "Bazaar-NG branch format 5\n"
2108
def get_format_description(self):
2109
"""See BranchFormat.get_format_description()."""
2110
return "Branch format 5"
2112
def initialize(self, a_bzrdir, name=None):
2113
"""Create a branch of this format in a_bzrdir."""
2114
utf8_files = [('revision-history', ''),
2115
('branch-name', ''),
2117
return self._initialize_helper(a_bzrdir, utf8_files, name)
2119
def supports_tags(self):
2123
class BzrBranchFormat6(BranchFormatMetadir):
2124
"""Branch format with last-revision and tags.
1136
_repository=a_bzrdir.find_repository())
1138
raise NotBranchError(path=transport.base)
1141
class BzrBranchFormat6(BzrBranchFormat5):
1142
"""Branch format with last-revision
2126
1144
Unlike previous formats, this has no explicit revision history. Instead,
2127
1145
this just stores the last-revision, and the left-hand history leading
2128
1146
up to there is the history.
2130
1148
This format was introduced in bzr 0.15
2131
and became the default in 0.91.
2134
def _branch_class(self):
2137
1151
def get_format_string(self):
2138
1152
"""See BranchFormat.get_format_string()."""
2139
1153
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2142
1156
"""See BranchFormat.get_format_description()."""
2143
1157
return "Branch format 6"
2145
def initialize(self, a_bzrdir, name=None):
2146
"""Create a branch of this format in a_bzrdir."""
2147
utf8_files = [('last-revision', '0 null:\n'),
2148
('branch.conf', ''),
2151
return self._initialize_helper(a_bzrdir, utf8_files, name)
2153
def make_tags(self, branch):
2154
"""See bzrlib.branch.BranchFormat.make_tags()."""
2155
return BasicTags(branch)
2157
def supports_set_append_revisions_only(self):
2161
class BzrBranchFormat8(BranchFormatMetadir):
2162
"""Metadir format supporting storing locations of subtree branches."""
2164
def _branch_class(self):
2167
def get_format_string(self):
2168
"""See BranchFormat.get_format_string()."""
2169
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2171
def get_format_description(self):
2172
"""See BranchFormat.get_format_description()."""
2173
return "Branch format 8"
2175
def initialize(self, a_bzrdir, name=None):
2176
"""Create a branch of this format in a_bzrdir."""
2177
utf8_files = [('last-revision', '0 null:\n'),
2178
('branch.conf', ''),
2182
return self._initialize_helper(a_bzrdir, utf8_files, name)
2185
super(BzrBranchFormat8, self).__init__()
2186
self._matchingbzrdir.repository_format = \
2187
RepositoryFormatKnitPack5RichRoot()
2189
def make_tags(self, branch):
2190
"""See bzrlib.branch.BranchFormat.make_tags()."""
2191
return BasicTags(branch)
2193
def supports_set_append_revisions_only(self):
2196
def supports_stacking(self):
2199
supports_reference_locations = True
2202
class BzrBranchFormat7(BzrBranchFormat8):
2203
"""Branch format with last-revision, tags, and a stacked location pointer.
2205
The stacked location pointer is passed down to the repository and requires
2206
a repository format with supports_external_lookups = True.
2208
This format was introduced in bzr 1.6.
2211
def initialize(self, a_bzrdir, name=None):
2212
"""Create a branch of this format in a_bzrdir."""
2213
utf8_files = [('last-revision', '0 null:\n'),
2214
('branch.conf', ''),
2217
return self._initialize_helper(a_bzrdir, utf8_files, name)
2219
def _branch_class(self):
2222
def get_format_string(self):
2223
"""See BranchFormat.get_format_string()."""
2224
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2226
def get_format_description(self):
2227
"""See BranchFormat.get_format_description()."""
2228
return "Branch format 7"
2230
def supports_set_append_revisions_only(self):
2233
supports_reference_locations = False
1159
def initialize(self, a_bzrdir):
1160
"""Create a branch of this format in a_bzrdir."""
1161
utf8_files = [('last-revision', '0 null:\n'),
1162
('branch-name', ''),
1163
('branch.conf', ''),
1166
return self._initialize_helper(a_bzrdir, utf8_files)
1168
def open(self, a_bzrdir, _found=False):
1169
"""Return the branch object for a_bzrdir
1171
_found is a private parameter, do not use it. It is used to indicate
1172
if format probing has already be done.
1175
format = BranchFormat.find_format(a_bzrdir)
1176
assert format.__class__ == self.__class__
1177
transport = a_bzrdir.get_branch_transport(None)
1178
control_files = lockable_files.LockableFiles(transport, 'lock',
1180
return BzrBranch6(_format=self,
1181
_control_files=control_files,
1183
_repository=a_bzrdir.find_repository())
1185
def supports_tags(self):
2236
1189
class BranchReferenceFormat(BranchFormat):
2251
1204
def get_format_description(self):
2252
1205
"""See BranchFormat.get_format_description()."""
2253
1206
return "Checkout reference format 1"
2255
def get_reference(self, a_bzrdir, name=None):
1208
def get_reference(self, a_bzrdir):
2256
1209
"""See BranchFormat.get_reference()."""
2257
transport = a_bzrdir.get_branch_transport(None, name=name)
2258
return transport.get_bytes('location')
2260
def set_reference(self, a_bzrdir, name, to_branch):
2261
"""See BranchFormat.set_reference()."""
2262
transport = a_bzrdir.get_branch_transport(None, name=name)
2263
location = transport.put_bytes('location', to_branch.base)
2265
def initialize(self, a_bzrdir, name=None, target_branch=None):
1210
transport = a_bzrdir.get_branch_transport(None)
1211
return transport.get('location').read()
1213
def initialize(self, a_bzrdir, target_branch=None):
2266
1214
"""Create a branch of this format in a_bzrdir."""
2267
1215
if target_branch is None:
2268
1216
# this format does not implement branch itself, thus the implicit
2269
1217
# creation contract must see it as uninitializable
2270
1218
raise errors.UninitializableFormat(self)
2271
mutter('creating branch reference in %s', a_bzrdir.user_url)
2272
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1219
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1220
branch_transport = a_bzrdir.get_branch_transport(self)
2273
1221
branch_transport.put_bytes('location',
2274
target_branch.bzrdir.user_url)
1222
target_branch.bzrdir.root_transport.base)
2275
1223
branch_transport.put_bytes('format', self.get_format_string())
2277
a_bzrdir, name, _found=True,
2278
possible_transports=[target_branch.bzrdir.root_transport])
2279
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1224
return self.open(a_bzrdir, _found=True)
2282
1226
def __init__(self):
2283
1227
super(BranchReferenceFormat, self).__init__()
2284
1228
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2285
self._matchingbzrdir.set_branch_format(self)
2287
1230
def _make_reference_clone_function(format, a_branch):
2288
1231
"""Create a clone() routine for a branch dynamically."""
2289
def clone(to_bzrdir, revision_id=None,
2290
repository_policy=None):
1232
def clone(to_bzrdir, revision_id=None):
2291
1233
"""See Branch.clone()."""
2292
return format.initialize(to_bzrdir, target_branch=a_branch)
1234
return format.initialize(to_bzrdir, a_branch)
2293
1235
# cannot obey revision_id limits when cloning a reference ...
2294
1236
# FIXME RBC 20060210 either nuke revision_id for clone, or
2295
1237
# emit some sort of warning/error to the caller ?!
2298
def open(self, a_bzrdir, name=None, _found=False, location=None,
2299
possible_transports=None, ignore_fallbacks=False):
1240
def open(self, a_bzrdir, _found=False, location=None):
2300
1241
"""Return the branch that the branch reference in a_bzrdir points at.
2302
:param a_bzrdir: A BzrDir that contains a branch.
2303
:param name: Name of colocated branch to open, if any
2304
:param _found: a private parameter, do not use it. It is used to
2305
indicate if format probing has already be done.
2306
:param ignore_fallbacks: when set, no fallback branches will be opened
2307
(if there are any). Default is to open fallbacks.
2308
:param location: The location of the referenced branch. If
2309
unspecified, this will be determined from the branch reference in
2311
:param possible_transports: An optional reusable transports list.
1243
_found is a private parameter, do not use it. It is used to indicate
1244
if format probing has already be done.
2314
format = BranchFormat.find_format(a_bzrdir, name=name)
2315
if format.__class__ != self.__class__:
2316
raise AssertionError("wrong format %r found for %r" %
1247
format = BranchFormat.find_format(a_bzrdir)
1248
assert format.__class__ == self.__class__
2318
1249
if location is None:
2319
location = self.get_reference(a_bzrdir, name)
2320
real_bzrdir = bzrdir.BzrDir.open(
2321
location, possible_transports=possible_transports)
2322
result = real_bzrdir.open_branch(name=name,
2323
ignore_fallbacks=ignore_fallbacks)
1250
location = self.get_reference(a_bzrdir)
1251
real_bzrdir = bzrdir.BzrDir.open(location)
1252
result = real_bzrdir.open_branch()
2324
1253
# this changes the behaviour of result.clone to create a new reference
2325
1254
# rather than a copy of the content of the branch.
2326
1255
# I did not use a proxy object because that needs much more extensive
2336
network_format_registry = registry.FormatRegistry()
2337
"""Registry of formats indexed by their network name.
2339
The network name for a branch format is an identifier that can be used when
2340
referring to formats with smart server operations. See
2341
BranchFormat.network_name() for more detail.
2345
1265
# formats which have no format string are not discoverable
2346
1266
# and not independently creatable, so are not registered.
2347
__format5 = BzrBranchFormat5()
2348
__format6 = BzrBranchFormat6()
2349
__format7 = BzrBranchFormat7()
2350
__format8 = BzrBranchFormat8()
2351
BranchFormat.register_format(__format5)
1267
__default_format = BzrBranchFormat5()
1268
BranchFormat.register_format(__default_format)
2352
1269
BranchFormat.register_format(BranchReferenceFormat())
2353
BranchFormat.register_format(__format6)
2354
BranchFormat.register_format(__format7)
2355
BranchFormat.register_format(__format8)
2356
BranchFormat.set_default_format(__format7)
1270
BranchFormat.register_format(BzrBranchFormat6())
1271
BranchFormat.set_default_format(__default_format)
2357
1272
_legacy_formats = [BzrBranchFormat4(),
2359
network_format_registry.register(
2360
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2363
class BranchWriteLockResult(LogicalLockResult):
2364
"""The result of write locking a branch.
2366
:ivar branch_token: The token obtained from the underlying branch lock, or
2368
:ivar unlock: A callable which will unlock the lock.
2371
def __init__(self, unlock, branch_token):
2372
LogicalLockResult.__init__(self, unlock)
2373
self.branch_token = branch_token
2376
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2380
class BzrBranch(Branch, _RelockDebugMixin):
1275
class BzrBranch(Branch):
2381
1276
"""A branch stored in the actual filesystem.
2383
1278
Note that it's "local" in the context of the filesystem; it doesn't
2384
1279
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2385
1280
it's writable, and can be accessed via the normal filesystem API.
2387
:ivar _transport: Transport for file operations on this branch's
2388
control files, typically pointing to the .bzr/branch directory.
2389
:ivar repository: Repository for this branch.
2390
:ivar base: The url of the base directory for this branch; the one
2391
containing the .bzr directory.
2392
:ivar name: Optional colocated branch name as it exists in the control
2396
1283
def __init__(self, _format=None,
2397
_control_files=None, a_bzrdir=None, name=None,
2398
_repository=None, ignore_fallbacks=False):
1284
_control_files=None, a_bzrdir=None, _repository=None):
2399
1285
"""Create new branch object at a particular location."""
1286
Branch.__init__(self)
2400
1287
if a_bzrdir is None:
2401
1288
raise ValueError('a_bzrdir must be supplied')
2403
1290
self.bzrdir = a_bzrdir
1291
# self._transport used to point to the directory containing the
1292
# control directory, but was not used - now it's just the transport
1293
# for the branch control files. mbp 20070212
2404
1294
self._base = self.bzrdir.transport.clone('..').base
2406
# XXX: We should be able to just do
2407
# self.base = self.bzrdir.root_transport.base
2408
# but this does not quite work yet -- mbp 20080522
2409
1295
self._format = _format
2410
1296
if _control_files is None:
2411
1297
raise ValueError('BzrBranch _control_files is None')
2412
1298
self.control_files = _control_files
2413
1299
self._transport = _control_files._transport
2414
1300
self.repository = _repository
2415
Branch.__init__(self)
2417
1302
def __str__(self):
2418
if self.name is None:
2419
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2421
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
1303
return '%s(%r)' % (self.__class__.__name__, self.base)
2424
1305
__repr__ = __str__
2430
1311
base = property(_get_base, doc="The URL for the root of this branch.")
2432
def _get_config(self):
2433
return TransportConfig(self._transport, 'branch.conf')
1313
def abspath(self, name):
1314
"""See Branch.abspath."""
1315
return self.control_files._transport.abspath(name)
1318
@deprecated_method(zero_sixteen)
1320
def get_root_id(self):
1321
"""See Branch.get_root_id."""
1322
tree = self.repository.revision_tree(self.last_revision())
1323
return tree.inventory.root.file_id
2435
1325
def is_locked(self):
2436
1326
return self.control_files.is_locked()
2438
1328
def lock_write(self, token=None):
2439
"""Lock the branch for write operations.
2441
:param token: A token to permit reacquiring a previously held and
2443
:return: A BranchWriteLockResult.
2445
if not self.is_locked():
2446
self._note_lock('w')
2447
# All-in-one needs to always unlock/lock.
2448
repo_control = getattr(self.repository, 'control_files', None)
2449
if self.control_files == repo_control or not self.is_locked():
2450
self.repository._warn_if_deprecated(self)
2451
self.repository.lock_write()
1329
repo_token = self.repository.lock_write()
2456
return BranchWriteLockResult(self.unlock,
2457
self.control_files.lock_write(token=token))
1331
token = self.control_files.lock_write(token=token)
2460
self.repository.unlock()
1333
self.repository.unlock()
2463
1337
def lock_read(self):
2464
"""Lock the branch for read operations.
2466
:return: A bzrlib.lock.LogicalLockResult.
2468
if not self.is_locked():
2469
self._note_lock('r')
2470
# All-in-one needs to always unlock/lock.
2471
repo_control = getattr(self.repository, 'control_files', None)
2472
if self.control_files == repo_control or not self.is_locked():
2473
self.repository._warn_if_deprecated(self)
2474
self.repository.lock_read()
1338
self.repository.lock_read()
2479
1340
self.control_files.lock_read()
2480
return LogicalLockResult(self.unlock)
2483
self.repository.unlock()
1342
self.repository.unlock()
2486
@only_raises(errors.LockNotHeld, errors.LockBroken)
2487
1345
def unlock(self):
1346
# TODO: test for failed two phase locks. This is known broken.
2489
1348
self.control_files.unlock()
2491
# All-in-one needs to always unlock/lock.
2492
repo_control = getattr(self.repository, 'control_files', None)
2493
if (self.control_files == repo_control or
2494
not self.control_files.is_locked()):
2495
self.repository.unlock()
2496
if not self.control_files.is_locked():
2497
# we just released the lock
2498
self._clear_cached_state()
1350
self.repository.unlock()
1351
if not self.control_files.is_locked():
1352
# we just released the lock
1353
self._clear_cached_state()
2500
1355
def peek_lock_mode(self):
2501
1356
if self.control_files._lock_count == 0:
2511
1366
"""See Branch.print_file."""
2512
1367
return self.repository.print_file(file, revision_id)
1370
def append_revision(self, *revision_ids):
1371
"""See Branch.append_revision."""
1372
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1373
for revision_id in revision_ids:
1374
_mod_revision.check_not_reserved_id(revision_id)
1375
mutter("add {%s} to revision-history" % revision_id)
1376
rev_history = self.revision_history()
1377
rev_history.extend(revision_ids)
1378
self.set_revision_history(rev_history)
2514
1380
def _write_revision_history(self, history):
2515
1381
"""Factored out of set_revision_history.
2517
1383
This performs the actual writing to disk.
2518
1384
It is intended to be called by BzrBranch5.set_revision_history."""
2519
self._transport.put_bytes(
2520
'revision-history', '\n'.join(history),
2521
mode=self.bzrdir._get_file_mode())
1385
self.control_files.put_bytes(
1386
'revision-history', '\n'.join(history))
2523
1388
@needs_write_lock
2524
1389
def set_revision_history(self, rev_history):
2525
1390
"""See Branch.set_revision_history."""
2526
if 'evil' in debug.debug_flags:
2527
mutter_callsite(3, "set_revision_history scales with history.")
2528
check_not_reserved_id = _mod_revision.check_not_reserved_id
2529
for rev_id in rev_history:
2530
check_not_reserved_id(rev_id)
2531
if Branch.hooks['post_change_branch_tip']:
2532
# Don't calculate the last_revision_info() if there are no hooks
2534
old_revno, old_revid = self.last_revision_info()
2535
if len(rev_history) == 0:
2536
revid = _mod_revision.NULL_REVISION
2538
revid = rev_history[-1]
2539
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1391
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1392
self._clear_cached_state()
2540
1393
self._write_revision_history(rev_history)
2541
self._clear_cached_state()
2542
1394
self._cache_revision_history(rev_history)
2543
1395
for hook in Branch.hooks['set_rh']:
2544
1396
hook(self, rev_history)
2545
if Branch.hooks['post_change_branch_tip']:
2546
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2548
def _synchronize_history(self, destination, revision_id):
2549
"""Synchronize last revision and revision history between branches.
2551
This version is most efficient when the destination is also a
2552
BzrBranch5, but works for BzrBranch6 as long as the revision
2553
history is the true lefthand parent history, and all of the revisions
2554
are in the destination's repository. If not, set_revision_history
2557
:param destination: The branch to copy the history into
2558
:param revision_id: The revision-id to truncate history at. May
2559
be None to copy complete history.
2561
if not isinstance(destination._format, BzrBranchFormat5):
2562
super(BzrBranch, self)._synchronize_history(
2563
destination, revision_id)
2565
if revision_id == _mod_revision.NULL_REVISION:
2568
new_history = self.revision_history()
2569
if revision_id is not None and new_history != []:
2571
new_history = new_history[:new_history.index(revision_id) + 1]
2573
rev = self.repository.get_revision(revision_id)
2574
new_history = rev.get_history(self.repository)[1:]
2575
destination.set_revision_history(new_history)
2577
1398
@needs_write_lock
2578
1399
def set_last_revision_info(self, revno, revision_id):
2579
"""Set the last revision of this branch.
2581
The caller is responsible for checking that the revno is correct
2582
for this revision id.
2584
It may be possible to set the branch last revision to an id not
2585
present in the repository. However, branches can also be
2586
configured to check constraints on history, in which case this may not
2589
revision_id = _mod_revision.ensure_null(revision_id)
2590
# this old format stores the full history, but this api doesn't
2591
# provide it, so we must generate, and might as well check it's
1400
revision_id = osutils.safe_revision_id(revision_id)
2593
1401
history = self._lefthand_history(revision_id)
2594
if len(history) != revno:
2595
raise AssertionError('%d != %d' % (len(history), revno))
1402
assert len(history) == revno, '%d != %d' % (len(history), revno)
2596
1403
self.set_revision_history(history)
2598
1405
def _gen_revision_history(self):
2599
history = self._transport.get_bytes('revision-history').split('\n')
1406
history = self.control_files.get('revision-history').read().split('\n')
2600
1407
if history[-1:] == ['']:
2601
1408
# There shouldn't be a trailing newline, but just in case.
1412
def _lefthand_history(self, revision_id, last_rev=None,
1414
# stop_revision must be a descendant of last_revision
1415
stop_graph = self.repository.get_revision_graph(revision_id)
1416
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1417
and last_rev not in stop_graph):
1418
# our previous tip is not merged into stop_revision
1419
raise errors.DivergedBranches(self, other_branch)
1420
# make a new revision history from the graph
1421
current_rev_id = revision_id
1423
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1424
new_history.append(current_rev_id)
1425
current_rev_id_parents = stop_graph[current_rev_id]
1427
current_rev_id = current_rev_id_parents[0]
1429
current_rev_id = None
1430
new_history.reverse()
2605
1433
@needs_write_lock
2606
1434
def generate_revision_history(self, revision_id, last_rev=None,
2607
1435
other_branch=None):
2613
1441
:param other_branch: The other branch that DivergedBranches should
2614
1442
raise with respect to.
1444
revision_id = osutils.safe_revision_id(revision_id)
2616
1445
self.set_revision_history(self._lefthand_history(revision_id,
2617
1446
last_rev, other_branch))
1449
def update_revisions(self, other, stop_revision=None):
1450
"""See Branch.update_revisions."""
1453
if stop_revision is None:
1454
stop_revision = other.last_revision()
1455
if stop_revision is None:
1456
# if there are no commits, we're done.
1459
stop_revision = osutils.safe_revision_id(stop_revision)
1460
# whats the current last revision, before we fetch [and change it
1462
last_rev = _mod_revision.ensure_null(self.last_revision())
1463
# we fetch here regardless of whether we need to so that we pickup
1465
self.fetch(other, stop_revision)
1466
if self.repository.get_graph().is_ancestor(stop_revision,
1469
self.generate_revision_history(stop_revision, last_rev=last_rev,
2619
1474
def basis_tree(self):
2620
1475
"""See Branch.basis_tree."""
2621
1476
return self.repository.revision_tree(self.last_revision())
1478
@deprecated_method(zero_eight)
1479
def working_tree(self):
1480
"""Create a Working tree object for this branch."""
1482
from bzrlib.transport.local import LocalTransport
1483
if (self.base.find('://') != -1 or
1484
not isinstance(self._transport, LocalTransport)):
1485
raise NoWorkingTree(self.base)
1486
return self.bzrdir.open_workingtree()
1489
def pull(self, source, overwrite=False, stop_revision=None,
1490
_hook_master=None, run_hooks=True):
1493
:param _hook_master: Private parameter - set the branch to
1494
be supplied as the master to push hooks.
1495
:param run_hooks: Private parameter - if false, this branch
1496
is being called because it's the master of the primary branch,
1497
so it should not run its hooks.
1499
result = PullResult()
1500
result.source_branch = source
1501
result.target_branch = self
1504
result.old_revno, result.old_revid = self.last_revision_info()
1506
self.update_revisions(source, stop_revision)
1507
except DivergedBranches:
1511
if stop_revision is None:
1512
stop_revision = source.last_revision()
1513
self.generate_revision_history(stop_revision)
1514
result.tag_conflicts = source.tags.merge_to(self.tags)
1515
result.new_revno, result.new_revid = self.last_revision_info()
1517
result.master_branch = _hook_master
1518
result.local_branch = self
1520
result.master_branch = self
1521
result.local_branch = None
1523
for hook in Branch.hooks['post_pull']:
2623
1529
def _get_parent_location(self):
2624
1530
_locs = ['parent', 'pull', 'x-pull']
2625
1531
for l in _locs:
2627
return self._transport.get_bytes(l).strip('\n')
2628
except errors.NoSuchFile:
1533
return self.control_files.get(l).read().strip('\n')
1539
def push(self, target, overwrite=False, stop_revision=None,
1540
_override_hook_source_branch=None):
1543
This is the basic concrete implementation of push()
1545
:param _override_hook_source_branch: If specified, run
1546
the hooks passing this Branch as the source, rather than self.
1547
This is for use of RemoteBranch, where push is delegated to the
1548
underlying vfs-based Branch.
1550
# TODO: Public option to disable running hooks - should be trivial but
1554
result = self._push_with_bound_branches(target, overwrite,
1556
_override_hook_source_branch=_override_hook_source_branch)
1561
def _push_with_bound_branches(self, target, overwrite,
1563
_override_hook_source_branch=None):
1564
"""Push from self into target, and into target's master if any.
1566
This is on the base BzrBranch class even though it doesn't support
1567
bound branches because the *target* might be bound.
1570
if _override_hook_source_branch:
1571
result.source_branch = _override_hook_source_branch
1572
for hook in Branch.hooks['post_push']:
1575
bound_location = target.get_bound_location()
1576
if bound_location and target.base != bound_location:
1577
# there is a master branch.
1579
# XXX: Why the second check? Is it even supported for a branch to
1580
# be bound to itself? -- mbp 20070507
1581
master_branch = target.get_master_branch()
1582
master_branch.lock_write()
1584
# push into the master from this branch.
1585
self._basic_push(master_branch, overwrite, stop_revision)
1586
# and push into the target branch from this. Note that we push from
1587
# this branch again, because its considered the highest bandwidth
1589
result = self._basic_push(target, overwrite, stop_revision)
1590
result.master_branch = master_branch
1591
result.local_branch = target
1595
master_branch.unlock()
1598
result = self._basic_push(target, overwrite, stop_revision)
1599
# TODO: Why set master_branch and local_branch if there's no
1600
# binding? Maybe cleaner to just leave them unset? -- mbp
1602
result.master_branch = target
1603
result.local_branch = None
2632
1607
def _basic_push(self, target, overwrite, stop_revision):
2633
1608
"""Basic implementation of push without bound branches or hooks.
2635
Must be called with source read locked and target write locked.
1610
Must be called with self read locked and target write locked.
2637
result = BranchPushResult()
1612
result = PushResult()
2638
1613
result.source_branch = self
2639
1614
result.target_branch = target
2640
1615
result.old_revno, result.old_revid = target.last_revision_info()
2641
self.update_references(target)
2642
if result.old_revid != self.last_revision():
2643
# We assume that during 'push' this repository is closer than
2645
graph = self.repository.get_graph(target.repository)
2646
target.update_revisions(self, stop_revision,
2647
overwrite=overwrite, graph=graph)
2648
if self._push_should_merge_tags():
2649
result.tag_conflicts = self.tags.merge_to(target.tags,
1617
target.update_revisions(self, stop_revision)
1618
except DivergedBranches:
1622
target.set_revision_history(self.revision_history())
1623
result.tag_conflicts = self.tags.merge_to(target.tags)
2651
1624
result.new_revno, result.new_revid = target.last_revision_info()
2654
def get_stacked_on_url(self):
2655
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1627
def get_parent(self):
1628
"""See Branch.get_parent."""
1630
assert self.base[-1] == '/'
1631
parent = self._get_parent_location()
1634
# This is an old-format absolute path to a local branch
1635
# turn it into a url
1636
if parent.startswith('/'):
1637
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1639
return urlutils.join(self.base[:-1], parent)
1640
except errors.InvalidURLJoin, e:
1641
raise errors.InaccessibleParent(parent, self.base)
2657
1643
def set_push_location(self, location):
2658
1644
"""See Branch.set_push_location."""
2660
1646
'push_location', location,
2661
1647
store=_mod_config.STORE_LOCATION_NORECURSE)
1650
def set_parent(self, url):
1651
"""See Branch.set_parent."""
1652
# TODO: Maybe delete old location files?
1653
# URLs should never be unicode, even on the local fs,
1654
# FIXUP this and get_parent in a future branch format bump:
1655
# read and rewrite the file, and have the new format code read
1656
# using .get not .get_utf8. RBC 20060125
1658
if isinstance(url, unicode):
1660
url = url.encode('ascii')
1661
except UnicodeEncodeError:
1662
raise errors.InvalidURL(url,
1663
"Urls must be 7-bit ascii, "
1664
"use bzrlib.urlutils.escape")
1665
url = urlutils.relative_url(self.base, url)
1666
self._set_parent_location(url)
2663
1668
def _set_parent_location(self, url):
2664
1669
if url is None:
2665
self._transport.delete('parent')
1670
self.control_files._transport.delete('parent')
2667
self._transport.put_bytes('parent', url + '\n',
2668
mode=self.bzrdir._get_file_mode())
1672
assert isinstance(url, str)
1673
self.control_files.put_bytes('parent', url + '\n')
1675
@deprecated_function(zero_nine)
1676
def tree_config(self):
1677
"""DEPRECATED; call get_config instead.
1678
TreeConfig has become part of BranchConfig."""
1679
return TreeConfig(self)
2671
1682
class BzrBranch5(BzrBranch):
2672
"""A format 5 branch. This supports new features over plain branches.
1683
"""A format 5 branch. This supports new features over plan branches.
2674
1685
It has support for a master_branch which is the data for bound branches.
1693
super(BzrBranch5, self).__init__(_format=_format,
1694
_control_files=_control_files,
1696
_repository=_repository)
1699
def pull(self, source, overwrite=False, stop_revision=None,
1701
"""Pull from source into self, updating my master if any.
1703
:param run_hooks: Private parameter - if false, this branch
1704
is being called because it's the master of the primary branch,
1705
so it should not run its hooks.
1707
bound_location = self.get_bound_location()
1708
master_branch = None
1709
if bound_location and source.base != bound_location:
1710
# not pulling from master, so we need to update master.
1711
master_branch = self.get_master_branch()
1712
master_branch.lock_write()
1715
# pull from source into master.
1716
master_branch.pull(source, overwrite, stop_revision,
1718
return super(BzrBranch5, self).pull(source, overwrite,
1719
stop_revision, _hook_master=master_branch,
1720
run_hooks=run_hooks)
1723
master_branch.unlock()
2677
1725
def get_bound_location(self):
2679
return self._transport.get_bytes('bound')[:-1]
1727
return self.control_files.get_utf8('bound').read()[:-1]
2680
1728
except errors.NoSuchFile:
2683
1731
@needs_read_lock
2684
def get_master_branch(self, possible_transports=None):
1732
def get_master_branch(self):
2685
1733
"""Return the branch we are bound to.
2687
1735
:return: Either a Branch, or None
2689
1737
This could memoise the branch, but if thats done
2769
class BzrBranch8(BzrBranch5):
2770
"""A branch that stores tree-reference locations."""
2772
def _open_hook(self):
2773
if self._ignore_fallbacks:
1831
class BzrBranchExperimental(BzrBranch5):
1832
"""Bzr experimental branch format
1835
- a revision-history file.
1837
- a lock dir guarding the branch itself
1838
- all of this stored in a branch/ subdirectory
1839
- works with shared repositories.
1840
- a tag dictionary in the branch
1842
This format is new in bzr 0.15, but shouldn't be used for real data,
1845
This class acts as it's own BranchFormat.
1848
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1851
def get_format_string(cls):
1852
"""See BranchFormat.get_format_string()."""
1853
return "Bazaar-NG branch format experimental\n"
1856
def get_format_description(cls):
1857
"""See BranchFormat.get_format_description()."""
1858
return "Experimental branch format"
1861
def get_reference(cls, a_bzrdir):
1862
"""Get the target reference of the branch in a_bzrdir.
1864
format probing must have been completed before calling
1865
this method - it is assumed that the format of the branch
1866
in a_bzrdir is correct.
1868
:param a_bzrdir: The bzrdir to get the branch data from.
1869
:return: None if the branch is not a reference branch.
1874
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1876
branch_transport = a_bzrdir.get_branch_transport(cls)
1877
control_files = lockable_files.LockableFiles(branch_transport,
1878
lock_filename, lock_class)
1879
control_files.create_lock()
1880
control_files.lock_write()
2776
url = self.get_stacked_on_url()
2777
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2778
errors.UnstackableBranchFormat):
2781
for hook in Branch.hooks['transform_fallback_location']:
2782
url = hook(self, url)
2784
hook_name = Branch.hooks.get_hook_name(hook)
2785
raise AssertionError(
2786
"'transform_fallback_location' hook %s returned "
2787
"None, not a URL." % hook_name)
2788
self._activate_fallback_location(url)
2790
def __init__(self, *args, **kwargs):
2791
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2792
super(BzrBranch8, self).__init__(*args, **kwargs)
2793
self._last_revision_info_cache = None
2794
self._reference_info = None
2796
def _clear_cached_state(self):
2797
super(BzrBranch8, self)._clear_cached_state()
2798
self._last_revision_info_cache = None
2799
self._reference_info = None
2801
def _last_revision_info(self):
2802
revision_string = self._transport.get_bytes('last-revision')
1882
for filename, content in utf8_files:
1883
control_files.put_utf8(filename, content)
1885
control_files.unlock()
1888
def initialize(cls, a_bzrdir):
1889
"""Create a branch of this format in a_bzrdir."""
1890
utf8_files = [('format', cls.get_format_string()),
1891
('revision-history', ''),
1892
('branch-name', ''),
1895
cls._initialize_control_files(a_bzrdir, utf8_files,
1896
'lock', lockdir.LockDir)
1897
return cls.open(a_bzrdir, _found=True)
1900
def open(cls, a_bzrdir, _found=False):
1901
"""Return the branch object for a_bzrdir
1903
_found is a private parameter, do not use it. It is used to indicate
1904
if format probing has already be done.
1907
format = BranchFormat.find_format(a_bzrdir)
1908
assert format.__class__ == cls
1909
transport = a_bzrdir.get_branch_transport(None)
1910
control_files = lockable_files.LockableFiles(transport, 'lock',
1912
return cls(_format=cls,
1913
_control_files=control_files,
1915
_repository=a_bzrdir.find_repository())
1918
def is_supported(cls):
1921
def _make_tags(self):
1922
return BasicTags(self)
1925
def supports_tags(cls):
1929
BranchFormat.register_format(BzrBranchExperimental)
1932
class BzrBranch6(BzrBranch5):
1935
def last_revision_info(self):
1936
revision_string = self.control_files.get('last-revision').read()
2803
1937
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2804
1938
revision_id = cache_utf8.get_cached_utf8(revision_id)
2805
1939
revno = int(revno)
2806
1940
return revno, revision_id
1942
def last_revision(self):
1943
"""Return last revision id, or None"""
1944
revision_id = self.last_revision_info()[1]
1945
if revision_id == _mod_revision.NULL_REVISION:
2808
1949
def _write_last_revision_info(self, revno, revision_id):
2809
1950
"""Simply write out the revision id, with no checks.
2814
1955
Intended to be called by set_last_revision_info and
2815
1956
_write_revision_history.
2817
revision_id = _mod_revision.ensure_null(revision_id)
1958
if revision_id is None:
1959
revision_id = 'null:'
2818
1960
out_string = '%d %s\n' % (revno, revision_id)
2819
self._transport.put_bytes('last-revision', out_string,
2820
mode=self.bzrdir._get_file_mode())
1961
self.control_files.put_bytes('last-revision', out_string)
2822
1963
@needs_write_lock
2823
1964
def set_last_revision_info(self, revno, revision_id):
2824
revision_id = _mod_revision.ensure_null(revision_id)
2825
old_revno, old_revid = self.last_revision_info()
1965
revision_id = osutils.safe_revision_id(revision_id)
2826
1966
if self._get_append_revisions_only():
2827
1967
self._check_history_violation(revision_id)
2828
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2829
1968
self._write_last_revision_info(revno, revision_id)
2830
1969
self._clear_cached_state()
2831
self._last_revision_info_cache = revno, revision_id
2832
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2834
def _synchronize_history(self, destination, revision_id):
2835
"""Synchronize last revision and revision history between branches.
2837
:see: Branch._synchronize_history
2839
# XXX: The base Branch has a fast implementation of this method based
2840
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2841
# that uses set_revision_history. This class inherits from BzrBranch5,
2842
# but wants the fast implementation, so it calls
2843
# Branch._synchronize_history directly.
2844
Branch._synchronize_history(self, destination, revision_id)
2846
1971
def _check_history_violation(self, revision_id):
2847
1972
last_revision = _mod_revision.ensure_null(self.last_revision())
2848
1973
if _mod_revision.is_null(last_revision):
2850
1975
if last_revision not in self._lefthand_history(revision_id):
2851
raise errors.AppendRevisionsOnlyViolation(self.user_url)
1976
raise errors.AppendRevisionsOnlyViolation(self.base)
2853
1978
def _gen_revision_history(self):
2854
1979
"""Generate the revision history from last revision
2856
last_revno, last_revision = self.last_revision_info()
2857
self._extend_partial_history(stop_index=last_revno-1)
2858
return list(reversed(self._partial_revision_history_cache))
1981
history = list(self.repository.iter_reverse_revision_history(
1982
self.last_revision()))
2860
1986
def _write_revision_history(self, history):
2861
1987
"""Factored out of set_revision_history.
2883
2028
"""Set the parent branch"""
2884
2029
return self._get_config_location('parent_location')
2887
def _set_all_reference_info(self, info_dict):
2888
"""Replace all reference info stored in a branch.
2890
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2893
writer = rio.RioWriter(s)
2894
for key, (tree_path, branch_location) in info_dict.iteritems():
2895
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2896
branch_location=branch_location)
2897
writer.write_stanza(stanza)
2898
self._transport.put_bytes('references', s.getvalue())
2899
self._reference_info = info_dict
2902
def _get_all_reference_info(self):
2903
"""Return all the reference info stored in a branch.
2905
:return: A dict of {file_id: (tree_path, branch_location)}
2907
if self._reference_info is not None:
2908
return self._reference_info
2909
rio_file = self._transport.get('references')
2911
stanzas = rio.read_stanzas(rio_file)
2912
info_dict = dict((s['file_id'], (s['tree_path'],
2913
s['branch_location'])) for s in stanzas)
2916
self._reference_info = info_dict
2919
def set_reference_info(self, file_id, tree_path, branch_location):
2920
"""Set the branch location to use for a tree reference.
2922
:param file_id: The file-id of the tree reference.
2923
:param tree_path: The path of the tree reference in the tree.
2924
:param branch_location: The location of the branch to retrieve tree
2927
info_dict = self._get_all_reference_info()
2928
info_dict[file_id] = (tree_path, branch_location)
2929
if None in (tree_path, branch_location):
2930
if tree_path is not None:
2931
raise ValueError('tree_path must be None when branch_location'
2933
if branch_location is not None:
2934
raise ValueError('branch_location must be None when tree_path'
2936
del info_dict[file_id]
2937
self._set_all_reference_info(info_dict)
2939
def get_reference_info(self, file_id):
2940
"""Get the tree_path and branch_location for a tree reference.
2942
:return: a tuple of (tree_path, branch_location)
2944
return self._get_all_reference_info().get(file_id, (None, None))
2946
def reference_parent(self, file_id, path, possible_transports=None):
2947
"""Return the parent branch for a tree-reference file_id.
2949
:param file_id: The file_id of the tree reference
2950
:param path: The path of the file_id in the tree
2951
:return: A branch associated with the file_id
2953
branch_location = self.get_reference_info(file_id)[1]
2954
if branch_location is None:
2955
return Branch.reference_parent(self, file_id, path,
2956
possible_transports)
2957
branch_location = urlutils.join(self.user_url, branch_location)
2958
return Branch.open(branch_location,
2959
possible_transports=possible_transports)
2961
2031
def set_push_location(self, location):
2962
2032
"""See Branch.set_push_location."""
2963
2033
self._set_config_location('push_location', location)
2996
2066
"""See Branch.get_old_bound_location"""
2997
2067
return self._get_bound_location(False)
2999
def get_stacked_on_url(self):
3000
# you can always ask for the URL; but you might not be able to use it
3001
# if the repo can't support stacking.
3002
## self._check_stackable_repo()
3003
stacked_url = self._get_config_location('stacked_on_location')
3004
if stacked_url is None:
3005
raise errors.NotStacked(self)
2069
def set_append_revisions_only(self, enabled):
2074
self.get_config().set_user_option('append_revisions_only', value,
3008
2077
def _get_append_revisions_only(self):
3009
return self.get_config(
3010
).get_user_option_as_bool('append_revisions_only')
3013
def generate_revision_history(self, revision_id, last_rev=None,
3015
"""See BzrBranch5.generate_revision_history"""
3016
history = self._lefthand_history(revision_id, last_rev, other_branch)
3017
revno = len(history)
3018
self.set_last_revision_info(revno, revision_id)
3021
def get_rev_id(self, revno, history=None):
3022
"""Find the revision id of the specified revno."""
3024
return _mod_revision.NULL_REVISION
3026
last_revno, last_revision_id = self.last_revision_info()
3027
if revno <= 0 or revno > last_revno:
3028
raise errors.NoSuchRevision(self, revno)
3030
if history is not None:
3031
return history[revno - 1]
3033
index = last_revno - revno
3034
if len(self._partial_revision_history_cache) <= index:
3035
self._extend_partial_history(stop_index=index)
3036
if len(self._partial_revision_history_cache) > index:
3037
return self._partial_revision_history_cache[index]
2078
value = self.get_config().get_user_option('append_revisions_only')
2079
return value == 'True'
2081
def _synchronize_history(self, destination, revision_id):
2082
"""Synchronize last revision and revision history between branches.
2084
This version is most efficient when the destination is also a
2085
BzrBranch6, but works for BzrBranch5, as long as the destination's
2086
repository contains all the lefthand ancestors of the intended
2087
last_revision. If not, set_last_revision_info will fail.
2089
:param destination: The branch to copy the history into
2090
:param revision_id: The revision-id to truncate history at. May
2091
be None to copy complete history.
2093
if revision_id is None:
2094
revno, revision_id = self.last_revision_info()
3039
raise errors.NoSuchRevision(self, revno)
3042
def revision_id_to_revno(self, revision_id):
3043
"""Given a revision id, return its revno"""
3044
if _mod_revision.is_null(revision_id):
3047
index = self._partial_revision_history_cache.index(revision_id)
3049
self._extend_partial_history(stop_revision=revision_id)
3050
index = len(self._partial_revision_history_cache) - 1
3051
if self._partial_revision_history_cache[index] != revision_id:
3052
raise errors.NoSuchRevision(self, revision_id)
3053
return self.revno() - index
3056
class BzrBranch7(BzrBranch8):
3057
"""A branch with support for a fallback repository."""
3059
def set_reference_info(self, file_id, tree_path, branch_location):
3060
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3062
def get_reference_info(self, file_id):
3063
Branch.get_reference_info(self, file_id)
3065
def reference_parent(self, file_id, path, possible_transports=None):
3066
return Branch.reference_parent(self, file_id, path,
3067
possible_transports)
3070
class BzrBranch6(BzrBranch7):
3071
"""See BzrBranchFormat6 for the capabilities of this branch.
3073
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3077
def get_stacked_on_url(self):
3078
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2096
# To figure out the revno for a random revision, we need to build
2097
# the revision history, and count its length.
2098
# We don't care about the order, just how long it is.
2099
# Alternatively, we could start at the current location, and count
2100
# backwards. But there is no guarantee that we will find it since
2101
# it may be a merged revision.
2102
revno = len(list(self.repository.iter_reverse_revision_history(
2104
destination.set_last_revision_info(revno, revision_id)
2106
def _make_tags(self):
2107
return BasicTags(self)
3081
2110
######################################################################
3192
2208
new_branch.tags._set_tag_dict({})
3194
2210
# Copying done; now update target format
3195
new_branch._transport.put_bytes('format',
3196
format.get_format_string(),
3197
mode=new_branch.bzrdir._get_file_mode())
2211
new_branch.control_files.put_utf8('format',
2212
format.get_format_string())
3199
2214
# Clean up old files
3200
new_branch._transport.delete('revision-history')
2215
new_branch.control_files._transport.delete('revision-history')
3202
2217
branch.set_parent(None)
3203
except errors.NoSuchFile:
3205
2220
branch.set_bound_location(None)
3208
class Converter6to7(object):
3209
"""Perform an in-place upgrade of format 6 to format 7"""
3211
def convert(self, branch):
3212
format = BzrBranchFormat7()
3213
branch._set_config_location('stacked_on_location', '')
3214
# update target format
3215
branch._transport.put_bytes('format', format.get_format_string())
3218
class Converter7to8(object):
3219
"""Perform an in-place upgrade of format 6 to format 7"""
3221
def convert(self, branch):
3222
format = BzrBranchFormat8()
3223
branch._transport.put_bytes('references', '')
3224
# update target format
3225
branch._transport.put_bytes('format', format.get_format_string())
3228
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3229
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3232
_run_with_write_locked_target will attempt to release the lock it acquires.
3234
If an exception is raised by callable, then that exception *will* be
3235
propagated, even if the unlock attempt raises its own error. Thus
3236
_run_with_write_locked_target should be preferred to simply doing::
3240
return callable(*args, **kwargs)
3245
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3246
# should share code?
3249
result = callable(*args, **kwargs)
3251
exc_info = sys.exc_info()
3255
raise exc_info[0], exc_info[1], exc_info[2]
3261
class InterBranch(InterObject):
3262
"""This class represents operations taking place between two branches.
3264
Its instances have methods like pull() and push() and contain
3265
references to the source and target repositories these operations
3266
can be carried out on.
3270
"""The available optimised InterBranch types."""
3273
def _get_branch_formats_to_test(klass):
3274
"""Return an iterable of format tuples for testing.
3276
:return: An iterable of (from_format, to_format) to use when testing
3277
this InterBranch class. Each InterBranch class should define this
3280
raise NotImplementedError(klass._get_branch_formats_to_test)
3283
def pull(self, overwrite=False, stop_revision=None,
3284
possible_transports=None, local=False):
3285
"""Mirror source into target branch.
3287
The target branch is considered to be 'local', having low latency.
3289
:returns: PullResult instance
3291
raise NotImplementedError(self.pull)
3294
def update_revisions(self, stop_revision=None, overwrite=False,
3296
"""Pull in new perfect-fit revisions.
3298
:param stop_revision: Updated until the given revision
3299
:param overwrite: Always set the branch pointer, rather than checking
3300
to see if it is a proper descendant.
3301
:param graph: A Graph object that can be used to query history
3302
information. This can be None.
3305
raise NotImplementedError(self.update_revisions)
3308
def push(self, overwrite=False, stop_revision=None,
3309
_override_hook_source_branch=None):
3310
"""Mirror the source branch into the target branch.
3312
The source branch is considered to be 'local', having low latency.
3314
raise NotImplementedError(self.push)
3317
class GenericInterBranch(InterBranch):
3318
"""InterBranch implementation that uses public Branch functions."""
3321
def is_compatible(klass, source, target):
3322
# GenericBranch uses the public API, so always compatible
3326
def _get_branch_formats_to_test(klass):
3327
return [(BranchFormat._default_format, BranchFormat._default_format)]
3330
def unwrap_format(klass, format):
3331
if isinstance(format, remote.RemoteBranchFormat):
3332
format._ensure_real()
3333
return format._custom_format
3337
def copy_content_into(self, revision_id=None):
3338
"""Copy the content of source into target
3340
revision_id: if not None, the revision history in the new branch will
3341
be truncated to end with revision_id.
3343
self.source.update_references(self.target)
3344
self.source._synchronize_history(self.target, revision_id)
3346
parent = self.source.get_parent()
3347
except errors.InaccessibleParent, e:
3348
mutter('parent was not accessible to copy: %s', e)
3351
self.target.set_parent(parent)
3352
if self.source._push_should_merge_tags():
3353
self.source.tags.merge_to(self.target.tags)
3356
def update_revisions(self, stop_revision=None, overwrite=False,
3358
"""See InterBranch.update_revisions()."""
3359
other_revno, other_last_revision = self.source.last_revision_info()
3360
stop_revno = None # unknown
3361
if stop_revision is None:
3362
stop_revision = other_last_revision
3363
if _mod_revision.is_null(stop_revision):
3364
# if there are no commits, we're done.
3366
stop_revno = other_revno
3368
# what's the current last revision, before we fetch [and change it
3370
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3371
# we fetch here so that we don't process data twice in the common
3372
# case of having something to pull, and so that the check for
3373
# already merged can operate on the just fetched graph, which will
3374
# be cached in memory.
3375
self.target.fetch(self.source, stop_revision)
3376
# Check to see if one is an ancestor of the other
3379
graph = self.target.repository.get_graph()
3380
if self.target._check_if_descendant_or_diverged(
3381
stop_revision, last_rev, graph, self.source):
3382
# stop_revision is a descendant of last_rev, but we aren't
3383
# overwriting, so we're done.
3385
if stop_revno is None:
3387
graph = self.target.repository.get_graph()
3388
this_revno, this_last_revision = \
3389
self.target.last_revision_info()
3390
stop_revno = graph.find_distance_to_null(stop_revision,
3391
[(other_last_revision, other_revno),
3392
(this_last_revision, this_revno)])
3393
self.target.set_last_revision_info(stop_revno, stop_revision)
3396
def pull(self, overwrite=False, stop_revision=None,
3397
possible_transports=None, run_hooks=True,
3398
_override_hook_target=None, local=False):
3399
"""Pull from source into self, updating my master if any.
3401
:param run_hooks: Private parameter - if false, this branch
3402
is being called because it's the master of the primary branch,
3403
so it should not run its hooks.
3405
bound_location = self.target.get_bound_location()
3406
if local and not bound_location:
3407
raise errors.LocalRequiresBoundBranch()
3408
master_branch = None
3409
if not local and bound_location and self.source.user_url != bound_location:
3410
# not pulling from master, so we need to update master.
3411
master_branch = self.target.get_master_branch(possible_transports)
3412
master_branch.lock_write()
3415
# pull from source into master.
3416
master_branch.pull(self.source, overwrite, stop_revision,
3418
return self._pull(overwrite,
3419
stop_revision, _hook_master=master_branch,
3420
run_hooks=run_hooks,
3421
_override_hook_target=_override_hook_target)
3424
master_branch.unlock()
3426
def push(self, overwrite=False, stop_revision=None,
3427
_override_hook_source_branch=None):
3428
"""See InterBranch.push.
3430
This is the basic concrete implementation of push()
3432
:param _override_hook_source_branch: If specified, run
3433
the hooks passing this Branch as the source, rather than self.
3434
This is for use of RemoteBranch, where push is delegated to the
3435
underlying vfs-based Branch.
3437
# TODO: Public option to disable running hooks - should be trivial but
3439
self.source.lock_read()
3441
return _run_with_write_locked_target(
3442
self.target, self._push_with_bound_branches, overwrite,
3444
_override_hook_source_branch=_override_hook_source_branch)
3446
self.source.unlock()
3448
def _push_with_bound_branches(self, overwrite, stop_revision,
3449
_override_hook_source_branch=None):
3450
"""Push from source into target, and into target's master if any.
3453
if _override_hook_source_branch:
3454
result.source_branch = _override_hook_source_branch
3455
for hook in Branch.hooks['post_push']:
3458
bound_location = self.target.get_bound_location()
3459
if bound_location and self.target.base != bound_location:
3460
# there is a master branch.
3462
# XXX: Why the second check? Is it even supported for a branch to
3463
# be bound to itself? -- mbp 20070507
3464
master_branch = self.target.get_master_branch()
3465
master_branch.lock_write()
3467
# push into the master from the source branch.
3468
self.source._basic_push(master_branch, overwrite, stop_revision)
3469
# and push into the target branch from the source. Note that we
3470
# push from the source branch again, because its considered the
3471
# highest bandwidth repository.
3472
result = self.source._basic_push(self.target, overwrite,
3474
result.master_branch = master_branch
3475
result.local_branch = self.target
3479
master_branch.unlock()
3482
result = self.source._basic_push(self.target, overwrite,
3484
# TODO: Why set master_branch and local_branch if there's no
3485
# binding? Maybe cleaner to just leave them unset? -- mbp
3487
result.master_branch = self.target
3488
result.local_branch = None
3492
def _pull(self, overwrite=False, stop_revision=None,
3493
possible_transports=None, _hook_master=None, run_hooks=True,
3494
_override_hook_target=None, local=False):
3497
This function is the core worker, used by GenericInterBranch.pull to
3498
avoid duplication when pulling source->master and source->local.
3500
:param _hook_master: Private parameter - set the branch to
3501
be supplied as the master to pull hooks.
3502
:param run_hooks: Private parameter - if false, this branch
3503
is being called because it's the master of the primary branch,
3504
so it should not run its hooks.
3505
:param _override_hook_target: Private parameter - set the branch to be
3506
supplied as the target_branch to pull hooks.
3507
:param local: Only update the local branch, and not the bound branch.
3509
# This type of branch can't be bound.
3511
raise errors.LocalRequiresBoundBranch()
3512
result = PullResult()
3513
result.source_branch = self.source
3514
if _override_hook_target is None:
3515
result.target_branch = self.target
3517
result.target_branch = _override_hook_target
3518
self.source.lock_read()
3520
# We assume that during 'pull' the target repository is closer than
3522
self.source.update_references(self.target)
3523
graph = self.target.repository.get_graph(self.source.repository)
3524
# TODO: Branch formats should have a flag that indicates
3525
# that revno's are expensive, and pull() should honor that flag.
3527
result.old_revno, result.old_revid = \
3528
self.target.last_revision_info()
3529
self.target.update_revisions(self.source, stop_revision,
3530
overwrite=overwrite, graph=graph)
3531
# TODO: The old revid should be specified when merging tags,
3532
# so a tags implementation that versions tags can only
3533
# pull in the most recent changes. -- JRV20090506
3534
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3536
result.new_revno, result.new_revid = self.target.last_revision_info()
3538
result.master_branch = _hook_master
3539
result.local_branch = result.target_branch
3541
result.master_branch = result.target_branch
3542
result.local_branch = None
3544
for hook in Branch.hooks['post_pull']:
3547
self.source.unlock()
3551
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
