140
115
if master is not None:
141
116
master.break_lock()
143
def _check_stackable_repo(self):
144
if not self.repository._format.supports_external_lookups:
145
raise errors.UnstackableRepositoryFormat(self.repository._format,
146
self.repository.base)
148
def _extend_partial_history(self, stop_index=None, stop_revision=None):
149
"""Extend the partial history to include a given index
151
If a stop_index is supplied, stop when that index has been reached.
152
If a stop_revision is supplied, stop when that revision is
153
encountered. Otherwise, stop when the beginning of history is
156
:param stop_index: The index which should be present. When it is
157
present, history extension will stop.
158
:param stop_revision: The revision id which should be present. When
159
it is encountered, history extension will stop.
161
if len(self._partial_revision_history_cache) == 0:
162
self._partial_revision_history_cache = [self.last_revision()]
163
repository._iter_for_revno(
164
self.repository, self._partial_revision_history_cache,
165
stop_index=stop_index, stop_revision=stop_revision)
166
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
167
self._partial_revision_history_cache.pop()
169
def _get_check_refs(self):
170
"""Get the references needed for check().
174
revid = self.last_revision()
175
return [('revision-existence', revid), ('lefthand-distance', revid)]
178
def open(base, _unsupported=False, possible_transports=None):
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):
179
126
"""Open the branch rooted at base.
181
128
For instance, if the branch is at URL/.bzr/branch,
182
129
Branch.open(URL) -> a Branch instance.
184
control = bzrdir.BzrDir.open(base, _unsupported,
185
possible_transports=possible_transports)
186
return control.open_branch(unsupported=_unsupported)
189
def open_from_transport(transport, name=None, _unsupported=False):
190
"""Open the branch rooted at transport"""
191
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
192
return control.open_branch(name=name, unsupported=_unsupported)
195
def open_containing(url, possible_transports=None):
131
control = bzrdir.BzrDir.open(base, _unsupported)
132
return control.open_branch(_unsupported)
135
def open_containing(url):
196
136
"""Open an existing branch which contains url.
198
138
This probes for a branch at url, and searches upwards from there.
200
140
Basically we keep looking up until we find the control directory or
201
141
run into the root. If there isn't one, raises NotBranchError.
202
If there is one and it is either an unrecognised format or an unsupported
142
If there is one and it is either an unrecognised format or an unsupported
203
143
format, UnknownFormatError or UnsupportedFormatError are raised.
204
144
If there is one, it is returned, along with the unused portion of url.
206
control, relpath = bzrdir.BzrDir.open_containing(url,
146
control, relpath = bzrdir.BzrDir.open_containing(url)
208
147
return control.open_branch(), relpath
210
def _push_should_merge_tags(self):
211
"""Should _basic_push merge this branch's tags into the target?
213
The default implementation returns False if this branch has no tags,
214
and True the rest of the time. Subclasses may override this.
216
return self.supports_tags() and self.tags.get_tag_dict()
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.
218
168
def get_config(self):
219
"""Get a bzrlib.config.BranchConfig for this Branch.
221
This can then be used to get and set configuration options for the
224
:return: A bzrlib.config.BranchConfig.
226
169
return BranchConfig(self)
228
def _get_config(self):
229
"""Get the concrete config for just the config in this branch.
231
This is not intended for client use; see Branch.get_config for the
236
:return: An object supporting get_option and set_option.
238
raise NotImplementedError(self._get_config)
240
def _get_fallback_repository(self, url):
241
"""Get the repository we fallback to at url."""
242
url = urlutils.join(self.base, url)
243
a_branch = Branch.open(url,
244
possible_transports=[self.bzrdir.root_transport])
245
return a_branch.repository
248
def _get_tags_bytes(self):
249
"""Get the bytes of a serialised tags dict.
251
Note that not all branches support tags, nor do all use the same tags
252
logic: this method is specific to BasicTags. Other tag implementations
253
may use the same method name and behave differently, safely, because
254
of the double-dispatch via
255
format.make_tags->tags_instance->get_tags_dict.
257
:return: The bytes of the tags file.
258
:seealso: Branch._set_tags_bytes.
260
if self._tags_bytes is None:
261
self._tags_bytes = self._transport.get_bytes('tags')
262
return self._tags_bytes
264
def _get_nick(self, local=False, possible_transports=None):
265
config = self.get_config()
266
# explicit overrides master, but don't look for master if local is True
267
if not local and not config.has_explicit_nickname():
269
master = self.get_master_branch(possible_transports)
270
if master and self.user_url == master.user_url:
271
raise errors.RecursiveBind(self.user_url)
272
if master is not None:
273
# return the master branch value
275
except errors.RecursiveBind, e:
277
except errors.BzrError, e:
278
# Silently fall back to local implicit nick if the master is
280
mutter("Could not connect to bound branch, "
281
"falling back to local nick.\n " + str(e))
282
return config.get_nickname()
172
return self.get_config().get_nickname()
284
174
def _set_nick(self, nick):
285
self.get_config().set_user_option('nickname', nick, warn_masked=True)
175
self.get_config().set_user_option('nickname', nick)
287
177
nick = property(_get_nick, _set_nick)
289
179
def is_locked(self):
290
180
raise NotImplementedError(self.is_locked)
292
def _lefthand_history(self, revision_id, last_rev=None,
294
if 'evil' in debug.debug_flags:
295
mutter_callsite(4, "_lefthand_history scales with history.")
296
# stop_revision must be a descendant of last_revision
297
graph = self.repository.get_graph()
298
if last_rev is not None:
299
if not graph.is_ancestor(last_rev, revision_id):
300
# our previous tip is not merged into stop_revision
301
raise errors.DivergedBranches(self, other_branch)
302
# make a new revision history from the graph
303
parents_map = graph.get_parent_map([revision_id])
304
if revision_id not in parents_map:
305
raise errors.NoSuchRevision(self, revision_id)
306
current_rev_id = revision_id
308
check_not_reserved_id = _mod_revision.check_not_reserved_id
309
# Do not include ghosts or graph origin in revision_history
310
while (current_rev_id in parents_map and
311
len(parents_map[current_rev_id]) > 0):
312
check_not_reserved_id(current_rev_id)
313
new_history.append(current_rev_id)
314
current_rev_id = parents_map[current_rev_id][0]
315
parents_map = graph.get_parent_map([current_rev_id])
316
new_history.reverse()
319
def lock_write(self, token=None):
320
"""Lock the branch for write operations.
322
:param token: A token to permit reacquiring a previously held and
324
:return: A BranchWriteLockResult.
182
def lock_write(self):
326
183
raise NotImplementedError(self.lock_write)
328
185
def lock_read(self):
329
"""Lock the branch for read operations.
331
:return: A bzrlib.lock.LogicalLockResult.
333
186
raise NotImplementedError(self.lock_read)
335
188
def unlock(self):
342
195
def get_physical_lock_status(self):
343
196
raise NotImplementedError(self.get_physical_lock_status)
346
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
347
"""Return the revision_id for a dotted revno.
349
:param revno: a tuple like (1,) or (1,1,2)
350
:param _cache_reverse: a private parameter enabling storage
351
of the reverse mapping in a top level cache. (This should
352
only be done in selective circumstances as we want to
353
avoid having the mapping cached multiple times.)
354
:return: the revision_id
355
:raises errors.NoSuchRevision: if the revno doesn't exist
357
rev_id = self._do_dotted_revno_to_revision_id(revno)
359
self._partial_revision_id_to_revno_cache[rev_id] = revno
362
def _do_dotted_revno_to_revision_id(self, revno):
363
"""Worker function for dotted_revno_to_revision_id.
365
Subclasses should override this if they wish to
366
provide a more efficient implementation.
369
return self.get_rev_id(revno[0])
370
revision_id_to_revno = self.get_revision_id_to_revno_map()
371
revision_ids = [revision_id for revision_id, this_revno
372
in revision_id_to_revno.iteritems()
373
if revno == this_revno]
374
if len(revision_ids) == 1:
375
return revision_ids[0]
377
revno_str = '.'.join(map(str, revno))
378
raise errors.NoSuchRevision(self, revno_str)
381
def revision_id_to_dotted_revno(self, revision_id):
382
"""Given a revision id, return its dotted revno.
384
:return: a tuple like (1,) or (400,1,3).
386
return self._do_revision_id_to_dotted_revno(revision_id)
388
def _do_revision_id_to_dotted_revno(self, revision_id):
389
"""Worker function for revision_id_to_revno."""
390
# Try the caches if they are loaded
391
result = self._partial_revision_id_to_revno_cache.get(revision_id)
392
if result is not None:
394
if self._revision_id_to_revno_cache:
395
result = self._revision_id_to_revno_cache.get(revision_id)
397
raise errors.NoSuchRevision(self, revision_id)
398
# Try the mainline as it's optimised
400
revno = self.revision_id_to_revno(revision_id)
402
except errors.NoSuchRevision:
403
# We need to load and use the full revno map after all
404
result = self.get_revision_id_to_revno_map().get(revision_id)
406
raise errors.NoSuchRevision(self, revision_id)
410
def get_revision_id_to_revno_map(self):
411
"""Return the revision_id => dotted revno map.
413
This will be regenerated on demand, but will be cached.
415
:return: A dictionary mapping revision_id => dotted revno.
416
This dictionary should not be modified by the caller.
418
if self._revision_id_to_revno_cache is not None:
419
mapping = self._revision_id_to_revno_cache
421
mapping = self._gen_revno_map()
422
self._cache_revision_id_to_revno(mapping)
423
# TODO: jam 20070417 Since this is being cached, should we be returning
425
# I would rather not, and instead just declare that users should not
426
# modify the return value.
429
def _gen_revno_map(self):
430
"""Create a new mapping from revision ids to dotted revnos.
432
Dotted revnos are generated based on the current tip in the revision
434
This is the worker function for get_revision_id_to_revno_map, which
435
just caches the return value.
437
:return: A dictionary mapping revision_id => dotted revno.
439
revision_id_to_revno = dict((rev_id, revno)
440
for rev_id, depth, revno, end_of_merge
441
in self.iter_merge_sorted_revisions())
442
return revision_id_to_revno
445
def iter_merge_sorted_revisions(self, start_revision_id=None,
446
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
447
"""Walk the revisions for a branch in merge sorted order.
449
Merge sorted order is the output from a merge-aware,
450
topological sort, i.e. all parents come before their
451
children going forward; the opposite for reverse.
453
:param start_revision_id: the revision_id to begin walking from.
454
If None, the branch tip is used.
455
:param stop_revision_id: the revision_id to terminate the walk
456
after. If None, the rest of history is included.
457
:param stop_rule: if stop_revision_id is not None, the precise rule
458
to use for termination:
459
* 'exclude' - leave the stop revision out of the result (default)
460
* 'include' - the stop revision is the last item in the result
461
* 'with-merges' - include the stop revision and all of its
462
merged revisions in the result
463
* 'with-merges-without-common-ancestry' - filter out revisions
464
that are in both ancestries
465
:param direction: either 'reverse' or 'forward':
466
* reverse means return the start_revision_id first, i.e.
467
start at the most recent revision and go backwards in history
468
* forward returns tuples in the opposite order to reverse.
469
Note in particular that forward does *not* do any intelligent
470
ordering w.r.t. depth as some clients of this API may like.
471
(If required, that ought to be done at higher layers.)
473
:return: an iterator over (revision_id, depth, revno, end_of_merge)
476
* revision_id: the unique id of the revision
477
* depth: How many levels of merging deep this node has been
479
* revno_sequence: This field provides a sequence of
480
revision numbers for all revisions. The format is:
481
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
482
branch that the revno is on. From left to right the REVNO numbers
483
are the sequence numbers within that branch of the revision.
484
* end_of_merge: When True the next node (earlier in history) is
485
part of a different merge.
487
# Note: depth and revno values are in the context of the branch so
488
# we need the full graph to get stable numbers, regardless of the
490
if self._merge_sorted_revisions_cache is None:
491
last_revision = self.last_revision()
492
known_graph = self.repository.get_known_graph_ancestry(
494
self._merge_sorted_revisions_cache = known_graph.merge_sort(
496
filtered = self._filter_merge_sorted_revisions(
497
self._merge_sorted_revisions_cache, start_revision_id,
498
stop_revision_id, stop_rule)
499
# Make sure we don't return revisions that are not part of the
500
# start_revision_id ancestry.
501
filtered = self._filter_start_non_ancestors(filtered)
502
if direction == 'reverse':
504
if direction == 'forward':
505
return reversed(list(filtered))
507
raise ValueError('invalid direction %r' % direction)
509
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
510
start_revision_id, stop_revision_id, stop_rule):
511
"""Iterate over an inclusive range of sorted revisions."""
512
rev_iter = iter(merge_sorted_revisions)
513
if start_revision_id is not None:
514
for node in rev_iter:
515
rev_id = node.key[-1]
516
if rev_id != start_revision_id:
519
# The decision to include the start or not
520
# depends on the stop_rule if a stop is provided
521
# so pop this node back into the iterator
522
rev_iter = chain(iter([node]), rev_iter)
524
if stop_revision_id is None:
526
for node in rev_iter:
527
rev_id = node.key[-1]
528
yield (rev_id, node.merge_depth, node.revno,
530
elif stop_rule == 'exclude':
531
for node in rev_iter:
532
rev_id = node.key[-1]
533
if rev_id == stop_revision_id:
535
yield (rev_id, node.merge_depth, node.revno,
537
elif stop_rule == 'include':
538
for node in rev_iter:
539
rev_id = node.key[-1]
540
yield (rev_id, node.merge_depth, node.revno,
542
if rev_id == stop_revision_id:
544
elif stop_rule == 'with-merges-without-common-ancestry':
545
# We want to exclude all revisions that are already part of the
546
# stop_revision_id ancestry.
547
graph = self.repository.get_graph()
548
ancestors = graph.find_unique_ancestors(start_revision_id,
550
for node in rev_iter:
551
rev_id = node.key[-1]
552
if rev_id not in ancestors:
554
yield (rev_id, node.merge_depth, node.revno,
556
elif stop_rule == 'with-merges':
557
stop_rev = self.repository.get_revision(stop_revision_id)
558
if stop_rev.parent_ids:
559
left_parent = stop_rev.parent_ids[0]
561
left_parent = _mod_revision.NULL_REVISION
562
# left_parent is the actual revision we want to stop logging at,
563
# since we want to show the merged revisions after the stop_rev too
564
reached_stop_revision_id = False
565
revision_id_whitelist = []
566
for node in rev_iter:
567
rev_id = node.key[-1]
568
if rev_id == left_parent:
569
# reached the left parent after the stop_revision
571
if (not reached_stop_revision_id or
572
rev_id in revision_id_whitelist):
573
yield (rev_id, node.merge_depth, node.revno,
575
if reached_stop_revision_id or rev_id == stop_revision_id:
576
# only do the merged revs of rev_id from now on
577
rev = self.repository.get_revision(rev_id)
579
reached_stop_revision_id = True
580
revision_id_whitelist.extend(rev.parent_ids)
582
raise ValueError('invalid stop_rule %r' % stop_rule)
584
def _filter_start_non_ancestors(self, rev_iter):
585
# If we started from a dotted revno, we want to consider it as a tip
586
# and don't want to yield revisions that are not part of its
587
# ancestry. Given the order guaranteed by the merge sort, we will see
588
# uninteresting descendants of the first parent of our tip before the
590
first = rev_iter.next()
591
(rev_id, merge_depth, revno, end_of_merge) = first
594
# We start at a mainline revision so by definition, all others
595
# revisions in rev_iter are ancestors
596
for node in rev_iter:
601
pmap = self.repository.get_parent_map([rev_id])
602
parents = pmap.get(rev_id, [])
604
whitelist.update(parents)
606
# If there is no parents, there is nothing of interest left
608
# FIXME: It's hard to test this scenario here as this code is never
609
# called in that case. -- vila 20100322
612
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
614
if rev_id in whitelist:
615
pmap = self.repository.get_parent_map([rev_id])
616
parents = pmap.get(rev_id, [])
617
whitelist.remove(rev_id)
618
whitelist.update(parents)
620
# We've reached the mainline, there is nothing left to
624
# A revision that is not part of the ancestry of our
627
yield (rev_id, merge_depth, revno, end_of_merge)
629
198
def leave_lock_in_place(self):
630
199
"""Tell this branch object not to release the physical lock when this
631
200
object is unlocked.
633
202
If lock_write doesn't return a token, then this method is not supported.
635
204
self.control_files.leave_in_place()
728
308
The delta is relative to its mainline predecessor, or the
729
309
empty tree for revision 1.
311
assert isinstance(revno, int)
731
312
rh = self.revision_history()
732
313
if not (1 <= revno <= len(rh)):
733
raise errors.InvalidRevisionNumber(revno)
314
raise InvalidRevisionNumber(revno)
734
315
return self.repository.get_revision_delta(rh[revno-1])
736
def get_stacked_on_url(self):
737
"""Get the URL this branch is stacked against.
317
@deprecated_method(zero_sixteen)
318
def get_root_id(self):
319
"""Return the id of this branches root
739
:raises NotStacked: If the branch is not stacked.
740
:raises UnstackableBranchFormat: If the branch does not support
321
Deprecated: branches don't have root ids-- trees do.
322
Use basis_tree().get_root_id() instead.
743
raise NotImplementedError(self.get_stacked_on_url)
324
raise NotImplementedError(self.get_root_id)
745
326
def print_file(self, file, revision_id):
746
327
"""Print `file` to stdout."""
747
328
raise NotImplementedError(self.print_file)
330
def append_revision(self, *revision_ids):
331
raise NotImplementedError(self.append_revision)
749
333
def set_revision_history(self, rev_history):
750
334
raise NotImplementedError(self.set_revision_history)
753
def set_parent(self, url):
754
"""See Branch.set_parent."""
755
# TODO: Maybe delete old location files?
756
# URLs should never be unicode, even on the local fs,
757
# FIXUP this and get_parent in a future branch format bump:
758
# read and rewrite the file. RBC 20060125
760
if isinstance(url, unicode):
762
url = url.encode('ascii')
763
except UnicodeEncodeError:
764
raise errors.InvalidURL(url,
765
"Urls must be 7-bit ascii, "
766
"use bzrlib.urlutils.escape")
767
url = urlutils.relative_url(self.base, url)
768
self._set_parent_location(url)
771
def set_stacked_on_url(self, url):
772
"""Set the URL this branch is stacked against.
774
:raises UnstackableBranchFormat: If the branch does not support
776
:raises UnstackableRepositoryFormat: If the repository does not support
779
if not self._format.supports_stacking():
780
raise errors.UnstackableBranchFormat(self._format, self.user_url)
781
# XXX: Changing from one fallback repository to another does not check
782
# that all the data you need is present in the new fallback.
783
# Possibly it should.
784
self._check_stackable_repo()
787
old_url = self.get_stacked_on_url()
788
except (errors.NotStacked, errors.UnstackableBranchFormat,
789
errors.UnstackableRepositoryFormat):
793
self._activate_fallback_location(url)
794
# write this out after the repository is stacked to avoid setting a
795
# stacked config that doesn't work.
796
self._set_config_location('stacked_on_location', url)
799
"""Change a branch to be unstacked, copying data as needed.
801
Don't call this directly, use set_stacked_on_url(None).
803
pb = ui.ui_factory.nested_progress_bar()
805
pb.update("Unstacking")
806
# The basic approach here is to fetch the tip of the branch,
807
# including all available ghosts, from the existing stacked
808
# repository into a new repository object without the fallbacks.
810
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
811
# correct for CHKMap repostiories
812
old_repository = self.repository
813
if len(old_repository._fallback_repositories) != 1:
814
raise AssertionError("can't cope with fallback repositories "
815
"of %r (fallbacks: %r)" % (old_repository,
816
old_repository._fallback_repositories))
817
# Open the new repository object.
818
# Repositories don't offer an interface to remove fallback
819
# repositories today; take the conceptually simpler option and just
820
# reopen it. We reopen it starting from the URL so that we
821
# get a separate connection for RemoteRepositories and can
822
# stream from one of them to the other. This does mean doing
823
# separate SSH connection setup, but unstacking is not a
824
# common operation so it's tolerable.
825
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
826
new_repository = new_bzrdir.find_repository()
827
if new_repository._fallback_repositories:
828
raise AssertionError("didn't expect %r to have "
829
"fallback_repositories"
830
% (self.repository,))
831
# Replace self.repository with the new repository.
832
# Do our best to transfer the lock state (i.e. lock-tokens and
833
# lock count) of self.repository to the new repository.
834
lock_token = old_repository.lock_write().repository_token
835
self.repository = new_repository
836
if isinstance(self, remote.RemoteBranch):
837
# Remote branches can have a second reference to the old
838
# repository that need to be replaced.
839
if self._real_branch is not None:
840
self._real_branch.repository = new_repository
841
self.repository.lock_write(token=lock_token)
842
if lock_token is not None:
843
old_repository.leave_lock_in_place()
844
old_repository.unlock()
845
if lock_token is not None:
846
# XXX: self.repository.leave_lock_in_place() before this
847
# function will not be preserved. Fortunately that doesn't
848
# affect the current default format (2a), and would be a
849
# corner-case anyway.
850
# - Andrew Bennetts, 2010/06/30
851
self.repository.dont_leave_lock_in_place()
855
old_repository.unlock()
856
except errors.LockNotHeld:
859
if old_lock_count == 0:
860
raise AssertionError(
861
'old_repository should have been locked at least once.')
862
for i in range(old_lock_count-1):
863
self.repository.lock_write()
864
# Fetch from the old repository into the new.
865
old_repository.lock_read()
867
# XXX: If you unstack a branch while it has a working tree
868
# with a pending merge, the pending-merged revisions will no
869
# longer be present. You can (probably) revert and remerge.
871
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
872
except errors.TagsNotSupported:
873
tags_to_fetch = set()
874
fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
875
old_repository, required_ids=[self.last_revision()],
876
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
877
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
879
old_repository.unlock()
883
def _set_tags_bytes(self, bytes):
884
"""Mirror method for _get_tags_bytes.
886
:seealso: Branch._get_tags_bytes.
888
return _run_with_write_locked_target(self, self._set_tags_bytes_locked,
891
def _set_tags_bytes_locked(self, bytes):
892
self._tags_bytes = bytes
893
return self._transport.put_bytes('tags', bytes)
895
336
def _cache_revision_history(self, rev_history):
896
337
"""Set the cached revision history to rev_history.
995
421
return (0, _mod_revision.NULL_REVISION)
997
@deprecated_method(deprecated_in((2, 4, 0)))
998
def import_last_revision_info(self, source_repo, revno, revid):
999
"""Set the last revision info, importing from another repo if necessary.
1001
:param source_repo: Source repository to optionally fetch from
1002
:param revno: Revision number of the new tip
1003
:param revid: Revision id of the new tip
1005
if not self.repository.has_same_location(source_repo):
1006
self.repository.fetch(source_repo, revision_id=revid)
1007
self.set_last_revision_info(revno, revid)
1009
def import_last_revision_info_and_tags(self, source, revno, revid,
1011
"""Set the last revision info, importing from another repo if necessary.
1013
This is used by the bound branch code to upload a revision to
1014
the master branch first before updating the tip of the local branch.
1015
Revisions referenced by source's tags are also transferred.
1017
:param source: Source branch to optionally fetch from
1018
:param revno: Revision number of the new tip
1019
:param revid: Revision id of the new tip
1020
:param lossy: Whether to discard metadata that can not be
1021
natively represented
1022
:return: Tuple with the new revision number and revision id
1023
(should only be different from the arguments when lossy=True)
1025
if not self.repository.has_same_location(source.repository):
1026
self.fetch(source, revid)
1027
self.set_last_revision_info(revno, revid)
1028
return (revno, revid)
423
def missing_revisions(self, other, stop_revision=None):
424
"""Return a list of new revisions that would perfectly fit.
426
If self and other have not diverged, return a list of the revisions
427
present in other, but missing from self.
429
self_history = self.revision_history()
430
self_len = len(self_history)
431
other_history = other.revision_history()
432
other_len = len(other_history)
433
common_index = min(self_len, other_len) -1
434
if common_index >= 0 and \
435
self_history[common_index] != other_history[common_index]:
436
raise DivergedBranches(self, other)
438
if stop_revision is None:
439
stop_revision = other_len
441
assert isinstance(stop_revision, int)
442
if stop_revision > other_len:
443
raise errors.NoSuchRevision(self, stop_revision)
444
return other_history[self_len:stop_revision]
446
def update_revisions(self, other, stop_revision=None):
447
"""Pull in new perfect-fit revisions.
449
:param other: Another Branch to pull from
450
:param stop_revision: Updated until the given revision
453
raise NotImplementedError(self.update_revisions)
1030
455
def revision_id_to_revno(self, revision_id):
1031
456
"""Given a revision id, return its revno"""
1032
if _mod_revision.is_null(revision_id):
457
if revision_id is None:
459
revision_id = osutils.safe_revision_id(revision_id)
1034
460
history = self.revision_history()
1036
462
return history.index(revision_id) + 1
1037
463
except ValueError:
1038
raise errors.NoSuchRevision(self, revision_id)
464
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1041
466
def get_rev_id(self, revno, history=None):
1042
467
"""Find the revision id of the specified revno."""
1044
return _mod_revision.NULL_REVISION
1045
last_revno, last_revid = self.last_revision_info()
1046
if revno == last_revno:
1048
if revno <= 0 or revno > last_revno:
1049
raise errors.NoSuchRevision(self, revno)
1050
distance_from_last = last_revno - revno
1051
if len(self._partial_revision_history_cache) <= distance_from_last:
1052
self._extend_partial_history(distance_from_last)
1053
return self._partial_revision_history_cache[distance_from_last]
471
history = self.revision_history()
472
if revno <= 0 or revno > len(history):
473
raise bzrlib.errors.NoSuchRevision(self, revno)
474
return history[revno - 1]
1055
def pull(self, source, overwrite=False, stop_revision=None,
1056
possible_transports=None, *args, **kwargs):
476
def pull(self, source, overwrite=False, stop_revision=None):
1057
477
"""Mirror source into this branch.
1059
479
This branch is considered to be 'local', having low latency.
1061
481
:returns: PullResult instance
1063
return InterBranch.get(source, self).pull(overwrite=overwrite,
1064
stop_revision=stop_revision,
1065
possible_transports=possible_transports, *args, **kwargs)
483
raise NotImplementedError(self.pull)
1067
def push(self, target, overwrite=False, stop_revision=None, *args,
485
def push(self, target, overwrite=False, stop_revision=None):
1069
486
"""Mirror this branch into target.
1071
488
This branch is considered to be 'local', having low latency.
1073
return InterBranch.get(self, target).push(overwrite, stop_revision,
1076
def lossy_push(self, target, stop_revision=None):
1077
"""Push deltas into another branch.
1079
:note: This does not, like push, retain the revision ids from
1080
the source branch and will, rather than adding bzr-specific
1081
metadata, push only those semantics of the revision that can be
1082
natively represented by this branch' VCS.
1084
:param target: Target branch
1085
:param stop_revision: Revision to push, defaults to last revision.
1086
:return: BranchPushResult with an extra member revidmap:
1087
A dictionary mapping revision ids from the target branch
1088
to new revision ids in the target branch, for each
1089
revision that was pushed.
1091
inter = InterBranch.get(self, target)
1092
lossy_push = getattr(inter, "lossy_push", None)
1093
if lossy_push is None:
1094
raise errors.LossyPushToSameVCS(self, target)
1095
return lossy_push(stop_revision)
490
raise NotImplementedError(self.push)
1097
492
def basis_tree(self):
1098
493
"""Return `Tree` object for last revision."""
1099
494
return self.repository.revision_tree(self.last_revision())
496
def rename_one(self, from_rel, to_rel):
499
This can change the directory or the filename or both.
501
raise NotImplementedError(self.rename_one)
503
def move(self, from_paths, to_name):
506
to_name must exist as a versioned directory.
508
If to_name exists and is a directory, the files are moved into
509
it, keeping their old names. If it is a directory,
511
Note that to_name is only the last component of the new name;
512
this doesn't change the directory.
514
This returns a list of (from_path, to_path) pairs for each
517
raise NotImplementedError(self.move)
1101
519
def get_parent(self):
1102
520
"""Return the parent location of the branch.
1104
This is the default location for pull/missing. The usual
522
This is the default location for push/pull/missing. The usual
1105
523
pattern is that the user can override it by specifying a
1108
parent = self._get_parent_location()
1111
# This is an old-format absolute path to a local branch
1112
# turn it into a url
1113
if parent.startswith('/'):
1114
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1116
return urlutils.join(self.base[:-1], parent)
1117
except errors.InvalidURLJoin, e:
1118
raise errors.InaccessibleParent(parent, self.user_url)
1120
def _get_parent_location(self):
1121
raise NotImplementedError(self._get_parent_location)
526
raise NotImplementedError(self.get_parent)
1123
528
def _set_config_location(self, name, url, config=None,
1124
529
make_relative=False):
1225
605
self.check_real_revno(revno)
1227
607
def check_real_revno(self, revno):
1229
609
Check whether a revno corresponds to a real revision.
1230
610
Zero (the NULL revision) is considered invalid
1232
612
if revno < 1 or revno > self.revno():
1233
raise errors.InvalidRevisionNumber(revno)
613
raise InvalidRevisionNumber(revno)
1235
615
@needs_read_lock
1236
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
616
def clone(self, to_bzrdir, revision_id=None):
1237
617
"""Clone this branch into to_bzrdir preserving all semantic values.
1239
Most API users will want 'create_clone_on_transport', which creates a
1240
new bzrdir and branch on the fly.
1242
619
revision_id: if not None, the revision history in the new branch will
1243
620
be truncated to end with revision_id.
1245
result = to_bzrdir.create_branch()
1248
if repository_policy is not None:
1249
repository_policy.configure_branch(result)
1250
self.copy_content_into(result, revision_id=revision_id)
622
result = self._format.initialize(to_bzrdir)
623
self.copy_content_into(result, revision_id=revision_id)
1255
626
@needs_read_lock
1256
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
627
def sprout(self, to_bzrdir, revision_id=None):
1258
628
"""Create a new line of development from the branch, into to_bzrdir.
1260
to_bzrdir controls the branch format.
1262
630
revision_id: if not None, the revision history in the new branch will
1263
631
be truncated to end with revision_id.
1265
if (repository_policy is not None and
1266
repository_policy.requires_stacking()):
1267
to_bzrdir._format.require_stacking(_skip_repo=True)
1268
result = to_bzrdir.create_branch(repository=repository)
1271
if repository_policy is not None:
1272
repository_policy.configure_branch(result)
1273
self.copy_content_into(result, revision_id=revision_id)
1274
result.set_parent(self.bzrdir.root_transport.base)
633
result = self._format.initialize(to_bzrdir)
634
self.copy_content_into(result, revision_id=revision_id)
635
result.set_parent(self.bzrdir.root_transport.base)
1279
638
def _synchronize_history(self, destination, revision_id):
1280
639
"""Synchronize last revision and revision history between branches.
1282
641
This version is most efficient when the destination is also a
1283
BzrBranch6, but works for BzrBranch5, as long as the destination's
1284
repository contains all the lefthand ancestors of the intended
1285
last_revision. If not, set_last_revision_info will fail.
642
BzrBranch5, but works for BzrBranch6 as long as the revision
643
history is the true lefthand parent history, and all of the revisions
644
are in the destination's repository. If not, set_revision_history
1287
647
:param destination: The branch to copy the history into
1288
648
:param revision_id: The revision-id to truncate history at. May
1289
649
be None to copy complete history.
1291
source_revno, source_revision_id = self.last_revision_info()
1292
if revision_id is None:
1293
revno, revision_id = source_revno, source_revision_id
1295
graph = self.repository.get_graph()
651
new_history = self.revision_history()
652
if revision_id is not None:
653
revision_id = osutils.safe_revision_id(revision_id)
1297
revno = graph.find_distance_to_null(revision_id,
1298
[(source_revision_id, source_revno)])
1299
except errors.GhostRevisionsHaveNoRevno:
1300
# Default to 1, if we can't find anything else
1302
destination.set_last_revision_info(revno, revision_id)
655
new_history = new_history[:new_history.index(revision_id) + 1]
657
rev = self.repository.get_revision(revision_id)
658
new_history = rev.get_history(self.repository)[1:]
659
destination.set_revision_history(new_history)
1304
662
def copy_content_into(self, destination, revision_id=None):
1305
663
"""Copy the content of self into destination.
1307
665
revision_id: if not None, the revision history in the new branch will
1308
666
be truncated to end with revision_id.
1310
return InterBranch.get(self, destination).copy_content_into(
1311
revision_id=revision_id)
1313
def update_references(self, target):
1314
if not getattr(self._format, 'supports_reference_locations', False):
1316
reference_dict = self._get_all_reference_info()
1317
if len(reference_dict) == 0:
1319
old_base = self.base
1320
new_base = target.base
1321
target_reference_dict = target._get_all_reference_info()
1322
for file_id, (tree_path, branch_location) in (
1323
reference_dict.items()):
1324
branch_location = urlutils.rebase_url(branch_location,
1326
target_reference_dict.setdefault(
1327
file_id, (tree_path, branch_location))
1328
target._set_all_reference_info(target_reference_dict)
668
self._synchronize_history(destination, revision_id)
670
parent = self.get_parent()
671
except errors.InaccessibleParent, e:
672
mutter('parent was not accessible to copy: %s', e)
675
destination.set_parent(parent)
676
self.tags.merge_to(destination.tags)
1330
678
@needs_read_lock
1331
def check(self, refs):
1332
680
"""Check consistency of the branch.
1334
682
In particular this checks that revisions given in the revision-history
1335
do actually match up in the revision graph, and that they're all
683
do actually match up in the revision graph, and that they're all
1336
684
present in the repository.
1338
686
Callers will typically also want to check the repository.
1340
:param refs: Calculated refs for this branch as specified by
1341
branch._get_check_refs()
1342
688
:return: A BranchCheckResult.
1344
result = BranchCheckResult(self)
1345
last_revno, last_revision_id = self.last_revision_info()
1346
actual_revno = refs[('lefthand-distance', last_revision_id)]
1347
if actual_revno != last_revno:
1348
result.errors.append(errors.BzrCheckError(
1349
'revno does not match len(mainline) %s != %s' % (
1350
last_revno, actual_revno)))
1351
# TODO: We should probably also check that self.revision_history
1352
# matches the repository for older branch formats.
1353
# If looking for the code that cross-checks repository parents against
1354
# the iter_reverse_revision_history output, that is now a repository
690
mainline_parent_id = None
691
for revision_id in self.revision_history():
693
revision = self.repository.get_revision(revision_id)
694
except errors.NoSuchRevision, e:
695
raise errors.BzrCheckError("mainline revision {%s} not in repository"
697
# In general the first entry on the revision history has no parents.
698
# But it's not illegal for it to have parents listed; this can happen
699
# in imports from Arch when the parents weren't reachable.
700
if mainline_parent_id is not None:
701
if mainline_parent_id not in revision.parent_ids:
702
raise errors.BzrCheckError("previous revision {%s} not listed among "
704
% (mainline_parent_id, revision_id))
705
mainline_parent_id = revision_id
706
return BranchCheckResult(self)
1358
708
def _get_checkout_format(self):
1359
709
"""Return the most suitable metadir for a checkout of this branch.
1360
Weaves are used if this branch's repository uses weaves.
710
Weaves are used if this branch's repostory uses weaves.
1362
format = self.repository.bzrdir.checkout_metadir()
1363
format.set_branch_format(self._format)
712
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
713
from bzrlib.repofmt import weaverepo
714
format = bzrdir.BzrDirMetaFormat1()
715
format.repository_format = weaverepo.RepositoryFormat7()
717
format = self.repository.bzrdir.checkout_metadir()
718
format.set_branch_format(self._format)
1366
def create_clone_on_transport(self, to_transport, revision_id=None,
1367
stacked_on=None, create_prefix=False, use_existing_dir=False,
1369
"""Create a clone of this branch and its bzrdir.
1371
:param to_transport: The transport to clone onto.
1372
:param revision_id: The revision id to use as tip in the new branch.
1373
If None the tip is obtained from this branch.
1374
:param stacked_on: An optional URL to stack the clone on.
1375
:param create_prefix: Create any missing directories leading up to
1377
:param use_existing_dir: Use an existing directory if one exists.
1379
# XXX: Fix the bzrdir API to allow getting the branch back from the
1380
# clone call. Or something. 20090224 RBC/spiv.
1381
# XXX: Should this perhaps clone colocated branches as well,
1382
# rather than just the default branch? 20100319 JRV
1383
if revision_id is None:
1384
revision_id = self.last_revision()
1385
dir_to = self.bzrdir.clone_on_transport(to_transport,
1386
revision_id=revision_id, stacked_on=stacked_on,
1387
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1389
return dir_to.open_branch()
1391
721
def create_checkout(self, to_location, revision_id=None,
1392
lightweight=False, accelerator_tree=None,
1394
723
"""Create a checkout of a branch.
1396
725
:param to_location: The url to produce the checkout at
1397
726
:param revision_id: The revision to check out
1398
727
:param lightweight: If True, produce a lightweight checkout, otherwise,
1399
728
produce a bound branch (heavyweight checkout)
1400
:param accelerator_tree: A tree which can be used for retrieving file
1401
contents more quickly than the revision tree, i.e. a workingtree.
1402
The revision tree will be used for cases where accelerator_tree's
1403
content is different.
1404
:param hardlink: If true, hard-link files from accelerator_tree,
1406
729
:return: The tree of the created checkout
1408
731
t = transport.get_transport(to_location)
734
except errors.FileExists:
1411
737
format = self._get_checkout_format()
1412
738
checkout = format.initialize_on_transport(t)
1413
from_branch = BranchReferenceFormat().initialize(checkout,
739
BranchReferenceFormat().initialize(checkout, self)
1416
741
format = self._get_checkout_format()
1417
742
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1418
743
to_location, force_new_tree=False, format=format)
1419
744
checkout = checkout_branch.bzrdir
1420
745
checkout_branch.bind(self)
1421
# pull up to the specified revision_id to set the initial
746
# pull up to the specified revision_id to set the initial
1422
747
# branch tip correctly, and seed it with history.
1423
748
checkout_branch.pull(self, stop_revision=revision_id)
1425
tree = checkout.create_workingtree(revision_id,
1426
from_branch=from_branch,
1427
accelerator_tree=accelerator_tree,
749
tree = checkout.create_workingtree(revision_id)
1429
750
basis_tree = tree.basis_tree()
1430
751
basis_tree.lock_read()
1438
759
basis_tree.unlock()
1442
def reconcile(self, thorough=True):
1443
"""Make sure the data stored in this branch is consistent."""
1444
from bzrlib.reconcile import BranchReconciler
1445
reconciler = BranchReconciler(self, thorough=thorough)
1446
reconciler.reconcile()
1449
def reference_parent(self, file_id, path, possible_transports=None):
762
def reference_parent(self, file_id, path):
1450
763
"""Return the parent branch for a tree-reference file_id
1451
764
:param file_id: The file_id of the tree reference
1452
765
:param path: The path of the file_id in the tree
1453
766
:return: A branch associated with the file_id
1455
768
# FIXME should provide multiple branches, based on config
1456
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1457
possible_transports=possible_transports)
769
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1459
771
def supports_tags(self):
1460
772
return self._format.supports_tags()
1462
def automatic_tag_name(self, revision_id):
1463
"""Try to automatically find the tag name for a revision.
1465
:param revision_id: Revision id of the revision.
1466
:return: A tag name or None if no tag name could be determined.
1468
for hook in Branch.hooks['automatic_tag_name']:
1469
ret = hook(self, revision_id)
1474
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1476
"""Ensure that revision_b is a descendant of revision_a.
1478
This is a helper function for update_revisions.
1480
:raises: DivergedBranches if revision_b has diverged from revision_a.
1481
:returns: True if revision_b is a descendant of revision_a.
1483
relation = self._revision_relations(revision_a, revision_b, graph)
1484
if relation == 'b_descends_from_a':
1486
elif relation == 'diverged':
1487
raise errors.DivergedBranches(self, other_branch)
1488
elif relation == 'a_descends_from_b':
1491
raise AssertionError("invalid relation: %r" % (relation,))
1493
def _revision_relations(self, revision_a, revision_b, graph):
1494
"""Determine the relationship between two revisions.
1496
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1498
heads = graph.heads([revision_a, revision_b])
1499
if heads == set([revision_b]):
1500
return 'b_descends_from_a'
1501
elif heads == set([revision_a, revision_b]):
1502
# These branches have diverged
1504
elif heads == set([revision_a]):
1505
return 'a_descends_from_b'
1507
raise AssertionError("invalid heads: %r" % (heads,))
1509
def heads_to_fetch(self):
1510
"""Return the heads that must and that should be fetched to copy this
1511
branch into another repo.
1513
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1514
set of heads that must be fetched. if_present_fetch is a set of
1515
heads that must be fetched if present, but no error is necessary if
1516
they are not present.
1518
# For bzr native formats must_fetch is just the tip, and if_present_fetch
1520
must_fetch = set([self.last_revision()])
1522
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1523
except errors.TagsNotSupported:
1524
if_present_fetch = set()
1525
must_fetch.discard(_mod_revision.NULL_REVISION)
1526
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1527
return must_fetch, if_present_fetch
1530
class BranchFormat(controldir.ControlComponentFormat):
775
class BranchFormat(object):
1531
776
"""An encapsulation of the initialization and open routines for a format.
1533
778
Formats provide three things:
1535
780
* a format string,
1536
781
* an open routine.
1538
Formats are placed in an dict by their format string for reference
1539
during branch opening. It's not required that these be instances, they
1540
can be classes themselves with class methods - it simply depends on
783
Formats are placed in an dict by their format string for reference
784
during branch opening. Its not required that these be instances, they
785
can be classes themselves with class methods - it simply depends on
1541
786
whether state is needed for a given format or not.
1543
788
Once a format is deprecated, just deprecate the initialize and open
1544
methods on the format class. Do not deprecate the object, as the
789
methods on the format class. Do not deprecate the object, as the
1545
790
object will be created every time regardless.
1548
can_set_append_revisions_only = True
1550
def __eq__(self, other):
1551
return self.__class__ is other.__class__
1553
def __ne__(self, other):
1554
return not (self == other)
793
_default_format = None
794
"""The default format used for new branches."""
797
"""The known formats."""
1557
def find_format(klass, a_bzrdir, name=None):
800
def find_format(klass, a_bzrdir):
1558
801
"""Return the format for the branch object in a_bzrdir."""
1560
transport = a_bzrdir.get_branch_transport(None, name=name)
1561
format_string = transport.get_bytes("format")
1562
return format_registry.get(format_string)
1563
except errors.NoSuchFile:
1564
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
803
transport = a_bzrdir.get_branch_transport(None)
804
format_string = transport.get("format").read()
805
return klass._formats[format_string]
807
raise NotBranchError(path=transport.base)
1565
808
except KeyError:
1566
raise errors.UnknownFormatError(format=format_string, kind='branch')
809
raise errors.UnknownFormatError(format=format_string)
1569
@deprecated_method(deprecated_in((2, 4, 0)))
1570
812
def get_default_format(klass):
1571
813
"""Return the current default format."""
1572
return format_registry.get_default()
1575
@deprecated_method(deprecated_in((2, 4, 0)))
1576
def get_formats(klass):
1577
"""Get all the known formats.
1579
Warning: This triggers a load of all lazy registered formats: do not
1580
use except when that is desireed.
1582
return format_registry._get_all()
1584
def get_reference(self, a_bzrdir, name=None):
1585
"""Get the target reference of the branch in a_bzrdir.
1587
format probing must have been completed before calling
1588
this method - it is assumed that the format of the branch
1589
in a_bzrdir is correct.
1591
:param a_bzrdir: The bzrdir to get the branch data from.
1592
:param name: Name of the colocated branch to fetch
1593
:return: None if the branch is not a reference branch.
1598
def set_reference(self, a_bzrdir, name, to_branch):
1599
"""Set the target reference of the branch in a_bzrdir.
1601
format probing must have been completed before calling
1602
this method - it is assumed that the format of the branch
1603
in a_bzrdir is correct.
1605
:param a_bzrdir: The bzrdir to set the branch reference for.
1606
:param name: Name of colocated branch to set, None for default
1607
:param to_branch: branch that the checkout is to reference
1609
raise NotImplementedError(self.set_reference)
814
return klass._default_format
1611
816
def get_format_string(self):
1612
817
"""Return the ASCII format string that identifies this format."""
1616
821
"""Return the short format description for this format."""
1617
822
raise NotImplementedError(self.get_format_description)
1619
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1620
hooks = Branch.hooks['post_branch_init']
1623
params = BranchInitHookParams(self, a_bzrdir, name, branch)
824
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
826
"""Initialize a branch in a bzrdir, with specified files
1627
def initialize(self, a_bzrdir, name=None, repository=None):
1628
"""Create a branch of this format in a_bzrdir.
1630
:param name: Name of the colocated branch to create.
828
:param a_bzrdir: The bzrdir to initialize the branch in
829
:param utf8_files: The files to create as a list of
830
(filename, content) tuples
831
:param set_format: If True, set the format with
832
self.get_format_string. (BzrBranch4 has its format set
834
:return: a branch in this format
836
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
837
branch_transport = a_bzrdir.get_branch_transport(self)
839
'metadir': ('lock', lockdir.LockDir),
840
'branch4': ('branch-lock', lockable_files.TransportLock),
842
lock_name, lock_class = lock_map[lock_type]
843
control_files = lockable_files.LockableFiles(branch_transport,
844
lock_name, lock_class)
845
control_files.create_lock()
846
control_files.lock_write()
848
control_files.put_utf8('format', self.get_format_string())
850
for file, content in utf8_files:
851
control_files.put_utf8(file, content)
853
control_files.unlock()
854
return self.open(a_bzrdir, _found=True)
856
def initialize(self, a_bzrdir):
857
"""Create a branch of this format in a_bzrdir."""
1632
858
raise NotImplementedError(self.initialize)
1634
860
def is_supported(self):
1635
861
"""Is this format supported?
1637
863
Supported formats can be initialized and opened.
1638
Unsupported formats may not support initialization or committing or
864
Unsupported formats may not support initialization or committing or
1639
865
some other features depending on the reason for not being supported.
1643
def make_tags(self, branch):
1644
"""Create a tags object for branch.
1646
This method is on BranchFormat, because BranchFormats are reflected
1647
over the wire via network_name(), whereas full Branch instances require
1648
multiple VFS method calls to operate at all.
1650
The default implementation returns a disabled-tags instance.
1652
Note that it is normal for branch to be a RemoteBranch when using tags
1655
return DisabledTags(branch)
1657
def network_name(self):
1658
"""A simple byte string uniquely identifying this format for RPC calls.
1660
MetaDir branch formats use their disk format string to identify the
1661
repository over the wire. All in one formats such as bzr < 0.8, and
1662
foreign formats like svn/git and hg should use some marker which is
1663
unique and immutable.
1665
raise NotImplementedError(self.network_name)
1667
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1668
found_repository=None):
869
def open(self, a_bzrdir, _found=False):
1669
870
"""Return the branch object for a_bzrdir
1671
:param a_bzrdir: A BzrDir that contains a branch.
1672
:param name: Name of colocated branch to open
1673
:param _found: a private parameter, do not use it. It is used to
1674
indicate if format probing has already be done.
1675
:param ignore_fallbacks: when set, no fallback branches will be opened
1676
(if there are any). Default is to open fallbacks.
872
_found is a private parameter, do not use it. It is used to indicate
873
if format probing has already be done.
1678
875
raise NotImplementedError(self.open)
1681
@deprecated_method(deprecated_in((2, 4, 0)))
1682
878
def register_format(klass, format):
1683
"""Register a metadir format.
1685
See MetaDirBranchFormatFactory for the ability to register a format
1686
without loading the code the format needs until it is actually used.
1688
format_registry.register(format)
879
klass._formats[format.get_format_string()] = format
1691
@deprecated_method(deprecated_in((2, 4, 0)))
1692
882
def set_default_format(klass, format):
1693
format_registry.set_default(format)
1695
def supports_set_append_revisions_only(self):
1696
"""True if this format supports set_append_revisions_only."""
1699
def supports_stacking(self):
1700
"""True if this format records a stacked-on branch."""
1703
def supports_leaving_lock(self):
1704
"""True if this format supports leaving locks in place."""
1705
return False # by default
883
klass._default_format = format
1708
@deprecated_method(deprecated_in((2, 4, 0)))
1709
886
def unregister_format(klass, format):
1710
format_registry.remove(format)
887
assert klass._formats[format.get_format_string()] is format
888
del klass._formats[format.get_format_string()]
1712
890
def __str__(self):
1713
return self.get_format_description().rstrip()
891
return self.get_format_string().rstrip()
1715
893
def supports_tags(self):
1716
894
"""True if this format supports tags stored in the branch"""
1717
895
return False # by default
1720
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1721
"""A factory for a BranchFormat object, permitting simple lazy registration.
1723
While none of the built in BranchFormats are lazy registered yet,
1724
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1725
use it, and the bzr-loom plugin uses it as well (see
1726
bzrlib.plugins.loom.formats).
1729
def __init__(self, format_string, module_name, member_name):
1730
"""Create a MetaDirBranchFormatFactory.
1732
:param format_string: The format string the format has.
1733
:param module_name: Module to load the format class from.
1734
:param member_name: Attribute name within the module for the format class.
1736
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1737
self._format_string = format_string
1739
def get_format_string(self):
1740
"""See BranchFormat.get_format_string."""
1741
return self._format_string
1744
"""Used for network_format_registry support."""
1745
return self.get_obj()()
897
# XXX: Probably doesn't really belong here -- mbp 20070212
898
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
900
branch_transport = a_bzrdir.get_branch_transport(self)
901
control_files = lockable_files.LockableFiles(branch_transport,
902
lock_filename, lock_class)
903
control_files.create_lock()
904
control_files.lock_write()
906
for filename, content in utf8_files:
907
control_files.put_utf8(filename, content)
909
control_files.unlock()
1748
912
class BranchHooks(Hooks):
1749
913
"""A dictionary mapping hook name to a list of callables for branch hooks.
1751
915
e.g. ['set_rh'] Is the list of items to be called when the
1752
916
set_revision_history function is invoked.
1758
922
These are all empty initially, because by default nothing should get
1761
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1762
self.add_hook('set_rh',
1763
"Invoked whenever the revision history has been set via "
1764
"set_revision_history. The api signature is (branch, "
1765
"revision_history), and the branch will be write-locked. "
1766
"The set_rh hook can be expensive for bzr to trigger, a better "
1767
"hook to use is Branch.post_change_branch_tip.", (0, 15))
1768
self.add_hook('open',
1769
"Called with the Branch object that has been opened after a "
1770
"branch is opened.", (1, 8))
1771
self.add_hook('post_push',
1772
"Called after a push operation completes. post_push is called "
1773
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1774
"bzr client.", (0, 15))
1775
self.add_hook('post_pull',
1776
"Called after a pull operation completes. post_pull is called "
1777
"with a bzrlib.branch.PullResult object and only runs in the "
1778
"bzr client.", (0, 15))
1779
self.add_hook('pre_commit',
1780
"Called after a commit is calculated but before it is "
1781
"completed. pre_commit is called with (local, master, old_revno, "
1782
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1783
"). old_revid is NULL_REVISION for the first commit to a branch, "
1784
"tree_delta is a TreeDelta object describing changes from the "
1785
"basis revision. hooks MUST NOT modify this delta. "
1786
" future_tree is an in-memory tree obtained from "
1787
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1789
self.add_hook('post_commit',
1790
"Called in the bzr client after a commit has completed. "
1791
"post_commit is called with (local, master, old_revno, old_revid, "
1792
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1793
"commit to a branch.", (0, 15))
1794
self.add_hook('post_uncommit',
1795
"Called in the bzr client after an uncommit completes. "
1796
"post_uncommit is called with (local, master, old_revno, "
1797
"old_revid, new_revno, new_revid) where local is the local branch "
1798
"or None, master is the target branch, and an empty branch "
1799
"receives new_revno of 0, new_revid of None.", (0, 15))
1800
self.add_hook('pre_change_branch_tip',
1801
"Called in bzr client and server before a change to the tip of a "
1802
"branch is made. pre_change_branch_tip is called with a "
1803
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1804
"commit, uncommit will all trigger this hook.", (1, 6))
1805
self.add_hook('post_change_branch_tip',
1806
"Called in bzr client and server after a change to the tip of a "
1807
"branch is made. post_change_branch_tip is called with a "
1808
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1809
"commit, uncommit will all trigger this hook.", (1, 4))
1810
self.add_hook('transform_fallback_location',
1811
"Called when a stacked branch is activating its fallback "
1812
"locations. transform_fallback_location is called with (branch, "
1813
"url), and should return a new url. Returning the same url "
1814
"allows it to be used as-is, returning a different one can be "
1815
"used to cause the branch to stack on a closer copy of that "
1816
"fallback_location. Note that the branch cannot have history "
1817
"accessing methods called on it during this hook because the "
1818
"fallback locations have not been activated. When there are "
1819
"multiple hooks installed for transform_fallback_location, "
1820
"all are called with the url returned from the previous hook."
1821
"The order is however undefined.", (1, 9))
1822
self.add_hook('automatic_tag_name',
1823
"Called to determine an automatic tag name for a revision. "
1824
"automatic_tag_name is called with (branch, revision_id) and "
1825
"should return a tag name or None if no tag name could be "
1826
"determined. The first non-None tag name returned will be used.",
1828
self.add_hook('post_branch_init',
1829
"Called after new branch initialization completes. "
1830
"post_branch_init is called with a "
1831
"bzrlib.branch.BranchInitHookParams. "
1832
"Note that init, branch and checkout (both heavyweight and "
1833
"lightweight) will all trigger this hook.", (2, 2))
1834
self.add_hook('post_switch',
1835
"Called after a checkout switches branch. "
1836
"post_switch is called with a "
1837
"bzrlib.branch.SwitchHookParams.", (2, 2))
926
# Introduced in 0.15:
927
# invoked whenever the revision history has been set
928
# with set_revision_history. The api signature is
929
# (branch, revision_history), and the branch will
932
# invoked after a push operation completes.
933
# the api signature is
935
# containing the members
936
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
937
# where local is the local branch or None, master is the target
938
# master branch, and the rest should be self explanatory. The source
939
# is read locked and the target branches write locked. Source will
940
# be the local low-latency branch.
941
self['post_push'] = []
942
# invoked after a pull operation completes.
943
# the api signature is
945
# containing the members
946
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
947
# where local is the local branch or None, master is the target
948
# master branch, and the rest should be self explanatory. The source
949
# is read locked and the target branches write locked. The local
950
# branch is the low-latency branch.
951
self['post_pull'] = []
952
# invoked after a commit operation completes.
953
# the api signature is
954
# (local, master, old_revno, old_revid, new_revno, new_revid)
955
# old_revid is NULL_REVISION for the first commit to a branch.
956
self['post_commit'] = []
957
# invoked after a uncommit operation completes.
958
# the api signature is
959
# (local, master, old_revno, old_revid, new_revno, new_revid) where
960
# local is the local branch or None, master is the target branch,
961
# and an empty branch recieves new_revno of 0, new_revid of None.
962
self['post_uncommit'] = []
1841
965
# install the default hooks into the Branch class.
1842
966
Branch.hooks = BranchHooks()
1845
class ChangeBranchTipParams(object):
1846
"""Object holding parameters passed to *_change_branch_tip hooks.
1848
There are 5 fields that hooks may wish to access:
1850
:ivar branch: the branch being changed
1851
:ivar old_revno: revision number before the change
1852
:ivar new_revno: revision number after the change
1853
:ivar old_revid: revision id before the change
1854
:ivar new_revid: revision id after the change
1856
The revid fields are strings. The revno fields are integers.
1859
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1860
"""Create a group of ChangeBranchTip parameters.
1862
:param branch: The branch being changed.
1863
:param old_revno: Revision number before the change.
1864
:param new_revno: Revision number after the change.
1865
:param old_revid: Tip revision id before the change.
1866
:param new_revid: Tip revision id after the change.
1868
self.branch = branch
1869
self.old_revno = old_revno
1870
self.new_revno = new_revno
1871
self.old_revid = old_revid
1872
self.new_revid = new_revid
1874
def __eq__(self, other):
1875
return self.__dict__ == other.__dict__
1878
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1879
self.__class__.__name__, self.branch,
1880
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1883
class BranchInitHookParams(object):
1884
"""Object holding parameters passed to *_branch_init hooks.
1886
There are 4 fields that hooks may wish to access:
1888
:ivar format: the branch format
1889
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1890
:ivar name: name of colocated branch, if any (or None)
1891
:ivar branch: the branch created
1893
Note that for lightweight checkouts, the bzrdir and format fields refer to
1894
the checkout, hence they are different from the corresponding fields in
1895
branch, which refer to the original branch.
1898
def __init__(self, format, a_bzrdir, name, branch):
1899
"""Create a group of BranchInitHook parameters.
1901
:param format: the branch format
1902
:param a_bzrdir: the BzrDir where the branch will be/has been
1904
:param name: name of colocated branch, if any (or None)
1905
:param branch: the branch created
1907
Note that for lightweight checkouts, the bzrdir and format fields refer
1908
to the checkout, hence they are different from the corresponding fields
1909
in branch, which refer to the original branch.
1911
self.format = format
1912
self.bzrdir = a_bzrdir
1914
self.branch = branch
1916
def __eq__(self, other):
1917
return self.__dict__ == other.__dict__
1920
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1923
class SwitchHookParams(object):
1924
"""Object holding parameters passed to *_switch hooks.
1926
There are 4 fields that hooks may wish to access:
1928
:ivar control_dir: BzrDir of the checkout to change
1929
:ivar to_branch: branch that the checkout is to reference
1930
:ivar force: skip the check for local commits in a heavy checkout
1931
:ivar revision_id: revision ID to switch to (or None)
1934
def __init__(self, control_dir, to_branch, force, revision_id):
1935
"""Create a group of SwitchHook parameters.
1937
:param control_dir: BzrDir of the checkout to change
1938
:param to_branch: branch that the checkout is to reference
1939
:param force: skip the check for local commits in a heavy checkout
1940
:param revision_id: revision ID to switch to (or None)
1942
self.control_dir = control_dir
1943
self.to_branch = to_branch
1945
self.revision_id = revision_id
1947
def __eq__(self, other):
1948
return self.__dict__ == other.__dict__
1951
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1952
self.control_dir, self.to_branch,
1956
class BranchFormatMetadir(BranchFormat):
1957
"""Common logic for meta-dir based branch formats."""
1959
def _branch_class(self):
1960
"""What class to instantiate on open calls."""
1961
raise NotImplementedError(self._branch_class)
1963
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1965
"""Initialize a branch in a bzrdir, with specified files
1967
:param a_bzrdir: The bzrdir to initialize the branch in
1968
:param utf8_files: The files to create as a list of
1969
(filename, content) tuples
1970
:param name: Name of colocated branch to create, if any
1971
:return: a branch in this format
1973
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1974
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1975
control_files = lockable_files.LockableFiles(branch_transport,
1976
'lock', lockdir.LockDir)
1977
control_files.create_lock()
1978
control_files.lock_write()
1980
utf8_files += [('format', self.get_format_string())]
1981
for (filename, content) in utf8_files:
1982
branch_transport.put_bytes(
1984
mode=a_bzrdir._get_file_mode())
1986
control_files.unlock()
1987
branch = self.open(a_bzrdir, name, _found=True,
1988
found_repository=repository)
1989
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1992
def network_name(self):
1993
"""A simple byte string uniquely identifying this format for RPC calls.
1995
Metadir branch formats use their format string.
1997
return self.get_format_string()
1999
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2000
found_repository=None):
2001
"""See BranchFormat.open()."""
969
class BzrBranchFormat4(BranchFormat):
970
"""Bzr branch format 4.
973
- a revision-history file.
974
- a branch-lock lock file [ to be shared with the bzrdir ]
977
def get_format_description(self):
978
"""See BranchFormat.get_format_description()."""
979
return "Branch format 4"
981
def initialize(self, a_bzrdir):
982
"""Create a branch of this format in a_bzrdir."""
983
utf8_files = [('revision-history', ''),
986
return self._initialize_helper(a_bzrdir, utf8_files,
987
lock_type='branch4', set_format=False)
990
super(BzrBranchFormat4, self).__init__()
991
self._matchingbzrdir = bzrdir.BzrDirFormat6()
993
def open(self, a_bzrdir, _found=False):
994
"""Return the branch object for a_bzrdir
996
_found is a private parameter, do not use it. It is used to indicate
997
if format probing has already be done.
2003
format = BranchFormat.find_format(a_bzrdir, name=name)
2004
if format.__class__ != self.__class__:
2005
raise AssertionError("wrong format %r found for %r" %
2007
transport = a_bzrdir.get_branch_transport(None, name=name)
2009
control_files = lockable_files.LockableFiles(transport, 'lock',
2011
if found_repository is None:
2012
found_repository = a_bzrdir.find_repository()
2013
return self._branch_class()(_format=self,
2014
_control_files=control_files,
2017
_repository=found_repository,
2018
ignore_fallbacks=ignore_fallbacks)
2019
except errors.NoSuchFile:
2020
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2023
super(BranchFormatMetadir, self).__init__()
2024
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2025
self._matchingbzrdir.set_branch_format(self)
2027
def supports_tags(self):
2030
def supports_leaving_lock(self):
2034
class BzrBranchFormat5(BranchFormatMetadir):
1000
# we are being called directly and must probe.
1001
raise NotImplementedError
1002
return BzrBranch(_format=self,
1003
_control_files=a_bzrdir._control_files,
1005
_repository=a_bzrdir.open_repository())
1008
return "Bazaar-NG branch format 4"
1011
class BzrBranchFormat5(BranchFormat):
2035
1012
"""Bzr branch format 5.
2037
1014
This format has:
2088
1076
"""See BranchFormat.get_format_description()."""
2089
1077
return "Branch format 6"
2091
def initialize(self, a_bzrdir, name=None, repository=None):
2092
"""Create a branch of this format in a_bzrdir."""
2093
utf8_files = [('last-revision', '0 null:\n'),
2094
('branch.conf', ''),
2097
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2099
def make_tags(self, branch):
2100
"""See bzrlib.branch.BranchFormat.make_tags()."""
2101
return BasicTags(branch)
2103
def supports_set_append_revisions_only(self):
2107
class BzrBranchFormat8(BranchFormatMetadir):
2108
"""Metadir format supporting storing locations of subtree branches."""
2110
def _branch_class(self):
2113
def get_format_string(self):
2114
"""See BranchFormat.get_format_string()."""
2115
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2117
def get_format_description(self):
2118
"""See BranchFormat.get_format_description()."""
2119
return "Branch format 8"
2121
def initialize(self, a_bzrdir, name=None, repository=None):
2122
"""Create a branch of this format in a_bzrdir."""
2123
utf8_files = [('last-revision', '0 null:\n'),
2124
('branch.conf', ''),
2128
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2130
def make_tags(self, branch):
2131
"""See bzrlib.branch.BranchFormat.make_tags()."""
2132
return BasicTags(branch)
2134
def supports_set_append_revisions_only(self):
2137
def supports_stacking(self):
2140
supports_reference_locations = True
2143
class BzrBranchFormat7(BranchFormatMetadir):
2144
"""Branch format with last-revision, tags, and a stacked location pointer.
2146
The stacked location pointer is passed down to the repository and requires
2147
a repository format with supports_external_lookups = True.
2149
This format was introduced in bzr 1.6.
2152
def initialize(self, a_bzrdir, name=None, repository=None):
2153
"""Create a branch of this format in a_bzrdir."""
2154
utf8_files = [('last-revision', '0 null:\n'),
2155
('branch.conf', ''),
2158
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2160
def _branch_class(self):
2163
def get_format_string(self):
2164
"""See BranchFormat.get_format_string()."""
2165
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2167
def get_format_description(self):
2168
"""See BranchFormat.get_format_description()."""
2169
return "Branch format 7"
2171
def supports_set_append_revisions_only(self):
2174
def supports_stacking(self):
2177
def make_tags(self, branch):
2178
"""See bzrlib.branch.BranchFormat.make_tags()."""
2179
return BasicTags(branch)
2181
supports_reference_locations = False
1079
def initialize(self, a_bzrdir):
1080
"""Create a branch of this format in a_bzrdir."""
1081
utf8_files = [('last-revision', '0 null:\n'),
1082
('branch-name', ''),
1083
('branch.conf', ''),
1086
return self._initialize_helper(a_bzrdir, utf8_files)
1088
def open(self, a_bzrdir, _found=False):
1089
"""Return the branch object for a_bzrdir
1091
_found is a private parameter, do not use it. It is used to indicate
1092
if format probing has already be done.
1095
format = BranchFormat.find_format(a_bzrdir)
1096
assert format.__class__ == self.__class__
1097
transport = a_bzrdir.get_branch_transport(None)
1098
control_files = lockable_files.LockableFiles(transport, 'lock',
1100
return BzrBranch6(_format=self,
1101
_control_files=control_files,
1103
_repository=a_bzrdir.find_repository())
1105
def supports_tags(self):
2184
1109
class BranchReferenceFormat(BranchFormat):
2199
1124
def get_format_description(self):
2200
1125
"""See BranchFormat.get_format_description()."""
2201
1126
return "Checkout reference format 1"
2203
def get_reference(self, a_bzrdir, name=None):
2204
"""See BranchFormat.get_reference()."""
2205
transport = a_bzrdir.get_branch_transport(None, name=name)
2206
return transport.get_bytes('location')
2208
def set_reference(self, a_bzrdir, name, to_branch):
2209
"""See BranchFormat.set_reference()."""
2210
transport = a_bzrdir.get_branch_transport(None, name=name)
2211
location = transport.put_bytes('location', to_branch.base)
2213
def initialize(self, a_bzrdir, name=None, target_branch=None,
1128
def initialize(self, a_bzrdir, target_branch=None):
2215
1129
"""Create a branch of this format in a_bzrdir."""
2216
1130
if target_branch is None:
2217
1131
# this format does not implement branch itself, thus the implicit
2218
1132
# creation contract must see it as uninitializable
2219
1133
raise errors.UninitializableFormat(self)
2220
mutter('creating branch reference in %s', a_bzrdir.user_url)
2221
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1134
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1135
branch_transport = a_bzrdir.get_branch_transport(self)
2222
1136
branch_transport.put_bytes('location',
2223
target_branch.bzrdir.user_url)
1137
target_branch.bzrdir.root_transport.base)
2224
1138
branch_transport.put_bytes('format', self.get_format_string())
2226
a_bzrdir, name, _found=True,
2227
possible_transports=[target_branch.bzrdir.root_transport])
2228
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1139
return self.open(a_bzrdir, _found=True)
2231
1141
def __init__(self):
2232
1142
super(BranchReferenceFormat, self).__init__()
2233
1143
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2234
self._matchingbzrdir.set_branch_format(self)
2236
1145
def _make_reference_clone_function(format, a_branch):
2237
1146
"""Create a clone() routine for a branch dynamically."""
2238
def clone(to_bzrdir, revision_id=None,
2239
repository_policy=None):
1147
def clone(to_bzrdir, revision_id=None):
2240
1148
"""See Branch.clone()."""
2241
return format.initialize(to_bzrdir, target_branch=a_branch)
1149
return format.initialize(to_bzrdir, a_branch)
2242
1150
# cannot obey revision_id limits when cloning a reference ...
2243
1151
# FIXME RBC 20060210 either nuke revision_id for clone, or
2244
1152
# emit some sort of warning/error to the caller ?!
2247
def open(self, a_bzrdir, name=None, _found=False, location=None,
2248
possible_transports=None, ignore_fallbacks=False,
2249
found_repository=None):
1155
def open(self, a_bzrdir, _found=False):
2250
1156
"""Return the branch that the branch reference in a_bzrdir points at.
2252
:param a_bzrdir: A BzrDir that contains a branch.
2253
:param name: Name of colocated branch to open, if any
2254
:param _found: a private parameter, do not use it. It is used to
2255
indicate if format probing has already be done.
2256
:param ignore_fallbacks: when set, no fallback branches will be opened
2257
(if there are any). Default is to open fallbacks.
2258
:param location: The location of the referenced branch. If
2259
unspecified, this will be determined from the branch reference in
2261
:param possible_transports: An optional reusable transports list.
1158
_found is a private parameter, do not use it. It is used to indicate
1159
if format probing has already be done.
2264
format = BranchFormat.find_format(a_bzrdir, name=name)
2265
if format.__class__ != self.__class__:
2266
raise AssertionError("wrong format %r found for %r" %
2268
if location is None:
2269
location = self.get_reference(a_bzrdir, name)
2270
real_bzrdir = bzrdir.BzrDir.open(
2271
location, possible_transports=possible_transports)
2272
result = real_bzrdir.open_branch(name=name,
2273
ignore_fallbacks=ignore_fallbacks)
1162
format = BranchFormat.find_format(a_bzrdir)
1163
assert format.__class__ == self.__class__
1164
transport = a_bzrdir.get_branch_transport(None)
1165
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1166
result = real_bzrdir.open_branch()
2274
1167
# this changes the behaviour of result.clone to create a new reference
2275
1168
# rather than a copy of the content of the branch.
2276
1169
# I did not use a proxy object because that needs much more extensive
2286
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2287
"""Branch format registry."""
2289
def __init__(self, other_registry=None):
2290
super(BranchFormatRegistry, self).__init__(other_registry)
2291
self._default_format = None
2293
def set_default(self, format):
2294
self._default_format = format
2296
def get_default(self):
2297
return self._default_format
2300
network_format_registry = registry.FormatRegistry()
2301
"""Registry of formats indexed by their network name.
2303
The network name for a branch format is an identifier that can be used when
2304
referring to formats with smart server operations. See
2305
BranchFormat.network_name() for more detail.
2308
format_registry = BranchFormatRegistry(network_format_registry)
2311
1179
# formats which have no format string are not discoverable
2312
1180
# and not independently creatable, so are not registered.
2313
__format5 = BzrBranchFormat5()
2314
__format6 = BzrBranchFormat6()
2315
__format7 = BzrBranchFormat7()
2316
__format8 = BzrBranchFormat8()
2317
format_registry.register(__format5)
2318
format_registry.register(BranchReferenceFormat())
2319
format_registry.register(__format6)
2320
format_registry.register(__format7)
2321
format_registry.register(__format8)
2322
format_registry.set_default(__format7)
2325
class BranchWriteLockResult(LogicalLockResult):
2326
"""The result of write locking a branch.
2328
:ivar branch_token: The token obtained from the underlying branch lock, or
2330
:ivar unlock: A callable which will unlock the lock.
2333
def __init__(self, unlock, branch_token):
2334
LogicalLockResult.__init__(self, unlock)
2335
self.branch_token = branch_token
2338
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2342
class BzrBranch(Branch, _RelockDebugMixin):
1181
__default_format = BzrBranchFormat5()
1182
BranchFormat.register_format(__default_format)
1183
BranchFormat.register_format(BranchReferenceFormat())
1184
BranchFormat.register_format(BzrBranchFormat6())
1185
BranchFormat.set_default_format(__default_format)
1186
_legacy_formats = [BzrBranchFormat4(),
1189
class BzrBranch(Branch):
2343
1190
"""A branch stored in the actual filesystem.
2345
1192
Note that it's "local" in the context of the filesystem; it doesn't
2346
1193
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2347
1194
it's writable, and can be accessed via the normal filesystem API.
2349
:ivar _transport: Transport for file operations on this branch's
2350
control files, typically pointing to the .bzr/branch directory.
2351
:ivar repository: Repository for this branch.
2352
:ivar base: The url of the base directory for this branch; the one
2353
containing the .bzr directory.
2354
:ivar name: Optional colocated branch name as it exists in the control
2358
1197
def __init__(self, _format=None,
2359
_control_files=None, a_bzrdir=None, name=None,
2360
_repository=None, ignore_fallbacks=False):
1198
_control_files=None, a_bzrdir=None, _repository=None):
2361
1199
"""Create new branch object at a particular location."""
1200
Branch.__init__(self)
2362
1201
if a_bzrdir is None:
2363
1202
raise ValueError('a_bzrdir must be supplied')
2365
1204
self.bzrdir = a_bzrdir
1205
# self._transport used to point to the directory containing the
1206
# control directory, but was not used - now it's just the transport
1207
# for the branch control files. mbp 20070212
2366
1208
self._base = self.bzrdir.transport.clone('..').base
2368
# XXX: We should be able to just do
2369
# self.base = self.bzrdir.root_transport.base
2370
# but this does not quite work yet -- mbp 20080522
2371
1209
self._format = _format
2372
1210
if _control_files is None:
2373
1211
raise ValueError('BzrBranch _control_files is None')
2374
1212
self.control_files = _control_files
2375
1213
self._transport = _control_files._transport
2376
1214
self.repository = _repository
2377
Branch.__init__(self)
2379
1216
def __str__(self):
2380
if self.name is None:
2381
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2383
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
1217
return '%s(%r)' % (self.__class__.__name__, self.base)
2386
1219
__repr__ = __str__
2473
1280
"""See Branch.print_file."""
2474
1281
return self.repository.print_file(file, revision_id)
1284
def append_revision(self, *revision_ids):
1285
"""See Branch.append_revision."""
1286
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1287
for revision_id in revision_ids:
1288
_mod_revision.check_not_reserved_id(revision_id)
1289
mutter("add {%s} to revision-history" % revision_id)
1290
rev_history = self.revision_history()
1291
rev_history.extend(revision_ids)
1292
self.set_revision_history(rev_history)
2476
1294
def _write_revision_history(self, history):
2477
1295
"""Factored out of set_revision_history.
2479
1297
This performs the actual writing to disk.
2480
1298
It is intended to be called by BzrBranch5.set_revision_history."""
2481
self._transport.put_bytes(
2482
'revision-history', '\n'.join(history),
2483
mode=self.bzrdir._get_file_mode())
1299
self.control_files.put_bytes(
1300
'revision-history', '\n'.join(history))
2485
@deprecated_method(deprecated_in((2, 4, 0)))
2486
1303
def set_revision_history(self, rev_history):
2487
1304
"""See Branch.set_revision_history."""
2488
self._set_revision_history(rev_history)
2491
def _set_revision_history(self, rev_history):
2492
if 'evil' in debug.debug_flags:
2493
mutter_callsite(3, "set_revision_history scales with history.")
2494
check_not_reserved_id = _mod_revision.check_not_reserved_id
2495
for rev_id in rev_history:
2496
check_not_reserved_id(rev_id)
2497
if Branch.hooks['post_change_branch_tip']:
2498
# Don't calculate the last_revision_info() if there are no hooks
2500
old_revno, old_revid = self.last_revision_info()
2501
if len(rev_history) == 0:
2502
revid = _mod_revision.NULL_REVISION
2504
revid = rev_history[-1]
2505
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1305
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
2506
1306
self._write_revision_history(rev_history)
2507
self._clear_cached_state()
2508
1307
self._cache_revision_history(rev_history)
2509
1308
for hook in Branch.hooks['set_rh']:
2510
1309
hook(self, rev_history)
2511
if Branch.hooks['post_change_branch_tip']:
2512
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2514
def _synchronize_history(self, destination, revision_id):
2515
"""Synchronize last revision and revision history between branches.
2517
This version is most efficient when the destination is also a
2518
BzrBranch5, but works for BzrBranch6 as long as the revision
2519
history is the true lefthand parent history, and all of the revisions
2520
are in the destination's repository. If not, set_revision_history
2523
:param destination: The branch to copy the history into
2524
:param revision_id: The revision-id to truncate history at. May
2525
be None to copy complete history.
2527
if not isinstance(destination._format, BzrBranchFormat5):
2528
super(BzrBranch, self)._synchronize_history(
2529
destination, revision_id)
2531
if revision_id == _mod_revision.NULL_REVISION:
2534
new_history = self.revision_history()
2535
if revision_id is not None and new_history != []:
2537
new_history = new_history[:new_history.index(revision_id) + 1]
2539
rev = self.repository.get_revision(revision_id)
2540
new_history = rev.get_history(self.repository)[1:]
2541
destination._set_revision_history(new_history)
2543
1311
@needs_write_lock
2544
1312
def set_last_revision_info(self, revno, revision_id):
2545
"""Set the last revision of this branch.
2547
The caller is responsible for checking that the revno is correct
2548
for this revision id.
2550
It may be possible to set the branch last revision to an id not
2551
present in the repository. However, branches can also be
2552
configured to check constraints on history, in which case this may not
2555
if not revision_id or not isinstance(revision_id, basestring):
2556
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2557
# this old format stores the full history, but this api doesn't
2558
# provide it, so we must generate, and might as well check it's
1313
revision_id = osutils.safe_revision_id(revision_id)
2560
1314
history = self._lefthand_history(revision_id)
2561
if len(history) != revno:
2562
raise AssertionError('%d != %d' % (len(history), revno))
2563
self._set_revision_history(history)
1315
assert len(history) == revno, '%d != %d' % (len(history), revno)
1316
self.set_revision_history(history)
2565
1318
def _gen_revision_history(self):
2566
history = self._transport.get_bytes('revision-history').split('\n')
1319
history = self.control_files.get('revision-history').read().split('\n')
2567
1320
if history[-1:] == ['']:
2568
1321
# There shouldn't be a trailing newline, but just in case.
1325
def _lefthand_history(self, revision_id, last_rev=None,
1327
# stop_revision must be a descendant of last_revision
1328
stop_graph = self.repository.get_revision_graph(revision_id)
1329
if last_rev is not None and last_rev not in stop_graph:
1330
# our previous tip is not merged into stop_revision
1331
raise errors.DivergedBranches(self, other_branch)
1332
# make a new revision history from the graph
1333
current_rev_id = revision_id
1335
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1336
new_history.append(current_rev_id)
1337
current_rev_id_parents = stop_graph[current_rev_id]
1339
current_rev_id = current_rev_id_parents[0]
1341
current_rev_id = None
1342
new_history.reverse()
2572
1345
@needs_write_lock
2573
1346
def generate_revision_history(self, revision_id, last_rev=None,
2574
1347
other_branch=None):
2580
1353
:param other_branch: The other branch that DivergedBranches should
2581
1354
raise with respect to.
2583
self._set_revision_history(self._lefthand_history(revision_id,
1356
revision_id = osutils.safe_revision_id(revision_id)
1357
self.set_revision_history(self._lefthand_history(revision_id,
2584
1358
last_rev, other_branch))
1361
def update_revisions(self, other, stop_revision=None):
1362
"""See Branch.update_revisions."""
1365
if stop_revision is None:
1366
stop_revision = other.last_revision()
1367
if stop_revision is None:
1368
# if there are no commits, we're done.
1371
stop_revision = osutils.safe_revision_id(stop_revision)
1372
# whats the current last revision, before we fetch [and change it
1374
last_rev = self.last_revision()
1375
# we fetch here regardless of whether we need to so that we pickup
1377
self.fetch(other, stop_revision)
1378
my_ancestry = self.repository.get_ancestry(last_rev)
1379
if stop_revision in my_ancestry:
1380
# last_revision is a descendant of stop_revision
1382
self.generate_revision_history(stop_revision, last_rev=last_rev,
2586
1387
def basis_tree(self):
2587
1388
"""See Branch.basis_tree."""
2588
1389
return self.repository.revision_tree(self.last_revision())
1391
@deprecated_method(zero_eight)
1392
def working_tree(self):
1393
"""Create a Working tree object for this branch."""
1395
from bzrlib.transport.local import LocalTransport
1396
if (self.base.find('://') != -1 or
1397
not isinstance(self._transport, LocalTransport)):
1398
raise NoWorkingTree(self.base)
1399
return self.bzrdir.open_workingtree()
1402
def pull(self, source, overwrite=False, stop_revision=None,
1403
_hook_master=None, _run_hooks=True):
1406
:param _hook_master: Private parameter - set the branch to
1407
be supplied as the master to push hooks.
1408
:param _run_hooks: Private parameter - allow disabling of
1409
hooks, used when pushing to a master branch.
1411
result = PullResult()
1412
result.source_branch = source
1413
result.target_branch = self
1416
result.old_revno, result.old_revid = self.last_revision_info()
1418
self.update_revisions(source, stop_revision)
1419
except DivergedBranches:
1423
if stop_revision is None:
1424
stop_revision = source.last_revision()
1425
self.generate_revision_history(stop_revision)
1426
result.tag_conflicts = source.tags.merge_to(self.tags)
1427
result.new_revno, result.new_revid = self.last_revision_info()
1429
result.master_branch = _hook_master
1430
result.local_branch = self
1432
result.master_branch = self
1433
result.local_branch = None
1435
for hook in Branch.hooks['post_pull']:
2590
1441
def _get_parent_location(self):
2591
1442
_locs = ['parent', 'pull', 'x-pull']
2592
1443
for l in _locs:
2594
return self._transport.get_bytes(l).strip('\n')
2595
except errors.NoSuchFile:
1445
return self.control_files.get(l).read().strip('\n')
2599
def get_stacked_on_url(self):
2600
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1451
def push(self, target, overwrite=False, stop_revision=None,
1452
_hook_master=None, _run_hooks=True):
1455
:param _hook_master: Private parameter - set the branch to
1456
be supplied as the master to push hooks.
1457
:param _run_hooks: Private parameter - allow disabling of
1458
hooks, used when pushing to a master branch.
1460
result = PushResult()
1461
result.source_branch = self
1462
result.target_branch = target
1465
result.old_revno, result.old_revid = target.last_revision_info()
1467
target.update_revisions(self, stop_revision)
1468
except DivergedBranches:
1472
target.set_revision_history(self.revision_history())
1473
result.tag_conflicts = self.tags.merge_to(target.tags)
1474
result.new_revno, result.new_revid = target.last_revision_info()
1476
result.master_branch = _hook_master
1477
result.local_branch = target
1479
result.master_branch = target
1480
result.local_branch = None
1482
for hook in Branch.hooks['post_push']:
1488
def get_parent(self):
1489
"""See Branch.get_parent."""
1491
assert self.base[-1] == '/'
1492
parent = self._get_parent_location()
1495
# This is an old-format absolute path to a local branch
1496
# turn it into a url
1497
if parent.startswith('/'):
1498
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1500
return urlutils.join(self.base[:-1], parent)
1501
except errors.InvalidURLJoin, e:
1502
raise errors.InaccessibleParent(parent, self.base)
1504
def get_push_location(self):
1505
"""See Branch.get_push_location."""
1506
push_loc = self.get_config().get_user_option('push_location')
2602
1509
def set_push_location(self, location):
2603
1510
"""See Branch.set_push_location."""
2605
1512
'push_location', location,
2606
1513
store=_mod_config.STORE_LOCATION_NORECURSE)
1516
def set_parent(self, url):
1517
"""See Branch.set_parent."""
1518
# TODO: Maybe delete old location files?
1519
# URLs should never be unicode, even on the local fs,
1520
# FIXUP this and get_parent in a future branch format bump:
1521
# read and rewrite the file, and have the new format code read
1522
# using .get not .get_utf8. RBC 20060125
1524
if isinstance(url, unicode):
1526
url = url.encode('ascii')
1527
except UnicodeEncodeError:
1528
raise bzrlib.errors.InvalidURL(url,
1529
"Urls must be 7-bit ascii, "
1530
"use bzrlib.urlutils.escape")
1531
url = urlutils.relative_url(self.base, url)
1532
self._set_parent_location(url)
2608
1534
def _set_parent_location(self, url):
2609
1535
if url is None:
2610
self._transport.delete('parent')
1536
self.control_files._transport.delete('parent')
2612
self._transport.put_bytes('parent', url + '\n',
2613
mode=self.bzrdir._get_file_mode())
1538
assert isinstance(url, str)
1539
self.control_files.put_bytes('parent', url + '\n')
1541
@deprecated_function(zero_nine)
1542
def tree_config(self):
1543
"""DEPRECATED; call get_config instead.
1544
TreeConfig has become part of BranchConfig."""
1545
return TreeConfig(self)
2616
1548
class BzrBranch5(BzrBranch):
2617
"""A format 5 branch. This supports new features over plain branches.
1549
"""A format 5 branch. This supports new features over plan branches.
2619
1551
It has support for a master_branch which is the data for bound branches.
1559
super(BzrBranch5, self).__init__(_format=_format,
1560
_control_files=_control_files,
1562
_repository=_repository)
1565
def pull(self, source, overwrite=False, stop_revision=None,
1567
"""Extends branch.pull to be bound branch aware.
1569
:param _run_hooks: Private parameter used to force hook running
1570
off during bound branch double-pushing.
1572
bound_location = self.get_bound_location()
1573
master_branch = None
1574
if bound_location and source.base != bound_location:
1575
# not pulling from master, so we need to update master.
1576
master_branch = self.get_master_branch()
1577
master_branch.lock_write()
1580
# pull from source into master.
1581
master_branch.pull(source, overwrite, stop_revision,
1583
return super(BzrBranch5, self).pull(source, overwrite,
1584
stop_revision, _hook_master=master_branch,
1585
_run_hooks=_run_hooks)
1588
master_branch.unlock()
1591
def push(self, target, overwrite=False, stop_revision=None):
1592
"""Updates branch.push to be bound branch aware."""
1593
bound_location = target.get_bound_location()
1594
master_branch = None
1595
if bound_location and target.base != bound_location:
1596
# not pushing to master, so we need to update master.
1597
master_branch = target.get_master_branch()
1598
master_branch.lock_write()
1601
# push into the master from this branch.
1602
super(BzrBranch5, self).push(master_branch, overwrite,
1603
stop_revision, _run_hooks=False)
1604
# and push into the target branch from this. Note that we push from
1605
# this branch again, because its considered the highest bandwidth
1607
return super(BzrBranch5, self).push(target, overwrite,
1608
stop_revision, _hook_master=master_branch)
1611
master_branch.unlock()
2622
1613
def get_bound_location(self):
2624
return self._transport.get_bytes('bound')[:-1]
1615
return self.control_files.get_utf8('bound').read()[:-1]
2625
1616
except errors.NoSuchFile:
2628
1619
@needs_read_lock
2629
def get_master_branch(self, possible_transports=None):
1620
def get_master_branch(self):
2630
1621
"""Return the branch we are bound to.
2632
1623
:return: Either a Branch, or None
1625
This could memoise the branch, but if thats done
1626
it must be revalidated on each new lock.
1627
So for now we just don't memoise it.
1628
# RBC 20060304 review this decision.
2634
if self._master_branch_cache is None:
2635
self._master_branch_cache = self._get_master_branch(
2636
possible_transports)
2637
return self._master_branch_cache
2639
def _get_master_branch(self, possible_transports):
2640
1630
bound_loc = self.get_bound_location()
2641
1631
if not bound_loc:
2644
return Branch.open(bound_loc,
2645
possible_transports=possible_transports)
1634
return Branch.open(bound_loc)
2646
1635
except (errors.NotBranchError, errors.ConnectionError), e:
2647
1636
raise errors.BoundBranchConnectionFailure(
2648
1637
self, bound_loc, e)
2696
1699
return self.set_bound_location(None)
2698
1701
@needs_write_lock
2699
def update(self, possible_transports=None):
2700
"""Synchronise this branch with the master branch if any.
1703
"""Synchronise this branch with the master branch if any.
2702
1705
:return: None or the last_revision that was pivoted out during the
2705
master = self.get_master_branch(possible_transports)
1708
master = self.get_master_branch()
2706
1709
if master is not None:
2707
old_tip = _mod_revision.ensure_null(self.last_revision())
1710
old_tip = self.last_revision()
2708
1711
self.pull(master, overwrite=True)
2709
if self.repository.get_graph().is_ancestor(old_tip,
2710
_mod_revision.ensure_null(self.last_revision())):
1712
if old_tip in self.repository.get_ancestry(self.last_revision()):
2716
class BzrBranch8(BzrBranch5):
2717
"""A branch that stores tree-reference locations."""
2719
def _open_hook(self):
2720
if self._ignore_fallbacks:
1718
class BzrBranchExperimental(BzrBranch5):
1719
"""Bzr experimental branch format
1722
- a revision-history file.
1724
- a lock dir guarding the branch itself
1725
- all of this stored in a branch/ subdirectory
1726
- works with shared repositories.
1727
- a tag dictionary in the branch
1729
This format is new in bzr 0.15, but shouldn't be used for real data,
1732
This class acts as it's own BranchFormat.
1735
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1738
def get_format_string(cls):
1739
"""See BranchFormat.get_format_string()."""
1740
return "Bazaar-NG branch format experimental\n"
1743
def get_format_description(cls):
1744
"""See BranchFormat.get_format_description()."""
1745
return "Experimental branch format"
1748
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1750
branch_transport = a_bzrdir.get_branch_transport(cls)
1751
control_files = lockable_files.LockableFiles(branch_transport,
1752
lock_filename, lock_class)
1753
control_files.create_lock()
1754
control_files.lock_write()
2723
url = self.get_stacked_on_url()
2724
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2725
errors.UnstackableBranchFormat):
2728
for hook in Branch.hooks['transform_fallback_location']:
2729
url = hook(self, url)
2731
hook_name = Branch.hooks.get_hook_name(hook)
2732
raise AssertionError(
2733
"'transform_fallback_location' hook %s returned "
2734
"None, not a URL." % hook_name)
2735
self._activate_fallback_location(url)
2737
def __init__(self, *args, **kwargs):
2738
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2739
super(BzrBranch8, self).__init__(*args, **kwargs)
2740
self._last_revision_info_cache = None
2741
self._reference_info = None
2743
def _clear_cached_state(self):
2744
super(BzrBranch8, self)._clear_cached_state()
2745
self._last_revision_info_cache = None
2746
self._reference_info = None
2748
def _last_revision_info(self):
2749
revision_string = self._transport.get_bytes('last-revision')
1756
for filename, content in utf8_files:
1757
control_files.put_utf8(filename, content)
1759
control_files.unlock()
1762
def initialize(cls, a_bzrdir):
1763
"""Create a branch of this format in a_bzrdir."""
1764
utf8_files = [('format', cls.get_format_string()),
1765
('revision-history', ''),
1766
('branch-name', ''),
1769
cls._initialize_control_files(a_bzrdir, utf8_files,
1770
'lock', lockdir.LockDir)
1771
return cls.open(a_bzrdir, _found=True)
1774
def open(cls, a_bzrdir, _found=False):
1775
"""Return the branch object for a_bzrdir
1777
_found is a private parameter, do not use it. It is used to indicate
1778
if format probing has already be done.
1781
format = BranchFormat.find_format(a_bzrdir)
1782
assert format.__class__ == cls
1783
transport = a_bzrdir.get_branch_transport(None)
1784
control_files = lockable_files.LockableFiles(transport, 'lock',
1786
return cls(_format=cls,
1787
_control_files=control_files,
1789
_repository=a_bzrdir.find_repository())
1792
def is_supported(cls):
1795
def _make_tags(self):
1796
return BasicTags(self)
1799
def supports_tags(cls):
1803
BranchFormat.register_format(BzrBranchExperimental)
1806
class BzrBranch6(BzrBranch5):
1809
def last_revision_info(self):
1810
revision_string = self.control_files.get('last-revision').read()
2750
1811
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2751
1812
revision_id = cache_utf8.get_cached_utf8(revision_id)
2752
1813
revno = int(revno)
2753
1814
return revno, revision_id
1816
def last_revision(self):
1817
"""Return last revision id, or None"""
1818
revision_id = self.last_revision_info()[1]
1819
if revision_id == _mod_revision.NULL_REVISION:
2755
1823
def _write_last_revision_info(self, revno, revision_id):
2756
1824
"""Simply write out the revision id, with no checks.
2831
1902
"""Set the parent branch"""
2832
1903
return self._get_config_location('parent_location')
2835
def _set_all_reference_info(self, info_dict):
2836
"""Replace all reference info stored in a branch.
2838
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2841
writer = rio.RioWriter(s)
2842
for key, (tree_path, branch_location) in info_dict.iteritems():
2843
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2844
branch_location=branch_location)
2845
writer.write_stanza(stanza)
2846
self._transport.put_bytes('references', s.getvalue())
2847
self._reference_info = info_dict
2850
def _get_all_reference_info(self):
2851
"""Return all the reference info stored in a branch.
2853
:return: A dict of {file_id: (tree_path, branch_location)}
2855
if self._reference_info is not None:
2856
return self._reference_info
2857
rio_file = self._transport.get('references')
2859
stanzas = rio.read_stanzas(rio_file)
2860
info_dict = dict((s['file_id'], (s['tree_path'],
2861
s['branch_location'])) for s in stanzas)
2864
self._reference_info = info_dict
2867
def set_reference_info(self, file_id, tree_path, branch_location):
2868
"""Set the branch location to use for a tree reference.
2870
:param file_id: The file-id of the tree reference.
2871
:param tree_path: The path of the tree reference in the tree.
2872
:param branch_location: The location of the branch to retrieve tree
2875
info_dict = self._get_all_reference_info()
2876
info_dict[file_id] = (tree_path, branch_location)
2877
if None in (tree_path, branch_location):
2878
if tree_path is not None:
2879
raise ValueError('tree_path must be None when branch_location'
2881
if branch_location is not None:
2882
raise ValueError('branch_location must be None when tree_path'
2884
del info_dict[file_id]
2885
self._set_all_reference_info(info_dict)
2887
def get_reference_info(self, file_id):
2888
"""Get the tree_path and branch_location for a tree reference.
2890
:return: a tuple of (tree_path, branch_location)
2892
return self._get_all_reference_info().get(file_id, (None, None))
2894
def reference_parent(self, file_id, path, possible_transports=None):
2895
"""Return the parent branch for a tree-reference file_id.
2897
:param file_id: The file_id of the tree reference
2898
:param path: The path of the file_id in the tree
2899
:return: A branch associated with the file_id
2901
branch_location = self.get_reference_info(file_id)[1]
2902
if branch_location is None:
2903
return Branch.reference_parent(self, file_id, path,
2904
possible_transports)
2905
branch_location = urlutils.join(self.user_url, branch_location)
2906
return Branch.open(branch_location,
2907
possible_transports=possible_transports)
2909
1905
def set_push_location(self, location):
2910
1906
"""See Branch.set_push_location."""
2911
1907
self._set_config_location('push_location', location)
2913
1909
def set_bound_location(self, location):
2914
1910
"""See Branch.set_push_location."""
2915
self._master_branch_cache = None
2917
1912
config = self.get_config()
2918
1913
if location is None:
2919
1914
if config.get_user_option('bound') != 'True':
2922
config.set_user_option('bound', 'False', warn_masked=True)
1917
config.set_user_option('bound', 'False')
2925
1920
self._set_config_location('bound_location', location,
2927
config.set_user_option('bound', 'True', warn_masked=True)
1922
config.set_user_option('bound', 'True')
2930
1925
def _get_bound_location(self, bound):
2945
1940
"""See Branch.get_old_bound_location"""
2946
1941
return self._get_bound_location(False)
2948
def get_stacked_on_url(self):
2949
# you can always ask for the URL; but you might not be able to use it
2950
# if the repo can't support stacking.
2951
## self._check_stackable_repo()
2952
stacked_url = self._get_config_location('stacked_on_location')
2953
if stacked_url is None:
2954
raise errors.NotStacked(self)
1943
def set_append_revisions_only(self, enabled):
1948
self.get_config().set_user_option('append_revisions_only', value)
2957
1950
def _get_append_revisions_only(self):
2958
return self.get_config(
2959
).get_user_option_as_bool('append_revisions_only')
2962
def generate_revision_history(self, revision_id, last_rev=None,
2964
"""See BzrBranch5.generate_revision_history"""
2965
history = self._lefthand_history(revision_id, last_rev, other_branch)
2966
revno = len(history)
2967
self.set_last_revision_info(revno, revision_id)
2970
def get_rev_id(self, revno, history=None):
2971
"""Find the revision id of the specified revno."""
2973
return _mod_revision.NULL_REVISION
2975
last_revno, last_revision_id = self.last_revision_info()
2976
if revno <= 0 or revno > last_revno:
2977
raise errors.NoSuchRevision(self, revno)
2979
if history is not None:
2980
return history[revno - 1]
2982
index = last_revno - revno
2983
if len(self._partial_revision_history_cache) <= index:
2984
self._extend_partial_history(stop_index=index)
2985
if len(self._partial_revision_history_cache) > index:
2986
return self._partial_revision_history_cache[index]
1951
value = self.get_config().get_user_option('append_revisions_only')
1952
return value == 'True'
1954
def _synchronize_history(self, destination, revision_id):
1955
"""Synchronize last revision and revision history between branches.
1957
This version is most efficient when the destination is also a
1958
BzrBranch6, but works for BzrBranch5, as long as the destination's
1959
repository contains all the lefthand ancestors of the intended
1960
last_revision. If not, set_last_revision_info will fail.
1962
:param destination: The branch to copy the history into
1963
:param revision_id: The revision-id to truncate history at. May
1964
be None to copy complete history.
1966
if revision_id is None:
1967
revno, revision_id = self.last_revision_info()
2988
raise errors.NoSuchRevision(self, revno)
2991
def revision_id_to_revno(self, revision_id):
2992
"""Given a revision id, return its revno"""
2993
if _mod_revision.is_null(revision_id):
2996
index = self._partial_revision_history_cache.index(revision_id)
2999
self._extend_partial_history(stop_revision=revision_id)
3000
except errors.RevisionNotPresent, e:
3001
raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
3002
index = len(self._partial_revision_history_cache) - 1
3003
if self._partial_revision_history_cache[index] != revision_id:
3004
raise errors.NoSuchRevision(self, revision_id)
3005
return self.revno() - index
3008
class BzrBranch7(BzrBranch8):
3009
"""A branch with support for a fallback repository."""
3011
def set_reference_info(self, file_id, tree_path, branch_location):
3012
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3014
def get_reference_info(self, file_id):
3015
Branch.get_reference_info(self, file_id)
3017
def reference_parent(self, file_id, path, possible_transports=None):
3018
return Branch.reference_parent(self, file_id, path,
3019
possible_transports)
3022
class BzrBranch6(BzrBranch7):
3023
"""See BzrBranchFormat6 for the capabilities of this branch.
3025
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
1969
revno = self.revision_id_to_revno(revision_id)
1970
destination.set_last_revision_info(revno, revision_id)
1972
def _make_tags(self):
1973
return BasicTags(self)
1976
class BranchTestProviderAdapter(object):
1977
"""A tool to generate a suite testing multiple branch formats at once.
1979
This is done by copying the test once for each transport and injecting
1980
the transport_server, transport_readonly_server, and branch_format
1981
classes into each copy. Each copy is also given a new id() to make it
3029
def get_stacked_on_url(self):
3030
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1985
def __init__(self, transport_server, transport_readonly_server, formats):
1986
self._transport_server = transport_server
1987
self._transport_readonly_server = transport_readonly_server
1988
self._formats = formats
1990
def adapt(self, test):
1991
result = TestSuite()
1992
for branch_format, bzrdir_format in self._formats:
1993
new_test = deepcopy(test)
1994
new_test.transport_server = self._transport_server
1995
new_test.transport_readonly_server = self._transport_readonly_server
1996
new_test.bzrdir_format = bzrdir_format
1997
new_test.branch_format = branch_format
1998
def make_new_test_id():
1999
# the format can be either a class or an instance
2000
name = getattr(branch_format, '__name__',
2001
branch_format.__class__.__name__)
2002
new_id = "%s(%s)" % (new_test.id(), name)
2003
return lambda: new_id
2004
new_test.id = make_new_test_id()
2005
result.addTest(new_test)
3033
2009
######################################################################
3051
2027
:ivar new_revno: Revision number after pull.
3052
2028
:ivar old_revid: Tip revision id before pull.
3053
2029
:ivar new_revid: Tip revision id after pull.
3054
:ivar source_branch: Source (local) branch object. (read locked)
3055
:ivar master_branch: Master branch of the target, or the target if no
3057
:ivar local_branch: target branch if there is a Master, else None
3058
:ivar target_branch: Target/destination branch object. (write locked)
3059
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2030
:ivar source_branch: Source (local) branch object.
2031
:ivar master_branch: Master branch of the target, or None.
2032
:ivar target_branch: Target/destination branch object.
3062
@deprecated_method(deprecated_in((2, 3, 0)))
3063
2035
def __int__(self):
3064
"""Return the relative change in revno.
3066
:deprecated: Use `new_revno` and `old_revno` instead.
2036
# DEPRECATED: pull used to return the change in revno
3068
2037
return self.new_revno - self.old_revno
3070
2039
def report(self, to_file):
3072
if self.old_revid == self.new_revid:
3073
to_file.write('No revisions to pull.\n')
3075
to_file.write('Now on revision %d.\n' % self.new_revno)
2040
if self.old_revid == self.new_revid:
2041
to_file.write('No revisions to pull.\n')
2043
to_file.write('Now on revision %d.\n' % self.new_revno)
3076
2044
self._show_tag_conficts(to_file)
3079
class BranchPushResult(_Result):
2047
class PushResult(_Result):
3080
2048
"""Result of a Branch.push operation.
3082
:ivar old_revno: Revision number (eg 10) of the target before push.
3083
:ivar new_revno: Revision number (eg 12) of the target after push.
3084
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3086
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3088
:ivar source_branch: Source branch object that the push was from. This is
3089
read locked, and generally is a local (and thus low latency) branch.
3090
:ivar master_branch: If target is a bound branch, the master branch of
3091
target, or target itself. Always write locked.
3092
:ivar target_branch: The direct Branch where data is being sent (write
3094
:ivar local_branch: If the target is a bound branch this will be the
3095
target, otherwise it will be None.
2050
:ivar old_revno: Revision number before push.
2051
:ivar new_revno: Revision number after push.
2052
:ivar old_revid: Tip revision id before push.
2053
:ivar new_revid: Tip revision id after push.
2054
:ivar source_branch: Source branch object.
2055
:ivar master_branch: Master branch of the target, or None.
2056
:ivar target_branch: Target/destination branch object.
3098
@deprecated_method(deprecated_in((2, 3, 0)))
3099
2059
def __int__(self):
3100
"""Return the relative change in revno.
3102
:deprecated: Use `new_revno` and `old_revno` instead.
2060
# DEPRECATED: push used to return the change in revno
3104
2061
return self.new_revno - self.old_revno
3106
2063
def report(self, to_file):
3107
2064
"""Write a human-readable description of the result."""
3108
2065
if self.old_revid == self.new_revid:
3109
note('No new revisions to push.')
2066
to_file.write('No new revisions to push.\n')
3111
note('Pushed up to revision %d.' % self.new_revno)
2068
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
3112
2069
self._show_tag_conficts(to_file)
3152
2107
new_branch.tags._set_tag_dict({})
3154
2109
# Copying done; now update target format
3155
new_branch._transport.put_bytes('format',
3156
format.get_format_string(),
3157
mode=new_branch.bzrdir._get_file_mode())
2110
new_branch.control_files.put_utf8('format',
2111
format.get_format_string())
3159
2113
# Clean up old files
3160
new_branch._transport.delete('revision-history')
2114
new_branch.control_files._transport.delete('revision-history')
3162
2116
branch.set_parent(None)
3163
except errors.NoSuchFile:
3165
2119
branch.set_bound_location(None)
3168
class Converter6to7(object):
3169
"""Perform an in-place upgrade of format 6 to format 7"""
3171
def convert(self, branch):
3172
format = BzrBranchFormat7()
3173
branch._set_config_location('stacked_on_location', '')
3174
# update target format
3175
branch._transport.put_bytes('format', format.get_format_string())
3178
class Converter7to8(object):
3179
"""Perform an in-place upgrade of format 6 to format 7"""
3181
def convert(self, branch):
3182
format = BzrBranchFormat8()
3183
branch._transport.put_bytes('references', '')
3184
# update target format
3185
branch._transport.put_bytes('format', format.get_format_string())
3188
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3189
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3192
_run_with_write_locked_target will attempt to release the lock it acquires.
3194
If an exception is raised by callable, then that exception *will* be
3195
propagated, even if the unlock attempt raises its own error. Thus
3196
_run_with_write_locked_target should be preferred to simply doing::
3200
return callable(*args, **kwargs)
3205
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3206
# should share code?
3209
result = callable(*args, **kwargs)
3211
exc_info = sys.exc_info()
3215
raise exc_info[0], exc_info[1], exc_info[2]
3221
class InterBranch(InterObject):
3222
"""This class represents operations taking place between two branches.
3224
Its instances have methods like pull() and push() and contain
3225
references to the source and target repositories these operations
3226
can be carried out on.
3230
"""The available optimised InterBranch types."""
3233
def _get_branch_formats_to_test(klass):
3234
"""Return an iterable of format tuples for testing.
3236
:return: An iterable of (from_format, to_format) to use when testing
3237
this InterBranch class. Each InterBranch class should define this
3240
raise NotImplementedError(klass._get_branch_formats_to_test)
3243
def pull(self, overwrite=False, stop_revision=None,
3244
possible_transports=None, local=False):
3245
"""Mirror source into target branch.
3247
The target branch is considered to be 'local', having low latency.
3249
:returns: PullResult instance
3251
raise NotImplementedError(self.pull)
3254
def push(self, overwrite=False, stop_revision=None,
3255
_override_hook_source_branch=None):
3256
"""Mirror the source branch into the target branch.
3258
The source branch is considered to be 'local', having low latency.
3260
raise NotImplementedError(self.push)
3263
def copy_content_into(self, revision_id=None):
3264
"""Copy the content of source into target
3266
revision_id: if not None, the revision history in the new branch will
3267
be truncated to end with revision_id.
3269
raise NotImplementedError(self.copy_content_into)
3272
def fetch(self, stop_revision=None):
3275
:param stop_revision: Last revision to fetch
3277
raise NotImplementedError(self.fetch)
3280
class GenericInterBranch(InterBranch):
3281
"""InterBranch implementation that uses public Branch functions."""
3284
def is_compatible(klass, source, target):
3285
# GenericBranch uses the public API, so always compatible
3289
def _get_branch_formats_to_test(klass):
3290
return [(format_registry.get_default(), format_registry.get_default())]
3293
def unwrap_format(klass, format):
3294
if isinstance(format, remote.RemoteBranchFormat):
3295
format._ensure_real()
3296
return format._custom_format
3300
def copy_content_into(self, revision_id=None):
3301
"""Copy the content of source into target
3303
revision_id: if not None, the revision history in the new branch will
3304
be truncated to end with revision_id.
3306
self.source.update_references(self.target)
3307
self.source._synchronize_history(self.target, revision_id)
3309
parent = self.source.get_parent()
3310
except errors.InaccessibleParent, e:
3311
mutter('parent was not accessible to copy: %s', e)
3314
self.target.set_parent(parent)
3315
if self.source._push_should_merge_tags():
3316
self.source.tags.merge_to(self.target.tags)
3319
def fetch(self, stop_revision=None):
3320
if self.target.base == self.source.base:
3322
self.source.lock_read()
3324
fetch_spec_factory = fetch.FetchSpecFactory()
3325
fetch_spec_factory.source_branch = self.source
3326
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3327
fetch_spec_factory.source_repo = self.source.repository
3328
fetch_spec_factory.target_repo = self.target.repository
3329
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3330
fetch_spec = fetch_spec_factory.make_fetch_spec()
3331
return self.target.repository.fetch(self.source.repository,
3332
fetch_spec=fetch_spec)
3334
self.source.unlock()
3337
def _update_revisions(self, stop_revision=None, overwrite=False,
3339
other_revno, other_last_revision = self.source.last_revision_info()
3340
stop_revno = None # unknown
3341
if stop_revision is None:
3342
stop_revision = other_last_revision
3343
if _mod_revision.is_null(stop_revision):
3344
# if there are no commits, we're done.
3346
stop_revno = other_revno
3348
# what's the current last revision, before we fetch [and change it
3350
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3351
# we fetch here so that we don't process data twice in the common
3352
# case of having something to pull, and so that the check for
3353
# already merged can operate on the just fetched graph, which will
3354
# be cached in memory.
3355
self.fetch(stop_revision=stop_revision)
3356
# Check to see if one is an ancestor of the other
3359
graph = self.target.repository.get_graph()
3360
if self.target._check_if_descendant_or_diverged(
3361
stop_revision, last_rev, graph, self.source):
3362
# stop_revision is a descendant of last_rev, but we aren't
3363
# overwriting, so we're done.
3365
if stop_revno is None:
3367
graph = self.target.repository.get_graph()
3368
this_revno, this_last_revision = \
3369
self.target.last_revision_info()
3370
stop_revno = graph.find_distance_to_null(stop_revision,
3371
[(other_last_revision, other_revno),
3372
(this_last_revision, this_revno)])
3373
self.target.set_last_revision_info(stop_revno, stop_revision)
3376
def pull(self, overwrite=False, stop_revision=None,
3377
possible_transports=None, run_hooks=True,
3378
_override_hook_target=None, local=False):
3379
"""Pull from source into self, updating my master if any.
3381
:param run_hooks: Private parameter - if false, this branch
3382
is being called because it's the master of the primary branch,
3383
so it should not run its hooks.
3385
bound_location = self.target.get_bound_location()
3386
if local and not bound_location:
3387
raise errors.LocalRequiresBoundBranch()
3388
master_branch = None
3389
source_is_master = (self.source.user_url == bound_location)
3390
if not local and bound_location and not source_is_master:
3391
# not pulling from master, so we need to update master.
3392
master_branch = self.target.get_master_branch(possible_transports)
3393
master_branch.lock_write()
3396
# pull from source into master.
3397
master_branch.pull(self.source, overwrite, stop_revision,
3399
return self._pull(overwrite,
3400
stop_revision, _hook_master=master_branch,
3401
run_hooks=run_hooks,
3402
_override_hook_target=_override_hook_target,
3403
merge_tags_to_master=not source_is_master)
3406
master_branch.unlock()
3408
def push(self, overwrite=False, stop_revision=None,
3409
_override_hook_source_branch=None):
3410
"""See InterBranch.push.
3412
This is the basic concrete implementation of push()
3414
:param _override_hook_source_branch: If specified, run
3415
the hooks passing this Branch as the source, rather than self.
3416
This is for use of RemoteBranch, where push is delegated to the
3417
underlying vfs-based Branch.
3419
# TODO: Public option to disable running hooks - should be trivial but
3421
self.source.lock_read()
3423
return _run_with_write_locked_target(
3424
self.target, self._push_with_bound_branches, overwrite,
3426
_override_hook_source_branch=_override_hook_source_branch)
3428
self.source.unlock()
3430
def _basic_push(self, overwrite, stop_revision):
3431
"""Basic implementation of push without bound branches or hooks.
3433
Must be called with source read locked and target write locked.
3435
result = BranchPushResult()
3436
result.source_branch = self.source
3437
result.target_branch = self.target
3438
result.old_revno, result.old_revid = self.target.last_revision_info()
3439
self.source.update_references(self.target)
3440
if result.old_revid != stop_revision:
3441
# We assume that during 'push' this repository is closer than
3443
graph = self.source.repository.get_graph(self.target.repository)
3444
self._update_revisions(stop_revision, overwrite=overwrite,
3446
if self.source._push_should_merge_tags():
3447
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3449
result.new_revno, result.new_revid = self.target.last_revision_info()
3452
def _push_with_bound_branches(self, overwrite, stop_revision,
3453
_override_hook_source_branch=None):
3454
"""Push from source into target, and into target's master if any.
3457
if _override_hook_source_branch:
3458
result.source_branch = _override_hook_source_branch
3459
for hook in Branch.hooks['post_push']:
3462
bound_location = self.target.get_bound_location()
3463
if bound_location and self.target.base != bound_location:
3464
# there is a master branch.
3466
# XXX: Why the second check? Is it even supported for a branch to
3467
# be bound to itself? -- mbp 20070507
3468
master_branch = self.target.get_master_branch()
3469
master_branch.lock_write()
3471
# push into the master from the source branch.
3472
master_inter = InterBranch.get(self.source, master_branch)
3473
master_inter._basic_push(overwrite, stop_revision)
3474
# and push into the target branch from the source. Note that
3475
# we push from the source branch again, because it's considered
3476
# the highest bandwidth repository.
3477
result = self._basic_push(overwrite, stop_revision)
3478
result.master_branch = master_branch
3479
result.local_branch = self.target
3483
master_branch.unlock()
3486
result = self._basic_push(overwrite, stop_revision)
3487
# TODO: Why set master_branch and local_branch if there's no
3488
# binding? Maybe cleaner to just leave them unset? -- mbp
3490
result.master_branch = self.target
3491
result.local_branch = None
3495
def _pull(self, overwrite=False, stop_revision=None,
3496
possible_transports=None, _hook_master=None, run_hooks=True,
3497
_override_hook_target=None, local=False,
3498
merge_tags_to_master=True):
3501
This function is the core worker, used by GenericInterBranch.pull to
3502
avoid duplication when pulling source->master and source->local.
3504
:param _hook_master: Private parameter - set the branch to
3505
be supplied as the master to pull hooks.
3506
:param run_hooks: Private parameter - if false, this branch
3507
is being called because it's the master of the primary branch,
3508
so it should not run its hooks.
3509
is being called because it's the master of the primary branch,
3510
so it should not run its hooks.
3511
:param _override_hook_target: Private parameter - set the branch to be
3512
supplied as the target_branch to pull hooks.
3513
:param local: Only update the local branch, and not the bound branch.
3515
# This type of branch can't be bound.
3517
raise errors.LocalRequiresBoundBranch()
3518
result = PullResult()
3519
result.source_branch = self.source
3520
if _override_hook_target is None:
3521
result.target_branch = self.target
3523
result.target_branch = _override_hook_target
3524
self.source.lock_read()
3526
# We assume that during 'pull' the target repository is closer than
3528
self.source.update_references(self.target)
3529
graph = self.target.repository.get_graph(self.source.repository)
3530
# TODO: Branch formats should have a flag that indicates
3531
# that revno's are expensive, and pull() should honor that flag.
3533
result.old_revno, result.old_revid = \
3534
self.target.last_revision_info()
3535
self._update_revisions(stop_revision, overwrite=overwrite,
3537
# TODO: The old revid should be specified when merging tags,
3538
# so a tags implementation that versions tags can only
3539
# pull in the most recent changes. -- JRV20090506
3540
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3541
overwrite, ignore_master=not merge_tags_to_master)
3542
result.new_revno, result.new_revid = self.target.last_revision_info()
3544
result.master_branch = _hook_master
3545
result.local_branch = result.target_branch
3547
result.master_branch = result.target_branch
3548
result.local_branch = None
3550
for hook in Branch.hooks['post_pull']:
3553
self.source.unlock()
3557
InterBranch.register_optimiser(GenericInterBranch)