1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
18
from cStringIO import StringIO
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from itertools import chain
27
config as _mod_config,
33
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TransportConfig
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.hooks import HookPoint, Hooks
51
from bzrlib.inter import InterObject
52
from bzrlib import registry
53
from bzrlib.symbol_versioning import (
57
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
60
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
61
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
65
# TODO: Maybe include checks for common corruption of newlines, etc?
67
# TODO: Some operations like log might retrieve the same revisions
68
# repeatedly to calculate deltas. We could perhaps have a weakref
69
# cache in memory to make this faster. In general anything can be
70
# cached in memory between lock and unlock operations. .. nb thats
71
# what the transaction identity map provides
74
######################################################################
78
"""Branch holding a history of revisions.
81
Base directory/url of the branch.
83
hooks: An instance of BranchHooks.
85
# this is really an instance variable - FIXME move it there
89
def __init__(self, *ignored, **ignored_too):
90
self.tags = self._format.make_tags(self)
91
self._revision_history_cache = None
92
self._revision_id_to_revno_cache = None
93
self._partial_revision_id_to_revno_cache = {}
94
self._last_revision_info_cache = None
95
self._merge_sorted_revisions_cache = None
97
hooks = Branch.hooks['open']
101
def _open_hook(self):
102
"""Called by init to allow simpler extension of the base class."""
104
def _activate_fallback_location(self, url):
105
"""Activate the branch/repository from url as a fallback repository."""
106
self.repository.add_fallback_repository(
107
self._get_fallback_repository(url))
109
def break_lock(self):
110
"""Break a lock if one is present from another instance.
112
Uses the ui factory to ask for confirmation if the lock may be from
115
This will probe the repository for its lock as well.
117
self.control_files.break_lock()
118
self.repository.break_lock()
119
master = self.get_master_branch()
120
if master is not None:
123
def _check_stackable_repo(self):
124
if not self.repository._format.supports_external_lookups:
125
raise errors.UnstackableRepositoryFormat(self.repository._format,
126
self.repository.base)
129
def open(base, _unsupported=False, possible_transports=None):
130
"""Open the branch rooted at base.
132
For instance, if the branch is at URL/.bzr/branch,
133
Branch.open(URL) -> a Branch instance.
135
control = bzrdir.BzrDir.open(base, _unsupported,
136
possible_transports=possible_transports)
137
return control.open_branch(_unsupported)
140
def open_from_transport(transport, _unsupported=False):
141
"""Open the branch rooted at transport"""
142
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
143
return control.open_branch(_unsupported)
146
def open_containing(url, possible_transports=None):
147
"""Open an existing branch which contains url.
149
This probes for a branch at url, and searches upwards from there.
151
Basically we keep looking up until we find the control directory or
152
run into the root. If there isn't one, raises NotBranchError.
153
If there is one and it is either an unrecognised format or an unsupported
154
format, UnknownFormatError or UnsupportedFormatError are raised.
155
If there is one, it is returned, along with the unused portion of url.
157
control, relpath = bzrdir.BzrDir.open_containing(url,
159
return control.open_branch(), relpath
161
def _push_should_merge_tags(self):
162
"""Should _basic_push merge this branch's tags into the target?
164
The default implementation returns False if this branch has no tags,
165
and True the rest of the time. Subclasses may override this.
167
return self.supports_tags() and self.tags.get_tag_dict()
169
def get_config(self):
170
return BranchConfig(self)
172
def _get_config(self):
173
"""Get the concrete config for just the config in this branch.
175
This is not intended for client use; see Branch.get_config for the
180
:return: An object supporting get_option and set_option.
182
raise NotImplementedError(self._get_config)
184
def _get_fallback_repository(self, url):
185
"""Get the repository we fallback to at url."""
186
url = urlutils.join(self.base, url)
187
a_bzrdir = bzrdir.BzrDir.open(url,
188
possible_transports=[self.bzrdir.root_transport])
189
return a_bzrdir.open_branch().repository
191
def _get_tags_bytes(self):
192
"""Get the bytes of a serialised tags dict.
194
Note that not all branches support tags, nor do all use the same tags
195
logic: this method is specific to BasicTags. Other tag implementations
196
may use the same method name and behave differently, safely, because
197
of the double-dispatch via
198
format.make_tags->tags_instance->get_tags_dict.
200
:return: The bytes of the tags file.
201
:seealso: Branch._set_tags_bytes.
203
return self._transport.get_bytes('tags')
205
def _get_nick(self, local=False, possible_transports=None):
206
config = self.get_config()
207
# explicit overrides master, but don't look for master if local is True
208
if not local and not config.has_explicit_nickname():
210
master = self.get_master_branch(possible_transports)
211
if master is not None:
212
# return the master branch value
214
except errors.BzrError, e:
215
# Silently fall back to local implicit nick if the master is
217
mutter("Could not connect to bound branch, "
218
"falling back to local nick.\n " + str(e))
219
return config.get_nickname()
221
def _set_nick(self, nick):
222
self.get_config().set_user_option('nickname', nick, warn_masked=True)
224
nick = property(_get_nick, _set_nick)
227
raise NotImplementedError(self.is_locked)
229
def _lefthand_history(self, revision_id, last_rev=None,
231
if 'evil' in debug.debug_flags:
232
mutter_callsite(4, "_lefthand_history scales with history.")
233
# stop_revision must be a descendant of last_revision
234
graph = self.repository.get_graph()
235
if last_rev is not None:
236
if not graph.is_ancestor(last_rev, revision_id):
237
# our previous tip is not merged into stop_revision
238
raise errors.DivergedBranches(self, other_branch)
239
# make a new revision history from the graph
240
parents_map = graph.get_parent_map([revision_id])
241
if revision_id not in parents_map:
242
raise errors.NoSuchRevision(self, revision_id)
243
current_rev_id = revision_id
245
check_not_reserved_id = _mod_revision.check_not_reserved_id
246
# Do not include ghosts or graph origin in revision_history
247
while (current_rev_id in parents_map and
248
len(parents_map[current_rev_id]) > 0):
249
check_not_reserved_id(current_rev_id)
250
new_history.append(current_rev_id)
251
current_rev_id = parents_map[current_rev_id][0]
252
parents_map = graph.get_parent_map([current_rev_id])
253
new_history.reverse()
256
def lock_write(self):
257
raise NotImplementedError(self.lock_write)
260
raise NotImplementedError(self.lock_read)
263
raise NotImplementedError(self.unlock)
265
def peek_lock_mode(self):
266
"""Return lock mode for the Branch: 'r', 'w' or None"""
267
raise NotImplementedError(self.peek_lock_mode)
269
def get_physical_lock_status(self):
270
raise NotImplementedError(self.get_physical_lock_status)
273
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
274
"""Return the revision_id for a dotted revno.
276
:param revno: a tuple like (1,) or (1,1,2)
277
:param _cache_reverse: a private parameter enabling storage
278
of the reverse mapping in a top level cache. (This should
279
only be done in selective circumstances as we want to
280
avoid having the mapping cached multiple times.)
281
:return: the revision_id
282
:raises errors.NoSuchRevision: if the revno doesn't exist
284
rev_id = self._do_dotted_revno_to_revision_id(revno)
286
self._partial_revision_id_to_revno_cache[rev_id] = revno
289
def _do_dotted_revno_to_revision_id(self, revno):
290
"""Worker function for dotted_revno_to_revision_id.
292
Subclasses should override this if they wish to
293
provide a more efficient implementation.
296
return self.get_rev_id(revno[0])
297
revision_id_to_revno = self.get_revision_id_to_revno_map()
298
revision_ids = [revision_id for revision_id, this_revno
299
in revision_id_to_revno.iteritems()
300
if revno == this_revno]
301
if len(revision_ids) == 1:
302
return revision_ids[0]
304
revno_str = '.'.join(map(str, revno))
305
raise errors.NoSuchRevision(self, revno_str)
308
def revision_id_to_dotted_revno(self, revision_id):
309
"""Given a revision id, return its dotted revno.
311
:return: a tuple like (1,) or (400,1,3).
313
return self._do_revision_id_to_dotted_revno(revision_id)
315
def _do_revision_id_to_dotted_revno(self, revision_id):
316
"""Worker function for revision_id_to_revno."""
317
# Try the caches if they are loaded
318
result = self._partial_revision_id_to_revno_cache.get(revision_id)
319
if result is not None:
321
if self._revision_id_to_revno_cache:
322
result = self._revision_id_to_revno_cache.get(revision_id)
324
raise errors.NoSuchRevision(self, revision_id)
325
# Try the mainline as it's optimised
327
revno = self.revision_id_to_revno(revision_id)
329
except errors.NoSuchRevision:
330
# We need to load and use the full revno map after all
331
result = self.get_revision_id_to_revno_map().get(revision_id)
333
raise errors.NoSuchRevision(self, revision_id)
337
def get_revision_id_to_revno_map(self):
338
"""Return the revision_id => dotted revno map.
340
This will be regenerated on demand, but will be cached.
342
:return: A dictionary mapping revision_id => dotted revno.
343
This dictionary should not be modified by the caller.
345
if self._revision_id_to_revno_cache is not None:
346
mapping = self._revision_id_to_revno_cache
348
mapping = self._gen_revno_map()
349
self._cache_revision_id_to_revno(mapping)
350
# TODO: jam 20070417 Since this is being cached, should we be returning
352
# I would rather not, and instead just declare that users should not
353
# modify the return value.
356
def _gen_revno_map(self):
357
"""Create a new mapping from revision ids to dotted revnos.
359
Dotted revnos are generated based on the current tip in the revision
361
This is the worker function for get_revision_id_to_revno_map, which
362
just caches the return value.
364
:return: A dictionary mapping revision_id => dotted revno.
366
revision_id_to_revno = dict((rev_id, revno)
367
for rev_id, depth, revno, end_of_merge
368
in self.iter_merge_sorted_revisions())
369
return revision_id_to_revno
372
def iter_merge_sorted_revisions(self, start_revision_id=None,
373
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
374
"""Walk the revisions for a branch in merge sorted order.
376
Merge sorted order is the output from a merge-aware,
377
topological sort, i.e. all parents come before their
378
children going forward; the opposite for reverse.
380
:param start_revision_id: the revision_id to begin walking from.
381
If None, the branch tip is used.
382
:param stop_revision_id: the revision_id to terminate the walk
383
after. If None, the rest of history is included.
384
:param stop_rule: if stop_revision_id is not None, the precise rule
385
to use for termination:
386
* 'exclude' - leave the stop revision out of the result (default)
387
* 'include' - the stop revision is the last item in the result
388
* 'with-merges' - include the stop revision and all of its
389
merged revisions in the result
390
:param direction: either 'reverse' or 'forward':
391
* reverse means return the start_revision_id first, i.e.
392
start at the most recent revision and go backwards in history
393
* forward returns tuples in the opposite order to reverse.
394
Note in particular that forward does *not* do any intelligent
395
ordering w.r.t. depth as some clients of this API may like.
396
(If required, that ought to be done at higher layers.)
398
:return: an iterator over (revision_id, depth, revno, end_of_merge)
401
* revision_id: the unique id of the revision
402
* depth: How many levels of merging deep this node has been
404
* revno_sequence: This field provides a sequence of
405
revision numbers for all revisions. The format is:
406
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
407
branch that the revno is on. From left to right the REVNO numbers
408
are the sequence numbers within that branch of the revision.
409
* end_of_merge: When True the next node (earlier in history) is
410
part of a different merge.
412
# Note: depth and revno values are in the context of the branch so
413
# we need the full graph to get stable numbers, regardless of the
415
if self._merge_sorted_revisions_cache is None:
416
last_revision = self.last_revision()
417
graph = self.repository.get_graph()
418
parent_map = dict(((key, value) for key, value in
419
graph.iter_ancestry([last_revision]) if value is not None))
420
revision_graph = repository._strip_NULL_ghosts(parent_map)
421
revs = tsort.merge_sort(revision_graph, last_revision, None,
423
# Drop the sequence # before caching
424
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
426
filtered = self._filter_merge_sorted_revisions(
427
self._merge_sorted_revisions_cache, start_revision_id,
428
stop_revision_id, stop_rule)
429
if direction == 'reverse':
431
if direction == 'forward':
432
return reversed(list(filtered))
434
raise ValueError('invalid direction %r' % direction)
436
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
437
start_revision_id, stop_revision_id, stop_rule):
438
"""Iterate over an inclusive range of sorted revisions."""
439
rev_iter = iter(merge_sorted_revisions)
440
if start_revision_id is not None:
441
for rev_id, depth, revno, end_of_merge in rev_iter:
442
if rev_id != start_revision_id:
445
# The decision to include the start or not
446
# depends on the stop_rule if a stop is provided
448
iter([(rev_id, depth, revno, end_of_merge)]),
451
if stop_revision_id is None:
452
for rev_id, depth, revno, end_of_merge in rev_iter:
453
yield rev_id, depth, revno, end_of_merge
454
elif stop_rule == 'exclude':
455
for rev_id, depth, revno, end_of_merge in rev_iter:
456
if rev_id == stop_revision_id:
458
yield rev_id, depth, revno, end_of_merge
459
elif stop_rule == 'include':
460
for rev_id, depth, revno, end_of_merge in rev_iter:
461
yield rev_id, depth, revno, end_of_merge
462
if rev_id == stop_revision_id:
464
elif stop_rule == 'with-merges':
465
stop_rev = self.repository.get_revision(stop_revision_id)
466
if stop_rev.parent_ids:
467
left_parent = stop_rev.parent_ids[0]
469
left_parent = _mod_revision.NULL_REVISION
470
for rev_id, depth, revno, end_of_merge in rev_iter:
471
if rev_id == left_parent:
473
yield rev_id, depth, revno, end_of_merge
475
raise ValueError('invalid stop_rule %r' % stop_rule)
477
def leave_lock_in_place(self):
478
"""Tell this branch object not to release the physical lock when this
481
If lock_write doesn't return a token, then this method is not supported.
483
self.control_files.leave_in_place()
485
def dont_leave_lock_in_place(self):
486
"""Tell this branch object to release the physical lock when this
487
object is unlocked, even if it didn't originally acquire it.
489
If lock_write doesn't return a token, then this method is not supported.
491
self.control_files.dont_leave_in_place()
493
def bind(self, other):
494
"""Bind the local branch the other branch.
496
:param other: The branch to bind to
499
raise errors.UpgradeRequired(self.base)
501
def set_reference_info(self, file_id, tree_path, branch_location):
502
"""Set the branch location to use for a tree reference."""
503
raise errors.UnsupportedOperation(self.set_reference_info, self)
505
def get_reference_info(self, file_id):
506
"""Get the tree_path and branch_location for a tree reference."""
507
raise errors.UnsupportedOperation(self.get_reference_info, self)
510
def fetch(self, from_branch, last_revision=None, pb=None):
511
"""Copy revisions from from_branch into this branch.
513
:param from_branch: Where to copy from.
514
:param last_revision: What revision to stop at (None for at the end
516
:param pb: An optional progress bar to use.
519
if self.base == from_branch.base:
522
symbol_versioning.warn(
523
symbol_versioning.deprecated_in((1, 14, 0))
524
% "pb parameter to fetch()")
525
from_branch.lock_read()
527
if last_revision is None:
528
last_revision = from_branch.last_revision()
529
last_revision = _mod_revision.ensure_null(last_revision)
530
return self.repository.fetch(from_branch.repository,
531
revision_id=last_revision,
536
def get_bound_location(self):
537
"""Return the URL of the branch we are bound to.
539
Older format branches cannot bind, please be sure to use a metadir
544
def get_old_bound_location(self):
545
"""Return the URL of the branch we used to be bound to
547
raise errors.UpgradeRequired(self.base)
549
def get_commit_builder(self, parents, config=None, timestamp=None,
550
timezone=None, committer=None, revprops=None,
552
"""Obtain a CommitBuilder for this branch.
554
:param parents: Revision ids of the parents of the new revision.
555
:param config: Optional configuration to use.
556
:param timestamp: Optional timestamp recorded for commit.
557
:param timezone: Optional timezone for timestamp.
558
:param committer: Optional committer to set for commit.
559
:param revprops: Optional dictionary of revision properties.
560
:param revision_id: Optional revision id.
564
config = self.get_config()
566
return self.repository.get_commit_builder(self, parents, config,
567
timestamp, timezone, committer, revprops, revision_id)
569
def get_master_branch(self, possible_transports=None):
570
"""Return the branch we are bound to.
572
:return: Either a Branch, or None
576
def get_revision_delta(self, revno):
577
"""Return the delta for one revision.
579
The delta is relative to its mainline predecessor, or the
580
empty tree for revision 1.
582
rh = self.revision_history()
583
if not (1 <= revno <= len(rh)):
584
raise errors.InvalidRevisionNumber(revno)
585
return self.repository.get_revision_delta(rh[revno-1])
587
def get_stacked_on_url(self):
588
"""Get the URL this branch is stacked against.
590
:raises NotStacked: If the branch is not stacked.
591
:raises UnstackableBranchFormat: If the branch does not support
594
raise NotImplementedError(self.get_stacked_on_url)
596
def print_file(self, file, revision_id):
597
"""Print `file` to stdout."""
598
raise NotImplementedError(self.print_file)
600
def set_revision_history(self, rev_history):
601
raise NotImplementedError(self.set_revision_history)
603
def set_stacked_on_url(self, url):
604
"""Set the URL this branch is stacked against.
606
:raises UnstackableBranchFormat: If the branch does not support
608
:raises UnstackableRepositoryFormat: If the repository does not support
611
if not self._format.supports_stacking():
612
raise errors.UnstackableBranchFormat(self._format, self.base)
613
self._check_stackable_repo()
616
old_url = self.get_stacked_on_url()
617
except (errors.NotStacked, errors.UnstackableBranchFormat,
618
errors.UnstackableRepositoryFormat):
621
# repositories don't offer an interface to remove fallback
622
# repositories today; take the conceptually simpler option and just
624
self.repository = self.bzrdir.find_repository()
625
# for every revision reference the branch has, ensure it is pulled
627
source_repository = self._get_fallback_repository(old_url)
628
for revision_id in chain([self.last_revision()],
629
self.tags.get_reverse_tag_dict()):
630
self.repository.fetch(source_repository, revision_id,
633
self._activate_fallback_location(url)
634
# write this out after the repository is stacked to avoid setting a
635
# stacked config that doesn't work.
636
self._set_config_location('stacked_on_location', url)
639
def _set_tags_bytes(self, bytes):
640
"""Mirror method for _get_tags_bytes.
642
:seealso: Branch._get_tags_bytes.
644
return _run_with_write_locked_target(self, self._transport.put_bytes,
647
def _cache_revision_history(self, rev_history):
648
"""Set the cached revision history to rev_history.
650
The revision_history method will use this cache to avoid regenerating
651
the revision history.
653
This API is semi-public; it only for use by subclasses, all other code
654
should consider it to be private.
656
self._revision_history_cache = rev_history
658
def _cache_revision_id_to_revno(self, revision_id_to_revno):
659
"""Set the cached revision_id => revno map to revision_id_to_revno.
661
This API is semi-public; it only for use by subclasses, all other code
662
should consider it to be private.
664
self._revision_id_to_revno_cache = revision_id_to_revno
666
def _clear_cached_state(self):
667
"""Clear any cached data on this branch, e.g. cached revision history.
669
This means the next call to revision_history will need to call
670
_gen_revision_history.
672
This API is semi-public; it only for use by subclasses, all other code
673
should consider it to be private.
675
self._revision_history_cache = None
676
self._revision_id_to_revno_cache = None
677
self._last_revision_info_cache = None
678
self._merge_sorted_revisions_cache = None
680
def _gen_revision_history(self):
681
"""Return sequence of revision hashes on to this branch.
683
Unlike revision_history, this method always regenerates or rereads the
684
revision history, i.e. it does not cache the result, so repeated calls
687
Concrete subclasses should override this instead of revision_history so
688
that subclasses do not need to deal with caching logic.
690
This API is semi-public; it only for use by subclasses, all other code
691
should consider it to be private.
693
raise NotImplementedError(self._gen_revision_history)
696
def revision_history(self):
697
"""Return sequence of revision ids on this branch.
699
This method will cache the revision history for as long as it is safe to
702
if 'evil' in debug.debug_flags:
703
mutter_callsite(3, "revision_history scales with history.")
704
if self._revision_history_cache is not None:
705
history = self._revision_history_cache
707
history = self._gen_revision_history()
708
self._cache_revision_history(history)
712
"""Return current revision number for this branch.
714
That is equivalent to the number of revisions committed to
717
return self.last_revision_info()[0]
720
"""Older format branches cannot bind or unbind."""
721
raise errors.UpgradeRequired(self.base)
723
def set_append_revisions_only(self, enabled):
724
"""Older format branches are never restricted to append-only"""
725
raise errors.UpgradeRequired(self.base)
727
def last_revision(self):
728
"""Return last revision id, or NULL_REVISION."""
729
return self.last_revision_info()[1]
732
def last_revision_info(self):
733
"""Return information about the last revision.
735
:return: A tuple (revno, revision_id).
737
if self._last_revision_info_cache is None:
738
self._last_revision_info_cache = self._last_revision_info()
739
return self._last_revision_info_cache
741
def _last_revision_info(self):
742
rh = self.revision_history()
745
return (revno, rh[-1])
747
return (0, _mod_revision.NULL_REVISION)
749
@deprecated_method(deprecated_in((1, 6, 0)))
750
def missing_revisions(self, other, stop_revision=None):
751
"""Return a list of new revisions that would perfectly fit.
753
If self and other have not diverged, return a list of the revisions
754
present in other, but missing from self.
756
self_history = self.revision_history()
757
self_len = len(self_history)
758
other_history = other.revision_history()
759
other_len = len(other_history)
760
common_index = min(self_len, other_len) -1
761
if common_index >= 0 and \
762
self_history[common_index] != other_history[common_index]:
763
raise errors.DivergedBranches(self, other)
765
if stop_revision is None:
766
stop_revision = other_len
768
if stop_revision > other_len:
769
raise errors.NoSuchRevision(self, stop_revision)
770
return other_history[self_len:stop_revision]
773
def update_revisions(self, other, stop_revision=None, overwrite=False,
775
"""Pull in new perfect-fit revisions.
777
:param other: Another Branch to pull from
778
:param stop_revision: Updated until the given revision
779
:param overwrite: Always set the branch pointer, rather than checking
780
to see if it is a proper descendant.
781
:param graph: A Graph object that can be used to query history
782
information. This can be None.
785
return InterBranch.get(other, self).update_revisions(stop_revision,
788
def import_last_revision_info(self, source_repo, revno, revid):
789
"""Set the last revision info, importing from another repo if necessary.
791
This is used by the bound branch code to upload a revision to
792
the master branch first before updating the tip of the local branch.
794
:param source_repo: Source repository to optionally fetch from
795
:param revno: Revision number of the new tip
796
:param revid: Revision id of the new tip
798
if not self.repository.has_same_location(source_repo):
799
self.repository.fetch(source_repo, revision_id=revid)
800
self.set_last_revision_info(revno, revid)
802
def revision_id_to_revno(self, revision_id):
803
"""Given a revision id, return its revno"""
804
if _mod_revision.is_null(revision_id):
806
history = self.revision_history()
808
return history.index(revision_id) + 1
810
raise errors.NoSuchRevision(self, revision_id)
812
def get_rev_id(self, revno, history=None):
813
"""Find the revision id of the specified revno."""
815
return _mod_revision.NULL_REVISION
817
history = self.revision_history()
818
if revno <= 0 or revno > len(history):
819
raise errors.NoSuchRevision(self, revno)
820
return history[revno - 1]
822
def pull(self, source, overwrite=False, stop_revision=None,
823
possible_transports=None, _override_hook_target=None):
824
"""Mirror source into this branch.
826
This branch is considered to be 'local', having low latency.
828
:returns: PullResult instance
830
raise NotImplementedError(self.pull)
832
def push(self, target, overwrite=False, stop_revision=None):
833
"""Mirror this branch into target.
835
This branch is considered to be 'local', having low latency.
837
raise NotImplementedError(self.push)
839
def basis_tree(self):
840
"""Return `Tree` object for last revision."""
841
return self.repository.revision_tree(self.last_revision())
843
def get_parent(self):
844
"""Return the parent location of the branch.
846
This is the default location for pull/missing. The usual
847
pattern is that the user can override it by specifying a
850
parent = self._get_parent_location()
853
# This is an old-format absolute path to a local branch
855
if parent.startswith('/'):
856
parent = urlutils.local_path_to_url(parent.decode('utf8'))
858
return urlutils.join(self.base[:-1], parent)
859
except errors.InvalidURLJoin, e:
860
raise errors.InaccessibleParent(parent, self.base)
862
def _get_parent_location(self):
863
raise NotImplementedError(self._get_parent_location)
865
def _set_config_location(self, name, url, config=None,
866
make_relative=False):
868
config = self.get_config()
872
url = urlutils.relative_url(self.base, url)
873
config.set_user_option(name, url, warn_masked=True)
875
def _get_config_location(self, name, config=None):
877
config = self.get_config()
878
location = config.get_user_option(name)
883
def get_submit_branch(self):
884
"""Return the submit location of the branch.
886
This is the default location for bundle. The usual
887
pattern is that the user can override it by specifying a
890
return self.get_config().get_user_option('submit_branch')
892
def set_submit_branch(self, location):
893
"""Return the submit location of the branch.
895
This is the default location for bundle. The usual
896
pattern is that the user can override it by specifying a
899
self.get_config().set_user_option('submit_branch', location,
902
def get_public_branch(self):
903
"""Return the public location of the branch.
905
This is used by merge directives.
907
return self._get_config_location('public_branch')
909
def set_public_branch(self, location):
910
"""Return the submit location of the branch.
912
This is the default location for bundle. The usual
913
pattern is that the user can override it by specifying a
916
self._set_config_location('public_branch', location)
918
def get_push_location(self):
919
"""Return the None or the location to push this branch to."""
920
push_loc = self.get_config().get_user_option('push_location')
923
def set_push_location(self, location):
924
"""Set a new push location for this branch."""
925
raise NotImplementedError(self.set_push_location)
927
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
928
"""Run the post_change_branch_tip hooks."""
929
hooks = Branch.hooks['post_change_branch_tip']
932
new_revno, new_revid = self.last_revision_info()
933
params = ChangeBranchTipParams(
934
self, old_revno, new_revno, old_revid, new_revid)
938
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
939
"""Run the pre_change_branch_tip hooks."""
940
hooks = Branch.hooks['pre_change_branch_tip']
943
old_revno, old_revid = self.last_revision_info()
944
params = ChangeBranchTipParams(
945
self, old_revno, new_revno, old_revid, new_revid)
949
except errors.TipChangeRejected:
952
exc_info = sys.exc_info()
953
hook_name = Branch.hooks.get_hook_name(hook)
954
raise errors.HookFailed(
955
'pre_change_branch_tip', hook_name, exc_info)
957
def set_parent(self, url):
958
raise NotImplementedError(self.set_parent)
962
"""Synchronise this branch with the master branch if any.
964
:return: None or the last_revision pivoted out during the update.
968
def check_revno(self, revno):
970
Check whether a revno corresponds to any revision.
971
Zero (the NULL revision) is considered valid.
974
self.check_real_revno(revno)
976
def check_real_revno(self, revno):
978
Check whether a revno corresponds to a real revision.
979
Zero (the NULL revision) is considered invalid
981
if revno < 1 or revno > self.revno():
982
raise errors.InvalidRevisionNumber(revno)
985
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
986
"""Clone this branch into to_bzrdir preserving all semantic values.
988
Most API users will want 'create_clone_on_transport', which creates a
989
new bzrdir and branch on the fly.
991
revision_id: if not None, the revision history in the new branch will
992
be truncated to end with revision_id.
994
result = to_bzrdir.create_branch()
995
if repository_policy is not None:
996
repository_policy.configure_branch(result)
997
self.copy_content_into(result, revision_id=revision_id)
1001
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1002
"""Create a new line of development from the branch, into to_bzrdir.
1004
to_bzrdir controls the branch format.
1006
revision_id: if not None, the revision history in the new branch will
1007
be truncated to end with revision_id.
1009
result = to_bzrdir.create_branch()
1010
if repository_policy is not None:
1011
repository_policy.configure_branch(result)
1012
self.copy_content_into(result, revision_id=revision_id)
1013
result.set_parent(self.bzrdir.root_transport.base)
1016
def _synchronize_history(self, destination, revision_id):
1017
"""Synchronize last revision and revision history between branches.
1019
This version is most efficient when the destination is also a
1020
BzrBranch6, but works for BzrBranch5, as long as the destination's
1021
repository contains all the lefthand ancestors of the intended
1022
last_revision. If not, set_last_revision_info will fail.
1024
:param destination: The branch to copy the history into
1025
:param revision_id: The revision-id to truncate history at. May
1026
be None to copy complete history.
1028
source_revno, source_revision_id = self.last_revision_info()
1029
if revision_id is None:
1030
revno, revision_id = source_revno, source_revision_id
1031
elif source_revision_id == revision_id:
1032
# we know the revno without needing to walk all of history
1033
revno = source_revno
1035
# To figure out the revno for a random revision, we need to build
1036
# the revision history, and count its length.
1037
# We don't care about the order, just how long it is.
1038
# Alternatively, we could start at the current location, and count
1039
# backwards. But there is no guarantee that we will find it since
1040
# it may be a merged revision.
1041
revno = len(list(self.repository.iter_reverse_revision_history(
1043
destination.set_last_revision_info(revno, revision_id)
1046
def copy_content_into(self, destination, revision_id=None):
1047
"""Copy the content of self into destination.
1049
revision_id: if not None, the revision history in the new branch will
1050
be truncated to end with revision_id.
1052
self.update_references(destination)
1053
self._synchronize_history(destination, revision_id)
1055
parent = self.get_parent()
1056
except errors.InaccessibleParent, e:
1057
mutter('parent was not accessible to copy: %s', e)
1060
destination.set_parent(parent)
1061
if self._push_should_merge_tags():
1062
self.tags.merge_to(destination.tags)
1064
def update_references(self, target):
1065
if not getattr(self._format, 'supports_reference_locations', False):
1067
reference_dict = self._get_all_reference_info()
1068
if len(reference_dict) == 0:
1070
old_base = self.base
1071
new_base = target.base
1072
target_reference_dict = target._get_all_reference_info()
1073
for file_id, (tree_path, branch_location) in (
1074
reference_dict.items()):
1075
branch_location = urlutils.rebase_url(branch_location,
1077
target_reference_dict.setdefault(
1078
file_id, (tree_path, branch_location))
1079
target._set_all_reference_info(target_reference_dict)
1083
"""Check consistency of the branch.
1085
In particular this checks that revisions given in the revision-history
1086
do actually match up in the revision graph, and that they're all
1087
present in the repository.
1089
Callers will typically also want to check the repository.
1091
:return: A BranchCheckResult.
1093
mainline_parent_id = None
1094
last_revno, last_revision_id = self.last_revision_info()
1095
real_rev_history = list(self.repository.iter_reverse_revision_history(
1097
real_rev_history.reverse()
1098
if len(real_rev_history) != last_revno:
1099
raise errors.BzrCheckError('revno does not match len(mainline)'
1100
' %s != %s' % (last_revno, len(real_rev_history)))
1101
# TODO: We should probably also check that real_rev_history actually
1102
# matches self.revision_history()
1103
for revision_id in real_rev_history:
1105
revision = self.repository.get_revision(revision_id)
1106
except errors.NoSuchRevision, e:
1107
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1109
# In general the first entry on the revision history has no parents.
1110
# But it's not illegal for it to have parents listed; this can happen
1111
# in imports from Arch when the parents weren't reachable.
1112
if mainline_parent_id is not None:
1113
if mainline_parent_id not in revision.parent_ids:
1114
raise errors.BzrCheckError("previous revision {%s} not listed among "
1116
% (mainline_parent_id, revision_id))
1117
mainline_parent_id = revision_id
1118
return BranchCheckResult(self)
1120
def _get_checkout_format(self):
1121
"""Return the most suitable metadir for a checkout of this branch.
1122
Weaves are used if this branch's repository uses weaves.
1124
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1125
from bzrlib.repofmt import weaverepo
1126
format = bzrdir.BzrDirMetaFormat1()
1127
format.repository_format = weaverepo.RepositoryFormat7()
1129
format = self.repository.bzrdir.checkout_metadir()
1130
format.set_branch_format(self._format)
1133
def create_clone_on_transport(self, to_transport, revision_id=None,
1135
"""Create a clone of this branch and its bzrdir.
1137
:param to_transport: The transport to clone onto.
1138
:param revision_id: The revision id to use as tip in the new branch.
1139
If None the tip is obtained from this branch.
1140
:param stacked_on: An optional URL to stack the clone on.
1142
# XXX: Fix the bzrdir API to allow getting the branch back from the
1143
# clone call. Or something. 20090224 RBC/spiv.
1144
dir_to = self.bzrdir.clone_on_transport(to_transport,
1145
revision_id=revision_id, stacked_on=stacked_on)
1146
return dir_to.open_branch()
1148
def create_checkout(self, to_location, revision_id=None,
1149
lightweight=False, accelerator_tree=None,
1151
"""Create a checkout of a branch.
1153
:param to_location: The url to produce the checkout at
1154
:param revision_id: The revision to check out
1155
:param lightweight: If True, produce a lightweight checkout, otherwise,
1156
produce a bound branch (heavyweight checkout)
1157
:param accelerator_tree: A tree which can be used for retrieving file
1158
contents more quickly than the revision tree, i.e. a workingtree.
1159
The revision tree will be used for cases where accelerator_tree's
1160
content is different.
1161
:param hardlink: If true, hard-link files from accelerator_tree,
1163
:return: The tree of the created checkout
1165
t = transport.get_transport(to_location)
1168
format = self._get_checkout_format()
1169
checkout = format.initialize_on_transport(t)
1170
from_branch = BranchReferenceFormat().initialize(checkout, self)
1172
format = self._get_checkout_format()
1173
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1174
to_location, force_new_tree=False, format=format)
1175
checkout = checkout_branch.bzrdir
1176
checkout_branch.bind(self)
1177
# pull up to the specified revision_id to set the initial
1178
# branch tip correctly, and seed it with history.
1179
checkout_branch.pull(self, stop_revision=revision_id)
1181
tree = checkout.create_workingtree(revision_id,
1182
from_branch=from_branch,
1183
accelerator_tree=accelerator_tree,
1185
basis_tree = tree.basis_tree()
1186
basis_tree.lock_read()
1188
for path, file_id in basis_tree.iter_references():
1189
reference_parent = self.reference_parent(file_id, path)
1190
reference_parent.create_checkout(tree.abspath(path),
1191
basis_tree.get_reference_revision(file_id, path),
1198
def reconcile(self, thorough=True):
1199
"""Make sure the data stored in this branch is consistent."""
1200
from bzrlib.reconcile import BranchReconciler
1201
reconciler = BranchReconciler(self, thorough=thorough)
1202
reconciler.reconcile()
1205
def reference_parent(self, file_id, path, possible_transports=None):
1206
"""Return the parent branch for a tree-reference file_id
1207
:param file_id: The file_id of the tree reference
1208
:param path: The path of the file_id in the tree
1209
:return: A branch associated with the file_id
1211
# FIXME should provide multiple branches, based on config
1212
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1213
possible_transports=possible_transports)
1215
def supports_tags(self):
1216
return self._format.supports_tags()
1218
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1220
"""Ensure that revision_b is a descendant of revision_a.
1222
This is a helper function for update_revisions.
1224
:raises: DivergedBranches if revision_b has diverged from revision_a.
1225
:returns: True if revision_b is a descendant of revision_a.
1227
relation = self._revision_relations(revision_a, revision_b, graph)
1228
if relation == 'b_descends_from_a':
1230
elif relation == 'diverged':
1231
raise errors.DivergedBranches(self, other_branch)
1232
elif relation == 'a_descends_from_b':
1235
raise AssertionError("invalid relation: %r" % (relation,))
1237
def _revision_relations(self, revision_a, revision_b, graph):
1238
"""Determine the relationship between two revisions.
1240
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1242
heads = graph.heads([revision_a, revision_b])
1243
if heads == set([revision_b]):
1244
return 'b_descends_from_a'
1245
elif heads == set([revision_a, revision_b]):
1246
# These branches have diverged
1248
elif heads == set([revision_a]):
1249
return 'a_descends_from_b'
1251
raise AssertionError("invalid heads: %r" % (heads,))
1254
class BranchFormat(object):
1255
"""An encapsulation of the initialization and open routines for a format.
1257
Formats provide three things:
1258
* An initialization routine,
1262
Formats are placed in an dict by their format string for reference
1263
during branch opening. Its not required that these be instances, they
1264
can be classes themselves with class methods - it simply depends on
1265
whether state is needed for a given format or not.
1267
Once a format is deprecated, just deprecate the initialize and open
1268
methods on the format class. Do not deprecate the object, as the
1269
object will be created every time regardless.
1272
_default_format = None
1273
"""The default format used for new branches."""
1276
"""The known formats."""
1278
def __eq__(self, other):
1279
return self.__class__ is other.__class__
1281
def __ne__(self, other):
1282
return not (self == other)
1285
def find_format(klass, a_bzrdir):
1286
"""Return the format for the branch object in a_bzrdir."""
1288
transport = a_bzrdir.get_branch_transport(None)
1289
format_string = transport.get("format").read()
1290
return klass._formats[format_string]
1291
except errors.NoSuchFile:
1292
raise errors.NotBranchError(path=transport.base)
1294
raise errors.UnknownFormatError(format=format_string, kind='branch')
1297
def get_default_format(klass):
1298
"""Return the current default format."""
1299
return klass._default_format
1301
def get_reference(self, a_bzrdir):
1302
"""Get the target reference of the branch in a_bzrdir.
1304
format probing must have been completed before calling
1305
this method - it is assumed that the format of the branch
1306
in a_bzrdir is correct.
1308
:param a_bzrdir: The bzrdir to get the branch data from.
1309
:return: None if the branch is not a reference branch.
1314
def set_reference(self, a_bzrdir, to_branch):
1315
"""Set the target reference of the branch in a_bzrdir.
1317
format probing must have been completed before calling
1318
this method - it is assumed that the format of the branch
1319
in a_bzrdir is correct.
1321
:param a_bzrdir: The bzrdir to set the branch reference for.
1322
:param to_branch: branch that the checkout is to reference
1324
raise NotImplementedError(self.set_reference)
1326
def get_format_string(self):
1327
"""Return the ASCII format string that identifies this format."""
1328
raise NotImplementedError(self.get_format_string)
1330
def get_format_description(self):
1331
"""Return the short format description for this format."""
1332
raise NotImplementedError(self.get_format_description)
1334
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1336
"""Initialize a branch in a bzrdir, with specified files
1338
:param a_bzrdir: The bzrdir to initialize the branch in
1339
:param utf8_files: The files to create as a list of
1340
(filename, content) tuples
1341
:param set_format: If True, set the format with
1342
self.get_format_string. (BzrBranch4 has its format set
1344
:return: a branch in this format
1346
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1347
branch_transport = a_bzrdir.get_branch_transport(self)
1349
'metadir': ('lock', lockdir.LockDir),
1350
'branch4': ('branch-lock', lockable_files.TransportLock),
1352
lock_name, lock_class = lock_map[lock_type]
1353
control_files = lockable_files.LockableFiles(branch_transport,
1354
lock_name, lock_class)
1355
control_files.create_lock()
1356
control_files.lock_write()
1358
utf8_files += [('format', self.get_format_string())]
1360
for (filename, content) in utf8_files:
1361
branch_transport.put_bytes(
1363
mode=a_bzrdir._get_file_mode())
1365
control_files.unlock()
1366
return self.open(a_bzrdir, _found=True)
1368
def initialize(self, a_bzrdir):
1369
"""Create a branch of this format in a_bzrdir."""
1370
raise NotImplementedError(self.initialize)
1372
def is_supported(self):
1373
"""Is this format supported?
1375
Supported formats can be initialized and opened.
1376
Unsupported formats may not support initialization or committing or
1377
some other features depending on the reason for not being supported.
1381
def make_tags(self, branch):
1382
"""Create a tags object for branch.
1384
This method is on BranchFormat, because BranchFormats are reflected
1385
over the wire via network_name(), whereas full Branch instances require
1386
multiple VFS method calls to operate at all.
1388
The default implementation returns a disabled-tags instance.
1390
Note that it is normal for branch to be a RemoteBranch when using tags
1393
return DisabledTags(branch)
1395
def network_name(self):
1396
"""A simple byte string uniquely identifying this format for RPC calls.
1398
MetaDir branch formats use their disk format string to identify the
1399
repository over the wire. All in one formats such as bzr < 0.8, and
1400
foreign formats like svn/git and hg should use some marker which is
1401
unique and immutable.
1403
raise NotImplementedError(self.network_name)
1405
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1406
"""Return the branch object for a_bzrdir
1408
:param a_bzrdir: A BzrDir that contains a branch.
1409
:param _found: a private parameter, do not use it. It is used to
1410
indicate if format probing has already be done.
1411
:param ignore_fallbacks: when set, no fallback branches will be opened
1412
(if there are any). Default is to open fallbacks.
1414
raise NotImplementedError(self.open)
1417
def register_format(klass, format):
1418
"""Register a metadir format."""
1419
klass._formats[format.get_format_string()] = format
1420
# Metadir formats have a network name of their format string, and get
1421
# registered as class factories.
1422
network_format_registry.register(format.get_format_string(), format.__class__)
1425
def set_default_format(klass, format):
1426
klass._default_format = format
1428
def supports_stacking(self):
1429
"""True if this format records a stacked-on branch."""
1433
def unregister_format(klass, format):
1434
del klass._formats[format.get_format_string()]
1437
return self.get_format_description().rstrip()
1439
def supports_tags(self):
1440
"""True if this format supports tags stored in the branch"""
1441
return False # by default
1444
class BranchHooks(Hooks):
1445
"""A dictionary mapping hook name to a list of callables for branch hooks.
1447
e.g. ['set_rh'] Is the list of items to be called when the
1448
set_revision_history function is invoked.
1452
"""Create the default hooks.
1454
These are all empty initially, because by default nothing should get
1457
Hooks.__init__(self)
1458
self.create_hook(HookPoint('set_rh',
1459
"Invoked whenever the revision history has been set via "
1460
"set_revision_history. The api signature is (branch, "
1461
"revision_history), and the branch will be write-locked. "
1462
"The set_rh hook can be expensive for bzr to trigger, a better "
1463
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1464
self.create_hook(HookPoint('open',
1465
"Called with the Branch object that has been opened after a "
1466
"branch is opened.", (1, 8), None))
1467
self.create_hook(HookPoint('post_push',
1468
"Called after a push operation completes. post_push is called "
1469
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1470
"bzr client.", (0, 15), None))
1471
self.create_hook(HookPoint('post_pull',
1472
"Called after a pull operation completes. post_pull is called "
1473
"with a bzrlib.branch.PullResult object and only runs in the "
1474
"bzr client.", (0, 15), None))
1475
self.create_hook(HookPoint('pre_commit',
1476
"Called after a commit is calculated but before it is is "
1477
"completed. pre_commit is called with (local, master, old_revno, "
1478
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1479
"). old_revid is NULL_REVISION for the first commit to a branch, "
1480
"tree_delta is a TreeDelta object describing changes from the "
1481
"basis revision. hooks MUST NOT modify this delta. "
1482
" future_tree is an in-memory tree obtained from "
1483
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1484
"tree.", (0,91), None))
1485
self.create_hook(HookPoint('post_commit',
1486
"Called in the bzr client after a commit has completed. "
1487
"post_commit is called with (local, master, old_revno, old_revid, "
1488
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1489
"commit to a branch.", (0, 15), None))
1490
self.create_hook(HookPoint('post_uncommit',
1491
"Called in the bzr client after an uncommit completes. "
1492
"post_uncommit is called with (local, master, old_revno, "
1493
"old_revid, new_revno, new_revid) where local is the local branch "
1494
"or None, master is the target branch, and an empty branch "
1495
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1496
self.create_hook(HookPoint('pre_change_branch_tip',
1497
"Called in bzr client and server before a change to the tip of a "
1498
"branch is made. pre_change_branch_tip is called with a "
1499
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1500
"commit, uncommit will all trigger this hook.", (1, 6), None))
1501
self.create_hook(HookPoint('post_change_branch_tip',
1502
"Called in bzr client and server after a change to the tip of a "
1503
"branch is made. post_change_branch_tip is called with a "
1504
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1505
"commit, uncommit will all trigger this hook.", (1, 4), None))
1506
self.create_hook(HookPoint('transform_fallback_location',
1507
"Called when a stacked branch is activating its fallback "
1508
"locations. transform_fallback_location is called with (branch, "
1509
"url), and should return a new url. Returning the same url "
1510
"allows it to be used as-is, returning a different one can be "
1511
"used to cause the branch to stack on a closer copy of that "
1512
"fallback_location. Note that the branch cannot have history "
1513
"accessing methods called on it during this hook because the "
1514
"fallback locations have not been activated. When there are "
1515
"multiple hooks installed for transform_fallback_location, "
1516
"all are called with the url returned from the previous hook."
1517
"The order is however undefined.", (1, 9), None))
1520
# install the default hooks into the Branch class.
1521
Branch.hooks = BranchHooks()
1524
class ChangeBranchTipParams(object):
1525
"""Object holding parameters passed to *_change_branch_tip hooks.
1527
There are 5 fields that hooks may wish to access:
1529
:ivar branch: the branch being changed
1530
:ivar old_revno: revision number before the change
1531
:ivar new_revno: revision number after the change
1532
:ivar old_revid: revision id before the change
1533
:ivar new_revid: revision id after the change
1535
The revid fields are strings. The revno fields are integers.
1538
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1539
"""Create a group of ChangeBranchTip parameters.
1541
:param branch: The branch being changed.
1542
:param old_revno: Revision number before the change.
1543
:param new_revno: Revision number after the change.
1544
:param old_revid: Tip revision id before the change.
1545
:param new_revid: Tip revision id after the change.
1547
self.branch = branch
1548
self.old_revno = old_revno
1549
self.new_revno = new_revno
1550
self.old_revid = old_revid
1551
self.new_revid = new_revid
1553
def __eq__(self, other):
1554
return self.__dict__ == other.__dict__
1557
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1558
self.__class__.__name__, self.branch,
1559
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1562
class BzrBranchFormat4(BranchFormat):
1563
"""Bzr branch format 4.
1566
- a revision-history file.
1567
- a branch-lock lock file [ to be shared with the bzrdir ]
1570
def get_format_description(self):
1571
"""See BranchFormat.get_format_description()."""
1572
return "Branch format 4"
1574
def initialize(self, a_bzrdir):
1575
"""Create a branch of this format in a_bzrdir."""
1576
utf8_files = [('revision-history', ''),
1577
('branch-name', ''),
1579
return self._initialize_helper(a_bzrdir, utf8_files,
1580
lock_type='branch4', set_format=False)
1583
super(BzrBranchFormat4, self).__init__()
1584
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1586
def network_name(self):
1587
"""The network name for this format is the control dirs disk label."""
1588
return self._matchingbzrdir.get_format_string()
1590
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1591
"""See BranchFormat.open()."""
1593
# we are being called directly and must probe.
1594
raise NotImplementedError
1595
return BzrBranch(_format=self,
1596
_control_files=a_bzrdir._control_files,
1598
_repository=a_bzrdir.open_repository())
1601
return "Bazaar-NG branch format 4"
1604
class BranchFormatMetadir(BranchFormat):
1605
"""Common logic for meta-dir based branch formats."""
1607
def _branch_class(self):
1608
"""What class to instantiate on open calls."""
1609
raise NotImplementedError(self._branch_class)
1611
def network_name(self):
1612
"""A simple byte string uniquely identifying this format for RPC calls.
1614
Metadir branch formats use their format string.
1616
return self.get_format_string()
1618
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1619
"""See BranchFormat.open()."""
1621
format = BranchFormat.find_format(a_bzrdir)
1622
if format.__class__ != self.__class__:
1623
raise AssertionError("wrong format %r found for %r" %
1626
transport = a_bzrdir.get_branch_transport(None)
1627
control_files = lockable_files.LockableFiles(transport, 'lock',
1629
return self._branch_class()(_format=self,
1630
_control_files=control_files,
1632
_repository=a_bzrdir.find_repository(),
1633
ignore_fallbacks=ignore_fallbacks)
1634
except errors.NoSuchFile:
1635
raise errors.NotBranchError(path=transport.base)
1638
super(BranchFormatMetadir, self).__init__()
1639
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1640
self._matchingbzrdir.set_branch_format(self)
1642
def supports_tags(self):
1646
class BzrBranchFormat5(BranchFormatMetadir):
1647
"""Bzr branch format 5.
1650
- a revision-history file.
1652
- a lock dir guarding the branch itself
1653
- all of this stored in a branch/ subdirectory
1654
- works with shared repositories.
1656
This format is new in bzr 0.8.
1659
def _branch_class(self):
1662
def get_format_string(self):
1663
"""See BranchFormat.get_format_string()."""
1664
return "Bazaar-NG branch format 5\n"
1666
def get_format_description(self):
1667
"""See BranchFormat.get_format_description()."""
1668
return "Branch format 5"
1670
def initialize(self, a_bzrdir):
1671
"""Create a branch of this format in a_bzrdir."""
1672
utf8_files = [('revision-history', ''),
1673
('branch-name', ''),
1675
return self._initialize_helper(a_bzrdir, utf8_files)
1677
def supports_tags(self):
1681
class BzrBranchFormat6(BranchFormatMetadir):
1682
"""Branch format with last-revision and tags.
1684
Unlike previous formats, this has no explicit revision history. Instead,
1685
this just stores the last-revision, and the left-hand history leading
1686
up to there is the history.
1688
This format was introduced in bzr 0.15
1689
and became the default in 0.91.
1692
def _branch_class(self):
1695
def get_format_string(self):
1696
"""See BranchFormat.get_format_string()."""
1697
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1699
def get_format_description(self):
1700
"""See BranchFormat.get_format_description()."""
1701
return "Branch format 6"
1703
def initialize(self, a_bzrdir):
1704
"""Create a branch of this format in a_bzrdir."""
1705
utf8_files = [('last-revision', '0 null:\n'),
1706
('branch.conf', ''),
1709
return self._initialize_helper(a_bzrdir, utf8_files)
1711
def make_tags(self, branch):
1712
"""See bzrlib.branch.BranchFormat.make_tags()."""
1713
return BasicTags(branch)
1717
class BzrBranchFormat8(BranchFormatMetadir):
1718
"""Metadir format supporting storing locations of subtree branches."""
1720
def _branch_class(self):
1723
def get_format_string(self):
1724
"""See BranchFormat.get_format_string()."""
1725
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1727
def get_format_description(self):
1728
"""See BranchFormat.get_format_description()."""
1729
return "Branch format 8"
1731
def initialize(self, a_bzrdir):
1732
"""Create a branch of this format in a_bzrdir."""
1733
utf8_files = [('last-revision', '0 null:\n'),
1734
('branch.conf', ''),
1738
return self._initialize_helper(a_bzrdir, utf8_files)
1741
super(BzrBranchFormat8, self).__init__()
1742
self._matchingbzrdir.repository_format = \
1743
RepositoryFormatKnitPack5RichRoot()
1745
def make_tags(self, branch):
1746
"""See bzrlib.branch.BranchFormat.make_tags()."""
1747
return BasicTags(branch)
1749
def supports_stacking(self):
1752
supports_reference_locations = True
1755
class BzrBranchFormat7(BzrBranchFormat8):
1756
"""Branch format with last-revision, tags, and a stacked location pointer.
1758
The stacked location pointer is passed down to the repository and requires
1759
a repository format with supports_external_lookups = True.
1761
This format was introduced in bzr 1.6.
1764
def initialize(self, a_bzrdir):
1765
"""Create a branch of this format in a_bzrdir."""
1766
utf8_files = [('last-revision', '0 null:\n'),
1767
('branch.conf', ''),
1770
return self._initialize_helper(a_bzrdir, utf8_files)
1772
def _branch_class(self):
1775
def get_format_string(self):
1776
"""See BranchFormat.get_format_string()."""
1777
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1779
def get_format_description(self):
1780
"""See BranchFormat.get_format_description()."""
1781
return "Branch format 7"
1783
supports_reference_locations = False
1786
class BranchReferenceFormat(BranchFormat):
1787
"""Bzr branch reference format.
1789
Branch references are used in implementing checkouts, they
1790
act as an alias to the real branch which is at some other url.
1797
def get_format_string(self):
1798
"""See BranchFormat.get_format_string()."""
1799
return "Bazaar-NG Branch Reference Format 1\n"
1801
def get_format_description(self):
1802
"""See BranchFormat.get_format_description()."""
1803
return "Checkout reference format 1"
1805
def get_reference(self, a_bzrdir):
1806
"""See BranchFormat.get_reference()."""
1807
transport = a_bzrdir.get_branch_transport(None)
1808
return transport.get('location').read()
1810
def set_reference(self, a_bzrdir, to_branch):
1811
"""See BranchFormat.set_reference()."""
1812
transport = a_bzrdir.get_branch_transport(None)
1813
location = transport.put_bytes('location', to_branch.base)
1815
def initialize(self, a_bzrdir, target_branch=None):
1816
"""Create a branch of this format in a_bzrdir."""
1817
if target_branch is None:
1818
# this format does not implement branch itself, thus the implicit
1819
# creation contract must see it as uninitializable
1820
raise errors.UninitializableFormat(self)
1821
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1822
branch_transport = a_bzrdir.get_branch_transport(self)
1823
branch_transport.put_bytes('location',
1824
target_branch.bzrdir.root_transport.base)
1825
branch_transport.put_bytes('format', self.get_format_string())
1827
a_bzrdir, _found=True,
1828
possible_transports=[target_branch.bzrdir.root_transport])
1831
super(BranchReferenceFormat, self).__init__()
1832
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1833
self._matchingbzrdir.set_branch_format(self)
1835
def _make_reference_clone_function(format, a_branch):
1836
"""Create a clone() routine for a branch dynamically."""
1837
def clone(to_bzrdir, revision_id=None,
1838
repository_policy=None):
1839
"""See Branch.clone()."""
1840
return format.initialize(to_bzrdir, a_branch)
1841
# cannot obey revision_id limits when cloning a reference ...
1842
# FIXME RBC 20060210 either nuke revision_id for clone, or
1843
# emit some sort of warning/error to the caller ?!
1846
def open(self, a_bzrdir, _found=False, location=None,
1847
possible_transports=None, ignore_fallbacks=False):
1848
"""Return the branch that the branch reference in a_bzrdir points at.
1850
:param a_bzrdir: A BzrDir that contains a branch.
1851
:param _found: a private parameter, do not use it. It is used to
1852
indicate if format probing has already be done.
1853
:param ignore_fallbacks: when set, no fallback branches will be opened
1854
(if there are any). Default is to open fallbacks.
1855
:param location: The location of the referenced branch. If
1856
unspecified, this will be determined from the branch reference in
1858
:param possible_transports: An optional reusable transports list.
1861
format = BranchFormat.find_format(a_bzrdir)
1862
if format.__class__ != self.__class__:
1863
raise AssertionError("wrong format %r found for %r" %
1865
if location is None:
1866
location = self.get_reference(a_bzrdir)
1867
real_bzrdir = bzrdir.BzrDir.open(
1868
location, possible_transports=possible_transports)
1869
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1870
# this changes the behaviour of result.clone to create a new reference
1871
# rather than a copy of the content of the branch.
1872
# I did not use a proxy object because that needs much more extensive
1873
# testing, and we are only changing one behaviour at the moment.
1874
# If we decide to alter more behaviours - i.e. the implicit nickname
1875
# then this should be refactored to introduce a tested proxy branch
1876
# and a subclass of that for use in overriding clone() and ....
1878
result.clone = self._make_reference_clone_function(result)
1882
network_format_registry = registry.FormatRegistry()
1883
"""Registry of formats indexed by their network name.
1885
The network name for a branch format is an identifier that can be used when
1886
referring to formats with smart server operations. See
1887
BranchFormat.network_name() for more detail.
1891
# formats which have no format string are not discoverable
1892
# and not independently creatable, so are not registered.
1893
__format5 = BzrBranchFormat5()
1894
__format6 = BzrBranchFormat6()
1895
__format7 = BzrBranchFormat7()
1896
__format8 = BzrBranchFormat8()
1897
BranchFormat.register_format(__format5)
1898
BranchFormat.register_format(BranchReferenceFormat())
1899
BranchFormat.register_format(__format6)
1900
BranchFormat.register_format(__format7)
1901
BranchFormat.register_format(__format8)
1902
BranchFormat.set_default_format(__format6)
1903
_legacy_formats = [BzrBranchFormat4(),
1905
network_format_registry.register(
1906
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1909
class BzrBranch(Branch):
1910
"""A branch stored in the actual filesystem.
1912
Note that it's "local" in the context of the filesystem; it doesn't
1913
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1914
it's writable, and can be accessed via the normal filesystem API.
1916
:ivar _transport: Transport for file operations on this branch's
1917
control files, typically pointing to the .bzr/branch directory.
1918
:ivar repository: Repository for this branch.
1919
:ivar base: The url of the base directory for this branch; the one
1920
containing the .bzr directory.
1923
def __init__(self, _format=None,
1924
_control_files=None, a_bzrdir=None, _repository=None,
1925
ignore_fallbacks=False):
1926
"""Create new branch object at a particular location."""
1927
if a_bzrdir is None:
1928
raise ValueError('a_bzrdir must be supplied')
1930
self.bzrdir = a_bzrdir
1931
self._base = self.bzrdir.transport.clone('..').base
1932
# XXX: We should be able to just do
1933
# self.base = self.bzrdir.root_transport.base
1934
# but this does not quite work yet -- mbp 20080522
1935
self._format = _format
1936
if _control_files is None:
1937
raise ValueError('BzrBranch _control_files is None')
1938
self.control_files = _control_files
1939
self._transport = _control_files._transport
1940
self.repository = _repository
1941
Branch.__init__(self)
1944
return '%s(%r)' % (self.__class__.__name__, self.base)
1948
def _get_base(self):
1949
"""Returns the directory containing the control directory."""
1952
base = property(_get_base, doc="The URL for the root of this branch.")
1954
def _get_config(self):
1955
return TransportConfig(self._transport, 'branch.conf')
1957
def is_locked(self):
1958
return self.control_files.is_locked()
1960
def lock_write(self, token=None):
1961
repo_token = self.repository.lock_write()
1963
token = self.control_files.lock_write(token=token)
1965
self.repository.unlock()
1969
def lock_read(self):
1970
self.repository.lock_read()
1972
self.control_files.lock_read()
1974
self.repository.unlock()
1978
# TODO: test for failed two phase locks. This is known broken.
1980
self.control_files.unlock()
1982
self.repository.unlock()
1983
if not self.control_files.is_locked():
1984
# we just released the lock
1985
self._clear_cached_state()
1987
def peek_lock_mode(self):
1988
if self.control_files._lock_count == 0:
1991
return self.control_files._lock_mode
1993
def get_physical_lock_status(self):
1994
return self.control_files.get_physical_lock_status()
1997
def print_file(self, file, revision_id):
1998
"""See Branch.print_file."""
1999
return self.repository.print_file(file, revision_id)
2001
def _write_revision_history(self, history):
2002
"""Factored out of set_revision_history.
2004
This performs the actual writing to disk.
2005
It is intended to be called by BzrBranch5.set_revision_history."""
2006
self._transport.put_bytes(
2007
'revision-history', '\n'.join(history),
2008
mode=self.bzrdir._get_file_mode())
2011
def set_revision_history(self, rev_history):
2012
"""See Branch.set_revision_history."""
2013
if 'evil' in debug.debug_flags:
2014
mutter_callsite(3, "set_revision_history scales with history.")
2015
check_not_reserved_id = _mod_revision.check_not_reserved_id
2016
for rev_id in rev_history:
2017
check_not_reserved_id(rev_id)
2018
if Branch.hooks['post_change_branch_tip']:
2019
# Don't calculate the last_revision_info() if there are no hooks
2021
old_revno, old_revid = self.last_revision_info()
2022
if len(rev_history) == 0:
2023
revid = _mod_revision.NULL_REVISION
2025
revid = rev_history[-1]
2026
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2027
self._write_revision_history(rev_history)
2028
self._clear_cached_state()
2029
self._cache_revision_history(rev_history)
2030
for hook in Branch.hooks['set_rh']:
2031
hook(self, rev_history)
2032
if Branch.hooks['post_change_branch_tip']:
2033
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2035
def _synchronize_history(self, destination, revision_id):
2036
"""Synchronize last revision and revision history between branches.
2038
This version is most efficient when the destination is also a
2039
BzrBranch5, but works for BzrBranch6 as long as the revision
2040
history is the true lefthand parent history, and all of the revisions
2041
are in the destination's repository. If not, set_revision_history
2044
:param destination: The branch to copy the history into
2045
:param revision_id: The revision-id to truncate history at. May
2046
be None to copy complete history.
2048
if not isinstance(destination._format, BzrBranchFormat5):
2049
super(BzrBranch, self)._synchronize_history(
2050
destination, revision_id)
2052
if revision_id == _mod_revision.NULL_REVISION:
2055
new_history = self.revision_history()
2056
if revision_id is not None and new_history != []:
2058
new_history = new_history[:new_history.index(revision_id) + 1]
2060
rev = self.repository.get_revision(revision_id)
2061
new_history = rev.get_history(self.repository)[1:]
2062
destination.set_revision_history(new_history)
2065
def set_last_revision_info(self, revno, revision_id):
2066
"""Set the last revision of this branch.
2068
The caller is responsible for checking that the revno is correct
2069
for this revision id.
2071
It may be possible to set the branch last revision to an id not
2072
present in the repository. However, branches can also be
2073
configured to check constraints on history, in which case this may not
2076
revision_id = _mod_revision.ensure_null(revision_id)
2077
# this old format stores the full history, but this api doesn't
2078
# provide it, so we must generate, and might as well check it's
2080
history = self._lefthand_history(revision_id)
2081
if len(history) != revno:
2082
raise AssertionError('%d != %d' % (len(history), revno))
2083
self.set_revision_history(history)
2085
def _gen_revision_history(self):
2086
history = self._transport.get_bytes('revision-history').split('\n')
2087
if history[-1:] == ['']:
2088
# There shouldn't be a trailing newline, but just in case.
2093
def generate_revision_history(self, revision_id, last_rev=None,
2095
"""Create a new revision history that will finish with revision_id.
2097
:param revision_id: the new tip to use.
2098
:param last_rev: The previous last_revision. If not None, then this
2099
must be a ancestory of revision_id, or DivergedBranches is raised.
2100
:param other_branch: The other branch that DivergedBranches should
2101
raise with respect to.
2103
self.set_revision_history(self._lefthand_history(revision_id,
2104
last_rev, other_branch))
2106
def basis_tree(self):
2107
"""See Branch.basis_tree."""
2108
return self.repository.revision_tree(self.last_revision())
2111
def pull(self, source, overwrite=False, stop_revision=None,
2112
_hook_master=None, run_hooks=True, possible_transports=None,
2113
_override_hook_target=None):
2116
:param _hook_master: Private parameter - set the branch to
2117
be supplied as the master to pull hooks.
2118
:param run_hooks: Private parameter - if false, this branch
2119
is being called because it's the master of the primary branch,
2120
so it should not run its hooks.
2121
:param _override_hook_target: Private parameter - set the branch to be
2122
supplied as the target_branch to pull hooks.
2124
result = PullResult()
2125
result.source_branch = source
2126
if _override_hook_target is None:
2127
result.target_branch = self
2129
result.target_branch = _override_hook_target
2132
# We assume that during 'pull' the local repository is closer than
2134
source.update_references(self)
2135
graph = self.repository.get_graph(source.repository)
2136
result.old_revno, result.old_revid = self.last_revision_info()
2137
self.update_revisions(source, stop_revision, overwrite=overwrite,
2139
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2140
result.new_revno, result.new_revid = self.last_revision_info()
2142
result.master_branch = _hook_master
2143
result.local_branch = result.target_branch
2145
result.master_branch = result.target_branch
2146
result.local_branch = None
2148
for hook in Branch.hooks['post_pull']:
2154
def _get_parent_location(self):
2155
_locs = ['parent', 'pull', 'x-pull']
2158
return self._transport.get_bytes(l).strip('\n')
2159
except errors.NoSuchFile:
2164
def push(self, target, overwrite=False, stop_revision=None,
2165
_override_hook_source_branch=None):
2168
This is the basic concrete implementation of push()
2170
:param _override_hook_source_branch: If specified, run
2171
the hooks passing this Branch as the source, rather than self.
2172
This is for use of RemoteBranch, where push is delegated to the
2173
underlying vfs-based Branch.
2175
# TODO: Public option to disable running hooks - should be trivial but
2177
return _run_with_write_locked_target(
2178
target, self._push_with_bound_branches, target, overwrite,
2180
_override_hook_source_branch=_override_hook_source_branch)
2182
def _push_with_bound_branches(self, target, overwrite,
2184
_override_hook_source_branch=None):
2185
"""Push from self into target, and into target's master if any.
2187
This is on the base BzrBranch class even though it doesn't support
2188
bound branches because the *target* might be bound.
2191
if _override_hook_source_branch:
2192
result.source_branch = _override_hook_source_branch
2193
for hook in Branch.hooks['post_push']:
2196
bound_location = target.get_bound_location()
2197
if bound_location and target.base != bound_location:
2198
# there is a master branch.
2200
# XXX: Why the second check? Is it even supported for a branch to
2201
# be bound to itself? -- mbp 20070507
2202
master_branch = target.get_master_branch()
2203
master_branch.lock_write()
2205
# push into the master from this branch.
2206
self._basic_push(master_branch, overwrite, stop_revision)
2207
# and push into the target branch from this. Note that we push from
2208
# this branch again, because its considered the highest bandwidth
2210
result = self._basic_push(target, overwrite, stop_revision)
2211
result.master_branch = master_branch
2212
result.local_branch = target
2216
master_branch.unlock()
2219
result = self._basic_push(target, overwrite, stop_revision)
2220
# TODO: Why set master_branch and local_branch if there's no
2221
# binding? Maybe cleaner to just leave them unset? -- mbp
2223
result.master_branch = target
2224
result.local_branch = None
2228
def _basic_push(self, target, overwrite, stop_revision):
2229
"""Basic implementation of push without bound branches or hooks.
2231
Must be called with self read locked and target write locked.
2233
result = BranchPushResult()
2234
result.source_branch = self
2235
result.target_branch = target
2236
result.old_revno, result.old_revid = target.last_revision_info()
2237
self.update_references(target)
2238
if result.old_revid != self.last_revision():
2239
# We assume that during 'push' this repository is closer than
2241
graph = self.repository.get_graph(target.repository)
2242
target.update_revisions(self, stop_revision, overwrite=overwrite,
2244
if self._push_should_merge_tags():
2245
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2246
result.new_revno, result.new_revid = target.last_revision_info()
2249
def get_stacked_on_url(self):
2250
raise errors.UnstackableBranchFormat(self._format, self.base)
2252
def set_push_location(self, location):
2253
"""See Branch.set_push_location."""
2254
self.get_config().set_user_option(
2255
'push_location', location,
2256
store=_mod_config.STORE_LOCATION_NORECURSE)
2259
def set_parent(self, url):
2260
"""See Branch.set_parent."""
2261
# TODO: Maybe delete old location files?
2262
# URLs should never be unicode, even on the local fs,
2263
# FIXUP this and get_parent in a future branch format bump:
2264
# read and rewrite the file. RBC 20060125
2266
if isinstance(url, unicode):
2268
url = url.encode('ascii')
2269
except UnicodeEncodeError:
2270
raise errors.InvalidURL(url,
2271
"Urls must be 7-bit ascii, "
2272
"use bzrlib.urlutils.escape")
2273
url = urlutils.relative_url(self.base, url)
2274
self._set_parent_location(url)
2276
def _set_parent_location(self, url):
2278
self._transport.delete('parent')
2280
self._transport.put_bytes('parent', url + '\n',
2281
mode=self.bzrdir._get_file_mode())
2284
class BzrBranch5(BzrBranch):
2285
"""A format 5 branch. This supports new features over plain branches.
2287
It has support for a master_branch which is the data for bound branches.
2291
def pull(self, source, overwrite=False, stop_revision=None,
2292
run_hooks=True, possible_transports=None,
2293
_override_hook_target=None):
2294
"""Pull from source into self, updating my master if any.
2296
:param run_hooks: Private parameter - if false, this branch
2297
is being called because it's the master of the primary branch,
2298
so it should not run its hooks.
2300
bound_location = self.get_bound_location()
2301
master_branch = None
2302
if bound_location and source.base != bound_location:
2303
# not pulling from master, so we need to update master.
2304
master_branch = self.get_master_branch(possible_transports)
2305
master_branch.lock_write()
2308
# pull from source into master.
2309
master_branch.pull(source, overwrite, stop_revision,
2311
return super(BzrBranch5, self).pull(source, overwrite,
2312
stop_revision, _hook_master=master_branch,
2313
run_hooks=run_hooks,
2314
_override_hook_target=_override_hook_target)
2317
master_branch.unlock()
2319
def get_bound_location(self):
2321
return self._transport.get_bytes('bound')[:-1]
2322
except errors.NoSuchFile:
2326
def get_master_branch(self, possible_transports=None):
2327
"""Return the branch we are bound to.
2329
:return: Either a Branch, or None
2331
This could memoise the branch, but if thats done
2332
it must be revalidated on each new lock.
2333
So for now we just don't memoise it.
2334
# RBC 20060304 review this decision.
2336
bound_loc = self.get_bound_location()
2340
return Branch.open(bound_loc,
2341
possible_transports=possible_transports)
2342
except (errors.NotBranchError, errors.ConnectionError), e:
2343
raise errors.BoundBranchConnectionFailure(
2347
def set_bound_location(self, location):
2348
"""Set the target where this branch is bound to.
2350
:param location: URL to the target branch
2353
self._transport.put_bytes('bound', location+'\n',
2354
mode=self.bzrdir._get_file_mode())
2357
self._transport.delete('bound')
2358
except errors.NoSuchFile:
2363
def bind(self, other):
2364
"""Bind this branch to the branch other.
2366
This does not push or pull data between the branches, though it does
2367
check for divergence to raise an error when the branches are not
2368
either the same, or one a prefix of the other. That behaviour may not
2369
be useful, so that check may be removed in future.
2371
:param other: The branch to bind to
2374
# TODO: jam 20051230 Consider checking if the target is bound
2375
# It is debatable whether you should be able to bind to
2376
# a branch which is itself bound.
2377
# Committing is obviously forbidden,
2378
# but binding itself may not be.
2379
# Since we *have* to check at commit time, we don't
2380
# *need* to check here
2382
# we want to raise diverged if:
2383
# last_rev is not in the other_last_rev history, AND
2384
# other_last_rev is not in our history, and do it without pulling
2386
self.set_bound_location(other.base)
2390
"""If bound, unbind"""
2391
return self.set_bound_location(None)
2394
def update(self, possible_transports=None):
2395
"""Synchronise this branch with the master branch if any.
2397
:return: None or the last_revision that was pivoted out during the
2400
master = self.get_master_branch(possible_transports)
2401
if master is not None:
2402
old_tip = _mod_revision.ensure_null(self.last_revision())
2403
self.pull(master, overwrite=True)
2404
if self.repository.get_graph().is_ancestor(old_tip,
2405
_mod_revision.ensure_null(self.last_revision())):
2411
class BzrBranch8(BzrBranch5):
2412
"""A branch that stores tree-reference locations."""
2414
def _open_hook(self):
2415
if self._ignore_fallbacks:
2418
url = self.get_stacked_on_url()
2419
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2420
errors.UnstackableBranchFormat):
2423
for hook in Branch.hooks['transform_fallback_location']:
2424
url = hook(self, url)
2426
hook_name = Branch.hooks.get_hook_name(hook)
2427
raise AssertionError(
2428
"'transform_fallback_location' hook %s returned "
2429
"None, not a URL." % hook_name)
2430
self._activate_fallback_location(url)
2432
def __init__(self, *args, **kwargs):
2433
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2434
super(BzrBranch8, self).__init__(*args, **kwargs)
2435
self._last_revision_info_cache = None
2436
self._partial_revision_history_cache = []
2438
def _clear_cached_state(self):
2439
super(BzrBranch8, self)._clear_cached_state()
2440
self._last_revision_info_cache = None
2441
self._partial_revision_history_cache = []
2443
def _last_revision_info(self):
2444
revision_string = self._transport.get_bytes('last-revision')
2445
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2446
revision_id = cache_utf8.get_cached_utf8(revision_id)
2448
return revno, revision_id
2450
def _write_last_revision_info(self, revno, revision_id):
2451
"""Simply write out the revision id, with no checks.
2453
Use set_last_revision_info to perform this safely.
2455
Does not update the revision_history cache.
2456
Intended to be called by set_last_revision_info and
2457
_write_revision_history.
2459
revision_id = _mod_revision.ensure_null(revision_id)
2460
out_string = '%d %s\n' % (revno, revision_id)
2461
self._transport.put_bytes('last-revision', out_string,
2462
mode=self.bzrdir._get_file_mode())
2465
def set_last_revision_info(self, revno, revision_id):
2466
revision_id = _mod_revision.ensure_null(revision_id)
2467
old_revno, old_revid = self.last_revision_info()
2468
if self._get_append_revisions_only():
2469
self._check_history_violation(revision_id)
2470
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2471
self._write_last_revision_info(revno, revision_id)
2472
self._clear_cached_state()
2473
self._last_revision_info_cache = revno, revision_id
2474
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2476
def _synchronize_history(self, destination, revision_id):
2477
"""Synchronize last revision and revision history between branches.
2479
:see: Branch._synchronize_history
2481
# XXX: The base Branch has a fast implementation of this method based
2482
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2483
# that uses set_revision_history. This class inherits from BzrBranch5,
2484
# but wants the fast implementation, so it calls
2485
# Branch._synchronize_history directly.
2486
Branch._synchronize_history(self, destination, revision_id)
2488
def _check_history_violation(self, revision_id):
2489
last_revision = _mod_revision.ensure_null(self.last_revision())
2490
if _mod_revision.is_null(last_revision):
2492
if last_revision not in self._lefthand_history(revision_id):
2493
raise errors.AppendRevisionsOnlyViolation(self.base)
2495
def _gen_revision_history(self):
2496
"""Generate the revision history from last revision
2498
last_revno, last_revision = self.last_revision_info()
2499
self._extend_partial_history(stop_index=last_revno-1)
2500
return list(reversed(self._partial_revision_history_cache))
2502
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2503
"""Extend the partial history to include a given index
2505
If a stop_index is supplied, stop when that index has been reached.
2506
If a stop_revision is supplied, stop when that revision is
2507
encountered. Otherwise, stop when the beginning of history is
2510
:param stop_index: The index which should be present. When it is
2511
present, history extension will stop.
2512
:param revision_id: The revision id which should be present. When
2513
it is encountered, history extension will stop.
2515
repo = self.repository
2516
if len(self._partial_revision_history_cache) == 0:
2517
iterator = repo.iter_reverse_revision_history(self.last_revision())
2519
start_revision = self._partial_revision_history_cache[-1]
2520
iterator = repo.iter_reverse_revision_history(start_revision)
2521
#skip the last revision in the list
2522
next_revision = iterator.next()
2523
for revision_id in iterator:
2524
self._partial_revision_history_cache.append(revision_id)
2525
if (stop_index is not None and
2526
len(self._partial_revision_history_cache) > stop_index):
2528
if revision_id == stop_revision:
2531
def _write_revision_history(self, history):
2532
"""Factored out of set_revision_history.
2534
This performs the actual writing to disk, with format-specific checks.
2535
It is intended to be called by BzrBranch5.set_revision_history.
2537
if len(history) == 0:
2538
last_revision = 'null:'
2540
if history != self._lefthand_history(history[-1]):
2541
raise errors.NotLefthandHistory(history)
2542
last_revision = history[-1]
2543
if self._get_append_revisions_only():
2544
self._check_history_violation(last_revision)
2545
self._write_last_revision_info(len(history), last_revision)
2548
def _set_parent_location(self, url):
2549
"""Set the parent branch"""
2550
self._set_config_location('parent_location', url, make_relative=True)
2553
def _get_parent_location(self):
2554
"""Set the parent branch"""
2555
return self._get_config_location('parent_location')
2557
def _set_all_reference_info(self, info_dict):
2558
"""Replace all reference info stored in a branch.
2560
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2563
writer = rio.RioWriter(s)
2564
for key, (tree_path, branch_location) in info_dict.iteritems():
2565
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2566
branch_location=branch_location)
2567
writer.write_stanza(stanza)
2568
self._transport.put_bytes('references', s.getvalue())
2570
def _get_all_reference_info(self):
2571
"""Return all the reference info stored in a branch.
2573
:return: A dict of {file_id: (tree_path, branch_location)}
2575
rio_file = self._transport.get('references')
2577
stanzas = rio.read_stanzas(rio_file)
2578
info_dict = dict((s['file_id'], (s['tree_path'],
2579
s['branch_location'])) for s in stanzas)
2584
def set_reference_info(self, file_id, tree_path, branch_location):
2585
"""Set the branch location to use for a tree reference.
2587
:param file_id: The file-id of the tree reference.
2588
:param tree_path: The path of the tree reference in the tree.
2589
:param branch_location: The location of the branch to retrieve tree
2592
info_dict = self._get_all_reference_info()
2593
info_dict[file_id] = (tree_path, branch_location)
2594
if None in (tree_path, branch_location):
2595
if tree_path is not None:
2596
raise ValueError('tree_path must be None when branch_location'
2598
if branch_location is not None:
2599
raise ValueError('branch_location must be None when tree_path'
2601
del info_dict[file_id]
2602
self._set_all_reference_info(info_dict)
2604
def get_reference_info(self, file_id):
2605
"""Get the tree_path and branch_location for a tree reference.
2607
:return: a tuple of (tree_path, branch_location)
2609
return self._get_all_reference_info().get(file_id, (None, None))
2611
def reference_parent(self, file_id, path, possible_transports=None):
2612
"""Return the parent branch for a tree-reference file_id.
2614
:param file_id: The file_id of the tree reference
2615
:param path: The path of the file_id in the tree
2616
:return: A branch associated with the file_id
2618
branch_location = self.get_reference_info(file_id)[1]
2619
if branch_location is None:
2620
return Branch.reference_parent(self, file_id, path,
2621
possible_transports)
2622
branch_location = urlutils.join(self.base, branch_location)
2623
return Branch.open(branch_location,
2624
possible_transports=possible_transports)
2626
def set_push_location(self, location):
2627
"""See Branch.set_push_location."""
2628
self._set_config_location('push_location', location)
2630
def set_bound_location(self, location):
2631
"""See Branch.set_push_location."""
2633
config = self.get_config()
2634
if location is None:
2635
if config.get_user_option('bound') != 'True':
2638
config.set_user_option('bound', 'False', warn_masked=True)
2641
self._set_config_location('bound_location', location,
2643
config.set_user_option('bound', 'True', warn_masked=True)
2646
def _get_bound_location(self, bound):
2647
"""Return the bound location in the config file.
2649
Return None if the bound parameter does not match"""
2650
config = self.get_config()
2651
config_bound = (config.get_user_option('bound') == 'True')
2652
if config_bound != bound:
2654
return self._get_config_location('bound_location', config=config)
2656
def get_bound_location(self):
2657
"""See Branch.set_push_location."""
2658
return self._get_bound_location(True)
2660
def get_old_bound_location(self):
2661
"""See Branch.get_old_bound_location"""
2662
return self._get_bound_location(False)
2664
def get_stacked_on_url(self):
2665
# you can always ask for the URL; but you might not be able to use it
2666
# if the repo can't support stacking.
2667
## self._check_stackable_repo()
2668
stacked_url = self._get_config_location('stacked_on_location')
2669
if stacked_url is None:
2670
raise errors.NotStacked(self)
2673
def set_append_revisions_only(self, enabled):
2678
self.get_config().set_user_option('append_revisions_only', value,
2681
def _get_append_revisions_only(self):
2682
value = self.get_config().get_user_option('append_revisions_only')
2683
return value == 'True'
2686
def generate_revision_history(self, revision_id, last_rev=None,
2688
"""See BzrBranch5.generate_revision_history"""
2689
history = self._lefthand_history(revision_id, last_rev, other_branch)
2690
revno = len(history)
2691
self.set_last_revision_info(revno, revision_id)
2694
def get_rev_id(self, revno, history=None):
2695
"""Find the revision id of the specified revno."""
2697
return _mod_revision.NULL_REVISION
2699
last_revno, last_revision_id = self.last_revision_info()
2700
if revno <= 0 or revno > last_revno:
2701
raise errors.NoSuchRevision(self, revno)
2703
if history is not None:
2704
return history[revno - 1]
2706
index = last_revno - revno
2707
if len(self._partial_revision_history_cache) <= index:
2708
self._extend_partial_history(stop_index=index)
2709
if len(self._partial_revision_history_cache) > index:
2710
return self._partial_revision_history_cache[index]
2712
raise errors.NoSuchRevision(self, revno)
2715
def revision_id_to_revno(self, revision_id):
2716
"""Given a revision id, return its revno"""
2717
if _mod_revision.is_null(revision_id):
2720
index = self._partial_revision_history_cache.index(revision_id)
2722
self._extend_partial_history(stop_revision=revision_id)
2723
index = len(self._partial_revision_history_cache) - 1
2724
if self._partial_revision_history_cache[index] != revision_id:
2725
raise errors.NoSuchRevision(self, revision_id)
2726
return self.revno() - index
2729
class BzrBranch7(BzrBranch8):
2730
"""A branch with support for a fallback repository."""
2732
def set_reference_info(self, file_id, tree_path, branch_location):
2733
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2735
def get_reference_info(self, file_id):
2736
Branch.get_reference_info(self, file_id)
2738
def reference_parent(self, file_id, path, possible_transports=None):
2739
return Branch.reference_parent(self, file_id, path,
2740
possible_transports)
2743
class BzrBranch6(BzrBranch7):
2744
"""See BzrBranchFormat6 for the capabilities of this branch.
2746
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2750
def get_stacked_on_url(self):
2751
raise errors.UnstackableBranchFormat(self._format, self.base)
2754
######################################################################
2755
# results of operations
2758
class _Result(object):
2760
def _show_tag_conficts(self, to_file):
2761
if not getattr(self, 'tag_conflicts', None):
2763
to_file.write('Conflicting tags:\n')
2764
for name, value1, value2 in self.tag_conflicts:
2765
to_file.write(' %s\n' % (name, ))
2768
class PullResult(_Result):
2769
"""Result of a Branch.pull operation.
2771
:ivar old_revno: Revision number before pull.
2772
:ivar new_revno: Revision number after pull.
2773
:ivar old_revid: Tip revision id before pull.
2774
:ivar new_revid: Tip revision id after pull.
2775
:ivar source_branch: Source (local) branch object. (read locked)
2776
:ivar master_branch: Master branch of the target, or the target if no
2778
:ivar local_branch: target branch if there is a Master, else None
2779
:ivar target_branch: Target/destination branch object. (write locked)
2780
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2784
# DEPRECATED: pull used to return the change in revno
2785
return self.new_revno - self.old_revno
2787
def report(self, to_file):
2789
if self.old_revid == self.new_revid:
2790
to_file.write('No revisions to pull.\n')
2792
to_file.write('Now on revision %d.\n' % self.new_revno)
2793
self._show_tag_conficts(to_file)
2796
class BranchPushResult(_Result):
2797
"""Result of a Branch.push operation.
2799
:ivar old_revno: Revision number (eg 10) of the target before push.
2800
:ivar new_revno: Revision number (eg 12) of the target after push.
2801
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2803
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2805
:ivar source_branch: Source branch object that the push was from. This is
2806
read locked, and generally is a local (and thus low latency) branch.
2807
:ivar master_branch: If target is a bound branch, the master branch of
2808
target, or target itself. Always write locked.
2809
:ivar target_branch: The direct Branch where data is being sent (write
2811
:ivar local_branch: If the target is a bound branch this will be the
2812
target, otherwise it will be None.
2816
# DEPRECATED: push used to return the change in revno
2817
return self.new_revno - self.old_revno
2819
def report(self, to_file):
2820
"""Write a human-readable description of the result."""
2821
if self.old_revid == self.new_revid:
2822
note('No new revisions to push.')
2824
note('Pushed up to revision %d.' % self.new_revno)
2825
self._show_tag_conficts(to_file)
2828
class BranchCheckResult(object):
2829
"""Results of checking branch consistency.
2834
def __init__(self, branch):
2835
self.branch = branch
2837
def report_results(self, verbose):
2838
"""Report the check results via trace.note.
2840
:param verbose: Requests more detailed display of what was checked,
2843
note('checked branch %s format %s',
2845
self.branch._format)
2848
class Converter5to6(object):
2849
"""Perform an in-place upgrade of format 5 to format 6"""
2851
def convert(self, branch):
2852
# Data for 5 and 6 can peacefully coexist.
2853
format = BzrBranchFormat6()
2854
new_branch = format.open(branch.bzrdir, _found=True)
2856
# Copy source data into target
2857
new_branch._write_last_revision_info(*branch.last_revision_info())
2858
new_branch.set_parent(branch.get_parent())
2859
new_branch.set_bound_location(branch.get_bound_location())
2860
new_branch.set_push_location(branch.get_push_location())
2862
# New branch has no tags by default
2863
new_branch.tags._set_tag_dict({})
2865
# Copying done; now update target format
2866
new_branch._transport.put_bytes('format',
2867
format.get_format_string(),
2868
mode=new_branch.bzrdir._get_file_mode())
2870
# Clean up old files
2871
new_branch._transport.delete('revision-history')
2873
branch.set_parent(None)
2874
except errors.NoSuchFile:
2876
branch.set_bound_location(None)
2879
class Converter6to7(object):
2880
"""Perform an in-place upgrade of format 6 to format 7"""
2882
def convert(self, branch):
2883
format = BzrBranchFormat7()
2884
branch._set_config_location('stacked_on_location', '')
2885
# update target format
2886
branch._transport.put_bytes('format', format.get_format_string())
2889
class Converter7to8(object):
2890
"""Perform an in-place upgrade of format 6 to format 7"""
2892
def convert(self, branch):
2893
format = BzrBranchFormat8()
2894
branch._transport.put_bytes('references', '')
2895
# update target format
2896
branch._transport.put_bytes('format', format.get_format_string())
2899
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2900
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2903
_run_with_write_locked_target will attempt to release the lock it acquires.
2905
If an exception is raised by callable, then that exception *will* be
2906
propagated, even if the unlock attempt raises its own error. Thus
2907
_run_with_write_locked_target should be preferred to simply doing::
2911
return callable(*args, **kwargs)
2916
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2917
# should share code?
2920
result = callable(*args, **kwargs)
2922
exc_info = sys.exc_info()
2926
raise exc_info[0], exc_info[1], exc_info[2]
2932
class InterBranch(InterObject):
2933
"""This class represents operations taking place between two branches.
2935
Its instances have methods like pull() and push() and contain
2936
references to the source and target repositories these operations
2937
can be carried out on.
2941
"""The available optimised InterBranch types."""
2944
def _get_branch_formats_to_test():
2945
"""Return a tuple with the Branch formats to use when testing."""
2946
raise NotImplementedError(self._get_branch_formats_to_test)
2948
def update_revisions(self, stop_revision=None, overwrite=False,
2950
"""Pull in new perfect-fit revisions.
2952
:param stop_revision: Updated until the given revision
2953
:param overwrite: Always set the branch pointer, rather than checking
2954
to see if it is a proper descendant.
2955
:param graph: A Graph object that can be used to query history
2956
information. This can be None.
2959
raise NotImplementedError(self.update_revisions)
2962
class GenericInterBranch(InterBranch):
2963
"""InterBranch implementation that uses public Branch functions.
2967
def _get_branch_formats_to_test():
2968
return BranchFormat._default_format, BranchFormat._default_format
2970
def update_revisions(self, stop_revision=None, overwrite=False,
2972
"""See InterBranch.update_revisions()."""
2973
self.source.lock_read()
2975
other_revno, other_last_revision = self.source.last_revision_info()
2976
stop_revno = None # unknown
2977
if stop_revision is None:
2978
stop_revision = other_last_revision
2979
if _mod_revision.is_null(stop_revision):
2980
# if there are no commits, we're done.
2982
stop_revno = other_revno
2984
# what's the current last revision, before we fetch [and change it
2986
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2987
# we fetch here so that we don't process data twice in the common
2988
# case of having something to pull, and so that the check for
2989
# already merged can operate on the just fetched graph, which will
2990
# be cached in memory.
2991
self.target.fetch(self.source, stop_revision)
2992
# Check to see if one is an ancestor of the other
2995
graph = self.target.repository.get_graph()
2996
if self.target._check_if_descendant_or_diverged(
2997
stop_revision, last_rev, graph, self.source):
2998
# stop_revision is a descendant of last_rev, but we aren't
2999
# overwriting, so we're done.
3001
if stop_revno is None:
3003
graph = self.target.repository.get_graph()
3004
this_revno, this_last_revision = \
3005
self.target.last_revision_info()
3006
stop_revno = graph.find_distance_to_null(stop_revision,
3007
[(other_last_revision, other_revno),
3008
(this_last_revision, this_revno)])
3009
self.target.set_last_revision_info(stop_revno, stop_revision)
3011
self.source.unlock()
3014
def is_compatible(self, source, target):
3015
# GenericBranch uses the public API, so always compatible
3019
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
