13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""MutableTree object.
23
23
from bzrlib.lazy_import import lazy_import
24
24
lazy_import(globals(), """
28
27
from bzrlib import (
32
from bzrlib.osutils import dirname
33
from bzrlib.revisiontree import RevisionTree
34
from bzrlib.trace import mutter, warning
41
42
from bzrlib.decorators import needs_read_lock, needs_write_lock
43
from bzrlib.osutils import splitpath
44
from bzrlib.symbol_versioning import DEPRECATED_PARAMETER
44
47
def needs_tree_write_lock(unbound):
66
69
entirely in memory.
68
71
For now, we are not treating MutableTree as an interface to provide
69
conformance tests for - rather we are testing MemoryTree specifically, and
72
conformance tests for - rather we are testing MemoryTree specifically, and
70
73
interface testing implementations of WorkingTree.
72
75
A mutable tree always has an associated Branch and BzrDir object - the
73
76
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
79
@needs_tree_write_lock
83
80
def add(self, files, ids=None, kinds=None):
183
180
# avoid circular imports
184
181
from bzrlib import commit
185
184
possible_master_transports=[]
186
revprops = commit.Commit.update_revprops(
189
kwargs.pop('authors', None),
190
kwargs.pop('author', None),
191
kwargs.get('local', False),
185
if not 'branch-nick' in revprops:
186
revprops['branch-nick'] = self.branch._get_nick(
192
187
possible_master_transports)
188
author = kwargs.pop('author', None)
189
if author is not None:
190
if 'author' in revprops:
191
# XXX: maybe we should just accept one of them?
192
raise AssertionError('author property given twice')
193
revprops['author'] = author
193
194
# args for wt.commit start at message from the Commit.commit method,
194
195
args = (message, ) + args
195
196
for hook in MutableTree.hooks['start_commit']:
198
199
revprops=revprops,
199
200
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)
204
202
return committed_id
206
204
def _gather_kinds(self, files, kinds):
207
205
"""Helper function for add - sets the entries of kinds."""
208
206
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)
208
def get_file_with_stat(self, file_id, path=None):
209
"""Get a file handle and stat object for file_id.
211
The default implementation returns (self.get_file, None) for backwards
214
:param file_id: The file id to read.
215
:param path: The path of the file, if it is known.
216
:return: A tuple (file_handle, stat_value_or_None). If the tree has
217
no stat facility, or need for a stat cache feedback during commit,
218
it may return None for the second element of the tuple.
220
return (self.get_file(file_id, path), None)
274
223
def last_revision(self):
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)
342
285
@needs_write_lock
343
286
def put_file_bytes_non_atomic(self, file_id, bytes):
344
287
"""Update the content of a file in the tree.
346
289
Note that the file is written in-place rather than being
347
290
written to a temporary location and renamed. As a consequence,
348
291
readers can potentially see the file half-written.
404
345
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
347
# validate user file paths and convert all paths to tree
415
348
# 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
349
# than to convert an abspath to tree relative.
350
for filepath in file_list:
351
rf = _FastPath(self.relpath(filepath))
352
# validate user parameters. Our recursive code avoids adding new files
353
# that need such validation
422
354
if self.is_control_filename(rf.raw_path):
423
355
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
425
357
abspath = self.abspath(rf.raw_path)
426
358
kind = osutils.file_kind(abspath)
427
359
if kind == 'directory':
431
363
if not InventoryEntry.versionable_kind(kind):
432
364
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
365
# ensure the named path is added, so that ignore rules in the later directory
367
# we dont have a parent ie known yet.: use the relatively slower inventory
437
369
versioned = inv.has_filename(rf.raw_path)
470
401
kind = osutils.file_kind(abspath)
472
403
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)',
404
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
487
407
if parent_ie is not None:
488
408
versioned = directory.base_path in parent_ie.children
490
# without the parent ie, use the relatively slower inventory
410
# without the parent ie, use the relatively slower inventory
492
versioned = inv.has_filename(
493
self._fix_case_of_inventory_path(directory.raw_path))
412
versioned = inv.has_filename(directory.raw_path)
495
414
if kind == 'directory':
511
430
# 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)
432
# XXX: This is wrong; people *might* reasonably be trying to add
433
# subtrees as subtrees. This should probably only be done in formats
434
# which can represent subtrees, and even then perhaps only when
435
# the user asked to add subtrees. At the moment you can add them
436
# specially through 'join --reference', which is perhaps
437
# reasonable: adding a new reference is a special operation and
438
# can have a special behaviour. mbp 20070306
439
mutter("%r is a nested bzr tree", abspath)
523
441
_add_one(self, inv, parent_ie, directory, kind, action)
524
442
added.append(directory.raw_path)
528
446
# must be present:
529
447
this_ie = parent_ie.children[directory.base_path]
531
# without the parent ie, use the relatively slower inventory
449
# without the parent ie, use the relatively slower inventory
533
this_id = inv.path2id(
534
self._fix_case_of_inventory_path(directory.raw_path))
451
this_id = inv.path2id(directory.raw_path)
535
452
if this_id is None:
538
455
this_ie = inv[this_id]
540
457
for subf in sorted(os.listdir(abspath)):
541
# here we could use TreeDirectory rather than
458
# here we could use TreeDirectory rather than
542
459
# string concatenation.
543
460
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
461
# TODO: is_control_filename is very slow. Make it faster.
462
# TreeDirectory.is_control_filename could also make this
463
# faster - its impossible for a non root dir to have a
548
465
if self.is_control_filename(subp):
549
trace.mutter("skip control directory %r", subp)
466
mutter("skip control directory %r", subp)
550
467
elif subf in this_ie.children:
551
468
# recurse into this already versioned subdir.
552
469
dirs_to_add.append((_FastPath(subp, subf), this_ie))
602
516
# WorkingTree classes for optimised versions for specific format trees.
603
517
basis = self.basis_tree()
604
518
basis.lock_read()
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()
519
inventory = basis.inventory
610
521
inventory.apply_delta(delta)
611
rev_tree = revisiontree.RevisionTree(self.branch.repository,
612
inventory, new_revid)
522
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
613
523
self.set_parent_trees([(new_revid, rev_tree)])
616
526
class MutableTreeHooks(hooks.Hooks):
617
"""A dictionary mapping a hook name to a list of callables for mutabletree
527
"""A dictionary mapping a hook name to a list of callables for mutabletree
625
535
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))
536
# Invoked before a commit is done in a tree. New in 1.4
537
self['start_commit'] = []
638
540
# install the default hooks into the MutableTree class.
639
541
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
544
class _FastPath(object):
656
545
"""A path object with fast accessors for things like basename."""
693
582
# slower but does not need parent_ie
694
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
583
if inv.has_filename(path.raw_path):
696
585
# its really not there : add the parent
697
586
# note that the dirname use leads to some extra str copying etc but as
698
587
# there are a limited number of dirs we can be nested under, it should
699
588
# generally find it very fast and not recurse after that.
700
589
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))
590
_FastPath(dirname(path.raw_path)), 'directory', action)
591
parent_id = inv.path2id(dirname(path.raw_path))
703
592
parent_ie = inv[parent_id]
704
593
_add_one(tree, inv, parent_ie, path, kind, action)
705
594
return added + [path.raw_path]
added
removed
bzrlib/mutabletree.py
