124
114
if master is not None:
125
115
master.break_lock()
127
def _check_stackable_repo(self):
128
if not self.repository._format.supports_external_lookups:
129
raise errors.UnstackableRepositoryFormat(self.repository._format,
130
self.repository.base)
133
def open(base, _unsupported=False, possible_transports=None):
118
@deprecated_method(zero_eight)
119
def open_downlevel(base):
120
"""Open a branch which may be of an old format."""
121
return Branch.open(base, _unsupported=True)
124
def open(base, _unsupported=False):
134
125
"""Open the branch rooted at base.
136
127
For instance, if the branch is at URL/.bzr/branch,
137
128
Branch.open(URL) -> a Branch instance.
139
control = bzrdir.BzrDir.open(base, _unsupported,
140
possible_transports=possible_transports)
141
return control.open_branch(_unsupported)
144
def open_from_transport(transport, _unsupported=False):
145
"""Open the branch rooted at transport"""
146
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
147
return control.open_branch(_unsupported)
150
def open_containing(url, possible_transports=None):
130
control = bzrdir.BzrDir.open(base, _unsupported)
131
return control.open_branch(_unsupported)
134
def open_containing(url):
151
135
"""Open an existing branch which contains url.
153
137
This probes for a branch at url, and searches upwards from there.
155
139
Basically we keep looking up until we find the control directory or
156
140
run into the root. If there isn't one, raises NotBranchError.
157
If there is one and it is either an unrecognised format or an unsupported
141
If there is one and it is either an unrecognised format or an unsupported
158
142
format, UnknownFormatError or UnsupportedFormatError are raised.
159
143
If there is one, it is returned, along with the unused portion of url.
161
control, relpath = bzrdir.BzrDir.open_containing(url,
145
control, relpath = bzrdir.BzrDir.open_containing(url)
163
146
return control.open_branch(), relpath
165
def _push_should_merge_tags(self):
166
"""Should _basic_push merge this branch's tags into the target?
168
The default implementation returns False if this branch has no tags,
169
and True the rest of the time. Subclasses may override this.
171
return self.supports_tags() and self.tags.get_tag_dict()
149
@deprecated_function(zero_eight)
150
def initialize(base):
151
"""Create a new working tree and branch, rooted at 'base' (url)
153
NOTE: This will soon be deprecated in favour of creation
156
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
158
@deprecated_function(zero_eight)
159
def setup_caching(self, cache_root):
160
"""Subclasses that care about caching should override this, and set
161
up cached stores located under cache_root.
163
NOTE: This is unused.
173
167
def get_config(self):
174
168
return BranchConfig(self)
176
def _get_config(self):
177
"""Get the concrete config for just the config in this branch.
179
This is not intended for client use; see Branch.get_config for the
184
:return: An object supporting get_option and set_option.
186
raise NotImplementedError(self._get_config)
188
def _get_fallback_repository(self, url):
189
"""Get the repository we fallback to at url."""
190
url = urlutils.join(self.base, url)
191
a_bzrdir = bzrdir.BzrDir.open(url,
192
possible_transports=[self.bzrdir.root_transport])
193
return a_bzrdir.open_branch().repository
195
def _get_tags_bytes(self):
196
"""Get the bytes of a serialised tags dict.
198
Note that not all branches support tags, nor do all use the same tags
199
logic: this method is specific to BasicTags. Other tag implementations
200
may use the same method name and behave differently, safely, because
201
of the double-dispatch via
202
format.make_tags->tags_instance->get_tags_dict.
204
:return: The bytes of the tags file.
205
:seealso: Branch._set_tags_bytes.
207
return self._transport.get_bytes('tags')
209
def _get_nick(self, local=False, possible_transports=None):
210
config = self.get_config()
211
# explicit overrides master, but don't look for master if local is True
212
if not local and not config.has_explicit_nickname():
214
master = self.get_master_branch(possible_transports)
215
if master is not None:
216
# return the master branch value
218
except errors.BzrError, e:
219
# Silently fall back to local implicit nick if the master is
221
mutter("Could not connect to bound branch, "
222
"falling back to local nick.\n " + str(e))
223
return config.get_nickname()
171
return self.get_config().get_nickname()
225
173
def _set_nick(self, nick):
226
self.get_config().set_user_option('nickname', nick, warn_masked=True)
174
self.get_config().set_user_option('nickname', nick)
228
176
nick = property(_get_nick, _set_nick)
230
178
def is_locked(self):
231
179
raise NotImplementedError(self.is_locked)
233
def _lefthand_history(self, revision_id, last_rev=None,
235
if 'evil' in debug.debug_flags:
236
mutter_callsite(4, "_lefthand_history scales with history.")
237
# stop_revision must be a descendant of last_revision
238
graph = self.repository.get_graph()
239
if last_rev is not None:
240
if not graph.is_ancestor(last_rev, revision_id):
241
# our previous tip is not merged into stop_revision
242
raise errors.DivergedBranches(self, other_branch)
243
# make a new revision history from the graph
244
parents_map = graph.get_parent_map([revision_id])
245
if revision_id not in parents_map:
246
raise errors.NoSuchRevision(self, revision_id)
247
current_rev_id = revision_id
249
check_not_reserved_id = _mod_revision.check_not_reserved_id
250
# Do not include ghosts or graph origin in revision_history
251
while (current_rev_id in parents_map and
252
len(parents_map[current_rev_id]) > 0):
253
check_not_reserved_id(current_rev_id)
254
new_history.append(current_rev_id)
255
current_rev_id = parents_map[current_rev_id][0]
256
parents_map = graph.get_parent_map([current_rev_id])
257
new_history.reverse()
260
181
def lock_write(self):
261
182
raise NotImplementedError(self.lock_write)
273
194
def get_physical_lock_status(self):
274
195
raise NotImplementedError(self.get_physical_lock_status)
277
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
278
"""Return the revision_id for a dotted revno.
280
:param revno: a tuple like (1,) or (1,1,2)
281
:param _cache_reverse: a private parameter enabling storage
282
of the reverse mapping in a top level cache. (This should
283
only be done in selective circumstances as we want to
284
avoid having the mapping cached multiple times.)
285
:return: the revision_id
286
:raises errors.NoSuchRevision: if the revno doesn't exist
288
rev_id = self._do_dotted_revno_to_revision_id(revno)
290
self._partial_revision_id_to_revno_cache[rev_id] = revno
293
def _do_dotted_revno_to_revision_id(self, revno):
294
"""Worker function for dotted_revno_to_revision_id.
296
Subclasses should override this if they wish to
297
provide a more efficient implementation.
300
return self.get_rev_id(revno[0])
301
revision_id_to_revno = self.get_revision_id_to_revno_map()
302
revision_ids = [revision_id for revision_id, this_revno
303
in revision_id_to_revno.iteritems()
304
if revno == this_revno]
305
if len(revision_ids) == 1:
306
return revision_ids[0]
308
revno_str = '.'.join(map(str, revno))
309
raise errors.NoSuchRevision(self, revno_str)
312
def revision_id_to_dotted_revno(self, revision_id):
313
"""Given a revision id, return its dotted revno.
315
:return: a tuple like (1,) or (400,1,3).
317
return self._do_revision_id_to_dotted_revno(revision_id)
319
def _do_revision_id_to_dotted_revno(self, revision_id):
320
"""Worker function for revision_id_to_revno."""
321
# Try the caches if they are loaded
322
result = self._partial_revision_id_to_revno_cache.get(revision_id)
323
if result is not None:
325
if self._revision_id_to_revno_cache:
326
result = self._revision_id_to_revno_cache.get(revision_id)
328
raise errors.NoSuchRevision(self, revision_id)
329
# Try the mainline as it's optimised
331
revno = self.revision_id_to_revno(revision_id)
333
except errors.NoSuchRevision:
334
# We need to load and use the full revno map after all
335
result = self.get_revision_id_to_revno_map().get(revision_id)
337
raise errors.NoSuchRevision(self, revision_id)
341
def get_revision_id_to_revno_map(self):
342
"""Return the revision_id => dotted revno map.
344
This will be regenerated on demand, but will be cached.
346
:return: A dictionary mapping revision_id => dotted revno.
347
This dictionary should not be modified by the caller.
349
if self._revision_id_to_revno_cache is not None:
350
mapping = self._revision_id_to_revno_cache
352
mapping = self._gen_revno_map()
353
self._cache_revision_id_to_revno(mapping)
354
# TODO: jam 20070417 Since this is being cached, should we be returning
356
# I would rather not, and instead just declare that users should not
357
# modify the return value.
360
def _gen_revno_map(self):
361
"""Create a new mapping from revision ids to dotted revnos.
363
Dotted revnos are generated based on the current tip in the revision
365
This is the worker function for get_revision_id_to_revno_map, which
366
just caches the return value.
368
:return: A dictionary mapping revision_id => dotted revno.
370
revision_id_to_revno = dict((rev_id, revno)
371
for rev_id, depth, revno, end_of_merge
372
in self.iter_merge_sorted_revisions())
373
return revision_id_to_revno
376
def iter_merge_sorted_revisions(self, start_revision_id=None,
377
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
378
"""Walk the revisions for a branch in merge sorted order.
380
Merge sorted order is the output from a merge-aware,
381
topological sort, i.e. all parents come before their
382
children going forward; the opposite for reverse.
384
:param start_revision_id: the revision_id to begin walking from.
385
If None, the branch tip is used.
386
:param stop_revision_id: the revision_id to terminate the walk
387
after. If None, the rest of history is included.
388
:param stop_rule: if stop_revision_id is not None, the precise rule
389
to use for termination:
390
* 'exclude' - leave the stop revision out of the result (default)
391
* 'include' - the stop revision is the last item in the result
392
* 'with-merges' - include the stop revision and all of its
393
merged revisions in the result
394
:param direction: either 'reverse' or 'forward':
395
* reverse means return the start_revision_id first, i.e.
396
start at the most recent revision and go backwards in history
397
* forward returns tuples in the opposite order to reverse.
398
Note in particular that forward does *not* do any intelligent
399
ordering w.r.t. depth as some clients of this API may like.
400
(If required, that ought to be done at higher layers.)
402
:return: an iterator over (revision_id, depth, revno, end_of_merge)
405
* revision_id: the unique id of the revision
406
* depth: How many levels of merging deep this node has been
408
* revno_sequence: This field provides a sequence of
409
revision numbers for all revisions. The format is:
410
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
411
branch that the revno is on. From left to right the REVNO numbers
412
are the sequence numbers within that branch of the revision.
413
* end_of_merge: When True the next node (earlier in history) is
414
part of a different merge.
416
# Note: depth and revno values are in the context of the branch so
417
# we need the full graph to get stable numbers, regardless of the
419
if self._merge_sorted_revisions_cache is None:
420
last_revision = self.last_revision()
421
graph = self.repository.get_graph()
422
parent_map = dict(((key, value) for key, value in
423
graph.iter_ancestry([last_revision]) if value is not None))
424
revision_graph = repository._strip_NULL_ghosts(parent_map)
425
revs = tsort.merge_sort(revision_graph, last_revision, None,
427
# Drop the sequence # before caching
428
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
430
filtered = self._filter_merge_sorted_revisions(
431
self._merge_sorted_revisions_cache, start_revision_id,
432
stop_revision_id, stop_rule)
433
if direction == 'reverse':
435
if direction == 'forward':
436
return reversed(list(filtered))
438
raise ValueError('invalid direction %r' % direction)
440
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
441
start_revision_id, stop_revision_id, stop_rule):
442
"""Iterate over an inclusive range of sorted revisions."""
443
rev_iter = iter(merge_sorted_revisions)
444
if start_revision_id is not None:
445
for rev_id, depth, revno, end_of_merge in rev_iter:
446
if rev_id != start_revision_id:
449
# The decision to include the start or not
450
# depends on the stop_rule if a stop is provided
452
iter([(rev_id, depth, revno, end_of_merge)]),
455
if stop_revision_id is None:
456
for rev_id, depth, revno, end_of_merge in rev_iter:
457
yield rev_id, depth, revno, end_of_merge
458
elif stop_rule == 'exclude':
459
for rev_id, depth, revno, end_of_merge in rev_iter:
460
if rev_id == stop_revision_id:
462
yield rev_id, depth, revno, end_of_merge
463
elif stop_rule == 'include':
464
for rev_id, depth, revno, end_of_merge in rev_iter:
465
yield rev_id, depth, revno, end_of_merge
466
if rev_id == stop_revision_id:
468
elif stop_rule == 'with-merges':
469
stop_rev = self.repository.get_revision(stop_revision_id)
470
if stop_rev.parent_ids:
471
left_parent = stop_rev.parent_ids[0]
473
left_parent = _mod_revision.NULL_REVISION
474
for rev_id, depth, revno, end_of_merge in rev_iter:
475
if rev_id == left_parent:
477
yield rev_id, depth, revno, end_of_merge
479
raise ValueError('invalid stop_rule %r' % stop_rule)
481
def leave_lock_in_place(self):
482
"""Tell this branch object not to release the physical lock when this
485
If lock_write doesn't return a token, then this method is not supported.
487
self.control_files.leave_in_place()
489
def dont_leave_lock_in_place(self):
490
"""Tell this branch object to release the physical lock when this
491
object is unlocked, even if it didn't originally acquire it.
493
If lock_write doesn't return a token, then this method is not supported.
495
self.control_files.dont_leave_in_place()
197
def abspath(self, name):
198
"""Return absolute filename for something in the branch
200
XXX: Robert Collins 20051017 what is this used for? why is it a branch
201
method and not a tree method.
203
raise NotImplementedError(self.abspath)
497
205
def bind(self, other):
498
206
"""Bind the local branch the other branch.
583
291
The delta is relative to its mainline predecessor, or the
584
292
empty tree for revision 1.
294
assert isinstance(revno, int)
586
295
rh = self.revision_history()
587
296
if not (1 <= revno <= len(rh)):
588
raise errors.InvalidRevisionNumber(revno)
297
raise InvalidRevisionNumber(revno)
589
298
return self.repository.get_revision_delta(rh[revno-1])
591
def get_stacked_on_url(self):
592
"""Get the URL this branch is stacked against.
300
@deprecated_method(zero_sixteen)
301
def get_root_id(self):
302
"""Return the id of this branches root
594
:raises NotStacked: If the branch is not stacked.
595
:raises UnstackableBranchFormat: If the branch does not support
304
Deprecated: branches don't have root ids-- trees do.
305
Use basis_tree().get_root_id() instead.
598
raise NotImplementedError(self.get_stacked_on_url)
307
raise NotImplementedError(self.get_root_id)
600
309
def print_file(self, file, revision_id):
601
310
"""Print `file` to stdout."""
602
311
raise NotImplementedError(self.print_file)
313
def append_revision(self, *revision_ids):
314
raise NotImplementedError(self.append_revision)
604
316
def set_revision_history(self, rev_history):
605
317
raise NotImplementedError(self.set_revision_history)
608
def set_parent(self, url):
609
"""See Branch.set_parent."""
610
# TODO: Maybe delete old location files?
611
# URLs should never be unicode, even on the local fs,
612
# FIXUP this and get_parent in a future branch format bump:
613
# read and rewrite the file. RBC 20060125
615
if isinstance(url, unicode):
617
url = url.encode('ascii')
618
except UnicodeEncodeError:
619
raise errors.InvalidURL(url,
620
"Urls must be 7-bit ascii, "
621
"use bzrlib.urlutils.escape")
622
url = urlutils.relative_url(self.base, url)
623
self._set_parent_location(url)
626
def set_stacked_on_url(self, url):
627
"""Set the URL this branch is stacked against.
629
:raises UnstackableBranchFormat: If the branch does not support
631
:raises UnstackableRepositoryFormat: If the repository does not support
634
if not self._format.supports_stacking():
635
raise errors.UnstackableBranchFormat(self._format, self.base)
636
self._check_stackable_repo()
639
old_url = self.get_stacked_on_url()
640
except (errors.NotStacked, errors.UnstackableBranchFormat,
641
errors.UnstackableRepositoryFormat):
644
# XXX: Lock correctness - should unlock our old repo if we were
646
# repositories don't offer an interface to remove fallback
647
# repositories today; take the conceptually simpler option and just
649
self.repository = self.bzrdir.find_repository()
650
self.repository.lock_write()
651
# for every revision reference the branch has, ensure it is pulled
653
source_repository = self._get_fallback_repository(old_url)
654
for revision_id in chain([self.last_revision()],
655
self.tags.get_reverse_tag_dict()):
656
self.repository.fetch(source_repository, revision_id,
659
self._activate_fallback_location(url, 'write')
660
# write this out after the repository is stacked to avoid setting a
661
# stacked config that doesn't work.
662
self._set_config_location('stacked_on_location', url)
665
def _set_tags_bytes(self, bytes):
666
"""Mirror method for _get_tags_bytes.
668
:seealso: Branch._get_tags_bytes.
670
return _run_with_write_locked_target(self, self._transport.put_bytes,
673
319
def _cache_revision_history(self, rev_history):
674
320
"""Set the cached revision history to rev_history.
786
416
common_index = min(self_len, other_len) -1
787
417
if common_index >= 0 and \
788
418
self_history[common_index] != other_history[common_index]:
789
raise errors.DivergedBranches(self, other)
419
raise DivergedBranches(self, other)
791
421
if stop_revision is None:
792
422
stop_revision = other_len
424
assert isinstance(stop_revision, int)
794
425
if stop_revision > other_len:
795
426
raise errors.NoSuchRevision(self, stop_revision)
796
427
return other_history[self_len:stop_revision]
799
def update_revisions(self, other, stop_revision=None, overwrite=False,
429
def update_revisions(self, other, stop_revision=None):
801
430
"""Pull in new perfect-fit revisions.
803
432
:param other: Another Branch to pull from
804
433
:param stop_revision: Updated until the given revision
805
:param overwrite: Always set the branch pointer, rather than checking
806
to see if it is a proper descendant.
807
:param graph: A Graph object that can be used to query history
808
information. This can be None.
811
return InterBranch.get(other, self).update_revisions(stop_revision,
814
def import_last_revision_info(self, source_repo, revno, revid):
815
"""Set the last revision info, importing from another repo if necessary.
817
This is used by the bound branch code to upload a revision to
818
the master branch first before updating the tip of the local branch.
820
:param source_repo: Source repository to optionally fetch from
821
:param revno: Revision number of the new tip
822
:param revid: Revision id of the new tip
824
if not self.repository.has_same_location(source_repo):
825
self.repository.fetch(source_repo, revision_id=revid)
826
self.set_last_revision_info(revno, revid)
436
raise NotImplementedError(self.update_revisions)
828
438
def revision_id_to_revno(self, revision_id):
829
439
"""Given a revision id, return its revno"""
830
if _mod_revision.is_null(revision_id):
440
if revision_id is None:
442
revision_id = osutils.safe_revision_id(revision_id)
832
443
history = self.revision_history()
834
445
return history.index(revision_id) + 1
835
446
except ValueError:
836
raise errors.NoSuchRevision(self, revision_id)
447
raise bzrlib.errors.NoSuchRevision(self, revision_id)
838
449
def get_rev_id(self, revno, history=None):
839
450
"""Find the revision id of the specified revno."""
841
return _mod_revision.NULL_REVISION
842
453
if history is None:
843
454
history = self.revision_history()
844
455
if revno <= 0 or revno > len(history):
845
raise errors.NoSuchRevision(self, revno)
456
raise bzrlib.errors.NoSuchRevision(self, revno)
846
457
return history[revno - 1]
848
def pull(self, source, overwrite=False, stop_revision=None,
849
possible_transports=None, _override_hook_target=None):
459
def pull(self, source, overwrite=False, stop_revision=None):
850
460
"""Mirror source into this branch.
852
462
This branch is considered to be 'local', having low latency.
856
466
raise NotImplementedError(self.pull)
858
def push(self, target, overwrite=False, stop_revision=None, *args,
468
def push(self, target, overwrite=False, stop_revision=None):
860
469
"""Mirror this branch into target.
862
471
This branch is considered to be 'local', having low latency.
864
return InterBranch.get(self, target).push(overwrite, stop_revision,
473
raise NotImplementedError(self.push)
867
475
def basis_tree(self):
868
476
"""Return `Tree` object for last revision."""
869
477
return self.repository.revision_tree(self.last_revision())
479
def rename_one(self, from_rel, to_rel):
482
This can change the directory or the filename or both.
484
raise NotImplementedError(self.rename_one)
486
def move(self, from_paths, to_name):
489
to_name must exist as a versioned directory.
491
If to_name exists and is a directory, the files are moved into
492
it, keeping their old names. If it is a directory,
494
Note that to_name is only the last component of the new name;
495
this doesn't change the directory.
497
This returns a list of (from_path, to_path) pairs for each
500
raise NotImplementedError(self.move)
871
502
def get_parent(self):
872
503
"""Return the parent location of the branch.
874
This is the default location for pull/missing. The usual
505
This is the default location for push/pull/missing. The usual
875
506
pattern is that the user can override it by specifying a
878
parent = self._get_parent_location()
881
# This is an old-format absolute path to a local branch
883
if parent.startswith('/'):
884
parent = urlutils.local_path_to_url(parent.decode('utf8'))
886
return urlutils.join(self.base[:-1], parent)
887
except errors.InvalidURLJoin, e:
888
raise errors.InaccessibleParent(parent, self.base)
890
def _get_parent_location(self):
891
raise NotImplementedError(self._get_parent_location)
509
raise NotImplementedError(self.get_parent)
893
511
def _set_config_location(self, name, url, config=None,
894
512
make_relative=False):
946
563
def get_push_location(self):
947
564
"""Return the None or the location to push this branch to."""
948
push_loc = self.get_config().get_user_option('push_location')
565
raise NotImplementedError(self.get_push_location)
951
567
def set_push_location(self, location):
952
568
"""Set a new push location for this branch."""
953
569
raise NotImplementedError(self.set_push_location)
955
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
956
"""Run the post_change_branch_tip hooks."""
957
hooks = Branch.hooks['post_change_branch_tip']
960
new_revno, new_revid = self.last_revision_info()
961
params = ChangeBranchTipParams(
962
self, old_revno, new_revno, old_revid, new_revid)
966
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
967
"""Run the pre_change_branch_tip hooks."""
968
hooks = Branch.hooks['pre_change_branch_tip']
971
old_revno, old_revid = self.last_revision_info()
972
params = ChangeBranchTipParams(
973
self, old_revno, new_revno, old_revid, new_revid)
977
except errors.TipChangeRejected:
980
exc_info = sys.exc_info()
981
hook_name = Branch.hooks.get_hook_name(hook)
982
raise errors.HookFailed(
983
'pre_change_branch_tip', hook_name, exc_info)
571
def set_parent(self, url):
572
raise NotImplementedError(self.set_parent)
985
574
@needs_write_lock
986
575
def update(self):
987
"""Synchronise this branch with the master branch if any.
576
"""Synchronise this branch with the master branch if any.
989
578
:return: None or the last_revision pivoted out during the update.
999
588
self.check_real_revno(revno)
1001
590
def check_real_revno(self, revno):
1003
592
Check whether a revno corresponds to a real revision.
1004
593
Zero (the NULL revision) is considered invalid
1006
595
if revno < 1 or revno > self.revno():
1007
raise errors.InvalidRevisionNumber(revno)
596
raise InvalidRevisionNumber(revno)
1009
598
@needs_read_lock
1010
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
599
def clone(self, to_bzrdir, revision_id=None):
1011
600
"""Clone this branch into to_bzrdir preserving all semantic values.
1013
Most API users will want 'create_clone_on_transport', which creates a
1014
new bzrdir and branch on the fly.
1016
602
revision_id: if not None, the revision history in the new branch will
1017
603
be truncated to end with revision_id.
1019
result = to_bzrdir.create_branch()
1022
if repository_policy is not None:
1023
repository_policy.configure_branch(result)
1024
self.copy_content_into(result, revision_id=revision_id)
605
result = self._format.initialize(to_bzrdir)
606
self.copy_content_into(result, revision_id=revision_id)
1029
609
@needs_read_lock
1030
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
610
def sprout(self, to_bzrdir, revision_id=None):
1031
611
"""Create a new line of development from the branch, into to_bzrdir.
1033
to_bzrdir controls the branch format.
1035
613
revision_id: if not None, the revision history in the new branch will
1036
614
be truncated to end with revision_id.
1038
result = to_bzrdir.create_branch()
1041
if repository_policy is not None:
1042
repository_policy.configure_branch(result)
1043
self.copy_content_into(result, revision_id=revision_id)
1044
result.set_parent(self.bzrdir.root_transport.base)
616
result = self._format.initialize(to_bzrdir)
617
self.copy_content_into(result, revision_id=revision_id)
618
result.set_parent(self.bzrdir.root_transport.base)
1049
621
def _synchronize_history(self, destination, revision_id):
1050
622
"""Synchronize last revision and revision history between branches.
1052
624
This version is most efficient when the destination is also a
1053
BzrBranch6, but works for BzrBranch5, as long as the destination's
1054
repository contains all the lefthand ancestors of the intended
1055
last_revision. If not, set_last_revision_info will fail.
625
BzrBranch5, but works for BzrBranch6 as long as the revision
626
history is the true lefthand parent history, and all of the revisions
627
are in the destination's repository. If not, set_revision_history
1057
630
:param destination: The branch to copy the history into
1058
631
:param revision_id: The revision-id to truncate history at. May
1059
632
be None to copy complete history.
1061
source_revno, source_revision_id = self.last_revision_info()
1062
if revision_id is None:
1063
revno, revision_id = source_revno, source_revision_id
1064
elif source_revision_id == revision_id:
1065
# we know the revno without needing to walk all of history
1066
revno = source_revno
1068
# To figure out the revno for a random revision, we need to build
1069
# the revision history, and count its length.
1070
# We don't care about the order, just how long it is.
1071
# Alternatively, we could start at the current location, and count
1072
# backwards. But there is no guarantee that we will find it since
1073
# it may be a merged revision.
1074
revno = len(list(self.repository.iter_reverse_revision_history(
1076
destination.set_last_revision_info(revno, revision_id)
634
new_history = self.revision_history()
635
if revision_id is not None:
636
revision_id = osutils.safe_revision_id(revision_id)
638
new_history = new_history[:new_history.index(revision_id) + 1]
640
rev = self.repository.get_revision(revision_id)
641
new_history = rev.get_history(self.repository)[1:]
642
destination.set_revision_history(new_history)
1078
644
@needs_read_lock
1079
645
def copy_content_into(self, destination, revision_id=None):
1093
658
destination.set_parent(parent)
1094
if self._push_should_merge_tags():
1095
self.tags.merge_to(destination.tags)
1097
def update_references(self, target):
1098
if not getattr(self._format, 'supports_reference_locations', False):
1100
reference_dict = self._get_all_reference_info()
1101
if len(reference_dict) == 0:
1103
old_base = self.base
1104
new_base = target.base
1105
target_reference_dict = target._get_all_reference_info()
1106
for file_id, (tree_path, branch_location) in (
1107
reference_dict.items()):
1108
branch_location = urlutils.rebase_url(branch_location,
1110
target_reference_dict.setdefault(
1111
file_id, (tree_path, branch_location))
1112
target._set_all_reference_info(target_reference_dict)
659
self.tags.merge_to(destination.tags)
1114
661
@needs_read_lock
1115
662
def check(self):
1116
663
"""Check consistency of the branch.
1118
665
In particular this checks that revisions given in the revision-history
1119
do actually match up in the revision graph, and that they're all
666
do actually match up in the revision graph, and that they're all
1120
667
present in the repository.
1122
669
Callers will typically also want to check the repository.
1124
671
:return: A BranchCheckResult.
1126
673
mainline_parent_id = None
1127
last_revno, last_revision_id = self.last_revision_info()
1128
real_rev_history = list(self.repository.iter_reverse_revision_history(
1130
real_rev_history.reverse()
1131
if len(real_rev_history) != last_revno:
1132
raise errors.BzrCheckError('revno does not match len(mainline)'
1133
' %s != %s' % (last_revno, len(real_rev_history)))
1134
# TODO: We should probably also check that real_rev_history actually
1135
# matches self.revision_history()
1136
for revision_id in real_rev_history:
674
for revision_id in self.revision_history():
1138
676
revision = self.repository.get_revision(revision_id)
1139
677
except errors.NoSuchRevision, e:
1163
701
format.set_branch_format(self._format)
1166
def create_clone_on_transport(self, to_transport, revision_id=None,
1167
stacked_on=None, create_prefix=False, use_existing_dir=False):
1168
"""Create a clone of this branch and its bzrdir.
1170
:param to_transport: The transport to clone onto.
1171
:param revision_id: The revision id to use as tip in the new branch.
1172
If None the tip is obtained from this branch.
1173
:param stacked_on: An optional URL to stack the clone on.
1174
:param create_prefix: Create any missing directories leading up to
1176
:param use_existing_dir: Use an existing directory if one exists.
1178
# XXX: Fix the bzrdir API to allow getting the branch back from the
1179
# clone call. Or something. 20090224 RBC/spiv.
1180
if revision_id is None:
1181
revision_id = self.last_revision()
1183
dir_to = self.bzrdir.clone_on_transport(to_transport,
1184
revision_id=revision_id, stacked_on=stacked_on,
1185
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1186
except errors.FileExists:
1187
if not use_existing_dir:
1189
except errors.NoSuchFile:
1190
if not create_prefix:
1192
return dir_to.open_branch()
1194
704
def create_checkout(self, to_location, revision_id=None,
1195
lightweight=False, accelerator_tree=None,
1197
706
"""Create a checkout of a branch.
1199
708
:param to_location: The url to produce the checkout at
1200
709
:param revision_id: The revision to check out
1201
710
:param lightweight: If True, produce a lightweight checkout, otherwise,
1202
711
produce a bound branch (heavyweight checkout)
1203
:param accelerator_tree: A tree which can be used for retrieving file
1204
contents more quickly than the revision tree, i.e. a workingtree.
1205
The revision tree will be used for cases where accelerator_tree's
1206
content is different.
1207
:param hardlink: If true, hard-link files from accelerator_tree,
1209
712
:return: The tree of the created checkout
1211
714
t = transport.get_transport(to_location)
717
except errors.FileExists:
1214
720
format = self._get_checkout_format()
1215
721
checkout = format.initialize_on_transport(t)
1216
from_branch = BranchReferenceFormat().initialize(checkout, self)
722
BranchReferenceFormat().initialize(checkout, self)
1218
724
format = self._get_checkout_format()
1219
725
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1220
726
to_location, force_new_tree=False, format=format)
1221
727
checkout = checkout_branch.bzrdir
1222
728
checkout_branch.bind(self)
1223
# pull up to the specified revision_id to set the initial
729
# pull up to the specified revision_id to set the initial
1224
730
# branch tip correctly, and seed it with history.
1225
731
checkout_branch.pull(self, stop_revision=revision_id)
1227
tree = checkout.create_workingtree(revision_id,
1228
from_branch=from_branch,
1229
accelerator_tree=accelerator_tree,
732
tree = checkout.create_workingtree(revision_id)
1231
733
basis_tree = tree.basis_tree()
1232
734
basis_tree.lock_read()
1240
742
basis_tree.unlock()
1244
def reconcile(self, thorough=True):
1245
"""Make sure the data stored in this branch is consistent."""
1246
from bzrlib.reconcile import BranchReconciler
1247
reconciler = BranchReconciler(self, thorough=thorough)
1248
reconciler.reconcile()
1251
def reference_parent(self, file_id, path, possible_transports=None):
745
def reference_parent(self, file_id, path):
1252
746
"""Return the parent branch for a tree-reference file_id
1253
747
:param file_id: The file_id of the tree reference
1254
748
:param path: The path of the file_id in the tree
1255
749
:return: A branch associated with the file_id
1257
751
# FIXME should provide multiple branches, based on config
1258
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1259
possible_transports=possible_transports)
752
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1261
754
def supports_tags(self):
1262
755
return self._format.supports_tags()
1264
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1266
"""Ensure that revision_b is a descendant of revision_a.
1268
This is a helper function for update_revisions.
1270
:raises: DivergedBranches if revision_b has diverged from revision_a.
1271
:returns: True if revision_b is a descendant of revision_a.
1273
relation = self._revision_relations(revision_a, revision_b, graph)
1274
if relation == 'b_descends_from_a':
1276
elif relation == 'diverged':
1277
raise errors.DivergedBranches(self, other_branch)
1278
elif relation == 'a_descends_from_b':
1281
raise AssertionError("invalid relation: %r" % (relation,))
1283
def _revision_relations(self, revision_a, revision_b, graph):
1284
"""Determine the relationship between two revisions.
1286
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1288
heads = graph.heads([revision_a, revision_b])
1289
if heads == set([revision_b]):
1290
return 'b_descends_from_a'
1291
elif heads == set([revision_a, revision_b]):
1292
# These branches have diverged
1294
elif heads == set([revision_a]):
1295
return 'a_descends_from_b'
1297
raise AssertionError("invalid heads: %r" % (heads,))
1300
758
class BranchFormat(object):
1301
759
"""An encapsulation of the initialization and open routines for a format.
1427
844
"""Is this format supported?
1429
846
Supported formats can be initialized and opened.
1430
Unsupported formats may not support initialization or committing or
847
Unsupported formats may not support initialization or committing or
1431
848
some other features depending on the reason for not being supported.
1435
def make_tags(self, branch):
1436
"""Create a tags object for branch.
1438
This method is on BranchFormat, because BranchFormats are reflected
1439
over the wire via network_name(), whereas full Branch instances require
1440
multiple VFS method calls to operate at all.
1442
The default implementation returns a disabled-tags instance.
1444
Note that it is normal for branch to be a RemoteBranch when using tags
1447
return DisabledTags(branch)
1449
def network_name(self):
1450
"""A simple byte string uniquely identifying this format for RPC calls.
1452
MetaDir branch formats use their disk format string to identify the
1453
repository over the wire. All in one formats such as bzr < 0.8, and
1454
foreign formats like svn/git and hg should use some marker which is
1455
unique and immutable.
1457
raise NotImplementedError(self.network_name)
1459
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
852
def open(self, a_bzrdir, _found=False):
1460
853
"""Return the branch object for a_bzrdir
1462
:param a_bzrdir: A BzrDir that contains a branch.
1463
:param _found: a private parameter, do not use it. It is used to
1464
indicate if format probing has already be done.
1465
:param ignore_fallbacks: when set, no fallback branches will be opened
1466
(if there are any). Default is to open fallbacks.
855
_found is a private parameter, do not use it. It is used to indicate
856
if format probing has already be done.
1468
858
raise NotImplementedError(self.open)
1471
861
def register_format(klass, format):
1472
"""Register a metadir format."""
1473
862
klass._formats[format.get_format_string()] = format
1474
# Metadir formats have a network name of their format string, and get
1475
# registered as class factories.
1476
network_format_registry.register(format.get_format_string(), format.__class__)
1479
865
def set_default_format(klass, format):
1480
866
klass._default_format = format
1482
def supports_stacking(self):
1483
"""True if this format records a stacked-on branch."""
1487
869
def unregister_format(klass, format):
870
assert klass._formats[format.get_format_string()] is format
1488
871
del klass._formats[format.get_format_string()]
1490
873
def __str__(self):
1491
return self.get_format_description().rstrip()
874
return self.get_format_string().rstrip()
1493
876
def supports_tags(self):
1494
877
"""True if this format supports tags stored in the branch"""
1495
878
return False # by default
1498
class BranchHooks(Hooks):
880
# XXX: Probably doesn't really belong here -- mbp 20070212
881
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
883
branch_transport = a_bzrdir.get_branch_transport(self)
884
control_files = lockable_files.LockableFiles(branch_transport,
885
lock_filename, lock_class)
886
control_files.create_lock()
887
control_files.lock_write()
889
for filename, content in utf8_files:
890
control_files.put_utf8(filename, content)
892
control_files.unlock()
895
class BranchHooks(dict):
1499
896
"""A dictionary mapping hook name to a list of callables for branch hooks.
1501
898
e.g. ['set_rh'] Is the list of items to be called when the
1502
899
set_revision_history function is invoked.
1508
905
These are all empty initially, because by default nothing should get
1511
Hooks.__init__(self)
1512
self.create_hook(HookPoint('set_rh',
1513
"Invoked whenever the revision history has been set via "
1514
"set_revision_history. The api signature is (branch, "
1515
"revision_history), and the branch will be write-locked. "
1516
"The set_rh hook can be expensive for bzr to trigger, a better "
1517
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1518
self.create_hook(HookPoint('open',
1519
"Called with the Branch object that has been opened after a "
1520
"branch is opened.", (1, 8), None))
1521
self.create_hook(HookPoint('post_push',
1522
"Called after a push operation completes. post_push is called "
1523
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1524
"bzr client.", (0, 15), None))
1525
self.create_hook(HookPoint('post_pull',
1526
"Called after a pull operation completes. post_pull is called "
1527
"with a bzrlib.branch.PullResult object and only runs in the "
1528
"bzr client.", (0, 15), None))
1529
self.create_hook(HookPoint('pre_commit',
1530
"Called after a commit is calculated but before it is is "
1531
"completed. pre_commit is called with (local, master, old_revno, "
1532
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1533
"). old_revid is NULL_REVISION for the first commit to a branch, "
1534
"tree_delta is a TreeDelta object describing changes from the "
1535
"basis revision. hooks MUST NOT modify this delta. "
1536
" future_tree is an in-memory tree obtained from "
1537
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1538
"tree.", (0,91), None))
1539
self.create_hook(HookPoint('post_commit',
1540
"Called in the bzr client after a commit has completed. "
1541
"post_commit is called with (local, master, old_revno, old_revid, "
1542
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1543
"commit to a branch.", (0, 15), None))
1544
self.create_hook(HookPoint('post_uncommit',
1545
"Called in the bzr client after an uncommit completes. "
1546
"post_uncommit is called with (local, master, old_revno, "
1547
"old_revid, new_revno, new_revid) where local is the local branch "
1548
"or None, master is the target branch, and an empty branch "
1549
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1550
self.create_hook(HookPoint('pre_change_branch_tip',
1551
"Called in bzr client and server before a change to the tip of a "
1552
"branch is made. pre_change_branch_tip is called with a "
1553
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1554
"commit, uncommit will all trigger this hook.", (1, 6), None))
1555
self.create_hook(HookPoint('post_change_branch_tip',
1556
"Called in bzr client and server after a change to the tip of a "
1557
"branch is made. post_change_branch_tip is called with a "
1558
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1559
"commit, uncommit will all trigger this hook.", (1, 4), None))
1560
self.create_hook(HookPoint('transform_fallback_location',
1561
"Called when a stacked branch is activating its fallback "
1562
"locations. transform_fallback_location is called with (branch, "
1563
"url), and should return a new url. Returning the same url "
1564
"allows it to be used as-is, returning a different one can be "
1565
"used to cause the branch to stack on a closer copy of that "
1566
"fallback_location. Note that the branch cannot have history "
1567
"accessing methods called on it during this hook because the "
1568
"fallback locations have not been activated. When there are "
1569
"multiple hooks installed for transform_fallback_location, "
1570
"all are called with the url returned from the previous hook."
1571
"The order is however undefined.", (1, 9), None))
909
# Introduced in 0.15:
910
# invoked whenever the revision history has been set
911
# with set_revision_history. The api signature is
912
# (branch, revision_history), and the branch will
915
# invoked after a push operation completes.
916
# the api signature is
918
# containing the members
919
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
920
# where local is the local branch or None, master is the target
921
# master branch, and the rest should be self explanatory. The source
922
# is read locked and the target branches write locked. Source will
923
# be the local low-latency branch.
924
self['post_push'] = []
925
# invoked after a pull operation completes.
926
# the api signature is
928
# containing the members
929
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
930
# where local is the local branch or None, master is the target
931
# master branch, and the rest should be self explanatory. The source
932
# is read locked and the target branches write locked. The local
933
# branch is the low-latency branch.
934
self['post_pull'] = []
935
# invoked after a commit operation completes.
936
# the api signature is
937
# (local, master, old_revno, old_revid, new_revno, new_revid)
938
# old_revid is NULL_REVISION for the first commit to a branch.
939
self['post_commit'] = []
940
# invoked after a uncommit operation completes.
941
# the api signature is
942
# (local, master, old_revno, old_revid, new_revno, new_revid) where
943
# local is the local branch or None, master is the target branch,
944
# and an empty branch recieves new_revno of 0, new_revid of None.
945
self['post_uncommit'] = []
947
def install_hook(self, hook_name, a_callable):
948
"""Install a_callable in to the hook hook_name.
950
:param hook_name: A hook name. See the __init__ method of BranchHooks
951
for the complete list of hooks.
952
:param a_callable: The callable to be invoked when the hook triggers.
953
The exact signature will depend on the hook - see the __init__
954
method of BranchHooks for details on each hook.
957
self[hook_name].append(a_callable)
959
raise errors.UnknownHook('branch', hook_name)
1574
962
# install the default hooks into the Branch class.
1575
963
Branch.hooks = BranchHooks()
1578
class ChangeBranchTipParams(object):
1579
"""Object holding parameters passed to *_change_branch_tip hooks.
1581
There are 5 fields that hooks may wish to access:
1583
:ivar branch: the branch being changed
1584
:ivar old_revno: revision number before the change
1585
:ivar new_revno: revision number after the change
1586
:ivar old_revid: revision id before the change
1587
:ivar new_revid: revision id after the change
1589
The revid fields are strings. The revno fields are integers.
1592
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1593
"""Create a group of ChangeBranchTip parameters.
1595
:param branch: The branch being changed.
1596
:param old_revno: Revision number before the change.
1597
:param new_revno: Revision number after the change.
1598
:param old_revid: Tip revision id before the change.
1599
:param new_revid: Tip revision id after the change.
1601
self.branch = branch
1602
self.old_revno = old_revno
1603
self.new_revno = new_revno
1604
self.old_revid = old_revid
1605
self.new_revid = new_revid
1607
def __eq__(self, other):
1608
return self.__dict__ == other.__dict__
1611
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1612
self.__class__.__name__, self.branch,
1613
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1616
966
class BzrBranchFormat4(BranchFormat):
1617
967
"""Bzr branch format 4.
1757
1076
def initialize(self, a_bzrdir):
1758
1077
"""Create a branch of this format in a_bzrdir."""
1759
1078
utf8_files = [('last-revision', '0 null:\n'),
1760
('branch.conf', ''),
1763
return self._initialize_helper(a_bzrdir, utf8_files)
1765
def make_tags(self, branch):
1766
"""See bzrlib.branch.BranchFormat.make_tags()."""
1767
return BasicTags(branch)
1771
class BzrBranchFormat8(BranchFormatMetadir):
1772
"""Metadir format supporting storing locations of subtree branches."""
1774
def _branch_class(self):
1777
def get_format_string(self):
1778
"""See BranchFormat.get_format_string()."""
1779
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1781
def get_format_description(self):
1782
"""See BranchFormat.get_format_description()."""
1783
return "Branch format 8"
1785
def initialize(self, a_bzrdir):
1786
"""Create a branch of this format in a_bzrdir."""
1787
utf8_files = [('last-revision', '0 null:\n'),
1788
('branch.conf', ''),
1792
return self._initialize_helper(a_bzrdir, utf8_files)
1795
super(BzrBranchFormat8, self).__init__()
1796
self._matchingbzrdir.repository_format = \
1797
RepositoryFormatKnitPack5RichRoot()
1799
def make_tags(self, branch):
1800
"""See bzrlib.branch.BranchFormat.make_tags()."""
1801
return BasicTags(branch)
1803
def supports_stacking(self):
1079
('branch-name', ''),
1080
('branch.conf', ''),
1083
return self._initialize_helper(a_bzrdir, utf8_files)
1085
def open(self, a_bzrdir, _found=False):
1086
"""Return the branch object for a_bzrdir
1088
_found is a private parameter, do not use it. It is used to indicate
1089
if format probing has already be done.
1092
format = BranchFormat.find_format(a_bzrdir)
1093
assert format.__class__ == self.__class__
1094
transport = a_bzrdir.get_branch_transport(None)
1095
control_files = lockable_files.LockableFiles(transport, 'lock',
1097
return BzrBranch6(_format=self,
1098
_control_files=control_files,
1100
_repository=a_bzrdir.find_repository())
1102
def supports_tags(self):
1806
supports_reference_locations = True
1809
class BzrBranchFormat7(BzrBranchFormat8):
1810
"""Branch format with last-revision, tags, and a stacked location pointer.
1812
The stacked location pointer is passed down to the repository and requires
1813
a repository format with supports_external_lookups = True.
1815
This format was introduced in bzr 1.6.
1818
def initialize(self, a_bzrdir):
1819
"""Create a branch of this format in a_bzrdir."""
1820
utf8_files = [('last-revision', '0 null:\n'),
1821
('branch.conf', ''),
1824
return self._initialize_helper(a_bzrdir, utf8_files)
1826
def _branch_class(self):
1829
def get_format_string(self):
1830
"""See BranchFormat.get_format_string()."""
1831
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1833
def get_format_description(self):
1834
"""See BranchFormat.get_format_description()."""
1835
return "Branch format 7"
1837
supports_reference_locations = False
1840
1106
class BranchReferenceFormat(BranchFormat):
1841
1107
"""Bzr branch reference format.
2006
1222
base = property(_get_base, doc="The URL for the root of this branch.")
2008
def _get_config(self):
2009
return TransportConfig(self._transport, 'branch.conf')
1224
def abspath(self, name):
1225
"""See Branch.abspath."""
1226
return self.control_files._transport.abspath(name)
1229
@deprecated_method(zero_sixteen)
1231
def get_root_id(self):
1232
"""See Branch.get_root_id."""
1233
tree = self.repository.revision_tree(self.last_revision())
1234
return tree.inventory.root.file_id
2011
1236
def is_locked(self):
2012
1237
return self.control_files.is_locked()
2014
def lock_write(self, token=None):
2015
# All-in-one needs to always unlock/lock.
2016
repo_control = getattr(self.repository, 'control_files', None)
2017
if self.control_files == repo_control or not self.is_locked():
2018
self.repository.lock_write()
1239
def lock_write(self):
1240
self.repository.lock_write()
2023
return self.control_files.lock_write(token=token)
1242
self.control_files.lock_write()
2026
self.repository.unlock()
1244
self.repository.unlock()
2029
1247
def lock_read(self):
2030
# All-in-one needs to always unlock/lock.
2031
repo_control = getattr(self.repository, 'control_files', None)
2032
if self.control_files == repo_control or not self.is_locked():
2033
self.repository.lock_read()
1248
self.repository.lock_read()
2038
1250
self.control_files.lock_read()
2041
self.repository.unlock()
1252
self.repository.unlock()
2044
1255
def unlock(self):
1256
# TODO: test for failed two phase locks. This is known broken.
2046
1258
self.control_files.unlock()
2048
# All-in-one needs to always unlock/lock.
2049
repo_control = getattr(self.repository, 'control_files', None)
2050
if (self.control_files == repo_control or
2051
not self.control_files.is_locked()):
2052
self.repository.unlock()
2053
if not self.control_files.is_locked():
2054
# we just released the lock
2055
self._clear_cached_state()
1260
self.repository.unlock()
1261
if not self.control_files.is_locked():
1262
# we just released the lock
1263
self._clear_cached_state()
2057
1265
def peek_lock_mode(self):
2058
1266
if self.control_files._lock_count == 0:
2068
1276
"""See Branch.print_file."""
2069
1277
return self.repository.print_file(file, revision_id)
1280
def append_revision(self, *revision_ids):
1281
"""See Branch.append_revision."""
1282
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1283
for revision_id in revision_ids:
1284
_mod_revision.check_not_reserved_id(revision_id)
1285
mutter("add {%s} to revision-history" % revision_id)
1286
rev_history = self.revision_history()
1287
rev_history.extend(revision_ids)
1288
self.set_revision_history(rev_history)
2071
1290
def _write_revision_history(self, history):
2072
1291
"""Factored out of set_revision_history.
2074
1293
This performs the actual writing to disk.
2075
1294
It is intended to be called by BzrBranch5.set_revision_history."""
2076
self._transport.put_bytes(
2077
'revision-history', '\n'.join(history),
2078
mode=self.bzrdir._get_file_mode())
1295
self.control_files.put_bytes(
1296
'revision-history', '\n'.join(history))
2080
1298
@needs_write_lock
2081
1299
def set_revision_history(self, rev_history):
2082
1300
"""See Branch.set_revision_history."""
2083
if 'evil' in debug.debug_flags:
2084
mutter_callsite(3, "set_revision_history scales with history.")
2085
check_not_reserved_id = _mod_revision.check_not_reserved_id
2086
for rev_id in rev_history:
2087
check_not_reserved_id(rev_id)
2088
if Branch.hooks['post_change_branch_tip']:
2089
# Don't calculate the last_revision_info() if there are no hooks
2091
old_revno, old_revid = self.last_revision_info()
2092
if len(rev_history) == 0:
2093
revid = _mod_revision.NULL_REVISION
2095
revid = rev_history[-1]
2096
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1301
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
2097
1302
self._write_revision_history(rev_history)
2098
self._clear_cached_state()
2099
1303
self._cache_revision_history(rev_history)
2100
1304
for hook in Branch.hooks['set_rh']:
2101
1305
hook(self, rev_history)
2102
if Branch.hooks['post_change_branch_tip']:
2103
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2105
def _synchronize_history(self, destination, revision_id):
2106
"""Synchronize last revision and revision history between branches.
2108
This version is most efficient when the destination is also a
2109
BzrBranch5, but works for BzrBranch6 as long as the revision
2110
history is the true lefthand parent history, and all of the revisions
2111
are in the destination's repository. If not, set_revision_history
2114
:param destination: The branch to copy the history into
2115
:param revision_id: The revision-id to truncate history at. May
2116
be None to copy complete history.
2118
if not isinstance(destination._format, BzrBranchFormat5):
2119
super(BzrBranch, self)._synchronize_history(
2120
destination, revision_id)
2122
if revision_id == _mod_revision.NULL_REVISION:
2125
new_history = self.revision_history()
2126
if revision_id is not None and new_history != []:
2128
new_history = new_history[:new_history.index(revision_id) + 1]
2130
rev = self.repository.get_revision(revision_id)
2131
new_history = rev.get_history(self.repository)[1:]
2132
destination.set_revision_history(new_history)
2134
1307
@needs_write_lock
2135
1308
def set_last_revision_info(self, revno, revision_id):
2136
"""Set the last revision of this branch.
2138
The caller is responsible for checking that the revno is correct
2139
for this revision id.
2141
It may be possible to set the branch last revision to an id not
2142
present in the repository. However, branches can also be
2143
configured to check constraints on history, in which case this may not
2146
revision_id = _mod_revision.ensure_null(revision_id)
2147
# this old format stores the full history, but this api doesn't
2148
# provide it, so we must generate, and might as well check it's
1309
revision_id = osutils.safe_revision_id(revision_id)
2150
1310
history = self._lefthand_history(revision_id)
2151
if len(history) != revno:
2152
raise AssertionError('%d != %d' % (len(history), revno))
1311
assert len(history) == revno, '%d != %d' % (len(history), revno)
2153
1312
self.set_revision_history(history)
2155
1314
def _gen_revision_history(self):
2156
history = self._transport.get_bytes('revision-history').split('\n')
1315
history = self.control_files.get('revision-history').read().split('\n')
2157
1316
if history[-1:] == ['']:
2158
1317
# There shouldn't be a trailing newline, but just in case.
1321
def _lefthand_history(self, revision_id, last_rev=None,
1323
# stop_revision must be a descendant of last_revision
1324
stop_graph = self.repository.get_revision_graph(revision_id)
1325
if last_rev is not None and last_rev not in stop_graph:
1326
# our previous tip is not merged into stop_revision
1327
raise errors.DivergedBranches(self, other_branch)
1328
# make a new revision history from the graph
1329
current_rev_id = revision_id
1331
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1332
new_history.append(current_rev_id)
1333
current_rev_id_parents = stop_graph[current_rev_id]
1335
current_rev_id = current_rev_id_parents[0]
1337
current_rev_id = None
1338
new_history.reverse()
2162
1341
@needs_write_lock
2163
1342
def generate_revision_history(self, revision_id, last_rev=None,
2164
1343
other_branch=None):
2170
1349
:param other_branch: The other branch that DivergedBranches should
2171
1350
raise with respect to.
1352
revision_id = osutils.safe_revision_id(revision_id)
2173
1353
self.set_revision_history(self._lefthand_history(revision_id,
2174
1354
last_rev, other_branch))
1357
def update_revisions(self, other, stop_revision=None):
1358
"""See Branch.update_revisions."""
1361
if stop_revision is None:
1362
stop_revision = other.last_revision()
1363
if stop_revision is None:
1364
# if there are no commits, we're done.
1367
stop_revision = osutils.safe_revision_id(stop_revision)
1368
# whats the current last revision, before we fetch [and change it
1370
last_rev = self.last_revision()
1371
# we fetch here regardless of whether we need to so that we pickup
1373
self.fetch(other, stop_revision)
1374
my_ancestry = self.repository.get_ancestry(last_rev)
1375
if stop_revision in my_ancestry:
1376
# last_revision is a descendant of stop_revision
1378
self.generate_revision_history(stop_revision, last_rev=last_rev,
2176
1383
def basis_tree(self):
2177
1384
"""See Branch.basis_tree."""
2178
1385
return self.repository.revision_tree(self.last_revision())
1387
@deprecated_method(zero_eight)
1388
def working_tree(self):
1389
"""Create a Working tree object for this branch."""
1391
from bzrlib.transport.local import LocalTransport
1392
if (self.base.find('://') != -1 or
1393
not isinstance(self._transport, LocalTransport)):
1394
raise NoWorkingTree(self.base)
1395
return self.bzrdir.open_workingtree()
2180
1397
@needs_write_lock
2181
1398
def pull(self, source, overwrite=False, stop_revision=None,
2182
_hook_master=None, run_hooks=True, possible_transports=None,
2183
_override_hook_target=None):
1399
_hook_master=None, _run_hooks=True):
2184
1400
"""See Branch.pull.
2186
:param _hook_master: Private parameter - set the branch to
2187
be supplied as the master to pull hooks.
2188
:param run_hooks: Private parameter - if false, this branch
2189
is being called because it's the master of the primary branch,
2190
so it should not run its hooks.
2191
:param _override_hook_target: Private parameter - set the branch to be
2192
supplied as the target_branch to pull hooks.
1402
:param _hook_master: Private parameter - set the branch to
1403
be supplied as the master to push hooks.
1404
:param _run_hooks: Private parameter - allow disabling of
1405
hooks, used when pushing to a master branch.
2194
1407
result = PullResult()
2195
1408
result.source_branch = source
2196
if _override_hook_target is None:
2197
result.target_branch = self
2199
result.target_branch = _override_hook_target
1409
result.target_branch = self
2200
1410
source.lock_read()
2202
# We assume that during 'pull' the local repository is closer than
2204
source.update_references(self)
2205
graph = self.repository.get_graph(source.repository)
2206
1412
result.old_revno, result.old_revid = self.last_revision_info()
2207
self.update_revisions(source, stop_revision, overwrite=overwrite,
2209
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1414
self.update_revisions(source, stop_revision)
1415
except DivergedBranches:
1419
if stop_revision is None:
1420
stop_revision = source.last_revision()
1421
self.generate_revision_history(stop_revision)
1422
result.tag_conflicts = source.tags.merge_to(self.tags)
2210
1423
result.new_revno, result.new_revid = self.last_revision_info()
2211
1424
if _hook_master:
2212
1425
result.master_branch = _hook_master
2213
result.local_branch = result.target_branch
1426
result.local_branch = self
2215
result.master_branch = result.target_branch
1428
result.master_branch = self
2216
1429
result.local_branch = None
2218
1431
for hook in Branch.hooks['post_pull']:
2225
1438
_locs = ['parent', 'pull', 'x-pull']
2226
1439
for l in _locs:
2228
return self._transport.get_bytes(l).strip('\n')
2229
except errors.NoSuchFile:
1441
return self.control_files.get(l).read().strip('\n')
2233
def _basic_push(self, target, overwrite, stop_revision):
2234
"""Basic implementation of push without bound branches or hooks.
2236
Must be called with source read locked and target write locked.
1447
def push(self, target, overwrite=False, stop_revision=None,
1448
_hook_master=None, _run_hooks=True):
1451
:param _hook_master: Private parameter - set the branch to
1452
be supplied as the master to push hooks.
1453
:param _run_hooks: Private parameter - allow disabling of
1454
hooks, used when pushing to a master branch.
2238
result = BranchPushResult()
1456
result = PushResult()
2239
1457
result.source_branch = self
2240
1458
result.target_branch = target
2241
result.old_revno, result.old_revid = target.last_revision_info()
2242
self.update_references(target)
2243
if result.old_revid != self.last_revision():
2244
# We assume that during 'push' this repository is closer than
2246
graph = self.repository.get_graph(target.repository)
2247
target.update_revisions(self, stop_revision,
2248
overwrite=overwrite, graph=graph)
2249
if self._push_should_merge_tags():
2250
result.tag_conflicts = self.tags.merge_to(target.tags,
2252
result.new_revno, result.new_revid = target.last_revision_info()
1461
result.old_revno, result.old_revid = target.last_revision_info()
1463
target.update_revisions(self, stop_revision)
1464
except DivergedBranches:
1468
target.set_revision_history(self.revision_history())
1469
result.tag_conflicts = self.tags.merge_to(target.tags)
1470
result.new_revno, result.new_revid = target.last_revision_info()
1472
result.master_branch = _hook_master
1473
result.local_branch = target
1475
result.master_branch = target
1476
result.local_branch = None
1478
for hook in Branch.hooks['post_push']:
2255
def get_stacked_on_url(self):
2256
raise errors.UnstackableBranchFormat(self._format, self.base)
1484
def get_parent(self):
1485
"""See Branch.get_parent."""
1487
assert self.base[-1] == '/'
1488
parent = self._get_parent_location()
1491
# This is an old-format absolute path to a local branch
1492
# turn it into a url
1493
if parent.startswith('/'):
1494
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1496
return urlutils.join(self.base[:-1], parent)
1497
except errors.InvalidURLJoin, e:
1498
raise errors.InaccessibleParent(parent, self.base)
1500
def get_push_location(self):
1501
"""See Branch.get_push_location."""
1502
push_loc = self.get_config().get_user_option('push_location')
2258
1505
def set_push_location(self, location):
2259
1506
"""See Branch.set_push_location."""
2261
1508
'push_location', location,
2262
1509
store=_mod_config.STORE_LOCATION_NORECURSE)
1512
def set_parent(self, url):
1513
"""See Branch.set_parent."""
1514
# TODO: Maybe delete old location files?
1515
# URLs should never be unicode, even on the local fs,
1516
# FIXUP this and get_parent in a future branch format bump:
1517
# read and rewrite the file, and have the new format code read
1518
# using .get not .get_utf8. RBC 20060125
1520
if isinstance(url, unicode):
1522
url = url.encode('ascii')
1523
except UnicodeEncodeError:
1524
raise bzrlib.errors.InvalidURL(url,
1525
"Urls must be 7-bit ascii, "
1526
"use bzrlib.urlutils.escape")
1527
url = urlutils.relative_url(self.base, url)
1528
self._set_parent_location(url)
2264
1530
def _set_parent_location(self, url):
2265
1531
if url is None:
2266
self._transport.delete('parent')
1532
self.control_files._transport.delete('parent')
2268
self._transport.put_bytes('parent', url + '\n',
2269
mode=self.bzrdir._get_file_mode())
1534
assert isinstance(url, str)
1535
self.control_files.put_bytes('parent', url + '\n')
1537
@deprecated_function(zero_nine)
1538
def tree_config(self):
1539
"""DEPRECATED; call get_config instead.
1540
TreeConfig has become part of BranchConfig."""
1541
return TreeConfig(self)
2272
1544
class BzrBranch5(BzrBranch):
2273
"""A format 5 branch. This supports new features over plain branches.
1545
"""A format 5 branch. This supports new features over plan branches.
2275
1547
It has support for a master_branch which is the data for bound branches.
1555
super(BzrBranch5, self).__init__(_format=_format,
1556
_control_files=_control_files,
1558
_repository=_repository)
2278
1560
@needs_write_lock
2279
1561
def pull(self, source, overwrite=False, stop_revision=None,
2280
run_hooks=True, possible_transports=None,
2281
_override_hook_target=None):
2282
"""Pull from source into self, updating my master if any.
2284
:param run_hooks: Private parameter - if false, this branch
2285
is being called because it's the master of the primary branch,
2286
so it should not run its hooks.
1563
"""Extends branch.pull to be bound branch aware.
1565
:param _run_hooks: Private parameter used to force hook running
1566
off during bound branch double-pushing.
2288
1568
bound_location = self.get_bound_location()
2289
1569
master_branch = None
2290
1570
if bound_location and source.base != bound_location:
2291
1571
# not pulling from master, so we need to update master.
2292
master_branch = self.get_master_branch(possible_transports)
1572
master_branch = self.get_master_branch()
2293
1573
master_branch.lock_write()
2295
1575
if master_branch:
2296
1576
# pull from source into master.
2297
1577
master_branch.pull(source, overwrite, stop_revision,
2299
1579
return super(BzrBranch5, self).pull(source, overwrite,
2300
1580
stop_revision, _hook_master=master_branch,
2301
run_hooks=run_hooks,
2302
_override_hook_target=_override_hook_target)
1581
_run_hooks=_run_hooks)
1584
master_branch.unlock()
1587
def push(self, target, overwrite=False, stop_revision=None):
1588
"""Updates branch.push to be bound branch aware."""
1589
bound_location = target.get_bound_location()
1590
master_branch = None
1591
if bound_location and target.base != bound_location:
1592
# not pushing to master, so we need to update master.
1593
master_branch = target.get_master_branch()
1594
master_branch.lock_write()
1597
# push into the master from this branch.
1598
super(BzrBranch5, self).push(master_branch, overwrite,
1599
stop_revision, _run_hooks=False)
1600
# and push into the target branch from this. Note that we push from
1601
# this branch again, because its considered the highest bandwidth
1603
return super(BzrBranch5, self).push(target, overwrite,
1604
stop_revision, _hook_master=master_branch)
2304
1606
if master_branch:
2305
1607
master_branch.unlock()
2307
1609
def get_bound_location(self):
2309
return self._transport.get_bytes('bound')[:-1]
1611
return self.control_files.get_utf8('bound').read()[:-1]
2310
1612
except errors.NoSuchFile:
2313
1615
@needs_read_lock
2314
def get_master_branch(self, possible_transports=None):
1616
def get_master_branch(self):
2315
1617
"""Return the branch we are bound to.
2317
1619
:return: Either a Branch, or None
2319
1621
This could memoise the branch, but if thats done
2379
1695
return self.set_bound_location(None)
2381
1697
@needs_write_lock
2382
def update(self, possible_transports=None):
2383
"""Synchronise this branch with the master branch if any.
1699
"""Synchronise this branch with the master branch if any.
2385
1701
:return: None or the last_revision that was pivoted out during the
2388
master = self.get_master_branch(possible_transports)
1704
master = self.get_master_branch()
2389
1705
if master is not None:
2390
old_tip = _mod_revision.ensure_null(self.last_revision())
1706
old_tip = self.last_revision()
2391
1707
self.pull(master, overwrite=True)
2392
if self.repository.get_graph().is_ancestor(old_tip,
2393
_mod_revision.ensure_null(self.last_revision())):
1708
if old_tip in self.repository.get_ancestry(self.last_revision()):
2399
class BzrBranch8(BzrBranch5):
2400
"""A branch that stores tree-reference locations."""
2402
def _open_hook(self):
2403
if self._ignore_fallbacks:
1714
class BzrBranchExperimental(BzrBranch5):
1715
"""Bzr experimental branch format
1718
- a revision-history file.
1720
- a lock dir guarding the branch itself
1721
- all of this stored in a branch/ subdirectory
1722
- works with shared repositories.
1723
- a tag dictionary in the branch
1725
This format is new in bzr 0.15, but shouldn't be used for real data,
1728
This class acts as it's own BranchFormat.
1731
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1734
def get_format_string(cls):
1735
"""See BranchFormat.get_format_string()."""
1736
return "Bazaar-NG branch format experimental\n"
1739
def get_format_description(cls):
1740
"""See BranchFormat.get_format_description()."""
1741
return "Experimental branch format"
1744
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1746
branch_transport = a_bzrdir.get_branch_transport(cls)
1747
control_files = lockable_files.LockableFiles(branch_transport,
1748
lock_filename, lock_class)
1749
control_files.create_lock()
1750
control_files.lock_write()
2406
url = self.get_stacked_on_url()
2407
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2408
errors.UnstackableBranchFormat):
2411
for hook in Branch.hooks['transform_fallback_location']:
2412
url = hook(self, url)
2414
hook_name = Branch.hooks.get_hook_name(hook)
2415
raise AssertionError(
2416
"'transform_fallback_location' hook %s returned "
2417
"None, not a URL." % hook_name)
2418
self._activate_fallback_location(url, None)
2420
def __init__(self, *args, **kwargs):
2421
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2422
super(BzrBranch8, self).__init__(*args, **kwargs)
2423
self._last_revision_info_cache = None
2424
self._partial_revision_history_cache = []
2425
self._reference_info = None
2427
def _clear_cached_state(self):
2428
super(BzrBranch8, self)._clear_cached_state()
2429
self._last_revision_info_cache = None
2430
self._partial_revision_history_cache = []
2431
self._reference_info = None
2433
def _last_revision_info(self):
2434
revision_string = self._transport.get_bytes('last-revision')
1752
for filename, content in utf8_files:
1753
control_files.put_utf8(filename, content)
1755
control_files.unlock()
1758
def initialize(cls, a_bzrdir):
1759
"""Create a branch of this format in a_bzrdir."""
1760
utf8_files = [('format', cls.get_format_string()),
1761
('revision-history', ''),
1762
('branch-name', ''),
1765
cls._initialize_control_files(a_bzrdir, utf8_files,
1766
'lock', lockdir.LockDir)
1767
return cls.open(a_bzrdir, _found=True)
1770
def open(cls, a_bzrdir, _found=False):
1771
"""Return the branch object for a_bzrdir
1773
_found is a private parameter, do not use it. It is used to indicate
1774
if format probing has already be done.
1777
format = BranchFormat.find_format(a_bzrdir)
1778
assert format.__class__ == cls
1779
transport = a_bzrdir.get_branch_transport(None)
1780
control_files = lockable_files.LockableFiles(transport, 'lock',
1782
return cls(_format=cls,
1783
_control_files=control_files,
1785
_repository=a_bzrdir.find_repository())
1788
def is_supported(cls):
1791
def _make_tags(self):
1792
return BasicTags(self)
1795
def supports_tags(cls):
1799
BranchFormat.register_format(BzrBranchExperimental)
1802
class BzrBranch6(BzrBranch5):
1805
def last_revision_info(self):
1806
revision_string = self.control_files.get('last-revision').read()
2435
1807
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2436
1808
revision_id = cache_utf8.get_cached_utf8(revision_id)
2437
1809
revno = int(revno)
2438
1810
return revno, revision_id
1812
def last_revision(self):
1813
"""Return last revision id, or None"""
1814
revision_id = self.last_revision_info()[1]
1815
if revision_id == _mod_revision.NULL_REVISION:
2440
1819
def _write_last_revision_info(self, revno, revision_id):
2441
1820
"""Simply write out the revision id, with no checks.
2446
1825
Intended to be called by set_last_revision_info and
2447
1826
_write_revision_history.
2449
revision_id = _mod_revision.ensure_null(revision_id)
1828
if revision_id is None:
1829
revision_id = 'null:'
2450
1830
out_string = '%d %s\n' % (revno, revision_id)
2451
self._transport.put_bytes('last-revision', out_string,
2452
mode=self.bzrdir._get_file_mode())
1831
self.control_files.put_bytes('last-revision', out_string)
2454
1833
@needs_write_lock
2455
1834
def set_last_revision_info(self, revno, revision_id):
2456
revision_id = _mod_revision.ensure_null(revision_id)
2457
old_revno, old_revid = self.last_revision_info()
1835
revision_id = osutils.safe_revision_id(revision_id)
2458
1836
if self._get_append_revisions_only():
2459
1837
self._check_history_violation(revision_id)
2460
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2461
1838
self._write_last_revision_info(revno, revision_id)
2462
1839
self._clear_cached_state()
2463
self._last_revision_info_cache = revno, revision_id
2464
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2466
def _synchronize_history(self, destination, revision_id):
2467
"""Synchronize last revision and revision history between branches.
2469
:see: Branch._synchronize_history
2471
# XXX: The base Branch has a fast implementation of this method based
2472
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2473
# that uses set_revision_history. This class inherits from BzrBranch5,
2474
# but wants the fast implementation, so it calls
2475
# Branch._synchronize_history directly.
2476
Branch._synchronize_history(self, destination, revision_id)
2478
1841
def _check_history_violation(self, revision_id):
2479
last_revision = _mod_revision.ensure_null(self.last_revision())
2480
if _mod_revision.is_null(last_revision):
1842
last_revision = self.last_revision()
1843
if last_revision is None:
2482
1845
if last_revision not in self._lefthand_history(revision_id):
2483
1846
raise errors.AppendRevisionsOnlyViolation(self.base)
2544
1898
"""Set the parent branch"""
2545
1899
return self._get_config_location('parent_location')
2548
def _set_all_reference_info(self, info_dict):
2549
"""Replace all reference info stored in a branch.
2551
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2554
writer = rio.RioWriter(s)
2555
for key, (tree_path, branch_location) in info_dict.iteritems():
2556
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2557
branch_location=branch_location)
2558
writer.write_stanza(stanza)
2559
self._transport.put_bytes('references', s.getvalue())
2560
self._reference_info = info_dict
2563
def _get_all_reference_info(self):
2564
"""Return all the reference info stored in a branch.
2566
:return: A dict of {file_id: (tree_path, branch_location)}
2568
if self._reference_info is not None:
2569
return self._reference_info
2570
rio_file = self._transport.get('references')
2572
stanzas = rio.read_stanzas(rio_file)
2573
info_dict = dict((s['file_id'], (s['tree_path'],
2574
s['branch_location'])) for s in stanzas)
2577
self._reference_info = info_dict
2580
def set_reference_info(self, file_id, tree_path, branch_location):
2581
"""Set the branch location to use for a tree reference.
2583
:param file_id: The file-id of the tree reference.
2584
:param tree_path: The path of the tree reference in the tree.
2585
:param branch_location: The location of the branch to retrieve tree
2588
info_dict = self._get_all_reference_info()
2589
info_dict[file_id] = (tree_path, branch_location)
2590
if None in (tree_path, branch_location):
2591
if tree_path is not None:
2592
raise ValueError('tree_path must be None when branch_location'
2594
if branch_location is not None:
2595
raise ValueError('branch_location must be None when tree_path'
2597
del info_dict[file_id]
2598
self._set_all_reference_info(info_dict)
2600
def get_reference_info(self, file_id):
2601
"""Get the tree_path and branch_location for a tree reference.
2603
:return: a tuple of (tree_path, branch_location)
2605
return self._get_all_reference_info().get(file_id, (None, None))
2607
def reference_parent(self, file_id, path, possible_transports=None):
2608
"""Return the parent branch for a tree-reference file_id.
2610
:param file_id: The file_id of the tree reference
2611
:param path: The path of the file_id in the tree
2612
:return: A branch associated with the file_id
2614
branch_location = self.get_reference_info(file_id)[1]
2615
if branch_location is None:
2616
return Branch.reference_parent(self, file_id, path,
2617
possible_transports)
2618
branch_location = urlutils.join(self.base, branch_location)
2619
return Branch.open(branch_location,
2620
possible_transports=possible_transports)
2622
1901
def set_push_location(self, location):
2623
1902
"""See Branch.set_push_location."""
2624
1903
self._set_config_location('push_location', location)
2657
1936
"""See Branch.get_old_bound_location"""
2658
1937
return self._get_bound_location(False)
2660
def get_stacked_on_url(self):
2661
# you can always ask for the URL; but you might not be able to use it
2662
# if the repo can't support stacking.
2663
## self._check_stackable_repo()
2664
stacked_url = self._get_config_location('stacked_on_location')
2665
if stacked_url is None:
2666
raise errors.NotStacked(self)
2669
1939
def set_append_revisions_only(self, enabled):
2673
1943
value = 'False'
2674
self.get_config().set_user_option('append_revisions_only', value,
1944
self.get_config().set_user_option('append_revisions_only', value)
2677
1946
def _get_append_revisions_only(self):
2678
1947
value = self.get_config().get_user_option('append_revisions_only')
2679
1948
return value == 'True'
2682
def generate_revision_history(self, revision_id, last_rev=None,
2684
"""See BzrBranch5.generate_revision_history"""
2685
history = self._lefthand_history(revision_id, last_rev, other_branch)
2686
revno = len(history)
2687
self.set_last_revision_info(revno, revision_id)
2690
def get_rev_id(self, revno, history=None):
2691
"""Find the revision id of the specified revno."""
2693
return _mod_revision.NULL_REVISION
2695
last_revno, last_revision_id = self.last_revision_info()
2696
if revno <= 0 or revno > last_revno:
2697
raise errors.NoSuchRevision(self, revno)
2699
if history is not None:
2700
return history[revno - 1]
2702
index = last_revno - revno
2703
if len(self._partial_revision_history_cache) <= index:
2704
self._extend_partial_history(stop_index=index)
2705
if len(self._partial_revision_history_cache) > index:
2706
return self._partial_revision_history_cache[index]
1950
def _synchronize_history(self, destination, revision_id):
1951
"""Synchronize last revision and revision history between branches.
1953
This version is most efficient when the destination is also a
1954
BzrBranch6, but works for BzrBranch5, as long as the destination's
1955
repository contains all the lefthand ancestors of the intended
1956
last_revision. If not, set_last_revision_info will fail.
1958
:param destination: The branch to copy the history into
1959
:param revision_id: The revision-id to truncate history at. May
1960
be None to copy complete history.
1962
if revision_id is None:
1963
revno, revision_id = self.last_revision_info()
2708
raise errors.NoSuchRevision(self, revno)
2711
def revision_id_to_revno(self, revision_id):
2712
"""Given a revision id, return its revno"""
2713
if _mod_revision.is_null(revision_id):
2716
index = self._partial_revision_history_cache.index(revision_id)
2718
self._extend_partial_history(stop_revision=revision_id)
2719
index = len(self._partial_revision_history_cache) - 1
2720
if self._partial_revision_history_cache[index] != revision_id:
2721
raise errors.NoSuchRevision(self, revision_id)
2722
return self.revno() - index
2725
class BzrBranch7(BzrBranch8):
2726
"""A branch with support for a fallback repository."""
2728
def set_reference_info(self, file_id, tree_path, branch_location):
2729
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2731
def get_reference_info(self, file_id):
2732
Branch.get_reference_info(self, file_id)
2734
def reference_parent(self, file_id, path, possible_transports=None):
2735
return Branch.reference_parent(self, file_id, path,
2736
possible_transports)
2739
class BzrBranch6(BzrBranch7):
2740
"""See BzrBranchFormat6 for the capabilities of this branch.
2742
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
1965
revno = self.revision_id_to_revno(revision_id)
1966
destination.set_last_revision_info(revno, revision_id)
1968
def _make_tags(self):
1969
return BasicTags(self)
1972
class BranchTestProviderAdapter(object):
1973
"""A tool to generate a suite testing multiple branch formats at once.
1975
This is done by copying the test once for each transport and injecting
1976
the transport_server, transport_readonly_server, and branch_format
1977
classes into each copy. Each copy is also given a new id() to make it
2746
def get_stacked_on_url(self):
2747
raise errors.UnstackableBranchFormat(self._format, self.base)
1981
def __init__(self, transport_server, transport_readonly_server, formats):
1982
self._transport_server = transport_server
1983
self._transport_readonly_server = transport_readonly_server
1984
self._formats = formats
1986
def adapt(self, test):
1987
result = TestSuite()
1988
for branch_format, bzrdir_format in self._formats:
1989
new_test = deepcopy(test)
1990
new_test.transport_server = self._transport_server
1991
new_test.transport_readonly_server = self._transport_readonly_server
1992
new_test.bzrdir_format = bzrdir_format
1993
new_test.branch_format = branch_format
1994
def make_new_test_id():
1995
# the format can be either a class or an instance
1996
name = getattr(branch_format, '__name__',
1997
branch_format.__class__.__name__)
1998
new_id = "%s(%s)" % (new_test.id(), name)
1999
return lambda: new_id
2000
new_test.id = make_new_test_id()
2001
result.addTest(new_test)
2750
2005
######################################################################
2859
2103
new_branch.tags._set_tag_dict({})
2861
2105
# Copying done; now update target format
2862
new_branch._transport.put_bytes('format',
2863
format.get_format_string(),
2864
mode=new_branch.bzrdir._get_file_mode())
2106
new_branch.control_files.put_utf8('format',
2107
format.get_format_string())
2866
2109
# Clean up old files
2867
new_branch._transport.delete('revision-history')
2110
new_branch.control_files._transport.delete('revision-history')
2869
2112
branch.set_parent(None)
2870
except errors.NoSuchFile:
2872
2115
branch.set_bound_location(None)
2875
class Converter6to7(object):
2876
"""Perform an in-place upgrade of format 6 to format 7"""
2878
def convert(self, branch):
2879
format = BzrBranchFormat7()
2880
branch._set_config_location('stacked_on_location', '')
2881
# update target format
2882
branch._transport.put_bytes('format', format.get_format_string())
2885
class Converter7to8(object):
2886
"""Perform an in-place upgrade of format 6 to format 7"""
2888
def convert(self, branch):
2889
format = BzrBranchFormat8()
2890
branch._transport.put_bytes('references', '')
2891
# update target format
2892
branch._transport.put_bytes('format', format.get_format_string())
2895
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2896
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2899
_run_with_write_locked_target will attempt to release the lock it acquires.
2901
If an exception is raised by callable, then that exception *will* be
2902
propagated, even if the unlock attempt raises its own error. Thus
2903
_run_with_write_locked_target should be preferred to simply doing::
2907
return callable(*args, **kwargs)
2912
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2913
# should share code?
2916
result = callable(*args, **kwargs)
2918
exc_info = sys.exc_info()
2922
raise exc_info[0], exc_info[1], exc_info[2]
2928
class InterBranch(InterObject):
2929
"""This class represents operations taking place between two branches.
2931
Its instances have methods like pull() and push() and contain
2932
references to the source and target repositories these operations
2933
can be carried out on.
2937
"""The available optimised InterBranch types."""
2940
def _get_branch_formats_to_test():
2941
"""Return a tuple with the Branch formats to use when testing."""
2942
raise NotImplementedError(self._get_branch_formats_to_test)
2944
def update_revisions(self, stop_revision=None, overwrite=False,
2946
"""Pull in new perfect-fit revisions.
2948
:param stop_revision: Updated until the given revision
2949
:param overwrite: Always set the branch pointer, rather than checking
2950
to see if it is a proper descendant.
2951
:param graph: A Graph object that can be used to query history
2952
information. This can be None.
2955
raise NotImplementedError(self.update_revisions)
2957
def push(self, overwrite=False, stop_revision=None,
2958
_override_hook_source_branch=None):
2959
"""Mirror the source branch into the target branch.
2961
The source branch is considered to be 'local', having low latency.
2963
raise NotImplementedError(self.push)
2966
class GenericInterBranch(InterBranch):
2967
"""InterBranch implementation that uses public Branch functions.
2971
def _get_branch_formats_to_test():
2972
return BranchFormat._default_format, BranchFormat._default_format
2974
def update_revisions(self, stop_revision=None, overwrite=False,
2976
"""See InterBranch.update_revisions()."""
2977
self.source.lock_read()
2979
other_revno, other_last_revision = self.source.last_revision_info()
2980
stop_revno = None # unknown
2981
if stop_revision is None:
2982
stop_revision = other_last_revision
2983
if _mod_revision.is_null(stop_revision):
2984
# if there are no commits, we're done.
2986
stop_revno = other_revno
2988
# what's the current last revision, before we fetch [and change it
2990
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2991
# we fetch here so that we don't process data twice in the common
2992
# case of having something to pull, and so that the check for
2993
# already merged can operate on the just fetched graph, which will
2994
# be cached in memory.
2995
self.target.fetch(self.source, stop_revision)
2996
# Check to see if one is an ancestor of the other
2999
graph = self.target.repository.get_graph()
3000
if self.target._check_if_descendant_or_diverged(
3001
stop_revision, last_rev, graph, self.source):
3002
# stop_revision is a descendant of last_rev, but we aren't
3003
# overwriting, so we're done.
3005
if stop_revno is None:
3007
graph = self.target.repository.get_graph()
3008
this_revno, this_last_revision = \
3009
self.target.last_revision_info()
3010
stop_revno = graph.find_distance_to_null(stop_revision,
3011
[(other_last_revision, other_revno),
3012
(this_last_revision, this_revno)])
3013
self.target.set_last_revision_info(stop_revno, stop_revision)
3015
self.source.unlock()
3017
def push(self, overwrite=False, stop_revision=None,
3018
_override_hook_source_branch=None):
3019
"""See InterBranch.push.
3021
This is the basic concrete implementation of push()
3023
:param _override_hook_source_branch: If specified, run
3024
the hooks passing this Branch as the source, rather than self.
3025
This is for use of RemoteBranch, where push is delegated to the
3026
underlying vfs-based Branch.
3028
# TODO: Public option to disable running hooks - should be trivial but
3030
self.source.lock_read()
3032
return _run_with_write_locked_target(
3033
self.target, self._push_with_bound_branches, overwrite,
3035
_override_hook_source_branch=_override_hook_source_branch)
3037
self.source.unlock()
3039
def _push_with_bound_branches(self, overwrite, stop_revision,
3040
_override_hook_source_branch=None):
3041
"""Push from source into target, and into target's master if any.
3044
if _override_hook_source_branch:
3045
result.source_branch = _override_hook_source_branch
3046
for hook in Branch.hooks['post_push']:
3049
bound_location = self.target.get_bound_location()
3050
if bound_location and self.target.base != bound_location:
3051
# there is a master branch.
3053
# XXX: Why the second check? Is it even supported for a branch to
3054
# be bound to itself? -- mbp 20070507
3055
master_branch = self.target.get_master_branch()
3056
master_branch.lock_write()
3058
# push into the master from the source branch.
3059
self.source._basic_push(master_branch, overwrite, stop_revision)
3060
# and push into the target branch from the source. Note that we
3061
# push from the source branch again, because its considered the
3062
# highest bandwidth repository.
3063
result = self.source._basic_push(self.target, overwrite,
3065
result.master_branch = master_branch
3066
result.local_branch = self.target
3070
master_branch.unlock()
3073
result = self.source._basic_push(self.target, overwrite,
3075
# TODO: Why set master_branch and local_branch if there's no
3076
# binding? Maybe cleaner to just leave them unset? -- mbp
3078
result.master_branch = self.target
3079
result.local_branch = None
3084
def is_compatible(self, source, target):
3085
# GenericBranch uses the public API, so always compatible
3089
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
