1
# Copyright (C) 2005, 2006, 2007, 2008 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from itertools import chain
26
config as _mod_config,
32
revision as _mod_revision,
38
from bzrlib.config import BranchConfig
39
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
40
from bzrlib.tag import (
46
from bzrlib.decorators import needs_read_lock, needs_write_lock
47
from bzrlib.hooks import Hooks
48
from bzrlib.symbol_versioning import (
52
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
55
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
56
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
57
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
60
# TODO: Maybe include checks for common corruption of newlines, etc?
62
# TODO: Some operations like log might retrieve the same revisions
63
# repeatedly to calculate deltas. We could perhaps have a weakref
64
# cache in memory to make this faster. In general anything can be
65
# cached in memory between lock and unlock operations. .. nb thats
66
# what the transaction identity map provides
69
######################################################################
73
"""Branch holding a history of revisions.
76
Base directory/url of the branch.
78
hooks: An instance of BranchHooks.
80
# this is really an instance variable - FIXME move it there
84
# override this to set the strategy for storing tags
86
return DisabledTags(self)
88
def __init__(self, *ignored, **ignored_too):
89
self.tags = self._make_tags()
90
self._revision_history_cache = None
91
self._revision_id_to_revno_cache = None
92
self._partial_revision_id_to_revno_cache = {}
93
self._last_revision_info_cache = None
94
self._merge_sorted_revisions_cache = None
96
hooks = Branch.hooks['open']
100
def _open_hook(self):
101
"""Called by init to allow simpler extension of the base class."""
103
def break_lock(self):
104
"""Break a lock if one is present from another instance.
106
Uses the ui factory to ask for confirmation if the lock may be from
109
This will probe the repository for its lock as well.
111
self.control_files.break_lock()
112
self.repository.break_lock()
113
master = self.get_master_branch()
114
if master is not None:
118
def open(base, _unsupported=False, possible_transports=None):
119
"""Open the branch rooted at base.
121
For instance, if the branch is at URL/.bzr/branch,
122
Branch.open(URL) -> a Branch instance.
124
control = bzrdir.BzrDir.open(base, _unsupported,
125
possible_transports=possible_transports)
126
return control.open_branch(_unsupported)
129
def open_from_transport(transport, _unsupported=False):
130
"""Open the branch rooted at transport"""
131
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
132
return control.open_branch(_unsupported)
135
def open_containing(url, possible_transports=None):
136
"""Open an existing branch which contains url.
138
This probes for a branch at url, and searches upwards from there.
140
Basically we keep looking up until we find the control directory or
141
run into the root. If there isn't one, raises NotBranchError.
142
If there is one and it is either an unrecognised format or an unsupported
143
format, UnknownFormatError or UnsupportedFormatError are raised.
144
If there is one, it is returned, along with the unused portion of url.
146
control, relpath = bzrdir.BzrDir.open_containing(url,
148
return control.open_branch(), relpath
150
def get_config(self):
151
return BranchConfig(self)
153
def _get_nick(self, local=False, possible_transports=None):
154
config = self.get_config()
155
# explicit overrides master, but don't look for master if local is True
156
if not local and not config.has_explicit_nickname():
158
master = self.get_master_branch(possible_transports)
159
if master is not None:
160
# return the master branch value
162
except errors.BzrError, e:
163
# Silently fall back to local implicit nick if the master is
165
mutter("Could not connect to bound branch, "
166
"falling back to local nick.\n " + str(e))
167
return config.get_nickname()
169
def _set_nick(self, nick):
170
self.get_config().set_user_option('nickname', nick, warn_masked=True)
172
nick = property(_get_nick, _set_nick)
175
raise NotImplementedError(self.is_locked)
177
def lock_write(self):
178
raise NotImplementedError(self.lock_write)
181
raise NotImplementedError(self.lock_read)
184
raise NotImplementedError(self.unlock)
186
def peek_lock_mode(self):
187
"""Return lock mode for the Branch: 'r', 'w' or None"""
188
raise NotImplementedError(self.peek_lock_mode)
190
def get_physical_lock_status(self):
191
raise NotImplementedError(self.get_physical_lock_status)
194
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
195
"""Return the revision_id for a dotted revno.
197
:param revno: a tuple like (1,) or (1,1,2)
198
:param _cache_reverse: a private parameter enabling storage
199
of the reverse mapping in a top level cache. (This should
200
only be done in selective circumstances as we want to
201
avoid having the mapping cached multiple times.)
202
:return: the revision_id
203
:raises errors.NoSuchRevision: if the revno doesn't exist
205
rev_id = self._do_dotted_revno_to_revision_id(revno)
207
self._partial_revision_id_to_revno_cache[rev_id] = revno
210
def _do_dotted_revno_to_revision_id(self, revno):
211
"""Worker function for dotted_revno_to_revision_id.
213
Subclasses should override this if they wish to
214
provide a more efficient implementation.
217
return self.get_rev_id(revno[0])
218
revision_id_to_revno = self.get_revision_id_to_revno_map()
219
revision_ids = [revision_id for revision_id, this_revno
220
in revision_id_to_revno.iteritems()
221
if revno == this_revno]
222
if len(revision_ids) == 1:
223
return revision_ids[0]
225
revno_str = '.'.join(map(str, revno))
226
raise errors.NoSuchRevision(self, revno_str)
229
def revision_id_to_dotted_revno(self, revision_id):
230
"""Given a revision id, return its dotted revno.
232
:return: a tuple like (1,) or (400,1,3).
234
return self._do_revision_id_to_dotted_revno(revision_id)
236
def _do_revision_id_to_dotted_revno(self, revision_id):
237
"""Worker function for revision_id_to_revno."""
238
# Try the caches if they are loaded
239
result = self._partial_revision_id_to_revno_cache.get(revision_id)
240
if result is not None:
242
if self._revision_id_to_revno_cache:
243
result = self._revision_id_to_revno_cache.get(revision_id)
245
raise errors.NoSuchRevision(self, revision_id)
246
# Try the mainline as it's optimised
248
revno = self.revision_id_to_revno(revision_id)
250
except errors.NoSuchRevision:
251
# We need to load and use the full revno map after all
252
result = self.get_revision_id_to_revno_map().get(revision_id)
254
raise errors.NoSuchRevision(self, revision_id)
258
def get_revision_id_to_revno_map(self):
259
"""Return the revision_id => dotted revno map.
261
This will be regenerated on demand, but will be cached.
263
:return: A dictionary mapping revision_id => dotted revno.
264
This dictionary should not be modified by the caller.
266
if self._revision_id_to_revno_cache is not None:
267
mapping = self._revision_id_to_revno_cache
269
mapping = self._gen_revno_map()
270
self._cache_revision_id_to_revno(mapping)
271
# TODO: jam 20070417 Since this is being cached, should we be returning
273
# I would rather not, and instead just declare that users should not
274
# modify the return value.
277
def _gen_revno_map(self):
278
"""Create a new mapping from revision ids to dotted revnos.
280
Dotted revnos are generated based on the current tip in the revision
282
This is the worker function for get_revision_id_to_revno_map, which
283
just caches the return value.
285
:return: A dictionary mapping revision_id => dotted revno.
287
revision_id_to_revno = dict((rev_id, revno)
288
for rev_id, depth, revno, end_of_merge
289
in self.iter_merge_sorted_revisions())
290
return revision_id_to_revno
293
def iter_merge_sorted_revisions(self, start_revision_id=None,
294
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
295
"""Walk the revisions for a branch in merge sorted order.
297
Merge sorted order is the output from a merge-aware,
298
topological sort, i.e. all parents come before their
299
children going forward; the opposite for reverse.
301
:param start_revision_id: the revision_id to begin walking from.
302
If None, the branch tip is used.
303
:param stop_revision_id: the revision_id to terminate the walk
304
after. If None, the rest of history is included.
305
:param stop_rule: if stop_revision_id is not None, the precise rule
306
to use for termination:
307
* 'exclude' - leave the stop revision out of the result (default)
308
* 'include' - the stop revision is the last item in the result
309
* 'with-merges' - include the stop revision and all of its
310
merged revisions in the result
311
:param direction: either 'reverse' or 'forward':
312
* reverse means return the start_revision_id first, i.e.
313
start at the most recent revision and go backwards in history
314
* forward returns tuples in the opposite order to reverse.
315
Note in particular that forward does *not* do any intelligent
316
ordering w.r.t. depth as some clients of this API may like.
317
(If required, that ought to be done at higher layers.)
319
:return: an iterator over (revision_id, depth, revno, end_of_merge)
322
* revision_id: the unique id of the revision
323
* depth: How many levels of merging deep this node has been
325
* revno_sequence: This field provides a sequence of
326
revision numbers for all revisions. The format is:
327
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
328
branch that the revno is on. From left to right the REVNO numbers
329
are the sequence numbers within that branch of the revision.
330
* end_of_merge: When True the next node (earlier in history) is
331
part of a different merge.
333
# Note: depth and revno values are in the context of the branch so
334
# we need the full graph to get stable numbers, regardless of the
336
if self._merge_sorted_revisions_cache is None:
337
last_revision = self.last_revision()
338
graph = self.repository.get_graph()
339
parent_map = dict(((key, value) for key, value in
340
graph.iter_ancestry([last_revision]) if value is not None))
341
revision_graph = repository._strip_NULL_ghosts(parent_map)
342
revs = tsort.merge_sort(revision_graph, last_revision, None,
344
# Drop the sequence # before caching
345
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
347
filtered = self._filter_merge_sorted_revisions(
348
self._merge_sorted_revisions_cache, start_revision_id,
349
stop_revision_id, stop_rule)
350
if direction == 'reverse':
352
if direction == 'forward':
353
return reversed(list(filtered))
355
raise ValueError('invalid direction %r' % direction)
357
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
358
start_revision_id, stop_revision_id, stop_rule):
359
"""Iterate over an inclusive range of sorted revisions."""
360
rev_iter = iter(merge_sorted_revisions)
361
if start_revision_id is not None:
362
for rev_id, depth, revno, end_of_merge in rev_iter:
363
if rev_id != start_revision_id:
366
# The decision to include the start or not
367
# depends on the stop_rule if a stop is provided
369
iter([(rev_id, depth, revno, end_of_merge)]),
372
if stop_revision_id is None:
373
for rev_id, depth, revno, end_of_merge in rev_iter:
374
yield rev_id, depth, revno, end_of_merge
375
elif stop_rule == 'exclude':
376
for rev_id, depth, revno, end_of_merge in rev_iter:
377
if rev_id == stop_revision_id:
379
yield rev_id, depth, revno, end_of_merge
380
elif stop_rule == 'include':
381
for rev_id, depth, revno, end_of_merge in rev_iter:
382
yield rev_id, depth, revno, end_of_merge
383
if rev_id == stop_revision_id:
385
elif stop_rule == 'with-merges':
387
for rev_id, depth, revno, end_of_merge in rev_iter:
388
if stop_depth is not None and depth <= stop_depth:
390
yield rev_id, depth, revno, end_of_merge
391
if rev_id == stop_revision_id:
394
raise ValueError('invalid stop_rule %r' % stop_rule)
396
def leave_lock_in_place(self):
397
"""Tell this branch object not to release the physical lock when this
400
If lock_write doesn't return a token, then this method is not supported.
402
self.control_files.leave_in_place()
404
def dont_leave_lock_in_place(self):
405
"""Tell this branch object to release the physical lock when this
406
object is unlocked, even if it didn't originally acquire it.
408
If lock_write doesn't return a token, then this method is not supported.
410
self.control_files.dont_leave_in_place()
412
def bind(self, other):
413
"""Bind the local branch the other branch.
415
:param other: The branch to bind to
418
raise errors.UpgradeRequired(self.base)
421
def fetch(self, from_branch, last_revision=None, pb=None):
422
"""Copy revisions from from_branch into this branch.
424
:param from_branch: Where to copy from.
425
:param last_revision: What revision to stop at (None for at the end
427
:param pb: An optional progress bar to use.
429
Returns the copied revision count and the failed revisions in a tuple:
432
if self.base == from_branch.base:
435
nested_pb = ui.ui_factory.nested_progress_bar()
440
from_branch.lock_read()
442
if last_revision is None:
443
pb.update('get source history')
444
last_revision = from_branch.last_revision()
445
last_revision = _mod_revision.ensure_null(last_revision)
446
return self.repository.fetch(from_branch.repository,
447
revision_id=last_revision,
450
if nested_pb is not None:
454
def get_bound_location(self):
455
"""Return the URL of the branch we are bound to.
457
Older format branches cannot bind, please be sure to use a metadir
462
def get_old_bound_location(self):
463
"""Return the URL of the branch we used to be bound to
465
raise errors.UpgradeRequired(self.base)
467
def get_commit_builder(self, parents, config=None, timestamp=None,
468
timezone=None, committer=None, revprops=None,
470
"""Obtain a CommitBuilder for this branch.
472
:param parents: Revision ids of the parents of the new revision.
473
:param config: Optional configuration to use.
474
:param timestamp: Optional timestamp recorded for commit.
475
:param timezone: Optional timezone for timestamp.
476
:param committer: Optional committer to set for commit.
477
:param revprops: Optional dictionary of revision properties.
478
:param revision_id: Optional revision id.
482
config = self.get_config()
484
return self.repository.get_commit_builder(self, parents, config,
485
timestamp, timezone, committer, revprops, revision_id)
487
def get_master_branch(self, possible_transports=None):
488
"""Return the branch we are bound to.
490
:return: Either a Branch, or None
494
def get_revision_delta(self, revno):
495
"""Return the delta for one revision.
497
The delta is relative to its mainline predecessor, or the
498
empty tree for revision 1.
500
rh = self.revision_history()
501
if not (1 <= revno <= len(rh)):
502
raise errors.InvalidRevisionNumber(revno)
503
return self.repository.get_revision_delta(rh[revno-1])
505
def get_stacked_on_url(self):
506
"""Get the URL this branch is stacked against.
508
:raises NotStacked: If the branch is not stacked.
509
:raises UnstackableBranchFormat: If the branch does not support
512
raise NotImplementedError(self.get_stacked_on_url)
514
def print_file(self, file, revision_id):
515
"""Print `file` to stdout."""
516
raise NotImplementedError(self.print_file)
518
def set_revision_history(self, rev_history):
519
raise NotImplementedError(self.set_revision_history)
521
def set_stacked_on_url(self, url):
522
"""Set the URL this branch is stacked against.
524
:raises UnstackableBranchFormat: If the branch does not support
526
:raises UnstackableRepositoryFormat: If the repository does not support
529
raise NotImplementedError(self.set_stacked_on_url)
531
def _cache_revision_history(self, rev_history):
532
"""Set the cached revision history to rev_history.
534
The revision_history method will use this cache to avoid regenerating
535
the revision history.
537
This API is semi-public; it only for use by subclasses, all other code
538
should consider it to be private.
540
self._revision_history_cache = rev_history
542
def _cache_revision_id_to_revno(self, revision_id_to_revno):
543
"""Set the cached revision_id => revno map to revision_id_to_revno.
545
This API is semi-public; it only for use by subclasses, all other code
546
should consider it to be private.
548
self._revision_id_to_revno_cache = revision_id_to_revno
550
def _clear_cached_state(self):
551
"""Clear any cached data on this branch, e.g. cached revision history.
553
This means the next call to revision_history will need to call
554
_gen_revision_history.
556
This API is semi-public; it only for use by subclasses, all other code
557
should consider it to be private.
559
self._revision_history_cache = None
560
self._revision_id_to_revno_cache = None
561
self._last_revision_info_cache = None
562
self._merge_sorted_revisions_cache = None
564
def _gen_revision_history(self):
565
"""Return sequence of revision hashes on to this branch.
567
Unlike revision_history, this method always regenerates or rereads the
568
revision history, i.e. it does not cache the result, so repeated calls
571
Concrete subclasses should override this instead of revision_history so
572
that subclasses do not need to deal with caching logic.
574
This API is semi-public; it only for use by subclasses, all other code
575
should consider it to be private.
577
raise NotImplementedError(self._gen_revision_history)
580
def revision_history(self):
581
"""Return sequence of revision ids on this branch.
583
This method will cache the revision history for as long as it is safe to
586
if 'evil' in debug.debug_flags:
587
mutter_callsite(3, "revision_history scales with history.")
588
if self._revision_history_cache is not None:
589
history = self._revision_history_cache
591
history = self._gen_revision_history()
592
self._cache_revision_history(history)
596
"""Return current revision number for this branch.
598
That is equivalent to the number of revisions committed to
601
return self.last_revision_info()[0]
604
"""Older format branches cannot bind or unbind."""
605
raise errors.UpgradeRequired(self.base)
607
def set_append_revisions_only(self, enabled):
608
"""Older format branches are never restricted to append-only"""
609
raise errors.UpgradeRequired(self.base)
611
def last_revision(self):
612
"""Return last revision id, or NULL_REVISION."""
613
return self.last_revision_info()[1]
616
def last_revision_info(self):
617
"""Return information about the last revision.
619
:return: A tuple (revno, revision_id).
621
if self._last_revision_info_cache is None:
622
self._last_revision_info_cache = self._last_revision_info()
623
return self._last_revision_info_cache
625
def _last_revision_info(self):
626
rh = self.revision_history()
629
return (revno, rh[-1])
631
return (0, _mod_revision.NULL_REVISION)
633
@deprecated_method(deprecated_in((1, 6, 0)))
634
def missing_revisions(self, other, stop_revision=None):
635
"""Return a list of new revisions that would perfectly fit.
637
If self and other have not diverged, return a list of the revisions
638
present in other, but missing from self.
640
self_history = self.revision_history()
641
self_len = len(self_history)
642
other_history = other.revision_history()
643
other_len = len(other_history)
644
common_index = min(self_len, other_len) -1
645
if common_index >= 0 and \
646
self_history[common_index] != other_history[common_index]:
647
raise errors.DivergedBranches(self, other)
649
if stop_revision is None:
650
stop_revision = other_len
652
if stop_revision > other_len:
653
raise errors.NoSuchRevision(self, stop_revision)
654
return other_history[self_len:stop_revision]
657
def update_revisions(self, other, stop_revision=None, overwrite=False,
659
"""Pull in new perfect-fit revisions.
661
:param other: Another Branch to pull from
662
:param stop_revision: Updated until the given revision
663
:param overwrite: Always set the branch pointer, rather than checking
664
to see if it is a proper descendant.
665
:param graph: A Graph object that can be used to query history
666
information. This can be None.
671
other_revno, other_last_revision = other.last_revision_info()
672
stop_revno = None # unknown
673
if stop_revision is None:
674
stop_revision = other_last_revision
675
if _mod_revision.is_null(stop_revision):
676
# if there are no commits, we're done.
678
stop_revno = other_revno
680
# what's the current last revision, before we fetch [and change it
682
last_rev = _mod_revision.ensure_null(self.last_revision())
683
# we fetch here so that we don't process data twice in the common
684
# case of having something to pull, and so that the check for
685
# already merged can operate on the just fetched graph, which will
686
# be cached in memory.
687
self.fetch(other, stop_revision)
688
# Check to see if one is an ancestor of the other
691
graph = self.repository.get_graph()
692
if self._check_if_descendant_or_diverged(
693
stop_revision, last_rev, graph, other):
694
# stop_revision is a descendant of last_rev, but we aren't
695
# overwriting, so we're done.
697
if stop_revno is None:
699
graph = self.repository.get_graph()
700
this_revno, this_last_revision = self.last_revision_info()
701
stop_revno = graph.find_distance_to_null(stop_revision,
702
[(other_last_revision, other_revno),
703
(this_last_revision, this_revno)])
704
self.set_last_revision_info(stop_revno, stop_revision)
708
def revision_id_to_revno(self, revision_id):
709
"""Given a revision id, return its revno"""
710
if _mod_revision.is_null(revision_id):
712
history = self.revision_history()
714
return history.index(revision_id) + 1
716
raise errors.NoSuchRevision(self, revision_id)
718
def get_rev_id(self, revno, history=None):
719
"""Find the revision id of the specified revno."""
721
return _mod_revision.NULL_REVISION
723
history = self.revision_history()
724
if revno <= 0 or revno > len(history):
725
raise errors.NoSuchRevision(self, revno)
726
return history[revno - 1]
728
def pull(self, source, overwrite=False, stop_revision=None,
729
possible_transports=None, _override_hook_target=None):
730
"""Mirror source into this branch.
732
This branch is considered to be 'local', having low latency.
734
:returns: PullResult instance
736
raise NotImplementedError(self.pull)
738
def push(self, target, overwrite=False, stop_revision=None):
739
"""Mirror this branch into target.
741
This branch is considered to be 'local', having low latency.
743
raise NotImplementedError(self.push)
745
def basis_tree(self):
746
"""Return `Tree` object for last revision."""
747
return self.repository.revision_tree(self.last_revision())
749
def get_parent(self):
750
"""Return the parent location of the branch.
752
This is the default location for push/pull/missing. The usual
753
pattern is that the user can override it by specifying a
756
raise NotImplementedError(self.get_parent)
758
def _set_config_location(self, name, url, config=None,
759
make_relative=False):
761
config = self.get_config()
765
url = urlutils.relative_url(self.base, url)
766
config.set_user_option(name, url, warn_masked=True)
768
def _get_config_location(self, name, config=None):
770
config = self.get_config()
771
location = config.get_user_option(name)
776
def get_submit_branch(self):
777
"""Return the submit location of the branch.
779
This is the default location for bundle. The usual
780
pattern is that the user can override it by specifying a
783
return self.get_config().get_user_option('submit_branch')
785
def set_submit_branch(self, location):
786
"""Return the submit location of the branch.
788
This is the default location for bundle. The usual
789
pattern is that the user can override it by specifying a
792
self.get_config().set_user_option('submit_branch', location,
795
def get_public_branch(self):
796
"""Return the public location of the branch.
798
This is is used by merge directives.
800
return self._get_config_location('public_branch')
802
def set_public_branch(self, location):
803
"""Return the submit location of the branch.
805
This is the default location for bundle. The usual
806
pattern is that the user can override it by specifying a
809
self._set_config_location('public_branch', location)
811
def get_push_location(self):
812
"""Return the None or the location to push this branch to."""
813
push_loc = self.get_config().get_user_option('push_location')
816
def set_push_location(self, location):
817
"""Set a new push location for this branch."""
818
raise NotImplementedError(self.set_push_location)
820
def set_parent(self, url):
821
raise NotImplementedError(self.set_parent)
825
"""Synchronise this branch with the master branch if any.
827
:return: None or the last_revision pivoted out during the update.
831
def check_revno(self, revno):
833
Check whether a revno corresponds to any revision.
834
Zero (the NULL revision) is considered valid.
837
self.check_real_revno(revno)
839
def check_real_revno(self, revno):
841
Check whether a revno corresponds to a real revision.
842
Zero (the NULL revision) is considered invalid
844
if revno < 1 or revno > self.revno():
845
raise errors.InvalidRevisionNumber(revno)
848
def clone(self, to_bzrdir, revision_id=None):
849
"""Clone this branch into to_bzrdir preserving all semantic values.
851
revision_id: if not None, the revision history in the new branch will
852
be truncated to end with revision_id.
854
result = to_bzrdir.create_branch()
855
self.copy_content_into(result, revision_id=revision_id)
859
def sprout(self, to_bzrdir, revision_id=None):
860
"""Create a new line of development from the branch, into to_bzrdir.
862
to_bzrdir controls the branch format.
864
revision_id: if not None, the revision history in the new branch will
865
be truncated to end with revision_id.
867
result = to_bzrdir.create_branch()
868
self.copy_content_into(result, revision_id=revision_id)
869
result.set_parent(self.bzrdir.root_transport.base)
872
def _synchronize_history(self, destination, revision_id):
873
"""Synchronize last revision and revision history between branches.
875
This version is most efficient when the destination is also a
876
BzrBranch6, but works for BzrBranch5, as long as the destination's
877
repository contains all the lefthand ancestors of the intended
878
last_revision. If not, set_last_revision_info will fail.
880
:param destination: The branch to copy the history into
881
:param revision_id: The revision-id to truncate history at. May
882
be None to copy complete history.
884
source_revno, source_revision_id = self.last_revision_info()
885
if revision_id is None:
886
revno, revision_id = source_revno, source_revision_id
887
elif source_revision_id == revision_id:
888
# we know the revno without needing to walk all of history
891
# To figure out the revno for a random revision, we need to build
892
# the revision history, and count its length.
893
# We don't care about the order, just how long it is.
894
# Alternatively, we could start at the current location, and count
895
# backwards. But there is no guarantee that we will find it since
896
# it may be a merged revision.
897
revno = len(list(self.repository.iter_reverse_revision_history(
899
destination.set_last_revision_info(revno, revision_id)
902
def copy_content_into(self, destination, revision_id=None):
903
"""Copy the content of self into destination.
905
revision_id: if not None, the revision history in the new branch will
906
be truncated to end with revision_id.
908
self._synchronize_history(destination, revision_id)
910
parent = self.get_parent()
911
except errors.InaccessibleParent, e:
912
mutter('parent was not accessible to copy: %s', e)
915
destination.set_parent(parent)
916
self.tags.merge_to(destination.tags)
920
"""Check consistency of the branch.
922
In particular this checks that revisions given in the revision-history
923
do actually match up in the revision graph, and that they're all
924
present in the repository.
926
Callers will typically also want to check the repository.
928
:return: A BranchCheckResult.
930
mainline_parent_id = None
931
last_revno, last_revision_id = self.last_revision_info()
932
real_rev_history = list(self.repository.iter_reverse_revision_history(
934
real_rev_history.reverse()
935
if len(real_rev_history) != last_revno:
936
raise errors.BzrCheckError('revno does not match len(mainline)'
937
' %s != %s' % (last_revno, len(real_rev_history)))
938
# TODO: We should probably also check that real_rev_history actually
939
# matches self.revision_history()
940
for revision_id in real_rev_history:
942
revision = self.repository.get_revision(revision_id)
943
except errors.NoSuchRevision, e:
944
raise errors.BzrCheckError("mainline revision {%s} not in repository"
946
# In general the first entry on the revision history has no parents.
947
# But it's not illegal for it to have parents listed; this can happen
948
# in imports from Arch when the parents weren't reachable.
949
if mainline_parent_id is not None:
950
if mainline_parent_id not in revision.parent_ids:
951
raise errors.BzrCheckError("previous revision {%s} not listed among "
953
% (mainline_parent_id, revision_id))
954
mainline_parent_id = revision_id
955
return BranchCheckResult(self)
957
def _get_checkout_format(self):
958
"""Return the most suitable metadir for a checkout of this branch.
959
Weaves are used if this branch's repository uses weaves.
961
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
962
from bzrlib.repofmt import weaverepo
963
format = bzrdir.BzrDirMetaFormat1()
964
format.repository_format = weaverepo.RepositoryFormat7()
966
format = self.repository.bzrdir.checkout_metadir()
967
format.set_branch_format(self._format)
970
def create_checkout(self, to_location, revision_id=None,
971
lightweight=False, accelerator_tree=None,
973
"""Create a checkout of a branch.
975
:param to_location: The url to produce the checkout at
976
:param revision_id: The revision to check out
977
:param lightweight: If True, produce a lightweight checkout, otherwise,
978
produce a bound branch (heavyweight checkout)
979
:param accelerator_tree: A tree which can be used for retrieving file
980
contents more quickly than the revision tree, i.e. a workingtree.
981
The revision tree will be used for cases where accelerator_tree's
982
content is different.
983
:param hardlink: If true, hard-link files from accelerator_tree,
985
:return: The tree of the created checkout
987
t = transport.get_transport(to_location)
990
format = self._get_checkout_format()
991
checkout = format.initialize_on_transport(t)
992
from_branch = BranchReferenceFormat().initialize(checkout, self)
994
format = self._get_checkout_format()
995
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
996
to_location, force_new_tree=False, format=format)
997
checkout = checkout_branch.bzrdir
998
checkout_branch.bind(self)
999
# pull up to the specified revision_id to set the initial
1000
# branch tip correctly, and seed it with history.
1001
checkout_branch.pull(self, stop_revision=revision_id)
1003
tree = checkout.create_workingtree(revision_id,
1004
from_branch=from_branch,
1005
accelerator_tree=accelerator_tree,
1007
basis_tree = tree.basis_tree()
1008
basis_tree.lock_read()
1010
for path, file_id in basis_tree.iter_references():
1011
reference_parent = self.reference_parent(file_id, path)
1012
reference_parent.create_checkout(tree.abspath(path),
1013
basis_tree.get_reference_revision(file_id, path),
1020
def reconcile(self, thorough=True):
1021
"""Make sure the data stored in this branch is consistent."""
1022
from bzrlib.reconcile import BranchReconciler
1023
reconciler = BranchReconciler(self, thorough=thorough)
1024
reconciler.reconcile()
1027
def reference_parent(self, file_id, path):
1028
"""Return the parent branch for a tree-reference file_id
1029
:param file_id: The file_id of the tree reference
1030
:param path: The path of the file_id in the tree
1031
:return: A branch associated with the file_id
1033
# FIXME should provide multiple branches, based on config
1034
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1036
def supports_tags(self):
1037
return self._format.supports_tags()
1039
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1041
"""Ensure that revision_b is a descendant of revision_a.
1043
This is a helper function for update_revisions.
1045
:raises: DivergedBranches if revision_b has diverged from revision_a.
1046
:returns: True if revision_b is a descendant of revision_a.
1048
relation = self._revision_relations(revision_a, revision_b, graph)
1049
if relation == 'b_descends_from_a':
1051
elif relation == 'diverged':
1052
raise errors.DivergedBranches(self, other_branch)
1053
elif relation == 'a_descends_from_b':
1056
raise AssertionError("invalid relation: %r" % (relation,))
1058
def _revision_relations(self, revision_a, revision_b, graph):
1059
"""Determine the relationship between two revisions.
1061
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1063
heads = graph.heads([revision_a, revision_b])
1064
if heads == set([revision_b]):
1065
return 'b_descends_from_a'
1066
elif heads == set([revision_a, revision_b]):
1067
# These branches have diverged
1069
elif heads == set([revision_a]):
1070
return 'a_descends_from_b'
1072
raise AssertionError("invalid heads: %r" % (heads,))
1075
class BranchFormat(object):
1076
"""An encapsulation of the initialization and open routines for a format.
1078
Formats provide three things:
1079
* An initialization routine,
1083
Formats are placed in an dict by their format string for reference
1084
during branch opening. Its not required that these be instances, they
1085
can be classes themselves with class methods - it simply depends on
1086
whether state is needed for a given format or not.
1088
Once a format is deprecated, just deprecate the initialize and open
1089
methods on the format class. Do not deprecate the object, as the
1090
object will be created every time regardless.
1093
_default_format = None
1094
"""The default format used for new branches."""
1097
"""The known formats."""
1099
def __eq__(self, other):
1100
return self.__class__ is other.__class__
1102
def __ne__(self, other):
1103
return not (self == other)
1106
def find_format(klass, a_bzrdir):
1107
"""Return the format for the branch object in a_bzrdir."""
1109
transport = a_bzrdir.get_branch_transport(None)
1110
format_string = transport.get("format").read()
1111
return klass._formats[format_string]
1112
except errors.NoSuchFile:
1113
raise errors.NotBranchError(path=transport.base)
1115
raise errors.UnknownFormatError(format=format_string, kind='branch')
1118
def get_default_format(klass):
1119
"""Return the current default format."""
1120
return klass._default_format
1122
def get_reference(self, a_bzrdir):
1123
"""Get the target reference of the branch in a_bzrdir.
1125
format probing must have been completed before calling
1126
this method - it is assumed that the format of the branch
1127
in a_bzrdir is correct.
1129
:param a_bzrdir: The bzrdir to get the branch data from.
1130
:return: None if the branch is not a reference branch.
1135
def set_reference(self, a_bzrdir, to_branch):
1136
"""Set the target reference of the branch in a_bzrdir.
1138
format probing must have been completed before calling
1139
this method - it is assumed that the format of the branch
1140
in a_bzrdir is correct.
1142
:param a_bzrdir: The bzrdir to set the branch reference for.
1143
:param to_branch: branch that the checkout is to reference
1145
raise NotImplementedError(self.set_reference)
1147
def get_format_string(self):
1148
"""Return the ASCII format string that identifies this format."""
1149
raise NotImplementedError(self.get_format_string)
1151
def get_format_description(self):
1152
"""Return the short format description for this format."""
1153
raise NotImplementedError(self.get_format_description)
1155
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1157
"""Initialize a branch in a bzrdir, with specified files
1159
:param a_bzrdir: The bzrdir to initialize the branch in
1160
:param utf8_files: The files to create as a list of
1161
(filename, content) tuples
1162
:param set_format: If True, set the format with
1163
self.get_format_string. (BzrBranch4 has its format set
1165
:return: a branch in this format
1167
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1168
branch_transport = a_bzrdir.get_branch_transport(self)
1170
'metadir': ('lock', lockdir.LockDir),
1171
'branch4': ('branch-lock', lockable_files.TransportLock),
1173
lock_name, lock_class = lock_map[lock_type]
1174
control_files = lockable_files.LockableFiles(branch_transport,
1175
lock_name, lock_class)
1176
control_files.create_lock()
1177
control_files.lock_write()
1179
utf8_files += [('format', self.get_format_string())]
1181
for (filename, content) in utf8_files:
1182
branch_transport.put_bytes(
1184
mode=a_bzrdir._get_file_mode())
1186
control_files.unlock()
1187
return self.open(a_bzrdir, _found=True)
1189
def initialize(self, a_bzrdir):
1190
"""Create a branch of this format in a_bzrdir."""
1191
raise NotImplementedError(self.initialize)
1193
def is_supported(self):
1194
"""Is this format supported?
1196
Supported formats can be initialized and opened.
1197
Unsupported formats may not support initialization or committing or
1198
some other features depending on the reason for not being supported.
1202
def open(self, a_bzrdir, _found=False):
1203
"""Return the branch object for a_bzrdir
1205
_found is a private parameter, do not use it. It is used to indicate
1206
if format probing has already be done.
1208
raise NotImplementedError(self.open)
1211
def register_format(klass, format):
1212
klass._formats[format.get_format_string()] = format
1215
def set_default_format(klass, format):
1216
klass._default_format = format
1218
def supports_stacking(self):
1219
"""True if this format records a stacked-on branch."""
1223
def unregister_format(klass, format):
1224
del klass._formats[format.get_format_string()]
1227
return self.get_format_string().rstrip()
1229
def supports_tags(self):
1230
"""True if this format supports tags stored in the branch"""
1231
return False # by default
1234
class BranchHooks(Hooks):
1235
"""A dictionary mapping hook name to a list of callables for branch hooks.
1237
e.g. ['set_rh'] Is the list of items to be called when the
1238
set_revision_history function is invoked.
1242
"""Create the default hooks.
1244
These are all empty initially, because by default nothing should get
1247
Hooks.__init__(self)
1248
# Introduced in 0.15:
1249
# invoked whenever the revision history has been set
1250
# with set_revision_history. The api signature is
1251
# (branch, revision_history), and the branch will
1254
# Invoked after a branch is opened. The api signature is (branch).
1256
# invoked after a push operation completes.
1257
# the api signature is
1259
# containing the members
1260
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1261
# where local is the local target branch or None, master is the target
1262
# master branch, and the rest should be self explanatory. The source
1263
# is read locked and the target branches write locked. Source will
1264
# be the local low-latency branch.
1265
self['post_push'] = []
1266
# invoked after a pull operation completes.
1267
# the api signature is
1269
# containing the members
1270
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1271
# where local is the local branch or None, master is the target
1272
# master branch, and the rest should be self explanatory. The source
1273
# is read locked and the target branches write locked. The local
1274
# branch is the low-latency branch.
1275
self['post_pull'] = []
1276
# invoked before a commit operation takes place.
1277
# the api signature is
1278
# (local, master, old_revno, old_revid, future_revno, future_revid,
1279
# tree_delta, future_tree).
1280
# old_revid is NULL_REVISION for the first commit to a branch
1281
# tree_delta is a TreeDelta object describing changes from the basis
1282
# revision, hooks MUST NOT modify this delta
1283
# future_tree is an in-memory tree obtained from
1284
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1285
self['pre_commit'] = []
1286
# invoked after a commit operation completes.
1287
# the api signature is
1288
# (local, master, old_revno, old_revid, new_revno, new_revid)
1289
# old_revid is NULL_REVISION for the first commit to a branch.
1290
self['post_commit'] = []
1291
# invoked after a uncommit operation completes.
1292
# the api signature is
1293
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1294
# local is the local branch or None, master is the target branch,
1295
# and an empty branch recieves new_revno of 0, new_revid of None.
1296
self['post_uncommit'] = []
1298
# Invoked before the tip of a branch changes.
1299
# the api signature is
1300
# (params) where params is a ChangeBranchTipParams with the members
1301
# (branch, old_revno, new_revno, old_revid, new_revid)
1302
self['pre_change_branch_tip'] = []
1304
# Invoked after the tip of a branch changes.
1305
# the api signature is
1306
# (params) where params is a ChangeBranchTipParams with the members
1307
# (branch, old_revno, new_revno, old_revid, new_revid)
1308
self['post_change_branch_tip'] = []
1310
# Invoked when a stacked branch activates its fallback locations and
1311
# allows the transformation of the url of said location.
1312
# the api signature is
1313
# (branch, url) where branch is the branch having its fallback
1314
# location activated and url is the url for the fallback location.
1315
# The hook should return a url.
1316
self['transform_fallback_location'] = []
1319
# install the default hooks into the Branch class.
1320
Branch.hooks = BranchHooks()
1323
class ChangeBranchTipParams(object):
1324
"""Object holding parameters passed to *_change_branch_tip hooks.
1326
There are 5 fields that hooks may wish to access:
1328
:ivar branch: the branch being changed
1329
:ivar old_revno: revision number before the change
1330
:ivar new_revno: revision number after the change
1331
:ivar old_revid: revision id before the change
1332
:ivar new_revid: revision id after the change
1334
The revid fields are strings. The revno fields are integers.
1337
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1338
"""Create a group of ChangeBranchTip parameters.
1340
:param branch: The branch being changed.
1341
:param old_revno: Revision number before the change.
1342
:param new_revno: Revision number after the change.
1343
:param old_revid: Tip revision id before the change.
1344
:param new_revid: Tip revision id after the change.
1346
self.branch = branch
1347
self.old_revno = old_revno
1348
self.new_revno = new_revno
1349
self.old_revid = old_revid
1350
self.new_revid = new_revid
1352
def __eq__(self, other):
1353
return self.__dict__ == other.__dict__
1356
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1357
self.__class__.__name__, self.branch,
1358
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1361
class BzrBranchFormat4(BranchFormat):
1362
"""Bzr branch format 4.
1365
- a revision-history file.
1366
- a branch-lock lock file [ to be shared with the bzrdir ]
1369
def get_format_description(self):
1370
"""See BranchFormat.get_format_description()."""
1371
return "Branch format 4"
1373
def initialize(self, a_bzrdir):
1374
"""Create a branch of this format in a_bzrdir."""
1375
utf8_files = [('revision-history', ''),
1376
('branch-name', ''),
1378
return self._initialize_helper(a_bzrdir, utf8_files,
1379
lock_type='branch4', set_format=False)
1382
super(BzrBranchFormat4, self).__init__()
1383
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1385
def open(self, a_bzrdir, _found=False):
1386
"""Return the branch object for a_bzrdir
1388
_found is a private parameter, do not use it. It is used to indicate
1389
if format probing has already be done.
1392
# we are being called directly and must probe.
1393
raise NotImplementedError
1394
return BzrBranch(_format=self,
1395
_control_files=a_bzrdir._control_files,
1397
_repository=a_bzrdir.open_repository())
1400
return "Bazaar-NG branch format 4"
1403
class BranchFormatMetadir(BranchFormat):
1404
"""Common logic for meta-dir based branch formats."""
1406
def _branch_class(self):
1407
"""What class to instantiate on open calls."""
1408
raise NotImplementedError(self._branch_class)
1410
def open(self, a_bzrdir, _found=False):
1411
"""Return the branch object for a_bzrdir.
1413
_found is a private parameter, do not use it. It is used to indicate
1414
if format probing has already be done.
1417
format = BranchFormat.find_format(a_bzrdir)
1418
if format.__class__ != self.__class__:
1419
raise AssertionError("wrong format %r found for %r" %
1422
transport = a_bzrdir.get_branch_transport(None)
1423
control_files = lockable_files.LockableFiles(transport, 'lock',
1425
return self._branch_class()(_format=self,
1426
_control_files=control_files,
1428
_repository=a_bzrdir.find_repository())
1429
except errors.NoSuchFile:
1430
raise errors.NotBranchError(path=transport.base)
1433
super(BranchFormatMetadir, self).__init__()
1434
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1435
self._matchingbzrdir.set_branch_format(self)
1437
def supports_tags(self):
1441
class BzrBranchFormat5(BranchFormatMetadir):
1442
"""Bzr branch format 5.
1445
- a revision-history file.
1447
- a lock dir guarding the branch itself
1448
- all of this stored in a branch/ subdirectory
1449
- works with shared repositories.
1451
This format is new in bzr 0.8.
1454
def _branch_class(self):
1457
def get_format_string(self):
1458
"""See BranchFormat.get_format_string()."""
1459
return "Bazaar-NG branch format 5\n"
1461
def get_format_description(self):
1462
"""See BranchFormat.get_format_description()."""
1463
return "Branch format 5"
1465
def initialize(self, a_bzrdir):
1466
"""Create a branch of this format in a_bzrdir."""
1467
utf8_files = [('revision-history', ''),
1468
('branch-name', ''),
1470
return self._initialize_helper(a_bzrdir, utf8_files)
1472
def supports_tags(self):
1476
class BzrBranchFormat6(BranchFormatMetadir):
1477
"""Branch format with last-revision and tags.
1479
Unlike previous formats, this has no explicit revision history. Instead,
1480
this just stores the last-revision, and the left-hand history leading
1481
up to there is the history.
1483
This format was introduced in bzr 0.15
1484
and became the default in 0.91.
1487
def _branch_class(self):
1490
def get_format_string(self):
1491
"""See BranchFormat.get_format_string()."""
1492
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1494
def get_format_description(self):
1495
"""See BranchFormat.get_format_description()."""
1496
return "Branch format 6"
1498
def initialize(self, a_bzrdir):
1499
"""Create a branch of this format in a_bzrdir."""
1500
utf8_files = [('last-revision', '0 null:\n'),
1501
('branch.conf', ''),
1504
return self._initialize_helper(a_bzrdir, utf8_files)
1507
class BzrBranchFormat7(BranchFormatMetadir):
1508
"""Branch format with last-revision, tags, and a stacked location pointer.
1510
The stacked location pointer is passed down to the repository and requires
1511
a repository format with supports_external_lookups = True.
1513
This format was introduced in bzr 1.6.
1516
def _branch_class(self):
1519
def get_format_string(self):
1520
"""See BranchFormat.get_format_string()."""
1521
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1523
def get_format_description(self):
1524
"""See BranchFormat.get_format_description()."""
1525
return "Branch format 7"
1527
def initialize(self, a_bzrdir):
1528
"""Create a branch of this format in a_bzrdir."""
1529
utf8_files = [('last-revision', '0 null:\n'),
1530
('branch.conf', ''),
1533
return self._initialize_helper(a_bzrdir, utf8_files)
1536
super(BzrBranchFormat7, self).__init__()
1537
self._matchingbzrdir.repository_format = \
1538
RepositoryFormatKnitPack5RichRoot()
1540
def supports_stacking(self):
1544
class BranchReferenceFormat(BranchFormat):
1545
"""Bzr branch reference format.
1547
Branch references are used in implementing checkouts, they
1548
act as an alias to the real branch which is at some other url.
1555
def get_format_string(self):
1556
"""See BranchFormat.get_format_string()."""
1557
return "Bazaar-NG Branch Reference Format 1\n"
1559
def get_format_description(self):
1560
"""See BranchFormat.get_format_description()."""
1561
return "Checkout reference format 1"
1563
def get_reference(self, a_bzrdir):
1564
"""See BranchFormat.get_reference()."""
1565
transport = a_bzrdir.get_branch_transport(None)
1566
return transport.get('location').read()
1568
def set_reference(self, a_bzrdir, to_branch):
1569
"""See BranchFormat.set_reference()."""
1570
transport = a_bzrdir.get_branch_transport(None)
1571
location = transport.put_bytes('location', to_branch.base)
1573
def initialize(self, a_bzrdir, target_branch=None):
1574
"""Create a branch of this format in a_bzrdir."""
1575
if target_branch is None:
1576
# this format does not implement branch itself, thus the implicit
1577
# creation contract must see it as uninitializable
1578
raise errors.UninitializableFormat(self)
1579
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1580
branch_transport = a_bzrdir.get_branch_transport(self)
1581
branch_transport.put_bytes('location',
1582
target_branch.bzrdir.root_transport.base)
1583
branch_transport.put_bytes('format', self.get_format_string())
1585
a_bzrdir, _found=True,
1586
possible_transports=[target_branch.bzrdir.root_transport])
1589
super(BranchReferenceFormat, self).__init__()
1590
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1591
self._matchingbzrdir.set_branch_format(self)
1593
def _make_reference_clone_function(format, a_branch):
1594
"""Create a clone() routine for a branch dynamically."""
1595
def clone(to_bzrdir, revision_id=None):
1596
"""See Branch.clone()."""
1597
return format.initialize(to_bzrdir, a_branch)
1598
# cannot obey revision_id limits when cloning a reference ...
1599
# FIXME RBC 20060210 either nuke revision_id for clone, or
1600
# emit some sort of warning/error to the caller ?!
1603
def open(self, a_bzrdir, _found=False, location=None,
1604
possible_transports=None):
1605
"""Return the branch that the branch reference in a_bzrdir points at.
1607
_found is a private parameter, do not use it. It is used to indicate
1608
if format probing has already be done.
1611
format = BranchFormat.find_format(a_bzrdir)
1612
if format.__class__ != self.__class__:
1613
raise AssertionError("wrong format %r found for %r" %
1615
if location is None:
1616
location = self.get_reference(a_bzrdir)
1617
real_bzrdir = bzrdir.BzrDir.open(
1618
location, possible_transports=possible_transports)
1619
result = real_bzrdir.open_branch()
1620
# this changes the behaviour of result.clone to create a new reference
1621
# rather than a copy of the content of the branch.
1622
# I did not use a proxy object because that needs much more extensive
1623
# testing, and we are only changing one behaviour at the moment.
1624
# If we decide to alter more behaviours - i.e. the implicit nickname
1625
# then this should be refactored to introduce a tested proxy branch
1626
# and a subclass of that for use in overriding clone() and ....
1628
result.clone = self._make_reference_clone_function(result)
1632
# formats which have no format string are not discoverable
1633
# and not independently creatable, so are not registered.
1634
__format5 = BzrBranchFormat5()
1635
__format6 = BzrBranchFormat6()
1636
__format7 = BzrBranchFormat7()
1637
BranchFormat.register_format(__format5)
1638
BranchFormat.register_format(BranchReferenceFormat())
1639
BranchFormat.register_format(__format6)
1640
BranchFormat.register_format(__format7)
1641
BranchFormat.set_default_format(__format6)
1642
_legacy_formats = [BzrBranchFormat4(),
1645
class BzrBranch(Branch):
1646
"""A branch stored in the actual filesystem.
1648
Note that it's "local" in the context of the filesystem; it doesn't
1649
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1650
it's writable, and can be accessed via the normal filesystem API.
1652
:ivar _transport: Transport for file operations on this branch's
1653
control files, typically pointing to the .bzr/branch directory.
1654
:ivar repository: Repository for this branch.
1655
:ivar base: The url of the base directory for this branch; the one
1656
containing the .bzr directory.
1659
def __init__(self, _format=None,
1660
_control_files=None, a_bzrdir=None, _repository=None):
1661
"""Create new branch object at a particular location."""
1662
if a_bzrdir is None:
1663
raise ValueError('a_bzrdir must be supplied')
1665
self.bzrdir = a_bzrdir
1666
self._base = self.bzrdir.transport.clone('..').base
1667
# XXX: We should be able to just do
1668
# self.base = self.bzrdir.root_transport.base
1669
# but this does not quite work yet -- mbp 20080522
1670
self._format = _format
1671
if _control_files is None:
1672
raise ValueError('BzrBranch _control_files is None')
1673
self.control_files = _control_files
1674
self._transport = _control_files._transport
1675
self.repository = _repository
1676
Branch.__init__(self)
1679
return '%s(%r)' % (self.__class__.__name__, self.base)
1683
def _get_base(self):
1684
"""Returns the directory containing the control directory."""
1687
base = property(_get_base, doc="The URL for the root of this branch.")
1689
def is_locked(self):
1690
return self.control_files.is_locked()
1692
def lock_write(self, token=None):
1693
repo_token = self.repository.lock_write()
1695
token = self.control_files.lock_write(token=token)
1697
self.repository.unlock()
1701
def lock_read(self):
1702
self.repository.lock_read()
1704
self.control_files.lock_read()
1706
self.repository.unlock()
1710
# TODO: test for failed two phase locks. This is known broken.
1712
self.control_files.unlock()
1714
self.repository.unlock()
1715
if not self.control_files.is_locked():
1716
# we just released the lock
1717
self._clear_cached_state()
1719
def peek_lock_mode(self):
1720
if self.control_files._lock_count == 0:
1723
return self.control_files._lock_mode
1725
def get_physical_lock_status(self):
1726
return self.control_files.get_physical_lock_status()
1729
def print_file(self, file, revision_id):
1730
"""See Branch.print_file."""
1731
return self.repository.print_file(file, revision_id)
1733
def _write_revision_history(self, history):
1734
"""Factored out of set_revision_history.
1736
This performs the actual writing to disk.
1737
It is intended to be called by BzrBranch5.set_revision_history."""
1738
self._transport.put_bytes(
1739
'revision-history', '\n'.join(history),
1740
mode=self.bzrdir._get_file_mode())
1743
def set_revision_history(self, rev_history):
1744
"""See Branch.set_revision_history."""
1745
if 'evil' in debug.debug_flags:
1746
mutter_callsite(3, "set_revision_history scales with history.")
1747
check_not_reserved_id = _mod_revision.check_not_reserved_id
1748
for rev_id in rev_history:
1749
check_not_reserved_id(rev_id)
1750
if Branch.hooks['post_change_branch_tip']:
1751
# Don't calculate the last_revision_info() if there are no hooks
1753
old_revno, old_revid = self.last_revision_info()
1754
if len(rev_history) == 0:
1755
revid = _mod_revision.NULL_REVISION
1757
revid = rev_history[-1]
1758
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1759
self._write_revision_history(rev_history)
1760
self._clear_cached_state()
1761
self._cache_revision_history(rev_history)
1762
for hook in Branch.hooks['set_rh']:
1763
hook(self, rev_history)
1764
if Branch.hooks['post_change_branch_tip']:
1765
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1767
def _synchronize_history(self, destination, revision_id):
1768
"""Synchronize last revision and revision history between branches.
1770
This version is most efficient when the destination is also a
1771
BzrBranch5, but works for BzrBranch6 as long as the revision
1772
history is the true lefthand parent history, and all of the revisions
1773
are in the destination's repository. If not, set_revision_history
1776
:param destination: The branch to copy the history into
1777
:param revision_id: The revision-id to truncate history at. May
1778
be None to copy complete history.
1780
if not isinstance(destination._format, BzrBranchFormat5):
1781
super(BzrBranch, self)._synchronize_history(
1782
destination, revision_id)
1784
if revision_id == _mod_revision.NULL_REVISION:
1787
new_history = self.revision_history()
1788
if revision_id is not None and new_history != []:
1790
new_history = new_history[:new_history.index(revision_id) + 1]
1792
rev = self.repository.get_revision(revision_id)
1793
new_history = rev.get_history(self.repository)[1:]
1794
destination.set_revision_history(new_history)
1796
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1797
"""Run the pre_change_branch_tip hooks."""
1798
hooks = Branch.hooks['pre_change_branch_tip']
1801
old_revno, old_revid = self.last_revision_info()
1802
params = ChangeBranchTipParams(
1803
self, old_revno, new_revno, old_revid, new_revid)
1807
except errors.TipChangeRejected:
1810
exc_info = sys.exc_info()
1811
hook_name = Branch.hooks.get_hook_name(hook)
1812
raise errors.HookFailed(
1813
'pre_change_branch_tip', hook_name, exc_info)
1815
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1816
"""Run the post_change_branch_tip hooks."""
1817
hooks = Branch.hooks['post_change_branch_tip']
1820
new_revno, new_revid = self.last_revision_info()
1821
params = ChangeBranchTipParams(
1822
self, old_revno, new_revno, old_revid, new_revid)
1827
def set_last_revision_info(self, revno, revision_id):
1828
"""Set the last revision of this branch.
1830
The caller is responsible for checking that the revno is correct
1831
for this revision id.
1833
It may be possible to set the branch last revision to an id not
1834
present in the repository. However, branches can also be
1835
configured to check constraints on history, in which case this may not
1838
revision_id = _mod_revision.ensure_null(revision_id)
1839
# this old format stores the full history, but this api doesn't
1840
# provide it, so we must generate, and might as well check it's
1842
history = self._lefthand_history(revision_id)
1843
if len(history) != revno:
1844
raise AssertionError('%d != %d' % (len(history), revno))
1845
self.set_revision_history(history)
1847
def _gen_revision_history(self):
1848
history = self._transport.get_bytes('revision-history').split('\n')
1849
if history[-1:] == ['']:
1850
# There shouldn't be a trailing newline, but just in case.
1854
def _lefthand_history(self, revision_id, last_rev=None,
1856
if 'evil' in debug.debug_flags:
1857
mutter_callsite(4, "_lefthand_history scales with history.")
1858
# stop_revision must be a descendant of last_revision
1859
graph = self.repository.get_graph()
1860
if last_rev is not None:
1861
if not graph.is_ancestor(last_rev, revision_id):
1862
# our previous tip is not merged into stop_revision
1863
raise errors.DivergedBranches(self, other_branch)
1864
# make a new revision history from the graph
1865
parents_map = graph.get_parent_map([revision_id])
1866
if revision_id not in parents_map:
1867
raise errors.NoSuchRevision(self, revision_id)
1868
current_rev_id = revision_id
1870
check_not_reserved_id = _mod_revision.check_not_reserved_id
1871
# Do not include ghosts or graph origin in revision_history
1872
while (current_rev_id in parents_map and
1873
len(parents_map[current_rev_id]) > 0):
1874
check_not_reserved_id(current_rev_id)
1875
new_history.append(current_rev_id)
1876
current_rev_id = parents_map[current_rev_id][0]
1877
parents_map = graph.get_parent_map([current_rev_id])
1878
new_history.reverse()
1882
def generate_revision_history(self, revision_id, last_rev=None,
1884
"""Create a new revision history that will finish with revision_id.
1886
:param revision_id: the new tip to use.
1887
:param last_rev: The previous last_revision. If not None, then this
1888
must be a ancestory of revision_id, or DivergedBranches is raised.
1889
:param other_branch: The other branch that DivergedBranches should
1890
raise with respect to.
1892
self.set_revision_history(self._lefthand_history(revision_id,
1893
last_rev, other_branch))
1895
def basis_tree(self):
1896
"""See Branch.basis_tree."""
1897
return self.repository.revision_tree(self.last_revision())
1900
def pull(self, source, overwrite=False, stop_revision=None,
1901
_hook_master=None, run_hooks=True, possible_transports=None,
1902
_override_hook_target=None):
1905
:param _hook_master: Private parameter - set the branch to
1906
be supplied as the master to pull hooks.
1907
:param run_hooks: Private parameter - if false, this branch
1908
is being called because it's the master of the primary branch,
1909
so it should not run its hooks.
1910
:param _override_hook_target: Private parameter - set the branch to be
1911
supplied as the target_branch to pull hooks.
1913
result = PullResult()
1914
result.source_branch = source
1915
if _override_hook_target is None:
1916
result.target_branch = self
1918
result.target_branch = _override_hook_target
1921
# We assume that during 'pull' the local repository is closer than
1923
graph = self.repository.get_graph(source.repository)
1924
result.old_revno, result.old_revid = self.last_revision_info()
1925
self.update_revisions(source, stop_revision, overwrite=overwrite,
1927
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1928
result.new_revno, result.new_revid = self.last_revision_info()
1930
result.master_branch = _hook_master
1931
result.local_branch = result.target_branch
1933
result.master_branch = result.target_branch
1934
result.local_branch = None
1936
for hook in Branch.hooks['post_pull']:
1942
def _get_parent_location(self):
1943
_locs = ['parent', 'pull', 'x-pull']
1946
return self._transport.get_bytes(l).strip('\n')
1947
except errors.NoSuchFile:
1952
def push(self, target, overwrite=False, stop_revision=None,
1953
_override_hook_source_branch=None):
1956
This is the basic concrete implementation of push()
1958
:param _override_hook_source_branch: If specified, run
1959
the hooks passing this Branch as the source, rather than self.
1960
This is for use of RemoteBranch, where push is delegated to the
1961
underlying vfs-based Branch.
1963
# TODO: Public option to disable running hooks - should be trivial but
1965
return _run_with_write_locked_target(
1966
target, self._push_with_bound_branches, target, overwrite,
1968
_override_hook_source_branch=_override_hook_source_branch)
1970
def _push_with_bound_branches(self, target, overwrite,
1972
_override_hook_source_branch=None):
1973
"""Push from self into target, and into target's master if any.
1975
This is on the base BzrBranch class even though it doesn't support
1976
bound branches because the *target* might be bound.
1979
if _override_hook_source_branch:
1980
result.source_branch = _override_hook_source_branch
1981
for hook in Branch.hooks['post_push']:
1984
bound_location = target.get_bound_location()
1985
if bound_location and target.base != bound_location:
1986
# there is a master branch.
1988
# XXX: Why the second check? Is it even supported for a branch to
1989
# be bound to itself? -- mbp 20070507
1990
master_branch = target.get_master_branch()
1991
master_branch.lock_write()
1993
# push into the master from this branch.
1994
self._basic_push(master_branch, overwrite, stop_revision)
1995
# and push into the target branch from this. Note that we push from
1996
# this branch again, because its considered the highest bandwidth
1998
result = self._basic_push(target, overwrite, stop_revision)
1999
result.master_branch = master_branch
2000
result.local_branch = target
2004
master_branch.unlock()
2007
result = self._basic_push(target, overwrite, stop_revision)
2008
# TODO: Why set master_branch and local_branch if there's no
2009
# binding? Maybe cleaner to just leave them unset? -- mbp
2011
result.master_branch = target
2012
result.local_branch = None
2016
def _basic_push(self, target, overwrite, stop_revision):
2017
"""Basic implementation of push without bound branches or hooks.
2019
Must be called with self read locked and target write locked.
2021
result = PushResult()
2022
result.source_branch = self
2023
result.target_branch = target
2024
result.old_revno, result.old_revid = target.last_revision_info()
2025
if result.old_revid != self.last_revision():
2026
# We assume that during 'push' this repository is closer than
2028
graph = self.repository.get_graph(target.repository)
2029
target.update_revisions(self, stop_revision, overwrite=overwrite,
2031
if self._push_should_merge_tags():
2032
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2033
result.new_revno, result.new_revid = target.last_revision_info()
2036
def _push_should_merge_tags(self):
2037
"""Should _basic_push merge this branch's tags into the target?
2039
The default implementation returns False if this branch has no tags,
2040
and True the rest of the time. Subclasses may override this.
2042
return self.tags.supports_tags() and self.tags.get_tag_dict()
2044
def get_parent(self):
2045
"""See Branch.get_parent."""
2046
parent = self._get_parent_location()
2049
# This is an old-format absolute path to a local branch
2050
# turn it into a url
2051
if parent.startswith('/'):
2052
parent = urlutils.local_path_to_url(parent.decode('utf8'))
2054
return urlutils.join(self.base[:-1], parent)
2055
except errors.InvalidURLJoin, e:
2056
raise errors.InaccessibleParent(parent, self.base)
2058
def get_stacked_on_url(self):
2059
raise errors.UnstackableBranchFormat(self._format, self.base)
2061
def set_push_location(self, location):
2062
"""See Branch.set_push_location."""
2063
self.get_config().set_user_option(
2064
'push_location', location,
2065
store=_mod_config.STORE_LOCATION_NORECURSE)
2068
def set_parent(self, url):
2069
"""See Branch.set_parent."""
2070
# TODO: Maybe delete old location files?
2071
# URLs should never be unicode, even on the local fs,
2072
# FIXUP this and get_parent in a future branch format bump:
2073
# read and rewrite the file. RBC 20060125
2075
if isinstance(url, unicode):
2077
url = url.encode('ascii')
2078
except UnicodeEncodeError:
2079
raise errors.InvalidURL(url,
2080
"Urls must be 7-bit ascii, "
2081
"use bzrlib.urlutils.escape")
2082
url = urlutils.relative_url(self.base, url)
2083
self._set_parent_location(url)
2085
def _set_parent_location(self, url):
2087
self._transport.delete('parent')
2089
self._transport.put_bytes('parent', url + '\n',
2090
mode=self.bzrdir._get_file_mode())
2092
def set_stacked_on_url(self, url):
2093
raise errors.UnstackableBranchFormat(self._format, self.base)
2096
class BzrBranch5(BzrBranch):
2097
"""A format 5 branch. This supports new features over plain branches.
2099
It has support for a master_branch which is the data for bound branches.
2103
def pull(self, source, overwrite=False, stop_revision=None,
2104
run_hooks=True, possible_transports=None,
2105
_override_hook_target=None):
2106
"""Pull from source into self, updating my master if any.
2108
:param run_hooks: Private parameter - if false, this branch
2109
is being called because it's the master of the primary branch,
2110
so it should not run its hooks.
2112
bound_location = self.get_bound_location()
2113
master_branch = None
2114
if bound_location and source.base != bound_location:
2115
# not pulling from master, so we need to update master.
2116
master_branch = self.get_master_branch(possible_transports)
2117
master_branch.lock_write()
2120
# pull from source into master.
2121
master_branch.pull(source, overwrite, stop_revision,
2123
return super(BzrBranch5, self).pull(source, overwrite,
2124
stop_revision, _hook_master=master_branch,
2125
run_hooks=run_hooks,
2126
_override_hook_target=_override_hook_target)
2129
master_branch.unlock()
2131
def get_bound_location(self):
2133
return self._transport.get_bytes('bound')[:-1]
2134
except errors.NoSuchFile:
2138
def get_master_branch(self, possible_transports=None):
2139
"""Return the branch we are bound to.
2141
:return: Either a Branch, or None
2143
This could memoise the branch, but if thats done
2144
it must be revalidated on each new lock.
2145
So for now we just don't memoise it.
2146
# RBC 20060304 review this decision.
2148
bound_loc = self.get_bound_location()
2152
return Branch.open(bound_loc,
2153
possible_transports=possible_transports)
2154
except (errors.NotBranchError, errors.ConnectionError), e:
2155
raise errors.BoundBranchConnectionFailure(
2159
def set_bound_location(self, location):
2160
"""Set the target where this branch is bound to.
2162
:param location: URL to the target branch
2165
self._transport.put_bytes('bound', location+'\n',
2166
mode=self.bzrdir._get_file_mode())
2169
self._transport.delete('bound')
2170
except errors.NoSuchFile:
2175
def bind(self, other):
2176
"""Bind this branch to the branch other.
2178
This does not push or pull data between the branches, though it does
2179
check for divergence to raise an error when the branches are not
2180
either the same, or one a prefix of the other. That behaviour may not
2181
be useful, so that check may be removed in future.
2183
:param other: The branch to bind to
2186
# TODO: jam 20051230 Consider checking if the target is bound
2187
# It is debatable whether you should be able to bind to
2188
# a branch which is itself bound.
2189
# Committing is obviously forbidden,
2190
# but binding itself may not be.
2191
# Since we *have* to check at commit time, we don't
2192
# *need* to check here
2194
# we want to raise diverged if:
2195
# last_rev is not in the other_last_rev history, AND
2196
# other_last_rev is not in our history, and do it without pulling
2198
self.set_bound_location(other.base)
2202
"""If bound, unbind"""
2203
return self.set_bound_location(None)
2206
def update(self, possible_transports=None):
2207
"""Synchronise this branch with the master branch if any.
2209
:return: None or the last_revision that was pivoted out during the
2212
master = self.get_master_branch(possible_transports)
2213
if master is not None:
2214
old_tip = _mod_revision.ensure_null(self.last_revision())
2215
self.pull(master, overwrite=True)
2216
if self.repository.get_graph().is_ancestor(old_tip,
2217
_mod_revision.ensure_null(self.last_revision())):
2223
class BzrBranch7(BzrBranch5):
2224
"""A branch with support for a fallback repository."""
2226
def _get_fallback_repository(self, url):
2227
"""Get the repository we fallback to at url."""
2228
url = urlutils.join(self.base, url)
2229
a_bzrdir = bzrdir.BzrDir.open(url,
2230
possible_transports=[self._transport])
2231
return a_bzrdir.open_branch().repository
2233
def _activate_fallback_location(self, url):
2234
"""Activate the branch/repository from url as a fallback repository."""
2235
self.repository.add_fallback_repository(
2236
self._get_fallback_repository(url))
2238
def _open_hook(self):
2240
url = self.get_stacked_on_url()
2241
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2242
errors.UnstackableBranchFormat):
2245
for hook in Branch.hooks['transform_fallback_location']:
2246
url = hook(self, url)
2248
hook_name = Branch.hooks.get_hook_name(hook)
2249
raise AssertionError(
2250
"'transform_fallback_location' hook %s returned "
2251
"None, not a URL." % hook_name)
2252
self._activate_fallback_location(url)
2254
def _check_stackable_repo(self):
2255
if not self.repository._format.supports_external_lookups:
2256
raise errors.UnstackableRepositoryFormat(self.repository._format,
2257
self.repository.base)
2259
def __init__(self, *args, **kwargs):
2260
super(BzrBranch7, self).__init__(*args, **kwargs)
2261
self._last_revision_info_cache = None
2262
self._partial_revision_history_cache = []
2264
def _clear_cached_state(self):
2265
super(BzrBranch7, self)._clear_cached_state()
2266
self._last_revision_info_cache = None
2267
self._partial_revision_history_cache = []
2269
def _last_revision_info(self):
2270
revision_string = self._transport.get_bytes('last-revision')
2271
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2272
revision_id = cache_utf8.get_cached_utf8(revision_id)
2274
return revno, revision_id
2276
def _write_last_revision_info(self, revno, revision_id):
2277
"""Simply write out the revision id, with no checks.
2279
Use set_last_revision_info to perform this safely.
2281
Does not update the revision_history cache.
2282
Intended to be called by set_last_revision_info and
2283
_write_revision_history.
2285
revision_id = _mod_revision.ensure_null(revision_id)
2286
out_string = '%d %s\n' % (revno, revision_id)
2287
self._transport.put_bytes('last-revision', out_string,
2288
mode=self.bzrdir._get_file_mode())
2291
def set_last_revision_info(self, revno, revision_id):
2292
revision_id = _mod_revision.ensure_null(revision_id)
2293
old_revno, old_revid = self.last_revision_info()
2294
if self._get_append_revisions_only():
2295
self._check_history_violation(revision_id)
2296
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2297
self._write_last_revision_info(revno, revision_id)
2298
self._clear_cached_state()
2299
self._last_revision_info_cache = revno, revision_id
2300
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2302
def _synchronize_history(self, destination, revision_id):
2303
"""Synchronize last revision and revision history between branches.
2305
:see: Branch._synchronize_history
2307
# XXX: The base Branch has a fast implementation of this method based
2308
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2309
# that uses set_revision_history. This class inherits from BzrBranch5,
2310
# but wants the fast implementation, so it calls
2311
# Branch._synchronize_history directly.
2312
Branch._synchronize_history(self, destination, revision_id)
2314
def _check_history_violation(self, revision_id):
2315
last_revision = _mod_revision.ensure_null(self.last_revision())
2316
if _mod_revision.is_null(last_revision):
2318
if last_revision not in self._lefthand_history(revision_id):
2319
raise errors.AppendRevisionsOnlyViolation(self.base)
2321
def _gen_revision_history(self):
2322
"""Generate the revision history from last revision
2324
last_revno, last_revision = self.last_revision_info()
2325
self._extend_partial_history(stop_index=last_revno-1)
2326
return list(reversed(self._partial_revision_history_cache))
2328
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2329
"""Extend the partial history to include a given index
2331
If a stop_index is supplied, stop when that index has been reached.
2332
If a stop_revision is supplied, stop when that revision is
2333
encountered. Otherwise, stop when the beginning of history is
2336
:param stop_index: The index which should be present. When it is
2337
present, history extension will stop.
2338
:param revision_id: The revision id which should be present. When
2339
it is encountered, history extension will stop.
2341
repo = self.repository
2342
if len(self._partial_revision_history_cache) == 0:
2343
iterator = repo.iter_reverse_revision_history(self.last_revision())
2345
start_revision = self._partial_revision_history_cache[-1]
2346
iterator = repo.iter_reverse_revision_history(start_revision)
2347
#skip the last revision in the list
2348
next_revision = iterator.next()
2349
for revision_id in iterator:
2350
self._partial_revision_history_cache.append(revision_id)
2351
if (stop_index is not None and
2352
len(self._partial_revision_history_cache) > stop_index):
2354
if revision_id == stop_revision:
2357
def _write_revision_history(self, history):
2358
"""Factored out of set_revision_history.
2360
This performs the actual writing to disk, with format-specific checks.
2361
It is intended to be called by BzrBranch5.set_revision_history.
2363
if len(history) == 0:
2364
last_revision = 'null:'
2366
if history != self._lefthand_history(history[-1]):
2367
raise errors.NotLefthandHistory(history)
2368
last_revision = history[-1]
2369
if self._get_append_revisions_only():
2370
self._check_history_violation(last_revision)
2371
self._write_last_revision_info(len(history), last_revision)
2374
def _set_parent_location(self, url):
2375
"""Set the parent branch"""
2376
self._set_config_location('parent_location', url, make_relative=True)
2379
def _get_parent_location(self):
2380
"""Set the parent branch"""
2381
return self._get_config_location('parent_location')
2383
def set_push_location(self, location):
2384
"""See Branch.set_push_location."""
2385
self._set_config_location('push_location', location)
2387
def set_bound_location(self, location):
2388
"""See Branch.set_push_location."""
2390
config = self.get_config()
2391
if location is None:
2392
if config.get_user_option('bound') != 'True':
2395
config.set_user_option('bound', 'False', warn_masked=True)
2398
self._set_config_location('bound_location', location,
2400
config.set_user_option('bound', 'True', warn_masked=True)
2403
def _get_bound_location(self, bound):
2404
"""Return the bound location in the config file.
2406
Return None if the bound parameter does not match"""
2407
config = self.get_config()
2408
config_bound = (config.get_user_option('bound') == 'True')
2409
if config_bound != bound:
2411
return self._get_config_location('bound_location', config=config)
2413
def get_bound_location(self):
2414
"""See Branch.set_push_location."""
2415
return self._get_bound_location(True)
2417
def get_old_bound_location(self):
2418
"""See Branch.get_old_bound_location"""
2419
return self._get_bound_location(False)
2421
def get_stacked_on_url(self):
2422
# you can always ask for the URL; but you might not be able to use it
2423
# if the repo can't support stacking.
2424
## self._check_stackable_repo()
2425
stacked_url = self._get_config_location('stacked_on_location')
2426
if stacked_url is None:
2427
raise errors.NotStacked(self)
2430
def set_append_revisions_only(self, enabled):
2435
self.get_config().set_user_option('append_revisions_only', value,
2438
def set_stacked_on_url(self, url):
2439
self._check_stackable_repo()
2442
old_url = self.get_stacked_on_url()
2443
except (errors.NotStacked, errors.UnstackableBranchFormat,
2444
errors.UnstackableRepositoryFormat):
2447
# repositories don't offer an interface to remove fallback
2448
# repositories today; take the conceptually simpler option and just
2450
self.repository = self.bzrdir.find_repository()
2451
# for every revision reference the branch has, ensure it is pulled
2453
source_repository = self._get_fallback_repository(old_url)
2454
for revision_id in chain([self.last_revision()],
2455
self.tags.get_reverse_tag_dict()):
2456
self.repository.fetch(source_repository, revision_id,
2459
self._activate_fallback_location(url)
2460
# write this out after the repository is stacked to avoid setting a
2461
# stacked config that doesn't work.
2462
self._set_config_location('stacked_on_location', url)
2464
def _get_append_revisions_only(self):
2465
value = self.get_config().get_user_option('append_revisions_only')
2466
return value == 'True'
2468
def _make_tags(self):
2469
return BasicTags(self)
2472
def generate_revision_history(self, revision_id, last_rev=None,
2474
"""See BzrBranch5.generate_revision_history"""
2475
history = self._lefthand_history(revision_id, last_rev, other_branch)
2476
revno = len(history)
2477
self.set_last_revision_info(revno, revision_id)
2480
def get_rev_id(self, revno, history=None):
2481
"""Find the revision id of the specified revno."""
2483
return _mod_revision.NULL_REVISION
2485
last_revno, last_revision_id = self.last_revision_info()
2486
if revno <= 0 or revno > last_revno:
2487
raise errors.NoSuchRevision(self, revno)
2489
if history is not None:
2490
return history[revno - 1]
2492
index = last_revno - revno
2493
if len(self._partial_revision_history_cache) <= index:
2494
self._extend_partial_history(stop_index=index)
2495
if len(self._partial_revision_history_cache) > index:
2496
return self._partial_revision_history_cache[index]
2498
raise errors.NoSuchRevision(self, revno)
2501
def revision_id_to_revno(self, revision_id):
2502
"""Given a revision id, return its revno"""
2503
if _mod_revision.is_null(revision_id):
2506
index = self._partial_revision_history_cache.index(revision_id)
2508
self._extend_partial_history(stop_revision=revision_id)
2509
index = len(self._partial_revision_history_cache) - 1
2510
if self._partial_revision_history_cache[index] != revision_id:
2511
raise errors.NoSuchRevision(self, revision_id)
2512
return self.revno() - index
2515
class BzrBranch6(BzrBranch7):
2516
"""See BzrBranchFormat6 for the capabilities of this branch.
2518
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2522
def get_stacked_on_url(self):
2523
raise errors.UnstackableBranchFormat(self._format, self.base)
2525
def set_stacked_on_url(self, url):
2526
raise errors.UnstackableBranchFormat(self._format, self.base)
2529
######################################################################
2530
# results of operations
2533
class _Result(object):
2535
def _show_tag_conficts(self, to_file):
2536
if not getattr(self, 'tag_conflicts', None):
2538
to_file.write('Conflicting tags:\n')
2539
for name, value1, value2 in self.tag_conflicts:
2540
to_file.write(' %s\n' % (name, ))
2543
class PullResult(_Result):
2544
"""Result of a Branch.pull operation.
2546
:ivar old_revno: Revision number before pull.
2547
:ivar new_revno: Revision number after pull.
2548
:ivar old_revid: Tip revision id before pull.
2549
:ivar new_revid: Tip revision id after pull.
2550
:ivar source_branch: Source (local) branch object.
2551
:ivar master_branch: Master branch of the target, or the target if no
2553
:ivar local_branch: target branch if there is a Master, else None
2554
:ivar target_branch: Target/destination branch object.
2555
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2559
# DEPRECATED: pull used to return the change in revno
2560
return self.new_revno - self.old_revno
2562
def report(self, to_file):
2564
if self.old_revid == self.new_revid:
2565
to_file.write('No revisions to pull.\n')
2567
to_file.write('Now on revision %d.\n' % self.new_revno)
2568
self._show_tag_conficts(to_file)
2571
class PushResult(_Result):
2572
"""Result of a Branch.push operation.
2574
:ivar old_revno: Revision number before push.
2575
:ivar new_revno: Revision number after push.
2576
:ivar old_revid: Tip revision id before push.
2577
:ivar new_revid: Tip revision id after push.
2578
:ivar source_branch: Source branch object.
2579
:ivar master_branch: Master branch of the target, or None.
2580
:ivar target_branch: Target/destination branch object.
2584
# DEPRECATED: push used to return the change in revno
2585
return self.new_revno - self.old_revno
2587
def report(self, to_file):
2588
"""Write a human-readable description of the result."""
2589
if self.old_revid == self.new_revid:
2590
to_file.write('No new revisions to push.\n')
2592
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2593
self._show_tag_conficts(to_file)
2596
class BranchCheckResult(object):
2597
"""Results of checking branch consistency.
2602
def __init__(self, branch):
2603
self.branch = branch
2605
def report_results(self, verbose):
2606
"""Report the check results via trace.note.
2608
:param verbose: Requests more detailed display of what was checked,
2611
note('checked branch %s format %s',
2613
self.branch._format)
2616
class Converter5to6(object):
2617
"""Perform an in-place upgrade of format 5 to format 6"""
2619
def convert(self, branch):
2620
# Data for 5 and 6 can peacefully coexist.
2621
format = BzrBranchFormat6()
2622
new_branch = format.open(branch.bzrdir, _found=True)
2624
# Copy source data into target
2625
new_branch._write_last_revision_info(*branch.last_revision_info())
2626
new_branch.set_parent(branch.get_parent())
2627
new_branch.set_bound_location(branch.get_bound_location())
2628
new_branch.set_push_location(branch.get_push_location())
2630
# New branch has no tags by default
2631
new_branch.tags._set_tag_dict({})
2633
# Copying done; now update target format
2634
new_branch._transport.put_bytes('format',
2635
format.get_format_string(),
2636
mode=new_branch.bzrdir._get_file_mode())
2638
# Clean up old files
2639
new_branch._transport.delete('revision-history')
2641
branch.set_parent(None)
2642
except errors.NoSuchFile:
2644
branch.set_bound_location(None)
2647
class Converter6to7(object):
2648
"""Perform an in-place upgrade of format 6 to format 7"""
2650
def convert(self, branch):
2651
format = BzrBranchFormat7()
2652
branch._set_config_location('stacked_on_location', '')
2653
# update target format
2654
branch._transport.put_bytes('format', format.get_format_string())
2658
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2659
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2662
_run_with_write_locked_target will attempt to release the lock it acquires.
2664
If an exception is raised by callable, then that exception *will* be
2665
propagated, even if the unlock attempt raises its own error. Thus
2666
_run_with_write_locked_target should be preferred to simply doing::
2670
return callable(*args, **kwargs)
2675
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2676
# should share code?
2679
result = callable(*args, **kwargs)
2681
exc_info = sys.exc_info()
2685
raise exc_info[0], exc_info[1], exc_info[2]
added
removed
bzrlib/branch.py
