115
123
if master is not None:
116
124
master.break_lock()
119
@deprecated_method(zero_eight)
120
def open_downlevel(base):
121
"""Open a branch which may be of an old format."""
122
return Branch.open(base, _unsupported=True)
125
def open(base, _unsupported=False):
126
def _check_stackable_repo(self):
127
if not self.repository._format.supports_external_lookups:
128
raise errors.UnstackableRepositoryFormat(self.repository._format,
129
self.repository.base)
131
def _extend_partial_history(self, stop_index=None, stop_revision=None):
132
"""Extend the partial history to include a given index
134
If a stop_index is supplied, stop when that index has been reached.
135
If a stop_revision is supplied, stop when that revision is
136
encountered. Otherwise, stop when the beginning of history is
139
:param stop_index: The index which should be present. When it is
140
present, history extension will stop.
141
:param stop_revision: The revision id which should be present. When
142
it is encountered, history extension will stop.
144
if len(self._partial_revision_history_cache) == 0:
145
self._partial_revision_history_cache = [self.last_revision()]
146
repository._iter_for_revno(
147
self.repository, self._partial_revision_history_cache,
148
stop_index=stop_index, stop_revision=stop_revision)
149
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
150
self._partial_revision_history_cache.pop()
152
def _get_check_refs(self):
153
"""Get the references needed for check().
157
revid = self.last_revision()
158
return [('revision-existence', revid), ('lefthand-distance', revid)]
161
def open(base, _unsupported=False, possible_transports=None):
126
162
"""Open the branch rooted at base.
128
164
For instance, if the branch is at URL/.bzr/branch,
129
165
Branch.open(URL) -> a Branch instance.
131
control = bzrdir.BzrDir.open(base, _unsupported)
132
return control.open_branch(_unsupported)
135
def open_containing(url):
167
control = bzrdir.BzrDir.open(base, _unsupported,
168
possible_transports=possible_transports)
169
return control.open_branch(_unsupported)
172
def open_from_transport(transport, _unsupported=False):
173
"""Open the branch rooted at transport"""
174
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
175
return control.open_branch(_unsupported)
178
def open_containing(url, possible_transports=None):
136
179
"""Open an existing branch which contains url.
138
181
This probes for a branch at url, and searches upwards from there.
140
183
Basically we keep looking up until we find the control directory or
141
184
run into the root. If there isn't one, raises NotBranchError.
142
If there is one and it is either an unrecognised format or an unsupported
185
If there is one and it is either an unrecognised format or an unsupported
143
186
format, UnknownFormatError or UnsupportedFormatError are raised.
144
187
If there is one, it is returned, along with the unused portion of url.
146
control, relpath = bzrdir.BzrDir.open_containing(url)
189
control, relpath = bzrdir.BzrDir.open_containing(url,
147
191
return control.open_branch(), relpath
150
@deprecated_function(zero_eight)
151
def initialize(base):
152
"""Create a new working tree and branch, rooted at 'base' (url)
154
NOTE: This will soon be deprecated in favour of creation
157
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
159
@deprecated_function(zero_eight)
160
def setup_caching(self, cache_root):
161
"""Subclasses that care about caching should override this, and set
162
up cached stores located under cache_root.
164
NOTE: This is unused.
193
def _push_should_merge_tags(self):
194
"""Should _basic_push merge this branch's tags into the target?
196
The default implementation returns False if this branch has no tags,
197
and True the rest of the time. Subclasses may override this.
199
return self.supports_tags() and self.tags.get_tag_dict()
168
201
def get_config(self):
169
202
return BranchConfig(self)
172
return self.get_config().get_nickname()
204
def _get_config(self):
205
"""Get the concrete config for just the config in this branch.
207
This is not intended for client use; see Branch.get_config for the
212
:return: An object supporting get_option and set_option.
214
raise NotImplementedError(self._get_config)
216
def _get_fallback_repository(self, url):
217
"""Get the repository we fallback to at url."""
218
url = urlutils.join(self.base, url)
219
a_bzrdir = bzrdir.BzrDir.open(url,
220
possible_transports=[self.bzrdir.root_transport])
221
return a_bzrdir.open_branch().repository
223
def _get_tags_bytes(self):
224
"""Get the bytes of a serialised tags dict.
226
Note that not all branches support tags, nor do all use the same tags
227
logic: this method is specific to BasicTags. Other tag implementations
228
may use the same method name and behave differently, safely, because
229
of the double-dispatch via
230
format.make_tags->tags_instance->get_tags_dict.
232
:return: The bytes of the tags file.
233
:seealso: Branch._set_tags_bytes.
235
return self._transport.get_bytes('tags')
237
def _get_nick(self, local=False, possible_transports=None):
238
config = self.get_config()
239
# explicit overrides master, but don't look for master if local is True
240
if not local and not config.has_explicit_nickname():
242
master = self.get_master_branch(possible_transports)
243
if master is not None:
244
# return the master branch value
246
except errors.BzrError, e:
247
# Silently fall back to local implicit nick if the master is
249
mutter("Could not connect to bound branch, "
250
"falling back to local nick.\n " + str(e))
251
return config.get_nickname()
174
253
def _set_nick(self, nick):
175
254
self.get_config().set_user_option('nickname', nick, warn_masked=True)
196
302
raise NotImplementedError(self.get_physical_lock_status)
305
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
306
"""Return the revision_id for a dotted revno.
308
:param revno: a tuple like (1,) or (1,1,2)
309
:param _cache_reverse: a private parameter enabling storage
310
of the reverse mapping in a top level cache. (This should
311
only be done in selective circumstances as we want to
312
avoid having the mapping cached multiple times.)
313
:return: the revision_id
314
:raises errors.NoSuchRevision: if the revno doesn't exist
316
rev_id = self._do_dotted_revno_to_revision_id(revno)
318
self._partial_revision_id_to_revno_cache[rev_id] = revno
321
def _do_dotted_revno_to_revision_id(self, revno):
322
"""Worker function for dotted_revno_to_revision_id.
324
Subclasses should override this if they wish to
325
provide a more efficient implementation.
328
return self.get_rev_id(revno[0])
329
revision_id_to_revno = self.get_revision_id_to_revno_map()
330
revision_ids = [revision_id for revision_id, this_revno
331
in revision_id_to_revno.iteritems()
332
if revno == this_revno]
333
if len(revision_ids) == 1:
334
return revision_ids[0]
336
revno_str = '.'.join(map(str, revno))
337
raise errors.NoSuchRevision(self, revno_str)
340
def revision_id_to_dotted_revno(self, revision_id):
341
"""Given a revision id, return its dotted revno.
343
:return: a tuple like (1,) or (400,1,3).
345
return self._do_revision_id_to_dotted_revno(revision_id)
347
def _do_revision_id_to_dotted_revno(self, revision_id):
348
"""Worker function for revision_id_to_revno."""
349
# Try the caches if they are loaded
350
result = self._partial_revision_id_to_revno_cache.get(revision_id)
351
if result is not None:
353
if self._revision_id_to_revno_cache:
354
result = self._revision_id_to_revno_cache.get(revision_id)
356
raise errors.NoSuchRevision(self, revision_id)
357
# Try the mainline as it's optimised
359
revno = self.revision_id_to_revno(revision_id)
361
except errors.NoSuchRevision:
362
# We need to load and use the full revno map after all
363
result = self.get_revision_id_to_revno_map().get(revision_id)
365
raise errors.NoSuchRevision(self, revision_id)
199
369
def get_revision_id_to_revno_map(self):
200
370
"""Return the revision_id => dotted revno map.
226
396
:return: A dictionary mapping revision_id => dotted revno.
228
last_revision = self.last_revision()
229
revision_graph = self.repository.get_revision_graph(last_revision)
230
merge_sorted_revisions = tsort.merge_sort(
235
398
revision_id_to_revno = dict((rev_id, revno)
236
for seq_num, rev_id, depth, revno, end_of_merge
237
in merge_sorted_revisions)
399
for rev_id, depth, revno, end_of_merge
400
in self.iter_merge_sorted_revisions())
238
401
return revision_id_to_revno
404
def iter_merge_sorted_revisions(self, start_revision_id=None,
405
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
406
"""Walk the revisions for a branch in merge sorted order.
408
Merge sorted order is the output from a merge-aware,
409
topological sort, i.e. all parents come before their
410
children going forward; the opposite for reverse.
412
:param start_revision_id: the revision_id to begin walking from.
413
If None, the branch tip is used.
414
:param stop_revision_id: the revision_id to terminate the walk
415
after. If None, the rest of history is included.
416
:param stop_rule: if stop_revision_id is not None, the precise rule
417
to use for termination:
418
* 'exclude' - leave the stop revision out of the result (default)
419
* 'include' - the stop revision is the last item in the result
420
* 'with-merges' - include the stop revision and all of its
421
merged revisions in the result
422
:param direction: either 'reverse' or 'forward':
423
* reverse means return the start_revision_id first, i.e.
424
start at the most recent revision and go backwards in history
425
* forward returns tuples in the opposite order to reverse.
426
Note in particular that forward does *not* do any intelligent
427
ordering w.r.t. depth as some clients of this API may like.
428
(If required, that ought to be done at higher layers.)
430
:return: an iterator over (revision_id, depth, revno, end_of_merge)
433
* revision_id: the unique id of the revision
434
* depth: How many levels of merging deep this node has been
436
* revno_sequence: This field provides a sequence of
437
revision numbers for all revisions. The format is:
438
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
439
branch that the revno is on. From left to right the REVNO numbers
440
are the sequence numbers within that branch of the revision.
441
* end_of_merge: When True the next node (earlier in history) is
442
part of a different merge.
444
# Note: depth and revno values are in the context of the branch so
445
# we need the full graph to get stable numbers, regardless of the
447
if self._merge_sorted_revisions_cache is None:
448
last_revision = self.last_revision()
449
graph = self.repository.get_graph()
450
parent_map = dict(((key, value) for key, value in
451
graph.iter_ancestry([last_revision]) if value is not None))
452
revision_graph = repository._strip_NULL_ghosts(parent_map)
453
revs = tsort.merge_sort(revision_graph, last_revision, None,
455
# Drop the sequence # before caching
456
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
458
filtered = self._filter_merge_sorted_revisions(
459
self._merge_sorted_revisions_cache, start_revision_id,
460
stop_revision_id, stop_rule)
461
if direction == 'reverse':
463
if direction == 'forward':
464
return reversed(list(filtered))
466
raise ValueError('invalid direction %r' % direction)
468
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
469
start_revision_id, stop_revision_id, stop_rule):
470
"""Iterate over an inclusive range of sorted revisions."""
471
rev_iter = iter(merge_sorted_revisions)
472
if start_revision_id is not None:
473
for rev_id, depth, revno, end_of_merge in rev_iter:
474
if rev_id != start_revision_id:
477
# The decision to include the start or not
478
# depends on the stop_rule if a stop is provided
480
iter([(rev_id, depth, revno, end_of_merge)]),
483
if stop_revision_id is None:
484
for rev_id, depth, revno, end_of_merge in rev_iter:
485
yield rev_id, depth, revno, end_of_merge
486
elif stop_rule == 'exclude':
487
for rev_id, depth, revno, end_of_merge in rev_iter:
488
if rev_id == stop_revision_id:
490
yield rev_id, depth, revno, end_of_merge
491
elif stop_rule == 'include':
492
for rev_id, depth, revno, end_of_merge in rev_iter:
493
yield rev_id, depth, revno, end_of_merge
494
if rev_id == stop_revision_id:
496
elif stop_rule == 'with-merges':
497
stop_rev = self.repository.get_revision(stop_revision_id)
498
if stop_rev.parent_ids:
499
left_parent = stop_rev.parent_ids[0]
501
left_parent = _mod_revision.NULL_REVISION
502
for rev_id, depth, revno, end_of_merge in rev_iter:
503
if rev_id == left_parent:
505
yield rev_id, depth, revno, end_of_merge
507
raise ValueError('invalid stop_rule %r' % stop_rule)
240
509
def leave_lock_in_place(self):
241
510
"""Tell this branch object not to release the physical lock when this
242
511
object is unlocked.
244
513
If lock_write doesn't return a token, then this method is not supported.
246
515
self.control_files.leave_in_place()
350
621
The delta is relative to its mainline predecessor, or the
351
622
empty tree for revision 1.
353
assert isinstance(revno, int)
354
624
rh = self.revision_history()
355
625
if not (1 <= revno <= len(rh)):
356
raise InvalidRevisionNumber(revno)
626
raise errors.InvalidRevisionNumber(revno)
357
627
return self.repository.get_revision_delta(rh[revno-1])
359
@deprecated_method(zero_sixteen)
360
def get_root_id(self):
361
"""Return the id of this branches root
629
def get_stacked_on_url(self):
630
"""Get the URL this branch is stacked against.
363
Deprecated: branches don't have root ids-- trees do.
364
Use basis_tree().get_root_id() instead.
632
:raises NotStacked: If the branch is not stacked.
633
:raises UnstackableBranchFormat: If the branch does not support
366
raise NotImplementedError(self.get_root_id)
636
raise NotImplementedError(self.get_stacked_on_url)
368
638
def print_file(self, file, revision_id):
369
639
"""Print `file` to stdout."""
370
640
raise NotImplementedError(self.print_file)
372
def append_revision(self, *revision_ids):
373
raise NotImplementedError(self.append_revision)
375
642
def set_revision_history(self, rev_history):
376
643
raise NotImplementedError(self.set_revision_history)
646
def set_parent(self, url):
647
"""See Branch.set_parent."""
648
# TODO: Maybe delete old location files?
649
# URLs should never be unicode, even on the local fs,
650
# FIXUP this and get_parent in a future branch format bump:
651
# read and rewrite the file. RBC 20060125
653
if isinstance(url, unicode):
655
url = url.encode('ascii')
656
except UnicodeEncodeError:
657
raise errors.InvalidURL(url,
658
"Urls must be 7-bit ascii, "
659
"use bzrlib.urlutils.escape")
660
url = urlutils.relative_url(self.base, url)
661
self._set_parent_location(url)
664
def set_stacked_on_url(self, url):
665
"""Set the URL this branch is stacked against.
667
:raises UnstackableBranchFormat: If the branch does not support
669
:raises UnstackableRepositoryFormat: If the repository does not support
672
if not self._format.supports_stacking():
673
raise errors.UnstackableBranchFormat(self._format, self.base)
674
# XXX: Changing from one fallback repository to another does not check
675
# that all the data you need is present in the new fallback.
676
# Possibly it should.
677
self._check_stackable_repo()
680
old_url = self.get_stacked_on_url()
681
except (errors.NotStacked, errors.UnstackableBranchFormat,
682
errors.UnstackableRepositoryFormat):
686
self._activate_fallback_location(url)
687
# write this out after the repository is stacked to avoid setting a
688
# stacked config that doesn't work.
689
self._set_config_location('stacked_on_location', url)
692
"""Change a branch to be unstacked, copying data as needed.
694
Don't call this directly, use set_stacked_on_url(None).
696
pb = ui.ui_factory.nested_progress_bar()
698
pb.update("Unstacking")
699
# The basic approach here is to fetch the tip of the branch,
700
# including all available ghosts, from the existing stacked
701
# repository into a new repository object without the fallbacks.
703
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
704
# correct for CHKMap repostiories
705
old_repository = self.repository
706
if len(old_repository._fallback_repositories) != 1:
707
raise AssertionError("can't cope with fallback repositories "
708
"of %r" % (self.repository,))
709
# unlock it, including unlocking the fallback
710
old_repository.unlock()
711
old_repository.lock_read()
713
# Repositories don't offer an interface to remove fallback
714
# repositories today; take the conceptually simpler option and just
715
# reopen it. We reopen it starting from the URL so that we
716
# get a separate connection for RemoteRepositories and can
717
# stream from one of them to the other. This does mean doing
718
# separate SSH connection setup, but unstacking is not a
719
# common operation so it's tolerable.
720
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
721
new_repository = new_bzrdir.find_repository()
722
self.repository = new_repository
723
if self.repository._fallback_repositories:
724
raise AssertionError("didn't expect %r to have "
725
"fallback_repositories"
726
% (self.repository,))
727
# this is not paired with an unlock because it's just restoring
728
# the previous state; the lock's released when set_stacked_on_url
730
self.repository.lock_write()
731
# XXX: If you unstack a branch while it has a working tree
732
# with a pending merge, the pending-merged revisions will no
733
# longer be present. You can (probably) revert and remerge.
735
# XXX: This only fetches up to the tip of the repository; it
736
# doesn't bring across any tags. That's fairly consistent
737
# with how branch works, but perhaps not ideal.
738
self.repository.fetch(old_repository,
739
revision_id=self.last_revision(),
742
old_repository.unlock()
746
def _set_tags_bytes(self, bytes):
747
"""Mirror method for _get_tags_bytes.
749
:seealso: Branch._get_tags_bytes.
751
return _run_with_write_locked_target(self, self._transport.put_bytes,
378
754
def _cache_revision_history(self, rev_history):
379
755
"""Set the cached revision history to rev_history.
484
865
common_index = min(self_len, other_len) -1
485
866
if common_index >= 0 and \
486
867
self_history[common_index] != other_history[common_index]:
487
raise DivergedBranches(self, other)
868
raise errors.DivergedBranches(self, other)
489
870
if stop_revision is None:
490
871
stop_revision = other_len
492
assert isinstance(stop_revision, int)
493
873
if stop_revision > other_len:
494
874
raise errors.NoSuchRevision(self, stop_revision)
495
875
return other_history[self_len:stop_revision]
497
def update_revisions(self, other, stop_revision=None):
878
def update_revisions(self, other, stop_revision=None, overwrite=False,
498
880
"""Pull in new perfect-fit revisions.
500
882
:param other: Another Branch to pull from
501
883
:param stop_revision: Updated until the given revision
884
:param overwrite: Always set the branch pointer, rather than checking
885
to see if it is a proper descendant.
886
:param graph: A Graph object that can be used to query history
887
information. This can be None.
504
raise NotImplementedError(self.update_revisions)
890
return InterBranch.get(other, self).update_revisions(stop_revision,
893
def import_last_revision_info(self, source_repo, revno, revid):
894
"""Set the last revision info, importing from another repo if necessary.
896
This is used by the bound branch code to upload a revision to
897
the master branch first before updating the tip of the local branch.
899
:param source_repo: Source repository to optionally fetch from
900
:param revno: Revision number of the new tip
901
:param revid: Revision id of the new tip
903
if not self.repository.has_same_location(source_repo):
904
self.repository.fetch(source_repo, revision_id=revid)
905
self.set_last_revision_info(revno, revid)
506
907
def revision_id_to_revno(self, revision_id):
507
908
"""Given a revision id, return its revno"""
508
909
if _mod_revision.is_null(revision_id):
510
revision_id = osutils.safe_revision_id(revision_id)
511
911
history = self.revision_history()
513
913
return history.index(revision_id) + 1
514
914
except ValueError:
515
915
raise errors.NoSuchRevision(self, revision_id)
517
918
def get_rev_id(self, revno, history=None):
518
919
"""Find the revision id of the specified revno."""
522
history = self.revision_history()
523
if revno <= 0 or revno > len(history):
921
return _mod_revision.NULL_REVISION
922
last_revno, last_revid = self.last_revision_info()
923
if revno == last_revno:
925
if revno <= 0 or revno > last_revno:
524
926
raise errors.NoSuchRevision(self, revno)
525
return history[revno - 1]
927
distance_from_last = last_revno - revno
928
if len(self._partial_revision_history_cache) <= distance_from_last:
929
self._extend_partial_history(distance_from_last)
930
return self._partial_revision_history_cache[distance_from_last]
527
def pull(self, source, overwrite=False, stop_revision=None):
933
def pull(self, source, overwrite=False, stop_revision=None,
934
possible_transports=None, *args, **kwargs):
528
935
"""Mirror source into this branch.
530
937
This branch is considered to be 'local', having low latency.
532
939
:returns: PullResult instance
534
raise NotImplementedError(self.pull)
941
return InterBranch.get(source, self).pull(overwrite=overwrite,
942
stop_revision=stop_revision,
943
possible_transports=possible_transports, *args, **kwargs)
536
def push(self, target, overwrite=False, stop_revision=None):
945
def push(self, target, overwrite=False, stop_revision=None, *args,
537
947
"""Mirror this branch into target.
539
949
This branch is considered to be 'local', having low latency.
541
raise NotImplementedError(self.push)
951
return InterBranch.get(self, target).push(overwrite, stop_revision,
954
def lossy_push(self, target, stop_revision=None):
955
"""Push deltas into another branch.
957
:note: This does not, like push, retain the revision ids from
958
the source branch and will, rather than adding bzr-specific
959
metadata, push only those semantics of the revision that can be
960
natively represented by this branch' VCS.
962
:param target: Target branch
963
:param stop_revision: Revision to push, defaults to last revision.
964
:return: BranchPushResult with an extra member revidmap:
965
A dictionary mapping revision ids from the target branch
966
to new revision ids in the target branch, for each
967
revision that was pushed.
969
inter = InterBranch.get(self, target)
970
lossy_push = getattr(inter, "lossy_push", None)
971
if lossy_push is None:
972
raise errors.LossyPushToSameVCS(self, target)
973
return lossy_push(stop_revision)
543
975
def basis_tree(self):
544
976
"""Return `Tree` object for last revision."""
545
977
return self.repository.revision_tree(self.last_revision())
547
def rename_one(self, from_rel, to_rel):
550
This can change the directory or the filename or both.
552
raise NotImplementedError(self.rename_one)
554
def move(self, from_paths, to_name):
557
to_name must exist as a versioned directory.
559
If to_name exists and is a directory, the files are moved into
560
it, keeping their old names. If it is a directory,
562
Note that to_name is only the last component of the new name;
563
this doesn't change the directory.
565
This returns a list of (from_path, to_path) pairs for each
568
raise NotImplementedError(self.move)
570
979
def get_parent(self):
571
980
"""Return the parent location of the branch.
573
This is the default location for push/pull/missing. The usual
982
This is the default location for pull/missing. The usual
574
983
pattern is that the user can override it by specifying a
577
raise NotImplementedError(self.get_parent)
986
parent = self._get_parent_location()
989
# This is an old-format absolute path to a local branch
991
if parent.startswith('/'):
992
parent = urlutils.local_path_to_url(parent.decode('utf8'))
994
return urlutils.join(self.base[:-1], parent)
995
except errors.InvalidURLJoin, e:
996
raise errors.InaccessibleParent(parent, self.base)
998
def _get_parent_location(self):
999
raise NotImplementedError(self._get_parent_location)
579
1001
def _set_config_location(self, name, url, config=None,
580
1002
make_relative=False):
658
1111
self.check_real_revno(revno)
660
1113
def check_real_revno(self, revno):
662
1115
Check whether a revno corresponds to a real revision.
663
1116
Zero (the NULL revision) is considered invalid
665
1118
if revno < 1 or revno > self.revno():
666
raise InvalidRevisionNumber(revno)
1119
raise errors.InvalidRevisionNumber(revno)
668
1121
@needs_read_lock
669
def clone(self, to_bzrdir, revision_id=None):
1122
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
670
1123
"""Clone this branch into to_bzrdir preserving all semantic values.
1125
Most API users will want 'create_clone_on_transport', which creates a
1126
new bzrdir and branch on the fly.
672
1128
revision_id: if not None, the revision history in the new branch will
673
1129
be truncated to end with revision_id.
675
result = self._format.initialize(to_bzrdir)
676
self.copy_content_into(result, revision_id=revision_id)
1131
result = to_bzrdir.create_branch()
1134
if repository_policy is not None:
1135
repository_policy.configure_branch(result)
1136
self.copy_content_into(result, revision_id=revision_id)
679
1141
@needs_read_lock
680
def sprout(self, to_bzrdir, revision_id=None):
1142
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
681
1143
"""Create a new line of development from the branch, into to_bzrdir.
1145
to_bzrdir controls the branch format.
683
1147
revision_id: if not None, the revision history in the new branch will
684
1148
be truncated to end with revision_id.
686
result = self._format.initialize(to_bzrdir)
687
self.copy_content_into(result, revision_id=revision_id)
688
result.set_parent(self.bzrdir.root_transport.base)
1150
result = to_bzrdir.create_branch()
1153
if repository_policy is not None:
1154
repository_policy.configure_branch(result)
1155
self.copy_content_into(result, revision_id=revision_id)
1156
result.set_parent(self.bzrdir.root_transport.base)
691
1161
def _synchronize_history(self, destination, revision_id):
692
1162
"""Synchronize last revision and revision history between branches.
694
1164
This version is most efficient when the destination is also a
695
BzrBranch5, but works for BzrBranch6 as long as the revision
696
history is the true lefthand parent history, and all of the revisions
697
are in the destination's repository. If not, set_revision_history
1165
BzrBranch6, but works for BzrBranch5, as long as the destination's
1166
repository contains all the lefthand ancestors of the intended
1167
last_revision. If not, set_last_revision_info will fail.
700
1169
:param destination: The branch to copy the history into
701
1170
:param revision_id: The revision-id to truncate history at. May
702
1171
be None to copy complete history.
704
if revision_id == _mod_revision.NULL_REVISION:
706
new_history = self.revision_history()
707
if revision_id is not None and new_history != []:
708
revision_id = osutils.safe_revision_id(revision_id)
1173
source_revno, source_revision_id = self.last_revision_info()
1174
if revision_id is None:
1175
revno, revision_id = source_revno, source_revision_id
1177
graph = self.repository.get_graph()
710
new_history = new_history[:new_history.index(revision_id) + 1]
712
rev = self.repository.get_revision(revision_id)
713
new_history = rev.get_history(self.repository)[1:]
714
destination.set_revision_history(new_history)
1179
revno = graph.find_distance_to_null(revision_id,
1180
[(source_revision_id, source_revno)])
1181
except errors.GhostRevisionsHaveNoRevno:
1182
# Default to 1, if we can't find anything else
1184
destination.set_last_revision_info(revno, revision_id)
716
1186
@needs_read_lock
717
1187
def copy_content_into(self, destination, revision_id=None):
730
1201
destination.set_parent(parent)
731
self.tags.merge_to(destination.tags)
1202
if self._push_should_merge_tags():
1203
self.tags.merge_to(destination.tags)
1205
def update_references(self, target):
1206
if not getattr(self._format, 'supports_reference_locations', False):
1208
reference_dict = self._get_all_reference_info()
1209
if len(reference_dict) == 0:
1211
old_base = self.base
1212
new_base = target.base
1213
target_reference_dict = target._get_all_reference_info()
1214
for file_id, (tree_path, branch_location) in (
1215
reference_dict.items()):
1216
branch_location = urlutils.rebase_url(branch_location,
1218
target_reference_dict.setdefault(
1219
file_id, (tree_path, branch_location))
1220
target._set_all_reference_info(target_reference_dict)
733
1222
@needs_read_lock
1223
def check(self, refs):
735
1224
"""Check consistency of the branch.
737
1226
In particular this checks that revisions given in the revision-history
738
do actually match up in the revision graph, and that they're all
1227
do actually match up in the revision graph, and that they're all
739
1228
present in the repository.
741
1230
Callers will typically also want to check the repository.
1232
:param refs: Calculated refs for this branch as specified by
1233
branch._get_check_refs()
743
1234
:return: A BranchCheckResult.
745
mainline_parent_id = None
746
for revision_id in self.revision_history():
748
revision = self.repository.get_revision(revision_id)
749
except errors.NoSuchRevision, e:
750
raise errors.BzrCheckError("mainline revision {%s} not in repository"
752
# In general the first entry on the revision history has no parents.
753
# But it's not illegal for it to have parents listed; this can happen
754
# in imports from Arch when the parents weren't reachable.
755
if mainline_parent_id is not None:
756
if mainline_parent_id not in revision.parent_ids:
757
raise errors.BzrCheckError("previous revision {%s} not listed among "
759
% (mainline_parent_id, revision_id))
760
mainline_parent_id = revision_id
761
return BranchCheckResult(self)
1236
result = BranchCheckResult(self)
1237
last_revno, last_revision_id = self.last_revision_info()
1238
actual_revno = refs[('lefthand-distance', last_revision_id)]
1239
if actual_revno != last_revno:
1240
result.errors.append(errors.BzrCheckError(
1241
'revno does not match len(mainline) %s != %s' % (
1242
last_revno, actual_revno)))
1243
# TODO: We should probably also check that self.revision_history
1244
# matches the repository for older branch formats.
1245
# If looking for the code that cross-checks repository parents against
1246
# the iter_reverse_revision_history output, that is now a repository
763
1250
def _get_checkout_format(self):
764
1251
"""Return the most suitable metadir for a checkout of this branch.
811
1337
basis_tree.unlock()
814
def reference_parent(self, file_id, path):
1341
def reconcile(self, thorough=True):
1342
"""Make sure the data stored in this branch is consistent."""
1343
from bzrlib.reconcile import BranchReconciler
1344
reconciler = BranchReconciler(self, thorough=thorough)
1345
reconciler.reconcile()
1348
def reference_parent(self, file_id, path, possible_transports=None):
815
1349
"""Return the parent branch for a tree-reference file_id
816
1350
:param file_id: The file_id of the tree reference
817
1351
:param path: The path of the file_id in the tree
818
1352
:return: A branch associated with the file_id
820
1354
# FIXME should provide multiple branches, based on config
821
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1355
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1356
possible_transports=possible_transports)
823
1358
def supports_tags(self):
824
1359
return self._format.supports_tags()
1361
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1363
"""Ensure that revision_b is a descendant of revision_a.
1365
This is a helper function for update_revisions.
1367
:raises: DivergedBranches if revision_b has diverged from revision_a.
1368
:returns: True if revision_b is a descendant of revision_a.
1370
relation = self._revision_relations(revision_a, revision_b, graph)
1371
if relation == 'b_descends_from_a':
1373
elif relation == 'diverged':
1374
raise errors.DivergedBranches(self, other_branch)
1375
elif relation == 'a_descends_from_b':
1378
raise AssertionError("invalid relation: %r" % (relation,))
1380
def _revision_relations(self, revision_a, revision_b, graph):
1381
"""Determine the relationship between two revisions.
1383
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1385
heads = graph.heads([revision_a, revision_b])
1386
if heads == set([revision_b]):
1387
return 'b_descends_from_a'
1388
elif heads == set([revision_a, revision_b]):
1389
# These branches have diverged
1391
elif heads == set([revision_a]):
1392
return 'a_descends_from_b'
1394
raise AssertionError("invalid heads: %r" % (heads,))
827
1397
class BranchFormat(object):
828
1398
"""An encapsulation of the initialization and open routines for a format.
931
1526
"""Is this format supported?
933
1528
Supported formats can be initialized and opened.
934
Unsupported formats may not support initialization or committing or
1529
Unsupported formats may not support initialization or committing or
935
1530
some other features depending on the reason for not being supported.
939
def open(self, a_bzrdir, _found=False):
1534
def make_tags(self, branch):
1535
"""Create a tags object for branch.
1537
This method is on BranchFormat, because BranchFormats are reflected
1538
over the wire via network_name(), whereas full Branch instances require
1539
multiple VFS method calls to operate at all.
1541
The default implementation returns a disabled-tags instance.
1543
Note that it is normal for branch to be a RemoteBranch when using tags
1546
return DisabledTags(branch)
1548
def network_name(self):
1549
"""A simple byte string uniquely identifying this format for RPC calls.
1551
MetaDir branch formats use their disk format string to identify the
1552
repository over the wire. All in one formats such as bzr < 0.8, and
1553
foreign formats like svn/git and hg should use some marker which is
1554
unique and immutable.
1556
raise NotImplementedError(self.network_name)
1558
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
940
1559
"""Return the branch object for a_bzrdir
942
_found is a private parameter, do not use it. It is used to indicate
943
if format probing has already be done.
1561
:param a_bzrdir: A BzrDir that contains a branch.
1562
:param _found: a private parameter, do not use it. It is used to
1563
indicate if format probing has already be done.
1564
:param ignore_fallbacks: when set, no fallback branches will be opened
1565
(if there are any). Default is to open fallbacks.
945
1567
raise NotImplementedError(self.open)
948
1570
def register_format(klass, format):
1571
"""Register a metadir format."""
949
1572
klass._formats[format.get_format_string()] = format
1573
# Metadir formats have a network name of their format string, and get
1574
# registered as class factories.
1575
network_format_registry.register(format.get_format_string(), format.__class__)
952
1578
def set_default_format(klass, format):
953
1579
klass._default_format = format
1581
def supports_set_append_revisions_only(self):
1582
"""True if this format supports set_append_revisions_only."""
1585
def supports_stacking(self):
1586
"""True if this format records a stacked-on branch."""
956
1590
def unregister_format(klass, format):
957
assert klass._formats[format.get_format_string()] is format
958
1591
del klass._formats[format.get_format_string()]
960
1593
def __str__(self):
961
return self.get_format_string().rstrip()
1594
return self.get_format_description().rstrip()
963
1596
def supports_tags(self):
964
1597
"""True if this format supports tags stored in the branch"""
965
1598
return False # by default
967
# XXX: Probably doesn't really belong here -- mbp 20070212
968
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
970
branch_transport = a_bzrdir.get_branch_transport(self)
971
control_files = lockable_files.LockableFiles(branch_transport,
972
lock_filename, lock_class)
973
control_files.create_lock()
974
control_files.lock_write()
976
for filename, content in utf8_files:
977
control_files.put_utf8(filename, content)
979
control_files.unlock()
982
1601
class BranchHooks(Hooks):
983
1602
"""A dictionary mapping hook name to a list of callables for branch hooks.
985
1604
e.g. ['set_rh'] Is the list of items to be called when the
986
1605
set_revision_history function is invoked.
995
1614
Hooks.__init__(self)
996
# Introduced in 0.15:
997
# invoked whenever the revision history has been set
998
# with set_revision_history. The api signature is
999
# (branch, revision_history), and the branch will
1002
# invoked after a push operation completes.
1003
# the api signature is
1005
# containing the members
1006
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1007
# where local is the local target branch or None, master is the target
1008
# master branch, and the rest should be self explanatory. The source
1009
# is read locked and the target branches write locked. Source will
1010
# be the local low-latency branch.
1011
self['post_push'] = []
1012
# invoked after a pull operation completes.
1013
# the api signature is
1015
# containing the members
1016
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1017
# where local is the local branch or None, master is the target
1018
# master branch, and the rest should be self explanatory. The source
1019
# is read locked and the target branches write locked. The local
1020
# branch is the low-latency branch.
1021
self['post_pull'] = []
1022
# invoked after a commit operation completes.
1023
# the api signature is
1024
# (local, master, old_revno, old_revid, new_revno, new_revid)
1025
# old_revid is NULL_REVISION for the first commit to a branch.
1026
self['post_commit'] = []
1027
# invoked after a uncommit operation completes.
1028
# the api signature is
1029
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1030
# local is the local branch or None, master is the target branch,
1031
# and an empty branch recieves new_revno of 0, new_revid of None.
1032
self['post_uncommit'] = []
1615
self.create_hook(HookPoint('set_rh',
1616
"Invoked whenever the revision history has been set via "
1617
"set_revision_history. The api signature is (branch, "
1618
"revision_history), and the branch will be write-locked. "
1619
"The set_rh hook can be expensive for bzr to trigger, a better "
1620
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1621
self.create_hook(HookPoint('open',
1622
"Called with the Branch object that has been opened after a "
1623
"branch is opened.", (1, 8), None))
1624
self.create_hook(HookPoint('post_push',
1625
"Called after a push operation completes. post_push is called "
1626
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1627
"bzr client.", (0, 15), None))
1628
self.create_hook(HookPoint('post_pull',
1629
"Called after a pull operation completes. post_pull is called "
1630
"with a bzrlib.branch.PullResult object and only runs in the "
1631
"bzr client.", (0, 15), None))
1632
self.create_hook(HookPoint('pre_commit',
1633
"Called after a commit is calculated but before it is is "
1634
"completed. pre_commit is called with (local, master, old_revno, "
1635
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1636
"). old_revid is NULL_REVISION for the first commit to a branch, "
1637
"tree_delta is a TreeDelta object describing changes from the "
1638
"basis revision. hooks MUST NOT modify this delta. "
1639
" future_tree is an in-memory tree obtained from "
1640
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1641
"tree.", (0,91), None))
1642
self.create_hook(HookPoint('post_commit',
1643
"Called in the bzr client after a commit has completed. "
1644
"post_commit is called with (local, master, old_revno, old_revid, "
1645
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1646
"commit to a branch.", (0, 15), None))
1647
self.create_hook(HookPoint('post_uncommit',
1648
"Called in the bzr client after an uncommit completes. "
1649
"post_uncommit is called with (local, master, old_revno, "
1650
"old_revid, new_revno, new_revid) where local is the local branch "
1651
"or None, master is the target branch, and an empty branch "
1652
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1653
self.create_hook(HookPoint('pre_change_branch_tip',
1654
"Called in bzr client and server before a change to the tip of a "
1655
"branch is made. pre_change_branch_tip is called with a "
1656
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1657
"commit, uncommit will all trigger this hook.", (1, 6), None))
1658
self.create_hook(HookPoint('post_change_branch_tip',
1659
"Called in bzr client and server after a change to the tip of a "
1660
"branch is made. post_change_branch_tip is called with a "
1661
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1662
"commit, uncommit will all trigger this hook.", (1, 4), None))
1663
self.create_hook(HookPoint('transform_fallback_location',
1664
"Called when a stacked branch is activating its fallback "
1665
"locations. transform_fallback_location is called with (branch, "
1666
"url), and should return a new url. Returning the same url "
1667
"allows it to be used as-is, returning a different one can be "
1668
"used to cause the branch to stack on a closer copy of that "
1669
"fallback_location. Note that the branch cannot have history "
1670
"accessing methods called on it during this hook because the "
1671
"fallback locations have not been activated. When there are "
1672
"multiple hooks installed for transform_fallback_location, "
1673
"all are called with the url returned from the previous hook."
1674
"The order is however undefined.", (1, 9), None))
1035
1677
# install the default hooks into the Branch class.
1036
1678
Branch.hooks = BranchHooks()
1681
class ChangeBranchTipParams(object):
1682
"""Object holding parameters passed to *_change_branch_tip hooks.
1684
There are 5 fields that hooks may wish to access:
1686
:ivar branch: the branch being changed
1687
:ivar old_revno: revision number before the change
1688
:ivar new_revno: revision number after the change
1689
:ivar old_revid: revision id before the change
1690
:ivar new_revid: revision id after the change
1692
The revid fields are strings. The revno fields are integers.
1695
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1696
"""Create a group of ChangeBranchTip parameters.
1698
:param branch: The branch being changed.
1699
:param old_revno: Revision number before the change.
1700
:param new_revno: Revision number after the change.
1701
:param old_revid: Tip revision id before the change.
1702
:param new_revid: Tip revision id after the change.
1704
self.branch = branch
1705
self.old_revno = old_revno
1706
self.new_revno = new_revno
1707
self.old_revid = old_revid
1708
self.new_revid = new_revid
1710
def __eq__(self, other):
1711
return self.__dict__ == other.__dict__
1714
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1715
self.__class__.__name__, self.branch,
1716
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1039
1719
class BzrBranchFormat4(BranchFormat):
1040
1720
"""Bzr branch format 4.
1152
1860
def initialize(self, a_bzrdir):
1153
1861
"""Create a branch of this format in a_bzrdir."""
1154
1862
utf8_files = [('last-revision', '0 null:\n'),
1155
('branch-name', ''),
1156
('branch.conf', ''),
1159
return self._initialize_helper(a_bzrdir, utf8_files)
1161
def open(self, a_bzrdir, _found=False):
1162
"""Return the branch object for a_bzrdir
1164
_found is a private parameter, do not use it. It is used to indicate
1165
if format probing has already be done.
1168
format = BranchFormat.find_format(a_bzrdir)
1169
assert format.__class__ == self.__class__
1170
transport = a_bzrdir.get_branch_transport(None)
1171
control_files = lockable_files.LockableFiles(transport, 'lock',
1173
return BzrBranch6(_format=self,
1174
_control_files=control_files,
1176
_repository=a_bzrdir.find_repository())
1178
def supports_tags(self):
1863
('branch.conf', ''),
1866
return self._initialize_helper(a_bzrdir, utf8_files)
1868
def make_tags(self, branch):
1869
"""See bzrlib.branch.BranchFormat.make_tags()."""
1870
return BasicTags(branch)
1872
def supports_set_append_revisions_only(self):
1876
class BzrBranchFormat8(BranchFormatMetadir):
1877
"""Metadir format supporting storing locations of subtree branches."""
1879
def _branch_class(self):
1882
def get_format_string(self):
1883
"""See BranchFormat.get_format_string()."""
1884
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1886
def get_format_description(self):
1887
"""See BranchFormat.get_format_description()."""
1888
return "Branch format 8"
1890
def initialize(self, a_bzrdir):
1891
"""Create a branch of this format in a_bzrdir."""
1892
utf8_files = [('last-revision', '0 null:\n'),
1893
('branch.conf', ''),
1897
return self._initialize_helper(a_bzrdir, utf8_files)
1900
super(BzrBranchFormat8, self).__init__()
1901
self._matchingbzrdir.repository_format = \
1902
RepositoryFormatKnitPack5RichRoot()
1904
def make_tags(self, branch):
1905
"""See bzrlib.branch.BranchFormat.make_tags()."""
1906
return BasicTags(branch)
1908
def supports_set_append_revisions_only(self):
1911
def supports_stacking(self):
1914
supports_reference_locations = True
1917
class BzrBranchFormat7(BzrBranchFormat8):
1918
"""Branch format with last-revision, tags, and a stacked location pointer.
1920
The stacked location pointer is passed down to the repository and requires
1921
a repository format with supports_external_lookups = True.
1923
This format was introduced in bzr 1.6.
1926
def initialize(self, a_bzrdir):
1927
"""Create a branch of this format in a_bzrdir."""
1928
utf8_files = [('last-revision', '0 null:\n'),
1929
('branch.conf', ''),
1932
return self._initialize_helper(a_bzrdir, utf8_files)
1934
def _branch_class(self):
1937
def get_format_string(self):
1938
"""See BranchFormat.get_format_string()."""
1939
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1941
def get_format_description(self):
1942
"""See BranchFormat.get_format_description()."""
1943
return "Branch format 7"
1945
def supports_set_append_revisions_only(self):
1948
supports_reference_locations = False
1182
1951
class BranchReferenceFormat(BranchFormat):
1359
2179
"""See Branch.print_file."""
1360
2180
return self.repository.print_file(file, revision_id)
1363
def append_revision(self, *revision_ids):
1364
"""See Branch.append_revision."""
1365
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1366
for revision_id in revision_ids:
1367
_mod_revision.check_not_reserved_id(revision_id)
1368
mutter("add {%s} to revision-history" % revision_id)
1369
rev_history = self.revision_history()
1370
rev_history.extend(revision_ids)
1371
self.set_revision_history(rev_history)
1373
2182
def _write_revision_history(self, history):
1374
2183
"""Factored out of set_revision_history.
1376
2185
This performs the actual writing to disk.
1377
2186
It is intended to be called by BzrBranch5.set_revision_history."""
1378
self.control_files.put_bytes(
1379
'revision-history', '\n'.join(history))
2187
self._transport.put_bytes(
2188
'revision-history', '\n'.join(history),
2189
mode=self.bzrdir._get_file_mode())
1381
2191
@needs_write_lock
1382
2192
def set_revision_history(self, rev_history):
1383
2193
"""See Branch.set_revision_history."""
1384
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1385
self._clear_cached_state()
2194
if 'evil' in debug.debug_flags:
2195
mutter_callsite(3, "set_revision_history scales with history.")
2196
check_not_reserved_id = _mod_revision.check_not_reserved_id
2197
for rev_id in rev_history:
2198
check_not_reserved_id(rev_id)
2199
if Branch.hooks['post_change_branch_tip']:
2200
# Don't calculate the last_revision_info() if there are no hooks
2202
old_revno, old_revid = self.last_revision_info()
2203
if len(rev_history) == 0:
2204
revid = _mod_revision.NULL_REVISION
2206
revid = rev_history[-1]
2207
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1386
2208
self._write_revision_history(rev_history)
2209
self._clear_cached_state()
1387
2210
self._cache_revision_history(rev_history)
1388
2211
for hook in Branch.hooks['set_rh']:
1389
2212
hook(self, rev_history)
2213
if Branch.hooks['post_change_branch_tip']:
2214
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2216
def _synchronize_history(self, destination, revision_id):
2217
"""Synchronize last revision and revision history between branches.
2219
This version is most efficient when the destination is also a
2220
BzrBranch5, but works for BzrBranch6 as long as the revision
2221
history is the true lefthand parent history, and all of the revisions
2222
are in the destination's repository. If not, set_revision_history
2225
:param destination: The branch to copy the history into
2226
:param revision_id: The revision-id to truncate history at. May
2227
be None to copy complete history.
2229
if not isinstance(destination._format, BzrBranchFormat5):
2230
super(BzrBranch, self)._synchronize_history(
2231
destination, revision_id)
2233
if revision_id == _mod_revision.NULL_REVISION:
2236
new_history = self.revision_history()
2237
if revision_id is not None and new_history != []:
2239
new_history = new_history[:new_history.index(revision_id) + 1]
2241
rev = self.repository.get_revision(revision_id)
2242
new_history = rev.get_history(self.repository)[1:]
2243
destination.set_revision_history(new_history)
1391
2245
@needs_write_lock
1392
2246
def set_last_revision_info(self, revno, revision_id):
1393
revision_id = osutils.safe_revision_id(revision_id)
2247
"""Set the last revision of this branch.
2249
The caller is responsible for checking that the revno is correct
2250
for this revision id.
2252
It may be possible to set the branch last revision to an id not
2253
present in the repository. However, branches can also be
2254
configured to check constraints on history, in which case this may not
2257
revision_id = _mod_revision.ensure_null(revision_id)
2258
# this old format stores the full history, but this api doesn't
2259
# provide it, so we must generate, and might as well check it's
1394
2261
history = self._lefthand_history(revision_id)
1395
assert len(history) == revno, '%d != %d' % (len(history), revno)
2262
if len(history) != revno:
2263
raise AssertionError('%d != %d' % (len(history), revno))
1396
2264
self.set_revision_history(history)
1398
2266
def _gen_revision_history(self):
1399
history = self.control_files.get('revision-history').read().split('\n')
2267
history = self._transport.get_bytes('revision-history').split('\n')
1400
2268
if history[-1:] == ['']:
1401
2269
# There shouldn't be a trailing newline, but just in case.
1405
def _lefthand_history(self, revision_id, last_rev=None,
1407
# stop_revision must be a descendant of last_revision
1408
stop_graph = self.repository.get_revision_graph(revision_id)
1409
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1410
and last_rev not in stop_graph):
1411
# our previous tip is not merged into stop_revision
1412
raise errors.DivergedBranches(self, other_branch)
1413
# make a new revision history from the graph
1414
current_rev_id = revision_id
1416
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1417
new_history.append(current_rev_id)
1418
current_rev_id_parents = stop_graph[current_rev_id]
1420
current_rev_id = current_rev_id_parents[0]
1422
current_rev_id = None
1423
new_history.reverse()
1426
2273
@needs_write_lock
1427
2274
def generate_revision_history(self, revision_id, last_rev=None,
1428
2275
other_branch=None):
1434
2281
:param other_branch: The other branch that DivergedBranches should
1435
2282
raise with respect to.
1437
revision_id = osutils.safe_revision_id(revision_id)
1438
2284
self.set_revision_history(self._lefthand_history(revision_id,
1439
2285
last_rev, other_branch))
1442
def update_revisions(self, other, stop_revision=None):
1443
"""See Branch.update_revisions."""
1446
if stop_revision is None:
1447
stop_revision = other.last_revision()
1448
if stop_revision is None:
1449
# if there are no commits, we're done.
1452
stop_revision = osutils.safe_revision_id(stop_revision)
1453
# whats the current last revision, before we fetch [and change it
1455
last_rev = _mod_revision.ensure_null(self.last_revision())
1456
# we fetch here regardless of whether we need to so that we pickup
1458
self.fetch(other, stop_revision)
1459
my_ancestry = self.repository.get_ancestry(last_rev,
1461
if stop_revision in my_ancestry:
1462
# last_revision is a descendant of stop_revision
1464
self.generate_revision_history(stop_revision, last_rev=last_rev,
1469
2287
def basis_tree(self):
1470
2288
"""See Branch.basis_tree."""
1471
2289
return self.repository.revision_tree(self.last_revision())
1473
@deprecated_method(zero_eight)
1474
def working_tree(self):
1475
"""Create a Working tree object for this branch."""
1477
from bzrlib.transport.local import LocalTransport
1478
if (self.base.find('://') != -1 or
1479
not isinstance(self._transport, LocalTransport)):
1480
raise NoWorkingTree(self.base)
1481
return self.bzrdir.open_workingtree()
1484
def pull(self, source, overwrite=False, stop_revision=None,
1485
_hook_master=None, run_hooks=True):
1488
:param _hook_master: Private parameter - set the branch to
1489
be supplied as the master to push hooks.
1490
:param run_hooks: Private parameter - if false, this branch
1491
is being called because it's the master of the primary branch,
1492
so it should not run its hooks.
1494
result = PullResult()
1495
result.source_branch = source
1496
result.target_branch = self
1499
result.old_revno, result.old_revid = self.last_revision_info()
1501
self.update_revisions(source, stop_revision)
1502
except DivergedBranches:
1506
if stop_revision is None:
1507
stop_revision = source.last_revision()
1508
self.generate_revision_history(stop_revision)
1509
result.tag_conflicts = source.tags.merge_to(self.tags)
1510
result.new_revno, result.new_revid = self.last_revision_info()
1512
result.master_branch = _hook_master
1513
result.local_branch = self
1515
result.master_branch = self
1516
result.local_branch = None
1518
for hook in Branch.hooks['post_pull']:
1524
2291
def _get_parent_location(self):
1525
2292
_locs = ['parent', 'pull', 'x-pull']
1526
2293
for l in _locs:
1528
return self.control_files.get(l).read().strip('\n')
2295
return self._transport.get_bytes(l).strip('\n')
2296
except errors.NoSuchFile:
1534
def push(self, target, overwrite=False, stop_revision=None,
1535
_override_hook_source_branch=None):
1538
This is the basic concrete implementation of push()
1540
:param _override_hook_source_branch: If specified, run
1541
the hooks passing this Branch as the source, rather than self.
1542
This is for use of RemoteBranch, where push is delegated to the
1543
underlying vfs-based Branch.
1545
# TODO: Public option to disable running hooks - should be trivial but
1549
result = self._push_with_bound_branches(target, overwrite,
1551
_override_hook_source_branch=_override_hook_source_branch)
1556
def _push_with_bound_branches(self, target, overwrite,
1558
_override_hook_source_branch=None):
1559
"""Push from self into target, and into target's master if any.
1561
This is on the base BzrBranch class even though it doesn't support
1562
bound branches because the *target* might be bound.
1565
if _override_hook_source_branch:
1566
result.source_branch = _override_hook_source_branch
1567
for hook in Branch.hooks['post_push']:
1570
bound_location = target.get_bound_location()
1571
if bound_location and target.base != bound_location:
1572
# there is a master branch.
1574
# XXX: Why the second check? Is it even supported for a branch to
1575
# be bound to itself? -- mbp 20070507
1576
master_branch = target.get_master_branch()
1577
master_branch.lock_write()
1579
# push into the master from this branch.
1580
self._basic_push(master_branch, overwrite, stop_revision)
1581
# and push into the target branch from this. Note that we push from
1582
# this branch again, because its considered the highest bandwidth
1584
result = self._basic_push(target, overwrite, stop_revision)
1585
result.master_branch = master_branch
1586
result.local_branch = target
1590
master_branch.unlock()
1593
result = self._basic_push(target, overwrite, stop_revision)
1594
# TODO: Why set master_branch and local_branch if there's no
1595
# binding? Maybe cleaner to just leave them unset? -- mbp
1597
result.master_branch = target
1598
result.local_branch = None
1602
2300
def _basic_push(self, target, overwrite, stop_revision):
1603
2301
"""Basic implementation of push without bound branches or hooks.
1605
Must be called with self read locked and target write locked.
2303
Must be called with source read locked and target write locked.
1607
result = PushResult()
2305
result = BranchPushResult()
1608
2306
result.source_branch = self
1609
2307
result.target_branch = target
1610
2308
result.old_revno, result.old_revid = target.last_revision_info()
1612
target.update_revisions(self, stop_revision)
1613
except DivergedBranches:
1617
target.set_revision_history(self.revision_history())
1618
result.tag_conflicts = self.tags.merge_to(target.tags)
2309
self.update_references(target)
2310
if result.old_revid != self.last_revision():
2311
# We assume that during 'push' this repository is closer than
2313
graph = self.repository.get_graph(target.repository)
2314
target.update_revisions(self, stop_revision,
2315
overwrite=overwrite, graph=graph)
2316
if self._push_should_merge_tags():
2317
result.tag_conflicts = self.tags.merge_to(target.tags,
1619
2319
result.new_revno, result.new_revid = target.last_revision_info()
1622
def get_parent(self):
1623
"""See Branch.get_parent."""
1625
assert self.base[-1] == '/'
1626
parent = self._get_parent_location()
1629
# This is an old-format absolute path to a local branch
1630
# turn it into a url
1631
if parent.startswith('/'):
1632
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1634
return urlutils.join(self.base[:-1], parent)
1635
except errors.InvalidURLJoin, e:
1636
raise errors.InaccessibleParent(parent, self.base)
2322
def get_stacked_on_url(self):
2323
raise errors.UnstackableBranchFormat(self._format, self.base)
1638
2325
def set_push_location(self, location):
1639
2326
"""See Branch.set_push_location."""
1641
2328
'push_location', location,
1642
2329
store=_mod_config.STORE_LOCATION_NORECURSE)
1645
def set_parent(self, url):
1646
"""See Branch.set_parent."""
1647
# TODO: Maybe delete old location files?
1648
# URLs should never be unicode, even on the local fs,
1649
# FIXUP this and get_parent in a future branch format bump:
1650
# read and rewrite the file, and have the new format code read
1651
# using .get not .get_utf8. RBC 20060125
1653
if isinstance(url, unicode):
1655
url = url.encode('ascii')
1656
except UnicodeEncodeError:
1657
raise errors.InvalidURL(url,
1658
"Urls must be 7-bit ascii, "
1659
"use bzrlib.urlutils.escape")
1660
url = urlutils.relative_url(self.base, url)
1661
self._set_parent_location(url)
1663
2331
def _set_parent_location(self, url):
1664
2332
if url is None:
1665
self.control_files._transport.delete('parent')
2333
self._transport.delete('parent')
1667
assert isinstance(url, str)
1668
self.control_files.put_bytes('parent', url + '\n')
1670
@deprecated_function(zero_nine)
1671
def tree_config(self):
1672
"""DEPRECATED; call get_config instead.
1673
TreeConfig has become part of BranchConfig."""
1674
return TreeConfig(self)
2335
self._transport.put_bytes('parent', url + '\n',
2336
mode=self.bzrdir._get_file_mode())
1677
2339
class BzrBranch5(BzrBranch):
1678
"""A format 5 branch. This supports new features over plan branches.
2340
"""A format 5 branch. This supports new features over plain branches.
1680
2342
It has support for a master_branch which is the data for bound branches.
1688
super(BzrBranch5, self).__init__(_format=_format,
1689
_control_files=_control_files,
1691
_repository=_repository)
1694
def pull(self, source, overwrite=False, stop_revision=None,
1696
"""Pull from source into self, updating my master if any.
1698
:param run_hooks: Private parameter - if false, this branch
1699
is being called because it's the master of the primary branch,
1700
so it should not run its hooks.
1702
bound_location = self.get_bound_location()
1703
master_branch = None
1704
if bound_location and source.base != bound_location:
1705
# not pulling from master, so we need to update master.
1706
master_branch = self.get_master_branch()
1707
master_branch.lock_write()
1710
# pull from source into master.
1711
master_branch.pull(source, overwrite, stop_revision,
1713
return super(BzrBranch5, self).pull(source, overwrite,
1714
stop_revision, _hook_master=master_branch,
1715
run_hooks=run_hooks)
1718
master_branch.unlock()
1720
2345
def get_bound_location(self):
1722
return self.control_files.get_utf8('bound').read()[:-1]
2347
return self._transport.get_bytes('bound')[:-1]
1723
2348
except errors.NoSuchFile:
1726
2351
@needs_read_lock
1727
def get_master_branch(self):
2352
def get_master_branch(self, possible_transports=None):
1728
2353
"""Return the branch we are bound to.
1730
2355
:return: Either a Branch, or None
1732
2357
This could memoise the branch, but if thats done
1806
2417
return self.set_bound_location(None)
1808
2419
@needs_write_lock
1810
"""Synchronise this branch with the master branch if any.
2420
def update(self, possible_transports=None):
2421
"""Synchronise this branch with the master branch if any.
1812
2423
:return: None or the last_revision that was pivoted out during the
1815
master = self.get_master_branch()
2426
master = self.get_master_branch(possible_transports)
1816
2427
if master is not None:
1817
old_tip = self.last_revision()
2428
old_tip = _mod_revision.ensure_null(self.last_revision())
1818
2429
self.pull(master, overwrite=True)
1819
if old_tip in self.repository.get_ancestry(
1820
_mod_revision.ensure_null(self.last_revision()),
2430
if self.repository.get_graph().is_ancestor(old_tip,
2431
_mod_revision.ensure_null(self.last_revision())):
1827
class BzrBranchExperimental(BzrBranch5):
1828
"""Bzr experimental branch format
1831
- a revision-history file.
1833
- a lock dir guarding the branch itself
1834
- all of this stored in a branch/ subdirectory
1835
- works with shared repositories.
1836
- a tag dictionary in the branch
1838
This format is new in bzr 0.15, but shouldn't be used for real data,
1841
This class acts as it's own BranchFormat.
1844
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1847
def get_format_string(cls):
1848
"""See BranchFormat.get_format_string()."""
1849
return "Bazaar-NG branch format experimental\n"
1852
def get_format_description(cls):
1853
"""See BranchFormat.get_format_description()."""
1854
return "Experimental branch format"
1857
def get_reference(cls, a_bzrdir):
1858
"""Get the target reference of the branch in a_bzrdir.
1860
format probing must have been completed before calling
1861
this method - it is assumed that the format of the branch
1862
in a_bzrdir is correct.
1864
:param a_bzrdir: The bzrdir to get the branch data from.
1865
:return: None if the branch is not a reference branch.
1870
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1872
branch_transport = a_bzrdir.get_branch_transport(cls)
1873
control_files = lockable_files.LockableFiles(branch_transport,
1874
lock_filename, lock_class)
1875
control_files.create_lock()
1876
control_files.lock_write()
2437
class BzrBranch8(BzrBranch5):
2438
"""A branch that stores tree-reference locations."""
2440
def _open_hook(self):
2441
if self._ignore_fallbacks:
1878
for filename, content in utf8_files:
1879
control_files.put_utf8(filename, content)
1881
control_files.unlock()
1884
def initialize(cls, a_bzrdir):
1885
"""Create a branch of this format in a_bzrdir."""
1886
utf8_files = [('format', cls.get_format_string()),
1887
('revision-history', ''),
1888
('branch-name', ''),
1891
cls._initialize_control_files(a_bzrdir, utf8_files,
1892
'lock', lockdir.LockDir)
1893
return cls.open(a_bzrdir, _found=True)
1896
def open(cls, a_bzrdir, _found=False):
1897
"""Return the branch object for a_bzrdir
1899
_found is a private parameter, do not use it. It is used to indicate
1900
if format probing has already be done.
1903
format = BranchFormat.find_format(a_bzrdir)
1904
assert format.__class__ == cls
1905
transport = a_bzrdir.get_branch_transport(None)
1906
control_files = lockable_files.LockableFiles(transport, 'lock',
1908
return cls(_format=cls,
1909
_control_files=control_files,
1911
_repository=a_bzrdir.find_repository())
1914
def is_supported(cls):
1917
def _make_tags(self):
1918
return BasicTags(self)
1921
def supports_tags(cls):
1925
BranchFormat.register_format(BzrBranchExperimental)
1928
class BzrBranch6(BzrBranch5):
1931
def last_revision_info(self):
1932
revision_string = self.control_files.get('last-revision').read()
2444
url = self.get_stacked_on_url()
2445
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2446
errors.UnstackableBranchFormat):
2449
for hook in Branch.hooks['transform_fallback_location']:
2450
url = hook(self, url)
2452
hook_name = Branch.hooks.get_hook_name(hook)
2453
raise AssertionError(
2454
"'transform_fallback_location' hook %s returned "
2455
"None, not a URL." % hook_name)
2456
self._activate_fallback_location(url)
2458
def __init__(self, *args, **kwargs):
2459
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2460
super(BzrBranch8, self).__init__(*args, **kwargs)
2461
self._last_revision_info_cache = None
2462
self._reference_info = None
2464
def _clear_cached_state(self):
2465
super(BzrBranch8, self)._clear_cached_state()
2466
self._last_revision_info_cache = None
2467
self._reference_info = None
2469
def _last_revision_info(self):
2470
revision_string = self._transport.get_bytes('last-revision')
1933
2471
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1934
2472
revision_id = cache_utf8.get_cached_utf8(revision_id)
1935
2473
revno = int(revno)
1936
2474
return revno, revision_id
1938
def last_revision(self):
1939
"""Return last revision id, or None"""
1940
revision_id = self.last_revision_info()[1]
1941
if revision_id == _mod_revision.NULL_REVISION:
1945
2476
def _write_last_revision_info(self, revno, revision_id):
1946
2477
"""Simply write out the revision id, with no checks.
2024
2551
"""Set the parent branch"""
2025
2552
return self._get_config_location('parent_location')
2555
def _set_all_reference_info(self, info_dict):
2556
"""Replace all reference info stored in a branch.
2558
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2561
writer = rio.RioWriter(s)
2562
for key, (tree_path, branch_location) in info_dict.iteritems():
2563
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2564
branch_location=branch_location)
2565
writer.write_stanza(stanza)
2566
self._transport.put_bytes('references', s.getvalue())
2567
self._reference_info = info_dict
2570
def _get_all_reference_info(self):
2571
"""Return all the reference info stored in a branch.
2573
:return: A dict of {file_id: (tree_path, branch_location)}
2575
if self._reference_info is not None:
2576
return self._reference_info
2577
rio_file = self._transport.get('references')
2579
stanzas = rio.read_stanzas(rio_file)
2580
info_dict = dict((s['file_id'], (s['tree_path'],
2581
s['branch_location'])) for s in stanzas)
2584
self._reference_info = info_dict
2587
def set_reference_info(self, file_id, tree_path, branch_location):
2588
"""Set the branch location to use for a tree reference.
2590
:param file_id: The file-id of the tree reference.
2591
:param tree_path: The path of the tree reference in the tree.
2592
:param branch_location: The location of the branch to retrieve tree
2595
info_dict = self._get_all_reference_info()
2596
info_dict[file_id] = (tree_path, branch_location)
2597
if None in (tree_path, branch_location):
2598
if tree_path is not None:
2599
raise ValueError('tree_path must be None when branch_location'
2601
if branch_location is not None:
2602
raise ValueError('branch_location must be None when tree_path'
2604
del info_dict[file_id]
2605
self._set_all_reference_info(info_dict)
2607
def get_reference_info(self, file_id):
2608
"""Get the tree_path and branch_location for a tree reference.
2610
:return: a tuple of (tree_path, branch_location)
2612
return self._get_all_reference_info().get(file_id, (None, None))
2614
def reference_parent(self, file_id, path, possible_transports=None):
2615
"""Return the parent branch for a tree-reference file_id.
2617
:param file_id: The file_id of the tree reference
2618
:param path: The path of the file_id in the tree
2619
:return: A branch associated with the file_id
2621
branch_location = self.get_reference_info(file_id)[1]
2622
if branch_location is None:
2623
return Branch.reference_parent(self, file_id, path,
2624
possible_transports)
2625
branch_location = urlutils.join(self.base, branch_location)
2626
return Branch.open(branch_location,
2627
possible_transports=possible_transports)
2027
2629
def set_push_location(self, location):
2028
2630
"""See Branch.set_push_location."""
2029
2631
self._set_config_location('push_location', location)
2062
2664
"""See Branch.get_old_bound_location"""
2063
2665
return self._get_bound_location(False)
2065
def set_append_revisions_only(self, enabled):
2070
self.get_config().set_user_option('append_revisions_only', value,
2667
def get_stacked_on_url(self):
2668
# you can always ask for the URL; but you might not be able to use it
2669
# if the repo can't support stacking.
2670
## self._check_stackable_repo()
2671
stacked_url = self._get_config_location('stacked_on_location')
2672
if stacked_url is None:
2673
raise errors.NotStacked(self)
2073
2676
def _get_append_revisions_only(self):
2074
2677
value = self.get_config().get_user_option('append_revisions_only')
2075
2678
return value == 'True'
2077
def _synchronize_history(self, destination, revision_id):
2078
"""Synchronize last revision and revision history between branches.
2080
This version is most efficient when the destination is also a
2081
BzrBranch6, but works for BzrBranch5, as long as the destination's
2082
repository contains all the lefthand ancestors of the intended
2083
last_revision. If not, set_last_revision_info will fail.
2085
:param destination: The branch to copy the history into
2086
:param revision_id: The revision-id to truncate history at. May
2087
be None to copy complete history.
2089
if revision_id is None:
2090
revno, revision_id = self.last_revision_info()
2681
def generate_revision_history(self, revision_id, last_rev=None,
2683
"""See BzrBranch5.generate_revision_history"""
2684
history = self._lefthand_history(revision_id, last_rev, other_branch)
2685
revno = len(history)
2686
self.set_last_revision_info(revno, revision_id)
2689
def get_rev_id(self, revno, history=None):
2690
"""Find the revision id of the specified revno."""
2692
return _mod_revision.NULL_REVISION
2694
last_revno, last_revision_id = self.last_revision_info()
2695
if revno <= 0 or revno > last_revno:
2696
raise errors.NoSuchRevision(self, revno)
2698
if history is not None:
2699
return history[revno - 1]
2701
index = last_revno - revno
2702
if len(self._partial_revision_history_cache) <= index:
2703
self._extend_partial_history(stop_index=index)
2704
if len(self._partial_revision_history_cache) > index:
2705
return self._partial_revision_history_cache[index]
2092
# To figure out the revno for a random revision, we need to build
2093
# the revision history, and count its length.
2094
# We don't care about the order, just how long it is.
2095
# Alternatively, we could start at the current location, and count
2096
# backwards. But there is no guarantee that we will find it since
2097
# it may be a merged revision.
2098
revno = len(list(self.repository.iter_reverse_revision_history(
2100
destination.set_last_revision_info(revno, revision_id)
2102
def _make_tags(self):
2103
return BasicTags(self)
2707
raise errors.NoSuchRevision(self, revno)
2710
def revision_id_to_revno(self, revision_id):
2711
"""Given a revision id, return its revno"""
2712
if _mod_revision.is_null(revision_id):
2715
index = self._partial_revision_history_cache.index(revision_id)
2717
self._extend_partial_history(stop_revision=revision_id)
2718
index = len(self._partial_revision_history_cache) - 1
2719
if self._partial_revision_history_cache[index] != revision_id:
2720
raise errors.NoSuchRevision(self, revision_id)
2721
return self.revno() - index
2724
class BzrBranch7(BzrBranch8):
2725
"""A branch with support for a fallback repository."""
2727
def set_reference_info(self, file_id, tree_path, branch_location):
2728
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2730
def get_reference_info(self, file_id):
2731
Branch.get_reference_info(self, file_id)
2733
def reference_parent(self, file_id, path, possible_transports=None):
2734
return Branch.reference_parent(self, file_id, path,
2735
possible_transports)
2738
class BzrBranch6(BzrBranch7):
2739
"""See BzrBranchFormat6 for the capabilities of this branch.
2741
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2745
def get_stacked_on_url(self):
2746
raise errors.UnstackableBranchFormat(self._format, self.base)
2106
2749
######################################################################
2204
2860
new_branch.tags._set_tag_dict({})
2206
2862
# Copying done; now update target format
2207
new_branch.control_files.put_utf8('format',
2208
format.get_format_string())
2863
new_branch._transport.put_bytes('format',
2864
format.get_format_string(),
2865
mode=new_branch.bzrdir._get_file_mode())
2210
2867
# Clean up old files
2211
new_branch.control_files._transport.delete('revision-history')
2868
new_branch._transport.delete('revision-history')
2213
2870
branch.set_parent(None)
2871
except errors.NoSuchFile:
2216
2873
branch.set_bound_location(None)
2876
class Converter6to7(object):
2877
"""Perform an in-place upgrade of format 6 to format 7"""
2879
def convert(self, branch):
2880
format = BzrBranchFormat7()
2881
branch._set_config_location('stacked_on_location', '')
2882
# update target format
2883
branch._transport.put_bytes('format', format.get_format_string())
2886
class Converter7to8(object):
2887
"""Perform an in-place upgrade of format 6 to format 7"""
2889
def convert(self, branch):
2890
format = BzrBranchFormat8()
2891
branch._transport.put_bytes('references', '')
2892
# update target format
2893
branch._transport.put_bytes('format', format.get_format_string())
2896
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2897
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2900
_run_with_write_locked_target will attempt to release the lock it acquires.
2902
If an exception is raised by callable, then that exception *will* be
2903
propagated, even if the unlock attempt raises its own error. Thus
2904
_run_with_write_locked_target should be preferred to simply doing::
2908
return callable(*args, **kwargs)
2913
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2914
# should share code?
2917
result = callable(*args, **kwargs)
2919
exc_info = sys.exc_info()
2923
raise exc_info[0], exc_info[1], exc_info[2]
2929
class InterBranch(InterObject):
2930
"""This class represents operations taking place between two branches.
2932
Its instances have methods like pull() and push() and contain
2933
references to the source and target repositories these operations
2934
can be carried out on.
2938
"""The available optimised InterBranch types."""
2941
def _get_branch_formats_to_test():
2942
"""Return a tuple with the Branch formats to use when testing."""
2943
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
2945
def pull(self, overwrite=False, stop_revision=None,
2946
possible_transports=None, local=False):
2947
"""Mirror source into target branch.
2949
The target branch is considered to be 'local', having low latency.
2951
:returns: PullResult instance
2953
raise NotImplementedError(self.pull)
2955
def update_revisions(self, stop_revision=None, overwrite=False,
2957
"""Pull in new perfect-fit revisions.
2959
:param stop_revision: Updated until the given revision
2960
:param overwrite: Always set the branch pointer, rather than checking
2961
to see if it is a proper descendant.
2962
:param graph: A Graph object that can be used to query history
2963
information. This can be None.
2966
raise NotImplementedError(self.update_revisions)
2968
def push(self, overwrite=False, stop_revision=None,
2969
_override_hook_source_branch=None):
2970
"""Mirror the source branch into the target branch.
2972
The source branch is considered to be 'local', having low latency.
2974
raise NotImplementedError(self.push)
2977
class GenericInterBranch(InterBranch):
2978
"""InterBranch implementation that uses public Branch functions.
2982
def _get_branch_formats_to_test():
2983
return BranchFormat._default_format, BranchFormat._default_format
2985
def update_revisions(self, stop_revision=None, overwrite=False,
2987
"""See InterBranch.update_revisions()."""
2988
self.source.lock_read()
2990
other_revno, other_last_revision = self.source.last_revision_info()
2991
stop_revno = None # unknown
2992
if stop_revision is None:
2993
stop_revision = other_last_revision
2994
if _mod_revision.is_null(stop_revision):
2995
# if there are no commits, we're done.
2997
stop_revno = other_revno
2999
# what's the current last revision, before we fetch [and change it
3001
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3002
# we fetch here so that we don't process data twice in the common
3003
# case of having something to pull, and so that the check for
3004
# already merged can operate on the just fetched graph, which will
3005
# be cached in memory.
3006
self.target.fetch(self.source, stop_revision)
3007
# Check to see if one is an ancestor of the other
3010
graph = self.target.repository.get_graph()
3011
if self.target._check_if_descendant_or_diverged(
3012
stop_revision, last_rev, graph, self.source):
3013
# stop_revision is a descendant of last_rev, but we aren't
3014
# overwriting, so we're done.
3016
if stop_revno is None:
3018
graph = self.target.repository.get_graph()
3019
this_revno, this_last_revision = \
3020
self.target.last_revision_info()
3021
stop_revno = graph.find_distance_to_null(stop_revision,
3022
[(other_last_revision, other_revno),
3023
(this_last_revision, this_revno)])
3024
self.target.set_last_revision_info(stop_revno, stop_revision)
3026
self.source.unlock()
3028
def pull(self, overwrite=False, stop_revision=None,
3029
possible_transports=None, _hook_master=None, run_hooks=True,
3030
_override_hook_target=None, local=False):
3033
:param _hook_master: Private parameter - set the branch to
3034
be supplied as the master to pull hooks.
3035
:param run_hooks: Private parameter - if false, this branch
3036
is being called because it's the master of the primary branch,
3037
so it should not run its hooks.
3038
:param _override_hook_target: Private parameter - set the branch to be
3039
supplied as the target_branch to pull hooks.
3040
:param local: Only update the local branch, and not the bound branch.
3042
# This type of branch can't be bound.
3044
raise errors.LocalRequiresBoundBranch()
3045
result = PullResult()
3046
result.source_branch = self.source
3047
if _override_hook_target is None:
3048
result.target_branch = self.target
3050
result.target_branch = _override_hook_target
3051
self.source.lock_read()
3053
# We assume that during 'pull' the target repository is closer than
3055
self.source.update_references(self.target)
3056
graph = self.target.repository.get_graph(self.source.repository)
3057
# TODO: Branch formats should have a flag that indicates
3058
# that revno's are expensive, and pull() should honor that flag.
3060
result.old_revno, result.old_revid = \
3061
self.target.last_revision_info()
3062
self.target.update_revisions(self.source, stop_revision,
3063
overwrite=overwrite, graph=graph)
3064
# TODO: The old revid should be specified when merging tags,
3065
# so a tags implementation that versions tags can only
3066
# pull in the most recent changes. -- JRV20090506
3067
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3069
result.new_revno, result.new_revid = self.target.last_revision_info()
3071
result.master_branch = _hook_master
3072
result.local_branch = result.target_branch
3074
result.master_branch = result.target_branch
3075
result.local_branch = None
3077
for hook in Branch.hooks['post_pull']:
3080
self.source.unlock()
3083
def push(self, overwrite=False, stop_revision=None,
3084
_override_hook_source_branch=None):
3085
"""See InterBranch.push.
3087
This is the basic concrete implementation of push()
3089
:param _override_hook_source_branch: If specified, run
3090
the hooks passing this Branch as the source, rather than self.
3091
This is for use of RemoteBranch, where push is delegated to the
3092
underlying vfs-based Branch.
3094
# TODO: Public option to disable running hooks - should be trivial but
3096
self.source.lock_read()
3098
return _run_with_write_locked_target(
3099
self.target, self._push_with_bound_branches, overwrite,
3101
_override_hook_source_branch=_override_hook_source_branch)
3103
self.source.unlock()
3105
def _push_with_bound_branches(self, overwrite, stop_revision,
3106
_override_hook_source_branch=None):
3107
"""Push from source into target, and into target's master if any.
3110
if _override_hook_source_branch:
3111
result.source_branch = _override_hook_source_branch
3112
for hook in Branch.hooks['post_push']:
3115
bound_location = self.target.get_bound_location()
3116
if bound_location and self.target.base != bound_location:
3117
# there is a master branch.
3119
# XXX: Why the second check? Is it even supported for a branch to
3120
# be bound to itself? -- mbp 20070507
3121
master_branch = self.target.get_master_branch()
3122
master_branch.lock_write()
3124
# push into the master from the source branch.
3125
self.source._basic_push(master_branch, overwrite, stop_revision)
3126
# and push into the target branch from the source. Note that we
3127
# push from the source branch again, because its considered the
3128
# highest bandwidth repository.
3129
result = self.source._basic_push(self.target, overwrite,
3131
result.master_branch = master_branch
3132
result.local_branch = self.target
3136
master_branch.unlock()
3139
result = self.source._basic_push(self.target, overwrite,
3141
# TODO: Why set master_branch and local_branch if there's no
3142
# binding? Maybe cleaner to just leave them unset? -- mbp
3144
result.master_branch = self.target
3145
result.local_branch = None
3150
def is_compatible(self, source, target):
3151
# GenericBranch uses the public API, so always compatible
3155
class InterToBranch5(GenericInterBranch):
3158
def _get_branch_formats_to_test():
3159
return BranchFormat._default_format, BzrBranchFormat5()
3161
def pull(self, overwrite=False, stop_revision=None,
3162
possible_transports=None, run_hooks=True,
3163
_override_hook_target=None, local=False):
3164
"""Pull from source into self, updating my master if any.
3166
:param run_hooks: Private parameter - if false, this branch
3167
is being called because it's the master of the primary branch,
3168
so it should not run its hooks.
3170
bound_location = self.target.get_bound_location()
3171
if local and not bound_location:
3172
raise errors.LocalRequiresBoundBranch()
3173
master_branch = None
3174
if not local and bound_location and self.source.base != bound_location:
3175
# not pulling from master, so we need to update master.
3176
master_branch = self.target.get_master_branch(possible_transports)
3177
master_branch.lock_write()
3180
# pull from source into master.
3181
master_branch.pull(self.source, overwrite, stop_revision,
3183
return super(InterToBranch5, self).pull(overwrite,
3184
stop_revision, _hook_master=master_branch,
3185
run_hooks=run_hooks,
3186
_override_hook_target=_override_hook_target)
3189
master_branch.unlock()
3192
InterBranch.register_optimiser(GenericInterBranch)
3193
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
