Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@17
|
3 * \DrupalPractice\Sniffs\FunctionDefinitions\AccessHookMenuSniff.
|
Chris@0
|
4 *
|
Chris@0
|
5 * @category PHP
|
Chris@0
|
6 * @package PHP_CodeSniffer
|
Chris@0
|
7 * @link http://pear.php.net/package/PHP_CodeSniffer
|
Chris@0
|
8 */
|
Chris@0
|
9
|
Chris@17
|
10 namespace DrupalPractice\Sniffs\FunctionDefinitions;
|
Chris@17
|
11
|
Chris@17
|
12 use PHP_CodeSniffer\Files\File;
|
Chris@17
|
13 use Drupal\Sniffs\Semantics\FunctionDefinition;
|
Chris@17
|
14 use PHP_CodeSniffer\Util\Tokens;
|
Chris@17
|
15
|
Chris@0
|
16 /**
|
Chris@0
|
17 * Checks that there are no undocumented open access callbacks in hook_menu().
|
Chris@0
|
18 *
|
Chris@0
|
19 * @category PHP
|
Chris@0
|
20 * @package PHP_CodeSniffer
|
Chris@0
|
21 * @link http://pear.php.net/package/PHP_CodeSniffer
|
Chris@0
|
22 */
|
Chris@17
|
23 class AccessHookMenuSniff extends FunctionDefinition
|
Chris@0
|
24 {
|
Chris@0
|
25
|
Chris@0
|
26
|
Chris@0
|
27 /**
|
Chris@0
|
28 * Process this function definition.
|
Chris@0
|
29 *
|
Chris@17
|
30 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
|
Chris@17
|
31 * @param int $stackPtr The position of the function name
|
Chris@17
|
32 * in the stack.
|
Chris@17
|
33 * @param int $functionPtr The position of the function keyword
|
Chris@17
|
34 * in the stack.
|
Chris@0
|
35 *
|
Chris@0
|
36 * @return void
|
Chris@0
|
37 */
|
Chris@17
|
38 public function processFunction(File $phpcsFile, $stackPtr, $functionPtr)
|
Chris@0
|
39 {
|
Chris@0
|
40 $fileExtension = strtolower(substr($phpcsFile->getFilename(), -6));
|
Chris@0
|
41 // Only check in *.module files.
|
Chris@0
|
42 if ($fileExtension !== 'module') {
|
Chris@0
|
43 return;
|
Chris@0
|
44 }
|
Chris@0
|
45
|
Chris@0
|
46 $fileName = substr(basename($phpcsFile->getFilename()), 0, -7);
|
Chris@0
|
47 $tokens = $phpcsFile->getTokens();
|
Chris@0
|
48 if ($tokens[$stackPtr]['content'] !== ($fileName.'_menu')) {
|
Chris@0
|
49 return;
|
Chris@0
|
50 }
|
Chris@0
|
51
|
Chris@0
|
52 // Search for 'access callabck' => TRUE in the function body.
|
Chris@0
|
53 $string = $phpcsFile->findNext(
|
Chris@0
|
54 T_CONSTANT_ENCAPSED_STRING,
|
Chris@0
|
55 $tokens[$functionPtr]['scope_opener'],
|
Chris@0
|
56 $tokens[$functionPtr]['scope_closer']
|
Chris@0
|
57 );
|
Chris@0
|
58 while ($string !== false) {
|
Chris@0
|
59 if (substr($tokens[$string]['content'], 1, -1) === 'access callback') {
|
Chris@0
|
60 $array_operator = $phpcsFile->findNext(
|
Chris@17
|
61 Tokens::$emptyTokens,
|
Chris@0
|
62 ($string + 1),
|
Chris@0
|
63 null,
|
Chris@0
|
64 true
|
Chris@0
|
65 );
|
Chris@0
|
66 if ($array_operator !== false
|
Chris@0
|
67 && $tokens[$array_operator]['code'] === T_DOUBLE_ARROW
|
Chris@0
|
68 ) {
|
Chris@0
|
69 $callback = $phpcsFile->findNext(
|
Chris@17
|
70 Tokens::$emptyTokens,
|
Chris@0
|
71 ($array_operator + 1),
|
Chris@0
|
72 null,
|
Chris@0
|
73 true
|
Chris@0
|
74 );
|
Chris@0
|
75 if ($callback !== false && $tokens[$callback]['code'] === T_TRUE) {
|
Chris@0
|
76 // Check if there is a comment before the line that might
|
Chris@0
|
77 // explain stuff.
|
Chris@0
|
78 $commentBefore = $phpcsFile->findPrevious(
|
Chris@0
|
79 T_WHITESPACE,
|
Chris@0
|
80 ($string - 1),
|
Chris@0
|
81 $tokens[$functionPtr]['scope_opener'],
|
Chris@0
|
82 true
|
Chris@0
|
83 );
|
Chris@17
|
84 if ($commentBefore !== false && in_array($tokens[$commentBefore]['code'], Tokens::$commentTokens) === false) {
|
Chris@0
|
85 $warning = 'Open page callback found, please add a comment before the line why there is no access restriction';
|
Chris@0
|
86 $phpcsFile->addWarning($warning, $callback, 'OpenCallback');
|
Chris@0
|
87 }
|
Chris@0
|
88 }
|
Chris@0
|
89 }//end if
|
Chris@0
|
90 }//end if
|
Chris@0
|
91
|
Chris@0
|
92 $string = $phpcsFile->findNext(
|
Chris@0
|
93 T_CONSTANT_ENCAPSED_STRING,
|
Chris@0
|
94 ($string + 1),
|
Chris@0
|
95 $tokens[$functionPtr]['scope_closer']
|
Chris@0
|
96 );
|
Chris@0
|
97 }//end while
|
Chris@0
|
98
|
Chris@0
|
99 }//end processFunction()
|
Chris@0
|
100
|
Chris@0
|
101
|
Chris@0
|
102 }//end class
|