66
67
entirely in memory.
68
69
For now, we are not treating MutableTree as an interface to provide
69
conformance tests for - rather we are testing MemoryTree specifically, and
70
conformance tests for - rather we are testing MemoryTree specifically, and
70
71
interface testing implementations of WorkingTree.
72
73
A mutable tree always has an associated Branch and BzrDir object - the
73
74
branch and bzrdir attributes.
75
def __init__(self, *args, **kw):
76
super(MutableTree, self).__init__(*args, **kw)
77
# Is this tree on a case-insensitive or case-preserving file-system?
78
# Sub-classes may initialize to False if they detect they are being
79
# used on media which doesn't differentiate the case of names.
80
self.case_sensitive = True
82
77
@needs_tree_write_lock
83
78
def add(self, files, ids=None, kinds=None):
117
108
ids = [None] * len(files)
119
if not (len(ids) == len(files)):
120
raise AssertionError()
110
assert(len(ids) == len(files))
111
ids = [osutils.safe_file_id(file_id) for file_id in ids]
121
113
if kinds is None:
122
114
kinds = [None] * len(files)
123
elif not len(kinds) == len(files):
124
raise AssertionError()
116
assert(len(kinds) == len(files))
126
118
# generic constraint checks:
127
119
if self.is_control_filename(f):
128
120
raise errors.ForbiddenControlFileError(filename=f)
129
fp = osutils.splitpath(f)
130
# fill out file kinds for all files [not needed when we stop
122
# fill out file kinds for all files [not needed when we stop
131
123
# caring about the instantaneous file kind within a uncommmitted tree
133
125
self._gather_kinds(files, kinds)
167
159
def apply_inventory_delta(self, changes):
168
160
"""Apply changes to the inventory as an atomic operation.
170
:param changes: An inventory delta to apply to the working tree's
173
:seealso Inventory.apply_delta: For details on the changes parameter.
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), ...]
176
180
inv = self.inventory
177
inv.apply_delta(changes)
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, {})
178
193
self._write_inventory(inv)
180
195
@needs_write_lock
183
198
# avoid circular imports
184
199
from bzrlib import commit
185
possible_master_transports=[]
186
revprops = commit.Commit.update_revprops(
189
kwargs.pop('authors', None),
190
kwargs.pop('author', None),
191
kwargs.get('local', False),
192
possible_master_transports)
202
if not 'branch-nick' in revprops:
203
revprops['branch-nick'] = self.branch.nick
204
author = kwargs.pop('author', None)
205
if author is not None:
206
assert 'author' not in revprops
207
revprops['author'] = author
193
208
# args for wt.commit start at message from the Commit.commit method,
194
209
args = (message, ) + args
195
for hook in MutableTree.hooks['start_commit']:
197
210
committed_id = commit.Commit().commit(working_tree=self,
199
possible_master_transports=possible_master_transports,
201
post_hook_params = PostCommitHookParams(self)
202
for hook in MutableTree.hooks['post_commit']:
203
hook(post_hook_params)
211
revprops=revprops, *args, **kwargs)
204
212
return committed_id
206
214
def _gather_kinds(self, files, kinds):
208
216
raise NotImplementedError(self._gather_kinds)
211
def has_changes(self, _from_tree=None):
212
"""Quickly check that the tree contains at least one commitable change.
214
:param _from_tree: tree to compare against to find changes (default to
215
the basis tree and is intended to be used by tests).
217
:return: True if a change is found. False otherwise
219
# Check pending merges
220
if len(self.get_parent_ids()) > 1:
222
if _from_tree is None:
223
_from_tree = self.basis_tree()
224
changes = self.iter_changes(_from_tree)
226
change = changes.next()
227
# Exclude root (talk about black magic... --vila 20090629)
228
if change[4] == (None, None):
229
change = changes.next()
231
except StopIteration:
236
def check_changed_or_out_of_date(self, strict, opt_name,
237
more_error, more_warning):
238
"""Check the tree for uncommitted changes and branch synchronization.
240
If strict is None and not set in the config files, a warning is issued.
241
If strict is True, an error is raised.
242
If strict is False, no checks are done and no warning is issued.
244
:param strict: True, False or None, searched in branch config if None.
246
:param opt_name: strict option name to search in config file.
248
:param more_error: Details about how to avoid the check.
250
:param more_warning: Details about what is happening.
253
strict = self.branch.get_config().get_user_option_as_bool(opt_name)
254
if strict is not False:
256
if (self.has_changes()):
257
err_class = errors.UncommittedChanges
258
elif self.last_revision() != self.branch.last_revision():
259
# The tree has lost sync with its branch, there is little
260
# chance that the user is aware of it but he can still force
261
# the action with --no-strict
262
err_class = errors.OutOfDateTree
263
if err_class is not None:
265
err = err_class(self, more=more_warning)
266
# We don't want to interrupt the user if he expressed no
267
# preference about strict.
268
trace.warning('%s', err._format())
270
err = err_class(self, more=more_error)
274
219
def last_revision(self):
275
220
"""Return the revision id of the last commit performed in this tree.
277
222
In early tree formats the result of last_revision is the same as the
278
223
branch last_revision, but that is no longer the case for modern tree
281
226
last_revision returns the left most parent id, or None if there are no
317
262
raise NotImplementedError(self.mkdir)
319
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
320
"""Tell the tree we have observed a paths sha1.
322
The intent of this function is to allow trees that have a hashcache to
323
update the hashcache during commit. If the observed file is too new
324
(based on the stat_value) to be safely hash-cached the tree will ignore
327
The default implementation does nothing.
329
:param file_id: The file id
330
:param path: The file path
331
:param sha1: The sha 1 that was observed.
332
:param stat_value: A stat result for the file the sha1 was read from.
336
def _fix_case_of_inventory_path(self, path):
337
"""If our tree isn't case sensitive, return the canonical path"""
338
if not self.case_sensitive:
339
path = self.get_canonical_inventory_path(path)
343
def put_file_bytes_non_atomic(self, file_id, bytes):
344
"""Update the content of a file in the tree.
346
Note that the file is written in-place rather than being
347
written to a temporary location and renamed. As a consequence,
348
readers can potentially see the file half-written.
350
:param file_id: file-id of the file
351
:param bytes: the new file contents
353
raise NotImplementedError(self.put_file_bytes_non_atomic)
355
264
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
356
265
"""Set the parents ids of the working tree.
404
312
user_dirs = set()
405
conflicts_related = set()
406
# Not all mutable trees can have conflicts
407
if getattr(self, 'conflicts', None) is not None:
408
# Collect all related files without checking whether they exist or
409
# are versioned. It's cheaper to do that once for all conflicts
410
# than trying to find the relevant conflict for each added file.
411
for c in self.conflicts():
412
conflicts_related.update(c.associated_filenames())
414
# validate user file paths and convert all paths to tree
314
# validate user file paths and convert all paths to tree
415
315
# relative : it's cheaper to make a tree relative path an abspath
416
# than to convert an abspath to tree relative, and it's cheaper to
417
# perform the canonicalization in bulk.
418
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
419
rf = _FastPath(filepath)
420
# validate user parameters. Our recursive code avoids adding new
421
# files that need such validation
316
# than to convert an abspath to tree relative.
317
for filepath in file_list:
318
rf = _FastPath(self.relpath(filepath))
319
# validate user parameters. Our recursive code avoids adding new files
320
# that need such validation
422
321
if self.is_control_filename(rf.raw_path):
423
322
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
425
324
abspath = self.abspath(rf.raw_path)
426
325
kind = osutils.file_kind(abspath)
427
326
if kind == 'directory':
431
330
if not InventoryEntry.versionable_kind(kind):
432
331
raise errors.BadFileKindError(filename=abspath, kind=kind)
433
# ensure the named path is added, so that ignore rules in the later
434
# directory walk dont skip it.
435
# we dont have a parent ie known yet.: use the relatively slower
436
# inventory probing method
332
# ensure the named path is added, so that ignore rules in the later directory
334
# we dont have a parent ie known yet.: use the relatively slower inventory
437
336
versioned = inv.has_filename(rf.raw_path)
470
368
kind = osutils.file_kind(abspath)
472
370
if not InventoryEntry.versionable_kind(kind):
473
trace.warning("skipping %s (can't add file of kind '%s')",
476
if illegalpath_re.search(directory.raw_path):
477
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
479
if directory.raw_path in conflicts_related:
480
# If the file looks like one generated for a conflict, don't
483
'skipping %s (generated to help resolve conflicts)',
371
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
487
374
if parent_ie is not None:
488
375
versioned = directory.base_path in parent_ie.children
490
# without the parent ie, use the relatively slower inventory
377
# without the parent ie, use the relatively slower inventory
492
versioned = inv.has_filename(
493
self._fix_case_of_inventory_path(directory.raw_path))
379
versioned = inv.has_filename(directory.raw_path)
495
381
if kind == 'directory':
511
397
# mutter("%r is already versioned", abspath)
513
# XXX: This is wrong; people *might* reasonably be trying to
514
# add subtrees as subtrees. This should probably only be done
515
# in formats which can represent subtrees, and even then
516
# perhaps only when the user asked to add subtrees. At the
517
# moment you can add them specially through 'join --reference',
518
# which is perhaps reasonable: adding a new reference is a
519
# special operation and can have a special behaviour. mbp
521
trace.mutter("%r is a nested bzr tree", abspath)
399
# XXX: This is wrong; people *might* reasonably be trying to add
400
# subtrees as subtrees. This should probably only be done in formats
401
# which can represent subtrees, and even then perhaps only when
402
# the user asked to add subtrees. At the moment you can add them
403
# specially through 'join --reference', which is perhaps
404
# reasonable: adding a new reference is a special operation and
405
# can have a special behaviour. mbp 20070306
406
mutter("%r is a nested bzr tree", abspath)
523
408
_add_one(self, inv, parent_ie, directory, kind, action)
524
409
added.append(directory.raw_path)
528
413
# must be present:
529
414
this_ie = parent_ie.children[directory.base_path]
531
# without the parent ie, use the relatively slower inventory
416
# without the parent ie, use the relatively slower inventory
533
this_id = inv.path2id(
534
self._fix_case_of_inventory_path(directory.raw_path))
418
this_id = inv.path2id(directory.raw_path)
535
419
if this_id is None:
538
422
this_ie = inv[this_id]
540
424
for subf in sorted(os.listdir(abspath)):
541
# here we could use TreeDirectory rather than
425
# here we could use TreeDirectory rather than
542
426
# string concatenation.
543
427
subp = osutils.pathjoin(directory.raw_path, subf)
544
# TODO: is_control_filename is very slow. Make it faster.
545
# TreeDirectory.is_control_filename could also make this
546
# faster - its impossible for a non root dir to have a
428
# TODO: is_control_filename is very slow. Make it faster.
429
# TreeDirectory.is_control_filename could also make this
430
# faster - its impossible for a non root dir to have a
548
432
if self.is_control_filename(subp):
549
trace.mutter("skip control directory %r", subp)
433
mutter("skip control directory %r", subp)
550
434
elif subf in this_ie.children:
551
435
# recurse into this already versioned subdir.
552
436
dirs_to_add.append((_FastPath(subp, subf), this_ie))
569
453
self.read_working_inventory()
570
454
return added, ignored
572
def update_basis_by_delta(self, new_revid, delta):
573
"""Update the parents of this tree after a commit.
575
This gives the tree one parent, with revision id new_revid. The
576
inventory delta is applied to the current basis tree to generate the
577
inventory for the parent new_revid, and all other parent trees are
580
All the changes in the delta should be changes synchronising the basis
581
tree with some or all of the working tree, with a change to a directory
582
requiring that its contents have been recursively included. That is,
583
this is not a general purpose tree modification routine, but a helper
584
for commit which is not required to handle situations that do not arise
587
See the inventory developers documentation for the theory behind
590
:param new_revid: The new revision id for the trees parent.
591
:param delta: An inventory delta (see apply_inventory_delta) describing
592
the changes from the current left most parent revision to new_revid.
594
# if the tree is updated by a pull to the branch, as happens in
595
# WorkingTree2, when there was no separation between branch and tree,
596
# then just clear merges, efficiency is not a concern for now as this
597
# is legacy environments only, and they are slow regardless.
598
if self.last_revision() == new_revid:
599
self.set_parent_ids([new_revid])
601
# generic implementation based on Inventory manipulation. See
602
# WorkingTree classes for optimised versions for specific format trees.
603
basis = self.basis_tree()
605
# TODO: Consider re-evaluating the need for this with CHKInventory
606
# we don't strictly need to mutate an inventory for this
607
# it only makes sense when apply_delta is cheaper than get_inventory()
608
inventory = basis.inventory._get_mutable_inventory()
610
inventory.apply_delta(delta)
611
rev_tree = revisiontree.RevisionTree(self.branch.repository,
612
inventory, new_revid)
613
self.set_parent_trees([(new_revid, rev_tree)])
616
class MutableTreeHooks(hooks.Hooks):
617
"""A dictionary mapping a hook name to a list of callables for mutabletree
622
"""Create the default hooks.
625
hooks.Hooks.__init__(self)
626
self.create_hook(hooks.HookPoint('start_commit',
627
"Called before a commit is performed on a tree. The start commit "
628
"hook is able to change the tree before the commit takes place. "
629
"start_commit is called with the bzrlib.mutabletree.MutableTree "
630
"that the commit is being performed on.", (1, 4), None))
631
self.create_hook(hooks.HookPoint('post_commit',
632
"Called after a commit is performed on a tree. The hook is "
633
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
634
"The mutable tree the commit was performed on is available via "
635
"the mutable_tree attribute of that object.", (2, 0), None))
638
# install the default hooks into the MutableTree class.
639
MutableTree.hooks = MutableTreeHooks()
642
class PostCommitHookParams(object):
643
"""Parameters for the post_commit hook.
645
To access the parameters, use the following attributes:
647
* mutable_tree - the MutableTree object
650
def __init__(self, mutable_tree):
651
"""Create the parameters for the post_commit hook."""
652
self.mutable_tree = mutable_tree
655
457
class _FastPath(object):
656
458
"""A path object with fast accessors for things like basename."""
693
495
# slower but does not need parent_ie
694
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
496
if inv.has_filename(path.raw_path):
696
498
# its really not there : add the parent
697
499
# note that the dirname use leads to some extra str copying etc but as
698
500
# there are a limited number of dirs we can be nested under, it should
699
501
# generally find it very fast and not recurse after that.
700
502
added = _add_one_and_parent(tree, inv, None,
701
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
702
parent_id = inv.path2id(osutils.dirname(path.raw_path))
503
_FastPath(dirname(path.raw_path)), 'directory', action)
504
parent_id = inv.path2id(dirname(path.raw_path))
703
505
parent_ie = inv[parent_id]
704
506
_add_one(tree, inv, parent_ie, path, kind, action)
705
507
return added + [path.raw_path]
added
removed
bzrlib/mutabletree.py
