Chris@0: <?php
Chris@0: 
Chris@0: /**
Chris@17:  * \DrupalPractice\Sniffs\Yaml\RoutingAccessSniff.
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@0: 
Chris@17: namespace DrupalPractice\Sniffs\Yaml;
Chris@17: 
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17: 
Chris@0: /**
Chris@0:  * Checks that there are no undocumented open access callbacks in *.routing.yml files.
Chris@0:  *
Chris@0:  * Also adds a warning if the permission "access administration pages" is used.
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@17: class RoutingAccessSniff implements Sniff
Chris@0: {
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns an array of tokens this test wants to listen for.
Chris@0:      *
Chris@0:      * @return array
Chris@0:      */
Chris@0:     public function register()
Chris@0:     {
Chris@0:         return array(T_INLINE_HTML);
Chris@0: 
Chris@0:     }//end register()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Processes this test, when one of its tokens is encountered.
Chris@0:      *
Chris@17:      * @param \PHP_CodeSniffer\Files\File $phpcsFile The current file being processed.
Chris@17:      * @param int                         $stackPtr  The position of the current token
Chris@17:      *                                               in the stack passed in $tokens.
Chris@0:      *
Chris@0:      * @return int
Chris@0:      */
Chris@17:     public function process(File $phpcsFile, $stackPtr)
Chris@0:     {
Chris@0:         $tokens = $phpcsFile->getTokens();
Chris@0: 
Chris@0:         $fileExtension = strtolower(substr($phpcsFile->getFilename(), -12));
Chris@0:         if ($fileExtension !== '.routing.yml') {
Chris@0:             return ($phpcsFile->numTokens + 1);
Chris@0:         }
Chris@0: 
Chris@0:         if (preg_match('/^[\s]+_access: \'TRUE\'/', $tokens[$stackPtr]['content']) === 1
Chris@0:             && isset($tokens[($stackPtr - 1)]) === true
Chris@0:             && preg_match('/^[\s]*#/', $tokens[($stackPtr - 1)]['content']) === 0
Chris@0:         ) {
Chris@0:             $warning = 'Open page callback found, please add a comment before the line why there is no access restriction';
Chris@0:             $phpcsFile->addWarning($warning, $stackPtr, 'OpenCallback');
Chris@0:         }
Chris@0: 
Chris@0:         if (preg_match('/^[\s]+_permission: \'access administration pages\'/', $tokens[$stackPtr]['content']) === 1) {
Chris@0:             $warning = 'The administration page callback should probably use "administer site configuration" - which implies the user can change something - rather than "access administration pages" which is about viewing but not changing configurations.';
Chris@0:             $phpcsFile->addWarning($warning, $stackPtr, 'PermissionFound');
Chris@0:         }
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class