-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathPhpCpd.php
More file actions
169 lines (143 loc) · 4.4 KB
/
Copy pathPhpCpd.php
File metadata and controls
169 lines (143 loc) · 4.4 KB
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
<?php
declare(strict_types=1);
namespace PHPCensor\Plugins\CodeQuality;
use PHPCensor\Common\Build\BuildErrorInterface;
use PHPCensor\Common\Build\BuildInterface;
use PHPCensor\Common\Build\BuildMetaInterface;
use PHPCensor\Common\Exception\Exception;
use PHPCensor\Common\Plugin\Plugin;
use PHPCensor\Common\Plugin\ZeroConfigPluginInterface;
/**
* PHP Copy / Paste Detector - Allows PHP Copy / Paste Detector testing.
*
* @package PHP Censor
* @subpackage Plugins
*
* @author Dmitry Khomutov <poisoncorpsee@gmail.com>
* @author Dan Cryer <dan@block8.co.uk>
*/
class PhpCpd extends Plugin implements ZeroConfigPluginInterface
{
/**
* {@inheritDoc}
*/
public static function getName(): string
{
return 'php_cpd';
}
/**
* {@inheritDoc}
*/
public function execute(): bool
{
$ignoresString = '';
$ignoreForNewVersion = '';
$filesToIgnore = [];
foreach ($this->ignores as $ignore) {
$ignoreForNewVersion .= \sprintf(' --exclude="%s"', $ignore);
$ignore = \rtrim($ignore, '/');
if (\is_file($this->build->getBuildPath() . $ignore)) {
$ignoredFile = \explode('/', $ignore);
$filesToIgnore[] = \array_pop($ignoredFile);
} else {
$ignoresString .= \sprintf(' --exclude="%s"', $ignore);
}
}
if ($filesToIgnore) {
$filesToIgnore = \sprintf(' --names-exclude="%s"', \implode(',', $filesToIgnore));
$ignoresString = $ignoresString . $filesToIgnore;
}
$executable = $this->commandExecutor->findBinary($this->binaryNames, $this->binaryPath);
$lastLine = \exec(
\sprintf(
('cd "%s" && ' . $executable . ' %s "%s" --version'),
$this->build->getBuildPath(),
$ignoresString,
$this->directory
)
);
if (\str_contains($lastLine, '--names-exclude')) {
$ignoresString = $ignoreForNewVersion;
}
$tmpFileName = \tempnam(\sys_get_temp_dir(), (self::getName() . '_'));
$cmd = 'cd "%s" && ' . $executable . ' --log-pmd "%s" %s "%s"';
$success = $this->commandExecutor->executeCommand(
$cmd,
$this->build->getBuildPath(),
$tmpFileName,
$ignoresString,
$this->directory
);
$errorCount = $this->processReport(\file_get_contents($tmpFileName));
$this->buildMetaWriter->write(
$this->build->getId(),
self::getName(),
BuildMetaInterface::KEY_WARNINGS,
$errorCount
);
\unlink($tmpFileName);
return $success;
}
/**
* {@inheritDoc}
*/
public static function canExecute(string $stage, BuildInterface $build): bool
{
if (BuildInterface::STAGE_TEST === $stage) {
return true;
}
return false;
}
/**
* {@inheritDoc}
*/
protected function initPluginSettings(): void
{
}
/**
* {@inheritDoc}
*/
protected function getPluginDefaultBinaryNames(): array
{
return [
'phpcpd',
'phpcpd.phar',
];
}
/**
* Process the PHPCPD XML report.
*
* @throws Exception
*/
private function processReport(string $xmlString): int
{
$xml = \simplexml_load_string($xmlString);
if (false === $xml) {
throw new Exception('Could not process the report generated by PHPCpd. XML content: ' . $xmlString);
}
$warnings = 0;
foreach ($xml->duplication as $duplication) {
foreach ($duplication->file as $file) {
$fileName = (string)$file['path'];
$fileName = \str_replace($this->build->getBuildPath(), '', $fileName);
$message = <<<CPD
Copy and paste detected:
```
{$duplication->codefragment}
```
CPD;
$this->buildErrorWriter->write(
$this->build->getId(),
self::getName(),
$message,
BuildErrorInterface::SEVERITY_NORMAL,
$fileName,
(int)$file['line'],
(int)($file['line'] + $duplication['lines'])
);
}
$warnings++;
}
return $warnings;
}
}