1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
<?php
/*
* $Id: f25fc4c605ead65db9235c9fe328b2d47b7c8299 $
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information please see
* <http://phing.info>.
*/
require_once 'phing/Task.php';
/**
* Deletes a file or directory, or set of files defined by a fileset.
*
* @version $Id: f25fc4c605ead65db9235c9fe328b2d47b7c8299 $
* @package phing.tasks.system
*/
class DeleteTask extends Task {
protected $file;
protected $dir;
protected $filesets = array();
protected $includeEmpty = false;
protected $quiet = false;
protected $failonerror = true;
protected $verbosity = Project::MSG_VERBOSE;
/** Any filelists of files that should be deleted. */
private $filelists = array();
/**
* Set the name of a single file to be removed.
* @param PhingFile $file
*/
function setFile(PhingFile $file) {
$this->file = $file;
}
/**
* Set the directory from which files are to be deleted.
* @param PhingFile $dir
*/
function setDir(PhingFile $dir) {
$this->dir = $dir;
}
/**
* Used to force listing of all names of deleted files.
* @param boolean $verbosity
*/
function setVerbose($verbosity) {
if ($verbosity) {
$this->verbosity = Project::MSG_INFO;
} else {
$this->verbosity = Project::MSG_VERBOSE;
}
}
/**
* If the file does not exist, do not display a diagnostic
* message or modify the exit status to reflect an error.
* This means that if a file or directory cannot be deleted,
* then no error is reported. This setting emulates the
* -f option to the Unix rm command. Default is false
* meaning things are verbose
*/
function setQuiet($bool) {
$this->quiet = $bool;
if ($this->quiet) {
$this->failonerror = false;
}
}
/** this flag means 'note errors to the output, but keep going' */
function setFailOnError($bool) {
$this->failonerror = $bool;
}
/** Used to delete empty directories.*/
function setIncludeEmptyDirs($includeEmpty) {
$this->includeEmpty = (boolean) $includeEmpty;
}
/** Nested creator, adds a set of files (nested fileset attribute). */
function addFileSet(FileSet $fs) {
$this->filesets[] = $fs;
}
/** Nested creator, adds a set of files (nested fileset attribute). */
function createFileList() {
$num = array_push($this->filelists, new FileList());
return $this->filelists[$num-1];
}
/** Delete the file(s). */
function main() {
if ($this->file === null && $this->dir === null && count($this->filesets) === 0 && count($this->filelists) === 0) {
throw new BuildException("At least one of the file or dir attributes, or a fileset element, or a filelist element must be set.");
}
if ($this->quiet && $this->failonerror) {
throw new BuildException("quiet and failonerror cannot both be set to true", $this->location);
}
// delete a single file
if ($this->file !== null) {
if ($this->file->exists()) {
if ($this->file->isDirectory()) {
$this->log("Directory " . $this->file->__toString() . " cannot be removed using the file attribute. Use dir instead.");
} else {
$this->log("Deleting: " . $this->file->__toString());
try {
$this->file->delete();
} catch(Exception $e) {
$message = "Unable to delete file " . $this->file->__toString() .": " .$e->getMessage();
if($this->failonerror) {
throw new BuildException($message);
} else {
$this->log($message, $this->quiet ? Project::MSG_VERBOSE : Project::MSG_WARN);
}
}
}
} else {
$this->log("Could not find file " . $this->file->getAbsolutePath() . " to delete.",Project::MSG_VERBOSE);
}
}
// delete the directory
if ($this->dir !== null && $this->dir->exists() && $this->dir->isDirectory()) {
if ($this->verbosity === Project::MSG_VERBOSE) {
$this->log("Deleting directory " . $this->dir->__toString());
}
$this->removeDir($this->dir);
}
// delete the files in the filelists
foreach($this->filelists as $fl) {
try {
$files = $fl->getFiles($this->project);
$this->removeFiles($fl->getDir($this->project), $files, $empty=array());
} catch (BuildException $be) {
// directory doesn't exist or is not readable
if ($this->failonerror) {
throw $be;
} else {
$this->log($be->getMessage(), $this->quiet ? Project::MSG_VERBOSE : Project::MSG_WARN);
}
}
}
// delete the files in the filesets
foreach($this->filesets as $fs) {
try {
$ds = $fs->getDirectoryScanner($this->project);
$files = $ds->getIncludedFiles();
$dirs = $ds->getIncludedDirectories();
$this->removeFiles($fs->getDir($this->project), $files, $dirs);
} catch (BuildException $be) {
// directory doesn't exist or is not readable
if ($this->failonerror) {
throw $be;
} else {
$this->log($be->getMessage(), $this->quiet ? Project::MSG_VERBOSE : Project::MSG_WARN);
}
}
}
}
/**
* Recursively removes a directory.
* @param PhingFile $d The directory to remove.
*/
private function removeDir($d) {
$list = $d->listDir();
if ($list === null) {
$list = array();
}
foreach($list as $s) {
$f = new PhingFile($d, $s);
if ($f->isDirectory()) {
$this->removeDir($f);
} else {
$this->log("Deleting " . $f->__toString(), $this->verbosity);
try {
$f->delete();
} catch (Exception $e) {
$message = "Unable to delete file " . $f->__toString() . ": " . $e->getMessage();
if($this->failonerror) {
throw new BuildException($message);
} else {
$this->log($message, $this->quiet ? Project::MSG_VERBOSE : Project::MSG_WARN);
}
}
}
}
$this->log("Deleting directory " . $d->getAbsolutePath(), $this->verbosity);
try {
$d->delete();
} catch (Exception $e) {
$message = "Unable to delete directory " . $d->__toString() . ": " . $e->getMessage();
if($this->failonerror) {
throw new BuildException($message);
} else {
$this->log($message, $this->quiet ? Project::MSG_VERBOSE : Project::MSG_WARN);
}
}
}
/**
* remove an array of files in a directory, and a list of subdirectories
* which will only be deleted if 'includeEmpty' is true
* @param PhingFile $d directory to work from
* @param array &$files array of files to delete; can be of zero length
* @param array &$dirs array of directories to delete; can of zero length
*/
private function removeFiles(PhingFile $d, &$files, &$dirs) {
if (count($files) > 0) {
$this->log("Deleting " . count($files) . " files from " . $d->__toString());
for ($j=0,$_j=count($files); $j < $_j; $j++) {
$f = new PhingFile($d, $files[$j]);
$this->log("Deleting " . $f->getAbsolutePath(), $this->verbosity);
try {
$f->delete();
} catch (Exception $e) {
$message = "Unable to delete file " . $f->__toString() . ": " . $e->getMessage();
if($this->failonerror) {
throw new BuildException($message);
} else {
$this->log($message, $this->quiet ? Project::MSG_VERBOSE : Project::MSG_WARN);
}
}
}
}
if (count($dirs) > 0 && $this->includeEmpty) {
$dirCount = 0;
for ($j=count($dirs)-1; $j>=0; --$j) {
$dir = new PhingFile($d, $dirs[$j]);
$dirFiles = $dir->listDir();
if ($dirFiles === null || count($dirFiles) === 0) {
$this->log("Deleting " . $dir->__toString(), $this->verbosity);
try {
$dir->delete();
$dirCount++;
} catch (Exception $e) {
$message="Unable to delete directory " . $dir->__toString();
if($this->failonerror) {
throw new BuildException($message);
} else {
$this->log($message, $this->quiet ? Project::MSG_VERBOSE : Project::MSG_WARN);
}
}
}
}
if ($dirCount > 0) {
$this->log("Deleted $dirCount director" . ($dirCount==1 ? "y" : "ies") . " from " . $d->__toString());
}
}
}
}
|
