1
# Copyright (C) 2009, 2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
17
from __future__ import absolute_import
28
from .osutils import isdir
29
from .trace import note
30
from .workingtree import WorkingTree
31
from .i18n import gettext
34
def is_detritus(subp):
35
"""Return True if the supplied path is detritus, False otherwise"""
36
return subp.endswith('.THIS') or subp.endswith('.BASE') or\
37
subp.endswith('.OTHER') or subp.endswith('~') or subp.endswith('.tmp')
40
def iter_deletables(tree, unknown=False, ignored=False, detritus=False):
41
"""Iterate through files that may be deleted"""
42
for subp in tree.extras():
43
if detritus and is_detritus(subp):
44
yield tree.abspath(subp), subp
46
if tree.is_ignored(subp):
48
yield tree.abspath(subp), subp
51
yield tree.abspath(subp), subp
54
def clean_tree(directory, unknown=False, ignored=False, detritus=False,
55
dry_run=False, no_prompt=False):
56
"""Remove files in the specified classes from the tree"""
57
tree = WorkingTree.open_containing(directory)[0]
58
with tree.lock_read():
59
deletables = list(iter_deletables(tree, unknown=unknown,
60
ignored=ignored, detritus=detritus))
61
deletables = _filter_out_nested_controldirs(deletables)
62
if len(deletables) == 0:
63
note(gettext('Nothing to delete.'))
66
for path, subp in deletables:
67
ui.ui_factory.note(subp)
68
prompt = gettext('Are you sure you wish to delete these')
69
if not ui.ui_factory.get_boolean(prompt):
70
ui.ui_factory.note(gettext('Canceled'))
72
delete_items(deletables, dry_run=dry_run)
75
def _filter_out_nested_controldirs(deletables):
77
for path, subp in deletables:
78
# bzr won't recurse into unknowns/ignored directories by default
79
# so we don't pay a penalty for checking subdirs of path for nested
81
# That said we won't detect the branch in the subdir of non-branch
82
# directory and therefore delete it. (worth to FIXME?)
85
controldir.ControlDir.open(path)
86
except errors.NotBranchError:
87
result.append((path, subp))
89
# TODO may be we need to notify user about skipped directories?
92
result.append((path, subp))
96
def delete_items(deletables, dry_run=False):
97
"""Delete files in the deletables iterable"""
98
def onerror(function, path, excinfo):
99
"""Show warning for errors seen by rmtree.
101
# Handle only permission error while removing files.
102
# Other errors are re-raised.
103
if function is not os.remove or excinfo[1].errno != errno.EACCES:
105
ui.ui_factory.show_warning(gettext('unable to remove %s') % path)
107
for path, subp in deletables:
109
note(gettext("deleting paths:"))
113
shutil.rmtree(path, onerror=onerror)
119
# We handle only permission error here
120
if e.errno != errno.EACCES:
122
ui.ui_factory.show_warning(gettext(
123
'unable to remove "{0}": {1}.').format(
128
note(gettext("No files deleted."))