66
65
entirely in memory.
68
67
For now, we are not treating MutableTree as an interface to provide
69
conformance tests for - rather we are testing MemoryTree specifically, and
68
conformance tests for - rather we are testing MemoryTree specifically, and
70
69
interface testing implementations of WorkingTree.
72
71
A mutable tree always has an associated Branch and BzrDir object - the
73
72
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
75
@needs_tree_write_lock
83
76
def add(self, files, ids=None, kinds=None):
117
106
ids = [None] * len(files)
119
if not (len(ids) == len(files)):
120
raise AssertionError()
108
assert(len(ids) == len(files))
109
ids = [osutils.safe_file_id(file_id) for file_id in ids]
121
111
if kinds is None:
122
112
kinds = [None] * len(files)
123
elif not len(kinds) == len(files):
124
raise AssertionError()
114
assert(len(kinds) == len(files))
126
116
# generic constraint checks:
127
117
if self.is_control_filename(f):
128
118
raise errors.ForbiddenControlFileError(filename=f)
129
fp = osutils.splitpath(f)
130
# fill out file kinds for all files [not needed when we stop
120
# fill out file kinds for all files [not needed when we stop
131
121
# caring about the instantaneous file kind within a uncommmitted tree
133
123
self._gather_kinds(files, kinds)
167
157
def apply_inventory_delta(self, changes):
168
158
"""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.
160
The argument is a set of changes to apply. It must describe a
161
valid result, but the order is not important. Specifically,
162
intermediate stages *may* be invalid, such as when two files
165
The changes should be structured as a list of tuples, of the form
166
(old_path, new_path, file_id, new_entry). For creation, old_path
167
must be None. For deletion, new_path and new_entry must be None.
168
file_id is always non-None. For renames and other mutations, all
169
values must be non-None.
171
If the new_entry is a directory, its children should be an empty
172
dict. Children are handled by apply_inventory_delta itself.
174
:param changes: A list of tuples for the change to apply:
175
[(old_path, new_path, file_id, new_inventory_entry), ...]
176
178
inv = self.inventory
177
inv.apply_delta(changes)
180
for old_path, file_id in sorted(((op, f) for op, np, f, e in changes
181
if op is not None), reverse=True):
182
if file_id not in inv:
184
children[file_id] = getattr(inv[file_id], 'children', {})
185
inv.remove_recursive_id(file_id)
186
for new_path, new_entry in sorted((np, e) for op, np, f, e in
187
changes if np is not None):
188
if getattr(new_entry, 'children', None) is not None:
189
new_entry.children = children.get(new_entry.file_id, {})
178
191
self._write_inventory(inv)
180
193
@needs_write_lock
184
197
from bzrlib import commit
185
198
if revprops is None:
187
possible_master_transports=[]
188
200
if not 'branch-nick' in revprops:
189
revprops['branch-nick'] = self.branch._get_nick(
190
kwargs.get('local', False),
191
possible_master_transports)
192
authors = kwargs.pop('authors', None)
193
author = kwargs.pop('author', None)
194
if authors is not None:
195
if author is not None:
196
raise AssertionError('Specifying both author and authors '
197
'is not allowed. Specify just authors instead')
198
if 'author' in revprops or 'authors' in revprops:
199
# XXX: maybe we should just accept one of them?
200
raise AssertionError('author property given twice')
202
for individual in authors:
203
if '\n' in individual:
204
raise AssertionError('\\n is not a valid character '
205
'in an author identity')
206
revprops['authors'] = '\n'.join(authors)
207
if author is not None:
208
symbol_versioning.warn('The parameter author was deprecated'
209
' in version 1.13. Use authors instead',
211
if 'author' in revprops or 'authors' in revprops:
212
# XXX: maybe we should just accept one of them?
213
raise AssertionError('author property given twice')
215
raise AssertionError('\\n is not a valid character '
216
'in an author identity')
217
revprops['authors'] = author
201
revprops['branch-nick'] = self.branch.nick
218
202
# args for wt.commit start at message from the Commit.commit method,
219
203
args = (message, ) + args
220
for hook in MutableTree.hooks['start_commit']:
222
204
committed_id = commit.Commit().commit(working_tree=self,
224
possible_master_transports=possible_master_transports,
226
post_hook_params = PostCommitHookParams(self)
227
for hook in MutableTree.hooks['post_commit']:
228
hook(post_hook_params)
205
revprops=revprops, *args, **kwargs)
229
206
return committed_id
231
208
def _gather_kinds(self, files, kinds):
233
210
raise NotImplementedError(self._gather_kinds)
236
def has_changes(self, _from_tree=None):
237
"""Quickly check that the tree contains at least one commitable change.
239
:param _from_tree: tree to compare against to find changes (default to
240
the basis tree and is intended to be used by tests).
242
:return: True if a change is found. False otherwise
244
# Check pending merges
245
if len(self.get_parent_ids()) > 1:
247
if _from_tree is None:
248
_from_tree = self.basis_tree()
249
changes = self.iter_changes(_from_tree)
251
change = changes.next()
252
# Exclude root (talk about black magic... --vila 20090629)
253
if change[4] == (None, None):
254
change = changes.next()
256
except StopIteration:
261
def check_changed_or_out_of_date(self, strict, opt_name,
262
more_error, more_warning):
263
"""Check the tree for uncommitted changes and branch synchronization.
265
If strict is None and not set in the config files, a warning is issued.
266
If strict is True, an error is raised.
267
If strict is False, no checks are done and no warning is issued.
269
:param strict: True, False or None, searched in branch config if None.
271
:param opt_name: strict option name to search in config file.
273
:param more_error: Details about how to avoid the check.
275
:param more_warning: Details about what is happening.
278
strict = self.branch.get_config().get_user_option_as_bool(opt_name)
279
if strict is not False:
281
if (self.has_changes()):
282
err_class = errors.UncommittedChanges
283
elif self.last_revision() != self.branch.last_revision():
284
# The tree has lost sync with its branch, there is little
285
# chance that the user is aware of it but he can still force
286
# the action with --no-strict
287
err_class = errors.OutOfDateTree
288
if err_class is not None:
290
err = err_class(self, more=more_warning)
291
# We don't want to interrupt the user if he expressed no
292
# preference about strict.
293
trace.warning('%s', err._format())
295
err = err_class(self, more=more_error)
299
213
def last_revision(self):
300
214
"""Return the revision id of the last commit performed in this tree.
302
216
In early tree formats the result of last_revision is the same as the
303
217
branch last_revision, but that is no longer the case for modern tree
306
220
last_revision returns the left most parent id, or None if there are no
342
256
raise NotImplementedError(self.mkdir)
344
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
345
"""Tell the tree we have observed a paths sha1.
347
The intent of this function is to allow trees that have a hashcache to
348
update the hashcache during commit. If the observed file is too new
349
(based on the stat_value) to be safely hash-cached the tree will ignore
352
The default implementation does nothing.
354
:param file_id: The file id
355
:param path: The file path
356
:param sha1: The sha 1 that was observed.
357
:param stat_value: A stat result for the file the sha1 was read from.
361
def _fix_case_of_inventory_path(self, path):
362
"""If our tree isn't case sensitive, return the canonical path"""
363
if not self.case_sensitive:
364
path = self.get_canonical_inventory_path(path)
368
def put_file_bytes_non_atomic(self, file_id, bytes):
369
"""Update the content of a file in the tree.
371
Note that the file is written in-place rather than being
372
written to a temporary location and renamed. As a consequence,
373
readers can potentially see the file half-written.
375
:param file_id: file-id of the file
376
:param bytes: the new file contents
378
raise NotImplementedError(self.put_file_bytes_non_atomic)
380
258
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
381
259
"""Set the parents ids of the working tree.
400
278
This is designed more towards DWIM for humans than API clarity.
401
279
For the specific behaviour see the help for cmd_add().
281
Returns the number of files added.
403
283
:param action: A reporter to be called with the inventory, parent_ie,
404
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
405
285
a specific one should be used.
406
286
:param save: Save the inventory after completing the adds. If False
407
287
this provides dry-run functionality by doing the add and not saving
409
:return: A tuple - files_added, ignored_files. files_added is the count
410
of added files, and ignored_files is a dict mapping files that were
411
ignored to the rule that caused them to be ignored.
288
the inventory. Note that the modified inventory is left in place,
289
allowing further dry-run tasks to take place. To restore the
290
original inventory call self.read_working_inventory().
413
292
# not in an inner loop; and we want to remove direct use of this,
414
293
# so here as a reminder for now. RBC 20070703
415
294
from bzrlib.inventory import InventoryEntry
295
assert isinstance(recurse, bool)
416
296
if action is None:
417
297
action = add.AddAction()
419
299
if not file_list:
420
300
# no paths supplied: add the entire tree.
421
# FIXME: this assumes we are running in a working tree subdir :-/
423
301
file_list = [u'.']
424
302
# mutter("smart add of %r")
425
303
inv = self.inventory
429
307
user_dirs = set()
430
conflicts_related = set()
431
# Not all mutable trees can have conflicts
432
if getattr(self, 'conflicts', None) is not None:
433
# Collect all related files without checking whether they exist or
434
# are versioned. It's cheaper to do that once for all conflicts
435
# than trying to find the relevant conflict for each added file.
436
for c in self.conflicts():
437
conflicts_related.update(c.associated_filenames())
439
# validate user file paths and convert all paths to tree
440
# relative : it's cheaper to make a tree relative path an abspath
441
# than to convert an abspath to tree relative, and it's cheaper to
442
# perform the canonicalization in bulk.
443
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
444
rf = _FastPath(filepath)
445
# validate user parameters. Our recursive code avoids adding new
446
# files that need such validation
309
# validate user file paths and convert all paths to tree
310
# relative : its cheaper to make a tree relative path an abspath
311
# than to convert an abspath to tree relative.
312
for filepath in file_list:
313
rf = FastPath(self.relpath(filepath))
314
# validate user parameters. Our recursive code avoids adding new files
315
# that need such validation
447
316
if self.is_control_filename(rf.raw_path):
448
317
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
450
319
abspath = self.abspath(rf.raw_path)
451
320
kind = osutils.file_kind(abspath)
452
321
if kind == 'directory':
495
363
kind = osutils.file_kind(abspath)
497
365
if not InventoryEntry.versionable_kind(kind):
498
trace.warning("skipping %s (can't add file of kind '%s')",
501
if illegalpath_re.search(directory.raw_path):
502
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
504
if directory.raw_path in conflicts_related:
505
# If the file looks like one generated for a conflict, don't
508
'skipping %s (generated to help resolve conflicts)',
366
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
512
369
if parent_ie is not None:
513
370
versioned = directory.base_path in parent_ie.children
515
# without the parent ie, use the relatively slower inventory
372
# without the parent ie, use the relatively slower inventory
517
versioned = inv.has_filename(
518
self._fix_case_of_inventory_path(directory.raw_path))
374
versioned = inv.has_filename(directory.raw_path)
520
376
if kind == 'directory':
536
392
# mutter("%r is already versioned", abspath)
538
# XXX: This is wrong; people *might* reasonably be trying to
539
# add subtrees as subtrees. This should probably only be done
540
# in formats which can represent subtrees, and even then
541
# perhaps only when the user asked to add subtrees. At the
542
# moment you can add them specially through 'join --reference',
543
# which is perhaps reasonable: adding a new reference is a
544
# special operation and can have a special behaviour. mbp
546
trace.mutter("%r is a nested bzr tree", abspath)
394
# XXX: This is wrong; people *might* reasonably be trying to add
395
# subtrees as subtrees. This should probably only be done in formats
396
# which can represent subtrees, and even then perhaps only when
397
# the user asked to add subtrees. At the moment you can add them
398
# specially through 'join --reference', which is perhaps
399
# reasonable: adding a new reference is a special operation and
400
# can have a special behaviour. mbp 20070306
401
mutter("%r is a nested bzr tree", abspath)
548
403
_add_one(self, inv, parent_ie, directory, kind, action)
549
404
added.append(directory.raw_path)
553
408
# must be present:
554
409
this_ie = parent_ie.children[directory.base_path]
556
# without the parent ie, use the relatively slower inventory
411
# without the parent ie, use the relatively slower inventory
558
this_id = inv.path2id(
559
self._fix_case_of_inventory_path(directory.raw_path))
413
this_id = inv.path2id(directory.raw_path)
560
414
if this_id is None:
563
417
this_ie = inv[this_id]
565
419
for subf in sorted(os.listdir(abspath)):
566
# here we could use TreeDirectory rather than
420
# here we could use TreeDirectory rather than
567
421
# string concatenation.
568
422
subp = osutils.pathjoin(directory.raw_path, subf)
569
# TODO: is_control_filename is very slow. Make it faster.
570
# TreeDirectory.is_control_filename could also make this
571
# faster - its impossible for a non root dir to have a
423
# TODO: is_control_filename is very slow. Make it faster.
424
# TreeDirectory.is_control_filename could also make this
425
# faster - its impossible for a non root dir to have a
573
427
if self.is_control_filename(subp):
574
trace.mutter("skip control directory %r", subp)
428
mutter("skip control directory %r", subp)
575
429
elif subf in this_ie.children:
576
430
# recurse into this already versioned subdir.
577
dirs_to_add.append((_FastPath(subp, subf), this_ie))
431
dirs_to_add.append((FastPath(subp, subf), this_ie))
579
433
# user selection overrides ignoes
580
434
# ignore while selecting files - if we globbed in the
585
439
ignored.setdefault(ignore_glob, []).append(subp)
587
441
#mutter("queue to add sub-file %r", subp)
588
dirs_to_add.append((_FastPath(subp, subf), this_ie))
442
dirs_to_add.append((FastPath(subp, subf), this_ie))
592
self._write_inventory(inv)
594
self.read_working_inventory()
444
if len(added) > 0 and save:
445
self._write_inventory(inv)
595
446
return added, ignored
597
def update_basis_by_delta(self, new_revid, delta):
598
"""Update the parents of this tree after a commit.
600
This gives the tree one parent, with revision id new_revid. The
601
inventory delta is applied to the current basis tree to generate the
602
inventory for the parent new_revid, and all other parent trees are
605
All the changes in the delta should be changes synchronising the basis
606
tree with some or all of the working tree, with a change to a directory
607
requiring that its contents have been recursively included. That is,
608
this is not a general purpose tree modification routine, but a helper
609
for commit which is not required to handle situations that do not arise
612
See the inventory developers documentation for the theory behind
615
:param new_revid: The new revision id for the trees parent.
616
:param delta: An inventory delta (see apply_inventory_delta) describing
617
the changes from the current left most parent revision to new_revid.
619
# if the tree is updated by a pull to the branch, as happens in
620
# WorkingTree2, when there was no separation between branch and tree,
621
# then just clear merges, efficiency is not a concern for now as this
622
# is legacy environments only, and they are slow regardless.
623
if self.last_revision() == new_revid:
624
self.set_parent_ids([new_revid])
626
# generic implementation based on Inventory manipulation. See
627
# WorkingTree classes for optimised versions for specific format trees.
628
basis = self.basis_tree()
630
# TODO: Consider re-evaluating the need for this with CHKInventory
631
# we don't strictly need to mutate an inventory for this
632
# it only makes sense when apply_delta is cheaper than get_inventory()
633
inventory = basis.inventory._get_mutable_inventory()
635
inventory.apply_delta(delta)
636
rev_tree = revisiontree.RevisionTree(self.branch.repository,
637
inventory, new_revid)
638
self.set_parent_trees([(new_revid, rev_tree)])
641
class MutableTreeHooks(hooks.Hooks):
642
"""A dictionary mapping a hook name to a list of callables for mutabletree
647
"""Create the default hooks.
650
hooks.Hooks.__init__(self)
651
self.create_hook(hooks.HookPoint('start_commit',
652
"Called before a commit is performed on a tree. The start commit "
653
"hook is able to change the tree before the commit takes place. "
654
"start_commit is called with the bzrlib.mutabletree.MutableTree "
655
"that the commit is being performed on.", (1, 4), None))
656
self.create_hook(hooks.HookPoint('post_commit',
657
"Called after a commit is performed on a tree. The hook is "
658
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
659
"The mutable tree the commit was performed on is available via "
660
"the mutable_tree attribute of that object.", (2, 0), None))
663
# install the default hooks into the MutableTree class.
664
MutableTree.hooks = MutableTreeHooks()
667
class PostCommitHookParams(object):
668
"""Parameters for the post_commit hook.
670
To access the parameters, use the following attributes:
672
* mutable_tree - the MutableTree object
675
def __init__(self, mutable_tree):
676
"""Create the parameters for the post_commit hook."""
677
self.mutable_tree = mutable_tree
680
class _FastPath(object):
449
class FastPath(object):
681
450
"""A path object with fast accessors for things like basename."""
683
452
__slots__ = ['raw_path', 'base_path']
718
487
# slower but does not need parent_ie
719
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
488
if inv.has_filename(path.raw_path):
721
490
# its really not there : add the parent
722
491
# note that the dirname use leads to some extra str copying etc but as
723
492
# there are a limited number of dirs we can be nested under, it should
724
493
# generally find it very fast and not recurse after that.
725
added = _add_one_and_parent(tree, inv, None,
726
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
727
parent_id = inv.path2id(osutils.dirname(path.raw_path))
494
added = _add_one_and_parent(tree, inv, None, FastPath(dirname(path.raw_path)), 'directory', action)
495
parent_id = inv.path2id(dirname(path.raw_path))
728
496
parent_ie = inv[parent_id]
729
497
_add_one(tree, inv, parent_ie, path, kind, action)
730
498
return added + [path.raw_path]
added
removed
bzrlib/mutabletree.py
