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
revision_id: if not None, the revision history in the new branch will
920
be truncated to end with revision_id.
922
result = to_bzrdir.create_branch()
923
self.copy_content_into(result, revision_id=revision_id)
927
def sprout(self, to_bzrdir, revision_id=None):
928
"""Create a new line of development from the branch, into to_bzrdir.
930
to_bzrdir controls the branch format.
932
revision_id: if not None, the revision history in the new branch will
933
be truncated to end with revision_id.
935
result = to_bzrdir.create_branch()
936
self.copy_content_into(result, revision_id=revision_id)
937
result.set_parent(self.bzrdir.root_transport.base)
940
def _synchronize_history(self, destination, revision_id):
941
"""Synchronize last revision and revision history between branches.
943
This version is most efficient when the destination is also a
944
BzrBranch6, but works for BzrBranch5, as long as the destination's
945
repository contains all the lefthand ancestors of the intended
946
last_revision. If not, set_last_revision_info will fail.
948
:param destination: The branch to copy the history into
949
:param revision_id: The revision-id to truncate history at. May
950
be None to copy complete history.
952
source_revno, source_revision_id = self.last_revision_info()
953
if revision_id is None:
954
revno, revision_id = source_revno, source_revision_id
955
elif source_revision_id == revision_id:
956
# we know the revno without needing to walk all of history
959
# To figure out the revno for a random revision, we need to build
960
# the revision history, and count its length.
961
# We don't care about the order, just how long it is.
962
# Alternatively, we could start at the current location, and count
963
# backwards. But there is no guarantee that we will find it since
964
# it may be a merged revision.
965
revno = len(list(self.repository.iter_reverse_revision_history(
967
destination.set_last_revision_info(revno, revision_id)
970
def copy_content_into(self, destination, revision_id=None):
971
"""Copy the content of self into destination.
973
revision_id: if not None, the revision history in the new branch will
974
be truncated to end with revision_id.
976
self._synchronize_history(destination, revision_id)
978
parent = self.get_parent()
979
except errors.InaccessibleParent, e:
980
mutter('parent was not accessible to copy: %s', e)
983
destination.set_parent(parent)
984
if self._push_should_merge_tags():
985
self.tags.merge_to(destination.tags)
989
"""Check consistency of the branch.
991
In particular this checks that revisions given in the revision-history
992
do actually match up in the revision graph, and that they're all
993
present in the repository.
995
Callers will typically also want to check the repository.
997
:return: A BranchCheckResult.
999
mainline_parent_id = None
1000
last_revno, last_revision_id = self.last_revision_info()
1001
real_rev_history = list(self.repository.iter_reverse_revision_history(
1003
real_rev_history.reverse()
1004
if len(real_rev_history) != last_revno:
1005
raise errors.BzrCheckError('revno does not match len(mainline)'
1006
' %s != %s' % (last_revno, len(real_rev_history)))
1007
# TODO: We should probably also check that real_rev_history actually
1008
# matches self.revision_history()
1009
for revision_id in real_rev_history:
1011
revision = self.repository.get_revision(revision_id)
1012
except errors.NoSuchRevision, e:
1013
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1015
# In general the first entry on the revision history has no parents.
1016
# But it's not illegal for it to have parents listed; this can happen
1017
# in imports from Arch when the parents weren't reachable.
1018
if mainline_parent_id is not None:
1019
if mainline_parent_id not in revision.parent_ids:
1020
raise errors.BzrCheckError("previous revision {%s} not listed among "
1022
% (mainline_parent_id, revision_id))
1023
mainline_parent_id = revision_id
1024
return BranchCheckResult(self)
1026
def _get_checkout_format(self):
1027
"""Return the most suitable metadir for a checkout of this branch.
1028
Weaves are used if this branch's repository uses weaves.
1030
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1031
from bzrlib.repofmt import weaverepo
1032
format = bzrdir.BzrDirMetaFormat1()
1033
format.repository_format = weaverepo.RepositoryFormat7()
1035
format = self.repository.bzrdir.checkout_metadir()
1036
format.set_branch_format(self._format)
1039
def create_checkout(self, to_location, revision_id=None,
1040
lightweight=False, accelerator_tree=None,
1042
"""Create a checkout of a branch.
1044
:param to_location: The url to produce the checkout at
1045
:param revision_id: The revision to check out
1046
:param lightweight: If True, produce a lightweight checkout, otherwise,
1047
produce a bound branch (heavyweight checkout)
1048
:param accelerator_tree: A tree which can be used for retrieving file
1049
contents more quickly than the revision tree, i.e. a workingtree.
1050
The revision tree will be used for cases where accelerator_tree's
1051
content is different.
1052
:param hardlink: If true, hard-link files from accelerator_tree,
1054
:return: The tree of the created checkout
1056
t = transport.get_transport(to_location)
1059
format = self._get_checkout_format()
1060
checkout = format.initialize_on_transport(t)
1061
from_branch = BranchReferenceFormat().initialize(checkout, self)
1063
format = self._get_checkout_format()
1064
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1065
to_location, force_new_tree=False, format=format)
1066
checkout = checkout_branch.bzrdir
1067
checkout_branch.bind(self)
1068
# pull up to the specified revision_id to set the initial
1069
# branch tip correctly, and seed it with history.
1070
checkout_branch.pull(self, stop_revision=revision_id)
1072
tree = checkout.create_workingtree(revision_id,
1073
from_branch=from_branch,
1074
accelerator_tree=accelerator_tree,
1076
basis_tree = tree.basis_tree()
1077
basis_tree.lock_read()
1079
for path, file_id in basis_tree.iter_references():
1080
reference_parent = self.reference_parent(file_id, path)
1081
reference_parent.create_checkout(tree.abspath(path),
1082
basis_tree.get_reference_revision(file_id, path),
1089
def reconcile(self, thorough=True):
1090
"""Make sure the data stored in this branch is consistent."""
1091
from bzrlib.reconcile import BranchReconciler
1092
reconciler = BranchReconciler(self, thorough=thorough)
1093
reconciler.reconcile()
1096
def reference_parent(self, file_id, path):
1097
"""Return the parent branch for a tree-reference file_id
1098
:param file_id: The file_id of the tree reference
1099
:param path: The path of the file_id in the tree
1100
:return: A branch associated with the file_id
1102
# FIXME should provide multiple branches, based on config
1103
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1105
def supports_tags(self):
1106
return self._format.supports_tags()
1108
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1110
"""Ensure that revision_b is a descendant of revision_a.
1112
This is a helper function for update_revisions.
1114
:raises: DivergedBranches if revision_b has diverged from revision_a.
1115
:returns: True if revision_b is a descendant of revision_a.
1117
relation = self._revision_relations(revision_a, revision_b, graph)
1118
if relation == 'b_descends_from_a':
1120
elif relation == 'diverged':
1121
raise errors.DivergedBranches(self, other_branch)
1122
elif relation == 'a_descends_from_b':
1125
raise AssertionError("invalid relation: %r" % (relation,))
1127
def _revision_relations(self, revision_a, revision_b, graph):
1128
"""Determine the relationship between two revisions.
1130
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1132
heads = graph.heads([revision_a, revision_b])
1133
if heads == set([revision_b]):
1134
return 'b_descends_from_a'
1135
elif heads == set([revision_a, revision_b]):
1136
# These branches have diverged
1138
elif heads == set([revision_a]):
1139
return 'a_descends_from_b'
1141
raise AssertionError("invalid heads: %r" % (heads,))
1144
class BranchFormat(object):
1145
"""An encapsulation of the initialization and open routines for a format.
1147
Formats provide three things:
1148
* An initialization routine,
1152
Formats are placed in an dict by their format string for reference
1153
during branch opening. Its not required that these be instances, they
1154
can be classes themselves with class methods - it simply depends on
1155
whether state is needed for a given format or not.
1157
Once a format is deprecated, just deprecate the initialize and open
1158
methods on the format class. Do not deprecate the object, as the
1159
object will be created every time regardless.
1162
_default_format = None
1163
"""The default format used for new branches."""
1166
"""The known formats."""
1168
def __eq__(self, other):
1169
return self.__class__ is other.__class__
1171
def __ne__(self, other):
1172
return not (self == other)
1175
def find_format(klass, a_bzrdir):
1176
"""Return the format for the branch object in a_bzrdir."""
1178
transport = a_bzrdir.get_branch_transport(None)
1179
format_string = transport.get("format").read()
1180
return klass._formats[format_string]
1181
except errors.NoSuchFile:
1182
raise errors.NotBranchError(path=transport.base)
1184
raise errors.UnknownFormatError(format=format_string, kind='branch')
1187
def get_default_format(klass):
1188
"""Return the current default format."""
1189
return klass._default_format
1191
def get_reference(self, a_bzrdir):
1192
"""Get the target reference of the branch in a_bzrdir.
1194
format probing must have been completed before calling
1195
this method - it is assumed that the format of the branch
1196
in a_bzrdir is correct.
1198
:param a_bzrdir: The bzrdir to get the branch data from.
1199
:return: None if the branch is not a reference branch.
1204
def set_reference(self, a_bzrdir, to_branch):
1205
"""Set the target reference of the branch in a_bzrdir.
1207
format probing must have been completed before calling
1208
this method - it is assumed that the format of the branch
1209
in a_bzrdir is correct.
1211
:param a_bzrdir: The bzrdir to set the branch reference for.
1212
:param to_branch: branch that the checkout is to reference
1214
raise NotImplementedError(self.set_reference)
1216
def get_format_string(self):
1217
"""Return the ASCII format string that identifies this format."""
1218
raise NotImplementedError(self.get_format_string)
1220
def get_format_description(self):
1221
"""Return the short format description for this format."""
1222
raise NotImplementedError(self.get_format_description)
1224
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1226
"""Initialize a branch in a bzrdir, with specified files
1228
:param a_bzrdir: The bzrdir to initialize the branch in
1229
:param utf8_files: The files to create as a list of
1230
(filename, content) tuples
1231
:param set_format: If True, set the format with
1232
self.get_format_string. (BzrBranch4 has its format set
1234
:return: a branch in this format
1236
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1237
branch_transport = a_bzrdir.get_branch_transport(self)
1239
'metadir': ('lock', lockdir.LockDir),
1240
'branch4': ('branch-lock', lockable_files.TransportLock),
1242
lock_name, lock_class = lock_map[lock_type]
1243
control_files = lockable_files.LockableFiles(branch_transport,
1244
lock_name, lock_class)
1245
control_files.create_lock()
1246
control_files.lock_write()
1248
utf8_files += [('format', self.get_format_string())]
1250
for (filename, content) in utf8_files:
1251
branch_transport.put_bytes(
1253
mode=a_bzrdir._get_file_mode())
1255
control_files.unlock()
1256
return self.open(a_bzrdir, _found=True)
1258
def initialize(self, a_bzrdir):
1259
"""Create a branch of this format in a_bzrdir."""
1260
raise NotImplementedError(self.initialize)
1262
def is_supported(self):
1263
"""Is this format supported?
1265
Supported formats can be initialized and opened.
1266
Unsupported formats may not support initialization or committing or
1267
some other features depending on the reason for not being supported.
1271
def network_name(self):
1272
"""A simple byte string uniquely identifying this format for RPC calls.
1274
MetaDir branch formats use their disk format string to identify the
1275
repository over the wire. All in one formats such as bzr < 0.8, and
1276
foreign formats like svn/git and hg should use some marker which is
1277
unique and immutable.
1279
raise NotImplementedError(self.network_name)
1281
def open(self, a_bzrdir, _found=False):
1282
"""Return the branch object for a_bzrdir
1284
_found is a private parameter, do not use it. It is used to indicate
1285
if format probing has already be done.
1287
raise NotImplementedError(self.open)
1290
def register_format(klass, format):
1291
"""Register a metadir format."""
1292
klass._formats[format.get_format_string()] = format
1293
# Metadir formats have a network name of their format string.
1294
network_format_registry.register(format.get_format_string(), format)
1297
def set_default_format(klass, format):
1298
klass._default_format = format
1300
def supports_stacking(self):
1301
"""True if this format records a stacked-on branch."""
1305
def unregister_format(klass, format):
1306
del klass._formats[format.get_format_string()]
1309
return self.get_format_description().rstrip()
1311
def supports_tags(self):
1312
"""True if this format supports tags stored in the branch"""
1313
return False # by default
1316
class BranchHooks(Hooks):
1317
"""A dictionary mapping hook name to a list of callables for branch hooks.
1319
e.g. ['set_rh'] Is the list of items to be called when the
1320
set_revision_history function is invoked.
1324
"""Create the default hooks.
1326
These are all empty initially, because by default nothing should get
1329
Hooks.__init__(self)
1330
# Introduced in 0.15:
1331
# invoked whenever the revision history has been set
1332
# with set_revision_history. The api signature is
1333
# (branch, revision_history), and the branch will
1336
# Invoked after a branch is opened. The api signature is (branch).
1338
# invoked after a push operation completes.
1339
# the api signature is
1341
# containing the members
1342
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1343
# where local is the local target branch or None, master is the target
1344
# master branch, and the rest should be self explanatory. The source
1345
# is read locked and the target branches write locked. Source will
1346
# be the local low-latency branch.
1347
self['post_push'] = []
1348
# invoked after a pull operation completes.
1349
# the api signature is
1351
# containing the members
1352
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1353
# where local is the local branch or None, master is the target
1354
# master branch, and the rest should be self explanatory. The source
1355
# is read locked and the target branches write locked. The local
1356
# branch is the low-latency branch.
1357
self['post_pull'] = []
1358
# invoked before a commit operation takes place.
1359
# the api signature is
1360
# (local, master, old_revno, old_revid, future_revno, future_revid,
1361
# tree_delta, future_tree).
1362
# old_revid is NULL_REVISION for the first commit to a branch
1363
# tree_delta is a TreeDelta object describing changes from the basis
1364
# revision, hooks MUST NOT modify this delta
1365
# future_tree is an in-memory tree obtained from
1366
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1367
self['pre_commit'] = []
1368
# invoked after a commit operation completes.
1369
# the api signature is
1370
# (local, master, old_revno, old_revid, new_revno, new_revid)
1371
# old_revid is NULL_REVISION for the first commit to a branch.
1372
self['post_commit'] = []
1373
# invoked after a uncommit operation completes.
1374
# the api signature is
1375
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1376
# local is the local branch or None, master is the target branch,
1377
# and an empty branch recieves new_revno of 0, new_revid of None.
1378
self['post_uncommit'] = []
1380
# Invoked before the tip of a branch changes.
1381
# the api signature is
1382
# (params) where params is a ChangeBranchTipParams with the members
1383
# (branch, old_revno, new_revno, old_revid, new_revid)
1384
self['pre_change_branch_tip'] = []
1386
# Invoked after the tip of a branch changes.
1387
# the api signature is
1388
# (params) where params is a ChangeBranchTipParams with the members
1389
# (branch, old_revno, new_revno, old_revid, new_revid)
1390
self['post_change_branch_tip'] = []
1392
# Invoked when a stacked branch activates its fallback locations and
1393
# allows the transformation of the url of said location.
1394
# the api signature is
1395
# (branch, url) where branch is the branch having its fallback
1396
# location activated and url is the url for the fallback location.
1397
# The hook should return a url.
1398
self['transform_fallback_location'] = []
1401
# install the default hooks into the Branch class.
1402
Branch.hooks = BranchHooks()
1405
class ChangeBranchTipParams(object):
1406
"""Object holding parameters passed to *_change_branch_tip hooks.
1408
There are 5 fields that hooks may wish to access:
1410
:ivar branch: the branch being changed
1411
:ivar old_revno: revision number before the change
1412
:ivar new_revno: revision number after the change
1413
:ivar old_revid: revision id before the change
1414
:ivar new_revid: revision id after the change
1416
The revid fields are strings. The revno fields are integers.
1419
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1420
"""Create a group of ChangeBranchTip parameters.
1422
:param branch: The branch being changed.
1423
:param old_revno: Revision number before the change.
1424
:param new_revno: Revision number after the change.
1425
:param old_revid: Tip revision id before the change.
1426
:param new_revid: Tip revision id after the change.
1428
self.branch = branch
1429
self.old_revno = old_revno
1430
self.new_revno = new_revno
1431
self.old_revid = old_revid
1432
self.new_revid = new_revid
1434
def __eq__(self, other):
1435
return self.__dict__ == other.__dict__
1438
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1439
self.__class__.__name__, self.branch,
1440
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1443
class BzrBranchFormat4(BranchFormat):
1444
"""Bzr branch format 4.
1447
- a revision-history file.
1448
- a branch-lock lock file [ to be shared with the bzrdir ]
1451
def get_format_description(self):
1452
"""See BranchFormat.get_format_description()."""
1453
return "Branch format 4"
1455
def initialize(self, a_bzrdir):
1456
"""Create a branch of this format in a_bzrdir."""
1457
utf8_files = [('revision-history', ''),
1458
('branch-name', ''),
1460
return self._initialize_helper(a_bzrdir, utf8_files,
1461
lock_type='branch4', set_format=False)
1464
super(BzrBranchFormat4, self).__init__()
1465
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1467
def network_name(self):
1468
"""The network name for this format is the control dirs disk label."""
1469
return self._matchingbzrdir.get_format_string()
1471
def open(self, a_bzrdir, _found=False):
1472
"""Return the branch object for a_bzrdir
1474
_found is a private parameter, do not use it. It is used to indicate
1475
if format probing has already be done.
1478
# we are being called directly and must probe.
1479
raise NotImplementedError
1480
return BzrBranch(_format=self,
1481
_control_files=a_bzrdir._control_files,
1483
_repository=a_bzrdir.open_repository())
1486
return "Bazaar-NG branch format 4"
1489
class BranchFormatMetadir(BranchFormat):
1490
"""Common logic for meta-dir based branch formats."""
1492
def _branch_class(self):
1493
"""What class to instantiate on open calls."""
1494
raise NotImplementedError(self._branch_class)
1496
def network_name(self):
1497
"""A simple byte string uniquely identifying this format for RPC calls.
1499
Metadir branch formats use their format string.
1501
return self.get_format_string()
1503
def open(self, a_bzrdir, _found=False):
1504
"""Return the branch object for a_bzrdir.
1506
_found is a private parameter, do not use it. It is used to indicate
1507
if format probing has already be done.
1510
format = BranchFormat.find_format(a_bzrdir)
1511
if format.__class__ != self.__class__:
1512
raise AssertionError("wrong format %r found for %r" %
1515
transport = a_bzrdir.get_branch_transport(None)
1516
control_files = lockable_files.LockableFiles(transport, 'lock',
1518
return self._branch_class()(_format=self,
1519
_control_files=control_files,
1521
_repository=a_bzrdir.find_repository())
1522
except errors.NoSuchFile:
1523
raise errors.NotBranchError(path=transport.base)
1526
super(BranchFormatMetadir, self).__init__()
1527
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1528
self._matchingbzrdir.set_branch_format(self)
1530
def supports_tags(self):
1534
class BzrBranchFormat5(BranchFormatMetadir):
1535
"""Bzr branch format 5.
1538
- a revision-history file.
1540
- a lock dir guarding the branch itself
1541
- all of this stored in a branch/ subdirectory
1542
- works with shared repositories.
1544
This format is new in bzr 0.8.
1547
def _branch_class(self):
1550
def get_format_string(self):
1551
"""See BranchFormat.get_format_string()."""
1552
return "Bazaar-NG branch format 5\n"
1554
def get_format_description(self):
1555
"""See BranchFormat.get_format_description()."""
1556
return "Branch format 5"
1558
def initialize(self, a_bzrdir):
1559
"""Create a branch of this format in a_bzrdir."""
1560
utf8_files = [('revision-history', ''),
1561
('branch-name', ''),
1563
return self._initialize_helper(a_bzrdir, utf8_files)
1565
def supports_tags(self):
1569
class BzrBranchFormat6(BranchFormatMetadir):
1570
"""Branch format with last-revision and tags.
1572
Unlike previous formats, this has no explicit revision history. Instead,
1573
this just stores the last-revision, and the left-hand history leading
1574
up to there is the history.
1576
This format was introduced in bzr 0.15
1577
and became the default in 0.91.
1580
def _branch_class(self):
1583
def get_format_string(self):
1584
"""See BranchFormat.get_format_string()."""
1585
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1587
def get_format_description(self):
1588
"""See BranchFormat.get_format_description()."""
1589
return "Branch format 6"
1591
def initialize(self, a_bzrdir):
1592
"""Create a branch of this format in a_bzrdir."""
1593
utf8_files = [('last-revision', '0 null:\n'),
1594
('branch.conf', ''),
1597
return self._initialize_helper(a_bzrdir, utf8_files)
1600
class BzrBranchFormat7(BranchFormatMetadir):
1601
"""Branch format with last-revision, tags, and a stacked location pointer.
1603
The stacked location pointer is passed down to the repository and requires
1604
a repository format with supports_external_lookups = True.
1606
This format was introduced in bzr 1.6.
1609
def _branch_class(self):
1612
def get_format_string(self):
1613
"""See BranchFormat.get_format_string()."""
1614
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1616
def get_format_description(self):
1617
"""See BranchFormat.get_format_description()."""
1618
return "Branch format 7"
1620
def initialize(self, a_bzrdir):
1621
"""Create a branch of this format in a_bzrdir."""
1622
utf8_files = [('last-revision', '0 null:\n'),
1623
('branch.conf', ''),
1626
return self._initialize_helper(a_bzrdir, utf8_files)
1629
super(BzrBranchFormat7, self).__init__()
1630
self._matchingbzrdir.repository_format = \
1631
RepositoryFormatKnitPack5RichRoot()
1633
def supports_stacking(self):
1637
class BranchReferenceFormat(BranchFormat):
1638
"""Bzr branch reference format.
1640
Branch references are used in implementing checkouts, they
1641
act as an alias to the real branch which is at some other url.
1648
def get_format_string(self):
1649
"""See BranchFormat.get_format_string()."""
1650
return "Bazaar-NG Branch Reference Format 1\n"
1652
def get_format_description(self):
1653
"""See BranchFormat.get_format_description()."""
1654
return "Checkout reference format 1"
1656
def get_reference(self, a_bzrdir):
1657
"""See BranchFormat.get_reference()."""
1658
transport = a_bzrdir.get_branch_transport(None)
1659
return transport.get('location').read()
1661
def set_reference(self, a_bzrdir, to_branch):
1662
"""See BranchFormat.set_reference()."""
1663
transport = a_bzrdir.get_branch_transport(None)
1664
location = transport.put_bytes('location', to_branch.base)
1666
def initialize(self, a_bzrdir, target_branch=None):
1667
"""Create a branch of this format in a_bzrdir."""
1668
if target_branch is None:
1669
# this format does not implement branch itself, thus the implicit
1670
# creation contract must see it as uninitializable
1671
raise errors.UninitializableFormat(self)
1672
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1673
branch_transport = a_bzrdir.get_branch_transport(self)
1674
branch_transport.put_bytes('location',
1675
target_branch.bzrdir.root_transport.base)
1676
branch_transport.put_bytes('format', self.get_format_string())
1678
a_bzrdir, _found=True,
1679
possible_transports=[target_branch.bzrdir.root_transport])
1682
super(BranchReferenceFormat, self).__init__()
1683
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1684
self._matchingbzrdir.set_branch_format(self)
1686
def _make_reference_clone_function(format, a_branch):
1687
"""Create a clone() routine for a branch dynamically."""
1688
def clone(to_bzrdir, revision_id=None):
1689
"""See Branch.clone()."""
1690
return format.initialize(to_bzrdir, a_branch)
1691
# cannot obey revision_id limits when cloning a reference ...
1692
# FIXME RBC 20060210 either nuke revision_id for clone, or
1693
# emit some sort of warning/error to the caller ?!
1696
def open(self, a_bzrdir, _found=False, location=None,
1697
possible_transports=None):
1698
"""Return the branch that the branch reference in a_bzrdir points at.
1700
_found is a private parameter, do not use it. It is used to indicate
1701
if format probing has already be done.
1704
format = BranchFormat.find_format(a_bzrdir)
1705
if format.__class__ != self.__class__:
1706
raise AssertionError("wrong format %r found for %r" %
1708
if location is None:
1709
location = self.get_reference(a_bzrdir)
1710
real_bzrdir = bzrdir.BzrDir.open(
1711
location, possible_transports=possible_transports)
1712
result = real_bzrdir.open_branch()
1713
# this changes the behaviour of result.clone to create a new reference
1714
# rather than a copy of the content of the branch.
1715
# I did not use a proxy object because that needs much more extensive
1716
# testing, and we are only changing one behaviour at the moment.
1717
# If we decide to alter more behaviours - i.e. the implicit nickname
1718
# then this should be refactored to introduce a tested proxy branch
1719
# and a subclass of that for use in overriding clone() and ....
1721
result.clone = self._make_reference_clone_function(result)
1725
network_format_registry = registry.FormatRegistry()
1726
"""Registry of formats indexed by their network name.
1728
The network name for a repository format is an identifier that can be used when
1729
referring to formats with smart server operations. See
1730
BranchFormat.network_name() for more detail.
1734
# formats which have no format string are not discoverable
1735
# and not independently creatable, so are not registered.
1736
__format5 = BzrBranchFormat5()
1737
__format6 = BzrBranchFormat6()
1738
__format7 = BzrBranchFormat7()
1739
BranchFormat.register_format(__format5)
1740
BranchFormat.register_format(BranchReferenceFormat())
1741
BranchFormat.register_format(__format6)
1742
BranchFormat.register_format(__format7)
1743
BranchFormat.set_default_format(__format6)
1744
_legacy_formats = [BzrBranchFormat4(),
1746
network_format_registry.register(
1747
_legacy_formats[0].network_name(), _legacy_formats[0])
1750
class BzrBranch(Branch):
1751
"""A branch stored in the actual filesystem.
1753
Note that it's "local" in the context of the filesystem; it doesn't
1754
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1755
it's writable, and can be accessed via the normal filesystem API.
1757
:ivar _transport: Transport for file operations on this branch's
1758
control files, typically pointing to the .bzr/branch directory.
1759
:ivar repository: Repository for this branch.
1760
:ivar base: The url of the base directory for this branch; the one
1761
containing the .bzr directory.
1764
def __init__(self, _format=None,
1765
_control_files=None, a_bzrdir=None, _repository=None):
1766
"""Create new branch object at a particular location."""
1767
if a_bzrdir is None:
1768
raise ValueError('a_bzrdir must be supplied')
1770
self.bzrdir = a_bzrdir
1771
self._base = self.bzrdir.transport.clone('..').base
1772
# XXX: We should be able to just do
1773
# self.base = self.bzrdir.root_transport.base
1774
# but this does not quite work yet -- mbp 20080522
1775
self._format = _format
1776
if _control_files is None:
1777
raise ValueError('BzrBranch _control_files is None')
1778
self.control_files = _control_files
1779
self._transport = _control_files._transport
1780
self.repository = _repository
1781
Branch.__init__(self)
1784
return '%s(%r)' % (self.__class__.__name__, self.base)
1788
def _get_base(self):
1789
"""Returns the directory containing the control directory."""
1792
base = property(_get_base, doc="The URL for the root of this branch.")
1794
def is_locked(self):
1795
return self.control_files.is_locked()
1797
def lock_write(self, token=None):
1798
repo_token = self.repository.lock_write()
1800
token = self.control_files.lock_write(token=token)
1802
self.repository.unlock()
1806
def lock_read(self):
1807
self.repository.lock_read()
1809
self.control_files.lock_read()
1811
self.repository.unlock()
1815
# TODO: test for failed two phase locks. This is known broken.
1817
self.control_files.unlock()
1819
self.repository.unlock()
1820
if not self.control_files.is_locked():
1821
# we just released the lock
1822
self._clear_cached_state()
1824
def peek_lock_mode(self):
1825
if self.control_files._lock_count == 0:
1828
return self.control_files._lock_mode
1830
def get_physical_lock_status(self):
1831
return self.control_files.get_physical_lock_status()
1834
def print_file(self, file, revision_id):
1835
"""See Branch.print_file."""
1836
return self.repository.print_file(file, revision_id)
1838
def _write_revision_history(self, history):
1839
"""Factored out of set_revision_history.
1841
This performs the actual writing to disk.
1842
It is intended to be called by BzrBranch5.set_revision_history."""
1843
self._transport.put_bytes(
1844
'revision-history', '\n'.join(history),
1845
mode=self.bzrdir._get_file_mode())
1848
def set_revision_history(self, rev_history):
1849
"""See Branch.set_revision_history."""
1850
if 'evil' in debug.debug_flags:
1851
mutter_callsite(3, "set_revision_history scales with history.")
1852
check_not_reserved_id = _mod_revision.check_not_reserved_id
1853
for rev_id in rev_history:
1854
check_not_reserved_id(rev_id)
1855
if Branch.hooks['post_change_branch_tip']:
1856
# Don't calculate the last_revision_info() if there are no hooks
1858
old_revno, old_revid = self.last_revision_info()
1859
if len(rev_history) == 0:
1860
revid = _mod_revision.NULL_REVISION
1862
revid = rev_history[-1]
1863
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1864
self._write_revision_history(rev_history)
1865
self._clear_cached_state()
1866
self._cache_revision_history(rev_history)
1867
for hook in Branch.hooks['set_rh']:
1868
hook(self, rev_history)
1869
if Branch.hooks['post_change_branch_tip']:
1870
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1872
def _synchronize_history(self, destination, revision_id):
1873
"""Synchronize last revision and revision history between branches.
1875
This version is most efficient when the destination is also a
1876
BzrBranch5, but works for BzrBranch6 as long as the revision
1877
history is the true lefthand parent history, and all of the revisions
1878
are in the destination's repository. If not, set_revision_history
1881
:param destination: The branch to copy the history into
1882
:param revision_id: The revision-id to truncate history at. May
1883
be None to copy complete history.
1885
if not isinstance(destination._format, BzrBranchFormat5):
1886
super(BzrBranch, self)._synchronize_history(
1887
destination, revision_id)
1889
if revision_id == _mod_revision.NULL_REVISION:
1892
new_history = self.revision_history()
1893
if revision_id is not None and new_history != []:
1895
new_history = new_history[:new_history.index(revision_id) + 1]
1897
rev = self.repository.get_revision(revision_id)
1898
new_history = rev.get_history(self.repository)[1:]
1899
destination.set_revision_history(new_history)
1902
def set_last_revision_info(self, revno, revision_id):
1903
"""Set the last revision of this branch.
1905
The caller is responsible for checking that the revno is correct
1906
for this revision id.
1908
It may be possible to set the branch last revision to an id not
1909
present in the repository. However, branches can also be
1910
configured to check constraints on history, in which case this may not
1913
revision_id = _mod_revision.ensure_null(revision_id)
1914
# this old format stores the full history, but this api doesn't
1915
# provide it, so we must generate, and might as well check it's
1917
history = self._lefthand_history(revision_id)
1918
if len(history) != revno:
1919
raise AssertionError('%d != %d' % (len(history), revno))
1920
self.set_revision_history(history)
1922
def _gen_revision_history(self):
1923
history = self._transport.get_bytes('revision-history').split('\n')
1924
if history[-1:] == ['']:
1925
# There shouldn't be a trailing newline, but just in case.
1930
def generate_revision_history(self, revision_id, last_rev=None,
1932
"""Create a new revision history that will finish with revision_id.
1934
:param revision_id: the new tip to use.
1935
:param last_rev: The previous last_revision. If not None, then this
1936
must be a ancestory of revision_id, or DivergedBranches is raised.
1937
:param other_branch: The other branch that DivergedBranches should
1938
raise with respect to.
1940
self.set_revision_history(self._lefthand_history(revision_id,
1941
last_rev, other_branch))
1943
def basis_tree(self):
1944
"""See Branch.basis_tree."""
1945
return self.repository.revision_tree(self.last_revision())
1948
def pull(self, source, overwrite=False, stop_revision=None,
1949
_hook_master=None, run_hooks=True, possible_transports=None,
1950
_override_hook_target=None):
1953
:param _hook_master: Private parameter - set the branch to
1954
be supplied as the master to pull hooks.
1955
:param run_hooks: Private parameter - if false, this branch
1956
is being called because it's the master of the primary branch,
1957
so it should not run its hooks.
1958
:param _override_hook_target: Private parameter - set the branch to be
1959
supplied as the target_branch to pull hooks.
1961
result = PullResult()
1962
result.source_branch = source
1963
if _override_hook_target is None:
1964
result.target_branch = self
1966
result.target_branch = _override_hook_target
1969
# We assume that during 'pull' the local repository is closer than
1971
graph = self.repository.get_graph(source.repository)
1972
result.old_revno, result.old_revid = self.last_revision_info()
1973
self.update_revisions(source, stop_revision, overwrite=overwrite,
1975
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1976
result.new_revno, result.new_revid = self.last_revision_info()
1978
result.master_branch = _hook_master
1979
result.local_branch = result.target_branch
1981
result.master_branch = result.target_branch
1982
result.local_branch = None
1984
for hook in Branch.hooks['post_pull']:
1990
def _get_parent_location(self):
1991
_locs = ['parent', 'pull', 'x-pull']
1994
return self._transport.get_bytes(l).strip('\n')
1995
except errors.NoSuchFile:
2000
def push(self, target, overwrite=False, stop_revision=None,
2001
_override_hook_source_branch=None):
2004
This is the basic concrete implementation of push()
2006
:param _override_hook_source_branch: If specified, run
2007
the hooks passing this Branch as the source, rather than self.
2008
This is for use of RemoteBranch, where push is delegated to the
2009
underlying vfs-based Branch.
2011
# TODO: Public option to disable running hooks - should be trivial but
2013
return _run_with_write_locked_target(
2014
target, self._push_with_bound_branches, target, overwrite,
2016
_override_hook_source_branch=_override_hook_source_branch)
2018
def _push_with_bound_branches(self, target, overwrite,
2020
_override_hook_source_branch=None):
2021
"""Push from self into target, and into target's master if any.
2023
This is on the base BzrBranch class even though it doesn't support
2024
bound branches because the *target* might be bound.
2027
if _override_hook_source_branch:
2028
result.source_branch = _override_hook_source_branch
2029
for hook in Branch.hooks['post_push']:
2032
bound_location = target.get_bound_location()
2033
if bound_location and target.base != bound_location:
2034
# there is a master branch.
2036
# XXX: Why the second check? Is it even supported for a branch to
2037
# be bound to itself? -- mbp 20070507
2038
master_branch = target.get_master_branch()
2039
master_branch.lock_write()
2041
# push into the master from this branch.
2042
self._basic_push(master_branch, overwrite, stop_revision)
2043
# and push into the target branch from this. Note that we push from
2044
# this branch again, because its considered the highest bandwidth
2046
result = self._basic_push(target, overwrite, stop_revision)
2047
result.master_branch = master_branch
2048
result.local_branch = target
2052
master_branch.unlock()
2055
result = self._basic_push(target, overwrite, stop_revision)
2056
# TODO: Why set master_branch and local_branch if there's no
2057
# binding? Maybe cleaner to just leave them unset? -- mbp
2059
result.master_branch = target
2060
result.local_branch = None
2064
def _basic_push(self, target, overwrite, stop_revision):
2065
"""Basic implementation of push without bound branches or hooks.
2067
Must be called with self read locked and target write locked.
2069
result = PushResult()
2070
result.source_branch = self
2071
result.target_branch = target
2072
result.old_revno, result.old_revid = target.last_revision_info()
2073
if result.old_revid != self.last_revision():
2074
# We assume that during 'push' this repository is closer than
2076
graph = self.repository.get_graph(target.repository)
2077
target.update_revisions(self, stop_revision, overwrite=overwrite,
2079
if self._push_should_merge_tags():
2080
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2081
result.new_revno, result.new_revid = target.last_revision_info()
2084
def get_parent(self):
2085
"""See Branch.get_parent."""
2086
parent = self._get_parent_location()
2089
# This is an old-format absolute path to a local branch
2090
# turn it into a url
2091
if parent.startswith('/'):
2092
parent = urlutils.local_path_to_url(parent.decode('utf8'))
2094
return urlutils.join(self.base[:-1], parent)
2095
except errors.InvalidURLJoin, e:
2096
raise errors.InaccessibleParent(parent, self.base)
2098
def get_stacked_on_url(self):
2099
raise errors.UnstackableBranchFormat(self._format, self.base)
2101
def set_push_location(self, location):
2102
"""See Branch.set_push_location."""
2103
self.get_config().set_user_option(
2104
'push_location', location,
2105
store=_mod_config.STORE_LOCATION_NORECURSE)
2108
def set_parent(self, url):
2109
"""See Branch.set_parent."""
2110
# TODO: Maybe delete old location files?
2111
# URLs should never be unicode, even on the local fs,
2112
# FIXUP this and get_parent in a future branch format bump:
2113
# read and rewrite the file. RBC 20060125
2115
if isinstance(url, unicode):
2117
url = url.encode('ascii')
2118
except UnicodeEncodeError:
2119
raise errors.InvalidURL(url,
2120
"Urls must be 7-bit ascii, "
2121
"use bzrlib.urlutils.escape")
2122
url = urlutils.relative_url(self.base, url)
2123
self._set_parent_location(url)
2125
def _set_parent_location(self, url):
2127
self._transport.delete('parent')
2129
self._transport.put_bytes('parent', url + '\n',
2130
mode=self.bzrdir._get_file_mode())
2132
def set_stacked_on_url(self, url):
2133
raise errors.UnstackableBranchFormat(self._format, self.base)
2136
class BzrBranch5(BzrBranch):
2137
"""A format 5 branch. This supports new features over plain branches.
2139
It has support for a master_branch which is the data for bound branches.
2143
def pull(self, source, overwrite=False, stop_revision=None,
2144
run_hooks=True, possible_transports=None,
2145
_override_hook_target=None):
2146
"""Pull from source into self, updating my master if any.
2148
:param run_hooks: Private parameter - if false, this branch
2149
is being called because it's the master of the primary branch,
2150
so it should not run its hooks.
2152
bound_location = self.get_bound_location()
2153
master_branch = None
2154
if bound_location and source.base != bound_location:
2155
# not pulling from master, so we need to update master.
2156
master_branch = self.get_master_branch(possible_transports)
2157
master_branch.lock_write()
2160
# pull from source into master.
2161
master_branch.pull(source, overwrite, stop_revision,
2163
return super(BzrBranch5, self).pull(source, overwrite,
2164
stop_revision, _hook_master=master_branch,
2165
run_hooks=run_hooks,
2166
_override_hook_target=_override_hook_target)
2169
master_branch.unlock()
2171
def get_bound_location(self):
2173
return self._transport.get_bytes('bound')[:-1]
2174
except errors.NoSuchFile:
2178
def get_master_branch(self, possible_transports=None):
2179
"""Return the branch we are bound to.
2181
:return: Either a Branch, or None
2183
This could memoise the branch, but if thats done
2184
it must be revalidated on each new lock.
2185
So for now we just don't memoise it.
2186
# RBC 20060304 review this decision.
2188
bound_loc = self.get_bound_location()
2192
return Branch.open(bound_loc,
2193
possible_transports=possible_transports)
2194
except (errors.NotBranchError, errors.ConnectionError), e:
2195
raise errors.BoundBranchConnectionFailure(
2199
def set_bound_location(self, location):
2200
"""Set the target where this branch is bound to.
2202
:param location: URL to the target branch
2205
self._transport.put_bytes('bound', location+'\n',
2206
mode=self.bzrdir._get_file_mode())
2209
self._transport.delete('bound')
2210
except errors.NoSuchFile:
2215
def bind(self, other):
2216
"""Bind this branch to the branch other.
2218
This does not push or pull data between the branches, though it does
2219
check for divergence to raise an error when the branches are not
2220
either the same, or one a prefix of the other. That behaviour may not
2221
be useful, so that check may be removed in future.
2223
:param other: The branch to bind to
2226
# TODO: jam 20051230 Consider checking if the target is bound
2227
# It is debatable whether you should be able to bind to
2228
# a branch which is itself bound.
2229
# Committing is obviously forbidden,
2230
# but binding itself may not be.
2231
# Since we *have* to check at commit time, we don't
2232
# *need* to check here
2234
# we want to raise diverged if:
2235
# last_rev is not in the other_last_rev history, AND
2236
# other_last_rev is not in our history, and do it without pulling
2238
self.set_bound_location(other.base)
2242
"""If bound, unbind"""
2243
return self.set_bound_location(None)
2246
def update(self, possible_transports=None):
2247
"""Synchronise this branch with the master branch if any.
2249
:return: None or the last_revision that was pivoted out during the
2252
master = self.get_master_branch(possible_transports)
2253
if master is not None:
2254
old_tip = _mod_revision.ensure_null(self.last_revision())
2255
self.pull(master, overwrite=True)
2256
if self.repository.get_graph().is_ancestor(old_tip,
2257
_mod_revision.ensure_null(self.last_revision())):
2263
class BzrBranch7(BzrBranch5):
2264
"""A branch with support for a fallback repository."""
2266
def _get_fallback_repository(self, url):
2267
"""Get the repository we fallback to at url."""
2268
url = urlutils.join(self.base, url)
2269
a_bzrdir = bzrdir.BzrDir.open(url,
2270
possible_transports=[self._transport])
2271
return a_bzrdir.open_branch().repository
2273
def _activate_fallback_location(self, url):
2274
"""Activate the branch/repository from url as a fallback repository."""
2275
self.repository.add_fallback_repository(
2276
self._get_fallback_repository(url))
2278
def _open_hook(self):
2280
url = self.get_stacked_on_url()
2281
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2282
errors.UnstackableBranchFormat):
2285
for hook in Branch.hooks['transform_fallback_location']:
2286
url = hook(self, url)
2288
hook_name = Branch.hooks.get_hook_name(hook)
2289
raise AssertionError(
2290
"'transform_fallback_location' hook %s returned "
2291
"None, not a URL." % hook_name)
2292
self._activate_fallback_location(url)
2294
def _check_stackable_repo(self):
2295
if not self.repository._format.supports_external_lookups:
2296
raise errors.UnstackableRepositoryFormat(self.repository._format,
2297
self.repository.base)
2299
def __init__(self, *args, **kwargs):
2300
super(BzrBranch7, self).__init__(*args, **kwargs)
2301
self._last_revision_info_cache = None
2302
self._partial_revision_history_cache = []
2304
def _clear_cached_state(self):
2305
super(BzrBranch7, self)._clear_cached_state()
2306
self._last_revision_info_cache = None
2307
self._partial_revision_history_cache = []
2309
def _last_revision_info(self):
2310
revision_string = self._transport.get_bytes('last-revision')
2311
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2312
revision_id = cache_utf8.get_cached_utf8(revision_id)
2314
return revno, revision_id
2316
def _write_last_revision_info(self, revno, revision_id):
2317
"""Simply write out the revision id, with no checks.
2319
Use set_last_revision_info to perform this safely.
2321
Does not update the revision_history cache.
2322
Intended to be called by set_last_revision_info and
2323
_write_revision_history.
2325
revision_id = _mod_revision.ensure_null(revision_id)
2326
out_string = '%d %s\n' % (revno, revision_id)
2327
self._transport.put_bytes('last-revision', out_string,
2328
mode=self.bzrdir._get_file_mode())
2331
def set_last_revision_info(self, revno, revision_id):
2332
revision_id = _mod_revision.ensure_null(revision_id)
2333
old_revno, old_revid = self.last_revision_info()
2334
if self._get_append_revisions_only():
2335
self._check_history_violation(revision_id)
2336
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2337
self._write_last_revision_info(revno, revision_id)
2338
self._clear_cached_state()
2339
self._last_revision_info_cache = revno, revision_id
2340
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2342
def _synchronize_history(self, destination, revision_id):
2343
"""Synchronize last revision and revision history between branches.
2345
:see: Branch._synchronize_history
2347
# XXX: The base Branch has a fast implementation of this method based
2348
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2349
# that uses set_revision_history. This class inherits from BzrBranch5,
2350
# but wants the fast implementation, so it calls
2351
# Branch._synchronize_history directly.
2352
Branch._synchronize_history(self, destination, revision_id)
2354
def _check_history_violation(self, revision_id):
2355
last_revision = _mod_revision.ensure_null(self.last_revision())
2356
if _mod_revision.is_null(last_revision):
2358
if last_revision not in self._lefthand_history(revision_id):
2359
raise errors.AppendRevisionsOnlyViolation(self.base)
2361
def _gen_revision_history(self):
2362
"""Generate the revision history from last revision
2364
last_revno, last_revision = self.last_revision_info()
2365
self._extend_partial_history(stop_index=last_revno-1)
2366
return list(reversed(self._partial_revision_history_cache))
2368
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2369
"""Extend the partial history to include a given index
2371
If a stop_index is supplied, stop when that index has been reached.
2372
If a stop_revision is supplied, stop when that revision is
2373
encountered. Otherwise, stop when the beginning of history is
2376
:param stop_index: The index which should be present. When it is
2377
present, history extension will stop.
2378
:param revision_id: The revision id which should be present. When
2379
it is encountered, history extension will stop.
2381
repo = self.repository
2382
if len(self._partial_revision_history_cache) == 0:
2383
iterator = repo.iter_reverse_revision_history(self.last_revision())
2385
start_revision = self._partial_revision_history_cache[-1]
2386
iterator = repo.iter_reverse_revision_history(start_revision)
2387
#skip the last revision in the list
2388
next_revision = iterator.next()
2389
for revision_id in iterator:
2390
self._partial_revision_history_cache.append(revision_id)
2391
if (stop_index is not None and
2392
len(self._partial_revision_history_cache) > stop_index):
2394
if revision_id == stop_revision:
2397
def _write_revision_history(self, history):
2398
"""Factored out of set_revision_history.
2400
This performs the actual writing to disk, with format-specific checks.
2401
It is intended to be called by BzrBranch5.set_revision_history.
2403
if len(history) == 0:
2404
last_revision = 'null:'
2406
if history != self._lefthand_history(history[-1]):
2407
raise errors.NotLefthandHistory(history)
2408
last_revision = history[-1]
2409
if self._get_append_revisions_only():
2410
self._check_history_violation(last_revision)
2411
self._write_last_revision_info(len(history), last_revision)
2414
def _set_parent_location(self, url):
2415
"""Set the parent branch"""
2416
self._set_config_location('parent_location', url, make_relative=True)
2419
def _get_parent_location(self):
2420
"""Set the parent branch"""
2421
return self._get_config_location('parent_location')
2423
def set_push_location(self, location):
2424
"""See Branch.set_push_location."""
2425
self._set_config_location('push_location', location)
2427
def set_bound_location(self, location):
2428
"""See Branch.set_push_location."""
2430
config = self.get_config()
2431
if location is None:
2432
if config.get_user_option('bound') != 'True':
2435
config.set_user_option('bound', 'False', warn_masked=True)
2438
self._set_config_location('bound_location', location,
2440
config.set_user_option('bound', 'True', warn_masked=True)
2443
def _get_bound_location(self, bound):
2444
"""Return the bound location in the config file.
2446
Return None if the bound parameter does not match"""
2447
config = self.get_config()
2448
config_bound = (config.get_user_option('bound') == 'True')
2449
if config_bound != bound:
2451
return self._get_config_location('bound_location', config=config)
2453
def get_bound_location(self):
2454
"""See Branch.set_push_location."""
2455
return self._get_bound_location(True)
2457
def get_old_bound_location(self):
2458
"""See Branch.get_old_bound_location"""
2459
return self._get_bound_location(False)
2461
def get_stacked_on_url(self):
2462
# you can always ask for the URL; but you might not be able to use it
2463
# if the repo can't support stacking.
2464
## self._check_stackable_repo()
2465
stacked_url = self._get_config_location('stacked_on_location')
2466
if stacked_url is None:
2467
raise errors.NotStacked(self)
2470
def set_append_revisions_only(self, enabled):
2475
self.get_config().set_user_option('append_revisions_only', value,
2478
def set_stacked_on_url(self, url):
2479
self._check_stackable_repo()
2482
old_url = self.get_stacked_on_url()
2483
except (errors.NotStacked, errors.UnstackableBranchFormat,
2484
errors.UnstackableRepositoryFormat):
2487
# repositories don't offer an interface to remove fallback
2488
# repositories today; take the conceptually simpler option and just
2490
self.repository = self.bzrdir.find_repository()
2491
# for every revision reference the branch has, ensure it is pulled
2493
source_repository = self._get_fallback_repository(old_url)
2494
for revision_id in chain([self.last_revision()],
2495
self.tags.get_reverse_tag_dict()):
2496
self.repository.fetch(source_repository, revision_id,
2499
self._activate_fallback_location(url)
2500
# write this out after the repository is stacked to avoid setting a
2501
# stacked config that doesn't work.
2502
self._set_config_location('stacked_on_location', url)
2504
def _get_append_revisions_only(self):
2505
value = self.get_config().get_user_option('append_revisions_only')
2506
return value == 'True'
2508
def _make_tags(self):
2509
return BasicTags(self)
2512
def generate_revision_history(self, revision_id, last_rev=None,
2514
"""See BzrBranch5.generate_revision_history"""
2515
history = self._lefthand_history(revision_id, last_rev, other_branch)
2516
revno = len(history)
2517
self.set_last_revision_info(revno, revision_id)
2520
def get_rev_id(self, revno, history=None):
2521
"""Find the revision id of the specified revno."""
2523
return _mod_revision.NULL_REVISION
2525
last_revno, last_revision_id = self.last_revision_info()
2526
if revno <= 0 or revno > last_revno:
2527
raise errors.NoSuchRevision(self, revno)
2529
if history is not None:
2530
return history[revno - 1]
2532
index = last_revno - revno
2533
if len(self._partial_revision_history_cache) <= index:
2534
self._extend_partial_history(stop_index=index)
2535
if len(self._partial_revision_history_cache) > index:
2536
return self._partial_revision_history_cache[index]
2538
raise errors.NoSuchRevision(self, revno)
2541
def revision_id_to_revno(self, revision_id):
2542
"""Given a revision id, return its revno"""
2543
if _mod_revision.is_null(revision_id):
2546
index = self._partial_revision_history_cache.index(revision_id)
2548
self._extend_partial_history(stop_revision=revision_id)
2549
index = len(self._partial_revision_history_cache) - 1
2550
if self._partial_revision_history_cache[index] != revision_id:
2551
raise errors.NoSuchRevision(self, revision_id)
2552
return self.revno() - index
2555
class BzrBranch6(BzrBranch7):
2556
"""See BzrBranchFormat6 for the capabilities of this branch.
2558
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2562
def get_stacked_on_url(self):
2563
raise errors.UnstackableBranchFormat(self._format, self.base)
2565
def set_stacked_on_url(self, url):
2566
raise errors.UnstackableBranchFormat(self._format, self.base)
2569
######################################################################
2570
# results of operations
2573
class _Result(object):
2575
def _show_tag_conficts(self, to_file):
2576
if not getattr(self, 'tag_conflicts', None):
2578
to_file.write('Conflicting tags:\n')
2579
for name, value1, value2 in self.tag_conflicts:
2580
to_file.write(' %s\n' % (name, ))
2583
class PullResult(_Result):
2584
"""Result of a Branch.pull operation.
2586
:ivar old_revno: Revision number before pull.
2587
:ivar new_revno: Revision number after pull.
2588
:ivar old_revid: Tip revision id before pull.
2589
:ivar new_revid: Tip revision id after pull.
2590
:ivar source_branch: Source (local) branch object.
2591
:ivar master_branch: Master branch of the target, or the target if no
2593
:ivar local_branch: target branch if there is a Master, else None
2594
:ivar target_branch: Target/destination branch object.
2595
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2599
# DEPRECATED: pull used to return the change in revno
2600
return self.new_revno - self.old_revno
2602
def report(self, to_file):
2604
if self.old_revid == self.new_revid:
2605
to_file.write('No revisions to pull.\n')
2607
to_file.write('Now on revision %d.\n' % self.new_revno)
2608
self._show_tag_conficts(to_file)
2611
class PushResult(_Result):
2612
"""Result of a Branch.push operation.
2614
:ivar old_revno: Revision number before push.
2615
:ivar new_revno: Revision number after push.
2616
:ivar old_revid: Tip revision id before push.
2617
:ivar new_revid: Tip revision id after push.
2618
:ivar source_branch: Source branch object.
2619
:ivar master_branch: Master branch of the target, or None.
2620
:ivar target_branch: Target/destination branch object.
2624
# DEPRECATED: push used to return the change in revno
2625
return self.new_revno - self.old_revno
2627
def report(self, to_file):
2628
"""Write a human-readable description of the result."""
2629
if self.old_revid == self.new_revid:
2630
to_file.write('No new revisions to push.\n')
2632
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2633
self._show_tag_conficts(to_file)
2636
class BranchCheckResult(object):
2637
"""Results of checking branch consistency.
2642
def __init__(self, branch):
2643
self.branch = branch
2645
def report_results(self, verbose):
2646
"""Report the check results via trace.note.
2648
:param verbose: Requests more detailed display of what was checked,
2651
note('checked branch %s format %s',
2653
self.branch._format)
2656
class Converter5to6(object):
2657
"""Perform an in-place upgrade of format 5 to format 6"""
2659
def convert(self, branch):
2660
# Data for 5 and 6 can peacefully coexist.
2661
format = BzrBranchFormat6()
2662
new_branch = format.open(branch.bzrdir, _found=True)
2664
# Copy source data into target
2665
new_branch._write_last_revision_info(*branch.last_revision_info())
2666
new_branch.set_parent(branch.get_parent())
2667
new_branch.set_bound_location(branch.get_bound_location())
2668
new_branch.set_push_location(branch.get_push_location())
2670
# New branch has no tags by default
2671
new_branch.tags._set_tag_dict({})
2673
# Copying done; now update target format
2674
new_branch._transport.put_bytes('format',
2675
format.get_format_string(),
2676
mode=new_branch.bzrdir._get_file_mode())
2678
# Clean up old files
2679
new_branch._transport.delete('revision-history')
2681
branch.set_parent(None)
2682
except errors.NoSuchFile:
2684
branch.set_bound_location(None)
2687
class Converter6to7(object):
2688
"""Perform an in-place upgrade of format 6 to format 7"""
2690
def convert(self, branch):
2691
format = BzrBranchFormat7()
2692
branch._set_config_location('stacked_on_location', '')
2693
# update target format
2694
branch._transport.put_bytes('format', format.get_format_string())
2698
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2699
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2702
_run_with_write_locked_target will attempt to release the lock it acquires.
2704
If an exception is raised by callable, then that exception *will* be
2705
propagated, even if the unlock attempt raises its own error. Thus
2706
_run_with_write_locked_target should be preferred to simply doing::
2710
return callable(*args, **kwargs)
2715
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2716
# should share code?
2719
result = callable(*args, **kwargs)
2721
exc_info = sys.exc_info()
2725
raise exc_info[0], exc_info[1], exc_info[2]
added
removed
bzrlib/branch.py
