121
113
if master is not None:
122
114
master.break_lock()
124
def _check_stackable_repo(self):
125
if not self.repository._format.supports_external_lookups:
126
raise errors.UnstackableRepositoryFormat(self.repository._format,
127
self.repository.base)
129
def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
"""Extend the partial history to include a given index
132
If a stop_index is supplied, stop when that index has been reached.
133
If a stop_revision is supplied, stop when that revision is
134
encountered. Otherwise, stop when the beginning of history is
137
:param stop_index: The index which should be present. When it is
138
present, history extension will stop.
139
:param stop_revision: The revision id which should be present. When
140
it is encountered, history extension will stop.
142
if len(self._partial_revision_history_cache) == 0:
143
self._partial_revision_history_cache = [self.last_revision()]
144
repository._iter_for_revno(
145
self.repository, self._partial_revision_history_cache,
146
stop_index=stop_index, stop_revision=stop_revision)
147
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
self._partial_revision_history_cache.pop()
150
def _get_check_refs(self):
151
"""Get the references needed for check().
155
revid = self.last_revision()
156
return [('revision-existence', revid), ('lefthand-distance', revid)]
159
def open(base, _unsupported=False, possible_transports=None):
117
@deprecated_method(zero_eight)
118
def open_downlevel(base):
119
"""Open a branch which may be of an old format."""
120
return Branch.open(base, _unsupported=True)
123
def open(base, _unsupported=False):
160
124
"""Open the branch rooted at base.
162
126
For instance, if the branch is at URL/.bzr/branch,
163
127
Branch.open(URL) -> a Branch instance.
165
control = bzrdir.BzrDir.open(base, _unsupported,
166
possible_transports=possible_transports)
167
return control.open_branch(unsupported=_unsupported)
170
def open_from_transport(transport, name=None, _unsupported=False):
171
"""Open the branch rooted at transport"""
172
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
return control.open_branch(name=name, unsupported=_unsupported)
176
def open_containing(url, possible_transports=None):
129
control = bzrdir.BzrDir.open(base, _unsupported)
130
return control.open_branch(_unsupported)
133
def open_containing(url):
177
134
"""Open an existing branch which contains url.
179
136
This probes for a branch at url, and searches upwards from there.
181
138
Basically we keep looking up until we find the control directory or
182
139
run into the root. If there isn't one, raises NotBranchError.
183
If there is one and it is either an unrecognised format or an unsupported
140
If there is one and it is either an unrecognised format or an unsupported
184
141
format, UnknownFormatError or UnsupportedFormatError are raised.
185
142
If there is one, it is returned, along with the unused portion of url.
187
control, relpath = bzrdir.BzrDir.open_containing(url,
144
control, relpath = bzrdir.BzrDir.open_containing(url)
189
145
return control.open_branch(), relpath
191
def _push_should_merge_tags(self):
192
"""Should _basic_push merge this branch's tags into the target?
194
The default implementation returns False if this branch has no tags,
195
and True the rest of the time. Subclasses may override this.
197
return self.supports_tags() and self.tags.get_tag_dict()
148
@deprecated_function(zero_eight)
149
def initialize(base):
150
"""Create a new working tree and branch, rooted at 'base' (url)
152
NOTE: This will soon be deprecated in favour of creation
155
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
157
@deprecated_function(zero_eight)
158
def setup_caching(self, cache_root):
159
"""Subclasses that care about caching should override this, and set
160
up cached stores located under cache_root.
162
NOTE: This is unused.
199
166
def get_config(self):
200
167
return BranchConfig(self)
202
def _get_config(self):
203
"""Get the concrete config for just the config in this branch.
205
This is not intended for client use; see Branch.get_config for the
210
:return: An object supporting get_option and set_option.
212
raise NotImplementedError(self._get_config)
214
def _get_fallback_repository(self, url):
215
"""Get the repository we fallback to at url."""
216
url = urlutils.join(self.base, url)
217
a_branch = Branch.open(url,
218
possible_transports=[self.bzrdir.root_transport])
219
return a_branch.repository
221
def _get_tags_bytes(self):
222
"""Get the bytes of a serialised tags dict.
224
Note that not all branches support tags, nor do all use the same tags
225
logic: this method is specific to BasicTags. Other tag implementations
226
may use the same method name and behave differently, safely, because
227
of the double-dispatch via
228
format.make_tags->tags_instance->get_tags_dict.
230
:return: The bytes of the tags file.
231
:seealso: Branch._set_tags_bytes.
233
return self._transport.get_bytes('tags')
235
def _get_nick(self, local=False, possible_transports=None):
236
config = self.get_config()
237
# explicit overrides master, but don't look for master if local is True
238
if not local and not config.has_explicit_nickname():
240
master = self.get_master_branch(possible_transports)
241
if master is not None:
242
# return the master branch value
244
except errors.BzrError, e:
245
# Silently fall back to local implicit nick if the master is
247
mutter("Could not connect to bound branch, "
248
"falling back to local nick.\n " + str(e))
249
return config.get_nickname()
170
return self.get_config().get_nickname()
251
172
def _set_nick(self, nick):
252
self.get_config().set_user_option('nickname', nick, warn_masked=True)
173
self.get_config().set_user_option('nickname', nick)
254
175
nick = property(_get_nick, _set_nick)
256
177
def is_locked(self):
257
178
raise NotImplementedError(self.is_locked)
259
def _lefthand_history(self, revision_id, last_rev=None,
261
if 'evil' in debug.debug_flags:
262
mutter_callsite(4, "_lefthand_history scales with history.")
263
# stop_revision must be a descendant of last_revision
264
graph = self.repository.get_graph()
265
if last_rev is not None:
266
if not graph.is_ancestor(last_rev, revision_id):
267
# our previous tip is not merged into stop_revision
268
raise errors.DivergedBranches(self, other_branch)
269
# make a new revision history from the graph
270
parents_map = graph.get_parent_map([revision_id])
271
if revision_id not in parents_map:
272
raise errors.NoSuchRevision(self, revision_id)
273
current_rev_id = revision_id
275
check_not_reserved_id = _mod_revision.check_not_reserved_id
276
# Do not include ghosts or graph origin in revision_history
277
while (current_rev_id in parents_map and
278
len(parents_map[current_rev_id]) > 0):
279
check_not_reserved_id(current_rev_id)
280
new_history.append(current_rev_id)
281
current_rev_id = parents_map[current_rev_id][0]
282
parents_map = graph.get_parent_map([current_rev_id])
283
new_history.reverse()
286
180
def lock_write(self):
287
181
raise NotImplementedError(self.lock_write)
299
193
def get_physical_lock_status(self):
300
194
raise NotImplementedError(self.get_physical_lock_status)
303
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
304
"""Return the revision_id for a dotted revno.
306
:param revno: a tuple like (1,) or (1,1,2)
307
:param _cache_reverse: a private parameter enabling storage
308
of the reverse mapping in a top level cache. (This should
309
only be done in selective circumstances as we want to
310
avoid having the mapping cached multiple times.)
311
:return: the revision_id
312
:raises errors.NoSuchRevision: if the revno doesn't exist
314
rev_id = self._do_dotted_revno_to_revision_id(revno)
316
self._partial_revision_id_to_revno_cache[rev_id] = revno
319
def _do_dotted_revno_to_revision_id(self, revno):
320
"""Worker function for dotted_revno_to_revision_id.
322
Subclasses should override this if they wish to
323
provide a more efficient implementation.
326
return self.get_rev_id(revno[0])
327
revision_id_to_revno = self.get_revision_id_to_revno_map()
328
revision_ids = [revision_id for revision_id, this_revno
329
in revision_id_to_revno.iteritems()
330
if revno == this_revno]
331
if len(revision_ids) == 1:
332
return revision_ids[0]
334
revno_str = '.'.join(map(str, revno))
335
raise errors.NoSuchRevision(self, revno_str)
338
def revision_id_to_dotted_revno(self, revision_id):
339
"""Given a revision id, return its dotted revno.
341
:return: a tuple like (1,) or (400,1,3).
343
return self._do_revision_id_to_dotted_revno(revision_id)
345
def _do_revision_id_to_dotted_revno(self, revision_id):
346
"""Worker function for revision_id_to_revno."""
347
# Try the caches if they are loaded
348
result = self._partial_revision_id_to_revno_cache.get(revision_id)
349
if result is not None:
351
if self._revision_id_to_revno_cache:
352
result = self._revision_id_to_revno_cache.get(revision_id)
354
raise errors.NoSuchRevision(self, revision_id)
355
# Try the mainline as it's optimised
357
revno = self.revision_id_to_revno(revision_id)
359
except errors.NoSuchRevision:
360
# We need to load and use the full revno map after all
361
result = self.get_revision_id_to_revno_map().get(revision_id)
363
raise errors.NoSuchRevision(self, revision_id)
367
def get_revision_id_to_revno_map(self):
368
"""Return the revision_id => dotted revno map.
370
This will be regenerated on demand, but will be cached.
372
:return: A dictionary mapping revision_id => dotted revno.
373
This dictionary should not be modified by the caller.
375
if self._revision_id_to_revno_cache is not None:
376
mapping = self._revision_id_to_revno_cache
378
mapping = self._gen_revno_map()
379
self._cache_revision_id_to_revno(mapping)
380
# TODO: jam 20070417 Since this is being cached, should we be returning
382
# I would rather not, and instead just declare that users should not
383
# modify the return value.
386
def _gen_revno_map(self):
387
"""Create a new mapping from revision ids to dotted revnos.
389
Dotted revnos are generated based on the current tip in the revision
391
This is the worker function for get_revision_id_to_revno_map, which
392
just caches the return value.
394
:return: A dictionary mapping revision_id => dotted revno.
396
revision_id_to_revno = dict((rev_id, revno)
397
for rev_id, depth, revno, end_of_merge
398
in self.iter_merge_sorted_revisions())
399
return revision_id_to_revno
402
def iter_merge_sorted_revisions(self, start_revision_id=None,
403
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
404
"""Walk the revisions for a branch in merge sorted order.
406
Merge sorted order is the output from a merge-aware,
407
topological sort, i.e. all parents come before their
408
children going forward; the opposite for reverse.
410
:param start_revision_id: the revision_id to begin walking from.
411
If None, the branch tip is used.
412
:param stop_revision_id: the revision_id to terminate the walk
413
after. If None, the rest of history is included.
414
:param stop_rule: if stop_revision_id is not None, the precise rule
415
to use for termination:
416
* 'exclude' - leave the stop revision out of the result (default)
417
* 'include' - the stop revision is the last item in the result
418
* 'with-merges' - include the stop revision and all of its
419
merged revisions in the result
420
* 'with-merges-without-common-ancestry' - filter out revisions
421
that are in both ancestries
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
known_graph = self.repository.get_known_graph_ancestry(
451
self._merge_sorted_revisions_cache = known_graph.merge_sort(
453
filtered = self._filter_merge_sorted_revisions(
454
self._merge_sorted_revisions_cache, start_revision_id,
455
stop_revision_id, stop_rule)
456
# Make sure we don't return revisions that are not part of the
457
# start_revision_id ancestry.
458
filtered = self._filter_start_non_ancestors(filtered)
459
if direction == 'reverse':
461
if direction == 'forward':
462
return reversed(list(filtered))
464
raise ValueError('invalid direction %r' % direction)
466
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
467
start_revision_id, stop_revision_id, stop_rule):
468
"""Iterate over an inclusive range of sorted revisions."""
469
rev_iter = iter(merge_sorted_revisions)
470
if start_revision_id is not None:
471
for node in rev_iter:
472
rev_id = node.key[-1]
473
if rev_id != start_revision_id:
476
# The decision to include the start or not
477
# depends on the stop_rule if a stop is provided
478
# so pop this node back into the iterator
479
rev_iter = chain(iter([node]), rev_iter)
481
if stop_revision_id is None:
483
for node in rev_iter:
484
rev_id = node.key[-1]
485
yield (rev_id, node.merge_depth, node.revno,
487
elif stop_rule == 'exclude':
488
for node in rev_iter:
489
rev_id = node.key[-1]
490
if rev_id == stop_revision_id:
492
yield (rev_id, node.merge_depth, node.revno,
494
elif stop_rule == 'include':
495
for node in rev_iter:
496
rev_id = node.key[-1]
497
yield (rev_id, node.merge_depth, node.revno,
499
if rev_id == stop_revision_id:
501
elif stop_rule == 'with-merges-without-common-ancestry':
502
# We want to exclude all revisions that are already part of the
503
# stop_revision_id ancestry.
504
graph = self.repository.get_graph()
505
ancestors = graph.find_unique_ancestors(start_revision_id,
507
for node in rev_iter:
508
rev_id = node.key[-1]
509
if rev_id not in ancestors:
511
yield (rev_id, node.merge_depth, node.revno,
513
elif stop_rule == 'with-merges':
514
stop_rev = self.repository.get_revision(stop_revision_id)
515
if stop_rev.parent_ids:
516
left_parent = stop_rev.parent_ids[0]
518
left_parent = _mod_revision.NULL_REVISION
519
# left_parent is the actual revision we want to stop logging at,
520
# since we want to show the merged revisions after the stop_rev too
521
reached_stop_revision_id = False
522
revision_id_whitelist = []
523
for node in rev_iter:
524
rev_id = node.key[-1]
525
if rev_id == left_parent:
526
# reached the left parent after the stop_revision
528
if (not reached_stop_revision_id or
529
rev_id in revision_id_whitelist):
530
yield (rev_id, node.merge_depth, node.revno,
532
if reached_stop_revision_id or rev_id == stop_revision_id:
533
# only do the merged revs of rev_id from now on
534
rev = self.repository.get_revision(rev_id)
536
reached_stop_revision_id = True
537
revision_id_whitelist.extend(rev.parent_ids)
539
raise ValueError('invalid stop_rule %r' % stop_rule)
541
def _filter_start_non_ancestors(self, rev_iter):
542
# If we started from a dotted revno, we want to consider it as a tip
543
# and don't want to yield revisions that are not part of its
544
# ancestry. Given the order guaranteed by the merge sort, we will see
545
# uninteresting descendants of the first parent of our tip before the
547
first = rev_iter.next()
548
(rev_id, merge_depth, revno, end_of_merge) = first
551
# We start at a mainline revision so by definition, all others
552
# revisions in rev_iter are ancestors
553
for node in rev_iter:
558
pmap = self.repository.get_parent_map([rev_id])
559
parents = pmap.get(rev_id, [])
561
whitelist.update(parents)
563
# If there is no parents, there is nothing of interest left
565
# FIXME: It's hard to test this scenario here as this code is never
566
# called in that case. -- vila 20100322
569
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
571
if rev_id in whitelist:
572
pmap = self.repository.get_parent_map([rev_id])
573
parents = pmap.get(rev_id, [])
574
whitelist.remove(rev_id)
575
whitelist.update(parents)
577
# We've reached the mainline, there is nothing left to
581
# A revision that is not part of the ancestry of our
584
yield (rev_id, merge_depth, revno, end_of_merge)
586
def leave_lock_in_place(self):
587
"""Tell this branch object not to release the physical lock when this
590
If lock_write doesn't return a token, then this method is not supported.
592
self.control_files.leave_in_place()
594
def dont_leave_lock_in_place(self):
595
"""Tell this branch object to release the physical lock when this
596
object is unlocked, even if it didn't originally acquire it.
598
If lock_write doesn't return a token, then this method is not supported.
600
self.control_files.dont_leave_in_place()
196
def abspath(self, name):
197
"""Return absolute filename for something in the branch
199
XXX: Robert Collins 20051017 what is this used for? why is it a branch
200
method and not a tree method.
202
raise NotImplementedError(self.abspath)
602
204
def bind(self, other):
603
205
"""Bind the local branch the other branch.
698
283
The delta is relative to its mainline predecessor, or the
699
284
empty tree for revision 1.
286
assert isinstance(revno, int)
701
287
rh = self.revision_history()
702
288
if not (1 <= revno <= len(rh)):
703
raise errors.InvalidRevisionNumber(revno)
289
raise InvalidRevisionNumber(revno)
704
290
return self.repository.get_revision_delta(rh[revno-1])
706
def get_stacked_on_url(self):
707
"""Get the URL this branch is stacked against.
709
:raises NotStacked: If the branch is not stacked.
710
:raises UnstackableBranchFormat: If the branch does not support
713
raise NotImplementedError(self.get_stacked_on_url)
292
def get_root_id(self):
293
"""Return the id of this branches root"""
294
raise NotImplementedError(self.get_root_id)
715
296
def print_file(self, file, revision_id):
716
297
"""Print `file` to stdout."""
717
298
raise NotImplementedError(self.print_file)
300
def append_revision(self, *revision_ids):
301
raise NotImplementedError(self.append_revision)
719
303
def set_revision_history(self, rev_history):
720
304
raise NotImplementedError(self.set_revision_history)
723
def set_parent(self, url):
724
"""See Branch.set_parent."""
725
# TODO: Maybe delete old location files?
726
# URLs should never be unicode, even on the local fs,
727
# FIXUP this and get_parent in a future branch format bump:
728
# read and rewrite the file. RBC 20060125
730
if isinstance(url, unicode):
732
url = url.encode('ascii')
733
except UnicodeEncodeError:
734
raise errors.InvalidURL(url,
735
"Urls must be 7-bit ascii, "
736
"use bzrlib.urlutils.escape")
737
url = urlutils.relative_url(self.base, url)
738
self._set_parent_location(url)
741
def set_stacked_on_url(self, url):
742
"""Set the URL this branch is stacked against.
744
:raises UnstackableBranchFormat: If the branch does not support
746
:raises UnstackableRepositoryFormat: If the repository does not support
749
if not self._format.supports_stacking():
750
raise errors.UnstackableBranchFormat(self._format, self.user_url)
751
# XXX: Changing from one fallback repository to another does not check
752
# that all the data you need is present in the new fallback.
753
# Possibly it should.
754
self._check_stackable_repo()
757
old_url = self.get_stacked_on_url()
758
except (errors.NotStacked, errors.UnstackableBranchFormat,
759
errors.UnstackableRepositoryFormat):
763
self._activate_fallback_location(url)
764
# write this out after the repository is stacked to avoid setting a
765
# stacked config that doesn't work.
766
self._set_config_location('stacked_on_location', url)
769
"""Change a branch to be unstacked, copying data as needed.
771
Don't call this directly, use set_stacked_on_url(None).
773
pb = ui.ui_factory.nested_progress_bar()
775
pb.update("Unstacking")
776
# The basic approach here is to fetch the tip of the branch,
777
# including all available ghosts, from the existing stacked
778
# repository into a new repository object without the fallbacks.
780
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
781
# correct for CHKMap repostiories
782
old_repository = self.repository
783
if len(old_repository._fallback_repositories) != 1:
784
raise AssertionError("can't cope with fallback repositories "
785
"of %r" % (self.repository,))
786
# unlock it, including unlocking the fallback
787
old_repository.unlock()
788
old_repository.lock_read()
790
# Repositories don't offer an interface to remove fallback
791
# repositories today; take the conceptually simpler option and just
792
# reopen it. We reopen it starting from the URL so that we
793
# get a separate connection for RemoteRepositories and can
794
# stream from one of them to the other. This does mean doing
795
# separate SSH connection setup, but unstacking is not a
796
# common operation so it's tolerable.
797
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
798
new_repository = new_bzrdir.find_repository()
799
self.repository = new_repository
800
if self.repository._fallback_repositories:
801
raise AssertionError("didn't expect %r to have "
802
"fallback_repositories"
803
% (self.repository,))
804
# this is not paired with an unlock because it's just restoring
805
# the previous state; the lock's released when set_stacked_on_url
807
self.repository.lock_write()
808
# XXX: If you unstack a branch while it has a working tree
809
# with a pending merge, the pending-merged revisions will no
810
# longer be present. You can (probably) revert and remerge.
812
# XXX: This only fetches up to the tip of the repository; it
813
# doesn't bring across any tags. That's fairly consistent
814
# with how branch works, but perhaps not ideal.
815
self.repository.fetch(old_repository,
816
revision_id=self.last_revision(),
819
old_repository.unlock()
823
def _set_tags_bytes(self, bytes):
824
"""Mirror method for _get_tags_bytes.
826
:seealso: Branch._get_tags_bytes.
828
return _run_with_write_locked_target(self, self._transport.put_bytes,
831
def _cache_revision_history(self, rev_history):
832
"""Set the cached revision history to rev_history.
834
The revision_history method will use this cache to avoid regenerating
835
the revision history.
837
This API is semi-public; it only for use by subclasses, all other code
838
should consider it to be private.
840
self._revision_history_cache = rev_history
842
def _cache_revision_id_to_revno(self, revision_id_to_revno):
843
"""Set the cached revision_id => revno map to revision_id_to_revno.
845
This API is semi-public; it only for use by subclasses, all other code
846
should consider it to be private.
848
self._revision_id_to_revno_cache = revision_id_to_revno
850
def _clear_cached_state(self):
851
"""Clear any cached data on this branch, e.g. cached revision history.
853
This means the next call to revision_history will need to call
854
_gen_revision_history.
856
This API is semi-public; it only for use by subclasses, all other code
857
should consider it to be private.
859
self._revision_history_cache = None
860
self._revision_id_to_revno_cache = None
861
self._last_revision_info_cache = None
862
self._merge_sorted_revisions_cache = None
863
self._partial_revision_history_cache = []
864
self._partial_revision_id_to_revno_cache = {}
866
def _gen_revision_history(self):
867
"""Return sequence of revision hashes on to this branch.
869
Unlike revision_history, this method always regenerates or rereads the
870
revision history, i.e. it does not cache the result, so repeated calls
873
Concrete subclasses should override this instead of revision_history so
874
that subclasses do not need to deal with caching logic.
876
This API is semi-public; it only for use by subclasses, all other code
877
should consider it to be private.
879
raise NotImplementedError(self._gen_revision_history)
882
306
def revision_history(self):
883
"""Return sequence of revision ids on this branch.
885
This method will cache the revision history for as long as it is safe to
888
if 'evil' in debug.debug_flags:
889
mutter_callsite(3, "revision_history scales with history.")
890
if self._revision_history_cache is not None:
891
history = self._revision_history_cache
893
history = self._gen_revision_history()
894
self._cache_revision_history(history)
307
"""Return sequence of revision hashes on to this branch."""
308
raise NotImplementedError(self.revision_history)
898
311
"""Return current revision number for this branch.
942
352
common_index = min(self_len, other_len) -1
943
353
if common_index >= 0 and \
944
354
self_history[common_index] != other_history[common_index]:
945
raise errors.DivergedBranches(self, other)
355
raise DivergedBranches(self, other)
947
357
if stop_revision is None:
948
358
stop_revision = other_len
360
assert isinstance(stop_revision, int)
950
361
if stop_revision > other_len:
951
362
raise errors.NoSuchRevision(self, stop_revision)
952
363
return other_history[self_len:stop_revision]
955
def update_revisions(self, other, stop_revision=None, overwrite=False,
365
def update_revisions(self, other, stop_revision=None):
957
366
"""Pull in new perfect-fit revisions.
959
368
:param other: Another Branch to pull from
960
369
:param stop_revision: Updated until the given revision
961
:param overwrite: Always set the branch pointer, rather than checking
962
to see if it is a proper descendant.
963
:param graph: A Graph object that can be used to query history
964
information. This can be None.
967
return InterBranch.get(other, self).update_revisions(stop_revision,
970
def import_last_revision_info(self, source_repo, revno, revid):
971
"""Set the last revision info, importing from another repo if necessary.
973
This is used by the bound branch code to upload a revision to
974
the master branch first before updating the tip of the local branch.
976
:param source_repo: Source repository to optionally fetch from
977
:param revno: Revision number of the new tip
978
:param revid: Revision id of the new tip
980
if not self.repository.has_same_location(source_repo):
981
self.repository.fetch(source_repo, revision_id=revid)
982
self.set_last_revision_info(revno, revid)
372
raise NotImplementedError(self.update_revisions)
984
374
def revision_id_to_revno(self, revision_id):
985
375
"""Given a revision id, return its revno"""
986
if _mod_revision.is_null(revision_id):
376
if revision_id is None:
988
378
history = self.revision_history()
990
380
return history.index(revision_id) + 1
991
381
except ValueError:
992
raise errors.NoSuchRevision(self, revision_id)
382
raise bzrlib.errors.NoSuchRevision(self, revision_id)
995
384
def get_rev_id(self, revno, history=None):
996
385
"""Find the revision id of the specified revno."""
998
return _mod_revision.NULL_REVISION
999
last_revno, last_revid = self.last_revision_info()
1000
if revno == last_revno:
1002
if revno <= 0 or revno > last_revno:
1003
raise errors.NoSuchRevision(self, revno)
1004
distance_from_last = last_revno - revno
1005
if len(self._partial_revision_history_cache) <= distance_from_last:
1006
self._extend_partial_history(distance_from_last)
1007
return self._partial_revision_history_cache[distance_from_last]
389
history = self.revision_history()
390
if revno <= 0 or revno > len(history):
391
raise bzrlib.errors.NoSuchRevision(self, revno)
392
return history[revno - 1]
1010
def pull(self, source, overwrite=False, stop_revision=None,
1011
possible_transports=None, *args, **kwargs):
394
def pull(self, source, overwrite=False, stop_revision=None):
1012
395
"""Mirror source into this branch.
1014
397
This branch is considered to be 'local', having low latency.
1016
:returns: PullResult instance
1018
return InterBranch.get(source, self).pull(overwrite=overwrite,
1019
stop_revision=stop_revision,
1020
possible_transports=possible_transports, *args, **kwargs)
399
raise NotImplementedError(self.pull)
1022
def push(self, target, overwrite=False, stop_revision=None, *args,
401
def push(self, target, overwrite=False, stop_revision=None):
1024
402
"""Mirror this branch into target.
1026
404
This branch is considered to be 'local', having low latency.
1028
return InterBranch.get(self, target).push(overwrite, stop_revision,
1031
def lossy_push(self, target, stop_revision=None):
1032
"""Push deltas into another branch.
1034
:note: This does not, like push, retain the revision ids from
1035
the source branch and will, rather than adding bzr-specific
1036
metadata, push only those semantics of the revision that can be
1037
natively represented by this branch' VCS.
1039
:param target: Target branch
1040
:param stop_revision: Revision to push, defaults to last revision.
1041
:return: BranchPushResult with an extra member revidmap:
1042
A dictionary mapping revision ids from the target branch
1043
to new revision ids in the target branch, for each
1044
revision that was pushed.
1046
inter = InterBranch.get(self, target)
1047
lossy_push = getattr(inter, "lossy_push", None)
1048
if lossy_push is None:
1049
raise errors.LossyPushToSameVCS(self, target)
1050
return lossy_push(stop_revision)
406
raise NotImplementedError(self.push)
1052
408
def basis_tree(self):
1053
409
"""Return `Tree` object for last revision."""
1054
410
return self.repository.revision_tree(self.last_revision())
412
def rename_one(self, from_rel, to_rel):
415
This can change the directory or the filename or both.
417
raise NotImplementedError(self.rename_one)
419
def move(self, from_paths, to_name):
422
to_name must exist as a versioned directory.
424
If to_name exists and is a directory, the files are moved into
425
it, keeping their old names. If it is a directory,
427
Note that to_name is only the last component of the new name;
428
this doesn't change the directory.
430
This returns a list of (from_path, to_path) pairs for each
433
raise NotImplementedError(self.move)
1056
435
def get_parent(self):
1057
436
"""Return the parent location of the branch.
1059
This is the default location for pull/missing. The usual
438
This is the default location for push/pull/missing. The usual
1060
439
pattern is that the user can override it by specifying a
1063
parent = self._get_parent_location()
1066
# This is an old-format absolute path to a local branch
1067
# turn it into a url
1068
if parent.startswith('/'):
1069
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1071
return urlutils.join(self.base[:-1], parent)
1072
except errors.InvalidURLJoin, e:
1073
raise errors.InaccessibleParent(parent, self.user_url)
1075
def _get_parent_location(self):
1076
raise NotImplementedError(self._get_parent_location)
1078
def _set_config_location(self, name, url, config=None,
1079
make_relative=False):
1081
config = self.get_config()
1085
url = urlutils.relative_url(self.base, url)
1086
config.set_user_option(name, url, warn_masked=True)
1088
def _get_config_location(self, name, config=None):
1090
config = self.get_config()
1091
location = config.get_user_option(name)
1096
def get_child_submit_format(self):
1097
"""Return the preferred format of submissions to this branch."""
1098
return self.get_config().get_user_option("child_submit_format")
442
raise NotImplementedError(self.get_parent)
1100
444
def get_submit_branch(self):
1101
445
"""Return the submit location of the branch.
1180
487
self.check_real_revno(revno)
1182
489
def check_real_revno(self, revno):
1184
491
Check whether a revno corresponds to a real revision.
1185
492
Zero (the NULL revision) is considered invalid
1187
494
if revno < 1 or revno > self.revno():
1188
raise errors.InvalidRevisionNumber(revno)
495
raise InvalidRevisionNumber(revno)
1190
497
@needs_read_lock
1191
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
498
def clone(self, *args, **kwargs):
1192
499
"""Clone this branch into to_bzrdir preserving all semantic values.
1194
Most API users will want 'create_clone_on_transport', which creates a
1195
new bzrdir and branch on the fly.
1197
501
revision_id: if not None, the revision history in the new branch will
1198
502
be truncated to end with revision_id.
1200
result = to_bzrdir.create_branch()
1203
if repository_policy is not None:
1204
repository_policy.configure_branch(result)
1205
self.copy_content_into(result, revision_id=revision_id)
504
# for API compatibility, until 0.8 releases we provide the old api:
505
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
506
# after 0.8 releases, the *args and **kwargs should be changed:
507
# def clone(self, to_bzrdir, revision_id=None):
508
if (kwargs.get('to_location', None) or
509
kwargs.get('revision', None) or
510
kwargs.get('basis_branch', None) or
511
(len(args) and isinstance(args[0], basestring))):
512
# backwards compatibility api:
513
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
514
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
517
basis_branch = args[2]
519
basis_branch = kwargs.get('basis_branch', None)
521
basis = basis_branch.bzrdir
526
revision_id = args[1]
528
revision_id = kwargs.get('revision', None)
533
# no default to raise if not provided.
534
url = kwargs.get('to_location')
535
return self.bzrdir.clone(url,
536
revision_id=revision_id,
537
basis=basis).open_branch()
539
# generate args by hand
541
revision_id = args[1]
543
revision_id = kwargs.get('revision_id', None)
547
# no default to raise if not provided.
548
to_bzrdir = kwargs.get('to_bzrdir')
549
result = self._format.initialize(to_bzrdir)
550
self.copy_content_into(result, revision_id=revision_id)
1210
553
@needs_read_lock
1211
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
554
def sprout(self, to_bzrdir, revision_id=None):
1212
555
"""Create a new line of development from the branch, into to_bzrdir.
1214
to_bzrdir controls the branch format.
1216
557
revision_id: if not None, the revision history in the new branch will
1217
558
be truncated to end with revision_id.
1219
if (repository_policy is not None and
1220
repository_policy.requires_stacking()):
1221
to_bzrdir._format.require_stacking(_skip_repo=True)
1222
result = to_bzrdir.create_branch()
1225
if repository_policy is not None:
1226
repository_policy.configure_branch(result)
1227
self.copy_content_into(result, revision_id=revision_id)
1228
result.set_parent(self.bzrdir.root_transport.base)
560
result = self._format.initialize(to_bzrdir)
561
self.copy_content_into(result, revision_id=revision_id)
562
result.set_parent(self.bzrdir.root_transport.base)
1233
def _synchronize_history(self, destination, revision_id):
1234
"""Synchronize last revision and revision history between branches.
1236
This version is most efficient when the destination is also a
1237
BzrBranch6, but works for BzrBranch5, as long as the destination's
1238
repository contains all the lefthand ancestors of the intended
1239
last_revision. If not, set_last_revision_info will fail.
1241
:param destination: The branch to copy the history into
1242
:param revision_id: The revision-id to truncate history at. May
1243
be None to copy complete history.
1245
source_revno, source_revision_id = self.last_revision_info()
1246
if revision_id is None:
1247
revno, revision_id = source_revno, source_revision_id
1249
graph = self.repository.get_graph()
1251
revno = graph.find_distance_to_null(revision_id,
1252
[(source_revision_id, source_revno)])
1253
except errors.GhostRevisionsHaveNoRevno:
1254
# Default to 1, if we can't find anything else
1256
destination.set_last_revision_info(revno, revision_id)
1258
565
@needs_read_lock
1259
566
def copy_content_into(self, destination, revision_id=None):
1260
567
"""Copy the content of self into destination.
1273
586
destination.set_parent(parent)
1274
if self._push_should_merge_tags():
1275
self.tags.merge_to(destination.tags)
1277
def update_references(self, target):
1278
if not getattr(self._format, 'supports_reference_locations', False):
1280
reference_dict = self._get_all_reference_info()
1281
if len(reference_dict) == 0:
1283
old_base = self.base
1284
new_base = target.base
1285
target_reference_dict = target._get_all_reference_info()
1286
for file_id, (tree_path, branch_location) in (
1287
reference_dict.items()):
1288
branch_location = urlutils.rebase_url(branch_location,
1290
target_reference_dict.setdefault(
1291
file_id, (tree_path, branch_location))
1292
target._set_all_reference_info(target_reference_dict)
1294
588
@needs_read_lock
1295
def check(self, refs):
1296
590
"""Check consistency of the branch.
1298
592
In particular this checks that revisions given in the revision-history
1299
do actually match up in the revision graph, and that they're all
593
do actually match up in the revision graph, and that they're all
1300
594
present in the repository.
1302
596
Callers will typically also want to check the repository.
1304
:param refs: Calculated refs for this branch as specified by
1305
branch._get_check_refs()
1306
598
:return: A BranchCheckResult.
1308
result = BranchCheckResult(self)
1309
last_revno, last_revision_id = self.last_revision_info()
1310
actual_revno = refs[('lefthand-distance', last_revision_id)]
1311
if actual_revno != last_revno:
1312
result.errors.append(errors.BzrCheckError(
1313
'revno does not match len(mainline) %s != %s' % (
1314
last_revno, actual_revno)))
1315
# TODO: We should probably also check that self.revision_history
1316
# matches the repository for older branch formats.
1317
# If looking for the code that cross-checks repository parents against
1318
# the iter_reverse_revision_history output, that is now a repository
600
mainline_parent_id = None
601
for revision_id in self.revision_history():
603
revision = self.repository.get_revision(revision_id)
604
except errors.NoSuchRevision, e:
605
raise errors.BzrCheckError("mainline revision {%s} not in repository"
607
# In general the first entry on the revision history has no parents.
608
# But it's not illegal for it to have parents listed; this can happen
609
# in imports from Arch when the parents weren't reachable.
610
if mainline_parent_id is not None:
611
if mainline_parent_id not in revision.parent_ids:
612
raise errors.BzrCheckError("previous revision {%s} not listed among "
614
% (mainline_parent_id, revision_id))
615
mainline_parent_id = revision_id
616
return BranchCheckResult(self)
1322
618
def _get_checkout_format(self):
1323
619
"""Return the most suitable metadir for a checkout of this branch.
1324
Weaves are used if this branch's repository uses weaves.
620
Weaves are used if this branch's repostory uses weaves.
1326
622
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1327
623
from bzrlib.repofmt import weaverepo
1328
624
format = bzrdir.BzrDirMetaFormat1()
1329
625
format.repository_format = weaverepo.RepositoryFormat7()
1331
format = self.repository.bzrdir.checkout_metadir()
1332
format.set_branch_format(self._format)
627
format = self.repository.bzrdir.cloning_metadir()
1335
def create_clone_on_transport(self, to_transport, revision_id=None,
1336
stacked_on=None, create_prefix=False, use_existing_dir=False):
1337
"""Create a clone of this branch and its bzrdir.
1339
:param to_transport: The transport to clone onto.
1340
:param revision_id: The revision id to use as tip in the new branch.
1341
If None the tip is obtained from this branch.
1342
:param stacked_on: An optional URL to stack the clone on.
1343
:param create_prefix: Create any missing directories leading up to
1345
:param use_existing_dir: Use an existing directory if one exists.
1347
# XXX: Fix the bzrdir API to allow getting the branch back from the
1348
# clone call. Or something. 20090224 RBC/spiv.
1349
if revision_id is None:
1350
revision_id = self.last_revision()
1351
dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
revision_id=revision_id, stacked_on=stacked_on,
1353
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1354
return dir_to.open_branch()
1356
630
def create_checkout(self, to_location, revision_id=None,
1357
lightweight=False, accelerator_tree=None,
1359
632
"""Create a checkout of a branch.
1361
634
:param to_location: The url to produce the checkout at
1362
635
:param revision_id: The revision to check out
1363
636
:param lightweight: If True, produce a lightweight checkout, otherwise,
1364
637
produce a bound branch (heavyweight checkout)
1365
:param accelerator_tree: A tree which can be used for retrieving file
1366
contents more quickly than the revision tree, i.e. a workingtree.
1367
The revision tree will be used for cases where accelerator_tree's
1368
content is different.
1369
:param hardlink: If true, hard-link files from accelerator_tree,
1371
638
:return: The tree of the created checkout
1373
640
t = transport.get_transport(to_location)
643
except errors.FileExists:
1376
format = self._get_checkout_format()
1377
checkout = format.initialize_on_transport(t)
1378
from_branch = BranchReferenceFormat().initialize(checkout,
646
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
647
BranchReferenceFormat().initialize(checkout, self)
1381
649
format = self._get_checkout_format()
1382
650
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1383
651
to_location, force_new_tree=False, format=format)
1384
652
checkout = checkout_branch.bzrdir
1385
653
checkout_branch.bind(self)
1386
# pull up to the specified revision_id to set the initial
654
# pull up to the specified revision_id to set the initial
1387
655
# branch tip correctly, and seed it with history.
1388
656
checkout_branch.pull(self, stop_revision=revision_id)
1390
tree = checkout.create_workingtree(revision_id,
1391
from_branch=from_branch,
1392
accelerator_tree=accelerator_tree,
1394
basis_tree = tree.basis_tree()
1395
basis_tree.lock_read()
657
return checkout.create_workingtree(revision_id)
659
def copy_tags_to(self, to_branch):
660
"""Copy tags to another branch.
662
# TODO: Allow for doing a smarter merge, etc
663
if self == to_branch:
665
to_branch.lock_write()
1397
for path, file_id in basis_tree.iter_references():
1398
reference_parent = self.reference_parent(file_id, path)
1399
reference_parent.create_checkout(tree.abspath(path),
1400
basis_tree.get_reference_revision(file_id, path),
667
to_branch.tags._set_tag_dict(self.tags.get_tag_dict())
1407
def reconcile(self, thorough=True):
1408
"""Make sure the data stored in this branch is consistent."""
1409
from bzrlib.reconcile import BranchReconciler
1410
reconciler = BranchReconciler(self, thorough=thorough)
1411
reconciler.reconcile()
1414
def reference_parent(self, file_id, path, possible_transports=None):
1415
"""Return the parent branch for a tree-reference file_id
1416
:param file_id: The file_id of the tree reference
1417
:param path: The path of the file_id in the tree
1418
:return: A branch associated with the file_id
1420
# FIXME should provide multiple branches, based on config
1421
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1422
possible_transports=possible_transports)
1424
def supports_tags(self):
1425
return self._format.supports_tags()
1427
def automatic_tag_name(self, revision_id):
1428
"""Try to automatically find the tag name for a revision.
1430
:param revision_id: Revision id of the revision.
1431
:return: A tag name or None if no tag name could be determined.
1433
for hook in Branch.hooks['automatic_tag_name']:
1434
ret = hook(self, revision_id)
1439
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1441
"""Ensure that revision_b is a descendant of revision_a.
1443
This is a helper function for update_revisions.
1445
:raises: DivergedBranches if revision_b has diverged from revision_a.
1446
:returns: True if revision_b is a descendant of revision_a.
1448
relation = self._revision_relations(revision_a, revision_b, graph)
1449
if relation == 'b_descends_from_a':
1451
elif relation == 'diverged':
1452
raise errors.DivergedBranches(self, other_branch)
1453
elif relation == 'a_descends_from_b':
1456
raise AssertionError("invalid relation: %r" % (relation,))
1458
def _revision_relations(self, revision_a, revision_b, graph):
1459
"""Determine the relationship between two revisions.
1461
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1463
heads = graph.heads([revision_a, revision_b])
1464
if heads == set([revision_b]):
1465
return 'b_descends_from_a'
1466
elif heads == set([revision_a, revision_b]):
1467
# These branches have diverged
1469
elif heads == set([revision_a]):
1470
return 'a_descends_from_b'
1472
raise AssertionError("invalid heads: %r" % (heads,))
1475
671
class BranchFormat(object):
1476
672
"""An encapsulation of the initialization and open routines for a format.
1554
717
"""Return the short format description for this format."""
1555
718
raise NotImplementedError(self.get_format_description)
1557
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1558
hooks = Branch.hooks['post_branch_init']
1561
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1565
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
lock_type='metadir', set_format=True):
1567
"""Initialize a branch in a bzrdir, with specified files
1569
:param a_bzrdir: The bzrdir to initialize the branch in
1570
:param utf8_files: The files to create as a list of
1571
(filename, content) tuples
1572
:param name: Name of colocated branch to create, if any
1573
:param set_format: If True, set the format with
1574
self.get_format_string. (BzrBranch4 has its format set
1576
:return: a branch in this format
1578
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1581
'metadir': ('lock', lockdir.LockDir),
1582
'branch4': ('branch-lock', lockable_files.TransportLock),
1584
lock_name, lock_class = lock_map[lock_type]
1585
control_files = lockable_files.LockableFiles(branch_transport,
1586
lock_name, lock_class)
1587
control_files.create_lock()
1589
control_files.lock_write()
1590
except errors.LockContention:
1591
if lock_type != 'branch4':
1597
utf8_files += [('format', self.get_format_string())]
1599
for (filename, content) in utf8_files:
1600
branch_transport.put_bytes(
1602
mode=a_bzrdir._get_file_mode())
1605
control_files.unlock()
1606
branch = self.open(a_bzrdir, name, _found=True)
1607
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1610
def initialize(self, a_bzrdir, name=None):
1611
"""Create a branch of this format in a_bzrdir.
1613
:param name: Name of the colocated branch to create.
720
def initialize(self, a_bzrdir):
721
"""Create a branch of this format in a_bzrdir."""
1615
722
raise NotImplementedError(self.initialize)
1617
724
def is_supported(self):
1618
725
"""Is this format supported?
1620
727
Supported formats can be initialized and opened.
1621
Unsupported formats may not support initialization or committing or
728
Unsupported formats may not support initialization or committing or
1622
729
some other features depending on the reason for not being supported.
1626
def make_tags(self, branch):
1627
"""Create a tags object for branch.
1629
This method is on BranchFormat, because BranchFormats are reflected
1630
over the wire via network_name(), whereas full Branch instances require
1631
multiple VFS method calls to operate at all.
1633
The default implementation returns a disabled-tags instance.
1635
Note that it is normal for branch to be a RemoteBranch when using tags
1638
return DisabledTags(branch)
1640
def network_name(self):
1641
"""A simple byte string uniquely identifying this format for RPC calls.
1643
MetaDir branch formats use their disk format string to identify the
1644
repository over the wire. All in one formats such as bzr < 0.8, and
1645
foreign formats like svn/git and hg should use some marker which is
1646
unique and immutable.
1648
raise NotImplementedError(self.network_name)
1650
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
733
def open(self, a_bzrdir, _found=False):
1651
734
"""Return the branch object for a_bzrdir
1653
:param a_bzrdir: A BzrDir that contains a branch.
1654
:param name: Name of colocated branch to open
1655
:param _found: a private parameter, do not use it. It is used to
1656
indicate if format probing has already be done.
1657
:param ignore_fallbacks: when set, no fallback branches will be opened
1658
(if there are any). Default is to open fallbacks.
736
_found is a private parameter, do not use it. It is used to indicate
737
if format probing has already be done.
1660
739
raise NotImplementedError(self.open)
1663
742
def register_format(klass, format):
1664
"""Register a metadir format."""
1665
743
klass._formats[format.get_format_string()] = format
1666
# Metadir formats have a network name of their format string, and get
1667
# registered as class factories.
1668
network_format_registry.register(format.get_format_string(), format.__class__)
1671
746
def set_default_format(klass, format):
1672
747
klass._default_format = format
1674
def supports_set_append_revisions_only(self):
1675
"""True if this format supports set_append_revisions_only."""
1678
def supports_stacking(self):
1679
"""True if this format records a stacked-on branch."""
1683
750
def unregister_format(klass, format):
751
assert klass._formats[format.get_format_string()] is format
1684
752
del klass._formats[format.get_format_string()]
1686
754
def __str__(self):
1687
return self.get_format_description().rstrip()
755
return self.get_format_string().rstrip()
1689
757
def supports_tags(self):
1690
758
"""True if this format supports tags stored in the branch"""
1691
759
return False # by default
1694
class BranchHooks(Hooks):
761
# XXX: Probably doesn't really belong here -- mbp 20070212
762
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
764
branch_transport = a_bzrdir.get_branch_transport(self)
765
control_files = lockable_files.LockableFiles(branch_transport,
766
lock_filename, lock_class)
767
control_files.create_lock()
768
control_files.lock_write()
770
for filename, content in utf8_files:
771
control_files.put_utf8(filename, content)
773
control_files.unlock()
776
class BranchHooks(dict):
1695
777
"""A dictionary mapping hook name to a list of callables for branch hooks.
1697
779
e.g. ['set_rh'] Is the list of items to be called when the
1698
780
set_revision_history function is invoked.
1704
786
These are all empty initially, because by default nothing should get
1707
Hooks.__init__(self)
1708
self.create_hook(HookPoint('set_rh',
1709
"Invoked whenever the revision history has been set via "
1710
"set_revision_history. The api signature is (branch, "
1711
"revision_history), and the branch will be write-locked. "
1712
"The set_rh hook can be expensive for bzr to trigger, a better "
1713
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1714
self.create_hook(HookPoint('open',
1715
"Called with the Branch object that has been opened after a "
1716
"branch is opened.", (1, 8), None))
1717
self.create_hook(HookPoint('post_push',
1718
"Called after a push operation completes. post_push is called "
1719
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
"bzr client.", (0, 15), None))
1721
self.create_hook(HookPoint('post_pull',
1722
"Called after a pull operation completes. post_pull is called "
1723
"with a bzrlib.branch.PullResult object and only runs in the "
1724
"bzr client.", (0, 15), None))
1725
self.create_hook(HookPoint('pre_commit',
1726
"Called after a commit is calculated but before it is is "
1727
"completed. pre_commit is called with (local, master, old_revno, "
1728
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
"). old_revid is NULL_REVISION for the first commit to a branch, "
1730
"tree_delta is a TreeDelta object describing changes from the "
1731
"basis revision. hooks MUST NOT modify this delta. "
1732
" future_tree is an in-memory tree obtained from "
1733
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
"tree.", (0,91), None))
1735
self.create_hook(HookPoint('post_commit',
1736
"Called in the bzr client after a commit has completed. "
1737
"post_commit is called with (local, master, old_revno, old_revid, "
1738
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1739
"commit to a branch.", (0, 15), None))
1740
self.create_hook(HookPoint('post_uncommit',
1741
"Called in the bzr client after an uncommit completes. "
1742
"post_uncommit is called with (local, master, old_revno, "
1743
"old_revid, new_revno, new_revid) where local is the local branch "
1744
"or None, master is the target branch, and an empty branch "
1745
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1746
self.create_hook(HookPoint('pre_change_branch_tip',
1747
"Called in bzr client and server before a change to the tip of a "
1748
"branch is made. pre_change_branch_tip is called with a "
1749
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1750
"commit, uncommit will all trigger this hook.", (1, 6), None))
1751
self.create_hook(HookPoint('post_change_branch_tip',
1752
"Called in bzr client and server after a change to the tip of a "
1753
"branch is made. post_change_branch_tip is called with a "
1754
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1755
"commit, uncommit will all trigger this hook.", (1, 4), None))
1756
self.create_hook(HookPoint('transform_fallback_location',
1757
"Called when a stacked branch is activating its fallback "
1758
"locations. transform_fallback_location is called with (branch, "
1759
"url), and should return a new url. Returning the same url "
1760
"allows it to be used as-is, returning a different one can be "
1761
"used to cause the branch to stack on a closer copy of that "
1762
"fallback_location. Note that the branch cannot have history "
1763
"accessing methods called on it during this hook because the "
1764
"fallback locations have not been activated. When there are "
1765
"multiple hooks installed for transform_fallback_location, "
1766
"all are called with the url returned from the previous hook."
1767
"The order is however undefined.", (1, 9), None))
1768
self.create_hook(HookPoint('automatic_tag_name',
1769
"Called to determine an automatic tag name for a revision."
1770
"automatic_tag_name is called with (branch, revision_id) and "
1771
"should return a tag name or None if no tag name could be "
1772
"determined. The first non-None tag name returned will be used.",
1774
self.create_hook(HookPoint('post_branch_init',
1775
"Called after new branch initialization completes. "
1776
"post_branch_init is called with a "
1777
"bzrlib.branch.BranchInitHookParams. "
1778
"Note that init, branch and checkout (both heavyweight and "
1779
"lightweight) will all trigger this hook.", (2, 2), None))
1780
self.create_hook(HookPoint('post_switch',
1781
"Called after a checkout switches branch. "
1782
"post_switch is called with a "
1783
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
790
# Introduced in 0.15:
791
# invoked whenever the revision history has been set
792
# with set_revision_history. The api signature is
793
# (branch, revision_history), and the branch will
796
# invoked after a push operation completes.
797
# the api signature is
798
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
799
# where local is the local branch or None, master is the target
800
# master branch, and the rest should be self explanatory. The source
801
# is read locked and the target branches write locked. Source will
802
# be the local low-latency branch.
803
self['post_push'] = []
804
# invoked after a pull operation completes.
805
# the api signature is
806
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
807
# where local is the local branch or None, master is the target
808
# master branch, and the rest should be self explanatory. The source
809
# is read locked and the target branches write locked. The local
810
# branch is the low-latency branch.
811
self['post_pull'] = []
812
# invoked after a commit operation completes.
813
# the api signature is
814
# (local, master, old_revno, old_revid, new_revno, new_revid)
815
# old_revid is NULL_REVISION for the first commit to a branch.
816
self['post_commit'] = []
817
# invoked after a uncommit operation completes.
818
# the api signature is
819
# (local, master, old_revno, old_revid, new_revno, new_revid) where
820
# local is the local branch or None, master is the target branch,
821
# and an empty branch recieves new_revno of 0, new_revid of None.
822
self['post_uncommit'] = []
824
def install_hook(self, hook_name, a_callable):
825
"""Install a_callable in to the hook hook_name.
827
:param hook_name: A hook name. See the __init__ method of BranchHooks
828
for the complete list of hooks.
829
:param a_callable: The callable to be invoked when the hook triggers.
830
The exact signature will depend on the hook - see the __init__
831
method of BranchHooks for details on each hook.
834
self[hook_name].append(a_callable)
836
raise errors.UnknownHook('branch', hook_name)
1787
839
# install the default hooks into the Branch class.
1788
840
Branch.hooks = BranchHooks()
1791
class ChangeBranchTipParams(object):
1792
"""Object holding parameters passed to *_change_branch_tip hooks.
1794
There are 5 fields that hooks may wish to access:
1796
:ivar branch: the branch being changed
1797
:ivar old_revno: revision number before the change
1798
:ivar new_revno: revision number after the change
1799
:ivar old_revid: revision id before the change
1800
:ivar new_revid: revision id after the change
1802
The revid fields are strings. The revno fields are integers.
1805
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1806
"""Create a group of ChangeBranchTip parameters.
1808
:param branch: The branch being changed.
1809
:param old_revno: Revision number before the change.
1810
:param new_revno: Revision number after the change.
1811
:param old_revid: Tip revision id before the change.
1812
:param new_revid: Tip revision id after the change.
1814
self.branch = branch
1815
self.old_revno = old_revno
1816
self.new_revno = new_revno
1817
self.old_revid = old_revid
1818
self.new_revid = new_revid
1820
def __eq__(self, other):
1821
return self.__dict__ == other.__dict__
1824
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1825
self.__class__.__name__, self.branch,
1826
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1829
class BranchInitHookParams(object):
1830
"""Object holding parameters passed to *_branch_init hooks.
1832
There are 4 fields that hooks may wish to access:
1834
:ivar format: the branch format
1835
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1836
:ivar name: name of colocated branch, if any (or None)
1837
:ivar branch: the branch created
1839
Note that for lightweight checkouts, the bzrdir and format fields refer to
1840
the checkout, hence they are different from the corresponding fields in
1841
branch, which refer to the original branch.
1844
def __init__(self, format, a_bzrdir, name, branch):
1845
"""Create a group of BranchInitHook parameters.
1847
:param format: the branch format
1848
:param a_bzrdir: the BzrDir where the branch will be/has been
1850
:param name: name of colocated branch, if any (or None)
1851
:param branch: the branch created
1853
Note that for lightweight checkouts, the bzrdir and format fields refer
1854
to the checkout, hence they are different from the corresponding fields
1855
in branch, which refer to the original branch.
1857
self.format = format
1858
self.bzrdir = a_bzrdir
1860
self.branch = branch
1862
def __eq__(self, other):
1863
return self.__dict__ == other.__dict__
1867
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1869
return "<%s of format:%s bzrdir:%s>" % (
1870
self.__class__.__name__, self.branch,
1871
self.format, self.bzrdir)
1874
class SwitchHookParams(object):
1875
"""Object holding parameters passed to *_switch hooks.
1877
There are 4 fields that hooks may wish to access:
1879
:ivar control_dir: BzrDir of the checkout to change
1880
:ivar to_branch: branch that the checkout is to reference
1881
:ivar force: skip the check for local commits in a heavy checkout
1882
:ivar revision_id: revision ID to switch to (or None)
1885
def __init__(self, control_dir, to_branch, force, revision_id):
1886
"""Create a group of SwitchHook parameters.
1888
:param control_dir: BzrDir of the checkout to change
1889
:param to_branch: branch that the checkout is to reference
1890
:param force: skip the check for local commits in a heavy checkout
1891
:param revision_id: revision ID to switch to (or None)
1893
self.control_dir = control_dir
1894
self.to_branch = to_branch
1896
self.revision_id = revision_id
1898
def __eq__(self, other):
1899
return self.__dict__ == other.__dict__
1902
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1903
self.control_dir, self.to_branch,
1907
843
class BzrBranchFormat4(BranchFormat):
1908
844
"""Bzr branch format 4.
2013
903
def get_format_description(self):
2014
904
"""See BranchFormat.get_format_description()."""
2015
905
return "Branch format 5"
2017
def initialize(self, a_bzrdir, name=None):
907
def initialize(self, a_bzrdir):
2018
908
"""Create a branch of this format in a_bzrdir."""
909
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
910
branch_transport = a_bzrdir.get_branch_transport(self)
2019
911
utf8_files = [('revision-history', ''),
2020
912
('branch-name', ''),
2022
return self._initialize_helper(a_bzrdir, utf8_files, name)
2024
def supports_tags(self):
2028
class BzrBranchFormat6(BranchFormatMetadir):
2029
"""Branch format with last-revision and tags.
2031
Unlike previous formats, this has no explicit revision history. Instead,
2032
this just stores the last-revision, and the left-hand history leading
2033
up to there is the history.
2035
This format was introduced in bzr 0.15
2036
and became the default in 0.91.
2039
def _branch_class(self):
2042
def get_format_string(self):
2043
"""See BranchFormat.get_format_string()."""
2044
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2046
def get_format_description(self):
2047
"""See BranchFormat.get_format_description()."""
2048
return "Branch format 6"
2050
def initialize(self, a_bzrdir, name=None):
2051
"""Create a branch of this format in a_bzrdir."""
2052
utf8_files = [('last-revision', '0 null:\n'),
2053
('branch.conf', ''),
2056
return self._initialize_helper(a_bzrdir, utf8_files, name)
2058
def make_tags(self, branch):
2059
"""See bzrlib.branch.BranchFormat.make_tags()."""
2060
return BasicTags(branch)
2062
def supports_set_append_revisions_only(self):
2066
class BzrBranchFormat8(BranchFormatMetadir):
2067
"""Metadir format supporting storing locations of subtree branches."""
2069
def _branch_class(self):
2072
def get_format_string(self):
2073
"""See BranchFormat.get_format_string()."""
2074
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2076
def get_format_description(self):
2077
"""See BranchFormat.get_format_description()."""
2078
return "Branch format 8"
2080
def initialize(self, a_bzrdir, name=None):
2081
"""Create a branch of this format in a_bzrdir."""
2082
utf8_files = [('last-revision', '0 null:\n'),
2083
('branch.conf', ''),
2087
return self._initialize_helper(a_bzrdir, utf8_files, name)
914
control_files = lockable_files.LockableFiles(branch_transport, 'lock',
916
control_files.create_lock()
917
control_files.lock_write()
918
control_files.put_utf8('format', self.get_format_string())
920
for file, content in utf8_files:
921
control_files.put_utf8(file, content)
923
control_files.unlock()
924
return self.open(a_bzrdir, _found=True, )
2089
926
def __init__(self):
2090
super(BzrBranchFormat8, self).__init__()
2091
self._matchingbzrdir.repository_format = \
2092
RepositoryFormatKnitPack5RichRoot()
2094
def make_tags(self, branch):
2095
"""See bzrlib.branch.BranchFormat.make_tags()."""
2096
return BasicTags(branch)
2098
def supports_set_append_revisions_only(self):
2101
def supports_stacking(self):
2104
supports_reference_locations = True
2107
class BzrBranchFormat7(BzrBranchFormat8):
2108
"""Branch format with last-revision, tags, and a stacked location pointer.
2110
The stacked location pointer is passed down to the repository and requires
2111
a repository format with supports_external_lookups = True.
2113
This format was introduced in bzr 1.6.
2116
def initialize(self, a_bzrdir, name=None):
2117
"""Create a branch of this format in a_bzrdir."""
2118
utf8_files = [('last-revision', '0 null:\n'),
2119
('branch.conf', ''),
2122
return self._initialize_helper(a_bzrdir, utf8_files, name)
2124
def _branch_class(self):
2127
def get_format_string(self):
2128
"""See BranchFormat.get_format_string()."""
2129
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2131
def get_format_description(self):
2132
"""See BranchFormat.get_format_description()."""
2133
return "Branch format 7"
2135
def supports_set_append_revisions_only(self):
2138
supports_reference_locations = False
927
super(BzrBranchFormat5, self).__init__()
928
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
930
def open(self, a_bzrdir, _found=False):
931
"""Return the branch object for a_bzrdir
933
_found is a private parameter, do not use it. It is used to indicate
934
if format probing has already be done.
937
format = BranchFormat.find_format(a_bzrdir)
938
assert format.__class__ == self.__class__
939
transport = a_bzrdir.get_branch_transport(None)
940
control_files = lockable_files.LockableFiles(transport, 'lock',
942
return BzrBranch5(_format=self,
943
_control_files=control_files,
945
_repository=a_bzrdir.find_repository())
2141
948
class BranchReferenceFormat(BranchFormat):
2156
963
def get_format_description(self):
2157
964
"""See BranchFormat.get_format_description()."""
2158
965
return "Checkout reference format 1"
2160
def get_reference(self, a_bzrdir):
2161
"""See BranchFormat.get_reference()."""
2162
transport = a_bzrdir.get_branch_transport(None)
2163
return transport.get_bytes('location')
2165
def set_reference(self, a_bzrdir, to_branch):
2166
"""See BranchFormat.set_reference()."""
2167
transport = a_bzrdir.get_branch_transport(None)
2168
location = transport.put_bytes('location', to_branch.base)
2170
def initialize(self, a_bzrdir, name=None, target_branch=None):
967
def initialize(self, a_bzrdir, target_branch=None):
2171
968
"""Create a branch of this format in a_bzrdir."""
2172
969
if target_branch is None:
2173
970
# this format does not implement branch itself, thus the implicit
2174
971
# creation contract must see it as uninitializable
2175
972
raise errors.UninitializableFormat(self)
2176
mutter('creating branch reference in %s', a_bzrdir.user_url)
2177
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
973
mutter('creating branch reference in %s', a_bzrdir.transport.base)
974
branch_transport = a_bzrdir.get_branch_transport(self)
2178
975
branch_transport.put_bytes('location',
2179
target_branch.bzrdir.user_url)
976
target_branch.bzrdir.root_transport.base)
2180
977
branch_transport.put_bytes('format', self.get_format_string())
2182
a_bzrdir, name, _found=True,
2183
possible_transports=[target_branch.bzrdir.root_transport])
2184
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
978
return self.open(a_bzrdir, _found=True)
2187
980
def __init__(self):
2188
981
super(BranchReferenceFormat, self).__init__()
2189
982
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2190
self._matchingbzrdir.set_branch_format(self)
2192
984
def _make_reference_clone_function(format, a_branch):
2193
985
"""Create a clone() routine for a branch dynamically."""
2194
def clone(to_bzrdir, revision_id=None,
2195
repository_policy=None):
986
def clone(to_bzrdir, revision_id=None):
2196
987
"""See Branch.clone()."""
2197
return format.initialize(to_bzrdir, target_branch=a_branch)
988
return format.initialize(to_bzrdir, a_branch)
2198
989
# cannot obey revision_id limits when cloning a reference ...
2199
990
# FIXME RBC 20060210 either nuke revision_id for clone, or
2200
991
# emit some sort of warning/error to the caller ?!
2203
def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
possible_transports=None, ignore_fallbacks=False):
994
def open(self, a_bzrdir, _found=False):
2205
995
"""Return the branch that the branch reference in a_bzrdir points at.
2207
:param a_bzrdir: A BzrDir that contains a branch.
2208
:param name: Name of colocated branch to open, if any
2209
:param _found: a private parameter, do not use it. It is used to
2210
indicate if format probing has already be done.
2211
:param ignore_fallbacks: when set, no fallback branches will be opened
2212
(if there are any). Default is to open fallbacks.
2213
:param location: The location of the referenced branch. If
2214
unspecified, this will be determined from the branch reference in
2216
:param possible_transports: An optional reusable transports list.
997
_found is a private parameter, do not use it. It is used to indicate
998
if format probing has already be done.
2219
format = BranchFormat.find_format(a_bzrdir, name=name)
2220
if format.__class__ != self.__class__:
2221
raise AssertionError("wrong format %r found for %r" %
2223
if location is None:
2224
location = self.get_reference(a_bzrdir)
2225
real_bzrdir = bzrdir.BzrDir.open(
2226
location, possible_transports=possible_transports)
2227
result = real_bzrdir.open_branch(name=name,
2228
ignore_fallbacks=ignore_fallbacks)
1001
format = BranchFormat.find_format(a_bzrdir)
1002
assert format.__class__ == self.__class__
1003
transport = a_bzrdir.get_branch_transport(None)
1004
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1005
result = real_bzrdir.open_branch()
2229
1006
# this changes the behaviour of result.clone to create a new reference
2230
1007
# rather than a copy of the content of the branch.
2231
1008
# I did not use a proxy object because that needs much more extensive
2241
network_format_registry = registry.FormatRegistry()
2242
"""Registry of formats indexed by their network name.
2244
The network name for a branch format is an identifier that can be used when
2245
referring to formats with smart server operations. See
2246
BranchFormat.network_name() for more detail.
2250
1018
# formats which have no format string are not discoverable
2251
1019
# and not independently creatable, so are not registered.
2252
__format5 = BzrBranchFormat5()
2253
__format6 = BzrBranchFormat6()
2254
__format7 = BzrBranchFormat7()
2255
__format8 = BzrBranchFormat8()
2256
BranchFormat.register_format(__format5)
1020
__default_format = BzrBranchFormat5()
1021
BranchFormat.register_format(__default_format)
2257
1022
BranchFormat.register_format(BranchReferenceFormat())
2258
BranchFormat.register_format(__format6)
2259
BranchFormat.register_format(__format7)
2260
BranchFormat.register_format(__format8)
2261
BranchFormat.set_default_format(__format7)
1023
BranchFormat.set_default_format(__default_format)
2262
1024
_legacy_formats = [BzrBranchFormat4(),
2264
network_format_registry.register(
2265
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2268
class BzrBranch(Branch, _RelockDebugMixin):
1027
class BzrBranch(Branch):
2269
1028
"""A branch stored in the actual filesystem.
2271
1030
Note that it's "local" in the context of the filesystem; it doesn't
2272
1031
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2273
1032
it's writable, and can be accessed via the normal filesystem API.
2275
:ivar _transport: Transport for file operations on this branch's
2276
control files, typically pointing to the .bzr/branch directory.
2277
:ivar repository: Repository for this branch.
2278
:ivar base: The url of the base directory for this branch; the one
2279
containing the .bzr directory.
2280
:ivar name: Optional colocated branch name as it exists in the control
2284
def __init__(self, _format=None,
2285
_control_files=None, a_bzrdir=None, name=None,
2286
_repository=None, ignore_fallbacks=False):
2287
"""Create new branch object at a particular location."""
1035
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1036
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1037
_control_files=None, a_bzrdir=None, _repository=None):
1038
"""Create new branch object at a particular location.
1040
transport -- A Transport object, defining how to access files.
1042
init -- If True, create new control files in a previously
1043
unversioned directory. If False, the branch must already
1046
relax_version_check -- If true, the usual check for the branch
1047
version is not applied. This is intended only for
1048
upgrade/recovery type use; it's not guaranteed that
1049
all operations will work on old format branches.
1051
Branch.__init__(self)
2288
1052
if a_bzrdir is None:
2289
raise ValueError('a_bzrdir must be supplied')
1053
self.bzrdir = bzrdir.BzrDir.open(transport.base)
2291
1055
self.bzrdir = a_bzrdir
1056
# self._transport used to point to the directory containing the
1057
# control directory, but was not used - now it's just the transport
1058
# for the branch control files. mbp 20070212
2292
1059
self._base = self.bzrdir.transport.clone('..').base
2294
# XXX: We should be able to just do
2295
# self.base = self.bzrdir.root_transport.base
2296
# but this does not quite work yet -- mbp 20080522
2297
1060
self._format = _format
2298
1061
if _control_files is None:
2299
1062
raise ValueError('BzrBranch _control_files is None')
2300
1063
self.control_files = _control_files
2301
1064
self._transport = _control_files._transport
1065
if deprecated_passed(init):
1066
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1067
"deprecated as of bzr 0.8. Please use Branch.create().",
1071
# this is slower than before deprecation, oh well never mind.
1072
# -> its deprecated.
1073
self._initialize(transport.base)
1074
self._check_format(_format)
1075
if deprecated_passed(relax_version_check):
1076
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1077
"relax_version_check parameter is deprecated as of bzr 0.8. "
1078
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1082
if (not relax_version_check
1083
and not self._format.is_supported()):
1084
raise errors.UnsupportedFormatError(format=fmt)
1085
if deprecated_passed(transport):
1086
warn("BzrBranch.__init__(transport=XXX...): The transport "
1087
"parameter is deprecated as of bzr 0.8. "
1088
"Please use Branch.open, or bzrdir.open_branch().",
2302
1091
self.repository = _repository
2303
Branch.__init__(self)
2305
1093
def __str__(self):
2306
if self.name is None:
2307
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2309
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
1094
return '%s(%r)' % (self.__class__.__name__, self.base)
2312
1096
__repr__ = __str__
2387
1190
"""See Branch.print_file."""
2388
1191
return self.repository.print_file(file, revision_id)
2390
def _write_revision_history(self, history):
2391
"""Factored out of set_revision_history.
2393
This performs the actual writing to disk.
2394
It is intended to be called by BzrBranch5.set_revision_history."""
2395
self._transport.put_bytes(
2396
'revision-history', '\n'.join(history),
2397
mode=self.bzrdir._get_file_mode())
1194
def append_revision(self, *revision_ids):
1195
"""See Branch.append_revision."""
1196
for revision_id in revision_ids:
1197
_mod_revision.check_not_reserved_id(revision_id)
1198
mutter("add {%s} to revision-history" % revision_id)
1199
rev_history = self.revision_history()
1200
rev_history.extend(revision_ids)
1201
self.set_revision_history(rev_history)
2399
1203
@needs_write_lock
2400
1204
def set_revision_history(self, rev_history):
2401
1205
"""See Branch.set_revision_history."""
2402
if 'evil' in debug.debug_flags:
2403
mutter_callsite(3, "set_revision_history scales with history.")
2404
check_not_reserved_id = _mod_revision.check_not_reserved_id
2405
for rev_id in rev_history:
2406
check_not_reserved_id(rev_id)
2407
if Branch.hooks['post_change_branch_tip']:
2408
# Don't calculate the last_revision_info() if there are no hooks
2410
old_revno, old_revid = self.last_revision_info()
2411
if len(rev_history) == 0:
2412
revid = _mod_revision.NULL_REVISION
1206
self.control_files.put_utf8(
1207
'revision-history', '\n'.join(rev_history))
1208
transaction = self.get_transaction()
1209
history = transaction.map.find_revision_history()
1210
if history is not None:
1211
# update the revision history in the identity map.
1212
history[:] = list(rev_history)
1213
# this call is disabled because revision_history is
1214
# not really an object yet, and the transaction is for objects.
1215
# transaction.register_dirty(history)
2414
revid = rev_history[-1]
2415
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2416
self._write_revision_history(rev_history)
2417
self._clear_cached_state()
2418
self._cache_revision_history(rev_history)
1217
transaction.map.add_revision_history(rev_history)
1218
# this call is disabled because revision_history is
1219
# not really an object yet, and the transaction is for objects.
1220
# transaction.register_clean(history)
2419
1221
for hook in Branch.hooks['set_rh']:
2420
1222
hook(self, rev_history)
2421
if Branch.hooks['post_change_branch_tip']:
2422
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2424
def _synchronize_history(self, destination, revision_id):
2425
"""Synchronize last revision and revision history between branches.
2427
This version is most efficient when the destination is also a
2428
BzrBranch5, but works for BzrBranch6 as long as the revision
2429
history is the true lefthand parent history, and all of the revisions
2430
are in the destination's repository. If not, set_revision_history
2433
:param destination: The branch to copy the history into
2434
:param revision_id: The revision-id to truncate history at. May
2435
be None to copy complete history.
2437
if not isinstance(destination._format, BzrBranchFormat5):
2438
super(BzrBranch, self)._synchronize_history(
2439
destination, revision_id)
2441
if revision_id == _mod_revision.NULL_REVISION:
2444
new_history = self.revision_history()
2445
if revision_id is not None and new_history != []:
2447
new_history = new_history[:new_history.index(revision_id) + 1]
2449
rev = self.repository.get_revision(revision_id)
2450
new_history = rev.get_history(self.repository)[1:]
2451
destination.set_revision_history(new_history)
2454
def set_last_revision_info(self, revno, revision_id):
2455
"""Set the last revision of this branch.
2457
The caller is responsible for checking that the revno is correct
2458
for this revision id.
2460
It may be possible to set the branch last revision to an id not
2461
present in the repository. However, branches can also be
2462
configured to check constraints on history, in which case this may not
2465
revision_id = _mod_revision.ensure_null(revision_id)
2466
# this old format stores the full history, but this api doesn't
2467
# provide it, so we must generate, and might as well check it's
2469
history = self._lefthand_history(revision_id)
2470
if len(history) != revno:
2471
raise AssertionError('%d != %d' % (len(history), revno))
2472
self.set_revision_history(history)
2474
def _gen_revision_history(self):
2475
history = self._transport.get_bytes('revision-history').split('\n')
2476
if history[-1:] == ['']:
2477
# There shouldn't be a trailing newline, but just in case.
2482
def generate_revision_history(self, revision_id, last_rev=None,
1225
def revision_history(self):
1226
"""See Branch.revision_history."""
1227
transaction = self.get_transaction()
1228
history = transaction.map.find_revision_history()
1229
if history is not None:
1230
# mutter("cache hit for revision-history in %s", self)
1231
return list(history)
1232
decode_utf8 = cache_utf8.decode
1233
history = [decode_utf8(l.rstrip('\r\n')) for l in
1234
self.control_files.get('revision-history').readlines()]
1235
transaction.map.add_revision_history(history)
1236
# this call is disabled because revision_history is
1237
# not really an object yet, and the transaction is for objects.
1238
# transaction.register_clean(history, precious=True)
1239
return list(history)
1242
def generate_revision_history(self, revision_id, last_rev=None,
2483
1243
other_branch=None):
2484
1244
"""Create a new revision history that will finish with revision_id.
2486
1246
:param revision_id: the new tip to use.
2487
1247
:param last_rev: The previous last_revision. If not None, then this
2488
1248
must be a ancestory of revision_id, or DivergedBranches is raised.
2489
1249
:param other_branch: The other branch that DivergedBranches should
2490
1250
raise with respect to.
2492
self.set_revision_history(self._lefthand_history(revision_id,
2493
last_rev, other_branch))
1252
# stop_revision must be a descendant of last_revision
1253
stop_graph = self.repository.get_revision_graph(revision_id)
1254
if last_rev is not None and last_rev not in stop_graph:
1255
# our previous tip is not merged into stop_revision
1256
raise errors.DivergedBranches(self, other_branch)
1257
# make a new revision history from the graph
1258
current_rev_id = revision_id
1260
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1261
new_history.append(current_rev_id)
1262
current_rev_id_parents = stop_graph[current_rev_id]
1264
current_rev_id = current_rev_id_parents[0]
1266
current_rev_id = None
1267
new_history.reverse()
1268
self.set_revision_history(new_history)
1271
def update_revisions(self, other, stop_revision=None):
1272
"""See Branch.update_revisions."""
1275
if stop_revision is None:
1276
stop_revision = other.last_revision()
1277
if stop_revision is None:
1278
# if there are no commits, we're done.
1280
# whats the current last revision, before we fetch [and change it
1282
last_rev = self.last_revision()
1283
# we fetch here regardless of whether we need to so that we pickup
1285
self.fetch(other, stop_revision)
1286
my_ancestry = self.repository.get_ancestry(last_rev)
1287
if stop_revision in my_ancestry:
1288
# last_revision is a descendant of stop_revision
1290
self.generate_revision_history(stop_revision, last_rev=last_rev,
2495
1295
def basis_tree(self):
2496
1296
"""See Branch.basis_tree."""
2497
1297
return self.repository.revision_tree(self.last_revision())
2499
def _get_parent_location(self):
1299
@deprecated_method(zero_eight)
1300
def working_tree(self):
1301
"""Create a Working tree object for this branch."""
1303
from bzrlib.transport.local import LocalTransport
1304
if (self.base.find('://') != -1 or
1305
not isinstance(self._transport, LocalTransport)):
1306
raise NoWorkingTree(self.base)
1307
return self.bzrdir.open_workingtree()
1310
def pull(self, source, overwrite=False, stop_revision=None,
1311
_hook_master=None, _run_hooks=True):
1314
:param _hook_master: Private parameter - set the branch to
1315
be supplied as the master to push hooks.
1316
:param _run_hooks: Private parameter - allow disabling of
1317
hooks, used when pushing to a master branch.
1321
old_count, old_tip = self.last_revision_info()
1323
self.update_revisions(source, stop_revision)
1324
except DivergedBranches:
1328
self.set_revision_history(source.revision_history())
1329
new_count, new_tip = self.last_revision_info()
1336
for hook in Branch.hooks['post_pull']:
1337
hook(source, _hook_local, _hook_master, old_count, old_tip,
1339
return new_count - old_count
1344
def push(self, target, overwrite=False, stop_revision=None,
1345
_hook_master=None, _run_hooks=True):
1348
:param _hook_master: Private parameter - set the branch to
1349
be supplied as the master to push hooks.
1350
:param _run_hooks: Private parameter - allow disabling of
1351
hooks, used when pushing to a master branch.
1355
old_count, old_tip = target.last_revision_info()
1357
target.update_revisions(self, stop_revision)
1358
except DivergedBranches:
1362
target.set_revision_history(self.revision_history())
1363
new_count, new_tip = target.last_revision_info()
1366
_hook_local = target
1368
_hook_master = target
1370
for hook in Branch.hooks['post_push']:
1371
hook(self, _hook_local, _hook_master, old_count, old_tip,
1373
return new_count - old_count
1377
def get_parent(self):
1378
"""See Branch.get_parent."""
2500
1380
_locs = ['parent', 'pull', 'x-pull']
1381
assert self.base[-1] == '/'
2501
1382
for l in _locs:
2503
return self._transport.get_bytes(l).strip('\n')
2504
except errors.NoSuchFile:
1384
parent = self.control_files.get(l).read().strip('\n')
1387
# This is an old-format absolute path to a local branch
1388
# turn it into a url
1389
if parent.startswith('/'):
1390
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1392
return urlutils.join(self.base[:-1], parent)
1393
except errors.InvalidURLJoin, e:
1394
raise errors.InaccessibleParent(parent, self.base)
2508
def _basic_push(self, target, overwrite, stop_revision):
2509
"""Basic implementation of push without bound branches or hooks.
2511
Must be called with source read locked and target write locked.
2513
result = BranchPushResult()
2514
result.source_branch = self
2515
result.target_branch = target
2516
result.old_revno, result.old_revid = target.last_revision_info()
2517
self.update_references(target)
2518
if result.old_revid != self.last_revision():
2519
# We assume that during 'push' this repository is closer than
2521
graph = self.repository.get_graph(target.repository)
2522
target.update_revisions(self, stop_revision,
2523
overwrite=overwrite, graph=graph)
2524
if self._push_should_merge_tags():
2525
result.tag_conflicts = self.tags.merge_to(target.tags,
2527
result.new_revno, result.new_revid = target.last_revision_info()
2530
def get_stacked_on_url(self):
2531
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1397
def get_push_location(self):
1398
"""See Branch.get_push_location."""
1399
push_loc = self.get_config().get_user_option('push_location')
2533
1402
def set_push_location(self, location):
2534
1403
"""See Branch.set_push_location."""
2536
1405
'push_location', location,
2537
1406
store=_mod_config.STORE_LOCATION_NORECURSE)
2539
def _set_parent_location(self, url):
1409
def set_parent(self, url):
1410
"""See Branch.set_parent."""
1411
# TODO: Maybe delete old location files?
1412
# URLs should never be unicode, even on the local fs,
1413
# FIXUP this and get_parent in a future branch format bump:
1414
# read and rewrite the file, and have the new format code read
1415
# using .get not .get_utf8. RBC 20060125
2540
1416
if url is None:
2541
self._transport.delete('parent')
1417
self.control_files._transport.delete('parent')
2543
self._transport.put_bytes('parent', url + '\n',
2544
mode=self.bzrdir._get_file_mode())
1419
if isinstance(url, unicode):
1421
url = url.encode('ascii')
1422
except UnicodeEncodeError:
1423
raise bzrlib.errors.InvalidURL(url,
1424
"Urls must be 7-bit ascii, "
1425
"use bzrlib.urlutils.escape")
1427
url = urlutils.relative_url(self.base, url)
1428
self.control_files.put('parent', StringIO(url + '\n'))
1430
@deprecated_function(zero_nine)
1431
def tree_config(self):
1432
"""DEPRECATED; call get_config instead.
1433
TreeConfig has become part of BranchConfig."""
1434
return TreeConfig(self)
2547
1437
class BzrBranch5(BzrBranch):
2548
"""A format 5 branch. This supports new features over plain branches.
1438
"""A format 5 branch. This supports new features over plan branches.
2550
1440
It has support for a master_branch which is the data for bound branches.
1448
super(BzrBranch5, self).__init__(_format=_format,
1449
_control_files=_control_files,
1451
_repository=_repository)
1454
def pull(self, source, overwrite=False, stop_revision=None,
1456
"""Extends branch.pull to be bound branch aware.
1458
:param _run_hooks: Private parameter used to force hook running
1459
off during bound branch double-pushing.
1461
bound_location = self.get_bound_location()
1462
master_branch = None
1463
if bound_location and source.base != bound_location:
1464
# not pulling from master, so we need to update master.
1465
master_branch = self.get_master_branch()
1466
master_branch.lock_write()
1469
# pull from source into master.
1470
master_branch.pull(source, overwrite, stop_revision,
1472
return super(BzrBranch5, self).pull(source, overwrite,
1473
stop_revision, _hook_master=master_branch,
1474
_run_hooks=_run_hooks)
1477
master_branch.unlock()
1480
def push(self, target, overwrite=False, stop_revision=None):
1481
"""Updates branch.push to be bound branch aware."""
1482
bound_location = target.get_bound_location()
1483
master_branch = None
1484
if bound_location and target.base != bound_location:
1485
# not pushing to master, so we need to update master.
1486
master_branch = target.get_master_branch()
1487
master_branch.lock_write()
1490
# push into the master from this branch.
1491
super(BzrBranch5, self).push(master_branch, overwrite,
1492
stop_revision, _run_hooks=False)
1493
# and push into the target branch from this. Note that we push from
1494
# this branch again, because its considered the highest bandwidth
1496
return super(BzrBranch5, self).push(target, overwrite,
1497
stop_revision, _hook_master=master_branch)
1500
master_branch.unlock()
2553
1502
def get_bound_location(self):
2555
return self._transport.get_bytes('bound')[:-1]
1504
return self.control_files.get_utf8('bound').read()[:-1]
2556
1505
except errors.NoSuchFile:
2559
1508
@needs_read_lock
2560
def get_master_branch(self, possible_transports=None):
1509
def get_master_branch(self):
2561
1510
"""Return the branch we are bound to.
2563
1512
:return: Either a Branch, or None
2565
1514
This could memoise the branch, but if thats done
2625
1588
return self.set_bound_location(None)
2627
1590
@needs_write_lock
2628
def update(self, possible_transports=None):
2629
"""Synchronise this branch with the master branch if any.
1592
"""Synchronise this branch with the master branch if any.
2631
1594
:return: None or the last_revision that was pivoted out during the
2634
master = self.get_master_branch(possible_transports)
1597
master = self.get_master_branch()
2635
1598
if master is not None:
2636
old_tip = _mod_revision.ensure_null(self.last_revision())
1599
old_tip = self.last_revision()
2637
1600
self.pull(master, overwrite=True)
2638
if self.repository.get_graph().is_ancestor(old_tip,
2639
_mod_revision.ensure_null(self.last_revision())):
1601
if old_tip in self.repository.get_ancestry(self.last_revision()):
2645
class BzrBranch8(BzrBranch5):
2646
"""A branch that stores tree-reference locations."""
2648
def _open_hook(self):
2649
if self._ignore_fallbacks:
2652
url = self.get_stacked_on_url()
2653
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2654
errors.UnstackableBranchFormat):
2657
for hook in Branch.hooks['transform_fallback_location']:
2658
url = hook(self, url)
2660
hook_name = Branch.hooks.get_hook_name(hook)
2661
raise AssertionError(
2662
"'transform_fallback_location' hook %s returned "
2663
"None, not a URL." % hook_name)
2664
self._activate_fallback_location(url)
2666
def __init__(self, *args, **kwargs):
2667
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2668
super(BzrBranch8, self).__init__(*args, **kwargs)
2669
self._last_revision_info_cache = None
2670
self._reference_info = None
2672
def _clear_cached_state(self):
2673
super(BzrBranch8, self)._clear_cached_state()
2674
self._last_revision_info_cache = None
2675
self._reference_info = None
2677
def _last_revision_info(self):
2678
revision_string = self._transport.get_bytes('last-revision')
2679
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2680
revision_id = cache_utf8.get_cached_utf8(revision_id)
2682
return revno, revision_id
2684
def _write_last_revision_info(self, revno, revision_id):
2685
"""Simply write out the revision id, with no checks.
2687
Use set_last_revision_info to perform this safely.
2689
Does not update the revision_history cache.
2690
Intended to be called by set_last_revision_info and
2691
_write_revision_history.
2693
revision_id = _mod_revision.ensure_null(revision_id)
2694
out_string = '%d %s\n' % (revno, revision_id)
2695
self._transport.put_bytes('last-revision', out_string,
2696
mode=self.bzrdir._get_file_mode())
2699
def set_last_revision_info(self, revno, revision_id):
2700
revision_id = _mod_revision.ensure_null(revision_id)
2701
old_revno, old_revid = self.last_revision_info()
2702
if self._get_append_revisions_only():
2703
self._check_history_violation(revision_id)
2704
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2705
self._write_last_revision_info(revno, revision_id)
2706
self._clear_cached_state()
2707
self._last_revision_info_cache = revno, revision_id
2708
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2710
def _synchronize_history(self, destination, revision_id):
2711
"""Synchronize last revision and revision history between branches.
2713
:see: Branch._synchronize_history
2715
# XXX: The base Branch has a fast implementation of this method based
2716
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2717
# that uses set_revision_history. This class inherits from BzrBranch5,
2718
# but wants the fast implementation, so it calls
2719
# Branch._synchronize_history directly.
2720
Branch._synchronize_history(self, destination, revision_id)
2722
def _check_history_violation(self, revision_id):
2723
last_revision = _mod_revision.ensure_null(self.last_revision())
2724
if _mod_revision.is_null(last_revision):
2726
if last_revision not in self._lefthand_history(revision_id):
2727
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2729
def _gen_revision_history(self):
2730
"""Generate the revision history from last revision
2732
last_revno, last_revision = self.last_revision_info()
2733
self._extend_partial_history(stop_index=last_revno-1)
2734
return list(reversed(self._partial_revision_history_cache))
2736
def _write_revision_history(self, history):
2737
"""Factored out of set_revision_history.
2739
This performs the actual writing to disk, with format-specific checks.
2740
It is intended to be called by BzrBranch5.set_revision_history.
2742
if len(history) == 0:
2743
last_revision = 'null:'
2745
if history != self._lefthand_history(history[-1]):
2746
raise errors.NotLefthandHistory(history)
2747
last_revision = history[-1]
2748
if self._get_append_revisions_only():
2749
self._check_history_violation(last_revision)
2750
self._write_last_revision_info(len(history), last_revision)
2753
def _set_parent_location(self, url):
2754
"""Set the parent branch"""
2755
self._set_config_location('parent_location', url, make_relative=True)
2758
def _get_parent_location(self):
2759
"""Set the parent branch"""
2760
return self._get_config_location('parent_location')
2763
def _set_all_reference_info(self, info_dict):
2764
"""Replace all reference info stored in a branch.
2766
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2769
writer = rio.RioWriter(s)
2770
for key, (tree_path, branch_location) in info_dict.iteritems():
2771
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2772
branch_location=branch_location)
2773
writer.write_stanza(stanza)
2774
self._transport.put_bytes('references', s.getvalue())
2775
self._reference_info = info_dict
2778
def _get_all_reference_info(self):
2779
"""Return all the reference info stored in a branch.
2781
:return: A dict of {file_id: (tree_path, branch_location)}
2783
if self._reference_info is not None:
2784
return self._reference_info
2785
rio_file = self._transport.get('references')
2787
stanzas = rio.read_stanzas(rio_file)
2788
info_dict = dict((s['file_id'], (s['tree_path'],
2789
s['branch_location'])) for s in stanzas)
1607
class BzrBranchExperimental(BzrBranch5):
1608
"""Bzr experimental branch format
1611
- a revision-history file.
1613
- a lock dir guarding the branch itself
1614
- all of this stored in a branch/ subdirectory
1615
- works with shared repositories.
1616
- a tag dictionary in the branch
1618
This format is new in bzr 0.15, but shouldn't be used for real data,
1621
This class acts as it's own BranchFormat.
1624
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1627
def get_format_string(cls):
1628
"""See BranchFormat.get_format_string()."""
1629
return "Bazaar-NG branch format experimental\n"
1632
def get_format_description(cls):
1633
"""See BranchFormat.get_format_description()."""
1634
return "Experimental branch format"
1637
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1639
branch_transport = a_bzrdir.get_branch_transport(cls)
1640
control_files = lockable_files.LockableFiles(branch_transport,
1641
lock_filename, lock_class)
1642
control_files.create_lock()
1643
control_files.lock_write()
1645
for filename, content in utf8_files:
1646
control_files.put_utf8(filename, content)
2792
self._reference_info = info_dict
2795
def set_reference_info(self, file_id, tree_path, branch_location):
2796
"""Set the branch location to use for a tree reference.
2798
:param file_id: The file-id of the tree reference.
2799
:param tree_path: The path of the tree reference in the tree.
2800
:param branch_location: The location of the branch to retrieve tree
2803
info_dict = self._get_all_reference_info()
2804
info_dict[file_id] = (tree_path, branch_location)
2805
if None in (tree_path, branch_location):
2806
if tree_path is not None:
2807
raise ValueError('tree_path must be None when branch_location'
2809
if branch_location is not None:
2810
raise ValueError('branch_location must be None when tree_path'
2812
del info_dict[file_id]
2813
self._set_all_reference_info(info_dict)
2815
def get_reference_info(self, file_id):
2816
"""Get the tree_path and branch_location for a tree reference.
2818
:return: a tuple of (tree_path, branch_location)
2820
return self._get_all_reference_info().get(file_id, (None, None))
2822
def reference_parent(self, file_id, path, possible_transports=None):
2823
"""Return the parent branch for a tree-reference file_id.
2825
:param file_id: The file_id of the tree reference
2826
:param path: The path of the file_id in the tree
2827
:return: A branch associated with the file_id
2829
branch_location = self.get_reference_info(file_id)[1]
2830
if branch_location is None:
2831
return Branch.reference_parent(self, file_id, path,
2832
possible_transports)
2833
branch_location = urlutils.join(self.user_url, branch_location)
2834
return Branch.open(branch_location,
2835
possible_transports=possible_transports)
2837
def set_push_location(self, location):
2838
"""See Branch.set_push_location."""
2839
self._set_config_location('push_location', location)
2841
def set_bound_location(self, location):
2842
"""See Branch.set_push_location."""
2844
config = self.get_config()
2845
if location is None:
2846
if config.get_user_option('bound') != 'True':
2849
config.set_user_option('bound', 'False', warn_masked=True)
2852
self._set_config_location('bound_location', location,
2854
config.set_user_option('bound', 'True', warn_masked=True)
2857
def _get_bound_location(self, bound):
2858
"""Return the bound location in the config file.
2860
Return None if the bound parameter does not match"""
2861
config = self.get_config()
2862
config_bound = (config.get_user_option('bound') == 'True')
2863
if config_bound != bound:
2865
return self._get_config_location('bound_location', config=config)
2867
def get_bound_location(self):
2868
"""See Branch.set_push_location."""
2869
return self._get_bound_location(True)
2871
def get_old_bound_location(self):
2872
"""See Branch.get_old_bound_location"""
2873
return self._get_bound_location(False)
2875
def get_stacked_on_url(self):
2876
# you can always ask for the URL; but you might not be able to use it
2877
# if the repo can't support stacking.
2878
## self._check_stackable_repo()
2879
stacked_url = self._get_config_location('stacked_on_location')
2880
if stacked_url is None:
2881
raise errors.NotStacked(self)
2884
def _get_append_revisions_only(self):
2885
return self.get_config(
2886
).get_user_option_as_bool('append_revisions_only')
2889
def generate_revision_history(self, revision_id, last_rev=None,
2891
"""See BzrBranch5.generate_revision_history"""
2892
history = self._lefthand_history(revision_id, last_rev, other_branch)
2893
revno = len(history)
2894
self.set_last_revision_info(revno, revision_id)
2897
def get_rev_id(self, revno, history=None):
2898
"""Find the revision id of the specified revno."""
2900
return _mod_revision.NULL_REVISION
2902
last_revno, last_revision_id = self.last_revision_info()
2903
if revno <= 0 or revno > last_revno:
2904
raise errors.NoSuchRevision(self, revno)
2906
if history is not None:
2907
return history[revno - 1]
2909
index = last_revno - revno
2910
if len(self._partial_revision_history_cache) <= index:
2911
self._extend_partial_history(stop_index=index)
2912
if len(self._partial_revision_history_cache) > index:
2913
return self._partial_revision_history_cache[index]
2915
raise errors.NoSuchRevision(self, revno)
2918
def revision_id_to_revno(self, revision_id):
2919
"""Given a revision id, return its revno"""
2920
if _mod_revision.is_null(revision_id):
2923
index = self._partial_revision_history_cache.index(revision_id)
2925
self._extend_partial_history(stop_revision=revision_id)
2926
index = len(self._partial_revision_history_cache) - 1
2927
if self._partial_revision_history_cache[index] != revision_id:
2928
raise errors.NoSuchRevision(self, revision_id)
2929
return self.revno() - index
2932
class BzrBranch7(BzrBranch8):
2933
"""A branch with support for a fallback repository."""
2935
def set_reference_info(self, file_id, tree_path, branch_location):
2936
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2938
def get_reference_info(self, file_id):
2939
Branch.get_reference_info(self, file_id)
2941
def reference_parent(self, file_id, path, possible_transports=None):
2942
return Branch.reference_parent(self, file_id, path,
2943
possible_transports)
2946
class BzrBranch6(BzrBranch7):
2947
"""See BzrBranchFormat6 for the capabilities of this branch.
2949
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2953
def get_stacked_on_url(self):
2954
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2957
######################################################################
2958
# results of operations
2961
class _Result(object):
2963
def _show_tag_conficts(self, to_file):
2964
if not getattr(self, 'tag_conflicts', None):
2966
to_file.write('Conflicting tags:\n')
2967
for name, value1, value2 in self.tag_conflicts:
2968
to_file.write(' %s\n' % (name, ))
2971
class PullResult(_Result):
2972
"""Result of a Branch.pull operation.
2974
:ivar old_revno: Revision number before pull.
2975
:ivar new_revno: Revision number after pull.
2976
:ivar old_revid: Tip revision id before pull.
2977
:ivar new_revid: Tip revision id after pull.
2978
:ivar source_branch: Source (local) branch object. (read locked)
2979
:ivar master_branch: Master branch of the target, or the target if no
2981
:ivar local_branch: target branch if there is a Master, else None
2982
:ivar target_branch: Target/destination branch object. (write locked)
2983
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2987
# DEPRECATED: pull used to return the change in revno
2988
return self.new_revno - self.old_revno
2990
def report(self, to_file):
2992
if self.old_revid == self.new_revid:
2993
to_file.write('No revisions to pull.\n')
2995
to_file.write('Now on revision %d.\n' % self.new_revno)
2996
self._show_tag_conficts(to_file)
2999
class BranchPushResult(_Result):
3000
"""Result of a Branch.push operation.
3002
:ivar old_revno: Revision number (eg 10) of the target before push.
3003
:ivar new_revno: Revision number (eg 12) of the target after push.
3004
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3006
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3008
:ivar source_branch: Source branch object that the push was from. This is
3009
read locked, and generally is a local (and thus low latency) branch.
3010
:ivar master_branch: If target is a bound branch, the master branch of
3011
target, or target itself. Always write locked.
3012
:ivar target_branch: The direct Branch where data is being sent (write
3014
:ivar local_branch: If the target is a bound branch this will be the
3015
target, otherwise it will be None.
3019
# DEPRECATED: push used to return the change in revno
3020
return self.new_revno - self.old_revno
3022
def report(self, to_file):
3023
"""Write a human-readable description of the result."""
3024
if self.old_revid == self.new_revid:
3025
note('No new revisions to push.')
3027
note('Pushed up to revision %d.' % self.new_revno)
3028
self._show_tag_conficts(to_file)
1648
control_files.unlock()
1651
def initialize(cls, a_bzrdir):
1652
"""Create a branch of this format in a_bzrdir."""
1653
utf8_files = [('format', cls.get_format_string()),
1654
('revision-history', ''),
1655
('branch-name', ''),
1658
cls._initialize_control_files(a_bzrdir, utf8_files,
1659
'lock', lockdir.LockDir)
1660
return cls.open(a_bzrdir, _found=True)
1663
def open(cls, a_bzrdir, _found=False):
1664
"""Return the branch object for a_bzrdir
1666
_found is a private parameter, do not use it. It is used to indicate
1667
if format probing has already be done.
1670
format = BranchFormat.find_format(a_bzrdir)
1671
assert format.__class__ == cls
1672
transport = a_bzrdir.get_branch_transport(None)
1673
control_files = lockable_files.LockableFiles(transport, 'lock',
1675
return cls(_format=cls,
1676
_control_files=control_files,
1678
_repository=a_bzrdir.find_repository())
1681
def is_supported(cls):
1684
def _make_tags(self):
1685
return BasicTags(self)
1688
def supports_tags(cls):
1692
BranchFormat.register_format(BzrBranchExperimental)
1695
class BranchTestProviderAdapter(object):
1696
"""A tool to generate a suite testing multiple branch formats at once.
1698
This is done by copying the test once for each transport and injecting
1699
the transport_server, transport_readonly_server, and branch_format
1700
classes into each copy. Each copy is also given a new id() to make it
1704
def __init__(self, transport_server, transport_readonly_server, formats):
1705
self._transport_server = transport_server
1706
self._transport_readonly_server = transport_readonly_server
1707
self._formats = formats
1709
def adapt(self, test):
1710
result = TestSuite()
1711
for branch_format, bzrdir_format in self._formats:
1712
new_test = deepcopy(test)
1713
new_test.transport_server = self._transport_server
1714
new_test.transport_readonly_server = self._transport_readonly_server
1715
new_test.bzrdir_format = bzrdir_format
1716
new_test.branch_format = branch_format
1717
def make_new_test_id():
1718
# the format can be either a class or an instance
1719
name = getattr(branch_format, '__name__',
1720
branch_format.__class__.__name__)
1721
new_id = "%s(%s)" % (new_test.id(), name)
1722
return lambda: new_id
1723
new_test.id = make_new_test_id()
1724
result.addTest(new_test)
3031
1728
class BranchCheckResult(object):
3037
1734
def __init__(self, branch):
3038
1735
self.branch = branch
3041
1737
def report_results(self, verbose):
3042
1738
"""Report the check results via trace.note.
3044
1740
:param verbose: Requests more detailed display of what was checked,
3047
note('checked branch %s format %s', self.branch.user_url,
3048
self.branch._format)
3049
for error in self.errors:
3050
note('found error:%s', error)
3053
class Converter5to6(object):
3054
"""Perform an in-place upgrade of format 5 to format 6"""
3056
def convert(self, branch):
3057
# Data for 5 and 6 can peacefully coexist.
3058
format = BzrBranchFormat6()
3059
new_branch = format.open(branch.bzrdir, _found=True)
3061
# Copy source data into target
3062
new_branch._write_last_revision_info(*branch.last_revision_info())
3063
new_branch.set_parent(branch.get_parent())
3064
new_branch.set_bound_location(branch.get_bound_location())
3065
new_branch.set_push_location(branch.get_push_location())
3067
# New branch has no tags by default
3068
new_branch.tags._set_tag_dict({})
3070
# Copying done; now update target format
3071
new_branch._transport.put_bytes('format',
3072
format.get_format_string(),
3073
mode=new_branch.bzrdir._get_file_mode())
3075
# Clean up old files
3076
new_branch._transport.delete('revision-history')
3078
branch.set_parent(None)
3079
except errors.NoSuchFile:
3081
branch.set_bound_location(None)
3084
class Converter6to7(object):
3085
"""Perform an in-place upgrade of format 6 to format 7"""
3087
def convert(self, branch):
3088
format = BzrBranchFormat7()
3089
branch._set_config_location('stacked_on_location', '')
3090
# update target format
3091
branch._transport.put_bytes('format', format.get_format_string())
3094
class Converter7to8(object):
3095
"""Perform an in-place upgrade of format 6 to format 7"""
3097
def convert(self, branch):
3098
format = BzrBranchFormat8()
3099
branch._transport.put_bytes('references', '')
3100
# update target format
3101
branch._transport.put_bytes('format', format.get_format_string())
3104
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3105
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3108
_run_with_write_locked_target will attempt to release the lock it acquires.
3110
If an exception is raised by callable, then that exception *will* be
3111
propagated, even if the unlock attempt raises its own error. Thus
3112
_run_with_write_locked_target should be preferred to simply doing::
3116
return callable(*args, **kwargs)
3121
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3122
# should share code?
3125
result = callable(*args, **kwargs)
3127
exc_info = sys.exc_info()
3131
raise exc_info[0], exc_info[1], exc_info[2]
3137
class InterBranch(InterObject):
3138
"""This class represents operations taking place between two branches.
3140
Its instances have methods like pull() and push() and contain
3141
references to the source and target repositories these operations
3142
can be carried out on.
3146
"""The available optimised InterBranch types."""
3149
def _get_branch_formats_to_test():
3150
"""Return a tuple with the Branch formats to use when testing."""
3151
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3153
def pull(self, overwrite=False, stop_revision=None,
3154
possible_transports=None, local=False):
3155
"""Mirror source into target branch.
3157
The target branch is considered to be 'local', having low latency.
3159
:returns: PullResult instance
3161
raise NotImplementedError(self.pull)
3163
def update_revisions(self, stop_revision=None, overwrite=False,
3165
"""Pull in new perfect-fit revisions.
3167
:param stop_revision: Updated until the given revision
3168
:param overwrite: Always set the branch pointer, rather than checking
3169
to see if it is a proper descendant.
3170
:param graph: A Graph object that can be used to query history
3171
information. This can be None.
3174
raise NotImplementedError(self.update_revisions)
3176
def push(self, overwrite=False, stop_revision=None,
3177
_override_hook_source_branch=None):
3178
"""Mirror the source branch into the target branch.
3180
The source branch is considered to be 'local', having low latency.
3182
raise NotImplementedError(self.push)
3185
class GenericInterBranch(InterBranch):
3186
"""InterBranch implementation that uses public Branch functions.
3190
def _get_branch_formats_to_test():
3191
return BranchFormat._default_format, BranchFormat._default_format
3193
def update_revisions(self, stop_revision=None, overwrite=False,
3195
"""See InterBranch.update_revisions()."""
3196
self.source.lock_read()
3198
other_revno, other_last_revision = self.source.last_revision_info()
3199
stop_revno = None # unknown
3200
if stop_revision is None:
3201
stop_revision = other_last_revision
3202
if _mod_revision.is_null(stop_revision):
3203
# if there are no commits, we're done.
3205
stop_revno = other_revno
3207
# what's the current last revision, before we fetch [and change it
3209
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3210
# we fetch here so that we don't process data twice in the common
3211
# case of having something to pull, and so that the check for
3212
# already merged can operate on the just fetched graph, which will
3213
# be cached in memory.
3214
self.target.fetch(self.source, stop_revision)
3215
# Check to see if one is an ancestor of the other
3218
graph = self.target.repository.get_graph()
3219
if self.target._check_if_descendant_or_diverged(
3220
stop_revision, last_rev, graph, self.source):
3221
# stop_revision is a descendant of last_rev, but we aren't
3222
# overwriting, so we're done.
3224
if stop_revno is None:
3226
graph = self.target.repository.get_graph()
3227
this_revno, this_last_revision = \
3228
self.target.last_revision_info()
3229
stop_revno = graph.find_distance_to_null(stop_revision,
3230
[(other_last_revision, other_revno),
3231
(this_last_revision, this_revno)])
3232
self.target.set_last_revision_info(stop_revno, stop_revision)
3234
self.source.unlock()
3236
def pull(self, overwrite=False, stop_revision=None,
3237
possible_transports=None, _hook_master=None, run_hooks=True,
3238
_override_hook_target=None, local=False):
3241
:param _hook_master: Private parameter - set the branch to
3242
be supplied as the master to pull hooks.
3243
:param run_hooks: Private parameter - if false, this branch
3244
is being called because it's the master of the primary branch,
3245
so it should not run its hooks.
3246
:param _override_hook_target: Private parameter - set the branch to be
3247
supplied as the target_branch to pull hooks.
3248
:param local: Only update the local branch, and not the bound branch.
3250
# This type of branch can't be bound.
3252
raise errors.LocalRequiresBoundBranch()
3253
result = PullResult()
3254
result.source_branch = self.source
3255
if _override_hook_target is None:
3256
result.target_branch = self.target
3258
result.target_branch = _override_hook_target
3259
self.source.lock_read()
3261
# We assume that during 'pull' the target repository is closer than
3263
self.source.update_references(self.target)
3264
graph = self.target.repository.get_graph(self.source.repository)
3265
# TODO: Branch formats should have a flag that indicates
3266
# that revno's are expensive, and pull() should honor that flag.
3268
result.old_revno, result.old_revid = \
3269
self.target.last_revision_info()
3270
self.target.update_revisions(self.source, stop_revision,
3271
overwrite=overwrite, graph=graph)
3272
# TODO: The old revid should be specified when merging tags,
3273
# so a tags implementation that versions tags can only
3274
# pull in the most recent changes. -- JRV20090506
3275
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3277
result.new_revno, result.new_revid = self.target.last_revision_info()
3279
result.master_branch = _hook_master
3280
result.local_branch = result.target_branch
3282
result.master_branch = result.target_branch
3283
result.local_branch = None
3285
for hook in Branch.hooks['post_pull']:
3288
self.source.unlock()
3291
def push(self, overwrite=False, stop_revision=None,
3292
_override_hook_source_branch=None):
3293
"""See InterBranch.push.
3295
This is the basic concrete implementation of push()
3297
:param _override_hook_source_branch: If specified, run
3298
the hooks passing this Branch as the source, rather than self.
3299
This is for use of RemoteBranch, where push is delegated to the
3300
underlying vfs-based Branch.
3302
# TODO: Public option to disable running hooks - should be trivial but
3304
self.source.lock_read()
3306
return _run_with_write_locked_target(
3307
self.target, self._push_with_bound_branches, overwrite,
3309
_override_hook_source_branch=_override_hook_source_branch)
3311
self.source.unlock()
3313
def _push_with_bound_branches(self, overwrite, stop_revision,
3314
_override_hook_source_branch=None):
3315
"""Push from source into target, and into target's master if any.
3318
if _override_hook_source_branch:
3319
result.source_branch = _override_hook_source_branch
3320
for hook in Branch.hooks['post_push']:
3323
bound_location = self.target.get_bound_location()
3324
if bound_location and self.target.base != bound_location:
3325
# there is a master branch.
3327
# XXX: Why the second check? Is it even supported for a branch to
3328
# be bound to itself? -- mbp 20070507
3329
master_branch = self.target.get_master_branch()
3330
master_branch.lock_write()
3332
# push into the master from the source branch.
3333
self.source._basic_push(master_branch, overwrite, stop_revision)
3334
# and push into the target branch from the source. Note that we
3335
# push from the source branch again, because its considered the
3336
# highest bandwidth repository.
3337
result = self.source._basic_push(self.target, overwrite,
3339
result.master_branch = master_branch
3340
result.local_branch = self.target
3344
master_branch.unlock()
3347
result = self.source._basic_push(self.target, overwrite,
3349
# TODO: Why set master_branch and local_branch if there's no
3350
# binding? Maybe cleaner to just leave them unset? -- mbp
3352
result.master_branch = self.target
3353
result.local_branch = None
3358
def is_compatible(self, source, target):
3359
# GenericBranch uses the public API, so always compatible
3363
class InterToBranch5(GenericInterBranch):
3366
def _get_branch_formats_to_test():
3367
return BranchFormat._default_format, BzrBranchFormat5()
3369
def pull(self, overwrite=False, stop_revision=None,
3370
possible_transports=None, run_hooks=True,
3371
_override_hook_target=None, local=False):
3372
"""Pull from source into self, updating my master if any.
3374
:param run_hooks: Private parameter - if false, this branch
3375
is being called because it's the master of the primary branch,
3376
so it should not run its hooks.
3378
bound_location = self.target.get_bound_location()
3379
if local and not bound_location:
3380
raise errors.LocalRequiresBoundBranch()
3381
master_branch = None
3382
if not local and bound_location and self.source.user_url != bound_location:
3383
# not pulling from master, so we need to update master.
3384
master_branch = self.target.get_master_branch(possible_transports)
3385
master_branch.lock_write()
3388
# pull from source into master.
3389
master_branch.pull(self.source, overwrite, stop_revision,
3391
return super(InterToBranch5, self).pull(overwrite,
3392
stop_revision, _hook_master=master_branch,
3393
run_hooks=run_hooks,
3394
_override_hook_target=_override_hook_target)
3397
master_branch.unlock()
3400
InterBranch.register_optimiser(GenericInterBranch)
3401
InterBranch.register_optimiser(InterToBranch5)
1743
note('checked branch %s format %s',
1745
self.branch._format)
1748
######################################################################
1752
@deprecated_function(zero_eight)
1753
def is_control_file(*args, **kwargs):
1754
"""See bzrlib.workingtree.is_control_file."""
1755
from bzrlib import workingtree
1756
return workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
