67
70
entirely in memory.
69
72
For now, we are not treating MutableTree as an interface to provide
70
conformance tests for - rather we are testing MemoryTree specifically, and
73
conformance tests for - rather we are testing MemoryTree specifically, and
71
74
interface testing implementations of WorkingTree.
73
76
A mutable tree always has an associated Branch and BzrDir object - the
74
77
branch and bzrdir attributes.
79
def __init__(self, *args, **kw):
80
super(MutableTree, self).__init__(*args, **kw)
81
# Is this tree on a case-insensitive or case-preserving file-system?
82
# Sub-classes may initialize to False if they detect they are being
83
# used on media which doesn't differentiate the case of names.
84
self.case_sensitive = True
77
86
@needs_tree_write_lock
78
87
def add(self, files, ids=None, kinds=None):
108
121
ids = [None] * len(files)
110
assert(len(ids) == len(files))
111
ids = [osutils.safe_file_id(file_id) for file_id in ids]
123
if not (len(ids) == len(files)):
124
raise AssertionError()
113
125
if kinds is None:
114
126
kinds = [None] * len(files)
116
assert(len(kinds) == len(files))
127
elif not len(kinds) == len(files):
128
raise AssertionError()
118
130
# generic constraint checks:
119
131
if self.is_control_filename(f):
120
132
raise errors.ForbiddenControlFileError(filename=f)
121
133
fp = splitpath(f)
122
# fill out file kinds for all files [not needed when we stop
134
# fill out file kinds for all files [not needed when we stop
123
135
# caring about the instantaneous file kind within a uncommmitted tree
125
137
self._gather_kinds(files, kinds)
159
171
def apply_inventory_delta(self, changes):
160
172
"""Apply changes to the inventory as an atomic operation.
162
The argument is a set of changes to apply. It must describe a
163
valid result, but the order is not important. Specifically,
164
intermediate stages *may* be invalid, such as when two files
167
The changes should be structured as a list of tuples, of the form
168
(old_path, new_path, file_id, new_entry). For creation, old_path
169
must be None. For deletion, new_path and new_entry must be None.
170
file_id is always non-None. For renames and other mutations, all
171
values must be non-None.
173
If the new_entry is a directory, its children should be an empty
174
dict. Children are handled by apply_inventory_delta itself.
176
:param changes: A list of tuples for the change to apply:
177
[(old_path, new_path, file_id, new_inventory_entry), ...]
174
:param changes: An inventory delta to apply to the working tree's
177
:seealso Inventory.apply_delta: For details on the changes parameter.
180
180
inv = self.inventory
182
for old_path, file_id in sorted(((op, f) for op, np, f, e in changes
183
if op is not None), reverse=True):
184
if file_id not in inv:
186
children[file_id] = getattr(inv[file_id], 'children', {})
187
inv.remove_recursive_id(file_id)
188
for new_path, new_entry in sorted((np, e) for op, np, f, e in
189
changes if np is not None):
190
if getattr(new_entry, 'children', None) is not None:
191
new_entry.children = children.get(new_entry.file_id, {})
181
inv.apply_delta(changes)
193
182
self._write_inventory(inv)
195
184
@needs_write_lock
199
188
from bzrlib import commit
200
189
if revprops is None:
191
possible_master_transports=[]
202
192
if not 'branch-nick' in revprops:
203
revprops['branch-nick'] = self.branch.nick
193
revprops['branch-nick'] = self.branch._get_nick(
194
kwargs.get('local', False),
195
possible_master_transports)
196
authors = kwargs.pop('authors', None)
197
author = kwargs.pop('author', None)
198
if authors is not None:
199
if author is not None:
200
raise AssertionError('Specifying both author and authors '
201
'is not allowed. Specify just authors instead')
202
if 'author' in revprops or 'authors' in revprops:
203
# XXX: maybe we should just accept one of them?
204
raise AssertionError('author property given twice')
206
for individual in authors:
207
if '\n' in individual:
208
raise AssertionError('\\n is not a valid character '
209
'in an author identity')
210
revprops['authors'] = '\n'.join(authors)
211
if author is not None:
212
symbol_versioning.warn('The parameter author was deprecated'
213
' in version 1.13. Use authors instead',
215
if 'author' in revprops or 'authors' in revprops:
216
# XXX: maybe we should just accept one of them?
217
raise AssertionError('author property given twice')
219
raise AssertionError('\\n is not a valid character '
220
'in an author identity')
221
revprops['authors'] = author
204
222
# args for wt.commit start at message from the Commit.commit method,
205
223
args = (message, ) + args
224
for hook in MutableTree.hooks['start_commit']:
206
226
committed_id = commit.Commit().commit(working_tree=self,
207
revprops=revprops, *args, **kwargs)
228
possible_master_transports=possible_master_transports,
230
post_hook_params = PostCommitHookParams(self)
231
for hook in MutableTree.hooks['post_commit']:
232
hook(post_hook_params)
208
233
return committed_id
210
235
def _gather_kinds(self, files, kinds):
212
237
raise NotImplementedError(self._gather_kinds)
240
def has_changes(self, from_tree):
241
"""Quickly check that the tree contains at least one change.
243
:return: True if a change is found. False otherwise
245
changes = self.iter_changes(from_tree)
247
change = changes.next()
248
# Exclude root (talk about black magic... --vila 20090629)
249
if change[4] == (None, None):
250
change = changes.next()
252
except StopIteration:
215
257
def last_revision(self):
216
258
"""Return the revision id of the last commit performed in this tree.
218
260
In early tree formats the result of last_revision is the same as the
219
261
branch last_revision, but that is no longer the case for modern tree
222
264
last_revision returns the left most parent id, or None if there are no
258
300
raise NotImplementedError(self.mkdir)
302
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
303
"""Tell the tree we have observed a paths sha1.
305
The intent of this function is to allow trees that have a hashcache to
306
update the hashcache during commit. If the observed file is too new
307
(based on the stat_value) to be safely hash-cached the tree will ignore
310
The default implementation does nothing.
312
:param file_id: The file id
313
:param path: The file path
314
:param sha1: The sha 1 that was observed.
315
:param stat_value: A stat result for the file the sha1 was read from.
319
def _fix_case_of_inventory_path(self, path):
320
"""If our tree isn't case sensitive, return the canonical path"""
321
if not self.case_sensitive:
322
path = self.get_canonical_inventory_path(path)
326
def put_file_bytes_non_atomic(self, file_id, bytes):
327
"""Update the content of a file in the tree.
329
Note that the file is written in-place rather than being
330
written to a temporary location and renamed. As a consequence,
331
readers can potentially see the file half-written.
333
:param file_id: file-id of the file
334
:param bytes: the new file contents
336
raise NotImplementedError(self.put_file_bytes_non_atomic)
260
338
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
261
339
"""Set the parents ids of the working tree.
308
385
user_dirs = set()
310
# validate user file paths and convert all paths to tree
387
# validate user file paths and convert all paths to tree
311
388
# relative : it's cheaper to make a tree relative path an abspath
312
# than to convert an abspath to tree relative.
313
for filepath in file_list:
314
rf = _FastPath(self.relpath(filepath))
389
# than to convert an abspath to tree relative, and it's cheaper to
390
# perform the canonicalization in bulk.
391
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
392
rf = _FastPath(filepath)
315
393
# validate user parameters. Our recursive code avoids adding new files
316
# that need such validation
394
# that need such validation
317
395
if self.is_control_filename(rf.raw_path):
318
396
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
320
398
abspath = self.abspath(rf.raw_path)
321
399
kind = osutils.file_kind(abspath)
322
400
if kind == 'directory':
366
445
if not InventoryEntry.versionable_kind(kind):
367
446
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
448
if illegalpath_re.search(directory.raw_path):
449
warning("skipping %r (contains \\n or \\r)" % abspath)
370
452
if parent_ie is not None:
371
453
versioned = directory.base_path in parent_ie.children
373
# without the parent ie, use the relatively slower inventory
455
# without the parent ie, use the relatively slower inventory
375
versioned = inv.has_filename(directory.raw_path)
457
versioned = inv.has_filename(
458
self._fix_case_of_inventory_path(directory.raw_path))
377
460
if kind == 'directory':
409
492
# must be present:
410
493
this_ie = parent_ie.children[directory.base_path]
412
# without the parent ie, use the relatively slower inventory
495
# without the parent ie, use the relatively slower inventory
414
this_id = inv.path2id(directory.raw_path)
497
this_id = inv.path2id(
498
self._fix_case_of_inventory_path(directory.raw_path))
415
499
if this_id is None:
418
502
this_ie = inv[this_id]
420
504
for subf in sorted(os.listdir(abspath)):
421
# here we could use TreeDirectory rather than
505
# here we could use TreeDirectory rather than
422
506
# string concatenation.
423
507
subp = osutils.pathjoin(directory.raw_path, subf)
424
# TODO: is_control_filename is very slow. Make it faster.
425
# TreeDirectory.is_control_filename could also make this
426
# faster - its impossible for a non root dir to have a
508
# TODO: is_control_filename is very slow. Make it faster.
509
# TreeDirectory.is_control_filename could also make this
510
# faster - its impossible for a non root dir to have a
428
512
if self.is_control_filename(subp):
429
513
mutter("skip control directory %r", subp)
449
533
self.read_working_inventory()
450
534
return added, ignored
536
def update_basis_by_delta(self, new_revid, delta):
537
"""Update the parents of this tree after a commit.
539
This gives the tree one parent, with revision id new_revid. The
540
inventory delta is applied to the current basis tree to generate the
541
inventory for the parent new_revid, and all other parent trees are
544
All the changes in the delta should be changes synchronising the basis
545
tree with some or all of the working tree, with a change to a directory
546
requiring that its contents have been recursively included. That is,
547
this is not a general purpose tree modification routine, but a helper
548
for commit which is not required to handle situations that do not arise
551
See the inventory developers documentation for the theory behind
554
:param new_revid: The new revision id for the trees parent.
555
:param delta: An inventory delta (see apply_inventory_delta) describing
556
the changes from the current left most parent revision to new_revid.
558
# if the tree is updated by a pull to the branch, as happens in
559
# WorkingTree2, when there was no separation between branch and tree,
560
# then just clear merges, efficiency is not a concern for now as this
561
# is legacy environments only, and they are slow regardless.
562
if self.last_revision() == new_revid:
563
self.set_parent_ids([new_revid])
565
# generic implementation based on Inventory manipulation. See
566
# WorkingTree classes for optimised versions for specific format trees.
567
basis = self.basis_tree()
569
# TODO: Consider re-evaluating the need for this with CHKInventory
570
# we don't strictly need to mutate an inventory for this
571
# it only makes sense when apply_delta is cheaper than get_inventory()
572
inventory = basis.inventory._get_mutable_inventory()
574
inventory.apply_delta(delta)
575
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
576
self.set_parent_trees([(new_revid, rev_tree)])
579
class MutableTreeHooks(hooks.Hooks):
580
"""A dictionary mapping a hook name to a list of callables for mutabletree
585
"""Create the default hooks.
588
hooks.Hooks.__init__(self)
589
self.create_hook(hooks.HookPoint('start_commit',
590
"Called before a commit is performed on a tree. The start commit "
591
"hook is able to change the tree before the commit takes place. "
592
"start_commit is called with the bzrlib.mutabletree.MutableTree "
593
"that the commit is being performed on.", (1, 4), None))
594
self.create_hook(hooks.HookPoint('post_commit',
595
"Called after a commit is performed on a tree. The hook is "
596
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
597
"The mutable tree the commit was performed on is available via "
598
"the mutable_tree attribute of that object.", (2, 0), None))
601
# install the default hooks into the MutableTree class.
602
MutableTree.hooks = MutableTreeHooks()
605
class PostCommitHookParams(object):
606
"""Parameters for the post_commit hook.
608
To access the parameters, use the following attributes:
610
* mutable_tree - the MutableTree object
613
def __init__(self, mutable_tree):
614
"""Create the parameters for the post_commit hook."""
615
self.mutable_tree = mutable_tree
453
618
class _FastPath(object):
454
619
"""A path object with fast accessors for things like basename."""
added
removed
bzrlib/mutabletree.py
