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
33
def is_detritus(subp):
34
"""Return True if the supplied path is detritus, False otherwise"""
35
return subp.endswith('.THIS') or subp.endswith('.BASE') or\
36
subp.endswith('.OTHER') or subp.endswith('~') or subp.endswith('.tmp')
39
def iter_deletables(tree, unknown=False, ignored=False, detritus=False):
40
"""Iterate through files that may be deleted"""
41
for subp in tree.extras():
42
if detritus and is_detritus(subp):
43
yield tree.abspath(subp), subp
45
if tree.is_ignored(subp):
47
yield tree.abspath(subp), subp
50
yield tree.abspath(subp), subp
53
def clean_tree(directory, unknown=False, ignored=False, detritus=False,
54
dry_run=False, no_prompt=False):
55
"""Remove files in the specified classes from the tree"""
56
tree = WorkingTree.open_containing(directory)[0]
57
with tree.lock_read():
58
deletables = list(iter_deletables(tree, unknown=unknown,
59
ignored=ignored, detritus=detritus))
60
deletables = _filter_out_nested_controldirs(deletables)
61
if len(deletables) == 0:
62
note(gettext('Nothing to delete.'))
65
for path, subp in deletables:
66
ui.ui_factory.note(subp)
67
prompt = gettext('Are you sure you wish to delete these')
68
if not ui.ui_factory.get_boolean(prompt):
69
ui.ui_factory.note(gettext('Canceled'))
71
delete_items(deletables, dry_run=dry_run)
74
def _filter_out_nested_controldirs(deletables):
76
for path, subp in deletables:
77
# bzr won't recurse into unknowns/ignored directories by default
78
# so we don't pay a penalty for checking subdirs of path for nested
80
# That said we won't detect the branch in the subdir of non-branch
81
# directory and therefore delete it. (worth to FIXME?)
84
controldir.ControlDir.open(path)
85
except errors.NotBranchError:
86
result.append((path, subp))
88
# TODO may be we need to notify user about skipped directories?
91
result.append((path, subp))
95
def delete_items(deletables, dry_run=False):
96
"""Delete files in the deletables iterable"""
97
def onerror(function, path, excinfo):
98
"""Show warning for errors seen by rmtree.
100
# Handle only permission error while removing files.
101
# Other errors are re-raised.
102
if function is not os.remove or excinfo[1].errno != errno.EACCES:
104
ui.ui_factory.show_warning(gettext('unable to remove %s') % path)
106
for path, subp in deletables:
108
note(gettext("deleting paths:"))
112
shutil.rmtree(path, onerror=onerror)
118
# We handle only permission error here
119
if e.errno != errno.EACCES:
121
ui.ui_factory.show_warning(gettext(
122
'unable to remove "{0}": {1}.').format(
127
note(gettext("No files deleted."))