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 import registry
49
from bzrlib.symbol_versioning import (
53
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
56
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
57
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
58
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
61
# TODO: Maybe include checks for common corruption of newlines, etc?
63
# TODO: Some operations like log might retrieve the same revisions
64
# repeatedly to calculate deltas. We could perhaps have a weakref
65
# cache in memory to make this faster. In general anything can be
66
# cached in memory between lock and unlock operations. .. nb thats
67
# what the transaction identity map provides
70
######################################################################
74
"""Branch holding a history of revisions.
77
Base directory/url of the branch.
79
hooks: An instance of BranchHooks.
81
# this is really an instance variable - FIXME move it there
85
# override this to set the strategy for storing tags
87
return DisabledTags(self)
89
def __init__(self, *ignored, **ignored_too):
90
self.tags = self._make_tags()
91
self._revision_history_cache = None
92
self._revision_id_to_revno_cache = None
93
self._partial_revision_id_to_revno_cache = {}
94
self._last_revision_info_cache = None
95
self._merge_sorted_revisions_cache = None
97
hooks = Branch.hooks['open']
101
def _open_hook(self):
102
"""Called by init to allow simpler extension of the base class."""
104
def break_lock(self):
105
"""Break a lock if one is present from another instance.
107
Uses the ui factory to ask for confirmation if the lock may be from
110
This will probe the repository for its lock as well.
112
self.control_files.break_lock()
113
self.repository.break_lock()
114
master = self.get_master_branch()
115
if master is not None:
119
def open(base, _unsupported=False, possible_transports=None):
120
"""Open the branch rooted at base.
122
For instance, if the branch is at URL/.bzr/branch,
123
Branch.open(URL) -> a Branch instance.
125
control = bzrdir.BzrDir.open(base, _unsupported,
126
possible_transports=possible_transports)
127
return control.open_branch(_unsupported)
130
def open_from_transport(transport, _unsupported=False):
131
"""Open the branch rooted at transport"""
132
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
133
return control.open_branch(_unsupported)
136
def open_containing(url, possible_transports=None):
137
"""Open an existing branch which contains url.
139
This probes for a branch at url, and searches upwards from there.
141
Basically we keep looking up until we find the control directory or
142
run into the root. If there isn't one, raises NotBranchError.
143
If there is one and it is either an unrecognised format or an unsupported
144
format, UnknownFormatError or UnsupportedFormatError are raised.
145
If there is one, it is returned, along with the unused portion of url.
147
control, relpath = bzrdir.BzrDir.open_containing(url,
149
return control.open_branch(), relpath
151
def _push_should_merge_tags(self):
152
"""Should _basic_push merge this branch's tags into the target?
154
The default implementation returns False if this branch has no tags,
155
and True the rest of the time. Subclasses may override this.
157
return self.tags.supports_tags() and self.tags.get_tag_dict()
159
def get_config(self):
160
return BranchConfig(self)
162
def _get_nick(self, local=False, possible_transports=None):
163
config = self.get_config()
164
# explicit overrides master, but don't look for master if local is True
165
if not local and not config.has_explicit_nickname():
167
master = self.get_master_branch(possible_transports)
168
if master is not None:
169
# return the master branch value
171
except errors.BzrError, e:
172
# Silently fall back to local implicit nick if the master is
174
mutter("Could not connect to bound branch, "
175
"falling back to local nick.\n " + str(e))
176
return config.get_nickname()
178
def _set_nick(self, nick):
179
self.get_config().set_user_option('nickname', nick, warn_masked=True)
181
nick = property(_get_nick, _set_nick)
184
raise NotImplementedError(self.is_locked)
186
def _lefthand_history(self, revision_id, last_rev=None,
188
if 'evil' in debug.debug_flags:
189
mutter_callsite(4, "_lefthand_history scales with history.")
190
# stop_revision must be a descendant of last_revision
191
graph = self.repository.get_graph()
192
if last_rev is not None:
193
if not graph.is_ancestor(last_rev, revision_id):
194
# our previous tip is not merged into stop_revision
195
raise errors.DivergedBranches(self, other_branch)
196
# make a new revision history from the graph
197
parents_map = graph.get_parent_map([revision_id])
198
if revision_id not in parents_map:
199
raise errors.NoSuchRevision(self, revision_id)
200
current_rev_id = revision_id
202
check_not_reserved_id = _mod_revision.check_not_reserved_id
203
# Do not include ghosts or graph origin in revision_history
204
while (current_rev_id in parents_map and
205
len(parents_map[current_rev_id]) > 0):
206
check_not_reserved_id(current_rev_id)
207
new_history.append(current_rev_id)
208
current_rev_id = parents_map[current_rev_id][0]
209
parents_map = graph.get_parent_map([current_rev_id])
210
new_history.reverse()
213
def lock_write(self):
214
raise NotImplementedError(self.lock_write)
217
raise NotImplementedError(self.lock_read)
220
raise NotImplementedError(self.unlock)
222
def peek_lock_mode(self):
223
"""Return lock mode for the Branch: 'r', 'w' or None"""
224
raise NotImplementedError(self.peek_lock_mode)
226
def get_physical_lock_status(self):
227
raise NotImplementedError(self.get_physical_lock_status)
230
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
231
"""Return the revision_id for a dotted revno.
233
:param revno: a tuple like (1,) or (1,1,2)
234
:param _cache_reverse: a private parameter enabling storage
235
of the reverse mapping in a top level cache. (This should
236
only be done in selective circumstances as we want to
237
avoid having the mapping cached multiple times.)
238
:return: the revision_id
239
:raises errors.NoSuchRevision: if the revno doesn't exist
241
rev_id = self._do_dotted_revno_to_revision_id(revno)
243
self._partial_revision_id_to_revno_cache[rev_id] = revno
246
def _do_dotted_revno_to_revision_id(self, revno):
247
"""Worker function for dotted_revno_to_revision_id.
249
Subclasses should override this if they wish to
250
provide a more efficient implementation.
253
return self.get_rev_id(revno[0])
254
revision_id_to_revno = self.get_revision_id_to_revno_map()
255
revision_ids = [revision_id for revision_id, this_revno
256
in revision_id_to_revno.iteritems()
257
if revno == this_revno]
258
if len(revision_ids) == 1:
259
return revision_ids[0]
261
revno_str = '.'.join(map(str, revno))
262
raise errors.NoSuchRevision(self, revno_str)
265
def revision_id_to_dotted_revno(self, revision_id):
266
"""Given a revision id, return its dotted revno.
268
:return: a tuple like (1,) or (400,1,3).
270
return self._do_revision_id_to_dotted_revno(revision_id)
272
def _do_revision_id_to_dotted_revno(self, revision_id):
273
"""Worker function for revision_id_to_revno."""
274
# Try the caches if they are loaded
275
result = self._partial_revision_id_to_revno_cache.get(revision_id)
276
if result is not None:
278
if self._revision_id_to_revno_cache:
279
result = self._revision_id_to_revno_cache.get(revision_id)
281
raise errors.NoSuchRevision(self, revision_id)
282
# Try the mainline as it's optimised
284
revno = self.revision_id_to_revno(revision_id)
286
except errors.NoSuchRevision:
287
# We need to load and use the full revno map after all
288
result = self.get_revision_id_to_revno_map().get(revision_id)
290
raise errors.NoSuchRevision(self, revision_id)
294
def get_revision_id_to_revno_map(self):
295
"""Return the revision_id => dotted revno map.
297
This will be regenerated on demand, but will be cached.
299
:return: A dictionary mapping revision_id => dotted revno.
300
This dictionary should not be modified by the caller.
302
if self._revision_id_to_revno_cache is not None:
303
mapping = self._revision_id_to_revno_cache
305
mapping = self._gen_revno_map()
306
self._cache_revision_id_to_revno(mapping)
307
# TODO: jam 20070417 Since this is being cached, should we be returning
309
# I would rather not, and instead just declare that users should not
310
# modify the return value.
313
def _gen_revno_map(self):
314
"""Create a new mapping from revision ids to dotted revnos.
316
Dotted revnos are generated based on the current tip in the revision
318
This is the worker function for get_revision_id_to_revno_map, which
319
just caches the return value.
321
:return: A dictionary mapping revision_id => dotted revno.
323
revision_id_to_revno = dict((rev_id, revno)
324
for rev_id, depth, revno, end_of_merge
325
in self.iter_merge_sorted_revisions())
326
return revision_id_to_revno
329
def iter_merge_sorted_revisions(self, start_revision_id=None,
330
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
331
"""Walk the revisions for a branch in merge sorted order.
333
Merge sorted order is the output from a merge-aware,
334
topological sort, i.e. all parents come before their
335
children going forward; the opposite for reverse.
337
:param start_revision_id: the revision_id to begin walking from.
338
If None, the branch tip is used.
339
:param stop_revision_id: the revision_id to terminate the walk
340
after. If None, the rest of history is included.
341
:param stop_rule: if stop_revision_id is not None, the precise rule
342
to use for termination:
343
* 'exclude' - leave the stop revision out of the result (default)
344
* 'include' - the stop revision is the last item in the result
345
* 'with-merges' - include the stop revision and all of its
346
merged revisions in the result
347
:param direction: either 'reverse' or 'forward':
348
* reverse means return the start_revision_id first, i.e.
349
start at the most recent revision and go backwards in history
350
* forward returns tuples in the opposite order to reverse.
351
Note in particular that forward does *not* do any intelligent
352
ordering w.r.t. depth as some clients of this API may like.
353
(If required, that ought to be done at higher layers.)
355
:return: an iterator over (revision_id, depth, revno, end_of_merge)
358
* revision_id: the unique id of the revision
359
* depth: How many levels of merging deep this node has been
361
* revno_sequence: This field provides a sequence of
362
revision numbers for all revisions. The format is:
363
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
364
branch that the revno is on. From left to right the REVNO numbers
365
are the sequence numbers within that branch of the revision.
366
* end_of_merge: When True the next node (earlier in history) is
367
part of a different merge.
369
# Note: depth and revno values are in the context of the branch so
370
# we need the full graph to get stable numbers, regardless of the
372
if self._merge_sorted_revisions_cache is None:
373
last_revision = self.last_revision()
374
graph = self.repository.get_graph()
375
parent_map = dict(((key, value) for key, value in
376
graph.iter_ancestry([last_revision]) if value is not None))
377
revision_graph = repository._strip_NULL_ghosts(parent_map)
378
revs = tsort.merge_sort(revision_graph, last_revision, None,
380
# Drop the sequence # before caching
381
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
383
filtered = self._filter_merge_sorted_revisions(
384
self._merge_sorted_revisions_cache, start_revision_id,
385
stop_revision_id, stop_rule)
386
if direction == 'reverse':
388
if direction == 'forward':
389
return reversed(list(filtered))
391
raise ValueError('invalid direction %r' % direction)
393
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
394
start_revision_id, stop_revision_id, stop_rule):
395
"""Iterate over an inclusive range of sorted revisions."""
396
rev_iter = iter(merge_sorted_revisions)
397
if start_revision_id is not None:
398
for rev_id, depth, revno, end_of_merge in rev_iter:
399
if rev_id != start_revision_id:
402
# The decision to include the start or not
403
# depends on the stop_rule if a stop is provided
405
iter([(rev_id, depth, revno, end_of_merge)]),
408
if stop_revision_id is None:
409
for rev_id, depth, revno, end_of_merge in rev_iter:
410
yield rev_id, depth, revno, end_of_merge
411
elif stop_rule == 'exclude':
412
for rev_id, depth, revno, end_of_merge in rev_iter:
413
if rev_id == stop_revision_id:
415
yield rev_id, depth, revno, end_of_merge
416
elif stop_rule == 'include':
417
for rev_id, depth, revno, end_of_merge in rev_iter:
418
yield rev_id, depth, revno, end_of_merge
419
if rev_id == stop_revision_id:
421
elif stop_rule == 'with-merges':
422
stop_rev = self.repository.get_revision(stop_revision_id)
423
if stop_rev.parent_ids:
424
left_parent = stop_rev.parent_ids[0]
426
left_parent = _mod_revision.NULL_REVISION
427
for rev_id, depth, revno, end_of_merge in rev_iter:
428
if rev_id == left_parent:
430
yield rev_id, depth, revno, end_of_merge
432
raise ValueError('invalid stop_rule %r' % stop_rule)
434
def leave_lock_in_place(self):
435
"""Tell this branch object not to release the physical lock when this
438
If lock_write doesn't return a token, then this method is not supported.
440
self.control_files.leave_in_place()
442
def dont_leave_lock_in_place(self):
443
"""Tell this branch object to release the physical lock when this
444
object is unlocked, even if it didn't originally acquire it.
446
If lock_write doesn't return a token, then this method is not supported.
448
self.control_files.dont_leave_in_place()
450
def bind(self, other):
451
"""Bind the local branch the other branch.
453
:param other: The branch to bind to
456
raise errors.UpgradeRequired(self.base)
459
def fetch(self, from_branch, last_revision=None, pb=None):
460
"""Copy revisions from from_branch into this branch.
462
:param from_branch: Where to copy from.
463
:param last_revision: What revision to stop at (None for at the end
465
:param pb: An optional progress bar to use.
467
Returns the copied revision count and the failed revisions in a tuple:
470
if self.base == from_branch.base:
473
nested_pb = ui.ui_factory.nested_progress_bar()
478
from_branch.lock_read()
480
if last_revision is None:
481
pb.update('get source history')
482
last_revision = from_branch.last_revision()
483
last_revision = _mod_revision.ensure_null(last_revision)
484
return self.repository.fetch(from_branch.repository,
485
revision_id=last_revision,
488
if nested_pb is not None:
492
def get_bound_location(self):
493
"""Return the URL of the branch we are bound to.
495
Older format branches cannot bind, please be sure to use a metadir
500
def get_old_bound_location(self):
501
"""Return the URL of the branch we used to be bound to
503
raise errors.UpgradeRequired(self.base)
505
def get_commit_builder(self, parents, config=None, timestamp=None,
506
timezone=None, committer=None, revprops=None,
508
"""Obtain a CommitBuilder for this branch.
510
:param parents: Revision ids of the parents of the new revision.
511
:param config: Optional configuration to use.
512
:param timestamp: Optional timestamp recorded for commit.
513
:param timezone: Optional timezone for timestamp.
514
:param committer: Optional committer to set for commit.
515
:param revprops: Optional dictionary of revision properties.
516
:param revision_id: Optional revision id.
520
config = self.get_config()
522
return self.repository.get_commit_builder(self, parents, config,
523
timestamp, timezone, committer, revprops, revision_id)
525
def get_master_branch(self, possible_transports=None):
526
"""Return the branch we are bound to.
528
:return: Either a Branch, or None
532
def get_revision_delta(self, revno):
533
"""Return the delta for one revision.
535
The delta is relative to its mainline predecessor, or the
536
empty tree for revision 1.
538
rh = self.revision_history()
539
if not (1 <= revno <= len(rh)):
540
raise errors.InvalidRevisionNumber(revno)
541
return self.repository.get_revision_delta(rh[revno-1])
543
def get_stacked_on_url(self):
544
"""Get the URL this branch is stacked against.
546
:raises NotStacked: If the branch is not stacked.
547
:raises UnstackableBranchFormat: If the branch does not support
550
raise NotImplementedError(self.get_stacked_on_url)
552
def print_file(self, file, revision_id):
553
"""Print `file` to stdout."""
554
raise NotImplementedError(self.print_file)
556
def set_revision_history(self, rev_history):
557
raise NotImplementedError(self.set_revision_history)
559
def set_stacked_on_url(self, url):
560
"""Set the URL this branch is stacked against.
562
:raises UnstackableBranchFormat: If the branch does not support
564
:raises UnstackableRepositoryFormat: If the repository does not support
567
raise NotImplementedError(self.set_stacked_on_url)
569
def _cache_revision_history(self, rev_history):
570
"""Set the cached revision history to rev_history.
572
The revision_history method will use this cache to avoid regenerating
573
the revision history.
575
This API is semi-public; it only for use by subclasses, all other code
576
should consider it to be private.
578
self._revision_history_cache = rev_history
580
def _cache_revision_id_to_revno(self, revision_id_to_revno):
581
"""Set the cached revision_id => revno map to revision_id_to_revno.
583
This API is semi-public; it only for use by subclasses, all other code
584
should consider it to be private.
586
self._revision_id_to_revno_cache = revision_id_to_revno
588
def _clear_cached_state(self):
589
"""Clear any cached data on this branch, e.g. cached revision history.
591
This means the next call to revision_history will need to call
592
_gen_revision_history.
594
This API is semi-public; it only for use by subclasses, all other code
595
should consider it to be private.
597
self._revision_history_cache = None
598
self._revision_id_to_revno_cache = None
599
self._last_revision_info_cache = None
600
self._merge_sorted_revisions_cache = None
602
def _gen_revision_history(self):
603
"""Return sequence of revision hashes on to this branch.
605
Unlike revision_history, this method always regenerates or rereads the
606
revision history, i.e. it does not cache the result, so repeated calls
609
Concrete subclasses should override this instead of revision_history so
610
that subclasses do not need to deal with caching logic.
612
This API is semi-public; it only for use by subclasses, all other code
613
should consider it to be private.
615
raise NotImplementedError(self._gen_revision_history)
618
def revision_history(self):
619
"""Return sequence of revision ids on this branch.
621
This method will cache the revision history for as long as it is safe to
624
if 'evil' in debug.debug_flags:
625
mutter_callsite(3, "revision_history scales with history.")
626
if self._revision_history_cache is not None:
627
history = self._revision_history_cache
629
history = self._gen_revision_history()
630
self._cache_revision_history(history)
634
"""Return current revision number for this branch.
636
That is equivalent to the number of revisions committed to
639
return self.last_revision_info()[0]
642
"""Older format branches cannot bind or unbind."""
643
raise errors.UpgradeRequired(self.base)
645
def set_append_revisions_only(self, enabled):
646
"""Older format branches are never restricted to append-only"""
647
raise errors.UpgradeRequired(self.base)
649
def last_revision(self):
650
"""Return last revision id, or NULL_REVISION."""
651
return self.last_revision_info()[1]
654
def last_revision_info(self):
655
"""Return information about the last revision.
657
:return: A tuple (revno, revision_id).
659
if self._last_revision_info_cache is None:
660
self._last_revision_info_cache = self._last_revision_info()
661
return self._last_revision_info_cache
663
def _last_revision_info(self):
664
rh = self.revision_history()
667
return (revno, rh[-1])
669
return (0, _mod_revision.NULL_REVISION)
671
@deprecated_method(deprecated_in((1, 6, 0)))
672
def missing_revisions(self, other, stop_revision=None):
673
"""Return a list of new revisions that would perfectly fit.
675
If self and other have not diverged, return a list of the revisions
676
present in other, but missing from self.
678
self_history = self.revision_history()
679
self_len = len(self_history)
680
other_history = other.revision_history()
681
other_len = len(other_history)
682
common_index = min(self_len, other_len) -1
683
if common_index >= 0 and \
684
self_history[common_index] != other_history[common_index]:
685
raise errors.DivergedBranches(self, other)
687
if stop_revision is None:
688
stop_revision = other_len
690
if stop_revision > other_len:
691
raise errors.NoSuchRevision(self, stop_revision)
692
return other_history[self_len:stop_revision]
695
def update_revisions(self, other, stop_revision=None, overwrite=False,
697
"""Pull in new perfect-fit revisions.
699
:param other: Another Branch to pull from
700
:param stop_revision: Updated until the given revision
701
:param overwrite: Always set the branch pointer, rather than checking
702
to see if it is a proper descendant.
703
:param graph: A Graph object that can be used to query history
704
information. This can be None.
709
other_revno, other_last_revision = other.last_revision_info()
710
stop_revno = None # unknown
711
if stop_revision is None:
712
stop_revision = other_last_revision
713
if _mod_revision.is_null(stop_revision):
714
# if there are no commits, we're done.
716
stop_revno = other_revno
718
# what's the current last revision, before we fetch [and change it
720
last_rev = _mod_revision.ensure_null(self.last_revision())
721
# we fetch here so that we don't process data twice in the common
722
# case of having something to pull, and so that the check for
723
# already merged can operate on the just fetched graph, which will
724
# be cached in memory.
725
self.fetch(other, stop_revision)
726
# Check to see if one is an ancestor of the other
729
graph = self.repository.get_graph()
730
if self._check_if_descendant_or_diverged(
731
stop_revision, last_rev, graph, other):
732
# stop_revision is a descendant of last_rev, but we aren't
733
# overwriting, so we're done.
735
if stop_revno is None:
737
graph = self.repository.get_graph()
738
this_revno, this_last_revision = self.last_revision_info()
739
stop_revno = graph.find_distance_to_null(stop_revision,
740
[(other_last_revision, other_revno),
741
(this_last_revision, this_revno)])
742
self.set_last_revision_info(stop_revno, stop_revision)
746
def revision_id_to_revno(self, revision_id):
747
"""Given a revision id, return its revno"""
748
if _mod_revision.is_null(revision_id):
750
history = self.revision_history()
752
return history.index(revision_id) + 1
754
raise errors.NoSuchRevision(self, revision_id)
756
def get_rev_id(self, revno, history=None):
757
"""Find the revision id of the specified revno."""
759
return _mod_revision.NULL_REVISION
761
history = self.revision_history()
762
if revno <= 0 or revno > len(history):
763
raise errors.NoSuchRevision(self, revno)
764
return history[revno - 1]
766
def pull(self, source, overwrite=False, stop_revision=None,
767
possible_transports=None, _override_hook_target=None):
768
"""Mirror source into this branch.
770
This branch is considered to be 'local', having low latency.
772
:returns: PullResult instance
774
raise NotImplementedError(self.pull)
776
def push(self, target, overwrite=False, stop_revision=None):
777
"""Mirror this branch into target.
779
This branch is considered to be 'local', having low latency.
781
raise NotImplementedError(self.push)
783
def basis_tree(self):
784
"""Return `Tree` object for last revision."""
785
return self.repository.revision_tree(self.last_revision())
787
def get_parent(self):
788
"""Return the parent location of the branch.
790
This is the default location for pull/missing. The usual
791
pattern is that the user can override it by specifying a
794
raise NotImplementedError(self.get_parent)
796
def _set_config_location(self, name, url, config=None,
797
make_relative=False):
799
config = self.get_config()
803
url = urlutils.relative_url(self.base, url)
804
config.set_user_option(name, url, warn_masked=True)
806
def _get_config_location(self, name, config=None):
808
config = self.get_config()
809
location = config.get_user_option(name)
814
def get_submit_branch(self):
815
"""Return the submit location of the branch.
817
This is the default location for bundle. The usual
818
pattern is that the user can override it by specifying a
821
return self.get_config().get_user_option('submit_branch')
823
def set_submit_branch(self, location):
824
"""Return the submit location of the branch.
826
This is the default location for bundle. The usual
827
pattern is that the user can override it by specifying a
830
self.get_config().set_user_option('submit_branch', location,
833
def get_public_branch(self):
834
"""Return the public location of the branch.
836
This is is used by merge directives.
838
return self._get_config_location('public_branch')
840
def set_public_branch(self, location):
841
"""Return the submit location of the branch.
843
This is the default location for bundle. The usual
844
pattern is that the user can override it by specifying a
847
self._set_config_location('public_branch', location)
849
def get_push_location(self):
850
"""Return the None or the location to push this branch to."""
851
push_loc = self.get_config().get_user_option('push_location')
854
def set_push_location(self, location):
855
"""Set a new push location for this branch."""
856
raise NotImplementedError(self.set_push_location)
858
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
859
"""Run the post_change_branch_tip hooks."""
860
hooks = Branch.hooks['post_change_branch_tip']
863
new_revno, new_revid = self.last_revision_info()
864
params = ChangeBranchTipParams(
865
self, old_revno, new_revno, old_revid, new_revid)
869
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
870
"""Run the pre_change_branch_tip hooks."""
871
hooks = Branch.hooks['pre_change_branch_tip']
874
old_revno, old_revid = self.last_revision_info()
875
params = ChangeBranchTipParams(
876
self, old_revno, new_revno, old_revid, new_revid)
880
except errors.TipChangeRejected:
883
exc_info = sys.exc_info()
884
hook_name = Branch.hooks.get_hook_name(hook)
885
raise errors.HookFailed(
886
'pre_change_branch_tip', hook_name, exc_info)
888
def set_parent(self, url):
889
raise NotImplementedError(self.set_parent)
893
"""Synchronise this branch with the master branch if any.
895
:return: None or the last_revision pivoted out during the update.
899
def check_revno(self, revno):
901
Check whether a revno corresponds to any revision.
902
Zero (the NULL revision) is considered valid.
905
self.check_real_revno(revno)
907
def check_real_revno(self, revno):
909
Check whether a revno corresponds to a real revision.
910
Zero (the NULL revision) is considered invalid
912
if revno < 1 or revno > self.revno():
913
raise errors.InvalidRevisionNumber(revno)
916
def clone(self, to_bzrdir, revision_id=None):
917
"""Clone this branch into to_bzrdir preserving all semantic values.
919
Most API users will want 'create_clone_on_transport', which creates a
920
new bzrdir and branch on the fly.
922
revision_id: if not None, the revision history in the new branch will
923
be truncated to end with revision_id.
925
result = to_bzrdir.create_branch()
926
self.copy_content_into(result, revision_id=revision_id)
930
def sprout(self, to_bzrdir, revision_id=None):
931
"""Create a new line of development from the branch, into to_bzrdir.
933
to_bzrdir controls the branch format.
935
revision_id: if not None, the revision history in the new branch will
936
be truncated to end with revision_id.
938
result = to_bzrdir.create_branch()
939
self.copy_content_into(result, revision_id=revision_id)
940
result.set_parent(self.bzrdir.root_transport.base)
943
def _synchronize_history(self, destination, revision_id):
944
"""Synchronize last revision and revision history between branches.
946
This version is most efficient when the destination is also a
947
BzrBranch6, but works for BzrBranch5, as long as the destination's
948
repository contains all the lefthand ancestors of the intended
949
last_revision. If not, set_last_revision_info will fail.
951
:param destination: The branch to copy the history into
952
:param revision_id: The revision-id to truncate history at. May
953
be None to copy complete history.
955
source_revno, source_revision_id = self.last_revision_info()
956
if revision_id is None:
957
revno, revision_id = source_revno, source_revision_id
958
elif source_revision_id == revision_id:
959
# we know the revno without needing to walk all of history
962
# To figure out the revno for a random revision, we need to build
963
# the revision history, and count its length.
964
# We don't care about the order, just how long it is.
965
# Alternatively, we could start at the current location, and count
966
# backwards. But there is no guarantee that we will find it since
967
# it may be a merged revision.
968
revno = len(list(self.repository.iter_reverse_revision_history(
970
destination.set_last_revision_info(revno, revision_id)
973
def copy_content_into(self, destination, revision_id=None):
974
"""Copy the content of self into destination.
976
revision_id: if not None, the revision history in the new branch will
977
be truncated to end with revision_id.
979
self._synchronize_history(destination, revision_id)
981
parent = self.get_parent()
982
except errors.InaccessibleParent, e:
983
mutter('parent was not accessible to copy: %s', e)
986
destination.set_parent(parent)
987
if self._push_should_merge_tags():
988
self.tags.merge_to(destination.tags)
992
"""Check consistency of the branch.
994
In particular this checks that revisions given in the revision-history
995
do actually match up in the revision graph, and that they're all
996
present in the repository.
998
Callers will typically also want to check the repository.
1000
:return: A BranchCheckResult.
1002
mainline_parent_id = None
1003
last_revno, last_revision_id = self.last_revision_info()
1004
real_rev_history = list(self.repository.iter_reverse_revision_history(
1006
real_rev_history.reverse()
1007
if len(real_rev_history) != last_revno:
1008
raise errors.BzrCheckError('revno does not match len(mainline)'
1009
' %s != %s' % (last_revno, len(real_rev_history)))
1010
# TODO: We should probably also check that real_rev_history actually
1011
# matches self.revision_history()
1012
for revision_id in real_rev_history:
1014
revision = self.repository.get_revision(revision_id)
1015
except errors.NoSuchRevision, e:
1016
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1018
# In general the first entry on the revision history has no parents.
1019
# But it's not illegal for it to have parents listed; this can happen
1020
# in imports from Arch when the parents weren't reachable.
1021
if mainline_parent_id is not None:
1022
if mainline_parent_id not in revision.parent_ids:
1023
raise errors.BzrCheckError("previous revision {%s} not listed among "
1025
% (mainline_parent_id, revision_id))
1026
mainline_parent_id = revision_id
1027
return BranchCheckResult(self)
1029
def _get_checkout_format(self):
1030
"""Return the most suitable metadir for a checkout of this branch.
1031
Weaves are used if this branch's repository uses weaves.
1033
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1034
from bzrlib.repofmt import weaverepo
1035
format = bzrdir.BzrDirMetaFormat1()
1036
format.repository_format = weaverepo.RepositoryFormat7()
1038
format = self.repository.bzrdir.checkout_metadir()
1039
format.set_branch_format(self._format)
1042
def create_clone_on_transport(self, to_transport, revision_id=None,
1044
"""Create a clone of this branch and its bzrdir.
1046
:param to_transport: The transport to clone onto.
1047
:param revision_id: The revision id to use as tip in the new branch.
1048
If None the tip is obtained from this branch.
1049
:param stacked_on: An optional URL to stack the clone on.
1051
dir_to = self.bzrdir.clone_on_transport(to_transport,
1052
revision_id=revision_id, stacked_on=stacked_on)
1053
return dir_to.open_branch()
1055
def create_checkout(self, to_location, revision_id=None,
1056
lightweight=False, accelerator_tree=None,
1058
"""Create a checkout of a branch.
1060
:param to_location: The url to produce the checkout at
1061
:param revision_id: The revision to check out
1062
:param lightweight: If True, produce a lightweight checkout, otherwise,
1063
produce a bound branch (heavyweight checkout)
1064
:param accelerator_tree: A tree which can be used for retrieving file
1065
contents more quickly than the revision tree, i.e. a workingtree.
1066
The revision tree will be used for cases where accelerator_tree's
1067
content is different.
1068
:param hardlink: If true, hard-link files from accelerator_tree,
1070
:return: The tree of the created checkout
1072
t = transport.get_transport(to_location)
1075
format = self._get_checkout_format()
1076
checkout = format.initialize_on_transport(t)
1077
from_branch = BranchReferenceFormat().initialize(checkout, self)
1079
format = self._get_checkout_format()
1080
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1081
to_location, force_new_tree=False, format=format)
1082
checkout = checkout_branch.bzrdir
1083
checkout_branch.bind(self)
1084
# pull up to the specified revision_id to set the initial
1085
# branch tip correctly, and seed it with history.
1086
checkout_branch.pull(self, stop_revision=revision_id)
1088
tree = checkout.create_workingtree(revision_id,
1089
from_branch=from_branch,
1090
accelerator_tree=accelerator_tree,
1092
basis_tree = tree.basis_tree()
1093
basis_tree.lock_read()
1095
for path, file_id in basis_tree.iter_references():
1096
reference_parent = self.reference_parent(file_id, path)
1097
reference_parent.create_checkout(tree.abspath(path),
1098
basis_tree.get_reference_revision(file_id, path),
1105
def reconcile(self, thorough=True):
1106
"""Make sure the data stored in this branch is consistent."""
1107
from bzrlib.reconcile import BranchReconciler
1108
reconciler = BranchReconciler(self, thorough=thorough)
1109
reconciler.reconcile()
1112
def reference_parent(self, file_id, path):
1113
"""Return the parent branch for a tree-reference file_id
1114
:param file_id: The file_id of the tree reference
1115
:param path: The path of the file_id in the tree
1116
:return: A branch associated with the file_id
1118
# FIXME should provide multiple branches, based on config
1119
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1121
def supports_tags(self):
1122
return self._format.supports_tags()
1124
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1126
"""Ensure that revision_b is a descendant of revision_a.
1128
This is a helper function for update_revisions.
1130
:raises: DivergedBranches if revision_b has diverged from revision_a.
1131
:returns: True if revision_b is a descendant of revision_a.
1133
relation = self._revision_relations(revision_a, revision_b, graph)
1134
if relation == 'b_descends_from_a':
1136
elif relation == 'diverged':
1137
raise errors.DivergedBranches(self, other_branch)
1138
elif relation == 'a_descends_from_b':
1141
raise AssertionError("invalid relation: %r" % (relation,))
1143
def _revision_relations(self, revision_a, revision_b, graph):
1144
"""Determine the relationship between two revisions.
1146
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1148
heads = graph.heads([revision_a, revision_b])
1149
if heads == set([revision_b]):
1150
return 'b_descends_from_a'
1151
elif heads == set([revision_a, revision_b]):
1152
# These branches have diverged
1154
elif heads == set([revision_a]):
1155
return 'a_descends_from_b'
1157
raise AssertionError("invalid heads: %r" % (heads,))
1160
class BranchFormat(object):
1161
"""An encapsulation of the initialization and open routines for a format.
1163
Formats provide three things:
1164
* An initialization routine,
1168
Formats are placed in an dict by their format string for reference
1169
during branch opening. Its not required that these be instances, they
1170
can be classes themselves with class methods - it simply depends on
1171
whether state is needed for a given format or not.
1173
Once a format is deprecated, just deprecate the initialize and open
1174
methods on the format class. Do not deprecate the object, as the
1175
object will be created every time regardless.
1178
_default_format = None
1179
"""The default format used for new branches."""
1182
"""The known formats."""
1184
def __eq__(self, other):
1185
return self.__class__ is other.__class__
1187
def __ne__(self, other):
1188
return not (self == other)
1191
def find_format(klass, a_bzrdir):
1192
"""Return the format for the branch object in a_bzrdir."""
1194
transport = a_bzrdir.get_branch_transport(None)
1195
format_string = transport.get("format").read()
1196
return klass._formats[format_string]
1197
except errors.NoSuchFile:
1198
raise errors.NotBranchError(path=transport.base)
1200
raise errors.UnknownFormatError(format=format_string, kind='branch')
1203
def get_default_format(klass):
1204
"""Return the current default format."""
1205
return klass._default_format
1207
def get_reference(self, a_bzrdir):
1208
"""Get the target reference of the branch in a_bzrdir.
1210
format probing must have been completed before calling
1211
this method - it is assumed that the format of the branch
1212
in a_bzrdir is correct.
1214
:param a_bzrdir: The bzrdir to get the branch data from.
1215
:return: None if the branch is not a reference branch.
1220
def set_reference(self, a_bzrdir, to_branch):
1221
"""Set the target reference of the branch in a_bzrdir.
1223
format probing must have been completed before calling
1224
this method - it is assumed that the format of the branch
1225
in a_bzrdir is correct.
1227
:param a_bzrdir: The bzrdir to set the branch reference for.
1228
:param to_branch: branch that the checkout is to reference
1230
raise NotImplementedError(self.set_reference)
1232
def get_format_string(self):
1233
"""Return the ASCII format string that identifies this format."""
1234
raise NotImplementedError(self.get_format_string)
1236
def get_format_description(self):
1237
"""Return the short format description for this format."""
1238
raise NotImplementedError(self.get_format_description)
1240
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1242
"""Initialize a branch in a bzrdir, with specified files
1244
:param a_bzrdir: The bzrdir to initialize the branch in
1245
:param utf8_files: The files to create as a list of
1246
(filename, content) tuples
1247
:param set_format: If True, set the format with
1248
self.get_format_string. (BzrBranch4 has its format set
1250
:return: a branch in this format
1252
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1253
branch_transport = a_bzrdir.get_branch_transport(self)
1255
'metadir': ('lock', lockdir.LockDir),
1256
'branch4': ('branch-lock', lockable_files.TransportLock),
1258
lock_name, lock_class = lock_map[lock_type]
1259
control_files = lockable_files.LockableFiles(branch_transport,
1260
lock_name, lock_class)
1261
control_files.create_lock()
1262
control_files.lock_write()
1264
utf8_files += [('format', self.get_format_string())]
1266
for (filename, content) in utf8_files:
1267
branch_transport.put_bytes(
1269
mode=a_bzrdir._get_file_mode())
1271
control_files.unlock()
1272
return self.open(a_bzrdir, _found=True)
1274
def initialize(self, a_bzrdir):
1275
"""Create a branch of this format in a_bzrdir."""
1276
raise NotImplementedError(self.initialize)
1278
def is_supported(self):
1279
"""Is this format supported?
1281
Supported formats can be initialized and opened.
1282
Unsupported formats may not support initialization or committing or
1283
some other features depending on the reason for not being supported.
1287
def network_name(self):
1288
"""A simple byte string uniquely identifying this format for RPC calls.
1290
MetaDir branch formats use their disk format string to identify the
1291
repository over the wire. All in one formats such as bzr < 0.8, and
1292
foreign formats like svn/git and hg should use some marker which is
1293
unique and immutable.
1295
raise NotImplementedError(self.network_name)
1297
def open(self, a_bzrdir, _found=False):
1298
"""Return the branch object for a_bzrdir
1300
_found is a private parameter, do not use it. It is used to indicate
1301
if format probing has already be done.
1303
raise NotImplementedError(self.open)
1306
def register_format(klass, format):
1307
"""Register a metadir format."""
1308
klass._formats[format.get_format_string()] = format
1309
# Metadir formats have a network name of their format string.
1310
network_format_registry.register(format.get_format_string(), format)
1313
def set_default_format(klass, format):
1314
klass._default_format = format
1316
def supports_stacking(self):
1317
"""True if this format records a stacked-on branch."""
1321
def unregister_format(klass, format):
1322
del klass._formats[format.get_format_string()]
1325
return self.get_format_description().rstrip()
1327
def supports_tags(self):
1328
"""True if this format supports tags stored in the branch"""
1329
return False # by default
1332
class BranchHooks(Hooks):
1333
"""A dictionary mapping hook name to a list of callables for branch hooks.
1335
e.g. ['set_rh'] Is the list of items to be called when the
1336
set_revision_history function is invoked.
1340
"""Create the default hooks.
1342
These are all empty initially, because by default nothing should get
1345
Hooks.__init__(self)
1346
# Introduced in 0.15:
1347
# invoked whenever the revision history has been set
1348
# with set_revision_history. The api signature is
1349
# (branch, revision_history), and the branch will
1352
# Invoked after a branch is opened. The api signature is (branch).
1354
# invoked after a push operation completes.
1355
# the api signature is
1357
# containing the members
1358
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1359
# where local is the local target branch or None, master is the target
1360
# master branch, and the rest should be self explanatory. The source
1361
# is read locked and the target branches write locked. Source will
1362
# be the local low-latency branch.
1363
self['post_push'] = []
1364
# invoked after a pull operation completes.
1365
# the api signature is
1367
# containing the members
1368
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1369
# where local is the local branch or None, master is the target
1370
# master branch, and the rest should be self explanatory. The source
1371
# is read locked and the target branches write locked. The local
1372
# branch is the low-latency branch.
1373
self['post_pull'] = []
1374
# invoked before a commit operation takes place.
1375
# the api signature is
1376
# (local, master, old_revno, old_revid, future_revno, future_revid,
1377
# tree_delta, future_tree).
1378
# old_revid is NULL_REVISION for the first commit to a branch
1379
# tree_delta is a TreeDelta object describing changes from the basis
1380
# revision, hooks MUST NOT modify this delta
1381
# future_tree is an in-memory tree obtained from
1382
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1383
self['pre_commit'] = []
1384
# invoked after a commit operation completes.
1385
# the api signature is
1386
# (local, master, old_revno, old_revid, new_revno, new_revid)
1387
# old_revid is NULL_REVISION for the first commit to a branch.
1388
self['post_commit'] = []
1389
# invoked after a uncommit operation completes.
1390
# the api signature is
1391
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1392
# local is the local branch or None, master is the target branch,
1393
# and an empty branch recieves new_revno of 0, new_revid of None.
1394
self['post_uncommit'] = []
1396
# Invoked before the tip of a branch changes.
1397
# the api signature is
1398
# (params) where params is a ChangeBranchTipParams with the members
1399
# (branch, old_revno, new_revno, old_revid, new_revid)
1400
self['pre_change_branch_tip'] = []
1402
# Invoked after the tip of a branch changes.
1403
# the api signature is
1404
# (params) where params is a ChangeBranchTipParams with the members
1405
# (branch, old_revno, new_revno, old_revid, new_revid)
1406
self['post_change_branch_tip'] = []
1408
# Invoked when a stacked branch activates its fallback locations and
1409
# allows the transformation of the url of said location.
1410
# the api signature is
1411
# (branch, url) where branch is the branch having its fallback
1412
# location activated and url is the url for the fallback location.
1413
# The hook should return a url.
1414
self['transform_fallback_location'] = []
1417
# install the default hooks into the Branch class.
1418
Branch.hooks = BranchHooks()
1421
class ChangeBranchTipParams(object):
1422
"""Object holding parameters passed to *_change_branch_tip hooks.
1424
There are 5 fields that hooks may wish to access:
1426
:ivar branch: the branch being changed
1427
:ivar old_revno: revision number before the change
1428
:ivar new_revno: revision number after the change
1429
:ivar old_revid: revision id before the change
1430
:ivar new_revid: revision id after the change
1432
The revid fields are strings. The revno fields are integers.
1435
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1436
"""Create a group of ChangeBranchTip parameters.
1438
:param branch: The branch being changed.
1439
:param old_revno: Revision number before the change.
1440
:param new_revno: Revision number after the change.
1441
:param old_revid: Tip revision id before the change.
1442
:param new_revid: Tip revision id after the change.
1444
self.branch = branch
1445
self.old_revno = old_revno
1446
self.new_revno = new_revno
1447
self.old_revid = old_revid
1448
self.new_revid = new_revid
1450
def __eq__(self, other):
1451
return self.__dict__ == other.__dict__
1454
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1455
self.__class__.__name__, self.branch,
1456
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1459
class BzrBranchFormat4(BranchFormat):
1460
"""Bzr branch format 4.
1463
- a revision-history file.
1464
- a branch-lock lock file [ to be shared with the bzrdir ]
1467
def get_format_description(self):
1468
"""See BranchFormat.get_format_description()."""
1469
return "Branch format 4"
1471
def initialize(self, a_bzrdir):
1472
"""Create a branch of this format in a_bzrdir."""
1473
utf8_files = [('revision-history', ''),
1474
('branch-name', ''),
1476
return self._initialize_helper(a_bzrdir, utf8_files,
1477
lock_type='branch4', set_format=False)
1480
super(BzrBranchFormat4, self).__init__()
1481
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1483
def network_name(self):
1484
"""The network name for this format is the control dirs disk label."""
1485
return self._matchingbzrdir.get_format_string()
1487
def open(self, a_bzrdir, _found=False):
1488
"""Return the branch object for a_bzrdir
1490
_found is a private parameter, do not use it. It is used to indicate
1491
if format probing has already be done.
1494
# we are being called directly and must probe.
1495
raise NotImplementedError
1496
return BzrBranch(_format=self,
1497
_control_files=a_bzrdir._control_files,
1499
_repository=a_bzrdir.open_repository())
1502
return "Bazaar-NG branch format 4"
1505
class BranchFormatMetadir(BranchFormat):
1506
"""Common logic for meta-dir based branch formats."""
1508
def _branch_class(self):
1509
"""What class to instantiate on open calls."""
1510
raise NotImplementedError(self._branch_class)
1512
def network_name(self):
1513
"""A simple byte string uniquely identifying this format for RPC calls.
1515
Metadir branch formats use their format string.
1517
return self.get_format_string()
1519
def open(self, a_bzrdir, _found=False):
1520
"""Return the branch object for a_bzrdir.
1522
_found is a private parameter, do not use it. It is used to indicate
1523
if format probing has already be done.
1526
format = BranchFormat.find_format(a_bzrdir)
1527
if format.__class__ != self.__class__:
1528
raise AssertionError("wrong format %r found for %r" %
1531
transport = a_bzrdir.get_branch_transport(None)
1532
control_files = lockable_files.LockableFiles(transport, 'lock',
1534
return self._branch_class()(_format=self,
1535
_control_files=control_files,
1537
_repository=a_bzrdir.find_repository())
1538
except errors.NoSuchFile:
1539
raise errors.NotBranchError(path=transport.base)
1542
super(BranchFormatMetadir, self).__init__()
1543
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1544
self._matchingbzrdir.set_branch_format(self)
1546
def supports_tags(self):
1550
class BzrBranchFormat5(BranchFormatMetadir):
1551
"""Bzr branch format 5.
1554
- a revision-history file.
1556
- a lock dir guarding the branch itself
1557
- all of this stored in a branch/ subdirectory
1558
- works with shared repositories.
1560
This format is new in bzr 0.8.
1563
def _branch_class(self):
1566
def get_format_string(self):
1567
"""See BranchFormat.get_format_string()."""
1568
return "Bazaar-NG branch format 5\n"
1570
def get_format_description(self):
1571
"""See BranchFormat.get_format_description()."""
1572
return "Branch format 5"
1574
def initialize(self, a_bzrdir):
1575
"""Create a branch of this format in a_bzrdir."""
1576
utf8_files = [('revision-history', ''),
1577
('branch-name', ''),
1579
return self._initialize_helper(a_bzrdir, utf8_files)
1581
def supports_tags(self):
1585
class BzrBranchFormat6(BranchFormatMetadir):
1586
"""Branch format with last-revision and tags.
1588
Unlike previous formats, this has no explicit revision history. Instead,
1589
this just stores the last-revision, and the left-hand history leading
1590
up to there is the history.
1592
This format was introduced in bzr 0.15
1593
and became the default in 0.91.
1596
def _branch_class(self):
1599
def get_format_string(self):
1600
"""See BranchFormat.get_format_string()."""
1601
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1603
def get_format_description(self):
1604
"""See BranchFormat.get_format_description()."""
1605
return "Branch format 6"
1607
def initialize(self, a_bzrdir):
1608
"""Create a branch of this format in a_bzrdir."""
1609
utf8_files = [('last-revision', '0 null:\n'),
1610
('branch.conf', ''),
1613
return self._initialize_helper(a_bzrdir, utf8_files)
1616
class BzrBranchFormat7(BranchFormatMetadir):
1617
"""Branch format with last-revision, tags, and a stacked location pointer.
1619
The stacked location pointer is passed down to the repository and requires
1620
a repository format with supports_external_lookups = True.
1622
This format was introduced in bzr 1.6.
1625
def _branch_class(self):
1628
def get_format_string(self):
1629
"""See BranchFormat.get_format_string()."""
1630
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1632
def get_format_description(self):
1633
"""See BranchFormat.get_format_description()."""
1634
return "Branch format 7"
1636
def initialize(self, a_bzrdir):
1637
"""Create a branch of this format in a_bzrdir."""
1638
utf8_files = [('last-revision', '0 null:\n'),
1639
('branch.conf', ''),
1642
return self._initialize_helper(a_bzrdir, utf8_files)
1645
super(BzrBranchFormat7, self).__init__()
1646
self._matchingbzrdir.repository_format = \
1647
RepositoryFormatKnitPack5RichRoot()
1649
def supports_stacking(self):
1653
class BranchReferenceFormat(BranchFormat):
1654
"""Bzr branch reference format.
1656
Branch references are used in implementing checkouts, they
1657
act as an alias to the real branch which is at some other url.
1664
def get_format_string(self):
1665
"""See BranchFormat.get_format_string()."""
1666
return "Bazaar-NG Branch Reference Format 1\n"
1668
def get_format_description(self):
1669
"""See BranchFormat.get_format_description()."""
1670
return "Checkout reference format 1"
1672
def get_reference(self, a_bzrdir):
1673
"""See BranchFormat.get_reference()."""
1674
transport = a_bzrdir.get_branch_transport(None)
1675
return transport.get('location').read()
1677
def set_reference(self, a_bzrdir, to_branch):
1678
"""See BranchFormat.set_reference()."""
1679
transport = a_bzrdir.get_branch_transport(None)
1680
location = transport.put_bytes('location', to_branch.base)
1682
def initialize(self, a_bzrdir, target_branch=None):
1683
"""Create a branch of this format in a_bzrdir."""
1684
if target_branch is None:
1685
# this format does not implement branch itself, thus the implicit
1686
# creation contract must see it as uninitializable
1687
raise errors.UninitializableFormat(self)
1688
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1689
branch_transport = a_bzrdir.get_branch_transport(self)
1690
branch_transport.put_bytes('location',
1691
target_branch.bzrdir.root_transport.base)
1692
branch_transport.put_bytes('format', self.get_format_string())
1694
a_bzrdir, _found=True,
1695
possible_transports=[target_branch.bzrdir.root_transport])
1698
super(BranchReferenceFormat, self).__init__()
1699
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1700
self._matchingbzrdir.set_branch_format(self)
1702
def _make_reference_clone_function(format, a_branch):
1703
"""Create a clone() routine for a branch dynamically."""
1704
def clone(to_bzrdir, revision_id=None):
1705
"""See Branch.clone()."""
1706
return format.initialize(to_bzrdir, a_branch)
1707
# cannot obey revision_id limits when cloning a reference ...
1708
# FIXME RBC 20060210 either nuke revision_id for clone, or
1709
# emit some sort of warning/error to the caller ?!
1712
def open(self, a_bzrdir, _found=False, location=None,
1713
possible_transports=None):
1714
"""Return the branch that the branch reference in a_bzrdir points at.
1716
_found is a private parameter, do not use it. It is used to indicate
1717
if format probing has already be done.
1720
format = BranchFormat.find_format(a_bzrdir)
1721
if format.__class__ != self.__class__:
1722
raise AssertionError("wrong format %r found for %r" %
1724
if location is None:
1725
location = self.get_reference(a_bzrdir)
1726
real_bzrdir = bzrdir.BzrDir.open(
1727
location, possible_transports=possible_transports)
1728
result = real_bzrdir.open_branch()
1729
# this changes the behaviour of result.clone to create a new reference
1730
# rather than a copy of the content of the branch.
1731
# I did not use a proxy object because that needs much more extensive
1732
# testing, and we are only changing one behaviour at the moment.
1733
# If we decide to alter more behaviours - i.e. the implicit nickname
1734
# then this should be refactored to introduce a tested proxy branch
1735
# and a subclass of that for use in overriding clone() and ....
1737
result.clone = self._make_reference_clone_function(result)
1741
network_format_registry = registry.FormatRegistry()
1742
"""Registry of formats indexed by their network name.
1744
The network name for a repository format is an identifier that can be used when
1745
referring to formats with smart server operations. See
1746
BranchFormat.network_name() for more detail.
1750
# formats which have no format string are not discoverable
1751
# and not independently creatable, so are not registered.
1752
__format5 = BzrBranchFormat5()
1753
__format6 = BzrBranchFormat6()
1754
__format7 = BzrBranchFormat7()
1755
BranchFormat.register_format(__format5)
1756
BranchFormat.register_format(BranchReferenceFormat())
1757
BranchFormat.register_format(__format6)
1758
BranchFormat.register_format(__format7)
1759
BranchFormat.set_default_format(__format6)
1760
_legacy_formats = [BzrBranchFormat4(),
1762
network_format_registry.register(
1763
_legacy_formats[0].network_name(), _legacy_formats[0])
1766
class BzrBranch(Branch):
1767
"""A branch stored in the actual filesystem.
1769
Note that it's "local" in the context of the filesystem; it doesn't
1770
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1771
it's writable, and can be accessed via the normal filesystem API.
1773
:ivar _transport: Transport for file operations on this branch's
1774
control files, typically pointing to the .bzr/branch directory.
1775
:ivar repository: Repository for this branch.
1776
:ivar base: The url of the base directory for this branch; the one
1777
containing the .bzr directory.
1780
def __init__(self, _format=None,
1781
_control_files=None, a_bzrdir=None, _repository=None):
1782
"""Create new branch object at a particular location."""
1783
if a_bzrdir is None:
1784
raise ValueError('a_bzrdir must be supplied')
1786
self.bzrdir = a_bzrdir
1787
self._base = self.bzrdir.transport.clone('..').base
1788
# XXX: We should be able to just do
1789
# self.base = self.bzrdir.root_transport.base
1790
# but this does not quite work yet -- mbp 20080522
1791
self._format = _format
1792
if _control_files is None:
1793
raise ValueError('BzrBranch _control_files is None')
1794
self.control_files = _control_files
1795
self._transport = _control_files._transport
1796
self.repository = _repository
1797
Branch.__init__(self)
1800
return '%s(%r)' % (self.__class__.__name__, self.base)
1804
def _get_base(self):
1805
"""Returns the directory containing the control directory."""
1808
base = property(_get_base, doc="The URL for the root of this branch.")
1810
def is_locked(self):
1811
return self.control_files.is_locked()
1813
def lock_write(self, token=None):
1814
repo_token = self.repository.lock_write()
1816
token = self.control_files.lock_write(token=token)
1818
self.repository.unlock()
1822
def lock_read(self):
1823
self.repository.lock_read()
1825
self.control_files.lock_read()
1827
self.repository.unlock()
1831
# TODO: test for failed two phase locks. This is known broken.
1833
self.control_files.unlock()
1835
self.repository.unlock()
1836
if not self.control_files.is_locked():
1837
# we just released the lock
1838
self._clear_cached_state()
1840
def peek_lock_mode(self):
1841
if self.control_files._lock_count == 0:
1844
return self.control_files._lock_mode
1846
def get_physical_lock_status(self):
1847
return self.control_files.get_physical_lock_status()
1850
def print_file(self, file, revision_id):
1851
"""See Branch.print_file."""
1852
return self.repository.print_file(file, revision_id)
1854
def _write_revision_history(self, history):
1855
"""Factored out of set_revision_history.
1857
This performs the actual writing to disk.
1858
It is intended to be called by BzrBranch5.set_revision_history."""
1859
self._transport.put_bytes(
1860
'revision-history', '\n'.join(history),
1861
mode=self.bzrdir._get_file_mode())
1864
def set_revision_history(self, rev_history):
1865
"""See Branch.set_revision_history."""
1866
if 'evil' in debug.debug_flags:
1867
mutter_callsite(3, "set_revision_history scales with history.")
1868
check_not_reserved_id = _mod_revision.check_not_reserved_id
1869
for rev_id in rev_history:
1870
check_not_reserved_id(rev_id)
1871
if Branch.hooks['post_change_branch_tip']:
1872
# Don't calculate the last_revision_info() if there are no hooks
1874
old_revno, old_revid = self.last_revision_info()
1875
if len(rev_history) == 0:
1876
revid = _mod_revision.NULL_REVISION
1878
revid = rev_history[-1]
1879
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1880
self._write_revision_history(rev_history)
1881
self._clear_cached_state()
1882
self._cache_revision_history(rev_history)
1883
for hook in Branch.hooks['set_rh']:
1884
hook(self, rev_history)
1885
if Branch.hooks['post_change_branch_tip']:
1886
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1888
def _synchronize_history(self, destination, revision_id):
1889
"""Synchronize last revision and revision history between branches.
1891
This version is most efficient when the destination is also a
1892
BzrBranch5, but works for BzrBranch6 as long as the revision
1893
history is the true lefthand parent history, and all of the revisions
1894
are in the destination's repository. If not, set_revision_history
1897
:param destination: The branch to copy the history into
1898
:param revision_id: The revision-id to truncate history at. May
1899
be None to copy complete history.
1901
if not isinstance(destination._format, BzrBranchFormat5):
1902
super(BzrBranch, self)._synchronize_history(
1903
destination, revision_id)
1905
if revision_id == _mod_revision.NULL_REVISION:
1908
new_history = self.revision_history()
1909
if revision_id is not None and new_history != []:
1911
new_history = new_history[:new_history.index(revision_id) + 1]
1913
rev = self.repository.get_revision(revision_id)
1914
new_history = rev.get_history(self.repository)[1:]
1915
destination.set_revision_history(new_history)
1918
def set_last_revision_info(self, revno, revision_id):
1919
"""Set the last revision of this branch.
1921
The caller is responsible for checking that the revno is correct
1922
for this revision id.
1924
It may be possible to set the branch last revision to an id not
1925
present in the repository. However, branches can also be
1926
configured to check constraints on history, in which case this may not
1929
revision_id = _mod_revision.ensure_null(revision_id)
1930
# this old format stores the full history, but this api doesn't
1931
# provide it, so we must generate, and might as well check it's
1933
history = self._lefthand_history(revision_id)
1934
if len(history) != revno:
1935
raise AssertionError('%d != %d' % (len(history), revno))
1936
self.set_revision_history(history)
1938
def _gen_revision_history(self):
1939
history = self._transport.get_bytes('revision-history').split('\n')
1940
if history[-1:] == ['']:
1941
# There shouldn't be a trailing newline, but just in case.
1946
def generate_revision_history(self, revision_id, last_rev=None,
1948
"""Create a new revision history that will finish with revision_id.
1950
:param revision_id: the new tip to use.
1951
:param last_rev: The previous last_revision. If not None, then this
1952
must be a ancestory of revision_id, or DivergedBranches is raised.
1953
:param other_branch: The other branch that DivergedBranches should
1954
raise with respect to.
1956
self.set_revision_history(self._lefthand_history(revision_id,
1957
last_rev, other_branch))
1959
def basis_tree(self):
1960
"""See Branch.basis_tree."""
1961
return self.repository.revision_tree(self.last_revision())
1964
def pull(self, source, overwrite=False, stop_revision=None,
1965
_hook_master=None, run_hooks=True, possible_transports=None,
1966
_override_hook_target=None):
1969
:param _hook_master: Private parameter - set the branch to
1970
be supplied as the master to pull hooks.
1971
:param run_hooks: Private parameter - if false, this branch
1972
is being called because it's the master of the primary branch,
1973
so it should not run its hooks.
1974
:param _override_hook_target: Private parameter - set the branch to be
1975
supplied as the target_branch to pull hooks.
1977
result = PullResult()
1978
result.source_branch = source
1979
if _override_hook_target is None:
1980
result.target_branch = self
1982
result.target_branch = _override_hook_target
1985
# We assume that during 'pull' the local repository is closer than
1987
graph = self.repository.get_graph(source.repository)
1988
result.old_revno, result.old_revid = self.last_revision_info()
1989
self.update_revisions(source, stop_revision, overwrite=overwrite,
1991
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1992
result.new_revno, result.new_revid = self.last_revision_info()
1994
result.master_branch = _hook_master
1995
result.local_branch = result.target_branch
1997
result.master_branch = result.target_branch
1998
result.local_branch = None
2000
for hook in Branch.hooks['post_pull']:
2006
def _get_parent_location(self):
2007
_locs = ['parent', 'pull', 'x-pull']
2010
return self._transport.get_bytes(l).strip('\n')
2011
except errors.NoSuchFile:
2016
def push(self, target, overwrite=False, stop_revision=None,
2017
_override_hook_source_branch=None):
2020
This is the basic concrete implementation of push()
2022
:param _override_hook_source_branch: If specified, run
2023
the hooks passing this Branch as the source, rather than self.
2024
This is for use of RemoteBranch, where push is delegated to the
2025
underlying vfs-based Branch.
2027
# TODO: Public option to disable running hooks - should be trivial but
2029
return _run_with_write_locked_target(
2030
target, self._push_with_bound_branches, target, overwrite,
2032
_override_hook_source_branch=_override_hook_source_branch)
2034
def _push_with_bound_branches(self, target, overwrite,
2036
_override_hook_source_branch=None):
2037
"""Push from self into target, and into target's master if any.
2039
This is on the base BzrBranch class even though it doesn't support
2040
bound branches because the *target* might be bound.
2043
if _override_hook_source_branch:
2044
result.source_branch = _override_hook_source_branch
2045
for hook in Branch.hooks['post_push']:
2048
bound_location = target.get_bound_location()
2049
if bound_location and target.base != bound_location:
2050
# there is a master branch.
2052
# XXX: Why the second check? Is it even supported for a branch to
2053
# be bound to itself? -- mbp 20070507
2054
master_branch = target.get_master_branch()
2055
master_branch.lock_write()
2057
# push into the master from this branch.
2058
self._basic_push(master_branch, overwrite, stop_revision)
2059
# and push into the target branch from this. Note that we push from
2060
# this branch again, because its considered the highest bandwidth
2062
result = self._basic_push(target, overwrite, stop_revision)
2063
result.master_branch = master_branch
2064
result.local_branch = target
2068
master_branch.unlock()
2071
result = self._basic_push(target, overwrite, stop_revision)
2072
# TODO: Why set master_branch and local_branch if there's no
2073
# binding? Maybe cleaner to just leave them unset? -- mbp
2075
result.master_branch = target
2076
result.local_branch = None
2080
def _basic_push(self, target, overwrite, stop_revision):
2081
"""Basic implementation of push without bound branches or hooks.
2083
Must be called with self read locked and target write locked.
2085
result = PushResult()
2086
result.source_branch = self
2087
result.target_branch = target
2088
result.old_revno, result.old_revid = target.last_revision_info()
2089
if result.old_revid != self.last_revision():
2090
# We assume that during 'push' this repository is closer than
2092
graph = self.repository.get_graph(target.repository)
2093
target.update_revisions(self, stop_revision, overwrite=overwrite,
2095
if self._push_should_merge_tags():
2096
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2097
result.new_revno, result.new_revid = target.last_revision_info()
2100
def get_parent(self):
2101
"""See Branch.get_parent."""
2102
parent = self._get_parent_location()
2105
# This is an old-format absolute path to a local branch
2106
# turn it into a url
2107
if parent.startswith('/'):
2108
parent = urlutils.local_path_to_url(parent.decode('utf8'))
2110
return urlutils.join(self.base[:-1], parent)
2111
except errors.InvalidURLJoin, e:
2112
raise errors.InaccessibleParent(parent, self.base)
2114
def get_stacked_on_url(self):
2115
raise errors.UnstackableBranchFormat(self._format, self.base)
2117
def set_push_location(self, location):
2118
"""See Branch.set_push_location."""
2119
self.get_config().set_user_option(
2120
'push_location', location,
2121
store=_mod_config.STORE_LOCATION_NORECURSE)
2124
def set_parent(self, url):
2125
"""See Branch.set_parent."""
2126
# TODO: Maybe delete old location files?
2127
# URLs should never be unicode, even on the local fs,
2128
# FIXUP this and get_parent in a future branch format bump:
2129
# read and rewrite the file. RBC 20060125
2131
if isinstance(url, unicode):
2133
url = url.encode('ascii')
2134
except UnicodeEncodeError:
2135
raise errors.InvalidURL(url,
2136
"Urls must be 7-bit ascii, "
2137
"use bzrlib.urlutils.escape")
2138
url = urlutils.relative_url(self.base, url)
2139
self._set_parent_location(url)
2141
def _set_parent_location(self, url):
2143
self._transport.delete('parent')
2145
self._transport.put_bytes('parent', url + '\n',
2146
mode=self.bzrdir._get_file_mode())
2148
def set_stacked_on_url(self, url):
2149
raise errors.UnstackableBranchFormat(self._format, self.base)
2152
class BzrBranch5(BzrBranch):
2153
"""A format 5 branch. This supports new features over plain branches.
2155
It has support for a master_branch which is the data for bound branches.
2159
def pull(self, source, overwrite=False, stop_revision=None,
2160
run_hooks=True, possible_transports=None,
2161
_override_hook_target=None):
2162
"""Pull from source into self, updating my master if any.
2164
:param run_hooks: Private parameter - if false, this branch
2165
is being called because it's the master of the primary branch,
2166
so it should not run its hooks.
2168
bound_location = self.get_bound_location()
2169
master_branch = None
2170
if bound_location and source.base != bound_location:
2171
# not pulling from master, so we need to update master.
2172
master_branch = self.get_master_branch(possible_transports)
2173
master_branch.lock_write()
2176
# pull from source into master.
2177
master_branch.pull(source, overwrite, stop_revision,
2179
return super(BzrBranch5, self).pull(source, overwrite,
2180
stop_revision, _hook_master=master_branch,
2181
run_hooks=run_hooks,
2182
_override_hook_target=_override_hook_target)
2185
master_branch.unlock()
2187
def get_bound_location(self):
2189
return self._transport.get_bytes('bound')[:-1]
2190
except errors.NoSuchFile:
2194
def get_master_branch(self, possible_transports=None):
2195
"""Return the branch we are bound to.
2197
:return: Either a Branch, or None
2199
This could memoise the branch, but if thats done
2200
it must be revalidated on each new lock.
2201
So for now we just don't memoise it.
2202
# RBC 20060304 review this decision.
2204
bound_loc = self.get_bound_location()
2208
return Branch.open(bound_loc,
2209
possible_transports=possible_transports)
2210
except (errors.NotBranchError, errors.ConnectionError), e:
2211
raise errors.BoundBranchConnectionFailure(
2215
def set_bound_location(self, location):
2216
"""Set the target where this branch is bound to.
2218
:param location: URL to the target branch
2221
self._transport.put_bytes('bound', location+'\n',
2222
mode=self.bzrdir._get_file_mode())
2225
self._transport.delete('bound')
2226
except errors.NoSuchFile:
2231
def bind(self, other):
2232
"""Bind this branch to the branch other.
2234
This does not push or pull data between the branches, though it does
2235
check for divergence to raise an error when the branches are not
2236
either the same, or one a prefix of the other. That behaviour may not
2237
be useful, so that check may be removed in future.
2239
:param other: The branch to bind to
2242
# TODO: jam 20051230 Consider checking if the target is bound
2243
# It is debatable whether you should be able to bind to
2244
# a branch which is itself bound.
2245
# Committing is obviously forbidden,
2246
# but binding itself may not be.
2247
# Since we *have* to check at commit time, we don't
2248
# *need* to check here
2250
# we want to raise diverged if:
2251
# last_rev is not in the other_last_rev history, AND
2252
# other_last_rev is not in our history, and do it without pulling
2254
self.set_bound_location(other.base)
2258
"""If bound, unbind"""
2259
return self.set_bound_location(None)
2262
def update(self, possible_transports=None):
2263
"""Synchronise this branch with the master branch if any.
2265
:return: None or the last_revision that was pivoted out during the
2268
master = self.get_master_branch(possible_transports)
2269
if master is not None:
2270
old_tip = _mod_revision.ensure_null(self.last_revision())
2271
self.pull(master, overwrite=True)
2272
if self.repository.get_graph().is_ancestor(old_tip,
2273
_mod_revision.ensure_null(self.last_revision())):
2279
class BzrBranch7(BzrBranch5):
2280
"""A branch with support for a fallback repository."""
2282
def _get_fallback_repository(self, url):
2283
"""Get the repository we fallback to at url."""
2284
url = urlutils.join(self.base, url)
2285
a_bzrdir = bzrdir.BzrDir.open(url,
2286
possible_transports=[self._transport])
2287
return a_bzrdir.open_branch().repository
2289
def _activate_fallback_location(self, url):
2290
"""Activate the branch/repository from url as a fallback repository."""
2291
self.repository.add_fallback_repository(
2292
self._get_fallback_repository(url))
2294
def _open_hook(self):
2296
url = self.get_stacked_on_url()
2297
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2298
errors.UnstackableBranchFormat):
2301
for hook in Branch.hooks['transform_fallback_location']:
2302
url = hook(self, url)
2304
hook_name = Branch.hooks.get_hook_name(hook)
2305
raise AssertionError(
2306
"'transform_fallback_location' hook %s returned "
2307
"None, not a URL." % hook_name)
2308
self._activate_fallback_location(url)
2310
def _check_stackable_repo(self):
2311
if not self.repository._format.supports_external_lookups:
2312
raise errors.UnstackableRepositoryFormat(self.repository._format,
2313
self.repository.base)
2315
def __init__(self, *args, **kwargs):
2316
super(BzrBranch7, self).__init__(*args, **kwargs)
2317
self._last_revision_info_cache = None
2318
self._partial_revision_history_cache = []
2320
def _clear_cached_state(self):
2321
super(BzrBranch7, self)._clear_cached_state()
2322
self._last_revision_info_cache = None
2323
self._partial_revision_history_cache = []
2325
def _last_revision_info(self):
2326
revision_string = self._transport.get_bytes('last-revision')
2327
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2328
revision_id = cache_utf8.get_cached_utf8(revision_id)
2330
return revno, revision_id
2332
def _write_last_revision_info(self, revno, revision_id):
2333
"""Simply write out the revision id, with no checks.
2335
Use set_last_revision_info to perform this safely.
2337
Does not update the revision_history cache.
2338
Intended to be called by set_last_revision_info and
2339
_write_revision_history.
2341
revision_id = _mod_revision.ensure_null(revision_id)
2342
out_string = '%d %s\n' % (revno, revision_id)
2343
self._transport.put_bytes('last-revision', out_string,
2344
mode=self.bzrdir._get_file_mode())
2347
def set_last_revision_info(self, revno, revision_id):
2348
revision_id = _mod_revision.ensure_null(revision_id)
2349
old_revno, old_revid = self.last_revision_info()
2350
if self._get_append_revisions_only():
2351
self._check_history_violation(revision_id)
2352
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2353
self._write_last_revision_info(revno, revision_id)
2354
self._clear_cached_state()
2355
self._last_revision_info_cache = revno, revision_id
2356
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2358
def _synchronize_history(self, destination, revision_id):
2359
"""Synchronize last revision and revision history between branches.
2361
:see: Branch._synchronize_history
2363
# XXX: The base Branch has a fast implementation of this method based
2364
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2365
# that uses set_revision_history. This class inherits from BzrBranch5,
2366
# but wants the fast implementation, so it calls
2367
# Branch._synchronize_history directly.
2368
Branch._synchronize_history(self, destination, revision_id)
2370
def _check_history_violation(self, revision_id):
2371
last_revision = _mod_revision.ensure_null(self.last_revision())
2372
if _mod_revision.is_null(last_revision):
2374
if last_revision not in self._lefthand_history(revision_id):
2375
raise errors.AppendRevisionsOnlyViolation(self.base)
2377
def _gen_revision_history(self):
2378
"""Generate the revision history from last revision
2380
last_revno, last_revision = self.last_revision_info()
2381
self._extend_partial_history(stop_index=last_revno-1)
2382
return list(reversed(self._partial_revision_history_cache))
2384
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2385
"""Extend the partial history to include a given index
2387
If a stop_index is supplied, stop when that index has been reached.
2388
If a stop_revision is supplied, stop when that revision is
2389
encountered. Otherwise, stop when the beginning of history is
2392
:param stop_index: The index which should be present. When it is
2393
present, history extension will stop.
2394
:param revision_id: The revision id which should be present. When
2395
it is encountered, history extension will stop.
2397
repo = self.repository
2398
if len(self._partial_revision_history_cache) == 0:
2399
iterator = repo.iter_reverse_revision_history(self.last_revision())
2401
start_revision = self._partial_revision_history_cache[-1]
2402
iterator = repo.iter_reverse_revision_history(start_revision)
2403
#skip the last revision in the list
2404
next_revision = iterator.next()
2405
for revision_id in iterator:
2406
self._partial_revision_history_cache.append(revision_id)
2407
if (stop_index is not None and
2408
len(self._partial_revision_history_cache) > stop_index):
2410
if revision_id == stop_revision:
2413
def _write_revision_history(self, history):
2414
"""Factored out of set_revision_history.
2416
This performs the actual writing to disk, with format-specific checks.
2417
It is intended to be called by BzrBranch5.set_revision_history.
2419
if len(history) == 0:
2420
last_revision = 'null:'
2422
if history != self._lefthand_history(history[-1]):
2423
raise errors.NotLefthandHistory(history)
2424
last_revision = history[-1]
2425
if self._get_append_revisions_only():
2426
self._check_history_violation(last_revision)
2427
self._write_last_revision_info(len(history), last_revision)
2430
def _set_parent_location(self, url):
2431
"""Set the parent branch"""
2432
self._set_config_location('parent_location', url, make_relative=True)
2435
def _get_parent_location(self):
2436
"""Set the parent branch"""
2437
return self._get_config_location('parent_location')
2439
def set_push_location(self, location):
2440
"""See Branch.set_push_location."""
2441
self._set_config_location('push_location', location)
2443
def set_bound_location(self, location):
2444
"""See Branch.set_push_location."""
2446
config = self.get_config()
2447
if location is None:
2448
if config.get_user_option('bound') != 'True':
2451
config.set_user_option('bound', 'False', warn_masked=True)
2454
self._set_config_location('bound_location', location,
2456
config.set_user_option('bound', 'True', warn_masked=True)
2459
def _get_bound_location(self, bound):
2460
"""Return the bound location in the config file.
2462
Return None if the bound parameter does not match"""
2463
config = self.get_config()
2464
config_bound = (config.get_user_option('bound') == 'True')
2465
if config_bound != bound:
2467
return self._get_config_location('bound_location', config=config)
2469
def get_bound_location(self):
2470
"""See Branch.set_push_location."""
2471
return self._get_bound_location(True)
2473
def get_old_bound_location(self):
2474
"""See Branch.get_old_bound_location"""
2475
return self._get_bound_location(False)
2477
def get_stacked_on_url(self):
2478
# you can always ask for the URL; but you might not be able to use it
2479
# if the repo can't support stacking.
2480
## self._check_stackable_repo()
2481
stacked_url = self._get_config_location('stacked_on_location')
2482
if stacked_url is None:
2483
raise errors.NotStacked(self)
2486
def set_append_revisions_only(self, enabled):
2491
self.get_config().set_user_option('append_revisions_only', value,
2494
def set_stacked_on_url(self, url):
2495
self._check_stackable_repo()
2498
old_url = self.get_stacked_on_url()
2499
except (errors.NotStacked, errors.UnstackableBranchFormat,
2500
errors.UnstackableRepositoryFormat):
2503
# repositories don't offer an interface to remove fallback
2504
# repositories today; take the conceptually simpler option and just
2506
self.repository = self.bzrdir.find_repository()
2507
# for every revision reference the branch has, ensure it is pulled
2509
source_repository = self._get_fallback_repository(old_url)
2510
for revision_id in chain([self.last_revision()],
2511
self.tags.get_reverse_tag_dict()):
2512
self.repository.fetch(source_repository, revision_id,
2515
self._activate_fallback_location(url)
2516
# write this out after the repository is stacked to avoid setting a
2517
# stacked config that doesn't work.
2518
self._set_config_location('stacked_on_location', url)
2520
def _get_append_revisions_only(self):
2521
value = self.get_config().get_user_option('append_revisions_only')
2522
return value == 'True'
2524
def _make_tags(self):
2525
return BasicTags(self)
2528
def generate_revision_history(self, revision_id, last_rev=None,
2530
"""See BzrBranch5.generate_revision_history"""
2531
history = self._lefthand_history(revision_id, last_rev, other_branch)
2532
revno = len(history)
2533
self.set_last_revision_info(revno, revision_id)
2536
def get_rev_id(self, revno, history=None):
2537
"""Find the revision id of the specified revno."""
2539
return _mod_revision.NULL_REVISION
2541
last_revno, last_revision_id = self.last_revision_info()
2542
if revno <= 0 or revno > last_revno:
2543
raise errors.NoSuchRevision(self, revno)
2545
if history is not None:
2546
return history[revno - 1]
2548
index = last_revno - revno
2549
if len(self._partial_revision_history_cache) <= index:
2550
self._extend_partial_history(stop_index=index)
2551
if len(self._partial_revision_history_cache) > index:
2552
return self._partial_revision_history_cache[index]
2554
raise errors.NoSuchRevision(self, revno)
2557
def revision_id_to_revno(self, revision_id):
2558
"""Given a revision id, return its revno"""
2559
if _mod_revision.is_null(revision_id):
2562
index = self._partial_revision_history_cache.index(revision_id)
2564
self._extend_partial_history(stop_revision=revision_id)
2565
index = len(self._partial_revision_history_cache) - 1
2566
if self._partial_revision_history_cache[index] != revision_id:
2567
raise errors.NoSuchRevision(self, revision_id)
2568
return self.revno() - index
2571
class BzrBranch6(BzrBranch7):
2572
"""See BzrBranchFormat6 for the capabilities of this branch.
2574
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2578
def get_stacked_on_url(self):
2579
raise errors.UnstackableBranchFormat(self._format, self.base)
2581
def set_stacked_on_url(self, url):
2582
raise errors.UnstackableBranchFormat(self._format, self.base)
2585
######################################################################
2586
# results of operations
2589
class _Result(object):
2591
def _show_tag_conficts(self, to_file):
2592
if not getattr(self, 'tag_conflicts', None):
2594
to_file.write('Conflicting tags:\n')
2595
for name, value1, value2 in self.tag_conflicts:
2596
to_file.write(' %s\n' % (name, ))
2599
class PullResult(_Result):
2600
"""Result of a Branch.pull operation.
2602
:ivar old_revno: Revision number before pull.
2603
:ivar new_revno: Revision number after pull.
2604
:ivar old_revid: Tip revision id before pull.
2605
:ivar new_revid: Tip revision id after pull.
2606
:ivar source_branch: Source (local) branch object.
2607
:ivar master_branch: Master branch of the target, or the target if no
2609
:ivar local_branch: target branch if there is a Master, else None
2610
:ivar target_branch: Target/destination branch object.
2611
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2615
# DEPRECATED: pull used to return the change in revno
2616
return self.new_revno - self.old_revno
2618
def report(self, to_file):
2620
if self.old_revid == self.new_revid:
2621
to_file.write('No revisions to pull.\n')
2623
to_file.write('Now on revision %d.\n' % self.new_revno)
2624
self._show_tag_conficts(to_file)
2627
class PushResult(_Result):
2628
"""Result of a Branch.push operation.
2630
:ivar old_revno: Revision number before push.
2631
:ivar new_revno: Revision number after push.
2632
:ivar old_revid: Tip revision id before push.
2633
:ivar new_revid: Tip revision id after push.
2634
:ivar source_branch: Source branch object.
2635
:ivar master_branch: Master branch of the target, or None.
2636
:ivar target_branch: Target/destination branch object.
2640
# DEPRECATED: push used to return the change in revno
2641
return self.new_revno - self.old_revno
2643
def report(self, to_file):
2644
"""Write a human-readable description of the result."""
2645
if self.old_revid == self.new_revid:
2646
to_file.write('No new revisions to push.\n')
2648
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2649
self._show_tag_conficts(to_file)
2652
class BranchCheckResult(object):
2653
"""Results of checking branch consistency.
2658
def __init__(self, branch):
2659
self.branch = branch
2661
def report_results(self, verbose):
2662
"""Report the check results via trace.note.
2664
:param verbose: Requests more detailed display of what was checked,
2667
note('checked branch %s format %s',
2669
self.branch._format)
2672
class Converter5to6(object):
2673
"""Perform an in-place upgrade of format 5 to format 6"""
2675
def convert(self, branch):
2676
# Data for 5 and 6 can peacefully coexist.
2677
format = BzrBranchFormat6()
2678
new_branch = format.open(branch.bzrdir, _found=True)
2680
# Copy source data into target
2681
new_branch._write_last_revision_info(*branch.last_revision_info())
2682
new_branch.set_parent(branch.get_parent())
2683
new_branch.set_bound_location(branch.get_bound_location())
2684
new_branch.set_push_location(branch.get_push_location())
2686
# New branch has no tags by default
2687
new_branch.tags._set_tag_dict({})
2689
# Copying done; now update target format
2690
new_branch._transport.put_bytes('format',
2691
format.get_format_string(),
2692
mode=new_branch.bzrdir._get_file_mode())
2694
# Clean up old files
2695
new_branch._transport.delete('revision-history')
2697
branch.set_parent(None)
2698
except errors.NoSuchFile:
2700
branch.set_bound_location(None)
2703
class Converter6to7(object):
2704
"""Perform an in-place upgrade of format 6 to format 7"""
2706
def convert(self, branch):
2707
format = BzrBranchFormat7()
2708
branch._set_config_location('stacked_on_location', '')
2709
# update target format
2710
branch._transport.put_bytes('format', format.get_format_string())
2714
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2715
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2718
_run_with_write_locked_target will attempt to release the lock it acquires.
2720
If an exception is raised by callable, then that exception *will* be
2721
propagated, even if the unlock attempt raises its own error. Thus
2722
_run_with_write_locked_target should be preferred to simply doing::
2726
return callable(*args, **kwargs)
2731
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2732
# should share code?
2735
result = callable(*args, **kwargs)
2737
exc_info = sys.exc_info()
2741
raise exc_info[0], exc_info[1], exc_info[2]
added
removed
bzrlib/branch.py
