98
76
Base directory/url of the branch.
78
hooks: An instance of BranchHooks.
80
# this is really an instance variable - FIXME move it there
84
# override this to set the strategy for storing tags
86
return DisabledTags(self)
102
88
def __init__(self, *ignored, **ignored_too):
103
raise NotImplementedError('The Branch class is abstract')
106
def open_downlevel(base):
107
"""Open a branch which may be of an old format.
109
Only local branches are supported."""
110
return BzrBranch(get_transport(base), relax_version_check=True)
114
"""Open an existing branch, rooted at 'base' (url)"""
115
t = get_transport(base)
116
mutter("trying to open %r with transport %r", base, t)
120
def open_containing(url):
89
self.tags = self._make_tags()
90
self._revision_history_cache = None
91
self._revision_id_to_revno_cache = None
92
self._last_revision_info_cache = None
96
"""Called by init to allow simpler extension of the base class."""
99
"""Break a lock if one is present from another instance.
101
Uses the ui factory to ask for confirmation if the lock may be from
104
This will probe the repository for its lock as well.
106
self.control_files.break_lock()
107
self.repository.break_lock()
108
master = self.get_master_branch()
109
if master is not None:
113
def open(base, _unsupported=False, possible_transports=None):
114
"""Open the branch rooted at base.
116
For instance, if the branch is at URL/.bzr/branch,
117
Branch.open(URL) -> a Branch instance.
119
control = bzrdir.BzrDir.open(base, _unsupported,
120
possible_transports=possible_transports)
121
return control.open_branch(_unsupported)
124
def open_from_transport(transport, _unsupported=False):
125
"""Open the branch rooted at transport"""
126
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
127
return control.open_branch(_unsupported)
130
def open_containing(url, possible_transports=None):
121
131
"""Open an existing branch which contains url.
123
133
This probes for a branch at url, and searches upwards from there.
125
135
Basically we keep looking up until we find the control directory or
126
136
run into the root. If there isn't one, raises NotBranchError.
137
If there is one and it is either an unrecognised format or an unsupported
138
format, UnknownFormatError or UnsupportedFormatError are raised.
127
139
If there is one, it is returned, along with the unused portion of url.
129
t = get_transport(url)
132
return BzrBranch(t), t.relpath(url)
133
except NotBranchError, e:
134
mutter('not a branch in: %r %s', t.base, e)
135
new_t = t.clone('..')
136
if new_t.base == t.base:
137
# reached the root, whatever that may be
138
raise NotBranchError(path=url)
142
def initialize(base):
143
"""Create a new branch, rooted at 'base' (url)"""
144
t = get_transport(unicode(base))
145
return BzrBranch(t, init=True)
147
def setup_caching(self, cache_root):
148
"""Subclasses that care about caching should override this, and set
149
up cached stores located under cache_root.
151
self.cache_root = cache_root
141
control, relpath = bzrdir.BzrDir.open_containing(url,
143
return control.open_branch(), relpath
145
def get_config(self):
146
return BranchConfig(self)
153
148
def _get_nick(self):
154
cfg = self.tree_config()
155
return cfg.get_option(u"nickname", default=self.base.split('/')[-1])
149
return self.get_config().get_nickname()
157
151
def _set_nick(self, nick):
158
cfg = self.tree_config()
159
cfg.set_option(nick, "nickname")
160
assert cfg.get_option("nickname") == nick
152
self.get_config().set_user_option('nickname', nick, warn_masked=True)
162
154
nick = property(_get_nick, _set_nick)
164
def push_stores(self, branch_to):
165
"""Copy the content of this branches store to branch_to."""
166
raise NotImplementedError('push_stores is abstract')
157
raise NotImplementedError(self.is_locked)
168
159
def lock_write(self):
169
raise NotImplementedError('lock_write is abstract')
160
raise NotImplementedError(self.lock_write)
171
162
def lock_read(self):
172
raise NotImplementedError('lock_read is abstract')
163
raise NotImplementedError(self.lock_read)
174
165
def unlock(self):
175
raise NotImplementedError('unlock is abstract')
177
def abspath(self, name):
178
"""Return absolute filename for something in the branch
180
XXX: Robert Collins 20051017 what is this used for? why is it a branch
181
method and not a tree method.
183
raise NotImplementedError('abspath is abstract')
185
def get_root_id(self):
186
"""Return the id of this branches root"""
187
raise NotImplementedError('get_root_id is abstract')
166
raise NotImplementedError(self.unlock)
168
def peek_lock_mode(self):
169
"""Return lock mode for the Branch: 'r', 'w' or None"""
170
raise NotImplementedError(self.peek_lock_mode)
172
def get_physical_lock_status(self):
173
raise NotImplementedError(self.get_physical_lock_status)
176
def get_revision_id_to_revno_map(self):
177
"""Return the revision_id => dotted revno map.
179
This will be regenerated on demand, but will be cached.
181
:return: A dictionary mapping revision_id => dotted revno.
182
This dictionary should not be modified by the caller.
184
if self._revision_id_to_revno_cache is not None:
185
mapping = self._revision_id_to_revno_cache
187
mapping = self._gen_revno_map()
188
self._cache_revision_id_to_revno(mapping)
189
# TODO: jam 20070417 Since this is being cached, should we be returning
191
# I would rather not, and instead just declare that users should not
192
# modify the return value.
195
def _gen_revno_map(self):
196
"""Create a new mapping from revision ids to dotted revnos.
198
Dotted revnos are generated based on the current tip in the revision
200
This is the worker function for get_revision_id_to_revno_map, which
201
just caches the return value.
203
:return: A dictionary mapping revision_id => dotted revno.
205
last_revision = self.last_revision()
206
revision_graph = repository._old_get_graph(self.repository,
208
merge_sorted_revisions = tsort.merge_sort(
213
revision_id_to_revno = dict((rev_id, revno)
214
for seq_num, rev_id, depth, revno, end_of_merge
215
in merge_sorted_revisions)
216
return revision_id_to_revno
218
def leave_lock_in_place(self):
219
"""Tell this branch object not to release the physical lock when this
222
If lock_write doesn't return a token, then this method is not supported.
224
self.control_files.leave_in_place()
226
def dont_leave_lock_in_place(self):
227
"""Tell this branch object to release the physical lock when this
228
object is unlocked, even if it didn't originally acquire it.
230
If lock_write doesn't return a token, then this method is not supported.
232
self.control_files.dont_leave_in_place()
234
def bind(self, other):
235
"""Bind the local branch the other branch.
237
:param other: The branch to bind to
240
raise errors.UpgradeRequired(self.base)
243
def fetch(self, from_branch, last_revision=None, pb=None):
244
"""Copy revisions from from_branch into this branch.
246
:param from_branch: Where to copy from.
247
:param last_revision: What revision to stop at (None for at the end
249
:param pb: An optional progress bar to use.
251
Returns the copied revision count and the failed revisions in a tuple:
254
if self.base == from_branch.base:
257
nested_pb = ui.ui_factory.nested_progress_bar()
262
from_branch.lock_read()
264
if last_revision is None:
265
pb.update('get source history')
266
last_revision = from_branch.last_revision()
267
last_revision = _mod_revision.ensure_null(last_revision)
268
return self.repository.fetch(from_branch.repository,
269
revision_id=last_revision,
272
if nested_pb is not None:
276
def get_bound_location(self):
277
"""Return the URL of the branch we are bound to.
279
Older format branches cannot bind, please be sure to use a metadir
284
def get_old_bound_location(self):
285
"""Return the URL of the branch we used to be bound to
287
raise errors.UpgradeRequired(self.base)
289
def get_commit_builder(self, parents, config=None, timestamp=None,
290
timezone=None, committer=None, revprops=None,
292
"""Obtain a CommitBuilder for this branch.
294
:param parents: Revision ids of the parents of the new revision.
295
:param config: Optional configuration to use.
296
:param timestamp: Optional timestamp recorded for commit.
297
:param timezone: Optional timezone for timestamp.
298
:param committer: Optional committer to set for commit.
299
:param revprops: Optional dictionary of revision properties.
300
:param revision_id: Optional revision id.
304
config = self.get_config()
306
return self.repository.get_commit_builder(self, parents, config,
307
timestamp, timezone, committer, revprops, revision_id)
309
def get_master_branch(self, possible_transports=None):
310
"""Return the branch we are bound to.
312
:return: Either a Branch, or None
316
def get_revision_delta(self, revno):
317
"""Return the delta for one revision.
319
The delta is relative to its mainline predecessor, or the
320
empty tree for revision 1.
322
rh = self.revision_history()
323
if not (1 <= revno <= len(rh)):
324
raise errors.InvalidRevisionNumber(revno)
325
return self.repository.get_revision_delta(rh[revno-1])
327
def get_stacked_on_url(self):
328
"""Get the URL this branch is stacked against.
330
:raises NotStacked: If the branch is not stacked.
331
:raises UnstackableBranchFormat: If the branch does not support
334
raise NotImplementedError(self.get_stacked_on_url)
189
336
def print_file(self, file, revision_id):
190
337
"""Print `file` to stdout."""
191
raise NotImplementedError('print_file is abstract')
193
def append_revision(self, *revision_ids):
194
raise NotImplementedError('append_revision is abstract')
338
raise NotImplementedError(self.print_file)
196
340
def set_revision_history(self, rev_history):
197
raise NotImplementedError('set_revision_history is abstract')
341
raise NotImplementedError(self.set_revision_history)
343
def set_stacked_on_url(self, url):
344
"""Set the URL this branch is stacked against.
346
:raises UnstackableBranchFormat: If the branch does not support
348
:raises UnstackableRepositoryFormat: If the repository does not support
351
raise NotImplementedError(self.set_stacked_on_url)
353
def _cache_revision_history(self, rev_history):
354
"""Set the cached revision history to rev_history.
356
The revision_history method will use this cache to avoid regenerating
357
the revision history.
359
This API is semi-public; it only for use by subclasses, all other code
360
should consider it to be private.
362
self._revision_history_cache = rev_history
364
def _cache_revision_id_to_revno(self, revision_id_to_revno):
365
"""Set the cached revision_id => revno map to revision_id_to_revno.
367
This API is semi-public; it only for use by subclasses, all other code
368
should consider it to be private.
370
self._revision_id_to_revno_cache = revision_id_to_revno
372
def _clear_cached_state(self):
373
"""Clear any cached data on this branch, e.g. cached revision history.
375
This means the next call to revision_history will need to call
376
_gen_revision_history.
378
This API is semi-public; it only for use by subclasses, all other code
379
should consider it to be private.
381
self._revision_history_cache = None
382
self._revision_id_to_revno_cache = None
383
self._last_revision_info_cache = None
385
def _gen_revision_history(self):
386
"""Return sequence of revision hashes on to this branch.
388
Unlike revision_history, this method always regenerates or rereads the
389
revision history, i.e. it does not cache the result, so repeated calls
392
Concrete subclasses should override this instead of revision_history so
393
that subclasses do not need to deal with caching logic.
395
This API is semi-public; it only for use by subclasses, all other code
396
should consider it to be private.
398
raise NotImplementedError(self._gen_revision_history)
199
401
def revision_history(self):
200
"""Return sequence of revision hashes on to this branch."""
201
raise NotImplementedError('revision_history is abstract')
402
"""Return sequence of revision ids on this branch.
404
This method will cache the revision history for as long as it is safe to
407
if 'evil' in debug.debug_flags:
408
mutter_callsite(3, "revision_history scales with history.")
409
if self._revision_history_cache is not None:
410
history = self._revision_history_cache
412
history = self._gen_revision_history()
413
self._cache_revision_history(history)
204
417
"""Return current revision number for this branch.
360
663
Zero (the NULL revision) is considered invalid
362
665
if revno < 1 or revno > self.revno():
363
raise InvalidRevisionNumber(revno)
365
def sign_revision(self, revision_id, gpg_strategy):
366
raise NotImplementedError('sign_revision is abstract')
368
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
369
raise NotImplementedError('store_revision_signature is abstract')
371
def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
372
"""Copy this branch into the existing directory to_location.
374
Returns the newly created branch object.
377
If not None, only revisions up to this point will be copied.
378
The head of the new branch will be that revision. Must be a
381
to_location -- The destination directory; must either exist and be
382
empty, or not exist, in which case it is created.
385
A local branch to copy revisions from, related to this branch.
386
This is used when branching from a remote (slow) branch, and we have
387
a local branch that might contain some relevant revisions.
390
Branch type of destination branch
392
assert isinstance(to_location, basestring)
393
if not bzrlib.osutils.lexists(to_location):
394
os.mkdir(to_location)
395
if to_branch_type is None:
396
to_branch_type = BzrBranch
397
br_to = to_branch_type.initialize(to_location)
398
mutter("copy branch from %s to %s", self, br_to)
399
if basis_branch is not None:
400
basis_branch.push_stores(br_to)
401
br_to.working_tree().set_root_id(self.get_root_id())
403
revision = self.last_revision()
404
br_to.update_revisions(self, stop_revision=revision)
405
br_to.set_parent(self.base)
406
# circular import protection
407
from bzrlib.merge import build_working_dir
408
build_working_dir(to_location)
666
raise errors.InvalidRevisionNumber(revno)
669
def clone(self, to_bzrdir, revision_id=None):
670
"""Clone this branch into to_bzrdir preserving all semantic values.
672
revision_id: if not None, the revision history in the new branch will
673
be truncated to end with revision_id.
675
result = self._format.initialize(to_bzrdir)
676
self.copy_content_into(result, revision_id=revision_id)
680
def sprout(self, to_bzrdir, revision_id=None):
681
"""Create a new line of development from the branch, into to_bzrdir.
683
to_bzrdir controls the branch format.
685
revision_id: if not None, the revision history in the new branch will
686
be truncated to end with revision_id.
688
result = to_bzrdir.create_branch()
689
self.copy_content_into(result, revision_id=revision_id)
690
result.set_parent(self.bzrdir.root_transport.base)
693
def _synchronize_history(self, destination, revision_id):
694
"""Synchronize last revision and revision history between branches.
696
This version is most efficient when the destination is also a
697
BzrBranch5, but works for BzrBranch6 as long as the revision
698
history is the true lefthand parent history, and all of the revisions
699
are in the destination's repository. If not, set_revision_history
702
:param destination: The branch to copy the history into
703
:param revision_id: The revision-id to truncate history at. May
704
be None to copy complete history.
706
if revision_id == _mod_revision.NULL_REVISION:
709
new_history = self.revision_history()
710
if revision_id is not None and new_history != []:
712
new_history = new_history[:new_history.index(revision_id) + 1]
714
rev = self.repository.get_revision(revision_id)
715
new_history = rev.get_history(self.repository)[1:]
716
destination.set_revision_history(new_history)
719
def copy_content_into(self, destination, revision_id=None):
720
"""Copy the content of self into destination.
722
revision_id: if not None, the revision history in the new branch will
723
be truncated to end with revision_id.
725
self._synchronize_history(destination, revision_id)
727
parent = self.get_parent()
728
except errors.InaccessibleParent, e:
729
mutter('parent was not accessible to copy: %s', e)
732
destination.set_parent(parent)
733
self.tags.merge_to(destination.tags)
737
"""Check consistency of the branch.
739
In particular this checks that revisions given in the revision-history
740
do actually match up in the revision graph, and that they're all
741
present in the repository.
743
Callers will typically also want to check the repository.
745
:return: A BranchCheckResult.
747
mainline_parent_id = None
748
last_revno, last_revision_id = self.last_revision_info()
749
real_rev_history = list(self.repository.iter_reverse_revision_history(
751
real_rev_history.reverse()
752
if len(real_rev_history) != last_revno:
753
raise errors.BzrCheckError('revno does not match len(mainline)'
754
' %s != %s' % (last_revno, len(real_rev_history)))
755
# TODO: We should probably also check that real_rev_history actually
756
# matches self.revision_history()
757
for revision_id in real_rev_history:
759
revision = self.repository.get_revision(revision_id)
760
except errors.NoSuchRevision, e:
761
raise errors.BzrCheckError("mainline revision {%s} not in repository"
763
# In general the first entry on the revision history has no parents.
764
# But it's not illegal for it to have parents listed; this can happen
765
# in imports from Arch when the parents weren't reachable.
766
if mainline_parent_id is not None:
767
if mainline_parent_id not in revision.parent_ids:
768
raise errors.BzrCheckError("previous revision {%s} not listed among "
770
% (mainline_parent_id, revision_id))
771
mainline_parent_id = revision_id
772
return BranchCheckResult(self)
774
def _get_checkout_format(self):
775
"""Return the most suitable metadir for a checkout of this branch.
776
Weaves are used if this branch's repository uses weaves.
778
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
779
from bzrlib.repofmt import weaverepo
780
format = bzrdir.BzrDirMetaFormat1()
781
format.repository_format = weaverepo.RepositoryFormat7()
783
format = self.repository.bzrdir.checkout_metadir()
784
format.set_branch_format(self._format)
787
def create_checkout(self, to_location, revision_id=None,
788
lightweight=False, accelerator_tree=None,
790
"""Create a checkout of a branch.
792
:param to_location: The url to produce the checkout at
793
:param revision_id: The revision to check out
794
:param lightweight: If True, produce a lightweight checkout, otherwise,
795
produce a bound branch (heavyweight checkout)
796
:param accelerator_tree: A tree which can be used for retrieving file
797
contents more quickly than the revision tree, i.e. a workingtree.
798
The revision tree will be used for cases where accelerator_tree's
799
content is different.
800
:param hardlink: If true, hard-link files from accelerator_tree,
802
:return: The tree of the created checkout
804
t = transport.get_transport(to_location)
807
format = self._get_checkout_format()
808
checkout = format.initialize_on_transport(t)
809
from_branch = BranchReferenceFormat().initialize(checkout, self)
811
format = self._get_checkout_format()
812
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
813
to_location, force_new_tree=False, format=format)
814
checkout = checkout_branch.bzrdir
815
checkout_branch.bind(self)
816
# pull up to the specified revision_id to set the initial
817
# branch tip correctly, and seed it with history.
818
checkout_branch.pull(self, stop_revision=revision_id)
820
tree = checkout.create_workingtree(revision_id,
821
from_branch=from_branch,
822
accelerator_tree=accelerator_tree,
824
basis_tree = tree.basis_tree()
825
basis_tree.lock_read()
827
for path, file_id in basis_tree.iter_references():
828
reference_parent = self.reference_parent(file_id, path)
829
reference_parent.create_checkout(tree.abspath(path),
830
basis_tree.get_reference_revision(file_id, path),
837
def reconcile(self, thorough=True):
838
"""Make sure the data stored in this branch is consistent."""
839
from bzrlib.reconcile import BranchReconciler
840
reconciler = BranchReconciler(self, thorough=thorough)
841
reconciler.reconcile()
844
def reference_parent(self, file_id, path):
845
"""Return the parent branch for a tree-reference file_id
846
:param file_id: The file_id of the tree reference
847
:param path: The path of the file_id in the tree
848
:return: A branch associated with the file_id
850
# FIXME should provide multiple branches, based on config
851
return Branch.open(self.bzrdir.root_transport.clone(path).base)
853
def supports_tags(self):
854
return self._format.supports_tags()
856
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
858
"""Ensure that revision_b is a descendant of revision_a.
860
This is a helper function for update_revisions.
862
:raises: DivergedBranches if revision_b has diverged from revision_a.
863
:returns: True if revision_b is a descendant of revision_a.
865
relation = self._revision_relations(revision_a, revision_b, graph)
866
if relation == 'b_descends_from_a':
868
elif relation == 'diverged':
869
raise errors.DivergedBranches(self, other_branch)
870
elif relation == 'a_descends_from_b':
873
raise AssertionError("invalid relation: %r" % (relation,))
875
def _revision_relations(self, revision_a, revision_b, graph):
876
"""Determine the relationship between two revisions.
878
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
880
heads = graph.heads([revision_a, revision_b])
881
if heads == set([revision_b]):
882
return 'b_descends_from_a'
883
elif heads == set([revision_a, revision_b]):
884
# These branches have diverged
886
elif heads == set([revision_a]):
887
return 'a_descends_from_b'
889
raise AssertionError("invalid heads: %r" % (heads,))
892
class BranchFormat(object):
893
"""An encapsulation of the initialization and open routines for a format.
895
Formats provide three things:
896
* An initialization routine,
900
Formats are placed in an dict by their format string for reference
901
during branch opening. Its not required that these be instances, they
902
can be classes themselves with class methods - it simply depends on
903
whether state is needed for a given format or not.
905
Once a format is deprecated, just deprecate the initialize and open
906
methods on the format class. Do not deprecate the object, as the
907
object will be created every time regardless.
910
_default_format = None
911
"""The default format used for new branches."""
914
"""The known formats."""
916
def __eq__(self, other):
917
return self.__class__ is other.__class__
919
def __ne__(self, other):
920
return not (self == other)
923
def find_format(klass, a_bzrdir):
924
"""Return the format for the branch object in a_bzrdir."""
926
transport = a_bzrdir.get_branch_transport(None)
927
format_string = transport.get("format").read()
928
return klass._formats[format_string]
929
except errors.NoSuchFile:
930
raise errors.NotBranchError(path=transport.base)
932
raise errors.UnknownFormatError(format=format_string, kind='branch')
935
def get_default_format(klass):
936
"""Return the current default format."""
937
return klass._default_format
939
def get_reference(self, a_bzrdir):
940
"""Get the target reference of the branch in a_bzrdir.
942
format probing must have been completed before calling
943
this method - it is assumed that the format of the branch
944
in a_bzrdir is correct.
946
:param a_bzrdir: The bzrdir to get the branch data from.
947
:return: None if the branch is not a reference branch.
952
def set_reference(self, a_bzrdir, to_branch):
953
"""Set the target reference of the branch in a_bzrdir.
955
format probing must have been completed before calling
956
this method - it is assumed that the format of the branch
957
in a_bzrdir is correct.
959
:param a_bzrdir: The bzrdir to set the branch reference for.
960
:param to_branch: branch that the checkout is to reference
962
raise NotImplementedError(self.set_reference)
964
def get_format_string(self):
965
"""Return the ASCII format string that identifies this format."""
966
raise NotImplementedError(self.get_format_string)
968
def get_format_description(self):
969
"""Return the short format description for this format."""
970
raise NotImplementedError(self.get_format_description)
972
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
974
"""Initialize a branch in a bzrdir, with specified files
976
:param a_bzrdir: The bzrdir to initialize the branch in
977
:param utf8_files: The files to create as a list of
978
(filename, content) tuples
979
:param set_format: If True, set the format with
980
self.get_format_string. (BzrBranch4 has its format set
982
:return: a branch in this format
984
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
985
branch_transport = a_bzrdir.get_branch_transport(self)
987
'metadir': ('lock', lockdir.LockDir),
988
'branch4': ('branch-lock', lockable_files.TransportLock),
990
lock_name, lock_class = lock_map[lock_type]
991
control_files = lockable_files.LockableFiles(branch_transport,
992
lock_name, lock_class)
993
control_files.create_lock()
994
control_files.lock_write()
996
utf8_files += [('format', self.get_format_string())]
998
for (filename, content) in utf8_files:
999
branch_transport.put_bytes(
1001
mode=a_bzrdir._get_file_mode())
1003
control_files.unlock()
1004
return self.open(a_bzrdir, _found=True)
1006
def initialize(self, a_bzrdir):
1007
"""Create a branch of this format in a_bzrdir."""
1008
raise NotImplementedError(self.initialize)
1010
def is_supported(self):
1011
"""Is this format supported?
1013
Supported formats can be initialized and opened.
1014
Unsupported formats may not support initialization or committing or
1015
some other features depending on the reason for not being supported.
1019
def open(self, a_bzrdir, _found=False):
1020
"""Return the branch object for a_bzrdir
1022
_found is a private parameter, do not use it. It is used to indicate
1023
if format probing has already be done.
1025
raise NotImplementedError(self.open)
1028
def register_format(klass, format):
1029
klass._formats[format.get_format_string()] = format
1032
def set_default_format(klass, format):
1033
klass._default_format = format
1035
def supports_stacking(self):
1036
"""True if this format records a stacked-on branch."""
1040
def unregister_format(klass, format):
1041
del klass._formats[format.get_format_string()]
1044
return self.get_format_string().rstrip()
1046
def supports_tags(self):
1047
"""True if this format supports tags stored in the branch"""
1048
return False # by default
1051
class BranchHooks(Hooks):
1052
"""A dictionary mapping hook name to a list of callables for branch hooks.
1054
e.g. ['set_rh'] Is the list of items to be called when the
1055
set_revision_history function is invoked.
1059
"""Create the default hooks.
1061
These are all empty initially, because by default nothing should get
1064
Hooks.__init__(self)
1065
# Introduced in 0.15:
1066
# invoked whenever the revision history has been set
1067
# with set_revision_history. The api signature is
1068
# (branch, revision_history), and the branch will
1071
# invoked after a push operation completes.
1072
# the api signature is
1074
# containing the members
1075
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1076
# where local is the local target branch or None, master is the target
1077
# master branch, and the rest should be self explanatory. The source
1078
# is read locked and the target branches write locked. Source will
1079
# be the local low-latency branch.
1080
self['post_push'] = []
1081
# invoked after a pull operation completes.
1082
# the api signature is
1084
# containing the members
1085
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1086
# where local is the local branch or None, master is the target
1087
# master branch, and the rest should be self explanatory. The source
1088
# is read locked and the target branches write locked. The local
1089
# branch is the low-latency branch.
1090
self['post_pull'] = []
1091
# invoked before a commit operation takes place.
1092
# the api signature is
1093
# (local, master, old_revno, old_revid, future_revno, future_revid,
1094
# tree_delta, future_tree).
1095
# old_revid is NULL_REVISION for the first commit to a branch
1096
# tree_delta is a TreeDelta object describing changes from the basis
1097
# revision, hooks MUST NOT modify this delta
1098
# future_tree is an in-memory tree obtained from
1099
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1100
self['pre_commit'] = []
1101
# invoked after a commit operation completes.
1102
# the api signature is
1103
# (local, master, old_revno, old_revid, new_revno, new_revid)
1104
# old_revid is NULL_REVISION for the first commit to a branch.
1105
self['post_commit'] = []
1106
# invoked after a uncommit operation completes.
1107
# the api signature is
1108
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1109
# local is the local branch or None, master is the target branch,
1110
# and an empty branch recieves new_revno of 0, new_revid of None.
1111
self['post_uncommit'] = []
1113
# Invoked before the tip of a branch changes.
1114
# the api signature is
1115
# (params) where params is a ChangeBranchTipParams with the members
1116
# (branch, old_revno, new_revno, old_revid, new_revid)
1117
self['pre_change_branch_tip'] = []
1119
# Invoked after the tip of a branch changes.
1120
# the api signature is
1121
# (params) where params is a ChangeBranchTipParams with the members
1122
# (branch, old_revno, new_revno, old_revid, new_revid)
1123
self['post_change_branch_tip'] = []
1126
# install the default hooks into the Branch class.
1127
Branch.hooks = BranchHooks()
1130
class ChangeBranchTipParams(object):
1131
"""Object holding parameters passed to *_change_branch_tip hooks.
1133
There are 5 fields that hooks may wish to access:
1135
:ivar branch: the branch being changed
1136
:ivar old_revno: revision number before the change
1137
:ivar new_revno: revision number after the change
1138
:ivar old_revid: revision id before the change
1139
:ivar new_revid: revision id after the change
1141
The revid fields are strings. The revno fields are integers.
1144
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1145
"""Create a group of ChangeBranchTip parameters.
1147
:param branch: The branch being changed.
1148
:param old_revno: Revision number before the change.
1149
:param new_revno: Revision number after the change.
1150
:param old_revid: Tip revision id before the change.
1151
:param new_revid: Tip revision id after the change.
1153
self.branch = branch
1154
self.old_revno = old_revno
1155
self.new_revno = new_revno
1156
self.old_revid = old_revid
1157
self.new_revid = new_revid
1159
def __eq__(self, other):
1160
return self.__dict__ == other.__dict__
1163
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1164
self.__class__.__name__, self.branch,
1165
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1168
class BzrBranchFormat4(BranchFormat):
1169
"""Bzr branch format 4.
1172
- a revision-history file.
1173
- a branch-lock lock file [ to be shared with the bzrdir ]
1176
def get_format_description(self):
1177
"""See BranchFormat.get_format_description()."""
1178
return "Branch format 4"
1180
def initialize(self, a_bzrdir):
1181
"""Create a branch of this format in a_bzrdir."""
1182
utf8_files = [('revision-history', ''),
1183
('branch-name', ''),
1185
return self._initialize_helper(a_bzrdir, utf8_files,
1186
lock_type='branch4', set_format=False)
1189
super(BzrBranchFormat4, self).__init__()
1190
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1192
def open(self, a_bzrdir, _found=False):
1193
"""Return the branch object for a_bzrdir
1195
_found is a private parameter, do not use it. It is used to indicate
1196
if format probing has already be done.
1199
# we are being called directly and must probe.
1200
raise NotImplementedError
1201
return BzrBranch(_format=self,
1202
_control_files=a_bzrdir._control_files,
1204
_repository=a_bzrdir.open_repository())
1207
return "Bazaar-NG branch format 4"
1210
class BranchFormatMetadir(BranchFormat):
1211
"""Common logic for meta-dir based branch formats."""
1213
def _branch_class(self):
1214
"""What class to instantiate on open calls."""
1215
raise NotImplementedError(self._branch_class)
1217
def open(self, a_bzrdir, _found=False):
1218
"""Return the branch object for a_bzrdir.
1220
_found is a private parameter, do not use it. It is used to indicate
1221
if format probing has already be done.
1224
format = BranchFormat.find_format(a_bzrdir)
1225
if format.__class__ != self.__class__:
1226
raise AssertionError("wrong format %r found for %r" %
1229
transport = a_bzrdir.get_branch_transport(None)
1230
control_files = lockable_files.LockableFiles(transport, 'lock',
1232
return self._branch_class()(_format=self,
1233
_control_files=control_files,
1235
_repository=a_bzrdir.find_repository())
1236
except errors.NoSuchFile:
1237
raise errors.NotBranchError(path=transport.base)
1240
super(BranchFormatMetadir, self).__init__()
1241
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1243
def supports_tags(self):
1247
class BzrBranchFormat5(BranchFormatMetadir):
1248
"""Bzr branch format 5.
1251
- a revision-history file.
1253
- a lock dir guarding the branch itself
1254
- all of this stored in a branch/ subdirectory
1255
- works with shared repositories.
1257
This format is new in bzr 0.8.
1260
def _branch_class(self):
1263
def get_format_string(self):
1264
"""See BranchFormat.get_format_string()."""
1265
return "Bazaar-NG branch format 5\n"
1267
def get_format_description(self):
1268
"""See BranchFormat.get_format_description()."""
1269
return "Branch format 5"
1271
def initialize(self, a_bzrdir):
1272
"""Create a branch of this format in a_bzrdir."""
1273
utf8_files = [('revision-history', ''),
1274
('branch-name', ''),
1276
return self._initialize_helper(a_bzrdir, utf8_files)
1278
def supports_tags(self):
1282
class BzrBranchFormat6(BranchFormatMetadir):
1283
"""Branch format with last-revision and tags.
1285
Unlike previous formats, this has no explicit revision history. Instead,
1286
this just stores the last-revision, and the left-hand history leading
1287
up to there is the history.
1289
This format was introduced in bzr 0.15
1290
and became the default in 0.91.
1293
def _branch_class(self):
1296
def get_format_string(self):
1297
"""See BranchFormat.get_format_string()."""
1298
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1300
def get_format_description(self):
1301
"""See BranchFormat.get_format_description()."""
1302
return "Branch format 6"
1304
def initialize(self, a_bzrdir):
1305
"""Create a branch of this format in a_bzrdir."""
1306
utf8_files = [('last-revision', '0 null:\n'),
1307
('branch.conf', ''),
1310
return self._initialize_helper(a_bzrdir, utf8_files)
1313
class BzrBranchFormat7(BranchFormatMetadir):
1314
"""Branch format with last-revision, tags, and a stacked location pointer.
1316
The stacked location pointer is passed down to the repository and requires
1317
a repository format with supports_external_lookups = True.
1319
This format was introduced in bzr 1.6.
1322
def _branch_class(self):
1325
def get_format_string(self):
1326
"""See BranchFormat.get_format_string()."""
1327
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1329
def get_format_description(self):
1330
"""See BranchFormat.get_format_description()."""
1331
return "Branch format 7"
1333
def initialize(self, a_bzrdir):
1334
"""Create a branch of this format in a_bzrdir."""
1335
utf8_files = [('last-revision', '0 null:\n'),
1336
('branch.conf', ''),
1339
return self._initialize_helper(a_bzrdir, utf8_files)
1342
super(BzrBranchFormat7, self).__init__()
1343
self._matchingbzrdir.repository_format = \
1344
RepositoryFormatPackDevelopment1Subtree()
1346
def supports_stacking(self):
1350
class BranchReferenceFormat(BranchFormat):
1351
"""Bzr branch reference format.
1353
Branch references are used in implementing checkouts, they
1354
act as an alias to the real branch which is at some other url.
1361
def get_format_string(self):
1362
"""See BranchFormat.get_format_string()."""
1363
return "Bazaar-NG Branch Reference Format 1\n"
1365
def get_format_description(self):
1366
"""See BranchFormat.get_format_description()."""
1367
return "Checkout reference format 1"
1369
def get_reference(self, a_bzrdir):
1370
"""See BranchFormat.get_reference()."""
1371
transport = a_bzrdir.get_branch_transport(None)
1372
return transport.get('location').read()
1374
def set_reference(self, a_bzrdir, to_branch):
1375
"""See BranchFormat.set_reference()."""
1376
transport = a_bzrdir.get_branch_transport(None)
1377
location = transport.put_bytes('location', to_branch.base)
1379
def initialize(self, a_bzrdir, target_branch=None):
1380
"""Create a branch of this format in a_bzrdir."""
1381
if target_branch is None:
1382
# this format does not implement branch itself, thus the implicit
1383
# creation contract must see it as uninitializable
1384
raise errors.UninitializableFormat(self)
1385
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1386
branch_transport = a_bzrdir.get_branch_transport(self)
1387
branch_transport.put_bytes('location',
1388
target_branch.bzrdir.root_transport.base)
1389
branch_transport.put_bytes('format', self.get_format_string())
1391
a_bzrdir, _found=True,
1392
possible_transports=[target_branch.bzrdir.root_transport])
1395
super(BranchReferenceFormat, self).__init__()
1396
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1398
def _make_reference_clone_function(format, a_branch):
1399
"""Create a clone() routine for a branch dynamically."""
1400
def clone(to_bzrdir, revision_id=None):
1401
"""See Branch.clone()."""
1402
return format.initialize(to_bzrdir, a_branch)
1403
# cannot obey revision_id limits when cloning a reference ...
1404
# FIXME RBC 20060210 either nuke revision_id for clone, or
1405
# emit some sort of warning/error to the caller ?!
1408
def open(self, a_bzrdir, _found=False, location=None,
1409
possible_transports=None):
1410
"""Return the branch that the branch reference in a_bzrdir points at.
1412
_found is a private parameter, do not use it. It is used to indicate
1413
if format probing has already be done.
1416
format = BranchFormat.find_format(a_bzrdir)
1417
if format.__class__ != self.__class__:
1418
raise AssertionError("wrong format %r found for %r" %
1420
if location is None:
1421
location = self.get_reference(a_bzrdir)
1422
real_bzrdir = bzrdir.BzrDir.open(
1423
location, possible_transports=possible_transports)
1424
result = real_bzrdir.open_branch()
1425
# this changes the behaviour of result.clone to create a new reference
1426
# rather than a copy of the content of the branch.
1427
# I did not use a proxy object because that needs much more extensive
1428
# testing, and we are only changing one behaviour at the moment.
1429
# If we decide to alter more behaviours - i.e. the implicit nickname
1430
# then this should be refactored to introduce a tested proxy branch
1431
# and a subclass of that for use in overriding clone() and ....
1433
result.clone = self._make_reference_clone_function(result)
1437
# formats which have no format string are not discoverable
1438
# and not independently creatable, so are not registered.
1439
__format5 = BzrBranchFormat5()
1440
__format6 = BzrBranchFormat6()
1441
__format7 = BzrBranchFormat7()
1442
BranchFormat.register_format(__format5)
1443
BranchFormat.register_format(BranchReferenceFormat())
1444
BranchFormat.register_format(__format6)
1445
BranchFormat.register_format(__format7)
1446
BranchFormat.set_default_format(__format6)
1447
_legacy_formats = [BzrBranchFormat4(),
412
1450
class BzrBranch(Branch):
413
1451
"""A branch stored in the actual filesystem.
416
1454
really matter if it's on an nfs/smb/afs/coda/... share, as long as
417
1455
it's writable, and can be accessed via the normal filesystem API.
1457
:ivar _transport: Transport for file operations on this branch's
1458
control files, typically pointing to the .bzr/branch directory.
1459
:ivar repository: Repository for this branch.
1460
:ivar base: The url of the base directory for this branch; the one
1461
containing the .bzr directory.
420
# We actually expect this class to be somewhat short-lived; part of its
421
# purpose is to try to isolate what bits of the branch logic are tied to
422
# filesystem access, so that in a later step, we can extricate them to
423
# a separarte ("storage") class.
424
_inventory_weave = None
426
# Map some sort of prefix into a namespace
427
# stuff like "revno:10", "revid:", etc.
428
# This should match a prefix with a function which accepts
429
REVISION_NAMESPACES = {}
431
def push_stores(self, branch_to):
432
"""See Branch.push_stores."""
433
if (self._branch_format != branch_to._branch_format
434
or self._branch_format != 4):
435
from bzrlib.fetch import greedy_fetch
436
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
437
self, self._branch_format, branch_to, branch_to._branch_format)
438
greedy_fetch(to_branch=branch_to, from_branch=self,
439
revision=self.last_revision())
442
store_pairs = ((self.text_store, branch_to.text_store),
443
(self.inventory_store, branch_to.inventory_store),
444
(self.revision_store, branch_to.revision_store))
446
for from_store, to_store in store_pairs:
447
copy_all(from_store, to_store)
448
except UnlistableStore:
449
raise UnlistableBranch(from_store)
451
def __init__(self, transport, init=False,
452
relax_version_check=False):
453
"""Create new branch object at a particular location.
455
transport -- A Transport object, defining how to access files.
457
init -- If True, create new control files in a previously
458
unversioned directory. If False, the branch must already
461
relax_version_check -- If true, the usual check for the branch
462
version is not applied. This is intended only for
463
upgrade/recovery type use; it's not guaranteed that
464
all operations will work on old format branches.
466
In the test suite, creation of new trees is tested using the
467
`ScratchBranch` class.
469
assert isinstance(transport, Transport), \
470
"%r is not a Transport" % transport
471
# TODO: jam 20060103 We create a clone of this transport at .bzr/
472
# and then we forget about it, should we keep a handle to it?
473
self._base = transport.base
474
self.control_files = LockableFiles(transport.clone(bzrlib.BZRDIR),
478
self._check_format(relax_version_check)
479
self.repository = Repository(transport, self._branch_format)
1464
def __init__(self, _format=None,
1465
_control_files=None, a_bzrdir=None, _repository=None):
1466
"""Create new branch object at a particular location."""
1467
if a_bzrdir is None:
1468
raise ValueError('a_bzrdir must be supplied')
1470
self.bzrdir = a_bzrdir
1471
self._base = self.bzrdir.transport.clone('..').base
1472
# XXX: We should be able to just do
1473
# self.base = self.bzrdir.root_transport.base
1474
# but this does not quite work yet -- mbp 20080522
1475
self._format = _format
1476
if _control_files is None:
1477
raise ValueError('BzrBranch _control_files is None')
1478
self.control_files = _control_files
1479
self._transport = _control_files._transport
1480
self.repository = _repository
1481
Branch.__init__(self)
481
1483
def __str__(self):
482
1484
return '%s(%r)' % (self.__class__.__name__, self.base)
484
1486
__repr__ = __str__
487
# TODO: It might be best to do this somewhere else,
488
# but it is nice for a Branch object to automatically
489
# cache it's information.
490
# Alternatively, we could have the Transport objects cache requests
491
# See the earlier discussion about how major objects (like Branch)
492
# should never expect their __del__ function to run.
493
if hasattr(self, 'cache_root') and self.cache_root is not None:
495
shutil.rmtree(self.cache_root)
498
self.cache_root = None
500
1488
def _get_base(self):
1489
"""Returns the directory containing the control directory."""
501
1490
return self._base
503
1492
base = property(_get_base, doc="The URL for the root of this branch.")
505
def _finish_transaction(self):
506
"""Exit the current transaction."""
507
return self.control_files._finish_transaction()
509
def get_transaction(self):
510
"""Return the current active transaction.
512
If no transaction is active, this returns a passthrough object
513
for which all data is immediately flushed and no caching happens.
515
# this is an explicit function so that we can do tricky stuff
516
# when the storage in rev_storage is elsewhere.
517
# we probably need to hook the two 'lock a location' and
518
# 'have a transaction' together more delicately, so that
519
# we can have two locks (branch and storage) and one transaction
520
# ... and finishing the transaction unlocks both, but unlocking
521
# does not. - RBC 20051121
522
return self.control_files.get_transaction()
524
def _set_transaction(self, transaction):
525
"""Set a new active transaction."""
526
return self.control_files._set_transaction(transaction)
528
def abspath(self, name):
529
"""See Branch.abspath."""
530
return self.control_files._transport.abspath(name)
532
def _make_control(self):
533
from bzrlib.inventory import Inventory
534
from bzrlib.weavefile import write_weave_v5
535
from bzrlib.weave import Weave
537
# Create an empty inventory
539
# if we want per-tree root ids then this is the place to set
540
# them; they're not needed for now and so ommitted for
542
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
543
empty_inv = sio.getvalue()
545
bzrlib.weavefile.write_weave_v5(Weave(), sio)
546
empty_weave = sio.getvalue()
548
dirs = ['', 'revision-store', 'weaves']
550
"This is a Bazaar-NG control directory.\n"
551
"Do not change any files in this directory.\n"),
552
('branch-format', BZR_BRANCH_FORMAT_6),
553
('revision-history', ''),
556
('pending-merges', ''),
557
('inventory', empty_inv),
558
('inventory.weave', empty_weave),
559
('ancestry.weave', empty_weave)
561
cfe = self.control_files._escape
562
self.control_files._transport.mkdir_multi([cfe(d) for d in dirs],
563
mode=self.control_files._dir_mode)
564
self.control_files.lock_write()
566
for file, content in files:
567
self.control_files.put_utf8(file, content)
568
mutter('created control directory in ' + self.base)
1494
def is_locked(self):
1495
return self.control_files.is_locked()
1497
def lock_write(self, token=None):
1498
repo_token = self.repository.lock_write()
1500
token = self.control_files.lock_write(token=token)
1502
self.repository.unlock()
1506
def lock_read(self):
1507
self.repository.lock_read()
1509
self.control_files.lock_read()
1511
self.repository.unlock()
1515
# TODO: test for failed two phase locks. This is known broken.
570
1517
self.control_files.unlock()
572
def _check_format(self, relax_version_check):
573
"""Check this branch format is supported.
575
The format level is stored, as an integer, in
576
self._branch_format for code that needs to check it later.
578
In the future, we might need different in-memory Branch
579
classes to support downlevel branches. But not yet.
582
fmt = self.control_files.controlfile('branch-format', 'r').read()
584
raise NotBranchError(path=self.base)
585
mutter("got branch format %r", fmt)
586
if fmt == BZR_BRANCH_FORMAT_6:
587
self._branch_format = 6
588
elif fmt == BZR_BRANCH_FORMAT_5:
589
self._branch_format = 5
590
elif fmt == BZR_BRANCH_FORMAT_4:
591
self._branch_format = 4
593
if (not relax_version_check
594
and self._branch_format not in (5, 6)):
595
raise errors.UnsupportedFormatError(
596
'sorry, branch format %r not supported' % fmt,
597
['use a different bzr version',
598
'or remove the .bzr directory'
599
' and "bzr init" again'])
602
def get_root_id(self):
603
"""See Branch.get_root_id."""
604
inv = self.repository.get_inventory(self.last_revision())
605
return inv.root.file_id
607
def lock_write(self):
608
# TODO: test for failed two phase locks. This is known broken.
609
self.control_files.lock_write()
610
self.repository.lock_write()
613
# TODO: test for failed two phase locks. This is known broken.
614
self.control_files.lock_read()
615
self.repository.lock_read()
618
# TODO: test for failed two phase locks. This is known broken.
619
self.repository.unlock()
620
self.control_files.unlock()
1519
self.repository.unlock()
1520
if not self.control_files.is_locked():
1521
# we just released the lock
1522
self._clear_cached_state()
1524
def peek_lock_mode(self):
1525
if self.control_files._lock_count == 0:
1528
return self.control_files._lock_mode
1530
def get_physical_lock_status(self):
1531
return self.control_files.get_physical_lock_status()
622
1533
@needs_read_lock
623
1534
def print_file(self, file, revision_id):
624
1535
"""See Branch.print_file."""
625
1536
return self.repository.print_file(file, revision_id)
628
def append_revision(self, *revision_ids):
629
"""See Branch.append_revision."""
630
for revision_id in revision_ids:
631
mutter("add {%s} to revision-history" % revision_id)
632
rev_history = self.revision_history()
633
rev_history.extend(revision_ids)
634
self.set_revision_history(rev_history)
1538
def _write_revision_history(self, history):
1539
"""Factored out of set_revision_history.
1541
This performs the actual writing to disk.
1542
It is intended to be called by BzrBranch5.set_revision_history."""
1543
self._transport.put_bytes(
1544
'revision-history', '\n'.join(history),
1545
mode=self.bzrdir._get_file_mode())
636
1547
@needs_write_lock
637
1548
def set_revision_history(self, rev_history):
638
1549
"""See Branch.set_revision_history."""
639
old_revision = self.last_revision()
640
new_revision = rev_history[-1]
641
self.control_files.put_utf8(
642
'revision-history', '\n'.join(rev_history))
644
# FIXME: RBC 20051207 this smells wrong, last_revision in the
645
# working tree may be != to last_revision in the branch - so
646
# why is this passing in the branches last_revision ?
647
self.working_tree().set_last_revision(new_revision, old_revision)
648
except NoWorkingTree:
649
mutter('Unable to set_last_revision without a working tree.')
651
def get_revision_delta(self, revno):
652
"""Return the delta for one revision.
654
The delta is relative to its mainline predecessor, or the
655
empty tree for revision 1.
657
assert isinstance(revno, int)
658
rh = self.revision_history()
659
if not (1 <= revno <= len(rh)):
660
raise InvalidRevisionNumber(revno)
662
# revno is 1-based; list is 0-based
664
new_tree = self.repository.revision_tree(rh[revno-1])
666
old_tree = EmptyTree()
1550
if 'evil' in debug.debug_flags:
1551
mutter_callsite(3, "set_revision_history scales with history.")
1552
check_not_reserved_id = _mod_revision.check_not_reserved_id
1553
for rev_id in rev_history:
1554
check_not_reserved_id(rev_id)
1555
if Branch.hooks['post_change_branch_tip']:
1556
# Don't calculate the last_revision_info() if there are no hooks
1558
old_revno, old_revid = self.last_revision_info()
1559
if len(rev_history) == 0:
1560
revid = _mod_revision.NULL_REVISION
668
old_tree = self.repository.revision_tree(rh[revno-2])
669
return compare_trees(old_tree, new_tree)
672
def revision_history(self):
673
"""See Branch.revision_history."""
674
# FIXME are transactions bound to control files ? RBC 20051121
675
transaction = self.get_transaction()
676
history = transaction.map.find_revision_history()
677
if history is not None:
678
mutter("cache hit for revision-history in %s", self)
680
history = [l.rstrip('\r\n') for l in
681
self.control_files.controlfile('revision-history', 'r').readlines()]
682
transaction.map.add_revision_history(history)
683
# this call is disabled because revision_history is
684
# not really an object yet, and the transaction is for objects.
685
# transaction.register_clean(history, precious=True)
688
def update_revisions(self, other, stop_revision=None):
689
"""See Branch.update_revisions."""
690
from bzrlib.fetch import greedy_fetch
691
if stop_revision is None:
692
stop_revision = other.last_revision()
693
### Should this be checking is_ancestor instead of revision_history?
694
if (stop_revision is not None and
695
stop_revision in self.revision_history()):
1562
revid = rev_history[-1]
1563
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1564
self._write_revision_history(rev_history)
1565
self._clear_cached_state()
1566
self._cache_revision_history(rev_history)
1567
for hook in Branch.hooks['set_rh']:
1568
hook(self, rev_history)
1569
if Branch.hooks['post_change_branch_tip']:
1570
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1572
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1573
"""Run the pre_change_branch_tip hooks."""
1574
hooks = Branch.hooks['pre_change_branch_tip']
697
greedy_fetch(to_branch=self, from_branch=other,
698
revision=stop_revision)
699
pullable_revs = self.pullable_revisions(other, stop_revision)
700
if len(pullable_revs) > 0:
701
self.append_revision(*pullable_revs)
703
def pullable_revisions(self, other, stop_revision):
704
"""See Branch.pullable_revisions."""
705
other_revno = other.revision_id_to_revno(stop_revision)
707
return self.missing_revisions(other, other_revno)
708
except DivergedBranches, e:
1577
old_revno, old_revid = self.last_revision_info()
1578
params = ChangeBranchTipParams(
1579
self, old_revno, new_revno, old_revid, new_revid)
710
pullable_revs = get_intervening_revisions(self.last_revision(),
713
assert self.last_revision() not in pullable_revs
715
except bzrlib.errors.NotAncestor:
716
if is_ancestor(self.last_revision(), stop_revision, self):
1583
except errors.TipChangeRejected:
1586
exc_info = sys.exc_info()
1587
hook_name = Branch.hooks.get_hook_name(hook)
1588
raise errors.HookFailed(
1589
'pre_change_branch_tip', hook_name, exc_info)
1591
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1592
"""Run the post_change_branch_tip hooks."""
1593
hooks = Branch.hooks['post_change_branch_tip']
1596
new_revno, new_revid = self.last_revision_info()
1597
params = ChangeBranchTipParams(
1598
self, old_revno, new_revno, old_revid, new_revid)
1603
def set_last_revision_info(self, revno, revision_id):
1604
"""Set the last revision of this branch.
1606
The caller is responsible for checking that the revno is correct
1607
for this revision id.
1609
It may be possible to set the branch last revision to an id not
1610
present in the repository. However, branches can also be
1611
configured to check constraints on history, in which case this may not
1614
revision_id = _mod_revision.ensure_null(revision_id)
1615
# this old format stores the full history, but this api doesn't
1616
# provide it, so we must generate, and might as well check it's
1618
history = self._lefthand_history(revision_id)
1619
if len(history) != revno:
1620
raise AssertionError('%d != %d' % (len(history), revno))
1621
self.set_revision_history(history)
1623
def _gen_revision_history(self):
1624
history = self._transport.get_bytes('revision-history').split('\n')
1625
if history[-1:] == ['']:
1626
# There shouldn't be a trailing newline, but just in case.
1630
def _lefthand_history(self, revision_id, last_rev=None,
1632
if 'evil' in debug.debug_flags:
1633
mutter_callsite(4, "_lefthand_history scales with history.")
1634
# stop_revision must be a descendant of last_revision
1635
graph = self.repository.get_graph()
1636
if last_rev is not None:
1637
if not graph.is_ancestor(last_rev, revision_id):
1638
# our previous tip is not merged into stop_revision
1639
raise errors.DivergedBranches(self, other_branch)
1640
# make a new revision history from the graph
1641
parents_map = graph.get_parent_map([revision_id])
1642
if revision_id not in parents_map:
1643
raise errors.NoSuchRevision(self, revision_id)
1644
current_rev_id = revision_id
1646
check_not_reserved_id = _mod_revision.check_not_reserved_id
1647
# Do not include ghosts or graph origin in revision_history
1648
while (current_rev_id in parents_map and
1649
len(parents_map[current_rev_id]) > 0):
1650
check_not_reserved_id(current_rev_id)
1651
new_history.append(current_rev_id)
1652
current_rev_id = parents_map[current_rev_id][0]
1653
parents_map = graph.get_parent_map([current_rev_id])
1654
new_history.reverse()
1658
def generate_revision_history(self, revision_id, last_rev=None,
1660
"""Create a new revision history that will finish with revision_id.
1662
:param revision_id: the new tip to use.
1663
:param last_rev: The previous last_revision. If not None, then this
1664
must be a ancestory of revision_id, or DivergedBranches is raised.
1665
:param other_branch: The other branch that DivergedBranches should
1666
raise with respect to.
1668
self.set_revision_history(self._lefthand_history(revision_id,
1669
last_rev, other_branch))
721
1671
def basis_tree(self):
722
1672
"""See Branch.basis_tree."""
724
revision_id = self.revision_history()[-1]
725
# FIXME: This is an abstraction violation, the basis tree
726
# here as defined is on the working tree, the method should
727
# be too. The basis tree for a branch can be different than
728
# that for a working tree. RBC 20051207
729
xml = self.working_tree().read_basis_inventory(revision_id)
730
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
731
return RevisionTree(self.repository, inv, revision_id)
732
except (IndexError, NoSuchFile, NoWorkingTree), e:
733
return self.repository.revision_tree(self.last_revision())
735
def working_tree(self):
736
"""See Branch.working_tree."""
737
from bzrlib.workingtree import WorkingTree
738
if self.base.find('://') != -1:
739
raise NoWorkingTree(self.base)
740
return WorkingTree(self.base, branch=self)
1673
return self.repository.revision_tree(self.last_revision())
742
1675
@needs_write_lock
743
def pull(self, source, overwrite=False):
744
"""See Branch.pull."""
1676
def pull(self, source, overwrite=False, stop_revision=None,
1677
_hook_master=None, run_hooks=True, possible_transports=None,
1678
_override_hook_target=None):
1681
:param _hook_master: Private parameter - set the branch to
1682
be supplied as the master to pull hooks.
1683
:param run_hooks: Private parameter - if false, this branch
1684
is being called because it's the master of the primary branch,
1685
so it should not run its hooks.
1686
:param _override_hook_target: Private parameter - set the branch to be
1687
supplied as the target_branch to pull hooks.
1689
result = PullResult()
1690
result.source_branch = source
1691
if _override_hook_target is None:
1692
result.target_branch = self
1694
result.target_branch = _override_hook_target
745
1695
source.lock_read()
747
old_count = len(self.revision_history())
749
self.update_revisions(source)
750
except DivergedBranches:
754
self.set_revision_history(source.revision_history())
755
new_count = len(self.revision_history())
756
return new_count - old_count
1697
# We assume that during 'pull' the local repository is closer than
1699
graph = self.repository.get_graph(source.repository)
1700
result.old_revno, result.old_revid = self.last_revision_info()
1701
self.update_revisions(source, stop_revision, overwrite=overwrite,
1703
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1704
result.new_revno, result.new_revid = self.last_revision_info()
1706
result.master_branch = _hook_master
1707
result.local_branch = result.target_branch
1709
result.master_branch = result.target_branch
1710
result.local_branch = None
1712
for hook in Branch.hooks['post_pull']:
760
def get_parent(self):
761
"""See Branch.get_parent."""
1718
def _get_parent_location(self):
763
1719
_locs = ['parent', 'pull', 'x-pull']
766
return self.control_files.controlfile(l, 'r').read().strip('\n')
1722
return self._transport.get_bytes(l).strip('\n')
1723
except errors.NoSuchFile:
771
def get_push_location(self):
772
"""See Branch.get_push_location."""
773
config = bzrlib.config.BranchConfig(self)
774
push_loc = config.get_user_option('push_location')
1728
def push(self, target, overwrite=False, stop_revision=None,
1729
_override_hook_source_branch=None):
1732
This is the basic concrete implementation of push()
1734
:param _override_hook_source_branch: If specified, run
1735
the hooks passing this Branch as the source, rather than self.
1736
This is for use of RemoteBranch, where push is delegated to the
1737
underlying vfs-based Branch.
1739
# TODO: Public option to disable running hooks - should be trivial but
1743
result = self._push_with_bound_branches(target, overwrite,
1745
_override_hook_source_branch=_override_hook_source_branch)
1750
def _push_with_bound_branches(self, target, overwrite,
1752
_override_hook_source_branch=None):
1753
"""Push from self into target, and into target's master if any.
1755
This is on the base BzrBranch class even though it doesn't support
1756
bound branches because the *target* might be bound.
1759
if _override_hook_source_branch:
1760
result.source_branch = _override_hook_source_branch
1761
for hook in Branch.hooks['post_push']:
1764
bound_location = target.get_bound_location()
1765
if bound_location and target.base != bound_location:
1766
# there is a master branch.
1768
# XXX: Why the second check? Is it even supported for a branch to
1769
# be bound to itself? -- mbp 20070507
1770
master_branch = target.get_master_branch()
1771
master_branch.lock_write()
1773
# push into the master from this branch.
1774
self._basic_push(master_branch, overwrite, stop_revision)
1775
# and push into the target branch from this. Note that we push from
1776
# this branch again, because its considered the highest bandwidth
1778
result = self._basic_push(target, overwrite, stop_revision)
1779
result.master_branch = master_branch
1780
result.local_branch = target
1784
master_branch.unlock()
1787
result = self._basic_push(target, overwrite, stop_revision)
1788
# TODO: Why set master_branch and local_branch if there's no
1789
# binding? Maybe cleaner to just leave them unset? -- mbp
1791
result.master_branch = target
1792
result.local_branch = None
1796
def _basic_push(self, target, overwrite, stop_revision):
1797
"""Basic implementation of push without bound branches or hooks.
1799
Must be called with self read locked and target write locked.
1801
result = PushResult()
1802
result.source_branch = self
1803
result.target_branch = target
1804
result.old_revno, result.old_revid = target.last_revision_info()
1806
# We assume that during 'push' this repository is closer than
1808
graph = self.repository.get_graph(target.repository)
1809
target.update_revisions(self, stop_revision, overwrite=overwrite,
1811
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1812
result.new_revno, result.new_revid = target.last_revision_info()
1815
def get_parent(self):
1816
"""See Branch.get_parent."""
1817
parent = self._get_parent_location()
1820
# This is an old-format absolute path to a local branch
1821
# turn it into a url
1822
if parent.startswith('/'):
1823
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1825
return urlutils.join(self.base[:-1], parent)
1826
except errors.InvalidURLJoin, e:
1827
raise errors.InaccessibleParent(parent, self.base)
1829
def get_stacked_on_url(self):
1830
raise errors.UnstackableBranchFormat(self._format, self.base)
777
1832
def set_push_location(self, location):
778
1833
"""See Branch.set_push_location."""
779
config = bzrlib.config.LocationConfig(self.base)
780
config.set_user_option('push_location', location)
1834
self.get_config().set_user_option(
1835
'push_location', location,
1836
store=_mod_config.STORE_LOCATION_NORECURSE)
782
1838
@needs_write_lock
783
1839
def set_parent(self, url):
784
1840
"""See Branch.set_parent."""
785
1841
# TODO: Maybe delete old location files?
786
from bzrlib.atomicfile import AtomicFile
787
f = AtomicFile(self.control_files.controlfilename('parent'))
1842
# URLs should never be unicode, even on the local fs,
1843
# FIXUP this and get_parent in a future branch format bump:
1844
# read and rewrite the file. RBC 20060125
1846
if isinstance(url, unicode):
1848
url = url.encode('ascii')
1849
except UnicodeEncodeError:
1850
raise errors.InvalidURL(url,
1851
"Urls must be 7-bit ascii, "
1852
"use bzrlib.urlutils.escape")
1853
url = urlutils.relative_url(self.base, url)
1854
self._set_parent_location(url)
1856
def _set_parent_location(self, url):
1858
self._transport.delete('parent')
1860
self._transport.put_bytes('parent', url + '\n',
1861
mode=self.bzrdir._get_file_mode())
1863
def set_stacked_on_url(self, url):
1864
raise errors.UnstackableBranchFormat(self._format, self.base)
1867
class BzrBranch5(BzrBranch):
1868
"""A format 5 branch. This supports new features over plain branches.
1870
It has support for a master_branch which is the data for bound branches.
1874
def pull(self, source, overwrite=False, stop_revision=None,
1875
run_hooks=True, possible_transports=None,
1876
_override_hook_target=None):
1877
"""Pull from source into self, updating my master if any.
1879
:param run_hooks: Private parameter - if false, this branch
1880
is being called because it's the master of the primary branch,
1881
so it should not run its hooks.
1883
bound_location = self.get_bound_location()
1884
master_branch = None
1885
if bound_location and source.base != bound_location:
1886
# not pulling from master, so we need to update master.
1887
master_branch = self.get_master_branch(possible_transports)
1888
master_branch.lock_write()
1891
# pull from source into master.
1892
master_branch.pull(source, overwrite, stop_revision,
1894
return super(BzrBranch5, self).pull(source, overwrite,
1895
stop_revision, _hook_master=master_branch,
1896
run_hooks=run_hooks,
1897
_override_hook_target=_override_hook_target)
794
def tree_config(self):
795
return TreeConfig(self)
797
def _get_truncated_history(self, revision_id):
798
history = self.revision_history()
1900
master_branch.unlock()
1902
def get_bound_location(self):
1904
return self._transport.get_bytes('bound')[:-1]
1905
except errors.NoSuchFile:
1909
def get_master_branch(self, possible_transports=None):
1910
"""Return the branch we are bound to.
1912
:return: Either a Branch, or None
1914
This could memoise the branch, but if thats done
1915
it must be revalidated on each new lock.
1916
So for now we just don't memoise it.
1917
# RBC 20060304 review this decision.
1919
bound_loc = self.get_bound_location()
1923
return Branch.open(bound_loc,
1924
possible_transports=possible_transports)
1925
except (errors.NotBranchError, errors.ConnectionError), e:
1926
raise errors.BoundBranchConnectionFailure(
1930
def set_bound_location(self, location):
1931
"""Set the target where this branch is bound to.
1933
:param location: URL to the target branch
1936
self._transport.put_bytes('bound', location+'\n',
1937
mode=self.bzrdir._get_file_mode())
1940
self._transport.delete('bound')
1941
except errors.NoSuchFile:
1946
def bind(self, other):
1947
"""Bind this branch to the branch other.
1949
This does not push or pull data between the branches, though it does
1950
check for divergence to raise an error when the branches are not
1951
either the same, or one a prefix of the other. That behaviour may not
1952
be useful, so that check may be removed in future.
1954
:param other: The branch to bind to
1957
# TODO: jam 20051230 Consider checking if the target is bound
1958
# It is debatable whether you should be able to bind to
1959
# a branch which is itself bound.
1960
# Committing is obviously forbidden,
1961
# but binding itself may not be.
1962
# Since we *have* to check at commit time, we don't
1963
# *need* to check here
1965
# we want to raise diverged if:
1966
# last_rev is not in the other_last_rev history, AND
1967
# other_last_rev is not in our history, and do it without pulling
1969
self.set_bound_location(other.base)
1973
"""If bound, unbind"""
1974
return self.set_bound_location(None)
1977
def update(self, possible_transports=None):
1978
"""Synchronise this branch with the master branch if any.
1980
:return: None or the last_revision that was pivoted out during the
1983
master = self.get_master_branch(possible_transports)
1984
if master is not None:
1985
old_tip = _mod_revision.ensure_null(self.last_revision())
1986
self.pull(master, overwrite=True)
1987
if self.repository.get_graph().is_ancestor(old_tip,
1988
_mod_revision.ensure_null(self.last_revision())):
1994
class BzrBranch7(BzrBranch5):
1995
"""A branch with support for a fallback repository."""
1997
def _get_fallback_repository(self, url):
1998
"""Get the repository we fallback to at url."""
1999
url = urlutils.join(self.base, url)
2000
return bzrdir.BzrDir.open(url).open_branch().repository
2002
def _activate_fallback_location(self, url):
2003
"""Activate the branch/repository from url as a fallback repository."""
2004
self.repository.add_fallback_repository(
2005
self._get_fallback_repository(url))
2007
def _open_hook(self):
2009
url = self.get_stacked_on_url()
2010
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2011
errors.UnstackableBranchFormat):
2014
self._activate_fallback_location(url)
2016
def _check_stackable_repo(self):
2017
if not self.repository._format.supports_external_lookups:
2018
raise errors.UnstackableRepositoryFormat(self.repository._format,
2019
self.repository.base)
2021
def __init__(self, *args, **kwargs):
2022
super(BzrBranch7, self).__init__(*args, **kwargs)
2023
self._last_revision_info_cache = None
2024
self._partial_revision_history_cache = []
2026
def _clear_cached_state(self):
2027
super(BzrBranch7, self)._clear_cached_state()
2028
self._last_revision_info_cache = None
2029
self._partial_revision_history_cache = []
2031
def _last_revision_info(self):
2032
revision_string = self._transport.get_bytes('last-revision')
2033
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2034
revision_id = cache_utf8.get_cached_utf8(revision_id)
2036
return revno, revision_id
2038
def _write_last_revision_info(self, revno, revision_id):
2039
"""Simply write out the revision id, with no checks.
2041
Use set_last_revision_info to perform this safely.
2043
Does not update the revision_history cache.
2044
Intended to be called by set_last_revision_info and
2045
_write_revision_history.
2047
revision_id = _mod_revision.ensure_null(revision_id)
2048
out_string = '%d %s\n' % (revno, revision_id)
2049
self._transport.put_bytes('last-revision', out_string,
2050
mode=self.bzrdir._get_file_mode())
2053
def set_last_revision_info(self, revno, revision_id):
2054
revision_id = _mod_revision.ensure_null(revision_id)
2055
old_revno, old_revid = self.last_revision_info()
2056
if self._get_append_revisions_only():
2057
self._check_history_violation(revision_id)
2058
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2059
self._write_last_revision_info(revno, revision_id)
2060
self._clear_cached_state()
2061
self._last_revision_info_cache = revno, revision_id
2062
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2064
def _check_history_violation(self, revision_id):
2065
last_revision = _mod_revision.ensure_null(self.last_revision())
2066
if _mod_revision.is_null(last_revision):
2068
if last_revision not in self._lefthand_history(revision_id):
2069
raise errors.AppendRevisionsOnlyViolation(self.base)
2071
def _gen_revision_history(self):
2072
"""Generate the revision history from last revision
2074
last_revno, last_revision = self.last_revision_info()
2075
self._extend_partial_history(stop_index=last_revno-1)
2076
return list(reversed(self._partial_revision_history_cache))
2078
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2079
"""Extend the partial history to include a given index
2081
If a stop_index is supplied, stop when that index has been reached.
2082
If a stop_revision is supplied, stop when that revision is
2083
encountered. Otherwise, stop when the beginning of history is
2086
:param stop_index: The index which should be present. When it is
2087
present, history extension will stop.
2088
:param revision_id: The revision id which should be present. When
2089
it is encountered, history extension will stop.
2091
repo = self.repository
2092
if len(self._partial_revision_history_cache) == 0:
2093
iterator = repo.iter_reverse_revision_history(self.last_revision())
2095
start_revision = self._partial_revision_history_cache[-1]
2096
iterator = repo.iter_reverse_revision_history(start_revision)
2097
#skip the last revision in the list
2098
next_revision = iterator.next()
2099
for revision_id in iterator:
2100
self._partial_revision_history_cache.append(revision_id)
2101
if (stop_index is not None and
2102
len(self._partial_revision_history_cache) > stop_index):
2104
if revision_id == stop_revision:
2107
def _write_revision_history(self, history):
2108
"""Factored out of set_revision_history.
2110
This performs the actual writing to disk, with format-specific checks.
2111
It is intended to be called by BzrBranch5.set_revision_history.
2113
if len(history) == 0:
2114
last_revision = 'null:'
2116
if history != self._lefthand_history(history[-1]):
2117
raise errors.NotLefthandHistory(history)
2118
last_revision = history[-1]
2119
if self._get_append_revisions_only():
2120
self._check_history_violation(last_revision)
2121
self._write_last_revision_info(len(history), last_revision)
2124
def _set_parent_location(self, url):
2125
"""Set the parent branch"""
2126
self._set_config_location('parent_location', url, make_relative=True)
2129
def _get_parent_location(self):
2130
"""Set the parent branch"""
2131
return self._get_config_location('parent_location')
2133
def set_push_location(self, location):
2134
"""See Branch.set_push_location."""
2135
self._set_config_location('push_location', location)
2137
def set_bound_location(self, location):
2138
"""See Branch.set_push_location."""
2140
config = self.get_config()
2141
if location is None:
2142
if config.get_user_option('bound') != 'True':
2145
config.set_user_option('bound', 'False', warn_masked=True)
2148
self._set_config_location('bound_location', location,
2150
config.set_user_option('bound', 'True', warn_masked=True)
2153
def _get_bound_location(self, bound):
2154
"""Return the bound location in the config file.
2156
Return None if the bound parameter does not match"""
2157
config = self.get_config()
2158
config_bound = (config.get_user_option('bound') == 'True')
2159
if config_bound != bound:
2161
return self._get_config_location('bound_location', config=config)
2163
def get_bound_location(self):
2164
"""See Branch.set_push_location."""
2165
return self._get_bound_location(True)
2167
def get_old_bound_location(self):
2168
"""See Branch.get_old_bound_location"""
2169
return self._get_bound_location(False)
2171
def get_stacked_on_url(self):
2172
self._check_stackable_repo()
2173
stacked_url = self._get_config_location('stacked_on_location')
2174
if stacked_url is None:
2175
raise errors.NotStacked(self)
2178
def set_append_revisions_only(self, enabled):
2183
self.get_config().set_user_option('append_revisions_only', value,
2186
def set_stacked_on_url(self, url):
2187
self._check_stackable_repo()
2190
old_url = self.get_stacked_on_url()
2191
except (errors.NotStacked, errors.UnstackableBranchFormat,
2192
errors.UnstackableRepositoryFormat):
2195
# repositories don't offer an interface to remove fallback
2196
# repositories today; take the conceptually simpler option and just
2198
self.repository = self.bzrdir.find_repository()
2199
# for every revision reference the branch has, ensure it is pulled
2201
source_repository = self._get_fallback_repository(old_url)
2202
for revision_id in chain([self.last_revision()],
2203
self.tags.get_reverse_tag_dict()):
2204
self.repository.fetch(source_repository, revision_id,
2207
self._activate_fallback_location(url)
2208
# write this out after the repository is stacked to avoid setting a
2209
# stacked config that doesn't work.
2210
self._set_config_location('stacked_on_location', url)
2212
def _get_append_revisions_only(self):
2213
value = self.get_config().get_user_option('append_revisions_only')
2214
return value == 'True'
2216
def _synchronize_history(self, destination, revision_id):
2217
"""Synchronize last revision and revision history between branches.
2219
This version is most efficient when the destination is also a
2220
BzrBranch6, but works for BzrBranch5, as long as the destination's
2221
repository contains all the lefthand ancestors of the intended
2222
last_revision. If not, set_last_revision_info will fail.
2224
:param destination: The branch to copy the history into
2225
:param revision_id: The revision-id to truncate history at. May
2226
be None to copy complete history.
2228
source_revno, source_revision_id = self.last_revision_info()
799
2229
if revision_id is None:
2230
revno, revision_id = source_revno, source_revision_id
2231
elif source_revision_id == revision_id:
2232
# we know the revno without needing to walk all of history
2233
revno = source_revno
2235
# To figure out the revno for a random revision, we need to build
2236
# the revision history, and count its length.
2237
# We don't care about the order, just how long it is.
2238
# Alternatively, we could start at the current location, and count
2239
# backwards. But there is no guarantee that we will find it since
2240
# it may be a merged revision.
2241
revno = len(list(self.repository.iter_reverse_revision_history(
2243
destination.set_last_revision_info(revno, revision_id)
2245
def _make_tags(self):
2246
return BasicTags(self)
2249
def generate_revision_history(self, revision_id, last_rev=None,
2251
"""See BzrBranch5.generate_revision_history"""
2252
history = self._lefthand_history(revision_id, last_rev, other_branch)
2253
revno = len(history)
2254
self.set_last_revision_info(revno, revision_id)
2257
def get_rev_id(self, revno, history=None):
2258
"""Find the revision id of the specified revno."""
2260
return _mod_revision.NULL_REVISION
2262
last_revno, last_revision_id = self.last_revision_info()
2263
if revno <= 0 or revno > last_revno:
2264
raise errors.NoSuchRevision(self, revno)
2266
if history is not None:
2267
return history[revno - 1]
2269
index = last_revno - revno
2270
if len(self._partial_revision_history_cache) <= index:
2271
self._extend_partial_history(stop_index=index)
2272
if len(self._partial_revision_history_cache) > index:
2273
return self._partial_revision_history_cache[index]
2275
raise errors.NoSuchRevision(self, revno)
2278
def revision_id_to_revno(self, revision_id):
2279
"""Given a revision id, return its revno"""
2280
if _mod_revision.is_null(revision_id):
802
idx = history.index(revision_id)
2283
index = self._partial_revision_history_cache.index(revision_id)
803
2284
except ValueError:
804
raise InvalidRevisionId(revision_id=revision, branch=self)
805
return history[:idx+1]
808
def _clone_weave(self, to_location, revision=None, basis_branch=None):
809
assert isinstance(to_location, basestring)
810
if basis_branch is not None:
811
note("basis_branch is not supported for fast weave copy yet.")
813
history = self._get_truncated_history(revision)
814
if not bzrlib.osutils.lexists(to_location):
815
os.mkdir(to_location)
816
branch_to = Branch.initialize(to_location)
817
mutter("copy branch from %s to %s", self, branch_to)
818
branch_to.working_tree().set_root_id(self.get_root_id())
820
self.repository.copy(branch_to.repository)
822
# must be done *after* history is copied across
823
# FIXME duplicate code with base .clone().
824
# .. would template method be useful here. RBC 20051207
825
branch_to.set_parent(self.base)
826
branch_to.append_revision(*history)
827
# circular import protection
828
from bzrlib.merge import build_working_dir
829
build_working_dir(to_location)
833
def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
834
if to_branch_type is None:
835
to_branch_type = BzrBranch
837
if to_branch_type == BzrBranch \
838
and self.repository.weave_store.listable() \
839
and self.repository.revision_store.listable():
840
return self._clone_weave(to_location, revision, basis_branch)
842
return Branch.clone(self, to_location, revision, basis_branch, to_branch_type)
845
class ScratchBranch(BzrBranch):
846
"""Special test class: a branch that cleans up after itself.
848
>>> b = ScratchBranch()
852
>>> b._transport.__del__()
2285
self._extend_partial_history(stop_revision=revision_id)
2286
index = len(self._partial_revision_history_cache) - 1
2287
if self._partial_revision_history_cache[index] != revision_id:
2288
raise errors.NoSuchRevision(self, revision_id)
2289
return self.revno() - index
2292
class BzrBranch6(BzrBranch7):
2293
"""See BzrBranchFormat6 for the capabilities of this branch.
2295
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
857
def __init__(self, files=[], dirs=[], transport=None):
858
"""Make a test branch.
860
This creates a temporary directory and runs init-tree in it.
862
If any files are listed, they are created in the working copy.
864
if transport is None:
865
transport = bzrlib.transport.local.ScratchTransport()
866
super(ScratchBranch, self).__init__(transport, init=True)
868
super(ScratchBranch, self).__init__(transport)
870
# BzrBranch creates a clone to .bzr and then forgets about the
871
# original transport. A ScratchTransport() deletes itself and
872
# everything underneath it when it goes away, so we need to
873
# grab a local copy to prevent that from happening
874
self._transport = transport
877
self._transport.mkdir(d)
880
self._transport.put(f, 'content of %s' % f)
884
>>> orig = ScratchBranch(files=["file1", "file2"])
885
>>> os.listdir(orig.base)
886
[u'.bzr', u'file1', u'file2']
887
>>> clone = orig.clone()
888
>>> if os.name != 'nt':
889
... os.path.samefile(orig.base, clone.base)
891
... orig.base == clone.base
894
>>> os.listdir(clone.base)
895
[u'.bzr', u'file1', u'file2']
897
from shutil import copytree
898
from bzrlib.osutils import mkdtemp
901
copytree(self.base, base, symlinks=True)
902
return ScratchBranch(
903
transport=bzrlib.transport.local.ScratchTransport(base))
2299
def get_stacked_on_url(self):
2300
raise errors.UnstackableBranchFormat(self._format, self.base)
2302
def set_stacked_on_url(self, url):
2303
raise errors.UnstackableBranchFormat(self._format, self.base)
906
2306
######################################################################
910
def is_control_file(filename):
911
## FIXME: better check
912
filename = normpath(filename)
913
while filename != '':
914
head, tail = os.path.split(filename)
915
## mutter('check %r for control file' % ((head, tail), ))
916
if tail == bzrlib.BZRDIR:
2307
# results of operations
2310
class _Result(object):
2312
def _show_tag_conficts(self, to_file):
2313
if not getattr(self, 'tag_conflicts', None):
2315
to_file.write('Conflicting tags:\n')
2316
for name, value1, value2 in self.tag_conflicts:
2317
to_file.write(' %s\n' % (name, ))
2320
class PullResult(_Result):
2321
"""Result of a Branch.pull operation.
2323
:ivar old_revno: Revision number before pull.
2324
:ivar new_revno: Revision number after pull.
2325
:ivar old_revid: Tip revision id before pull.
2326
:ivar new_revid: Tip revision id after pull.
2327
:ivar source_branch: Source (local) branch object.
2328
:ivar master_branch: Master branch of the target, or the target if no
2330
:ivar local_branch: target branch if there is a Master, else None
2331
:ivar target_branch: Target/destination branch object.
2332
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2336
# DEPRECATED: pull used to return the change in revno
2337
return self.new_revno - self.old_revno
2339
def report(self, to_file):
2341
if self.old_revid == self.new_revid:
2342
to_file.write('No revisions to pull.\n')
2344
to_file.write('Now on revision %d.\n' % self.new_revno)
2345
self._show_tag_conficts(to_file)
2348
class PushResult(_Result):
2349
"""Result of a Branch.push operation.
2351
:ivar old_revno: Revision number before push.
2352
:ivar new_revno: Revision number after push.
2353
:ivar old_revid: Tip revision id before push.
2354
:ivar new_revid: Tip revision id after push.
2355
:ivar source_branch: Source branch object.
2356
:ivar master_branch: Master branch of the target, or None.
2357
:ivar target_branch: Target/destination branch object.
2361
# DEPRECATED: push used to return the change in revno
2362
return self.new_revno - self.old_revno
2364
def report(self, to_file):
2365
"""Write a human-readable description of the result."""
2366
if self.old_revid == self.new_revid:
2367
to_file.write('No new revisions to push.\n')
2369
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2370
self._show_tag_conficts(to_file)
2373
class BranchCheckResult(object):
2374
"""Results of checking branch consistency.
2379
def __init__(self, branch):
2380
self.branch = branch
2382
def report_results(self, verbose):
2383
"""Report the check results via trace.note.
2385
:param verbose: Requests more detailed display of what was checked,
2388
note('checked branch %s format %s',
2390
self.branch._format)
2393
class Converter5to6(object):
2394
"""Perform an in-place upgrade of format 5 to format 6"""
2396
def convert(self, branch):
2397
# Data for 5 and 6 can peacefully coexist.
2398
format = BzrBranchFormat6()
2399
new_branch = format.open(branch.bzrdir, _found=True)
2401
# Copy source data into target
2402
new_branch._write_last_revision_info(*branch.last_revision_info())
2403
new_branch.set_parent(branch.get_parent())
2404
new_branch.set_bound_location(branch.get_bound_location())
2405
new_branch.set_push_location(branch.get_push_location())
2407
# New branch has no tags by default
2408
new_branch.tags._set_tag_dict({})
2410
# Copying done; now update target format
2411
new_branch._transport.put_bytes('format',
2412
format.get_format_string(),
2413
mode=new_branch.bzrdir._get_file_mode())
2415
# Clean up old files
2416
new_branch._transport.delete('revision-history')
2418
branch.set_parent(None)
2419
except errors.NoSuchFile:
2421
branch.set_bound_location(None)
2424
class Converter6to7(object):
2425
"""Perform an in-place upgrade of format 6 to format 7"""
2427
def convert(self, branch):
2428
format = BzrBranchFormat7()
2429
branch._set_config_location('stacked_on_location', '')
2430
# update target format
2431
branch._transport.put_bytes('format', format.get_format_string())
added
removed
bzrlib/branch.py
