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
76
73
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
79
82
@needs_tree_write_lock
80
83
def add(self, files, ids=None, kinds=None):
123
126
# generic constraint checks:
124
127
if self.is_control_filename(f):
125
128
raise errors.ForbiddenControlFileError(filename=f)
127
# 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
128
131
# caring about the instantaneous file kind within a uncommmitted tree
130
133
self._gather_kinds(files, kinds)
181
184
from bzrlib import commit
182
185
if revprops is None:
187
possible_master_transports=[]
184
188
if not 'branch-nick' in revprops:
185
revprops['branch-nick'] = self.branch.nick
189
revprops['branch-nick'] = self.branch._get_nick(
190
kwargs.get('local', False),
191
possible_master_transports)
192
authors = kwargs.pop('authors', None)
186
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)
187
207
if author is not None:
188
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:
189
212
# XXX: maybe we should just accept one of them?
190
213
raise AssertionError('author property given twice')
191
revprops['author'] = author
215
raise AssertionError('\\n is not a valid character '
216
'in an author identity')
217
revprops['authors'] = author
192
218
# args for wt.commit start at message from the Commit.commit method,
193
219
args = (message, ) + args
194
220
for hook in MutableTree.hooks['start_commit']:
196
222
committed_id = commit.Commit().commit(working_tree=self,
197
revprops=revprops, *args, **kwargs)
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)
198
229
return committed_id
200
231
def _gather_kinds(self, files, kinds):
202
233
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:
205
261
def last_revision(self):
206
262
"""Return the revision id of the last commit performed in this tree.
208
264
In early tree formats the result of last_revision is the same as the
209
265
branch last_revision, but that is no longer the case for modern tree
212
268
last_revision returns the left most parent id, or None if there are no
231
287
def lock_write(self):
232
288
"""Lock the tree and its branch. This allows mutating calls to be made.
234
Some mutating methods will take out implicit write locks, but in
290
Some mutating methods will take out implicit write locks, but in
235
291
general you should always obtain a write lock before calling mutating
236
292
methods on a tree.
248
304
raise NotImplementedError(self.mkdir)
306
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
307
"""Tell the tree we have observed a paths sha1.
309
The intent of this function is to allow trees that have a hashcache to
310
update the hashcache during commit. If the observed file is too new
311
(based on the stat_value) to be safely hash-cached the tree will ignore
314
The default implementation does nothing.
316
:param file_id: The file id
317
:param path: The file path
318
:param sha1: The sha 1 that was observed.
319
:param stat_value: A stat result for the file the sha1 was read from.
323
def _fix_case_of_inventory_path(self, path):
324
"""If our tree isn't case sensitive, return the canonical path"""
325
if not self.case_sensitive:
326
path = self.get_canonical_inventory_path(path)
250
329
@needs_write_lock
251
330
def put_file_bytes_non_atomic(self, file_id, bytes):
252
331
"""Update the content of a file in the tree.
254
333
Note that the file is written in-place rather than being
255
334
written to a temporary location and renamed. As a consequence,
256
335
readers can potentially see the file half-written.
270
349
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
271
350
"""Set the parents of the working tree.
273
:param parents_list: A list of (revision_id, tree) tuples.
352
:param parents_list: A list of (revision_id, tree) tuples.
274
353
If tree is None, then that element is treated as an unreachable
275
354
parent tree - i.e. a ghost.
284
363
For the specific behaviour see the help for cmd_add().
286
365
:param action: A reporter to be called with the inventory, parent_ie,
287
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
288
367
a specific one should be used.
289
368
:param save: Save the inventory after completing the adds. If False
290
369
this provides dry-run functionality by doing the add and not saving
310
391
user_dirs = set()
392
conflicts_related = set()
393
# Not all mutable trees can have conflicts
394
if getattr(self, 'conflicts', None) is not None:
395
# Collect all related files without checking whether they exist or
396
# are versioned. It's cheaper to do that once for all conflicts
397
# than trying to find the relevant conflict for each added file.
398
for c in self.conflicts():
399
conflicts_related.update(c.associated_filenames())
312
# validate user file paths and convert all paths to tree
401
# validate user file paths and convert all paths to tree
313
402
# relative : it's cheaper to make a tree relative path an abspath
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
403
# than to convert an abspath to tree relative, and it's cheaper to
404
# perform the canonicalization in bulk.
405
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
406
rf = _FastPath(filepath)
407
# validate user parameters. Our recursive code avoids adding new
408
# files that need such validation
319
409
if self.is_control_filename(rf.raw_path):
320
410
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
322
412
abspath = self.abspath(rf.raw_path)
323
413
kind = osutils.file_kind(abspath)
324
414
if kind == 'directory':
328
418
if not InventoryEntry.versionable_kind(kind):
329
419
raise errors.BadFileKindError(filename=abspath, kind=kind)
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
420
# ensure the named path is added, so that ignore rules in the later
421
# directory walk dont skip it.
422
# we dont have a parent ie known yet.: use the relatively slower
423
# inventory probing method
334
424
versioned = inv.has_filename(rf.raw_path)
352
442
dirs_to_add.append((path, None))
353
443
prev_dir = path.raw_path
445
illegalpath_re = re.compile(r'[\r\n]')
355
446
# dirs_to_add is initialised to a list of directories, but as we scan
356
447
# directories we append files to it.
357
448
# XXX: We should determine kind of files when we scan them rather than
366
457
kind = osutils.file_kind(abspath)
368
459
if not InventoryEntry.versionable_kind(kind):
369
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
460
trace.warning("skipping %s (can't add file of kind '%s')",
463
if illegalpath_re.search(directory.raw_path):
464
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
466
if directory.raw_path in conflicts_related:
467
# If the file looks like one generated for a conflict, don't
470
'skipping %s (generated to help resolve conflicts)',
372
474
if parent_ie is not None:
373
475
versioned = directory.base_path in parent_ie.children
375
# without the parent ie, use the relatively slower inventory
477
# without the parent ie, use the relatively slower inventory
377
versioned = inv.has_filename(directory.raw_path)
479
versioned = inv.has_filename(
480
self._fix_case_of_inventory_path(directory.raw_path))
379
482
if kind == 'directory':
395
498
# mutter("%r is already versioned", 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)
500
# XXX: This is wrong; people *might* reasonably be trying to
501
# add subtrees as subtrees. This should probably only be done
502
# in formats which can represent subtrees, and even then
503
# perhaps only when the user asked to add subtrees. At the
504
# moment you can add them specially through 'join --reference',
505
# which is perhaps reasonable: adding a new reference is a
506
# special operation and can have a special behaviour. mbp
508
trace.mutter("%r is a nested bzr tree", abspath)
406
510
_add_one(self, inv, parent_ie, directory, kind, action)
407
511
added.append(directory.raw_path)
411
515
# must be present:
412
516
this_ie = parent_ie.children[directory.base_path]
414
# without the parent ie, use the relatively slower inventory
518
# without the parent ie, use the relatively slower inventory
416
this_id = inv.path2id(directory.raw_path)
520
this_id = inv.path2id(
521
self._fix_case_of_inventory_path(directory.raw_path))
417
522
if this_id is None:
420
525
this_ie = inv[this_id]
422
527
for subf in sorted(os.listdir(abspath)):
423
# here we could use TreeDirectory rather than
528
# here we could use TreeDirectory rather than
424
529
# string concatenation.
425
530
subp = osutils.pathjoin(directory.raw_path, subf)
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
531
# TODO: is_control_filename is very slow. Make it faster.
532
# TreeDirectory.is_control_filename could also make this
533
# faster - its impossible for a non root dir to have a
430
535
if self.is_control_filename(subp):
431
mutter("skip control directory %r", subp)
536
trace.mutter("skip control directory %r", subp)
432
537
elif subf in this_ie.children:
433
538
# recurse into this already versioned subdir.
434
539
dirs_to_add.append((_FastPath(subp, subf), this_ie))
466
571
for commit which is not required to handle situations that do not arise
467
572
outside of commit.
574
See the inventory developers documentation for the theory behind
469
577
:param new_revid: The new revision id for the trees parent.
470
578
:param delta: An inventory delta (see apply_inventory_delta) describing
471
579
the changes from the current left most parent revision to new_revid.
481
589
# WorkingTree classes for optimised versions for specific format trees.
482
590
basis = self.basis_tree()
483
591
basis.lock_read()
484
inventory = basis.inventory
592
# TODO: Consider re-evaluating the need for this with CHKInventory
593
# we don't strictly need to mutate an inventory for this
594
# it only makes sense when apply_delta is cheaper than get_inventory()
595
inventory = basis.inventory._get_mutable_inventory()
486
597
inventory.apply_delta(delta)
487
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
598
rev_tree = revisiontree.RevisionTree(self.branch.repository,
599
inventory, new_revid)
488
600
self.set_parent_trees([(new_revid, rev_tree)])
491
603
class MutableTreeHooks(hooks.Hooks):
492
"""A dictionary mapping a hook name to a list of callables for mutabletree
604
"""A dictionary mapping a hook name to a list of callables for mutabletree
500
612
hooks.Hooks.__init__(self)
501
# Invoked before a commit is done in a tree. New in 1.4
502
self['start_commit'] = []
613
self.create_hook(hooks.HookPoint('start_commit',
614
"Called before a commit is performed on a tree. The start commit "
615
"hook is able to change the tree before the commit takes place. "
616
"start_commit is called with the bzrlib.mutabletree.MutableTree "
617
"that the commit is being performed on.", (1, 4), None))
618
self.create_hook(hooks.HookPoint('post_commit',
619
"Called after a commit is performed on a tree. The hook is "
620
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
621
"The mutable tree the commit was performed on is available via "
622
"the mutable_tree attribute of that object.", (2, 0), None))
505
625
# install the default hooks into the MutableTree class.
506
626
MutableTree.hooks = MutableTreeHooks()
629
class PostCommitHookParams(object):
630
"""Parameters for the post_commit hook.
632
To access the parameters, use the following attributes:
634
* mutable_tree - the MutableTree object
637
def __init__(self, mutable_tree):
638
"""Create the parameters for the post_commit hook."""
639
self.mutable_tree = mutable_tree
509
642
class _FastPath(object):
510
643
"""A path object with fast accessors for things like basename."""
547
680
# slower but does not need parent_ie
548
if inv.has_filename(path.raw_path):
681
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
550
683
# its really not there : add the parent
551
684
# note that the dirname use leads to some extra str copying etc but as
552
685
# there are a limited number of dirs we can be nested under, it should
553
686
# generally find it very fast and not recurse after that.
554
687
added = _add_one_and_parent(tree, inv, None,
555
_FastPath(dirname(path.raw_path)), 'directory', action)
556
parent_id = inv.path2id(dirname(path.raw_path))
688
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
689
parent_id = inv.path2id(osutils.dirname(path.raw_path))
557
690
parent_ie = inv[parent_id]
558
691
_add_one(tree, inv, parent_ie, path, kind, action)
559
692
return added + [path.raw_path]
added
removed
bzrlib/mutabletree.py
