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):
126
123
# generic constraint checks:
127
124
if self.is_control_filename(f):
128
125
raise errors.ForbiddenControlFileError(filename=f)
129
fp = osutils.splitpath(f)
130
# fill out file kinds for all files [not needed when we stop
127
# fill out file kinds for all files [not needed when we stop
131
128
# caring about the instantaneous file kind within a uncommmitted tree
133
130
self._gather_kinds(files, kinds)
183
180
# avoid circular imports
184
181
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)
184
if not 'branch-nick' in revprops:
185
revprops['branch-nick'] = self.branch.nick
186
author = kwargs.pop('author', None)
187
if author is not None:
188
if 'author' in revprops:
189
# XXX: maybe we should just accept one of them?
190
raise AssertionError('author property given twice')
191
revprops['author'] = author
193
192
# args for wt.commit start at message from the Commit.commit method,
194
193
args = (message, ) + args
195
194
for hook in MutableTree.hooks['start_commit']:
197
196
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)
197
revprops=revprops, *args, **kwargs)
204
198
return committed_id
206
200
def _gather_kinds(self, files, kinds):
208
202
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
205
def last_revision(self):
275
206
"""Return the revision id of the last commit performed in this tree.
277
208
In early tree formats the result of last_revision is the same as the
278
209
branch last_revision, but that is no longer the case for modern tree
281
212
last_revision returns the left most parent id, or None if there are no
317
248
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)
342
250
@needs_write_lock
343
251
def put_file_bytes_non_atomic(self, file_id, bytes):
344
252
"""Update the content of a file in the tree.
346
254
Note that the file is written in-place rather than being
347
255
written to a temporary location and renamed. As a consequence,
348
256
readers can potentially see the file half-written.
362
270
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
363
271
"""Set the parents of the working tree.
365
:param parents_list: A list of (revision_id, tree) tuples.
273
:param parents_list: A list of (revision_id, tree) tuples.
366
274
If tree is None, then that element is treated as an unreachable
367
275
parent tree - i.e. a ghost.
375
283
This is designed more towards DWIM for humans than API clarity.
376
284
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
286
: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
287
path and kind of the path being added. It may return a file_id if
384
288
a specific one should be used.
385
289
:param save: Save the inventory after completing the adds. If False
386
290
this provides dry-run functionality by doing the add and not saving
408
310
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
312
# validate user file paths and convert all paths to tree
419
313
# 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
314
# than to convert an abspath to tree relative.
315
for filepath in file_list:
316
rf = _FastPath(self.relpath(filepath))
317
# validate user parameters. Our recursive code avoids adding new files
318
# that need such validation
426
319
if self.is_control_filename(rf.raw_path):
427
320
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
429
322
abspath = self.abspath(rf.raw_path)
430
323
kind = osutils.file_kind(abspath)
431
324
if kind == 'directory':
435
328
if not InventoryEntry.versionable_kind(kind):
436
329
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
330
# ensure the named path is added, so that ignore rules in the later directory
332
# we dont have a parent ie known yet.: use the relatively slower inventory
441
334
versioned = inv.has_filename(rf.raw_path)
459
352
dirs_to_add.append((path, None))
460
353
prev_dir = path.raw_path
462
illegalpath_re = re.compile(r'[\r\n]')
463
355
# dirs_to_add is initialised to a list of directories, but as we scan
464
356
# directories we append files to it.
465
357
# XXX: We should determine kind of files when we scan them rather than
474
366
kind = osutils.file_kind(abspath)
476
368
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)',
369
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
491
372
if parent_ie is not None:
492
373
versioned = directory.base_path in parent_ie.children
494
# without the parent ie, use the relatively slower inventory
375
# without the parent ie, use the relatively slower inventory
496
versioned = inv.has_filename(
497
self._fix_case_of_inventory_path(directory.raw_path))
377
versioned = inv.has_filename(directory.raw_path)
499
379
if kind == 'directory':
515
395
# 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)
397
# XXX: This is wrong; people *might* reasonably be trying to add
398
# subtrees as subtrees. This should probably only be done in formats
399
# which can represent subtrees, and even then perhaps only when
400
# the user asked to add subtrees. At the moment you can add them
401
# specially through 'join --reference', which is perhaps
402
# reasonable: adding a new reference is a special operation and
403
# can have a special behaviour. mbp 20070306
404
mutter("%r is a nested bzr tree", abspath)
527
406
_add_one(self, inv, parent_ie, directory, kind, action)
528
407
added.append(directory.raw_path)
532
411
# must be present:
533
412
this_ie = parent_ie.children[directory.base_path]
535
# without the parent ie, use the relatively slower inventory
414
# without the parent ie, use the relatively slower inventory
537
this_id = inv.path2id(
538
self._fix_case_of_inventory_path(directory.raw_path))
416
this_id = inv.path2id(directory.raw_path)
539
417
if this_id is None:
542
420
this_ie = inv[this_id]
544
422
for subf in sorted(os.listdir(abspath)):
545
# here we could use TreeDirectory rather than
423
# here we could use TreeDirectory rather than
546
424
# string concatenation.
547
425
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
426
# TODO: is_control_filename is very slow. Make it faster.
427
# TreeDirectory.is_control_filename could also make this
428
# faster - its impossible for a non root dir to have a
552
430
if self.is_control_filename(subp):
553
trace.mutter("skip control directory %r", subp)
431
mutter("skip control directory %r", subp)
554
432
elif subf in this_ie.children:
555
433
# recurse into this already versioned subdir.
556
434
dirs_to_add.append((_FastPath(subp, subf), this_ie))
606
481
# WorkingTree classes for optimised versions for specific format trees.
607
482
basis = self.basis_tree()
608
483
basis.lock_read()
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()
484
inventory = basis.inventory
614
486
inventory.apply_delta(delta)
615
rev_tree = revisiontree.RevisionTree(self.branch.repository,
616
inventory, new_revid)
487
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
617
488
self.set_parent_trees([(new_revid, rev_tree)])
620
491
class MutableTreeHooks(hooks.Hooks):
621
"""A dictionary mapping a hook name to a list of callables for mutabletree
492
"""A dictionary mapping a hook name to a list of callables for mutabletree
629
500
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))
501
# Invoked before a commit is done in a tree. New in 1.4
502
self['start_commit'] = []
642
505
# install the default hooks into the MutableTree class.
643
506
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
509
class _FastPath(object):
660
510
"""A path object with fast accessors for things like basename."""
697
547
# slower but does not need parent_ie
698
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
548
if inv.has_filename(path.raw_path):
700
550
# its really not there : add the parent
701
551
# note that the dirname use leads to some extra str copying etc but as
702
552
# there are a limited number of dirs we can be nested under, it should
703
553
# generally find it very fast and not recurse after that.
704
554
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))
555
_FastPath(dirname(path.raw_path)), 'directory', action)
556
parent_id = inv.path2id(dirname(path.raw_path))
707
557
parent_ie = inv[parent_id]
708
558
_add_one(tree, inv, parent_ie, path, kind, action)
709
559
return added + [path.raw_path]
added
removed
bzrlib/mutabletree.py
