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
193
204
# args for wt.commit start at message from the Commit.commit method,
194
205
args = (message, ) + args
195
for hook in MutableTree.hooks['start_commit']:
197
206
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)
207
revprops=revprops, *args, **kwargs)
204
208
return committed_id
206
210
def _gather_kinds(self, files, kinds):
208
212
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
215
def last_revision(self):
275
216
"""Return the revision id of the last commit performed in this tree.
277
218
In early tree formats the result of last_revision is the same as the
278
219
branch last_revision, but that is no longer the case for modern tree
281
222
last_revision returns the left most parent id, or None if there are no
317
258
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
260
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
356
261
"""Set the parents ids of the working tree.
375
280
This is designed more towards DWIM for humans than API clarity.
376
281
For the specific behaviour see the help for cmd_add().
378
:param file_list: List of zero or more paths. *NB: these are
379
interpreted relative to the process cwd, not relative to the
380
tree.* (Add and most other tree methods use tree-relative
382
283
:param action: A reporter to be called with the inventory, parent_ie,
383
path and kind of the path being added. It may return a file_id if
284
path and kind of the path being added. It may return a file_id if
384
285
a specific one should be used.
385
286
:param save: Save the inventory after completing the adds. If False
386
287
this provides dry-run functionality by doing the add and not saving
408
308
user_dirs = set()
409
conflicts_related = set()
410
# Not all mutable trees can have conflicts
411
if getattr(self, 'conflicts', None) is not None:
412
# Collect all related files without checking whether they exist or
413
# are versioned. It's cheaper to do that once for all conflicts
414
# than trying to find the relevant conflict for each added file.
415
for c in self.conflicts():
416
conflicts_related.update(c.associated_filenames())
418
# validate user file paths and convert all paths to tree
310
# validate user file paths and convert all paths to tree
419
311
# relative : it's cheaper to make a tree relative path an abspath
420
# than to convert an abspath to tree relative, and it's cheaper to
421
# perform the canonicalization in bulk.
422
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
423
rf = _FastPath(filepath)
424
# validate user parameters. Our recursive code avoids adding new
425
# files that need such validation
312
# than to convert an abspath to tree relative.
313
for filepath in file_list:
314
rf = _FastPath(self.relpath(filepath))
315
# validate user parameters. Our recursive code avoids adding new files
316
# that need such validation
426
317
if self.is_control_filename(rf.raw_path):
427
318
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
429
320
abspath = self.abspath(rf.raw_path)
430
321
kind = osutils.file_kind(abspath)
431
322
if kind == 'directory':
435
326
if not InventoryEntry.versionable_kind(kind):
436
327
raise errors.BadFileKindError(filename=abspath, kind=kind)
437
# ensure the named path is added, so that ignore rules in the later
438
# directory walk dont skip it.
439
# we dont have a parent ie known yet.: use the relatively slower
440
# inventory probing method
328
# ensure the named path is added, so that ignore rules in the later directory
330
# we dont have a parent ie known yet.: use the relatively slower inventory
441
332
versioned = inv.has_filename(rf.raw_path)
474
364
kind = osutils.file_kind(abspath)
476
366
if not InventoryEntry.versionable_kind(kind):
477
trace.warning("skipping %s (can't add file of kind '%s')",
480
if illegalpath_re.search(directory.raw_path):
481
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
483
if directory.raw_path in conflicts_related:
484
# If the file looks like one generated for a conflict, don't
487
'skipping %s (generated to help resolve conflicts)',
367
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
491
370
if parent_ie is not None:
492
371
versioned = directory.base_path in parent_ie.children
494
# without the parent ie, use the relatively slower inventory
373
# without the parent ie, use the relatively slower inventory
496
versioned = inv.has_filename(
497
self._fix_case_of_inventory_path(directory.raw_path))
375
versioned = inv.has_filename(directory.raw_path)
499
377
if kind == 'directory':
515
393
# mutter("%r is already versioned", abspath)
517
# XXX: This is wrong; people *might* reasonably be trying to
518
# add subtrees as subtrees. This should probably only be done
519
# in formats which can represent subtrees, and even then
520
# perhaps only when the user asked to add subtrees. At the
521
# moment you can add them specially through 'join --reference',
522
# which is perhaps reasonable: adding a new reference is a
523
# special operation and can have a special behaviour. mbp
525
trace.mutter("%r is a nested bzr tree", abspath)
395
# XXX: This is wrong; people *might* reasonably be trying to add
396
# subtrees as subtrees. This should probably only be done in formats
397
# which can represent subtrees, and even then perhaps only when
398
# the user asked to add subtrees. At the moment you can add them
399
# specially through 'join --reference', which is perhaps
400
# reasonable: adding a new reference is a special operation and
401
# can have a special behaviour. mbp 20070306
402
mutter("%r is a nested bzr tree", abspath)
527
404
_add_one(self, inv, parent_ie, directory, kind, action)
528
405
added.append(directory.raw_path)
532
409
# must be present:
533
410
this_ie = parent_ie.children[directory.base_path]
535
# without the parent ie, use the relatively slower inventory
412
# without the parent ie, use the relatively slower inventory
537
this_id = inv.path2id(
538
self._fix_case_of_inventory_path(directory.raw_path))
414
this_id = inv.path2id(directory.raw_path)
539
415
if this_id is None:
542
418
this_ie = inv[this_id]
544
420
for subf in sorted(os.listdir(abspath)):
545
# here we could use TreeDirectory rather than
421
# here we could use TreeDirectory rather than
546
422
# string concatenation.
547
423
subp = osutils.pathjoin(directory.raw_path, subf)
548
# TODO: is_control_filename is very slow. Make it faster.
549
# TreeDirectory.is_control_filename could also make this
550
# faster - its impossible for a non root dir to have a
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
552
428
if self.is_control_filename(subp):
553
trace.mutter("skip control directory %r", subp)
429
mutter("skip control directory %r", subp)
554
430
elif subf in this_ie.children:
555
431
# recurse into this already versioned subdir.
556
432
dirs_to_add.append((_FastPath(subp, subf), this_ie))
573
449
self.read_working_inventory()
574
450
return added, ignored
576
def update_basis_by_delta(self, new_revid, delta):
577
"""Update the parents of this tree after a commit.
579
This gives the tree one parent, with revision id new_revid. The
580
inventory delta is applied to the current basis tree to generate the
581
inventory for the parent new_revid, and all other parent trees are
584
All the changes in the delta should be changes synchronising the basis
585
tree with some or all of the working tree, with a change to a directory
586
requiring that its contents have been recursively included. That is,
587
this is not a general purpose tree modification routine, but a helper
588
for commit which is not required to handle situations that do not arise
591
See the inventory developers documentation for the theory behind
594
:param new_revid: The new revision id for the trees parent.
595
:param delta: An inventory delta (see apply_inventory_delta) describing
596
the changes from the current left most parent revision to new_revid.
598
# if the tree is updated by a pull to the branch, as happens in
599
# WorkingTree2, when there was no separation between branch and tree,
600
# then just clear merges, efficiency is not a concern for now as this
601
# is legacy environments only, and they are slow regardless.
602
if self.last_revision() == new_revid:
603
self.set_parent_ids([new_revid])
605
# generic implementation based on Inventory manipulation. See
606
# WorkingTree classes for optimised versions for specific format trees.
607
basis = self.basis_tree()
609
# TODO: Consider re-evaluating the need for this with CHKInventory
610
# we don't strictly need to mutate an inventory for this
611
# it only makes sense when apply_delta is cheaper than get_inventory()
612
inventory = basis.inventory._get_mutable_inventory()
614
inventory.apply_delta(delta)
615
rev_tree = revisiontree.RevisionTree(self.branch.repository,
616
inventory, new_revid)
617
self.set_parent_trees([(new_revid, rev_tree)])
620
class MutableTreeHooks(hooks.Hooks):
621
"""A dictionary mapping a hook name to a list of callables for mutabletree
626
"""Create the default hooks.
629
hooks.Hooks.__init__(self)
630
self.create_hook(hooks.HookPoint('start_commit',
631
"Called before a commit is performed on a tree. The start commit "
632
"hook is able to change the tree before the commit takes place. "
633
"start_commit is called with the bzrlib.mutabletree.MutableTree "
634
"that the commit is being performed on.", (1, 4), None))
635
self.create_hook(hooks.HookPoint('post_commit',
636
"Called after a commit is performed on a tree. The hook is "
637
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
638
"The mutable tree the commit was performed on is available via "
639
"the mutable_tree attribute of that object.", (2, 0), None))
642
# install the default hooks into the MutableTree class.
643
MutableTree.hooks = MutableTreeHooks()
646
class PostCommitHookParams(object):
647
"""Parameters for the post_commit hook.
649
To access the parameters, use the following attributes:
651
* mutable_tree - the MutableTree object
654
def __init__(self, mutable_tree):
655
"""Create the parameters for the post_commit hook."""
656
self.mutable_tree = mutable_tree
659
453
class _FastPath(object):
660
454
"""A path object with fast accessors for things like basename."""
697
491
# slower but does not need parent_ie
698
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
492
if inv.has_filename(path.raw_path):
700
494
# its really not there : add the parent
701
495
# note that the dirname use leads to some extra str copying etc but as
702
496
# there are a limited number of dirs we can be nested under, it should
703
497
# generally find it very fast and not recurse after that.
704
498
added = _add_one_and_parent(tree, inv, None,
705
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
706
parent_id = inv.path2id(osutils.dirname(path.raw_path))
499
_FastPath(dirname(path.raw_path)), 'directory', action)
500
parent_id = inv.path2id(dirname(path.raw_path))
707
501
parent_ie = inv[parent_id]
708
502
_add_one(tree, inv, parent_ie, path, kind, action)
709
503
return added + [path.raw_path]
added
removed
bzrlib/mutabletree.py
