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
|
<?php
/**
* Squiz_Sniffs_PHP_CommentedOutCodeSniff.
*
* PHP version 5
*
* @category PHP
* @package PHP_CodeSniffer
* @author Greg Sherwood <gsherwood@squiz.net>
* @author Marc McIntyre <mmcintyre@squiz.net>
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
* @link http://pear.php.net/package/PHP_CodeSniffer
*/
/**
* Squiz_Sniffs_PHP_CommentedOutCodeSniff.
*
* Warn about commented out code.
*
* @category PHP
* @package PHP_CodeSniffer
* @author Greg Sherwood <gsherwood@squiz.net>
* @author Marc McIntyre <mmcintyre@squiz.net>
* @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
* @version Release: 1.3.3
* @link http://pear.php.net/package/PHP_CodeSniffer
*/
class Squiz_Sniffs_PHP_CommentedOutCodeSniff implements PHP_CodeSniffer_Sniff
{
/**
* A list of tokenizers this sniff supports.
*
* @var array
*/
public $supportedTokenizers = array(
'PHP',
'CSS',
);
/**
* If a comment is more than $maxPercentage% code, a warning will be shown.
*
* @var int
*/
public $maxPercentage = 35;
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array
*/
public function register()
{
return PHP_CodeSniffer_Tokens::$commentTokens;
}//end register()
/**
* Processes this test, when one of its tokens is encountered.
*
* @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current token
* in the stack passed in $tokens.
*
* @return void
*/
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
{
$tokens = $phpcsFile->getTokens();
// Process whole comment blocks at once, so skip all but the first token.
if ($stackPtr > 0 && $tokens[$stackPtr]['code'] === $tokens[($stackPtr - 1)]['code']) {
return;
}
// Ignore comments at the end of code blocks.
if (substr($tokens[$stackPtr]['content'], 0, 6) === '//end ') {
return;
}
$content = '';
if ($phpcsFile->tokenizerType === 'PHP') {
$content = '<?php ';
}
for ($i = $stackPtr; $i < $phpcsFile->numTokens; $i++) {
if ($tokens[$stackPtr]['code'] !== $tokens[$i]['code']) {
break;
}
/*
Trim as much off the comment as possible so we don't
have additional whitespace tokens or comment tokens
*/
$tokenContent = trim($tokens[$i]['content']);
if (substr($tokenContent, 0, 2) === '//') {
$tokenContent = substr($tokenContent, 2);
}
if (substr($tokenContent, 0, 1) === '#') {
$tokenContent = substr($tokenContent, 1);
}
if (substr($tokenContent, 0, 3) === '/**') {
$tokenContent = substr($tokenContent, 3);
}
if (substr($tokenContent, 0, 2) === '/*') {
$tokenContent = substr($tokenContent, 2);
}
if (substr($tokenContent, -2) === '*/') {
$tokenContent = substr($tokenContent, 0, -2);
}
if (substr($tokenContent, 0, 1) === '*') {
$tokenContent = substr($tokenContent, 1);
}
$content .= $tokenContent.$phpcsFile->eolChar;
}//end for
$content = trim($content);
if ($phpcsFile->tokenizerType === 'PHP') {
$content .= ' ?>';
}
// Quite a few comments use multiple dashes, equals signs etc
// to frame comments and licence headers.
$content = preg_replace('/[-=*]+/', '-', $content);
$stringTokens = PHP_CodeSniffer_File::tokenizeString($content, $phpcsFile->tokenizer, $phpcsFile->eolChar);
$emptyTokens = array(
T_WHITESPACE,
T_STRING,
T_STRING_CONCAT,
T_ENCAPSED_AND_WHITESPACE,
T_NONE,
);
$numTokens = count($stringTokens);
/*
We know what the first two and last two tokens should be
(because we put them there) so ignore this comment if those
tokens were not parsed correctly. It obvously means this is not
valid code.
*/
// First token is always the opening PHP tag.
if ($stringTokens[0]['code'] !== T_OPEN_TAG) {
return;
}
// Last token is always the closing PHP tag.
if ($stringTokens[($numTokens - 1)]['code'] !== T_CLOSE_TAG) {
return;
}
// Second last token is always whitespace or a comment, depending
// on the code inside the comment.
if (in_array($stringTokens[($numTokens - 2)]['code'], PHP_CodeSniffer_Tokens::$emptyTokens) === false) {
return;
}
$numComment = 0;
$numCode = 0;
for ($i = 0; $i < $numTokens; $i++) {
if (in_array($stringTokens[$i]['code'], $emptyTokens) === true) {
// Looks like comment.
$numComment++;
} else {
// Looks like code.
$numCode++;
}
}
// We subtract 3 from the token number so we ignore the start/end tokens
// and their surrounding whitespace. We take 2 off the number of code
// tokens so we ignore the start/end tokens.
if ($numTokens > 3) {
$numTokens -= 3;
}
if ($numCode >= 2) {
$numCode -= 2;
}
$percentCode = ceil((($numCode / $numTokens) * 100));
if ($percentCode > $this->maxPercentage) {
// Just in case.
$percentCode = min(100, $percentCode);
$error = 'This comment is %s%% valid code; is this commented out code?';
$data = array($percentCode);
$phpcsFile->addWarning($error, $stackPtr, 'Found', $data);
}
}//end process()
}//end class
?>
|