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):
859
"""Mirror this branch into target.
861
This branch is considered to be 'local', having low latency.
863
raise NotImplementedError(self.push)
865
def basis_tree(self):
866
"""Return `Tree` object for last revision."""
867
return self.repository.revision_tree(self.last_revision())
869
def get_parent(self):
870
"""Return the parent location of the branch.
872
This is the default location for pull/missing. The usual
873
pattern is that the user can override it by specifying a
876
parent = self._get_parent_location()
879
# This is an old-format absolute path to a local branch
881
if parent.startswith('/'):
882
parent = urlutils.local_path_to_url(parent.decode('utf8'))
884
return urlutils.join(self.base[:-1], parent)
885
except errors.InvalidURLJoin, e:
886
raise errors.InaccessibleParent(parent, self.base)
888
def _get_parent_location(self):
889
raise NotImplementedError(self._get_parent_location)
891
def _set_config_location(self, name, url, config=None,
892
make_relative=False):
894
config = self.get_config()
898
url = urlutils.relative_url(self.base, url)
899
config.set_user_option(name, url, warn_masked=True)
901
def _get_config_location(self, name, config=None):
903
config = self.get_config()
904
location = config.get_user_option(name)
909
def get_submit_branch(self):
910
"""Return the submit location of the branch.
912
This is the default location for bundle. The usual
913
pattern is that the user can override it by specifying a
916
return self.get_config().get_user_option('submit_branch')
918
def set_submit_branch(self, location):
919
"""Return the submit location of the branch.
921
This is the default location for bundle. The usual
922
pattern is that the user can override it by specifying a
925
self.get_config().set_user_option('submit_branch', location,
928
def get_public_branch(self):
929
"""Return the public location of the branch.
931
This is used by merge directives.
933
return self._get_config_location('public_branch')
935
def set_public_branch(self, location):
936
"""Return the submit location of the branch.
938
This is the default location for bundle. The usual
939
pattern is that the user can override it by specifying a
942
self._set_config_location('public_branch', location)
944
def get_push_location(self):
945
"""Return the None or the location to push this branch to."""
946
push_loc = self.get_config().get_user_option('push_location')
949
def set_push_location(self, location):
950
"""Set a new push location for this branch."""
951
raise NotImplementedError(self.set_push_location)
953
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
954
"""Run the post_change_branch_tip hooks."""
955
hooks = Branch.hooks['post_change_branch_tip']
958
new_revno, new_revid = self.last_revision_info()
959
params = ChangeBranchTipParams(
960
self, old_revno, new_revno, old_revid, new_revid)
964
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
965
"""Run the pre_change_branch_tip hooks."""
966
hooks = Branch.hooks['pre_change_branch_tip']
969
old_revno, old_revid = self.last_revision_info()
970
params = ChangeBranchTipParams(
971
self, old_revno, new_revno, old_revid, new_revid)
975
except errors.TipChangeRejected:
978
exc_info = sys.exc_info()
979
hook_name = Branch.hooks.get_hook_name(hook)
980
raise errors.HookFailed(
981
'pre_change_branch_tip', hook_name, exc_info)
985
"""Synchronise this branch with the master branch if any.
987
:return: None or the last_revision pivoted out during the update.
991
def check_revno(self, revno):
993
Check whether a revno corresponds to any revision.
994
Zero (the NULL revision) is considered valid.
997
self.check_real_revno(revno)
999
def check_real_revno(self, revno):
1001
Check whether a revno corresponds to a real revision.
1002
Zero (the NULL revision) is considered invalid
1004
if revno < 1 or revno > self.revno():
1005
raise errors.InvalidRevisionNumber(revno)
1008
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1009
"""Clone this branch into to_bzrdir preserving all semantic values.
1011
Most API users will want 'create_clone_on_transport', which creates a
1012
new bzrdir and branch on the fly.
1014
revision_id: if not None, the revision history in the new branch will
1015
be truncated to end with revision_id.
1017
result = to_bzrdir.create_branch()
1020
if repository_policy is not None:
1021
repository_policy.configure_branch(result)
1022
self.copy_content_into(result, revision_id=revision_id)
1028
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1029
"""Create a new line of development from the branch, into to_bzrdir.
1031
to_bzrdir controls the branch format.
1033
revision_id: if not None, the revision history in the new branch will
1034
be truncated to end with revision_id.
1036
result = to_bzrdir.create_branch()
1039
if repository_policy is not None:
1040
repository_policy.configure_branch(result)
1041
self.copy_content_into(result, revision_id=revision_id)
1042
result.set_parent(self.bzrdir.root_transport.base)
1047
def _synchronize_history(self, destination, revision_id):
1048
"""Synchronize last revision and revision history between branches.
1050
This version is most efficient when the destination is also a
1051
BzrBranch6, but works for BzrBranch5, as long as the destination's
1052
repository contains all the lefthand ancestors of the intended
1053
last_revision. If not, set_last_revision_info will fail.
1055
:param destination: The branch to copy the history into
1056
:param revision_id: The revision-id to truncate history at. May
1057
be None to copy complete history.
1059
source_revno, source_revision_id = self.last_revision_info()
1060
if revision_id is None:
1061
revno, revision_id = source_revno, source_revision_id
1062
elif source_revision_id == revision_id:
1063
# we know the revno without needing to walk all of history
1064
revno = source_revno
1066
# To figure out the revno for a random revision, we need to build
1067
# the revision history, and count its length.
1068
# We don't care about the order, just how long it is.
1069
# Alternatively, we could start at the current location, and count
1070
# backwards. But there is no guarantee that we will find it since
1071
# it may be a merged revision.
1072
revno = len(list(self.repository.iter_reverse_revision_history(
1074
destination.set_last_revision_info(revno, revision_id)
1077
def copy_content_into(self, destination, revision_id=None):
1078
"""Copy the content of self into destination.
1080
revision_id: if not None, the revision history in the new branch will
1081
be truncated to end with revision_id.
1083
self.update_references(destination)
1084
self._synchronize_history(destination, revision_id)
1086
parent = self.get_parent()
1087
except errors.InaccessibleParent, e:
1088
mutter('parent was not accessible to copy: %s', e)
1091
destination.set_parent(parent)
1092
if self._push_should_merge_tags():
1093
self.tags.merge_to(destination.tags)
1095
def update_references(self, target):
1096
if not getattr(self._format, 'supports_reference_locations', False):
1098
reference_dict = self._get_all_reference_info()
1099
if len(reference_dict) == 0:
1101
old_base = self.base
1102
new_base = target.base
1103
target_reference_dict = target._get_all_reference_info()
1104
for file_id, (tree_path, branch_location) in (
1105
reference_dict.items()):
1106
branch_location = urlutils.rebase_url(branch_location,
1108
target_reference_dict.setdefault(
1109
file_id, (tree_path, branch_location))
1110
target._set_all_reference_info(target_reference_dict)
1114
"""Check consistency of the branch.
1116
In particular this checks that revisions given in the revision-history
1117
do actually match up in the revision graph, and that they're all
1118
present in the repository.
1120
Callers will typically also want to check the repository.
1122
:return: A BranchCheckResult.
1124
mainline_parent_id = None
1125
last_revno, last_revision_id = self.last_revision_info()
1126
real_rev_history = list(self.repository.iter_reverse_revision_history(
1128
real_rev_history.reverse()
1129
if len(real_rev_history) != last_revno:
1130
raise errors.BzrCheckError('revno does not match len(mainline)'
1131
' %s != %s' % (last_revno, len(real_rev_history)))
1132
# TODO: We should probably also check that real_rev_history actually
1133
# matches self.revision_history()
1134
for revision_id in real_rev_history:
1136
revision = self.repository.get_revision(revision_id)
1137
except errors.NoSuchRevision, e:
1138
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1140
# In general the first entry on the revision history has no parents.
1141
# But it's not illegal for it to have parents listed; this can happen
1142
# in imports from Arch when the parents weren't reachable.
1143
if mainline_parent_id is not None:
1144
if mainline_parent_id not in revision.parent_ids:
1145
raise errors.BzrCheckError("previous revision {%s} not listed among "
1147
% (mainline_parent_id, revision_id))
1148
mainline_parent_id = revision_id
1149
return BranchCheckResult(self)
1151
def _get_checkout_format(self):
1152
"""Return the most suitable metadir for a checkout of this branch.
1153
Weaves are used if this branch's repository uses weaves.
1155
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1156
from bzrlib.repofmt import weaverepo
1157
format = bzrdir.BzrDirMetaFormat1()
1158
format.repository_format = weaverepo.RepositoryFormat7()
1160
format = self.repository.bzrdir.checkout_metadir()
1161
format.set_branch_format(self._format)
1164
def create_clone_on_transport(self, to_transport, revision_id=None,
1165
stacked_on=None, create_prefix=False, use_existing_dir=False):
1166
"""Create a clone of this branch and its bzrdir.
1168
:param to_transport: The transport to clone onto.
1169
:param revision_id: The revision id to use as tip in the new branch.
1170
If None the tip is obtained from this branch.
1171
:param stacked_on: An optional URL to stack the clone on.
1172
:param create_prefix: Create any missing directories leading up to
1174
:param use_existing_dir: Use an existing directory if one exists.
1176
# XXX: Fix the bzrdir API to allow getting the branch back from the
1177
# clone call. Or something. 20090224 RBC/spiv.
1178
if revision_id is None:
1179
revision_id = self.last_revision()
1181
dir_to = self.bzrdir.clone_on_transport(to_transport,
1182
revision_id=revision_id, stacked_on=stacked_on,
1183
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1184
except errors.FileExists:
1185
if not use_existing_dir:
1187
except errors.NoSuchFile:
1188
if not create_prefix:
1190
return dir_to.open_branch()
1192
def create_checkout(self, to_location, revision_id=None,
1193
lightweight=False, accelerator_tree=None,
1195
"""Create a checkout of a branch.
1197
:param to_location: The url to produce the checkout at
1198
:param revision_id: The revision to check out
1199
:param lightweight: If True, produce a lightweight checkout, otherwise,
1200
produce a bound branch (heavyweight checkout)
1201
:param accelerator_tree: A tree which can be used for retrieving file
1202
contents more quickly than the revision tree, i.e. a workingtree.
1203
The revision tree will be used for cases where accelerator_tree's
1204
content is different.
1205
:param hardlink: If true, hard-link files from accelerator_tree,
1207
:return: The tree of the created checkout
1209
t = transport.get_transport(to_location)
1212
format = self._get_checkout_format()
1213
checkout = format.initialize_on_transport(t)
1214
from_branch = BranchReferenceFormat().initialize(checkout, self)
1216
format = self._get_checkout_format()
1217
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1218
to_location, force_new_tree=False, format=format)
1219
checkout = checkout_branch.bzrdir
1220
checkout_branch.bind(self)
1221
# pull up to the specified revision_id to set the initial
1222
# branch tip correctly, and seed it with history.
1223
checkout_branch.pull(self, stop_revision=revision_id)
1225
tree = checkout.create_workingtree(revision_id,
1226
from_branch=from_branch,
1227
accelerator_tree=accelerator_tree,
1229
basis_tree = tree.basis_tree()
1230
basis_tree.lock_read()
1232
for path, file_id in basis_tree.iter_references():
1233
reference_parent = self.reference_parent(file_id, path)
1234
reference_parent.create_checkout(tree.abspath(path),
1235
basis_tree.get_reference_revision(file_id, path),
1242
def reconcile(self, thorough=True):
1243
"""Make sure the data stored in this branch is consistent."""
1244
from bzrlib.reconcile import BranchReconciler
1245
reconciler = BranchReconciler(self, thorough=thorough)
1246
reconciler.reconcile()
1249
def reference_parent(self, file_id, path, possible_transports=None):
1250
"""Return the parent branch for a tree-reference file_id
1251
:param file_id: The file_id of the tree reference
1252
:param path: The path of the file_id in the tree
1253
:return: A branch associated with the file_id
1255
# FIXME should provide multiple branches, based on config
1256
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1257
possible_transports=possible_transports)
1259
def supports_tags(self):
1260
return self._format.supports_tags()
1262
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1264
"""Ensure that revision_b is a descendant of revision_a.
1266
This is a helper function for update_revisions.
1268
:raises: DivergedBranches if revision_b has diverged from revision_a.
1269
:returns: True if revision_b is a descendant of revision_a.
1271
relation = self._revision_relations(revision_a, revision_b, graph)
1272
if relation == 'b_descends_from_a':
1274
elif relation == 'diverged':
1275
raise errors.DivergedBranches(self, other_branch)
1276
elif relation == 'a_descends_from_b':
1279
raise AssertionError("invalid relation: %r" % (relation,))
1281
def _revision_relations(self, revision_a, revision_b, graph):
1282
"""Determine the relationship between two revisions.
1284
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1286
heads = graph.heads([revision_a, revision_b])
1287
if heads == set([revision_b]):
1288
return 'b_descends_from_a'
1289
elif heads == set([revision_a, revision_b]):
1290
# These branches have diverged
1292
elif heads == set([revision_a]):
1293
return 'a_descends_from_b'
1295
raise AssertionError("invalid heads: %r" % (heads,))
1298
class BranchFormat(object):
1299
"""An encapsulation of the initialization and open routines for a format.
1301
Formats provide three things:
1302
* An initialization routine,
1306
Formats are placed in an dict by their format string for reference
1307
during branch opening. Its not required that these be instances, they
1308
can be classes themselves with class methods - it simply depends on
1309
whether state is needed for a given format or not.
1311
Once a format is deprecated, just deprecate the initialize and open
1312
methods on the format class. Do not deprecate the object, as the
1313
object will be created every time regardless.
1316
_default_format = None
1317
"""The default format used for new branches."""
1320
"""The known formats."""
1322
def __eq__(self, other):
1323
return self.__class__ is other.__class__
1325
def __ne__(self, other):
1326
return not (self == other)
1329
def find_format(klass, a_bzrdir):
1330
"""Return the format for the branch object in a_bzrdir."""
1332
transport = a_bzrdir.get_branch_transport(None)
1333
format_string = transport.get("format").read()
1334
return klass._formats[format_string]
1335
except errors.NoSuchFile:
1336
raise errors.NotBranchError(path=transport.base)
1338
raise errors.UnknownFormatError(format=format_string, kind='branch')
1341
def get_default_format(klass):
1342
"""Return the current default format."""
1343
return klass._default_format
1345
def get_reference(self, a_bzrdir):
1346
"""Get the target reference of the branch in a_bzrdir.
1348
format probing must have been completed before calling
1349
this method - it is assumed that the format of the branch
1350
in a_bzrdir is correct.
1352
:param a_bzrdir: The bzrdir to get the branch data from.
1353
:return: None if the branch is not a reference branch.
1358
def set_reference(self, a_bzrdir, to_branch):
1359
"""Set the target reference of the branch in a_bzrdir.
1361
format probing must have been completed before calling
1362
this method - it is assumed that the format of the branch
1363
in a_bzrdir is correct.
1365
:param a_bzrdir: The bzrdir to set the branch reference for.
1366
:param to_branch: branch that the checkout is to reference
1368
raise NotImplementedError(self.set_reference)
1370
def get_format_string(self):
1371
"""Return the ASCII format string that identifies this format."""
1372
raise NotImplementedError(self.get_format_string)
1374
def get_format_description(self):
1375
"""Return the short format description for this format."""
1376
raise NotImplementedError(self.get_format_description)
1378
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1380
"""Initialize a branch in a bzrdir, with specified files
1382
:param a_bzrdir: The bzrdir to initialize the branch in
1383
:param utf8_files: The files to create as a list of
1384
(filename, content) tuples
1385
:param set_format: If True, set the format with
1386
self.get_format_string. (BzrBranch4 has its format set
1388
:return: a branch in this format
1390
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1391
branch_transport = a_bzrdir.get_branch_transport(self)
1393
'metadir': ('lock', lockdir.LockDir),
1394
'branch4': ('branch-lock', lockable_files.TransportLock),
1396
lock_name, lock_class = lock_map[lock_type]
1397
control_files = lockable_files.LockableFiles(branch_transport,
1398
lock_name, lock_class)
1399
control_files.create_lock()
1400
control_files.lock_write()
1402
utf8_files += [('format', self.get_format_string())]
1404
for (filename, content) in utf8_files:
1405
branch_transport.put_bytes(
1407
mode=a_bzrdir._get_file_mode())
1409
control_files.unlock()
1410
return self.open(a_bzrdir, _found=True)
1412
def initialize(self, a_bzrdir):
1413
"""Create a branch of this format in a_bzrdir."""
1414
raise NotImplementedError(self.initialize)
1416
def is_supported(self):
1417
"""Is this format supported?
1419
Supported formats can be initialized and opened.
1420
Unsupported formats may not support initialization or committing or
1421
some other features depending on the reason for not being supported.
1425
def make_tags(self, branch):
1426
"""Create a tags object for branch.
1428
This method is on BranchFormat, because BranchFormats are reflected
1429
over the wire via network_name(), whereas full Branch instances require
1430
multiple VFS method calls to operate at all.
1432
The default implementation returns a disabled-tags instance.
1434
Note that it is normal for branch to be a RemoteBranch when using tags
1437
return DisabledTags(branch)
1439
def network_name(self):
1440
"""A simple byte string uniquely identifying this format for RPC calls.
1442
MetaDir branch formats use their disk format string to identify the
1443
repository over the wire. All in one formats such as bzr < 0.8, and
1444
foreign formats like svn/git and hg should use some marker which is
1445
unique and immutable.
1447
raise NotImplementedError(self.network_name)
1449
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1450
"""Return the branch object for a_bzrdir
1452
:param a_bzrdir: A BzrDir that contains a branch.
1453
:param _found: a private parameter, do not use it. It is used to
1454
indicate if format probing has already be done.
1455
:param ignore_fallbacks: when set, no fallback branches will be opened
1456
(if there are any). Default is to open fallbacks.
1458
raise NotImplementedError(self.open)
1461
def register_format(klass, format):
1462
"""Register a metadir format."""
1463
klass._formats[format.get_format_string()] = format
1464
# Metadir formats have a network name of their format string, and get
1465
# registered as class factories.
1466
network_format_registry.register(format.get_format_string(), format.__class__)
1469
def set_default_format(klass, format):
1470
klass._default_format = format
1472
def supports_stacking(self):
1473
"""True if this format records a stacked-on branch."""
1477
def unregister_format(klass, format):
1478
del klass._formats[format.get_format_string()]
1481
return self.get_format_description().rstrip()
1483
def supports_tags(self):
1484
"""True if this format supports tags stored in the branch"""
1485
return False # by default
1488
class BranchHooks(Hooks):
1489
"""A dictionary mapping hook name to a list of callables for branch hooks.
1491
e.g. ['set_rh'] Is the list of items to be called when the
1492
set_revision_history function is invoked.
1496
"""Create the default hooks.
1498
These are all empty initially, because by default nothing should get
1501
Hooks.__init__(self)
1502
self.create_hook(HookPoint('set_rh',
1503
"Invoked whenever the revision history has been set via "
1504
"set_revision_history. The api signature is (branch, "
1505
"revision_history), and the branch will be write-locked. "
1506
"The set_rh hook can be expensive for bzr to trigger, a better "
1507
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1508
self.create_hook(HookPoint('open',
1509
"Called with the Branch object that has been opened after a "
1510
"branch is opened.", (1, 8), None))
1511
self.create_hook(HookPoint('post_push',
1512
"Called after a push operation completes. post_push is called "
1513
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1514
"bzr client.", (0, 15), None))
1515
self.create_hook(HookPoint('post_pull',
1516
"Called after a pull operation completes. post_pull is called "
1517
"with a bzrlib.branch.PullResult object and only runs in the "
1518
"bzr client.", (0, 15), None))
1519
self.create_hook(HookPoint('pre_commit',
1520
"Called after a commit is calculated but before it is is "
1521
"completed. pre_commit is called with (local, master, old_revno, "
1522
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1523
"). old_revid is NULL_REVISION for the first commit to a branch, "
1524
"tree_delta is a TreeDelta object describing changes from the "
1525
"basis revision. hooks MUST NOT modify this delta. "
1526
" future_tree is an in-memory tree obtained from "
1527
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1528
"tree.", (0,91), None))
1529
self.create_hook(HookPoint('post_commit',
1530
"Called in the bzr client after a commit has completed. "
1531
"post_commit is called with (local, master, old_revno, old_revid, "
1532
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1533
"commit to a branch.", (0, 15), None))
1534
self.create_hook(HookPoint('post_uncommit',
1535
"Called in the bzr client after an uncommit completes. "
1536
"post_uncommit is called with (local, master, old_revno, "
1537
"old_revid, new_revno, new_revid) where local is the local branch "
1538
"or None, master is the target branch, and an empty branch "
1539
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1540
self.create_hook(HookPoint('pre_change_branch_tip',
1541
"Called in bzr client and server before a change to the tip of a "
1542
"branch is made. pre_change_branch_tip is called with a "
1543
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1544
"commit, uncommit will all trigger this hook.", (1, 6), None))
1545
self.create_hook(HookPoint('post_change_branch_tip',
1546
"Called in bzr client and server after a change to the tip of a "
1547
"branch is made. post_change_branch_tip is called with a "
1548
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1549
"commit, uncommit will all trigger this hook.", (1, 4), None))
1550
self.create_hook(HookPoint('transform_fallback_location',
1551
"Called when a stacked branch is activating its fallback "
1552
"locations. transform_fallback_location is called with (branch, "
1553
"url), and should return a new url. Returning the same url "
1554
"allows it to be used as-is, returning a different one can be "
1555
"used to cause the branch to stack on a closer copy of that "
1556
"fallback_location. Note that the branch cannot have history "
1557
"accessing methods called on it during this hook because the "
1558
"fallback locations have not been activated. When there are "
1559
"multiple hooks installed for transform_fallback_location, "
1560
"all are called with the url returned from the previous hook."
1561
"The order is however undefined.", (1, 9), None))
1564
# install the default hooks into the Branch class.
1565
Branch.hooks = BranchHooks()
1568
class ChangeBranchTipParams(object):
1569
"""Object holding parameters passed to *_change_branch_tip hooks.
1571
There are 5 fields that hooks may wish to access:
1573
:ivar branch: the branch being changed
1574
:ivar old_revno: revision number before the change
1575
:ivar new_revno: revision number after the change
1576
:ivar old_revid: revision id before the change
1577
:ivar new_revid: revision id after the change
1579
The revid fields are strings. The revno fields are integers.
1582
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1583
"""Create a group of ChangeBranchTip parameters.
1585
:param branch: The branch being changed.
1586
:param old_revno: Revision number before the change.
1587
:param new_revno: Revision number after the change.
1588
:param old_revid: Tip revision id before the change.
1589
:param new_revid: Tip revision id after the change.
1591
self.branch = branch
1592
self.old_revno = old_revno
1593
self.new_revno = new_revno
1594
self.old_revid = old_revid
1595
self.new_revid = new_revid
1597
def __eq__(self, other):
1598
return self.__dict__ == other.__dict__
1601
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1602
self.__class__.__name__, self.branch,
1603
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1606
class BzrBranchFormat4(BranchFormat):
1607
"""Bzr branch format 4.
1610
- a revision-history file.
1611
- a branch-lock lock file [ to be shared with the bzrdir ]
1614
def get_format_description(self):
1615
"""See BranchFormat.get_format_description()."""
1616
return "Branch format 4"
1618
def initialize(self, a_bzrdir):
1619
"""Create a branch of this format in a_bzrdir."""
1620
utf8_files = [('revision-history', ''),
1621
('branch-name', ''),
1623
return self._initialize_helper(a_bzrdir, utf8_files,
1624
lock_type='branch4', set_format=False)
1627
super(BzrBranchFormat4, self).__init__()
1628
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1630
def network_name(self):
1631
"""The network name for this format is the control dirs disk label."""
1632
return self._matchingbzrdir.get_format_string()
1634
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1635
"""See BranchFormat.open()."""
1637
# we are being called directly and must probe.
1638
raise NotImplementedError
1639
return BzrBranch(_format=self,
1640
_control_files=a_bzrdir._control_files,
1642
_repository=a_bzrdir.open_repository())
1645
return "Bazaar-NG branch format 4"
1648
class BranchFormatMetadir(BranchFormat):
1649
"""Common logic for meta-dir based branch formats."""
1651
def _branch_class(self):
1652
"""What class to instantiate on open calls."""
1653
raise NotImplementedError(self._branch_class)
1655
def network_name(self):
1656
"""A simple byte string uniquely identifying this format for RPC calls.
1658
Metadir branch formats use their format string.
1660
return self.get_format_string()
1662
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1663
"""See BranchFormat.open()."""
1665
format = BranchFormat.find_format(a_bzrdir)
1666
if format.__class__ != self.__class__:
1667
raise AssertionError("wrong format %r found for %r" %
1670
transport = a_bzrdir.get_branch_transport(None)
1671
control_files = lockable_files.LockableFiles(transport, 'lock',
1673
return self._branch_class()(_format=self,
1674
_control_files=control_files,
1676
_repository=a_bzrdir.find_repository(),
1677
ignore_fallbacks=ignore_fallbacks)
1678
except errors.NoSuchFile:
1679
raise errors.NotBranchError(path=transport.base)
1682
super(BranchFormatMetadir, self).__init__()
1683
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1684
self._matchingbzrdir.set_branch_format(self)
1686
def supports_tags(self):
1690
class BzrBranchFormat5(BranchFormatMetadir):
1691
"""Bzr branch format 5.
1694
- a revision-history file.
1696
- a lock dir guarding the branch itself
1697
- all of this stored in a branch/ subdirectory
1698
- works with shared repositories.
1700
This format is new in bzr 0.8.
1703
def _branch_class(self):
1706
def get_format_string(self):
1707
"""See BranchFormat.get_format_string()."""
1708
return "Bazaar-NG branch format 5\n"
1710
def get_format_description(self):
1711
"""See BranchFormat.get_format_description()."""
1712
return "Branch format 5"
1714
def initialize(self, a_bzrdir):
1715
"""Create a branch of this format in a_bzrdir."""
1716
utf8_files = [('revision-history', ''),
1717
('branch-name', ''),
1719
return self._initialize_helper(a_bzrdir, utf8_files)
1721
def supports_tags(self):
1725
class BzrBranchFormat6(BranchFormatMetadir):
1726
"""Branch format with last-revision and tags.
1728
Unlike previous formats, this has no explicit revision history. Instead,
1729
this just stores the last-revision, and the left-hand history leading
1730
up to there is the history.
1732
This format was introduced in bzr 0.15
1733
and became the default in 0.91.
1736
def _branch_class(self):
1739
def get_format_string(self):
1740
"""See BranchFormat.get_format_string()."""
1741
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1743
def get_format_description(self):
1744
"""See BranchFormat.get_format_description()."""
1745
return "Branch format 6"
1747
def initialize(self, a_bzrdir):
1748
"""Create a branch of this format in a_bzrdir."""
1749
utf8_files = [('last-revision', '0 null:\n'),
1750
('branch.conf', ''),
1753
return self._initialize_helper(a_bzrdir, utf8_files)
1755
def make_tags(self, branch):
1756
"""See bzrlib.branch.BranchFormat.make_tags()."""
1757
return BasicTags(branch)
1761
class BzrBranchFormat8(BranchFormatMetadir):
1762
"""Metadir format supporting storing locations of subtree branches."""
1764
def _branch_class(self):
1767
def get_format_string(self):
1768
"""See BranchFormat.get_format_string()."""
1769
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1771
def get_format_description(self):
1772
"""See BranchFormat.get_format_description()."""
1773
return "Branch format 8"
1775
def initialize(self, a_bzrdir):
1776
"""Create a branch of this format in a_bzrdir."""
1777
utf8_files = [('last-revision', '0 null:\n'),
1778
('branch.conf', ''),
1782
return self._initialize_helper(a_bzrdir, utf8_files)
1785
super(BzrBranchFormat8, self).__init__()
1786
self._matchingbzrdir.repository_format = \
1787
RepositoryFormatKnitPack5RichRoot()
1789
def make_tags(self, branch):
1790
"""See bzrlib.branch.BranchFormat.make_tags()."""
1791
return BasicTags(branch)
1793
def supports_stacking(self):
1796
supports_reference_locations = True
1799
class BzrBranchFormat7(BzrBranchFormat8):
1800
"""Branch format with last-revision, tags, and a stacked location pointer.
1802
The stacked location pointer is passed down to the repository and requires
1803
a repository format with supports_external_lookups = True.
1805
This format was introduced in bzr 1.6.
1808
def initialize(self, a_bzrdir):
1809
"""Create a branch of this format in a_bzrdir."""
1810
utf8_files = [('last-revision', '0 null:\n'),
1811
('branch.conf', ''),
1814
return self._initialize_helper(a_bzrdir, utf8_files)
1816
def _branch_class(self):
1819
def get_format_string(self):
1820
"""See BranchFormat.get_format_string()."""
1821
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1823
def get_format_description(self):
1824
"""See BranchFormat.get_format_description()."""
1825
return "Branch format 7"
1827
supports_reference_locations = False
1830
class BranchReferenceFormat(BranchFormat):
1831
"""Bzr branch reference format.
1833
Branch references are used in implementing checkouts, they
1834
act as an alias to the real branch which is at some other url.
1841
def get_format_string(self):
1842
"""See BranchFormat.get_format_string()."""
1843
return "Bazaar-NG Branch Reference Format 1\n"
1845
def get_format_description(self):
1846
"""See BranchFormat.get_format_description()."""
1847
return "Checkout reference format 1"
1849
def get_reference(self, a_bzrdir):
1850
"""See BranchFormat.get_reference()."""
1851
transport = a_bzrdir.get_branch_transport(None)
1852
return transport.get('location').read()
1854
def set_reference(self, a_bzrdir, to_branch):
1855
"""See BranchFormat.set_reference()."""
1856
transport = a_bzrdir.get_branch_transport(None)
1857
location = transport.put_bytes('location', to_branch.base)
1859
def initialize(self, a_bzrdir, target_branch=None):
1860
"""Create a branch of this format in a_bzrdir."""
1861
if target_branch is None:
1862
# this format does not implement branch itself, thus the implicit
1863
# creation contract must see it as uninitializable
1864
raise errors.UninitializableFormat(self)
1865
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1866
branch_transport = a_bzrdir.get_branch_transport(self)
1867
branch_transport.put_bytes('location',
1868
target_branch.bzrdir.root_transport.base)
1869
branch_transport.put_bytes('format', self.get_format_string())
1871
a_bzrdir, _found=True,
1872
possible_transports=[target_branch.bzrdir.root_transport])
1875
super(BranchReferenceFormat, self).__init__()
1876
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1877
self._matchingbzrdir.set_branch_format(self)
1879
def _make_reference_clone_function(format, a_branch):
1880
"""Create a clone() routine for a branch dynamically."""
1881
def clone(to_bzrdir, revision_id=None,
1882
repository_policy=None):
1883
"""See Branch.clone()."""
1884
return format.initialize(to_bzrdir, a_branch)
1885
# cannot obey revision_id limits when cloning a reference ...
1886
# FIXME RBC 20060210 either nuke revision_id for clone, or
1887
# emit some sort of warning/error to the caller ?!
1890
def open(self, a_bzrdir, _found=False, location=None,
1891
possible_transports=None, ignore_fallbacks=False):
1892
"""Return the branch that the branch reference in a_bzrdir points at.
1894
:param a_bzrdir: A BzrDir that contains a branch.
1895
:param _found: a private parameter, do not use it. It is used to
1896
indicate if format probing has already be done.
1897
:param ignore_fallbacks: when set, no fallback branches will be opened
1898
(if there are any). Default is to open fallbacks.
1899
:param location: The location of the referenced branch. If
1900
unspecified, this will be determined from the branch reference in
1902
:param possible_transports: An optional reusable transports list.
1905
format = BranchFormat.find_format(a_bzrdir)
1906
if format.__class__ != self.__class__:
1907
raise AssertionError("wrong format %r found for %r" %
1909
if location is None:
1910
location = self.get_reference(a_bzrdir)
1911
real_bzrdir = bzrdir.BzrDir.open(
1912
location, possible_transports=possible_transports)
1913
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1914
# this changes the behaviour of result.clone to create a new reference
1915
# rather than a copy of the content of the branch.
1916
# I did not use a proxy object because that needs much more extensive
1917
# testing, and we are only changing one behaviour at the moment.
1918
# If we decide to alter more behaviours - i.e. the implicit nickname
1919
# then this should be refactored to introduce a tested proxy branch
1920
# and a subclass of that for use in overriding clone() and ....
1922
result.clone = self._make_reference_clone_function(result)
1926
network_format_registry = registry.FormatRegistry()
1927
"""Registry of formats indexed by their network name.
1929
The network name for a branch format is an identifier that can be used when
1930
referring to formats with smart server operations. See
1931
BranchFormat.network_name() for more detail.
1935
# formats which have no format string are not discoverable
1936
# and not independently creatable, so are not registered.
1937
__format5 = BzrBranchFormat5()
1938
__format6 = BzrBranchFormat6()
1939
__format7 = BzrBranchFormat7()
1940
__format8 = BzrBranchFormat8()
1941
BranchFormat.register_format(__format5)
1942
BranchFormat.register_format(BranchReferenceFormat())
1943
BranchFormat.register_format(__format6)
1944
BranchFormat.register_format(__format7)
1945
BranchFormat.register_format(__format8)
1946
BranchFormat.set_default_format(__format6)
1947
_legacy_formats = [BzrBranchFormat4(),
1949
network_format_registry.register(
1950
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1953
class BzrBranch(Branch):
1954
"""A branch stored in the actual filesystem.
1956
Note that it's "local" in the context of the filesystem; it doesn't
1957
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1958
it's writable, and can be accessed via the normal filesystem API.
1960
:ivar _transport: Transport for file operations on this branch's
1961
control files, typically pointing to the .bzr/branch directory.
1962
:ivar repository: Repository for this branch.
1963
:ivar base: The url of the base directory for this branch; the one
1964
containing the .bzr directory.
1967
def __init__(self, _format=None,
1968
_control_files=None, a_bzrdir=None, _repository=None,
1969
ignore_fallbacks=False):
1970
"""Create new branch object at a particular location."""
1971
if a_bzrdir is None:
1972
raise ValueError('a_bzrdir must be supplied')
1974
self.bzrdir = a_bzrdir
1975
self._base = self.bzrdir.transport.clone('..').base
1976
# XXX: We should be able to just do
1977
# self.base = self.bzrdir.root_transport.base
1978
# but this does not quite work yet -- mbp 20080522
1979
self._format = _format
1980
if _control_files is None:
1981
raise ValueError('BzrBranch _control_files is None')
1982
self.control_files = _control_files
1983
self._transport = _control_files._transport
1984
self.repository = _repository
1985
Branch.__init__(self)
1988
return '%s(%r)' % (self.__class__.__name__, self.base)
1992
def _get_base(self):
1993
"""Returns the directory containing the control directory."""
1996
base = property(_get_base, doc="The URL for the root of this branch.")
1998
def _get_config(self):
1999
return TransportConfig(self._transport, 'branch.conf')
2001
def is_locked(self):
2002
return self.control_files.is_locked()
2004
def lock_write(self, token=None):
2005
# All-in-one needs to always unlock/lock.
2006
repo_control = getattr(self.repository, 'control_files', None)
2007
if self.control_files == repo_control or not self.is_locked():
2008
self.repository.lock_write()
2013
return self.control_files.lock_write(token=token)
2016
self.repository.unlock()
2019
def lock_read(self):
2020
# All-in-one needs to always unlock/lock.
2021
repo_control = getattr(self.repository, 'control_files', None)
2022
if self.control_files == repo_control or not self.is_locked():
2023
self.repository.lock_read()
2028
self.control_files.lock_read()
2031
self.repository.unlock()
2036
self.control_files.unlock()
2038
# All-in-one needs to always unlock/lock.
2039
repo_control = getattr(self.repository, 'control_files', None)
2040
if (self.control_files == repo_control or
2041
not self.control_files.is_locked()):
2042
self.repository.unlock()
2043
if not self.control_files.is_locked():
2044
# we just released the lock
2045
self._clear_cached_state()
2047
def peek_lock_mode(self):
2048
if self.control_files._lock_count == 0:
2051
return self.control_files._lock_mode
2053
def get_physical_lock_status(self):
2054
return self.control_files.get_physical_lock_status()
2057
def print_file(self, file, revision_id):
2058
"""See Branch.print_file."""
2059
return self.repository.print_file(file, revision_id)
2061
def _write_revision_history(self, history):
2062
"""Factored out of set_revision_history.
2064
This performs the actual writing to disk.
2065
It is intended to be called by BzrBranch5.set_revision_history."""
2066
self._transport.put_bytes(
2067
'revision-history', '\n'.join(history),
2068
mode=self.bzrdir._get_file_mode())
2071
def set_revision_history(self, rev_history):
2072
"""See Branch.set_revision_history."""
2073
if 'evil' in debug.debug_flags:
2074
mutter_callsite(3, "set_revision_history scales with history.")
2075
check_not_reserved_id = _mod_revision.check_not_reserved_id
2076
for rev_id in rev_history:
2077
check_not_reserved_id(rev_id)
2078
if Branch.hooks['post_change_branch_tip']:
2079
# Don't calculate the last_revision_info() if there are no hooks
2081
old_revno, old_revid = self.last_revision_info()
2082
if len(rev_history) == 0:
2083
revid = _mod_revision.NULL_REVISION
2085
revid = rev_history[-1]
2086
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2087
self._write_revision_history(rev_history)
2088
self._clear_cached_state()
2089
self._cache_revision_history(rev_history)
2090
for hook in Branch.hooks['set_rh']:
2091
hook(self, rev_history)
2092
if Branch.hooks['post_change_branch_tip']:
2093
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2095
def _synchronize_history(self, destination, revision_id):
2096
"""Synchronize last revision and revision history between branches.
2098
This version is most efficient when the destination is also a
2099
BzrBranch5, but works for BzrBranch6 as long as the revision
2100
history is the true lefthand parent history, and all of the revisions
2101
are in the destination's repository. If not, set_revision_history
2104
:param destination: The branch to copy the history into
2105
:param revision_id: The revision-id to truncate history at. May
2106
be None to copy complete history.
2108
if not isinstance(destination._format, BzrBranchFormat5):
2109
super(BzrBranch, self)._synchronize_history(
2110
destination, revision_id)
2112
if revision_id == _mod_revision.NULL_REVISION:
2115
new_history = self.revision_history()
2116
if revision_id is not None and new_history != []:
2118
new_history = new_history[:new_history.index(revision_id) + 1]
2120
rev = self.repository.get_revision(revision_id)
2121
new_history = rev.get_history(self.repository)[1:]
2122
destination.set_revision_history(new_history)
2125
def set_last_revision_info(self, revno, revision_id):
2126
"""Set the last revision of this branch.
2128
The caller is responsible for checking that the revno is correct
2129
for this revision id.
2131
It may be possible to set the branch last revision to an id not
2132
present in the repository. However, branches can also be
2133
configured to check constraints on history, in which case this may not
2136
revision_id = _mod_revision.ensure_null(revision_id)
2137
# this old format stores the full history, but this api doesn't
2138
# provide it, so we must generate, and might as well check it's
2140
history = self._lefthand_history(revision_id)
2141
if len(history) != revno:
2142
raise AssertionError('%d != %d' % (len(history), revno))
2143
self.set_revision_history(history)
2145
def _gen_revision_history(self):
2146
history = self._transport.get_bytes('revision-history').split('\n')
2147
if history[-1:] == ['']:
2148
# There shouldn't be a trailing newline, but just in case.
2153
def generate_revision_history(self, revision_id, last_rev=None,
2155
"""Create a new revision history that will finish with revision_id.
2157
:param revision_id: the new tip to use.
2158
:param last_rev: The previous last_revision. If not None, then this
2159
must be a ancestory of revision_id, or DivergedBranches is raised.
2160
:param other_branch: The other branch that DivergedBranches should
2161
raise with respect to.
2163
self.set_revision_history(self._lefthand_history(revision_id,
2164
last_rev, other_branch))
2166
def basis_tree(self):
2167
"""See Branch.basis_tree."""
2168
return self.repository.revision_tree(self.last_revision())
2171
def pull(self, source, overwrite=False, stop_revision=None,
2172
_hook_master=None, run_hooks=True, possible_transports=None,
2173
_override_hook_target=None):
2176
:param _hook_master: Private parameter - set the branch to
2177
be supplied as the master to pull hooks.
2178
:param run_hooks: Private parameter - if false, this branch
2179
is being called because it's the master of the primary branch,
2180
so it should not run its hooks.
2181
:param _override_hook_target: Private parameter - set the branch to be
2182
supplied as the target_branch to pull hooks.
2184
result = PullResult()
2185
result.source_branch = source
2186
if _override_hook_target is None:
2187
result.target_branch = self
2189
result.target_branch = _override_hook_target
2192
# We assume that during 'pull' the local repository is closer than
2194
source.update_references(self)
2195
graph = self.repository.get_graph(source.repository)
2196
result.old_revno, result.old_revid = self.last_revision_info()
2197
self.update_revisions(source, stop_revision, overwrite=overwrite,
2199
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2200
result.new_revno, result.new_revid = self.last_revision_info()
2202
result.master_branch = _hook_master
2203
result.local_branch = result.target_branch
2205
result.master_branch = result.target_branch
2206
result.local_branch = None
2208
for hook in Branch.hooks['post_pull']:
2214
def _get_parent_location(self):
2215
_locs = ['parent', 'pull', 'x-pull']
2218
return self._transport.get_bytes(l).strip('\n')
2219
except errors.NoSuchFile:
2224
def push(self, target, overwrite=False, stop_revision=None,
2225
_override_hook_source_branch=None):
2228
This is the basic concrete implementation of push()
2230
:param _override_hook_source_branch: If specified, run
2231
the hooks passing this Branch as the source, rather than self.
2232
This is for use of RemoteBranch, where push is delegated to the
2233
underlying vfs-based Branch.
2235
# TODO: Public option to disable running hooks - should be trivial but
2237
return _run_with_write_locked_target(
2238
target, self._push_with_bound_branches, target, overwrite,
2240
_override_hook_source_branch=_override_hook_source_branch)
2242
def _push_with_bound_branches(self, target, overwrite,
2244
_override_hook_source_branch=None):
2245
"""Push from self into target, and into target's master if any.
2247
This is on the base BzrBranch class even though it doesn't support
2248
bound branches because the *target* might be bound.
2251
if _override_hook_source_branch:
2252
result.source_branch = _override_hook_source_branch
2253
for hook in Branch.hooks['post_push']:
2256
bound_location = target.get_bound_location()
2257
if bound_location and target.base != bound_location:
2258
# there is a master branch.
2260
# XXX: Why the second check? Is it even supported for a branch to
2261
# be bound to itself? -- mbp 20070507
2262
master_branch = target.get_master_branch()
2263
master_branch.lock_write()
2265
# push into the master from this branch.
2266
self._basic_push(master_branch, overwrite, stop_revision)
2267
# and push into the target branch from this. Note that we push from
2268
# this branch again, because its considered the highest bandwidth
2270
result = self._basic_push(target, overwrite, stop_revision)
2271
result.master_branch = master_branch
2272
result.local_branch = target
2276
master_branch.unlock()
2279
result = self._basic_push(target, overwrite, stop_revision)
2280
# TODO: Why set master_branch and local_branch if there's no
2281
# binding? Maybe cleaner to just leave them unset? -- mbp
2283
result.master_branch = target
2284
result.local_branch = None
2288
def _basic_push(self, target, overwrite, stop_revision):
2289
"""Basic implementation of push without bound branches or hooks.
2291
Must be called with self read locked and target write locked.
2293
result = BranchPushResult()
2294
result.source_branch = self
2295
result.target_branch = target
2296
result.old_revno, result.old_revid = target.last_revision_info()
2297
self.update_references(target)
2298
if result.old_revid != self.last_revision():
2299
# We assume that during 'push' this repository is closer than
2301
graph = self.repository.get_graph(target.repository)
2302
target.update_revisions(self, stop_revision, overwrite=overwrite,
2304
if self._push_should_merge_tags():
2305
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2306
result.new_revno, result.new_revid = target.last_revision_info()
2309
def get_stacked_on_url(self):
2310
raise errors.UnstackableBranchFormat(self._format, self.base)
2312
def set_push_location(self, location):
2313
"""See Branch.set_push_location."""
2314
self.get_config().set_user_option(
2315
'push_location', location,
2316
store=_mod_config.STORE_LOCATION_NORECURSE)
2318
def _set_parent_location(self, url):
2320
self._transport.delete('parent')
2322
self._transport.put_bytes('parent', url + '\n',
2323
mode=self.bzrdir._get_file_mode())
2326
class BzrBranch5(BzrBranch):
2327
"""A format 5 branch. This supports new features over plain branches.
2329
It has support for a master_branch which is the data for bound branches.
2333
def pull(self, source, overwrite=False, stop_revision=None,
2334
run_hooks=True, possible_transports=None,
2335
_override_hook_target=None):
2336
"""Pull from source into self, updating my master if any.
2338
:param run_hooks: Private parameter - if false, this branch
2339
is being called because it's the master of the primary branch,
2340
so it should not run its hooks.
2342
bound_location = self.get_bound_location()
2343
master_branch = None
2344
if bound_location and source.base != bound_location:
2345
# not pulling from master, so we need to update master.
2346
master_branch = self.get_master_branch(possible_transports)
2347
master_branch.lock_write()
2350
# pull from source into master.
2351
master_branch.pull(source, overwrite, stop_revision,
2353
return super(BzrBranch5, self).pull(source, overwrite,
2354
stop_revision, _hook_master=master_branch,
2355
run_hooks=run_hooks,
2356
_override_hook_target=_override_hook_target)
2359
master_branch.unlock()
2361
def get_bound_location(self):
2363
return self._transport.get_bytes('bound')[:-1]
2364
except errors.NoSuchFile:
2368
def get_master_branch(self, possible_transports=None):
2369
"""Return the branch we are bound to.
2371
:return: Either a Branch, or None
2373
This could memoise the branch, but if thats done
2374
it must be revalidated on each new lock.
2375
So for now we just don't memoise it.
2376
# RBC 20060304 review this decision.
2378
bound_loc = self.get_bound_location()
2382
return Branch.open(bound_loc,
2383
possible_transports=possible_transports)
2384
except (errors.NotBranchError, errors.ConnectionError), e:
2385
raise errors.BoundBranchConnectionFailure(
2389
def set_bound_location(self, location):
2390
"""Set the target where this branch is bound to.
2392
:param location: URL to the target branch
2395
self._transport.put_bytes('bound', location+'\n',
2396
mode=self.bzrdir._get_file_mode())
2399
self._transport.delete('bound')
2400
except errors.NoSuchFile:
2405
def bind(self, other):
2406
"""Bind this branch to the branch other.
2408
This does not push or pull data between the branches, though it does
2409
check for divergence to raise an error when the branches are not
2410
either the same, or one a prefix of the other. That behaviour may not
2411
be useful, so that check may be removed in future.
2413
:param other: The branch to bind to
2416
# TODO: jam 20051230 Consider checking if the target is bound
2417
# It is debatable whether you should be able to bind to
2418
# a branch which is itself bound.
2419
# Committing is obviously forbidden,
2420
# but binding itself may not be.
2421
# Since we *have* to check at commit time, we don't
2422
# *need* to check here
2424
# we want to raise diverged if:
2425
# last_rev is not in the other_last_rev history, AND
2426
# other_last_rev is not in our history, and do it without pulling
2428
self.set_bound_location(other.base)
2432
"""If bound, unbind"""
2433
return self.set_bound_location(None)
2436
def update(self, possible_transports=None):
2437
"""Synchronise this branch with the master branch if any.
2439
:return: None or the last_revision that was pivoted out during the
2442
master = self.get_master_branch(possible_transports)
2443
if master is not None:
2444
old_tip = _mod_revision.ensure_null(self.last_revision())
2445
self.pull(master, overwrite=True)
2446
if self.repository.get_graph().is_ancestor(old_tip,
2447
_mod_revision.ensure_null(self.last_revision())):
2453
class BzrBranch8(BzrBranch5):
2454
"""A branch that stores tree-reference locations."""
2456
def _open_hook(self):
2457
if self._ignore_fallbacks:
2460
url = self.get_stacked_on_url()
2461
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2462
errors.UnstackableBranchFormat):
2465
for hook in Branch.hooks['transform_fallback_location']:
2466
url = hook(self, url)
2468
hook_name = Branch.hooks.get_hook_name(hook)
2469
raise AssertionError(
2470
"'transform_fallback_location' hook %s returned "
2471
"None, not a URL." % hook_name)
2472
self._activate_fallback_location(url, None)
2474
def __init__(self, *args, **kwargs):
2475
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2476
super(BzrBranch8, self).__init__(*args, **kwargs)
2477
self._last_revision_info_cache = None
2478
self._partial_revision_history_cache = []
2479
self._reference_info = None
2481
def _clear_cached_state(self):
2482
super(BzrBranch8, self)._clear_cached_state()
2483
self._last_revision_info_cache = None
2484
self._partial_revision_history_cache = []
2485
self._reference_info = None
2487
def _last_revision_info(self):
2488
revision_string = self._transport.get_bytes('last-revision')
2489
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2490
revision_id = cache_utf8.get_cached_utf8(revision_id)
2492
return revno, revision_id
2494
def _write_last_revision_info(self, revno, revision_id):
2495
"""Simply write out the revision id, with no checks.
2497
Use set_last_revision_info to perform this safely.
2499
Does not update the revision_history cache.
2500
Intended to be called by set_last_revision_info and
2501
_write_revision_history.
2503
revision_id = _mod_revision.ensure_null(revision_id)
2504
out_string = '%d %s\n' % (revno, revision_id)
2505
self._transport.put_bytes('last-revision', out_string,
2506
mode=self.bzrdir._get_file_mode())
2509
def set_last_revision_info(self, revno, revision_id):
2510
revision_id = _mod_revision.ensure_null(revision_id)
2511
old_revno, old_revid = self.last_revision_info()
2512
if self._get_append_revisions_only():
2513
self._check_history_violation(revision_id)
2514
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2515
self._write_last_revision_info(revno, revision_id)
2516
self._clear_cached_state()
2517
self._last_revision_info_cache = revno, revision_id
2518
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2520
def _synchronize_history(self, destination, revision_id):
2521
"""Synchronize last revision and revision history between branches.
2523
:see: Branch._synchronize_history
2525
# XXX: The base Branch has a fast implementation of this method based
2526
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2527
# that uses set_revision_history. This class inherits from BzrBranch5,
2528
# but wants the fast implementation, so it calls
2529
# Branch._synchronize_history directly.
2530
Branch._synchronize_history(self, destination, revision_id)
2532
def _check_history_violation(self, revision_id):
2533
last_revision = _mod_revision.ensure_null(self.last_revision())
2534
if _mod_revision.is_null(last_revision):
2536
if last_revision not in self._lefthand_history(revision_id):
2537
raise errors.AppendRevisionsOnlyViolation(self.base)
2539
def _gen_revision_history(self):
2540
"""Generate the revision history from last revision
2542
last_revno, last_revision = self.last_revision_info()
2543
self._extend_partial_history(stop_index=last_revno-1)
2544
return list(reversed(self._partial_revision_history_cache))
2546
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2547
"""Extend the partial history to include a given index
2549
If a stop_index is supplied, stop when that index has been reached.
2550
If a stop_revision is supplied, stop when that revision is
2551
encountered. Otherwise, stop when the beginning of history is
2554
:param stop_index: The index which should be present. When it is
2555
present, history extension will stop.
2556
:param revision_id: The revision id which should be present. When
2557
it is encountered, history extension will stop.
2559
repo = self.repository
2560
if len(self._partial_revision_history_cache) == 0:
2561
iterator = repo.iter_reverse_revision_history(self.last_revision())
2563
start_revision = self._partial_revision_history_cache[-1]
2564
iterator = repo.iter_reverse_revision_history(start_revision)
2565
#skip the last revision in the list
2566
next_revision = iterator.next()
2567
for revision_id in iterator:
2568
self._partial_revision_history_cache.append(revision_id)
2569
if (stop_index is not None and
2570
len(self._partial_revision_history_cache) > stop_index):
2572
if revision_id == stop_revision:
2575
def _write_revision_history(self, history):
2576
"""Factored out of set_revision_history.
2578
This performs the actual writing to disk, with format-specific checks.
2579
It is intended to be called by BzrBranch5.set_revision_history.
2581
if len(history) == 0:
2582
last_revision = 'null:'
2584
if history != self._lefthand_history(history[-1]):
2585
raise errors.NotLefthandHistory(history)
2586
last_revision = history[-1]
2587
if self._get_append_revisions_only():
2588
self._check_history_violation(last_revision)
2589
self._write_last_revision_info(len(history), last_revision)
2592
def _set_parent_location(self, url):
2593
"""Set the parent branch"""
2594
self._set_config_location('parent_location', url, make_relative=True)
2597
def _get_parent_location(self):
2598
"""Set the parent branch"""
2599
return self._get_config_location('parent_location')
2602
def _set_all_reference_info(self, info_dict):
2603
"""Replace all reference info stored in a branch.
2605
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2608
writer = rio.RioWriter(s)
2609
for key, (tree_path, branch_location) in info_dict.iteritems():
2610
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2611
branch_location=branch_location)
2612
writer.write_stanza(stanza)
2613
self._transport.put_bytes('references', s.getvalue())
2614
self._reference_info = info_dict
2617
def _get_all_reference_info(self):
2618
"""Return all the reference info stored in a branch.
2620
:return: A dict of {file_id: (tree_path, branch_location)}
2622
if self._reference_info is not None:
2623
return self._reference_info
2624
rio_file = self._transport.get('references')
2626
stanzas = rio.read_stanzas(rio_file)
2627
info_dict = dict((s['file_id'], (s['tree_path'],
2628
s['branch_location'])) for s in stanzas)
2631
self._reference_info = info_dict
2634
def set_reference_info(self, file_id, tree_path, branch_location):
2635
"""Set the branch location to use for a tree reference.
2637
:param file_id: The file-id of the tree reference.
2638
:param tree_path: The path of the tree reference in the tree.
2639
:param branch_location: The location of the branch to retrieve tree
2642
info_dict = self._get_all_reference_info()
2643
info_dict[file_id] = (tree_path, branch_location)
2644
if None in (tree_path, branch_location):
2645
if tree_path is not None:
2646
raise ValueError('tree_path must be None when branch_location'
2648
if branch_location is not None:
2649
raise ValueError('branch_location must be None when tree_path'
2651
del info_dict[file_id]
2652
self._set_all_reference_info(info_dict)
2654
def get_reference_info(self, file_id):
2655
"""Get the tree_path and branch_location for a tree reference.
2657
:return: a tuple of (tree_path, branch_location)
2659
return self._get_all_reference_info().get(file_id, (None, None))
2661
def reference_parent(self, file_id, path, possible_transports=None):
2662
"""Return the parent branch for a tree-reference file_id.
2664
:param file_id: The file_id of the tree reference
2665
:param path: The path of the file_id in the tree
2666
:return: A branch associated with the file_id
2668
branch_location = self.get_reference_info(file_id)[1]
2669
if branch_location is None:
2670
return Branch.reference_parent(self, file_id, path,
2671
possible_transports)
2672
branch_location = urlutils.join(self.base, branch_location)
2673
return Branch.open(branch_location,
2674
possible_transports=possible_transports)
2676
def set_push_location(self, location):
2677
"""See Branch.set_push_location."""
2678
self._set_config_location('push_location', location)
2680
def set_bound_location(self, location):
2681
"""See Branch.set_push_location."""
2683
config = self.get_config()
2684
if location is None:
2685
if config.get_user_option('bound') != 'True':
2688
config.set_user_option('bound', 'False', warn_masked=True)
2691
self._set_config_location('bound_location', location,
2693
config.set_user_option('bound', 'True', warn_masked=True)
2696
def _get_bound_location(self, bound):
2697
"""Return the bound location in the config file.
2699
Return None if the bound parameter does not match"""
2700
config = self.get_config()
2701
config_bound = (config.get_user_option('bound') == 'True')
2702
if config_bound != bound:
2704
return self._get_config_location('bound_location', config=config)
2706
def get_bound_location(self):
2707
"""See Branch.set_push_location."""
2708
return self._get_bound_location(True)
2710
def get_old_bound_location(self):
2711
"""See Branch.get_old_bound_location"""
2712
return self._get_bound_location(False)
2714
def get_stacked_on_url(self):
2715
# you can always ask for the URL; but you might not be able to use it
2716
# if the repo can't support stacking.
2717
## self._check_stackable_repo()
2718
stacked_url = self._get_config_location('stacked_on_location')
2719
if stacked_url is None:
2720
raise errors.NotStacked(self)
2723
def set_append_revisions_only(self, enabled):
2728
self.get_config().set_user_option('append_revisions_only', value,
2731
def _get_append_revisions_only(self):
2732
value = self.get_config().get_user_option('append_revisions_only')
2733
return value == 'True'
2736
def generate_revision_history(self, revision_id, last_rev=None,
2738
"""See BzrBranch5.generate_revision_history"""
2739
history = self._lefthand_history(revision_id, last_rev, other_branch)
2740
revno = len(history)
2741
self.set_last_revision_info(revno, revision_id)
2744
def get_rev_id(self, revno, history=None):
2745
"""Find the revision id of the specified revno."""
2747
return _mod_revision.NULL_REVISION
2749
last_revno, last_revision_id = self.last_revision_info()
2750
if revno <= 0 or revno > last_revno:
2751
raise errors.NoSuchRevision(self, revno)
2753
if history is not None:
2754
return history[revno - 1]
2756
index = last_revno - revno
2757
if len(self._partial_revision_history_cache) <= index:
2758
self._extend_partial_history(stop_index=index)
2759
if len(self._partial_revision_history_cache) > index:
2760
return self._partial_revision_history_cache[index]
2762
raise errors.NoSuchRevision(self, revno)
2765
def revision_id_to_revno(self, revision_id):
2766
"""Given a revision id, return its revno"""
2767
if _mod_revision.is_null(revision_id):
2770
index = self._partial_revision_history_cache.index(revision_id)
2772
self._extend_partial_history(stop_revision=revision_id)
2773
index = len(self._partial_revision_history_cache) - 1
2774
if self._partial_revision_history_cache[index] != revision_id:
2775
raise errors.NoSuchRevision(self, revision_id)
2776
return self.revno() - index
2779
class BzrBranch7(BzrBranch8):
2780
"""A branch with support for a fallback repository."""
2782
def set_reference_info(self, file_id, tree_path, branch_location):
2783
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2785
def get_reference_info(self, file_id):
2786
Branch.get_reference_info(self, file_id)
2788
def reference_parent(self, file_id, path, possible_transports=None):
2789
return Branch.reference_parent(self, file_id, path,
2790
possible_transports)
2793
class BzrBranch6(BzrBranch7):
2794
"""See BzrBranchFormat6 for the capabilities of this branch.
2796
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2800
def get_stacked_on_url(self):
2801
raise errors.UnstackableBranchFormat(self._format, self.base)
2804
######################################################################
2805
# results of operations
2808
class _Result(object):
2810
def _show_tag_conficts(self, to_file):
2811
if not getattr(self, 'tag_conflicts', None):
2813
to_file.write('Conflicting tags:\n')
2814
for name, value1, value2 in self.tag_conflicts:
2815
to_file.write(' %s\n' % (name, ))
2818
class PullResult(_Result):
2819
"""Result of a Branch.pull operation.
2821
:ivar old_revno: Revision number before pull.
2822
:ivar new_revno: Revision number after pull.
2823
:ivar old_revid: Tip revision id before pull.
2824
:ivar new_revid: Tip revision id after pull.
2825
:ivar source_branch: Source (local) branch object. (read locked)
2826
:ivar master_branch: Master branch of the target, or the target if no
2828
:ivar local_branch: target branch if there is a Master, else None
2829
:ivar target_branch: Target/destination branch object. (write locked)
2830
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2834
# DEPRECATED: pull used to return the change in revno
2835
return self.new_revno - self.old_revno
2837
def report(self, to_file):
2839
if self.old_revid == self.new_revid:
2840
to_file.write('No revisions to pull.\n')
2842
to_file.write('Now on revision %d.\n' % self.new_revno)
2843
self._show_tag_conficts(to_file)
2846
class BranchPushResult(_Result):
2847
"""Result of a Branch.push operation.
2849
:ivar old_revno: Revision number (eg 10) of the target before push.
2850
:ivar new_revno: Revision number (eg 12) of the target after push.
2851
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2853
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2855
:ivar source_branch: Source branch object that the push was from. This is
2856
read locked, and generally is a local (and thus low latency) branch.
2857
:ivar master_branch: If target is a bound branch, the master branch of
2858
target, or target itself. Always write locked.
2859
:ivar target_branch: The direct Branch where data is being sent (write
2861
:ivar local_branch: If the target is a bound branch this will be the
2862
target, otherwise it will be None.
2866
# DEPRECATED: push used to return the change in revno
2867
return self.new_revno - self.old_revno
2869
def report(self, to_file):
2870
"""Write a human-readable description of the result."""
2871
if self.old_revid == self.new_revid:
2872
note('No new revisions to push.')
2874
note('Pushed up to revision %d.' % self.new_revno)
2875
self._show_tag_conficts(to_file)
2878
class BranchCheckResult(object):
2879
"""Results of checking branch consistency.
2884
def __init__(self, branch):
2885
self.branch = branch
2887
def report_results(self, verbose):
2888
"""Report the check results via trace.note.
2890
:param verbose: Requests more detailed display of what was checked,
2893
note('checked branch %s format %s',
2895
self.branch._format)
2898
class Converter5to6(object):
2899
"""Perform an in-place upgrade of format 5 to format 6"""
2901
def convert(self, branch):
2902
# Data for 5 and 6 can peacefully coexist.
2903
format = BzrBranchFormat6()
2904
new_branch = format.open(branch.bzrdir, _found=True)
2906
# Copy source data into target
2907
new_branch._write_last_revision_info(*branch.last_revision_info())
2908
new_branch.set_parent(branch.get_parent())
2909
new_branch.set_bound_location(branch.get_bound_location())
2910
new_branch.set_push_location(branch.get_push_location())
2912
# New branch has no tags by default
2913
new_branch.tags._set_tag_dict({})
2915
# Copying done; now update target format
2916
new_branch._transport.put_bytes('format',
2917
format.get_format_string(),
2918
mode=new_branch.bzrdir._get_file_mode())
2920
# Clean up old files
2921
new_branch._transport.delete('revision-history')
2923
branch.set_parent(None)
2924
except errors.NoSuchFile:
2926
branch.set_bound_location(None)
2929
class Converter6to7(object):
2930
"""Perform an in-place upgrade of format 6 to format 7"""
2932
def convert(self, branch):
2933
format = BzrBranchFormat7()
2934
branch._set_config_location('stacked_on_location', '')
2935
# update target format
2936
branch._transport.put_bytes('format', format.get_format_string())
2939
class Converter7to8(object):
2940
"""Perform an in-place upgrade of format 6 to format 7"""
2942
def convert(self, branch):
2943
format = BzrBranchFormat8()
2944
branch._transport.put_bytes('references', '')
2945
# update target format
2946
branch._transport.put_bytes('format', format.get_format_string())
2949
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2950
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2953
_run_with_write_locked_target will attempt to release the lock it acquires.
2955
If an exception is raised by callable, then that exception *will* be
2956
propagated, even if the unlock attempt raises its own error. Thus
2957
_run_with_write_locked_target should be preferred to simply doing::
2961
return callable(*args, **kwargs)
2966
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2967
# should share code?
2970
result = callable(*args, **kwargs)
2972
exc_info = sys.exc_info()
2976
raise exc_info[0], exc_info[1], exc_info[2]
2982
class InterBranch(InterObject):
2983
"""This class represents operations taking place between two branches.
2985
Its instances have methods like pull() and push() and contain
2986
references to the source and target repositories these operations
2987
can be carried out on.
2991
"""The available optimised InterBranch types."""
2994
def _get_branch_formats_to_test():
2995
"""Return a tuple with the Branch formats to use when testing."""
2996
raise NotImplementedError(self._get_branch_formats_to_test)
2998
def update_revisions(self, stop_revision=None, overwrite=False,
3000
"""Pull in new perfect-fit revisions.
3002
:param stop_revision: Updated until the given revision
3003
:param overwrite: Always set the branch pointer, rather than checking
3004
to see if it is a proper descendant.
3005
:param graph: A Graph object that can be used to query history
3006
information. This can be None.
3009
raise NotImplementedError(self.update_revisions)
3012
class GenericInterBranch(InterBranch):
3013
"""InterBranch implementation that uses public Branch functions.
3017
def _get_branch_formats_to_test():
3018
return BranchFormat._default_format, BranchFormat._default_format
3020
def update_revisions(self, stop_revision=None, overwrite=False,
3022
"""See InterBranch.update_revisions()."""
3023
self.source.lock_read()
3025
other_revno, other_last_revision = self.source.last_revision_info()
3026
stop_revno = None # unknown
3027
if stop_revision is None:
3028
stop_revision = other_last_revision
3029
if _mod_revision.is_null(stop_revision):
3030
# if there are no commits, we're done.
3032
stop_revno = other_revno
3034
# what's the current last revision, before we fetch [and change it
3036
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3037
# we fetch here so that we don't process data twice in the common
3038
# case of having something to pull, and so that the check for
3039
# already merged can operate on the just fetched graph, which will
3040
# be cached in memory.
3041
self.target.fetch(self.source, stop_revision)
3042
# Check to see if one is an ancestor of the other
3045
graph = self.target.repository.get_graph()
3046
if self.target._check_if_descendant_or_diverged(
3047
stop_revision, last_rev, graph, self.source):
3048
# stop_revision is a descendant of last_rev, but we aren't
3049
# overwriting, so we're done.
3051
if stop_revno is None:
3053
graph = self.target.repository.get_graph()
3054
this_revno, this_last_revision = \
3055
self.target.last_revision_info()
3056
stop_revno = graph.find_distance_to_null(stop_revision,
3057
[(other_last_revision, other_revno),
3058
(this_last_revision, this_revno)])
3059
self.target.set_last_revision_info(stop_revno, stop_revision)
3061
self.source.unlock()
3064
def is_compatible(self, source, target):
3065
# GenericBranch uses the public API, so always compatible
3069
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
