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, lock_style):
103
"""Activate the branch/repository from url as a fallback repository."""
104
repo = self._get_fallback_repository(url)
105
if lock_style == 'write':
107
elif lock_style == 'read':
109
self.repository.add_fallback_repository(repo)
111
def break_lock(self):
112
"""Break a lock if one is present from another instance.
114
Uses the ui factory to ask for confirmation if the lock may be from
117
This will probe the repository for its lock as well.
119
self.control_files.break_lock()
120
self.repository.break_lock()
121
master = self.get_master_branch()
122
if master is not None:
125
def _check_stackable_repo(self):
126
if not self.repository._format.supports_external_lookups:
127
raise errors.UnstackableRepositoryFormat(self.repository._format,
128
self.repository.base)
131
def open(base, _unsupported=False, possible_transports=None):
132
"""Open the branch rooted at base.
134
For instance, if the branch is at URL/.bzr/branch,
135
Branch.open(URL) -> a Branch instance.
137
control = bzrdir.BzrDir.open(base, _unsupported,
138
possible_transports=possible_transports)
139
return control.open_branch(_unsupported)
142
def open_from_transport(transport, _unsupported=False):
143
"""Open the branch rooted at transport"""
144
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
145
return control.open_branch(_unsupported)
148
def open_containing(url, possible_transports=None):
149
"""Open an existing branch which contains url.
151
This probes for a branch at url, and searches upwards from there.
153
Basically we keep looking up until we find the control directory or
154
run into the root. If there isn't one, raises NotBranchError.
155
If there is one and it is either an unrecognised format or an unsupported
156
format, UnknownFormatError or UnsupportedFormatError are raised.
157
If there is one, it is returned, along with the unused portion of url.
159
control, relpath = bzrdir.BzrDir.open_containing(url,
161
return control.open_branch(), relpath
163
def _push_should_merge_tags(self):
164
"""Should _basic_push merge this branch's tags into the target?
166
The default implementation returns False if this branch has no tags,
167
and True the rest of the time. Subclasses may override this.
169
return self.supports_tags() and self.tags.get_tag_dict()
171
def get_config(self):
172
return BranchConfig(self)
174
def _get_config(self):
175
"""Get the concrete config for just the config in this branch.
177
This is not intended for client use; see Branch.get_config for the
182
:return: An object supporting get_option and set_option.
184
raise NotImplementedError(self._get_config)
186
def _get_fallback_repository(self, url):
187
"""Get the repository we fallback to at url."""
188
url = urlutils.join(self.base, url)
189
a_bzrdir = bzrdir.BzrDir.open(url,
190
possible_transports=[self.bzrdir.root_transport])
191
return a_bzrdir.open_branch().repository
193
def _get_tags_bytes(self):
194
"""Get the bytes of a serialised tags dict.
196
Note that not all branches support tags, nor do all use the same tags
197
logic: this method is specific to BasicTags. Other tag implementations
198
may use the same method name and behave differently, safely, because
199
of the double-dispatch via
200
format.make_tags->tags_instance->get_tags_dict.
202
:return: The bytes of the tags file.
203
:seealso: Branch._set_tags_bytes.
205
return self._transport.get_bytes('tags')
207
def _get_nick(self, local=False, possible_transports=None):
208
config = self.get_config()
209
# explicit overrides master, but don't look for master if local is True
210
if not local and not config.has_explicit_nickname():
212
master = self.get_master_branch(possible_transports)
213
if master is not None:
214
# return the master branch value
216
except errors.BzrError, e:
217
# Silently fall back to local implicit nick if the master is
219
mutter("Could not connect to bound branch, "
220
"falling back to local nick.\n " + str(e))
221
return config.get_nickname()
223
def _set_nick(self, nick):
224
self.get_config().set_user_option('nickname', nick, warn_masked=True)
226
nick = property(_get_nick, _set_nick)
229
raise NotImplementedError(self.is_locked)
231
def _lefthand_history(self, revision_id, last_rev=None,
233
if 'evil' in debug.debug_flags:
234
mutter_callsite(4, "_lefthand_history scales with history.")
235
# stop_revision must be a descendant of last_revision
236
graph = self.repository.get_graph()
237
if last_rev is not None:
238
if not graph.is_ancestor(last_rev, revision_id):
239
# our previous tip is not merged into stop_revision
240
raise errors.DivergedBranches(self, other_branch)
241
# make a new revision history from the graph
242
parents_map = graph.get_parent_map([revision_id])
243
if revision_id not in parents_map:
244
raise errors.NoSuchRevision(self, revision_id)
245
current_rev_id = revision_id
247
check_not_reserved_id = _mod_revision.check_not_reserved_id
248
# Do not include ghosts or graph origin in revision_history
249
while (current_rev_id in parents_map and
250
len(parents_map[current_rev_id]) > 0):
251
check_not_reserved_id(current_rev_id)
252
new_history.append(current_rev_id)
253
current_rev_id = parents_map[current_rev_id][0]
254
parents_map = graph.get_parent_map([current_rev_id])
255
new_history.reverse()
258
def lock_write(self):
259
raise NotImplementedError(self.lock_write)
262
raise NotImplementedError(self.lock_read)
265
raise NotImplementedError(self.unlock)
267
def peek_lock_mode(self):
268
"""Return lock mode for the Branch: 'r', 'w' or None"""
269
raise NotImplementedError(self.peek_lock_mode)
271
def get_physical_lock_status(self):
272
raise NotImplementedError(self.get_physical_lock_status)
275
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
276
"""Return the revision_id for a dotted revno.
278
:param revno: a tuple like (1,) or (1,1,2)
279
:param _cache_reverse: a private parameter enabling storage
280
of the reverse mapping in a top level cache. (This should
281
only be done in selective circumstances as we want to
282
avoid having the mapping cached multiple times.)
283
:return: the revision_id
284
:raises errors.NoSuchRevision: if the revno doesn't exist
286
rev_id = self._do_dotted_revno_to_revision_id(revno)
288
self._partial_revision_id_to_revno_cache[rev_id] = revno
291
def _do_dotted_revno_to_revision_id(self, revno):
292
"""Worker function for dotted_revno_to_revision_id.
294
Subclasses should override this if they wish to
295
provide a more efficient implementation.
298
return self.get_rev_id(revno[0])
299
revision_id_to_revno = self.get_revision_id_to_revno_map()
300
revision_ids = [revision_id for revision_id, this_revno
301
in revision_id_to_revno.iteritems()
302
if revno == this_revno]
303
if len(revision_ids) == 1:
304
return revision_ids[0]
306
revno_str = '.'.join(map(str, revno))
307
raise errors.NoSuchRevision(self, revno_str)
310
def revision_id_to_dotted_revno(self, revision_id):
311
"""Given a revision id, return its dotted revno.
313
:return: a tuple like (1,) or (400,1,3).
315
return self._do_revision_id_to_dotted_revno(revision_id)
317
def _do_revision_id_to_dotted_revno(self, revision_id):
318
"""Worker function for revision_id_to_revno."""
319
# Try the caches if they are loaded
320
result = self._partial_revision_id_to_revno_cache.get(revision_id)
321
if result is not None:
323
if self._revision_id_to_revno_cache:
324
result = self._revision_id_to_revno_cache.get(revision_id)
326
raise errors.NoSuchRevision(self, revision_id)
327
# Try the mainline as it's optimised
329
revno = self.revision_id_to_revno(revision_id)
331
except errors.NoSuchRevision:
332
# We need to load and use the full revno map after all
333
result = self.get_revision_id_to_revno_map().get(revision_id)
335
raise errors.NoSuchRevision(self, revision_id)
339
def get_revision_id_to_revno_map(self):
340
"""Return the revision_id => dotted revno map.
342
This will be regenerated on demand, but will be cached.
344
:return: A dictionary mapping revision_id => dotted revno.
345
This dictionary should not be modified by the caller.
347
if self._revision_id_to_revno_cache is not None:
348
mapping = self._revision_id_to_revno_cache
350
mapping = self._gen_revno_map()
351
self._cache_revision_id_to_revno(mapping)
352
# TODO: jam 20070417 Since this is being cached, should we be returning
354
# I would rather not, and instead just declare that users should not
355
# modify the return value.
358
def _gen_revno_map(self):
359
"""Create a new mapping from revision ids to dotted revnos.
361
Dotted revnos are generated based on the current tip in the revision
363
This is the worker function for get_revision_id_to_revno_map, which
364
just caches the return value.
366
:return: A dictionary mapping revision_id => dotted revno.
368
revision_id_to_revno = dict((rev_id, revno)
369
for rev_id, depth, revno, end_of_merge
370
in self.iter_merge_sorted_revisions())
371
return revision_id_to_revno
374
def iter_merge_sorted_revisions(self, start_revision_id=None,
375
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
376
"""Walk the revisions for a branch in merge sorted order.
378
Merge sorted order is the output from a merge-aware,
379
topological sort, i.e. all parents come before their
380
children going forward; the opposite for reverse.
382
:param start_revision_id: the revision_id to begin walking from.
383
If None, the branch tip is used.
384
:param stop_revision_id: the revision_id to terminate the walk
385
after. If None, the rest of history is included.
386
:param stop_rule: if stop_revision_id is not None, the precise rule
387
to use for termination:
388
* 'exclude' - leave the stop revision out of the result (default)
389
* 'include' - the stop revision is the last item in the result
390
* 'with-merges' - include the stop revision and all of its
391
merged revisions in the result
392
:param direction: either 'reverse' or 'forward':
393
* reverse means return the start_revision_id first, i.e.
394
start at the most recent revision and go backwards in history
395
* forward returns tuples in the opposite order to reverse.
396
Note in particular that forward does *not* do any intelligent
397
ordering w.r.t. depth as some clients of this API may like.
398
(If required, that ought to be done at higher layers.)
400
:return: an iterator over (revision_id, depth, revno, end_of_merge)
403
* revision_id: the unique id of the revision
404
* depth: How many levels of merging deep this node has been
406
* revno_sequence: This field provides a sequence of
407
revision numbers for all revisions. The format is:
408
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
409
branch that the revno is on. From left to right the REVNO numbers
410
are the sequence numbers within that branch of the revision.
411
* end_of_merge: When True the next node (earlier in history) is
412
part of a different merge.
414
# Note: depth and revno values are in the context of the branch so
415
# we need the full graph to get stable numbers, regardless of the
417
if self._merge_sorted_revisions_cache is None:
418
last_revision = self.last_revision()
419
graph = self.repository.get_graph()
420
parent_map = dict(((key, value) for key, value in
421
graph.iter_ancestry([last_revision]) if value is not None))
422
revision_graph = repository._strip_NULL_ghosts(parent_map)
423
revs = tsort.merge_sort(revision_graph, last_revision, None,
425
# Drop the sequence # before caching
426
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
428
filtered = self._filter_merge_sorted_revisions(
429
self._merge_sorted_revisions_cache, start_revision_id,
430
stop_revision_id, stop_rule)
431
if direction == 'reverse':
433
if direction == 'forward':
434
return reversed(list(filtered))
436
raise ValueError('invalid direction %r' % direction)
438
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
439
start_revision_id, stop_revision_id, stop_rule):
440
"""Iterate over an inclusive range of sorted revisions."""
441
rev_iter = iter(merge_sorted_revisions)
442
if start_revision_id is not None:
443
for rev_id, depth, revno, end_of_merge in rev_iter:
444
if rev_id != start_revision_id:
447
# The decision to include the start or not
448
# depends on the stop_rule if a stop is provided
450
iter([(rev_id, depth, revno, end_of_merge)]),
453
if stop_revision_id is None:
454
for rev_id, depth, revno, end_of_merge in rev_iter:
455
yield rev_id, depth, revno, end_of_merge
456
elif stop_rule == 'exclude':
457
for rev_id, depth, revno, end_of_merge in rev_iter:
458
if rev_id == stop_revision_id:
460
yield rev_id, depth, revno, end_of_merge
461
elif stop_rule == 'include':
462
for rev_id, depth, revno, end_of_merge in rev_iter:
463
yield rev_id, depth, revno, end_of_merge
464
if rev_id == stop_revision_id:
466
elif stop_rule == 'with-merges':
467
stop_rev = self.repository.get_revision(stop_revision_id)
468
if stop_rev.parent_ids:
469
left_parent = stop_rev.parent_ids[0]
471
left_parent = _mod_revision.NULL_REVISION
472
for rev_id, depth, revno, end_of_merge in rev_iter:
473
if rev_id == left_parent:
475
yield rev_id, depth, revno, end_of_merge
477
raise ValueError('invalid stop_rule %r' % stop_rule)
479
def leave_lock_in_place(self):
480
"""Tell this branch object not to release the physical lock when this
483
If lock_write doesn't return a token, then this method is not supported.
485
self.control_files.leave_in_place()
487
def dont_leave_lock_in_place(self):
488
"""Tell this branch object to release the physical lock when this
489
object is unlocked, even if it didn't originally acquire it.
491
If lock_write doesn't return a token, then this method is not supported.
493
self.control_files.dont_leave_in_place()
495
def bind(self, other):
496
"""Bind the local branch the other branch.
498
:param other: The branch to bind to
501
raise errors.UpgradeRequired(self.base)
504
def fetch(self, from_branch, last_revision=None, pb=None):
505
"""Copy revisions from from_branch into this branch.
507
:param from_branch: Where to copy from.
508
:param last_revision: What revision to stop at (None for at the end
510
:param pb: An optional progress bar to use.
513
if self.base == from_branch.base:
516
symbol_versioning.warn(
517
symbol_versioning.deprecated_in((1, 14, 0))
518
% "pb parameter to fetch()")
519
from_branch.lock_read()
521
if last_revision is None:
522
last_revision = from_branch.last_revision()
523
last_revision = _mod_revision.ensure_null(last_revision)
524
return self.repository.fetch(from_branch.repository,
525
revision_id=last_revision,
530
def get_bound_location(self):
531
"""Return the URL of the branch we are bound to.
533
Older format branches cannot bind, please be sure to use a metadir
538
def get_old_bound_location(self):
539
"""Return the URL of the branch we used to be bound to
541
raise errors.UpgradeRequired(self.base)
543
def get_commit_builder(self, parents, config=None, timestamp=None,
544
timezone=None, committer=None, revprops=None,
546
"""Obtain a CommitBuilder for this branch.
548
:param parents: Revision ids of the parents of the new revision.
549
:param config: Optional configuration to use.
550
:param timestamp: Optional timestamp recorded for commit.
551
:param timezone: Optional timezone for timestamp.
552
:param committer: Optional committer to set for commit.
553
:param revprops: Optional dictionary of revision properties.
554
:param revision_id: Optional revision id.
558
config = self.get_config()
560
return self.repository.get_commit_builder(self, parents, config,
561
timestamp, timezone, committer, revprops, revision_id)
563
def get_master_branch(self, possible_transports=None):
564
"""Return the branch we are bound to.
566
:return: Either a Branch, or None
570
def get_revision_delta(self, revno):
571
"""Return the delta for one revision.
573
The delta is relative to its mainline predecessor, or the
574
empty tree for revision 1.
576
rh = self.revision_history()
577
if not (1 <= revno <= len(rh)):
578
raise errors.InvalidRevisionNumber(revno)
579
return self.repository.get_revision_delta(rh[revno-1])
581
def get_stacked_on_url(self):
582
"""Get the URL this branch is stacked against.
584
:raises NotStacked: If the branch is not stacked.
585
:raises UnstackableBranchFormat: If the branch does not support
588
raise NotImplementedError(self.get_stacked_on_url)
590
def print_file(self, file, revision_id):
591
"""Print `file` to stdout."""
592
raise NotImplementedError(self.print_file)
594
def set_revision_history(self, rev_history):
595
raise NotImplementedError(self.set_revision_history)
598
def set_parent(self, url):
599
"""See Branch.set_parent."""
600
# TODO: Maybe delete old location files?
601
# URLs should never be unicode, even on the local fs,
602
# FIXUP this and get_parent in a future branch format bump:
603
# read and rewrite the file. RBC 20060125
605
if isinstance(url, unicode):
607
url = url.encode('ascii')
608
except UnicodeEncodeError:
609
raise errors.InvalidURL(url,
610
"Urls must be 7-bit ascii, "
611
"use bzrlib.urlutils.escape")
612
url = urlutils.relative_url(self.base, url)
613
self._set_parent_location(url)
616
def set_stacked_on_url(self, url):
617
"""Set the URL this branch is stacked against.
619
:raises UnstackableBranchFormat: If the branch does not support
621
:raises UnstackableRepositoryFormat: If the repository does not support
624
if not self._format.supports_stacking():
625
raise errors.UnstackableBranchFormat(self._format, self.base)
626
self._check_stackable_repo()
629
old_url = self.get_stacked_on_url()
630
except (errors.NotStacked, errors.UnstackableBranchFormat,
631
errors.UnstackableRepositoryFormat):
634
# XXX: Lock correctness - should unlock our old repo if we were
636
# repositories don't offer an interface to remove fallback
637
# repositories today; take the conceptually simpler option and just
639
self.repository = self.bzrdir.find_repository()
640
self.repository.lock_write()
641
# for every revision reference the branch has, ensure it is pulled
643
source_repository = self._get_fallback_repository(old_url)
644
for revision_id in chain([self.last_revision()],
645
self.tags.get_reverse_tag_dict()):
646
self.repository.fetch(source_repository, revision_id,
649
self._activate_fallback_location(url, 'write')
650
# write this out after the repository is stacked to avoid setting a
651
# stacked config that doesn't work.
652
self._set_config_location('stacked_on_location', url)
655
def _set_tags_bytes(self, bytes):
656
"""Mirror method for _get_tags_bytes.
658
:seealso: Branch._get_tags_bytes.
660
return _run_with_write_locked_target(self, self._transport.put_bytes,
663
def _cache_revision_history(self, rev_history):
664
"""Set the cached revision history to rev_history.
666
The revision_history method will use this cache to avoid regenerating
667
the revision history.
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_history_cache = rev_history
674
def _cache_revision_id_to_revno(self, revision_id_to_revno):
675
"""Set the cached revision_id => revno map to revision_id_to_revno.
677
This API is semi-public; it only for use by subclasses, all other code
678
should consider it to be private.
680
self._revision_id_to_revno_cache = revision_id_to_revno
682
def _clear_cached_state(self):
683
"""Clear any cached data on this branch, e.g. cached revision history.
685
This means the next call to revision_history will need to call
686
_gen_revision_history.
688
This API is semi-public; it only for use by subclasses, all other code
689
should consider it to be private.
691
self._revision_history_cache = None
692
self._revision_id_to_revno_cache = None
693
self._last_revision_info_cache = None
694
self._merge_sorted_revisions_cache = None
696
def _gen_revision_history(self):
697
"""Return sequence of revision hashes on to this branch.
699
Unlike revision_history, this method always regenerates or rereads the
700
revision history, i.e. it does not cache the result, so repeated calls
703
Concrete subclasses should override this instead of revision_history so
704
that subclasses do not need to deal with caching logic.
706
This API is semi-public; it only for use by subclasses, all other code
707
should consider it to be private.
709
raise NotImplementedError(self._gen_revision_history)
712
def revision_history(self):
713
"""Return sequence of revision ids on this branch.
715
This method will cache the revision history for as long as it is safe to
718
if 'evil' in debug.debug_flags:
719
mutter_callsite(3, "revision_history scales with history.")
720
if self._revision_history_cache is not None:
721
history = self._revision_history_cache
723
history = self._gen_revision_history()
724
self._cache_revision_history(history)
728
"""Return current revision number for this branch.
730
That is equivalent to the number of revisions committed to
733
return self.last_revision_info()[0]
736
"""Older format branches cannot bind or unbind."""
737
raise errors.UpgradeRequired(self.base)
739
def set_append_revisions_only(self, enabled):
740
"""Older format branches are never restricted to append-only"""
741
raise errors.UpgradeRequired(self.base)
743
def last_revision(self):
744
"""Return last revision id, or NULL_REVISION."""
745
return self.last_revision_info()[1]
748
def last_revision_info(self):
749
"""Return information about the last revision.
751
:return: A tuple (revno, revision_id).
753
if self._last_revision_info_cache is None:
754
self._last_revision_info_cache = self._last_revision_info()
755
return self._last_revision_info_cache
757
def _last_revision_info(self):
758
rh = self.revision_history()
761
return (revno, rh[-1])
763
return (0, _mod_revision.NULL_REVISION)
765
@deprecated_method(deprecated_in((1, 6, 0)))
766
def missing_revisions(self, other, stop_revision=None):
767
"""Return a list of new revisions that would perfectly fit.
769
If self and other have not diverged, return a list of the revisions
770
present in other, but missing from self.
772
self_history = self.revision_history()
773
self_len = len(self_history)
774
other_history = other.revision_history()
775
other_len = len(other_history)
776
common_index = min(self_len, other_len) -1
777
if common_index >= 0 and \
778
self_history[common_index] != other_history[common_index]:
779
raise errors.DivergedBranches(self, other)
781
if stop_revision is None:
782
stop_revision = other_len
784
if stop_revision > other_len:
785
raise errors.NoSuchRevision(self, stop_revision)
786
return other_history[self_len:stop_revision]
789
def update_revisions(self, other, stop_revision=None, overwrite=False,
791
"""Pull in new perfect-fit revisions.
793
:param other: Another Branch to pull from
794
:param stop_revision: Updated until the given revision
795
:param overwrite: Always set the branch pointer, rather than checking
796
to see if it is a proper descendant.
797
:param graph: A Graph object that can be used to query history
798
information. This can be None.
801
return InterBranch.get(other, self).update_revisions(stop_revision,
804
def import_last_revision_info(self, source_repo, revno, revid):
805
"""Set the last revision info, importing from another repo if necessary.
807
This is used by the bound branch code to upload a revision to
808
the master branch first before updating the tip of the local branch.
810
:param source_repo: Source repository to optionally fetch from
811
:param revno: Revision number of the new tip
812
:param revid: Revision id of the new tip
814
if not self.repository.has_same_location(source_repo):
815
self.repository.fetch(source_repo, revision_id=revid)
816
self.set_last_revision_info(revno, revid)
818
def revision_id_to_revno(self, revision_id):
819
"""Given a revision id, return its revno"""
820
if _mod_revision.is_null(revision_id):
822
history = self.revision_history()
824
return history.index(revision_id) + 1
826
raise errors.NoSuchRevision(self, revision_id)
828
def get_rev_id(self, revno, history=None):
829
"""Find the revision id of the specified revno."""
831
return _mod_revision.NULL_REVISION
833
history = self.revision_history()
834
if revno <= 0 or revno > len(history):
835
raise errors.NoSuchRevision(self, revno)
836
return history[revno - 1]
838
def pull(self, source, overwrite=False, stop_revision=None,
839
possible_transports=None, _override_hook_target=None):
840
"""Mirror source into this branch.
842
This branch is considered to be 'local', having low latency.
844
:returns: PullResult instance
846
raise NotImplementedError(self.pull)
848
def push(self, target, overwrite=False, stop_revision=None):
849
"""Mirror this branch into target.
851
This branch is considered to be 'local', having low latency.
853
raise NotImplementedError(self.push)
855
def basis_tree(self):
856
"""Return `Tree` object for last revision."""
857
return self.repository.revision_tree(self.last_revision())
859
def get_parent(self):
860
"""Return the parent location of the branch.
862
This is the default location for pull/missing. The usual
863
pattern is that the user can override it by specifying a
866
parent = self._get_parent_location()
869
# This is an old-format absolute path to a local branch
871
if parent.startswith('/'):
872
parent = urlutils.local_path_to_url(parent.decode('utf8'))
874
return urlutils.join(self.base[:-1], parent)
875
except errors.InvalidURLJoin, e:
876
raise errors.InaccessibleParent(parent, self.base)
878
def _get_parent_location(self):
879
raise NotImplementedError(self._get_parent_location)
881
def _set_config_location(self, name, url, config=None,
882
make_relative=False):
884
config = self.get_config()
888
url = urlutils.relative_url(self.base, url)
889
config.set_user_option(name, url, warn_masked=True)
891
def _get_config_location(self, name, config=None):
893
config = self.get_config()
894
location = config.get_user_option(name)
899
def get_submit_branch(self):
900
"""Return the submit location of the branch.
902
This is the default location for bundle. The usual
903
pattern is that the user can override it by specifying a
906
return self.get_config().get_user_option('submit_branch')
908
def set_submit_branch(self, location):
909
"""Return the submit location of the branch.
911
This is the default location for bundle. The usual
912
pattern is that the user can override it by specifying a
915
self.get_config().set_user_option('submit_branch', location,
918
def get_public_branch(self):
919
"""Return the public location of the branch.
921
This is used by merge directives.
923
return self._get_config_location('public_branch')
925
def set_public_branch(self, location):
926
"""Return the submit location of the branch.
928
This is the default location for bundle. The usual
929
pattern is that the user can override it by specifying a
932
self._set_config_location('public_branch', location)
934
def get_push_location(self):
935
"""Return the None or the location to push this branch to."""
936
push_loc = self.get_config().get_user_option('push_location')
939
def set_push_location(self, location):
940
"""Set a new push location for this branch."""
941
raise NotImplementedError(self.set_push_location)
943
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
944
"""Run the post_change_branch_tip hooks."""
945
hooks = Branch.hooks['post_change_branch_tip']
948
new_revno, new_revid = self.last_revision_info()
949
params = ChangeBranchTipParams(
950
self, old_revno, new_revno, old_revid, new_revid)
954
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
955
"""Run the pre_change_branch_tip hooks."""
956
hooks = Branch.hooks['pre_change_branch_tip']
959
old_revno, old_revid = self.last_revision_info()
960
params = ChangeBranchTipParams(
961
self, old_revno, new_revno, old_revid, new_revid)
965
except errors.TipChangeRejected:
968
exc_info = sys.exc_info()
969
hook_name = Branch.hooks.get_hook_name(hook)
970
raise errors.HookFailed(
971
'pre_change_branch_tip', hook_name, exc_info)
975
"""Synchronise this branch with the master branch if any.
977
:return: None or the last_revision pivoted out during the update.
981
def check_revno(self, revno):
983
Check whether a revno corresponds to any revision.
984
Zero (the NULL revision) is considered valid.
987
self.check_real_revno(revno)
989
def check_real_revno(self, revno):
991
Check whether a revno corresponds to a real revision.
992
Zero (the NULL revision) is considered invalid
994
if revno < 1 or revno > self.revno():
995
raise errors.InvalidRevisionNumber(revno)
998
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
999
"""Clone this branch into to_bzrdir preserving all semantic values.
1001
Most API users will want 'create_clone_on_transport', which creates a
1002
new bzrdir and branch on the fly.
1004
revision_id: if not None, the revision history in the new branch will
1005
be truncated to end with revision_id.
1007
result = to_bzrdir.create_branch()
1010
if repository_policy is not None:
1011
repository_policy.configure_branch(result)
1012
self.copy_content_into(result, revision_id=revision_id)
1018
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1019
"""Create a new line of development from the branch, into to_bzrdir.
1021
to_bzrdir controls the branch format.
1023
revision_id: if not None, the revision history in the new branch will
1024
be truncated to end with revision_id.
1026
result = to_bzrdir.create_branch()
1029
if repository_policy is not None:
1030
repository_policy.configure_branch(result)
1031
self.copy_content_into(result, revision_id=revision_id)
1032
result.set_parent(self.bzrdir.root_transport.base)
1037
def _synchronize_history(self, destination, revision_id):
1038
"""Synchronize last revision and revision history between branches.
1040
This version is most efficient when the destination is also a
1041
BzrBranch6, but works for BzrBranch5, as long as the destination's
1042
repository contains all the lefthand ancestors of the intended
1043
last_revision. If not, set_last_revision_info will fail.
1045
:param destination: The branch to copy the history into
1046
:param revision_id: The revision-id to truncate history at. May
1047
be None to copy complete history.
1049
source_revno, source_revision_id = self.last_revision_info()
1050
if revision_id is None:
1051
revno, revision_id = source_revno, source_revision_id
1052
elif source_revision_id == revision_id:
1053
# we know the revno without needing to walk all of history
1054
revno = source_revno
1056
# To figure out the revno for a random revision, we need to build
1057
# the revision history, and count its length.
1058
# We don't care about the order, just how long it is.
1059
# Alternatively, we could start at the current location, and count
1060
# backwards. But there is no guarantee that we will find it since
1061
# it may be a merged revision.
1062
revno = len(list(self.repository.iter_reverse_revision_history(
1064
destination.set_last_revision_info(revno, revision_id)
1067
def copy_content_into(self, destination, revision_id=None):
1068
"""Copy the content of self into destination.
1070
revision_id: if not None, the revision history in the new branch will
1071
be truncated to end with revision_id.
1073
self._synchronize_history(destination, revision_id)
1075
parent = self.get_parent()
1076
except errors.InaccessibleParent, e:
1077
mutter('parent was not accessible to copy: %s', e)
1080
destination.set_parent(parent)
1081
if self._push_should_merge_tags():
1082
self.tags.merge_to(destination.tags)
1086
"""Check consistency of the branch.
1088
In particular this checks that revisions given in the revision-history
1089
do actually match up in the revision graph, and that they're all
1090
present in the repository.
1092
Callers will typically also want to check the repository.
1094
:return: A BranchCheckResult.
1096
mainline_parent_id = None
1097
last_revno, last_revision_id = self.last_revision_info()
1098
real_rev_history = list(self.repository.iter_reverse_revision_history(
1100
real_rev_history.reverse()
1101
if len(real_rev_history) != last_revno:
1102
raise errors.BzrCheckError('revno does not match len(mainline)'
1103
' %s != %s' % (last_revno, len(real_rev_history)))
1104
# TODO: We should probably also check that real_rev_history actually
1105
# matches self.revision_history()
1106
for revision_id in real_rev_history:
1108
revision = self.repository.get_revision(revision_id)
1109
except errors.NoSuchRevision, e:
1110
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1112
# In general the first entry on the revision history has no parents.
1113
# But it's not illegal for it to have parents listed; this can happen
1114
# in imports from Arch when the parents weren't reachable.
1115
if mainline_parent_id is not None:
1116
if mainline_parent_id not in revision.parent_ids:
1117
raise errors.BzrCheckError("previous revision {%s} not listed among "
1119
% (mainline_parent_id, revision_id))
1120
mainline_parent_id = revision_id
1121
return BranchCheckResult(self)
1123
def _get_checkout_format(self):
1124
"""Return the most suitable metadir for a checkout of this branch.
1125
Weaves are used if this branch's repository uses weaves.
1127
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1128
from bzrlib.repofmt import weaverepo
1129
format = bzrdir.BzrDirMetaFormat1()
1130
format.repository_format = weaverepo.RepositoryFormat7()
1132
format = self.repository.bzrdir.checkout_metadir()
1133
format.set_branch_format(self._format)
1136
def create_clone_on_transport(self, to_transport, revision_id=None,
1137
stacked_on=None, create_prefix=False, use_existing_dir=False):
1138
"""Create a clone of this branch and its bzrdir.
1140
:param to_transport: The transport to clone onto.
1141
:param revision_id: The revision id to use as tip in the new branch.
1142
If None the tip is obtained from this branch.
1143
:param stacked_on: An optional URL to stack the clone on.
1144
:param create_prefix: Create any missing directories leading up to
1146
:param use_existing_dir: Use an existing directory if one exists.
1148
# XXX: Fix the bzrdir API to allow getting the branch back from the
1149
# clone call. Or something. 20090224 RBC/spiv.
1150
if revision_id is None:
1151
revision_id = self.last_revision()
1153
dir_to = self.bzrdir.clone_on_transport(to_transport,
1154
revision_id=revision_id, stacked_on=stacked_on,
1155
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1156
except errors.FileExists:
1157
if not use_existing_dir:
1158
raise errors.BzrCommandError("Target directory %s"
1159
" already exists, but does not have a valid .bzr"
1160
" directory. Supply --use-existing-dir to push"
1161
" there anyway." % to_transport.base)
1162
except errors.NoSuchFile:
1163
if not create_prefix:
1164
raise errors.BzrCommandError("Parent directory of %s"
1166
"\nYou may supply --create-prefix to create all"
1167
" leading parent directories."
1168
% to_transport.base)
1169
except errors.TooManyRedirections:
1170
raise errors.BzrCommandError("Too many redirections trying "
1171
"to make %s." % to_transport.base)
1172
return dir_to.open_branch()
1174
def create_checkout(self, to_location, revision_id=None,
1175
lightweight=False, accelerator_tree=None,
1177
"""Create a checkout of a branch.
1179
:param to_location: The url to produce the checkout at
1180
:param revision_id: The revision to check out
1181
:param lightweight: If True, produce a lightweight checkout, otherwise,
1182
produce a bound branch (heavyweight checkout)
1183
:param accelerator_tree: A tree which can be used for retrieving file
1184
contents more quickly than the revision tree, i.e. a workingtree.
1185
The revision tree will be used for cases where accelerator_tree's
1186
content is different.
1187
:param hardlink: If true, hard-link files from accelerator_tree,
1189
:return: The tree of the created checkout
1191
t = transport.get_transport(to_location)
1194
format = self._get_checkout_format()
1195
checkout = format.initialize_on_transport(t)
1196
from_branch = BranchReferenceFormat().initialize(checkout, self)
1198
format = self._get_checkout_format()
1199
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1200
to_location, force_new_tree=False, format=format)
1201
checkout = checkout_branch.bzrdir
1202
checkout_branch.bind(self)
1203
# pull up to the specified revision_id to set the initial
1204
# branch tip correctly, and seed it with history.
1205
checkout_branch.pull(self, stop_revision=revision_id)
1207
tree = checkout.create_workingtree(revision_id,
1208
from_branch=from_branch,
1209
accelerator_tree=accelerator_tree,
1211
basis_tree = tree.basis_tree()
1212
basis_tree.lock_read()
1214
for path, file_id in basis_tree.iter_references():
1215
reference_parent = self.reference_parent(file_id, path)
1216
reference_parent.create_checkout(tree.abspath(path),
1217
basis_tree.get_reference_revision(file_id, path),
1224
def reconcile(self, thorough=True):
1225
"""Make sure the data stored in this branch is consistent."""
1226
from bzrlib.reconcile import BranchReconciler
1227
reconciler = BranchReconciler(self, thorough=thorough)
1228
reconciler.reconcile()
1231
def reference_parent(self, file_id, path):
1232
"""Return the parent branch for a tree-reference file_id
1233
:param file_id: The file_id of the tree reference
1234
:param path: The path of the file_id in the tree
1235
:return: A branch associated with the file_id
1237
# FIXME should provide multiple branches, based on config
1238
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1240
def supports_tags(self):
1241
return self._format.supports_tags()
1243
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1245
"""Ensure that revision_b is a descendant of revision_a.
1247
This is a helper function for update_revisions.
1249
:raises: DivergedBranches if revision_b has diverged from revision_a.
1250
:returns: True if revision_b is a descendant of revision_a.
1252
relation = self._revision_relations(revision_a, revision_b, graph)
1253
if relation == 'b_descends_from_a':
1255
elif relation == 'diverged':
1256
raise errors.DivergedBranches(self, other_branch)
1257
elif relation == 'a_descends_from_b':
1260
raise AssertionError("invalid relation: %r" % (relation,))
1262
def _revision_relations(self, revision_a, revision_b, graph):
1263
"""Determine the relationship between two revisions.
1265
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1267
heads = graph.heads([revision_a, revision_b])
1268
if heads == set([revision_b]):
1269
return 'b_descends_from_a'
1270
elif heads == set([revision_a, revision_b]):
1271
# These branches have diverged
1273
elif heads == set([revision_a]):
1274
return 'a_descends_from_b'
1276
raise AssertionError("invalid heads: %r" % (heads,))
1279
class BranchFormat(object):
1280
"""An encapsulation of the initialization and open routines for a format.
1282
Formats provide three things:
1283
* An initialization routine,
1287
Formats are placed in an dict by their format string for reference
1288
during branch opening. Its not required that these be instances, they
1289
can be classes themselves with class methods - it simply depends on
1290
whether state is needed for a given format or not.
1292
Once a format is deprecated, just deprecate the initialize and open
1293
methods on the format class. Do not deprecate the object, as the
1294
object will be created every time regardless.
1297
_default_format = None
1298
"""The default format used for new branches."""
1301
"""The known formats."""
1303
def __eq__(self, other):
1304
return self.__class__ is other.__class__
1306
def __ne__(self, other):
1307
return not (self == other)
1310
def find_format(klass, a_bzrdir):
1311
"""Return the format for the branch object in a_bzrdir."""
1313
transport = a_bzrdir.get_branch_transport(None)
1314
format_string = transport.get("format").read()
1315
return klass._formats[format_string]
1316
except errors.NoSuchFile:
1317
raise errors.NotBranchError(path=transport.base)
1319
raise errors.UnknownFormatError(format=format_string, kind='branch')
1322
def get_default_format(klass):
1323
"""Return the current default format."""
1324
return klass._default_format
1326
def get_reference(self, a_bzrdir):
1327
"""Get the target reference of the branch in a_bzrdir.
1329
format probing must have been completed before calling
1330
this method - it is assumed that the format of the branch
1331
in a_bzrdir is correct.
1333
:param a_bzrdir: The bzrdir to get the branch data from.
1334
:return: None if the branch is not a reference branch.
1339
def set_reference(self, a_bzrdir, to_branch):
1340
"""Set the target reference of the branch in a_bzrdir.
1342
format probing must have been completed before calling
1343
this method - it is assumed that the format of the branch
1344
in a_bzrdir is correct.
1346
:param a_bzrdir: The bzrdir to set the branch reference for.
1347
:param to_branch: branch that the checkout is to reference
1349
raise NotImplementedError(self.set_reference)
1351
def get_format_string(self):
1352
"""Return the ASCII format string that identifies this format."""
1353
raise NotImplementedError(self.get_format_string)
1355
def get_format_description(self):
1356
"""Return the short format description for this format."""
1357
raise NotImplementedError(self.get_format_description)
1359
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1361
"""Initialize a branch in a bzrdir, with specified files
1363
:param a_bzrdir: The bzrdir to initialize the branch in
1364
:param utf8_files: The files to create as a list of
1365
(filename, content) tuples
1366
:param set_format: If True, set the format with
1367
self.get_format_string. (BzrBranch4 has its format set
1369
:return: a branch in this format
1371
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1372
branch_transport = a_bzrdir.get_branch_transport(self)
1374
'metadir': ('lock', lockdir.LockDir),
1375
'branch4': ('branch-lock', lockable_files.TransportLock),
1377
lock_name, lock_class = lock_map[lock_type]
1378
control_files = lockable_files.LockableFiles(branch_transport,
1379
lock_name, lock_class)
1380
control_files.create_lock()
1381
control_files.lock_write()
1383
utf8_files += [('format', self.get_format_string())]
1385
for (filename, content) in utf8_files:
1386
branch_transport.put_bytes(
1388
mode=a_bzrdir._get_file_mode())
1390
control_files.unlock()
1391
return self.open(a_bzrdir, _found=True)
1393
def initialize(self, a_bzrdir):
1394
"""Create a branch of this format in a_bzrdir."""
1395
raise NotImplementedError(self.initialize)
1397
def is_supported(self):
1398
"""Is this format supported?
1400
Supported formats can be initialized and opened.
1401
Unsupported formats may not support initialization or committing or
1402
some other features depending on the reason for not being supported.
1406
def make_tags(self, branch):
1407
"""Create a tags object for branch.
1409
This method is on BranchFormat, because BranchFormats are reflected
1410
over the wire via network_name(), whereas full Branch instances require
1411
multiple VFS method calls to operate at all.
1413
The default implementation returns a disabled-tags instance.
1415
Note that it is normal for branch to be a RemoteBranch when using tags
1418
return DisabledTags(branch)
1420
def network_name(self):
1421
"""A simple byte string uniquely identifying this format for RPC calls.
1423
MetaDir branch formats use their disk format string to identify the
1424
repository over the wire. All in one formats such as bzr < 0.8, and
1425
foreign formats like svn/git and hg should use some marker which is
1426
unique and immutable.
1428
raise NotImplementedError(self.network_name)
1430
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1431
"""Return the branch object for a_bzrdir
1433
:param a_bzrdir: A BzrDir that contains a branch.
1434
:param _found: a private parameter, do not use it. It is used to
1435
indicate if format probing has already be done.
1436
:param ignore_fallbacks: when set, no fallback branches will be opened
1437
(if there are any). Default is to open fallbacks.
1439
raise NotImplementedError(self.open)
1442
def register_format(klass, format):
1443
"""Register a metadir format."""
1444
klass._formats[format.get_format_string()] = format
1445
# Metadir formats have a network name of their format string, and get
1446
# registered as class factories.
1447
network_format_registry.register(format.get_format_string(), format.__class__)
1450
def set_default_format(klass, format):
1451
klass._default_format = format
1453
def supports_stacking(self):
1454
"""True if this format records a stacked-on branch."""
1458
def unregister_format(klass, format):
1459
del klass._formats[format.get_format_string()]
1462
return self.get_format_description().rstrip()
1464
def supports_tags(self):
1465
"""True if this format supports tags stored in the branch"""
1466
return False # by default
1469
class BranchHooks(Hooks):
1470
"""A dictionary mapping hook name to a list of callables for branch hooks.
1472
e.g. ['set_rh'] Is the list of items to be called when the
1473
set_revision_history function is invoked.
1477
"""Create the default hooks.
1479
These are all empty initially, because by default nothing should get
1482
Hooks.__init__(self)
1483
self.create_hook(HookPoint('set_rh',
1484
"Invoked whenever the revision history has been set via "
1485
"set_revision_history. The api signature is (branch, "
1486
"revision_history), and the branch will be write-locked. "
1487
"The set_rh hook can be expensive for bzr to trigger, a better "
1488
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1489
self.create_hook(HookPoint('open',
1490
"Called with the Branch object that has been opened after a "
1491
"branch is opened.", (1, 8), None))
1492
self.create_hook(HookPoint('post_push',
1493
"Called after a push operation completes. post_push is called "
1494
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1495
"bzr client.", (0, 15), None))
1496
self.create_hook(HookPoint('post_pull',
1497
"Called after a pull operation completes. post_pull is called "
1498
"with a bzrlib.branch.PullResult object and only runs in the "
1499
"bzr client.", (0, 15), None))
1500
self.create_hook(HookPoint('pre_commit',
1501
"Called after a commit is calculated but before it is is "
1502
"completed. pre_commit is called with (local, master, old_revno, "
1503
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1504
"). old_revid is NULL_REVISION for the first commit to a branch, "
1505
"tree_delta is a TreeDelta object describing changes from the "
1506
"basis revision. hooks MUST NOT modify this delta. "
1507
" future_tree is an in-memory tree obtained from "
1508
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1509
"tree.", (0,91), None))
1510
self.create_hook(HookPoint('post_commit',
1511
"Called in the bzr client after a commit has completed. "
1512
"post_commit is called with (local, master, old_revno, old_revid, "
1513
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1514
"commit to a branch.", (0, 15), None))
1515
self.create_hook(HookPoint('post_uncommit',
1516
"Called in the bzr client after an uncommit completes. "
1517
"post_uncommit is called with (local, master, old_revno, "
1518
"old_revid, new_revno, new_revid) where local is the local branch "
1519
"or None, master is the target branch, and an empty branch "
1520
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1521
self.create_hook(HookPoint('pre_change_branch_tip',
1522
"Called in bzr client and server before a change to the tip of a "
1523
"branch is made. pre_change_branch_tip is called with a "
1524
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1525
"commit, uncommit will all trigger this hook.", (1, 6), None))
1526
self.create_hook(HookPoint('post_change_branch_tip',
1527
"Called in bzr client and server after a change to the tip of a "
1528
"branch is made. post_change_branch_tip is called with a "
1529
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1530
"commit, uncommit will all trigger this hook.", (1, 4), None))
1531
self.create_hook(HookPoint('transform_fallback_location',
1532
"Called when a stacked branch is activating its fallback "
1533
"locations. transform_fallback_location is called with (branch, "
1534
"url), and should return a new url. Returning the same url "
1535
"allows it to be used as-is, returning a different one can be "
1536
"used to cause the branch to stack on a closer copy of that "
1537
"fallback_location. Note that the branch cannot have history "
1538
"accessing methods called on it during this hook because the "
1539
"fallback locations have not been activated. When there are "
1540
"multiple hooks installed for transform_fallback_location, "
1541
"all are called with the url returned from the previous hook."
1542
"The order is however undefined.", (1, 9), None))
1545
# install the default hooks into the Branch class.
1546
Branch.hooks = BranchHooks()
1549
class ChangeBranchTipParams(object):
1550
"""Object holding parameters passed to *_change_branch_tip hooks.
1552
There are 5 fields that hooks may wish to access:
1554
:ivar branch: the branch being changed
1555
:ivar old_revno: revision number before the change
1556
:ivar new_revno: revision number after the change
1557
:ivar old_revid: revision id before the change
1558
:ivar new_revid: revision id after the change
1560
The revid fields are strings. The revno fields are integers.
1563
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1564
"""Create a group of ChangeBranchTip parameters.
1566
:param branch: The branch being changed.
1567
:param old_revno: Revision number before the change.
1568
:param new_revno: Revision number after the change.
1569
:param old_revid: Tip revision id before the change.
1570
:param new_revid: Tip revision id after the change.
1572
self.branch = branch
1573
self.old_revno = old_revno
1574
self.new_revno = new_revno
1575
self.old_revid = old_revid
1576
self.new_revid = new_revid
1578
def __eq__(self, other):
1579
return self.__dict__ == other.__dict__
1582
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1583
self.__class__.__name__, self.branch,
1584
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1587
class BzrBranchFormat4(BranchFormat):
1588
"""Bzr branch format 4.
1591
- a revision-history file.
1592
- a branch-lock lock file [ to be shared with the bzrdir ]
1595
def get_format_description(self):
1596
"""See BranchFormat.get_format_description()."""
1597
return "Branch format 4"
1599
def initialize(self, a_bzrdir):
1600
"""Create a branch of this format in a_bzrdir."""
1601
utf8_files = [('revision-history', ''),
1602
('branch-name', ''),
1604
return self._initialize_helper(a_bzrdir, utf8_files,
1605
lock_type='branch4', set_format=False)
1608
super(BzrBranchFormat4, self).__init__()
1609
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1611
def network_name(self):
1612
"""The network name for this format is the control dirs disk label."""
1613
return self._matchingbzrdir.get_format_string()
1615
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1616
"""See BranchFormat.open()."""
1618
# we are being called directly and must probe.
1619
raise NotImplementedError
1620
return BzrBranch(_format=self,
1621
_control_files=a_bzrdir._control_files,
1623
_repository=a_bzrdir.open_repository())
1626
return "Bazaar-NG branch format 4"
1629
class BranchFormatMetadir(BranchFormat):
1630
"""Common logic for meta-dir based branch formats."""
1632
def _branch_class(self):
1633
"""What class to instantiate on open calls."""
1634
raise NotImplementedError(self._branch_class)
1636
def network_name(self):
1637
"""A simple byte string uniquely identifying this format for RPC calls.
1639
Metadir branch formats use their format string.
1641
return self.get_format_string()
1643
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1644
"""See BranchFormat.open()."""
1646
format = BranchFormat.find_format(a_bzrdir)
1647
if format.__class__ != self.__class__:
1648
raise AssertionError("wrong format %r found for %r" %
1651
transport = a_bzrdir.get_branch_transport(None)
1652
control_files = lockable_files.LockableFiles(transport, 'lock',
1654
return self._branch_class()(_format=self,
1655
_control_files=control_files,
1657
_repository=a_bzrdir.find_repository(),
1658
ignore_fallbacks=ignore_fallbacks)
1659
except errors.NoSuchFile:
1660
raise errors.NotBranchError(path=transport.base)
1663
super(BranchFormatMetadir, self).__init__()
1664
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1665
self._matchingbzrdir.set_branch_format(self)
1667
def supports_tags(self):
1671
class BzrBranchFormat5(BranchFormatMetadir):
1672
"""Bzr branch format 5.
1675
- a revision-history file.
1677
- a lock dir guarding the branch itself
1678
- all of this stored in a branch/ subdirectory
1679
- works with shared repositories.
1681
This format is new in bzr 0.8.
1684
def _branch_class(self):
1687
def get_format_string(self):
1688
"""See BranchFormat.get_format_string()."""
1689
return "Bazaar-NG branch format 5\n"
1691
def get_format_description(self):
1692
"""See BranchFormat.get_format_description()."""
1693
return "Branch format 5"
1695
def initialize(self, a_bzrdir):
1696
"""Create a branch of this format in a_bzrdir."""
1697
utf8_files = [('revision-history', ''),
1698
('branch-name', ''),
1700
return self._initialize_helper(a_bzrdir, utf8_files)
1702
def supports_tags(self):
1706
class BzrBranchFormat6(BranchFormatMetadir):
1707
"""Branch format with last-revision and tags.
1709
Unlike previous formats, this has no explicit revision history. Instead,
1710
this just stores the last-revision, and the left-hand history leading
1711
up to there is the history.
1713
This format was introduced in bzr 0.15
1714
and became the default in 0.91.
1717
def _branch_class(self):
1720
def get_format_string(self):
1721
"""See BranchFormat.get_format_string()."""
1722
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1724
def get_format_description(self):
1725
"""See BranchFormat.get_format_description()."""
1726
return "Branch format 6"
1728
def initialize(self, a_bzrdir):
1729
"""Create a branch of this format in a_bzrdir."""
1730
utf8_files = [('last-revision', '0 null:\n'),
1731
('branch.conf', ''),
1734
return self._initialize_helper(a_bzrdir, utf8_files)
1736
def make_tags(self, branch):
1737
"""See bzrlib.branch.BranchFormat.make_tags()."""
1738
return BasicTags(branch)
1742
class BzrBranchFormat7(BranchFormatMetadir):
1743
"""Branch format with last-revision, tags, and a stacked location pointer.
1745
The stacked location pointer is passed down to the repository and requires
1746
a repository format with supports_external_lookups = True.
1748
This format was introduced in bzr 1.6.
1751
def _branch_class(self):
1754
def get_format_string(self):
1755
"""See BranchFormat.get_format_string()."""
1756
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1758
def get_format_description(self):
1759
"""See BranchFormat.get_format_description()."""
1760
return "Branch format 7"
1762
def initialize(self, a_bzrdir):
1763
"""Create a branch of this format in a_bzrdir."""
1764
utf8_files = [('last-revision', '0 null:\n'),
1765
('branch.conf', ''),
1768
return self._initialize_helper(a_bzrdir, utf8_files)
1771
super(BzrBranchFormat7, self).__init__()
1772
self._matchingbzrdir.repository_format = \
1773
RepositoryFormatKnitPack5RichRoot()
1775
def make_tags(self, branch):
1776
"""See bzrlib.branch.BranchFormat.make_tags()."""
1777
return BasicTags(branch)
1779
def supports_stacking(self):
1783
class BranchReferenceFormat(BranchFormat):
1784
"""Bzr branch reference format.
1786
Branch references are used in implementing checkouts, they
1787
act as an alias to the real branch which is at some other url.
1794
def get_format_string(self):
1795
"""See BranchFormat.get_format_string()."""
1796
return "Bazaar-NG Branch Reference Format 1\n"
1798
def get_format_description(self):
1799
"""See BranchFormat.get_format_description()."""
1800
return "Checkout reference format 1"
1802
def get_reference(self, a_bzrdir):
1803
"""See BranchFormat.get_reference()."""
1804
transport = a_bzrdir.get_branch_transport(None)
1805
return transport.get('location').read()
1807
def set_reference(self, a_bzrdir, to_branch):
1808
"""See BranchFormat.set_reference()."""
1809
transport = a_bzrdir.get_branch_transport(None)
1810
location = transport.put_bytes('location', to_branch.base)
1812
def initialize(self, a_bzrdir, target_branch=None):
1813
"""Create a branch of this format in a_bzrdir."""
1814
if target_branch is None:
1815
# this format does not implement branch itself, thus the implicit
1816
# creation contract must see it as uninitializable
1817
raise errors.UninitializableFormat(self)
1818
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1819
branch_transport = a_bzrdir.get_branch_transport(self)
1820
branch_transport.put_bytes('location',
1821
target_branch.bzrdir.root_transport.base)
1822
branch_transport.put_bytes('format', self.get_format_string())
1824
a_bzrdir, _found=True,
1825
possible_transports=[target_branch.bzrdir.root_transport])
1828
super(BranchReferenceFormat, self).__init__()
1829
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1830
self._matchingbzrdir.set_branch_format(self)
1832
def _make_reference_clone_function(format, a_branch):
1833
"""Create a clone() routine for a branch dynamically."""
1834
def clone(to_bzrdir, revision_id=None,
1835
repository_policy=None):
1836
"""See Branch.clone()."""
1837
return format.initialize(to_bzrdir, a_branch)
1838
# cannot obey revision_id limits when cloning a reference ...
1839
# FIXME RBC 20060210 either nuke revision_id for clone, or
1840
# emit some sort of warning/error to the caller ?!
1843
def open(self, a_bzrdir, _found=False, location=None,
1844
possible_transports=None, ignore_fallbacks=False):
1845
"""Return the branch that the branch reference in a_bzrdir points at.
1847
:param a_bzrdir: A BzrDir that contains a branch.
1848
:param _found: a private parameter, do not use it. It is used to
1849
indicate if format probing has already be done.
1850
:param ignore_fallbacks: when set, no fallback branches will be opened
1851
(if there are any). Default is to open fallbacks.
1852
:param location: The location of the referenced branch. If
1853
unspecified, this will be determined from the branch reference in
1855
:param possible_transports: An optional reusable transports list.
1858
format = BranchFormat.find_format(a_bzrdir)
1859
if format.__class__ != self.__class__:
1860
raise AssertionError("wrong format %r found for %r" %
1862
if location is None:
1863
location = self.get_reference(a_bzrdir)
1864
real_bzrdir = bzrdir.BzrDir.open(
1865
location, possible_transports=possible_transports)
1866
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1867
# this changes the behaviour of result.clone to create a new reference
1868
# rather than a copy of the content of the branch.
1869
# I did not use a proxy object because that needs much more extensive
1870
# testing, and we are only changing one behaviour at the moment.
1871
# If we decide to alter more behaviours - i.e. the implicit nickname
1872
# then this should be refactored to introduce a tested proxy branch
1873
# and a subclass of that for use in overriding clone() and ....
1875
result.clone = self._make_reference_clone_function(result)
1879
network_format_registry = registry.FormatRegistry()
1880
"""Registry of formats indexed by their network name.
1882
The network name for a branch format is an identifier that can be used when
1883
referring to formats with smart server operations. See
1884
BranchFormat.network_name() for more detail.
1888
# formats which have no format string are not discoverable
1889
# and not independently creatable, so are not registered.
1890
__format5 = BzrBranchFormat5()
1891
__format6 = BzrBranchFormat6()
1892
__format7 = BzrBranchFormat7()
1893
BranchFormat.register_format(__format5)
1894
BranchFormat.register_format(BranchReferenceFormat())
1895
BranchFormat.register_format(__format6)
1896
BranchFormat.register_format(__format7)
1897
BranchFormat.set_default_format(__format6)
1898
_legacy_formats = [BzrBranchFormat4(),
1900
network_format_registry.register(
1901
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1904
class BzrBranch(Branch):
1905
"""A branch stored in the actual filesystem.
1907
Note that it's "local" in the context of the filesystem; it doesn't
1908
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1909
it's writable, and can be accessed via the normal filesystem API.
1911
:ivar _transport: Transport for file operations on this branch's
1912
control files, typically pointing to the .bzr/branch directory.
1913
:ivar repository: Repository for this branch.
1914
:ivar base: The url of the base directory for this branch; the one
1915
containing the .bzr directory.
1918
def __init__(self, _format=None,
1919
_control_files=None, a_bzrdir=None, _repository=None,
1920
ignore_fallbacks=False):
1921
"""Create new branch object at a particular location."""
1922
if a_bzrdir is None:
1923
raise ValueError('a_bzrdir must be supplied')
1925
self.bzrdir = a_bzrdir
1926
self._base = self.bzrdir.transport.clone('..').base
1927
# XXX: We should be able to just do
1928
# self.base = self.bzrdir.root_transport.base
1929
# but this does not quite work yet -- mbp 20080522
1930
self._format = _format
1931
if _control_files is None:
1932
raise ValueError('BzrBranch _control_files is None')
1933
self.control_files = _control_files
1934
self._transport = _control_files._transport
1935
self.repository = _repository
1936
Branch.__init__(self)
1939
return '%s(%r)' % (self.__class__.__name__, self.base)
1943
def _get_base(self):
1944
"""Returns the directory containing the control directory."""
1947
base = property(_get_base, doc="The URL for the root of this branch.")
1949
def _get_config(self):
1950
return TransportConfig(self._transport, 'branch.conf')
1952
def is_locked(self):
1953
return self.control_files.is_locked()
1955
def lock_write(self, token=None):
1956
# All-in-one needs to always unlock/lock.
1957
repo_control = getattr(self.repository, 'control_files', None)
1958
if self.control_files == repo_control or not self.is_locked():
1959
self.repository.lock_write()
1964
return self.control_files.lock_write(token=token)
1967
self.repository.unlock()
1970
def lock_read(self):
1971
# All-in-one needs to always unlock/lock.
1972
repo_control = getattr(self.repository, 'control_files', None)
1973
if self.control_files == repo_control or not self.is_locked():
1974
self.repository.lock_read()
1979
self.control_files.lock_read()
1982
self.repository.unlock()
1987
self.control_files.unlock()
1989
# All-in-one needs to always unlock/lock.
1990
repo_control = getattr(self.repository, 'control_files', None)
1991
if (self.control_files == repo_control or
1992
not self.control_files.is_locked()):
1993
self.repository.unlock()
1994
if not self.control_files.is_locked():
1995
# we just released the lock
1996
self._clear_cached_state()
1998
def peek_lock_mode(self):
1999
if self.control_files._lock_count == 0:
2002
return self.control_files._lock_mode
2004
def get_physical_lock_status(self):
2005
return self.control_files.get_physical_lock_status()
2008
def print_file(self, file, revision_id):
2009
"""See Branch.print_file."""
2010
return self.repository.print_file(file, revision_id)
2012
def _write_revision_history(self, history):
2013
"""Factored out of set_revision_history.
2015
This performs the actual writing to disk.
2016
It is intended to be called by BzrBranch5.set_revision_history."""
2017
self._transport.put_bytes(
2018
'revision-history', '\n'.join(history),
2019
mode=self.bzrdir._get_file_mode())
2022
def set_revision_history(self, rev_history):
2023
"""See Branch.set_revision_history."""
2024
if 'evil' in debug.debug_flags:
2025
mutter_callsite(3, "set_revision_history scales with history.")
2026
check_not_reserved_id = _mod_revision.check_not_reserved_id
2027
for rev_id in rev_history:
2028
check_not_reserved_id(rev_id)
2029
if Branch.hooks['post_change_branch_tip']:
2030
# Don't calculate the last_revision_info() if there are no hooks
2032
old_revno, old_revid = self.last_revision_info()
2033
if len(rev_history) == 0:
2034
revid = _mod_revision.NULL_REVISION
2036
revid = rev_history[-1]
2037
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2038
self._write_revision_history(rev_history)
2039
self._clear_cached_state()
2040
self._cache_revision_history(rev_history)
2041
for hook in Branch.hooks['set_rh']:
2042
hook(self, rev_history)
2043
if Branch.hooks['post_change_branch_tip']:
2044
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2046
def _synchronize_history(self, destination, revision_id):
2047
"""Synchronize last revision and revision history between branches.
2049
This version is most efficient when the destination is also a
2050
BzrBranch5, but works for BzrBranch6 as long as the revision
2051
history is the true lefthand parent history, and all of the revisions
2052
are in the destination's repository. If not, set_revision_history
2055
:param destination: The branch to copy the history into
2056
:param revision_id: The revision-id to truncate history at. May
2057
be None to copy complete history.
2059
if not isinstance(destination._format, BzrBranchFormat5):
2060
super(BzrBranch, self)._synchronize_history(
2061
destination, revision_id)
2063
if revision_id == _mod_revision.NULL_REVISION:
2066
new_history = self.revision_history()
2067
if revision_id is not None and new_history != []:
2069
new_history = new_history[:new_history.index(revision_id) + 1]
2071
rev = self.repository.get_revision(revision_id)
2072
new_history = rev.get_history(self.repository)[1:]
2073
destination.set_revision_history(new_history)
2076
def set_last_revision_info(self, revno, revision_id):
2077
"""Set the last revision of this branch.
2079
The caller is responsible for checking that the revno is correct
2080
for this revision id.
2082
It may be possible to set the branch last revision to an id not
2083
present in the repository. However, branches can also be
2084
configured to check constraints on history, in which case this may not
2087
revision_id = _mod_revision.ensure_null(revision_id)
2088
# this old format stores the full history, but this api doesn't
2089
# provide it, so we must generate, and might as well check it's
2091
history = self._lefthand_history(revision_id)
2092
if len(history) != revno:
2093
raise AssertionError('%d != %d' % (len(history), revno))
2094
self.set_revision_history(history)
2096
def _gen_revision_history(self):
2097
history = self._transport.get_bytes('revision-history').split('\n')
2098
if history[-1:] == ['']:
2099
# There shouldn't be a trailing newline, but just in case.
2104
def generate_revision_history(self, revision_id, last_rev=None,
2106
"""Create a new revision history that will finish with revision_id.
2108
:param revision_id: the new tip to use.
2109
:param last_rev: The previous last_revision. If not None, then this
2110
must be a ancestory of revision_id, or DivergedBranches is raised.
2111
:param other_branch: The other branch that DivergedBranches should
2112
raise with respect to.
2114
self.set_revision_history(self._lefthand_history(revision_id,
2115
last_rev, other_branch))
2117
def basis_tree(self):
2118
"""See Branch.basis_tree."""
2119
return self.repository.revision_tree(self.last_revision())
2122
def pull(self, source, overwrite=False, stop_revision=None,
2123
_hook_master=None, run_hooks=True, possible_transports=None,
2124
_override_hook_target=None):
2127
:param _hook_master: Private parameter - set the branch to
2128
be supplied as the master to pull hooks.
2129
:param run_hooks: Private parameter - if false, this branch
2130
is being called because it's the master of the primary branch,
2131
so it should not run its hooks.
2132
:param _override_hook_target: Private parameter - set the branch to be
2133
supplied as the target_branch to pull hooks.
2135
result = PullResult()
2136
result.source_branch = source
2137
if _override_hook_target is None:
2138
result.target_branch = self
2140
result.target_branch = _override_hook_target
2143
# We assume that during 'pull' the local repository is closer than
2145
graph = self.repository.get_graph(source.repository)
2146
result.old_revno, result.old_revid = self.last_revision_info()
2147
self.update_revisions(source, stop_revision, overwrite=overwrite,
2149
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2150
result.new_revno, result.new_revid = self.last_revision_info()
2152
result.master_branch = _hook_master
2153
result.local_branch = result.target_branch
2155
result.master_branch = result.target_branch
2156
result.local_branch = None
2158
for hook in Branch.hooks['post_pull']:
2164
def _get_parent_location(self):
2165
_locs = ['parent', 'pull', 'x-pull']
2168
return self._transport.get_bytes(l).strip('\n')
2169
except errors.NoSuchFile:
2174
def push(self, target, overwrite=False, stop_revision=None,
2175
_override_hook_source_branch=None):
2178
This is the basic concrete implementation of push()
2180
:param _override_hook_source_branch: If specified, run
2181
the hooks passing this Branch as the source, rather than self.
2182
This is for use of RemoteBranch, where push is delegated to the
2183
underlying vfs-based Branch.
2185
# TODO: Public option to disable running hooks - should be trivial but
2187
return _run_with_write_locked_target(
2188
target, self._push_with_bound_branches, target, overwrite,
2190
_override_hook_source_branch=_override_hook_source_branch)
2192
def _push_with_bound_branches(self, target, overwrite,
2194
_override_hook_source_branch=None):
2195
"""Push from self into target, and into target's master if any.
2197
This is on the base BzrBranch class even though it doesn't support
2198
bound branches because the *target* might be bound.
2201
if _override_hook_source_branch:
2202
result.source_branch = _override_hook_source_branch
2203
for hook in Branch.hooks['post_push']:
2206
bound_location = target.get_bound_location()
2207
if bound_location and target.base != bound_location:
2208
# there is a master branch.
2210
# XXX: Why the second check? Is it even supported for a branch to
2211
# be bound to itself? -- mbp 20070507
2212
master_branch = target.get_master_branch()
2213
master_branch.lock_write()
2215
# push into the master from this branch.
2216
self._basic_push(master_branch, overwrite, stop_revision)
2217
# and push into the target branch from this. Note that we push from
2218
# this branch again, because its considered the highest bandwidth
2220
result = self._basic_push(target, overwrite, stop_revision)
2221
result.master_branch = master_branch
2222
result.local_branch = target
2226
master_branch.unlock()
2229
result = self._basic_push(target, overwrite, stop_revision)
2230
# TODO: Why set master_branch and local_branch if there's no
2231
# binding? Maybe cleaner to just leave them unset? -- mbp
2233
result.master_branch = target
2234
result.local_branch = None
2238
def _basic_push(self, target, overwrite, stop_revision):
2239
"""Basic implementation of push without bound branches or hooks.
2241
Must be called with self read locked and target write locked.
2243
result = BranchPushResult()
2244
result.source_branch = self
2245
result.target_branch = target
2246
result.old_revno, result.old_revid = target.last_revision_info()
2247
if result.old_revid != self.last_revision():
2248
# We assume that during 'push' this repository is closer than
2250
graph = self.repository.get_graph(target.repository)
2251
target.update_revisions(self, stop_revision, overwrite=overwrite,
2253
if self._push_should_merge_tags():
2254
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2255
result.new_revno, result.new_revid = target.last_revision_info()
2258
def get_stacked_on_url(self):
2259
raise errors.UnstackableBranchFormat(self._format, self.base)
2261
def set_push_location(self, location):
2262
"""See Branch.set_push_location."""
2263
self.get_config().set_user_option(
2264
'push_location', location,
2265
store=_mod_config.STORE_LOCATION_NORECURSE)
2267
def _set_parent_location(self, url):
2269
self._transport.delete('parent')
2271
self._transport.put_bytes('parent', url + '\n',
2272
mode=self.bzrdir._get_file_mode())
2275
class BzrBranch5(BzrBranch):
2276
"""A format 5 branch. This supports new features over plain branches.
2278
It has support for a master_branch which is the data for bound branches.
2282
def pull(self, source, overwrite=False, stop_revision=None,
2283
run_hooks=True, possible_transports=None,
2284
_override_hook_target=None):
2285
"""Pull from source into self, updating my master if any.
2287
:param run_hooks: Private parameter - if false, this branch
2288
is being called because it's the master of the primary branch,
2289
so it should not run its hooks.
2291
bound_location = self.get_bound_location()
2292
master_branch = None
2293
if bound_location and source.base != bound_location:
2294
# not pulling from master, so we need to update master.
2295
master_branch = self.get_master_branch(possible_transports)
2296
master_branch.lock_write()
2299
# pull from source into master.
2300
master_branch.pull(source, overwrite, stop_revision,
2302
return super(BzrBranch5, self).pull(source, overwrite,
2303
stop_revision, _hook_master=master_branch,
2304
run_hooks=run_hooks,
2305
_override_hook_target=_override_hook_target)
2308
master_branch.unlock()
2310
def get_bound_location(self):
2312
return self._transport.get_bytes('bound')[:-1]
2313
except errors.NoSuchFile:
2317
def get_master_branch(self, possible_transports=None):
2318
"""Return the branch we are bound to.
2320
:return: Either a Branch, or None
2322
This could memoise the branch, but if thats done
2323
it must be revalidated on each new lock.
2324
So for now we just don't memoise it.
2325
# RBC 20060304 review this decision.
2327
bound_loc = self.get_bound_location()
2331
return Branch.open(bound_loc,
2332
possible_transports=possible_transports)
2333
except (errors.NotBranchError, errors.ConnectionError), e:
2334
raise errors.BoundBranchConnectionFailure(
2338
def set_bound_location(self, location):
2339
"""Set the target where this branch is bound to.
2341
:param location: URL to the target branch
2344
self._transport.put_bytes('bound', location+'\n',
2345
mode=self.bzrdir._get_file_mode())
2348
self._transport.delete('bound')
2349
except errors.NoSuchFile:
2354
def bind(self, other):
2355
"""Bind this branch to the branch other.
2357
This does not push or pull data between the branches, though it does
2358
check for divergence to raise an error when the branches are not
2359
either the same, or one a prefix of the other. That behaviour may not
2360
be useful, so that check may be removed in future.
2362
:param other: The branch to bind to
2365
# TODO: jam 20051230 Consider checking if the target is bound
2366
# It is debatable whether you should be able to bind to
2367
# a branch which is itself bound.
2368
# Committing is obviously forbidden,
2369
# but binding itself may not be.
2370
# Since we *have* to check at commit time, we don't
2371
# *need* to check here
2373
# we want to raise diverged if:
2374
# last_rev is not in the other_last_rev history, AND
2375
# other_last_rev is not in our history, and do it without pulling
2377
self.set_bound_location(other.base)
2381
"""If bound, unbind"""
2382
return self.set_bound_location(None)
2385
def update(self, possible_transports=None):
2386
"""Synchronise this branch with the master branch if any.
2388
:return: None or the last_revision that was pivoted out during the
2391
master = self.get_master_branch(possible_transports)
2392
if master is not None:
2393
old_tip = _mod_revision.ensure_null(self.last_revision())
2394
self.pull(master, overwrite=True)
2395
if self.repository.get_graph().is_ancestor(old_tip,
2396
_mod_revision.ensure_null(self.last_revision())):
2402
class BzrBranch7(BzrBranch5):
2403
"""A branch with support for a fallback repository."""
2405
def _open_hook(self):
2406
if self._ignore_fallbacks:
2409
url = self.get_stacked_on_url()
2410
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2411
errors.UnstackableBranchFormat):
2414
for hook in Branch.hooks['transform_fallback_location']:
2415
url = hook(self, url)
2417
hook_name = Branch.hooks.get_hook_name(hook)
2418
raise AssertionError(
2419
"'transform_fallback_location' hook %s returned "
2420
"None, not a URL." % hook_name)
2421
self._activate_fallback_location(url, None)
2423
def __init__(self, *args, **kwargs):
2424
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2425
super(BzrBranch7, self).__init__(*args, **kwargs)
2426
self._last_revision_info_cache = None
2427
self._partial_revision_history_cache = []
2429
def _clear_cached_state(self):
2430
super(BzrBranch7, self)._clear_cached_state()
2431
self._last_revision_info_cache = None
2432
self._partial_revision_history_cache = []
2434
def _last_revision_info(self):
2435
revision_string = self._transport.get_bytes('last-revision')
2436
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2437
revision_id = cache_utf8.get_cached_utf8(revision_id)
2439
return revno, revision_id
2441
def _write_last_revision_info(self, revno, revision_id):
2442
"""Simply write out the revision id, with no checks.
2444
Use set_last_revision_info to perform this safely.
2446
Does not update the revision_history cache.
2447
Intended to be called by set_last_revision_info and
2448
_write_revision_history.
2450
revision_id = _mod_revision.ensure_null(revision_id)
2451
out_string = '%d %s\n' % (revno, revision_id)
2452
self._transport.put_bytes('last-revision', out_string,
2453
mode=self.bzrdir._get_file_mode())
2456
def set_last_revision_info(self, revno, revision_id):
2457
revision_id = _mod_revision.ensure_null(revision_id)
2458
old_revno, old_revid = self.last_revision_info()
2459
if self._get_append_revisions_only():
2460
self._check_history_violation(revision_id)
2461
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2462
self._write_last_revision_info(revno, revision_id)
2463
self._clear_cached_state()
2464
self._last_revision_info_cache = revno, revision_id
2465
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2467
def _synchronize_history(self, destination, revision_id):
2468
"""Synchronize last revision and revision history between branches.
2470
:see: Branch._synchronize_history
2472
# XXX: The base Branch has a fast implementation of this method based
2473
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2474
# that uses set_revision_history. This class inherits from BzrBranch5,
2475
# but wants the fast implementation, so it calls
2476
# Branch._synchronize_history directly.
2477
Branch._synchronize_history(self, destination, revision_id)
2479
def _check_history_violation(self, revision_id):
2480
last_revision = _mod_revision.ensure_null(self.last_revision())
2481
if _mod_revision.is_null(last_revision):
2483
if last_revision not in self._lefthand_history(revision_id):
2484
raise errors.AppendRevisionsOnlyViolation(self.base)
2486
def _gen_revision_history(self):
2487
"""Generate the revision history from last revision
2489
last_revno, last_revision = self.last_revision_info()
2490
self._extend_partial_history(stop_index=last_revno-1)
2491
return list(reversed(self._partial_revision_history_cache))
2493
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2494
"""Extend the partial history to include a given index
2496
If a stop_index is supplied, stop when that index has been reached.
2497
If a stop_revision is supplied, stop when that revision is
2498
encountered. Otherwise, stop when the beginning of history is
2501
:param stop_index: The index which should be present. When it is
2502
present, history extension will stop.
2503
:param revision_id: The revision id which should be present. When
2504
it is encountered, history extension will stop.
2506
repo = self.repository
2507
if len(self._partial_revision_history_cache) == 0:
2508
iterator = repo.iter_reverse_revision_history(self.last_revision())
2510
start_revision = self._partial_revision_history_cache[-1]
2511
iterator = repo.iter_reverse_revision_history(start_revision)
2512
#skip the last revision in the list
2513
next_revision = iterator.next()
2514
for revision_id in iterator:
2515
self._partial_revision_history_cache.append(revision_id)
2516
if (stop_index is not None and
2517
len(self._partial_revision_history_cache) > stop_index):
2519
if revision_id == stop_revision:
2522
def _write_revision_history(self, history):
2523
"""Factored out of set_revision_history.
2525
This performs the actual writing to disk, with format-specific checks.
2526
It is intended to be called by BzrBranch5.set_revision_history.
2528
if len(history) == 0:
2529
last_revision = 'null:'
2531
if history != self._lefthand_history(history[-1]):
2532
raise errors.NotLefthandHistory(history)
2533
last_revision = history[-1]
2534
if self._get_append_revisions_only():
2535
self._check_history_violation(last_revision)
2536
self._write_last_revision_info(len(history), last_revision)
2539
def _set_parent_location(self, url):
2540
"""Set the parent branch"""
2541
self._set_config_location('parent_location', url, make_relative=True)
2544
def _get_parent_location(self):
2545
"""Set the parent branch"""
2546
return self._get_config_location('parent_location')
2548
def set_push_location(self, location):
2549
"""See Branch.set_push_location."""
2550
self._set_config_location('push_location', location)
2552
def set_bound_location(self, location):
2553
"""See Branch.set_push_location."""
2555
config = self.get_config()
2556
if location is None:
2557
if config.get_user_option('bound') != 'True':
2560
config.set_user_option('bound', 'False', warn_masked=True)
2563
self._set_config_location('bound_location', location,
2565
config.set_user_option('bound', 'True', warn_masked=True)
2568
def _get_bound_location(self, bound):
2569
"""Return the bound location in the config file.
2571
Return None if the bound parameter does not match"""
2572
config = self.get_config()
2573
config_bound = (config.get_user_option('bound') == 'True')
2574
if config_bound != bound:
2576
return self._get_config_location('bound_location', config=config)
2578
def get_bound_location(self):
2579
"""See Branch.set_push_location."""
2580
return self._get_bound_location(True)
2582
def get_old_bound_location(self):
2583
"""See Branch.get_old_bound_location"""
2584
return self._get_bound_location(False)
2586
def get_stacked_on_url(self):
2587
# you can always ask for the URL; but you might not be able to use it
2588
# if the repo can't support stacking.
2589
## self._check_stackable_repo()
2590
stacked_url = self._get_config_location('stacked_on_location')
2591
if stacked_url is None:
2592
raise errors.NotStacked(self)
2595
def set_append_revisions_only(self, enabled):
2600
self.get_config().set_user_option('append_revisions_only', value,
2603
def _get_append_revisions_only(self):
2604
value = self.get_config().get_user_option('append_revisions_only')
2605
return value == 'True'
2608
def generate_revision_history(self, revision_id, last_rev=None,
2610
"""See BzrBranch5.generate_revision_history"""
2611
history = self._lefthand_history(revision_id, last_rev, other_branch)
2612
revno = len(history)
2613
self.set_last_revision_info(revno, revision_id)
2616
def get_rev_id(self, revno, history=None):
2617
"""Find the revision id of the specified revno."""
2619
return _mod_revision.NULL_REVISION
2621
last_revno, last_revision_id = self.last_revision_info()
2622
if revno <= 0 or revno > last_revno:
2623
raise errors.NoSuchRevision(self, revno)
2625
if history is not None:
2626
return history[revno - 1]
2628
index = last_revno - revno
2629
if len(self._partial_revision_history_cache) <= index:
2630
self._extend_partial_history(stop_index=index)
2631
if len(self._partial_revision_history_cache) > index:
2632
return self._partial_revision_history_cache[index]
2634
raise errors.NoSuchRevision(self, revno)
2637
def revision_id_to_revno(self, revision_id):
2638
"""Given a revision id, return its revno"""
2639
if _mod_revision.is_null(revision_id):
2642
index = self._partial_revision_history_cache.index(revision_id)
2644
self._extend_partial_history(stop_revision=revision_id)
2645
index = len(self._partial_revision_history_cache) - 1
2646
if self._partial_revision_history_cache[index] != revision_id:
2647
raise errors.NoSuchRevision(self, revision_id)
2648
return self.revno() - index
2651
class BzrBranch6(BzrBranch7):
2652
"""See BzrBranchFormat6 for the capabilities of this branch.
2654
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2658
def get_stacked_on_url(self):
2659
raise errors.UnstackableBranchFormat(self._format, self.base)
2662
######################################################################
2663
# results of operations
2666
class _Result(object):
2668
def _show_tag_conficts(self, to_file):
2669
if not getattr(self, 'tag_conflicts', None):
2671
to_file.write('Conflicting tags:\n')
2672
for name, value1, value2 in self.tag_conflicts:
2673
to_file.write(' %s\n' % (name, ))
2676
class PullResult(_Result):
2677
"""Result of a Branch.pull operation.
2679
:ivar old_revno: Revision number before pull.
2680
:ivar new_revno: Revision number after pull.
2681
:ivar old_revid: Tip revision id before pull.
2682
:ivar new_revid: Tip revision id after pull.
2683
:ivar source_branch: Source (local) branch object. (read locked)
2684
:ivar master_branch: Master branch of the target, or the target if no
2686
:ivar local_branch: target branch if there is a Master, else None
2687
:ivar target_branch: Target/destination branch object. (write locked)
2688
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2692
# DEPRECATED: pull used to return the change in revno
2693
return self.new_revno - self.old_revno
2695
def report(self, to_file):
2697
if self.old_revid == self.new_revid:
2698
to_file.write('No revisions to pull.\n')
2700
to_file.write('Now on revision %d.\n' % self.new_revno)
2701
self._show_tag_conficts(to_file)
2704
class BranchPushResult(_Result):
2705
"""Result of a Branch.push operation.
2707
:ivar old_revno: Revision number (eg 10) of the target before push.
2708
:ivar new_revno: Revision number (eg 12) of the target after push.
2709
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2711
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2713
:ivar source_branch: Source branch object that the push was from. This is
2714
read locked, and generally is a local (and thus low latency) branch.
2715
:ivar master_branch: If target is a bound branch, the master branch of
2716
target, or target itself. Always write locked.
2717
:ivar target_branch: The direct Branch where data is being sent (write
2719
:ivar local_branch: If the target is a bound branch this will be the
2720
target, otherwise it will be None.
2724
# DEPRECATED: push used to return the change in revno
2725
return self.new_revno - self.old_revno
2727
def report(self, to_file):
2728
"""Write a human-readable description of the result."""
2729
if self.old_revid == self.new_revid:
2730
note('No new revisions to push.')
2732
note('Pushed up to revision %d.' % self.new_revno)
2733
self._show_tag_conficts(to_file)
2736
class BranchCheckResult(object):
2737
"""Results of checking branch consistency.
2742
def __init__(self, branch):
2743
self.branch = branch
2745
def report_results(self, verbose):
2746
"""Report the check results via trace.note.
2748
:param verbose: Requests more detailed display of what was checked,
2751
note('checked branch %s format %s',
2753
self.branch._format)
2756
class Converter5to6(object):
2757
"""Perform an in-place upgrade of format 5 to format 6"""
2759
def convert(self, branch):
2760
# Data for 5 and 6 can peacefully coexist.
2761
format = BzrBranchFormat6()
2762
new_branch = format.open(branch.bzrdir, _found=True)
2764
# Copy source data into target
2765
new_branch._write_last_revision_info(*branch.last_revision_info())
2766
new_branch.set_parent(branch.get_parent())
2767
new_branch.set_bound_location(branch.get_bound_location())
2768
new_branch.set_push_location(branch.get_push_location())
2770
# New branch has no tags by default
2771
new_branch.tags._set_tag_dict({})
2773
# Copying done; now update target format
2774
new_branch._transport.put_bytes('format',
2775
format.get_format_string(),
2776
mode=new_branch.bzrdir._get_file_mode())
2778
# Clean up old files
2779
new_branch._transport.delete('revision-history')
2781
branch.set_parent(None)
2782
except errors.NoSuchFile:
2784
branch.set_bound_location(None)
2787
class Converter6to7(object):
2788
"""Perform an in-place upgrade of format 6 to format 7"""
2790
def convert(self, branch):
2791
format = BzrBranchFormat7()
2792
branch._set_config_location('stacked_on_location', '')
2793
# update target format
2794
branch._transport.put_bytes('format', format.get_format_string())
2798
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2799
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2802
_run_with_write_locked_target will attempt to release the lock it acquires.
2804
If an exception is raised by callable, then that exception *will* be
2805
propagated, even if the unlock attempt raises its own error. Thus
2806
_run_with_write_locked_target should be preferred to simply doing::
2810
return callable(*args, **kwargs)
2815
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2816
# should share code?
2819
result = callable(*args, **kwargs)
2821
exc_info = sys.exc_info()
2825
raise exc_info[0], exc_info[1], exc_info[2]
2831
class InterBranch(InterObject):
2832
"""This class represents operations taking place between two branches.
2834
Its instances have methods like pull() and push() and contain
2835
references to the source and target repositories these operations
2836
can be carried out on.
2840
"""The available optimised InterBranch types."""
2843
def _get_branch_formats_to_test():
2844
"""Return a tuple with the Branch formats to use when testing."""
2845
raise NotImplementedError(self._get_branch_formats_to_test)
2847
def update_revisions(self, stop_revision=None, overwrite=False,
2849
"""Pull in new perfect-fit revisions.
2851
:param stop_revision: Updated until the given revision
2852
:param overwrite: Always set the branch pointer, rather than checking
2853
to see if it is a proper descendant.
2854
:param graph: A Graph object that can be used to query history
2855
information. This can be None.
2858
raise NotImplementedError(self.update_revisions)
2861
class GenericInterBranch(InterBranch):
2862
"""InterBranch implementation that uses public Branch functions.
2866
def _get_branch_formats_to_test():
2867
return BranchFormat._default_format, BranchFormat._default_format
2869
def update_revisions(self, stop_revision=None, overwrite=False,
2871
"""See InterBranch.update_revisions()."""
2872
self.source.lock_read()
2874
other_revno, other_last_revision = self.source.last_revision_info()
2875
stop_revno = None # unknown
2876
if stop_revision is None:
2877
stop_revision = other_last_revision
2878
if _mod_revision.is_null(stop_revision):
2879
# if there are no commits, we're done.
2881
stop_revno = other_revno
2883
# what's the current last revision, before we fetch [and change it
2885
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2886
# we fetch here so that we don't process data twice in the common
2887
# case of having something to pull, and so that the check for
2888
# already merged can operate on the just fetched graph, which will
2889
# be cached in memory.
2890
self.target.fetch(self.source, stop_revision)
2891
# Check to see if one is an ancestor of the other
2894
graph = self.target.repository.get_graph()
2895
if self.target._check_if_descendant_or_diverged(
2896
stop_revision, last_rev, graph, self.source):
2897
# stop_revision is a descendant of last_rev, but we aren't
2898
# overwriting, so we're done.
2900
if stop_revno is None:
2902
graph = self.target.repository.get_graph()
2903
this_revno, this_last_revision = \
2904
self.target.last_revision_info()
2905
stop_revno = graph.find_distance_to_null(stop_revision,
2906
[(other_last_revision, other_revno),
2907
(this_last_revision, this_revno)])
2908
self.target.set_last_revision_info(stop_revno, stop_revision)
2910
self.source.unlock()
2913
def is_compatible(self, source, target):
2914
# GenericBranch uses the public API, so always compatible
2918
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
