13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
18
from cStringIO import StringIO
21
20
from bzrlib.lazy_import import lazy_import
22
21
lazy_import(globals(), """
23
from itertools import chain
22
from copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
24
27
from bzrlib import (
27
30
config as _mod_config,
33
35
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TransportConfig
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
from bzrlib.hooks import HookPoint, Hooks
51
from bzrlib.inter import InterObject
52
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
51
HistoryMissing, InvalidRevisionId,
52
InvalidRevisionNumber, LockError, NoSuchFile,
53
NoSuchRevision, NoWorkingTree, NotVersionedError,
54
NotBranchError, UninitializableFormat,
55
UnlistableStore, UnlistableBranch,
57
from bzrlib.hooks import Hooks
58
from bzrlib.symbol_versioning import (deprecated_function,
62
zero_eight, zero_nine, zero_sixteen,
64
from bzrlib.trace import mutter, note
61
67
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
121
115
if master is not None:
122
116
master.break_lock()
124
def _check_stackable_repo(self):
125
if not self.repository._format.supports_external_lookups:
126
raise errors.UnstackableRepositoryFormat(self.repository._format,
127
self.repository.base)
129
def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
"""Extend the partial history to include a given index
132
If a stop_index is supplied, stop when that index has been reached.
133
If a stop_revision is supplied, stop when that revision is
134
encountered. Otherwise, stop when the beginning of history is
137
:param stop_index: The index which should be present. When it is
138
present, history extension will stop.
139
:param stop_revision: The revision id which should be present. When
140
it is encountered, history extension will stop.
142
if len(self._partial_revision_history_cache) == 0:
143
self._partial_revision_history_cache = [self.last_revision()]
144
repository._iter_for_revno(
145
self.repository, self._partial_revision_history_cache,
146
stop_index=stop_index, stop_revision=stop_revision)
147
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
self._partial_revision_history_cache.pop()
150
def _get_check_refs(self):
151
"""Get the references needed for check().
155
revid = self.last_revision()
156
return [('revision-existence', revid), ('lefthand-distance', revid)]
159
def open(base, _unsupported=False, possible_transports=None):
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):
160
126
"""Open the branch rooted at base.
162
128
For instance, if the branch is at URL/.bzr/branch,
163
129
Branch.open(URL) -> a Branch instance.
165
control = bzrdir.BzrDir.open(base, _unsupported,
166
possible_transports=possible_transports)
167
return control.open_branch(unsupported=_unsupported)
170
def open_from_transport(transport, name=None, _unsupported=False):
171
"""Open the branch rooted at transport"""
172
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
return control.open_branch(name=name, unsupported=_unsupported)
176
def open_containing(url, possible_transports=None):
131
control = bzrdir.BzrDir.open(base, _unsupported)
132
return control.open_branch(_unsupported)
135
def open_containing(url):
177
136
"""Open an existing branch which contains url.
179
138
This probes for a branch at url, and searches upwards from there.
181
140
Basically we keep looking up until we find the control directory or
182
141
run into the root. If there isn't one, raises NotBranchError.
183
If there is one and it is either an unrecognised format or an unsupported
142
If there is one and it is either an unrecognised format or an unsupported
184
143
format, UnknownFormatError or UnsupportedFormatError are raised.
185
144
If there is one, it is returned, along with the unused portion of url.
187
control, relpath = bzrdir.BzrDir.open_containing(url,
146
control, relpath = bzrdir.BzrDir.open_containing(url)
189
147
return control.open_branch(), relpath
191
def _push_should_merge_tags(self):
192
"""Should _basic_push merge this branch's tags into the target?
194
The default implementation returns False if this branch has no tags,
195
and True the rest of the time. Subclasses may override this.
197
return self.supports_tags() and self.tags.get_tag_dict()
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.
199
168
def get_config(self):
200
169
return BranchConfig(self)
202
def _get_config(self):
203
"""Get the concrete config for just the config in this branch.
205
This is not intended for client use; see Branch.get_config for the
210
:return: An object supporting get_option and set_option.
212
raise NotImplementedError(self._get_config)
214
def _get_fallback_repository(self, url):
215
"""Get the repository we fallback to at url."""
216
url = urlutils.join(self.base, url)
217
a_branch = Branch.open(url,
218
possible_transports=[self.bzrdir.root_transport])
219
return a_branch.repository
221
def _get_tags_bytes(self):
222
"""Get the bytes of a serialised tags dict.
224
Note that not all branches support tags, nor do all use the same tags
225
logic: this method is specific to BasicTags. Other tag implementations
226
may use the same method name and behave differently, safely, because
227
of the double-dispatch via
228
format.make_tags->tags_instance->get_tags_dict.
230
:return: The bytes of the tags file.
231
:seealso: Branch._set_tags_bytes.
233
return self._transport.get_bytes('tags')
235
def _get_nick(self, local=False, possible_transports=None):
236
config = self.get_config()
237
# explicit overrides master, but don't look for master if local is True
238
if not local and not config.has_explicit_nickname():
240
master = self.get_master_branch(possible_transports)
241
if master is not None:
242
# return the master branch value
244
except errors.BzrError, e:
245
# Silently fall back to local implicit nick if the master is
247
mutter("Could not connect to bound branch, "
248
"falling back to local nick.\n " + str(e))
249
return config.get_nickname()
172
return self.get_config().get_nickname()
251
174
def _set_nick(self, nick):
252
self.get_config().set_user_option('nickname', nick, warn_masked=True)
175
self.get_config().set_user_option('nickname', nick)
254
177
nick = property(_get_nick, _set_nick)
256
179
def is_locked(self):
257
180
raise NotImplementedError(self.is_locked)
259
def _lefthand_history(self, revision_id, last_rev=None,
261
if 'evil' in debug.debug_flags:
262
mutter_callsite(4, "_lefthand_history scales with history.")
263
# stop_revision must be a descendant of last_revision
264
graph = self.repository.get_graph()
265
if last_rev is not None:
266
if not graph.is_ancestor(last_rev, revision_id):
267
# our previous tip is not merged into stop_revision
268
raise errors.DivergedBranches(self, other_branch)
269
# make a new revision history from the graph
270
parents_map = graph.get_parent_map([revision_id])
271
if revision_id not in parents_map:
272
raise errors.NoSuchRevision(self, revision_id)
273
current_rev_id = revision_id
275
check_not_reserved_id = _mod_revision.check_not_reserved_id
276
# Do not include ghosts or graph origin in revision_history
277
while (current_rev_id in parents_map and
278
len(parents_map[current_rev_id]) > 0):
279
check_not_reserved_id(current_rev_id)
280
new_history.append(current_rev_id)
281
current_rev_id = parents_map[current_rev_id][0]
282
parents_map = graph.get_parent_map([current_rev_id])
283
new_history.reverse()
286
def lock_write(self, token=None):
287
"""Lock the branch for write operations.
289
:param token: A token to permit reacquiring a previously held and
291
:return: A BranchWriteLockResult.
182
def lock_write(self):
293
183
raise NotImplementedError(self.lock_write)
295
185
def lock_read(self):
296
"""Lock the branch for read operations.
298
:return: A bzrlib.lock.LogicalLockResult.
300
186
raise NotImplementedError(self.lock_read)
302
188
def unlock(self):
309
195
def get_physical_lock_status(self):
310
196
raise NotImplementedError(self.get_physical_lock_status)
313
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
314
"""Return the revision_id for a dotted revno.
316
:param revno: a tuple like (1,) or (1,1,2)
317
:param _cache_reverse: a private parameter enabling storage
318
of the reverse mapping in a top level cache. (This should
319
only be done in selective circumstances as we want to
320
avoid having the mapping cached multiple times.)
321
:return: the revision_id
322
:raises errors.NoSuchRevision: if the revno doesn't exist
324
rev_id = self._do_dotted_revno_to_revision_id(revno)
326
self._partial_revision_id_to_revno_cache[rev_id] = revno
329
def _do_dotted_revno_to_revision_id(self, revno):
330
"""Worker function for dotted_revno_to_revision_id.
332
Subclasses should override this if they wish to
333
provide a more efficient implementation.
336
return self.get_rev_id(revno[0])
337
revision_id_to_revno = self.get_revision_id_to_revno_map()
338
revision_ids = [revision_id for revision_id, this_revno
339
in revision_id_to_revno.iteritems()
340
if revno == this_revno]
341
if len(revision_ids) == 1:
342
return revision_ids[0]
344
revno_str = '.'.join(map(str, revno))
345
raise errors.NoSuchRevision(self, revno_str)
348
def revision_id_to_dotted_revno(self, revision_id):
349
"""Given a revision id, return its dotted revno.
351
:return: a tuple like (1,) or (400,1,3).
353
return self._do_revision_id_to_dotted_revno(revision_id)
355
def _do_revision_id_to_dotted_revno(self, revision_id):
356
"""Worker function for revision_id_to_revno."""
357
# Try the caches if they are loaded
358
result = self._partial_revision_id_to_revno_cache.get(revision_id)
359
if result is not None:
361
if self._revision_id_to_revno_cache:
362
result = self._revision_id_to_revno_cache.get(revision_id)
364
raise errors.NoSuchRevision(self, revision_id)
365
# Try the mainline as it's optimised
367
revno = self.revision_id_to_revno(revision_id)
369
except errors.NoSuchRevision:
370
# We need to load and use the full revno map after all
371
result = self.get_revision_id_to_revno_map().get(revision_id)
373
raise errors.NoSuchRevision(self, revision_id)
377
def get_revision_id_to_revno_map(self):
378
"""Return the revision_id => dotted revno map.
380
This will be regenerated on demand, but will be cached.
382
:return: A dictionary mapping revision_id => dotted revno.
383
This dictionary should not be modified by the caller.
385
if self._revision_id_to_revno_cache is not None:
386
mapping = self._revision_id_to_revno_cache
388
mapping = self._gen_revno_map()
389
self._cache_revision_id_to_revno(mapping)
390
# TODO: jam 20070417 Since this is being cached, should we be returning
392
# I would rather not, and instead just declare that users should not
393
# modify the return value.
396
def _gen_revno_map(self):
397
"""Create a new mapping from revision ids to dotted revnos.
399
Dotted revnos are generated based on the current tip in the revision
401
This is the worker function for get_revision_id_to_revno_map, which
402
just caches the return value.
404
:return: A dictionary mapping revision_id => dotted revno.
406
revision_id_to_revno = dict((rev_id, revno)
407
for rev_id, depth, revno, end_of_merge
408
in self.iter_merge_sorted_revisions())
409
return revision_id_to_revno
412
def iter_merge_sorted_revisions(self, start_revision_id=None,
413
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
414
"""Walk the revisions for a branch in merge sorted order.
416
Merge sorted order is the output from a merge-aware,
417
topological sort, i.e. all parents come before their
418
children going forward; the opposite for reverse.
420
:param start_revision_id: the revision_id to begin walking from.
421
If None, the branch tip is used.
422
:param stop_revision_id: the revision_id to terminate the walk
423
after. If None, the rest of history is included.
424
:param stop_rule: if stop_revision_id is not None, the precise rule
425
to use for termination:
426
* 'exclude' - leave the stop revision out of the result (default)
427
* 'include' - the stop revision is the last item in the result
428
* 'with-merges' - include the stop revision and all of its
429
merged revisions in the result
430
* 'with-merges-without-common-ancestry' - filter out revisions
431
that are in both ancestries
432
:param direction: either 'reverse' or 'forward':
433
* reverse means return the start_revision_id first, i.e.
434
start at the most recent revision and go backwards in history
435
* forward returns tuples in the opposite order to reverse.
436
Note in particular that forward does *not* do any intelligent
437
ordering w.r.t. depth as some clients of this API may like.
438
(If required, that ought to be done at higher layers.)
440
:return: an iterator over (revision_id, depth, revno, end_of_merge)
443
* revision_id: the unique id of the revision
444
* depth: How many levels of merging deep this node has been
446
* revno_sequence: This field provides a sequence of
447
revision numbers for all revisions. The format is:
448
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
449
branch that the revno is on. From left to right the REVNO numbers
450
are the sequence numbers within that branch of the revision.
451
* end_of_merge: When True the next node (earlier in history) is
452
part of a different merge.
454
# Note: depth and revno values are in the context of the branch so
455
# we need the full graph to get stable numbers, regardless of the
457
if self._merge_sorted_revisions_cache is None:
458
last_revision = self.last_revision()
459
known_graph = self.repository.get_known_graph_ancestry(
461
self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
filtered = self._filter_merge_sorted_revisions(
464
self._merge_sorted_revisions_cache, start_revision_id,
465
stop_revision_id, stop_rule)
466
# Make sure we don't return revisions that are not part of the
467
# start_revision_id ancestry.
468
filtered = self._filter_start_non_ancestors(filtered)
469
if direction == 'reverse':
471
if direction == 'forward':
472
return reversed(list(filtered))
474
raise ValueError('invalid direction %r' % direction)
476
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
477
start_revision_id, stop_revision_id, stop_rule):
478
"""Iterate over an inclusive range of sorted revisions."""
479
rev_iter = iter(merge_sorted_revisions)
480
if start_revision_id is not None:
481
for node in rev_iter:
482
rev_id = node.key[-1]
483
if rev_id != start_revision_id:
486
# The decision to include the start or not
487
# depends on the stop_rule if a stop is provided
488
# so pop this node back into the iterator
489
rev_iter = chain(iter([node]), rev_iter)
491
if stop_revision_id is None:
493
for node in rev_iter:
494
rev_id = node.key[-1]
495
yield (rev_id, node.merge_depth, node.revno,
497
elif stop_rule == 'exclude':
498
for node in rev_iter:
499
rev_id = node.key[-1]
500
if rev_id == stop_revision_id:
502
yield (rev_id, node.merge_depth, node.revno,
504
elif stop_rule == 'include':
505
for node in rev_iter:
506
rev_id = node.key[-1]
507
yield (rev_id, node.merge_depth, node.revno,
509
if rev_id == stop_revision_id:
511
elif stop_rule == 'with-merges-without-common-ancestry':
512
# We want to exclude all revisions that are already part of the
513
# stop_revision_id ancestry.
514
graph = self.repository.get_graph()
515
ancestors = graph.find_unique_ancestors(start_revision_id,
517
for node in rev_iter:
518
rev_id = node.key[-1]
519
if rev_id not in ancestors:
521
yield (rev_id, node.merge_depth, node.revno,
523
elif stop_rule == 'with-merges':
524
stop_rev = self.repository.get_revision(stop_revision_id)
525
if stop_rev.parent_ids:
526
left_parent = stop_rev.parent_ids[0]
528
left_parent = _mod_revision.NULL_REVISION
529
# left_parent is the actual revision we want to stop logging at,
530
# since we want to show the merged revisions after the stop_rev too
531
reached_stop_revision_id = False
532
revision_id_whitelist = []
533
for node in rev_iter:
534
rev_id = node.key[-1]
535
if rev_id == left_parent:
536
# reached the left parent after the stop_revision
538
if (not reached_stop_revision_id or
539
rev_id in revision_id_whitelist):
540
yield (rev_id, node.merge_depth, node.revno,
542
if reached_stop_revision_id or rev_id == stop_revision_id:
543
# only do the merged revs of rev_id from now on
544
rev = self.repository.get_revision(rev_id)
546
reached_stop_revision_id = True
547
revision_id_whitelist.extend(rev.parent_ids)
549
raise ValueError('invalid stop_rule %r' % stop_rule)
551
def _filter_start_non_ancestors(self, rev_iter):
552
# If we started from a dotted revno, we want to consider it as a tip
553
# and don't want to yield revisions that are not part of its
554
# ancestry. Given the order guaranteed by the merge sort, we will see
555
# uninteresting descendants of the first parent of our tip before the
557
first = rev_iter.next()
558
(rev_id, merge_depth, revno, end_of_merge) = first
561
# We start at a mainline revision so by definition, all others
562
# revisions in rev_iter are ancestors
563
for node in rev_iter:
568
pmap = self.repository.get_parent_map([rev_id])
569
parents = pmap.get(rev_id, [])
571
whitelist.update(parents)
573
# If there is no parents, there is nothing of interest left
575
# FIXME: It's hard to test this scenario here as this code is never
576
# called in that case. -- vila 20100322
579
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
if rev_id in whitelist:
582
pmap = self.repository.get_parent_map([rev_id])
583
parents = pmap.get(rev_id, [])
584
whitelist.remove(rev_id)
585
whitelist.update(parents)
587
# We've reached the mainline, there is nothing left to
591
# A revision that is not part of the ancestry of our
594
yield (rev_id, merge_depth, revno, end_of_merge)
596
198
def leave_lock_in_place(self):
597
199
"""Tell this branch object not to release the physical lock when this
598
200
object is unlocked.
600
202
If lock_write doesn't return a token, then this method is not supported.
602
204
self.control_files.leave_in_place()
708
308
The delta is relative to its mainline predecessor, or the
709
309
empty tree for revision 1.
311
assert isinstance(revno, int)
711
312
rh = self.revision_history()
712
313
if not (1 <= revno <= len(rh)):
713
raise errors.InvalidRevisionNumber(revno)
314
raise InvalidRevisionNumber(revno)
714
315
return self.repository.get_revision_delta(rh[revno-1])
716
def get_stacked_on_url(self):
717
"""Get the URL this branch is stacked against.
317
@deprecated_method(zero_sixteen)
318
def get_root_id(self):
319
"""Return the id of this branches root
719
:raises NotStacked: If the branch is not stacked.
720
:raises UnstackableBranchFormat: If the branch does not support
321
Deprecated: branches don't have root ids-- trees do.
322
Use basis_tree().get_root_id() instead.
723
raise NotImplementedError(self.get_stacked_on_url)
324
raise NotImplementedError(self.get_root_id)
725
326
def print_file(self, file, revision_id):
726
327
"""Print `file` to stdout."""
727
328
raise NotImplementedError(self.print_file)
330
def append_revision(self, *revision_ids):
331
raise NotImplementedError(self.append_revision)
729
333
def set_revision_history(self, rev_history):
730
334
raise NotImplementedError(self.set_revision_history)
733
def set_parent(self, url):
734
"""See Branch.set_parent."""
735
# TODO: Maybe delete old location files?
736
# URLs should never be unicode, even on the local fs,
737
# FIXUP this and get_parent in a future branch format bump:
738
# read and rewrite the file. RBC 20060125
740
if isinstance(url, unicode):
742
url = url.encode('ascii')
743
except UnicodeEncodeError:
744
raise errors.InvalidURL(url,
745
"Urls must be 7-bit ascii, "
746
"use bzrlib.urlutils.escape")
747
url = urlutils.relative_url(self.base, url)
748
self._set_parent_location(url)
751
def set_stacked_on_url(self, url):
752
"""Set the URL this branch is stacked against.
754
:raises UnstackableBranchFormat: If the branch does not support
756
:raises UnstackableRepositoryFormat: If the repository does not support
759
if not self._format.supports_stacking():
760
raise errors.UnstackableBranchFormat(self._format, self.user_url)
761
# XXX: Changing from one fallback repository to another does not check
762
# that all the data you need is present in the new fallback.
763
# Possibly it should.
764
self._check_stackable_repo()
767
old_url = self.get_stacked_on_url()
768
except (errors.NotStacked, errors.UnstackableBranchFormat,
769
errors.UnstackableRepositoryFormat):
773
self._activate_fallback_location(url)
774
# write this out after the repository is stacked to avoid setting a
775
# stacked config that doesn't work.
776
self._set_config_location('stacked_on_location', url)
779
"""Change a branch to be unstacked, copying data as needed.
781
Don't call this directly, use set_stacked_on_url(None).
783
pb = ui.ui_factory.nested_progress_bar()
785
pb.update("Unstacking")
786
# The basic approach here is to fetch the tip of the branch,
787
# including all available ghosts, from the existing stacked
788
# repository into a new repository object without the fallbacks.
790
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
791
# correct for CHKMap repostiories
792
old_repository = self.repository
793
if len(old_repository._fallback_repositories) != 1:
794
raise AssertionError("can't cope with fallback repositories "
795
"of %r" % (self.repository,))
796
# unlock it, including unlocking the fallback
797
old_repository.unlock()
798
old_repository.lock_read()
800
# Repositories don't offer an interface to remove fallback
801
# repositories today; take the conceptually simpler option and just
802
# reopen it. We reopen it starting from the URL so that we
803
# get a separate connection for RemoteRepositories and can
804
# stream from one of them to the other. This does mean doing
805
# separate SSH connection setup, but unstacking is not a
806
# common operation so it's tolerable.
807
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
808
new_repository = new_bzrdir.find_repository()
809
self.repository = new_repository
810
if self.repository._fallback_repositories:
811
raise AssertionError("didn't expect %r to have "
812
"fallback_repositories"
813
% (self.repository,))
814
# this is not paired with an unlock because it's just restoring
815
# the previous state; the lock's released when set_stacked_on_url
817
self.repository.lock_write()
818
# XXX: If you unstack a branch while it has a working tree
819
# with a pending merge, the pending-merged revisions will no
820
# longer be present. You can (probably) revert and remerge.
822
# XXX: This only fetches up to the tip of the repository; it
823
# doesn't bring across any tags. That's fairly consistent
824
# with how branch works, but perhaps not ideal.
825
self.repository.fetch(old_repository,
826
revision_id=self.last_revision(),
829
old_repository.unlock()
833
def _set_tags_bytes(self, bytes):
834
"""Mirror method for _get_tags_bytes.
836
:seealso: Branch._get_tags_bytes.
838
return _run_with_write_locked_target(self, self._transport.put_bytes,
841
336
def _cache_revision_history(self, rev_history):
842
337
"""Set the cached revision history to rev_history.
952
433
common_index = min(self_len, other_len) -1
953
434
if common_index >= 0 and \
954
435
self_history[common_index] != other_history[common_index]:
955
raise errors.DivergedBranches(self, other)
436
raise DivergedBranches(self, other)
957
438
if stop_revision is None:
958
439
stop_revision = other_len
441
assert isinstance(stop_revision, int)
960
442
if stop_revision > other_len:
961
443
raise errors.NoSuchRevision(self, stop_revision)
962
444
return other_history[self_len:stop_revision]
965
def update_revisions(self, other, stop_revision=None, overwrite=False,
446
def update_revisions(self, other, stop_revision=None):
967
447
"""Pull in new perfect-fit revisions.
969
449
:param other: Another Branch to pull from
970
450
:param stop_revision: Updated until the given revision
971
:param overwrite: Always set the branch pointer, rather than checking
972
to see if it is a proper descendant.
973
:param graph: A Graph object that can be used to query history
974
information. This can be None.
977
return InterBranch.get(other, self).update_revisions(stop_revision,
980
def import_last_revision_info(self, source_repo, revno, revid):
981
"""Set the last revision info, importing from another repo if necessary.
983
This is used by the bound branch code to upload a revision to
984
the master branch first before updating the tip of the local branch.
986
:param source_repo: Source repository to optionally fetch from
987
:param revno: Revision number of the new tip
988
:param revid: Revision id of the new tip
990
if not self.repository.has_same_location(source_repo):
991
self.repository.fetch(source_repo, revision_id=revid)
992
self.set_last_revision_info(revno, revid)
453
raise NotImplementedError(self.update_revisions)
994
455
def revision_id_to_revno(self, revision_id):
995
456
"""Given a revision id, return its revno"""
996
if _mod_revision.is_null(revision_id):
457
if revision_id is None:
459
revision_id = osutils.safe_revision_id(revision_id)
998
460
history = self.revision_history()
1000
462
return history.index(revision_id) + 1
1001
463
except ValueError:
1002
raise errors.NoSuchRevision(self, revision_id)
464
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1005
466
def get_rev_id(self, revno, history=None):
1006
467
"""Find the revision id of the specified revno."""
1008
return _mod_revision.NULL_REVISION
1009
last_revno, last_revid = self.last_revision_info()
1010
if revno == last_revno:
1012
if revno <= 0 or revno > last_revno:
1013
raise errors.NoSuchRevision(self, revno)
1014
distance_from_last = last_revno - revno
1015
if len(self._partial_revision_history_cache) <= distance_from_last:
1016
self._extend_partial_history(distance_from_last)
1017
return self._partial_revision_history_cache[distance_from_last]
471
history = self.revision_history()
472
if revno <= 0 or revno > len(history):
473
raise bzrlib.errors.NoSuchRevision(self, revno)
474
return history[revno - 1]
1020
def pull(self, source, overwrite=False, stop_revision=None,
1021
possible_transports=None, *args, **kwargs):
476
def pull(self, source, overwrite=False, stop_revision=None):
1022
477
"""Mirror source into this branch.
1024
479
This branch is considered to be 'local', having low latency.
1026
481
:returns: PullResult instance
1028
return InterBranch.get(source, self).pull(overwrite=overwrite,
1029
stop_revision=stop_revision,
1030
possible_transports=possible_transports, *args, **kwargs)
483
raise NotImplementedError(self.pull)
1032
def push(self, target, overwrite=False, stop_revision=None, *args,
485
def push(self, target, overwrite=False, stop_revision=None):
1034
486
"""Mirror this branch into target.
1036
488
This branch is considered to be 'local', having low latency.
1038
return InterBranch.get(self, target).push(overwrite, stop_revision,
1041
def lossy_push(self, target, stop_revision=None):
1042
"""Push deltas into another branch.
1044
:note: This does not, like push, retain the revision ids from
1045
the source branch and will, rather than adding bzr-specific
1046
metadata, push only those semantics of the revision that can be
1047
natively represented by this branch' VCS.
1049
:param target: Target branch
1050
:param stop_revision: Revision to push, defaults to last revision.
1051
:return: BranchPushResult with an extra member revidmap:
1052
A dictionary mapping revision ids from the target branch
1053
to new revision ids in the target branch, for each
1054
revision that was pushed.
1056
inter = InterBranch.get(self, target)
1057
lossy_push = getattr(inter, "lossy_push", None)
1058
if lossy_push is None:
1059
raise errors.LossyPushToSameVCS(self, target)
1060
return lossy_push(stop_revision)
490
raise NotImplementedError(self.push)
1062
492
def basis_tree(self):
1063
493
"""Return `Tree` object for last revision."""
1064
494
return self.repository.revision_tree(self.last_revision())
496
def rename_one(self, from_rel, to_rel):
499
This can change the directory or the filename or both.
501
raise NotImplementedError(self.rename_one)
503
def move(self, from_paths, to_name):
506
to_name must exist as a versioned directory.
508
If to_name exists and is a directory, the files are moved into
509
it, keeping their old names. If it is a directory,
511
Note that to_name is only the last component of the new name;
512
this doesn't change the directory.
514
This returns a list of (from_path, to_path) pairs for each
517
raise NotImplementedError(self.move)
1066
519
def get_parent(self):
1067
520
"""Return the parent location of the branch.
1069
This is the default location for pull/missing. The usual
522
This is the default location for push/pull/missing. The usual
1070
523
pattern is that the user can override it by specifying a
1073
parent = self._get_parent_location()
1076
# This is an old-format absolute path to a local branch
1077
# turn it into a url
1078
if parent.startswith('/'):
1079
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1081
return urlutils.join(self.base[:-1], parent)
1082
except errors.InvalidURLJoin, e:
1083
raise errors.InaccessibleParent(parent, self.user_url)
1085
def _get_parent_location(self):
1086
raise NotImplementedError(self._get_parent_location)
526
raise NotImplementedError(self.get_parent)
1088
528
def _set_config_location(self, name, url, config=None,
1089
529
make_relative=False):
1190
605
self.check_real_revno(revno)
1192
607
def check_real_revno(self, revno):
1194
609
Check whether a revno corresponds to a real revision.
1195
610
Zero (the NULL revision) is considered invalid
1197
612
if revno < 1 or revno > self.revno():
1198
raise errors.InvalidRevisionNumber(revno)
613
raise InvalidRevisionNumber(revno)
1200
615
@needs_read_lock
1201
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
616
def clone(self, to_bzrdir, revision_id=None):
1202
617
"""Clone this branch into to_bzrdir preserving all semantic values.
1204
Most API users will want 'create_clone_on_transport', which creates a
1205
new bzrdir and branch on the fly.
1207
619
revision_id: if not None, the revision history in the new branch will
1208
620
be truncated to end with revision_id.
1210
result = to_bzrdir.create_branch()
1213
if repository_policy is not None:
1214
repository_policy.configure_branch(result)
1215
self.copy_content_into(result, revision_id=revision_id)
622
result = self._format.initialize(to_bzrdir)
623
self.copy_content_into(result, revision_id=revision_id)
1220
626
@needs_read_lock
1221
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
627
def sprout(self, to_bzrdir, revision_id=None):
1222
628
"""Create a new line of development from the branch, into to_bzrdir.
1224
to_bzrdir controls the branch format.
1226
630
revision_id: if not None, the revision history in the new branch will
1227
631
be truncated to end with revision_id.
1229
if (repository_policy is not None and
1230
repository_policy.requires_stacking()):
1231
to_bzrdir._format.require_stacking(_skip_repo=True)
1232
result = to_bzrdir.create_branch()
1235
if repository_policy is not None:
1236
repository_policy.configure_branch(result)
1237
self.copy_content_into(result, revision_id=revision_id)
1238
result.set_parent(self.bzrdir.root_transport.base)
633
result = self._format.initialize(to_bzrdir)
634
self.copy_content_into(result, revision_id=revision_id)
635
result.set_parent(self.bzrdir.root_transport.base)
1243
638
def _synchronize_history(self, destination, revision_id):
1244
639
"""Synchronize last revision and revision history between branches.
1246
641
This version is most efficient when the destination is also a
1247
BzrBranch6, but works for BzrBranch5, as long as the destination's
1248
repository contains all the lefthand ancestors of the intended
1249
last_revision. If not, set_last_revision_info will fail.
642
BzrBranch5, but works for BzrBranch6 as long as the revision
643
history is the true lefthand parent history, and all of the revisions
644
are in the destination's repository. If not, set_revision_history
1251
647
:param destination: The branch to copy the history into
1252
648
:param revision_id: The revision-id to truncate history at. May
1253
649
be None to copy complete history.
1255
source_revno, source_revision_id = self.last_revision_info()
1256
if revision_id is None:
1257
revno, revision_id = source_revno, source_revision_id
1259
graph = self.repository.get_graph()
651
new_history = self.revision_history()
652
if revision_id is not None:
653
revision_id = osutils.safe_revision_id(revision_id)
1261
revno = graph.find_distance_to_null(revision_id,
1262
[(source_revision_id, source_revno)])
1263
except errors.GhostRevisionsHaveNoRevno:
1264
# Default to 1, if we can't find anything else
1266
destination.set_last_revision_info(revno, revision_id)
655
new_history = new_history[:new_history.index(revision_id) + 1]
657
rev = self.repository.get_revision(revision_id)
658
new_history = rev.get_history(self.repository)[1:]
659
destination.set_revision_history(new_history)
1268
661
@needs_read_lock
1269
662
def copy_content_into(self, destination, revision_id=None):
1283
675
destination.set_parent(parent)
1284
if self._push_should_merge_tags():
1285
self.tags.merge_to(destination.tags)
1287
def update_references(self, target):
1288
if not getattr(self._format, 'supports_reference_locations', False):
1290
reference_dict = self._get_all_reference_info()
1291
if len(reference_dict) == 0:
1293
old_base = self.base
1294
new_base = target.base
1295
target_reference_dict = target._get_all_reference_info()
1296
for file_id, (tree_path, branch_location) in (
1297
reference_dict.items()):
1298
branch_location = urlutils.rebase_url(branch_location,
1300
target_reference_dict.setdefault(
1301
file_id, (tree_path, branch_location))
1302
target._set_all_reference_info(target_reference_dict)
676
self.tags.merge_to(destination.tags)
1304
678
@needs_read_lock
1305
def check(self, refs):
1306
680
"""Check consistency of the branch.
1308
682
In particular this checks that revisions given in the revision-history
1309
do actually match up in the revision graph, and that they're all
683
do actually match up in the revision graph, and that they're all
1310
684
present in the repository.
1312
686
Callers will typically also want to check the repository.
1314
:param refs: Calculated refs for this branch as specified by
1315
branch._get_check_refs()
1316
688
:return: A BranchCheckResult.
1318
result = BranchCheckResult(self)
1319
last_revno, last_revision_id = self.last_revision_info()
1320
actual_revno = refs[('lefthand-distance', last_revision_id)]
1321
if actual_revno != last_revno:
1322
result.errors.append(errors.BzrCheckError(
1323
'revno does not match len(mainline) %s != %s' % (
1324
last_revno, actual_revno)))
1325
# TODO: We should probably also check that self.revision_history
1326
# matches the repository for older branch formats.
1327
# If looking for the code that cross-checks repository parents against
1328
# the iter_reverse_revision_history output, that is now a repository
690
mainline_parent_id = None
691
for revision_id in self.revision_history():
693
revision = self.repository.get_revision(revision_id)
694
except errors.NoSuchRevision, e:
695
raise errors.BzrCheckError("mainline revision {%s} not in repository"
697
# In general the first entry on the revision history has no parents.
698
# But it's not illegal for it to have parents listed; this can happen
699
# in imports from Arch when the parents weren't reachable.
700
if mainline_parent_id is not None:
701
if mainline_parent_id not in revision.parent_ids:
702
raise errors.BzrCheckError("previous revision {%s} not listed among "
704
% (mainline_parent_id, revision_id))
705
mainline_parent_id = revision_id
706
return BranchCheckResult(self)
1332
708
def _get_checkout_format(self):
1333
709
"""Return the most suitable metadir for a checkout of this branch.
1334
Weaves are used if this branch's repository uses weaves.
710
Weaves are used if this branch's repostory uses weaves.
1336
712
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1337
713
from bzrlib.repofmt import weaverepo
1342
718
format.set_branch_format(self._format)
1345
def create_clone_on_transport(self, to_transport, revision_id=None,
1346
stacked_on=None, create_prefix=False, use_existing_dir=False):
1347
"""Create a clone of this branch and its bzrdir.
1349
:param to_transport: The transport to clone onto.
1350
:param revision_id: The revision id to use as tip in the new branch.
1351
If None the tip is obtained from this branch.
1352
:param stacked_on: An optional URL to stack the clone on.
1353
:param create_prefix: Create any missing directories leading up to
1355
:param use_existing_dir: Use an existing directory if one exists.
1357
# XXX: Fix the bzrdir API to allow getting the branch back from the
1358
# clone call. Or something. 20090224 RBC/spiv.
1359
# XXX: Should this perhaps clone colocated branches as well,
1360
# rather than just the default branch? 20100319 JRV
1361
if revision_id is None:
1362
revision_id = self.last_revision()
1363
dir_to = self.bzrdir.clone_on_transport(to_transport,
1364
revision_id=revision_id, stacked_on=stacked_on,
1365
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1366
return dir_to.open_branch()
1368
721
def create_checkout(self, to_location, revision_id=None,
1369
lightweight=False, accelerator_tree=None,
1371
723
"""Create a checkout of a branch.
1373
725
:param to_location: The url to produce the checkout at
1374
726
:param revision_id: The revision to check out
1375
727
:param lightweight: If True, produce a lightweight checkout, otherwise,
1376
728
produce a bound branch (heavyweight checkout)
1377
:param accelerator_tree: A tree which can be used for retrieving file
1378
contents more quickly than the revision tree, i.e. a workingtree.
1379
The revision tree will be used for cases where accelerator_tree's
1380
content is different.
1381
:param hardlink: If true, hard-link files from accelerator_tree,
1383
729
:return: The tree of the created checkout
1385
731
t = transport.get_transport(to_location)
734
except errors.FileExists:
1388
737
format = self._get_checkout_format()
1389
738
checkout = format.initialize_on_transport(t)
1390
from_branch = BranchReferenceFormat().initialize(checkout,
739
BranchReferenceFormat().initialize(checkout, self)
1393
741
format = self._get_checkout_format()
1394
742
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1395
743
to_location, force_new_tree=False, format=format)
1396
744
checkout = checkout_branch.bzrdir
1397
745
checkout_branch.bind(self)
1398
# pull up to the specified revision_id to set the initial
746
# pull up to the specified revision_id to set the initial
1399
747
# branch tip correctly, and seed it with history.
1400
748
checkout_branch.pull(self, stop_revision=revision_id)
1402
tree = checkout.create_workingtree(revision_id,
1403
from_branch=from_branch,
1404
accelerator_tree=accelerator_tree,
749
tree = checkout.create_workingtree(revision_id)
1406
750
basis_tree = tree.basis_tree()
1407
751
basis_tree.lock_read()
1415
759
basis_tree.unlock()
1419
def reconcile(self, thorough=True):
1420
"""Make sure the data stored in this branch is consistent."""
1421
from bzrlib.reconcile import BranchReconciler
1422
reconciler = BranchReconciler(self, thorough=thorough)
1423
reconciler.reconcile()
1426
def reference_parent(self, file_id, path, possible_transports=None):
762
def reference_parent(self, file_id, path):
1427
763
"""Return the parent branch for a tree-reference file_id
1428
764
:param file_id: The file_id of the tree reference
1429
765
:param path: The path of the file_id in the tree
1430
766
:return: A branch associated with the file_id
1432
768
# FIXME should provide multiple branches, based on config
1433
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1434
possible_transports=possible_transports)
769
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1436
771
def supports_tags(self):
1437
772
return self._format.supports_tags()
1439
def automatic_tag_name(self, revision_id):
1440
"""Try to automatically find the tag name for a revision.
1442
:param revision_id: Revision id of the revision.
1443
:return: A tag name or None if no tag name could be determined.
1445
for hook in Branch.hooks['automatic_tag_name']:
1446
ret = hook(self, revision_id)
1451
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1453
"""Ensure that revision_b is a descendant of revision_a.
1455
This is a helper function for update_revisions.
1457
:raises: DivergedBranches if revision_b has diverged from revision_a.
1458
:returns: True if revision_b is a descendant of revision_a.
1460
relation = self._revision_relations(revision_a, revision_b, graph)
1461
if relation == 'b_descends_from_a':
1463
elif relation == 'diverged':
1464
raise errors.DivergedBranches(self, other_branch)
1465
elif relation == 'a_descends_from_b':
1468
raise AssertionError("invalid relation: %r" % (relation,))
1470
def _revision_relations(self, revision_a, revision_b, graph):
1471
"""Determine the relationship between two revisions.
1473
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1475
heads = graph.heads([revision_a, revision_b])
1476
if heads == set([revision_b]):
1477
return 'b_descends_from_a'
1478
elif heads == set([revision_a, revision_b]):
1479
# These branches have diverged
1481
elif heads == set([revision_a]):
1482
return 'a_descends_from_b'
1484
raise AssertionError("invalid heads: %r" % (heads,))
1487
775
class BranchFormat(object):
1488
776
"""An encapsulation of the initialization and open routines for a format.
1599
843
control_files = lockable_files.LockableFiles(branch_transport,
1600
844
lock_name, lock_class)
1601
845
control_files.create_lock()
1603
control_files.lock_write()
1604
except errors.LockContention:
1605
if lock_type != 'branch4':
846
control_files.lock_write()
1611
utf8_files += [('format', self.get_format_string())]
848
control_files.put_utf8('format', self.get_format_string())
1613
for (filename, content) in utf8_files:
1614
branch_transport.put_bytes(
1616
mode=a_bzrdir._get_file_mode())
850
for file, content in utf8_files:
851
control_files.put_utf8(file, content)
1619
control_files.unlock()
1620
branch = self.open(a_bzrdir, name, _found=True)
1621
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
853
control_files.unlock()
854
return self.open(a_bzrdir, _found=True)
1624
def initialize(self, a_bzrdir, name=None):
1625
"""Create a branch of this format in a_bzrdir.
1627
:param name: Name of the colocated branch to create.
856
def initialize(self, a_bzrdir):
857
"""Create a branch of this format in a_bzrdir."""
1629
858
raise NotImplementedError(self.initialize)
1631
860
def is_supported(self):
1632
861
"""Is this format supported?
1634
863
Supported formats can be initialized and opened.
1635
Unsupported formats may not support initialization or committing or
864
Unsupported formats may not support initialization or committing or
1636
865
some other features depending on the reason for not being supported.
1640
def make_tags(self, branch):
1641
"""Create a tags object for branch.
1643
This method is on BranchFormat, because BranchFormats are reflected
1644
over the wire via network_name(), whereas full Branch instances require
1645
multiple VFS method calls to operate at all.
1647
The default implementation returns a disabled-tags instance.
1649
Note that it is normal for branch to be a RemoteBranch when using tags
1652
return DisabledTags(branch)
1654
def network_name(self):
1655
"""A simple byte string uniquely identifying this format for RPC calls.
1657
MetaDir branch formats use their disk format string to identify the
1658
repository over the wire. All in one formats such as bzr < 0.8, and
1659
foreign formats like svn/git and hg should use some marker which is
1660
unique and immutable.
1662
raise NotImplementedError(self.network_name)
1664
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
869
def open(self, a_bzrdir, _found=False):
1665
870
"""Return the branch object for a_bzrdir
1667
:param a_bzrdir: A BzrDir that contains a branch.
1668
:param name: Name of colocated branch to open
1669
:param _found: a private parameter, do not use it. It is used to
1670
indicate if format probing has already be done.
1671
:param ignore_fallbacks: when set, no fallback branches will be opened
1672
(if there are any). Default is to open fallbacks.
872
_found is a private parameter, do not use it. It is used to indicate
873
if format probing has already be done.
1674
875
raise NotImplementedError(self.open)
1677
878
def register_format(klass, format):
1678
"""Register a metadir format."""
1679
879
klass._formats[format.get_format_string()] = format
1680
# Metadir formats have a network name of their format string, and get
1681
# registered as class factories.
1682
network_format_registry.register(format.get_format_string(), format.__class__)
1685
882
def set_default_format(klass, format):
1686
883
klass._default_format = format
1688
def supports_set_append_revisions_only(self):
1689
"""True if this format supports set_append_revisions_only."""
1692
def supports_stacking(self):
1693
"""True if this format records a stacked-on branch."""
1697
886
def unregister_format(klass, format):
887
assert klass._formats[format.get_format_string()] is format
1698
888
del klass._formats[format.get_format_string()]
1700
890
def __str__(self):
1701
return self.get_format_description().rstrip()
891
return self.get_format_string().rstrip()
1703
893
def supports_tags(self):
1704
894
"""True if this format supports tags stored in the branch"""
1705
895
return False # by default
897
# XXX: Probably doesn't really belong here -- mbp 20070212
898
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
900
branch_transport = a_bzrdir.get_branch_transport(self)
901
control_files = lockable_files.LockableFiles(branch_transport,
902
lock_filename, lock_class)
903
control_files.create_lock()
904
control_files.lock_write()
906
for filename, content in utf8_files:
907
control_files.put_utf8(filename, content)
909
control_files.unlock()
1708
912
class BranchHooks(Hooks):
1709
913
"""A dictionary mapping hook name to a list of callables for branch hooks.
1711
915
e.g. ['set_rh'] Is the list of items to be called when the
1712
916
set_revision_history function is invoked.
1721
925
Hooks.__init__(self)
1722
self.create_hook(HookPoint('set_rh',
1723
"Invoked whenever the revision history has been set via "
1724
"set_revision_history. The api signature is (branch, "
1725
"revision_history), and the branch will be write-locked. "
1726
"The set_rh hook can be expensive for bzr to trigger, a better "
1727
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1728
self.create_hook(HookPoint('open',
1729
"Called with the Branch object that has been opened after a "
1730
"branch is opened.", (1, 8), None))
1731
self.create_hook(HookPoint('post_push',
1732
"Called after a push operation completes. post_push is called "
1733
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1734
"bzr client.", (0, 15), None))
1735
self.create_hook(HookPoint('post_pull',
1736
"Called after a pull operation completes. post_pull is called "
1737
"with a bzrlib.branch.PullResult object and only runs in the "
1738
"bzr client.", (0, 15), None))
1739
self.create_hook(HookPoint('pre_commit',
1740
"Called after a commit is calculated but before it is is "
1741
"completed. pre_commit is called with (local, master, old_revno, "
1742
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1743
"). old_revid is NULL_REVISION for the first commit to a branch, "
1744
"tree_delta is a TreeDelta object describing changes from the "
1745
"basis revision. hooks MUST NOT modify this delta. "
1746
" future_tree is an in-memory tree obtained from "
1747
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1748
"tree.", (0,91), None))
1749
self.create_hook(HookPoint('post_commit',
1750
"Called in the bzr client after a commit has completed. "
1751
"post_commit is called with (local, master, old_revno, old_revid, "
1752
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1753
"commit to a branch.", (0, 15), None))
1754
self.create_hook(HookPoint('post_uncommit',
1755
"Called in the bzr client after an uncommit completes. "
1756
"post_uncommit is called with (local, master, old_revno, "
1757
"old_revid, new_revno, new_revid) where local is the local branch "
1758
"or None, master is the target branch, and an empty branch "
1759
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1760
self.create_hook(HookPoint('pre_change_branch_tip',
1761
"Called in bzr client and server before a change to the tip of a "
1762
"branch is made. pre_change_branch_tip is called with a "
1763
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1764
"commit, uncommit will all trigger this hook.", (1, 6), None))
1765
self.create_hook(HookPoint('post_change_branch_tip',
1766
"Called in bzr client and server after a change to the tip of a "
1767
"branch is made. post_change_branch_tip is called with a "
1768
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1769
"commit, uncommit will all trigger this hook.", (1, 4), None))
1770
self.create_hook(HookPoint('transform_fallback_location',
1771
"Called when a stacked branch is activating its fallback "
1772
"locations. transform_fallback_location is called with (branch, "
1773
"url), and should return a new url. Returning the same url "
1774
"allows it to be used as-is, returning a different one can be "
1775
"used to cause the branch to stack on a closer copy of that "
1776
"fallback_location. Note that the branch cannot have history "
1777
"accessing methods called on it during this hook because the "
1778
"fallback locations have not been activated. When there are "
1779
"multiple hooks installed for transform_fallback_location, "
1780
"all are called with the url returned from the previous hook."
1781
"The order is however undefined.", (1, 9), None))
1782
self.create_hook(HookPoint('automatic_tag_name',
1783
"Called to determine an automatic tag name for a revision."
1784
"automatic_tag_name is called with (branch, revision_id) and "
1785
"should return a tag name or None if no tag name could be "
1786
"determined. The first non-None tag name returned will be used.",
1788
self.create_hook(HookPoint('post_branch_init',
1789
"Called after new branch initialization completes. "
1790
"post_branch_init is called with a "
1791
"bzrlib.branch.BranchInitHookParams. "
1792
"Note that init, branch and checkout (both heavyweight and "
1793
"lightweight) will all trigger this hook.", (2, 2), None))
1794
self.create_hook(HookPoint('post_switch',
1795
"Called after a checkout switches branch. "
1796
"post_switch is called with a "
1797
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
926
# Introduced in 0.15:
927
# invoked whenever the revision history has been set
928
# with set_revision_history. The api signature is
929
# (branch, revision_history), and the branch will
932
# invoked after a push operation completes.
933
# the api signature is
935
# containing the members
936
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
937
# where local is the local branch or None, master is the target
938
# master branch, and the rest should be self explanatory. The source
939
# is read locked and the target branches write locked. Source will
940
# be the local low-latency branch.
941
self['post_push'] = []
942
# invoked after a pull operation completes.
943
# the api signature is
945
# containing the members
946
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
947
# where local is the local branch or None, master is the target
948
# master branch, and the rest should be self explanatory. The source
949
# is read locked and the target branches write locked. The local
950
# branch is the low-latency branch.
951
self['post_pull'] = []
952
# invoked after a commit operation completes.
953
# the api signature is
954
# (local, master, old_revno, old_revid, new_revno, new_revid)
955
# old_revid is NULL_REVISION for the first commit to a branch.
956
self['post_commit'] = []
957
# invoked after a uncommit operation completes.
958
# the api signature is
959
# (local, master, old_revno, old_revid, new_revno, new_revid) where
960
# local is the local branch or None, master is the target branch,
961
# and an empty branch recieves new_revno of 0, new_revid of None.
962
self['post_uncommit'] = []
1801
965
# install the default hooks into the Branch class.
1802
966
Branch.hooks = BranchHooks()
1805
class ChangeBranchTipParams(object):
1806
"""Object holding parameters passed to *_change_branch_tip hooks.
1808
There are 5 fields that hooks may wish to access:
1810
:ivar branch: the branch being changed
1811
:ivar old_revno: revision number before the change
1812
:ivar new_revno: revision number after the change
1813
:ivar old_revid: revision id before the change
1814
:ivar new_revid: revision id after the change
1816
The revid fields are strings. The revno fields are integers.
1819
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1820
"""Create a group of ChangeBranchTip parameters.
1822
:param branch: The branch being changed.
1823
:param old_revno: Revision number before the change.
1824
:param new_revno: Revision number after the change.
1825
:param old_revid: Tip revision id before the change.
1826
:param new_revid: Tip revision id after the change.
1828
self.branch = branch
1829
self.old_revno = old_revno
1830
self.new_revno = new_revno
1831
self.old_revid = old_revid
1832
self.new_revid = new_revid
1834
def __eq__(self, other):
1835
return self.__dict__ == other.__dict__
1838
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1839
self.__class__.__name__, self.branch,
1840
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1843
class BranchInitHookParams(object):
1844
"""Object holding parameters passed to *_branch_init hooks.
1846
There are 4 fields that hooks may wish to access:
1848
:ivar format: the branch format
1849
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1850
:ivar name: name of colocated branch, if any (or None)
1851
:ivar branch: the branch created
1853
Note that for lightweight checkouts, the bzrdir and format fields refer to
1854
the checkout, hence they are different from the corresponding fields in
1855
branch, which refer to the original branch.
1858
def __init__(self, format, a_bzrdir, name, branch):
1859
"""Create a group of BranchInitHook parameters.
1861
:param format: the branch format
1862
:param a_bzrdir: the BzrDir where the branch will be/has been
1864
:param name: name of colocated branch, if any (or None)
1865
:param branch: the branch created
1867
Note that for lightweight checkouts, the bzrdir and format fields refer
1868
to the checkout, hence they are different from the corresponding fields
1869
in branch, which refer to the original branch.
1871
self.format = format
1872
self.bzrdir = a_bzrdir
1874
self.branch = branch
1876
def __eq__(self, other):
1877
return self.__dict__ == other.__dict__
1881
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1883
return "<%s of format:%s bzrdir:%s>" % (
1884
self.__class__.__name__, self.branch,
1885
self.format, self.bzrdir)
1888
class SwitchHookParams(object):
1889
"""Object holding parameters passed to *_switch hooks.
1891
There are 4 fields that hooks may wish to access:
1893
:ivar control_dir: BzrDir of the checkout to change
1894
:ivar to_branch: branch that the checkout is to reference
1895
:ivar force: skip the check for local commits in a heavy checkout
1896
:ivar revision_id: revision ID to switch to (or None)
1899
def __init__(self, control_dir, to_branch, force, revision_id):
1900
"""Create a group of SwitchHook parameters.
1902
:param control_dir: BzrDir of the checkout to change
1903
:param to_branch: branch that the checkout is to reference
1904
:param force: skip the check for local commits in a heavy checkout
1905
:param revision_id: revision ID to switch to (or None)
1907
self.control_dir = control_dir
1908
self.to_branch = to_branch
1910
self.revision_id = revision_id
1912
def __eq__(self, other):
1913
return self.__dict__ == other.__dict__
1916
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1917
self.control_dir, self.to_branch,
1921
969
class BzrBranchFormat4(BranchFormat):
1922
970
"""Bzr branch format 4.
1930
978
"""See BranchFormat.get_format_description()."""
1931
979
return "Branch format 4"
1933
def initialize(self, a_bzrdir, name=None):
981
def initialize(self, a_bzrdir):
1934
982
"""Create a branch of this format in a_bzrdir."""
1935
983
utf8_files = [('revision-history', ''),
1936
984
('branch-name', ''),
1938
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
986
return self._initialize_helper(a_bzrdir, utf8_files,
1939
987
lock_type='branch4', set_format=False)
1941
989
def __init__(self):
1942
990
super(BzrBranchFormat4, self).__init__()
1943
991
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1945
def network_name(self):
1946
"""The network name for this format is the control dirs disk label."""
1947
return self._matchingbzrdir.get_format_string()
993
def open(self, a_bzrdir, _found=False):
994
"""Return the branch object for a_bzrdir
1949
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1950
"""See BranchFormat.open()."""
996
_found is a private parameter, do not use it. It is used to indicate
997
if format probing has already be done.
1952
1000
# we are being called directly and must probe.
1953
1001
raise NotImplementedError
1954
1002
return BzrBranch(_format=self,
1955
1003
_control_files=a_bzrdir._control_files,
1956
1004
a_bzrdir=a_bzrdir,
1958
1005
_repository=a_bzrdir.open_repository())
1960
1007
def __str__(self):
1961
1008
return "Bazaar-NG branch format 4"
1964
class BranchFormatMetadir(BranchFormat):
1965
"""Common logic for meta-dir based branch formats."""
1967
def _branch_class(self):
1968
"""What class to instantiate on open calls."""
1969
raise NotImplementedError(self._branch_class)
1971
def network_name(self):
1972
"""A simple byte string uniquely identifying this format for RPC calls.
1974
Metadir branch formats use their format string.
1976
return self.get_format_string()
1978
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1979
"""See BranchFormat.open()."""
1981
format = BranchFormat.find_format(a_bzrdir, name=name)
1982
if format.__class__ != self.__class__:
1983
raise AssertionError("wrong format %r found for %r" %
1985
transport = a_bzrdir.get_branch_transport(None, name=name)
1987
control_files = lockable_files.LockableFiles(transport, 'lock',
1989
return self._branch_class()(_format=self,
1990
_control_files=control_files,
1993
_repository=a_bzrdir.find_repository(),
1994
ignore_fallbacks=ignore_fallbacks)
1995
except errors.NoSuchFile:
1996
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1999
super(BranchFormatMetadir, self).__init__()
2000
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2001
self._matchingbzrdir.set_branch_format(self)
2003
def supports_tags(self):
2007
class BzrBranchFormat5(BranchFormatMetadir):
1011
class BzrBranchFormat5(BranchFormat):
2008
1012
"""Bzr branch format 5.
2010
1014
This format has:
2061
1076
"""See BranchFormat.get_format_description()."""
2062
1077
return "Branch format 6"
2064
def initialize(self, a_bzrdir, name=None):
2065
"""Create a branch of this format in a_bzrdir."""
2066
utf8_files = [('last-revision', '0 null:\n'),
2067
('branch.conf', ''),
2070
return self._initialize_helper(a_bzrdir, utf8_files, name)
2072
def make_tags(self, branch):
2073
"""See bzrlib.branch.BranchFormat.make_tags()."""
2074
return BasicTags(branch)
2076
def supports_set_append_revisions_only(self):
2080
class BzrBranchFormat8(BranchFormatMetadir):
2081
"""Metadir format supporting storing locations of subtree branches."""
2083
def _branch_class(self):
2086
def get_format_string(self):
2087
"""See BranchFormat.get_format_string()."""
2088
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2090
def get_format_description(self):
2091
"""See BranchFormat.get_format_description()."""
2092
return "Branch format 8"
2094
def initialize(self, a_bzrdir, name=None):
2095
"""Create a branch of this format in a_bzrdir."""
2096
utf8_files = [('last-revision', '0 null:\n'),
2097
('branch.conf', ''),
2101
return self._initialize_helper(a_bzrdir, utf8_files, name)
2104
super(BzrBranchFormat8, self).__init__()
2105
self._matchingbzrdir.repository_format = \
2106
RepositoryFormatKnitPack5RichRoot()
2108
def make_tags(self, branch):
2109
"""See bzrlib.branch.BranchFormat.make_tags()."""
2110
return BasicTags(branch)
2112
def supports_set_append_revisions_only(self):
2115
def supports_stacking(self):
2118
supports_reference_locations = True
2121
class BzrBranchFormat7(BzrBranchFormat8):
2122
"""Branch format with last-revision, tags, and a stacked location pointer.
2124
The stacked location pointer is passed down to the repository and requires
2125
a repository format with supports_external_lookups = True.
2127
This format was introduced in bzr 1.6.
2130
def initialize(self, a_bzrdir, name=None):
2131
"""Create a branch of this format in a_bzrdir."""
2132
utf8_files = [('last-revision', '0 null:\n'),
2133
('branch.conf', ''),
2136
return self._initialize_helper(a_bzrdir, utf8_files, name)
2138
def _branch_class(self):
2141
def get_format_string(self):
2142
"""See BranchFormat.get_format_string()."""
2143
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2145
def get_format_description(self):
2146
"""See BranchFormat.get_format_description()."""
2147
return "Branch format 7"
2149
def supports_set_append_revisions_only(self):
2152
supports_reference_locations = False
1079
def initialize(self, a_bzrdir):
1080
"""Create a branch of this format in a_bzrdir."""
1081
utf8_files = [('last-revision', '0 null:\n'),
1082
('branch-name', ''),
1083
('branch.conf', ''),
1086
return self._initialize_helper(a_bzrdir, utf8_files)
1088
def open(self, a_bzrdir, _found=False):
1089
"""Return the branch object for a_bzrdir
1091
_found is a private parameter, do not use it. It is used to indicate
1092
if format probing has already be done.
1095
format = BranchFormat.find_format(a_bzrdir)
1096
assert format.__class__ == self.__class__
1097
transport = a_bzrdir.get_branch_transport(None)
1098
control_files = lockable_files.LockableFiles(transport, 'lock',
1100
return BzrBranch6(_format=self,
1101
_control_files=control_files,
1103
_repository=a_bzrdir.find_repository())
1105
def supports_tags(self):
2155
1109
class BranchReferenceFormat(BranchFormat):
2170
1124
def get_format_description(self):
2171
1125
"""See BranchFormat.get_format_description()."""
2172
1126
return "Checkout reference format 1"
2174
def get_reference(self, a_bzrdir, name=None):
2175
"""See BranchFormat.get_reference()."""
2176
transport = a_bzrdir.get_branch_transport(None, name=name)
2177
return transport.get_bytes('location')
2179
def set_reference(self, a_bzrdir, name, to_branch):
2180
"""See BranchFormat.set_reference()."""
2181
transport = a_bzrdir.get_branch_transport(None, name=name)
2182
location = transport.put_bytes('location', to_branch.base)
2184
def initialize(self, a_bzrdir, name=None, target_branch=None):
1128
def initialize(self, a_bzrdir, target_branch=None):
2185
1129
"""Create a branch of this format in a_bzrdir."""
2186
1130
if target_branch is None:
2187
1131
# this format does not implement branch itself, thus the implicit
2188
1132
# creation contract must see it as uninitializable
2189
1133
raise errors.UninitializableFormat(self)
2190
mutter('creating branch reference in %s', a_bzrdir.user_url)
2191
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1134
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1135
branch_transport = a_bzrdir.get_branch_transport(self)
2192
1136
branch_transport.put_bytes('location',
2193
target_branch.bzrdir.user_url)
1137
target_branch.bzrdir.root_transport.base)
2194
1138
branch_transport.put_bytes('format', self.get_format_string())
2196
a_bzrdir, name, _found=True,
2197
possible_transports=[target_branch.bzrdir.root_transport])
2198
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1139
return self.open(a_bzrdir, _found=True)
2201
1141
def __init__(self):
2202
1142
super(BranchReferenceFormat, self).__init__()
2203
1143
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2204
self._matchingbzrdir.set_branch_format(self)
2206
1145
def _make_reference_clone_function(format, a_branch):
2207
1146
"""Create a clone() routine for a branch dynamically."""
2208
def clone(to_bzrdir, revision_id=None,
2209
repository_policy=None):
1147
def clone(to_bzrdir, revision_id=None):
2210
1148
"""See Branch.clone()."""
2211
return format.initialize(to_bzrdir, target_branch=a_branch)
1149
return format.initialize(to_bzrdir, a_branch)
2212
1150
# cannot obey revision_id limits when cloning a reference ...
2213
1151
# FIXME RBC 20060210 either nuke revision_id for clone, or
2214
1152
# emit some sort of warning/error to the caller ?!
2217
def open(self, a_bzrdir, name=None, _found=False, location=None,
2218
possible_transports=None, ignore_fallbacks=False):
1155
def open(self, a_bzrdir, _found=False):
2219
1156
"""Return the branch that the branch reference in a_bzrdir points at.
2221
:param a_bzrdir: A BzrDir that contains a branch.
2222
:param name: Name of colocated branch to open, if any
2223
:param _found: a private parameter, do not use it. It is used to
2224
indicate if format probing has already be done.
2225
:param ignore_fallbacks: when set, no fallback branches will be opened
2226
(if there are any). Default is to open fallbacks.
2227
:param location: The location of the referenced branch. If
2228
unspecified, this will be determined from the branch reference in
2230
:param possible_transports: An optional reusable transports list.
1158
_found is a private parameter, do not use it. It is used to indicate
1159
if format probing has already be done.
2233
format = BranchFormat.find_format(a_bzrdir, name=name)
2234
if format.__class__ != self.__class__:
2235
raise AssertionError("wrong format %r found for %r" %
2237
if location is None:
2238
location = self.get_reference(a_bzrdir, name)
2239
real_bzrdir = bzrdir.BzrDir.open(
2240
location, possible_transports=possible_transports)
2241
result = real_bzrdir.open_branch(name=name,
2242
ignore_fallbacks=ignore_fallbacks)
1162
format = BranchFormat.find_format(a_bzrdir)
1163
assert format.__class__ == self.__class__
1164
transport = a_bzrdir.get_branch_transport(None)
1165
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1166
result = real_bzrdir.open_branch()
2243
1167
# this changes the behaviour of result.clone to create a new reference
2244
1168
# rather than a copy of the content of the branch.
2245
1169
# I did not use a proxy object because that needs much more extensive
2255
network_format_registry = registry.FormatRegistry()
2256
"""Registry of formats indexed by their network name.
2258
The network name for a branch format is an identifier that can be used when
2259
referring to formats with smart server operations. See
2260
BranchFormat.network_name() for more detail.
2264
1179
# formats which have no format string are not discoverable
2265
1180
# and not independently creatable, so are not registered.
2266
__format5 = BzrBranchFormat5()
2267
__format6 = BzrBranchFormat6()
2268
__format7 = BzrBranchFormat7()
2269
__format8 = BzrBranchFormat8()
2270
BranchFormat.register_format(__format5)
1181
__default_format = BzrBranchFormat5()
1182
BranchFormat.register_format(__default_format)
2271
1183
BranchFormat.register_format(BranchReferenceFormat())
2272
BranchFormat.register_format(__format6)
2273
BranchFormat.register_format(__format7)
2274
BranchFormat.register_format(__format8)
2275
BranchFormat.set_default_format(__format7)
1184
BranchFormat.register_format(BzrBranchFormat6())
1185
BranchFormat.set_default_format(__default_format)
2276
1186
_legacy_formats = [BzrBranchFormat4(),
2278
network_format_registry.register(
2279
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2282
class BranchWriteLockResult(LogicalLockResult):
2283
"""The result of write locking a branch.
2285
:ivar branch_token: The token obtained from the underlying branch lock, or
2287
:ivar unlock: A callable which will unlock the lock.
2290
def __init__(self, unlock, branch_token):
2291
LogicalLockResult.__init__(self, unlock)
2292
self.branch_token = branch_token
2295
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2299
class BzrBranch(Branch, _RelockDebugMixin):
1189
class BzrBranch(Branch):
2300
1190
"""A branch stored in the actual filesystem.
2302
1192
Note that it's "local" in the context of the filesystem; it doesn't
2303
1193
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2304
1194
it's writable, and can be accessed via the normal filesystem API.
2306
:ivar _transport: Transport for file operations on this branch's
2307
control files, typically pointing to the .bzr/branch directory.
2308
:ivar repository: Repository for this branch.
2309
:ivar base: The url of the base directory for this branch; the one
2310
containing the .bzr directory.
2311
:ivar name: Optional colocated branch name as it exists in the control
2315
1197
def __init__(self, _format=None,
2316
_control_files=None, a_bzrdir=None, name=None,
2317
_repository=None, ignore_fallbacks=False):
1198
_control_files=None, a_bzrdir=None, _repository=None):
2318
1199
"""Create new branch object at a particular location."""
1200
Branch.__init__(self)
2319
1201
if a_bzrdir is None:
2320
1202
raise ValueError('a_bzrdir must be supplied')
2322
1204
self.bzrdir = a_bzrdir
1205
# self._transport used to point to the directory containing the
1206
# control directory, but was not used - now it's just the transport
1207
# for the branch control files. mbp 20070212
2323
1208
self._base = self.bzrdir.transport.clone('..').base
2325
# XXX: We should be able to just do
2326
# self.base = self.bzrdir.root_transport.base
2327
# but this does not quite work yet -- mbp 20080522
2328
1209
self._format = _format
2329
1210
if _control_files is None:
2330
1211
raise ValueError('BzrBranch _control_files is None')
2331
1212
self.control_files = _control_files
2332
1213
self._transport = _control_files._transport
2333
1214
self.repository = _repository
2334
Branch.__init__(self)
2336
1216
def __str__(self):
2337
if self.name is None:
2338
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2340
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
1217
return '%s(%r)' % (self.__class__.__name__, self.base)
2343
1219
__repr__ = __str__
2349
1225
base = property(_get_base, doc="The URL for the root of this branch.")
2351
def _get_config(self):
2352
return TransportConfig(self._transport, 'branch.conf')
1227
def abspath(self, name):
1228
"""See Branch.abspath."""
1229
return self.control_files._transport.abspath(name)
1232
@deprecated_method(zero_sixteen)
1234
def get_root_id(self):
1235
"""See Branch.get_root_id."""
1236
tree = self.repository.revision_tree(self.last_revision())
1237
return tree.inventory.root.file_id
2354
1239
def is_locked(self):
2355
1240
return self.control_files.is_locked()
2357
1242
def lock_write(self, token=None):
2358
"""Lock the branch for write operations.
2360
:param token: A token to permit reacquiring a previously held and
2362
:return: A BranchWriteLockResult.
2364
if not self.is_locked():
2365
self._note_lock('w')
2366
# All-in-one needs to always unlock/lock.
2367
repo_control = getattr(self.repository, 'control_files', None)
2368
if self.control_files == repo_control or not self.is_locked():
2369
self.repository._warn_if_deprecated(self)
2370
self.repository.lock_write()
1243
repo_token = self.repository.lock_write()
2375
return BranchWriteLockResult(self.unlock,
2376
self.control_files.lock_write(token=token))
1245
token = self.control_files.lock_write(token=token)
2379
self.repository.unlock()
1247
self.repository.unlock()
2382
1251
def lock_read(self):
2383
"""Lock the branch for read operations.
2385
:return: A bzrlib.lock.LogicalLockResult.
2387
if not self.is_locked():
2388
self._note_lock('r')
2389
# All-in-one needs to always unlock/lock.
2390
repo_control = getattr(self.repository, 'control_files', None)
2391
if self.control_files == repo_control or not self.is_locked():
2392
self.repository._warn_if_deprecated(self)
2393
self.repository.lock_read()
1252
self.repository.lock_read()
2398
1254
self.control_files.lock_read()
2399
return LogicalLockResult(self.unlock)
2402
self.repository.unlock()
1256
self.repository.unlock()
2405
@only_raises(errors.LockNotHeld, errors.LockBroken)
2406
1259
def unlock(self):
1260
# TODO: test for failed two phase locks. This is known broken.
2408
1262
self.control_files.unlock()
2410
# All-in-one needs to always unlock/lock.
2411
repo_control = getattr(self.repository, 'control_files', None)
2412
if (self.control_files == repo_control or
2413
not self.control_files.is_locked()):
2414
self.repository.unlock()
2415
if not self.control_files.is_locked():
2416
# we just released the lock
2417
self._clear_cached_state()
1264
self.repository.unlock()
1265
if not self.control_files.is_locked():
1266
# we just released the lock
1267
self._clear_cached_state()
2419
1269
def peek_lock_mode(self):
2420
1270
if self.control_files._lock_count == 0:
2430
1280
"""See Branch.print_file."""
2431
1281
return self.repository.print_file(file, revision_id)
1284
def append_revision(self, *revision_ids):
1285
"""See Branch.append_revision."""
1286
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1287
for revision_id in revision_ids:
1288
_mod_revision.check_not_reserved_id(revision_id)
1289
mutter("add {%s} to revision-history" % revision_id)
1290
rev_history = self.revision_history()
1291
rev_history.extend(revision_ids)
1292
self.set_revision_history(rev_history)
2433
1294
def _write_revision_history(self, history):
2434
1295
"""Factored out of set_revision_history.
2436
1297
This performs the actual writing to disk.
2437
1298
It is intended to be called by BzrBranch5.set_revision_history."""
2438
self._transport.put_bytes(
2439
'revision-history', '\n'.join(history),
2440
mode=self.bzrdir._get_file_mode())
1299
self.control_files.put_bytes(
1300
'revision-history', '\n'.join(history))
2442
1302
@needs_write_lock
2443
1303
def set_revision_history(self, rev_history):
2444
1304
"""See Branch.set_revision_history."""
2445
if 'evil' in debug.debug_flags:
2446
mutter_callsite(3, "set_revision_history scales with history.")
2447
check_not_reserved_id = _mod_revision.check_not_reserved_id
2448
for rev_id in rev_history:
2449
check_not_reserved_id(rev_id)
2450
if Branch.hooks['post_change_branch_tip']:
2451
# Don't calculate the last_revision_info() if there are no hooks
2453
old_revno, old_revid = self.last_revision_info()
2454
if len(rev_history) == 0:
2455
revid = _mod_revision.NULL_REVISION
2457
revid = rev_history[-1]
2458
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1305
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
2459
1306
self._write_revision_history(rev_history)
2460
self._clear_cached_state()
2461
1307
self._cache_revision_history(rev_history)
2462
1308
for hook in Branch.hooks['set_rh']:
2463
1309
hook(self, rev_history)
2464
if Branch.hooks['post_change_branch_tip']:
2465
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2467
def _synchronize_history(self, destination, revision_id):
2468
"""Synchronize last revision and revision history between branches.
2470
This version is most efficient when the destination is also a
2471
BzrBranch5, but works for BzrBranch6 as long as the revision
2472
history is the true lefthand parent history, and all of the revisions
2473
are in the destination's repository. If not, set_revision_history
2476
:param destination: The branch to copy the history into
2477
:param revision_id: The revision-id to truncate history at. May
2478
be None to copy complete history.
2480
if not isinstance(destination._format, BzrBranchFormat5):
2481
super(BzrBranch, self)._synchronize_history(
2482
destination, revision_id)
2484
if revision_id == _mod_revision.NULL_REVISION:
2487
new_history = self.revision_history()
2488
if revision_id is not None and new_history != []:
2490
new_history = new_history[:new_history.index(revision_id) + 1]
2492
rev = self.repository.get_revision(revision_id)
2493
new_history = rev.get_history(self.repository)[1:]
2494
destination.set_revision_history(new_history)
2496
1311
@needs_write_lock
2497
1312
def set_last_revision_info(self, revno, revision_id):
2498
"""Set the last revision of this branch.
2500
The caller is responsible for checking that the revno is correct
2501
for this revision id.
2503
It may be possible to set the branch last revision to an id not
2504
present in the repository. However, branches can also be
2505
configured to check constraints on history, in which case this may not
2508
revision_id = _mod_revision.ensure_null(revision_id)
2509
# this old format stores the full history, but this api doesn't
2510
# provide it, so we must generate, and might as well check it's
1313
revision_id = osutils.safe_revision_id(revision_id)
2512
1314
history = self._lefthand_history(revision_id)
2513
if len(history) != revno:
2514
raise AssertionError('%d != %d' % (len(history), revno))
1315
assert len(history) == revno, '%d != %d' % (len(history), revno)
2515
1316
self.set_revision_history(history)
2517
1318
def _gen_revision_history(self):
2518
history = self._transport.get_bytes('revision-history').split('\n')
1319
history = self.control_files.get('revision-history').read().split('\n')
2519
1320
if history[-1:] == ['']:
2520
1321
# There shouldn't be a trailing newline, but just in case.
1325
def _lefthand_history(self, revision_id, last_rev=None,
1327
# stop_revision must be a descendant of last_revision
1328
stop_graph = self.repository.get_revision_graph(revision_id)
1329
if last_rev is not None and last_rev not in stop_graph:
1330
# our previous tip is not merged into stop_revision
1331
raise errors.DivergedBranches(self, other_branch)
1332
# make a new revision history from the graph
1333
current_rev_id = revision_id
1335
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1336
new_history.append(current_rev_id)
1337
current_rev_id_parents = stop_graph[current_rev_id]
1339
current_rev_id = current_rev_id_parents[0]
1341
current_rev_id = None
1342
new_history.reverse()
2524
1345
@needs_write_lock
2525
1346
def generate_revision_history(self, revision_id, last_rev=None,
2526
1347
other_branch=None):
2532
1353
:param other_branch: The other branch that DivergedBranches should
2533
1354
raise with respect to.
1356
revision_id = osutils.safe_revision_id(revision_id)
2535
1357
self.set_revision_history(self._lefthand_history(revision_id,
2536
1358
last_rev, other_branch))
1361
def update_revisions(self, other, stop_revision=None):
1362
"""See Branch.update_revisions."""
1365
if stop_revision is None:
1366
stop_revision = other.last_revision()
1367
if stop_revision is None:
1368
# if there are no commits, we're done.
1371
stop_revision = osutils.safe_revision_id(stop_revision)
1372
# whats the current last revision, before we fetch [and change it
1374
last_rev = self.last_revision()
1375
# we fetch here regardless of whether we need to so that we pickup
1377
self.fetch(other, stop_revision)
1378
my_ancestry = self.repository.get_ancestry(last_rev)
1379
if stop_revision in my_ancestry:
1380
# last_revision is a descendant of stop_revision
1382
self.generate_revision_history(stop_revision, last_rev=last_rev,
2538
1387
def basis_tree(self):
2539
1388
"""See Branch.basis_tree."""
2540
1389
return self.repository.revision_tree(self.last_revision())
1391
@deprecated_method(zero_eight)
1392
def working_tree(self):
1393
"""Create a Working tree object for this branch."""
1395
from bzrlib.transport.local import LocalTransport
1396
if (self.base.find('://') != -1 or
1397
not isinstance(self._transport, LocalTransport)):
1398
raise NoWorkingTree(self.base)
1399
return self.bzrdir.open_workingtree()
1402
def pull(self, source, overwrite=False, stop_revision=None,
1403
_hook_master=None, _run_hooks=True):
1406
:param _hook_master: Private parameter - set the branch to
1407
be supplied as the master to push hooks.
1408
:param _run_hooks: Private parameter - allow disabling of
1409
hooks, used when pushing to a master branch.
1411
result = PullResult()
1412
result.source_branch = source
1413
result.target_branch = self
1416
result.old_revno, result.old_revid = self.last_revision_info()
1418
self.update_revisions(source, stop_revision)
1419
except DivergedBranches:
1423
if stop_revision is None:
1424
stop_revision = source.last_revision()
1425
self.generate_revision_history(stop_revision)
1426
result.tag_conflicts = source.tags.merge_to(self.tags)
1427
result.new_revno, result.new_revid = self.last_revision_info()
1429
result.master_branch = _hook_master
1430
result.local_branch = self
1432
result.master_branch = self
1433
result.local_branch = None
1435
for hook in Branch.hooks['post_pull']:
2542
1441
def _get_parent_location(self):
2543
1442
_locs = ['parent', 'pull', 'x-pull']
2544
1443
for l in _locs:
2546
return self._transport.get_bytes(l).strip('\n')
2547
except errors.NoSuchFile:
1445
return self.control_files.get(l).read().strip('\n')
2551
def _basic_push(self, target, overwrite, stop_revision):
2552
"""Basic implementation of push without bound branches or hooks.
2554
Must be called with source read locked and target write locked.
1451
def push(self, target, overwrite=False, stop_revision=None,
1452
_hook_master=None, _run_hooks=True):
1455
:param _hook_master: Private parameter - set the branch to
1456
be supplied as the master to push hooks.
1457
:param _run_hooks: Private parameter - allow disabling of
1458
hooks, used when pushing to a master branch.
2556
result = BranchPushResult()
1460
result = PushResult()
2557
1461
result.source_branch = self
2558
1462
result.target_branch = target
2559
result.old_revno, result.old_revid = target.last_revision_info()
2560
self.update_references(target)
2561
if result.old_revid != self.last_revision():
2562
# We assume that during 'push' this repository is closer than
2564
graph = self.repository.get_graph(target.repository)
2565
target.update_revisions(self, stop_revision,
2566
overwrite=overwrite, graph=graph)
2567
if self._push_should_merge_tags():
2568
result.tag_conflicts = self.tags.merge_to(target.tags,
2570
result.new_revno, result.new_revid = target.last_revision_info()
1465
result.old_revno, result.old_revid = target.last_revision_info()
1467
target.update_revisions(self, stop_revision)
1468
except DivergedBranches:
1472
target.set_revision_history(self.revision_history())
1473
result.tag_conflicts = self.tags.merge_to(target.tags)
1474
result.new_revno, result.new_revid = target.last_revision_info()
1476
result.master_branch = _hook_master
1477
result.local_branch = target
1479
result.master_branch = target
1480
result.local_branch = None
1482
for hook in Branch.hooks['post_push']:
2573
def get_stacked_on_url(self):
2574
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1488
def get_parent(self):
1489
"""See Branch.get_parent."""
1491
assert self.base[-1] == '/'
1492
parent = self._get_parent_location()
1495
# This is an old-format absolute path to a local branch
1496
# turn it into a url
1497
if parent.startswith('/'):
1498
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1500
return urlutils.join(self.base[:-1], parent)
1501
except errors.InvalidURLJoin, e:
1502
raise errors.InaccessibleParent(parent, self.base)
1504
def get_push_location(self):
1505
"""See Branch.get_push_location."""
1506
push_loc = self.get_config().get_user_option('push_location')
2576
1509
def set_push_location(self, location):
2577
1510
"""See Branch.set_push_location."""
2579
1512
'push_location', location,
2580
1513
store=_mod_config.STORE_LOCATION_NORECURSE)
1516
def set_parent(self, url):
1517
"""See Branch.set_parent."""
1518
# TODO: Maybe delete old location files?
1519
# URLs should never be unicode, even on the local fs,
1520
# FIXUP this and get_parent in a future branch format bump:
1521
# read and rewrite the file, and have the new format code read
1522
# using .get not .get_utf8. RBC 20060125
1524
if isinstance(url, unicode):
1526
url = url.encode('ascii')
1527
except UnicodeEncodeError:
1528
raise bzrlib.errors.InvalidURL(url,
1529
"Urls must be 7-bit ascii, "
1530
"use bzrlib.urlutils.escape")
1531
url = urlutils.relative_url(self.base, url)
1532
self._set_parent_location(url)
2582
1534
def _set_parent_location(self, url):
2583
1535
if url is None:
2584
self._transport.delete('parent')
1536
self.control_files._transport.delete('parent')
2586
self._transport.put_bytes('parent', url + '\n',
2587
mode=self.bzrdir._get_file_mode())
1538
assert isinstance(url, str)
1539
self.control_files.put_bytes('parent', url + '\n')
1541
@deprecated_function(zero_nine)
1542
def tree_config(self):
1543
"""DEPRECATED; call get_config instead.
1544
TreeConfig has become part of BranchConfig."""
1545
return TreeConfig(self)
2590
1548
class BzrBranch5(BzrBranch):
2591
"""A format 5 branch. This supports new features over plain branches.
1549
"""A format 5 branch. This supports new features over plan branches.
2593
1551
It has support for a master_branch which is the data for bound branches.
1559
super(BzrBranch5, self).__init__(_format=_format,
1560
_control_files=_control_files,
1562
_repository=_repository)
1565
def pull(self, source, overwrite=False, stop_revision=None,
1567
"""Extends branch.pull to be bound branch aware.
1569
:param _run_hooks: Private parameter used to force hook running
1570
off during bound branch double-pushing.
1572
bound_location = self.get_bound_location()
1573
master_branch = None
1574
if bound_location and source.base != bound_location:
1575
# not pulling from master, so we need to update master.
1576
master_branch = self.get_master_branch()
1577
master_branch.lock_write()
1580
# pull from source into master.
1581
master_branch.pull(source, overwrite, stop_revision,
1583
return super(BzrBranch5, self).pull(source, overwrite,
1584
stop_revision, _hook_master=master_branch,
1585
_run_hooks=_run_hooks)
1588
master_branch.unlock()
1591
def push(self, target, overwrite=False, stop_revision=None):
1592
"""Updates branch.push to be bound branch aware."""
1593
bound_location = target.get_bound_location()
1594
master_branch = None
1595
if bound_location and target.base != bound_location:
1596
# not pushing to master, so we need to update master.
1597
master_branch = target.get_master_branch()
1598
master_branch.lock_write()
1601
# push into the master from this branch.
1602
super(BzrBranch5, self).push(master_branch, overwrite,
1603
stop_revision, _run_hooks=False)
1604
# and push into the target branch from this. Note that we push from
1605
# this branch again, because its considered the highest bandwidth
1607
return super(BzrBranch5, self).push(target, overwrite,
1608
stop_revision, _hook_master=master_branch)
1611
master_branch.unlock()
2596
1613
def get_bound_location(self):
2598
return self._transport.get_bytes('bound')[:-1]
1615
return self.control_files.get_utf8('bound').read()[:-1]
2599
1616
except errors.NoSuchFile:
2602
1619
@needs_read_lock
2603
def get_master_branch(self, possible_transports=None):
1620
def get_master_branch(self):
2604
1621
"""Return the branch we are bound to.
2606
1623
:return: Either a Branch, or None
2608
1625
This could memoise the branch, but if thats done
2668
1699
return self.set_bound_location(None)
2670
1701
@needs_write_lock
2671
def update(self, possible_transports=None):
2672
"""Synchronise this branch with the master branch if any.
1703
"""Synchronise this branch with the master branch if any.
2674
1705
:return: None or the last_revision that was pivoted out during the
2677
master = self.get_master_branch(possible_transports)
1708
master = self.get_master_branch()
2678
1709
if master is not None:
2679
old_tip = _mod_revision.ensure_null(self.last_revision())
1710
old_tip = self.last_revision()
2680
1711
self.pull(master, overwrite=True)
2681
if self.repository.get_graph().is_ancestor(old_tip,
2682
_mod_revision.ensure_null(self.last_revision())):
1712
if old_tip in self.repository.get_ancestry(self.last_revision()):
2688
class BzrBranch8(BzrBranch5):
2689
"""A branch that stores tree-reference locations."""
2691
def _open_hook(self):
2692
if self._ignore_fallbacks:
1718
class BzrBranchExperimental(BzrBranch5):
1719
"""Bzr experimental branch format
1722
- a revision-history file.
1724
- a lock dir guarding the branch itself
1725
- all of this stored in a branch/ subdirectory
1726
- works with shared repositories.
1727
- a tag dictionary in the branch
1729
This format is new in bzr 0.15, but shouldn't be used for real data,
1732
This class acts as it's own BranchFormat.
1735
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1738
def get_format_string(cls):
1739
"""See BranchFormat.get_format_string()."""
1740
return "Bazaar-NG branch format experimental\n"
1743
def get_format_description(cls):
1744
"""See BranchFormat.get_format_description()."""
1745
return "Experimental branch format"
1748
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1750
branch_transport = a_bzrdir.get_branch_transport(cls)
1751
control_files = lockable_files.LockableFiles(branch_transport,
1752
lock_filename, lock_class)
1753
control_files.create_lock()
1754
control_files.lock_write()
2695
url = self.get_stacked_on_url()
2696
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2697
errors.UnstackableBranchFormat):
2700
for hook in Branch.hooks['transform_fallback_location']:
2701
url = hook(self, url)
2703
hook_name = Branch.hooks.get_hook_name(hook)
2704
raise AssertionError(
2705
"'transform_fallback_location' hook %s returned "
2706
"None, not a URL." % hook_name)
2707
self._activate_fallback_location(url)
2709
def __init__(self, *args, **kwargs):
2710
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2711
super(BzrBranch8, self).__init__(*args, **kwargs)
2712
self._last_revision_info_cache = None
2713
self._reference_info = None
2715
def _clear_cached_state(self):
2716
super(BzrBranch8, self)._clear_cached_state()
2717
self._last_revision_info_cache = None
2718
self._reference_info = None
2720
def _last_revision_info(self):
2721
revision_string = self._transport.get_bytes('last-revision')
1756
for filename, content in utf8_files:
1757
control_files.put_utf8(filename, content)
1759
control_files.unlock()
1762
def initialize(cls, a_bzrdir):
1763
"""Create a branch of this format in a_bzrdir."""
1764
utf8_files = [('format', cls.get_format_string()),
1765
('revision-history', ''),
1766
('branch-name', ''),
1769
cls._initialize_control_files(a_bzrdir, utf8_files,
1770
'lock', lockdir.LockDir)
1771
return cls.open(a_bzrdir, _found=True)
1774
def open(cls, a_bzrdir, _found=False):
1775
"""Return the branch object for a_bzrdir
1777
_found is a private parameter, do not use it. It is used to indicate
1778
if format probing has already be done.
1781
format = BranchFormat.find_format(a_bzrdir)
1782
assert format.__class__ == cls
1783
transport = a_bzrdir.get_branch_transport(None)
1784
control_files = lockable_files.LockableFiles(transport, 'lock',
1786
return cls(_format=cls,
1787
_control_files=control_files,
1789
_repository=a_bzrdir.find_repository())
1792
def is_supported(cls):
1795
def _make_tags(self):
1796
return BasicTags(self)
1799
def supports_tags(cls):
1803
BranchFormat.register_format(BzrBranchExperimental)
1806
class BzrBranch6(BzrBranch5):
1809
def last_revision_info(self):
1810
revision_string = self.control_files.get('last-revision').read()
2722
1811
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2723
1812
revision_id = cache_utf8.get_cached_utf8(revision_id)
2724
1813
revno = int(revno)
2725
1814
return revno, revision_id
1816
def last_revision(self):
1817
"""Return last revision id, or None"""
1818
revision_id = self.last_revision_info()[1]
1819
if revision_id == _mod_revision.NULL_REVISION:
2727
1823
def _write_last_revision_info(self, revno, revision_id):
2728
1824
"""Simply write out the revision id, with no checks.
2733
1829
Intended to be called by set_last_revision_info and
2734
1830
_write_revision_history.
2736
revision_id = _mod_revision.ensure_null(revision_id)
1832
if revision_id is None:
1833
revision_id = 'null:'
2737
1834
out_string = '%d %s\n' % (revno, revision_id)
2738
self._transport.put_bytes('last-revision', out_string,
2739
mode=self.bzrdir._get_file_mode())
1835
self.control_files.put_bytes('last-revision', out_string)
2741
1837
@needs_write_lock
2742
1838
def set_last_revision_info(self, revno, revision_id):
2743
revision_id = _mod_revision.ensure_null(revision_id)
2744
old_revno, old_revid = self.last_revision_info()
1839
revision_id = osutils.safe_revision_id(revision_id)
2745
1840
if self._get_append_revisions_only():
2746
1841
self._check_history_violation(revision_id)
2747
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2748
1842
self._write_last_revision_info(revno, revision_id)
2749
1843
self._clear_cached_state()
2750
self._last_revision_info_cache = revno, revision_id
2751
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2753
def _synchronize_history(self, destination, revision_id):
2754
"""Synchronize last revision and revision history between branches.
2756
:see: Branch._synchronize_history
2758
# XXX: The base Branch has a fast implementation of this method based
2759
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2760
# that uses set_revision_history. This class inherits from BzrBranch5,
2761
# but wants the fast implementation, so it calls
2762
# Branch._synchronize_history directly.
2763
Branch._synchronize_history(self, destination, revision_id)
2765
1845
def _check_history_violation(self, revision_id):
2766
last_revision = _mod_revision.ensure_null(self.last_revision())
2767
if _mod_revision.is_null(last_revision):
1846
last_revision = self.last_revision()
1847
if last_revision is None:
2769
1849
if last_revision not in self._lefthand_history(revision_id):
2770
raise errors.AppendRevisionsOnlyViolation(self.user_url)
1850
raise errors.AppendRevisionsOnlyViolation(self.base)
2772
1852
def _gen_revision_history(self):
2773
1853
"""Generate the revision history from last revision
2775
last_revno, last_revision = self.last_revision_info()
2776
self._extend_partial_history(stop_index=last_revno-1)
2777
return list(reversed(self._partial_revision_history_cache))
1855
history = list(self.repository.iter_reverse_revision_history(
1856
self.last_revision()))
2779
1860
def _write_revision_history(self, history):
2780
1861
"""Factored out of set_revision_history.
2802
1902
"""Set the parent branch"""
2803
1903
return self._get_config_location('parent_location')
2806
def _set_all_reference_info(self, info_dict):
2807
"""Replace all reference info stored in a branch.
2809
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2812
writer = rio.RioWriter(s)
2813
for key, (tree_path, branch_location) in info_dict.iteritems():
2814
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2815
branch_location=branch_location)
2816
writer.write_stanza(stanza)
2817
self._transport.put_bytes('references', s.getvalue())
2818
self._reference_info = info_dict
2821
def _get_all_reference_info(self):
2822
"""Return all the reference info stored in a branch.
2824
:return: A dict of {file_id: (tree_path, branch_location)}
2826
if self._reference_info is not None:
2827
return self._reference_info
2828
rio_file = self._transport.get('references')
2830
stanzas = rio.read_stanzas(rio_file)
2831
info_dict = dict((s['file_id'], (s['tree_path'],
2832
s['branch_location'])) for s in stanzas)
2835
self._reference_info = info_dict
2838
def set_reference_info(self, file_id, tree_path, branch_location):
2839
"""Set the branch location to use for a tree reference.
2841
:param file_id: The file-id of the tree reference.
2842
:param tree_path: The path of the tree reference in the tree.
2843
:param branch_location: The location of the branch to retrieve tree
2846
info_dict = self._get_all_reference_info()
2847
info_dict[file_id] = (tree_path, branch_location)
2848
if None in (tree_path, branch_location):
2849
if tree_path is not None:
2850
raise ValueError('tree_path must be None when branch_location'
2852
if branch_location is not None:
2853
raise ValueError('branch_location must be None when tree_path'
2855
del info_dict[file_id]
2856
self._set_all_reference_info(info_dict)
2858
def get_reference_info(self, file_id):
2859
"""Get the tree_path and branch_location for a tree reference.
2861
:return: a tuple of (tree_path, branch_location)
2863
return self._get_all_reference_info().get(file_id, (None, None))
2865
def reference_parent(self, file_id, path, possible_transports=None):
2866
"""Return the parent branch for a tree-reference file_id.
2868
:param file_id: The file_id of the tree reference
2869
:param path: The path of the file_id in the tree
2870
:return: A branch associated with the file_id
2872
branch_location = self.get_reference_info(file_id)[1]
2873
if branch_location is None:
2874
return Branch.reference_parent(self, file_id, path,
2875
possible_transports)
2876
branch_location = urlutils.join(self.user_url, branch_location)
2877
return Branch.open(branch_location,
2878
possible_transports=possible_transports)
2880
1905
def set_push_location(self, location):
2881
1906
"""See Branch.set_push_location."""
2882
1907
self._set_config_location('push_location', location)
2915
1940
"""See Branch.get_old_bound_location"""
2916
1941
return self._get_bound_location(False)
2918
def get_stacked_on_url(self):
2919
# you can always ask for the URL; but you might not be able to use it
2920
# if the repo can't support stacking.
2921
## self._check_stackable_repo()
2922
stacked_url = self._get_config_location('stacked_on_location')
2923
if stacked_url is None:
2924
raise errors.NotStacked(self)
1943
def set_append_revisions_only(self, enabled):
1948
self.get_config().set_user_option('append_revisions_only', value)
2927
1950
def _get_append_revisions_only(self):
2928
return self.get_config(
2929
).get_user_option_as_bool('append_revisions_only')
2932
def generate_revision_history(self, revision_id, last_rev=None,
2934
"""See BzrBranch5.generate_revision_history"""
2935
history = self._lefthand_history(revision_id, last_rev, other_branch)
2936
revno = len(history)
2937
self.set_last_revision_info(revno, revision_id)
2940
def get_rev_id(self, revno, history=None):
2941
"""Find the revision id of the specified revno."""
2943
return _mod_revision.NULL_REVISION
2945
last_revno, last_revision_id = self.last_revision_info()
2946
if revno <= 0 or revno > last_revno:
2947
raise errors.NoSuchRevision(self, revno)
2949
if history is not None:
2950
return history[revno - 1]
2952
index = last_revno - revno
2953
if len(self._partial_revision_history_cache) <= index:
2954
self._extend_partial_history(stop_index=index)
2955
if len(self._partial_revision_history_cache) > index:
2956
return self._partial_revision_history_cache[index]
1951
value = self.get_config().get_user_option('append_revisions_only')
1952
return value == 'True'
1954
def _synchronize_history(self, destination, revision_id):
1955
"""Synchronize last revision and revision history between branches.
1957
This version is most efficient when the destination is also a
1958
BzrBranch6, but works for BzrBranch5, as long as the destination's
1959
repository contains all the lefthand ancestors of the intended
1960
last_revision. If not, set_last_revision_info will fail.
1962
:param destination: The branch to copy the history into
1963
:param revision_id: The revision-id to truncate history at. May
1964
be None to copy complete history.
1966
if revision_id is None:
1967
revno, revision_id = self.last_revision_info()
2958
raise errors.NoSuchRevision(self, revno)
2961
def revision_id_to_revno(self, revision_id):
2962
"""Given a revision id, return its revno"""
2963
if _mod_revision.is_null(revision_id):
2966
index = self._partial_revision_history_cache.index(revision_id)
2968
self._extend_partial_history(stop_revision=revision_id)
2969
index = len(self._partial_revision_history_cache) - 1
2970
if self._partial_revision_history_cache[index] != revision_id:
2971
raise errors.NoSuchRevision(self, revision_id)
2972
return self.revno() - index
2975
class BzrBranch7(BzrBranch8):
2976
"""A branch with support for a fallback repository."""
2978
def set_reference_info(self, file_id, tree_path, branch_location):
2979
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2981
def get_reference_info(self, file_id):
2982
Branch.get_reference_info(self, file_id)
2984
def reference_parent(self, file_id, path, possible_transports=None):
2985
return Branch.reference_parent(self, file_id, path,
2986
possible_transports)
2989
class BzrBranch6(BzrBranch7):
2990
"""See BzrBranchFormat6 for the capabilities of this branch.
2992
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
1969
revno = self.revision_id_to_revno(revision_id)
1970
destination.set_last_revision_info(revno, revision_id)
1972
def _make_tags(self):
1973
return BasicTags(self)
1976
class BranchTestProviderAdapter(object):
1977
"""A tool to generate a suite testing multiple branch formats at once.
1979
This is done by copying the test once for each transport and injecting
1980
the transport_server, transport_readonly_server, and branch_format
1981
classes into each copy. Each copy is also given a new id() to make it
2996
def get_stacked_on_url(self):
2997
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1985
def __init__(self, transport_server, transport_readonly_server, formats):
1986
self._transport_server = transport_server
1987
self._transport_readonly_server = transport_readonly_server
1988
self._formats = formats
1990
def adapt(self, test):
1991
result = TestSuite()
1992
for branch_format, bzrdir_format in self._formats:
1993
new_test = deepcopy(test)
1994
new_test.transport_server = self._transport_server
1995
new_test.transport_readonly_server = self._transport_readonly_server
1996
new_test.bzrdir_format = bzrdir_format
1997
new_test.branch_format = branch_format
1998
def make_new_test_id():
1999
# the format can be either a class or an instance
2000
name = getattr(branch_format, '__name__',
2001
branch_format.__class__.__name__)
2002
new_id = "%s(%s)" % (new_test.id(), name)
2003
return lambda: new_id
2004
new_test.id = make_new_test_id()
2005
result.addTest(new_test)
3000
2009
######################################################################
3111
2107
new_branch.tags._set_tag_dict({})
3113
2109
# Copying done; now update target format
3114
new_branch._transport.put_bytes('format',
3115
format.get_format_string(),
3116
mode=new_branch.bzrdir._get_file_mode())
2110
new_branch.control_files.put_utf8('format',
2111
format.get_format_string())
3118
2113
# Clean up old files
3119
new_branch._transport.delete('revision-history')
2114
new_branch.control_files._transport.delete('revision-history')
3121
2116
branch.set_parent(None)
3122
except errors.NoSuchFile:
3124
2119
branch.set_bound_location(None)
3127
class Converter6to7(object):
3128
"""Perform an in-place upgrade of format 6 to format 7"""
3130
def convert(self, branch):
3131
format = BzrBranchFormat7()
3132
branch._set_config_location('stacked_on_location', '')
3133
# update target format
3134
branch._transport.put_bytes('format', format.get_format_string())
3137
class Converter7to8(object):
3138
"""Perform an in-place upgrade of format 6 to format 7"""
3140
def convert(self, branch):
3141
format = BzrBranchFormat8()
3142
branch._transport.put_bytes('references', '')
3143
# update target format
3144
branch._transport.put_bytes('format', format.get_format_string())
3147
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3148
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3151
_run_with_write_locked_target will attempt to release the lock it acquires.
3153
If an exception is raised by callable, then that exception *will* be
3154
propagated, even if the unlock attempt raises its own error. Thus
3155
_run_with_write_locked_target should be preferred to simply doing::
3159
return callable(*args, **kwargs)
3164
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3165
# should share code?
3168
result = callable(*args, **kwargs)
3170
exc_info = sys.exc_info()
3174
raise exc_info[0], exc_info[1], exc_info[2]
3180
class InterBranch(InterObject):
3181
"""This class represents operations taking place between two branches.
3183
Its instances have methods like pull() and push() and contain
3184
references to the source and target repositories these operations
3185
can be carried out on.
3189
"""The available optimised InterBranch types."""
3192
def _get_branch_formats_to_test():
3193
"""Return a tuple with the Branch formats to use when testing."""
3194
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3196
def pull(self, overwrite=False, stop_revision=None,
3197
possible_transports=None, local=False):
3198
"""Mirror source into target branch.
3200
The target branch is considered to be 'local', having low latency.
3202
:returns: PullResult instance
3204
raise NotImplementedError(self.pull)
3206
def update_revisions(self, stop_revision=None, overwrite=False,
3208
"""Pull in new perfect-fit revisions.
3210
:param stop_revision: Updated until the given revision
3211
:param overwrite: Always set the branch pointer, rather than checking
3212
to see if it is a proper descendant.
3213
:param graph: A Graph object that can be used to query history
3214
information. This can be None.
3217
raise NotImplementedError(self.update_revisions)
3219
def push(self, overwrite=False, stop_revision=None,
3220
_override_hook_source_branch=None):
3221
"""Mirror the source branch into the target branch.
3223
The source branch is considered to be 'local', having low latency.
3225
raise NotImplementedError(self.push)
3228
class GenericInterBranch(InterBranch):
3229
"""InterBranch implementation that uses public Branch functions.
3233
def _get_branch_formats_to_test():
3234
return BranchFormat._default_format, BranchFormat._default_format
3236
def update_revisions(self, stop_revision=None, overwrite=False,
3238
"""See InterBranch.update_revisions()."""
3239
self.source.lock_read()
3241
other_revno, other_last_revision = self.source.last_revision_info()
3242
stop_revno = None # unknown
3243
if stop_revision is None:
3244
stop_revision = other_last_revision
3245
if _mod_revision.is_null(stop_revision):
3246
# if there are no commits, we're done.
3248
stop_revno = other_revno
3250
# what's the current last revision, before we fetch [and change it
3252
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3253
# we fetch here so that we don't process data twice in the common
3254
# case of having something to pull, and so that the check for
3255
# already merged can operate on the just fetched graph, which will
3256
# be cached in memory.
3257
self.target.fetch(self.source, stop_revision)
3258
# Check to see if one is an ancestor of the other
3261
graph = self.target.repository.get_graph()
3262
if self.target._check_if_descendant_or_diverged(
3263
stop_revision, last_rev, graph, self.source):
3264
# stop_revision is a descendant of last_rev, but we aren't
3265
# overwriting, so we're done.
3267
if stop_revno is None:
3269
graph = self.target.repository.get_graph()
3270
this_revno, this_last_revision = \
3271
self.target.last_revision_info()
3272
stop_revno = graph.find_distance_to_null(stop_revision,
3273
[(other_last_revision, other_revno),
3274
(this_last_revision, this_revno)])
3275
self.target.set_last_revision_info(stop_revno, stop_revision)
3277
self.source.unlock()
3279
def pull(self, overwrite=False, stop_revision=None,
3280
possible_transports=None, _hook_master=None, run_hooks=True,
3281
_override_hook_target=None, local=False):
3284
:param _hook_master: Private parameter - set the branch to
3285
be supplied as the master to pull hooks.
3286
:param run_hooks: Private parameter - if false, this branch
3287
is being called because it's the master of the primary branch,
3288
so it should not run its hooks.
3289
:param _override_hook_target: Private parameter - set the branch to be
3290
supplied as the target_branch to pull hooks.
3291
:param local: Only update the local branch, and not the bound branch.
3293
# This type of branch can't be bound.
3295
raise errors.LocalRequiresBoundBranch()
3296
result = PullResult()
3297
result.source_branch = self.source
3298
if _override_hook_target is None:
3299
result.target_branch = self.target
3301
result.target_branch = _override_hook_target
3302
self.source.lock_read()
3304
# We assume that during 'pull' the target repository is closer than
3306
self.source.update_references(self.target)
3307
graph = self.target.repository.get_graph(self.source.repository)
3308
# TODO: Branch formats should have a flag that indicates
3309
# that revno's are expensive, and pull() should honor that flag.
3311
result.old_revno, result.old_revid = \
3312
self.target.last_revision_info()
3313
self.target.update_revisions(self.source, stop_revision,
3314
overwrite=overwrite, graph=graph)
3315
# TODO: The old revid should be specified when merging tags,
3316
# so a tags implementation that versions tags can only
3317
# pull in the most recent changes. -- JRV20090506
3318
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3320
result.new_revno, result.new_revid = self.target.last_revision_info()
3322
result.master_branch = _hook_master
3323
result.local_branch = result.target_branch
3325
result.master_branch = result.target_branch
3326
result.local_branch = None
3328
for hook in Branch.hooks['post_pull']:
3331
self.source.unlock()
3334
def push(self, overwrite=False, stop_revision=None,
3335
_override_hook_source_branch=None):
3336
"""See InterBranch.push.
3338
This is the basic concrete implementation of push()
3340
:param _override_hook_source_branch: If specified, run
3341
the hooks passing this Branch as the source, rather than self.
3342
This is for use of RemoteBranch, where push is delegated to the
3343
underlying vfs-based Branch.
3345
# TODO: Public option to disable running hooks - should be trivial but
3347
self.source.lock_read()
3349
return _run_with_write_locked_target(
3350
self.target, self._push_with_bound_branches, overwrite,
3352
_override_hook_source_branch=_override_hook_source_branch)
3354
self.source.unlock()
3356
def _push_with_bound_branches(self, overwrite, stop_revision,
3357
_override_hook_source_branch=None):
3358
"""Push from source into target, and into target's master if any.
3361
if _override_hook_source_branch:
3362
result.source_branch = _override_hook_source_branch
3363
for hook in Branch.hooks['post_push']:
3366
bound_location = self.target.get_bound_location()
3367
if bound_location and self.target.base != bound_location:
3368
# there is a master branch.
3370
# XXX: Why the second check? Is it even supported for a branch to
3371
# be bound to itself? -- mbp 20070507
3372
master_branch = self.target.get_master_branch()
3373
master_branch.lock_write()
3375
# push into the master from the source branch.
3376
self.source._basic_push(master_branch, overwrite, stop_revision)
3377
# and push into the target branch from the source. Note that we
3378
# push from the source branch again, because its considered the
3379
# highest bandwidth repository.
3380
result = self.source._basic_push(self.target, overwrite,
3382
result.master_branch = master_branch
3383
result.local_branch = self.target
3387
master_branch.unlock()
3390
result = self.source._basic_push(self.target, overwrite,
3392
# TODO: Why set master_branch and local_branch if there's no
3393
# binding? Maybe cleaner to just leave them unset? -- mbp
3395
result.master_branch = self.target
3396
result.local_branch = None
3401
def is_compatible(self, source, target):
3402
# GenericBranch uses the public API, so always compatible
3406
class InterToBranch5(GenericInterBranch):
3409
def _get_branch_formats_to_test():
3410
return BranchFormat._default_format, BzrBranchFormat5()
3412
def pull(self, overwrite=False, stop_revision=None,
3413
possible_transports=None, run_hooks=True,
3414
_override_hook_target=None, local=False):
3415
"""Pull from source into self, updating my master if any.
3417
:param run_hooks: Private parameter - if false, this branch
3418
is being called because it's the master of the primary branch,
3419
so it should not run its hooks.
3421
bound_location = self.target.get_bound_location()
3422
if local and not bound_location:
3423
raise errors.LocalRequiresBoundBranch()
3424
master_branch = None
3425
if not local and bound_location and self.source.user_url != bound_location:
3426
# not pulling from master, so we need to update master.
3427
master_branch = self.target.get_master_branch(possible_transports)
3428
master_branch.lock_write()
3431
# pull from source into master.
3432
master_branch.pull(self.source, overwrite, stop_revision,
3434
return super(InterToBranch5, self).pull(overwrite,
3435
stop_revision, _hook_master=master_branch,
3436
run_hooks=run_hooks,
3437
_override_hook_target=_override_hook_target)
3440
master_branch.unlock()
3443
InterBranch.register_optimiser(GenericInterBranch)
3444
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
