1
# Copyright (C) 2005, 2006, 2007, 2008 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,
38
from bzrlib.config import BranchConfig
39
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
40
from bzrlib.tag import (
46
from bzrlib.decorators import needs_read_lock, needs_write_lock
47
from bzrlib.hooks import Hooks
48
from bzrlib.inter import InterObject
49
from bzrlib import registry
50
from bzrlib.symbol_versioning import (
54
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
57
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
58
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
59
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
62
# TODO: Maybe include checks for common corruption of newlines, etc?
64
# TODO: Some operations like log might retrieve the same revisions
65
# repeatedly to calculate deltas. We could perhaps have a weakref
66
# cache in memory to make this faster. In general anything can be
67
# cached in memory between lock and unlock operations. .. nb thats
68
# what the transaction identity map provides
71
######################################################################
75
"""Branch holding a history of revisions.
78
Base directory/url of the branch.
80
hooks: An instance of BranchHooks.
82
# this is really an instance variable - FIXME move it there
86
# override this to set the strategy for storing tags
88
return DisabledTags(self)
90
def __init__(self, *ignored, **ignored_too):
91
self.tags = self._make_tags()
92
self._revision_history_cache = None
93
self._revision_id_to_revno_cache = None
94
self._partial_revision_id_to_revno_cache = {}
95
self._last_revision_info_cache = None
96
self._merge_sorted_revisions_cache = None
98
hooks = Branch.hooks['open']
102
def _open_hook(self):
103
"""Called by init to allow simpler extension of the base class."""
105
def break_lock(self):
106
"""Break a lock if one is present from another instance.
108
Uses the ui factory to ask for confirmation if the lock may be from
111
This will probe the repository for its lock as well.
113
self.control_files.break_lock()
114
self.repository.break_lock()
115
master = self.get_master_branch()
116
if master is not None:
120
def open(base, _unsupported=False, possible_transports=None):
121
"""Open the branch rooted at base.
123
For instance, if the branch is at URL/.bzr/branch,
124
Branch.open(URL) -> a Branch instance.
126
control = bzrdir.BzrDir.open(base, _unsupported,
127
possible_transports=possible_transports)
128
return control.open_branch(_unsupported)
131
def open_from_transport(transport, _unsupported=False):
132
"""Open the branch rooted at transport"""
133
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
134
return control.open_branch(_unsupported)
137
def open_containing(url, possible_transports=None):
138
"""Open an existing branch which contains url.
140
This probes for a branch at url, and searches upwards from there.
142
Basically we keep looking up until we find the control directory or
143
run into the root. If there isn't one, raises NotBranchError.
144
If there is one and it is either an unrecognised format or an unsupported
145
format, UnknownFormatError or UnsupportedFormatError are raised.
146
If there is one, it is returned, along with the unused portion of url.
148
control, relpath = bzrdir.BzrDir.open_containing(url,
150
return control.open_branch(), relpath
152
def _push_should_merge_tags(self):
153
"""Should _basic_push merge this branch's tags into the target?
155
The default implementation returns False if this branch has no tags,
156
and True the rest of the time. Subclasses may override this.
158
return self.tags.supports_tags() and self.tags.get_tag_dict()
160
def get_config(self):
161
return BranchConfig(self)
163
def _get_nick(self, local=False, possible_transports=None):
164
config = self.get_config()
165
# explicit overrides master, but don't look for master if local is True
166
if not local and not config.has_explicit_nickname():
168
master = self.get_master_branch(possible_transports)
169
if master is not None:
170
# return the master branch value
172
except errors.BzrError, e:
173
# Silently fall back to local implicit nick if the master is
175
mutter("Could not connect to bound branch, "
176
"falling back to local nick.\n " + str(e))
177
return config.get_nickname()
179
def _set_nick(self, nick):
180
self.get_config().set_user_option('nickname', nick, warn_masked=True)
182
nick = property(_get_nick, _set_nick)
185
raise NotImplementedError(self.is_locked)
187
def _lefthand_history(self, revision_id, last_rev=None,
189
if 'evil' in debug.debug_flags:
190
mutter_callsite(4, "_lefthand_history scales with history.")
191
# stop_revision must be a descendant of last_revision
192
graph = self.repository.get_graph()
193
if last_rev is not None:
194
if not graph.is_ancestor(last_rev, revision_id):
195
# our previous tip is not merged into stop_revision
196
raise errors.DivergedBranches(self, other_branch)
197
# make a new revision history from the graph
198
parents_map = graph.get_parent_map([revision_id])
199
if revision_id not in parents_map:
200
raise errors.NoSuchRevision(self, revision_id)
201
current_rev_id = revision_id
203
check_not_reserved_id = _mod_revision.check_not_reserved_id
204
# Do not include ghosts or graph origin in revision_history
205
while (current_rev_id in parents_map and
206
len(parents_map[current_rev_id]) > 0):
207
check_not_reserved_id(current_rev_id)
208
new_history.append(current_rev_id)
209
current_rev_id = parents_map[current_rev_id][0]
210
parents_map = graph.get_parent_map([current_rev_id])
211
new_history.reverse()
214
def lock_write(self):
215
raise NotImplementedError(self.lock_write)
218
raise NotImplementedError(self.lock_read)
221
raise NotImplementedError(self.unlock)
223
def peek_lock_mode(self):
224
"""Return lock mode for the Branch: 'r', 'w' or None"""
225
raise NotImplementedError(self.peek_lock_mode)
227
def get_physical_lock_status(self):
228
raise NotImplementedError(self.get_physical_lock_status)
231
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
232
"""Return the revision_id for a dotted revno.
234
:param revno: a tuple like (1,) or (1,1,2)
235
:param _cache_reverse: a private parameter enabling storage
236
of the reverse mapping in a top level cache. (This should
237
only be done in selective circumstances as we want to
238
avoid having the mapping cached multiple times.)
239
:return: the revision_id
240
:raises errors.NoSuchRevision: if the revno doesn't exist
242
rev_id = self._do_dotted_revno_to_revision_id(revno)
244
self._partial_revision_id_to_revno_cache[rev_id] = revno
247
def _do_dotted_revno_to_revision_id(self, revno):
248
"""Worker function for dotted_revno_to_revision_id.
250
Subclasses should override this if they wish to
251
provide a more efficient implementation.
254
return self.get_rev_id(revno[0])
255
revision_id_to_revno = self.get_revision_id_to_revno_map()
256
revision_ids = [revision_id for revision_id, this_revno
257
in revision_id_to_revno.iteritems()
258
if revno == this_revno]
259
if len(revision_ids) == 1:
260
return revision_ids[0]
262
revno_str = '.'.join(map(str, revno))
263
raise errors.NoSuchRevision(self, revno_str)
266
def revision_id_to_dotted_revno(self, revision_id):
267
"""Given a revision id, return its dotted revno.
269
:return: a tuple like (1,) or (400,1,3).
271
return self._do_revision_id_to_dotted_revno(revision_id)
273
def _do_revision_id_to_dotted_revno(self, revision_id):
274
"""Worker function for revision_id_to_revno."""
275
# Try the caches if they are loaded
276
result = self._partial_revision_id_to_revno_cache.get(revision_id)
277
if result is not None:
279
if self._revision_id_to_revno_cache:
280
result = self._revision_id_to_revno_cache.get(revision_id)
282
raise errors.NoSuchRevision(self, revision_id)
283
# Try the mainline as it's optimised
285
revno = self.revision_id_to_revno(revision_id)
287
except errors.NoSuchRevision:
288
# We need to load and use the full revno map after all
289
result = self.get_revision_id_to_revno_map().get(revision_id)
291
raise errors.NoSuchRevision(self, revision_id)
295
def get_revision_id_to_revno_map(self):
296
"""Return the revision_id => dotted revno map.
298
This will be regenerated on demand, but will be cached.
300
:return: A dictionary mapping revision_id => dotted revno.
301
This dictionary should not be modified by the caller.
303
if self._revision_id_to_revno_cache is not None:
304
mapping = self._revision_id_to_revno_cache
306
mapping = self._gen_revno_map()
307
self._cache_revision_id_to_revno(mapping)
308
# TODO: jam 20070417 Since this is being cached, should we be returning
310
# I would rather not, and instead just declare that users should not
311
# modify the return value.
314
def _gen_revno_map(self):
315
"""Create a new mapping from revision ids to dotted revnos.
317
Dotted revnos are generated based on the current tip in the revision
319
This is the worker function for get_revision_id_to_revno_map, which
320
just caches the return value.
322
:return: A dictionary mapping revision_id => dotted revno.
324
revision_id_to_revno = dict((rev_id, revno)
325
for rev_id, depth, revno, end_of_merge
326
in self.iter_merge_sorted_revisions())
327
return revision_id_to_revno
330
def iter_merge_sorted_revisions(self, start_revision_id=None,
331
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
332
"""Walk the revisions for a branch in merge sorted order.
334
Merge sorted order is the output from a merge-aware,
335
topological sort, i.e. all parents come before their
336
children going forward; the opposite for reverse.
338
:param start_revision_id: the revision_id to begin walking from.
339
If None, the branch tip is used.
340
:param stop_revision_id: the revision_id to terminate the walk
341
after. If None, the rest of history is included.
342
:param stop_rule: if stop_revision_id is not None, the precise rule
343
to use for termination:
344
* 'exclude' - leave the stop revision out of the result (default)
345
* 'include' - the stop revision is the last item in the result
346
* 'with-merges' - include the stop revision and all of its
347
merged revisions in the result
348
:param direction: either 'reverse' or 'forward':
349
* reverse means return the start_revision_id first, i.e.
350
start at the most recent revision and go backwards in history
351
* forward returns tuples in the opposite order to reverse.
352
Note in particular that forward does *not* do any intelligent
353
ordering w.r.t. depth as some clients of this API may like.
354
(If required, that ought to be done at higher layers.)
356
:return: an iterator over (revision_id, depth, revno, end_of_merge)
359
* revision_id: the unique id of the revision
360
* depth: How many levels of merging deep this node has been
362
* revno_sequence: This field provides a sequence of
363
revision numbers for all revisions. The format is:
364
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
365
branch that the revno is on. From left to right the REVNO numbers
366
are the sequence numbers within that branch of the revision.
367
* end_of_merge: When True the next node (earlier in history) is
368
part of a different merge.
370
# Note: depth and revno values are in the context of the branch so
371
# we need the full graph to get stable numbers, regardless of the
373
if self._merge_sorted_revisions_cache is None:
374
last_revision = self.last_revision()
375
graph = self.repository.get_graph()
376
parent_map = dict(((key, value) for key, value in
377
graph.iter_ancestry([last_revision]) if value is not None))
378
revision_graph = repository._strip_NULL_ghosts(parent_map)
379
revs = tsort.merge_sort(revision_graph, last_revision, None,
381
# Drop the sequence # before caching
382
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
384
filtered = self._filter_merge_sorted_revisions(
385
self._merge_sorted_revisions_cache, start_revision_id,
386
stop_revision_id, stop_rule)
387
if direction == 'reverse':
389
if direction == 'forward':
390
return reversed(list(filtered))
392
raise ValueError('invalid direction %r' % direction)
394
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
395
start_revision_id, stop_revision_id, stop_rule):
396
"""Iterate over an inclusive range of sorted revisions."""
397
rev_iter = iter(merge_sorted_revisions)
398
if start_revision_id is not None:
399
for rev_id, depth, revno, end_of_merge in rev_iter:
400
if rev_id != start_revision_id:
403
# The decision to include the start or not
404
# depends on the stop_rule if a stop is provided
406
iter([(rev_id, depth, revno, end_of_merge)]),
409
if stop_revision_id is None:
410
for rev_id, depth, revno, end_of_merge in rev_iter:
411
yield rev_id, depth, revno, end_of_merge
412
elif stop_rule == 'exclude':
413
for rev_id, depth, revno, end_of_merge in rev_iter:
414
if rev_id == stop_revision_id:
416
yield rev_id, depth, revno, end_of_merge
417
elif stop_rule == 'include':
418
for rev_id, depth, revno, end_of_merge in rev_iter:
419
yield rev_id, depth, revno, end_of_merge
420
if rev_id == stop_revision_id:
422
elif stop_rule == 'with-merges':
423
stop_rev = self.repository.get_revision(stop_revision_id)
424
if stop_rev.parent_ids:
425
left_parent = stop_rev.parent_ids[0]
427
left_parent = _mod_revision.NULL_REVISION
428
for rev_id, depth, revno, end_of_merge in rev_iter:
429
if rev_id == left_parent:
431
yield rev_id, depth, revno, end_of_merge
433
raise ValueError('invalid stop_rule %r' % stop_rule)
435
def leave_lock_in_place(self):
436
"""Tell this branch object not to release the physical lock when this
439
If lock_write doesn't return a token, then this method is not supported.
441
self.control_files.leave_in_place()
443
def dont_leave_lock_in_place(self):
444
"""Tell this branch object to release the physical lock when this
445
object is unlocked, even if it didn't originally acquire it.
447
If lock_write doesn't return a token, then this method is not supported.
449
self.control_files.dont_leave_in_place()
451
def bind(self, other):
452
"""Bind the local branch the other branch.
454
:param other: The branch to bind to
457
raise errors.UpgradeRequired(self.base)
460
def fetch(self, from_branch, last_revision=None, pb=None):
461
"""Copy revisions from from_branch into this branch.
463
:param from_branch: Where to copy from.
464
:param last_revision: What revision to stop at (None for at the end
466
:param pb: An optional progress bar to use.
469
if self.base == from_branch.base:
472
nested_pb = ui.ui_factory.nested_progress_bar()
477
from_branch.lock_read()
479
if last_revision is None:
480
pb.update('get source history')
481
last_revision = from_branch.last_revision()
482
last_revision = _mod_revision.ensure_null(last_revision)
483
return self.repository.fetch(from_branch.repository,
484
revision_id=last_revision,
487
if nested_pb is not None:
491
def get_bound_location(self):
492
"""Return the URL of the branch we are bound to.
494
Older format branches cannot bind, please be sure to use a metadir
499
def get_old_bound_location(self):
500
"""Return the URL of the branch we used to be bound to
502
raise errors.UpgradeRequired(self.base)
504
def get_commit_builder(self, parents, config=None, timestamp=None,
505
timezone=None, committer=None, revprops=None,
507
"""Obtain a CommitBuilder for this branch.
509
:param parents: Revision ids of the parents of the new revision.
510
:param config: Optional configuration to use.
511
:param timestamp: Optional timestamp recorded for commit.
512
:param timezone: Optional timezone for timestamp.
513
:param committer: Optional committer to set for commit.
514
:param revprops: Optional dictionary of revision properties.
515
:param revision_id: Optional revision id.
519
config = self.get_config()
521
return self.repository.get_commit_builder(self, parents, config,
522
timestamp, timezone, committer, revprops, revision_id)
524
def get_master_branch(self, possible_transports=None):
525
"""Return the branch we are bound to.
527
:return: Either a Branch, or None
531
def get_revision_delta(self, revno):
532
"""Return the delta for one revision.
534
The delta is relative to its mainline predecessor, or the
535
empty tree for revision 1.
537
rh = self.revision_history()
538
if not (1 <= revno <= len(rh)):
539
raise errors.InvalidRevisionNumber(revno)
540
return self.repository.get_revision_delta(rh[revno-1])
542
def get_stacked_on_url(self):
543
"""Get the URL this branch is stacked against.
545
:raises NotStacked: If the branch is not stacked.
546
:raises UnstackableBranchFormat: If the branch does not support
549
raise NotImplementedError(self.get_stacked_on_url)
551
def print_file(self, file, revision_id):
552
"""Print `file` to stdout."""
553
raise NotImplementedError(self.print_file)
555
def set_revision_history(self, rev_history):
556
raise NotImplementedError(self.set_revision_history)
558
def set_stacked_on_url(self, url):
559
"""Set the URL this branch is stacked against.
561
:raises UnstackableBranchFormat: If the branch does not support
563
:raises UnstackableRepositoryFormat: If the repository does not support
566
raise NotImplementedError(self.set_stacked_on_url)
568
def _cache_revision_history(self, rev_history):
569
"""Set the cached revision history to rev_history.
571
The revision_history method will use this cache to avoid regenerating
572
the revision history.
574
This API is semi-public; it only for use by subclasses, all other code
575
should consider it to be private.
577
self._revision_history_cache = rev_history
579
def _cache_revision_id_to_revno(self, revision_id_to_revno):
580
"""Set the cached revision_id => revno map to revision_id_to_revno.
582
This API is semi-public; it only for use by subclasses, all other code
583
should consider it to be private.
585
self._revision_id_to_revno_cache = revision_id_to_revno
587
def _clear_cached_state(self):
588
"""Clear any cached data on this branch, e.g. cached revision history.
590
This means the next call to revision_history will need to call
591
_gen_revision_history.
593
This API is semi-public; it only for use by subclasses, all other code
594
should consider it to be private.
596
self._revision_history_cache = None
597
self._revision_id_to_revno_cache = None
598
self._last_revision_info_cache = None
599
self._merge_sorted_revisions_cache = None
601
def _gen_revision_history(self):
602
"""Return sequence of revision hashes on to this branch.
604
Unlike revision_history, this method always regenerates or rereads the
605
revision history, i.e. it does not cache the result, so repeated calls
608
Concrete subclasses should override this instead of revision_history so
609
that subclasses do not need to deal with caching logic.
611
This API is semi-public; it only for use by subclasses, all other code
612
should consider it to be private.
614
raise NotImplementedError(self._gen_revision_history)
617
def revision_history(self):
618
"""Return sequence of revision ids on this branch.
620
This method will cache the revision history for as long as it is safe to
623
if 'evil' in debug.debug_flags:
624
mutter_callsite(3, "revision_history scales with history.")
625
if self._revision_history_cache is not None:
626
history = self._revision_history_cache
628
history = self._gen_revision_history()
629
self._cache_revision_history(history)
633
"""Return current revision number for this branch.
635
That is equivalent to the number of revisions committed to
638
return self.last_revision_info()[0]
641
"""Older format branches cannot bind or unbind."""
642
raise errors.UpgradeRequired(self.base)
644
def set_append_revisions_only(self, enabled):
645
"""Older format branches are never restricted to append-only"""
646
raise errors.UpgradeRequired(self.base)
648
def last_revision(self):
649
"""Return last revision id, or NULL_REVISION."""
650
return self.last_revision_info()[1]
653
def last_revision_info(self):
654
"""Return information about the last revision.
656
:return: A tuple (revno, revision_id).
658
if self._last_revision_info_cache is None:
659
self._last_revision_info_cache = self._last_revision_info()
660
return self._last_revision_info_cache
662
def _last_revision_info(self):
663
rh = self.revision_history()
666
return (revno, rh[-1])
668
return (0, _mod_revision.NULL_REVISION)
670
@deprecated_method(deprecated_in((1, 6, 0)))
671
def missing_revisions(self, other, stop_revision=None):
672
"""Return a list of new revisions that would perfectly fit.
674
If self and other have not diverged, return a list of the revisions
675
present in other, but missing from self.
677
self_history = self.revision_history()
678
self_len = len(self_history)
679
other_history = other.revision_history()
680
other_len = len(other_history)
681
common_index = min(self_len, other_len) -1
682
if common_index >= 0 and \
683
self_history[common_index] != other_history[common_index]:
684
raise errors.DivergedBranches(self, other)
686
if stop_revision is None:
687
stop_revision = other_len
689
if stop_revision > other_len:
690
raise errors.NoSuchRevision(self, stop_revision)
691
return other_history[self_len:stop_revision]
694
def update_revisions(self, other, stop_revision=None, overwrite=False,
696
"""Pull in new perfect-fit revisions.
698
:param other: Another Branch to pull from
699
:param stop_revision: Updated until the given revision
700
:param overwrite: Always set the branch pointer, rather than checking
701
to see if it is a proper descendant.
702
:param graph: A Graph object that can be used to query history
703
information. This can be None.
706
return InterBranch.get(other, self).update_revisions(stop_revision,
709
def import_last_revision_info(self, source_repo, revno, revid):
710
"""Set the last revision info, importing from another repo if necessary.
712
This is used by the bound branch code to upload a revision to
713
the master branch first before updating the tip of the local branch.
715
:param source_repo: Source repository to optionally fetch from
716
:param revno: Revision number of the new tip
717
:param revid: Revision id of the new tip
719
if not self.repository.has_same_location(source_repo):
720
self.repository.fetch(source_repo, revision_id=revid)
721
self.set_last_revision_info(revno, revid)
723
def revision_id_to_revno(self, revision_id):
724
"""Given a revision id, return its revno"""
725
if _mod_revision.is_null(revision_id):
727
history = self.revision_history()
729
return history.index(revision_id) + 1
731
raise errors.NoSuchRevision(self, revision_id)
733
def get_rev_id(self, revno, history=None):
734
"""Find the revision id of the specified revno."""
736
return _mod_revision.NULL_REVISION
738
history = self.revision_history()
739
if revno <= 0 or revno > len(history):
740
raise errors.NoSuchRevision(self, revno)
741
return history[revno - 1]
743
def pull(self, source, overwrite=False, stop_revision=None,
744
possible_transports=None, _override_hook_target=None):
745
"""Mirror source into this branch.
747
This branch is considered to be 'local', having low latency.
749
:returns: PullResult instance
751
raise NotImplementedError(self.pull)
753
def push(self, target, overwrite=False, stop_revision=None):
754
"""Mirror this branch into target.
756
This branch is considered to be 'local', having low latency.
758
raise NotImplementedError(self.push)
760
def basis_tree(self):
761
"""Return `Tree` object for last revision."""
762
return self.repository.revision_tree(self.last_revision())
764
def get_parent(self):
765
"""Return the parent location of the branch.
767
This is the default location for pull/missing. The usual
768
pattern is that the user can override it by specifying a
771
parent = self._get_parent_location()
774
# This is an old-format absolute path to a local branch
776
if parent.startswith('/'):
777
parent = urlutils.local_path_to_url(parent.decode('utf8'))
779
return urlutils.join(self.base[:-1], parent)
780
except errors.InvalidURLJoin, e:
781
raise errors.InaccessibleParent(parent, self.base)
783
def _get_parent_location(self):
784
raise NotImplementedError(self._get_parent_location)
786
def _set_config_location(self, name, url, config=None,
787
make_relative=False):
789
config = self.get_config()
793
url = urlutils.relative_url(self.base, url)
794
config.set_user_option(name, url, warn_masked=True)
796
def _get_config_location(self, name, config=None):
798
config = self.get_config()
799
location = config.get_user_option(name)
804
def get_submit_branch(self):
805
"""Return the submit location of the branch.
807
This is the default location for bundle. The usual
808
pattern is that the user can override it by specifying a
811
return self.get_config().get_user_option('submit_branch')
813
def set_submit_branch(self, location):
814
"""Return the submit location of the branch.
816
This is the default location for bundle. The usual
817
pattern is that the user can override it by specifying a
820
self.get_config().set_user_option('submit_branch', location,
823
def get_public_branch(self):
824
"""Return the public location of the branch.
826
This is is used by merge directives.
828
return self._get_config_location('public_branch')
830
def set_public_branch(self, location):
831
"""Return the submit location of the branch.
833
This is the default location for bundle. The usual
834
pattern is that the user can override it by specifying a
837
self._set_config_location('public_branch', location)
839
def get_push_location(self):
840
"""Return the None or the location to push this branch to."""
841
push_loc = self.get_config().get_user_option('push_location')
844
def set_push_location(self, location):
845
"""Set a new push location for this branch."""
846
raise NotImplementedError(self.set_push_location)
848
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
849
"""Run the post_change_branch_tip hooks."""
850
hooks = Branch.hooks['post_change_branch_tip']
853
new_revno, new_revid = self.last_revision_info()
854
params = ChangeBranchTipParams(
855
self, old_revno, new_revno, old_revid, new_revid)
859
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
860
"""Run the pre_change_branch_tip hooks."""
861
hooks = Branch.hooks['pre_change_branch_tip']
864
old_revno, old_revid = self.last_revision_info()
865
params = ChangeBranchTipParams(
866
self, old_revno, new_revno, old_revid, new_revid)
870
except errors.TipChangeRejected:
873
exc_info = sys.exc_info()
874
hook_name = Branch.hooks.get_hook_name(hook)
875
raise errors.HookFailed(
876
'pre_change_branch_tip', hook_name, exc_info)
878
def set_parent(self, url):
879
raise NotImplementedError(self.set_parent)
883
"""Synchronise this branch with the master branch if any.
885
:return: None or the last_revision pivoted out during the update.
889
def check_revno(self, revno):
891
Check whether a revno corresponds to any revision.
892
Zero (the NULL revision) is considered valid.
895
self.check_real_revno(revno)
897
def check_real_revno(self, revno):
899
Check whether a revno corresponds to a real revision.
900
Zero (the NULL revision) is considered invalid
902
if revno < 1 or revno > self.revno():
903
raise errors.InvalidRevisionNumber(revno)
906
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
907
"""Clone this branch into to_bzrdir preserving all semantic values.
909
Most API users will want 'create_clone_on_transport', which creates a
910
new bzrdir and branch on the fly.
912
revision_id: if not None, the revision history in the new branch will
913
be truncated to end with revision_id.
915
result = to_bzrdir.create_branch()
916
if repository_policy is not None:
917
repository_policy.configure_branch(result)
918
self.copy_content_into(result, revision_id=revision_id)
922
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
923
"""Create a new line of development from the branch, into to_bzrdir.
925
to_bzrdir controls the branch format.
927
revision_id: if not None, the revision history in the new branch will
928
be truncated to end with revision_id.
930
result = to_bzrdir.create_branch()
931
if repository_policy is not None:
932
repository_policy.configure_branch(result)
933
self.copy_content_into(result, revision_id=revision_id)
934
result.set_parent(self.bzrdir.root_transport.base)
937
def _synchronize_history(self, destination, revision_id):
938
"""Synchronize last revision and revision history between branches.
940
This version is most efficient when the destination is also a
941
BzrBranch6, but works for BzrBranch5, as long as the destination's
942
repository contains all the lefthand ancestors of the intended
943
last_revision. If not, set_last_revision_info will fail.
945
:param destination: The branch to copy the history into
946
:param revision_id: The revision-id to truncate history at. May
947
be None to copy complete history.
949
source_revno, source_revision_id = self.last_revision_info()
950
if revision_id is None:
951
revno, revision_id = source_revno, source_revision_id
952
elif source_revision_id == revision_id:
953
# we know the revno without needing to walk all of history
956
# To figure out the revno for a random revision, we need to build
957
# the revision history, and count its length.
958
# We don't care about the order, just how long it is.
959
# Alternatively, we could start at the current location, and count
960
# backwards. But there is no guarantee that we will find it since
961
# it may be a merged revision.
962
revno = len(list(self.repository.iter_reverse_revision_history(
964
destination.set_last_revision_info(revno, revision_id)
967
def copy_content_into(self, destination, revision_id=None):
968
"""Copy the content of self into destination.
970
revision_id: if not None, the revision history in the new branch will
971
be truncated to end with revision_id.
973
self._synchronize_history(destination, revision_id)
975
parent = self.get_parent()
976
except errors.InaccessibleParent, e:
977
mutter('parent was not accessible to copy: %s', e)
980
destination.set_parent(parent)
981
if self._push_should_merge_tags():
982
self.tags.merge_to(destination.tags)
986
"""Check consistency of the branch.
988
In particular this checks that revisions given in the revision-history
989
do actually match up in the revision graph, and that they're all
990
present in the repository.
992
Callers will typically also want to check the repository.
994
:return: A BranchCheckResult.
996
mainline_parent_id = None
997
last_revno, last_revision_id = self.last_revision_info()
998
real_rev_history = list(self.repository.iter_reverse_revision_history(
1000
real_rev_history.reverse()
1001
if len(real_rev_history) != last_revno:
1002
raise errors.BzrCheckError('revno does not match len(mainline)'
1003
' %s != %s' % (last_revno, len(real_rev_history)))
1004
# TODO: We should probably also check that real_rev_history actually
1005
# matches self.revision_history()
1006
for revision_id in real_rev_history:
1008
revision = self.repository.get_revision(revision_id)
1009
except errors.NoSuchRevision, e:
1010
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1012
# In general the first entry on the revision history has no parents.
1013
# But it's not illegal for it to have parents listed; this can happen
1014
# in imports from Arch when the parents weren't reachable.
1015
if mainline_parent_id is not None:
1016
if mainline_parent_id not in revision.parent_ids:
1017
raise errors.BzrCheckError("previous revision {%s} not listed among "
1019
% (mainline_parent_id, revision_id))
1020
mainline_parent_id = revision_id
1021
return BranchCheckResult(self)
1023
def _get_checkout_format(self):
1024
"""Return the most suitable metadir for a checkout of this branch.
1025
Weaves are used if this branch's repository uses weaves.
1027
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1028
from bzrlib.repofmt import weaverepo
1029
format = bzrdir.BzrDirMetaFormat1()
1030
format.repository_format = weaverepo.RepositoryFormat7()
1032
format = self.repository.bzrdir.checkout_metadir()
1033
format.set_branch_format(self._format)
1036
def create_clone_on_transport(self, to_transport, revision_id=None,
1038
"""Create a clone of this branch and its bzrdir.
1040
:param to_transport: The transport to clone onto.
1041
:param revision_id: The revision id to use as tip in the new branch.
1042
If None the tip is obtained from this branch.
1043
:param stacked_on: An optional URL to stack the clone on.
1045
# XXX: Fix the bzrdir API to allow getting the branch back from the
1046
# clone call. Or something. 20090224 RBC/spiv.
1047
dir_to = self.bzrdir.clone_on_transport(to_transport,
1048
revision_id=revision_id, stacked_on=stacked_on)
1049
return dir_to.open_branch()
1051
def create_checkout(self, to_location, revision_id=None,
1052
lightweight=False, accelerator_tree=None,
1054
"""Create a checkout of a branch.
1056
:param to_location: The url to produce the checkout at
1057
:param revision_id: The revision to check out
1058
:param lightweight: If True, produce a lightweight checkout, otherwise,
1059
produce a bound branch (heavyweight checkout)
1060
:param accelerator_tree: A tree which can be used for retrieving file
1061
contents more quickly than the revision tree, i.e. a workingtree.
1062
The revision tree will be used for cases where accelerator_tree's
1063
content is different.
1064
:param hardlink: If true, hard-link files from accelerator_tree,
1066
:return: The tree of the created checkout
1068
t = transport.get_transport(to_location)
1071
format = self._get_checkout_format()
1072
checkout = format.initialize_on_transport(t)
1073
from_branch = BranchReferenceFormat().initialize(checkout, self)
1075
format = self._get_checkout_format()
1076
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1077
to_location, force_new_tree=False, format=format)
1078
checkout = checkout_branch.bzrdir
1079
checkout_branch.bind(self)
1080
# pull up to the specified revision_id to set the initial
1081
# branch tip correctly, and seed it with history.
1082
checkout_branch.pull(self, stop_revision=revision_id)
1084
tree = checkout.create_workingtree(revision_id,
1085
from_branch=from_branch,
1086
accelerator_tree=accelerator_tree,
1088
basis_tree = tree.basis_tree()
1089
basis_tree.lock_read()
1091
for path, file_id in basis_tree.iter_references():
1092
reference_parent = self.reference_parent(file_id, path)
1093
reference_parent.create_checkout(tree.abspath(path),
1094
basis_tree.get_reference_revision(file_id, path),
1101
def reconcile(self, thorough=True):
1102
"""Make sure the data stored in this branch is consistent."""
1103
from bzrlib.reconcile import BranchReconciler
1104
reconciler = BranchReconciler(self, thorough=thorough)
1105
reconciler.reconcile()
1108
def reference_parent(self, file_id, path):
1109
"""Return the parent branch for a tree-reference file_id
1110
:param file_id: The file_id of the tree reference
1111
:param path: The path of the file_id in the tree
1112
:return: A branch associated with the file_id
1114
# FIXME should provide multiple branches, based on config
1115
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1117
def supports_tags(self):
1118
return self._format.supports_tags()
1120
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1122
"""Ensure that revision_b is a descendant of revision_a.
1124
This is a helper function for update_revisions.
1126
:raises: DivergedBranches if revision_b has diverged from revision_a.
1127
:returns: True if revision_b is a descendant of revision_a.
1129
relation = self._revision_relations(revision_a, revision_b, graph)
1130
if relation == 'b_descends_from_a':
1132
elif relation == 'diverged':
1133
raise errors.DivergedBranches(self, other_branch)
1134
elif relation == 'a_descends_from_b':
1137
raise AssertionError("invalid relation: %r" % (relation,))
1139
def _revision_relations(self, revision_a, revision_b, graph):
1140
"""Determine the relationship between two revisions.
1142
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1144
heads = graph.heads([revision_a, revision_b])
1145
if heads == set([revision_b]):
1146
return 'b_descends_from_a'
1147
elif heads == set([revision_a, revision_b]):
1148
# These branches have diverged
1150
elif heads == set([revision_a]):
1151
return 'a_descends_from_b'
1153
raise AssertionError("invalid heads: %r" % (heads,))
1156
class BranchFormat(object):
1157
"""An encapsulation of the initialization and open routines for a format.
1159
Formats provide three things:
1160
* An initialization routine,
1164
Formats are placed in an dict by their format string for reference
1165
during branch opening. Its not required that these be instances, they
1166
can be classes themselves with class methods - it simply depends on
1167
whether state is needed for a given format or not.
1169
Once a format is deprecated, just deprecate the initialize and open
1170
methods on the format class. Do not deprecate the object, as the
1171
object will be created every time regardless.
1174
_default_format = None
1175
"""The default format used for new branches."""
1178
"""The known formats."""
1180
def __eq__(self, other):
1181
return self.__class__ is other.__class__
1183
def __ne__(self, other):
1184
return not (self == other)
1187
def find_format(klass, a_bzrdir):
1188
"""Return the format for the branch object in a_bzrdir."""
1190
transport = a_bzrdir.get_branch_transport(None)
1191
format_string = transport.get("format").read()
1192
return klass._formats[format_string]
1193
except errors.NoSuchFile:
1194
raise errors.NotBranchError(path=transport.base)
1196
raise errors.UnknownFormatError(format=format_string, kind='branch')
1199
def get_default_format(klass):
1200
"""Return the current default format."""
1201
return klass._default_format
1203
def get_reference(self, a_bzrdir):
1204
"""Get the target reference of the branch in a_bzrdir.
1206
format probing must have been completed before calling
1207
this method - it is assumed that the format of the branch
1208
in a_bzrdir is correct.
1210
:param a_bzrdir: The bzrdir to get the branch data from.
1211
:return: None if the branch is not a reference branch.
1216
def set_reference(self, a_bzrdir, to_branch):
1217
"""Set the target reference of the branch in a_bzrdir.
1219
format probing must have been completed before calling
1220
this method - it is assumed that the format of the branch
1221
in a_bzrdir is correct.
1223
:param a_bzrdir: The bzrdir to set the branch reference for.
1224
:param to_branch: branch that the checkout is to reference
1226
raise NotImplementedError(self.set_reference)
1228
def get_format_string(self):
1229
"""Return the ASCII format string that identifies this format."""
1230
raise NotImplementedError(self.get_format_string)
1232
def get_format_description(self):
1233
"""Return the short format description for this format."""
1234
raise NotImplementedError(self.get_format_description)
1236
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1238
"""Initialize a branch in a bzrdir, with specified files
1240
:param a_bzrdir: The bzrdir to initialize the branch in
1241
:param utf8_files: The files to create as a list of
1242
(filename, content) tuples
1243
:param set_format: If True, set the format with
1244
self.get_format_string. (BzrBranch4 has its format set
1246
:return: a branch in this format
1248
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1249
branch_transport = a_bzrdir.get_branch_transport(self)
1251
'metadir': ('lock', lockdir.LockDir),
1252
'branch4': ('branch-lock', lockable_files.TransportLock),
1254
lock_name, lock_class = lock_map[lock_type]
1255
control_files = lockable_files.LockableFiles(branch_transport,
1256
lock_name, lock_class)
1257
control_files.create_lock()
1258
control_files.lock_write()
1260
utf8_files += [('format', self.get_format_string())]
1262
for (filename, content) in utf8_files:
1263
branch_transport.put_bytes(
1265
mode=a_bzrdir._get_file_mode())
1267
control_files.unlock()
1268
return self.open(a_bzrdir, _found=True)
1270
def initialize(self, a_bzrdir):
1271
"""Create a branch of this format in a_bzrdir."""
1272
raise NotImplementedError(self.initialize)
1274
def is_supported(self):
1275
"""Is this format supported?
1277
Supported formats can be initialized and opened.
1278
Unsupported formats may not support initialization or committing or
1279
some other features depending on the reason for not being supported.
1283
def network_name(self):
1284
"""A simple byte string uniquely identifying this format for RPC calls.
1286
MetaDir branch formats use their disk format string to identify the
1287
repository over the wire. All in one formats such as bzr < 0.8, and
1288
foreign formats like svn/git and hg should use some marker which is
1289
unique and immutable.
1291
raise NotImplementedError(self.network_name)
1293
def open(self, a_bzrdir, _found=False):
1294
"""Return the branch object for a_bzrdir
1296
_found is a private parameter, do not use it. It is used to indicate
1297
if format probing has already be done.
1299
raise NotImplementedError(self.open)
1302
def register_format(klass, format):
1303
"""Register a metadir format."""
1304
klass._formats[format.get_format_string()] = format
1305
# Metadir formats have a network name of their format string, and get
1306
# registered as class factories.
1307
network_format_registry.register(format.get_format_string(), format.__class__)
1310
def set_default_format(klass, format):
1311
klass._default_format = format
1313
def supports_stacking(self):
1314
"""True if this format records a stacked-on branch."""
1318
def unregister_format(klass, format):
1319
del klass._formats[format.get_format_string()]
1322
return self.get_format_description().rstrip()
1324
def supports_tags(self):
1325
"""True if this format supports tags stored in the branch"""
1326
return False # by default
1329
class BranchHooks(Hooks):
1330
"""A dictionary mapping hook name to a list of callables for branch hooks.
1332
e.g. ['set_rh'] Is the list of items to be called when the
1333
set_revision_history function is invoked.
1337
"""Create the default hooks.
1339
These are all empty initially, because by default nothing should get
1342
Hooks.__init__(self)
1343
# Introduced in 0.15:
1344
# invoked whenever the revision history has been set
1345
# with set_revision_history. The api signature is
1346
# (branch, revision_history), and the branch will
1349
# Invoked after a branch is opened. The api signature is (branch).
1351
# invoked after a push operation completes.
1352
# the api signature is
1354
# containing the members
1355
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1356
# where local is the local target branch or None, master is the target
1357
# master branch, and the rest should be self explanatory. The source
1358
# is read locked and the target branches write locked. Source will
1359
# be the local low-latency branch.
1360
self['post_push'] = []
1361
# invoked after a pull operation completes.
1362
# the api signature is
1364
# containing the members
1365
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1366
# where local is the local branch or None, master is the target
1367
# master branch, and the rest should be self explanatory. The source
1368
# is read locked and the target branches write locked. The local
1369
# branch is the low-latency branch.
1370
self['post_pull'] = []
1371
# invoked before a commit operation takes place.
1372
# the api signature is
1373
# (local, master, old_revno, old_revid, future_revno, future_revid,
1374
# tree_delta, future_tree).
1375
# old_revid is NULL_REVISION for the first commit to a branch
1376
# tree_delta is a TreeDelta object describing changes from the basis
1377
# revision, hooks MUST NOT modify this delta
1378
# future_tree is an in-memory tree obtained from
1379
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1380
self['pre_commit'] = []
1381
# invoked after a commit operation completes.
1382
# the api signature is
1383
# (local, master, old_revno, old_revid, new_revno, new_revid)
1384
# old_revid is NULL_REVISION for the first commit to a branch.
1385
self['post_commit'] = []
1386
# invoked after a uncommit operation completes.
1387
# the api signature is
1388
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1389
# local is the local branch or None, master is the target branch,
1390
# and an empty branch recieves new_revno of 0, new_revid of None.
1391
self['post_uncommit'] = []
1393
# Invoked before the tip of a branch changes.
1394
# the api signature is
1395
# (params) where params is a ChangeBranchTipParams with the members
1396
# (branch, old_revno, new_revno, old_revid, new_revid)
1397
self['pre_change_branch_tip'] = []
1399
# Invoked after the tip of a branch changes.
1400
# the api signature is
1401
# (params) where params is a ChangeBranchTipParams with the members
1402
# (branch, old_revno, new_revno, old_revid, new_revid)
1403
self['post_change_branch_tip'] = []
1405
# Invoked when a stacked branch activates its fallback locations and
1406
# allows the transformation of the url of said location.
1407
# the api signature is
1408
# (branch, url) where branch is the branch having its fallback
1409
# location activated and url is the url for the fallback location.
1410
# The hook should return a url.
1411
self['transform_fallback_location'] = []
1414
# install the default hooks into the Branch class.
1415
Branch.hooks = BranchHooks()
1418
class ChangeBranchTipParams(object):
1419
"""Object holding parameters passed to *_change_branch_tip hooks.
1421
There are 5 fields that hooks may wish to access:
1423
:ivar branch: the branch being changed
1424
:ivar old_revno: revision number before the change
1425
:ivar new_revno: revision number after the change
1426
:ivar old_revid: revision id before the change
1427
:ivar new_revid: revision id after the change
1429
The revid fields are strings. The revno fields are integers.
1432
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1433
"""Create a group of ChangeBranchTip parameters.
1435
:param branch: The branch being changed.
1436
:param old_revno: Revision number before the change.
1437
:param new_revno: Revision number after the change.
1438
:param old_revid: Tip revision id before the change.
1439
:param new_revid: Tip revision id after the change.
1441
self.branch = branch
1442
self.old_revno = old_revno
1443
self.new_revno = new_revno
1444
self.old_revid = old_revid
1445
self.new_revid = new_revid
1447
def __eq__(self, other):
1448
return self.__dict__ == other.__dict__
1451
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1452
self.__class__.__name__, self.branch,
1453
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1456
class BzrBranchFormat4(BranchFormat):
1457
"""Bzr branch format 4.
1460
- a revision-history file.
1461
- a branch-lock lock file [ to be shared with the bzrdir ]
1464
def get_format_description(self):
1465
"""See BranchFormat.get_format_description()."""
1466
return "Branch format 4"
1468
def initialize(self, a_bzrdir):
1469
"""Create a branch of this format in a_bzrdir."""
1470
utf8_files = [('revision-history', ''),
1471
('branch-name', ''),
1473
return self._initialize_helper(a_bzrdir, utf8_files,
1474
lock_type='branch4', set_format=False)
1477
super(BzrBranchFormat4, self).__init__()
1478
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1480
def network_name(self):
1481
"""The network name for this format is the control dirs disk label."""
1482
return self._matchingbzrdir.get_format_string()
1484
def open(self, a_bzrdir, _found=False):
1485
"""Return the branch object for a_bzrdir
1487
_found is a private parameter, do not use it. It is used to indicate
1488
if format probing has already be done.
1491
# we are being called directly and must probe.
1492
raise NotImplementedError
1493
return BzrBranch(_format=self,
1494
_control_files=a_bzrdir._control_files,
1496
_repository=a_bzrdir.open_repository())
1499
return "Bazaar-NG branch format 4"
1502
class BranchFormatMetadir(BranchFormat):
1503
"""Common logic for meta-dir based branch formats."""
1505
def _branch_class(self):
1506
"""What class to instantiate on open calls."""
1507
raise NotImplementedError(self._branch_class)
1509
def network_name(self):
1510
"""A simple byte string uniquely identifying this format for RPC calls.
1512
Metadir branch formats use their format string.
1514
return self.get_format_string()
1516
def open(self, a_bzrdir, _found=False):
1517
"""Return the branch object for a_bzrdir.
1519
_found is a private parameter, do not use it. It is used to indicate
1520
if format probing has already be done.
1523
format = BranchFormat.find_format(a_bzrdir)
1524
if format.__class__ != self.__class__:
1525
raise AssertionError("wrong format %r found for %r" %
1528
transport = a_bzrdir.get_branch_transport(None)
1529
control_files = lockable_files.LockableFiles(transport, 'lock',
1531
return self._branch_class()(_format=self,
1532
_control_files=control_files,
1534
_repository=a_bzrdir.find_repository())
1535
except errors.NoSuchFile:
1536
raise errors.NotBranchError(path=transport.base)
1539
super(BranchFormatMetadir, self).__init__()
1540
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1541
self._matchingbzrdir.set_branch_format(self)
1543
def supports_tags(self):
1547
class BzrBranchFormat5(BranchFormatMetadir):
1548
"""Bzr branch format 5.
1551
- a revision-history file.
1553
- a lock dir guarding the branch itself
1554
- all of this stored in a branch/ subdirectory
1555
- works with shared repositories.
1557
This format is new in bzr 0.8.
1560
def _branch_class(self):
1563
def get_format_string(self):
1564
"""See BranchFormat.get_format_string()."""
1565
return "Bazaar-NG branch format 5\n"
1567
def get_format_description(self):
1568
"""See BranchFormat.get_format_description()."""
1569
return "Branch format 5"
1571
def initialize(self, a_bzrdir):
1572
"""Create a branch of this format in a_bzrdir."""
1573
utf8_files = [('revision-history', ''),
1574
('branch-name', ''),
1576
return self._initialize_helper(a_bzrdir, utf8_files)
1578
def supports_tags(self):
1582
class BzrBranchFormat6(BranchFormatMetadir):
1583
"""Branch format with last-revision and tags.
1585
Unlike previous formats, this has no explicit revision history. Instead,
1586
this just stores the last-revision, and the left-hand history leading
1587
up to there is the history.
1589
This format was introduced in bzr 0.15
1590
and became the default in 0.91.
1593
def _branch_class(self):
1596
def get_format_string(self):
1597
"""See BranchFormat.get_format_string()."""
1598
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1600
def get_format_description(self):
1601
"""See BranchFormat.get_format_description()."""
1602
return "Branch format 6"
1604
def initialize(self, a_bzrdir):
1605
"""Create a branch of this format in a_bzrdir."""
1606
utf8_files = [('last-revision', '0 null:\n'),
1607
('branch.conf', ''),
1610
return self._initialize_helper(a_bzrdir, utf8_files)
1613
class BzrBranchFormat7(BranchFormatMetadir):
1614
"""Branch format with last-revision, tags, and a stacked location pointer.
1616
The stacked location pointer is passed down to the repository and requires
1617
a repository format with supports_external_lookups = True.
1619
This format was introduced in bzr 1.6.
1622
def _branch_class(self):
1625
def get_format_string(self):
1626
"""See BranchFormat.get_format_string()."""
1627
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1629
def get_format_description(self):
1630
"""See BranchFormat.get_format_description()."""
1631
return "Branch format 7"
1633
def initialize(self, a_bzrdir):
1634
"""Create a branch of this format in a_bzrdir."""
1635
utf8_files = [('last-revision', '0 null:\n'),
1636
('branch.conf', ''),
1639
return self._initialize_helper(a_bzrdir, utf8_files)
1642
super(BzrBranchFormat7, self).__init__()
1643
self._matchingbzrdir.repository_format = \
1644
RepositoryFormatKnitPack5RichRoot()
1646
def supports_stacking(self):
1650
class BranchReferenceFormat(BranchFormat):
1651
"""Bzr branch reference format.
1653
Branch references are used in implementing checkouts, they
1654
act as an alias to the real branch which is at some other url.
1661
def get_format_string(self):
1662
"""See BranchFormat.get_format_string()."""
1663
return "Bazaar-NG Branch Reference Format 1\n"
1665
def get_format_description(self):
1666
"""See BranchFormat.get_format_description()."""
1667
return "Checkout reference format 1"
1669
def get_reference(self, a_bzrdir):
1670
"""See BranchFormat.get_reference()."""
1671
transport = a_bzrdir.get_branch_transport(None)
1672
return transport.get('location').read()
1674
def set_reference(self, a_bzrdir, to_branch):
1675
"""See BranchFormat.set_reference()."""
1676
transport = a_bzrdir.get_branch_transport(None)
1677
location = transport.put_bytes('location', to_branch.base)
1679
def initialize(self, a_bzrdir, target_branch=None):
1680
"""Create a branch of this format in a_bzrdir."""
1681
if target_branch is None:
1682
# this format does not implement branch itself, thus the implicit
1683
# creation contract must see it as uninitializable
1684
raise errors.UninitializableFormat(self)
1685
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1686
branch_transport = a_bzrdir.get_branch_transport(self)
1687
branch_transport.put_bytes('location',
1688
target_branch.bzrdir.root_transport.base)
1689
branch_transport.put_bytes('format', self.get_format_string())
1691
a_bzrdir, _found=True,
1692
possible_transports=[target_branch.bzrdir.root_transport])
1695
super(BranchReferenceFormat, self).__init__()
1696
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1697
self._matchingbzrdir.set_branch_format(self)
1699
def _make_reference_clone_function(format, a_branch):
1700
"""Create a clone() routine for a branch dynamically."""
1701
def clone(to_bzrdir, revision_id=None,
1702
repository_policy=None):
1703
"""See Branch.clone()."""
1704
return format.initialize(to_bzrdir, a_branch)
1705
# cannot obey revision_id limits when cloning a reference ...
1706
# FIXME RBC 20060210 either nuke revision_id for clone, or
1707
# emit some sort of warning/error to the caller ?!
1710
def open(self, a_bzrdir, _found=False, location=None,
1711
possible_transports=None):
1712
"""Return the branch that the branch reference in a_bzrdir points at.
1714
_found is a private parameter, do not use it. It is used to indicate
1715
if format probing has already be done.
1718
format = BranchFormat.find_format(a_bzrdir)
1719
if format.__class__ != self.__class__:
1720
raise AssertionError("wrong format %r found for %r" %
1722
if location is None:
1723
location = self.get_reference(a_bzrdir)
1724
real_bzrdir = bzrdir.BzrDir.open(
1725
location, possible_transports=possible_transports)
1726
result = real_bzrdir.open_branch()
1727
# this changes the behaviour of result.clone to create a new reference
1728
# rather than a copy of the content of the branch.
1729
# I did not use a proxy object because that needs much more extensive
1730
# testing, and we are only changing one behaviour at the moment.
1731
# If we decide to alter more behaviours - i.e. the implicit nickname
1732
# then this should be refactored to introduce a tested proxy branch
1733
# and a subclass of that for use in overriding clone() and ....
1735
result.clone = self._make_reference_clone_function(result)
1739
network_format_registry = registry.FormatRegistry()
1740
"""Registry of formats indexed by their network name.
1742
The network name for a branch format is an identifier that can be used when
1743
referring to formats with smart server operations. See
1744
BranchFormat.network_name() for more detail.
1748
# formats which have no format string are not discoverable
1749
# and not independently creatable, so are not registered.
1750
__format5 = BzrBranchFormat5()
1751
__format6 = BzrBranchFormat6()
1752
__format7 = BzrBranchFormat7()
1753
BranchFormat.register_format(__format5)
1754
BranchFormat.register_format(BranchReferenceFormat())
1755
BranchFormat.register_format(__format6)
1756
BranchFormat.register_format(__format7)
1757
BranchFormat.set_default_format(__format6)
1758
_legacy_formats = [BzrBranchFormat4(),
1760
network_format_registry.register(
1761
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1764
class BzrBranch(Branch):
1765
"""A branch stored in the actual filesystem.
1767
Note that it's "local" in the context of the filesystem; it doesn't
1768
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1769
it's writable, and can be accessed via the normal filesystem API.
1771
:ivar _transport: Transport for file operations on this branch's
1772
control files, typically pointing to the .bzr/branch directory.
1773
:ivar repository: Repository for this branch.
1774
:ivar base: The url of the base directory for this branch; the one
1775
containing the .bzr directory.
1778
def __init__(self, _format=None,
1779
_control_files=None, a_bzrdir=None, _repository=None):
1780
"""Create new branch object at a particular location."""
1781
if a_bzrdir is None:
1782
raise ValueError('a_bzrdir must be supplied')
1784
self.bzrdir = a_bzrdir
1785
self._base = self.bzrdir.transport.clone('..').base
1786
# XXX: We should be able to just do
1787
# self.base = self.bzrdir.root_transport.base
1788
# but this does not quite work yet -- mbp 20080522
1789
self._format = _format
1790
if _control_files is None:
1791
raise ValueError('BzrBranch _control_files is None')
1792
self.control_files = _control_files
1793
self._transport = _control_files._transport
1794
self.repository = _repository
1795
Branch.__init__(self)
1798
return '%s(%r)' % (self.__class__.__name__, self.base)
1802
def _get_base(self):
1803
"""Returns the directory containing the control directory."""
1806
base = property(_get_base, doc="The URL for the root of this branch.")
1808
def is_locked(self):
1809
return self.control_files.is_locked()
1811
def lock_write(self, token=None):
1812
repo_token = self.repository.lock_write()
1814
token = self.control_files.lock_write(token=token)
1816
self.repository.unlock()
1820
def lock_read(self):
1821
self.repository.lock_read()
1823
self.control_files.lock_read()
1825
self.repository.unlock()
1829
# TODO: test for failed two phase locks. This is known broken.
1831
self.control_files.unlock()
1833
self.repository.unlock()
1834
if not self.control_files.is_locked():
1835
# we just released the lock
1836
self._clear_cached_state()
1838
def peek_lock_mode(self):
1839
if self.control_files._lock_count == 0:
1842
return self.control_files._lock_mode
1844
def get_physical_lock_status(self):
1845
return self.control_files.get_physical_lock_status()
1848
def print_file(self, file, revision_id):
1849
"""See Branch.print_file."""
1850
return self.repository.print_file(file, revision_id)
1852
def _write_revision_history(self, history):
1853
"""Factored out of set_revision_history.
1855
This performs the actual writing to disk.
1856
It is intended to be called by BzrBranch5.set_revision_history."""
1857
self._transport.put_bytes(
1858
'revision-history', '\n'.join(history),
1859
mode=self.bzrdir._get_file_mode())
1862
def set_revision_history(self, rev_history):
1863
"""See Branch.set_revision_history."""
1864
if 'evil' in debug.debug_flags:
1865
mutter_callsite(3, "set_revision_history scales with history.")
1866
check_not_reserved_id = _mod_revision.check_not_reserved_id
1867
for rev_id in rev_history:
1868
check_not_reserved_id(rev_id)
1869
if Branch.hooks['post_change_branch_tip']:
1870
# Don't calculate the last_revision_info() if there are no hooks
1872
old_revno, old_revid = self.last_revision_info()
1873
if len(rev_history) == 0:
1874
revid = _mod_revision.NULL_REVISION
1876
revid = rev_history[-1]
1877
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1878
self._write_revision_history(rev_history)
1879
self._clear_cached_state()
1880
self._cache_revision_history(rev_history)
1881
for hook in Branch.hooks['set_rh']:
1882
hook(self, rev_history)
1883
if Branch.hooks['post_change_branch_tip']:
1884
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1886
def _synchronize_history(self, destination, revision_id):
1887
"""Synchronize last revision and revision history between branches.
1889
This version is most efficient when the destination is also a
1890
BzrBranch5, but works for BzrBranch6 as long as the revision
1891
history is the true lefthand parent history, and all of the revisions
1892
are in the destination's repository. If not, set_revision_history
1895
:param destination: The branch to copy the history into
1896
:param revision_id: The revision-id to truncate history at. May
1897
be None to copy complete history.
1899
if not isinstance(destination._format, BzrBranchFormat5):
1900
super(BzrBranch, self)._synchronize_history(
1901
destination, revision_id)
1903
if revision_id == _mod_revision.NULL_REVISION:
1906
new_history = self.revision_history()
1907
if revision_id is not None and new_history != []:
1909
new_history = new_history[:new_history.index(revision_id) + 1]
1911
rev = self.repository.get_revision(revision_id)
1912
new_history = rev.get_history(self.repository)[1:]
1913
destination.set_revision_history(new_history)
1916
def set_last_revision_info(self, revno, revision_id):
1917
"""Set the last revision of this branch.
1919
The caller is responsible for checking that the revno is correct
1920
for this revision id.
1922
It may be possible to set the branch last revision to an id not
1923
present in the repository. However, branches can also be
1924
configured to check constraints on history, in which case this may not
1927
revision_id = _mod_revision.ensure_null(revision_id)
1928
# this old format stores the full history, but this api doesn't
1929
# provide it, so we must generate, and might as well check it's
1931
history = self._lefthand_history(revision_id)
1932
if len(history) != revno:
1933
raise AssertionError('%d != %d' % (len(history), revno))
1934
self.set_revision_history(history)
1936
def _gen_revision_history(self):
1937
history = self._transport.get_bytes('revision-history').split('\n')
1938
if history[-1:] == ['']:
1939
# There shouldn't be a trailing newline, but just in case.
1944
def generate_revision_history(self, revision_id, last_rev=None,
1946
"""Create a new revision history that will finish with revision_id.
1948
:param revision_id: the new tip to use.
1949
:param last_rev: The previous last_revision. If not None, then this
1950
must be a ancestory of revision_id, or DivergedBranches is raised.
1951
:param other_branch: The other branch that DivergedBranches should
1952
raise with respect to.
1954
self.set_revision_history(self._lefthand_history(revision_id,
1955
last_rev, other_branch))
1957
def basis_tree(self):
1958
"""See Branch.basis_tree."""
1959
return self.repository.revision_tree(self.last_revision())
1962
def pull(self, source, overwrite=False, stop_revision=None,
1963
_hook_master=None, run_hooks=True, possible_transports=None,
1964
_override_hook_target=None):
1967
:param _hook_master: Private parameter - set the branch to
1968
be supplied as the master to pull hooks.
1969
:param run_hooks: Private parameter - if false, this branch
1970
is being called because it's the master of the primary branch,
1971
so it should not run its hooks.
1972
:param _override_hook_target: Private parameter - set the branch to be
1973
supplied as the target_branch to pull hooks.
1975
result = PullResult()
1976
result.source_branch = source
1977
if _override_hook_target is None:
1978
result.target_branch = self
1980
result.target_branch = _override_hook_target
1983
# We assume that during 'pull' the local repository is closer than
1985
graph = self.repository.get_graph(source.repository)
1986
result.old_revno, result.old_revid = self.last_revision_info()
1987
self.update_revisions(source, stop_revision, overwrite=overwrite,
1989
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1990
result.new_revno, result.new_revid = self.last_revision_info()
1992
result.master_branch = _hook_master
1993
result.local_branch = result.target_branch
1995
result.master_branch = result.target_branch
1996
result.local_branch = None
1998
for hook in Branch.hooks['post_pull']:
2004
def _get_parent_location(self):
2005
_locs = ['parent', 'pull', 'x-pull']
2008
return self._transport.get_bytes(l).strip('\n')
2009
except errors.NoSuchFile:
2014
def push(self, target, overwrite=False, stop_revision=None,
2015
_override_hook_source_branch=None):
2018
This is the basic concrete implementation of push()
2020
:param _override_hook_source_branch: If specified, run
2021
the hooks passing this Branch as the source, rather than self.
2022
This is for use of RemoteBranch, where push is delegated to the
2023
underlying vfs-based Branch.
2025
# TODO: Public option to disable running hooks - should be trivial but
2027
return _run_with_write_locked_target(
2028
target, self._push_with_bound_branches, target, overwrite,
2030
_override_hook_source_branch=_override_hook_source_branch)
2032
def _push_with_bound_branches(self, target, overwrite,
2034
_override_hook_source_branch=None):
2035
"""Push from self into target, and into target's master if any.
2037
This is on the base BzrBranch class even though it doesn't support
2038
bound branches because the *target* might be bound.
2041
if _override_hook_source_branch:
2042
result.source_branch = _override_hook_source_branch
2043
for hook in Branch.hooks['post_push']:
2046
bound_location = target.get_bound_location()
2047
if bound_location and target.base != bound_location:
2048
# there is a master branch.
2050
# XXX: Why the second check? Is it even supported for a branch to
2051
# be bound to itself? -- mbp 20070507
2052
master_branch = target.get_master_branch()
2053
master_branch.lock_write()
2055
# push into the master from this branch.
2056
self._basic_push(master_branch, overwrite, stop_revision)
2057
# and push into the target branch from this. Note that we push from
2058
# this branch again, because its considered the highest bandwidth
2060
result = self._basic_push(target, overwrite, stop_revision)
2061
result.master_branch = master_branch
2062
result.local_branch = target
2066
master_branch.unlock()
2069
result = self._basic_push(target, overwrite, stop_revision)
2070
# TODO: Why set master_branch and local_branch if there's no
2071
# binding? Maybe cleaner to just leave them unset? -- mbp
2073
result.master_branch = target
2074
result.local_branch = None
2078
def _basic_push(self, target, overwrite, stop_revision):
2079
"""Basic implementation of push without bound branches or hooks.
2081
Must be called with self read locked and target write locked.
2083
result = PushResult()
2084
result.source_branch = self
2085
result.target_branch = target
2086
result.old_revno, result.old_revid = target.last_revision_info()
2087
if result.old_revid != self.last_revision():
2088
# We assume that during 'push' this repository is closer than
2090
graph = self.repository.get_graph(target.repository)
2091
target.update_revisions(self, stop_revision, overwrite=overwrite,
2093
if self._push_should_merge_tags():
2094
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2095
result.new_revno, result.new_revid = target.last_revision_info()
2098
def get_stacked_on_url(self):
2099
raise errors.UnstackableBranchFormat(self._format, self.base)
2101
def set_push_location(self, location):
2102
"""See Branch.set_push_location."""
2103
self.get_config().set_user_option(
2104
'push_location', location,
2105
store=_mod_config.STORE_LOCATION_NORECURSE)
2108
def set_parent(self, url):
2109
"""See Branch.set_parent."""
2110
# TODO: Maybe delete old location files?
2111
# URLs should never be unicode, even on the local fs,
2112
# FIXUP this and get_parent in a future branch format bump:
2113
# read and rewrite the file. RBC 20060125
2115
if isinstance(url, unicode):
2117
url = url.encode('ascii')
2118
except UnicodeEncodeError:
2119
raise errors.InvalidURL(url,
2120
"Urls must be 7-bit ascii, "
2121
"use bzrlib.urlutils.escape")
2122
url = urlutils.relative_url(self.base, url)
2123
self._set_parent_location(url)
2125
def _set_parent_location(self, url):
2127
self._transport.delete('parent')
2129
self._transport.put_bytes('parent', url + '\n',
2130
mode=self.bzrdir._get_file_mode())
2132
def set_stacked_on_url(self, url):
2133
raise errors.UnstackableBranchFormat(self._format, self.base)
2136
class BzrBranch5(BzrBranch):
2137
"""A format 5 branch. This supports new features over plain branches.
2139
It has support for a master_branch which is the data for bound branches.
2143
def pull(self, source, overwrite=False, stop_revision=None,
2144
run_hooks=True, possible_transports=None,
2145
_override_hook_target=None):
2146
"""Pull from source into self, updating my master if any.
2148
:param run_hooks: Private parameter - if false, this branch
2149
is being called because it's the master of the primary branch,
2150
so it should not run its hooks.
2152
bound_location = self.get_bound_location()
2153
master_branch = None
2154
if bound_location and source.base != bound_location:
2155
# not pulling from master, so we need to update master.
2156
master_branch = self.get_master_branch(possible_transports)
2157
master_branch.lock_write()
2160
# pull from source into master.
2161
master_branch.pull(source, overwrite, stop_revision,
2163
return super(BzrBranch5, self).pull(source, overwrite,
2164
stop_revision, _hook_master=master_branch,
2165
run_hooks=run_hooks,
2166
_override_hook_target=_override_hook_target)
2169
master_branch.unlock()
2171
def get_bound_location(self):
2173
return self._transport.get_bytes('bound')[:-1]
2174
except errors.NoSuchFile:
2178
def get_master_branch(self, possible_transports=None):
2179
"""Return the branch we are bound to.
2181
:return: Either a Branch, or None
2183
This could memoise the branch, but if thats done
2184
it must be revalidated on each new lock.
2185
So for now we just don't memoise it.
2186
# RBC 20060304 review this decision.
2188
bound_loc = self.get_bound_location()
2192
return Branch.open(bound_loc,
2193
possible_transports=possible_transports)
2194
except (errors.NotBranchError, errors.ConnectionError), e:
2195
raise errors.BoundBranchConnectionFailure(
2199
def set_bound_location(self, location):
2200
"""Set the target where this branch is bound to.
2202
:param location: URL to the target branch
2205
self._transport.put_bytes('bound', location+'\n',
2206
mode=self.bzrdir._get_file_mode())
2209
self._transport.delete('bound')
2210
except errors.NoSuchFile:
2215
def bind(self, other):
2216
"""Bind this branch to the branch other.
2218
This does not push or pull data between the branches, though it does
2219
check for divergence to raise an error when the branches are not
2220
either the same, or one a prefix of the other. That behaviour may not
2221
be useful, so that check may be removed in future.
2223
:param other: The branch to bind to
2226
# TODO: jam 20051230 Consider checking if the target is bound
2227
# It is debatable whether you should be able to bind to
2228
# a branch which is itself bound.
2229
# Committing is obviously forbidden,
2230
# but binding itself may not be.
2231
# Since we *have* to check at commit time, we don't
2232
# *need* to check here
2234
# we want to raise diverged if:
2235
# last_rev is not in the other_last_rev history, AND
2236
# other_last_rev is not in our history, and do it without pulling
2238
self.set_bound_location(other.base)
2242
"""If bound, unbind"""
2243
return self.set_bound_location(None)
2246
def update(self, possible_transports=None):
2247
"""Synchronise this branch with the master branch if any.
2249
:return: None or the last_revision that was pivoted out during the
2252
master = self.get_master_branch(possible_transports)
2253
if master is not None:
2254
old_tip = _mod_revision.ensure_null(self.last_revision())
2255
self.pull(master, overwrite=True)
2256
if self.repository.get_graph().is_ancestor(old_tip,
2257
_mod_revision.ensure_null(self.last_revision())):
2263
class BzrBranch7(BzrBranch5):
2264
"""A branch with support for a fallback repository."""
2266
def _get_fallback_repository(self, url):
2267
"""Get the repository we fallback to at url."""
2268
url = urlutils.join(self.base, url)
2269
a_bzrdir = bzrdir.BzrDir.open(url,
2270
possible_transports=[self._transport])
2271
return a_bzrdir.open_branch().repository
2273
def _activate_fallback_location(self, url):
2274
"""Activate the branch/repository from url as a fallback repository."""
2275
self.repository.add_fallback_repository(
2276
self._get_fallback_repository(url))
2278
def _open_hook(self):
2280
url = self.get_stacked_on_url()
2281
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2282
errors.UnstackableBranchFormat):
2285
for hook in Branch.hooks['transform_fallback_location']:
2286
url = hook(self, url)
2288
hook_name = Branch.hooks.get_hook_name(hook)
2289
raise AssertionError(
2290
"'transform_fallback_location' hook %s returned "
2291
"None, not a URL." % hook_name)
2292
self._activate_fallback_location(url)
2294
def _check_stackable_repo(self):
2295
if not self.repository._format.supports_external_lookups:
2296
raise errors.UnstackableRepositoryFormat(self.repository._format,
2297
self.repository.base)
2299
def __init__(self, *args, **kwargs):
2300
super(BzrBranch7, self).__init__(*args, **kwargs)
2301
self._last_revision_info_cache = None
2302
self._partial_revision_history_cache = []
2304
def _clear_cached_state(self):
2305
super(BzrBranch7, self)._clear_cached_state()
2306
self._last_revision_info_cache = None
2307
self._partial_revision_history_cache = []
2309
def _last_revision_info(self):
2310
revision_string = self._transport.get_bytes('last-revision')
2311
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2312
revision_id = cache_utf8.get_cached_utf8(revision_id)
2314
return revno, revision_id
2316
def _write_last_revision_info(self, revno, revision_id):
2317
"""Simply write out the revision id, with no checks.
2319
Use set_last_revision_info to perform this safely.
2321
Does not update the revision_history cache.
2322
Intended to be called by set_last_revision_info and
2323
_write_revision_history.
2325
revision_id = _mod_revision.ensure_null(revision_id)
2326
out_string = '%d %s\n' % (revno, revision_id)
2327
self._transport.put_bytes('last-revision', out_string,
2328
mode=self.bzrdir._get_file_mode())
2331
def set_last_revision_info(self, revno, revision_id):
2332
revision_id = _mod_revision.ensure_null(revision_id)
2333
old_revno, old_revid = self.last_revision_info()
2334
if self._get_append_revisions_only():
2335
self._check_history_violation(revision_id)
2336
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2337
self._write_last_revision_info(revno, revision_id)
2338
self._clear_cached_state()
2339
self._last_revision_info_cache = revno, revision_id
2340
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2342
def _synchronize_history(self, destination, revision_id):
2343
"""Synchronize last revision and revision history between branches.
2345
:see: Branch._synchronize_history
2347
# XXX: The base Branch has a fast implementation of this method based
2348
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2349
# that uses set_revision_history. This class inherits from BzrBranch5,
2350
# but wants the fast implementation, so it calls
2351
# Branch._synchronize_history directly.
2352
Branch._synchronize_history(self, destination, revision_id)
2354
def _check_history_violation(self, revision_id):
2355
last_revision = _mod_revision.ensure_null(self.last_revision())
2356
if _mod_revision.is_null(last_revision):
2358
if last_revision not in self._lefthand_history(revision_id):
2359
raise errors.AppendRevisionsOnlyViolation(self.base)
2361
def _gen_revision_history(self):
2362
"""Generate the revision history from last revision
2364
last_revno, last_revision = self.last_revision_info()
2365
self._extend_partial_history(stop_index=last_revno-1)
2366
return list(reversed(self._partial_revision_history_cache))
2368
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2369
"""Extend the partial history to include a given index
2371
If a stop_index is supplied, stop when that index has been reached.
2372
If a stop_revision is supplied, stop when that revision is
2373
encountered. Otherwise, stop when the beginning of history is
2376
:param stop_index: The index which should be present. When it is
2377
present, history extension will stop.
2378
:param revision_id: The revision id which should be present. When
2379
it is encountered, history extension will stop.
2381
repo = self.repository
2382
if len(self._partial_revision_history_cache) == 0:
2383
iterator = repo.iter_reverse_revision_history(self.last_revision())
2385
start_revision = self._partial_revision_history_cache[-1]
2386
iterator = repo.iter_reverse_revision_history(start_revision)
2387
#skip the last revision in the list
2388
next_revision = iterator.next()
2389
for revision_id in iterator:
2390
self._partial_revision_history_cache.append(revision_id)
2391
if (stop_index is not None and
2392
len(self._partial_revision_history_cache) > stop_index):
2394
if revision_id == stop_revision:
2397
def _write_revision_history(self, history):
2398
"""Factored out of set_revision_history.
2400
This performs the actual writing to disk, with format-specific checks.
2401
It is intended to be called by BzrBranch5.set_revision_history.
2403
if len(history) == 0:
2404
last_revision = 'null:'
2406
if history != self._lefthand_history(history[-1]):
2407
raise errors.NotLefthandHistory(history)
2408
last_revision = history[-1]
2409
if self._get_append_revisions_only():
2410
self._check_history_violation(last_revision)
2411
self._write_last_revision_info(len(history), last_revision)
2414
def _set_parent_location(self, url):
2415
"""Set the parent branch"""
2416
self._set_config_location('parent_location', url, make_relative=True)
2419
def _get_parent_location(self):
2420
"""Set the parent branch"""
2421
return self._get_config_location('parent_location')
2423
def set_push_location(self, location):
2424
"""See Branch.set_push_location."""
2425
self._set_config_location('push_location', location)
2427
def set_bound_location(self, location):
2428
"""See Branch.set_push_location."""
2430
config = self.get_config()
2431
if location is None:
2432
if config.get_user_option('bound') != 'True':
2435
config.set_user_option('bound', 'False', warn_masked=True)
2438
self._set_config_location('bound_location', location,
2440
config.set_user_option('bound', 'True', warn_masked=True)
2443
def _get_bound_location(self, bound):
2444
"""Return the bound location in the config file.
2446
Return None if the bound parameter does not match"""
2447
config = self.get_config()
2448
config_bound = (config.get_user_option('bound') == 'True')
2449
if config_bound != bound:
2451
return self._get_config_location('bound_location', config=config)
2453
def get_bound_location(self):
2454
"""See Branch.set_push_location."""
2455
return self._get_bound_location(True)
2457
def get_old_bound_location(self):
2458
"""See Branch.get_old_bound_location"""
2459
return self._get_bound_location(False)
2461
def get_stacked_on_url(self):
2462
# you can always ask for the URL; but you might not be able to use it
2463
# if the repo can't support stacking.
2464
## self._check_stackable_repo()
2465
stacked_url = self._get_config_location('stacked_on_location')
2466
if stacked_url is None:
2467
raise errors.NotStacked(self)
2470
def set_append_revisions_only(self, enabled):
2475
self.get_config().set_user_option('append_revisions_only', value,
2478
def set_stacked_on_url(self, url):
2479
self._check_stackable_repo()
2482
old_url = self.get_stacked_on_url()
2483
except (errors.NotStacked, errors.UnstackableBranchFormat,
2484
errors.UnstackableRepositoryFormat):
2487
# repositories don't offer an interface to remove fallback
2488
# repositories today; take the conceptually simpler option and just
2490
self.repository = self.bzrdir.find_repository()
2491
# for every revision reference the branch has, ensure it is pulled
2493
source_repository = self._get_fallback_repository(old_url)
2494
for revision_id in chain([self.last_revision()],
2495
self.tags.get_reverse_tag_dict()):
2496
self.repository.fetch(source_repository, revision_id,
2499
self._activate_fallback_location(url)
2500
# write this out after the repository is stacked to avoid setting a
2501
# stacked config that doesn't work.
2502
self._set_config_location('stacked_on_location', url)
2504
def _get_append_revisions_only(self):
2505
value = self.get_config().get_user_option('append_revisions_only')
2506
return value == 'True'
2508
def _make_tags(self):
2509
return BasicTags(self)
2512
def generate_revision_history(self, revision_id, last_rev=None,
2514
"""See BzrBranch5.generate_revision_history"""
2515
history = self._lefthand_history(revision_id, last_rev, other_branch)
2516
revno = len(history)
2517
self.set_last_revision_info(revno, revision_id)
2520
def get_rev_id(self, revno, history=None):
2521
"""Find the revision id of the specified revno."""
2523
return _mod_revision.NULL_REVISION
2525
last_revno, last_revision_id = self.last_revision_info()
2526
if revno <= 0 or revno > last_revno:
2527
raise errors.NoSuchRevision(self, revno)
2529
if history is not None:
2530
return history[revno - 1]
2532
index = last_revno - revno
2533
if len(self._partial_revision_history_cache) <= index:
2534
self._extend_partial_history(stop_index=index)
2535
if len(self._partial_revision_history_cache) > index:
2536
return self._partial_revision_history_cache[index]
2538
raise errors.NoSuchRevision(self, revno)
2541
def revision_id_to_revno(self, revision_id):
2542
"""Given a revision id, return its revno"""
2543
if _mod_revision.is_null(revision_id):
2546
index = self._partial_revision_history_cache.index(revision_id)
2548
self._extend_partial_history(stop_revision=revision_id)
2549
index = len(self._partial_revision_history_cache) - 1
2550
if self._partial_revision_history_cache[index] != revision_id:
2551
raise errors.NoSuchRevision(self, revision_id)
2552
return self.revno() - index
2555
class BzrBranch6(BzrBranch7):
2556
"""See BzrBranchFormat6 for the capabilities of this branch.
2558
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2562
def get_stacked_on_url(self):
2563
raise errors.UnstackableBranchFormat(self._format, self.base)
2565
def set_stacked_on_url(self, url):
2566
raise errors.UnstackableBranchFormat(self._format, self.base)
2569
######################################################################
2570
# results of operations
2573
class _Result(object):
2575
def _show_tag_conficts(self, to_file):
2576
if not getattr(self, 'tag_conflicts', None):
2578
to_file.write('Conflicting tags:\n')
2579
for name, value1, value2 in self.tag_conflicts:
2580
to_file.write(' %s\n' % (name, ))
2583
class PullResult(_Result):
2584
"""Result of a Branch.pull operation.
2586
:ivar old_revno: Revision number before pull.
2587
:ivar new_revno: Revision number after pull.
2588
:ivar old_revid: Tip revision id before pull.
2589
:ivar new_revid: Tip revision id after pull.
2590
:ivar source_branch: Source (local) branch object.
2591
:ivar master_branch: Master branch of the target, or the target if no
2593
:ivar local_branch: target branch if there is a Master, else None
2594
:ivar target_branch: Target/destination branch object.
2595
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2599
# DEPRECATED: pull used to return the change in revno
2600
return self.new_revno - self.old_revno
2602
def report(self, to_file):
2604
if self.old_revid == self.new_revid:
2605
to_file.write('No revisions to pull.\n')
2607
to_file.write('Now on revision %d.\n' % self.new_revno)
2608
self._show_tag_conficts(to_file)
2611
class PushResult(_Result):
2612
"""Result of a Branch.push operation.
2614
:ivar old_revno: Revision number before push.
2615
:ivar new_revno: Revision number after push.
2616
:ivar old_revid: Tip revision id before push.
2617
:ivar new_revid: Tip revision id after push.
2618
:ivar source_branch: Source branch object.
2619
:ivar master_branch: Master branch of the target, or None.
2620
:ivar target_branch: Target/destination branch object.
2624
# DEPRECATED: push used to return the change in revno
2625
return self.new_revno - self.old_revno
2627
def report(self, to_file):
2628
"""Write a human-readable description of the result."""
2629
if self.old_revid == self.new_revid:
2630
note('No new revisions to push.')
2632
note('Pushed up to revision %d.' % self.new_revno)
2633
self._show_tag_conficts(to_file)
2636
class BranchCheckResult(object):
2637
"""Results of checking branch consistency.
2642
def __init__(self, branch):
2643
self.branch = branch
2645
def report_results(self, verbose):
2646
"""Report the check results via trace.note.
2648
:param verbose: Requests more detailed display of what was checked,
2651
note('checked branch %s format %s',
2653
self.branch._format)
2656
class Converter5to6(object):
2657
"""Perform an in-place upgrade of format 5 to format 6"""
2659
def convert(self, branch):
2660
# Data for 5 and 6 can peacefully coexist.
2661
format = BzrBranchFormat6()
2662
new_branch = format.open(branch.bzrdir, _found=True)
2664
# Copy source data into target
2665
new_branch._write_last_revision_info(*branch.last_revision_info())
2666
new_branch.set_parent(branch.get_parent())
2667
new_branch.set_bound_location(branch.get_bound_location())
2668
new_branch.set_push_location(branch.get_push_location())
2670
# New branch has no tags by default
2671
new_branch.tags._set_tag_dict({})
2673
# Copying done; now update target format
2674
new_branch._transport.put_bytes('format',
2675
format.get_format_string(),
2676
mode=new_branch.bzrdir._get_file_mode())
2678
# Clean up old files
2679
new_branch._transport.delete('revision-history')
2681
branch.set_parent(None)
2682
except errors.NoSuchFile:
2684
branch.set_bound_location(None)
2687
class Converter6to7(object):
2688
"""Perform an in-place upgrade of format 6 to format 7"""
2690
def convert(self, branch):
2691
format = BzrBranchFormat7()
2692
branch._set_config_location('stacked_on_location', '')
2693
# update target format
2694
branch._transport.put_bytes('format', format.get_format_string())
2698
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2699
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2702
_run_with_write_locked_target will attempt to release the lock it acquires.
2704
If an exception is raised by callable, then that exception *will* be
2705
propagated, even if the unlock attempt raises its own error. Thus
2706
_run_with_write_locked_target should be preferred to simply doing::
2710
return callable(*args, **kwargs)
2715
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2716
# should share code?
2719
result = callable(*args, **kwargs)
2721
exc_info = sys.exc_info()
2725
raise exc_info[0], exc_info[1], exc_info[2]
2731
class InterBranch(InterObject):
2732
"""This class represents operations taking place between two branches.
2734
Its instances have methods like pull() and push() and contain
2735
references to the source and target repositories these operations
2736
can be carried out on.
2740
"""The available optimised InterBranch types."""
2743
def _get_branch_formats_to_test():
2744
"""Return a tuple with the Branch formats to use when testing."""
2745
raise NotImplementedError(self._get_branch_formats_to_test)
2747
def update_revisions(self, stop_revision=None, overwrite=False,
2749
"""Pull in new perfect-fit revisions.
2751
:param stop_revision: Updated until the given revision
2752
:param overwrite: Always set the branch pointer, rather than checking
2753
to see if it is a proper descendant.
2754
:param graph: A Graph object that can be used to query history
2755
information. This can be None.
2758
raise NotImplementedError(self.update_revisions)
2761
class GenericInterBranch(InterBranch):
2762
"""InterBranch implementation that uses public Branch functions.
2766
def _get_branch_formats_to_test():
2767
return BranchFormat._default_format, BranchFormat._default_format
2769
def update_revisions(self, stop_revision=None, overwrite=False,
2771
"""See InterBranch.update_revisions()."""
2772
self.source.lock_read()
2774
other_revno, other_last_revision = self.source.last_revision_info()
2775
stop_revno = None # unknown
2776
if stop_revision is None:
2777
stop_revision = other_last_revision
2778
if _mod_revision.is_null(stop_revision):
2779
# if there are no commits, we're done.
2781
stop_revno = other_revno
2783
# what's the current last revision, before we fetch [and change it
2785
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2786
# we fetch here so that we don't process data twice in the common
2787
# case of having something to pull, and so that the check for
2788
# already merged can operate on the just fetched graph, which will
2789
# be cached in memory.
2790
self.target.fetch(self.source, stop_revision)
2791
# Check to see if one is an ancestor of the other
2794
graph = self.target.repository.get_graph()
2795
if self.target._check_if_descendant_or_diverged(
2796
stop_revision, last_rev, graph, self.source):
2797
# stop_revision is a descendant of last_rev, but we aren't
2798
# overwriting, so we're done.
2800
if stop_revno is None:
2802
graph = self.target.repository.get_graph()
2803
this_revno, this_last_revision = \
2804
self.target.last_revision_info()
2805
stop_revno = graph.find_distance_to_null(stop_revision,
2806
[(other_last_revision, other_revno),
2807
(this_last_revision, this_revno)])
2808
self.target.set_last_revision_info(stop_revno, stop_revision)
2810
self.source.unlock()
2813
def is_compatible(self, source, target):
2814
# GenericBranch uses the public API, so always compatible
2818
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
