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()
1000
if repository_policy is not None:
1001
repository_policy.configure_branch(result)
1002
self.copy_content_into(result, revision_id=revision_id)
1006
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1007
"""Create a new line of development from the branch, into to_bzrdir.
1009
to_bzrdir controls the branch format.
1011
revision_id: if not None, the revision history in the new branch will
1012
be truncated to end with revision_id.
1014
result = to_bzrdir.create_branch()
1015
if repository_policy is not None:
1016
repository_policy.configure_branch(result)
1017
self.copy_content_into(result, revision_id=revision_id)
1018
result.set_parent(self.bzrdir.root_transport.base)
1021
def _synchronize_history(self, destination, revision_id):
1022
"""Synchronize last revision and revision history between branches.
1024
This version is most efficient when the destination is also a
1025
BzrBranch6, but works for BzrBranch5, as long as the destination's
1026
repository contains all the lefthand ancestors of the intended
1027
last_revision. If not, set_last_revision_info will fail.
1029
:param destination: The branch to copy the history into
1030
:param revision_id: The revision-id to truncate history at. May
1031
be None to copy complete history.
1033
source_revno, source_revision_id = self.last_revision_info()
1034
if revision_id is None:
1035
revno, revision_id = source_revno, source_revision_id
1036
elif source_revision_id == revision_id:
1037
# we know the revno without needing to walk all of history
1038
revno = source_revno
1040
# To figure out the revno for a random revision, we need to build
1041
# the revision history, and count its length.
1042
# We don't care about the order, just how long it is.
1043
# Alternatively, we could start at the current location, and count
1044
# backwards. But there is no guarantee that we will find it since
1045
# it may be a merged revision.
1046
revno = len(list(self.repository.iter_reverse_revision_history(
1048
destination.set_last_revision_info(revno, revision_id)
1051
def copy_content_into(self, destination, revision_id=None):
1052
"""Copy the content of self into destination.
1054
revision_id: if not None, the revision history in the new branch will
1055
be truncated to end with revision_id.
1057
self._synchronize_history(destination, revision_id)
1059
parent = self.get_parent()
1060
except errors.InaccessibleParent, e:
1061
mutter('parent was not accessible to copy: %s', e)
1064
destination.set_parent(parent)
1065
if self._push_should_merge_tags():
1066
self.tags.merge_to(destination.tags)
1070
"""Check consistency of the branch.
1072
In particular this checks that revisions given in the revision-history
1073
do actually match up in the revision graph, and that they're all
1074
present in the repository.
1076
Callers will typically also want to check the repository.
1078
:return: A BranchCheckResult.
1080
mainline_parent_id = None
1081
last_revno, last_revision_id = self.last_revision_info()
1082
real_rev_history = list(self.repository.iter_reverse_revision_history(
1084
real_rev_history.reverse()
1085
if len(real_rev_history) != last_revno:
1086
raise errors.BzrCheckError('revno does not match len(mainline)'
1087
' %s != %s' % (last_revno, len(real_rev_history)))
1088
# TODO: We should probably also check that real_rev_history actually
1089
# matches self.revision_history()
1090
for revision_id in real_rev_history:
1092
revision = self.repository.get_revision(revision_id)
1093
except errors.NoSuchRevision, e:
1094
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1096
# In general the first entry on the revision history has no parents.
1097
# But it's not illegal for it to have parents listed; this can happen
1098
# in imports from Arch when the parents weren't reachable.
1099
if mainline_parent_id is not None:
1100
if mainline_parent_id not in revision.parent_ids:
1101
raise errors.BzrCheckError("previous revision {%s} not listed among "
1103
% (mainline_parent_id, revision_id))
1104
mainline_parent_id = revision_id
1105
return BranchCheckResult(self)
1107
def _get_checkout_format(self):
1108
"""Return the most suitable metadir for a checkout of this branch.
1109
Weaves are used if this branch's repository uses weaves.
1111
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1112
from bzrlib.repofmt import weaverepo
1113
format = bzrdir.BzrDirMetaFormat1()
1114
format.repository_format = weaverepo.RepositoryFormat7()
1116
format = self.repository.bzrdir.checkout_metadir()
1117
format.set_branch_format(self._format)
1120
def create_clone_on_transport(self, to_transport, revision_id=None,
1122
"""Create a clone of this branch and its bzrdir.
1124
:param to_transport: The transport to clone onto.
1125
:param revision_id: The revision id to use as tip in the new branch.
1126
If None the tip is obtained from this branch.
1127
:param stacked_on: An optional URL to stack the clone on.
1129
# XXX: Fix the bzrdir API to allow getting the branch back from the
1130
# clone call. Or something. 20090224 RBC/spiv.
1131
dir_to = self.bzrdir.clone_on_transport(to_transport,
1132
revision_id=revision_id, stacked_on=stacked_on)
1133
return dir_to.open_branch()
1135
def create_checkout(self, to_location, revision_id=None,
1136
lightweight=False, accelerator_tree=None,
1138
"""Create a checkout of a branch.
1140
:param to_location: The url to produce the checkout at
1141
:param revision_id: The revision to check out
1142
:param lightweight: If True, produce a lightweight checkout, otherwise,
1143
produce a bound branch (heavyweight checkout)
1144
:param accelerator_tree: A tree which can be used for retrieving file
1145
contents more quickly than the revision tree, i.e. a workingtree.
1146
The revision tree will be used for cases where accelerator_tree's
1147
content is different.
1148
:param hardlink: If true, hard-link files from accelerator_tree,
1150
:return: The tree of the created checkout
1152
t = transport.get_transport(to_location)
1155
format = self._get_checkout_format()
1156
checkout = format.initialize_on_transport(t)
1157
from_branch = BranchReferenceFormat().initialize(checkout, self)
1159
format = self._get_checkout_format()
1160
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1161
to_location, force_new_tree=False, format=format)
1162
checkout = checkout_branch.bzrdir
1163
checkout_branch.bind(self)
1164
# pull up to the specified revision_id to set the initial
1165
# branch tip correctly, and seed it with history.
1166
checkout_branch.pull(self, stop_revision=revision_id)
1168
tree = checkout.create_workingtree(revision_id,
1169
from_branch=from_branch,
1170
accelerator_tree=accelerator_tree,
1172
basis_tree = tree.basis_tree()
1173
basis_tree.lock_read()
1175
for path, file_id in basis_tree.iter_references():
1176
reference_parent = self.reference_parent(file_id, path)
1177
reference_parent.create_checkout(tree.abspath(path),
1178
basis_tree.get_reference_revision(file_id, path),
1185
def reconcile(self, thorough=True):
1186
"""Make sure the data stored in this branch is consistent."""
1187
from bzrlib.reconcile import BranchReconciler
1188
reconciler = BranchReconciler(self, thorough=thorough)
1189
reconciler.reconcile()
1192
def reference_parent(self, file_id, path):
1193
"""Return the parent branch for a tree-reference file_id
1194
:param file_id: The file_id of the tree reference
1195
:param path: The path of the file_id in the tree
1196
:return: A branch associated with the file_id
1198
# FIXME should provide multiple branches, based on config
1199
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1201
def supports_tags(self):
1202
return self._format.supports_tags()
1204
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1206
"""Ensure that revision_b is a descendant of revision_a.
1208
This is a helper function for update_revisions.
1210
:raises: DivergedBranches if revision_b has diverged from revision_a.
1211
:returns: True if revision_b is a descendant of revision_a.
1213
relation = self._revision_relations(revision_a, revision_b, graph)
1214
if relation == 'b_descends_from_a':
1216
elif relation == 'diverged':
1217
raise errors.DivergedBranches(self, other_branch)
1218
elif relation == 'a_descends_from_b':
1221
raise AssertionError("invalid relation: %r" % (relation,))
1223
def _revision_relations(self, revision_a, revision_b, graph):
1224
"""Determine the relationship between two revisions.
1226
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1228
heads = graph.heads([revision_a, revision_b])
1229
if heads == set([revision_b]):
1230
return 'b_descends_from_a'
1231
elif heads == set([revision_a, revision_b]):
1232
# These branches have diverged
1234
elif heads == set([revision_a]):
1235
return 'a_descends_from_b'
1237
raise AssertionError("invalid heads: %r" % (heads,))
1240
class BranchFormat(object):
1241
"""An encapsulation of the initialization and open routines for a format.
1243
Formats provide three things:
1244
* An initialization routine,
1248
Formats are placed in an dict by their format string for reference
1249
during branch opening. Its not required that these be instances, they
1250
can be classes themselves with class methods - it simply depends on
1251
whether state is needed for a given format or not.
1253
Once a format is deprecated, just deprecate the initialize and open
1254
methods on the format class. Do not deprecate the object, as the
1255
object will be created every time regardless.
1258
_default_format = None
1259
"""The default format used for new branches."""
1262
"""The known formats."""
1264
def __eq__(self, other):
1265
return self.__class__ is other.__class__
1267
def __ne__(self, other):
1268
return not (self == other)
1271
def find_format(klass, a_bzrdir):
1272
"""Return the format for the branch object in a_bzrdir."""
1274
transport = a_bzrdir.get_branch_transport(None)
1275
format_string = transport.get("format").read()
1276
return klass._formats[format_string]
1277
except errors.NoSuchFile:
1278
raise errors.NotBranchError(path=transport.base)
1280
raise errors.UnknownFormatError(format=format_string, kind='branch')
1283
def get_default_format(klass):
1284
"""Return the current default format."""
1285
return klass._default_format
1287
def get_reference(self, a_bzrdir):
1288
"""Get the target reference of the branch in a_bzrdir.
1290
format probing must have been completed before calling
1291
this method - it is assumed that the format of the branch
1292
in a_bzrdir is correct.
1294
:param a_bzrdir: The bzrdir to get the branch data from.
1295
:return: None if the branch is not a reference branch.
1300
def set_reference(self, a_bzrdir, to_branch):
1301
"""Set the target reference of the branch in a_bzrdir.
1303
format probing must have been completed before calling
1304
this method - it is assumed that the format of the branch
1305
in a_bzrdir is correct.
1307
:param a_bzrdir: The bzrdir to set the branch reference for.
1308
:param to_branch: branch that the checkout is to reference
1310
raise NotImplementedError(self.set_reference)
1312
def get_format_string(self):
1313
"""Return the ASCII format string that identifies this format."""
1314
raise NotImplementedError(self.get_format_string)
1316
def get_format_description(self):
1317
"""Return the short format description for this format."""
1318
raise NotImplementedError(self.get_format_description)
1320
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1322
"""Initialize a branch in a bzrdir, with specified files
1324
:param a_bzrdir: The bzrdir to initialize the branch in
1325
:param utf8_files: The files to create as a list of
1326
(filename, content) tuples
1327
:param set_format: If True, set the format with
1328
self.get_format_string. (BzrBranch4 has its format set
1330
:return: a branch in this format
1332
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1333
branch_transport = a_bzrdir.get_branch_transport(self)
1335
'metadir': ('lock', lockdir.LockDir),
1336
'branch4': ('branch-lock', lockable_files.TransportLock),
1338
lock_name, lock_class = lock_map[lock_type]
1339
control_files = lockable_files.LockableFiles(branch_transport,
1340
lock_name, lock_class)
1341
control_files.create_lock()
1342
control_files.lock_write()
1344
utf8_files += [('format', self.get_format_string())]
1346
for (filename, content) in utf8_files:
1347
branch_transport.put_bytes(
1349
mode=a_bzrdir._get_file_mode())
1351
control_files.unlock()
1352
return self.open(a_bzrdir, _found=True)
1354
def initialize(self, a_bzrdir):
1355
"""Create a branch of this format in a_bzrdir."""
1356
raise NotImplementedError(self.initialize)
1358
def is_supported(self):
1359
"""Is this format supported?
1361
Supported formats can be initialized and opened.
1362
Unsupported formats may not support initialization or committing or
1363
some other features depending on the reason for not being supported.
1367
def make_tags(self, branch):
1368
"""Create a tags object for branch.
1370
This method is on BranchFormat, because BranchFormats are reflected
1371
over the wire via network_name(), whereas full Branch instances require
1372
multiple VFS method calls to operate at all.
1374
The default implementation returns a disabled-tags instance.
1376
Note that it is normal for branch to be a RemoteBranch when using tags
1379
return DisabledTags(branch)
1381
def network_name(self):
1382
"""A simple byte string uniquely identifying this format for RPC calls.
1384
MetaDir branch formats use their disk format string to identify the
1385
repository over the wire. All in one formats such as bzr < 0.8, and
1386
foreign formats like svn/git and hg should use some marker which is
1387
unique and immutable.
1389
raise NotImplementedError(self.network_name)
1391
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1392
"""Return the branch object for a_bzrdir
1394
:param a_bzrdir: A BzrDir that contains a branch.
1395
:param _found: a private parameter, do not use it. It is used to
1396
indicate if format probing has already be done.
1397
:param ignore_fallbacks: when set, no fallback branches will be opened
1398
(if there are any). Default is to open fallbacks.
1400
raise NotImplementedError(self.open)
1403
def register_format(klass, format):
1404
"""Register a metadir format."""
1405
klass._formats[format.get_format_string()] = format
1406
# Metadir formats have a network name of their format string, and get
1407
# registered as class factories.
1408
network_format_registry.register(format.get_format_string(), format.__class__)
1411
def set_default_format(klass, format):
1412
klass._default_format = format
1414
def supports_stacking(self):
1415
"""True if this format records a stacked-on branch."""
1419
def unregister_format(klass, format):
1420
del klass._formats[format.get_format_string()]
1423
return self.get_format_description().rstrip()
1425
def supports_tags(self):
1426
"""True if this format supports tags stored in the branch"""
1427
return False # by default
1430
class BranchHooks(Hooks):
1431
"""A dictionary mapping hook name to a list of callables for branch hooks.
1433
e.g. ['set_rh'] Is the list of items to be called when the
1434
set_revision_history function is invoked.
1438
"""Create the default hooks.
1440
These are all empty initially, because by default nothing should get
1443
Hooks.__init__(self)
1444
self.create_hook(HookPoint('set_rh',
1445
"Invoked whenever the revision history has been set via "
1446
"set_revision_history. The api signature is (branch, "
1447
"revision_history), and the branch will be write-locked. "
1448
"The set_rh hook can be expensive for bzr to trigger, a better "
1449
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1450
self.create_hook(HookPoint('open',
1451
"Called with the Branch object that has been opened after a "
1452
"branch is opened.", (1, 8), None))
1453
self.create_hook(HookPoint('post_push',
1454
"Called after a push operation completes. post_push is called "
1455
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1456
"bzr client.", (0, 15), None))
1457
self.create_hook(HookPoint('post_pull',
1458
"Called after a pull operation completes. post_pull is called "
1459
"with a bzrlib.branch.PullResult object and only runs in the "
1460
"bzr client.", (0, 15), None))
1461
self.create_hook(HookPoint('pre_commit',
1462
"Called after a commit is calculated but before it is is "
1463
"completed. pre_commit is called with (local, master, old_revno, "
1464
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1465
"). old_revid is NULL_REVISION for the first commit to a branch, "
1466
"tree_delta is a TreeDelta object describing changes from the "
1467
"basis revision. hooks MUST NOT modify this delta. "
1468
" future_tree is an in-memory tree obtained from "
1469
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1470
"tree.", (0,91), None))
1471
self.create_hook(HookPoint('post_commit',
1472
"Called in the bzr client after a commit has completed. "
1473
"post_commit is called with (local, master, old_revno, old_revid, "
1474
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1475
"commit to a branch.", (0, 15), None))
1476
self.create_hook(HookPoint('post_uncommit',
1477
"Called in the bzr client after an uncommit completes. "
1478
"post_uncommit is called with (local, master, old_revno, "
1479
"old_revid, new_revno, new_revid) where local is the local branch "
1480
"or None, master is the target branch, and an empty branch "
1481
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1482
self.create_hook(HookPoint('pre_change_branch_tip',
1483
"Called in bzr client and server before a change to the tip of a "
1484
"branch is made. pre_change_branch_tip is called with a "
1485
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1486
"commit, uncommit will all trigger this hook.", (1, 6), None))
1487
self.create_hook(HookPoint('post_change_branch_tip',
1488
"Called in bzr client and server after a change to the tip of a "
1489
"branch is made. post_change_branch_tip is called with a "
1490
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1491
"commit, uncommit will all trigger this hook.", (1, 4), None))
1492
self.create_hook(HookPoint('transform_fallback_location',
1493
"Called when a stacked branch is activating its fallback "
1494
"locations. transform_fallback_location is called with (branch, "
1495
"url), and should return a new url. Returning the same url "
1496
"allows it to be used as-is, returning a different one can be "
1497
"used to cause the branch to stack on a closer copy of that "
1498
"fallback_location. Note that the branch cannot have history "
1499
"accessing methods called on it during this hook because the "
1500
"fallback locations have not been activated. When there are "
1501
"multiple hooks installed for transform_fallback_location, "
1502
"all are called with the url returned from the previous hook."
1503
"The order is however undefined.", (1, 9), None))
1506
# install the default hooks into the Branch class.
1507
Branch.hooks = BranchHooks()
1510
class ChangeBranchTipParams(object):
1511
"""Object holding parameters passed to *_change_branch_tip hooks.
1513
There are 5 fields that hooks may wish to access:
1515
:ivar branch: the branch being changed
1516
:ivar old_revno: revision number before the change
1517
:ivar new_revno: revision number after the change
1518
:ivar old_revid: revision id before the change
1519
:ivar new_revid: revision id after the change
1521
The revid fields are strings. The revno fields are integers.
1524
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1525
"""Create a group of ChangeBranchTip parameters.
1527
:param branch: The branch being changed.
1528
:param old_revno: Revision number before the change.
1529
:param new_revno: Revision number after the change.
1530
:param old_revid: Tip revision id before the change.
1531
:param new_revid: Tip revision id after the change.
1533
self.branch = branch
1534
self.old_revno = old_revno
1535
self.new_revno = new_revno
1536
self.old_revid = old_revid
1537
self.new_revid = new_revid
1539
def __eq__(self, other):
1540
return self.__dict__ == other.__dict__
1543
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1544
self.__class__.__name__, self.branch,
1545
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1548
class BzrBranchFormat4(BranchFormat):
1549
"""Bzr branch format 4.
1552
- a revision-history file.
1553
- a branch-lock lock file [ to be shared with the bzrdir ]
1556
def get_format_description(self):
1557
"""See BranchFormat.get_format_description()."""
1558
return "Branch format 4"
1560
def initialize(self, a_bzrdir):
1561
"""Create a branch of this format in a_bzrdir."""
1562
utf8_files = [('revision-history', ''),
1563
('branch-name', ''),
1565
return self._initialize_helper(a_bzrdir, utf8_files,
1566
lock_type='branch4', set_format=False)
1569
super(BzrBranchFormat4, self).__init__()
1570
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1572
def network_name(self):
1573
"""The network name for this format is the control dirs disk label."""
1574
return self._matchingbzrdir.get_format_string()
1576
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1577
"""See BranchFormat.open()."""
1579
# we are being called directly and must probe.
1580
raise NotImplementedError
1581
return BzrBranch(_format=self,
1582
_control_files=a_bzrdir._control_files,
1584
_repository=a_bzrdir.open_repository())
1587
return "Bazaar-NG branch format 4"
1590
class BranchFormatMetadir(BranchFormat):
1591
"""Common logic for meta-dir based branch formats."""
1593
def _branch_class(self):
1594
"""What class to instantiate on open calls."""
1595
raise NotImplementedError(self._branch_class)
1597
def network_name(self):
1598
"""A simple byte string uniquely identifying this format for RPC calls.
1600
Metadir branch formats use their format string.
1602
return self.get_format_string()
1604
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1605
"""See BranchFormat.open()."""
1607
format = BranchFormat.find_format(a_bzrdir)
1608
if format.__class__ != self.__class__:
1609
raise AssertionError("wrong format %r found for %r" %
1612
transport = a_bzrdir.get_branch_transport(None)
1613
control_files = lockable_files.LockableFiles(transport, 'lock',
1615
return self._branch_class()(_format=self,
1616
_control_files=control_files,
1618
_repository=a_bzrdir.find_repository(),
1619
ignore_fallbacks=ignore_fallbacks)
1620
except errors.NoSuchFile:
1621
raise errors.NotBranchError(path=transport.base)
1624
super(BranchFormatMetadir, self).__init__()
1625
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1626
self._matchingbzrdir.set_branch_format(self)
1628
def supports_tags(self):
1632
class BzrBranchFormat5(BranchFormatMetadir):
1633
"""Bzr branch format 5.
1636
- a revision-history file.
1638
- a lock dir guarding the branch itself
1639
- all of this stored in a branch/ subdirectory
1640
- works with shared repositories.
1642
This format is new in bzr 0.8.
1645
def _branch_class(self):
1648
def get_format_string(self):
1649
"""See BranchFormat.get_format_string()."""
1650
return "Bazaar-NG branch format 5\n"
1652
def get_format_description(self):
1653
"""See BranchFormat.get_format_description()."""
1654
return "Branch format 5"
1656
def initialize(self, a_bzrdir):
1657
"""Create a branch of this format in a_bzrdir."""
1658
utf8_files = [('revision-history', ''),
1659
('branch-name', ''),
1661
return self._initialize_helper(a_bzrdir, utf8_files)
1663
def supports_tags(self):
1667
class BzrBranchFormat6(BranchFormatMetadir):
1668
"""Branch format with last-revision and tags.
1670
Unlike previous formats, this has no explicit revision history. Instead,
1671
this just stores the last-revision, and the left-hand history leading
1672
up to there is the history.
1674
This format was introduced in bzr 0.15
1675
and became the default in 0.91.
1678
def _branch_class(self):
1681
def get_format_string(self):
1682
"""See BranchFormat.get_format_string()."""
1683
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1685
def get_format_description(self):
1686
"""See BranchFormat.get_format_description()."""
1687
return "Branch format 6"
1689
def initialize(self, a_bzrdir):
1690
"""Create a branch of this format in a_bzrdir."""
1691
utf8_files = [('last-revision', '0 null:\n'),
1692
('branch.conf', ''),
1695
return self._initialize_helper(a_bzrdir, utf8_files)
1697
def make_tags(self, branch):
1698
"""See bzrlib.branch.BranchFormat.make_tags()."""
1699
return BasicTags(branch)
1703
class BzrBranchFormat7(BranchFormatMetadir):
1704
"""Branch format with last-revision, tags, and a stacked location pointer.
1706
The stacked location pointer is passed down to the repository and requires
1707
a repository format with supports_external_lookups = True.
1709
This format was introduced in bzr 1.6.
1712
def _branch_class(self):
1715
def get_format_string(self):
1716
"""See BranchFormat.get_format_string()."""
1717
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1719
def get_format_description(self):
1720
"""See BranchFormat.get_format_description()."""
1721
return "Branch format 7"
1723
def initialize(self, a_bzrdir):
1724
"""Create a branch of this format in a_bzrdir."""
1725
utf8_files = [('last-revision', '0 null:\n'),
1726
('branch.conf', ''),
1729
return self._initialize_helper(a_bzrdir, utf8_files)
1732
super(BzrBranchFormat7, self).__init__()
1733
self._matchingbzrdir.repository_format = \
1734
RepositoryFormatKnitPack5RichRoot()
1736
def make_tags(self, branch):
1737
"""See bzrlib.branch.BranchFormat.make_tags()."""
1738
return BasicTags(branch)
1740
def supports_stacking(self):
1744
class BranchReferenceFormat(BranchFormat):
1745
"""Bzr branch reference format.
1747
Branch references are used in implementing checkouts, they
1748
act as an alias to the real branch which is at some other url.
1755
def get_format_string(self):
1756
"""See BranchFormat.get_format_string()."""
1757
return "Bazaar-NG Branch Reference Format 1\n"
1759
def get_format_description(self):
1760
"""See BranchFormat.get_format_description()."""
1761
return "Checkout reference format 1"
1763
def get_reference(self, a_bzrdir):
1764
"""See BranchFormat.get_reference()."""
1765
transport = a_bzrdir.get_branch_transport(None)
1766
return transport.get('location').read()
1768
def set_reference(self, a_bzrdir, to_branch):
1769
"""See BranchFormat.set_reference()."""
1770
transport = a_bzrdir.get_branch_transport(None)
1771
location = transport.put_bytes('location', to_branch.base)
1773
def initialize(self, a_bzrdir, target_branch=None):
1774
"""Create a branch of this format in a_bzrdir."""
1775
if target_branch is None:
1776
# this format does not implement branch itself, thus the implicit
1777
# creation contract must see it as uninitializable
1778
raise errors.UninitializableFormat(self)
1779
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1780
branch_transport = a_bzrdir.get_branch_transport(self)
1781
branch_transport.put_bytes('location',
1782
target_branch.bzrdir.root_transport.base)
1783
branch_transport.put_bytes('format', self.get_format_string())
1785
a_bzrdir, _found=True,
1786
possible_transports=[target_branch.bzrdir.root_transport])
1789
super(BranchReferenceFormat, self).__init__()
1790
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1791
self._matchingbzrdir.set_branch_format(self)
1793
def _make_reference_clone_function(format, a_branch):
1794
"""Create a clone() routine for a branch dynamically."""
1795
def clone(to_bzrdir, revision_id=None,
1796
repository_policy=None):
1797
"""See Branch.clone()."""
1798
return format.initialize(to_bzrdir, a_branch)
1799
# cannot obey revision_id limits when cloning a reference ...
1800
# FIXME RBC 20060210 either nuke revision_id for clone, or
1801
# emit some sort of warning/error to the caller ?!
1804
def open(self, a_bzrdir, _found=False, location=None,
1805
possible_transports=None, ignore_fallbacks=False):
1806
"""Return the branch that the branch reference in a_bzrdir points at.
1808
:param a_bzrdir: A BzrDir that contains a branch.
1809
:param _found: a private parameter, do not use it. It is used to
1810
indicate if format probing has already be done.
1811
:param ignore_fallbacks: when set, no fallback branches will be opened
1812
(if there are any). Default is to open fallbacks.
1813
:param location: The location of the referenced branch. If
1814
unspecified, this will be determined from the branch reference in
1816
:param possible_transports: An optional reusable transports list.
1819
format = BranchFormat.find_format(a_bzrdir)
1820
if format.__class__ != self.__class__:
1821
raise AssertionError("wrong format %r found for %r" %
1823
if location is None:
1824
location = self.get_reference(a_bzrdir)
1825
real_bzrdir = bzrdir.BzrDir.open(
1826
location, possible_transports=possible_transports)
1827
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1828
# this changes the behaviour of result.clone to create a new reference
1829
# rather than a copy of the content of the branch.
1830
# I did not use a proxy object because that needs much more extensive
1831
# testing, and we are only changing one behaviour at the moment.
1832
# If we decide to alter more behaviours - i.e. the implicit nickname
1833
# then this should be refactored to introduce a tested proxy branch
1834
# and a subclass of that for use in overriding clone() and ....
1836
result.clone = self._make_reference_clone_function(result)
1840
network_format_registry = registry.FormatRegistry()
1841
"""Registry of formats indexed by their network name.
1843
The network name for a branch format is an identifier that can be used when
1844
referring to formats with smart server operations. See
1845
BranchFormat.network_name() for more detail.
1849
# formats which have no format string are not discoverable
1850
# and not independently creatable, so are not registered.
1851
__format5 = BzrBranchFormat5()
1852
__format6 = BzrBranchFormat6()
1853
__format7 = BzrBranchFormat7()
1854
BranchFormat.register_format(__format5)
1855
BranchFormat.register_format(BranchReferenceFormat())
1856
BranchFormat.register_format(__format6)
1857
BranchFormat.register_format(__format7)
1858
BranchFormat.set_default_format(__format6)
1859
_legacy_formats = [BzrBranchFormat4(),
1861
network_format_registry.register(
1862
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1865
class BzrBranch(Branch):
1866
"""A branch stored in the actual filesystem.
1868
Note that it's "local" in the context of the filesystem; it doesn't
1869
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1870
it's writable, and can be accessed via the normal filesystem API.
1872
:ivar _transport: Transport for file operations on this branch's
1873
control files, typically pointing to the .bzr/branch directory.
1874
:ivar repository: Repository for this branch.
1875
:ivar base: The url of the base directory for this branch; the one
1876
containing the .bzr directory.
1879
def __init__(self, _format=None,
1880
_control_files=None, a_bzrdir=None, _repository=None,
1881
ignore_fallbacks=False):
1882
"""Create new branch object at a particular location."""
1883
if a_bzrdir is None:
1884
raise ValueError('a_bzrdir must be supplied')
1886
self.bzrdir = a_bzrdir
1887
self._base = self.bzrdir.transport.clone('..').base
1888
# XXX: We should be able to just do
1889
# self.base = self.bzrdir.root_transport.base
1890
# but this does not quite work yet -- mbp 20080522
1891
self._format = _format
1892
if _control_files is None:
1893
raise ValueError('BzrBranch _control_files is None')
1894
self.control_files = _control_files
1895
self._transport = _control_files._transport
1896
self.repository = _repository
1897
Branch.__init__(self)
1900
return '%s(%r)' % (self.__class__.__name__, self.base)
1904
def _get_base(self):
1905
"""Returns the directory containing the control directory."""
1908
base = property(_get_base, doc="The URL for the root of this branch.")
1910
def _get_config(self):
1911
return TransportConfig(self._transport, 'branch.conf')
1913
def is_locked(self):
1914
return self.control_files.is_locked()
1916
def lock_write(self, token=None):
1917
repo_token = self.repository.lock_write()
1919
token = self.control_files.lock_write(token=token)
1921
self.repository.unlock()
1925
def lock_read(self):
1926
self.repository.lock_read()
1928
self.control_files.lock_read()
1930
self.repository.unlock()
1934
# TODO: test for failed two phase locks. This is known broken.
1936
self.control_files.unlock()
1938
self.repository.unlock()
1939
if not self.control_files.is_locked():
1940
# we just released the lock
1941
self._clear_cached_state()
1943
def peek_lock_mode(self):
1944
if self.control_files._lock_count == 0:
1947
return self.control_files._lock_mode
1949
def get_physical_lock_status(self):
1950
return self.control_files.get_physical_lock_status()
1953
def print_file(self, file, revision_id):
1954
"""See Branch.print_file."""
1955
return self.repository.print_file(file, revision_id)
1957
def _write_revision_history(self, history):
1958
"""Factored out of set_revision_history.
1960
This performs the actual writing to disk.
1961
It is intended to be called by BzrBranch5.set_revision_history."""
1962
self._transport.put_bytes(
1963
'revision-history', '\n'.join(history),
1964
mode=self.bzrdir._get_file_mode())
1967
def set_revision_history(self, rev_history):
1968
"""See Branch.set_revision_history."""
1969
if 'evil' in debug.debug_flags:
1970
mutter_callsite(3, "set_revision_history scales with history.")
1971
check_not_reserved_id = _mod_revision.check_not_reserved_id
1972
for rev_id in rev_history:
1973
check_not_reserved_id(rev_id)
1974
if Branch.hooks['post_change_branch_tip']:
1975
# Don't calculate the last_revision_info() if there are no hooks
1977
old_revno, old_revid = self.last_revision_info()
1978
if len(rev_history) == 0:
1979
revid = _mod_revision.NULL_REVISION
1981
revid = rev_history[-1]
1982
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1983
self._write_revision_history(rev_history)
1984
self._clear_cached_state()
1985
self._cache_revision_history(rev_history)
1986
for hook in Branch.hooks['set_rh']:
1987
hook(self, rev_history)
1988
if Branch.hooks['post_change_branch_tip']:
1989
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1991
def _synchronize_history(self, destination, revision_id):
1992
"""Synchronize last revision and revision history between branches.
1994
This version is most efficient when the destination is also a
1995
BzrBranch5, but works for BzrBranch6 as long as the revision
1996
history is the true lefthand parent history, and all of the revisions
1997
are in the destination's repository. If not, set_revision_history
2000
:param destination: The branch to copy the history into
2001
:param revision_id: The revision-id to truncate history at. May
2002
be None to copy complete history.
2004
if not isinstance(destination._format, BzrBranchFormat5):
2005
super(BzrBranch, self)._synchronize_history(
2006
destination, revision_id)
2008
if revision_id == _mod_revision.NULL_REVISION:
2011
new_history = self.revision_history()
2012
if revision_id is not None and new_history != []:
2014
new_history = new_history[:new_history.index(revision_id) + 1]
2016
rev = self.repository.get_revision(revision_id)
2017
new_history = rev.get_history(self.repository)[1:]
2018
destination.set_revision_history(new_history)
2021
def set_last_revision_info(self, revno, revision_id):
2022
"""Set the last revision of this branch.
2024
The caller is responsible for checking that the revno is correct
2025
for this revision id.
2027
It may be possible to set the branch last revision to an id not
2028
present in the repository. However, branches can also be
2029
configured to check constraints on history, in which case this may not
2032
revision_id = _mod_revision.ensure_null(revision_id)
2033
# this old format stores the full history, but this api doesn't
2034
# provide it, so we must generate, and might as well check it's
2036
history = self._lefthand_history(revision_id)
2037
if len(history) != revno:
2038
raise AssertionError('%d != %d' % (len(history), revno))
2039
self.set_revision_history(history)
2041
def _gen_revision_history(self):
2042
history = self._transport.get_bytes('revision-history').split('\n')
2043
if history[-1:] == ['']:
2044
# There shouldn't be a trailing newline, but just in case.
2049
def generate_revision_history(self, revision_id, last_rev=None,
2051
"""Create a new revision history that will finish with revision_id.
2053
:param revision_id: the new tip to use.
2054
:param last_rev: The previous last_revision. If not None, then this
2055
must be a ancestory of revision_id, or DivergedBranches is raised.
2056
:param other_branch: The other branch that DivergedBranches should
2057
raise with respect to.
2059
self.set_revision_history(self._lefthand_history(revision_id,
2060
last_rev, other_branch))
2062
def basis_tree(self):
2063
"""See Branch.basis_tree."""
2064
return self.repository.revision_tree(self.last_revision())
2067
def pull(self, source, overwrite=False, stop_revision=None,
2068
_hook_master=None, run_hooks=True, possible_transports=None,
2069
_override_hook_target=None):
2072
:param _hook_master: Private parameter - set the branch to
2073
be supplied as the master to pull hooks.
2074
:param run_hooks: Private parameter - if false, this branch
2075
is being called because it's the master of the primary branch,
2076
so it should not run its hooks.
2077
:param _override_hook_target: Private parameter - set the branch to be
2078
supplied as the target_branch to pull hooks.
2080
result = PullResult()
2081
result.source_branch = source
2082
if _override_hook_target is None:
2083
result.target_branch = self
2085
result.target_branch = _override_hook_target
2088
# We assume that during 'pull' the local repository is closer than
2090
graph = self.repository.get_graph(source.repository)
2091
result.old_revno, result.old_revid = self.last_revision_info()
2092
self.update_revisions(source, stop_revision, overwrite=overwrite,
2094
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2095
result.new_revno, result.new_revid = self.last_revision_info()
2097
result.master_branch = _hook_master
2098
result.local_branch = result.target_branch
2100
result.master_branch = result.target_branch
2101
result.local_branch = None
2103
for hook in Branch.hooks['post_pull']:
2109
def _get_parent_location(self):
2110
_locs = ['parent', 'pull', 'x-pull']
2113
return self._transport.get_bytes(l).strip('\n')
2114
except errors.NoSuchFile:
2119
def push(self, target, overwrite=False, stop_revision=None,
2120
_override_hook_source_branch=None):
2123
This is the basic concrete implementation of push()
2125
:param _override_hook_source_branch: If specified, run
2126
the hooks passing this Branch as the source, rather than self.
2127
This is for use of RemoteBranch, where push is delegated to the
2128
underlying vfs-based Branch.
2130
# TODO: Public option to disable running hooks - should be trivial but
2132
return _run_with_write_locked_target(
2133
target, self._push_with_bound_branches, target, overwrite,
2135
_override_hook_source_branch=_override_hook_source_branch)
2137
def _push_with_bound_branches(self, target, overwrite,
2139
_override_hook_source_branch=None):
2140
"""Push from self into target, and into target's master if any.
2142
This is on the base BzrBranch class even though it doesn't support
2143
bound branches because the *target* might be bound.
2146
if _override_hook_source_branch:
2147
result.source_branch = _override_hook_source_branch
2148
for hook in Branch.hooks['post_push']:
2151
bound_location = target.get_bound_location()
2152
if bound_location and target.base != bound_location:
2153
# there is a master branch.
2155
# XXX: Why the second check? Is it even supported for a branch to
2156
# be bound to itself? -- mbp 20070507
2157
master_branch = target.get_master_branch()
2158
master_branch.lock_write()
2160
# push into the master from this branch.
2161
self._basic_push(master_branch, overwrite, stop_revision)
2162
# and push into the target branch from this. Note that we push from
2163
# this branch again, because its considered the highest bandwidth
2165
result = self._basic_push(target, overwrite, stop_revision)
2166
result.master_branch = master_branch
2167
result.local_branch = target
2171
master_branch.unlock()
2174
result = self._basic_push(target, overwrite, stop_revision)
2175
# TODO: Why set master_branch and local_branch if there's no
2176
# binding? Maybe cleaner to just leave them unset? -- mbp
2178
result.master_branch = target
2179
result.local_branch = None
2183
def _basic_push(self, target, overwrite, stop_revision):
2184
"""Basic implementation of push without bound branches or hooks.
2186
Must be called with self read locked and target write locked.
2188
result = BranchPushResult()
2189
result.source_branch = self
2190
result.target_branch = target
2191
result.old_revno, result.old_revid = target.last_revision_info()
2192
if result.old_revid != self.last_revision():
2193
# We assume that during 'push' this repository is closer than
2195
graph = self.repository.get_graph(target.repository)
2196
target.update_revisions(self, stop_revision, overwrite=overwrite,
2198
if self._push_should_merge_tags():
2199
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2200
result.new_revno, result.new_revid = target.last_revision_info()
2203
def get_stacked_on_url(self):
2204
raise errors.UnstackableBranchFormat(self._format, self.base)
2206
def set_push_location(self, location):
2207
"""See Branch.set_push_location."""
2208
self.get_config().set_user_option(
2209
'push_location', location,
2210
store=_mod_config.STORE_LOCATION_NORECURSE)
2212
def _set_parent_location(self, url):
2214
self._transport.delete('parent')
2216
self._transport.put_bytes('parent', url + '\n',
2217
mode=self.bzrdir._get_file_mode())
2220
class BzrBranch5(BzrBranch):
2221
"""A format 5 branch. This supports new features over plain branches.
2223
It has support for a master_branch which is the data for bound branches.
2227
def pull(self, source, overwrite=False, stop_revision=None,
2228
run_hooks=True, possible_transports=None,
2229
_override_hook_target=None):
2230
"""Pull from source into self, updating my master if any.
2232
:param run_hooks: Private parameter - if false, this branch
2233
is being called because it's the master of the primary branch,
2234
so it should not run its hooks.
2236
bound_location = self.get_bound_location()
2237
master_branch = None
2238
if bound_location and source.base != bound_location:
2239
# not pulling from master, so we need to update master.
2240
master_branch = self.get_master_branch(possible_transports)
2241
master_branch.lock_write()
2244
# pull from source into master.
2245
master_branch.pull(source, overwrite, stop_revision,
2247
return super(BzrBranch5, self).pull(source, overwrite,
2248
stop_revision, _hook_master=master_branch,
2249
run_hooks=run_hooks,
2250
_override_hook_target=_override_hook_target)
2253
master_branch.unlock()
2255
def get_bound_location(self):
2257
return self._transport.get_bytes('bound')[:-1]
2258
except errors.NoSuchFile:
2262
def get_master_branch(self, possible_transports=None):
2263
"""Return the branch we are bound to.
2265
:return: Either a Branch, or None
2267
This could memoise the branch, but if thats done
2268
it must be revalidated on each new lock.
2269
So for now we just don't memoise it.
2270
# RBC 20060304 review this decision.
2272
bound_loc = self.get_bound_location()
2276
return Branch.open(bound_loc,
2277
possible_transports=possible_transports)
2278
except (errors.NotBranchError, errors.ConnectionError), e:
2279
raise errors.BoundBranchConnectionFailure(
2283
def set_bound_location(self, location):
2284
"""Set the target where this branch is bound to.
2286
:param location: URL to the target branch
2289
self._transport.put_bytes('bound', location+'\n',
2290
mode=self.bzrdir._get_file_mode())
2293
self._transport.delete('bound')
2294
except errors.NoSuchFile:
2299
def bind(self, other):
2300
"""Bind this branch to the branch other.
2302
This does not push or pull data between the branches, though it does
2303
check for divergence to raise an error when the branches are not
2304
either the same, or one a prefix of the other. That behaviour may not
2305
be useful, so that check may be removed in future.
2307
:param other: The branch to bind to
2310
# TODO: jam 20051230 Consider checking if the target is bound
2311
# It is debatable whether you should be able to bind to
2312
# a branch which is itself bound.
2313
# Committing is obviously forbidden,
2314
# but binding itself may not be.
2315
# Since we *have* to check at commit time, we don't
2316
# *need* to check here
2318
# we want to raise diverged if:
2319
# last_rev is not in the other_last_rev history, AND
2320
# other_last_rev is not in our history, and do it without pulling
2322
self.set_bound_location(other.base)
2326
"""If bound, unbind"""
2327
return self.set_bound_location(None)
2330
def update(self, possible_transports=None):
2331
"""Synchronise this branch with the master branch if any.
2333
:return: None or the last_revision that was pivoted out during the
2336
master = self.get_master_branch(possible_transports)
2337
if master is not None:
2338
old_tip = _mod_revision.ensure_null(self.last_revision())
2339
self.pull(master, overwrite=True)
2340
if self.repository.get_graph().is_ancestor(old_tip,
2341
_mod_revision.ensure_null(self.last_revision())):
2347
class BzrBranch7(BzrBranch5):
2348
"""A branch with support for a fallback repository."""
2350
def _open_hook(self):
2351
if self._ignore_fallbacks:
2354
url = self.get_stacked_on_url()
2355
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2356
errors.UnstackableBranchFormat):
2359
for hook in Branch.hooks['transform_fallback_location']:
2360
url = hook(self, url)
2362
hook_name = Branch.hooks.get_hook_name(hook)
2363
raise AssertionError(
2364
"'transform_fallback_location' hook %s returned "
2365
"None, not a URL." % hook_name)
2366
self._activate_fallback_location(url)
2368
def __init__(self, *args, **kwargs):
2369
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2370
super(BzrBranch7, self).__init__(*args, **kwargs)
2371
self._last_revision_info_cache = None
2372
self._partial_revision_history_cache = []
2374
def _clear_cached_state(self):
2375
super(BzrBranch7, self)._clear_cached_state()
2376
self._last_revision_info_cache = None
2377
self._partial_revision_history_cache = []
2379
def _last_revision_info(self):
2380
revision_string = self._transport.get_bytes('last-revision')
2381
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2382
revision_id = cache_utf8.get_cached_utf8(revision_id)
2384
return revno, revision_id
2386
def _write_last_revision_info(self, revno, revision_id):
2387
"""Simply write out the revision id, with no checks.
2389
Use set_last_revision_info to perform this safely.
2391
Does not update the revision_history cache.
2392
Intended to be called by set_last_revision_info and
2393
_write_revision_history.
2395
revision_id = _mod_revision.ensure_null(revision_id)
2396
out_string = '%d %s\n' % (revno, revision_id)
2397
self._transport.put_bytes('last-revision', out_string,
2398
mode=self.bzrdir._get_file_mode())
2401
def set_last_revision_info(self, revno, revision_id):
2402
revision_id = _mod_revision.ensure_null(revision_id)
2403
old_revno, old_revid = self.last_revision_info()
2404
if self._get_append_revisions_only():
2405
self._check_history_violation(revision_id)
2406
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2407
self._write_last_revision_info(revno, revision_id)
2408
self._clear_cached_state()
2409
self._last_revision_info_cache = revno, revision_id
2410
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2412
def _synchronize_history(self, destination, revision_id):
2413
"""Synchronize last revision and revision history between branches.
2415
:see: Branch._synchronize_history
2417
# XXX: The base Branch has a fast implementation of this method based
2418
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2419
# that uses set_revision_history. This class inherits from BzrBranch5,
2420
# but wants the fast implementation, so it calls
2421
# Branch._synchronize_history directly.
2422
Branch._synchronize_history(self, destination, revision_id)
2424
def _check_history_violation(self, revision_id):
2425
last_revision = _mod_revision.ensure_null(self.last_revision())
2426
if _mod_revision.is_null(last_revision):
2428
if last_revision not in self._lefthand_history(revision_id):
2429
raise errors.AppendRevisionsOnlyViolation(self.base)
2431
def _gen_revision_history(self):
2432
"""Generate the revision history from last revision
2434
last_revno, last_revision = self.last_revision_info()
2435
self._extend_partial_history(stop_index=last_revno-1)
2436
return list(reversed(self._partial_revision_history_cache))
2438
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2439
"""Extend the partial history to include a given index
2441
If a stop_index is supplied, stop when that index has been reached.
2442
If a stop_revision is supplied, stop when that revision is
2443
encountered. Otherwise, stop when the beginning of history is
2446
:param stop_index: The index which should be present. When it is
2447
present, history extension will stop.
2448
:param revision_id: The revision id which should be present. When
2449
it is encountered, history extension will stop.
2451
repo = self.repository
2452
if len(self._partial_revision_history_cache) == 0:
2453
iterator = repo.iter_reverse_revision_history(self.last_revision())
2455
start_revision = self._partial_revision_history_cache[-1]
2456
iterator = repo.iter_reverse_revision_history(start_revision)
2457
#skip the last revision in the list
2458
next_revision = iterator.next()
2459
for revision_id in iterator:
2460
self._partial_revision_history_cache.append(revision_id)
2461
if (stop_index is not None and
2462
len(self._partial_revision_history_cache) > stop_index):
2464
if revision_id == stop_revision:
2467
def _write_revision_history(self, history):
2468
"""Factored out of set_revision_history.
2470
This performs the actual writing to disk, with format-specific checks.
2471
It is intended to be called by BzrBranch5.set_revision_history.
2473
if len(history) == 0:
2474
last_revision = 'null:'
2476
if history != self._lefthand_history(history[-1]):
2477
raise errors.NotLefthandHistory(history)
2478
last_revision = history[-1]
2479
if self._get_append_revisions_only():
2480
self._check_history_violation(last_revision)
2481
self._write_last_revision_info(len(history), last_revision)
2484
def _set_parent_location(self, url):
2485
"""Set the parent branch"""
2486
self._set_config_location('parent_location', url, make_relative=True)
2489
def _get_parent_location(self):
2490
"""Set the parent branch"""
2491
return self._get_config_location('parent_location')
2493
def set_push_location(self, location):
2494
"""See Branch.set_push_location."""
2495
self._set_config_location('push_location', location)
2497
def set_bound_location(self, location):
2498
"""See Branch.set_push_location."""
2500
config = self.get_config()
2501
if location is None:
2502
if config.get_user_option('bound') != 'True':
2505
config.set_user_option('bound', 'False', warn_masked=True)
2508
self._set_config_location('bound_location', location,
2510
config.set_user_option('bound', 'True', warn_masked=True)
2513
def _get_bound_location(self, bound):
2514
"""Return the bound location in the config file.
2516
Return None if the bound parameter does not match"""
2517
config = self.get_config()
2518
config_bound = (config.get_user_option('bound') == 'True')
2519
if config_bound != bound:
2521
return self._get_config_location('bound_location', config=config)
2523
def get_bound_location(self):
2524
"""See Branch.set_push_location."""
2525
return self._get_bound_location(True)
2527
def get_old_bound_location(self):
2528
"""See Branch.get_old_bound_location"""
2529
return self._get_bound_location(False)
2531
def get_stacked_on_url(self):
2532
# you can always ask for the URL; but you might not be able to use it
2533
# if the repo can't support stacking.
2534
## self._check_stackable_repo()
2535
stacked_url = self._get_config_location('stacked_on_location')
2536
if stacked_url is None:
2537
raise errors.NotStacked(self)
2540
def set_append_revisions_only(self, enabled):
2545
self.get_config().set_user_option('append_revisions_only', value,
2548
def _get_append_revisions_only(self):
2549
value = self.get_config().get_user_option('append_revisions_only')
2550
return value == 'True'
2553
def generate_revision_history(self, revision_id, last_rev=None,
2555
"""See BzrBranch5.generate_revision_history"""
2556
history = self._lefthand_history(revision_id, last_rev, other_branch)
2557
revno = len(history)
2558
self.set_last_revision_info(revno, revision_id)
2561
def get_rev_id(self, revno, history=None):
2562
"""Find the revision id of the specified revno."""
2564
return _mod_revision.NULL_REVISION
2566
last_revno, last_revision_id = self.last_revision_info()
2567
if revno <= 0 or revno > last_revno:
2568
raise errors.NoSuchRevision(self, revno)
2570
if history is not None:
2571
return history[revno - 1]
2573
index = last_revno - revno
2574
if len(self._partial_revision_history_cache) <= index:
2575
self._extend_partial_history(stop_index=index)
2576
if len(self._partial_revision_history_cache) > index:
2577
return self._partial_revision_history_cache[index]
2579
raise errors.NoSuchRevision(self, revno)
2582
def revision_id_to_revno(self, revision_id):
2583
"""Given a revision id, return its revno"""
2584
if _mod_revision.is_null(revision_id):
2587
index = self._partial_revision_history_cache.index(revision_id)
2589
self._extend_partial_history(stop_revision=revision_id)
2590
index = len(self._partial_revision_history_cache) - 1
2591
if self._partial_revision_history_cache[index] != revision_id:
2592
raise errors.NoSuchRevision(self, revision_id)
2593
return self.revno() - index
2596
class BzrBranch6(BzrBranch7):
2597
"""See BzrBranchFormat6 for the capabilities of this branch.
2599
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2603
def get_stacked_on_url(self):
2604
raise errors.UnstackableBranchFormat(self._format, self.base)
2607
######################################################################
2608
# results of operations
2611
class _Result(object):
2613
def _show_tag_conficts(self, to_file):
2614
if not getattr(self, 'tag_conflicts', None):
2616
to_file.write('Conflicting tags:\n')
2617
for name, value1, value2 in self.tag_conflicts:
2618
to_file.write(' %s\n' % (name, ))
2621
class PullResult(_Result):
2622
"""Result of a Branch.pull operation.
2624
:ivar old_revno: Revision number before pull.
2625
:ivar new_revno: Revision number after pull.
2626
:ivar old_revid: Tip revision id before pull.
2627
:ivar new_revid: Tip revision id after pull.
2628
:ivar source_branch: Source (local) branch object. (read locked)
2629
:ivar master_branch: Master branch of the target, or the target if no
2631
:ivar local_branch: target branch if there is a Master, else None
2632
:ivar target_branch: Target/destination branch object. (write locked)
2633
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2637
# DEPRECATED: pull used to return the change in revno
2638
return self.new_revno - self.old_revno
2640
def report(self, to_file):
2642
if self.old_revid == self.new_revid:
2643
to_file.write('No revisions to pull.\n')
2645
to_file.write('Now on revision %d.\n' % self.new_revno)
2646
self._show_tag_conficts(to_file)
2649
class BranchPushResult(_Result):
2650
"""Result of a Branch.push operation.
2652
:ivar old_revno: Revision number (eg 10) of the target before push.
2653
:ivar new_revno: Revision number (eg 12) of the target after push.
2654
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2656
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2658
:ivar source_branch: Source branch object that the push was from. This is
2659
read locked, and generally is a local (and thus low latency) branch.
2660
:ivar master_branch: If target is a bound branch, the master branch of
2661
target, or target itself. Always write locked.
2662
:ivar target_branch: The direct Branch where data is being sent (write
2664
:ivar local_branch: If the target is a bound branch this will be the
2665
target, otherwise it will be None.
2669
# DEPRECATED: push used to return the change in revno
2670
return self.new_revno - self.old_revno
2672
def report(self, to_file):
2673
"""Write a human-readable description of the result."""
2674
if self.old_revid == self.new_revid:
2675
note('No new revisions to push.')
2677
note('Pushed up to revision %d.' % self.new_revno)
2678
self._show_tag_conficts(to_file)
2681
class BranchCheckResult(object):
2682
"""Results of checking branch consistency.
2687
def __init__(self, branch):
2688
self.branch = branch
2690
def report_results(self, verbose):
2691
"""Report the check results via trace.note.
2693
:param verbose: Requests more detailed display of what was checked,
2696
note('checked branch %s format %s',
2698
self.branch._format)
2701
class Converter5to6(object):
2702
"""Perform an in-place upgrade of format 5 to format 6"""
2704
def convert(self, branch):
2705
# Data for 5 and 6 can peacefully coexist.
2706
format = BzrBranchFormat6()
2707
new_branch = format.open(branch.bzrdir, _found=True)
2709
# Copy source data into target
2710
new_branch._write_last_revision_info(*branch.last_revision_info())
2711
new_branch.set_parent(branch.get_parent())
2712
new_branch.set_bound_location(branch.get_bound_location())
2713
new_branch.set_push_location(branch.get_push_location())
2715
# New branch has no tags by default
2716
new_branch.tags._set_tag_dict({})
2718
# Copying done; now update target format
2719
new_branch._transport.put_bytes('format',
2720
format.get_format_string(),
2721
mode=new_branch.bzrdir._get_file_mode())
2723
# Clean up old files
2724
new_branch._transport.delete('revision-history')
2726
branch.set_parent(None)
2727
except errors.NoSuchFile:
2729
branch.set_bound_location(None)
2732
class Converter6to7(object):
2733
"""Perform an in-place upgrade of format 6 to format 7"""
2735
def convert(self, branch):
2736
format = BzrBranchFormat7()
2737
branch._set_config_location('stacked_on_location', '')
2738
# update target format
2739
branch._transport.put_bytes('format', format.get_format_string())
2743
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2744
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2747
_run_with_write_locked_target will attempt to release the lock it acquires.
2749
If an exception is raised by callable, then that exception *will* be
2750
propagated, even if the unlock attempt raises its own error. Thus
2751
_run_with_write_locked_target should be preferred to simply doing::
2755
return callable(*args, **kwargs)
2760
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2761
# should share code?
2764
result = callable(*args, **kwargs)
2766
exc_info = sys.exc_info()
2770
raise exc_info[0], exc_info[1], exc_info[2]
2776
class InterBranch(InterObject):
2777
"""This class represents operations taking place between two branches.
2779
Its instances have methods like pull() and push() and contain
2780
references to the source and target repositories these operations
2781
can be carried out on.
2785
"""The available optimised InterBranch types."""
2788
def _get_branch_formats_to_test():
2789
"""Return a tuple with the Branch formats to use when testing."""
2790
raise NotImplementedError(self._get_branch_formats_to_test)
2792
def update_revisions(self, stop_revision=None, overwrite=False,
2794
"""Pull in new perfect-fit revisions.
2796
:param stop_revision: Updated until the given revision
2797
:param overwrite: Always set the branch pointer, rather than checking
2798
to see if it is a proper descendant.
2799
:param graph: A Graph object that can be used to query history
2800
information. This can be None.
2803
raise NotImplementedError(self.update_revisions)
2806
class GenericInterBranch(InterBranch):
2807
"""InterBranch implementation that uses public Branch functions.
2811
def _get_branch_formats_to_test():
2812
return BranchFormat._default_format, BranchFormat._default_format
2814
def update_revisions(self, stop_revision=None, overwrite=False,
2816
"""See InterBranch.update_revisions()."""
2817
self.source.lock_read()
2819
other_revno, other_last_revision = self.source.last_revision_info()
2820
stop_revno = None # unknown
2821
if stop_revision is None:
2822
stop_revision = other_last_revision
2823
if _mod_revision.is_null(stop_revision):
2824
# if there are no commits, we're done.
2826
stop_revno = other_revno
2828
# what's the current last revision, before we fetch [and change it
2830
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2831
# we fetch here so that we don't process data twice in the common
2832
# case of having something to pull, and so that the check for
2833
# already merged can operate on the just fetched graph, which will
2834
# be cached in memory.
2835
self.target.fetch(self.source, stop_revision)
2836
# Check to see if one is an ancestor of the other
2839
graph = self.target.repository.get_graph()
2840
if self.target._check_if_descendant_or_diverged(
2841
stop_revision, last_rev, graph, self.source):
2842
# stop_revision is a descendant of last_rev, but we aren't
2843
# overwriting, so we're done.
2845
if stop_revno is None:
2847
graph = self.target.repository.get_graph()
2848
this_revno, this_last_revision = \
2849
self.target.last_revision_info()
2850
stop_revno = graph.find_distance_to_null(stop_revision,
2851
[(other_last_revision, other_revno),
2852
(this_last_revision, this_revno)])
2853
self.target.set_last_revision_info(stop_revno, stop_revision)
2855
self.source.unlock()
2858
def is_compatible(self, source, target):
2859
# GenericBranch uses the public API, so always compatible
2863
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
