76
101
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)
88
105
def __init__(self, *ignored, **ignored_too):
89
self.tags = self._make_tags()
90
self._revision_history_cache = None
91
self._revision_id_to_revno_cache = None
92
self._partial_revision_id_to_revno_cache = {}
93
self._last_revision_info_cache = None
94
self._merge_sorted_revisions_cache = None
96
hooks = Branch.hooks['open']
100
def _open_hook(self):
101
"""Called by init to allow simpler extension of the base class."""
103
def break_lock(self):
104
"""Break a lock if one is present from another instance.
106
Uses the ui factory to ask for confirmation if the lock may be from
109
This will probe the repository for its lock as well.
111
self.control_files.break_lock()
112
self.repository.break_lock()
113
master = self.get_master_branch()
114
if master is not None:
118
def open(base, _unsupported=False, possible_transports=None):
119
"""Open the branch rooted at base.
121
For instance, if the branch is at URL/.bzr/branch,
122
Branch.open(URL) -> a Branch instance.
124
control = bzrdir.BzrDir.open(base, _unsupported,
125
possible_transports=possible_transports)
126
return control.open_branch(_unsupported)
129
def open_from_transport(transport, _unsupported=False):
130
"""Open the branch rooted at transport"""
131
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
132
return control.open_branch(_unsupported)
135
def open_containing(url, possible_transports=None):
106
raise NotImplementedError('The Branch class is abstract')
109
def open_downlevel(base):
110
"""Open a branch which may be of an old format.
112
Only local branches are supported."""
113
return BzrBranch(get_transport(base), relax_version_check=True)
117
"""Open an existing branch, rooted at 'base' (url)"""
118
t = get_transport(base)
119
mutter("trying to open %r with transport %r", base, t)
123
def open_containing(url):
136
124
"""Open an existing branch which contains url.
138
126
This probes for a branch at url, and searches upwards from there.
140
128
Basically we keep looking up until we find the control directory or
141
129
run into the root. If there isn't one, raises NotBranchError.
142
If there is one and it is either an unrecognised format or an unsupported
143
format, UnknownFormatError or UnsupportedFormatError are raised.
144
130
If there is one, it is returned, along with the unused portion of url.
146
control, relpath = bzrdir.BzrDir.open_containing(url,
148
return control.open_branch(), relpath
150
def get_config(self):
151
return BranchConfig(self)
153
def _get_nick(self, local=False, possible_transports=None):
154
config = self.get_config()
155
# explicit overrides master, but don't look for master if local is True
156
if not local and not config.has_explicit_nickname():
132
t = get_transport(url)
158
master = self.get_master_branch(possible_transports)
159
if master is not None:
160
# return the master branch value
162
except errors.BzrError, e:
163
# Silently fall back to local implicit nick if the master is
165
mutter("Could not connect to bound branch, "
166
"falling back to local nick.\n " + str(e))
167
return config.get_nickname()
135
return BzrBranch(t), t.relpath(url)
136
except NotBranchError:
138
new_t = t.clone('..')
139
if new_t.base == t.base:
140
# reached the root, whatever that may be
141
raise NotBranchError(path=url)
145
def initialize(base):
146
"""Create a new branch, rooted at 'base' (url)"""
147
t = get_transport(base)
148
return BzrBranch(t, init=True)
150
def setup_caching(self, cache_root):
151
"""Subclasses that care about caching should override this, and set
152
up cached stores located under cache_root.
154
self.cache_root = cache_root
157
cfg = self.tree_config()
158
return cfg.get_option(u"nickname", default=self.base.split('/')[-1])
169
160
def _set_nick(self, nick):
170
self.get_config().set_user_option('nickname', nick, warn_masked=True)
161
cfg = self.tree_config()
162
cfg.set_option(nick, "nickname")
163
assert cfg.get_option("nickname") == nick
172
165
nick = property(_get_nick, _set_nick)
175
raise NotImplementedError(self.is_locked)
167
def push_stores(self, branch_to):
168
"""Copy the content of this branches store to branch_to."""
169
raise NotImplementedError('push_stores is abstract')
171
def get_transaction(self):
172
"""Return the current active transaction.
174
If no transaction is active, this returns a passthrough object
175
for which all data is immediately flushed and no caching happens.
177
raise NotImplementedError('get_transaction is abstract')
177
179
def lock_write(self):
178
raise NotImplementedError(self.lock_write)
180
raise NotImplementedError('lock_write is abstract')
180
182
def lock_read(self):
181
raise NotImplementedError(self.lock_read)
183
raise NotImplementedError('lock_read is abstract')
183
185
def unlock(self):
184
raise NotImplementedError(self.unlock)
186
def peek_lock_mode(self):
187
"""Return lock mode for the Branch: 'r', 'w' or None"""
188
raise NotImplementedError(self.peek_lock_mode)
190
def get_physical_lock_status(self):
191
raise NotImplementedError(self.get_physical_lock_status)
194
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
195
"""Return the revision_id for a dotted revno.
197
:param revno: a tuple like (1,) or (1,1,2)
198
:param _cache_reverse: a private parameter enabling storage
199
of the reverse mapping in a top level cache. (This should
200
only be done in selective circumstances as we want to
201
avoid having the mapping cached multiple times.)
202
:return: the revision_id
203
:raises errors.NoSuchRevision: if the revno doesn't exist
205
rev_id = self._do_dotted_revno_to_revision_id(revno)
207
self._partial_revision_id_to_revno_cache[rev_id] = revno
210
def _do_dotted_revno_to_revision_id(self, revno):
211
"""Worker function for dotted_revno_to_revision_id.
213
Subclasses should override this if they wish to
214
provide a more efficient implementation.
217
return self.get_rev_id(revno[0])
218
revision_id_to_revno = self.get_revision_id_to_revno_map()
219
revision_ids = [revision_id for revision_id, this_revno
220
in revision_id_to_revno.iteritems()
221
if revno == this_revno]
222
if len(revision_ids) == 1:
223
return revision_ids[0]
225
revno_str = '.'.join(map(str, revno))
226
raise errors.NoSuchRevision(self, revno_str)
229
def revision_id_to_dotted_revno(self, revision_id):
230
"""Given a revision id, return its dotted revno.
232
:return: a tuple like (1,) or (400,1,3).
234
return self._do_revision_id_to_dotted_revno(revision_id)
236
def _do_revision_id_to_dotted_revno(self, revision_id):
237
"""Worker function for revision_id_to_revno."""
238
# Try the caches if they are loaded
239
result = self._partial_revision_id_to_revno_cache.get(revision_id)
240
if result is not None:
242
if self._revision_id_to_revno_cache:
243
result = self._revision_id_to_revno_cache.get(revision_id)
245
raise errors.NoSuchRevision(self, revision_id)
246
# Try the mainline as it's optimised
248
revno = self.revision_id_to_revno(revision_id)
250
except errors.NoSuchRevision:
251
# We need to load and use the full revno map after all
252
result = self.get_revision_id_to_revno_map().get(revision_id)
254
raise errors.NoSuchRevision(self, revision_id)
258
def get_revision_id_to_revno_map(self):
259
"""Return the revision_id => dotted revno map.
261
This will be regenerated on demand, but will be cached.
263
:return: A dictionary mapping revision_id => dotted revno.
264
This dictionary should not be modified by the caller.
266
if self._revision_id_to_revno_cache is not None:
267
mapping = self._revision_id_to_revno_cache
269
mapping = self._gen_revno_map()
270
self._cache_revision_id_to_revno(mapping)
271
# TODO: jam 20070417 Since this is being cached, should we be returning
273
# I would rather not, and instead just declare that users should not
274
# modify the return value.
277
def _gen_revno_map(self):
278
"""Create a new mapping from revision ids to dotted revnos.
280
Dotted revnos are generated based on the current tip in the revision
282
This is the worker function for get_revision_id_to_revno_map, which
283
just caches the return value.
285
:return: A dictionary mapping revision_id => dotted revno.
287
revision_id_to_revno = dict((rev_id, revno)
288
for rev_id, depth, revno, end_of_merge
289
in self.iter_merge_sorted_revisions())
290
return revision_id_to_revno
293
def iter_merge_sorted_revisions(self, start_revision_id=None,
294
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
295
"""Walk the revisions for a branch in merge sorted order.
297
Merge sorted order is the output from a merge-aware,
298
topological sort, i.e. all parents come before their
299
children going forward; the opposite for reverse.
301
:param start_revision_id: the revision_id to begin walking from.
302
If None, the branch tip is used.
303
:param stop_revision_id: the revision_id to terminate the walk
304
after. If None, the rest of history is included.
305
:param stop_rule: if stop_revision_id is not None, the precise rule
306
to use for termination:
307
* 'exclude' - leave the stop revision out of the result (default)
308
* 'include' - the stop revision is the last item in the result
309
* 'with-merges' - include the stop revision and all of its
310
merged revisions in the result
311
:param direction: either 'reverse' or 'forward':
312
* reverse means return the start_revision_id first, i.e.
313
start at the most recent revision and go backwards in history
314
* forward returns tuples in the opposite order to reverse.
315
Note in particular that forward does *not* do any intelligent
316
ordering w.r.t. depth as some clients of this API may like.
317
(If required, that ought to be done at higher layers.)
319
:return: an iterator over (revision_id, depth, revno, end_of_merge)
322
* revision_id: the unique id of the revision
323
* depth: How many levels of merging deep this node has been
325
* revno_sequence: This field provides a sequence of
326
revision numbers for all revisions. The format is:
327
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
328
branch that the revno is on. From left to right the REVNO numbers
329
are the sequence numbers within that branch of the revision.
330
* end_of_merge: When True the next node (earlier in history) is
331
part of a different merge.
333
# Note: depth and revno values are in the context of the branch so
334
# we need the full graph to get stable numbers, regardless of the
336
if self._merge_sorted_revisions_cache is None:
337
last_revision = self.last_revision()
338
graph = self.repository.get_graph()
339
parent_map = dict(((key, value) for key, value in
340
graph.iter_ancestry([last_revision]) if value is not None))
341
revision_graph = repository._strip_NULL_ghosts(parent_map)
342
revs = tsort.merge_sort(revision_graph, last_revision, None,
344
# Drop the sequence # before caching
345
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
347
filtered = self._filter_merge_sorted_revisions(
348
self._merge_sorted_revisions_cache, start_revision_id,
349
stop_revision_id, stop_rule)
350
if direction == 'reverse':
352
if direction == 'forward':
353
return reversed(list(filtered))
355
raise ValueError('invalid direction %r' % direction)
357
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
358
start_revision_id, stop_revision_id, stop_rule):
359
"""Iterate over an inclusive range of sorted revisions."""
360
rev_iter = iter(merge_sorted_revisions)
361
if start_revision_id is not None:
362
for rev_id, depth, revno, end_of_merge in rev_iter:
363
if rev_id != start_revision_id:
366
# The decision to include the start or not
367
# depends on the stop_rule if a stop is provided
369
iter([(rev_id, depth, revno, end_of_merge)]),
372
if stop_revision_id is None:
373
for rev_id, depth, revno, end_of_merge in rev_iter:
374
yield rev_id, depth, revno, end_of_merge
375
elif stop_rule == 'exclude':
376
for rev_id, depth, revno, end_of_merge in rev_iter:
377
if rev_id == stop_revision_id:
379
yield rev_id, depth, revno, end_of_merge
380
elif stop_rule == 'include':
381
for rev_id, depth, revno, end_of_merge in rev_iter:
382
yield rev_id, depth, revno, end_of_merge
383
if rev_id == stop_revision_id:
385
elif stop_rule == 'with-merges':
386
stop_rev = self.repository.get_revision(stop_revision_id)
387
if stop_rev.parent_ids:
388
left_parent = stop_rev.parent_ids[0]
390
left_parent = _mod_revision.NULL_REVISION
391
for rev_id, depth, revno, end_of_merge in rev_iter:
392
if rev_id == left_parent:
394
yield rev_id, depth, revno, end_of_merge
396
raise ValueError('invalid stop_rule %r' % stop_rule)
398
def leave_lock_in_place(self):
399
"""Tell this branch object not to release the physical lock when this
402
If lock_write doesn't return a token, then this method is not supported.
404
self.control_files.leave_in_place()
406
def dont_leave_lock_in_place(self):
407
"""Tell this branch object to release the physical lock when this
408
object is unlocked, even if it didn't originally acquire it.
410
If lock_write doesn't return a token, then this method is not supported.
412
self.control_files.dont_leave_in_place()
414
def bind(self, other):
415
"""Bind the local branch the other branch.
417
:param other: The branch to bind to
420
raise errors.UpgradeRequired(self.base)
423
def fetch(self, from_branch, last_revision=None, pb=None):
424
"""Copy revisions from from_branch into this branch.
426
:param from_branch: Where to copy from.
427
:param last_revision: What revision to stop at (None for at the end
429
:param pb: An optional progress bar to use.
431
Returns the copied revision count and the failed revisions in a tuple:
434
if self.base == from_branch.base:
437
nested_pb = ui.ui_factory.nested_progress_bar()
442
from_branch.lock_read()
444
if last_revision is None:
445
pb.update('get source history')
446
last_revision = from_branch.last_revision()
447
last_revision = _mod_revision.ensure_null(last_revision)
448
return self.repository.fetch(from_branch.repository,
449
revision_id=last_revision,
452
if nested_pb is not None:
456
def get_bound_location(self):
457
"""Return the URL of the branch we are bound to.
459
Older format branches cannot bind, please be sure to use a metadir
464
def get_old_bound_location(self):
465
"""Return the URL of the branch we used to be bound to
467
raise errors.UpgradeRequired(self.base)
469
def get_commit_builder(self, parents, config=None, timestamp=None,
470
timezone=None, committer=None, revprops=None,
472
"""Obtain a CommitBuilder for this branch.
474
:param parents: Revision ids of the parents of the new revision.
475
:param config: Optional configuration to use.
476
:param timestamp: Optional timestamp recorded for commit.
477
:param timezone: Optional timezone for timestamp.
478
:param committer: Optional committer to set for commit.
479
:param revprops: Optional dictionary of revision properties.
480
:param revision_id: Optional revision id.
484
config = self.get_config()
486
return self.repository.get_commit_builder(self, parents, config,
487
timestamp, timezone, committer, revprops, revision_id)
489
def get_master_branch(self, possible_transports=None):
490
"""Return the branch we are bound to.
492
:return: Either a Branch, or None
186
raise NotImplementedError('unlock is abstract')
188
def abspath(self, name):
189
"""Return absolute filename for something in the branch
191
XXX: Robert Collins 20051017 what is this used for? why is it a branch
192
method and not a tree method.
194
raise NotImplementedError('abspath is abstract')
196
def controlfilename(self, file_or_path):
197
"""Return location relative to branch."""
198
raise NotImplementedError('controlfilename is abstract')
200
def controlfile(self, file_or_path, mode='r'):
201
"""Open a control file for this branch.
203
There are two classes of file in the control directory: text
204
and binary. binary files are untranslated byte streams. Text
205
control files are stored with Unix newlines and in UTF-8, even
206
if the platform or locale defaults are different.
208
Controlfiles should almost never be opened in write mode but
209
rather should be atomically copied and replaced using atomicfile.
211
raise NotImplementedError('controlfile is abstract')
213
def put_controlfile(self, path, f, encode=True):
214
"""Write an entry as a controlfile.
216
:param path: The path to put the file, relative to the .bzr control
218
:param f: A file-like or string object whose contents should be copied.
219
:param encode: If true, encode the contents as utf-8
221
raise NotImplementedError('put_controlfile is abstract')
223
def put_controlfiles(self, files, encode=True):
224
"""Write several entries as controlfiles.
226
:param files: A list of [(path, file)] pairs, where the path is the directory
227
underneath the bzr control directory
228
:param encode: If true, encode the contents as utf-8
230
raise NotImplementedError('put_controlfiles is abstract')
232
def get_root_id(self):
233
"""Return the id of this branches root"""
234
raise NotImplementedError('get_root_id is abstract')
236
def set_root_id(self, file_id):
237
raise NotImplementedError('set_root_id is abstract')
239
def print_file(self, file, revno):
240
"""Print `file` to stdout."""
241
raise NotImplementedError('print_file is abstract')
243
def append_revision(self, *revision_ids):
244
raise NotImplementedError('append_revision is abstract')
246
def set_revision_history(self, rev_history):
247
raise NotImplementedError('set_revision_history is abstract')
249
def has_revision(self, revision_id):
250
"""True if this branch has a copy of the revision.
252
This does not necessarily imply the revision is merge
253
or on the mainline."""
254
raise NotImplementedError('has_revision is abstract')
256
def get_revision_xml(self, revision_id):
257
raise NotImplementedError('get_revision_xml is abstract')
259
def get_revision(self, revision_id):
260
"""Return the Revision object for a named revision"""
261
raise NotImplementedError('get_revision is abstract')
496
263
def get_revision_delta(self, revno):
497
264
"""Return the delta for one revision.
844
479
Zero (the NULL revision) is considered invalid
846
481
if revno < 1 or revno > self.revno():
847
raise errors.InvalidRevisionNumber(revno)
850
def clone(self, to_bzrdir, revision_id=None):
851
"""Clone this branch into to_bzrdir preserving all semantic values.
853
revision_id: if not None, the revision history in the new branch will
854
be truncated to end with revision_id.
856
result = to_bzrdir.create_branch()
857
self.copy_content_into(result, revision_id=revision_id)
861
def sprout(self, to_bzrdir, revision_id=None):
862
"""Create a new line of development from the branch, into to_bzrdir.
864
to_bzrdir controls the branch format.
866
revision_id: if not None, the revision history in the new branch will
867
be truncated to end with revision_id.
869
result = to_bzrdir.create_branch()
870
self.copy_content_into(result, revision_id=revision_id)
871
result.set_parent(self.bzrdir.root_transport.base)
874
def _synchronize_history(self, destination, revision_id):
875
"""Synchronize last revision and revision history between branches.
877
This version is most efficient when the destination is also a
878
BzrBranch6, but works for BzrBranch5, as long as the destination's
879
repository contains all the lefthand ancestors of the intended
880
last_revision. If not, set_last_revision_info will fail.
882
:param destination: The branch to copy the history into
883
:param revision_id: The revision-id to truncate history at. May
884
be None to copy complete history.
886
source_revno, source_revision_id = self.last_revision_info()
887
if revision_id is None:
888
revno, revision_id = source_revno, source_revision_id
889
elif source_revision_id == revision_id:
890
# we know the revno without needing to walk all of history
893
# To figure out the revno for a random revision, we need to build
894
# the revision history, and count its length.
895
# We don't care about the order, just how long it is.
896
# Alternatively, we could start at the current location, and count
897
# backwards. But there is no guarantee that we will find it since
898
# it may be a merged revision.
899
revno = len(list(self.repository.iter_reverse_revision_history(
901
destination.set_last_revision_info(revno, revision_id)
904
def copy_content_into(self, destination, revision_id=None):
905
"""Copy the content of self into destination.
907
revision_id: if not None, the revision history in the new branch will
908
be truncated to end with revision_id.
910
self._synchronize_history(destination, revision_id)
912
parent = self.get_parent()
913
except errors.InaccessibleParent, e:
914
mutter('parent was not accessible to copy: %s', e)
917
destination.set_parent(parent)
918
self.tags.merge_to(destination.tags)
922
"""Check consistency of the branch.
924
In particular this checks that revisions given in the revision-history
925
do actually match up in the revision graph, and that they're all
926
present in the repository.
928
Callers will typically also want to check the repository.
930
:return: A BranchCheckResult.
932
mainline_parent_id = None
933
last_revno, last_revision_id = self.last_revision_info()
934
real_rev_history = list(self.repository.iter_reverse_revision_history(
936
real_rev_history.reverse()
937
if len(real_rev_history) != last_revno:
938
raise errors.BzrCheckError('revno does not match len(mainline)'
939
' %s != %s' % (last_revno, len(real_rev_history)))
940
# TODO: We should probably also check that real_rev_history actually
941
# matches self.revision_history()
942
for revision_id in real_rev_history:
944
revision = self.repository.get_revision(revision_id)
945
except errors.NoSuchRevision, e:
946
raise errors.BzrCheckError("mainline revision {%s} not in repository"
948
# In general the first entry on the revision history has no parents.
949
# But it's not illegal for it to have parents listed; this can happen
950
# in imports from Arch when the parents weren't reachable.
951
if mainline_parent_id is not None:
952
if mainline_parent_id not in revision.parent_ids:
953
raise errors.BzrCheckError("previous revision {%s} not listed among "
955
% (mainline_parent_id, revision_id))
956
mainline_parent_id = revision_id
957
return BranchCheckResult(self)
959
def _get_checkout_format(self):
960
"""Return the most suitable metadir for a checkout of this branch.
961
Weaves are used if this branch's repository uses weaves.
963
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
964
from bzrlib.repofmt import weaverepo
965
format = bzrdir.BzrDirMetaFormat1()
966
format.repository_format = weaverepo.RepositoryFormat7()
968
format = self.repository.bzrdir.checkout_metadir()
969
format.set_branch_format(self._format)
972
def create_checkout(self, to_location, revision_id=None,
973
lightweight=False, accelerator_tree=None,
975
"""Create a checkout of a branch.
977
:param to_location: The url to produce the checkout at
978
:param revision_id: The revision to check out
979
:param lightweight: If True, produce a lightweight checkout, otherwise,
980
produce a bound branch (heavyweight checkout)
981
:param accelerator_tree: A tree which can be used for retrieving file
982
contents more quickly than the revision tree, i.e. a workingtree.
983
The revision tree will be used for cases where accelerator_tree's
984
content is different.
985
:param hardlink: If true, hard-link files from accelerator_tree,
987
:return: The tree of the created checkout
989
t = transport.get_transport(to_location)
992
format = self._get_checkout_format()
993
checkout = format.initialize_on_transport(t)
994
from_branch = BranchReferenceFormat().initialize(checkout, self)
996
format = self._get_checkout_format()
997
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
998
to_location, force_new_tree=False, format=format)
999
checkout = checkout_branch.bzrdir
1000
checkout_branch.bind(self)
1001
# pull up to the specified revision_id to set the initial
1002
# branch tip correctly, and seed it with history.
1003
checkout_branch.pull(self, stop_revision=revision_id)
1005
tree = checkout.create_workingtree(revision_id,
1006
from_branch=from_branch,
1007
accelerator_tree=accelerator_tree,
1009
basis_tree = tree.basis_tree()
1010
basis_tree.lock_read()
1012
for path, file_id in basis_tree.iter_references():
1013
reference_parent = self.reference_parent(file_id, path)
1014
reference_parent.create_checkout(tree.abspath(path),
1015
basis_tree.get_reference_revision(file_id, path),
1022
def reconcile(self, thorough=True):
1023
"""Make sure the data stored in this branch is consistent."""
1024
from bzrlib.reconcile import BranchReconciler
1025
reconciler = BranchReconciler(self, thorough=thorough)
1026
reconciler.reconcile()
1029
def reference_parent(self, file_id, path):
1030
"""Return the parent branch for a tree-reference file_id
1031
:param file_id: The file_id of the tree reference
1032
:param path: The path of the file_id in the tree
1033
:return: A branch associated with the file_id
1035
# FIXME should provide multiple branches, based on config
1036
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1038
def supports_tags(self):
1039
return self._format.supports_tags()
1041
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1043
"""Ensure that revision_b is a descendant of revision_a.
1045
This is a helper function for update_revisions.
1047
:raises: DivergedBranches if revision_b has diverged from revision_a.
1048
:returns: True if revision_b is a descendant of revision_a.
1050
relation = self._revision_relations(revision_a, revision_b, graph)
1051
if relation == 'b_descends_from_a':
1053
elif relation == 'diverged':
1054
raise errors.DivergedBranches(self, other_branch)
1055
elif relation == 'a_descends_from_b':
1058
raise AssertionError("invalid relation: %r" % (relation,))
1060
def _revision_relations(self, revision_a, revision_b, graph):
1061
"""Determine the relationship between two revisions.
1063
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1065
heads = graph.heads([revision_a, revision_b])
1066
if heads == set([revision_b]):
1067
return 'b_descends_from_a'
1068
elif heads == set([revision_a, revision_b]):
1069
# These branches have diverged
1071
elif heads == set([revision_a]):
1072
return 'a_descends_from_b'
1074
raise AssertionError("invalid heads: %r" % (heads,))
1077
class BranchFormat(object):
1078
"""An encapsulation of the initialization and open routines for a format.
1080
Formats provide three things:
1081
* An initialization routine,
1085
Formats are placed in an dict by their format string for reference
1086
during branch opening. Its not required that these be instances, they
1087
can be classes themselves with class methods - it simply depends on
1088
whether state is needed for a given format or not.
1090
Once a format is deprecated, just deprecate the initialize and open
1091
methods on the format class. Do not deprecate the object, as the
1092
object will be created every time regardless.
1095
_default_format = None
1096
"""The default format used for new branches."""
1099
"""The known formats."""
1101
def __eq__(self, other):
1102
return self.__class__ is other.__class__
1104
def __ne__(self, other):
1105
return not (self == other)
1108
def find_format(klass, a_bzrdir):
1109
"""Return the format for the branch object in a_bzrdir."""
1111
transport = a_bzrdir.get_branch_transport(None)
1112
format_string = transport.get("format").read()
1113
return klass._formats[format_string]
1114
except errors.NoSuchFile:
1115
raise errors.NotBranchError(path=transport.base)
1117
raise errors.UnknownFormatError(format=format_string, kind='branch')
1120
def get_default_format(klass):
1121
"""Return the current default format."""
1122
return klass._default_format
1124
def get_reference(self, a_bzrdir):
1125
"""Get the target reference of the branch in a_bzrdir.
1127
format probing must have been completed before calling
1128
this method - it is assumed that the format of the branch
1129
in a_bzrdir is correct.
1131
:param a_bzrdir: The bzrdir to get the branch data from.
1132
:return: None if the branch is not a reference branch.
1137
def set_reference(self, a_bzrdir, to_branch):
1138
"""Set the target reference of the branch in a_bzrdir.
1140
format probing must have been completed before calling
1141
this method - it is assumed that the format of the branch
1142
in a_bzrdir is correct.
1144
:param a_bzrdir: The bzrdir to set the branch reference for.
1145
:param to_branch: branch that the checkout is to reference
1147
raise NotImplementedError(self.set_reference)
1149
def get_format_string(self):
1150
"""Return the ASCII format string that identifies this format."""
1151
raise NotImplementedError(self.get_format_string)
1153
def get_format_description(self):
1154
"""Return the short format description for this format."""
1155
raise NotImplementedError(self.get_format_description)
1157
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1159
"""Initialize a branch in a bzrdir, with specified files
1161
:param a_bzrdir: The bzrdir to initialize the branch in
1162
:param utf8_files: The files to create as a list of
1163
(filename, content) tuples
1164
:param set_format: If True, set the format with
1165
self.get_format_string. (BzrBranch4 has its format set
1167
:return: a branch in this format
1169
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1170
branch_transport = a_bzrdir.get_branch_transport(self)
1172
'metadir': ('lock', lockdir.LockDir),
1173
'branch4': ('branch-lock', lockable_files.TransportLock),
1175
lock_name, lock_class = lock_map[lock_type]
1176
control_files = lockable_files.LockableFiles(branch_transport,
1177
lock_name, lock_class)
1178
control_files.create_lock()
1179
control_files.lock_write()
1181
utf8_files += [('format', self.get_format_string())]
1183
for (filename, content) in utf8_files:
1184
branch_transport.put_bytes(
1186
mode=a_bzrdir._get_file_mode())
1188
control_files.unlock()
1189
return self.open(a_bzrdir, _found=True)
1191
def initialize(self, a_bzrdir):
1192
"""Create a branch of this format in a_bzrdir."""
1193
raise NotImplementedError(self.initialize)
1195
def is_supported(self):
1196
"""Is this format supported?
1198
Supported formats can be initialized and opened.
1199
Unsupported formats may not support initialization or committing or
1200
some other features depending on the reason for not being supported.
1204
def open(self, a_bzrdir, _found=False):
1205
"""Return the branch object for a_bzrdir
1207
_found is a private parameter, do not use it. It is used to indicate
1208
if format probing has already be done.
1210
raise NotImplementedError(self.open)
1213
def register_format(klass, format):
1214
klass._formats[format.get_format_string()] = format
1217
def set_default_format(klass, format):
1218
klass._default_format = format
1220
def supports_stacking(self):
1221
"""True if this format records a stacked-on branch."""
1225
def unregister_format(klass, format):
1226
del klass._formats[format.get_format_string()]
1229
return self.get_format_string().rstrip()
1231
def supports_tags(self):
1232
"""True if this format supports tags stored in the branch"""
1233
return False # by default
1236
class BranchHooks(Hooks):
1237
"""A dictionary mapping hook name to a list of callables for branch hooks.
1239
e.g. ['set_rh'] Is the list of items to be called when the
1240
set_revision_history function is invoked.
1244
"""Create the default hooks.
1246
These are all empty initially, because by default nothing should get
1249
Hooks.__init__(self)
1250
# Introduced in 0.15:
1251
# invoked whenever the revision history has been set
1252
# with set_revision_history. The api signature is
1253
# (branch, revision_history), and the branch will
1256
# Invoked after a branch is opened. The api signature is (branch).
1258
# invoked after a push operation completes.
1259
# the api signature is
1261
# containing the members
1262
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1263
# where local is the local target branch or None, master is the target
1264
# master branch, and the rest should be self explanatory. The source
1265
# is read locked and the target branches write locked. Source will
1266
# be the local low-latency branch.
1267
self['post_push'] = []
1268
# invoked after a pull operation completes.
1269
# the api signature is
1271
# containing the members
1272
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1273
# where local is the local branch or None, master is the target
1274
# master branch, and the rest should be self explanatory. The source
1275
# is read locked and the target branches write locked. The local
1276
# branch is the low-latency branch.
1277
self['post_pull'] = []
1278
# invoked before a commit operation takes place.
1279
# the api signature is
1280
# (local, master, old_revno, old_revid, future_revno, future_revid,
1281
# tree_delta, future_tree).
1282
# old_revid is NULL_REVISION for the first commit to a branch
1283
# tree_delta is a TreeDelta object describing changes from the basis
1284
# revision, hooks MUST NOT modify this delta
1285
# future_tree is an in-memory tree obtained from
1286
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1287
self['pre_commit'] = []
1288
# invoked after a commit operation completes.
1289
# the api signature is
1290
# (local, master, old_revno, old_revid, new_revno, new_revid)
1291
# old_revid is NULL_REVISION for the first commit to a branch.
1292
self['post_commit'] = []
1293
# invoked after a uncommit operation completes.
1294
# the api signature is
1295
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1296
# local is the local branch or None, master is the target branch,
1297
# and an empty branch recieves new_revno of 0, new_revid of None.
1298
self['post_uncommit'] = []
1300
# Invoked before the tip of a branch changes.
1301
# the api signature is
1302
# (params) where params is a ChangeBranchTipParams with the members
1303
# (branch, old_revno, new_revno, old_revid, new_revid)
1304
self['pre_change_branch_tip'] = []
1306
# Invoked after the tip of a branch changes.
1307
# the api signature is
1308
# (params) where params is a ChangeBranchTipParams with the members
1309
# (branch, old_revno, new_revno, old_revid, new_revid)
1310
self['post_change_branch_tip'] = []
1312
# Invoked when a stacked branch activates its fallback locations and
1313
# allows the transformation of the url of said location.
1314
# the api signature is
1315
# (branch, url) where branch is the branch having its fallback
1316
# location activated and url is the url for the fallback location.
1317
# The hook should return a url.
1318
self['transform_fallback_location'] = []
1321
# install the default hooks into the Branch class.
1322
Branch.hooks = BranchHooks()
1325
class ChangeBranchTipParams(object):
1326
"""Object holding parameters passed to *_change_branch_tip hooks.
1328
There are 5 fields that hooks may wish to access:
1330
:ivar branch: the branch being changed
1331
:ivar old_revno: revision number before the change
1332
:ivar new_revno: revision number after the change
1333
:ivar old_revid: revision id before the change
1334
:ivar new_revid: revision id after the change
1336
The revid fields are strings. The revno fields are integers.
1339
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1340
"""Create a group of ChangeBranchTip parameters.
1342
:param branch: The branch being changed.
1343
:param old_revno: Revision number before the change.
1344
:param new_revno: Revision number after the change.
1345
:param old_revid: Tip revision id before the change.
1346
:param new_revid: Tip revision id after the change.
1348
self.branch = branch
1349
self.old_revno = old_revno
1350
self.new_revno = new_revno
1351
self.old_revid = old_revid
1352
self.new_revid = new_revid
1354
def __eq__(self, other):
1355
return self.__dict__ == other.__dict__
1358
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1359
self.__class__.__name__, self.branch,
1360
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1363
class BzrBranchFormat4(BranchFormat):
1364
"""Bzr branch format 4.
1367
- a revision-history file.
1368
- a branch-lock lock file [ to be shared with the bzrdir ]
1371
def get_format_description(self):
1372
"""See BranchFormat.get_format_description()."""
1373
return "Branch format 4"
1375
def initialize(self, a_bzrdir):
1376
"""Create a branch of this format in a_bzrdir."""
1377
utf8_files = [('revision-history', ''),
1378
('branch-name', ''),
1380
return self._initialize_helper(a_bzrdir, utf8_files,
1381
lock_type='branch4', set_format=False)
1384
super(BzrBranchFormat4, self).__init__()
1385
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1387
def open(self, a_bzrdir, _found=False):
1388
"""Return the branch object for a_bzrdir
1390
_found is a private parameter, do not use it. It is used to indicate
1391
if format probing has already be done.
1394
# we are being called directly and must probe.
1395
raise NotImplementedError
1396
return BzrBranch(_format=self,
1397
_control_files=a_bzrdir._control_files,
1399
_repository=a_bzrdir.open_repository())
1402
return "Bazaar-NG branch format 4"
1405
class BranchFormatMetadir(BranchFormat):
1406
"""Common logic for meta-dir based branch formats."""
1408
def _branch_class(self):
1409
"""What class to instantiate on open calls."""
1410
raise NotImplementedError(self._branch_class)
1412
def open(self, a_bzrdir, _found=False):
1413
"""Return the branch object for a_bzrdir.
1415
_found is a private parameter, do not use it. It is used to indicate
1416
if format probing has already be done.
1419
format = BranchFormat.find_format(a_bzrdir)
1420
if format.__class__ != self.__class__:
1421
raise AssertionError("wrong format %r found for %r" %
1424
transport = a_bzrdir.get_branch_transport(None)
1425
control_files = lockable_files.LockableFiles(transport, 'lock',
1427
return self._branch_class()(_format=self,
1428
_control_files=control_files,
1430
_repository=a_bzrdir.find_repository())
1431
except errors.NoSuchFile:
1432
raise errors.NotBranchError(path=transport.base)
1435
super(BranchFormatMetadir, self).__init__()
1436
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1437
self._matchingbzrdir.set_branch_format(self)
1439
def supports_tags(self):
1443
class BzrBranchFormat5(BranchFormatMetadir):
1444
"""Bzr branch format 5.
1447
- a revision-history file.
1449
- a lock dir guarding the branch itself
1450
- all of this stored in a branch/ subdirectory
1451
- works with shared repositories.
1453
This format is new in bzr 0.8.
1456
def _branch_class(self):
1459
def get_format_string(self):
1460
"""See BranchFormat.get_format_string()."""
1461
return "Bazaar-NG branch format 5\n"
1463
def get_format_description(self):
1464
"""See BranchFormat.get_format_description()."""
1465
return "Branch format 5"
1467
def initialize(self, a_bzrdir):
1468
"""Create a branch of this format in a_bzrdir."""
1469
utf8_files = [('revision-history', ''),
1470
('branch-name', ''),
1472
return self._initialize_helper(a_bzrdir, utf8_files)
1474
def supports_tags(self):
1478
class BzrBranchFormat6(BranchFormatMetadir):
1479
"""Branch format with last-revision and tags.
1481
Unlike previous formats, this has no explicit revision history. Instead,
1482
this just stores the last-revision, and the left-hand history leading
1483
up to there is the history.
1485
This format was introduced in bzr 0.15
1486
and became the default in 0.91.
1489
def _branch_class(self):
1492
def get_format_string(self):
1493
"""See BranchFormat.get_format_string()."""
1494
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1496
def get_format_description(self):
1497
"""See BranchFormat.get_format_description()."""
1498
return "Branch format 6"
1500
def initialize(self, a_bzrdir):
1501
"""Create a branch of this format in a_bzrdir."""
1502
utf8_files = [('last-revision', '0 null:\n'),
1503
('branch.conf', ''),
1506
return self._initialize_helper(a_bzrdir, utf8_files)
1509
class BzrBranchFormat7(BranchFormatMetadir):
1510
"""Branch format with last-revision, tags, and a stacked location pointer.
1512
The stacked location pointer is passed down to the repository and requires
1513
a repository format with supports_external_lookups = True.
1515
This format was introduced in bzr 1.6.
1518
def _branch_class(self):
1521
def get_format_string(self):
1522
"""See BranchFormat.get_format_string()."""
1523
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1525
def get_format_description(self):
1526
"""See BranchFormat.get_format_description()."""
1527
return "Branch format 7"
1529
def initialize(self, a_bzrdir):
1530
"""Create a branch of this format in a_bzrdir."""
1531
utf8_files = [('last-revision', '0 null:\n'),
1532
('branch.conf', ''),
1535
return self._initialize_helper(a_bzrdir, utf8_files)
1538
super(BzrBranchFormat7, self).__init__()
1539
self._matchingbzrdir.repository_format = \
1540
RepositoryFormatKnitPack5RichRoot()
1542
def supports_stacking(self):
1546
class BranchReferenceFormat(BranchFormat):
1547
"""Bzr branch reference format.
1549
Branch references are used in implementing checkouts, they
1550
act as an alias to the real branch which is at some other url.
1557
def get_format_string(self):
1558
"""See BranchFormat.get_format_string()."""
1559
return "Bazaar-NG Branch Reference Format 1\n"
1561
def get_format_description(self):
1562
"""See BranchFormat.get_format_description()."""
1563
return "Checkout reference format 1"
1565
def get_reference(self, a_bzrdir):
1566
"""See BranchFormat.get_reference()."""
1567
transport = a_bzrdir.get_branch_transport(None)
1568
return transport.get('location').read()
1570
def set_reference(self, a_bzrdir, to_branch):
1571
"""See BranchFormat.set_reference()."""
1572
transport = a_bzrdir.get_branch_transport(None)
1573
location = transport.put_bytes('location', to_branch.base)
1575
def initialize(self, a_bzrdir, target_branch=None):
1576
"""Create a branch of this format in a_bzrdir."""
1577
if target_branch is None:
1578
# this format does not implement branch itself, thus the implicit
1579
# creation contract must see it as uninitializable
1580
raise errors.UninitializableFormat(self)
1581
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1582
branch_transport = a_bzrdir.get_branch_transport(self)
1583
branch_transport.put_bytes('location',
1584
target_branch.bzrdir.root_transport.base)
1585
branch_transport.put_bytes('format', self.get_format_string())
1587
a_bzrdir, _found=True,
1588
possible_transports=[target_branch.bzrdir.root_transport])
1591
super(BranchReferenceFormat, self).__init__()
1592
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1593
self._matchingbzrdir.set_branch_format(self)
1595
def _make_reference_clone_function(format, a_branch):
1596
"""Create a clone() routine for a branch dynamically."""
1597
def clone(to_bzrdir, revision_id=None):
1598
"""See Branch.clone()."""
1599
return format.initialize(to_bzrdir, a_branch)
1600
# cannot obey revision_id limits when cloning a reference ...
1601
# FIXME RBC 20060210 either nuke revision_id for clone, or
1602
# emit some sort of warning/error to the caller ?!
1605
def open(self, a_bzrdir, _found=False, location=None,
1606
possible_transports=None):
1607
"""Return the branch that the branch reference in a_bzrdir points at.
1609
_found is a private parameter, do not use it. It is used to indicate
1610
if format probing has already be done.
1613
format = BranchFormat.find_format(a_bzrdir)
1614
if format.__class__ != self.__class__:
1615
raise AssertionError("wrong format %r found for %r" %
1617
if location is None:
1618
location = self.get_reference(a_bzrdir)
1619
real_bzrdir = bzrdir.BzrDir.open(
1620
location, possible_transports=possible_transports)
1621
result = real_bzrdir.open_branch()
1622
# this changes the behaviour of result.clone to create a new reference
1623
# rather than a copy of the content of the branch.
1624
# I did not use a proxy object because that needs much more extensive
1625
# testing, and we are only changing one behaviour at the moment.
1626
# If we decide to alter more behaviours - i.e. the implicit nickname
1627
# then this should be refactored to introduce a tested proxy branch
1628
# and a subclass of that for use in overriding clone() and ....
1630
result.clone = self._make_reference_clone_function(result)
1634
# formats which have no format string are not discoverable
1635
# and not independently creatable, so are not registered.
1636
__format5 = BzrBranchFormat5()
1637
__format6 = BzrBranchFormat6()
1638
__format7 = BzrBranchFormat7()
1639
BranchFormat.register_format(__format5)
1640
BranchFormat.register_format(BranchReferenceFormat())
1641
BranchFormat.register_format(__format6)
1642
BranchFormat.register_format(__format7)
1643
BranchFormat.set_default_format(__format6)
1644
_legacy_formats = [BzrBranchFormat4(),
482
raise InvalidRevisionNumber(revno)
484
def sign_revision(self, revision_id, gpg_strategy):
485
raise NotImplementedError('sign_revision is abstract')
487
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
488
raise NotImplementedError('store_revision_signature is abstract')
1647
490
class BzrBranch(Branch):
1648
491
"""A branch stored in the actual filesystem.
1651
494
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1652
495
it's writable, and can be accessed via the normal filesystem API.
1654
:ivar _transport: Transport for file operations on this branch's
1655
control files, typically pointing to the .bzr/branch directory.
1656
:ivar repository: Repository for this branch.
1657
:ivar base: The url of the base directory for this branch; the one
1658
containing the .bzr directory.
501
If _lock_mode is true, a positive count of the number of times the
505
Lock object from bzrlib.lock.
507
# We actually expect this class to be somewhat short-lived; part of its
508
# purpose is to try to isolate what bits of the branch logic are tied to
509
# filesystem access, so that in a later step, we can extricate them to
510
# a separarte ("storage") class.
514
_inventory_weave = None
1661
def __init__(self, _format=None,
1662
_control_files=None, a_bzrdir=None, _repository=None):
1663
"""Create new branch object at a particular location."""
1664
if a_bzrdir is None:
1665
raise ValueError('a_bzrdir must be supplied')
1667
self.bzrdir = a_bzrdir
1668
self._base = self.bzrdir.transport.clone('..').base
1669
# XXX: We should be able to just do
1670
# self.base = self.bzrdir.root_transport.base
1671
# but this does not quite work yet -- mbp 20080522
1672
self._format = _format
1673
if _control_files is None:
1674
raise ValueError('BzrBranch _control_files is None')
1675
self.control_files = _control_files
1676
self._transport = _control_files._transport
1677
self.repository = _repository
1678
Branch.__init__(self)
516
# Map some sort of prefix into a namespace
517
# stuff like "revno:10", "revid:", etc.
518
# This should match a prefix with a function which accepts
519
REVISION_NAMESPACES = {}
521
def push_stores(self, branch_to):
522
"""See Branch.push_stores."""
523
if (self._branch_format != branch_to._branch_format
524
or self._branch_format != 4):
525
from bzrlib.fetch import greedy_fetch
526
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
527
self, self._branch_format, branch_to, branch_to._branch_format)
528
greedy_fetch(to_branch=branch_to, from_branch=self,
529
revision=self.last_revision())
532
store_pairs = ((self.text_store, branch_to.text_store),
533
(self.inventory_store, branch_to.inventory_store),
534
(self.revision_store, branch_to.revision_store))
536
for from_store, to_store in store_pairs:
537
copy_all(from_store, to_store)
538
except UnlistableStore:
539
raise UnlistableBranch(from_store)
541
def __init__(self, transport, init=False,
542
relax_version_check=False):
543
"""Create new branch object at a particular location.
545
transport -- A Transport object, defining how to access files.
547
init -- If True, create new control files in a previously
548
unversioned directory. If False, the branch must already
551
relax_version_check -- If true, the usual check for the branch
552
version is not applied. This is intended only for
553
upgrade/recovery type use; it's not guaranteed that
554
all operations will work on old format branches.
556
In the test suite, creation of new trees is tested using the
557
`ScratchBranch` class.
559
assert isinstance(transport, Transport), \
560
"%r is not a Transport" % transport
561
self._transport = transport
564
self._check_format(relax_version_check)
566
def get_store(name, compressed=True, prefixed=False):
567
# FIXME: This approach of assuming stores are all entirely compressed
568
# or entirely uncompressed is tidy, but breaks upgrade from
569
# some existing branches where there's a mixture; we probably
570
# still want the option to look for both.
571
relpath = self._rel_controlfilename(name)
572
store = TextStore(self._transport.clone(relpath),
574
compressed=compressed)
575
#if self._transport.should_cache():
576
# cache_path = os.path.join(self.cache_root, name)
577
# os.mkdir(cache_path)
578
# store = bzrlib.store.CachedStore(store, cache_path)
580
def get_weave(name, prefixed=False):
581
relpath = self._rel_controlfilename(name)
582
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
583
if self._transport.should_cache():
584
ws.enable_cache = True
587
if self._branch_format == 4:
588
self.inventory_store = get_store(u'inventory-store')
589
self.text_store = get_store(u'text-store')
590
self.revision_store = get_store(u'revision-store')
591
elif self._branch_format == 5:
592
self.control_weaves = get_weave(u'')
593
self.weave_store = get_weave(u'weaves')
594
self.revision_store = get_store(u'revision-store', compressed=False)
595
elif self._branch_format == 6:
596
self.control_weaves = get_weave(u'')
597
self.weave_store = get_weave(u'weaves', prefixed=True)
598
self.revision_store = get_store(u'revision-store', compressed=False,
600
self.revision_store.register_suffix('sig')
601
self._transaction = None
1680
603
def __str__(self):
1681
return '%s(%r)' % (self.__class__.__name__, self.base)
604
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
1683
606
__repr__ = __str__
609
if self._lock_mode or self._lock:
610
# XXX: This should show something every time, and be suitable for
611
# headless operation and embedding
612
warn("branch %r was not explicitly unlocked" % self)
615
# TODO: It might be best to do this somewhere else,
616
# but it is nice for a Branch object to automatically
617
# cache it's information.
618
# Alternatively, we could have the Transport objects cache requests
619
# See the earlier discussion about how major objects (like Branch)
620
# should never expect their __del__ function to run.
621
if hasattr(self, 'cache_root') and self.cache_root is not None:
623
shutil.rmtree(self.cache_root)
626
self.cache_root = None
1685
628
def _get_base(self):
1686
"""Returns the directory containing the control directory."""
630
return self._transport.base
1689
633
base = property(_get_base, doc="The URL for the root of this branch.")
1691
def is_locked(self):
1692
return self.control_files.is_locked()
1694
def lock_write(self, token=None):
1695
repo_token = self.repository.lock_write()
1697
token = self.control_files.lock_write(token=token)
1699
self.repository.unlock()
635
def _finish_transaction(self):
636
"""Exit the current transaction."""
637
if self._transaction is None:
638
raise errors.LockError('Branch %s is not in a transaction' %
640
transaction = self._transaction
641
self._transaction = None
644
def get_transaction(self):
645
"""See Branch.get_transaction."""
646
if self._transaction is None:
647
return transactions.PassThroughTransaction()
649
return self._transaction
651
def _set_transaction(self, new_transaction):
652
"""Set a new active transaction."""
653
if self._transaction is not None:
654
raise errors.LockError('Branch %s is in a transaction already.' %
656
self._transaction = new_transaction
658
def lock_write(self):
659
mutter("lock write: %s (%s)", self, self._lock_count)
660
# TODO: Upgrade locking to support using a Transport,
661
# and potentially a remote locking protocol
663
if self._lock_mode != 'w':
664
raise LockError("can't upgrade to a write lock from %r" %
666
self._lock_count += 1
668
self._lock = self._transport.lock_write(
669
self._rel_controlfilename('branch-lock'))
670
self._lock_mode = 'w'
672
self._set_transaction(transactions.PassThroughTransaction())
1703
674
def lock_read(self):
1704
self.repository.lock_read()
1706
self.control_files.lock_read()
1708
self.repository.unlock()
675
mutter("lock read: %s (%s)", self, self._lock_count)
677
assert self._lock_mode in ('r', 'w'), \
678
"invalid lock mode %r" % self._lock_mode
679
self._lock_count += 1
681
self._lock = self._transport.lock_read(
682
self._rel_controlfilename('branch-lock'))
683
self._lock_mode = 'r'
685
self._set_transaction(transactions.ReadOnlyTransaction())
686
# 5K may be excessive, but hey, its a knob.
687
self.get_transaction().set_cache_size(5000)
1711
689
def unlock(self):
1712
# TODO: test for failed two phase locks. This is known broken.
1714
self.control_files.unlock()
1716
self.repository.unlock()
1717
if not self.control_files.is_locked():
1718
# we just released the lock
1719
self._clear_cached_state()
690
mutter("unlock: %s (%s)", self, self._lock_count)
691
if not self._lock_mode:
692
raise LockError('branch %r is not locked' % (self))
694
if self._lock_count > 1:
695
self._lock_count -= 1
697
self._finish_transaction()
700
self._lock_mode = self._lock_count = None
702
def abspath(self, name):
703
"""See Branch.abspath."""
704
return self._transport.abspath(name)
706
def _rel_controlfilename(self, file_or_path):
707
if not isinstance(file_or_path, basestring):
708
file_or_path = u'/'.join(file_or_path)
709
if file_or_path == '':
711
return bzrlib.transport.urlescape(bzrlib.BZRDIR + u'/' + file_or_path)
713
def controlfilename(self, file_or_path):
714
"""See Branch.controlfilename."""
715
return self._transport.abspath(self._rel_controlfilename(file_or_path))
717
def controlfile(self, file_or_path, mode='r'):
718
"""See Branch.controlfile."""
721
relpath = self._rel_controlfilename(file_or_path)
722
#TODO: codecs.open() buffers linewise, so it was overloaded with
723
# a much larger buffer, do we need to do the same for getreader/getwriter?
725
return self._transport.get(relpath)
727
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
729
# XXX: Do we really want errors='replace'? Perhaps it should be
730
# an error, or at least reported, if there's incorrectly-encoded
731
# data inside a file.
732
# <https://launchpad.net/products/bzr/+bug/3823>
733
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
735
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
737
raise BzrError("invalid controlfile mode %r" % mode)
739
def put_controlfile(self, path, f, encode=True):
740
"""See Branch.put_controlfile."""
741
self.put_controlfiles([(path, f)], encode=encode)
743
def put_controlfiles(self, files, encode=True):
744
"""See Branch.put_controlfiles."""
747
for path, f in files:
749
if isinstance(f, basestring):
750
f = f.encode('utf-8', 'replace')
752
f = codecs.getwriter('utf-8')(f, errors='replace')
753
path = self._rel_controlfilename(path)
754
ctrl_files.append((path, f))
755
self._transport.put_multi(ctrl_files)
757
def _make_control(self):
758
from bzrlib.inventory import Inventory
759
from bzrlib.weavefile import write_weave_v5
760
from bzrlib.weave import Weave
1721
def peek_lock_mode(self):
1722
if self.control_files._lock_count == 0:
1725
return self.control_files._lock_mode
1727
def get_physical_lock_status(self):
1728
return self.control_files.get_physical_lock_status()
1731
def print_file(self, file, revision_id):
762
# Create an empty inventory
764
# if we want per-tree root ids then this is the place to set
765
# them; they're not needed for now and so ommitted for
767
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
768
empty_inv = sio.getvalue()
770
bzrlib.weavefile.write_weave_v5(Weave(), sio)
771
empty_weave = sio.getvalue()
773
dirs = [[], 'revision-store', 'weaves']
775
"This is a Bazaar-NG control directory.\n"
776
"Do not change any files in this directory.\n"),
777
('branch-format', BZR_BRANCH_FORMAT_6),
778
('revision-history', ''),
781
('pending-merges', ''),
782
('inventory', empty_inv),
783
('inventory.weave', empty_weave),
784
('ancestry.weave', empty_weave)
786
cfn = self._rel_controlfilename
787
self._transport.mkdir_multi([cfn(d) for d in dirs])
788
self.put_controlfiles(files)
789
mutter('created control directory in ' + self._transport.base)
791
def _check_format(self, relax_version_check):
792
"""Check this branch format is supported.
794
The format level is stored, as an integer, in
795
self._branch_format for code that needs to check it later.
797
In the future, we might need different in-memory Branch
798
classes to support downlevel branches. But not yet.
801
fmt = self.controlfile('branch-format', 'r').read()
803
raise NotBranchError(path=self.base)
804
mutter("got branch format %r", fmt)
805
if fmt == BZR_BRANCH_FORMAT_6:
806
self._branch_format = 6
807
elif fmt == BZR_BRANCH_FORMAT_5:
808
self._branch_format = 5
809
elif fmt == BZR_BRANCH_FORMAT_4:
810
self._branch_format = 4
812
if (not relax_version_check
813
and self._branch_format not in (5, 6)):
814
raise errors.UnsupportedFormatError(
815
'sorry, branch format %r not supported' % fmt,
816
['use a different bzr version',
817
'or remove the .bzr directory'
818
' and "bzr init" again'])
821
def get_root_id(self):
822
"""See Branch.get_root_id."""
823
inv = self.get_inventory(self.last_revision())
824
return inv.root.file_id
827
def print_file(self, file, revno):
1732
828
"""See Branch.print_file."""
1733
return self.repository.print_file(file, revision_id)
1735
def _write_revision_history(self, history):
1736
"""Factored out of set_revision_history.
1738
This performs the actual writing to disk.
1739
It is intended to be called by BzrBranch5.set_revision_history."""
1740
self._transport.put_bytes(
1741
'revision-history', '\n'.join(history),
1742
mode=self.bzrdir._get_file_mode())
829
tree = self.revision_tree(self.get_rev_id(revno))
830
# use inventory as it was in that revision
831
file_id = tree.inventory.path2id(file)
833
raise BzrError("%r is not present in revision %s" % (file, revno))
834
tree.print_file(file_id)
837
def append_revision(self, *revision_ids):
838
"""See Branch.append_revision."""
839
for revision_id in revision_ids:
840
mutter("add {%s} to revision-history" % revision_id)
841
rev_history = self.revision_history()
842
rev_history.extend(revision_ids)
843
self.set_revision_history(rev_history)
1744
845
@needs_write_lock
1745
846
def set_revision_history(self, rev_history):
1746
847
"""See Branch.set_revision_history."""
1747
if 'evil' in debug.debug_flags:
1748
mutter_callsite(3, "set_revision_history scales with history.")
1749
check_not_reserved_id = _mod_revision.check_not_reserved_id
1750
for rev_id in rev_history:
1751
check_not_reserved_id(rev_id)
1752
if Branch.hooks['post_change_branch_tip']:
1753
# Don't calculate the last_revision_info() if there are no hooks
1755
old_revno, old_revid = self.last_revision_info()
1756
if len(rev_history) == 0:
1757
revid = _mod_revision.NULL_REVISION
1759
revid = rev_history[-1]
1760
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1761
self._write_revision_history(rev_history)
1762
self._clear_cached_state()
1763
self._cache_revision_history(rev_history)
1764
for hook in Branch.hooks['set_rh']:
1765
hook(self, rev_history)
1766
if Branch.hooks['post_change_branch_tip']:
1767
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1769
def _synchronize_history(self, destination, revision_id):
1770
"""Synchronize last revision and revision history between branches.
1772
This version is most efficient when the destination is also a
1773
BzrBranch5, but works for BzrBranch6 as long as the revision
1774
history is the true lefthand parent history, and all of the revisions
1775
are in the destination's repository. If not, set_revision_history
1778
:param destination: The branch to copy the history into
1779
:param revision_id: The revision-id to truncate history at. May
1780
be None to copy complete history.
1782
if not isinstance(destination._format, BzrBranchFormat5):
1783
super(BzrBranch, self)._synchronize_history(
1784
destination, revision_id)
1786
if revision_id == _mod_revision.NULL_REVISION:
1789
new_history = self.revision_history()
1790
if revision_id is not None and new_history != []:
1792
new_history = new_history[:new_history.index(revision_id) + 1]
1794
rev = self.repository.get_revision(revision_id)
1795
new_history = rev.get_history(self.repository)[1:]
1796
destination.set_revision_history(new_history)
1798
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1799
"""Run the pre_change_branch_tip hooks."""
1800
hooks = Branch.hooks['pre_change_branch_tip']
1803
old_revno, old_revid = self.last_revision_info()
1804
params = ChangeBranchTipParams(
1805
self, old_revno, new_revno, old_revid, new_revid)
1809
except errors.TipChangeRejected:
1812
exc_info = sys.exc_info()
1813
hook_name = Branch.hooks.get_hook_name(hook)
1814
raise errors.HookFailed(
1815
'pre_change_branch_tip', hook_name, exc_info)
1817
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1818
"""Run the post_change_branch_tip hooks."""
1819
hooks = Branch.hooks['post_change_branch_tip']
1822
new_revno, new_revid = self.last_revision_info()
1823
params = ChangeBranchTipParams(
1824
self, old_revno, new_revno, old_revid, new_revid)
1829
def set_last_revision_info(self, revno, revision_id):
1830
"""Set the last revision of this branch.
1832
The caller is responsible for checking that the revno is correct
1833
for this revision id.
1835
It may be possible to set the branch last revision to an id not
1836
present in the repository. However, branches can also be
1837
configured to check constraints on history, in which case this may not
1840
revision_id = _mod_revision.ensure_null(revision_id)
1841
# this old format stores the full history, but this api doesn't
1842
# provide it, so we must generate, and might as well check it's
1844
history = self._lefthand_history(revision_id)
1845
if len(history) != revno:
1846
raise AssertionError('%d != %d' % (len(history), revno))
1847
self.set_revision_history(history)
1849
def _gen_revision_history(self):
1850
history = self._transport.get_bytes('revision-history').split('\n')
1851
if history[-1:] == ['']:
1852
# There shouldn't be a trailing newline, but just in case.
1856
def _lefthand_history(self, revision_id, last_rev=None,
1858
if 'evil' in debug.debug_flags:
1859
mutter_callsite(4, "_lefthand_history scales with history.")
1860
# stop_revision must be a descendant of last_revision
1861
graph = self.repository.get_graph()
1862
if last_rev is not None:
1863
if not graph.is_ancestor(last_rev, revision_id):
1864
# our previous tip is not merged into stop_revision
1865
raise errors.DivergedBranches(self, other_branch)
1866
# make a new revision history from the graph
1867
parents_map = graph.get_parent_map([revision_id])
1868
if revision_id not in parents_map:
1869
raise errors.NoSuchRevision(self, revision_id)
1870
current_rev_id = revision_id
1872
check_not_reserved_id = _mod_revision.check_not_reserved_id
1873
# Do not include ghosts or graph origin in revision_history
1874
while (current_rev_id in parents_map and
1875
len(parents_map[current_rev_id]) > 0):
1876
check_not_reserved_id(current_rev_id)
1877
new_history.append(current_rev_id)
1878
current_rev_id = parents_map[current_rev_id][0]
1879
parents_map = graph.get_parent_map([current_rev_id])
1880
new_history.reverse()
1884
def generate_revision_history(self, revision_id, last_rev=None,
1886
"""Create a new revision history that will finish with revision_id.
1888
:param revision_id: the new tip to use.
1889
:param last_rev: The previous last_revision. If not None, then this
1890
must be a ancestory of revision_id, or DivergedBranches is raised.
1891
:param other_branch: The other branch that DivergedBranches should
1892
raise with respect to.
1894
self.set_revision_history(self._lefthand_history(revision_id,
1895
last_rev, other_branch))
848
old_revision = self.last_revision()
849
new_revision = rev_history[-1]
850
self.put_controlfile('revision-history', '\n'.join(rev_history))
851
self.working_tree().set_last_revision(new_revision, old_revision)
853
def has_revision(self, revision_id):
854
"""See Branch.has_revision."""
855
return (revision_id is None
856
or self.revision_store.has_id(revision_id))
859
def _get_revision_xml_file(self, revision_id):
860
if not revision_id or not isinstance(revision_id, basestring):
861
raise InvalidRevisionId(revision_id=revision_id, branch=self)
863
return self.revision_store.get(revision_id)
864
except (IndexError, KeyError):
865
raise bzrlib.errors.NoSuchRevision(self, revision_id)
867
def get_revision_xml(self, revision_id):
868
"""See Branch.get_revision_xml."""
869
return self._get_revision_xml_file(revision_id).read()
871
def get_revision(self, revision_id):
872
"""See Branch.get_revision."""
873
xml_file = self._get_revision_xml_file(revision_id)
876
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
877
except SyntaxError, e:
878
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
882
assert r.revision_id == revision_id
885
def get_revision_sha1(self, revision_id):
886
"""See Branch.get_revision_sha1."""
887
# In the future, revision entries will be signed. At that
888
# point, it is probably best *not* to include the signature
889
# in the revision hash. Because that lets you re-sign
890
# the revision, (add signatures/remove signatures) and still
891
# have all hash pointers stay consistent.
892
# But for now, just hash the contents.
893
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
895
def get_ancestry(self, revision_id):
896
"""See Branch.get_ancestry."""
897
if revision_id is None:
899
w = self._get_inventory_weave()
900
return [None] + map(w.idx_to_name,
901
w.inclusions([w.lookup(revision_id)]))
903
def _get_inventory_weave(self):
904
return self.control_weaves.get_weave('inventory',
905
self.get_transaction())
907
def get_inventory(self, revision_id):
908
"""See Branch.get_inventory."""
909
xml = self.get_inventory_xml(revision_id)
910
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
912
def get_inventory_xml(self, revision_id):
913
"""See Branch.get_inventory_xml."""
915
assert isinstance(revision_id, basestring), type(revision_id)
916
iw = self._get_inventory_weave()
917
return iw.get_text(iw.lookup(revision_id))
919
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
921
def get_inventory_sha1(self, revision_id):
922
"""See Branch.get_inventory_sha1."""
923
return self.get_revision(revision_id).inventory_sha1
925
def get_revision_inventory(self, revision_id):
926
"""See Branch.get_revision_inventory."""
927
# TODO: Unify this with get_inventory()
928
# bzr 0.0.6 and later imposes the constraint that the inventory_id
929
# must be the same as its revision, so this is trivial.
930
if revision_id == None:
931
# This does not make sense: if there is no revision,
932
# then it is the current tree inventory surely ?!
933
# and thus get_root_id() is something that looks at the last
934
# commit on the branch, and the get_root_id is an inventory check.
935
raise NotImplementedError
936
# return Inventory(self.get_root_id())
938
return self.get_inventory(revision_id)
941
def revision_history(self):
942
"""See Branch.revision_history."""
943
transaction = self.get_transaction()
944
history = transaction.map.find_revision_history()
945
if history is not None:
946
mutter("cache hit for revision-history in %s", self)
948
history = [l.rstrip('\r\n') for l in
949
self.controlfile('revision-history', 'r').readlines()]
950
transaction.map.add_revision_history(history)
951
# this call is disabled because revision_history is
952
# not really an object yet, and the transaction is for objects.
953
# transaction.register_clean(history, precious=True)
956
def update_revisions(self, other, stop_revision=None):
957
"""See Branch.update_revisions."""
958
from bzrlib.fetch import greedy_fetch
959
if stop_revision is None:
960
stop_revision = other.last_revision()
961
### Should this be checking is_ancestor instead of revision_history?
962
if (stop_revision is not None and
963
stop_revision in self.revision_history()):
965
greedy_fetch(to_branch=self, from_branch=other,
966
revision=stop_revision)
967
pullable_revs = self.pullable_revisions(other, stop_revision)
968
if len(pullable_revs) > 0:
969
self.append_revision(*pullable_revs)
971
def pullable_revisions(self, other, stop_revision):
972
"""See Branch.pullable_revisions."""
973
other_revno = other.revision_id_to_revno(stop_revision)
975
return self.missing_revisions(other, other_revno)
976
except DivergedBranches, e:
978
pullable_revs = get_intervening_revisions(self.last_revision(),
980
assert self.last_revision() not in pullable_revs
982
except bzrlib.errors.NotAncestor:
983
if is_ancestor(self.last_revision(), stop_revision, self):
988
def revision_tree(self, revision_id):
989
"""See Branch.revision_tree."""
990
# TODO: refactor this to use an existing revision object
991
# so we don't need to read it in twice.
992
if revision_id == None or revision_id == NULL_REVISION:
995
inv = self.get_revision_inventory(revision_id)
996
return RevisionTree(self.weave_store, inv, revision_id)
1897
998
def basis_tree(self):
1898
999
"""See Branch.basis_tree."""
1899
return self.repository.revision_tree(self.last_revision())
1001
revision_id = self.revision_history()[-1]
1002
xml = self.working_tree().read_basis_inventory(revision_id)
1003
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
1004
return RevisionTree(self.weave_store, inv, revision_id)
1005
except (IndexError, NoSuchFile), e:
1006
return self.revision_tree(self.last_revision())
1008
def working_tree(self):
1009
"""See Branch.working_tree."""
1010
from bzrlib.workingtree import WorkingTree
1011
if self._transport.base.find('://') != -1:
1012
raise NoWorkingTree(self.base)
1013
return WorkingTree(self.base, branch=self)
1901
1015
@needs_write_lock
1902
def pull(self, source, overwrite=False, stop_revision=None,
1903
_hook_master=None, run_hooks=True, possible_transports=None,
1904
_override_hook_target=None):
1907
:param _hook_master: Private parameter - set the branch to
1908
be supplied as the master to pull hooks.
1909
:param run_hooks: Private parameter - if false, this branch
1910
is being called because it's the master of the primary branch,
1911
so it should not run its hooks.
1912
:param _override_hook_target: Private parameter - set the branch to be
1913
supplied as the target_branch to pull hooks.
1915
result = PullResult()
1916
result.source_branch = source
1917
if _override_hook_target is None:
1918
result.target_branch = self
1920
result.target_branch = _override_hook_target
1016
def pull(self, source, overwrite=False):
1017
"""See Branch.pull."""
1921
1018
source.lock_read()
1923
# We assume that during 'pull' the local repository is closer than
1925
graph = self.repository.get_graph(source.repository)
1926
result.old_revno, result.old_revid = self.last_revision_info()
1927
self.update_revisions(source, stop_revision, overwrite=overwrite,
1929
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1930
result.new_revno, result.new_revid = self.last_revision_info()
1932
result.master_branch = _hook_master
1933
result.local_branch = result.target_branch
1935
result.master_branch = result.target_branch
1936
result.local_branch = None
1938
for hook in Branch.hooks['post_pull']:
1020
old_count = len(self.revision_history())
1022
self.update_revisions(source)
1023
except DivergedBranches:
1026
self.set_revision_history(source.revision_history())
1027
new_count = len(self.revision_history())
1028
return new_count - old_count
1941
1030
source.unlock()
1944
def _get_parent_location(self):
1032
def get_parent(self):
1033
"""See Branch.get_parent."""
1945
1035
_locs = ['parent', 'pull', 'x-pull']
1946
1036
for l in _locs:
1948
return self._transport.get_bytes(l).strip('\n')
1949
except errors.NoSuchFile:
1038
return self.controlfile(l, 'r').read().strip('\n')
1040
if e.errno != errno.ENOENT:
1954
def push(self, target, overwrite=False, stop_revision=None,
1955
_override_hook_source_branch=None):
1958
This is the basic concrete implementation of push()
1960
:param _override_hook_source_branch: If specified, run
1961
the hooks passing this Branch as the source, rather than self.
1962
This is for use of RemoteBranch, where push is delegated to the
1963
underlying vfs-based Branch.
1965
# TODO: Public option to disable running hooks - should be trivial but
1967
return _run_with_write_locked_target(
1968
target, self._push_with_bound_branches, target, overwrite,
1970
_override_hook_source_branch=_override_hook_source_branch)
1972
def _push_with_bound_branches(self, target, overwrite,
1974
_override_hook_source_branch=None):
1975
"""Push from self into target, and into target's master if any.
1977
This is on the base BzrBranch class even though it doesn't support
1978
bound branches because the *target* might be bound.
1981
if _override_hook_source_branch:
1982
result.source_branch = _override_hook_source_branch
1983
for hook in Branch.hooks['post_push']:
1986
bound_location = target.get_bound_location()
1987
if bound_location and target.base != bound_location:
1988
# there is a master branch.
1990
# XXX: Why the second check? Is it even supported for a branch to
1991
# be bound to itself? -- mbp 20070507
1992
master_branch = target.get_master_branch()
1993
master_branch.lock_write()
1995
# push into the master from this branch.
1996
self._basic_push(master_branch, overwrite, stop_revision)
1997
# and push into the target branch from this. Note that we push from
1998
# this branch again, because its considered the highest bandwidth
2000
result = self._basic_push(target, overwrite, stop_revision)
2001
result.master_branch = master_branch
2002
result.local_branch = target
2006
master_branch.unlock()
2009
result = self._basic_push(target, overwrite, stop_revision)
2010
# TODO: Why set master_branch and local_branch if there's no
2011
# binding? Maybe cleaner to just leave them unset? -- mbp
2013
result.master_branch = target
2014
result.local_branch = None
2018
def _basic_push(self, target, overwrite, stop_revision):
2019
"""Basic implementation of push without bound branches or hooks.
2021
Must be called with self read locked and target write locked.
2023
result = PushResult()
2024
result.source_branch = self
2025
result.target_branch = target
2026
result.old_revno, result.old_revid = target.last_revision_info()
2027
if result.old_revid != self.last_revision():
2028
# We assume that during 'push' this repository is closer than
2030
graph = self.repository.get_graph(target.repository)
2031
target.update_revisions(self, stop_revision, overwrite=overwrite,
2033
if self._push_should_merge_tags():
2034
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2035
result.new_revno, result.new_revid = target.last_revision_info()
2038
def _push_should_merge_tags(self):
2039
"""Should _basic_push merge this branch's tags into the target?
2041
The default implementation returns False if this branch has no tags,
2042
and True the rest of the time. Subclasses may override this.
2044
return self.tags.supports_tags() and self.tags.get_tag_dict()
2046
def get_parent(self):
2047
"""See Branch.get_parent."""
2048
parent = self._get_parent_location()
2051
# This is an old-format absolute path to a local branch
2052
# turn it into a url
2053
if parent.startswith('/'):
2054
parent = urlutils.local_path_to_url(parent.decode('utf8'))
2056
return urlutils.join(self.base[:-1], parent)
2057
except errors.InvalidURLJoin, e:
2058
raise errors.InaccessibleParent(parent, self.base)
2060
def get_stacked_on_url(self):
2061
raise errors.UnstackableBranchFormat(self._format, self.base)
1044
def get_push_location(self):
1045
"""See Branch.get_push_location."""
1046
config = bzrlib.config.BranchConfig(self)
1047
push_loc = config.get_user_option('push_location')
2063
1050
def set_push_location(self, location):
2064
1051
"""See Branch.set_push_location."""
2065
self.get_config().set_user_option(
2066
'push_location', location,
2067
store=_mod_config.STORE_LOCATION_NORECURSE)
1052
config = bzrlib.config.LocationConfig(self.base)
1053
config.set_user_option('push_location', location)
2069
1055
@needs_write_lock
2070
1056
def set_parent(self, url):
2071
1057
"""See Branch.set_parent."""
2072
1058
# TODO: Maybe delete old location files?
2073
# URLs should never be unicode, even on the local fs,
2074
# FIXUP this and get_parent in a future branch format bump:
2075
# read and rewrite the file. RBC 20060125
2077
if isinstance(url, unicode):
2079
url = url.encode('ascii')
2080
except UnicodeEncodeError:
2081
raise errors.InvalidURL(url,
2082
"Urls must be 7-bit ascii, "
2083
"use bzrlib.urlutils.escape")
2084
url = urlutils.relative_url(self.base, url)
2085
self._set_parent_location(url)
2087
def _set_parent_location(self, url):
2089
self._transport.delete('parent')
2091
self._transport.put_bytes('parent', url + '\n',
2092
mode=self.bzrdir._get_file_mode())
2094
def set_stacked_on_url(self, url):
2095
raise errors.UnstackableBranchFormat(self._format, self.base)
2098
class BzrBranch5(BzrBranch):
2099
"""A format 5 branch. This supports new features over plain branches.
2101
It has support for a master_branch which is the data for bound branches.
1059
from bzrlib.atomicfile import AtomicFile
1060
f = AtomicFile(self.controlfilename('parent'))
1067
def tree_config(self):
1068
return TreeConfig(self)
1070
def sign_revision(self, revision_id, gpg_strategy):
1071
"""See Branch.sign_revision."""
1072
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1073
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1076
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1077
"""See Branch.store_revision_signature."""
1078
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1082
class ScratchBranch(BzrBranch):
1083
"""Special test class: a branch that cleans up after itself.
1085
>>> b = ScratchBranch()
1089
>>> b._transport.__del__()
2105
def pull(self, source, overwrite=False, stop_revision=None,
2106
run_hooks=True, possible_transports=None,
2107
_override_hook_target=None):
2108
"""Pull from source into self, updating my master if any.
2110
:param run_hooks: Private parameter - if false, this branch
2111
is being called because it's the master of the primary branch,
2112
so it should not run its hooks.
2114
bound_location = self.get_bound_location()
2115
master_branch = None
2116
if bound_location and source.base != bound_location:
2117
# not pulling from master, so we need to update master.
2118
master_branch = self.get_master_branch(possible_transports)
2119
master_branch.lock_write()
2122
# pull from source into master.
2123
master_branch.pull(source, overwrite, stop_revision,
2125
return super(BzrBranch5, self).pull(source, overwrite,
2126
stop_revision, _hook_master=master_branch,
2127
run_hooks=run_hooks,
2128
_override_hook_target=_override_hook_target)
2131
master_branch.unlock()
2133
def get_bound_location(self):
2135
return self._transport.get_bytes('bound')[:-1]
2136
except errors.NoSuchFile:
2140
def get_master_branch(self, possible_transports=None):
2141
"""Return the branch we are bound to.
2143
:return: Either a Branch, or None
2145
This could memoise the branch, but if thats done
2146
it must be revalidated on each new lock.
2147
So for now we just don't memoise it.
2148
# RBC 20060304 review this decision.
2150
bound_loc = self.get_bound_location()
2154
return Branch.open(bound_loc,
2155
possible_transports=possible_transports)
2156
except (errors.NotBranchError, errors.ConnectionError), e:
2157
raise errors.BoundBranchConnectionFailure(
2161
def set_bound_location(self, location):
2162
"""Set the target where this branch is bound to.
2164
:param location: URL to the target branch
2167
self._transport.put_bytes('bound', location+'\n',
2168
mode=self.bzrdir._get_file_mode())
1094
def __init__(self, files=[], dirs=[], transport=None):
1095
"""Make a test branch.
1097
This creates a temporary directory and runs init-tree in it.
1099
If any files are listed, they are created in the working copy.
1101
if transport is None:
1102
transport = bzrlib.transport.local.ScratchTransport()
1103
super(ScratchBranch, self).__init__(transport, init=True)
2171
self._transport.delete('bound')
2172
except errors.NoSuchFile:
1105
super(ScratchBranch, self).__init__(transport)
1108
self._transport.mkdir(d)
1111
self._transport.put(f, 'content of %s' % f)
1116
>>> orig = ScratchBranch(files=["file1", "file2"])
1117
>>> clone = orig.clone()
1118
>>> if os.name != 'nt':
1119
... os.path.samefile(orig.base, clone.base)
1121
... orig.base == clone.base
1124
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1127
from shutil import copytree
1128
from tempfile import mkdtemp
1131
copytree(self.base, base, symlinks=True)
1132
return ScratchBranch(
1133
transport=bzrlib.transport.local.ScratchTransport(base))
1136
######################################################################
1140
def is_control_file(filename):
1141
## FIXME: better check
1142
filename = os.path.normpath(filename)
1143
while filename != '':
1144
head, tail = os.path.split(filename)
1145
## mutter('check %r for control file' % ((head, tail), ))
1146
if tail == bzrlib.BZRDIR:
2177
def bind(self, other):
2178
"""Bind this branch to the branch other.
2180
This does not push or pull data between the branches, though it does
2181
check for divergence to raise an error when the branches are not
2182
either the same, or one a prefix of the other. That behaviour may not
2183
be useful, so that check may be removed in future.
2185
:param other: The branch to bind to
2188
# TODO: jam 20051230 Consider checking if the target is bound
2189
# It is debatable whether you should be able to bind to
2190
# a branch which is itself bound.
2191
# Committing is obviously forbidden,
2192
# but binding itself may not be.
2193
# Since we *have* to check at commit time, we don't
2194
# *need* to check here
2196
# we want to raise diverged if:
2197
# last_rev is not in the other_last_rev history, AND
2198
# other_last_rev is not in our history, and do it without pulling
2200
self.set_bound_location(other.base)
2204
"""If bound, unbind"""
2205
return self.set_bound_location(None)
2208
def update(self, possible_transports=None):
2209
"""Synchronise this branch with the master branch if any.
2211
:return: None or the last_revision that was pivoted out during the
2214
master = self.get_master_branch(possible_transports)
2215
if master is not None:
2216
old_tip = _mod_revision.ensure_null(self.last_revision())
2217
self.pull(master, overwrite=True)
2218
if self.repository.get_graph().is_ancestor(old_tip,
2219
_mod_revision.ensure_null(self.last_revision())):
2225
class BzrBranch7(BzrBranch5):
2226
"""A branch with support for a fallback repository."""
2228
def _get_fallback_repository(self, url):
2229
"""Get the repository we fallback to at url."""
2230
url = urlutils.join(self.base, url)
2231
a_bzrdir = bzrdir.BzrDir.open(url,
2232
possible_transports=[self._transport])
2233
return a_bzrdir.open_branch().repository
2235
def _activate_fallback_location(self, url):
2236
"""Activate the branch/repository from url as a fallback repository."""
2237
self.repository.add_fallback_repository(
2238
self._get_fallback_repository(url))
2240
def _open_hook(self):
2242
url = self.get_stacked_on_url()
2243
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2244
errors.UnstackableBranchFormat):
2247
for hook in Branch.hooks['transform_fallback_location']:
2248
url = hook(self, url)
2250
hook_name = Branch.hooks.get_hook_name(hook)
2251
raise AssertionError(
2252
"'transform_fallback_location' hook %s returned "
2253
"None, not a URL." % hook_name)
2254
self._activate_fallback_location(url)
2256
def _check_stackable_repo(self):
2257
if not self.repository._format.supports_external_lookups:
2258
raise errors.UnstackableRepositoryFormat(self.repository._format,
2259
self.repository.base)
2261
def __init__(self, *args, **kwargs):
2262
super(BzrBranch7, self).__init__(*args, **kwargs)
2263
self._last_revision_info_cache = None
2264
self._partial_revision_history_cache = []
2266
def _clear_cached_state(self):
2267
super(BzrBranch7, self)._clear_cached_state()
2268
self._last_revision_info_cache = None
2269
self._partial_revision_history_cache = []
2271
def _last_revision_info(self):
2272
revision_string = self._transport.get_bytes('last-revision')
2273
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2274
revision_id = cache_utf8.get_cached_utf8(revision_id)
2276
return revno, revision_id
2278
def _write_last_revision_info(self, revno, revision_id):
2279
"""Simply write out the revision id, with no checks.
2281
Use set_last_revision_info to perform this safely.
2283
Does not update the revision_history cache.
2284
Intended to be called by set_last_revision_info and
2285
_write_revision_history.
2287
revision_id = _mod_revision.ensure_null(revision_id)
2288
out_string = '%d %s\n' % (revno, revision_id)
2289
self._transport.put_bytes('last-revision', out_string,
2290
mode=self.bzrdir._get_file_mode())
2293
def set_last_revision_info(self, revno, revision_id):
2294
revision_id = _mod_revision.ensure_null(revision_id)
2295
old_revno, old_revid = self.last_revision_info()
2296
if self._get_append_revisions_only():
2297
self._check_history_violation(revision_id)
2298
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2299
self._write_last_revision_info(revno, revision_id)
2300
self._clear_cached_state()
2301
self._last_revision_info_cache = revno, revision_id
2302
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2304
def _synchronize_history(self, destination, revision_id):
2305
"""Synchronize last revision and revision history between branches.
2307
:see: Branch._synchronize_history
2309
# XXX: The base Branch has a fast implementation of this method based
2310
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2311
# that uses set_revision_history. This class inherits from BzrBranch5,
2312
# but wants the fast implementation, so it calls
2313
# Branch._synchronize_history directly.
2314
Branch._synchronize_history(self, destination, revision_id)
2316
def _check_history_violation(self, revision_id):
2317
last_revision = _mod_revision.ensure_null(self.last_revision())
2318
if _mod_revision.is_null(last_revision):
2320
if last_revision not in self._lefthand_history(revision_id):
2321
raise errors.AppendRevisionsOnlyViolation(self.base)
2323
def _gen_revision_history(self):
2324
"""Generate the revision history from last revision
2326
last_revno, last_revision = self.last_revision_info()
2327
self._extend_partial_history(stop_index=last_revno-1)
2328
return list(reversed(self._partial_revision_history_cache))
2330
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2331
"""Extend the partial history to include a given index
2333
If a stop_index is supplied, stop when that index has been reached.
2334
If a stop_revision is supplied, stop when that revision is
2335
encountered. Otherwise, stop when the beginning of history is
2338
:param stop_index: The index which should be present. When it is
2339
present, history extension will stop.
2340
:param revision_id: The revision id which should be present. When
2341
it is encountered, history extension will stop.
2343
repo = self.repository
2344
if len(self._partial_revision_history_cache) == 0:
2345
iterator = repo.iter_reverse_revision_history(self.last_revision())
2347
start_revision = self._partial_revision_history_cache[-1]
2348
iterator = repo.iter_reverse_revision_history(start_revision)
2349
#skip the last revision in the list
2350
next_revision = iterator.next()
2351
for revision_id in iterator:
2352
self._partial_revision_history_cache.append(revision_id)
2353
if (stop_index is not None and
2354
len(self._partial_revision_history_cache) > stop_index):
2356
if revision_id == stop_revision:
2359
def _write_revision_history(self, history):
2360
"""Factored out of set_revision_history.
2362
This performs the actual writing to disk, with format-specific checks.
2363
It is intended to be called by BzrBranch5.set_revision_history.
2365
if len(history) == 0:
2366
last_revision = 'null:'
2368
if history != self._lefthand_history(history[-1]):
2369
raise errors.NotLefthandHistory(history)
2370
last_revision = history[-1]
2371
if self._get_append_revisions_only():
2372
self._check_history_violation(last_revision)
2373
self._write_last_revision_info(len(history), last_revision)
2376
def _set_parent_location(self, url):
2377
"""Set the parent branch"""
2378
self._set_config_location('parent_location', url, make_relative=True)
2381
def _get_parent_location(self):
2382
"""Set the parent branch"""
2383
return self._get_config_location('parent_location')
2385
def set_push_location(self, location):
2386
"""See Branch.set_push_location."""
2387
self._set_config_location('push_location', location)
2389
def set_bound_location(self, location):
2390
"""See Branch.set_push_location."""
2392
config = self.get_config()
2393
if location is None:
2394
if config.get_user_option('bound') != 'True':
2397
config.set_user_option('bound', 'False', warn_masked=True)
2400
self._set_config_location('bound_location', location,
2402
config.set_user_option('bound', 'True', warn_masked=True)
2405
def _get_bound_location(self, bound):
2406
"""Return the bound location in the config file.
2408
Return None if the bound parameter does not match"""
2409
config = self.get_config()
2410
config_bound = (config.get_user_option('bound') == 'True')
2411
if config_bound != bound:
2413
return self._get_config_location('bound_location', config=config)
2415
def get_bound_location(self):
2416
"""See Branch.set_push_location."""
2417
return self._get_bound_location(True)
2419
def get_old_bound_location(self):
2420
"""See Branch.get_old_bound_location"""
2421
return self._get_bound_location(False)
2423
def get_stacked_on_url(self):
2424
# you can always ask for the URL; but you might not be able to use it
2425
# if the repo can't support stacking.
2426
## self._check_stackable_repo()
2427
stacked_url = self._get_config_location('stacked_on_location')
2428
if stacked_url is None:
2429
raise errors.NotStacked(self)
2432
def set_append_revisions_only(self, enabled):
2437
self.get_config().set_user_option('append_revisions_only', value,
2440
def set_stacked_on_url(self, url):
2441
self._check_stackable_repo()
2444
old_url = self.get_stacked_on_url()
2445
except (errors.NotStacked, errors.UnstackableBranchFormat,
2446
errors.UnstackableRepositoryFormat):
2449
# repositories don't offer an interface to remove fallback
2450
# repositories today; take the conceptually simpler option and just
2452
self.repository = self.bzrdir.find_repository()
2453
# for every revision reference the branch has, ensure it is pulled
2455
source_repository = self._get_fallback_repository(old_url)
2456
for revision_id in chain([self.last_revision()],
2457
self.tags.get_reverse_tag_dict()):
2458
self.repository.fetch(source_repository, revision_id,
2461
self._activate_fallback_location(url)
2462
# write this out after the repository is stacked to avoid setting a
2463
# stacked config that doesn't work.
2464
self._set_config_location('stacked_on_location', url)
2466
def _get_append_revisions_only(self):
2467
value = self.get_config().get_user_option('append_revisions_only')
2468
return value == 'True'
2470
def _make_tags(self):
2471
return BasicTags(self)
2474
def generate_revision_history(self, revision_id, last_rev=None,
2476
"""See BzrBranch5.generate_revision_history"""
2477
history = self._lefthand_history(revision_id, last_rev, other_branch)
2478
revno = len(history)
2479
self.set_last_revision_info(revno, revision_id)
2482
def get_rev_id(self, revno, history=None):
2483
"""Find the revision id of the specified revno."""
2485
return _mod_revision.NULL_REVISION
2487
last_revno, last_revision_id = self.last_revision_info()
2488
if revno <= 0 or revno > last_revno:
2489
raise errors.NoSuchRevision(self, revno)
2491
if history is not None:
2492
return history[revno - 1]
2494
index = last_revno - revno
2495
if len(self._partial_revision_history_cache) <= index:
2496
self._extend_partial_history(stop_index=index)
2497
if len(self._partial_revision_history_cache) > index:
2498
return self._partial_revision_history_cache[index]
2500
raise errors.NoSuchRevision(self, revno)
2503
def revision_id_to_revno(self, revision_id):
2504
"""Given a revision id, return its revno"""
2505
if _mod_revision.is_null(revision_id):
2508
index = self._partial_revision_history_cache.index(revision_id)
2510
self._extend_partial_history(stop_revision=revision_id)
2511
index = len(self._partial_revision_history_cache) - 1
2512
if self._partial_revision_history_cache[index] != revision_id:
2513
raise errors.NoSuchRevision(self, revision_id)
2514
return self.revno() - index
2517
class BzrBranch6(BzrBranch7):
2518
"""See BzrBranchFormat6 for the capabilities of this branch.
2520
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2524
def get_stacked_on_url(self):
2525
raise errors.UnstackableBranchFormat(self._format, self.base)
2527
def set_stacked_on_url(self, url):
2528
raise errors.UnstackableBranchFormat(self._format, self.base)
2531
######################################################################
2532
# results of operations
2535
class _Result(object):
2537
def _show_tag_conficts(self, to_file):
2538
if not getattr(self, 'tag_conflicts', None):
2540
to_file.write('Conflicting tags:\n')
2541
for name, value1, value2 in self.tag_conflicts:
2542
to_file.write(' %s\n' % (name, ))
2545
class PullResult(_Result):
2546
"""Result of a Branch.pull operation.
2548
:ivar old_revno: Revision number before pull.
2549
:ivar new_revno: Revision number after pull.
2550
:ivar old_revid: Tip revision id before pull.
2551
:ivar new_revid: Tip revision id after pull.
2552
:ivar source_branch: Source (local) branch object.
2553
:ivar master_branch: Master branch of the target, or the target if no
2555
:ivar local_branch: target branch if there is a Master, else None
2556
:ivar target_branch: Target/destination branch object.
2557
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2561
# DEPRECATED: pull used to return the change in revno
2562
return self.new_revno - self.old_revno
2564
def report(self, to_file):
2566
if self.old_revid == self.new_revid:
2567
to_file.write('No revisions to pull.\n')
2569
to_file.write('Now on revision %d.\n' % self.new_revno)
2570
self._show_tag_conficts(to_file)
2573
class PushResult(_Result):
2574
"""Result of a Branch.push operation.
2576
:ivar old_revno: Revision number before push.
2577
:ivar new_revno: Revision number after push.
2578
:ivar old_revid: Tip revision id before push.
2579
:ivar new_revid: Tip revision id after push.
2580
:ivar source_branch: Source branch object.
2581
:ivar master_branch: Master branch of the target, or None.
2582
:ivar target_branch: Target/destination branch object.
2586
# DEPRECATED: push used to return the change in revno
2587
return self.new_revno - self.old_revno
2589
def report(self, to_file):
2590
"""Write a human-readable description of the result."""
2591
if self.old_revid == self.new_revid:
2592
to_file.write('No new revisions to push.\n')
2594
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2595
self._show_tag_conficts(to_file)
2598
class BranchCheckResult(object):
2599
"""Results of checking branch consistency.
2604
def __init__(self, branch):
2605
self.branch = branch
2607
def report_results(self, verbose):
2608
"""Report the check results via trace.note.
2610
:param verbose: Requests more detailed display of what was checked,
2613
note('checked branch %s format %s',
2615
self.branch._format)
2618
class Converter5to6(object):
2619
"""Perform an in-place upgrade of format 5 to format 6"""
2621
def convert(self, branch):
2622
# Data for 5 and 6 can peacefully coexist.
2623
format = BzrBranchFormat6()
2624
new_branch = format.open(branch.bzrdir, _found=True)
2626
# Copy source data into target
2627
new_branch._write_last_revision_info(*branch.last_revision_info())
2628
new_branch.set_parent(branch.get_parent())
2629
new_branch.set_bound_location(branch.get_bound_location())
2630
new_branch.set_push_location(branch.get_push_location())
2632
# New branch has no tags by default
2633
new_branch.tags._set_tag_dict({})
2635
# Copying done; now update target format
2636
new_branch._transport.put_bytes('format',
2637
format.get_format_string(),
2638
mode=new_branch.bzrdir._get_file_mode())
2640
# Clean up old files
2641
new_branch._transport.delete('revision-history')
2643
branch.set_parent(None)
2644
except errors.NoSuchFile:
2646
branch.set_bound_location(None)
2649
class Converter6to7(object):
2650
"""Perform an in-place upgrade of format 6 to format 7"""
2652
def convert(self, branch):
2653
format = BzrBranchFormat7()
2654
branch._set_config_location('stacked_on_location', '')
2655
# update target format
2656
branch._transport.put_bytes('format', format.get_format_string())
2660
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2661
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2664
_run_with_write_locked_target will attempt to release the lock it acquires.
2666
If an exception is raised by callable, then that exception *will* be
2667
propagated, even if the unlock attempt raises its own error. Thus
2668
_run_with_write_locked_target should be preferred to simply doing::
2672
return callable(*args, **kwargs)
2677
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2678
# should share code?
2681
result = callable(*args, **kwargs)
2683
exc_info = sys.exc_info()
2687
raise exc_info[0], exc_info[1], exc_info[2]
1148
if filename == head:
added
removed
bzrlib/branch.py
