/
PHPCPDTask.php
349 lines (297 loc) · 9 KB
/
PHPCPDTask.php
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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
<?php
use SebastianBergmann\PHPCPD\Detector\Strategy\DefaultStrategy;
use Composer\Autoload\ClassLoader;
/**
* 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>.
*/
/**
* Runs PHP Copy & Paste Detector. Checking PHP files for duplicated code.
* Refactored original PhpCpdTask provided by
* Timo Haberkern <timo.haberkern@fantastic-bits.de>
*
* @package phing.tasks.ext.phpcpd
* @author Benjamin Schultz <bschultz@proqrent.de>
*/
class PHPCPDTask extends Task
{
use FileSetAware;
/**
* A php source code filename or directory
*
* @var PhingFile
*/
protected $file = null;
/**
* Minimum number of identical lines.
*
* @var integer
*/
protected $minLines = 5;
/**
* Minimum number of identical tokens.
*
* @var integer
*/
protected $minTokens = 70;
/**
* Allow for fuzzy matches.
*
* @var boolean
*/
protected $fuzzy = false;
/**
* List of valid file extensions for analyzed files.
*
* @var array
*/
protected $allowedFileExtensions = ['php'];
/**
* List of exclude directory patterns.
*
* @var array
*/
protected $ignorePatterns = ['.git', '.svn', 'CVS', '.bzr', '.hg'];
/**
* The format for the report
*
* @var string
*/
protected $format = 'default';
/**
* Formatter elements.
*
* @var PHPCPDFormatterElement[]
*/
protected $formatters = [];
/**
* @var bool
*/
protected $oldVersion = false;
/**
* @var string
*/
private $pharLocation = "";
/**
* Set the input source file or directory.
*
* @param PhingFile $file The input source file or directory.
*/
public function setFile(PhingFile $file)
{
$this->file = $file;
}
/**
* Sets the minimum number of identical lines (default: 5).
*
* @param integer $minLines Minimum number of identical lines
*/
public function setMinLines($minLines)
{
$this->minLines = $minLines;
}
/**
* Sets the minimum number of identical tokens (default: 70).
*
* @param integer $minTokens Minimum number of identical tokens
*/
public function setMinTokens($minTokens)
{
$this->minTokens = $minTokens;
}
/**
* Sets the fuzzy match (default: false).
*
* @param boolean $fuzzy fuzzy match
*/
public function setFuzzy($fuzzy)
{
$this->fuzzy = $fuzzy;
}
/**
* Sets a list of filename extensions for valid php source code files.
*
* @param string $fileExtensions List of valid file extensions.
*/
public function setAllowedFileExtensions($fileExtensions)
{
$this->allowedFileExtensions = [];
$token = ' ,;';
$ext = strtok($fileExtensions, $token);
while ($ext !== false) {
$this->allowedFileExtensions[] = $ext;
$ext = strtok($token);
}
}
/**
* Sets a list of ignore patterns that is used to exclude directories from the source analysis.
*
* @param string $ignorePatterns List of ignore patterns.
*/
public function setIgnorePatterns($ignorePatterns)
{
$this->ignorePatterns = [];
$token = ' ,;';
$pattern = strtok($ignorePatterns, $token);
while ($pattern !== false) {
$this->ignorePatterns[] = $pattern;
$pattern = strtok($token);
}
}
/**
* Sets the output format
*
* @param string $format Format of the report
*/
public function setFormat($format)
{
$this->format = $format;
}
/**
* Create object for nested formatter element.
*
* @return PHPCPDFormatterElement
*/
public function createFormatter()
{
$num = array_push($this->formatters, new PHPCPDFormatterElement($this));
return $this->formatters[$num - 1];
}
/**
* @param string $pharLocation
*/
public function setPharLocation($pharLocation)
{
$this->pharLocation = $pharLocation;
}
/**
* @throws BuildException if the phpcpd classes can't be loaded
*/
private function loadDependencies()
{
if (!empty($this->pharLocation)) {
// hack to prevent PHPCPD from starting in CLI mode and halting Phing
eval(
"namespace SebastianBergmann\PHPCPD\CLI;
class Application
{
public function run() {}
}"
);
ob_start();
include $this->pharLocation;
ob_end_clean();
if (class_exists('\\SebastianBergmann\\PHPCPD\\Detector\\Strategy\\DefaultStrategy')) {
return;
}
}
if (
class_exists(ClassLoader::class, false) &&
class_exists(DefaultStrategy::class)
) {
return;
}
if ($handler = @fopen('SebastianBergmann/PHPCPD/autoload.php', 'r', true)) {
fclose($handler);
@include_once 'SebastianBergmann/PHPCPD/autoload.php';
return;
}
if ($handler = @fopen('PHPCPD/Autoload.php', 'r', true)) {
fclose($handler);
@include_once 'PHPCPD/Autoload.php';
$this->oldVersion = true;
return;
}
throw new BuildException(
'PHPCPDTask depends on PHPCPD being installed and on include_path.',
$this->getLocation()
);
}
/**
* Executes PHPCPD against PhingFile or a FileSet
*
* @throws BuildException
*/
public function main()
{
$this->loadDependencies();
if (!isset($this->file) && count($this->filesets) == 0) {
throw new BuildException('Missing either a nested fileset or attribute "file" set');
}
if (count($this->formatters) == 0) {
// turn legacy format attribute into formatter
$fmt = new PHPCPDFormatterElement($this);
$fmt->setType($this->format);
$fmt->setUseFile(false);
$this->formatters[] = $fmt;
}
$this->validateFormatters();
$filesToParse = [];
if ($this->file instanceof PhingFile) {
$filesToParse[] = $this->file->getPath();
} else {
// append any files in filesets
foreach ($this->filesets as $fs) {
$files = $fs->getDirectoryScanner($this->project)->getIncludedFiles();
foreach ($files as $filename) {
$f = new PhingFile($fs->getDir($this->project), $filename);
$filesToParse[] = $f->getAbsolutePath();
}
}
}
$this->log('Processing files...');
if ($this->oldVersion) {
$detectorClass = 'PHPCPD_Detector';
$strategyClass = 'PHPCPD_Detector_Strategy_Default';
} else {
$detectorClass = '\\SebastianBergmann\\PHPCPD\\Detector\\Detector';
$strategyClass = '\\SebastianBergmann\\PHPCPD\\Detector\\Strategy\\DefaultStrategy';
}
$detector = new $detectorClass(new $strategyClass());
$clones = $detector->copyPasteDetection(
$filesToParse,
$this->minLines,
$this->minTokens,
$this->fuzzy
);
$this->log('Finished copy/paste detection');
foreach ($this->formatters as $fe) {
$formatter = $fe->getFormatter();
$formatter->processClones(
$clones,
$this->project,
$fe->getUseFile(),
$fe->getOutfile()
);
}
}
/**
* Validates the available formatters
*
* @throws BuildException
*/
protected function validateFormatters()
{
foreach ($this->formatters as $fe) {
if ($fe->getType() == '') {
throw new BuildException('Formatter missing required "type" attribute.');
}
if ($fe->getUsefile() && $fe->getOutfile() === null) {
throw new BuildException('Formatter requires "outfile" attribute when "useFile" is true.');
}
}
}
}