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
|
<?php
/*
* $Id: 2e783b14ff093df7de21477479a123403d630984 $
*
* 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>.
*/
include_once 'phing/filters/BaseParamFilterReader.php';
include_once 'phing/filters/BaseFilterReader.php';
include_once 'phing/filters/ChainableReader.php';
/**
* Filter which includes only those lines that contain all the user-specified
* strings.
*
* Example:
*
* <pre><linecontains>
* <contains value="foo">
* <contains value="bar">
* </linecontains></pre>
*
* Or:
*
* <pre><filterreader classname="phing.filters.LineContains">
* <param type="contains" value="foo"/>
* <param type="contains" value="bar"/>
* </filterreader></pre>
*
* This will include only those lines that contain <code>foo</code> and
* <code>bar</code>.
*
* @author Yannick Lecaillez <yl@seasonfive.com>
* @author Hans Lellelid <hans@velum.net>
* @version $Id$
* @see PhingFilterReader
* @package phing.filters
*/
class LineContains extends BaseParamFilterReader implements ChainableReader {
/**
* The parameter name for the string to match on.
* @var string
*/
const CONTAINS_KEY = "contains";
/**
* Array of Contains objects.
* @var array
*/
private $_contains = array();
/**
* [Deprecated]
* @var string
*/
private $_line = null;
/**
* Returns all lines in a buffer that contain specified strings.
* @return mixed buffer, -1 on EOF
*/
function read($len = null) {
if ( !$this->getInitialized() ) {
$this->_initialize();
$this->setInitialized(true);
}
$buffer = $this->in->read($len);
if ($buffer === -1) {
return -1;
}
$lines = explode("\n", $buffer);
$matched = array();
$containsSize = count($this->_contains);
foreach($lines as $line) {
for($i = 0 ; $i < $containsSize ; $i++) {
$containsStr = $this->_contains[$i]->getValue();
if ( strstr($line, $containsStr) === false ) {
$line = null;
break;
}
}
if($line !== null) {
$matched[] = $line;
}
}
$filtered_buffer = implode("\n", $matched);
return $filtered_buffer;
}
/**
* [Deprecated. For reference only, used to be read() method.]
* Returns the next character in the filtered stream, only including
* lines from the original stream which contain all of the specified words.
*
* @return the next character in the resulting stream, or -1
* if the end of the resulting stream has been reached
*
* @exception IOException if the underlying stream throws an IOException
* during reading
*/
function readChar() {
if ( !$this->getInitialized() ) {
$this->_initialize();
$this->setInitialized(true);
}
$ch = -1;
if ( $this->_line !== null ) {
$ch = substr($this->_line, 0, 1);
if ( strlen($this->_line) === 1 )
$this->_line = null;
else
$this->_line = substr($this->_line, 1);
} else {
$this->_line = $this->readLine();
if ( $this->_line === null ) {
$ch = -1;
} else {
$containsSize = count($this->_contains);
for($i = 0 ; $i < $containsSize ; $i++) {
$containsStr = $this->_contains[$i]->getValue();
if ( strstr($this->_line, $containsStr) === false ) {
$this->_line = null;
break;
}
}
return $this->readChar();
}
}
return $ch;
}
/**
* Adds a <code>contains</code> nested element.
*
* @return Contains The <code>contains</code> element added.
* Must not be <code>null</code>.
*/
function createContains() {
$num = array_push($this->_contains, new Contains());
return $this->_contains[$num-1];
}
/**
* Sets the array of words which must be contained within a line read
* from the original stream in order for it to match this filter.
*
* @param array $contains An array of words which must be contained
* within a line in order for it to match in this filter.
* Must not be <code>null</code>.
*/
function setContains($contains) {
// type check, error must never occur, bad code of it does
if ( !is_array($contains) ) {
throw new Exception("Excpected array got something else");
}
$this->_contains = $contains;
}
/**
* Returns the vector of words which must be contained within a line read
* from the original stream in order for it to match this filter.
*
* @return array The array of words which must be contained within a line read
* from the original stream in order for it to match this filter. The
* returned object is "live" - in other words, changes made to the
* returned object are mirrored in the filter.
*/
function getContains() {
return $this->_contains;
}
/**
* Creates a new LineContains using the passed in
* Reader for instantiation.
*
* @param object A Reader object providing the underlying stream.
* Must not be <code>null</code>.
*
* @return object A new filter based on this configuration, but filtering
* the specified reader
*/
function chain(Reader $reader) {
$newFilter = new LineContains($reader);
$newFilter->setContains($this->getContains());
$newFilter->setInitialized(true);
$newFilter->setProject($this->getProject());
return $newFilter;
}
/**
* Parses the parameters to add user-defined contains strings.
*/
private function _initialize() {
$params = $this->getParameters();
if ( $params !== null ) {
foreach($params as $param) {
if ( self::CONTAINS_KEY == $param->getType() ) {
$cont = new Contains();
$cont->setValue($param->getValue());
array_push($this->_contains, $cont);
break; // because we only support a single contains
}
}
}
}
}
/**
* Holds a contains element.
*
* @package phing.filters
*/
class Contains {
/**
* @var string
*/
private $_value;
/**
* Set 'contains' value.
* @param string $contains
*/
function setValue($contains) {
$this->_value = (string) $contains;
}
/**
* Returns 'contains' value.
* @return string
*/
function getValue() {
return $this->_value;
}
}
|
