137
79
"""Branch holding a history of revisions.
140
Base directory of the branch.
146
If _lock_mode is true, a positive count of the number of times the
150
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
157
# Map some sort of prefix into a namespace
158
# stuff like "revno:10", "revid:", etc.
159
# This should match a prefix with a function which accepts
160
REVISION_NAMESPACES = {}
162
def __init__(self, base, init=False, find_root=True):
163
"""Create new branch object at a particular location.
165
base -- Base directory for the branch.
167
init -- If True, create new control files in a previously
168
unversioned directory. If False, the branch must already
171
find_root -- If true and init is false, find the root of the
172
existing branch containing base.
174
In the test suite, creation of new trees is tested using the
175
`ScratchBranch` class.
177
from bzrlib.store import ImmutableStore
179
self.base = os.path.realpath(base)
182
self.base = find_branch_root(base)
184
self.base = os.path.realpath(base)
185
if not isdir(self.controlfilename('.')):
186
from errors import NotBranchError
187
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
188
['use "bzr init" to initialize a new working tree',
189
'current bzr can only operate from top-of-tree'])
192
self.text_store = ImmutableStore(self.controlfilename('text-store'))
193
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
194
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
198
return '%s(%r)' % (self.__class__.__name__, self.base)
205
if self._lock_mode or self._lock:
206
from warnings import warn
207
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=_unsupported)
173
def open_from_transport(transport, name=None, _unsupported=False):
174
"""Open the branch rooted at transport"""
175
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
176
return control.open_branch(name=name, unsupported=_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_branch = Branch.open(url,
221
possible_transports=[self.bzrdir.root_transport])
222
return a_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()
212
289
def lock_write(self):
214
if self._lock_mode != 'w':
215
from errors import LockError
216
raise LockError("can't upgrade to a write lock from %r" %
218
self._lock_count += 1
220
from bzrlib.lock import WriteLock
222
self._lock = WriteLock(self.controlfilename('branch-lock'))
223
self._lock_mode = 'w'
290
raise NotImplementedError(self.lock_write)
228
292
def lock_read(self):
230
assert self._lock_mode in ('r', 'w'), \
231
"invalid lock mode %r" % self._lock_mode
232
self._lock_count += 1
234
from bzrlib.lock import ReadLock
236
self._lock = ReadLock(self.controlfilename('branch-lock'))
237
self._lock_mode = 'r'
293
raise NotImplementedError(self.lock_read)
242
295
def unlock(self):
243
if not self._lock_mode:
244
from errors import LockError
245
raise LockError('branch %r is not locked' % (self))
247
if self._lock_count > 1:
248
self._lock_count -= 1
252
self._lock_mode = self._lock_count = None
255
def abspath(self, name):
256
"""Return absolute filename for something in the branch"""
257
return os.path.join(self.base, name)
260
def relpath(self, path):
261
"""Return path relative to this branch of something inside it.
263
Raises an error if path is not in this branch."""
264
return _relpath(self.base, path)
267
def controlfilename(self, file_or_path):
268
"""Return location relative to branch."""
269
if isinstance(file_or_path, basestring):
270
file_or_path = [file_or_path]
271
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
274
def controlfile(self, file_or_path, mode='r'):
275
"""Open a control file for this branch.
277
There are two classes of file in the control directory: text
278
and binary. binary files are untranslated byte streams. Text
279
control files are stored with Unix newlines and in UTF-8, even
280
if the platform or locale defaults are different.
282
Controlfiles should almost never be opened in write mode but
283
rather should be atomically copied and replaced using atomicfile.
286
fn = self.controlfilename(file_or_path)
288
if mode == 'rb' or mode == 'wb':
289
return file(fn, mode)
290
elif mode == 'r' or mode == 'w':
291
# open in binary mode anyhow so there's no newline translation;
292
# codecs uses line buffering by default; don't want that.
294
return codecs.open(fn, mode + 'b', 'utf-8',
297
raise BzrError("invalid controlfile mode %r" % mode)
301
def _make_control(self):
302
from bzrlib.inventory import Inventory
303
from bzrlib.xml import pack_xml
305
os.mkdir(self.controlfilename([]))
306
self.controlfile('README', 'w').write(
307
"This is a Bazaar-NG control directory.\n"
308
"Do not change any files in this directory.\n")
309
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
310
for d in ('text-store', 'inventory-store', 'revision-store'):
311
os.mkdir(self.controlfilename(d))
312
for f in ('revision-history', 'merged-patches',
313
'pending-merged-patches', 'branch-name',
316
self.controlfile(f, 'w').write('')
317
mutter('created control directory in ' + self.base)
319
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
322
def _check_format(self):
323
"""Check this branch format is supported.
325
The current tool only supports the current unstable format.
327
In the future, we might need different in-memory Branch
328
classes to support downlevel branches. But not yet.
330
# This ignores newlines so that we can open branches created
331
# on Windows from Linux and so on. I think it might be better
332
# to always make all internal files in unix format.
333
fmt = self.controlfile('branch-format', 'r').read()
334
fmt.replace('\r\n', '')
335
if fmt != BZR_BRANCH_FORMAT:
336
raise BzrError('sorry, branch format %r not supported' % fmt,
337
['use a different bzr version',
338
'or remove the .bzr directory and "bzr init" again'])
340
def get_root_id(self):
341
"""Return the id of this branches root"""
342
inv = self.read_working_inventory()
343
return inv.root.file_id
345
def set_root_id(self, file_id):
346
inv = self.read_working_inventory()
347
orig_root_id = inv.root.file_id
348
del inv._byid[inv.root.file_id]
349
inv.root.file_id = file_id
350
inv._byid[inv.root.file_id] = inv.root
353
if entry.parent_id in (None, orig_root_id):
354
entry.parent_id = inv.root.file_id
355
self._write_inventory(inv)
357
def read_working_inventory(self):
358
"""Read the working inventory."""
359
from bzrlib.inventory import Inventory
360
from bzrlib.xml import unpack_xml
361
from time import time
365
# ElementTree does its own conversion from UTF-8, so open in
367
inv = unpack_xml(Inventory,
368
self.controlfile('inventory', 'rb'))
369
mutter("loaded inventory of %d items in %f"
370
% (len(inv), time() - before))
376
def _write_inventory(self, inv):
377
"""Update the working inventory.
379
That is to say, the inventory describing changes underway, that
380
will be committed to the next revision.
382
from bzrlib.atomicfile import AtomicFile
383
from bzrlib.xml import pack_xml
387
f = AtomicFile(self.controlfilename('inventory'), 'wb')
396
mutter('wrote working inventory')
399
inventory = property(read_working_inventory, _write_inventory, None,
400
"""Inventory for the working copy.""")
403
def add(self, files, verbose=False, ids=None):
404
"""Make files versioned.
406
Note that the command line normally calls smart_add instead.
408
This puts the files in the Added state, so that they will be
409
recorded by the next commit.
412
List of paths to add, relative to the base of the tree.
415
If set, use these instead of automatically generated ids.
416
Must be the same length as the list of files, but may
417
contain None for ids that are to be autogenerated.
419
TODO: Perhaps have an option to add the ids even if the files do
422
TODO: Perhaps return the ids of the files? But then again it
423
is easy to retrieve them if they're needed.
425
TODO: Adding a directory should optionally recurse down and
426
add all non-ignored children. Perhaps do that in a
429
# TODO: Re-adding a file that is removed in the working copy
430
# should probably put it back with the previous ID.
431
if isinstance(files, basestring):
432
assert(ids is None or isinstance(ids, basestring))
438
ids = [None] * len(files)
440
assert(len(ids) == len(files))
444
inv = self.read_working_inventory()
445
for f,file_id in zip(files, ids):
446
if is_control_file(f):
447
raise BzrError("cannot add control file %s" % quotefn(f))
452
raise BzrError("cannot add top-level %r" % f)
454
fullpath = os.path.normpath(self.abspath(f))
457
kind = file_kind(fullpath)
459
# maybe something better?
460
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
462
if kind != 'file' and kind != 'directory':
463
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
466
file_id = gen_file_id(f)
467
inv.add_path(f, kind=kind, file_id=file_id)
470
print 'added', quotefn(f)
472
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
474
self._write_inventory(inv)
479
def print_file(self, file, revno):
480
"""Print `file` to stdout."""
483
tree = self.revision_tree(self.lookup_revision(revno))
484
# use inventory as it was in that revision
485
file_id = tree.inventory.path2id(file)
487
raise BzrError("%r is not present in revision %s" % (file, revno))
488
tree.print_file(file_id)
493
def remove(self, files, verbose=False):
494
"""Mark nominated files for removal from the inventory.
496
This does not remove their text. This does not run on
498
TODO: Refuse to remove modified files unless --force is given?
500
TODO: Do something useful with directories.
502
TODO: Should this remove the text or not? Tough call; not
503
removing may be useful and the user can just use use rm, and
504
is the opposite of add. Removing it is consistent with most
505
other tools. Maybe an option.
507
## TODO: Normalize names
508
## TODO: Remove nested loops; better scalability
509
if isinstance(files, basestring):
515
tree = self.working_tree()
518
# do this before any modifications
522
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
523
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
525
# having remove it, it must be either ignored or unknown
526
if tree.is_ignored(f):
530
show_status(new_status, inv[fid].kind, quotefn(f))
533
self._write_inventory(inv)
538
# FIXME: this doesn't need to be a branch method
539
def set_inventory(self, new_inventory_list):
540
from bzrlib.inventory import Inventory, InventoryEntry
541
inv = Inventory(self.get_root_id())
542
for path, file_id, parent, kind in new_inventory_list:
543
name = os.path.basename(path)
546
inv.add(InventoryEntry(file_id, name, kind, parent))
547
self._write_inventory(inv)
551
"""Return all unknown files.
553
These are files in the working directory that are not versioned or
554
control files or ignored.
556
>>> b = ScratchBranch(files=['foo', 'foo~'])
557
>>> list(b.unknowns())
560
>>> list(b.unknowns())
563
>>> list(b.unknowns())
566
return self.working_tree().unknowns()
569
def append_revision(self, *revision_ids):
570
from bzrlib.atomicfile import AtomicFile
572
for revision_id in revision_ids:
573
mutter("add {%s} to revision-history" % revision_id)
575
rev_history = self.revision_history()
576
rev_history.extend(revision_ids)
578
f = AtomicFile(self.controlfilename('revision-history'))
580
for rev_id in rev_history:
587
def get_revision_xml(self, revision_id):
588
"""Return XML file object for revision object."""
589
if not revision_id or not isinstance(revision_id, basestring):
590
raise InvalidRevisionId(revision_id)
595
return self.revision_store[revision_id]
597
raise bzrlib.errors.NoSuchRevision(revision_id)
602
def get_revision(self, revision_id):
603
"""Return the Revision object for a named revision"""
604
xml_file = self.get_revision_xml(revision_id)
607
r = unpack_xml(Revision, xml_file)
608
except SyntaxError, e:
609
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
613
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
known_graph = self.repository.get_known_graph_ancestry(
452
self._merge_sorted_revisions_cache = known_graph.merge_sort(
454
filtered = self._filter_merge_sorted_revisions(
455
self._merge_sorted_revisions_cache, start_revision_id,
456
stop_revision_id, stop_rule)
457
# Make sure we don't return revisions that are not part of the
458
# start_revision_id ancestry.
459
filtered = self._filter_non_ancestors(filtered)
460
if direction == 'reverse':
462
if direction == 'forward':
463
return reversed(list(filtered))
465
raise ValueError('invalid direction %r' % direction)
467
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
468
start_revision_id, stop_revision_id, stop_rule):
469
"""Iterate over an inclusive range of sorted revisions."""
470
rev_iter = iter(merge_sorted_revisions)
471
if start_revision_id is not None:
472
for node in rev_iter:
473
rev_id = node.key[-1]
474
if rev_id != start_revision_id:
477
# The decision to include the start or not
478
# depends on the stop_rule if a stop is provided
479
# so pop this node back into the iterator
480
rev_iter = chain(iter([node]), rev_iter)
482
if stop_revision_id is None:
484
for node in rev_iter:
485
rev_id = node.key[-1]
486
yield (rev_id, node.merge_depth, node.revno,
488
elif stop_rule == 'exclude':
489
for node in rev_iter:
490
rev_id = node.key[-1]
491
if rev_id == stop_revision_id:
493
yield (rev_id, node.merge_depth, node.revno,
495
elif stop_rule == 'include':
496
for node in rev_iter:
497
rev_id = node.key[-1]
498
yield (rev_id, node.merge_depth, node.revno,
500
if rev_id == stop_revision_id:
502
elif stop_rule == 'with-merges':
503
stop_rev = self.repository.get_revision(stop_revision_id)
504
if stop_rev.parent_ids:
505
left_parent = stop_rev.parent_ids[0]
507
left_parent = _mod_revision.NULL_REVISION
508
# left_parent is the actual revision we want to stop logging at,
509
# since we want to show the merged revisions after the stop_rev too
510
reached_stop_revision_id = False
511
revision_id_whitelist = []
512
for node in rev_iter:
513
rev_id = node.key[-1]
514
if rev_id == left_parent:
515
# reached the left parent after the stop_revision
517
if (not reached_stop_revision_id or
518
rev_id in revision_id_whitelist):
519
yield (rev_id, node.merge_depth, node.revno,
521
if reached_stop_revision_id or rev_id == stop_revision_id:
522
# only do the merged revs of rev_id from now on
523
rev = self.repository.get_revision(rev_id)
525
reached_stop_revision_id = True
526
revision_id_whitelist.extend(rev.parent_ids)
528
raise ValueError('invalid stop_rule %r' % stop_rule)
530
def _filter_non_ancestors(self, rev_iter):
531
# If we started from a dotted revno, we want to consider it as a tip
532
# and don't want to yield revisions that are not part of its
533
# ancestry. Given the order guaranteed by the merge sort, we will see
534
# uninteresting descendants of the first parent of our tip before the
536
first = rev_iter.next()
537
(rev_id, merge_depth, revno, end_of_merge) = first
540
# We start at a mainline revision so by definition, all others
541
# revisions in rev_iter are ancestors
542
for node in rev_iter:
547
pmap = self.repository.get_parent_map([rev_id])
548
parents = pmap.get(rev_id, [])
550
whitelist.update(parents)
552
# If there is no parents, there is nothing of interest left
554
# FIXME: It's hard to test this scenario here as this code is never
555
# called in that case. -- vila 20100322
558
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
560
if rev_id in whitelist:
561
pmap = self.repository.get_parent_map([rev_id])
562
parents = pmap.get(rev_id, [])
563
whitelist.remove(rev_id)
564
whitelist.update(parents)
566
# We've reached the mainline, there is nothing left to
570
# A revision that is not part of the ancestry of our
573
yield (rev_id, merge_depth, revno, end_of_merge)
575
def leave_lock_in_place(self):
576
"""Tell this branch object not to release the physical lock when this
579
If lock_write doesn't return a token, then this method is not supported.
581
self.control_files.leave_in_place()
583
def dont_leave_lock_in_place(self):
584
"""Tell this branch object to release the physical lock when this
585
object is unlocked, even if it didn't originally acquire it.
587
If lock_write doesn't return a token, then this method is not supported.
589
self.control_files.dont_leave_in_place()
591
def bind(self, other):
592
"""Bind the local branch the other branch.
594
:param other: The branch to bind to
597
raise errors.UpgradeRequired(self.base)
599
def set_append_revisions_only(self, enabled):
600
if not self._format.supports_set_append_revisions_only():
601
raise errors.UpgradeRequired(self.base)
606
self.get_config().set_user_option('append_revisions_only', value,
609
def set_reference_info(self, file_id, tree_path, branch_location):
610
"""Set the branch location to use for a tree reference."""
611
raise errors.UnsupportedOperation(self.set_reference_info, self)
613
def get_reference_info(self, file_id):
614
"""Get the tree_path and branch_location for a tree reference."""
615
raise errors.UnsupportedOperation(self.get_reference_info, self)
618
def fetch(self, from_branch, last_revision=None, pb=None):
619
"""Copy revisions from from_branch into this branch.
621
:param from_branch: Where to copy from.
622
:param last_revision: What revision to stop at (None for at the end
624
:param pb: An optional progress bar to use.
627
if self.base == from_branch.base:
630
symbol_versioning.warn(
631
symbol_versioning.deprecated_in((1, 14, 0))
632
% "pb parameter to fetch()")
633
from_branch.lock_read()
635
if last_revision is None:
636
last_revision = from_branch.last_revision()
637
last_revision = _mod_revision.ensure_null(last_revision)
638
return self.repository.fetch(from_branch.repository,
639
revision_id=last_revision,
644
def get_bound_location(self):
645
"""Return the URL of the branch we are bound to.
647
Older format branches cannot bind, please be sure to use a metadir
652
def get_old_bound_location(self):
653
"""Return the URL of the branch we used to be bound to
655
raise errors.UpgradeRequired(self.base)
657
def get_commit_builder(self, parents, config=None, timestamp=None,
658
timezone=None, committer=None, revprops=None,
660
"""Obtain a CommitBuilder for this branch.
662
:param parents: Revision ids of the parents of the new revision.
663
:param config: Optional configuration to use.
664
:param timestamp: Optional timestamp recorded for commit.
665
:param timezone: Optional timezone for timestamp.
666
:param committer: Optional committer to set for commit.
667
:param revprops: Optional dictionary of revision properties.
668
:param revision_id: Optional revision id.
672
config = self.get_config()
674
return self.repository.get_commit_builder(self, parents, config,
675
timestamp, timezone, committer, revprops, revision_id)
677
def get_master_branch(self, possible_transports=None):
678
"""Return the branch we are bound to.
680
:return: Either a Branch, or None
617
684
def get_revision_delta(self, revno):
618
685
"""Return the delta for one revision.
789
931
common_index = min(self_len, other_len) -1
790
932
if common_index >= 0 and \
791
933
self_history[common_index] != other_history[common_index]:
792
raise DivergedBranches(self, other)
934
raise errors.DivergedBranches(self, other)
794
936
if stop_revision is None:
795
937
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
939
if stop_revision > other_len:
940
raise errors.NoSuchRevision(self, stop_revision)
799
941
return other_history[self_len:stop_revision]
802
def update_revisions(self, other, stop_revision=None):
803
"""Pull in all new revisions from other branch.
805
>>> from bzrlib.commit import commit
806
>>> bzrlib.trace.silent = True
807
>>> br1 = ScratchBranch(files=['foo', 'bar'])
810
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
811
>>> br2 = ScratchBranch()
812
>>> br2.update_revisions(br1)
816
>>> br2.revision_history()
818
>>> br2.update_revisions(br1)
822
>>> br1.text_store.total_size() == br2.text_store.total_size()
825
from bzrlib.progress import ProgressBar
829
pb.update('comparing histories')
830
revision_ids = self.missing_revisions(other, stop_revision)
832
if hasattr(other.revision_store, "prefetch"):
833
other.revision_store.prefetch(revision_ids)
834
if hasattr(other.inventory_store, "prefetch"):
835
inventory_ids = [other.get_revision(r).inventory_id
836
for r in revision_ids]
837
other.inventory_store.prefetch(inventory_ids)
842
for rev_id in revision_ids:
844
pb.update('fetching revision', i, len(revision_ids))
845
rev = other.get_revision(rev_id)
846
revisions.append(rev)
847
inv = other.get_inventory(str(rev.inventory_id))
848
for key, entry in inv.iter_entries():
849
if entry.text_id is None:
851
if entry.text_id not in self.text_store:
852
needed_texts.add(entry.text_id)
856
count = self.text_store.copy_multi(other.text_store, needed_texts)
857
print "Added %d texts." % count
858
inventory_ids = [ f.inventory_id for f in revisions ]
859
count = self.inventory_store.copy_multi(other.inventory_store,
861
print "Added %d inventories." % count
862
revision_ids = [ f.revision_id for f in revisions]
863
count = self.revision_store.copy_multi(other.revision_store,
865
for revision_id in revision_ids:
866
self.append_revision(revision_id)
867
print "Added %d revisions." % count
870
def commit(self, *args, **kw):
871
from bzrlib.commit import commit
872
commit(self, *args, **kw)
875
def lookup_revision(self, revision):
876
"""Return the revision identifier for a given revision information."""
877
revno, info = self.get_revision_info(revision)
880
def get_revision_info(self, revision):
881
"""Return (revno, revision id) for revision identifier.
883
revision can be an integer, in which case it is assumed to be revno (though
884
this will translate negative values into positive ones)
885
revision can also be a string, in which case it is parsed for something like
886
'date:' or 'revid:' etc.
891
try:# Convert to int if possible
892
revision = int(revision)
944
def update_revisions(self, other, stop_revision=None, overwrite=False,
946
"""Pull in new perfect-fit revisions.
948
:param other: Another Branch to pull from
949
:param stop_revision: Updated until the given revision
950
:param overwrite: Always set the branch pointer, rather than checking
951
to see if it is a proper descendant.
952
:param graph: A Graph object that can be used to query history
953
information. This can be None.
956
return InterBranch.get(other, self).update_revisions(stop_revision,
959
def import_last_revision_info(self, source_repo, revno, revid):
960
"""Set the last revision info, importing from another repo if necessary.
962
This is used by the bound branch code to upload a revision to
963
the master branch first before updating the tip of the local branch.
965
:param source_repo: Source repository to optionally fetch from
966
:param revno: Revision number of the new tip
967
:param revid: Revision id of the new tip
969
if not self.repository.has_same_location(source_repo):
970
self.repository.fetch(source_repo, revision_id=revid)
971
self.set_last_revision_info(revno, revid)
973
def revision_id_to_revno(self, revision_id):
974
"""Given a revision id, return its revno"""
975
if _mod_revision.is_null(revision_id):
977
history = self.revision_history()
979
return history.index(revision_id) + 1
893
980
except ValueError:
981
raise errors.NoSuchRevision(self, revision_id)
984
def get_rev_id(self, revno, history=None):
985
"""Find the revision id of the specified revno."""
987
return _mod_revision.NULL_REVISION
988
last_revno, last_revid = self.last_revision_info()
989
if revno == last_revno:
991
if revno <= 0 or revno > last_revno:
992
raise errors.NoSuchRevision(self, revno)
993
distance_from_last = last_revno - revno
994
if len(self._partial_revision_history_cache) <= distance_from_last:
995
self._extend_partial_history(distance_from_last)
996
return self._partial_revision_history_cache[distance_from_last]
999
def pull(self, source, overwrite=False, stop_revision=None,
1000
possible_transports=None, *args, **kwargs):
1001
"""Mirror source into this branch.
1003
This branch is considered to be 'local', having low latency.
1005
:returns: PullResult instance
1007
return InterBranch.get(source, self).pull(overwrite=overwrite,
1008
stop_revision=stop_revision,
1009
possible_transports=possible_transports, *args, **kwargs)
1011
def push(self, target, overwrite=False, stop_revision=None, *args,
1013
"""Mirror this branch into target.
1015
This branch is considered to be 'local', having low latency.
1017
return InterBranch.get(self, target).push(overwrite, stop_revision,
1020
def lossy_push(self, target, stop_revision=None):
1021
"""Push deltas into another branch.
1023
:note: This does not, like push, retain the revision ids from
1024
the source branch and will, rather than adding bzr-specific
1025
metadata, push only those semantics of the revision that can be
1026
natively represented by this branch' VCS.
1028
:param target: Target branch
1029
:param stop_revision: Revision to push, defaults to last revision.
1030
:return: BranchPushResult with an extra member revidmap:
1031
A dictionary mapping revision ids from the target branch
1032
to new revision ids in the target branch, for each
1033
revision that was pushed.
1035
inter = InterBranch.get(self, target)
1036
lossy_push = getattr(inter, "lossy_push", None)
1037
if lossy_push is None:
1038
raise errors.LossyPushToSameVCS(self, target)
1039
return lossy_push(stop_revision)
1041
def basis_tree(self):
1042
"""Return `Tree` object for last revision."""
1043
return self.repository.revision_tree(self.last_revision())
1045
def get_parent(self):
1046
"""Return the parent location of the branch.
1048
This is the default location for pull/missing. The usual
1049
pattern is that the user can override it by specifying a
1052
parent = self._get_parent_location()
1055
# This is an old-format absolute path to a local branch
1056
# turn it into a url
1057
if parent.startswith('/'):
1058
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1060
return urlutils.join(self.base[:-1], parent)
1061
except errors.InvalidURLJoin, e:
1062
raise errors.InaccessibleParent(parent, self.base)
1064
def _get_parent_location(self):
1065
raise NotImplementedError(self._get_parent_location)
1067
def _set_config_location(self, name, url, config=None,
1068
make_relative=False):
1070
config = self.get_config()
1074
url = urlutils.relative_url(self.base, url)
1075
config.set_user_option(name, url, warn_masked=True)
1077
def _get_config_location(self, name, config=None):
1079
config = self.get_config()
1080
location = config.get_user_option(name)
1085
def get_child_submit_format(self):
1086
"""Return the preferred format of submissions to this branch."""
1087
return self.get_config().get_user_option("child_submit_format")
1089
def get_submit_branch(self):
1090
"""Return the submit location of the branch.
1092
This is the default location for bundle. The usual
1093
pattern is that the user can override it by specifying a
1096
return self.get_config().get_user_option('submit_branch')
1098
def set_submit_branch(self, location):
1099
"""Return the submit location of the branch.
1101
This is the default location for bundle. The usual
1102
pattern is that the user can override it by specifying a
1105
self.get_config().set_user_option('submit_branch', location,
1108
def get_public_branch(self):
1109
"""Return the public location of the branch.
1111
This is used by merge directives.
1113
return self._get_config_location('public_branch')
1115
def set_public_branch(self, location):
1116
"""Return the submit location of the branch.
1118
This is the default location for bundle. The usual
1119
pattern is that the user can override it by specifying a
1122
self._set_config_location('public_branch', location)
1124
def get_push_location(self):
1125
"""Return the None or the location to push this branch to."""
1126
push_loc = self.get_config().get_user_option('push_location')
1129
def set_push_location(self, location):
1130
"""Set a new push location for this branch."""
1131
raise NotImplementedError(self.set_push_location)
1133
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1134
"""Run the post_change_branch_tip hooks."""
1135
hooks = Branch.hooks['post_change_branch_tip']
1138
new_revno, new_revid = self.last_revision_info()
1139
params = ChangeBranchTipParams(
1140
self, old_revno, new_revno, old_revid, new_revid)
1144
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1145
"""Run the pre_change_branch_tip hooks."""
1146
hooks = Branch.hooks['pre_change_branch_tip']
1149
old_revno, old_revid = self.last_revision_info()
1150
params = ChangeBranchTipParams(
1151
self, old_revno, new_revno, old_revid, new_revid)
1157
"""Synchronise this branch with the master branch if any.
1159
:return: None or the last_revision pivoted out during the update.
1163
def check_revno(self, revno):
1165
Check whether a revno corresponds to any revision.
1166
Zero (the NULL revision) is considered valid.
1169
self.check_real_revno(revno)
1171
def check_real_revno(self, revno):
1173
Check whether a revno corresponds to a real revision.
1174
Zero (the NULL revision) is considered invalid
1176
if revno < 1 or revno > self.revno():
1177
raise errors.InvalidRevisionNumber(revno)
1180
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1181
"""Clone this branch into to_bzrdir preserving all semantic values.
1183
Most API users will want 'create_clone_on_transport', which creates a
1184
new bzrdir and branch on the fly.
1186
revision_id: if not None, the revision history in the new branch will
1187
be truncated to end with revision_id.
1189
result = to_bzrdir.create_branch()
1192
if repository_policy is not None:
1193
repository_policy.configure_branch(result)
1194
self.copy_content_into(result, revision_id=revision_id)
1200
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1201
"""Create a new line of development from the branch, into to_bzrdir.
1203
to_bzrdir controls the branch format.
1205
revision_id: if not None, the revision history in the new branch will
1206
be truncated to end with revision_id.
1208
if (repository_policy is not None and
1209
repository_policy.requires_stacking()):
1210
to_bzrdir._format.require_stacking(_skip_repo=True)
1211
result = to_bzrdir.create_branch()
1214
if repository_policy is not None:
1215
repository_policy.configure_branch(result)
1216
self.copy_content_into(result, revision_id=revision_id)
1217
result.set_parent(self.bzrdir.root_transport.base)
1222
def _synchronize_history(self, destination, revision_id):
1223
"""Synchronize last revision and revision history between branches.
1225
This version is most efficient when the destination is also a
1226
BzrBranch6, but works for BzrBranch5, as long as the destination's
1227
repository contains all the lefthand ancestors of the intended
1228
last_revision. If not, set_last_revision_info will fail.
1230
:param destination: The branch to copy the history into
1231
:param revision_id: The revision-id to truncate history at. May
1232
be None to copy complete history.
1234
source_revno, source_revision_id = self.last_revision_info()
1235
if revision_id is None:
1236
revno, revision_id = source_revno, source_revision_id
1238
graph = self.repository.get_graph()
1240
revno = graph.find_distance_to_null(revision_id,
1241
[(source_revision_id, source_revno)])
1242
except errors.GhostRevisionsHaveNoRevno:
1243
# Default to 1, if we can't find anything else
1245
destination.set_last_revision_info(revno, revision_id)
1248
def copy_content_into(self, destination, revision_id=None):
1249
"""Copy the content of self into destination.
1251
revision_id: if not None, the revision history in the new branch will
1252
be truncated to end with revision_id.
1254
self.update_references(destination)
1255
self._synchronize_history(destination, revision_id)
1257
parent = self.get_parent()
1258
except errors.InaccessibleParent, e:
1259
mutter('parent was not accessible to copy: %s', e)
1262
destination.set_parent(parent)
1263
if self._push_should_merge_tags():
1264
self.tags.merge_to(destination.tags)
1266
def update_references(self, target):
1267
if not getattr(self._format, 'supports_reference_locations', False):
1269
reference_dict = self._get_all_reference_info()
1270
if len(reference_dict) == 0:
1272
old_base = self.base
1273
new_base = target.base
1274
target_reference_dict = target._get_all_reference_info()
1275
for file_id, (tree_path, branch_location) in (
1276
reference_dict.items()):
1277
branch_location = urlutils.rebase_url(branch_location,
1279
target_reference_dict.setdefault(
1280
file_id, (tree_path, branch_location))
1281
target._set_all_reference_info(target_reference_dict)
1284
def check(self, refs):
1285
"""Check consistency of the branch.
1287
In particular this checks that revisions given in the revision-history
1288
do actually match up in the revision graph, and that they're all
1289
present in the repository.
1291
Callers will typically also want to check the repository.
1293
:param refs: Calculated refs for this branch as specified by
1294
branch._get_check_refs()
1295
:return: A BranchCheckResult.
1297
result = BranchCheckResult(self)
1298
last_revno, last_revision_id = self.last_revision_info()
1299
actual_revno = refs[('lefthand-distance', last_revision_id)]
1300
if actual_revno != last_revno:
1301
result.errors.append(errors.BzrCheckError(
1302
'revno does not match len(mainline) %s != %s' % (
1303
last_revno, actual_revno)))
1304
# TODO: We should probably also check that self.revision_history
1305
# matches the repository for older branch formats.
1306
# If looking for the code that cross-checks repository parents against
1307
# the iter_reverse_revision_history output, that is now a repository
1311
def _get_checkout_format(self):
1312
"""Return the most suitable metadir for a checkout of this branch.
1313
Weaves are used if this branch's repository uses weaves.
1315
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1316
from bzrlib.repofmt import weaverepo
1317
format = bzrdir.BzrDirMetaFormat1()
1318
format.repository_format = weaverepo.RepositoryFormat7()
1320
format = self.repository.bzrdir.checkout_metadir()
1321
format.set_branch_format(self._format)
1324
def create_clone_on_transport(self, to_transport, revision_id=None,
1325
stacked_on=None, create_prefix=False, use_existing_dir=False):
1326
"""Create a clone of this branch and its bzrdir.
1328
:param to_transport: The transport to clone onto.
1329
:param revision_id: The revision id to use as tip in the new branch.
1330
If None the tip is obtained from this branch.
1331
:param stacked_on: An optional URL to stack the clone on.
1332
:param create_prefix: Create any missing directories leading up to
1334
:param use_existing_dir: Use an existing directory if one exists.
1336
# XXX: Fix the bzrdir API to allow getting the branch back from the
1337
# clone call. Or something. 20090224 RBC/spiv.
1338
if revision_id is None:
1339
revision_id = self.last_revision()
1340
dir_to = self.bzrdir.clone_on_transport(to_transport,
1341
revision_id=revision_id, stacked_on=stacked_on,
1342
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1343
return dir_to.open_branch()
1345
def create_checkout(self, to_location, revision_id=None,
1346
lightweight=False, accelerator_tree=None,
1348
"""Create a checkout of a branch.
1350
:param to_location: The url to produce the checkout at
1351
:param revision_id: The revision to check out
1352
:param lightweight: If True, produce a lightweight checkout, otherwise,
1353
produce a bound branch (heavyweight checkout)
1354
:param accelerator_tree: A tree which can be used for retrieving file
1355
contents more quickly than the revision tree, i.e. a workingtree.
1356
The revision tree will be used for cases where accelerator_tree's
1357
content is different.
1358
:param hardlink: If true, hard-link files from accelerator_tree,
1360
:return: The tree of the created checkout
1362
t = transport.get_transport(to_location)
1365
format = self._get_checkout_format()
1366
checkout = format.initialize_on_transport(t)
1367
from_branch = BranchReferenceFormat().initialize(checkout,
1370
format = self._get_checkout_format()
1371
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1372
to_location, force_new_tree=False, format=format)
1373
checkout = checkout_branch.bzrdir
1374
checkout_branch.bind(self)
1375
# pull up to the specified revision_id to set the initial
1376
# branch tip correctly, and seed it with history.
1377
checkout_branch.pull(self, stop_revision=revision_id)
1379
tree = checkout.create_workingtree(revision_id,
1380
from_branch=from_branch,
1381
accelerator_tree=accelerator_tree,
1383
basis_tree = tree.basis_tree()
1384
basis_tree.lock_read()
1386
for path, file_id in basis_tree.iter_references():
1387
reference_parent = self.reference_parent(file_id, path)
1388
reference_parent.create_checkout(tree.abspath(path),
1389
basis_tree.get_reference_revision(file_id, path),
1396
def reconcile(self, thorough=True):
1397
"""Make sure the data stored in this branch is consistent."""
1398
from bzrlib.reconcile import BranchReconciler
1399
reconciler = BranchReconciler(self, thorough=thorough)
1400
reconciler.reconcile()
1403
def reference_parent(self, file_id, path, possible_transports=None):
1404
"""Return the parent branch for a tree-reference file_id
1405
:param file_id: The file_id of the tree reference
1406
:param path: The path of the file_id in the tree
1407
:return: A branch associated with the file_id
1409
# FIXME should provide multiple branches, based on config
1410
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1411
possible_transports=possible_transports)
1413
def supports_tags(self):
1414
return self._format.supports_tags()
1416
def automatic_tag_name(self, revision_id):
1417
"""Try to automatically find the tag name for a revision.
1419
:param revision_id: Revision id of the revision.
1420
:return: A tag name or None if no tag name could be determined.
1422
for hook in Branch.hooks['automatic_tag_name']:
1423
ret = hook(self, revision_id)
1428
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1430
"""Ensure that revision_b is a descendant of revision_a.
1432
This is a helper function for update_revisions.
1434
:raises: DivergedBranches if revision_b has diverged from revision_a.
1435
:returns: True if revision_b is a descendant of revision_a.
1437
relation = self._revision_relations(revision_a, revision_b, graph)
1438
if relation == 'b_descends_from_a':
1440
elif relation == 'diverged':
1441
raise errors.DivergedBranches(self, other_branch)
1442
elif relation == 'a_descends_from_b':
1445
raise AssertionError("invalid relation: %r" % (relation,))
1447
def _revision_relations(self, revision_a, revision_b, graph):
1448
"""Determine the relationship between two revisions.
1450
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1452
heads = graph.heads([revision_a, revision_b])
1453
if heads == set([revision_b]):
1454
return 'b_descends_from_a'
1455
elif heads == set([revision_a, revision_b]):
1456
# These branches have diverged
1458
elif heads == set([revision_a]):
1459
return 'a_descends_from_b'
1461
raise AssertionError("invalid heads: %r" % (heads,))
1464
class BranchFormat(object):
1465
"""An encapsulation of the initialization and open routines for a format.
1467
Formats provide three things:
1468
* An initialization routine,
1472
Formats are placed in an dict by their format string for reference
1473
during branch opening. Its not required that these be instances, they
1474
can be classes themselves with class methods - it simply depends on
1475
whether state is needed for a given format or not.
1477
Once a format is deprecated, just deprecate the initialize and open
1478
methods on the format class. Do not deprecate the object, as the
1479
object will be created every time regardless.
1482
_default_format = None
1483
"""The default format used for new branches."""
1486
"""The known formats."""
1488
can_set_append_revisions_only = True
1490
def __eq__(self, other):
1491
return self.__class__ is other.__class__
1493
def __ne__(self, other):
1494
return not (self == other)
1497
def find_format(klass, a_bzrdir, name=None):
1498
"""Return the format for the branch object in a_bzrdir."""
1500
transport = a_bzrdir.get_branch_transport(None, name=name)
1501
format_string = transport.get_bytes("format")
1502
return klass._formats[format_string]
1503
except errors.NoSuchFile:
1504
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1506
raise errors.UnknownFormatError(format=format_string, kind='branch')
1509
def get_default_format(klass):
1510
"""Return the current default format."""
1511
return klass._default_format
1513
def get_reference(self, a_bzrdir):
1514
"""Get the target reference of the branch in a_bzrdir.
1516
format probing must have been completed before calling
1517
this method - it is assumed that the format of the branch
1518
in a_bzrdir is correct.
1520
:param a_bzrdir: The bzrdir to get the branch data from.
1521
:return: None if the branch is not a reference branch.
1526
def set_reference(self, a_bzrdir, to_branch):
1527
"""Set the target reference of the branch in a_bzrdir.
1529
format probing must have been completed before calling
1530
this method - it is assumed that the format of the branch
1531
in a_bzrdir is correct.
1533
:param a_bzrdir: The bzrdir to set the branch reference for.
1534
:param to_branch: branch that the checkout is to reference
1536
raise NotImplementedError(self.set_reference)
1538
def get_format_string(self):
1539
"""Return the ASCII format string that identifies this format."""
1540
raise NotImplementedError(self.get_format_string)
1542
def get_format_description(self):
1543
"""Return the short format description for this format."""
1544
raise NotImplementedError(self.get_format_description)
1546
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1547
lock_type='metadir', set_format=True):
1548
"""Initialize a branch in a bzrdir, with specified files
1550
:param a_bzrdir: The bzrdir to initialize the branch in
1551
:param utf8_files: The files to create as a list of
1552
(filename, content) tuples
1553
:param name: Name of colocated branch to create, if any
1554
:param set_format: If True, set the format with
1555
self.get_format_string. (BzrBranch4 has its format set
1557
:return: a branch in this format
1559
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1560
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1562
'metadir': ('lock', lockdir.LockDir),
1563
'branch4': ('branch-lock', lockable_files.TransportLock),
1565
lock_name, lock_class = lock_map[lock_type]
1566
control_files = lockable_files.LockableFiles(branch_transport,
1567
lock_name, lock_class)
1568
control_files.create_lock()
1570
control_files.lock_write()
1571
except errors.LockContention:
1572
if lock_type != 'branch4':
1578
utf8_files += [('format', self.get_format_string())]
1580
for (filename, content) in utf8_files:
1581
branch_transport.put_bytes(
1583
mode=a_bzrdir._get_file_mode())
1586
control_files.unlock()
1587
return self.open(a_bzrdir, name, _found=True)
1589
def initialize(self, a_bzrdir, name=None):
1590
"""Create a branch of this format in a_bzrdir.
1592
:param name: Name of the colocated branch to create.
1594
raise NotImplementedError(self.initialize)
1596
def is_supported(self):
1597
"""Is this format supported?
1599
Supported formats can be initialized and opened.
1600
Unsupported formats may not support initialization or committing or
1601
some other features depending on the reason for not being supported.
1605
def make_tags(self, branch):
1606
"""Create a tags object for branch.
1608
This method is on BranchFormat, because BranchFormats are reflected
1609
over the wire via network_name(), whereas full Branch instances require
1610
multiple VFS method calls to operate at all.
1612
The default implementation returns a disabled-tags instance.
1614
Note that it is normal for branch to be a RemoteBranch when using tags
1617
return DisabledTags(branch)
1619
def network_name(self):
1620
"""A simple byte string uniquely identifying this format for RPC calls.
1622
MetaDir branch formats use their disk format string to identify the
1623
repository over the wire. All in one formats such as bzr < 0.8, and
1624
foreign formats like svn/git and hg should use some marker which is
1625
unique and immutable.
1627
raise NotImplementedError(self.network_name)
1629
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1630
"""Return the branch object for a_bzrdir
1632
:param a_bzrdir: A BzrDir that contains a branch.
1633
:param name: Name of colocated branch to open
1634
:param _found: a private parameter, do not use it. It is used to
1635
indicate if format probing has already be done.
1636
:param ignore_fallbacks: when set, no fallback branches will be opened
1637
(if there are any). Default is to open fallbacks.
1639
raise NotImplementedError(self.open)
1642
def register_format(klass, format):
1643
"""Register a metadir format."""
1644
klass._formats[format.get_format_string()] = format
1645
# Metadir formats have a network name of their format string, and get
1646
# registered as class factories.
1647
network_format_registry.register(format.get_format_string(), format.__class__)
1650
def set_default_format(klass, format):
1651
klass._default_format = format
1653
def supports_set_append_revisions_only(self):
1654
"""True if this format supports set_append_revisions_only."""
1657
def supports_stacking(self):
1658
"""True if this format records a stacked-on branch."""
1662
def unregister_format(klass, format):
1663
del klass._formats[format.get_format_string()]
1666
return self.get_format_description().rstrip()
1668
def supports_tags(self):
1669
"""True if this format supports tags stored in the branch"""
1670
return False # by default
1673
class BranchHooks(Hooks):
1674
"""A dictionary mapping hook name to a list of callables for branch hooks.
1676
e.g. ['set_rh'] Is the list of items to be called when the
1677
set_revision_history function is invoked.
1681
"""Create the default hooks.
1683
These are all empty initially, because by default nothing should get
1686
Hooks.__init__(self)
1687
self.create_hook(HookPoint('set_rh',
1688
"Invoked whenever the revision history has been set via "
1689
"set_revision_history. The api signature is (branch, "
1690
"revision_history), and the branch will be write-locked. "
1691
"The set_rh hook can be expensive for bzr to trigger, a better "
1692
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1693
self.create_hook(HookPoint('open',
1694
"Called with the Branch object that has been opened after a "
1695
"branch is opened.", (1, 8), None))
1696
self.create_hook(HookPoint('post_push',
1697
"Called after a push operation completes. post_push is called "
1698
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1699
"bzr client.", (0, 15), None))
1700
self.create_hook(HookPoint('post_pull',
1701
"Called after a pull operation completes. post_pull is called "
1702
"with a bzrlib.branch.PullResult object and only runs in the "
1703
"bzr client.", (0, 15), None))
1704
self.create_hook(HookPoint('pre_commit',
1705
"Called after a commit is calculated but before it is is "
1706
"completed. pre_commit is called with (local, master, old_revno, "
1707
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1708
"). old_revid is NULL_REVISION for the first commit to a branch, "
1709
"tree_delta is a TreeDelta object describing changes from the "
1710
"basis revision. hooks MUST NOT modify this delta. "
1711
" future_tree is an in-memory tree obtained from "
1712
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1713
"tree.", (0,91), None))
1714
self.create_hook(HookPoint('post_commit',
1715
"Called in the bzr client after a commit has completed. "
1716
"post_commit is called with (local, master, old_revno, old_revid, "
1717
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1718
"commit to a branch.", (0, 15), None))
1719
self.create_hook(HookPoint('post_uncommit',
1720
"Called in the bzr client after an uncommit completes. "
1721
"post_uncommit is called with (local, master, old_revno, "
1722
"old_revid, new_revno, new_revid) where local is the local branch "
1723
"or None, master is the target branch, and an empty branch "
1724
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1725
self.create_hook(HookPoint('pre_change_branch_tip',
1726
"Called in bzr client and server before a change to the tip of a "
1727
"branch is made. pre_change_branch_tip is called with a "
1728
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1729
"commit, uncommit will all trigger this hook.", (1, 6), None))
1730
self.create_hook(HookPoint('post_change_branch_tip',
1731
"Called in bzr client and server after a change to the tip of a "
1732
"branch is made. post_change_branch_tip is called with a "
1733
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1734
"commit, uncommit will all trigger this hook.", (1, 4), None))
1735
self.create_hook(HookPoint('transform_fallback_location',
1736
"Called when a stacked branch is activating its fallback "
1737
"locations. transform_fallback_location is called with (branch, "
1738
"url), and should return a new url. Returning the same url "
1739
"allows it to be used as-is, returning a different one can be "
1740
"used to cause the branch to stack on a closer copy of that "
1741
"fallback_location. Note that the branch cannot have history "
1742
"accessing methods called on it during this hook because the "
1743
"fallback locations have not been activated. When there are "
1744
"multiple hooks installed for transform_fallback_location, "
1745
"all are called with the url returned from the previous hook."
1746
"The order is however undefined.", (1, 9), None))
1747
self.create_hook(HookPoint('automatic_tag_name',
1748
"Called to determine an automatic tag name for a revision."
1749
"automatic_tag_name is called with (branch, revision_id) and "
1750
"should return a tag name or None if no tag name could be "
1751
"determined. The first non-None tag name returned will be used.",
1756
# install the default hooks into the Branch class.
1757
Branch.hooks = BranchHooks()
1760
class ChangeBranchTipParams(object):
1761
"""Object holding parameters passed to *_change_branch_tip hooks.
1763
There are 5 fields that hooks may wish to access:
1765
:ivar branch: the branch being changed
1766
:ivar old_revno: revision number before the change
1767
:ivar new_revno: revision number after the change
1768
:ivar old_revid: revision id before the change
1769
:ivar new_revid: revision id after the change
1771
The revid fields are strings. The revno fields are integers.
1774
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1775
"""Create a group of ChangeBranchTip parameters.
1777
:param branch: The branch being changed.
1778
:param old_revno: Revision number before the change.
1779
:param new_revno: Revision number after the change.
1780
:param old_revid: Tip revision id before the change.
1781
:param new_revid: Tip revision id after the change.
1783
self.branch = branch
1784
self.old_revno = old_revno
1785
self.new_revno = new_revno
1786
self.old_revid = old_revid
1787
self.new_revid = new_revid
1789
def __eq__(self, other):
1790
return self.__dict__ == other.__dict__
1793
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1794
self.__class__.__name__, self.branch,
1795
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1798
class BzrBranchFormat4(BranchFormat):
1799
"""Bzr branch format 4.
1802
- a revision-history file.
1803
- a branch-lock lock file [ to be shared with the bzrdir ]
1806
def get_format_description(self):
1807
"""See BranchFormat.get_format_description()."""
1808
return "Branch format 4"
1810
def initialize(self, a_bzrdir, name=None):
1811
"""Create a branch of this format in a_bzrdir."""
1812
utf8_files = [('revision-history', ''),
1813
('branch-name', ''),
1815
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1816
lock_type='branch4', set_format=False)
1819
super(BzrBranchFormat4, self).__init__()
1820
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1822
def network_name(self):
1823
"""The network name for this format is the control dirs disk label."""
1824
return self._matchingbzrdir.get_format_string()
1826
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1827
"""See BranchFormat.open()."""
1829
# we are being called directly and must probe.
1830
raise NotImplementedError
1831
return BzrBranch(_format=self,
1832
_control_files=a_bzrdir._control_files,
1835
_repository=a_bzrdir.open_repository())
1838
return "Bazaar-NG branch format 4"
1841
class BranchFormatMetadir(BranchFormat):
1842
"""Common logic for meta-dir based branch formats."""
1844
def _branch_class(self):
1845
"""What class to instantiate on open calls."""
1846
raise NotImplementedError(self._branch_class)
1848
def network_name(self):
1849
"""A simple byte string uniquely identifying this format for RPC calls.
1851
Metadir branch formats use their format string.
1853
return self.get_format_string()
1855
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1856
"""See BranchFormat.open()."""
1858
format = BranchFormat.find_format(a_bzrdir, name=name)
1859
if format.__class__ != self.__class__:
1860
raise AssertionError("wrong format %r found for %r" %
1863
transport = a_bzrdir.get_branch_transport(None, name=name)
1864
control_files = lockable_files.LockableFiles(transport, 'lock',
1866
return self._branch_class()(_format=self,
1867
_control_files=control_files,
1870
_repository=a_bzrdir.find_repository(),
1871
ignore_fallbacks=ignore_fallbacks)
1872
except errors.NoSuchFile:
1873
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1876
super(BranchFormatMetadir, self).__init__()
1877
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1878
self._matchingbzrdir.set_branch_format(self)
1880
def supports_tags(self):
1884
class BzrBranchFormat5(BranchFormatMetadir):
1885
"""Bzr branch format 5.
1888
- a revision-history file.
1890
- a lock dir guarding the branch itself
1891
- all of this stored in a branch/ subdirectory
1892
- works with shared repositories.
1894
This format is new in bzr 0.8.
1897
def _branch_class(self):
1900
def get_format_string(self):
1901
"""See BranchFormat.get_format_string()."""
1902
return "Bazaar-NG branch format 5\n"
1904
def get_format_description(self):
1905
"""See BranchFormat.get_format_description()."""
1906
return "Branch format 5"
1908
def initialize(self, a_bzrdir, name=None):
1909
"""Create a branch of this format in a_bzrdir."""
1910
utf8_files = [('revision-history', ''),
1911
('branch-name', ''),
1913
return self._initialize_helper(a_bzrdir, utf8_files, name)
1915
def supports_tags(self):
1919
class BzrBranchFormat6(BranchFormatMetadir):
1920
"""Branch format with last-revision and tags.
1922
Unlike previous formats, this has no explicit revision history. Instead,
1923
this just stores the last-revision, and the left-hand history leading
1924
up to there is the history.
1926
This format was introduced in bzr 0.15
1927
and became the default in 0.91.
1930
def _branch_class(self):
1933
def get_format_string(self):
1934
"""See BranchFormat.get_format_string()."""
1935
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1937
def get_format_description(self):
1938
"""See BranchFormat.get_format_description()."""
1939
return "Branch format 6"
1941
def initialize(self, a_bzrdir, name=None):
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, name)
1949
def make_tags(self, branch):
1950
"""See bzrlib.branch.BranchFormat.make_tags()."""
1951
return BasicTags(branch)
1953
def supports_set_append_revisions_only(self):
1957
class BzrBranchFormat8(BranchFormatMetadir):
1958
"""Metadir format supporting storing locations of subtree branches."""
1960
def _branch_class(self):
1963
def get_format_string(self):
1964
"""See BranchFormat.get_format_string()."""
1965
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1967
def get_format_description(self):
1968
"""See BranchFormat.get_format_description()."""
1969
return "Branch format 8"
1971
def initialize(self, a_bzrdir, name=None):
1972
"""Create a branch of this format in a_bzrdir."""
1973
utf8_files = [('last-revision', '0 null:\n'),
1974
('branch.conf', ''),
1978
return self._initialize_helper(a_bzrdir, utf8_files, name)
1981
super(BzrBranchFormat8, self).__init__()
1982
self._matchingbzrdir.repository_format = \
1983
RepositoryFormatKnitPack5RichRoot()
1985
def make_tags(self, branch):
1986
"""See bzrlib.branch.BranchFormat.make_tags()."""
1987
return BasicTags(branch)
1989
def supports_set_append_revisions_only(self):
1992
def supports_stacking(self):
1995
supports_reference_locations = True
1998
class BzrBranchFormat7(BzrBranchFormat8):
1999
"""Branch format with last-revision, tags, and a stacked location pointer.
2001
The stacked location pointer is passed down to the repository and requires
2002
a repository format with supports_external_lookups = True.
2004
This format was introduced in bzr 1.6.
2007
def initialize(self, a_bzrdir, name=None):
2008
"""Create a branch of this format in a_bzrdir."""
2009
utf8_files = [('last-revision', '0 null:\n'),
2010
('branch.conf', ''),
2013
return self._initialize_helper(a_bzrdir, utf8_files, name)
2015
def _branch_class(self):
2018
def get_format_string(self):
2019
"""See BranchFormat.get_format_string()."""
2020
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2022
def get_format_description(self):
2023
"""See BranchFormat.get_format_description()."""
2024
return "Branch format 7"
2026
def supports_set_append_revisions_only(self):
2029
supports_reference_locations = False
2032
class BranchReferenceFormat(BranchFormat):
2033
"""Bzr branch reference format.
2035
Branch references are used in implementing checkouts, they
2036
act as an alias to the real branch which is at some other url.
2043
def get_format_string(self):
2044
"""See BranchFormat.get_format_string()."""
2045
return "Bazaar-NG Branch Reference Format 1\n"
2047
def get_format_description(self):
2048
"""See BranchFormat.get_format_description()."""
2049
return "Checkout reference format 1"
2051
def get_reference(self, a_bzrdir):
2052
"""See BranchFormat.get_reference()."""
2053
transport = a_bzrdir.get_branch_transport(None)
2054
return transport.get_bytes('location')
2056
def set_reference(self, a_bzrdir, to_branch):
2057
"""See BranchFormat.set_reference()."""
2058
transport = a_bzrdir.get_branch_transport(None)
2059
location = transport.put_bytes('location', to_branch.base)
2061
def initialize(self, a_bzrdir, name=None, target_branch=None):
2062
"""Create a branch of this format in a_bzrdir."""
2063
if target_branch is None:
2064
# this format does not implement branch itself, thus the implicit
2065
# creation contract must see it as uninitializable
2066
raise errors.UninitializableFormat(self)
2067
mutter('creating branch reference in %s', a_bzrdir.transport.base)
2068
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2069
branch_transport.put_bytes('location',
2070
target_branch.bzrdir.root_transport.base)
2071
branch_transport.put_bytes('format', self.get_format_string())
2073
a_bzrdir, name, _found=True,
2074
possible_transports=[target_branch.bzrdir.root_transport])
2077
super(BranchReferenceFormat, self).__init__()
2078
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2079
self._matchingbzrdir.set_branch_format(self)
2081
def _make_reference_clone_function(format, a_branch):
2082
"""Create a clone() routine for a branch dynamically."""
2083
def clone(to_bzrdir, revision_id=None,
2084
repository_policy=None):
2085
"""See Branch.clone()."""
2086
return format.initialize(to_bzrdir, target_branch=a_branch)
2087
# cannot obey revision_id limits when cloning a reference ...
2088
# FIXME RBC 20060210 either nuke revision_id for clone, or
2089
# emit some sort of warning/error to the caller ?!
2092
def open(self, a_bzrdir, name=None, _found=False, location=None,
2093
possible_transports=None, ignore_fallbacks=False):
2094
"""Return the branch that the branch reference in a_bzrdir points at.
2096
:param a_bzrdir: A BzrDir that contains a branch.
2097
:param name: Name of colocated branch to open, if any
2098
:param _found: a private parameter, do not use it. It is used to
2099
indicate if format probing has already be done.
2100
:param ignore_fallbacks: when set, no fallback branches will be opened
2101
(if there are any). Default is to open fallbacks.
2102
:param location: The location of the referenced branch. If
2103
unspecified, this will be determined from the branch reference in
2105
:param possible_transports: An optional reusable transports list.
2108
format = BranchFormat.find_format(a_bzrdir, name=name)
2109
if format.__class__ != self.__class__:
2110
raise AssertionError("wrong format %r found for %r" %
2112
if location is None:
2113
location = self.get_reference(a_bzrdir)
2114
real_bzrdir = bzrdir.BzrDir.open(
2115
location, possible_transports=possible_transports)
2116
result = real_bzrdir.open_branch(name=name,
2117
ignore_fallbacks=ignore_fallbacks)
2118
# this changes the behaviour of result.clone to create a new reference
2119
# rather than a copy of the content of the branch.
2120
# I did not use a proxy object because that needs much more extensive
2121
# testing, and we are only changing one behaviour at the moment.
2122
# If we decide to alter more behaviours - i.e. the implicit nickname
2123
# then this should be refactored to introduce a tested proxy branch
2124
# and a subclass of that for use in overriding clone() and ....
2126
result.clone = self._make_reference_clone_function(result)
2130
network_format_registry = registry.FormatRegistry()
2131
"""Registry of formats indexed by their network name.
2133
The network name for a branch format is an identifier that can be used when
2134
referring to formats with smart server operations. See
2135
BranchFormat.network_name() for more detail.
2139
# formats which have no format string are not discoverable
2140
# and not independently creatable, so are not registered.
2141
__format5 = BzrBranchFormat5()
2142
__format6 = BzrBranchFormat6()
2143
__format7 = BzrBranchFormat7()
2144
__format8 = BzrBranchFormat8()
2145
BranchFormat.register_format(__format5)
2146
BranchFormat.register_format(BranchReferenceFormat())
2147
BranchFormat.register_format(__format6)
2148
BranchFormat.register_format(__format7)
2149
BranchFormat.register_format(__format8)
2150
BranchFormat.set_default_format(__format7)
2151
_legacy_formats = [BzrBranchFormat4(),
2153
network_format_registry.register(
2154
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2157
class BzrBranch(Branch, _RelockDebugMixin):
2158
"""A branch stored in the actual filesystem.
2160
Note that it's "local" in the context of the filesystem; it doesn't
2161
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2162
it's writable, and can be accessed via the normal filesystem API.
2164
:ivar _transport: Transport for file operations on this branch's
2165
control files, typically pointing to the .bzr/branch directory.
2166
:ivar repository: Repository for this branch.
2167
:ivar base: The url of the base directory for this branch; the one
2168
containing the .bzr directory.
2169
:ivar name: Optional colocated branch name as it exists in the control
2173
def __init__(self, _format=None,
2174
_control_files=None, a_bzrdir=None, name=None,
2175
_repository=None, ignore_fallbacks=False):
2176
"""Create new branch object at a particular location."""
2177
if a_bzrdir is None:
2178
raise ValueError('a_bzrdir must be supplied')
2180
self.bzrdir = a_bzrdir
2181
self._base = self.bzrdir.transport.clone('..').base
2183
# XXX: We should be able to just do
2184
# self.base = self.bzrdir.root_transport.base
2185
# but this does not quite work yet -- mbp 20080522
2186
self._format = _format
2187
if _control_files is None:
2188
raise ValueError('BzrBranch _control_files is None')
2189
self.control_files = _control_files
2190
self._transport = _control_files._transport
2191
self.repository = _repository
2192
Branch.__init__(self)
2195
if self.name is None:
2196
return '%s(%r)' % (self.__class__.__name__, self.base)
2198
return '%s(%r,%r)' % (self.__class__.__name__, self.base, self.name)
2202
def _get_base(self):
2203
"""Returns the directory containing the control directory."""
2206
base = property(_get_base, doc="The URL for the root of this branch.")
2208
def _get_config(self):
2209
return TransportConfig(self._transport, 'branch.conf')
2211
def is_locked(self):
2212
return self.control_files.is_locked()
2214
def lock_write(self, token=None):
2215
if not self.is_locked():
2216
self._note_lock('w')
2217
# All-in-one needs to always unlock/lock.
2218
repo_control = getattr(self.repository, 'control_files', None)
2219
if self.control_files == repo_control or not self.is_locked():
2220
self.repository._warn_if_deprecated(self)
2221
self.repository.lock_write()
2226
return self.control_files.lock_write(token=token)
2229
self.repository.unlock()
2232
def lock_read(self):
2233
if not self.is_locked():
2234
self._note_lock('r')
2235
# All-in-one needs to always unlock/lock.
2236
repo_control = getattr(self.repository, 'control_files', None)
2237
if self.control_files == repo_control or not self.is_locked():
2238
self.repository._warn_if_deprecated(self)
2239
self.repository.lock_read()
2244
self.control_files.lock_read()
2247
self.repository.unlock()
2250
@only_raises(errors.LockNotHeld, errors.LockBroken)
2253
self.control_files.unlock()
2255
# All-in-one needs to always unlock/lock.
2256
repo_control = getattr(self.repository, 'control_files', None)
2257
if (self.control_files == repo_control or
2258
not self.control_files.is_locked()):
2259
self.repository.unlock()
2260
if not self.control_files.is_locked():
2261
# we just released the lock
2262
self._clear_cached_state()
2264
def peek_lock_mode(self):
2265
if self.control_files._lock_count == 0:
2268
return self.control_files._lock_mode
2270
def get_physical_lock_status(self):
2271
return self.control_files.get_physical_lock_status()
2274
def print_file(self, file, revision_id):
2275
"""See Branch.print_file."""
2276
return self.repository.print_file(file, revision_id)
2278
def _write_revision_history(self, history):
2279
"""Factored out of set_revision_history.
2281
This performs the actual writing to disk.
2282
It is intended to be called by BzrBranch5.set_revision_history."""
2283
self._transport.put_bytes(
2284
'revision-history', '\n'.join(history),
2285
mode=self.bzrdir._get_file_mode())
2288
def set_revision_history(self, rev_history):
2289
"""See Branch.set_revision_history."""
2290
if 'evil' in debug.debug_flags:
2291
mutter_callsite(3, "set_revision_history scales with history.")
2292
check_not_reserved_id = _mod_revision.check_not_reserved_id
2293
for rev_id in rev_history:
2294
check_not_reserved_id(rev_id)
2295
if Branch.hooks['post_change_branch_tip']:
2296
# Don't calculate the last_revision_info() if there are no hooks
2298
old_revno, old_revid = self.last_revision_info()
2299
if len(rev_history) == 0:
2300
revid = _mod_revision.NULL_REVISION
2302
revid = rev_history[-1]
2303
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2304
self._write_revision_history(rev_history)
2305
self._clear_cached_state()
2306
self._cache_revision_history(rev_history)
2307
for hook in Branch.hooks['set_rh']:
2308
hook(self, rev_history)
2309
if Branch.hooks['post_change_branch_tip']:
2310
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2312
def _synchronize_history(self, destination, revision_id):
2313
"""Synchronize last revision and revision history between branches.
2315
This version is most efficient when the destination is also a
2316
BzrBranch5, but works for BzrBranch6 as long as the revision
2317
history is the true lefthand parent history, and all of the revisions
2318
are in the destination's repository. If not, set_revision_history
2321
:param destination: The branch to copy the history into
2322
:param revision_id: The revision-id to truncate history at. May
2323
be None to copy complete history.
2325
if not isinstance(destination._format, BzrBranchFormat5):
2326
super(BzrBranch, self)._synchronize_history(
2327
destination, revision_id)
2329
if revision_id == _mod_revision.NULL_REVISION:
2332
new_history = self.revision_history()
2333
if revision_id is not None and new_history != []:
2335
new_history = new_history[:new_history.index(revision_id) + 1]
2337
rev = self.repository.get_revision(revision_id)
2338
new_history = rev.get_history(self.repository)[1:]
2339
destination.set_revision_history(new_history)
2342
def set_last_revision_info(self, revno, revision_id):
2343
"""Set the last revision of this branch.
2345
The caller is responsible for checking that the revno is correct
2346
for this revision id.
2348
It may be possible to set the branch last revision to an id not
2349
present in the repository. However, branches can also be
2350
configured to check constraints on history, in which case this may not
2353
revision_id = _mod_revision.ensure_null(revision_id)
2354
# this old format stores the full history, but this api doesn't
2355
# provide it, so we must generate, and might as well check it's
2357
history = self._lefthand_history(revision_id)
2358
if len(history) != revno:
2359
raise AssertionError('%d != %d' % (len(history), revno))
2360
self.set_revision_history(history)
2362
def _gen_revision_history(self):
2363
history = self._transport.get_bytes('revision-history').split('\n')
2364
if history[-1:] == ['']:
2365
# There shouldn't be a trailing newline, but just in case.
2370
def generate_revision_history(self, revision_id, last_rev=None,
2372
"""Create a new revision history that will finish with revision_id.
2374
:param revision_id: the new tip to use.
2375
:param last_rev: The previous last_revision. If not None, then this
2376
must be a ancestory of revision_id, or DivergedBranches is raised.
2377
:param other_branch: The other branch that DivergedBranches should
2378
raise with respect to.
2380
self.set_revision_history(self._lefthand_history(revision_id,
2381
last_rev, other_branch))
2383
def basis_tree(self):
2384
"""See Branch.basis_tree."""
2385
return self.repository.revision_tree(self.last_revision())
2387
def _get_parent_location(self):
2388
_locs = ['parent', 'pull', 'x-pull']
2391
return self._transport.get_bytes(l).strip('\n')
2392
except errors.NoSuchFile:
2396
def _basic_push(self, target, overwrite, stop_revision):
2397
"""Basic implementation of push without bound branches or hooks.
2399
Must be called with source read locked and target write locked.
2401
result = BranchPushResult()
2402
result.source_branch = self
2403
result.target_branch = target
2404
result.old_revno, result.old_revid = target.last_revision_info()
2405
self.update_references(target)
2406
if result.old_revid != self.last_revision():
2407
# We assume that during 'push' this repository is closer than
2409
graph = self.repository.get_graph(target.repository)
2410
target.update_revisions(self, stop_revision,
2411
overwrite=overwrite, graph=graph)
2412
if self._push_should_merge_tags():
2413
result.tag_conflicts = self.tags.merge_to(target.tags,
2415
result.new_revno, result.new_revid = target.last_revision_info()
2418
def get_stacked_on_url(self):
2419
raise errors.UnstackableBranchFormat(self._format, self.base)
2421
def set_push_location(self, location):
2422
"""See Branch.set_push_location."""
2423
self.get_config().set_user_option(
2424
'push_location', location,
2425
store=_mod_config.STORE_LOCATION_NORECURSE)
2427
def _set_parent_location(self, url):
2429
self._transport.delete('parent')
2431
self._transport.put_bytes('parent', url + '\n',
2432
mode=self.bzrdir._get_file_mode())
2435
class BzrBranch5(BzrBranch):
2436
"""A format 5 branch. This supports new features over plain branches.
2438
It has support for a master_branch which is the data for bound branches.
2441
def get_bound_location(self):
2443
return self._transport.get_bytes('bound')[:-1]
2444
except errors.NoSuchFile:
2448
def get_master_branch(self, possible_transports=None):
2449
"""Return the branch we are bound to.
2451
:return: Either a Branch, or None
2453
This could memoise the branch, but if thats done
2454
it must be revalidated on each new lock.
2455
So for now we just don't memoise it.
2456
# RBC 20060304 review this decision.
2458
bound_loc = self.get_bound_location()
2462
return Branch.open(bound_loc,
2463
possible_transports=possible_transports)
2464
except (errors.NotBranchError, errors.ConnectionError), e:
2465
raise errors.BoundBranchConnectionFailure(
2469
def set_bound_location(self, location):
2470
"""Set the target where this branch is bound to.
2472
:param location: URL to the target branch
2475
self._transport.put_bytes('bound', location+'\n',
2476
mode=self.bzrdir._get_file_mode())
2479
self._transport.delete('bound')
2480
except errors.NoSuchFile:
2485
def bind(self, other):
2486
"""Bind this branch to the branch other.
2488
This does not push or pull data between the branches, though it does
2489
check for divergence to raise an error when the branches are not
2490
either the same, or one a prefix of the other. That behaviour may not
2491
be useful, so that check may be removed in future.
2493
:param other: The branch to bind to
2496
# TODO: jam 20051230 Consider checking if the target is bound
2497
# It is debatable whether you should be able to bind to
2498
# a branch which is itself bound.
2499
# Committing is obviously forbidden,
2500
# but binding itself may not be.
2501
# Since we *have* to check at commit time, we don't
2502
# *need* to check here
2504
# we want to raise diverged if:
2505
# last_rev is not in the other_last_rev history, AND
2506
# other_last_rev is not in our history, and do it without pulling
2508
self.set_bound_location(other.base)
2512
"""If bound, unbind"""
2513
return self.set_bound_location(None)
2516
def update(self, possible_transports=None):
2517
"""Synchronise this branch with the master branch if any.
2519
:return: None or the last_revision that was pivoted out during the
2522
master = self.get_master_branch(possible_transports)
2523
if master is not None:
2524
old_tip = _mod_revision.ensure_null(self.last_revision())
2525
self.pull(master, overwrite=True)
2526
if self.repository.get_graph().is_ancestor(old_tip,
2527
_mod_revision.ensure_null(self.last_revision())):
2533
class BzrBranch8(BzrBranch5):
2534
"""A branch that stores tree-reference locations."""
2536
def _open_hook(self):
2537
if self._ignore_fallbacks:
2540
url = self.get_stacked_on_url()
2541
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2542
errors.UnstackableBranchFormat):
895
revs = self.revision_history()
896
if isinstance(revision, int):
899
# Mabye we should do this first, but we don't need it if revision == 0
901
revno = len(revs) + revision + 1
904
elif isinstance(revision, basestring):
905
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
906
if revision.startswith(prefix):
907
revno = func(self, revs, revision)
910
raise BzrError('No namespace registered for string: %r' % revision)
912
if revno is None or revno <= 0 or revno > len(revs):
913
raise BzrError("no such revision %s" % revision)
914
return revno, revs[revno-1]
916
def _namespace_revno(self, revs, revision):
917
"""Lookup a revision by revision number"""
918
assert revision.startswith('revno:')
920
return int(revision[6:])
923
REVISION_NAMESPACES['revno:'] = _namespace_revno
925
def _namespace_revid(self, revs, revision):
926
assert revision.startswith('revid:')
928
return revs.index(revision[6:]) + 1
931
REVISION_NAMESPACES['revid:'] = _namespace_revid
933
def _namespace_last(self, revs, revision):
934
assert revision.startswith('last:')
936
offset = int(revision[5:])
941
raise BzrError('You must supply a positive value for --revision last:XXX')
942
return len(revs) - offset + 1
943
REVISION_NAMESPACES['last:'] = _namespace_last
945
def _namespace_tag(self, revs, revision):
946
assert revision.startswith('tag:')
947
raise BzrError('tag: namespace registered, but not implemented.')
948
REVISION_NAMESPACES['tag:'] = _namespace_tag
950
def _namespace_date(self, revs, revision):
951
assert revision.startswith('date:')
953
# Spec for date revisions:
955
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
956
# it can also start with a '+/-/='. '+' says match the first
957
# entry after the given date. '-' is match the first entry before the date
958
# '=' is match the first entry after, but still on the given date.
960
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
961
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
962
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
963
# May 13th, 2005 at 0:00
965
# So the proper way of saying 'give me all entries for today' is:
966
# -r {date:+today}:{date:-tomorrow}
967
# The default is '=' when not supplied
970
if val[:1] in ('+', '-', '='):
971
match_style = val[:1]
974
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
975
if val.lower() == 'yesterday':
976
dt = today - datetime.timedelta(days=1)
977
elif val.lower() == 'today':
979
elif val.lower() == 'tomorrow':
980
dt = today + datetime.timedelta(days=1)
983
# This should be done outside the function to avoid recompiling it.
984
_date_re = re.compile(
985
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
987
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
989
m = _date_re.match(val)
990
if not m or (not m.group('date') and not m.group('time')):
991
raise BzrError('Invalid revision date %r' % revision)
994
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
996
year, month, day = today.year, today.month, today.day
998
hour = int(m.group('hour'))
999
minute = int(m.group('minute'))
1000
if m.group('second'):
1001
second = int(m.group('second'))
1005
hour, minute, second = 0,0,0
1007
dt = datetime.datetime(year=year, month=month, day=day,
1008
hour=hour, minute=minute, second=second)
1012
if match_style == '-':
1014
elif match_style == '=':
1015
last = dt + datetime.timedelta(days=1)
1018
for i in range(len(revs)-1, -1, -1):
1019
r = self.get_revision(revs[i])
1020
# TODO: Handle timezone.
1021
dt = datetime.datetime.fromtimestamp(r.timestamp)
1022
if first >= dt and (last is None or dt >= last):
1025
for i in range(len(revs)):
1026
r = self.get_revision(revs[i])
1027
# TODO: Handle timezone.
1028
dt = datetime.datetime.fromtimestamp(r.timestamp)
1029
if first <= dt and (last is None or dt <= last):
1031
REVISION_NAMESPACES['date:'] = _namespace_date
1033
def revision_tree(self, revision_id):
1034
"""Return Tree for a revision on this branch.
1036
`revision_id` may be None for the null revision, in which case
1037
an `EmptyTree` is returned."""
1038
# TODO: refactor this to use an existing revision object
1039
# so we don't need to read it in twice.
1040
if revision_id == None:
1043
inv = self.get_revision_inventory(revision_id)
1044
return RevisionTree(self.text_store, inv)
1047
def working_tree(self):
1048
"""Return a `Tree` for the working copy."""
1049
from workingtree import WorkingTree
1050
return WorkingTree(self.base, self.read_working_inventory())
1053
def basis_tree(self):
1054
"""Return `Tree` object for last revision.
1056
If there are no revisions yet, return an `EmptyTree`.
1058
r = self.last_patch()
1062
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1066
def rename_one(self, from_rel, to_rel):
1069
This can change the directory or the filename or both.
1073
tree = self.working_tree()
1074
inv = tree.inventory
1075
if not tree.has_filename(from_rel):
1076
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1077
if tree.has_filename(to_rel):
1078
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1080
file_id = inv.path2id(from_rel)
1082
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1084
if inv.path2id(to_rel):
1085
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1087
to_dir, to_tail = os.path.split(to_rel)
1088
to_dir_id = inv.path2id(to_dir)
1089
if to_dir_id == None and to_dir != '':
1090
raise BzrError("can't determine destination directory id for %r" % to_dir)
1092
mutter("rename_one:")
1093
mutter(" file_id {%s}" % file_id)
1094
mutter(" from_rel %r" % from_rel)
1095
mutter(" to_rel %r" % to_rel)
1096
mutter(" to_dir %r" % to_dir)
1097
mutter(" to_dir_id {%s}" % to_dir_id)
1099
inv.rename(file_id, to_dir_id, to_tail)
1101
print "%s => %s" % (from_rel, to_rel)
1103
from_abs = self.abspath(from_rel)
1104
to_abs = self.abspath(to_rel)
1106
os.rename(from_abs, to_abs)
1108
raise BzrError("failed to rename %r to %r: %s"
1109
% (from_abs, to_abs, e[1]),
1110
["rename rolled back"])
1112
self._write_inventory(inv)
1117
def move(self, from_paths, to_name):
1120
to_name must exist as a versioned directory.
1122
If to_name exists and is a directory, the files are moved into
1123
it, keeping their old names. If it is a directory,
1125
Note that to_name is only the last component of the new name;
1126
this doesn't change the directory.
1130
## TODO: Option to move IDs only
1131
assert not isinstance(from_paths, basestring)
1132
tree = self.working_tree()
1133
inv = tree.inventory
1134
to_abs = self.abspath(to_name)
1135
if not isdir(to_abs):
1136
raise BzrError("destination %r is not a directory" % to_abs)
1137
if not tree.has_filename(to_name):
1138
raise BzrError("destination %r not in working directory" % to_abs)
1139
to_dir_id = inv.path2id(to_name)
1140
if to_dir_id == None and to_name != '':
1141
raise BzrError("destination %r is not a versioned directory" % to_name)
1142
to_dir_ie = inv[to_dir_id]
1143
if to_dir_ie.kind not in ('directory', 'root_directory'):
1144
raise BzrError("destination %r is not a directory" % to_abs)
1146
to_idpath = inv.get_idpath(to_dir_id)
1148
for f in from_paths:
1149
if not tree.has_filename(f):
1150
raise BzrError("%r does not exist in working tree" % f)
1151
f_id = inv.path2id(f)
1153
raise BzrError("%r is not versioned" % f)
1154
name_tail = splitpath(f)[-1]
1155
dest_path = appendpath(to_name, name_tail)
1156
if tree.has_filename(dest_path):
1157
raise BzrError("destination %r already exists" % dest_path)
1158
if f_id in to_idpath:
1159
raise BzrError("can't move %r to a subdirectory of itself" % f)
1161
# OK, so there's a race here, it's possible that someone will
1162
# create a file in this interval and then the rename might be
1163
# left half-done. But we should have caught most problems.
1165
for f in from_paths:
1166
name_tail = splitpath(f)[-1]
1167
dest_path = appendpath(to_name, name_tail)
1168
print "%s => %s" % (f, dest_path)
1169
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1171
os.rename(self.abspath(f), self.abspath(dest_path))
1173
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1174
["rename rolled back"])
1176
self._write_inventory(inv)
1181
def revert(self, filenames, old_tree=None, backups=True):
1182
"""Restore selected files to the versions from a previous tree.
1185
If true (default) backups are made of files before
1188
from bzrlib.errors import NotVersionedError, BzrError
1189
from bzrlib.atomicfile import AtomicFile
1190
from bzrlib.osutils import backup_file
1192
inv = self.read_working_inventory()
1193
if old_tree is None:
1194
old_tree = self.basis_tree()
1195
old_inv = old_tree.inventory
1198
for fn in filenames:
1199
file_id = inv.path2id(fn)
1201
raise NotVersionedError("not a versioned file", fn)
1202
if not old_inv.has_id(file_id):
1203
raise BzrError("file not present in old tree", fn, file_id)
1204
nids.append((fn, file_id))
1206
# TODO: Rename back if it was previously at a different location
1208
# TODO: If given a directory, restore the entire contents from
1209
# the previous version.
1211
# TODO: Make a backup to a temporary file.
1213
# TODO: If the file previously didn't exist, delete it?
1214
for fn, file_id in nids:
1217
f = AtomicFile(fn, 'wb')
1219
f.write(old_tree.get_file(file_id).read())
1225
def pending_merges(self):
1226
"""Return a list of pending merges.
1228
These are revisions that have been merged into the working
1229
directory but not yet committed.
1231
cfn = self.controlfilename('pending-merges')
1232
if not os.path.exists(cfn):
1235
for l in self.controlfile('pending-merges', 'r').readlines():
1236
p.append(l.rstrip('\n'))
1240
def add_pending_merge(self, revision_id):
1241
from bzrlib.revision import validate_revision_id
1243
validate_revision_id(revision_id)
1245
p = self.pending_merges()
1246
if revision_id in p:
2545
for hook in Branch.hooks['transform_fallback_location']:
2546
url = hook(self, url)
2548
hook_name = Branch.hooks.get_hook_name(hook)
2549
raise AssertionError(
2550
"'transform_fallback_location' hook %s returned "
2551
"None, not a URL." % hook_name)
2552
self._activate_fallback_location(url)
2554
def __init__(self, *args, **kwargs):
2555
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2556
super(BzrBranch8, self).__init__(*args, **kwargs)
2557
self._last_revision_info_cache = None
2558
self._reference_info = None
2560
def _clear_cached_state(self):
2561
super(BzrBranch8, self)._clear_cached_state()
2562
self._last_revision_info_cache = None
2563
self._reference_info = None
2565
def _last_revision_info(self):
2566
revision_string = self._transport.get_bytes('last-revision')
2567
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2568
revision_id = cache_utf8.get_cached_utf8(revision_id)
2570
return revno, revision_id
2572
def _write_last_revision_info(self, revno, revision_id):
2573
"""Simply write out the revision id, with no checks.
2575
Use set_last_revision_info to perform this safely.
2577
Does not update the revision_history cache.
2578
Intended to be called by set_last_revision_info and
2579
_write_revision_history.
2581
revision_id = _mod_revision.ensure_null(revision_id)
2582
out_string = '%d %s\n' % (revno, revision_id)
2583
self._transport.put_bytes('last-revision', out_string,
2584
mode=self.bzrdir._get_file_mode())
2587
def set_last_revision_info(self, revno, revision_id):
2588
revision_id = _mod_revision.ensure_null(revision_id)
2589
old_revno, old_revid = self.last_revision_info()
2590
if self._get_append_revisions_only():
2591
self._check_history_violation(revision_id)
2592
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2593
self._write_last_revision_info(revno, revision_id)
2594
self._clear_cached_state()
2595
self._last_revision_info_cache = revno, revision_id
2596
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2598
def _synchronize_history(self, destination, revision_id):
2599
"""Synchronize last revision and revision history between branches.
2601
:see: Branch._synchronize_history
2603
# XXX: The base Branch has a fast implementation of this method based
2604
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2605
# that uses set_revision_history. This class inherits from BzrBranch5,
2606
# but wants the fast implementation, so it calls
2607
# Branch._synchronize_history directly.
2608
Branch._synchronize_history(self, destination, revision_id)
2610
def _check_history_violation(self, revision_id):
2611
last_revision = _mod_revision.ensure_null(self.last_revision())
2612
if _mod_revision.is_null(last_revision):
1248
p.append(revision_id)
1249
self.set_pending_merges(p)
1252
def set_pending_merges(self, rev_list):
1253
from bzrlib.atomicfile import AtomicFile
2614
if last_revision not in self._lefthand_history(revision_id):
2615
raise errors.AppendRevisionsOnlyViolation(self.base)
2617
def _gen_revision_history(self):
2618
"""Generate the revision history from last revision
2620
last_revno, last_revision = self.last_revision_info()
2621
self._extend_partial_history(stop_index=last_revno-1)
2622
return list(reversed(self._partial_revision_history_cache))
2624
def _write_revision_history(self, history):
2625
"""Factored out of set_revision_history.
2627
This performs the actual writing to disk, with format-specific checks.
2628
It is intended to be called by BzrBranch5.set_revision_history.
2630
if len(history) == 0:
2631
last_revision = 'null:'
2633
if history != self._lefthand_history(history[-1]):
2634
raise errors.NotLefthandHistory(history)
2635
last_revision = history[-1]
2636
if self._get_append_revisions_only():
2637
self._check_history_violation(last_revision)
2638
self._write_last_revision_info(len(history), last_revision)
2641
def _set_parent_location(self, url):
2642
"""Set the parent branch"""
2643
self._set_config_location('parent_location', url, make_relative=True)
2646
def _get_parent_location(self):
2647
"""Set the parent branch"""
2648
return self._get_config_location('parent_location')
2651
def _set_all_reference_info(self, info_dict):
2652
"""Replace all reference info stored in a branch.
2654
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2657
writer = rio.RioWriter(s)
2658
for key, (tree_path, branch_location) in info_dict.iteritems():
2659
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2660
branch_location=branch_location)
2661
writer.write_stanza(stanza)
2662
self._transport.put_bytes('references', s.getvalue())
2663
self._reference_info = info_dict
2666
def _get_all_reference_info(self):
2667
"""Return all the reference info stored in a branch.
2669
:return: A dict of {file_id: (tree_path, branch_location)}
2671
if self._reference_info is not None:
2672
return self._reference_info
2673
rio_file = self._transport.get('references')
1256
f = AtomicFile(self.controlfilename('pending-merges'))
2675
stanzas = rio.read_stanzas(rio_file)
2676
info_dict = dict((s['file_id'], (s['tree_path'],
2677
s['branch_location'])) for s in stanzas)
1268
class ScratchBranch(Branch):
1269
"""Special test class: a branch that cleans up after itself.
1271
>>> b = ScratchBranch()
2680
self._reference_info = info_dict
2683
def set_reference_info(self, file_id, tree_path, branch_location):
2684
"""Set the branch location to use for a tree reference.
2686
:param file_id: The file-id of the tree reference.
2687
:param tree_path: The path of the tree reference in the tree.
2688
:param branch_location: The location of the branch to retrieve tree
2691
info_dict = self._get_all_reference_info()
2692
info_dict[file_id] = (tree_path, branch_location)
2693
if None in (tree_path, branch_location):
2694
if tree_path is not None:
2695
raise ValueError('tree_path must be None when branch_location'
2697
if branch_location is not None:
2698
raise ValueError('branch_location must be None when tree_path'
2700
del info_dict[file_id]
2701
self._set_all_reference_info(info_dict)
2703
def get_reference_info(self, file_id):
2704
"""Get the tree_path and branch_location for a tree reference.
2706
:return: a tuple of (tree_path, branch_location)
2708
return self._get_all_reference_info().get(file_id, (None, None))
2710
def reference_parent(self, file_id, path, possible_transports=None):
2711
"""Return the parent branch for a tree-reference file_id.
2713
:param file_id: The file_id of the tree reference
2714
:param path: The path of the file_id in the tree
2715
:return: A branch associated with the file_id
2717
branch_location = self.get_reference_info(file_id)[1]
2718
if branch_location is None:
2719
return Branch.reference_parent(self, file_id, path,
2720
possible_transports)
2721
branch_location = urlutils.join(self.base, branch_location)
2722
return Branch.open(branch_location,
2723
possible_transports=possible_transports)
2725
def set_push_location(self, location):
2726
"""See Branch.set_push_location."""
2727
self._set_config_location('push_location', location)
2729
def set_bound_location(self, location):
2730
"""See Branch.set_push_location."""
2732
config = self.get_config()
2733
if location is None:
2734
if config.get_user_option('bound') != 'True':
2737
config.set_user_option('bound', 'False', warn_masked=True)
2740
self._set_config_location('bound_location', location,
2742
config.set_user_option('bound', 'True', warn_masked=True)
2745
def _get_bound_location(self, bound):
2746
"""Return the bound location in the config file.
2748
Return None if the bound parameter does not match"""
2749
config = self.get_config()
2750
config_bound = (config.get_user_option('bound') == 'True')
2751
if config_bound != bound:
2753
return self._get_config_location('bound_location', config=config)
2755
def get_bound_location(self):
2756
"""See Branch.set_push_location."""
2757
return self._get_bound_location(True)
2759
def get_old_bound_location(self):
2760
"""See Branch.get_old_bound_location"""
2761
return self._get_bound_location(False)
2763
def get_stacked_on_url(self):
2764
# you can always ask for the URL; but you might not be able to use it
2765
# if the repo can't support stacking.
2766
## self._check_stackable_repo()
2767
stacked_url = self._get_config_location('stacked_on_location')
2768
if stacked_url is None:
2769
raise errors.NotStacked(self)
2772
def _get_append_revisions_only(self):
2773
value = self.get_config().get_user_option('append_revisions_only')
2774
return value == 'True'
2777
def generate_revision_history(self, revision_id, last_rev=None,
2779
"""See BzrBranch5.generate_revision_history"""
2780
history = self._lefthand_history(revision_id, last_rev, other_branch)
2781
revno = len(history)
2782
self.set_last_revision_info(revno, revision_id)
2785
def get_rev_id(self, revno, history=None):
2786
"""Find the revision id of the specified revno."""
2788
return _mod_revision.NULL_REVISION
2790
last_revno, last_revision_id = self.last_revision_info()
2791
if revno <= 0 or revno > last_revno:
2792
raise errors.NoSuchRevision(self, revno)
2794
if history is not None:
2795
return history[revno - 1]
2797
index = last_revno - revno
2798
if len(self._partial_revision_history_cache) <= index:
2799
self._extend_partial_history(stop_index=index)
2800
if len(self._partial_revision_history_cache) > index:
2801
return self._partial_revision_history_cache[index]
2803
raise errors.NoSuchRevision(self, revno)
2806
def revision_id_to_revno(self, revision_id):
2807
"""Given a revision id, return its revno"""
2808
if _mod_revision.is_null(revision_id):
2811
index = self._partial_revision_history_cache.index(revision_id)
2813
self._extend_partial_history(stop_revision=revision_id)
2814
index = len(self._partial_revision_history_cache) - 1
2815
if self._partial_revision_history_cache[index] != revision_id:
2816
raise errors.NoSuchRevision(self, revision_id)
2817
return self.revno() - index
2820
class BzrBranch7(BzrBranch8):
2821
"""A branch with support for a fallback repository."""
2823
def set_reference_info(self, file_id, tree_path, branch_location):
2824
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2826
def get_reference_info(self, file_id):
2827
Branch.get_reference_info(self, file_id)
2829
def reference_parent(self, file_id, path, possible_transports=None):
2830
return Branch.reference_parent(self, file_id, path,
2831
possible_transports)
2834
class BzrBranch6(BzrBranch7):
2835
"""See BzrBranchFormat6 for the capabilities of this branch.
2837
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
1279
def __init__(self, files=[], dirs=[], base=None):
1280
"""Make a test branch.
1282
This creates a temporary directory and runs init-tree in it.
1284
If any files are listed, they are created in the working copy.
1286
from tempfile import mkdtemp
1291
Branch.__init__(self, base, init=init)
1293
os.mkdir(self.abspath(d))
1296
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1301
>>> orig = ScratchBranch(files=["file1", "file2"])
1302
>>> clone = orig.clone()
1303
>>> os.path.samefile(orig.base, clone.base)
1305
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1308
from shutil import copytree
1309
from tempfile import mkdtemp
1312
copytree(self.base, base, symlinks=True)
1313
return ScratchBranch(base=base)
1319
"""Destroy the test branch, removing the scratch directory."""
1320
from shutil import rmtree
1323
mutter("delete ScratchBranch %s" % self.base)
1326
# Work around for shutil.rmtree failing on Windows when
1327
# readonly files are encountered
1328
mutter("hit exception in destroying ScratchBranch: %s" % e)
1329
for root, dirs, files in os.walk(self.base, topdown=False):
1331
os.chmod(os.path.join(root, name), 0700)
2841
def get_stacked_on_url(self):
2842
raise errors.UnstackableBranchFormat(self._format, self.base)
1337
2845
######################################################################
1341
def is_control_file(filename):
1342
## FIXME: better check
1343
filename = os.path.normpath(filename)
1344
while filename != '':
1345
head, tail = os.path.split(filename)
1346
## mutter('check %r for control file' % ((head, tail), ))
1347
if tail == bzrlib.BZRDIR:
1349
if filename == head:
1356
def gen_file_id(name):
1357
"""Return new file id.
1359
This should probably generate proper UUIDs, but for the moment we
1360
cope with just randomness because running uuidgen every time is
1363
from binascii import hexlify
1364
from time import time
1366
# get last component
1367
idx = name.rfind('/')
1369
name = name[idx+1 : ]
1370
idx = name.rfind('\\')
1372
name = name[idx+1 : ]
1374
# make it not a hidden file
1375
name = name.lstrip('.')
1377
# remove any wierd characters; we don't escape them but rather
1378
# just pull them out
1379
name = re.sub(r'[^\w.]', '', name)
1381
s = hexlify(rand_bytes(8))
1382
return '-'.join((name, compact_date(time()), s))
1386
"""Return a new tree-root file id."""
1387
return gen_file_id('TREE_ROOT')
2846
# results of operations
2849
class _Result(object):
2851
def _show_tag_conficts(self, to_file):
2852
if not getattr(self, 'tag_conflicts', None):
2854
to_file.write('Conflicting tags:\n')
2855
for name, value1, value2 in self.tag_conflicts:
2856
to_file.write(' %s\n' % (name, ))
2859
class PullResult(_Result):
2860
"""Result of a Branch.pull operation.
2862
:ivar old_revno: Revision number before pull.
2863
:ivar new_revno: Revision number after pull.
2864
:ivar old_revid: Tip revision id before pull.
2865
:ivar new_revid: Tip revision id after pull.
2866
:ivar source_branch: Source (local) branch object. (read locked)
2867
:ivar master_branch: Master branch of the target, or the target if no
2869
:ivar local_branch: target branch if there is a Master, else None
2870
:ivar target_branch: Target/destination branch object. (write locked)
2871
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2875
# DEPRECATED: pull used to return the change in revno
2876
return self.new_revno - self.old_revno
2878
def report(self, to_file):
2880
if self.old_revid == self.new_revid:
2881
to_file.write('No revisions to pull.\n')
2883
to_file.write('Now on revision %d.\n' % self.new_revno)
2884
self._show_tag_conficts(to_file)
2887
class BranchPushResult(_Result):
2888
"""Result of a Branch.push operation.
2890
:ivar old_revno: Revision number (eg 10) of the target before push.
2891
:ivar new_revno: Revision number (eg 12) of the target after push.
2892
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2894
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2896
:ivar source_branch: Source branch object that the push was from. This is
2897
read locked, and generally is a local (and thus low latency) branch.
2898
:ivar master_branch: If target is a bound branch, the master branch of
2899
target, or target itself. Always write locked.
2900
:ivar target_branch: The direct Branch where data is being sent (write
2902
:ivar local_branch: If the target is a bound branch this will be the
2903
target, otherwise it will be None.
2907
# DEPRECATED: push used to return the change in revno
2908
return self.new_revno - self.old_revno
2910
def report(self, to_file):
2911
"""Write a human-readable description of the result."""
2912
if self.old_revid == self.new_revid:
2913
note('No new revisions to push.')
2915
note('Pushed up to revision %d.' % self.new_revno)
2916
self._show_tag_conficts(to_file)
2919
class BranchCheckResult(object):
2920
"""Results of checking branch consistency.
2925
def __init__(self, branch):
2926
self.branch = branch
2929
def report_results(self, verbose):
2930
"""Report the check results via trace.note.
2932
:param verbose: Requests more detailed display of what was checked,
2935
note('checked branch %s format %s', self.branch.base,
2936
self.branch._format)
2937
for error in self.errors:
2938
note('found error:%s', error)
2941
class Converter5to6(object):
2942
"""Perform an in-place upgrade of format 5 to format 6"""
2944
def convert(self, branch):
2945
# Data for 5 and 6 can peacefully coexist.
2946
format = BzrBranchFormat6()
2947
new_branch = format.open(branch.bzrdir, _found=True)
2949
# Copy source data into target
2950
new_branch._write_last_revision_info(*branch.last_revision_info())
2951
new_branch.set_parent(branch.get_parent())
2952
new_branch.set_bound_location(branch.get_bound_location())
2953
new_branch.set_push_location(branch.get_push_location())
2955
# New branch has no tags by default
2956
new_branch.tags._set_tag_dict({})
2958
# Copying done; now update target format
2959
new_branch._transport.put_bytes('format',
2960
format.get_format_string(),
2961
mode=new_branch.bzrdir._get_file_mode())
2963
# Clean up old files
2964
new_branch._transport.delete('revision-history')
2966
branch.set_parent(None)
2967
except errors.NoSuchFile:
2969
branch.set_bound_location(None)
2972
class Converter6to7(object):
2973
"""Perform an in-place upgrade of format 6 to format 7"""
2975
def convert(self, branch):
2976
format = BzrBranchFormat7()
2977
branch._set_config_location('stacked_on_location', '')
2978
# update target format
2979
branch._transport.put_bytes('format', format.get_format_string())
2982
class Converter7to8(object):
2983
"""Perform an in-place upgrade of format 6 to format 7"""
2985
def convert(self, branch):
2986
format = BzrBranchFormat8()
2987
branch._transport.put_bytes('references', '')
2988
# update target format
2989
branch._transport.put_bytes('format', format.get_format_string())
2992
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2993
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2996
_run_with_write_locked_target will attempt to release the lock it acquires.
2998
If an exception is raised by callable, then that exception *will* be
2999
propagated, even if the unlock attempt raises its own error. Thus
3000
_run_with_write_locked_target should be preferred to simply doing::
3004
return callable(*args, **kwargs)
3009
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3010
# should share code?
3013
result = callable(*args, **kwargs)
3015
exc_info = sys.exc_info()
3019
raise exc_info[0], exc_info[1], exc_info[2]
3025
class InterBranch(InterObject):
3026
"""This class represents operations taking place between two branches.
3028
Its instances have methods like pull() and push() and contain
3029
references to the source and target repositories these operations
3030
can be carried out on.
3034
"""The available optimised InterBranch types."""
3037
def _get_branch_formats_to_test():
3038
"""Return a tuple with the Branch formats to use when testing."""
3039
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3041
def pull(self, overwrite=False, stop_revision=None,
3042
possible_transports=None, local=False):
3043
"""Mirror source into target branch.
3045
The target branch is considered to be 'local', having low latency.
3047
:returns: PullResult instance
3049
raise NotImplementedError(self.pull)
3051
def update_revisions(self, stop_revision=None, overwrite=False,
3053
"""Pull in new perfect-fit revisions.
3055
:param stop_revision: Updated until the given revision
3056
:param overwrite: Always set the branch pointer, rather than checking
3057
to see if it is a proper descendant.
3058
:param graph: A Graph object that can be used to query history
3059
information. This can be None.
3062
raise NotImplementedError(self.update_revisions)
3064
def push(self, overwrite=False, stop_revision=None,
3065
_override_hook_source_branch=None):
3066
"""Mirror the source branch into the target branch.
3068
The source branch is considered to be 'local', having low latency.
3070
raise NotImplementedError(self.push)
3073
class GenericInterBranch(InterBranch):
3074
"""InterBranch implementation that uses public Branch functions.
3078
def _get_branch_formats_to_test():
3079
return BranchFormat._default_format, BranchFormat._default_format
3081
def update_revisions(self, stop_revision=None, overwrite=False,
3083
"""See InterBranch.update_revisions()."""
3084
self.source.lock_read()
3086
other_revno, other_last_revision = self.source.last_revision_info()
3087
stop_revno = None # unknown
3088
if stop_revision is None:
3089
stop_revision = other_last_revision
3090
if _mod_revision.is_null(stop_revision):
3091
# if there are no commits, we're done.
3093
stop_revno = other_revno
3095
# what's the current last revision, before we fetch [and change it
3097
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3098
# we fetch here so that we don't process data twice in the common
3099
# case of having something to pull, and so that the check for
3100
# already merged can operate on the just fetched graph, which will
3101
# be cached in memory.
3102
self.target.fetch(self.source, stop_revision)
3103
# Check to see if one is an ancestor of the other
3106
graph = self.target.repository.get_graph()
3107
if self.target._check_if_descendant_or_diverged(
3108
stop_revision, last_rev, graph, self.source):
3109
# stop_revision is a descendant of last_rev, but we aren't
3110
# overwriting, so we're done.
3112
if stop_revno is None:
3114
graph = self.target.repository.get_graph()
3115
this_revno, this_last_revision = \
3116
self.target.last_revision_info()
3117
stop_revno = graph.find_distance_to_null(stop_revision,
3118
[(other_last_revision, other_revno),
3119
(this_last_revision, this_revno)])
3120
self.target.set_last_revision_info(stop_revno, stop_revision)
3122
self.source.unlock()
3124
def pull(self, overwrite=False, stop_revision=None,
3125
possible_transports=None, _hook_master=None, run_hooks=True,
3126
_override_hook_target=None, local=False):
3129
:param _hook_master: Private parameter - set the branch to
3130
be supplied as the master to pull hooks.
3131
:param run_hooks: Private parameter - if false, this branch
3132
is being called because it's the master of the primary branch,
3133
so it should not run its hooks.
3134
:param _override_hook_target: Private parameter - set the branch to be
3135
supplied as the target_branch to pull hooks.
3136
:param local: Only update the local branch, and not the bound branch.
3138
# This type of branch can't be bound.
3140
raise errors.LocalRequiresBoundBranch()
3141
result = PullResult()
3142
result.source_branch = self.source
3143
if _override_hook_target is None:
3144
result.target_branch = self.target
3146
result.target_branch = _override_hook_target
3147
self.source.lock_read()
3149
# We assume that during 'pull' the target repository is closer than
3151
self.source.update_references(self.target)
3152
graph = self.target.repository.get_graph(self.source.repository)
3153
# TODO: Branch formats should have a flag that indicates
3154
# that revno's are expensive, and pull() should honor that flag.
3156
result.old_revno, result.old_revid = \
3157
self.target.last_revision_info()
3158
self.target.update_revisions(self.source, stop_revision,
3159
overwrite=overwrite, graph=graph)
3160
# TODO: The old revid should be specified when merging tags,
3161
# so a tags implementation that versions tags can only
3162
# pull in the most recent changes. -- JRV20090506
3163
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3165
result.new_revno, result.new_revid = self.target.last_revision_info()
3167
result.master_branch = _hook_master
3168
result.local_branch = result.target_branch
3170
result.master_branch = result.target_branch
3171
result.local_branch = None
3173
for hook in Branch.hooks['post_pull']:
3176
self.source.unlock()
3179
def push(self, overwrite=False, stop_revision=None,
3180
_override_hook_source_branch=None):
3181
"""See InterBranch.push.
3183
This is the basic concrete implementation of push()
3185
:param _override_hook_source_branch: If specified, run
3186
the hooks passing this Branch as the source, rather than self.
3187
This is for use of RemoteBranch, where push is delegated to the
3188
underlying vfs-based Branch.
3190
# TODO: Public option to disable running hooks - should be trivial but
3192
self.source.lock_read()
3194
return _run_with_write_locked_target(
3195
self.target, self._push_with_bound_branches, overwrite,
3197
_override_hook_source_branch=_override_hook_source_branch)
3199
self.source.unlock()
3201
def _push_with_bound_branches(self, overwrite, stop_revision,
3202
_override_hook_source_branch=None):
3203
"""Push from source into target, and into target's master if any.
3206
if _override_hook_source_branch:
3207
result.source_branch = _override_hook_source_branch
3208
for hook in Branch.hooks['post_push']:
3211
bound_location = self.target.get_bound_location()
3212
if bound_location and self.target.base != bound_location:
3213
# there is a master branch.
3215
# XXX: Why the second check? Is it even supported for a branch to
3216
# be bound to itself? -- mbp 20070507
3217
master_branch = self.target.get_master_branch()
3218
master_branch.lock_write()
3220
# push into the master from the source branch.
3221
self.source._basic_push(master_branch, overwrite, stop_revision)
3222
# and push into the target branch from the source. Note that we
3223
# push from the source branch again, because its considered the
3224
# highest bandwidth repository.
3225
result = self.source._basic_push(self.target, overwrite,
3227
result.master_branch = master_branch
3228
result.local_branch = self.target
3232
master_branch.unlock()
3235
result = self.source._basic_push(self.target, overwrite,
3237
# TODO: Why set master_branch and local_branch if there's no
3238
# binding? Maybe cleaner to just leave them unset? -- mbp
3240
result.master_branch = self.target
3241
result.local_branch = None
3246
def is_compatible(self, source, target):
3247
# GenericBranch uses the public API, so always compatible
3251
class InterToBranch5(GenericInterBranch):
3254
def _get_branch_formats_to_test():
3255
return BranchFormat._default_format, BzrBranchFormat5()
3257
def pull(self, overwrite=False, stop_revision=None,
3258
possible_transports=None, run_hooks=True,
3259
_override_hook_target=None, local=False):
3260
"""Pull from source into self, updating my master if any.
3262
:param run_hooks: Private parameter - if false, this branch
3263
is being called because it's the master of the primary branch,
3264
so it should not run its hooks.
3266
bound_location = self.target.get_bound_location()
3267
if local and not bound_location:
3268
raise errors.LocalRequiresBoundBranch()
3269
master_branch = None
3270
if not local and bound_location and self.source.base != bound_location:
3271
# not pulling from master, so we need to update master.
3272
master_branch = self.target.get_master_branch(possible_transports)
3273
master_branch.lock_write()
3276
# pull from source into master.
3277
master_branch.pull(self.source, overwrite, stop_revision,
3279
return super(InterToBranch5, self).pull(overwrite,
3280
stop_revision, _hook_master=master_branch,
3281
run_hooks=run_hooks,
3282
_override_hook_target=_override_hook_target)
3285
master_branch.unlock()
3288
InterBranch.register_optimiser(GenericInterBranch)
3289
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
