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 HookPoint, 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
def __init__(self, *ignored, **ignored_too):
87
self.tags = self._format.make_tags(self)
88
self._revision_history_cache = None
89
self._revision_id_to_revno_cache = None
90
self._partial_revision_id_to_revno_cache = {}
91
self._last_revision_info_cache = None
92
self._merge_sorted_revisions_cache = None
94
hooks = Branch.hooks['open']
99
"""Called by init to allow simpler extension of the base class."""
101
def break_lock(self):
102
"""Break a lock if one is present from another instance.
104
Uses the ui factory to ask for confirmation if the lock may be from
107
This will probe the repository for its lock as well.
109
self.control_files.break_lock()
110
self.repository.break_lock()
111
master = self.get_master_branch()
112
if master is not None:
116
def open(base, _unsupported=False, possible_transports=None):
117
"""Open the branch rooted at base.
119
For instance, if the branch is at URL/.bzr/branch,
120
Branch.open(URL) -> a Branch instance.
122
control = bzrdir.BzrDir.open(base, _unsupported,
123
possible_transports=possible_transports)
124
return control.open_branch(_unsupported)
127
def open_from_transport(transport, _unsupported=False):
128
"""Open the branch rooted at transport"""
129
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
130
return control.open_branch(_unsupported)
133
def open_containing(url, possible_transports=None):
134
"""Open an existing branch which contains url.
136
This probes for a branch at url, and searches upwards from there.
138
Basically we keep looking up until we find the control directory or
139
run into the root. If there isn't one, raises NotBranchError.
140
If there is one and it is either an unrecognised format or an unsupported
141
format, UnknownFormatError or UnsupportedFormatError are raised.
142
If there is one, it is returned, along with the unused portion of url.
144
control, relpath = bzrdir.BzrDir.open_containing(url,
146
return control.open_branch(), relpath
148
def _push_should_merge_tags(self):
149
"""Should _basic_push merge this branch's tags into the target?
151
The default implementation returns False if this branch has no tags,
152
and True the rest of the time. Subclasses may override this.
154
return self.supports_tags() and self.tags.get_tag_dict()
156
def get_config(self):
157
return BranchConfig(self)
159
def _get_tags_bytes(self):
160
"""Get the bytes of a serialised tags dict.
162
Note that not all branches support tags, nor do all use the same tags
163
logic: this method is specific to BasicTags. Other tag implementations
164
may use the same method name and behave differently, safely, because
165
of the double-dispatch via
166
format.make_tags->tags_instance->get_tags_dict.
168
:return: The bytes of the tags file.
169
:seealso: Branch._set_tags_bytes.
171
return self._transport.get_bytes('tags')
173
def _get_nick(self, local=False, possible_transports=None):
174
config = self.get_config()
175
# explicit overrides master, but don't look for master if local is True
176
if not local and not config.has_explicit_nickname():
178
master = self.get_master_branch(possible_transports)
179
if master is not None:
180
# return the master branch value
182
except errors.BzrError, e:
183
# Silently fall back to local implicit nick if the master is
185
mutter("Could not connect to bound branch, "
186
"falling back to local nick.\n " + str(e))
187
return config.get_nickname()
189
def _set_nick(self, nick):
190
self.get_config().set_user_option('nickname', nick, warn_masked=True)
192
nick = property(_get_nick, _set_nick)
195
raise NotImplementedError(self.is_locked)
197
def _lefthand_history(self, revision_id, last_rev=None,
199
if 'evil' in debug.debug_flags:
200
mutter_callsite(4, "_lefthand_history scales with history.")
201
# stop_revision must be a descendant of last_revision
202
graph = self.repository.get_graph()
203
if last_rev is not None:
204
if not graph.is_ancestor(last_rev, revision_id):
205
# our previous tip is not merged into stop_revision
206
raise errors.DivergedBranches(self, other_branch)
207
# make a new revision history from the graph
208
parents_map = graph.get_parent_map([revision_id])
209
if revision_id not in parents_map:
210
raise errors.NoSuchRevision(self, revision_id)
211
current_rev_id = revision_id
213
check_not_reserved_id = _mod_revision.check_not_reserved_id
214
# Do not include ghosts or graph origin in revision_history
215
while (current_rev_id in parents_map and
216
len(parents_map[current_rev_id]) > 0):
217
check_not_reserved_id(current_rev_id)
218
new_history.append(current_rev_id)
219
current_rev_id = parents_map[current_rev_id][0]
220
parents_map = graph.get_parent_map([current_rev_id])
221
new_history.reverse()
224
def lock_write(self):
225
raise NotImplementedError(self.lock_write)
228
raise NotImplementedError(self.lock_read)
231
raise NotImplementedError(self.unlock)
233
def peek_lock_mode(self):
234
"""Return lock mode for the Branch: 'r', 'w' or None"""
235
raise NotImplementedError(self.peek_lock_mode)
237
def get_physical_lock_status(self):
238
raise NotImplementedError(self.get_physical_lock_status)
241
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
242
"""Return the revision_id for a dotted revno.
244
:param revno: a tuple like (1,) or (1,1,2)
245
:param _cache_reverse: a private parameter enabling storage
246
of the reverse mapping in a top level cache. (This should
247
only be done in selective circumstances as we want to
248
avoid having the mapping cached multiple times.)
249
:return: the revision_id
250
:raises errors.NoSuchRevision: if the revno doesn't exist
252
rev_id = self._do_dotted_revno_to_revision_id(revno)
254
self._partial_revision_id_to_revno_cache[rev_id] = revno
257
def _do_dotted_revno_to_revision_id(self, revno):
258
"""Worker function for dotted_revno_to_revision_id.
260
Subclasses should override this if they wish to
261
provide a more efficient implementation.
264
return self.get_rev_id(revno[0])
265
revision_id_to_revno = self.get_revision_id_to_revno_map()
266
revision_ids = [revision_id for revision_id, this_revno
267
in revision_id_to_revno.iteritems()
268
if revno == this_revno]
269
if len(revision_ids) == 1:
270
return revision_ids[0]
272
revno_str = '.'.join(map(str, revno))
273
raise errors.NoSuchRevision(self, revno_str)
276
def revision_id_to_dotted_revno(self, revision_id):
277
"""Given a revision id, return its dotted revno.
279
:return: a tuple like (1,) or (400,1,3).
281
return self._do_revision_id_to_dotted_revno(revision_id)
283
def _do_revision_id_to_dotted_revno(self, revision_id):
284
"""Worker function for revision_id_to_revno."""
285
# Try the caches if they are loaded
286
result = self._partial_revision_id_to_revno_cache.get(revision_id)
287
if result is not None:
289
if self._revision_id_to_revno_cache:
290
result = self._revision_id_to_revno_cache.get(revision_id)
292
raise errors.NoSuchRevision(self, revision_id)
293
# Try the mainline as it's optimised
295
revno = self.revision_id_to_revno(revision_id)
297
except errors.NoSuchRevision:
298
# We need to load and use the full revno map after all
299
result = self.get_revision_id_to_revno_map().get(revision_id)
301
raise errors.NoSuchRevision(self, revision_id)
305
def get_revision_id_to_revno_map(self):
306
"""Return the revision_id => dotted revno map.
308
This will be regenerated on demand, but will be cached.
310
:return: A dictionary mapping revision_id => dotted revno.
311
This dictionary should not be modified by the caller.
313
if self._revision_id_to_revno_cache is not None:
314
mapping = self._revision_id_to_revno_cache
316
mapping = self._gen_revno_map()
317
self._cache_revision_id_to_revno(mapping)
318
# TODO: jam 20070417 Since this is being cached, should we be returning
320
# I would rather not, and instead just declare that users should not
321
# modify the return value.
324
def _gen_revno_map(self):
325
"""Create a new mapping from revision ids to dotted revnos.
327
Dotted revnos are generated based on the current tip in the revision
329
This is the worker function for get_revision_id_to_revno_map, which
330
just caches the return value.
332
:return: A dictionary mapping revision_id => dotted revno.
334
revision_id_to_revno = dict((rev_id, revno)
335
for rev_id, depth, revno, end_of_merge
336
in self.iter_merge_sorted_revisions())
337
return revision_id_to_revno
340
def iter_merge_sorted_revisions(self, start_revision_id=None,
341
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
342
"""Walk the revisions for a branch in merge sorted order.
344
Merge sorted order is the output from a merge-aware,
345
topological sort, i.e. all parents come before their
346
children going forward; the opposite for reverse.
348
:param start_revision_id: the revision_id to begin walking from.
349
If None, the branch tip is used.
350
:param stop_revision_id: the revision_id to terminate the walk
351
after. If None, the rest of history is included.
352
:param stop_rule: if stop_revision_id is not None, the precise rule
353
to use for termination:
354
* 'exclude' - leave the stop revision out of the result (default)
355
* 'include' - the stop revision is the last item in the result
356
* 'with-merges' - include the stop revision and all of its
357
merged revisions in the result
358
:param direction: either 'reverse' or 'forward':
359
* reverse means return the start_revision_id first, i.e.
360
start at the most recent revision and go backwards in history
361
* forward returns tuples in the opposite order to reverse.
362
Note in particular that forward does *not* do any intelligent
363
ordering w.r.t. depth as some clients of this API may like.
364
(If required, that ought to be done at higher layers.)
366
:return: an iterator over (revision_id, depth, revno, end_of_merge)
369
* revision_id: the unique id of the revision
370
* depth: How many levels of merging deep this node has been
372
* revno_sequence: This field provides a sequence of
373
revision numbers for all revisions. The format is:
374
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
375
branch that the revno is on. From left to right the REVNO numbers
376
are the sequence numbers within that branch of the revision.
377
* end_of_merge: When True the next node (earlier in history) is
378
part of a different merge.
380
# Note: depth and revno values are in the context of the branch so
381
# we need the full graph to get stable numbers, regardless of the
383
if self._merge_sorted_revisions_cache is None:
384
last_revision = self.last_revision()
385
graph = self.repository.get_graph()
386
parent_map = dict(((key, value) for key, value in
387
graph.iter_ancestry([last_revision]) if value is not None))
388
revision_graph = repository._strip_NULL_ghosts(parent_map)
389
revs = tsort.merge_sort(revision_graph, last_revision, None,
391
# Drop the sequence # before caching
392
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
394
filtered = self._filter_merge_sorted_revisions(
395
self._merge_sorted_revisions_cache, start_revision_id,
396
stop_revision_id, stop_rule)
397
if direction == 'reverse':
399
if direction == 'forward':
400
return reversed(list(filtered))
402
raise ValueError('invalid direction %r' % direction)
404
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
405
start_revision_id, stop_revision_id, stop_rule):
406
"""Iterate over an inclusive range of sorted revisions."""
407
rev_iter = iter(merge_sorted_revisions)
408
if start_revision_id is not None:
409
for rev_id, depth, revno, end_of_merge in rev_iter:
410
if rev_id != start_revision_id:
413
# The decision to include the start or not
414
# depends on the stop_rule if a stop is provided
416
iter([(rev_id, depth, revno, end_of_merge)]),
419
if stop_revision_id is None:
420
for rev_id, depth, revno, end_of_merge in rev_iter:
421
yield rev_id, depth, revno, end_of_merge
422
elif stop_rule == 'exclude':
423
for rev_id, depth, revno, end_of_merge in rev_iter:
424
if rev_id == stop_revision_id:
426
yield rev_id, depth, revno, end_of_merge
427
elif stop_rule == 'include':
428
for rev_id, depth, revno, end_of_merge in rev_iter:
429
yield rev_id, depth, revno, end_of_merge
430
if rev_id == stop_revision_id:
432
elif stop_rule == 'with-merges':
433
stop_rev = self.repository.get_revision(stop_revision_id)
434
if stop_rev.parent_ids:
435
left_parent = stop_rev.parent_ids[0]
437
left_parent = _mod_revision.NULL_REVISION
438
for rev_id, depth, revno, end_of_merge in rev_iter:
439
if rev_id == left_parent:
441
yield rev_id, depth, revno, end_of_merge
443
raise ValueError('invalid stop_rule %r' % stop_rule)
445
def leave_lock_in_place(self):
446
"""Tell this branch object not to release the physical lock when this
449
If lock_write doesn't return a token, then this method is not supported.
451
self.control_files.leave_in_place()
453
def dont_leave_lock_in_place(self):
454
"""Tell this branch object to release the physical lock when this
455
object is unlocked, even if it didn't originally acquire it.
457
If lock_write doesn't return a token, then this method is not supported.
459
self.control_files.dont_leave_in_place()
461
def bind(self, other):
462
"""Bind the local branch the other branch.
464
:param other: The branch to bind to
467
raise errors.UpgradeRequired(self.base)
470
def fetch(self, from_branch, last_revision=None, pb=None):
471
"""Copy revisions from from_branch into this branch.
473
:param from_branch: Where to copy from.
474
:param last_revision: What revision to stop at (None for at the end
476
:param pb: An optional progress bar to use.
479
if self.base == from_branch.base:
482
nested_pb = ui.ui_factory.nested_progress_bar()
487
from_branch.lock_read()
489
if last_revision is None:
490
pb.update('get source history')
491
last_revision = from_branch.last_revision()
492
last_revision = _mod_revision.ensure_null(last_revision)
493
return self.repository.fetch(from_branch.repository,
494
revision_id=last_revision,
497
if nested_pb is not None:
501
def get_bound_location(self):
502
"""Return the URL of the branch we are bound to.
504
Older format branches cannot bind, please be sure to use a metadir
509
def get_old_bound_location(self):
510
"""Return the URL of the branch we used to be bound to
512
raise errors.UpgradeRequired(self.base)
514
def get_commit_builder(self, parents, config=None, timestamp=None,
515
timezone=None, committer=None, revprops=None,
517
"""Obtain a CommitBuilder for this branch.
519
:param parents: Revision ids of the parents of the new revision.
520
:param config: Optional configuration to use.
521
:param timestamp: Optional timestamp recorded for commit.
522
:param timezone: Optional timezone for timestamp.
523
:param committer: Optional committer to set for commit.
524
:param revprops: Optional dictionary of revision properties.
525
:param revision_id: Optional revision id.
529
config = self.get_config()
531
return self.repository.get_commit_builder(self, parents, config,
532
timestamp, timezone, committer, revprops, revision_id)
534
def get_master_branch(self, possible_transports=None):
535
"""Return the branch we are bound to.
537
:return: Either a Branch, or None
541
def get_revision_delta(self, revno):
542
"""Return the delta for one revision.
544
The delta is relative to its mainline predecessor, or the
545
empty tree for revision 1.
547
rh = self.revision_history()
548
if not (1 <= revno <= len(rh)):
549
raise errors.InvalidRevisionNumber(revno)
550
return self.repository.get_revision_delta(rh[revno-1])
552
def get_stacked_on_url(self):
553
"""Get the URL this branch is stacked against.
555
:raises NotStacked: If the branch is not stacked.
556
:raises UnstackableBranchFormat: If the branch does not support
559
raise NotImplementedError(self.get_stacked_on_url)
561
def print_file(self, file, revision_id):
562
"""Print `file` to stdout."""
563
raise NotImplementedError(self.print_file)
565
def set_revision_history(self, rev_history):
566
raise NotImplementedError(self.set_revision_history)
568
def set_stacked_on_url(self, url):
569
"""Set the URL this branch is stacked against.
571
:raises UnstackableBranchFormat: If the branch does not support
573
:raises UnstackableRepositoryFormat: If the repository does not support
576
raise NotImplementedError(self.set_stacked_on_url)
578
def _set_tags_bytes(self, bytes):
579
"""Mirror method for _get_tags_bytes.
581
:seealso: Branch._get_tags_bytes.
583
return _run_with_write_locked_target(self, self._transport.put_bytes,
586
def _cache_revision_history(self, rev_history):
587
"""Set the cached revision history to rev_history.
589
The revision_history method will use this cache to avoid regenerating
590
the revision history.
592
This API is semi-public; it only for use by subclasses, all other code
593
should consider it to be private.
595
self._revision_history_cache = rev_history
597
def _cache_revision_id_to_revno(self, revision_id_to_revno):
598
"""Set the cached revision_id => revno map to revision_id_to_revno.
600
This API is semi-public; it only for use by subclasses, all other code
601
should consider it to be private.
603
self._revision_id_to_revno_cache = revision_id_to_revno
605
def _clear_cached_state(self):
606
"""Clear any cached data on this branch, e.g. cached revision history.
608
This means the next call to revision_history will need to call
609
_gen_revision_history.
611
This API is semi-public; it only for use by subclasses, all other code
612
should consider it to be private.
614
self._revision_history_cache = None
615
self._revision_id_to_revno_cache = None
616
self._last_revision_info_cache = None
617
self._merge_sorted_revisions_cache = None
619
def _gen_revision_history(self):
620
"""Return sequence of revision hashes on to this branch.
622
Unlike revision_history, this method always regenerates or rereads the
623
revision history, i.e. it does not cache the result, so repeated calls
626
Concrete subclasses should override this instead of revision_history so
627
that subclasses do not need to deal with caching logic.
629
This API is semi-public; it only for use by subclasses, all other code
630
should consider it to be private.
632
raise NotImplementedError(self._gen_revision_history)
635
def revision_history(self):
636
"""Return sequence of revision ids on this branch.
638
This method will cache the revision history for as long as it is safe to
641
if 'evil' in debug.debug_flags:
642
mutter_callsite(3, "revision_history scales with history.")
643
if self._revision_history_cache is not None:
644
history = self._revision_history_cache
646
history = self._gen_revision_history()
647
self._cache_revision_history(history)
651
"""Return current revision number for this branch.
653
That is equivalent to the number of revisions committed to
656
return self.last_revision_info()[0]
659
"""Older format branches cannot bind or unbind."""
660
raise errors.UpgradeRequired(self.base)
662
def set_append_revisions_only(self, enabled):
663
"""Older format branches are never restricted to append-only"""
664
raise errors.UpgradeRequired(self.base)
666
def last_revision(self):
667
"""Return last revision id, or NULL_REVISION."""
668
return self.last_revision_info()[1]
671
def last_revision_info(self):
672
"""Return information about the last revision.
674
:return: A tuple (revno, revision_id).
676
if self._last_revision_info_cache is None:
677
self._last_revision_info_cache = self._last_revision_info()
678
return self._last_revision_info_cache
680
def _last_revision_info(self):
681
rh = self.revision_history()
684
return (revno, rh[-1])
686
return (0, _mod_revision.NULL_REVISION)
688
@deprecated_method(deprecated_in((1, 6, 0)))
689
def missing_revisions(self, other, stop_revision=None):
690
"""Return a list of new revisions that would perfectly fit.
692
If self and other have not diverged, return a list of the revisions
693
present in other, but missing from self.
695
self_history = self.revision_history()
696
self_len = len(self_history)
697
other_history = other.revision_history()
698
other_len = len(other_history)
699
common_index = min(self_len, other_len) -1
700
if common_index >= 0 and \
701
self_history[common_index] != other_history[common_index]:
702
raise errors.DivergedBranches(self, other)
704
if stop_revision is None:
705
stop_revision = other_len
707
if stop_revision > other_len:
708
raise errors.NoSuchRevision(self, stop_revision)
709
return other_history[self_len:stop_revision]
712
def update_revisions(self, other, stop_revision=None, overwrite=False,
714
"""Pull in new perfect-fit revisions.
716
:param other: Another Branch to pull from
717
:param stop_revision: Updated until the given revision
718
:param overwrite: Always set the branch pointer, rather than checking
719
to see if it is a proper descendant.
720
:param graph: A Graph object that can be used to query history
721
information. This can be None.
724
return InterBranch.get(other, self).update_revisions(stop_revision,
727
def import_last_revision_info(self, source_repo, revno, revid):
728
"""Set the last revision info, importing from another repo if necessary.
730
This is used by the bound branch code to upload a revision to
731
the master branch first before updating the tip of the local branch.
733
:param source_repo: Source repository to optionally fetch from
734
:param revno: Revision number of the new tip
735
:param revid: Revision id of the new tip
737
if not self.repository.has_same_location(source_repo):
738
self.repository.fetch(source_repo, revision_id=revid)
739
self.set_last_revision_info(revno, revid)
741
def revision_id_to_revno(self, revision_id):
742
"""Given a revision id, return its revno"""
743
if _mod_revision.is_null(revision_id):
745
history = self.revision_history()
747
return history.index(revision_id) + 1
749
raise errors.NoSuchRevision(self, revision_id)
751
def get_rev_id(self, revno, history=None):
752
"""Find the revision id of the specified revno."""
754
return _mod_revision.NULL_REVISION
756
history = self.revision_history()
757
if revno <= 0 or revno > len(history):
758
raise errors.NoSuchRevision(self, revno)
759
return history[revno - 1]
761
def pull(self, source, overwrite=False, stop_revision=None,
762
possible_transports=None, _override_hook_target=None):
763
"""Mirror source into this branch.
765
This branch is considered to be 'local', having low latency.
767
:returns: PullResult instance
769
raise NotImplementedError(self.pull)
771
def push(self, target, overwrite=False, stop_revision=None):
772
"""Mirror this branch into target.
774
This branch is considered to be 'local', having low latency.
776
raise NotImplementedError(self.push)
778
def basis_tree(self):
779
"""Return `Tree` object for last revision."""
780
return self.repository.revision_tree(self.last_revision())
782
def get_parent(self):
783
"""Return the parent location of the branch.
785
This is the default location for pull/missing. The usual
786
pattern is that the user can override it by specifying a
789
parent = self._get_parent_location()
792
# This is an old-format absolute path to a local branch
794
if parent.startswith('/'):
795
parent = urlutils.local_path_to_url(parent.decode('utf8'))
797
return urlutils.join(self.base[:-1], parent)
798
except errors.InvalidURLJoin, e:
799
raise errors.InaccessibleParent(parent, self.base)
801
def _get_parent_location(self):
802
raise NotImplementedError(self._get_parent_location)
804
def _set_config_location(self, name, url, config=None,
805
make_relative=False):
807
config = self.get_config()
811
url = urlutils.relative_url(self.base, url)
812
config.set_user_option(name, url, warn_masked=True)
814
def _get_config_location(self, name, config=None):
816
config = self.get_config()
817
location = config.get_user_option(name)
822
def get_submit_branch(self):
823
"""Return the submit location of the branch.
825
This is the default location for bundle. The usual
826
pattern is that the user can override it by specifying a
829
return self.get_config().get_user_option('submit_branch')
831
def set_submit_branch(self, location):
832
"""Return the submit location of the branch.
834
This is the default location for bundle. The usual
835
pattern is that the user can override it by specifying a
838
self.get_config().set_user_option('submit_branch', location,
841
def get_public_branch(self):
842
"""Return the public location of the branch.
844
This is is used by merge directives.
846
return self._get_config_location('public_branch')
848
def set_public_branch(self, location):
849
"""Return the submit location of the branch.
851
This is the default location for bundle. The usual
852
pattern is that the user can override it by specifying a
855
self._set_config_location('public_branch', location)
857
def get_push_location(self):
858
"""Return the None or the location to push this branch to."""
859
push_loc = self.get_config().get_user_option('push_location')
862
def set_push_location(self, location):
863
"""Set a new push location for this branch."""
864
raise NotImplementedError(self.set_push_location)
866
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
867
"""Run the post_change_branch_tip hooks."""
868
hooks = Branch.hooks['post_change_branch_tip']
871
new_revno, new_revid = self.last_revision_info()
872
params = ChangeBranchTipParams(
873
self, old_revno, new_revno, old_revid, new_revid)
877
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
878
"""Run the pre_change_branch_tip hooks."""
879
hooks = Branch.hooks['pre_change_branch_tip']
882
old_revno, old_revid = self.last_revision_info()
883
params = ChangeBranchTipParams(
884
self, old_revno, new_revno, old_revid, new_revid)
888
except errors.TipChangeRejected:
891
exc_info = sys.exc_info()
892
hook_name = Branch.hooks.get_hook_name(hook)
893
raise errors.HookFailed(
894
'pre_change_branch_tip', hook_name, exc_info)
896
def set_parent(self, url):
897
raise NotImplementedError(self.set_parent)
901
"""Synchronise this branch with the master branch if any.
903
:return: None or the last_revision pivoted out during the update.
907
def check_revno(self, revno):
909
Check whether a revno corresponds to any revision.
910
Zero (the NULL revision) is considered valid.
913
self.check_real_revno(revno)
915
def check_real_revno(self, revno):
917
Check whether a revno corresponds to a real revision.
918
Zero (the NULL revision) is considered invalid
920
if revno < 1 or revno > self.revno():
921
raise errors.InvalidRevisionNumber(revno)
924
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
925
"""Clone this branch into to_bzrdir preserving all semantic values.
927
Most API users will want 'create_clone_on_transport', which creates a
928
new bzrdir and branch on the fly.
930
revision_id: if not None, the revision history in the new branch will
931
be truncated to end with revision_id.
933
result = to_bzrdir.create_branch()
934
if repository_policy is not None:
935
repository_policy.configure_branch(result)
936
self.copy_content_into(result, revision_id=revision_id)
940
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
941
"""Create a new line of development from the branch, into to_bzrdir.
943
to_bzrdir controls the branch format.
945
revision_id: if not None, the revision history in the new branch will
946
be truncated to end with revision_id.
948
result = to_bzrdir.create_branch()
949
if repository_policy is not None:
950
repository_policy.configure_branch(result)
951
self.copy_content_into(result, revision_id=revision_id)
952
result.set_parent(self.bzrdir.root_transport.base)
955
def _synchronize_history(self, destination, revision_id):
956
"""Synchronize last revision and revision history between branches.
958
This version is most efficient when the destination is also a
959
BzrBranch6, but works for BzrBranch5, as long as the destination's
960
repository contains all the lefthand ancestors of the intended
961
last_revision. If not, set_last_revision_info will fail.
963
:param destination: The branch to copy the history into
964
:param revision_id: The revision-id to truncate history at. May
965
be None to copy complete history.
967
source_revno, source_revision_id = self.last_revision_info()
968
if revision_id is None:
969
revno, revision_id = source_revno, source_revision_id
970
elif source_revision_id == revision_id:
971
# we know the revno without needing to walk all of history
974
# To figure out the revno for a random revision, we need to build
975
# the revision history, and count its length.
976
# We don't care about the order, just how long it is.
977
# Alternatively, we could start at the current location, and count
978
# backwards. But there is no guarantee that we will find it since
979
# it may be a merged revision.
980
revno = len(list(self.repository.iter_reverse_revision_history(
982
destination.set_last_revision_info(revno, revision_id)
985
def copy_content_into(self, destination, revision_id=None):
986
"""Copy the content of self into destination.
988
revision_id: if not None, the revision history in the new branch will
989
be truncated to end with revision_id.
991
self._synchronize_history(destination, revision_id)
993
parent = self.get_parent()
994
except errors.InaccessibleParent, e:
995
mutter('parent was not accessible to copy: %s', e)
998
destination.set_parent(parent)
999
if self._push_should_merge_tags():
1000
self.tags.merge_to(destination.tags)
1004
"""Check consistency of the branch.
1006
In particular this checks that revisions given in the revision-history
1007
do actually match up in the revision graph, and that they're all
1008
present in the repository.
1010
Callers will typically also want to check the repository.
1012
:return: A BranchCheckResult.
1014
mainline_parent_id = None
1015
last_revno, last_revision_id = self.last_revision_info()
1016
real_rev_history = list(self.repository.iter_reverse_revision_history(
1018
real_rev_history.reverse()
1019
if len(real_rev_history) != last_revno:
1020
raise errors.BzrCheckError('revno does not match len(mainline)'
1021
' %s != %s' % (last_revno, len(real_rev_history)))
1022
# TODO: We should probably also check that real_rev_history actually
1023
# matches self.revision_history()
1024
for revision_id in real_rev_history:
1026
revision = self.repository.get_revision(revision_id)
1027
except errors.NoSuchRevision, e:
1028
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1030
# In general the first entry on the revision history has no parents.
1031
# But it's not illegal for it to have parents listed; this can happen
1032
# in imports from Arch when the parents weren't reachable.
1033
if mainline_parent_id is not None:
1034
if mainline_parent_id not in revision.parent_ids:
1035
raise errors.BzrCheckError("previous revision {%s} not listed among "
1037
% (mainline_parent_id, revision_id))
1038
mainline_parent_id = revision_id
1039
return BranchCheckResult(self)
1041
def _get_checkout_format(self):
1042
"""Return the most suitable metadir for a checkout of this branch.
1043
Weaves are used if this branch's repository uses weaves.
1045
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1046
from bzrlib.repofmt import weaverepo
1047
format = bzrdir.BzrDirMetaFormat1()
1048
format.repository_format = weaverepo.RepositoryFormat7()
1050
format = self.repository.bzrdir.checkout_metadir()
1051
format.set_branch_format(self._format)
1054
def create_clone_on_transport(self, to_transport, revision_id=None,
1056
"""Create a clone of this branch and its bzrdir.
1058
:param to_transport: The transport to clone onto.
1059
:param revision_id: The revision id to use as tip in the new branch.
1060
If None the tip is obtained from this branch.
1061
:param stacked_on: An optional URL to stack the clone on.
1063
# XXX: Fix the bzrdir API to allow getting the branch back from the
1064
# clone call. Or something. 20090224 RBC/spiv.
1065
dir_to = self.bzrdir.clone_on_transport(to_transport,
1066
revision_id=revision_id, stacked_on=stacked_on)
1067
return dir_to.open_branch()
1069
def create_checkout(self, to_location, revision_id=None,
1070
lightweight=False, accelerator_tree=None,
1072
"""Create a checkout of a branch.
1074
:param to_location: The url to produce the checkout at
1075
:param revision_id: The revision to check out
1076
:param lightweight: If True, produce a lightweight checkout, otherwise,
1077
produce a bound branch (heavyweight checkout)
1078
:param accelerator_tree: A tree which can be used for retrieving file
1079
contents more quickly than the revision tree, i.e. a workingtree.
1080
The revision tree will be used for cases where accelerator_tree's
1081
content is different.
1082
:param hardlink: If true, hard-link files from accelerator_tree,
1084
:return: The tree of the created checkout
1086
t = transport.get_transport(to_location)
1089
format = self._get_checkout_format()
1090
checkout = format.initialize_on_transport(t)
1091
from_branch = BranchReferenceFormat().initialize(checkout, self)
1093
format = self._get_checkout_format()
1094
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1095
to_location, force_new_tree=False, format=format)
1096
checkout = checkout_branch.bzrdir
1097
checkout_branch.bind(self)
1098
# pull up to the specified revision_id to set the initial
1099
# branch tip correctly, and seed it with history.
1100
checkout_branch.pull(self, stop_revision=revision_id)
1102
tree = checkout.create_workingtree(revision_id,
1103
from_branch=from_branch,
1104
accelerator_tree=accelerator_tree,
1106
basis_tree = tree.basis_tree()
1107
basis_tree.lock_read()
1109
for path, file_id in basis_tree.iter_references():
1110
reference_parent = self.reference_parent(file_id, path)
1111
reference_parent.create_checkout(tree.abspath(path),
1112
basis_tree.get_reference_revision(file_id, path),
1119
def reconcile(self, thorough=True):
1120
"""Make sure the data stored in this branch is consistent."""
1121
from bzrlib.reconcile import BranchReconciler
1122
reconciler = BranchReconciler(self, thorough=thorough)
1123
reconciler.reconcile()
1126
def reference_parent(self, file_id, path):
1127
"""Return the parent branch for a tree-reference file_id
1128
:param file_id: The file_id of the tree reference
1129
:param path: The path of the file_id in the tree
1130
:return: A branch associated with the file_id
1132
# FIXME should provide multiple branches, based on config
1133
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1135
def supports_tags(self):
1136
return self._format.supports_tags()
1138
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1140
"""Ensure that revision_b is a descendant of revision_a.
1142
This is a helper function for update_revisions.
1144
:raises: DivergedBranches if revision_b has diverged from revision_a.
1145
:returns: True if revision_b is a descendant of revision_a.
1147
relation = self._revision_relations(revision_a, revision_b, graph)
1148
if relation == 'b_descends_from_a':
1150
elif relation == 'diverged':
1151
raise errors.DivergedBranches(self, other_branch)
1152
elif relation == 'a_descends_from_b':
1155
raise AssertionError("invalid relation: %r" % (relation,))
1157
def _revision_relations(self, revision_a, revision_b, graph):
1158
"""Determine the relationship between two revisions.
1160
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1162
heads = graph.heads([revision_a, revision_b])
1163
if heads == set([revision_b]):
1164
return 'b_descends_from_a'
1165
elif heads == set([revision_a, revision_b]):
1166
# These branches have diverged
1168
elif heads == set([revision_a]):
1169
return 'a_descends_from_b'
1171
raise AssertionError("invalid heads: %r" % (heads,))
1174
class BranchFormat(object):
1175
"""An encapsulation of the initialization and open routines for a format.
1177
Formats provide three things:
1178
* An initialization routine,
1182
Formats are placed in an dict by their format string for reference
1183
during branch opening. Its not required that these be instances, they
1184
can be classes themselves with class methods - it simply depends on
1185
whether state is needed for a given format or not.
1187
Once a format is deprecated, just deprecate the initialize and open
1188
methods on the format class. Do not deprecate the object, as the
1189
object will be created every time regardless.
1192
_default_format = None
1193
"""The default format used for new branches."""
1196
"""The known formats."""
1198
def __eq__(self, other):
1199
return self.__class__ is other.__class__
1201
def __ne__(self, other):
1202
return not (self == other)
1205
def find_format(klass, a_bzrdir):
1206
"""Return the format for the branch object in a_bzrdir."""
1208
transport = a_bzrdir.get_branch_transport(None)
1209
format_string = transport.get("format").read()
1210
return klass._formats[format_string]
1211
except errors.NoSuchFile:
1212
raise errors.NotBranchError(path=transport.base)
1214
raise errors.UnknownFormatError(format=format_string, kind='branch')
1217
def get_default_format(klass):
1218
"""Return the current default format."""
1219
return klass._default_format
1221
def get_reference(self, a_bzrdir):
1222
"""Get the target reference of the branch in a_bzrdir.
1224
format probing must have been completed before calling
1225
this method - it is assumed that the format of the branch
1226
in a_bzrdir is correct.
1228
:param a_bzrdir: The bzrdir to get the branch data from.
1229
:return: None if the branch is not a reference branch.
1234
def set_reference(self, a_bzrdir, to_branch):
1235
"""Set the target reference of the branch in a_bzrdir.
1237
format probing must have been completed before calling
1238
this method - it is assumed that the format of the branch
1239
in a_bzrdir is correct.
1241
:param a_bzrdir: The bzrdir to set the branch reference for.
1242
:param to_branch: branch that the checkout is to reference
1244
raise NotImplementedError(self.set_reference)
1246
def get_format_string(self):
1247
"""Return the ASCII format string that identifies this format."""
1248
raise NotImplementedError(self.get_format_string)
1250
def get_format_description(self):
1251
"""Return the short format description for this format."""
1252
raise NotImplementedError(self.get_format_description)
1254
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1256
"""Initialize a branch in a bzrdir, with specified files
1258
:param a_bzrdir: The bzrdir to initialize the branch in
1259
:param utf8_files: The files to create as a list of
1260
(filename, content) tuples
1261
:param set_format: If True, set the format with
1262
self.get_format_string. (BzrBranch4 has its format set
1264
:return: a branch in this format
1266
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1267
branch_transport = a_bzrdir.get_branch_transport(self)
1269
'metadir': ('lock', lockdir.LockDir),
1270
'branch4': ('branch-lock', lockable_files.TransportLock),
1272
lock_name, lock_class = lock_map[lock_type]
1273
control_files = lockable_files.LockableFiles(branch_transport,
1274
lock_name, lock_class)
1275
control_files.create_lock()
1276
control_files.lock_write()
1278
utf8_files += [('format', self.get_format_string())]
1280
for (filename, content) in utf8_files:
1281
branch_transport.put_bytes(
1283
mode=a_bzrdir._get_file_mode())
1285
control_files.unlock()
1286
return self.open(a_bzrdir, _found=True)
1288
def initialize(self, a_bzrdir):
1289
"""Create a branch of this format in a_bzrdir."""
1290
raise NotImplementedError(self.initialize)
1292
def is_supported(self):
1293
"""Is this format supported?
1295
Supported formats can be initialized and opened.
1296
Unsupported formats may not support initialization or committing or
1297
some other features depending on the reason for not being supported.
1301
def make_tags(self, branch):
1302
"""Create a tags object for branch.
1304
This method is on BranchFormat, because BranchFormats are reflected
1305
over the wire via network_name(), whereas full Branch instances require
1306
multiple VFS method calls to operate at all.
1308
The default implementation returns a disabled-tags instance.
1310
Note that it is normal for branch to be a RemoteBranch when using tags
1313
return DisabledTags(branch)
1315
def network_name(self):
1316
"""A simple byte string uniquely identifying this format for RPC calls.
1318
MetaDir branch formats use their disk format string to identify the
1319
repository over the wire. All in one formats such as bzr < 0.8, and
1320
foreign formats like svn/git and hg should use some marker which is
1321
unique and immutable.
1323
raise NotImplementedError(self.network_name)
1325
def open(self, a_bzrdir, _found=False):
1326
"""Return the branch object for a_bzrdir
1328
_found is a private parameter, do not use it. It is used to indicate
1329
if format probing has already be done.
1331
raise NotImplementedError(self.open)
1334
def register_format(klass, format):
1335
"""Register a metadir format."""
1336
klass._formats[format.get_format_string()] = format
1337
# Metadir formats have a network name of their format string, and get
1338
# registered as class factories.
1339
network_format_registry.register(format.get_format_string(), format.__class__)
1342
def set_default_format(klass, format):
1343
klass._default_format = format
1345
def supports_stacking(self):
1346
"""True if this format records a stacked-on branch."""
1350
def unregister_format(klass, format):
1351
del klass._formats[format.get_format_string()]
1354
return self.get_format_description().rstrip()
1356
def supports_tags(self):
1357
"""True if this format supports tags stored in the branch"""
1358
return False # by default
1361
class BranchHooks(Hooks):
1362
"""A dictionary mapping hook name to a list of callables for branch hooks.
1364
e.g. ['set_rh'] Is the list of items to be called when the
1365
set_revision_history function is invoked.
1369
"""Create the default hooks.
1371
These are all empty initially, because by default nothing should get
1374
Hooks.__init__(self)
1375
self.create_hook(HookPoint('set_rh',
1376
"Invoked whenever the revision history has been set via "
1377
"set_revision_history. The api signature is (branch, "
1378
"revision_history), and the branch will be write-locked. "
1379
"The set_rh hook can be expensive for bzr to trigger, a better "
1380
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1381
self.create_hook(HookPoint('open',
1382
"Called with the Branch object that has been opened after a "
1383
"branch is opened.", (1, 8), None))
1384
self.create_hook(HookPoint('post_push',
1385
"Called after a push operation completes. post_push is called "
1386
"with a bzrlib.branch.PushResult object and only runs in the "
1387
"bzr client.", (0, 15), None))
1388
self.create_hook(HookPoint('post_pull',
1389
"Called after a pull operation completes. post_pull is called "
1390
"with a bzrlib.branch.PullResult object and only runs in the "
1391
"bzr client.", (0, 15), None))
1392
self.create_hook(HookPoint('pre_commit',
1393
"Called after a commit is calculated but before it is is "
1394
"completed. pre_commit is called with (local, master, old_revno, "
1395
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1396
"). old_revid is NULL_REVISION for the first commit to a branch, "
1397
"tree_delta is a TreeDelta object describing changes from the "
1398
"basis revision. hooks MUST NOT modify this delta. "
1399
" future_tree is an in-memory tree obtained from "
1400
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1401
"tree.", (0,91), None))
1402
self.create_hook(HookPoint('post_commit',
1403
"Called in the bzr client after a commit has completed. "
1404
"post_commit is called with (local, master, old_revno, old_revid, "
1405
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1406
"commit to a branch.", (0, 15), None))
1407
self.create_hook(HookPoint('post_uncommit',
1408
"Called in the bzr client after an uncommit completes. "
1409
"post_uncommit is called with (local, master, old_revno, "
1410
"old_revid, new_revno, new_revid) where local is the local branch "
1411
"or None, master is the target branch, and an empty branch "
1412
"recieves new_revno of 0, new_revid of None.", (0, 15), None))
1413
self.create_hook(HookPoint('pre_change_branch_tip',
1414
"Called in bzr client and server before a change to the tip of a "
1415
"branch is made. pre_change_branch_tip is called with a "
1416
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1417
"commit, uncommit will all trigger this hook.", (1, 6), None))
1418
self.create_hook(HookPoint('post_change_branch_tip',
1419
"Called in bzr client and server after a change to the tip of a "
1420
"branch is made. post_change_branch_tip is called with a "
1421
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1422
"commit, uncommit will all trigger this hook.", (1, 4), None))
1423
self.create_hook(HookPoint('transform_fallback_location',
1424
"Called when a stacked branch is activating its fallback "
1425
"locations. transform_fallback_location is called with (branch, "
1426
"url), and should return a new url. Returning the same url "
1427
"allows it to be used as-is, returning a different one can be "
1428
"used to cause the branch to stack on a closer copy of that "
1429
"fallback_location. Note that the branch cannot have history "
1430
"accessing methods called on it during this hook because the "
1431
"fallback locations have not been activated. When there are "
1432
"multiple hooks installed for transform_fallback_location, "
1433
"all are called with the url returned from the previous hook."
1434
"The order is however undefined.", (1, 9), None))
1437
# install the default hooks into the Branch class.
1438
Branch.hooks = BranchHooks()
1441
class ChangeBranchTipParams(object):
1442
"""Object holding parameters passed to *_change_branch_tip hooks.
1444
There are 5 fields that hooks may wish to access:
1446
:ivar branch: the branch being changed
1447
:ivar old_revno: revision number before the change
1448
:ivar new_revno: revision number after the change
1449
:ivar old_revid: revision id before the change
1450
:ivar new_revid: revision id after the change
1452
The revid fields are strings. The revno fields are integers.
1455
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1456
"""Create a group of ChangeBranchTip parameters.
1458
:param branch: The branch being changed.
1459
:param old_revno: Revision number before the change.
1460
:param new_revno: Revision number after the change.
1461
:param old_revid: Tip revision id before the change.
1462
:param new_revid: Tip revision id after the change.
1464
self.branch = branch
1465
self.old_revno = old_revno
1466
self.new_revno = new_revno
1467
self.old_revid = old_revid
1468
self.new_revid = new_revid
1470
def __eq__(self, other):
1471
return self.__dict__ == other.__dict__
1474
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1475
self.__class__.__name__, self.branch,
1476
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1479
class BzrBranchFormat4(BranchFormat):
1480
"""Bzr branch format 4.
1483
- a revision-history file.
1484
- a branch-lock lock file [ to be shared with the bzrdir ]
1487
def get_format_description(self):
1488
"""See BranchFormat.get_format_description()."""
1489
return "Branch format 4"
1491
def initialize(self, a_bzrdir):
1492
"""Create a branch of this format in a_bzrdir."""
1493
utf8_files = [('revision-history', ''),
1494
('branch-name', ''),
1496
return self._initialize_helper(a_bzrdir, utf8_files,
1497
lock_type='branch4', set_format=False)
1500
super(BzrBranchFormat4, self).__init__()
1501
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1503
def network_name(self):
1504
"""The network name for this format is the control dirs disk label."""
1505
return self._matchingbzrdir.get_format_string()
1507
def open(self, a_bzrdir, _found=False):
1508
"""Return the branch object for a_bzrdir
1510
_found is a private parameter, do not use it. It is used to indicate
1511
if format probing has already be done.
1514
# we are being called directly and must probe.
1515
raise NotImplementedError
1516
return BzrBranch(_format=self,
1517
_control_files=a_bzrdir._control_files,
1519
_repository=a_bzrdir.open_repository())
1522
return "Bazaar-NG branch format 4"
1525
class BranchFormatMetadir(BranchFormat):
1526
"""Common logic for meta-dir based branch formats."""
1528
def _branch_class(self):
1529
"""What class to instantiate on open calls."""
1530
raise NotImplementedError(self._branch_class)
1532
def network_name(self):
1533
"""A simple byte string uniquely identifying this format for RPC calls.
1535
Metadir branch formats use their format string.
1537
return self.get_format_string()
1539
def open(self, a_bzrdir, _found=False):
1540
"""Return the branch object for a_bzrdir.
1542
_found is a private parameter, do not use it. It is used to indicate
1543
if format probing has already be done.
1546
format = BranchFormat.find_format(a_bzrdir)
1547
if format.__class__ != self.__class__:
1548
raise AssertionError("wrong format %r found for %r" %
1551
transport = a_bzrdir.get_branch_transport(None)
1552
control_files = lockable_files.LockableFiles(transport, 'lock',
1554
return self._branch_class()(_format=self,
1555
_control_files=control_files,
1557
_repository=a_bzrdir.find_repository())
1558
except errors.NoSuchFile:
1559
raise errors.NotBranchError(path=transport.base)
1562
super(BranchFormatMetadir, self).__init__()
1563
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1564
self._matchingbzrdir.set_branch_format(self)
1566
def supports_tags(self):
1570
class BzrBranchFormat5(BranchFormatMetadir):
1571
"""Bzr branch format 5.
1574
- a revision-history file.
1576
- a lock dir guarding the branch itself
1577
- all of this stored in a branch/ subdirectory
1578
- works with shared repositories.
1580
This format is new in bzr 0.8.
1583
def _branch_class(self):
1586
def get_format_string(self):
1587
"""See BranchFormat.get_format_string()."""
1588
return "Bazaar-NG branch format 5\n"
1590
def get_format_description(self):
1591
"""See BranchFormat.get_format_description()."""
1592
return "Branch format 5"
1594
def initialize(self, a_bzrdir):
1595
"""Create a branch of this format in a_bzrdir."""
1596
utf8_files = [('revision-history', ''),
1597
('branch-name', ''),
1599
return self._initialize_helper(a_bzrdir, utf8_files)
1601
def supports_tags(self):
1605
class BzrBranchFormat6(BranchFormatMetadir):
1606
"""Branch format with last-revision and tags.
1608
Unlike previous formats, this has no explicit revision history. Instead,
1609
this just stores the last-revision, and the left-hand history leading
1610
up to there is the history.
1612
This format was introduced in bzr 0.15
1613
and became the default in 0.91.
1616
def _branch_class(self):
1619
def get_format_string(self):
1620
"""See BranchFormat.get_format_string()."""
1621
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1623
def get_format_description(self):
1624
"""See BranchFormat.get_format_description()."""
1625
return "Branch format 6"
1627
def initialize(self, a_bzrdir):
1628
"""Create a branch of this format in a_bzrdir."""
1629
utf8_files = [('last-revision', '0 null:\n'),
1630
('branch.conf', ''),
1633
return self._initialize_helper(a_bzrdir, utf8_files)
1635
def make_tags(self, branch):
1636
"""See bzrlib.branch.BranchFormat.make_tags()."""
1637
return BasicTags(branch)
1641
class BzrBranchFormat7(BranchFormatMetadir):
1642
"""Branch format with last-revision, tags, and a stacked location pointer.
1644
The stacked location pointer is passed down to the repository and requires
1645
a repository format with supports_external_lookups = True.
1647
This format was introduced in bzr 1.6.
1650
def _branch_class(self):
1653
def get_format_string(self):
1654
"""See BranchFormat.get_format_string()."""
1655
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1657
def get_format_description(self):
1658
"""See BranchFormat.get_format_description()."""
1659
return "Branch format 7"
1661
def initialize(self, a_bzrdir):
1662
"""Create a branch of this format in a_bzrdir."""
1663
utf8_files = [('last-revision', '0 null:\n'),
1664
('branch.conf', ''),
1667
return self._initialize_helper(a_bzrdir, utf8_files)
1670
super(BzrBranchFormat7, self).__init__()
1671
self._matchingbzrdir.repository_format = \
1672
RepositoryFormatKnitPack5RichRoot()
1674
def make_tags(self, branch):
1675
"""See bzrlib.branch.BranchFormat.make_tags()."""
1676
return BasicTags(branch)
1678
def supports_stacking(self):
1682
class BranchReferenceFormat(BranchFormat):
1683
"""Bzr branch reference format.
1685
Branch references are used in implementing checkouts, they
1686
act as an alias to the real branch which is at some other url.
1693
def get_format_string(self):
1694
"""See BranchFormat.get_format_string()."""
1695
return "Bazaar-NG Branch Reference Format 1\n"
1697
def get_format_description(self):
1698
"""See BranchFormat.get_format_description()."""
1699
return "Checkout reference format 1"
1701
def get_reference(self, a_bzrdir):
1702
"""See BranchFormat.get_reference()."""
1703
transport = a_bzrdir.get_branch_transport(None)
1704
return transport.get('location').read()
1706
def set_reference(self, a_bzrdir, to_branch):
1707
"""See BranchFormat.set_reference()."""
1708
transport = a_bzrdir.get_branch_transport(None)
1709
location = transport.put_bytes('location', to_branch.base)
1711
def initialize(self, a_bzrdir, target_branch=None):
1712
"""Create a branch of this format in a_bzrdir."""
1713
if target_branch is None:
1714
# this format does not implement branch itself, thus the implicit
1715
# creation contract must see it as uninitializable
1716
raise errors.UninitializableFormat(self)
1717
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1718
branch_transport = a_bzrdir.get_branch_transport(self)
1719
branch_transport.put_bytes('location',
1720
target_branch.bzrdir.root_transport.base)
1721
branch_transport.put_bytes('format', self.get_format_string())
1723
a_bzrdir, _found=True,
1724
possible_transports=[target_branch.bzrdir.root_transport])
1727
super(BranchReferenceFormat, self).__init__()
1728
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1729
self._matchingbzrdir.set_branch_format(self)
1731
def _make_reference_clone_function(format, a_branch):
1732
"""Create a clone() routine for a branch dynamically."""
1733
def clone(to_bzrdir, revision_id=None,
1734
repository_policy=None):
1735
"""See Branch.clone()."""
1736
return format.initialize(to_bzrdir, a_branch)
1737
# cannot obey revision_id limits when cloning a reference ...
1738
# FIXME RBC 20060210 either nuke revision_id for clone, or
1739
# emit some sort of warning/error to the caller ?!
1742
def open(self, a_bzrdir, _found=False, location=None,
1743
possible_transports=None):
1744
"""Return the branch that the branch reference in a_bzrdir points at.
1746
_found is a private parameter, do not use it. It is used to indicate
1747
if format probing has already be done.
1750
format = BranchFormat.find_format(a_bzrdir)
1751
if format.__class__ != self.__class__:
1752
raise AssertionError("wrong format %r found for %r" %
1754
if location is None:
1755
location = self.get_reference(a_bzrdir)
1756
real_bzrdir = bzrdir.BzrDir.open(
1757
location, possible_transports=possible_transports)
1758
result = real_bzrdir.open_branch()
1759
# this changes the behaviour of result.clone to create a new reference
1760
# rather than a copy of the content of the branch.
1761
# I did not use a proxy object because that needs much more extensive
1762
# testing, and we are only changing one behaviour at the moment.
1763
# If we decide to alter more behaviours - i.e. the implicit nickname
1764
# then this should be refactored to introduce a tested proxy branch
1765
# and a subclass of that for use in overriding clone() and ....
1767
result.clone = self._make_reference_clone_function(result)
1771
network_format_registry = registry.FormatRegistry()
1772
"""Registry of formats indexed by their network name.
1774
The network name for a branch format is an identifier that can be used when
1775
referring to formats with smart server operations. See
1776
BranchFormat.network_name() for more detail.
1780
# formats which have no format string are not discoverable
1781
# and not independently creatable, so are not registered.
1782
__format5 = BzrBranchFormat5()
1783
__format6 = BzrBranchFormat6()
1784
__format7 = BzrBranchFormat7()
1785
BranchFormat.register_format(__format5)
1786
BranchFormat.register_format(BranchReferenceFormat())
1787
BranchFormat.register_format(__format6)
1788
BranchFormat.register_format(__format7)
1789
BranchFormat.set_default_format(__format6)
1790
_legacy_formats = [BzrBranchFormat4(),
1792
network_format_registry.register(
1793
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1796
class BzrBranch(Branch):
1797
"""A branch stored in the actual filesystem.
1799
Note that it's "local" in the context of the filesystem; it doesn't
1800
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1801
it's writable, and can be accessed via the normal filesystem API.
1803
:ivar _transport: Transport for file operations on this branch's
1804
control files, typically pointing to the .bzr/branch directory.
1805
:ivar repository: Repository for this branch.
1806
:ivar base: The url of the base directory for this branch; the one
1807
containing the .bzr directory.
1810
def __init__(self, _format=None,
1811
_control_files=None, a_bzrdir=None, _repository=None):
1812
"""Create new branch object at a particular location."""
1813
if a_bzrdir is None:
1814
raise ValueError('a_bzrdir must be supplied')
1816
self.bzrdir = a_bzrdir
1817
self._base = self.bzrdir.transport.clone('..').base
1818
# XXX: We should be able to just do
1819
# self.base = self.bzrdir.root_transport.base
1820
# but this does not quite work yet -- mbp 20080522
1821
self._format = _format
1822
if _control_files is None:
1823
raise ValueError('BzrBranch _control_files is None')
1824
self.control_files = _control_files
1825
self._transport = _control_files._transport
1826
self.repository = _repository
1827
Branch.__init__(self)
1830
return '%s(%r)' % (self.__class__.__name__, self.base)
1834
def _get_base(self):
1835
"""Returns the directory containing the control directory."""
1838
base = property(_get_base, doc="The URL for the root of this branch.")
1840
def is_locked(self):
1841
return self.control_files.is_locked()
1843
def lock_write(self, token=None):
1844
repo_token = self.repository.lock_write()
1846
token = self.control_files.lock_write(token=token)
1848
self.repository.unlock()
1852
def lock_read(self):
1853
self.repository.lock_read()
1855
self.control_files.lock_read()
1857
self.repository.unlock()
1861
# TODO: test for failed two phase locks. This is known broken.
1863
self.control_files.unlock()
1865
self.repository.unlock()
1866
if not self.control_files.is_locked():
1867
# we just released the lock
1868
self._clear_cached_state()
1870
def peek_lock_mode(self):
1871
if self.control_files._lock_count == 0:
1874
return self.control_files._lock_mode
1876
def get_physical_lock_status(self):
1877
return self.control_files.get_physical_lock_status()
1880
def print_file(self, file, revision_id):
1881
"""See Branch.print_file."""
1882
return self.repository.print_file(file, revision_id)
1884
def _write_revision_history(self, history):
1885
"""Factored out of set_revision_history.
1887
This performs the actual writing to disk.
1888
It is intended to be called by BzrBranch5.set_revision_history."""
1889
self._transport.put_bytes(
1890
'revision-history', '\n'.join(history),
1891
mode=self.bzrdir._get_file_mode())
1894
def set_revision_history(self, rev_history):
1895
"""See Branch.set_revision_history."""
1896
if 'evil' in debug.debug_flags:
1897
mutter_callsite(3, "set_revision_history scales with history.")
1898
check_not_reserved_id = _mod_revision.check_not_reserved_id
1899
for rev_id in rev_history:
1900
check_not_reserved_id(rev_id)
1901
if Branch.hooks['post_change_branch_tip']:
1902
# Don't calculate the last_revision_info() if there are no hooks
1904
old_revno, old_revid = self.last_revision_info()
1905
if len(rev_history) == 0:
1906
revid = _mod_revision.NULL_REVISION
1908
revid = rev_history[-1]
1909
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1910
self._write_revision_history(rev_history)
1911
self._clear_cached_state()
1912
self._cache_revision_history(rev_history)
1913
for hook in Branch.hooks['set_rh']:
1914
hook(self, rev_history)
1915
if Branch.hooks['post_change_branch_tip']:
1916
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1918
def _synchronize_history(self, destination, revision_id):
1919
"""Synchronize last revision and revision history between branches.
1921
This version is most efficient when the destination is also a
1922
BzrBranch5, but works for BzrBranch6 as long as the revision
1923
history is the true lefthand parent history, and all of the revisions
1924
are in the destination's repository. If not, set_revision_history
1927
:param destination: The branch to copy the history into
1928
:param revision_id: The revision-id to truncate history at. May
1929
be None to copy complete history.
1931
if not isinstance(destination._format, BzrBranchFormat5):
1932
super(BzrBranch, self)._synchronize_history(
1933
destination, revision_id)
1935
if revision_id == _mod_revision.NULL_REVISION:
1938
new_history = self.revision_history()
1939
if revision_id is not None and new_history != []:
1941
new_history = new_history[:new_history.index(revision_id) + 1]
1943
rev = self.repository.get_revision(revision_id)
1944
new_history = rev.get_history(self.repository)[1:]
1945
destination.set_revision_history(new_history)
1948
def set_last_revision_info(self, revno, revision_id):
1949
"""Set the last revision of this branch.
1951
The caller is responsible for checking that the revno is correct
1952
for this revision id.
1954
It may be possible to set the branch last revision to an id not
1955
present in the repository. However, branches can also be
1956
configured to check constraints on history, in which case this may not
1959
revision_id = _mod_revision.ensure_null(revision_id)
1960
# this old format stores the full history, but this api doesn't
1961
# provide it, so we must generate, and might as well check it's
1963
history = self._lefthand_history(revision_id)
1964
if len(history) != revno:
1965
raise AssertionError('%d != %d' % (len(history), revno))
1966
self.set_revision_history(history)
1968
def _gen_revision_history(self):
1969
history = self._transport.get_bytes('revision-history').split('\n')
1970
if history[-1:] == ['']:
1971
# There shouldn't be a trailing newline, but just in case.
1976
def generate_revision_history(self, revision_id, last_rev=None,
1978
"""Create a new revision history that will finish with revision_id.
1980
:param revision_id: the new tip to use.
1981
:param last_rev: The previous last_revision. If not None, then this
1982
must be a ancestory of revision_id, or DivergedBranches is raised.
1983
:param other_branch: The other branch that DivergedBranches should
1984
raise with respect to.
1986
self.set_revision_history(self._lefthand_history(revision_id,
1987
last_rev, other_branch))
1989
def basis_tree(self):
1990
"""See Branch.basis_tree."""
1991
return self.repository.revision_tree(self.last_revision())
1994
def pull(self, source, overwrite=False, stop_revision=None,
1995
_hook_master=None, run_hooks=True, possible_transports=None,
1996
_override_hook_target=None):
1999
:param _hook_master: Private parameter - set the branch to
2000
be supplied as the master to pull hooks.
2001
:param run_hooks: Private parameter - if false, this branch
2002
is being called because it's the master of the primary branch,
2003
so it should not run its hooks.
2004
:param _override_hook_target: Private parameter - set the branch to be
2005
supplied as the target_branch to pull hooks.
2007
result = PullResult()
2008
result.source_branch = source
2009
if _override_hook_target is None:
2010
result.target_branch = self
2012
result.target_branch = _override_hook_target
2015
# We assume that during 'pull' the local repository is closer than
2017
graph = self.repository.get_graph(source.repository)
2018
result.old_revno, result.old_revid = self.last_revision_info()
2019
self.update_revisions(source, stop_revision, overwrite=overwrite,
2021
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2022
result.new_revno, result.new_revid = self.last_revision_info()
2024
result.master_branch = _hook_master
2025
result.local_branch = result.target_branch
2027
result.master_branch = result.target_branch
2028
result.local_branch = None
2030
for hook in Branch.hooks['post_pull']:
2036
def _get_parent_location(self):
2037
_locs = ['parent', 'pull', 'x-pull']
2040
return self._transport.get_bytes(l).strip('\n')
2041
except errors.NoSuchFile:
2046
def push(self, target, overwrite=False, stop_revision=None,
2047
_override_hook_source_branch=None):
2050
This is the basic concrete implementation of push()
2052
:param _override_hook_source_branch: If specified, run
2053
the hooks passing this Branch as the source, rather than self.
2054
This is for use of RemoteBranch, where push is delegated to the
2055
underlying vfs-based Branch.
2057
# TODO: Public option to disable running hooks - should be trivial but
2059
return _run_with_write_locked_target(
2060
target, self._push_with_bound_branches, target, overwrite,
2062
_override_hook_source_branch=_override_hook_source_branch)
2064
def _push_with_bound_branches(self, target, overwrite,
2066
_override_hook_source_branch=None):
2067
"""Push from self into target, and into target's master if any.
2069
This is on the base BzrBranch class even though it doesn't support
2070
bound branches because the *target* might be bound.
2073
if _override_hook_source_branch:
2074
result.source_branch = _override_hook_source_branch
2075
for hook in Branch.hooks['post_push']:
2078
bound_location = target.get_bound_location()
2079
if bound_location and target.base != bound_location:
2080
# there is a master branch.
2082
# XXX: Why the second check? Is it even supported for a branch to
2083
# be bound to itself? -- mbp 20070507
2084
master_branch = target.get_master_branch()
2085
master_branch.lock_write()
2087
# push into the master from this branch.
2088
self._basic_push(master_branch, overwrite, stop_revision)
2089
# and push into the target branch from this. Note that we push from
2090
# this branch again, because its considered the highest bandwidth
2092
result = self._basic_push(target, overwrite, stop_revision)
2093
result.master_branch = master_branch
2094
result.local_branch = target
2098
master_branch.unlock()
2101
result = self._basic_push(target, overwrite, stop_revision)
2102
# TODO: Why set master_branch and local_branch if there's no
2103
# binding? Maybe cleaner to just leave them unset? -- mbp
2105
result.master_branch = target
2106
result.local_branch = None
2110
def _basic_push(self, target, overwrite, stop_revision):
2111
"""Basic implementation of push without bound branches or hooks.
2113
Must be called with self read locked and target write locked.
2115
result = PushResult()
2116
result.source_branch = self
2117
result.target_branch = target
2118
result.old_revno, result.old_revid = target.last_revision_info()
2119
if result.old_revid != self.last_revision():
2120
# We assume that during 'push' this repository is closer than
2122
graph = self.repository.get_graph(target.repository)
2123
target.update_revisions(self, stop_revision, overwrite=overwrite,
2125
if self._push_should_merge_tags():
2126
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2127
result.new_revno, result.new_revid = target.last_revision_info()
2130
def get_stacked_on_url(self):
2131
raise errors.UnstackableBranchFormat(self._format, self.base)
2133
def set_push_location(self, location):
2134
"""See Branch.set_push_location."""
2135
self.get_config().set_user_option(
2136
'push_location', location,
2137
store=_mod_config.STORE_LOCATION_NORECURSE)
2140
def set_parent(self, url):
2141
"""See Branch.set_parent."""
2142
# TODO: Maybe delete old location files?
2143
# URLs should never be unicode, even on the local fs,
2144
# FIXUP this and get_parent in a future branch format bump:
2145
# read and rewrite the file. RBC 20060125
2147
if isinstance(url, unicode):
2149
url = url.encode('ascii')
2150
except UnicodeEncodeError:
2151
raise errors.InvalidURL(url,
2152
"Urls must be 7-bit ascii, "
2153
"use bzrlib.urlutils.escape")
2154
url = urlutils.relative_url(self.base, url)
2155
self._set_parent_location(url)
2157
def _set_parent_location(self, url):
2159
self._transport.delete('parent')
2161
self._transport.put_bytes('parent', url + '\n',
2162
mode=self.bzrdir._get_file_mode())
2164
def set_stacked_on_url(self, url):
2165
raise errors.UnstackableBranchFormat(self._format, self.base)
2168
class BzrBranch5(BzrBranch):
2169
"""A format 5 branch. This supports new features over plain branches.
2171
It has support for a master_branch which is the data for bound branches.
2175
def pull(self, source, overwrite=False, stop_revision=None,
2176
run_hooks=True, possible_transports=None,
2177
_override_hook_target=None):
2178
"""Pull from source into self, updating my master if any.
2180
:param run_hooks: Private parameter - if false, this branch
2181
is being called because it's the master of the primary branch,
2182
so it should not run its hooks.
2184
bound_location = self.get_bound_location()
2185
master_branch = None
2186
if bound_location and source.base != bound_location:
2187
# not pulling from master, so we need to update master.
2188
master_branch = self.get_master_branch(possible_transports)
2189
master_branch.lock_write()
2192
# pull from source into master.
2193
master_branch.pull(source, overwrite, stop_revision,
2195
return super(BzrBranch5, self).pull(source, overwrite,
2196
stop_revision, _hook_master=master_branch,
2197
run_hooks=run_hooks,
2198
_override_hook_target=_override_hook_target)
2201
master_branch.unlock()
2203
def get_bound_location(self):
2205
return self._transport.get_bytes('bound')[:-1]
2206
except errors.NoSuchFile:
2210
def get_master_branch(self, possible_transports=None):
2211
"""Return the branch we are bound to.
2213
:return: Either a Branch, or None
2215
This could memoise the branch, but if thats done
2216
it must be revalidated on each new lock.
2217
So for now we just don't memoise it.
2218
# RBC 20060304 review this decision.
2220
bound_loc = self.get_bound_location()
2224
return Branch.open(bound_loc,
2225
possible_transports=possible_transports)
2226
except (errors.NotBranchError, errors.ConnectionError), e:
2227
raise errors.BoundBranchConnectionFailure(
2231
def set_bound_location(self, location):
2232
"""Set the target where this branch is bound to.
2234
:param location: URL to the target branch
2237
self._transport.put_bytes('bound', location+'\n',
2238
mode=self.bzrdir._get_file_mode())
2241
self._transport.delete('bound')
2242
except errors.NoSuchFile:
2247
def bind(self, other):
2248
"""Bind this branch to the branch other.
2250
This does not push or pull data between the branches, though it does
2251
check for divergence to raise an error when the branches are not
2252
either the same, or one a prefix of the other. That behaviour may not
2253
be useful, so that check may be removed in future.
2255
:param other: The branch to bind to
2258
# TODO: jam 20051230 Consider checking if the target is bound
2259
# It is debatable whether you should be able to bind to
2260
# a branch which is itself bound.
2261
# Committing is obviously forbidden,
2262
# but binding itself may not be.
2263
# Since we *have* to check at commit time, we don't
2264
# *need* to check here
2266
# we want to raise diverged if:
2267
# last_rev is not in the other_last_rev history, AND
2268
# other_last_rev is not in our history, and do it without pulling
2270
self.set_bound_location(other.base)
2274
"""If bound, unbind"""
2275
return self.set_bound_location(None)
2278
def update(self, possible_transports=None):
2279
"""Synchronise this branch with the master branch if any.
2281
:return: None or the last_revision that was pivoted out during the
2284
master = self.get_master_branch(possible_transports)
2285
if master is not None:
2286
old_tip = _mod_revision.ensure_null(self.last_revision())
2287
self.pull(master, overwrite=True)
2288
if self.repository.get_graph().is_ancestor(old_tip,
2289
_mod_revision.ensure_null(self.last_revision())):
2295
class BzrBranch7(BzrBranch5):
2296
"""A branch with support for a fallback repository."""
2298
def _get_fallback_repository(self, url):
2299
"""Get the repository we fallback to at url."""
2300
url = urlutils.join(self.base, url)
2301
a_bzrdir = bzrdir.BzrDir.open(url,
2302
possible_transports=[self._transport])
2303
return a_bzrdir.open_branch().repository
2305
def _activate_fallback_location(self, url):
2306
"""Activate the branch/repository from url as a fallback repository."""
2307
self.repository.add_fallback_repository(
2308
self._get_fallback_repository(url))
2310
def _open_hook(self):
2312
url = self.get_stacked_on_url()
2313
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2314
errors.UnstackableBranchFormat):
2317
for hook in Branch.hooks['transform_fallback_location']:
2318
url = hook(self, url)
2320
hook_name = Branch.hooks.get_hook_name(hook)
2321
raise AssertionError(
2322
"'transform_fallback_location' hook %s returned "
2323
"None, not a URL." % hook_name)
2324
self._activate_fallback_location(url)
2326
def _check_stackable_repo(self):
2327
if not self.repository._format.supports_external_lookups:
2328
raise errors.UnstackableRepositoryFormat(self.repository._format,
2329
self.repository.base)
2331
def __init__(self, *args, **kwargs):
2332
super(BzrBranch7, self).__init__(*args, **kwargs)
2333
self._last_revision_info_cache = None
2334
self._partial_revision_history_cache = []
2336
def _clear_cached_state(self):
2337
super(BzrBranch7, self)._clear_cached_state()
2338
self._last_revision_info_cache = None
2339
self._partial_revision_history_cache = []
2341
def _last_revision_info(self):
2342
revision_string = self._transport.get_bytes('last-revision')
2343
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2344
revision_id = cache_utf8.get_cached_utf8(revision_id)
2346
return revno, revision_id
2348
def _write_last_revision_info(self, revno, revision_id):
2349
"""Simply write out the revision id, with no checks.
2351
Use set_last_revision_info to perform this safely.
2353
Does not update the revision_history cache.
2354
Intended to be called by set_last_revision_info and
2355
_write_revision_history.
2357
revision_id = _mod_revision.ensure_null(revision_id)
2358
out_string = '%d %s\n' % (revno, revision_id)
2359
self._transport.put_bytes('last-revision', out_string,
2360
mode=self.bzrdir._get_file_mode())
2363
def set_last_revision_info(self, revno, revision_id):
2364
revision_id = _mod_revision.ensure_null(revision_id)
2365
old_revno, old_revid = self.last_revision_info()
2366
if self._get_append_revisions_only():
2367
self._check_history_violation(revision_id)
2368
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2369
self._write_last_revision_info(revno, revision_id)
2370
self._clear_cached_state()
2371
self._last_revision_info_cache = revno, revision_id
2372
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2374
def _synchronize_history(self, destination, revision_id):
2375
"""Synchronize last revision and revision history between branches.
2377
:see: Branch._synchronize_history
2379
# XXX: The base Branch has a fast implementation of this method based
2380
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2381
# that uses set_revision_history. This class inherits from BzrBranch5,
2382
# but wants the fast implementation, so it calls
2383
# Branch._synchronize_history directly.
2384
Branch._synchronize_history(self, destination, revision_id)
2386
def _check_history_violation(self, revision_id):
2387
last_revision = _mod_revision.ensure_null(self.last_revision())
2388
if _mod_revision.is_null(last_revision):
2390
if last_revision not in self._lefthand_history(revision_id):
2391
raise errors.AppendRevisionsOnlyViolation(self.base)
2393
def _gen_revision_history(self):
2394
"""Generate the revision history from last revision
2396
last_revno, last_revision = self.last_revision_info()
2397
self._extend_partial_history(stop_index=last_revno-1)
2398
return list(reversed(self._partial_revision_history_cache))
2400
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2401
"""Extend the partial history to include a given index
2403
If a stop_index is supplied, stop when that index has been reached.
2404
If a stop_revision is supplied, stop when that revision is
2405
encountered. Otherwise, stop when the beginning of history is
2408
:param stop_index: The index which should be present. When it is
2409
present, history extension will stop.
2410
:param revision_id: The revision id which should be present. When
2411
it is encountered, history extension will stop.
2413
repo = self.repository
2414
if len(self._partial_revision_history_cache) == 0:
2415
iterator = repo.iter_reverse_revision_history(self.last_revision())
2417
start_revision = self._partial_revision_history_cache[-1]
2418
iterator = repo.iter_reverse_revision_history(start_revision)
2419
#skip the last revision in the list
2420
next_revision = iterator.next()
2421
for revision_id in iterator:
2422
self._partial_revision_history_cache.append(revision_id)
2423
if (stop_index is not None and
2424
len(self._partial_revision_history_cache) > stop_index):
2426
if revision_id == stop_revision:
2429
def _write_revision_history(self, history):
2430
"""Factored out of set_revision_history.
2432
This performs the actual writing to disk, with format-specific checks.
2433
It is intended to be called by BzrBranch5.set_revision_history.
2435
if len(history) == 0:
2436
last_revision = 'null:'
2438
if history != self._lefthand_history(history[-1]):
2439
raise errors.NotLefthandHistory(history)
2440
last_revision = history[-1]
2441
if self._get_append_revisions_only():
2442
self._check_history_violation(last_revision)
2443
self._write_last_revision_info(len(history), last_revision)
2446
def _set_parent_location(self, url):
2447
"""Set the parent branch"""
2448
self._set_config_location('parent_location', url, make_relative=True)
2451
def _get_parent_location(self):
2452
"""Set the parent branch"""
2453
return self._get_config_location('parent_location')
2455
def set_push_location(self, location):
2456
"""See Branch.set_push_location."""
2457
self._set_config_location('push_location', location)
2459
def set_bound_location(self, location):
2460
"""See Branch.set_push_location."""
2462
config = self.get_config()
2463
if location is None:
2464
if config.get_user_option('bound') != 'True':
2467
config.set_user_option('bound', 'False', warn_masked=True)
2470
self._set_config_location('bound_location', location,
2472
config.set_user_option('bound', 'True', warn_masked=True)
2475
def _get_bound_location(self, bound):
2476
"""Return the bound location in the config file.
2478
Return None if the bound parameter does not match"""
2479
config = self.get_config()
2480
config_bound = (config.get_user_option('bound') == 'True')
2481
if config_bound != bound:
2483
return self._get_config_location('bound_location', config=config)
2485
def get_bound_location(self):
2486
"""See Branch.set_push_location."""
2487
return self._get_bound_location(True)
2489
def get_old_bound_location(self):
2490
"""See Branch.get_old_bound_location"""
2491
return self._get_bound_location(False)
2493
def get_stacked_on_url(self):
2494
# you can always ask for the URL; but you might not be able to use it
2495
# if the repo can't support stacking.
2496
## self._check_stackable_repo()
2497
stacked_url = self._get_config_location('stacked_on_location')
2498
if stacked_url is None:
2499
raise errors.NotStacked(self)
2502
def set_append_revisions_only(self, enabled):
2507
self.get_config().set_user_option('append_revisions_only', value,
2510
def set_stacked_on_url(self, url):
2511
self._check_stackable_repo()
2514
old_url = self.get_stacked_on_url()
2515
except (errors.NotStacked, errors.UnstackableBranchFormat,
2516
errors.UnstackableRepositoryFormat):
2519
# repositories don't offer an interface to remove fallback
2520
# repositories today; take the conceptually simpler option and just
2522
self.repository = self.bzrdir.find_repository()
2523
# for every revision reference the branch has, ensure it is pulled
2525
source_repository = self._get_fallback_repository(old_url)
2526
for revision_id in chain([self.last_revision()],
2527
self.tags.get_reverse_tag_dict()):
2528
self.repository.fetch(source_repository, revision_id,
2531
self._activate_fallback_location(url)
2532
# write this out after the repository is stacked to avoid setting a
2533
# stacked config that doesn't work.
2534
self._set_config_location('stacked_on_location', url)
2536
def _get_append_revisions_only(self):
2537
value = self.get_config().get_user_option('append_revisions_only')
2538
return value == 'True'
2541
def generate_revision_history(self, revision_id, last_rev=None,
2543
"""See BzrBranch5.generate_revision_history"""
2544
history = self._lefthand_history(revision_id, last_rev, other_branch)
2545
revno = len(history)
2546
self.set_last_revision_info(revno, revision_id)
2549
def get_rev_id(self, revno, history=None):
2550
"""Find the revision id of the specified revno."""
2552
return _mod_revision.NULL_REVISION
2554
last_revno, last_revision_id = self.last_revision_info()
2555
if revno <= 0 or revno > last_revno:
2556
raise errors.NoSuchRevision(self, revno)
2558
if history is not None:
2559
return history[revno - 1]
2561
index = last_revno - revno
2562
if len(self._partial_revision_history_cache) <= index:
2563
self._extend_partial_history(stop_index=index)
2564
if len(self._partial_revision_history_cache) > index:
2565
return self._partial_revision_history_cache[index]
2567
raise errors.NoSuchRevision(self, revno)
2570
def revision_id_to_revno(self, revision_id):
2571
"""Given a revision id, return its revno"""
2572
if _mod_revision.is_null(revision_id):
2575
index = self._partial_revision_history_cache.index(revision_id)
2577
self._extend_partial_history(stop_revision=revision_id)
2578
index = len(self._partial_revision_history_cache) - 1
2579
if self._partial_revision_history_cache[index] != revision_id:
2580
raise errors.NoSuchRevision(self, revision_id)
2581
return self.revno() - index
2584
class BzrBranch6(BzrBranch7):
2585
"""See BzrBranchFormat6 for the capabilities of this branch.
2587
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2591
def get_stacked_on_url(self):
2592
raise errors.UnstackableBranchFormat(self._format, self.base)
2594
def set_stacked_on_url(self, url):
2595
raise errors.UnstackableBranchFormat(self._format, self.base)
2598
######################################################################
2599
# results of operations
2602
class _Result(object):
2604
def _show_tag_conficts(self, to_file):
2605
if not getattr(self, 'tag_conflicts', None):
2607
to_file.write('Conflicting tags:\n')
2608
for name, value1, value2 in self.tag_conflicts:
2609
to_file.write(' %s\n' % (name, ))
2612
class PullResult(_Result):
2613
"""Result of a Branch.pull operation.
2615
:ivar old_revno: Revision number before pull.
2616
:ivar new_revno: Revision number after pull.
2617
:ivar old_revid: Tip revision id before pull.
2618
:ivar new_revid: Tip revision id after pull.
2619
:ivar source_branch: Source (local) branch object. (read locked)
2620
:ivar master_branch: Master branch of the target, or the target if no
2622
:ivar local_branch: target branch if there is a Master, else None
2623
:ivar target_branch: Target/destination branch object. (write locked)
2624
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2628
# DEPRECATED: pull used to return the change in revno
2629
return self.new_revno - self.old_revno
2631
def report(self, to_file):
2633
if self.old_revid == self.new_revid:
2634
to_file.write('No revisions to pull.\n')
2636
to_file.write('Now on revision %d.\n' % self.new_revno)
2637
self._show_tag_conficts(to_file)
2640
class PushResult(_Result):
2641
"""Result of a Branch.push operation.
2643
:ivar old_revno: Revision number (eg 10) of the target before push.
2644
:ivar new_revno: Revision number (eg 12) of the target after push.
2645
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2647
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2649
:ivar source_branch: Source branch object that the push was from. This is
2650
read locked, and generally is a local (and thus low latency) branch.
2651
:ivar master_branch: If target is a bound branch, the master branch of
2652
target, or target itself. Always write locked.
2653
:ivar target_branch: The direct Branch where data is being sent (write
2655
:ivar local_branch: If the target is a bound branch this will be the
2656
target, otherwise it will be None.
2660
# DEPRECATED: push used to return the change in revno
2661
return self.new_revno - self.old_revno
2663
def report(self, to_file):
2664
"""Write a human-readable description of the result."""
2665
if self.old_revid == self.new_revid:
2666
note('No new revisions to push.')
2668
note('Pushed up to revision %d.' % self.new_revno)
2669
self._show_tag_conficts(to_file)
2672
class BranchCheckResult(object):
2673
"""Results of checking branch consistency.
2678
def __init__(self, branch):
2679
self.branch = branch
2681
def report_results(self, verbose):
2682
"""Report the check results via trace.note.
2684
:param verbose: Requests more detailed display of what was checked,
2687
note('checked branch %s format %s',
2689
self.branch._format)
2692
class Converter5to6(object):
2693
"""Perform an in-place upgrade of format 5 to format 6"""
2695
def convert(self, branch):
2696
# Data for 5 and 6 can peacefully coexist.
2697
format = BzrBranchFormat6()
2698
new_branch = format.open(branch.bzrdir, _found=True)
2700
# Copy source data into target
2701
new_branch._write_last_revision_info(*branch.last_revision_info())
2702
new_branch.set_parent(branch.get_parent())
2703
new_branch.set_bound_location(branch.get_bound_location())
2704
new_branch.set_push_location(branch.get_push_location())
2706
# New branch has no tags by default
2707
new_branch.tags._set_tag_dict({})
2709
# Copying done; now update target format
2710
new_branch._transport.put_bytes('format',
2711
format.get_format_string(),
2712
mode=new_branch.bzrdir._get_file_mode())
2714
# Clean up old files
2715
new_branch._transport.delete('revision-history')
2717
branch.set_parent(None)
2718
except errors.NoSuchFile:
2720
branch.set_bound_location(None)
2723
class Converter6to7(object):
2724
"""Perform an in-place upgrade of format 6 to format 7"""
2726
def convert(self, branch):
2727
format = BzrBranchFormat7()
2728
branch._set_config_location('stacked_on_location', '')
2729
# update target format
2730
branch._transport.put_bytes('format', format.get_format_string())
2734
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2735
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2738
_run_with_write_locked_target will attempt to release the lock it acquires.
2740
If an exception is raised by callable, then that exception *will* be
2741
propagated, even if the unlock attempt raises its own error. Thus
2742
_run_with_write_locked_target should be preferred to simply doing::
2746
return callable(*args, **kwargs)
2751
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2752
# should share code?
2755
result = callable(*args, **kwargs)
2757
exc_info = sys.exc_info()
2761
raise exc_info[0], exc_info[1], exc_info[2]
2767
class InterBranch(InterObject):
2768
"""This class represents operations taking place between two branches.
2770
Its instances have methods like pull() and push() and contain
2771
references to the source and target repositories these operations
2772
can be carried out on.
2776
"""The available optimised InterBranch types."""
2779
def _get_branch_formats_to_test():
2780
"""Return a tuple with the Branch formats to use when testing."""
2781
raise NotImplementedError(self._get_branch_formats_to_test)
2783
def update_revisions(self, stop_revision=None, overwrite=False,
2785
"""Pull in new perfect-fit revisions.
2787
:param stop_revision: Updated until the given revision
2788
:param overwrite: Always set the branch pointer, rather than checking
2789
to see if it is a proper descendant.
2790
:param graph: A Graph object that can be used to query history
2791
information. This can be None.
2794
raise NotImplementedError(self.update_revisions)
2797
class GenericInterBranch(InterBranch):
2798
"""InterBranch implementation that uses public Branch functions.
2802
def _get_branch_formats_to_test():
2803
return BranchFormat._default_format, BranchFormat._default_format
2805
def update_revisions(self, stop_revision=None, overwrite=False,
2807
"""See InterBranch.update_revisions()."""
2808
self.source.lock_read()
2810
other_revno, other_last_revision = self.source.last_revision_info()
2811
stop_revno = None # unknown
2812
if stop_revision is None:
2813
stop_revision = other_last_revision
2814
if _mod_revision.is_null(stop_revision):
2815
# if there are no commits, we're done.
2817
stop_revno = other_revno
2819
# what's the current last revision, before we fetch [and change it
2821
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2822
# we fetch here so that we don't process data twice in the common
2823
# case of having something to pull, and so that the check for
2824
# already merged can operate on the just fetched graph, which will
2825
# be cached in memory.
2826
self.target.fetch(self.source, stop_revision)
2827
# Check to see if one is an ancestor of the other
2830
graph = self.target.repository.get_graph()
2831
if self.target._check_if_descendant_or_diverged(
2832
stop_revision, last_rev, graph, self.source):
2833
# stop_revision is a descendant of last_rev, but we aren't
2834
# overwriting, so we're done.
2836
if stop_revno is None:
2838
graph = self.target.repository.get_graph()
2839
this_revno, this_last_revision = \
2840
self.target.last_revision_info()
2841
stop_revno = graph.find_distance_to_null(stop_revision,
2842
[(other_last_revision, other_revno),
2843
(this_last_revision, this_revno)])
2844
self.target.set_last_revision_info(stop_revno, stop_revision)
2846
self.source.unlock()
2849
def is_compatible(self, source, target):
2850
# GenericBranch uses the public API, so always compatible
2854
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
