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, 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 (i.e. the range is inclusive). If None, the rest of
306
:param direction: either 'reverse' or 'forward':
307
* reverse means return the start_revision_id first, i.e.
308
start at the most recent revision and go backwards in history
309
* forward returns tuples in the opposite order to reverse.
310
Note in particular that forward does *not* do any intelligent
311
ordering w.r.t. depth as some clients of this API may like.
312
(If required, that ought to be done at higher layers.)
314
:return: an iterator over (revision_id, depth, revno, end_of_merge)
317
* revision_id: the unique id of the revision
318
* depth: How many levels of merging deep this node has been
320
* revno_sequence: This field provides a sequence of
321
revision numbers for all revisions. The format is:
322
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
323
branch that the revno is on. From left to right the REVNO numbers
324
are the sequence numbers within that branch of the revision.
325
* end_of_merge: When True the next node (earlier in history) is
326
part of a different merge.
328
# Note: depth and revno values are in the context of the branch so
329
# we need the full graph to get stable numbers, regardless of the
331
if self._merge_sorted_revisions_cache is None:
332
last_revision = self.last_revision()
333
graph = self.repository.get_graph()
334
parent_map = dict(((key, value) for key, value in
335
graph.iter_ancestry([last_revision]) if value is not None))
336
revision_graph = repository._strip_NULL_ghosts(parent_map)
337
revs = tsort.merge_sort(revision_graph, last_revision, None,
339
# Drop the sequence # before caching
340
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
342
filtered = self._filter_merge_sorted_revisions(
343
self._merge_sorted_revisions_cache, start_revision_id,
345
if direction == 'reverse':
347
if direction == 'forward':
348
return reversed(list(filtered))
350
raise ValueError('invalid direction %r' % direction)
352
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
353
start_revision_id, stop_revision_id):
354
"""Iterate over an inclusive range of sorted revisions."""
355
rev_iter = iter(merge_sorted_revisions)
356
if start_revision_id is not None:
357
for rev_id, depth, revno, end_of_merge in rev_iter:
358
if rev_id != start_revision_id:
361
yield rev_id, depth, revno, end_of_merge
363
for rev_id, depth, revno, end_of_merge in rev_iter:
364
yield rev_id, depth, revno, end_of_merge
365
if stop_revision_id is not None and rev_id == stop_revision_id:
368
def leave_lock_in_place(self):
369
"""Tell this branch object not to release the physical lock when this
372
If lock_write doesn't return a token, then this method is not supported.
374
self.control_files.leave_in_place()
376
def dont_leave_lock_in_place(self):
377
"""Tell this branch object to release the physical lock when this
378
object is unlocked, even if it didn't originally acquire it.
380
If lock_write doesn't return a token, then this method is not supported.
382
self.control_files.dont_leave_in_place()
384
def bind(self, other):
385
"""Bind the local branch the other branch.
387
:param other: The branch to bind to
390
raise errors.UpgradeRequired(self.base)
393
def fetch(self, from_branch, last_revision=None, pb=None):
394
"""Copy revisions from from_branch into this branch.
396
:param from_branch: Where to copy from.
397
:param last_revision: What revision to stop at (None for at the end
399
:param pb: An optional progress bar to use.
401
Returns the copied revision count and the failed revisions in a tuple:
404
if self.base == from_branch.base:
407
nested_pb = ui.ui_factory.nested_progress_bar()
412
from_branch.lock_read()
414
if last_revision is None:
415
pb.update('get source history')
416
last_revision = from_branch.last_revision()
417
last_revision = _mod_revision.ensure_null(last_revision)
418
return self.repository.fetch(from_branch.repository,
419
revision_id=last_revision,
422
if nested_pb is not None:
426
def get_bound_location(self):
427
"""Return the URL of the branch we are bound to.
429
Older format branches cannot bind, please be sure to use a metadir
434
def get_old_bound_location(self):
435
"""Return the URL of the branch we used to be bound to
437
raise errors.UpgradeRequired(self.base)
439
def get_commit_builder(self, parents, config=None, timestamp=None,
440
timezone=None, committer=None, revprops=None,
442
"""Obtain a CommitBuilder for this branch.
444
:param parents: Revision ids of the parents of the new revision.
445
:param config: Optional configuration to use.
446
:param timestamp: Optional timestamp recorded for commit.
447
:param timezone: Optional timezone for timestamp.
448
:param committer: Optional committer to set for commit.
449
:param revprops: Optional dictionary of revision properties.
450
:param revision_id: Optional revision id.
454
config = self.get_config()
456
return self.repository.get_commit_builder(self, parents, config,
457
timestamp, timezone, committer, revprops, revision_id)
459
def get_master_branch(self, possible_transports=None):
460
"""Return the branch we are bound to.
462
:return: Either a Branch, or None
466
def get_revision_delta(self, revno):
467
"""Return the delta for one revision.
469
The delta is relative to its mainline predecessor, or the
470
empty tree for revision 1.
472
rh = self.revision_history()
473
if not (1 <= revno <= len(rh)):
474
raise errors.InvalidRevisionNumber(revno)
475
return self.repository.get_revision_delta(rh[revno-1])
477
def get_stacked_on_url(self):
478
"""Get the URL this branch is stacked against.
480
:raises NotStacked: If the branch is not stacked.
481
:raises UnstackableBranchFormat: If the branch does not support
484
raise NotImplementedError(self.get_stacked_on_url)
486
def print_file(self, file, revision_id):
487
"""Print `file` to stdout."""
488
raise NotImplementedError(self.print_file)
490
def set_revision_history(self, rev_history):
491
raise NotImplementedError(self.set_revision_history)
493
def set_stacked_on_url(self, url):
494
"""Set the URL this branch is stacked against.
496
:raises UnstackableBranchFormat: If the branch does not support
498
:raises UnstackableRepositoryFormat: If the repository does not support
501
raise NotImplementedError(self.set_stacked_on_url)
503
def _cache_revision_history(self, rev_history):
504
"""Set the cached revision history to rev_history.
506
The revision_history method will use this cache to avoid regenerating
507
the revision history.
509
This API is semi-public; it only for use by subclasses, all other code
510
should consider it to be private.
512
self._revision_history_cache = rev_history
514
def _cache_revision_id_to_revno(self, revision_id_to_revno):
515
"""Set the cached revision_id => revno map to revision_id_to_revno.
517
This API is semi-public; it only for use by subclasses, all other code
518
should consider it to be private.
520
self._revision_id_to_revno_cache = revision_id_to_revno
522
def _clear_cached_state(self):
523
"""Clear any cached data on this branch, e.g. cached revision history.
525
This means the next call to revision_history will need to call
526
_gen_revision_history.
528
This API is semi-public; it only for use by subclasses, all other code
529
should consider it to be private.
531
self._revision_history_cache = None
532
self._revision_id_to_revno_cache = None
533
self._last_revision_info_cache = None
534
self._merge_sorted_revisions_cache = None
536
def _gen_revision_history(self):
537
"""Return sequence of revision hashes on to this branch.
539
Unlike revision_history, this method always regenerates or rereads the
540
revision history, i.e. it does not cache the result, so repeated calls
543
Concrete subclasses should override this instead of revision_history so
544
that subclasses do not need to deal with caching logic.
546
This API is semi-public; it only for use by subclasses, all other code
547
should consider it to be private.
549
raise NotImplementedError(self._gen_revision_history)
552
def revision_history(self):
553
"""Return sequence of revision ids on this branch.
555
This method will cache the revision history for as long as it is safe to
558
if 'evil' in debug.debug_flags:
559
mutter_callsite(3, "revision_history scales with history.")
560
if self._revision_history_cache is not None:
561
history = self._revision_history_cache
563
history = self._gen_revision_history()
564
self._cache_revision_history(history)
568
"""Return current revision number for this branch.
570
That is equivalent to the number of revisions committed to
573
return self.last_revision_info()[0]
576
"""Older format branches cannot bind or unbind."""
577
raise errors.UpgradeRequired(self.base)
579
def set_append_revisions_only(self, enabled):
580
"""Older format branches are never restricted to append-only"""
581
raise errors.UpgradeRequired(self.base)
583
def last_revision(self):
584
"""Return last revision id, or NULL_REVISION."""
585
return self.last_revision_info()[1]
588
def last_revision_info(self):
589
"""Return information about the last revision.
591
:return: A tuple (revno, revision_id).
593
if self._last_revision_info_cache is None:
594
self._last_revision_info_cache = self._last_revision_info()
595
return self._last_revision_info_cache
597
def _last_revision_info(self):
598
rh = self.revision_history()
601
return (revno, rh[-1])
603
return (0, _mod_revision.NULL_REVISION)
605
@deprecated_method(deprecated_in((1, 6, 0)))
606
def missing_revisions(self, other, stop_revision=None):
607
"""Return a list of new revisions that would perfectly fit.
609
If self and other have not diverged, return a list of the revisions
610
present in other, but missing from self.
612
self_history = self.revision_history()
613
self_len = len(self_history)
614
other_history = other.revision_history()
615
other_len = len(other_history)
616
common_index = min(self_len, other_len) -1
617
if common_index >= 0 and \
618
self_history[common_index] != other_history[common_index]:
619
raise errors.DivergedBranches(self, other)
621
if stop_revision is None:
622
stop_revision = other_len
624
if stop_revision > other_len:
625
raise errors.NoSuchRevision(self, stop_revision)
626
return other_history[self_len:stop_revision]
629
def update_revisions(self, other, stop_revision=None, overwrite=False,
631
"""Pull in new perfect-fit revisions.
633
:param other: Another Branch to pull from
634
:param stop_revision: Updated until the given revision
635
:param overwrite: Always set the branch pointer, rather than checking
636
to see if it is a proper descendant.
637
:param graph: A Graph object that can be used to query history
638
information. This can be None.
643
other_revno, other_last_revision = other.last_revision_info()
644
stop_revno = None # unknown
645
if stop_revision is None:
646
stop_revision = other_last_revision
647
if _mod_revision.is_null(stop_revision):
648
# if there are no commits, we're done.
650
stop_revno = other_revno
652
# what's the current last revision, before we fetch [and change it
654
last_rev = _mod_revision.ensure_null(self.last_revision())
655
# we fetch here so that we don't process data twice in the common
656
# case of having something to pull, and so that the check for
657
# already merged can operate on the just fetched graph, which will
658
# be cached in memory.
659
self.fetch(other, stop_revision)
660
# Check to see if one is an ancestor of the other
663
graph = self.repository.get_graph()
664
if self._check_if_descendant_or_diverged(
665
stop_revision, last_rev, graph, other):
666
# stop_revision is a descendant of last_rev, but we aren't
667
# overwriting, so we're done.
669
if stop_revno is None:
671
graph = self.repository.get_graph()
672
this_revno, this_last_revision = self.last_revision_info()
673
stop_revno = graph.find_distance_to_null(stop_revision,
674
[(other_last_revision, other_revno),
675
(this_last_revision, this_revno)])
676
self.set_last_revision_info(stop_revno, stop_revision)
680
def revision_id_to_revno(self, revision_id):
681
"""Given a revision id, return its revno"""
682
if _mod_revision.is_null(revision_id):
684
history = self.revision_history()
686
return history.index(revision_id) + 1
688
raise errors.NoSuchRevision(self, revision_id)
690
def get_rev_id(self, revno, history=None):
691
"""Find the revision id of the specified revno."""
693
return _mod_revision.NULL_REVISION
695
history = self.revision_history()
696
if revno <= 0 or revno > len(history):
697
raise errors.NoSuchRevision(self, revno)
698
return history[revno - 1]
700
def pull(self, source, overwrite=False, stop_revision=None,
701
possible_transports=None, _override_hook_target=None):
702
"""Mirror source into this branch.
704
This branch is considered to be 'local', having low latency.
706
:returns: PullResult instance
708
raise NotImplementedError(self.pull)
710
def push(self, target, overwrite=False, stop_revision=None):
711
"""Mirror this branch into target.
713
This branch is considered to be 'local', having low latency.
715
raise NotImplementedError(self.push)
717
def basis_tree(self):
718
"""Return `Tree` object for last revision."""
719
return self.repository.revision_tree(self.last_revision())
721
def get_parent(self):
722
"""Return the parent location of the branch.
724
This is the default location for push/pull/missing. The usual
725
pattern is that the user can override it by specifying a
728
raise NotImplementedError(self.get_parent)
730
def _set_config_location(self, name, url, config=None,
731
make_relative=False):
733
config = self.get_config()
737
url = urlutils.relative_url(self.base, url)
738
config.set_user_option(name, url, warn_masked=True)
740
def _get_config_location(self, name, config=None):
742
config = self.get_config()
743
location = config.get_user_option(name)
748
def get_submit_branch(self):
749
"""Return the submit location of the branch.
751
This is the default location for bundle. The usual
752
pattern is that the user can override it by specifying a
755
return self.get_config().get_user_option('submit_branch')
757
def set_submit_branch(self, location):
758
"""Return the submit location of the branch.
760
This is the default location for bundle. The usual
761
pattern is that the user can override it by specifying a
764
self.get_config().set_user_option('submit_branch', location,
767
def get_public_branch(self):
768
"""Return the public location of the branch.
770
This is is used by merge directives.
772
return self._get_config_location('public_branch')
774
def set_public_branch(self, location):
775
"""Return the submit location of the branch.
777
This is the default location for bundle. The usual
778
pattern is that the user can override it by specifying a
781
self._set_config_location('public_branch', location)
783
def get_push_location(self):
784
"""Return the None or the location to push this branch to."""
785
push_loc = self.get_config().get_user_option('push_location')
788
def set_push_location(self, location):
789
"""Set a new push location for this branch."""
790
raise NotImplementedError(self.set_push_location)
792
def set_parent(self, url):
793
raise NotImplementedError(self.set_parent)
797
"""Synchronise this branch with the master branch if any.
799
:return: None or the last_revision pivoted out during the update.
803
def check_revno(self, revno):
805
Check whether a revno corresponds to any revision.
806
Zero (the NULL revision) is considered valid.
809
self.check_real_revno(revno)
811
def check_real_revno(self, revno):
813
Check whether a revno corresponds to a real revision.
814
Zero (the NULL revision) is considered invalid
816
if revno < 1 or revno > self.revno():
817
raise errors.InvalidRevisionNumber(revno)
820
def clone(self, to_bzrdir, revision_id=None):
821
"""Clone this branch into to_bzrdir preserving all semantic values.
823
revision_id: if not None, the revision history in the new branch will
824
be truncated to end with revision_id.
826
result = to_bzrdir.create_branch()
827
self.copy_content_into(result, revision_id=revision_id)
831
def sprout(self, to_bzrdir, revision_id=None):
832
"""Create a new line of development from the branch, into to_bzrdir.
834
to_bzrdir controls the branch format.
836
revision_id: if not None, the revision history in the new branch will
837
be truncated to end with revision_id.
839
result = to_bzrdir.create_branch()
840
self.copy_content_into(result, revision_id=revision_id)
841
result.set_parent(self.bzrdir.root_transport.base)
844
def _synchronize_history(self, destination, revision_id):
845
"""Synchronize last revision and revision history between branches.
847
This version is most efficient when the destination is also a
848
BzrBranch6, but works for BzrBranch5, as long as the destination's
849
repository contains all the lefthand ancestors of the intended
850
last_revision. If not, set_last_revision_info will fail.
852
:param destination: The branch to copy the history into
853
:param revision_id: The revision-id to truncate history at. May
854
be None to copy complete history.
856
source_revno, source_revision_id = self.last_revision_info()
857
if revision_id is None:
858
revno, revision_id = source_revno, source_revision_id
859
elif source_revision_id == revision_id:
860
# we know the revno without needing to walk all of history
863
# To figure out the revno for a random revision, we need to build
864
# the revision history, and count its length.
865
# We don't care about the order, just how long it is.
866
# Alternatively, we could start at the current location, and count
867
# backwards. But there is no guarantee that we will find it since
868
# it may be a merged revision.
869
revno = len(list(self.repository.iter_reverse_revision_history(
871
destination.set_last_revision_info(revno, revision_id)
874
def copy_content_into(self, destination, revision_id=None):
875
"""Copy the content of self into destination.
877
revision_id: if not None, the revision history in the new branch will
878
be truncated to end with revision_id.
880
self._synchronize_history(destination, revision_id)
882
parent = self.get_parent()
883
except errors.InaccessibleParent, e:
884
mutter('parent was not accessible to copy: %s', e)
887
destination.set_parent(parent)
888
self.tags.merge_to(destination.tags)
892
"""Check consistency of the branch.
894
In particular this checks that revisions given in the revision-history
895
do actually match up in the revision graph, and that they're all
896
present in the repository.
898
Callers will typically also want to check the repository.
900
:return: A BranchCheckResult.
902
mainline_parent_id = None
903
last_revno, last_revision_id = self.last_revision_info()
904
real_rev_history = list(self.repository.iter_reverse_revision_history(
906
real_rev_history.reverse()
907
if len(real_rev_history) != last_revno:
908
raise errors.BzrCheckError('revno does not match len(mainline)'
909
' %s != %s' % (last_revno, len(real_rev_history)))
910
# TODO: We should probably also check that real_rev_history actually
911
# matches self.revision_history()
912
for revision_id in real_rev_history:
914
revision = self.repository.get_revision(revision_id)
915
except errors.NoSuchRevision, e:
916
raise errors.BzrCheckError("mainline revision {%s} not in repository"
918
# In general the first entry on the revision history has no parents.
919
# But it's not illegal for it to have parents listed; this can happen
920
# in imports from Arch when the parents weren't reachable.
921
if mainline_parent_id is not None:
922
if mainline_parent_id not in revision.parent_ids:
923
raise errors.BzrCheckError("previous revision {%s} not listed among "
925
% (mainline_parent_id, revision_id))
926
mainline_parent_id = revision_id
927
return BranchCheckResult(self)
929
def _get_checkout_format(self):
930
"""Return the most suitable metadir for a checkout of this branch.
931
Weaves are used if this branch's repository uses weaves.
933
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
934
from bzrlib.repofmt import weaverepo
935
format = bzrdir.BzrDirMetaFormat1()
936
format.repository_format = weaverepo.RepositoryFormat7()
938
format = self.repository.bzrdir.checkout_metadir()
939
format.set_branch_format(self._format)
942
def create_checkout(self, to_location, revision_id=None,
943
lightweight=False, accelerator_tree=None,
945
"""Create a checkout of a branch.
947
:param to_location: The url to produce the checkout at
948
:param revision_id: The revision to check out
949
:param lightweight: If True, produce a lightweight checkout, otherwise,
950
produce a bound branch (heavyweight checkout)
951
:param accelerator_tree: A tree which can be used for retrieving file
952
contents more quickly than the revision tree, i.e. a workingtree.
953
The revision tree will be used for cases where accelerator_tree's
954
content is different.
955
:param hardlink: If true, hard-link files from accelerator_tree,
957
:return: The tree of the created checkout
959
t = transport.get_transport(to_location)
962
format = self._get_checkout_format()
963
checkout = format.initialize_on_transport(t)
964
from_branch = BranchReferenceFormat().initialize(checkout, self)
966
format = self._get_checkout_format()
967
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
968
to_location, force_new_tree=False, format=format)
969
checkout = checkout_branch.bzrdir
970
checkout_branch.bind(self)
971
# pull up to the specified revision_id to set the initial
972
# branch tip correctly, and seed it with history.
973
checkout_branch.pull(self, stop_revision=revision_id)
975
tree = checkout.create_workingtree(revision_id,
976
from_branch=from_branch,
977
accelerator_tree=accelerator_tree,
979
basis_tree = tree.basis_tree()
980
basis_tree.lock_read()
982
for path, file_id in basis_tree.iter_references():
983
reference_parent = self.reference_parent(file_id, path)
984
reference_parent.create_checkout(tree.abspath(path),
985
basis_tree.get_reference_revision(file_id, path),
992
def reconcile(self, thorough=True):
993
"""Make sure the data stored in this branch is consistent."""
994
from bzrlib.reconcile import BranchReconciler
995
reconciler = BranchReconciler(self, thorough=thorough)
996
reconciler.reconcile()
999
def reference_parent(self, file_id, path):
1000
"""Return the parent branch for a tree-reference file_id
1001
:param file_id: The file_id of the tree reference
1002
:param path: The path of the file_id in the tree
1003
:return: A branch associated with the file_id
1005
# FIXME should provide multiple branches, based on config
1006
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1008
def supports_tags(self):
1009
return self._format.supports_tags()
1011
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1013
"""Ensure that revision_b is a descendant of revision_a.
1015
This is a helper function for update_revisions.
1017
:raises: DivergedBranches if revision_b has diverged from revision_a.
1018
:returns: True if revision_b is a descendant of revision_a.
1020
relation = self._revision_relations(revision_a, revision_b, graph)
1021
if relation == 'b_descends_from_a':
1023
elif relation == 'diverged':
1024
raise errors.DivergedBranches(self, other_branch)
1025
elif relation == 'a_descends_from_b':
1028
raise AssertionError("invalid relation: %r" % (relation,))
1030
def _revision_relations(self, revision_a, revision_b, graph):
1031
"""Determine the relationship between two revisions.
1033
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1035
heads = graph.heads([revision_a, revision_b])
1036
if heads == set([revision_b]):
1037
return 'b_descends_from_a'
1038
elif heads == set([revision_a, revision_b]):
1039
# These branches have diverged
1041
elif heads == set([revision_a]):
1042
return 'a_descends_from_b'
1044
raise AssertionError("invalid heads: %r" % (heads,))
1047
class BranchFormat(object):
1048
"""An encapsulation of the initialization and open routines for a format.
1050
Formats provide three things:
1051
* An initialization routine,
1055
Formats are placed in an dict by their format string for reference
1056
during branch opening. Its not required that these be instances, they
1057
can be classes themselves with class methods - it simply depends on
1058
whether state is needed for a given format or not.
1060
Once a format is deprecated, just deprecate the initialize and open
1061
methods on the format class. Do not deprecate the object, as the
1062
object will be created every time regardless.
1065
_default_format = None
1066
"""The default format used for new branches."""
1069
"""The known formats."""
1071
def __eq__(self, other):
1072
return self.__class__ is other.__class__
1074
def __ne__(self, other):
1075
return not (self == other)
1078
def find_format(klass, a_bzrdir):
1079
"""Return the format for the branch object in a_bzrdir."""
1081
transport = a_bzrdir.get_branch_transport(None)
1082
format_string = transport.get("format").read()
1083
return klass._formats[format_string]
1084
except errors.NoSuchFile:
1085
raise errors.NotBranchError(path=transport.base)
1087
raise errors.UnknownFormatError(format=format_string, kind='branch')
1090
def get_default_format(klass):
1091
"""Return the current default format."""
1092
return klass._default_format
1094
def get_reference(self, a_bzrdir):
1095
"""Get the target reference of the branch in a_bzrdir.
1097
format probing must have been completed before calling
1098
this method - it is assumed that the format of the branch
1099
in a_bzrdir is correct.
1101
:param a_bzrdir: The bzrdir to get the branch data from.
1102
:return: None if the branch is not a reference branch.
1107
def set_reference(self, a_bzrdir, to_branch):
1108
"""Set the target reference of the branch in a_bzrdir.
1110
format probing must have been completed before calling
1111
this method - it is assumed that the format of the branch
1112
in a_bzrdir is correct.
1114
:param a_bzrdir: The bzrdir to set the branch reference for.
1115
:param to_branch: branch that the checkout is to reference
1117
raise NotImplementedError(self.set_reference)
1119
def get_format_string(self):
1120
"""Return the ASCII format string that identifies this format."""
1121
raise NotImplementedError(self.get_format_string)
1123
def get_format_description(self):
1124
"""Return the short format description for this format."""
1125
raise NotImplementedError(self.get_format_description)
1127
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1129
"""Initialize a branch in a bzrdir, with specified files
1131
:param a_bzrdir: The bzrdir to initialize the branch in
1132
:param utf8_files: The files to create as a list of
1133
(filename, content) tuples
1134
:param set_format: If True, set the format with
1135
self.get_format_string. (BzrBranch4 has its format set
1137
:return: a branch in this format
1139
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1140
branch_transport = a_bzrdir.get_branch_transport(self)
1142
'metadir': ('lock', lockdir.LockDir),
1143
'branch4': ('branch-lock', lockable_files.TransportLock),
1145
lock_name, lock_class = lock_map[lock_type]
1146
control_files = lockable_files.LockableFiles(branch_transport,
1147
lock_name, lock_class)
1148
control_files.create_lock()
1149
control_files.lock_write()
1151
utf8_files += [('format', self.get_format_string())]
1153
for (filename, content) in utf8_files:
1154
branch_transport.put_bytes(
1156
mode=a_bzrdir._get_file_mode())
1158
control_files.unlock()
1159
return self.open(a_bzrdir, _found=True)
1161
def initialize(self, a_bzrdir):
1162
"""Create a branch of this format in a_bzrdir."""
1163
raise NotImplementedError(self.initialize)
1165
def is_supported(self):
1166
"""Is this format supported?
1168
Supported formats can be initialized and opened.
1169
Unsupported formats may not support initialization or committing or
1170
some other features depending on the reason for not being supported.
1174
def open(self, a_bzrdir, _found=False):
1175
"""Return the branch object for a_bzrdir
1177
_found is a private parameter, do not use it. It is used to indicate
1178
if format probing has already be done.
1180
raise NotImplementedError(self.open)
1183
def register_format(klass, format):
1184
klass._formats[format.get_format_string()] = format
1187
def set_default_format(klass, format):
1188
klass._default_format = format
1190
def supports_stacking(self):
1191
"""True if this format records a stacked-on branch."""
1195
def unregister_format(klass, format):
1196
del klass._formats[format.get_format_string()]
1199
return self.get_format_string().rstrip()
1201
def supports_tags(self):
1202
"""True if this format supports tags stored in the branch"""
1203
return False # by default
1206
class BranchHooks(Hooks):
1207
"""A dictionary mapping hook name to a list of callables for branch hooks.
1209
e.g. ['set_rh'] Is the list of items to be called when the
1210
set_revision_history function is invoked.
1214
"""Create the default hooks.
1216
These are all empty initially, because by default nothing should get
1219
Hooks.__init__(self)
1220
# Introduced in 0.15:
1221
# invoked whenever the revision history has been set
1222
# with set_revision_history. The api signature is
1223
# (branch, revision_history), and the branch will
1226
# Invoked after a branch is opened. The api signature is (branch).
1228
# invoked after a push operation completes.
1229
# the api signature is
1231
# containing the members
1232
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1233
# where local is the local target branch or None, master is the target
1234
# master branch, and the rest should be self explanatory. The source
1235
# is read locked and the target branches write locked. Source will
1236
# be the local low-latency branch.
1237
self['post_push'] = []
1238
# invoked after a pull operation completes.
1239
# the api signature is
1241
# containing the members
1242
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1243
# where local is the local branch or None, master is the target
1244
# master branch, and the rest should be self explanatory. The source
1245
# is read locked and the target branches write locked. The local
1246
# branch is the low-latency branch.
1247
self['post_pull'] = []
1248
# invoked before a commit operation takes place.
1249
# the api signature is
1250
# (local, master, old_revno, old_revid, future_revno, future_revid,
1251
# tree_delta, future_tree).
1252
# old_revid is NULL_REVISION for the first commit to a branch
1253
# tree_delta is a TreeDelta object describing changes from the basis
1254
# revision, hooks MUST NOT modify this delta
1255
# future_tree is an in-memory tree obtained from
1256
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1257
self['pre_commit'] = []
1258
# invoked after a commit operation completes.
1259
# the api signature is
1260
# (local, master, old_revno, old_revid, new_revno, new_revid)
1261
# old_revid is NULL_REVISION for the first commit to a branch.
1262
self['post_commit'] = []
1263
# invoked after a uncommit operation completes.
1264
# the api signature is
1265
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1266
# local is the local branch or None, master is the target branch,
1267
# and an empty branch recieves new_revno of 0, new_revid of None.
1268
self['post_uncommit'] = []
1270
# Invoked before the tip of a branch changes.
1271
# the api signature is
1272
# (params) where params is a ChangeBranchTipParams with the members
1273
# (branch, old_revno, new_revno, old_revid, new_revid)
1274
self['pre_change_branch_tip'] = []
1276
# Invoked after the tip of a branch changes.
1277
# the api signature is
1278
# (params) where params is a ChangeBranchTipParams with the members
1279
# (branch, old_revno, new_revno, old_revid, new_revid)
1280
self['post_change_branch_tip'] = []
1282
# Invoked when a stacked branch activates its fallback locations and
1283
# allows the transformation of the url of said location.
1284
# the api signature is
1285
# (branch, url) where branch is the branch having its fallback
1286
# location activated and url is the url for the fallback location.
1287
# The hook should return a url.
1288
self['transform_fallback_location'] = []
1291
# install the default hooks into the Branch class.
1292
Branch.hooks = BranchHooks()
1295
class ChangeBranchTipParams(object):
1296
"""Object holding parameters passed to *_change_branch_tip hooks.
1298
There are 5 fields that hooks may wish to access:
1300
:ivar branch: the branch being changed
1301
:ivar old_revno: revision number before the change
1302
:ivar new_revno: revision number after the change
1303
:ivar old_revid: revision id before the change
1304
:ivar new_revid: revision id after the change
1306
The revid fields are strings. The revno fields are integers.
1309
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1310
"""Create a group of ChangeBranchTip parameters.
1312
:param branch: The branch being changed.
1313
:param old_revno: Revision number before the change.
1314
:param new_revno: Revision number after the change.
1315
:param old_revid: Tip revision id before the change.
1316
:param new_revid: Tip revision id after the change.
1318
self.branch = branch
1319
self.old_revno = old_revno
1320
self.new_revno = new_revno
1321
self.old_revid = old_revid
1322
self.new_revid = new_revid
1324
def __eq__(self, other):
1325
return self.__dict__ == other.__dict__
1328
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1329
self.__class__.__name__, self.branch,
1330
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1333
class BzrBranchFormat4(BranchFormat):
1334
"""Bzr branch format 4.
1337
- a revision-history file.
1338
- a branch-lock lock file [ to be shared with the bzrdir ]
1341
def get_format_description(self):
1342
"""See BranchFormat.get_format_description()."""
1343
return "Branch format 4"
1345
def initialize(self, a_bzrdir):
1346
"""Create a branch of this format in a_bzrdir."""
1347
utf8_files = [('revision-history', ''),
1348
('branch-name', ''),
1350
return self._initialize_helper(a_bzrdir, utf8_files,
1351
lock_type='branch4', set_format=False)
1354
super(BzrBranchFormat4, self).__init__()
1355
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1357
def open(self, a_bzrdir, _found=False):
1358
"""Return the branch object for a_bzrdir
1360
_found is a private parameter, do not use it. It is used to indicate
1361
if format probing has already be done.
1364
# we are being called directly and must probe.
1365
raise NotImplementedError
1366
return BzrBranch(_format=self,
1367
_control_files=a_bzrdir._control_files,
1369
_repository=a_bzrdir.open_repository())
1372
return "Bazaar-NG branch format 4"
1375
class BranchFormatMetadir(BranchFormat):
1376
"""Common logic for meta-dir based branch formats."""
1378
def _branch_class(self):
1379
"""What class to instantiate on open calls."""
1380
raise NotImplementedError(self._branch_class)
1382
def open(self, a_bzrdir, _found=False):
1383
"""Return the branch object for a_bzrdir.
1385
_found is a private parameter, do not use it. It is used to indicate
1386
if format probing has already be done.
1389
format = BranchFormat.find_format(a_bzrdir)
1390
if format.__class__ != self.__class__:
1391
raise AssertionError("wrong format %r found for %r" %
1394
transport = a_bzrdir.get_branch_transport(None)
1395
control_files = lockable_files.LockableFiles(transport, 'lock',
1397
return self._branch_class()(_format=self,
1398
_control_files=control_files,
1400
_repository=a_bzrdir.find_repository())
1401
except errors.NoSuchFile:
1402
raise errors.NotBranchError(path=transport.base)
1405
super(BranchFormatMetadir, self).__init__()
1406
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1407
self._matchingbzrdir.set_branch_format(self)
1409
def supports_tags(self):
1413
class BzrBranchFormat5(BranchFormatMetadir):
1414
"""Bzr branch format 5.
1417
- a revision-history file.
1419
- a lock dir guarding the branch itself
1420
- all of this stored in a branch/ subdirectory
1421
- works with shared repositories.
1423
This format is new in bzr 0.8.
1426
def _branch_class(self):
1429
def get_format_string(self):
1430
"""See BranchFormat.get_format_string()."""
1431
return "Bazaar-NG branch format 5\n"
1433
def get_format_description(self):
1434
"""See BranchFormat.get_format_description()."""
1435
return "Branch format 5"
1437
def initialize(self, a_bzrdir):
1438
"""Create a branch of this format in a_bzrdir."""
1439
utf8_files = [('revision-history', ''),
1440
('branch-name', ''),
1442
return self._initialize_helper(a_bzrdir, utf8_files)
1444
def supports_tags(self):
1448
class BzrBranchFormat6(BranchFormatMetadir):
1449
"""Branch format with last-revision and tags.
1451
Unlike previous formats, this has no explicit revision history. Instead,
1452
this just stores the last-revision, and the left-hand history leading
1453
up to there is the history.
1455
This format was introduced in bzr 0.15
1456
and became the default in 0.91.
1459
def _branch_class(self):
1462
def get_format_string(self):
1463
"""See BranchFormat.get_format_string()."""
1464
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1466
def get_format_description(self):
1467
"""See BranchFormat.get_format_description()."""
1468
return "Branch format 6"
1470
def initialize(self, a_bzrdir):
1471
"""Create a branch of this format in a_bzrdir."""
1472
utf8_files = [('last-revision', '0 null:\n'),
1473
('branch.conf', ''),
1476
return self._initialize_helper(a_bzrdir, utf8_files)
1479
class BzrBranchFormat7(BranchFormatMetadir):
1480
"""Branch format with last-revision, tags, and a stacked location pointer.
1482
The stacked location pointer is passed down to the repository and requires
1483
a repository format with supports_external_lookups = True.
1485
This format was introduced in bzr 1.6.
1488
def _branch_class(self):
1491
def get_format_string(self):
1492
"""See BranchFormat.get_format_string()."""
1493
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1495
def get_format_description(self):
1496
"""See BranchFormat.get_format_description()."""
1497
return "Branch format 7"
1499
def initialize(self, a_bzrdir):
1500
"""Create a branch of this format in a_bzrdir."""
1501
utf8_files = [('last-revision', '0 null:\n'),
1502
('branch.conf', ''),
1505
return self._initialize_helper(a_bzrdir, utf8_files)
1508
super(BzrBranchFormat7, self).__init__()
1509
self._matchingbzrdir.repository_format = \
1510
RepositoryFormatKnitPack5RichRoot()
1512
def supports_stacking(self):
1516
class BranchReferenceFormat(BranchFormat):
1517
"""Bzr branch reference format.
1519
Branch references are used in implementing checkouts, they
1520
act as an alias to the real branch which is at some other url.
1527
def get_format_string(self):
1528
"""See BranchFormat.get_format_string()."""
1529
return "Bazaar-NG Branch Reference Format 1\n"
1531
def get_format_description(self):
1532
"""See BranchFormat.get_format_description()."""
1533
return "Checkout reference format 1"
1535
def get_reference(self, a_bzrdir):
1536
"""See BranchFormat.get_reference()."""
1537
transport = a_bzrdir.get_branch_transport(None)
1538
return transport.get('location').read()
1540
def set_reference(self, a_bzrdir, to_branch):
1541
"""See BranchFormat.set_reference()."""
1542
transport = a_bzrdir.get_branch_transport(None)
1543
location = transport.put_bytes('location', to_branch.base)
1545
def initialize(self, a_bzrdir, target_branch=None):
1546
"""Create a branch of this format in a_bzrdir."""
1547
if target_branch is None:
1548
# this format does not implement branch itself, thus the implicit
1549
# creation contract must see it as uninitializable
1550
raise errors.UninitializableFormat(self)
1551
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1552
branch_transport = a_bzrdir.get_branch_transport(self)
1553
branch_transport.put_bytes('location',
1554
target_branch.bzrdir.root_transport.base)
1555
branch_transport.put_bytes('format', self.get_format_string())
1557
a_bzrdir, _found=True,
1558
possible_transports=[target_branch.bzrdir.root_transport])
1561
super(BranchReferenceFormat, self).__init__()
1562
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1563
self._matchingbzrdir.set_branch_format(self)
1565
def _make_reference_clone_function(format, a_branch):
1566
"""Create a clone() routine for a branch dynamically."""
1567
def clone(to_bzrdir, revision_id=None):
1568
"""See Branch.clone()."""
1569
return format.initialize(to_bzrdir, a_branch)
1570
# cannot obey revision_id limits when cloning a reference ...
1571
# FIXME RBC 20060210 either nuke revision_id for clone, or
1572
# emit some sort of warning/error to the caller ?!
1575
def open(self, a_bzrdir, _found=False, location=None,
1576
possible_transports=None):
1577
"""Return the branch that the branch reference in a_bzrdir points at.
1579
_found is a private parameter, do not use it. It is used to indicate
1580
if format probing has already be done.
1583
format = BranchFormat.find_format(a_bzrdir)
1584
if format.__class__ != self.__class__:
1585
raise AssertionError("wrong format %r found for %r" %
1587
if location is None:
1588
location = self.get_reference(a_bzrdir)
1589
real_bzrdir = bzrdir.BzrDir.open(
1590
location, possible_transports=possible_transports)
1591
result = real_bzrdir.open_branch()
1592
# this changes the behaviour of result.clone to create a new reference
1593
# rather than a copy of the content of the branch.
1594
# I did not use a proxy object because that needs much more extensive
1595
# testing, and we are only changing one behaviour at the moment.
1596
# If we decide to alter more behaviours - i.e. the implicit nickname
1597
# then this should be refactored to introduce a tested proxy branch
1598
# and a subclass of that for use in overriding clone() and ....
1600
result.clone = self._make_reference_clone_function(result)
1604
# formats which have no format string are not discoverable
1605
# and not independently creatable, so are not registered.
1606
__format5 = BzrBranchFormat5()
1607
__format6 = BzrBranchFormat6()
1608
__format7 = BzrBranchFormat7()
1609
BranchFormat.register_format(__format5)
1610
BranchFormat.register_format(BranchReferenceFormat())
1611
BranchFormat.register_format(__format6)
1612
BranchFormat.register_format(__format7)
1613
BranchFormat.set_default_format(__format6)
1614
_legacy_formats = [BzrBranchFormat4(),
1617
class BzrBranch(Branch):
1618
"""A branch stored in the actual filesystem.
1620
Note that it's "local" in the context of the filesystem; it doesn't
1621
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1622
it's writable, and can be accessed via the normal filesystem API.
1624
:ivar _transport: Transport for file operations on this branch's
1625
control files, typically pointing to the .bzr/branch directory.
1626
:ivar repository: Repository for this branch.
1627
:ivar base: The url of the base directory for this branch; the one
1628
containing the .bzr directory.
1631
def __init__(self, _format=None,
1632
_control_files=None, a_bzrdir=None, _repository=None):
1633
"""Create new branch object at a particular location."""
1634
if a_bzrdir is None:
1635
raise ValueError('a_bzrdir must be supplied')
1637
self.bzrdir = a_bzrdir
1638
self._base = self.bzrdir.transport.clone('..').base
1639
# XXX: We should be able to just do
1640
# self.base = self.bzrdir.root_transport.base
1641
# but this does not quite work yet -- mbp 20080522
1642
self._format = _format
1643
if _control_files is None:
1644
raise ValueError('BzrBranch _control_files is None')
1645
self.control_files = _control_files
1646
self._transport = _control_files._transport
1647
self.repository = _repository
1648
Branch.__init__(self)
1651
return '%s(%r)' % (self.__class__.__name__, self.base)
1655
def _get_base(self):
1656
"""Returns the directory containing the control directory."""
1659
base = property(_get_base, doc="The URL for the root of this branch.")
1661
def is_locked(self):
1662
return self.control_files.is_locked()
1664
def lock_write(self, token=None):
1665
repo_token = self.repository.lock_write()
1667
token = self.control_files.lock_write(token=token)
1669
self.repository.unlock()
1673
def lock_read(self):
1674
self.repository.lock_read()
1676
self.control_files.lock_read()
1678
self.repository.unlock()
1682
# TODO: test for failed two phase locks. This is known broken.
1684
self.control_files.unlock()
1686
self.repository.unlock()
1687
if not self.control_files.is_locked():
1688
# we just released the lock
1689
self._clear_cached_state()
1691
def peek_lock_mode(self):
1692
if self.control_files._lock_count == 0:
1695
return self.control_files._lock_mode
1697
def get_physical_lock_status(self):
1698
return self.control_files.get_physical_lock_status()
1701
def print_file(self, file, revision_id):
1702
"""See Branch.print_file."""
1703
return self.repository.print_file(file, revision_id)
1705
def _write_revision_history(self, history):
1706
"""Factored out of set_revision_history.
1708
This performs the actual writing to disk.
1709
It is intended to be called by BzrBranch5.set_revision_history."""
1710
self._transport.put_bytes(
1711
'revision-history', '\n'.join(history),
1712
mode=self.bzrdir._get_file_mode())
1715
def set_revision_history(self, rev_history):
1716
"""See Branch.set_revision_history."""
1717
if 'evil' in debug.debug_flags:
1718
mutter_callsite(3, "set_revision_history scales with history.")
1719
check_not_reserved_id = _mod_revision.check_not_reserved_id
1720
for rev_id in rev_history:
1721
check_not_reserved_id(rev_id)
1722
if Branch.hooks['post_change_branch_tip']:
1723
# Don't calculate the last_revision_info() if there are no hooks
1725
old_revno, old_revid = self.last_revision_info()
1726
if len(rev_history) == 0:
1727
revid = _mod_revision.NULL_REVISION
1729
revid = rev_history[-1]
1730
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1731
self._write_revision_history(rev_history)
1732
self._clear_cached_state()
1733
self._cache_revision_history(rev_history)
1734
for hook in Branch.hooks['set_rh']:
1735
hook(self, rev_history)
1736
if Branch.hooks['post_change_branch_tip']:
1737
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1739
def _synchronize_history(self, destination, revision_id):
1740
"""Synchronize last revision and revision history between branches.
1742
This version is most efficient when the destination is also a
1743
BzrBranch5, but works for BzrBranch6 as long as the revision
1744
history is the true lefthand parent history, and all of the revisions
1745
are in the destination's repository. If not, set_revision_history
1748
:param destination: The branch to copy the history into
1749
:param revision_id: The revision-id to truncate history at. May
1750
be None to copy complete history.
1752
if not isinstance(destination._format, BzrBranchFormat5):
1753
super(BzrBranch, self)._synchronize_history(
1754
destination, revision_id)
1756
if revision_id == _mod_revision.NULL_REVISION:
1759
new_history = self.revision_history()
1760
if revision_id is not None and new_history != []:
1762
new_history = new_history[:new_history.index(revision_id) + 1]
1764
rev = self.repository.get_revision(revision_id)
1765
new_history = rev.get_history(self.repository)[1:]
1766
destination.set_revision_history(new_history)
1768
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1769
"""Run the pre_change_branch_tip hooks."""
1770
hooks = Branch.hooks['pre_change_branch_tip']
1773
old_revno, old_revid = self.last_revision_info()
1774
params = ChangeBranchTipParams(
1775
self, old_revno, new_revno, old_revid, new_revid)
1779
except errors.TipChangeRejected:
1782
exc_info = sys.exc_info()
1783
hook_name = Branch.hooks.get_hook_name(hook)
1784
raise errors.HookFailed(
1785
'pre_change_branch_tip', hook_name, exc_info)
1787
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1788
"""Run the post_change_branch_tip hooks."""
1789
hooks = Branch.hooks['post_change_branch_tip']
1792
new_revno, new_revid = self.last_revision_info()
1793
params = ChangeBranchTipParams(
1794
self, old_revno, new_revno, old_revid, new_revid)
1799
def set_last_revision_info(self, revno, revision_id):
1800
"""Set the last revision of this branch.
1802
The caller is responsible for checking that the revno is correct
1803
for this revision id.
1805
It may be possible to set the branch last revision to an id not
1806
present in the repository. However, branches can also be
1807
configured to check constraints on history, in which case this may not
1810
revision_id = _mod_revision.ensure_null(revision_id)
1811
# this old format stores the full history, but this api doesn't
1812
# provide it, so we must generate, and might as well check it's
1814
history = self._lefthand_history(revision_id)
1815
if len(history) != revno:
1816
raise AssertionError('%d != %d' % (len(history), revno))
1817
self.set_revision_history(history)
1819
def _gen_revision_history(self):
1820
history = self._transport.get_bytes('revision-history').split('\n')
1821
if history[-1:] == ['']:
1822
# There shouldn't be a trailing newline, but just in case.
1826
def _lefthand_history(self, revision_id, last_rev=None,
1828
if 'evil' in debug.debug_flags:
1829
mutter_callsite(4, "_lefthand_history scales with history.")
1830
# stop_revision must be a descendant of last_revision
1831
graph = self.repository.get_graph()
1832
if last_rev is not None:
1833
if not graph.is_ancestor(last_rev, revision_id):
1834
# our previous tip is not merged into stop_revision
1835
raise errors.DivergedBranches(self, other_branch)
1836
# make a new revision history from the graph
1837
parents_map = graph.get_parent_map([revision_id])
1838
if revision_id not in parents_map:
1839
raise errors.NoSuchRevision(self, revision_id)
1840
current_rev_id = revision_id
1842
check_not_reserved_id = _mod_revision.check_not_reserved_id
1843
# Do not include ghosts or graph origin in revision_history
1844
while (current_rev_id in parents_map and
1845
len(parents_map[current_rev_id]) > 0):
1846
check_not_reserved_id(current_rev_id)
1847
new_history.append(current_rev_id)
1848
current_rev_id = parents_map[current_rev_id][0]
1849
parents_map = graph.get_parent_map([current_rev_id])
1850
new_history.reverse()
1854
def generate_revision_history(self, revision_id, last_rev=None,
1856
"""Create a new revision history that will finish with revision_id.
1858
:param revision_id: the new tip to use.
1859
:param last_rev: The previous last_revision. If not None, then this
1860
must be a ancestory of revision_id, or DivergedBranches is raised.
1861
:param other_branch: The other branch that DivergedBranches should
1862
raise with respect to.
1864
self.set_revision_history(self._lefthand_history(revision_id,
1865
last_rev, other_branch))
1867
def basis_tree(self):
1868
"""See Branch.basis_tree."""
1869
return self.repository.revision_tree(self.last_revision())
1872
def pull(self, source, overwrite=False, stop_revision=None,
1873
_hook_master=None, run_hooks=True, possible_transports=None,
1874
_override_hook_target=None):
1877
:param _hook_master: Private parameter - set the branch to
1878
be supplied as the master to pull hooks.
1879
:param run_hooks: Private parameter - if false, this branch
1880
is being called because it's the master of the primary branch,
1881
so it should not run its hooks.
1882
:param _override_hook_target: Private parameter - set the branch to be
1883
supplied as the target_branch to pull hooks.
1885
result = PullResult()
1886
result.source_branch = source
1887
if _override_hook_target is None:
1888
result.target_branch = self
1890
result.target_branch = _override_hook_target
1893
# We assume that during 'pull' the local repository is closer than
1895
graph = self.repository.get_graph(source.repository)
1896
result.old_revno, result.old_revid = self.last_revision_info()
1897
self.update_revisions(source, stop_revision, overwrite=overwrite,
1899
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1900
result.new_revno, result.new_revid = self.last_revision_info()
1902
result.master_branch = _hook_master
1903
result.local_branch = result.target_branch
1905
result.master_branch = result.target_branch
1906
result.local_branch = None
1908
for hook in Branch.hooks['post_pull']:
1914
def _get_parent_location(self):
1915
_locs = ['parent', 'pull', 'x-pull']
1918
return self._transport.get_bytes(l).strip('\n')
1919
except errors.NoSuchFile:
1924
def push(self, target, overwrite=False, stop_revision=None,
1925
_override_hook_source_branch=None):
1928
This is the basic concrete implementation of push()
1930
:param _override_hook_source_branch: If specified, run
1931
the hooks passing this Branch as the source, rather than self.
1932
This is for use of RemoteBranch, where push is delegated to the
1933
underlying vfs-based Branch.
1935
# TODO: Public option to disable running hooks - should be trivial but
1937
return _run_with_write_locked_target(
1938
target, self._push_with_bound_branches, target, overwrite,
1940
_override_hook_source_branch=_override_hook_source_branch)
1942
def _push_with_bound_branches(self, target, overwrite,
1944
_override_hook_source_branch=None):
1945
"""Push from self into target, and into target's master if any.
1947
This is on the base BzrBranch class even though it doesn't support
1948
bound branches because the *target* might be bound.
1951
if _override_hook_source_branch:
1952
result.source_branch = _override_hook_source_branch
1953
for hook in Branch.hooks['post_push']:
1956
bound_location = target.get_bound_location()
1957
if bound_location and target.base != bound_location:
1958
# there is a master branch.
1960
# XXX: Why the second check? Is it even supported for a branch to
1961
# be bound to itself? -- mbp 20070507
1962
master_branch = target.get_master_branch()
1963
master_branch.lock_write()
1965
# push into the master from this branch.
1966
self._basic_push(master_branch, overwrite, stop_revision)
1967
# and push into the target branch from this. Note that we push from
1968
# this branch again, because its considered the highest bandwidth
1970
result = self._basic_push(target, overwrite, stop_revision)
1971
result.master_branch = master_branch
1972
result.local_branch = target
1976
master_branch.unlock()
1979
result = self._basic_push(target, overwrite, stop_revision)
1980
# TODO: Why set master_branch and local_branch if there's no
1981
# binding? Maybe cleaner to just leave them unset? -- mbp
1983
result.master_branch = target
1984
result.local_branch = None
1988
def _basic_push(self, target, overwrite, stop_revision):
1989
"""Basic implementation of push without bound branches or hooks.
1991
Must be called with self read locked and target write locked.
1993
result = PushResult()
1994
result.source_branch = self
1995
result.target_branch = target
1996
result.old_revno, result.old_revid = target.last_revision_info()
1997
if result.old_revid != self.last_revision():
1998
# We assume that during 'push' this repository is closer than
2000
graph = self.repository.get_graph(target.repository)
2001
target.update_revisions(self, stop_revision, overwrite=overwrite,
2003
if self._push_should_merge_tags():
2004
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2005
result.new_revno, result.new_revid = target.last_revision_info()
2008
def _push_should_merge_tags(self):
2009
"""Should _basic_push merge this branch's tags into the target?
2011
The default implementation returns False if this branch has no tags,
2012
and True the rest of the time. Subclasses may override this.
2014
return self.tags.supports_tags() and self.tags.get_tag_dict()
2016
def get_parent(self):
2017
"""See Branch.get_parent."""
2018
parent = self._get_parent_location()
2021
# This is an old-format absolute path to a local branch
2022
# turn it into a url
2023
if parent.startswith('/'):
2024
parent = urlutils.local_path_to_url(parent.decode('utf8'))
2026
return urlutils.join(self.base[:-1], parent)
2027
except errors.InvalidURLJoin, e:
2028
raise errors.InaccessibleParent(parent, self.base)
2030
def get_stacked_on_url(self):
2031
raise errors.UnstackableBranchFormat(self._format, self.base)
2033
def set_push_location(self, location):
2034
"""See Branch.set_push_location."""
2035
self.get_config().set_user_option(
2036
'push_location', location,
2037
store=_mod_config.STORE_LOCATION_NORECURSE)
2040
def set_parent(self, url):
2041
"""See Branch.set_parent."""
2042
# TODO: Maybe delete old location files?
2043
# URLs should never be unicode, even on the local fs,
2044
# FIXUP this and get_parent in a future branch format bump:
2045
# read and rewrite the file. RBC 20060125
2047
if isinstance(url, unicode):
2049
url = url.encode('ascii')
2050
except UnicodeEncodeError:
2051
raise errors.InvalidURL(url,
2052
"Urls must be 7-bit ascii, "
2053
"use bzrlib.urlutils.escape")
2054
url = urlutils.relative_url(self.base, url)
2055
self._set_parent_location(url)
2057
def _set_parent_location(self, url):
2059
self._transport.delete('parent')
2061
self._transport.put_bytes('parent', url + '\n',
2062
mode=self.bzrdir._get_file_mode())
2064
def set_stacked_on_url(self, url):
2065
raise errors.UnstackableBranchFormat(self._format, self.base)
2068
class BzrBranch5(BzrBranch):
2069
"""A format 5 branch. This supports new features over plain branches.
2071
It has support for a master_branch which is the data for bound branches.
2075
def pull(self, source, overwrite=False, stop_revision=None,
2076
run_hooks=True, possible_transports=None,
2077
_override_hook_target=None):
2078
"""Pull from source into self, updating my master if any.
2080
:param run_hooks: Private parameter - if false, this branch
2081
is being called because it's the master of the primary branch,
2082
so it should not run its hooks.
2084
bound_location = self.get_bound_location()
2085
master_branch = None
2086
if bound_location and source.base != bound_location:
2087
# not pulling from master, so we need to update master.
2088
master_branch = self.get_master_branch(possible_transports)
2089
master_branch.lock_write()
2092
# pull from source into master.
2093
master_branch.pull(source, overwrite, stop_revision,
2095
return super(BzrBranch5, self).pull(source, overwrite,
2096
stop_revision, _hook_master=master_branch,
2097
run_hooks=run_hooks,
2098
_override_hook_target=_override_hook_target)
2101
master_branch.unlock()
2103
def get_bound_location(self):
2105
return self._transport.get_bytes('bound')[:-1]
2106
except errors.NoSuchFile:
2110
def get_master_branch(self, possible_transports=None):
2111
"""Return the branch we are bound to.
2113
:return: Either a Branch, or None
2115
This could memoise the branch, but if thats done
2116
it must be revalidated on each new lock.
2117
So for now we just don't memoise it.
2118
# RBC 20060304 review this decision.
2120
bound_loc = self.get_bound_location()
2124
return Branch.open(bound_loc,
2125
possible_transports=possible_transports)
2126
except (errors.NotBranchError, errors.ConnectionError), e:
2127
raise errors.BoundBranchConnectionFailure(
2131
def set_bound_location(self, location):
2132
"""Set the target where this branch is bound to.
2134
:param location: URL to the target branch
2137
self._transport.put_bytes('bound', location+'\n',
2138
mode=self.bzrdir._get_file_mode())
2141
self._transport.delete('bound')
2142
except errors.NoSuchFile:
2147
def bind(self, other):
2148
"""Bind this branch to the branch other.
2150
This does not push or pull data between the branches, though it does
2151
check for divergence to raise an error when the branches are not
2152
either the same, or one a prefix of the other. That behaviour may not
2153
be useful, so that check may be removed in future.
2155
:param other: The branch to bind to
2158
# TODO: jam 20051230 Consider checking if the target is bound
2159
# It is debatable whether you should be able to bind to
2160
# a branch which is itself bound.
2161
# Committing is obviously forbidden,
2162
# but binding itself may not be.
2163
# Since we *have* to check at commit time, we don't
2164
# *need* to check here
2166
# we want to raise diverged if:
2167
# last_rev is not in the other_last_rev history, AND
2168
# other_last_rev is not in our history, and do it without pulling
2170
self.set_bound_location(other.base)
2174
"""If bound, unbind"""
2175
return self.set_bound_location(None)
2178
def update(self, possible_transports=None):
2179
"""Synchronise this branch with the master branch if any.
2181
:return: None or the last_revision that was pivoted out during the
2184
master = self.get_master_branch(possible_transports)
2185
if master is not None:
2186
old_tip = _mod_revision.ensure_null(self.last_revision())
2187
self.pull(master, overwrite=True)
2188
if self.repository.get_graph().is_ancestor(old_tip,
2189
_mod_revision.ensure_null(self.last_revision())):
2195
class BzrBranch7(BzrBranch5):
2196
"""A branch with support for a fallback repository."""
2198
def _get_fallback_repository(self, url):
2199
"""Get the repository we fallback to at url."""
2200
url = urlutils.join(self.base, url)
2201
a_bzrdir = bzrdir.BzrDir.open(url,
2202
possible_transports=[self._transport])
2203
return a_bzrdir.open_branch().repository
2205
def _activate_fallback_location(self, url):
2206
"""Activate the branch/repository from url as a fallback repository."""
2207
self.repository.add_fallback_repository(
2208
self._get_fallback_repository(url))
2210
def _open_hook(self):
2212
url = self.get_stacked_on_url()
2213
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2214
errors.UnstackableBranchFormat):
2217
for hook in Branch.hooks['transform_fallback_location']:
2218
url = hook(self, url)
2220
hook_name = Branch.hooks.get_hook_name(hook)
2221
raise AssertionError(
2222
"'transform_fallback_location' hook %s returned "
2223
"None, not a URL." % hook_name)
2224
self._activate_fallback_location(url)
2226
def _check_stackable_repo(self):
2227
if not self.repository._format.supports_external_lookups:
2228
raise errors.UnstackableRepositoryFormat(self.repository._format,
2229
self.repository.base)
2231
def __init__(self, *args, **kwargs):
2232
super(BzrBranch7, self).__init__(*args, **kwargs)
2233
self._last_revision_info_cache = None
2234
self._partial_revision_history_cache = []
2236
def _clear_cached_state(self):
2237
super(BzrBranch7, self)._clear_cached_state()
2238
self._last_revision_info_cache = None
2239
self._partial_revision_history_cache = []
2241
def _last_revision_info(self):
2242
revision_string = self._transport.get_bytes('last-revision')
2243
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2244
revision_id = cache_utf8.get_cached_utf8(revision_id)
2246
return revno, revision_id
2248
def _write_last_revision_info(self, revno, revision_id):
2249
"""Simply write out the revision id, with no checks.
2251
Use set_last_revision_info to perform this safely.
2253
Does not update the revision_history cache.
2254
Intended to be called by set_last_revision_info and
2255
_write_revision_history.
2257
revision_id = _mod_revision.ensure_null(revision_id)
2258
out_string = '%d %s\n' % (revno, revision_id)
2259
self._transport.put_bytes('last-revision', out_string,
2260
mode=self.bzrdir._get_file_mode())
2263
def set_last_revision_info(self, revno, revision_id):
2264
revision_id = _mod_revision.ensure_null(revision_id)
2265
old_revno, old_revid = self.last_revision_info()
2266
if self._get_append_revisions_only():
2267
self._check_history_violation(revision_id)
2268
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2269
self._write_last_revision_info(revno, revision_id)
2270
self._clear_cached_state()
2271
self._last_revision_info_cache = revno, revision_id
2272
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2274
def _synchronize_history(self, destination, revision_id):
2275
"""Synchronize last revision and revision history between branches.
2277
:see: Branch._synchronize_history
2279
# XXX: The base Branch has a fast implementation of this method based
2280
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2281
# that uses set_revision_history. This class inherits from BzrBranch5,
2282
# but wants the fast implementation, so it calls
2283
# Branch._synchronize_history directly.
2284
Branch._synchronize_history(self, destination, revision_id)
2286
def _check_history_violation(self, revision_id):
2287
last_revision = _mod_revision.ensure_null(self.last_revision())
2288
if _mod_revision.is_null(last_revision):
2290
if last_revision not in self._lefthand_history(revision_id):
2291
raise errors.AppendRevisionsOnlyViolation(self.base)
2293
def _gen_revision_history(self):
2294
"""Generate the revision history from last revision
2296
last_revno, last_revision = self.last_revision_info()
2297
self._extend_partial_history(stop_index=last_revno-1)
2298
return list(reversed(self._partial_revision_history_cache))
2300
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2301
"""Extend the partial history to include a given index
2303
If a stop_index is supplied, stop when that index has been reached.
2304
If a stop_revision is supplied, stop when that revision is
2305
encountered. Otherwise, stop when the beginning of history is
2308
:param stop_index: The index which should be present. When it is
2309
present, history extension will stop.
2310
:param revision_id: The revision id which should be present. When
2311
it is encountered, history extension will stop.
2313
repo = self.repository
2314
if len(self._partial_revision_history_cache) == 0:
2315
iterator = repo.iter_reverse_revision_history(self.last_revision())
2317
start_revision = self._partial_revision_history_cache[-1]
2318
iterator = repo.iter_reverse_revision_history(start_revision)
2319
#skip the last revision in the list
2320
next_revision = iterator.next()
2321
for revision_id in iterator:
2322
self._partial_revision_history_cache.append(revision_id)
2323
if (stop_index is not None and
2324
len(self._partial_revision_history_cache) > stop_index):
2326
if revision_id == stop_revision:
2329
def _write_revision_history(self, history):
2330
"""Factored out of set_revision_history.
2332
This performs the actual writing to disk, with format-specific checks.
2333
It is intended to be called by BzrBranch5.set_revision_history.
2335
if len(history) == 0:
2336
last_revision = 'null:'
2338
if history != self._lefthand_history(history[-1]):
2339
raise errors.NotLefthandHistory(history)
2340
last_revision = history[-1]
2341
if self._get_append_revisions_only():
2342
self._check_history_violation(last_revision)
2343
self._write_last_revision_info(len(history), last_revision)
2346
def _set_parent_location(self, url):
2347
"""Set the parent branch"""
2348
self._set_config_location('parent_location', url, make_relative=True)
2351
def _get_parent_location(self):
2352
"""Set the parent branch"""
2353
return self._get_config_location('parent_location')
2355
def set_push_location(self, location):
2356
"""See Branch.set_push_location."""
2357
self._set_config_location('push_location', location)
2359
def set_bound_location(self, location):
2360
"""See Branch.set_push_location."""
2362
config = self.get_config()
2363
if location is None:
2364
if config.get_user_option('bound') != 'True':
2367
config.set_user_option('bound', 'False', warn_masked=True)
2370
self._set_config_location('bound_location', location,
2372
config.set_user_option('bound', 'True', warn_masked=True)
2375
def _get_bound_location(self, bound):
2376
"""Return the bound location in the config file.
2378
Return None if the bound parameter does not match"""
2379
config = self.get_config()
2380
config_bound = (config.get_user_option('bound') == 'True')
2381
if config_bound != bound:
2383
return self._get_config_location('bound_location', config=config)
2385
def get_bound_location(self):
2386
"""See Branch.set_push_location."""
2387
return self._get_bound_location(True)
2389
def get_old_bound_location(self):
2390
"""See Branch.get_old_bound_location"""
2391
return self._get_bound_location(False)
2393
def get_stacked_on_url(self):
2394
# you can always ask for the URL; but you might not be able to use it
2395
# if the repo can't support stacking.
2396
## self._check_stackable_repo()
2397
stacked_url = self._get_config_location('stacked_on_location')
2398
if stacked_url is None:
2399
raise errors.NotStacked(self)
2402
def set_append_revisions_only(self, enabled):
2407
self.get_config().set_user_option('append_revisions_only', value,
2410
def set_stacked_on_url(self, url):
2411
self._check_stackable_repo()
2414
old_url = self.get_stacked_on_url()
2415
except (errors.NotStacked, errors.UnstackableBranchFormat,
2416
errors.UnstackableRepositoryFormat):
2419
# repositories don't offer an interface to remove fallback
2420
# repositories today; take the conceptually simpler option and just
2422
self.repository = self.bzrdir.find_repository()
2423
# for every revision reference the branch has, ensure it is pulled
2425
source_repository = self._get_fallback_repository(old_url)
2426
for revision_id in chain([self.last_revision()],
2427
self.tags.get_reverse_tag_dict()):
2428
self.repository.fetch(source_repository, revision_id,
2431
self._activate_fallback_location(url)
2432
# write this out after the repository is stacked to avoid setting a
2433
# stacked config that doesn't work.
2434
self._set_config_location('stacked_on_location', url)
2436
def _get_append_revisions_only(self):
2437
value = self.get_config().get_user_option('append_revisions_only')
2438
return value == 'True'
2440
def _make_tags(self):
2441
return BasicTags(self)
2444
def generate_revision_history(self, revision_id, last_rev=None,
2446
"""See BzrBranch5.generate_revision_history"""
2447
history = self._lefthand_history(revision_id, last_rev, other_branch)
2448
revno = len(history)
2449
self.set_last_revision_info(revno, revision_id)
2452
def get_rev_id(self, revno, history=None):
2453
"""Find the revision id of the specified revno."""
2455
return _mod_revision.NULL_REVISION
2457
last_revno, last_revision_id = self.last_revision_info()
2458
if revno <= 0 or revno > last_revno:
2459
raise errors.NoSuchRevision(self, revno)
2461
if history is not None:
2462
return history[revno - 1]
2464
index = last_revno - revno
2465
if len(self._partial_revision_history_cache) <= index:
2466
self._extend_partial_history(stop_index=index)
2467
if len(self._partial_revision_history_cache) > index:
2468
return self._partial_revision_history_cache[index]
2470
raise errors.NoSuchRevision(self, revno)
2473
def revision_id_to_revno(self, revision_id):
2474
"""Given a revision id, return its revno"""
2475
if _mod_revision.is_null(revision_id):
2478
index = self._partial_revision_history_cache.index(revision_id)
2480
self._extend_partial_history(stop_revision=revision_id)
2481
index = len(self._partial_revision_history_cache) - 1
2482
if self._partial_revision_history_cache[index] != revision_id:
2483
raise errors.NoSuchRevision(self, revision_id)
2484
return self.revno() - index
2487
class BzrBranch6(BzrBranch7):
2488
"""See BzrBranchFormat6 for the capabilities of this branch.
2490
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2494
def get_stacked_on_url(self):
2495
raise errors.UnstackableBranchFormat(self._format, self.base)
2497
def set_stacked_on_url(self, url):
2498
raise errors.UnstackableBranchFormat(self._format, self.base)
2501
######################################################################
2502
# results of operations
2505
class _Result(object):
2507
def _show_tag_conficts(self, to_file):
2508
if not getattr(self, 'tag_conflicts', None):
2510
to_file.write('Conflicting tags:\n')
2511
for name, value1, value2 in self.tag_conflicts:
2512
to_file.write(' %s\n' % (name, ))
2515
class PullResult(_Result):
2516
"""Result of a Branch.pull operation.
2518
:ivar old_revno: Revision number before pull.
2519
:ivar new_revno: Revision number after pull.
2520
:ivar old_revid: Tip revision id before pull.
2521
:ivar new_revid: Tip revision id after pull.
2522
:ivar source_branch: Source (local) branch object.
2523
:ivar master_branch: Master branch of the target, or the target if no
2525
:ivar local_branch: target branch if there is a Master, else None
2526
:ivar target_branch: Target/destination branch object.
2527
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2531
# DEPRECATED: pull used to return the change in revno
2532
return self.new_revno - self.old_revno
2534
def report(self, to_file):
2536
if self.old_revid == self.new_revid:
2537
to_file.write('No revisions to pull.\n')
2539
to_file.write('Now on revision %d.\n' % self.new_revno)
2540
self._show_tag_conficts(to_file)
2543
class PushResult(_Result):
2544
"""Result of a Branch.push operation.
2546
:ivar old_revno: Revision number before push.
2547
:ivar new_revno: Revision number after push.
2548
:ivar old_revid: Tip revision id before push.
2549
:ivar new_revid: Tip revision id after push.
2550
:ivar source_branch: Source branch object.
2551
:ivar master_branch: Master branch of the target, or None.
2552
:ivar target_branch: Target/destination branch object.
2556
# DEPRECATED: push used to return the change in revno
2557
return self.new_revno - self.old_revno
2559
def report(self, to_file):
2560
"""Write a human-readable description of the result."""
2561
if self.old_revid == self.new_revid:
2562
to_file.write('No new revisions to push.\n')
2564
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2565
self._show_tag_conficts(to_file)
2568
class BranchCheckResult(object):
2569
"""Results of checking branch consistency.
2574
def __init__(self, branch):
2575
self.branch = branch
2577
def report_results(self, verbose):
2578
"""Report the check results via trace.note.
2580
:param verbose: Requests more detailed display of what was checked,
2583
note('checked branch %s format %s',
2585
self.branch._format)
2588
class Converter5to6(object):
2589
"""Perform an in-place upgrade of format 5 to format 6"""
2591
def convert(self, branch):
2592
# Data for 5 and 6 can peacefully coexist.
2593
format = BzrBranchFormat6()
2594
new_branch = format.open(branch.bzrdir, _found=True)
2596
# Copy source data into target
2597
new_branch._write_last_revision_info(*branch.last_revision_info())
2598
new_branch.set_parent(branch.get_parent())
2599
new_branch.set_bound_location(branch.get_bound_location())
2600
new_branch.set_push_location(branch.get_push_location())
2602
# New branch has no tags by default
2603
new_branch.tags._set_tag_dict({})
2605
# Copying done; now update target format
2606
new_branch._transport.put_bytes('format',
2607
format.get_format_string(),
2608
mode=new_branch.bzrdir._get_file_mode())
2610
# Clean up old files
2611
new_branch._transport.delete('revision-history')
2613
branch.set_parent(None)
2614
except errors.NoSuchFile:
2616
branch.set_bound_location(None)
2619
class Converter6to7(object):
2620
"""Perform an in-place upgrade of format 6 to format 7"""
2622
def convert(self, branch):
2623
format = BzrBranchFormat7()
2624
branch._set_config_location('stacked_on_location', '')
2625
# update target format
2626
branch._transport.put_bytes('format', format.get_format_string())
2630
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2631
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2634
_run_with_write_locked_target will attempt to release the lock it acquires.
2636
If an exception is raised by callable, then that exception *will* be
2637
propagated, even if the unlock attempt raises its own error. Thus
2638
_run_with_write_locked_target should be preferred to simply doing::
2642
return callable(*args, **kwargs)
2647
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2648
# should share code?
2651
result = callable(*args, **kwargs)
2653
exc_info = sys.exc_info()
2657
raise exc_info[0], exc_info[1], exc_info[2]
added
removed
bzrlib/branch.py
