82
107
Base directory/url of the branch.
84
hooks: An instance of BranchHooks.
86
109
# this is really an instance variable - FIXME move it there
113
_default_initializer = None
114
"""The default initializer for making new branches."""
90
116
def __init__(self, *ignored, **ignored_too):
91
self.tags = self._format.make_tags(self)
92
self._revision_history_cache = None
93
self._revision_id_to_revno_cache = None
94
self._partial_revision_id_to_revno_cache = {}
95
self._partial_revision_history_cache = []
96
self._last_revision_info_cache = None
97
self._merge_sorted_revisions_cache = None
99
hooks = Branch.hooks['open']
103
def _open_hook(self):
104
"""Called by init to allow simpler extension of the base class."""
106
def _activate_fallback_location(self, url):
107
"""Activate the branch/repository from url as a fallback repository."""
108
repo = self._get_fallback_repository(url)
109
if repo.has_same_location(self.repository):
110
raise errors.UnstackableLocationError(self.base, url)
111
self.repository.add_fallback_repository(repo)
113
def break_lock(self):
114
"""Break a lock if one is present from another instance.
116
Uses the ui factory to ask for confirmation if the lock may be from
119
This will probe the repository for its lock as well.
121
self.control_files.break_lock()
122
self.repository.break_lock()
123
master = self.get_master_branch()
124
if master is not None:
127
def _check_stackable_repo(self):
128
if not self.repository._format.supports_external_lookups:
129
raise errors.UnstackableRepositoryFormat(self.repository._format,
130
self.repository.base)
132
def _extend_partial_history(self, stop_index=None, stop_revision=None):
133
"""Extend the partial history to include a given index
135
If a stop_index is supplied, stop when that index has been reached.
136
If a stop_revision is supplied, stop when that revision is
137
encountered. Otherwise, stop when the beginning of history is
140
:param stop_index: The index which should be present. When it is
141
present, history extension will stop.
142
:param stop_revision: The revision id which should be present. When
143
it is encountered, history extension will stop.
145
if len(self._partial_revision_history_cache) == 0:
146
self._partial_revision_history_cache = [self.last_revision()]
147
repository._iter_for_revno(
148
self.repository, self._partial_revision_history_cache,
149
stop_index=stop_index, stop_revision=stop_revision)
150
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
151
self._partial_revision_history_cache.pop()
153
def _get_check_refs(self):
154
"""Get the references needed for check().
158
revid = self.last_revision()
159
return [('revision-existence', revid), ('lefthand-distance', revid)]
162
def open(base, _unsupported=False, possible_transports=None):
163
"""Open the branch rooted at base.
165
For instance, if the branch is at URL/.bzr/branch,
166
Branch.open(URL) -> a Branch instance.
168
control = bzrdir.BzrDir.open(base, _unsupported,
169
possible_transports=possible_transports)
170
return control.open_branch(_unsupported)
173
def open_from_transport(transport, _unsupported=False):
174
"""Open the branch rooted at transport"""
175
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
176
return control.open_branch(_unsupported)
179
def open_containing(url, possible_transports=None):
117
raise NotImplementedError('The Branch class is abstract')
120
def open_downlevel(base):
121
"""Open a branch which may be of an old format."""
122
return Branch.open(base, _unsupported=True)
125
def open(base, _unsupported=False):
126
"""Open an existing branch, rooted at 'base' (url)
128
_unsupported is a private parameter to the Branch class.
130
t = get_transport(base)
131
mutter("trying to open %r with transport %r", base, t)
132
format = BzrBranchFormat.find_format(t)
133
if not _unsupported and not format.is_supported():
134
# see open_downlevel to open legacy branches.
135
raise errors.UnsupportedFormatError(
136
'sorry, branch format %s not supported' % format,
137
['use a different bzr version',
138
'or remove the .bzr directory'
139
' and "bzr init" again'])
140
return format.open(t)
143
def open_containing(url):
180
144
"""Open an existing branch which contains url.
182
146
This probes for a branch at url, and searches upwards from there.
184
148
Basically we keep looking up until we find the control directory or
185
149
run into the root. If there isn't one, raises NotBranchError.
186
If there is one and it is either an unrecognised format or an unsupported
187
format, UnknownFormatError or UnsupportedFormatError are raised.
188
150
If there is one, it is returned, along with the unused portion of url.
190
control, relpath = bzrdir.BzrDir.open_containing(url,
192
return control.open_branch(), relpath
194
def _push_should_merge_tags(self):
195
"""Should _basic_push merge this branch's tags into the target?
197
The default implementation returns False if this branch has no tags,
198
and True the rest of the time. Subclasses may override this.
200
return self.supports_tags() and self.tags.get_tag_dict()
202
def get_config(self):
203
return BranchConfig(self)
205
def _get_config(self):
206
"""Get the concrete config for just the config in this branch.
208
This is not intended for client use; see Branch.get_config for the
213
:return: An object supporting get_option and set_option.
215
raise NotImplementedError(self._get_config)
217
def _get_fallback_repository(self, url):
218
"""Get the repository we fallback to at url."""
219
url = urlutils.join(self.base, url)
220
a_bzrdir = bzrdir.BzrDir.open(url,
221
possible_transports=[self.bzrdir.root_transport])
222
return a_bzrdir.open_branch().repository
224
def _get_tags_bytes(self):
225
"""Get the bytes of a serialised tags dict.
227
Note that not all branches support tags, nor do all use the same tags
228
logic: this method is specific to BasicTags. Other tag implementations
229
may use the same method name and behave differently, safely, because
230
of the double-dispatch via
231
format.make_tags->tags_instance->get_tags_dict.
233
:return: The bytes of the tags file.
234
:seealso: Branch._set_tags_bytes.
236
return self._transport.get_bytes('tags')
238
def _get_nick(self, local=False, possible_transports=None):
239
config = self.get_config()
240
# explicit overrides master, but don't look for master if local is True
241
if not local and not config.has_explicit_nickname():
152
t = get_transport(url)
243
master = self.get_master_branch(possible_transports)
244
if master is not None:
245
# return the master branch value
247
except errors.BzrError, e:
248
# Silently fall back to local implicit nick if the master is
250
mutter("Could not connect to bound branch, "
251
"falling back to local nick.\n " + str(e))
252
return config.get_nickname()
155
format = BzrBranchFormat.find_format(t)
156
return format.open(t), t.relpath(url)
157
# TODO FIXME, distinguish between formats that cannot be
158
# identified, and a lack of format.
159
except NotBranchError, e:
160
mutter('not a branch in: %r %s', t.base, e)
161
new_t = t.clone('..')
162
if new_t.base == t.base:
163
# reached the root, whatever that may be
164
raise NotBranchError(path=url)
168
def initialize(base):
169
"""Create a new branch, rooted at 'base' (url)
171
This will call the current default initializer with base
172
as the only parameter.
174
return Branch._default_initializer(safe_unicode(base))
177
def get_default_initializer():
178
"""Return the initializer being used for new branches."""
179
return Branch._default_initializer
182
def set_default_initializer(initializer):
183
"""Set the initializer to be used for new branches."""
184
Branch._default_initializer = staticmethod(initializer)
186
def setup_caching(self, cache_root):
187
"""Subclasses that care about caching should override this, and set
188
up cached stores located under cache_root.
190
self.cache_root = cache_root
193
cfg = self.tree_config()
194
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
254
196
def _set_nick(self, nick):
255
self.get_config().set_user_option('nickname', nick, warn_masked=True)
197
cfg = self.tree_config()
198
cfg.set_option(nick, "nickname")
199
assert cfg.get_option("nickname") == nick
257
201
nick = property(_get_nick, _set_nick)
260
raise NotImplementedError(self.is_locked)
262
def _lefthand_history(self, revision_id, last_rev=None,
264
if 'evil' in debug.debug_flags:
265
mutter_callsite(4, "_lefthand_history scales with history.")
266
# stop_revision must be a descendant of last_revision
267
graph = self.repository.get_graph()
268
if last_rev is not None:
269
if not graph.is_ancestor(last_rev, revision_id):
270
# our previous tip is not merged into stop_revision
271
raise errors.DivergedBranches(self, other_branch)
272
# make a new revision history from the graph
273
parents_map = graph.get_parent_map([revision_id])
274
if revision_id not in parents_map:
275
raise errors.NoSuchRevision(self, revision_id)
276
current_rev_id = revision_id
278
check_not_reserved_id = _mod_revision.check_not_reserved_id
279
# Do not include ghosts or graph origin in revision_history
280
while (current_rev_id in parents_map and
281
len(parents_map[current_rev_id]) > 0):
282
check_not_reserved_id(current_rev_id)
283
new_history.append(current_rev_id)
284
current_rev_id = parents_map[current_rev_id][0]
285
parents_map = graph.get_parent_map([current_rev_id])
286
new_history.reverse()
203
def push_stores(self, branch_to):
204
"""Copy the content of this branches store to branch_to."""
205
raise NotImplementedError('push_stores is abstract')
207
def get_transaction(self):
208
"""Return the current active transaction.
210
If no transaction is active, this returns a passthrough object
211
for which all data is immediately flushed and no caching happens.
213
raise NotImplementedError('get_transaction is abstract')
289
215
def lock_write(self):
290
raise NotImplementedError(self.lock_write)
216
raise NotImplementedError('lock_write is abstract')
292
218
def lock_read(self):
293
raise NotImplementedError(self.lock_read)
219
raise NotImplementedError('lock_read is abstract')
295
221
def unlock(self):
296
raise NotImplementedError(self.unlock)
298
def peek_lock_mode(self):
299
"""Return lock mode for the Branch: 'r', 'w' or None"""
300
raise NotImplementedError(self.peek_lock_mode)
302
def get_physical_lock_status(self):
303
raise NotImplementedError(self.get_physical_lock_status)
306
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
307
"""Return the revision_id for a dotted revno.
309
:param revno: a tuple like (1,) or (1,1,2)
310
:param _cache_reverse: a private parameter enabling storage
311
of the reverse mapping in a top level cache. (This should
312
only be done in selective circumstances as we want to
313
avoid having the mapping cached multiple times.)
314
:return: the revision_id
315
:raises errors.NoSuchRevision: if the revno doesn't exist
317
rev_id = self._do_dotted_revno_to_revision_id(revno)
319
self._partial_revision_id_to_revno_cache[rev_id] = revno
322
def _do_dotted_revno_to_revision_id(self, revno):
323
"""Worker function for dotted_revno_to_revision_id.
325
Subclasses should override this if they wish to
326
provide a more efficient implementation.
329
return self.get_rev_id(revno[0])
330
revision_id_to_revno = self.get_revision_id_to_revno_map()
331
revision_ids = [revision_id for revision_id, this_revno
332
in revision_id_to_revno.iteritems()
333
if revno == this_revno]
334
if len(revision_ids) == 1:
335
return revision_ids[0]
337
revno_str = '.'.join(map(str, revno))
338
raise errors.NoSuchRevision(self, revno_str)
341
def revision_id_to_dotted_revno(self, revision_id):
342
"""Given a revision id, return its dotted revno.
344
:return: a tuple like (1,) or (400,1,3).
346
return self._do_revision_id_to_dotted_revno(revision_id)
348
def _do_revision_id_to_dotted_revno(self, revision_id):
349
"""Worker function for revision_id_to_revno."""
350
# Try the caches if they are loaded
351
result = self._partial_revision_id_to_revno_cache.get(revision_id)
352
if result is not None:
354
if self._revision_id_to_revno_cache:
355
result = self._revision_id_to_revno_cache.get(revision_id)
357
raise errors.NoSuchRevision(self, revision_id)
358
# Try the mainline as it's optimised
360
revno = self.revision_id_to_revno(revision_id)
362
except errors.NoSuchRevision:
363
# We need to load and use the full revno map after all
364
result = self.get_revision_id_to_revno_map().get(revision_id)
366
raise errors.NoSuchRevision(self, revision_id)
370
def get_revision_id_to_revno_map(self):
371
"""Return the revision_id => dotted revno map.
373
This will be regenerated on demand, but will be cached.
375
:return: A dictionary mapping revision_id => dotted revno.
376
This dictionary should not be modified by the caller.
378
if self._revision_id_to_revno_cache is not None:
379
mapping = self._revision_id_to_revno_cache
381
mapping = self._gen_revno_map()
382
self._cache_revision_id_to_revno(mapping)
383
# TODO: jam 20070417 Since this is being cached, should we be returning
385
# I would rather not, and instead just declare that users should not
386
# modify the return value.
389
def _gen_revno_map(self):
390
"""Create a new mapping from revision ids to dotted revnos.
392
Dotted revnos are generated based on the current tip in the revision
394
This is the worker function for get_revision_id_to_revno_map, which
395
just caches the return value.
397
:return: A dictionary mapping revision_id => dotted revno.
399
revision_id_to_revno = dict((rev_id, revno)
400
for rev_id, depth, revno, end_of_merge
401
in self.iter_merge_sorted_revisions())
402
return revision_id_to_revno
405
def iter_merge_sorted_revisions(self, start_revision_id=None,
406
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
407
"""Walk the revisions for a branch in merge sorted order.
409
Merge sorted order is the output from a merge-aware,
410
topological sort, i.e. all parents come before their
411
children going forward; the opposite for reverse.
413
:param start_revision_id: the revision_id to begin walking from.
414
If None, the branch tip is used.
415
:param stop_revision_id: the revision_id to terminate the walk
416
after. If None, the rest of history is included.
417
:param stop_rule: if stop_revision_id is not None, the precise rule
418
to use for termination:
419
* 'exclude' - leave the stop revision out of the result (default)
420
* 'include' - the stop revision is the last item in the result
421
* 'with-merges' - include the stop revision and all of its
422
merged revisions in the result
423
:param direction: either 'reverse' or 'forward':
424
* reverse means return the start_revision_id first, i.e.
425
start at the most recent revision and go backwards in history
426
* forward returns tuples in the opposite order to reverse.
427
Note in particular that forward does *not* do any intelligent
428
ordering w.r.t. depth as some clients of this API may like.
429
(If required, that ought to be done at higher layers.)
431
:return: an iterator over (revision_id, depth, revno, end_of_merge)
434
* revision_id: the unique id of the revision
435
* depth: How many levels of merging deep this node has been
437
* revno_sequence: This field provides a sequence of
438
revision numbers for all revisions. The format is:
439
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
440
branch that the revno is on. From left to right the REVNO numbers
441
are the sequence numbers within that branch of the revision.
442
* end_of_merge: When True the next node (earlier in history) is
443
part of a different merge.
445
# Note: depth and revno values are in the context of the branch so
446
# we need the full graph to get stable numbers, regardless of the
448
if self._merge_sorted_revisions_cache is None:
449
last_revision = self.last_revision()
450
last_key = (last_revision,)
451
known_graph = self.repository.revisions.get_known_graph_ancestry(
453
self._merge_sorted_revisions_cache = known_graph.merge_sort(
455
filtered = self._filter_merge_sorted_revisions(
456
self._merge_sorted_revisions_cache, start_revision_id,
457
stop_revision_id, stop_rule)
458
if direction == 'reverse':
460
if direction == 'forward':
461
return reversed(list(filtered))
463
raise ValueError('invalid direction %r' % direction)
465
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
466
start_revision_id, stop_revision_id, stop_rule):
467
"""Iterate over an inclusive range of sorted revisions."""
468
rev_iter = iter(merge_sorted_revisions)
469
if start_revision_id is not None:
470
for node in rev_iter:
471
rev_id = node.key[-1]
472
if rev_id != start_revision_id:
475
# The decision to include the start or not
476
# depends on the stop_rule if a stop is provided
477
# so pop this node back into the iterator
478
rev_iter = chain(iter([node]), rev_iter)
480
if stop_revision_id is None:
482
for node in rev_iter:
483
rev_id = node.key[-1]
484
yield (rev_id, node.merge_depth, node.revno,
486
elif stop_rule == 'exclude':
487
for node in rev_iter:
488
rev_id = node.key[-1]
489
if rev_id == stop_revision_id:
491
yield (rev_id, node.merge_depth, node.revno,
493
elif stop_rule == 'include':
494
for node in rev_iter:
495
rev_id = node.key[-1]
496
yield (rev_id, node.merge_depth, node.revno,
498
if rev_id == stop_revision_id:
500
elif stop_rule == 'with-merges':
501
stop_rev = self.repository.get_revision(stop_revision_id)
502
if stop_rev.parent_ids:
503
left_parent = stop_rev.parent_ids[0]
505
left_parent = _mod_revision.NULL_REVISION
506
# left_parent is the actual revision we want to stop logging at,
507
# since we want to show the merged revisions after the stop_rev too
508
reached_stop_revision_id = False
509
revision_id_whitelist = []
510
for node in rev_iter:
511
rev_id = node.key[-1]
512
if rev_id == left_parent:
513
# reached the left parent after the stop_revision
515
if (not reached_stop_revision_id or
516
rev_id in revision_id_whitelist):
517
yield (rev_id, node.merge_depth, node.revno,
519
if reached_stop_revision_id or rev_id == stop_revision_id:
520
# only do the merged revs of rev_id from now on
521
rev = self.repository.get_revision(rev_id)
523
reached_stop_revision_id = True
524
revision_id_whitelist.extend(rev.parent_ids)
526
raise ValueError('invalid stop_rule %r' % stop_rule)
528
def leave_lock_in_place(self):
529
"""Tell this branch object not to release the physical lock when this
532
If lock_write doesn't return a token, then this method is not supported.
534
self.control_files.leave_in_place()
536
def dont_leave_lock_in_place(self):
537
"""Tell this branch object to release the physical lock when this
538
object is unlocked, even if it didn't originally acquire it.
540
If lock_write doesn't return a token, then this method is not supported.
542
self.control_files.dont_leave_in_place()
544
def bind(self, other):
545
"""Bind the local branch the other branch.
547
:param other: The branch to bind to
550
raise errors.UpgradeRequired(self.base)
552
def set_append_revisions_only(self, enabled):
553
if not self._format.supports_set_append_revisions_only():
554
raise errors.UpgradeRequired(self.base)
559
self.get_config().set_user_option('append_revisions_only', value,
562
def set_reference_info(self, file_id, tree_path, branch_location):
563
"""Set the branch location to use for a tree reference."""
564
raise errors.UnsupportedOperation(self.set_reference_info, self)
566
def get_reference_info(self, file_id):
567
"""Get the tree_path and branch_location for a tree reference."""
568
raise errors.UnsupportedOperation(self.get_reference_info, self)
571
def fetch(self, from_branch, last_revision=None, pb=None):
572
"""Copy revisions from from_branch into this branch.
574
:param from_branch: Where to copy from.
575
:param last_revision: What revision to stop at (None for at the end
577
:param pb: An optional progress bar to use.
580
if self.base == from_branch.base:
583
symbol_versioning.warn(
584
symbol_versioning.deprecated_in((1, 14, 0))
585
% "pb parameter to fetch()")
586
from_branch.lock_read()
588
if last_revision is None:
589
last_revision = from_branch.last_revision()
590
last_revision = _mod_revision.ensure_null(last_revision)
591
return self.repository.fetch(from_branch.repository,
592
revision_id=last_revision,
597
def get_bound_location(self):
598
"""Return the URL of the branch we are bound to.
600
Older format branches cannot bind, please be sure to use a metadir
605
def get_old_bound_location(self):
606
"""Return the URL of the branch we used to be bound to
608
raise errors.UpgradeRequired(self.base)
610
def get_commit_builder(self, parents, config=None, timestamp=None,
611
timezone=None, committer=None, revprops=None,
613
"""Obtain a CommitBuilder for this branch.
615
:param parents: Revision ids of the parents of the new revision.
616
:param config: Optional configuration to use.
617
:param timestamp: Optional timestamp recorded for commit.
618
:param timezone: Optional timezone for timestamp.
619
:param committer: Optional committer to set for commit.
620
:param revprops: Optional dictionary of revision properties.
621
:param revision_id: Optional revision id.
625
config = self.get_config()
627
return self.repository.get_commit_builder(self, parents, config,
628
timestamp, timezone, committer, revprops, revision_id)
630
def get_master_branch(self, possible_transports=None):
631
"""Return the branch we are bound to.
633
:return: Either a Branch, or None
222
raise NotImplementedError('unlock is abstract')
224
def abspath(self, name):
225
"""Return absolute filename for something in the branch
227
XXX: Robert Collins 20051017 what is this used for? why is it a branch
228
method and not a tree method.
230
raise NotImplementedError('abspath is abstract')
232
def controlfilename(self, file_or_path):
233
"""Return location relative to branch."""
234
raise NotImplementedError('controlfilename is abstract')
236
def controlfile(self, file_or_path, mode='r'):
237
"""Open a control file for this branch.
239
There are two classes of file in the control directory: text
240
and binary. binary files are untranslated byte streams. Text
241
control files are stored with Unix newlines and in UTF-8, even
242
if the platform or locale defaults are different.
244
Controlfiles should almost never be opened in write mode but
245
rather should be atomically copied and replaced using atomicfile.
247
raise NotImplementedError('controlfile is abstract')
249
def put_controlfile(self, path, f, encode=True):
250
"""Write an entry as a controlfile.
252
:param path: The path to put the file, relative to the .bzr control
254
:param f: A file-like or string object whose contents should be copied.
255
:param encode: If true, encode the contents as utf-8
257
raise NotImplementedError('put_controlfile is abstract')
259
def put_controlfiles(self, files, encode=True):
260
"""Write several entries as controlfiles.
262
:param files: A list of [(path, file)] pairs, where the path is the directory
263
underneath the bzr control directory
264
:param encode: If true, encode the contents as utf-8
266
raise NotImplementedError('put_controlfiles is abstract')
268
def get_root_id(self):
269
"""Return the id of this branches root"""
270
raise NotImplementedError('get_root_id is abstract')
272
def set_root_id(self, file_id):
273
raise NotImplementedError('set_root_id is abstract')
275
def print_file(self, file, revision_id):
276
"""Print `file` to stdout."""
277
raise NotImplementedError('print_file is abstract')
279
def append_revision(self, *revision_ids):
280
raise NotImplementedError('append_revision is abstract')
282
def set_revision_history(self, rev_history):
283
raise NotImplementedError('set_revision_history is abstract')
285
def has_revision(self, revision_id):
286
"""True if this branch has a copy of the revision.
288
This does not necessarily imply the revision is merge
289
or on the mainline."""
290
raise NotImplementedError('has_revision is abstract')
292
def get_revision_xml(self, revision_id):
293
raise NotImplementedError('get_revision_xml is abstract')
295
def get_revision(self, revision_id):
296
"""Return the Revision object for a named revision"""
297
raise NotImplementedError('get_revision is abstract')
637
299
def get_revision_delta(self, revno):
638
300
"""Return the delta for one revision.
1409
532
* a format string,
1410
533
* an open routine.
1412
Formats are placed in an dict by their format string for reference
535
Formats are placed in an dict by their format string for reference
1413
536
during branch opening. Its not required that these be instances, they
1414
can be classes themselves with class methods - it simply depends on
537
can be classes themselves with class methods - it simply depends on
1415
538
whether state is needed for a given format or not.
1417
540
Once a format is deprecated, just deprecate the initialize and open
1418
methods on the format class. Do not deprecate the object, as the
541
methods on the format class. Do not deprecate the object, as the
1419
542
object will be created every time regardless.
1422
_default_format = None
1423
"""The default format used for new branches."""
1426
546
"""The known formats."""
1428
can_set_append_revisions_only = True
1430
def __eq__(self, other):
1431
return self.__class__ is other.__class__
1433
def __ne__(self, other):
1434
return not (self == other)
1437
def find_format(klass, a_bzrdir):
1438
"""Return the format for the branch object in a_bzrdir."""
549
def find_format(klass, transport):
550
"""Return the format registered for URL."""
1440
transport = a_bzrdir.get_branch_transport(None)
1441
format_string = transport.get_bytes("format")
552
format_string = transport.get(".bzr/branch-format").read()
1442
553
return klass._formats[format_string]
1443
except errors.NoSuchFile:
1444
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
555
raise NotBranchError(path=transport.base)
1445
556
except KeyError:
1446
raise errors.UnknownFormatError(format=format_string, kind='branch')
1449
def get_default_format(klass):
1450
"""Return the current default format."""
1451
return klass._default_format
1453
def get_reference(self, a_bzrdir):
1454
"""Get the target reference of the branch in a_bzrdir.
1456
format probing must have been completed before calling
1457
this method - it is assumed that the format of the branch
1458
in a_bzrdir is correct.
1460
:param a_bzrdir: The bzrdir to get the branch data from.
1461
:return: None if the branch is not a reference branch.
1466
def set_reference(self, a_bzrdir, to_branch):
1467
"""Set the target reference of the branch in a_bzrdir.
1469
format probing must have been completed before calling
1470
this method - it is assumed that the format of the branch
1471
in a_bzrdir is correct.
1473
:param a_bzrdir: The bzrdir to set the branch reference for.
1474
:param to_branch: branch that the checkout is to reference
1476
raise NotImplementedError(self.set_reference)
557
raise errors.UnknownFormatError(format_string)
1478
559
def get_format_string(self):
1479
560
"""Return the ASCII format string that identifies this format."""
1480
561
raise NotImplementedError(self.get_format_string)
1482
def get_format_description(self):
1483
"""Return the short format description for this format."""
1484
raise NotImplementedError(self.get_format_description)
1486
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1488
"""Initialize a branch in a bzrdir, with specified files
1490
:param a_bzrdir: The bzrdir to initialize the branch in
1491
:param utf8_files: The files to create as a list of
1492
(filename, content) tuples
1493
:param set_format: If True, set the format with
1494
self.get_format_string. (BzrBranch4 has its format set
1496
:return: a branch in this format
563
def _find_modes(self, t):
564
"""Determine the appropriate modes for files and directories.
566
FIXME: When this merges into, or from storage,
567
this code becomes delgatable to a LockableFiles instance.
569
For now its cribbed and returns (dir_mode, file_mode)
1498
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1499
branch_transport = a_bzrdir.get_branch_transport(self)
1501
'metadir': ('lock', lockdir.LockDir),
1502
'branch4': ('branch-lock', lockable_files.TransportLock),
1504
lock_name, lock_class = lock_map[lock_type]
1505
control_files = lockable_files.LockableFiles(branch_transport,
1506
lock_name, lock_class)
1507
control_files.create_lock()
1509
control_files.lock_write()
1510
except errors.LockContention:
1511
if lock_type != 'branch4':
573
except errors.TransportNotPossible:
1517
utf8_files += [('format', self.get_format_string())]
1519
for (filename, content) in utf8_files:
1520
branch_transport.put_bytes(
1522
mode=a_bzrdir._get_file_mode())
1525
control_files.unlock()
1526
return self.open(a_bzrdir, _found=True)
1528
def initialize(self, a_bzrdir):
1529
"""Create a branch of this format in a_bzrdir."""
1530
raise NotImplementedError(self.initialize)
577
dir_mode = st.st_mode & 07777
578
# Remove the sticky and execute bits for files
579
file_mode = dir_mode & ~07111
580
if not BzrBranch._set_dir_mode:
582
if not BzrBranch._set_file_mode:
584
return dir_mode, file_mode
586
def initialize(self, url):
587
"""Create a branch of this format at url and return an open branch."""
588
t = get_transport(url)
589
from bzrlib.inventory import Inventory
590
from bzrlib.weavefile import write_weave_v5
591
from bzrlib.weave import Weave
593
# Create an empty inventory
595
# if we want per-tree root ids then this is the place to set
596
# them; they're not needed for now and so ommitted for
598
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
599
empty_inv = sio.getvalue()
601
bzrlib.weavefile.write_weave_v5(Weave(), sio)
602
empty_weave = sio.getvalue()
604
# Since we don't have a .bzr directory, inherit the
605
# mode from the root directory
606
dir_mode, file_mode = self._find_modes(t)
608
t.mkdir('.bzr', mode=dir_mode)
609
control = t.clone('.bzr')
610
dirs = ['revision-store', 'weaves']
612
StringIO("This is a Bazaar-NG control directory.\n"
613
"Do not change any files in this directory.\n")),
614
('branch-format', StringIO(self.get_format_string())),
615
('revision-history', StringIO('')),
616
('branch-name', StringIO('')),
617
('branch-lock', StringIO('')),
618
('pending-merges', StringIO('')),
619
('inventory', StringIO(empty_inv)),
620
('inventory.weave', StringIO(empty_weave)),
621
('ancestry.weave', StringIO(empty_weave))
623
control.mkdir_multi(dirs, mode=dir_mode)
624
control.put_multi(files, mode=file_mode)
625
mutter('created control directory in ' + t.base)
626
return BzrBranch(t, format=self)
1532
628
def is_supported(self):
1533
629
"""Is this format supported?
1535
631
Supported formats can be initialized and opened.
1536
Unsupported formats may not support initialization or committing or
632
Unsupported formats may not support initialization or committing or
1537
633
some other features depending on the reason for not being supported.
1541
def make_tags(self, branch):
1542
"""Create a tags object for branch.
1544
This method is on BranchFormat, because BranchFormats are reflected
1545
over the wire via network_name(), whereas full Branch instances require
1546
multiple VFS method calls to operate at all.
1548
The default implementation returns a disabled-tags instance.
1550
Note that it is normal for branch to be a RemoteBranch when using tags
1553
return DisabledTags(branch)
1555
def network_name(self):
1556
"""A simple byte string uniquely identifying this format for RPC calls.
1558
MetaDir branch formats use their disk format string to identify the
1559
repository over the wire. All in one formats such as bzr < 0.8, and
1560
foreign formats like svn/git and hg should use some marker which is
1561
unique and immutable.
1563
raise NotImplementedError(self.network_name)
1565
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1566
"""Return the branch object for a_bzrdir
1568
:param a_bzrdir: A BzrDir that contains a branch.
1569
:param _found: a private parameter, do not use it. It is used to
1570
indicate if format probing has already be done.
1571
:param ignore_fallbacks: when set, no fallback branches will be opened
1572
(if there are any). Default is to open fallbacks.
1574
raise NotImplementedError(self.open)
637
def open(self, transport):
638
"""Fill out the data in branch for the branch at url."""
639
return BzrBranch(transport, format=self)
1577
642
def register_format(klass, format):
1578
"""Register a metadir format."""
1579
643
klass._formats[format.get_format_string()] = format
1580
# Metadir formats have a network name of their format string, and get
1581
# registered as class factories.
1582
network_format_registry.register(format.get_format_string(), format.__class__)
1585
def set_default_format(klass, format):
1586
klass._default_format = format
1588
def supports_set_append_revisions_only(self):
1589
"""True if this format supports set_append_revisions_only."""
1592
def supports_stacking(self):
1593
"""True if this format records a stacked-on branch."""
1597
646
def unregister_format(klass, format):
647
assert klass._formats[format.get_format_string()] is format
1598
648
del klass._formats[format.get_format_string()]
1601
return self.get_format_description().rstrip()
1603
def supports_tags(self):
1604
"""True if this format supports tags stored in the branch"""
1605
return False # by default
1608
class BranchHooks(Hooks):
1609
"""A dictionary mapping hook name to a list of callables for branch hooks.
1611
e.g. ['set_rh'] Is the list of items to be called when the
1612
set_revision_history function is invoked.
1616
"""Create the default hooks.
1618
These are all empty initially, because by default nothing should get
1621
Hooks.__init__(self)
1622
self.create_hook(HookPoint('set_rh',
1623
"Invoked whenever the revision history has been set via "
1624
"set_revision_history. The api signature is (branch, "
1625
"revision_history), and the branch will be write-locked. "
1626
"The set_rh hook can be expensive for bzr to trigger, a better "
1627
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1628
self.create_hook(HookPoint('open',
1629
"Called with the Branch object that has been opened after a "
1630
"branch is opened.", (1, 8), None))
1631
self.create_hook(HookPoint('post_push',
1632
"Called after a push operation completes. post_push is called "
1633
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1634
"bzr client.", (0, 15), None))
1635
self.create_hook(HookPoint('post_pull',
1636
"Called after a pull operation completes. post_pull is called "
1637
"with a bzrlib.branch.PullResult object and only runs in the "
1638
"bzr client.", (0, 15), None))
1639
self.create_hook(HookPoint('pre_commit',
1640
"Called after a commit is calculated but before it is is "
1641
"completed. pre_commit is called with (local, master, old_revno, "
1642
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1643
"). old_revid is NULL_REVISION for the first commit to a branch, "
1644
"tree_delta is a TreeDelta object describing changes from the "
1645
"basis revision. hooks MUST NOT modify this delta. "
1646
" future_tree is an in-memory tree obtained from "
1647
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1648
"tree.", (0,91), None))
1649
self.create_hook(HookPoint('post_commit',
1650
"Called in the bzr client after a commit has completed. "
1651
"post_commit is called with (local, master, old_revno, old_revid, "
1652
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1653
"commit to a branch.", (0, 15), None))
1654
self.create_hook(HookPoint('post_uncommit',
1655
"Called in the bzr client after an uncommit completes. "
1656
"post_uncommit is called with (local, master, old_revno, "
1657
"old_revid, new_revno, new_revid) where local is the local branch "
1658
"or None, master is the target branch, and an empty branch "
1659
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1660
self.create_hook(HookPoint('pre_change_branch_tip',
1661
"Called in bzr client and server before a change to the tip of a "
1662
"branch is made. pre_change_branch_tip is called with a "
1663
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1664
"commit, uncommit will all trigger this hook.", (1, 6), None))
1665
self.create_hook(HookPoint('post_change_branch_tip',
1666
"Called in bzr client and server after a change to the tip of a "
1667
"branch is made. post_change_branch_tip is called with a "
1668
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1669
"commit, uncommit will all trigger this hook.", (1, 4), None))
1670
self.create_hook(HookPoint('transform_fallback_location',
1671
"Called when a stacked branch is activating its fallback "
1672
"locations. transform_fallback_location is called with (branch, "
1673
"url), and should return a new url. Returning the same url "
1674
"allows it to be used as-is, returning a different one can be "
1675
"used to cause the branch to stack on a closer copy of that "
1676
"fallback_location. Note that the branch cannot have history "
1677
"accessing methods called on it during this hook because the "
1678
"fallback locations have not been activated. When there are "
1679
"multiple hooks installed for transform_fallback_location, "
1680
"all are called with the url returned from the previous hook."
1681
"The order is however undefined.", (1, 9), None))
1684
# install the default hooks into the Branch class.
1685
Branch.hooks = BranchHooks()
1688
class ChangeBranchTipParams(object):
1689
"""Object holding parameters passed to *_change_branch_tip hooks.
1691
There are 5 fields that hooks may wish to access:
1693
:ivar branch: the branch being changed
1694
:ivar old_revno: revision number before the change
1695
:ivar new_revno: revision number after the change
1696
:ivar old_revid: revision id before the change
1697
:ivar new_revid: revision id after the change
1699
The revid fields are strings. The revno fields are integers.
1702
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1703
"""Create a group of ChangeBranchTip parameters.
1705
:param branch: The branch being changed.
1706
:param old_revno: Revision number before the change.
1707
:param new_revno: Revision number after the change.
1708
:param old_revid: Tip revision id before the change.
1709
:param new_revid: Tip revision id after the change.
1711
self.branch = branch
1712
self.old_revno = old_revno
1713
self.new_revno = new_revno
1714
self.old_revid = old_revid
1715
self.new_revid = new_revid
1717
def __eq__(self, other):
1718
return self.__dict__ == other.__dict__
1721
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1722
self.__class__.__name__, self.branch,
1723
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1726
class BzrBranchFormat4(BranchFormat):
651
class BzrBranchFormat4(BzrBranchFormat):
1727
652
"""Bzr branch format 4.
1729
654
This format has:
1730
- a revision-history file.
1731
- a branch-lock lock file [ to be shared with the bzrdir ]
656
- TextStores for texts, inventories,revisions.
658
This format is deprecated: it indexes texts using a text it which is
659
removed in format 5; write support for this format has been removed.
1734
def get_format_description(self):
1735
"""See BranchFormat.get_format_description()."""
1736
return "Branch format 4"
1738
def initialize(self, a_bzrdir):
1739
"""Create a branch of this format in a_bzrdir."""
1740
utf8_files = [('revision-history', ''),
1741
('branch-name', ''),
1743
return self._initialize_helper(a_bzrdir, utf8_files,
1744
lock_type='branch4', set_format=False)
1747
super(BzrBranchFormat4, self).__init__()
1748
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1750
def network_name(self):
1751
"""The network name for this format is the control dirs disk label."""
1752
return self._matchingbzrdir.get_format_string()
1754
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1755
"""See BranchFormat.open()."""
1757
# we are being called directly and must probe.
1758
raise NotImplementedError
1759
return BzrBranch(_format=self,
1760
_control_files=a_bzrdir._control_files,
1762
_repository=a_bzrdir.open_repository())
1765
return "Bazaar-NG branch format 4"
1768
class BranchFormatMetadir(BranchFormat):
1769
"""Common logic for meta-dir based branch formats."""
1771
def _branch_class(self):
1772
"""What class to instantiate on open calls."""
1773
raise NotImplementedError(self._branch_class)
1775
def network_name(self):
1776
"""A simple byte string uniquely identifying this format for RPC calls.
1778
Metadir branch formats use their format string.
662
def get_format_string(self):
663
"""See BzrBranchFormat.get_format_string()."""
664
return BZR_BRANCH_FORMAT_4
666
def initialize(self, url):
667
"""Format 4 branches cannot be created."""
668
raise UninitializableFormat(self)
670
def is_supported(self):
671
"""Format 4 is not supported.
673
It is not supported because the model changed from 4 to 5 and the
674
conversion logic is expensive - so doing it on the fly was not
1780
return self.get_format_string()
1782
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1783
"""See BranchFormat.open()."""
1785
format = BranchFormat.find_format(a_bzrdir)
1786
if format.__class__ != self.__class__:
1787
raise AssertionError("wrong format %r found for %r" %
1790
transport = a_bzrdir.get_branch_transport(None)
1791
control_files = lockable_files.LockableFiles(transport, 'lock',
1793
return self._branch_class()(_format=self,
1794
_control_files=control_files,
1796
_repository=a_bzrdir.find_repository(),
1797
ignore_fallbacks=ignore_fallbacks)
1798
except errors.NoSuchFile:
1799
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1802
super(BranchFormatMetadir, self).__init__()
1803
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1804
self._matchingbzrdir.set_branch_format(self)
1806
def supports_tags(self):
1810
class BzrBranchFormat5(BranchFormatMetadir):
680
class BzrBranchFormat5(BzrBranchFormat):
1811
681
"""Bzr branch format 5.
1813
683
This format has:
1814
- a revision-history file.
1816
- a lock dir guarding the branch itself
1817
- all of this stored in a branch/ subdirectory
1818
- works with shared repositories.
1820
This format is new in bzr 0.8.
1823
def _branch_class(self):
1826
def get_format_string(self):
1827
"""See BranchFormat.get_format_string()."""
1828
return "Bazaar-NG branch format 5\n"
1830
def get_format_description(self):
1831
"""See BranchFormat.get_format_description()."""
1832
return "Branch format 5"
1834
def initialize(self, a_bzrdir):
1835
"""Create a branch of this format in a_bzrdir."""
1836
utf8_files = [('revision-history', ''),
1837
('branch-name', ''),
1839
return self._initialize_helper(a_bzrdir, utf8_files)
1841
def supports_tags(self):
1845
class BzrBranchFormat6(BranchFormatMetadir):
1846
"""Branch format with last-revision and tags.
1848
Unlike previous formats, this has no explicit revision history. Instead,
1849
this just stores the last-revision, and the left-hand history leading
1850
up to there is the history.
1852
This format was introduced in bzr 0.15
1853
and became the default in 0.91.
1856
def _branch_class(self):
1859
def get_format_string(self):
1860
"""See BranchFormat.get_format_string()."""
1861
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1863
def get_format_description(self):
1864
"""See BranchFormat.get_format_description()."""
1865
return "Branch format 6"
1867
def initialize(self, a_bzrdir):
1868
"""Create a branch of this format in a_bzrdir."""
1869
utf8_files = [('last-revision', '0 null:\n'),
1870
('branch.conf', ''),
1873
return self._initialize_helper(a_bzrdir, utf8_files)
1875
def make_tags(self, branch):
1876
"""See bzrlib.branch.BranchFormat.make_tags()."""
1877
return BasicTags(branch)
1879
def supports_set_append_revisions_only(self):
1883
class BzrBranchFormat8(BranchFormatMetadir):
1884
"""Metadir format supporting storing locations of subtree branches."""
1886
def _branch_class(self):
1889
def get_format_string(self):
1890
"""See BranchFormat.get_format_string()."""
1891
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1893
def get_format_description(self):
1894
"""See BranchFormat.get_format_description()."""
1895
return "Branch format 8"
1897
def initialize(self, a_bzrdir):
1898
"""Create a branch of this format in a_bzrdir."""
1899
utf8_files = [('last-revision', '0 null:\n'),
1900
('branch.conf', ''),
1904
return self._initialize_helper(a_bzrdir, utf8_files)
1907
super(BzrBranchFormat8, self).__init__()
1908
self._matchingbzrdir.repository_format = \
1909
RepositoryFormatKnitPack5RichRoot()
1911
def make_tags(self, branch):
1912
"""See bzrlib.branch.BranchFormat.make_tags()."""
1913
return BasicTags(branch)
1915
def supports_set_append_revisions_only(self):
1918
def supports_stacking(self):
1921
supports_reference_locations = True
1924
class BzrBranchFormat7(BzrBranchFormat8):
1925
"""Branch format with last-revision, tags, and a stacked location pointer.
1927
The stacked location pointer is passed down to the repository and requires
1928
a repository format with supports_external_lookups = True.
1930
This format was introduced in bzr 1.6.
1933
def initialize(self, a_bzrdir):
1934
"""Create a branch of this format in a_bzrdir."""
1935
utf8_files = [('last-revision', '0 null:\n'),
1936
('branch.conf', ''),
1939
return self._initialize_helper(a_bzrdir, utf8_files)
1941
def _branch_class(self):
1944
def get_format_string(self):
1945
"""See BranchFormat.get_format_string()."""
1946
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1948
def get_format_description(self):
1949
"""See BranchFormat.get_format_description()."""
1950
return "Branch format 7"
1952
def supports_set_append_revisions_only(self):
1955
supports_reference_locations = False
1958
class BranchReferenceFormat(BranchFormat):
1959
"""Bzr branch reference format.
1961
Branch references are used in implementing checkouts, they
1962
act as an alias to the real branch which is at some other url.
684
- weaves for file texts and inventory
686
- TextStores for revisions and signatures.
689
def get_format_string(self):
690
"""See BzrBranchFormat.get_format_string()."""
691
return BZR_BRANCH_FORMAT_5
694
class BzrBranchFormat6(BzrBranchFormat):
695
"""Bzr branch format 6.
1964
697
This format has:
698
- weaves for file texts and inventory
699
- hash subdirectory based stores.
700
- TextStores for revisions and signatures.
1969
703
def get_format_string(self):
1970
"""See BranchFormat.get_format_string()."""
1971
return "Bazaar-NG Branch Reference Format 1\n"
1973
def get_format_description(self):
1974
"""See BranchFormat.get_format_description()."""
1975
return "Checkout reference format 1"
1977
def get_reference(self, a_bzrdir):
1978
"""See BranchFormat.get_reference()."""
1979
transport = a_bzrdir.get_branch_transport(None)
1980
return transport.get_bytes('location')
1982
def set_reference(self, a_bzrdir, to_branch):
1983
"""See BranchFormat.set_reference()."""
1984
transport = a_bzrdir.get_branch_transport(None)
1985
location = transport.put_bytes('location', to_branch.base)
1987
def initialize(self, a_bzrdir, target_branch=None):
1988
"""Create a branch of this format in a_bzrdir."""
1989
if target_branch is None:
1990
# this format does not implement branch itself, thus the implicit
1991
# creation contract must see it as uninitializable
1992
raise errors.UninitializableFormat(self)
1993
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1994
branch_transport = a_bzrdir.get_branch_transport(self)
1995
branch_transport.put_bytes('location',
1996
target_branch.bzrdir.root_transport.base)
1997
branch_transport.put_bytes('format', self.get_format_string())
1999
a_bzrdir, _found=True,
2000
possible_transports=[target_branch.bzrdir.root_transport])
2003
super(BranchReferenceFormat, self).__init__()
2004
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2005
self._matchingbzrdir.set_branch_format(self)
2007
def _make_reference_clone_function(format, a_branch):
2008
"""Create a clone() routine for a branch dynamically."""
2009
def clone(to_bzrdir, revision_id=None,
2010
repository_policy=None):
2011
"""See Branch.clone()."""
2012
return format.initialize(to_bzrdir, a_branch)
2013
# cannot obey revision_id limits when cloning a reference ...
2014
# FIXME RBC 20060210 either nuke revision_id for clone, or
2015
# emit some sort of warning/error to the caller ?!
2018
def open(self, a_bzrdir, _found=False, location=None,
2019
possible_transports=None, ignore_fallbacks=False):
2020
"""Return the branch that the branch reference in a_bzrdir points at.
2022
:param a_bzrdir: A BzrDir that contains a branch.
2023
:param _found: a private parameter, do not use it. It is used to
2024
indicate if format probing has already be done.
2025
:param ignore_fallbacks: when set, no fallback branches will be opened
2026
(if there are any). Default is to open fallbacks.
2027
:param location: The location of the referenced branch. If
2028
unspecified, this will be determined from the branch reference in
2030
:param possible_transports: An optional reusable transports list.
2033
format = BranchFormat.find_format(a_bzrdir)
2034
if format.__class__ != self.__class__:
2035
raise AssertionError("wrong format %r found for %r" %
2037
if location is None:
2038
location = self.get_reference(a_bzrdir)
2039
real_bzrdir = bzrdir.BzrDir.open(
2040
location, possible_transports=possible_transports)
2041
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2042
# this changes the behaviour of result.clone to create a new reference
2043
# rather than a copy of the content of the branch.
2044
# I did not use a proxy object because that needs much more extensive
2045
# testing, and we are only changing one behaviour at the moment.
2046
# If we decide to alter more behaviours - i.e. the implicit nickname
2047
# then this should be refactored to introduce a tested proxy branch
2048
# and a subclass of that for use in overriding clone() and ....
2050
result.clone = self._make_reference_clone_function(result)
2054
network_format_registry = registry.FormatRegistry()
2055
"""Registry of formats indexed by their network name.
2057
The network name for a branch format is an identifier that can be used when
2058
referring to formats with smart server operations. See
2059
BranchFormat.network_name() for more detail.
2063
# formats which have no format string are not discoverable
2064
# and not independently creatable, so are not registered.
2065
__format5 = BzrBranchFormat5()
2066
__format6 = BzrBranchFormat6()
2067
__format7 = BzrBranchFormat7()
2068
__format8 = BzrBranchFormat8()
2069
BranchFormat.register_format(__format5)
2070
BranchFormat.register_format(BranchReferenceFormat())
2071
BranchFormat.register_format(__format6)
2072
BranchFormat.register_format(__format7)
2073
BranchFormat.register_format(__format8)
2074
BranchFormat.set_default_format(__format7)
2075
_legacy_formats = [BzrBranchFormat4(),
2077
network_format_registry.register(
2078
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2081
class BzrBranch(Branch, _RelockDebugMixin):
704
"""See BzrBranchFormat.get_format_string()."""
705
return BZR_BRANCH_FORMAT_6
708
BzrBranchFormat.register_format(BzrBranchFormat4())
709
BzrBranchFormat.register_format(BzrBranchFormat5())
710
BzrBranchFormat.register_format(BzrBranchFormat6())
713
class BzrBranch(Branch):
2082
714
"""A branch stored in the actual filesystem.
2084
716
Note that it's "local" in the context of the filesystem; it doesn't
2085
717
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2086
718
it's writable, and can be accessed via the normal filesystem API.
2088
:ivar _transport: Transport for file operations on this branch's
2089
control files, typically pointing to the .bzr/branch directory.
2090
:ivar repository: Repository for this branch.
2091
:ivar base: The url of the base directory for this branch; the one
2092
containing the .bzr directory.
724
If _lock_mode is true, a positive count of the number of times the
728
Lock object from bzrlib.lock.
2095
def __init__(self, _format=None,
2096
_control_files=None, a_bzrdir=None, _repository=None,
2097
ignore_fallbacks=False):
2098
"""Create new branch object at a particular location."""
2099
if a_bzrdir is None:
2100
raise ValueError('a_bzrdir must be supplied')
2102
self.bzrdir = a_bzrdir
2103
self._base = self.bzrdir.transport.clone('..').base
2104
# XXX: We should be able to just do
2105
# self.base = self.bzrdir.root_transport.base
2106
# but this does not quite work yet -- mbp 20080522
2107
self._format = _format
2108
if _control_files is None:
2109
raise ValueError('BzrBranch _control_files is None')
2110
self.control_files = _control_files
2111
self._transport = _control_files._transport
2112
self.repository = _repository
2113
Branch.__init__(self)
730
# We actually expect this class to be somewhat short-lived; part of its
731
# purpose is to try to isolate what bits of the branch logic are tied to
732
# filesystem access, so that in a later step, we can extricate them to
733
# a separarte ("storage") class.
737
_inventory_weave = None
738
# If set to False (by a plugin, etc) BzrBranch will not set the
739
# mode on created files or directories
740
_set_file_mode = True
743
# Map some sort of prefix into a namespace
744
# stuff like "revno:10", "revid:", etc.
745
# This should match a prefix with a function which accepts
746
REVISION_NAMESPACES = {}
748
def push_stores(self, branch_to):
749
"""See Branch.push_stores."""
750
if (not isinstance(self._branch_format, BzrBranchFormat4) or
751
self._branch_format != branch_to._branch_format):
752
from bzrlib.fetch import greedy_fetch
753
mutter("Using fetch logic to push between %s(%s) and %s(%s)",
754
self, self._branch_format, branch_to, branch_to._branch_format)
755
greedy_fetch(to_branch=branch_to, from_branch=self,
756
revision=self.last_revision())
759
# format 4 to format 4 logic only.
760
store_pairs = ((self.text_store, branch_to.text_store),
761
(self.inventory_store, branch_to.inventory_store),
762
(self.revision_store, branch_to.revision_store))
764
for from_store, to_store in store_pairs:
765
copy_all(from_store, to_store)
766
except UnlistableStore:
767
raise UnlistableBranch(from_store)
769
def __init__(self, transport, init=deprecated_nonce,
770
relax_version_check=deprecated_nonce, format=None):
771
"""Create new branch object at a particular location.
773
transport -- A Transport object, defining how to access files.
775
init -- If True, create new control files in a previously
776
unversioned directory. If False, the branch must already
779
relax_version_check -- If true, the usual check for the branch
780
version is not applied. This is intended only for
781
upgrade/recovery type use; it's not guaranteed that
782
all operations will work on old format branches.
784
In the test suite, creation of new trees is tested using the
785
`ScratchBranch` class.
787
assert isinstance(transport, Transport), \
788
"%r is not a Transport" % transport
789
self._transport = transport
790
if deprecated_passed(init):
791
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
792
"deprecated as of bzr 0.8. Please use Branch.initialize().",
795
# this is slower than before deprecation, oh well never mind.
797
self._initialize(transport.base)
799
self._check_format(format)
800
if deprecated_passed(relax_version_check):
801
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
802
"relax_version_check parameter is deprecated as of bzr 0.8. "
803
"Please use Branch.open_downlevel, or a BzrBranchFormat's "
804
"open() method.", DeprecationWarning)
805
if (not relax_version_check
806
and not self._branch_format.is_supported()):
807
raise errors.UnsupportedFormatError(
808
'sorry, branch format %r not supported' % fmt,
809
['use a different bzr version',
810
'or remove the .bzr directory'
811
' and "bzr init" again'])
813
def get_store(name, compressed=True, prefixed=False):
814
relpath = self._rel_controlfilename(safe_unicode(name))
815
store = TextStore(self._transport.clone(relpath),
816
dir_mode=self._dir_mode,
817
file_mode=self._file_mode,
819
compressed=compressed)
822
def get_weave(name, prefixed=False):
823
relpath = self._rel_controlfilename(unicode(name))
824
ws = WeaveStore(self._transport.clone(relpath),
826
dir_mode=self._dir_mode,
827
file_mode=self._file_mode)
828
if self._transport.should_cache():
829
ws.enable_cache = True
832
if isinstance(self._branch_format, BzrBranchFormat4):
833
self.inventory_store = get_store('inventory-store')
834
self.text_store = get_store('text-store')
835
self.revision_store = get_store('revision-store')
836
elif isinstance(self._branch_format, BzrBranchFormat5):
837
self.control_weaves = get_weave(u'')
838
self.weave_store = get_weave(u'weaves')
839
self.revision_store = get_store(u'revision-store', compressed=False)
840
elif isinstance(self._branch_format, BzrBranchFormat6):
841
self.control_weaves = get_weave(u'')
842
self.weave_store = get_weave(u'weaves', prefixed=True)
843
self.revision_store = get_store(u'revision-store', compressed=False,
845
self.revision_store.register_suffix('sig')
846
self._transaction = None
849
def _initialize(base):
850
"""Create a bzr branch in the latest format."""
851
return BzrBranchFormat6().initialize(base)
2115
853
def __str__(self):
2116
return '%s(%r)' % (self.__class__.__name__, self.base)
854
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
2118
856
__repr__ = __str__
859
if self._lock_mode or self._lock:
860
# XXX: This should show something every time, and be suitable for
861
# headless operation and embedding
862
warn("branch %r was not explicitly unlocked" % self)
865
# TODO: It might be best to do this somewhere else,
866
# but it is nice for a Branch object to automatically
867
# cache it's information.
868
# Alternatively, we could have the Transport objects cache requests
869
# See the earlier discussion about how major objects (like Branch)
870
# should never expect their __del__ function to run.
871
if hasattr(self, 'cache_root') and self.cache_root is not None:
873
shutil.rmtree(self.cache_root)
876
self.cache_root = None
2120
878
def _get_base(self):
2121
"""Returns the directory containing the control directory."""
880
return self._transport.base
2124
883
base = property(_get_base, doc="The URL for the root of this branch.")
2126
def _get_config(self):
2127
return TransportConfig(self._transport, 'branch.conf')
2129
def is_locked(self):
2130
return self.control_files.is_locked()
2132
def lock_write(self, token=None):
2133
if not self.is_locked():
2134
self._note_lock('w')
2135
# All-in-one needs to always unlock/lock.
2136
repo_control = getattr(self.repository, 'control_files', None)
2137
if self.control_files == repo_control or not self.is_locked():
2138
self.repository._warn_if_deprecated(self)
2139
self.repository.lock_write()
2144
return self.control_files.lock_write(token=token)
2147
self.repository.unlock()
885
def _finish_transaction(self):
886
"""Exit the current transaction."""
887
if self._transaction is None:
888
raise errors.LockError('Branch %s is not in a transaction' %
890
transaction = self._transaction
891
self._transaction = None
894
def get_transaction(self):
895
"""See Branch.get_transaction."""
896
if self._transaction is None:
897
return transactions.PassThroughTransaction()
899
return self._transaction
901
def _set_transaction(self, new_transaction):
902
"""Set a new active transaction."""
903
if self._transaction is not None:
904
raise errors.LockError('Branch %s is in a transaction already.' %
906
self._transaction = new_transaction
908
def lock_write(self):
909
#mutter("lock write: %s (%s)", self, self._lock_count)
910
# TODO: Upgrade locking to support using a Transport,
911
# and potentially a remote locking protocol
913
if self._lock_mode != 'w':
914
raise LockError("can't upgrade to a write lock from %r" %
916
self._lock_count += 1
918
self._lock = self._transport.lock_write(
919
self._rel_controlfilename('branch-lock'))
920
self._lock_mode = 'w'
922
self._set_transaction(transactions.PassThroughTransaction())
2150
924
def lock_read(self):
2151
if not self.is_locked():
2152
self._note_lock('r')
2153
# All-in-one needs to always unlock/lock.
2154
repo_control = getattr(self.repository, 'control_files', None)
2155
if self.control_files == repo_control or not self.is_locked():
2156
self.repository._warn_if_deprecated(self)
2157
self.repository.lock_read()
925
#mutter("lock read: %s (%s)", self, self._lock_count)
927
assert self._lock_mode in ('r', 'w'), \
928
"invalid lock mode %r" % self._lock_mode
929
self._lock_count += 1
2162
self.control_files.lock_read()
2165
self.repository.unlock()
2168
@only_raises(errors.LockNotHeld, errors.LockBroken)
931
self._lock = self._transport.lock_read(
932
self._rel_controlfilename('branch-lock'))
933
self._lock_mode = 'r'
935
self._set_transaction(transactions.ReadOnlyTransaction())
936
# 5K may be excessive, but hey, its a knob.
937
self.get_transaction().set_cache_size(5000)
2169
939
def unlock(self):
940
#mutter("unlock: %s (%s)", self, self._lock_count)
941
if not self._lock_mode:
942
raise LockError('branch %r is not locked' % (self))
944
if self._lock_count > 1:
945
self._lock_count -= 1
947
self._finish_transaction()
950
self._lock_mode = self._lock_count = None
952
def abspath(self, name):
953
"""See Branch.abspath."""
954
return self._transport.abspath(name)
956
def _rel_controlfilename(self, file_or_path):
957
if not isinstance(file_or_path, basestring):
958
file_or_path = u'/'.join(file_or_path)
959
if file_or_path == '':
961
return bzrlib.transport.urlescape(bzrlib.BZRDIR + u'/' + file_or_path)
963
def controlfilename(self, file_or_path):
964
"""See Branch.controlfilename."""
965
return self._transport.abspath(self._rel_controlfilename(file_or_path))
967
def controlfile(self, file_or_path, mode='r'):
968
"""See Branch.controlfile."""
971
relpath = self._rel_controlfilename(file_or_path)
972
#TODO: codecs.open() buffers linewise, so it was overloaded with
973
# a much larger buffer, do we need to do the same for getreader/getwriter?
975
return self._transport.get(relpath)
977
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
979
# XXX: Do we really want errors='replace'? Perhaps it should be
980
# an error, or at least reported, if there's incorrectly-encoded
981
# data inside a file.
982
# <https://launchpad.net/products/bzr/+bug/3823>
983
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
985
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
987
raise BzrError("invalid controlfile mode %r" % mode)
989
def put_controlfile(self, path, f, encode=True):
990
"""See Branch.put_controlfile."""
991
self.put_controlfiles([(path, f)], encode=encode)
993
def put_controlfiles(self, files, encode=True):
994
"""See Branch.put_controlfiles."""
997
for path, f in files:
999
if isinstance(f, basestring):
1000
f = f.encode('utf-8', 'replace')
1002
f = codecs.getwriter('utf-8')(f, errors='replace')
1003
path = self._rel_controlfilename(path)
1004
ctrl_files.append((path, f))
1005
self._transport.put_multi(ctrl_files, mode=self._file_mode)
1007
def _find_modes(self, path=None):
1008
"""Determine the appropriate modes for files and directories."""
2171
self.control_files.unlock()
2173
# All-in-one needs to always unlock/lock.
2174
repo_control = getattr(self.repository, 'control_files', None)
2175
if (self.control_files == repo_control or
2176
not self.control_files.is_locked()):
2177
self.repository.unlock()
2178
if not self.control_files.is_locked():
2179
# we just released the lock
2180
self._clear_cached_state()
2182
def peek_lock_mode(self):
2183
if self.control_files._lock_count == 0:
1011
path = self._rel_controlfilename('')
1012
st = self._transport.stat(path)
1013
except errors.TransportNotPossible:
1014
self._dir_mode = 0755
1015
self._file_mode = 0644
2186
return self.control_files._lock_mode
2188
def get_physical_lock_status(self):
2189
return self.control_files.get_physical_lock_status()
1017
self._dir_mode = st.st_mode & 07777
1018
# Remove the sticky and execute bits for files
1019
self._file_mode = self._dir_mode & ~07111
1020
if not self._set_dir_mode:
1021
self._dir_mode = None
1022
if not self._set_file_mode:
1023
self._file_mode = None
1025
def _check_format(self, format):
1026
"""Identify the branch format if needed.
1028
The format is stored as a reference to the format object in
1029
self._branch_format for code that needs to check it later.
1031
The format parameter is either None or the branch format class
1032
used to open this branch.
1035
format = BzrBranchFormat.find_format(self._transport)
1036
self._branch_format = format
1037
mutter("got branch format %s", self._branch_format)
1040
def get_root_id(self):
1041
"""See Branch.get_root_id."""
1042
inv = self.get_inventory(self.last_revision())
1043
return inv.root.file_id
2191
1045
@needs_read_lock
2192
1046
def print_file(self, file, revision_id):
2193
1047
"""See Branch.print_file."""
2194
return self.repository.print_file(file, revision_id)
2196
def _write_revision_history(self, history):
2197
"""Factored out of set_revision_history.
2199
This performs the actual writing to disk.
2200
It is intended to be called by BzrBranch5.set_revision_history."""
2201
self._transport.put_bytes(
2202
'revision-history', '\n'.join(history),
2203
mode=self.bzrdir._get_file_mode())
1048
tree = self.revision_tree(revision_id)
1049
# use inventory as it was in that revision
1050
file_id = tree.inventory.path2id(file)
1053
revno = self.revision_id_to_revno(revision_id)
1054
except errors.NoSuchRevision:
1055
# TODO: This should not be BzrError,
1056
# but NoSuchFile doesn't fit either
1057
raise BzrError('%r is not present in revision %s'
1058
% (file, revision_id))
1060
raise BzrError('%r is not present in revision %s'
1062
tree.print_file(file_id)
1065
def append_revision(self, *revision_ids):
1066
"""See Branch.append_revision."""
1067
for revision_id in revision_ids:
1068
mutter("add {%s} to revision-history" % revision_id)
1069
rev_history = self.revision_history()
1070
rev_history.extend(revision_ids)
1071
self.set_revision_history(rev_history)
2205
1073
@needs_write_lock
2206
1074
def set_revision_history(self, rev_history):
2207
1075
"""See Branch.set_revision_history."""
2208
if 'evil' in debug.debug_flags:
2209
mutter_callsite(3, "set_revision_history scales with history.")
2210
check_not_reserved_id = _mod_revision.check_not_reserved_id
2211
for rev_id in rev_history:
2212
check_not_reserved_id(rev_id)
2213
if Branch.hooks['post_change_branch_tip']:
2214
# Don't calculate the last_revision_info() if there are no hooks
2216
old_revno, old_revid = self.last_revision_info()
2217
if len(rev_history) == 0:
2218
revid = _mod_revision.NULL_REVISION
1076
old_revision = self.last_revision()
1077
new_revision = rev_history[-1]
1078
self.put_controlfile('revision-history', '\n'.join(rev_history))
1080
self.working_tree().set_last_revision(new_revision, old_revision)
1081
except NoWorkingTree:
1082
mutter('Unable to set_last_revision without a working tree.')
1084
def has_revision(self, revision_id):
1085
"""See Branch.has_revision."""
1086
return (revision_id is None
1087
or self.revision_store.has_id(revision_id))
1090
def _get_revision_xml_file(self, revision_id):
1091
if not revision_id or not isinstance(revision_id, basestring):
1092
raise InvalidRevisionId(revision_id=revision_id, branch=self)
1094
return self.revision_store.get(revision_id)
1095
except (IndexError, KeyError):
1096
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1098
def get_revision_xml(self, revision_id):
1099
"""See Branch.get_revision_xml."""
1100
return self._get_revision_xml_file(revision_id).read()
1102
def get_revision(self, revision_id):
1103
"""See Branch.get_revision."""
1104
xml_file = self._get_revision_xml_file(revision_id)
1107
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
1108
except SyntaxError, e:
1109
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
1113
assert r.revision_id == revision_id
1116
def get_revision_sha1(self, revision_id):
1117
"""See Branch.get_revision_sha1."""
1118
# In the future, revision entries will be signed. At that
1119
# point, it is probably best *not* to include the signature
1120
# in the revision hash. Because that lets you re-sign
1121
# the revision, (add signatures/remove signatures) and still
1122
# have all hash pointers stay consistent.
1123
# But for now, just hash the contents.
1124
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
1126
def get_ancestry(self, revision_id):
1127
"""See Branch.get_ancestry."""
1128
if revision_id is None:
1130
w = self._get_inventory_weave()
1131
return [None] + map(w.idx_to_name,
1132
w.inclusions([w.lookup(revision_id)]))
1134
def _get_inventory_weave(self):
1135
return self.control_weaves.get_weave('inventory',
1136
self.get_transaction())
1138
def get_inventory(self, revision_id):
1139
"""See Branch.get_inventory."""
1140
xml = self.get_inventory_xml(revision_id)
1141
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
1143
def get_inventory_xml(self, revision_id):
1144
"""See Branch.get_inventory_xml."""
1146
assert isinstance(revision_id, basestring), type(revision_id)
1147
iw = self._get_inventory_weave()
1148
return iw.get_text(iw.lookup(revision_id))
1150
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
1152
def get_inventory_sha1(self, revision_id):
1153
"""See Branch.get_inventory_sha1."""
1154
return self.get_revision(revision_id).inventory_sha1
1156
def get_revision_inventory(self, revision_id):
1157
"""See Branch.get_revision_inventory."""
1158
# TODO: Unify this with get_inventory()
1159
# bzr 0.0.6 and later imposes the constraint that the inventory_id
1160
# must be the same as its revision, so this is trivial.
1161
if revision_id == None:
1162
# This does not make sense: if there is no revision,
1163
# then it is the current tree inventory surely ?!
1164
# and thus get_root_id() is something that looks at the last
1165
# commit on the branch, and the get_root_id is an inventory check.
1166
raise NotImplementedError
1167
# return Inventory(self.get_root_id())
2220
revid = rev_history[-1]
2221
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2222
self._write_revision_history(rev_history)
2223
self._clear_cached_state()
2224
self._cache_revision_history(rev_history)
2225
for hook in Branch.hooks['set_rh']:
2226
hook(self, rev_history)
2227
if Branch.hooks['post_change_branch_tip']:
2228
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2230
def _synchronize_history(self, destination, revision_id):
2231
"""Synchronize last revision and revision history between branches.
2233
This version is most efficient when the destination is also a
2234
BzrBranch5, but works for BzrBranch6 as long as the revision
2235
history is the true lefthand parent history, and all of the revisions
2236
are in the destination's repository. If not, set_revision_history
2239
:param destination: The branch to copy the history into
2240
:param revision_id: The revision-id to truncate history at. May
2241
be None to copy complete history.
2243
if not isinstance(destination._format, BzrBranchFormat5):
2244
super(BzrBranch, self)._synchronize_history(
2245
destination, revision_id)
1169
return self.get_inventory(revision_id)
1172
def revision_history(self):
1173
"""See Branch.revision_history."""
1174
transaction = self.get_transaction()
1175
history = transaction.map.find_revision_history()
1176
if history is not None:
1177
mutter("cache hit for revision-history in %s", self)
1178
return list(history)
1179
history = [l.rstrip('\r\n') for l in
1180
self.controlfile('revision-history', 'r').readlines()]
1181
transaction.map.add_revision_history(history)
1182
# this call is disabled because revision_history is
1183
# not really an object yet, and the transaction is for objects.
1184
# transaction.register_clean(history, precious=True)
1185
return list(history)
1187
def update_revisions(self, other, stop_revision=None):
1188
"""See Branch.update_revisions."""
1189
from bzrlib.fetch import greedy_fetch
1190
if stop_revision is None:
1191
stop_revision = other.last_revision()
1192
### Should this be checking is_ancestor instead of revision_history?
1193
if (stop_revision is not None and
1194
stop_revision in self.revision_history()):
2247
if revision_id == _mod_revision.NULL_REVISION:
2250
new_history = self.revision_history()
2251
if revision_id is not None and new_history != []:
1196
greedy_fetch(to_branch=self, from_branch=other,
1197
revision=stop_revision)
1198
pullable_revs = self.pullable_revisions(other, stop_revision)
1199
if len(pullable_revs) > 0:
1200
self.append_revision(*pullable_revs)
1202
def pullable_revisions(self, other, stop_revision):
1203
"""See Branch.pullable_revisions."""
1204
other_revno = other.revision_id_to_revno(stop_revision)
1206
return self.missing_revisions(other, other_revno)
1207
except DivergedBranches, e:
2253
new_history = new_history[:new_history.index(revision_id) + 1]
2255
rev = self.repository.get_revision(revision_id)
2256
new_history = rev.get_history(self.repository)[1:]
2257
destination.set_revision_history(new_history)
2260
def set_last_revision_info(self, revno, revision_id):
2261
"""Set the last revision of this branch.
2263
The caller is responsible for checking that the revno is correct
2264
for this revision id.
2266
It may be possible to set the branch last revision to an id not
2267
present in the repository. However, branches can also be
2268
configured to check constraints on history, in which case this may not
2271
revision_id = _mod_revision.ensure_null(revision_id)
2272
# this old format stores the full history, but this api doesn't
2273
# provide it, so we must generate, and might as well check it's
2275
history = self._lefthand_history(revision_id)
2276
if len(history) != revno:
2277
raise AssertionError('%d != %d' % (len(history), revno))
2278
self.set_revision_history(history)
2280
def _gen_revision_history(self):
2281
history = self._transport.get_bytes('revision-history').split('\n')
2282
if history[-1:] == ['']:
2283
# There shouldn't be a trailing newline, but just in case.
2288
def generate_revision_history(self, revision_id, last_rev=None,
2290
"""Create a new revision history that will finish with revision_id.
2292
:param revision_id: the new tip to use.
2293
:param last_rev: The previous last_revision. If not None, then this
2294
must be a ancestory of revision_id, or DivergedBranches is raised.
2295
:param other_branch: The other branch that DivergedBranches should
2296
raise with respect to.
2298
self.set_revision_history(self._lefthand_history(revision_id,
2299
last_rev, other_branch))
1209
pullable_revs = get_intervening_revisions(self.last_revision(),
1210
stop_revision, self)
1211
assert self.last_revision() not in pullable_revs
1212
return pullable_revs
1213
except bzrlib.errors.NotAncestor:
1214
if is_ancestor(self.last_revision(), stop_revision, self):
1219
def revision_tree(self, revision_id):
1220
"""See Branch.revision_tree."""
1221
# TODO: refactor this to use an existing revision object
1222
# so we don't need to read it in twice.
1223
if revision_id == None or revision_id == NULL_REVISION:
1226
inv = self.get_revision_inventory(revision_id)
1227
return RevisionTree(self, inv, revision_id)
2301
1229
def basis_tree(self):
2302
1230
"""See Branch.basis_tree."""
2303
return self.repository.revision_tree(self.last_revision())
2305
def _get_parent_location(self):
1232
revision_id = self.revision_history()[-1]
1233
xml = self.working_tree().read_basis_inventory(revision_id)
1234
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
1235
return RevisionTree(self, inv, revision_id)
1236
except (IndexError, NoSuchFile, NoWorkingTree), e:
1237
return self.revision_tree(self.last_revision())
1239
def working_tree(self):
1240
"""See Branch.working_tree."""
1241
from bzrlib.workingtree import WorkingTree
1242
if self._transport.base.find('://') != -1:
1243
raise NoWorkingTree(self.base)
1244
return WorkingTree(self.base, branch=self)
1247
def pull(self, source, overwrite=False):
1248
"""See Branch.pull."""
1251
old_count = len(self.revision_history())
1253
self.update_revisions(source)
1254
except DivergedBranches:
1258
self.set_revision_history(source.revision_history())
1259
new_count = len(self.revision_history())
1260
return new_count - old_count
1264
def get_parent(self):
1265
"""See Branch.get_parent."""
2306
1267
_locs = ['parent', 'pull', 'x-pull']
2307
1268
for l in _locs:
2309
return self._transport.get_bytes(l).strip('\n')
2310
except errors.NoSuchFile:
1270
return self.controlfile(l, 'r').read().strip('\n')
2314
def _basic_push(self, target, overwrite, stop_revision):
2315
"""Basic implementation of push without bound branches or hooks.
2317
Must be called with source read locked and target write locked.
2319
result = BranchPushResult()
2320
result.source_branch = self
2321
result.target_branch = target
2322
result.old_revno, result.old_revid = target.last_revision_info()
2323
self.update_references(target)
2324
if result.old_revid != self.last_revision():
2325
# We assume that during 'push' this repository is closer than
2327
graph = self.repository.get_graph(target.repository)
2328
target.update_revisions(self, stop_revision,
2329
overwrite=overwrite, graph=graph)
2330
if self._push_should_merge_tags():
2331
result.tag_conflicts = self.tags.merge_to(target.tags,
2333
result.new_revno, result.new_revid = target.last_revision_info()
2336
def get_stacked_on_url(self):
2337
raise errors.UnstackableBranchFormat(self._format, self.base)
1275
def get_push_location(self):
1276
"""See Branch.get_push_location."""
1277
config = bzrlib.config.BranchConfig(self)
1278
push_loc = config.get_user_option('push_location')
2339
1281
def set_push_location(self, location):
2340
1282
"""See Branch.set_push_location."""
2341
self.get_config().set_user_option(
2342
'push_location', location,
2343
store=_mod_config.STORE_LOCATION_NORECURSE)
2345
def _set_parent_location(self, url):
2347
self._transport.delete('parent')
2349
self._transport.put_bytes('parent', url + '\n',
2350
mode=self.bzrdir._get_file_mode())
2353
class BzrBranch5(BzrBranch):
2354
"""A format 5 branch. This supports new features over plain branches.
2356
It has support for a master_branch which is the data for bound branches.
2359
def get_bound_location(self):
2361
return self._transport.get_bytes('bound')[:-1]
2362
except errors.NoSuchFile:
2366
def get_master_branch(self, possible_transports=None):
2367
"""Return the branch we are bound to.
2369
:return: Either a Branch, or None
2371
This could memoise the branch, but if thats done
2372
it must be revalidated on each new lock.
2373
So for now we just don't memoise it.
2374
# RBC 20060304 review this decision.
2376
bound_loc = self.get_bound_location()
2380
return Branch.open(bound_loc,
2381
possible_transports=possible_transports)
2382
except (errors.NotBranchError, errors.ConnectionError), e:
2383
raise errors.BoundBranchConnectionFailure(
2387
def set_bound_location(self, location):
2388
"""Set the target where this branch is bound to.
2390
:param location: URL to the target branch
2393
self._transport.put_bytes('bound', location+'\n',
2394
mode=self.bzrdir._get_file_mode())
2397
self._transport.delete('bound')
2398
except errors.NoSuchFile:
1283
config = bzrlib.config.LocationConfig(self.base)
1284
config.set_user_option('push_location', location)
1287
def set_parent(self, url):
1288
"""See Branch.set_parent."""
1289
# TODO: Maybe delete old location files?
1290
from bzrlib.atomicfile import AtomicFile
1291
f = AtomicFile(self.controlfilename('parent'))
1298
def tree_config(self):
1299
return TreeConfig(self)
1301
def sign_revision(self, revision_id, gpg_strategy):
1302
"""See Branch.sign_revision."""
1303
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1304
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1307
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1308
"""See Branch.store_revision_signature."""
1309
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1313
Branch.set_default_initializer(BzrBranch._initialize)
1316
class BranchTestProviderAdapter(object):
1317
"""A tool to generate a suite testing multiple branch formats at once.
1319
This is done by copying the test once for each transport and injecting
1320
the transport_server, transport_readonly_server, and branch_format
1321
classes into each copy. Each copy is also given a new id() to make it
1325
def __init__(self, transport_server, transport_readonly_server, formats):
1326
self._transport_server = transport_server
1327
self._transport_readonly_server = transport_readonly_server
1328
self._formats = formats
1330
def adapt(self, test):
1331
result = TestSuite()
1332
for format in self._formats:
1333
new_test = deepcopy(test)
1334
new_test.transport_server = self._transport_server
1335
new_test.transport_readonly_server = self._transport_readonly_server
1336
new_test.branch_format = format
1337
def make_new_test_id():
1338
new_id = "%s(%s)" % (new_test.id(), format.__class__.__name__)
1339
return lambda: new_id
1340
new_test.id = make_new_test_id()
1341
result.addTest(new_test)
1345
class ScratchBranch(BzrBranch):
1346
"""Special test class: a branch that cleans up after itself.
1348
>>> b = ScratchBranch()
1352
>>> b._transport.__del__()
1357
def __init__(self, files=[], dirs=[], transport=None):
1358
"""Make a test branch.
1360
This creates a temporary directory and runs init-tree in it.
1362
If any files are listed, they are created in the working copy.
1364
if transport is None:
1365
transport = bzrlib.transport.local.ScratchTransport()
1366
Branch.initialize(transport.base)
1367
super(ScratchBranch, self).__init__(transport)
1369
super(ScratchBranch, self).__init__(transport)
1372
self._transport.mkdir(d)
1375
self._transport.put(f, 'content of %s' % f)
1380
>>> orig = ScratchBranch(files=["file1", "file2"])
1381
>>> clone = orig.clone()
1382
>>> if os.name != 'nt':
1383
... os.path.samefile(orig.base, clone.base)
1385
... orig.base == clone.base
1388
>>> os.path.isfile(pathjoin(clone.base, "file1"))
1391
from shutil import copytree
1392
from bzrlib.osutils import mkdtemp
1395
copytree(self.base, base, symlinks=True)
1396
return ScratchBranch(
1397
transport=bzrlib.transport.local.ScratchTransport(base))
1400
######################################################################
1404
def is_control_file(filename):
1405
## FIXME: better check
1406
filename = normpath(filename)
1407
while filename != '':
1408
head, tail = os.path.split(filename)
1409
## mutter('check %r for control file' % ((head, tail), ))
1410
if tail == bzrlib.BZRDIR:
2403
def bind(self, other):
2404
"""Bind this branch to the branch other.
2406
This does not push or pull data between the branches, though it does
2407
check for divergence to raise an error when the branches are not
2408
either the same, or one a prefix of the other. That behaviour may not
2409
be useful, so that check may be removed in future.
2411
:param other: The branch to bind to
2414
# TODO: jam 20051230 Consider checking if the target is bound
2415
# It is debatable whether you should be able to bind to
2416
# a branch which is itself bound.
2417
# Committing is obviously forbidden,
2418
# but binding itself may not be.
2419
# Since we *have* to check at commit time, we don't
2420
# *need* to check here
2422
# we want to raise diverged if:
2423
# last_rev is not in the other_last_rev history, AND
2424
# other_last_rev is not in our history, and do it without pulling
2426
self.set_bound_location(other.base)
2430
"""If bound, unbind"""
2431
return self.set_bound_location(None)
2434
def update(self, possible_transports=None):
2435
"""Synchronise this branch with the master branch if any.
2437
:return: None or the last_revision that was pivoted out during the
2440
master = self.get_master_branch(possible_transports)
2441
if master is not None:
2442
old_tip = _mod_revision.ensure_null(self.last_revision())
2443
self.pull(master, overwrite=True)
2444
if self.repository.get_graph().is_ancestor(old_tip,
2445
_mod_revision.ensure_null(self.last_revision())):
2451
class BzrBranch8(BzrBranch5):
2452
"""A branch that stores tree-reference locations."""
2454
def _open_hook(self):
2455
if self._ignore_fallbacks:
2458
url = self.get_stacked_on_url()
2459
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2460
errors.UnstackableBranchFormat):
2463
for hook in Branch.hooks['transform_fallback_location']:
2464
url = hook(self, url)
2466
hook_name = Branch.hooks.get_hook_name(hook)
2467
raise AssertionError(
2468
"'transform_fallback_location' hook %s returned "
2469
"None, not a URL." % hook_name)
2470
self._activate_fallback_location(url)
2472
def __init__(self, *args, **kwargs):
2473
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2474
super(BzrBranch8, self).__init__(*args, **kwargs)
2475
self._last_revision_info_cache = None
2476
self._reference_info = None
2478
def _clear_cached_state(self):
2479
super(BzrBranch8, self)._clear_cached_state()
2480
self._last_revision_info_cache = None
2481
self._reference_info = None
2483
def _last_revision_info(self):
2484
revision_string = self._transport.get_bytes('last-revision')
2485
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2486
revision_id = cache_utf8.get_cached_utf8(revision_id)
2488
return revno, revision_id
2490
def _write_last_revision_info(self, revno, revision_id):
2491
"""Simply write out the revision id, with no checks.
2493
Use set_last_revision_info to perform this safely.
2495
Does not update the revision_history cache.
2496
Intended to be called by set_last_revision_info and
2497
_write_revision_history.
2499
revision_id = _mod_revision.ensure_null(revision_id)
2500
out_string = '%d %s\n' % (revno, revision_id)
2501
self._transport.put_bytes('last-revision', out_string,
2502
mode=self.bzrdir._get_file_mode())
2505
def set_last_revision_info(self, revno, revision_id):
2506
revision_id = _mod_revision.ensure_null(revision_id)
2507
old_revno, old_revid = self.last_revision_info()
2508
if self._get_append_revisions_only():
2509
self._check_history_violation(revision_id)
2510
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2511
self._write_last_revision_info(revno, revision_id)
2512
self._clear_cached_state()
2513
self._last_revision_info_cache = revno, revision_id
2514
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2516
def _synchronize_history(self, destination, revision_id):
2517
"""Synchronize last revision and revision history between branches.
2519
:see: Branch._synchronize_history
2521
# XXX: The base Branch has a fast implementation of this method based
2522
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2523
# that uses set_revision_history. This class inherits from BzrBranch5,
2524
# but wants the fast implementation, so it calls
2525
# Branch._synchronize_history directly.
2526
Branch._synchronize_history(self, destination, revision_id)
2528
def _check_history_violation(self, revision_id):
2529
last_revision = _mod_revision.ensure_null(self.last_revision())
2530
if _mod_revision.is_null(last_revision):
2532
if last_revision not in self._lefthand_history(revision_id):
2533
raise errors.AppendRevisionsOnlyViolation(self.base)
2535
def _gen_revision_history(self):
2536
"""Generate the revision history from last revision
2538
last_revno, last_revision = self.last_revision_info()
2539
self._extend_partial_history(stop_index=last_revno-1)
2540
return list(reversed(self._partial_revision_history_cache))
2542
def _write_revision_history(self, history):
2543
"""Factored out of set_revision_history.
2545
This performs the actual writing to disk, with format-specific checks.
2546
It is intended to be called by BzrBranch5.set_revision_history.
2548
if len(history) == 0:
2549
last_revision = 'null:'
2551
if history != self._lefthand_history(history[-1]):
2552
raise errors.NotLefthandHistory(history)
2553
last_revision = history[-1]
2554
if self._get_append_revisions_only():
2555
self._check_history_violation(last_revision)
2556
self._write_last_revision_info(len(history), last_revision)
2559
def _set_parent_location(self, url):
2560
"""Set the parent branch"""
2561
self._set_config_location('parent_location', url, make_relative=True)
2564
def _get_parent_location(self):
2565
"""Set the parent branch"""
2566
return self._get_config_location('parent_location')
2569
def _set_all_reference_info(self, info_dict):
2570
"""Replace all reference info stored in a branch.
2572
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2575
writer = rio.RioWriter(s)
2576
for key, (tree_path, branch_location) in info_dict.iteritems():
2577
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2578
branch_location=branch_location)
2579
writer.write_stanza(stanza)
2580
self._transport.put_bytes('references', s.getvalue())
2581
self._reference_info = info_dict
2584
def _get_all_reference_info(self):
2585
"""Return all the reference info stored in a branch.
2587
:return: A dict of {file_id: (tree_path, branch_location)}
2589
if self._reference_info is not None:
2590
return self._reference_info
2591
rio_file = self._transport.get('references')
2593
stanzas = rio.read_stanzas(rio_file)
2594
info_dict = dict((s['file_id'], (s['tree_path'],
2595
s['branch_location'])) for s in stanzas)
2598
self._reference_info = info_dict
2601
def set_reference_info(self, file_id, tree_path, branch_location):
2602
"""Set the branch location to use for a tree reference.
2604
:param file_id: The file-id of the tree reference.
2605
:param tree_path: The path of the tree reference in the tree.
2606
:param branch_location: The location of the branch to retrieve tree
2609
info_dict = self._get_all_reference_info()
2610
info_dict[file_id] = (tree_path, branch_location)
2611
if None in (tree_path, branch_location):
2612
if tree_path is not None:
2613
raise ValueError('tree_path must be None when branch_location'
2615
if branch_location is not None:
2616
raise ValueError('branch_location must be None when tree_path'
2618
del info_dict[file_id]
2619
self._set_all_reference_info(info_dict)
2621
def get_reference_info(self, file_id):
2622
"""Get the tree_path and branch_location for a tree reference.
2624
:return: a tuple of (tree_path, branch_location)
2626
return self._get_all_reference_info().get(file_id, (None, None))
2628
def reference_parent(self, file_id, path, possible_transports=None):
2629
"""Return the parent branch for a tree-reference file_id.
2631
:param file_id: The file_id of the tree reference
2632
:param path: The path of the file_id in the tree
2633
:return: A branch associated with the file_id
2635
branch_location = self.get_reference_info(file_id)[1]
2636
if branch_location is None:
2637
return Branch.reference_parent(self, file_id, path,
2638
possible_transports)
2639
branch_location = urlutils.join(self.base, branch_location)
2640
return Branch.open(branch_location,
2641
possible_transports=possible_transports)
2643
def set_push_location(self, location):
2644
"""See Branch.set_push_location."""
2645
self._set_config_location('push_location', location)
2647
def set_bound_location(self, location):
2648
"""See Branch.set_push_location."""
2650
config = self.get_config()
2651
if location is None:
2652
if config.get_user_option('bound') != 'True':
2655
config.set_user_option('bound', 'False', warn_masked=True)
2658
self._set_config_location('bound_location', location,
2660
config.set_user_option('bound', 'True', warn_masked=True)
2663
def _get_bound_location(self, bound):
2664
"""Return the bound location in the config file.
2666
Return None if the bound parameter does not match"""
2667
config = self.get_config()
2668
config_bound = (config.get_user_option('bound') == 'True')
2669
if config_bound != bound:
2671
return self._get_config_location('bound_location', config=config)
2673
def get_bound_location(self):
2674
"""See Branch.set_push_location."""
2675
return self._get_bound_location(True)
2677
def get_old_bound_location(self):
2678
"""See Branch.get_old_bound_location"""
2679
return self._get_bound_location(False)
2681
def get_stacked_on_url(self):
2682
# you can always ask for the URL; but you might not be able to use it
2683
# if the repo can't support stacking.
2684
## self._check_stackable_repo()
2685
stacked_url = self._get_config_location('stacked_on_location')
2686
if stacked_url is None:
2687
raise errors.NotStacked(self)
2690
def _get_append_revisions_only(self):
2691
value = self.get_config().get_user_option('append_revisions_only')
2692
return value == 'True'
2695
def generate_revision_history(self, revision_id, last_rev=None,
2697
"""See BzrBranch5.generate_revision_history"""
2698
history = self._lefthand_history(revision_id, last_rev, other_branch)
2699
revno = len(history)
2700
self.set_last_revision_info(revno, revision_id)
2703
def get_rev_id(self, revno, history=None):
2704
"""Find the revision id of the specified revno."""
2706
return _mod_revision.NULL_REVISION
2708
last_revno, last_revision_id = self.last_revision_info()
2709
if revno <= 0 or revno > last_revno:
2710
raise errors.NoSuchRevision(self, revno)
2712
if history is not None:
2713
return history[revno - 1]
2715
index = last_revno - revno
2716
if len(self._partial_revision_history_cache) <= index:
2717
self._extend_partial_history(stop_index=index)
2718
if len(self._partial_revision_history_cache) > index:
2719
return self._partial_revision_history_cache[index]
2721
raise errors.NoSuchRevision(self, revno)
2724
def revision_id_to_revno(self, revision_id):
2725
"""Given a revision id, return its revno"""
2726
if _mod_revision.is_null(revision_id):
2729
index = self._partial_revision_history_cache.index(revision_id)
2731
self._extend_partial_history(stop_revision=revision_id)
2732
index = len(self._partial_revision_history_cache) - 1
2733
if self._partial_revision_history_cache[index] != revision_id:
2734
raise errors.NoSuchRevision(self, revision_id)
2735
return self.revno() - index
2738
class BzrBranch7(BzrBranch8):
2739
"""A branch with support for a fallback repository."""
2741
def set_reference_info(self, file_id, tree_path, branch_location):
2742
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2744
def get_reference_info(self, file_id):
2745
Branch.get_reference_info(self, file_id)
2747
def reference_parent(self, file_id, path, possible_transports=None):
2748
return Branch.reference_parent(self, file_id, path,
2749
possible_transports)
2752
class BzrBranch6(BzrBranch7):
2753
"""See BzrBranchFormat6 for the capabilities of this branch.
2755
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2759
def get_stacked_on_url(self):
2760
raise errors.UnstackableBranchFormat(self._format, self.base)
2763
######################################################################
2764
# results of operations
2767
class _Result(object):
2769
def _show_tag_conficts(self, to_file):
2770
if not getattr(self, 'tag_conflicts', None):
2772
to_file.write('Conflicting tags:\n')
2773
for name, value1, value2 in self.tag_conflicts:
2774
to_file.write(' %s\n' % (name, ))
2777
class PullResult(_Result):
2778
"""Result of a Branch.pull operation.
2780
:ivar old_revno: Revision number before pull.
2781
:ivar new_revno: Revision number after pull.
2782
:ivar old_revid: Tip revision id before pull.
2783
:ivar new_revid: Tip revision id after pull.
2784
:ivar source_branch: Source (local) branch object. (read locked)
2785
:ivar master_branch: Master branch of the target, or the target if no
2787
:ivar local_branch: target branch if there is a Master, else None
2788
:ivar target_branch: Target/destination branch object. (write locked)
2789
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2793
# DEPRECATED: pull used to return the change in revno
2794
return self.new_revno - self.old_revno
2796
def report(self, to_file):
2798
if self.old_revid == self.new_revid:
2799
to_file.write('No revisions to pull.\n')
2801
to_file.write('Now on revision %d.\n' % self.new_revno)
2802
self._show_tag_conficts(to_file)
2805
class BranchPushResult(_Result):
2806
"""Result of a Branch.push operation.
2808
:ivar old_revno: Revision number (eg 10) of the target before push.
2809
:ivar new_revno: Revision number (eg 12) of the target after push.
2810
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2812
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2814
:ivar source_branch: Source branch object that the push was from. This is
2815
read locked, and generally is a local (and thus low latency) branch.
2816
:ivar master_branch: If target is a bound branch, the master branch of
2817
target, or target itself. Always write locked.
2818
:ivar target_branch: The direct Branch where data is being sent (write
2820
:ivar local_branch: If the target is a bound branch this will be the
2821
target, otherwise it will be None.
2825
# DEPRECATED: push used to return the change in revno
2826
return self.new_revno - self.old_revno
2828
def report(self, to_file):
2829
"""Write a human-readable description of the result."""
2830
if self.old_revid == self.new_revid:
2831
note('No new revisions to push.')
2833
note('Pushed up to revision %d.' % self.new_revno)
2834
self._show_tag_conficts(to_file)
2837
class BranchCheckResult(object):
2838
"""Results of checking branch consistency.
2843
def __init__(self, branch):
2844
self.branch = branch
2847
def report_results(self, verbose):
2848
"""Report the check results via trace.note.
2850
:param verbose: Requests more detailed display of what was checked,
2853
note('checked branch %s format %s', self.branch.base,
2854
self.branch._format)
2855
for error in self.errors:
2856
note('found error:%s', error)
2859
class Converter5to6(object):
2860
"""Perform an in-place upgrade of format 5 to format 6"""
2862
def convert(self, branch):
2863
# Data for 5 and 6 can peacefully coexist.
2864
format = BzrBranchFormat6()
2865
new_branch = format.open(branch.bzrdir, _found=True)
2867
# Copy source data into target
2868
new_branch._write_last_revision_info(*branch.last_revision_info())
2869
new_branch.set_parent(branch.get_parent())
2870
new_branch.set_bound_location(branch.get_bound_location())
2871
new_branch.set_push_location(branch.get_push_location())
2873
# New branch has no tags by default
2874
new_branch.tags._set_tag_dict({})
2876
# Copying done; now update target format
2877
new_branch._transport.put_bytes('format',
2878
format.get_format_string(),
2879
mode=new_branch.bzrdir._get_file_mode())
2881
# Clean up old files
2882
new_branch._transport.delete('revision-history')
2884
branch.set_parent(None)
2885
except errors.NoSuchFile:
2887
branch.set_bound_location(None)
2890
class Converter6to7(object):
2891
"""Perform an in-place upgrade of format 6 to format 7"""
2893
def convert(self, branch):
2894
format = BzrBranchFormat7()
2895
branch._set_config_location('stacked_on_location', '')
2896
# update target format
2897
branch._transport.put_bytes('format', format.get_format_string())
2900
class Converter7to8(object):
2901
"""Perform an in-place upgrade of format 6 to format 7"""
2903
def convert(self, branch):
2904
format = BzrBranchFormat8()
2905
branch._transport.put_bytes('references', '')
2906
# update target format
2907
branch._transport.put_bytes('format', format.get_format_string())
2910
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2911
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2914
_run_with_write_locked_target will attempt to release the lock it acquires.
2916
If an exception is raised by callable, then that exception *will* be
2917
propagated, even if the unlock attempt raises its own error. Thus
2918
_run_with_write_locked_target should be preferred to simply doing::
2922
return callable(*args, **kwargs)
2927
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2928
# should share code?
2931
result = callable(*args, **kwargs)
2933
exc_info = sys.exc_info()
2937
raise exc_info[0], exc_info[1], exc_info[2]
2943
class InterBranch(InterObject):
2944
"""This class represents operations taking place between two branches.
2946
Its instances have methods like pull() and push() and contain
2947
references to the source and target repositories these operations
2948
can be carried out on.
2952
"""The available optimised InterBranch types."""
2955
def _get_branch_formats_to_test():
2956
"""Return a tuple with the Branch formats to use when testing."""
2957
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
2959
def pull(self, overwrite=False, stop_revision=None,
2960
possible_transports=None, local=False):
2961
"""Mirror source into target branch.
2963
The target branch is considered to be 'local', having low latency.
2965
:returns: PullResult instance
2967
raise NotImplementedError(self.pull)
2969
def update_revisions(self, stop_revision=None, overwrite=False,
2971
"""Pull in new perfect-fit revisions.
2973
:param stop_revision: Updated until the given revision
2974
:param overwrite: Always set the branch pointer, rather than checking
2975
to see if it is a proper descendant.
2976
:param graph: A Graph object that can be used to query history
2977
information. This can be None.
2980
raise NotImplementedError(self.update_revisions)
2982
def push(self, overwrite=False, stop_revision=None,
2983
_override_hook_source_branch=None):
2984
"""Mirror the source branch into the target branch.
2986
The source branch is considered to be 'local', having low latency.
2988
raise NotImplementedError(self.push)
2991
class GenericInterBranch(InterBranch):
2992
"""InterBranch implementation that uses public Branch functions.
2996
def _get_branch_formats_to_test():
2997
return BranchFormat._default_format, BranchFormat._default_format
2999
def update_revisions(self, stop_revision=None, overwrite=False,
3001
"""See InterBranch.update_revisions()."""
3002
self.source.lock_read()
3004
other_revno, other_last_revision = self.source.last_revision_info()
3005
stop_revno = None # unknown
3006
if stop_revision is None:
3007
stop_revision = other_last_revision
3008
if _mod_revision.is_null(stop_revision):
3009
# if there are no commits, we're done.
3011
stop_revno = other_revno
3013
# what's the current last revision, before we fetch [and change it
3015
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3016
# we fetch here so that we don't process data twice in the common
3017
# case of having something to pull, and so that the check for
3018
# already merged can operate on the just fetched graph, which will
3019
# be cached in memory.
3020
self.target.fetch(self.source, stop_revision)
3021
# Check to see if one is an ancestor of the other
3024
graph = self.target.repository.get_graph()
3025
if self.target._check_if_descendant_or_diverged(
3026
stop_revision, last_rev, graph, self.source):
3027
# stop_revision is a descendant of last_rev, but we aren't
3028
# overwriting, so we're done.
3030
if stop_revno is None:
3032
graph = self.target.repository.get_graph()
3033
this_revno, this_last_revision = \
3034
self.target.last_revision_info()
3035
stop_revno = graph.find_distance_to_null(stop_revision,
3036
[(other_last_revision, other_revno),
3037
(this_last_revision, this_revno)])
3038
self.target.set_last_revision_info(stop_revno, stop_revision)
3040
self.source.unlock()
3042
def pull(self, overwrite=False, stop_revision=None,
3043
possible_transports=None, _hook_master=None, run_hooks=True,
3044
_override_hook_target=None, local=False):
3047
:param _hook_master: Private parameter - set the branch to
3048
be supplied as the master to pull hooks.
3049
:param run_hooks: Private parameter - if false, this branch
3050
is being called because it's the master of the primary branch,
3051
so it should not run its hooks.
3052
:param _override_hook_target: Private parameter - set the branch to be
3053
supplied as the target_branch to pull hooks.
3054
:param local: Only update the local branch, and not the bound branch.
3056
# This type of branch can't be bound.
3058
raise errors.LocalRequiresBoundBranch()
3059
result = PullResult()
3060
result.source_branch = self.source
3061
if _override_hook_target is None:
3062
result.target_branch = self.target
3064
result.target_branch = _override_hook_target
3065
self.source.lock_read()
3067
# We assume that during 'pull' the target repository is closer than
3069
self.source.update_references(self.target)
3070
graph = self.target.repository.get_graph(self.source.repository)
3071
# TODO: Branch formats should have a flag that indicates
3072
# that revno's are expensive, and pull() should honor that flag.
3074
result.old_revno, result.old_revid = \
3075
self.target.last_revision_info()
3076
self.target.update_revisions(self.source, stop_revision,
3077
overwrite=overwrite, graph=graph)
3078
# TODO: The old revid should be specified when merging tags,
3079
# so a tags implementation that versions tags can only
3080
# pull in the most recent changes. -- JRV20090506
3081
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3083
result.new_revno, result.new_revid = self.target.last_revision_info()
3085
result.master_branch = _hook_master
3086
result.local_branch = result.target_branch
3088
result.master_branch = result.target_branch
3089
result.local_branch = None
3091
for hook in Branch.hooks['post_pull']:
3094
self.source.unlock()
3097
def push(self, overwrite=False, stop_revision=None,
3098
_override_hook_source_branch=None):
3099
"""See InterBranch.push.
3101
This is the basic concrete implementation of push()
3103
:param _override_hook_source_branch: If specified, run
3104
the hooks passing this Branch as the source, rather than self.
3105
This is for use of RemoteBranch, where push is delegated to the
3106
underlying vfs-based Branch.
3108
# TODO: Public option to disable running hooks - should be trivial but
3110
self.source.lock_read()
3112
return _run_with_write_locked_target(
3113
self.target, self._push_with_bound_branches, overwrite,
3115
_override_hook_source_branch=_override_hook_source_branch)
3117
self.source.unlock()
3119
def _push_with_bound_branches(self, overwrite, stop_revision,
3120
_override_hook_source_branch=None):
3121
"""Push from source into target, and into target's master if any.
3124
if _override_hook_source_branch:
3125
result.source_branch = _override_hook_source_branch
3126
for hook in Branch.hooks['post_push']:
3129
bound_location = self.target.get_bound_location()
3130
if bound_location and self.target.base != bound_location:
3131
# there is a master branch.
3133
# XXX: Why the second check? Is it even supported for a branch to
3134
# be bound to itself? -- mbp 20070507
3135
master_branch = self.target.get_master_branch()
3136
master_branch.lock_write()
3138
# push into the master from the source branch.
3139
self.source._basic_push(master_branch, overwrite, stop_revision)
3140
# and push into the target branch from the source. Note that we
3141
# push from the source branch again, because its considered the
3142
# highest bandwidth repository.
3143
result = self.source._basic_push(self.target, overwrite,
3145
result.master_branch = master_branch
3146
result.local_branch = self.target
3150
master_branch.unlock()
3153
result = self.source._basic_push(self.target, overwrite,
3155
# TODO: Why set master_branch and local_branch if there's no
3156
# binding? Maybe cleaner to just leave them unset? -- mbp
3158
result.master_branch = self.target
3159
result.local_branch = None
3164
def is_compatible(self, source, target):
3165
# GenericBranch uses the public API, so always compatible
3169
class InterToBranch5(GenericInterBranch):
3172
def _get_branch_formats_to_test():
3173
return BranchFormat._default_format, BzrBranchFormat5()
3175
def pull(self, overwrite=False, stop_revision=None,
3176
possible_transports=None, run_hooks=True,
3177
_override_hook_target=None, local=False):
3178
"""Pull from source into self, updating my master if any.
3180
:param run_hooks: Private parameter - if false, this branch
3181
is being called because it's the master of the primary branch,
3182
so it should not run its hooks.
3184
bound_location = self.target.get_bound_location()
3185
if local and not bound_location:
3186
raise errors.LocalRequiresBoundBranch()
3187
master_branch = None
3188
if not local and bound_location and self.source.base != bound_location:
3189
# not pulling from master, so we need to update master.
3190
master_branch = self.target.get_master_branch(possible_transports)
3191
master_branch.lock_write()
3194
# pull from source into master.
3195
master_branch.pull(self.source, overwrite, stop_revision,
3197
return super(InterToBranch5, self).pull(overwrite,
3198
stop_revision, _hook_master=master_branch,
3199
run_hooks=run_hooks,
3200
_override_hook_target=_override_hook_target)
3203
master_branch.unlock()
3206
InterBranch.register_optimiser(GenericInterBranch)
3207
InterBranch.register_optimiser(InterToBranch5)
1412
if filename == head:
added
removed
bzrlib/branch.py
