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
126
129
# generic constraint checks:
127
130
if self.is_control_filename(f):
128
131
raise errors.ForbiddenControlFileError(filename=f)
129
fp = osutils.splitpath(f)
130
# fill out file kinds for all files [not needed when we stop
133
# fill out file kinds for all files [not needed when we stop
131
134
# caring about the instantaneous file kind within a uncommmitted tree
133
136
self._gather_kinds(files, kinds)
189
192
revprops['branch-nick'] = self.branch._get_nick(
190
193
kwargs.get('local', False),
191
194
possible_master_transports)
192
authors = kwargs.pop('authors', None)
193
195
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
196
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:
197
if 'author' in revprops:
212
198
# XXX: maybe we should just accept one of them?
213
199
raise AssertionError('author property given twice')
215
raise AssertionError('\\n is not a valid character '
216
'in an author identity')
217
revprops['authors'] = author
200
revprops['author'] = author
218
201
# args for wt.commit start at message from the Commit.commit method,
219
202
args = (message, ) + args
220
203
for hook in MutableTree.hooks['start_commit']:
223
206
revprops=revprops,
224
207
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)
229
209
return committed_id
231
211
def _gather_kinds(self, files, kinds):
232
212
"""Helper function for add - sets the entries of kinds."""
233
213
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
215
def get_file_with_stat(self, file_id, path=None):
216
"""Get a file handle and stat object for file_id.
218
The default implementation returns (self.get_file, None) for backwards
221
:param file_id: The file id to read.
222
:param path: The path of the file, if it is known.
223
:return: A tuple (file_handle, stat_value_or_None). If the tree has
224
no stat facility, or need for a stat cache feedback during commit,
225
it may return None for the second element of the tuple.
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:
227
return (self.get_file(file_id, path), None)
261
230
def last_revision(self):
264
233
In early tree formats the result of last_revision is the same as the
265
234
branch last_revision, but that is no longer the case for modern tree
268
237
last_revision returns the left most parent id, or None if there are no
287
256
def lock_write(self):
288
257
"""Lock the tree and its branch. This allows mutating calls to be made.
290
Some mutating methods will take out implicit write locks, but in
259
Some mutating methods will take out implicit write locks, but in
291
260
general you should always obtain a write lock before calling mutating
292
261
methods on a tree.
309
278
The intent of this function is to allow trees that have a hashcache to
310
279
update the hashcache during commit. If the observed file is too new
311
280
(based on the stat_value) to be safely hash-cached the tree will ignore
314
283
The default implementation does nothing.
329
298
@needs_write_lock
330
299
def put_file_bytes_non_atomic(self, file_id, bytes):
331
300
"""Update the content of a file in the tree.
333
302
Note that the file is written in-place rather than being
334
303
written to a temporary location and renamed. As a consequence,
335
304
readers can potentially see the file half-written.
349
318
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
350
319
"""Set the parents of the working tree.
352
:param parents_list: A list of (revision_id, tree) tuples.
321
:param parents_list: A list of (revision_id, tree) tuples.
353
322
If tree is None, then that element is treated as an unreachable
354
323
parent tree - i.e. a ghost.
363
332
For the specific behaviour see the help for cmd_add().
365
334
:param action: A reporter to be called with the inventory, parent_ie,
366
path and kind of the path being added. It may return a file_id if
335
path and kind of the path being added. It may return a file_id if
367
336
a specific one should be used.
368
337
:param save: Save the inventory after completing the adds. If False
369
338
this provides dry-run functionality by doing the add and not saving
389
358
user_dirs = set()
391
# validate user file paths and convert all paths to tree
360
# validate user file paths and convert all paths to tree
392
361
# relative : it's cheaper to make a tree relative path an abspath
393
362
# than to convert an abspath to tree relative, and it's cheaper to
394
363
# perform the canonicalization in bulk.
395
364
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
396
365
rf = _FastPath(filepath)
397
# validate user parameters. Our recursive code avoids adding new
398
# files that need such validation
366
# validate user parameters. Our recursive code avoids adding new files
367
# that need such validation
399
368
if self.is_control_filename(rf.raw_path):
400
369
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
402
371
abspath = self.abspath(rf.raw_path)
403
372
kind = osutils.file_kind(abspath)
404
373
if kind == 'directory':
408
377
if not InventoryEntry.versionable_kind(kind):
409
378
raise errors.BadFileKindError(filename=abspath, kind=kind)
410
# ensure the named path is added, so that ignore rules in the later
411
# directory walk dont skip it.
412
# we dont have a parent ie known yet.: use the relatively slower
413
# inventory probing method
379
# ensure the named path is added, so that ignore rules in the later directory
381
# we dont have a parent ie known yet.: use the relatively slower inventory
414
383
versioned = inv.has_filename(rf.raw_path)
432
401
dirs_to_add.append((path, None))
433
402
prev_dir = path.raw_path
435
illegalpath_re = re.compile(r'[\r\n]')
436
404
# dirs_to_add is initialised to a list of directories, but as we scan
437
405
# directories we append files to it.
438
406
# XXX: We should determine kind of files when we scan them rather than
447
415
kind = osutils.file_kind(abspath)
449
417
if not InventoryEntry.versionable_kind(kind):
450
trace.warning("skipping %s (can't add file of kind '%s')",
453
if illegalpath_re.search(directory.raw_path):
454
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
418
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
457
421
if parent_ie is not None:
458
422
versioned = directory.base_path in parent_ie.children
460
# without the parent ie, use the relatively slower inventory
424
# without the parent ie, use the relatively slower inventory
462
426
versioned = inv.has_filename(
463
427
self._fix_case_of_inventory_path(directory.raw_path))
481
445
# mutter("%r is already versioned", abspath)
483
# XXX: This is wrong; people *might* reasonably be trying to
484
# add subtrees as subtrees. This should probably only be done
485
# in formats which can represent subtrees, and even then
486
# perhaps only when the user asked to add subtrees. At the
487
# moment you can add them specially through 'join --reference',
488
# which is perhaps reasonable: adding a new reference is a
489
# special operation and can have a special behaviour. mbp
491
trace.mutter("%r is a nested bzr tree", abspath)
447
# XXX: This is wrong; people *might* reasonably be trying to add
448
# subtrees as subtrees. This should probably only be done in formats
449
# which can represent subtrees, and even then perhaps only when
450
# the user asked to add subtrees. At the moment you can add them
451
# specially through 'join --reference', which is perhaps
452
# reasonable: adding a new reference is a special operation and
453
# can have a special behaviour. mbp 20070306
454
mutter("%r is a nested bzr tree", abspath)
493
456
_add_one(self, inv, parent_ie, directory, kind, action)
494
457
added.append(directory.raw_path)
498
461
# must be present:
499
462
this_ie = parent_ie.children[directory.base_path]
501
# without the parent ie, use the relatively slower inventory
464
# without the parent ie, use the relatively slower inventory
503
466
this_id = inv.path2id(
504
self._fix_case_of_inventory_path(directory.raw_path))
467
self._fix_case_of_inventory_path(directory.raw_path))
505
468
if this_id is None:
508
471
this_ie = inv[this_id]
510
473
for subf in sorted(os.listdir(abspath)):
511
# here we could use TreeDirectory rather than
474
# here we could use TreeDirectory rather than
512
475
# string concatenation.
513
476
subp = osutils.pathjoin(directory.raw_path, subf)
514
# TODO: is_control_filename is very slow. Make it faster.
515
# TreeDirectory.is_control_filename could also make this
516
# faster - its impossible for a non root dir to have a
477
# TODO: is_control_filename is very slow. Make it faster.
478
# TreeDirectory.is_control_filename could also make this
479
# faster - its impossible for a non root dir to have a
518
481
if self.is_control_filename(subp):
519
trace.mutter("skip control directory %r", subp)
482
mutter("skip control directory %r", subp)
520
483
elif subf in this_ie.children:
521
484
# recurse into this already versioned subdir.
522
485
dirs_to_add.append((_FastPath(subp, subf), this_ie))
554
517
for commit which is not required to handle situations that do not arise
555
518
outside of commit.
557
See the inventory developers documentation for the theory behind
560
520
:param new_revid: The new revision id for the trees parent.
561
521
:param delta: An inventory delta (see apply_inventory_delta) describing
562
522
the changes from the current left most parent revision to new_revid.
572
532
# WorkingTree classes for optimised versions for specific format trees.
573
533
basis = self.basis_tree()
574
534
basis.lock_read()
575
# TODO: Consider re-evaluating the need for this with CHKInventory
576
# we don't strictly need to mutate an inventory for this
577
# it only makes sense when apply_delta is cheaper than get_inventory()
578
inventory = basis.inventory._get_mutable_inventory()
535
inventory = basis.inventory
580
537
inventory.apply_delta(delta)
581
rev_tree = revisiontree.RevisionTree(self.branch.repository,
582
inventory, new_revid)
538
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
583
539
self.set_parent_trees([(new_revid, rev_tree)])
586
542
class MutableTreeHooks(hooks.Hooks):
587
"""A dictionary mapping a hook name to a list of callables for mutabletree
543
"""A dictionary mapping a hook name to a list of callables for mutabletree
595
551
hooks.Hooks.__init__(self)
596
self.create_hook(hooks.HookPoint('start_commit',
597
"Called before a commit is performed on a tree. The start commit "
598
"hook is able to change the tree before the commit takes place. "
599
"start_commit is called with the bzrlib.mutabletree.MutableTree "
600
"that the commit is being performed on.", (1, 4), None))
601
self.create_hook(hooks.HookPoint('post_commit',
602
"Called after a commit is performed on a tree. The hook is "
603
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
604
"The mutable tree the commit was performed on is available via "
605
"the mutable_tree attribute of that object.", (2, 0), None))
552
# Invoked before a commit is done in a tree. New in 1.4
553
self['start_commit'] = []
608
556
# install the default hooks into the MutableTree class.
609
557
MutableTree.hooks = MutableTreeHooks()
612
class PostCommitHookParams(object):
613
"""Parameters for the post_commit hook.
615
To access the parameters, use the following attributes:
617
* mutable_tree - the MutableTree object
620
def __init__(self, mutable_tree):
621
"""Create the parameters for the post_commit hook."""
622
self.mutable_tree = mutable_tree
625
560
class _FastPath(object):
626
561
"""A path object with fast accessors for things like basename."""
668
603
# there are a limited number of dirs we can be nested under, it should
669
604
# generally find it very fast and not recurse after that.
670
605
added = _add_one_and_parent(tree, inv, None,
671
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
672
parent_id = inv.path2id(osutils.dirname(path.raw_path))
606
_FastPath(dirname(path.raw_path)), 'directory', action)
607
parent_id = inv.path2id(dirname(path.raw_path))
673
608
parent_ie = inv[parent_id]
674
609
_add_one(tree, inv, parent_ie, path, kind, action)
675
610
return added + [path.raw_path]
added
removed
bzrlib/mutabletree.py
