96
123
if master is not None:
97
124
master.break_lock()
100
@deprecated_method(zero_eight)
101
def open_downlevel(base):
102
"""Open a branch which may be of an old format."""
103
return Branch.open(base, _unsupported=True)
106
def open(base, _unsupported=False):
126
def _check_stackable_repo(self):
127
if not self.repository._format.supports_external_lookups:
128
raise errors.UnstackableRepositoryFormat(self.repository._format,
129
self.repository.base)
131
def _extend_partial_history(self, stop_index=None, stop_revision=None):
132
"""Extend the partial history to include a given index
134
If a stop_index is supplied, stop when that index has been reached.
135
If a stop_revision is supplied, stop when that revision is
136
encountered. Otherwise, stop when the beginning of history is
139
:param stop_index: The index which should be present. When it is
140
present, history extension will stop.
141
:param stop_revision: The revision id which should be present. When
142
it is encountered, history extension will stop.
144
if len(self._partial_revision_history_cache) == 0:
145
self._partial_revision_history_cache = [self.last_revision()]
146
repository._iter_for_revno(
147
self.repository, self._partial_revision_history_cache,
148
stop_index=stop_index, stop_revision=stop_revision)
149
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
150
self._partial_revision_history_cache.pop()
152
def _get_check_refs(self):
153
"""Get the references needed for check().
157
revid = self.last_revision()
158
return [('revision-existence', revid), ('lefthand-distance', revid)]
161
def open(base, _unsupported=False, possible_transports=None):
107
162
"""Open the branch rooted at base.
109
164
For instance, if the branch is at URL/.bzr/branch,
110
165
Branch.open(URL) -> a Branch instance.
112
control = bzrdir.BzrDir.open(base, _unsupported)
113
return control.open_branch(_unsupported)
116
def open_containing(url):
167
control = bzrdir.BzrDir.open(base, _unsupported,
168
possible_transports=possible_transports)
169
return control.open_branch(_unsupported)
172
def open_from_transport(transport, _unsupported=False):
173
"""Open the branch rooted at transport"""
174
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
175
return control.open_branch(_unsupported)
178
def open_containing(url, possible_transports=None):
117
179
"""Open an existing branch which contains url.
119
181
This probes for a branch at url, and searches upwards from there.
121
183
Basically we keep looking up until we find the control directory or
122
184
run into the root. If there isn't one, raises NotBranchError.
123
If there is one and it is either an unrecognised format or an unsupported
185
If there is one and it is either an unrecognised format or an unsupported
124
186
format, UnknownFormatError or UnsupportedFormatError are raised.
125
187
If there is one, it is returned, along with the unused portion of url.
127
control, relpath = bzrdir.BzrDir.open_containing(url)
189
control, relpath = bzrdir.BzrDir.open_containing(url,
128
191
return control.open_branch(), relpath
131
@deprecated_function(zero_eight)
132
def initialize(base):
133
"""Create a new working tree and branch, rooted at 'base' (url)
135
NOTE: This will soon be deprecated in favour of creation
138
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
140
def setup_caching(self, cache_root):
141
"""Subclasses that care about caching should override this, and set
142
up cached stores located under cache_root.
144
# seems to be unused, 2006-01-13 mbp
145
warn('%s is deprecated' % self.setup_caching)
146
self.cache_root = cache_root
193
def _push_should_merge_tags(self):
194
"""Should _basic_push merge this branch's tags into the target?
196
The default implementation returns False if this branch has no tags,
197
and True the rest of the time. Subclasses may override this.
199
return self.supports_tags() and self.tags.get_tag_dict()
148
201
def get_config(self):
149
return bzrlib.config.BranchConfig(self)
152
return self.get_config().get_nickname()
202
return BranchConfig(self)
204
def _get_config(self):
205
"""Get the concrete config for just the config in this branch.
207
This is not intended for client use; see Branch.get_config for the
212
:return: An object supporting get_option and set_option.
214
raise NotImplementedError(self._get_config)
216
def _get_fallback_repository(self, url):
217
"""Get the repository we fallback to at url."""
218
url = urlutils.join(self.base, url)
219
a_bzrdir = bzrdir.BzrDir.open(url,
220
possible_transports=[self.bzrdir.root_transport])
221
return a_bzrdir.open_branch().repository
223
def _get_tags_bytes(self):
224
"""Get the bytes of a serialised tags dict.
226
Note that not all branches support tags, nor do all use the same tags
227
logic: this method is specific to BasicTags. Other tag implementations
228
may use the same method name and behave differently, safely, because
229
of the double-dispatch via
230
format.make_tags->tags_instance->get_tags_dict.
232
:return: The bytes of the tags file.
233
:seealso: Branch._set_tags_bytes.
235
return self._transport.get_bytes('tags')
237
def _get_nick(self, local=False, possible_transports=None):
238
config = self.get_config()
239
# explicit overrides master, but don't look for master if local is True
240
if not local and not config.has_explicit_nickname():
242
master = self.get_master_branch(possible_transports)
243
if master is not None:
244
# return the master branch value
246
except errors.BzrError, e:
247
# Silently fall back to local implicit nick if the master is
249
mutter("Could not connect to bound branch, "
250
"falling back to local nick.\n " + str(e))
251
return config.get_nickname()
154
253
def _set_nick(self, nick):
155
self.get_config().set_user_option('nickname', nick)
254
self.get_config().set_user_option('nickname', nick, warn_masked=True)
157
256
nick = property(_get_nick, _set_nick)
159
258
def is_locked(self):
160
raise NotImplementedError('is_locked is abstract')
259
raise NotImplementedError(self.is_locked)
261
def _lefthand_history(self, revision_id, last_rev=None,
263
if 'evil' in debug.debug_flags:
264
mutter_callsite(4, "_lefthand_history scales with history.")
265
# stop_revision must be a descendant of last_revision
266
graph = self.repository.get_graph()
267
if last_rev is not None:
268
if not graph.is_ancestor(last_rev, revision_id):
269
# our previous tip is not merged into stop_revision
270
raise errors.DivergedBranches(self, other_branch)
271
# make a new revision history from the graph
272
parents_map = graph.get_parent_map([revision_id])
273
if revision_id not in parents_map:
274
raise errors.NoSuchRevision(self, revision_id)
275
current_rev_id = revision_id
277
check_not_reserved_id = _mod_revision.check_not_reserved_id
278
# Do not include ghosts or graph origin in revision_history
279
while (current_rev_id in parents_map and
280
len(parents_map[current_rev_id]) > 0):
281
check_not_reserved_id(current_rev_id)
282
new_history.append(current_rev_id)
283
current_rev_id = parents_map[current_rev_id][0]
284
parents_map = graph.get_parent_map([current_rev_id])
285
new_history.reverse()
162
288
def lock_write(self):
163
raise NotImplementedError('lock_write is abstract')
289
raise NotImplementedError(self.lock_write)
165
291
def lock_read(self):
166
raise NotImplementedError('lock_read is abstract')
292
raise NotImplementedError(self.lock_read)
168
294
def unlock(self):
169
raise NotImplementedError('unlock is abstract')
295
raise NotImplementedError(self.unlock)
171
297
def peek_lock_mode(self):
172
298
"""Return lock mode for the Branch: 'r', 'w' or None"""
173
299
raise NotImplementedError(self.peek_lock_mode)
175
301
def get_physical_lock_status(self):
176
raise NotImplementedError('get_physical_lock_status is abstract')
178
def abspath(self, name):
179
"""Return absolute filename for something in the branch
181
XXX: Robert Collins 20051017 what is this used for? why is it a branch
182
method and not a tree method.
184
raise NotImplementedError('abspath is abstract')
302
raise NotImplementedError(self.get_physical_lock_status)
305
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
306
"""Return the revision_id for a dotted revno.
308
:param revno: a tuple like (1,) or (1,1,2)
309
:param _cache_reverse: a private parameter enabling storage
310
of the reverse mapping in a top level cache. (This should
311
only be done in selective circumstances as we want to
312
avoid having the mapping cached multiple times.)
313
:return: the revision_id
314
:raises errors.NoSuchRevision: if the revno doesn't exist
316
rev_id = self._do_dotted_revno_to_revision_id(revno)
318
self._partial_revision_id_to_revno_cache[rev_id] = revno
321
def _do_dotted_revno_to_revision_id(self, revno):
322
"""Worker function for dotted_revno_to_revision_id.
324
Subclasses should override this if they wish to
325
provide a more efficient implementation.
328
return self.get_rev_id(revno[0])
329
revision_id_to_revno = self.get_revision_id_to_revno_map()
330
revision_ids = [revision_id for revision_id, this_revno
331
in revision_id_to_revno.iteritems()
332
if revno == this_revno]
333
if len(revision_ids) == 1:
334
return revision_ids[0]
336
revno_str = '.'.join(map(str, revno))
337
raise errors.NoSuchRevision(self, revno_str)
340
def revision_id_to_dotted_revno(self, revision_id):
341
"""Given a revision id, return its dotted revno.
343
:return: a tuple like (1,) or (400,1,3).
345
return self._do_revision_id_to_dotted_revno(revision_id)
347
def _do_revision_id_to_dotted_revno(self, revision_id):
348
"""Worker function for revision_id_to_revno."""
349
# Try the caches if they are loaded
350
result = self._partial_revision_id_to_revno_cache.get(revision_id)
351
if result is not None:
353
if self._revision_id_to_revno_cache:
354
result = self._revision_id_to_revno_cache.get(revision_id)
356
raise errors.NoSuchRevision(self, revision_id)
357
# Try the mainline as it's optimised
359
revno = self.revision_id_to_revno(revision_id)
361
except errors.NoSuchRevision:
362
# We need to load and use the full revno map after all
363
result = self.get_revision_id_to_revno_map().get(revision_id)
365
raise errors.NoSuchRevision(self, revision_id)
369
def get_revision_id_to_revno_map(self):
370
"""Return the revision_id => dotted revno map.
372
This will be regenerated on demand, but will be cached.
374
:return: A dictionary mapping revision_id => dotted revno.
375
This dictionary should not be modified by the caller.
377
if self._revision_id_to_revno_cache is not None:
378
mapping = self._revision_id_to_revno_cache
380
mapping = self._gen_revno_map()
381
self._cache_revision_id_to_revno(mapping)
382
# TODO: jam 20070417 Since this is being cached, should we be returning
384
# I would rather not, and instead just declare that users should not
385
# modify the return value.
388
def _gen_revno_map(self):
389
"""Create a new mapping from revision ids to dotted revnos.
391
Dotted revnos are generated based on the current tip in the revision
393
This is the worker function for get_revision_id_to_revno_map, which
394
just caches the return value.
396
:return: A dictionary mapping revision_id => dotted revno.
398
revision_id_to_revno = dict((rev_id, revno)
399
for rev_id, depth, revno, end_of_merge
400
in self.iter_merge_sorted_revisions())
401
return revision_id_to_revno
404
def iter_merge_sorted_revisions(self, start_revision_id=None,
405
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
406
"""Walk the revisions for a branch in merge sorted order.
408
Merge sorted order is the output from a merge-aware,
409
topological sort, i.e. all parents come before their
410
children going forward; the opposite for reverse.
412
:param start_revision_id: the revision_id to begin walking from.
413
If None, the branch tip is used.
414
:param stop_revision_id: the revision_id to terminate the walk
415
after. If None, the rest of history is included.
416
:param stop_rule: if stop_revision_id is not None, the precise rule
417
to use for termination:
418
* 'exclude' - leave the stop revision out of the result (default)
419
* 'include' - the stop revision is the last item in the result
420
* 'with-merges' - include the stop revision and all of its
421
merged revisions in the result
422
:param direction: either 'reverse' or 'forward':
423
* reverse means return the start_revision_id first, i.e.
424
start at the most recent revision and go backwards in history
425
* forward returns tuples in the opposite order to reverse.
426
Note in particular that forward does *not* do any intelligent
427
ordering w.r.t. depth as some clients of this API may like.
428
(If required, that ought to be done at higher layers.)
430
:return: an iterator over (revision_id, depth, revno, end_of_merge)
433
* revision_id: the unique id of the revision
434
* depth: How many levels of merging deep this node has been
436
* revno_sequence: This field provides a sequence of
437
revision numbers for all revisions. The format is:
438
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
439
branch that the revno is on. From left to right the REVNO numbers
440
are the sequence numbers within that branch of the revision.
441
* end_of_merge: When True the next node (earlier in history) is
442
part of a different merge.
444
# Note: depth and revno values are in the context of the branch so
445
# we need the full graph to get stable numbers, regardless of the
447
if self._merge_sorted_revisions_cache is None:
448
last_revision = self.last_revision()
449
last_key = (last_revision,)
450
known_graph = self.repository.revisions.get_known_graph_ancestry(
452
self._merge_sorted_revisions_cache = known_graph.merge_sort(
454
filtered = self._filter_merge_sorted_revisions(
455
self._merge_sorted_revisions_cache, start_revision_id,
456
stop_revision_id, stop_rule)
457
if direction == 'reverse':
459
if direction == 'forward':
460
return reversed(list(filtered))
462
raise ValueError('invalid direction %r' % direction)
464
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
465
start_revision_id, stop_revision_id, stop_rule):
466
"""Iterate over an inclusive range of sorted revisions."""
467
rev_iter = iter(merge_sorted_revisions)
468
if start_revision_id is not None:
469
for node in rev_iter:
470
rev_id = node.key[-1]
471
if rev_id != start_revision_id:
474
# The decision to include the start or not
475
# depends on the stop_rule if a stop is provided
476
# so pop this node back into the iterator
477
rev_iter = chain(iter([node]), rev_iter)
479
if stop_revision_id is None:
481
for node in rev_iter:
482
rev_id = node.key[-1]
483
yield (rev_id, node.merge_depth, node.revno,
485
elif stop_rule == 'exclude':
486
for node in rev_iter:
487
rev_id = node.key[-1]
488
if rev_id == stop_revision_id:
490
yield (rev_id, node.merge_depth, node.revno,
492
elif stop_rule == 'include':
493
for node in rev_iter:
494
rev_id = node.key[-1]
495
yield (rev_id, node.merge_depth, node.revno,
497
if rev_id == stop_revision_id:
499
elif stop_rule == 'with-merges':
500
stop_rev = self.repository.get_revision(stop_revision_id)
501
if stop_rev.parent_ids:
502
left_parent = stop_rev.parent_ids[0]
504
left_parent = _mod_revision.NULL_REVISION
505
for node in rev_iter:
506
rev_id = node.key[-1]
507
if rev_id == left_parent:
509
yield (rev_id, node.merge_depth, node.revno,
512
raise ValueError('invalid stop_rule %r' % stop_rule)
514
def leave_lock_in_place(self):
515
"""Tell this branch object not to release the physical lock when this
518
If lock_write doesn't return a token, then this method is not supported.
520
self.control_files.leave_in_place()
522
def dont_leave_lock_in_place(self):
523
"""Tell this branch object to release the physical lock when this
524
object is unlocked, even if it didn't originally acquire it.
526
If lock_write doesn't return a token, then this method is not supported.
528
self.control_files.dont_leave_in_place()
186
530
def bind(self, other):
187
531
"""Bind the local branch the other branch.
270
626
The delta is relative to its mainline predecessor, or the
271
627
empty tree for revision 1.
273
assert isinstance(revno, int)
274
629
rh = self.revision_history()
275
630
if not (1 <= revno <= len(rh)):
276
raise InvalidRevisionNumber(revno)
631
raise errors.InvalidRevisionNumber(revno)
277
632
return self.repository.get_revision_delta(rh[revno-1])
279
def get_root_id(self):
280
"""Return the id of this branches root"""
281
raise NotImplementedError('get_root_id is abstract')
634
def get_stacked_on_url(self):
635
"""Get the URL this branch is stacked against.
637
:raises NotStacked: If the branch is not stacked.
638
:raises UnstackableBranchFormat: If the branch does not support
641
raise NotImplementedError(self.get_stacked_on_url)
283
643
def print_file(self, file, revision_id):
284
644
"""Print `file` to stdout."""
285
raise NotImplementedError('print_file is abstract')
287
def append_revision(self, *revision_ids):
288
raise NotImplementedError('append_revision is abstract')
645
raise NotImplementedError(self.print_file)
290
647
def set_revision_history(self, rev_history):
291
raise NotImplementedError('set_revision_history is abstract')
648
raise NotImplementedError(self.set_revision_history)
651
def set_parent(self, url):
652
"""See Branch.set_parent."""
653
# TODO: Maybe delete old location files?
654
# URLs should never be unicode, even on the local fs,
655
# FIXUP this and get_parent in a future branch format bump:
656
# read and rewrite the file. RBC 20060125
658
if isinstance(url, unicode):
660
url = url.encode('ascii')
661
except UnicodeEncodeError:
662
raise errors.InvalidURL(url,
663
"Urls must be 7-bit ascii, "
664
"use bzrlib.urlutils.escape")
665
url = urlutils.relative_url(self.base, url)
666
self._set_parent_location(url)
669
def set_stacked_on_url(self, url):
670
"""Set the URL this branch is stacked against.
672
:raises UnstackableBranchFormat: If the branch does not support
674
:raises UnstackableRepositoryFormat: If the repository does not support
677
if not self._format.supports_stacking():
678
raise errors.UnstackableBranchFormat(self._format, self.base)
679
# XXX: Changing from one fallback repository to another does not check
680
# that all the data you need is present in the new fallback.
681
# Possibly it should.
682
self._check_stackable_repo()
685
old_url = self.get_stacked_on_url()
686
except (errors.NotStacked, errors.UnstackableBranchFormat,
687
errors.UnstackableRepositoryFormat):
691
self._activate_fallback_location(url)
692
# write this out after the repository is stacked to avoid setting a
693
# stacked config that doesn't work.
694
self._set_config_location('stacked_on_location', url)
697
"""Change a branch to be unstacked, copying data as needed.
699
Don't call this directly, use set_stacked_on_url(None).
701
pb = ui.ui_factory.nested_progress_bar()
703
pb.update("Unstacking")
704
# The basic approach here is to fetch the tip of the branch,
705
# including all available ghosts, from the existing stacked
706
# repository into a new repository object without the fallbacks.
708
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
709
# correct for CHKMap repostiories
710
old_repository = self.repository
711
if len(old_repository._fallback_repositories) != 1:
712
raise AssertionError("can't cope with fallback repositories "
713
"of %r" % (self.repository,))
714
# unlock it, including unlocking the fallback
715
old_repository.unlock()
716
old_repository.lock_read()
718
# Repositories don't offer an interface to remove fallback
719
# repositories today; take the conceptually simpler option and just
720
# reopen it. We reopen it starting from the URL so that we
721
# get a separate connection for RemoteRepositories and can
722
# stream from one of them to the other. This does mean doing
723
# separate SSH connection setup, but unstacking is not a
724
# common operation so it's tolerable.
725
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
726
new_repository = new_bzrdir.find_repository()
727
self.repository = new_repository
728
if self.repository._fallback_repositories:
729
raise AssertionError("didn't expect %r to have "
730
"fallback_repositories"
731
% (self.repository,))
732
# this is not paired with an unlock because it's just restoring
733
# the previous state; the lock's released when set_stacked_on_url
735
self.repository.lock_write()
736
# XXX: If you unstack a branch while it has a working tree
737
# with a pending merge, the pending-merged revisions will no
738
# longer be present. You can (probably) revert and remerge.
740
# XXX: This only fetches up to the tip of the repository; it
741
# doesn't bring across any tags. That's fairly consistent
742
# with how branch works, but perhaps not ideal.
743
self.repository.fetch(old_repository,
744
revision_id=self.last_revision(),
747
old_repository.unlock()
751
def _set_tags_bytes(self, bytes):
752
"""Mirror method for _get_tags_bytes.
754
:seealso: Branch._get_tags_bytes.
756
return _run_with_write_locked_target(self, self._transport.put_bytes,
759
def _cache_revision_history(self, rev_history):
760
"""Set the cached revision history to rev_history.
762
The revision_history method will use this cache to avoid regenerating
763
the revision history.
765
This API is semi-public; it only for use by subclasses, all other code
766
should consider it to be private.
768
self._revision_history_cache = rev_history
770
def _cache_revision_id_to_revno(self, revision_id_to_revno):
771
"""Set the cached revision_id => revno map to revision_id_to_revno.
773
This API is semi-public; it only for use by subclasses, all other code
774
should consider it to be private.
776
self._revision_id_to_revno_cache = revision_id_to_revno
778
def _clear_cached_state(self):
779
"""Clear any cached data on this branch, e.g. cached revision history.
781
This means the next call to revision_history will need to call
782
_gen_revision_history.
784
This API is semi-public; it only for use by subclasses, all other code
785
should consider it to be private.
787
self._revision_history_cache = None
788
self._revision_id_to_revno_cache = None
789
self._last_revision_info_cache = None
790
self._merge_sorted_revisions_cache = None
791
self._partial_revision_history_cache = []
792
self._partial_revision_id_to_revno_cache = {}
794
def _gen_revision_history(self):
795
"""Return sequence of revision hashes on to this branch.
797
Unlike revision_history, this method always regenerates or rereads the
798
revision history, i.e. it does not cache the result, so repeated calls
801
Concrete subclasses should override this instead of revision_history so
802
that subclasses do not need to deal with caching logic.
804
This API is semi-public; it only for use by subclasses, all other code
805
should consider it to be private.
807
raise NotImplementedError(self._gen_revision_history)
293
810
def revision_history(self):
294
"""Return sequence of revision hashes on to this branch."""
295
raise NotImplementedError('revision_history is abstract')
811
"""Return sequence of revision ids on this branch.
813
This method will cache the revision history for as long as it is safe to
816
if 'evil' in debug.debug_flags:
817
mutter_callsite(3, "revision_history scales with history.")
818
if self._revision_history_cache is not None:
819
history = self._revision_history_cache
821
history = self._gen_revision_history()
822
self._cache_revision_history(history)
298
826
"""Return current revision number for this branch.
327
870
common_index = min(self_len, other_len) -1
328
871
if common_index >= 0 and \
329
872
self_history[common_index] != other_history[common_index]:
330
raise DivergedBranches(self, other)
873
raise errors.DivergedBranches(self, other)
332
875
if stop_revision is None:
333
876
stop_revision = other_len
335
assert isinstance(stop_revision, int)
336
878
if stop_revision > other_len:
337
879
raise errors.NoSuchRevision(self, stop_revision)
338
880
return other_history[self_len:stop_revision]
340
def update_revisions(self, other, stop_revision=None):
883
def update_revisions(self, other, stop_revision=None, overwrite=False,
341
885
"""Pull in new perfect-fit revisions.
343
887
:param other: Another Branch to pull from
344
888
:param stop_revision: Updated until the given revision
889
:param overwrite: Always set the branch pointer, rather than checking
890
to see if it is a proper descendant.
891
:param graph: A Graph object that can be used to query history
892
information. This can be None.
347
raise NotImplementedError('update_revisions is abstract')
895
return InterBranch.get(other, self).update_revisions(stop_revision,
898
def import_last_revision_info(self, source_repo, revno, revid):
899
"""Set the last revision info, importing from another repo if necessary.
901
This is used by the bound branch code to upload a revision to
902
the master branch first before updating the tip of the local branch.
904
:param source_repo: Source repository to optionally fetch from
905
:param revno: Revision number of the new tip
906
:param revid: Revision id of the new tip
908
if not self.repository.has_same_location(source_repo):
909
self.repository.fetch(source_repo, revision_id=revid)
910
self.set_last_revision_info(revno, revid)
349
912
def revision_id_to_revno(self, revision_id):
350
913
"""Given a revision id, return its revno"""
351
if revision_id is None:
914
if _mod_revision.is_null(revision_id):
353
916
history = self.revision_history()
355
918
return history.index(revision_id) + 1
356
919
except ValueError:
357
raise bzrlib.errors.NoSuchRevision(self, revision_id)
920
raise errors.NoSuchRevision(self, revision_id)
359
923
def get_rev_id(self, revno, history=None):
360
924
"""Find the revision id of the specified revno."""
364
history = self.revision_history()
365
elif revno <= 0 or revno > len(history):
366
raise bzrlib.errors.NoSuchRevision(self, revno)
367
return history[revno - 1]
369
def pull(self, source, overwrite=False, stop_revision=None):
370
raise NotImplementedError('pull is abstract')
926
return _mod_revision.NULL_REVISION
927
last_revno, last_revid = self.last_revision_info()
928
if revno == last_revno:
930
if revno <= 0 or revno > last_revno:
931
raise errors.NoSuchRevision(self, revno)
932
distance_from_last = last_revno - revno
933
if len(self._partial_revision_history_cache) <= distance_from_last:
934
self._extend_partial_history(distance_from_last)
935
return self._partial_revision_history_cache[distance_from_last]
938
def pull(self, source, overwrite=False, stop_revision=None,
939
possible_transports=None, *args, **kwargs):
940
"""Mirror source into this branch.
942
This branch is considered to be 'local', having low latency.
944
:returns: PullResult instance
946
return InterBranch.get(source, self).pull(overwrite=overwrite,
947
stop_revision=stop_revision,
948
possible_transports=possible_transports, *args, **kwargs)
950
def push(self, target, overwrite=False, stop_revision=None, *args,
952
"""Mirror this branch into target.
954
This branch is considered to be 'local', having low latency.
956
return InterBranch.get(self, target).push(overwrite, stop_revision,
959
def lossy_push(self, target, stop_revision=None):
960
"""Push deltas into another branch.
962
:note: This does not, like push, retain the revision ids from
963
the source branch and will, rather than adding bzr-specific
964
metadata, push only those semantics of the revision that can be
965
natively represented by this branch' VCS.
967
:param target: Target branch
968
:param stop_revision: Revision to push, defaults to last revision.
969
:return: BranchPushResult with an extra member revidmap:
970
A dictionary mapping revision ids from the target branch
971
to new revision ids in the target branch, for each
972
revision that was pushed.
974
inter = InterBranch.get(self, target)
975
lossy_push = getattr(inter, "lossy_push", None)
976
if lossy_push is None:
977
raise errors.LossyPushToSameVCS(self, target)
978
return lossy_push(stop_revision)
372
980
def basis_tree(self):
373
981
"""Return `Tree` object for last revision."""
374
982
return self.repository.revision_tree(self.last_revision())
376
def rename_one(self, from_rel, to_rel):
379
This can change the directory or the filename or both.
381
raise NotImplementedError('rename_one is abstract')
383
def move(self, from_paths, to_name):
386
to_name must exist as a versioned directory.
388
If to_name exists and is a directory, the files are moved into
389
it, keeping their old names. If it is a directory,
391
Note that to_name is only the last component of the new name;
392
this doesn't change the directory.
394
This returns a list of (from_path, to_path) pairs for each
397
raise NotImplementedError('move is abstract')
399
984
def get_parent(self):
400
985
"""Return the parent location of the branch.
402
This is the default location for push/pull/missing. The usual
987
This is the default location for pull/missing. The usual
403
988
pattern is that the user can override it by specifying a
406
raise NotImplementedError('get_parent is abstract')
991
parent = self._get_parent_location()
994
# This is an old-format absolute path to a local branch
996
if parent.startswith('/'):
997
parent = urlutils.local_path_to_url(parent.decode('utf8'))
999
return urlutils.join(self.base[:-1], parent)
1000
except errors.InvalidURLJoin, e:
1001
raise errors.InaccessibleParent(parent, self.base)
1003
def _get_parent_location(self):
1004
raise NotImplementedError(self._get_parent_location)
1006
def _set_config_location(self, name, url, config=None,
1007
make_relative=False):
1009
config = self.get_config()
1013
url = urlutils.relative_url(self.base, url)
1014
config.set_user_option(name, url, warn_masked=True)
1016
def _get_config_location(self, name, config=None):
1018
config = self.get_config()
1019
location = config.get_user_option(name)
1024
def get_child_submit_format(self):
1025
"""Return the preferred format of submissions to this branch."""
1026
return self.get_config().get_user_option("child_submit_format")
408
1028
def get_submit_branch(self):
409
1029
"""Return the submit location of the branch.
451
1116
self.check_real_revno(revno)
453
1118
def check_real_revno(self, revno):
455
1120
Check whether a revno corresponds to a real revision.
456
1121
Zero (the NULL revision) is considered invalid
458
1123
if revno < 1 or revno > self.revno():
459
raise InvalidRevisionNumber(revno)
1124
raise errors.InvalidRevisionNumber(revno)
461
1126
@needs_read_lock
462
def clone(self, *args, **kwargs):
1127
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
463
1128
"""Clone this branch into to_bzrdir preserving all semantic values.
1130
Most API users will want 'create_clone_on_transport', which creates a
1131
new bzrdir and branch on the fly.
465
1133
revision_id: if not None, the revision history in the new branch will
466
1134
be truncated to end with revision_id.
468
# for API compatibility, until 0.8 releases we provide the old api:
469
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
470
# after 0.8 releases, the *args and **kwargs should be changed:
471
# def clone(self, to_bzrdir, revision_id=None):
472
if (kwargs.get('to_location', None) or
473
kwargs.get('revision', None) or
474
kwargs.get('basis_branch', None) or
475
(len(args) and isinstance(args[0], basestring))):
476
# backwards compatibility api:
477
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
478
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
481
basis_branch = args[2]
483
basis_branch = kwargs.get('basis_branch', None)
485
basis = basis_branch.bzrdir
490
revision_id = args[1]
492
revision_id = kwargs.get('revision', None)
497
# no default to raise if not provided.
498
url = kwargs.get('to_location')
499
return self.bzrdir.clone(url,
500
revision_id=revision_id,
501
basis=basis).open_branch()
503
# generate args by hand
505
revision_id = args[1]
507
revision_id = kwargs.get('revision_id', None)
511
# no default to raise if not provided.
512
to_bzrdir = kwargs.get('to_bzrdir')
513
result = self._format.initialize(to_bzrdir)
514
self.copy_content_into(result, revision_id=revision_id)
1136
result = to_bzrdir.create_branch()
1139
if repository_policy is not None:
1140
repository_policy.configure_branch(result)
1141
self.copy_content_into(result, revision_id=revision_id)
517
1146
@needs_read_lock
518
def sprout(self, to_bzrdir, revision_id=None):
1147
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
519
1148
"""Create a new line of development from the branch, into to_bzrdir.
1150
to_bzrdir controls the branch format.
521
1152
revision_id: if not None, the revision history in the new branch will
522
1153
be truncated to end with revision_id.
524
result = self._format.initialize(to_bzrdir)
525
self.copy_content_into(result, revision_id=revision_id)
526
result.set_parent(self.bzrdir.root_transport.base)
1155
if (repository_policy is not None and
1156
repository_policy.requires_stacking()):
1157
to_bzrdir._format.require_stacking(_skip_repo=True)
1158
result = to_bzrdir.create_branch()
1161
if repository_policy is not None:
1162
repository_policy.configure_branch(result)
1163
self.copy_content_into(result, revision_id=revision_id)
1164
result.set_parent(self.bzrdir.root_transport.base)
1169
def _synchronize_history(self, destination, revision_id):
1170
"""Synchronize last revision and revision history between branches.
1172
This version is most efficient when the destination is also a
1173
BzrBranch6, but works for BzrBranch5, as long as the destination's
1174
repository contains all the lefthand ancestors of the intended
1175
last_revision. If not, set_last_revision_info will fail.
1177
:param destination: The branch to copy the history into
1178
:param revision_id: The revision-id to truncate history at. May
1179
be None to copy complete history.
1181
source_revno, source_revision_id = self.last_revision_info()
1182
if revision_id is None:
1183
revno, revision_id = source_revno, source_revision_id
1185
graph = self.repository.get_graph()
1187
revno = graph.find_distance_to_null(revision_id,
1188
[(source_revision_id, source_revno)])
1189
except errors.GhostRevisionsHaveNoRevno:
1190
# Default to 1, if we can't find anything else
1192
destination.set_last_revision_info(revno, revision_id)
529
1194
@needs_read_lock
530
1195
def copy_content_into(self, destination, revision_id=None):
531
1196
"""Copy the content of self into destination.
550
1209
destination.set_parent(parent)
1210
if self._push_should_merge_tags():
1211
self.tags.merge_to(destination.tags)
1213
def update_references(self, target):
1214
if not getattr(self._format, 'supports_reference_locations', False):
1216
reference_dict = self._get_all_reference_info()
1217
if len(reference_dict) == 0:
1219
old_base = self.base
1220
new_base = target.base
1221
target_reference_dict = target._get_all_reference_info()
1222
for file_id, (tree_path, branch_location) in (
1223
reference_dict.items()):
1224
branch_location = urlutils.rebase_url(branch_location,
1226
target_reference_dict.setdefault(
1227
file_id, (tree_path, branch_location))
1228
target._set_all_reference_info(target_reference_dict)
552
1230
@needs_read_lock
1231
def check(self, refs):
554
1232
"""Check consistency of the branch.
556
1234
In particular this checks that revisions given in the revision-history
557
do actually match up in the revision graph, and that they're all
1235
do actually match up in the revision graph, and that they're all
558
1236
present in the repository.
560
1238
Callers will typically also want to check the repository.
1240
:param refs: Calculated refs for this branch as specified by
1241
branch._get_check_refs()
562
1242
:return: A BranchCheckResult.
564
mainline_parent_id = None
565
for revision_id in self.revision_history():
567
revision = self.repository.get_revision(revision_id)
568
except errors.NoSuchRevision, e:
569
raise errors.BzrCheckError("mainline revision {%s} not in repository"
571
# In general the first entry on the revision history has no parents.
572
# But it's not illegal for it to have parents listed; this can happen
573
# in imports from Arch when the parents weren't reachable.
574
if mainline_parent_id is not None:
575
if mainline_parent_id not in revision.parent_ids:
576
raise errors.BzrCheckError("previous revision {%s} not listed among "
578
% (mainline_parent_id, revision_id))
579
mainline_parent_id = revision_id
580
return BranchCheckResult(self)
582
def create_checkout(self, to_location, revision_id=None,
1244
result = BranchCheckResult(self)
1245
last_revno, last_revision_id = self.last_revision_info()
1246
actual_revno = refs[('lefthand-distance', last_revision_id)]
1247
if actual_revno != last_revno:
1248
result.errors.append(errors.BzrCheckError(
1249
'revno does not match len(mainline) %s != %s' % (
1250
last_revno, actual_revno)))
1251
# TODO: We should probably also check that self.revision_history
1252
# matches the repository for older branch formats.
1253
# If looking for the code that cross-checks repository parents against
1254
# the iter_reverse_revision_history output, that is now a repository
1258
def _get_checkout_format(self):
1259
"""Return the most suitable metadir for a checkout of this branch.
1260
Weaves are used if this branch's repository uses weaves.
1262
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1263
from bzrlib.repofmt import weaverepo
1264
format = bzrdir.BzrDirMetaFormat1()
1265
format.repository_format = weaverepo.RepositoryFormat7()
1267
format = self.repository.bzrdir.checkout_metadir()
1268
format.set_branch_format(self._format)
1271
def create_clone_on_transport(self, to_transport, revision_id=None,
1272
stacked_on=None, create_prefix=False, use_existing_dir=False):
1273
"""Create a clone of this branch and its bzrdir.
1275
:param to_transport: The transport to clone onto.
1276
:param revision_id: The revision id to use as tip in the new branch.
1277
If None the tip is obtained from this branch.
1278
:param stacked_on: An optional URL to stack the clone on.
1279
:param create_prefix: Create any missing directories leading up to
1281
:param use_existing_dir: Use an existing directory if one exists.
1283
# XXX: Fix the bzrdir API to allow getting the branch back from the
1284
# clone call. Or something. 20090224 RBC/spiv.
1285
if revision_id is None:
1286
revision_id = self.last_revision()
1288
dir_to = self.bzrdir.clone_on_transport(to_transport,
1289
revision_id=revision_id, stacked_on=stacked_on,
1290
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1291
except errors.FileExists:
1292
if not use_existing_dir:
1294
except errors.NoSuchFile:
1295
if not create_prefix:
1297
return dir_to.open_branch()
1299
def create_checkout(self, to_location, revision_id=None,
1300
lightweight=False, accelerator_tree=None,
584
1302
"""Create a checkout of a branch.
586
1304
:param to_location: The url to produce the checkout at
587
1305
:param revision_id: The revision to check out
588
1306
:param lightweight: If True, produce a lightweight checkout, otherwise,
589
1307
produce a bound branch (heavyweight checkout)
1308
:param accelerator_tree: A tree which can be used for retrieving file
1309
contents more quickly than the revision tree, i.e. a workingtree.
1310
The revision tree will be used for cases where accelerator_tree's
1311
content is different.
1312
:param hardlink: If true, hard-link files from accelerator_tree,
590
1314
:return: The tree of the created checkout
1316
t = transport.get_transport(to_location)
593
t = transport.get_transport(to_location)
596
except errors.FileExists:
598
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
599
BranchReferenceFormat().initialize(checkout, self)
1319
format = self._get_checkout_format()
1320
checkout = format.initialize_on_transport(t)
1321
from_branch = BranchReferenceFormat().initialize(checkout, self)
1323
format = self._get_checkout_format()
601
1324
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
602
to_location, force_new_tree=False)
1325
to_location, force_new_tree=False, format=format)
603
1326
checkout = checkout_branch.bzrdir
604
1327
checkout_branch.bind(self)
605
if revision_id is not None:
606
rh = checkout_branch.revision_history()
607
new_rh = rh[:rh.index(revision_id) + 1]
608
checkout_branch.set_revision_history(new_rh)
609
return checkout.create_workingtree(revision_id)
1328
# pull up to the specified revision_id to set the initial
1329
# branch tip correctly, and seed it with history.
1330
checkout_branch.pull(self, stop_revision=revision_id)
1332
tree = checkout.create_workingtree(revision_id,
1333
from_branch=from_branch,
1334
accelerator_tree=accelerator_tree,
1336
basis_tree = tree.basis_tree()
1337
basis_tree.lock_read()
1339
for path, file_id in basis_tree.iter_references():
1340
reference_parent = self.reference_parent(file_id, path)
1341
reference_parent.create_checkout(tree.abspath(path),
1342
basis_tree.get_reference_revision(file_id, path),
1349
def reconcile(self, thorough=True):
1350
"""Make sure the data stored in this branch is consistent."""
1351
from bzrlib.reconcile import BranchReconciler
1352
reconciler = BranchReconciler(self, thorough=thorough)
1353
reconciler.reconcile()
1356
def reference_parent(self, file_id, path, possible_transports=None):
1357
"""Return the parent branch for a tree-reference file_id
1358
:param file_id: The file_id of the tree reference
1359
:param path: The path of the file_id in the tree
1360
:return: A branch associated with the file_id
1362
# FIXME should provide multiple branches, based on config
1363
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1364
possible_transports=possible_transports)
1366
def supports_tags(self):
1367
return self._format.supports_tags()
1369
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1371
"""Ensure that revision_b is a descendant of revision_a.
1373
This is a helper function for update_revisions.
1375
:raises: DivergedBranches if revision_b has diverged from revision_a.
1376
:returns: True if revision_b is a descendant of revision_a.
1378
relation = self._revision_relations(revision_a, revision_b, graph)
1379
if relation == 'b_descends_from_a':
1381
elif relation == 'diverged':
1382
raise errors.DivergedBranches(self, other_branch)
1383
elif relation == 'a_descends_from_b':
1386
raise AssertionError("invalid relation: %r" % (relation,))
1388
def _revision_relations(self, revision_a, revision_b, graph):
1389
"""Determine the relationship between two revisions.
1391
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1393
heads = graph.heads([revision_a, revision_b])
1394
if heads == set([revision_b]):
1395
return 'b_descends_from_a'
1396
elif heads == set([revision_a, revision_b]):
1397
# These branches have diverged
1399
elif heads == set([revision_a]):
1400
return 'a_descends_from_b'
1402
raise AssertionError("invalid heads: %r" % (heads,))
612
1405
class BranchFormat(object):
640
1441
transport = a_bzrdir.get_branch_transport(None)
641
1442
format_string = transport.get("format").read()
642
1443
return klass._formats[format_string]
644
raise NotBranchError(path=transport.base)
1444
except errors.NoSuchFile:
1445
raise errors.NotBranchError(path=transport.base)
645
1446
except KeyError:
646
raise errors.UnknownFormatError(format=format_string)
1447
raise errors.UnknownFormatError(format=format_string, kind='branch')
649
1450
def get_default_format(klass):
650
1451
"""Return the current default format."""
651
1452
return klass._default_format
1454
def get_reference(self, a_bzrdir):
1455
"""Get the target reference of the branch in a_bzrdir.
1457
format probing must have been completed before calling
1458
this method - it is assumed that the format of the branch
1459
in a_bzrdir is correct.
1461
:param a_bzrdir: The bzrdir to get the branch data from.
1462
:return: None if the branch is not a reference branch.
1467
def set_reference(self, a_bzrdir, to_branch):
1468
"""Set the target reference of the branch in a_bzrdir.
1470
format probing must have been completed before calling
1471
this method - it is assumed that the format of the branch
1472
in a_bzrdir is correct.
1474
:param a_bzrdir: The bzrdir to set the branch reference for.
1475
:param to_branch: branch that the checkout is to reference
1477
raise NotImplementedError(self.set_reference)
653
1479
def get_format_string(self):
654
1480
"""Return the ASCII format string that identifies this format."""
655
1481
raise NotImplementedError(self.get_format_string)
657
1483
def get_format_description(self):
658
1484
"""Return the short format description for this format."""
659
raise NotImplementedError(self.get_format_string)
1485
raise NotImplementedError(self.get_format_description)
1487
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1489
"""Initialize a branch in a bzrdir, with specified files
1491
:param a_bzrdir: The bzrdir to initialize the branch in
1492
:param utf8_files: The files to create as a list of
1493
(filename, content) tuples
1494
:param set_format: If True, set the format with
1495
self.get_format_string. (BzrBranch4 has its format set
1497
:return: a branch in this format
1499
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1500
branch_transport = a_bzrdir.get_branch_transport(self)
1502
'metadir': ('lock', lockdir.LockDir),
1503
'branch4': ('branch-lock', lockable_files.TransportLock),
1505
lock_name, lock_class = lock_map[lock_type]
1506
control_files = lockable_files.LockableFiles(branch_transport,
1507
lock_name, lock_class)
1508
control_files.create_lock()
1510
control_files.lock_write()
1511
except errors.LockContention:
1512
if lock_type != 'branch4':
1518
utf8_files += [('format', self.get_format_string())]
1520
for (filename, content) in utf8_files:
1521
branch_transport.put_bytes(
1523
mode=a_bzrdir._get_file_mode())
1526
control_files.unlock()
1527
return self.open(a_bzrdir, _found=True)
661
1529
def initialize(self, a_bzrdir):
662
1530
"""Create a branch of this format in a_bzrdir."""
666
1534
"""Is this format supported?
668
1536
Supported formats can be initialized and opened.
669
Unsupported formats may not support initialization or committing or
1537
Unsupported formats may not support initialization or committing or
670
1538
some other features depending on the reason for not being supported.
674
def open(self, a_bzrdir, _found=False):
1542
def make_tags(self, branch):
1543
"""Create a tags object for branch.
1545
This method is on BranchFormat, because BranchFormats are reflected
1546
over the wire via network_name(), whereas full Branch instances require
1547
multiple VFS method calls to operate at all.
1549
The default implementation returns a disabled-tags instance.
1551
Note that it is normal for branch to be a RemoteBranch when using tags
1554
return DisabledTags(branch)
1556
def network_name(self):
1557
"""A simple byte string uniquely identifying this format for RPC calls.
1559
MetaDir branch formats use their disk format string to identify the
1560
repository over the wire. All in one formats such as bzr < 0.8, and
1561
foreign formats like svn/git and hg should use some marker which is
1562
unique and immutable.
1564
raise NotImplementedError(self.network_name)
1566
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
675
1567
"""Return the branch object for a_bzrdir
677
_found is a private parameter, do not use it. It is used to indicate
678
if format probing has already be done.
1569
:param a_bzrdir: A BzrDir that contains a branch.
1570
:param _found: a private parameter, do not use it. It is used to
1571
indicate if format probing has already be done.
1572
:param ignore_fallbacks: when set, no fallback branches will be opened
1573
(if there are any). Default is to open fallbacks.
680
1575
raise NotImplementedError(self.open)
683
1578
def register_format(klass, format):
1579
"""Register a metadir format."""
684
1580
klass._formats[format.get_format_string()] = format
1581
# Metadir formats have a network name of their format string, and get
1582
# registered as class factories.
1583
network_format_registry.register(format.get_format_string(), format.__class__)
687
1586
def set_default_format(klass, format):
688
1587
klass._default_format = format
1589
def supports_set_append_revisions_only(self):
1590
"""True if this format supports set_append_revisions_only."""
1593
def supports_stacking(self):
1594
"""True if this format records a stacked-on branch."""
691
1598
def unregister_format(klass, format):
692
assert klass._formats[format.get_format_string()] is format
693
1599
del klass._formats[format.get_format_string()]
695
1601
def __str__(self):
696
return self.get_format_string().rstrip()
1602
return self.get_format_description().rstrip()
1604
def supports_tags(self):
1605
"""True if this format supports tags stored in the branch"""
1606
return False # by default
1609
class BranchHooks(Hooks):
1610
"""A dictionary mapping hook name to a list of callables for branch hooks.
1612
e.g. ['set_rh'] Is the list of items to be called when the
1613
set_revision_history function is invoked.
1617
"""Create the default hooks.
1619
These are all empty initially, because by default nothing should get
1622
Hooks.__init__(self)
1623
self.create_hook(HookPoint('set_rh',
1624
"Invoked whenever the revision history has been set via "
1625
"set_revision_history. The api signature is (branch, "
1626
"revision_history), and the branch will be write-locked. "
1627
"The set_rh hook can be expensive for bzr to trigger, a better "
1628
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1629
self.create_hook(HookPoint('open',
1630
"Called with the Branch object that has been opened after a "
1631
"branch is opened.", (1, 8), None))
1632
self.create_hook(HookPoint('post_push',
1633
"Called after a push operation completes. post_push is called "
1634
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1635
"bzr client.", (0, 15), None))
1636
self.create_hook(HookPoint('post_pull',
1637
"Called after a pull operation completes. post_pull is called "
1638
"with a bzrlib.branch.PullResult object and only runs in the "
1639
"bzr client.", (0, 15), None))
1640
self.create_hook(HookPoint('pre_commit',
1641
"Called after a commit is calculated but before it is is "
1642
"completed. pre_commit is called with (local, master, old_revno, "
1643
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1644
"). old_revid is NULL_REVISION for the first commit to a branch, "
1645
"tree_delta is a TreeDelta object describing changes from the "
1646
"basis revision. hooks MUST NOT modify this delta. "
1647
" future_tree is an in-memory tree obtained from "
1648
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1649
"tree.", (0,91), None))
1650
self.create_hook(HookPoint('post_commit',
1651
"Called in the bzr client after a commit has completed. "
1652
"post_commit is called with (local, master, old_revno, old_revid, "
1653
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1654
"commit to a branch.", (0, 15), None))
1655
self.create_hook(HookPoint('post_uncommit',
1656
"Called in the bzr client after an uncommit completes. "
1657
"post_uncommit is called with (local, master, old_revno, "
1658
"old_revid, new_revno, new_revid) where local is the local branch "
1659
"or None, master is the target branch, and an empty branch "
1660
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1661
self.create_hook(HookPoint('pre_change_branch_tip',
1662
"Called in bzr client and server before a change to the tip of a "
1663
"branch is made. pre_change_branch_tip is called with a "
1664
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1665
"commit, uncommit will all trigger this hook.", (1, 6), None))
1666
self.create_hook(HookPoint('post_change_branch_tip',
1667
"Called in bzr client and server after a change to the tip of a "
1668
"branch is made. post_change_branch_tip is called with a "
1669
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1670
"commit, uncommit will all trigger this hook.", (1, 4), None))
1671
self.create_hook(HookPoint('transform_fallback_location',
1672
"Called when a stacked branch is activating its fallback "
1673
"locations. transform_fallback_location is called with (branch, "
1674
"url), and should return a new url. Returning the same url "
1675
"allows it to be used as-is, returning a different one can be "
1676
"used to cause the branch to stack on a closer copy of that "
1677
"fallback_location. Note that the branch cannot have history "
1678
"accessing methods called on it during this hook because the "
1679
"fallback locations have not been activated. When there are "
1680
"multiple hooks installed for transform_fallback_location, "
1681
"all are called with the url returned from the previous hook."
1682
"The order is however undefined.", (1, 9), None))
1685
# install the default hooks into the Branch class.
1686
Branch.hooks = BranchHooks()
1689
class ChangeBranchTipParams(object):
1690
"""Object holding parameters passed to *_change_branch_tip hooks.
1692
There are 5 fields that hooks may wish to access:
1694
:ivar branch: the branch being changed
1695
:ivar old_revno: revision number before the change
1696
:ivar new_revno: revision number after the change
1697
:ivar old_revid: revision id before the change
1698
:ivar new_revid: revision id after the change
1700
The revid fields are strings. The revno fields are integers.
1703
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1704
"""Create a group of ChangeBranchTip parameters.
1706
:param branch: The branch being changed.
1707
:param old_revno: Revision number before the change.
1708
:param new_revno: Revision number after the change.
1709
:param old_revid: Tip revision id before the change.
1710
:param new_revid: Tip revision id after the change.
1712
self.branch = branch
1713
self.old_revno = old_revno
1714
self.new_revno = new_revno
1715
self.old_revid = old_revid
1716
self.new_revid = new_revid
1718
def __eq__(self, other):
1719
return self.__dict__ == other.__dict__
1722
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1723
self.__class__.__name__, self.branch,
1724
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
699
1727
class BzrBranchFormat4(BranchFormat):
768
1831
def get_format_description(self):
769
1832
"""See BranchFormat.get_format_description()."""
770
1833
return "Branch format 5"
772
1835
def initialize(self, a_bzrdir):
773
1836
"""Create a branch of this format in a_bzrdir."""
774
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
775
branch_transport = a_bzrdir.get_branch_transport(self)
776
1837
utf8_files = [('revision-history', ''),
777
1838
('branch-name', ''),
779
control_files = LockableFiles(branch_transport, 'lock', lockdir.LockDir)
780
control_files.create_lock()
781
control_files.lock_write()
782
control_files.put_utf8('format', self.get_format_string())
784
for file, content in utf8_files:
785
control_files.put_utf8(file, content)
787
control_files.unlock()
788
return self.open(a_bzrdir, _found=True, )
1840
return self._initialize_helper(a_bzrdir, utf8_files)
1842
def supports_tags(self):
1846
class BzrBranchFormat6(BranchFormatMetadir):
1847
"""Branch format with last-revision and tags.
1849
Unlike previous formats, this has no explicit revision history. Instead,
1850
this just stores the last-revision, and the left-hand history leading
1851
up to there is the history.
1853
This format was introduced in bzr 0.15
1854
and became the default in 0.91.
1857
def _branch_class(self):
1860
def get_format_string(self):
1861
"""See BranchFormat.get_format_string()."""
1862
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1864
def get_format_description(self):
1865
"""See BranchFormat.get_format_description()."""
1866
return "Branch format 6"
1868
def initialize(self, a_bzrdir):
1869
"""Create a branch of this format in a_bzrdir."""
1870
utf8_files = [('last-revision', '0 null:\n'),
1871
('branch.conf', ''),
1874
return self._initialize_helper(a_bzrdir, utf8_files)
1876
def make_tags(self, branch):
1877
"""See bzrlib.branch.BranchFormat.make_tags()."""
1878
return BasicTags(branch)
1880
def supports_set_append_revisions_only(self):
1884
class BzrBranchFormat8(BranchFormatMetadir):
1885
"""Metadir format supporting storing locations of subtree branches."""
1887
def _branch_class(self):
1890
def get_format_string(self):
1891
"""See BranchFormat.get_format_string()."""
1892
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1894
def get_format_description(self):
1895
"""See BranchFormat.get_format_description()."""
1896
return "Branch format 8"
1898
def initialize(self, a_bzrdir):
1899
"""Create a branch of this format in a_bzrdir."""
1900
utf8_files = [('last-revision', '0 null:\n'),
1901
('branch.conf', ''),
1905
return self._initialize_helper(a_bzrdir, utf8_files)
790
1907
def __init__(self):
791
super(BzrBranchFormat5, self).__init__()
792
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
794
def open(self, a_bzrdir, _found=False):
795
"""Return the branch object for a_bzrdir
797
_found is a private parameter, do not use it. It is used to indicate
798
if format probing has already be done.
801
format = BranchFormat.find_format(a_bzrdir)
802
assert format.__class__ == self.__class__
803
transport = a_bzrdir.get_branch_transport(None)
804
control_files = LockableFiles(transport, 'lock', lockdir.LockDir)
805
return BzrBranch5(_format=self,
806
_control_files=control_files,
808
_repository=a_bzrdir.find_repository())
811
return "Bazaar-NG Metadir branch format 5"
1908
super(BzrBranchFormat8, self).__init__()
1909
self._matchingbzrdir.repository_format = \
1910
RepositoryFormatKnitPack5RichRoot()
1912
def make_tags(self, branch):
1913
"""See bzrlib.branch.BranchFormat.make_tags()."""
1914
return BasicTags(branch)
1916
def supports_set_append_revisions_only(self):
1919
def supports_stacking(self):
1922
supports_reference_locations = True
1925
class BzrBranchFormat7(BzrBranchFormat8):
1926
"""Branch format with last-revision, tags, and a stacked location pointer.
1928
The stacked location pointer is passed down to the repository and requires
1929
a repository format with supports_external_lookups = True.
1931
This format was introduced in bzr 1.6.
1934
def initialize(self, a_bzrdir):
1935
"""Create a branch of this format in a_bzrdir."""
1936
utf8_files = [('last-revision', '0 null:\n'),
1937
('branch.conf', ''),
1940
return self._initialize_helper(a_bzrdir, utf8_files)
1942
def _branch_class(self):
1945
def get_format_string(self):
1946
"""See BranchFormat.get_format_string()."""
1947
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1949
def get_format_description(self):
1950
"""See BranchFormat.get_format_description()."""
1951
return "Branch format 7"
1953
def supports_set_append_revisions_only(self):
1956
supports_reference_locations = False
814
1959
class BranchReferenceFormat(BranchFormat):
896
2085
Note that it's "local" in the context of the filesystem; it doesn't
897
2086
really matter if it's on an nfs/smb/afs/coda/... share, as long as
898
2087
it's writable, and can be accessed via the normal filesystem API.
2089
:ivar _transport: Transport for file operations on this branch's
2090
control files, typically pointing to the .bzr/branch directory.
2091
:ivar repository: Repository for this branch.
2092
:ivar base: The url of the base directory for this branch; the one
2093
containing the .bzr directory.
901
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
902
relax_version_check=DEPRECATED_PARAMETER, _format=None,
903
_control_files=None, a_bzrdir=None, _repository=None):
904
"""Create new branch object at a particular location.
906
transport -- A Transport object, defining how to access files.
908
init -- If True, create new control files in a previously
909
unversioned directory. If False, the branch must already
912
relax_version_check -- If true, the usual check for the branch
913
version is not applied. This is intended only for
914
upgrade/recovery type use; it's not guaranteed that
915
all operations will work on old format branches.
2096
def __init__(self, _format=None,
2097
_control_files=None, a_bzrdir=None, _repository=None,
2098
ignore_fallbacks=False):
2099
"""Create new branch object at a particular location."""
917
2100
if a_bzrdir is None:
918
self.bzrdir = bzrdir.BzrDir.open(transport.base)
2101
raise ValueError('a_bzrdir must be supplied')
920
2103
self.bzrdir = a_bzrdir
921
self._transport = self.bzrdir.transport.clone('..')
922
self._base = self._transport.base
2104
self._base = self.bzrdir.transport.clone('..').base
2105
# XXX: We should be able to just do
2106
# self.base = self.bzrdir.root_transport.base
2107
# but this does not quite work yet -- mbp 20080522
923
2108
self._format = _format
924
2109
if _control_files is None:
925
2110
raise ValueError('BzrBranch _control_files is None')
926
2111
self.control_files = _control_files
927
if deprecated_passed(init):
928
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
929
"deprecated as of bzr 0.8. Please use Branch.create().",
933
# this is slower than before deprecation, oh well never mind.
935
self._initialize(transport.base)
936
self._check_format(_format)
937
if deprecated_passed(relax_version_check):
938
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
939
"relax_version_check parameter is deprecated as of bzr 0.8. "
940
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
944
if (not relax_version_check
945
and not self._format.is_supported()):
946
raise errors.UnsupportedFormatError(format=fmt)
947
if deprecated_passed(transport):
948
warn("BzrBranch.__init__(transport=XXX...): The transport "
949
"parameter is deprecated as of bzr 0.8. "
950
"Please use Branch.open, or bzrdir.open_branch().",
2112
self._transport = _control_files._transport
953
2113
self.repository = _repository
2114
Branch.__init__(self)
955
2116
def __str__(self):
956
2117
return '%s(%r)' % (self.__class__.__name__, self.base)
958
2119
__repr__ = __str__
961
# TODO: It might be best to do this somewhere else,
962
# but it is nice for a Branch object to automatically
963
# cache it's information.
964
# Alternatively, we could have the Transport objects cache requests
965
# See the earlier discussion about how major objects (like Branch)
966
# should never expect their __del__ function to run.
967
# XXX: cache_root seems to be unused, 2006-01-13 mbp
968
if hasattr(self, 'cache_root') and self.cache_root is not None:
970
osutils.rmtree(self.cache_root)
973
self.cache_root = None
975
2121
def _get_base(self):
2122
"""Returns the directory containing the control directory."""
976
2123
return self._base
978
2125
base = property(_get_base, doc="The URL for the root of this branch.")
980
def _finish_transaction(self):
981
"""Exit the current transaction."""
982
return self.control_files._finish_transaction()
984
def get_transaction(self):
985
"""Return the current active transaction.
987
If no transaction is active, this returns a passthrough object
988
for which all data is immediately flushed and no caching happens.
990
# this is an explicit function so that we can do tricky stuff
991
# when the storage in rev_storage is elsewhere.
992
# we probably need to hook the two 'lock a location' and
993
# 'have a transaction' together more delicately, so that
994
# we can have two locks (branch and storage) and one transaction
995
# ... and finishing the transaction unlocks both, but unlocking
996
# does not. - RBC 20051121
997
return self.control_files.get_transaction()
999
def _set_transaction(self, transaction):
1000
"""Set a new active transaction."""
1001
return self.control_files._set_transaction(transaction)
1003
def abspath(self, name):
1004
"""See Branch.abspath."""
1005
return self.control_files._transport.abspath(name)
1007
def _check_format(self, format):
1008
"""Identify the branch format if needed.
1010
The format is stored as a reference to the format object in
1011
self._format for code that needs to check it later.
1013
The format parameter is either None or the branch format class
1014
used to open this branch.
1016
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1019
format = BranchFormat.find_format(self.bzrdir)
1020
self._format = format
1021
mutter("got branch format %s", self._format)
1024
def get_root_id(self):
1025
"""See Branch.get_root_id."""
1026
tree = self.repository.revision_tree(self.last_revision())
1027
return tree.inventory.root.file_id
2127
def _get_config(self):
2128
return TransportConfig(self._transport, 'branch.conf')
1029
2130
def is_locked(self):
1030
2131
return self.control_files.is_locked()
1032
def lock_write(self):
1033
self.repository.lock_write()
2133
def lock_write(self, token=None):
2134
# All-in-one needs to always unlock/lock.
2135
repo_control = getattr(self.repository, 'control_files', None)
2136
if self.control_files == repo_control or not self.is_locked():
2137
self.repository.lock_write()
1035
self.control_files.lock_write()
2142
return self.control_files.lock_write(token=token)
1037
self.repository.unlock()
2145
self.repository.unlock()
1040
2148
def lock_read(self):
1041
self.repository.lock_read()
2149
# All-in-one needs to always unlock/lock.
2150
repo_control = getattr(self.repository, 'control_files', None)
2151
if self.control_files == repo_control or not self.is_locked():
2152
self.repository.lock_read()
1043
2157
self.control_files.lock_read()
1045
self.repository.unlock()
2160
self.repository.unlock()
1048
2163
def unlock(self):
1049
# TODO: test for failed two phase locks. This is known broken.
1051
2165
self.control_files.unlock()
1053
self.repository.unlock()
2167
# All-in-one needs to always unlock/lock.
2168
repo_control = getattr(self.repository, 'control_files', None)
2169
if (self.control_files == repo_control or
2170
not self.control_files.is_locked()):
2171
self.repository.unlock()
2172
if not self.control_files.is_locked():
2173
# we just released the lock
2174
self._clear_cached_state()
1055
2176
def peek_lock_mode(self):
1056
2177
if self.control_files._lock_count == 0:
1066
2187
"""See Branch.print_file."""
1067
2188
return self.repository.print_file(file, revision_id)
1070
def append_revision(self, *revision_ids):
1071
"""See Branch.append_revision."""
1072
for revision_id in revision_ids:
1073
mutter("add {%s} to revision-history" % revision_id)
1074
rev_history = self.revision_history()
1075
rev_history.extend(revision_ids)
1076
self.set_revision_history(rev_history)
2190
def _write_revision_history(self, history):
2191
"""Factored out of set_revision_history.
2193
This performs the actual writing to disk.
2194
It is intended to be called by BzrBranch5.set_revision_history."""
2195
self._transport.put_bytes(
2196
'revision-history', '\n'.join(history),
2197
mode=self.bzrdir._get_file_mode())
1078
2199
@needs_write_lock
1079
2200
def set_revision_history(self, rev_history):
1080
2201
"""See Branch.set_revision_history."""
1081
self.control_files.put_utf8(
1082
'revision-history', '\n'.join(rev_history))
1083
transaction = self.get_transaction()
1084
history = transaction.map.find_revision_history()
1085
if history is not None:
1086
# update the revision history in the identity map.
1087
history[:] = list(rev_history)
1088
# this call is disabled because revision_history is
1089
# not really an object yet, and the transaction is for objects.
1090
# transaction.register_dirty(history)
1092
transaction.map.add_revision_history(rev_history)
1093
# this call is disabled because revision_history is
1094
# not really an object yet, and the transaction is for objects.
1095
# transaction.register_clean(history)
1098
def revision_history(self):
1099
"""See Branch.revision_history."""
1100
transaction = self.get_transaction()
1101
history = transaction.map.find_revision_history()
1102
if history is not None:
1103
mutter("cache hit for revision-history in %s", self)
1104
return list(history)
1105
history = [l.rstrip('\r\n') for l in
1106
self.control_files.get_utf8('revision-history').readlines()]
1107
transaction.map.add_revision_history(history)
1108
# this call is disabled because revision_history is
1109
# not really an object yet, and the transaction is for objects.
1110
# transaction.register_clean(history, precious=True)
1111
return list(history)
1114
def generate_revision_history(self, revision_id, last_rev=None,
2202
if 'evil' in debug.debug_flags:
2203
mutter_callsite(3, "set_revision_history scales with history.")
2204
check_not_reserved_id = _mod_revision.check_not_reserved_id
2205
for rev_id in rev_history:
2206
check_not_reserved_id(rev_id)
2207
if Branch.hooks['post_change_branch_tip']:
2208
# Don't calculate the last_revision_info() if there are no hooks
2210
old_revno, old_revid = self.last_revision_info()
2211
if len(rev_history) == 0:
2212
revid = _mod_revision.NULL_REVISION
2214
revid = rev_history[-1]
2215
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2216
self._write_revision_history(rev_history)
2217
self._clear_cached_state()
2218
self._cache_revision_history(rev_history)
2219
for hook in Branch.hooks['set_rh']:
2220
hook(self, rev_history)
2221
if Branch.hooks['post_change_branch_tip']:
2222
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2224
def _synchronize_history(self, destination, revision_id):
2225
"""Synchronize last revision and revision history between branches.
2227
This version is most efficient when the destination is also a
2228
BzrBranch5, but works for BzrBranch6 as long as the revision
2229
history is the true lefthand parent history, and all of the revisions
2230
are in the destination's repository. If not, set_revision_history
2233
:param destination: The branch to copy the history into
2234
:param revision_id: The revision-id to truncate history at. May
2235
be None to copy complete history.
2237
if not isinstance(destination._format, BzrBranchFormat5):
2238
super(BzrBranch, self)._synchronize_history(
2239
destination, revision_id)
2241
if revision_id == _mod_revision.NULL_REVISION:
2244
new_history = self.revision_history()
2245
if revision_id is not None and new_history != []:
2247
new_history = new_history[:new_history.index(revision_id) + 1]
2249
rev = self.repository.get_revision(revision_id)
2250
new_history = rev.get_history(self.repository)[1:]
2251
destination.set_revision_history(new_history)
2254
def set_last_revision_info(self, revno, revision_id):
2255
"""Set the last revision of this branch.
2257
The caller is responsible for checking that the revno is correct
2258
for this revision id.
2260
It may be possible to set the branch last revision to an id not
2261
present in the repository. However, branches can also be
2262
configured to check constraints on history, in which case this may not
2265
revision_id = _mod_revision.ensure_null(revision_id)
2266
# this old format stores the full history, but this api doesn't
2267
# provide it, so we must generate, and might as well check it's
2269
history = self._lefthand_history(revision_id)
2270
if len(history) != revno:
2271
raise AssertionError('%d != %d' % (len(history), revno))
2272
self.set_revision_history(history)
2274
def _gen_revision_history(self):
2275
history = self._transport.get_bytes('revision-history').split('\n')
2276
if history[-1:] == ['']:
2277
# There shouldn't be a trailing newline, but just in case.
2282
def generate_revision_history(self, revision_id, last_rev=None,
1115
2283
other_branch=None):
1116
2284
"""Create a new revision history that will finish with revision_id.
1118
2286
:param revision_id: the new tip to use.
1119
2287
:param last_rev: The previous last_revision. If not None, then this
1120
2288
must be a ancestory of revision_id, or DivergedBranches is raised.
1121
2289
:param other_branch: The other branch that DivergedBranches should
1122
2290
raise with respect to.
1124
# stop_revision must be a descendant of last_revision
1125
stop_graph = self.repository.get_revision_graph(revision_id)
1126
if last_rev is not None and last_rev not in stop_graph:
1127
# our previous tip is not merged into stop_revision
1128
raise errors.DivergedBranches(self, other_branch)
1129
# make a new revision history from the graph
1130
current_rev_id = revision_id
1132
while current_rev_id not in (None, revision.NULL_REVISION):
1133
new_history.append(current_rev_id)
1134
current_rev_id_parents = stop_graph[current_rev_id]
1136
current_rev_id = current_rev_id_parents[0]
1138
current_rev_id = None
1139
new_history.reverse()
1140
self.set_revision_history(new_history)
1143
def update_revisions(self, other, stop_revision=None):
1144
"""See Branch.update_revisions."""
1147
if stop_revision is None:
1148
stop_revision = other.last_revision()
1149
if stop_revision is None:
1150
# if there are no commits, we're done.
1152
# whats the current last revision, before we fetch [and change it
1154
last_rev = self.last_revision()
1155
# we fetch here regardless of whether we need to so that we pickup
1157
self.fetch(other, stop_revision)
1158
my_ancestry = self.repository.get_ancestry(last_rev)
1159
if stop_revision in my_ancestry:
1160
# last_revision is a descendant of stop_revision
1162
self.generate_revision_history(stop_revision, last_rev=last_rev,
2292
self.set_revision_history(self._lefthand_history(revision_id,
2293
last_rev, other_branch))
1167
2295
def basis_tree(self):
1168
2296
"""See Branch.basis_tree."""
1169
2297
return self.repository.revision_tree(self.last_revision())
1171
@deprecated_method(zero_eight)
1172
def working_tree(self):
1173
"""Create a Working tree object for this branch."""
1175
from bzrlib.transport.local import LocalTransport
1176
if (self.base.find('://') != -1 or
1177
not isinstance(self._transport, LocalTransport)):
1178
raise NoWorkingTree(self.base)
1179
return self.bzrdir.open_workingtree()
1182
def pull(self, source, overwrite=False, stop_revision=None):
1183
"""See Branch.pull."""
1186
old_count = len(self.revision_history())
1188
self.update_revisions(source,stop_revision)
1189
except DivergedBranches:
1193
self.set_revision_history(source.revision_history())
1194
new_count = len(self.revision_history())
1195
return new_count - old_count
1199
def get_parent(self):
1200
"""See Branch.get_parent."""
2299
def _get_parent_location(self):
1202
2300
_locs = ['parent', 'pull', 'x-pull']
1203
assert self.base[-1] == '/'
1204
2301
for l in _locs:
1206
parent = self.control_files.get(l).read().strip('\n')
1209
# This is an old-format absolute path to a local branch
1210
# turn it into a url
1211
if parent.startswith('/'):
1212
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1214
return urlutils.join(self.base[:-1], parent)
1215
except errors.InvalidURLJoin, e:
1216
raise errors.InaccessibleParent(parent, self.base)
2303
return self._transport.get_bytes(l).strip('\n')
2304
except errors.NoSuchFile:
1219
def get_push_location(self):
1220
"""See Branch.get_push_location."""
1221
push_loc = self.get_config().get_user_option('push_location')
2308
def _basic_push(self, target, overwrite, stop_revision):
2309
"""Basic implementation of push without bound branches or hooks.
2311
Must be called with source read locked and target write locked.
2313
result = BranchPushResult()
2314
result.source_branch = self
2315
result.target_branch = target
2316
result.old_revno, result.old_revid = target.last_revision_info()
2317
self.update_references(target)
2318
if result.old_revid != self.last_revision():
2319
# We assume that during 'push' this repository is closer than
2321
graph = self.repository.get_graph(target.repository)
2322
target.update_revisions(self, stop_revision,
2323
overwrite=overwrite, graph=graph)
2324
if self._push_should_merge_tags():
2325
result.tag_conflicts = self.tags.merge_to(target.tags,
2327
result.new_revno, result.new_revid = target.last_revision_info()
2330
def get_stacked_on_url(self):
2331
raise errors.UnstackableBranchFormat(self._format, self.base)
1224
2333
def set_push_location(self, location):
1225
2334
"""See Branch.set_push_location."""
1226
self.get_config().set_user_option('push_location', location,
2335
self.get_config().set_user_option(
2336
'push_location', location,
2337
store=_mod_config.STORE_LOCATION_NORECURSE)
1230
def set_parent(self, url):
1231
"""See Branch.set_parent."""
1232
# TODO: Maybe delete old location files?
1233
# URLs should never be unicode, even on the local fs,
1234
# FIXUP this and get_parent in a future branch format bump:
1235
# read and rewrite the file, and have the new format code read
1236
# using .get not .get_utf8. RBC 20060125
2339
def _set_parent_location(self, url):
1237
2340
if url is None:
1238
self.control_files._transport.delete('parent')
2341
self._transport.delete('parent')
1240
if isinstance(url, unicode):
1242
url = url.encode('ascii')
1243
except UnicodeEncodeError:
1244
raise bzrlib.errors.InvalidURL(url,
1245
"Urls must be 7-bit ascii, "
1246
"use bzrlib.urlutils.escape")
1248
url = urlutils.relative_url(self.base, url)
1249
self.control_files.put('parent', url + '\n')
1251
@deprecated_function(zero_nine)
1252
def tree_config(self):
1253
"""DEPRECATED; call get_config instead.
1254
TreeConfig has become part of BranchConfig."""
1255
return TreeConfig(self)
2343
self._transport.put_bytes('parent', url + '\n',
2344
mode=self.bzrdir._get_file_mode())
1258
2347
class BzrBranch5(BzrBranch):
1259
"""A format 5 branch. This supports new features over plan branches.
2348
"""A format 5 branch. This supports new features over plain branches.
1261
2350
It has support for a master_branch which is the data for bound branches.
1269
super(BzrBranch5, self).__init__(_format=_format,
1270
_control_files=_control_files,
1272
_repository=_repository)
1275
def pull(self, source, overwrite=False, stop_revision=None):
1276
"""Updates branch.pull to be bound branch aware."""
1277
bound_location = self.get_bound_location()
1278
if source.base != bound_location:
1279
# not pulling from master, so we need to update master.
1280
master_branch = self.get_master_branch()
1282
master_branch.pull(source)
1283
source = master_branch
1284
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1286
2353
def get_bound_location(self):
1288
return self.control_files.get_utf8('bound').read()[:-1]
2355
return self._transport.get_bytes('bound')[:-1]
1289
2356
except errors.NoSuchFile:
1292
2359
@needs_read_lock
1293
def get_master_branch(self):
2360
def get_master_branch(self, possible_transports=None):
1294
2361
"""Return the branch we are bound to.
1296
2363
:return: Either a Branch, or None
1298
2365
This could memoise the branch, but if thats done
1375
2425
return self.set_bound_location(None)
1377
2427
@needs_write_lock
1379
"""Synchronise this branch with the master branch if any.
2428
def update(self, possible_transports=None):
2429
"""Synchronise this branch with the master branch if any.
1381
2431
:return: None or the last_revision that was pivoted out during the
1384
master = self.get_master_branch()
2434
master = self.get_master_branch(possible_transports)
1385
2435
if master is not None:
1386
old_tip = self.last_revision()
2436
old_tip = _mod_revision.ensure_null(self.last_revision())
1387
2437
self.pull(master, overwrite=True)
1388
if old_tip in self.repository.get_ancestry(self.last_revision()):
2438
if self.repository.get_graph().is_ancestor(old_tip,
2439
_mod_revision.ensure_null(self.last_revision())):
1394
class BranchTestProviderAdapter(object):
1395
"""A tool to generate a suite testing multiple branch formats at once.
1397
This is done by copying the test once for each transport and injecting
1398
the transport_server, transport_readonly_server, and branch_format
1399
classes into each copy. Each copy is also given a new id() to make it
1403
def __init__(self, transport_server, transport_readonly_server, formats):
1404
self._transport_server = transport_server
1405
self._transport_readonly_server = transport_readonly_server
1406
self._formats = formats
1408
def adapt(self, test):
1409
result = TestSuite()
1410
for branch_format, bzrdir_format in self._formats:
1411
new_test = deepcopy(test)
1412
new_test.transport_server = self._transport_server
1413
new_test.transport_readonly_server = self._transport_readonly_server
1414
new_test.bzrdir_format = bzrdir_format
1415
new_test.branch_format = branch_format
1416
def make_new_test_id():
1417
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1418
return lambda: new_id
1419
new_test.id = make_new_test_id()
1420
result.addTest(new_test)
2445
class BzrBranch8(BzrBranch5):
2446
"""A branch that stores tree-reference locations."""
2448
def _open_hook(self):
2449
if self._ignore_fallbacks:
2452
url = self.get_stacked_on_url()
2453
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2454
errors.UnstackableBranchFormat):
2457
for hook in Branch.hooks['transform_fallback_location']:
2458
url = hook(self, url)
2460
hook_name = Branch.hooks.get_hook_name(hook)
2461
raise AssertionError(
2462
"'transform_fallback_location' hook %s returned "
2463
"None, not a URL." % hook_name)
2464
self._activate_fallback_location(url)
2466
def __init__(self, *args, **kwargs):
2467
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2468
super(BzrBranch8, self).__init__(*args, **kwargs)
2469
self._last_revision_info_cache = None
2470
self._reference_info = None
2472
def _clear_cached_state(self):
2473
super(BzrBranch8, self)._clear_cached_state()
2474
self._last_revision_info_cache = None
2475
self._reference_info = None
2477
def _last_revision_info(self):
2478
revision_string = self._transport.get_bytes('last-revision')
2479
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2480
revision_id = cache_utf8.get_cached_utf8(revision_id)
2482
return revno, revision_id
2484
def _write_last_revision_info(self, revno, revision_id):
2485
"""Simply write out the revision id, with no checks.
2487
Use set_last_revision_info to perform this safely.
2489
Does not update the revision_history cache.
2490
Intended to be called by set_last_revision_info and
2491
_write_revision_history.
2493
revision_id = _mod_revision.ensure_null(revision_id)
2494
out_string = '%d %s\n' % (revno, revision_id)
2495
self._transport.put_bytes('last-revision', out_string,
2496
mode=self.bzrdir._get_file_mode())
2499
def set_last_revision_info(self, revno, revision_id):
2500
revision_id = _mod_revision.ensure_null(revision_id)
2501
old_revno, old_revid = self.last_revision_info()
2502
if self._get_append_revisions_only():
2503
self._check_history_violation(revision_id)
2504
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2505
self._write_last_revision_info(revno, revision_id)
2506
self._clear_cached_state()
2507
self._last_revision_info_cache = revno, revision_id
2508
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2510
def _synchronize_history(self, destination, revision_id):
2511
"""Synchronize last revision and revision history between branches.
2513
:see: Branch._synchronize_history
2515
# XXX: The base Branch has a fast implementation of this method based
2516
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2517
# that uses set_revision_history. This class inherits from BzrBranch5,
2518
# but wants the fast implementation, so it calls
2519
# Branch._synchronize_history directly.
2520
Branch._synchronize_history(self, destination, revision_id)
2522
def _check_history_violation(self, revision_id):
2523
last_revision = _mod_revision.ensure_null(self.last_revision())
2524
if _mod_revision.is_null(last_revision):
2526
if last_revision not in self._lefthand_history(revision_id):
2527
raise errors.AppendRevisionsOnlyViolation(self.base)
2529
def _gen_revision_history(self):
2530
"""Generate the revision history from last revision
2532
last_revno, last_revision = self.last_revision_info()
2533
self._extend_partial_history(stop_index=last_revno-1)
2534
return list(reversed(self._partial_revision_history_cache))
2536
def _write_revision_history(self, history):
2537
"""Factored out of set_revision_history.
2539
This performs the actual writing to disk, with format-specific checks.
2540
It is intended to be called by BzrBranch5.set_revision_history.
2542
if len(history) == 0:
2543
last_revision = 'null:'
2545
if history != self._lefthand_history(history[-1]):
2546
raise errors.NotLefthandHistory(history)
2547
last_revision = history[-1]
2548
if self._get_append_revisions_only():
2549
self._check_history_violation(last_revision)
2550
self._write_last_revision_info(len(history), last_revision)
2553
def _set_parent_location(self, url):
2554
"""Set the parent branch"""
2555
self._set_config_location('parent_location', url, make_relative=True)
2558
def _get_parent_location(self):
2559
"""Set the parent branch"""
2560
return self._get_config_location('parent_location')
2563
def _set_all_reference_info(self, info_dict):
2564
"""Replace all reference info stored in a branch.
2566
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2569
writer = rio.RioWriter(s)
2570
for key, (tree_path, branch_location) in info_dict.iteritems():
2571
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2572
branch_location=branch_location)
2573
writer.write_stanza(stanza)
2574
self._transport.put_bytes('references', s.getvalue())
2575
self._reference_info = info_dict
2578
def _get_all_reference_info(self):
2579
"""Return all the reference info stored in a branch.
2581
:return: A dict of {file_id: (tree_path, branch_location)}
2583
if self._reference_info is not None:
2584
return self._reference_info
2585
rio_file = self._transport.get('references')
2587
stanzas = rio.read_stanzas(rio_file)
2588
info_dict = dict((s['file_id'], (s['tree_path'],
2589
s['branch_location'])) for s in stanzas)
2592
self._reference_info = info_dict
2595
def set_reference_info(self, file_id, tree_path, branch_location):
2596
"""Set the branch location to use for a tree reference.
2598
:param file_id: The file-id of the tree reference.
2599
:param tree_path: The path of the tree reference in the tree.
2600
:param branch_location: The location of the branch to retrieve tree
2603
info_dict = self._get_all_reference_info()
2604
info_dict[file_id] = (tree_path, branch_location)
2605
if None in (tree_path, branch_location):
2606
if tree_path is not None:
2607
raise ValueError('tree_path must be None when branch_location'
2609
if branch_location is not None:
2610
raise ValueError('branch_location must be None when tree_path'
2612
del info_dict[file_id]
2613
self._set_all_reference_info(info_dict)
2615
def get_reference_info(self, file_id):
2616
"""Get the tree_path and branch_location for a tree reference.
2618
:return: a tuple of (tree_path, branch_location)
2620
return self._get_all_reference_info().get(file_id, (None, None))
2622
def reference_parent(self, file_id, path, possible_transports=None):
2623
"""Return the parent branch for a tree-reference file_id.
2625
:param file_id: The file_id of the tree reference
2626
:param path: The path of the file_id in the tree
2627
:return: A branch associated with the file_id
2629
branch_location = self.get_reference_info(file_id)[1]
2630
if branch_location is None:
2631
return Branch.reference_parent(self, file_id, path,
2632
possible_transports)
2633
branch_location = urlutils.join(self.base, branch_location)
2634
return Branch.open(branch_location,
2635
possible_transports=possible_transports)
2637
def set_push_location(self, location):
2638
"""See Branch.set_push_location."""
2639
self._set_config_location('push_location', location)
2641
def set_bound_location(self, location):
2642
"""See Branch.set_push_location."""
2644
config = self.get_config()
2645
if location is None:
2646
if config.get_user_option('bound') != 'True':
2649
config.set_user_option('bound', 'False', warn_masked=True)
2652
self._set_config_location('bound_location', location,
2654
config.set_user_option('bound', 'True', warn_masked=True)
2657
def _get_bound_location(self, bound):
2658
"""Return the bound location in the config file.
2660
Return None if the bound parameter does not match"""
2661
config = self.get_config()
2662
config_bound = (config.get_user_option('bound') == 'True')
2663
if config_bound != bound:
2665
return self._get_config_location('bound_location', config=config)
2667
def get_bound_location(self):
2668
"""See Branch.set_push_location."""
2669
return self._get_bound_location(True)
2671
def get_old_bound_location(self):
2672
"""See Branch.get_old_bound_location"""
2673
return self._get_bound_location(False)
2675
def get_stacked_on_url(self):
2676
# you can always ask for the URL; but you might not be able to use it
2677
# if the repo can't support stacking.
2678
## self._check_stackable_repo()
2679
stacked_url = self._get_config_location('stacked_on_location')
2680
if stacked_url is None:
2681
raise errors.NotStacked(self)
2684
def _get_append_revisions_only(self):
2685
value = self.get_config().get_user_option('append_revisions_only')
2686
return value == 'True'
2689
def generate_revision_history(self, revision_id, last_rev=None,
2691
"""See BzrBranch5.generate_revision_history"""
2692
history = self._lefthand_history(revision_id, last_rev, other_branch)
2693
revno = len(history)
2694
self.set_last_revision_info(revno, revision_id)
2697
def get_rev_id(self, revno, history=None):
2698
"""Find the revision id of the specified revno."""
2700
return _mod_revision.NULL_REVISION
2702
last_revno, last_revision_id = self.last_revision_info()
2703
if revno <= 0 or revno > last_revno:
2704
raise errors.NoSuchRevision(self, revno)
2706
if history is not None:
2707
return history[revno - 1]
2709
index = last_revno - revno
2710
if len(self._partial_revision_history_cache) <= index:
2711
self._extend_partial_history(stop_index=index)
2712
if len(self._partial_revision_history_cache) > index:
2713
return self._partial_revision_history_cache[index]
2715
raise errors.NoSuchRevision(self, revno)
2718
def revision_id_to_revno(self, revision_id):
2719
"""Given a revision id, return its revno"""
2720
if _mod_revision.is_null(revision_id):
2723
index = self._partial_revision_history_cache.index(revision_id)
2725
self._extend_partial_history(stop_revision=revision_id)
2726
index = len(self._partial_revision_history_cache) - 1
2727
if self._partial_revision_history_cache[index] != revision_id:
2728
raise errors.NoSuchRevision(self, revision_id)
2729
return self.revno() - index
2732
class BzrBranch7(BzrBranch8):
2733
"""A branch with support for a fallback repository."""
2735
def set_reference_info(self, file_id, tree_path, branch_location):
2736
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2738
def get_reference_info(self, file_id):
2739
Branch.get_reference_info(self, file_id)
2741
def reference_parent(self, file_id, path, possible_transports=None):
2742
return Branch.reference_parent(self, file_id, path,
2743
possible_transports)
2746
class BzrBranch6(BzrBranch7):
2747
"""See BzrBranchFormat6 for the capabilities of this branch.
2749
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2753
def get_stacked_on_url(self):
2754
raise errors.UnstackableBranchFormat(self._format, self.base)
2757
######################################################################
2758
# results of operations
2761
class _Result(object):
2763
def _show_tag_conficts(self, to_file):
2764
if not getattr(self, 'tag_conflicts', None):
2766
to_file.write('Conflicting tags:\n')
2767
for name, value1, value2 in self.tag_conflicts:
2768
to_file.write(' %s\n' % (name, ))
2771
class PullResult(_Result):
2772
"""Result of a Branch.pull operation.
2774
:ivar old_revno: Revision number before pull.
2775
:ivar new_revno: Revision number after pull.
2776
:ivar old_revid: Tip revision id before pull.
2777
:ivar new_revid: Tip revision id after pull.
2778
:ivar source_branch: Source (local) branch object. (read locked)
2779
:ivar master_branch: Master branch of the target, or the target if no
2781
:ivar local_branch: target branch if there is a Master, else None
2782
:ivar target_branch: Target/destination branch object. (write locked)
2783
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2787
# DEPRECATED: pull used to return the change in revno
2788
return self.new_revno - self.old_revno
2790
def report(self, to_file):
2792
if self.old_revid == self.new_revid:
2793
to_file.write('No revisions to pull.\n')
2795
to_file.write('Now on revision %d.\n' % self.new_revno)
2796
self._show_tag_conficts(to_file)
2799
class BranchPushResult(_Result):
2800
"""Result of a Branch.push operation.
2802
:ivar old_revno: Revision number (eg 10) of the target before push.
2803
:ivar new_revno: Revision number (eg 12) of the target after push.
2804
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2806
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2808
:ivar source_branch: Source branch object that the push was from. This is
2809
read locked, and generally is a local (and thus low latency) branch.
2810
:ivar master_branch: If target is a bound branch, the master branch of
2811
target, or target itself. Always write locked.
2812
:ivar target_branch: The direct Branch where data is being sent (write
2814
:ivar local_branch: If the target is a bound branch this will be the
2815
target, otherwise it will be None.
2819
# DEPRECATED: push used to return the change in revno
2820
return self.new_revno - self.old_revno
2822
def report(self, to_file):
2823
"""Write a human-readable description of the result."""
2824
if self.old_revid == self.new_revid:
2825
note('No new revisions to push.')
2827
note('Pushed up to revision %d.' % self.new_revno)
2828
self._show_tag_conficts(to_file)
1424
2831
class BranchCheckResult(object):
1430
2837
def __init__(self, branch):
1431
2838
self.branch = branch
1433
2841
def report_results(self, verbose):
1434
2842
"""Report the check results via trace.note.
1436
2844
:param verbose: Requests more detailed display of what was checked,
1439
note('checked branch %s format %s',
1441
self.branch._format)
1444
######################################################################
1448
@deprecated_function(zero_eight)
1449
def is_control_file(*args, **kwargs):
1450
"""See bzrlib.workingtree.is_control_file."""
1451
return bzrlib.workingtree.is_control_file(*args, **kwargs)
2847
note('checked branch %s format %s', self.branch.base,
2848
self.branch._format)
2849
for error in self.errors:
2850
note('found error:%s', error)
2853
class Converter5to6(object):
2854
"""Perform an in-place upgrade of format 5 to format 6"""
2856
def convert(self, branch):
2857
# Data for 5 and 6 can peacefully coexist.
2858
format = BzrBranchFormat6()
2859
new_branch = format.open(branch.bzrdir, _found=True)
2861
# Copy source data into target
2862
new_branch._write_last_revision_info(*branch.last_revision_info())
2863
new_branch.set_parent(branch.get_parent())
2864
new_branch.set_bound_location(branch.get_bound_location())
2865
new_branch.set_push_location(branch.get_push_location())
2867
# New branch has no tags by default
2868
new_branch.tags._set_tag_dict({})
2870
# Copying done; now update target format
2871
new_branch._transport.put_bytes('format',
2872
format.get_format_string(),
2873
mode=new_branch.bzrdir._get_file_mode())
2875
# Clean up old files
2876
new_branch._transport.delete('revision-history')
2878
branch.set_parent(None)
2879
except errors.NoSuchFile:
2881
branch.set_bound_location(None)
2884
class Converter6to7(object):
2885
"""Perform an in-place upgrade of format 6 to format 7"""
2887
def convert(self, branch):
2888
format = BzrBranchFormat7()
2889
branch._set_config_location('stacked_on_location', '')
2890
# update target format
2891
branch._transport.put_bytes('format', format.get_format_string())
2894
class Converter7to8(object):
2895
"""Perform an in-place upgrade of format 6 to format 7"""
2897
def convert(self, branch):
2898
format = BzrBranchFormat8()
2899
branch._transport.put_bytes('references', '')
2900
# update target format
2901
branch._transport.put_bytes('format', format.get_format_string())
2904
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2905
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2908
_run_with_write_locked_target will attempt to release the lock it acquires.
2910
If an exception is raised by callable, then that exception *will* be
2911
propagated, even if the unlock attempt raises its own error. Thus
2912
_run_with_write_locked_target should be preferred to simply doing::
2916
return callable(*args, **kwargs)
2921
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2922
# should share code?
2925
result = callable(*args, **kwargs)
2927
exc_info = sys.exc_info()
2931
raise exc_info[0], exc_info[1], exc_info[2]
2937
class InterBranch(InterObject):
2938
"""This class represents operations taking place between two branches.
2940
Its instances have methods like pull() and push() and contain
2941
references to the source and target repositories these operations
2942
can be carried out on.
2946
"""The available optimised InterBranch types."""
2949
def _get_branch_formats_to_test():
2950
"""Return a tuple with the Branch formats to use when testing."""
2951
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
2953
def pull(self, overwrite=False, stop_revision=None,
2954
possible_transports=None, local=False):
2955
"""Mirror source into target branch.
2957
The target branch is considered to be 'local', having low latency.
2959
:returns: PullResult instance
2961
raise NotImplementedError(self.pull)
2963
def update_revisions(self, stop_revision=None, overwrite=False,
2965
"""Pull in new perfect-fit revisions.
2967
:param stop_revision: Updated until the given revision
2968
:param overwrite: Always set the branch pointer, rather than checking
2969
to see if it is a proper descendant.
2970
:param graph: A Graph object that can be used to query history
2971
information. This can be None.
2974
raise NotImplementedError(self.update_revisions)
2976
def push(self, overwrite=False, stop_revision=None,
2977
_override_hook_source_branch=None):
2978
"""Mirror the source branch into the target branch.
2980
The source branch is considered to be 'local', having low latency.
2982
raise NotImplementedError(self.push)
2985
class GenericInterBranch(InterBranch):
2986
"""InterBranch implementation that uses public Branch functions.
2990
def _get_branch_formats_to_test():
2991
return BranchFormat._default_format, BranchFormat._default_format
2993
def update_revisions(self, stop_revision=None, overwrite=False,
2995
"""See InterBranch.update_revisions()."""
2996
self.source.lock_read()
2998
other_revno, other_last_revision = self.source.last_revision_info()
2999
stop_revno = None # unknown
3000
if stop_revision is None:
3001
stop_revision = other_last_revision
3002
if _mod_revision.is_null(stop_revision):
3003
# if there are no commits, we're done.
3005
stop_revno = other_revno
3007
# what's the current last revision, before we fetch [and change it
3009
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3010
# we fetch here so that we don't process data twice in the common
3011
# case of having something to pull, and so that the check for
3012
# already merged can operate on the just fetched graph, which will
3013
# be cached in memory.
3014
self.target.fetch(self.source, stop_revision)
3015
# Check to see if one is an ancestor of the other
3018
graph = self.target.repository.get_graph()
3019
if self.target._check_if_descendant_or_diverged(
3020
stop_revision, last_rev, graph, self.source):
3021
# stop_revision is a descendant of last_rev, but we aren't
3022
# overwriting, so we're done.
3024
if stop_revno is None:
3026
graph = self.target.repository.get_graph()
3027
this_revno, this_last_revision = \
3028
self.target.last_revision_info()
3029
stop_revno = graph.find_distance_to_null(stop_revision,
3030
[(other_last_revision, other_revno),
3031
(this_last_revision, this_revno)])
3032
self.target.set_last_revision_info(stop_revno, stop_revision)
3034
self.source.unlock()
3036
def pull(self, overwrite=False, stop_revision=None,
3037
possible_transports=None, _hook_master=None, run_hooks=True,
3038
_override_hook_target=None, local=False):
3041
:param _hook_master: Private parameter - set the branch to
3042
be supplied as the master to pull hooks.
3043
:param run_hooks: Private parameter - if false, this branch
3044
is being called because it's the master of the primary branch,
3045
so it should not run its hooks.
3046
:param _override_hook_target: Private parameter - set the branch to be
3047
supplied as the target_branch to pull hooks.
3048
:param local: Only update the local branch, and not the bound branch.
3050
# This type of branch can't be bound.
3052
raise errors.LocalRequiresBoundBranch()
3053
result = PullResult()
3054
result.source_branch = self.source
3055
if _override_hook_target is None:
3056
result.target_branch = self.target
3058
result.target_branch = _override_hook_target
3059
self.source.lock_read()
3061
# We assume that during 'pull' the target repository is closer than
3063
self.source.update_references(self.target)
3064
graph = self.target.repository.get_graph(self.source.repository)
3065
# TODO: Branch formats should have a flag that indicates
3066
# that revno's are expensive, and pull() should honor that flag.
3068
result.old_revno, result.old_revid = \
3069
self.target.last_revision_info()
3070
self.target.update_revisions(self.source, stop_revision,
3071
overwrite=overwrite, graph=graph)
3072
# TODO: The old revid should be specified when merging tags,
3073
# so a tags implementation that versions tags can only
3074
# pull in the most recent changes. -- JRV20090506
3075
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3077
result.new_revno, result.new_revid = self.target.last_revision_info()
3079
result.master_branch = _hook_master
3080
result.local_branch = result.target_branch
3082
result.master_branch = result.target_branch
3083
result.local_branch = None
3085
for hook in Branch.hooks['post_pull']:
3088
self.source.unlock()
3091
def push(self, overwrite=False, stop_revision=None,
3092
_override_hook_source_branch=None):
3093
"""See InterBranch.push.
3095
This is the basic concrete implementation of push()
3097
:param _override_hook_source_branch: If specified, run
3098
the hooks passing this Branch as the source, rather than self.
3099
This is for use of RemoteBranch, where push is delegated to the
3100
underlying vfs-based Branch.
3102
# TODO: Public option to disable running hooks - should be trivial but
3104
self.source.lock_read()
3106
return _run_with_write_locked_target(
3107
self.target, self._push_with_bound_branches, overwrite,
3109
_override_hook_source_branch=_override_hook_source_branch)
3111
self.source.unlock()
3113
def _push_with_bound_branches(self, overwrite, stop_revision,
3114
_override_hook_source_branch=None):
3115
"""Push from source into target, and into target's master if any.
3118
if _override_hook_source_branch:
3119
result.source_branch = _override_hook_source_branch
3120
for hook in Branch.hooks['post_push']:
3123
bound_location = self.target.get_bound_location()
3124
if bound_location and self.target.base != bound_location:
3125
# there is a master branch.
3127
# XXX: Why the second check? Is it even supported for a branch to
3128
# be bound to itself? -- mbp 20070507
3129
master_branch = self.target.get_master_branch()
3130
master_branch.lock_write()
3132
# push into the master from the source branch.
3133
self.source._basic_push(master_branch, overwrite, stop_revision)
3134
# and push into the target branch from the source. Note that we
3135
# push from the source branch again, because its considered the
3136
# highest bandwidth repository.
3137
result = self.source._basic_push(self.target, overwrite,
3139
result.master_branch = master_branch
3140
result.local_branch = self.target
3144
master_branch.unlock()
3147
result = self.source._basic_push(self.target, overwrite,
3149
# TODO: Why set master_branch and local_branch if there's no
3150
# binding? Maybe cleaner to just leave them unset? -- mbp
3152
result.master_branch = self.target
3153
result.local_branch = None
3158
def is_compatible(self, source, target):
3159
# GenericBranch uses the public API, so always compatible
3163
class InterToBranch5(GenericInterBranch):
3166
def _get_branch_formats_to_test():
3167
return BranchFormat._default_format, BzrBranchFormat5()
3169
def pull(self, overwrite=False, stop_revision=None,
3170
possible_transports=None, run_hooks=True,
3171
_override_hook_target=None, local=False):
3172
"""Pull from source into self, updating my master if any.
3174
:param run_hooks: Private parameter - if false, this branch
3175
is being called because it's the master of the primary branch,
3176
so it should not run its hooks.
3178
bound_location = self.target.get_bound_location()
3179
if local and not bound_location:
3180
raise errors.LocalRequiresBoundBranch()
3181
master_branch = None
3182
if not local and bound_location and self.source.base != bound_location:
3183
# not pulling from master, so we need to update master.
3184
master_branch = self.target.get_master_branch(possible_transports)
3185
master_branch.lock_write()
3188
# pull from source into master.
3189
master_branch.pull(self.source, overwrite, stop_revision,
3191
return super(InterToBranch5, self).pull(overwrite,
3192
stop_revision, _hook_master=master_branch,
3193
run_hooks=run_hooks,
3194
_override_hook_target=_override_hook_target)
3197
master_branch.unlock()
3200
InterBranch.register_optimiser(GenericInterBranch)
3201
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
