157
79
"""Branch holding a history of revisions.
160
Base directory of the branch.
166
If _lock_mode is true, a positive count of the number of times the
170
Lock object from bzrlib.lock.
82
Base directory/url of the branch.
84
hooks: An instance of BranchHooks.
86
# this is really an instance variable - FIXME move it there
176
_inventory_weave = None
178
# Map some sort of prefix into a namespace
179
# stuff like "revno:10", "revid:", etc.
180
# This should match a prefix with a function which accepts
181
REVISION_NAMESPACES = {}
183
def __init__(self, base, init=False, find_root=True):
184
"""Create new branch object at a particular location.
186
base -- Base directory for the branch.
188
init -- If True, create new control files in a previously
189
unversioned directory. If False, the branch must already
192
find_root -- If true and init is false, find the root of the
193
existing branch containing base.
195
In the test suite, creation of new trees is tested using the
196
`ScratchBranch` class.
199
self.base = os.path.realpath(base)
202
self.base = find_branch_root(base)
204
self.base = os.path.realpath(base)
205
if not isdir(self.controlfilename('.')):
206
from errors import NotBranchError
207
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
208
['use "bzr init" to initialize a new working tree',
209
'current bzr can only operate from top-of-tree'])
212
self.weave_store = WeaveStore(self.controlfilename('weaves'))
213
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
217
return '%s(%r)' % (self.__class__.__name__, self.base)
224
if self._lock_mode or self._lock:
225
from warnings import warn
226
warn("branch %r was not explicitly unlocked" % self)
90
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):
180
"""Open an existing branch which contains url.
182
This probes for a branch at url, and searches upwards from there.
184
Basically we keep looking up until we find the control directory or
185
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
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():
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()
254
def _set_nick(self, nick):
255
self.get_config().set_user_option('nickname', nick, warn_masked=True)
257
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()
230
289
def lock_write(self):
232
if self._lock_mode != 'w':
233
from errors import LockError
234
raise LockError("can't upgrade to a write lock from %r" %
236
self._lock_count += 1
238
from bzrlib.lock import WriteLock
240
self._lock = WriteLock(self.controlfilename('branch-lock'))
241
self._lock_mode = 'w'
290
raise NotImplementedError(self.lock_write)
245
292
def lock_read(self):
247
assert self._lock_mode in ('r', 'w'), \
248
"invalid lock mode %r" % self._lock_mode
249
self._lock_count += 1
251
from bzrlib.lock import ReadLock
293
raise NotImplementedError(self.lock_read)
253
self._lock = ReadLock(self.controlfilename('branch-lock'))
254
self._lock_mode = 'r'
257
295
def unlock(self):
258
if not self._lock_mode:
259
from errors import LockError
260
raise LockError('branch %r is not locked' % (self))
262
if self._lock_count > 1:
263
self._lock_count -= 1
267
self._lock_mode = self._lock_count = None
269
def abspath(self, name):
270
"""Return absolute filename for something in the branch"""
271
return os.path.join(self.base, name)
273
def relpath(self, path):
274
"""Return path relative to this branch of something inside it.
276
Raises an error if path is not in this branch."""
277
return _relpath(self.base, path)
279
def controlfilename(self, file_or_path):
280
"""Return location relative to branch."""
281
if isinstance(file_or_path, basestring):
282
file_or_path = [file_or_path]
283
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
286
def controlfile(self, file_or_path, mode='r'):
287
"""Open a control file for this branch.
289
There are two classes of file in the control directory: text
290
and binary. binary files are untranslated byte streams. Text
291
control files are stored with Unix newlines and in UTF-8, even
292
if the platform or locale defaults are different.
294
Controlfiles should almost never be opened in write mode but
295
rather should be atomically copied and replaced using atomicfile.
298
fn = self.controlfilename(file_or_path)
300
if mode == 'rb' or mode == 'wb':
301
return file(fn, mode)
302
elif mode == 'r' or mode == 'w':
303
# open in binary mode anyhow so there's no newline translation;
304
# codecs uses line buffering by default; don't want that.
306
return codecs.open(fn, mode + 'b', 'utf-8',
309
raise BzrError("invalid controlfile mode %r" % mode)
311
def _make_control(self):
312
os.mkdir(self.controlfilename([]))
313
self.controlfile('README', 'w').write(
314
"This is a Bazaar-NG control directory.\n"
315
"Do not change any files in this directory.\n")
316
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT_5)
317
for d in ('text-store', 'revision-store',
319
os.mkdir(self.controlfilename(d))
320
for f in ('revision-history', 'merged-patches',
321
'pending-merged-patches', 'branch-name',
324
self.controlfile(f, 'w').write('')
325
mutter('created control directory in ' + self.base)
327
# if we want per-tree root ids then this is the place to set
328
# them; they're not needed for now and so ommitted for
330
f = self.controlfile('inventory','w')
331
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), f)
335
def _check_format(self):
336
"""Check this branch format is supported.
338
The format level is stored, as an integer, in
339
self._branch_format for code that needs to check it later.
341
In the future, we might need different in-memory Branch
342
classes to support downlevel branches. But not yet.
344
fmt = self.controlfile('branch-format', 'r').read()
345
if fmt == BZR_BRANCH_FORMAT_5:
346
self._branch_format = 5
348
raise BzrError('sorry, branch format "%s" not supported; '
349
'use a different bzr version, '
350
'or run "bzr upgrade", '
351
'or remove the .bzr directory and "bzr init" again'
352
% fmt.rstrip('\n\r'))
354
def get_root_id(self):
355
"""Return the id of this branches root"""
356
inv = self.read_working_inventory()
357
return inv.root.file_id
359
def set_root_id(self, file_id):
360
inv = self.read_working_inventory()
361
orig_root_id = inv.root.file_id
362
del inv._byid[inv.root.file_id]
363
inv.root.file_id = file_id
364
inv._byid[inv.root.file_id] = inv.root
367
if entry.parent_id in (None, orig_root_id):
368
entry.parent_id = inv.root.file_id
369
self._write_inventory(inv)
371
def read_working_inventory(self):
372
"""Read the working inventory."""
375
# ElementTree does its own conversion from UTF-8, so open in
377
f = self.controlfile('inventory', 'rb')
378
return bzrlib.xml5.serializer_v5.read_inventory(f)
383
def _write_inventory(self, inv):
384
"""Update the working inventory.
386
That is to say, the inventory describing changes underway, that
387
will be committed to the next revision.
389
from bzrlib.atomicfile import AtomicFile
393
f = AtomicFile(self.controlfilename('inventory'), 'wb')
395
bzrlib.xml5.serializer_v5.write_inventory(inv, f)
402
mutter('wrote working inventory')
405
inventory = property(read_working_inventory, _write_inventory, None,
406
"""Inventory for the working copy.""")
409
def add(self, files, ids=None):
410
"""Make files versioned.
412
Note that the command line normally calls smart_add instead,
413
which can automatically recurse.
415
This puts the files in the Added state, so that they will be
416
recorded by the next commit.
419
List of paths to add, relative to the base of the tree.
422
If set, use these instead of automatically generated ids.
423
Must be the same length as the list of files, but may
424
contain None for ids that are to be autogenerated.
426
TODO: Perhaps have an option to add the ids even if the files do
429
TODO: Perhaps yield the ids and paths as they're added.
431
# TODO: Re-adding a file that is removed in the working copy
432
# should probably put it back with the previous ID.
433
if isinstance(files, basestring):
434
assert(ids is None or isinstance(ids, basestring))
440
ids = [None] * len(files)
442
assert(len(ids) == len(files))
446
inv = self.read_working_inventory()
447
for f,file_id in zip(files, ids):
448
if is_control_file(f):
449
raise BzrError("cannot add control file %s" % quotefn(f))
454
raise BzrError("cannot add top-level %r" % f)
456
fullpath = os.path.normpath(self.abspath(f))
459
kind = file_kind(fullpath)
461
# maybe something better?
462
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
464
if kind != 'file' and kind != 'directory':
465
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
468
file_id = gen_file_id(f)
469
inv.add_path(f, kind=kind, file_id=file_id)
471
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
473
self._write_inventory(inv)
478
def print_file(self, file, revno):
479
"""Print `file` to stdout."""
482
tree = self.revision_tree(self.lookup_revision(revno))
483
# use inventory as it was in that revision
484
file_id = tree.inventory.path2id(file)
486
raise BzrError("%r is not present in revision %s" % (file, revno))
487
tree.print_file(file_id)
492
def remove(self, files, verbose=False):
493
"""Mark nominated files for removal from the inventory.
495
This does not remove their text. This does not run on
497
TODO: Refuse to remove modified files unless --force is given?
499
TODO: Do something useful with directories.
501
TODO: Should this remove the text or not? Tough call; not
502
removing may be useful and the user can just use use rm, and
503
is the opposite of add. Removing it is consistent with most
504
other tools. Maybe an option.
506
## TODO: Normalize names
507
## TODO: Remove nested loops; better scalability
508
if isinstance(files, basestring):
514
tree = self.working_tree()
517
# do this before any modifications
521
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
522
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
524
# having remove it, it must be either ignored or unknown
525
if tree.is_ignored(f):
529
show_status(new_status, inv[fid].kind, quotefn(f))
532
self._write_inventory(inv)
537
# FIXME: this doesn't need to be a branch method
538
def set_inventory(self, new_inventory_list):
539
from bzrlib.inventory import Inventory, InventoryEntry
540
inv = Inventory(self.get_root_id())
541
for path, file_id, parent, kind in new_inventory_list:
542
name = os.path.basename(path)
545
inv.add(InventoryEntry(file_id, name, kind, parent))
546
self._write_inventory(inv)
550
"""Return all unknown files.
552
These are files in the working directory that are not versioned or
553
control files or ignored.
555
>>> b = ScratchBranch(files=['foo', 'foo~'])
556
>>> list(b.unknowns())
559
>>> list(b.unknowns())
562
>>> list(b.unknowns())
565
return self.working_tree().unknowns()
568
def append_revision(self, *revision_ids):
569
from bzrlib.atomicfile import AtomicFile
571
for revision_id in revision_ids:
572
mutter("add {%s} to revision-history" % revision_id)
574
rev_history = self.revision_history()
575
rev_history.extend(revision_ids)
577
f = AtomicFile(self.controlfilename('revision-history'))
579
for rev_id in rev_history:
586
def get_revision_xml_file(self, revision_id):
587
"""Return XML file object for revision object."""
588
if not revision_id or not isinstance(revision_id, basestring):
589
raise InvalidRevisionId(revision_id)
594
return self.revision_store[revision_id]
596
raise bzrlib.errors.NoSuchRevision(self, revision_id)
602
get_revision_xml = get_revision_xml_file
605
def get_revision(self, revision_id):
606
"""Return the Revision object for a named revision"""
607
xml_file = self.get_revision_xml_file(revision_id)
610
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
611
except SyntaxError, e:
612
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
616
assert r.revision_id == revision_id
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
620
637
def get_revision_delta(self, revno):
621
638
"""Return the delta for one revision.
807
884
common_index = min(self_len, other_len) -1
808
885
if common_index >= 0 and \
809
886
self_history[common_index] != other_history[common_index]:
810
raise DivergedBranches(self, other)
887
raise errors.DivergedBranches(self, other)
812
889
if stop_revision is None:
813
890
stop_revision = other_len
814
elif stop_revision > other_len:
815
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
892
if stop_revision > other_len:
893
raise errors.NoSuchRevision(self, stop_revision)
817
894
return other_history[self_len:stop_revision]
820
def update_revisions(self, other, stop_revision=None):
821
"""Pull in all new revisions from other branch.
823
from bzrlib.fetch import greedy_fetch
825
pb = bzrlib.ui.ui_factory.progress_bar()
826
pb.update('comparing histories')
828
revision_ids = self.missing_revisions(other, stop_revision)
830
if len(revision_ids) > 0:
831
count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
834
self.append_revision(*revision_ids)
835
## note("Added %d revisions." % count)
839
def commit(self, *args, **kw):
840
from bzrlib.commit import Commit
841
Commit().commit(self, *args, **kw)
844
def lookup_revision(self, revision):
845
"""Return the revision identifier for a given revision information."""
846
revno, info = self._get_revision_info(revision)
897
def update_revisions(self, other, stop_revision=None, overwrite=False,
899
"""Pull in new perfect-fit revisions.
901
:param other: Another Branch to pull from
902
:param stop_revision: Updated until the given revision
903
:param overwrite: Always set the branch pointer, rather than checking
904
to see if it is a proper descendant.
905
:param graph: A Graph object that can be used to query history
906
information. This can be None.
909
return InterBranch.get(other, self).update_revisions(stop_revision,
912
def import_last_revision_info(self, source_repo, revno, revid):
913
"""Set the last revision info, importing from another repo if necessary.
915
This is used by the bound branch code to upload a revision to
916
the master branch first before updating the tip of the local branch.
918
:param source_repo: Source repository to optionally fetch from
919
:param revno: Revision number of the new tip
920
:param revid: Revision id of the new tip
922
if not self.repository.has_same_location(source_repo):
923
self.repository.fetch(source_repo, revision_id=revid)
924
self.set_last_revision_info(revno, revid)
850
926
def revision_id_to_revno(self, revision_id):
851
927
"""Given a revision id, return its revno"""
928
if _mod_revision.is_null(revision_id):
852
930
history = self.revision_history()
854
932
return history.index(revision_id) + 1
855
933
except ValueError:
856
raise bzrlib.errors.NoSuchRevision(self, revision_id)
859
def get_revision_info(self, revision):
860
"""Return (revno, revision id) for revision identifier.
862
revision can be an integer, in which case it is assumed to be revno (though
863
this will translate negative values into positive ones)
864
revision can also be a string, in which case it is parsed for something like
865
'date:' or 'revid:' etc.
867
revno, rev_id = self._get_revision_info(revision)
869
raise bzrlib.errors.NoSuchRevision(self, revision)
934
raise errors.NoSuchRevision(self, revision_id)
872
937
def get_rev_id(self, revno, history=None):
873
938
"""Find the revision id of the specified revno."""
877
history = self.revision_history()
878
elif revno <= 0 or revno > len(history):
879
raise bzrlib.errors.NoSuchRevision(self, revno)
880
return history[revno - 1]
882
def _get_revision_info(self, revision):
883
"""Return (revno, revision id) for revision specifier.
885
revision can be an integer, in which case it is assumed to be revno
886
(though this will translate negative values into positive ones)
887
revision can also be a string, in which case it is parsed for something
888
like 'date:' or 'revid:' etc.
890
A revid is always returned. If it is None, the specifier referred to
891
the null revision. If the revid does not occur in the revision
892
history, revno will be None.
898
try:# Convert to int if possible
899
revision = int(revision)
902
revs = self.revision_history()
903
if isinstance(revision, int):
905
revno = len(revs) + revision + 1
908
rev_id = self.get_rev_id(revno, revs)
909
elif isinstance(revision, basestring):
910
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
911
if revision.startswith(prefix):
912
result = func(self, revs, revision)
914
revno, rev_id = result
917
rev_id = self.get_rev_id(revno, revs)
920
raise BzrError('No namespace registered for string: %r' %
923
raise TypeError('Unhandled revision type %s' % revision)
927
raise bzrlib.errors.NoSuchRevision(self, revision)
930
def _namespace_revno(self, revs, revision):
931
"""Lookup a revision by revision number"""
932
assert revision.startswith('revno:')
934
return (int(revision[6:]),)
937
REVISION_NAMESPACES['revno:'] = _namespace_revno
939
def _namespace_revid(self, revs, revision):
940
assert revision.startswith('revid:')
941
rev_id = revision[len('revid:'):]
943
return revs.index(rev_id) + 1, rev_id
946
REVISION_NAMESPACES['revid:'] = _namespace_revid
948
def _namespace_last(self, revs, revision):
949
assert revision.startswith('last:')
951
offset = int(revision[5:])
956
raise BzrError('You must supply a positive value for --revision last:XXX')
957
return (len(revs) - offset + 1,)
958
REVISION_NAMESPACES['last:'] = _namespace_last
960
def _namespace_tag(self, revs, revision):
961
assert revision.startswith('tag:')
962
raise BzrError('tag: namespace registered, but not implemented.')
963
REVISION_NAMESPACES['tag:'] = _namespace_tag
965
def _namespace_date(self, revs, revision):
966
assert revision.startswith('date:')
968
# Spec for date revisions:
970
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
971
# it can also start with a '+/-/='. '+' says match the first
972
# entry after the given date. '-' is match the first entry before the date
973
# '=' is match the first entry after, but still on the given date.
975
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
976
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
977
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
978
# May 13th, 2005 at 0:00
980
# So the proper way of saying 'give me all entries for today' is:
981
# -r {date:+today}:{date:-tomorrow}
982
# The default is '=' when not supplied
985
if val[:1] in ('+', '-', '='):
986
match_style = val[:1]
989
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
990
if val.lower() == 'yesterday':
991
dt = today - datetime.timedelta(days=1)
992
elif val.lower() == 'today':
994
elif val.lower() == 'tomorrow':
995
dt = today + datetime.timedelta(days=1)
998
# This should be done outside the function to avoid recompiling it.
999
_date_re = re.compile(
1000
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1002
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1004
m = _date_re.match(val)
1005
if not m or (not m.group('date') and not m.group('time')):
1006
raise BzrError('Invalid revision date %r' % revision)
1009
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1011
year, month, day = today.year, today.month, today.day
1013
hour = int(m.group('hour'))
1014
minute = int(m.group('minute'))
1015
if m.group('second'):
1016
second = int(m.group('second'))
1020
hour, minute, second = 0,0,0
1022
dt = datetime.datetime(year=year, month=month, day=day,
1023
hour=hour, minute=minute, second=second)
1027
if match_style == '-':
1029
elif match_style == '=':
1030
last = dt + datetime.timedelta(days=1)
1033
for i in range(len(revs)-1, -1, -1):
1034
r = self.get_revision(revs[i])
1035
# TODO: Handle timezone.
1036
dt = datetime.datetime.fromtimestamp(r.timestamp)
1037
if first >= dt and (last is None or dt >= last):
1040
for i in range(len(revs)):
1041
r = self.get_revision(revs[i])
1042
# TODO: Handle timezone.
1043
dt = datetime.datetime.fromtimestamp(r.timestamp)
1044
if first <= dt and (last is None or dt <= last):
1046
REVISION_NAMESPACES['date:'] = _namespace_date
1048
def revision_tree(self, revision_id):
1049
"""Return Tree for a revision on this branch.
1051
`revision_id` may be None for the null revision, in which case
1052
an `EmptyTree` is returned."""
1053
# TODO: refactor this to use an existing revision object
1054
# so we don't need to read it in twice.
1055
if revision_id == None:
1058
inv = self.get_revision_inventory(revision_id)
1059
return RevisionTree(self.weave_store, inv, revision_id)
1062
def working_tree(self):
1063
"""Return a `Tree` for the working copy."""
1064
from workingtree import WorkingTree
1065
return WorkingTree(self.base, self.read_working_inventory())
940
return _mod_revision.NULL_REVISION
941
last_revno, last_revid = self.last_revision_info()
942
if revno == last_revno:
944
if revno <= 0 or revno > last_revno:
945
raise errors.NoSuchRevision(self, revno)
946
distance_from_last = last_revno - revno
947
if len(self._partial_revision_history_cache) <= distance_from_last:
948
self._extend_partial_history(distance_from_last)
949
return self._partial_revision_history_cache[distance_from_last]
952
def pull(self, source, overwrite=False, stop_revision=None,
953
possible_transports=None, *args, **kwargs):
954
"""Mirror source into this branch.
956
This branch is considered to be 'local', having low latency.
958
:returns: PullResult instance
960
return InterBranch.get(source, self).pull(overwrite=overwrite,
961
stop_revision=stop_revision,
962
possible_transports=possible_transports, *args, **kwargs)
964
def push(self, target, overwrite=False, stop_revision=None, *args,
966
"""Mirror this branch into target.
968
This branch is considered to be 'local', having low latency.
970
return InterBranch.get(self, target).push(overwrite, stop_revision,
973
def lossy_push(self, target, stop_revision=None):
974
"""Push deltas into another branch.
976
:note: This does not, like push, retain the revision ids from
977
the source branch and will, rather than adding bzr-specific
978
metadata, push only those semantics of the revision that can be
979
natively represented by this branch' VCS.
981
:param target: Target branch
982
:param stop_revision: Revision to push, defaults to last revision.
983
:return: BranchPushResult with an extra member revidmap:
984
A dictionary mapping revision ids from the target branch
985
to new revision ids in the target branch, for each
986
revision that was pushed.
988
inter = InterBranch.get(self, target)
989
lossy_push = getattr(inter, "lossy_push", None)
990
if lossy_push is None:
991
raise errors.LossyPushToSameVCS(self, target)
992
return lossy_push(stop_revision)
1068
994
def basis_tree(self):
1069
"""Return `Tree` object for last revision.
1071
If there are no revisions yet, return an `EmptyTree`.
1073
return self.revision_tree(self.last_patch())
1076
def rename_one(self, from_rel, to_rel):
1079
This can change the directory or the filename or both.
1083
tree = self.working_tree()
1084
inv = tree.inventory
1085
if not tree.has_filename(from_rel):
1086
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1087
if tree.has_filename(to_rel):
1088
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1090
file_id = inv.path2id(from_rel)
1092
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1094
if inv.path2id(to_rel):
1095
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1097
to_dir, to_tail = os.path.split(to_rel)
1098
to_dir_id = inv.path2id(to_dir)
1099
if to_dir_id == None and to_dir != '':
1100
raise BzrError("can't determine destination directory id for %r" % to_dir)
1102
mutter("rename_one:")
1103
mutter(" file_id {%s}" % file_id)
1104
mutter(" from_rel %r" % from_rel)
1105
mutter(" to_rel %r" % to_rel)
1106
mutter(" to_dir %r" % to_dir)
1107
mutter(" to_dir_id {%s}" % to_dir_id)
1109
inv.rename(file_id, to_dir_id, to_tail)
1111
from_abs = self.abspath(from_rel)
1112
to_abs = self.abspath(to_rel)
1114
os.rename(from_abs, to_abs)
1116
raise BzrError("failed to rename %r to %r: %s"
1117
% (from_abs, to_abs, e[1]),
1118
["rename rolled back"])
1120
self._write_inventory(inv)
1125
def move(self, from_paths, to_name):
1128
to_name must exist as a versioned directory.
1130
If to_name exists and is a directory, the files are moved into
1131
it, keeping their old names. If it is a directory,
1133
Note that to_name is only the last component of the new name;
1134
this doesn't change the directory.
1136
This returns a list of (from_path, to_path) pairs for each
1137
entry that is moved.
1142
## TODO: Option to move IDs only
1143
assert not isinstance(from_paths, basestring)
1144
tree = self.working_tree()
1145
inv = tree.inventory
1146
to_abs = self.abspath(to_name)
1147
if not isdir(to_abs):
1148
raise BzrError("destination %r is not a directory" % to_abs)
1149
if not tree.has_filename(to_name):
1150
raise BzrError("destination %r not in working directory" % to_abs)
1151
to_dir_id = inv.path2id(to_name)
1152
if to_dir_id == None and to_name != '':
1153
raise BzrError("destination %r is not a versioned directory" % to_name)
1154
to_dir_ie = inv[to_dir_id]
1155
if to_dir_ie.kind not in ('directory', 'root_directory'):
1156
raise BzrError("destination %r is not a directory" % to_abs)
1158
to_idpath = inv.get_idpath(to_dir_id)
1160
for f in from_paths:
1161
if not tree.has_filename(f):
1162
raise BzrError("%r does not exist in working tree" % f)
1163
f_id = inv.path2id(f)
1165
raise BzrError("%r is not versioned" % f)
1166
name_tail = splitpath(f)[-1]
1167
dest_path = appendpath(to_name, name_tail)
1168
if tree.has_filename(dest_path):
1169
raise BzrError("destination %r already exists" % dest_path)
1170
if f_id in to_idpath:
1171
raise BzrError("can't move %r to a subdirectory of itself" % f)
1173
# OK, so there's a race here, it's possible that someone will
1174
# create a file in this interval and then the rename might be
1175
# left half-done. But we should have caught most problems.
1177
for f in from_paths:
1178
name_tail = splitpath(f)[-1]
1179
dest_path = appendpath(to_name, name_tail)
1180
result.append((f, dest_path))
1181
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1183
os.rename(self.abspath(f), self.abspath(dest_path))
1185
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1186
["rename rolled back"])
1188
self._write_inventory(inv)
1195
def revert(self, filenames, old_tree=None, backups=True):
1196
"""Restore selected files to the versions from a previous tree.
1199
If true (default) backups are made of files before
1202
from bzrlib.errors import NotVersionedError, BzrError
1203
from bzrlib.atomicfile import AtomicFile
1204
from bzrlib.osutils import backup_file
1206
inv = self.read_working_inventory()
1207
if old_tree is None:
1208
old_tree = self.basis_tree()
1209
old_inv = old_tree.inventory
1212
for fn in filenames:
1213
file_id = inv.path2id(fn)
1215
raise NotVersionedError("not a versioned file", fn)
1216
if not old_inv.has_id(file_id):
1217
raise BzrError("file not present in old tree", fn, file_id)
1218
nids.append((fn, file_id))
1220
# TODO: Rename back if it was previously at a different location
1222
# TODO: If given a directory, restore the entire contents from
1223
# the previous version.
1225
# TODO: Make a backup to a temporary file.
1227
# TODO: If the file previously didn't exist, delete it?
1228
for fn, file_id in nids:
1231
f = AtomicFile(fn, 'wb')
1233
f.write(old_tree.get_file(file_id).read())
1239
def pending_merges(self):
1240
"""Return a list of pending merges.
1242
These are revisions that have been merged into the working
1243
directory but not yet committed.
1245
cfn = self.controlfilename('pending-merges')
1246
if not os.path.exists(cfn):
1249
for l in self.controlfile('pending-merges', 'r').readlines():
1250
p.append(l.rstrip('\n'))
1254
def add_pending_merge(self, revision_id):
1255
from bzrlib.revision import validate_revision_id
1257
validate_revision_id(revision_id)
1259
p = self.pending_merges()
1260
if revision_id in p:
1262
p.append(revision_id)
1263
self.set_pending_merges(p)
1266
def set_pending_merges(self, rev_list):
1267
from bzrlib.atomicfile import AtomicFile
1270
f = AtomicFile(self.controlfilename('pending-merges'))
995
"""Return `Tree` object for last revision."""
996
return self.repository.revision_tree(self.last_revision())
1281
998
def get_parent(self):
1282
999
"""Return the parent location of the branch.
1284
This is the default location for push/pull/missing. The usual
1285
pattern is that the user can override it by specifying a
1289
_locs = ['parent', 'pull', 'x-pull']
1001
This is the default location for pull/missing. The usual
1002
pattern is that the user can override it by specifying a
1005
parent = self._get_parent_location()
1008
# This is an old-format absolute path to a local branch
1009
# turn it into a url
1010
if parent.startswith('/'):
1011
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1013
return urlutils.join(self.base[:-1], parent)
1014
except errors.InvalidURLJoin, e:
1015
raise errors.InaccessibleParent(parent, self.base)
1017
def _get_parent_location(self):
1018
raise NotImplementedError(self._get_parent_location)
1020
def _set_config_location(self, name, url, config=None,
1021
make_relative=False):
1023
config = self.get_config()
1027
url = urlutils.relative_url(self.base, url)
1028
config.set_user_option(name, url, warn_masked=True)
1030
def _get_config_location(self, name, config=None):
1032
config = self.get_config()
1033
location = config.get_user_option(name)
1038
def get_child_submit_format(self):
1039
"""Return the preferred format of submissions to this branch."""
1040
return self.get_config().get_user_option("child_submit_format")
1042
def get_submit_branch(self):
1043
"""Return the submit location of the branch.
1045
This is the default location for bundle. The usual
1046
pattern is that the user can override it by specifying a
1049
return self.get_config().get_user_option('submit_branch')
1051
def set_submit_branch(self, location):
1052
"""Return the submit location of the branch.
1054
This is the default location for bundle. The usual
1055
pattern is that the user can override it by specifying a
1058
self.get_config().set_user_option('submit_branch', location,
1061
def get_public_branch(self):
1062
"""Return the public location of the branch.
1064
This is used by merge directives.
1066
return self._get_config_location('public_branch')
1068
def set_public_branch(self, location):
1069
"""Return the submit location of the branch.
1071
This is the default location for bundle. The usual
1072
pattern is that the user can override it by specifying a
1075
self._set_config_location('public_branch', location)
1077
def get_push_location(self):
1078
"""Return the None or the location to push this branch to."""
1079
push_loc = self.get_config().get_user_option('push_location')
1082
def set_push_location(self, location):
1083
"""Set a new push location for this branch."""
1084
raise NotImplementedError(self.set_push_location)
1086
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1087
"""Run the post_change_branch_tip hooks."""
1088
hooks = Branch.hooks['post_change_branch_tip']
1091
new_revno, new_revid = self.last_revision_info()
1092
params = ChangeBranchTipParams(
1093
self, old_revno, new_revno, old_revid, new_revid)
1097
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1098
"""Run the pre_change_branch_tip hooks."""
1099
hooks = Branch.hooks['pre_change_branch_tip']
1102
old_revno, old_revid = self.last_revision_info()
1103
params = ChangeBranchTipParams(
1104
self, old_revno, new_revno, old_revid, new_revid)
1292
return self.controlfile(l, 'r').read().strip('\n')
1294
if e.errno != errno.ENOENT:
1108
except errors.TipChangeRejected:
1111
exc_info = sys.exc_info()
1112
hook_name = Branch.hooks.get_hook_name(hook)
1113
raise errors.HookFailed(
1114
'pre_change_branch_tip', hook_name, exc_info)
1118
"""Synchronise this branch with the master branch if any.
1120
:return: None or the last_revision pivoted out during the update.
1299
def set_parent(self, url):
1300
# TODO: Maybe delete old location files?
1301
from bzrlib.atomicfile import AtomicFile
1304
f = AtomicFile(self.controlfilename('parent'))
1313
1124
def check_revno(self, revno):
1315
1126
Check whether a revno corresponds to any revision.
1319
1130
self.check_real_revno(revno)
1321
1132
def check_real_revno(self, revno):
1323
1134
Check whether a revno corresponds to a real revision.
1324
1135
Zero (the NULL revision) is considered invalid
1326
1137
if revno < 1 or revno > self.revno():
1327
raise InvalidRevisionNumber(revno)
1332
class ScratchBranch(Branch):
1333
"""Special test class: a branch that cleans up after itself.
1335
>>> b = ScratchBranch()
1343
def __init__(self, files=[], dirs=[], base=None):
1344
"""Make a test branch.
1346
This creates a temporary directory and runs init-tree in it.
1348
If any files are listed, they are created in the working copy.
1350
from tempfile import mkdtemp
1355
Branch.__init__(self, base, init=init)
1357
os.mkdir(self.abspath(d))
1360
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1365
>>> orig = ScratchBranch(files=["file1", "file2"])
1366
>>> clone = orig.clone()
1367
>>> os.path.samefile(orig.base, clone.base)
1369
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1372
from shutil import copytree
1373
from tempfile import mkdtemp
1376
copytree(self.base, base, symlinks=True)
1377
return ScratchBranch(base=base)
1385
"""Destroy the test branch, removing the scratch directory."""
1386
from shutil import rmtree
1389
mutter("delete ScratchBranch %s" % self.base)
1392
# Work around for shutil.rmtree failing on Windows when
1393
# readonly files are encountered
1394
mutter("hit exception in destroying ScratchBranch: %s" % e)
1395
for root, dirs, files in os.walk(self.base, topdown=False):
1397
os.chmod(os.path.join(root, name), 0700)
1138
raise errors.InvalidRevisionNumber(revno)
1141
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1142
"""Clone this branch into to_bzrdir preserving all semantic values.
1144
Most API users will want 'create_clone_on_transport', which creates a
1145
new bzrdir and branch on the fly.
1147
revision_id: if not None, the revision history in the new branch will
1148
be truncated to end with revision_id.
1150
result = to_bzrdir.create_branch()
1153
if repository_policy is not None:
1154
repository_policy.configure_branch(result)
1155
self.copy_content_into(result, revision_id=revision_id)
1161
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1162
"""Create a new line of development from the branch, into to_bzrdir.
1164
to_bzrdir controls the branch format.
1166
revision_id: if not None, the revision history in the new branch will
1167
be truncated to end with revision_id.
1169
if (repository_policy is not None and
1170
repository_policy.requires_stacking()):
1171
to_bzrdir._format.require_stacking(_skip_repo=True)
1172
result = to_bzrdir.create_branch()
1175
if repository_policy is not None:
1176
repository_policy.configure_branch(result)
1177
self.copy_content_into(result, revision_id=revision_id)
1178
result.set_parent(self.bzrdir.root_transport.base)
1183
def _synchronize_history(self, destination, revision_id):
1184
"""Synchronize last revision and revision history between branches.
1186
This version is most efficient when the destination is also a
1187
BzrBranch6, but works for BzrBranch5, as long as the destination's
1188
repository contains all the lefthand ancestors of the intended
1189
last_revision. If not, set_last_revision_info will fail.
1191
:param destination: The branch to copy the history into
1192
:param revision_id: The revision-id to truncate history at. May
1193
be None to copy complete history.
1195
source_revno, source_revision_id = self.last_revision_info()
1196
if revision_id is None:
1197
revno, revision_id = source_revno, source_revision_id
1199
graph = self.repository.get_graph()
1201
revno = graph.find_distance_to_null(revision_id,
1202
[(source_revision_id, source_revno)])
1203
except errors.GhostRevisionsHaveNoRevno:
1204
# Default to 1, if we can't find anything else
1206
destination.set_last_revision_info(revno, revision_id)
1209
def copy_content_into(self, destination, revision_id=None):
1210
"""Copy the content of self into destination.
1212
revision_id: if not None, the revision history in the new branch will
1213
be truncated to end with revision_id.
1215
self.update_references(destination)
1216
self._synchronize_history(destination, revision_id)
1218
parent = self.get_parent()
1219
except errors.InaccessibleParent, e:
1220
mutter('parent was not accessible to copy: %s', e)
1223
destination.set_parent(parent)
1224
if self._push_should_merge_tags():
1225
self.tags.merge_to(destination.tags)
1227
def update_references(self, target):
1228
if not getattr(self._format, 'supports_reference_locations', False):
1230
reference_dict = self._get_all_reference_info()
1231
if len(reference_dict) == 0:
1233
old_base = self.base
1234
new_base = target.base
1235
target_reference_dict = target._get_all_reference_info()
1236
for file_id, (tree_path, branch_location) in (
1237
reference_dict.items()):
1238
branch_location = urlutils.rebase_url(branch_location,
1240
target_reference_dict.setdefault(
1241
file_id, (tree_path, branch_location))
1242
target._set_all_reference_info(target_reference_dict)
1245
def check(self, refs):
1246
"""Check consistency of the branch.
1248
In particular this checks that revisions given in the revision-history
1249
do actually match up in the revision graph, and that they're all
1250
present in the repository.
1252
Callers will typically also want to check the repository.
1254
:param refs: Calculated refs for this branch as specified by
1255
branch._get_check_refs()
1256
:return: A BranchCheckResult.
1258
result = BranchCheckResult(self)
1259
last_revno, last_revision_id = self.last_revision_info()
1260
actual_revno = refs[('lefthand-distance', last_revision_id)]
1261
if actual_revno != last_revno:
1262
result.errors.append(errors.BzrCheckError(
1263
'revno does not match len(mainline) %s != %s' % (
1264
last_revno, actual_revno)))
1265
# TODO: We should probably also check that self.revision_history
1266
# matches the repository for older branch formats.
1267
# If looking for the code that cross-checks repository parents against
1268
# the iter_reverse_revision_history output, that is now a repository
1272
def _get_checkout_format(self):
1273
"""Return the most suitable metadir for a checkout of this branch.
1274
Weaves are used if this branch's repository uses weaves.
1276
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1277
from bzrlib.repofmt import weaverepo
1278
format = bzrdir.BzrDirMetaFormat1()
1279
format.repository_format = weaverepo.RepositoryFormat7()
1281
format = self.repository.bzrdir.checkout_metadir()
1282
format.set_branch_format(self._format)
1285
def create_clone_on_transport(self, to_transport, revision_id=None,
1286
stacked_on=None, create_prefix=False, use_existing_dir=False):
1287
"""Create a clone of this branch and its bzrdir.
1289
:param to_transport: The transport to clone onto.
1290
:param revision_id: The revision id to use as tip in the new branch.
1291
If None the tip is obtained from this branch.
1292
:param stacked_on: An optional URL to stack the clone on.
1293
:param create_prefix: Create any missing directories leading up to
1295
:param use_existing_dir: Use an existing directory if one exists.
1297
# XXX: Fix the bzrdir API to allow getting the branch back from the
1298
# clone call. Or something. 20090224 RBC/spiv.
1299
if revision_id is None:
1300
revision_id = self.last_revision()
1301
dir_to = self.bzrdir.clone_on_transport(to_transport,
1302
revision_id=revision_id, stacked_on=stacked_on,
1303
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1304
return dir_to.open_branch()
1306
def create_checkout(self, to_location, revision_id=None,
1307
lightweight=False, accelerator_tree=None,
1309
"""Create a checkout of a branch.
1311
:param to_location: The url to produce the checkout at
1312
:param revision_id: The revision to check out
1313
:param lightweight: If True, produce a lightweight checkout, otherwise,
1314
produce a bound branch (heavyweight checkout)
1315
:param accelerator_tree: A tree which can be used for retrieving file
1316
contents more quickly than the revision tree, i.e. a workingtree.
1317
The revision tree will be used for cases where accelerator_tree's
1318
content is different.
1319
:param hardlink: If true, hard-link files from accelerator_tree,
1321
:return: The tree of the created checkout
1323
t = transport.get_transport(to_location)
1326
format = self._get_checkout_format()
1327
checkout = format.initialize_on_transport(t)
1328
from_branch = BranchReferenceFormat().initialize(checkout, self)
1330
format = self._get_checkout_format()
1331
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1332
to_location, force_new_tree=False, format=format)
1333
checkout = checkout_branch.bzrdir
1334
checkout_branch.bind(self)
1335
# pull up to the specified revision_id to set the initial
1336
# branch tip correctly, and seed it with history.
1337
checkout_branch.pull(self, stop_revision=revision_id)
1339
tree = checkout.create_workingtree(revision_id,
1340
from_branch=from_branch,
1341
accelerator_tree=accelerator_tree,
1343
basis_tree = tree.basis_tree()
1344
basis_tree.lock_read()
1346
for path, file_id in basis_tree.iter_references():
1347
reference_parent = self.reference_parent(file_id, path)
1348
reference_parent.create_checkout(tree.abspath(path),
1349
basis_tree.get_reference_revision(file_id, path),
1356
def reconcile(self, thorough=True):
1357
"""Make sure the data stored in this branch is consistent."""
1358
from bzrlib.reconcile import BranchReconciler
1359
reconciler = BranchReconciler(self, thorough=thorough)
1360
reconciler.reconcile()
1363
def reference_parent(self, file_id, path, possible_transports=None):
1364
"""Return the parent branch for a tree-reference file_id
1365
:param file_id: The file_id of the tree reference
1366
:param path: The path of the file_id in the tree
1367
:return: A branch associated with the file_id
1369
# FIXME should provide multiple branches, based on config
1370
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1371
possible_transports=possible_transports)
1373
def supports_tags(self):
1374
return self._format.supports_tags()
1376
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1378
"""Ensure that revision_b is a descendant of revision_a.
1380
This is a helper function for update_revisions.
1382
:raises: DivergedBranches if revision_b has diverged from revision_a.
1383
:returns: True if revision_b is a descendant of revision_a.
1385
relation = self._revision_relations(revision_a, revision_b, graph)
1386
if relation == 'b_descends_from_a':
1388
elif relation == 'diverged':
1389
raise errors.DivergedBranches(self, other_branch)
1390
elif relation == 'a_descends_from_b':
1393
raise AssertionError("invalid relation: %r" % (relation,))
1395
def _revision_relations(self, revision_a, revision_b, graph):
1396
"""Determine the relationship between two revisions.
1398
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1400
heads = graph.heads([revision_a, revision_b])
1401
if heads == set([revision_b]):
1402
return 'b_descends_from_a'
1403
elif heads == set([revision_a, revision_b]):
1404
# These branches have diverged
1406
elif heads == set([revision_a]):
1407
return 'a_descends_from_b'
1409
raise AssertionError("invalid heads: %r" % (heads,))
1412
class BranchFormat(object):
1413
"""An encapsulation of the initialization and open routines for a format.
1415
Formats provide three things:
1416
* An initialization routine,
1420
Formats are placed in an dict by their format string for reference
1421
during branch opening. Its not required that these be instances, they
1422
can be classes themselves with class methods - it simply depends on
1423
whether state is needed for a given format or not.
1425
Once a format is deprecated, just deprecate the initialize and open
1426
methods on the format class. Do not deprecate the object, as the
1427
object will be created every time regardless.
1430
_default_format = None
1431
"""The default format used for new branches."""
1434
"""The known formats."""
1436
can_set_append_revisions_only = True
1438
def __eq__(self, other):
1439
return self.__class__ is other.__class__
1441
def __ne__(self, other):
1442
return not (self == other)
1445
def find_format(klass, a_bzrdir):
1446
"""Return the format for the branch object in a_bzrdir."""
1448
transport = a_bzrdir.get_branch_transport(None)
1449
format_string = transport.get_bytes("format")
1450
return klass._formats[format_string]
1451
except errors.NoSuchFile:
1452
raise errors.NotBranchError(path=transport.base)
1454
raise errors.UnknownFormatError(format=format_string, kind='branch')
1457
def get_default_format(klass):
1458
"""Return the current default format."""
1459
return klass._default_format
1461
def get_reference(self, a_bzrdir):
1462
"""Get the target reference of the branch in a_bzrdir.
1464
format probing must have been completed before calling
1465
this method - it is assumed that the format of the branch
1466
in a_bzrdir is correct.
1468
:param a_bzrdir: The bzrdir to get the branch data from.
1469
:return: None if the branch is not a reference branch.
1474
def set_reference(self, a_bzrdir, to_branch):
1475
"""Set the target reference of the branch in a_bzrdir.
1477
format probing must have been completed before calling
1478
this method - it is assumed that the format of the branch
1479
in a_bzrdir is correct.
1481
:param a_bzrdir: The bzrdir to set the branch reference for.
1482
:param to_branch: branch that the checkout is to reference
1484
raise NotImplementedError(self.set_reference)
1486
def get_format_string(self):
1487
"""Return the ASCII format string that identifies this format."""
1488
raise NotImplementedError(self.get_format_string)
1490
def get_format_description(self):
1491
"""Return the short format description for this format."""
1492
raise NotImplementedError(self.get_format_description)
1494
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1496
"""Initialize a branch in a bzrdir, with specified files
1498
:param a_bzrdir: The bzrdir to initialize the branch in
1499
:param utf8_files: The files to create as a list of
1500
(filename, content) tuples
1501
:param set_format: If True, set the format with
1502
self.get_format_string. (BzrBranch4 has its format set
1504
:return: a branch in this format
1506
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1507
branch_transport = a_bzrdir.get_branch_transport(self)
1509
'metadir': ('lock', lockdir.LockDir),
1510
'branch4': ('branch-lock', lockable_files.TransportLock),
1512
lock_name, lock_class = lock_map[lock_type]
1513
control_files = lockable_files.LockableFiles(branch_transport,
1514
lock_name, lock_class)
1515
control_files.create_lock()
1517
control_files.lock_write()
1518
except errors.LockContention:
1519
if lock_type != 'branch4':
1525
utf8_files += [('format', self.get_format_string())]
1527
for (filename, content) in utf8_files:
1528
branch_transport.put_bytes(
1530
mode=a_bzrdir._get_file_mode())
1533
control_files.unlock()
1534
return self.open(a_bzrdir, _found=True)
1536
def initialize(self, a_bzrdir):
1537
"""Create a branch of this format in a_bzrdir."""
1538
raise NotImplementedError(self.initialize)
1540
def is_supported(self):
1541
"""Is this format supported?
1543
Supported formats can be initialized and opened.
1544
Unsupported formats may not support initialization or committing or
1545
some other features depending on the reason for not being supported.
1549
def make_tags(self, branch):
1550
"""Create a tags object for branch.
1552
This method is on BranchFormat, because BranchFormats are reflected
1553
over the wire via network_name(), whereas full Branch instances require
1554
multiple VFS method calls to operate at all.
1556
The default implementation returns a disabled-tags instance.
1558
Note that it is normal for branch to be a RemoteBranch when using tags
1561
return DisabledTags(branch)
1563
def network_name(self):
1564
"""A simple byte string uniquely identifying this format for RPC calls.
1566
MetaDir branch formats use their disk format string to identify the
1567
repository over the wire. All in one formats such as bzr < 0.8, and
1568
foreign formats like svn/git and hg should use some marker which is
1569
unique and immutable.
1571
raise NotImplementedError(self.network_name)
1573
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1574
"""Return the branch object for a_bzrdir
1576
:param a_bzrdir: A BzrDir that contains a branch.
1577
:param _found: a private parameter, do not use it. It is used to
1578
indicate if format probing has already be done.
1579
:param ignore_fallbacks: when set, no fallback branches will be opened
1580
(if there are any). Default is to open fallbacks.
1582
raise NotImplementedError(self.open)
1585
def register_format(klass, format):
1586
"""Register a metadir format."""
1587
klass._formats[format.get_format_string()] = format
1588
# Metadir formats have a network name of their format string, and get
1589
# registered as class factories.
1590
network_format_registry.register(format.get_format_string(), format.__class__)
1593
def set_default_format(klass, format):
1594
klass._default_format = format
1596
def supports_set_append_revisions_only(self):
1597
"""True if this format supports set_append_revisions_only."""
1600
def supports_stacking(self):
1601
"""True if this format records a stacked-on branch."""
1605
def unregister_format(klass, format):
1606
del klass._formats[format.get_format_string()]
1609
return self.get_format_description().rstrip()
1611
def supports_tags(self):
1612
"""True if this format supports tags stored in the branch"""
1613
return False # by default
1616
class BranchHooks(Hooks):
1617
"""A dictionary mapping hook name to a list of callables for branch hooks.
1619
e.g. ['set_rh'] Is the list of items to be called when the
1620
set_revision_history function is invoked.
1624
"""Create the default hooks.
1626
These are all empty initially, because by default nothing should get
1629
Hooks.__init__(self)
1630
self.create_hook(HookPoint('set_rh',
1631
"Invoked whenever the revision history has been set via "
1632
"set_revision_history. The api signature is (branch, "
1633
"revision_history), and the branch will be write-locked. "
1634
"The set_rh hook can be expensive for bzr to trigger, a better "
1635
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1636
self.create_hook(HookPoint('open',
1637
"Called with the Branch object that has been opened after a "
1638
"branch is opened.", (1, 8), None))
1639
self.create_hook(HookPoint('post_push',
1640
"Called after a push operation completes. post_push is called "
1641
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1642
"bzr client.", (0, 15), None))
1643
self.create_hook(HookPoint('post_pull',
1644
"Called after a pull operation completes. post_pull is called "
1645
"with a bzrlib.branch.PullResult object and only runs in the "
1646
"bzr client.", (0, 15), None))
1647
self.create_hook(HookPoint('pre_commit',
1648
"Called after a commit is calculated but before it is is "
1649
"completed. pre_commit is called with (local, master, old_revno, "
1650
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1651
"). old_revid is NULL_REVISION for the first commit to a branch, "
1652
"tree_delta is a TreeDelta object describing changes from the "
1653
"basis revision. hooks MUST NOT modify this delta. "
1654
" future_tree is an in-memory tree obtained from "
1655
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1656
"tree.", (0,91), None))
1657
self.create_hook(HookPoint('post_commit',
1658
"Called in the bzr client after a commit has completed. "
1659
"post_commit is called with (local, master, old_revno, old_revid, "
1660
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1661
"commit to a branch.", (0, 15), None))
1662
self.create_hook(HookPoint('post_uncommit',
1663
"Called in the bzr client after an uncommit completes. "
1664
"post_uncommit is called with (local, master, old_revno, "
1665
"old_revid, new_revno, new_revid) where local is the local branch "
1666
"or None, master is the target branch, and an empty branch "
1667
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1668
self.create_hook(HookPoint('pre_change_branch_tip',
1669
"Called in bzr client and server before a change to the tip of a "
1670
"branch is made. pre_change_branch_tip is called with a "
1671
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1672
"commit, uncommit will all trigger this hook.", (1, 6), None))
1673
self.create_hook(HookPoint('post_change_branch_tip',
1674
"Called in bzr client and server after a change to the tip of a "
1675
"branch is made. post_change_branch_tip is called with a "
1676
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1677
"commit, uncommit will all trigger this hook.", (1, 4), None))
1678
self.create_hook(HookPoint('transform_fallback_location',
1679
"Called when a stacked branch is activating its fallback "
1680
"locations. transform_fallback_location is called with (branch, "
1681
"url), and should return a new url. Returning the same url "
1682
"allows it to be used as-is, returning a different one can be "
1683
"used to cause the branch to stack on a closer copy of that "
1684
"fallback_location. Note that the branch cannot have history "
1685
"accessing methods called on it during this hook because the "
1686
"fallback locations have not been activated. When there are "
1687
"multiple hooks installed for transform_fallback_location, "
1688
"all are called with the url returned from the previous hook."
1689
"The order is however undefined.", (1, 9), None))
1692
# install the default hooks into the Branch class.
1693
Branch.hooks = BranchHooks()
1696
class ChangeBranchTipParams(object):
1697
"""Object holding parameters passed to *_change_branch_tip hooks.
1699
There are 5 fields that hooks may wish to access:
1701
:ivar branch: the branch being changed
1702
:ivar old_revno: revision number before the change
1703
:ivar new_revno: revision number after the change
1704
:ivar old_revid: revision id before the change
1705
:ivar new_revid: revision id after the change
1707
The revid fields are strings. The revno fields are integers.
1710
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1711
"""Create a group of ChangeBranchTip parameters.
1713
:param branch: The branch being changed.
1714
:param old_revno: Revision number before the change.
1715
:param new_revno: Revision number after the change.
1716
:param old_revid: Tip revision id before the change.
1717
:param new_revid: Tip revision id after the change.
1719
self.branch = branch
1720
self.old_revno = old_revno
1721
self.new_revno = new_revno
1722
self.old_revid = old_revid
1723
self.new_revid = new_revid
1725
def __eq__(self, other):
1726
return self.__dict__ == other.__dict__
1729
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1730
self.__class__.__name__, self.branch,
1731
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1734
class BzrBranchFormat4(BranchFormat):
1735
"""Bzr branch format 4.
1738
- a revision-history file.
1739
- a branch-lock lock file [ to be shared with the bzrdir ]
1742
def get_format_description(self):
1743
"""See BranchFormat.get_format_description()."""
1744
return "Branch format 4"
1746
def initialize(self, a_bzrdir):
1747
"""Create a branch of this format in a_bzrdir."""
1748
utf8_files = [('revision-history', ''),
1749
('branch-name', ''),
1751
return self._initialize_helper(a_bzrdir, utf8_files,
1752
lock_type='branch4', set_format=False)
1755
super(BzrBranchFormat4, self).__init__()
1756
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1758
def network_name(self):
1759
"""The network name for this format is the control dirs disk label."""
1760
return self._matchingbzrdir.get_format_string()
1762
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1763
"""See BranchFormat.open()."""
1765
# we are being called directly and must probe.
1766
raise NotImplementedError
1767
return BzrBranch(_format=self,
1768
_control_files=a_bzrdir._control_files,
1770
_repository=a_bzrdir.open_repository())
1773
return "Bazaar-NG branch format 4"
1776
class BranchFormatMetadir(BranchFormat):
1777
"""Common logic for meta-dir based branch formats."""
1779
def _branch_class(self):
1780
"""What class to instantiate on open calls."""
1781
raise NotImplementedError(self._branch_class)
1783
def network_name(self):
1784
"""A simple byte string uniquely identifying this format for RPC calls.
1786
Metadir branch formats use their format string.
1788
return self.get_format_string()
1790
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1791
"""See BranchFormat.open()."""
1793
format = BranchFormat.find_format(a_bzrdir)
1794
if format.__class__ != self.__class__:
1795
raise AssertionError("wrong format %r found for %r" %
1798
transport = a_bzrdir.get_branch_transport(None)
1799
control_files = lockable_files.LockableFiles(transport, 'lock',
1801
return self._branch_class()(_format=self,
1802
_control_files=control_files,
1804
_repository=a_bzrdir.find_repository(),
1805
ignore_fallbacks=ignore_fallbacks)
1806
except errors.NoSuchFile:
1807
raise errors.NotBranchError(path=transport.base)
1810
super(BranchFormatMetadir, self).__init__()
1811
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1812
self._matchingbzrdir.set_branch_format(self)
1814
def supports_tags(self):
1818
class BzrBranchFormat5(BranchFormatMetadir):
1819
"""Bzr branch format 5.
1822
- a revision-history file.
1824
- a lock dir guarding the branch itself
1825
- all of this stored in a branch/ subdirectory
1826
- works with shared repositories.
1828
This format is new in bzr 0.8.
1831
def _branch_class(self):
1834
def get_format_string(self):
1835
"""See BranchFormat.get_format_string()."""
1836
return "Bazaar-NG branch format 5\n"
1838
def get_format_description(self):
1839
"""See BranchFormat.get_format_description()."""
1840
return "Branch format 5"
1842
def initialize(self, a_bzrdir):
1843
"""Create a branch of this format in a_bzrdir."""
1844
utf8_files = [('revision-history', ''),
1845
('branch-name', ''),
1847
return self._initialize_helper(a_bzrdir, utf8_files)
1849
def supports_tags(self):
1853
class BzrBranchFormat6(BranchFormatMetadir):
1854
"""Branch format with last-revision and tags.
1856
Unlike previous formats, this has no explicit revision history. Instead,
1857
this just stores the last-revision, and the left-hand history leading
1858
up to there is the history.
1860
This format was introduced in bzr 0.15
1861
and became the default in 0.91.
1864
def _branch_class(self):
1867
def get_format_string(self):
1868
"""See BranchFormat.get_format_string()."""
1869
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1871
def get_format_description(self):
1872
"""See BranchFormat.get_format_description()."""
1873
return "Branch format 6"
1875
def initialize(self, a_bzrdir):
1876
"""Create a branch of this format in a_bzrdir."""
1877
utf8_files = [('last-revision', '0 null:\n'),
1878
('branch.conf', ''),
1881
return self._initialize_helper(a_bzrdir, utf8_files)
1883
def make_tags(self, branch):
1884
"""See bzrlib.branch.BranchFormat.make_tags()."""
1885
return BasicTags(branch)
1887
def supports_set_append_revisions_only(self):
1891
class BzrBranchFormat8(BranchFormatMetadir):
1892
"""Metadir format supporting storing locations of subtree branches."""
1894
def _branch_class(self):
1897
def get_format_string(self):
1898
"""See BranchFormat.get_format_string()."""
1899
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1901
def get_format_description(self):
1902
"""See BranchFormat.get_format_description()."""
1903
return "Branch format 8"
1905
def initialize(self, a_bzrdir):
1906
"""Create a branch of this format in a_bzrdir."""
1907
utf8_files = [('last-revision', '0 null:\n'),
1908
('branch.conf', ''),
1912
return self._initialize_helper(a_bzrdir, utf8_files)
1915
super(BzrBranchFormat8, self).__init__()
1916
self._matchingbzrdir.repository_format = \
1917
RepositoryFormatKnitPack5RichRoot()
1919
def make_tags(self, branch):
1920
"""See bzrlib.branch.BranchFormat.make_tags()."""
1921
return BasicTags(branch)
1923
def supports_set_append_revisions_only(self):
1926
def supports_stacking(self):
1929
supports_reference_locations = True
1932
class BzrBranchFormat7(BzrBranchFormat8):
1933
"""Branch format with last-revision, tags, and a stacked location pointer.
1935
The stacked location pointer is passed down to the repository and requires
1936
a repository format with supports_external_lookups = True.
1938
This format was introduced in bzr 1.6.
1941
def initialize(self, a_bzrdir):
1942
"""Create a branch of this format in a_bzrdir."""
1943
utf8_files = [('last-revision', '0 null:\n'),
1944
('branch.conf', ''),
1947
return self._initialize_helper(a_bzrdir, utf8_files)
1949
def _branch_class(self):
1952
def get_format_string(self):
1953
"""See BranchFormat.get_format_string()."""
1954
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1956
def get_format_description(self):
1957
"""See BranchFormat.get_format_description()."""
1958
return "Branch format 7"
1960
def supports_set_append_revisions_only(self):
1963
supports_reference_locations = False
1966
class BranchReferenceFormat(BranchFormat):
1967
"""Bzr branch reference format.
1969
Branch references are used in implementing checkouts, they
1970
act as an alias to the real branch which is at some other url.
1977
def get_format_string(self):
1978
"""See BranchFormat.get_format_string()."""
1979
return "Bazaar-NG Branch Reference Format 1\n"
1981
def get_format_description(self):
1982
"""See BranchFormat.get_format_description()."""
1983
return "Checkout reference format 1"
1985
def get_reference(self, a_bzrdir):
1986
"""See BranchFormat.get_reference()."""
1987
transport = a_bzrdir.get_branch_transport(None)
1988
return transport.get_bytes('location')
1990
def set_reference(self, a_bzrdir, to_branch):
1991
"""See BranchFormat.set_reference()."""
1992
transport = a_bzrdir.get_branch_transport(None)
1993
location = transport.put_bytes('location', to_branch.base)
1995
def initialize(self, a_bzrdir, target_branch=None):
1996
"""Create a branch of this format in a_bzrdir."""
1997
if target_branch is None:
1998
# this format does not implement branch itself, thus the implicit
1999
# creation contract must see it as uninitializable
2000
raise errors.UninitializableFormat(self)
2001
mutter('creating branch reference in %s', a_bzrdir.transport.base)
2002
branch_transport = a_bzrdir.get_branch_transport(self)
2003
branch_transport.put_bytes('location',
2004
target_branch.bzrdir.root_transport.base)
2005
branch_transport.put_bytes('format', self.get_format_string())
2007
a_bzrdir, _found=True,
2008
possible_transports=[target_branch.bzrdir.root_transport])
2011
super(BranchReferenceFormat, self).__init__()
2012
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2013
self._matchingbzrdir.set_branch_format(self)
2015
def _make_reference_clone_function(format, a_branch):
2016
"""Create a clone() routine for a branch dynamically."""
2017
def clone(to_bzrdir, revision_id=None,
2018
repository_policy=None):
2019
"""See Branch.clone()."""
2020
return format.initialize(to_bzrdir, a_branch)
2021
# cannot obey revision_id limits when cloning a reference ...
2022
# FIXME RBC 20060210 either nuke revision_id for clone, or
2023
# emit some sort of warning/error to the caller ?!
2026
def open(self, a_bzrdir, _found=False, location=None,
2027
possible_transports=None, ignore_fallbacks=False):
2028
"""Return the branch that the branch reference in a_bzrdir points at.
2030
:param a_bzrdir: A BzrDir that contains a branch.
2031
:param _found: a private parameter, do not use it. It is used to
2032
indicate if format probing has already be done.
2033
:param ignore_fallbacks: when set, no fallback branches will be opened
2034
(if there are any). Default is to open fallbacks.
2035
:param location: The location of the referenced branch. If
2036
unspecified, this will be determined from the branch reference in
2038
:param possible_transports: An optional reusable transports list.
2041
format = BranchFormat.find_format(a_bzrdir)
2042
if format.__class__ != self.__class__:
2043
raise AssertionError("wrong format %r found for %r" %
2045
if location is None:
2046
location = self.get_reference(a_bzrdir)
2047
real_bzrdir = bzrdir.BzrDir.open(
2048
location, possible_transports=possible_transports)
2049
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2050
# this changes the behaviour of result.clone to create a new reference
2051
# rather than a copy of the content of the branch.
2052
# I did not use a proxy object because that needs much more extensive
2053
# testing, and we are only changing one behaviour at the moment.
2054
# If we decide to alter more behaviours - i.e. the implicit nickname
2055
# then this should be refactored to introduce a tested proxy branch
2056
# and a subclass of that for use in overriding clone() and ....
2058
result.clone = self._make_reference_clone_function(result)
2062
network_format_registry = registry.FormatRegistry()
2063
"""Registry of formats indexed by their network name.
2065
The network name for a branch format is an identifier that can be used when
2066
referring to formats with smart server operations. See
2067
BranchFormat.network_name() for more detail.
2071
# formats which have no format string are not discoverable
2072
# and not independently creatable, so are not registered.
2073
__format5 = BzrBranchFormat5()
2074
__format6 = BzrBranchFormat6()
2075
__format7 = BzrBranchFormat7()
2076
__format8 = BzrBranchFormat8()
2077
BranchFormat.register_format(__format5)
2078
BranchFormat.register_format(BranchReferenceFormat())
2079
BranchFormat.register_format(__format6)
2080
BranchFormat.register_format(__format7)
2081
BranchFormat.register_format(__format8)
2082
BranchFormat.set_default_format(__format7)
2083
_legacy_formats = [BzrBranchFormat4(),
2085
network_format_registry.register(
2086
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2089
class BzrBranch(Branch, _RelockDebugMixin):
2090
"""A branch stored in the actual filesystem.
2092
Note that it's "local" in the context of the filesystem; it doesn't
2093
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2094
it's writable, and can be accessed via the normal filesystem API.
2096
:ivar _transport: Transport for file operations on this branch's
2097
control files, typically pointing to the .bzr/branch directory.
2098
:ivar repository: Repository for this branch.
2099
:ivar base: The url of the base directory for this branch; the one
2100
containing the .bzr directory.
2103
def __init__(self, _format=None,
2104
_control_files=None, a_bzrdir=None, _repository=None,
2105
ignore_fallbacks=False):
2106
"""Create new branch object at a particular location."""
2107
if a_bzrdir is None:
2108
raise ValueError('a_bzrdir must be supplied')
2110
self.bzrdir = a_bzrdir
2111
self._base = self.bzrdir.transport.clone('..').base
2112
# XXX: We should be able to just do
2113
# self.base = self.bzrdir.root_transport.base
2114
# but this does not quite work yet -- mbp 20080522
2115
self._format = _format
2116
if _control_files is None:
2117
raise ValueError('BzrBranch _control_files is None')
2118
self.control_files = _control_files
2119
self._transport = _control_files._transport
2120
self.repository = _repository
2121
Branch.__init__(self)
2124
return '%s(%r)' % (self.__class__.__name__, self.base)
2128
def _get_base(self):
2129
"""Returns the directory containing the control directory."""
2132
base = property(_get_base, doc="The URL for the root of this branch.")
2134
def _get_config(self):
2135
return TransportConfig(self._transport, 'branch.conf')
2137
def is_locked(self):
2138
return self.control_files.is_locked()
2140
def lock_write(self, token=None):
2141
if not self.is_locked():
2142
self._note_lock('w')
2143
# All-in-one needs to always unlock/lock.
2144
repo_control = getattr(self.repository, 'control_files', None)
2145
if self.control_files == repo_control or not self.is_locked():
2146
self.repository.lock_write()
2151
return self.control_files.lock_write(token=token)
2154
self.repository.unlock()
2157
def lock_read(self):
2158
if not self.is_locked():
2159
self._note_lock('r')
2160
# All-in-one needs to always unlock/lock.
2161
repo_control = getattr(self.repository, 'control_files', None)
2162
if self.control_files == repo_control or not self.is_locked():
2163
self.repository.lock_read()
2168
self.control_files.lock_read()
2171
self.repository.unlock()
2174
@only_raises(errors.LockNotHeld, errors.LockBroken)
2177
self.control_files.unlock()
2179
# All-in-one needs to always unlock/lock.
2180
repo_control = getattr(self.repository, 'control_files', None)
2181
if (self.control_files == repo_control or
2182
not self.control_files.is_locked()):
2183
self.repository.unlock()
2184
if not self.control_files.is_locked():
2185
# we just released the lock
2186
self._clear_cached_state()
2188
def peek_lock_mode(self):
2189
if self.control_files._lock_count == 0:
2192
return self.control_files._lock_mode
2194
def get_physical_lock_status(self):
2195
return self.control_files.get_physical_lock_status()
2198
def print_file(self, file, revision_id):
2199
"""See Branch.print_file."""
2200
return self.repository.print_file(file, revision_id)
2202
def _write_revision_history(self, history):
2203
"""Factored out of set_revision_history.
2205
This performs the actual writing to disk.
2206
It is intended to be called by BzrBranch5.set_revision_history."""
2207
self._transport.put_bytes(
2208
'revision-history', '\n'.join(history),
2209
mode=self.bzrdir._get_file_mode())
2212
def set_revision_history(self, rev_history):
2213
"""See Branch.set_revision_history."""
2214
if 'evil' in debug.debug_flags:
2215
mutter_callsite(3, "set_revision_history scales with history.")
2216
check_not_reserved_id = _mod_revision.check_not_reserved_id
2217
for rev_id in rev_history:
2218
check_not_reserved_id(rev_id)
2219
if Branch.hooks['post_change_branch_tip']:
2220
# Don't calculate the last_revision_info() if there are no hooks
2222
old_revno, old_revid = self.last_revision_info()
2223
if len(rev_history) == 0:
2224
revid = _mod_revision.NULL_REVISION
2226
revid = rev_history[-1]
2227
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2228
self._write_revision_history(rev_history)
2229
self._clear_cached_state()
2230
self._cache_revision_history(rev_history)
2231
for hook in Branch.hooks['set_rh']:
2232
hook(self, rev_history)
2233
if Branch.hooks['post_change_branch_tip']:
2234
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2236
def _synchronize_history(self, destination, revision_id):
2237
"""Synchronize last revision and revision history between branches.
2239
This version is most efficient when the destination is also a
2240
BzrBranch5, but works for BzrBranch6 as long as the revision
2241
history is the true lefthand parent history, and all of the revisions
2242
are in the destination's repository. If not, set_revision_history
2245
:param destination: The branch to copy the history into
2246
:param revision_id: The revision-id to truncate history at. May
2247
be None to copy complete history.
2249
if not isinstance(destination._format, BzrBranchFormat5):
2250
super(BzrBranch, self)._synchronize_history(
2251
destination, revision_id)
2253
if revision_id == _mod_revision.NULL_REVISION:
2256
new_history = self.revision_history()
2257
if revision_id is not None and new_history != []:
2259
new_history = new_history[:new_history.index(revision_id) + 1]
2261
rev = self.repository.get_revision(revision_id)
2262
new_history = rev.get_history(self.repository)[1:]
2263
destination.set_revision_history(new_history)
2266
def set_last_revision_info(self, revno, revision_id):
2267
"""Set the last revision of this branch.
2269
The caller is responsible for checking that the revno is correct
2270
for this revision id.
2272
It may be possible to set the branch last revision to an id not
2273
present in the repository. However, branches can also be
2274
configured to check constraints on history, in which case this may not
2277
revision_id = _mod_revision.ensure_null(revision_id)
2278
# this old format stores the full history, but this api doesn't
2279
# provide it, so we must generate, and might as well check it's
2281
history = self._lefthand_history(revision_id)
2282
if len(history) != revno:
2283
raise AssertionError('%d != %d' % (len(history), revno))
2284
self.set_revision_history(history)
2286
def _gen_revision_history(self):
2287
history = self._transport.get_bytes('revision-history').split('\n')
2288
if history[-1:] == ['']:
2289
# There shouldn't be a trailing newline, but just in case.
2294
def generate_revision_history(self, revision_id, last_rev=None,
2296
"""Create a new revision history that will finish with revision_id.
2298
:param revision_id: the new tip to use.
2299
:param last_rev: The previous last_revision. If not None, then this
2300
must be a ancestory of revision_id, or DivergedBranches is raised.
2301
:param other_branch: The other branch that DivergedBranches should
2302
raise with respect to.
2304
self.set_revision_history(self._lefthand_history(revision_id,
2305
last_rev, other_branch))
2307
def basis_tree(self):
2308
"""See Branch.basis_tree."""
2309
return self.repository.revision_tree(self.last_revision())
2311
def _get_parent_location(self):
2312
_locs = ['parent', 'pull', 'x-pull']
2315
return self._transport.get_bytes(l).strip('\n')
2316
except errors.NoSuchFile:
2320
def _basic_push(self, target, overwrite, stop_revision):
2321
"""Basic implementation of push without bound branches or hooks.
2323
Must be called with source read locked and target write locked.
2325
result = BranchPushResult()
2326
result.source_branch = self
2327
result.target_branch = target
2328
result.old_revno, result.old_revid = target.last_revision_info()
2329
self.update_references(target)
2330
if result.old_revid != self.last_revision():
2331
# We assume that during 'push' this repository is closer than
2333
graph = self.repository.get_graph(target.repository)
2334
target.update_revisions(self, stop_revision,
2335
overwrite=overwrite, graph=graph)
2336
if self._push_should_merge_tags():
2337
result.tag_conflicts = self.tags.merge_to(target.tags,
2339
result.new_revno, result.new_revid = target.last_revision_info()
2342
def get_stacked_on_url(self):
2343
raise errors.UnstackableBranchFormat(self._format, self.base)
2345
def set_push_location(self, location):
2346
"""See Branch.set_push_location."""
2347
self.get_config().set_user_option(
2348
'push_location', location,
2349
store=_mod_config.STORE_LOCATION_NORECURSE)
2351
def _set_parent_location(self, url):
2353
self._transport.delete('parent')
2355
self._transport.put_bytes('parent', url + '\n',
2356
mode=self.bzrdir._get_file_mode())
2359
class BzrBranch5(BzrBranch):
2360
"""A format 5 branch. This supports new features over plain branches.
2362
It has support for a master_branch which is the data for bound branches.
2365
def get_bound_location(self):
2367
return self._transport.get_bytes('bound')[:-1]
2368
except errors.NoSuchFile:
2372
def get_master_branch(self, possible_transports=None):
2373
"""Return the branch we are bound to.
2375
:return: Either a Branch, or None
2377
This could memoise the branch, but if thats done
2378
it must be revalidated on each new lock.
2379
So for now we just don't memoise it.
2380
# RBC 20060304 review this decision.
2382
bound_loc = self.get_bound_location()
2386
return Branch.open(bound_loc,
2387
possible_transports=possible_transports)
2388
except (errors.NotBranchError, errors.ConnectionError), e:
2389
raise errors.BoundBranchConnectionFailure(
2393
def set_bound_location(self, location):
2394
"""Set the target where this branch is bound to.
2396
:param location: URL to the target branch
2399
self._transport.put_bytes('bound', location+'\n',
2400
mode=self.bzrdir._get_file_mode())
2403
self._transport.delete('bound')
2404
except errors.NoSuchFile:
2409
def bind(self, other):
2410
"""Bind this branch to the branch other.
2412
This does not push or pull data between the branches, though it does
2413
check for divergence to raise an error when the branches are not
2414
either the same, or one a prefix of the other. That behaviour may not
2415
be useful, so that check may be removed in future.
2417
:param other: The branch to bind to
2420
# TODO: jam 20051230 Consider checking if the target is bound
2421
# It is debatable whether you should be able to bind to
2422
# a branch which is itself bound.
2423
# Committing is obviously forbidden,
2424
# but binding itself may not be.
2425
# Since we *have* to check at commit time, we don't
2426
# *need* to check here
2428
# we want to raise diverged if:
2429
# last_rev is not in the other_last_rev history, AND
2430
# other_last_rev is not in our history, and do it without pulling
2432
self.set_bound_location(other.base)
2436
"""If bound, unbind"""
2437
return self.set_bound_location(None)
2440
def update(self, possible_transports=None):
2441
"""Synchronise this branch with the master branch if any.
2443
:return: None or the last_revision that was pivoted out during the
2446
master = self.get_master_branch(possible_transports)
2447
if master is not None:
2448
old_tip = _mod_revision.ensure_null(self.last_revision())
2449
self.pull(master, overwrite=True)
2450
if self.repository.get_graph().is_ancestor(old_tip,
2451
_mod_revision.ensure_null(self.last_revision())):
2457
class BzrBranch8(BzrBranch5):
2458
"""A branch that stores tree-reference locations."""
2460
def _open_hook(self):
2461
if self._ignore_fallbacks:
2464
url = self.get_stacked_on_url()
2465
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2466
errors.UnstackableBranchFormat):
2469
for hook in Branch.hooks['transform_fallback_location']:
2470
url = hook(self, url)
2472
hook_name = Branch.hooks.get_hook_name(hook)
2473
raise AssertionError(
2474
"'transform_fallback_location' hook %s returned "
2475
"None, not a URL." % hook_name)
2476
self._activate_fallback_location(url)
2478
def __init__(self, *args, **kwargs):
2479
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2480
super(BzrBranch8, self).__init__(*args, **kwargs)
2481
self._last_revision_info_cache = None
2482
self._reference_info = None
2484
def _clear_cached_state(self):
2485
super(BzrBranch8, self)._clear_cached_state()
2486
self._last_revision_info_cache = None
2487
self._reference_info = None
2489
def _last_revision_info(self):
2490
revision_string = self._transport.get_bytes('last-revision')
2491
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2492
revision_id = cache_utf8.get_cached_utf8(revision_id)
2494
return revno, revision_id
2496
def _write_last_revision_info(self, revno, revision_id):
2497
"""Simply write out the revision id, with no checks.
2499
Use set_last_revision_info to perform this safely.
2501
Does not update the revision_history cache.
2502
Intended to be called by set_last_revision_info and
2503
_write_revision_history.
2505
revision_id = _mod_revision.ensure_null(revision_id)
2506
out_string = '%d %s\n' % (revno, revision_id)
2507
self._transport.put_bytes('last-revision', out_string,
2508
mode=self.bzrdir._get_file_mode())
2511
def set_last_revision_info(self, revno, revision_id):
2512
revision_id = _mod_revision.ensure_null(revision_id)
2513
old_revno, old_revid = self.last_revision_info()
2514
if self._get_append_revisions_only():
2515
self._check_history_violation(revision_id)
2516
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2517
self._write_last_revision_info(revno, revision_id)
2518
self._clear_cached_state()
2519
self._last_revision_info_cache = revno, revision_id
2520
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2522
def _synchronize_history(self, destination, revision_id):
2523
"""Synchronize last revision and revision history between branches.
2525
:see: Branch._synchronize_history
2527
# XXX: The base Branch has a fast implementation of this method based
2528
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2529
# that uses set_revision_history. This class inherits from BzrBranch5,
2530
# but wants the fast implementation, so it calls
2531
# Branch._synchronize_history directly.
2532
Branch._synchronize_history(self, destination, revision_id)
2534
def _check_history_violation(self, revision_id):
2535
last_revision = _mod_revision.ensure_null(self.last_revision())
2536
if _mod_revision.is_null(last_revision):
2538
if last_revision not in self._lefthand_history(revision_id):
2539
raise errors.AppendRevisionsOnlyViolation(self.base)
2541
def _gen_revision_history(self):
2542
"""Generate the revision history from last revision
2544
last_revno, last_revision = self.last_revision_info()
2545
self._extend_partial_history(stop_index=last_revno-1)
2546
return list(reversed(self._partial_revision_history_cache))
2548
def _write_revision_history(self, history):
2549
"""Factored out of set_revision_history.
2551
This performs the actual writing to disk, with format-specific checks.
2552
It is intended to be called by BzrBranch5.set_revision_history.
2554
if len(history) == 0:
2555
last_revision = 'null:'
2557
if history != self._lefthand_history(history[-1]):
2558
raise errors.NotLefthandHistory(history)
2559
last_revision = history[-1]
2560
if self._get_append_revisions_only():
2561
self._check_history_violation(last_revision)
2562
self._write_last_revision_info(len(history), last_revision)
2565
def _set_parent_location(self, url):
2566
"""Set the parent branch"""
2567
self._set_config_location('parent_location', url, make_relative=True)
2570
def _get_parent_location(self):
2571
"""Set the parent branch"""
2572
return self._get_config_location('parent_location')
2575
def _set_all_reference_info(self, info_dict):
2576
"""Replace all reference info stored in a branch.
2578
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2581
writer = rio.RioWriter(s)
2582
for key, (tree_path, branch_location) in info_dict.iteritems():
2583
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2584
branch_location=branch_location)
2585
writer.write_stanza(stanza)
2586
self._transport.put_bytes('references', s.getvalue())
2587
self._reference_info = info_dict
2590
def _get_all_reference_info(self):
2591
"""Return all the reference info stored in a branch.
2593
:return: A dict of {file_id: (tree_path, branch_location)}
2595
if self._reference_info is not None:
2596
return self._reference_info
2597
rio_file = self._transport.get('references')
2599
stanzas = rio.read_stanzas(rio_file)
2600
info_dict = dict((s['file_id'], (s['tree_path'],
2601
s['branch_location'])) for s in stanzas)
2604
self._reference_info = info_dict
2607
def set_reference_info(self, file_id, tree_path, branch_location):
2608
"""Set the branch location to use for a tree reference.
2610
:param file_id: The file-id of the tree reference.
2611
:param tree_path: The path of the tree reference in the tree.
2612
:param branch_location: The location of the branch to retrieve tree
2615
info_dict = self._get_all_reference_info()
2616
info_dict[file_id] = (tree_path, branch_location)
2617
if None in (tree_path, branch_location):
2618
if tree_path is not None:
2619
raise ValueError('tree_path must be None when branch_location'
2621
if branch_location is not None:
2622
raise ValueError('branch_location must be None when tree_path'
2624
del info_dict[file_id]
2625
self._set_all_reference_info(info_dict)
2627
def get_reference_info(self, file_id):
2628
"""Get the tree_path and branch_location for a tree reference.
2630
:return: a tuple of (tree_path, branch_location)
2632
return self._get_all_reference_info().get(file_id, (None, None))
2634
def reference_parent(self, file_id, path, possible_transports=None):
2635
"""Return the parent branch for a tree-reference file_id.
2637
:param file_id: The file_id of the tree reference
2638
:param path: The path of the file_id in the tree
2639
:return: A branch associated with the file_id
2641
branch_location = self.get_reference_info(file_id)[1]
2642
if branch_location is None:
2643
return Branch.reference_parent(self, file_id, path,
2644
possible_transports)
2645
branch_location = urlutils.join(self.base, branch_location)
2646
return Branch.open(branch_location,
2647
possible_transports=possible_transports)
2649
def set_push_location(self, location):
2650
"""See Branch.set_push_location."""
2651
self._set_config_location('push_location', location)
2653
def set_bound_location(self, location):
2654
"""See Branch.set_push_location."""
2656
config = self.get_config()
2657
if location is None:
2658
if config.get_user_option('bound') != 'True':
2661
config.set_user_option('bound', 'False', warn_masked=True)
2664
self._set_config_location('bound_location', location,
2666
config.set_user_option('bound', 'True', warn_masked=True)
2669
def _get_bound_location(self, bound):
2670
"""Return the bound location in the config file.
2672
Return None if the bound parameter does not match"""
2673
config = self.get_config()
2674
config_bound = (config.get_user_option('bound') == 'True')
2675
if config_bound != bound:
2677
return self._get_config_location('bound_location', config=config)
2679
def get_bound_location(self):
2680
"""See Branch.set_push_location."""
2681
return self._get_bound_location(True)
2683
def get_old_bound_location(self):
2684
"""See Branch.get_old_bound_location"""
2685
return self._get_bound_location(False)
2687
def get_stacked_on_url(self):
2688
# you can always ask for the URL; but you might not be able to use it
2689
# if the repo can't support stacking.
2690
## self._check_stackable_repo()
2691
stacked_url = self._get_config_location('stacked_on_location')
2692
if stacked_url is None:
2693
raise errors.NotStacked(self)
2696
def _get_append_revisions_only(self):
2697
value = self.get_config().get_user_option('append_revisions_only')
2698
return value == 'True'
2701
def generate_revision_history(self, revision_id, last_rev=None,
2703
"""See BzrBranch5.generate_revision_history"""
2704
history = self._lefthand_history(revision_id, last_rev, other_branch)
2705
revno = len(history)
2706
self.set_last_revision_info(revno, revision_id)
2709
def get_rev_id(self, revno, history=None):
2710
"""Find the revision id of the specified revno."""
2712
return _mod_revision.NULL_REVISION
2714
last_revno, last_revision_id = self.last_revision_info()
2715
if revno <= 0 or revno > last_revno:
2716
raise errors.NoSuchRevision(self, revno)
2718
if history is not None:
2719
return history[revno - 1]
2721
index = last_revno - revno
2722
if len(self._partial_revision_history_cache) <= index:
2723
self._extend_partial_history(stop_index=index)
2724
if len(self._partial_revision_history_cache) > index:
2725
return self._partial_revision_history_cache[index]
2727
raise errors.NoSuchRevision(self, revno)
2730
def revision_id_to_revno(self, revision_id):
2731
"""Given a revision id, return its revno"""
2732
if _mod_revision.is_null(revision_id):
2735
index = self._partial_revision_history_cache.index(revision_id)
2737
self._extend_partial_history(stop_revision=revision_id)
2738
index = len(self._partial_revision_history_cache) - 1
2739
if self._partial_revision_history_cache[index] != revision_id:
2740
raise errors.NoSuchRevision(self, revision_id)
2741
return self.revno() - index
2744
class BzrBranch7(BzrBranch8):
2745
"""A branch with support for a fallback repository."""
2747
def set_reference_info(self, file_id, tree_path, branch_location):
2748
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2750
def get_reference_info(self, file_id):
2751
Branch.get_reference_info(self, file_id)
2753
def reference_parent(self, file_id, path, possible_transports=None):
2754
return Branch.reference_parent(self, file_id, path,
2755
possible_transports)
2758
class BzrBranch6(BzrBranch7):
2759
"""See BzrBranchFormat6 for the capabilities of this branch.
2761
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2765
def get_stacked_on_url(self):
2766
raise errors.UnstackableBranchFormat(self._format, self.base)
1403
2769
######################################################################
1407
def is_control_file(filename):
1408
## FIXME: better check
1409
filename = os.path.normpath(filename)
1410
while filename != '':
1411
head, tail = os.path.split(filename)
1412
## mutter('check %r for control file' % ((head, tail), ))
1413
if tail == bzrlib.BZRDIR:
1415
if filename == head:
1422
def gen_file_id(name):
1423
"""Return new file id.
1425
This should probably generate proper UUIDs, but for the moment we
1426
cope with just randomness because running uuidgen every time is
1429
from binascii import hexlify
1430
from time import time
1432
# get last component
1433
idx = name.rfind('/')
1435
name = name[idx+1 : ]
1436
idx = name.rfind('\\')
1438
name = name[idx+1 : ]
1440
# make it not a hidden file
1441
name = name.lstrip('.')
1443
# remove any wierd characters; we don't escape them but rather
1444
# just pull them out
1445
name = re.sub(r'[^\w.]', '', name)
1447
s = hexlify(rand_bytes(8))
1448
return '-'.join((name, compact_date(time()), s))
1452
"""Return a new tree-root file id."""
1453
return gen_file_id('TREE_ROOT')
1456
def pull_loc(branch):
1457
# TODO: Should perhaps just make attribute be 'base' in
1458
# RemoteBranch and Branch?
1459
if hasattr(branch, "baseurl"):
1460
return branch.baseurl
1465
def copy_branch(branch_from, to_location, revision=None):
1466
"""Copy branch_from into the existing directory to_location.
1469
If not None, only revisions up to this point will be copied.
1470
The head of the new branch will be that revision.
1473
The name of a local directory that exists but is empty.
1475
from bzrlib.merge import merge
1476
from bzrlib.branch import Branch
1478
assert isinstance(branch_from, Branch)
1479
assert isinstance(to_location, basestring)
1481
br_to = Branch(to_location, init=True)
1482
br_to.set_root_id(branch_from.get_root_id())
1483
if revision is None:
1484
revno = branch_from.revno()
1486
revno, rev_id = branch_from.get_revision_info(revision)
1487
br_to.update_revisions(branch_from, stop_revision=revno)
1488
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1489
check_clean=False, ignore_zero=True)
1491
from_location = pull_loc(branch_from)
1492
br_to.set_parent(pull_loc(branch_from))
2770
# results of operations
2773
class _Result(object):
2775
def _show_tag_conficts(self, to_file):
2776
if not getattr(self, 'tag_conflicts', None):
2778
to_file.write('Conflicting tags:\n')
2779
for name, value1, value2 in self.tag_conflicts:
2780
to_file.write(' %s\n' % (name, ))
2783
class PullResult(_Result):
2784
"""Result of a Branch.pull operation.
2786
:ivar old_revno: Revision number before pull.
2787
:ivar new_revno: Revision number after pull.
2788
:ivar old_revid: Tip revision id before pull.
2789
:ivar new_revid: Tip revision id after pull.
2790
:ivar source_branch: Source (local) branch object. (read locked)
2791
:ivar master_branch: Master branch of the target, or the target if no
2793
:ivar local_branch: target branch if there is a Master, else None
2794
:ivar target_branch: Target/destination branch object. (write locked)
2795
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2799
# DEPRECATED: pull used to return the change in revno
2800
return self.new_revno - self.old_revno
2802
def report(self, to_file):
2804
if self.old_revid == self.new_revid:
2805
to_file.write('No revisions to pull.\n')
2807
to_file.write('Now on revision %d.\n' % self.new_revno)
2808
self._show_tag_conficts(to_file)
2811
class BranchPushResult(_Result):
2812
"""Result of a Branch.push operation.
2814
:ivar old_revno: Revision number (eg 10) of the target before push.
2815
:ivar new_revno: Revision number (eg 12) of the target after push.
2816
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2818
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2820
:ivar source_branch: Source branch object that the push was from. This is
2821
read locked, and generally is a local (and thus low latency) branch.
2822
:ivar master_branch: If target is a bound branch, the master branch of
2823
target, or target itself. Always write locked.
2824
:ivar target_branch: The direct Branch where data is being sent (write
2826
:ivar local_branch: If the target is a bound branch this will be the
2827
target, otherwise it will be None.
2831
# DEPRECATED: push used to return the change in revno
2832
return self.new_revno - self.old_revno
2834
def report(self, to_file):
2835
"""Write a human-readable description of the result."""
2836
if self.old_revid == self.new_revid:
2837
note('No new revisions to push.')
2839
note('Pushed up to revision %d.' % self.new_revno)
2840
self._show_tag_conficts(to_file)
2843
class BranchCheckResult(object):
2844
"""Results of checking branch consistency.
2849
def __init__(self, branch):
2850
self.branch = branch
2853
def report_results(self, verbose):
2854
"""Report the check results via trace.note.
2856
:param verbose: Requests more detailed display of what was checked,
2859
note('checked branch %s format %s', self.branch.base,
2860
self.branch._format)
2861
for error in self.errors:
2862
note('found error:%s', error)
2865
class Converter5to6(object):
2866
"""Perform an in-place upgrade of format 5 to format 6"""
2868
def convert(self, branch):
2869
# Data for 5 and 6 can peacefully coexist.
2870
format = BzrBranchFormat6()
2871
new_branch = format.open(branch.bzrdir, _found=True)
2873
# Copy source data into target
2874
new_branch._write_last_revision_info(*branch.last_revision_info())
2875
new_branch.set_parent(branch.get_parent())
2876
new_branch.set_bound_location(branch.get_bound_location())
2877
new_branch.set_push_location(branch.get_push_location())
2879
# New branch has no tags by default
2880
new_branch.tags._set_tag_dict({})
2882
# Copying done; now update target format
2883
new_branch._transport.put_bytes('format',
2884
format.get_format_string(),
2885
mode=new_branch.bzrdir._get_file_mode())
2887
# Clean up old files
2888
new_branch._transport.delete('revision-history')
2890
branch.set_parent(None)
2891
except errors.NoSuchFile:
2893
branch.set_bound_location(None)
2896
class Converter6to7(object):
2897
"""Perform an in-place upgrade of format 6 to format 7"""
2899
def convert(self, branch):
2900
format = BzrBranchFormat7()
2901
branch._set_config_location('stacked_on_location', '')
2902
# update target format
2903
branch._transport.put_bytes('format', format.get_format_string())
2906
class Converter7to8(object):
2907
"""Perform an in-place upgrade of format 6 to format 7"""
2909
def convert(self, branch):
2910
format = BzrBranchFormat8()
2911
branch._transport.put_bytes('references', '')
2912
# update target format
2913
branch._transport.put_bytes('format', format.get_format_string())
2916
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2917
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2920
_run_with_write_locked_target will attempt to release the lock it acquires.
2922
If an exception is raised by callable, then that exception *will* be
2923
propagated, even if the unlock attempt raises its own error. Thus
2924
_run_with_write_locked_target should be preferred to simply doing::
2928
return callable(*args, **kwargs)
2933
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2934
# should share code?
2937
result = callable(*args, **kwargs)
2939
exc_info = sys.exc_info()
2943
raise exc_info[0], exc_info[1], exc_info[2]
2949
class InterBranch(InterObject):
2950
"""This class represents operations taking place between two branches.
2952
Its instances have methods like pull() and push() and contain
2953
references to the source and target repositories these operations
2954
can be carried out on.
2958
"""The available optimised InterBranch types."""
2961
def _get_branch_formats_to_test():
2962
"""Return a tuple with the Branch formats to use when testing."""
2963
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
2965
def pull(self, overwrite=False, stop_revision=None,
2966
possible_transports=None, local=False):
2967
"""Mirror source into target branch.
2969
The target branch is considered to be 'local', having low latency.
2971
:returns: PullResult instance
2973
raise NotImplementedError(self.pull)
2975
def update_revisions(self, stop_revision=None, overwrite=False,
2977
"""Pull in new perfect-fit revisions.
2979
:param stop_revision: Updated until the given revision
2980
:param overwrite: Always set the branch pointer, rather than checking
2981
to see if it is a proper descendant.
2982
:param graph: A Graph object that can be used to query history
2983
information. This can be None.
2986
raise NotImplementedError(self.update_revisions)
2988
def push(self, overwrite=False, stop_revision=None,
2989
_override_hook_source_branch=None):
2990
"""Mirror the source branch into the target branch.
2992
The source branch is considered to be 'local', having low latency.
2994
raise NotImplementedError(self.push)
2997
class GenericInterBranch(InterBranch):
2998
"""InterBranch implementation that uses public Branch functions.
3002
def _get_branch_formats_to_test():
3003
return BranchFormat._default_format, BranchFormat._default_format
3005
def update_revisions(self, stop_revision=None, overwrite=False,
3007
"""See InterBranch.update_revisions()."""
3008
self.source.lock_read()
3010
other_revno, other_last_revision = self.source.last_revision_info()
3011
stop_revno = None # unknown
3012
if stop_revision is None:
3013
stop_revision = other_last_revision
3014
if _mod_revision.is_null(stop_revision):
3015
# if there are no commits, we're done.
3017
stop_revno = other_revno
3019
# what's the current last revision, before we fetch [and change it
3021
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3022
# we fetch here so that we don't process data twice in the common
3023
# case of having something to pull, and so that the check for
3024
# already merged can operate on the just fetched graph, which will
3025
# be cached in memory.
3026
self.target.fetch(self.source, stop_revision)
3027
# Check to see if one is an ancestor of the other
3030
graph = self.target.repository.get_graph()
3031
if self.target._check_if_descendant_or_diverged(
3032
stop_revision, last_rev, graph, self.source):
3033
# stop_revision is a descendant of last_rev, but we aren't
3034
# overwriting, so we're done.
3036
if stop_revno is None:
3038
graph = self.target.repository.get_graph()
3039
this_revno, this_last_revision = \
3040
self.target.last_revision_info()
3041
stop_revno = graph.find_distance_to_null(stop_revision,
3042
[(other_last_revision, other_revno),
3043
(this_last_revision, this_revno)])
3044
self.target.set_last_revision_info(stop_revno, stop_revision)
3046
self.source.unlock()
3048
def pull(self, overwrite=False, stop_revision=None,
3049
possible_transports=None, _hook_master=None, run_hooks=True,
3050
_override_hook_target=None, local=False):
3053
:param _hook_master: Private parameter - set the branch to
3054
be supplied as the master to pull hooks.
3055
:param run_hooks: Private parameter - if false, this branch
3056
is being called because it's the master of the primary branch,
3057
so it should not run its hooks.
3058
:param _override_hook_target: Private parameter - set the branch to be
3059
supplied as the target_branch to pull hooks.
3060
:param local: Only update the local branch, and not the bound branch.
3062
# This type of branch can't be bound.
3064
raise errors.LocalRequiresBoundBranch()
3065
result = PullResult()
3066
result.source_branch = self.source
3067
if _override_hook_target is None:
3068
result.target_branch = self.target
3070
result.target_branch = _override_hook_target
3071
self.source.lock_read()
3073
# We assume that during 'pull' the target repository is closer than
3075
self.source.update_references(self.target)
3076
graph = self.target.repository.get_graph(self.source.repository)
3077
# TODO: Branch formats should have a flag that indicates
3078
# that revno's are expensive, and pull() should honor that flag.
3080
result.old_revno, result.old_revid = \
3081
self.target.last_revision_info()
3082
self.target.update_revisions(self.source, stop_revision,
3083
overwrite=overwrite, graph=graph)
3084
# TODO: The old revid should be specified when merging tags,
3085
# so a tags implementation that versions tags can only
3086
# pull in the most recent changes. -- JRV20090506
3087
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3089
result.new_revno, result.new_revid = self.target.last_revision_info()
3091
result.master_branch = _hook_master
3092
result.local_branch = result.target_branch
3094
result.master_branch = result.target_branch
3095
result.local_branch = None
3097
for hook in Branch.hooks['post_pull']:
3100
self.source.unlock()
3103
def push(self, overwrite=False, stop_revision=None,
3104
_override_hook_source_branch=None):
3105
"""See InterBranch.push.
3107
This is the basic concrete implementation of push()
3109
:param _override_hook_source_branch: If specified, run
3110
the hooks passing this Branch as the source, rather than self.
3111
This is for use of RemoteBranch, where push is delegated to the
3112
underlying vfs-based Branch.
3114
# TODO: Public option to disable running hooks - should be trivial but
3116
self.source.lock_read()
3118
return _run_with_write_locked_target(
3119
self.target, self._push_with_bound_branches, overwrite,
3121
_override_hook_source_branch=_override_hook_source_branch)
3123
self.source.unlock()
3125
def _push_with_bound_branches(self, overwrite, stop_revision,
3126
_override_hook_source_branch=None):
3127
"""Push from source into target, and into target's master if any.
3130
if _override_hook_source_branch:
3131
result.source_branch = _override_hook_source_branch
3132
for hook in Branch.hooks['post_push']:
3135
bound_location = self.target.get_bound_location()
3136
if bound_location and self.target.base != bound_location:
3137
# there is a master branch.
3139
# XXX: Why the second check? Is it even supported for a branch to
3140
# be bound to itself? -- mbp 20070507
3141
master_branch = self.target.get_master_branch()
3142
master_branch.lock_write()
3144
# push into the master from the source branch.
3145
self.source._basic_push(master_branch, overwrite, stop_revision)
3146
# and push into the target branch from the source. Note that we
3147
# push from the source branch again, because its considered the
3148
# highest bandwidth repository.
3149
result = self.source._basic_push(self.target, overwrite,
3151
result.master_branch = master_branch
3152
result.local_branch = self.target
3156
master_branch.unlock()
3159
result = self.source._basic_push(self.target, overwrite,
3161
# TODO: Why set master_branch and local_branch if there's no
3162
# binding? Maybe cleaner to just leave them unset? -- mbp
3164
result.master_branch = self.target
3165
result.local_branch = None
3170
def is_compatible(self, source, target):
3171
# GenericBranch uses the public API, so always compatible
3175
class InterToBranch5(GenericInterBranch):
3178
def _get_branch_formats_to_test():
3179
return BranchFormat._default_format, BzrBranchFormat5()
3181
def pull(self, overwrite=False, stop_revision=None,
3182
possible_transports=None, run_hooks=True,
3183
_override_hook_target=None, local=False):
3184
"""Pull from source into self, updating my master if any.
3186
:param run_hooks: Private parameter - if false, this branch
3187
is being called because it's the master of the primary branch,
3188
so it should not run its hooks.
3190
bound_location = self.target.get_bound_location()
3191
if local and not bound_location:
3192
raise errors.LocalRequiresBoundBranch()
3193
master_branch = None
3194
if not local and bound_location and self.source.base != bound_location:
3195
# not pulling from master, so we need to update master.
3196
master_branch = self.target.get_master_branch(possible_transports)
3197
master_branch.lock_write()
3200
# pull from source into master.
3201
master_branch.pull(self.source, overwrite, stop_revision,
3203
return super(InterToBranch5, self).pull(overwrite,
3204
stop_revision, _hook_master=master_branch,
3205
run_hooks=run_hooks,
3206
_override_hook_target=_override_hook_target)
3209
master_branch.unlock()
3212
InterBranch.register_optimiser(GenericInterBranch)
3213
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
