1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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,
39
from bzrlib.config import BranchConfig, TransportConfig
40
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
41
from bzrlib.tag import (
47
from bzrlib.decorators import needs_read_lock, needs_write_lock
48
from bzrlib.hooks import HookPoint, Hooks
49
from bzrlib.inter import InterObject
50
from bzrlib import registry
51
from bzrlib.symbol_versioning import (
55
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
58
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
59
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
60
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
63
# TODO: Maybe include checks for common corruption of newlines, etc?
65
# TODO: Some operations like log might retrieve the same revisions
66
# repeatedly to calculate deltas. We could perhaps have a weakref
67
# cache in memory to make this faster. In general anything can be
68
# cached in memory between lock and unlock operations. .. nb thats
69
# what the transaction identity map provides
72
######################################################################
76
"""Branch holding a history of revisions.
79
Base directory/url of the branch.
81
hooks: An instance of BranchHooks.
83
# this is really an instance variable - FIXME move it there
87
def __init__(self, *ignored, **ignored_too):
88
self.tags = self._format.make_tags(self)
89
self._revision_history_cache = None
90
self._revision_id_to_revno_cache = None
91
self._partial_revision_id_to_revno_cache = {}
92
self._last_revision_info_cache = None
93
self._merge_sorted_revisions_cache = None
95
hooks = Branch.hooks['open']
100
"""Called by init to allow simpler extension of the base class."""
102
def _activate_fallback_location(self, url):
103
"""Activate the branch/repository from url as a fallback repository."""
104
self.repository.add_fallback_repository(
105
self._get_fallback_repository(url))
107
def break_lock(self):
108
"""Break a lock if one is present from another instance.
110
Uses the ui factory to ask for confirmation if the lock may be from
113
This will probe the repository for its lock as well.
115
self.control_files.break_lock()
116
self.repository.break_lock()
117
master = self.get_master_branch()
118
if master is not None:
121
def _check_stackable_repo(self):
122
if not self.repository._format.supports_external_lookups:
123
raise errors.UnstackableRepositoryFormat(self.repository._format,
124
self.repository.base)
127
def open(base, _unsupported=False, possible_transports=None):
128
"""Open the branch rooted at base.
130
For instance, if the branch is at URL/.bzr/branch,
131
Branch.open(URL) -> a Branch instance.
133
control = bzrdir.BzrDir.open(base, _unsupported,
134
possible_transports=possible_transports)
135
return control.open_branch(_unsupported)
138
def open_from_transport(transport, _unsupported=False):
139
"""Open the branch rooted at transport"""
140
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
141
return control.open_branch(_unsupported)
144
def open_containing(url, possible_transports=None):
145
"""Open an existing branch which contains url.
147
This probes for a branch at url, and searches upwards from there.
149
Basically we keep looking up until we find the control directory or
150
run into the root. If there isn't one, raises NotBranchError.
151
If there is one and it is either an unrecognised format or an unsupported
152
format, UnknownFormatError or UnsupportedFormatError are raised.
153
If there is one, it is returned, along with the unused portion of url.
155
control, relpath = bzrdir.BzrDir.open_containing(url,
157
return control.open_branch(), relpath
159
def _push_should_merge_tags(self):
160
"""Should _basic_push merge this branch's tags into the target?
162
The default implementation returns False if this branch has no tags,
163
and True the rest of the time. Subclasses may override this.
165
return self.supports_tags() and self.tags.get_tag_dict()
167
def get_config(self):
168
return BranchConfig(self)
170
def _get_config(self):
171
"""Get the concrete config for just the config in this branch.
173
This is not intended for client use; see Branch.get_config for the
178
:return: An object supporting get_option and set_option.
180
raise NotImplementedError(self._get_config)
182
def _get_fallback_repository(self, url):
183
"""Get the repository we fallback to at url."""
184
url = urlutils.join(self.base, url)
185
a_bzrdir = bzrdir.BzrDir.open(url,
186
possible_transports=[self.bzrdir.root_transport])
187
return a_bzrdir.open_branch().repository
189
def _get_tags_bytes(self):
190
"""Get the bytes of a serialised tags dict.
192
Note that not all branches support tags, nor do all use the same tags
193
logic: this method is specific to BasicTags. Other tag implementations
194
may use the same method name and behave differently, safely, because
195
of the double-dispatch via
196
format.make_tags->tags_instance->get_tags_dict.
198
:return: The bytes of the tags file.
199
:seealso: Branch._set_tags_bytes.
201
return self._transport.get_bytes('tags')
203
def _get_nick(self, local=False, possible_transports=None):
204
config = self.get_config()
205
# explicit overrides master, but don't look for master if local is True
206
if not local and not config.has_explicit_nickname():
208
master = self.get_master_branch(possible_transports)
209
if master is not None:
210
# return the master branch value
212
except errors.BzrError, e:
213
# Silently fall back to local implicit nick if the master is
215
mutter("Could not connect to bound branch, "
216
"falling back to local nick.\n " + str(e))
217
return config.get_nickname()
219
def _set_nick(self, nick):
220
self.get_config().set_user_option('nickname', nick, warn_masked=True)
222
nick = property(_get_nick, _set_nick)
225
raise NotImplementedError(self.is_locked)
227
def _lefthand_history(self, revision_id, last_rev=None,
229
if 'evil' in debug.debug_flags:
230
mutter_callsite(4, "_lefthand_history scales with history.")
231
# stop_revision must be a descendant of last_revision
232
graph = self.repository.get_graph()
233
if last_rev is not None:
234
if not graph.is_ancestor(last_rev, revision_id):
235
# our previous tip is not merged into stop_revision
236
raise errors.DivergedBranches(self, other_branch)
237
# make a new revision history from the graph
238
parents_map = graph.get_parent_map([revision_id])
239
if revision_id not in parents_map:
240
raise errors.NoSuchRevision(self, revision_id)
241
current_rev_id = revision_id
243
check_not_reserved_id = _mod_revision.check_not_reserved_id
244
# Do not include ghosts or graph origin in revision_history
245
while (current_rev_id in parents_map and
246
len(parents_map[current_rev_id]) > 0):
247
check_not_reserved_id(current_rev_id)
248
new_history.append(current_rev_id)
249
current_rev_id = parents_map[current_rev_id][0]
250
parents_map = graph.get_parent_map([current_rev_id])
251
new_history.reverse()
254
def lock_write(self):
255
raise NotImplementedError(self.lock_write)
258
raise NotImplementedError(self.lock_read)
261
raise NotImplementedError(self.unlock)
263
def peek_lock_mode(self):
264
"""Return lock mode for the Branch: 'r', 'w' or None"""
265
raise NotImplementedError(self.peek_lock_mode)
267
def get_physical_lock_status(self):
268
raise NotImplementedError(self.get_physical_lock_status)
271
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
272
"""Return the revision_id for a dotted revno.
274
:param revno: a tuple like (1,) or (1,1,2)
275
:param _cache_reverse: a private parameter enabling storage
276
of the reverse mapping in a top level cache. (This should
277
only be done in selective circumstances as we want to
278
avoid having the mapping cached multiple times.)
279
:return: the revision_id
280
:raises errors.NoSuchRevision: if the revno doesn't exist
282
rev_id = self._do_dotted_revno_to_revision_id(revno)
284
self._partial_revision_id_to_revno_cache[rev_id] = revno
287
def _do_dotted_revno_to_revision_id(self, revno):
288
"""Worker function for dotted_revno_to_revision_id.
290
Subclasses should override this if they wish to
291
provide a more efficient implementation.
294
return self.get_rev_id(revno[0])
295
revision_id_to_revno = self.get_revision_id_to_revno_map()
296
revision_ids = [revision_id for revision_id, this_revno
297
in revision_id_to_revno.iteritems()
298
if revno == this_revno]
299
if len(revision_ids) == 1:
300
return revision_ids[0]
302
revno_str = '.'.join(map(str, revno))
303
raise errors.NoSuchRevision(self, revno_str)
306
def revision_id_to_dotted_revno(self, revision_id):
307
"""Given a revision id, return its dotted revno.
309
:return: a tuple like (1,) or (400,1,3).
311
return self._do_revision_id_to_dotted_revno(revision_id)
313
def _do_revision_id_to_dotted_revno(self, revision_id):
314
"""Worker function for revision_id_to_revno."""
315
# Try the caches if they are loaded
316
result = self._partial_revision_id_to_revno_cache.get(revision_id)
317
if result is not None:
319
if self._revision_id_to_revno_cache:
320
result = self._revision_id_to_revno_cache.get(revision_id)
322
raise errors.NoSuchRevision(self, revision_id)
323
# Try the mainline as it's optimised
325
revno = self.revision_id_to_revno(revision_id)
327
except errors.NoSuchRevision:
328
# We need to load and use the full revno map after all
329
result = self.get_revision_id_to_revno_map().get(revision_id)
331
raise errors.NoSuchRevision(self, revision_id)
335
def get_revision_id_to_revno_map(self):
336
"""Return the revision_id => dotted revno map.
338
This will be regenerated on demand, but will be cached.
340
:return: A dictionary mapping revision_id => dotted revno.
341
This dictionary should not be modified by the caller.
343
if self._revision_id_to_revno_cache is not None:
344
mapping = self._revision_id_to_revno_cache
346
mapping = self._gen_revno_map()
347
self._cache_revision_id_to_revno(mapping)
348
# TODO: jam 20070417 Since this is being cached, should we be returning
350
# I would rather not, and instead just declare that users should not
351
# modify the return value.
354
def _gen_revno_map(self):
355
"""Create a new mapping from revision ids to dotted revnos.
357
Dotted revnos are generated based on the current tip in the revision
359
This is the worker function for get_revision_id_to_revno_map, which
360
just caches the return value.
362
:return: A dictionary mapping revision_id => dotted revno.
364
revision_id_to_revno = dict((rev_id, revno)
365
for rev_id, depth, revno, end_of_merge
366
in self.iter_merge_sorted_revisions())
367
return revision_id_to_revno
370
def iter_merge_sorted_revisions(self, start_revision_id=None,
371
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
372
"""Walk the revisions for a branch in merge sorted order.
374
Merge sorted order is the output from a merge-aware,
375
topological sort, i.e. all parents come before their
376
children going forward; the opposite for reverse.
378
:param start_revision_id: the revision_id to begin walking from.
379
If None, the branch tip is used.
380
:param stop_revision_id: the revision_id to terminate the walk
381
after. If None, the rest of history is included.
382
:param stop_rule: if stop_revision_id is not None, the precise rule
383
to use for termination:
384
* 'exclude' - leave the stop revision out of the result (default)
385
* 'include' - the stop revision is the last item in the result
386
* 'with-merges' - include the stop revision and all of its
387
merged revisions in the result
388
:param direction: either 'reverse' or 'forward':
389
* reverse means return the start_revision_id first, i.e.
390
start at the most recent revision and go backwards in history
391
* forward returns tuples in the opposite order to reverse.
392
Note in particular that forward does *not* do any intelligent
393
ordering w.r.t. depth as some clients of this API may like.
394
(If required, that ought to be done at higher layers.)
396
:return: an iterator over (revision_id, depth, revno, end_of_merge)
399
* revision_id: the unique id of the revision
400
* depth: How many levels of merging deep this node has been
402
* revno_sequence: This field provides a sequence of
403
revision numbers for all revisions. The format is:
404
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
405
branch that the revno is on. From left to right the REVNO numbers
406
are the sequence numbers within that branch of the revision.
407
* end_of_merge: When True the next node (earlier in history) is
408
part of a different merge.
410
# Note: depth and revno values are in the context of the branch so
411
# we need the full graph to get stable numbers, regardless of the
413
if self._merge_sorted_revisions_cache is None:
414
last_revision = self.last_revision()
415
graph = self.repository.get_graph()
416
parent_map = dict(((key, value) for key, value in
417
graph.iter_ancestry([last_revision]) if value is not None))
418
revision_graph = repository._strip_NULL_ghosts(parent_map)
419
revs = tsort.merge_sort(revision_graph, last_revision, None,
421
# Drop the sequence # before caching
422
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
424
filtered = self._filter_merge_sorted_revisions(
425
self._merge_sorted_revisions_cache, start_revision_id,
426
stop_revision_id, stop_rule)
427
if direction == 'reverse':
429
if direction == 'forward':
430
return reversed(list(filtered))
432
raise ValueError('invalid direction %r' % direction)
434
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
435
start_revision_id, stop_revision_id, stop_rule):
436
"""Iterate over an inclusive range of sorted revisions."""
437
rev_iter = iter(merge_sorted_revisions)
438
if start_revision_id is not None:
439
for rev_id, depth, revno, end_of_merge in rev_iter:
440
if rev_id != start_revision_id:
443
# The decision to include the start or not
444
# depends on the stop_rule if a stop is provided
446
iter([(rev_id, depth, revno, end_of_merge)]),
449
if stop_revision_id is None:
450
for rev_id, depth, revno, end_of_merge in rev_iter:
451
yield rev_id, depth, revno, end_of_merge
452
elif stop_rule == 'exclude':
453
for rev_id, depth, revno, end_of_merge in rev_iter:
454
if rev_id == stop_revision_id:
456
yield rev_id, depth, revno, end_of_merge
457
elif stop_rule == 'include':
458
for rev_id, depth, revno, end_of_merge in rev_iter:
459
yield rev_id, depth, revno, end_of_merge
460
if rev_id == stop_revision_id:
462
elif stop_rule == 'with-merges':
463
stop_rev = self.repository.get_revision(stop_revision_id)
464
if stop_rev.parent_ids:
465
left_parent = stop_rev.parent_ids[0]
467
left_parent = _mod_revision.NULL_REVISION
468
for rev_id, depth, revno, end_of_merge in rev_iter:
469
if rev_id == left_parent:
471
yield rev_id, depth, revno, end_of_merge
473
raise ValueError('invalid stop_rule %r' % stop_rule)
475
def leave_lock_in_place(self):
476
"""Tell this branch object not to release the physical lock when this
479
If lock_write doesn't return a token, then this method is not supported.
481
self.control_files.leave_in_place()
483
def dont_leave_lock_in_place(self):
484
"""Tell this branch object to release the physical lock when this
485
object is unlocked, even if it didn't originally acquire it.
487
If lock_write doesn't return a token, then this method is not supported.
489
self.control_files.dont_leave_in_place()
491
def bind(self, other):
492
"""Bind the local branch the other branch.
494
:param other: The branch to bind to
497
raise errors.UpgradeRequired(self.base)
500
def fetch(self, from_branch, last_revision=None, pb=None):
501
"""Copy revisions from from_branch into this branch.
503
:param from_branch: Where to copy from.
504
:param last_revision: What revision to stop at (None for at the end
506
:param pb: An optional progress bar to use.
509
if self.base == from_branch.base:
512
symbol_versioning.warn(
513
symbol_versioning.deprecated_in((1, 14, 0))
514
% "pb parameter to fetch()")
515
from_branch.lock_read()
517
if last_revision is None:
518
last_revision = from_branch.last_revision()
519
last_revision = _mod_revision.ensure_null(last_revision)
520
return self.repository.fetch(from_branch.repository,
521
revision_id=last_revision,
526
def get_bound_location(self):
527
"""Return the URL of the branch we are bound to.
529
Older format branches cannot bind, please be sure to use a metadir
534
def get_old_bound_location(self):
535
"""Return the URL of the branch we used to be bound to
537
raise errors.UpgradeRequired(self.base)
539
def get_commit_builder(self, parents, config=None, timestamp=None,
540
timezone=None, committer=None, revprops=None,
542
"""Obtain a CommitBuilder for this branch.
544
:param parents: Revision ids of the parents of the new revision.
545
:param config: Optional configuration to use.
546
:param timestamp: Optional timestamp recorded for commit.
547
:param timezone: Optional timezone for timestamp.
548
:param committer: Optional committer to set for commit.
549
:param revprops: Optional dictionary of revision properties.
550
:param revision_id: Optional revision id.
554
config = self.get_config()
556
return self.repository.get_commit_builder(self, parents, config,
557
timestamp, timezone, committer, revprops, revision_id)
559
def get_master_branch(self, possible_transports=None):
560
"""Return the branch we are bound to.
562
:return: Either a Branch, or None
566
def get_revision_delta(self, revno):
567
"""Return the delta for one revision.
569
The delta is relative to its mainline predecessor, or the
570
empty tree for revision 1.
572
rh = self.revision_history()
573
if not (1 <= revno <= len(rh)):
574
raise errors.InvalidRevisionNumber(revno)
575
return self.repository.get_revision_delta(rh[revno-1])
577
def get_stacked_on_url(self):
578
"""Get the URL this branch is stacked against.
580
:raises NotStacked: If the branch is not stacked.
581
:raises UnstackableBranchFormat: If the branch does not support
584
raise NotImplementedError(self.get_stacked_on_url)
586
def print_file(self, file, revision_id):
587
"""Print `file` to stdout."""
588
raise NotImplementedError(self.print_file)
590
def set_revision_history(self, rev_history):
591
raise NotImplementedError(self.set_revision_history)
594
def set_parent(self, url):
595
"""See Branch.set_parent."""
596
# TODO: Maybe delete old location files?
597
# URLs should never be unicode, even on the local fs,
598
# FIXUP this and get_parent in a future branch format bump:
599
# read and rewrite the file. RBC 20060125
601
if isinstance(url, unicode):
603
url = url.encode('ascii')
604
except UnicodeEncodeError:
605
raise errors.InvalidURL(url,
606
"Urls must be 7-bit ascii, "
607
"use bzrlib.urlutils.escape")
608
url = urlutils.relative_url(self.base, url)
609
self._set_parent_location(url)
611
def set_stacked_on_url(self, url):
612
"""Set the URL this branch is stacked against.
614
:raises UnstackableBranchFormat: If the branch does not support
616
:raises UnstackableRepositoryFormat: If the repository does not support
619
if not self._format.supports_stacking():
620
raise errors.UnstackableBranchFormat(self._format, self.base)
621
self._check_stackable_repo()
624
old_url = self.get_stacked_on_url()
625
except (errors.NotStacked, errors.UnstackableBranchFormat,
626
errors.UnstackableRepositoryFormat):
629
# repositories don't offer an interface to remove fallback
630
# repositories today; take the conceptually simpler option and just
632
self.repository = self.bzrdir.find_repository()
633
# for every revision reference the branch has, ensure it is pulled
635
source_repository = self._get_fallback_repository(old_url)
636
for revision_id in chain([self.last_revision()],
637
self.tags.get_reverse_tag_dict()):
638
self.repository.fetch(source_repository, revision_id,
641
self._activate_fallback_location(url)
642
# write this out after the repository is stacked to avoid setting a
643
# stacked config that doesn't work.
644
self._set_config_location('stacked_on_location', url)
647
def _set_tags_bytes(self, bytes):
648
"""Mirror method for _get_tags_bytes.
650
:seealso: Branch._get_tags_bytes.
652
return _run_with_write_locked_target(self, self._transport.put_bytes,
655
def _cache_revision_history(self, rev_history):
656
"""Set the cached revision history to rev_history.
658
The revision_history method will use this cache to avoid regenerating
659
the revision history.
661
This API is semi-public; it only for use by subclasses, all other code
662
should consider it to be private.
664
self._revision_history_cache = rev_history
666
def _cache_revision_id_to_revno(self, revision_id_to_revno):
667
"""Set the cached revision_id => revno map to revision_id_to_revno.
669
This API is semi-public; it only for use by subclasses, all other code
670
should consider it to be private.
672
self._revision_id_to_revno_cache = revision_id_to_revno
674
def _clear_cached_state(self):
675
"""Clear any cached data on this branch, e.g. cached revision history.
677
This means the next call to revision_history will need to call
678
_gen_revision_history.
680
This API is semi-public; it only for use by subclasses, all other code
681
should consider it to be private.
683
self._revision_history_cache = None
684
self._revision_id_to_revno_cache = None
685
self._last_revision_info_cache = None
686
self._merge_sorted_revisions_cache = None
688
def _gen_revision_history(self):
689
"""Return sequence of revision hashes on to this branch.
691
Unlike revision_history, this method always regenerates or rereads the
692
revision history, i.e. it does not cache the result, so repeated calls
695
Concrete subclasses should override this instead of revision_history so
696
that subclasses do not need to deal with caching logic.
698
This API is semi-public; it only for use by subclasses, all other code
699
should consider it to be private.
701
raise NotImplementedError(self._gen_revision_history)
704
def revision_history(self):
705
"""Return sequence of revision ids on this branch.
707
This method will cache the revision history for as long as it is safe to
710
if 'evil' in debug.debug_flags:
711
mutter_callsite(3, "revision_history scales with history.")
712
if self._revision_history_cache is not None:
713
history = self._revision_history_cache
715
history = self._gen_revision_history()
716
self._cache_revision_history(history)
720
"""Return current revision number for this branch.
722
That is equivalent to the number of revisions committed to
725
return self.last_revision_info()[0]
728
"""Older format branches cannot bind or unbind."""
729
raise errors.UpgradeRequired(self.base)
731
def set_append_revisions_only(self, enabled):
732
"""Older format branches are never restricted to append-only"""
733
raise errors.UpgradeRequired(self.base)
735
def last_revision(self):
736
"""Return last revision id, or NULL_REVISION."""
737
return self.last_revision_info()[1]
740
def last_revision_info(self):
741
"""Return information about the last revision.
743
:return: A tuple (revno, revision_id).
745
if self._last_revision_info_cache is None:
746
self._last_revision_info_cache = self._last_revision_info()
747
return self._last_revision_info_cache
749
def _last_revision_info(self):
750
rh = self.revision_history()
753
return (revno, rh[-1])
755
return (0, _mod_revision.NULL_REVISION)
757
@deprecated_method(deprecated_in((1, 6, 0)))
758
def missing_revisions(self, other, stop_revision=None):
759
"""Return a list of new revisions that would perfectly fit.
761
If self and other have not diverged, return a list of the revisions
762
present in other, but missing from self.
764
self_history = self.revision_history()
765
self_len = len(self_history)
766
other_history = other.revision_history()
767
other_len = len(other_history)
768
common_index = min(self_len, other_len) -1
769
if common_index >= 0 and \
770
self_history[common_index] != other_history[common_index]:
771
raise errors.DivergedBranches(self, other)
773
if stop_revision is None:
774
stop_revision = other_len
776
if stop_revision > other_len:
777
raise errors.NoSuchRevision(self, stop_revision)
778
return other_history[self_len:stop_revision]
781
def update_revisions(self, other, stop_revision=None, overwrite=False,
783
"""Pull in new perfect-fit revisions.
785
:param other: Another Branch to pull from
786
:param stop_revision: Updated until the given revision
787
:param overwrite: Always set the branch pointer, rather than checking
788
to see if it is a proper descendant.
789
:param graph: A Graph object that can be used to query history
790
information. This can be None.
793
return InterBranch.get(other, self).update_revisions(stop_revision,
796
def import_last_revision_info(self, source_repo, revno, revid):
797
"""Set the last revision info, importing from another repo if necessary.
799
This is used by the bound branch code to upload a revision to
800
the master branch first before updating the tip of the local branch.
802
:param source_repo: Source repository to optionally fetch from
803
:param revno: Revision number of the new tip
804
:param revid: Revision id of the new tip
806
if not self.repository.has_same_location(source_repo):
807
self.repository.fetch(source_repo, revision_id=revid)
808
self.set_last_revision_info(revno, revid)
810
def revision_id_to_revno(self, revision_id):
811
"""Given a revision id, return its revno"""
812
if _mod_revision.is_null(revision_id):
814
history = self.revision_history()
816
return history.index(revision_id) + 1
818
raise errors.NoSuchRevision(self, revision_id)
820
def get_rev_id(self, revno, history=None):
821
"""Find the revision id of the specified revno."""
823
return _mod_revision.NULL_REVISION
825
history = self.revision_history()
826
if revno <= 0 or revno > len(history):
827
raise errors.NoSuchRevision(self, revno)
828
return history[revno - 1]
830
def pull(self, source, overwrite=False, stop_revision=None,
831
possible_transports=None, _override_hook_target=None):
832
"""Mirror source into this branch.
834
This branch is considered to be 'local', having low latency.
836
:returns: PullResult instance
838
raise NotImplementedError(self.pull)
840
def push(self, target, overwrite=False, stop_revision=None):
841
"""Mirror this branch into target.
843
This branch is considered to be 'local', having low latency.
845
raise NotImplementedError(self.push)
847
def basis_tree(self):
848
"""Return `Tree` object for last revision."""
849
return self.repository.revision_tree(self.last_revision())
851
def get_parent(self):
852
"""Return the parent location of the branch.
854
This is the default location for pull/missing. The usual
855
pattern is that the user can override it by specifying a
858
parent = self._get_parent_location()
861
# This is an old-format absolute path to a local branch
863
if parent.startswith('/'):
864
parent = urlutils.local_path_to_url(parent.decode('utf8'))
866
return urlutils.join(self.base[:-1], parent)
867
except errors.InvalidURLJoin, e:
868
raise errors.InaccessibleParent(parent, self.base)
870
def _get_parent_location(self):
871
raise NotImplementedError(self._get_parent_location)
873
def _set_config_location(self, name, url, config=None,
874
make_relative=False):
876
config = self.get_config()
880
url = urlutils.relative_url(self.base, url)
881
config.set_user_option(name, url, warn_masked=True)
883
def _get_config_location(self, name, config=None):
885
config = self.get_config()
886
location = config.get_user_option(name)
891
def get_submit_branch(self):
892
"""Return the submit location of the branch.
894
This is the default location for bundle. The usual
895
pattern is that the user can override it by specifying a
898
return self.get_config().get_user_option('submit_branch')
900
def set_submit_branch(self, location):
901
"""Return the submit location of the branch.
903
This is the default location for bundle. The usual
904
pattern is that the user can override it by specifying a
907
self.get_config().set_user_option('submit_branch', location,
910
def get_public_branch(self):
911
"""Return the public location of the branch.
913
This is used by merge directives.
915
return self._get_config_location('public_branch')
917
def set_public_branch(self, location):
918
"""Return the submit location of the branch.
920
This is the default location for bundle. The usual
921
pattern is that the user can override it by specifying a
924
self._set_config_location('public_branch', location)
926
def get_push_location(self):
927
"""Return the None or the location to push this branch to."""
928
push_loc = self.get_config().get_user_option('push_location')
931
def set_push_location(self, location):
932
"""Set a new push location for this branch."""
933
raise NotImplementedError(self.set_push_location)
935
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
936
"""Run the post_change_branch_tip hooks."""
937
hooks = Branch.hooks['post_change_branch_tip']
940
new_revno, new_revid = self.last_revision_info()
941
params = ChangeBranchTipParams(
942
self, old_revno, new_revno, old_revid, new_revid)
946
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
947
"""Run the pre_change_branch_tip hooks."""
948
hooks = Branch.hooks['pre_change_branch_tip']
951
old_revno, old_revid = self.last_revision_info()
952
params = ChangeBranchTipParams(
953
self, old_revno, new_revno, old_revid, new_revid)
957
except errors.TipChangeRejected:
960
exc_info = sys.exc_info()
961
hook_name = Branch.hooks.get_hook_name(hook)
962
raise errors.HookFailed(
963
'pre_change_branch_tip', hook_name, exc_info)
967
"""Synchronise this branch with the master branch if any.
969
:return: None or the last_revision pivoted out during the update.
973
def check_revno(self, revno):
975
Check whether a revno corresponds to any revision.
976
Zero (the NULL revision) is considered valid.
979
self.check_real_revno(revno)
981
def check_real_revno(self, revno):
983
Check whether a revno corresponds to a real revision.
984
Zero (the NULL revision) is considered invalid
986
if revno < 1 or revno > self.revno():
987
raise errors.InvalidRevisionNumber(revno)
990
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
991
"""Clone this branch into to_bzrdir preserving all semantic values.
993
Most API users will want 'create_clone_on_transport', which creates a
994
new bzrdir and branch on the fly.
996
revision_id: if not None, the revision history in the new branch will
997
be truncated to end with revision_id.
999
result = to_bzrdir.create_branch()
1002
if repository_policy is not None:
1003
repository_policy.configure_branch(result)
1004
self.copy_content_into(result, revision_id=revision_id)
1010
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1011
"""Create a new line of development from the branch, into to_bzrdir.
1013
to_bzrdir controls the branch format.
1015
revision_id: if not None, the revision history in the new branch will
1016
be truncated to end with revision_id.
1018
result = to_bzrdir.create_branch()
1020
if repository_policy is not None:
1021
repository_policy.configure_branch(result)
1022
self.copy_content_into(result, revision_id=revision_id)
1023
result.set_parent(self.bzrdir.root_transport.base)
1028
def _synchronize_history(self, destination, revision_id):
1029
"""Synchronize last revision and revision history between branches.
1031
This version is most efficient when the destination is also a
1032
BzrBranch6, but works for BzrBranch5, as long as the destination's
1033
repository contains all the lefthand ancestors of the intended
1034
last_revision. If not, set_last_revision_info will fail.
1036
:param destination: The branch to copy the history into
1037
:param revision_id: The revision-id to truncate history at. May
1038
be None to copy complete history.
1040
source_revno, source_revision_id = self.last_revision_info()
1041
if revision_id is None:
1042
revno, revision_id = source_revno, source_revision_id
1043
elif source_revision_id == revision_id:
1044
# we know the revno without needing to walk all of history
1045
revno = source_revno
1047
# To figure out the revno for a random revision, we need to build
1048
# the revision history, and count its length.
1049
# We don't care about the order, just how long it is.
1050
# Alternatively, we could start at the current location, and count
1051
# backwards. But there is no guarantee that we will find it since
1052
# it may be a merged revision.
1053
revno = len(list(self.repository.iter_reverse_revision_history(
1055
destination.set_last_revision_info(revno, revision_id)
1058
def copy_content_into(self, destination, revision_id=None):
1059
"""Copy the content of self into destination.
1061
revision_id: if not None, the revision history in the new branch will
1062
be truncated to end with revision_id.
1064
self._synchronize_history(destination, revision_id)
1066
parent = self.get_parent()
1067
except errors.InaccessibleParent, e:
1068
mutter('parent was not accessible to copy: %s', e)
1071
destination.set_parent(parent)
1072
if self._push_should_merge_tags():
1073
self.tags.merge_to(destination.tags)
1077
"""Check consistency of the branch.
1079
In particular this checks that revisions given in the revision-history
1080
do actually match up in the revision graph, and that they're all
1081
present in the repository.
1083
Callers will typically also want to check the repository.
1085
:return: A BranchCheckResult.
1087
mainline_parent_id = None
1088
last_revno, last_revision_id = self.last_revision_info()
1089
real_rev_history = list(self.repository.iter_reverse_revision_history(
1091
real_rev_history.reverse()
1092
if len(real_rev_history) != last_revno:
1093
raise errors.BzrCheckError('revno does not match len(mainline)'
1094
' %s != %s' % (last_revno, len(real_rev_history)))
1095
# TODO: We should probably also check that real_rev_history actually
1096
# matches self.revision_history()
1097
for revision_id in real_rev_history:
1099
revision = self.repository.get_revision(revision_id)
1100
except errors.NoSuchRevision, e:
1101
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1103
# In general the first entry on the revision history has no parents.
1104
# But it's not illegal for it to have parents listed; this can happen
1105
# in imports from Arch when the parents weren't reachable.
1106
if mainline_parent_id is not None:
1107
if mainline_parent_id not in revision.parent_ids:
1108
raise errors.BzrCheckError("previous revision {%s} not listed among "
1110
% (mainline_parent_id, revision_id))
1111
mainline_parent_id = revision_id
1112
return BranchCheckResult(self)
1114
def _get_checkout_format(self):
1115
"""Return the most suitable metadir for a checkout of this branch.
1116
Weaves are used if this branch's repository uses weaves.
1118
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1119
from bzrlib.repofmt import weaverepo
1120
format = bzrdir.BzrDirMetaFormat1()
1121
format.repository_format = weaverepo.RepositoryFormat7()
1123
format = self.repository.bzrdir.checkout_metadir()
1124
format.set_branch_format(self._format)
1127
def create_clone_on_transport(self, to_transport, revision_id=None,
1129
"""Create a clone of this branch and its bzrdir.
1131
:param to_transport: The transport to clone onto.
1132
:param revision_id: The revision id to use as tip in the new branch.
1133
If None the tip is obtained from this branch.
1134
:param stacked_on: An optional URL to stack the clone on.
1136
# XXX: Fix the bzrdir API to allow getting the branch back from the
1137
# clone call. Or something. 20090224 RBC/spiv.
1138
dir_to = self.bzrdir.clone_on_transport(to_transport,
1139
revision_id=revision_id, stacked_on=stacked_on)
1140
return dir_to.open_branch()
1142
def create_checkout(self, to_location, revision_id=None,
1143
lightweight=False, accelerator_tree=None,
1145
"""Create a checkout of a branch.
1147
:param to_location: The url to produce the checkout at
1148
:param revision_id: The revision to check out
1149
:param lightweight: If True, produce a lightweight checkout, otherwise,
1150
produce a bound branch (heavyweight checkout)
1151
:param accelerator_tree: A tree which can be used for retrieving file
1152
contents more quickly than the revision tree, i.e. a workingtree.
1153
The revision tree will be used for cases where accelerator_tree's
1154
content is different.
1155
:param hardlink: If true, hard-link files from accelerator_tree,
1157
:return: The tree of the created checkout
1159
t = transport.get_transport(to_location)
1162
format = self._get_checkout_format()
1163
checkout = format.initialize_on_transport(t)
1164
from_branch = BranchReferenceFormat().initialize(checkout, self)
1166
format = self._get_checkout_format()
1167
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1168
to_location, force_new_tree=False, format=format)
1169
checkout = checkout_branch.bzrdir
1170
checkout_branch.bind(self)
1171
# pull up to the specified revision_id to set the initial
1172
# branch tip correctly, and seed it with history.
1173
checkout_branch.pull(self, stop_revision=revision_id)
1175
tree = checkout.create_workingtree(revision_id,
1176
from_branch=from_branch,
1177
accelerator_tree=accelerator_tree,
1179
basis_tree = tree.basis_tree()
1180
basis_tree.lock_read()
1182
for path, file_id in basis_tree.iter_references():
1183
reference_parent = self.reference_parent(file_id, path)
1184
reference_parent.create_checkout(tree.abspath(path),
1185
basis_tree.get_reference_revision(file_id, path),
1192
def reconcile(self, thorough=True):
1193
"""Make sure the data stored in this branch is consistent."""
1194
from bzrlib.reconcile import BranchReconciler
1195
reconciler = BranchReconciler(self, thorough=thorough)
1196
reconciler.reconcile()
1199
def reference_parent(self, file_id, path):
1200
"""Return the parent branch for a tree-reference file_id
1201
:param file_id: The file_id of the tree reference
1202
:param path: The path of the file_id in the tree
1203
:return: A branch associated with the file_id
1205
# FIXME should provide multiple branches, based on config
1206
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1208
def supports_tags(self):
1209
return self._format.supports_tags()
1211
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1213
"""Ensure that revision_b is a descendant of revision_a.
1215
This is a helper function for update_revisions.
1217
:raises: DivergedBranches if revision_b has diverged from revision_a.
1218
:returns: True if revision_b is a descendant of revision_a.
1220
relation = self._revision_relations(revision_a, revision_b, graph)
1221
if relation == 'b_descends_from_a':
1223
elif relation == 'diverged':
1224
raise errors.DivergedBranches(self, other_branch)
1225
elif relation == 'a_descends_from_b':
1228
raise AssertionError("invalid relation: %r" % (relation,))
1230
def _revision_relations(self, revision_a, revision_b, graph):
1231
"""Determine the relationship between two revisions.
1233
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1235
heads = graph.heads([revision_a, revision_b])
1236
if heads == set([revision_b]):
1237
return 'b_descends_from_a'
1238
elif heads == set([revision_a, revision_b]):
1239
# These branches have diverged
1241
elif heads == set([revision_a]):
1242
return 'a_descends_from_b'
1244
raise AssertionError("invalid heads: %r" % (heads,))
1247
class BranchFormat(object):
1248
"""An encapsulation of the initialization and open routines for a format.
1250
Formats provide three things:
1251
* An initialization routine,
1255
Formats are placed in an dict by their format string for reference
1256
during branch opening. Its not required that these be instances, they
1257
can be classes themselves with class methods - it simply depends on
1258
whether state is needed for a given format or not.
1260
Once a format is deprecated, just deprecate the initialize and open
1261
methods on the format class. Do not deprecate the object, as the
1262
object will be created every time regardless.
1265
_default_format = None
1266
"""The default format used for new branches."""
1269
"""The known formats."""
1271
def __eq__(self, other):
1272
return self.__class__ is other.__class__
1274
def __ne__(self, other):
1275
return not (self == other)
1278
def find_format(klass, a_bzrdir):
1279
"""Return the format for the branch object in a_bzrdir."""
1281
transport = a_bzrdir.get_branch_transport(None)
1282
format_string = transport.get("format").read()
1283
return klass._formats[format_string]
1284
except errors.NoSuchFile:
1285
raise errors.NotBranchError(path=transport.base)
1287
raise errors.UnknownFormatError(format=format_string, kind='branch')
1290
def get_default_format(klass):
1291
"""Return the current default format."""
1292
return klass._default_format
1294
def get_reference(self, a_bzrdir):
1295
"""Get the target reference of the branch in a_bzrdir.
1297
format probing must have been completed before calling
1298
this method - it is assumed that the format of the branch
1299
in a_bzrdir is correct.
1301
:param a_bzrdir: The bzrdir to get the branch data from.
1302
:return: None if the branch is not a reference branch.
1307
def set_reference(self, a_bzrdir, to_branch):
1308
"""Set the target reference of the branch in a_bzrdir.
1310
format probing must have been completed before calling
1311
this method - it is assumed that the format of the branch
1312
in a_bzrdir is correct.
1314
:param a_bzrdir: The bzrdir to set the branch reference for.
1315
:param to_branch: branch that the checkout is to reference
1317
raise NotImplementedError(self.set_reference)
1319
def get_format_string(self):
1320
"""Return the ASCII format string that identifies this format."""
1321
raise NotImplementedError(self.get_format_string)
1323
def get_format_description(self):
1324
"""Return the short format description for this format."""
1325
raise NotImplementedError(self.get_format_description)
1327
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1329
"""Initialize a branch in a bzrdir, with specified files
1331
:param a_bzrdir: The bzrdir to initialize the branch in
1332
:param utf8_files: The files to create as a list of
1333
(filename, content) tuples
1334
:param set_format: If True, set the format with
1335
self.get_format_string. (BzrBranch4 has its format set
1337
:return: a branch in this format
1339
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1340
branch_transport = a_bzrdir.get_branch_transport(self)
1342
'metadir': ('lock', lockdir.LockDir),
1343
'branch4': ('branch-lock', lockable_files.TransportLock),
1345
lock_name, lock_class = lock_map[lock_type]
1346
control_files = lockable_files.LockableFiles(branch_transport,
1347
lock_name, lock_class)
1348
control_files.create_lock()
1349
control_files.lock_write()
1351
utf8_files += [('format', self.get_format_string())]
1353
for (filename, content) in utf8_files:
1354
branch_transport.put_bytes(
1356
mode=a_bzrdir._get_file_mode())
1358
control_files.unlock()
1359
return self.open(a_bzrdir, _found=True)
1361
def initialize(self, a_bzrdir):
1362
"""Create a branch of this format in a_bzrdir."""
1363
raise NotImplementedError(self.initialize)
1365
def is_supported(self):
1366
"""Is this format supported?
1368
Supported formats can be initialized and opened.
1369
Unsupported formats may not support initialization or committing or
1370
some other features depending on the reason for not being supported.
1374
def make_tags(self, branch):
1375
"""Create a tags object for branch.
1377
This method is on BranchFormat, because BranchFormats are reflected
1378
over the wire via network_name(), whereas full Branch instances require
1379
multiple VFS method calls to operate at all.
1381
The default implementation returns a disabled-tags instance.
1383
Note that it is normal for branch to be a RemoteBranch when using tags
1386
return DisabledTags(branch)
1388
def network_name(self):
1389
"""A simple byte string uniquely identifying this format for RPC calls.
1391
MetaDir branch formats use their disk format string to identify the
1392
repository over the wire. All in one formats such as bzr < 0.8, and
1393
foreign formats like svn/git and hg should use some marker which is
1394
unique and immutable.
1396
raise NotImplementedError(self.network_name)
1398
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1399
"""Return the branch object for a_bzrdir
1401
:param a_bzrdir: A BzrDir that contains a branch.
1402
:param _found: a private parameter, do not use it. It is used to
1403
indicate if format probing has already be done.
1404
:param ignore_fallbacks: when set, no fallback branches will be opened
1405
(if there are any). Default is to open fallbacks.
1407
raise NotImplementedError(self.open)
1410
def register_format(klass, format):
1411
"""Register a metadir format."""
1412
klass._formats[format.get_format_string()] = format
1413
# Metadir formats have a network name of their format string, and get
1414
# registered as class factories.
1415
network_format_registry.register(format.get_format_string(), format.__class__)
1418
def set_default_format(klass, format):
1419
klass._default_format = format
1421
def supports_stacking(self):
1422
"""True if this format records a stacked-on branch."""
1426
def unregister_format(klass, format):
1427
del klass._formats[format.get_format_string()]
1430
return self.get_format_description().rstrip()
1432
def supports_tags(self):
1433
"""True if this format supports tags stored in the branch"""
1434
return False # by default
1437
class BranchHooks(Hooks):
1438
"""A dictionary mapping hook name to a list of callables for branch hooks.
1440
e.g. ['set_rh'] Is the list of items to be called when the
1441
set_revision_history function is invoked.
1445
"""Create the default hooks.
1447
These are all empty initially, because by default nothing should get
1450
Hooks.__init__(self)
1451
self.create_hook(HookPoint('set_rh',
1452
"Invoked whenever the revision history has been set via "
1453
"set_revision_history. The api signature is (branch, "
1454
"revision_history), and the branch will be write-locked. "
1455
"The set_rh hook can be expensive for bzr to trigger, a better "
1456
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1457
self.create_hook(HookPoint('open',
1458
"Called with the Branch object that has been opened after a "
1459
"branch is opened.", (1, 8), None))
1460
self.create_hook(HookPoint('post_push',
1461
"Called after a push operation completes. post_push is called "
1462
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1463
"bzr client.", (0, 15), None))
1464
self.create_hook(HookPoint('post_pull',
1465
"Called after a pull operation completes. post_pull is called "
1466
"with a bzrlib.branch.PullResult object and only runs in the "
1467
"bzr client.", (0, 15), None))
1468
self.create_hook(HookPoint('pre_commit',
1469
"Called after a commit is calculated but before it is is "
1470
"completed. pre_commit is called with (local, master, old_revno, "
1471
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1472
"). old_revid is NULL_REVISION for the first commit to a branch, "
1473
"tree_delta is a TreeDelta object describing changes from the "
1474
"basis revision. hooks MUST NOT modify this delta. "
1475
" future_tree is an in-memory tree obtained from "
1476
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1477
"tree.", (0,91), None))
1478
self.create_hook(HookPoint('post_commit',
1479
"Called in the bzr client after a commit has completed. "
1480
"post_commit is called with (local, master, old_revno, old_revid, "
1481
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1482
"commit to a branch.", (0, 15), None))
1483
self.create_hook(HookPoint('post_uncommit',
1484
"Called in the bzr client after an uncommit completes. "
1485
"post_uncommit is called with (local, master, old_revno, "
1486
"old_revid, new_revno, new_revid) where local is the local branch "
1487
"or None, master is the target branch, and an empty branch "
1488
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1489
self.create_hook(HookPoint('pre_change_branch_tip',
1490
"Called in bzr client and server before a change to the tip of a "
1491
"branch is made. pre_change_branch_tip is called with a "
1492
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1493
"commit, uncommit will all trigger this hook.", (1, 6), None))
1494
self.create_hook(HookPoint('post_change_branch_tip',
1495
"Called in bzr client and server after a change to the tip of a "
1496
"branch is made. post_change_branch_tip is called with a "
1497
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1498
"commit, uncommit will all trigger this hook.", (1, 4), None))
1499
self.create_hook(HookPoint('transform_fallback_location',
1500
"Called when a stacked branch is activating its fallback "
1501
"locations. transform_fallback_location is called with (branch, "
1502
"url), and should return a new url. Returning the same url "
1503
"allows it to be used as-is, returning a different one can be "
1504
"used to cause the branch to stack on a closer copy of that "
1505
"fallback_location. Note that the branch cannot have history "
1506
"accessing methods called on it during this hook because the "
1507
"fallback locations have not been activated. When there are "
1508
"multiple hooks installed for transform_fallback_location, "
1509
"all are called with the url returned from the previous hook."
1510
"The order is however undefined.", (1, 9), None))
1513
# install the default hooks into the Branch class.
1514
Branch.hooks = BranchHooks()
1517
class ChangeBranchTipParams(object):
1518
"""Object holding parameters passed to *_change_branch_tip hooks.
1520
There are 5 fields that hooks may wish to access:
1522
:ivar branch: the branch being changed
1523
:ivar old_revno: revision number before the change
1524
:ivar new_revno: revision number after the change
1525
:ivar old_revid: revision id before the change
1526
:ivar new_revid: revision id after the change
1528
The revid fields are strings. The revno fields are integers.
1531
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1532
"""Create a group of ChangeBranchTip parameters.
1534
:param branch: The branch being changed.
1535
:param old_revno: Revision number before the change.
1536
:param new_revno: Revision number after the change.
1537
:param old_revid: Tip revision id before the change.
1538
:param new_revid: Tip revision id after the change.
1540
self.branch = branch
1541
self.old_revno = old_revno
1542
self.new_revno = new_revno
1543
self.old_revid = old_revid
1544
self.new_revid = new_revid
1546
def __eq__(self, other):
1547
return self.__dict__ == other.__dict__
1550
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1551
self.__class__.__name__, self.branch,
1552
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1555
class BzrBranchFormat4(BranchFormat):
1556
"""Bzr branch format 4.
1559
- a revision-history file.
1560
- a branch-lock lock file [ to be shared with the bzrdir ]
1563
def get_format_description(self):
1564
"""See BranchFormat.get_format_description()."""
1565
return "Branch format 4"
1567
def initialize(self, a_bzrdir):
1568
"""Create a branch of this format in a_bzrdir."""
1569
utf8_files = [('revision-history', ''),
1570
('branch-name', ''),
1572
return self._initialize_helper(a_bzrdir, utf8_files,
1573
lock_type='branch4', set_format=False)
1576
super(BzrBranchFormat4, self).__init__()
1577
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1579
def network_name(self):
1580
"""The network name for this format is the control dirs disk label."""
1581
return self._matchingbzrdir.get_format_string()
1583
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1584
"""See BranchFormat.open()."""
1586
# we are being called directly and must probe.
1587
raise NotImplementedError
1588
return BzrBranch(_format=self,
1589
_control_files=a_bzrdir._control_files,
1591
_repository=a_bzrdir.open_repository())
1594
return "Bazaar-NG branch format 4"
1597
class BranchFormatMetadir(BranchFormat):
1598
"""Common logic for meta-dir based branch formats."""
1600
def _branch_class(self):
1601
"""What class to instantiate on open calls."""
1602
raise NotImplementedError(self._branch_class)
1604
def network_name(self):
1605
"""A simple byte string uniquely identifying this format for RPC calls.
1607
Metadir branch formats use their format string.
1609
return self.get_format_string()
1611
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1612
"""See BranchFormat.open()."""
1614
format = BranchFormat.find_format(a_bzrdir)
1615
if format.__class__ != self.__class__:
1616
raise AssertionError("wrong format %r found for %r" %
1619
transport = a_bzrdir.get_branch_transport(None)
1620
control_files = lockable_files.LockableFiles(transport, 'lock',
1622
return self._branch_class()(_format=self,
1623
_control_files=control_files,
1625
_repository=a_bzrdir.find_repository(),
1626
ignore_fallbacks=ignore_fallbacks)
1627
except errors.NoSuchFile:
1628
raise errors.NotBranchError(path=transport.base)
1631
super(BranchFormatMetadir, self).__init__()
1632
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1633
self._matchingbzrdir.set_branch_format(self)
1635
def supports_tags(self):
1639
class BzrBranchFormat5(BranchFormatMetadir):
1640
"""Bzr branch format 5.
1643
- a revision-history file.
1645
- a lock dir guarding the branch itself
1646
- all of this stored in a branch/ subdirectory
1647
- works with shared repositories.
1649
This format is new in bzr 0.8.
1652
def _branch_class(self):
1655
def get_format_string(self):
1656
"""See BranchFormat.get_format_string()."""
1657
return "Bazaar-NG branch format 5\n"
1659
def get_format_description(self):
1660
"""See BranchFormat.get_format_description()."""
1661
return "Branch format 5"
1663
def initialize(self, a_bzrdir):
1664
"""Create a branch of this format in a_bzrdir."""
1665
utf8_files = [('revision-history', ''),
1666
('branch-name', ''),
1668
return self._initialize_helper(a_bzrdir, utf8_files)
1670
def supports_tags(self):
1674
class BzrBranchFormat6(BranchFormatMetadir):
1675
"""Branch format with last-revision and tags.
1677
Unlike previous formats, this has no explicit revision history. Instead,
1678
this just stores the last-revision, and the left-hand history leading
1679
up to there is the history.
1681
This format was introduced in bzr 0.15
1682
and became the default in 0.91.
1685
def _branch_class(self):
1688
def get_format_string(self):
1689
"""See BranchFormat.get_format_string()."""
1690
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1692
def get_format_description(self):
1693
"""See BranchFormat.get_format_description()."""
1694
return "Branch format 6"
1696
def initialize(self, a_bzrdir):
1697
"""Create a branch of this format in a_bzrdir."""
1698
utf8_files = [('last-revision', '0 null:\n'),
1699
('branch.conf', ''),
1702
return self._initialize_helper(a_bzrdir, utf8_files)
1704
def make_tags(self, branch):
1705
"""See bzrlib.branch.BranchFormat.make_tags()."""
1706
return BasicTags(branch)
1710
class BzrBranchFormat7(BranchFormatMetadir):
1711
"""Branch format with last-revision, tags, and a stacked location pointer.
1713
The stacked location pointer is passed down to the repository and requires
1714
a repository format with supports_external_lookups = True.
1716
This format was introduced in bzr 1.6.
1719
def _branch_class(self):
1722
def get_format_string(self):
1723
"""See BranchFormat.get_format_string()."""
1724
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1726
def get_format_description(self):
1727
"""See BranchFormat.get_format_description()."""
1728
return "Branch format 7"
1730
def initialize(self, a_bzrdir):
1731
"""Create a branch of this format in a_bzrdir."""
1732
utf8_files = [('last-revision', '0 null:\n'),
1733
('branch.conf', ''),
1736
return self._initialize_helper(a_bzrdir, utf8_files)
1739
super(BzrBranchFormat7, self).__init__()
1740
self._matchingbzrdir.repository_format = \
1741
RepositoryFormatKnitPack5RichRoot()
1743
def make_tags(self, branch):
1744
"""See bzrlib.branch.BranchFormat.make_tags()."""
1745
return BasicTags(branch)
1747
def supports_stacking(self):
1751
class BranchReferenceFormat(BranchFormat):
1752
"""Bzr branch reference format.
1754
Branch references are used in implementing checkouts, they
1755
act as an alias to the real branch which is at some other url.
1762
def get_format_string(self):
1763
"""See BranchFormat.get_format_string()."""
1764
return "Bazaar-NG Branch Reference Format 1\n"
1766
def get_format_description(self):
1767
"""See BranchFormat.get_format_description()."""
1768
return "Checkout reference format 1"
1770
def get_reference(self, a_bzrdir):
1771
"""See BranchFormat.get_reference()."""
1772
transport = a_bzrdir.get_branch_transport(None)
1773
return transport.get('location').read()
1775
def set_reference(self, a_bzrdir, to_branch):
1776
"""See BranchFormat.set_reference()."""
1777
transport = a_bzrdir.get_branch_transport(None)
1778
location = transport.put_bytes('location', to_branch.base)
1780
def initialize(self, a_bzrdir, target_branch=None):
1781
"""Create a branch of this format in a_bzrdir."""
1782
if target_branch is None:
1783
# this format does not implement branch itself, thus the implicit
1784
# creation contract must see it as uninitializable
1785
raise errors.UninitializableFormat(self)
1786
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1787
branch_transport = a_bzrdir.get_branch_transport(self)
1788
branch_transport.put_bytes('location',
1789
target_branch.bzrdir.root_transport.base)
1790
branch_transport.put_bytes('format', self.get_format_string())
1792
a_bzrdir, _found=True,
1793
possible_transports=[target_branch.bzrdir.root_transport])
1796
super(BranchReferenceFormat, self).__init__()
1797
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1798
self._matchingbzrdir.set_branch_format(self)
1800
def _make_reference_clone_function(format, a_branch):
1801
"""Create a clone() routine for a branch dynamically."""
1802
def clone(to_bzrdir, revision_id=None,
1803
repository_policy=None):
1804
"""See Branch.clone()."""
1805
return format.initialize(to_bzrdir, a_branch)
1806
# cannot obey revision_id limits when cloning a reference ...
1807
# FIXME RBC 20060210 either nuke revision_id for clone, or
1808
# emit some sort of warning/error to the caller ?!
1811
def open(self, a_bzrdir, _found=False, location=None,
1812
possible_transports=None, ignore_fallbacks=False):
1813
"""Return the branch that the branch reference in a_bzrdir points at.
1815
:param a_bzrdir: A BzrDir that contains a branch.
1816
:param _found: a private parameter, do not use it. It is used to
1817
indicate if format probing has already be done.
1818
:param ignore_fallbacks: when set, no fallback branches will be opened
1819
(if there are any). Default is to open fallbacks.
1820
:param location: The location of the referenced branch. If
1821
unspecified, this will be determined from the branch reference in
1823
:param possible_transports: An optional reusable transports list.
1826
format = BranchFormat.find_format(a_bzrdir)
1827
if format.__class__ != self.__class__:
1828
raise AssertionError("wrong format %r found for %r" %
1830
if location is None:
1831
location = self.get_reference(a_bzrdir)
1832
real_bzrdir = bzrdir.BzrDir.open(
1833
location, possible_transports=possible_transports)
1834
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1835
# this changes the behaviour of result.clone to create a new reference
1836
# rather than a copy of the content of the branch.
1837
# I did not use a proxy object because that needs much more extensive
1838
# testing, and we are only changing one behaviour at the moment.
1839
# If we decide to alter more behaviours - i.e. the implicit nickname
1840
# then this should be refactored to introduce a tested proxy branch
1841
# and a subclass of that for use in overriding clone() and ....
1843
result.clone = self._make_reference_clone_function(result)
1847
network_format_registry = registry.FormatRegistry()
1848
"""Registry of formats indexed by their network name.
1850
The network name for a branch format is an identifier that can be used when
1851
referring to formats with smart server operations. See
1852
BranchFormat.network_name() for more detail.
1856
# formats which have no format string are not discoverable
1857
# and not independently creatable, so are not registered.
1858
__format5 = BzrBranchFormat5()
1859
__format6 = BzrBranchFormat6()
1860
__format7 = BzrBranchFormat7()
1861
BranchFormat.register_format(__format5)
1862
BranchFormat.register_format(BranchReferenceFormat())
1863
BranchFormat.register_format(__format6)
1864
BranchFormat.register_format(__format7)
1865
BranchFormat.set_default_format(__format6)
1866
_legacy_formats = [BzrBranchFormat4(),
1868
network_format_registry.register(
1869
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1872
class BzrBranch(Branch):
1873
"""A branch stored in the actual filesystem.
1875
Note that it's "local" in the context of the filesystem; it doesn't
1876
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1877
it's writable, and can be accessed via the normal filesystem API.
1879
:ivar _transport: Transport for file operations on this branch's
1880
control files, typically pointing to the .bzr/branch directory.
1881
:ivar repository: Repository for this branch.
1882
:ivar base: The url of the base directory for this branch; the one
1883
containing the .bzr directory.
1886
def __init__(self, _format=None,
1887
_control_files=None, a_bzrdir=None, _repository=None,
1888
ignore_fallbacks=False):
1889
"""Create new branch object at a particular location."""
1890
if a_bzrdir is None:
1891
raise ValueError('a_bzrdir must be supplied')
1893
self.bzrdir = a_bzrdir
1894
self._base = self.bzrdir.transport.clone('..').base
1895
# XXX: We should be able to just do
1896
# self.base = self.bzrdir.root_transport.base
1897
# but this does not quite work yet -- mbp 20080522
1898
self._format = _format
1899
if _control_files is None:
1900
raise ValueError('BzrBranch _control_files is None')
1901
self.control_files = _control_files
1902
self._transport = _control_files._transport
1903
self.repository = _repository
1904
Branch.__init__(self)
1907
return '%s(%r)' % (self.__class__.__name__, self.base)
1911
def _get_base(self):
1912
"""Returns the directory containing the control directory."""
1915
base = property(_get_base, doc="The URL for the root of this branch.")
1917
def _get_config(self):
1918
return TransportConfig(self._transport, 'branch.conf')
1920
def is_locked(self):
1921
return self.control_files.is_locked()
1923
def lock_write(self, token=None):
1924
repo_token = self.repository.lock_write()
1926
token = self.control_files.lock_write(token=token)
1928
self.repository.unlock()
1932
def lock_read(self):
1933
self.repository.lock_read()
1935
self.control_files.lock_read()
1937
self.repository.unlock()
1941
# TODO: test for failed two phase locks. This is known broken.
1943
self.control_files.unlock()
1945
self.repository.unlock()
1946
if not self.control_files.is_locked():
1947
# we just released the lock
1948
self._clear_cached_state()
1950
def peek_lock_mode(self):
1951
if self.control_files._lock_count == 0:
1954
return self.control_files._lock_mode
1956
def get_physical_lock_status(self):
1957
return self.control_files.get_physical_lock_status()
1960
def print_file(self, file, revision_id):
1961
"""See Branch.print_file."""
1962
return self.repository.print_file(file, revision_id)
1964
def _write_revision_history(self, history):
1965
"""Factored out of set_revision_history.
1967
This performs the actual writing to disk.
1968
It is intended to be called by BzrBranch5.set_revision_history."""
1969
self._transport.put_bytes(
1970
'revision-history', '\n'.join(history),
1971
mode=self.bzrdir._get_file_mode())
1974
def set_revision_history(self, rev_history):
1975
"""See Branch.set_revision_history."""
1976
if 'evil' in debug.debug_flags:
1977
mutter_callsite(3, "set_revision_history scales with history.")
1978
check_not_reserved_id = _mod_revision.check_not_reserved_id
1979
for rev_id in rev_history:
1980
check_not_reserved_id(rev_id)
1981
if Branch.hooks['post_change_branch_tip']:
1982
# Don't calculate the last_revision_info() if there are no hooks
1984
old_revno, old_revid = self.last_revision_info()
1985
if len(rev_history) == 0:
1986
revid = _mod_revision.NULL_REVISION
1988
revid = rev_history[-1]
1989
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1990
self._write_revision_history(rev_history)
1991
self._clear_cached_state()
1992
self._cache_revision_history(rev_history)
1993
for hook in Branch.hooks['set_rh']:
1994
hook(self, rev_history)
1995
if Branch.hooks['post_change_branch_tip']:
1996
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1998
def _synchronize_history(self, destination, revision_id):
1999
"""Synchronize last revision and revision history between branches.
2001
This version is most efficient when the destination is also a
2002
BzrBranch5, but works for BzrBranch6 as long as the revision
2003
history is the true lefthand parent history, and all of the revisions
2004
are in the destination's repository. If not, set_revision_history
2007
:param destination: The branch to copy the history into
2008
:param revision_id: The revision-id to truncate history at. May
2009
be None to copy complete history.
2011
if not isinstance(destination._format, BzrBranchFormat5):
2012
super(BzrBranch, self)._synchronize_history(
2013
destination, revision_id)
2015
if revision_id == _mod_revision.NULL_REVISION:
2018
new_history = self.revision_history()
2019
if revision_id is not None and new_history != []:
2021
new_history = new_history[:new_history.index(revision_id) + 1]
2023
rev = self.repository.get_revision(revision_id)
2024
new_history = rev.get_history(self.repository)[1:]
2025
destination.set_revision_history(new_history)
2028
def set_last_revision_info(self, revno, revision_id):
2029
"""Set the last revision of this branch.
2031
The caller is responsible for checking that the revno is correct
2032
for this revision id.
2034
It may be possible to set the branch last revision to an id not
2035
present in the repository. However, branches can also be
2036
configured to check constraints on history, in which case this may not
2039
revision_id = _mod_revision.ensure_null(revision_id)
2040
# this old format stores the full history, but this api doesn't
2041
# provide it, so we must generate, and might as well check it's
2043
history = self._lefthand_history(revision_id)
2044
if len(history) != revno:
2045
raise AssertionError('%d != %d' % (len(history), revno))
2046
self.set_revision_history(history)
2048
def _gen_revision_history(self):
2049
history = self._transport.get_bytes('revision-history').split('\n')
2050
if history[-1:] == ['']:
2051
# There shouldn't be a trailing newline, but just in case.
2056
def generate_revision_history(self, revision_id, last_rev=None,
2058
"""Create a new revision history that will finish with revision_id.
2060
:param revision_id: the new tip to use.
2061
:param last_rev: The previous last_revision. If not None, then this
2062
must be a ancestory of revision_id, or DivergedBranches is raised.
2063
:param other_branch: The other branch that DivergedBranches should
2064
raise with respect to.
2066
self.set_revision_history(self._lefthand_history(revision_id,
2067
last_rev, other_branch))
2069
def basis_tree(self):
2070
"""See Branch.basis_tree."""
2071
return self.repository.revision_tree(self.last_revision())
2074
def pull(self, source, overwrite=False, stop_revision=None,
2075
_hook_master=None, run_hooks=True, possible_transports=None,
2076
_override_hook_target=None):
2079
:param _hook_master: Private parameter - set the branch to
2080
be supplied as the master to pull hooks.
2081
:param run_hooks: Private parameter - if false, this branch
2082
is being called because it's the master of the primary branch,
2083
so it should not run its hooks.
2084
:param _override_hook_target: Private parameter - set the branch to be
2085
supplied as the target_branch to pull hooks.
2087
result = PullResult()
2088
result.source_branch = source
2089
if _override_hook_target is None:
2090
result.target_branch = self
2092
result.target_branch = _override_hook_target
2095
# We assume that during 'pull' the local repository is closer than
2097
graph = self.repository.get_graph(source.repository)
2098
result.old_revno, result.old_revid = self.last_revision_info()
2099
self.update_revisions(source, stop_revision, overwrite=overwrite,
2101
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2102
result.new_revno, result.new_revid = self.last_revision_info()
2104
result.master_branch = _hook_master
2105
result.local_branch = result.target_branch
2107
result.master_branch = result.target_branch
2108
result.local_branch = None
2110
for hook in Branch.hooks['post_pull']:
2116
def _get_parent_location(self):
2117
_locs = ['parent', 'pull', 'x-pull']
2120
return self._transport.get_bytes(l).strip('\n')
2121
except errors.NoSuchFile:
2126
def push(self, target, overwrite=False, stop_revision=None,
2127
_override_hook_source_branch=None):
2130
This is the basic concrete implementation of push()
2132
:param _override_hook_source_branch: If specified, run
2133
the hooks passing this Branch as the source, rather than self.
2134
This is for use of RemoteBranch, where push is delegated to the
2135
underlying vfs-based Branch.
2137
# TODO: Public option to disable running hooks - should be trivial but
2139
return _run_with_write_locked_target(
2140
target, self._push_with_bound_branches, target, overwrite,
2142
_override_hook_source_branch=_override_hook_source_branch)
2144
def _push_with_bound_branches(self, target, overwrite,
2146
_override_hook_source_branch=None):
2147
"""Push from self into target, and into target's master if any.
2149
This is on the base BzrBranch class even though it doesn't support
2150
bound branches because the *target* might be bound.
2153
if _override_hook_source_branch:
2154
result.source_branch = _override_hook_source_branch
2155
for hook in Branch.hooks['post_push']:
2158
bound_location = target.get_bound_location()
2159
if bound_location and target.base != bound_location:
2160
# there is a master branch.
2162
# XXX: Why the second check? Is it even supported for a branch to
2163
# be bound to itself? -- mbp 20070507
2164
master_branch = target.get_master_branch()
2165
master_branch.lock_write()
2167
# push into the master from this branch.
2168
self._basic_push(master_branch, overwrite, stop_revision)
2169
# and push into the target branch from this. Note that we push from
2170
# this branch again, because its considered the highest bandwidth
2172
result = self._basic_push(target, overwrite, stop_revision)
2173
result.master_branch = master_branch
2174
result.local_branch = target
2178
master_branch.unlock()
2181
result = self._basic_push(target, overwrite, stop_revision)
2182
# TODO: Why set master_branch and local_branch if there's no
2183
# binding? Maybe cleaner to just leave them unset? -- mbp
2185
result.master_branch = target
2186
result.local_branch = None
2190
def _basic_push(self, target, overwrite, stop_revision):
2191
"""Basic implementation of push without bound branches or hooks.
2193
Must be called with self read locked and target write locked.
2195
result = BranchPushResult()
2196
result.source_branch = self
2197
result.target_branch = target
2198
result.old_revno, result.old_revid = target.last_revision_info()
2199
if result.old_revid != self.last_revision():
2200
# We assume that during 'push' this repository is closer than
2202
graph = self.repository.get_graph(target.repository)
2203
target.update_revisions(self, stop_revision, overwrite=overwrite,
2205
if self._push_should_merge_tags():
2206
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2207
result.new_revno, result.new_revid = target.last_revision_info()
2210
def get_stacked_on_url(self):
2211
raise errors.UnstackableBranchFormat(self._format, self.base)
2213
def set_push_location(self, location):
2214
"""See Branch.set_push_location."""
2215
self.get_config().set_user_option(
2216
'push_location', location,
2217
store=_mod_config.STORE_LOCATION_NORECURSE)
2219
def _set_parent_location(self, url):
2221
self._transport.delete('parent')
2223
self._transport.put_bytes('parent', url + '\n',
2224
mode=self.bzrdir._get_file_mode())
2227
class BzrBranch5(BzrBranch):
2228
"""A format 5 branch. This supports new features over plain branches.
2230
It has support for a master_branch which is the data for bound branches.
2234
def pull(self, source, overwrite=False, stop_revision=None,
2235
run_hooks=True, possible_transports=None,
2236
_override_hook_target=None):
2237
"""Pull from source into self, updating my master if any.
2239
:param run_hooks: Private parameter - if false, this branch
2240
is being called because it's the master of the primary branch,
2241
so it should not run its hooks.
2243
bound_location = self.get_bound_location()
2244
master_branch = None
2245
if bound_location and source.base != bound_location:
2246
# not pulling from master, so we need to update master.
2247
master_branch = self.get_master_branch(possible_transports)
2248
master_branch.lock_write()
2251
# pull from source into master.
2252
master_branch.pull(source, overwrite, stop_revision,
2254
return super(BzrBranch5, self).pull(source, overwrite,
2255
stop_revision, _hook_master=master_branch,
2256
run_hooks=run_hooks,
2257
_override_hook_target=_override_hook_target)
2260
master_branch.unlock()
2262
def get_bound_location(self):
2264
return self._transport.get_bytes('bound')[:-1]
2265
except errors.NoSuchFile:
2269
def get_master_branch(self, possible_transports=None):
2270
"""Return the branch we are bound to.
2272
:return: Either a Branch, or None
2274
This could memoise the branch, but if thats done
2275
it must be revalidated on each new lock.
2276
So for now we just don't memoise it.
2277
# RBC 20060304 review this decision.
2279
bound_loc = self.get_bound_location()
2283
return Branch.open(bound_loc,
2284
possible_transports=possible_transports)
2285
except (errors.NotBranchError, errors.ConnectionError), e:
2286
raise errors.BoundBranchConnectionFailure(
2290
def set_bound_location(self, location):
2291
"""Set the target where this branch is bound to.
2293
:param location: URL to the target branch
2296
self._transport.put_bytes('bound', location+'\n',
2297
mode=self.bzrdir._get_file_mode())
2300
self._transport.delete('bound')
2301
except errors.NoSuchFile:
2306
def bind(self, other):
2307
"""Bind this branch to the branch other.
2309
This does not push or pull data between the branches, though it does
2310
check for divergence to raise an error when the branches are not
2311
either the same, or one a prefix of the other. That behaviour may not
2312
be useful, so that check may be removed in future.
2314
:param other: The branch to bind to
2317
# TODO: jam 20051230 Consider checking if the target is bound
2318
# It is debatable whether you should be able to bind to
2319
# a branch which is itself bound.
2320
# Committing is obviously forbidden,
2321
# but binding itself may not be.
2322
# Since we *have* to check at commit time, we don't
2323
# *need* to check here
2325
# we want to raise diverged if:
2326
# last_rev is not in the other_last_rev history, AND
2327
# other_last_rev is not in our history, and do it without pulling
2329
self.set_bound_location(other.base)
2333
"""If bound, unbind"""
2334
return self.set_bound_location(None)
2337
def update(self, possible_transports=None):
2338
"""Synchronise this branch with the master branch if any.
2340
:return: None or the last_revision that was pivoted out during the
2343
master = self.get_master_branch(possible_transports)
2344
if master is not None:
2345
old_tip = _mod_revision.ensure_null(self.last_revision())
2346
self.pull(master, overwrite=True)
2347
if self.repository.get_graph().is_ancestor(old_tip,
2348
_mod_revision.ensure_null(self.last_revision())):
2354
class BzrBranch7(BzrBranch5):
2355
"""A branch with support for a fallback repository."""
2357
def _open_hook(self):
2358
if self._ignore_fallbacks:
2361
url = self.get_stacked_on_url()
2362
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2363
errors.UnstackableBranchFormat):
2366
for hook in Branch.hooks['transform_fallback_location']:
2367
url = hook(self, url)
2369
hook_name = Branch.hooks.get_hook_name(hook)
2370
raise AssertionError(
2371
"'transform_fallback_location' hook %s returned "
2372
"None, not a URL." % hook_name)
2373
self._activate_fallback_location(url)
2375
def __init__(self, *args, **kwargs):
2376
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2377
super(BzrBranch7, self).__init__(*args, **kwargs)
2378
self._last_revision_info_cache = None
2379
self._partial_revision_history_cache = []
2381
def _clear_cached_state(self):
2382
super(BzrBranch7, self)._clear_cached_state()
2383
self._last_revision_info_cache = None
2384
self._partial_revision_history_cache = []
2386
def _last_revision_info(self):
2387
revision_string = self._transport.get_bytes('last-revision')
2388
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2389
revision_id = cache_utf8.get_cached_utf8(revision_id)
2391
return revno, revision_id
2393
def _write_last_revision_info(self, revno, revision_id):
2394
"""Simply write out the revision id, with no checks.
2396
Use set_last_revision_info to perform this safely.
2398
Does not update the revision_history cache.
2399
Intended to be called by set_last_revision_info and
2400
_write_revision_history.
2402
revision_id = _mod_revision.ensure_null(revision_id)
2403
out_string = '%d %s\n' % (revno, revision_id)
2404
self._transport.put_bytes('last-revision', out_string,
2405
mode=self.bzrdir._get_file_mode())
2408
def set_last_revision_info(self, revno, revision_id):
2409
revision_id = _mod_revision.ensure_null(revision_id)
2410
old_revno, old_revid = self.last_revision_info()
2411
if self._get_append_revisions_only():
2412
self._check_history_violation(revision_id)
2413
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2414
self._write_last_revision_info(revno, revision_id)
2415
self._clear_cached_state()
2416
self._last_revision_info_cache = revno, revision_id
2417
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2419
def _synchronize_history(self, destination, revision_id):
2420
"""Synchronize last revision and revision history between branches.
2422
:see: Branch._synchronize_history
2424
# XXX: The base Branch has a fast implementation of this method based
2425
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2426
# that uses set_revision_history. This class inherits from BzrBranch5,
2427
# but wants the fast implementation, so it calls
2428
# Branch._synchronize_history directly.
2429
Branch._synchronize_history(self, destination, revision_id)
2431
def _check_history_violation(self, revision_id):
2432
last_revision = _mod_revision.ensure_null(self.last_revision())
2433
if _mod_revision.is_null(last_revision):
2435
if last_revision not in self._lefthand_history(revision_id):
2436
raise errors.AppendRevisionsOnlyViolation(self.base)
2438
def _gen_revision_history(self):
2439
"""Generate the revision history from last revision
2441
last_revno, last_revision = self.last_revision_info()
2442
self._extend_partial_history(stop_index=last_revno-1)
2443
return list(reversed(self._partial_revision_history_cache))
2445
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2446
"""Extend the partial history to include a given index
2448
If a stop_index is supplied, stop when that index has been reached.
2449
If a stop_revision is supplied, stop when that revision is
2450
encountered. Otherwise, stop when the beginning of history is
2453
:param stop_index: The index which should be present. When it is
2454
present, history extension will stop.
2455
:param revision_id: The revision id which should be present. When
2456
it is encountered, history extension will stop.
2458
repo = self.repository
2459
if len(self._partial_revision_history_cache) == 0:
2460
iterator = repo.iter_reverse_revision_history(self.last_revision())
2462
start_revision = self._partial_revision_history_cache[-1]
2463
iterator = repo.iter_reverse_revision_history(start_revision)
2464
#skip the last revision in the list
2465
next_revision = iterator.next()
2466
for revision_id in iterator:
2467
self._partial_revision_history_cache.append(revision_id)
2468
if (stop_index is not None and
2469
len(self._partial_revision_history_cache) > stop_index):
2471
if revision_id == stop_revision:
2474
def _write_revision_history(self, history):
2475
"""Factored out of set_revision_history.
2477
This performs the actual writing to disk, with format-specific checks.
2478
It is intended to be called by BzrBranch5.set_revision_history.
2480
if len(history) == 0:
2481
last_revision = 'null:'
2483
if history != self._lefthand_history(history[-1]):
2484
raise errors.NotLefthandHistory(history)
2485
last_revision = history[-1]
2486
if self._get_append_revisions_only():
2487
self._check_history_violation(last_revision)
2488
self._write_last_revision_info(len(history), last_revision)
2491
def _set_parent_location(self, url):
2492
"""Set the parent branch"""
2493
self._set_config_location('parent_location', url, make_relative=True)
2496
def _get_parent_location(self):
2497
"""Set the parent branch"""
2498
return self._get_config_location('parent_location')
2500
def set_push_location(self, location):
2501
"""See Branch.set_push_location."""
2502
self._set_config_location('push_location', location)
2504
def set_bound_location(self, location):
2505
"""See Branch.set_push_location."""
2507
config = self.get_config()
2508
if location is None:
2509
if config.get_user_option('bound') != 'True':
2512
config.set_user_option('bound', 'False', warn_masked=True)
2515
self._set_config_location('bound_location', location,
2517
config.set_user_option('bound', 'True', warn_masked=True)
2520
def _get_bound_location(self, bound):
2521
"""Return the bound location in the config file.
2523
Return None if the bound parameter does not match"""
2524
config = self.get_config()
2525
config_bound = (config.get_user_option('bound') == 'True')
2526
if config_bound != bound:
2528
return self._get_config_location('bound_location', config=config)
2530
def get_bound_location(self):
2531
"""See Branch.set_push_location."""
2532
return self._get_bound_location(True)
2534
def get_old_bound_location(self):
2535
"""See Branch.get_old_bound_location"""
2536
return self._get_bound_location(False)
2538
def get_stacked_on_url(self):
2539
# you can always ask for the URL; but you might not be able to use it
2540
# if the repo can't support stacking.
2541
## self._check_stackable_repo()
2542
stacked_url = self._get_config_location('stacked_on_location')
2543
if stacked_url is None:
2544
raise errors.NotStacked(self)
2547
def set_append_revisions_only(self, enabled):
2552
self.get_config().set_user_option('append_revisions_only', value,
2555
def _get_append_revisions_only(self):
2556
value = self.get_config().get_user_option('append_revisions_only')
2557
return value == 'True'
2560
def generate_revision_history(self, revision_id, last_rev=None,
2562
"""See BzrBranch5.generate_revision_history"""
2563
history = self._lefthand_history(revision_id, last_rev, other_branch)
2564
revno = len(history)
2565
self.set_last_revision_info(revno, revision_id)
2568
def get_rev_id(self, revno, history=None):
2569
"""Find the revision id of the specified revno."""
2571
return _mod_revision.NULL_REVISION
2573
last_revno, last_revision_id = self.last_revision_info()
2574
if revno <= 0 or revno > last_revno:
2575
raise errors.NoSuchRevision(self, revno)
2577
if history is not None:
2578
return history[revno - 1]
2580
index = last_revno - revno
2581
if len(self._partial_revision_history_cache) <= index:
2582
self._extend_partial_history(stop_index=index)
2583
if len(self._partial_revision_history_cache) > index:
2584
return self._partial_revision_history_cache[index]
2586
raise errors.NoSuchRevision(self, revno)
2589
def revision_id_to_revno(self, revision_id):
2590
"""Given a revision id, return its revno"""
2591
if _mod_revision.is_null(revision_id):
2594
index = self._partial_revision_history_cache.index(revision_id)
2596
self._extend_partial_history(stop_revision=revision_id)
2597
index = len(self._partial_revision_history_cache) - 1
2598
if self._partial_revision_history_cache[index] != revision_id:
2599
raise errors.NoSuchRevision(self, revision_id)
2600
return self.revno() - index
2603
class BzrBranch6(BzrBranch7):
2604
"""See BzrBranchFormat6 for the capabilities of this branch.
2606
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2610
def get_stacked_on_url(self):
2611
raise errors.UnstackableBranchFormat(self._format, self.base)
2614
######################################################################
2615
# results of operations
2618
class _Result(object):
2620
def _show_tag_conficts(self, to_file):
2621
if not getattr(self, 'tag_conflicts', None):
2623
to_file.write('Conflicting tags:\n')
2624
for name, value1, value2 in self.tag_conflicts:
2625
to_file.write(' %s\n' % (name, ))
2628
class PullResult(_Result):
2629
"""Result of a Branch.pull operation.
2631
:ivar old_revno: Revision number before pull.
2632
:ivar new_revno: Revision number after pull.
2633
:ivar old_revid: Tip revision id before pull.
2634
:ivar new_revid: Tip revision id after pull.
2635
:ivar source_branch: Source (local) branch object. (read locked)
2636
:ivar master_branch: Master branch of the target, or the target if no
2638
:ivar local_branch: target branch if there is a Master, else None
2639
:ivar target_branch: Target/destination branch object. (write locked)
2640
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2644
# DEPRECATED: pull used to return the change in revno
2645
return self.new_revno - self.old_revno
2647
def report(self, to_file):
2649
if self.old_revid == self.new_revid:
2650
to_file.write('No revisions to pull.\n')
2652
to_file.write('Now on revision %d.\n' % self.new_revno)
2653
self._show_tag_conficts(to_file)
2656
class BranchPushResult(_Result):
2657
"""Result of a Branch.push operation.
2659
:ivar old_revno: Revision number (eg 10) of the target before push.
2660
:ivar new_revno: Revision number (eg 12) of the target after push.
2661
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2663
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2665
:ivar source_branch: Source branch object that the push was from. This is
2666
read locked, and generally is a local (and thus low latency) branch.
2667
:ivar master_branch: If target is a bound branch, the master branch of
2668
target, or target itself. Always write locked.
2669
:ivar target_branch: The direct Branch where data is being sent (write
2671
:ivar local_branch: If the target is a bound branch this will be the
2672
target, otherwise it will be None.
2676
# DEPRECATED: push used to return the change in revno
2677
return self.new_revno - self.old_revno
2679
def report(self, to_file):
2680
"""Write a human-readable description of the result."""
2681
if self.old_revid == self.new_revid:
2682
note('No new revisions to push.')
2684
note('Pushed up to revision %d.' % self.new_revno)
2685
self._show_tag_conficts(to_file)
2688
class BranchCheckResult(object):
2689
"""Results of checking branch consistency.
2694
def __init__(self, branch):
2695
self.branch = branch
2697
def report_results(self, verbose):
2698
"""Report the check results via trace.note.
2700
:param verbose: Requests more detailed display of what was checked,
2703
note('checked branch %s format %s',
2705
self.branch._format)
2708
class Converter5to6(object):
2709
"""Perform an in-place upgrade of format 5 to format 6"""
2711
def convert(self, branch):
2712
# Data for 5 and 6 can peacefully coexist.
2713
format = BzrBranchFormat6()
2714
new_branch = format.open(branch.bzrdir, _found=True)
2716
# Copy source data into target
2717
new_branch._write_last_revision_info(*branch.last_revision_info())
2718
new_branch.set_parent(branch.get_parent())
2719
new_branch.set_bound_location(branch.get_bound_location())
2720
new_branch.set_push_location(branch.get_push_location())
2722
# New branch has no tags by default
2723
new_branch.tags._set_tag_dict({})
2725
# Copying done; now update target format
2726
new_branch._transport.put_bytes('format',
2727
format.get_format_string(),
2728
mode=new_branch.bzrdir._get_file_mode())
2730
# Clean up old files
2731
new_branch._transport.delete('revision-history')
2733
branch.set_parent(None)
2734
except errors.NoSuchFile:
2736
branch.set_bound_location(None)
2739
class Converter6to7(object):
2740
"""Perform an in-place upgrade of format 6 to format 7"""
2742
def convert(self, branch):
2743
format = BzrBranchFormat7()
2744
branch._set_config_location('stacked_on_location', '')
2745
# update target format
2746
branch._transport.put_bytes('format', format.get_format_string())
2750
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2751
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2754
_run_with_write_locked_target will attempt to release the lock it acquires.
2756
If an exception is raised by callable, then that exception *will* be
2757
propagated, even if the unlock attempt raises its own error. Thus
2758
_run_with_write_locked_target should be preferred to simply doing::
2762
return callable(*args, **kwargs)
2767
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2768
# should share code?
2771
result = callable(*args, **kwargs)
2773
exc_info = sys.exc_info()
2777
raise exc_info[0], exc_info[1], exc_info[2]
2783
class InterBranch(InterObject):
2784
"""This class represents operations taking place between two branches.
2786
Its instances have methods like pull() and push() and contain
2787
references to the source and target repositories these operations
2788
can be carried out on.
2792
"""The available optimised InterBranch types."""
2795
def _get_branch_formats_to_test():
2796
"""Return a tuple with the Branch formats to use when testing."""
2797
raise NotImplementedError(self._get_branch_formats_to_test)
2799
def update_revisions(self, stop_revision=None, overwrite=False,
2801
"""Pull in new perfect-fit revisions.
2803
:param stop_revision: Updated until the given revision
2804
:param overwrite: Always set the branch pointer, rather than checking
2805
to see if it is a proper descendant.
2806
:param graph: A Graph object that can be used to query history
2807
information. This can be None.
2810
raise NotImplementedError(self.update_revisions)
2813
class GenericInterBranch(InterBranch):
2814
"""InterBranch implementation that uses public Branch functions.
2818
def _get_branch_formats_to_test():
2819
return BranchFormat._default_format, BranchFormat._default_format
2821
def update_revisions(self, stop_revision=None, overwrite=False,
2823
"""See InterBranch.update_revisions()."""
2824
self.source.lock_read()
2826
other_revno, other_last_revision = self.source.last_revision_info()
2827
stop_revno = None # unknown
2828
if stop_revision is None:
2829
stop_revision = other_last_revision
2830
if _mod_revision.is_null(stop_revision):
2831
# if there are no commits, we're done.
2833
stop_revno = other_revno
2835
# what's the current last revision, before we fetch [and change it
2837
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2838
# we fetch here so that we don't process data twice in the common
2839
# case of having something to pull, and so that the check for
2840
# already merged can operate on the just fetched graph, which will
2841
# be cached in memory.
2842
self.target.fetch(self.source, stop_revision)
2843
# Check to see if one is an ancestor of the other
2846
graph = self.target.repository.get_graph()
2847
if self.target._check_if_descendant_or_diverged(
2848
stop_revision, last_rev, graph, self.source):
2849
# stop_revision is a descendant of last_rev, but we aren't
2850
# overwriting, so we're done.
2852
if stop_revno is None:
2854
graph = self.target.repository.get_graph()
2855
this_revno, this_last_revision = \
2856
self.target.last_revision_info()
2857
stop_revno = graph.find_distance_to_null(stop_revision,
2858
[(other_last_revision, other_revno),
2859
(this_last_revision, this_revno)])
2860
self.target.set_last_revision_info(stop_revno, stop_revision)
2862
self.source.unlock()
2865
def is_compatible(self, source, target):
2866
# GenericBranch uses the public API, so always compatible
2870
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
