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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
17
"""MutableTree object.
23
23
from bzrlib.lazy_import import lazy_import
24
24
lazy_import(globals(), """
27
28
from bzrlib import (
32
from bzrlib.osutils import dirname
33
from bzrlib.revisiontree import RevisionTree
34
from bzrlib.trace import mutter, warning
42
41
from bzrlib.decorators import needs_read_lock, needs_write_lock
43
from bzrlib.osutils import splitpath
44
from bzrlib.symbol_versioning import DEPRECATED_PARAMETER
47
44
def needs_tree_write_lock(unbound):
69
66
entirely in memory.
71
68
For now, we are not treating MutableTree as an interface to provide
72
conformance tests for - rather we are testing MemoryTree specifically, and
69
conformance tests for - rather we are testing MemoryTree specifically, and
73
70
interface testing implementations of WorkingTree.
75
72
A mutable tree always has an associated Branch and BzrDir object - the
129
126
# generic constraint checks:
130
127
if self.is_control_filename(f):
131
128
raise errors.ForbiddenControlFileError(filename=f)
133
# fill out file kinds for all files [not needed when we stop
129
fp = osutils.splitpath(f)
130
# fill out file kinds for all files [not needed when we stop
134
131
# caring about the instantaneous file kind within a uncommmitted tree
136
133
self._gather_kinds(files, kinds)
192
189
revprops['branch-nick'] = self.branch._get_nick(
193
190
kwargs.get('local', False),
194
191
possible_master_transports)
192
authors = kwargs.pop('authors', None)
195
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)
196
207
if author is not None:
197
if 'author' in revprops:
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:
198
212
# XXX: maybe we should just accept one of them?
199
213
raise AssertionError('author property given twice')
200
revprops['author'] = author
215
raise AssertionError('\\n is not a valid character '
216
'in an author identity')
217
revprops['authors'] = author
201
218
# args for wt.commit start at message from the Commit.commit method,
202
219
args = (message, ) + args
203
220
for hook in MutableTree.hooks['start_commit']:
206
223
revprops=revprops,
207
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)
209
229
return committed_id
211
231
def _gather_kinds(self, files, kinds):
212
232
"""Helper function for add - sets the entries of kinds."""
213
233
raise NotImplementedError(self._gather_kinds)
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.
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
227
return (self.get_file(file_id, path), None)
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:
230
261
def last_revision(self):
233
264
In early tree formats the result of last_revision is the same as the
234
265
branch last_revision, but that is no longer the case for modern tree
237
268
last_revision returns the left most parent id, or None if there are no
256
287
def lock_write(self):
257
288
"""Lock the tree and its branch. This allows mutating calls to be made.
259
Some mutating methods will take out implicit write locks, but in
290
Some mutating methods will take out implicit write locks, but in
260
291
general you should always obtain a write lock before calling mutating
261
292
methods on a tree.
278
309
The intent of this function is to allow trees that have a hashcache to
279
310
update the hashcache during commit. If the observed file is too new
280
311
(based on the stat_value) to be safely hash-cached the tree will ignore
283
314
The default implementation does nothing.
298
329
@needs_write_lock
299
330
def put_file_bytes_non_atomic(self, file_id, bytes):
300
331
"""Update the content of a file in the tree.
302
333
Note that the file is written in-place rather than being
303
334
written to a temporary location and renamed. As a consequence,
304
335
readers can potentially see the file half-written.
318
349
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
319
350
"""Set the parents of the working tree.
321
:param parents_list: A list of (revision_id, tree) tuples.
352
:param parents_list: A list of (revision_id, tree) tuples.
322
353
If tree is None, then that element is treated as an unreachable
323
354
parent tree - i.e. a ghost.
332
363
For the specific behaviour see the help for cmd_add().
334
365
:param action: A reporter to be called with the inventory, parent_ie,
335
path and kind of the path being added. It may return a file_id if
366
path and kind of the path being added. It may return a file_id if
336
367
a specific one should be used.
337
368
:param save: Save the inventory after completing the adds. If False
338
369
this provides dry-run functionality by doing the add and not saving
358
389
user_dirs = set()
360
# validate user file paths and convert all paths to tree
391
# validate user file paths and convert all paths to tree
361
392
# relative : it's cheaper to make a tree relative path an abspath
362
393
# than to convert an abspath to tree relative, and it's cheaper to
363
394
# perform the canonicalization in bulk.
364
395
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
365
396
rf = _FastPath(filepath)
366
# validate user parameters. Our recursive code avoids adding new files
367
# that need such validation
397
# validate user parameters. Our recursive code avoids adding new
398
# files that need such validation
368
399
if self.is_control_filename(rf.raw_path):
369
400
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
371
402
abspath = self.abspath(rf.raw_path)
372
403
kind = osutils.file_kind(abspath)
373
404
if kind == 'directory':
377
408
if not InventoryEntry.versionable_kind(kind):
378
409
raise errors.BadFileKindError(filename=abspath, kind=kind)
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
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
383
414
versioned = inv.has_filename(rf.raw_path)
401
432
dirs_to_add.append((path, None))
402
433
prev_dir = path.raw_path
435
illegalpath_re = re.compile(r'[\r\n]')
404
436
# dirs_to_add is initialised to a list of directories, but as we scan
405
437
# directories we append files to it.
406
438
# XXX: We should determine kind of files when we scan them rather than
415
447
kind = osutils.file_kind(abspath)
417
449
if not InventoryEntry.versionable_kind(kind):
418
warning("skipping %s (can't add file of kind '%s')", abspath, 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)
421
457
if parent_ie is not None:
422
458
versioned = directory.base_path in parent_ie.children
424
# without the parent ie, use the relatively slower inventory
460
# without the parent ie, use the relatively slower inventory
426
462
versioned = inv.has_filename(
427
463
self._fix_case_of_inventory_path(directory.raw_path))
445
481
# mutter("%r is already versioned", 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)
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)
456
493
_add_one(self, inv, parent_ie, directory, kind, action)
457
494
added.append(directory.raw_path)
461
498
# must be present:
462
499
this_ie = parent_ie.children[directory.base_path]
464
# without the parent ie, use the relatively slower inventory
501
# without the parent ie, use the relatively slower inventory
466
503
this_id = inv.path2id(
467
self._fix_case_of_inventory_path(directory.raw_path))
504
self._fix_case_of_inventory_path(directory.raw_path))
468
505
if this_id is None:
471
508
this_ie = inv[this_id]
473
510
for subf in sorted(os.listdir(abspath)):
474
# here we could use TreeDirectory rather than
511
# here we could use TreeDirectory rather than
475
512
# string concatenation.
476
513
subp = osutils.pathjoin(directory.raw_path, subf)
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
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
481
518
if self.is_control_filename(subp):
482
mutter("skip control directory %r", subp)
519
trace.mutter("skip control directory %r", subp)
483
520
elif subf in this_ie.children:
484
521
# recurse into this already versioned subdir.
485
522
dirs_to_add.append((_FastPath(subp, subf), this_ie))
517
554
for commit which is not required to handle situations that do not arise
518
555
outside of commit.
557
See the inventory developers documentation for the theory behind
520
560
:param new_revid: The new revision id for the trees parent.
521
561
:param delta: An inventory delta (see apply_inventory_delta) describing
522
562
the changes from the current left most parent revision to new_revid.
532
572
# WorkingTree classes for optimised versions for specific format trees.
533
573
basis = self.basis_tree()
534
574
basis.lock_read()
535
inventory = basis.inventory
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()
537
580
inventory.apply_delta(delta)
538
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
581
rev_tree = revisiontree.RevisionTree(self.branch.repository,
582
inventory, new_revid)
539
583
self.set_parent_trees([(new_revid, rev_tree)])
542
586
class MutableTreeHooks(hooks.Hooks):
543
"""A dictionary mapping a hook name to a list of callables for mutabletree
587
"""A dictionary mapping a hook name to a list of callables for mutabletree
551
595
hooks.Hooks.__init__(self)
552
# Invoked before a commit is done in a tree. New in 1.4
553
self['start_commit'] = []
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))
556
608
# install the default hooks into the MutableTree class.
557
609
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
560
625
class _FastPath(object):
561
626
"""A path object with fast accessors for things like basename."""
603
668
# there are a limited number of dirs we can be nested under, it should
604
669
# generally find it very fast and not recurse after that.
605
670
added = _add_one_and_parent(tree, inv, None,
606
_FastPath(dirname(path.raw_path)), 'directory', action)
607
parent_id = inv.path2id(dirname(path.raw_path))
671
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
672
parent_id = inv.path2id(osutils.dirname(path.raw_path))
608
673
parent_ie = inv[parent_id]
609
674
_add_one(tree, inv, parent_ie, path, kind, action)
610
675
return added + [path.raw_path]
added
removed
bzrlib/mutabletree.py
