1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
from cStringIO import StringIO
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from itertools import chain
27
config as _mod_config,
33
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TransportConfig
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.hooks import HookPoint, Hooks
51
from bzrlib.inter import InterObject
52
from bzrlib import registry
53
from bzrlib.symbol_versioning import (
57
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
60
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
61
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
65
# TODO: Maybe include checks for common corruption of newlines, etc?
67
# TODO: Some operations like log might retrieve the same revisions
68
# repeatedly to calculate deltas. We could perhaps have a weakref
69
# cache in memory to make this faster. In general anything can be
70
# cached in memory between lock and unlock operations. .. nb thats
71
# what the transaction identity map provides
74
######################################################################
78
"""Branch holding a history of revisions.
81
Base directory/url of the branch.
83
hooks: An instance of BranchHooks.
85
# this is really an instance variable - FIXME move it there
89
def __init__(self, *ignored, **ignored_too):
90
self.tags = self._format.make_tags(self)
91
self._revision_history_cache = None
92
self._revision_id_to_revno_cache = None
93
self._partial_revision_id_to_revno_cache = {}
94
self._last_revision_info_cache = None
95
self._merge_sorted_revisions_cache = None
97
hooks = Branch.hooks['open']
101
def _open_hook(self):
102
"""Called by init to allow simpler extension of the base class."""
104
def _activate_fallback_location(self, url, lock_style):
105
"""Activate the branch/repository from url as a fallback repository."""
106
repo = self._get_fallback_repository(url)
107
if lock_style == 'write':
109
elif lock_style == 'read':
111
self.repository.add_fallback_repository(repo)
113
def break_lock(self):
114
"""Break a lock if one is present from another instance.
116
Uses the ui factory to ask for confirmation if the lock may be from
119
This will probe the repository for its lock as well.
121
self.control_files.break_lock()
122
self.repository.break_lock()
123
master = self.get_master_branch()
124
if master is not None:
127
def _check_stackable_repo(self):
128
if not self.repository._format.supports_external_lookups:
129
raise errors.UnstackableRepositoryFormat(self.repository._format,
130
self.repository.base)
132
def _get_check_refs(self):
133
"""Get the references needed for check().
137
revid = self.last_revision()
138
return [('revision-existence', revid), ('lefthand-distance', revid)]
141
def open(base, _unsupported=False, possible_transports=None):
142
"""Open the branch rooted at base.
144
For instance, if the branch is at URL/.bzr/branch,
145
Branch.open(URL) -> a Branch instance.
147
control = bzrdir.BzrDir.open(base, _unsupported,
148
possible_transports=possible_transports)
149
return control.open_branch(_unsupported)
152
def open_from_transport(transport, _unsupported=False):
153
"""Open the branch rooted at transport"""
154
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
155
return control.open_branch(_unsupported)
158
def open_containing(url, possible_transports=None):
159
"""Open an existing branch which contains url.
161
This probes for a branch at url, and searches upwards from there.
163
Basically we keep looking up until we find the control directory or
164
run into the root. If there isn't one, raises NotBranchError.
165
If there is one and it is either an unrecognised format or an unsupported
166
format, UnknownFormatError or UnsupportedFormatError are raised.
167
If there is one, it is returned, along with the unused portion of url.
169
control, relpath = bzrdir.BzrDir.open_containing(url,
171
return control.open_branch(), relpath
173
def _push_should_merge_tags(self):
174
"""Should _basic_push merge this branch's tags into the target?
176
The default implementation returns False if this branch has no tags,
177
and True the rest of the time. Subclasses may override this.
179
return self.supports_tags() and self.tags.get_tag_dict()
181
def get_config(self):
182
return BranchConfig(self)
184
def _get_config(self):
185
"""Get the concrete config for just the config in this branch.
187
This is not intended for client use; see Branch.get_config for the
192
:return: An object supporting get_option and set_option.
194
raise NotImplementedError(self._get_config)
196
def _get_fallback_repository(self, url):
197
"""Get the repository we fallback to at url."""
198
url = urlutils.join(self.base, url)
199
a_bzrdir = bzrdir.BzrDir.open(url,
200
possible_transports=[self.bzrdir.root_transport])
201
return a_bzrdir.open_branch().repository
203
def _get_tags_bytes(self):
204
"""Get the bytes of a serialised tags dict.
206
Note that not all branches support tags, nor do all use the same tags
207
logic: this method is specific to BasicTags. Other tag implementations
208
may use the same method name and behave differently, safely, because
209
of the double-dispatch via
210
format.make_tags->tags_instance->get_tags_dict.
212
:return: The bytes of the tags file.
213
:seealso: Branch._set_tags_bytes.
215
return self._transport.get_bytes('tags')
217
def _get_nick(self, local=False, possible_transports=None):
218
config = self.get_config()
219
# explicit overrides master, but don't look for master if local is True
220
if not local and not config.has_explicit_nickname():
222
master = self.get_master_branch(possible_transports)
223
if master is not None:
224
# return the master branch value
226
except errors.BzrError, e:
227
# Silently fall back to local implicit nick if the master is
229
mutter("Could not connect to bound branch, "
230
"falling back to local nick.\n " + str(e))
231
return config.get_nickname()
233
def _set_nick(self, nick):
234
self.get_config().set_user_option('nickname', nick, warn_masked=True)
236
nick = property(_get_nick, _set_nick)
239
raise NotImplementedError(self.is_locked)
241
def _lefthand_history(self, revision_id, last_rev=None,
243
if 'evil' in debug.debug_flags:
244
mutter_callsite(4, "_lefthand_history scales with history.")
245
# stop_revision must be a descendant of last_revision
246
graph = self.repository.get_graph()
247
if last_rev is not None:
248
if not graph.is_ancestor(last_rev, revision_id):
249
# our previous tip is not merged into stop_revision
250
raise errors.DivergedBranches(self, other_branch)
251
# make a new revision history from the graph
252
parents_map = graph.get_parent_map([revision_id])
253
if revision_id not in parents_map:
254
raise errors.NoSuchRevision(self, revision_id)
255
current_rev_id = revision_id
257
check_not_reserved_id = _mod_revision.check_not_reserved_id
258
# Do not include ghosts or graph origin in revision_history
259
while (current_rev_id in parents_map and
260
len(parents_map[current_rev_id]) > 0):
261
check_not_reserved_id(current_rev_id)
262
new_history.append(current_rev_id)
263
current_rev_id = parents_map[current_rev_id][0]
264
parents_map = graph.get_parent_map([current_rev_id])
265
new_history.reverse()
268
def lock_write(self):
269
raise NotImplementedError(self.lock_write)
272
raise NotImplementedError(self.lock_read)
275
raise NotImplementedError(self.unlock)
277
def peek_lock_mode(self):
278
"""Return lock mode for the Branch: 'r', 'w' or None"""
279
raise NotImplementedError(self.peek_lock_mode)
281
def get_physical_lock_status(self):
282
raise NotImplementedError(self.get_physical_lock_status)
285
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
286
"""Return the revision_id for a dotted revno.
288
:param revno: a tuple like (1,) or (1,1,2)
289
:param _cache_reverse: a private parameter enabling storage
290
of the reverse mapping in a top level cache. (This should
291
only be done in selective circumstances as we want to
292
avoid having the mapping cached multiple times.)
293
:return: the revision_id
294
:raises errors.NoSuchRevision: if the revno doesn't exist
296
rev_id = self._do_dotted_revno_to_revision_id(revno)
298
self._partial_revision_id_to_revno_cache[rev_id] = revno
301
def _do_dotted_revno_to_revision_id(self, revno):
302
"""Worker function for dotted_revno_to_revision_id.
304
Subclasses should override this if they wish to
305
provide a more efficient implementation.
308
return self.get_rev_id(revno[0])
309
revision_id_to_revno = self.get_revision_id_to_revno_map()
310
revision_ids = [revision_id for revision_id, this_revno
311
in revision_id_to_revno.iteritems()
312
if revno == this_revno]
313
if len(revision_ids) == 1:
314
return revision_ids[0]
316
revno_str = '.'.join(map(str, revno))
317
raise errors.NoSuchRevision(self, revno_str)
320
def revision_id_to_dotted_revno(self, revision_id):
321
"""Given a revision id, return its dotted revno.
323
:return: a tuple like (1,) or (400,1,3).
325
return self._do_revision_id_to_dotted_revno(revision_id)
327
def _do_revision_id_to_dotted_revno(self, revision_id):
328
"""Worker function for revision_id_to_revno."""
329
# Try the caches if they are loaded
330
result = self._partial_revision_id_to_revno_cache.get(revision_id)
331
if result is not None:
333
if self._revision_id_to_revno_cache:
334
result = self._revision_id_to_revno_cache.get(revision_id)
336
raise errors.NoSuchRevision(self, revision_id)
337
# Try the mainline as it's optimised
339
revno = self.revision_id_to_revno(revision_id)
341
except errors.NoSuchRevision:
342
# We need to load and use the full revno map after all
343
result = self.get_revision_id_to_revno_map().get(revision_id)
345
raise errors.NoSuchRevision(self, revision_id)
349
def get_revision_id_to_revno_map(self):
350
"""Return the revision_id => dotted revno map.
352
This will be regenerated on demand, but will be cached.
354
:return: A dictionary mapping revision_id => dotted revno.
355
This dictionary should not be modified by the caller.
357
if self._revision_id_to_revno_cache is not None:
358
mapping = self._revision_id_to_revno_cache
360
mapping = self._gen_revno_map()
361
self._cache_revision_id_to_revno(mapping)
362
# TODO: jam 20070417 Since this is being cached, should we be returning
364
# I would rather not, and instead just declare that users should not
365
# modify the return value.
368
def _gen_revno_map(self):
369
"""Create a new mapping from revision ids to dotted revnos.
371
Dotted revnos are generated based on the current tip in the revision
373
This is the worker function for get_revision_id_to_revno_map, which
374
just caches the return value.
376
:return: A dictionary mapping revision_id => dotted revno.
378
revision_id_to_revno = dict((rev_id, revno)
379
for rev_id, depth, revno, end_of_merge
380
in self.iter_merge_sorted_revisions())
381
return revision_id_to_revno
384
def iter_merge_sorted_revisions(self, start_revision_id=None,
385
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
386
"""Walk the revisions for a branch in merge sorted order.
388
Merge sorted order is the output from a merge-aware,
389
topological sort, i.e. all parents come before their
390
children going forward; the opposite for reverse.
392
:param start_revision_id: the revision_id to begin walking from.
393
If None, the branch tip is used.
394
:param stop_revision_id: the revision_id to terminate the walk
395
after. If None, the rest of history is included.
396
:param stop_rule: if stop_revision_id is not None, the precise rule
397
to use for termination:
398
* 'exclude' - leave the stop revision out of the result (default)
399
* 'include' - the stop revision is the last item in the result
400
* 'with-merges' - include the stop revision and all of its
401
merged revisions in the result
402
:param direction: either 'reverse' or 'forward':
403
* reverse means return the start_revision_id first, i.e.
404
start at the most recent revision and go backwards in history
405
* forward returns tuples in the opposite order to reverse.
406
Note in particular that forward does *not* do any intelligent
407
ordering w.r.t. depth as some clients of this API may like.
408
(If required, that ought to be done at higher layers.)
410
:return: an iterator over (revision_id, depth, revno, end_of_merge)
413
* revision_id: the unique id of the revision
414
* depth: How many levels of merging deep this node has been
416
* revno_sequence: This field provides a sequence of
417
revision numbers for all revisions. The format is:
418
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
419
branch that the revno is on. From left to right the REVNO numbers
420
are the sequence numbers within that branch of the revision.
421
* end_of_merge: When True the next node (earlier in history) is
422
part of a different merge.
424
# Note: depth and revno values are in the context of the branch so
425
# we need the full graph to get stable numbers, regardless of the
427
if self._merge_sorted_revisions_cache is None:
428
last_revision = self.last_revision()
429
graph = self.repository.get_graph()
430
parent_map = dict(((key, value) for key, value in
431
graph.iter_ancestry([last_revision]) if value is not None))
432
revision_graph = repository._strip_NULL_ghosts(parent_map)
433
revs = tsort.merge_sort(revision_graph, last_revision, None,
435
# Drop the sequence # before caching
436
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
438
filtered = self._filter_merge_sorted_revisions(
439
self._merge_sorted_revisions_cache, start_revision_id,
440
stop_revision_id, stop_rule)
441
if direction == 'reverse':
443
if direction == 'forward':
444
return reversed(list(filtered))
446
raise ValueError('invalid direction %r' % direction)
448
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
449
start_revision_id, stop_revision_id, stop_rule):
450
"""Iterate over an inclusive range of sorted revisions."""
451
rev_iter = iter(merge_sorted_revisions)
452
if start_revision_id is not None:
453
for rev_id, depth, revno, end_of_merge in rev_iter:
454
if rev_id != start_revision_id:
457
# The decision to include the start or not
458
# depends on the stop_rule if a stop is provided
460
iter([(rev_id, depth, revno, end_of_merge)]),
463
if stop_revision_id is None:
464
for rev_id, depth, revno, end_of_merge in rev_iter:
465
yield rev_id, depth, revno, end_of_merge
466
elif stop_rule == 'exclude':
467
for rev_id, depth, revno, end_of_merge in rev_iter:
468
if rev_id == stop_revision_id:
470
yield rev_id, depth, revno, end_of_merge
471
elif stop_rule == 'include':
472
for rev_id, depth, revno, end_of_merge in rev_iter:
473
yield rev_id, depth, revno, end_of_merge
474
if rev_id == stop_revision_id:
476
elif stop_rule == 'with-merges':
477
stop_rev = self.repository.get_revision(stop_revision_id)
478
if stop_rev.parent_ids:
479
left_parent = stop_rev.parent_ids[0]
481
left_parent = _mod_revision.NULL_REVISION
482
for rev_id, depth, revno, end_of_merge in rev_iter:
483
if rev_id == left_parent:
485
yield rev_id, depth, revno, end_of_merge
487
raise ValueError('invalid stop_rule %r' % stop_rule)
489
def leave_lock_in_place(self):
490
"""Tell this branch object not to release the physical lock when this
493
If lock_write doesn't return a token, then this method is not supported.
495
self.control_files.leave_in_place()
497
def dont_leave_lock_in_place(self):
498
"""Tell this branch object to release the physical lock when this
499
object is unlocked, even if it didn't originally acquire it.
501
If lock_write doesn't return a token, then this method is not supported.
503
self.control_files.dont_leave_in_place()
505
def bind(self, other):
506
"""Bind the local branch the other branch.
508
:param other: The branch to bind to
511
raise errors.UpgradeRequired(self.base)
513
def set_reference_info(self, file_id, tree_path, branch_location):
514
"""Set the branch location to use for a tree reference."""
515
raise errors.UnsupportedOperation(self.set_reference_info, self)
517
def get_reference_info(self, file_id):
518
"""Get the tree_path and branch_location for a tree reference."""
519
raise errors.UnsupportedOperation(self.get_reference_info, self)
522
def fetch(self, from_branch, last_revision=None, pb=None):
523
"""Copy revisions from from_branch into this branch.
525
:param from_branch: Where to copy from.
526
:param last_revision: What revision to stop at (None for at the end
528
:param pb: An optional progress bar to use.
531
if self.base == from_branch.base:
534
symbol_versioning.warn(
535
symbol_versioning.deprecated_in((1, 14, 0))
536
% "pb parameter to fetch()")
537
from_branch.lock_read()
539
if last_revision is None:
540
last_revision = from_branch.last_revision()
541
last_revision = _mod_revision.ensure_null(last_revision)
542
return self.repository.fetch(from_branch.repository,
543
revision_id=last_revision,
548
def get_bound_location(self):
549
"""Return the URL of the branch we are bound to.
551
Older format branches cannot bind, please be sure to use a metadir
556
def get_old_bound_location(self):
557
"""Return the URL of the branch we used to be bound to
559
raise errors.UpgradeRequired(self.base)
561
def get_commit_builder(self, parents, config=None, timestamp=None,
562
timezone=None, committer=None, revprops=None,
564
"""Obtain a CommitBuilder for this branch.
566
:param parents: Revision ids of the parents of the new revision.
567
:param config: Optional configuration to use.
568
:param timestamp: Optional timestamp recorded for commit.
569
:param timezone: Optional timezone for timestamp.
570
:param committer: Optional committer to set for commit.
571
:param revprops: Optional dictionary of revision properties.
572
:param revision_id: Optional revision id.
576
config = self.get_config()
578
return self.repository.get_commit_builder(self, parents, config,
579
timestamp, timezone, committer, revprops, revision_id)
581
def get_master_branch(self, possible_transports=None):
582
"""Return the branch we are bound to.
584
:return: Either a Branch, or None
588
def get_revision_delta(self, revno):
589
"""Return the delta for one revision.
591
The delta is relative to its mainline predecessor, or the
592
empty tree for revision 1.
594
rh = self.revision_history()
595
if not (1 <= revno <= len(rh)):
596
raise errors.InvalidRevisionNumber(revno)
597
return self.repository.get_revision_delta(rh[revno-1])
599
def get_stacked_on_url(self):
600
"""Get the URL this branch is stacked against.
602
:raises NotStacked: If the branch is not stacked.
603
:raises UnstackableBranchFormat: If the branch does not support
606
raise NotImplementedError(self.get_stacked_on_url)
608
def print_file(self, file, revision_id):
609
"""Print `file` to stdout."""
610
raise NotImplementedError(self.print_file)
612
def set_revision_history(self, rev_history):
613
raise NotImplementedError(self.set_revision_history)
616
def set_parent(self, url):
617
"""See Branch.set_parent."""
618
# TODO: Maybe delete old location files?
619
# URLs should never be unicode, even on the local fs,
620
# FIXUP this and get_parent in a future branch format bump:
621
# read and rewrite the file. RBC 20060125
623
if isinstance(url, unicode):
625
url = url.encode('ascii')
626
except UnicodeEncodeError:
627
raise errors.InvalidURL(url,
628
"Urls must be 7-bit ascii, "
629
"use bzrlib.urlutils.escape")
630
url = urlutils.relative_url(self.base, url)
631
self._set_parent_location(url)
634
def set_stacked_on_url(self, url):
635
"""Set the URL this branch is stacked against.
637
:raises UnstackableBranchFormat: If the branch does not support
639
:raises UnstackableRepositoryFormat: If the repository does not support
642
if not self._format.supports_stacking():
643
raise errors.UnstackableBranchFormat(self._format, self.base)
644
self._check_stackable_repo()
647
old_url = self.get_stacked_on_url()
648
except (errors.NotStacked, errors.UnstackableBranchFormat,
649
errors.UnstackableRepositoryFormat):
652
# XXX: Lock correctness - should unlock our old repo if we were
654
# repositories don't offer an interface to remove fallback
655
# repositories today; take the conceptually simpler option and just
657
self.repository = self.bzrdir.find_repository()
658
self.repository.lock_write()
659
# for every revision reference the branch has, ensure it is pulled
661
source_repository = self._get_fallback_repository(old_url)
662
for revision_id in chain([self.last_revision()],
663
self.tags.get_reverse_tag_dict()):
664
self.repository.fetch(source_repository, revision_id,
667
self._activate_fallback_location(url, 'write')
668
# write this out after the repository is stacked to avoid setting a
669
# stacked config that doesn't work.
670
self._set_config_location('stacked_on_location', url)
673
def _set_tags_bytes(self, bytes):
674
"""Mirror method for _get_tags_bytes.
676
:seealso: Branch._get_tags_bytes.
678
return _run_with_write_locked_target(self, self._transport.put_bytes,
681
def _cache_revision_history(self, rev_history):
682
"""Set the cached revision history to rev_history.
684
The revision_history method will use this cache to avoid regenerating
685
the revision history.
687
This API is semi-public; it only for use by subclasses, all other code
688
should consider it to be private.
690
self._revision_history_cache = rev_history
692
def _cache_revision_id_to_revno(self, revision_id_to_revno):
693
"""Set the cached revision_id => revno map to revision_id_to_revno.
695
This API is semi-public; it only for use by subclasses, all other code
696
should consider it to be private.
698
self._revision_id_to_revno_cache = revision_id_to_revno
700
def _clear_cached_state(self):
701
"""Clear any cached data on this branch, e.g. cached revision history.
703
This means the next call to revision_history will need to call
704
_gen_revision_history.
706
This API is semi-public; it only for use by subclasses, all other code
707
should consider it to be private.
709
self._revision_history_cache = None
710
self._revision_id_to_revno_cache = None
711
self._last_revision_info_cache = None
712
self._merge_sorted_revisions_cache = None
714
def _gen_revision_history(self):
715
"""Return sequence of revision hashes on to this branch.
717
Unlike revision_history, this method always regenerates or rereads the
718
revision history, i.e. it does not cache the result, so repeated calls
721
Concrete subclasses should override this instead of revision_history so
722
that subclasses do not need to deal with caching logic.
724
This API is semi-public; it only for use by subclasses, all other code
725
should consider it to be private.
727
raise NotImplementedError(self._gen_revision_history)
730
def revision_history(self):
731
"""Return sequence of revision ids on this branch.
733
This method will cache the revision history for as long as it is safe to
736
if 'evil' in debug.debug_flags:
737
mutter_callsite(3, "revision_history scales with history.")
738
if self._revision_history_cache is not None:
739
history = self._revision_history_cache
741
history = self._gen_revision_history()
742
self._cache_revision_history(history)
746
"""Return current revision number for this branch.
748
That is equivalent to the number of revisions committed to
751
return self.last_revision_info()[0]
754
"""Older format branches cannot bind or unbind."""
755
raise errors.UpgradeRequired(self.base)
757
def set_append_revisions_only(self, enabled):
758
"""Older format branches are never restricted to append-only"""
759
raise errors.UpgradeRequired(self.base)
761
def last_revision(self):
762
"""Return last revision id, or NULL_REVISION."""
763
return self.last_revision_info()[1]
766
def last_revision_info(self):
767
"""Return information about the last revision.
769
:return: A tuple (revno, revision_id).
771
if self._last_revision_info_cache is None:
772
self._last_revision_info_cache = self._last_revision_info()
773
return self._last_revision_info_cache
775
def _last_revision_info(self):
776
rh = self.revision_history()
779
return (revno, rh[-1])
781
return (0, _mod_revision.NULL_REVISION)
783
@deprecated_method(deprecated_in((1, 6, 0)))
784
def missing_revisions(self, other, stop_revision=None):
785
"""Return a list of new revisions that would perfectly fit.
787
If self and other have not diverged, return a list of the revisions
788
present in other, but missing from self.
790
self_history = self.revision_history()
791
self_len = len(self_history)
792
other_history = other.revision_history()
793
other_len = len(other_history)
794
common_index = min(self_len, other_len) -1
795
if common_index >= 0 and \
796
self_history[common_index] != other_history[common_index]:
797
raise errors.DivergedBranches(self, other)
799
if stop_revision is None:
800
stop_revision = other_len
802
if stop_revision > other_len:
803
raise errors.NoSuchRevision(self, stop_revision)
804
return other_history[self_len:stop_revision]
807
def update_revisions(self, other, stop_revision=None, overwrite=False,
809
"""Pull in new perfect-fit revisions.
811
:param other: Another Branch to pull from
812
:param stop_revision: Updated until the given revision
813
:param overwrite: Always set the branch pointer, rather than checking
814
to see if it is a proper descendant.
815
:param graph: A Graph object that can be used to query history
816
information. This can be None.
819
return InterBranch.get(other, self).update_revisions(stop_revision,
822
def import_last_revision_info(self, source_repo, revno, revid):
823
"""Set the last revision info, importing from another repo if necessary.
825
This is used by the bound branch code to upload a revision to
826
the master branch first before updating the tip of the local branch.
828
:param source_repo: Source repository to optionally fetch from
829
:param revno: Revision number of the new tip
830
:param revid: Revision id of the new tip
832
if not self.repository.has_same_location(source_repo):
833
self.repository.fetch(source_repo, revision_id=revid)
834
self.set_last_revision_info(revno, revid)
836
def revision_id_to_revno(self, revision_id):
837
"""Given a revision id, return its revno"""
838
if _mod_revision.is_null(revision_id):
840
history = self.revision_history()
842
return history.index(revision_id) + 1
844
raise errors.NoSuchRevision(self, revision_id)
846
def get_rev_id(self, revno, history=None):
847
"""Find the revision id of the specified revno."""
849
return _mod_revision.NULL_REVISION
851
history = self.revision_history()
852
if revno <= 0 or revno > len(history):
853
raise errors.NoSuchRevision(self, revno)
854
return history[revno - 1]
856
def pull(self, source, overwrite=False, stop_revision=None,
857
possible_transports=None, _override_hook_target=None):
858
"""Mirror source into this branch.
860
This branch is considered to be 'local', having low latency.
862
:returns: PullResult instance
864
raise NotImplementedError(self.pull)
866
def push(self, target, overwrite=False, stop_revision=None, *args,
868
"""Mirror this branch into target.
870
This branch is considered to be 'local', having low latency.
872
return InterBranch.get(self, target).push(overwrite, stop_revision,
875
def basis_tree(self):
876
"""Return `Tree` object for last revision."""
877
return self.repository.revision_tree(self.last_revision())
879
def get_parent(self):
880
"""Return the parent location of the branch.
882
This is the default location for pull/missing. The usual
883
pattern is that the user can override it by specifying a
886
parent = self._get_parent_location()
889
# This is an old-format absolute path to a local branch
891
if parent.startswith('/'):
892
parent = urlutils.local_path_to_url(parent.decode('utf8'))
894
return urlutils.join(self.base[:-1], parent)
895
except errors.InvalidURLJoin, e:
896
raise errors.InaccessibleParent(parent, self.base)
898
def _get_parent_location(self):
899
raise NotImplementedError(self._get_parent_location)
901
def _set_config_location(self, name, url, config=None,
902
make_relative=False):
904
config = self.get_config()
908
url = urlutils.relative_url(self.base, url)
909
config.set_user_option(name, url, warn_masked=True)
911
def _get_config_location(self, name, config=None):
913
config = self.get_config()
914
location = config.get_user_option(name)
919
def get_submit_branch(self):
920
"""Return the submit location of the branch.
922
This is the default location for bundle. The usual
923
pattern is that the user can override it by specifying a
926
return self.get_config().get_user_option('submit_branch')
928
def set_submit_branch(self, location):
929
"""Return the submit location of the branch.
931
This is the default location for bundle. The usual
932
pattern is that the user can override it by specifying a
935
self.get_config().set_user_option('submit_branch', location,
938
def get_public_branch(self):
939
"""Return the public location of the branch.
941
This is used by merge directives.
943
return self._get_config_location('public_branch')
945
def set_public_branch(self, location):
946
"""Return the submit location of the branch.
948
This is the default location for bundle. The usual
949
pattern is that the user can override it by specifying a
952
self._set_config_location('public_branch', location)
954
def get_push_location(self):
955
"""Return the None or the location to push this branch to."""
956
push_loc = self.get_config().get_user_option('push_location')
959
def set_push_location(self, location):
960
"""Set a new push location for this branch."""
961
raise NotImplementedError(self.set_push_location)
963
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
964
"""Run the post_change_branch_tip hooks."""
965
hooks = Branch.hooks['post_change_branch_tip']
968
new_revno, new_revid = self.last_revision_info()
969
params = ChangeBranchTipParams(
970
self, old_revno, new_revno, old_revid, new_revid)
974
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
975
"""Run the pre_change_branch_tip hooks."""
976
hooks = Branch.hooks['pre_change_branch_tip']
979
old_revno, old_revid = self.last_revision_info()
980
params = ChangeBranchTipParams(
981
self, old_revno, new_revno, old_revid, new_revid)
985
except errors.TipChangeRejected:
988
exc_info = sys.exc_info()
989
hook_name = Branch.hooks.get_hook_name(hook)
990
raise errors.HookFailed(
991
'pre_change_branch_tip', hook_name, exc_info)
995
"""Synchronise this branch with the master branch if any.
997
:return: None or the last_revision pivoted out during the update.
1001
def check_revno(self, revno):
1003
Check whether a revno corresponds to any revision.
1004
Zero (the NULL revision) is considered valid.
1007
self.check_real_revno(revno)
1009
def check_real_revno(self, revno):
1011
Check whether a revno corresponds to a real revision.
1012
Zero (the NULL revision) is considered invalid
1014
if revno < 1 or revno > self.revno():
1015
raise errors.InvalidRevisionNumber(revno)
1018
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1019
"""Clone this branch into to_bzrdir preserving all semantic values.
1021
Most API users will want 'create_clone_on_transport', which creates a
1022
new bzrdir and branch on the fly.
1024
revision_id: if not None, the revision history in the new branch will
1025
be truncated to end with revision_id.
1027
result = to_bzrdir.create_branch()
1030
if repository_policy is not None:
1031
repository_policy.configure_branch(result)
1032
self.copy_content_into(result, revision_id=revision_id)
1038
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1039
"""Create a new line of development from the branch, into to_bzrdir.
1041
to_bzrdir controls the branch format.
1043
revision_id: if not None, the revision history in the new branch will
1044
be truncated to end with revision_id.
1046
result = to_bzrdir.create_branch()
1049
if repository_policy is not None:
1050
repository_policy.configure_branch(result)
1051
self.copy_content_into(result, revision_id=revision_id)
1052
result.set_parent(self.bzrdir.root_transport.base)
1057
def _synchronize_history(self, destination, revision_id):
1058
"""Synchronize last revision and revision history between branches.
1060
This version is most efficient when the destination is also a
1061
BzrBranch6, but works for BzrBranch5, as long as the destination's
1062
repository contains all the lefthand ancestors of the intended
1063
last_revision. If not, set_last_revision_info will fail.
1065
:param destination: The branch to copy the history into
1066
:param revision_id: The revision-id to truncate history at. May
1067
be None to copy complete history.
1069
source_revno, source_revision_id = self.last_revision_info()
1070
if revision_id is None:
1071
revno, revision_id = source_revno, source_revision_id
1072
elif source_revision_id == revision_id:
1073
# we know the revno without needing to walk all of history
1074
revno = source_revno
1076
# To figure out the revno for a random revision, we need to build
1077
# the revision history, and count its length.
1078
# We don't care about the order, just how long it is.
1079
# Alternatively, we could start at the current location, and count
1080
# backwards. But there is no guarantee that we will find it since
1081
# it may be a merged revision.
1082
revno = len(list(self.repository.iter_reverse_revision_history(
1084
destination.set_last_revision_info(revno, revision_id)
1087
def copy_content_into(self, destination, revision_id=None):
1088
"""Copy the content of self into destination.
1090
revision_id: if not None, the revision history in the new branch will
1091
be truncated to end with revision_id.
1093
self.update_references(destination)
1094
self._synchronize_history(destination, revision_id)
1096
parent = self.get_parent()
1097
except errors.InaccessibleParent, e:
1098
mutter('parent was not accessible to copy: %s', e)
1101
destination.set_parent(parent)
1102
if self._push_should_merge_tags():
1103
self.tags.merge_to(destination.tags)
1105
def update_references(self, target):
1106
if not getattr(self._format, 'supports_reference_locations', False):
1108
reference_dict = self._get_all_reference_info()
1109
if len(reference_dict) == 0:
1111
old_base = self.base
1112
new_base = target.base
1113
target_reference_dict = target._get_all_reference_info()
1114
for file_id, (tree_path, branch_location) in (
1115
reference_dict.items()):
1116
branch_location = urlutils.rebase_url(branch_location,
1118
target_reference_dict.setdefault(
1119
file_id, (tree_path, branch_location))
1120
target._set_all_reference_info(target_reference_dict)
1123
def check(self, refs):
1124
"""Check consistency of the branch.
1126
In particular this checks that revisions given in the revision-history
1127
do actually match up in the revision graph, and that they're all
1128
present in the repository.
1130
Callers will typically also want to check the repository.
1132
:param refs: Calculated refs for this branch as specified by
1133
branch._get_check_refs()
1134
:return: A BranchCheckResult.
1136
result = BranchCheckResult(self)
1137
last_revno, last_revision_id = self.last_revision_info()
1138
actual_revno = refs[('lefthand-distance', last_revision_id)]
1139
if actual_revno != last_revno:
1140
result.errors.append(errors.BzrCheckError(
1141
'revno does not match len(mainline) %s != %s' % (
1142
last_revno, actual_revno)))
1143
# TODO: We should probably also check that self.revision_history
1144
# matches the repository for older branch formats.
1145
# If looking for the code that cross-checks repository parents against
1146
# the iter_reverse_revision_history output, that is now a repository
1150
def _get_checkout_format(self):
1151
"""Return the most suitable metadir for a checkout of this branch.
1152
Weaves are used if this branch's repository uses weaves.
1154
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1155
from bzrlib.repofmt import weaverepo
1156
format = bzrdir.BzrDirMetaFormat1()
1157
format.repository_format = weaverepo.RepositoryFormat7()
1159
format = self.repository.bzrdir.checkout_metadir()
1160
format.set_branch_format(self._format)
1163
def create_clone_on_transport(self, to_transport, revision_id=None,
1164
stacked_on=None, create_prefix=False, use_existing_dir=False):
1165
"""Create a clone of this branch and its bzrdir.
1167
:param to_transport: The transport to clone onto.
1168
:param revision_id: The revision id to use as tip in the new branch.
1169
If None the tip is obtained from this branch.
1170
:param stacked_on: An optional URL to stack the clone on.
1171
:param create_prefix: Create any missing directories leading up to
1173
:param use_existing_dir: Use an existing directory if one exists.
1175
# XXX: Fix the bzrdir API to allow getting the branch back from the
1176
# clone call. Or something. 20090224 RBC/spiv.
1177
if revision_id is None:
1178
revision_id = self.last_revision()
1180
dir_to = self.bzrdir.clone_on_transport(to_transport,
1181
revision_id=revision_id, stacked_on=stacked_on,
1182
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1183
except errors.FileExists:
1184
if not use_existing_dir:
1186
except errors.NoSuchFile:
1187
if not create_prefix:
1189
return dir_to.open_branch()
1191
def create_checkout(self, to_location, revision_id=None,
1192
lightweight=False, accelerator_tree=None,
1194
"""Create a checkout of a branch.
1196
:param to_location: The url to produce the checkout at
1197
:param revision_id: The revision to check out
1198
:param lightweight: If True, produce a lightweight checkout, otherwise,
1199
produce a bound branch (heavyweight checkout)
1200
:param accelerator_tree: A tree which can be used for retrieving file
1201
contents more quickly than the revision tree, i.e. a workingtree.
1202
The revision tree will be used for cases where accelerator_tree's
1203
content is different.
1204
:param hardlink: If true, hard-link files from accelerator_tree,
1206
:return: The tree of the created checkout
1208
t = transport.get_transport(to_location)
1211
format = self._get_checkout_format()
1212
checkout = format.initialize_on_transport(t)
1213
from_branch = BranchReferenceFormat().initialize(checkout, self)
1215
format = self._get_checkout_format()
1216
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1217
to_location, force_new_tree=False, format=format)
1218
checkout = checkout_branch.bzrdir
1219
checkout_branch.bind(self)
1220
# pull up to the specified revision_id to set the initial
1221
# branch tip correctly, and seed it with history.
1222
checkout_branch.pull(self, stop_revision=revision_id)
1224
tree = checkout.create_workingtree(revision_id,
1225
from_branch=from_branch,
1226
accelerator_tree=accelerator_tree,
1228
basis_tree = tree.basis_tree()
1229
basis_tree.lock_read()
1231
for path, file_id in basis_tree.iter_references():
1232
reference_parent = self.reference_parent(file_id, path)
1233
reference_parent.create_checkout(tree.abspath(path),
1234
basis_tree.get_reference_revision(file_id, path),
1241
def reconcile(self, thorough=True):
1242
"""Make sure the data stored in this branch is consistent."""
1243
from bzrlib.reconcile import BranchReconciler
1244
reconciler = BranchReconciler(self, thorough=thorough)
1245
reconciler.reconcile()
1248
def reference_parent(self, file_id, path, possible_transports=None):
1249
"""Return the parent branch for a tree-reference file_id
1250
:param file_id: The file_id of the tree reference
1251
:param path: The path of the file_id in the tree
1252
:return: A branch associated with the file_id
1254
# FIXME should provide multiple branches, based on config
1255
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1256
possible_transports=possible_transports)
1258
def supports_tags(self):
1259
return self._format.supports_tags()
1261
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1263
"""Ensure that revision_b is a descendant of revision_a.
1265
This is a helper function for update_revisions.
1267
:raises: DivergedBranches if revision_b has diverged from revision_a.
1268
:returns: True if revision_b is a descendant of revision_a.
1270
relation = self._revision_relations(revision_a, revision_b, graph)
1271
if relation == 'b_descends_from_a':
1273
elif relation == 'diverged':
1274
raise errors.DivergedBranches(self, other_branch)
1275
elif relation == 'a_descends_from_b':
1278
raise AssertionError("invalid relation: %r" % (relation,))
1280
def _revision_relations(self, revision_a, revision_b, graph):
1281
"""Determine the relationship between two revisions.
1283
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1285
heads = graph.heads([revision_a, revision_b])
1286
if heads == set([revision_b]):
1287
return 'b_descends_from_a'
1288
elif heads == set([revision_a, revision_b]):
1289
# These branches have diverged
1291
elif heads == set([revision_a]):
1292
return 'a_descends_from_b'
1294
raise AssertionError("invalid heads: %r" % (heads,))
1297
class BranchFormat(object):
1298
"""An encapsulation of the initialization and open routines for a format.
1300
Formats provide three things:
1301
* An initialization routine,
1305
Formats are placed in an dict by their format string for reference
1306
during branch opening. Its not required that these be instances, they
1307
can be classes themselves with class methods - it simply depends on
1308
whether state is needed for a given format or not.
1310
Once a format is deprecated, just deprecate the initialize and open
1311
methods on the format class. Do not deprecate the object, as the
1312
object will be created every time regardless.
1315
_default_format = None
1316
"""The default format used for new branches."""
1319
"""The known formats."""
1321
def __eq__(self, other):
1322
return self.__class__ is other.__class__
1324
def __ne__(self, other):
1325
return not (self == other)
1328
def find_format(klass, a_bzrdir):
1329
"""Return the format for the branch object in a_bzrdir."""
1331
transport = a_bzrdir.get_branch_transport(None)
1332
format_string = transport.get("format").read()
1333
return klass._formats[format_string]
1334
except errors.NoSuchFile:
1335
raise errors.NotBranchError(path=transport.base)
1337
raise errors.UnknownFormatError(format=format_string, kind='branch')
1340
def get_default_format(klass):
1341
"""Return the current default format."""
1342
return klass._default_format
1344
def get_reference(self, a_bzrdir):
1345
"""Get the target reference of the branch in a_bzrdir.
1347
format probing must have been completed before calling
1348
this method - it is assumed that the format of the branch
1349
in a_bzrdir is correct.
1351
:param a_bzrdir: The bzrdir to get the branch data from.
1352
:return: None if the branch is not a reference branch.
1357
def set_reference(self, a_bzrdir, to_branch):
1358
"""Set the target reference of the branch in a_bzrdir.
1360
format probing must have been completed before calling
1361
this method - it is assumed that the format of the branch
1362
in a_bzrdir is correct.
1364
:param a_bzrdir: The bzrdir to set the branch reference for.
1365
:param to_branch: branch that the checkout is to reference
1367
raise NotImplementedError(self.set_reference)
1369
def get_format_string(self):
1370
"""Return the ASCII format string that identifies this format."""
1371
raise NotImplementedError(self.get_format_string)
1373
def get_format_description(self):
1374
"""Return the short format description for this format."""
1375
raise NotImplementedError(self.get_format_description)
1377
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1379
"""Initialize a branch in a bzrdir, with specified files
1381
:param a_bzrdir: The bzrdir to initialize the branch in
1382
:param utf8_files: The files to create as a list of
1383
(filename, content) tuples
1384
:param set_format: If True, set the format with
1385
self.get_format_string. (BzrBranch4 has its format set
1387
:return: a branch in this format
1389
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1390
branch_transport = a_bzrdir.get_branch_transport(self)
1392
'metadir': ('lock', lockdir.LockDir),
1393
'branch4': ('branch-lock', lockable_files.TransportLock),
1395
lock_name, lock_class = lock_map[lock_type]
1396
control_files = lockable_files.LockableFiles(branch_transport,
1397
lock_name, lock_class)
1398
control_files.create_lock()
1400
control_files.lock_write()
1401
except errors.LockContention:
1402
if lock_type != 'branch4':
1408
utf8_files += [('format', self.get_format_string())]
1410
for (filename, content) in utf8_files:
1411
branch_transport.put_bytes(
1413
mode=a_bzrdir._get_file_mode())
1416
control_files.unlock()
1417
return self.open(a_bzrdir, _found=True)
1419
def initialize(self, a_bzrdir):
1420
"""Create a branch of this format in a_bzrdir."""
1421
raise NotImplementedError(self.initialize)
1423
def is_supported(self):
1424
"""Is this format supported?
1426
Supported formats can be initialized and opened.
1427
Unsupported formats may not support initialization or committing or
1428
some other features depending on the reason for not being supported.
1432
def make_tags(self, branch):
1433
"""Create a tags object for branch.
1435
This method is on BranchFormat, because BranchFormats are reflected
1436
over the wire via network_name(), whereas full Branch instances require
1437
multiple VFS method calls to operate at all.
1439
The default implementation returns a disabled-tags instance.
1441
Note that it is normal for branch to be a RemoteBranch when using tags
1444
return DisabledTags(branch)
1446
def network_name(self):
1447
"""A simple byte string uniquely identifying this format for RPC calls.
1449
MetaDir branch formats use their disk format string to identify the
1450
repository over the wire. All in one formats such as bzr < 0.8, and
1451
foreign formats like svn/git and hg should use some marker which is
1452
unique and immutable.
1454
raise NotImplementedError(self.network_name)
1456
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1457
"""Return the branch object for a_bzrdir
1459
:param a_bzrdir: A BzrDir that contains a branch.
1460
:param _found: a private parameter, do not use it. It is used to
1461
indicate if format probing has already be done.
1462
:param ignore_fallbacks: when set, no fallback branches will be opened
1463
(if there are any). Default is to open fallbacks.
1465
raise NotImplementedError(self.open)
1468
def register_format(klass, format):
1469
"""Register a metadir format."""
1470
klass._formats[format.get_format_string()] = format
1471
# Metadir formats have a network name of their format string, and get
1472
# registered as class factories.
1473
network_format_registry.register(format.get_format_string(), format.__class__)
1476
def set_default_format(klass, format):
1477
klass._default_format = format
1479
def supports_stacking(self):
1480
"""True if this format records a stacked-on branch."""
1484
def unregister_format(klass, format):
1485
del klass._formats[format.get_format_string()]
1488
return self.get_format_description().rstrip()
1490
def supports_tags(self):
1491
"""True if this format supports tags stored in the branch"""
1492
return False # by default
1495
class BranchHooks(Hooks):
1496
"""A dictionary mapping hook name to a list of callables for branch hooks.
1498
e.g. ['set_rh'] Is the list of items to be called when the
1499
set_revision_history function is invoked.
1503
"""Create the default hooks.
1505
These are all empty initially, because by default nothing should get
1508
Hooks.__init__(self)
1509
self.create_hook(HookPoint('set_rh',
1510
"Invoked whenever the revision history has been set via "
1511
"set_revision_history. The api signature is (branch, "
1512
"revision_history), and the branch will be write-locked. "
1513
"The set_rh hook can be expensive for bzr to trigger, a better "
1514
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1515
self.create_hook(HookPoint('open',
1516
"Called with the Branch object that has been opened after a "
1517
"branch is opened.", (1, 8), None))
1518
self.create_hook(HookPoint('post_push',
1519
"Called after a push operation completes. post_push is called "
1520
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1521
"bzr client.", (0, 15), None))
1522
self.create_hook(HookPoint('post_pull',
1523
"Called after a pull operation completes. post_pull is called "
1524
"with a bzrlib.branch.PullResult object and only runs in the "
1525
"bzr client.", (0, 15), None))
1526
self.create_hook(HookPoint('pre_commit',
1527
"Called after a commit is calculated but before it is is "
1528
"completed. pre_commit is called with (local, master, old_revno, "
1529
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1530
"). old_revid is NULL_REVISION for the first commit to a branch, "
1531
"tree_delta is a TreeDelta object describing changes from the "
1532
"basis revision. hooks MUST NOT modify this delta. "
1533
" future_tree is an in-memory tree obtained from "
1534
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1535
"tree.", (0,91), None))
1536
self.create_hook(HookPoint('post_commit',
1537
"Called in the bzr client after a commit has completed. "
1538
"post_commit is called with (local, master, old_revno, old_revid, "
1539
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1540
"commit to a branch.", (0, 15), None))
1541
self.create_hook(HookPoint('post_uncommit',
1542
"Called in the bzr client after an uncommit completes. "
1543
"post_uncommit is called with (local, master, old_revno, "
1544
"old_revid, new_revno, new_revid) where local is the local branch "
1545
"or None, master is the target branch, and an empty branch "
1546
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1547
self.create_hook(HookPoint('pre_change_branch_tip',
1548
"Called in bzr client and server before a change to the tip of a "
1549
"branch is made. pre_change_branch_tip is called with a "
1550
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1551
"commit, uncommit will all trigger this hook.", (1, 6), None))
1552
self.create_hook(HookPoint('post_change_branch_tip',
1553
"Called in bzr client and server after a change to the tip of a "
1554
"branch is made. post_change_branch_tip is called with a "
1555
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1556
"commit, uncommit will all trigger this hook.", (1, 4), None))
1557
self.create_hook(HookPoint('transform_fallback_location',
1558
"Called when a stacked branch is activating its fallback "
1559
"locations. transform_fallback_location is called with (branch, "
1560
"url), and should return a new url. Returning the same url "
1561
"allows it to be used as-is, returning a different one can be "
1562
"used to cause the branch to stack on a closer copy of that "
1563
"fallback_location. Note that the branch cannot have history "
1564
"accessing methods called on it during this hook because the "
1565
"fallback locations have not been activated. When there are "
1566
"multiple hooks installed for transform_fallback_location, "
1567
"all are called with the url returned from the previous hook."
1568
"The order is however undefined.", (1, 9), None))
1571
# install the default hooks into the Branch class.
1572
Branch.hooks = BranchHooks()
1575
class ChangeBranchTipParams(object):
1576
"""Object holding parameters passed to *_change_branch_tip hooks.
1578
There are 5 fields that hooks may wish to access:
1580
:ivar branch: the branch being changed
1581
:ivar old_revno: revision number before the change
1582
:ivar new_revno: revision number after the change
1583
:ivar old_revid: revision id before the change
1584
:ivar new_revid: revision id after the change
1586
The revid fields are strings. The revno fields are integers.
1589
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1590
"""Create a group of ChangeBranchTip parameters.
1592
:param branch: The branch being changed.
1593
:param old_revno: Revision number before the change.
1594
:param new_revno: Revision number after the change.
1595
:param old_revid: Tip revision id before the change.
1596
:param new_revid: Tip revision id after the change.
1598
self.branch = branch
1599
self.old_revno = old_revno
1600
self.new_revno = new_revno
1601
self.old_revid = old_revid
1602
self.new_revid = new_revid
1604
def __eq__(self, other):
1605
return self.__dict__ == other.__dict__
1608
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1609
self.__class__.__name__, self.branch,
1610
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1613
class BzrBranchFormat4(BranchFormat):
1614
"""Bzr branch format 4.
1617
- a revision-history file.
1618
- a branch-lock lock file [ to be shared with the bzrdir ]
1621
def get_format_description(self):
1622
"""See BranchFormat.get_format_description()."""
1623
return "Branch format 4"
1625
def initialize(self, a_bzrdir):
1626
"""Create a branch of this format in a_bzrdir."""
1627
utf8_files = [('revision-history', ''),
1628
('branch-name', ''),
1630
return self._initialize_helper(a_bzrdir, utf8_files,
1631
lock_type='branch4', set_format=False)
1634
super(BzrBranchFormat4, self).__init__()
1635
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1637
def network_name(self):
1638
"""The network name for this format is the control dirs disk label."""
1639
return self._matchingbzrdir.get_format_string()
1641
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1642
"""See BranchFormat.open()."""
1644
# we are being called directly and must probe.
1645
raise NotImplementedError
1646
return BzrBranch(_format=self,
1647
_control_files=a_bzrdir._control_files,
1649
_repository=a_bzrdir.open_repository())
1652
return "Bazaar-NG branch format 4"
1655
class BranchFormatMetadir(BranchFormat):
1656
"""Common logic for meta-dir based branch formats."""
1658
def _branch_class(self):
1659
"""What class to instantiate on open calls."""
1660
raise NotImplementedError(self._branch_class)
1662
def network_name(self):
1663
"""A simple byte string uniquely identifying this format for RPC calls.
1665
Metadir branch formats use their format string.
1667
return self.get_format_string()
1669
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1670
"""See BranchFormat.open()."""
1672
format = BranchFormat.find_format(a_bzrdir)
1673
if format.__class__ != self.__class__:
1674
raise AssertionError("wrong format %r found for %r" %
1677
transport = a_bzrdir.get_branch_transport(None)
1678
control_files = lockable_files.LockableFiles(transport, 'lock',
1680
return self._branch_class()(_format=self,
1681
_control_files=control_files,
1683
_repository=a_bzrdir.find_repository(),
1684
ignore_fallbacks=ignore_fallbacks)
1685
except errors.NoSuchFile:
1686
raise errors.NotBranchError(path=transport.base)
1689
super(BranchFormatMetadir, self).__init__()
1690
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1691
self._matchingbzrdir.set_branch_format(self)
1693
def supports_tags(self):
1697
class BzrBranchFormat5(BranchFormatMetadir):
1698
"""Bzr branch format 5.
1701
- a revision-history file.
1703
- a lock dir guarding the branch itself
1704
- all of this stored in a branch/ subdirectory
1705
- works with shared repositories.
1707
This format is new in bzr 0.8.
1710
def _branch_class(self):
1713
def get_format_string(self):
1714
"""See BranchFormat.get_format_string()."""
1715
return "Bazaar-NG branch format 5\n"
1717
def get_format_description(self):
1718
"""See BranchFormat.get_format_description()."""
1719
return "Branch format 5"
1721
def initialize(self, a_bzrdir):
1722
"""Create a branch of this format in a_bzrdir."""
1723
utf8_files = [('revision-history', ''),
1724
('branch-name', ''),
1726
return self._initialize_helper(a_bzrdir, utf8_files)
1728
def supports_tags(self):
1732
class BzrBranchFormat6(BranchFormatMetadir):
1733
"""Branch format with last-revision and tags.
1735
Unlike previous formats, this has no explicit revision history. Instead,
1736
this just stores the last-revision, and the left-hand history leading
1737
up to there is the history.
1739
This format was introduced in bzr 0.15
1740
and became the default in 0.91.
1743
def _branch_class(self):
1746
def get_format_string(self):
1747
"""See BranchFormat.get_format_string()."""
1748
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1750
def get_format_description(self):
1751
"""See BranchFormat.get_format_description()."""
1752
return "Branch format 6"
1754
def initialize(self, a_bzrdir):
1755
"""Create a branch of this format in a_bzrdir."""
1756
utf8_files = [('last-revision', '0 null:\n'),
1757
('branch.conf', ''),
1760
return self._initialize_helper(a_bzrdir, utf8_files)
1762
def make_tags(self, branch):
1763
"""See bzrlib.branch.BranchFormat.make_tags()."""
1764
return BasicTags(branch)
1768
class BzrBranchFormat8(BranchFormatMetadir):
1769
"""Metadir format supporting storing locations of subtree branches."""
1771
def _branch_class(self):
1774
def get_format_string(self):
1775
"""See BranchFormat.get_format_string()."""
1776
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1778
def get_format_description(self):
1779
"""See BranchFormat.get_format_description()."""
1780
return "Branch format 8"
1782
def initialize(self, a_bzrdir):
1783
"""Create a branch of this format in a_bzrdir."""
1784
utf8_files = [('last-revision', '0 null:\n'),
1785
('branch.conf', ''),
1789
return self._initialize_helper(a_bzrdir, utf8_files)
1792
super(BzrBranchFormat8, self).__init__()
1793
self._matchingbzrdir.repository_format = \
1794
RepositoryFormatKnitPack5RichRoot()
1796
def make_tags(self, branch):
1797
"""See bzrlib.branch.BranchFormat.make_tags()."""
1798
return BasicTags(branch)
1800
def supports_stacking(self):
1803
supports_reference_locations = True
1806
class BzrBranchFormat7(BzrBranchFormat8):
1807
"""Branch format with last-revision, tags, and a stacked location pointer.
1809
The stacked location pointer is passed down to the repository and requires
1810
a repository format with supports_external_lookups = True.
1812
This format was introduced in bzr 1.6.
1815
def initialize(self, a_bzrdir):
1816
"""Create a branch of this format in a_bzrdir."""
1817
utf8_files = [('last-revision', '0 null:\n'),
1818
('branch.conf', ''),
1821
return self._initialize_helper(a_bzrdir, utf8_files)
1823
def _branch_class(self):
1826
def get_format_string(self):
1827
"""See BranchFormat.get_format_string()."""
1828
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1830
def get_format_description(self):
1831
"""See BranchFormat.get_format_description()."""
1832
return "Branch format 7"
1834
supports_reference_locations = False
1837
class BranchReferenceFormat(BranchFormat):
1838
"""Bzr branch reference format.
1840
Branch references are used in implementing checkouts, they
1841
act as an alias to the real branch which is at some other url.
1848
def get_format_string(self):
1849
"""See BranchFormat.get_format_string()."""
1850
return "Bazaar-NG Branch Reference Format 1\n"
1852
def get_format_description(self):
1853
"""See BranchFormat.get_format_description()."""
1854
return "Checkout reference format 1"
1856
def get_reference(self, a_bzrdir):
1857
"""See BranchFormat.get_reference()."""
1858
transport = a_bzrdir.get_branch_transport(None)
1859
return transport.get('location').read()
1861
def set_reference(self, a_bzrdir, to_branch):
1862
"""See BranchFormat.set_reference()."""
1863
transport = a_bzrdir.get_branch_transport(None)
1864
location = transport.put_bytes('location', to_branch.base)
1866
def initialize(self, a_bzrdir, target_branch=None):
1867
"""Create a branch of this format in a_bzrdir."""
1868
if target_branch is None:
1869
# this format does not implement branch itself, thus the implicit
1870
# creation contract must see it as uninitializable
1871
raise errors.UninitializableFormat(self)
1872
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1873
branch_transport = a_bzrdir.get_branch_transport(self)
1874
branch_transport.put_bytes('location',
1875
target_branch.bzrdir.root_transport.base)
1876
branch_transport.put_bytes('format', self.get_format_string())
1878
a_bzrdir, _found=True,
1879
possible_transports=[target_branch.bzrdir.root_transport])
1882
super(BranchReferenceFormat, self).__init__()
1883
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1884
self._matchingbzrdir.set_branch_format(self)
1886
def _make_reference_clone_function(format, a_branch):
1887
"""Create a clone() routine for a branch dynamically."""
1888
def clone(to_bzrdir, revision_id=None,
1889
repository_policy=None):
1890
"""See Branch.clone()."""
1891
return format.initialize(to_bzrdir, a_branch)
1892
# cannot obey revision_id limits when cloning a reference ...
1893
# FIXME RBC 20060210 either nuke revision_id for clone, or
1894
# emit some sort of warning/error to the caller ?!
1897
def open(self, a_bzrdir, _found=False, location=None,
1898
possible_transports=None, ignore_fallbacks=False):
1899
"""Return the branch that the branch reference in a_bzrdir points at.
1901
:param a_bzrdir: A BzrDir that contains a branch.
1902
:param _found: a private parameter, do not use it. It is used to
1903
indicate if format probing has already be done.
1904
:param ignore_fallbacks: when set, no fallback branches will be opened
1905
(if there are any). Default is to open fallbacks.
1906
:param location: The location of the referenced branch. If
1907
unspecified, this will be determined from the branch reference in
1909
:param possible_transports: An optional reusable transports list.
1912
format = BranchFormat.find_format(a_bzrdir)
1913
if format.__class__ != self.__class__:
1914
raise AssertionError("wrong format %r found for %r" %
1916
if location is None:
1917
location = self.get_reference(a_bzrdir)
1918
real_bzrdir = bzrdir.BzrDir.open(
1919
location, possible_transports=possible_transports)
1920
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1921
# this changes the behaviour of result.clone to create a new reference
1922
# rather than a copy of the content of the branch.
1923
# I did not use a proxy object because that needs much more extensive
1924
# testing, and we are only changing one behaviour at the moment.
1925
# If we decide to alter more behaviours - i.e. the implicit nickname
1926
# then this should be refactored to introduce a tested proxy branch
1927
# and a subclass of that for use in overriding clone() and ....
1929
result.clone = self._make_reference_clone_function(result)
1933
network_format_registry = registry.FormatRegistry()
1934
"""Registry of formats indexed by their network name.
1936
The network name for a branch format is an identifier that can be used when
1937
referring to formats with smart server operations. See
1938
BranchFormat.network_name() for more detail.
1942
# formats which have no format string are not discoverable
1943
# and not independently creatable, so are not registered.
1944
__format5 = BzrBranchFormat5()
1945
__format6 = BzrBranchFormat6()
1946
__format7 = BzrBranchFormat7()
1947
__format8 = BzrBranchFormat8()
1948
BranchFormat.register_format(__format5)
1949
BranchFormat.register_format(BranchReferenceFormat())
1950
BranchFormat.register_format(__format6)
1951
BranchFormat.register_format(__format7)
1952
BranchFormat.register_format(__format8)
1953
BranchFormat.set_default_format(__format6)
1954
_legacy_formats = [BzrBranchFormat4(),
1956
network_format_registry.register(
1957
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1960
class BzrBranch(Branch):
1961
"""A branch stored in the actual filesystem.
1963
Note that it's "local" in the context of the filesystem; it doesn't
1964
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1965
it's writable, and can be accessed via the normal filesystem API.
1967
:ivar _transport: Transport for file operations on this branch's
1968
control files, typically pointing to the .bzr/branch directory.
1969
:ivar repository: Repository for this branch.
1970
:ivar base: The url of the base directory for this branch; the one
1971
containing the .bzr directory.
1974
def __init__(self, _format=None,
1975
_control_files=None, a_bzrdir=None, _repository=None,
1976
ignore_fallbacks=False):
1977
"""Create new branch object at a particular location."""
1978
if a_bzrdir is None:
1979
raise ValueError('a_bzrdir must be supplied')
1981
self.bzrdir = a_bzrdir
1982
self._base = self.bzrdir.transport.clone('..').base
1983
# XXX: We should be able to just do
1984
# self.base = self.bzrdir.root_transport.base
1985
# but this does not quite work yet -- mbp 20080522
1986
self._format = _format
1987
if _control_files is None:
1988
raise ValueError('BzrBranch _control_files is None')
1989
self.control_files = _control_files
1990
self._transport = _control_files._transport
1991
self.repository = _repository
1992
Branch.__init__(self)
1995
return '%s(%r)' % (self.__class__.__name__, self.base)
1999
def _get_base(self):
2000
"""Returns the directory containing the control directory."""
2003
base = property(_get_base, doc="The URL for the root of this branch.")
2005
def _get_config(self):
2006
return TransportConfig(self._transport, 'branch.conf')
2008
def is_locked(self):
2009
return self.control_files.is_locked()
2011
def lock_write(self, token=None):
2012
# All-in-one needs to always unlock/lock.
2013
repo_control = getattr(self.repository, 'control_files', None)
2014
if self.control_files == repo_control or not self.is_locked():
2015
self.repository.lock_write()
2020
return self.control_files.lock_write(token=token)
2023
self.repository.unlock()
2026
def lock_read(self):
2027
# All-in-one needs to always unlock/lock.
2028
repo_control = getattr(self.repository, 'control_files', None)
2029
if self.control_files == repo_control or not self.is_locked():
2030
self.repository.lock_read()
2035
self.control_files.lock_read()
2038
self.repository.unlock()
2043
self.control_files.unlock()
2045
# All-in-one needs to always unlock/lock.
2046
repo_control = getattr(self.repository, 'control_files', None)
2047
if (self.control_files == repo_control or
2048
not self.control_files.is_locked()):
2049
self.repository.unlock()
2050
if not self.control_files.is_locked():
2051
# we just released the lock
2052
self._clear_cached_state()
2054
def peek_lock_mode(self):
2055
if self.control_files._lock_count == 0:
2058
return self.control_files._lock_mode
2060
def get_physical_lock_status(self):
2061
return self.control_files.get_physical_lock_status()
2064
def print_file(self, file, revision_id):
2065
"""See Branch.print_file."""
2066
return self.repository.print_file(file, revision_id)
2068
def _write_revision_history(self, history):
2069
"""Factored out of set_revision_history.
2071
This performs the actual writing to disk.
2072
It is intended to be called by BzrBranch5.set_revision_history."""
2073
self._transport.put_bytes(
2074
'revision-history', '\n'.join(history),
2075
mode=self.bzrdir._get_file_mode())
2078
def set_revision_history(self, rev_history):
2079
"""See Branch.set_revision_history."""
2080
if 'evil' in debug.debug_flags:
2081
mutter_callsite(3, "set_revision_history scales with history.")
2082
check_not_reserved_id = _mod_revision.check_not_reserved_id
2083
for rev_id in rev_history:
2084
check_not_reserved_id(rev_id)
2085
if Branch.hooks['post_change_branch_tip']:
2086
# Don't calculate the last_revision_info() if there are no hooks
2088
old_revno, old_revid = self.last_revision_info()
2089
if len(rev_history) == 0:
2090
revid = _mod_revision.NULL_REVISION
2092
revid = rev_history[-1]
2093
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2094
self._write_revision_history(rev_history)
2095
self._clear_cached_state()
2096
self._cache_revision_history(rev_history)
2097
for hook in Branch.hooks['set_rh']:
2098
hook(self, rev_history)
2099
if Branch.hooks['post_change_branch_tip']:
2100
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2102
def _synchronize_history(self, destination, revision_id):
2103
"""Synchronize last revision and revision history between branches.
2105
This version is most efficient when the destination is also a
2106
BzrBranch5, but works for BzrBranch6 as long as the revision
2107
history is the true lefthand parent history, and all of the revisions
2108
are in the destination's repository. If not, set_revision_history
2111
:param destination: The branch to copy the history into
2112
:param revision_id: The revision-id to truncate history at. May
2113
be None to copy complete history.
2115
if not isinstance(destination._format, BzrBranchFormat5):
2116
super(BzrBranch, self)._synchronize_history(
2117
destination, revision_id)
2119
if revision_id == _mod_revision.NULL_REVISION:
2122
new_history = self.revision_history()
2123
if revision_id is not None and new_history != []:
2125
new_history = new_history[:new_history.index(revision_id) + 1]
2127
rev = self.repository.get_revision(revision_id)
2128
new_history = rev.get_history(self.repository)[1:]
2129
destination.set_revision_history(new_history)
2132
def set_last_revision_info(self, revno, revision_id):
2133
"""Set the last revision of this branch.
2135
The caller is responsible for checking that the revno is correct
2136
for this revision id.
2138
It may be possible to set the branch last revision to an id not
2139
present in the repository. However, branches can also be
2140
configured to check constraints on history, in which case this may not
2143
revision_id = _mod_revision.ensure_null(revision_id)
2144
# this old format stores the full history, but this api doesn't
2145
# provide it, so we must generate, and might as well check it's
2147
history = self._lefthand_history(revision_id)
2148
if len(history) != revno:
2149
raise AssertionError('%d != %d' % (len(history), revno))
2150
self.set_revision_history(history)
2152
def _gen_revision_history(self):
2153
history = self._transport.get_bytes('revision-history').split('\n')
2154
if history[-1:] == ['']:
2155
# There shouldn't be a trailing newline, but just in case.
2160
def generate_revision_history(self, revision_id, last_rev=None,
2162
"""Create a new revision history that will finish with revision_id.
2164
:param revision_id: the new tip to use.
2165
:param last_rev: The previous last_revision. If not None, then this
2166
must be a ancestory of revision_id, or DivergedBranches is raised.
2167
:param other_branch: The other branch that DivergedBranches should
2168
raise with respect to.
2170
self.set_revision_history(self._lefthand_history(revision_id,
2171
last_rev, other_branch))
2173
def basis_tree(self):
2174
"""See Branch.basis_tree."""
2175
return self.repository.revision_tree(self.last_revision())
2178
def pull(self, source, overwrite=False, stop_revision=None,
2179
_hook_master=None, run_hooks=True, possible_transports=None,
2180
_override_hook_target=None):
2183
:param _hook_master: Private parameter - set the branch to
2184
be supplied as the master to pull hooks.
2185
:param run_hooks: Private parameter - if false, this branch
2186
is being called because it's the master of the primary branch,
2187
so it should not run its hooks.
2188
:param _override_hook_target: Private parameter - set the branch to be
2189
supplied as the target_branch to pull hooks.
2191
result = PullResult()
2192
result.source_branch = source
2193
if _override_hook_target is None:
2194
result.target_branch = self
2196
result.target_branch = _override_hook_target
2199
# We assume that during 'pull' the local repository is closer than
2201
source.update_references(self)
2202
graph = self.repository.get_graph(source.repository)
2203
result.old_revno, result.old_revid = self.last_revision_info()
2204
self.update_revisions(source, stop_revision, overwrite=overwrite,
2206
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2207
result.new_revno, result.new_revid = self.last_revision_info()
2209
result.master_branch = _hook_master
2210
result.local_branch = result.target_branch
2212
result.master_branch = result.target_branch
2213
result.local_branch = None
2215
for hook in Branch.hooks['post_pull']:
2221
def _get_parent_location(self):
2222
_locs = ['parent', 'pull', 'x-pull']
2225
return self._transport.get_bytes(l).strip('\n')
2226
except errors.NoSuchFile:
2230
def _basic_push(self, target, overwrite, stop_revision):
2231
"""Basic implementation of push without bound branches or hooks.
2233
Must be called with source read locked and target write locked.
2235
result = BranchPushResult()
2236
result.source_branch = self
2237
result.target_branch = target
2238
result.old_revno, result.old_revid = target.last_revision_info()
2239
self.update_references(target)
2240
if result.old_revid != self.last_revision():
2241
# We assume that during 'push' this repository is closer than
2243
graph = self.repository.get_graph(target.repository)
2244
target.update_revisions(self, stop_revision,
2245
overwrite=overwrite, graph=graph)
2246
if self._push_should_merge_tags():
2247
result.tag_conflicts = self.tags.merge_to(target.tags,
2249
result.new_revno, result.new_revid = target.last_revision_info()
2252
def get_stacked_on_url(self):
2253
raise errors.UnstackableBranchFormat(self._format, self.base)
2255
def set_push_location(self, location):
2256
"""See Branch.set_push_location."""
2257
self.get_config().set_user_option(
2258
'push_location', location,
2259
store=_mod_config.STORE_LOCATION_NORECURSE)
2261
def _set_parent_location(self, url):
2263
self._transport.delete('parent')
2265
self._transport.put_bytes('parent', url + '\n',
2266
mode=self.bzrdir._get_file_mode())
2269
class BzrBranch5(BzrBranch):
2270
"""A format 5 branch. This supports new features over plain branches.
2272
It has support for a master_branch which is the data for bound branches.
2276
def pull(self, source, overwrite=False, stop_revision=None,
2277
run_hooks=True, possible_transports=None,
2278
_override_hook_target=None):
2279
"""Pull from source into self, updating my master if any.
2281
:param run_hooks: Private parameter - if false, this branch
2282
is being called because it's the master of the primary branch,
2283
so it should not run its hooks.
2285
bound_location = self.get_bound_location()
2286
master_branch = None
2287
if bound_location and source.base != bound_location:
2288
# not pulling from master, so we need to update master.
2289
master_branch = self.get_master_branch(possible_transports)
2290
master_branch.lock_write()
2293
# pull from source into master.
2294
master_branch.pull(source, overwrite, stop_revision,
2296
return super(BzrBranch5, self).pull(source, overwrite,
2297
stop_revision, _hook_master=master_branch,
2298
run_hooks=run_hooks,
2299
_override_hook_target=_override_hook_target)
2302
master_branch.unlock()
2304
def get_bound_location(self):
2306
return self._transport.get_bytes('bound')[:-1]
2307
except errors.NoSuchFile:
2311
def get_master_branch(self, possible_transports=None):
2312
"""Return the branch we are bound to.
2314
:return: Either a Branch, or None
2316
This could memoise the branch, but if thats done
2317
it must be revalidated on each new lock.
2318
So for now we just don't memoise it.
2319
# RBC 20060304 review this decision.
2321
bound_loc = self.get_bound_location()
2325
return Branch.open(bound_loc,
2326
possible_transports=possible_transports)
2327
except (errors.NotBranchError, errors.ConnectionError), e:
2328
raise errors.BoundBranchConnectionFailure(
2332
def set_bound_location(self, location):
2333
"""Set the target where this branch is bound to.
2335
:param location: URL to the target branch
2338
self._transport.put_bytes('bound', location+'\n',
2339
mode=self.bzrdir._get_file_mode())
2342
self._transport.delete('bound')
2343
except errors.NoSuchFile:
2348
def bind(self, other):
2349
"""Bind this branch to the branch other.
2351
This does not push or pull data between the branches, though it does
2352
check for divergence to raise an error when the branches are not
2353
either the same, or one a prefix of the other. That behaviour may not
2354
be useful, so that check may be removed in future.
2356
:param other: The branch to bind to
2359
# TODO: jam 20051230 Consider checking if the target is bound
2360
# It is debatable whether you should be able to bind to
2361
# a branch which is itself bound.
2362
# Committing is obviously forbidden,
2363
# but binding itself may not be.
2364
# Since we *have* to check at commit time, we don't
2365
# *need* to check here
2367
# we want to raise diverged if:
2368
# last_rev is not in the other_last_rev history, AND
2369
# other_last_rev is not in our history, and do it without pulling
2371
self.set_bound_location(other.base)
2375
"""If bound, unbind"""
2376
return self.set_bound_location(None)
2379
def update(self, possible_transports=None):
2380
"""Synchronise this branch with the master branch if any.
2382
:return: None or the last_revision that was pivoted out during the
2385
master = self.get_master_branch(possible_transports)
2386
if master is not None:
2387
old_tip = _mod_revision.ensure_null(self.last_revision())
2388
self.pull(master, overwrite=True)
2389
if self.repository.get_graph().is_ancestor(old_tip,
2390
_mod_revision.ensure_null(self.last_revision())):
2396
class BzrBranch8(BzrBranch5):
2397
"""A branch that stores tree-reference locations."""
2399
def _open_hook(self):
2400
if self._ignore_fallbacks:
2403
url = self.get_stacked_on_url()
2404
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2405
errors.UnstackableBranchFormat):
2408
for hook in Branch.hooks['transform_fallback_location']:
2409
url = hook(self, url)
2411
hook_name = Branch.hooks.get_hook_name(hook)
2412
raise AssertionError(
2413
"'transform_fallback_location' hook %s returned "
2414
"None, not a URL." % hook_name)
2415
self._activate_fallback_location(url, None)
2417
def __init__(self, *args, **kwargs):
2418
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2419
super(BzrBranch8, self).__init__(*args, **kwargs)
2420
self._last_revision_info_cache = None
2421
self._partial_revision_history_cache = []
2422
self._reference_info = None
2424
def _clear_cached_state(self):
2425
super(BzrBranch8, self)._clear_cached_state()
2426
self._last_revision_info_cache = None
2427
self._partial_revision_history_cache = []
2428
self._reference_info = None
2430
def _last_revision_info(self):
2431
revision_string = self._transport.get_bytes('last-revision')
2432
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2433
revision_id = cache_utf8.get_cached_utf8(revision_id)
2435
return revno, revision_id
2437
def _write_last_revision_info(self, revno, revision_id):
2438
"""Simply write out the revision id, with no checks.
2440
Use set_last_revision_info to perform this safely.
2442
Does not update the revision_history cache.
2443
Intended to be called by set_last_revision_info and
2444
_write_revision_history.
2446
revision_id = _mod_revision.ensure_null(revision_id)
2447
out_string = '%d %s\n' % (revno, revision_id)
2448
self._transport.put_bytes('last-revision', out_string,
2449
mode=self.bzrdir._get_file_mode())
2452
def set_last_revision_info(self, revno, revision_id):
2453
revision_id = _mod_revision.ensure_null(revision_id)
2454
old_revno, old_revid = self.last_revision_info()
2455
if self._get_append_revisions_only():
2456
self._check_history_violation(revision_id)
2457
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2458
self._write_last_revision_info(revno, revision_id)
2459
self._clear_cached_state()
2460
self._last_revision_info_cache = revno, revision_id
2461
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2463
def _synchronize_history(self, destination, revision_id):
2464
"""Synchronize last revision and revision history between branches.
2466
:see: Branch._synchronize_history
2468
# XXX: The base Branch has a fast implementation of this method based
2469
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2470
# that uses set_revision_history. This class inherits from BzrBranch5,
2471
# but wants the fast implementation, so it calls
2472
# Branch._synchronize_history directly.
2473
Branch._synchronize_history(self, destination, revision_id)
2475
def _check_history_violation(self, revision_id):
2476
last_revision = _mod_revision.ensure_null(self.last_revision())
2477
if _mod_revision.is_null(last_revision):
2479
if last_revision not in self._lefthand_history(revision_id):
2480
raise errors.AppendRevisionsOnlyViolation(self.base)
2482
def _gen_revision_history(self):
2483
"""Generate the revision history from last revision
2485
last_revno, last_revision = self.last_revision_info()
2486
self._extend_partial_history(stop_index=last_revno-1)
2487
return list(reversed(self._partial_revision_history_cache))
2489
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2490
"""Extend the partial history to include a given index
2492
If a stop_index is supplied, stop when that index has been reached.
2493
If a stop_revision is supplied, stop when that revision is
2494
encountered. Otherwise, stop when the beginning of history is
2497
:param stop_index: The index which should be present. When it is
2498
present, history extension will stop.
2499
:param revision_id: The revision id which should be present. When
2500
it is encountered, history extension will stop.
2502
repo = self.repository
2503
if len(self._partial_revision_history_cache) == 0:
2504
iterator = repo.iter_reverse_revision_history(self.last_revision())
2506
start_revision = self._partial_revision_history_cache[-1]
2507
iterator = repo.iter_reverse_revision_history(start_revision)
2508
#skip the last revision in the list
2509
next_revision = iterator.next()
2510
for revision_id in iterator:
2511
self._partial_revision_history_cache.append(revision_id)
2512
if (stop_index is not None and
2513
len(self._partial_revision_history_cache) > stop_index):
2515
if revision_id == stop_revision:
2518
def _write_revision_history(self, history):
2519
"""Factored out of set_revision_history.
2521
This performs the actual writing to disk, with format-specific checks.
2522
It is intended to be called by BzrBranch5.set_revision_history.
2524
if len(history) == 0:
2525
last_revision = 'null:'
2527
if history != self._lefthand_history(history[-1]):
2528
raise errors.NotLefthandHistory(history)
2529
last_revision = history[-1]
2530
if self._get_append_revisions_only():
2531
self._check_history_violation(last_revision)
2532
self._write_last_revision_info(len(history), last_revision)
2535
def _set_parent_location(self, url):
2536
"""Set the parent branch"""
2537
self._set_config_location('parent_location', url, make_relative=True)
2540
def _get_parent_location(self):
2541
"""Set the parent branch"""
2542
return self._get_config_location('parent_location')
2545
def _set_all_reference_info(self, info_dict):
2546
"""Replace all reference info stored in a branch.
2548
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2551
writer = rio.RioWriter(s)
2552
for key, (tree_path, branch_location) in info_dict.iteritems():
2553
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2554
branch_location=branch_location)
2555
writer.write_stanza(stanza)
2556
self._transport.put_bytes('references', s.getvalue())
2557
self._reference_info = info_dict
2560
def _get_all_reference_info(self):
2561
"""Return all the reference info stored in a branch.
2563
:return: A dict of {file_id: (tree_path, branch_location)}
2565
if self._reference_info is not None:
2566
return self._reference_info
2567
rio_file = self._transport.get('references')
2569
stanzas = rio.read_stanzas(rio_file)
2570
info_dict = dict((s['file_id'], (s['tree_path'],
2571
s['branch_location'])) for s in stanzas)
2574
self._reference_info = info_dict
2577
def set_reference_info(self, file_id, tree_path, branch_location):
2578
"""Set the branch location to use for a tree reference.
2580
:param file_id: The file-id of the tree reference.
2581
:param tree_path: The path of the tree reference in the tree.
2582
:param branch_location: The location of the branch to retrieve tree
2585
info_dict = self._get_all_reference_info()
2586
info_dict[file_id] = (tree_path, branch_location)
2587
if None in (tree_path, branch_location):
2588
if tree_path is not None:
2589
raise ValueError('tree_path must be None when branch_location'
2591
if branch_location is not None:
2592
raise ValueError('branch_location must be None when tree_path'
2594
del info_dict[file_id]
2595
self._set_all_reference_info(info_dict)
2597
def get_reference_info(self, file_id):
2598
"""Get the tree_path and branch_location for a tree reference.
2600
:return: a tuple of (tree_path, branch_location)
2602
return self._get_all_reference_info().get(file_id, (None, None))
2604
def reference_parent(self, file_id, path, possible_transports=None):
2605
"""Return the parent branch for a tree-reference file_id.
2607
:param file_id: The file_id of the tree reference
2608
:param path: The path of the file_id in the tree
2609
:return: A branch associated with the file_id
2611
branch_location = self.get_reference_info(file_id)[1]
2612
if branch_location is None:
2613
return Branch.reference_parent(self, file_id, path,
2614
possible_transports)
2615
branch_location = urlutils.join(self.base, branch_location)
2616
return Branch.open(branch_location,
2617
possible_transports=possible_transports)
2619
def set_push_location(self, location):
2620
"""See Branch.set_push_location."""
2621
self._set_config_location('push_location', location)
2623
def set_bound_location(self, location):
2624
"""See Branch.set_push_location."""
2626
config = self.get_config()
2627
if location is None:
2628
if config.get_user_option('bound') != 'True':
2631
config.set_user_option('bound', 'False', warn_masked=True)
2634
self._set_config_location('bound_location', location,
2636
config.set_user_option('bound', 'True', warn_masked=True)
2639
def _get_bound_location(self, bound):
2640
"""Return the bound location in the config file.
2642
Return None if the bound parameter does not match"""
2643
config = self.get_config()
2644
config_bound = (config.get_user_option('bound') == 'True')
2645
if config_bound != bound:
2647
return self._get_config_location('bound_location', config=config)
2649
def get_bound_location(self):
2650
"""See Branch.set_push_location."""
2651
return self._get_bound_location(True)
2653
def get_old_bound_location(self):
2654
"""See Branch.get_old_bound_location"""
2655
return self._get_bound_location(False)
2657
def get_stacked_on_url(self):
2658
# you can always ask for the URL; but you might not be able to use it
2659
# if the repo can't support stacking.
2660
## self._check_stackable_repo()
2661
stacked_url = self._get_config_location('stacked_on_location')
2662
if stacked_url is None:
2663
raise errors.NotStacked(self)
2666
def set_append_revisions_only(self, enabled):
2671
self.get_config().set_user_option('append_revisions_only', value,
2674
def _get_append_revisions_only(self):
2675
value = self.get_config().get_user_option('append_revisions_only')
2676
return value == 'True'
2679
def generate_revision_history(self, revision_id, last_rev=None,
2681
"""See BzrBranch5.generate_revision_history"""
2682
history = self._lefthand_history(revision_id, last_rev, other_branch)
2683
revno = len(history)
2684
self.set_last_revision_info(revno, revision_id)
2687
def get_rev_id(self, revno, history=None):
2688
"""Find the revision id of the specified revno."""
2690
return _mod_revision.NULL_REVISION
2692
last_revno, last_revision_id = self.last_revision_info()
2693
if revno <= 0 or revno > last_revno:
2694
raise errors.NoSuchRevision(self, revno)
2696
if history is not None:
2697
return history[revno - 1]
2699
index = last_revno - revno
2700
if len(self._partial_revision_history_cache) <= index:
2701
self._extend_partial_history(stop_index=index)
2702
if len(self._partial_revision_history_cache) > index:
2703
return self._partial_revision_history_cache[index]
2705
raise errors.NoSuchRevision(self, revno)
2708
def revision_id_to_revno(self, revision_id):
2709
"""Given a revision id, return its revno"""
2710
if _mod_revision.is_null(revision_id):
2713
index = self._partial_revision_history_cache.index(revision_id)
2715
self._extend_partial_history(stop_revision=revision_id)
2716
index = len(self._partial_revision_history_cache) - 1
2717
if self._partial_revision_history_cache[index] != revision_id:
2718
raise errors.NoSuchRevision(self, revision_id)
2719
return self.revno() - index
2722
class BzrBranch7(BzrBranch8):
2723
"""A branch with support for a fallback repository."""
2725
def set_reference_info(self, file_id, tree_path, branch_location):
2726
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2728
def get_reference_info(self, file_id):
2729
Branch.get_reference_info(self, file_id)
2731
def reference_parent(self, file_id, path, possible_transports=None):
2732
return Branch.reference_parent(self, file_id, path,
2733
possible_transports)
2736
class BzrBranch6(BzrBranch7):
2737
"""See BzrBranchFormat6 for the capabilities of this branch.
2739
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2743
def get_stacked_on_url(self):
2744
raise errors.UnstackableBranchFormat(self._format, self.base)
2747
######################################################################
2748
# results of operations
2751
class _Result(object):
2753
def _show_tag_conficts(self, to_file):
2754
if not getattr(self, 'tag_conflicts', None):
2756
to_file.write('Conflicting tags:\n')
2757
for name, value1, value2 in self.tag_conflicts:
2758
to_file.write(' %s\n' % (name, ))
2761
class PullResult(_Result):
2762
"""Result of a Branch.pull operation.
2764
:ivar old_revno: Revision number before pull.
2765
:ivar new_revno: Revision number after pull.
2766
:ivar old_revid: Tip revision id before pull.
2767
:ivar new_revid: Tip revision id after pull.
2768
:ivar source_branch: Source (local) branch object. (read locked)
2769
:ivar master_branch: Master branch of the target, or the target if no
2771
:ivar local_branch: target branch if there is a Master, else None
2772
:ivar target_branch: Target/destination branch object. (write locked)
2773
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2777
# DEPRECATED: pull used to return the change in revno
2778
return self.new_revno - self.old_revno
2780
def report(self, to_file):
2782
if self.old_revid == self.new_revid:
2783
to_file.write('No revisions to pull.\n')
2785
to_file.write('Now on revision %d.\n' % self.new_revno)
2786
self._show_tag_conficts(to_file)
2789
class BranchPushResult(_Result):
2790
"""Result of a Branch.push operation.
2792
:ivar old_revno: Revision number (eg 10) of the target before push.
2793
:ivar new_revno: Revision number (eg 12) of the target after push.
2794
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2796
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2798
:ivar source_branch: Source branch object that the push was from. This is
2799
read locked, and generally is a local (and thus low latency) branch.
2800
:ivar master_branch: If target is a bound branch, the master branch of
2801
target, or target itself. Always write locked.
2802
:ivar target_branch: The direct Branch where data is being sent (write
2804
:ivar local_branch: If the target is a bound branch this will be the
2805
target, otherwise it will be None.
2809
# DEPRECATED: push used to return the change in revno
2810
return self.new_revno - self.old_revno
2812
def report(self, to_file):
2813
"""Write a human-readable description of the result."""
2814
if self.old_revid == self.new_revid:
2815
note('No new revisions to push.')
2817
note('Pushed up to revision %d.' % self.new_revno)
2818
self._show_tag_conficts(to_file)
2821
class BranchCheckResult(object):
2822
"""Results of checking branch consistency.
2827
def __init__(self, branch):
2828
self.branch = branch
2831
def report_results(self, verbose):
2832
"""Report the check results via trace.note.
2834
:param verbose: Requests more detailed display of what was checked,
2837
note('checked branch %s format %s', self.branch.base,
2838
self.branch._format)
2839
for error in self.errors:
2840
note('found error:%s', error)
2843
class Converter5to6(object):
2844
"""Perform an in-place upgrade of format 5 to format 6"""
2846
def convert(self, branch):
2847
# Data for 5 and 6 can peacefully coexist.
2848
format = BzrBranchFormat6()
2849
new_branch = format.open(branch.bzrdir, _found=True)
2851
# Copy source data into target
2852
new_branch._write_last_revision_info(*branch.last_revision_info())
2853
new_branch.set_parent(branch.get_parent())
2854
new_branch.set_bound_location(branch.get_bound_location())
2855
new_branch.set_push_location(branch.get_push_location())
2857
# New branch has no tags by default
2858
new_branch.tags._set_tag_dict({})
2860
# Copying done; now update target format
2861
new_branch._transport.put_bytes('format',
2862
format.get_format_string(),
2863
mode=new_branch.bzrdir._get_file_mode())
2865
# Clean up old files
2866
new_branch._transport.delete('revision-history')
2868
branch.set_parent(None)
2869
except errors.NoSuchFile:
2871
branch.set_bound_location(None)
2874
class Converter6to7(object):
2875
"""Perform an in-place upgrade of format 6 to format 7"""
2877
def convert(self, branch):
2878
format = BzrBranchFormat7()
2879
branch._set_config_location('stacked_on_location', '')
2880
# update target format
2881
branch._transport.put_bytes('format', format.get_format_string())
2884
class Converter7to8(object):
2885
"""Perform an in-place upgrade of format 6 to format 7"""
2887
def convert(self, branch):
2888
format = BzrBranchFormat8()
2889
branch._transport.put_bytes('references', '')
2890
# update target format
2891
branch._transport.put_bytes('format', format.get_format_string())
2894
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2895
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2898
_run_with_write_locked_target will attempt to release the lock it acquires.
2900
If an exception is raised by callable, then that exception *will* be
2901
propagated, even if the unlock attempt raises its own error. Thus
2902
_run_with_write_locked_target should be preferred to simply doing::
2906
return callable(*args, **kwargs)
2911
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2912
# should share code?
2915
result = callable(*args, **kwargs)
2917
exc_info = sys.exc_info()
2921
raise exc_info[0], exc_info[1], exc_info[2]
2927
class InterBranch(InterObject):
2928
"""This class represents operations taking place between two branches.
2930
Its instances have methods like pull() and push() and contain
2931
references to the source and target repositories these operations
2932
can be carried out on.
2936
"""The available optimised InterBranch types."""
2939
def _get_branch_formats_to_test():
2940
"""Return a tuple with the Branch formats to use when testing."""
2941
raise NotImplementedError(self._get_branch_formats_to_test)
2943
def update_revisions(self, stop_revision=None, overwrite=False,
2945
"""Pull in new perfect-fit revisions.
2947
:param stop_revision: Updated until the given revision
2948
:param overwrite: Always set the branch pointer, rather than checking
2949
to see if it is a proper descendant.
2950
:param graph: A Graph object that can be used to query history
2951
information. This can be None.
2954
raise NotImplementedError(self.update_revisions)
2956
def push(self, overwrite=False, stop_revision=None,
2957
_override_hook_source_branch=None):
2958
"""Mirror the source branch into the target branch.
2960
The source branch is considered to be 'local', having low latency.
2962
raise NotImplementedError(self.push)
2965
class GenericInterBranch(InterBranch):
2966
"""InterBranch implementation that uses public Branch functions.
2970
def _get_branch_formats_to_test():
2971
return BranchFormat._default_format, BranchFormat._default_format
2973
def update_revisions(self, stop_revision=None, overwrite=False,
2975
"""See InterBranch.update_revisions()."""
2976
self.source.lock_read()
2978
other_revno, other_last_revision = self.source.last_revision_info()
2979
stop_revno = None # unknown
2980
if stop_revision is None:
2981
stop_revision = other_last_revision
2982
if _mod_revision.is_null(stop_revision):
2983
# if there are no commits, we're done.
2985
stop_revno = other_revno
2987
# what's the current last revision, before we fetch [and change it
2989
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2990
# we fetch here so that we don't process data twice in the common
2991
# case of having something to pull, and so that the check for
2992
# already merged can operate on the just fetched graph, which will
2993
# be cached in memory.
2994
self.target.fetch(self.source, stop_revision)
2995
# Check to see if one is an ancestor of the other
2998
graph = self.target.repository.get_graph()
2999
if self.target._check_if_descendant_or_diverged(
3000
stop_revision, last_rev, graph, self.source):
3001
# stop_revision is a descendant of last_rev, but we aren't
3002
# overwriting, so we're done.
3004
if stop_revno is None:
3006
graph = self.target.repository.get_graph()
3007
this_revno, this_last_revision = \
3008
self.target.last_revision_info()
3009
stop_revno = graph.find_distance_to_null(stop_revision,
3010
[(other_last_revision, other_revno),
3011
(this_last_revision, this_revno)])
3012
self.target.set_last_revision_info(stop_revno, stop_revision)
3014
self.source.unlock()
3016
def push(self, overwrite=False, stop_revision=None,
3017
_override_hook_source_branch=None):
3018
"""See InterBranch.push.
3020
This is the basic concrete implementation of push()
3022
:param _override_hook_source_branch: If specified, run
3023
the hooks passing this Branch as the source, rather than self.
3024
This is for use of RemoteBranch, where push is delegated to the
3025
underlying vfs-based Branch.
3027
# TODO: Public option to disable running hooks - should be trivial but
3029
self.source.lock_read()
3031
return _run_with_write_locked_target(
3032
self.target, self._push_with_bound_branches, overwrite,
3034
_override_hook_source_branch=_override_hook_source_branch)
3036
self.source.unlock()
3038
def _push_with_bound_branches(self, overwrite, stop_revision,
3039
_override_hook_source_branch=None):
3040
"""Push from source into target, and into target's master if any.
3043
if _override_hook_source_branch:
3044
result.source_branch = _override_hook_source_branch
3045
for hook in Branch.hooks['post_push']:
3048
bound_location = self.target.get_bound_location()
3049
if bound_location and self.target.base != bound_location:
3050
# there is a master branch.
3052
# XXX: Why the second check? Is it even supported for a branch to
3053
# be bound to itself? -- mbp 20070507
3054
master_branch = self.target.get_master_branch()
3055
master_branch.lock_write()
3057
# push into the master from the source branch.
3058
self.source._basic_push(master_branch, overwrite, stop_revision)
3059
# and push into the target branch from the source. Note that we
3060
# push from the source branch again, because its considered the
3061
# highest bandwidth repository.
3062
result = self.source._basic_push(self.target, overwrite,
3064
result.master_branch = master_branch
3065
result.local_branch = self.target
3069
master_branch.unlock()
3072
result = self.source._basic_push(self.target, overwrite,
3074
# TODO: Why set master_branch and local_branch if there's no
3075
# binding? Maybe cleaner to just leave them unset? -- mbp
3077
result.master_branch = self.target
3078
result.local_branch = None
3083
def is_compatible(self, source, target):
3084
# GenericBranch uses the public API, so always compatible
3088
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
