1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
from cStringIO import StringIO
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from itertools import chain
27
config as _mod_config,
33
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TransportConfig
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.hooks import HookPoint, Hooks
51
from bzrlib.inter import InterObject
52
from bzrlib import registry
53
from bzrlib.symbol_versioning import (
57
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
60
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
61
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
65
# TODO: Maybe include checks for common corruption of newlines, etc?
67
# TODO: Some operations like log might retrieve the same revisions
68
# repeatedly to calculate deltas. We could perhaps have a weakref
69
# cache in memory to make this faster. In general anything can be
70
# cached in memory between lock and unlock operations. .. nb thats
71
# what the transaction identity map provides
74
######################################################################
78
"""Branch holding a history of revisions.
81
Base directory/url of the branch.
83
hooks: An instance of BranchHooks.
85
# this is really an instance variable - FIXME move it there
89
def __init__(self, *ignored, **ignored_too):
90
self.tags = self._format.make_tags(self)
91
self._revision_history_cache = None
92
self._revision_id_to_revno_cache = None
93
self._partial_revision_id_to_revno_cache = {}
94
self._last_revision_info_cache = None
95
self._merge_sorted_revisions_cache = None
97
hooks = Branch.hooks['open']
101
def _open_hook(self):
102
"""Called by init to allow simpler extension of the base class."""
104
def _activate_fallback_location(self, url, lock_style):
105
"""Activate the branch/repository from url as a fallback repository."""
106
repo = self._get_fallback_repository(url)
107
if lock_style == 'write':
109
elif lock_style == 'read':
111
self.repository.add_fallback_repository(repo)
113
def break_lock(self):
114
"""Break a lock if one is present from another instance.
116
Uses the ui factory to ask for confirmation if the lock may be from
119
This will probe the repository for its lock as well.
121
self.control_files.break_lock()
122
self.repository.break_lock()
123
master = self.get_master_branch()
124
if master is not None:
127
def _check_stackable_repo(self):
128
if not self.repository._format.supports_external_lookups:
129
raise errors.UnstackableRepositoryFormat(self.repository._format,
130
self.repository.base)
133
def open(base, _unsupported=False, possible_transports=None):
134
"""Open the branch rooted at base.
136
For instance, if the branch is at URL/.bzr/branch,
137
Branch.open(URL) -> a Branch instance.
139
control = bzrdir.BzrDir.open(base, _unsupported,
140
possible_transports=possible_transports)
141
return control.open_branch(_unsupported)
144
def open_from_transport(transport, _unsupported=False):
145
"""Open the branch rooted at transport"""
146
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
147
return control.open_branch(_unsupported)
150
def open_containing(url, possible_transports=None):
151
"""Open an existing branch which contains url.
153
This probes for a branch at url, and searches upwards from there.
155
Basically we keep looking up until we find the control directory or
156
run into the root. If there isn't one, raises NotBranchError.
157
If there is one and it is either an unrecognised format or an unsupported
158
format, UnknownFormatError or UnsupportedFormatError are raised.
159
If there is one, it is returned, along with the unused portion of url.
161
control, relpath = bzrdir.BzrDir.open_containing(url,
163
return control.open_branch(), relpath
165
def _push_should_merge_tags(self):
166
"""Should _basic_push merge this branch's tags into the target?
168
The default implementation returns False if this branch has no tags,
169
and True the rest of the time. Subclasses may override this.
171
return self.supports_tags() and self.tags.get_tag_dict()
173
def get_config(self):
174
return BranchConfig(self)
176
def _get_config(self):
177
"""Get the concrete config for just the config in this branch.
179
This is not intended for client use; see Branch.get_config for the
184
:return: An object supporting get_option and set_option.
186
raise NotImplementedError(self._get_config)
188
def _get_fallback_repository(self, url):
189
"""Get the repository we fallback to at url."""
190
url = urlutils.join(self.base, url)
191
a_bzrdir = bzrdir.BzrDir.open(url,
192
possible_transports=[self.bzrdir.root_transport])
193
return a_bzrdir.open_branch().repository
195
def _get_tags_bytes(self):
196
"""Get the bytes of a serialised tags dict.
198
Note that not all branches support tags, nor do all use the same tags
199
logic: this method is specific to BasicTags. Other tag implementations
200
may use the same method name and behave differently, safely, because
201
of the double-dispatch via
202
format.make_tags->tags_instance->get_tags_dict.
204
:return: The bytes of the tags file.
205
:seealso: Branch._set_tags_bytes.
207
return self._transport.get_bytes('tags')
209
def _get_nick(self, local=False, possible_transports=None):
210
config = self.get_config()
211
# explicit overrides master, but don't look for master if local is True
212
if not local and not config.has_explicit_nickname():
214
master = self.get_master_branch(possible_transports)
215
if master is not None:
216
# return the master branch value
218
except errors.BzrError, e:
219
# Silently fall back to local implicit nick if the master is
221
mutter("Could not connect to bound branch, "
222
"falling back to local nick.\n " + str(e))
223
return config.get_nickname()
225
def _set_nick(self, nick):
226
self.get_config().set_user_option('nickname', nick, warn_masked=True)
228
nick = property(_get_nick, _set_nick)
231
raise NotImplementedError(self.is_locked)
233
def _lefthand_history(self, revision_id, last_rev=None,
235
if 'evil' in debug.debug_flags:
236
mutter_callsite(4, "_lefthand_history scales with history.")
237
# stop_revision must be a descendant of last_revision
238
graph = self.repository.get_graph()
239
if last_rev is not None:
240
if not graph.is_ancestor(last_rev, revision_id):
241
# our previous tip is not merged into stop_revision
242
raise errors.DivergedBranches(self, other_branch)
243
# make a new revision history from the graph
244
parents_map = graph.get_parent_map([revision_id])
245
if revision_id not in parents_map:
246
raise errors.NoSuchRevision(self, revision_id)
247
current_rev_id = revision_id
249
check_not_reserved_id = _mod_revision.check_not_reserved_id
250
# Do not include ghosts or graph origin in revision_history
251
while (current_rev_id in parents_map and
252
len(parents_map[current_rev_id]) > 0):
253
check_not_reserved_id(current_rev_id)
254
new_history.append(current_rev_id)
255
current_rev_id = parents_map[current_rev_id][0]
256
parents_map = graph.get_parent_map([current_rev_id])
257
new_history.reverse()
260
def lock_write(self):
261
raise NotImplementedError(self.lock_write)
264
raise NotImplementedError(self.lock_read)
267
raise NotImplementedError(self.unlock)
269
def peek_lock_mode(self):
270
"""Return lock mode for the Branch: 'r', 'w' or None"""
271
raise NotImplementedError(self.peek_lock_mode)
273
def get_physical_lock_status(self):
274
raise NotImplementedError(self.get_physical_lock_status)
277
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
278
"""Return the revision_id for a dotted revno.
280
:param revno: a tuple like (1,) or (1,1,2)
281
:param _cache_reverse: a private parameter enabling storage
282
of the reverse mapping in a top level cache. (This should
283
only be done in selective circumstances as we want to
284
avoid having the mapping cached multiple times.)
285
:return: the revision_id
286
:raises errors.NoSuchRevision: if the revno doesn't exist
288
rev_id = self._do_dotted_revno_to_revision_id(revno)
290
self._partial_revision_id_to_revno_cache[rev_id] = revno
293
def _do_dotted_revno_to_revision_id(self, revno):
294
"""Worker function for dotted_revno_to_revision_id.
296
Subclasses should override this if they wish to
297
provide a more efficient implementation.
300
return self.get_rev_id(revno[0])
301
revision_id_to_revno = self.get_revision_id_to_revno_map()
302
revision_ids = [revision_id for revision_id, this_revno
303
in revision_id_to_revno.iteritems()
304
if revno == this_revno]
305
if len(revision_ids) == 1:
306
return revision_ids[0]
308
revno_str = '.'.join(map(str, revno))
309
raise errors.NoSuchRevision(self, revno_str)
312
def revision_id_to_dotted_revno(self, revision_id):
313
"""Given a revision id, return its dotted revno.
315
:return: a tuple like (1,) or (400,1,3).
317
return self._do_revision_id_to_dotted_revno(revision_id)
319
def _do_revision_id_to_dotted_revno(self, revision_id):
320
"""Worker function for revision_id_to_revno."""
321
# Try the caches if they are loaded
322
result = self._partial_revision_id_to_revno_cache.get(revision_id)
323
if result is not None:
325
if self._revision_id_to_revno_cache:
326
result = self._revision_id_to_revno_cache.get(revision_id)
328
raise errors.NoSuchRevision(self, revision_id)
329
# Try the mainline as it's optimised
331
revno = self.revision_id_to_revno(revision_id)
333
except errors.NoSuchRevision:
334
# We need to load and use the full revno map after all
335
result = self.get_revision_id_to_revno_map().get(revision_id)
337
raise errors.NoSuchRevision(self, revision_id)
341
def get_revision_id_to_revno_map(self):
342
"""Return the revision_id => dotted revno map.
344
This will be regenerated on demand, but will be cached.
346
:return: A dictionary mapping revision_id => dotted revno.
347
This dictionary should not be modified by the caller.
349
if self._revision_id_to_revno_cache is not None:
350
mapping = self._revision_id_to_revno_cache
352
mapping = self._gen_revno_map()
353
self._cache_revision_id_to_revno(mapping)
354
# TODO: jam 20070417 Since this is being cached, should we be returning
356
# I would rather not, and instead just declare that users should not
357
# modify the return value.
360
def _gen_revno_map(self):
361
"""Create a new mapping from revision ids to dotted revnos.
363
Dotted revnos are generated based on the current tip in the revision
365
This is the worker function for get_revision_id_to_revno_map, which
366
just caches the return value.
368
:return: A dictionary mapping revision_id => dotted revno.
370
revision_id_to_revno = dict((rev_id, revno)
371
for rev_id, depth, revno, end_of_merge
372
in self.iter_merge_sorted_revisions())
373
return revision_id_to_revno
376
def iter_merge_sorted_revisions(self, start_revision_id=None,
377
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
378
"""Walk the revisions for a branch in merge sorted order.
380
Merge sorted order is the output from a merge-aware,
381
topological sort, i.e. all parents come before their
382
children going forward; the opposite for reverse.
384
:param start_revision_id: the revision_id to begin walking from.
385
If None, the branch tip is used.
386
:param stop_revision_id: the revision_id to terminate the walk
387
after. If None, the rest of history is included.
388
:param stop_rule: if stop_revision_id is not None, the precise rule
389
to use for termination:
390
* 'exclude' - leave the stop revision out of the result (default)
391
* 'include' - the stop revision is the last item in the result
392
* 'with-merges' - include the stop revision and all of its
393
merged revisions in the result
394
:param direction: either 'reverse' or 'forward':
395
* reverse means return the start_revision_id first, i.e.
396
start at the most recent revision and go backwards in history
397
* forward returns tuples in the opposite order to reverse.
398
Note in particular that forward does *not* do any intelligent
399
ordering w.r.t. depth as some clients of this API may like.
400
(If required, that ought to be done at higher layers.)
402
:return: an iterator over (revision_id, depth, revno, end_of_merge)
405
* revision_id: the unique id of the revision
406
* depth: How many levels of merging deep this node has been
408
* revno_sequence: This field provides a sequence of
409
revision numbers for all revisions. The format is:
410
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
411
branch that the revno is on. From left to right the REVNO numbers
412
are the sequence numbers within that branch of the revision.
413
* end_of_merge: When True the next node (earlier in history) is
414
part of a different merge.
416
# Note: depth and revno values are in the context of the branch so
417
# we need the full graph to get stable numbers, regardless of the
419
if self._merge_sorted_revisions_cache is None:
420
last_revision = self.last_revision()
421
graph = self.repository.get_graph()
422
parent_map = dict(((key, value) for key, value in
423
graph.iter_ancestry([last_revision]) if value is not None))
424
revision_graph = repository._strip_NULL_ghosts(parent_map)
425
revs = tsort.merge_sort(revision_graph, last_revision, None,
427
# Drop the sequence # before caching
428
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
430
filtered = self._filter_merge_sorted_revisions(
431
self._merge_sorted_revisions_cache, start_revision_id,
432
stop_revision_id, stop_rule)
433
if direction == 'reverse':
435
if direction == 'forward':
436
return reversed(list(filtered))
438
raise ValueError('invalid direction %r' % direction)
440
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
441
start_revision_id, stop_revision_id, stop_rule):
442
"""Iterate over an inclusive range of sorted revisions."""
443
rev_iter = iter(merge_sorted_revisions)
444
if start_revision_id is not None:
445
for rev_id, depth, revno, end_of_merge in rev_iter:
446
if rev_id != start_revision_id:
449
# The decision to include the start or not
450
# depends on the stop_rule if a stop is provided
452
iter([(rev_id, depth, revno, end_of_merge)]),
455
if stop_revision_id is None:
456
for rev_id, depth, revno, end_of_merge in rev_iter:
457
yield rev_id, depth, revno, end_of_merge
458
elif stop_rule == 'exclude':
459
for rev_id, depth, revno, end_of_merge in rev_iter:
460
if rev_id == stop_revision_id:
462
yield rev_id, depth, revno, end_of_merge
463
elif stop_rule == 'include':
464
for rev_id, depth, revno, end_of_merge in rev_iter:
465
yield rev_id, depth, revno, end_of_merge
466
if rev_id == stop_revision_id:
468
elif stop_rule == 'with-merges':
469
stop_rev = self.repository.get_revision(stop_revision_id)
470
if stop_rev.parent_ids:
471
left_parent = stop_rev.parent_ids[0]
473
left_parent = _mod_revision.NULL_REVISION
474
for rev_id, depth, revno, end_of_merge in rev_iter:
475
if rev_id == left_parent:
477
yield rev_id, depth, revno, end_of_merge
479
raise ValueError('invalid stop_rule %r' % stop_rule)
481
def leave_lock_in_place(self):
482
"""Tell this branch object not to release the physical lock when this
485
If lock_write doesn't return a token, then this method is not supported.
487
self.control_files.leave_in_place()
489
def dont_leave_lock_in_place(self):
490
"""Tell this branch object to release the physical lock when this
491
object is unlocked, even if it didn't originally acquire it.
493
If lock_write doesn't return a token, then this method is not supported.
495
self.control_files.dont_leave_in_place()
497
def bind(self, other):
498
"""Bind the local branch the other branch.
500
:param other: The branch to bind to
503
raise errors.UpgradeRequired(self.base)
505
def set_reference_info(self, file_id, tree_path, branch_location):
506
"""Set the branch location to use for a tree reference."""
507
raise errors.UnsupportedOperation(self.set_reference_info, self)
509
def get_reference_info(self, file_id):
510
"""Get the tree_path and branch_location for a tree reference."""
511
raise errors.UnsupportedOperation(self.get_reference_info, self)
514
def fetch(self, from_branch, last_revision=None, pb=None):
515
"""Copy revisions from from_branch into this branch.
517
:param from_branch: Where to copy from.
518
:param last_revision: What revision to stop at (None for at the end
520
:param pb: An optional progress bar to use.
523
if self.base == from_branch.base:
526
symbol_versioning.warn(
527
symbol_versioning.deprecated_in((1, 14, 0))
528
% "pb parameter to fetch()")
529
from_branch.lock_read()
531
if last_revision is None:
532
last_revision = from_branch.last_revision()
533
last_revision = _mod_revision.ensure_null(last_revision)
534
return self.repository.fetch(from_branch.repository,
535
revision_id=last_revision,
540
def get_bound_location(self):
541
"""Return the URL of the branch we are bound to.
543
Older format branches cannot bind, please be sure to use a metadir
548
def get_old_bound_location(self):
549
"""Return the URL of the branch we used to be bound to
551
raise errors.UpgradeRequired(self.base)
553
def get_commit_builder(self, parents, config=None, timestamp=None,
554
timezone=None, committer=None, revprops=None,
556
"""Obtain a CommitBuilder for this branch.
558
:param parents: Revision ids of the parents of the new revision.
559
:param config: Optional configuration to use.
560
:param timestamp: Optional timestamp recorded for commit.
561
:param timezone: Optional timezone for timestamp.
562
:param committer: Optional committer to set for commit.
563
:param revprops: Optional dictionary of revision properties.
564
:param revision_id: Optional revision id.
568
config = self.get_config()
570
return self.repository.get_commit_builder(self, parents, config,
571
timestamp, timezone, committer, revprops, revision_id)
573
def get_master_branch(self, possible_transports=None):
574
"""Return the branch we are bound to.
576
:return: Either a Branch, or None
580
def get_revision_delta(self, revno):
581
"""Return the delta for one revision.
583
The delta is relative to its mainline predecessor, or the
584
empty tree for revision 1.
586
rh = self.revision_history()
587
if not (1 <= revno <= len(rh)):
588
raise errors.InvalidRevisionNumber(revno)
589
return self.repository.get_revision_delta(rh[revno-1])
591
def get_stacked_on_url(self):
592
"""Get the URL this branch is stacked against.
594
:raises NotStacked: If the branch is not stacked.
595
:raises UnstackableBranchFormat: If the branch does not support
598
raise NotImplementedError(self.get_stacked_on_url)
600
def print_file(self, file, revision_id):
601
"""Print `file` to stdout."""
602
raise NotImplementedError(self.print_file)
604
def set_revision_history(self, rev_history):
605
raise NotImplementedError(self.set_revision_history)
608
def set_parent(self, url):
609
"""See Branch.set_parent."""
610
# TODO: Maybe delete old location files?
611
# URLs should never be unicode, even on the local fs,
612
# FIXUP this and get_parent in a future branch format bump:
613
# read and rewrite the file. RBC 20060125
615
if isinstance(url, unicode):
617
url = url.encode('ascii')
618
except UnicodeEncodeError:
619
raise errors.InvalidURL(url,
620
"Urls must be 7-bit ascii, "
621
"use bzrlib.urlutils.escape")
622
url = urlutils.relative_url(self.base, url)
623
self._set_parent_location(url)
626
def set_stacked_on_url(self, url):
627
"""Set the URL this branch is stacked against.
629
:raises UnstackableBranchFormat: If the branch does not support
631
:raises UnstackableRepositoryFormat: If the repository does not support
634
if not self._format.supports_stacking():
635
raise errors.UnstackableBranchFormat(self._format, self.base)
636
self._check_stackable_repo()
639
old_url = self.get_stacked_on_url()
640
except (errors.NotStacked, errors.UnstackableBranchFormat,
641
errors.UnstackableRepositoryFormat):
644
# XXX: Lock correctness - should unlock our old repo if we were
646
# repositories don't offer an interface to remove fallback
647
# repositories today; take the conceptually simpler option and just
649
self.repository = self.bzrdir.find_repository()
650
self.repository.lock_write()
651
# for every revision reference the branch has, ensure it is pulled
653
source_repository = self._get_fallback_repository(old_url)
654
for revision_id in chain([self.last_revision()],
655
self.tags.get_reverse_tag_dict()):
656
self.repository.fetch(source_repository, revision_id,
659
self._activate_fallback_location(url, 'write')
660
# write this out after the repository is stacked to avoid setting a
661
# stacked config that doesn't work.
662
self._set_config_location('stacked_on_location', url)
665
def _set_tags_bytes(self, bytes):
666
"""Mirror method for _get_tags_bytes.
668
:seealso: Branch._get_tags_bytes.
670
return _run_with_write_locked_target(self, self._transport.put_bytes,
673
def _cache_revision_history(self, rev_history):
674
"""Set the cached revision history to rev_history.
676
The revision_history method will use this cache to avoid regenerating
677
the revision history.
679
This API is semi-public; it only for use by subclasses, all other code
680
should consider it to be private.
682
self._revision_history_cache = rev_history
684
def _cache_revision_id_to_revno(self, revision_id_to_revno):
685
"""Set the cached revision_id => revno map to revision_id_to_revno.
687
This API is semi-public; it only for use by subclasses, all other code
688
should consider it to be private.
690
self._revision_id_to_revno_cache = revision_id_to_revno
692
def _clear_cached_state(self):
693
"""Clear any cached data on this branch, e.g. cached revision history.
695
This means the next call to revision_history will need to call
696
_gen_revision_history.
698
This API is semi-public; it only for use by subclasses, all other code
699
should consider it to be private.
701
self._revision_history_cache = None
702
self._revision_id_to_revno_cache = None
703
self._last_revision_info_cache = None
704
self._merge_sorted_revisions_cache = None
706
def _gen_revision_history(self):
707
"""Return sequence of revision hashes on to this branch.
709
Unlike revision_history, this method always regenerates or rereads the
710
revision history, i.e. it does not cache the result, so repeated calls
713
Concrete subclasses should override this instead of revision_history so
714
that subclasses do not need to deal with caching logic.
716
This API is semi-public; it only for use by subclasses, all other code
717
should consider it to be private.
719
raise NotImplementedError(self._gen_revision_history)
722
def revision_history(self):
723
"""Return sequence of revision ids on this branch.
725
This method will cache the revision history for as long as it is safe to
728
if 'evil' in debug.debug_flags:
729
mutter_callsite(3, "revision_history scales with history.")
730
if self._revision_history_cache is not None:
731
history = self._revision_history_cache
733
history = self._gen_revision_history()
734
self._cache_revision_history(history)
738
"""Return current revision number for this branch.
740
That is equivalent to the number of revisions committed to
743
return self.last_revision_info()[0]
746
"""Older format branches cannot bind or unbind."""
747
raise errors.UpgradeRequired(self.base)
749
def set_append_revisions_only(self, enabled):
750
"""Older format branches are never restricted to append-only"""
751
raise errors.UpgradeRequired(self.base)
753
def last_revision(self):
754
"""Return last revision id, or NULL_REVISION."""
755
return self.last_revision_info()[1]
758
def last_revision_info(self):
759
"""Return information about the last revision.
761
:return: A tuple (revno, revision_id).
763
if self._last_revision_info_cache is None:
764
self._last_revision_info_cache = self._last_revision_info()
765
return self._last_revision_info_cache
767
def _last_revision_info(self):
768
rh = self.revision_history()
771
return (revno, rh[-1])
773
return (0, _mod_revision.NULL_REVISION)
775
@deprecated_method(deprecated_in((1, 6, 0)))
776
def missing_revisions(self, other, stop_revision=None):
777
"""Return a list of new revisions that would perfectly fit.
779
If self and other have not diverged, return a list of the revisions
780
present in other, but missing from self.
782
self_history = self.revision_history()
783
self_len = len(self_history)
784
other_history = other.revision_history()
785
other_len = len(other_history)
786
common_index = min(self_len, other_len) -1
787
if common_index >= 0 and \
788
self_history[common_index] != other_history[common_index]:
789
raise errors.DivergedBranches(self, other)
791
if stop_revision is None:
792
stop_revision = other_len
794
if stop_revision > other_len:
795
raise errors.NoSuchRevision(self, stop_revision)
796
return other_history[self_len:stop_revision]
799
def update_revisions(self, other, stop_revision=None, overwrite=False,
801
"""Pull in new perfect-fit revisions.
803
:param other: Another Branch to pull from
804
:param stop_revision: Updated until the given revision
805
:param overwrite: Always set the branch pointer, rather than checking
806
to see if it is a proper descendant.
807
:param graph: A Graph object that can be used to query history
808
information. This can be None.
811
return InterBranch.get(other, self).update_revisions(stop_revision,
814
def import_last_revision_info(self, source_repo, revno, revid):
815
"""Set the last revision info, importing from another repo if necessary.
817
This is used by the bound branch code to upload a revision to
818
the master branch first before updating the tip of the local branch.
820
:param source_repo: Source repository to optionally fetch from
821
:param revno: Revision number of the new tip
822
:param revid: Revision id of the new tip
824
if not self.repository.has_same_location(source_repo):
825
self.repository.fetch(source_repo, revision_id=revid)
826
self.set_last_revision_info(revno, revid)
828
def revision_id_to_revno(self, revision_id):
829
"""Given a revision id, return its revno"""
830
if _mod_revision.is_null(revision_id):
832
history = self.revision_history()
834
return history.index(revision_id) + 1
836
raise errors.NoSuchRevision(self, revision_id)
838
def get_rev_id(self, revno, history=None):
839
"""Find the revision id of the specified revno."""
841
return _mod_revision.NULL_REVISION
843
history = self.revision_history()
844
if revno <= 0 or revno > len(history):
845
raise errors.NoSuchRevision(self, revno)
846
return history[revno - 1]
848
def pull(self, source, overwrite=False, stop_revision=None,
849
possible_transports=None, _override_hook_target=None):
850
"""Mirror source into this branch.
852
This branch is considered to be 'local', having low latency.
854
:returns: PullResult instance
856
raise NotImplementedError(self.pull)
858
def push(self, target, overwrite=False, stop_revision=None, *args,
860
"""Mirror this branch into target.
862
This branch is considered to be 'local', having low latency.
864
return InterBranch.get(self, target).push(overwrite, stop_revision,
867
def basis_tree(self):
868
"""Return `Tree` object for last revision."""
869
return self.repository.revision_tree(self.last_revision())
871
def get_parent(self):
872
"""Return the parent location of the branch.
874
This is the default location for pull/missing. The usual
875
pattern is that the user can override it by specifying a
878
parent = self._get_parent_location()
881
# This is an old-format absolute path to a local branch
883
if parent.startswith('/'):
884
parent = urlutils.local_path_to_url(parent.decode('utf8'))
886
return urlutils.join(self.base[:-1], parent)
887
except errors.InvalidURLJoin, e:
888
raise errors.InaccessibleParent(parent, self.base)
890
def _get_parent_location(self):
891
raise NotImplementedError(self._get_parent_location)
893
def _set_config_location(self, name, url, config=None,
894
make_relative=False):
896
config = self.get_config()
900
url = urlutils.relative_url(self.base, url)
901
config.set_user_option(name, url, warn_masked=True)
903
def _get_config_location(self, name, config=None):
905
config = self.get_config()
906
location = config.get_user_option(name)
911
def get_submit_branch(self):
912
"""Return the submit location of the branch.
914
This is the default location for bundle. The usual
915
pattern is that the user can override it by specifying a
918
return self.get_config().get_user_option('submit_branch')
920
def set_submit_branch(self, location):
921
"""Return the submit location of the branch.
923
This is the default location for bundle. The usual
924
pattern is that the user can override it by specifying a
927
self.get_config().set_user_option('submit_branch', location,
930
def get_public_branch(self):
931
"""Return the public location of the branch.
933
This is used by merge directives.
935
return self._get_config_location('public_branch')
937
def set_public_branch(self, location):
938
"""Return the submit location of the branch.
940
This is the default location for bundle. The usual
941
pattern is that the user can override it by specifying a
944
self._set_config_location('public_branch', location)
946
def get_push_location(self):
947
"""Return the None or the location to push this branch to."""
948
push_loc = self.get_config().get_user_option('push_location')
951
def set_push_location(self, location):
952
"""Set a new push location for this branch."""
953
raise NotImplementedError(self.set_push_location)
955
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
956
"""Run the post_change_branch_tip hooks."""
957
hooks = Branch.hooks['post_change_branch_tip']
960
new_revno, new_revid = self.last_revision_info()
961
params = ChangeBranchTipParams(
962
self, old_revno, new_revno, old_revid, new_revid)
966
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
967
"""Run the pre_change_branch_tip hooks."""
968
hooks = Branch.hooks['pre_change_branch_tip']
971
old_revno, old_revid = self.last_revision_info()
972
params = ChangeBranchTipParams(
973
self, old_revno, new_revno, old_revid, new_revid)
977
except errors.TipChangeRejected:
980
exc_info = sys.exc_info()
981
hook_name = Branch.hooks.get_hook_name(hook)
982
raise errors.HookFailed(
983
'pre_change_branch_tip', hook_name, exc_info)
987
"""Synchronise this branch with the master branch if any.
989
:return: None or the last_revision pivoted out during the update.
993
def check_revno(self, revno):
995
Check whether a revno corresponds to any revision.
996
Zero (the NULL revision) is considered valid.
999
self.check_real_revno(revno)
1001
def check_real_revno(self, revno):
1003
Check whether a revno corresponds to a real revision.
1004
Zero (the NULL revision) is considered invalid
1006
if revno < 1 or revno > self.revno():
1007
raise errors.InvalidRevisionNumber(revno)
1010
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1011
"""Clone this branch into to_bzrdir preserving all semantic values.
1013
Most API users will want 'create_clone_on_transport', which creates a
1014
new bzrdir and branch on the fly.
1016
revision_id: if not None, the revision history in the new branch will
1017
be truncated to end with revision_id.
1019
result = to_bzrdir.create_branch()
1022
if repository_policy is not None:
1023
repository_policy.configure_branch(result)
1024
self.copy_content_into(result, revision_id=revision_id)
1030
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1031
"""Create a new line of development from the branch, into to_bzrdir.
1033
to_bzrdir controls the branch format.
1035
revision_id: if not None, the revision history in the new branch will
1036
be truncated to end with revision_id.
1038
result = to_bzrdir.create_branch()
1041
if repository_policy is not None:
1042
repository_policy.configure_branch(result)
1043
self.copy_content_into(result, revision_id=revision_id)
1044
result.set_parent(self.bzrdir.root_transport.base)
1049
def _synchronize_history(self, destination, revision_id):
1050
"""Synchronize last revision and revision history between branches.
1052
This version is most efficient when the destination is also a
1053
BzrBranch6, but works for BzrBranch5, as long as the destination's
1054
repository contains all the lefthand ancestors of the intended
1055
last_revision. If not, set_last_revision_info will fail.
1057
:param destination: The branch to copy the history into
1058
:param revision_id: The revision-id to truncate history at. May
1059
be None to copy complete history.
1061
source_revno, source_revision_id = self.last_revision_info()
1062
if revision_id is None:
1063
revno, revision_id = source_revno, source_revision_id
1064
elif source_revision_id == revision_id:
1065
# we know the revno without needing to walk all of history
1066
revno = source_revno
1068
# To figure out the revno for a random revision, we need to build
1069
# the revision history, and count its length.
1070
# We don't care about the order, just how long it is.
1071
# Alternatively, we could start at the current location, and count
1072
# backwards. But there is no guarantee that we will find it since
1073
# it may be a merged revision.
1074
revno = len(list(self.repository.iter_reverse_revision_history(
1076
destination.set_last_revision_info(revno, revision_id)
1079
def copy_content_into(self, destination, revision_id=None):
1080
"""Copy the content of self into destination.
1082
revision_id: if not None, the revision history in the new branch will
1083
be truncated to end with revision_id.
1085
self.update_references(destination)
1086
self._synchronize_history(destination, revision_id)
1088
parent = self.get_parent()
1089
except errors.InaccessibleParent, e:
1090
mutter('parent was not accessible to copy: %s', e)
1093
destination.set_parent(parent)
1094
if self._push_should_merge_tags():
1095
self.tags.merge_to(destination.tags)
1097
def update_references(self, target):
1098
if not getattr(self._format, 'supports_reference_locations', False):
1100
reference_dict = self._get_all_reference_info()
1101
if len(reference_dict) == 0:
1103
old_base = self.base
1104
new_base = target.base
1105
target_reference_dict = target._get_all_reference_info()
1106
for file_id, (tree_path, branch_location) in (
1107
reference_dict.items()):
1108
branch_location = urlutils.rebase_url(branch_location,
1110
target_reference_dict.setdefault(
1111
file_id, (tree_path, branch_location))
1112
target._set_all_reference_info(target_reference_dict)
1116
"""Check consistency of the branch.
1118
In particular this checks that revisions given in the revision-history
1119
do actually match up in the revision graph, and that they're all
1120
present in the repository.
1122
Callers will typically also want to check the repository.
1124
:return: A BranchCheckResult.
1126
mainline_parent_id = None
1127
last_revno, last_revision_id = self.last_revision_info()
1128
real_rev_history = list(self.repository.iter_reverse_revision_history(
1130
real_rev_history.reverse()
1131
if len(real_rev_history) != last_revno:
1132
raise errors.BzrCheckError('revno does not match len(mainline)'
1133
' %s != %s' % (last_revno, len(real_rev_history)))
1134
# TODO: We should probably also check that real_rev_history actually
1135
# matches self.revision_history()
1136
for revision_id in real_rev_history:
1138
revision = self.repository.get_revision(revision_id)
1139
except errors.NoSuchRevision, e:
1140
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1142
# In general the first entry on the revision history has no parents.
1143
# But it's not illegal for it to have parents listed; this can happen
1144
# in imports from Arch when the parents weren't reachable.
1145
if mainline_parent_id is not None:
1146
if mainline_parent_id not in revision.parent_ids:
1147
raise errors.BzrCheckError("previous revision {%s} not listed among "
1149
% (mainline_parent_id, revision_id))
1150
mainline_parent_id = revision_id
1151
return BranchCheckResult(self)
1153
def _get_checkout_format(self):
1154
"""Return the most suitable metadir for a checkout of this branch.
1155
Weaves are used if this branch's repository uses weaves.
1157
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1158
from bzrlib.repofmt import weaverepo
1159
format = bzrdir.BzrDirMetaFormat1()
1160
format.repository_format = weaverepo.RepositoryFormat7()
1162
format = self.repository.bzrdir.checkout_metadir()
1163
format.set_branch_format(self._format)
1166
def create_clone_on_transport(self, to_transport, revision_id=None,
1167
stacked_on=None, create_prefix=False, use_existing_dir=False):
1168
"""Create a clone of this branch and its bzrdir.
1170
:param to_transport: The transport to clone onto.
1171
:param revision_id: The revision id to use as tip in the new branch.
1172
If None the tip is obtained from this branch.
1173
:param stacked_on: An optional URL to stack the clone on.
1174
:param create_prefix: Create any missing directories leading up to
1176
:param use_existing_dir: Use an existing directory if one exists.
1178
# XXX: Fix the bzrdir API to allow getting the branch back from the
1179
# clone call. Or something. 20090224 RBC/spiv.
1180
if revision_id is None:
1181
revision_id = self.last_revision()
1183
dir_to = self.bzrdir.clone_on_transport(to_transport,
1184
revision_id=revision_id, stacked_on=stacked_on,
1185
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1186
except errors.FileExists:
1187
if not use_existing_dir:
1189
except errors.NoSuchFile:
1190
if not create_prefix:
1192
return dir_to.open_branch()
1194
def create_checkout(self, to_location, revision_id=None,
1195
lightweight=False, accelerator_tree=None,
1197
"""Create a checkout of a branch.
1199
:param to_location: The url to produce the checkout at
1200
:param revision_id: The revision to check out
1201
:param lightweight: If True, produce a lightweight checkout, otherwise,
1202
produce a bound branch (heavyweight checkout)
1203
:param accelerator_tree: A tree which can be used for retrieving file
1204
contents more quickly than the revision tree, i.e. a workingtree.
1205
The revision tree will be used for cases where accelerator_tree's
1206
content is different.
1207
:param hardlink: If true, hard-link files from accelerator_tree,
1209
:return: The tree of the created checkout
1211
t = transport.get_transport(to_location)
1214
format = self._get_checkout_format()
1215
checkout = format.initialize_on_transport(t)
1216
from_branch = BranchReferenceFormat().initialize(checkout, self)
1218
format = self._get_checkout_format()
1219
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1220
to_location, force_new_tree=False, format=format)
1221
checkout = checkout_branch.bzrdir
1222
checkout_branch.bind(self)
1223
# pull up to the specified revision_id to set the initial
1224
# branch tip correctly, and seed it with history.
1225
checkout_branch.pull(self, stop_revision=revision_id)
1227
tree = checkout.create_workingtree(revision_id,
1228
from_branch=from_branch,
1229
accelerator_tree=accelerator_tree,
1231
basis_tree = tree.basis_tree()
1232
basis_tree.lock_read()
1234
for path, file_id in basis_tree.iter_references():
1235
reference_parent = self.reference_parent(file_id, path)
1236
reference_parent.create_checkout(tree.abspath(path),
1237
basis_tree.get_reference_revision(file_id, path),
1244
def reconcile(self, thorough=True):
1245
"""Make sure the data stored in this branch is consistent."""
1246
from bzrlib.reconcile import BranchReconciler
1247
reconciler = BranchReconciler(self, thorough=thorough)
1248
reconciler.reconcile()
1251
def reference_parent(self, file_id, path, possible_transports=None):
1252
"""Return the parent branch for a tree-reference file_id
1253
:param file_id: The file_id of the tree reference
1254
:param path: The path of the file_id in the tree
1255
:return: A branch associated with the file_id
1257
# FIXME should provide multiple branches, based on config
1258
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1259
possible_transports=possible_transports)
1261
def supports_tags(self):
1262
return self._format.supports_tags()
1264
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1266
"""Ensure that revision_b is a descendant of revision_a.
1268
This is a helper function for update_revisions.
1270
:raises: DivergedBranches if revision_b has diverged from revision_a.
1271
:returns: True if revision_b is a descendant of revision_a.
1273
relation = self._revision_relations(revision_a, revision_b, graph)
1274
if relation == 'b_descends_from_a':
1276
elif relation == 'diverged':
1277
raise errors.DivergedBranches(self, other_branch)
1278
elif relation == 'a_descends_from_b':
1281
raise AssertionError("invalid relation: %r" % (relation,))
1283
def _revision_relations(self, revision_a, revision_b, graph):
1284
"""Determine the relationship between two revisions.
1286
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1288
heads = graph.heads([revision_a, revision_b])
1289
if heads == set([revision_b]):
1290
return 'b_descends_from_a'
1291
elif heads == set([revision_a, revision_b]):
1292
# These branches have diverged
1294
elif heads == set([revision_a]):
1295
return 'a_descends_from_b'
1297
raise AssertionError("invalid heads: %r" % (heads,))
1300
class BranchFormat(object):
1301
"""An encapsulation of the initialization and open routines for a format.
1303
Formats provide three things:
1304
* An initialization routine,
1308
Formats are placed in an dict by their format string for reference
1309
during branch opening. Its not required that these be instances, they
1310
can be classes themselves with class methods - it simply depends on
1311
whether state is needed for a given format or not.
1313
Once a format is deprecated, just deprecate the initialize and open
1314
methods on the format class. Do not deprecate the object, as the
1315
object will be created every time regardless.
1318
_default_format = None
1319
"""The default format used for new branches."""
1322
"""The known formats."""
1324
def __eq__(self, other):
1325
return self.__class__ is other.__class__
1327
def __ne__(self, other):
1328
return not (self == other)
1331
def find_format(klass, a_bzrdir):
1332
"""Return the format for the branch object in a_bzrdir."""
1334
transport = a_bzrdir.get_branch_transport(None)
1335
format_string = transport.get("format").read()
1336
return klass._formats[format_string]
1337
except errors.NoSuchFile:
1338
raise errors.NotBranchError(path=transport.base)
1340
raise errors.UnknownFormatError(format=format_string, kind='branch')
1343
def get_default_format(klass):
1344
"""Return the current default format."""
1345
return klass._default_format
1347
def get_reference(self, a_bzrdir):
1348
"""Get the target reference of the branch in a_bzrdir.
1350
format probing must have been completed before calling
1351
this method - it is assumed that the format of the branch
1352
in a_bzrdir is correct.
1354
:param a_bzrdir: The bzrdir to get the branch data from.
1355
:return: None if the branch is not a reference branch.
1360
def set_reference(self, a_bzrdir, to_branch):
1361
"""Set the target reference of the branch in a_bzrdir.
1363
format probing must have been completed before calling
1364
this method - it is assumed that the format of the branch
1365
in a_bzrdir is correct.
1367
:param a_bzrdir: The bzrdir to set the branch reference for.
1368
:param to_branch: branch that the checkout is to reference
1370
raise NotImplementedError(self.set_reference)
1372
def get_format_string(self):
1373
"""Return the ASCII format string that identifies this format."""
1374
raise NotImplementedError(self.get_format_string)
1376
def get_format_description(self):
1377
"""Return the short format description for this format."""
1378
raise NotImplementedError(self.get_format_description)
1380
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1382
"""Initialize a branch in a bzrdir, with specified files
1384
:param a_bzrdir: The bzrdir to initialize the branch in
1385
:param utf8_files: The files to create as a list of
1386
(filename, content) tuples
1387
:param set_format: If True, set the format with
1388
self.get_format_string. (BzrBranch4 has its format set
1390
:return: a branch in this format
1392
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1393
branch_transport = a_bzrdir.get_branch_transport(self)
1395
'metadir': ('lock', lockdir.LockDir),
1396
'branch4': ('branch-lock', lockable_files.TransportLock),
1398
lock_name, lock_class = lock_map[lock_type]
1399
control_files = lockable_files.LockableFiles(branch_transport,
1400
lock_name, lock_class)
1401
control_files.create_lock()
1403
control_files.lock_write()
1404
except errors.LockContention:
1405
if lock_type != 'branch4':
1411
utf8_files += [('format', self.get_format_string())]
1413
for (filename, content) in utf8_files:
1414
branch_transport.put_bytes(
1416
mode=a_bzrdir._get_file_mode())
1419
control_files.unlock()
1420
return self.open(a_bzrdir, _found=True)
1422
def initialize(self, a_bzrdir):
1423
"""Create a branch of this format in a_bzrdir."""
1424
raise NotImplementedError(self.initialize)
1426
def is_supported(self):
1427
"""Is this format supported?
1429
Supported formats can be initialized and opened.
1430
Unsupported formats may not support initialization or committing or
1431
some other features depending on the reason for not being supported.
1435
def make_tags(self, branch):
1436
"""Create a tags object for branch.
1438
This method is on BranchFormat, because BranchFormats are reflected
1439
over the wire via network_name(), whereas full Branch instances require
1440
multiple VFS method calls to operate at all.
1442
The default implementation returns a disabled-tags instance.
1444
Note that it is normal for branch to be a RemoteBranch when using tags
1447
return DisabledTags(branch)
1449
def network_name(self):
1450
"""A simple byte string uniquely identifying this format for RPC calls.
1452
MetaDir branch formats use their disk format string to identify the
1453
repository over the wire. All in one formats such as bzr < 0.8, and
1454
foreign formats like svn/git and hg should use some marker which is
1455
unique and immutable.
1457
raise NotImplementedError(self.network_name)
1459
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1460
"""Return the branch object for a_bzrdir
1462
:param a_bzrdir: A BzrDir that contains a branch.
1463
:param _found: a private parameter, do not use it. It is used to
1464
indicate if format probing has already be done.
1465
:param ignore_fallbacks: when set, no fallback branches will be opened
1466
(if there are any). Default is to open fallbacks.
1468
raise NotImplementedError(self.open)
1471
def register_format(klass, format):
1472
"""Register a metadir format."""
1473
klass._formats[format.get_format_string()] = format
1474
# Metadir formats have a network name of their format string, and get
1475
# registered as class factories.
1476
network_format_registry.register(format.get_format_string(), format.__class__)
1479
def set_default_format(klass, format):
1480
klass._default_format = format
1482
def supports_stacking(self):
1483
"""True if this format records a stacked-on branch."""
1487
def unregister_format(klass, format):
1488
del klass._formats[format.get_format_string()]
1491
return self.get_format_description().rstrip()
1493
def supports_tags(self):
1494
"""True if this format supports tags stored in the branch"""
1495
return False # by default
1498
class BranchHooks(Hooks):
1499
"""A dictionary mapping hook name to a list of callables for branch hooks.
1501
e.g. ['set_rh'] Is the list of items to be called when the
1502
set_revision_history function is invoked.
1506
"""Create the default hooks.
1508
These are all empty initially, because by default nothing should get
1511
Hooks.__init__(self)
1512
self.create_hook(HookPoint('set_rh',
1513
"Invoked whenever the revision history has been set via "
1514
"set_revision_history. The api signature is (branch, "
1515
"revision_history), and the branch will be write-locked. "
1516
"The set_rh hook can be expensive for bzr to trigger, a better "
1517
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1518
self.create_hook(HookPoint('open',
1519
"Called with the Branch object that has been opened after a "
1520
"branch is opened.", (1, 8), None))
1521
self.create_hook(HookPoint('post_push',
1522
"Called after a push operation completes. post_push is called "
1523
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1524
"bzr client.", (0, 15), None))
1525
self.create_hook(HookPoint('post_pull',
1526
"Called after a pull operation completes. post_pull is called "
1527
"with a bzrlib.branch.PullResult object and only runs in the "
1528
"bzr client.", (0, 15), None))
1529
self.create_hook(HookPoint('pre_commit',
1530
"Called after a commit is calculated but before it is is "
1531
"completed. pre_commit is called with (local, master, old_revno, "
1532
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1533
"). old_revid is NULL_REVISION for the first commit to a branch, "
1534
"tree_delta is a TreeDelta object describing changes from the "
1535
"basis revision. hooks MUST NOT modify this delta. "
1536
" future_tree is an in-memory tree obtained from "
1537
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1538
"tree.", (0,91), None))
1539
self.create_hook(HookPoint('post_commit',
1540
"Called in the bzr client after a commit has completed. "
1541
"post_commit is called with (local, master, old_revno, old_revid, "
1542
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1543
"commit to a branch.", (0, 15), None))
1544
self.create_hook(HookPoint('post_uncommit',
1545
"Called in the bzr client after an uncommit completes. "
1546
"post_uncommit is called with (local, master, old_revno, "
1547
"old_revid, new_revno, new_revid) where local is the local branch "
1548
"or None, master is the target branch, and an empty branch "
1549
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1550
self.create_hook(HookPoint('pre_change_branch_tip',
1551
"Called in bzr client and server before a change to the tip of a "
1552
"branch is made. pre_change_branch_tip is called with a "
1553
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1554
"commit, uncommit will all trigger this hook.", (1, 6), None))
1555
self.create_hook(HookPoint('post_change_branch_tip',
1556
"Called in bzr client and server after a change to the tip of a "
1557
"branch is made. post_change_branch_tip is called with a "
1558
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1559
"commit, uncommit will all trigger this hook.", (1, 4), None))
1560
self.create_hook(HookPoint('transform_fallback_location',
1561
"Called when a stacked branch is activating its fallback "
1562
"locations. transform_fallback_location is called with (branch, "
1563
"url), and should return a new url. Returning the same url "
1564
"allows it to be used as-is, returning a different one can be "
1565
"used to cause the branch to stack on a closer copy of that "
1566
"fallback_location. Note that the branch cannot have history "
1567
"accessing methods called on it during this hook because the "
1568
"fallback locations have not been activated. When there are "
1569
"multiple hooks installed for transform_fallback_location, "
1570
"all are called with the url returned from the previous hook."
1571
"The order is however undefined.", (1, 9), None))
1574
# install the default hooks into the Branch class.
1575
Branch.hooks = BranchHooks()
1578
class ChangeBranchTipParams(object):
1579
"""Object holding parameters passed to *_change_branch_tip hooks.
1581
There are 5 fields that hooks may wish to access:
1583
:ivar branch: the branch being changed
1584
:ivar old_revno: revision number before the change
1585
:ivar new_revno: revision number after the change
1586
:ivar old_revid: revision id before the change
1587
:ivar new_revid: revision id after the change
1589
The revid fields are strings. The revno fields are integers.
1592
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1593
"""Create a group of ChangeBranchTip parameters.
1595
:param branch: The branch being changed.
1596
:param old_revno: Revision number before the change.
1597
:param new_revno: Revision number after the change.
1598
:param old_revid: Tip revision id before the change.
1599
:param new_revid: Tip revision id after the change.
1601
self.branch = branch
1602
self.old_revno = old_revno
1603
self.new_revno = new_revno
1604
self.old_revid = old_revid
1605
self.new_revid = new_revid
1607
def __eq__(self, other):
1608
return self.__dict__ == other.__dict__
1611
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1612
self.__class__.__name__, self.branch,
1613
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1616
class BzrBranchFormat4(BranchFormat):
1617
"""Bzr branch format 4.
1620
- a revision-history file.
1621
- a branch-lock lock file [ to be shared with the bzrdir ]
1624
def get_format_description(self):
1625
"""See BranchFormat.get_format_description()."""
1626
return "Branch format 4"
1628
def initialize(self, a_bzrdir):
1629
"""Create a branch of this format in a_bzrdir."""
1630
utf8_files = [('revision-history', ''),
1631
('branch-name', ''),
1633
return self._initialize_helper(a_bzrdir, utf8_files,
1634
lock_type='branch4', set_format=False)
1637
super(BzrBranchFormat4, self).__init__()
1638
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1640
def network_name(self):
1641
"""The network name for this format is the control dirs disk label."""
1642
return self._matchingbzrdir.get_format_string()
1644
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1645
"""See BranchFormat.open()."""
1647
# we are being called directly and must probe.
1648
raise NotImplementedError
1649
return BzrBranch(_format=self,
1650
_control_files=a_bzrdir._control_files,
1652
_repository=a_bzrdir.open_repository())
1655
return "Bazaar-NG branch format 4"
1658
class BranchFormatMetadir(BranchFormat):
1659
"""Common logic for meta-dir based branch formats."""
1661
def _branch_class(self):
1662
"""What class to instantiate on open calls."""
1663
raise NotImplementedError(self._branch_class)
1665
def network_name(self):
1666
"""A simple byte string uniquely identifying this format for RPC calls.
1668
Metadir branch formats use their format string.
1670
return self.get_format_string()
1672
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1673
"""See BranchFormat.open()."""
1675
format = BranchFormat.find_format(a_bzrdir)
1676
if format.__class__ != self.__class__:
1677
raise AssertionError("wrong format %r found for %r" %
1680
transport = a_bzrdir.get_branch_transport(None)
1681
control_files = lockable_files.LockableFiles(transport, 'lock',
1683
return self._branch_class()(_format=self,
1684
_control_files=control_files,
1686
_repository=a_bzrdir.find_repository(),
1687
ignore_fallbacks=ignore_fallbacks)
1688
except errors.NoSuchFile:
1689
raise errors.NotBranchError(path=transport.base)
1692
super(BranchFormatMetadir, self).__init__()
1693
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1694
self._matchingbzrdir.set_branch_format(self)
1696
def supports_tags(self):
1700
class BzrBranchFormat5(BranchFormatMetadir):
1701
"""Bzr branch format 5.
1704
- a revision-history file.
1706
- a lock dir guarding the branch itself
1707
- all of this stored in a branch/ subdirectory
1708
- works with shared repositories.
1710
This format is new in bzr 0.8.
1713
def _branch_class(self):
1716
def get_format_string(self):
1717
"""See BranchFormat.get_format_string()."""
1718
return "Bazaar-NG branch format 5\n"
1720
def get_format_description(self):
1721
"""See BranchFormat.get_format_description()."""
1722
return "Branch format 5"
1724
def initialize(self, a_bzrdir):
1725
"""Create a branch of this format in a_bzrdir."""
1726
utf8_files = [('revision-history', ''),
1727
('branch-name', ''),
1729
return self._initialize_helper(a_bzrdir, utf8_files)
1731
def supports_tags(self):
1735
class BzrBranchFormat6(BranchFormatMetadir):
1736
"""Branch format with last-revision and tags.
1738
Unlike previous formats, this has no explicit revision history. Instead,
1739
this just stores the last-revision, and the left-hand history leading
1740
up to there is the history.
1742
This format was introduced in bzr 0.15
1743
and became the default in 0.91.
1746
def _branch_class(self):
1749
def get_format_string(self):
1750
"""See BranchFormat.get_format_string()."""
1751
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1753
def get_format_description(self):
1754
"""See BranchFormat.get_format_description()."""
1755
return "Branch format 6"
1757
def initialize(self, a_bzrdir):
1758
"""Create a branch of this format in a_bzrdir."""
1759
utf8_files = [('last-revision', '0 null:\n'),
1760
('branch.conf', ''),
1763
return self._initialize_helper(a_bzrdir, utf8_files)
1765
def make_tags(self, branch):
1766
"""See bzrlib.branch.BranchFormat.make_tags()."""
1767
return BasicTags(branch)
1771
class BzrBranchFormat8(BranchFormatMetadir):
1772
"""Metadir format supporting storing locations of subtree branches."""
1774
def _branch_class(self):
1777
def get_format_string(self):
1778
"""See BranchFormat.get_format_string()."""
1779
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1781
def get_format_description(self):
1782
"""See BranchFormat.get_format_description()."""
1783
return "Branch format 8"
1785
def initialize(self, a_bzrdir):
1786
"""Create a branch of this format in a_bzrdir."""
1787
utf8_files = [('last-revision', '0 null:\n'),
1788
('branch.conf', ''),
1792
return self._initialize_helper(a_bzrdir, utf8_files)
1795
super(BzrBranchFormat8, self).__init__()
1796
self._matchingbzrdir.repository_format = \
1797
RepositoryFormatKnitPack5RichRoot()
1799
def make_tags(self, branch):
1800
"""See bzrlib.branch.BranchFormat.make_tags()."""
1801
return BasicTags(branch)
1803
def supports_stacking(self):
1806
supports_reference_locations = True
1809
class BzrBranchFormat7(BzrBranchFormat8):
1810
"""Branch format with last-revision, tags, and a stacked location pointer.
1812
The stacked location pointer is passed down to the repository and requires
1813
a repository format with supports_external_lookups = True.
1815
This format was introduced in bzr 1.6.
1818
def initialize(self, a_bzrdir):
1819
"""Create a branch of this format in a_bzrdir."""
1820
utf8_files = [('last-revision', '0 null:\n'),
1821
('branch.conf', ''),
1824
return self._initialize_helper(a_bzrdir, utf8_files)
1826
def _branch_class(self):
1829
def get_format_string(self):
1830
"""See BranchFormat.get_format_string()."""
1831
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1833
def get_format_description(self):
1834
"""See BranchFormat.get_format_description()."""
1835
return "Branch format 7"
1837
supports_reference_locations = False
1840
class BranchReferenceFormat(BranchFormat):
1841
"""Bzr branch reference format.
1843
Branch references are used in implementing checkouts, they
1844
act as an alias to the real branch which is at some other url.
1851
def get_format_string(self):
1852
"""See BranchFormat.get_format_string()."""
1853
return "Bazaar-NG Branch Reference Format 1\n"
1855
def get_format_description(self):
1856
"""See BranchFormat.get_format_description()."""
1857
return "Checkout reference format 1"
1859
def get_reference(self, a_bzrdir):
1860
"""See BranchFormat.get_reference()."""
1861
transport = a_bzrdir.get_branch_transport(None)
1862
return transport.get('location').read()
1864
def set_reference(self, a_bzrdir, to_branch):
1865
"""See BranchFormat.set_reference()."""
1866
transport = a_bzrdir.get_branch_transport(None)
1867
location = transport.put_bytes('location', to_branch.base)
1869
def initialize(self, a_bzrdir, target_branch=None):
1870
"""Create a branch of this format in a_bzrdir."""
1871
if target_branch is None:
1872
# this format does not implement branch itself, thus the implicit
1873
# creation contract must see it as uninitializable
1874
raise errors.UninitializableFormat(self)
1875
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1876
branch_transport = a_bzrdir.get_branch_transport(self)
1877
branch_transport.put_bytes('location',
1878
target_branch.bzrdir.root_transport.base)
1879
branch_transport.put_bytes('format', self.get_format_string())
1881
a_bzrdir, _found=True,
1882
possible_transports=[target_branch.bzrdir.root_transport])
1885
super(BranchReferenceFormat, self).__init__()
1886
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1887
self._matchingbzrdir.set_branch_format(self)
1889
def _make_reference_clone_function(format, a_branch):
1890
"""Create a clone() routine for a branch dynamically."""
1891
def clone(to_bzrdir, revision_id=None,
1892
repository_policy=None):
1893
"""See Branch.clone()."""
1894
return format.initialize(to_bzrdir, a_branch)
1895
# cannot obey revision_id limits when cloning a reference ...
1896
# FIXME RBC 20060210 either nuke revision_id for clone, or
1897
# emit some sort of warning/error to the caller ?!
1900
def open(self, a_bzrdir, _found=False, location=None,
1901
possible_transports=None, ignore_fallbacks=False):
1902
"""Return the branch that the branch reference in a_bzrdir points at.
1904
:param a_bzrdir: A BzrDir that contains a branch.
1905
:param _found: a private parameter, do not use it. It is used to
1906
indicate if format probing has already be done.
1907
:param ignore_fallbacks: when set, no fallback branches will be opened
1908
(if there are any). Default is to open fallbacks.
1909
:param location: The location of the referenced branch. If
1910
unspecified, this will be determined from the branch reference in
1912
:param possible_transports: An optional reusable transports list.
1915
format = BranchFormat.find_format(a_bzrdir)
1916
if format.__class__ != self.__class__:
1917
raise AssertionError("wrong format %r found for %r" %
1919
if location is None:
1920
location = self.get_reference(a_bzrdir)
1921
real_bzrdir = bzrdir.BzrDir.open(
1922
location, possible_transports=possible_transports)
1923
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1924
# this changes the behaviour of result.clone to create a new reference
1925
# rather than a copy of the content of the branch.
1926
# I did not use a proxy object because that needs much more extensive
1927
# testing, and we are only changing one behaviour at the moment.
1928
# If we decide to alter more behaviours - i.e. the implicit nickname
1929
# then this should be refactored to introduce a tested proxy branch
1930
# and a subclass of that for use in overriding clone() and ....
1932
result.clone = self._make_reference_clone_function(result)
1936
network_format_registry = registry.FormatRegistry()
1937
"""Registry of formats indexed by their network name.
1939
The network name for a branch format is an identifier that can be used when
1940
referring to formats with smart server operations. See
1941
BranchFormat.network_name() for more detail.
1945
# formats which have no format string are not discoverable
1946
# and not independently creatable, so are not registered.
1947
__format5 = BzrBranchFormat5()
1948
__format6 = BzrBranchFormat6()
1949
__format7 = BzrBranchFormat7()
1950
__format8 = BzrBranchFormat8()
1951
BranchFormat.register_format(__format5)
1952
BranchFormat.register_format(BranchReferenceFormat())
1953
BranchFormat.register_format(__format6)
1954
BranchFormat.register_format(__format7)
1955
BranchFormat.register_format(__format8)
1956
BranchFormat.set_default_format(__format6)
1957
_legacy_formats = [BzrBranchFormat4(),
1959
network_format_registry.register(
1960
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1963
class BzrBranch(Branch):
1964
"""A branch stored in the actual filesystem.
1966
Note that it's "local" in the context of the filesystem; it doesn't
1967
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1968
it's writable, and can be accessed via the normal filesystem API.
1970
:ivar _transport: Transport for file operations on this branch's
1971
control files, typically pointing to the .bzr/branch directory.
1972
:ivar repository: Repository for this branch.
1973
:ivar base: The url of the base directory for this branch; the one
1974
containing the .bzr directory.
1977
def __init__(self, _format=None,
1978
_control_files=None, a_bzrdir=None, _repository=None,
1979
ignore_fallbacks=False):
1980
"""Create new branch object at a particular location."""
1981
if a_bzrdir is None:
1982
raise ValueError('a_bzrdir must be supplied')
1984
self.bzrdir = a_bzrdir
1985
self._base = self.bzrdir.transport.clone('..').base
1986
# XXX: We should be able to just do
1987
# self.base = self.bzrdir.root_transport.base
1988
# but this does not quite work yet -- mbp 20080522
1989
self._format = _format
1990
if _control_files is None:
1991
raise ValueError('BzrBranch _control_files is None')
1992
self.control_files = _control_files
1993
self._transport = _control_files._transport
1994
self.repository = _repository
1995
Branch.__init__(self)
1998
return '%s(%r)' % (self.__class__.__name__, self.base)
2002
def _get_base(self):
2003
"""Returns the directory containing the control directory."""
2006
base = property(_get_base, doc="The URL for the root of this branch.")
2008
def _get_config(self):
2009
return TransportConfig(self._transport, 'branch.conf')
2011
def is_locked(self):
2012
return self.control_files.is_locked()
2014
def lock_write(self, token=None):
2015
# All-in-one needs to always unlock/lock.
2016
repo_control = getattr(self.repository, 'control_files', None)
2017
if self.control_files == repo_control or not self.is_locked():
2018
self.repository.lock_write()
2023
return self.control_files.lock_write(token=token)
2026
self.repository.unlock()
2029
def lock_read(self):
2030
# All-in-one needs to always unlock/lock.
2031
repo_control = getattr(self.repository, 'control_files', None)
2032
if self.control_files == repo_control or not self.is_locked():
2033
self.repository.lock_read()
2038
self.control_files.lock_read()
2041
self.repository.unlock()
2046
self.control_files.unlock()
2048
# All-in-one needs to always unlock/lock.
2049
repo_control = getattr(self.repository, 'control_files', None)
2050
if (self.control_files == repo_control or
2051
not self.control_files.is_locked()):
2052
self.repository.unlock()
2053
if not self.control_files.is_locked():
2054
# we just released the lock
2055
self._clear_cached_state()
2057
def peek_lock_mode(self):
2058
if self.control_files._lock_count == 0:
2061
return self.control_files._lock_mode
2063
def get_physical_lock_status(self):
2064
return self.control_files.get_physical_lock_status()
2067
def print_file(self, file, revision_id):
2068
"""See Branch.print_file."""
2069
return self.repository.print_file(file, revision_id)
2071
def _write_revision_history(self, history):
2072
"""Factored out of set_revision_history.
2074
This performs the actual writing to disk.
2075
It is intended to be called by BzrBranch5.set_revision_history."""
2076
self._transport.put_bytes(
2077
'revision-history', '\n'.join(history),
2078
mode=self.bzrdir._get_file_mode())
2081
def set_revision_history(self, rev_history):
2082
"""See Branch.set_revision_history."""
2083
if 'evil' in debug.debug_flags:
2084
mutter_callsite(3, "set_revision_history scales with history.")
2085
check_not_reserved_id = _mod_revision.check_not_reserved_id
2086
for rev_id in rev_history:
2087
check_not_reserved_id(rev_id)
2088
if Branch.hooks['post_change_branch_tip']:
2089
# Don't calculate the last_revision_info() if there are no hooks
2091
old_revno, old_revid = self.last_revision_info()
2092
if len(rev_history) == 0:
2093
revid = _mod_revision.NULL_REVISION
2095
revid = rev_history[-1]
2096
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2097
self._write_revision_history(rev_history)
2098
self._clear_cached_state()
2099
self._cache_revision_history(rev_history)
2100
for hook in Branch.hooks['set_rh']:
2101
hook(self, rev_history)
2102
if Branch.hooks['post_change_branch_tip']:
2103
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2105
def _synchronize_history(self, destination, revision_id):
2106
"""Synchronize last revision and revision history between branches.
2108
This version is most efficient when the destination is also a
2109
BzrBranch5, but works for BzrBranch6 as long as the revision
2110
history is the true lefthand parent history, and all of the revisions
2111
are in the destination's repository. If not, set_revision_history
2114
:param destination: The branch to copy the history into
2115
:param revision_id: The revision-id to truncate history at. May
2116
be None to copy complete history.
2118
if not isinstance(destination._format, BzrBranchFormat5):
2119
super(BzrBranch, self)._synchronize_history(
2120
destination, revision_id)
2122
if revision_id == _mod_revision.NULL_REVISION:
2125
new_history = self.revision_history()
2126
if revision_id is not None and new_history != []:
2128
new_history = new_history[:new_history.index(revision_id) + 1]
2130
rev = self.repository.get_revision(revision_id)
2131
new_history = rev.get_history(self.repository)[1:]
2132
destination.set_revision_history(new_history)
2135
def set_last_revision_info(self, revno, revision_id):
2136
"""Set the last revision of this branch.
2138
The caller is responsible for checking that the revno is correct
2139
for this revision id.
2141
It may be possible to set the branch last revision to an id not
2142
present in the repository. However, branches can also be
2143
configured to check constraints on history, in which case this may not
2146
revision_id = _mod_revision.ensure_null(revision_id)
2147
# this old format stores the full history, but this api doesn't
2148
# provide it, so we must generate, and might as well check it's
2150
history = self._lefthand_history(revision_id)
2151
if len(history) != revno:
2152
raise AssertionError('%d != %d' % (len(history), revno))
2153
self.set_revision_history(history)
2155
def _gen_revision_history(self):
2156
history = self._transport.get_bytes('revision-history').split('\n')
2157
if history[-1:] == ['']:
2158
# There shouldn't be a trailing newline, but just in case.
2163
def generate_revision_history(self, revision_id, last_rev=None,
2165
"""Create a new revision history that will finish with revision_id.
2167
:param revision_id: the new tip to use.
2168
:param last_rev: The previous last_revision. If not None, then this
2169
must be a ancestory of revision_id, or DivergedBranches is raised.
2170
:param other_branch: The other branch that DivergedBranches should
2171
raise with respect to.
2173
self.set_revision_history(self._lefthand_history(revision_id,
2174
last_rev, other_branch))
2176
def basis_tree(self):
2177
"""See Branch.basis_tree."""
2178
return self.repository.revision_tree(self.last_revision())
2181
def pull(self, source, overwrite=False, stop_revision=None,
2182
_hook_master=None, run_hooks=True, possible_transports=None,
2183
_override_hook_target=None):
2186
:param _hook_master: Private parameter - set the branch to
2187
be supplied as the master to pull hooks.
2188
:param run_hooks: Private parameter - if false, this branch
2189
is being called because it's the master of the primary branch,
2190
so it should not run its hooks.
2191
:param _override_hook_target: Private parameter - set the branch to be
2192
supplied as the target_branch to pull hooks.
2194
result = PullResult()
2195
result.source_branch = source
2196
if _override_hook_target is None:
2197
result.target_branch = self
2199
result.target_branch = _override_hook_target
2202
# We assume that during 'pull' the local repository is closer than
2204
source.update_references(self)
2205
graph = self.repository.get_graph(source.repository)
2206
result.old_revno, result.old_revid = self.last_revision_info()
2207
self.update_revisions(source, stop_revision, overwrite=overwrite,
2209
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2210
result.new_revno, result.new_revid = self.last_revision_info()
2212
result.master_branch = _hook_master
2213
result.local_branch = result.target_branch
2215
result.master_branch = result.target_branch
2216
result.local_branch = None
2218
for hook in Branch.hooks['post_pull']:
2224
def _get_parent_location(self):
2225
_locs = ['parent', 'pull', 'x-pull']
2228
return self._transport.get_bytes(l).strip('\n')
2229
except errors.NoSuchFile:
2233
def _basic_push(self, target, overwrite, stop_revision):
2234
"""Basic implementation of push without bound branches or hooks.
2236
Must be called with source read locked and target write locked.
2238
result = BranchPushResult()
2239
result.source_branch = self
2240
result.target_branch = target
2241
result.old_revno, result.old_revid = target.last_revision_info()
2242
self.update_references(target)
2243
if result.old_revid != self.last_revision():
2244
# We assume that during 'push' this repository is closer than
2246
graph = self.repository.get_graph(target.repository)
2247
target.update_revisions(self, stop_revision,
2248
overwrite=overwrite, graph=graph)
2249
if self._push_should_merge_tags():
2250
result.tag_conflicts = self.tags.merge_to(target.tags,
2252
result.new_revno, result.new_revid = target.last_revision_info()
2255
def get_stacked_on_url(self):
2256
raise errors.UnstackableBranchFormat(self._format, self.base)
2258
def set_push_location(self, location):
2259
"""See Branch.set_push_location."""
2260
self.get_config().set_user_option(
2261
'push_location', location,
2262
store=_mod_config.STORE_LOCATION_NORECURSE)
2264
def _set_parent_location(self, url):
2266
self._transport.delete('parent')
2268
self._transport.put_bytes('parent', url + '\n',
2269
mode=self.bzrdir._get_file_mode())
2272
class BzrBranch5(BzrBranch):
2273
"""A format 5 branch. This supports new features over plain branches.
2275
It has support for a master_branch which is the data for bound branches.
2279
def pull(self, source, overwrite=False, stop_revision=None,
2280
run_hooks=True, possible_transports=None,
2281
_override_hook_target=None):
2282
"""Pull from source into self, updating my master if any.
2284
:param run_hooks: Private parameter - if false, this branch
2285
is being called because it's the master of the primary branch,
2286
so it should not run its hooks.
2288
bound_location = self.get_bound_location()
2289
master_branch = None
2290
if bound_location and source.base != bound_location:
2291
# not pulling from master, so we need to update master.
2292
master_branch = self.get_master_branch(possible_transports)
2293
master_branch.lock_write()
2296
# pull from source into master.
2297
master_branch.pull(source, overwrite, stop_revision,
2299
return super(BzrBranch5, self).pull(source, overwrite,
2300
stop_revision, _hook_master=master_branch,
2301
run_hooks=run_hooks,
2302
_override_hook_target=_override_hook_target)
2305
master_branch.unlock()
2307
def get_bound_location(self):
2309
return self._transport.get_bytes('bound')[:-1]
2310
except errors.NoSuchFile:
2314
def get_master_branch(self, possible_transports=None):
2315
"""Return the branch we are bound to.
2317
:return: Either a Branch, or None
2319
This could memoise the branch, but if thats done
2320
it must be revalidated on each new lock.
2321
So for now we just don't memoise it.
2322
# RBC 20060304 review this decision.
2324
bound_loc = self.get_bound_location()
2328
return Branch.open(bound_loc,
2329
possible_transports=possible_transports)
2330
except (errors.NotBranchError, errors.ConnectionError), e:
2331
raise errors.BoundBranchConnectionFailure(
2335
def set_bound_location(self, location):
2336
"""Set the target where this branch is bound to.
2338
:param location: URL to the target branch
2341
self._transport.put_bytes('bound', location+'\n',
2342
mode=self.bzrdir._get_file_mode())
2345
self._transport.delete('bound')
2346
except errors.NoSuchFile:
2351
def bind(self, other):
2352
"""Bind this branch to the branch other.
2354
This does not push or pull data between the branches, though it does
2355
check for divergence to raise an error when the branches are not
2356
either the same, or one a prefix of the other. That behaviour may not
2357
be useful, so that check may be removed in future.
2359
:param other: The branch to bind to
2362
# TODO: jam 20051230 Consider checking if the target is bound
2363
# It is debatable whether you should be able to bind to
2364
# a branch which is itself bound.
2365
# Committing is obviously forbidden,
2366
# but binding itself may not be.
2367
# Since we *have* to check at commit time, we don't
2368
# *need* to check here
2370
# we want to raise diverged if:
2371
# last_rev is not in the other_last_rev history, AND
2372
# other_last_rev is not in our history, and do it without pulling
2374
self.set_bound_location(other.base)
2378
"""If bound, unbind"""
2379
return self.set_bound_location(None)
2382
def update(self, possible_transports=None):
2383
"""Synchronise this branch with the master branch if any.
2385
:return: None or the last_revision that was pivoted out during the
2388
master = self.get_master_branch(possible_transports)
2389
if master is not None:
2390
old_tip = _mod_revision.ensure_null(self.last_revision())
2391
self.pull(master, overwrite=True)
2392
if self.repository.get_graph().is_ancestor(old_tip,
2393
_mod_revision.ensure_null(self.last_revision())):
2399
class BzrBranch8(BzrBranch5):
2400
"""A branch that stores tree-reference locations."""
2402
def _open_hook(self):
2403
if self._ignore_fallbacks:
2406
url = self.get_stacked_on_url()
2407
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2408
errors.UnstackableBranchFormat):
2411
for hook in Branch.hooks['transform_fallback_location']:
2412
url = hook(self, url)
2414
hook_name = Branch.hooks.get_hook_name(hook)
2415
raise AssertionError(
2416
"'transform_fallback_location' hook %s returned "
2417
"None, not a URL." % hook_name)
2418
self._activate_fallback_location(url, None)
2420
def __init__(self, *args, **kwargs):
2421
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2422
super(BzrBranch8, self).__init__(*args, **kwargs)
2423
self._last_revision_info_cache = None
2424
self._partial_revision_history_cache = []
2425
self._reference_info = None
2427
def _clear_cached_state(self):
2428
super(BzrBranch8, self)._clear_cached_state()
2429
self._last_revision_info_cache = None
2430
self._partial_revision_history_cache = []
2431
self._reference_info = None
2433
def _last_revision_info(self):
2434
revision_string = self._transport.get_bytes('last-revision')
2435
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2436
revision_id = cache_utf8.get_cached_utf8(revision_id)
2438
return revno, revision_id
2440
def _write_last_revision_info(self, revno, revision_id):
2441
"""Simply write out the revision id, with no checks.
2443
Use set_last_revision_info to perform this safely.
2445
Does not update the revision_history cache.
2446
Intended to be called by set_last_revision_info and
2447
_write_revision_history.
2449
revision_id = _mod_revision.ensure_null(revision_id)
2450
out_string = '%d %s\n' % (revno, revision_id)
2451
self._transport.put_bytes('last-revision', out_string,
2452
mode=self.bzrdir._get_file_mode())
2455
def set_last_revision_info(self, revno, revision_id):
2456
revision_id = _mod_revision.ensure_null(revision_id)
2457
old_revno, old_revid = self.last_revision_info()
2458
if self._get_append_revisions_only():
2459
self._check_history_violation(revision_id)
2460
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2461
self._write_last_revision_info(revno, revision_id)
2462
self._clear_cached_state()
2463
self._last_revision_info_cache = revno, revision_id
2464
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2466
def _synchronize_history(self, destination, revision_id):
2467
"""Synchronize last revision and revision history between branches.
2469
:see: Branch._synchronize_history
2471
# XXX: The base Branch has a fast implementation of this method based
2472
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2473
# that uses set_revision_history. This class inherits from BzrBranch5,
2474
# but wants the fast implementation, so it calls
2475
# Branch._synchronize_history directly.
2476
Branch._synchronize_history(self, destination, revision_id)
2478
def _check_history_violation(self, revision_id):
2479
last_revision = _mod_revision.ensure_null(self.last_revision())
2480
if _mod_revision.is_null(last_revision):
2482
if last_revision not in self._lefthand_history(revision_id):
2483
raise errors.AppendRevisionsOnlyViolation(self.base)
2485
def _gen_revision_history(self):
2486
"""Generate the revision history from last revision
2488
last_revno, last_revision = self.last_revision_info()
2489
self._extend_partial_history(stop_index=last_revno-1)
2490
return list(reversed(self._partial_revision_history_cache))
2492
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2493
"""Extend the partial history to include a given index
2495
If a stop_index is supplied, stop when that index has been reached.
2496
If a stop_revision is supplied, stop when that revision is
2497
encountered. Otherwise, stop when the beginning of history is
2500
:param stop_index: The index which should be present. When it is
2501
present, history extension will stop.
2502
:param revision_id: The revision id which should be present. When
2503
it is encountered, history extension will stop.
2505
repo = self.repository
2506
if len(self._partial_revision_history_cache) == 0:
2507
iterator = repo.iter_reverse_revision_history(self.last_revision())
2509
start_revision = self._partial_revision_history_cache[-1]
2510
iterator = repo.iter_reverse_revision_history(start_revision)
2511
#skip the last revision in the list
2512
next_revision = iterator.next()
2513
for revision_id in iterator:
2514
self._partial_revision_history_cache.append(revision_id)
2515
if (stop_index is not None and
2516
len(self._partial_revision_history_cache) > stop_index):
2518
if revision_id == stop_revision:
2521
def _write_revision_history(self, history):
2522
"""Factored out of set_revision_history.
2524
This performs the actual writing to disk, with format-specific checks.
2525
It is intended to be called by BzrBranch5.set_revision_history.
2527
if len(history) == 0:
2528
last_revision = 'null:'
2530
if history != self._lefthand_history(history[-1]):
2531
raise errors.NotLefthandHistory(history)
2532
last_revision = history[-1]
2533
if self._get_append_revisions_only():
2534
self._check_history_violation(last_revision)
2535
self._write_last_revision_info(len(history), last_revision)
2538
def _set_parent_location(self, url):
2539
"""Set the parent branch"""
2540
self._set_config_location('parent_location', url, make_relative=True)
2543
def _get_parent_location(self):
2544
"""Set the parent branch"""
2545
return self._get_config_location('parent_location')
2548
def _set_all_reference_info(self, info_dict):
2549
"""Replace all reference info stored in a branch.
2551
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2554
writer = rio.RioWriter(s)
2555
for key, (tree_path, branch_location) in info_dict.iteritems():
2556
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2557
branch_location=branch_location)
2558
writer.write_stanza(stanza)
2559
self._transport.put_bytes('references', s.getvalue())
2560
self._reference_info = info_dict
2563
def _get_all_reference_info(self):
2564
"""Return all the reference info stored in a branch.
2566
:return: A dict of {file_id: (tree_path, branch_location)}
2568
if self._reference_info is not None:
2569
return self._reference_info
2570
rio_file = self._transport.get('references')
2572
stanzas = rio.read_stanzas(rio_file)
2573
info_dict = dict((s['file_id'], (s['tree_path'],
2574
s['branch_location'])) for s in stanzas)
2577
self._reference_info = info_dict
2580
def set_reference_info(self, file_id, tree_path, branch_location):
2581
"""Set the branch location to use for a tree reference.
2583
:param file_id: The file-id of the tree reference.
2584
:param tree_path: The path of the tree reference in the tree.
2585
:param branch_location: The location of the branch to retrieve tree
2588
info_dict = self._get_all_reference_info()
2589
info_dict[file_id] = (tree_path, branch_location)
2590
if None in (tree_path, branch_location):
2591
if tree_path is not None:
2592
raise ValueError('tree_path must be None when branch_location'
2594
if branch_location is not None:
2595
raise ValueError('branch_location must be None when tree_path'
2597
del info_dict[file_id]
2598
self._set_all_reference_info(info_dict)
2600
def get_reference_info(self, file_id):
2601
"""Get the tree_path and branch_location for a tree reference.
2603
:return: a tuple of (tree_path, branch_location)
2605
return self._get_all_reference_info().get(file_id, (None, None))
2607
def reference_parent(self, file_id, path, possible_transports=None):
2608
"""Return the parent branch for a tree-reference file_id.
2610
:param file_id: The file_id of the tree reference
2611
:param path: The path of the file_id in the tree
2612
:return: A branch associated with the file_id
2614
branch_location = self.get_reference_info(file_id)[1]
2615
if branch_location is None:
2616
return Branch.reference_parent(self, file_id, path,
2617
possible_transports)
2618
branch_location = urlutils.join(self.base, branch_location)
2619
return Branch.open(branch_location,
2620
possible_transports=possible_transports)
2622
def set_push_location(self, location):
2623
"""See Branch.set_push_location."""
2624
self._set_config_location('push_location', location)
2626
def set_bound_location(self, location):
2627
"""See Branch.set_push_location."""
2629
config = self.get_config()
2630
if location is None:
2631
if config.get_user_option('bound') != 'True':
2634
config.set_user_option('bound', 'False', warn_masked=True)
2637
self._set_config_location('bound_location', location,
2639
config.set_user_option('bound', 'True', warn_masked=True)
2642
def _get_bound_location(self, bound):
2643
"""Return the bound location in the config file.
2645
Return None if the bound parameter does not match"""
2646
config = self.get_config()
2647
config_bound = (config.get_user_option('bound') == 'True')
2648
if config_bound != bound:
2650
return self._get_config_location('bound_location', config=config)
2652
def get_bound_location(self):
2653
"""See Branch.set_push_location."""
2654
return self._get_bound_location(True)
2656
def get_old_bound_location(self):
2657
"""See Branch.get_old_bound_location"""
2658
return self._get_bound_location(False)
2660
def get_stacked_on_url(self):
2661
# you can always ask for the URL; but you might not be able to use it
2662
# if the repo can't support stacking.
2663
## self._check_stackable_repo()
2664
stacked_url = self._get_config_location('stacked_on_location')
2665
if stacked_url is None:
2666
raise errors.NotStacked(self)
2669
def set_append_revisions_only(self, enabled):
2674
self.get_config().set_user_option('append_revisions_only', value,
2677
def _get_append_revisions_only(self):
2678
value = self.get_config().get_user_option('append_revisions_only')
2679
return value == 'True'
2682
def generate_revision_history(self, revision_id, last_rev=None,
2684
"""See BzrBranch5.generate_revision_history"""
2685
history = self._lefthand_history(revision_id, last_rev, other_branch)
2686
revno = len(history)
2687
self.set_last_revision_info(revno, revision_id)
2690
def get_rev_id(self, revno, history=None):
2691
"""Find the revision id of the specified revno."""
2693
return _mod_revision.NULL_REVISION
2695
last_revno, last_revision_id = self.last_revision_info()
2696
if revno <= 0 or revno > last_revno:
2697
raise errors.NoSuchRevision(self, revno)
2699
if history is not None:
2700
return history[revno - 1]
2702
index = last_revno - revno
2703
if len(self._partial_revision_history_cache) <= index:
2704
self._extend_partial_history(stop_index=index)
2705
if len(self._partial_revision_history_cache) > index:
2706
return self._partial_revision_history_cache[index]
2708
raise errors.NoSuchRevision(self, revno)
2711
def revision_id_to_revno(self, revision_id):
2712
"""Given a revision id, return its revno"""
2713
if _mod_revision.is_null(revision_id):
2716
index = self._partial_revision_history_cache.index(revision_id)
2718
self._extend_partial_history(stop_revision=revision_id)
2719
index = len(self._partial_revision_history_cache) - 1
2720
if self._partial_revision_history_cache[index] != revision_id:
2721
raise errors.NoSuchRevision(self, revision_id)
2722
return self.revno() - index
2725
class BzrBranch7(BzrBranch8):
2726
"""A branch with support for a fallback repository."""
2728
def set_reference_info(self, file_id, tree_path, branch_location):
2729
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2731
def get_reference_info(self, file_id):
2732
Branch.get_reference_info(self, file_id)
2734
def reference_parent(self, file_id, path, possible_transports=None):
2735
return Branch.reference_parent(self, file_id, path,
2736
possible_transports)
2739
class BzrBranch6(BzrBranch7):
2740
"""See BzrBranchFormat6 for the capabilities of this branch.
2742
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2746
def get_stacked_on_url(self):
2747
raise errors.UnstackableBranchFormat(self._format, self.base)
2750
######################################################################
2751
# results of operations
2754
class _Result(object):
2756
def _show_tag_conficts(self, to_file):
2757
if not getattr(self, 'tag_conflicts', None):
2759
to_file.write('Conflicting tags:\n')
2760
for name, value1, value2 in self.tag_conflicts:
2761
to_file.write(' %s\n' % (name, ))
2764
class PullResult(_Result):
2765
"""Result of a Branch.pull operation.
2767
:ivar old_revno: Revision number before pull.
2768
:ivar new_revno: Revision number after pull.
2769
:ivar old_revid: Tip revision id before pull.
2770
:ivar new_revid: Tip revision id after pull.
2771
:ivar source_branch: Source (local) branch object. (read locked)
2772
:ivar master_branch: Master branch of the target, or the target if no
2774
:ivar local_branch: target branch if there is a Master, else None
2775
:ivar target_branch: Target/destination branch object. (write locked)
2776
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2780
# DEPRECATED: pull used to return the change in revno
2781
return self.new_revno - self.old_revno
2783
def report(self, to_file):
2785
if self.old_revid == self.new_revid:
2786
to_file.write('No revisions to pull.\n')
2788
to_file.write('Now on revision %d.\n' % self.new_revno)
2789
self._show_tag_conficts(to_file)
2792
class BranchPushResult(_Result):
2793
"""Result of a Branch.push operation.
2795
:ivar old_revno: Revision number (eg 10) of the target before push.
2796
:ivar new_revno: Revision number (eg 12) of the target after push.
2797
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2799
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2801
:ivar source_branch: Source branch object that the push was from. This is
2802
read locked, and generally is a local (and thus low latency) branch.
2803
:ivar master_branch: If target is a bound branch, the master branch of
2804
target, or target itself. Always write locked.
2805
:ivar target_branch: The direct Branch where data is being sent (write
2807
:ivar local_branch: If the target is a bound branch this will be the
2808
target, otherwise it will be None.
2812
# DEPRECATED: push used to return the change in revno
2813
return self.new_revno - self.old_revno
2815
def report(self, to_file):
2816
"""Write a human-readable description of the result."""
2817
if self.old_revid == self.new_revid:
2818
note('No new revisions to push.')
2820
note('Pushed up to revision %d.' % self.new_revno)
2821
self._show_tag_conficts(to_file)
2824
class BranchCheckResult(object):
2825
"""Results of checking branch consistency.
2830
def __init__(self, branch):
2831
self.branch = branch
2833
def report_results(self, verbose):
2834
"""Report the check results via trace.note.
2836
:param verbose: Requests more detailed display of what was checked,
2839
note('checked branch %s format %s',
2841
self.branch._format)
2844
class Converter5to6(object):
2845
"""Perform an in-place upgrade of format 5 to format 6"""
2847
def convert(self, branch):
2848
# Data for 5 and 6 can peacefully coexist.
2849
format = BzrBranchFormat6()
2850
new_branch = format.open(branch.bzrdir, _found=True)
2852
# Copy source data into target
2853
new_branch._write_last_revision_info(*branch.last_revision_info())
2854
new_branch.set_parent(branch.get_parent())
2855
new_branch.set_bound_location(branch.get_bound_location())
2856
new_branch.set_push_location(branch.get_push_location())
2858
# New branch has no tags by default
2859
new_branch.tags._set_tag_dict({})
2861
# Copying done; now update target format
2862
new_branch._transport.put_bytes('format',
2863
format.get_format_string(),
2864
mode=new_branch.bzrdir._get_file_mode())
2866
# Clean up old files
2867
new_branch._transport.delete('revision-history')
2869
branch.set_parent(None)
2870
except errors.NoSuchFile:
2872
branch.set_bound_location(None)
2875
class Converter6to7(object):
2876
"""Perform an in-place upgrade of format 6 to format 7"""
2878
def convert(self, branch):
2879
format = BzrBranchFormat7()
2880
branch._set_config_location('stacked_on_location', '')
2881
# update target format
2882
branch._transport.put_bytes('format', format.get_format_string())
2885
class Converter7to8(object):
2886
"""Perform an in-place upgrade of format 6 to format 7"""
2888
def convert(self, branch):
2889
format = BzrBranchFormat8()
2890
branch._transport.put_bytes('references', '')
2891
# update target format
2892
branch._transport.put_bytes('format', format.get_format_string())
2895
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2896
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2899
_run_with_write_locked_target will attempt to release the lock it acquires.
2901
If an exception is raised by callable, then that exception *will* be
2902
propagated, even if the unlock attempt raises its own error. Thus
2903
_run_with_write_locked_target should be preferred to simply doing::
2907
return callable(*args, **kwargs)
2912
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2913
# should share code?
2916
result = callable(*args, **kwargs)
2918
exc_info = sys.exc_info()
2922
raise exc_info[0], exc_info[1], exc_info[2]
2928
class InterBranch(InterObject):
2929
"""This class represents operations taking place between two branches.
2931
Its instances have methods like pull() and push() and contain
2932
references to the source and target repositories these operations
2933
can be carried out on.
2937
"""The available optimised InterBranch types."""
2940
def _get_branch_formats_to_test():
2941
"""Return a tuple with the Branch formats to use when testing."""
2942
raise NotImplementedError(self._get_branch_formats_to_test)
2944
def update_revisions(self, stop_revision=None, overwrite=False,
2946
"""Pull in new perfect-fit revisions.
2948
:param stop_revision: Updated until the given revision
2949
:param overwrite: Always set the branch pointer, rather than checking
2950
to see if it is a proper descendant.
2951
:param graph: A Graph object that can be used to query history
2952
information. This can be None.
2955
raise NotImplementedError(self.update_revisions)
2957
def push(self, overwrite=False, stop_revision=None,
2958
_override_hook_source_branch=None):
2959
"""Mirror the source branch into the target branch.
2961
The source branch is considered to be 'local', having low latency.
2963
raise NotImplementedError(self.push)
2966
class GenericInterBranch(InterBranch):
2967
"""InterBranch implementation that uses public Branch functions.
2971
def _get_branch_formats_to_test():
2972
return BranchFormat._default_format, BranchFormat._default_format
2974
def update_revisions(self, stop_revision=None, overwrite=False,
2976
"""See InterBranch.update_revisions()."""
2977
self.source.lock_read()
2979
other_revno, other_last_revision = self.source.last_revision_info()
2980
stop_revno = None # unknown
2981
if stop_revision is None:
2982
stop_revision = other_last_revision
2983
if _mod_revision.is_null(stop_revision):
2984
# if there are no commits, we're done.
2986
stop_revno = other_revno
2988
# what's the current last revision, before we fetch [and change it
2990
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2991
# we fetch here so that we don't process data twice in the common
2992
# case of having something to pull, and so that the check for
2993
# already merged can operate on the just fetched graph, which will
2994
# be cached in memory.
2995
self.target.fetch(self.source, stop_revision)
2996
# Check to see if one is an ancestor of the other
2999
graph = self.target.repository.get_graph()
3000
if self.target._check_if_descendant_or_diverged(
3001
stop_revision, last_rev, graph, self.source):
3002
# stop_revision is a descendant of last_rev, but we aren't
3003
# overwriting, so we're done.
3005
if stop_revno is None:
3007
graph = self.target.repository.get_graph()
3008
this_revno, this_last_revision = \
3009
self.target.last_revision_info()
3010
stop_revno = graph.find_distance_to_null(stop_revision,
3011
[(other_last_revision, other_revno),
3012
(this_last_revision, this_revno)])
3013
self.target.set_last_revision_info(stop_revno, stop_revision)
3015
self.source.unlock()
3017
def push(self, overwrite=False, stop_revision=None,
3018
_override_hook_source_branch=None):
3019
"""See InterBranch.push.
3021
This is the basic concrete implementation of push()
3023
:param _override_hook_source_branch: If specified, run
3024
the hooks passing this Branch as the source, rather than self.
3025
This is for use of RemoteBranch, where push is delegated to the
3026
underlying vfs-based Branch.
3028
# TODO: Public option to disable running hooks - should be trivial but
3030
self.source.lock_read()
3032
return _run_with_write_locked_target(
3033
self.target, self._push_with_bound_branches, overwrite,
3035
_override_hook_source_branch=_override_hook_source_branch)
3037
self.source.unlock()
3039
def _push_with_bound_branches(self, overwrite, stop_revision,
3040
_override_hook_source_branch=None):
3041
"""Push from source into target, and into target's master if any.
3044
if _override_hook_source_branch:
3045
result.source_branch = _override_hook_source_branch
3046
for hook in Branch.hooks['post_push']:
3049
bound_location = self.target.get_bound_location()
3050
if bound_location and self.target.base != bound_location:
3051
# there is a master branch.
3053
# XXX: Why the second check? Is it even supported for a branch to
3054
# be bound to itself? -- mbp 20070507
3055
master_branch = self.target.get_master_branch()
3056
master_branch.lock_write()
3058
# push into the master from the source branch.
3059
self.source._basic_push(master_branch, overwrite, stop_revision)
3060
# and push into the target branch from the source. Note that we
3061
# push from the source branch again, because its considered the
3062
# highest bandwidth repository.
3063
result = self.source._basic_push(self.target, overwrite,
3065
result.master_branch = master_branch
3066
result.local_branch = self.target
3070
master_branch.unlock()
3073
result = self.source._basic_push(self.target, overwrite,
3075
# TODO: Why set master_branch and local_branch if there's no
3076
# binding? Maybe cleaner to just leave them unset? -- mbp
3078
result.master_branch = self.target
3079
result.local_branch = None
3084
def is_compatible(self, source, target):
3085
# GenericBranch uses the public API, so always compatible
3089
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
