1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
from cStringIO import StringIO
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from itertools import chain
27
config as _mod_config,
33
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TransportConfig
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.hooks import HookPoint, Hooks
51
from bzrlib.inter import InterObject
52
from bzrlib import registry
53
from bzrlib.symbol_versioning import (
57
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
60
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
61
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
65
# TODO: Maybe include checks for common corruption of newlines, etc?
67
# TODO: Some operations like log might retrieve the same revisions
68
# repeatedly to calculate deltas. We could perhaps have a weakref
69
# cache in memory to make this faster. In general anything can be
70
# cached in memory between lock and unlock operations. .. nb thats
71
# what the transaction identity map provides
74
######################################################################
78
"""Branch holding a history of revisions.
81
Base directory/url of the branch.
83
hooks: An instance of BranchHooks.
85
# this is really an instance variable - FIXME move it there
89
def __init__(self, *ignored, **ignored_too):
90
self.tags = self._format.make_tags(self)
91
self._revision_history_cache = None
92
self._revision_id_to_revno_cache = None
93
self._partial_revision_id_to_revno_cache = {}
94
self._last_revision_info_cache = None
95
self._merge_sorted_revisions_cache = None
97
hooks = Branch.hooks['open']
101
def _open_hook(self):
102
"""Called by init to allow simpler extension of the base class."""
104
def _activate_fallback_location(self, url, lock_style):
105
"""Activate the branch/repository from url as a fallback repository."""
106
repo = self._get_fallback_repository(url)
107
if lock_style == 'write':
109
elif lock_style == 'read':
111
self.repository.add_fallback_repository(repo)
113
def break_lock(self):
114
"""Break a lock if one is present from another instance.
116
Uses the ui factory to ask for confirmation if the lock may be from
119
This will probe the repository for its lock as well.
121
self.control_files.break_lock()
122
self.repository.break_lock()
123
master = self.get_master_branch()
124
if master is not None:
127
def _check_stackable_repo(self):
128
if not self.repository._format.supports_external_lookups:
129
raise errors.UnstackableRepositoryFormat(self.repository._format,
130
self.repository.base)
133
def open(base, _unsupported=False, possible_transports=None):
134
"""Open the branch rooted at base.
136
For instance, if the branch is at URL/.bzr/branch,
137
Branch.open(URL) -> a Branch instance.
139
control = bzrdir.BzrDir.open(base, _unsupported,
140
possible_transports=possible_transports)
141
return control.open_branch(_unsupported)
144
def open_from_transport(transport, _unsupported=False):
145
"""Open the branch rooted at transport"""
146
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
147
return control.open_branch(_unsupported)
150
def open_containing(url, possible_transports=None):
151
"""Open an existing branch which contains url.
153
This probes for a branch at url, and searches upwards from there.
155
Basically we keep looking up until we find the control directory or
156
run into the root. If there isn't one, raises NotBranchError.
157
If there is one and it is either an unrecognised format or an unsupported
158
format, UnknownFormatError or UnsupportedFormatError are raised.
159
If there is one, it is returned, along with the unused portion of url.
161
control, relpath = bzrdir.BzrDir.open_containing(url,
163
return control.open_branch(), relpath
165
def _push_should_merge_tags(self):
166
"""Should _basic_push merge this branch's tags into the target?
168
The default implementation returns False if this branch has no tags,
169
and True the rest of the time. Subclasses may override this.
171
return self.supports_tags() and self.tags.get_tag_dict()
173
def get_config(self):
174
return BranchConfig(self)
176
def _get_config(self):
177
"""Get the concrete config for just the config in this branch.
179
This is not intended for client use; see Branch.get_config for the
184
:return: An object supporting get_option and set_option.
186
raise NotImplementedError(self._get_config)
188
def _get_fallback_repository(self, url):
189
"""Get the repository we fallback to at url."""
190
url = urlutils.join(self.base, url)
191
a_bzrdir = bzrdir.BzrDir.open(url,
192
possible_transports=[self.bzrdir.root_transport])
193
return a_bzrdir.open_branch().repository
195
def _get_tags_bytes(self):
196
"""Get the bytes of a serialised tags dict.
198
Note that not all branches support tags, nor do all use the same tags
199
logic: this method is specific to BasicTags. Other tag implementations
200
may use the same method name and behave differently, safely, because
201
of the double-dispatch via
202
format.make_tags->tags_instance->get_tags_dict.
204
:return: The bytes of the tags file.
205
:seealso: Branch._set_tags_bytes.
207
return self._transport.get_bytes('tags')
209
def _get_nick(self, local=False, possible_transports=None):
210
config = self.get_config()
211
# explicit overrides master, but don't look for master if local is True
212
if not local and not config.has_explicit_nickname():
214
master = self.get_master_branch(possible_transports)
215
if master is not None:
216
# return the master branch value
218
except errors.BzrError, e:
219
# Silently fall back to local implicit nick if the master is
221
mutter("Could not connect to bound branch, "
222
"falling back to local nick.\n " + str(e))
223
return config.get_nickname()
225
def _set_nick(self, nick):
226
self.get_config().set_user_option('nickname', nick, warn_masked=True)
228
nick = property(_get_nick, _set_nick)
231
raise NotImplementedError(self.is_locked)
233
def _lefthand_history(self, revision_id, last_rev=None,
235
if 'evil' in debug.debug_flags:
236
mutter_callsite(4, "_lefthand_history scales with history.")
237
# stop_revision must be a descendant of last_revision
238
graph = self.repository.get_graph()
239
if last_rev is not None:
240
if not graph.is_ancestor(last_rev, revision_id):
241
# our previous tip is not merged into stop_revision
242
raise errors.DivergedBranches(self, other_branch)
243
# make a new revision history from the graph
244
parents_map = graph.get_parent_map([revision_id])
245
if revision_id not in parents_map:
246
raise errors.NoSuchRevision(self, revision_id)
247
current_rev_id = revision_id
249
check_not_reserved_id = _mod_revision.check_not_reserved_id
250
# Do not include ghosts or graph origin in revision_history
251
while (current_rev_id in parents_map and
252
len(parents_map[current_rev_id]) > 0):
253
check_not_reserved_id(current_rev_id)
254
new_history.append(current_rev_id)
255
current_rev_id = parents_map[current_rev_id][0]
256
parents_map = graph.get_parent_map([current_rev_id])
257
new_history.reverse()
260
def lock_write(self):
261
raise NotImplementedError(self.lock_write)
264
raise NotImplementedError(self.lock_read)
267
raise NotImplementedError(self.unlock)
269
def peek_lock_mode(self):
270
"""Return lock mode for the Branch: 'r', 'w' or None"""
271
raise NotImplementedError(self.peek_lock_mode)
273
def get_physical_lock_status(self):
274
raise NotImplementedError(self.get_physical_lock_status)
277
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
278
"""Return the revision_id for a dotted revno.
280
:param revno: a tuple like (1,) or (1,1,2)
281
:param _cache_reverse: a private parameter enabling storage
282
of the reverse mapping in a top level cache. (This should
283
only be done in selective circumstances as we want to
284
avoid having the mapping cached multiple times.)
285
:return: the revision_id
286
:raises errors.NoSuchRevision: if the revno doesn't exist
288
rev_id = self._do_dotted_revno_to_revision_id(revno)
290
self._partial_revision_id_to_revno_cache[rev_id] = revno
293
def _do_dotted_revno_to_revision_id(self, revno):
294
"""Worker function for dotted_revno_to_revision_id.
296
Subclasses should override this if they wish to
297
provide a more efficient implementation.
300
return self.get_rev_id(revno[0])
301
revision_id_to_revno = self.get_revision_id_to_revno_map()
302
revision_ids = [revision_id for revision_id, this_revno
303
in revision_id_to_revno.iteritems()
304
if revno == this_revno]
305
if len(revision_ids) == 1:
306
return revision_ids[0]
308
revno_str = '.'.join(map(str, revno))
309
raise errors.NoSuchRevision(self, revno_str)
312
def revision_id_to_dotted_revno(self, revision_id):
313
"""Given a revision id, return its dotted revno.
315
:return: a tuple like (1,) or (400,1,3).
317
return self._do_revision_id_to_dotted_revno(revision_id)
319
def _do_revision_id_to_dotted_revno(self, revision_id):
320
"""Worker function for revision_id_to_revno."""
321
# Try the caches if they are loaded
322
result = self._partial_revision_id_to_revno_cache.get(revision_id)
323
if result is not None:
325
if self._revision_id_to_revno_cache:
326
result = self._revision_id_to_revno_cache.get(revision_id)
328
raise errors.NoSuchRevision(self, revision_id)
329
# Try the mainline as it's optimised
331
revno = self.revision_id_to_revno(revision_id)
333
except errors.NoSuchRevision:
334
# We need to load and use the full revno map after all
335
result = self.get_revision_id_to_revno_map().get(revision_id)
337
raise errors.NoSuchRevision(self, revision_id)
341
def get_revision_id_to_revno_map(self):
342
"""Return the revision_id => dotted revno map.
344
This will be regenerated on demand, but will be cached.
346
:return: A dictionary mapping revision_id => dotted revno.
347
This dictionary should not be modified by the caller.
349
if self._revision_id_to_revno_cache is not None:
350
mapping = self._revision_id_to_revno_cache
352
mapping = self._gen_revno_map()
353
self._cache_revision_id_to_revno(mapping)
354
# TODO: jam 20070417 Since this is being cached, should we be returning
356
# I would rather not, and instead just declare that users should not
357
# modify the return value.
360
def _gen_revno_map(self):
361
"""Create a new mapping from revision ids to dotted revnos.
363
Dotted revnos are generated based on the current tip in the revision
365
This is the worker function for get_revision_id_to_revno_map, which
366
just caches the return value.
368
:return: A dictionary mapping revision_id => dotted revno.
370
revision_id_to_revno = dict((rev_id, revno)
371
for rev_id, depth, revno, end_of_merge
372
in self.iter_merge_sorted_revisions())
373
return revision_id_to_revno
376
def iter_merge_sorted_revisions(self, start_revision_id=None,
377
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
378
"""Walk the revisions for a branch in merge sorted order.
380
Merge sorted order is the output from a merge-aware,
381
topological sort, i.e. all parents come before their
382
children going forward; the opposite for reverse.
384
:param start_revision_id: the revision_id to begin walking from.
385
If None, the branch tip is used.
386
:param stop_revision_id: the revision_id to terminate the walk
387
after. If None, the rest of history is included.
388
:param stop_rule: if stop_revision_id is not None, the precise rule
389
to use for termination:
390
* 'exclude' - leave the stop revision out of the result (default)
391
* 'include' - the stop revision is the last item in the result
392
* 'with-merges' - include the stop revision and all of its
393
merged revisions in the result
394
:param direction: either 'reverse' or 'forward':
395
* reverse means return the start_revision_id first, i.e.
396
start at the most recent revision and go backwards in history
397
* forward returns tuples in the opposite order to reverse.
398
Note in particular that forward does *not* do any intelligent
399
ordering w.r.t. depth as some clients of this API may like.
400
(If required, that ought to be done at higher layers.)
402
:return: an iterator over (revision_id, depth, revno, end_of_merge)
405
* revision_id: the unique id of the revision
406
* depth: How many levels of merging deep this node has been
408
* revno_sequence: This field provides a sequence of
409
revision numbers for all revisions. The format is:
410
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
411
branch that the revno is on. From left to right the REVNO numbers
412
are the sequence numbers within that branch of the revision.
413
* end_of_merge: When True the next node (earlier in history) is
414
part of a different merge.
416
# Note: depth and revno values are in the context of the branch so
417
# we need the full graph to get stable numbers, regardless of the
419
if self._merge_sorted_revisions_cache is None:
420
last_revision = self.last_revision()
421
graph = self.repository.get_graph()
422
parent_map = dict(((key, value) for key, value in
423
graph.iter_ancestry([last_revision]) if value is not None))
424
revision_graph = repository._strip_NULL_ghosts(parent_map)
425
revs = tsort.merge_sort(revision_graph, last_revision, None,
427
# Drop the sequence # before caching
428
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
430
filtered = self._filter_merge_sorted_revisions(
431
self._merge_sorted_revisions_cache, start_revision_id,
432
stop_revision_id, stop_rule)
433
if direction == 'reverse':
435
if direction == 'forward':
436
return reversed(list(filtered))
438
raise ValueError('invalid direction %r' % direction)
440
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
441
start_revision_id, stop_revision_id, stop_rule):
442
"""Iterate over an inclusive range of sorted revisions."""
443
rev_iter = iter(merge_sorted_revisions)
444
if start_revision_id is not None:
445
for rev_id, depth, revno, end_of_merge in rev_iter:
446
if rev_id != start_revision_id:
449
# The decision to include the start or not
450
# depends on the stop_rule if a stop is provided
452
iter([(rev_id, depth, revno, end_of_merge)]),
455
if stop_revision_id is None:
456
for rev_id, depth, revno, end_of_merge in rev_iter:
457
yield rev_id, depth, revno, end_of_merge
458
elif stop_rule == 'exclude':
459
for rev_id, depth, revno, end_of_merge in rev_iter:
460
if rev_id == stop_revision_id:
462
yield rev_id, depth, revno, end_of_merge
463
elif stop_rule == 'include':
464
for rev_id, depth, revno, end_of_merge in rev_iter:
465
yield rev_id, depth, revno, end_of_merge
466
if rev_id == stop_revision_id:
468
elif stop_rule == 'with-merges':
469
stop_rev = self.repository.get_revision(stop_revision_id)
470
if stop_rev.parent_ids:
471
left_parent = stop_rev.parent_ids[0]
473
left_parent = _mod_revision.NULL_REVISION
474
for rev_id, depth, revno, end_of_merge in rev_iter:
475
if rev_id == left_parent:
477
yield rev_id, depth, revno, end_of_merge
479
raise ValueError('invalid stop_rule %r' % stop_rule)
481
def leave_lock_in_place(self):
482
"""Tell this branch object not to release the physical lock when this
485
If lock_write doesn't return a token, then this method is not supported.
487
self.control_files.leave_in_place()
489
def dont_leave_lock_in_place(self):
490
"""Tell this branch object to release the physical lock when this
491
object is unlocked, even if it didn't originally acquire it.
493
If lock_write doesn't return a token, then this method is not supported.
495
self.control_files.dont_leave_in_place()
497
def bind(self, other):
498
"""Bind the local branch the other branch.
500
:param other: The branch to bind to
503
raise errors.UpgradeRequired(self.base)
505
def set_reference_info(self, file_id, tree_path, branch_location):
506
"""Set the branch location to use for a tree reference."""
507
raise errors.UnsupportedOperation(self.set_reference_info, self)
509
def get_reference_info(self, file_id):
510
"""Get the tree_path and branch_location for a tree reference."""
511
raise errors.UnsupportedOperation(self.get_reference_info, self)
514
def fetch(self, from_branch, last_revision=None, pb=None):
515
"""Copy revisions from from_branch into this branch.
517
:param from_branch: Where to copy from.
518
:param last_revision: What revision to stop at (None for at the end
520
:param pb: An optional progress bar to use.
523
if self.base == from_branch.base:
526
symbol_versioning.warn(
527
symbol_versioning.deprecated_in((1, 14, 0))
528
% "pb parameter to fetch()")
529
from_branch.lock_read()
531
if last_revision is None:
532
last_revision = from_branch.last_revision()
533
last_revision = _mod_revision.ensure_null(last_revision)
534
return self.repository.fetch(from_branch.repository,
535
revision_id=last_revision,
540
def get_bound_location(self):
541
"""Return the URL of the branch we are bound to.
543
Older format branches cannot bind, please be sure to use a metadir
548
def get_old_bound_location(self):
549
"""Return the URL of the branch we used to be bound to
551
raise errors.UpgradeRequired(self.base)
553
def get_commit_builder(self, parents, config=None, timestamp=None,
554
timezone=None, committer=None, revprops=None,
556
"""Obtain a CommitBuilder for this branch.
558
:param parents: Revision ids of the parents of the new revision.
559
:param config: Optional configuration to use.
560
:param timestamp: Optional timestamp recorded for commit.
561
:param timezone: Optional timezone for timestamp.
562
:param committer: Optional committer to set for commit.
563
:param revprops: Optional dictionary of revision properties.
564
:param revision_id: Optional revision id.
568
config = self.get_config()
570
return self.repository.get_commit_builder(self, parents, config,
571
timestamp, timezone, committer, revprops, revision_id)
573
def get_master_branch(self, possible_transports=None):
574
"""Return the branch we are bound to.
576
:return: Either a Branch, or None
580
def get_revision_delta(self, revno):
581
"""Return the delta for one revision.
583
The delta is relative to its mainline predecessor, or the
584
empty tree for revision 1.
586
rh = self.revision_history()
587
if not (1 <= revno <= len(rh)):
588
raise errors.InvalidRevisionNumber(revno)
589
return self.repository.get_revision_delta(rh[revno-1])
591
def get_stacked_on_url(self):
592
"""Get the URL this branch is stacked against.
594
:raises NotStacked: If the branch is not stacked.
595
:raises UnstackableBranchFormat: If the branch does not support
598
raise NotImplementedError(self.get_stacked_on_url)
600
def print_file(self, file, revision_id):
601
"""Print `file` to stdout."""
602
raise NotImplementedError(self.print_file)
604
def set_revision_history(self, rev_history):
605
raise NotImplementedError(self.set_revision_history)
608
def set_parent(self, url):
609
"""See Branch.set_parent."""
610
# TODO: Maybe delete old location files?
611
# URLs should never be unicode, even on the local fs,
612
# FIXUP this and get_parent in a future branch format bump:
613
# read and rewrite the file. RBC 20060125
615
if isinstance(url, unicode):
617
url = url.encode('ascii')
618
except UnicodeEncodeError:
619
raise errors.InvalidURL(url,
620
"Urls must be 7-bit ascii, "
621
"use bzrlib.urlutils.escape")
622
url = urlutils.relative_url(self.base, url)
623
self._set_parent_location(url)
626
def set_stacked_on_url(self, url):
627
"""Set the URL this branch is stacked against.
629
:raises UnstackableBranchFormat: If the branch does not support
631
:raises UnstackableRepositoryFormat: If the repository does not support
634
if not self._format.supports_stacking():
635
raise errors.UnstackableBranchFormat(self._format, self.base)
636
self._check_stackable_repo()
639
old_url = self.get_stacked_on_url()
640
except (errors.NotStacked, errors.UnstackableBranchFormat,
641
errors.UnstackableRepositoryFormat):
644
# XXX: Lock correctness - should unlock our old repo if we were
646
# repositories don't offer an interface to remove fallback
647
# repositories today; take the conceptually simpler option and just
649
self.repository = self.bzrdir.find_repository()
650
self.repository.lock_write()
651
# for every revision reference the branch has, ensure it is pulled
653
source_repository = self._get_fallback_repository(old_url)
654
for revision_id in chain([self.last_revision()],
655
self.tags.get_reverse_tag_dict()):
656
self.repository.fetch(source_repository, revision_id,
659
self._activate_fallback_location(url, 'write')
660
# write this out after the repository is stacked to avoid setting a
661
# stacked config that doesn't work.
662
self._set_config_location('stacked_on_location', url)
665
def _set_tags_bytes(self, bytes):
666
"""Mirror method for _get_tags_bytes.
668
:seealso: Branch._get_tags_bytes.
670
return _run_with_write_locked_target(self, self._transport.put_bytes,
673
def _cache_revision_history(self, rev_history):
674
"""Set the cached revision history to rev_history.
676
The revision_history method will use this cache to avoid regenerating
677
the revision history.
679
This API is semi-public; it only for use by subclasses, all other code
680
should consider it to be private.
682
self._revision_history_cache = rev_history
684
def _cache_revision_id_to_revno(self, revision_id_to_revno):
685
"""Set the cached revision_id => revno map to revision_id_to_revno.
687
This API is semi-public; it only for use by subclasses, all other code
688
should consider it to be private.
690
self._revision_id_to_revno_cache = revision_id_to_revno
692
def _clear_cached_state(self):
693
"""Clear any cached data on this branch, e.g. cached revision history.
695
This means the next call to revision_history will need to call
696
_gen_revision_history.
698
This API is semi-public; it only for use by subclasses, all other code
699
should consider it to be private.
701
self._revision_history_cache = None
702
self._revision_id_to_revno_cache = None
703
self._last_revision_info_cache = None
704
self._merge_sorted_revisions_cache = None
706
def _gen_revision_history(self):
707
"""Return sequence of revision hashes on to this branch.
709
Unlike revision_history, this method always regenerates or rereads the
710
revision history, i.e. it does not cache the result, so repeated calls
713
Concrete subclasses should override this instead of revision_history so
714
that subclasses do not need to deal with caching logic.
716
This API is semi-public; it only for use by subclasses, all other code
717
should consider it to be private.
719
raise NotImplementedError(self._gen_revision_history)
722
def revision_history(self):
723
"""Return sequence of revision ids on this branch.
725
This method will cache the revision history for as long as it is safe to
728
if 'evil' in debug.debug_flags:
729
mutter_callsite(3, "revision_history scales with history.")
730
if self._revision_history_cache is not None:
731
history = self._revision_history_cache
733
history = self._gen_revision_history()
734
self._cache_revision_history(history)
738
"""Return current revision number for this branch.
740
That is equivalent to the number of revisions committed to
743
return self.last_revision_info()[0]
746
"""Older format branches cannot bind or unbind."""
747
raise errors.UpgradeRequired(self.base)
749
def set_append_revisions_only(self, enabled):
750
"""Older format branches are never restricted to append-only"""
751
raise errors.UpgradeRequired(self.base)
753
def last_revision(self):
754
"""Return last revision id, or NULL_REVISION."""
755
return self.last_revision_info()[1]
758
def last_revision_info(self):
759
"""Return information about the last revision.
761
:return: A tuple (revno, revision_id).
763
if self._last_revision_info_cache is None:
764
self._last_revision_info_cache = self._last_revision_info()
765
return self._last_revision_info_cache
767
def _last_revision_info(self):
768
rh = self.revision_history()
771
return (revno, rh[-1])
773
return (0, _mod_revision.NULL_REVISION)
775
@deprecated_method(deprecated_in((1, 6, 0)))
776
def missing_revisions(self, other, stop_revision=None):
777
"""Return a list of new revisions that would perfectly fit.
779
If self and other have not diverged, return a list of the revisions
780
present in other, but missing from self.
782
self_history = self.revision_history()
783
self_len = len(self_history)
784
other_history = other.revision_history()
785
other_len = len(other_history)
786
common_index = min(self_len, other_len) -1
787
if common_index >= 0 and \
788
self_history[common_index] != other_history[common_index]:
789
raise errors.DivergedBranches(self, other)
791
if stop_revision is None:
792
stop_revision = other_len
794
if stop_revision > other_len:
795
raise errors.NoSuchRevision(self, stop_revision)
796
return other_history[self_len:stop_revision]
799
def update_revisions(self, other, stop_revision=None, overwrite=False,
801
"""Pull in new perfect-fit revisions.
803
:param other: Another Branch to pull from
804
:param stop_revision: Updated until the given revision
805
:param overwrite: Always set the branch pointer, rather than checking
806
to see if it is a proper descendant.
807
:param graph: A Graph object that can be used to query history
808
information. This can be None.
811
return InterBranch.get(other, self).update_revisions(stop_revision,
814
def import_last_revision_info(self, source_repo, revno, revid):
815
"""Set the last revision info, importing from another repo if necessary.
817
This is used by the bound branch code to upload a revision to
818
the master branch first before updating the tip of the local branch.
820
:param source_repo: Source repository to optionally fetch from
821
:param revno: Revision number of the new tip
822
:param revid: Revision id of the new tip
824
if not self.repository.has_same_location(source_repo):
825
self.repository.fetch(source_repo, revision_id=revid)
826
self.set_last_revision_info(revno, revid)
828
def revision_id_to_revno(self, revision_id):
829
"""Given a revision id, return its revno"""
830
if _mod_revision.is_null(revision_id):
832
history = self.revision_history()
834
return history.index(revision_id) + 1
836
raise errors.NoSuchRevision(self, revision_id)
838
def get_rev_id(self, revno, history=None):
839
"""Find the revision id of the specified revno."""
841
return _mod_revision.NULL_REVISION
843
history = self.revision_history()
844
if revno <= 0 or revno > len(history):
845
raise errors.NoSuchRevision(self, revno)
846
return history[revno - 1]
849
def pull(self, source, overwrite=False, stop_revision=None,
850
possible_transports=None, *args, **kwargs):
851
"""Mirror source into this branch.
853
This branch is considered to be 'local', having low latency.
855
:returns: PullResult instance
857
return InterBranch.get(source, self).pull(overwrite=overwrite,
858
stop_revision=stop_revision,
859
possible_transports=possible_transports, *args, **kwargs)
861
def push(self, target, overwrite=False, stop_revision=None, *args,
863
"""Mirror this branch into target.
865
This branch is considered to be 'local', having low latency.
867
return InterBranch.get(self, target).push(overwrite, stop_revision,
870
def basis_tree(self):
871
"""Return `Tree` object for last revision."""
872
return self.repository.revision_tree(self.last_revision())
874
def get_parent(self):
875
"""Return the parent location of the branch.
877
This is the default location for pull/missing. The usual
878
pattern is that the user can override it by specifying a
881
parent = self._get_parent_location()
884
# This is an old-format absolute path to a local branch
886
if parent.startswith('/'):
887
parent = urlutils.local_path_to_url(parent.decode('utf8'))
889
return urlutils.join(self.base[:-1], parent)
890
except errors.InvalidURLJoin, e:
891
raise errors.InaccessibleParent(parent, self.base)
893
def _get_parent_location(self):
894
raise NotImplementedError(self._get_parent_location)
896
def _set_config_location(self, name, url, config=None,
897
make_relative=False):
899
config = self.get_config()
903
url = urlutils.relative_url(self.base, url)
904
config.set_user_option(name, url, warn_masked=True)
906
def _get_config_location(self, name, config=None):
908
config = self.get_config()
909
location = config.get_user_option(name)
914
def get_submit_branch(self):
915
"""Return the submit location of the branch.
917
This is the default location for bundle. The usual
918
pattern is that the user can override it by specifying a
921
return self.get_config().get_user_option('submit_branch')
923
def set_submit_branch(self, location):
924
"""Return the submit location of the branch.
926
This is the default location for bundle. The usual
927
pattern is that the user can override it by specifying a
930
self.get_config().set_user_option('submit_branch', location,
933
def get_public_branch(self):
934
"""Return the public location of the branch.
936
This is used by merge directives.
938
return self._get_config_location('public_branch')
940
def set_public_branch(self, location):
941
"""Return the submit location of the branch.
943
This is the default location for bundle. The usual
944
pattern is that the user can override it by specifying a
947
self._set_config_location('public_branch', location)
949
def get_push_location(self):
950
"""Return the None or the location to push this branch to."""
951
push_loc = self.get_config().get_user_option('push_location')
954
def set_push_location(self, location):
955
"""Set a new push location for this branch."""
956
raise NotImplementedError(self.set_push_location)
958
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
959
"""Run the post_change_branch_tip hooks."""
960
hooks = Branch.hooks['post_change_branch_tip']
963
new_revno, new_revid = self.last_revision_info()
964
params = ChangeBranchTipParams(
965
self, old_revno, new_revno, old_revid, new_revid)
969
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
970
"""Run the pre_change_branch_tip hooks."""
971
hooks = Branch.hooks['pre_change_branch_tip']
974
old_revno, old_revid = self.last_revision_info()
975
params = ChangeBranchTipParams(
976
self, old_revno, new_revno, old_revid, new_revid)
980
except errors.TipChangeRejected:
983
exc_info = sys.exc_info()
984
hook_name = Branch.hooks.get_hook_name(hook)
985
raise errors.HookFailed(
986
'pre_change_branch_tip', hook_name, exc_info)
990
"""Synchronise this branch with the master branch if any.
992
:return: None or the last_revision pivoted out during the update.
996
def check_revno(self, revno):
998
Check whether a revno corresponds to any revision.
999
Zero (the NULL revision) is considered valid.
1002
self.check_real_revno(revno)
1004
def check_real_revno(self, revno):
1006
Check whether a revno corresponds to a real revision.
1007
Zero (the NULL revision) is considered invalid
1009
if revno < 1 or revno > self.revno():
1010
raise errors.InvalidRevisionNumber(revno)
1013
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1014
"""Clone this branch into to_bzrdir preserving all semantic values.
1016
Most API users will want 'create_clone_on_transport', which creates a
1017
new bzrdir and branch on the fly.
1019
revision_id: if not None, the revision history in the new branch will
1020
be truncated to end with revision_id.
1022
result = to_bzrdir.create_branch()
1025
if repository_policy is not None:
1026
repository_policy.configure_branch(result)
1027
self.copy_content_into(result, revision_id=revision_id)
1033
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1034
"""Create a new line of development from the branch, into to_bzrdir.
1036
to_bzrdir controls the branch format.
1038
revision_id: if not None, the revision history in the new branch will
1039
be truncated to end with revision_id.
1041
result = to_bzrdir.create_branch()
1044
if repository_policy is not None:
1045
repository_policy.configure_branch(result)
1046
self.copy_content_into(result, revision_id=revision_id)
1047
result.set_parent(self.bzrdir.root_transport.base)
1052
def _synchronize_history(self, destination, revision_id):
1053
"""Synchronize last revision and revision history between branches.
1055
This version is most efficient when the destination is also a
1056
BzrBranch6, but works for BzrBranch5, as long as the destination's
1057
repository contains all the lefthand ancestors of the intended
1058
last_revision. If not, set_last_revision_info will fail.
1060
:param destination: The branch to copy the history into
1061
:param revision_id: The revision-id to truncate history at. May
1062
be None to copy complete history.
1064
source_revno, source_revision_id = self.last_revision_info()
1065
if revision_id is None:
1066
revno, revision_id = source_revno, source_revision_id
1067
elif source_revision_id == revision_id:
1068
# we know the revno without needing to walk all of history
1069
revno = source_revno
1071
# To figure out the revno for a random revision, we need to build
1072
# the revision history, and count its length.
1073
# We don't care about the order, just how long it is.
1074
# Alternatively, we could start at the current location, and count
1075
# backwards. But there is no guarantee that we will find it since
1076
# it may be a merged revision.
1077
revno = len(list(self.repository.iter_reverse_revision_history(
1079
destination.set_last_revision_info(revno, revision_id)
1082
def copy_content_into(self, destination, revision_id=None):
1083
"""Copy the content of self into destination.
1085
revision_id: if not None, the revision history in the new branch will
1086
be truncated to end with revision_id.
1088
self.update_references(destination)
1089
self._synchronize_history(destination, revision_id)
1091
parent = self.get_parent()
1092
except errors.InaccessibleParent, e:
1093
mutter('parent was not accessible to copy: %s', e)
1096
destination.set_parent(parent)
1097
if self._push_should_merge_tags():
1098
self.tags.merge_to(destination.tags)
1100
def update_references(self, target):
1101
if not getattr(self._format, 'supports_reference_locations', False):
1103
reference_dict = self._get_all_reference_info()
1104
if len(reference_dict) == 0:
1106
old_base = self.base
1107
new_base = target.base
1108
target_reference_dict = target._get_all_reference_info()
1109
for file_id, (tree_path, branch_location) in (
1110
reference_dict.items()):
1111
branch_location = urlutils.rebase_url(branch_location,
1113
target_reference_dict.setdefault(
1114
file_id, (tree_path, branch_location))
1115
target._set_all_reference_info(target_reference_dict)
1119
"""Check consistency of the branch.
1121
In particular this checks that revisions given in the revision-history
1122
do actually match up in the revision graph, and that they're all
1123
present in the repository.
1125
Callers will typically also want to check the repository.
1127
:return: A BranchCheckResult.
1129
mainline_parent_id = None
1130
last_revno, last_revision_id = self.last_revision_info()
1131
real_rev_history = list(self.repository.iter_reverse_revision_history(
1133
real_rev_history.reverse()
1134
if len(real_rev_history) != last_revno:
1135
raise errors.BzrCheckError('revno does not match len(mainline)'
1136
' %s != %s' % (last_revno, len(real_rev_history)))
1137
# TODO: We should probably also check that real_rev_history actually
1138
# matches self.revision_history()
1139
for revision_id in real_rev_history:
1141
revision = self.repository.get_revision(revision_id)
1142
except errors.NoSuchRevision, e:
1143
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1145
# In general the first entry on the revision history has no parents.
1146
# But it's not illegal for it to have parents listed; this can happen
1147
# in imports from Arch when the parents weren't reachable.
1148
if mainline_parent_id is not None:
1149
if mainline_parent_id not in revision.parent_ids:
1150
raise errors.BzrCheckError("previous revision {%s} not listed among "
1152
% (mainline_parent_id, revision_id))
1153
mainline_parent_id = revision_id
1154
return BranchCheckResult(self)
1156
def _get_checkout_format(self):
1157
"""Return the most suitable metadir for a checkout of this branch.
1158
Weaves are used if this branch's repository uses weaves.
1160
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1161
from bzrlib.repofmt import weaverepo
1162
format = bzrdir.BzrDirMetaFormat1()
1163
format.repository_format = weaverepo.RepositoryFormat7()
1165
format = self.repository.bzrdir.checkout_metadir()
1166
format.set_branch_format(self._format)
1169
def create_clone_on_transport(self, to_transport, revision_id=None,
1170
stacked_on=None, create_prefix=False, use_existing_dir=False):
1171
"""Create a clone of this branch and its bzrdir.
1173
:param to_transport: The transport to clone onto.
1174
:param revision_id: The revision id to use as tip in the new branch.
1175
If None the tip is obtained from this branch.
1176
:param stacked_on: An optional URL to stack the clone on.
1177
:param create_prefix: Create any missing directories leading up to
1179
:param use_existing_dir: Use an existing directory if one exists.
1181
# XXX: Fix the bzrdir API to allow getting the branch back from the
1182
# clone call. Or something. 20090224 RBC/spiv.
1183
if revision_id is None:
1184
revision_id = self.last_revision()
1186
dir_to = self.bzrdir.clone_on_transport(to_transport,
1187
revision_id=revision_id, stacked_on=stacked_on,
1188
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1189
except errors.FileExists:
1190
if not use_existing_dir:
1192
except errors.NoSuchFile:
1193
if not create_prefix:
1195
return dir_to.open_branch()
1197
def create_checkout(self, to_location, revision_id=None,
1198
lightweight=False, accelerator_tree=None,
1200
"""Create a checkout of a branch.
1202
:param to_location: The url to produce the checkout at
1203
:param revision_id: The revision to check out
1204
:param lightweight: If True, produce a lightweight checkout, otherwise,
1205
produce a bound branch (heavyweight checkout)
1206
:param accelerator_tree: A tree which can be used for retrieving file
1207
contents more quickly than the revision tree, i.e. a workingtree.
1208
The revision tree will be used for cases where accelerator_tree's
1209
content is different.
1210
:param hardlink: If true, hard-link files from accelerator_tree,
1212
:return: The tree of the created checkout
1214
t = transport.get_transport(to_location)
1217
format = self._get_checkout_format()
1218
checkout = format.initialize_on_transport(t)
1219
from_branch = BranchReferenceFormat().initialize(checkout, self)
1221
format = self._get_checkout_format()
1222
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1223
to_location, force_new_tree=False, format=format)
1224
checkout = checkout_branch.bzrdir
1225
checkout_branch.bind(self)
1226
# pull up to the specified revision_id to set the initial
1227
# branch tip correctly, and seed it with history.
1228
checkout_branch.pull(self, stop_revision=revision_id)
1230
tree = checkout.create_workingtree(revision_id,
1231
from_branch=from_branch,
1232
accelerator_tree=accelerator_tree,
1234
basis_tree = tree.basis_tree()
1235
basis_tree.lock_read()
1237
for path, file_id in basis_tree.iter_references():
1238
reference_parent = self.reference_parent(file_id, path)
1239
reference_parent.create_checkout(tree.abspath(path),
1240
basis_tree.get_reference_revision(file_id, path),
1247
def reconcile(self, thorough=True):
1248
"""Make sure the data stored in this branch is consistent."""
1249
from bzrlib.reconcile import BranchReconciler
1250
reconciler = BranchReconciler(self, thorough=thorough)
1251
reconciler.reconcile()
1254
def reference_parent(self, file_id, path, possible_transports=None):
1255
"""Return the parent branch for a tree-reference file_id
1256
:param file_id: The file_id of the tree reference
1257
:param path: The path of the file_id in the tree
1258
:return: A branch associated with the file_id
1260
# FIXME should provide multiple branches, based on config
1261
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1262
possible_transports=possible_transports)
1264
def supports_tags(self):
1265
return self._format.supports_tags()
1267
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1269
"""Ensure that revision_b is a descendant of revision_a.
1271
This is a helper function for update_revisions.
1273
:raises: DivergedBranches if revision_b has diverged from revision_a.
1274
:returns: True if revision_b is a descendant of revision_a.
1276
relation = self._revision_relations(revision_a, revision_b, graph)
1277
if relation == 'b_descends_from_a':
1279
elif relation == 'diverged':
1280
raise errors.DivergedBranches(self, other_branch)
1281
elif relation == 'a_descends_from_b':
1284
raise AssertionError("invalid relation: %r" % (relation,))
1286
def _revision_relations(self, revision_a, revision_b, graph):
1287
"""Determine the relationship between two revisions.
1289
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1291
heads = graph.heads([revision_a, revision_b])
1292
if heads == set([revision_b]):
1293
return 'b_descends_from_a'
1294
elif heads == set([revision_a, revision_b]):
1295
# These branches have diverged
1297
elif heads == set([revision_a]):
1298
return 'a_descends_from_b'
1300
raise AssertionError("invalid heads: %r" % (heads,))
1303
class BranchFormat(object):
1304
"""An encapsulation of the initialization and open routines for a format.
1306
Formats provide three things:
1307
* An initialization routine,
1311
Formats are placed in an dict by their format string for reference
1312
during branch opening. Its not required that these be instances, they
1313
can be classes themselves with class methods - it simply depends on
1314
whether state is needed for a given format or not.
1316
Once a format is deprecated, just deprecate the initialize and open
1317
methods on the format class. Do not deprecate the object, as the
1318
object will be created every time regardless.
1321
_default_format = None
1322
"""The default format used for new branches."""
1325
"""The known formats."""
1327
def __eq__(self, other):
1328
return self.__class__ is other.__class__
1330
def __ne__(self, other):
1331
return not (self == other)
1334
def find_format(klass, a_bzrdir):
1335
"""Return the format for the branch object in a_bzrdir."""
1337
transport = a_bzrdir.get_branch_transport(None)
1338
format_string = transport.get("format").read()
1339
return klass._formats[format_string]
1340
except errors.NoSuchFile:
1341
raise errors.NotBranchError(path=transport.base)
1343
raise errors.UnknownFormatError(format=format_string, kind='branch')
1346
def get_default_format(klass):
1347
"""Return the current default format."""
1348
return klass._default_format
1350
def get_reference(self, a_bzrdir):
1351
"""Get the target reference of the branch in a_bzrdir.
1353
format probing must have been completed before calling
1354
this method - it is assumed that the format of the branch
1355
in a_bzrdir is correct.
1357
:param a_bzrdir: The bzrdir to get the branch data from.
1358
:return: None if the branch is not a reference branch.
1363
def set_reference(self, a_bzrdir, to_branch):
1364
"""Set the target reference of the branch in a_bzrdir.
1366
format probing must have been completed before calling
1367
this method - it is assumed that the format of the branch
1368
in a_bzrdir is correct.
1370
:param a_bzrdir: The bzrdir to set the branch reference for.
1371
:param to_branch: branch that the checkout is to reference
1373
raise NotImplementedError(self.set_reference)
1375
def get_format_string(self):
1376
"""Return the ASCII format string that identifies this format."""
1377
raise NotImplementedError(self.get_format_string)
1379
def get_format_description(self):
1380
"""Return the short format description for this format."""
1381
raise NotImplementedError(self.get_format_description)
1383
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1385
"""Initialize a branch in a bzrdir, with specified files
1387
:param a_bzrdir: The bzrdir to initialize the branch in
1388
:param utf8_files: The files to create as a list of
1389
(filename, content) tuples
1390
:param set_format: If True, set the format with
1391
self.get_format_string. (BzrBranch4 has its format set
1393
:return: a branch in this format
1395
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1396
branch_transport = a_bzrdir.get_branch_transport(self)
1398
'metadir': ('lock', lockdir.LockDir),
1399
'branch4': ('branch-lock', lockable_files.TransportLock),
1401
lock_name, lock_class = lock_map[lock_type]
1402
control_files = lockable_files.LockableFiles(branch_transport,
1403
lock_name, lock_class)
1404
control_files.create_lock()
1406
control_files.lock_write()
1407
except errors.LockContention:
1408
if lock_type != 'branch4':
1414
utf8_files += [('format', self.get_format_string())]
1416
for (filename, content) in utf8_files:
1417
branch_transport.put_bytes(
1419
mode=a_bzrdir._get_file_mode())
1422
control_files.unlock()
1423
return self.open(a_bzrdir, _found=True)
1425
def initialize(self, a_bzrdir):
1426
"""Create a branch of this format in a_bzrdir."""
1427
raise NotImplementedError(self.initialize)
1429
def is_supported(self):
1430
"""Is this format supported?
1432
Supported formats can be initialized and opened.
1433
Unsupported formats may not support initialization or committing or
1434
some other features depending on the reason for not being supported.
1438
def make_tags(self, branch):
1439
"""Create a tags object for branch.
1441
This method is on BranchFormat, because BranchFormats are reflected
1442
over the wire via network_name(), whereas full Branch instances require
1443
multiple VFS method calls to operate at all.
1445
The default implementation returns a disabled-tags instance.
1447
Note that it is normal for branch to be a RemoteBranch when using tags
1450
return DisabledTags(branch)
1452
def network_name(self):
1453
"""A simple byte string uniquely identifying this format for RPC calls.
1455
MetaDir branch formats use their disk format string to identify the
1456
repository over the wire. All in one formats such as bzr < 0.8, and
1457
foreign formats like svn/git and hg should use some marker which is
1458
unique and immutable.
1460
raise NotImplementedError(self.network_name)
1462
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1463
"""Return the branch object for a_bzrdir
1465
:param a_bzrdir: A BzrDir that contains a branch.
1466
:param _found: a private parameter, do not use it. It is used to
1467
indicate if format probing has already be done.
1468
:param ignore_fallbacks: when set, no fallback branches will be opened
1469
(if there are any). Default is to open fallbacks.
1471
raise NotImplementedError(self.open)
1474
def register_format(klass, format):
1475
"""Register a metadir format."""
1476
klass._formats[format.get_format_string()] = format
1477
# Metadir formats have a network name of their format string, and get
1478
# registered as class factories.
1479
network_format_registry.register(format.get_format_string(), format.__class__)
1482
def set_default_format(klass, format):
1483
klass._default_format = format
1485
def supports_stacking(self):
1486
"""True if this format records a stacked-on branch."""
1490
def unregister_format(klass, format):
1491
del klass._formats[format.get_format_string()]
1494
return self.get_format_description().rstrip()
1496
def supports_tags(self):
1497
"""True if this format supports tags stored in the branch"""
1498
return False # by default
1501
class BranchHooks(Hooks):
1502
"""A dictionary mapping hook name to a list of callables for branch hooks.
1504
e.g. ['set_rh'] Is the list of items to be called when the
1505
set_revision_history function is invoked.
1509
"""Create the default hooks.
1511
These are all empty initially, because by default nothing should get
1514
Hooks.__init__(self)
1515
self.create_hook(HookPoint('set_rh',
1516
"Invoked whenever the revision history has been set via "
1517
"set_revision_history. The api signature is (branch, "
1518
"revision_history), and the branch will be write-locked. "
1519
"The set_rh hook can be expensive for bzr to trigger, a better "
1520
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1521
self.create_hook(HookPoint('open',
1522
"Called with the Branch object that has been opened after a "
1523
"branch is opened.", (1, 8), None))
1524
self.create_hook(HookPoint('post_push',
1525
"Called after a push operation completes. post_push is called "
1526
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1527
"bzr client.", (0, 15), None))
1528
self.create_hook(HookPoint('post_pull',
1529
"Called after a pull operation completes. post_pull is called "
1530
"with a bzrlib.branch.PullResult object and only runs in the "
1531
"bzr client.", (0, 15), None))
1532
self.create_hook(HookPoint('pre_commit',
1533
"Called after a commit is calculated but before it is is "
1534
"completed. pre_commit is called with (local, master, old_revno, "
1535
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1536
"). old_revid is NULL_REVISION for the first commit to a branch, "
1537
"tree_delta is a TreeDelta object describing changes from the "
1538
"basis revision. hooks MUST NOT modify this delta. "
1539
" future_tree is an in-memory tree obtained from "
1540
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1541
"tree.", (0,91), None))
1542
self.create_hook(HookPoint('post_commit',
1543
"Called in the bzr client after a commit has completed. "
1544
"post_commit is called with (local, master, old_revno, old_revid, "
1545
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1546
"commit to a branch.", (0, 15), None))
1547
self.create_hook(HookPoint('post_uncommit',
1548
"Called in the bzr client after an uncommit completes. "
1549
"post_uncommit is called with (local, master, old_revno, "
1550
"old_revid, new_revno, new_revid) where local is the local branch "
1551
"or None, master is the target branch, and an empty branch "
1552
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1553
self.create_hook(HookPoint('pre_change_branch_tip',
1554
"Called in bzr client and server before a change to the tip of a "
1555
"branch is made. pre_change_branch_tip is called with a "
1556
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1557
"commit, uncommit will all trigger this hook.", (1, 6), None))
1558
self.create_hook(HookPoint('post_change_branch_tip',
1559
"Called in bzr client and server after a change to the tip of a "
1560
"branch is made. post_change_branch_tip is called with a "
1561
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1562
"commit, uncommit will all trigger this hook.", (1, 4), None))
1563
self.create_hook(HookPoint('transform_fallback_location',
1564
"Called when a stacked branch is activating its fallback "
1565
"locations. transform_fallback_location is called with (branch, "
1566
"url), and should return a new url. Returning the same url "
1567
"allows it to be used as-is, returning a different one can be "
1568
"used to cause the branch to stack on a closer copy of that "
1569
"fallback_location. Note that the branch cannot have history "
1570
"accessing methods called on it during this hook because the "
1571
"fallback locations have not been activated. When there are "
1572
"multiple hooks installed for transform_fallback_location, "
1573
"all are called with the url returned from the previous hook."
1574
"The order is however undefined.", (1, 9), None))
1577
# install the default hooks into the Branch class.
1578
Branch.hooks = BranchHooks()
1581
class ChangeBranchTipParams(object):
1582
"""Object holding parameters passed to *_change_branch_tip hooks.
1584
There are 5 fields that hooks may wish to access:
1586
:ivar branch: the branch being changed
1587
:ivar old_revno: revision number before the change
1588
:ivar new_revno: revision number after the change
1589
:ivar old_revid: revision id before the change
1590
:ivar new_revid: revision id after the change
1592
The revid fields are strings. The revno fields are integers.
1595
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1596
"""Create a group of ChangeBranchTip parameters.
1598
:param branch: The branch being changed.
1599
:param old_revno: Revision number before the change.
1600
:param new_revno: Revision number after the change.
1601
:param old_revid: Tip revision id before the change.
1602
:param new_revid: Tip revision id after the change.
1604
self.branch = branch
1605
self.old_revno = old_revno
1606
self.new_revno = new_revno
1607
self.old_revid = old_revid
1608
self.new_revid = new_revid
1610
def __eq__(self, other):
1611
return self.__dict__ == other.__dict__
1614
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1615
self.__class__.__name__, self.branch,
1616
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1619
class BzrBranchFormat4(BranchFormat):
1620
"""Bzr branch format 4.
1623
- a revision-history file.
1624
- a branch-lock lock file [ to be shared with the bzrdir ]
1627
def get_format_description(self):
1628
"""See BranchFormat.get_format_description()."""
1629
return "Branch format 4"
1631
def initialize(self, a_bzrdir):
1632
"""Create a branch of this format in a_bzrdir."""
1633
utf8_files = [('revision-history', ''),
1634
('branch-name', ''),
1636
return self._initialize_helper(a_bzrdir, utf8_files,
1637
lock_type='branch4', set_format=False)
1640
super(BzrBranchFormat4, self).__init__()
1641
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1643
def network_name(self):
1644
"""The network name for this format is the control dirs disk label."""
1645
return self._matchingbzrdir.get_format_string()
1647
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1648
"""See BranchFormat.open()."""
1650
# we are being called directly and must probe.
1651
raise NotImplementedError
1652
return BzrBranch(_format=self,
1653
_control_files=a_bzrdir._control_files,
1655
_repository=a_bzrdir.open_repository())
1658
return "Bazaar-NG branch format 4"
1661
class BranchFormatMetadir(BranchFormat):
1662
"""Common logic for meta-dir based branch formats."""
1664
def _branch_class(self):
1665
"""What class to instantiate on open calls."""
1666
raise NotImplementedError(self._branch_class)
1668
def network_name(self):
1669
"""A simple byte string uniquely identifying this format for RPC calls.
1671
Metadir branch formats use their format string.
1673
return self.get_format_string()
1675
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1676
"""See BranchFormat.open()."""
1678
format = BranchFormat.find_format(a_bzrdir)
1679
if format.__class__ != self.__class__:
1680
raise AssertionError("wrong format %r found for %r" %
1683
transport = a_bzrdir.get_branch_transport(None)
1684
control_files = lockable_files.LockableFiles(transport, 'lock',
1686
return self._branch_class()(_format=self,
1687
_control_files=control_files,
1689
_repository=a_bzrdir.find_repository(),
1690
ignore_fallbacks=ignore_fallbacks)
1691
except errors.NoSuchFile:
1692
raise errors.NotBranchError(path=transport.base)
1695
super(BranchFormatMetadir, self).__init__()
1696
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1697
self._matchingbzrdir.set_branch_format(self)
1699
def supports_tags(self):
1703
class BzrBranchFormat5(BranchFormatMetadir):
1704
"""Bzr branch format 5.
1707
- a revision-history file.
1709
- a lock dir guarding the branch itself
1710
- all of this stored in a branch/ subdirectory
1711
- works with shared repositories.
1713
This format is new in bzr 0.8.
1716
def _branch_class(self):
1719
def get_format_string(self):
1720
"""See BranchFormat.get_format_string()."""
1721
return "Bazaar-NG branch format 5\n"
1723
def get_format_description(self):
1724
"""See BranchFormat.get_format_description()."""
1725
return "Branch format 5"
1727
def initialize(self, a_bzrdir):
1728
"""Create a branch of this format in a_bzrdir."""
1729
utf8_files = [('revision-history', ''),
1730
('branch-name', ''),
1732
return self._initialize_helper(a_bzrdir, utf8_files)
1734
def supports_tags(self):
1738
class BzrBranchFormat6(BranchFormatMetadir):
1739
"""Branch format with last-revision and tags.
1741
Unlike previous formats, this has no explicit revision history. Instead,
1742
this just stores the last-revision, and the left-hand history leading
1743
up to there is the history.
1745
This format was introduced in bzr 0.15
1746
and became the default in 0.91.
1749
def _branch_class(self):
1752
def get_format_string(self):
1753
"""See BranchFormat.get_format_string()."""
1754
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1756
def get_format_description(self):
1757
"""See BranchFormat.get_format_description()."""
1758
return "Branch format 6"
1760
def initialize(self, a_bzrdir):
1761
"""Create a branch of this format in a_bzrdir."""
1762
utf8_files = [('last-revision', '0 null:\n'),
1763
('branch.conf', ''),
1766
return self._initialize_helper(a_bzrdir, utf8_files)
1768
def make_tags(self, branch):
1769
"""See bzrlib.branch.BranchFormat.make_tags()."""
1770
return BasicTags(branch)
1774
class BzrBranchFormat8(BranchFormatMetadir):
1775
"""Metadir format supporting storing locations of subtree branches."""
1777
def _branch_class(self):
1780
def get_format_string(self):
1781
"""See BranchFormat.get_format_string()."""
1782
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1784
def get_format_description(self):
1785
"""See BranchFormat.get_format_description()."""
1786
return "Branch format 8"
1788
def initialize(self, a_bzrdir):
1789
"""Create a branch of this format in a_bzrdir."""
1790
utf8_files = [('last-revision', '0 null:\n'),
1791
('branch.conf', ''),
1795
return self._initialize_helper(a_bzrdir, utf8_files)
1798
super(BzrBranchFormat8, self).__init__()
1799
self._matchingbzrdir.repository_format = \
1800
RepositoryFormatKnitPack5RichRoot()
1802
def make_tags(self, branch):
1803
"""See bzrlib.branch.BranchFormat.make_tags()."""
1804
return BasicTags(branch)
1806
def supports_stacking(self):
1809
supports_reference_locations = True
1812
class BzrBranchFormat7(BzrBranchFormat8):
1813
"""Branch format with last-revision, tags, and a stacked location pointer.
1815
The stacked location pointer is passed down to the repository and requires
1816
a repository format with supports_external_lookups = True.
1818
This format was introduced in bzr 1.6.
1821
def initialize(self, a_bzrdir):
1822
"""Create a branch of this format in a_bzrdir."""
1823
utf8_files = [('last-revision', '0 null:\n'),
1824
('branch.conf', ''),
1827
return self._initialize_helper(a_bzrdir, utf8_files)
1829
def _branch_class(self):
1832
def get_format_string(self):
1833
"""See BranchFormat.get_format_string()."""
1834
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1836
def get_format_description(self):
1837
"""See BranchFormat.get_format_description()."""
1838
return "Branch format 7"
1840
supports_reference_locations = False
1843
class BranchReferenceFormat(BranchFormat):
1844
"""Bzr branch reference format.
1846
Branch references are used in implementing checkouts, they
1847
act as an alias to the real branch which is at some other url.
1854
def get_format_string(self):
1855
"""See BranchFormat.get_format_string()."""
1856
return "Bazaar-NG Branch Reference Format 1\n"
1858
def get_format_description(self):
1859
"""See BranchFormat.get_format_description()."""
1860
return "Checkout reference format 1"
1862
def get_reference(self, a_bzrdir):
1863
"""See BranchFormat.get_reference()."""
1864
transport = a_bzrdir.get_branch_transport(None)
1865
return transport.get('location').read()
1867
def set_reference(self, a_bzrdir, to_branch):
1868
"""See BranchFormat.set_reference()."""
1869
transport = a_bzrdir.get_branch_transport(None)
1870
location = transport.put_bytes('location', to_branch.base)
1872
def initialize(self, a_bzrdir, target_branch=None):
1873
"""Create a branch of this format in a_bzrdir."""
1874
if target_branch is None:
1875
# this format does not implement branch itself, thus the implicit
1876
# creation contract must see it as uninitializable
1877
raise errors.UninitializableFormat(self)
1878
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1879
branch_transport = a_bzrdir.get_branch_transport(self)
1880
branch_transport.put_bytes('location',
1881
target_branch.bzrdir.root_transport.base)
1882
branch_transport.put_bytes('format', self.get_format_string())
1884
a_bzrdir, _found=True,
1885
possible_transports=[target_branch.bzrdir.root_transport])
1888
super(BranchReferenceFormat, self).__init__()
1889
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1890
self._matchingbzrdir.set_branch_format(self)
1892
def _make_reference_clone_function(format, a_branch):
1893
"""Create a clone() routine for a branch dynamically."""
1894
def clone(to_bzrdir, revision_id=None,
1895
repository_policy=None):
1896
"""See Branch.clone()."""
1897
return format.initialize(to_bzrdir, a_branch)
1898
# cannot obey revision_id limits when cloning a reference ...
1899
# FIXME RBC 20060210 either nuke revision_id for clone, or
1900
# emit some sort of warning/error to the caller ?!
1903
def open(self, a_bzrdir, _found=False, location=None,
1904
possible_transports=None, ignore_fallbacks=False):
1905
"""Return the branch that the branch reference in a_bzrdir points at.
1907
:param a_bzrdir: A BzrDir that contains a branch.
1908
:param _found: a private parameter, do not use it. It is used to
1909
indicate if format probing has already be done.
1910
:param ignore_fallbacks: when set, no fallback branches will be opened
1911
(if there are any). Default is to open fallbacks.
1912
:param location: The location of the referenced branch. If
1913
unspecified, this will be determined from the branch reference in
1915
:param possible_transports: An optional reusable transports list.
1918
format = BranchFormat.find_format(a_bzrdir)
1919
if format.__class__ != self.__class__:
1920
raise AssertionError("wrong format %r found for %r" %
1922
if location is None:
1923
location = self.get_reference(a_bzrdir)
1924
real_bzrdir = bzrdir.BzrDir.open(
1925
location, possible_transports=possible_transports)
1926
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1927
# this changes the behaviour of result.clone to create a new reference
1928
# rather than a copy of the content of the branch.
1929
# I did not use a proxy object because that needs much more extensive
1930
# testing, and we are only changing one behaviour at the moment.
1931
# If we decide to alter more behaviours - i.e. the implicit nickname
1932
# then this should be refactored to introduce a tested proxy branch
1933
# and a subclass of that for use in overriding clone() and ....
1935
result.clone = self._make_reference_clone_function(result)
1939
network_format_registry = registry.FormatRegistry()
1940
"""Registry of formats indexed by their network name.
1942
The network name for a branch format is an identifier that can be used when
1943
referring to formats with smart server operations. See
1944
BranchFormat.network_name() for more detail.
1948
# formats which have no format string are not discoverable
1949
# and not independently creatable, so are not registered.
1950
__format5 = BzrBranchFormat5()
1951
__format6 = BzrBranchFormat6()
1952
__format7 = BzrBranchFormat7()
1953
__format8 = BzrBranchFormat8()
1954
BranchFormat.register_format(__format5)
1955
BranchFormat.register_format(BranchReferenceFormat())
1956
BranchFormat.register_format(__format6)
1957
BranchFormat.register_format(__format7)
1958
BranchFormat.register_format(__format8)
1959
BranchFormat.set_default_format(__format6)
1960
_legacy_formats = [BzrBranchFormat4(),
1962
network_format_registry.register(
1963
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1966
class BzrBranch(Branch):
1967
"""A branch stored in the actual filesystem.
1969
Note that it's "local" in the context of the filesystem; it doesn't
1970
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1971
it's writable, and can be accessed via the normal filesystem API.
1973
:ivar _transport: Transport for file operations on this branch's
1974
control files, typically pointing to the .bzr/branch directory.
1975
:ivar repository: Repository for this branch.
1976
:ivar base: The url of the base directory for this branch; the one
1977
containing the .bzr directory.
1980
def __init__(self, _format=None,
1981
_control_files=None, a_bzrdir=None, _repository=None,
1982
ignore_fallbacks=False):
1983
"""Create new branch object at a particular location."""
1984
if a_bzrdir is None:
1985
raise ValueError('a_bzrdir must be supplied')
1987
self.bzrdir = a_bzrdir
1988
self._base = self.bzrdir.transport.clone('..').base
1989
# XXX: We should be able to just do
1990
# self.base = self.bzrdir.root_transport.base
1991
# but this does not quite work yet -- mbp 20080522
1992
self._format = _format
1993
if _control_files is None:
1994
raise ValueError('BzrBranch _control_files is None')
1995
self.control_files = _control_files
1996
self._transport = _control_files._transport
1997
self.repository = _repository
1998
Branch.__init__(self)
2001
return '%s(%r)' % (self.__class__.__name__, self.base)
2005
def _get_base(self):
2006
"""Returns the directory containing the control directory."""
2009
base = property(_get_base, doc="The URL for the root of this branch.")
2011
def _get_config(self):
2012
return TransportConfig(self._transport, 'branch.conf')
2014
def is_locked(self):
2015
return self.control_files.is_locked()
2017
def lock_write(self, token=None):
2018
# All-in-one needs to always unlock/lock.
2019
repo_control = getattr(self.repository, 'control_files', None)
2020
if self.control_files == repo_control or not self.is_locked():
2021
self.repository.lock_write()
2026
return self.control_files.lock_write(token=token)
2029
self.repository.unlock()
2032
def lock_read(self):
2033
# All-in-one needs to always unlock/lock.
2034
repo_control = getattr(self.repository, 'control_files', None)
2035
if self.control_files == repo_control or not self.is_locked():
2036
self.repository.lock_read()
2041
self.control_files.lock_read()
2044
self.repository.unlock()
2049
self.control_files.unlock()
2051
# All-in-one needs to always unlock/lock.
2052
repo_control = getattr(self.repository, 'control_files', None)
2053
if (self.control_files == repo_control or
2054
not self.control_files.is_locked()):
2055
self.repository.unlock()
2056
if not self.control_files.is_locked():
2057
# we just released the lock
2058
self._clear_cached_state()
2060
def peek_lock_mode(self):
2061
if self.control_files._lock_count == 0:
2064
return self.control_files._lock_mode
2066
def get_physical_lock_status(self):
2067
return self.control_files.get_physical_lock_status()
2070
def print_file(self, file, revision_id):
2071
"""See Branch.print_file."""
2072
return self.repository.print_file(file, revision_id)
2074
def _write_revision_history(self, history):
2075
"""Factored out of set_revision_history.
2077
This performs the actual writing to disk.
2078
It is intended to be called by BzrBranch5.set_revision_history."""
2079
self._transport.put_bytes(
2080
'revision-history', '\n'.join(history),
2081
mode=self.bzrdir._get_file_mode())
2084
def set_revision_history(self, rev_history):
2085
"""See Branch.set_revision_history."""
2086
if 'evil' in debug.debug_flags:
2087
mutter_callsite(3, "set_revision_history scales with history.")
2088
check_not_reserved_id = _mod_revision.check_not_reserved_id
2089
for rev_id in rev_history:
2090
check_not_reserved_id(rev_id)
2091
if Branch.hooks['post_change_branch_tip']:
2092
# Don't calculate the last_revision_info() if there are no hooks
2094
old_revno, old_revid = self.last_revision_info()
2095
if len(rev_history) == 0:
2096
revid = _mod_revision.NULL_REVISION
2098
revid = rev_history[-1]
2099
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2100
self._write_revision_history(rev_history)
2101
self._clear_cached_state()
2102
self._cache_revision_history(rev_history)
2103
for hook in Branch.hooks['set_rh']:
2104
hook(self, rev_history)
2105
if Branch.hooks['post_change_branch_tip']:
2106
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2108
def _synchronize_history(self, destination, revision_id):
2109
"""Synchronize last revision and revision history between branches.
2111
This version is most efficient when the destination is also a
2112
BzrBranch5, but works for BzrBranch6 as long as the revision
2113
history is the true lefthand parent history, and all of the revisions
2114
are in the destination's repository. If not, set_revision_history
2117
:param destination: The branch to copy the history into
2118
:param revision_id: The revision-id to truncate history at. May
2119
be None to copy complete history.
2121
if not isinstance(destination._format, BzrBranchFormat5):
2122
super(BzrBranch, self)._synchronize_history(
2123
destination, revision_id)
2125
if revision_id == _mod_revision.NULL_REVISION:
2128
new_history = self.revision_history()
2129
if revision_id is not None and new_history != []:
2131
new_history = new_history[:new_history.index(revision_id) + 1]
2133
rev = self.repository.get_revision(revision_id)
2134
new_history = rev.get_history(self.repository)[1:]
2135
destination.set_revision_history(new_history)
2138
def set_last_revision_info(self, revno, revision_id):
2139
"""Set the last revision of this branch.
2141
The caller is responsible for checking that the revno is correct
2142
for this revision id.
2144
It may be possible to set the branch last revision to an id not
2145
present in the repository. However, branches can also be
2146
configured to check constraints on history, in which case this may not
2149
revision_id = _mod_revision.ensure_null(revision_id)
2150
# this old format stores the full history, but this api doesn't
2151
# provide it, so we must generate, and might as well check it's
2153
history = self._lefthand_history(revision_id)
2154
if len(history) != revno:
2155
raise AssertionError('%d != %d' % (len(history), revno))
2156
self.set_revision_history(history)
2158
def _gen_revision_history(self):
2159
history = self._transport.get_bytes('revision-history').split('\n')
2160
if history[-1:] == ['']:
2161
# There shouldn't be a trailing newline, but just in case.
2166
def generate_revision_history(self, revision_id, last_rev=None,
2168
"""Create a new revision history that will finish with revision_id.
2170
:param revision_id: the new tip to use.
2171
:param last_rev: The previous last_revision. If not None, then this
2172
must be a ancestory of revision_id, or DivergedBranches is raised.
2173
:param other_branch: The other branch that DivergedBranches should
2174
raise with respect to.
2176
self.set_revision_history(self._lefthand_history(revision_id,
2177
last_rev, other_branch))
2179
def basis_tree(self):
2180
"""See Branch.basis_tree."""
2181
return self.repository.revision_tree(self.last_revision())
2183
def _get_parent_location(self):
2184
_locs = ['parent', 'pull', 'x-pull']
2187
return self._transport.get_bytes(l).strip('\n')
2188
except errors.NoSuchFile:
2192
def _basic_push(self, target, overwrite, stop_revision):
2193
"""Basic implementation of push without bound branches or hooks.
2195
Must be called with source read locked and target write locked.
2197
result = BranchPushResult()
2198
result.source_branch = self
2199
result.target_branch = target
2200
result.old_revno, result.old_revid = target.last_revision_info()
2201
self.update_references(target)
2202
if result.old_revid != self.last_revision():
2203
# We assume that during 'push' this repository is closer than
2205
graph = self.repository.get_graph(target.repository)
2206
target.update_revisions(self, stop_revision,
2207
overwrite=overwrite, graph=graph)
2208
if self._push_should_merge_tags():
2209
result.tag_conflicts = self.tags.merge_to(target.tags,
2211
result.new_revno, result.new_revid = target.last_revision_info()
2214
def get_stacked_on_url(self):
2215
raise errors.UnstackableBranchFormat(self._format, self.base)
2217
def set_push_location(self, location):
2218
"""See Branch.set_push_location."""
2219
self.get_config().set_user_option(
2220
'push_location', location,
2221
store=_mod_config.STORE_LOCATION_NORECURSE)
2223
def _set_parent_location(self, url):
2225
self._transport.delete('parent')
2227
self._transport.put_bytes('parent', url + '\n',
2228
mode=self.bzrdir._get_file_mode())
2231
class BzrBranch5(BzrBranch):
2232
"""A format 5 branch. This supports new features over plain branches.
2234
It has support for a master_branch which is the data for bound branches.
2237
def get_bound_location(self):
2239
return self._transport.get_bytes('bound')[:-1]
2240
except errors.NoSuchFile:
2244
def get_master_branch(self, possible_transports=None):
2245
"""Return the branch we are bound to.
2247
:return: Either a Branch, or None
2249
This could memoise the branch, but if thats done
2250
it must be revalidated on each new lock.
2251
So for now we just don't memoise it.
2252
# RBC 20060304 review this decision.
2254
bound_loc = self.get_bound_location()
2258
return Branch.open(bound_loc,
2259
possible_transports=possible_transports)
2260
except (errors.NotBranchError, errors.ConnectionError), e:
2261
raise errors.BoundBranchConnectionFailure(
2265
def set_bound_location(self, location):
2266
"""Set the target where this branch is bound to.
2268
:param location: URL to the target branch
2271
self._transport.put_bytes('bound', location+'\n',
2272
mode=self.bzrdir._get_file_mode())
2275
self._transport.delete('bound')
2276
except errors.NoSuchFile:
2281
def bind(self, other):
2282
"""Bind this branch to the branch other.
2284
This does not push or pull data between the branches, though it does
2285
check for divergence to raise an error when the branches are not
2286
either the same, or one a prefix of the other. That behaviour may not
2287
be useful, so that check may be removed in future.
2289
:param other: The branch to bind to
2292
# TODO: jam 20051230 Consider checking if the target is bound
2293
# It is debatable whether you should be able to bind to
2294
# a branch which is itself bound.
2295
# Committing is obviously forbidden,
2296
# but binding itself may not be.
2297
# Since we *have* to check at commit time, we don't
2298
# *need* to check here
2300
# we want to raise diverged if:
2301
# last_rev is not in the other_last_rev history, AND
2302
# other_last_rev is not in our history, and do it without pulling
2304
self.set_bound_location(other.base)
2308
"""If bound, unbind"""
2309
return self.set_bound_location(None)
2312
def update(self, possible_transports=None):
2313
"""Synchronise this branch with the master branch if any.
2315
:return: None or the last_revision that was pivoted out during the
2318
master = self.get_master_branch(possible_transports)
2319
if master is not None:
2320
old_tip = _mod_revision.ensure_null(self.last_revision())
2321
self.pull(master, overwrite=True)
2322
if self.repository.get_graph().is_ancestor(old_tip,
2323
_mod_revision.ensure_null(self.last_revision())):
2329
class BzrBranch8(BzrBranch5):
2330
"""A branch that stores tree-reference locations."""
2332
def _open_hook(self):
2333
if self._ignore_fallbacks:
2336
url = self.get_stacked_on_url()
2337
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2338
errors.UnstackableBranchFormat):
2341
for hook in Branch.hooks['transform_fallback_location']:
2342
url = hook(self, url)
2344
hook_name = Branch.hooks.get_hook_name(hook)
2345
raise AssertionError(
2346
"'transform_fallback_location' hook %s returned "
2347
"None, not a URL." % hook_name)
2348
self._activate_fallback_location(url, None)
2350
def __init__(self, *args, **kwargs):
2351
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2352
super(BzrBranch8, self).__init__(*args, **kwargs)
2353
self._last_revision_info_cache = None
2354
self._partial_revision_history_cache = []
2355
self._reference_info = None
2357
def _clear_cached_state(self):
2358
super(BzrBranch8, self)._clear_cached_state()
2359
self._last_revision_info_cache = None
2360
self._partial_revision_history_cache = []
2361
self._reference_info = None
2363
def _last_revision_info(self):
2364
revision_string = self._transport.get_bytes('last-revision')
2365
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2366
revision_id = cache_utf8.get_cached_utf8(revision_id)
2368
return revno, revision_id
2370
def _write_last_revision_info(self, revno, revision_id):
2371
"""Simply write out the revision id, with no checks.
2373
Use set_last_revision_info to perform this safely.
2375
Does not update the revision_history cache.
2376
Intended to be called by set_last_revision_info and
2377
_write_revision_history.
2379
revision_id = _mod_revision.ensure_null(revision_id)
2380
out_string = '%d %s\n' % (revno, revision_id)
2381
self._transport.put_bytes('last-revision', out_string,
2382
mode=self.bzrdir._get_file_mode())
2385
def set_last_revision_info(self, revno, revision_id):
2386
revision_id = _mod_revision.ensure_null(revision_id)
2387
old_revno, old_revid = self.last_revision_info()
2388
if self._get_append_revisions_only():
2389
self._check_history_violation(revision_id)
2390
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2391
self._write_last_revision_info(revno, revision_id)
2392
self._clear_cached_state()
2393
self._last_revision_info_cache = revno, revision_id
2394
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2396
def _synchronize_history(self, destination, revision_id):
2397
"""Synchronize last revision and revision history between branches.
2399
:see: Branch._synchronize_history
2401
# XXX: The base Branch has a fast implementation of this method based
2402
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2403
# that uses set_revision_history. This class inherits from BzrBranch5,
2404
# but wants the fast implementation, so it calls
2405
# Branch._synchronize_history directly.
2406
Branch._synchronize_history(self, destination, revision_id)
2408
def _check_history_violation(self, revision_id):
2409
last_revision = _mod_revision.ensure_null(self.last_revision())
2410
if _mod_revision.is_null(last_revision):
2412
if last_revision not in self._lefthand_history(revision_id):
2413
raise errors.AppendRevisionsOnlyViolation(self.base)
2415
def _gen_revision_history(self):
2416
"""Generate the revision history from last revision
2418
last_revno, last_revision = self.last_revision_info()
2419
self._extend_partial_history(stop_index=last_revno-1)
2420
return list(reversed(self._partial_revision_history_cache))
2422
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2423
"""Extend the partial history to include a given index
2425
If a stop_index is supplied, stop when that index has been reached.
2426
If a stop_revision is supplied, stop when that revision is
2427
encountered. Otherwise, stop when the beginning of history is
2430
:param stop_index: The index which should be present. When it is
2431
present, history extension will stop.
2432
:param revision_id: The revision id which should be present. When
2433
it is encountered, history extension will stop.
2435
repo = self.repository
2436
if len(self._partial_revision_history_cache) == 0:
2437
iterator = repo.iter_reverse_revision_history(self.last_revision())
2439
start_revision = self._partial_revision_history_cache[-1]
2440
iterator = repo.iter_reverse_revision_history(start_revision)
2441
#skip the last revision in the list
2442
next_revision = iterator.next()
2443
for revision_id in iterator:
2444
self._partial_revision_history_cache.append(revision_id)
2445
if (stop_index is not None and
2446
len(self._partial_revision_history_cache) > stop_index):
2448
if revision_id == stop_revision:
2451
def _write_revision_history(self, history):
2452
"""Factored out of set_revision_history.
2454
This performs the actual writing to disk, with format-specific checks.
2455
It is intended to be called by BzrBranch5.set_revision_history.
2457
if len(history) == 0:
2458
last_revision = 'null:'
2460
if history != self._lefthand_history(history[-1]):
2461
raise errors.NotLefthandHistory(history)
2462
last_revision = history[-1]
2463
if self._get_append_revisions_only():
2464
self._check_history_violation(last_revision)
2465
self._write_last_revision_info(len(history), last_revision)
2468
def _set_parent_location(self, url):
2469
"""Set the parent branch"""
2470
self._set_config_location('parent_location', url, make_relative=True)
2473
def _get_parent_location(self):
2474
"""Set the parent branch"""
2475
return self._get_config_location('parent_location')
2478
def _set_all_reference_info(self, info_dict):
2479
"""Replace all reference info stored in a branch.
2481
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2484
writer = rio.RioWriter(s)
2485
for key, (tree_path, branch_location) in info_dict.iteritems():
2486
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2487
branch_location=branch_location)
2488
writer.write_stanza(stanza)
2489
self._transport.put_bytes('references', s.getvalue())
2490
self._reference_info = info_dict
2493
def _get_all_reference_info(self):
2494
"""Return all the reference info stored in a branch.
2496
:return: A dict of {file_id: (tree_path, branch_location)}
2498
if self._reference_info is not None:
2499
return self._reference_info
2500
rio_file = self._transport.get('references')
2502
stanzas = rio.read_stanzas(rio_file)
2503
info_dict = dict((s['file_id'], (s['tree_path'],
2504
s['branch_location'])) for s in stanzas)
2507
self._reference_info = info_dict
2510
def set_reference_info(self, file_id, tree_path, branch_location):
2511
"""Set the branch location to use for a tree reference.
2513
:param file_id: The file-id of the tree reference.
2514
:param tree_path: The path of the tree reference in the tree.
2515
:param branch_location: The location of the branch to retrieve tree
2518
info_dict = self._get_all_reference_info()
2519
info_dict[file_id] = (tree_path, branch_location)
2520
if None in (tree_path, branch_location):
2521
if tree_path is not None:
2522
raise ValueError('tree_path must be None when branch_location'
2524
if branch_location is not None:
2525
raise ValueError('branch_location must be None when tree_path'
2527
del info_dict[file_id]
2528
self._set_all_reference_info(info_dict)
2530
def get_reference_info(self, file_id):
2531
"""Get the tree_path and branch_location for a tree reference.
2533
:return: a tuple of (tree_path, branch_location)
2535
return self._get_all_reference_info().get(file_id, (None, None))
2537
def reference_parent(self, file_id, path, possible_transports=None):
2538
"""Return the parent branch for a tree-reference file_id.
2540
:param file_id: The file_id of the tree reference
2541
:param path: The path of the file_id in the tree
2542
:return: A branch associated with the file_id
2544
branch_location = self.get_reference_info(file_id)[1]
2545
if branch_location is None:
2546
return Branch.reference_parent(self, file_id, path,
2547
possible_transports)
2548
branch_location = urlutils.join(self.base, branch_location)
2549
return Branch.open(branch_location,
2550
possible_transports=possible_transports)
2552
def set_push_location(self, location):
2553
"""See Branch.set_push_location."""
2554
self._set_config_location('push_location', location)
2556
def set_bound_location(self, location):
2557
"""See Branch.set_push_location."""
2559
config = self.get_config()
2560
if location is None:
2561
if config.get_user_option('bound') != 'True':
2564
config.set_user_option('bound', 'False', warn_masked=True)
2567
self._set_config_location('bound_location', location,
2569
config.set_user_option('bound', 'True', warn_masked=True)
2572
def _get_bound_location(self, bound):
2573
"""Return the bound location in the config file.
2575
Return None if the bound parameter does not match"""
2576
config = self.get_config()
2577
config_bound = (config.get_user_option('bound') == 'True')
2578
if config_bound != bound:
2580
return self._get_config_location('bound_location', config=config)
2582
def get_bound_location(self):
2583
"""See Branch.set_push_location."""
2584
return self._get_bound_location(True)
2586
def get_old_bound_location(self):
2587
"""See Branch.get_old_bound_location"""
2588
return self._get_bound_location(False)
2590
def get_stacked_on_url(self):
2591
# you can always ask for the URL; but you might not be able to use it
2592
# if the repo can't support stacking.
2593
## self._check_stackable_repo()
2594
stacked_url = self._get_config_location('stacked_on_location')
2595
if stacked_url is None:
2596
raise errors.NotStacked(self)
2599
def set_append_revisions_only(self, enabled):
2604
self.get_config().set_user_option('append_revisions_only', value,
2607
def _get_append_revisions_only(self):
2608
value = self.get_config().get_user_option('append_revisions_only')
2609
return value == 'True'
2612
def generate_revision_history(self, revision_id, last_rev=None,
2614
"""See BzrBranch5.generate_revision_history"""
2615
history = self._lefthand_history(revision_id, last_rev, other_branch)
2616
revno = len(history)
2617
self.set_last_revision_info(revno, revision_id)
2620
def get_rev_id(self, revno, history=None):
2621
"""Find the revision id of the specified revno."""
2623
return _mod_revision.NULL_REVISION
2625
last_revno, last_revision_id = self.last_revision_info()
2626
if revno <= 0 or revno > last_revno:
2627
raise errors.NoSuchRevision(self, revno)
2629
if history is not None:
2630
return history[revno - 1]
2632
index = last_revno - revno
2633
if len(self._partial_revision_history_cache) <= index:
2634
self._extend_partial_history(stop_index=index)
2635
if len(self._partial_revision_history_cache) > index:
2636
return self._partial_revision_history_cache[index]
2638
raise errors.NoSuchRevision(self, revno)
2641
def revision_id_to_revno(self, revision_id):
2642
"""Given a revision id, return its revno"""
2643
if _mod_revision.is_null(revision_id):
2646
index = self._partial_revision_history_cache.index(revision_id)
2648
self._extend_partial_history(stop_revision=revision_id)
2649
index = len(self._partial_revision_history_cache) - 1
2650
if self._partial_revision_history_cache[index] != revision_id:
2651
raise errors.NoSuchRevision(self, revision_id)
2652
return self.revno() - index
2655
class BzrBranch7(BzrBranch8):
2656
"""A branch with support for a fallback repository."""
2658
def set_reference_info(self, file_id, tree_path, branch_location):
2659
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2661
def get_reference_info(self, file_id):
2662
Branch.get_reference_info(self, file_id)
2664
def reference_parent(self, file_id, path, possible_transports=None):
2665
return Branch.reference_parent(self, file_id, path,
2666
possible_transports)
2669
class BzrBranch6(BzrBranch7):
2670
"""See BzrBranchFormat6 for the capabilities of this branch.
2672
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2676
def get_stacked_on_url(self):
2677
raise errors.UnstackableBranchFormat(self._format, self.base)
2680
######################################################################
2681
# results of operations
2684
class _Result(object):
2686
def _show_tag_conficts(self, to_file):
2687
if not getattr(self, 'tag_conflicts', None):
2689
to_file.write('Conflicting tags:\n')
2690
for name, value1, value2 in self.tag_conflicts:
2691
to_file.write(' %s\n' % (name, ))
2694
class PullResult(_Result):
2695
"""Result of a Branch.pull operation.
2697
:ivar old_revno: Revision number before pull.
2698
:ivar new_revno: Revision number after pull.
2699
:ivar old_revid: Tip revision id before pull.
2700
:ivar new_revid: Tip revision id after pull.
2701
:ivar source_branch: Source (local) branch object. (read locked)
2702
:ivar master_branch: Master branch of the target, or the target if no
2704
:ivar local_branch: target branch if there is a Master, else None
2705
:ivar target_branch: Target/destination branch object. (write locked)
2706
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2710
# DEPRECATED: pull used to return the change in revno
2711
return self.new_revno - self.old_revno
2713
def report(self, to_file):
2715
if self.old_revid == self.new_revid:
2716
to_file.write('No revisions to pull.\n')
2718
to_file.write('Now on revision %d.\n' % self.new_revno)
2719
self._show_tag_conficts(to_file)
2722
class BranchPushResult(_Result):
2723
"""Result of a Branch.push operation.
2725
:ivar old_revno: Revision number (eg 10) of the target before push.
2726
:ivar new_revno: Revision number (eg 12) of the target after push.
2727
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2729
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2731
:ivar source_branch: Source branch object that the push was from. This is
2732
read locked, and generally is a local (and thus low latency) branch.
2733
:ivar master_branch: If target is a bound branch, the master branch of
2734
target, or target itself. Always write locked.
2735
:ivar target_branch: The direct Branch where data is being sent (write
2737
:ivar local_branch: If the target is a bound branch this will be the
2738
target, otherwise it will be None.
2742
# DEPRECATED: push used to return the change in revno
2743
return self.new_revno - self.old_revno
2745
def report(self, to_file):
2746
"""Write a human-readable description of the result."""
2747
if self.old_revid == self.new_revid:
2748
note('No new revisions to push.')
2750
note('Pushed up to revision %d.' % self.new_revno)
2751
self._show_tag_conficts(to_file)
2754
class BranchCheckResult(object):
2755
"""Results of checking branch consistency.
2760
def __init__(self, branch):
2761
self.branch = branch
2763
def report_results(self, verbose):
2764
"""Report the check results via trace.note.
2766
:param verbose: Requests more detailed display of what was checked,
2769
note('checked branch %s format %s',
2771
self.branch._format)
2774
class Converter5to6(object):
2775
"""Perform an in-place upgrade of format 5 to format 6"""
2777
def convert(self, branch):
2778
# Data for 5 and 6 can peacefully coexist.
2779
format = BzrBranchFormat6()
2780
new_branch = format.open(branch.bzrdir, _found=True)
2782
# Copy source data into target
2783
new_branch._write_last_revision_info(*branch.last_revision_info())
2784
new_branch.set_parent(branch.get_parent())
2785
new_branch.set_bound_location(branch.get_bound_location())
2786
new_branch.set_push_location(branch.get_push_location())
2788
# New branch has no tags by default
2789
new_branch.tags._set_tag_dict({})
2791
# Copying done; now update target format
2792
new_branch._transport.put_bytes('format',
2793
format.get_format_string(),
2794
mode=new_branch.bzrdir._get_file_mode())
2796
# Clean up old files
2797
new_branch._transport.delete('revision-history')
2799
branch.set_parent(None)
2800
except errors.NoSuchFile:
2802
branch.set_bound_location(None)
2805
class Converter6to7(object):
2806
"""Perform an in-place upgrade of format 6 to format 7"""
2808
def convert(self, branch):
2809
format = BzrBranchFormat7()
2810
branch._set_config_location('stacked_on_location', '')
2811
# update target format
2812
branch._transport.put_bytes('format', format.get_format_string())
2815
class Converter7to8(object):
2816
"""Perform an in-place upgrade of format 6 to format 7"""
2818
def convert(self, branch):
2819
format = BzrBranchFormat8()
2820
branch._transport.put_bytes('references', '')
2821
# update target format
2822
branch._transport.put_bytes('format', format.get_format_string())
2825
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2826
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2829
_run_with_write_locked_target will attempt to release the lock it acquires.
2831
If an exception is raised by callable, then that exception *will* be
2832
propagated, even if the unlock attempt raises its own error. Thus
2833
_run_with_write_locked_target should be preferred to simply doing::
2837
return callable(*args, **kwargs)
2842
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2843
# should share code?
2846
result = callable(*args, **kwargs)
2848
exc_info = sys.exc_info()
2852
raise exc_info[0], exc_info[1], exc_info[2]
2858
class InterBranch(InterObject):
2859
"""This class represents operations taking place between two branches.
2861
Its instances have methods like pull() and push() and contain
2862
references to the source and target repositories these operations
2863
can be carried out on.
2867
"""The available optimised InterBranch types."""
2870
def _get_branch_formats_to_test():
2871
"""Return a tuple with the Branch formats to use when testing."""
2872
raise NotImplementedError(self._get_branch_formats_to_test)
2874
def pull(self, overwrite=False, stop_revision=None,
2875
possible_transports=None, local=False):
2876
"""Mirror source into target branch.
2878
The target branch is considered to be 'local', having low latency.
2880
:returns: PullResult instance
2882
raise NotImplementedError(self.pull)
2884
def update_revisions(self, stop_revision=None, overwrite=False,
2886
"""Pull in new perfect-fit revisions.
2888
:param stop_revision: Updated until the given revision
2889
:param overwrite: Always set the branch pointer, rather than checking
2890
to see if it is a proper descendant.
2891
:param graph: A Graph object that can be used to query history
2892
information. This can be None.
2895
raise NotImplementedError(self.update_revisions)
2897
def push(self, overwrite=False, stop_revision=None,
2898
_override_hook_source_branch=None):
2899
"""Mirror the source branch into the target branch.
2901
The source branch is considered to be 'local', having low latency.
2903
raise NotImplementedError(self.push)
2906
class GenericInterBranch(InterBranch):
2907
"""InterBranch implementation that uses public Branch functions.
2911
def _get_branch_formats_to_test():
2912
return BranchFormat._default_format, BranchFormat._default_format
2914
def update_revisions(self, stop_revision=None, overwrite=False,
2916
"""See InterBranch.update_revisions()."""
2917
self.source.lock_read()
2919
other_revno, other_last_revision = self.source.last_revision_info()
2920
stop_revno = None # unknown
2921
if stop_revision is None:
2922
stop_revision = other_last_revision
2923
if _mod_revision.is_null(stop_revision):
2924
# if there are no commits, we're done.
2926
stop_revno = other_revno
2928
# what's the current last revision, before we fetch [and change it
2930
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2931
# we fetch here so that we don't process data twice in the common
2932
# case of having something to pull, and so that the check for
2933
# already merged can operate on the just fetched graph, which will
2934
# be cached in memory.
2935
self.target.fetch(self.source, stop_revision)
2936
# Check to see if one is an ancestor of the other
2939
graph = self.target.repository.get_graph()
2940
if self.target._check_if_descendant_or_diverged(
2941
stop_revision, last_rev, graph, self.source):
2942
# stop_revision is a descendant of last_rev, but we aren't
2943
# overwriting, so we're done.
2945
if stop_revno is None:
2947
graph = self.target.repository.get_graph()
2948
this_revno, this_last_revision = \
2949
self.target.last_revision_info()
2950
stop_revno = graph.find_distance_to_null(stop_revision,
2951
[(other_last_revision, other_revno),
2952
(this_last_revision, this_revno)])
2953
self.target.set_last_revision_info(stop_revno, stop_revision)
2955
self.source.unlock()
2957
def pull(self, overwrite=False, stop_revision=None,
2958
possible_transports=None, _hook_master=None, run_hooks=True,
2959
_override_hook_target=None, local=False):
2962
:param _hook_master: Private parameter - set the branch to
2963
be supplied as the master to pull hooks.
2964
:param run_hooks: Private parameter - if false, this branch
2965
is being called because it's the master of the primary branch,
2966
so it should not run its hooks.
2967
:param _override_hook_target: Private parameter - set the branch to be
2968
supplied as the target_branch to pull hooks.
2969
:param local: Only update the local branch, and not the bound branch.
2971
# This type of branch can't be bound.
2973
raise errors.LocalRequiresBoundBranch()
2974
result = PullResult()
2975
result.source_branch = self.source
2976
if _override_hook_target is None:
2977
result.target_branch = self.target
2979
result.target_branch = _override_hook_target
2980
self.source.lock_read()
2982
# We assume that during 'pull' the target repository is closer than
2984
self.source.update_references(self.target)
2985
graph = self.target.repository.get_graph(self.source.repository)
2986
# TODO: Branch formats should have a flag that indicates
2987
# that revno's are expensive, and pull() should honor that flag.
2989
result.old_revno, result.old_revid = \
2990
self.target.last_revision_info()
2991
self.target.update_revisions(self.source, stop_revision,
2992
overwrite=overwrite, graph=graph)
2993
# TODO: The old revid should be specified when merging tags,
2994
# so a tags implementation that versions tags can only
2995
# pull in the most recent changes. -- JRV20090506
2996
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
2998
result.new_revno, result.new_revid = self.target.last_revision_info()
3000
result.master_branch = _hook_master
3001
result.local_branch = result.target_branch
3003
result.master_branch = result.target_branch
3004
result.local_branch = None
3006
for hook in Branch.hooks['post_pull']:
3009
self.source.unlock()
3012
def push(self, overwrite=False, stop_revision=None,
3013
_override_hook_source_branch=None):
3014
"""See InterBranch.push.
3016
This is the basic concrete implementation of push()
3018
:param _override_hook_source_branch: If specified, run
3019
the hooks passing this Branch as the source, rather than self.
3020
This is for use of RemoteBranch, where push is delegated to the
3021
underlying vfs-based Branch.
3023
# TODO: Public option to disable running hooks - should be trivial but
3025
self.source.lock_read()
3027
return _run_with_write_locked_target(
3028
self.target, self._push_with_bound_branches, overwrite,
3030
_override_hook_source_branch=_override_hook_source_branch)
3032
self.source.unlock()
3035
def _push_with_bound_branches(self, overwrite, stop_revision,
3036
_override_hook_source_branch=None):
3037
"""Push from source into target, and into target's master if any.
3040
if _override_hook_source_branch:
3041
result.source_branch = _override_hook_source_branch
3042
for hook in Branch.hooks['post_push']:
3045
bound_location = self.target.get_bound_location()
3046
if bound_location and self.target.base != bound_location:
3047
# there is a master branch.
3049
# XXX: Why the second check? Is it even supported for a branch to
3050
# be bound to itself? -- mbp 20070507
3051
master_branch = self.target.get_master_branch()
3052
master_branch.lock_write()
3054
# push into the master from the source branch.
3055
self.source._basic_push(master_branch, overwrite, stop_revision)
3056
# and push into the target branch from the source. Note that we
3057
# push from the source branch again, because its considered the
3058
# highest bandwidth repository.
3059
result = self.source._basic_push(self.target, overwrite,
3061
result.master_branch = master_branch
3062
result.local_branch = self.target
3066
master_branch.unlock()
3069
result = self.source._basic_push(self.target, overwrite,
3071
# TODO: Why set master_branch and local_branch if there's no
3072
# binding? Maybe cleaner to just leave them unset? -- mbp
3074
result.master_branch = self.target
3075
result.local_branch = None
3080
def is_compatible(self, source, target):
3081
# GenericBranch uses the public API, so always compatible
3085
class InterToBranch5(GenericInterBranch):
3088
def _get_branch_formats_to_test():
3089
return BranchFormat._default_format, BzrBranchFormat5()
3091
def pull(self, overwrite=False, stop_revision=None,
3092
possible_transports=None, run_hooks=True,
3093
_override_hook_target=None, local=False):
3094
"""Pull from source into self, updating my master if any.
3096
:param run_hooks: Private parameter - if false, this branch
3097
is being called because it's the master of the primary branch,
3098
so it should not run its hooks.
3100
bound_location = self.target.get_bound_location()
3101
if local and not bound_location:
3102
raise errors.LocalRequiresBoundBranch()
3103
master_branch = None
3104
if not local and bound_location and self.source.base != bound_location:
3105
# not pulling from master, so we need to update master.
3106
master_branch = self.target.get_master_branch(possible_transports)
3107
master_branch.lock_write()
3110
# pull from source into master.
3111
master_branch.pull(self.source, overwrite, stop_revision,
3113
return super(InterToBranch5, self).pull(overwrite,
3114
stop_revision, _hook_master=master_branch,
3115
run_hooks=run_hooks,
3116
_override_hook_target=_override_hook_target)
3119
master_branch.unlock()
3122
InterBranch.register_optimiser(GenericInterBranch)
3123
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
