1
# Copyright (C) 2006-2010 Canonical Ltd
1
# Copyright (C) 2006, 2007 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
23
23
from bzrlib.lazy_import import lazy_import
24
24
lazy_import(globals(), """
28
27
from bzrlib import (
33
from bzrlib.osutils import dirname
34
from bzrlib.revisiontree import RevisionTree
35
from bzrlib.trace import mutter, warning
41
43
from bzrlib.decorators import needs_read_lock, needs_write_lock
44
from bzrlib.osutils import splitpath
44
47
def needs_tree_write_lock(unbound):
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
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
223
226
revprops=revprops,
224
227
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
229
return committed_id
231
231
def _gather_kinds(self, files, kinds):
233
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).
236
def has_changes(self, from_tree):
237
"""Quickly check that the tree contains at least one change.
242
239
: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)
241
changes = self.iter_changes(from_tree)
251
243
change = changes.next()
252
244
# Exclude root (talk about black magic... --vila 20090629)
261
def check_changed_or_out_of_date(self, strict, opt_name,
262
more_error, more_warning):
263
"""Check the tree for uncommitted changes and branch synchronization.
265
If strict is None and not set in the config files, a warning is issued.
266
If strict is True, an error is raised.
267
If strict is False, no checks are done and no warning is issued.
269
:param strict: True, False or None, searched in branch config if None.
271
:param opt_name: strict option name to search in config file.
273
:param more_error: Details about how to avoid the check.
275
:param more_warning: Details about what is happening.
278
strict = self.branch.get_config().get_user_option_as_bool(opt_name)
279
if strict is not False:
281
if (self.has_changes()):
282
err_class = errors.UncommittedChanges
283
elif self.last_revision() != self.branch.last_revision():
284
# The tree has lost sync with its branch, there is little
285
# chance that the user is aware of it but he can still force
286
# the action with --no-strict
287
err_class = errors.OutOfDateTree
288
if err_class is not None:
290
err = err_class(self, more=more_warning)
291
# We don't want to interrupt the user if he expressed no
292
# preference about strict.
293
trace.warning('%s', err._format())
295
err = err_class(self, more=more_error)
299
253
def last_revision(self):
300
254
"""Return the revision id of the last commit performed in this tree.
429
381
user_dirs = set()
430
conflicts_related = set()
431
# Not all mutable trees can have conflicts
432
if getattr(self, 'conflicts', None) is not None:
433
# Collect all related files without checking whether they exist or
434
# are versioned. It's cheaper to do that once for all conflicts
435
# than trying to find the relevant conflict for each added file.
436
for c in self.conflicts():
437
conflicts_related.update(c.associated_filenames())
439
383
# validate user file paths and convert all paths to tree
440
384
# relative : it's cheaper to make a tree relative path an abspath
442
386
# perform the canonicalization in bulk.
443
387
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
444
388
rf = _FastPath(filepath)
445
# validate user parameters. Our recursive code avoids adding new
446
# files that need such validation
389
# validate user parameters. Our recursive code avoids adding new files
390
# that need such validation
447
391
if self.is_control_filename(rf.raw_path):
448
392
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
456
400
if not InventoryEntry.versionable_kind(kind):
457
401
raise errors.BadFileKindError(filename=abspath, kind=kind)
458
# ensure the named path is added, so that ignore rules in the later
459
# directory walk dont skip it.
460
# we dont have a parent ie known yet.: use the relatively slower
461
# inventory probing method
402
# ensure the named path is added, so that ignore rules in the later directory
404
# we dont have a parent ie known yet.: use the relatively slower inventory
462
406
versioned = inv.has_filename(rf.raw_path)
480
424
dirs_to_add.append((path, None))
481
425
prev_dir = path.raw_path
483
illegalpath_re = re.compile(r'[\r\n]')
484
427
# dirs_to_add is initialised to a list of directories, but as we scan
485
428
# directories we append files to it.
486
429
# XXX: We should determine kind of files when we scan them rather than
495
438
kind = osutils.file_kind(abspath)
497
440
if not InventoryEntry.versionable_kind(kind):
498
trace.warning("skipping %s (can't add file of kind '%s')",
501
if illegalpath_re.search(directory.raw_path):
502
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
504
if directory.raw_path in conflicts_related:
505
# If the file looks like one generated for a conflict, don't
508
'skipping %s (generated to help resolve conflicts)',
441
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
512
444
if parent_ie is not None:
536
468
# mutter("%r is already versioned", abspath)
538
# XXX: This is wrong; people *might* reasonably be trying to
539
# add subtrees as subtrees. This should probably only be done
540
# in formats which can represent subtrees, and even then
541
# perhaps only when the user asked to add subtrees. At the
542
# moment you can add them specially through 'join --reference',
543
# which is perhaps reasonable: adding a new reference is a
544
# special operation and can have a special behaviour. mbp
546
trace.mutter("%r is a nested bzr tree", abspath)
470
# XXX: This is wrong; people *might* reasonably be trying to add
471
# subtrees as subtrees. This should probably only be done in formats
472
# which can represent subtrees, and even then perhaps only when
473
# the user asked to add subtrees. At the moment you can add them
474
# specially through 'join --reference', which is perhaps
475
# reasonable: adding a new reference is a special operation and
476
# can have a special behaviour. mbp 20070306
477
mutter("%r is a nested bzr tree", abspath)
548
479
_add_one(self, inv, parent_ie, directory, kind, action)
549
480
added.append(directory.raw_path)
571
502
# faster - its impossible for a non root dir to have a
573
504
if self.is_control_filename(subp):
574
trace.mutter("skip control directory %r", subp)
505
mutter("skip control directory %r", subp)
575
506
elif subf in this_ie.children:
576
507
# recurse into this already versioned subdir.
577
508
dirs_to_add.append((_FastPath(subp, subf), this_ie))
633
564
inventory = basis.inventory._get_mutable_inventory()
635
566
inventory.apply_delta(delta)
636
rev_tree = revisiontree.RevisionTree(self.branch.repository,
637
inventory, new_revid)
567
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
638
568
self.set_parent_trees([(new_revid, rev_tree)])
651
581
self.create_hook(hooks.HookPoint('start_commit',
652
582
"Called before a commit is performed on a tree. The start commit "
653
583
"hook is able to change the tree before the commit takes place. "
654
"start_commit is called with the bzrlib.mutabletree.MutableTree "
655
"that the commit is being performed on.", (1, 4), None))
656
self.create_hook(hooks.HookPoint('post_commit',
657
"Called after a commit is performed on a tree. The hook is "
658
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
659
"The mutable tree the commit was performed on is available via "
660
"the mutable_tree attribute of that object.", (2, 0), None))
584
"start_commit is called with the bzrlib.tree.MutableTree that the "
585
"commit is being performed on.", (1, 4), None))
663
588
# install the default hooks into the MutableTree class.
664
589
MutableTree.hooks = MutableTreeHooks()
667
class PostCommitHookParams(object):
668
"""Parameters for the post_commit hook.
670
To access the parameters, use the following attributes:
672
* mutable_tree - the MutableTree object
675
def __init__(self, mutable_tree):
676
"""Create the parameters for the post_commit hook."""
677
self.mutable_tree = mutable_tree
680
592
class _FastPath(object):
681
593
"""A path object with fast accessors for things like basename."""
723
635
# there are a limited number of dirs we can be nested under, it should
724
636
# generally find it very fast and not recurse after that.
725
637
added = _add_one_and_parent(tree, inv, None,
726
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
727
parent_id = inv.path2id(osutils.dirname(path.raw_path))
638
_FastPath(dirname(path.raw_path)), 'directory', action)
639
parent_id = inv.path2id(dirname(path.raw_path))
728
640
parent_ie = inv[parent_id]
729
641
_add_one(tree, inv, parent_ie, path, kind, action)
730
642
return added + [path.raw_path]
added
removed
bzrlib/mutabletree.py
