13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
18
from cStringIO import StringIO
21
20
from bzrlib.lazy_import import lazy_import
22
21
lazy_import(globals(), """
23
from itertools import chain
22
from copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
24
27
from bzrlib import (
27
30
config as _mod_config,
33
35
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TransportConfig
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
from bzrlib.hooks import HookPoint, Hooks
51
from bzrlib.inter import InterObject
52
from bzrlib.lock import _RelockDebugMixin
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
51
HistoryMissing, InvalidRevisionId,
52
InvalidRevisionNumber, LockError, NoSuchFile,
53
NoSuchRevision, NoWorkingTree, NotVersionedError,
54
NotBranchError, UninitializableFormat,
55
UnlistableStore, UnlistableBranch,
57
from bzrlib.hooks import Hooks
58
from bzrlib.symbol_versioning import (deprecated_function,
62
zero_eight, zero_nine, zero_sixteen,
64
from bzrlib.trace import mutter, note
61
67
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
121
115
if master is not None:
122
116
master.break_lock()
124
def _check_stackable_repo(self):
125
if not self.repository._format.supports_external_lookups:
126
raise errors.UnstackableRepositoryFormat(self.repository._format,
127
self.repository.base)
129
def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
"""Extend the partial history to include a given index
132
If a stop_index is supplied, stop when that index has been reached.
133
If a stop_revision is supplied, stop when that revision is
134
encountered. Otherwise, stop when the beginning of history is
137
:param stop_index: The index which should be present. When it is
138
present, history extension will stop.
139
:param stop_revision: The revision id which should be present. When
140
it is encountered, history extension will stop.
142
if len(self._partial_revision_history_cache) == 0:
143
self._partial_revision_history_cache = [self.last_revision()]
144
repository._iter_for_revno(
145
self.repository, self._partial_revision_history_cache,
146
stop_index=stop_index, stop_revision=stop_revision)
147
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
self._partial_revision_history_cache.pop()
150
def _get_check_refs(self):
151
"""Get the references needed for check().
155
revid = self.last_revision()
156
return [('revision-existence', revid), ('lefthand-distance', revid)]
159
def open(base, _unsupported=False, possible_transports=None):
119
@deprecated_method(zero_eight)
120
def open_downlevel(base):
121
"""Open a branch which may be of an old format."""
122
return Branch.open(base, _unsupported=True)
125
def open(base, _unsupported=False):
160
126
"""Open the branch rooted at base.
162
128
For instance, if the branch is at URL/.bzr/branch,
163
129
Branch.open(URL) -> a Branch instance.
165
control = bzrdir.BzrDir.open(base, _unsupported,
166
possible_transports=possible_transports)
167
return control.open_branch(unsupported=_unsupported)
170
def open_from_transport(transport, name=None, _unsupported=False):
171
"""Open the branch rooted at transport"""
172
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
return control.open_branch(name=name, unsupported=_unsupported)
176
def open_containing(url, possible_transports=None):
131
control = bzrdir.BzrDir.open(base, _unsupported)
132
return control.open_branch(_unsupported)
135
def open_containing(url):
177
136
"""Open an existing branch which contains url.
179
138
This probes for a branch at url, and searches upwards from there.
181
140
Basically we keep looking up until we find the control directory or
182
141
run into the root. If there isn't one, raises NotBranchError.
183
If there is one and it is either an unrecognised format or an unsupported
142
If there is one and it is either an unrecognised format or an unsupported
184
143
format, UnknownFormatError or UnsupportedFormatError are raised.
185
144
If there is one, it is returned, along with the unused portion of url.
187
control, relpath = bzrdir.BzrDir.open_containing(url,
146
control, relpath = bzrdir.BzrDir.open_containing(url)
189
147
return control.open_branch(), relpath
191
def _push_should_merge_tags(self):
192
"""Should _basic_push merge this branch's tags into the target?
194
The default implementation returns False if this branch has no tags,
195
and True the rest of the time. Subclasses may override this.
197
return self.supports_tags() and self.tags.get_tag_dict()
150
@deprecated_function(zero_eight)
151
def initialize(base):
152
"""Create a new working tree and branch, rooted at 'base' (url)
154
NOTE: This will soon be deprecated in favour of creation
157
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
159
@deprecated_function(zero_eight)
160
def setup_caching(self, cache_root):
161
"""Subclasses that care about caching should override this, and set
162
up cached stores located under cache_root.
164
NOTE: This is unused.
199
168
def get_config(self):
200
169
return BranchConfig(self)
202
def _get_config(self):
203
"""Get the concrete config for just the config in this branch.
205
This is not intended for client use; see Branch.get_config for the
210
:return: An object supporting get_option and set_option.
212
raise NotImplementedError(self._get_config)
214
def _get_fallback_repository(self, url):
215
"""Get the repository we fallback to at url."""
216
url = urlutils.join(self.base, url)
217
a_branch = Branch.open(url,
218
possible_transports=[self.bzrdir.root_transport])
219
return a_branch.repository
221
def _get_tags_bytes(self):
222
"""Get the bytes of a serialised tags dict.
224
Note that not all branches support tags, nor do all use the same tags
225
logic: this method is specific to BasicTags. Other tag implementations
226
may use the same method name and behave differently, safely, because
227
of the double-dispatch via
228
format.make_tags->tags_instance->get_tags_dict.
230
:return: The bytes of the tags file.
231
:seealso: Branch._set_tags_bytes.
233
return self._transport.get_bytes('tags')
235
def _get_nick(self, local=False, possible_transports=None):
236
config = self.get_config()
237
# explicit overrides master, but don't look for master if local is True
238
if not local and not config.has_explicit_nickname():
240
master = self.get_master_branch(possible_transports)
241
if master is not None:
242
# return the master branch value
244
except errors.BzrError, e:
245
# Silently fall back to local implicit nick if the master is
247
mutter("Could not connect to bound branch, "
248
"falling back to local nick.\n " + str(e))
249
return config.get_nickname()
172
return self.get_config().get_nickname()
251
174
def _set_nick(self, nick):
252
self.get_config().set_user_option('nickname', nick, warn_masked=True)
175
self.get_config().set_user_option('nickname', nick)
254
177
nick = property(_get_nick, _set_nick)
256
179
def is_locked(self):
257
180
raise NotImplementedError(self.is_locked)
259
def _lefthand_history(self, revision_id, last_rev=None,
261
if 'evil' in debug.debug_flags:
262
mutter_callsite(4, "_lefthand_history scales with history.")
263
# stop_revision must be a descendant of last_revision
264
graph = self.repository.get_graph()
265
if last_rev is not None:
266
if not graph.is_ancestor(last_rev, revision_id):
267
# our previous tip is not merged into stop_revision
268
raise errors.DivergedBranches(self, other_branch)
269
# make a new revision history from the graph
270
parents_map = graph.get_parent_map([revision_id])
271
if revision_id not in parents_map:
272
raise errors.NoSuchRevision(self, revision_id)
273
current_rev_id = revision_id
275
check_not_reserved_id = _mod_revision.check_not_reserved_id
276
# Do not include ghosts or graph origin in revision_history
277
while (current_rev_id in parents_map and
278
len(parents_map[current_rev_id]) > 0):
279
check_not_reserved_id(current_rev_id)
280
new_history.append(current_rev_id)
281
current_rev_id = parents_map[current_rev_id][0]
282
parents_map = graph.get_parent_map([current_rev_id])
283
new_history.reverse()
286
def lock_write(self, token=None):
287
"""Lock the branch for write operations.
289
:param token: A token to permit reacquiring a previously held and
291
:return: A BranchWriteLockResult.
182
def lock_write(self):
293
183
raise NotImplementedError(self.lock_write)
295
185
def lock_read(self):
296
"""Lock the branch for read operations.
298
:return: An object with an unlock method which will release the lock
301
186
raise NotImplementedError(self.lock_read)
303
188
def unlock(self):
310
195
def get_physical_lock_status(self):
311
196
raise NotImplementedError(self.get_physical_lock_status)
314
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
315
"""Return the revision_id for a dotted revno.
317
:param revno: a tuple like (1,) or (1,1,2)
318
:param _cache_reverse: a private parameter enabling storage
319
of the reverse mapping in a top level cache. (This should
320
only be done in selective circumstances as we want to
321
avoid having the mapping cached multiple times.)
322
:return: the revision_id
323
:raises errors.NoSuchRevision: if the revno doesn't exist
325
rev_id = self._do_dotted_revno_to_revision_id(revno)
327
self._partial_revision_id_to_revno_cache[rev_id] = revno
330
def _do_dotted_revno_to_revision_id(self, revno):
331
"""Worker function for dotted_revno_to_revision_id.
333
Subclasses should override this if they wish to
334
provide a more efficient implementation.
337
return self.get_rev_id(revno[0])
338
revision_id_to_revno = self.get_revision_id_to_revno_map()
339
revision_ids = [revision_id for revision_id, this_revno
340
in revision_id_to_revno.iteritems()
341
if revno == this_revno]
342
if len(revision_ids) == 1:
343
return revision_ids[0]
345
revno_str = '.'.join(map(str, revno))
346
raise errors.NoSuchRevision(self, revno_str)
349
def revision_id_to_dotted_revno(self, revision_id):
350
"""Given a revision id, return its dotted revno.
352
:return: a tuple like (1,) or (400,1,3).
354
return self._do_revision_id_to_dotted_revno(revision_id)
356
def _do_revision_id_to_dotted_revno(self, revision_id):
357
"""Worker function for revision_id_to_revno."""
358
# Try the caches if they are loaded
359
result = self._partial_revision_id_to_revno_cache.get(revision_id)
360
if result is not None:
362
if self._revision_id_to_revno_cache:
363
result = self._revision_id_to_revno_cache.get(revision_id)
365
raise errors.NoSuchRevision(self, revision_id)
366
# Try the mainline as it's optimised
368
revno = self.revision_id_to_revno(revision_id)
370
except errors.NoSuchRevision:
371
# We need to load and use the full revno map after all
372
result = self.get_revision_id_to_revno_map().get(revision_id)
374
raise errors.NoSuchRevision(self, revision_id)
378
def get_revision_id_to_revno_map(self):
379
"""Return the revision_id => dotted revno map.
381
This will be regenerated on demand, but will be cached.
383
:return: A dictionary mapping revision_id => dotted revno.
384
This dictionary should not be modified by the caller.
386
if self._revision_id_to_revno_cache is not None:
387
mapping = self._revision_id_to_revno_cache
389
mapping = self._gen_revno_map()
390
self._cache_revision_id_to_revno(mapping)
391
# TODO: jam 20070417 Since this is being cached, should we be returning
393
# I would rather not, and instead just declare that users should not
394
# modify the return value.
397
def _gen_revno_map(self):
398
"""Create a new mapping from revision ids to dotted revnos.
400
Dotted revnos are generated based on the current tip in the revision
402
This is the worker function for get_revision_id_to_revno_map, which
403
just caches the return value.
405
:return: A dictionary mapping revision_id => dotted revno.
407
revision_id_to_revno = dict((rev_id, revno)
408
for rev_id, depth, revno, end_of_merge
409
in self.iter_merge_sorted_revisions())
410
return revision_id_to_revno
413
def iter_merge_sorted_revisions(self, start_revision_id=None,
414
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
415
"""Walk the revisions for a branch in merge sorted order.
417
Merge sorted order is the output from a merge-aware,
418
topological sort, i.e. all parents come before their
419
children going forward; the opposite for reverse.
421
:param start_revision_id: the revision_id to begin walking from.
422
If None, the branch tip is used.
423
:param stop_revision_id: the revision_id to terminate the walk
424
after. If None, the rest of history is included.
425
:param stop_rule: if stop_revision_id is not None, the precise rule
426
to use for termination:
427
* 'exclude' - leave the stop revision out of the result (default)
428
* 'include' - the stop revision is the last item in the result
429
* 'with-merges' - include the stop revision and all of its
430
merged revisions in the result
431
* 'with-merges-without-common-ancestry' - filter out revisions
432
that are in both ancestries
433
:param direction: either 'reverse' or 'forward':
434
* reverse means return the start_revision_id first, i.e.
435
start at the most recent revision and go backwards in history
436
* forward returns tuples in the opposite order to reverse.
437
Note in particular that forward does *not* do any intelligent
438
ordering w.r.t. depth as some clients of this API may like.
439
(If required, that ought to be done at higher layers.)
441
:return: an iterator over (revision_id, depth, revno, end_of_merge)
444
* revision_id: the unique id of the revision
445
* depth: How many levels of merging deep this node has been
447
* revno_sequence: This field provides a sequence of
448
revision numbers for all revisions. The format is:
449
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
450
branch that the revno is on. From left to right the REVNO numbers
451
are the sequence numbers within that branch of the revision.
452
* end_of_merge: When True the next node (earlier in history) is
453
part of a different merge.
455
# Note: depth and revno values are in the context of the branch so
456
# we need the full graph to get stable numbers, regardless of the
458
if self._merge_sorted_revisions_cache is None:
459
last_revision = self.last_revision()
460
known_graph = self.repository.get_known_graph_ancestry(
462
self._merge_sorted_revisions_cache = known_graph.merge_sort(
464
filtered = self._filter_merge_sorted_revisions(
465
self._merge_sorted_revisions_cache, start_revision_id,
466
stop_revision_id, stop_rule)
467
# Make sure we don't return revisions that are not part of the
468
# start_revision_id ancestry.
469
filtered = self._filter_start_non_ancestors(filtered)
470
if direction == 'reverse':
472
if direction == 'forward':
473
return reversed(list(filtered))
475
raise ValueError('invalid direction %r' % direction)
477
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
478
start_revision_id, stop_revision_id, stop_rule):
479
"""Iterate over an inclusive range of sorted revisions."""
480
rev_iter = iter(merge_sorted_revisions)
481
if start_revision_id is not None:
482
for node in rev_iter:
483
rev_id = node.key[-1]
484
if rev_id != start_revision_id:
487
# The decision to include the start or not
488
# depends on the stop_rule if a stop is provided
489
# so pop this node back into the iterator
490
rev_iter = chain(iter([node]), rev_iter)
492
if stop_revision_id is None:
494
for node in rev_iter:
495
rev_id = node.key[-1]
496
yield (rev_id, node.merge_depth, node.revno,
498
elif stop_rule == 'exclude':
499
for node in rev_iter:
500
rev_id = node.key[-1]
501
if rev_id == stop_revision_id:
503
yield (rev_id, node.merge_depth, node.revno,
505
elif stop_rule == 'include':
506
for node in rev_iter:
507
rev_id = node.key[-1]
508
yield (rev_id, node.merge_depth, node.revno,
510
if rev_id == stop_revision_id:
512
elif stop_rule == 'with-merges-without-common-ancestry':
513
# We want to exclude all revisions that are already part of the
514
# stop_revision_id ancestry.
515
graph = self.repository.get_graph()
516
ancestors = graph.find_unique_ancestors(start_revision_id,
518
for node in rev_iter:
519
rev_id = node.key[-1]
520
if rev_id not in ancestors:
522
yield (rev_id, node.merge_depth, node.revno,
524
elif stop_rule == 'with-merges':
525
stop_rev = self.repository.get_revision(stop_revision_id)
526
if stop_rev.parent_ids:
527
left_parent = stop_rev.parent_ids[0]
529
left_parent = _mod_revision.NULL_REVISION
530
# left_parent is the actual revision we want to stop logging at,
531
# since we want to show the merged revisions after the stop_rev too
532
reached_stop_revision_id = False
533
revision_id_whitelist = []
534
for node in rev_iter:
535
rev_id = node.key[-1]
536
if rev_id == left_parent:
537
# reached the left parent after the stop_revision
539
if (not reached_stop_revision_id or
540
rev_id in revision_id_whitelist):
541
yield (rev_id, node.merge_depth, node.revno,
543
if reached_stop_revision_id or rev_id == stop_revision_id:
544
# only do the merged revs of rev_id from now on
545
rev = self.repository.get_revision(rev_id)
547
reached_stop_revision_id = True
548
revision_id_whitelist.extend(rev.parent_ids)
550
raise ValueError('invalid stop_rule %r' % stop_rule)
552
def _filter_start_non_ancestors(self, rev_iter):
553
# If we started from a dotted revno, we want to consider it as a tip
554
# and don't want to yield revisions that are not part of its
555
# ancestry. Given the order guaranteed by the merge sort, we will see
556
# uninteresting descendants of the first parent of our tip before the
558
first = rev_iter.next()
559
(rev_id, merge_depth, revno, end_of_merge) = first
562
# We start at a mainline revision so by definition, all others
563
# revisions in rev_iter are ancestors
564
for node in rev_iter:
569
pmap = self.repository.get_parent_map([rev_id])
570
parents = pmap.get(rev_id, [])
572
whitelist.update(parents)
574
# If there is no parents, there is nothing of interest left
576
# FIXME: It's hard to test this scenario here as this code is never
577
# called in that case. -- vila 20100322
580
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
582
if rev_id in whitelist:
583
pmap = self.repository.get_parent_map([rev_id])
584
parents = pmap.get(rev_id, [])
585
whitelist.remove(rev_id)
586
whitelist.update(parents)
588
# We've reached the mainline, there is nothing left to
592
# A revision that is not part of the ancestry of our
595
yield (rev_id, merge_depth, revno, end_of_merge)
597
198
def leave_lock_in_place(self):
598
199
"""Tell this branch object not to release the physical lock when this
599
200
object is unlocked.
601
202
If lock_write doesn't return a token, then this method is not supported.
603
204
self.control_files.leave_in_place()
709
308
The delta is relative to its mainline predecessor, or the
710
309
empty tree for revision 1.
311
assert isinstance(revno, int)
712
312
rh = self.revision_history()
713
313
if not (1 <= revno <= len(rh)):
714
raise errors.InvalidRevisionNumber(revno)
314
raise InvalidRevisionNumber(revno)
715
315
return self.repository.get_revision_delta(rh[revno-1])
717
def get_stacked_on_url(self):
718
"""Get the URL this branch is stacked against.
317
@deprecated_method(zero_sixteen)
318
def get_root_id(self):
319
"""Return the id of this branches root
720
:raises NotStacked: If the branch is not stacked.
721
:raises UnstackableBranchFormat: If the branch does not support
321
Deprecated: branches don't have root ids-- trees do.
322
Use basis_tree().get_root_id() instead.
724
raise NotImplementedError(self.get_stacked_on_url)
324
raise NotImplementedError(self.get_root_id)
726
326
def print_file(self, file, revision_id):
727
327
"""Print `file` to stdout."""
728
328
raise NotImplementedError(self.print_file)
330
def append_revision(self, *revision_ids):
331
raise NotImplementedError(self.append_revision)
730
333
def set_revision_history(self, rev_history):
731
334
raise NotImplementedError(self.set_revision_history)
734
def set_parent(self, url):
735
"""See Branch.set_parent."""
736
# TODO: Maybe delete old location files?
737
# URLs should never be unicode, even on the local fs,
738
# FIXUP this and get_parent in a future branch format bump:
739
# read and rewrite the file. RBC 20060125
741
if isinstance(url, unicode):
743
url = url.encode('ascii')
744
except UnicodeEncodeError:
745
raise errors.InvalidURL(url,
746
"Urls must be 7-bit ascii, "
747
"use bzrlib.urlutils.escape")
748
url = urlutils.relative_url(self.base, url)
749
self._set_parent_location(url)
752
def set_stacked_on_url(self, url):
753
"""Set the URL this branch is stacked against.
755
:raises UnstackableBranchFormat: If the branch does not support
757
:raises UnstackableRepositoryFormat: If the repository does not support
760
if not self._format.supports_stacking():
761
raise errors.UnstackableBranchFormat(self._format, self.user_url)
762
# XXX: Changing from one fallback repository to another does not check
763
# that all the data you need is present in the new fallback.
764
# Possibly it should.
765
self._check_stackable_repo()
768
old_url = self.get_stacked_on_url()
769
except (errors.NotStacked, errors.UnstackableBranchFormat,
770
errors.UnstackableRepositoryFormat):
774
self._activate_fallback_location(url)
775
# write this out after the repository is stacked to avoid setting a
776
# stacked config that doesn't work.
777
self._set_config_location('stacked_on_location', url)
780
"""Change a branch to be unstacked, copying data as needed.
782
Don't call this directly, use set_stacked_on_url(None).
784
pb = ui.ui_factory.nested_progress_bar()
786
pb.update("Unstacking")
787
# The basic approach here is to fetch the tip of the branch,
788
# including all available ghosts, from the existing stacked
789
# repository into a new repository object without the fallbacks.
791
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
792
# correct for CHKMap repostiories
793
old_repository = self.repository
794
if len(old_repository._fallback_repositories) != 1:
795
raise AssertionError("can't cope with fallback repositories "
796
"of %r" % (self.repository,))
797
# unlock it, including unlocking the fallback
798
old_repository.unlock()
799
old_repository.lock_read()
801
# Repositories don't offer an interface to remove fallback
802
# repositories today; take the conceptually simpler option and just
803
# reopen it. We reopen it starting from the URL so that we
804
# get a separate connection for RemoteRepositories and can
805
# stream from one of them to the other. This does mean doing
806
# separate SSH connection setup, but unstacking is not a
807
# common operation so it's tolerable.
808
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
809
new_repository = new_bzrdir.find_repository()
810
self.repository = new_repository
811
if self.repository._fallback_repositories:
812
raise AssertionError("didn't expect %r to have "
813
"fallback_repositories"
814
% (self.repository,))
815
# this is not paired with an unlock because it's just restoring
816
# the previous state; the lock's released when set_stacked_on_url
818
self.repository.lock_write()
819
# XXX: If you unstack a branch while it has a working tree
820
# with a pending merge, the pending-merged revisions will no
821
# longer be present. You can (probably) revert and remerge.
823
# XXX: This only fetches up to the tip of the repository; it
824
# doesn't bring across any tags. That's fairly consistent
825
# with how branch works, but perhaps not ideal.
826
self.repository.fetch(old_repository,
827
revision_id=self.last_revision(),
830
old_repository.unlock()
834
def _set_tags_bytes(self, bytes):
835
"""Mirror method for _get_tags_bytes.
837
:seealso: Branch._get_tags_bytes.
839
return _run_with_write_locked_target(self, self._transport.put_bytes,
842
336
def _cache_revision_history(self, rev_history):
843
337
"""Set the cached revision history to rev_history.
953
433
common_index = min(self_len, other_len) -1
954
434
if common_index >= 0 and \
955
435
self_history[common_index] != other_history[common_index]:
956
raise errors.DivergedBranches(self, other)
436
raise DivergedBranches(self, other)
958
438
if stop_revision is None:
959
439
stop_revision = other_len
441
assert isinstance(stop_revision, int)
961
442
if stop_revision > other_len:
962
443
raise errors.NoSuchRevision(self, stop_revision)
963
444
return other_history[self_len:stop_revision]
966
def update_revisions(self, other, stop_revision=None, overwrite=False,
446
def update_revisions(self, other, stop_revision=None):
968
447
"""Pull in new perfect-fit revisions.
970
449
:param other: Another Branch to pull from
971
450
:param stop_revision: Updated until the given revision
972
:param overwrite: Always set the branch pointer, rather than checking
973
to see if it is a proper descendant.
974
:param graph: A Graph object that can be used to query history
975
information. This can be None.
978
return InterBranch.get(other, self).update_revisions(stop_revision,
981
def import_last_revision_info(self, source_repo, revno, revid):
982
"""Set the last revision info, importing from another repo if necessary.
984
This is used by the bound branch code to upload a revision to
985
the master branch first before updating the tip of the local branch.
987
:param source_repo: Source repository to optionally fetch from
988
:param revno: Revision number of the new tip
989
:param revid: Revision id of the new tip
991
if not self.repository.has_same_location(source_repo):
992
self.repository.fetch(source_repo, revision_id=revid)
993
self.set_last_revision_info(revno, revid)
453
raise NotImplementedError(self.update_revisions)
995
455
def revision_id_to_revno(self, revision_id):
996
456
"""Given a revision id, return its revno"""
997
if _mod_revision.is_null(revision_id):
457
if revision_id is None:
459
revision_id = osutils.safe_revision_id(revision_id)
999
460
history = self.revision_history()
1001
462
return history.index(revision_id) + 1
1002
463
except ValueError:
1003
raise errors.NoSuchRevision(self, revision_id)
464
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1006
466
def get_rev_id(self, revno, history=None):
1007
467
"""Find the revision id of the specified revno."""
1009
return _mod_revision.NULL_REVISION
1010
last_revno, last_revid = self.last_revision_info()
1011
if revno == last_revno:
1013
if revno <= 0 or revno > last_revno:
1014
raise errors.NoSuchRevision(self, revno)
1015
distance_from_last = last_revno - revno
1016
if len(self._partial_revision_history_cache) <= distance_from_last:
1017
self._extend_partial_history(distance_from_last)
1018
return self._partial_revision_history_cache[distance_from_last]
471
history = self.revision_history()
472
if revno <= 0 or revno > len(history):
473
raise bzrlib.errors.NoSuchRevision(self, revno)
474
return history[revno - 1]
1021
def pull(self, source, overwrite=False, stop_revision=None,
1022
possible_transports=None, *args, **kwargs):
476
def pull(self, source, overwrite=False, stop_revision=None):
1023
477
"""Mirror source into this branch.
1025
479
This branch is considered to be 'local', having low latency.
1027
481
:returns: PullResult instance
1029
return InterBranch.get(source, self).pull(overwrite=overwrite,
1030
stop_revision=stop_revision,
1031
possible_transports=possible_transports, *args, **kwargs)
483
raise NotImplementedError(self.pull)
1033
def push(self, target, overwrite=False, stop_revision=None, *args,
485
def push(self, target, overwrite=False, stop_revision=None):
1035
486
"""Mirror this branch into target.
1037
488
This branch is considered to be 'local', having low latency.
1039
return InterBranch.get(self, target).push(overwrite, stop_revision,
1042
def lossy_push(self, target, stop_revision=None):
1043
"""Push deltas into another branch.
1045
:note: This does not, like push, retain the revision ids from
1046
the source branch and will, rather than adding bzr-specific
1047
metadata, push only those semantics of the revision that can be
1048
natively represented by this branch' VCS.
1050
:param target: Target branch
1051
:param stop_revision: Revision to push, defaults to last revision.
1052
:return: BranchPushResult with an extra member revidmap:
1053
A dictionary mapping revision ids from the target branch
1054
to new revision ids in the target branch, for each
1055
revision that was pushed.
1057
inter = InterBranch.get(self, target)
1058
lossy_push = getattr(inter, "lossy_push", None)
1059
if lossy_push is None:
1060
raise errors.LossyPushToSameVCS(self, target)
1061
return lossy_push(stop_revision)
490
raise NotImplementedError(self.push)
1063
492
def basis_tree(self):
1064
493
"""Return `Tree` object for last revision."""
1065
494
return self.repository.revision_tree(self.last_revision())
496
def rename_one(self, from_rel, to_rel):
499
This can change the directory or the filename or both.
501
raise NotImplementedError(self.rename_one)
503
def move(self, from_paths, to_name):
506
to_name must exist as a versioned directory.
508
If to_name exists and is a directory, the files are moved into
509
it, keeping their old names. If it is a directory,
511
Note that to_name is only the last component of the new name;
512
this doesn't change the directory.
514
This returns a list of (from_path, to_path) pairs for each
517
raise NotImplementedError(self.move)
1067
519
def get_parent(self):
1068
520
"""Return the parent location of the branch.
1070
This is the default location for pull/missing. The usual
522
This is the default location for push/pull/missing. The usual
1071
523
pattern is that the user can override it by specifying a
1074
parent = self._get_parent_location()
1077
# This is an old-format absolute path to a local branch
1078
# turn it into a url
1079
if parent.startswith('/'):
1080
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1082
return urlutils.join(self.base[:-1], parent)
1083
except errors.InvalidURLJoin, e:
1084
raise errors.InaccessibleParent(parent, self.user_url)
1086
def _get_parent_location(self):
1087
raise NotImplementedError(self._get_parent_location)
526
raise NotImplementedError(self.get_parent)
1089
528
def _set_config_location(self, name, url, config=None,
1090
529
make_relative=False):
1191
606
self.check_real_revno(revno)
1193
608
def check_real_revno(self, revno):
1195
610
Check whether a revno corresponds to a real revision.
1196
611
Zero (the NULL revision) is considered invalid
1198
613
if revno < 1 or revno > self.revno():
1199
raise errors.InvalidRevisionNumber(revno)
614
raise InvalidRevisionNumber(revno)
1201
616
@needs_read_lock
1202
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
617
def clone(self, to_bzrdir, revision_id=None):
1203
618
"""Clone this branch into to_bzrdir preserving all semantic values.
1205
Most API users will want 'create_clone_on_transport', which creates a
1206
new bzrdir and branch on the fly.
1208
620
revision_id: if not None, the revision history in the new branch will
1209
621
be truncated to end with revision_id.
1211
result = to_bzrdir.create_branch()
1214
if repository_policy is not None:
1215
repository_policy.configure_branch(result)
1216
self.copy_content_into(result, revision_id=revision_id)
623
result = self._format.initialize(to_bzrdir)
624
self.copy_content_into(result, revision_id=revision_id)
1221
627
@needs_read_lock
1222
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
628
def sprout(self, to_bzrdir, revision_id=None):
1223
629
"""Create a new line of development from the branch, into to_bzrdir.
1225
to_bzrdir controls the branch format.
1227
631
revision_id: if not None, the revision history in the new branch will
1228
632
be truncated to end with revision_id.
1230
if (repository_policy is not None and
1231
repository_policy.requires_stacking()):
1232
to_bzrdir._format.require_stacking(_skip_repo=True)
1233
result = to_bzrdir.create_branch()
1236
if repository_policy is not None:
1237
repository_policy.configure_branch(result)
1238
self.copy_content_into(result, revision_id=revision_id)
1239
result.set_parent(self.bzrdir.root_transport.base)
634
result = self._format.initialize(to_bzrdir)
635
self.copy_content_into(result, revision_id=revision_id)
636
result.set_parent(self.bzrdir.root_transport.base)
1244
639
def _synchronize_history(self, destination, revision_id):
1245
640
"""Synchronize last revision and revision history between branches.
1247
642
This version is most efficient when the destination is also a
1248
BzrBranch6, but works for BzrBranch5, as long as the destination's
1249
repository contains all the lefthand ancestors of the intended
1250
last_revision. If not, set_last_revision_info will fail.
643
BzrBranch5, but works for BzrBranch6 as long as the revision
644
history is the true lefthand parent history, and all of the revisions
645
are in the destination's repository. If not, set_revision_history
1252
648
:param destination: The branch to copy the history into
1253
649
:param revision_id: The revision-id to truncate history at. May
1254
650
be None to copy complete history.
1256
source_revno, source_revision_id = self.last_revision_info()
1257
if revision_id is None:
1258
revno, revision_id = source_revno, source_revision_id
1260
graph = self.repository.get_graph()
652
new_history = self.revision_history()
653
if revision_id is not None:
654
revision_id = osutils.safe_revision_id(revision_id)
1262
revno = graph.find_distance_to_null(revision_id,
1263
[(source_revision_id, source_revno)])
1264
except errors.GhostRevisionsHaveNoRevno:
1265
# Default to 1, if we can't find anything else
1267
destination.set_last_revision_info(revno, revision_id)
656
new_history = new_history[:new_history.index(revision_id) + 1]
658
rev = self.repository.get_revision(revision_id)
659
new_history = rev.get_history(self.repository)[1:]
660
destination.set_revision_history(new_history)
1269
662
@needs_read_lock
1270
663
def copy_content_into(self, destination, revision_id=None):
1284
676
destination.set_parent(parent)
1285
if self._push_should_merge_tags():
1286
self.tags.merge_to(destination.tags)
1288
def update_references(self, target):
1289
if not getattr(self._format, 'supports_reference_locations', False):
1291
reference_dict = self._get_all_reference_info()
1292
if len(reference_dict) == 0:
1294
old_base = self.base
1295
new_base = target.base
1296
target_reference_dict = target._get_all_reference_info()
1297
for file_id, (tree_path, branch_location) in (
1298
reference_dict.items()):
1299
branch_location = urlutils.rebase_url(branch_location,
1301
target_reference_dict.setdefault(
1302
file_id, (tree_path, branch_location))
1303
target._set_all_reference_info(target_reference_dict)
677
self.tags.merge_to(destination.tags)
1305
679
@needs_read_lock
1306
def check(self, refs):
1307
681
"""Check consistency of the branch.
1309
683
In particular this checks that revisions given in the revision-history
1310
do actually match up in the revision graph, and that they're all
684
do actually match up in the revision graph, and that they're all
1311
685
present in the repository.
1313
687
Callers will typically also want to check the repository.
1315
:param refs: Calculated refs for this branch as specified by
1316
branch._get_check_refs()
1317
689
:return: A BranchCheckResult.
1319
result = BranchCheckResult(self)
1320
last_revno, last_revision_id = self.last_revision_info()
1321
actual_revno = refs[('lefthand-distance', last_revision_id)]
1322
if actual_revno != last_revno:
1323
result.errors.append(errors.BzrCheckError(
1324
'revno does not match len(mainline) %s != %s' % (
1325
last_revno, actual_revno)))
1326
# TODO: We should probably also check that self.revision_history
1327
# matches the repository for older branch formats.
1328
# If looking for the code that cross-checks repository parents against
1329
# the iter_reverse_revision_history output, that is now a repository
691
mainline_parent_id = None
692
for revision_id in self.revision_history():
694
revision = self.repository.get_revision(revision_id)
695
except errors.NoSuchRevision, e:
696
raise errors.BzrCheckError("mainline revision {%s} not in repository"
698
# In general the first entry on the revision history has no parents.
699
# But it's not illegal for it to have parents listed; this can happen
700
# in imports from Arch when the parents weren't reachable.
701
if mainline_parent_id is not None:
702
if mainline_parent_id not in revision.parent_ids:
703
raise errors.BzrCheckError("previous revision {%s} not listed among "
705
% (mainline_parent_id, revision_id))
706
mainline_parent_id = revision_id
707
return BranchCheckResult(self)
1333
709
def _get_checkout_format(self):
1334
710
"""Return the most suitable metadir for a checkout of this branch.
1335
711
Weaves are used if this branch's repository uses weaves.
713
from bzrlib.remote import RemoteBzrDir
1337
714
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1338
715
from bzrlib.repofmt import weaverepo
1339
716
format = bzrdir.BzrDirMetaFormat1()
1340
717
format.repository_format = weaverepo.RepositoryFormat7()
718
elif isinstance(self.bzrdir, RemoteBzrDir):
719
format = bzrdir.BzrDirMetaFormat1()
1342
721
format = self.repository.bzrdir.checkout_metadir()
1343
722
format.set_branch_format(self._format)
1346
def create_clone_on_transport(self, to_transport, revision_id=None,
1347
stacked_on=None, create_prefix=False, use_existing_dir=False):
1348
"""Create a clone of this branch and its bzrdir.
1350
:param to_transport: The transport to clone onto.
1351
:param revision_id: The revision id to use as tip in the new branch.
1352
If None the tip is obtained from this branch.
1353
:param stacked_on: An optional URL to stack the clone on.
1354
:param create_prefix: Create any missing directories leading up to
1356
:param use_existing_dir: Use an existing directory if one exists.
1358
# XXX: Fix the bzrdir API to allow getting the branch back from the
1359
# clone call. Or something. 20090224 RBC/spiv.
1360
if revision_id is None:
1361
revision_id = self.last_revision()
1362
dir_to = self.bzrdir.clone_on_transport(to_transport,
1363
revision_id=revision_id, stacked_on=stacked_on,
1364
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1365
return dir_to.open_branch()
1367
725
def create_checkout(self, to_location, revision_id=None,
1368
lightweight=False, accelerator_tree=None,
1370
727
"""Create a checkout of a branch.
1372
729
:param to_location: The url to produce the checkout at
1373
730
:param revision_id: The revision to check out
1374
731
:param lightweight: If True, produce a lightweight checkout, otherwise,
1375
732
produce a bound branch (heavyweight checkout)
1376
:param accelerator_tree: A tree which can be used for retrieving file
1377
contents more quickly than the revision tree, i.e. a workingtree.
1378
The revision tree will be used for cases where accelerator_tree's
1379
content is different.
1380
:param hardlink: If true, hard-link files from accelerator_tree,
1382
733
:return: The tree of the created checkout
1384
735
t = transport.get_transport(to_location)
738
except errors.FileExists:
1387
741
format = self._get_checkout_format()
1388
742
checkout = format.initialize_on_transport(t)
1389
from_branch = BranchReferenceFormat().initialize(checkout,
743
BranchReferenceFormat().initialize(checkout, self)
1392
745
format = self._get_checkout_format()
1393
746
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1394
747
to_location, force_new_tree=False, format=format)
1395
748
checkout = checkout_branch.bzrdir
1396
749
checkout_branch.bind(self)
1397
# pull up to the specified revision_id to set the initial
750
# pull up to the specified revision_id to set the initial
1398
751
# branch tip correctly, and seed it with history.
1399
752
checkout_branch.pull(self, stop_revision=revision_id)
1401
tree = checkout.create_workingtree(revision_id,
1402
from_branch=from_branch,
1403
accelerator_tree=accelerator_tree,
753
tree = checkout.create_workingtree(revision_id)
1405
754
basis_tree = tree.basis_tree()
1406
755
basis_tree.lock_read()
1414
763
basis_tree.unlock()
1418
def reconcile(self, thorough=True):
1419
"""Make sure the data stored in this branch is consistent."""
1420
from bzrlib.reconcile import BranchReconciler
1421
reconciler = BranchReconciler(self, thorough=thorough)
1422
reconciler.reconcile()
1425
def reference_parent(self, file_id, path, possible_transports=None):
766
def reference_parent(self, file_id, path):
1426
767
"""Return the parent branch for a tree-reference file_id
1427
768
:param file_id: The file_id of the tree reference
1428
769
:param path: The path of the file_id in the tree
1429
770
:return: A branch associated with the file_id
1431
772
# FIXME should provide multiple branches, based on config
1432
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1433
possible_transports=possible_transports)
773
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1435
775
def supports_tags(self):
1436
776
return self._format.supports_tags()
1438
def automatic_tag_name(self, revision_id):
1439
"""Try to automatically find the tag name for a revision.
1441
:param revision_id: Revision id of the revision.
1442
:return: A tag name or None if no tag name could be determined.
1444
for hook in Branch.hooks['automatic_tag_name']:
1445
ret = hook(self, revision_id)
1450
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1452
"""Ensure that revision_b is a descendant of revision_a.
1454
This is a helper function for update_revisions.
1456
:raises: DivergedBranches if revision_b has diverged from revision_a.
1457
:returns: True if revision_b is a descendant of revision_a.
1459
relation = self._revision_relations(revision_a, revision_b, graph)
1460
if relation == 'b_descends_from_a':
1462
elif relation == 'diverged':
1463
raise errors.DivergedBranches(self, other_branch)
1464
elif relation == 'a_descends_from_b':
1467
raise AssertionError("invalid relation: %r" % (relation,))
1469
def _revision_relations(self, revision_a, revision_b, graph):
1470
"""Determine the relationship between two revisions.
1472
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1474
heads = graph.heads([revision_a, revision_b])
1475
if heads == set([revision_b]):
1476
return 'b_descends_from_a'
1477
elif heads == set([revision_a, revision_b]):
1478
# These branches have diverged
1480
elif heads == set([revision_a]):
1481
return 'a_descends_from_b'
1483
raise AssertionError("invalid heads: %r" % (heads,))
1486
779
class BranchFormat(object):
1487
780
"""An encapsulation of the initialization and open routines for a format.
1596
859
control_files = lockable_files.LockableFiles(branch_transport,
1597
860
lock_name, lock_class)
1598
861
control_files.create_lock()
1600
control_files.lock_write()
1601
except errors.LockContention:
1602
if lock_type != 'branch4':
862
control_files.lock_write()
1608
utf8_files += [('format', self.get_format_string())]
864
control_files.put_utf8('format', self.get_format_string())
1610
for (filename, content) in utf8_files:
1611
branch_transport.put_bytes(
1613
mode=a_bzrdir._get_file_mode())
866
for file, content in utf8_files:
867
control_files.put_utf8(file, content)
1616
control_files.unlock()
1617
branch = self.open(a_bzrdir, name, _found=True)
1618
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
869
control_files.unlock()
870
return self.open(a_bzrdir, _found=True)
1621
def initialize(self, a_bzrdir, name=None):
1622
"""Create a branch of this format in a_bzrdir.
1624
:param name: Name of the colocated branch to create.
872
def initialize(self, a_bzrdir):
873
"""Create a branch of this format in a_bzrdir."""
1626
874
raise NotImplementedError(self.initialize)
1628
876
def is_supported(self):
1629
877
"""Is this format supported?
1631
879
Supported formats can be initialized and opened.
1632
Unsupported formats may not support initialization or committing or
880
Unsupported formats may not support initialization or committing or
1633
881
some other features depending on the reason for not being supported.
1637
def make_tags(self, branch):
1638
"""Create a tags object for branch.
1640
This method is on BranchFormat, because BranchFormats are reflected
1641
over the wire via network_name(), whereas full Branch instances require
1642
multiple VFS method calls to operate at all.
1644
The default implementation returns a disabled-tags instance.
1646
Note that it is normal for branch to be a RemoteBranch when using tags
1649
return DisabledTags(branch)
1651
def network_name(self):
1652
"""A simple byte string uniquely identifying this format for RPC calls.
1654
MetaDir branch formats use their disk format string to identify the
1655
repository over the wire. All in one formats such as bzr < 0.8, and
1656
foreign formats like svn/git and hg should use some marker which is
1657
unique and immutable.
1659
raise NotImplementedError(self.network_name)
1661
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
885
def open(self, a_bzrdir, _found=False):
1662
886
"""Return the branch object for a_bzrdir
1664
:param a_bzrdir: A BzrDir that contains a branch.
1665
:param name: Name of colocated branch to open
1666
:param _found: a private parameter, do not use it. It is used to
1667
indicate if format probing has already be done.
1668
:param ignore_fallbacks: when set, no fallback branches will be opened
1669
(if there are any). Default is to open fallbacks.
888
_found is a private parameter, do not use it. It is used to indicate
889
if format probing has already be done.
1671
891
raise NotImplementedError(self.open)
1674
894
def register_format(klass, format):
1675
"""Register a metadir format."""
1676
895
klass._formats[format.get_format_string()] = format
1677
# Metadir formats have a network name of their format string, and get
1678
# registered as class factories.
1679
network_format_registry.register(format.get_format_string(), format.__class__)
1682
898
def set_default_format(klass, format):
1683
899
klass._default_format = format
1685
def supports_set_append_revisions_only(self):
1686
"""True if this format supports set_append_revisions_only."""
1689
def supports_stacking(self):
1690
"""True if this format records a stacked-on branch."""
1694
902
def unregister_format(klass, format):
903
assert klass._formats[format.get_format_string()] is format
1695
904
del klass._formats[format.get_format_string()]
1697
906
def __str__(self):
1698
return self.get_format_description().rstrip()
907
return self.get_format_string().rstrip()
1700
909
def supports_tags(self):
1701
910
"""True if this format supports tags stored in the branch"""
1702
911
return False # by default
913
# XXX: Probably doesn't really belong here -- mbp 20070212
914
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
916
branch_transport = a_bzrdir.get_branch_transport(self)
917
control_files = lockable_files.LockableFiles(branch_transport,
918
lock_filename, lock_class)
919
control_files.create_lock()
920
control_files.lock_write()
922
for filename, content in utf8_files:
923
control_files.put_utf8(filename, content)
925
control_files.unlock()
1705
928
class BranchHooks(Hooks):
1706
929
"""A dictionary mapping hook name to a list of callables for branch hooks.
1708
931
e.g. ['set_rh'] Is the list of items to be called when the
1709
932
set_revision_history function is invoked.
1718
941
Hooks.__init__(self)
1719
self.create_hook(HookPoint('set_rh',
1720
"Invoked whenever the revision history has been set via "
1721
"set_revision_history. The api signature is (branch, "
1722
"revision_history), and the branch will be write-locked. "
1723
"The set_rh hook can be expensive for bzr to trigger, a better "
1724
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1725
self.create_hook(HookPoint('open',
1726
"Called with the Branch object that has been opened after a "
1727
"branch is opened.", (1, 8), None))
1728
self.create_hook(HookPoint('post_push',
1729
"Called after a push operation completes. post_push is called "
1730
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1731
"bzr client.", (0, 15), None))
1732
self.create_hook(HookPoint('post_pull',
1733
"Called after a pull operation completes. post_pull is called "
1734
"with a bzrlib.branch.PullResult object and only runs in the "
1735
"bzr client.", (0, 15), None))
1736
self.create_hook(HookPoint('pre_commit',
1737
"Called after a commit is calculated but before it is is "
1738
"completed. pre_commit is called with (local, master, old_revno, "
1739
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1740
"). old_revid is NULL_REVISION for the first commit to a branch, "
1741
"tree_delta is a TreeDelta object describing changes from the "
1742
"basis revision. hooks MUST NOT modify this delta. "
1743
" future_tree is an in-memory tree obtained from "
1744
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1745
"tree.", (0,91), None))
1746
self.create_hook(HookPoint('post_commit',
1747
"Called in the bzr client after a commit has completed. "
1748
"post_commit is called with (local, master, old_revno, old_revid, "
1749
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1750
"commit to a branch.", (0, 15), None))
1751
self.create_hook(HookPoint('post_uncommit',
1752
"Called in the bzr client after an uncommit completes. "
1753
"post_uncommit is called with (local, master, old_revno, "
1754
"old_revid, new_revno, new_revid) where local is the local branch "
1755
"or None, master is the target branch, and an empty branch "
1756
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1757
self.create_hook(HookPoint('pre_change_branch_tip',
1758
"Called in bzr client and server before a change to the tip of a "
1759
"branch is made. pre_change_branch_tip is called with a "
1760
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1761
"commit, uncommit will all trigger this hook.", (1, 6), None))
1762
self.create_hook(HookPoint('post_change_branch_tip',
1763
"Called in bzr client and server after a change to the tip of a "
1764
"branch is made. post_change_branch_tip is called with a "
1765
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1766
"commit, uncommit will all trigger this hook.", (1, 4), None))
1767
self.create_hook(HookPoint('transform_fallback_location',
1768
"Called when a stacked branch is activating its fallback "
1769
"locations. transform_fallback_location is called with (branch, "
1770
"url), and should return a new url. Returning the same url "
1771
"allows it to be used as-is, returning a different one can be "
1772
"used to cause the branch to stack on a closer copy of that "
1773
"fallback_location. Note that the branch cannot have history "
1774
"accessing methods called on it during this hook because the "
1775
"fallback locations have not been activated. When there are "
1776
"multiple hooks installed for transform_fallback_location, "
1777
"all are called with the url returned from the previous hook."
1778
"The order is however undefined.", (1, 9), None))
1779
self.create_hook(HookPoint('automatic_tag_name',
1780
"Called to determine an automatic tag name for a revision."
1781
"automatic_tag_name is called with (branch, revision_id) and "
1782
"should return a tag name or None if no tag name could be "
1783
"determined. The first non-None tag name returned will be used.",
1785
self.create_hook(HookPoint('post_branch_init',
1786
"Called after new branch initialization completes. "
1787
"post_branch_init is called with a "
1788
"bzrlib.branch.BranchInitHookParams. "
1789
"Note that init, branch and checkout (both heavyweight and "
1790
"lightweight) will all trigger this hook.", (2, 2), None))
1791
self.create_hook(HookPoint('post_switch',
1792
"Called after a checkout switches branch. "
1793
"post_switch is called with a "
1794
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
942
# Introduced in 0.15:
943
# invoked whenever the revision history has been set
944
# with set_revision_history. The api signature is
945
# (branch, revision_history), and the branch will
948
# invoked after a push operation completes.
949
# the api signature is
951
# containing the members
952
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
953
# where local is the local branch or None, master is the target
954
# master branch, and the rest should be self explanatory. The source
955
# is read locked and the target branches write locked. Source will
956
# be the local low-latency branch.
957
self['post_push'] = []
958
# invoked after a pull operation completes.
959
# the api signature is
961
# containing the members
962
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
963
# where local is the local branch or None, master is the target
964
# master branch, and the rest should be self explanatory. The source
965
# is read locked and the target branches write locked. The local
966
# branch is the low-latency branch.
967
self['post_pull'] = []
968
# invoked after a commit operation completes.
969
# the api signature is
970
# (local, master, old_revno, old_revid, new_revno, new_revid)
971
# old_revid is NULL_REVISION for the first commit to a branch.
972
self['post_commit'] = []
973
# invoked after a uncommit operation completes.
974
# the api signature is
975
# (local, master, old_revno, old_revid, new_revno, new_revid) where
976
# local is the local branch or None, master is the target branch,
977
# and an empty branch recieves new_revno of 0, new_revid of None.
978
self['post_uncommit'] = []
1798
981
# install the default hooks into the Branch class.
1799
982
Branch.hooks = BranchHooks()
1802
class ChangeBranchTipParams(object):
1803
"""Object holding parameters passed to *_change_branch_tip hooks.
1805
There are 5 fields that hooks may wish to access:
1807
:ivar branch: the branch being changed
1808
:ivar old_revno: revision number before the change
1809
:ivar new_revno: revision number after the change
1810
:ivar old_revid: revision id before the change
1811
:ivar new_revid: revision id after the change
1813
The revid fields are strings. The revno fields are integers.
1816
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1817
"""Create a group of ChangeBranchTip parameters.
1819
:param branch: The branch being changed.
1820
:param old_revno: Revision number before the change.
1821
:param new_revno: Revision number after the change.
1822
:param old_revid: Tip revision id before the change.
1823
:param new_revid: Tip revision id after the change.
1825
self.branch = branch
1826
self.old_revno = old_revno
1827
self.new_revno = new_revno
1828
self.old_revid = old_revid
1829
self.new_revid = new_revid
1831
def __eq__(self, other):
1832
return self.__dict__ == other.__dict__
1835
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1836
self.__class__.__name__, self.branch,
1837
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1840
class BranchInitHookParams(object):
1841
"""Object holding parameters passed to *_branch_init hooks.
1843
There are 4 fields that hooks may wish to access:
1845
:ivar format: the branch format
1846
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1847
:ivar name: name of colocated branch, if any (or None)
1848
:ivar branch: the branch created
1850
Note that for lightweight checkouts, the bzrdir and format fields refer to
1851
the checkout, hence they are different from the corresponding fields in
1852
branch, which refer to the original branch.
1855
def __init__(self, format, a_bzrdir, name, branch):
1856
"""Create a group of BranchInitHook parameters.
1858
:param format: the branch format
1859
:param a_bzrdir: the BzrDir where the branch will be/has been
1861
:param name: name of colocated branch, if any (or None)
1862
:param branch: the branch created
1864
Note that for lightweight checkouts, the bzrdir and format fields refer
1865
to the checkout, hence they are different from the corresponding fields
1866
in branch, which refer to the original branch.
1868
self.format = format
1869
self.bzrdir = a_bzrdir
1871
self.branch = branch
1873
def __eq__(self, other):
1874
return self.__dict__ == other.__dict__
1878
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1880
return "<%s of format:%s bzrdir:%s>" % (
1881
self.__class__.__name__, self.branch,
1882
self.format, self.bzrdir)
1885
class SwitchHookParams(object):
1886
"""Object holding parameters passed to *_switch hooks.
1888
There are 4 fields that hooks may wish to access:
1890
:ivar control_dir: BzrDir of the checkout to change
1891
:ivar to_branch: branch that the checkout is to reference
1892
:ivar force: skip the check for local commits in a heavy checkout
1893
:ivar revision_id: revision ID to switch to (or None)
1896
def __init__(self, control_dir, to_branch, force, revision_id):
1897
"""Create a group of SwitchHook parameters.
1899
:param control_dir: BzrDir of the checkout to change
1900
:param to_branch: branch that the checkout is to reference
1901
:param force: skip the check for local commits in a heavy checkout
1902
:param revision_id: revision ID to switch to (or None)
1904
self.control_dir = control_dir
1905
self.to_branch = to_branch
1907
self.revision_id = revision_id
1909
def __eq__(self, other):
1910
return self.__dict__ == other.__dict__
1913
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1914
self.control_dir, self.to_branch,
1918
985
class BzrBranchFormat4(BranchFormat):
1919
986
"""Bzr branch format 4.
1927
994
"""See BranchFormat.get_format_description()."""
1928
995
return "Branch format 4"
1930
def initialize(self, a_bzrdir, name=None):
997
def initialize(self, a_bzrdir):
1931
998
"""Create a branch of this format in a_bzrdir."""
1932
999
utf8_files = [('revision-history', ''),
1933
1000
('branch-name', ''),
1935
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1002
return self._initialize_helper(a_bzrdir, utf8_files,
1936
1003
lock_type='branch4', set_format=False)
1938
1005
def __init__(self):
1939
1006
super(BzrBranchFormat4, self).__init__()
1940
1007
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1942
def network_name(self):
1943
"""The network name for this format is the control dirs disk label."""
1944
return self._matchingbzrdir.get_format_string()
1009
def open(self, a_bzrdir, _found=False):
1010
"""Return the branch object for a_bzrdir
1946
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1947
"""See BranchFormat.open()."""
1012
_found is a private parameter, do not use it. It is used to indicate
1013
if format probing has already be done.
1949
1016
# we are being called directly and must probe.
1950
1017
raise NotImplementedError
1951
1018
return BzrBranch(_format=self,
1952
1019
_control_files=a_bzrdir._control_files,
1953
1020
a_bzrdir=a_bzrdir,
1955
1021
_repository=a_bzrdir.open_repository())
1957
1023
def __str__(self):
1958
1024
return "Bazaar-NG branch format 4"
1961
class BranchFormatMetadir(BranchFormat):
1962
"""Common logic for meta-dir based branch formats."""
1964
def _branch_class(self):
1965
"""What class to instantiate on open calls."""
1966
raise NotImplementedError(self._branch_class)
1968
def network_name(self):
1969
"""A simple byte string uniquely identifying this format for RPC calls.
1971
Metadir branch formats use their format string.
1027
class BzrBranchFormat5(BranchFormat):
1028
"""Bzr branch format 5.
1031
- a revision-history file.
1033
- a lock dir guarding the branch itself
1034
- all of this stored in a branch/ subdirectory
1035
- works with shared repositories.
1037
This format is new in bzr 0.8.
1040
def get_format_string(self):
1041
"""See BranchFormat.get_format_string()."""
1042
return "Bazaar-NG branch format 5\n"
1044
def get_format_description(self):
1045
"""See BranchFormat.get_format_description()."""
1046
return "Branch format 5"
1048
def initialize(self, a_bzrdir):
1049
"""Create a branch of this format in a_bzrdir."""
1050
utf8_files = [('revision-history', ''),
1051
('branch-name', ''),
1053
return self._initialize_helper(a_bzrdir, utf8_files)
1056
super(BzrBranchFormat5, self).__init__()
1057
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1059
def open(self, a_bzrdir, _found=False):
1060
"""Return the branch object for a_bzrdir
1062
_found is a private parameter, do not use it. It is used to indicate
1063
if format probing has already be done.
1973
return self.get_format_string()
1975
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1976
"""See BranchFormat.open()."""
1978
format = BranchFormat.find_format(a_bzrdir, name=name)
1979
if format.__class__ != self.__class__:
1980
raise AssertionError("wrong format %r found for %r" %
1982
transport = a_bzrdir.get_branch_transport(None, name=name)
1066
format = BranchFormat.find_format(a_bzrdir)
1067
assert format.__class__ == self.__class__
1069
transport = a_bzrdir.get_branch_transport(None)
1984
1070
control_files = lockable_files.LockableFiles(transport, 'lock',
1985
1071
lockdir.LockDir)
1986
return self._branch_class()(_format=self,
1072
return BzrBranch5(_format=self,
1987
1073
_control_files=control_files,
1989
1074
a_bzrdir=a_bzrdir,
1990
_repository=a_bzrdir.find_repository(),
1991
ignore_fallbacks=ignore_fallbacks)
1992
except errors.NoSuchFile:
1993
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1996
super(BranchFormatMetadir, self).__init__()
1997
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1998
self._matchingbzrdir.set_branch_format(self)
2000
def supports_tags(self):
2004
class BzrBranchFormat5(BranchFormatMetadir):
2005
"""Bzr branch format 5.
2008
- a revision-history file.
2010
- a lock dir guarding the branch itself
2011
- all of this stored in a branch/ subdirectory
2012
- works with shared repositories.
2014
This format is new in bzr 0.8.
2017
def _branch_class(self):
2020
def get_format_string(self):
2021
"""See BranchFormat.get_format_string()."""
2022
return "Bazaar-NG branch format 5\n"
2024
def get_format_description(self):
2025
"""See BranchFormat.get_format_description()."""
2026
return "Branch format 5"
2028
def initialize(self, a_bzrdir, name=None):
2029
"""Create a branch of this format in a_bzrdir."""
2030
utf8_files = [('revision-history', ''),
2031
('branch-name', ''),
2033
return self._initialize_helper(a_bzrdir, utf8_files, name)
2035
def supports_tags(self):
2039
class BzrBranchFormat6(BranchFormatMetadir):
2040
"""Branch format with last-revision and tags.
1075
_repository=a_bzrdir.find_repository())
1077
raise NotBranchError(path=transport.base)
1080
class BzrBranchFormat6(BzrBranchFormat5):
1081
"""Branch format with last-revision
2042
1083
Unlike previous formats, this has no explicit revision history. Instead,
2043
1084
this just stores the last-revision, and the left-hand history leading
2044
1085
up to there is the history.
2046
1087
This format was introduced in bzr 0.15
2047
and became the default in 0.91.
2050
def _branch_class(self):
2053
1090
def get_format_string(self):
2054
1091
"""See BranchFormat.get_format_string()."""
2055
1092
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2058
1095
"""See BranchFormat.get_format_description()."""
2059
1096
return "Branch format 6"
2061
def initialize(self, a_bzrdir, name=None):
2062
"""Create a branch of this format in a_bzrdir."""
2063
utf8_files = [('last-revision', '0 null:\n'),
2064
('branch.conf', ''),
2067
return self._initialize_helper(a_bzrdir, utf8_files, name)
2069
def make_tags(self, branch):
2070
"""See bzrlib.branch.BranchFormat.make_tags()."""
2071
return BasicTags(branch)
2073
def supports_set_append_revisions_only(self):
2077
class BzrBranchFormat8(BranchFormatMetadir):
2078
"""Metadir format supporting storing locations of subtree branches."""
2080
def _branch_class(self):
2083
def get_format_string(self):
2084
"""See BranchFormat.get_format_string()."""
2085
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2087
def get_format_description(self):
2088
"""See BranchFormat.get_format_description()."""
2089
return "Branch format 8"
2091
def initialize(self, a_bzrdir, name=None):
2092
"""Create a branch of this format in a_bzrdir."""
2093
utf8_files = [('last-revision', '0 null:\n'),
2094
('branch.conf', ''),
2098
return self._initialize_helper(a_bzrdir, utf8_files, name)
2101
super(BzrBranchFormat8, self).__init__()
2102
self._matchingbzrdir.repository_format = \
2103
RepositoryFormatKnitPack5RichRoot()
2105
def make_tags(self, branch):
2106
"""See bzrlib.branch.BranchFormat.make_tags()."""
2107
return BasicTags(branch)
2109
def supports_set_append_revisions_only(self):
2112
def supports_stacking(self):
2115
supports_reference_locations = True
2118
class BzrBranchFormat7(BzrBranchFormat8):
2119
"""Branch format with last-revision, tags, and a stacked location pointer.
2121
The stacked location pointer is passed down to the repository and requires
2122
a repository format with supports_external_lookups = True.
2124
This format was introduced in bzr 1.6.
2127
def initialize(self, a_bzrdir, name=None):
2128
"""Create a branch of this format in a_bzrdir."""
2129
utf8_files = [('last-revision', '0 null:\n'),
2130
('branch.conf', ''),
2133
return self._initialize_helper(a_bzrdir, utf8_files, name)
2135
def _branch_class(self):
2138
def get_format_string(self):
2139
"""See BranchFormat.get_format_string()."""
2140
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2142
def get_format_description(self):
2143
"""See BranchFormat.get_format_description()."""
2144
return "Branch format 7"
2146
def supports_set_append_revisions_only(self):
2149
supports_reference_locations = False
1098
def initialize(self, a_bzrdir):
1099
"""Create a branch of this format in a_bzrdir."""
1100
utf8_files = [('last-revision', '0 null:\n'),
1101
('branch-name', ''),
1102
('branch.conf', ''),
1105
return self._initialize_helper(a_bzrdir, utf8_files)
1107
def open(self, a_bzrdir, _found=False):
1108
"""Return the branch object for a_bzrdir
1110
_found is a private parameter, do not use it. It is used to indicate
1111
if format probing has already be done.
1114
format = BranchFormat.find_format(a_bzrdir)
1115
assert format.__class__ == self.__class__
1116
transport = a_bzrdir.get_branch_transport(None)
1117
control_files = lockable_files.LockableFiles(transport, 'lock',
1119
return BzrBranch6(_format=self,
1120
_control_files=control_files,
1122
_repository=a_bzrdir.find_repository())
1124
def supports_tags(self):
2152
1128
class BranchReferenceFormat(BranchFormat):
2167
1143
def get_format_description(self):
2168
1144
"""See BranchFormat.get_format_description()."""
2169
1145
return "Checkout reference format 1"
2171
1147
def get_reference(self, a_bzrdir):
2172
1148
"""See BranchFormat.get_reference()."""
2173
1149
transport = a_bzrdir.get_branch_transport(None)
2174
return transport.get_bytes('location')
2176
def set_reference(self, a_bzrdir, to_branch):
2177
"""See BranchFormat.set_reference()."""
2178
transport = a_bzrdir.get_branch_transport(None)
2179
location = transport.put_bytes('location', to_branch.base)
2181
def initialize(self, a_bzrdir, name=None, target_branch=None):
1150
return transport.get('location').read()
1152
def initialize(self, a_bzrdir, target_branch=None):
2182
1153
"""Create a branch of this format in a_bzrdir."""
2183
1154
if target_branch is None:
2184
1155
# this format does not implement branch itself, thus the implicit
2185
1156
# creation contract must see it as uninitializable
2186
1157
raise errors.UninitializableFormat(self)
2187
mutter('creating branch reference in %s', a_bzrdir.user_url)
2188
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1158
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1159
branch_transport = a_bzrdir.get_branch_transport(self)
2189
1160
branch_transport.put_bytes('location',
2190
target_branch.bzrdir.user_url)
1161
target_branch.bzrdir.root_transport.base)
2191
1162
branch_transport.put_bytes('format', self.get_format_string())
2193
a_bzrdir, name, _found=True,
2194
possible_transports=[target_branch.bzrdir.root_transport])
2195
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1163
return self.open(a_bzrdir, _found=True)
2198
1165
def __init__(self):
2199
1166
super(BranchReferenceFormat, self).__init__()
2200
1167
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2201
self._matchingbzrdir.set_branch_format(self)
2203
1169
def _make_reference_clone_function(format, a_branch):
2204
1170
"""Create a clone() routine for a branch dynamically."""
2205
def clone(to_bzrdir, revision_id=None,
2206
repository_policy=None):
1171
def clone(to_bzrdir, revision_id=None):
2207
1172
"""See Branch.clone()."""
2208
return format.initialize(to_bzrdir, target_branch=a_branch)
1173
return format.initialize(to_bzrdir, a_branch)
2209
1174
# cannot obey revision_id limits when cloning a reference ...
2210
1175
# FIXME RBC 20060210 either nuke revision_id for clone, or
2211
1176
# emit some sort of warning/error to the caller ?!
2214
def open(self, a_bzrdir, name=None, _found=False, location=None,
2215
possible_transports=None, ignore_fallbacks=False):
1179
def open(self, a_bzrdir, _found=False, location=None):
2216
1180
"""Return the branch that the branch reference in a_bzrdir points at.
2218
:param a_bzrdir: A BzrDir that contains a branch.
2219
:param name: Name of colocated branch to open, if any
2220
:param _found: a private parameter, do not use it. It is used to
2221
indicate if format probing has already be done.
2222
:param ignore_fallbacks: when set, no fallback branches will be opened
2223
(if there are any). Default is to open fallbacks.
2224
:param location: The location of the referenced branch. If
2225
unspecified, this will be determined from the branch reference in
2227
:param possible_transports: An optional reusable transports list.
1182
_found is a private parameter, do not use it. It is used to indicate
1183
if format probing has already be done.
2230
format = BranchFormat.find_format(a_bzrdir, name=name)
2231
if format.__class__ != self.__class__:
2232
raise AssertionError("wrong format %r found for %r" %
1186
format = BranchFormat.find_format(a_bzrdir)
1187
assert format.__class__ == self.__class__
2234
1188
if location is None:
2235
1189
location = self.get_reference(a_bzrdir)
2236
real_bzrdir = bzrdir.BzrDir.open(
2237
location, possible_transports=possible_transports)
2238
result = real_bzrdir.open_branch(name=name,
2239
ignore_fallbacks=ignore_fallbacks)
1190
real_bzrdir = bzrdir.BzrDir.open(location)
1191
result = real_bzrdir.open_branch()
2240
1192
# this changes the behaviour of result.clone to create a new reference
2241
1193
# rather than a copy of the content of the branch.
2242
1194
# I did not use a proxy object because that needs much more extensive
2252
network_format_registry = registry.FormatRegistry()
2253
"""Registry of formats indexed by their network name.
2255
The network name for a branch format is an identifier that can be used when
2256
referring to formats with smart server operations. See
2257
BranchFormat.network_name() for more detail.
2261
1204
# formats which have no format string are not discoverable
2262
1205
# and not independently creatable, so are not registered.
2263
__format5 = BzrBranchFormat5()
2264
__format6 = BzrBranchFormat6()
2265
__format7 = BzrBranchFormat7()
2266
__format8 = BzrBranchFormat8()
2267
BranchFormat.register_format(__format5)
1206
__default_format = BzrBranchFormat5()
1207
BranchFormat.register_format(__default_format)
2268
1208
BranchFormat.register_format(BranchReferenceFormat())
2269
BranchFormat.register_format(__format6)
2270
BranchFormat.register_format(__format7)
2271
BranchFormat.register_format(__format8)
2272
BranchFormat.set_default_format(__format7)
1209
BranchFormat.register_format(BzrBranchFormat6())
1210
BranchFormat.set_default_format(__default_format)
2273
1211
_legacy_formats = [BzrBranchFormat4(),
2275
network_format_registry.register(
2276
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2279
class BranchWriteLockResult(object):
2280
"""The result of write locking a branch.
2282
:ivar branch_token: The token obtained from the underlying branch lock, or
2284
:ivar unlock: A callable which will unlock the lock.
2287
def __init__(self, unlock, branch_token):
2288
self.branch_token = branch_token
2289
self.unlock = unlock
2292
class BzrBranch(Branch, _RelockDebugMixin):
1214
class BzrBranch(Branch):
2293
1215
"""A branch stored in the actual filesystem.
2295
1217
Note that it's "local" in the context of the filesystem; it doesn't
2296
1218
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2297
1219
it's writable, and can be accessed via the normal filesystem API.
2299
:ivar _transport: Transport for file operations on this branch's
2300
control files, typically pointing to the .bzr/branch directory.
2301
:ivar repository: Repository for this branch.
2302
:ivar base: The url of the base directory for this branch; the one
2303
containing the .bzr directory.
2304
:ivar name: Optional colocated branch name as it exists in the control
2308
1222
def __init__(self, _format=None,
2309
_control_files=None, a_bzrdir=None, name=None,
2310
_repository=None, ignore_fallbacks=False):
1223
_control_files=None, a_bzrdir=None, _repository=None):
2311
1224
"""Create new branch object at a particular location."""
1225
Branch.__init__(self)
2312
1226
if a_bzrdir is None:
2313
1227
raise ValueError('a_bzrdir must be supplied')
2315
1229
self.bzrdir = a_bzrdir
1230
# self._transport used to point to the directory containing the
1231
# control directory, but was not used - now it's just the transport
1232
# for the branch control files. mbp 20070212
2316
1233
self._base = self.bzrdir.transport.clone('..').base
2318
# XXX: We should be able to just do
2319
# self.base = self.bzrdir.root_transport.base
2320
# but this does not quite work yet -- mbp 20080522
2321
1234
self._format = _format
2322
1235
if _control_files is None:
2323
1236
raise ValueError('BzrBranch _control_files is None')
2324
1237
self.control_files = _control_files
2325
1238
self._transport = _control_files._transport
2326
1239
self.repository = _repository
2327
Branch.__init__(self)
2329
1241
def __str__(self):
2330
if self.name is None:
2331
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2333
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
1242
return '%s(%r)' % (self.__class__.__name__, self.base)
2336
1244
__repr__ = __str__
2342
1250
base = property(_get_base, doc="The URL for the root of this branch.")
2344
def _get_config(self):
2345
return TransportConfig(self._transport, 'branch.conf')
1252
def abspath(self, name):
1253
"""See Branch.abspath."""
1254
return self.control_files._transport.abspath(name)
1257
@deprecated_method(zero_sixteen)
1259
def get_root_id(self):
1260
"""See Branch.get_root_id."""
1261
tree = self.repository.revision_tree(self.last_revision())
1262
return tree.inventory.root.file_id
2347
1264
def is_locked(self):
2348
1265
return self.control_files.is_locked()
2350
def lock_write(self, token=None):
2351
"""Lock the branch for write operations.
2353
:param token: A token to permit reacquiring a previously held and
2355
:return: A BranchWriteLockResult.
2357
if not self.is_locked():
2358
self._note_lock('w')
2359
# All-in-one needs to always unlock/lock.
2360
repo_control = getattr(self.repository, 'control_files', None)
2361
if self.control_files == repo_control or not self.is_locked():
2362
self.repository._warn_if_deprecated(self)
2363
self.repository.lock_write()
1267
def lock_write(self, tokens=None):
1268
if tokens is not None:
1269
branch_token, repo_token = tokens
1271
branch_token = repo_token = None
1272
repo_token = self.repository.lock_write(token=repo_token)
2368
return BranchWriteLockResult(self.unlock,
2369
self.control_files.lock_write(token=token))
1274
branch_token = self.control_files.lock_write(token=branch_token)
2372
self.repository.unlock()
1276
self.repository.unlock()
1279
tokens = (branch_token, repo_token)
1280
assert tokens == (None, None) or None not in tokens, (
1281
'Both branch and repository locks must return tokens, or else '
1282
'neither must return tokens. Got %r.' % (tokens,))
1283
if tokens == (None, None):
2375
1288
def lock_read(self):
2376
"""Lock the branch for read operations.
2378
:return: An object with an unlock method which will release the lock
2381
if not self.is_locked():
2382
self._note_lock('r')
2383
# All-in-one needs to always unlock/lock.
2384
repo_control = getattr(self.repository, 'control_files', None)
2385
if self.control_files == repo_control or not self.is_locked():
2386
self.repository._warn_if_deprecated(self)
2387
self.repository.lock_read()
1289
self.repository.lock_read()
2392
1291
self.control_files.lock_read()
2396
self.repository.unlock()
1293
self.repository.unlock()
2399
@only_raises(errors.LockNotHeld, errors.LockBroken)
2400
1296
def unlock(self):
1297
# TODO: test for failed two phase locks. This is known broken.
2402
1299
self.control_files.unlock()
2404
# All-in-one needs to always unlock/lock.
2405
repo_control = getattr(self.repository, 'control_files', None)
2406
if (self.control_files == repo_control or
2407
not self.control_files.is_locked()):
2408
self.repository.unlock()
2409
if not self.control_files.is_locked():
2410
# we just released the lock
2411
self._clear_cached_state()
1301
self.repository.unlock()
1302
if not self.control_files.is_locked():
1303
# we just released the lock
1304
self._clear_cached_state()
2413
1306
def peek_lock_mode(self):
2414
1307
if self.control_files._lock_count == 0:
2424
1317
"""See Branch.print_file."""
2425
1318
return self.repository.print_file(file, revision_id)
1321
def append_revision(self, *revision_ids):
1322
"""See Branch.append_revision."""
1323
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1324
for revision_id in revision_ids:
1325
_mod_revision.check_not_reserved_id(revision_id)
1326
mutter("add {%s} to revision-history" % revision_id)
1327
rev_history = self.revision_history()
1328
rev_history.extend(revision_ids)
1329
self.set_revision_history(rev_history)
2427
1331
def _write_revision_history(self, history):
2428
1332
"""Factored out of set_revision_history.
2430
1334
This performs the actual writing to disk.
2431
1335
It is intended to be called by BzrBranch5.set_revision_history."""
2432
self._transport.put_bytes(
2433
'revision-history', '\n'.join(history),
2434
mode=self.bzrdir._get_file_mode())
1336
self.control_files.put_bytes(
1337
'revision-history', '\n'.join(history))
2436
1339
@needs_write_lock
2437
1340
def set_revision_history(self, rev_history):
2438
1341
"""See Branch.set_revision_history."""
2439
if 'evil' in debug.debug_flags:
2440
mutter_callsite(3, "set_revision_history scales with history.")
2441
check_not_reserved_id = _mod_revision.check_not_reserved_id
2442
for rev_id in rev_history:
2443
check_not_reserved_id(rev_id)
2444
if Branch.hooks['post_change_branch_tip']:
2445
# Don't calculate the last_revision_info() if there are no hooks
2447
old_revno, old_revid = self.last_revision_info()
2448
if len(rev_history) == 0:
2449
revid = _mod_revision.NULL_REVISION
2451
revid = rev_history[-1]
2452
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1342
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
2453
1343
self._write_revision_history(rev_history)
2454
self._clear_cached_state()
2455
1344
self._cache_revision_history(rev_history)
2456
1345
for hook in Branch.hooks['set_rh']:
2457
1346
hook(self, rev_history)
2458
if Branch.hooks['post_change_branch_tip']:
2459
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2461
def _synchronize_history(self, destination, revision_id):
2462
"""Synchronize last revision and revision history between branches.
2464
This version is most efficient when the destination is also a
2465
BzrBranch5, but works for BzrBranch6 as long as the revision
2466
history is the true lefthand parent history, and all of the revisions
2467
are in the destination's repository. If not, set_revision_history
2470
:param destination: The branch to copy the history into
2471
:param revision_id: The revision-id to truncate history at. May
2472
be None to copy complete history.
2474
if not isinstance(destination._format, BzrBranchFormat5):
2475
super(BzrBranch, self)._synchronize_history(
2476
destination, revision_id)
2478
if revision_id == _mod_revision.NULL_REVISION:
2481
new_history = self.revision_history()
2482
if revision_id is not None and new_history != []:
2484
new_history = new_history[:new_history.index(revision_id) + 1]
2486
rev = self.repository.get_revision(revision_id)
2487
new_history = rev.get_history(self.repository)[1:]
2488
destination.set_revision_history(new_history)
2490
1348
@needs_write_lock
2491
1349
def set_last_revision_info(self, revno, revision_id):
2492
"""Set the last revision of this branch.
2494
The caller is responsible for checking that the revno is correct
2495
for this revision id.
2497
It may be possible to set the branch last revision to an id not
2498
present in the repository. However, branches can also be
2499
configured to check constraints on history, in which case this may not
2502
revision_id = _mod_revision.ensure_null(revision_id)
2503
# this old format stores the full history, but this api doesn't
2504
# provide it, so we must generate, and might as well check it's
1350
revision_id = osutils.safe_revision_id(revision_id)
2506
1351
history = self._lefthand_history(revision_id)
2507
if len(history) != revno:
2508
raise AssertionError('%d != %d' % (len(history), revno))
1352
assert len(history) == revno, '%d != %d' % (len(history), revno)
2509
1353
self.set_revision_history(history)
2511
1355
def _gen_revision_history(self):
2512
history = self._transport.get_bytes('revision-history').split('\n')
1356
history = self.control_files.get('revision-history').read().split('\n')
2513
1357
if history[-1:] == ['']:
2514
1358
# There shouldn't be a trailing newline, but just in case.
1362
def _lefthand_history(self, revision_id, last_rev=None,
1364
# stop_revision must be a descendant of last_revision
1365
stop_graph = self.repository.get_revision_graph(revision_id)
1366
if last_rev is not None and last_rev not in stop_graph:
1367
# our previous tip is not merged into stop_revision
1368
raise errors.DivergedBranches(self, other_branch)
1369
# make a new revision history from the graph
1370
current_rev_id = revision_id
1372
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1373
new_history.append(current_rev_id)
1374
current_rev_id_parents = stop_graph[current_rev_id]
1376
current_rev_id = current_rev_id_parents[0]
1378
current_rev_id = None
1379
new_history.reverse()
2518
1382
@needs_write_lock
2519
1383
def generate_revision_history(self, revision_id, last_rev=None,
2520
1384
other_branch=None):
2526
1390
:param other_branch: The other branch that DivergedBranches should
2527
1391
raise with respect to.
1393
revision_id = osutils.safe_revision_id(revision_id)
2529
1394
self.set_revision_history(self._lefthand_history(revision_id,
2530
1395
last_rev, other_branch))
1398
def update_revisions(self, other, stop_revision=None):
1399
"""See Branch.update_revisions."""
1402
if stop_revision is None:
1403
stop_revision = other.last_revision()
1404
if stop_revision is None:
1405
# if there are no commits, we're done.
1408
stop_revision = osutils.safe_revision_id(stop_revision)
1409
# whats the current last revision, before we fetch [and change it
1411
last_rev = self.last_revision()
1412
# we fetch here regardless of whether we need to so that we pickup
1414
self.fetch(other, stop_revision)
1415
my_ancestry = self.repository.get_ancestry(last_rev)
1416
if stop_revision in my_ancestry:
1417
# last_revision is a descendant of stop_revision
1419
self.generate_revision_history(stop_revision, last_rev=last_rev,
2532
1424
def basis_tree(self):
2533
1425
"""See Branch.basis_tree."""
2534
1426
return self.repository.revision_tree(self.last_revision())
1428
@deprecated_method(zero_eight)
1429
def working_tree(self):
1430
"""Create a Working tree object for this branch."""
1432
from bzrlib.transport.local import LocalTransport
1433
if (self.base.find('://') != -1 or
1434
not isinstance(self._transport, LocalTransport)):
1435
raise NoWorkingTree(self.base)
1436
return self.bzrdir.open_workingtree()
1439
def pull(self, source, overwrite=False, stop_revision=None,
1440
_hook_master=None, _run_hooks=True):
1443
:param _hook_master: Private parameter - set the branch to
1444
be supplied as the master to push hooks.
1445
:param _run_hooks: Private parameter - allow disabling of
1446
hooks, used when pushing to a master branch.
1448
result = PullResult()
1449
result.source_branch = source
1450
result.target_branch = self
1453
result.old_revno, result.old_revid = self.last_revision_info()
1455
self.update_revisions(source, stop_revision)
1456
except DivergedBranches:
1460
if stop_revision is None:
1461
stop_revision = source.last_revision()
1462
self.generate_revision_history(stop_revision)
1463
result.tag_conflicts = source.tags.merge_to(self.tags)
1464
result.new_revno, result.new_revid = self.last_revision_info()
1466
result.master_branch = _hook_master
1467
result.local_branch = self
1469
result.master_branch = self
1470
result.local_branch = None
1472
for hook in Branch.hooks['post_pull']:
2536
1478
def _get_parent_location(self):
2537
1479
_locs = ['parent', 'pull', 'x-pull']
2538
1480
for l in _locs:
2540
return self._transport.get_bytes(l).strip('\n')
2541
except errors.NoSuchFile:
1482
return self.control_files.get(l).read().strip('\n')
2545
def _basic_push(self, target, overwrite, stop_revision):
2546
"""Basic implementation of push without bound branches or hooks.
2548
Must be called with source read locked and target write locked.
1488
def push(self, target, overwrite=False, stop_revision=None,
1489
_hook_master=None, _run_hooks=True):
1492
:param _hook_master: Private parameter - set the branch to
1493
be supplied as the master to push hooks.
1494
:param _run_hooks: Private parameter - allow disabling of
1495
hooks, used when pushing to a master branch.
2550
result = BranchPushResult()
1497
result = PushResult()
2551
1498
result.source_branch = self
2552
1499
result.target_branch = target
2553
result.old_revno, result.old_revid = target.last_revision_info()
2554
self.update_references(target)
2555
if result.old_revid != self.last_revision():
2556
# We assume that during 'push' this repository is closer than
2558
graph = self.repository.get_graph(target.repository)
2559
target.update_revisions(self, stop_revision,
2560
overwrite=overwrite, graph=graph)
2561
if self._push_should_merge_tags():
2562
result.tag_conflicts = self.tags.merge_to(target.tags,
2564
result.new_revno, result.new_revid = target.last_revision_info()
1502
result.old_revno, result.old_revid = target.last_revision_info()
1504
target.update_revisions(self, stop_revision)
1505
except DivergedBranches:
1509
target.set_revision_history(self.revision_history())
1510
result.tag_conflicts = self.tags.merge_to(target.tags)
1511
result.new_revno, result.new_revid = target.last_revision_info()
1513
result.master_branch = _hook_master
1514
result.local_branch = target
1516
result.master_branch = target
1517
result.local_branch = None
1519
for hook in Branch.hooks['post_push']:
2567
def get_stacked_on_url(self):
2568
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1525
def get_parent(self):
1526
"""See Branch.get_parent."""
1528
assert self.base[-1] == '/'
1529
parent = self._get_parent_location()
1532
# This is an old-format absolute path to a local branch
1533
# turn it into a url
1534
if parent.startswith('/'):
1535
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1537
return urlutils.join(self.base[:-1], parent)
1538
except errors.InvalidURLJoin, e:
1539
raise errors.InaccessibleParent(parent, self.base)
2570
1541
def set_push_location(self, location):
2571
1542
"""See Branch.set_push_location."""
2573
1544
'push_location', location,
2574
1545
store=_mod_config.STORE_LOCATION_NORECURSE)
1548
def set_parent(self, url):
1549
"""See Branch.set_parent."""
1550
# TODO: Maybe delete old location files?
1551
# URLs should never be unicode, even on the local fs,
1552
# FIXUP this and get_parent in a future branch format bump:
1553
# read and rewrite the file, and have the new format code read
1554
# using .get not .get_utf8. RBC 20060125
1556
if isinstance(url, unicode):
1558
url = url.encode('ascii')
1559
except UnicodeEncodeError:
1560
raise bzrlib.errors.InvalidURL(url,
1561
"Urls must be 7-bit ascii, "
1562
"use bzrlib.urlutils.escape")
1563
url = urlutils.relative_url(self.base, url)
1564
self._set_parent_location(url)
2576
1566
def _set_parent_location(self, url):
2577
1567
if url is None:
2578
self._transport.delete('parent')
1568
self.control_files._transport.delete('parent')
2580
self._transport.put_bytes('parent', url + '\n',
2581
mode=self.bzrdir._get_file_mode())
1570
assert isinstance(url, str)
1571
self.control_files.put_bytes('parent', url + '\n')
1573
@deprecated_function(zero_nine)
1574
def tree_config(self):
1575
"""DEPRECATED; call get_config instead.
1576
TreeConfig has become part of BranchConfig."""
1577
return TreeConfig(self)
2584
1580
class BzrBranch5(BzrBranch):
2585
"""A format 5 branch. This supports new features over plain branches.
1581
"""A format 5 branch. This supports new features over plan branches.
2587
1583
It has support for a master_branch which is the data for bound branches.
1591
super(BzrBranch5, self).__init__(_format=_format,
1592
_control_files=_control_files,
1594
_repository=_repository)
1597
def pull(self, source, overwrite=False, stop_revision=None,
1599
"""Extends branch.pull to be bound branch aware.
1601
:param _run_hooks: Private parameter used to force hook running
1602
off during bound branch double-pushing.
1604
bound_location = self.get_bound_location()
1605
master_branch = None
1606
if bound_location and source.base != bound_location:
1607
# not pulling from master, so we need to update master.
1608
master_branch = self.get_master_branch()
1609
master_branch.lock_write()
1612
# pull from source into master.
1613
master_branch.pull(source, overwrite, stop_revision,
1615
return super(BzrBranch5, self).pull(source, overwrite,
1616
stop_revision, _hook_master=master_branch,
1617
_run_hooks=_run_hooks)
1620
master_branch.unlock()
1623
def push(self, target, overwrite=False, stop_revision=None):
1624
"""Updates branch.push to be bound branch aware."""
1625
bound_location = target.get_bound_location()
1626
master_branch = None
1627
if bound_location and target.base != bound_location:
1628
# not pushing to master, so we need to update master.
1629
master_branch = target.get_master_branch()
1630
master_branch.lock_write()
1633
# push into the master from this branch.
1634
super(BzrBranch5, self).push(master_branch, overwrite,
1635
stop_revision, _run_hooks=False)
1636
# and push into the target branch from this. Note that we push from
1637
# this branch again, because its considered the highest bandwidth
1639
return super(BzrBranch5, self).push(target, overwrite,
1640
stop_revision, _hook_master=master_branch)
1643
master_branch.unlock()
2590
1645
def get_bound_location(self):
2592
return self._transport.get_bytes('bound')[:-1]
1647
return self.control_files.get_utf8('bound').read()[:-1]
2593
1648
except errors.NoSuchFile:
2596
1651
@needs_read_lock
2597
def get_master_branch(self, possible_transports=None):
1652
def get_master_branch(self):
2598
1653
"""Return the branch we are bound to.
2600
1655
:return: Either a Branch, or None
2602
1657
This could memoise the branch, but if thats done
2662
1731
return self.set_bound_location(None)
2664
1733
@needs_write_lock
2665
def update(self, possible_transports=None):
2666
"""Synchronise this branch with the master branch if any.
1735
"""Synchronise this branch with the master branch if any.
2668
1737
:return: None or the last_revision that was pivoted out during the
2671
master = self.get_master_branch(possible_transports)
1740
master = self.get_master_branch()
2672
1741
if master is not None:
2673
old_tip = _mod_revision.ensure_null(self.last_revision())
1742
old_tip = self.last_revision()
2674
1743
self.pull(master, overwrite=True)
2675
if self.repository.get_graph().is_ancestor(old_tip,
2676
_mod_revision.ensure_null(self.last_revision())):
1744
if old_tip in self.repository.get_ancestry(self.last_revision()):
2682
class BzrBranch8(BzrBranch5):
2683
"""A branch that stores tree-reference locations."""
2685
def _open_hook(self):
2686
if self._ignore_fallbacks:
1750
class BzrBranchExperimental(BzrBranch5):
1751
"""Bzr experimental branch format
1754
- a revision-history file.
1756
- a lock dir guarding the branch itself
1757
- all of this stored in a branch/ subdirectory
1758
- works with shared repositories.
1759
- a tag dictionary in the branch
1761
This format is new in bzr 0.15, but shouldn't be used for real data,
1764
This class acts as it's own BranchFormat.
1767
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1770
def get_format_string(cls):
1771
"""See BranchFormat.get_format_string()."""
1772
return "Bazaar-NG branch format experimental\n"
1775
def get_format_description(cls):
1776
"""See BranchFormat.get_format_description()."""
1777
return "Experimental branch format"
1780
def get_reference(cls, a_bzrdir):
1781
"""Get the target reference of the branch in a_bzrdir.
1783
format probing must have been completed before calling
1784
this method - it is assumed that the format of the branch
1785
in a_bzrdir is correct.
1787
:param a_bzrdir: The bzrdir to get the branch data from.
1788
:return: None if the branch is not a reference branch.
1793
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1795
branch_transport = a_bzrdir.get_branch_transport(cls)
1796
control_files = lockable_files.LockableFiles(branch_transport,
1797
lock_filename, lock_class)
1798
control_files.create_lock()
1799
control_files.lock_write()
2689
url = self.get_stacked_on_url()
2690
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2691
errors.UnstackableBranchFormat):
2694
for hook in Branch.hooks['transform_fallback_location']:
2695
url = hook(self, url)
2697
hook_name = Branch.hooks.get_hook_name(hook)
2698
raise AssertionError(
2699
"'transform_fallback_location' hook %s returned "
2700
"None, not a URL." % hook_name)
2701
self._activate_fallback_location(url)
2703
def __init__(self, *args, **kwargs):
2704
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2705
super(BzrBranch8, self).__init__(*args, **kwargs)
2706
self._last_revision_info_cache = None
2707
self._reference_info = None
2709
def _clear_cached_state(self):
2710
super(BzrBranch8, self)._clear_cached_state()
2711
self._last_revision_info_cache = None
2712
self._reference_info = None
2714
def _last_revision_info(self):
2715
revision_string = self._transport.get_bytes('last-revision')
1801
for filename, content in utf8_files:
1802
control_files.put_utf8(filename, content)
1804
control_files.unlock()
1807
def initialize(cls, a_bzrdir):
1808
"""Create a branch of this format in a_bzrdir."""
1809
utf8_files = [('format', cls.get_format_string()),
1810
('revision-history', ''),
1811
('branch-name', ''),
1814
cls._initialize_control_files(a_bzrdir, utf8_files,
1815
'lock', lockdir.LockDir)
1816
return cls.open(a_bzrdir, _found=True)
1819
def open(cls, a_bzrdir, _found=False):
1820
"""Return the branch object for a_bzrdir
1822
_found is a private parameter, do not use it. It is used to indicate
1823
if format probing has already be done.
1826
format = BranchFormat.find_format(a_bzrdir)
1827
assert format.__class__ == cls
1828
transport = a_bzrdir.get_branch_transport(None)
1829
control_files = lockable_files.LockableFiles(transport, 'lock',
1831
return cls(_format=cls,
1832
_control_files=control_files,
1834
_repository=a_bzrdir.find_repository())
1837
def is_supported(cls):
1840
def _make_tags(self):
1841
return BasicTags(self)
1844
def supports_tags(cls):
1848
BranchFormat.register_format(BzrBranchExperimental)
1851
class BzrBranch6(BzrBranch5):
1854
def last_revision_info(self):
1855
revision_string = self.control_files.get('last-revision').read()
2716
1856
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2717
1857
revision_id = cache_utf8.get_cached_utf8(revision_id)
2718
1858
revno = int(revno)
2719
1859
return revno, revision_id
1861
def last_revision(self):
1862
"""Return last revision id, or None"""
1863
revision_id = self.last_revision_info()[1]
1864
if revision_id == _mod_revision.NULL_REVISION:
2721
1868
def _write_last_revision_info(self, revno, revision_id):
2722
1869
"""Simply write out the revision id, with no checks.
2727
1874
Intended to be called by set_last_revision_info and
2728
1875
_write_revision_history.
2730
revision_id = _mod_revision.ensure_null(revision_id)
1877
if revision_id is None:
1878
revision_id = 'null:'
2731
1879
out_string = '%d %s\n' % (revno, revision_id)
2732
self._transport.put_bytes('last-revision', out_string,
2733
mode=self.bzrdir._get_file_mode())
1880
self.control_files.put_bytes('last-revision', out_string)
2735
1882
@needs_write_lock
2736
1883
def set_last_revision_info(self, revno, revision_id):
2737
revision_id = _mod_revision.ensure_null(revision_id)
2738
old_revno, old_revid = self.last_revision_info()
1884
revision_id = osutils.safe_revision_id(revision_id)
2739
1885
if self._get_append_revisions_only():
2740
1886
self._check_history_violation(revision_id)
2741
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2742
1887
self._write_last_revision_info(revno, revision_id)
2743
1888
self._clear_cached_state()
2744
self._last_revision_info_cache = revno, revision_id
2745
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2747
def _synchronize_history(self, destination, revision_id):
2748
"""Synchronize last revision and revision history between branches.
2750
:see: Branch._synchronize_history
2752
# XXX: The base Branch has a fast implementation of this method based
2753
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2754
# that uses set_revision_history. This class inherits from BzrBranch5,
2755
# but wants the fast implementation, so it calls
2756
# Branch._synchronize_history directly.
2757
Branch._synchronize_history(self, destination, revision_id)
2759
1890
def _check_history_violation(self, revision_id):
2760
last_revision = _mod_revision.ensure_null(self.last_revision())
2761
if _mod_revision.is_null(last_revision):
1891
last_revision = self.last_revision()
1892
if last_revision is None:
2763
1894
if last_revision not in self._lefthand_history(revision_id):
2764
raise errors.AppendRevisionsOnlyViolation(self.user_url)
1895
raise errors.AppendRevisionsOnlyViolation(self.base)
2766
1897
def _gen_revision_history(self):
2767
1898
"""Generate the revision history from last revision
2769
last_revno, last_revision = self.last_revision_info()
2770
self._extend_partial_history(stop_index=last_revno-1)
2771
return list(reversed(self._partial_revision_history_cache))
1900
history = list(self.repository.iter_reverse_revision_history(
1901
self.last_revision()))
2773
1905
def _write_revision_history(self, history):
2774
1906
"""Factored out of set_revision_history.
2796
1947
"""Set the parent branch"""
2797
1948
return self._get_config_location('parent_location')
2800
def _set_all_reference_info(self, info_dict):
2801
"""Replace all reference info stored in a branch.
2803
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2806
writer = rio.RioWriter(s)
2807
for key, (tree_path, branch_location) in info_dict.iteritems():
2808
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2809
branch_location=branch_location)
2810
writer.write_stanza(stanza)
2811
self._transport.put_bytes('references', s.getvalue())
2812
self._reference_info = info_dict
2815
def _get_all_reference_info(self):
2816
"""Return all the reference info stored in a branch.
2818
:return: A dict of {file_id: (tree_path, branch_location)}
2820
if self._reference_info is not None:
2821
return self._reference_info
2822
rio_file = self._transport.get('references')
2824
stanzas = rio.read_stanzas(rio_file)
2825
info_dict = dict((s['file_id'], (s['tree_path'],
2826
s['branch_location'])) for s in stanzas)
2829
self._reference_info = info_dict
2832
def set_reference_info(self, file_id, tree_path, branch_location):
2833
"""Set the branch location to use for a tree reference.
2835
:param file_id: The file-id of the tree reference.
2836
:param tree_path: The path of the tree reference in the tree.
2837
:param branch_location: The location of the branch to retrieve tree
2840
info_dict = self._get_all_reference_info()
2841
info_dict[file_id] = (tree_path, branch_location)
2842
if None in (tree_path, branch_location):
2843
if tree_path is not None:
2844
raise ValueError('tree_path must be None when branch_location'
2846
if branch_location is not None:
2847
raise ValueError('branch_location must be None when tree_path'
2849
del info_dict[file_id]
2850
self._set_all_reference_info(info_dict)
2852
def get_reference_info(self, file_id):
2853
"""Get the tree_path and branch_location for a tree reference.
2855
:return: a tuple of (tree_path, branch_location)
2857
return self._get_all_reference_info().get(file_id, (None, None))
2859
def reference_parent(self, file_id, path, possible_transports=None):
2860
"""Return the parent branch for a tree-reference file_id.
2862
:param file_id: The file_id of the tree reference
2863
:param path: The path of the file_id in the tree
2864
:return: A branch associated with the file_id
2866
branch_location = self.get_reference_info(file_id)[1]
2867
if branch_location is None:
2868
return Branch.reference_parent(self, file_id, path,
2869
possible_transports)
2870
branch_location = urlutils.join(self.user_url, branch_location)
2871
return Branch.open(branch_location,
2872
possible_transports=possible_transports)
2874
1950
def set_push_location(self, location):
2875
1951
"""See Branch.set_push_location."""
2876
1952
self._set_config_location('push_location', location)
2909
1985
"""See Branch.get_old_bound_location"""
2910
1986
return self._get_bound_location(False)
2912
def get_stacked_on_url(self):
2913
# you can always ask for the URL; but you might not be able to use it
2914
# if the repo can't support stacking.
2915
## self._check_stackable_repo()
2916
stacked_url = self._get_config_location('stacked_on_location')
2917
if stacked_url is None:
2918
raise errors.NotStacked(self)
1988
def set_append_revisions_only(self, enabled):
1993
self.get_config().set_user_option('append_revisions_only', value)
2921
1995
def _get_append_revisions_only(self):
2922
return self.get_config(
2923
).get_user_option_as_bool('append_revisions_only')
2926
def generate_revision_history(self, revision_id, last_rev=None,
2928
"""See BzrBranch5.generate_revision_history"""
2929
history = self._lefthand_history(revision_id, last_rev, other_branch)
2930
revno = len(history)
2931
self.set_last_revision_info(revno, revision_id)
2934
def get_rev_id(self, revno, history=None):
2935
"""Find the revision id of the specified revno."""
2937
return _mod_revision.NULL_REVISION
2939
last_revno, last_revision_id = self.last_revision_info()
2940
if revno <= 0 or revno > last_revno:
2941
raise errors.NoSuchRevision(self, revno)
2943
if history is not None:
2944
return history[revno - 1]
2946
index = last_revno - revno
2947
if len(self._partial_revision_history_cache) <= index:
2948
self._extend_partial_history(stop_index=index)
2949
if len(self._partial_revision_history_cache) > index:
2950
return self._partial_revision_history_cache[index]
1996
value = self.get_config().get_user_option('append_revisions_only')
1997
return value == 'True'
1999
def _synchronize_history(self, destination, revision_id):
2000
"""Synchronize last revision and revision history between branches.
2002
This version is most efficient when the destination is also a
2003
BzrBranch6, but works for BzrBranch5, as long as the destination's
2004
repository contains all the lefthand ancestors of the intended
2005
last_revision. If not, set_last_revision_info will fail.
2007
:param destination: The branch to copy the history into
2008
:param revision_id: The revision-id to truncate history at. May
2009
be None to copy complete history.
2011
if revision_id is None:
2012
revno, revision_id = self.last_revision_info()
2952
raise errors.NoSuchRevision(self, revno)
2955
def revision_id_to_revno(self, revision_id):
2956
"""Given a revision id, return its revno"""
2957
if _mod_revision.is_null(revision_id):
2960
index = self._partial_revision_history_cache.index(revision_id)
2962
self._extend_partial_history(stop_revision=revision_id)
2963
index = len(self._partial_revision_history_cache) - 1
2964
if self._partial_revision_history_cache[index] != revision_id:
2965
raise errors.NoSuchRevision(self, revision_id)
2966
return self.revno() - index
2969
class BzrBranch7(BzrBranch8):
2970
"""A branch with support for a fallback repository."""
2972
def set_reference_info(self, file_id, tree_path, branch_location):
2973
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2975
def get_reference_info(self, file_id):
2976
Branch.get_reference_info(self, file_id)
2978
def reference_parent(self, file_id, path, possible_transports=None):
2979
return Branch.reference_parent(self, file_id, path,
2980
possible_transports)
2983
class BzrBranch6(BzrBranch7):
2984
"""See BzrBranchFormat6 for the capabilities of this branch.
2986
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2014
revno = self.revision_id_to_revno(revision_id)
2015
destination.set_last_revision_info(revno, revision_id)
2017
def _make_tags(self):
2018
return BasicTags(self)
2021
class BranchTestProviderAdapter(object):
2022
"""A tool to generate a suite testing multiple branch formats at once.
2024
This is done by copying the test once for each transport and injecting
2025
the transport_server, transport_readonly_server, and branch_format
2026
classes into each copy. Each copy is also given a new id() to make it
2990
def get_stacked_on_url(self):
2991
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2030
def __init__(self, transport_server, transport_readonly_server, formats,
2031
vfs_transport_factory=None):
2032
self._transport_server = transport_server
2033
self._transport_readonly_server = transport_readonly_server
2034
self._formats = formats
2036
def adapt(self, test):
2037
result = TestSuite()
2038
for branch_format, bzrdir_format in self._formats:
2039
new_test = deepcopy(test)
2040
new_test.transport_server = self._transport_server
2041
new_test.transport_readonly_server = self._transport_readonly_server
2042
new_test.bzrdir_format = bzrdir_format
2043
new_test.branch_format = branch_format
2044
def make_new_test_id():
2045
# the format can be either a class or an instance
2046
name = getattr(branch_format, '__name__',
2047
branch_format.__class__.__name__)
2048
new_id = "%s(%s)" % (new_test.id(), name)
2049
return lambda: new_id
2050
new_test.id = make_new_test_id()
2051
result.addTest(new_test)
2994
2055
######################################################################
3105
2153
new_branch.tags._set_tag_dict({})
3107
2155
# Copying done; now update target format
3108
new_branch._transport.put_bytes('format',
3109
format.get_format_string(),
3110
mode=new_branch.bzrdir._get_file_mode())
2156
new_branch.control_files.put_utf8('format',
2157
format.get_format_string())
3112
2159
# Clean up old files
3113
new_branch._transport.delete('revision-history')
2160
new_branch.control_files._transport.delete('revision-history')
3115
2162
branch.set_parent(None)
3116
except errors.NoSuchFile:
3118
2165
branch.set_bound_location(None)
3121
class Converter6to7(object):
3122
"""Perform an in-place upgrade of format 6 to format 7"""
3124
def convert(self, branch):
3125
format = BzrBranchFormat7()
3126
branch._set_config_location('stacked_on_location', '')
3127
# update target format
3128
branch._transport.put_bytes('format', format.get_format_string())
3131
class Converter7to8(object):
3132
"""Perform an in-place upgrade of format 6 to format 7"""
3134
def convert(self, branch):
3135
format = BzrBranchFormat8()
3136
branch._transport.put_bytes('references', '')
3137
# update target format
3138
branch._transport.put_bytes('format', format.get_format_string())
3141
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3142
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3145
_run_with_write_locked_target will attempt to release the lock it acquires.
3147
If an exception is raised by callable, then that exception *will* be
3148
propagated, even if the unlock attempt raises its own error. Thus
3149
_run_with_write_locked_target should be preferred to simply doing::
3153
return callable(*args, **kwargs)
3158
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3159
# should share code?
3162
result = callable(*args, **kwargs)
3164
exc_info = sys.exc_info()
3168
raise exc_info[0], exc_info[1], exc_info[2]
3174
class InterBranch(InterObject):
3175
"""This class represents operations taking place between two branches.
3177
Its instances have methods like pull() and push() and contain
3178
references to the source and target repositories these operations
3179
can be carried out on.
3183
"""The available optimised InterBranch types."""
3186
def _get_branch_formats_to_test():
3187
"""Return a tuple with the Branch formats to use when testing."""
3188
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3190
def pull(self, overwrite=False, stop_revision=None,
3191
possible_transports=None, local=False):
3192
"""Mirror source into target branch.
3194
The target branch is considered to be 'local', having low latency.
3196
:returns: PullResult instance
3198
raise NotImplementedError(self.pull)
3200
def update_revisions(self, stop_revision=None, overwrite=False,
3202
"""Pull in new perfect-fit revisions.
3204
:param stop_revision: Updated until the given revision
3205
:param overwrite: Always set the branch pointer, rather than checking
3206
to see if it is a proper descendant.
3207
:param graph: A Graph object that can be used to query history
3208
information. This can be None.
3211
raise NotImplementedError(self.update_revisions)
3213
def push(self, overwrite=False, stop_revision=None,
3214
_override_hook_source_branch=None):
3215
"""Mirror the source branch into the target branch.
3217
The source branch is considered to be 'local', having low latency.
3219
raise NotImplementedError(self.push)
3222
class GenericInterBranch(InterBranch):
3223
"""InterBranch implementation that uses public Branch functions.
3227
def _get_branch_formats_to_test():
3228
return BranchFormat._default_format, BranchFormat._default_format
3230
def update_revisions(self, stop_revision=None, overwrite=False,
3232
"""See InterBranch.update_revisions()."""
3233
self.source.lock_read()
3235
other_revno, other_last_revision = self.source.last_revision_info()
3236
stop_revno = None # unknown
3237
if stop_revision is None:
3238
stop_revision = other_last_revision
3239
if _mod_revision.is_null(stop_revision):
3240
# if there are no commits, we're done.
3242
stop_revno = other_revno
3244
# what's the current last revision, before we fetch [and change it
3246
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3247
# we fetch here so that we don't process data twice in the common
3248
# case of having something to pull, and so that the check for
3249
# already merged can operate on the just fetched graph, which will
3250
# be cached in memory.
3251
self.target.fetch(self.source, stop_revision)
3252
# Check to see if one is an ancestor of the other
3255
graph = self.target.repository.get_graph()
3256
if self.target._check_if_descendant_or_diverged(
3257
stop_revision, last_rev, graph, self.source):
3258
# stop_revision is a descendant of last_rev, but we aren't
3259
# overwriting, so we're done.
3261
if stop_revno is None:
3263
graph = self.target.repository.get_graph()
3264
this_revno, this_last_revision = \
3265
self.target.last_revision_info()
3266
stop_revno = graph.find_distance_to_null(stop_revision,
3267
[(other_last_revision, other_revno),
3268
(this_last_revision, this_revno)])
3269
self.target.set_last_revision_info(stop_revno, stop_revision)
3271
self.source.unlock()
3273
def pull(self, overwrite=False, stop_revision=None,
3274
possible_transports=None, _hook_master=None, run_hooks=True,
3275
_override_hook_target=None, local=False):
3278
:param _hook_master: Private parameter - set the branch to
3279
be supplied as the master to pull hooks.
3280
:param run_hooks: Private parameter - if false, this branch
3281
is being called because it's the master of the primary branch,
3282
so it should not run its hooks.
3283
:param _override_hook_target: Private parameter - set the branch to be
3284
supplied as the target_branch to pull hooks.
3285
:param local: Only update the local branch, and not the bound branch.
3287
# This type of branch can't be bound.
3289
raise errors.LocalRequiresBoundBranch()
3290
result = PullResult()
3291
result.source_branch = self.source
3292
if _override_hook_target is None:
3293
result.target_branch = self.target
3295
result.target_branch = _override_hook_target
3296
self.source.lock_read()
3298
# We assume that during 'pull' the target repository is closer than
3300
self.source.update_references(self.target)
3301
graph = self.target.repository.get_graph(self.source.repository)
3302
# TODO: Branch formats should have a flag that indicates
3303
# that revno's are expensive, and pull() should honor that flag.
3305
result.old_revno, result.old_revid = \
3306
self.target.last_revision_info()
3307
self.target.update_revisions(self.source, stop_revision,
3308
overwrite=overwrite, graph=graph)
3309
# TODO: The old revid should be specified when merging tags,
3310
# so a tags implementation that versions tags can only
3311
# pull in the most recent changes. -- JRV20090506
3312
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3314
result.new_revno, result.new_revid = self.target.last_revision_info()
3316
result.master_branch = _hook_master
3317
result.local_branch = result.target_branch
3319
result.master_branch = result.target_branch
3320
result.local_branch = None
3322
for hook in Branch.hooks['post_pull']:
3325
self.source.unlock()
3328
def push(self, overwrite=False, stop_revision=None,
3329
_override_hook_source_branch=None):
3330
"""See InterBranch.push.
3332
This is the basic concrete implementation of push()
3334
:param _override_hook_source_branch: If specified, run
3335
the hooks passing this Branch as the source, rather than self.
3336
This is for use of RemoteBranch, where push is delegated to the
3337
underlying vfs-based Branch.
3339
# TODO: Public option to disable running hooks - should be trivial but
3341
self.source.lock_read()
3343
return _run_with_write_locked_target(
3344
self.target, self._push_with_bound_branches, overwrite,
3346
_override_hook_source_branch=_override_hook_source_branch)
3348
self.source.unlock()
3350
def _push_with_bound_branches(self, overwrite, stop_revision,
3351
_override_hook_source_branch=None):
3352
"""Push from source into target, and into target's master if any.
3355
if _override_hook_source_branch:
3356
result.source_branch = _override_hook_source_branch
3357
for hook in Branch.hooks['post_push']:
3360
bound_location = self.target.get_bound_location()
3361
if bound_location and self.target.base != bound_location:
3362
# there is a master branch.
3364
# XXX: Why the second check? Is it even supported for a branch to
3365
# be bound to itself? -- mbp 20070507
3366
master_branch = self.target.get_master_branch()
3367
master_branch.lock_write()
3369
# push into the master from the source branch.
3370
self.source._basic_push(master_branch, overwrite, stop_revision)
3371
# and push into the target branch from the source. Note that we
3372
# push from the source branch again, because its considered the
3373
# highest bandwidth repository.
3374
result = self.source._basic_push(self.target, overwrite,
3376
result.master_branch = master_branch
3377
result.local_branch = self.target
3381
master_branch.unlock()
3384
result = self.source._basic_push(self.target, overwrite,
3386
# TODO: Why set master_branch and local_branch if there's no
3387
# binding? Maybe cleaner to just leave them unset? -- mbp
3389
result.master_branch = self.target
3390
result.local_branch = None
3395
def is_compatible(self, source, target):
3396
# GenericBranch uses the public API, so always compatible
3400
class InterToBranch5(GenericInterBranch):
3403
def _get_branch_formats_to_test():
3404
return BranchFormat._default_format, BzrBranchFormat5()
3406
def pull(self, overwrite=False, stop_revision=None,
3407
possible_transports=None, run_hooks=True,
3408
_override_hook_target=None, local=False):
3409
"""Pull from source into self, updating my master if any.
3411
:param run_hooks: Private parameter - if false, this branch
3412
is being called because it's the master of the primary branch,
3413
so it should not run its hooks.
3415
bound_location = self.target.get_bound_location()
3416
if local and not bound_location:
3417
raise errors.LocalRequiresBoundBranch()
3418
master_branch = None
3419
if not local and bound_location and self.source.user_url != bound_location:
3420
# not pulling from master, so we need to update master.
3421
master_branch = self.target.get_master_branch(possible_transports)
3422
master_branch.lock_write()
3425
# pull from source into master.
3426
master_branch.pull(self.source, overwrite, stop_revision,
3428
return super(InterToBranch5, self).pull(overwrite,
3429
stop_revision, _hook_master=master_branch,
3430
run_hooks=run_hooks,
3431
_override_hook_target=_override_hook_target)
3434
master_branch.unlock()
3437
InterBranch.register_optimiser(GenericInterBranch)
3438
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
