121
110
if master is not None:
122
111
master.break_lock()
124
def _check_stackable_repo(self):
125
if not self.repository._format.supports_external_lookups:
126
raise errors.UnstackableRepositoryFormat(self.repository._format,
127
self.repository.base)
129
def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
"""Extend the partial history to include a given index
132
If a stop_index is supplied, stop when that index has been reached.
133
If a stop_revision is supplied, stop when that revision is
134
encountered. Otherwise, stop when the beginning of history is
137
:param stop_index: The index which should be present. When it is
138
present, history extension will stop.
139
:param stop_revision: The revision id which should be present. When
140
it is encountered, history extension will stop.
142
if len(self._partial_revision_history_cache) == 0:
143
self._partial_revision_history_cache = [self.last_revision()]
144
repository._iter_for_revno(
145
self.repository, self._partial_revision_history_cache,
146
stop_index=stop_index, stop_revision=stop_revision)
147
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
self._partial_revision_history_cache.pop()
150
def _get_check_refs(self):
151
"""Get the references needed for check().
155
revid = self.last_revision()
156
return [('revision-existence', revid), ('lefthand-distance', revid)]
159
def open(base, _unsupported=False, possible_transports=None):
160
"""Open the branch rooted at base.
162
For instance, if the branch is at URL/.bzr/branch,
163
Branch.open(URL) -> a Branch instance.
165
control = bzrdir.BzrDir.open(base, _unsupported,
166
possible_transports=possible_transports)
167
return control.open_branch(unsupported=_unsupported)
170
def open_from_transport(transport, name=None, _unsupported=False):
171
"""Open the branch rooted at transport"""
172
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
return control.open_branch(name=name, unsupported=_unsupported)
176
def open_containing(url, possible_transports=None):
114
@deprecated_method(zero_eight)
115
def open_downlevel(base):
116
"""Open a branch which may be of an old format."""
117
return Branch.open(base, _unsupported=True)
120
def open(base, _unsupported=False):
121
"""Open the repository rooted at base.
123
For instance, if the repository is at URL/.bzr/repository,
124
Repository.open(URL) -> a Repository instance.
126
control = bzrdir.BzrDir.open(base, _unsupported)
127
return control.open_branch(_unsupported)
130
def open_containing(url):
177
131
"""Open an existing branch which contains url.
179
133
This probes for a branch at url, and searches upwards from there.
181
135
Basically we keep looking up until we find the control directory or
182
136
run into the root. If there isn't one, raises NotBranchError.
183
If there is one and it is either an unrecognised format or an unsupported
137
If there is one and it is either an unrecognised format or an unsupported
184
138
format, UnknownFormatError or UnsupportedFormatError are raised.
185
139
If there is one, it is returned, along with the unused portion of url.
187
control, relpath = bzrdir.BzrDir.open_containing(url,
141
control, relpath = bzrdir.BzrDir.open_containing(url)
189
142
return control.open_branch(), relpath
191
def _push_should_merge_tags(self):
192
"""Should _basic_push merge this branch's tags into the target?
194
The default implementation returns False if this branch has no tags,
195
and True the rest of the time. Subclasses may override this.
197
return self.supports_tags() and self.tags.get_tag_dict()
199
def get_config(self):
200
return BranchConfig(self)
202
def _get_config(self):
203
"""Get the concrete config for just the config in this branch.
205
This is not intended for client use; see Branch.get_config for the
210
:return: An object supporting get_option and set_option.
212
raise NotImplementedError(self._get_config)
214
def _get_fallback_repository(self, url):
215
"""Get the repository we fallback to at url."""
216
url = urlutils.join(self.base, url)
217
a_branch = Branch.open(url,
218
possible_transports=[self.bzrdir.root_transport])
219
return a_branch.repository
221
def _get_tags_bytes(self):
222
"""Get the bytes of a serialised tags dict.
224
Note that not all branches support tags, nor do all use the same tags
225
logic: this method is specific to BasicTags. Other tag implementations
226
may use the same method name and behave differently, safely, because
227
of the double-dispatch via
228
format.make_tags->tags_instance->get_tags_dict.
230
:return: The bytes of the tags file.
231
:seealso: Branch._set_tags_bytes.
233
return self._transport.get_bytes('tags')
235
def _get_nick(self, local=False, possible_transports=None):
236
config = self.get_config()
237
# explicit overrides master, but don't look for master if local is True
238
if not local and not config.has_explicit_nickname():
240
master = self.get_master_branch(possible_transports)
241
if master is not None:
242
# return the master branch value
244
except errors.BzrError, e:
245
# Silently fall back to local implicit nick if the master is
247
mutter("Could not connect to bound branch, "
248
"falling back to local nick.\n " + str(e))
249
return config.get_nickname()
145
@deprecated_function(zero_eight)
146
def initialize(base):
147
"""Create a new working tree and branch, rooted at 'base' (url)
149
NOTE: This will soon be deprecated in favour of creation
152
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
154
def setup_caching(self, cache_root):
155
"""Subclasses that care about caching should override this, and set
156
up cached stores located under cache_root.
158
# seems to be unused, 2006-01-13 mbp
159
warn('%s is deprecated' % self.setup_caching)
160
self.cache_root = cache_root
163
cfg = self.tree_config()
164
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
251
166
def _set_nick(self, nick):
252
self.get_config().set_user_option('nickname', nick, warn_masked=True)
167
cfg = self.tree_config()
168
cfg.set_option(nick, "nickname")
169
assert cfg.get_option("nickname") == nick
254
171
nick = property(_get_nick, _set_nick)
256
173
def is_locked(self):
257
raise NotImplementedError(self.is_locked)
259
def _lefthand_history(self, revision_id, last_rev=None,
261
if 'evil' in debug.debug_flags:
262
mutter_callsite(4, "_lefthand_history scales with history.")
263
# stop_revision must be a descendant of last_revision
264
graph = self.repository.get_graph()
265
if last_rev is not None:
266
if not graph.is_ancestor(last_rev, revision_id):
267
# our previous tip is not merged into stop_revision
268
raise errors.DivergedBranches(self, other_branch)
269
# make a new revision history from the graph
270
parents_map = graph.get_parent_map([revision_id])
271
if revision_id not in parents_map:
272
raise errors.NoSuchRevision(self, revision_id)
273
current_rev_id = revision_id
275
check_not_reserved_id = _mod_revision.check_not_reserved_id
276
# Do not include ghosts or graph origin in revision_history
277
while (current_rev_id in parents_map and
278
len(parents_map[current_rev_id]) > 0):
279
check_not_reserved_id(current_rev_id)
280
new_history.append(current_rev_id)
281
current_rev_id = parents_map[current_rev_id][0]
282
parents_map = graph.get_parent_map([current_rev_id])
283
new_history.reverse()
286
def lock_write(self, token=None):
287
"""Lock the branch for write operations.
289
:param token: A token to permit reacquiring a previously held and
291
:return: A BranchWriteLockResult.
293
raise NotImplementedError(self.lock_write)
174
raise NotImplementedError('is_locked is abstract')
176
def lock_write(self):
177
raise NotImplementedError('lock_write is abstract')
295
179
def lock_read(self):
296
"""Lock the branch for read operations.
298
:return: A bzrlib.lock.LogicalLockResult.
300
raise NotImplementedError(self.lock_read)
180
raise NotImplementedError('lock_read is abstract')
302
182
def unlock(self):
303
raise NotImplementedError(self.unlock)
183
raise NotImplementedError('unlock is abstract')
305
185
def peek_lock_mode(self):
306
186
"""Return lock mode for the Branch: 'r', 'w' or None"""
307
187
raise NotImplementedError(self.peek_lock_mode)
309
189
def get_physical_lock_status(self):
310
raise NotImplementedError(self.get_physical_lock_status)
313
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
314
"""Return the revision_id for a dotted revno.
316
:param revno: a tuple like (1,) or (1,1,2)
317
:param _cache_reverse: a private parameter enabling storage
318
of the reverse mapping in a top level cache. (This should
319
only be done in selective circumstances as we want to
320
avoid having the mapping cached multiple times.)
321
:return: the revision_id
322
:raises errors.NoSuchRevision: if the revno doesn't exist
324
rev_id = self._do_dotted_revno_to_revision_id(revno)
326
self._partial_revision_id_to_revno_cache[rev_id] = revno
329
def _do_dotted_revno_to_revision_id(self, revno):
330
"""Worker function for dotted_revno_to_revision_id.
332
Subclasses should override this if they wish to
333
provide a more efficient implementation.
336
return self.get_rev_id(revno[0])
337
revision_id_to_revno = self.get_revision_id_to_revno_map()
338
revision_ids = [revision_id for revision_id, this_revno
339
in revision_id_to_revno.iteritems()
340
if revno == this_revno]
341
if len(revision_ids) == 1:
342
return revision_ids[0]
344
revno_str = '.'.join(map(str, revno))
345
raise errors.NoSuchRevision(self, revno_str)
348
def revision_id_to_dotted_revno(self, revision_id):
349
"""Given a revision id, return its dotted revno.
351
:return: a tuple like (1,) or (400,1,3).
353
return self._do_revision_id_to_dotted_revno(revision_id)
355
def _do_revision_id_to_dotted_revno(self, revision_id):
356
"""Worker function for revision_id_to_revno."""
357
# Try the caches if they are loaded
358
result = self._partial_revision_id_to_revno_cache.get(revision_id)
359
if result is not None:
361
if self._revision_id_to_revno_cache:
362
result = self._revision_id_to_revno_cache.get(revision_id)
364
raise errors.NoSuchRevision(self, revision_id)
365
# Try the mainline as it's optimised
367
revno = self.revision_id_to_revno(revision_id)
369
except errors.NoSuchRevision:
370
# We need to load and use the full revno map after all
371
result = self.get_revision_id_to_revno_map().get(revision_id)
373
raise errors.NoSuchRevision(self, revision_id)
377
def get_revision_id_to_revno_map(self):
378
"""Return the revision_id => dotted revno map.
380
This will be regenerated on demand, but will be cached.
382
:return: A dictionary mapping revision_id => dotted revno.
383
This dictionary should not be modified by the caller.
385
if self._revision_id_to_revno_cache is not None:
386
mapping = self._revision_id_to_revno_cache
388
mapping = self._gen_revno_map()
389
self._cache_revision_id_to_revno(mapping)
390
# TODO: jam 20070417 Since this is being cached, should we be returning
392
# I would rather not, and instead just declare that users should not
393
# modify the return value.
396
def _gen_revno_map(self):
397
"""Create a new mapping from revision ids to dotted revnos.
399
Dotted revnos are generated based on the current tip in the revision
401
This is the worker function for get_revision_id_to_revno_map, which
402
just caches the return value.
404
:return: A dictionary mapping revision_id => dotted revno.
406
revision_id_to_revno = dict((rev_id, revno)
407
for rev_id, depth, revno, end_of_merge
408
in self.iter_merge_sorted_revisions())
409
return revision_id_to_revno
412
def iter_merge_sorted_revisions(self, start_revision_id=None,
413
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
414
"""Walk the revisions for a branch in merge sorted order.
416
Merge sorted order is the output from a merge-aware,
417
topological sort, i.e. all parents come before their
418
children going forward; the opposite for reverse.
420
:param start_revision_id: the revision_id to begin walking from.
421
If None, the branch tip is used.
422
:param stop_revision_id: the revision_id to terminate the walk
423
after. If None, the rest of history is included.
424
:param stop_rule: if stop_revision_id is not None, the precise rule
425
to use for termination:
426
* 'exclude' - leave the stop revision out of the result (default)
427
* 'include' - the stop revision is the last item in the result
428
* 'with-merges' - include the stop revision and all of its
429
merged revisions in the result
430
* 'with-merges-without-common-ancestry' - filter out revisions
431
that are in both ancestries
432
:param direction: either 'reverse' or 'forward':
433
* reverse means return the start_revision_id first, i.e.
434
start at the most recent revision and go backwards in history
435
* forward returns tuples in the opposite order to reverse.
436
Note in particular that forward does *not* do any intelligent
437
ordering w.r.t. depth as some clients of this API may like.
438
(If required, that ought to be done at higher layers.)
440
:return: an iterator over (revision_id, depth, revno, end_of_merge)
443
* revision_id: the unique id of the revision
444
* depth: How many levels of merging deep this node has been
446
* revno_sequence: This field provides a sequence of
447
revision numbers for all revisions. The format is:
448
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
449
branch that the revno is on. From left to right the REVNO numbers
450
are the sequence numbers within that branch of the revision.
451
* end_of_merge: When True the next node (earlier in history) is
452
part of a different merge.
454
# Note: depth and revno values are in the context of the branch so
455
# we need the full graph to get stable numbers, regardless of the
457
if self._merge_sorted_revisions_cache is None:
458
last_revision = self.last_revision()
459
known_graph = self.repository.get_known_graph_ancestry(
461
self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
filtered = self._filter_merge_sorted_revisions(
464
self._merge_sorted_revisions_cache, start_revision_id,
465
stop_revision_id, stop_rule)
466
# Make sure we don't return revisions that are not part of the
467
# start_revision_id ancestry.
468
filtered = self._filter_start_non_ancestors(filtered)
469
if direction == 'reverse':
471
if direction == 'forward':
472
return reversed(list(filtered))
474
raise ValueError('invalid direction %r' % direction)
476
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
477
start_revision_id, stop_revision_id, stop_rule):
478
"""Iterate over an inclusive range of sorted revisions."""
479
rev_iter = iter(merge_sorted_revisions)
480
if start_revision_id is not None:
481
for node in rev_iter:
482
rev_id = node.key[-1]
483
if rev_id != start_revision_id:
486
# The decision to include the start or not
487
# depends on the stop_rule if a stop is provided
488
# so pop this node back into the iterator
489
rev_iter = chain(iter([node]), rev_iter)
491
if stop_revision_id is None:
493
for node in rev_iter:
494
rev_id = node.key[-1]
495
yield (rev_id, node.merge_depth, node.revno,
497
elif stop_rule == 'exclude':
498
for node in rev_iter:
499
rev_id = node.key[-1]
500
if rev_id == stop_revision_id:
502
yield (rev_id, node.merge_depth, node.revno,
504
elif stop_rule == 'include':
505
for node in rev_iter:
506
rev_id = node.key[-1]
507
yield (rev_id, node.merge_depth, node.revno,
509
if rev_id == stop_revision_id:
511
elif stop_rule == 'with-merges-without-common-ancestry':
512
# We want to exclude all revisions that are already part of the
513
# stop_revision_id ancestry.
514
graph = self.repository.get_graph()
515
ancestors = graph.find_unique_ancestors(start_revision_id,
517
for node in rev_iter:
518
rev_id = node.key[-1]
519
if rev_id not in ancestors:
521
yield (rev_id, node.merge_depth, node.revno,
523
elif stop_rule == 'with-merges':
524
stop_rev = self.repository.get_revision(stop_revision_id)
525
if stop_rev.parent_ids:
526
left_parent = stop_rev.parent_ids[0]
528
left_parent = _mod_revision.NULL_REVISION
529
# left_parent is the actual revision we want to stop logging at,
530
# since we want to show the merged revisions after the stop_rev too
531
reached_stop_revision_id = False
532
revision_id_whitelist = []
533
for node in rev_iter:
534
rev_id = node.key[-1]
535
if rev_id == left_parent:
536
# reached the left parent after the stop_revision
538
if (not reached_stop_revision_id or
539
rev_id in revision_id_whitelist):
540
yield (rev_id, node.merge_depth, node.revno,
542
if reached_stop_revision_id or rev_id == stop_revision_id:
543
# only do the merged revs of rev_id from now on
544
rev = self.repository.get_revision(rev_id)
546
reached_stop_revision_id = True
547
revision_id_whitelist.extend(rev.parent_ids)
549
raise ValueError('invalid stop_rule %r' % stop_rule)
551
def _filter_start_non_ancestors(self, rev_iter):
552
# If we started from a dotted revno, we want to consider it as a tip
553
# and don't want to yield revisions that are not part of its
554
# ancestry. Given the order guaranteed by the merge sort, we will see
555
# uninteresting descendants of the first parent of our tip before the
557
first = rev_iter.next()
558
(rev_id, merge_depth, revno, end_of_merge) = first
561
# We start at a mainline revision so by definition, all others
562
# revisions in rev_iter are ancestors
563
for node in rev_iter:
568
pmap = self.repository.get_parent_map([rev_id])
569
parents = pmap.get(rev_id, [])
571
whitelist.update(parents)
573
# If there is no parents, there is nothing of interest left
575
# FIXME: It's hard to test this scenario here as this code is never
576
# called in that case. -- vila 20100322
579
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
if rev_id in whitelist:
582
pmap = self.repository.get_parent_map([rev_id])
583
parents = pmap.get(rev_id, [])
584
whitelist.remove(rev_id)
585
whitelist.update(parents)
587
# We've reached the mainline, there is nothing left to
591
# A revision that is not part of the ancestry of our
594
yield (rev_id, merge_depth, revno, end_of_merge)
596
def leave_lock_in_place(self):
597
"""Tell this branch object not to release the physical lock when this
600
If lock_write doesn't return a token, then this method is not supported.
602
self.control_files.leave_in_place()
604
def dont_leave_lock_in_place(self):
605
"""Tell this branch object to release the physical lock when this
606
object is unlocked, even if it didn't originally acquire it.
608
If lock_write doesn't return a token, then this method is not supported.
610
self.control_files.dont_leave_in_place()
190
raise NotImplementedError('get_physical_lock_status is abstract')
192
def abspath(self, name):
193
"""Return absolute filename for something in the branch
195
XXX: Robert Collins 20051017 what is this used for? why is it a branch
196
method and not a tree method.
198
raise NotImplementedError('abspath is abstract')
612
200
def bind(self, other):
613
201
"""Bind the local branch the other branch.
673
def get_old_bound_location(self):
674
"""Return the URL of the branch we used to be bound to
676
raise errors.UpgradeRequired(self.user_url)
678
def get_commit_builder(self, parents, config=None, timestamp=None,
679
timezone=None, committer=None, revprops=None,
681
"""Obtain a CommitBuilder for this branch.
683
:param parents: Revision ids of the parents of the new revision.
684
:param config: Optional configuration to use.
685
:param timestamp: Optional timestamp recorded for commit.
686
:param timezone: Optional timezone for timestamp.
687
:param committer: Optional committer to set for commit.
688
:param revprops: Optional dictionary of revision properties.
689
:param revision_id: Optional revision id.
693
config = self.get_config()
695
return self.repository.get_commit_builder(self, parents, config,
696
timestamp, timezone, committer, revprops, revision_id)
698
def get_master_branch(self, possible_transports=None):
254
def get_master_branch(self):
699
255
"""Return the branch we are bound to.
701
257
:return: Either a Branch, or None
705
def get_revision_delta(self, revno):
706
"""Return the delta for one revision.
708
The delta is relative to its mainline predecessor, or the
709
empty tree for revision 1.
711
rh = self.revision_history()
712
if not (1 <= revno <= len(rh)):
713
raise errors.InvalidRevisionNumber(revno)
714
return self.repository.get_revision_delta(rh[revno-1])
716
def get_stacked_on_url(self):
717
"""Get the URL this branch is stacked against.
719
:raises NotStacked: If the branch is not stacked.
720
:raises UnstackableBranchFormat: If the branch does not support
723
raise NotImplementedError(self.get_stacked_on_url)
261
def get_root_id(self):
262
"""Return the id of this branches root"""
263
raise NotImplementedError('get_root_id is abstract')
725
265
def print_file(self, file, revision_id):
726
266
"""Print `file` to stdout."""
727
raise NotImplementedError(self.print_file)
267
raise NotImplementedError('print_file is abstract')
269
def append_revision(self, *revision_ids):
270
raise NotImplementedError('append_revision is abstract')
729
272
def set_revision_history(self, rev_history):
730
raise NotImplementedError(self.set_revision_history)
733
def set_parent(self, url):
734
"""See Branch.set_parent."""
735
# TODO: Maybe delete old location files?
736
# URLs should never be unicode, even on the local fs,
737
# FIXUP this and get_parent in a future branch format bump:
738
# read and rewrite the file. RBC 20060125
740
if isinstance(url, unicode):
742
url = url.encode('ascii')
743
except UnicodeEncodeError:
744
raise errors.InvalidURL(url,
745
"Urls must be 7-bit ascii, "
746
"use bzrlib.urlutils.escape")
747
url = urlutils.relative_url(self.base, url)
748
self._set_parent_location(url)
751
def set_stacked_on_url(self, url):
752
"""Set the URL this branch is stacked against.
754
:raises UnstackableBranchFormat: If the branch does not support
756
:raises UnstackableRepositoryFormat: If the repository does not support
759
if not self._format.supports_stacking():
760
raise errors.UnstackableBranchFormat(self._format, self.user_url)
761
# XXX: Changing from one fallback repository to another does not check
762
# that all the data you need is present in the new fallback.
763
# Possibly it should.
764
self._check_stackable_repo()
767
old_url = self.get_stacked_on_url()
768
except (errors.NotStacked, errors.UnstackableBranchFormat,
769
errors.UnstackableRepositoryFormat):
773
self._activate_fallback_location(url)
774
# write this out after the repository is stacked to avoid setting a
775
# stacked config that doesn't work.
776
self._set_config_location('stacked_on_location', url)
779
"""Change a branch to be unstacked, copying data as needed.
781
Don't call this directly, use set_stacked_on_url(None).
783
pb = ui.ui_factory.nested_progress_bar()
785
pb.update("Unstacking")
786
# The basic approach here is to fetch the tip of the branch,
787
# including all available ghosts, from the existing stacked
788
# repository into a new repository object without the fallbacks.
790
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
791
# correct for CHKMap repostiories
792
old_repository = self.repository
793
if len(old_repository._fallback_repositories) != 1:
794
raise AssertionError("can't cope with fallback repositories "
795
"of %r" % (self.repository,))
796
# unlock it, including unlocking the fallback
797
old_repository.unlock()
798
old_repository.lock_read()
800
# Repositories don't offer an interface to remove fallback
801
# repositories today; take the conceptually simpler option and just
802
# reopen it. We reopen it starting from the URL so that we
803
# get a separate connection for RemoteRepositories and can
804
# stream from one of them to the other. This does mean doing
805
# separate SSH connection setup, but unstacking is not a
806
# common operation so it's tolerable.
807
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
808
new_repository = new_bzrdir.find_repository()
809
self.repository = new_repository
810
if self.repository._fallback_repositories:
811
raise AssertionError("didn't expect %r to have "
812
"fallback_repositories"
813
% (self.repository,))
814
# this is not paired with an unlock because it's just restoring
815
# the previous state; the lock's released when set_stacked_on_url
817
self.repository.lock_write()
818
# XXX: If you unstack a branch while it has a working tree
819
# with a pending merge, the pending-merged revisions will no
820
# longer be present. You can (probably) revert and remerge.
822
# XXX: This only fetches up to the tip of the repository; it
823
# doesn't bring across any tags. That's fairly consistent
824
# with how branch works, but perhaps not ideal.
825
self.repository.fetch(old_repository,
826
revision_id=self.last_revision(),
829
old_repository.unlock()
833
def _set_tags_bytes(self, bytes):
834
"""Mirror method for _get_tags_bytes.
836
:seealso: Branch._get_tags_bytes.
838
return _run_with_write_locked_target(self, self._transport.put_bytes,
841
def _cache_revision_history(self, rev_history):
842
"""Set the cached revision history to rev_history.
844
The revision_history method will use this cache to avoid regenerating
845
the revision history.
847
This API is semi-public; it only for use by subclasses, all other code
848
should consider it to be private.
850
self._revision_history_cache = rev_history
852
def _cache_revision_id_to_revno(self, revision_id_to_revno):
853
"""Set the cached revision_id => revno map to revision_id_to_revno.
855
This API is semi-public; it only for use by subclasses, all other code
856
should consider it to be private.
858
self._revision_id_to_revno_cache = revision_id_to_revno
860
def _clear_cached_state(self):
861
"""Clear any cached data on this branch, e.g. cached revision history.
863
This means the next call to revision_history will need to call
864
_gen_revision_history.
866
This API is semi-public; it only for use by subclasses, all other code
867
should consider it to be private.
869
self._revision_history_cache = None
870
self._revision_id_to_revno_cache = None
871
self._last_revision_info_cache = None
872
self._merge_sorted_revisions_cache = None
873
self._partial_revision_history_cache = []
874
self._partial_revision_id_to_revno_cache = {}
876
def _gen_revision_history(self):
877
"""Return sequence of revision hashes on to this branch.
879
Unlike revision_history, this method always regenerates or rereads the
880
revision history, i.e. it does not cache the result, so repeated calls
883
Concrete subclasses should override this instead of revision_history so
884
that subclasses do not need to deal with caching logic.
886
This API is semi-public; it only for use by subclasses, all other code
887
should consider it to be private.
889
raise NotImplementedError(self._gen_revision_history)
273
raise NotImplementedError('set_revision_history is abstract')
892
275
def revision_history(self):
893
"""Return sequence of revision ids on this branch.
895
This method will cache the revision history for as long as it is safe to
898
if 'evil' in debug.debug_flags:
899
mutter_callsite(3, "revision_history scales with history.")
900
if self._revision_history_cache is not None:
901
history = self._revision_history_cache
903
history = self._gen_revision_history()
904
self._cache_revision_history(history)
276
"""Return sequence of revision hashes on to this branch."""
277
raise NotImplementedError('revision_history is abstract')
908
280
"""Return current revision number for this branch.
952
335
common_index = min(self_len, other_len) -1
953
336
if common_index >= 0 and \
954
337
self_history[common_index] != other_history[common_index]:
955
raise errors.DivergedBranches(self, other)
338
raise DivergedBranches(self, other)
957
340
if stop_revision is None:
958
341
stop_revision = other_len
343
assert isinstance(stop_revision, int)
960
344
if stop_revision > other_len:
961
raise errors.NoSuchRevision(self, stop_revision)
345
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
962
346
return other_history[self_len:stop_revision]
965
def update_revisions(self, other, stop_revision=None, overwrite=False,
348
def update_revisions(self, other, stop_revision=None):
967
349
"""Pull in new perfect-fit revisions.
969
351
:param other: Another Branch to pull from
970
352
:param stop_revision: Updated until the given revision
971
:param overwrite: Always set the branch pointer, rather than checking
972
to see if it is a proper descendant.
973
:param graph: A Graph object that can be used to query history
974
information. This can be None.
977
return InterBranch.get(other, self).update_revisions(stop_revision,
980
def import_last_revision_info(self, source_repo, revno, revid):
981
"""Set the last revision info, importing from another repo if necessary.
983
This is used by the bound branch code to upload a revision to
984
the master branch first before updating the tip of the local branch.
986
:param source_repo: Source repository to optionally fetch from
987
:param revno: Revision number of the new tip
988
:param revid: Revision id of the new tip
990
if not self.repository.has_same_location(source_repo):
991
self.repository.fetch(source_repo, revision_id=revid)
992
self.set_last_revision_info(revno, revid)
355
raise NotImplementedError('update_revisions is abstract')
994
357
def revision_id_to_revno(self, revision_id):
995
358
"""Given a revision id, return its revno"""
996
if _mod_revision.is_null(revision_id):
359
if revision_id is None:
998
361
history = self.revision_history()
1000
363
return history.index(revision_id) + 1
1001
364
except ValueError:
1002
raise errors.NoSuchRevision(self, revision_id)
365
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1005
367
def get_rev_id(self, revno, history=None):
1006
368
"""Find the revision id of the specified revno."""
1008
return _mod_revision.NULL_REVISION
1009
last_revno, last_revid = self.last_revision_info()
1010
if revno == last_revno:
1012
if revno <= 0 or revno > last_revno:
1013
raise errors.NoSuchRevision(self, revno)
1014
distance_from_last = last_revno - revno
1015
if len(self._partial_revision_history_cache) <= distance_from_last:
1016
self._extend_partial_history(distance_from_last)
1017
return self._partial_revision_history_cache[distance_from_last]
1020
def pull(self, source, overwrite=False, stop_revision=None,
1021
possible_transports=None, *args, **kwargs):
1022
"""Mirror source into this branch.
1024
This branch is considered to be 'local', having low latency.
1026
:returns: PullResult instance
1028
return InterBranch.get(source, self).pull(overwrite=overwrite,
1029
stop_revision=stop_revision,
1030
possible_transports=possible_transports, *args, **kwargs)
1032
def push(self, target, overwrite=False, stop_revision=None, *args,
1034
"""Mirror this branch into target.
1036
This branch is considered to be 'local', having low latency.
1038
return InterBranch.get(self, target).push(overwrite, stop_revision,
1041
def lossy_push(self, target, stop_revision=None):
1042
"""Push deltas into another branch.
1044
:note: This does not, like push, retain the revision ids from
1045
the source branch and will, rather than adding bzr-specific
1046
metadata, push only those semantics of the revision that can be
1047
natively represented by this branch' VCS.
1049
:param target: Target branch
1050
:param stop_revision: Revision to push, defaults to last revision.
1051
:return: BranchPushResult with an extra member revidmap:
1052
A dictionary mapping revision ids from the target branch
1053
to new revision ids in the target branch, for each
1054
revision that was pushed.
1056
inter = InterBranch.get(self, target)
1057
lossy_push = getattr(inter, "lossy_push", None)
1058
if lossy_push is None:
1059
raise errors.LossyPushToSameVCS(self, target)
1060
return lossy_push(stop_revision)
372
history = self.revision_history()
373
elif revno <= 0 or revno > len(history):
374
raise bzrlib.errors.NoSuchRevision(self, revno)
375
return history[revno - 1]
377
def pull(self, source, overwrite=False, stop_revision=None):
378
raise NotImplementedError('pull is abstract')
1062
380
def basis_tree(self):
1063
"""Return `Tree` object for last revision."""
381
"""Return `Tree` object for last revision.
383
If there are no revisions yet, return an `EmptyTree`.
1064
385
return self.repository.revision_tree(self.last_revision())
387
def rename_one(self, from_rel, to_rel):
390
This can change the directory or the filename or both.
392
raise NotImplementedError('rename_one is abstract')
394
def move(self, from_paths, to_name):
397
to_name must exist as a versioned directory.
399
If to_name exists and is a directory, the files are moved into
400
it, keeping their old names. If it is a directory,
402
Note that to_name is only the last component of the new name;
403
this doesn't change the directory.
405
This returns a list of (from_path, to_path) pairs for each
408
raise NotImplementedError('move is abstract')
1066
410
def get_parent(self):
1067
411
"""Return the parent location of the branch.
1069
This is the default location for pull/missing. The usual
1070
pattern is that the user can override it by specifying a
1073
parent = self._get_parent_location()
1076
# This is an old-format absolute path to a local branch
1077
# turn it into a url
1078
if parent.startswith('/'):
1079
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1081
return urlutils.join(self.base[:-1], parent)
1082
except errors.InvalidURLJoin, e:
1083
raise errors.InaccessibleParent(parent, self.user_url)
1085
def _get_parent_location(self):
1086
raise NotImplementedError(self._get_parent_location)
1088
def _set_config_location(self, name, url, config=None,
1089
make_relative=False):
1091
config = self.get_config()
1095
url = urlutils.relative_url(self.base, url)
1096
config.set_user_option(name, url, warn_masked=True)
1098
def _get_config_location(self, name, config=None):
1100
config = self.get_config()
1101
location = config.get_user_option(name)
1106
def get_child_submit_format(self):
1107
"""Return the preferred format of submissions to this branch."""
1108
return self.get_config().get_user_option("child_submit_format")
1110
def get_submit_branch(self):
1111
"""Return the submit location of the branch.
1113
This is the default location for bundle. The usual
1114
pattern is that the user can override it by specifying a
1117
return self.get_config().get_user_option('submit_branch')
1119
def set_submit_branch(self, location):
1120
"""Return the submit location of the branch.
1122
This is the default location for bundle. The usual
1123
pattern is that the user can override it by specifying a
1126
self.get_config().set_user_option('submit_branch', location,
1129
def get_public_branch(self):
1130
"""Return the public location of the branch.
1132
This is used by merge directives.
1134
return self._get_config_location('public_branch')
1136
def set_public_branch(self, location):
1137
"""Return the submit location of the branch.
1139
This is the default location for bundle. The usual
1140
pattern is that the user can override it by specifying a
1143
self._set_config_location('public_branch', location)
413
This is the default location for push/pull/missing. The usual
414
pattern is that the user can override it by specifying a
417
raise NotImplementedError('get_parent is abstract')
1145
419
def get_push_location(self):
1146
420
"""Return the None or the location to push this branch to."""
1147
push_loc = self.get_config().get_user_option('push_location')
421
raise NotImplementedError('get_push_location is abstract')
1150
423
def set_push_location(self, location):
1151
424
"""Set a new push location for this branch."""
1152
raise NotImplementedError(self.set_push_location)
1154
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1155
"""Run the post_change_branch_tip hooks."""
1156
hooks = Branch.hooks['post_change_branch_tip']
1159
new_revno, new_revid = self.last_revision_info()
1160
params = ChangeBranchTipParams(
1161
self, old_revno, new_revno, old_revid, new_revid)
1165
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1166
"""Run the pre_change_branch_tip hooks."""
1167
hooks = Branch.hooks['pre_change_branch_tip']
1170
old_revno, old_revid = self.last_revision_info()
1171
params = ChangeBranchTipParams(
1172
self, old_revno, new_revno, old_revid, new_revid)
425
raise NotImplementedError('set_push_location is abstract')
427
def set_parent(self, url):
428
raise NotImplementedError('set_parent is abstract')
1176
430
@needs_write_lock
1177
431
def update(self):
1178
"""Synchronise this branch with the master branch if any.
432
"""Synchronise this branch with the master branch if any.
1180
434
:return: None or the last_revision pivoted out during the update.
1272
526
revision_id: if not None, the revision history in the new branch will
1273
527
be truncated to end with revision_id.
1275
self.update_references(destination)
1276
self._synchronize_history(destination, revision_id)
1278
parent = self.get_parent()
1279
except errors.InaccessibleParent, e:
1280
mutter('parent was not accessible to copy: %s', e)
1283
destination.set_parent(parent)
1284
if self._push_should_merge_tags():
1285
self.tags.merge_to(destination.tags)
1287
def update_references(self, target):
1288
if not getattr(self._format, 'supports_reference_locations', False):
1290
reference_dict = self._get_all_reference_info()
1291
if len(reference_dict) == 0:
1293
old_base = self.base
1294
new_base = target.base
1295
target_reference_dict = target._get_all_reference_info()
1296
for file_id, (tree_path, branch_location) in (
1297
reference_dict.items()):
1298
branch_location = urlutils.rebase_url(branch_location,
1300
target_reference_dict.setdefault(
1301
file_id, (tree_path, branch_location))
1302
target._set_all_reference_info(target_reference_dict)
1305
def check(self, refs):
1306
"""Check consistency of the branch.
1308
In particular this checks that revisions given in the revision-history
1309
do actually match up in the revision graph, and that they're all
1310
present in the repository.
1312
Callers will typically also want to check the repository.
1314
:param refs: Calculated refs for this branch as specified by
1315
branch._get_check_refs()
1316
:return: A BranchCheckResult.
1318
result = BranchCheckResult(self)
1319
last_revno, last_revision_id = self.last_revision_info()
1320
actual_revno = refs[('lefthand-distance', last_revision_id)]
1321
if actual_revno != last_revno:
1322
result.errors.append(errors.BzrCheckError(
1323
'revno does not match len(mainline) %s != %s' % (
1324
last_revno, actual_revno)))
1325
# TODO: We should probably also check that self.revision_history
1326
# matches the repository for older branch formats.
1327
# If looking for the code that cross-checks repository parents against
1328
# the iter_reverse_revision_history output, that is now a repository
1332
def _get_checkout_format(self):
1333
"""Return the most suitable metadir for a checkout of this branch.
1334
Weaves are used if this branch's repository uses weaves.
1336
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1337
from bzrlib.repofmt import weaverepo
1338
format = bzrdir.BzrDirMetaFormat1()
1339
format.repository_format = weaverepo.RepositoryFormat7()
1341
format = self.repository.bzrdir.checkout_metadir()
1342
format.set_branch_format(self._format)
1345
def create_clone_on_transport(self, to_transport, revision_id=None,
1346
stacked_on=None, create_prefix=False, use_existing_dir=False):
1347
"""Create a clone of this branch and its bzrdir.
1349
:param to_transport: The transport to clone onto.
1350
:param revision_id: The revision id to use as tip in the new branch.
1351
If None the tip is obtained from this branch.
1352
:param stacked_on: An optional URL to stack the clone on.
1353
:param create_prefix: Create any missing directories leading up to
1355
:param use_existing_dir: Use an existing directory if one exists.
1357
# XXX: Fix the bzrdir API to allow getting the branch back from the
1358
# clone call. Or something. 20090224 RBC/spiv.
1359
# XXX: Should this perhaps clone colocated branches as well,
1360
# rather than just the default branch? 20100319 JRV
1361
if revision_id is None:
1362
revision_id = self.last_revision()
1363
dir_to = self.bzrdir.clone_on_transport(to_transport,
1364
revision_id=revision_id, stacked_on=stacked_on,
1365
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1366
return dir_to.open_branch()
1368
def create_checkout(self, to_location, revision_id=None,
1369
lightweight=False, accelerator_tree=None,
1371
"""Create a checkout of a branch.
1373
:param to_location: The url to produce the checkout at
1374
:param revision_id: The revision to check out
1375
:param lightweight: If True, produce a lightweight checkout, otherwise,
1376
produce a bound branch (heavyweight checkout)
1377
:param accelerator_tree: A tree which can be used for retrieving file
1378
contents more quickly than the revision tree, i.e. a workingtree.
1379
The revision tree will be used for cases where accelerator_tree's
1380
content is different.
1381
:param hardlink: If true, hard-link files from accelerator_tree,
1383
:return: The tree of the created checkout
1385
t = transport.get_transport(to_location)
1388
format = self._get_checkout_format()
1389
checkout = format.initialize_on_transport(t)
1390
from_branch = BranchReferenceFormat().initialize(checkout,
1393
format = self._get_checkout_format()
1394
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1395
to_location, force_new_tree=False, format=format)
1396
checkout = checkout_branch.bzrdir
1397
checkout_branch.bind(self)
1398
# pull up to the specified revision_id to set the initial
1399
# branch tip correctly, and seed it with history.
1400
checkout_branch.pull(self, stop_revision=revision_id)
1402
tree = checkout.create_workingtree(revision_id,
1403
from_branch=from_branch,
1404
accelerator_tree=accelerator_tree,
1406
basis_tree = tree.basis_tree()
1407
basis_tree.lock_read()
1409
for path, file_id in basis_tree.iter_references():
1410
reference_parent = self.reference_parent(file_id, path)
1411
reference_parent.create_checkout(tree.abspath(path),
1412
basis_tree.get_reference_revision(file_id, path),
1419
def reconcile(self, thorough=True):
1420
"""Make sure the data stored in this branch is consistent."""
1421
from bzrlib.reconcile import BranchReconciler
1422
reconciler = BranchReconciler(self, thorough=thorough)
1423
reconciler.reconcile()
1426
def reference_parent(self, file_id, path, possible_transports=None):
1427
"""Return the parent branch for a tree-reference file_id
1428
:param file_id: The file_id of the tree reference
1429
:param path: The path of the file_id in the tree
1430
:return: A branch associated with the file_id
1432
# FIXME should provide multiple branches, based on config
1433
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1434
possible_transports=possible_transports)
1436
def supports_tags(self):
1437
return self._format.supports_tags()
1439
def automatic_tag_name(self, revision_id):
1440
"""Try to automatically find the tag name for a revision.
1442
:param revision_id: Revision id of the revision.
1443
:return: A tag name or None if no tag name could be determined.
1445
for hook in Branch.hooks['automatic_tag_name']:
1446
ret = hook(self, revision_id)
1451
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1453
"""Ensure that revision_b is a descendant of revision_a.
1455
This is a helper function for update_revisions.
1457
:raises: DivergedBranches if revision_b has diverged from revision_a.
1458
:returns: True if revision_b is a descendant of revision_a.
1460
relation = self._revision_relations(revision_a, revision_b, graph)
1461
if relation == 'b_descends_from_a':
1463
elif relation == 'diverged':
1464
raise errors.DivergedBranches(self, other_branch)
1465
elif relation == 'a_descends_from_b':
1468
raise AssertionError("invalid relation: %r" % (relation,))
1470
def _revision_relations(self, revision_a, revision_b, graph):
1471
"""Determine the relationship between two revisions.
1473
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1475
heads = graph.heads([revision_a, revision_b])
1476
if heads == set([revision_b]):
1477
return 'b_descends_from_a'
1478
elif heads == set([revision_a, revision_b]):
1479
# These branches have diverged
1481
elif heads == set([revision_a]):
1482
return 'a_descends_from_b'
1484
raise AssertionError("invalid heads: %r" % (heads,))
529
new_history = self.revision_history()
530
if revision_id is not None:
532
new_history = new_history[:new_history.index(revision_id) + 1]
534
rev = self.repository.get_revision(revision_id)
535
new_history = rev.get_history(self.repository)[1:]
536
destination.set_revision_history(new_history)
537
parent = self.get_parent()
539
destination.set_parent(parent)
1487
542
class BranchFormat(object):
1509
564
"""The known formats."""
1511
can_set_append_revisions_only = True
1513
def __eq__(self, other):
1514
return self.__class__ is other.__class__
1516
def __ne__(self, other):
1517
return not (self == other)
1520
def find_format(klass, a_bzrdir, name=None):
567
def find_format(klass, a_bzrdir):
1521
568
"""Return the format for the branch object in a_bzrdir."""
1523
transport = a_bzrdir.get_branch_transport(None, name=name)
1524
format_string = transport.get_bytes("format")
570
transport = a_bzrdir.get_branch_transport(None)
571
format_string = transport.get("format").read()
1525
572
return klass._formats[format_string]
1526
except errors.NoSuchFile:
1527
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
574
raise NotBranchError(path=transport.base)
1528
575
except KeyError:
1529
raise errors.UnknownFormatError(format=format_string, kind='branch')
576
raise errors.UnknownFormatError(format_string)
1532
579
def get_default_format(klass):
1533
580
"""Return the current default format."""
1534
581
return klass._default_format
1536
def get_reference(self, a_bzrdir, name=None):
1537
"""Get the target reference of the branch in a_bzrdir.
1539
format probing must have been completed before calling
1540
this method - it is assumed that the format of the branch
1541
in a_bzrdir is correct.
1543
:param a_bzrdir: The bzrdir to get the branch data from.
1544
:param name: Name of the colocated branch to fetch
1545
:return: None if the branch is not a reference branch.
1550
def set_reference(self, a_bzrdir, name, to_branch):
1551
"""Set the target reference of the branch in a_bzrdir.
1553
format probing must have been completed before calling
1554
this method - it is assumed that the format of the branch
1555
in a_bzrdir is correct.
1557
:param a_bzrdir: The bzrdir to set the branch reference for.
1558
:param name: Name of colocated branch to set, None for default
1559
:param to_branch: branch that the checkout is to reference
1561
raise NotImplementedError(self.set_reference)
1563
583
def get_format_string(self):
1564
584
"""Return the ASCII format string that identifies this format."""
1565
585
raise NotImplementedError(self.get_format_string)
1567
587
def get_format_description(self):
1568
588
"""Return the short format description for this format."""
1569
raise NotImplementedError(self.get_format_description)
1571
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1572
hooks = Branch.hooks['post_branch_init']
1575
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1579
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1580
lock_type='metadir', set_format=True):
1581
"""Initialize a branch in a bzrdir, with specified files
1583
:param a_bzrdir: The bzrdir to initialize the branch in
1584
:param utf8_files: The files to create as a list of
1585
(filename, content) tuples
1586
:param name: Name of colocated branch to create, if any
1587
:param set_format: If True, set the format with
1588
self.get_format_string. (BzrBranch4 has its format set
1590
:return: a branch in this format
1592
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1593
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1595
'metadir': ('lock', lockdir.LockDir),
1596
'branch4': ('branch-lock', lockable_files.TransportLock),
1598
lock_name, lock_class = lock_map[lock_type]
1599
control_files = lockable_files.LockableFiles(branch_transport,
1600
lock_name, lock_class)
1601
control_files.create_lock()
1603
control_files.lock_write()
1604
except errors.LockContention:
1605
if lock_type != 'branch4':
1611
utf8_files += [('format', self.get_format_string())]
1613
for (filename, content) in utf8_files:
1614
branch_transport.put_bytes(
1616
mode=a_bzrdir._get_file_mode())
1619
control_files.unlock()
1620
branch = self.open(a_bzrdir, name, _found=True)
1621
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1624
def initialize(self, a_bzrdir, name=None):
1625
"""Create a branch of this format in a_bzrdir.
1627
:param name: Name of the colocated branch to create.
1629
raise NotImplementedError(self.initialize)
589
raise NotImplementedError(self.get_format_string)
591
def initialize(self, a_bzrdir):
592
"""Create a branch of this format in a_bzrdir."""
593
raise NotImplementedError(self.initialized)
1631
595
def is_supported(self):
1632
596
"""Is this format supported?
1634
598
Supported formats can be initialized and opened.
1635
Unsupported formats may not support initialization or committing or
599
Unsupported formats may not support initialization or committing or
1636
600
some other features depending on the reason for not being supported.
1640
def make_tags(self, branch):
1641
"""Create a tags object for branch.
1643
This method is on BranchFormat, because BranchFormats are reflected
1644
over the wire via network_name(), whereas full Branch instances require
1645
multiple VFS method calls to operate at all.
1647
The default implementation returns a disabled-tags instance.
1649
Note that it is normal for branch to be a RemoteBranch when using tags
1652
return DisabledTags(branch)
1654
def network_name(self):
1655
"""A simple byte string uniquely identifying this format for RPC calls.
1657
MetaDir branch formats use their disk format string to identify the
1658
repository over the wire. All in one formats such as bzr < 0.8, and
1659
foreign formats like svn/git and hg should use some marker which is
1660
unique and immutable.
1662
raise NotImplementedError(self.network_name)
1664
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
604
def open(self, a_bzrdir, _found=False):
1665
605
"""Return the branch object for a_bzrdir
1667
:param a_bzrdir: A BzrDir that contains a branch.
1668
:param name: Name of colocated branch to open
1669
:param _found: a private parameter, do not use it. It is used to
1670
indicate if format probing has already be done.
1671
:param ignore_fallbacks: when set, no fallback branches will be opened
1672
(if there are any). Default is to open fallbacks.
607
_found is a private parameter, do not use it. It is used to indicate
608
if format probing has already be done.
1674
610
raise NotImplementedError(self.open)
1677
613
def register_format(klass, format):
1678
"""Register a metadir format."""
1679
614
klass._formats[format.get_format_string()] = format
1680
# Metadir formats have a network name of their format string, and get
1681
# registered as class factories.
1682
network_format_registry.register(format.get_format_string(), format.__class__)
1685
617
def set_default_format(klass, format):
1686
618
klass._default_format = format
1688
def supports_set_append_revisions_only(self):
1689
"""True if this format supports set_append_revisions_only."""
1692
def supports_stacking(self):
1693
"""True if this format records a stacked-on branch."""
1697
621
def unregister_format(klass, format):
622
assert klass._formats[format.get_format_string()] is format
1698
623
del klass._formats[format.get_format_string()]
1700
625
def __str__(self):
1701
return self.get_format_description().rstrip()
1703
def supports_tags(self):
1704
"""True if this format supports tags stored in the branch"""
1705
return False # by default
1708
class BranchHooks(Hooks):
1709
"""A dictionary mapping hook name to a list of callables for branch hooks.
1711
e.g. ['set_rh'] Is the list of items to be called when the
1712
set_revision_history function is invoked.
1716
"""Create the default hooks.
1718
These are all empty initially, because by default nothing should get
1721
Hooks.__init__(self)
1722
self.create_hook(HookPoint('set_rh',
1723
"Invoked whenever the revision history has been set via "
1724
"set_revision_history. The api signature is (branch, "
1725
"revision_history), and the branch will be write-locked. "
1726
"The set_rh hook can be expensive for bzr to trigger, a better "
1727
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1728
self.create_hook(HookPoint('open',
1729
"Called with the Branch object that has been opened after a "
1730
"branch is opened.", (1, 8), None))
1731
self.create_hook(HookPoint('post_push',
1732
"Called after a push operation completes. post_push is called "
1733
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1734
"bzr client.", (0, 15), None))
1735
self.create_hook(HookPoint('post_pull',
1736
"Called after a pull operation completes. post_pull is called "
1737
"with a bzrlib.branch.PullResult object and only runs in the "
1738
"bzr client.", (0, 15), None))
1739
self.create_hook(HookPoint('pre_commit',
1740
"Called after a commit is calculated but before it is is "
1741
"completed. pre_commit is called with (local, master, old_revno, "
1742
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1743
"). old_revid is NULL_REVISION for the first commit to a branch, "
1744
"tree_delta is a TreeDelta object describing changes from the "
1745
"basis revision. hooks MUST NOT modify this delta. "
1746
" future_tree is an in-memory tree obtained from "
1747
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1748
"tree.", (0,91), None))
1749
self.create_hook(HookPoint('post_commit',
1750
"Called in the bzr client after a commit has completed. "
1751
"post_commit is called with (local, master, old_revno, old_revid, "
1752
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1753
"commit to a branch.", (0, 15), None))
1754
self.create_hook(HookPoint('post_uncommit',
1755
"Called in the bzr client after an uncommit completes. "
1756
"post_uncommit is called with (local, master, old_revno, "
1757
"old_revid, new_revno, new_revid) where local is the local branch "
1758
"or None, master is the target branch, and an empty branch "
1759
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1760
self.create_hook(HookPoint('pre_change_branch_tip',
1761
"Called in bzr client and server before a change to the tip of a "
1762
"branch is made. pre_change_branch_tip is called with a "
1763
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1764
"commit, uncommit will all trigger this hook.", (1, 6), None))
1765
self.create_hook(HookPoint('post_change_branch_tip',
1766
"Called in bzr client and server after a change to the tip of a "
1767
"branch is made. post_change_branch_tip is called with a "
1768
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1769
"commit, uncommit will all trigger this hook.", (1, 4), None))
1770
self.create_hook(HookPoint('transform_fallback_location',
1771
"Called when a stacked branch is activating its fallback "
1772
"locations. transform_fallback_location is called with (branch, "
1773
"url), and should return a new url. Returning the same url "
1774
"allows it to be used as-is, returning a different one can be "
1775
"used to cause the branch to stack on a closer copy of that "
1776
"fallback_location. Note that the branch cannot have history "
1777
"accessing methods called on it during this hook because the "
1778
"fallback locations have not been activated. When there are "
1779
"multiple hooks installed for transform_fallback_location, "
1780
"all are called with the url returned from the previous hook."
1781
"The order is however undefined.", (1, 9), None))
1782
self.create_hook(HookPoint('automatic_tag_name',
1783
"Called to determine an automatic tag name for a revision."
1784
"automatic_tag_name is called with (branch, revision_id) and "
1785
"should return a tag name or None if no tag name could be "
1786
"determined. The first non-None tag name returned will be used.",
1788
self.create_hook(HookPoint('post_branch_init',
1789
"Called after new branch initialization completes. "
1790
"post_branch_init is called with a "
1791
"bzrlib.branch.BranchInitHookParams. "
1792
"Note that init, branch and checkout (both heavyweight and "
1793
"lightweight) will all trigger this hook.", (2, 2), None))
1794
self.create_hook(HookPoint('post_switch',
1795
"Called after a checkout switches branch. "
1796
"post_switch is called with a "
1797
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1801
# install the default hooks into the Branch class.
1802
Branch.hooks = BranchHooks()
1805
class ChangeBranchTipParams(object):
1806
"""Object holding parameters passed to *_change_branch_tip hooks.
1808
There are 5 fields that hooks may wish to access:
1810
:ivar branch: the branch being changed
1811
:ivar old_revno: revision number before the change
1812
:ivar new_revno: revision number after the change
1813
:ivar old_revid: revision id before the change
1814
:ivar new_revid: revision id after the change
1816
The revid fields are strings. The revno fields are integers.
1819
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1820
"""Create a group of ChangeBranchTip parameters.
1822
:param branch: The branch being changed.
1823
:param old_revno: Revision number before the change.
1824
:param new_revno: Revision number after the change.
1825
:param old_revid: Tip revision id before the change.
1826
:param new_revid: Tip revision id after the change.
1828
self.branch = branch
1829
self.old_revno = old_revno
1830
self.new_revno = new_revno
1831
self.old_revid = old_revid
1832
self.new_revid = new_revid
1834
def __eq__(self, other):
1835
return self.__dict__ == other.__dict__
1838
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1839
self.__class__.__name__, self.branch,
1840
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1843
class BranchInitHookParams(object):
1844
"""Object holding parameters passed to *_branch_init hooks.
1846
There are 4 fields that hooks may wish to access:
1848
:ivar format: the branch format
1849
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1850
:ivar name: name of colocated branch, if any (or None)
1851
:ivar branch: the branch created
1853
Note that for lightweight checkouts, the bzrdir and format fields refer to
1854
the checkout, hence they are different from the corresponding fields in
1855
branch, which refer to the original branch.
1858
def __init__(self, format, a_bzrdir, name, branch):
1859
"""Create a group of BranchInitHook parameters.
1861
:param format: the branch format
1862
:param a_bzrdir: the BzrDir where the branch will be/has been
1864
:param name: name of colocated branch, if any (or None)
1865
:param branch: the branch created
1867
Note that for lightweight checkouts, the bzrdir and format fields refer
1868
to the checkout, hence they are different from the corresponding fields
1869
in branch, which refer to the original branch.
1871
self.format = format
1872
self.bzrdir = a_bzrdir
1874
self.branch = branch
1876
def __eq__(self, other):
1877
return self.__dict__ == other.__dict__
1881
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1883
return "<%s of format:%s bzrdir:%s>" % (
1884
self.__class__.__name__, self.branch,
1885
self.format, self.bzrdir)
1888
class SwitchHookParams(object):
1889
"""Object holding parameters passed to *_switch hooks.
1891
There are 4 fields that hooks may wish to access:
1893
:ivar control_dir: BzrDir of the checkout to change
1894
:ivar to_branch: branch that the checkout is to reference
1895
:ivar force: skip the check for local commits in a heavy checkout
1896
:ivar revision_id: revision ID to switch to (or None)
1899
def __init__(self, control_dir, to_branch, force, revision_id):
1900
"""Create a group of SwitchHook parameters.
1902
:param control_dir: BzrDir of the checkout to change
1903
:param to_branch: branch that the checkout is to reference
1904
:param force: skip the check for local commits in a heavy checkout
1905
:param revision_id: revision ID to switch to (or None)
1907
self.control_dir = control_dir
1908
self.to_branch = to_branch
1910
self.revision_id = revision_id
1912
def __eq__(self, other):
1913
return self.__dict__ == other.__dict__
1916
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1917
self.control_dir, self.to_branch,
626
return self.get_format_string().rstrip()
1921
629
class BzrBranchFormat4(BranchFormat):
2255
network_format_registry = registry.FormatRegistry()
2256
"""Registry of formats indexed by their network name.
2258
The network name for a branch format is an identifier that can be used when
2259
referring to formats with smart server operations. See
2260
BranchFormat.network_name() for more detail.
2264
814
# formats which have no format string are not discoverable
2265
815
# and not independently creatable, so are not registered.
2266
__format5 = BzrBranchFormat5()
2267
__format6 = BzrBranchFormat6()
2268
__format7 = BzrBranchFormat7()
2269
__format8 = BzrBranchFormat8()
2270
BranchFormat.register_format(__format5)
816
__default_format = BzrBranchFormat5()
817
BranchFormat.register_format(__default_format)
2271
818
BranchFormat.register_format(BranchReferenceFormat())
2272
BranchFormat.register_format(__format6)
2273
BranchFormat.register_format(__format7)
2274
BranchFormat.register_format(__format8)
2275
BranchFormat.set_default_format(__format7)
819
BranchFormat.set_default_format(__default_format)
2276
820
_legacy_formats = [BzrBranchFormat4(),
2278
network_format_registry.register(
2279
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2282
class BranchWriteLockResult(LogicalLockResult):
2283
"""The result of write locking a branch.
2285
:ivar branch_token: The token obtained from the underlying branch lock, or
2287
:ivar unlock: A callable which will unlock the lock.
2290
def __init__(self, unlock, branch_token):
2291
LogicalLockResult.__init__(self, unlock)
2292
self.branch_token = branch_token
2295
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2299
class BzrBranch(Branch, _RelockDebugMixin):
823
class BzrBranch(Branch):
2300
824
"""A branch stored in the actual filesystem.
2302
826
Note that it's "local" in the context of the filesystem; it doesn't
2303
827
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2304
828
it's writable, and can be accessed via the normal filesystem API.
2306
:ivar _transport: Transport for file operations on this branch's
2307
control files, typically pointing to the .bzr/branch directory.
2308
:ivar repository: Repository for this branch.
2309
:ivar base: The url of the base directory for this branch; the one
2310
containing the .bzr directory.
2311
:ivar name: Optional colocated branch name as it exists in the control
2315
def __init__(self, _format=None,
2316
_control_files=None, a_bzrdir=None, name=None,
2317
_repository=None, ignore_fallbacks=False):
2318
"""Create new branch object at a particular location."""
831
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
832
relax_version_check=DEPRECATED_PARAMETER, _format=None,
833
_control_files=None, a_bzrdir=None, _repository=None):
834
"""Create new branch object at a particular location.
836
transport -- A Transport object, defining how to access files.
838
init -- If True, create new control files in a previously
839
unversioned directory. If False, the branch must already
842
relax_version_check -- If true, the usual check for the branch
843
version is not applied. This is intended only for
844
upgrade/recovery type use; it's not guaranteed that
845
all operations will work on old format branches.
2319
847
if a_bzrdir is None:
2320
raise ValueError('a_bzrdir must be supplied')
848
self.bzrdir = bzrdir.BzrDir.open(transport.base)
2322
850
self.bzrdir = a_bzrdir
2323
self._base = self.bzrdir.transport.clone('..').base
2325
# XXX: We should be able to just do
2326
# self.base = self.bzrdir.root_transport.base
2327
# but this does not quite work yet -- mbp 20080522
851
self._transport = self.bzrdir.transport.clone('..')
852
self._base = self._transport.base
2328
853
self._format = _format
2329
854
if _control_files is None:
2330
raise ValueError('BzrBranch _control_files is None')
855
raise BzrBadParameterMissing('_control_files')
2331
856
self.control_files = _control_files
2332
self._transport = _control_files._transport
857
if deprecated_passed(init):
858
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
859
"deprecated as of bzr 0.8. Please use Branch.create().",
863
# this is slower than before deprecation, oh well never mind.
865
self._initialize(transport.base)
866
self._check_format(_format)
867
if deprecated_passed(relax_version_check):
868
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
869
"relax_version_check parameter is deprecated as of bzr 0.8. "
870
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
874
if (not relax_version_check
875
and not self._format.is_supported()):
876
raise errors.UnsupportedFormatError(
877
'sorry, branch format %r not supported' % fmt,
878
['use a different bzr version',
879
'or remove the .bzr directory'
880
' and "bzr init" again'])
881
if deprecated_passed(transport):
882
warn("BzrBranch.__init__(transport=XXX...): The transport "
883
"parameter is deprecated as of bzr 0.8. "
884
"Please use Branch.open, or bzrdir.open_branch().",
2333
887
self.repository = _repository
2334
Branch.__init__(self)
2336
889
def __str__(self):
2337
if self.name is None:
2338
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2340
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
890
return '%s(%r)' % (self.__class__.__name__, self.base)
2343
892
__repr__ = __str__
895
# TODO: It might be best to do this somewhere else,
896
# but it is nice for a Branch object to automatically
897
# cache it's information.
898
# Alternatively, we could have the Transport objects cache requests
899
# See the earlier discussion about how major objects (like Branch)
900
# should never expect their __del__ function to run.
901
# XXX: cache_root seems to be unused, 2006-01-13 mbp
902
if hasattr(self, 'cache_root') and self.cache_root is not None:
904
rmtree(self.cache_root)
907
self.cache_root = None
2345
909
def _get_base(self):
2346
"""Returns the directory containing the control directory."""
2347
910
return self._base
2349
912
base = property(_get_base, doc="The URL for the root of this branch.")
2351
def _get_config(self):
2352
return TransportConfig(self._transport, 'branch.conf')
914
def _finish_transaction(self):
915
"""Exit the current transaction."""
916
return self.control_files._finish_transaction()
918
def get_transaction(self):
919
"""Return the current active transaction.
921
If no transaction is active, this returns a passthrough object
922
for which all data is immediately flushed and no caching happens.
924
# this is an explicit function so that we can do tricky stuff
925
# when the storage in rev_storage is elsewhere.
926
# we probably need to hook the two 'lock a location' and
927
# 'have a transaction' together more delicately, so that
928
# we can have two locks (branch and storage) and one transaction
929
# ... and finishing the transaction unlocks both, but unlocking
930
# does not. - RBC 20051121
931
return self.control_files.get_transaction()
933
def _set_transaction(self, transaction):
934
"""Set a new active transaction."""
935
return self.control_files._set_transaction(transaction)
937
def abspath(self, name):
938
"""See Branch.abspath."""
939
return self.control_files._transport.abspath(name)
941
def _check_format(self, format):
942
"""Identify the branch format if needed.
944
The format is stored as a reference to the format object in
945
self._format for code that needs to check it later.
947
The format parameter is either None or the branch format class
948
used to open this branch.
950
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
953
format = BzrBranchFormat.find_format(self.bzrdir)
954
self._format = format
955
mutter("got branch format %s", self._format)
958
def get_root_id(self):
959
"""See Branch.get_root_id."""
960
tree = self.repository.revision_tree(self.last_revision())
961
return tree.inventory.root.file_id
2354
963
def is_locked(self):
2355
964
return self.control_files.is_locked()
2357
def lock_write(self, token=None):
2358
"""Lock the branch for write operations.
2360
:param token: A token to permit reacquiring a previously held and
2362
:return: A BranchWriteLockResult.
2364
if not self.is_locked():
2365
self._note_lock('w')
2366
# All-in-one needs to always unlock/lock.
2367
repo_control = getattr(self.repository, 'control_files', None)
2368
if self.control_files == repo_control or not self.is_locked():
2369
self.repository._warn_if_deprecated(self)
2370
self.repository.lock_write()
2375
return BranchWriteLockResult(self.unlock,
2376
self.control_files.lock_write(token=token))
2379
self.repository.unlock()
966
def lock_write(self):
967
# TODO: test for failed two phase locks. This is known broken.
968
self.control_files.lock_write()
969
self.repository.lock_write()
2382
971
def lock_read(self):
2383
"""Lock the branch for read operations.
2385
:return: A bzrlib.lock.LogicalLockResult.
2387
if not self.is_locked():
2388
self._note_lock('r')
2389
# All-in-one needs to always unlock/lock.
2390
repo_control = getattr(self.repository, 'control_files', None)
2391
if self.control_files == repo_control or not self.is_locked():
2392
self.repository._warn_if_deprecated(self)
2393
self.repository.lock_read()
2398
self.control_files.lock_read()
2399
return LogicalLockResult(self.unlock)
2402
self.repository.unlock()
2405
@only_raises(errors.LockNotHeld, errors.LockBroken)
972
# TODO: test for failed two phase locks. This is known broken.
973
self.control_files.lock_read()
974
self.repository.lock_read()
2406
976
def unlock(self):
977
# TODO: test for failed two phase locks. This is known broken.
979
self.repository.unlock()
2408
981
self.control_files.unlock()
2410
# All-in-one needs to always unlock/lock.
2411
repo_control = getattr(self.repository, 'control_files', None)
2412
if (self.control_files == repo_control or
2413
not self.control_files.is_locked()):
2414
self.repository.unlock()
2415
if not self.control_files.is_locked():
2416
# we just released the lock
2417
self._clear_cached_state()
2419
983
def peek_lock_mode(self):
2420
984
if self.control_files._lock_count == 0:
2430
994
"""See Branch.print_file."""
2431
995
return self.repository.print_file(file, revision_id)
2433
def _write_revision_history(self, history):
2434
"""Factored out of set_revision_history.
2436
This performs the actual writing to disk.
2437
It is intended to be called by BzrBranch5.set_revision_history."""
2438
self._transport.put_bytes(
2439
'revision-history', '\n'.join(history),
2440
mode=self.bzrdir._get_file_mode())
998
def append_revision(self, *revision_ids):
999
"""See Branch.append_revision."""
1000
for revision_id in revision_ids:
1001
mutter("add {%s} to revision-history" % revision_id)
1002
rev_history = self.revision_history()
1003
rev_history.extend(revision_ids)
1004
self.set_revision_history(rev_history)
2442
1006
@needs_write_lock
2443
1007
def set_revision_history(self, rev_history):
2444
1008
"""See Branch.set_revision_history."""
2445
if 'evil' in debug.debug_flags:
2446
mutter_callsite(3, "set_revision_history scales with history.")
2447
check_not_reserved_id = _mod_revision.check_not_reserved_id
2448
for rev_id in rev_history:
2449
check_not_reserved_id(rev_id)
2450
if Branch.hooks['post_change_branch_tip']:
2451
# Don't calculate the last_revision_info() if there are no hooks
2453
old_revno, old_revid = self.last_revision_info()
2454
if len(rev_history) == 0:
2455
revid = _mod_revision.NULL_REVISION
1009
self.control_files.put_utf8(
1010
'revision-history', '\n'.join(rev_history))
1011
transaction = self.get_transaction()
1012
history = transaction.map.find_revision_history()
1013
if history is not None:
1014
# update the revision history in the identity map.
1015
history[:] = list(rev_history)
1016
# this call is disabled because revision_history is
1017
# not really an object yet, and the transaction is for objects.
1018
# transaction.register_dirty(history)
2457
revid = rev_history[-1]
2458
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2459
self._write_revision_history(rev_history)
2460
self._clear_cached_state()
2461
self._cache_revision_history(rev_history)
2462
for hook in Branch.hooks['set_rh']:
2463
hook(self, rev_history)
2464
if Branch.hooks['post_change_branch_tip']:
2465
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2467
def _synchronize_history(self, destination, revision_id):
2468
"""Synchronize last revision and revision history between branches.
2470
This version is most efficient when the destination is also a
2471
BzrBranch5, but works for BzrBranch6 as long as the revision
2472
history is the true lefthand parent history, and all of the revisions
2473
are in the destination's repository. If not, set_revision_history
2476
:param destination: The branch to copy the history into
2477
:param revision_id: The revision-id to truncate history at. May
2478
be None to copy complete history.
1020
transaction.map.add_revision_history(rev_history)
1021
# this call is disabled because revision_history is
1022
# not really an object yet, and the transaction is for objects.
1023
# transaction.register_clean(history)
1025
def get_revision_delta(self, revno):
1026
"""Return the delta for one revision.
1028
The delta is relative to its mainline predecessor, or the
1029
empty tree for revision 1.
2480
if not isinstance(destination._format, BzrBranchFormat5):
2481
super(BzrBranch, self)._synchronize_history(
2482
destination, revision_id)
2484
if revision_id == _mod_revision.NULL_REVISION:
1031
assert isinstance(revno, int)
1032
rh = self.revision_history()
1033
if not (1 <= revno <= len(rh)):
1034
raise InvalidRevisionNumber(revno)
1036
# revno is 1-based; list is 0-based
1038
new_tree = self.repository.revision_tree(rh[revno-1])
1040
old_tree = EmptyTree()
1042
old_tree = self.repository.revision_tree(rh[revno-2])
1043
return compare_trees(old_tree, new_tree)
1046
def revision_history(self):
1047
"""See Branch.revision_history."""
1048
transaction = self.get_transaction()
1049
history = transaction.map.find_revision_history()
1050
if history is not None:
1051
mutter("cache hit for revision-history in %s", self)
1052
return list(history)
1053
history = [l.rstrip('\r\n') for l in
1054
self.control_files.get_utf8('revision-history').readlines()]
1055
transaction.map.add_revision_history(history)
1056
# this call is disabled because revision_history is
1057
# not really an object yet, and the transaction is for objects.
1058
# transaction.register_clean(history, precious=True)
1059
return list(history)
1062
def update_revisions(self, other, stop_revision=None):
1063
"""See Branch.update_revisions."""
1066
if stop_revision is None:
1067
stop_revision = other.last_revision()
1068
if stop_revision is None:
1069
# if there are no commits, we're done.
1071
# whats the current last revision, before we fetch [and change it
1073
last_rev = self.last_revision()
1074
# we fetch here regardless of whether we need to so that we pickup
1076
self.fetch(other, stop_revision)
1077
my_ancestry = self.repository.get_ancestry(last_rev)
1078
if stop_revision in my_ancestry:
1079
# last_revision is a descendant of stop_revision
1081
# stop_revision must be a descendant of last_revision
1082
stop_graph = self.repository.get_revision_graph(stop_revision)
1083
if last_rev is not None and last_rev not in stop_graph:
1084
# our previous tip is not merged into stop_revision
1085
raise errors.DivergedBranches(self, other)
1086
# make a new revision history from the graph
1087
current_rev_id = stop_revision
2485
1088
new_history = []
2487
new_history = self.revision_history()
2488
if revision_id is not None and new_history != []:
1089
while current_rev_id not in (None, NULL_REVISION):
1090
new_history.append(current_rev_id)
1091
current_rev_id_parents = stop_graph[current_rev_id]
1093
current_rev_id = current_rev_id_parents[0]
1095
current_rev_id = None
1096
new_history.reverse()
1097
self.set_revision_history(new_history)
1101
@deprecated_method(zero_eight)
1102
def pullable_revisions(self, other, stop_revision):
1103
"""Please use bzrlib.missing instead."""
1104
other_revno = other.revision_id_to_revno(stop_revision)
1106
return self.missing_revisions(other, other_revno)
1107
except DivergedBranches, e:
2490
new_history = new_history[:new_history.index(revision_id) + 1]
2492
rev = self.repository.get_revision(revision_id)
2493
new_history = rev.get_history(self.repository)[1:]
2494
destination.set_revision_history(new_history)
2497
def set_last_revision_info(self, revno, revision_id):
2498
"""Set the last revision of this branch.
2500
The caller is responsible for checking that the revno is correct
2501
for this revision id.
2503
It may be possible to set the branch last revision to an id not
2504
present in the repository. However, branches can also be
2505
configured to check constraints on history, in which case this may not
2508
revision_id = _mod_revision.ensure_null(revision_id)
2509
# this old format stores the full history, but this api doesn't
2510
# provide it, so we must generate, and might as well check it's
2512
history = self._lefthand_history(revision_id)
2513
if len(history) != revno:
2514
raise AssertionError('%d != %d' % (len(history), revno))
2515
self.set_revision_history(history)
2517
def _gen_revision_history(self):
2518
history = self._transport.get_bytes('revision-history').split('\n')
2519
if history[-1:] == ['']:
2520
# There shouldn't be a trailing newline, but just in case.
2525
def generate_revision_history(self, revision_id, last_rev=None,
2527
"""Create a new revision history that will finish with revision_id.
2529
:param revision_id: the new tip to use.
2530
:param last_rev: The previous last_revision. If not None, then this
2531
must be a ancestory of revision_id, or DivergedBranches is raised.
2532
:param other_branch: The other branch that DivergedBranches should
2533
raise with respect to.
2535
self.set_revision_history(self._lefthand_history(revision_id,
2536
last_rev, other_branch))
1109
pullable_revs = get_intervening_revisions(self.last_revision(),
1112
assert self.last_revision() not in pullable_revs
1113
return pullable_revs
1114
except bzrlib.errors.NotAncestor:
1115
if is_ancestor(self.last_revision(), stop_revision, self):
2538
1120
def basis_tree(self):
2539
1121
"""See Branch.basis_tree."""
2540
1122
return self.repository.revision_tree(self.last_revision())
2542
def _get_parent_location(self):
1124
@deprecated_method(zero_eight)
1125
def working_tree(self):
1126
"""Create a Working tree object for this branch."""
1127
from bzrlib.workingtree import WorkingTree
1128
from bzrlib.transport.local import LocalTransport
1129
if (self.base.find('://') != -1 or
1130
not isinstance(self._transport, LocalTransport)):
1131
raise NoWorkingTree(self.base)
1132
return self.bzrdir.open_workingtree()
1135
def pull(self, source, overwrite=False, stop_revision=None):
1136
"""See Branch.pull."""
1139
old_count = len(self.revision_history())
1141
self.update_revisions(source,stop_revision)
1142
except DivergedBranches:
1146
self.set_revision_history(source.revision_history())
1147
new_count = len(self.revision_history())
1148
return new_count - old_count
1152
def get_parent(self):
1153
"""See Branch.get_parent."""
2543
1155
_locs = ['parent', 'pull', 'x-pull']
2544
1156
for l in _locs:
2546
return self._transport.get_bytes(l).strip('\n')
2547
except errors.NoSuchFile:
1158
return self.control_files.get_utf8(l).read().strip('\n')
2551
def _basic_push(self, target, overwrite, stop_revision):
2552
"""Basic implementation of push without bound branches or hooks.
2554
Must be called with source read locked and target write locked.
2556
result = BranchPushResult()
2557
result.source_branch = self
2558
result.target_branch = target
2559
result.old_revno, result.old_revid = target.last_revision_info()
2560
self.update_references(target)
2561
if result.old_revid != self.last_revision():
2562
# We assume that during 'push' this repository is closer than
2564
graph = self.repository.get_graph(target.repository)
2565
target.update_revisions(self, stop_revision,
2566
overwrite=overwrite, graph=graph)
2567
if self._push_should_merge_tags():
2568
result.tag_conflicts = self.tags.merge_to(target.tags,
2570
result.new_revno, result.new_revid = target.last_revision_info()
2573
def get_stacked_on_url(self):
2574
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1163
def get_push_location(self):
1164
"""See Branch.get_push_location."""
1165
config = bzrlib.config.BranchConfig(self)
1166
push_loc = config.get_user_option('push_location')
2576
1169
def set_push_location(self, location):
2577
1170
"""See Branch.set_push_location."""
2578
self.get_config().set_user_option(
2579
'push_location', location,
2580
store=_mod_config.STORE_LOCATION_NORECURSE)
1171
config = bzrlib.config.LocationConfig(self.base)
1172
config.set_user_option('push_location', location)
2582
def _set_parent_location(self, url):
1175
def set_parent(self, url):
1176
"""See Branch.set_parent."""
1177
# TODO: Maybe delete old location files?
1178
# URLs should never be unicode, even on the local fs,
1179
# FIXUP this and get_parent in a future branch format bump:
1180
# read and rewrite the file, and have the new format code read
1181
# using .get not .get_utf8. RBC 20060125
2583
1182
if url is None:
2584
self._transport.delete('parent')
1183
self.control_files._transport.delete('parent')
2586
self._transport.put_bytes('parent', url + '\n',
2587
mode=self.bzrdir._get_file_mode())
1185
self.control_files.put_utf8('parent', url + '\n')
1187
def tree_config(self):
1188
return TreeConfig(self)
2590
1191
class BzrBranch5(BzrBranch):
2591
"""A format 5 branch. This supports new features over plain branches.
1192
"""A format 5 branch. This supports new features over plan branches.
2593
1194
It has support for a master_branch which is the data for bound branches.
1202
super(BzrBranch5, self).__init__(_format=_format,
1203
_control_files=_control_files,
1205
_repository=_repository)
1208
def pull(self, source, overwrite=False, stop_revision=None):
1209
"""Updates branch.pull to be bound branch aware."""
1210
bound_location = self.get_bound_location()
1211
if source.base != bound_location:
1212
# not pulling from master, so we need to update master.
1213
master_branch = self.get_master_branch()
1215
master_branch.pull(source)
1216
source = master_branch
1217
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
2596
1219
def get_bound_location(self):
2598
return self._transport.get_bytes('bound')[:-1]
1221
return self.control_files.get_utf8('bound').read()[:-1]
2599
1222
except errors.NoSuchFile:
2602
1225
@needs_read_lock
2603
def get_master_branch(self, possible_transports=None):
1226
def get_master_branch(self):
2604
1227
"""Return the branch we are bound to.
2606
1229
:return: Either a Branch, or None
2608
1231
This could memoise the branch, but if thats done
2609
1232
it must be revalidated on each new lock.
2610
So for now we just don't memoise it.
1233
So for now we just dont memoise it.
2611
1234
# RBC 20060304 review this decision.
2613
1236
bound_loc = self.get_bound_location()
2614
1237
if not bound_loc:
2617
return Branch.open(bound_loc,
2618
possible_transports=possible_transports)
1240
return Branch.open(bound_loc)
2619
1241
except (errors.NotBranchError, errors.ConnectionError), e:
2620
1242
raise errors.BoundBranchConnectionFailure(
2621
1243
self, bound_loc, e)
2668
1308
return self.set_bound_location(None)
2670
1310
@needs_write_lock
2671
def update(self, possible_transports=None):
2672
"""Synchronise this branch with the master branch if any.
1312
"""Synchronise this branch with the master branch if any.
2674
1314
:return: None or the last_revision that was pivoted out during the
2677
master = self.get_master_branch(possible_transports)
1317
master = self.get_master_branch()
2678
1318
if master is not None:
2679
old_tip = _mod_revision.ensure_null(self.last_revision())
1319
old_tip = self.last_revision()
2680
1320
self.pull(master, overwrite=True)
2681
if self.repository.get_graph().is_ancestor(old_tip,
2682
_mod_revision.ensure_null(self.last_revision())):
1321
if old_tip in self.repository.get_ancestry(self.last_revision()):
2688
class BzrBranch8(BzrBranch5):
2689
"""A branch that stores tree-reference locations."""
2691
def _open_hook(self):
2692
if self._ignore_fallbacks:
2695
url = self.get_stacked_on_url()
2696
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2697
errors.UnstackableBranchFormat):
2700
for hook in Branch.hooks['transform_fallback_location']:
2701
url = hook(self, url)
2703
hook_name = Branch.hooks.get_hook_name(hook)
2704
raise AssertionError(
2705
"'transform_fallback_location' hook %s returned "
2706
"None, not a URL." % hook_name)
2707
self._activate_fallback_location(url)
2709
def __init__(self, *args, **kwargs):
2710
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2711
super(BzrBranch8, self).__init__(*args, **kwargs)
2712
self._last_revision_info_cache = None
2713
self._reference_info = None
2715
def _clear_cached_state(self):
2716
super(BzrBranch8, self)._clear_cached_state()
2717
self._last_revision_info_cache = None
2718
self._reference_info = None
2720
def _last_revision_info(self):
2721
revision_string = self._transport.get_bytes('last-revision')
2722
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2723
revision_id = cache_utf8.get_cached_utf8(revision_id)
2725
return revno, revision_id
2727
def _write_last_revision_info(self, revno, revision_id):
2728
"""Simply write out the revision id, with no checks.
2730
Use set_last_revision_info to perform this safely.
2732
Does not update the revision_history cache.
2733
Intended to be called by set_last_revision_info and
2734
_write_revision_history.
2736
revision_id = _mod_revision.ensure_null(revision_id)
2737
out_string = '%d %s\n' % (revno, revision_id)
2738
self._transport.put_bytes('last-revision', out_string,
2739
mode=self.bzrdir._get_file_mode())
2742
def set_last_revision_info(self, revno, revision_id):
2743
revision_id = _mod_revision.ensure_null(revision_id)
2744
old_revno, old_revid = self.last_revision_info()
2745
if self._get_append_revisions_only():
2746
self._check_history_violation(revision_id)
2747
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2748
self._write_last_revision_info(revno, revision_id)
2749
self._clear_cached_state()
2750
self._last_revision_info_cache = revno, revision_id
2751
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2753
def _synchronize_history(self, destination, revision_id):
2754
"""Synchronize last revision and revision history between branches.
2756
:see: Branch._synchronize_history
2758
# XXX: The base Branch has a fast implementation of this method based
2759
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2760
# that uses set_revision_history. This class inherits from BzrBranch5,
2761
# but wants the fast implementation, so it calls
2762
# Branch._synchronize_history directly.
2763
Branch._synchronize_history(self, destination, revision_id)
2765
def _check_history_violation(self, revision_id):
2766
last_revision = _mod_revision.ensure_null(self.last_revision())
2767
if _mod_revision.is_null(last_revision):
2769
if last_revision not in self._lefthand_history(revision_id):
2770
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2772
def _gen_revision_history(self):
2773
"""Generate the revision history from last revision
2775
last_revno, last_revision = self.last_revision_info()
2776
self._extend_partial_history(stop_index=last_revno-1)
2777
return list(reversed(self._partial_revision_history_cache))
2779
def _write_revision_history(self, history):
2780
"""Factored out of set_revision_history.
2782
This performs the actual writing to disk, with format-specific checks.
2783
It is intended to be called by BzrBranch5.set_revision_history.
2785
if len(history) == 0:
2786
last_revision = 'null:'
2788
if history != self._lefthand_history(history[-1]):
2789
raise errors.NotLefthandHistory(history)
2790
last_revision = history[-1]
2791
if self._get_append_revisions_only():
2792
self._check_history_violation(last_revision)
2793
self._write_last_revision_info(len(history), last_revision)
2796
def _set_parent_location(self, url):
2797
"""Set the parent branch"""
2798
self._set_config_location('parent_location', url, make_relative=True)
2801
def _get_parent_location(self):
2802
"""Set the parent branch"""
2803
return self._get_config_location('parent_location')
2806
def _set_all_reference_info(self, info_dict):
2807
"""Replace all reference info stored in a branch.
2809
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2812
writer = rio.RioWriter(s)
2813
for key, (tree_path, branch_location) in info_dict.iteritems():
2814
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2815
branch_location=branch_location)
2816
writer.write_stanza(stanza)
2817
self._transport.put_bytes('references', s.getvalue())
2818
self._reference_info = info_dict
2821
def _get_all_reference_info(self):
2822
"""Return all the reference info stored in a branch.
2824
:return: A dict of {file_id: (tree_path, branch_location)}
2826
if self._reference_info is not None:
2827
return self._reference_info
2828
rio_file = self._transport.get('references')
2830
stanzas = rio.read_stanzas(rio_file)
2831
info_dict = dict((s['file_id'], (s['tree_path'],
2832
s['branch_location'])) for s in stanzas)
2835
self._reference_info = info_dict
2838
def set_reference_info(self, file_id, tree_path, branch_location):
2839
"""Set the branch location to use for a tree reference.
2841
:param file_id: The file-id of the tree reference.
2842
:param tree_path: The path of the tree reference in the tree.
2843
:param branch_location: The location of the branch to retrieve tree
2846
info_dict = self._get_all_reference_info()
2847
info_dict[file_id] = (tree_path, branch_location)
2848
if None in (tree_path, branch_location):
2849
if tree_path is not None:
2850
raise ValueError('tree_path must be None when branch_location'
2852
if branch_location is not None:
2853
raise ValueError('branch_location must be None when tree_path'
2855
del info_dict[file_id]
2856
self._set_all_reference_info(info_dict)
2858
def get_reference_info(self, file_id):
2859
"""Get the tree_path and branch_location for a tree reference.
2861
:return: a tuple of (tree_path, branch_location)
2863
return self._get_all_reference_info().get(file_id, (None, None))
2865
def reference_parent(self, file_id, path, possible_transports=None):
2866
"""Return the parent branch for a tree-reference file_id.
2868
:param file_id: The file_id of the tree reference
2869
:param path: The path of the file_id in the tree
2870
:return: A branch associated with the file_id
2872
branch_location = self.get_reference_info(file_id)[1]
2873
if branch_location is None:
2874
return Branch.reference_parent(self, file_id, path,
2875
possible_transports)
2876
branch_location = urlutils.join(self.user_url, branch_location)
2877
return Branch.open(branch_location,
2878
possible_transports=possible_transports)
2880
def set_push_location(self, location):
2881
"""See Branch.set_push_location."""
2882
self._set_config_location('push_location', location)
2884
def set_bound_location(self, location):
2885
"""See Branch.set_push_location."""
2887
config = self.get_config()
2888
if location is None:
2889
if config.get_user_option('bound') != 'True':
2892
config.set_user_option('bound', 'False', warn_masked=True)
2895
self._set_config_location('bound_location', location,
2897
config.set_user_option('bound', 'True', warn_masked=True)
2900
def _get_bound_location(self, bound):
2901
"""Return the bound location in the config file.
2903
Return None if the bound parameter does not match"""
2904
config = self.get_config()
2905
config_bound = (config.get_user_option('bound') == 'True')
2906
if config_bound != bound:
2908
return self._get_config_location('bound_location', config=config)
2910
def get_bound_location(self):
2911
"""See Branch.set_push_location."""
2912
return self._get_bound_location(True)
2914
def get_old_bound_location(self):
2915
"""See Branch.get_old_bound_location"""
2916
return self._get_bound_location(False)
2918
def get_stacked_on_url(self):
2919
# you can always ask for the URL; but you might not be able to use it
2920
# if the repo can't support stacking.
2921
## self._check_stackable_repo()
2922
stacked_url = self._get_config_location('stacked_on_location')
2923
if stacked_url is None:
2924
raise errors.NotStacked(self)
2927
def _get_append_revisions_only(self):
2928
return self.get_config(
2929
).get_user_option_as_bool('append_revisions_only')
2932
def generate_revision_history(self, revision_id, last_rev=None,
2934
"""See BzrBranch5.generate_revision_history"""
2935
history = self._lefthand_history(revision_id, last_rev, other_branch)
2936
revno = len(history)
2937
self.set_last_revision_info(revno, revision_id)
2940
def get_rev_id(self, revno, history=None):
2941
"""Find the revision id of the specified revno."""
2943
return _mod_revision.NULL_REVISION
2945
last_revno, last_revision_id = self.last_revision_info()
2946
if revno <= 0 or revno > last_revno:
2947
raise errors.NoSuchRevision(self, revno)
2949
if history is not None:
2950
return history[revno - 1]
2952
index = last_revno - revno
2953
if len(self._partial_revision_history_cache) <= index:
2954
self._extend_partial_history(stop_index=index)
2955
if len(self._partial_revision_history_cache) > index:
2956
return self._partial_revision_history_cache[index]
2958
raise errors.NoSuchRevision(self, revno)
2961
def revision_id_to_revno(self, revision_id):
2962
"""Given a revision id, return its revno"""
2963
if _mod_revision.is_null(revision_id):
2966
index = self._partial_revision_history_cache.index(revision_id)
2968
self._extend_partial_history(stop_revision=revision_id)
2969
index = len(self._partial_revision_history_cache) - 1
2970
if self._partial_revision_history_cache[index] != revision_id:
2971
raise errors.NoSuchRevision(self, revision_id)
2972
return self.revno() - index
2975
class BzrBranch7(BzrBranch8):
2976
"""A branch with support for a fallback repository."""
2978
def set_reference_info(self, file_id, tree_path, branch_location):
2979
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2981
def get_reference_info(self, file_id):
2982
Branch.get_reference_info(self, file_id)
2984
def reference_parent(self, file_id, path, possible_transports=None):
2985
return Branch.reference_parent(self, file_id, path,
2986
possible_transports)
2989
class BzrBranch6(BzrBranch7):
2990
"""See BzrBranchFormat6 for the capabilities of this branch.
2992
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
1327
class BranchTestProviderAdapter(object):
1328
"""A tool to generate a suite testing multiple branch formats at once.
1330
This is done by copying the test once for each transport and injecting
1331
the transport_server, transport_readonly_server, and branch_format
1332
classes into each copy. Each copy is also given a new id() to make it
2996
def get_stacked_on_url(self):
2997
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1336
def __init__(self, transport_server, transport_readonly_server, formats):
1337
self._transport_server = transport_server
1338
self._transport_readonly_server = transport_readonly_server
1339
self._formats = formats
1341
def adapt(self, test):
1342
result = TestSuite()
1343
for branch_format, bzrdir_format in self._formats:
1344
new_test = deepcopy(test)
1345
new_test.transport_server = self._transport_server
1346
new_test.transport_readonly_server = self._transport_readonly_server
1347
new_test.bzrdir_format = bzrdir_format
1348
new_test.branch_format = branch_format
1349
def make_new_test_id():
1350
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1351
return lambda: new_id
1352
new_test.id = make_new_test_id()
1353
result.addTest(new_test)
3000
1357
######################################################################
3001
# results of operations
3004
class _Result(object):
3006
def _show_tag_conficts(self, to_file):
3007
if not getattr(self, 'tag_conflicts', None):
3009
to_file.write('Conflicting tags:\n')
3010
for name, value1, value2 in self.tag_conflicts:
3011
to_file.write(' %s\n' % (name, ))
3014
class PullResult(_Result):
3015
"""Result of a Branch.pull operation.
3017
:ivar old_revno: Revision number before pull.
3018
:ivar new_revno: Revision number after pull.
3019
:ivar old_revid: Tip revision id before pull.
3020
:ivar new_revid: Tip revision id after pull.
3021
:ivar source_branch: Source (local) branch object. (read locked)
3022
:ivar master_branch: Master branch of the target, or the target if no
3024
:ivar local_branch: target branch if there is a Master, else None
3025
:ivar target_branch: Target/destination branch object. (write locked)
3026
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3030
# DEPRECATED: pull used to return the change in revno
3031
return self.new_revno - self.old_revno
3033
def report(self, to_file):
3035
if self.old_revid == self.new_revid:
3036
to_file.write('No revisions to pull.\n')
3038
to_file.write('Now on revision %d.\n' % self.new_revno)
3039
self._show_tag_conficts(to_file)
3042
class BranchPushResult(_Result):
3043
"""Result of a Branch.push operation.
3045
:ivar old_revno: Revision number (eg 10) of the target before push.
3046
:ivar new_revno: Revision number (eg 12) of the target after push.
3047
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3049
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3051
:ivar source_branch: Source branch object that the push was from. This is
3052
read locked, and generally is a local (and thus low latency) branch.
3053
:ivar master_branch: If target is a bound branch, the master branch of
3054
target, or target itself. Always write locked.
3055
:ivar target_branch: The direct Branch where data is being sent (write
3057
:ivar local_branch: If the target is a bound branch this will be the
3058
target, otherwise it will be None.
3062
# DEPRECATED: push used to return the change in revno
3063
return self.new_revno - self.old_revno
3065
def report(self, to_file):
3066
"""Write a human-readable description of the result."""
3067
if self.old_revid == self.new_revid:
3068
note('No new revisions to push.')
3070
note('Pushed up to revision %d.' % self.new_revno)
3071
self._show_tag_conficts(to_file)
3074
class BranchCheckResult(object):
3075
"""Results of checking branch consistency.
3080
def __init__(self, branch):
3081
self.branch = branch
3084
def report_results(self, verbose):
3085
"""Report the check results via trace.note.
3087
:param verbose: Requests more detailed display of what was checked,
3090
note('checked branch %s format %s', self.branch.user_url,
3091
self.branch._format)
3092
for error in self.errors:
3093
note('found error:%s', error)
3096
class Converter5to6(object):
3097
"""Perform an in-place upgrade of format 5 to format 6"""
3099
def convert(self, branch):
3100
# Data for 5 and 6 can peacefully coexist.
3101
format = BzrBranchFormat6()
3102
new_branch = format.open(branch.bzrdir, _found=True)
3104
# Copy source data into target
3105
new_branch._write_last_revision_info(*branch.last_revision_info())
3106
new_branch.set_parent(branch.get_parent())
3107
new_branch.set_bound_location(branch.get_bound_location())
3108
new_branch.set_push_location(branch.get_push_location())
3110
# New branch has no tags by default
3111
new_branch.tags._set_tag_dict({})
3113
# Copying done; now update target format
3114
new_branch._transport.put_bytes('format',
3115
format.get_format_string(),
3116
mode=new_branch.bzrdir._get_file_mode())
3118
# Clean up old files
3119
new_branch._transport.delete('revision-history')
3121
branch.set_parent(None)
3122
except errors.NoSuchFile:
3124
branch.set_bound_location(None)
3127
class Converter6to7(object):
3128
"""Perform an in-place upgrade of format 6 to format 7"""
3130
def convert(self, branch):
3131
format = BzrBranchFormat7()
3132
branch._set_config_location('stacked_on_location', '')
3133
# update target format
3134
branch._transport.put_bytes('format', format.get_format_string())
3137
class Converter7to8(object):
3138
"""Perform an in-place upgrade of format 6 to format 7"""
3140
def convert(self, branch):
3141
format = BzrBranchFormat8()
3142
branch._transport.put_bytes('references', '')
3143
# update target format
3144
branch._transport.put_bytes('format', format.get_format_string())
3147
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3148
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3151
_run_with_write_locked_target will attempt to release the lock it acquires.
3153
If an exception is raised by callable, then that exception *will* be
3154
propagated, even if the unlock attempt raises its own error. Thus
3155
_run_with_write_locked_target should be preferred to simply doing::
3159
return callable(*args, **kwargs)
3164
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3165
# should share code?
3168
result = callable(*args, **kwargs)
3170
exc_info = sys.exc_info()
3174
raise exc_info[0], exc_info[1], exc_info[2]
3180
class InterBranch(InterObject):
3181
"""This class represents operations taking place between two branches.
3183
Its instances have methods like pull() and push() and contain
3184
references to the source and target repositories these operations
3185
can be carried out on.
3189
"""The available optimised InterBranch types."""
3192
def _get_branch_formats_to_test():
3193
"""Return a tuple with the Branch formats to use when testing."""
3194
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3196
def pull(self, overwrite=False, stop_revision=None,
3197
possible_transports=None, local=False):
3198
"""Mirror source into target branch.
3200
The target branch is considered to be 'local', having low latency.
3202
:returns: PullResult instance
3204
raise NotImplementedError(self.pull)
3206
def update_revisions(self, stop_revision=None, overwrite=False,
3208
"""Pull in new perfect-fit revisions.
3210
:param stop_revision: Updated until the given revision
3211
:param overwrite: Always set the branch pointer, rather than checking
3212
to see if it is a proper descendant.
3213
:param graph: A Graph object that can be used to query history
3214
information. This can be None.
3217
raise NotImplementedError(self.update_revisions)
3219
def push(self, overwrite=False, stop_revision=None,
3220
_override_hook_source_branch=None):
3221
"""Mirror the source branch into the target branch.
3223
The source branch is considered to be 'local', having low latency.
3225
raise NotImplementedError(self.push)
3228
class GenericInterBranch(InterBranch):
3229
"""InterBranch implementation that uses public Branch functions.
3233
def _get_branch_formats_to_test():
3234
return BranchFormat._default_format, BranchFormat._default_format
3236
def update_revisions(self, stop_revision=None, overwrite=False,
3238
"""See InterBranch.update_revisions()."""
3239
self.source.lock_read()
3241
other_revno, other_last_revision = self.source.last_revision_info()
3242
stop_revno = None # unknown
3243
if stop_revision is None:
3244
stop_revision = other_last_revision
3245
if _mod_revision.is_null(stop_revision):
3246
# if there are no commits, we're done.
3248
stop_revno = other_revno
3250
# what's the current last revision, before we fetch [and change it
3252
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3253
# we fetch here so that we don't process data twice in the common
3254
# case of having something to pull, and so that the check for
3255
# already merged can operate on the just fetched graph, which will
3256
# be cached in memory.
3257
self.target.fetch(self.source, stop_revision)
3258
# Check to see if one is an ancestor of the other
3261
graph = self.target.repository.get_graph()
3262
if self.target._check_if_descendant_or_diverged(
3263
stop_revision, last_rev, graph, self.source):
3264
# stop_revision is a descendant of last_rev, but we aren't
3265
# overwriting, so we're done.
3267
if stop_revno is None:
3269
graph = self.target.repository.get_graph()
3270
this_revno, this_last_revision = \
3271
self.target.last_revision_info()
3272
stop_revno = graph.find_distance_to_null(stop_revision,
3273
[(other_last_revision, other_revno),
3274
(this_last_revision, this_revno)])
3275
self.target.set_last_revision_info(stop_revno, stop_revision)
3277
self.source.unlock()
3279
def pull(self, overwrite=False, stop_revision=None,
3280
possible_transports=None, _hook_master=None, run_hooks=True,
3281
_override_hook_target=None, local=False):
3284
:param _hook_master: Private parameter - set the branch to
3285
be supplied as the master to pull hooks.
3286
:param run_hooks: Private parameter - if false, this branch
3287
is being called because it's the master of the primary branch,
3288
so it should not run its hooks.
3289
:param _override_hook_target: Private parameter - set the branch to be
3290
supplied as the target_branch to pull hooks.
3291
:param local: Only update the local branch, and not the bound branch.
3293
# This type of branch can't be bound.
3295
raise errors.LocalRequiresBoundBranch()
3296
result = PullResult()
3297
result.source_branch = self.source
3298
if _override_hook_target is None:
3299
result.target_branch = self.target
3301
result.target_branch = _override_hook_target
3302
self.source.lock_read()
3304
# We assume that during 'pull' the target repository is closer than
3306
self.source.update_references(self.target)
3307
graph = self.target.repository.get_graph(self.source.repository)
3308
# TODO: Branch formats should have a flag that indicates
3309
# that revno's are expensive, and pull() should honor that flag.
3311
result.old_revno, result.old_revid = \
3312
self.target.last_revision_info()
3313
self.target.update_revisions(self.source, stop_revision,
3314
overwrite=overwrite, graph=graph)
3315
# TODO: The old revid should be specified when merging tags,
3316
# so a tags implementation that versions tags can only
3317
# pull in the most recent changes. -- JRV20090506
3318
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3320
result.new_revno, result.new_revid = self.target.last_revision_info()
3322
result.master_branch = _hook_master
3323
result.local_branch = result.target_branch
3325
result.master_branch = result.target_branch
3326
result.local_branch = None
3328
for hook in Branch.hooks['post_pull']:
3331
self.source.unlock()
3334
def push(self, overwrite=False, stop_revision=None,
3335
_override_hook_source_branch=None):
3336
"""See InterBranch.push.
3338
This is the basic concrete implementation of push()
3340
:param _override_hook_source_branch: If specified, run
3341
the hooks passing this Branch as the source, rather than self.
3342
This is for use of RemoteBranch, where push is delegated to the
3343
underlying vfs-based Branch.
3345
# TODO: Public option to disable running hooks - should be trivial but
3347
self.source.lock_read()
3349
return _run_with_write_locked_target(
3350
self.target, self._push_with_bound_branches, overwrite,
3352
_override_hook_source_branch=_override_hook_source_branch)
3354
self.source.unlock()
3356
def _push_with_bound_branches(self, overwrite, stop_revision,
3357
_override_hook_source_branch=None):
3358
"""Push from source into target, and into target's master if any.
3361
if _override_hook_source_branch:
3362
result.source_branch = _override_hook_source_branch
3363
for hook in Branch.hooks['post_push']:
3366
bound_location = self.target.get_bound_location()
3367
if bound_location and self.target.base != bound_location:
3368
# there is a master branch.
3370
# XXX: Why the second check? Is it even supported for a branch to
3371
# be bound to itself? -- mbp 20070507
3372
master_branch = self.target.get_master_branch()
3373
master_branch.lock_write()
3375
# push into the master from the source branch.
3376
self.source._basic_push(master_branch, overwrite, stop_revision)
3377
# and push into the target branch from the source. Note that we
3378
# push from the source branch again, because its considered the
3379
# highest bandwidth repository.
3380
result = self.source._basic_push(self.target, overwrite,
3382
result.master_branch = master_branch
3383
result.local_branch = self.target
3387
master_branch.unlock()
3390
result = self.source._basic_push(self.target, overwrite,
3392
# TODO: Why set master_branch and local_branch if there's no
3393
# binding? Maybe cleaner to just leave them unset? -- mbp
3395
result.master_branch = self.target
3396
result.local_branch = None
3401
def is_compatible(self, source, target):
3402
# GenericBranch uses the public API, so always compatible
3406
class InterToBranch5(GenericInterBranch):
3409
def _get_branch_formats_to_test():
3410
return BranchFormat._default_format, BzrBranchFormat5()
3412
def pull(self, overwrite=False, stop_revision=None,
3413
possible_transports=None, run_hooks=True,
3414
_override_hook_target=None, local=False):
3415
"""Pull from source into self, updating my master if any.
3417
:param run_hooks: Private parameter - if false, this branch
3418
is being called because it's the master of the primary branch,
3419
so it should not run its hooks.
3421
bound_location = self.target.get_bound_location()
3422
if local and not bound_location:
3423
raise errors.LocalRequiresBoundBranch()
3424
master_branch = None
3425
if not local and bound_location and self.source.user_url != bound_location:
3426
# not pulling from master, so we need to update master.
3427
master_branch = self.target.get_master_branch(possible_transports)
3428
master_branch.lock_write()
3431
# pull from source into master.
3432
master_branch.pull(self.source, overwrite, stop_revision,
3434
return super(InterToBranch5, self).pull(overwrite,
3435
stop_revision, _hook_master=master_branch,
3436
run_hooks=run_hooks,
3437
_override_hook_target=_override_hook_target)
3440
master_branch.unlock()
3443
InterBranch.register_optimiser(GenericInterBranch)
3444
InterBranch.register_optimiser(InterToBranch5)
1361
@deprecated_function(zero_eight)
1362
def ScratchBranch(*args, **kwargs):
1363
"""See bzrlib.bzrdir.ScratchDir."""
1364
d = ScratchDir(*args, **kwargs)
1365
return d.open_branch()
1368
@deprecated_function(zero_eight)
1369
def is_control_file(*args, **kwargs):
1370
"""See bzrlib.workingtree.is_control_file."""
1371
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
