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
|
<?php
/*
* $Id: FileList.php,v 1.10 2005/11/01 15:26:09 hlellelid Exp $
*
* 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/types/DataType.php';
include_once 'phing/system/io/PhingFile.php';
/**
* FileList represents an explicitly named list of files. FileLists
* are useful when you want to capture a list of files regardless of
* whether they currently exist.
*
* <filelist
* id="docfiles"
* dir="${phing.docs.dir}"
* files="chapters/Installation.html,chapters/Setup.html"/>
*
* OR
*
* <filelist
* dir="${doc.src.dir}"
* listfile="${phing.docs.dir}/PhingGuide.book"/>
*
* (or a mixture of files="" and listfile="" can be used)
*
* @author Hans Lellelid <hans@xmpl.org>
* @version $Revision: 1.10 $
* @package phing.types
*/
class FileList extends DataType {
// public for "cloning" purposes
/** Array containing all filenames. */
public $filenames = array();
/** Base directory for this file list. */
public $dir;
/** PhingFile that contains a list of files (one per line). */
public $listfile;
/**
* Construct a new FileList.
* @param array $filelist;
*/
function __construct($filelist = null) {
if ($filelist !== null) {
$this->dir = $filelist->dir;
$this->filenames = $filelist->filenames;
$this->listfile = $filelist->listfile;
}
}
/**
* Makes this instance in effect a reference to another FileList
* instance.
*/
function setRefid(Reference $r) {
if ($this->dir !== null || count($this->filenames) !== 0) {
throw $this->tooManyAttributes();
}
parent::setRefid($r);
}
/**
* Base directory for files in list.
* @param PhingFile $dir
*/
function setDir(PhingFile $dir) {
if ($this->isReference()) {
throw $this->tooManyAttributes();
}
if (!($dir instanceof PhingFile)) {
$dir = new PhingFile($dir);
}
$this->dir = $dir;
}
/**
* Get the basedir for files in list.
* @return PhingFile
*/
function getDir(Project $p) {
if ($this->isReference()) {
$ref = $this->getRef($p);
return $ref->getDir($p);
}
return $this->dir;
}
/**
* Set the array of files in list.
* @param array $filenames
*/
function setFiles($filenames) {
if ($this->isReference()) {
throw $this->tooManyAttributes();
}
if (!empty($filenames)) {
$tok = strtok($filenames, ", \t\n\r");
while ($tok !== false) {
$fname = trim($tok);
if ($fname !== "") {
$this->filenames[] = $tok;
}
$tok = strtok(", \t\n\r");
}
}
}
/**
* Sets a source "list" file that contains filenames to add -- one per line.
* @param string $file
*/
function setListFile($file) {
if ($this->isReference()) {
throw $this->tooManyAttributes();
}
if (!($file instanceof PhingFile)) {
$file = new PhingFile($file);
}
$this->listfile = $file;
}
/**
* Get the source "list" file that contains file names.
* @return PhingFile
*/
function getListFile() {
if ($this->isReference()) {
$ref = $this->getRef($p);
return $ref->getListFile($p);
}
return $this->listfile;
}
/**
* Returns the list of files represented by this FileList.
* @param Project $p
* @return array
*/
function getFiles(Project $p) {
if ($this->isReference()) {
$ret = $this->getRef($p);
$ret = $ret->getFiles($p);
return $ret;
}
if ($this->listfile !== null) {
$this->readListFile($p);
}
return $this->filenames;
}
/**
* Performs the check for circular references and returns the
* referenced FileSet.
* @param Project $p
*/
function getRef(Project $p) {
if (!$this->checked) {
$stk = array();
array_push($stk, $this);
$this->dieOnCircularReference($stk, $p);
}
$o = $this->ref->getReferencedObject($p);
if (!($o instanceof FileList)) {
throw new BuildException($this->ref->getRefId()." doesn't denote a filelist");
} else {
return $o;
}
}
/**
* Reads file names from a file and adds them to the files array.
* @param Project $p
*/
private function readListFile(Project $p) {
$listReader = null;
try {
// Get a FileReader
$listReader = new BufferedReader(new FileReader($this->listfile));
$line = $listReader->readLine();
while ($line !== null) {
if (!empty($line)) {
$line = $p->replaceProperties($line);
$this->filenames[] = trim($line);
}
$line = $listReader->readLine();
}
} catch (Exception $e) {
if ($listReader) $listReader->close();
throw new BuildException("An error occured while reading from list file " . $this->listfile->__toString() . ": " . $e->getMessage());
}
$listReader->close();
}
}
|
