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
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 break_lock(self):
103
"""Break a lock if one is present from another instance.
105
Uses the ui factory to ask for confirmation if the lock may be from
108
This will probe the repository for its lock as well.
110
self.control_files.break_lock()
111
self.repository.break_lock()
112
master = self.get_master_branch()
113
if master is not None:
117
def open(base, _unsupported=False, possible_transports=None):
118
"""Open the branch rooted at base.
120
For instance, if the branch is at URL/.bzr/branch,
121
Branch.open(URL) -> a Branch instance.
123
control = bzrdir.BzrDir.open(base, _unsupported,
124
possible_transports=possible_transports)
125
return control.open_branch(_unsupported)
128
def open_from_transport(transport, _unsupported=False):
129
"""Open the branch rooted at transport"""
130
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
131
return control.open_branch(_unsupported)
134
def open_containing(url, possible_transports=None):
135
"""Open an existing branch which contains url.
137
This probes for a branch at url, and searches upwards from there.
139
Basically we keep looking up until we find the control directory or
140
run into the root. If there isn't one, raises NotBranchError.
141
If there is one and it is either an unrecognised format or an unsupported
142
format, UnknownFormatError or UnsupportedFormatError are raised.
143
If there is one, it is returned, along with the unused portion of url.
145
control, relpath = bzrdir.BzrDir.open_containing(url,
147
return control.open_branch(), relpath
149
def _push_should_merge_tags(self):
150
"""Should _basic_push merge this branch's tags into the target?
152
The default implementation returns False if this branch has no tags,
153
and True the rest of the time. Subclasses may override this.
155
return self.supports_tags() and self.tags.get_tag_dict()
157
def get_config(self):
158
return BranchConfig(self)
160
def _get_tags_bytes(self):
161
"""Get the bytes of a serialised tags dict.
163
Note that not all branches support tags, nor do all use the same tags
164
logic: this method is specific to BasicTags. Other tag implementations
165
may use the same method name and behave differently, safely, because
166
of the double-dispatch via
167
format.make_tags->tags_instance->get_tags_dict.
169
:return: The bytes of the tags file.
170
:seealso: Branch._set_tags_bytes.
172
return self._transport.get_bytes('tags')
174
def _get_nick(self, local=False, possible_transports=None):
175
config = self.get_config()
176
# explicit overrides master, but don't look for master if local is True
177
if not local and not config.has_explicit_nickname():
179
master = self.get_master_branch(possible_transports)
180
if master is not None:
181
# return the master branch value
183
except errors.BzrError, e:
184
# Silently fall back to local implicit nick if the master is
186
mutter("Could not connect to bound branch, "
187
"falling back to local nick.\n " + str(e))
188
return config.get_nickname()
190
def _set_nick(self, nick):
191
self.get_config().set_user_option('nickname', nick, warn_masked=True)
193
nick = property(_get_nick, _set_nick)
196
raise NotImplementedError(self.is_locked)
198
def _lefthand_history(self, revision_id, last_rev=None,
200
if 'evil' in debug.debug_flags:
201
mutter_callsite(4, "_lefthand_history scales with history.")
202
# stop_revision must be a descendant of last_revision
203
graph = self.repository.get_graph()
204
if last_rev is not None:
205
if not graph.is_ancestor(last_rev, revision_id):
206
# our previous tip is not merged into stop_revision
207
raise errors.DivergedBranches(self, other_branch)
208
# make a new revision history from the graph
209
parents_map = graph.get_parent_map([revision_id])
210
if revision_id not in parents_map:
211
raise errors.NoSuchRevision(self, revision_id)
212
current_rev_id = revision_id
214
check_not_reserved_id = _mod_revision.check_not_reserved_id
215
# Do not include ghosts or graph origin in revision_history
216
while (current_rev_id in parents_map and
217
len(parents_map[current_rev_id]) > 0):
218
check_not_reserved_id(current_rev_id)
219
new_history.append(current_rev_id)
220
current_rev_id = parents_map[current_rev_id][0]
221
parents_map = graph.get_parent_map([current_rev_id])
222
new_history.reverse()
225
def lock_write(self):
226
raise NotImplementedError(self.lock_write)
229
raise NotImplementedError(self.lock_read)
232
raise NotImplementedError(self.unlock)
234
def peek_lock_mode(self):
235
"""Return lock mode for the Branch: 'r', 'w' or None"""
236
raise NotImplementedError(self.peek_lock_mode)
238
def get_physical_lock_status(self):
239
raise NotImplementedError(self.get_physical_lock_status)
242
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
243
"""Return the revision_id for a dotted revno.
245
:param revno: a tuple like (1,) or (1,1,2)
246
:param _cache_reverse: a private parameter enabling storage
247
of the reverse mapping in a top level cache. (This should
248
only be done in selective circumstances as we want to
249
avoid having the mapping cached multiple times.)
250
:return: the revision_id
251
:raises errors.NoSuchRevision: if the revno doesn't exist
253
rev_id = self._do_dotted_revno_to_revision_id(revno)
255
self._partial_revision_id_to_revno_cache[rev_id] = revno
258
def _do_dotted_revno_to_revision_id(self, revno):
259
"""Worker function for dotted_revno_to_revision_id.
261
Subclasses should override this if they wish to
262
provide a more efficient implementation.
265
return self.get_rev_id(revno[0])
266
revision_id_to_revno = self.get_revision_id_to_revno_map()
267
revision_ids = [revision_id for revision_id, this_revno
268
in revision_id_to_revno.iteritems()
269
if revno == this_revno]
270
if len(revision_ids) == 1:
271
return revision_ids[0]
273
revno_str = '.'.join(map(str, revno))
274
raise errors.NoSuchRevision(self, revno_str)
277
def revision_id_to_dotted_revno(self, revision_id):
278
"""Given a revision id, return its dotted revno.
280
:return: a tuple like (1,) or (400,1,3).
282
return self._do_revision_id_to_dotted_revno(revision_id)
284
def _do_revision_id_to_dotted_revno(self, revision_id):
285
"""Worker function for revision_id_to_revno."""
286
# Try the caches if they are loaded
287
result = self._partial_revision_id_to_revno_cache.get(revision_id)
288
if result is not None:
290
if self._revision_id_to_revno_cache:
291
result = self._revision_id_to_revno_cache.get(revision_id)
293
raise errors.NoSuchRevision(self, revision_id)
294
# Try the mainline as it's optimised
296
revno = self.revision_id_to_revno(revision_id)
298
except errors.NoSuchRevision:
299
# We need to load and use the full revno map after all
300
result = self.get_revision_id_to_revno_map().get(revision_id)
302
raise errors.NoSuchRevision(self, revision_id)
306
def get_revision_id_to_revno_map(self):
307
"""Return the revision_id => dotted revno map.
309
This will be regenerated on demand, but will be cached.
311
:return: A dictionary mapping revision_id => dotted revno.
312
This dictionary should not be modified by the caller.
314
if self._revision_id_to_revno_cache is not None:
315
mapping = self._revision_id_to_revno_cache
317
mapping = self._gen_revno_map()
318
self._cache_revision_id_to_revno(mapping)
319
# TODO: jam 20070417 Since this is being cached, should we be returning
321
# I would rather not, and instead just declare that users should not
322
# modify the return value.
325
def _gen_revno_map(self):
326
"""Create a new mapping from revision ids to dotted revnos.
328
Dotted revnos are generated based on the current tip in the revision
330
This is the worker function for get_revision_id_to_revno_map, which
331
just caches the return value.
333
:return: A dictionary mapping revision_id => dotted revno.
335
revision_id_to_revno = dict((rev_id, revno)
336
for rev_id, depth, revno, end_of_merge
337
in self.iter_merge_sorted_revisions())
338
return revision_id_to_revno
341
def iter_merge_sorted_revisions(self, start_revision_id=None,
342
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
343
"""Walk the revisions for a branch in merge sorted order.
345
Merge sorted order is the output from a merge-aware,
346
topological sort, i.e. all parents come before their
347
children going forward; the opposite for reverse.
349
:param start_revision_id: the revision_id to begin walking from.
350
If None, the branch tip is used.
351
:param stop_revision_id: the revision_id to terminate the walk
352
after. If None, the rest of history is included.
353
:param stop_rule: if stop_revision_id is not None, the precise rule
354
to use for termination:
355
* 'exclude' - leave the stop revision out of the result (default)
356
* 'include' - the stop revision is the last item in the result
357
* 'with-merges' - include the stop revision and all of its
358
merged revisions in the result
359
:param direction: either 'reverse' or 'forward':
360
* reverse means return the start_revision_id first, i.e.
361
start at the most recent revision and go backwards in history
362
* forward returns tuples in the opposite order to reverse.
363
Note in particular that forward does *not* do any intelligent
364
ordering w.r.t. depth as some clients of this API may like.
365
(If required, that ought to be done at higher layers.)
367
:return: an iterator over (revision_id, depth, revno, end_of_merge)
370
* revision_id: the unique id of the revision
371
* depth: How many levels of merging deep this node has been
373
* revno_sequence: This field provides a sequence of
374
revision numbers for all revisions. The format is:
375
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
376
branch that the revno is on. From left to right the REVNO numbers
377
are the sequence numbers within that branch of the revision.
378
* end_of_merge: When True the next node (earlier in history) is
379
part of a different merge.
381
# Note: depth and revno values are in the context of the branch so
382
# we need the full graph to get stable numbers, regardless of the
384
if self._merge_sorted_revisions_cache is None:
385
last_revision = self.last_revision()
386
graph = self.repository.get_graph()
387
parent_map = dict(((key, value) for key, value in
388
graph.iter_ancestry([last_revision]) if value is not None))
389
revision_graph = repository._strip_NULL_ghosts(parent_map)
390
revs = tsort.merge_sort(revision_graph, last_revision, None,
392
# Drop the sequence # before caching
393
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
395
filtered = self._filter_merge_sorted_revisions(
396
self._merge_sorted_revisions_cache, start_revision_id,
397
stop_revision_id, stop_rule)
398
if direction == 'reverse':
400
if direction == 'forward':
401
return reversed(list(filtered))
403
raise ValueError('invalid direction %r' % direction)
405
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
406
start_revision_id, stop_revision_id, stop_rule):
407
"""Iterate over an inclusive range of sorted revisions."""
408
rev_iter = iter(merge_sorted_revisions)
409
if start_revision_id is not None:
410
for rev_id, depth, revno, end_of_merge in rev_iter:
411
if rev_id != start_revision_id:
414
# The decision to include the start or not
415
# depends on the stop_rule if a stop is provided
417
iter([(rev_id, depth, revno, end_of_merge)]),
420
if stop_revision_id is None:
421
for rev_id, depth, revno, end_of_merge in rev_iter:
422
yield rev_id, depth, revno, end_of_merge
423
elif stop_rule == 'exclude':
424
for rev_id, depth, revno, end_of_merge in rev_iter:
425
if rev_id == stop_revision_id:
427
yield rev_id, depth, revno, end_of_merge
428
elif stop_rule == 'include':
429
for rev_id, depth, revno, end_of_merge in rev_iter:
430
yield rev_id, depth, revno, end_of_merge
431
if rev_id == stop_revision_id:
433
elif stop_rule == 'with-merges':
434
stop_rev = self.repository.get_revision(stop_revision_id)
435
if stop_rev.parent_ids:
436
left_parent = stop_rev.parent_ids[0]
438
left_parent = _mod_revision.NULL_REVISION
439
for rev_id, depth, revno, end_of_merge in rev_iter:
440
if rev_id == left_parent:
442
yield rev_id, depth, revno, end_of_merge
444
raise ValueError('invalid stop_rule %r' % stop_rule)
446
def leave_lock_in_place(self):
447
"""Tell this branch object not to release the physical lock when this
450
If lock_write doesn't return a token, then this method is not supported.
452
self.control_files.leave_in_place()
454
def dont_leave_lock_in_place(self):
455
"""Tell this branch object to release the physical lock when this
456
object is unlocked, even if it didn't originally acquire it.
458
If lock_write doesn't return a token, then this method is not supported.
460
self.control_files.dont_leave_in_place()
462
def bind(self, other):
463
"""Bind the local branch the other branch.
465
:param other: The branch to bind to
468
raise errors.UpgradeRequired(self.base)
471
def fetch(self, from_branch, last_revision=None, pb=None):
472
"""Copy revisions from from_branch into this branch.
474
:param from_branch: Where to copy from.
475
:param last_revision: What revision to stop at (None for at the end
477
:param pb: An optional progress bar to use.
480
if self.base == from_branch.base:
483
symbol_versioning.warn(
484
symbol_versioning.deprecated_in((1, 14, 0))
485
% "pb parameter to fetch()")
486
from_branch.lock_read()
488
if last_revision is None:
489
last_revision = from_branch.last_revision()
490
last_revision = _mod_revision.ensure_null(last_revision)
491
return self.repository.fetch(from_branch.repository,
492
revision_id=last_revision,
497
def get_bound_location(self):
498
"""Return the URL of the branch we are bound to.
500
Older format branches cannot bind, please be sure to use a metadir
505
def get_old_bound_location(self):
506
"""Return the URL of the branch we used to be bound to
508
raise errors.UpgradeRequired(self.base)
510
def get_commit_builder(self, parents, config=None, timestamp=None,
511
timezone=None, committer=None, revprops=None,
513
"""Obtain a CommitBuilder for this branch.
515
:param parents: Revision ids of the parents of the new revision.
516
:param config: Optional configuration to use.
517
:param timestamp: Optional timestamp recorded for commit.
518
:param timezone: Optional timezone for timestamp.
519
:param committer: Optional committer to set for commit.
520
:param revprops: Optional dictionary of revision properties.
521
:param revision_id: Optional revision id.
525
config = self.get_config()
527
return self.repository.get_commit_builder(self, parents, config,
528
timestamp, timezone, committer, revprops, revision_id)
530
def get_master_branch(self, possible_transports=None):
531
"""Return the branch we are bound to.
533
:return: Either a Branch, or None
537
def get_revision_delta(self, revno):
538
"""Return the delta for one revision.
540
The delta is relative to its mainline predecessor, or the
541
empty tree for revision 1.
543
rh = self.revision_history()
544
if not (1 <= revno <= len(rh)):
545
raise errors.InvalidRevisionNumber(revno)
546
return self.repository.get_revision_delta(rh[revno-1])
548
def get_stacked_on_url(self):
549
"""Get the URL this branch is stacked against.
551
:raises NotStacked: If the branch is not stacked.
552
:raises UnstackableBranchFormat: If the branch does not support
555
raise NotImplementedError(self.get_stacked_on_url)
557
def print_file(self, file, revision_id):
558
"""Print `file` to stdout."""
559
raise NotImplementedError(self.print_file)
561
def set_revision_history(self, rev_history):
562
raise NotImplementedError(self.set_revision_history)
564
def set_stacked_on_url(self, url):
565
"""Set the URL this branch is stacked against.
567
:raises UnstackableBranchFormat: If the branch does not support
569
:raises UnstackableRepositoryFormat: If the repository does not support
572
raise NotImplementedError(self.set_stacked_on_url)
574
def _set_tags_bytes(self, bytes):
575
"""Mirror method for _get_tags_bytes.
577
:seealso: Branch._get_tags_bytes.
579
return _run_with_write_locked_target(self, self._transport.put_bytes,
582
def _cache_revision_history(self, rev_history):
583
"""Set the cached revision history to rev_history.
585
The revision_history method will use this cache to avoid regenerating
586
the revision history.
588
This API is semi-public; it only for use by subclasses, all other code
589
should consider it to be private.
591
self._revision_history_cache = rev_history
593
def _cache_revision_id_to_revno(self, revision_id_to_revno):
594
"""Set the cached revision_id => revno map to revision_id_to_revno.
596
This API is semi-public; it only for use by subclasses, all other code
597
should consider it to be private.
599
self._revision_id_to_revno_cache = revision_id_to_revno
601
def _clear_cached_state(self):
602
"""Clear any cached data on this branch, e.g. cached revision history.
604
This means the next call to revision_history will need to call
605
_gen_revision_history.
607
This API is semi-public; it only for use by subclasses, all other code
608
should consider it to be private.
610
self._revision_history_cache = None
611
self._revision_id_to_revno_cache = None
612
self._last_revision_info_cache = None
613
self._merge_sorted_revisions_cache = None
615
def _gen_revision_history(self):
616
"""Return sequence of revision hashes on to this branch.
618
Unlike revision_history, this method always regenerates or rereads the
619
revision history, i.e. it does not cache the result, so repeated calls
622
Concrete subclasses should override this instead of revision_history so
623
that subclasses do not need to deal with caching logic.
625
This API is semi-public; it only for use by subclasses, all other code
626
should consider it to be private.
628
raise NotImplementedError(self._gen_revision_history)
631
def revision_history(self):
632
"""Return sequence of revision ids on this branch.
634
This method will cache the revision history for as long as it is safe to
637
if 'evil' in debug.debug_flags:
638
mutter_callsite(3, "revision_history scales with history.")
639
if self._revision_history_cache is not None:
640
history = self._revision_history_cache
642
history = self._gen_revision_history()
643
self._cache_revision_history(history)
647
"""Return current revision number for this branch.
649
That is equivalent to the number of revisions committed to
652
return self.last_revision_info()[0]
655
"""Older format branches cannot bind or unbind."""
656
raise errors.UpgradeRequired(self.base)
658
def set_append_revisions_only(self, enabled):
659
"""Older format branches are never restricted to append-only"""
660
raise errors.UpgradeRequired(self.base)
662
def last_revision(self):
663
"""Return last revision id, or NULL_REVISION."""
664
return self.last_revision_info()[1]
667
def last_revision_info(self):
668
"""Return information about the last revision.
670
:return: A tuple (revno, revision_id).
672
if self._last_revision_info_cache is None:
673
self._last_revision_info_cache = self._last_revision_info()
674
return self._last_revision_info_cache
676
def _last_revision_info(self):
677
rh = self.revision_history()
680
return (revno, rh[-1])
682
return (0, _mod_revision.NULL_REVISION)
684
@deprecated_method(deprecated_in((1, 6, 0)))
685
def missing_revisions(self, other, stop_revision=None):
686
"""Return a list of new revisions that would perfectly fit.
688
If self and other have not diverged, return a list of the revisions
689
present in other, but missing from self.
691
self_history = self.revision_history()
692
self_len = len(self_history)
693
other_history = other.revision_history()
694
other_len = len(other_history)
695
common_index = min(self_len, other_len) -1
696
if common_index >= 0 and \
697
self_history[common_index] != other_history[common_index]:
698
raise errors.DivergedBranches(self, other)
700
if stop_revision is None:
701
stop_revision = other_len
703
if stop_revision > other_len:
704
raise errors.NoSuchRevision(self, stop_revision)
705
return other_history[self_len:stop_revision]
708
def update_revisions(self, other, stop_revision=None, overwrite=False,
710
"""Pull in new perfect-fit revisions.
712
:param other: Another Branch to pull from
713
:param stop_revision: Updated until the given revision
714
:param overwrite: Always set the branch pointer, rather than checking
715
to see if it is a proper descendant.
716
:param graph: A Graph object that can be used to query history
717
information. This can be None.
720
return InterBranch.get(other, self).update_revisions(stop_revision,
723
def import_last_revision_info(self, source_repo, revno, revid):
724
"""Set the last revision info, importing from another repo if necessary.
726
This is used by the bound branch code to upload a revision to
727
the master branch first before updating the tip of the local branch.
729
:param source_repo: Source repository to optionally fetch from
730
:param revno: Revision number of the new tip
731
:param revid: Revision id of the new tip
733
if not self.repository.has_same_location(source_repo):
734
self.repository.fetch(source_repo, revision_id=revid)
735
self.set_last_revision_info(revno, revid)
737
def revision_id_to_revno(self, revision_id):
738
"""Given a revision id, return its revno"""
739
if _mod_revision.is_null(revision_id):
741
history = self.revision_history()
743
return history.index(revision_id) + 1
745
raise errors.NoSuchRevision(self, revision_id)
747
def get_rev_id(self, revno, history=None):
748
"""Find the revision id of the specified revno."""
750
return _mod_revision.NULL_REVISION
752
history = self.revision_history()
753
if revno <= 0 or revno > len(history):
754
raise errors.NoSuchRevision(self, revno)
755
return history[revno - 1]
757
def pull(self, source, overwrite=False, stop_revision=None,
758
possible_transports=None, _override_hook_target=None):
759
"""Mirror source into this branch.
761
This branch is considered to be 'local', having low latency.
763
:returns: PullResult instance
765
raise NotImplementedError(self.pull)
767
def push(self, target, overwrite=False, stop_revision=None, *args,
769
"""Mirror this branch into target.
771
This branch is considered to be 'local', having low latency.
773
return InterBranch.get(self, target).push(overwrite, stop_revision,
776
def basis_tree(self):
777
"""Return `Tree` object for last revision."""
778
return self.repository.revision_tree(self.last_revision())
780
def get_parent(self):
781
"""Return the parent location of the branch.
783
This is the default location for pull/missing. The usual
784
pattern is that the user can override it by specifying a
787
parent = self._get_parent_location()
790
# This is an old-format absolute path to a local branch
792
if parent.startswith('/'):
793
parent = urlutils.local_path_to_url(parent.decode('utf8'))
795
return urlutils.join(self.base[:-1], parent)
796
except errors.InvalidURLJoin, e:
797
raise errors.InaccessibleParent(parent, self.base)
799
def _get_parent_location(self):
800
raise NotImplementedError(self._get_parent_location)
802
def _set_config_location(self, name, url, config=None,
803
make_relative=False):
805
config = self.get_config()
809
url = urlutils.relative_url(self.base, url)
810
config.set_user_option(name, url, warn_masked=True)
812
def _get_config_location(self, name, config=None):
814
config = self.get_config()
815
location = config.get_user_option(name)
820
def get_submit_branch(self):
821
"""Return the submit location of the branch.
823
This is the default location for bundle. The usual
824
pattern is that the user can override it by specifying a
827
return self.get_config().get_user_option('submit_branch')
829
def set_submit_branch(self, location):
830
"""Return the submit location of the branch.
832
This is the default location for bundle. The usual
833
pattern is that the user can override it by specifying a
836
self.get_config().set_user_option('submit_branch', location,
839
def get_public_branch(self):
840
"""Return the public location of the branch.
842
This is is used by merge directives.
844
return self._get_config_location('public_branch')
846
def set_public_branch(self, location):
847
"""Return the submit location of the branch.
849
This is the default location for bundle. The usual
850
pattern is that the user can override it by specifying a
853
self._set_config_location('public_branch', location)
855
def get_push_location(self):
856
"""Return the None or the location to push this branch to."""
857
push_loc = self.get_config().get_user_option('push_location')
860
def set_push_location(self, location):
861
"""Set a new push location for this branch."""
862
raise NotImplementedError(self.set_push_location)
864
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
865
"""Run the post_change_branch_tip hooks."""
866
hooks = Branch.hooks['post_change_branch_tip']
869
new_revno, new_revid = self.last_revision_info()
870
params = ChangeBranchTipParams(
871
self, old_revno, new_revno, old_revid, new_revid)
875
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
876
"""Run the pre_change_branch_tip hooks."""
877
hooks = Branch.hooks['pre_change_branch_tip']
880
old_revno, old_revid = self.last_revision_info()
881
params = ChangeBranchTipParams(
882
self, old_revno, new_revno, old_revid, new_revid)
886
except errors.TipChangeRejected:
889
exc_info = sys.exc_info()
890
hook_name = Branch.hooks.get_hook_name(hook)
891
raise errors.HookFailed(
892
'pre_change_branch_tip', hook_name, exc_info)
894
def set_parent(self, url):
895
raise NotImplementedError(self.set_parent)
899
"""Synchronise this branch with the master branch if any.
901
:return: None or the last_revision pivoted out during the update.
905
def check_revno(self, revno):
907
Check whether a revno corresponds to any revision.
908
Zero (the NULL revision) is considered valid.
911
self.check_real_revno(revno)
913
def check_real_revno(self, revno):
915
Check whether a revno corresponds to a real revision.
916
Zero (the NULL revision) is considered invalid
918
if revno < 1 or revno > self.revno():
919
raise errors.InvalidRevisionNumber(revno)
922
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
923
"""Clone this branch into to_bzrdir preserving all semantic values.
925
Most API users will want 'create_clone_on_transport', which creates a
926
new bzrdir and branch on the fly.
928
revision_id: if not None, the revision history in the new branch will
929
be truncated to end with revision_id.
931
result = to_bzrdir.create_branch()
932
if repository_policy is not None:
933
repository_policy.configure_branch(result)
934
self.copy_content_into(result, revision_id=revision_id)
938
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
939
"""Create a new line of development from the branch, into to_bzrdir.
941
to_bzrdir controls the branch format.
943
revision_id: if not None, the revision history in the new branch will
944
be truncated to end with revision_id.
946
result = to_bzrdir.create_branch()
947
if repository_policy is not None:
948
repository_policy.configure_branch(result)
949
self.copy_content_into(result, revision_id=revision_id)
950
result.set_parent(self.bzrdir.root_transport.base)
953
def _synchronize_history(self, destination, revision_id):
954
"""Synchronize last revision and revision history between branches.
956
This version is most efficient when the destination is also a
957
BzrBranch6, but works for BzrBranch5, as long as the destination's
958
repository contains all the lefthand ancestors of the intended
959
last_revision. If not, set_last_revision_info will fail.
961
:param destination: The branch to copy the history into
962
:param revision_id: The revision-id to truncate history at. May
963
be None to copy complete history.
965
source_revno, source_revision_id = self.last_revision_info()
966
if revision_id is None:
967
revno, revision_id = source_revno, source_revision_id
968
elif source_revision_id == revision_id:
969
# we know the revno without needing to walk all of history
972
# To figure out the revno for a random revision, we need to build
973
# the revision history, and count its length.
974
# We don't care about the order, just how long it is.
975
# Alternatively, we could start at the current location, and count
976
# backwards. But there is no guarantee that we will find it since
977
# it may be a merged revision.
978
revno = len(list(self.repository.iter_reverse_revision_history(
980
destination.set_last_revision_info(revno, revision_id)
983
def copy_content_into(self, destination, revision_id=None):
984
"""Copy the content of self into destination.
986
revision_id: if not None, the revision history in the new branch will
987
be truncated to end with revision_id.
989
self._synchronize_history(destination, revision_id)
991
parent = self.get_parent()
992
except errors.InaccessibleParent, e:
993
mutter('parent was not accessible to copy: %s', e)
996
destination.set_parent(parent)
997
if self._push_should_merge_tags():
998
self.tags.merge_to(destination.tags)
1002
"""Check consistency of the branch.
1004
In particular this checks that revisions given in the revision-history
1005
do actually match up in the revision graph, and that they're all
1006
present in the repository.
1008
Callers will typically also want to check the repository.
1010
:return: A BranchCheckResult.
1012
mainline_parent_id = None
1013
last_revno, last_revision_id = self.last_revision_info()
1014
real_rev_history = list(self.repository.iter_reverse_revision_history(
1016
real_rev_history.reverse()
1017
if len(real_rev_history) != last_revno:
1018
raise errors.BzrCheckError('revno does not match len(mainline)'
1019
' %s != %s' % (last_revno, len(real_rev_history)))
1020
# TODO: We should probably also check that real_rev_history actually
1021
# matches self.revision_history()
1022
for revision_id in real_rev_history:
1024
revision = self.repository.get_revision(revision_id)
1025
except errors.NoSuchRevision, e:
1026
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1028
# In general the first entry on the revision history has no parents.
1029
# But it's not illegal for it to have parents listed; this can happen
1030
# in imports from Arch when the parents weren't reachable.
1031
if mainline_parent_id is not None:
1032
if mainline_parent_id not in revision.parent_ids:
1033
raise errors.BzrCheckError("previous revision {%s} not listed among "
1035
% (mainline_parent_id, revision_id))
1036
mainline_parent_id = revision_id
1037
return BranchCheckResult(self)
1039
def _get_checkout_format(self):
1040
"""Return the most suitable metadir for a checkout of this branch.
1041
Weaves are used if this branch's repository uses weaves.
1043
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1044
from bzrlib.repofmt import weaverepo
1045
format = bzrdir.BzrDirMetaFormat1()
1046
format.repository_format = weaverepo.RepositoryFormat7()
1048
format = self.repository.bzrdir.checkout_metadir()
1049
format.set_branch_format(self._format)
1052
def create_clone_on_transport(self, to_transport, revision_id=None,
1054
"""Create a clone of this branch and its bzrdir.
1056
:param to_transport: The transport to clone onto.
1057
:param revision_id: The revision id to use as tip in the new branch.
1058
If None the tip is obtained from this branch.
1059
:param stacked_on: An optional URL to stack the clone on.
1061
# XXX: Fix the bzrdir API to allow getting the branch back from the
1062
# clone call. Or something. 20090224 RBC/spiv.
1063
dir_to = self.bzrdir.clone_on_transport(to_transport,
1064
revision_id=revision_id, stacked_on=stacked_on)
1065
return dir_to.open_branch()
1067
def create_checkout(self, to_location, revision_id=None,
1068
lightweight=False, accelerator_tree=None,
1070
"""Create a checkout of a branch.
1072
:param to_location: The url to produce the checkout at
1073
:param revision_id: The revision to check out
1074
:param lightweight: If True, produce a lightweight checkout, otherwise,
1075
produce a bound branch (heavyweight checkout)
1076
:param accelerator_tree: A tree which can be used for retrieving file
1077
contents more quickly than the revision tree, i.e. a workingtree.
1078
The revision tree will be used for cases where accelerator_tree's
1079
content is different.
1080
:param hardlink: If true, hard-link files from accelerator_tree,
1082
:return: The tree of the created checkout
1084
t = transport.get_transport(to_location)
1087
format = self._get_checkout_format()
1088
checkout = format.initialize_on_transport(t)
1089
from_branch = BranchReferenceFormat().initialize(checkout, self)
1091
format = self._get_checkout_format()
1092
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1093
to_location, force_new_tree=False, format=format)
1094
checkout = checkout_branch.bzrdir
1095
checkout_branch.bind(self)
1096
# pull up to the specified revision_id to set the initial
1097
# branch tip correctly, and seed it with history.
1098
checkout_branch.pull(self, stop_revision=revision_id)
1100
tree = checkout.create_workingtree(revision_id,
1101
from_branch=from_branch,
1102
accelerator_tree=accelerator_tree,
1104
basis_tree = tree.basis_tree()
1105
basis_tree.lock_read()
1107
for path, file_id in basis_tree.iter_references():
1108
reference_parent = self.reference_parent(file_id, path)
1109
reference_parent.create_checkout(tree.abspath(path),
1110
basis_tree.get_reference_revision(file_id, path),
1117
def reconcile(self, thorough=True):
1118
"""Make sure the data stored in this branch is consistent."""
1119
from bzrlib.reconcile import BranchReconciler
1120
reconciler = BranchReconciler(self, thorough=thorough)
1121
reconciler.reconcile()
1124
def reference_parent(self, file_id, path):
1125
"""Return the parent branch for a tree-reference file_id
1126
:param file_id: The file_id of the tree reference
1127
:param path: The path of the file_id in the tree
1128
:return: A branch associated with the file_id
1130
# FIXME should provide multiple branches, based on config
1131
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1133
def supports_tags(self):
1134
return self._format.supports_tags()
1136
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1138
"""Ensure that revision_b is a descendant of revision_a.
1140
This is a helper function for update_revisions.
1142
:raises: DivergedBranches if revision_b has diverged from revision_a.
1143
:returns: True if revision_b is a descendant of revision_a.
1145
relation = self._revision_relations(revision_a, revision_b, graph)
1146
if relation == 'b_descends_from_a':
1148
elif relation == 'diverged':
1149
raise errors.DivergedBranches(self, other_branch)
1150
elif relation == 'a_descends_from_b':
1153
raise AssertionError("invalid relation: %r" % (relation,))
1155
def _revision_relations(self, revision_a, revision_b, graph):
1156
"""Determine the relationship between two revisions.
1158
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1160
heads = graph.heads([revision_a, revision_b])
1161
if heads == set([revision_b]):
1162
return 'b_descends_from_a'
1163
elif heads == set([revision_a, revision_b]):
1164
# These branches have diverged
1166
elif heads == set([revision_a]):
1167
return 'a_descends_from_b'
1169
raise AssertionError("invalid heads: %r" % (heads,))
1172
class BranchFormat(object):
1173
"""An encapsulation of the initialization and open routines for a format.
1175
Formats provide three things:
1176
* An initialization routine,
1180
Formats are placed in an dict by their format string for reference
1181
during branch opening. Its not required that these be instances, they
1182
can be classes themselves with class methods - it simply depends on
1183
whether state is needed for a given format or not.
1185
Once a format is deprecated, just deprecate the initialize and open
1186
methods on the format class. Do not deprecate the object, as the
1187
object will be created every time regardless.
1190
_default_format = None
1191
"""The default format used for new branches."""
1194
"""The known formats."""
1196
def __eq__(self, other):
1197
return self.__class__ is other.__class__
1199
def __ne__(self, other):
1200
return not (self == other)
1203
def find_format(klass, a_bzrdir):
1204
"""Return the format for the branch object in a_bzrdir."""
1206
transport = a_bzrdir.get_branch_transport(None)
1207
format_string = transport.get("format").read()
1208
return klass._formats[format_string]
1209
except errors.NoSuchFile:
1210
raise errors.NotBranchError(path=transport.base)
1212
raise errors.UnknownFormatError(format=format_string, kind='branch')
1215
def get_default_format(klass):
1216
"""Return the current default format."""
1217
return klass._default_format
1219
def get_reference(self, a_bzrdir):
1220
"""Get the target reference of the branch in a_bzrdir.
1222
format probing must have been completed before calling
1223
this method - it is assumed that the format of the branch
1224
in a_bzrdir is correct.
1226
:param a_bzrdir: The bzrdir to get the branch data from.
1227
:return: None if the branch is not a reference branch.
1232
def set_reference(self, a_bzrdir, to_branch):
1233
"""Set the target reference of the branch in a_bzrdir.
1235
format probing must have been completed before calling
1236
this method - it is assumed that the format of the branch
1237
in a_bzrdir is correct.
1239
:param a_bzrdir: The bzrdir to set the branch reference for.
1240
:param to_branch: branch that the checkout is to reference
1242
raise NotImplementedError(self.set_reference)
1244
def get_format_string(self):
1245
"""Return the ASCII format string that identifies this format."""
1246
raise NotImplementedError(self.get_format_string)
1248
def get_format_description(self):
1249
"""Return the short format description for this format."""
1250
raise NotImplementedError(self.get_format_description)
1252
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1254
"""Initialize a branch in a bzrdir, with specified files
1256
:param a_bzrdir: The bzrdir to initialize the branch in
1257
:param utf8_files: The files to create as a list of
1258
(filename, content) tuples
1259
:param set_format: If True, set the format with
1260
self.get_format_string. (BzrBranch4 has its format set
1262
:return: a branch in this format
1264
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1265
branch_transport = a_bzrdir.get_branch_transport(self)
1267
'metadir': ('lock', lockdir.LockDir),
1268
'branch4': ('branch-lock', lockable_files.TransportLock),
1270
lock_name, lock_class = lock_map[lock_type]
1271
control_files = lockable_files.LockableFiles(branch_transport,
1272
lock_name, lock_class)
1273
control_files.create_lock()
1274
control_files.lock_write()
1276
utf8_files += [('format', self.get_format_string())]
1278
for (filename, content) in utf8_files:
1279
branch_transport.put_bytes(
1281
mode=a_bzrdir._get_file_mode())
1283
control_files.unlock()
1284
return self.open(a_bzrdir, _found=True)
1286
def initialize(self, a_bzrdir):
1287
"""Create a branch of this format in a_bzrdir."""
1288
raise NotImplementedError(self.initialize)
1290
def is_supported(self):
1291
"""Is this format supported?
1293
Supported formats can be initialized and opened.
1294
Unsupported formats may not support initialization or committing or
1295
some other features depending on the reason for not being supported.
1299
def make_tags(self, branch):
1300
"""Create a tags object for branch.
1302
This method is on BranchFormat, because BranchFormats are reflected
1303
over the wire via network_name(), whereas full Branch instances require
1304
multiple VFS method calls to operate at all.
1306
The default implementation returns a disabled-tags instance.
1308
Note that it is normal for branch to be a RemoteBranch when using tags
1311
return DisabledTags(branch)
1313
def network_name(self):
1314
"""A simple byte string uniquely identifying this format for RPC calls.
1316
MetaDir branch formats use their disk format string to identify the
1317
repository over the wire. All in one formats such as bzr < 0.8, and
1318
foreign formats like svn/git and hg should use some marker which is
1319
unique and immutable.
1321
raise NotImplementedError(self.network_name)
1323
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1324
"""Return the branch object for a_bzrdir
1326
:param a_bzrdir: A BzrDir that contains a branch.
1327
:param _found: a private parameter, do not use it. It is used to
1328
indicate if format probing has already be done.
1329
:param ignore_fallbacks: when set, no fallback branches will be opened
1330
(if there are any). Default is to open fallbacks.
1332
raise NotImplementedError(self.open)
1335
def register_format(klass, format):
1336
"""Register a metadir format."""
1337
klass._formats[format.get_format_string()] = format
1338
# Metadir formats have a network name of their format string, and get
1339
# registered as class factories.
1340
network_format_registry.register(format.get_format_string(), format.__class__)
1343
def set_default_format(klass, format):
1344
klass._default_format = format
1346
def supports_stacking(self):
1347
"""True if this format records a stacked-on branch."""
1351
def unregister_format(klass, format):
1352
del klass._formats[format.get_format_string()]
1355
return self.get_format_description().rstrip()
1357
def supports_tags(self):
1358
"""True if this format supports tags stored in the branch"""
1359
return False # by default
1362
class BranchHooks(Hooks):
1363
"""A dictionary mapping hook name to a list of callables for branch hooks.
1365
e.g. ['set_rh'] Is the list of items to be called when the
1366
set_revision_history function is invoked.
1370
"""Create the default hooks.
1372
These are all empty initially, because by default nothing should get
1375
Hooks.__init__(self)
1376
self.create_hook(HookPoint('set_rh',
1377
"Invoked whenever the revision history has been set via "
1378
"set_revision_history. The api signature is (branch, "
1379
"revision_history), and the branch will be write-locked. "
1380
"The set_rh hook can be expensive for bzr to trigger, a better "
1381
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1382
self.create_hook(HookPoint('open',
1383
"Called with the Branch object that has been opened after a "
1384
"branch is opened.", (1, 8), None))
1385
self.create_hook(HookPoint('post_push',
1386
"Called after a push operation completes. post_push is called "
1387
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1388
"bzr client.", (0, 15), None))
1389
self.create_hook(HookPoint('post_pull',
1390
"Called after a pull operation completes. post_pull is called "
1391
"with a bzrlib.branch.PullResult object and only runs in the "
1392
"bzr client.", (0, 15), None))
1393
self.create_hook(HookPoint('pre_commit',
1394
"Called after a commit is calculated but before it is is "
1395
"completed. pre_commit is called with (local, master, old_revno, "
1396
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1397
"). old_revid is NULL_REVISION for the first commit to a branch, "
1398
"tree_delta is a TreeDelta object describing changes from the "
1399
"basis revision. hooks MUST NOT modify this delta. "
1400
" future_tree is an in-memory tree obtained from "
1401
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1402
"tree.", (0,91), None))
1403
self.create_hook(HookPoint('post_commit',
1404
"Called in the bzr client after a commit has completed. "
1405
"post_commit is called with (local, master, old_revno, old_revid, "
1406
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1407
"commit to a branch.", (0, 15), None))
1408
self.create_hook(HookPoint('post_uncommit',
1409
"Called in the bzr client after an uncommit completes. "
1410
"post_uncommit is called with (local, master, old_revno, "
1411
"old_revid, new_revno, new_revid) where local is the local branch "
1412
"or None, master is the target branch, and an empty branch "
1413
"recieves new_revno of 0, new_revid of None.", (0, 15), None))
1414
self.create_hook(HookPoint('pre_change_branch_tip',
1415
"Called in bzr client and server before a change to the tip of a "
1416
"branch is made. pre_change_branch_tip is called with a "
1417
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1418
"commit, uncommit will all trigger this hook.", (1, 6), None))
1419
self.create_hook(HookPoint('post_change_branch_tip',
1420
"Called in bzr client and server after a change to the tip of a "
1421
"branch is made. post_change_branch_tip is called with a "
1422
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1423
"commit, uncommit will all trigger this hook.", (1, 4), None))
1424
self.create_hook(HookPoint('transform_fallback_location',
1425
"Called when a stacked branch is activating its fallback "
1426
"locations. transform_fallback_location is called with (branch, "
1427
"url), and should return a new url. Returning the same url "
1428
"allows it to be used as-is, returning a different one can be "
1429
"used to cause the branch to stack on a closer copy of that "
1430
"fallback_location. Note that the branch cannot have history "
1431
"accessing methods called on it during this hook because the "
1432
"fallback locations have not been activated. When there are "
1433
"multiple hooks installed for transform_fallback_location, "
1434
"all are called with the url returned from the previous hook."
1435
"The order is however undefined.", (1, 9), None))
1438
# install the default hooks into the Branch class.
1439
Branch.hooks = BranchHooks()
1442
class ChangeBranchTipParams(object):
1443
"""Object holding parameters passed to *_change_branch_tip hooks.
1445
There are 5 fields that hooks may wish to access:
1447
:ivar branch: the branch being changed
1448
:ivar old_revno: revision number before the change
1449
:ivar new_revno: revision number after the change
1450
:ivar old_revid: revision id before the change
1451
:ivar new_revid: revision id after the change
1453
The revid fields are strings. The revno fields are integers.
1456
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1457
"""Create a group of ChangeBranchTip parameters.
1459
:param branch: The branch being changed.
1460
:param old_revno: Revision number before the change.
1461
:param new_revno: Revision number after the change.
1462
:param old_revid: Tip revision id before the change.
1463
:param new_revid: Tip revision id after the change.
1465
self.branch = branch
1466
self.old_revno = old_revno
1467
self.new_revno = new_revno
1468
self.old_revid = old_revid
1469
self.new_revid = new_revid
1471
def __eq__(self, other):
1472
return self.__dict__ == other.__dict__
1475
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1476
self.__class__.__name__, self.branch,
1477
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1480
class BzrBranchFormat4(BranchFormat):
1481
"""Bzr branch format 4.
1484
- a revision-history file.
1485
- a branch-lock lock file [ to be shared with the bzrdir ]
1488
def get_format_description(self):
1489
"""See BranchFormat.get_format_description()."""
1490
return "Branch format 4"
1492
def initialize(self, a_bzrdir):
1493
"""Create a branch of this format in a_bzrdir."""
1494
utf8_files = [('revision-history', ''),
1495
('branch-name', ''),
1497
return self._initialize_helper(a_bzrdir, utf8_files,
1498
lock_type='branch4', set_format=False)
1501
super(BzrBranchFormat4, self).__init__()
1502
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1504
def network_name(self):
1505
"""The network name for this format is the control dirs disk label."""
1506
return self._matchingbzrdir.get_format_string()
1508
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1509
"""See BranchFormat.open()."""
1511
# we are being called directly and must probe.
1512
raise NotImplementedError
1513
return BzrBranch(_format=self,
1514
_control_files=a_bzrdir._control_files,
1516
_repository=a_bzrdir.open_repository())
1519
return "Bazaar-NG branch format 4"
1522
class BranchFormatMetadir(BranchFormat):
1523
"""Common logic for meta-dir based branch formats."""
1525
def _branch_class(self):
1526
"""What class to instantiate on open calls."""
1527
raise NotImplementedError(self._branch_class)
1529
def network_name(self):
1530
"""A simple byte string uniquely identifying this format for RPC calls.
1532
Metadir branch formats use their format string.
1534
return self.get_format_string()
1536
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1537
"""See BranchFormat.open()."""
1539
format = BranchFormat.find_format(a_bzrdir)
1540
if format.__class__ != self.__class__:
1541
raise AssertionError("wrong format %r found for %r" %
1544
transport = a_bzrdir.get_branch_transport(None)
1545
control_files = lockable_files.LockableFiles(transport, 'lock',
1547
return self._branch_class()(_format=self,
1548
_control_files=control_files,
1550
_repository=a_bzrdir.find_repository(),
1551
ignore_fallbacks=ignore_fallbacks)
1552
except errors.NoSuchFile:
1553
raise errors.NotBranchError(path=transport.base)
1556
super(BranchFormatMetadir, self).__init__()
1557
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1558
self._matchingbzrdir.set_branch_format(self)
1560
def supports_tags(self):
1564
class BzrBranchFormat5(BranchFormatMetadir):
1565
"""Bzr branch format 5.
1568
- a revision-history file.
1570
- a lock dir guarding the branch itself
1571
- all of this stored in a branch/ subdirectory
1572
- works with shared repositories.
1574
This format is new in bzr 0.8.
1577
def _branch_class(self):
1580
def get_format_string(self):
1581
"""See BranchFormat.get_format_string()."""
1582
return "Bazaar-NG branch format 5\n"
1584
def get_format_description(self):
1585
"""See BranchFormat.get_format_description()."""
1586
return "Branch format 5"
1588
def initialize(self, a_bzrdir):
1589
"""Create a branch of this format in a_bzrdir."""
1590
utf8_files = [('revision-history', ''),
1591
('branch-name', ''),
1593
return self._initialize_helper(a_bzrdir, utf8_files)
1595
def supports_tags(self):
1599
class BzrBranchFormat6(BranchFormatMetadir):
1600
"""Branch format with last-revision and tags.
1602
Unlike previous formats, this has no explicit revision history. Instead,
1603
this just stores the last-revision, and the left-hand history leading
1604
up to there is the history.
1606
This format was introduced in bzr 0.15
1607
and became the default in 0.91.
1610
def _branch_class(self):
1613
def get_format_string(self):
1614
"""See BranchFormat.get_format_string()."""
1615
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1617
def get_format_description(self):
1618
"""See BranchFormat.get_format_description()."""
1619
return "Branch format 6"
1621
def initialize(self, a_bzrdir):
1622
"""Create a branch of this format in a_bzrdir."""
1623
utf8_files = [('last-revision', '0 null:\n'),
1624
('branch.conf', ''),
1627
return self._initialize_helper(a_bzrdir, utf8_files)
1629
def make_tags(self, branch):
1630
"""See bzrlib.branch.BranchFormat.make_tags()."""
1631
return BasicTags(branch)
1635
class BzrBranchFormat7(BranchFormatMetadir):
1636
"""Branch format with last-revision, tags, and a stacked location pointer.
1638
The stacked location pointer is passed down to the repository and requires
1639
a repository format with supports_external_lookups = True.
1641
This format was introduced in bzr 1.6.
1644
def _branch_class(self):
1647
def get_format_string(self):
1648
"""See BranchFormat.get_format_string()."""
1649
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1651
def get_format_description(self):
1652
"""See BranchFormat.get_format_description()."""
1653
return "Branch format 7"
1655
def initialize(self, a_bzrdir):
1656
"""Create a branch of this format in a_bzrdir."""
1657
utf8_files = [('last-revision', '0 null:\n'),
1658
('branch.conf', ''),
1661
return self._initialize_helper(a_bzrdir, utf8_files)
1664
super(BzrBranchFormat7, self).__init__()
1665
self._matchingbzrdir.repository_format = \
1666
RepositoryFormatKnitPack5RichRoot()
1668
def make_tags(self, branch):
1669
"""See bzrlib.branch.BranchFormat.make_tags()."""
1670
return BasicTags(branch)
1672
def supports_stacking(self):
1676
class BranchReferenceFormat(BranchFormat):
1677
"""Bzr branch reference format.
1679
Branch references are used in implementing checkouts, they
1680
act as an alias to the real branch which is at some other url.
1687
def get_format_string(self):
1688
"""See BranchFormat.get_format_string()."""
1689
return "Bazaar-NG Branch Reference Format 1\n"
1691
def get_format_description(self):
1692
"""See BranchFormat.get_format_description()."""
1693
return "Checkout reference format 1"
1695
def get_reference(self, a_bzrdir):
1696
"""See BranchFormat.get_reference()."""
1697
transport = a_bzrdir.get_branch_transport(None)
1698
return transport.get('location').read()
1700
def set_reference(self, a_bzrdir, to_branch):
1701
"""See BranchFormat.set_reference()."""
1702
transport = a_bzrdir.get_branch_transport(None)
1703
location = transport.put_bytes('location', to_branch.base)
1705
def initialize(self, a_bzrdir, target_branch=None):
1706
"""Create a branch of this format in a_bzrdir."""
1707
if target_branch is None:
1708
# this format does not implement branch itself, thus the implicit
1709
# creation contract must see it as uninitializable
1710
raise errors.UninitializableFormat(self)
1711
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1712
branch_transport = a_bzrdir.get_branch_transport(self)
1713
branch_transport.put_bytes('location',
1714
target_branch.bzrdir.root_transport.base)
1715
branch_transport.put_bytes('format', self.get_format_string())
1717
a_bzrdir, _found=True,
1718
possible_transports=[target_branch.bzrdir.root_transport])
1721
super(BranchReferenceFormat, self).__init__()
1722
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1723
self._matchingbzrdir.set_branch_format(self)
1725
def _make_reference_clone_function(format, a_branch):
1726
"""Create a clone() routine for a branch dynamically."""
1727
def clone(to_bzrdir, revision_id=None,
1728
repository_policy=None):
1729
"""See Branch.clone()."""
1730
return format.initialize(to_bzrdir, a_branch)
1731
# cannot obey revision_id limits when cloning a reference ...
1732
# FIXME RBC 20060210 either nuke revision_id for clone, or
1733
# emit some sort of warning/error to the caller ?!
1736
def open(self, a_bzrdir, _found=False, location=None,
1737
possible_transports=None, ignore_fallbacks=False):
1738
"""Return the branch that the branch reference in a_bzrdir points at.
1740
:param a_bzrdir: A BzrDir that contains a branch.
1741
:param _found: a private parameter, do not use it. It is used to
1742
indicate if format probing has already be done.
1743
:param ignore_fallbacks: when set, no fallback branches will be opened
1744
(if there are any). Default is to open fallbacks.
1745
:param location: The location of the referenced branch. If
1746
unspecified, this will be determined from the branch reference in
1748
:param possible_transports: An optional reusable transports list.
1751
format = BranchFormat.find_format(a_bzrdir)
1752
if format.__class__ != self.__class__:
1753
raise AssertionError("wrong format %r found for %r" %
1755
if location is None:
1756
location = self.get_reference(a_bzrdir)
1757
real_bzrdir = bzrdir.BzrDir.open(
1758
location, possible_transports=possible_transports)
1759
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1760
# this changes the behaviour of result.clone to create a new reference
1761
# rather than a copy of the content of the branch.
1762
# I did not use a proxy object because that needs much more extensive
1763
# testing, and we are only changing one behaviour at the moment.
1764
# If we decide to alter more behaviours - i.e. the implicit nickname
1765
# then this should be refactored to introduce a tested proxy branch
1766
# and a subclass of that for use in overriding clone() and ....
1768
result.clone = self._make_reference_clone_function(result)
1772
network_format_registry = registry.FormatRegistry()
1773
"""Registry of formats indexed by their network name.
1775
The network name for a branch format is an identifier that can be used when
1776
referring to formats with smart server operations. See
1777
BranchFormat.network_name() for more detail.
1781
# formats which have no format string are not discoverable
1782
# and not independently creatable, so are not registered.
1783
__format5 = BzrBranchFormat5()
1784
__format6 = BzrBranchFormat6()
1785
__format7 = BzrBranchFormat7()
1786
BranchFormat.register_format(__format5)
1787
BranchFormat.register_format(BranchReferenceFormat())
1788
BranchFormat.register_format(__format6)
1789
BranchFormat.register_format(__format7)
1790
BranchFormat.set_default_format(__format6)
1791
_legacy_formats = [BzrBranchFormat4(),
1793
network_format_registry.register(
1794
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1797
class BzrBranch(Branch):
1798
"""A branch stored in the actual filesystem.
1800
Note that it's "local" in the context of the filesystem; it doesn't
1801
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1802
it's writable, and can be accessed via the normal filesystem API.
1804
:ivar _transport: Transport for file operations on this branch's
1805
control files, typically pointing to the .bzr/branch directory.
1806
:ivar repository: Repository for this branch.
1807
:ivar base: The url of the base directory for this branch; the one
1808
containing the .bzr directory.
1811
def __init__(self, _format=None,
1812
_control_files=None, a_bzrdir=None, _repository=None,
1813
ignore_fallbacks=False):
1814
"""Create new branch object at a particular location."""
1815
if a_bzrdir is None:
1816
raise ValueError('a_bzrdir must be supplied')
1818
self.bzrdir = a_bzrdir
1819
self._base = self.bzrdir.transport.clone('..').base
1820
# XXX: We should be able to just do
1821
# self.base = self.bzrdir.root_transport.base
1822
# but this does not quite work yet -- mbp 20080522
1823
self._format = _format
1824
if _control_files is None:
1825
raise ValueError('BzrBranch _control_files is None')
1826
self.control_files = _control_files
1827
self._transport = _control_files._transport
1828
self.repository = _repository
1829
Branch.__init__(self)
1832
return '%s(%r)' % (self.__class__.__name__, self.base)
1836
def _get_base(self):
1837
"""Returns the directory containing the control directory."""
1840
base = property(_get_base, doc="The URL for the root of this branch.")
1842
def is_locked(self):
1843
return self.control_files.is_locked()
1845
def lock_write(self, token=None):
1846
repo_token = self.repository.lock_write()
1848
token = self.control_files.lock_write(token=token)
1850
self.repository.unlock()
1854
def lock_read(self):
1855
self.repository.lock_read()
1857
self.control_files.lock_read()
1859
self.repository.unlock()
1863
# TODO: test for failed two phase locks. This is known broken.
1865
self.control_files.unlock()
1867
self.repository.unlock()
1868
if not self.control_files.is_locked():
1869
# we just released the lock
1870
self._clear_cached_state()
1872
def peek_lock_mode(self):
1873
if self.control_files._lock_count == 0:
1876
return self.control_files._lock_mode
1878
def get_physical_lock_status(self):
1879
return self.control_files.get_physical_lock_status()
1882
def print_file(self, file, revision_id):
1883
"""See Branch.print_file."""
1884
return self.repository.print_file(file, revision_id)
1886
def _write_revision_history(self, history):
1887
"""Factored out of set_revision_history.
1889
This performs the actual writing to disk.
1890
It is intended to be called by BzrBranch5.set_revision_history."""
1891
self._transport.put_bytes(
1892
'revision-history', '\n'.join(history),
1893
mode=self.bzrdir._get_file_mode())
1896
def set_revision_history(self, rev_history):
1897
"""See Branch.set_revision_history."""
1898
if 'evil' in debug.debug_flags:
1899
mutter_callsite(3, "set_revision_history scales with history.")
1900
check_not_reserved_id = _mod_revision.check_not_reserved_id
1901
for rev_id in rev_history:
1902
check_not_reserved_id(rev_id)
1903
if Branch.hooks['post_change_branch_tip']:
1904
# Don't calculate the last_revision_info() if there are no hooks
1906
old_revno, old_revid = self.last_revision_info()
1907
if len(rev_history) == 0:
1908
revid = _mod_revision.NULL_REVISION
1910
revid = rev_history[-1]
1911
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1912
self._write_revision_history(rev_history)
1913
self._clear_cached_state()
1914
self._cache_revision_history(rev_history)
1915
for hook in Branch.hooks['set_rh']:
1916
hook(self, rev_history)
1917
if Branch.hooks['post_change_branch_tip']:
1918
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1920
def _synchronize_history(self, destination, revision_id):
1921
"""Synchronize last revision and revision history between branches.
1923
This version is most efficient when the destination is also a
1924
BzrBranch5, but works for BzrBranch6 as long as the revision
1925
history is the true lefthand parent history, and all of the revisions
1926
are in the destination's repository. If not, set_revision_history
1929
:param destination: The branch to copy the history into
1930
:param revision_id: The revision-id to truncate history at. May
1931
be None to copy complete history.
1933
if not isinstance(destination._format, BzrBranchFormat5):
1934
super(BzrBranch, self)._synchronize_history(
1935
destination, revision_id)
1937
if revision_id == _mod_revision.NULL_REVISION:
1940
new_history = self.revision_history()
1941
if revision_id is not None and new_history != []:
1943
new_history = new_history[:new_history.index(revision_id) + 1]
1945
rev = self.repository.get_revision(revision_id)
1946
new_history = rev.get_history(self.repository)[1:]
1947
destination.set_revision_history(new_history)
1950
def set_last_revision_info(self, revno, revision_id):
1951
"""Set the last revision of this branch.
1953
The caller is responsible for checking that the revno is correct
1954
for this revision id.
1956
It may be possible to set the branch last revision to an id not
1957
present in the repository. However, branches can also be
1958
configured to check constraints on history, in which case this may not
1961
revision_id = _mod_revision.ensure_null(revision_id)
1962
# this old format stores the full history, but this api doesn't
1963
# provide it, so we must generate, and might as well check it's
1965
history = self._lefthand_history(revision_id)
1966
if len(history) != revno:
1967
raise AssertionError('%d != %d' % (len(history), revno))
1968
self.set_revision_history(history)
1970
def _gen_revision_history(self):
1971
history = self._transport.get_bytes('revision-history').split('\n')
1972
if history[-1:] == ['']:
1973
# There shouldn't be a trailing newline, but just in case.
1978
def generate_revision_history(self, revision_id, last_rev=None,
1980
"""Create a new revision history that will finish with revision_id.
1982
:param revision_id: the new tip to use.
1983
:param last_rev: The previous last_revision. If not None, then this
1984
must be a ancestory of revision_id, or DivergedBranches is raised.
1985
:param other_branch: The other branch that DivergedBranches should
1986
raise with respect to.
1988
self.set_revision_history(self._lefthand_history(revision_id,
1989
last_rev, other_branch))
1991
def basis_tree(self):
1992
"""See Branch.basis_tree."""
1993
return self.repository.revision_tree(self.last_revision())
1996
def pull(self, source, overwrite=False, stop_revision=None,
1997
_hook_master=None, run_hooks=True, possible_transports=None,
1998
_override_hook_target=None):
2001
:param _hook_master: Private parameter - set the branch to
2002
be supplied as the master to pull hooks.
2003
:param run_hooks: Private parameter - if false, this branch
2004
is being called because it's the master of the primary branch,
2005
so it should not run its hooks.
2006
:param _override_hook_target: Private parameter - set the branch to be
2007
supplied as the target_branch to pull hooks.
2009
result = PullResult()
2010
result.source_branch = source
2011
if _override_hook_target is None:
2012
result.target_branch = self
2014
result.target_branch = _override_hook_target
2017
# We assume that during 'pull' the local repository is closer than
2019
graph = self.repository.get_graph(source.repository)
2020
result.old_revno, result.old_revid = self.last_revision_info()
2021
self.update_revisions(source, stop_revision, overwrite=overwrite,
2023
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2024
result.new_revno, result.new_revid = self.last_revision_info()
2026
result.master_branch = _hook_master
2027
result.local_branch = result.target_branch
2029
result.master_branch = result.target_branch
2030
result.local_branch = None
2032
for hook in Branch.hooks['post_pull']:
2038
def _get_parent_location(self):
2039
_locs = ['parent', 'pull', 'x-pull']
2042
return self._transport.get_bytes(l).strip('\n')
2043
except errors.NoSuchFile:
2047
def _basic_push(self, target, overwrite, stop_revision):
2048
"""Basic implementation of push without bound branches or hooks.
2050
Must be called with source read locked and target write locked.
2052
result = BranchPushResult()
2053
result.source_branch = self
2054
result.target_branch = target
2055
result.old_revno, result.old_revid = target.last_revision_info()
2056
if result.old_revid != self.last_revision():
2057
# We assume that during 'push' this repository is closer than
2059
graph = self.repository.get_graph(target.repository)
2060
target.update_revisions(self, stop_revision,
2061
overwrite=overwrite, graph=graph)
2062
if self._push_should_merge_tags():
2063
result.tag_conflicts = self.tags.merge_to(target.tags,
2065
result.new_revno, result.new_revid = target.last_revision_info()
2068
def get_stacked_on_url(self):
2069
raise errors.UnstackableBranchFormat(self._format, self.base)
2071
def set_push_location(self, location):
2072
"""See Branch.set_push_location."""
2073
self.get_config().set_user_option(
2074
'push_location', location,
2075
store=_mod_config.STORE_LOCATION_NORECURSE)
2078
def set_parent(self, url):
2079
"""See Branch.set_parent."""
2080
# TODO: Maybe delete old location files?
2081
# URLs should never be unicode, even on the local fs,
2082
# FIXUP this and get_parent in a future branch format bump:
2083
# read and rewrite the file. RBC 20060125
2085
if isinstance(url, unicode):
2087
url = url.encode('ascii')
2088
except UnicodeEncodeError:
2089
raise errors.InvalidURL(url,
2090
"Urls must be 7-bit ascii, "
2091
"use bzrlib.urlutils.escape")
2092
url = urlutils.relative_url(self.base, url)
2093
self._set_parent_location(url)
2095
def _set_parent_location(self, url):
2097
self._transport.delete('parent')
2099
self._transport.put_bytes('parent', url + '\n',
2100
mode=self.bzrdir._get_file_mode())
2102
def set_stacked_on_url(self, url):
2103
raise errors.UnstackableBranchFormat(self._format, self.base)
2106
class BzrBranch5(BzrBranch):
2107
"""A format 5 branch. This supports new features over plain branches.
2109
It has support for a master_branch which is the data for bound branches.
2113
def pull(self, source, overwrite=False, stop_revision=None,
2114
run_hooks=True, possible_transports=None,
2115
_override_hook_target=None):
2116
"""Pull from source into self, updating my master if any.
2118
:param run_hooks: Private parameter - if false, this branch
2119
is being called because it's the master of the primary branch,
2120
so it should not run its hooks.
2122
bound_location = self.get_bound_location()
2123
master_branch = None
2124
if bound_location and source.base != bound_location:
2125
# not pulling from master, so we need to update master.
2126
master_branch = self.get_master_branch(possible_transports)
2127
master_branch.lock_write()
2130
# pull from source into master.
2131
master_branch.pull(source, overwrite, stop_revision,
2133
return super(BzrBranch5, self).pull(source, overwrite,
2134
stop_revision, _hook_master=master_branch,
2135
run_hooks=run_hooks,
2136
_override_hook_target=_override_hook_target)
2139
master_branch.unlock()
2141
def get_bound_location(self):
2143
return self._transport.get_bytes('bound')[:-1]
2144
except errors.NoSuchFile:
2148
def get_master_branch(self, possible_transports=None):
2149
"""Return the branch we are bound to.
2151
:return: Either a Branch, or None
2153
This could memoise the branch, but if thats done
2154
it must be revalidated on each new lock.
2155
So for now we just don't memoise it.
2156
# RBC 20060304 review this decision.
2158
bound_loc = self.get_bound_location()
2162
return Branch.open(bound_loc,
2163
possible_transports=possible_transports)
2164
except (errors.NotBranchError, errors.ConnectionError), e:
2165
raise errors.BoundBranchConnectionFailure(
2169
def set_bound_location(self, location):
2170
"""Set the target where this branch is bound to.
2172
:param location: URL to the target branch
2175
self._transport.put_bytes('bound', location+'\n',
2176
mode=self.bzrdir._get_file_mode())
2179
self._transport.delete('bound')
2180
except errors.NoSuchFile:
2185
def bind(self, other):
2186
"""Bind this branch to the branch other.
2188
This does not push or pull data between the branches, though it does
2189
check for divergence to raise an error when the branches are not
2190
either the same, or one a prefix of the other. That behaviour may not
2191
be useful, so that check may be removed in future.
2193
:param other: The branch to bind to
2196
# TODO: jam 20051230 Consider checking if the target is bound
2197
# It is debatable whether you should be able to bind to
2198
# a branch which is itself bound.
2199
# Committing is obviously forbidden,
2200
# but binding itself may not be.
2201
# Since we *have* to check at commit time, we don't
2202
# *need* to check here
2204
# we want to raise diverged if:
2205
# last_rev is not in the other_last_rev history, AND
2206
# other_last_rev is not in our history, and do it without pulling
2208
self.set_bound_location(other.base)
2212
"""If bound, unbind"""
2213
return self.set_bound_location(None)
2216
def update(self, possible_transports=None):
2217
"""Synchronise this branch with the master branch if any.
2219
:return: None or the last_revision that was pivoted out during the
2222
master = self.get_master_branch(possible_transports)
2223
if master is not None:
2224
old_tip = _mod_revision.ensure_null(self.last_revision())
2225
self.pull(master, overwrite=True)
2226
if self.repository.get_graph().is_ancestor(old_tip,
2227
_mod_revision.ensure_null(self.last_revision())):
2233
class BzrBranch7(BzrBranch5):
2234
"""A branch with support for a fallback repository."""
2236
def _get_fallback_repository(self, url):
2237
"""Get the repository we fallback to at url."""
2238
url = urlutils.join(self.base, url)
2239
a_bzrdir = bzrdir.BzrDir.open(url,
2240
possible_transports=[self._transport])
2241
return a_bzrdir.open_branch().repository
2243
def _activate_fallback_location(self, url):
2244
"""Activate the branch/repository from url as a fallback repository."""
2245
self.repository.add_fallback_repository(
2246
self._get_fallback_repository(url))
2248
def _open_hook(self):
2249
if self._ignore_fallbacks:
2252
url = self.get_stacked_on_url()
2253
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2254
errors.UnstackableBranchFormat):
2257
for hook in Branch.hooks['transform_fallback_location']:
2258
url = hook(self, url)
2260
hook_name = Branch.hooks.get_hook_name(hook)
2261
raise AssertionError(
2262
"'transform_fallback_location' hook %s returned "
2263
"None, not a URL." % hook_name)
2264
self._activate_fallback_location(url)
2266
def _check_stackable_repo(self):
2267
if not self.repository._format.supports_external_lookups:
2268
raise errors.UnstackableRepositoryFormat(self.repository._format,
2269
self.repository.base)
2271
def __init__(self, *args, **kwargs):
2272
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2273
super(BzrBranch7, self).__init__(*args, **kwargs)
2274
self._last_revision_info_cache = None
2275
self._partial_revision_history_cache = []
2277
def _clear_cached_state(self):
2278
super(BzrBranch7, self)._clear_cached_state()
2279
self._last_revision_info_cache = None
2280
self._partial_revision_history_cache = []
2282
def _last_revision_info(self):
2283
revision_string = self._transport.get_bytes('last-revision')
2284
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2285
revision_id = cache_utf8.get_cached_utf8(revision_id)
2287
return revno, revision_id
2289
def _write_last_revision_info(self, revno, revision_id):
2290
"""Simply write out the revision id, with no checks.
2292
Use set_last_revision_info to perform this safely.
2294
Does not update the revision_history cache.
2295
Intended to be called by set_last_revision_info and
2296
_write_revision_history.
2298
revision_id = _mod_revision.ensure_null(revision_id)
2299
out_string = '%d %s\n' % (revno, revision_id)
2300
self._transport.put_bytes('last-revision', out_string,
2301
mode=self.bzrdir._get_file_mode())
2304
def set_last_revision_info(self, revno, revision_id):
2305
revision_id = _mod_revision.ensure_null(revision_id)
2306
old_revno, old_revid = self.last_revision_info()
2307
if self._get_append_revisions_only():
2308
self._check_history_violation(revision_id)
2309
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2310
self._write_last_revision_info(revno, revision_id)
2311
self._clear_cached_state()
2312
self._last_revision_info_cache = revno, revision_id
2313
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2315
def _synchronize_history(self, destination, revision_id):
2316
"""Synchronize last revision and revision history between branches.
2318
:see: Branch._synchronize_history
2320
# XXX: The base Branch has a fast implementation of this method based
2321
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2322
# that uses set_revision_history. This class inherits from BzrBranch5,
2323
# but wants the fast implementation, so it calls
2324
# Branch._synchronize_history directly.
2325
Branch._synchronize_history(self, destination, revision_id)
2327
def _check_history_violation(self, revision_id):
2328
last_revision = _mod_revision.ensure_null(self.last_revision())
2329
if _mod_revision.is_null(last_revision):
2331
if last_revision not in self._lefthand_history(revision_id):
2332
raise errors.AppendRevisionsOnlyViolation(self.base)
2334
def _gen_revision_history(self):
2335
"""Generate the revision history from last revision
2337
last_revno, last_revision = self.last_revision_info()
2338
self._extend_partial_history(stop_index=last_revno-1)
2339
return list(reversed(self._partial_revision_history_cache))
2341
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2342
"""Extend the partial history to include a given index
2344
If a stop_index is supplied, stop when that index has been reached.
2345
If a stop_revision is supplied, stop when that revision is
2346
encountered. Otherwise, stop when the beginning of history is
2349
:param stop_index: The index which should be present. When it is
2350
present, history extension will stop.
2351
:param revision_id: The revision id which should be present. When
2352
it is encountered, history extension will stop.
2354
repo = self.repository
2355
if len(self._partial_revision_history_cache) == 0:
2356
iterator = repo.iter_reverse_revision_history(self.last_revision())
2358
start_revision = self._partial_revision_history_cache[-1]
2359
iterator = repo.iter_reverse_revision_history(start_revision)
2360
#skip the last revision in the list
2361
next_revision = iterator.next()
2362
for revision_id in iterator:
2363
self._partial_revision_history_cache.append(revision_id)
2364
if (stop_index is not None and
2365
len(self._partial_revision_history_cache) > stop_index):
2367
if revision_id == stop_revision:
2370
def _write_revision_history(self, history):
2371
"""Factored out of set_revision_history.
2373
This performs the actual writing to disk, with format-specific checks.
2374
It is intended to be called by BzrBranch5.set_revision_history.
2376
if len(history) == 0:
2377
last_revision = 'null:'
2379
if history != self._lefthand_history(history[-1]):
2380
raise errors.NotLefthandHistory(history)
2381
last_revision = history[-1]
2382
if self._get_append_revisions_only():
2383
self._check_history_violation(last_revision)
2384
self._write_last_revision_info(len(history), last_revision)
2387
def _set_parent_location(self, url):
2388
"""Set the parent branch"""
2389
self._set_config_location('parent_location', url, make_relative=True)
2392
def _get_parent_location(self):
2393
"""Set the parent branch"""
2394
return self._get_config_location('parent_location')
2396
def set_push_location(self, location):
2397
"""See Branch.set_push_location."""
2398
self._set_config_location('push_location', location)
2400
def set_bound_location(self, location):
2401
"""See Branch.set_push_location."""
2403
config = self.get_config()
2404
if location is None:
2405
if config.get_user_option('bound') != 'True':
2408
config.set_user_option('bound', 'False', warn_masked=True)
2411
self._set_config_location('bound_location', location,
2413
config.set_user_option('bound', 'True', warn_masked=True)
2416
def _get_bound_location(self, bound):
2417
"""Return the bound location in the config file.
2419
Return None if the bound parameter does not match"""
2420
config = self.get_config()
2421
config_bound = (config.get_user_option('bound') == 'True')
2422
if config_bound != bound:
2424
return self._get_config_location('bound_location', config=config)
2426
def get_bound_location(self):
2427
"""See Branch.set_push_location."""
2428
return self._get_bound_location(True)
2430
def get_old_bound_location(self):
2431
"""See Branch.get_old_bound_location"""
2432
return self._get_bound_location(False)
2434
def get_stacked_on_url(self):
2435
# you can always ask for the URL; but you might not be able to use it
2436
# if the repo can't support stacking.
2437
## self._check_stackable_repo()
2438
stacked_url = self._get_config_location('stacked_on_location')
2439
if stacked_url is None:
2440
raise errors.NotStacked(self)
2443
def set_append_revisions_only(self, enabled):
2448
self.get_config().set_user_option('append_revisions_only', value,
2451
def set_stacked_on_url(self, url):
2452
self._check_stackable_repo()
2455
old_url = self.get_stacked_on_url()
2456
except (errors.NotStacked, errors.UnstackableBranchFormat,
2457
errors.UnstackableRepositoryFormat):
2460
# repositories don't offer an interface to remove fallback
2461
# repositories today; take the conceptually simpler option and just
2463
self.repository = self.bzrdir.find_repository()
2464
# for every revision reference the branch has, ensure it is pulled
2466
source_repository = self._get_fallback_repository(old_url)
2467
for revision_id in chain([self.last_revision()],
2468
self.tags.get_reverse_tag_dict()):
2469
self.repository.fetch(source_repository, revision_id,
2472
self._activate_fallback_location(url)
2473
# write this out after the repository is stacked to avoid setting a
2474
# stacked config that doesn't work.
2475
self._set_config_location('stacked_on_location', url)
2477
def _get_append_revisions_only(self):
2478
value = self.get_config().get_user_option('append_revisions_only')
2479
return value == 'True'
2482
def generate_revision_history(self, revision_id, last_rev=None,
2484
"""See BzrBranch5.generate_revision_history"""
2485
history = self._lefthand_history(revision_id, last_rev, other_branch)
2486
revno = len(history)
2487
self.set_last_revision_info(revno, revision_id)
2490
def get_rev_id(self, revno, history=None):
2491
"""Find the revision id of the specified revno."""
2493
return _mod_revision.NULL_REVISION
2495
last_revno, last_revision_id = self.last_revision_info()
2496
if revno <= 0 or revno > last_revno:
2497
raise errors.NoSuchRevision(self, revno)
2499
if history is not None:
2500
return history[revno - 1]
2502
index = last_revno - revno
2503
if len(self._partial_revision_history_cache) <= index:
2504
self._extend_partial_history(stop_index=index)
2505
if len(self._partial_revision_history_cache) > index:
2506
return self._partial_revision_history_cache[index]
2508
raise errors.NoSuchRevision(self, revno)
2511
def revision_id_to_revno(self, revision_id):
2512
"""Given a revision id, return its revno"""
2513
if _mod_revision.is_null(revision_id):
2516
index = self._partial_revision_history_cache.index(revision_id)
2518
self._extend_partial_history(stop_revision=revision_id)
2519
index = len(self._partial_revision_history_cache) - 1
2520
if self._partial_revision_history_cache[index] != revision_id:
2521
raise errors.NoSuchRevision(self, revision_id)
2522
return self.revno() - index
2525
class BzrBranch6(BzrBranch7):
2526
"""See BzrBranchFormat6 for the capabilities of this branch.
2528
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2532
def get_stacked_on_url(self):
2533
raise errors.UnstackableBranchFormat(self._format, self.base)
2535
def set_stacked_on_url(self, url):
2536
raise errors.UnstackableBranchFormat(self._format, self.base)
2539
######################################################################
2540
# results of operations
2543
class _Result(object):
2545
def _show_tag_conficts(self, to_file):
2546
if not getattr(self, 'tag_conflicts', None):
2548
to_file.write('Conflicting tags:\n')
2549
for name, value1, value2 in self.tag_conflicts:
2550
to_file.write(' %s\n' % (name, ))
2553
class PullResult(_Result):
2554
"""Result of a Branch.pull operation.
2556
:ivar old_revno: Revision number before pull.
2557
:ivar new_revno: Revision number after pull.
2558
:ivar old_revid: Tip revision id before pull.
2559
:ivar new_revid: Tip revision id after pull.
2560
:ivar source_branch: Source (local) branch object. (read locked)
2561
:ivar master_branch: Master branch of the target, or the target if no
2563
:ivar local_branch: target branch if there is a Master, else None
2564
:ivar target_branch: Target/destination branch object. (write locked)
2565
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2569
# DEPRECATED: pull used to return the change in revno
2570
return self.new_revno - self.old_revno
2572
def report(self, to_file):
2574
if self.old_revid == self.new_revid:
2575
to_file.write('No revisions to pull.\n')
2577
to_file.write('Now on revision %d.\n' % self.new_revno)
2578
self._show_tag_conficts(to_file)
2581
class BranchPushResult(_Result):
2582
"""Result of a Branch.push operation.
2584
:ivar old_revno: Revision number (eg 10) of the target before push.
2585
:ivar new_revno: Revision number (eg 12) of the target after push.
2586
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2588
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2590
:ivar source_branch: Source branch object that the push was from. This is
2591
read locked, and generally is a local (and thus low latency) branch.
2592
:ivar master_branch: If target is a bound branch, the master branch of
2593
target, or target itself. Always write locked.
2594
:ivar target_branch: The direct Branch where data is being sent (write
2596
:ivar local_branch: If the target is a bound branch this will be the
2597
target, otherwise it will be None.
2601
# DEPRECATED: push used to return the change in revno
2602
return self.new_revno - self.old_revno
2604
def report(self, to_file):
2605
"""Write a human-readable description of the result."""
2606
if self.old_revid == self.new_revid:
2607
note('No new revisions to push.')
2609
note('Pushed up to revision %d.' % self.new_revno)
2610
self._show_tag_conficts(to_file)
2613
class BranchCheckResult(object):
2614
"""Results of checking branch consistency.
2619
def __init__(self, branch):
2620
self.branch = branch
2622
def report_results(self, verbose):
2623
"""Report the check results via trace.note.
2625
:param verbose: Requests more detailed display of what was checked,
2628
note('checked branch %s format %s',
2630
self.branch._format)
2633
class Converter5to6(object):
2634
"""Perform an in-place upgrade of format 5 to format 6"""
2636
def convert(self, branch):
2637
# Data for 5 and 6 can peacefully coexist.
2638
format = BzrBranchFormat6()
2639
new_branch = format.open(branch.bzrdir, _found=True)
2641
# Copy source data into target
2642
new_branch._write_last_revision_info(*branch.last_revision_info())
2643
new_branch.set_parent(branch.get_parent())
2644
new_branch.set_bound_location(branch.get_bound_location())
2645
new_branch.set_push_location(branch.get_push_location())
2647
# New branch has no tags by default
2648
new_branch.tags._set_tag_dict({})
2650
# Copying done; now update target format
2651
new_branch._transport.put_bytes('format',
2652
format.get_format_string(),
2653
mode=new_branch.bzrdir._get_file_mode())
2655
# Clean up old files
2656
new_branch._transport.delete('revision-history')
2658
branch.set_parent(None)
2659
except errors.NoSuchFile:
2661
branch.set_bound_location(None)
2664
class Converter6to7(object):
2665
"""Perform an in-place upgrade of format 6 to format 7"""
2667
def convert(self, branch):
2668
format = BzrBranchFormat7()
2669
branch._set_config_location('stacked_on_location', '')
2670
# update target format
2671
branch._transport.put_bytes('format', format.get_format_string())
2675
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2676
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2679
_run_with_write_locked_target will attempt to release the lock it acquires.
2681
If an exception is raised by callable, then that exception *will* be
2682
propagated, even if the unlock attempt raises its own error. Thus
2683
_run_with_write_locked_target should be preferred to simply doing::
2687
return callable(*args, **kwargs)
2692
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2693
# should share code?
2696
result = callable(*args, **kwargs)
2698
exc_info = sys.exc_info()
2702
raise exc_info[0], exc_info[1], exc_info[2]
2708
class InterBranch(InterObject):
2709
"""This class represents operations taking place between two branches.
2711
Its instances have methods like pull() and push() and contain
2712
references to the source and target repositories these operations
2713
can be carried out on.
2717
"""The available optimised InterBranch types."""
2720
def _get_branch_formats_to_test():
2721
"""Return a tuple with the Branch formats to use when testing."""
2722
raise NotImplementedError(self._get_branch_formats_to_test)
2724
def update_revisions(self, stop_revision=None, overwrite=False,
2726
"""Pull in new perfect-fit revisions.
2728
:param stop_revision: Updated until the given revision
2729
:param overwrite: Always set the branch pointer, rather than checking
2730
to see if it is a proper descendant.
2731
:param graph: A Graph object that can be used to query history
2732
information. This can be None.
2735
raise NotImplementedError(self.update_revisions)
2737
def push(self, overwrite=False, stop_revision=None,
2738
_override_hook_source_branch=None):
2739
"""Mirror the source branch into the target branch.
2741
The source branch is considered to be 'local', having low latency.
2743
raise NotImplementedError(self.push)
2746
class GenericInterBranch(InterBranch):
2747
"""InterBranch implementation that uses public Branch functions.
2751
def _get_branch_formats_to_test():
2752
return BranchFormat._default_format, BranchFormat._default_format
2754
def update_revisions(self, stop_revision=None, overwrite=False,
2756
"""See InterBranch.update_revisions()."""
2757
self.source.lock_read()
2759
other_revno, other_last_revision = self.source.last_revision_info()
2760
stop_revno = None # unknown
2761
if stop_revision is None:
2762
stop_revision = other_last_revision
2763
if _mod_revision.is_null(stop_revision):
2764
# if there are no commits, we're done.
2766
stop_revno = other_revno
2768
# what's the current last revision, before we fetch [and change it
2770
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2771
# we fetch here so that we don't process data twice in the common
2772
# case of having something to pull, and so that the check for
2773
# already merged can operate on the just fetched graph, which will
2774
# be cached in memory.
2775
self.target.fetch(self.source, stop_revision)
2776
# Check to see if one is an ancestor of the other
2779
graph = self.target.repository.get_graph()
2780
if self.target._check_if_descendant_or_diverged(
2781
stop_revision, last_rev, graph, self.source):
2782
# stop_revision is a descendant of last_rev, but we aren't
2783
# overwriting, so we're done.
2785
if stop_revno is None:
2787
graph = self.target.repository.get_graph()
2788
this_revno, this_last_revision = \
2789
self.target.last_revision_info()
2790
stop_revno = graph.find_distance_to_null(stop_revision,
2791
[(other_last_revision, other_revno),
2792
(this_last_revision, this_revno)])
2793
self.target.set_last_revision_info(stop_revno, stop_revision)
2795
self.source.unlock()
2797
def push(self, overwrite=False, stop_revision=None,
2798
_override_hook_source_branch=None):
2799
"""See InterBranch.push.
2801
This is the basic concrete implementation of push()
2803
:param _override_hook_source_branch: If specified, run
2804
the hooks passing this Branch as the source, rather than self.
2805
This is for use of RemoteBranch, where push is delegated to the
2806
underlying vfs-based Branch.
2808
# TODO: Public option to disable running hooks - should be trivial but
2810
self.source.lock_read()
2812
return _run_with_write_locked_target(
2813
self.target, self._push_with_bound_branches, overwrite,
2815
_override_hook_source_branch=_override_hook_source_branch)
2817
self.source.unlock()
2819
def _push_with_bound_branches(self, overwrite, stop_revision,
2820
_override_hook_source_branch=None):
2821
"""Push from source into target, and into target's master if any.
2824
if _override_hook_source_branch:
2825
result.source_branch = _override_hook_source_branch
2826
for hook in Branch.hooks['post_push']:
2829
bound_location = self.target.get_bound_location()
2830
if bound_location and self.target.base != bound_location:
2831
# there is a master branch.
2833
# XXX: Why the second check? Is it even supported for a branch to
2834
# be bound to itself? -- mbp 20070507
2835
master_branch = self.target.get_master_branch()
2836
master_branch.lock_write()
2838
# push into the master from the source branch.
2839
self.source._basic_push(master_branch, overwrite, stop_revision)
2840
# and push into the target branch from the source. Note that we
2841
# push from the source branch again, because its considered the
2842
# highest bandwidth repository.
2843
result = self.source._basic_push(self.target, overwrite,
2845
result.master_branch = master_branch
2846
result.local_branch = self.target
2850
master_branch.unlock()
2853
result = self.source._basic_push(self.target, overwrite,
2855
# TODO: Why set master_branch and local_branch if there's no
2856
# binding? Maybe cleaner to just leave them unset? -- mbp
2858
result.master_branch = self.target
2859
result.local_branch = None
2864
def is_compatible(self, source, target):
2865
# GenericBranch uses the public API, so always compatible
2869
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
