/web/vendors/PHP/CodeSniffer.php
PHP | 2137 lines | 1348 code | 272 blank | 517 comment | 231 complexity | e28237372078c1cc3f0cd4bf61432c32 MD5 | raw file
Possible License(s): Apache-2.0
Large files files are truncated, but you can click here to view the full file
- <?php
- /**
- * PHP_CodeSniffer tokenises PHP code and detects violations of a
- * defined set of coding standards.
- *
- * PHP version 5
- *
- * @category PHP
- * @package PHP_CodeSniffer
- * @author Greg Sherwood <gsherwood@squiz.net>
- * @author Marc McIntyre <mmcintyre@squiz.net>
- * @copyright 2006-2012 Squiz Pty Ltd (ABN 77 084 670 600)
- * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
- * @link http://pear.php.net/package/PHP_CodeSniffer
- */
- spl_autoload_register(array('PHP_CodeSniffer', 'autoload'));
- if (class_exists('PHP_CodeSniffer_Exception', true) === false) {
- throw new Exception('Class PHP_CodeSniffer_Exception not found');
- }
- if (class_exists('PHP_CodeSniffer_File', true) === false) {
- throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_File not found');
- }
- if (class_exists('PHP_CodeSniffer_Tokens', true) === false) {
- throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Tokens not found');
- }
- if (class_exists('PHP_CodeSniffer_CLI', true) === false) {
- throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_CLI not found');
- }
- if (interface_exists('PHP_CodeSniffer_Sniff', true) === false) {
- throw new PHP_CodeSniffer_Exception('Interface PHP_CodeSniffer_Sniff not found');
- }
- if (interface_exists('PHP_CodeSniffer_MultiFileSniff', true) === false) {
- throw new PHP_CodeSniffer_Exception('Interface PHP_CodeSniffer_MultiFileSniff not found');
- }
- /**
- * PHP_CodeSniffer tokenises PHP code and detects violations of a
- * defined set of coding standards.
- *
- * Standards are specified by classes that implement the PHP_CodeSniffer_Sniff
- * interface. A sniff registers what token types it wishes to listen for, then
- * PHP_CodeSniffer encounters that token, the sniff is invoked and passed
- * information about where the token was found in the stack, and the token stack
- * itself.
- *
- * Sniff files and their containing class must be prefixed with Sniff, and
- * have an extension of .php.
- *
- * Multiple PHP_CodeSniffer operations can be performed by re-calling the
- * process function with different parameters.
- *
- * @category PHP
- * @package PHP_CodeSniffer
- * @author Greg Sherwood <gsherwood@squiz.net>
- * @author Marc McIntyre <mmcintyre@squiz.net>
- * @copyright 2006-2012 Squiz Pty Ltd (ABN 77 084 670 600)
- * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
- * @version Release: 1.4.3
- * @link http://pear.php.net/package/PHP_CodeSniffer
- */
- class PHP_CodeSniffer
- {
- /**
- * The file or directory that is currently being processed.
- *
- * @var string
- */
- protected $file = '';
- /**
- * The files that have been processed.
- *
- * @var array(PHP_CodeSniffer_File)
- */
- protected $files = array();
- /**
- * A cache of different token types, resolved into arrays.
- *
- * @var array()
- * @see standardiseToken()
- */
- private static $_resolveTokenCache = array();
- /**
- * The directory to search for sniffs in.
- *
- * This is declared static because it is also used in the
- * autoloader to look for sniffs outside the PHPCS install.
- * This way, standards designed to be installed inside PHPCS can
- * also be used from outside the PHPCS Standards directory.
- *
- * @var string
- */
- protected static $standardDir = '';
- /**
- * The CLI object controlling the run.
- *
- * @var string
- */
- public $cli = null;
- /**
- * An array of sniffs that are being used to check files.
- *
- * @var array(PHP_CodeSniffer_Sniff)
- */
- protected $listeners = array();
- /**
- * An array of rules from the ruleset.xml file.
- *
- * It may be empty, indicating that the ruleset does not override
- * any of the default sniff settings.
- *
- * @var array
- */
- protected $ruleset = array();
- /**
- * The listeners array, indexed by token type.
- *
- * @var array
- */
- private $_tokenListeners = array(
- 'file' => array(),
- 'multifile' => array(),
- );
- /**
- * An array of patterns to use for skipping files.
- *
- * @var array
- */
- protected $ignorePatterns = array();
- /**
- * An array of extensions for files we will check.
- *
- * @var array
- */
- public $allowedFileExtensions = array(
- 'php' => 'PHP',
- 'inc' => 'PHP',
- 'js' => 'JS',
- 'css' => 'CSS',
- );
- /**
- * An array of variable types for param/var we will check.
- *
- * @var array(string)
- */
- public static $allowedTypes = array(
- 'array',
- 'boolean',
- 'float',
- 'integer',
- 'mixed',
- 'object',
- 'string',
- );
- /**
- * Constructs a PHP_CodeSniffer object.
- *
- * @param int $verbosity The verbosity level.
- * 1: Print progress information.
- * 2: Print tokenizer debug information.
- * 3: Print sniff debug information.
- * @param int $tabWidth The number of spaces each tab represents.
- * If greater than zero, tabs will be replaced
- * by spaces before testing each file.
- * @param string $encoding The charset of the sniffed files.
- * This is important for some reports that output
- * with utf-8 encoding as you don't want it double
- * encoding messages.
- * @param bool $interactive If TRUE, will stop after each file with errors
- * and wait for user input.
- *
- * @see process()
- */
- public function __construct(
- $verbosity=0,
- $tabWidth=0,
- $encoding='iso-8859-1',
- $interactive=false
- ) {
- if (defined('PHP_CODESNIFFER_VERBOSITY') === false) {
- define('PHP_CODESNIFFER_VERBOSITY', $verbosity);
- }
- if (defined('PHP_CODESNIFFER_TAB_WIDTH') === false) {
- define('PHP_CODESNIFFER_TAB_WIDTH', $tabWidth);
- }
- if (defined('PHP_CODESNIFFER_ENCODING') === false) {
- define('PHP_CODESNIFFER_ENCODING', $encoding);
- }
- if (defined('PHP_CODESNIFFER_INTERACTIVE') === false) {
- define('PHP_CODESNIFFER_INTERACTIVE', $interactive);
- }
- if (defined('PHPCS_DEFAULT_ERROR_SEV') === false) {
- define('PHPCS_DEFAULT_ERROR_SEV', 5);
- }
- if (defined('PHPCS_DEFAULT_WARN_SEV') === false) {
- define('PHPCS_DEFAULT_WARN_SEV', 5);
- }
- // Change into a directory that we know about to stop any
- // relative path conflicts.
- if (defined('PHPCS_CWD') === false) {
- define('PHPCS_CWD', getcwd());
- }
- chdir(dirname(__FILE__).'/CodeSniffer/');
- // Set default CLI object in case someone is running us
- // without using the command line script.
- $this->cli = new PHP_CodeSniffer_CLI();
- $this->cli->errorSeverity = PHPCS_DEFAULT_ERROR_SEV;
- $this->cli->warningSeverity = PHPCS_DEFAULT_WARN_SEV;
- }//end __construct()
- /**
- * Destructs a PHP_CodeSniffer object.
- *
- * Restores the current working directory to what it
- * was before we started our run.
- *
- * @return void
- */
- public function __destruct()
- {
- chdir(PHPCS_CWD);
- }//end __destruct()
- /**
- * Autoload static method for loading classes and interfaces.
- *
- * @param string $className The name of the class or interface.
- *
- * @return void
- */
- public static function autoload($className)
- {
- if (substr($className, 0, 4) === 'PHP_') {
- $newClassName = substr($className, 4);
- } else {
- $newClassName = $className;
- }
- $path = str_replace(array('_', '\\'), '/', $newClassName).'.php';
- if (is_file(dirname(__FILE__).'/'.$path) === true) {
- // Check standard file locations based on class name.
- include dirname(__FILE__).'/'.$path;
- } else if (is_file(dirname(__FILE__).'/CodeSniffer/Standards/'.$path) === true) {
- // Check for included sniffs.
- include dirname(__FILE__).'/CodeSniffer/Standards/'.$path;
- } else if (self::$standardDir !== ''
- && is_file(dirname(self::$standardDir).'/'.$path) === true
- ) {
- // Check standard file locations based on the passed standard directory.
- include dirname(self::$standardDir).'/'.$path;
- } else {
- // Everything else.
- @include $path;
- }
- }//end autoload()
- /**
- * Sets an array of file extensions that we will allow checking of.
- *
- * If the extension is one of the defaults, a specific tokenizer
- * will be used. Otherwise, the PHP tokenizer will be used for
- * all extensions passed.
- *
- * @param array $extensions An array of file extensions.
- *
- * @return void
- */
- public function setAllowedFileExtensions(array $extensions)
- {
- $newExtensions = array();
- foreach ($extensions as $ext) {
- if (isset($this->allowedFileExtensions[$ext]) === true) {
- $newExtensions[$ext] = $this->allowedFileExtensions[$ext];
- } else {
- $newExtensions[$ext] = 'PHP';
- }
- }
- $this->allowedFileExtensions = $newExtensions;
- }//end setAllowedFileExtensions()
- /**
- * Sets an array of ignore patterns that we use to skip files and folders.
- *
- * Patterns are not case sensitive.
- *
- * @param array $patterns An array of ignore patterns.
- *
- * @return void
- */
- public function setIgnorePatterns(array $patterns)
- {
- $this->ignorePatterns = $patterns;
- }//end setIgnorePatterns()
- /**
- * Gets the array of ignore patterns.
- *
- * Optionally takes a listener to get ignore patterns specified
- * for that sniff only.
- *
- * @param string $listener The listener to get patterns for. If NULL, all
- * patterns are returned.
- *
- * @return array
- */
- public function getIgnorePatterns($listener=null)
- {
- if ($listener === null) {
- return $this->ignorePatterns;
- }
- if (isset($this->ignorePatterns[$listener]) === true) {
- return $this->ignorePatterns[$listener];
- }
- return array();
- }//end getIgnorePatterns()
- /**
- * Sets the internal CLI object.
- *
- * @param object $cli The CLI object controlling the run.
- *
- * @return void
- */
- public function setCli($cli)
- {
- $this->cli = $cli;
- }//end setCli()
- /**
- * Adds a file to the list of checked files.
- *
- * Checked files are used to generate error reports after the run.
- *
- * @param PHP_CodeSniffer_File $phpcsFile The file to add.
- *
- * @return void
- */
- public function addFile(PHP_CodeSniffer_File $phpcsFile)
- {
- $this->files[] = $phpcsFile;
- }//end addFile()
- /**
- * Processes the files/directories that PHP_CodeSniffer was constructed with.
- *
- * @param string|array $files The files and directories to process. For
- * directories, each sub directory will also
- * be traversed for source files.
- * @param string $standard The set of code sniffs we are testing
- * against.
- * @param array $sniffs The sniff names to restrict the allowed
- * listeners to.
- * @param boolean $local If true, don't recurse into directories.
- *
- * @return void
- * @throws PHP_CodeSniffer_Exception If files or standard are invalid.
- */
- public function process($files, $standard, array $sniffs=array(), $local=false)
- {
- if (is_array($files) === false) {
- if (is_string($files) === false || $files === null) {
- throw new PHP_CodeSniffer_Exception('$file must be a string');
- }
- $files = array($files);
- }
- if (is_string($standard) === false || $standard === null) {
- throw new PHP_CodeSniffer_Exception('$standard must be a string');
- }
- // Reset the members.
- $this->listeners = array();
- $this->files = array();
- $this->ruleset = array();
- $this->_tokenListeners = array(
- 'file' => array(),
- 'multifile' => array(),
- );
- // Ensure this option is enabled or else line endings will not always
- // be detected properly for files created on a Mac with the /r line ending.
- ini_set('auto_detect_line_endings', true);
- if (PHP_CODESNIFFER_VERBOSITY > 0) {
- // If this is a custom ruleset.xml file, load the standard name
- // from the file. I know this looks a little ugly, but it is
- // just when verbose output is on so we have to go to the effort
- // of finding the correct name.
- $standardName = basename($standard);
- if (is_file($standard) === true) {
- $ruleset = simplexml_load_file($standard);
- if ($ruleset !== false) {
- $standardName = (string) $ruleset['name'];
- }
- } else if (is_file(realpath(PHPCS_CWD.'/'.$standard)) === true) {
- $ruleset = simplexml_load_file(realpath(PHPCS_CWD.'/'.$standard));
- if ($ruleset !== false) {
- $standardName = (string) $ruleset['name'];
- }
- }
- echo "Registering sniffs in $standardName standard... ";
- if (PHP_CODESNIFFER_VERBOSITY > 2) {
- echo PHP_EOL;
- }
- }//end if
- $this->setTokenListeners($standard, $sniffs);
- $this->populateCustomRules();
- $this->populateTokenListeners();
- if (PHP_CODESNIFFER_VERBOSITY > 0) {
- $numSniffs = count($this->listeners);
- echo "DONE ($numSniffs sniffs registered)".PHP_EOL;
- }
- // The SVN pre-commit calls process() to init the sniffs
- // and ruleset so there may not be any files to process.
- // But this has to come after that initial setup.
- if (empty($files) === true) {
- return;
- }
- $reporting = new PHP_CodeSniffer_Reporting();
- $cliValues = $this->cli->getCommandLineValues();
- $showProgress = $cliValues['showProgress'];
- if (PHP_CODESNIFFER_VERBOSITY > 0) {
- $numSniffs = count($this->listeners);
- echo 'Creating file list... ';
- }
- $todo = $this->getFilesToProcess($files, $local);
- $numFiles = count($todo);
- if (PHP_CODESNIFFER_VERBOSITY > 0) {
- $numSniffs = count($this->listeners);
- echo "DONE ($numFiles files in queue)".PHP_EOL;
- }
- $numProcessed = 0;
- $dots = 0;
- $maxLength = strlen($numFiles);
- $lastDir = '';
- foreach ($todo as $file) {
- $this->file = $file;
- $currDir = dirname($file);
- if ($lastDir !== $currDir) {
- if (PHP_CODESNIFFER_VERBOSITY > 0) {
- echo 'Changing into directory '.$currDir.PHP_EOL;
- }
- $lastDir = $currDir;
- }
- $phpcsFile = $this->processFile($file);
- $numProcessed++;
- if (PHP_CODESNIFFER_VERBOSITY > 0
- || PHP_CODESNIFFER_INTERACTIVE === true
- || $showProgress === false
- ) {
- continue;
- }
- // Show progress information.
- if ($phpcsFile === null) {
- echo 'S';
- } else {
- $errors = $phpcsFile->getErrorCount();
- $warnings = $phpcsFile->getWarningCount();
- if ($errors > 0) {
- echo 'E';
- } else if ($warnings > 0) {
- echo 'W';
- } else {
- echo '.';
- }
- }
- $dots++;
- if ($dots === 60) {
- $padding = ($maxLength - strlen($numProcessed));
- echo str_repeat(' ', $padding);
- echo " $numProcessed / $numFiles".PHP_EOL;
- $dots = 0;
- }
- }//end foreach
- if (PHP_CODESNIFFER_VERBOSITY === 0
- && PHP_CODESNIFFER_INTERACTIVE === false
- && $showProgress === true
- ) {
- echo PHP_EOL.PHP_EOL;
- }
- // Now process the multi-file sniffs, assuming there are
- // multiple files being sniffed.
- if (count($files) > 1 || is_dir($files[0]) === true) {
- $this->processMulti();
- }
- }//end process()
- /**
- * Processes multi-file sniffs.
- *
- * @return void
- */
- public function processMulti()
- {
- foreach ($this->_tokenListeners['multifile'] as $listenerData) {
- // Set the name of the listener for error messages.
- foreach ($this->files as $file) {
- $file->setActiveListener($listenerData['class']);
- }
- $listenerData['listener']->process($this->files);
- }
- }//end processMulti()
- /**
- * Sets installed sniffs in the coding standard being used.
- *
- * Traverses the standard directory for classes that implement the
- * PHP_CodeSniffer_Sniff interface asks them to register. Each of the
- * sniff's class names must be exact as the basename of the sniff file.
- * If the standard is a file, will skip transversal and just load sniffs
- * from the file.
- *
- * @param string $standard The name of the coding standard we are checking.
- * Can also be a path to a custom standard dir
- * containing a ruleset.xml file or can be a path
- * to a custom ruleset file.
- * @param array $sniffs The sniff names to restrict the allowed
- * listeners to.
- *
- * @return void
- * @throws PHP_CodeSniffer_Exception If the standard is not valid.
- */
- public function setTokenListeners($standard, array $sniffs=array())
- {
- if (is_dir($standard) === true) {
- // This is an absolute path to a custom standard.
- self::$standardDir = $standard;
- $standard = basename($standard);
- } else if (is_file($standard) === true) {
- // Might be a custom ruleset file.
- $ruleset = simplexml_load_file($standard);
- if ($ruleset === false) {
- throw new PHP_CodeSniffer_Exception("Ruleset $standard is not valid");
- }
- if (basename($standard) === 'ruleset.xml') {
- // The ruleset uses the generic name, so this may actually
- // be a complete standard with it's own sniffs. By setting the
- // the standardDir to be the directory, we will process both
- // the directory (for custom sniffs) and the ruleset.xml file
- // (as it uses the generic name) in getSniffFiles.
- self::$standardDir = dirname($standard);
- } else {
- // This is a custom ruleset file with a custom name, so we have
- // to assume there are no custom sniffs to go with this otherwise
- // we'd be recursing through directories on every run, even if
- // we don't need to.
- self::$standardDir = $standard;
- }
- $standard = (string) $ruleset['name'];
- } else {
- self::$standardDir = realpath(dirname(__FILE__).'/CodeSniffer/Standards/'.$standard);
- if (is_dir(self::$standardDir) === false) {
- // This isn't looking good. Let's see if this
- // is a relative path to a custom standard.
- $path = realpath(PHPCS_CWD.'/'.$standard);
- if (is_dir($path) === true) {
- // This is a relative path to a custom standard.
- self::$standardDir = $path;
- $standard = basename($standard);
- } else if (is_file($path) === true) {
- // Might be a custom ruleset file.
- $ruleset = simplexml_load_file($path);
- if ($ruleset === false) {
- throw new PHP_CodeSniffer_Exception("Ruleset $path is not valid");
- }
- // See comments in ELSE IF condition above for why we do this.
- if (basename($path) === 'ruleset.xml') {
- self::$standardDir = dirname($path);
- } else {
- self::$standardDir = $path;
- }
- $standard = (string) $ruleset['name'];
- }
- }
- }//end if
- $files = $this->getSniffFiles(self::$standardDir, $standard);
- if (empty($sniffs) === false) {
- // Convert the allowed sniffs to lower case so
- // they are easier to check.
- foreach ($sniffs as &$sniff) {
- $sniff = strtolower($sniff);
- }
- }
- $listeners = array();
- foreach ($files as $file) {
- // Work out where the position of /StandardName/Sniffs/... is
- // so we can determine what the class will be called.
- $sniffPos = strrpos($file, DIRECTORY_SEPARATOR.'Sniffs'.DIRECTORY_SEPARATOR);
- if ($sniffPos === false) {
- continue;
- }
- $slashPos = strrpos(substr($file, 0, $sniffPos), DIRECTORY_SEPARATOR);
- if ($slashPos === false) {
- continue;
- }
- $className = substr($file, ($slashPos + 1));
- $className = substr($className, 0, -4);
- $className = str_replace(DIRECTORY_SEPARATOR, '_', $className);
- include_once $file;
- // Support the use of PHP namespaces. If the class name we included
- // contains namespace seperators instead of underscores, use this as the
- // class name from now on.
- $classNameNS = str_replace('_', '\\', $className);
- if (class_exists($classNameNS, false) === true) {
- $className = $classNameNS;
- }
- // If they have specified a list of sniffs to restrict to, check
- // to see if this sniff is allowed.
- $allowed = in_array(strtolower($className), $sniffs);
- if (empty($sniffs) === false && $allowed === false) {
- continue;
- }
- $listeners[$className] = $className;
- if (PHP_CODESNIFFER_VERBOSITY > 2) {
- echo "\tRegistered $className".PHP_EOL;
- }
- }//end foreach
- $this->listeners = $listeners;
- }//end setTokenListeners()
- /**
- * Return a list of sniffs that a coding standard has defined.
- *
- * Sniffs are found by recursing the standard directory and also by
- * asking the standard for included sniffs.
- *
- * @param string $dir The directory where to look for the files.
- * @param string $standard The name of the coding standard. If NULL, no
- * included sniffs will be checked for.
- *
- * @return array
- * @throws PHP_CodeSniffer_Exception If an included or excluded sniff does
- * not exist.
- */
- public function getSniffFiles($dir, $standard=null)
- {
- $ownSniffs = array();
- $includedSniffs = array();
- $excludedSniffs = array();
- if (is_dir($dir) === true) {
- $di = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($dir));
- foreach ($di as $file) {
- $fileName = $file->getFilename();
- // Skip hidden files.
- if (substr($fileName, 0, 1) === '.') {
- continue;
- }
- // We are only interested in PHP and sniff files.
- $fileParts = explode('.', $fileName);
- if (array_pop($fileParts) !== 'php') {
- continue;
- }
- $basename = basename($fileName, '.php');
- if (substr($basename, -5) !== 'Sniff') {
- continue;
- }
- $ownSniffs[] = $file->getPathname();
- }//end foreach
- }//end if
- if ($standard !== null) {
- $rulesetPath = $dir;
- if (is_dir($rulesetPath) === true) {
- $rulesetPath .= '/ruleset.xml';
- }
- $ruleset = simplexml_load_file($rulesetPath);
- if ($ruleset === false) {
- throw new PHP_CodeSniffer_Exception("Ruleset $rulesetPath is not valid");
- }
- foreach ($ruleset->rule as $rule) {
- $includedSniffs = array_merge($includedSniffs, $this->_expandRulesetReference($rule['ref']));
- if (isset($rule->exclude) === true) {
- foreach ($rule->exclude as $exclude) {
- $excludedSniffs = array_merge($excludedSniffs, $this->_expandRulesetReference($exclude['name']));
- }
- }
- }//end foreach
- }//end if
- $includedSniffs = array_unique($includedSniffs);
- $excludedSniffs = array_unique($excludedSniffs);
- // Merge our own sniff list with our externally included
- // sniff list, but filter out any excluded sniffs.
- $files = array();
- foreach (array_merge($ownSniffs, $includedSniffs) as $sniff) {
- if (in_array($sniff, $excludedSniffs) === true) {
- continue;
- } else {
- $files[] = realpath($sniff);
- }
- }
- return array_unique($files);
- }//end getSniffFiles()
- /**
- * Expand a ruleset sniff reference into a list of sniff files.
- *
- * @param string $sniff The sniff reference from the rulset.xml file.
- *
- * @return array
- * @throws PHP_CodeSniffer_Exception If the sniff reference is invalid.
- */
- private function _expandRulesetReference($sniff)
- {
- $referencedSniffs = array();
- // Ignore internal sniffs as they are used to only
- // hide and change internal messages.
- if (substr($sniff, 0, 9) === 'Internal.') {
- return $referencedSniffs;
- }
- // As sniffs can't begin with a full stop, assume sniffs in
- // this format are relative paths and attempt to convert them
- // to absolute paths. If this fails, let the sniff path run through
- // the normal checks and have it fail as normal.
- if (substr($sniff, 0, 1) === '.') {
- $standardDir = self::$standardDir;
- if (substr(self::$standardDir, -4) === '.xml') {
- $standardDir = dirname($standardDir);
- }
- $realpath = realpath($standardDir.'/'.$sniff);
- if ($realpath !== false) {
- $sniff = $realpath;
- }
- }
- $isDir = false;
- $path = $sniff;
- if (is_dir($sniff) === true) {
- // Referencing a custom standard.
- $isDir = true;
- $path = $sniff;
- $sniff = basename($path);
- } else if (is_file($sniff) === false) {
- // See if this is a whole standard being referenced.
- $path = realpath(dirname(__FILE__).'/CodeSniffer/Standards/'.$sniff);
- if (is_dir($path) === true) {
- $isDir = true;
- } else {
- // Work out the sniff path.
- $parts = explode('.', $sniff);
- if (count($parts) < 3) {
- $error = "Referenced sniff $sniff does not exist";
- throw new PHP_CodeSniffer_Exception($error);
- }
- $path = $parts[0].'/Sniffs/'.$parts[1].'/'.$parts[2].'Sniff.php';
- $path = realpath(dirname(__FILE__).'/CodeSniffer/Standards/'.$path);
- if ($path === false && self::$standardDir !== '') {
- // The sniff is not locally installed, so check if it is being
- // referenced as a remote sniff outside the install. We do this by
- // looking directly in the passed standard dir to see if it is
- // installed in there.
- $path = realpath(self::$standardDir.'/Sniffs/'.$parts[1].'/'.$parts[2].'Sniff.php');
- }
- }
- }//end if
- if ($isDir === true) {
- if (self::isInstalledStandard($sniff) === true) {
- // We are referencing a coding standard.
- $referencedSniffs = $this->getSniffFiles($path, $sniff);
- $this->populateCustomRules($path);
- } else {
- // We are referencing a whole directory of sniffs.
- $referencedSniffs = $this->getSniffFiles($path);
- }
- } else {
- if (is_file($path) === false) {
- $error = "Referenced sniff $sniff does not exist";
- throw new PHP_CodeSniffer_Exception($error);
- }
- if (substr($path, -9) === 'Sniff.php') {
- // A single sniff.
- $referencedSniffs[] = $path;
- } else {
- // Assume an external ruleset.xml file.
- $referencedSniffs = $this->getSniffFiles($path, $sniff);
- }
- }//end if
- return $referencedSniffs;
- }//end _expandRulesetReference()
- /**
- * Sets installed sniffs in the coding standard being used.
- *
- * @param string $standard The name of the coding standard we are checking.
- * Can also be a path to a custom ruleset.xml file.
- *
- * @return void
- */
- public function populateCustomRules($standard=null)
- {
- if ($standard === null) {
- $standard = self::$standardDir;
- }
- if (is_file($standard) === false) {
- $standard .= '/ruleset.xml';
- if (is_file($standard) === false) {
- return;
- }
- }
- $ruleset = simplexml_load_file($standard);
- foreach ($ruleset->rule as $rule) {
- if (isset($rule['ref']) === false) {
- continue;
- }
- $code = (string) $rule['ref'];
- // Custom severity.
- if (isset($rule->severity) === true) {
- if (isset($this->ruleset[$code]) === false) {
- $this->ruleset[$code] = array();
- }
- $this->ruleset[$code]['severity'] = (int) $rule->severity;
- }
- // Custom message type.
- if (isset($rule->type) === true) {
- if (isset($this->ruleset[$code]) === false) {
- $this->ruleset[$code] = array();
- }
- $this->ruleset[$code]['type'] = (string) $rule->type;
- }
- // Custom message.
- if (isset($rule->message) === true) {
- if (isset($this->ruleset[$code]) === false) {
- $this->ruleset[$code] = array();
- }
- $this->ruleset[$code]['message'] = (string) $rule->message;
- }
- // Custom properties.
- if (isset($rule->properties) === true) {
- foreach ($rule->properties->property as $prop) {
- if (isset($this->ruleset[$code]) === false) {
- $this->ruleset[$code] = array(
- 'properties' => array(),
- );
- } else if (isset($this->ruleset[$code]['properties']) === false) {
- $this->ruleset[$code]['properties'] = array();
- }
- $name = (string) $prop['name'];
- if (isset($prop['type']) === true
- && (string) $prop['type'] === 'array'
- ) {
- $value = (string) $prop['value'];
- $this->ruleset[$code]['properties'][$name] = explode(',', $value);
- } else {
- $this->ruleset[$code]['properties'][$name] = (string) $prop['value'];
- }
- }
- }//end if
- // Ignore patterns.
- foreach ($rule->{'exclude-pattern'} as $pattern) {
- if (isset($this->ignorePatterns[$code]) === false) {
- $this->ignorePatterns[$code] = array();
- }
- if (isset($pattern['type']) === false) {
- $pattern['type'] = 'absolute';
- }
- $this->ignorePatterns[$code][(string) $pattern] = (string) $pattern['type'];
- }
- }//end foreach
- // Process custom ignore pattern rules.
- foreach ($ruleset->{'exclude-pattern'} as $pattern) {
- if (isset($pattern['type']) === false) {
- $pattern['type'] = 'absolute';
- }
- $this->ignorePatterns[(string) $pattern] = (string) $pattern['type'];
- }
- }//end populateCustomRules()
- /**
- * Populates the array of PHP_CodeSniffer_Sniff's for this file.
- *
- * @return void
- * @throws PHP_CodeSniffer_Exception If sniff registration fails.
- */
- public function populateTokenListeners()
- {
- // Construct a list of listeners indexed by token being listened for.
- $this->_tokenListeners = array(
- 'file' => array(),
- 'multifile' => array(),
- );
- foreach ($this->listeners as $listenerClass) {
- // Work out the internal code for this sniff. Detect usage of namespace
- // seperators instead of underscores to support PHP namespaces.
- if (strstr($listenerClass, '\\') === false) {
- $parts = explode('_', $listenerClass);
- } else {
- $parts = explode('\\', $listenerClass);
- }
- $code = $parts[0].'.'.$parts[2].'.'.$parts[3];
- $code = substr($code, 0, -5);
- $this->listeners[$listenerClass] = new $listenerClass();
- // Set custom properties.
- if (isset($this->ruleset[$code]['properties']) === true) {
- foreach ($this->ruleset[$code]['properties'] as $name => $value) {
- $this->setSniffProperty($listenerClass, $name, $value);
- }
- }
- $tokenizers = array('PHP');
- $vars = get_class_vars($listenerClass);
- if (isset($vars['supportedTokenizers']) === true) {
- $tokenizers = $vars['supportedTokenizers'];
- }
- if (($this->listeners[$listenerClass] instanceof PHP_CodeSniffer_Sniff) === true) {
- $tokens = $this->listeners[$listenerClass]->register();
- if (is_array($tokens) === false) {
- $msg = "Sniff $listenerClass register() method must return an array";
- throw new PHP_CodeSniffer_Exception($msg);
- }
- foreach ($tokens as $token) {
- if (isset($this->_tokenListeners['file'][$token]) === false) {
- $this->_tokenListeners['file'][$token] = array();
- }
- if (in_array($this->listeners[$listenerClass], $this->_tokenListeners['file'][$token], true) === false) {
- $this->_tokenListeners['file'][$token][] = array(
- 'listener' => $this->listeners[$listenerClass],
- 'class' => $listenerClass,
- 'tokenizers' => $tokenizers,
- );
- }
- }
- } else if (($this->listeners[$listenerClass] instanceof PHP_CodeSniffer_MultiFileSniff) === true) {
- $this->_tokenListeners['multifile'][] = array(
- 'listener' => $this->listeners[$listenerClass],
- 'class' => $listenerClass,
- 'tokenizers' => $tokenizers,
- );
- }
- }//end foreach
- }//end populateTokenListeners()
- /**
- * Set a single property for a sniff.
- *
- * @param string $listenerClass The class name of the sniff.
- * @param string $name The name of the property to change.
- * @param string $value The new value of the property.
- *
- * @return void
- */
- public function setSniffProperty($listenerClass, $name, $value)
- {
- // Setting a property for a sniff we are not using.
- if (isset($this->listeners[$listenerClass]) === false) {
- return;
- }
- $name = trim($name);
- if (is_string($value) === true) {
- $value = trim($value);
- }
- // Special case for booleans.
- if ($value === 'true') {
- $value = true;
- } else if ($value === 'false') {
- $value = false;
- }
- $this->listeners[$listenerClass]->$name = $value;
- }//end setSniffProperty()
- /**
- * Get a list of files that will be processed.
- *
- * If passed directories, this method will find all files within them.
- * The method will also perform file extension and ignore pattern filtering.
- *
- * @param string $paths A list of file or directory paths to process.
- * @param boolean $local If true, only process 1 level of files in directories
- *
- * @return array
- * @throws Exception If there was an error opening a directory.
- * @see shouldProcessFile()
- */
- public function getFilesToProcess($paths, $local=false)
- {
- $files = array();
- foreach ($paths as $path) {
- if (is_dir($path) === true) {
- if ($local === true) {
- $di = new DirectoryIterator($path);
- } else {
- $di = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path));
- }
- foreach ($di as $file) {
- // Check if the file exists after all symlinks are reolved.
- $filePath = realpath($file->getPathname());
- if ($filePath === false) {
- continue;
- }
- if (is_dir($filePath) === true) {
- continue;
- }
- if ($this->shouldProcessFile($file->getPathname(), $path) === false) {
- continue;
- }
- $files[] = $file->getPathname();
- }//end foreach
- } else {
- if ($this->shouldIgnoreFile($path, dirname($path)) === true) {
- continue;
- }
- $files[] = $path;
- }//end if
- }//end foreach
- return $files;
- }//end getFilesToProcess()
- /**
- * Checks filtering rules to see if a file should be checked.
- *
- * Checks both file extension filters and path ignore filters.
- *
- * @param string $path The path to the file being checked.
- * @param string $basedir The directory to use for relative path checks.
- *
- * @return bool
- */
- public function shouldProcessFile($path, $basedir)
- {
- // Check that the file's extension is one we are checking.
- // We are strict about checking the extension and we don't
- // let files through with no extension or that start with a dot.
- $fileName = basename($path);
- $fileParts = explode('.', $fileName);
- if ($fileParts[0] === $fileName || $fileParts[0] === '') {
- return false;
- }
- // Checking multi-part file extensions, so need to create a
- // complete extension list and make sure one is allowed.
- $extensions = array();
- array_shift($fileParts);
- foreach ($fileParts as $part) {
- $extensions[implode('.', $fileParts)] = 1;
- array_shift($fileParts);
- }
- $matches = array_intersect_key($extensions, $this->allowedFileExtensions);
- if (empty($matches) === true) {
- return false;
- }
- // If the file's path matches one of our ignore patterns, skip it.
- if ($this->shouldIgnoreFile($path, $basedir) === true) {
- return false;
- }
- return true;
- }//end shouldProcessFile()
- /**
- * Checks filtering rules to see if a file should be ignored.
- *
- * @param string $path The path to the file being checked.
- * @param string $basedir The directory to use for relative path checks.
- *
- * @return bool
- */
- public function shouldIgnoreFile($path, $basedir)
- {
- $relativePath = $path;
- if (strpos($path, $basedir) === 0) {
- // The +1 cuts off the directory separator as well.
- $relativePath = substr($path, (strlen($basedir) + 1));
- }
- foreach ($this->ignorePatterns as $pattern => $type) {
- if (is_array($pattern) === true) {
- // A sniff specific ignore pattern.
- continue;
- }
- $replacements = array(
- '\\,' => ',',
- '*' => '.*',
- );
- // We assume a / directory seperator, as do the exclude rules
- // most developers write, so we need a special case for any system
- // that is different.
- if (DIRECTORY_SEPARATOR === '\\') {
- $replacements['/'] = '\\\\';
- }
- $pattern = strtr($pattern, $replacements);
- if ($type === 'relative') {
- $testPath = $relativePath;
- } else {
- $testPath = $path;
- }
- if (preg_match("|{$pattern}|i", $testPath) === 1) {
- return true;
- }
- }//end foreach
- return false;
- }//end shouldIgnoreFile()
- /**
- * Run the code sniffs over a single given file.
- *
- * Processes the file and runs the PHP_CodeSniffer sniffs to verify that it
- * conforms with the standard. Returns the processed file object, or NULL
- * if no file was processed due to error.
- *
- * @param string $file The file to process.
- * @param string $contents The contents to parse. If NULL, the content
- * is taken from the file system.
- *
- * @return PHP_CodeSniffer_File
- * @throws PHP_CodeSniffer_Exception If the file could not be processed.
- * @see _processFile()
- */
- public function processFile($file, $contents=null)
- {
- if ($contents === null && file_exists($file) === false) {
- throw new PHP_CodeSniffer_Exception("Source file $file does not exist");
- }
- $filePath = realpath($file);
- if ($filePath === false) {
- $filePath = $file;
- }
- // Before we go and spend time tokenizing this file, just check
- // to see if there is a tag up top to indicate that the whole
- // file should be ignored. It must be on one of the first two lines.
- $firstContent = $contents;
- if ($contents === null && is_readable($filePath) === true) {
- $handle = fopen($filePath, 'r');
- if ($handle !== false) {
- $firstContent = fgets($handle);
- $firstContent .= fgets($handle);
- fclose($handle);
- }
- }
- if (strpos($firstContent, '@codingStandardsIgnoreFile') !== false) {
- // We are ignoring the whole file.
- if (PHP_CODESNIFFER_VERBOSITY > 0) {
- echo 'Ignoring '.basename($filePath).PHP_EOL;
- }
- return null;
- }
- try {
- $phpcsFile = $this->_processFile($file, $contents);
- } catch (Exception $e) {
- $trace = $e->getTrace();
- $filename = $trace[0]['args'][0];
- if (is_object($filename) === true
- && get_class($filename) === 'PHP_CodeSniffer_File'
- ) {
- $filename = $filename->getFilename();
- } else if (is_numeric($filename) === true) {
- // See if we can find the PHP_CodeSniffer_File object.
- foreach ($trace as $data) {
- if (isset($data['args'][0]) === true
- && ($data['args'][0] instanceof PHP_CodeSniffer_File) === true
- ) {
- $filename = $data['args'][0]->getFilename();
- }
- }
- } else if (is_string($filename) === false) {
- $filename = (string) $filename;
- }
- $error = 'An error occurred during processing; checking has been aborted. The error message was: '.$e->getMessage();
- $phpcsFile = new PHP_CodeSniffer_File(
- $filename,
- $this->_tokenListeners['file'],
- $this->allowedFileExtensions,
- $this->ruleset,
- $this
- );
- $this->addFile($phpcsFile);
- $phpcsFile->addError($error, null);
- }//end try
- if (PHP_CODESNIFFER_INTERACTIVE === false) {
- return $phpcsFile;
- }
- /*
- Running interactively.
- Print the error report for the current file and then wait for user input.
- */
- $reporting = new PHP_CodeSniffer_Reporting();
- $cliValues = $this->cli->getCommandLineValues();
- // Get current violations and then clear the list to make sure
- // we only print violations for a single file each time.
- $numErrors = null;
- while ($numErrors !== 0) {
- $filesViolations = $this->getFilesErrors();
- $this->files = array();
- $numErrors = $reporting->printReport(
- 'full',
- $filesViolations,
- $cliValues['showSources'],
- null,
- $cliValues['reportWidth']
- );
- if ($numErrors === 0) {
- continue;
- }
- echo '<ENTER> to recheck, [s] to skip or [q] to quit : ';
- $input = fgets(STDIN);
- $input = trim($input);
- switch ($input) {
- case 's':
- break;
- case 'q':
- exit(0);
- break;
- default:
- // Repopulate the sniffs because some of them save their state
- // and only clear it when the file changes, but we are rechecking
- // the same file.
- $this->populateTokenListeners();
- $phpcsFile = $this->_processFile($file, $contents);
- break;
- }
- }//end while
- return $phpcsFile;
- }//end processFile()
- /**
- * Process the sniffs for a single file.
- *
- * Does raw processing only. No interactive support or error checking.
- *
- * @param string $file The file to process.
- * @param string $contents The contents to parse. If NULL, the content
- * is taken from the file system.
- *
- * @return PHP_CodeSniffer_File
- * @see processFile()
- */
- private function _processFile($file, $contents)
- {
- if (PHP_CODESNIFFER_VERBOSITY > 0) {
- $startTime = time();
- echo 'Processing '.basename($file).' ';
- if (PHP_CODESNIFFER_VERBOSITY > 1) {
- echo PHP_EOL;
- }
- }
- $phpcsFile = new PHP_CodeSniffer_File(
- $file,
- $this->_tokenListeners['file'],
- $this->allowedFileExtensions,
- $this->ruleset,
- $this
- );
- $this->addFile($phpcsFile);
- $phpcsFile->start($contents);
- // Clean up the test if we can to save memory. This can't be done if
- // we need to leave the files around for multi-file sniffs.
- if (PHP_CODESNIFFER_INTERACTIVE === false
- && empty($this->_tokenListeners['multifile']) === true
- ) {
- $phpcsFile->cleanUp()…
Large files files are truncated, but you can click here to view the full file