13
13
# You should have received a copy of the GNU General Public License
14
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
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
18
from cStringIO import StringIO
20
21
from bzrlib.lazy_import import lazy_import
21
22
lazy_import(globals(), """
22
from copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
23
from itertools import chain
27
24
from bzrlib import (
30
27
config as _mod_config,
35
34
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
42
from bzrlib.config import BranchConfig, TransportConfig
43
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
44
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
51
HistoryMissing, InvalidRevisionId,
52
InvalidRevisionNumber, LockError, NoSuchFile,
53
NoSuchRevision, NoWorkingTree, NotVersionedError,
54
NotBranchError, UninitializableFormat,
55
UnlistableStore, UnlistableBranch,
57
from bzrlib.hooks import Hooks
58
from bzrlib.symbol_versioning import (deprecated_function,
62
zero_eight, zero_nine, zero_sixteen,
64
from bzrlib.trace import mutter, note
50
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
51
from bzrlib.hooks import HookPoint, Hooks
52
from bzrlib.inter import InterObject
53
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
54
from bzrlib import registry
55
from bzrlib.symbol_versioning import (
59
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
67
62
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
115
122
if master is not None:
116
123
master.break_lock()
119
@deprecated_method(zero_eight)
120
def open_downlevel(base):
121
"""Open a branch which may be of an old format."""
122
return Branch.open(base, _unsupported=True)
125
def open(base, _unsupported=False):
125
def _check_stackable_repo(self):
126
if not self.repository._format.supports_external_lookups:
127
raise errors.UnstackableRepositoryFormat(self.repository._format,
128
self.repository.base)
130
def _extend_partial_history(self, stop_index=None, stop_revision=None):
131
"""Extend the partial history to include a given index
133
If a stop_index is supplied, stop when that index has been reached.
134
If a stop_revision is supplied, stop when that revision is
135
encountered. Otherwise, stop when the beginning of history is
138
:param stop_index: The index which should be present. When it is
139
present, history extension will stop.
140
:param stop_revision: The revision id which should be present. When
141
it is encountered, history extension will stop.
143
if len(self._partial_revision_history_cache) == 0:
144
self._partial_revision_history_cache = [self.last_revision()]
145
repository._iter_for_revno(
146
self.repository, self._partial_revision_history_cache,
147
stop_index=stop_index, stop_revision=stop_revision)
148
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
149
self._partial_revision_history_cache.pop()
151
def _get_check_refs(self):
152
"""Get the references needed for check().
156
revid = self.last_revision()
157
return [('revision-existence', revid), ('lefthand-distance', revid)]
160
def open(base, _unsupported=False, possible_transports=None):
126
161
"""Open the branch rooted at base.
128
163
For instance, if the branch is at URL/.bzr/branch,
129
164
Branch.open(URL) -> a Branch instance.
131
control = bzrdir.BzrDir.open(base, _unsupported)
132
return control.open_branch(_unsupported)
135
def open_containing(url):
166
control = bzrdir.BzrDir.open(base, _unsupported,
167
possible_transports=possible_transports)
168
return control.open_branch(unsupported=_unsupported)
171
def open_from_transport(transport, name=None, _unsupported=False):
172
"""Open the branch rooted at transport"""
173
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
174
return control.open_branch(name=name, unsupported=_unsupported)
177
def open_containing(url, possible_transports=None):
136
178
"""Open an existing branch which contains url.
138
180
This probes for a branch at url, and searches upwards from there.
140
182
Basically we keep looking up until we find the control directory or
141
183
run into the root. If there isn't one, raises NotBranchError.
142
If there is one and it is either an unrecognised format or an unsupported
184
If there is one and it is either an unrecognised format or an unsupported
143
185
format, UnknownFormatError or UnsupportedFormatError are raised.
144
186
If there is one, it is returned, along with the unused portion of url.
146
control, relpath = bzrdir.BzrDir.open_containing(url)
188
control, relpath = bzrdir.BzrDir.open_containing(url,
147
190
return control.open_branch(), relpath
150
@deprecated_function(zero_eight)
151
def initialize(base):
152
"""Create a new working tree and branch, rooted at 'base' (url)
154
NOTE: This will soon be deprecated in favour of creation
157
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
159
@deprecated_function(zero_eight)
160
def setup_caching(self, cache_root):
161
"""Subclasses that care about caching should override this, and set
162
up cached stores located under cache_root.
164
NOTE: This is unused.
192
def _push_should_merge_tags(self):
193
"""Should _basic_push merge this branch's tags into the target?
195
The default implementation returns False if this branch has no tags,
196
and True the rest of the time. Subclasses may override this.
198
return self.supports_tags() and self.tags.get_tag_dict()
168
200
def get_config(self):
201
"""Get a bzrlib.config.BranchConfig for this Branch.
203
This can then be used to get and set configuration options for the
206
:return: A bzrlib.config.BranchConfig.
169
208
return BranchConfig(self)
172
return self.get_config().get_nickname()
210
def _get_config(self):
211
"""Get the concrete config for just the config in this branch.
213
This is not intended for client use; see Branch.get_config for the
218
:return: An object supporting get_option and set_option.
220
raise NotImplementedError(self._get_config)
222
def _get_fallback_repository(self, url):
223
"""Get the repository we fallback to at url."""
224
url = urlutils.join(self.base, url)
225
a_branch = Branch.open(url,
226
possible_transports=[self.bzrdir.root_transport])
227
return a_branch.repository
229
def _get_tags_bytes(self):
230
"""Get the bytes of a serialised tags dict.
232
Note that not all branches support tags, nor do all use the same tags
233
logic: this method is specific to BasicTags. Other tag implementations
234
may use the same method name and behave differently, safely, because
235
of the double-dispatch via
236
format.make_tags->tags_instance->get_tags_dict.
238
:return: The bytes of the tags file.
239
:seealso: Branch._set_tags_bytes.
241
return self._transport.get_bytes('tags')
243
def _get_nick(self, local=False, possible_transports=None):
244
config = self.get_config()
245
# explicit overrides master, but don't look for master if local is True
246
if not local and not config.has_explicit_nickname():
248
master = self.get_master_branch(possible_transports)
249
if master is not None:
250
# return the master branch value
252
except errors.BzrError, e:
253
# Silently fall back to local implicit nick if the master is
255
mutter("Could not connect to bound branch, "
256
"falling back to local nick.\n " + str(e))
257
return config.get_nickname()
174
259
def _set_nick(self, nick):
175
self.get_config().set_user_option('nickname', nick)
260
self.get_config().set_user_option('nickname', nick, warn_masked=True)
177
262
nick = property(_get_nick, _set_nick)
179
264
def is_locked(self):
180
265
raise NotImplementedError(self.is_locked)
182
def lock_write(self):
267
def _lefthand_history(self, revision_id, last_rev=None,
269
if 'evil' in debug.debug_flags:
270
mutter_callsite(4, "_lefthand_history scales with history.")
271
# stop_revision must be a descendant of last_revision
272
graph = self.repository.get_graph()
273
if last_rev is not None:
274
if not graph.is_ancestor(last_rev, revision_id):
275
# our previous tip is not merged into stop_revision
276
raise errors.DivergedBranches(self, other_branch)
277
# make a new revision history from the graph
278
parents_map = graph.get_parent_map([revision_id])
279
if revision_id not in parents_map:
280
raise errors.NoSuchRevision(self, revision_id)
281
current_rev_id = revision_id
283
check_not_reserved_id = _mod_revision.check_not_reserved_id
284
# Do not include ghosts or graph origin in revision_history
285
while (current_rev_id in parents_map and
286
len(parents_map[current_rev_id]) > 0):
287
check_not_reserved_id(current_rev_id)
288
new_history.append(current_rev_id)
289
current_rev_id = parents_map[current_rev_id][0]
290
parents_map = graph.get_parent_map([current_rev_id])
291
new_history.reverse()
294
def lock_write(self, token=None):
295
"""Lock the branch for write operations.
297
:param token: A token to permit reacquiring a previously held and
299
:return: A BranchWriteLockResult.
183
301
raise NotImplementedError(self.lock_write)
185
303
def lock_read(self):
304
"""Lock the branch for read operations.
306
:return: A bzrlib.lock.LogicalLockResult.
186
308
raise NotImplementedError(self.lock_read)
188
310
def unlock(self):
195
317
def get_physical_lock_status(self):
196
318
raise NotImplementedError(self.get_physical_lock_status)
198
def abspath(self, name):
199
"""Return absolute filename for something in the branch
201
XXX: Robert Collins 20051017 what is this used for? why is it a branch
202
method and not a tree method.
204
raise NotImplementedError(self.abspath)
321
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
322
"""Return the revision_id for a dotted revno.
324
:param revno: a tuple like (1,) or (1,1,2)
325
:param _cache_reverse: a private parameter enabling storage
326
of the reverse mapping in a top level cache. (This should
327
only be done in selective circumstances as we want to
328
avoid having the mapping cached multiple times.)
329
:return: the revision_id
330
:raises errors.NoSuchRevision: if the revno doesn't exist
332
rev_id = self._do_dotted_revno_to_revision_id(revno)
334
self._partial_revision_id_to_revno_cache[rev_id] = revno
337
def _do_dotted_revno_to_revision_id(self, revno):
338
"""Worker function for dotted_revno_to_revision_id.
340
Subclasses should override this if they wish to
341
provide a more efficient implementation.
344
return self.get_rev_id(revno[0])
345
revision_id_to_revno = self.get_revision_id_to_revno_map()
346
revision_ids = [revision_id for revision_id, this_revno
347
in revision_id_to_revno.iteritems()
348
if revno == this_revno]
349
if len(revision_ids) == 1:
350
return revision_ids[0]
352
revno_str = '.'.join(map(str, revno))
353
raise errors.NoSuchRevision(self, revno_str)
356
def revision_id_to_dotted_revno(self, revision_id):
357
"""Given a revision id, return its dotted revno.
359
:return: a tuple like (1,) or (400,1,3).
361
return self._do_revision_id_to_dotted_revno(revision_id)
363
def _do_revision_id_to_dotted_revno(self, revision_id):
364
"""Worker function for revision_id_to_revno."""
365
# Try the caches if they are loaded
366
result = self._partial_revision_id_to_revno_cache.get(revision_id)
367
if result is not None:
369
if self._revision_id_to_revno_cache:
370
result = self._revision_id_to_revno_cache.get(revision_id)
372
raise errors.NoSuchRevision(self, revision_id)
373
# Try the mainline as it's optimised
375
revno = self.revision_id_to_revno(revision_id)
377
except errors.NoSuchRevision:
378
# We need to load and use the full revno map after all
379
result = self.get_revision_id_to_revno_map().get(revision_id)
381
raise errors.NoSuchRevision(self, revision_id)
385
def get_revision_id_to_revno_map(self):
386
"""Return the revision_id => dotted revno map.
388
This will be regenerated on demand, but will be cached.
390
:return: A dictionary mapping revision_id => dotted revno.
391
This dictionary should not be modified by the caller.
393
if self._revision_id_to_revno_cache is not None:
394
mapping = self._revision_id_to_revno_cache
396
mapping = self._gen_revno_map()
397
self._cache_revision_id_to_revno(mapping)
398
# TODO: jam 20070417 Since this is being cached, should we be returning
400
# I would rather not, and instead just declare that users should not
401
# modify the return value.
404
def _gen_revno_map(self):
405
"""Create a new mapping from revision ids to dotted revnos.
407
Dotted revnos are generated based on the current tip in the revision
409
This is the worker function for get_revision_id_to_revno_map, which
410
just caches the return value.
412
:return: A dictionary mapping revision_id => dotted revno.
414
revision_id_to_revno = dict((rev_id, revno)
415
for rev_id, depth, revno, end_of_merge
416
in self.iter_merge_sorted_revisions())
417
return revision_id_to_revno
420
def iter_merge_sorted_revisions(self, start_revision_id=None,
421
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
422
"""Walk the revisions for a branch in merge sorted order.
424
Merge sorted order is the output from a merge-aware,
425
topological sort, i.e. all parents come before their
426
children going forward; the opposite for reverse.
428
:param start_revision_id: the revision_id to begin walking from.
429
If None, the branch tip is used.
430
:param stop_revision_id: the revision_id to terminate the walk
431
after. If None, the rest of history is included.
432
:param stop_rule: if stop_revision_id is not None, the precise rule
433
to use for termination:
434
* 'exclude' - leave the stop revision out of the result (default)
435
* 'include' - the stop revision is the last item in the result
436
* 'with-merges' - include the stop revision and all of its
437
merged revisions in the result
438
* 'with-merges-without-common-ancestry' - filter out revisions
439
that are in both ancestries
440
:param direction: either 'reverse' or 'forward':
441
* reverse means return the start_revision_id first, i.e.
442
start at the most recent revision and go backwards in history
443
* forward returns tuples in the opposite order to reverse.
444
Note in particular that forward does *not* do any intelligent
445
ordering w.r.t. depth as some clients of this API may like.
446
(If required, that ought to be done at higher layers.)
448
:return: an iterator over (revision_id, depth, revno, end_of_merge)
451
* revision_id: the unique id of the revision
452
* depth: How many levels of merging deep this node has been
454
* revno_sequence: This field provides a sequence of
455
revision numbers for all revisions. The format is:
456
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
457
branch that the revno is on. From left to right the REVNO numbers
458
are the sequence numbers within that branch of the revision.
459
* end_of_merge: When True the next node (earlier in history) is
460
part of a different merge.
462
# Note: depth and revno values are in the context of the branch so
463
# we need the full graph to get stable numbers, regardless of the
465
if self._merge_sorted_revisions_cache is None:
466
last_revision = self.last_revision()
467
known_graph = self.repository.get_known_graph_ancestry(
469
self._merge_sorted_revisions_cache = known_graph.merge_sort(
471
filtered = self._filter_merge_sorted_revisions(
472
self._merge_sorted_revisions_cache, start_revision_id,
473
stop_revision_id, stop_rule)
474
# Make sure we don't return revisions that are not part of the
475
# start_revision_id ancestry.
476
filtered = self._filter_start_non_ancestors(filtered)
477
if direction == 'reverse':
479
if direction == 'forward':
480
return reversed(list(filtered))
482
raise ValueError('invalid direction %r' % direction)
484
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
485
start_revision_id, stop_revision_id, stop_rule):
486
"""Iterate over an inclusive range of sorted revisions."""
487
rev_iter = iter(merge_sorted_revisions)
488
if start_revision_id is not None:
489
for node in rev_iter:
490
rev_id = node.key[-1]
491
if rev_id != start_revision_id:
494
# The decision to include the start or not
495
# depends on the stop_rule if a stop is provided
496
# so pop this node back into the iterator
497
rev_iter = chain(iter([node]), rev_iter)
499
if stop_revision_id is None:
501
for node in rev_iter:
502
rev_id = node.key[-1]
503
yield (rev_id, node.merge_depth, node.revno,
505
elif stop_rule == 'exclude':
506
for node in rev_iter:
507
rev_id = node.key[-1]
508
if rev_id == stop_revision_id:
510
yield (rev_id, node.merge_depth, node.revno,
512
elif stop_rule == 'include':
513
for node in rev_iter:
514
rev_id = node.key[-1]
515
yield (rev_id, node.merge_depth, node.revno,
517
if rev_id == stop_revision_id:
519
elif stop_rule == 'with-merges-without-common-ancestry':
520
# We want to exclude all revisions that are already part of the
521
# stop_revision_id ancestry.
522
graph = self.repository.get_graph()
523
ancestors = graph.find_unique_ancestors(start_revision_id,
525
for node in rev_iter:
526
rev_id = node.key[-1]
527
if rev_id not in ancestors:
529
yield (rev_id, node.merge_depth, node.revno,
531
elif stop_rule == 'with-merges':
532
stop_rev = self.repository.get_revision(stop_revision_id)
533
if stop_rev.parent_ids:
534
left_parent = stop_rev.parent_ids[0]
536
left_parent = _mod_revision.NULL_REVISION
537
# left_parent is the actual revision we want to stop logging at,
538
# since we want to show the merged revisions after the stop_rev too
539
reached_stop_revision_id = False
540
revision_id_whitelist = []
541
for node in rev_iter:
542
rev_id = node.key[-1]
543
if rev_id == left_parent:
544
# reached the left parent after the stop_revision
546
if (not reached_stop_revision_id or
547
rev_id in revision_id_whitelist):
548
yield (rev_id, node.merge_depth, node.revno,
550
if reached_stop_revision_id or rev_id == stop_revision_id:
551
# only do the merged revs of rev_id from now on
552
rev = self.repository.get_revision(rev_id)
554
reached_stop_revision_id = True
555
revision_id_whitelist.extend(rev.parent_ids)
557
raise ValueError('invalid stop_rule %r' % stop_rule)
559
def _filter_start_non_ancestors(self, rev_iter):
560
# If we started from a dotted revno, we want to consider it as a tip
561
# and don't want to yield revisions that are not part of its
562
# ancestry. Given the order guaranteed by the merge sort, we will see
563
# uninteresting descendants of the first parent of our tip before the
565
first = rev_iter.next()
566
(rev_id, merge_depth, revno, end_of_merge) = first
569
# We start at a mainline revision so by definition, all others
570
# revisions in rev_iter are ancestors
571
for node in rev_iter:
576
pmap = self.repository.get_parent_map([rev_id])
577
parents = pmap.get(rev_id, [])
579
whitelist.update(parents)
581
# If there is no parents, there is nothing of interest left
583
# FIXME: It's hard to test this scenario here as this code is never
584
# called in that case. -- vila 20100322
587
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
589
if rev_id in whitelist:
590
pmap = self.repository.get_parent_map([rev_id])
591
parents = pmap.get(rev_id, [])
592
whitelist.remove(rev_id)
593
whitelist.update(parents)
595
# We've reached the mainline, there is nothing left to
599
# A revision that is not part of the ancestry of our
602
yield (rev_id, merge_depth, revno, end_of_merge)
604
def leave_lock_in_place(self):
605
"""Tell this branch object not to release the physical lock when this
608
If lock_write doesn't return a token, then this method is not supported.
610
self.control_files.leave_in_place()
612
def dont_leave_lock_in_place(self):
613
"""Tell this branch object to release the physical lock when this
614
object is unlocked, even if it didn't originally acquire it.
616
If lock_write doesn't return a token, then this method is not supported.
618
self.control_files.dont_leave_in_place()
206
620
def bind(self, other):
207
621
"""Bind the local branch the other branch.
292
716
The delta is relative to its mainline predecessor, or the
293
717
empty tree for revision 1.
295
assert isinstance(revno, int)
296
719
rh = self.revision_history()
297
720
if not (1 <= revno <= len(rh)):
298
raise InvalidRevisionNumber(revno)
721
raise errors.InvalidRevisionNumber(revno)
299
722
return self.repository.get_revision_delta(rh[revno-1])
301
@deprecated_method(zero_sixteen)
302
def get_root_id(self):
303
"""Return the id of this branches root
724
def get_stacked_on_url(self):
725
"""Get the URL this branch is stacked against.
305
Deprecated: branches don't have root ids-- trees do.
306
Use basis_tree().get_root_id() instead.
727
:raises NotStacked: If the branch is not stacked.
728
:raises UnstackableBranchFormat: If the branch does not support
308
raise NotImplementedError(self.get_root_id)
731
raise NotImplementedError(self.get_stacked_on_url)
310
733
def print_file(self, file, revision_id):
311
734
"""Print `file` to stdout."""
312
735
raise NotImplementedError(self.print_file)
314
def append_revision(self, *revision_ids):
315
raise NotImplementedError(self.append_revision)
317
737
def set_revision_history(self, rev_history):
318
738
raise NotImplementedError(self.set_revision_history)
741
def set_parent(self, url):
742
"""See Branch.set_parent."""
743
# TODO: Maybe delete old location files?
744
# URLs should never be unicode, even on the local fs,
745
# FIXUP this and get_parent in a future branch format bump:
746
# read and rewrite the file. RBC 20060125
748
if isinstance(url, unicode):
750
url = url.encode('ascii')
751
except UnicodeEncodeError:
752
raise errors.InvalidURL(url,
753
"Urls must be 7-bit ascii, "
754
"use bzrlib.urlutils.escape")
755
url = urlutils.relative_url(self.base, url)
756
self._set_parent_location(url)
759
def set_stacked_on_url(self, url):
760
"""Set the URL this branch is stacked against.
762
:raises UnstackableBranchFormat: If the branch does not support
764
:raises UnstackableRepositoryFormat: If the repository does not support
767
if not self._format.supports_stacking():
768
raise errors.UnstackableBranchFormat(self._format, self.user_url)
769
# XXX: Changing from one fallback repository to another does not check
770
# that all the data you need is present in the new fallback.
771
# Possibly it should.
772
self._check_stackable_repo()
775
old_url = self.get_stacked_on_url()
776
except (errors.NotStacked, errors.UnstackableBranchFormat,
777
errors.UnstackableRepositoryFormat):
781
self._activate_fallback_location(url)
782
# write this out after the repository is stacked to avoid setting a
783
# stacked config that doesn't work.
784
self._set_config_location('stacked_on_location', url)
787
"""Change a branch to be unstacked, copying data as needed.
789
Don't call this directly, use set_stacked_on_url(None).
791
pb = ui.ui_factory.nested_progress_bar()
793
pb.update("Unstacking")
794
# The basic approach here is to fetch the tip of the branch,
795
# including all available ghosts, from the existing stacked
796
# repository into a new repository object without the fallbacks.
798
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
799
# correct for CHKMap repostiories
800
old_repository = self.repository
801
if len(old_repository._fallback_repositories) != 1:
802
raise AssertionError("can't cope with fallback repositories "
803
"of %r" % (self.repository,))
804
# Open the new repository object.
805
# Repositories don't offer an interface to remove fallback
806
# repositories today; take the conceptually simpler option and just
807
# reopen it. We reopen it starting from the URL so that we
808
# get a separate connection for RemoteRepositories and can
809
# stream from one of them to the other. This does mean doing
810
# separate SSH connection setup, but unstacking is not a
811
# common operation so it's tolerable.
812
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
813
new_repository = new_bzrdir.find_repository()
814
if new_repository._fallback_repositories:
815
raise AssertionError("didn't expect %r to have "
816
"fallback_repositories"
817
% (self.repository,))
818
# Replace self.repository with the new repository.
819
# Do our best to transfer the lock state (i.e. lock-tokens and
820
# lock count) of self.repository to the new repository.
821
lock_token = old_repository.lock_write().repository_token
822
self.repository = new_repository
823
if isinstance(self, remote.RemoteBranch):
824
# Remote branches can have a second reference to the old
825
# repository that need to be replaced.
826
if self._real_branch is not None:
827
self._real_branch.repository = new_repository
828
self.repository.lock_write(token=lock_token)
829
if lock_token is not None:
830
old_repository.leave_lock_in_place()
831
old_repository.unlock()
832
if lock_token is not None:
833
# XXX: self.repository.leave_lock_in_place() before this
834
# function will not be preserved. Fortunately that doesn't
835
# affect the current default format (2a), and would be a
836
# corner-case anyway.
837
# - Andrew Bennetts, 2010/06/30
838
self.repository.dont_leave_lock_in_place()
842
old_repository.unlock()
843
except errors.LockNotHeld:
846
if old_lock_count == 0:
847
raise AssertionError(
848
'old_repository should have been locked at least once.')
849
for i in range(old_lock_count-1):
850
self.repository.lock_write()
851
# Fetch from the old repository into the new.
852
old_repository.lock_read()
854
# XXX: If you unstack a branch while it has a working tree
855
# with a pending merge, the pending-merged revisions will no
856
# longer be present. You can (probably) revert and remerge.
858
# XXX: This only fetches up to the tip of the repository; it
859
# doesn't bring across any tags. That's fairly consistent
860
# with how branch works, but perhaps not ideal.
861
self.repository.fetch(old_repository,
862
revision_id=self.last_revision(),
865
old_repository.unlock()
869
def _set_tags_bytes(self, bytes):
870
"""Mirror method for _get_tags_bytes.
872
:seealso: Branch._get_tags_bytes.
874
return _run_with_write_locked_target(self, self._transport.put_bytes,
320
877
def _cache_revision_history(self, rev_history):
321
878
"""Set the cached revision history to rev_history.
417
988
common_index = min(self_len, other_len) -1
418
989
if common_index >= 0 and \
419
990
self_history[common_index] != other_history[common_index]:
420
raise DivergedBranches(self, other)
991
raise errors.DivergedBranches(self, other)
422
993
if stop_revision is None:
423
994
stop_revision = other_len
425
assert isinstance(stop_revision, int)
426
996
if stop_revision > other_len:
427
997
raise errors.NoSuchRevision(self, stop_revision)
428
998
return other_history[self_len:stop_revision]
430
def update_revisions(self, other, stop_revision=None):
1000
def update_revisions(self, other, stop_revision=None, overwrite=False,
431
1002
"""Pull in new perfect-fit revisions.
433
1004
:param other: Another Branch to pull from
434
1005
:param stop_revision: Updated until the given revision
1006
:param overwrite: Always set the branch pointer, rather than checking
1007
to see if it is a proper descendant.
1008
:param graph: A Graph object that can be used to query history
1009
information. This can be None.
437
raise NotImplementedError(self.update_revisions)
1012
return InterBranch.get(other, self).update_revisions(stop_revision,
1015
def import_last_revision_info(self, source_repo, revno, revid):
1016
"""Set the last revision info, importing from another repo if necessary.
1018
This is used by the bound branch code to upload a revision to
1019
the master branch first before updating the tip of the local branch.
1021
:param source_repo: Source repository to optionally fetch from
1022
:param revno: Revision number of the new tip
1023
:param revid: Revision id of the new tip
1025
if not self.repository.has_same_location(source_repo):
1026
self.repository.fetch(source_repo, revision_id=revid)
1027
self.set_last_revision_info(revno, revid)
439
1029
def revision_id_to_revno(self, revision_id):
440
1030
"""Given a revision id, return its revno"""
441
if revision_id is None:
1031
if _mod_revision.is_null(revision_id):
443
revision_id = osutils.safe_revision_id(revision_id)
444
1033
history = self.revision_history()
446
1035
return history.index(revision_id) + 1
447
1036
except ValueError:
448
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1037
raise errors.NoSuchRevision(self, revision_id)
450
1040
def get_rev_id(self, revno, history=None):
451
1041
"""Find the revision id of the specified revno."""
455
history = self.revision_history()
456
if revno <= 0 or revno > len(history):
457
raise bzrlib.errors.NoSuchRevision(self, revno)
458
return history[revno - 1]
1043
return _mod_revision.NULL_REVISION
1044
last_revno, last_revid = self.last_revision_info()
1045
if revno == last_revno:
1047
if revno <= 0 or revno > last_revno:
1048
raise errors.NoSuchRevision(self, revno)
1049
distance_from_last = last_revno - revno
1050
if len(self._partial_revision_history_cache) <= distance_from_last:
1051
self._extend_partial_history(distance_from_last)
1052
return self._partial_revision_history_cache[distance_from_last]
460
def pull(self, source, overwrite=False, stop_revision=None):
1054
def pull(self, source, overwrite=False, stop_revision=None,
1055
possible_transports=None, *args, **kwargs):
461
1056
"""Mirror source into this branch.
463
1058
This branch is considered to be 'local', having low latency.
465
1060
:returns: PullResult instance
467
raise NotImplementedError(self.pull)
1062
return InterBranch.get(source, self).pull(overwrite=overwrite,
1063
stop_revision=stop_revision,
1064
possible_transports=possible_transports, *args, **kwargs)
469
def push(self, target, overwrite=False, stop_revision=None):
1066
def push(self, target, overwrite=False, stop_revision=None, *args,
470
1068
"""Mirror this branch into target.
472
1070
This branch is considered to be 'local', having low latency.
474
raise NotImplementedError(self.push)
1072
return InterBranch.get(self, target).push(overwrite, stop_revision,
1075
def lossy_push(self, target, stop_revision=None):
1076
"""Push deltas into another branch.
1078
:note: This does not, like push, retain the revision ids from
1079
the source branch and will, rather than adding bzr-specific
1080
metadata, push only those semantics of the revision that can be
1081
natively represented by this branch' VCS.
1083
:param target: Target branch
1084
:param stop_revision: Revision to push, defaults to last revision.
1085
:return: BranchPushResult with an extra member revidmap:
1086
A dictionary mapping revision ids from the target branch
1087
to new revision ids in the target branch, for each
1088
revision that was pushed.
1090
inter = InterBranch.get(self, target)
1091
lossy_push = getattr(inter, "lossy_push", None)
1092
if lossy_push is None:
1093
raise errors.LossyPushToSameVCS(self, target)
1094
return lossy_push(stop_revision)
476
1096
def basis_tree(self):
477
1097
"""Return `Tree` object for last revision."""
478
1098
return self.repository.revision_tree(self.last_revision())
480
def rename_one(self, from_rel, to_rel):
483
This can change the directory or the filename or both.
485
raise NotImplementedError(self.rename_one)
487
def move(self, from_paths, to_name):
490
to_name must exist as a versioned directory.
492
If to_name exists and is a directory, the files are moved into
493
it, keeping their old names. If it is a directory,
495
Note that to_name is only the last component of the new name;
496
this doesn't change the directory.
498
This returns a list of (from_path, to_path) pairs for each
501
raise NotImplementedError(self.move)
503
1100
def get_parent(self):
504
1101
"""Return the parent location of the branch.
506
This is the default location for push/pull/missing. The usual
1103
This is the default location for pull/missing. The usual
507
1104
pattern is that the user can override it by specifying a
510
raise NotImplementedError(self.get_parent)
1107
parent = self._get_parent_location()
1110
# This is an old-format absolute path to a local branch
1111
# turn it into a url
1112
if parent.startswith('/'):
1113
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1115
return urlutils.join(self.base[:-1], parent)
1116
except errors.InvalidURLJoin, e:
1117
raise errors.InaccessibleParent(parent, self.user_url)
1119
def _get_parent_location(self):
1120
raise NotImplementedError(self._get_parent_location)
512
1122
def _set_config_location(self, name, url, config=None,
513
1123
make_relative=False):
589
1224
self.check_real_revno(revno)
591
1226
def check_real_revno(self, revno):
593
1228
Check whether a revno corresponds to a real revision.
594
1229
Zero (the NULL revision) is considered invalid
596
1231
if revno < 1 or revno > self.revno():
597
raise InvalidRevisionNumber(revno)
1232
raise errors.InvalidRevisionNumber(revno)
599
1234
@needs_read_lock
600
def clone(self, to_bzrdir, revision_id=None):
1235
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
601
1236
"""Clone this branch into to_bzrdir preserving all semantic values.
1238
Most API users will want 'create_clone_on_transport', which creates a
1239
new bzrdir and branch on the fly.
603
1241
revision_id: if not None, the revision history in the new branch will
604
1242
be truncated to end with revision_id.
606
result = self._format.initialize(to_bzrdir)
607
self.copy_content_into(result, revision_id=revision_id)
1244
result = to_bzrdir.create_branch()
1247
if repository_policy is not None:
1248
repository_policy.configure_branch(result)
1249
self.copy_content_into(result, revision_id=revision_id)
610
1254
@needs_read_lock
611
def sprout(self, to_bzrdir, revision_id=None):
1255
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
612
1256
"""Create a new line of development from the branch, into to_bzrdir.
1258
to_bzrdir controls the branch format.
614
1260
revision_id: if not None, the revision history in the new branch will
615
1261
be truncated to end with revision_id.
617
result = self._format.initialize(to_bzrdir)
618
self.copy_content_into(result, revision_id=revision_id)
619
result.set_parent(self.bzrdir.root_transport.base)
1263
if (repository_policy is not None and
1264
repository_policy.requires_stacking()):
1265
to_bzrdir._format.require_stacking(_skip_repo=True)
1266
result = to_bzrdir.create_branch()
1269
if repository_policy is not None:
1270
repository_policy.configure_branch(result)
1271
self.copy_content_into(result, revision_id=revision_id)
1272
result.set_parent(self.bzrdir.root_transport.base)
622
1277
def _synchronize_history(self, destination, revision_id):
623
1278
"""Synchronize last revision and revision history between branches.
625
1280
This version is most efficient when the destination is also a
626
BzrBranch5, but works for BzrBranch6 as long as the revision
627
history is the true lefthand parent history, and all of the revisions
628
are in the destination's repository. If not, set_revision_history
1281
BzrBranch6, but works for BzrBranch5, as long as the destination's
1282
repository contains all the lefthand ancestors of the intended
1283
last_revision. If not, set_last_revision_info will fail.
631
1285
:param destination: The branch to copy the history into
632
1286
:param revision_id: The revision-id to truncate history at. May
633
1287
be None to copy complete history.
635
new_history = self.revision_history()
636
if revision_id is not None:
637
revision_id = osutils.safe_revision_id(revision_id)
1289
source_revno, source_revision_id = self.last_revision_info()
1290
if revision_id is None:
1291
revno, revision_id = source_revno, source_revision_id
1293
graph = self.repository.get_graph()
639
new_history = new_history[:new_history.index(revision_id) + 1]
641
rev = self.repository.get_revision(revision_id)
642
new_history = rev.get_history(self.repository)[1:]
643
destination.set_revision_history(new_history)
1295
revno = graph.find_distance_to_null(revision_id,
1296
[(source_revision_id, source_revno)])
1297
except errors.GhostRevisionsHaveNoRevno:
1298
# Default to 1, if we can't find anything else
1300
destination.set_last_revision_info(revno, revision_id)
646
1302
def copy_content_into(self, destination, revision_id=None):
647
1303
"""Copy the content of self into destination.
649
1305
revision_id: if not None, the revision history in the new branch will
650
1306
be truncated to end with revision_id.
652
self._synchronize_history(destination, revision_id)
654
parent = self.get_parent()
655
except errors.InaccessibleParent, e:
656
mutter('parent was not accessible to copy: %s', e)
659
destination.set_parent(parent)
660
self.tags.merge_to(destination.tags)
1308
return InterBranch.get(self, destination).copy_content_into(
1309
revision_id=revision_id)
1311
def update_references(self, target):
1312
if not getattr(self._format, 'supports_reference_locations', False):
1314
reference_dict = self._get_all_reference_info()
1315
if len(reference_dict) == 0:
1317
old_base = self.base
1318
new_base = target.base
1319
target_reference_dict = target._get_all_reference_info()
1320
for file_id, (tree_path, branch_location) in (
1321
reference_dict.items()):
1322
branch_location = urlutils.rebase_url(branch_location,
1324
target_reference_dict.setdefault(
1325
file_id, (tree_path, branch_location))
1326
target._set_all_reference_info(target_reference_dict)
662
1328
@needs_read_lock
1329
def check(self, refs):
664
1330
"""Check consistency of the branch.
666
1332
In particular this checks that revisions given in the revision-history
667
do actually match up in the revision graph, and that they're all
1333
do actually match up in the revision graph, and that they're all
668
1334
present in the repository.
670
1336
Callers will typically also want to check the repository.
1338
:param refs: Calculated refs for this branch as specified by
1339
branch._get_check_refs()
672
1340
:return: A BranchCheckResult.
674
mainline_parent_id = None
675
for revision_id in self.revision_history():
677
revision = self.repository.get_revision(revision_id)
678
except errors.NoSuchRevision, e:
679
raise errors.BzrCheckError("mainline revision {%s} not in repository"
681
# In general the first entry on the revision history has no parents.
682
# But it's not illegal for it to have parents listed; this can happen
683
# in imports from Arch when the parents weren't reachable.
684
if mainline_parent_id is not None:
685
if mainline_parent_id not in revision.parent_ids:
686
raise errors.BzrCheckError("previous revision {%s} not listed among "
688
% (mainline_parent_id, revision_id))
689
mainline_parent_id = revision_id
690
return BranchCheckResult(self)
1342
result = BranchCheckResult(self)
1343
last_revno, last_revision_id = self.last_revision_info()
1344
actual_revno = refs[('lefthand-distance', last_revision_id)]
1345
if actual_revno != last_revno:
1346
result.errors.append(errors.BzrCheckError(
1347
'revno does not match len(mainline) %s != %s' % (
1348
last_revno, actual_revno)))
1349
# TODO: We should probably also check that self.revision_history
1350
# matches the repository for older branch formats.
1351
# If looking for the code that cross-checks repository parents against
1352
# the iter_reverse_revision_history output, that is now a repository
692
1356
def _get_checkout_format(self):
693
1357
"""Return the most suitable metadir for a checkout of this branch.
694
Weaves are used if this branch's repostory uses weaves.
1358
Weaves are used if this branch's repository uses weaves.
696
1360
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
697
1361
from bzrlib.repofmt import weaverepo
702
1366
format.set_branch_format(self._format)
1369
def create_clone_on_transport(self, to_transport, revision_id=None,
1370
stacked_on=None, create_prefix=False, use_existing_dir=False):
1371
"""Create a clone of this branch and its bzrdir.
1373
:param to_transport: The transport to clone onto.
1374
:param revision_id: The revision id to use as tip in the new branch.
1375
If None the tip is obtained from this branch.
1376
:param stacked_on: An optional URL to stack the clone on.
1377
:param create_prefix: Create any missing directories leading up to
1379
:param use_existing_dir: Use an existing directory if one exists.
1381
# XXX: Fix the bzrdir API to allow getting the branch back from the
1382
# clone call. Or something. 20090224 RBC/spiv.
1383
# XXX: Should this perhaps clone colocated branches as well,
1384
# rather than just the default branch? 20100319 JRV
1385
if revision_id is None:
1386
revision_id = self.last_revision()
1387
dir_to = self.bzrdir.clone_on_transport(to_transport,
1388
revision_id=revision_id, stacked_on=stacked_on,
1389
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1390
return dir_to.open_branch()
705
1392
def create_checkout(self, to_location, revision_id=None,
1393
lightweight=False, accelerator_tree=None,
707
1395
"""Create a checkout of a branch.
709
1397
:param to_location: The url to produce the checkout at
710
1398
:param revision_id: The revision to check out
711
1399
:param lightweight: If True, produce a lightweight checkout, otherwise,
712
1400
produce a bound branch (heavyweight checkout)
1401
:param accelerator_tree: A tree which can be used for retrieving file
1402
contents more quickly than the revision tree, i.e. a workingtree.
1403
The revision tree will be used for cases where accelerator_tree's
1404
content is different.
1405
:param hardlink: If true, hard-link files from accelerator_tree,
713
1407
:return: The tree of the created checkout
715
1409
t = transport.get_transport(to_location)
718
except errors.FileExists:
721
1412
format = self._get_checkout_format()
722
1413
checkout = format.initialize_on_transport(t)
723
BranchReferenceFormat().initialize(checkout, self)
1414
from_branch = BranchReferenceFormat().initialize(checkout,
725
1417
format = self._get_checkout_format()
726
1418
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
727
1419
to_location, force_new_tree=False, format=format)
728
1420
checkout = checkout_branch.bzrdir
729
1421
checkout_branch.bind(self)
730
# pull up to the specified revision_id to set the initial
1422
# pull up to the specified revision_id to set the initial
731
1423
# branch tip correctly, and seed it with history.
732
1424
checkout_branch.pull(self, stop_revision=revision_id)
733
tree = checkout.create_workingtree(revision_id)
1426
tree = checkout.create_workingtree(revision_id,
1427
from_branch=from_branch,
1428
accelerator_tree=accelerator_tree,
734
1430
basis_tree = tree.basis_tree()
735
1431
basis_tree.lock_read()
743
1439
basis_tree.unlock()
746
def reference_parent(self, file_id, path):
1443
def reconcile(self, thorough=True):
1444
"""Make sure the data stored in this branch is consistent."""
1445
from bzrlib.reconcile import BranchReconciler
1446
reconciler = BranchReconciler(self, thorough=thorough)
1447
reconciler.reconcile()
1450
def reference_parent(self, file_id, path, possible_transports=None):
747
1451
"""Return the parent branch for a tree-reference file_id
748
1452
:param file_id: The file_id of the tree reference
749
1453
:param path: The path of the file_id in the tree
750
1454
:return: A branch associated with the file_id
752
1456
# FIXME should provide multiple branches, based on config
753
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1457
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1458
possible_transports=possible_transports)
755
1460
def supports_tags(self):
756
1461
return self._format.supports_tags()
1463
def automatic_tag_name(self, revision_id):
1464
"""Try to automatically find the tag name for a revision.
1466
:param revision_id: Revision id of the revision.
1467
:return: A tag name or None if no tag name could be determined.
1469
for hook in Branch.hooks['automatic_tag_name']:
1470
ret = hook(self, revision_id)
1475
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1477
"""Ensure that revision_b is a descendant of revision_a.
1479
This is a helper function for update_revisions.
1481
:raises: DivergedBranches if revision_b has diverged from revision_a.
1482
:returns: True if revision_b is a descendant of revision_a.
1484
relation = self._revision_relations(revision_a, revision_b, graph)
1485
if relation == 'b_descends_from_a':
1487
elif relation == 'diverged':
1488
raise errors.DivergedBranches(self, other_branch)
1489
elif relation == 'a_descends_from_b':
1492
raise AssertionError("invalid relation: %r" % (relation,))
1494
def _revision_relations(self, revision_a, revision_b, graph):
1495
"""Determine the relationship between two revisions.
1497
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1499
heads = graph.heads([revision_a, revision_b])
1500
if heads == set([revision_b]):
1501
return 'b_descends_from_a'
1502
elif heads == set([revision_a, revision_b]):
1503
# These branches have diverged
1505
elif heads == set([revision_a]):
1506
return 'a_descends_from_b'
1508
raise AssertionError("invalid heads: %r" % (heads,))
759
1511
class BranchFormat(object):
760
1512
"""An encapsulation of the initialization and open routines for a format.
781
1533
"""The known formats."""
1535
can_set_append_revisions_only = True
1537
def __eq__(self, other):
1538
return self.__class__ is other.__class__
1540
def __ne__(self, other):
1541
return not (self == other)
784
def find_format(klass, a_bzrdir):
1544
def find_format(klass, a_bzrdir, name=None):
785
1545
"""Return the format for the branch object in a_bzrdir."""
787
transport = a_bzrdir.get_branch_transport(None)
788
format_string = transport.get("format").read()
789
return klass._formats[format_string]
791
raise NotBranchError(path=transport.base)
1547
transport = a_bzrdir.get_branch_transport(None, name=name)
1548
format_string = transport.get_bytes("format")
1549
format = klass._formats[format_string]
1550
if isinstance(format, MetaDirBranchFormatFactory):
1553
except errors.NoSuchFile:
1554
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
792
1555
except KeyError:
793
raise errors.UnknownFormatError(format=format_string)
1556
raise errors.UnknownFormatError(format=format_string, kind='branch')
796
1559
def get_default_format(klass):
797
1560
"""Return the current default format."""
798
1561
return klass._default_format
1564
def get_formats(klass):
1565
"""Get all the known formats.
1567
Warning: This triggers a load of all lazy registered formats: do not
1568
use except when that is desireed.
1571
for fmt in klass._formats.values():
1572
if isinstance(fmt, MetaDirBranchFormatFactory):
1577
def get_reference(self, a_bzrdir, name=None):
1578
"""Get the target reference of the branch in a_bzrdir.
1580
format probing must have been completed before calling
1581
this method - it is assumed that the format of the branch
1582
in a_bzrdir is correct.
1584
:param a_bzrdir: The bzrdir to get the branch data from.
1585
:param name: Name of the colocated branch to fetch
1586
:return: None if the branch is not a reference branch.
1591
def set_reference(self, a_bzrdir, name, to_branch):
1592
"""Set the target reference of the branch in a_bzrdir.
1594
format probing must have been completed before calling
1595
this method - it is assumed that the format of the branch
1596
in a_bzrdir is correct.
1598
:param a_bzrdir: The bzrdir to set the branch reference for.
1599
:param name: Name of colocated branch to set, None for default
1600
:param to_branch: branch that the checkout is to reference
1602
raise NotImplementedError(self.set_reference)
800
1604
def get_format_string(self):
801
1605
"""Return the ASCII format string that identifies this format."""
802
1606
raise NotImplementedError(self.get_format_string)
827
1640
control_files = lockable_files.LockableFiles(branch_transport,
828
1641
lock_name, lock_class)
829
1642
control_files.create_lock()
830
control_files.lock_write()
1644
control_files.lock_write()
1645
except errors.LockContention:
1646
if lock_type != 'branch4':
832
control_files.put_utf8('format', self.get_format_string())
1652
utf8_files += [('format', self.get_format_string())]
834
for file, content in utf8_files:
835
control_files.put_utf8(file, content)
1654
for (filename, content) in utf8_files:
1655
branch_transport.put_bytes(
1657
mode=a_bzrdir._get_file_mode())
837
control_files.unlock()
838
return self.open(a_bzrdir, _found=True)
1660
control_files.unlock()
1661
branch = self.open(a_bzrdir, name, _found=True)
1662
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
840
def initialize(self, a_bzrdir):
841
"""Create a branch of this format in a_bzrdir."""
1665
def initialize(self, a_bzrdir, name=None):
1666
"""Create a branch of this format in a_bzrdir.
1668
:param name: Name of the colocated branch to create.
842
1670
raise NotImplementedError(self.initialize)
844
1672
def is_supported(self):
845
1673
"""Is this format supported?
847
1675
Supported formats can be initialized and opened.
848
Unsupported formats may not support initialization or committing or
1676
Unsupported formats may not support initialization or committing or
849
1677
some other features depending on the reason for not being supported.
853
def open(self, a_bzrdir, _found=False):
1681
def make_tags(self, branch):
1682
"""Create a tags object for branch.
1684
This method is on BranchFormat, because BranchFormats are reflected
1685
over the wire via network_name(), whereas full Branch instances require
1686
multiple VFS method calls to operate at all.
1688
The default implementation returns a disabled-tags instance.
1690
Note that it is normal for branch to be a RemoteBranch when using tags
1693
return DisabledTags(branch)
1695
def network_name(self):
1696
"""A simple byte string uniquely identifying this format for RPC calls.
1698
MetaDir branch formats use their disk format string to identify the
1699
repository over the wire. All in one formats such as bzr < 0.8, and
1700
foreign formats like svn/git and hg should use some marker which is
1701
unique and immutable.
1703
raise NotImplementedError(self.network_name)
1705
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
854
1706
"""Return the branch object for a_bzrdir
856
_found is a private parameter, do not use it. It is used to indicate
857
if format probing has already be done.
1708
:param a_bzrdir: A BzrDir that contains a branch.
1709
:param name: Name of colocated branch to open
1710
:param _found: a private parameter, do not use it. It is used to
1711
indicate if format probing has already be done.
1712
:param ignore_fallbacks: when set, no fallback branches will be opened
1713
(if there are any). Default is to open fallbacks.
859
1715
raise NotImplementedError(self.open)
862
1718
def register_format(klass, format):
1719
"""Register a metadir format.
1721
See MetaDirBranchFormatFactory for the ability to register a format
1722
without loading the code the format needs until it is actually used.
863
1724
klass._formats[format.get_format_string()] = format
1725
# Metadir formats have a network name of their format string, and get
1726
# registered as factories.
1727
if isinstance(format, MetaDirBranchFormatFactory):
1728
network_format_registry.register(format.get_format_string(), format)
1730
network_format_registry.register(format.get_format_string(),
866
1734
def set_default_format(klass, format):
867
1735
klass._default_format = format
1737
def supports_set_append_revisions_only(self):
1738
"""True if this format supports set_append_revisions_only."""
1741
def supports_stacking(self):
1742
"""True if this format records a stacked-on branch."""
870
1746
def unregister_format(klass, format):
871
assert klass._formats[format.get_format_string()] is format
872
1747
del klass._formats[format.get_format_string()]
874
1749
def __str__(self):
875
return self.get_format_string().rstrip()
1750
return self.get_format_description().rstrip()
877
1752
def supports_tags(self):
878
1753
"""True if this format supports tags stored in the branch"""
879
1754
return False # by default
881
# XXX: Probably doesn't really belong here -- mbp 20070212
882
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
884
branch_transport = a_bzrdir.get_branch_transport(self)
885
control_files = lockable_files.LockableFiles(branch_transport,
886
lock_filename, lock_class)
887
control_files.create_lock()
888
control_files.lock_write()
890
for filename, content in utf8_files:
891
control_files.put_utf8(filename, content)
893
control_files.unlock()
1757
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1758
"""A factory for a BranchFormat object, permitting simple lazy registration.
1760
While none of the built in BranchFormats are lazy registered yet,
1761
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1762
use it, and the bzr-loom plugin uses it as well (see
1763
bzrlib.plugins.loom.formats).
1766
def __init__(self, format_string, module_name, member_name):
1767
"""Create a MetaDirBranchFormatFactory.
1769
:param format_string: The format string the format has.
1770
:param module_name: Module to load the format class from.
1771
:param member_name: Attribute name within the module for the format class.
1773
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1774
self._format_string = format_string
1776
def get_format_string(self):
1777
"""See BranchFormat.get_format_string."""
1778
return self._format_string
1781
"""Used for network_format_registry support."""
1782
return self.get_obj()()
896
1785
class BranchHooks(Hooks):
897
1786
"""A dictionary mapping hook name to a list of callables for branch hooks.
899
1788
e.g. ['set_rh'] Is the list of items to be called when the
900
1789
set_revision_history function is invoked.
909
1798
Hooks.__init__(self)
910
# Introduced in 0.15:
911
# invoked whenever the revision history has been set
912
# with set_revision_history. The api signature is
913
# (branch, revision_history), and the branch will
916
# invoked after a push operation completes.
917
# the api signature is
919
# containing the members
920
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
921
# where local is the local branch or None, master is the target
922
# master branch, and the rest should be self explanatory. The source
923
# is read locked and the target branches write locked. Source will
924
# be the local low-latency branch.
925
self['post_push'] = []
926
# invoked after a pull operation completes.
927
# the api signature is
929
# containing the members
930
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
931
# where local is the local branch or None, master is the target
932
# master branch, and the rest should be self explanatory. The source
933
# is read locked and the target branches write locked. The local
934
# branch is the low-latency branch.
935
self['post_pull'] = []
936
# invoked after a commit operation completes.
937
# the api signature is
938
# (local, master, old_revno, old_revid, new_revno, new_revid)
939
# old_revid is NULL_REVISION for the first commit to a branch.
940
self['post_commit'] = []
941
# invoked after a uncommit operation completes.
942
# the api signature is
943
# (local, master, old_revno, old_revid, new_revno, new_revid) where
944
# local is the local branch or None, master is the target branch,
945
# and an empty branch recieves new_revno of 0, new_revid of None.
946
self['post_uncommit'] = []
1799
self.create_hook(HookPoint('set_rh',
1800
"Invoked whenever the revision history has been set via "
1801
"set_revision_history. The api signature is (branch, "
1802
"revision_history), and the branch will be write-locked. "
1803
"The set_rh hook can be expensive for bzr to trigger, a better "
1804
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1805
self.create_hook(HookPoint('open',
1806
"Called with the Branch object that has been opened after a "
1807
"branch is opened.", (1, 8), None))
1808
self.create_hook(HookPoint('post_push',
1809
"Called after a push operation completes. post_push is called "
1810
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1811
"bzr client.", (0, 15), None))
1812
self.create_hook(HookPoint('post_pull',
1813
"Called after a pull operation completes. post_pull is called "
1814
"with a bzrlib.branch.PullResult object and only runs in the "
1815
"bzr client.", (0, 15), None))
1816
self.create_hook(HookPoint('pre_commit',
1817
"Called after a commit is calculated but before it is is "
1818
"completed. pre_commit is called with (local, master, old_revno, "
1819
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1820
"). old_revid is NULL_REVISION for the first commit to a branch, "
1821
"tree_delta is a TreeDelta object describing changes from the "
1822
"basis revision. hooks MUST NOT modify this delta. "
1823
" future_tree is an in-memory tree obtained from "
1824
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1825
"tree.", (0,91), None))
1826
self.create_hook(HookPoint('post_commit',
1827
"Called in the bzr client after a commit has completed. "
1828
"post_commit is called with (local, master, old_revno, old_revid, "
1829
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1830
"commit to a branch.", (0, 15), None))
1831
self.create_hook(HookPoint('post_uncommit',
1832
"Called in the bzr client after an uncommit completes. "
1833
"post_uncommit is called with (local, master, old_revno, "
1834
"old_revid, new_revno, new_revid) where local is the local branch "
1835
"or None, master is the target branch, and an empty branch "
1836
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1837
self.create_hook(HookPoint('pre_change_branch_tip',
1838
"Called in bzr client and server before a change to the tip of a "
1839
"branch is made. pre_change_branch_tip is called with a "
1840
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1841
"commit, uncommit will all trigger this hook.", (1, 6), None))
1842
self.create_hook(HookPoint('post_change_branch_tip',
1843
"Called in bzr client and server after a change to the tip of a "
1844
"branch is made. post_change_branch_tip is called with a "
1845
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1846
"commit, uncommit will all trigger this hook.", (1, 4), None))
1847
self.create_hook(HookPoint('transform_fallback_location',
1848
"Called when a stacked branch is activating its fallback "
1849
"locations. transform_fallback_location is called with (branch, "
1850
"url), and should return a new url. Returning the same url "
1851
"allows it to be used as-is, returning a different one can be "
1852
"used to cause the branch to stack on a closer copy of that "
1853
"fallback_location. Note that the branch cannot have history "
1854
"accessing methods called on it during this hook because the "
1855
"fallback locations have not been activated. When there are "
1856
"multiple hooks installed for transform_fallback_location, "
1857
"all are called with the url returned from the previous hook."
1858
"The order is however undefined.", (1, 9), None))
1859
self.create_hook(HookPoint('automatic_tag_name',
1860
"Called to determine an automatic tag name for a revision."
1861
"automatic_tag_name is called with (branch, revision_id) and "
1862
"should return a tag name or None if no tag name could be "
1863
"determined. The first non-None tag name returned will be used.",
1865
self.create_hook(HookPoint('post_branch_init',
1866
"Called after new branch initialization completes. "
1867
"post_branch_init is called with a "
1868
"bzrlib.branch.BranchInitHookParams. "
1869
"Note that init, branch and checkout (both heavyweight and "
1870
"lightweight) will all trigger this hook.", (2, 2), None))
1871
self.create_hook(HookPoint('post_switch',
1872
"Called after a checkout switches branch. "
1873
"post_switch is called with a "
1874
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
949
1878
# install the default hooks into the Branch class.
950
1879
Branch.hooks = BranchHooks()
1882
class ChangeBranchTipParams(object):
1883
"""Object holding parameters passed to *_change_branch_tip hooks.
1885
There are 5 fields that hooks may wish to access:
1887
:ivar branch: the branch being changed
1888
:ivar old_revno: revision number before the change
1889
:ivar new_revno: revision number after the change
1890
:ivar old_revid: revision id before the change
1891
:ivar new_revid: revision id after the change
1893
The revid fields are strings. The revno fields are integers.
1896
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1897
"""Create a group of ChangeBranchTip parameters.
1899
:param branch: The branch being changed.
1900
:param old_revno: Revision number before the change.
1901
:param new_revno: Revision number after the change.
1902
:param old_revid: Tip revision id before the change.
1903
:param new_revid: Tip revision id after the change.
1905
self.branch = branch
1906
self.old_revno = old_revno
1907
self.new_revno = new_revno
1908
self.old_revid = old_revid
1909
self.new_revid = new_revid
1911
def __eq__(self, other):
1912
return self.__dict__ == other.__dict__
1915
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1916
self.__class__.__name__, self.branch,
1917
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1920
class BranchInitHookParams(object):
1921
"""Object holding parameters passed to *_branch_init hooks.
1923
There are 4 fields that hooks may wish to access:
1925
:ivar format: the branch format
1926
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1927
:ivar name: name of colocated branch, if any (or None)
1928
:ivar branch: the branch created
1930
Note that for lightweight checkouts, the bzrdir and format fields refer to
1931
the checkout, hence they are different from the corresponding fields in
1932
branch, which refer to the original branch.
1935
def __init__(self, format, a_bzrdir, name, branch):
1936
"""Create a group of BranchInitHook parameters.
1938
:param format: the branch format
1939
:param a_bzrdir: the BzrDir where the branch will be/has been
1941
:param name: name of colocated branch, if any (or None)
1942
:param branch: the branch created
1944
Note that for lightweight checkouts, the bzrdir and format fields refer
1945
to the checkout, hence they are different from the corresponding fields
1946
in branch, which refer to the original branch.
1948
self.format = format
1949
self.bzrdir = a_bzrdir
1951
self.branch = branch
1953
def __eq__(self, other):
1954
return self.__dict__ == other.__dict__
1958
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1960
return "<%s of format:%s bzrdir:%s>" % (
1961
self.__class__.__name__, self.branch,
1962
self.format, self.bzrdir)
1965
class SwitchHookParams(object):
1966
"""Object holding parameters passed to *_switch hooks.
1968
There are 4 fields that hooks may wish to access:
1970
:ivar control_dir: BzrDir of the checkout to change
1971
:ivar to_branch: branch that the checkout is to reference
1972
:ivar force: skip the check for local commits in a heavy checkout
1973
:ivar revision_id: revision ID to switch to (or None)
1976
def __init__(self, control_dir, to_branch, force, revision_id):
1977
"""Create a group of SwitchHook parameters.
1979
:param control_dir: BzrDir of the checkout to change
1980
:param to_branch: branch that the checkout is to reference
1981
:param force: skip the check for local commits in a heavy checkout
1982
:param revision_id: revision ID to switch to (or None)
1984
self.control_dir = control_dir
1985
self.to_branch = to_branch
1987
self.revision_id = revision_id
1989
def __eq__(self, other):
1990
return self.__dict__ == other.__dict__
1993
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1994
self.control_dir, self.to_branch,
953
1998
class BzrBranchFormat4(BranchFormat):
954
1999
"""Bzr branch format 4.
962
2007
"""See BranchFormat.get_format_description()."""
963
2008
return "Branch format 4"
965
def initialize(self, a_bzrdir):
2010
def initialize(self, a_bzrdir, name=None):
966
2011
"""Create a branch of this format in a_bzrdir."""
967
2012
utf8_files = [('revision-history', ''),
968
2013
('branch-name', ''),
970
return self._initialize_helper(a_bzrdir, utf8_files,
2015
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
971
2016
lock_type='branch4', set_format=False)
973
2018
def __init__(self):
974
2019
super(BzrBranchFormat4, self).__init__()
975
2020
self._matchingbzrdir = bzrdir.BzrDirFormat6()
977
def open(self, a_bzrdir, _found=False):
978
"""Return the branch object for a_bzrdir
2022
def network_name(self):
2023
"""The network name for this format is the control dirs disk label."""
2024
return self._matchingbzrdir.get_format_string()
980
_found is a private parameter, do not use it. It is used to indicate
981
if format probing has already be done.
2026
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2027
"""See BranchFormat.open()."""
984
2029
# we are being called directly and must probe.
985
2030
raise NotImplementedError
986
2031
return BzrBranch(_format=self,
987
2032
_control_files=a_bzrdir._control_files,
988
2033
a_bzrdir=a_bzrdir,
989
2035
_repository=a_bzrdir.open_repository())
991
2037
def __str__(self):
992
2038
return "Bazaar-NG branch format 4"
995
class BzrBranchFormat5(BranchFormat):
2041
class BranchFormatMetadir(BranchFormat):
2042
"""Common logic for meta-dir based branch formats."""
2044
def _branch_class(self):
2045
"""What class to instantiate on open calls."""
2046
raise NotImplementedError(self._branch_class)
2048
def network_name(self):
2049
"""A simple byte string uniquely identifying this format for RPC calls.
2051
Metadir branch formats use their format string.
2053
return self.get_format_string()
2055
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2056
"""See BranchFormat.open()."""
2058
format = BranchFormat.find_format(a_bzrdir, name=name)
2059
if format.__class__ != self.__class__:
2060
raise AssertionError("wrong format %r found for %r" %
2062
transport = a_bzrdir.get_branch_transport(None, name=name)
2064
control_files = lockable_files.LockableFiles(transport, 'lock',
2066
return self._branch_class()(_format=self,
2067
_control_files=control_files,
2070
_repository=a_bzrdir.find_repository(),
2071
ignore_fallbacks=ignore_fallbacks)
2072
except errors.NoSuchFile:
2073
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2076
super(BranchFormatMetadir, self).__init__()
2077
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2078
self._matchingbzrdir.set_branch_format(self)
2080
def supports_tags(self):
2084
class BzrBranchFormat5(BranchFormatMetadir):
996
2085
"""Bzr branch format 5.
998
2087
This format has:
1060
2138
"""See BranchFormat.get_format_description()."""
1061
2139
return "Branch format 6"
1063
def initialize(self, a_bzrdir):
1064
"""Create a branch of this format in a_bzrdir."""
1065
utf8_files = [('last-revision', '0 null:\n'),
1066
('branch-name', ''),
1067
('branch.conf', ''),
1070
return self._initialize_helper(a_bzrdir, utf8_files)
1072
def open(self, a_bzrdir, _found=False):
1073
"""Return the branch object for a_bzrdir
1075
_found is a private parameter, do not use it. It is used to indicate
1076
if format probing has already be done.
1079
format = BranchFormat.find_format(a_bzrdir)
1080
assert format.__class__ == self.__class__
1081
transport = a_bzrdir.get_branch_transport(None)
1082
control_files = lockable_files.LockableFiles(transport, 'lock',
1084
return BzrBranch6(_format=self,
1085
_control_files=control_files,
1087
_repository=a_bzrdir.find_repository())
1089
def supports_tags(self):
2141
def initialize(self, a_bzrdir, name=None):
2142
"""Create a branch of this format in a_bzrdir."""
2143
utf8_files = [('last-revision', '0 null:\n'),
2144
('branch.conf', ''),
2147
return self._initialize_helper(a_bzrdir, utf8_files, name)
2149
def make_tags(self, branch):
2150
"""See bzrlib.branch.BranchFormat.make_tags()."""
2151
return BasicTags(branch)
2153
def supports_set_append_revisions_only(self):
2157
class BzrBranchFormat8(BranchFormatMetadir):
2158
"""Metadir format supporting storing locations of subtree branches."""
2160
def _branch_class(self):
2163
def get_format_string(self):
2164
"""See BranchFormat.get_format_string()."""
2165
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2167
def get_format_description(self):
2168
"""See BranchFormat.get_format_description()."""
2169
return "Branch format 8"
2171
def initialize(self, a_bzrdir, name=None):
2172
"""Create a branch of this format in a_bzrdir."""
2173
utf8_files = [('last-revision', '0 null:\n'),
2174
('branch.conf', ''),
2178
return self._initialize_helper(a_bzrdir, utf8_files, name)
2181
super(BzrBranchFormat8, self).__init__()
2182
self._matchingbzrdir.repository_format = \
2183
RepositoryFormatKnitPack5RichRoot()
2185
def make_tags(self, branch):
2186
"""See bzrlib.branch.BranchFormat.make_tags()."""
2187
return BasicTags(branch)
2189
def supports_set_append_revisions_only(self):
2192
def supports_stacking(self):
2195
supports_reference_locations = True
2198
class BzrBranchFormat7(BzrBranchFormat8):
2199
"""Branch format with last-revision, tags, and a stacked location pointer.
2201
The stacked location pointer is passed down to the repository and requires
2202
a repository format with supports_external_lookups = True.
2204
This format was introduced in bzr 1.6.
2207
def initialize(self, a_bzrdir, name=None):
2208
"""Create a branch of this format in a_bzrdir."""
2209
utf8_files = [('last-revision', '0 null:\n'),
2210
('branch.conf', ''),
2213
return self._initialize_helper(a_bzrdir, utf8_files, name)
2215
def _branch_class(self):
2218
def get_format_string(self):
2219
"""See BranchFormat.get_format_string()."""
2220
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2222
def get_format_description(self):
2223
"""See BranchFormat.get_format_description()."""
2224
return "Branch format 7"
2226
def supports_set_append_revisions_only(self):
2229
supports_reference_locations = False
1093
2232
class BranchReferenceFormat(BranchFormat):
1108
2247
def get_format_description(self):
1109
2248
"""See BranchFormat.get_format_description()."""
1110
2249
return "Checkout reference format 1"
1112
def initialize(self, a_bzrdir, target_branch=None):
2251
def get_reference(self, a_bzrdir, name=None):
2252
"""See BranchFormat.get_reference()."""
2253
transport = a_bzrdir.get_branch_transport(None, name=name)
2254
return transport.get_bytes('location')
2256
def set_reference(self, a_bzrdir, name, to_branch):
2257
"""See BranchFormat.set_reference()."""
2258
transport = a_bzrdir.get_branch_transport(None, name=name)
2259
location = transport.put_bytes('location', to_branch.base)
2261
def initialize(self, a_bzrdir, name=None, target_branch=None):
1113
2262
"""Create a branch of this format in a_bzrdir."""
1114
2263
if target_branch is None:
1115
2264
# this format does not implement branch itself, thus the implicit
1116
2265
# creation contract must see it as uninitializable
1117
2266
raise errors.UninitializableFormat(self)
1118
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1119
branch_transport = a_bzrdir.get_branch_transport(self)
2267
mutter('creating branch reference in %s', a_bzrdir.user_url)
2268
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1120
2269
branch_transport.put_bytes('location',
1121
target_branch.bzrdir.root_transport.base)
2270
target_branch.bzrdir.user_url)
1122
2271
branch_transport.put_bytes('format', self.get_format_string())
1123
return self.open(a_bzrdir, _found=True)
2273
a_bzrdir, name, _found=True,
2274
possible_transports=[target_branch.bzrdir.root_transport])
2275
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1125
2278
def __init__(self):
1126
2279
super(BranchReferenceFormat, self).__init__()
1127
2280
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2281
self._matchingbzrdir.set_branch_format(self)
1129
2283
def _make_reference_clone_function(format, a_branch):
1130
2284
"""Create a clone() routine for a branch dynamically."""
1131
def clone(to_bzrdir, revision_id=None):
2285
def clone(to_bzrdir, revision_id=None,
2286
repository_policy=None):
1132
2287
"""See Branch.clone()."""
1133
return format.initialize(to_bzrdir, a_branch)
2288
return format.initialize(to_bzrdir, target_branch=a_branch)
1134
2289
# cannot obey revision_id limits when cloning a reference ...
1135
2290
# FIXME RBC 20060210 either nuke revision_id for clone, or
1136
2291
# emit some sort of warning/error to the caller ?!
1139
def open(self, a_bzrdir, _found=False):
2294
def open(self, a_bzrdir, name=None, _found=False, location=None,
2295
possible_transports=None, ignore_fallbacks=False):
1140
2296
"""Return the branch that the branch reference in a_bzrdir points at.
1142
_found is a private parameter, do not use it. It is used to indicate
1143
if format probing has already be done.
2298
:param a_bzrdir: A BzrDir that contains a branch.
2299
:param name: Name of colocated branch to open, if any
2300
:param _found: a private parameter, do not use it. It is used to
2301
indicate if format probing has already be done.
2302
:param ignore_fallbacks: when set, no fallback branches will be opened
2303
(if there are any). Default is to open fallbacks.
2304
:param location: The location of the referenced branch. If
2305
unspecified, this will be determined from the branch reference in
2307
:param possible_transports: An optional reusable transports list.
1146
format = BranchFormat.find_format(a_bzrdir)
1147
assert format.__class__ == self.__class__
1148
transport = a_bzrdir.get_branch_transport(None)
1149
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1150
result = real_bzrdir.open_branch()
2310
format = BranchFormat.find_format(a_bzrdir, name=name)
2311
if format.__class__ != self.__class__:
2312
raise AssertionError("wrong format %r found for %r" %
2314
if location is None:
2315
location = self.get_reference(a_bzrdir, name)
2316
real_bzrdir = bzrdir.BzrDir.open(
2317
location, possible_transports=possible_transports)
2318
result = real_bzrdir.open_branch(name=name,
2319
ignore_fallbacks=ignore_fallbacks)
1151
2320
# this changes the behaviour of result.clone to create a new reference
1152
2321
# rather than a copy of the content of the branch.
1153
2322
# I did not use a proxy object because that needs much more extensive
2332
network_format_registry = registry.FormatRegistry()
2333
"""Registry of formats indexed by their network name.
2335
The network name for a branch format is an identifier that can be used when
2336
referring to formats with smart server operations. See
2337
BranchFormat.network_name() for more detail.
1163
2341
# formats which have no format string are not discoverable
1164
2342
# and not independently creatable, so are not registered.
1165
__default_format = BzrBranchFormat5()
1166
BranchFormat.register_format(__default_format)
2343
__format5 = BzrBranchFormat5()
2344
__format6 = BzrBranchFormat6()
2345
__format7 = BzrBranchFormat7()
2346
__format8 = BzrBranchFormat8()
2347
BranchFormat.register_format(__format5)
1167
2348
BranchFormat.register_format(BranchReferenceFormat())
1168
BranchFormat.register_format(BzrBranchFormat6())
1169
BranchFormat.set_default_format(__default_format)
2349
BranchFormat.register_format(__format6)
2350
BranchFormat.register_format(__format7)
2351
BranchFormat.register_format(__format8)
2352
BranchFormat.set_default_format(__format7)
1170
2353
_legacy_formats = [BzrBranchFormat4(),
1173
class BzrBranch(Branch):
2355
network_format_registry.register(
2356
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2359
class BranchWriteLockResult(LogicalLockResult):
2360
"""The result of write locking a branch.
2362
:ivar branch_token: The token obtained from the underlying branch lock, or
2364
:ivar unlock: A callable which will unlock the lock.
2367
def __init__(self, unlock, branch_token):
2368
LogicalLockResult.__init__(self, unlock)
2369
self.branch_token = branch_token
2372
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2376
class BzrBranch(Branch, _RelockDebugMixin):
1174
2377
"""A branch stored in the actual filesystem.
1176
2379
Note that it's "local" in the context of the filesystem; it doesn't
1177
2380
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1178
2381
it's writable, and can be accessed via the normal filesystem API.
2383
:ivar _transport: Transport for file operations on this branch's
2384
control files, typically pointing to the .bzr/branch directory.
2385
:ivar repository: Repository for this branch.
2386
:ivar base: The url of the base directory for this branch; the one
2387
containing the .bzr directory.
2388
:ivar name: Optional colocated branch name as it exists in the control
1181
2392
def __init__(self, _format=None,
1182
_control_files=None, a_bzrdir=None, _repository=None):
2393
_control_files=None, a_bzrdir=None, name=None,
2394
_repository=None, ignore_fallbacks=False):
1183
2395
"""Create new branch object at a particular location."""
1184
Branch.__init__(self)
1185
2396
if a_bzrdir is None:
1186
2397
raise ValueError('a_bzrdir must be supplied')
1188
2399
self.bzrdir = a_bzrdir
1189
# self._transport used to point to the directory containing the
1190
# control directory, but was not used - now it's just the transport
1191
# for the branch control files. mbp 20070212
1192
2400
self._base = self.bzrdir.transport.clone('..').base
2402
# XXX: We should be able to just do
2403
# self.base = self.bzrdir.root_transport.base
2404
# but this does not quite work yet -- mbp 20080522
1193
2405
self._format = _format
1194
2406
if _control_files is None:
1195
2407
raise ValueError('BzrBranch _control_files is None')
1196
2408
self.control_files = _control_files
1197
2409
self._transport = _control_files._transport
1198
2410
self.repository = _repository
2411
Branch.__init__(self)
1200
2413
def __str__(self):
1201
return '%s(%r)' % (self.__class__.__name__, self.base)
2414
if self.name is None:
2415
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2417
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
1203
2420
__repr__ = __str__
1209
2426
base = property(_get_base, doc="The URL for the root of this branch.")
1211
def abspath(self, name):
1212
"""See Branch.abspath."""
1213
return self.control_files._transport.abspath(name)
1216
@deprecated_method(zero_sixteen)
1218
def get_root_id(self):
1219
"""See Branch.get_root_id."""
1220
tree = self.repository.revision_tree(self.last_revision())
1221
return tree.inventory.root.file_id
2428
def _get_config(self):
2429
return TransportConfig(self._transport, 'branch.conf')
1223
2431
def is_locked(self):
1224
2432
return self.control_files.is_locked()
1226
def lock_write(self):
1227
self.repository.lock_write()
2434
def lock_write(self, token=None):
2435
"""Lock the branch for write operations.
2437
:param token: A token to permit reacquiring a previously held and
2439
:return: A BranchWriteLockResult.
2441
if not self.is_locked():
2442
self._note_lock('w')
2443
# All-in-one needs to always unlock/lock.
2444
repo_control = getattr(self.repository, 'control_files', None)
2445
if self.control_files == repo_control or not self.is_locked():
2446
self.repository._warn_if_deprecated(self)
2447
self.repository.lock_write()
1229
self.control_files.lock_write()
2452
return BranchWriteLockResult(self.unlock,
2453
self.control_files.lock_write(token=token))
1231
self.repository.unlock()
2456
self.repository.unlock()
1234
2459
def lock_read(self):
1235
self.repository.lock_read()
2460
"""Lock the branch for read operations.
2462
:return: A bzrlib.lock.LogicalLockResult.
2464
if not self.is_locked():
2465
self._note_lock('r')
2466
# All-in-one needs to always unlock/lock.
2467
repo_control = getattr(self.repository, 'control_files', None)
2468
if self.control_files == repo_control or not self.is_locked():
2469
self.repository._warn_if_deprecated(self)
2470
self.repository.lock_read()
1237
2475
self.control_files.lock_read()
2476
return LogicalLockResult(self.unlock)
1239
self.repository.unlock()
2479
self.repository.unlock()
2482
@only_raises(errors.LockNotHeld, errors.LockBroken)
1242
2483
def unlock(self):
1243
# TODO: test for failed two phase locks. This is known broken.
1245
2485
self.control_files.unlock()
1247
self.repository.unlock()
1248
if not self.control_files.is_locked():
1249
# we just released the lock
1250
self._clear_cached_state()
2487
# All-in-one needs to always unlock/lock.
2488
repo_control = getattr(self.repository, 'control_files', None)
2489
if (self.control_files == repo_control or
2490
not self.control_files.is_locked()):
2491
self.repository.unlock()
2492
if not self.control_files.is_locked():
2493
# we just released the lock
2494
self._clear_cached_state()
1252
2496
def peek_lock_mode(self):
1253
2497
if self.control_files._lock_count == 0:
1263
2507
"""See Branch.print_file."""
1264
2508
return self.repository.print_file(file, revision_id)
1267
def append_revision(self, *revision_ids):
1268
"""See Branch.append_revision."""
1269
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1270
for revision_id in revision_ids:
1271
_mod_revision.check_not_reserved_id(revision_id)
1272
mutter("add {%s} to revision-history" % revision_id)
1273
rev_history = self.revision_history()
1274
rev_history.extend(revision_ids)
1275
self.set_revision_history(rev_history)
1277
2510
def _write_revision_history(self, history):
1278
2511
"""Factored out of set_revision_history.
1280
2513
This performs the actual writing to disk.
1281
2514
It is intended to be called by BzrBranch5.set_revision_history."""
1282
self.control_files.put_bytes(
1283
'revision-history', '\n'.join(history))
2515
self._transport.put_bytes(
2516
'revision-history', '\n'.join(history),
2517
mode=self.bzrdir._get_file_mode())
1285
2519
@needs_write_lock
1286
2520
def set_revision_history(self, rev_history):
1287
2521
"""See Branch.set_revision_history."""
1288
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
2522
if 'evil' in debug.debug_flags:
2523
mutter_callsite(3, "set_revision_history scales with history.")
2524
check_not_reserved_id = _mod_revision.check_not_reserved_id
2525
for rev_id in rev_history:
2526
check_not_reserved_id(rev_id)
2527
if Branch.hooks['post_change_branch_tip']:
2528
# Don't calculate the last_revision_info() if there are no hooks
2530
old_revno, old_revid = self.last_revision_info()
2531
if len(rev_history) == 0:
2532
revid = _mod_revision.NULL_REVISION
2534
revid = rev_history[-1]
2535
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1289
2536
self._write_revision_history(rev_history)
2537
self._clear_cached_state()
1290
2538
self._cache_revision_history(rev_history)
1291
2539
for hook in Branch.hooks['set_rh']:
1292
2540
hook(self, rev_history)
2541
if Branch.hooks['post_change_branch_tip']:
2542
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2544
def _synchronize_history(self, destination, revision_id):
2545
"""Synchronize last revision and revision history between branches.
2547
This version is most efficient when the destination is also a
2548
BzrBranch5, but works for BzrBranch6 as long as the revision
2549
history is the true lefthand parent history, and all of the revisions
2550
are in the destination's repository. If not, set_revision_history
2553
:param destination: The branch to copy the history into
2554
:param revision_id: The revision-id to truncate history at. May
2555
be None to copy complete history.
2557
if not isinstance(destination._format, BzrBranchFormat5):
2558
super(BzrBranch, self)._synchronize_history(
2559
destination, revision_id)
2561
if revision_id == _mod_revision.NULL_REVISION:
2564
new_history = self.revision_history()
2565
if revision_id is not None and new_history != []:
2567
new_history = new_history[:new_history.index(revision_id) + 1]
2569
rev = self.repository.get_revision(revision_id)
2570
new_history = rev.get_history(self.repository)[1:]
2571
destination.set_revision_history(new_history)
1294
2573
@needs_write_lock
1295
2574
def set_last_revision_info(self, revno, revision_id):
1296
revision_id = osutils.safe_revision_id(revision_id)
2575
"""Set the last revision of this branch.
2577
The caller is responsible for checking that the revno is correct
2578
for this revision id.
2580
It may be possible to set the branch last revision to an id not
2581
present in the repository. However, branches can also be
2582
configured to check constraints on history, in which case this may not
2585
revision_id = _mod_revision.ensure_null(revision_id)
2586
# this old format stores the full history, but this api doesn't
2587
# provide it, so we must generate, and might as well check it's
1297
2589
history = self._lefthand_history(revision_id)
1298
assert len(history) == revno, '%d != %d' % (len(history), revno)
2590
if len(history) != revno:
2591
raise AssertionError('%d != %d' % (len(history), revno))
1299
2592
self.set_revision_history(history)
1301
2594
def _gen_revision_history(self):
1302
history = self.control_files.get('revision-history').read().split('\n')
2595
history = self._transport.get_bytes('revision-history').split('\n')
1303
2596
if history[-1:] == ['']:
1304
2597
# There shouldn't be a trailing newline, but just in case.
1308
def _lefthand_history(self, revision_id, last_rev=None,
1310
# stop_revision must be a descendant of last_revision
1311
stop_graph = self.repository.get_revision_graph(revision_id)
1312
if last_rev is not None and last_rev not in stop_graph:
1313
# our previous tip is not merged into stop_revision
1314
raise errors.DivergedBranches(self, other_branch)
1315
# make a new revision history from the graph
1316
current_rev_id = revision_id
1318
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1319
new_history.append(current_rev_id)
1320
current_rev_id_parents = stop_graph[current_rev_id]
1322
current_rev_id = current_rev_id_parents[0]
1324
current_rev_id = None
1325
new_history.reverse()
1328
2601
@needs_write_lock
1329
2602
def generate_revision_history(self, revision_id, last_rev=None,
1330
2603
other_branch=None):
1336
2609
:param other_branch: The other branch that DivergedBranches should
1337
2610
raise with respect to.
1339
revision_id = osutils.safe_revision_id(revision_id)
1340
2612
self.set_revision_history(self._lefthand_history(revision_id,
1341
2613
last_rev, other_branch))
1344
def update_revisions(self, other, stop_revision=None):
1345
"""See Branch.update_revisions."""
1348
if stop_revision is None:
1349
stop_revision = other.last_revision()
1350
if stop_revision is None:
1351
# if there are no commits, we're done.
1354
stop_revision = osutils.safe_revision_id(stop_revision)
1355
# whats the current last revision, before we fetch [and change it
1357
last_rev = self.last_revision()
1358
# we fetch here regardless of whether we need to so that we pickup
1360
self.fetch(other, stop_revision)
1361
my_ancestry = self.repository.get_ancestry(last_rev)
1362
if stop_revision in my_ancestry:
1363
# last_revision is a descendant of stop_revision
1365
self.generate_revision_history(stop_revision, last_rev=last_rev,
1370
2615
def basis_tree(self):
1371
2616
"""See Branch.basis_tree."""
1372
2617
return self.repository.revision_tree(self.last_revision())
1374
@deprecated_method(zero_eight)
1375
def working_tree(self):
1376
"""Create a Working tree object for this branch."""
1378
from bzrlib.transport.local import LocalTransport
1379
if (self.base.find('://') != -1 or
1380
not isinstance(self._transport, LocalTransport)):
1381
raise NoWorkingTree(self.base)
1382
return self.bzrdir.open_workingtree()
1385
def pull(self, source, overwrite=False, stop_revision=None,
1386
_hook_master=None, _run_hooks=True):
1389
:param _hook_master: Private parameter - set the branch to
1390
be supplied as the master to push hooks.
1391
:param _run_hooks: Private parameter - allow disabling of
1392
hooks, used when pushing to a master branch.
1394
result = PullResult()
1395
result.source_branch = source
1396
result.target_branch = self
1399
result.old_revno, result.old_revid = self.last_revision_info()
1401
self.update_revisions(source, stop_revision)
1402
except DivergedBranches:
1406
if stop_revision is None:
1407
stop_revision = source.last_revision()
1408
self.generate_revision_history(stop_revision)
1409
result.tag_conflicts = source.tags.merge_to(self.tags)
1410
result.new_revno, result.new_revid = self.last_revision_info()
1412
result.master_branch = _hook_master
1413
result.local_branch = self
1415
result.master_branch = self
1416
result.local_branch = None
1418
for hook in Branch.hooks['post_pull']:
1424
2619
def _get_parent_location(self):
1425
2620
_locs = ['parent', 'pull', 'x-pull']
1426
2621
for l in _locs:
1428
return self.control_files.get(l).read().strip('\n')
2623
return self._transport.get_bytes(l).strip('\n')
2624
except errors.NoSuchFile:
1434
def push(self, target, overwrite=False, stop_revision=None,
1435
_hook_master=None, _run_hooks=True):
1438
:param _hook_master: Private parameter - set the branch to
1439
be supplied as the master to push hooks.
1440
:param _run_hooks: Private parameter - allow disabling of
1441
hooks, used when pushing to a master branch.
2628
def _basic_push(self, target, overwrite, stop_revision):
2629
"""Basic implementation of push without bound branches or hooks.
2631
Must be called with source read locked and target write locked.
1443
result = PushResult()
2633
result = BranchPushResult()
1444
2634
result.source_branch = self
1445
2635
result.target_branch = target
1448
result.old_revno, result.old_revid = target.last_revision_info()
1450
target.update_revisions(self, stop_revision)
1451
except DivergedBranches:
1455
target.set_revision_history(self.revision_history())
1456
result.tag_conflicts = self.tags.merge_to(target.tags)
1457
result.new_revno, result.new_revid = target.last_revision_info()
1459
result.master_branch = _hook_master
1460
result.local_branch = target
1462
result.master_branch = target
1463
result.local_branch = None
1465
for hook in Branch.hooks['post_push']:
2636
result.old_revno, result.old_revid = target.last_revision_info()
2637
self.update_references(target)
2638
if result.old_revid != self.last_revision():
2639
# We assume that during 'push' this repository is closer than
2641
graph = self.repository.get_graph(target.repository)
2642
target.update_revisions(self, stop_revision,
2643
overwrite=overwrite, graph=graph)
2644
if self._push_should_merge_tags():
2645
result.tag_conflicts = self.tags.merge_to(target.tags,
2647
result.new_revno, result.new_revid = target.last_revision_info()
1471
def get_parent(self):
1472
"""See Branch.get_parent."""
1474
assert self.base[-1] == '/'
1475
parent = self._get_parent_location()
1478
# This is an old-format absolute path to a local branch
1479
# turn it into a url
1480
if parent.startswith('/'):
1481
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1483
return urlutils.join(self.base[:-1], parent)
1484
except errors.InvalidURLJoin, e:
1485
raise errors.InaccessibleParent(parent, self.base)
1487
def get_push_location(self):
1488
"""See Branch.get_push_location."""
1489
push_loc = self.get_config().get_user_option('push_location')
2650
def get_stacked_on_url(self):
2651
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1492
2653
def set_push_location(self, location):
1493
2654
"""See Branch.set_push_location."""
1495
2656
'push_location', location,
1496
2657
store=_mod_config.STORE_LOCATION_NORECURSE)
1499
def set_parent(self, url):
1500
"""See Branch.set_parent."""
1501
# TODO: Maybe delete old location files?
1502
# URLs should never be unicode, even on the local fs,
1503
# FIXUP this and get_parent in a future branch format bump:
1504
# read and rewrite the file, and have the new format code read
1505
# using .get not .get_utf8. RBC 20060125
1507
if isinstance(url, unicode):
1509
url = url.encode('ascii')
1510
except UnicodeEncodeError:
1511
raise bzrlib.errors.InvalidURL(url,
1512
"Urls must be 7-bit ascii, "
1513
"use bzrlib.urlutils.escape")
1514
url = urlutils.relative_url(self.base, url)
1515
self._set_parent_location(url)
1517
2659
def _set_parent_location(self, url):
1518
2660
if url is None:
1519
self.control_files._transport.delete('parent')
2661
self._transport.delete('parent')
1521
assert isinstance(url, str)
1522
self.control_files.put_bytes('parent', url + '\n')
1524
@deprecated_function(zero_nine)
1525
def tree_config(self):
1526
"""DEPRECATED; call get_config instead.
1527
TreeConfig has become part of BranchConfig."""
1528
return TreeConfig(self)
2663
self._transport.put_bytes('parent', url + '\n',
2664
mode=self.bzrdir._get_file_mode())
1531
2667
class BzrBranch5(BzrBranch):
1532
"""A format 5 branch. This supports new features over plan branches.
2668
"""A format 5 branch. This supports new features over plain branches.
1534
2670
It has support for a master_branch which is the data for bound branches.
1542
super(BzrBranch5, self).__init__(_format=_format,
1543
_control_files=_control_files,
1545
_repository=_repository)
1548
def pull(self, source, overwrite=False, stop_revision=None,
1550
"""Extends branch.pull to be bound branch aware.
1552
:param _run_hooks: Private parameter used to force hook running
1553
off during bound branch double-pushing.
1555
bound_location = self.get_bound_location()
1556
master_branch = None
1557
if bound_location and source.base != bound_location:
1558
# not pulling from master, so we need to update master.
1559
master_branch = self.get_master_branch()
1560
master_branch.lock_write()
1563
# pull from source into master.
1564
master_branch.pull(source, overwrite, stop_revision,
1566
return super(BzrBranch5, self).pull(source, overwrite,
1567
stop_revision, _hook_master=master_branch,
1568
_run_hooks=_run_hooks)
1571
master_branch.unlock()
1574
def push(self, target, overwrite=False, stop_revision=None):
1575
"""Updates branch.push to be bound branch aware."""
1576
bound_location = target.get_bound_location()
1577
master_branch = None
1578
if bound_location and target.base != bound_location:
1579
# not pushing to master, so we need to update master.
1580
master_branch = target.get_master_branch()
1581
master_branch.lock_write()
1584
# push into the master from this branch.
1585
super(BzrBranch5, self).push(master_branch, overwrite,
1586
stop_revision, _run_hooks=False)
1587
# and push into the target branch from this. Note that we push from
1588
# this branch again, because its considered the highest bandwidth
1590
return super(BzrBranch5, self).push(target, overwrite,
1591
stop_revision, _hook_master=master_branch)
1594
master_branch.unlock()
1596
2673
def get_bound_location(self):
1598
return self.control_files.get_utf8('bound').read()[:-1]
2675
return self._transport.get_bytes('bound')[:-1]
1599
2676
except errors.NoSuchFile:
1602
2679
@needs_read_lock
1603
def get_master_branch(self):
2680
def get_master_branch(self, possible_transports=None):
1604
2681
"""Return the branch we are bound to.
1606
2683
:return: Either a Branch, or None
1608
2685
This could memoise the branch, but if thats done
1682
2745
return self.set_bound_location(None)
1684
2747
@needs_write_lock
1686
"""Synchronise this branch with the master branch if any.
2748
def update(self, possible_transports=None):
2749
"""Synchronise this branch with the master branch if any.
1688
2751
:return: None or the last_revision that was pivoted out during the
1691
master = self.get_master_branch()
2754
master = self.get_master_branch(possible_transports)
1692
2755
if master is not None:
1693
old_tip = self.last_revision()
2756
old_tip = _mod_revision.ensure_null(self.last_revision())
1694
2757
self.pull(master, overwrite=True)
1695
if old_tip in self.repository.get_ancestry(self.last_revision()):
2758
if self.repository.get_graph().is_ancestor(old_tip,
2759
_mod_revision.ensure_null(self.last_revision())):
1701
class BzrBranchExperimental(BzrBranch5):
1702
"""Bzr experimental branch format
1705
- a revision-history file.
1707
- a lock dir guarding the branch itself
1708
- all of this stored in a branch/ subdirectory
1709
- works with shared repositories.
1710
- a tag dictionary in the branch
1712
This format is new in bzr 0.15, but shouldn't be used for real data,
1715
This class acts as it's own BranchFormat.
1718
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1721
def get_format_string(cls):
1722
"""See BranchFormat.get_format_string()."""
1723
return "Bazaar-NG branch format experimental\n"
1726
def get_format_description(cls):
1727
"""See BranchFormat.get_format_description()."""
1728
return "Experimental branch format"
1731
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1733
branch_transport = a_bzrdir.get_branch_transport(cls)
1734
control_files = lockable_files.LockableFiles(branch_transport,
1735
lock_filename, lock_class)
1736
control_files.create_lock()
1737
control_files.lock_write()
2765
class BzrBranch8(BzrBranch5):
2766
"""A branch that stores tree-reference locations."""
2768
def _open_hook(self):
2769
if self._ignore_fallbacks:
1739
for filename, content in utf8_files:
1740
control_files.put_utf8(filename, content)
1742
control_files.unlock()
1745
def initialize(cls, a_bzrdir):
1746
"""Create a branch of this format in a_bzrdir."""
1747
utf8_files = [('format', cls.get_format_string()),
1748
('revision-history', ''),
1749
('branch-name', ''),
1752
cls._initialize_control_files(a_bzrdir, utf8_files,
1753
'lock', lockdir.LockDir)
1754
return cls.open(a_bzrdir, _found=True)
1757
def open(cls, a_bzrdir, _found=False):
1758
"""Return the branch object for a_bzrdir
1760
_found is a private parameter, do not use it. It is used to indicate
1761
if format probing has already be done.
1764
format = BranchFormat.find_format(a_bzrdir)
1765
assert format.__class__ == cls
1766
transport = a_bzrdir.get_branch_transport(None)
1767
control_files = lockable_files.LockableFiles(transport, 'lock',
1769
return cls(_format=cls,
1770
_control_files=control_files,
1772
_repository=a_bzrdir.find_repository())
1775
def is_supported(cls):
1778
def _make_tags(self):
1779
return BasicTags(self)
1782
def supports_tags(cls):
1786
BranchFormat.register_format(BzrBranchExperimental)
1789
class BzrBranch6(BzrBranch5):
1792
def last_revision_info(self):
1793
revision_string = self.control_files.get('last-revision').read()
2772
url = self.get_stacked_on_url()
2773
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2774
errors.UnstackableBranchFormat):
2777
for hook in Branch.hooks['transform_fallback_location']:
2778
url = hook(self, url)
2780
hook_name = Branch.hooks.get_hook_name(hook)
2781
raise AssertionError(
2782
"'transform_fallback_location' hook %s returned "
2783
"None, not a URL." % hook_name)
2784
self._activate_fallback_location(url)
2786
def __init__(self, *args, **kwargs):
2787
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2788
super(BzrBranch8, self).__init__(*args, **kwargs)
2789
self._last_revision_info_cache = None
2790
self._reference_info = None
2792
def _clear_cached_state(self):
2793
super(BzrBranch8, self)._clear_cached_state()
2794
self._last_revision_info_cache = None
2795
self._reference_info = None
2797
def _last_revision_info(self):
2798
revision_string = self._transport.get_bytes('last-revision')
1794
2799
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1795
2800
revision_id = cache_utf8.get_cached_utf8(revision_id)
1796
2801
revno = int(revno)
1797
2802
return revno, revision_id
1799
def last_revision(self):
1800
"""Return last revision id, or None"""
1801
revision_id = self.last_revision_info()[1]
1802
if revision_id == _mod_revision.NULL_REVISION:
1806
2804
def _write_last_revision_info(self, revno, revision_id):
1807
2805
"""Simply write out the revision id, with no checks.
1812
2810
Intended to be called by set_last_revision_info and
1813
2811
_write_revision_history.
1815
if revision_id is None:
1816
revision_id = 'null:'
2813
revision_id = _mod_revision.ensure_null(revision_id)
1817
2814
out_string = '%d %s\n' % (revno, revision_id)
1818
self.control_files.put_bytes('last-revision', out_string)
2815
self._transport.put_bytes('last-revision', out_string,
2816
mode=self.bzrdir._get_file_mode())
1820
2818
@needs_write_lock
1821
2819
def set_last_revision_info(self, revno, revision_id):
1822
revision_id = osutils.safe_revision_id(revision_id)
2820
revision_id = _mod_revision.ensure_null(revision_id)
2821
old_revno, old_revid = self.last_revision_info()
1823
2822
if self._get_append_revisions_only():
1824
2823
self._check_history_violation(revision_id)
2824
self._run_pre_change_branch_tip_hooks(revno, revision_id)
1825
2825
self._write_last_revision_info(revno, revision_id)
1826
2826
self._clear_cached_state()
2827
self._last_revision_info_cache = revno, revision_id
2828
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2830
def _synchronize_history(self, destination, revision_id):
2831
"""Synchronize last revision and revision history between branches.
2833
:see: Branch._synchronize_history
2835
# XXX: The base Branch has a fast implementation of this method based
2836
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2837
# that uses set_revision_history. This class inherits from BzrBranch5,
2838
# but wants the fast implementation, so it calls
2839
# Branch._synchronize_history directly.
2840
Branch._synchronize_history(self, destination, revision_id)
1828
2842
def _check_history_violation(self, revision_id):
1829
last_revision = self.last_revision()
1830
if last_revision is None:
2843
last_revision = _mod_revision.ensure_null(self.last_revision())
2844
if _mod_revision.is_null(last_revision):
1832
2846
if last_revision not in self._lefthand_history(revision_id):
1833
raise errors.AppendRevisionsOnlyViolation(self.base)
2847
raise errors.AppendRevisionsOnlyViolation(self.user_url)
1835
2849
def _gen_revision_history(self):
1836
2850
"""Generate the revision history from last revision
1838
history = list(self.repository.iter_reverse_revision_history(
1839
self.last_revision()))
2852
last_revno, last_revision = self.last_revision_info()
2853
self._extend_partial_history(stop_index=last_revno-1)
2854
return list(reversed(self._partial_revision_history_cache))
1843
2856
def _write_revision_history(self, history):
1844
2857
"""Factored out of set_revision_history.
1885
2879
"""Set the parent branch"""
1886
2880
return self._get_config_location('parent_location')
2883
def _set_all_reference_info(self, info_dict):
2884
"""Replace all reference info stored in a branch.
2886
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2889
writer = rio.RioWriter(s)
2890
for key, (tree_path, branch_location) in info_dict.iteritems():
2891
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2892
branch_location=branch_location)
2893
writer.write_stanza(stanza)
2894
self._transport.put_bytes('references', s.getvalue())
2895
self._reference_info = info_dict
2898
def _get_all_reference_info(self):
2899
"""Return all the reference info stored in a branch.
2901
:return: A dict of {file_id: (tree_path, branch_location)}
2903
if self._reference_info is not None:
2904
return self._reference_info
2905
rio_file = self._transport.get('references')
2907
stanzas = rio.read_stanzas(rio_file)
2908
info_dict = dict((s['file_id'], (s['tree_path'],
2909
s['branch_location'])) for s in stanzas)
2912
self._reference_info = info_dict
2915
def set_reference_info(self, file_id, tree_path, branch_location):
2916
"""Set the branch location to use for a tree reference.
2918
:param file_id: The file-id of the tree reference.
2919
:param tree_path: The path of the tree reference in the tree.
2920
:param branch_location: The location of the branch to retrieve tree
2923
info_dict = self._get_all_reference_info()
2924
info_dict[file_id] = (tree_path, branch_location)
2925
if None in (tree_path, branch_location):
2926
if tree_path is not None:
2927
raise ValueError('tree_path must be None when branch_location'
2929
if branch_location is not None:
2930
raise ValueError('branch_location must be None when tree_path'
2932
del info_dict[file_id]
2933
self._set_all_reference_info(info_dict)
2935
def get_reference_info(self, file_id):
2936
"""Get the tree_path and branch_location for a tree reference.
2938
:return: a tuple of (tree_path, branch_location)
2940
return self._get_all_reference_info().get(file_id, (None, None))
2942
def reference_parent(self, file_id, path, possible_transports=None):
2943
"""Return the parent branch for a tree-reference file_id.
2945
:param file_id: The file_id of the tree reference
2946
:param path: The path of the file_id in the tree
2947
:return: A branch associated with the file_id
2949
branch_location = self.get_reference_info(file_id)[1]
2950
if branch_location is None:
2951
return Branch.reference_parent(self, file_id, path,
2952
possible_transports)
2953
branch_location = urlutils.join(self.user_url, branch_location)
2954
return Branch.open(branch_location,
2955
possible_transports=possible_transports)
1888
2957
def set_push_location(self, location):
1889
2958
"""See Branch.set_push_location."""
1890
2959
self._set_config_location('push_location', location)
1923
2992
"""See Branch.get_old_bound_location"""
1924
2993
return self._get_bound_location(False)
1926
def set_append_revisions_only(self, enabled):
1931
self.get_config().set_user_option('append_revisions_only', value)
2995
def get_stacked_on_url(self):
2996
# you can always ask for the URL; but you might not be able to use it
2997
# if the repo can't support stacking.
2998
## self._check_stackable_repo()
2999
stacked_url = self._get_config_location('stacked_on_location')
3000
if stacked_url is None:
3001
raise errors.NotStacked(self)
1933
3004
def _get_append_revisions_only(self):
1934
value = self.get_config().get_user_option('append_revisions_only')
1935
return value == 'True'
1937
def _synchronize_history(self, destination, revision_id):
1938
"""Synchronize last revision and revision history between branches.
1940
This version is most efficient when the destination is also a
1941
BzrBranch6, but works for BzrBranch5, as long as the destination's
1942
repository contains all the lefthand ancestors of the intended
1943
last_revision. If not, set_last_revision_info will fail.
1945
:param destination: The branch to copy the history into
1946
:param revision_id: The revision-id to truncate history at. May
1947
be None to copy complete history.
1949
if revision_id is None:
1950
revno, revision_id = self.last_revision_info()
3005
return self.get_config(
3006
).get_user_option_as_bool('append_revisions_only')
3009
def generate_revision_history(self, revision_id, last_rev=None,
3011
"""See BzrBranch5.generate_revision_history"""
3012
history = self._lefthand_history(revision_id, last_rev, other_branch)
3013
revno = len(history)
3014
self.set_last_revision_info(revno, revision_id)
3017
def get_rev_id(self, revno, history=None):
3018
"""Find the revision id of the specified revno."""
3020
return _mod_revision.NULL_REVISION
3022
last_revno, last_revision_id = self.last_revision_info()
3023
if revno <= 0 or revno > last_revno:
3024
raise errors.NoSuchRevision(self, revno)
3026
if history is not None:
3027
return history[revno - 1]
3029
index = last_revno - revno
3030
if len(self._partial_revision_history_cache) <= index:
3031
self._extend_partial_history(stop_index=index)
3032
if len(self._partial_revision_history_cache) > index:
3033
return self._partial_revision_history_cache[index]
1952
revno = self.revision_id_to_revno(revision_id)
1953
destination.set_last_revision_info(revno, revision_id)
1955
def _make_tags(self):
1956
return BasicTags(self)
1959
class BranchTestProviderAdapter(object):
1960
"""A tool to generate a suite testing multiple branch formats at once.
1962
This is done by copying the test once for each transport and injecting
1963
the transport_server, transport_readonly_server, and branch_format
1964
classes into each copy. Each copy is also given a new id() to make it
3035
raise errors.NoSuchRevision(self, revno)
3038
def revision_id_to_revno(self, revision_id):
3039
"""Given a revision id, return its revno"""
3040
if _mod_revision.is_null(revision_id):
3043
index = self._partial_revision_history_cache.index(revision_id)
3045
self._extend_partial_history(stop_revision=revision_id)
3046
index = len(self._partial_revision_history_cache) - 1
3047
if self._partial_revision_history_cache[index] != revision_id:
3048
raise errors.NoSuchRevision(self, revision_id)
3049
return self.revno() - index
3052
class BzrBranch7(BzrBranch8):
3053
"""A branch with support for a fallback repository."""
3055
def set_reference_info(self, file_id, tree_path, branch_location):
3056
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3058
def get_reference_info(self, file_id):
3059
Branch.get_reference_info(self, file_id)
3061
def reference_parent(self, file_id, path, possible_transports=None):
3062
return Branch.reference_parent(self, file_id, path,
3063
possible_transports)
3066
class BzrBranch6(BzrBranch7):
3067
"""See BzrBranchFormat6 for the capabilities of this branch.
3069
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
1968
def __init__(self, transport_server, transport_readonly_server, formats):
1969
self._transport_server = transport_server
1970
self._transport_readonly_server = transport_readonly_server
1971
self._formats = formats
1973
def adapt(self, test):
1974
result = TestSuite()
1975
for branch_format, bzrdir_format in self._formats:
1976
new_test = deepcopy(test)
1977
new_test.transport_server = self._transport_server
1978
new_test.transport_readonly_server = self._transport_readonly_server
1979
new_test.bzrdir_format = bzrdir_format
1980
new_test.branch_format = branch_format
1981
def make_new_test_id():
1982
# the format can be either a class or an instance
1983
name = getattr(branch_format, '__name__',
1984
branch_format.__class__.__name__)
1985
new_id = "%s(%s)" % (new_test.id(), name)
1986
return lambda: new_id
1987
new_test.id = make_new_test_id()
1988
result.addTest(new_test)
3073
def get_stacked_on_url(self):
3074
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1992
3077
######################################################################
2090
3188
new_branch.tags._set_tag_dict({})
2092
3190
# Copying done; now update target format
2093
new_branch.control_files.put_utf8('format',
2094
format.get_format_string())
3191
new_branch._transport.put_bytes('format',
3192
format.get_format_string(),
3193
mode=new_branch.bzrdir._get_file_mode())
2096
3195
# Clean up old files
2097
new_branch.control_files._transport.delete('revision-history')
3196
new_branch._transport.delete('revision-history')
2099
3198
branch.set_parent(None)
3199
except errors.NoSuchFile:
2102
3201
branch.set_bound_location(None)
3204
class Converter6to7(object):
3205
"""Perform an in-place upgrade of format 6 to format 7"""
3207
def convert(self, branch):
3208
format = BzrBranchFormat7()
3209
branch._set_config_location('stacked_on_location', '')
3210
# update target format
3211
branch._transport.put_bytes('format', format.get_format_string())
3214
class Converter7to8(object):
3215
"""Perform an in-place upgrade of format 6 to format 7"""
3217
def convert(self, branch):
3218
format = BzrBranchFormat8()
3219
branch._transport.put_bytes('references', '')
3220
# update target format
3221
branch._transport.put_bytes('format', format.get_format_string())
3224
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3225
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3228
_run_with_write_locked_target will attempt to release the lock it acquires.
3230
If an exception is raised by callable, then that exception *will* be
3231
propagated, even if the unlock attempt raises its own error. Thus
3232
_run_with_write_locked_target should be preferred to simply doing::
3236
return callable(*args, **kwargs)
3241
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3242
# should share code?
3245
result = callable(*args, **kwargs)
3247
exc_info = sys.exc_info()
3251
raise exc_info[0], exc_info[1], exc_info[2]
3257
class InterBranch(InterObject):
3258
"""This class represents operations taking place between two branches.
3260
Its instances have methods like pull() and push() and contain
3261
references to the source and target repositories these operations
3262
can be carried out on.
3266
"""The available optimised InterBranch types."""
3269
def _get_branch_formats_to_test(klass):
3270
"""Return an iterable of format tuples for testing.
3272
:return: An iterable of (from_format, to_format) to use when testing
3273
this InterBranch class. Each InterBranch class should define this
3276
raise NotImplementedError(klass._get_branch_formats_to_test)
3279
def pull(self, overwrite=False, stop_revision=None,
3280
possible_transports=None, local=False):
3281
"""Mirror source into target branch.
3283
The target branch is considered to be 'local', having low latency.
3285
:returns: PullResult instance
3287
raise NotImplementedError(self.pull)
3290
def update_revisions(self, stop_revision=None, overwrite=False,
3292
"""Pull in new perfect-fit revisions.
3294
:param stop_revision: Updated until the given revision
3295
:param overwrite: Always set the branch pointer, rather than checking
3296
to see if it is a proper descendant.
3297
:param graph: A Graph object that can be used to query history
3298
information. This can be None.
3301
raise NotImplementedError(self.update_revisions)
3304
def push(self, overwrite=False, stop_revision=None,
3305
_override_hook_source_branch=None):
3306
"""Mirror the source branch into the target branch.
3308
The source branch is considered to be 'local', having low latency.
3310
raise NotImplementedError(self.push)
3313
class GenericInterBranch(InterBranch):
3314
"""InterBranch implementation that uses public Branch functions."""
3317
def is_compatible(klass, source, target):
3318
# GenericBranch uses the public API, so always compatible
3322
def _get_branch_formats_to_test(klass):
3323
return [(BranchFormat._default_format, BranchFormat._default_format)]
3326
def unwrap_format(klass, format):
3327
if isinstance(format, remote.RemoteBranchFormat):
3328
format._ensure_real()
3329
return format._custom_format
3333
def copy_content_into(self, revision_id=None):
3334
"""Copy the content of source into target
3336
revision_id: if not None, the revision history in the new branch will
3337
be truncated to end with revision_id.
3339
self.source.update_references(self.target)
3340
self.source._synchronize_history(self.target, revision_id)
3342
parent = self.source.get_parent()
3343
except errors.InaccessibleParent, e:
3344
mutter('parent was not accessible to copy: %s', e)
3347
self.target.set_parent(parent)
3348
if self.source._push_should_merge_tags():
3349
self.source.tags.merge_to(self.target.tags)
3352
def update_revisions(self, stop_revision=None, overwrite=False,
3354
"""See InterBranch.update_revisions()."""
3355
other_revno, other_last_revision = self.source.last_revision_info()
3356
stop_revno = None # unknown
3357
if stop_revision is None:
3358
stop_revision = other_last_revision
3359
if _mod_revision.is_null(stop_revision):
3360
# if there are no commits, we're done.
3362
stop_revno = other_revno
3364
# what's the current last revision, before we fetch [and change it
3366
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3367
# we fetch here so that we don't process data twice in the common
3368
# case of having something to pull, and so that the check for
3369
# already merged can operate on the just fetched graph, which will
3370
# be cached in memory.
3371
self.target.fetch(self.source, stop_revision)
3372
# Check to see if one is an ancestor of the other
3375
graph = self.target.repository.get_graph()
3376
if self.target._check_if_descendant_or_diverged(
3377
stop_revision, last_rev, graph, self.source):
3378
# stop_revision is a descendant of last_rev, but we aren't
3379
# overwriting, so we're done.
3381
if stop_revno is None:
3383
graph = self.target.repository.get_graph()
3384
this_revno, this_last_revision = \
3385
self.target.last_revision_info()
3386
stop_revno = graph.find_distance_to_null(stop_revision,
3387
[(other_last_revision, other_revno),
3388
(this_last_revision, this_revno)])
3389
self.target.set_last_revision_info(stop_revno, stop_revision)
3392
def pull(self, overwrite=False, stop_revision=None,
3393
possible_transports=None, run_hooks=True,
3394
_override_hook_target=None, local=False):
3395
"""Pull from source into self, updating my master if any.
3397
:param run_hooks: Private parameter - if false, this branch
3398
is being called because it's the master of the primary branch,
3399
so it should not run its hooks.
3401
bound_location = self.target.get_bound_location()
3402
if local and not bound_location:
3403
raise errors.LocalRequiresBoundBranch()
3404
master_branch = None
3405
if not local and bound_location and self.source.user_url != bound_location:
3406
# not pulling from master, so we need to update master.
3407
master_branch = self.target.get_master_branch(possible_transports)
3408
master_branch.lock_write()
3411
# pull from source into master.
3412
master_branch.pull(self.source, overwrite, stop_revision,
3414
return self._pull(overwrite,
3415
stop_revision, _hook_master=master_branch,
3416
run_hooks=run_hooks,
3417
_override_hook_target=_override_hook_target)
3420
master_branch.unlock()
3422
def push(self, overwrite=False, stop_revision=None,
3423
_override_hook_source_branch=None):
3424
"""See InterBranch.push.
3426
This is the basic concrete implementation of push()
3428
:param _override_hook_source_branch: If specified, run
3429
the hooks passing this Branch as the source, rather than self.
3430
This is for use of RemoteBranch, where push is delegated to the
3431
underlying vfs-based Branch.
3433
# TODO: Public option to disable running hooks - should be trivial but
3435
self.source.lock_read()
3437
return _run_with_write_locked_target(
3438
self.target, self._push_with_bound_branches, overwrite,
3440
_override_hook_source_branch=_override_hook_source_branch)
3442
self.source.unlock()
3444
def _push_with_bound_branches(self, overwrite, stop_revision,
3445
_override_hook_source_branch=None):
3446
"""Push from source into target, and into target's master if any.
3449
if _override_hook_source_branch:
3450
result.source_branch = _override_hook_source_branch
3451
for hook in Branch.hooks['post_push']:
3454
bound_location = self.target.get_bound_location()
3455
if bound_location and self.target.base != bound_location:
3456
# there is a master branch.
3458
# XXX: Why the second check? Is it even supported for a branch to
3459
# be bound to itself? -- mbp 20070507
3460
master_branch = self.target.get_master_branch()
3461
master_branch.lock_write()
3463
# push into the master from the source branch.
3464
self.source._basic_push(master_branch, overwrite, stop_revision)
3465
# and push into the target branch from the source. Note that we
3466
# push from the source branch again, because its considered the
3467
# highest bandwidth repository.
3468
result = self.source._basic_push(self.target, overwrite,
3470
result.master_branch = master_branch
3471
result.local_branch = self.target
3475
master_branch.unlock()
3478
result = self.source._basic_push(self.target, overwrite,
3480
# TODO: Why set master_branch and local_branch if there's no
3481
# binding? Maybe cleaner to just leave them unset? -- mbp
3483
result.master_branch = self.target
3484
result.local_branch = None
3488
def _pull(self, overwrite=False, stop_revision=None,
3489
possible_transports=None, _hook_master=None, run_hooks=True,
3490
_override_hook_target=None, local=False):
3493
This function is the core worker, used by GenericInterBranch.pull to
3494
avoid duplication when pulling source->master and source->local.
3496
:param _hook_master: Private parameter - set the branch to
3497
be supplied as the master to pull hooks.
3498
:param run_hooks: Private parameter - if false, this branch
3499
is being called because it's the master of the primary branch,
3500
so it should not run its hooks.
3501
:param _override_hook_target: Private parameter - set the branch to be
3502
supplied as the target_branch to pull hooks.
3503
:param local: Only update the local branch, and not the bound branch.
3505
# This type of branch can't be bound.
3507
raise errors.LocalRequiresBoundBranch()
3508
result = PullResult()
3509
result.source_branch = self.source
3510
if _override_hook_target is None:
3511
result.target_branch = self.target
3513
result.target_branch = _override_hook_target
3514
self.source.lock_read()
3516
# We assume that during 'pull' the target repository is closer than
3518
self.source.update_references(self.target)
3519
graph = self.target.repository.get_graph(self.source.repository)
3520
# TODO: Branch formats should have a flag that indicates
3521
# that revno's are expensive, and pull() should honor that flag.
3523
result.old_revno, result.old_revid = \
3524
self.target.last_revision_info()
3525
self.target.update_revisions(self.source, stop_revision,
3526
overwrite=overwrite, graph=graph)
3527
# TODO: The old revid should be specified when merging tags,
3528
# so a tags implementation that versions tags can only
3529
# pull in the most recent changes. -- JRV20090506
3530
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3532
result.new_revno, result.new_revid = self.target.last_revision_info()
3534
result.master_branch = _hook_master
3535
result.local_branch = result.target_branch
3537
result.master_branch = result.target_branch
3538
result.local_branch = None
3540
for hook in Branch.hooks['post_pull']:
3543
self.source.unlock()
3547
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
