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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from itertools import chain
26
config as _mod_config,
32
revision as _mod_revision,
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):
768
"""Mirror this branch into target.
770
This branch is considered to be 'local', having low latency.
772
raise NotImplementedError(self.push)
774
def basis_tree(self):
775
"""Return `Tree` object for last revision."""
776
return self.repository.revision_tree(self.last_revision())
778
def get_parent(self):
779
"""Return the parent location of the branch.
781
This is the default location for pull/missing. The usual
782
pattern is that the user can override it by specifying a
785
parent = self._get_parent_location()
788
# This is an old-format absolute path to a local branch
790
if parent.startswith('/'):
791
parent = urlutils.local_path_to_url(parent.decode('utf8'))
793
return urlutils.join(self.base[:-1], parent)
794
except errors.InvalidURLJoin, e:
795
raise errors.InaccessibleParent(parent, self.base)
797
def _get_parent_location(self):
798
raise NotImplementedError(self._get_parent_location)
800
def _set_config_location(self, name, url, config=None,
801
make_relative=False):
803
config = self.get_config()
807
url = urlutils.relative_url(self.base, url)
808
config.set_user_option(name, url, warn_masked=True)
810
def _get_config_location(self, name, config=None):
812
config = self.get_config()
813
location = config.get_user_option(name)
818
def get_submit_branch(self):
819
"""Return the submit location of the branch.
821
This is the default location for bundle. The usual
822
pattern is that the user can override it by specifying a
825
return self.get_config().get_user_option('submit_branch')
827
def set_submit_branch(self, location):
828
"""Return the submit location of the branch.
830
This is the default location for bundle. The usual
831
pattern is that the user can override it by specifying a
834
self.get_config().set_user_option('submit_branch', location,
837
def get_public_branch(self):
838
"""Return the public location of the branch.
840
This is is used by merge directives.
842
return self._get_config_location('public_branch')
844
def set_public_branch(self, location):
845
"""Return the submit location of the branch.
847
This is the default location for bundle. The usual
848
pattern is that the user can override it by specifying a
851
self._set_config_location('public_branch', location)
853
def get_push_location(self):
854
"""Return the None or the location to push this branch to."""
855
push_loc = self.get_config().get_user_option('push_location')
858
def set_push_location(self, location):
859
"""Set a new push location for this branch."""
860
raise NotImplementedError(self.set_push_location)
862
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
863
"""Run the post_change_branch_tip hooks."""
864
hooks = Branch.hooks['post_change_branch_tip']
867
new_revno, new_revid = self.last_revision_info()
868
params = ChangeBranchTipParams(
869
self, old_revno, new_revno, old_revid, new_revid)
873
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
874
"""Run the pre_change_branch_tip hooks."""
875
hooks = Branch.hooks['pre_change_branch_tip']
878
old_revno, old_revid = self.last_revision_info()
879
params = ChangeBranchTipParams(
880
self, old_revno, new_revno, old_revid, new_revid)
884
except errors.TipChangeRejected:
887
exc_info = sys.exc_info()
888
hook_name = Branch.hooks.get_hook_name(hook)
889
raise errors.HookFailed(
890
'pre_change_branch_tip', hook_name, exc_info)
892
def set_parent(self, url):
893
raise NotImplementedError(self.set_parent)
897
"""Synchronise this branch with the master branch if any.
899
:return: None or the last_revision pivoted out during the update.
903
def check_revno(self, revno):
905
Check whether a revno corresponds to any revision.
906
Zero (the NULL revision) is considered valid.
909
self.check_real_revno(revno)
911
def check_real_revno(self, revno):
913
Check whether a revno corresponds to a real revision.
914
Zero (the NULL revision) is considered invalid
916
if revno < 1 or revno > self.revno():
917
raise errors.InvalidRevisionNumber(revno)
920
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
921
"""Clone this branch into to_bzrdir preserving all semantic values.
923
Most API users will want 'create_clone_on_transport', which creates a
924
new bzrdir and branch on the fly.
926
revision_id: if not None, the revision history in the new branch will
927
be truncated to end with revision_id.
929
result = to_bzrdir.create_branch()
930
if repository_policy is not None:
931
repository_policy.configure_branch(result)
932
self.copy_content_into(result, revision_id=revision_id)
936
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
937
"""Create a new line of development from the branch, into to_bzrdir.
939
to_bzrdir controls the branch format.
941
revision_id: if not None, the revision history in the new branch will
942
be truncated to end with revision_id.
944
result = to_bzrdir.create_branch()
945
if repository_policy is not None:
946
repository_policy.configure_branch(result)
947
self.copy_content_into(result, revision_id=revision_id)
948
result.set_parent(self.bzrdir.root_transport.base)
951
def _synchronize_history(self, destination, revision_id):
952
"""Synchronize last revision and revision history between branches.
954
This version is most efficient when the destination is also a
955
BzrBranch6, but works for BzrBranch5, as long as the destination's
956
repository contains all the lefthand ancestors of the intended
957
last_revision. If not, set_last_revision_info will fail.
959
:param destination: The branch to copy the history into
960
:param revision_id: The revision-id to truncate history at. May
961
be None to copy complete history.
963
source_revno, source_revision_id = self.last_revision_info()
964
if revision_id is None:
965
revno, revision_id = source_revno, source_revision_id
966
elif source_revision_id == revision_id:
967
# we know the revno without needing to walk all of history
970
# To figure out the revno for a random revision, we need to build
971
# the revision history, and count its length.
972
# We don't care about the order, just how long it is.
973
# Alternatively, we could start at the current location, and count
974
# backwards. But there is no guarantee that we will find it since
975
# it may be a merged revision.
976
revno = len(list(self.repository.iter_reverse_revision_history(
978
destination.set_last_revision_info(revno, revision_id)
981
def copy_content_into(self, destination, revision_id=None):
982
"""Copy the content of self into destination.
984
revision_id: if not None, the revision history in the new branch will
985
be truncated to end with revision_id.
987
self._synchronize_history(destination, revision_id)
989
parent = self.get_parent()
990
except errors.InaccessibleParent, e:
991
mutter('parent was not accessible to copy: %s', e)
994
destination.set_parent(parent)
995
if self._push_should_merge_tags():
996
self.tags.merge_to(destination.tags)
1000
"""Check consistency of the branch.
1002
In particular this checks that revisions given in the revision-history
1003
do actually match up in the revision graph, and that they're all
1004
present in the repository.
1006
Callers will typically also want to check the repository.
1008
:return: A BranchCheckResult.
1010
mainline_parent_id = None
1011
last_revno, last_revision_id = self.last_revision_info()
1012
real_rev_history = list(self.repository.iter_reverse_revision_history(
1014
real_rev_history.reverse()
1015
if len(real_rev_history) != last_revno:
1016
raise errors.BzrCheckError('revno does not match len(mainline)'
1017
' %s != %s' % (last_revno, len(real_rev_history)))
1018
# TODO: We should probably also check that real_rev_history actually
1019
# matches self.revision_history()
1020
for revision_id in real_rev_history:
1022
revision = self.repository.get_revision(revision_id)
1023
except errors.NoSuchRevision, e:
1024
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1026
# In general the first entry on the revision history has no parents.
1027
# But it's not illegal for it to have parents listed; this can happen
1028
# in imports from Arch when the parents weren't reachable.
1029
if mainline_parent_id is not None:
1030
if mainline_parent_id not in revision.parent_ids:
1031
raise errors.BzrCheckError("previous revision {%s} not listed among "
1033
% (mainline_parent_id, revision_id))
1034
mainline_parent_id = revision_id
1035
return BranchCheckResult(self)
1037
def _get_checkout_format(self):
1038
"""Return the most suitable metadir for a checkout of this branch.
1039
Weaves are used if this branch's repository uses weaves.
1041
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1042
from bzrlib.repofmt import weaverepo
1043
format = bzrdir.BzrDirMetaFormat1()
1044
format.repository_format = weaverepo.RepositoryFormat7()
1046
format = self.repository.bzrdir.checkout_metadir()
1047
format.set_branch_format(self._format)
1050
def create_clone_on_transport(self, to_transport, revision_id=None,
1052
"""Create a clone of this branch and its bzrdir.
1054
:param to_transport: The transport to clone onto.
1055
:param revision_id: The revision id to use as tip in the new branch.
1056
If None the tip is obtained from this branch.
1057
:param stacked_on: An optional URL to stack the clone on.
1059
# XXX: Fix the bzrdir API to allow getting the branch back from the
1060
# clone call. Or something. 20090224 RBC/spiv.
1061
dir_to = self.bzrdir.clone_on_transport(to_transport,
1062
revision_id=revision_id, stacked_on=stacked_on)
1063
return dir_to.open_branch()
1065
def create_checkout(self, to_location, revision_id=None,
1066
lightweight=False, accelerator_tree=None,
1068
"""Create a checkout of a branch.
1070
:param to_location: The url to produce the checkout at
1071
:param revision_id: The revision to check out
1072
:param lightweight: If True, produce a lightweight checkout, otherwise,
1073
produce a bound branch (heavyweight checkout)
1074
:param accelerator_tree: A tree which can be used for retrieving file
1075
contents more quickly than the revision tree, i.e. a workingtree.
1076
The revision tree will be used for cases where accelerator_tree's
1077
content is different.
1078
:param hardlink: If true, hard-link files from accelerator_tree,
1080
:return: The tree of the created checkout
1082
t = transport.get_transport(to_location)
1085
format = self._get_checkout_format()
1086
checkout = format.initialize_on_transport(t)
1087
from_branch = BranchReferenceFormat().initialize(checkout, self)
1089
format = self._get_checkout_format()
1090
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1091
to_location, force_new_tree=False, format=format)
1092
checkout = checkout_branch.bzrdir
1093
checkout_branch.bind(self)
1094
# pull up to the specified revision_id to set the initial
1095
# branch tip correctly, and seed it with history.
1096
checkout_branch.pull(self, stop_revision=revision_id)
1098
tree = checkout.create_workingtree(revision_id,
1099
from_branch=from_branch,
1100
accelerator_tree=accelerator_tree,
1102
basis_tree = tree.basis_tree()
1103
basis_tree.lock_read()
1105
for path, file_id in basis_tree.iter_references():
1106
reference_parent = self.reference_parent(file_id, path)
1107
reference_parent.create_checkout(tree.abspath(path),
1108
basis_tree.get_reference_revision(file_id, path),
1115
def reconcile(self, thorough=True):
1116
"""Make sure the data stored in this branch is consistent."""
1117
from bzrlib.reconcile import BranchReconciler
1118
reconciler = BranchReconciler(self, thorough=thorough)
1119
reconciler.reconcile()
1122
def reference_parent(self, file_id, path):
1123
"""Return the parent branch for a tree-reference file_id
1124
:param file_id: The file_id of the tree reference
1125
:param path: The path of the file_id in the tree
1126
:return: A branch associated with the file_id
1128
# FIXME should provide multiple branches, based on config
1129
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1131
def supports_tags(self):
1132
return self._format.supports_tags()
1134
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1136
"""Ensure that revision_b is a descendant of revision_a.
1138
This is a helper function for update_revisions.
1140
:raises: DivergedBranches if revision_b has diverged from revision_a.
1141
:returns: True if revision_b is a descendant of revision_a.
1143
relation = self._revision_relations(revision_a, revision_b, graph)
1144
if relation == 'b_descends_from_a':
1146
elif relation == 'diverged':
1147
raise errors.DivergedBranches(self, other_branch)
1148
elif relation == 'a_descends_from_b':
1151
raise AssertionError("invalid relation: %r" % (relation,))
1153
def _revision_relations(self, revision_a, revision_b, graph):
1154
"""Determine the relationship between two revisions.
1156
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1158
heads = graph.heads([revision_a, revision_b])
1159
if heads == set([revision_b]):
1160
return 'b_descends_from_a'
1161
elif heads == set([revision_a, revision_b]):
1162
# These branches have diverged
1164
elif heads == set([revision_a]):
1165
return 'a_descends_from_b'
1167
raise AssertionError("invalid heads: %r" % (heads,))
1170
class BranchFormat(object):
1171
"""An encapsulation of the initialization and open routines for a format.
1173
Formats provide three things:
1174
* An initialization routine,
1178
Formats are placed in an dict by their format string for reference
1179
during branch opening. Its not required that these be instances, they
1180
can be classes themselves with class methods - it simply depends on
1181
whether state is needed for a given format or not.
1183
Once a format is deprecated, just deprecate the initialize and open
1184
methods on the format class. Do not deprecate the object, as the
1185
object will be created every time regardless.
1188
_default_format = None
1189
"""The default format used for new branches."""
1192
"""The known formats."""
1194
def __eq__(self, other):
1195
return self.__class__ is other.__class__
1197
def __ne__(self, other):
1198
return not (self == other)
1201
def find_format(klass, a_bzrdir):
1202
"""Return the format for the branch object in a_bzrdir."""
1204
transport = a_bzrdir.get_branch_transport(None)
1205
format_string = transport.get("format").read()
1206
return klass._formats[format_string]
1207
except errors.NoSuchFile:
1208
raise errors.NotBranchError(path=transport.base)
1210
raise errors.UnknownFormatError(format=format_string, kind='branch')
1213
def get_default_format(klass):
1214
"""Return the current default format."""
1215
return klass._default_format
1217
def get_reference(self, a_bzrdir):
1218
"""Get the target reference of the branch in a_bzrdir.
1220
format probing must have been completed before calling
1221
this method - it is assumed that the format of the branch
1222
in a_bzrdir is correct.
1224
:param a_bzrdir: The bzrdir to get the branch data from.
1225
:return: None if the branch is not a reference branch.
1230
def set_reference(self, a_bzrdir, to_branch):
1231
"""Set the target reference of the branch in a_bzrdir.
1233
format probing must have been completed before calling
1234
this method - it is assumed that the format of the branch
1235
in a_bzrdir is correct.
1237
:param a_bzrdir: The bzrdir to set the branch reference for.
1238
:param to_branch: branch that the checkout is to reference
1240
raise NotImplementedError(self.set_reference)
1242
def get_format_string(self):
1243
"""Return the ASCII format string that identifies this format."""
1244
raise NotImplementedError(self.get_format_string)
1246
def get_format_description(self):
1247
"""Return the short format description for this format."""
1248
raise NotImplementedError(self.get_format_description)
1250
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1252
"""Initialize a branch in a bzrdir, with specified files
1254
:param a_bzrdir: The bzrdir to initialize the branch in
1255
:param utf8_files: The files to create as a list of
1256
(filename, content) tuples
1257
:param set_format: If True, set the format with
1258
self.get_format_string. (BzrBranch4 has its format set
1260
:return: a branch in this format
1262
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1263
branch_transport = a_bzrdir.get_branch_transport(self)
1265
'metadir': ('lock', lockdir.LockDir),
1266
'branch4': ('branch-lock', lockable_files.TransportLock),
1268
lock_name, lock_class = lock_map[lock_type]
1269
control_files = lockable_files.LockableFiles(branch_transport,
1270
lock_name, lock_class)
1271
control_files.create_lock()
1272
control_files.lock_write()
1274
utf8_files += [('format', self.get_format_string())]
1276
for (filename, content) in utf8_files:
1277
branch_transport.put_bytes(
1279
mode=a_bzrdir._get_file_mode())
1281
control_files.unlock()
1282
return self.open(a_bzrdir, _found=True)
1284
def initialize(self, a_bzrdir):
1285
"""Create a branch of this format in a_bzrdir."""
1286
raise NotImplementedError(self.initialize)
1288
def is_supported(self):
1289
"""Is this format supported?
1291
Supported formats can be initialized and opened.
1292
Unsupported formats may not support initialization or committing or
1293
some other features depending on the reason for not being supported.
1297
def make_tags(self, branch):
1298
"""Create a tags object for branch.
1300
This method is on BranchFormat, because BranchFormats are reflected
1301
over the wire via network_name(), whereas full Branch instances require
1302
multiple VFS method calls to operate at all.
1304
The default implementation returns a disabled-tags instance.
1306
Note that it is normal for branch to be a RemoteBranch when using tags
1309
return DisabledTags(branch)
1311
def network_name(self):
1312
"""A simple byte string uniquely identifying this format for RPC calls.
1314
MetaDir branch formats use their disk format string to identify the
1315
repository over the wire. All in one formats such as bzr < 0.8, and
1316
foreign formats like svn/git and hg should use some marker which is
1317
unique and immutable.
1319
raise NotImplementedError(self.network_name)
1321
def open(self, a_bzrdir, _found=False):
1322
"""Return the branch object for a_bzrdir
1324
_found is a private parameter, do not use it. It is used to indicate
1325
if format probing has already be done.
1327
raise NotImplementedError(self.open)
1330
def register_format(klass, format):
1331
"""Register a metadir format."""
1332
klass._formats[format.get_format_string()] = format
1333
# Metadir formats have a network name of their format string, and get
1334
# registered as class factories.
1335
network_format_registry.register(format.get_format_string(), format.__class__)
1338
def set_default_format(klass, format):
1339
klass._default_format = format
1341
def supports_stacking(self):
1342
"""True if this format records a stacked-on branch."""
1346
def unregister_format(klass, format):
1347
del klass._formats[format.get_format_string()]
1350
return self.get_format_description().rstrip()
1352
def supports_tags(self):
1353
"""True if this format supports tags stored in the branch"""
1354
return False # by default
1357
class BranchHooks(Hooks):
1358
"""A dictionary mapping hook name to a list of callables for branch hooks.
1360
e.g. ['set_rh'] Is the list of items to be called when the
1361
set_revision_history function is invoked.
1365
"""Create the default hooks.
1367
These are all empty initially, because by default nothing should get
1370
Hooks.__init__(self)
1371
self.create_hook(HookPoint('set_rh',
1372
"Invoked whenever the revision history has been set via "
1373
"set_revision_history. The api signature is (branch, "
1374
"revision_history), and the branch will be write-locked. "
1375
"The set_rh hook can be expensive for bzr to trigger, a better "
1376
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1377
self.create_hook(HookPoint('open',
1378
"Called with the Branch object that has been opened after a "
1379
"branch is opened.", (1, 8), None))
1380
self.create_hook(HookPoint('post_push',
1381
"Called after a push operation completes. post_push is called "
1382
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1383
"bzr client.", (0, 15), None))
1384
self.create_hook(HookPoint('post_pull',
1385
"Called after a pull operation completes. post_pull is called "
1386
"with a bzrlib.branch.PullResult object and only runs in the "
1387
"bzr client.", (0, 15), None))
1388
self.create_hook(HookPoint('pre_commit',
1389
"Called after a commit is calculated but before it is is "
1390
"completed. pre_commit is called with (local, master, old_revno, "
1391
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1392
"). old_revid is NULL_REVISION for the first commit to a branch, "
1393
"tree_delta is a TreeDelta object describing changes from the "
1394
"basis revision. hooks MUST NOT modify this delta. "
1395
" future_tree is an in-memory tree obtained from "
1396
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1397
"tree.", (0,91), None))
1398
self.create_hook(HookPoint('post_commit',
1399
"Called in the bzr client after a commit has completed. "
1400
"post_commit is called with (local, master, old_revno, old_revid, "
1401
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1402
"commit to a branch.", (0, 15), None))
1403
self.create_hook(HookPoint('post_uncommit',
1404
"Called in the bzr client after an uncommit completes. "
1405
"post_uncommit is called with (local, master, old_revno, "
1406
"old_revid, new_revno, new_revid) where local is the local branch "
1407
"or None, master is the target branch, and an empty branch "
1408
"recieves new_revno of 0, new_revid of None.", (0, 15), None))
1409
self.create_hook(HookPoint('pre_change_branch_tip',
1410
"Called in bzr client and server before a change to the tip of a "
1411
"branch is made. pre_change_branch_tip is called with a "
1412
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1413
"commit, uncommit will all trigger this hook.", (1, 6), None))
1414
self.create_hook(HookPoint('post_change_branch_tip',
1415
"Called in bzr client and server after a change to the tip of a "
1416
"branch is made. post_change_branch_tip is called with a "
1417
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1418
"commit, uncommit will all trigger this hook.", (1, 4), None))
1419
self.create_hook(HookPoint('transform_fallback_location',
1420
"Called when a stacked branch is activating its fallback "
1421
"locations. transform_fallback_location is called with (branch, "
1422
"url), and should return a new url. Returning the same url "
1423
"allows it to be used as-is, returning a different one can be "
1424
"used to cause the branch to stack on a closer copy of that "
1425
"fallback_location. Note that the branch cannot have history "
1426
"accessing methods called on it during this hook because the "
1427
"fallback locations have not been activated. When there are "
1428
"multiple hooks installed for transform_fallback_location, "
1429
"all are called with the url returned from the previous hook."
1430
"The order is however undefined.", (1, 9), None))
1433
# install the default hooks into the Branch class.
1434
Branch.hooks = BranchHooks()
1437
class ChangeBranchTipParams(object):
1438
"""Object holding parameters passed to *_change_branch_tip hooks.
1440
There are 5 fields that hooks may wish to access:
1442
:ivar branch: the branch being changed
1443
:ivar old_revno: revision number before the change
1444
:ivar new_revno: revision number after the change
1445
:ivar old_revid: revision id before the change
1446
:ivar new_revid: revision id after the change
1448
The revid fields are strings. The revno fields are integers.
1451
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1452
"""Create a group of ChangeBranchTip parameters.
1454
:param branch: The branch being changed.
1455
:param old_revno: Revision number before the change.
1456
:param new_revno: Revision number after the change.
1457
:param old_revid: Tip revision id before the change.
1458
:param new_revid: Tip revision id after the change.
1460
self.branch = branch
1461
self.old_revno = old_revno
1462
self.new_revno = new_revno
1463
self.old_revid = old_revid
1464
self.new_revid = new_revid
1466
def __eq__(self, other):
1467
return self.__dict__ == other.__dict__
1470
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1471
self.__class__.__name__, self.branch,
1472
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1475
class BzrBranchFormat4(BranchFormat):
1476
"""Bzr branch format 4.
1479
- a revision-history file.
1480
- a branch-lock lock file [ to be shared with the bzrdir ]
1483
def get_format_description(self):
1484
"""See BranchFormat.get_format_description()."""
1485
return "Branch format 4"
1487
def initialize(self, a_bzrdir):
1488
"""Create a branch of this format in a_bzrdir."""
1489
utf8_files = [('revision-history', ''),
1490
('branch-name', ''),
1492
return self._initialize_helper(a_bzrdir, utf8_files,
1493
lock_type='branch4', set_format=False)
1496
super(BzrBranchFormat4, self).__init__()
1497
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1499
def network_name(self):
1500
"""The network name for this format is the control dirs disk label."""
1501
return self._matchingbzrdir.get_format_string()
1503
def open(self, a_bzrdir, _found=False):
1504
"""Return the branch object for a_bzrdir
1506
_found is a private parameter, do not use it. It is used to indicate
1507
if format probing has already be done.
1510
# we are being called directly and must probe.
1511
raise NotImplementedError
1512
return BzrBranch(_format=self,
1513
_control_files=a_bzrdir._control_files,
1515
_repository=a_bzrdir.open_repository())
1518
return "Bazaar-NG branch format 4"
1521
class BranchFormatMetadir(BranchFormat):
1522
"""Common logic for meta-dir based branch formats."""
1524
def _branch_class(self):
1525
"""What class to instantiate on open calls."""
1526
raise NotImplementedError(self._branch_class)
1528
def network_name(self):
1529
"""A simple byte string uniquely identifying this format for RPC calls.
1531
Metadir branch formats use their format string.
1533
return self.get_format_string()
1535
def open(self, a_bzrdir, _found=False):
1536
"""Return the branch object for a_bzrdir.
1538
_found is a private parameter, do not use it. It is used to indicate
1539
if format probing has already be done.
1542
format = BranchFormat.find_format(a_bzrdir)
1543
if format.__class__ != self.__class__:
1544
raise AssertionError("wrong format %r found for %r" %
1547
transport = a_bzrdir.get_branch_transport(None)
1548
control_files = lockable_files.LockableFiles(transport, 'lock',
1550
return self._branch_class()(_format=self,
1551
_control_files=control_files,
1553
_repository=a_bzrdir.find_repository())
1554
except errors.NoSuchFile:
1555
raise errors.NotBranchError(path=transport.base)
1558
super(BranchFormatMetadir, self).__init__()
1559
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1560
self._matchingbzrdir.set_branch_format(self)
1562
def supports_tags(self):
1566
class BzrBranchFormat5(BranchFormatMetadir):
1567
"""Bzr branch format 5.
1570
- a revision-history file.
1572
- a lock dir guarding the branch itself
1573
- all of this stored in a branch/ subdirectory
1574
- works with shared repositories.
1576
This format is new in bzr 0.8.
1579
def _branch_class(self):
1582
def get_format_string(self):
1583
"""See BranchFormat.get_format_string()."""
1584
return "Bazaar-NG branch format 5\n"
1586
def get_format_description(self):
1587
"""See BranchFormat.get_format_description()."""
1588
return "Branch format 5"
1590
def initialize(self, a_bzrdir):
1591
"""Create a branch of this format in a_bzrdir."""
1592
utf8_files = [('revision-history', ''),
1593
('branch-name', ''),
1595
return self._initialize_helper(a_bzrdir, utf8_files)
1597
def supports_tags(self):
1601
class BzrBranchFormat6(BranchFormatMetadir):
1602
"""Branch format with last-revision and tags.
1604
Unlike previous formats, this has no explicit revision history. Instead,
1605
this just stores the last-revision, and the left-hand history leading
1606
up to there is the history.
1608
This format was introduced in bzr 0.15
1609
and became the default in 0.91.
1612
def _branch_class(self):
1615
def get_format_string(self):
1616
"""See BranchFormat.get_format_string()."""
1617
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1619
def get_format_description(self):
1620
"""See BranchFormat.get_format_description()."""
1621
return "Branch format 6"
1623
def initialize(self, a_bzrdir):
1624
"""Create a branch of this format in a_bzrdir."""
1625
utf8_files = [('last-revision', '0 null:\n'),
1626
('branch.conf', ''),
1629
return self._initialize_helper(a_bzrdir, utf8_files)
1631
def make_tags(self, branch):
1632
"""See bzrlib.branch.BranchFormat.make_tags()."""
1633
return BasicTags(branch)
1637
class BzrBranchFormat7(BranchFormatMetadir):
1638
"""Branch format with last-revision, tags, and a stacked location pointer.
1640
The stacked location pointer is passed down to the repository and requires
1641
a repository format with supports_external_lookups = True.
1643
This format was introduced in bzr 1.6.
1646
def _branch_class(self):
1649
def get_format_string(self):
1650
"""See BranchFormat.get_format_string()."""
1651
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1653
def get_format_description(self):
1654
"""See BranchFormat.get_format_description()."""
1655
return "Branch format 7"
1657
def initialize(self, a_bzrdir):
1658
"""Create a branch of this format in a_bzrdir."""
1659
utf8_files = [('last-revision', '0 null:\n'),
1660
('branch.conf', ''),
1663
return self._initialize_helper(a_bzrdir, utf8_files)
1666
super(BzrBranchFormat7, self).__init__()
1667
self._matchingbzrdir.repository_format = \
1668
RepositoryFormatKnitPack5RichRoot()
1670
def make_tags(self, branch):
1671
"""See bzrlib.branch.BranchFormat.make_tags()."""
1672
return BasicTags(branch)
1674
def supports_stacking(self):
1678
class BranchReferenceFormat(BranchFormat):
1679
"""Bzr branch reference format.
1681
Branch references are used in implementing checkouts, they
1682
act as an alias to the real branch which is at some other url.
1689
def get_format_string(self):
1690
"""See BranchFormat.get_format_string()."""
1691
return "Bazaar-NG Branch Reference Format 1\n"
1693
def get_format_description(self):
1694
"""See BranchFormat.get_format_description()."""
1695
return "Checkout reference format 1"
1697
def get_reference(self, a_bzrdir):
1698
"""See BranchFormat.get_reference()."""
1699
transport = a_bzrdir.get_branch_transport(None)
1700
return transport.get('location').read()
1702
def set_reference(self, a_bzrdir, to_branch):
1703
"""See BranchFormat.set_reference()."""
1704
transport = a_bzrdir.get_branch_transport(None)
1705
location = transport.put_bytes('location', to_branch.base)
1707
def initialize(self, a_bzrdir, target_branch=None):
1708
"""Create a branch of this format in a_bzrdir."""
1709
if target_branch is None:
1710
# this format does not implement branch itself, thus the implicit
1711
# creation contract must see it as uninitializable
1712
raise errors.UninitializableFormat(self)
1713
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1714
branch_transport = a_bzrdir.get_branch_transport(self)
1715
branch_transport.put_bytes('location',
1716
target_branch.bzrdir.root_transport.base)
1717
branch_transport.put_bytes('format', self.get_format_string())
1719
a_bzrdir, _found=True,
1720
possible_transports=[target_branch.bzrdir.root_transport])
1723
super(BranchReferenceFormat, self).__init__()
1724
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1725
self._matchingbzrdir.set_branch_format(self)
1727
def _make_reference_clone_function(format, a_branch):
1728
"""Create a clone() routine for a branch dynamically."""
1729
def clone(to_bzrdir, revision_id=None,
1730
repository_policy=None):
1731
"""See Branch.clone()."""
1732
return format.initialize(to_bzrdir, a_branch)
1733
# cannot obey revision_id limits when cloning a reference ...
1734
# FIXME RBC 20060210 either nuke revision_id for clone, or
1735
# emit some sort of warning/error to the caller ?!
1738
def open(self, a_bzrdir, _found=False, location=None,
1739
possible_transports=None):
1740
"""Return the branch that the branch reference in a_bzrdir points at.
1742
_found is a private parameter, do not use it. It is used to indicate
1743
if format probing has already be done.
1746
format = BranchFormat.find_format(a_bzrdir)
1747
if format.__class__ != self.__class__:
1748
raise AssertionError("wrong format %r found for %r" %
1750
if location is None:
1751
location = self.get_reference(a_bzrdir)
1752
real_bzrdir = bzrdir.BzrDir.open(
1753
location, possible_transports=possible_transports)
1754
result = real_bzrdir.open_branch()
1755
# this changes the behaviour of result.clone to create a new reference
1756
# rather than a copy of the content of the branch.
1757
# I did not use a proxy object because that needs much more extensive
1758
# testing, and we are only changing one behaviour at the moment.
1759
# If we decide to alter more behaviours - i.e. the implicit nickname
1760
# then this should be refactored to introduce a tested proxy branch
1761
# and a subclass of that for use in overriding clone() and ....
1763
result.clone = self._make_reference_clone_function(result)
1767
network_format_registry = registry.FormatRegistry()
1768
"""Registry of formats indexed by their network name.
1770
The network name for a branch format is an identifier that can be used when
1771
referring to formats with smart server operations. See
1772
BranchFormat.network_name() for more detail.
1776
# formats which have no format string are not discoverable
1777
# and not independently creatable, so are not registered.
1778
__format5 = BzrBranchFormat5()
1779
__format6 = BzrBranchFormat6()
1780
__format7 = BzrBranchFormat7()
1781
BranchFormat.register_format(__format5)
1782
BranchFormat.register_format(BranchReferenceFormat())
1783
BranchFormat.register_format(__format6)
1784
BranchFormat.register_format(__format7)
1785
BranchFormat.set_default_format(__format6)
1786
_legacy_formats = [BzrBranchFormat4(),
1788
network_format_registry.register(
1789
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1792
class BzrBranch(Branch):
1793
"""A branch stored in the actual filesystem.
1795
Note that it's "local" in the context of the filesystem; it doesn't
1796
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1797
it's writable, and can be accessed via the normal filesystem API.
1799
:ivar _transport: Transport for file operations on this branch's
1800
control files, typically pointing to the .bzr/branch directory.
1801
:ivar repository: Repository for this branch.
1802
:ivar base: The url of the base directory for this branch; the one
1803
containing the .bzr directory.
1806
def __init__(self, _format=None,
1807
_control_files=None, a_bzrdir=None, _repository=None):
1808
"""Create new branch object at a particular location."""
1809
if a_bzrdir is None:
1810
raise ValueError('a_bzrdir must be supplied')
1812
self.bzrdir = a_bzrdir
1813
self._base = self.bzrdir.transport.clone('..').base
1814
# XXX: We should be able to just do
1815
# self.base = self.bzrdir.root_transport.base
1816
# but this does not quite work yet -- mbp 20080522
1817
self._format = _format
1818
if _control_files is None:
1819
raise ValueError('BzrBranch _control_files is None')
1820
self.control_files = _control_files
1821
self._transport = _control_files._transport
1822
self.repository = _repository
1823
Branch.__init__(self)
1826
return '%s(%r)' % (self.__class__.__name__, self.base)
1830
def _get_base(self):
1831
"""Returns the directory containing the control directory."""
1834
base = property(_get_base, doc="The URL for the root of this branch.")
1836
def is_locked(self):
1837
return self.control_files.is_locked()
1839
def lock_write(self, token=None):
1840
repo_token = self.repository.lock_write()
1842
token = self.control_files.lock_write(token=token)
1844
self.repository.unlock()
1848
def lock_read(self):
1849
self.repository.lock_read()
1851
self.control_files.lock_read()
1853
self.repository.unlock()
1857
# TODO: test for failed two phase locks. This is known broken.
1859
self.control_files.unlock()
1861
self.repository.unlock()
1862
if not self.control_files.is_locked():
1863
# we just released the lock
1864
self._clear_cached_state()
1866
def peek_lock_mode(self):
1867
if self.control_files._lock_count == 0:
1870
return self.control_files._lock_mode
1872
def get_physical_lock_status(self):
1873
return self.control_files.get_physical_lock_status()
1876
def print_file(self, file, revision_id):
1877
"""See Branch.print_file."""
1878
return self.repository.print_file(file, revision_id)
1880
def _write_revision_history(self, history):
1881
"""Factored out of set_revision_history.
1883
This performs the actual writing to disk.
1884
It is intended to be called by BzrBranch5.set_revision_history."""
1885
self._transport.put_bytes(
1886
'revision-history', '\n'.join(history),
1887
mode=self.bzrdir._get_file_mode())
1890
def set_revision_history(self, rev_history):
1891
"""See Branch.set_revision_history."""
1892
if 'evil' in debug.debug_flags:
1893
mutter_callsite(3, "set_revision_history scales with history.")
1894
check_not_reserved_id = _mod_revision.check_not_reserved_id
1895
for rev_id in rev_history:
1896
check_not_reserved_id(rev_id)
1897
if Branch.hooks['post_change_branch_tip']:
1898
# Don't calculate the last_revision_info() if there are no hooks
1900
old_revno, old_revid = self.last_revision_info()
1901
if len(rev_history) == 0:
1902
revid = _mod_revision.NULL_REVISION
1904
revid = rev_history[-1]
1905
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1906
self._write_revision_history(rev_history)
1907
self._clear_cached_state()
1908
self._cache_revision_history(rev_history)
1909
for hook in Branch.hooks['set_rh']:
1910
hook(self, rev_history)
1911
if Branch.hooks['post_change_branch_tip']:
1912
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1914
def _synchronize_history(self, destination, revision_id):
1915
"""Synchronize last revision and revision history between branches.
1917
This version is most efficient when the destination is also a
1918
BzrBranch5, but works for BzrBranch6 as long as the revision
1919
history is the true lefthand parent history, and all of the revisions
1920
are in the destination's repository. If not, set_revision_history
1923
:param destination: The branch to copy the history into
1924
:param revision_id: The revision-id to truncate history at. May
1925
be None to copy complete history.
1927
if not isinstance(destination._format, BzrBranchFormat5):
1928
super(BzrBranch, self)._synchronize_history(
1929
destination, revision_id)
1931
if revision_id == _mod_revision.NULL_REVISION:
1934
new_history = self.revision_history()
1935
if revision_id is not None and new_history != []:
1937
new_history = new_history[:new_history.index(revision_id) + 1]
1939
rev = self.repository.get_revision(revision_id)
1940
new_history = rev.get_history(self.repository)[1:]
1941
destination.set_revision_history(new_history)
1944
def set_last_revision_info(self, revno, revision_id):
1945
"""Set the last revision of this branch.
1947
The caller is responsible for checking that the revno is correct
1948
for this revision id.
1950
It may be possible to set the branch last revision to an id not
1951
present in the repository. However, branches can also be
1952
configured to check constraints on history, in which case this may not
1955
revision_id = _mod_revision.ensure_null(revision_id)
1956
# this old format stores the full history, but this api doesn't
1957
# provide it, so we must generate, and might as well check it's
1959
history = self._lefthand_history(revision_id)
1960
if len(history) != revno:
1961
raise AssertionError('%d != %d' % (len(history), revno))
1962
self.set_revision_history(history)
1964
def _gen_revision_history(self):
1965
history = self._transport.get_bytes('revision-history').split('\n')
1966
if history[-1:] == ['']:
1967
# There shouldn't be a trailing newline, but just in case.
1972
def generate_revision_history(self, revision_id, last_rev=None,
1974
"""Create a new revision history that will finish with revision_id.
1976
:param revision_id: the new tip to use.
1977
:param last_rev: The previous last_revision. If not None, then this
1978
must be a ancestory of revision_id, or DivergedBranches is raised.
1979
:param other_branch: The other branch that DivergedBranches should
1980
raise with respect to.
1982
self.set_revision_history(self._lefthand_history(revision_id,
1983
last_rev, other_branch))
1985
def basis_tree(self):
1986
"""See Branch.basis_tree."""
1987
return self.repository.revision_tree(self.last_revision())
1990
def pull(self, source, overwrite=False, stop_revision=None,
1991
_hook_master=None, run_hooks=True, possible_transports=None,
1992
_override_hook_target=None):
1995
:param _hook_master: Private parameter - set the branch to
1996
be supplied as the master to pull hooks.
1997
:param run_hooks: Private parameter - if false, this branch
1998
is being called because it's the master of the primary branch,
1999
so it should not run its hooks.
2000
:param _override_hook_target: Private parameter - set the branch to be
2001
supplied as the target_branch to pull hooks.
2003
result = PullResult()
2004
result.source_branch = source
2005
if _override_hook_target is None:
2006
result.target_branch = self
2008
result.target_branch = _override_hook_target
2011
# We assume that during 'pull' the local repository is closer than
2013
graph = self.repository.get_graph(source.repository)
2014
result.old_revno, result.old_revid = self.last_revision_info()
2015
self.update_revisions(source, stop_revision, overwrite=overwrite,
2017
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2018
result.new_revno, result.new_revid = self.last_revision_info()
2020
result.master_branch = _hook_master
2021
result.local_branch = result.target_branch
2023
result.master_branch = result.target_branch
2024
result.local_branch = None
2026
for hook in Branch.hooks['post_pull']:
2032
def _get_parent_location(self):
2033
_locs = ['parent', 'pull', 'x-pull']
2036
return self._transport.get_bytes(l).strip('\n')
2037
except errors.NoSuchFile:
2042
def push(self, target, overwrite=False, stop_revision=None,
2043
_override_hook_source_branch=None):
2046
This is the basic concrete implementation of push()
2048
:param _override_hook_source_branch: If specified, run
2049
the hooks passing this Branch as the source, rather than self.
2050
This is for use of RemoteBranch, where push is delegated to the
2051
underlying vfs-based Branch.
2053
# TODO: Public option to disable running hooks - should be trivial but
2055
return _run_with_write_locked_target(
2056
target, self._push_with_bound_branches, target, overwrite,
2058
_override_hook_source_branch=_override_hook_source_branch)
2060
def _push_with_bound_branches(self, target, overwrite,
2062
_override_hook_source_branch=None):
2063
"""Push from self into target, and into target's master if any.
2065
This is on the base BzrBranch class even though it doesn't support
2066
bound branches because the *target* might be bound.
2069
if _override_hook_source_branch:
2070
result.source_branch = _override_hook_source_branch
2071
for hook in Branch.hooks['post_push']:
2074
bound_location = target.get_bound_location()
2075
if bound_location and target.base != bound_location:
2076
# there is a master branch.
2078
# XXX: Why the second check? Is it even supported for a branch to
2079
# be bound to itself? -- mbp 20070507
2080
master_branch = target.get_master_branch()
2081
master_branch.lock_write()
2083
# push into the master from this branch.
2084
self._basic_push(master_branch, overwrite, stop_revision)
2085
# and push into the target branch from this. Note that we push from
2086
# this branch again, because its considered the highest bandwidth
2088
result = self._basic_push(target, overwrite, stop_revision)
2089
result.master_branch = master_branch
2090
result.local_branch = target
2094
master_branch.unlock()
2097
result = self._basic_push(target, overwrite, stop_revision)
2098
# TODO: Why set master_branch and local_branch if there's no
2099
# binding? Maybe cleaner to just leave them unset? -- mbp
2101
result.master_branch = target
2102
result.local_branch = None
2106
def _basic_push(self, target, overwrite, stop_revision):
2107
"""Basic implementation of push without bound branches or hooks.
2109
Must be called with self read locked and target write locked.
2111
result = BranchPushResult()
2112
result.source_branch = self
2113
result.target_branch = target
2114
result.old_revno, result.old_revid = target.last_revision_info()
2115
if result.old_revid != self.last_revision():
2116
# We assume that during 'push' this repository is closer than
2118
graph = self.repository.get_graph(target.repository)
2119
target.update_revisions(self, stop_revision, overwrite=overwrite,
2121
if self._push_should_merge_tags():
2122
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2123
result.new_revno, result.new_revid = target.last_revision_info()
2126
def get_stacked_on_url(self):
2127
raise errors.UnstackableBranchFormat(self._format, self.base)
2129
def set_push_location(self, location):
2130
"""See Branch.set_push_location."""
2131
self.get_config().set_user_option(
2132
'push_location', location,
2133
store=_mod_config.STORE_LOCATION_NORECURSE)
2136
def set_parent(self, url):
2137
"""See Branch.set_parent."""
2138
# TODO: Maybe delete old location files?
2139
# URLs should never be unicode, even on the local fs,
2140
# FIXUP this and get_parent in a future branch format bump:
2141
# read and rewrite the file. RBC 20060125
2143
if isinstance(url, unicode):
2145
url = url.encode('ascii')
2146
except UnicodeEncodeError:
2147
raise errors.InvalidURL(url,
2148
"Urls must be 7-bit ascii, "
2149
"use bzrlib.urlutils.escape")
2150
url = urlutils.relative_url(self.base, url)
2151
self._set_parent_location(url)
2153
def _set_parent_location(self, url):
2155
self._transport.delete('parent')
2157
self._transport.put_bytes('parent', url + '\n',
2158
mode=self.bzrdir._get_file_mode())
2160
def set_stacked_on_url(self, url):
2161
raise errors.UnstackableBranchFormat(self._format, self.base)
2164
class BzrBranch5(BzrBranch):
2165
"""A format 5 branch. This supports new features over plain branches.
2167
It has support for a master_branch which is the data for bound branches.
2171
def pull(self, source, overwrite=False, stop_revision=None,
2172
run_hooks=True, possible_transports=None,
2173
_override_hook_target=None):
2174
"""Pull from source into self, updating my master if any.
2176
:param run_hooks: Private parameter - if false, this branch
2177
is being called because it's the master of the primary branch,
2178
so it should not run its hooks.
2180
bound_location = self.get_bound_location()
2181
master_branch = None
2182
if bound_location and source.base != bound_location:
2183
# not pulling from master, so we need to update master.
2184
master_branch = self.get_master_branch(possible_transports)
2185
master_branch.lock_write()
2188
# pull from source into master.
2189
master_branch.pull(source, overwrite, stop_revision,
2191
return super(BzrBranch5, self).pull(source, overwrite,
2192
stop_revision, _hook_master=master_branch,
2193
run_hooks=run_hooks,
2194
_override_hook_target=_override_hook_target)
2197
master_branch.unlock()
2199
def get_bound_location(self):
2201
return self._transport.get_bytes('bound')[:-1]
2202
except errors.NoSuchFile:
2206
def get_master_branch(self, possible_transports=None):
2207
"""Return the branch we are bound to.
2209
:return: Either a Branch, or None
2211
This could memoise the branch, but if thats done
2212
it must be revalidated on each new lock.
2213
So for now we just don't memoise it.
2214
# RBC 20060304 review this decision.
2216
bound_loc = self.get_bound_location()
2220
return Branch.open(bound_loc,
2221
possible_transports=possible_transports)
2222
except (errors.NotBranchError, errors.ConnectionError), e:
2223
raise errors.BoundBranchConnectionFailure(
2227
def set_bound_location(self, location):
2228
"""Set the target where this branch is bound to.
2230
:param location: URL to the target branch
2233
self._transport.put_bytes('bound', location+'\n',
2234
mode=self.bzrdir._get_file_mode())
2237
self._transport.delete('bound')
2238
except errors.NoSuchFile:
2243
def bind(self, other):
2244
"""Bind this branch to the branch other.
2246
This does not push or pull data between the branches, though it does
2247
check for divergence to raise an error when the branches are not
2248
either the same, or one a prefix of the other. That behaviour may not
2249
be useful, so that check may be removed in future.
2251
:param other: The branch to bind to
2254
# TODO: jam 20051230 Consider checking if the target is bound
2255
# It is debatable whether you should be able to bind to
2256
# a branch which is itself bound.
2257
# Committing is obviously forbidden,
2258
# but binding itself may not be.
2259
# Since we *have* to check at commit time, we don't
2260
# *need* to check here
2262
# we want to raise diverged if:
2263
# last_rev is not in the other_last_rev history, AND
2264
# other_last_rev is not in our history, and do it without pulling
2266
self.set_bound_location(other.base)
2270
"""If bound, unbind"""
2271
return self.set_bound_location(None)
2274
def update(self, possible_transports=None):
2275
"""Synchronise this branch with the master branch if any.
2277
:return: None or the last_revision that was pivoted out during the
2280
master = self.get_master_branch(possible_transports)
2281
if master is not None:
2282
old_tip = _mod_revision.ensure_null(self.last_revision())
2283
self.pull(master, overwrite=True)
2284
if self.repository.get_graph().is_ancestor(old_tip,
2285
_mod_revision.ensure_null(self.last_revision())):
2291
class BzrBranch7(BzrBranch5):
2292
"""A branch with support for a fallback repository."""
2294
def _get_fallback_repository(self, url):
2295
"""Get the repository we fallback to at url."""
2296
url = urlutils.join(self.base, url)
2297
a_bzrdir = bzrdir.BzrDir.open(url,
2298
possible_transports=[self._transport])
2299
return a_bzrdir.open_branch().repository
2301
def _activate_fallback_location(self, url):
2302
"""Activate the branch/repository from url as a fallback repository."""
2303
self.repository.add_fallback_repository(
2304
self._get_fallback_repository(url))
2306
def _open_hook(self):
2308
url = self.get_stacked_on_url()
2309
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2310
errors.UnstackableBranchFormat):
2313
for hook in Branch.hooks['transform_fallback_location']:
2314
url = hook(self, url)
2316
hook_name = Branch.hooks.get_hook_name(hook)
2317
raise AssertionError(
2318
"'transform_fallback_location' hook %s returned "
2319
"None, not a URL." % hook_name)
2320
self._activate_fallback_location(url)
2322
def _check_stackable_repo(self):
2323
if not self.repository._format.supports_external_lookups:
2324
raise errors.UnstackableRepositoryFormat(self.repository._format,
2325
self.repository.base)
2327
def __init__(self, *args, **kwargs):
2328
super(BzrBranch7, self).__init__(*args, **kwargs)
2329
self._last_revision_info_cache = None
2330
self._partial_revision_history_cache = []
2332
def _clear_cached_state(self):
2333
super(BzrBranch7, self)._clear_cached_state()
2334
self._last_revision_info_cache = None
2335
self._partial_revision_history_cache = []
2337
def _last_revision_info(self):
2338
revision_string = self._transport.get_bytes('last-revision')
2339
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2340
revision_id = cache_utf8.get_cached_utf8(revision_id)
2342
return revno, revision_id
2344
def _write_last_revision_info(self, revno, revision_id):
2345
"""Simply write out the revision id, with no checks.
2347
Use set_last_revision_info to perform this safely.
2349
Does not update the revision_history cache.
2350
Intended to be called by set_last_revision_info and
2351
_write_revision_history.
2353
revision_id = _mod_revision.ensure_null(revision_id)
2354
out_string = '%d %s\n' % (revno, revision_id)
2355
self._transport.put_bytes('last-revision', out_string,
2356
mode=self.bzrdir._get_file_mode())
2359
def set_last_revision_info(self, revno, revision_id):
2360
revision_id = _mod_revision.ensure_null(revision_id)
2361
old_revno, old_revid = self.last_revision_info()
2362
if self._get_append_revisions_only():
2363
self._check_history_violation(revision_id)
2364
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2365
self._write_last_revision_info(revno, revision_id)
2366
self._clear_cached_state()
2367
self._last_revision_info_cache = revno, revision_id
2368
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2370
def _synchronize_history(self, destination, revision_id):
2371
"""Synchronize last revision and revision history between branches.
2373
:see: Branch._synchronize_history
2375
# XXX: The base Branch has a fast implementation of this method based
2376
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2377
# that uses set_revision_history. This class inherits from BzrBranch5,
2378
# but wants the fast implementation, so it calls
2379
# Branch._synchronize_history directly.
2380
Branch._synchronize_history(self, destination, revision_id)
2382
def _check_history_violation(self, revision_id):
2383
last_revision = _mod_revision.ensure_null(self.last_revision())
2384
if _mod_revision.is_null(last_revision):
2386
if last_revision not in self._lefthand_history(revision_id):
2387
raise errors.AppendRevisionsOnlyViolation(self.base)
2389
def _gen_revision_history(self):
2390
"""Generate the revision history from last revision
2392
last_revno, last_revision = self.last_revision_info()
2393
self._extend_partial_history(stop_index=last_revno-1)
2394
return list(reversed(self._partial_revision_history_cache))
2396
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2397
"""Extend the partial history to include a given index
2399
If a stop_index is supplied, stop when that index has been reached.
2400
If a stop_revision is supplied, stop when that revision is
2401
encountered. Otherwise, stop when the beginning of history is
2404
:param stop_index: The index which should be present. When it is
2405
present, history extension will stop.
2406
:param revision_id: The revision id which should be present. When
2407
it is encountered, history extension will stop.
2409
repo = self.repository
2410
if len(self._partial_revision_history_cache) == 0:
2411
iterator = repo.iter_reverse_revision_history(self.last_revision())
2413
start_revision = self._partial_revision_history_cache[-1]
2414
iterator = repo.iter_reverse_revision_history(start_revision)
2415
#skip the last revision in the list
2416
next_revision = iterator.next()
2417
for revision_id in iterator:
2418
self._partial_revision_history_cache.append(revision_id)
2419
if (stop_index is not None and
2420
len(self._partial_revision_history_cache) > stop_index):
2422
if revision_id == stop_revision:
2425
def _write_revision_history(self, history):
2426
"""Factored out of set_revision_history.
2428
This performs the actual writing to disk, with format-specific checks.
2429
It is intended to be called by BzrBranch5.set_revision_history.
2431
if len(history) == 0:
2432
last_revision = 'null:'
2434
if history != self._lefthand_history(history[-1]):
2435
raise errors.NotLefthandHistory(history)
2436
last_revision = history[-1]
2437
if self._get_append_revisions_only():
2438
self._check_history_violation(last_revision)
2439
self._write_last_revision_info(len(history), last_revision)
2442
def _set_parent_location(self, url):
2443
"""Set the parent branch"""
2444
self._set_config_location('parent_location', url, make_relative=True)
2447
def _get_parent_location(self):
2448
"""Set the parent branch"""
2449
return self._get_config_location('parent_location')
2451
def set_push_location(self, location):
2452
"""See Branch.set_push_location."""
2453
self._set_config_location('push_location', location)
2455
def set_bound_location(self, location):
2456
"""See Branch.set_push_location."""
2458
config = self.get_config()
2459
if location is None:
2460
if config.get_user_option('bound') != 'True':
2463
config.set_user_option('bound', 'False', warn_masked=True)
2466
self._set_config_location('bound_location', location,
2468
config.set_user_option('bound', 'True', warn_masked=True)
2471
def _get_bound_location(self, bound):
2472
"""Return the bound location in the config file.
2474
Return None if the bound parameter does not match"""
2475
config = self.get_config()
2476
config_bound = (config.get_user_option('bound') == 'True')
2477
if config_bound != bound:
2479
return self._get_config_location('bound_location', config=config)
2481
def get_bound_location(self):
2482
"""See Branch.set_push_location."""
2483
return self._get_bound_location(True)
2485
def get_old_bound_location(self):
2486
"""See Branch.get_old_bound_location"""
2487
return self._get_bound_location(False)
2489
def get_stacked_on_url(self):
2490
# you can always ask for the URL; but you might not be able to use it
2491
# if the repo can't support stacking.
2492
## self._check_stackable_repo()
2493
stacked_url = self._get_config_location('stacked_on_location')
2494
if stacked_url is None:
2495
raise errors.NotStacked(self)
2498
def set_append_revisions_only(self, enabled):
2503
self.get_config().set_user_option('append_revisions_only', value,
2506
def set_stacked_on_url(self, url):
2507
self._check_stackable_repo()
2510
old_url = self.get_stacked_on_url()
2511
except (errors.NotStacked, errors.UnstackableBranchFormat,
2512
errors.UnstackableRepositoryFormat):
2515
# repositories don't offer an interface to remove fallback
2516
# repositories today; take the conceptually simpler option and just
2518
self.repository = self.bzrdir.find_repository()
2519
# for every revision reference the branch has, ensure it is pulled
2521
source_repository = self._get_fallback_repository(old_url)
2522
for revision_id in chain([self.last_revision()],
2523
self.tags.get_reverse_tag_dict()):
2524
self.repository.fetch(source_repository, revision_id,
2527
self._activate_fallback_location(url)
2528
# write this out after the repository is stacked to avoid setting a
2529
# stacked config that doesn't work.
2530
self._set_config_location('stacked_on_location', url)
2532
def _get_append_revisions_only(self):
2533
value = self.get_config().get_user_option('append_revisions_only')
2534
return value == 'True'
2537
def generate_revision_history(self, revision_id, last_rev=None,
2539
"""See BzrBranch5.generate_revision_history"""
2540
history = self._lefthand_history(revision_id, last_rev, other_branch)
2541
revno = len(history)
2542
self.set_last_revision_info(revno, revision_id)
2545
def get_rev_id(self, revno, history=None):
2546
"""Find the revision id of the specified revno."""
2548
return _mod_revision.NULL_REVISION
2550
last_revno, last_revision_id = self.last_revision_info()
2551
if revno <= 0 or revno > last_revno:
2552
raise errors.NoSuchRevision(self, revno)
2554
if history is not None:
2555
return history[revno - 1]
2557
index = last_revno - revno
2558
if len(self._partial_revision_history_cache) <= index:
2559
self._extend_partial_history(stop_index=index)
2560
if len(self._partial_revision_history_cache) > index:
2561
return self._partial_revision_history_cache[index]
2563
raise errors.NoSuchRevision(self, revno)
2566
def revision_id_to_revno(self, revision_id):
2567
"""Given a revision id, return its revno"""
2568
if _mod_revision.is_null(revision_id):
2571
index = self._partial_revision_history_cache.index(revision_id)
2573
self._extend_partial_history(stop_revision=revision_id)
2574
index = len(self._partial_revision_history_cache) - 1
2575
if self._partial_revision_history_cache[index] != revision_id:
2576
raise errors.NoSuchRevision(self, revision_id)
2577
return self.revno() - index
2580
class BzrBranch6(BzrBranch7):
2581
"""See BzrBranchFormat6 for the capabilities of this branch.
2583
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2587
def get_stacked_on_url(self):
2588
raise errors.UnstackableBranchFormat(self._format, self.base)
2590
def set_stacked_on_url(self, url):
2591
raise errors.UnstackableBranchFormat(self._format, self.base)
2594
######################################################################
2595
# results of operations
2598
class _Result(object):
2600
def _show_tag_conficts(self, to_file):
2601
if not getattr(self, 'tag_conflicts', None):
2603
to_file.write('Conflicting tags:\n')
2604
for name, value1, value2 in self.tag_conflicts:
2605
to_file.write(' %s\n' % (name, ))
2608
class PullResult(_Result):
2609
"""Result of a Branch.pull operation.
2611
:ivar old_revno: Revision number before pull.
2612
:ivar new_revno: Revision number after pull.
2613
:ivar old_revid: Tip revision id before pull.
2614
:ivar new_revid: Tip revision id after pull.
2615
:ivar source_branch: Source (local) branch object. (read locked)
2616
:ivar master_branch: Master branch of the target, or the target if no
2618
:ivar local_branch: target branch if there is a Master, else None
2619
:ivar target_branch: Target/destination branch object. (write locked)
2620
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2624
# DEPRECATED: pull used to return the change in revno
2625
return self.new_revno - self.old_revno
2627
def report(self, to_file):
2629
if self.old_revid == self.new_revid:
2630
to_file.write('No revisions to pull.\n')
2632
to_file.write('Now on revision %d.\n' % self.new_revno)
2633
self._show_tag_conficts(to_file)
2636
class BranchPushResult(_Result):
2637
"""Result of a Branch.push operation.
2639
:ivar old_revno: Revision number (eg 10) of the target before push.
2640
:ivar new_revno: Revision number (eg 12) of the target after push.
2641
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2643
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2645
:ivar source_branch: Source branch object that the push was from. This is
2646
read locked, and generally is a local (and thus low latency) branch.
2647
:ivar master_branch: If target is a bound branch, the master branch of
2648
target, or target itself. Always write locked.
2649
:ivar target_branch: The direct Branch where data is being sent (write
2651
:ivar local_branch: If the target is a bound branch this will be the
2652
target, otherwise it will be None.
2656
# DEPRECATED: push used to return the change in revno
2657
return self.new_revno - self.old_revno
2659
def report(self, to_file):
2660
"""Write a human-readable description of the result."""
2661
if self.old_revid == self.new_revid:
2662
note('No new revisions to push.')
2664
note('Pushed up to revision %d.' % self.new_revno)
2665
self._show_tag_conficts(to_file)
2668
class BranchCheckResult(object):
2669
"""Results of checking branch consistency.
2674
def __init__(self, branch):
2675
self.branch = branch
2677
def report_results(self, verbose):
2678
"""Report the check results via trace.note.
2680
:param verbose: Requests more detailed display of what was checked,
2683
note('checked branch %s format %s',
2685
self.branch._format)
2688
class Converter5to6(object):
2689
"""Perform an in-place upgrade of format 5 to format 6"""
2691
def convert(self, branch):
2692
# Data for 5 and 6 can peacefully coexist.
2693
format = BzrBranchFormat6()
2694
new_branch = format.open(branch.bzrdir, _found=True)
2696
# Copy source data into target
2697
new_branch._write_last_revision_info(*branch.last_revision_info())
2698
new_branch.set_parent(branch.get_parent())
2699
new_branch.set_bound_location(branch.get_bound_location())
2700
new_branch.set_push_location(branch.get_push_location())
2702
# New branch has no tags by default
2703
new_branch.tags._set_tag_dict({})
2705
# Copying done; now update target format
2706
new_branch._transport.put_bytes('format',
2707
format.get_format_string(),
2708
mode=new_branch.bzrdir._get_file_mode())
2710
# Clean up old files
2711
new_branch._transport.delete('revision-history')
2713
branch.set_parent(None)
2714
except errors.NoSuchFile:
2716
branch.set_bound_location(None)
2719
class Converter6to7(object):
2720
"""Perform an in-place upgrade of format 6 to format 7"""
2722
def convert(self, branch):
2723
format = BzrBranchFormat7()
2724
branch._set_config_location('stacked_on_location', '')
2725
# update target format
2726
branch._transport.put_bytes('format', format.get_format_string())
2730
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2731
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2734
_run_with_write_locked_target will attempt to release the lock it acquires.
2736
If an exception is raised by callable, then that exception *will* be
2737
propagated, even if the unlock attempt raises its own error. Thus
2738
_run_with_write_locked_target should be preferred to simply doing::
2742
return callable(*args, **kwargs)
2747
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2748
# should share code?
2751
result = callable(*args, **kwargs)
2753
exc_info = sys.exc_info()
2757
raise exc_info[0], exc_info[1], exc_info[2]
2763
class InterBranch(InterObject):
2764
"""This class represents operations taking place between two branches.
2766
Its instances have methods like pull() and push() and contain
2767
references to the source and target repositories these operations
2768
can be carried out on.
2772
"""The available optimised InterBranch types."""
2775
def _get_branch_formats_to_test():
2776
"""Return a tuple with the Branch formats to use when testing."""
2777
raise NotImplementedError(self._get_branch_formats_to_test)
2779
def update_revisions(self, stop_revision=None, overwrite=False,
2781
"""Pull in new perfect-fit revisions.
2783
:param stop_revision: Updated until the given revision
2784
:param overwrite: Always set the branch pointer, rather than checking
2785
to see if it is a proper descendant.
2786
:param graph: A Graph object that can be used to query history
2787
information. This can be None.
2790
raise NotImplementedError(self.update_revisions)
2793
class GenericInterBranch(InterBranch):
2794
"""InterBranch implementation that uses public Branch functions.
2798
def _get_branch_formats_to_test():
2799
return BranchFormat._default_format, BranchFormat._default_format
2801
def update_revisions(self, stop_revision=None, overwrite=False,
2803
"""See InterBranch.update_revisions()."""
2804
self.source.lock_read()
2806
other_revno, other_last_revision = self.source.last_revision_info()
2807
stop_revno = None # unknown
2808
if stop_revision is None:
2809
stop_revision = other_last_revision
2810
if _mod_revision.is_null(stop_revision):
2811
# if there are no commits, we're done.
2813
stop_revno = other_revno
2815
# what's the current last revision, before we fetch [and change it
2817
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2818
# we fetch here so that we don't process data twice in the common
2819
# case of having something to pull, and so that the check for
2820
# already merged can operate on the just fetched graph, which will
2821
# be cached in memory.
2822
self.target.fetch(self.source, stop_revision)
2823
# Check to see if one is an ancestor of the other
2826
graph = self.target.repository.get_graph()
2827
if self.target._check_if_descendant_or_diverged(
2828
stop_revision, last_rev, graph, self.source):
2829
# stop_revision is a descendant of last_rev, but we aren't
2830
# overwriting, so we're done.
2832
if stop_revno is None:
2834
graph = self.target.repository.get_graph()
2835
this_revno, this_last_revision = \
2836
self.target.last_revision_info()
2837
stop_revno = graph.find_distance_to_null(stop_revision,
2838
[(other_last_revision, other_revno),
2839
(this_last_revision, this_revno)])
2840
self.target.set_last_revision_info(stop_revno, stop_revision)
2842
self.source.unlock()
2845
def is_compatible(self, source, target):
2846
# GenericBranch uses the public API, so always compatible
2850
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
