1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from itertools import chain
26
config as _mod_config,
32
revision as _mod_revision,
38
from bzrlib.config import BranchConfig
39
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
40
from bzrlib.tag import (
46
from bzrlib.decorators import needs_read_lock, needs_write_lock
47
from bzrlib.hooks import Hooks
48
from bzrlib.symbol_versioning import (
52
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
55
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
56
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
57
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
60
# TODO: Maybe include checks for common corruption of newlines, etc?
62
# TODO: Some operations like log might retrieve the same revisions
63
# repeatedly to calculate deltas. We could perhaps have a weakref
64
# cache in memory to make this faster. In general anything can be
65
# cached in memory between lock and unlock operations. .. nb thats
66
# what the transaction identity map provides
69
######################################################################
73
"""Branch holding a history of revisions.
76
Base directory/url of the branch.
78
hooks: An instance of BranchHooks.
80
# this is really an instance variable - FIXME move it there
84
# override this to set the strategy for storing tags
86
return DisabledTags(self)
88
def __init__(self, *ignored, **ignored_too):
89
self.tags = self._make_tags()
90
self._revision_history_cache = None
91
self._revision_id_to_revno_cache = None
92
self._partial_revision_id_to_revno_cache = {}
93
self._last_revision_info_cache = None
94
self._merge_sorted_revisions_cache = None
96
hooks = Branch.hooks['open']
100
def _open_hook(self):
101
"""Called by init to allow simpler extension of the base class."""
103
def break_lock(self):
104
"""Break a lock if one is present from another instance.
106
Uses the ui factory to ask for confirmation if the lock may be from
109
This will probe the repository for its lock as well.
111
self.control_files.break_lock()
112
self.repository.break_lock()
113
master = self.get_master_branch()
114
if master is not None:
118
def open(base, _unsupported=False, possible_transports=None):
119
"""Open the branch rooted at base.
121
For instance, if the branch is at URL/.bzr/branch,
122
Branch.open(URL) -> a Branch instance.
124
control = bzrdir.BzrDir.open(base, _unsupported,
125
possible_transports=possible_transports)
126
return control.open_branch(_unsupported)
129
def open_from_transport(transport, _unsupported=False):
130
"""Open the branch rooted at transport"""
131
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
132
return control.open_branch(_unsupported)
135
def open_containing(url, possible_transports=None):
136
"""Open an existing branch which contains url.
138
This probes for a branch at url, and searches upwards from there.
140
Basically we keep looking up until we find the control directory or
141
run into the root. If there isn't one, raises NotBranchError.
142
If there is one and it is either an unrecognised format or an unsupported
143
format, UnknownFormatError or UnsupportedFormatError are raised.
144
If there is one, it is returned, along with the unused portion of url.
146
control, relpath = bzrdir.BzrDir.open_containing(url,
148
return control.open_branch(), relpath
150
def get_config(self):
151
return BranchConfig(self)
153
def _get_nick(self, local=False, possible_transports=None):
154
config = self.get_config()
155
# explicit overrides master, but don't look for master if local is True
156
if not local and not config.has_explicit_nickname():
158
master = self.get_master_branch(possible_transports)
159
if master is not None:
160
# return the master branch value
162
except errors.BzrError, e:
163
# Silently fall back to local implicit nick if the master is
165
mutter("Could not connect to bound branch, "
166
"falling back to local nick.\n " + str(e))
167
return config.get_nickname()
169
def _set_nick(self, nick):
170
self.get_config().set_user_option('nickname', nick, warn_masked=True)
172
nick = property(_get_nick, _set_nick)
175
raise NotImplementedError(self.is_locked)
177
def _lefthand_history(self, revision_id, last_rev=None,
179
if 'evil' in debug.debug_flags:
180
mutter_callsite(4, "_lefthand_history scales with history.")
181
# stop_revision must be a descendant of last_revision
182
graph = self.repository.get_graph()
183
if last_rev is not None:
184
if not graph.is_ancestor(last_rev, revision_id):
185
# our previous tip is not merged into stop_revision
186
raise errors.DivergedBranches(self, other_branch)
187
# make a new revision history from the graph
188
parents_map = graph.get_parent_map([revision_id])
189
if revision_id not in parents_map:
190
raise errors.NoSuchRevision(self, revision_id)
191
current_rev_id = revision_id
193
check_not_reserved_id = _mod_revision.check_not_reserved_id
194
# Do not include ghosts or graph origin in revision_history
195
while (current_rev_id in parents_map and
196
len(parents_map[current_rev_id]) > 0):
197
check_not_reserved_id(current_rev_id)
198
new_history.append(current_rev_id)
199
current_rev_id = parents_map[current_rev_id][0]
200
parents_map = graph.get_parent_map([current_rev_id])
201
new_history.reverse()
204
def lock_write(self):
205
raise NotImplementedError(self.lock_write)
208
raise NotImplementedError(self.lock_read)
211
raise NotImplementedError(self.unlock)
213
def peek_lock_mode(self):
214
"""Return lock mode for the Branch: 'r', 'w' or None"""
215
raise NotImplementedError(self.peek_lock_mode)
217
def get_physical_lock_status(self):
218
raise NotImplementedError(self.get_physical_lock_status)
221
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
222
"""Return the revision_id for a dotted revno.
224
:param revno: a tuple like (1,) or (1,1,2)
225
:param _cache_reverse: a private parameter enabling storage
226
of the reverse mapping in a top level cache. (This should
227
only be done in selective circumstances as we want to
228
avoid having the mapping cached multiple times.)
229
:return: the revision_id
230
:raises errors.NoSuchRevision: if the revno doesn't exist
232
rev_id = self._do_dotted_revno_to_revision_id(revno)
234
self._partial_revision_id_to_revno_cache[rev_id] = revno
237
def _do_dotted_revno_to_revision_id(self, revno):
238
"""Worker function for dotted_revno_to_revision_id.
240
Subclasses should override this if they wish to
241
provide a more efficient implementation.
244
return self.get_rev_id(revno[0])
245
revision_id_to_revno = self.get_revision_id_to_revno_map()
246
revision_ids = [revision_id for revision_id, this_revno
247
in revision_id_to_revno.iteritems()
248
if revno == this_revno]
249
if len(revision_ids) == 1:
250
return revision_ids[0]
252
revno_str = '.'.join(map(str, revno))
253
raise errors.NoSuchRevision(self, revno_str)
256
def revision_id_to_dotted_revno(self, revision_id):
257
"""Given a revision id, return its dotted revno.
259
:return: a tuple like (1,) or (400,1,3).
261
return self._do_revision_id_to_dotted_revno(revision_id)
263
def _do_revision_id_to_dotted_revno(self, revision_id):
264
"""Worker function for revision_id_to_revno."""
265
# Try the caches if they are loaded
266
result = self._partial_revision_id_to_revno_cache.get(revision_id)
267
if result is not None:
269
if self._revision_id_to_revno_cache:
270
result = self._revision_id_to_revno_cache.get(revision_id)
272
raise errors.NoSuchRevision(self, revision_id)
273
# Try the mainline as it's optimised
275
revno = self.revision_id_to_revno(revision_id)
277
except errors.NoSuchRevision:
278
# We need to load and use the full revno map after all
279
result = self.get_revision_id_to_revno_map().get(revision_id)
281
raise errors.NoSuchRevision(self, revision_id)
285
def get_revision_id_to_revno_map(self):
286
"""Return the revision_id => dotted revno map.
288
This will be regenerated on demand, but will be cached.
290
:return: A dictionary mapping revision_id => dotted revno.
291
This dictionary should not be modified by the caller.
293
if self._revision_id_to_revno_cache is not None:
294
mapping = self._revision_id_to_revno_cache
296
mapping = self._gen_revno_map()
297
self._cache_revision_id_to_revno(mapping)
298
# TODO: jam 20070417 Since this is being cached, should we be returning
300
# I would rather not, and instead just declare that users should not
301
# modify the return value.
304
def _gen_revno_map(self):
305
"""Create a new mapping from revision ids to dotted revnos.
307
Dotted revnos are generated based on the current tip in the revision
309
This is the worker function for get_revision_id_to_revno_map, which
310
just caches the return value.
312
:return: A dictionary mapping revision_id => dotted revno.
314
revision_id_to_revno = dict((rev_id, revno)
315
for rev_id, depth, revno, end_of_merge
316
in self.iter_merge_sorted_revisions())
317
return revision_id_to_revno
320
def iter_merge_sorted_revisions(self, start_revision_id=None,
321
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
322
"""Walk the revisions for a branch in merge sorted order.
324
Merge sorted order is the output from a merge-aware,
325
topological sort, i.e. all parents come before their
326
children going forward; the opposite for reverse.
328
:param start_revision_id: the revision_id to begin walking from.
329
If None, the branch tip is used.
330
:param stop_revision_id: the revision_id to terminate the walk
331
after. If None, the rest of history is included.
332
:param stop_rule: if stop_revision_id is not None, the precise rule
333
to use for termination:
334
* 'exclude' - leave the stop revision out of the result (default)
335
* 'include' - the stop revision is the last item in the result
336
* 'with-merges' - include the stop revision and all of its
337
merged revisions in the result
338
:param direction: either 'reverse' or 'forward':
339
* reverse means return the start_revision_id first, i.e.
340
start at the most recent revision and go backwards in history
341
* forward returns tuples in the opposite order to reverse.
342
Note in particular that forward does *not* do any intelligent
343
ordering w.r.t. depth as some clients of this API may like.
344
(If required, that ought to be done at higher layers.)
346
:return: an iterator over (revision_id, depth, revno, end_of_merge)
349
* revision_id: the unique id of the revision
350
* depth: How many levels of merging deep this node has been
352
* revno_sequence: This field provides a sequence of
353
revision numbers for all revisions. The format is:
354
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
355
branch that the revno is on. From left to right the REVNO numbers
356
are the sequence numbers within that branch of the revision.
357
* end_of_merge: When True the next node (earlier in history) is
358
part of a different merge.
360
# Note: depth and revno values are in the context of the branch so
361
# we need the full graph to get stable numbers, regardless of the
363
if self._merge_sorted_revisions_cache is None:
364
last_revision = self.last_revision()
365
graph = self.repository.get_graph()
366
parent_map = dict(((key, value) for key, value in
367
graph.iter_ancestry([last_revision]) if value is not None))
368
revision_graph = repository._strip_NULL_ghosts(parent_map)
369
revs = tsort.merge_sort(revision_graph, last_revision, None,
371
# Drop the sequence # before caching
372
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
374
filtered = self._filter_merge_sorted_revisions(
375
self._merge_sorted_revisions_cache, start_revision_id,
376
stop_revision_id, stop_rule)
377
if direction == 'reverse':
379
if direction == 'forward':
380
return reversed(list(filtered))
382
raise ValueError('invalid direction %r' % direction)
384
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
385
start_revision_id, stop_revision_id, stop_rule):
386
"""Iterate over an inclusive range of sorted revisions."""
387
rev_iter = iter(merge_sorted_revisions)
388
if start_revision_id is not None:
389
for rev_id, depth, revno, end_of_merge in rev_iter:
390
if rev_id != start_revision_id:
393
# The decision to include the start or not
394
# depends on the stop_rule if a stop is provided
396
iter([(rev_id, depth, revno, end_of_merge)]),
399
if stop_revision_id is None:
400
for rev_id, depth, revno, end_of_merge in rev_iter:
401
yield rev_id, depth, revno, end_of_merge
402
elif stop_rule == 'exclude':
403
for rev_id, depth, revno, end_of_merge in rev_iter:
404
if rev_id == stop_revision_id:
406
yield rev_id, depth, revno, end_of_merge
407
elif stop_rule == 'include':
408
for rev_id, depth, revno, end_of_merge in rev_iter:
409
yield rev_id, depth, revno, end_of_merge
410
if rev_id == stop_revision_id:
412
elif stop_rule == 'with-merges':
413
stop_rev = self.repository.get_revision(stop_revision_id)
414
if stop_rev.parent_ids:
415
left_parent = stop_rev.parent_ids[0]
417
left_parent = _mod_revision.NULL_REVISION
418
for rev_id, depth, revno, end_of_merge in rev_iter:
419
if rev_id == left_parent:
421
yield rev_id, depth, revno, end_of_merge
423
raise ValueError('invalid stop_rule %r' % stop_rule)
425
def leave_lock_in_place(self):
426
"""Tell this branch object not to release the physical lock when this
429
If lock_write doesn't return a token, then this method is not supported.
431
self.control_files.leave_in_place()
433
def dont_leave_lock_in_place(self):
434
"""Tell this branch object to release the physical lock when this
435
object is unlocked, even if it didn't originally acquire it.
437
If lock_write doesn't return a token, then this method is not supported.
439
self.control_files.dont_leave_in_place()
441
def bind(self, other):
442
"""Bind the local branch the other branch.
444
:param other: The branch to bind to
447
raise errors.UpgradeRequired(self.base)
450
def fetch(self, from_branch, last_revision=None, pb=None):
451
"""Copy revisions from from_branch into this branch.
453
:param from_branch: Where to copy from.
454
:param last_revision: What revision to stop at (None for at the end
456
:param pb: An optional progress bar to use.
458
Returns the copied revision count and the failed revisions in a tuple:
461
if self.base == from_branch.base:
464
nested_pb = ui.ui_factory.nested_progress_bar()
469
from_branch.lock_read()
471
if last_revision is None:
472
pb.update('get source history')
473
last_revision = from_branch.last_revision()
474
last_revision = _mod_revision.ensure_null(last_revision)
475
return self.repository.fetch(from_branch.repository,
476
revision_id=last_revision,
479
if nested_pb is not None:
483
def get_bound_location(self):
484
"""Return the URL of the branch we are bound to.
486
Older format branches cannot bind, please be sure to use a metadir
491
def get_old_bound_location(self):
492
"""Return the URL of the branch we used to be bound to
494
raise errors.UpgradeRequired(self.base)
496
def get_commit_builder(self, parents, config=None, timestamp=None,
497
timezone=None, committer=None, revprops=None,
499
"""Obtain a CommitBuilder for this branch.
501
:param parents: Revision ids of the parents of the new revision.
502
:param config: Optional configuration to use.
503
:param timestamp: Optional timestamp recorded for commit.
504
:param timezone: Optional timezone for timestamp.
505
:param committer: Optional committer to set for commit.
506
:param revprops: Optional dictionary of revision properties.
507
:param revision_id: Optional revision id.
511
config = self.get_config()
513
return self.repository.get_commit_builder(self, parents, config,
514
timestamp, timezone, committer, revprops, revision_id)
516
def get_master_branch(self, possible_transports=None):
517
"""Return the branch we are bound to.
519
:return: Either a Branch, or None
523
def get_revision_delta(self, revno):
524
"""Return the delta for one revision.
526
The delta is relative to its mainline predecessor, or the
527
empty tree for revision 1.
529
rh = self.revision_history()
530
if not (1 <= revno <= len(rh)):
531
raise errors.InvalidRevisionNumber(revno)
532
return self.repository.get_revision_delta(rh[revno-1])
534
def get_stacked_on_url(self):
535
"""Get the URL this branch is stacked against.
537
:raises NotStacked: If the branch is not stacked.
538
:raises UnstackableBranchFormat: If the branch does not support
541
raise NotImplementedError(self.get_stacked_on_url)
543
def print_file(self, file, revision_id):
544
"""Print `file` to stdout."""
545
raise NotImplementedError(self.print_file)
547
def set_revision_history(self, rev_history):
548
raise NotImplementedError(self.set_revision_history)
550
def set_stacked_on_url(self, url):
551
"""Set the URL this branch is stacked against.
553
:raises UnstackableBranchFormat: If the branch does not support
555
:raises UnstackableRepositoryFormat: If the repository does not support
558
raise NotImplementedError(self.set_stacked_on_url)
560
def _cache_revision_history(self, rev_history):
561
"""Set the cached revision history to rev_history.
563
The revision_history method will use this cache to avoid regenerating
564
the revision history.
566
This API is semi-public; it only for use by subclasses, all other code
567
should consider it to be private.
569
self._revision_history_cache = rev_history
571
def _cache_revision_id_to_revno(self, revision_id_to_revno):
572
"""Set the cached revision_id => revno map to revision_id_to_revno.
574
This API is semi-public; it only for use by subclasses, all other code
575
should consider it to be private.
577
self._revision_id_to_revno_cache = revision_id_to_revno
579
def _clear_cached_state(self):
580
"""Clear any cached data on this branch, e.g. cached revision history.
582
This means the next call to revision_history will need to call
583
_gen_revision_history.
585
This API is semi-public; it only for use by subclasses, all other code
586
should consider it to be private.
588
self._revision_history_cache = None
589
self._revision_id_to_revno_cache = None
590
self._last_revision_info_cache = None
591
self._merge_sorted_revisions_cache = None
593
def _gen_revision_history(self):
594
"""Return sequence of revision hashes on to this branch.
596
Unlike revision_history, this method always regenerates or rereads the
597
revision history, i.e. it does not cache the result, so repeated calls
600
Concrete subclasses should override this instead of revision_history so
601
that subclasses do not need to deal with caching logic.
603
This API is semi-public; it only for use by subclasses, all other code
604
should consider it to be private.
606
raise NotImplementedError(self._gen_revision_history)
609
def revision_history(self):
610
"""Return sequence of revision ids on this branch.
612
This method will cache the revision history for as long as it is safe to
615
if 'evil' in debug.debug_flags:
616
mutter_callsite(3, "revision_history scales with history.")
617
if self._revision_history_cache is not None:
618
history = self._revision_history_cache
620
history = self._gen_revision_history()
621
self._cache_revision_history(history)
625
"""Return current revision number for this branch.
627
That is equivalent to the number of revisions committed to
630
return self.last_revision_info()[0]
633
"""Older format branches cannot bind or unbind."""
634
raise errors.UpgradeRequired(self.base)
636
def set_append_revisions_only(self, enabled):
637
"""Older format branches are never restricted to append-only"""
638
raise errors.UpgradeRequired(self.base)
640
def last_revision(self):
641
"""Return last revision id, or NULL_REVISION."""
642
return self.last_revision_info()[1]
645
def last_revision_info(self):
646
"""Return information about the last revision.
648
:return: A tuple (revno, revision_id).
650
if self._last_revision_info_cache is None:
651
self._last_revision_info_cache = self._last_revision_info()
652
return self._last_revision_info_cache
654
def _last_revision_info(self):
655
rh = self.revision_history()
658
return (revno, rh[-1])
660
return (0, _mod_revision.NULL_REVISION)
662
@deprecated_method(deprecated_in((1, 6, 0)))
663
def missing_revisions(self, other, stop_revision=None):
664
"""Return a list of new revisions that would perfectly fit.
666
If self and other have not diverged, return a list of the revisions
667
present in other, but missing from self.
669
self_history = self.revision_history()
670
self_len = len(self_history)
671
other_history = other.revision_history()
672
other_len = len(other_history)
673
common_index = min(self_len, other_len) -1
674
if common_index >= 0 and \
675
self_history[common_index] != other_history[common_index]:
676
raise errors.DivergedBranches(self, other)
678
if stop_revision is None:
679
stop_revision = other_len
681
if stop_revision > other_len:
682
raise errors.NoSuchRevision(self, stop_revision)
683
return other_history[self_len:stop_revision]
686
def update_revisions(self, other, stop_revision=None, overwrite=False,
688
"""Pull in new perfect-fit revisions.
690
:param other: Another Branch to pull from
691
:param stop_revision: Updated until the given revision
692
:param overwrite: Always set the branch pointer, rather than checking
693
to see if it is a proper descendant.
694
:param graph: A Graph object that can be used to query history
695
information. This can be None.
700
other_revno, other_last_revision = other.last_revision_info()
701
stop_revno = None # unknown
702
if stop_revision is None:
703
stop_revision = other_last_revision
704
if _mod_revision.is_null(stop_revision):
705
# if there are no commits, we're done.
707
stop_revno = other_revno
709
# what's the current last revision, before we fetch [and change it
711
last_rev = _mod_revision.ensure_null(self.last_revision())
712
# we fetch here so that we don't process data twice in the common
713
# case of having something to pull, and so that the check for
714
# already merged can operate on the just fetched graph, which will
715
# be cached in memory.
716
self.fetch(other, stop_revision)
717
# Check to see if one is an ancestor of the other
720
graph = self.repository.get_graph()
721
if self._check_if_descendant_or_diverged(
722
stop_revision, last_rev, graph, other):
723
# stop_revision is a descendant of last_rev, but we aren't
724
# overwriting, so we're done.
726
if stop_revno is None:
728
graph = self.repository.get_graph()
729
this_revno, this_last_revision = self.last_revision_info()
730
stop_revno = graph.find_distance_to_null(stop_revision,
731
[(other_last_revision, other_revno),
732
(this_last_revision, this_revno)])
733
self.set_last_revision_info(stop_revno, stop_revision)
737
def revision_id_to_revno(self, revision_id):
738
"""Given a revision id, return its revno"""
739
if _mod_revision.is_null(revision_id):
741
history = self.revision_history()
743
return history.index(revision_id) + 1
745
raise errors.NoSuchRevision(self, revision_id)
747
def get_rev_id(self, revno, history=None):
748
"""Find the revision id of the specified revno."""
750
return _mod_revision.NULL_REVISION
752
history = self.revision_history()
753
if revno <= 0 or revno > len(history):
754
raise errors.NoSuchRevision(self, revno)
755
return history[revno - 1]
757
def pull(self, source, overwrite=False, stop_revision=None,
758
possible_transports=None, _override_hook_target=None):
759
"""Mirror source into this branch.
761
This branch is considered to be 'local', having low latency.
763
:returns: PullResult instance
765
raise NotImplementedError(self.pull)
767
def push(self, target, overwrite=False, stop_revision=None):
768
"""Mirror this branch into target.
770
This branch is considered to be 'local', having low latency.
772
raise NotImplementedError(self.push)
774
def basis_tree(self):
775
"""Return `Tree` object for last revision."""
776
return self.repository.revision_tree(self.last_revision())
778
def get_parent(self):
779
"""Return the parent location of the branch.
781
This is the default location for push/pull/missing. The usual
782
pattern is that the user can override it by specifying a
785
raise NotImplementedError(self.get_parent)
787
def _set_config_location(self, name, url, config=None,
788
make_relative=False):
790
config = self.get_config()
794
url = urlutils.relative_url(self.base, url)
795
config.set_user_option(name, url, warn_masked=True)
797
def _get_config_location(self, name, config=None):
799
config = self.get_config()
800
location = config.get_user_option(name)
805
def get_submit_branch(self):
806
"""Return the submit location of the branch.
808
This is the default location for bundle. The usual
809
pattern is that the user can override it by specifying a
812
return self.get_config().get_user_option('submit_branch')
814
def set_submit_branch(self, location):
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
self.get_config().set_user_option('submit_branch', location,
824
def get_public_branch(self):
825
"""Return the public location of the branch.
827
This is is used by merge directives.
829
return self._get_config_location('public_branch')
831
def set_public_branch(self, location):
832
"""Return the submit location of the branch.
834
This is the default location for bundle. The usual
835
pattern is that the user can override it by specifying a
838
self._set_config_location('public_branch', location)
840
def get_push_location(self):
841
"""Return the None or the location to push this branch to."""
842
push_loc = self.get_config().get_user_option('push_location')
845
def set_push_location(self, location):
846
"""Set a new push location for this branch."""
847
raise NotImplementedError(self.set_push_location)
849
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
850
"""Run the post_change_branch_tip hooks."""
851
hooks = Branch.hooks['post_change_branch_tip']
854
new_revno, new_revid = self.last_revision_info()
855
params = ChangeBranchTipParams(
856
self, old_revno, new_revno, old_revid, new_revid)
860
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
861
"""Run the pre_change_branch_tip hooks."""
862
hooks = Branch.hooks['pre_change_branch_tip']
865
old_revno, old_revid = self.last_revision_info()
866
params = ChangeBranchTipParams(
867
self, old_revno, new_revno, old_revid, new_revid)
871
except errors.TipChangeRejected:
874
exc_info = sys.exc_info()
875
hook_name = Branch.hooks.get_hook_name(hook)
876
raise errors.HookFailed(
877
'pre_change_branch_tip', hook_name, exc_info)
879
def set_parent(self, url):
880
raise NotImplementedError(self.set_parent)
884
"""Synchronise this branch with the master branch if any.
886
:return: None or the last_revision pivoted out during the update.
890
def check_revno(self, revno):
892
Check whether a revno corresponds to any revision.
893
Zero (the NULL revision) is considered valid.
896
self.check_real_revno(revno)
898
def check_real_revno(self, revno):
900
Check whether a revno corresponds to a real revision.
901
Zero (the NULL revision) is considered invalid
903
if revno < 1 or revno > self.revno():
904
raise errors.InvalidRevisionNumber(revno)
907
def clone(self, to_bzrdir, revision_id=None):
908
"""Clone this branch into to_bzrdir preserving all semantic values.
910
revision_id: if not None, the revision history in the new branch will
911
be truncated to end with revision_id.
913
result = to_bzrdir.create_branch()
914
self.copy_content_into(result, revision_id=revision_id)
918
def sprout(self, to_bzrdir, revision_id=None):
919
"""Create a new line of development from the branch, into to_bzrdir.
921
to_bzrdir controls the branch format.
923
revision_id: if not None, the revision history in the new branch will
924
be truncated to end with revision_id.
926
result = to_bzrdir.create_branch()
927
self.copy_content_into(result, revision_id=revision_id)
928
result.set_parent(self.bzrdir.root_transport.base)
931
def _synchronize_history(self, destination, revision_id):
932
"""Synchronize last revision and revision history between branches.
934
This version is most efficient when the destination is also a
935
BzrBranch6, but works for BzrBranch5, as long as the destination's
936
repository contains all the lefthand ancestors of the intended
937
last_revision. If not, set_last_revision_info will fail.
939
:param destination: The branch to copy the history into
940
:param revision_id: The revision-id to truncate history at. May
941
be None to copy complete history.
943
source_revno, source_revision_id = self.last_revision_info()
944
if revision_id is None:
945
revno, revision_id = source_revno, source_revision_id
946
elif source_revision_id == revision_id:
947
# we know the revno without needing to walk all of history
950
# To figure out the revno for a random revision, we need to build
951
# the revision history, and count its length.
952
# We don't care about the order, just how long it is.
953
# Alternatively, we could start at the current location, and count
954
# backwards. But there is no guarantee that we will find it since
955
# it may be a merged revision.
956
revno = len(list(self.repository.iter_reverse_revision_history(
958
destination.set_last_revision_info(revno, revision_id)
961
def copy_content_into(self, destination, revision_id=None):
962
"""Copy the content of self into destination.
964
revision_id: if not None, the revision history in the new branch will
965
be truncated to end with revision_id.
967
self._synchronize_history(destination, revision_id)
969
parent = self.get_parent()
970
except errors.InaccessibleParent, e:
971
mutter('parent was not accessible to copy: %s', e)
974
destination.set_parent(parent)
975
self.tags.merge_to(destination.tags)
979
"""Check consistency of the branch.
981
In particular this checks that revisions given in the revision-history
982
do actually match up in the revision graph, and that they're all
983
present in the repository.
985
Callers will typically also want to check the repository.
987
:return: A BranchCheckResult.
989
mainline_parent_id = None
990
last_revno, last_revision_id = self.last_revision_info()
991
real_rev_history = list(self.repository.iter_reverse_revision_history(
993
real_rev_history.reverse()
994
if len(real_rev_history) != last_revno:
995
raise errors.BzrCheckError('revno does not match len(mainline)'
996
' %s != %s' % (last_revno, len(real_rev_history)))
997
# TODO: We should probably also check that real_rev_history actually
998
# matches self.revision_history()
999
for revision_id in real_rev_history:
1001
revision = self.repository.get_revision(revision_id)
1002
except errors.NoSuchRevision, e:
1003
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1005
# In general the first entry on the revision history has no parents.
1006
# But it's not illegal for it to have parents listed; this can happen
1007
# in imports from Arch when the parents weren't reachable.
1008
if mainline_parent_id is not None:
1009
if mainline_parent_id not in revision.parent_ids:
1010
raise errors.BzrCheckError("previous revision {%s} not listed among "
1012
% (mainline_parent_id, revision_id))
1013
mainline_parent_id = revision_id
1014
return BranchCheckResult(self)
1016
def _get_checkout_format(self):
1017
"""Return the most suitable metadir for a checkout of this branch.
1018
Weaves are used if this branch's repository uses weaves.
1020
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1021
from bzrlib.repofmt import weaverepo
1022
format = bzrdir.BzrDirMetaFormat1()
1023
format.repository_format = weaverepo.RepositoryFormat7()
1025
format = self.repository.bzrdir.checkout_metadir()
1026
format.set_branch_format(self._format)
1029
def create_checkout(self, to_location, revision_id=None,
1030
lightweight=False, accelerator_tree=None,
1032
"""Create a checkout of a branch.
1034
:param to_location: The url to produce the checkout at
1035
:param revision_id: The revision to check out
1036
:param lightweight: If True, produce a lightweight checkout, otherwise,
1037
produce a bound branch (heavyweight checkout)
1038
:param accelerator_tree: A tree which can be used for retrieving file
1039
contents more quickly than the revision tree, i.e. a workingtree.
1040
The revision tree will be used for cases where accelerator_tree's
1041
content is different.
1042
:param hardlink: If true, hard-link files from accelerator_tree,
1044
:return: The tree of the created checkout
1046
t = transport.get_transport(to_location)
1049
format = self._get_checkout_format()
1050
checkout = format.initialize_on_transport(t)
1051
from_branch = BranchReferenceFormat().initialize(checkout, self)
1053
format = self._get_checkout_format()
1054
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1055
to_location, force_new_tree=False, format=format)
1056
checkout = checkout_branch.bzrdir
1057
checkout_branch.bind(self)
1058
# pull up to the specified revision_id to set the initial
1059
# branch tip correctly, and seed it with history.
1060
checkout_branch.pull(self, stop_revision=revision_id)
1062
tree = checkout.create_workingtree(revision_id,
1063
from_branch=from_branch,
1064
accelerator_tree=accelerator_tree,
1066
basis_tree = tree.basis_tree()
1067
basis_tree.lock_read()
1069
for path, file_id in basis_tree.iter_references():
1070
reference_parent = self.reference_parent(file_id, path)
1071
reference_parent.create_checkout(tree.abspath(path),
1072
basis_tree.get_reference_revision(file_id, path),
1079
def reconcile(self, thorough=True):
1080
"""Make sure the data stored in this branch is consistent."""
1081
from bzrlib.reconcile import BranchReconciler
1082
reconciler = BranchReconciler(self, thorough=thorough)
1083
reconciler.reconcile()
1086
def reference_parent(self, file_id, path):
1087
"""Return the parent branch for a tree-reference file_id
1088
:param file_id: The file_id of the tree reference
1089
:param path: The path of the file_id in the tree
1090
:return: A branch associated with the file_id
1092
# FIXME should provide multiple branches, based on config
1093
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1095
def supports_tags(self):
1096
return self._format.supports_tags()
1098
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1100
"""Ensure that revision_b is a descendant of revision_a.
1102
This is a helper function for update_revisions.
1104
:raises: DivergedBranches if revision_b has diverged from revision_a.
1105
:returns: True if revision_b is a descendant of revision_a.
1107
relation = self._revision_relations(revision_a, revision_b, graph)
1108
if relation == 'b_descends_from_a':
1110
elif relation == 'diverged':
1111
raise errors.DivergedBranches(self, other_branch)
1112
elif relation == 'a_descends_from_b':
1115
raise AssertionError("invalid relation: %r" % (relation,))
1117
def _revision_relations(self, revision_a, revision_b, graph):
1118
"""Determine the relationship between two revisions.
1120
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1122
heads = graph.heads([revision_a, revision_b])
1123
if heads == set([revision_b]):
1124
return 'b_descends_from_a'
1125
elif heads == set([revision_a, revision_b]):
1126
# These branches have diverged
1128
elif heads == set([revision_a]):
1129
return 'a_descends_from_b'
1131
raise AssertionError("invalid heads: %r" % (heads,))
1134
class BranchFormat(object):
1135
"""An encapsulation of the initialization and open routines for a format.
1137
Formats provide three things:
1138
* An initialization routine,
1142
Formats are placed in an dict by their format string for reference
1143
during branch opening. Its not required that these be instances, they
1144
can be classes themselves with class methods - it simply depends on
1145
whether state is needed for a given format or not.
1147
Once a format is deprecated, just deprecate the initialize and open
1148
methods on the format class. Do not deprecate the object, as the
1149
object will be created every time regardless.
1152
_default_format = None
1153
"""The default format used for new branches."""
1156
"""The known formats."""
1158
def __eq__(self, other):
1159
return self.__class__ is other.__class__
1161
def __ne__(self, other):
1162
return not (self == other)
1165
def find_format(klass, a_bzrdir):
1166
"""Return the format for the branch object in a_bzrdir."""
1168
transport = a_bzrdir.get_branch_transport(None)
1169
format_string = transport.get("format").read()
1170
return klass._formats[format_string]
1171
except errors.NoSuchFile:
1172
raise errors.NotBranchError(path=transport.base)
1174
raise errors.UnknownFormatError(format=format_string, kind='branch')
1177
def get_default_format(klass):
1178
"""Return the current default format."""
1179
return klass._default_format
1181
def get_reference(self, a_bzrdir):
1182
"""Get the target reference of the branch in a_bzrdir.
1184
format probing must have been completed before calling
1185
this method - it is assumed that the format of the branch
1186
in a_bzrdir is correct.
1188
:param a_bzrdir: The bzrdir to get the branch data from.
1189
:return: None if the branch is not a reference branch.
1194
def set_reference(self, a_bzrdir, to_branch):
1195
"""Set the target reference of the branch in a_bzrdir.
1197
format probing must have been completed before calling
1198
this method - it is assumed that the format of the branch
1199
in a_bzrdir is correct.
1201
:param a_bzrdir: The bzrdir to set the branch reference for.
1202
:param to_branch: branch that the checkout is to reference
1204
raise NotImplementedError(self.set_reference)
1206
def get_format_string(self):
1207
"""Return the ASCII format string that identifies this format."""
1208
raise NotImplementedError(self.get_format_string)
1210
def get_format_description(self):
1211
"""Return the short format description for this format."""
1212
raise NotImplementedError(self.get_format_description)
1214
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1216
"""Initialize a branch in a bzrdir, with specified files
1218
:param a_bzrdir: The bzrdir to initialize the branch in
1219
:param utf8_files: The files to create as a list of
1220
(filename, content) tuples
1221
:param set_format: If True, set the format with
1222
self.get_format_string. (BzrBranch4 has its format set
1224
:return: a branch in this format
1226
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1227
branch_transport = a_bzrdir.get_branch_transport(self)
1229
'metadir': ('lock', lockdir.LockDir),
1230
'branch4': ('branch-lock', lockable_files.TransportLock),
1232
lock_name, lock_class = lock_map[lock_type]
1233
control_files = lockable_files.LockableFiles(branch_transport,
1234
lock_name, lock_class)
1235
control_files.create_lock()
1236
control_files.lock_write()
1238
utf8_files += [('format', self.get_format_string())]
1240
for (filename, content) in utf8_files:
1241
branch_transport.put_bytes(
1243
mode=a_bzrdir._get_file_mode())
1245
control_files.unlock()
1246
return self.open(a_bzrdir, _found=True)
1248
def initialize(self, a_bzrdir):
1249
"""Create a branch of this format in a_bzrdir."""
1250
raise NotImplementedError(self.initialize)
1252
def is_supported(self):
1253
"""Is this format supported?
1255
Supported formats can be initialized and opened.
1256
Unsupported formats may not support initialization or committing or
1257
some other features depending on the reason for not being supported.
1261
def open(self, a_bzrdir, _found=False):
1262
"""Return the branch object for a_bzrdir
1264
_found is a private parameter, do not use it. It is used to indicate
1265
if format probing has already be done.
1267
raise NotImplementedError(self.open)
1270
def register_format(klass, format):
1271
klass._formats[format.get_format_string()] = format
1274
def set_default_format(klass, format):
1275
klass._default_format = format
1277
def supports_stacking(self):
1278
"""True if this format records a stacked-on branch."""
1282
def unregister_format(klass, format):
1283
del klass._formats[format.get_format_string()]
1286
return self.get_format_string().rstrip()
1288
def supports_tags(self):
1289
"""True if this format supports tags stored in the branch"""
1290
return False # by default
1293
class BranchHooks(Hooks):
1294
"""A dictionary mapping hook name to a list of callables for branch hooks.
1296
e.g. ['set_rh'] Is the list of items to be called when the
1297
set_revision_history function is invoked.
1301
"""Create the default hooks.
1303
These are all empty initially, because by default nothing should get
1306
Hooks.__init__(self)
1307
# Introduced in 0.15:
1308
# invoked whenever the revision history has been set
1309
# with set_revision_history. The api signature is
1310
# (branch, revision_history), and the branch will
1313
# Invoked after a branch is opened. The api signature is (branch).
1315
# invoked after a push operation completes.
1316
# the api signature is
1318
# containing the members
1319
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1320
# where local is the local target branch or None, master is the target
1321
# master branch, and the rest should be self explanatory. The source
1322
# is read locked and the target branches write locked. Source will
1323
# be the local low-latency branch.
1324
self['post_push'] = []
1325
# invoked after a pull operation completes.
1326
# the api signature is
1328
# containing the members
1329
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1330
# where local is the local branch or None, master is the target
1331
# master branch, and the rest should be self explanatory. The source
1332
# is read locked and the target branches write locked. The local
1333
# branch is the low-latency branch.
1334
self['post_pull'] = []
1335
# invoked before a commit operation takes place.
1336
# the api signature is
1337
# (local, master, old_revno, old_revid, future_revno, future_revid,
1338
# tree_delta, future_tree).
1339
# old_revid is NULL_REVISION for the first commit to a branch
1340
# tree_delta is a TreeDelta object describing changes from the basis
1341
# revision, hooks MUST NOT modify this delta
1342
# future_tree is an in-memory tree obtained from
1343
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1344
self['pre_commit'] = []
1345
# invoked after a commit operation completes.
1346
# the api signature is
1347
# (local, master, old_revno, old_revid, new_revno, new_revid)
1348
# old_revid is NULL_REVISION for the first commit to a branch.
1349
self['post_commit'] = []
1350
# invoked after a uncommit operation completes.
1351
# the api signature is
1352
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1353
# local is the local branch or None, master is the target branch,
1354
# and an empty branch recieves new_revno of 0, new_revid of None.
1355
self['post_uncommit'] = []
1357
# Invoked before the tip of a branch changes.
1358
# the api signature is
1359
# (params) where params is a ChangeBranchTipParams with the members
1360
# (branch, old_revno, new_revno, old_revid, new_revid)
1361
self['pre_change_branch_tip'] = []
1363
# Invoked after the tip of a branch changes.
1364
# the api signature is
1365
# (params) where params is a ChangeBranchTipParams with the members
1366
# (branch, old_revno, new_revno, old_revid, new_revid)
1367
self['post_change_branch_tip'] = []
1369
# Invoked when a stacked branch activates its fallback locations and
1370
# allows the transformation of the url of said location.
1371
# the api signature is
1372
# (branch, url) where branch is the branch having its fallback
1373
# location activated and url is the url for the fallback location.
1374
# The hook should return a url.
1375
self['transform_fallback_location'] = []
1378
# install the default hooks into the Branch class.
1379
Branch.hooks = BranchHooks()
1382
class ChangeBranchTipParams(object):
1383
"""Object holding parameters passed to *_change_branch_tip hooks.
1385
There are 5 fields that hooks may wish to access:
1387
:ivar branch: the branch being changed
1388
:ivar old_revno: revision number before the change
1389
:ivar new_revno: revision number after the change
1390
:ivar old_revid: revision id before the change
1391
:ivar new_revid: revision id after the change
1393
The revid fields are strings. The revno fields are integers.
1396
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1397
"""Create a group of ChangeBranchTip parameters.
1399
:param branch: The branch being changed.
1400
:param old_revno: Revision number before the change.
1401
:param new_revno: Revision number after the change.
1402
:param old_revid: Tip revision id before the change.
1403
:param new_revid: Tip revision id after the change.
1405
self.branch = branch
1406
self.old_revno = old_revno
1407
self.new_revno = new_revno
1408
self.old_revid = old_revid
1409
self.new_revid = new_revid
1411
def __eq__(self, other):
1412
return self.__dict__ == other.__dict__
1415
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1416
self.__class__.__name__, self.branch,
1417
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1420
class BzrBranchFormat4(BranchFormat):
1421
"""Bzr branch format 4.
1424
- a revision-history file.
1425
- a branch-lock lock file [ to be shared with the bzrdir ]
1428
def get_format_description(self):
1429
"""See BranchFormat.get_format_description()."""
1430
return "Branch format 4"
1432
def initialize(self, a_bzrdir):
1433
"""Create a branch of this format in a_bzrdir."""
1434
utf8_files = [('revision-history', ''),
1435
('branch-name', ''),
1437
return self._initialize_helper(a_bzrdir, utf8_files,
1438
lock_type='branch4', set_format=False)
1441
super(BzrBranchFormat4, self).__init__()
1442
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1444
def open(self, a_bzrdir, _found=False):
1445
"""Return the branch object for a_bzrdir
1447
_found is a private parameter, do not use it. It is used to indicate
1448
if format probing has already be done.
1451
# we are being called directly and must probe.
1452
raise NotImplementedError
1453
return BzrBranch(_format=self,
1454
_control_files=a_bzrdir._control_files,
1456
_repository=a_bzrdir.open_repository())
1459
return "Bazaar-NG branch format 4"
1462
class BranchFormatMetadir(BranchFormat):
1463
"""Common logic for meta-dir based branch formats."""
1465
def _branch_class(self):
1466
"""What class to instantiate on open calls."""
1467
raise NotImplementedError(self._branch_class)
1469
def open(self, a_bzrdir, _found=False):
1470
"""Return the branch object for a_bzrdir.
1472
_found is a private parameter, do not use it. It is used to indicate
1473
if format probing has already be done.
1476
format = BranchFormat.find_format(a_bzrdir)
1477
if format.__class__ != self.__class__:
1478
raise AssertionError("wrong format %r found for %r" %
1481
transport = a_bzrdir.get_branch_transport(None)
1482
control_files = lockable_files.LockableFiles(transport, 'lock',
1484
return self._branch_class()(_format=self,
1485
_control_files=control_files,
1487
_repository=a_bzrdir.find_repository())
1488
except errors.NoSuchFile:
1489
raise errors.NotBranchError(path=transport.base)
1492
super(BranchFormatMetadir, self).__init__()
1493
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1494
self._matchingbzrdir.set_branch_format(self)
1496
def supports_tags(self):
1500
class BzrBranchFormat5(BranchFormatMetadir):
1501
"""Bzr branch format 5.
1504
- a revision-history file.
1506
- a lock dir guarding the branch itself
1507
- all of this stored in a branch/ subdirectory
1508
- works with shared repositories.
1510
This format is new in bzr 0.8.
1513
def _branch_class(self):
1516
def get_format_string(self):
1517
"""See BranchFormat.get_format_string()."""
1518
return "Bazaar-NG branch format 5\n"
1520
def get_format_description(self):
1521
"""See BranchFormat.get_format_description()."""
1522
return "Branch format 5"
1524
def initialize(self, a_bzrdir):
1525
"""Create a branch of this format in a_bzrdir."""
1526
utf8_files = [('revision-history', ''),
1527
('branch-name', ''),
1529
return self._initialize_helper(a_bzrdir, utf8_files)
1531
def supports_tags(self):
1535
class BzrBranchFormat6(BranchFormatMetadir):
1536
"""Branch format with last-revision and tags.
1538
Unlike previous formats, this has no explicit revision history. Instead,
1539
this just stores the last-revision, and the left-hand history leading
1540
up to there is the history.
1542
This format was introduced in bzr 0.15
1543
and became the default in 0.91.
1546
def _branch_class(self):
1549
def get_format_string(self):
1550
"""See BranchFormat.get_format_string()."""
1551
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1553
def get_format_description(self):
1554
"""See BranchFormat.get_format_description()."""
1555
return "Branch format 6"
1557
def initialize(self, a_bzrdir):
1558
"""Create a branch of this format in a_bzrdir."""
1559
utf8_files = [('last-revision', '0 null:\n'),
1560
('branch.conf', ''),
1563
return self._initialize_helper(a_bzrdir, utf8_files)
1566
class BzrBranchFormat7(BranchFormatMetadir):
1567
"""Branch format with last-revision, tags, and a stacked location pointer.
1569
The stacked location pointer is passed down to the repository and requires
1570
a repository format with supports_external_lookups = True.
1572
This format was introduced in bzr 1.6.
1575
def _branch_class(self):
1578
def get_format_string(self):
1579
"""See BranchFormat.get_format_string()."""
1580
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1582
def get_format_description(self):
1583
"""See BranchFormat.get_format_description()."""
1584
return "Branch format 7"
1586
def initialize(self, a_bzrdir):
1587
"""Create a branch of this format in a_bzrdir."""
1588
utf8_files = [('last-revision', '0 null:\n'),
1589
('branch.conf', ''),
1592
return self._initialize_helper(a_bzrdir, utf8_files)
1595
super(BzrBranchFormat7, self).__init__()
1596
self._matchingbzrdir.repository_format = \
1597
RepositoryFormatKnitPack5RichRoot()
1599
def supports_stacking(self):
1603
class BranchReferenceFormat(BranchFormat):
1604
"""Bzr branch reference format.
1606
Branch references are used in implementing checkouts, they
1607
act as an alias to the real branch which is at some other url.
1614
def get_format_string(self):
1615
"""See BranchFormat.get_format_string()."""
1616
return "Bazaar-NG Branch Reference Format 1\n"
1618
def get_format_description(self):
1619
"""See BranchFormat.get_format_description()."""
1620
return "Checkout reference format 1"
1622
def get_reference(self, a_bzrdir):
1623
"""See BranchFormat.get_reference()."""
1624
transport = a_bzrdir.get_branch_transport(None)
1625
return transport.get('location').read()
1627
def set_reference(self, a_bzrdir, to_branch):
1628
"""See BranchFormat.set_reference()."""
1629
transport = a_bzrdir.get_branch_transport(None)
1630
location = transport.put_bytes('location', to_branch.base)
1632
def initialize(self, a_bzrdir, target_branch=None):
1633
"""Create a branch of this format in a_bzrdir."""
1634
if target_branch is None:
1635
# this format does not implement branch itself, thus the implicit
1636
# creation contract must see it as uninitializable
1637
raise errors.UninitializableFormat(self)
1638
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1639
branch_transport = a_bzrdir.get_branch_transport(self)
1640
branch_transport.put_bytes('location',
1641
target_branch.bzrdir.root_transport.base)
1642
branch_transport.put_bytes('format', self.get_format_string())
1644
a_bzrdir, _found=True,
1645
possible_transports=[target_branch.bzrdir.root_transport])
1648
super(BranchReferenceFormat, self).__init__()
1649
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1650
self._matchingbzrdir.set_branch_format(self)
1652
def _make_reference_clone_function(format, a_branch):
1653
"""Create a clone() routine for a branch dynamically."""
1654
def clone(to_bzrdir, revision_id=None):
1655
"""See Branch.clone()."""
1656
return format.initialize(to_bzrdir, a_branch)
1657
# cannot obey revision_id limits when cloning a reference ...
1658
# FIXME RBC 20060210 either nuke revision_id for clone, or
1659
# emit some sort of warning/error to the caller ?!
1662
def open(self, a_bzrdir, _found=False, location=None,
1663
possible_transports=None):
1664
"""Return the branch that the branch reference in a_bzrdir points at.
1666
_found is a private parameter, do not use it. It is used to indicate
1667
if format probing has already be done.
1670
format = BranchFormat.find_format(a_bzrdir)
1671
if format.__class__ != self.__class__:
1672
raise AssertionError("wrong format %r found for %r" %
1674
if location is None:
1675
location = self.get_reference(a_bzrdir)
1676
real_bzrdir = bzrdir.BzrDir.open(
1677
location, possible_transports=possible_transports)
1678
result = real_bzrdir.open_branch()
1679
# this changes the behaviour of result.clone to create a new reference
1680
# rather than a copy of the content of the branch.
1681
# I did not use a proxy object because that needs much more extensive
1682
# testing, and we are only changing one behaviour at the moment.
1683
# If we decide to alter more behaviours - i.e. the implicit nickname
1684
# then this should be refactored to introduce a tested proxy branch
1685
# and a subclass of that for use in overriding clone() and ....
1687
result.clone = self._make_reference_clone_function(result)
1691
# formats which have no format string are not discoverable
1692
# and not independently creatable, so are not registered.
1693
__format5 = BzrBranchFormat5()
1694
__format6 = BzrBranchFormat6()
1695
__format7 = BzrBranchFormat7()
1696
BranchFormat.register_format(__format5)
1697
BranchFormat.register_format(BranchReferenceFormat())
1698
BranchFormat.register_format(__format6)
1699
BranchFormat.register_format(__format7)
1700
BranchFormat.set_default_format(__format6)
1701
_legacy_formats = [BzrBranchFormat4(),
1704
class BzrBranch(Branch):
1705
"""A branch stored in the actual filesystem.
1707
Note that it's "local" in the context of the filesystem; it doesn't
1708
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1709
it's writable, and can be accessed via the normal filesystem API.
1711
:ivar _transport: Transport for file operations on this branch's
1712
control files, typically pointing to the .bzr/branch directory.
1713
:ivar repository: Repository for this branch.
1714
:ivar base: The url of the base directory for this branch; the one
1715
containing the .bzr directory.
1718
def __init__(self, _format=None,
1719
_control_files=None, a_bzrdir=None, _repository=None):
1720
"""Create new branch object at a particular location."""
1721
if a_bzrdir is None:
1722
raise ValueError('a_bzrdir must be supplied')
1724
self.bzrdir = a_bzrdir
1725
self._base = self.bzrdir.transport.clone('..').base
1726
# XXX: We should be able to just do
1727
# self.base = self.bzrdir.root_transport.base
1728
# but this does not quite work yet -- mbp 20080522
1729
self._format = _format
1730
if _control_files is None:
1731
raise ValueError('BzrBranch _control_files is None')
1732
self.control_files = _control_files
1733
self._transport = _control_files._transport
1734
self.repository = _repository
1735
Branch.__init__(self)
1738
return '%s(%r)' % (self.__class__.__name__, self.base)
1742
def _get_base(self):
1743
"""Returns the directory containing the control directory."""
1746
base = property(_get_base, doc="The URL for the root of this branch.")
1748
def is_locked(self):
1749
return self.control_files.is_locked()
1751
def lock_write(self, token=None):
1752
repo_token = self.repository.lock_write()
1754
token = self.control_files.lock_write(token=token)
1756
self.repository.unlock()
1760
def lock_read(self):
1761
self.repository.lock_read()
1763
self.control_files.lock_read()
1765
self.repository.unlock()
1769
# TODO: test for failed two phase locks. This is known broken.
1771
self.control_files.unlock()
1773
self.repository.unlock()
1774
if not self.control_files.is_locked():
1775
# we just released the lock
1776
self._clear_cached_state()
1778
def peek_lock_mode(self):
1779
if self.control_files._lock_count == 0:
1782
return self.control_files._lock_mode
1784
def get_physical_lock_status(self):
1785
return self.control_files.get_physical_lock_status()
1788
def print_file(self, file, revision_id):
1789
"""See Branch.print_file."""
1790
return self.repository.print_file(file, revision_id)
1792
def _write_revision_history(self, history):
1793
"""Factored out of set_revision_history.
1795
This performs the actual writing to disk.
1796
It is intended to be called by BzrBranch5.set_revision_history."""
1797
self._transport.put_bytes(
1798
'revision-history', '\n'.join(history),
1799
mode=self.bzrdir._get_file_mode())
1802
def set_revision_history(self, rev_history):
1803
"""See Branch.set_revision_history."""
1804
if 'evil' in debug.debug_flags:
1805
mutter_callsite(3, "set_revision_history scales with history.")
1806
check_not_reserved_id = _mod_revision.check_not_reserved_id
1807
for rev_id in rev_history:
1808
check_not_reserved_id(rev_id)
1809
if Branch.hooks['post_change_branch_tip']:
1810
# Don't calculate the last_revision_info() if there are no hooks
1812
old_revno, old_revid = self.last_revision_info()
1813
if len(rev_history) == 0:
1814
revid = _mod_revision.NULL_REVISION
1816
revid = rev_history[-1]
1817
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1818
self._write_revision_history(rev_history)
1819
self._clear_cached_state()
1820
self._cache_revision_history(rev_history)
1821
for hook in Branch.hooks['set_rh']:
1822
hook(self, rev_history)
1823
if Branch.hooks['post_change_branch_tip']:
1824
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1826
def _synchronize_history(self, destination, revision_id):
1827
"""Synchronize last revision and revision history between branches.
1829
This version is most efficient when the destination is also a
1830
BzrBranch5, but works for BzrBranch6 as long as the revision
1831
history is the true lefthand parent history, and all of the revisions
1832
are in the destination's repository. If not, set_revision_history
1835
:param destination: The branch to copy the history into
1836
:param revision_id: The revision-id to truncate history at. May
1837
be None to copy complete history.
1839
if not isinstance(destination._format, BzrBranchFormat5):
1840
super(BzrBranch, self)._synchronize_history(
1841
destination, revision_id)
1843
if revision_id == _mod_revision.NULL_REVISION:
1846
new_history = self.revision_history()
1847
if revision_id is not None and new_history != []:
1849
new_history = new_history[:new_history.index(revision_id) + 1]
1851
rev = self.repository.get_revision(revision_id)
1852
new_history = rev.get_history(self.repository)[1:]
1853
destination.set_revision_history(new_history)
1856
def set_last_revision_info(self, revno, revision_id):
1857
"""Set the last revision of this branch.
1859
The caller is responsible for checking that the revno is correct
1860
for this revision id.
1862
It may be possible to set the branch last revision to an id not
1863
present in the repository. However, branches can also be
1864
configured to check constraints on history, in which case this may not
1867
revision_id = _mod_revision.ensure_null(revision_id)
1868
# this old format stores the full history, but this api doesn't
1869
# provide it, so we must generate, and might as well check it's
1871
history = self._lefthand_history(revision_id)
1872
if len(history) != revno:
1873
raise AssertionError('%d != %d' % (len(history), revno))
1874
self.set_revision_history(history)
1876
def _gen_revision_history(self):
1877
history = self._transport.get_bytes('revision-history').split('\n')
1878
if history[-1:] == ['']:
1879
# There shouldn't be a trailing newline, but just in case.
1884
def generate_revision_history(self, revision_id, last_rev=None,
1886
"""Create a new revision history that will finish with revision_id.
1888
:param revision_id: the new tip to use.
1889
:param last_rev: The previous last_revision. If not None, then this
1890
must be a ancestory of revision_id, or DivergedBranches is raised.
1891
:param other_branch: The other branch that DivergedBranches should
1892
raise with respect to.
1894
self.set_revision_history(self._lefthand_history(revision_id,
1895
last_rev, other_branch))
1897
def basis_tree(self):
1898
"""See Branch.basis_tree."""
1899
return self.repository.revision_tree(self.last_revision())
1902
def pull(self, source, overwrite=False, stop_revision=None,
1903
_hook_master=None, run_hooks=True, possible_transports=None,
1904
_override_hook_target=None):
1907
:param _hook_master: Private parameter - set the branch to
1908
be supplied as the master to pull hooks.
1909
:param run_hooks: Private parameter - if false, this branch
1910
is being called because it's the master of the primary branch,
1911
so it should not run its hooks.
1912
:param _override_hook_target: Private parameter - set the branch to be
1913
supplied as the target_branch to pull hooks.
1915
result = PullResult()
1916
result.source_branch = source
1917
if _override_hook_target is None:
1918
result.target_branch = self
1920
result.target_branch = _override_hook_target
1923
# We assume that during 'pull' the local repository is closer than
1925
graph = self.repository.get_graph(source.repository)
1926
result.old_revno, result.old_revid = self.last_revision_info()
1927
self.update_revisions(source, stop_revision, overwrite=overwrite,
1929
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1930
result.new_revno, result.new_revid = self.last_revision_info()
1932
result.master_branch = _hook_master
1933
result.local_branch = result.target_branch
1935
result.master_branch = result.target_branch
1936
result.local_branch = None
1938
for hook in Branch.hooks['post_pull']:
1944
def _get_parent_location(self):
1945
_locs = ['parent', 'pull', 'x-pull']
1948
return self._transport.get_bytes(l).strip('\n')
1949
except errors.NoSuchFile:
1954
def push(self, target, overwrite=False, stop_revision=None,
1955
_override_hook_source_branch=None):
1958
This is the basic concrete implementation of push()
1960
:param _override_hook_source_branch: If specified, run
1961
the hooks passing this Branch as the source, rather than self.
1962
This is for use of RemoteBranch, where push is delegated to the
1963
underlying vfs-based Branch.
1965
# TODO: Public option to disable running hooks - should be trivial but
1967
return _run_with_write_locked_target(
1968
target, self._push_with_bound_branches, target, overwrite,
1970
_override_hook_source_branch=_override_hook_source_branch)
1972
def _push_with_bound_branches(self, target, overwrite,
1974
_override_hook_source_branch=None):
1975
"""Push from self into target, and into target's master if any.
1977
This is on the base BzrBranch class even though it doesn't support
1978
bound branches because the *target* might be bound.
1981
if _override_hook_source_branch:
1982
result.source_branch = _override_hook_source_branch
1983
for hook in Branch.hooks['post_push']:
1986
bound_location = target.get_bound_location()
1987
if bound_location and target.base != bound_location:
1988
# there is a master branch.
1990
# XXX: Why the second check? Is it even supported for a branch to
1991
# be bound to itself? -- mbp 20070507
1992
master_branch = target.get_master_branch()
1993
master_branch.lock_write()
1995
# push into the master from this branch.
1996
self._basic_push(master_branch, overwrite, stop_revision)
1997
# and push into the target branch from this. Note that we push from
1998
# this branch again, because its considered the highest bandwidth
2000
result = self._basic_push(target, overwrite, stop_revision)
2001
result.master_branch = master_branch
2002
result.local_branch = target
2006
master_branch.unlock()
2009
result = self._basic_push(target, overwrite, stop_revision)
2010
# TODO: Why set master_branch and local_branch if there's no
2011
# binding? Maybe cleaner to just leave them unset? -- mbp
2013
result.master_branch = target
2014
result.local_branch = None
2018
def _basic_push(self, target, overwrite, stop_revision):
2019
"""Basic implementation of push without bound branches or hooks.
2021
Must be called with self read locked and target write locked.
2023
result = PushResult()
2024
result.source_branch = self
2025
result.target_branch = target
2026
result.old_revno, result.old_revid = target.last_revision_info()
2027
if result.old_revid != self.last_revision():
2028
# We assume that during 'push' this repository is closer than
2030
graph = self.repository.get_graph(target.repository)
2031
target.update_revisions(self, stop_revision, overwrite=overwrite,
2033
if self._push_should_merge_tags():
2034
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2035
result.new_revno, result.new_revid = target.last_revision_info()
2038
def _push_should_merge_tags(self):
2039
"""Should _basic_push merge this branch's tags into the target?
2041
The default implementation returns False if this branch has no tags,
2042
and True the rest of the time. Subclasses may override this.
2044
return self.tags.supports_tags() and self.tags.get_tag_dict()
2046
def get_parent(self):
2047
"""See Branch.get_parent."""
2048
parent = self._get_parent_location()
2051
# This is an old-format absolute path to a local branch
2052
# turn it into a url
2053
if parent.startswith('/'):
2054
parent = urlutils.local_path_to_url(parent.decode('utf8'))
2056
return urlutils.join(self.base[:-1], parent)
2057
except errors.InvalidURLJoin, e:
2058
raise errors.InaccessibleParent(parent, self.base)
2060
def get_stacked_on_url(self):
2061
raise errors.UnstackableBranchFormat(self._format, self.base)
2063
def set_push_location(self, location):
2064
"""See Branch.set_push_location."""
2065
self.get_config().set_user_option(
2066
'push_location', location,
2067
store=_mod_config.STORE_LOCATION_NORECURSE)
2070
def set_parent(self, url):
2071
"""See Branch.set_parent."""
2072
# TODO: Maybe delete old location files?
2073
# URLs should never be unicode, even on the local fs,
2074
# FIXUP this and get_parent in a future branch format bump:
2075
# read and rewrite the file. RBC 20060125
2077
if isinstance(url, unicode):
2079
url = url.encode('ascii')
2080
except UnicodeEncodeError:
2081
raise errors.InvalidURL(url,
2082
"Urls must be 7-bit ascii, "
2083
"use bzrlib.urlutils.escape")
2084
url = urlutils.relative_url(self.base, url)
2085
self._set_parent_location(url)
2087
def _set_parent_location(self, url):
2089
self._transport.delete('parent')
2091
self._transport.put_bytes('parent', url + '\n',
2092
mode=self.bzrdir._get_file_mode())
2094
def set_stacked_on_url(self, url):
2095
raise errors.UnstackableBranchFormat(self._format, self.base)
2098
class BzrBranch5(BzrBranch):
2099
"""A format 5 branch. This supports new features over plain branches.
2101
It has support for a master_branch which is the data for bound branches.
2105
def pull(self, source, overwrite=False, stop_revision=None,
2106
run_hooks=True, possible_transports=None,
2107
_override_hook_target=None):
2108
"""Pull from source into self, updating my master if any.
2110
:param run_hooks: Private parameter - if false, this branch
2111
is being called because it's the master of the primary branch,
2112
so it should not run its hooks.
2114
bound_location = self.get_bound_location()
2115
master_branch = None
2116
if bound_location and source.base != bound_location:
2117
# not pulling from master, so we need to update master.
2118
master_branch = self.get_master_branch(possible_transports)
2119
master_branch.lock_write()
2122
# pull from source into master.
2123
master_branch.pull(source, overwrite, stop_revision,
2125
return super(BzrBranch5, self).pull(source, overwrite,
2126
stop_revision, _hook_master=master_branch,
2127
run_hooks=run_hooks,
2128
_override_hook_target=_override_hook_target)
2131
master_branch.unlock()
2133
def get_bound_location(self):
2135
return self._transport.get_bytes('bound')[:-1]
2136
except errors.NoSuchFile:
2140
def get_master_branch(self, possible_transports=None):
2141
"""Return the branch we are bound to.
2143
:return: Either a Branch, or None
2145
This could memoise the branch, but if thats done
2146
it must be revalidated on each new lock.
2147
So for now we just don't memoise it.
2148
# RBC 20060304 review this decision.
2150
bound_loc = self.get_bound_location()
2154
return Branch.open(bound_loc,
2155
possible_transports=possible_transports)
2156
except (errors.NotBranchError, errors.ConnectionError), e:
2157
raise errors.BoundBranchConnectionFailure(
2161
def set_bound_location(self, location):
2162
"""Set the target where this branch is bound to.
2164
:param location: URL to the target branch
2167
self._transport.put_bytes('bound', location+'\n',
2168
mode=self.bzrdir._get_file_mode())
2171
self._transport.delete('bound')
2172
except errors.NoSuchFile:
2177
def bind(self, other):
2178
"""Bind this branch to the branch other.
2180
This does not push or pull data between the branches, though it does
2181
check for divergence to raise an error when the branches are not
2182
either the same, or one a prefix of the other. That behaviour may not
2183
be useful, so that check may be removed in future.
2185
:param other: The branch to bind to
2188
# TODO: jam 20051230 Consider checking if the target is bound
2189
# It is debatable whether you should be able to bind to
2190
# a branch which is itself bound.
2191
# Committing is obviously forbidden,
2192
# but binding itself may not be.
2193
# Since we *have* to check at commit time, we don't
2194
# *need* to check here
2196
# we want to raise diverged if:
2197
# last_rev is not in the other_last_rev history, AND
2198
# other_last_rev is not in our history, and do it without pulling
2200
self.set_bound_location(other.base)
2204
"""If bound, unbind"""
2205
return self.set_bound_location(None)
2208
def update(self, possible_transports=None):
2209
"""Synchronise this branch with the master branch if any.
2211
:return: None or the last_revision that was pivoted out during the
2214
master = self.get_master_branch(possible_transports)
2215
if master is not None:
2216
old_tip = _mod_revision.ensure_null(self.last_revision())
2217
self.pull(master, overwrite=True)
2218
if self.repository.get_graph().is_ancestor(old_tip,
2219
_mod_revision.ensure_null(self.last_revision())):
2225
class BzrBranch7(BzrBranch5):
2226
"""A branch with support for a fallback repository."""
2228
def _get_fallback_repository(self, url):
2229
"""Get the repository we fallback to at url."""
2230
url = urlutils.join(self.base, url)
2231
a_bzrdir = bzrdir.BzrDir.open(url,
2232
possible_transports=[self._transport])
2233
return a_bzrdir.open_branch().repository
2235
def _activate_fallback_location(self, url):
2236
"""Activate the branch/repository from url as a fallback repository."""
2237
self.repository.add_fallback_repository(
2238
self._get_fallback_repository(url))
2240
def _open_hook(self):
2242
url = self.get_stacked_on_url()
2243
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2244
errors.UnstackableBranchFormat):
2247
for hook in Branch.hooks['transform_fallback_location']:
2248
url = hook(self, url)
2250
hook_name = Branch.hooks.get_hook_name(hook)
2251
raise AssertionError(
2252
"'transform_fallback_location' hook %s returned "
2253
"None, not a URL." % hook_name)
2254
self._activate_fallback_location(url)
2256
def _check_stackable_repo(self):
2257
if not self.repository._format.supports_external_lookups:
2258
raise errors.UnstackableRepositoryFormat(self.repository._format,
2259
self.repository.base)
2261
def __init__(self, *args, **kwargs):
2262
super(BzrBranch7, self).__init__(*args, **kwargs)
2263
self._last_revision_info_cache = None
2264
self._partial_revision_history_cache = []
2266
def _clear_cached_state(self):
2267
super(BzrBranch7, self)._clear_cached_state()
2268
self._last_revision_info_cache = None
2269
self._partial_revision_history_cache = []
2271
def _last_revision_info(self):
2272
revision_string = self._transport.get_bytes('last-revision')
2273
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2274
revision_id = cache_utf8.get_cached_utf8(revision_id)
2276
return revno, revision_id
2278
def _write_last_revision_info(self, revno, revision_id):
2279
"""Simply write out the revision id, with no checks.
2281
Use set_last_revision_info to perform this safely.
2283
Does not update the revision_history cache.
2284
Intended to be called by set_last_revision_info and
2285
_write_revision_history.
2287
revision_id = _mod_revision.ensure_null(revision_id)
2288
out_string = '%d %s\n' % (revno, revision_id)
2289
self._transport.put_bytes('last-revision', out_string,
2290
mode=self.bzrdir._get_file_mode())
2293
def set_last_revision_info(self, revno, revision_id):
2294
revision_id = _mod_revision.ensure_null(revision_id)
2295
old_revno, old_revid = self.last_revision_info()
2296
if self._get_append_revisions_only():
2297
self._check_history_violation(revision_id)
2298
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2299
self._write_last_revision_info(revno, revision_id)
2300
self._clear_cached_state()
2301
self._last_revision_info_cache = revno, revision_id
2302
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2304
def _synchronize_history(self, destination, revision_id):
2305
"""Synchronize last revision and revision history between branches.
2307
:see: Branch._synchronize_history
2309
# XXX: The base Branch has a fast implementation of this method based
2310
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2311
# that uses set_revision_history. This class inherits from BzrBranch5,
2312
# but wants the fast implementation, so it calls
2313
# Branch._synchronize_history directly.
2314
Branch._synchronize_history(self, destination, revision_id)
2316
def _check_history_violation(self, revision_id):
2317
last_revision = _mod_revision.ensure_null(self.last_revision())
2318
if _mod_revision.is_null(last_revision):
2320
if last_revision not in self._lefthand_history(revision_id):
2321
raise errors.AppendRevisionsOnlyViolation(self.base)
2323
def _gen_revision_history(self):
2324
"""Generate the revision history from last revision
2326
last_revno, last_revision = self.last_revision_info()
2327
self._extend_partial_history(stop_index=last_revno-1)
2328
return list(reversed(self._partial_revision_history_cache))
2330
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2331
"""Extend the partial history to include a given index
2333
If a stop_index is supplied, stop when that index has been reached.
2334
If a stop_revision is supplied, stop when that revision is
2335
encountered. Otherwise, stop when the beginning of history is
2338
:param stop_index: The index which should be present. When it is
2339
present, history extension will stop.
2340
:param revision_id: The revision id which should be present. When
2341
it is encountered, history extension will stop.
2343
repo = self.repository
2344
if len(self._partial_revision_history_cache) == 0:
2345
iterator = repo.iter_reverse_revision_history(self.last_revision())
2347
start_revision = self._partial_revision_history_cache[-1]
2348
iterator = repo.iter_reverse_revision_history(start_revision)
2349
#skip the last revision in the list
2350
next_revision = iterator.next()
2351
for revision_id in iterator:
2352
self._partial_revision_history_cache.append(revision_id)
2353
if (stop_index is not None and
2354
len(self._partial_revision_history_cache) > stop_index):
2356
if revision_id == stop_revision:
2359
def _write_revision_history(self, history):
2360
"""Factored out of set_revision_history.
2362
This performs the actual writing to disk, with format-specific checks.
2363
It is intended to be called by BzrBranch5.set_revision_history.
2365
if len(history) == 0:
2366
last_revision = 'null:'
2368
if history != self._lefthand_history(history[-1]):
2369
raise errors.NotLefthandHistory(history)
2370
last_revision = history[-1]
2371
if self._get_append_revisions_only():
2372
self._check_history_violation(last_revision)
2373
self._write_last_revision_info(len(history), last_revision)
2376
def _set_parent_location(self, url):
2377
"""Set the parent branch"""
2378
self._set_config_location('parent_location', url, make_relative=True)
2381
def _get_parent_location(self):
2382
"""Set the parent branch"""
2383
return self._get_config_location('parent_location')
2385
def set_push_location(self, location):
2386
"""See Branch.set_push_location."""
2387
self._set_config_location('push_location', location)
2389
def set_bound_location(self, location):
2390
"""See Branch.set_push_location."""
2392
config = self.get_config()
2393
if location is None:
2394
if config.get_user_option('bound') != 'True':
2397
config.set_user_option('bound', 'False', warn_masked=True)
2400
self._set_config_location('bound_location', location,
2402
config.set_user_option('bound', 'True', warn_masked=True)
2405
def _get_bound_location(self, bound):
2406
"""Return the bound location in the config file.
2408
Return None if the bound parameter does not match"""
2409
config = self.get_config()
2410
config_bound = (config.get_user_option('bound') == 'True')
2411
if config_bound != bound:
2413
return self._get_config_location('bound_location', config=config)
2415
def get_bound_location(self):
2416
"""See Branch.set_push_location."""
2417
return self._get_bound_location(True)
2419
def get_old_bound_location(self):
2420
"""See Branch.get_old_bound_location"""
2421
return self._get_bound_location(False)
2423
def get_stacked_on_url(self):
2424
# you can always ask for the URL; but you might not be able to use it
2425
# if the repo can't support stacking.
2426
## self._check_stackable_repo()
2427
stacked_url = self._get_config_location('stacked_on_location')
2428
if stacked_url is None:
2429
raise errors.NotStacked(self)
2432
def set_append_revisions_only(self, enabled):
2437
self.get_config().set_user_option('append_revisions_only', value,
2440
def set_stacked_on_url(self, url):
2441
self._check_stackable_repo()
2444
old_url = self.get_stacked_on_url()
2445
except (errors.NotStacked, errors.UnstackableBranchFormat,
2446
errors.UnstackableRepositoryFormat):
2449
# repositories don't offer an interface to remove fallback
2450
# repositories today; take the conceptually simpler option and just
2452
self.repository = self.bzrdir.find_repository()
2453
# for every revision reference the branch has, ensure it is pulled
2455
source_repository = self._get_fallback_repository(old_url)
2456
for revision_id in chain([self.last_revision()],
2457
self.tags.get_reverse_tag_dict()):
2458
self.repository.fetch(source_repository, revision_id,
2461
self._activate_fallback_location(url)
2462
# write this out after the repository is stacked to avoid setting a
2463
# stacked config that doesn't work.
2464
self._set_config_location('stacked_on_location', url)
2466
def _get_append_revisions_only(self):
2467
value = self.get_config().get_user_option('append_revisions_only')
2468
return value == 'True'
2470
def _make_tags(self):
2471
return BasicTags(self)
2474
def generate_revision_history(self, revision_id, last_rev=None,
2476
"""See BzrBranch5.generate_revision_history"""
2477
history = self._lefthand_history(revision_id, last_rev, other_branch)
2478
revno = len(history)
2479
self.set_last_revision_info(revno, revision_id)
2482
def get_rev_id(self, revno, history=None):
2483
"""Find the revision id of the specified revno."""
2485
return _mod_revision.NULL_REVISION
2487
last_revno, last_revision_id = self.last_revision_info()
2488
if revno <= 0 or revno > last_revno:
2489
raise errors.NoSuchRevision(self, revno)
2491
if history is not None:
2492
return history[revno - 1]
2494
index = last_revno - revno
2495
if len(self._partial_revision_history_cache) <= index:
2496
self._extend_partial_history(stop_index=index)
2497
if len(self._partial_revision_history_cache) > index:
2498
return self._partial_revision_history_cache[index]
2500
raise errors.NoSuchRevision(self, revno)
2503
def revision_id_to_revno(self, revision_id):
2504
"""Given a revision id, return its revno"""
2505
if _mod_revision.is_null(revision_id):
2508
index = self._partial_revision_history_cache.index(revision_id)
2510
self._extend_partial_history(stop_revision=revision_id)
2511
index = len(self._partial_revision_history_cache) - 1
2512
if self._partial_revision_history_cache[index] != revision_id:
2513
raise errors.NoSuchRevision(self, revision_id)
2514
return self.revno() - index
2517
class BzrBranch6(BzrBranch7):
2518
"""See BzrBranchFormat6 for the capabilities of this branch.
2520
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2524
def get_stacked_on_url(self):
2525
raise errors.UnstackableBranchFormat(self._format, self.base)
2527
def set_stacked_on_url(self, url):
2528
raise errors.UnstackableBranchFormat(self._format, self.base)
2531
######################################################################
2532
# results of operations
2535
class _Result(object):
2537
def _show_tag_conficts(self, to_file):
2538
if not getattr(self, 'tag_conflicts', None):
2540
to_file.write('Conflicting tags:\n')
2541
for name, value1, value2 in self.tag_conflicts:
2542
to_file.write(' %s\n' % (name, ))
2545
class PullResult(_Result):
2546
"""Result of a Branch.pull operation.
2548
:ivar old_revno: Revision number before pull.
2549
:ivar new_revno: Revision number after pull.
2550
:ivar old_revid: Tip revision id before pull.
2551
:ivar new_revid: Tip revision id after pull.
2552
:ivar source_branch: Source (local) branch object.
2553
:ivar master_branch: Master branch of the target, or the target if no
2555
:ivar local_branch: target branch if there is a Master, else None
2556
:ivar target_branch: Target/destination branch object.
2557
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2561
# DEPRECATED: pull used to return the change in revno
2562
return self.new_revno - self.old_revno
2564
def report(self, to_file):
2566
if self.old_revid == self.new_revid:
2567
to_file.write('No revisions to pull.\n')
2569
to_file.write('Now on revision %d.\n' % self.new_revno)
2570
self._show_tag_conficts(to_file)
2573
class PushResult(_Result):
2574
"""Result of a Branch.push operation.
2576
:ivar old_revno: Revision number before push.
2577
:ivar new_revno: Revision number after push.
2578
:ivar old_revid: Tip revision id before push.
2579
:ivar new_revid: Tip revision id after push.
2580
:ivar source_branch: Source branch object.
2581
:ivar master_branch: Master branch of the target, or None.
2582
:ivar target_branch: Target/destination branch object.
2586
# DEPRECATED: push used to return the change in revno
2587
return self.new_revno - self.old_revno
2589
def report(self, to_file):
2590
"""Write a human-readable description of the result."""
2591
if self.old_revid == self.new_revid:
2592
to_file.write('No new revisions to push.\n')
2594
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2595
self._show_tag_conficts(to_file)
2598
class BranchCheckResult(object):
2599
"""Results of checking branch consistency.
2604
def __init__(self, branch):
2605
self.branch = branch
2607
def report_results(self, verbose):
2608
"""Report the check results via trace.note.
2610
:param verbose: Requests more detailed display of what was checked,
2613
note('checked branch %s format %s',
2615
self.branch._format)
2618
class Converter5to6(object):
2619
"""Perform an in-place upgrade of format 5 to format 6"""
2621
def convert(self, branch):
2622
# Data for 5 and 6 can peacefully coexist.
2623
format = BzrBranchFormat6()
2624
new_branch = format.open(branch.bzrdir, _found=True)
2626
# Copy source data into target
2627
new_branch._write_last_revision_info(*branch.last_revision_info())
2628
new_branch.set_parent(branch.get_parent())
2629
new_branch.set_bound_location(branch.get_bound_location())
2630
new_branch.set_push_location(branch.get_push_location())
2632
# New branch has no tags by default
2633
new_branch.tags._set_tag_dict({})
2635
# Copying done; now update target format
2636
new_branch._transport.put_bytes('format',
2637
format.get_format_string(),
2638
mode=new_branch.bzrdir._get_file_mode())
2640
# Clean up old files
2641
new_branch._transport.delete('revision-history')
2643
branch.set_parent(None)
2644
except errors.NoSuchFile:
2646
branch.set_bound_location(None)
2649
class Converter6to7(object):
2650
"""Perform an in-place upgrade of format 6 to format 7"""
2652
def convert(self, branch):
2653
format = BzrBranchFormat7()
2654
branch._set_config_location('stacked_on_location', '')
2655
# update target format
2656
branch._transport.put_bytes('format', format.get_format_string())
2660
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2661
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2664
_run_with_write_locked_target will attempt to release the lock it acquires.
2666
If an exception is raised by callable, then that exception *will* be
2667
propagated, even if the unlock attempt raises its own error. Thus
2668
_run_with_write_locked_target should be preferred to simply doing::
2672
return callable(*args, **kwargs)
2677
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2678
# should share code?
2681
result = callable(*args, **kwargs)
2683
exc_info = sys.exc_info()
2687
raise exc_info[0], exc_info[1], exc_info[2]
added
removed
bzrlib/branch.py
