-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
FileHeaderSniff.php
330 lines (281 loc) · 12.3 KB
/
FileHeaderSniff.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
<?php
/**
* Checks the format of the file header.
*
* @author Greg Sherwood <gsherwood@squiz.net>
* @copyright 2006-2019 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
*/
namespace PHP_CodeSniffer\Standards\PSR12\Sniffs\Files;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Util\Tokens;
class FileHeaderSniff implements Sniff
{
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array
*/
public function register()
{
return [T_OPEN_TAG];
}//end register()
/**
* Processes this sniff when one of its tokens is encountered.
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current
* token in the stack.
*
* @return int|null
*/
public function process(File $phpcsFile, $stackPtr)
{
$tokens = $phpcsFile->getTokens();
/*
First, gather information about the statements inside
the file header.
*/
$headerLines = [];
$headerLines[] = [
'type' => 'tag',
'start' => $stackPtr,
'end' => $stackPtr,
];
$next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
if ($next === false) {
return;
}
$foundDocblock = false;
$commentOpeners = Tokens::$scopeOpeners;
unset($commentOpeners[T_NAMESPACE]);
unset($commentOpeners[T_DECLARE]);
unset($commentOpeners[T_USE]);
do {
switch ($tokens[$next]['code']) {
case T_DOC_COMMENT_OPEN_TAG:
if ($foundDocblock === true) {
// Found a second docblock, so start of code.
break(2);
}
// Make sure this is not a code-level docblock.
$end = $tokens[$next]['comment_closer'];
$docToken = $phpcsFile->findNext(Tokens::$emptyTokens, ($end + 1), null, true);
if (isset($commentOpeners[$tokens[$docToken]['code']]) === false
&& isset(Tokens::$methodPrefixes[$tokens[$docToken]['code']]) === false
) {
// Check for an @var annotation.
$annotation = false;
for ($i = $next; $i < $end; $i++) {
if ($tokens[$i]['code'] === T_DOC_COMMENT_TAG
&& strtolower($tokens[$i]['content']) === '@var'
) {
$annotation = true;
break;
}
}
if ($annotation === false) {
$foundDocblock = true;
$headerLines[] = [
'type' => 'docblock',
'start' => $next,
'end' => $end,
];
}
}//end if
$next = $end;
break;
case T_DECLARE:
case T_NAMESPACE:
$end = $phpcsFile->findEndOfStatement($next);
$headerLines[] = [
'type' => substr(strtolower($tokens[$next]['type']), 2),
'start' => $next,
'end' => $end,
];
$next = $end;
break;
case T_USE:
$type = 'use';
$useType = $phpcsFile->findNext(Tokens::$emptyTokens, ($next + 1), null, true);
if ($useType !== false && $tokens[$useType]['code'] === T_STRING) {
$content = strtolower($tokens[$useType]['content']);
if ($content === 'function' || $content === 'const') {
$type .= ' '.$content;
}
}
$end = $phpcsFile->findEndOfStatement($next);
$headerLines[] = [
'type' => $type,
'start' => $next,
'end' => $end,
];
$next = $end;
break;
default:
// Skip comments as PSR-12 doesn't say if these are allowed or not.
if (isset(Tokens::$commentTokens[$tokens[$next]['code']]) === true) {
$next = $phpcsFile->findNext(Tokens::$commentTokens, ($next + 1), null, true);
if ($next === false) {
// We reached the end of the file.
break(2);
}
$next--;
break;
}
// We found the start of the main code block.
break(2);
}//end switch
$next = $phpcsFile->findNext(T_WHITESPACE, ($next + 1), null, true);
} while ($next !== false);
if (count($headerLines) === 1) {
// This is only an open tag and doesn't contain the file header.
// We need to keep checking for one in case they put it further
// down in the file.
return;
}
/*
Next, check the spacing and grouping of the statements
inside each header block.
*/
$found = [];
foreach ($headerLines as $i => $line) {
if (isset($headerLines[($i + 1)]) === false
|| $headerLines[($i + 1)]['type'] !== $line['type']
) {
// We're at the end of the current header block.
// Make sure there is a single blank line after
// this block.
$next = $phpcsFile->findNext(T_WHITESPACE, ($line['end'] + 1), null, true);
if ($next !== false && $tokens[$next]['line'] !== ($tokens[$line['end']]['line'] + 2)) {
$error = 'Header blocks must be separated by a single blank line';
$fix = $phpcsFile->addFixableError($error, $line['end'], 'SpacingAfterBlock');
if ($fix === true) {
if ($tokens[$next]['line'] === $tokens[$line['end']]['line']) {
$phpcsFile->fixer->addNewlineBefore($next);
$phpcsFile->fixer->addNewlineBefore($next);
} else if ($tokens[$next]['line'] === ($tokens[$line['end']]['line'] + 1)) {
$phpcsFile->fixer->addNewline($line['end']);
} else {
$phpcsFile->fixer->beginChangeset();
for ($i = ($line['end'] + 1); $i < $next; $i++) {
if ($tokens[$i]['line'] === ($tokens[$line['end']]['line'] + 2)) {
break;
}
$phpcsFile->fixer->replaceToken($i, '');
}
$phpcsFile->fixer->endChangeset();
}
}//end if
}//end if
// Make sure we haven't seen this next block before.
if (isset($headerLines[($i + 1)]) === true
&& isset($found[$headerLines[($i + 1)]['type']]) === true
) {
$error = 'Similar statements must be grouped together inside header blocks; ';
$error .= 'the first "%s" statement was found on line %s';
$data = [
$headerLines[($i + 1)]['type'],
$tokens[$found[$headerLines[($i + 1)]['type']]['start']]['line'],
];
$phpcsFile->addError($error, $headerLines[($i + 1)]['start'], 'IncorrectGrouping', $data);
}
} else if ($headerLines[($i + 1)]['type'] === $line['type']) {
// Still in the same block, so make sure there is no
// blank line after this statement.
$next = $phpcsFile->findNext(T_WHITESPACE, ($line['end'] + 1), null, true);
if ($tokens[$next]['line'] > ($tokens[$line['end']]['line'] + 1)) {
$error = 'Header blocks must not contain blank lines';
$fix = $phpcsFile->addFixableError($error, $line['end'], 'SpacingInsideBlock');
if ($fix === true) {
$phpcsFile->fixer->beginChangeset();
for ($i = ($line['end'] + 1); $i < $next; $i++) {
if ($tokens[$i]['line'] === $tokens[$line['end']]['line']) {
continue;
}
if ($tokens[$i]['line'] === $tokens[$next]['line']) {
break;
}
$phpcsFile->fixer->replaceToken($i, '');
}
$phpcsFile->fixer->endChangeset();
}
}
}//end if
if (isset($found[$line['type']]) === false) {
$found[$line['type']] = $line;
}
}//end foreach
/*
Next, check that the order of the header blocks
is correct:
Opening php tag.
File-level docblock.
One or more declare statements.
The namespace declaration of the file.
One or more class-based use import statements.
One or more function-based use import statements.
One or more constant-based use import statements.
*/
$blockOrder = [
'tag' => 'opening PHP tag',
'docblock' => 'file-level docblock',
'declare' => 'declare statements',
'namespace' => 'namespace declaration',
'use' => 'class-based use imports',
'use function' => 'function-based use imports',
'use const' => 'constant-based use imports',
];
foreach (array_keys($found) as $type) {
if ($type === 'tag') {
// The opening tag is always in the correct spot.
continue;
}
do {
$orderedType = next($blockOrder);
} while ($orderedType !== false && key($blockOrder) !== $type);
if ($orderedType === false) {
// We didn't find the block type in the rest of the
// ordered array, so it is out of place.
// Error and reset the array to the correct position
// so we can check the next block.
reset($blockOrder);
$prevValidType = 'tag';
do {
$orderedType = next($blockOrder);
if (isset($found[key($blockOrder)]) === true
&& key($blockOrder) !== $type
) {
$prevValidType = key($blockOrder);
}
} while ($orderedType !== false && key($blockOrder) !== $type);
$error = 'The %s must follow the %s in the file header';
$data = [
$blockOrder[$type],
$blockOrder[$prevValidType],
];
$phpcsFile->addError($error, $found[$type]['start'], 'IncorrectOrder', $data);
}//end if
}//end foreach
/*
Finally, make sure this header block is at the very
top of the file.
*/
if ($stackPtr !== 0) {
// Allow for hashbang lines.
$hashbang = false;
if ($tokens[($stackPtr - 1)]['code'] === T_INLINE_HTML) {
$content = trim($tokens[($stackPtr - 1)]['content']);
if (substr($content, 0, 2) === '#!') {
$hashbang = true;
}
}
if ($hashbang === false) {
$error = 'The file header must be the first content in the file';
$phpcsFile->addError($error, $stackPtr, 'HeaderPosition');
}
}
return $phpcsFile->numTokens;
}//end process()
}//end class