Chris@17: Chris@17: * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600) Chris@17: * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence Chris@17: */ Chris@17: Chris@17: namespace PHP_CodeSniffer\Tokenizers; Chris@17: Chris@17: use PHP_CodeSniffer\Util; Chris@17: use PHP_CodeSniffer\Config; Chris@17: use PHP_CodeSniffer\Exceptions\TokenizerException; Chris@17: Chris@17: class CSS extends PHP Chris@17: { Chris@17: Chris@17: Chris@17: /** Chris@17: * Initialise the tokenizer. Chris@17: * Chris@17: * Pre-checks the content to see if it looks minified. Chris@17: * Chris@17: * @param string $content The content to tokenize, Chris@17: * @param \PHP_CodeSniffer\Config $config The config data for the run. Chris@17: * @param string $eolChar The EOL char used in the content. Chris@17: * Chris@17: * @return void Chris@18: * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the file appears to be minified. Chris@17: */ Chris@17: public function __construct($content, Config $config, $eolChar='\n') Chris@17: { Chris@17: if ($this->isMinifiedContent($content, $eolChar) === true) { Chris@17: throw new TokenizerException('File appears to be minified and cannot be processed'); Chris@17: } Chris@17: Chris@18: parent::__construct($content, $config, $eolChar); Chris@17: Chris@17: }//end __construct() Chris@17: Chris@17: Chris@17: /** Chris@17: * Creates an array of tokens when given some CSS code. Chris@17: * Chris@17: * Uses the PHP tokenizer to do all the tricky work Chris@17: * Chris@17: * @param string $string The string to tokenize. Chris@17: * Chris@17: * @return array Chris@17: */ Chris@17: public function tokenize($string) Chris@17: { Chris@17: if (PHP_CODESNIFFER_VERBOSITY > 1) { Chris@17: echo "\t*** START CSS TOKENIZING 1ST PASS ***".PHP_EOL; Chris@17: } Chris@17: Chris@17: // If the content doesn't have an EOL char on the end, add one so Chris@17: // the open and close tags we add are parsed correctly. Chris@17: $eolAdded = false; Chris@17: if (substr($string, (strlen($this->eolChar) * -1)) !== $this->eolChar) { Chris@17: $string .= $this->eolChar; Chris@17: $eolAdded = true; Chris@17: } Chris@17: Chris@17: $string = str_replace('', '^PHPCS_CSS_T_CLOSE_TAG^', $string); Chris@17: $tokens = parent::tokenize(''); Chris@17: Chris@17: $finalTokens = []; Chris@17: $finalTokens[0] = [ Chris@17: 'code' => T_OPEN_TAG, Chris@17: 'type' => 'T_OPEN_TAG', Chris@17: 'content' => '', Chris@17: ]; Chris@17: Chris@17: $newStackPtr = 1; Chris@17: $numTokens = count($tokens); Chris@17: $multiLineComment = false; Chris@17: for ($stackPtr = 1; $stackPtr < $numTokens; $stackPtr++) { Chris@17: $token = $tokens[$stackPtr]; Chris@17: Chris@17: // CSS files don't have lists, breaks etc, so convert these to Chris@17: // standard strings early so they can be converted into T_STYLE Chris@17: // tokens and joined with other strings if needed. Chris@17: if ($token['code'] === T_BREAK Chris@17: || $token['code'] === T_LIST Chris@17: || $token['code'] === T_DEFAULT Chris@17: || $token['code'] === T_SWITCH Chris@17: || $token['code'] === T_FOR Chris@17: || $token['code'] === T_FOREACH Chris@17: || $token['code'] === T_WHILE Chris@17: || $token['code'] === T_DEC Chris@17: || $token['code'] === T_NEW Chris@17: ) { Chris@17: $token['type'] = 'T_STRING'; Chris@17: $token['code'] = T_STRING; Chris@17: } Chris@17: Chris@18: $token['content'] = str_replace('^PHPCS_CSS_T_OPEN_TAG^', '', $token['content']); Chris@18: Chris@17: if (PHP_CODESNIFFER_VERBOSITY > 1) { Chris@17: $type = $token['type']; Chris@17: $content = Util\Common::prepareForOutput($token['content']); Chris@17: echo "\tProcess token $stackPtr: $type => $content".PHP_EOL; Chris@17: } Chris@17: Chris@17: if ($token['code'] === T_BITWISE_XOR Chris@17: && $tokens[($stackPtr + 1)]['content'] === 'PHPCS_CSS_T_OPEN_TAG' Chris@17: ) { Chris@17: $content = ''; Chris@17: $stackPtr += 2; Chris@17: break; Chris@17: } else { Chris@17: $content .= $tokens[$stackPtr]['content']; Chris@17: } Chris@17: } Chris@17: Chris@17: if (PHP_CODESNIFFER_VERBOSITY > 1) { Chris@17: echo "\t\t=> Found embedded PHP code: "; Chris@17: $cleanContent = Util\Common::prepareForOutput($content); Chris@17: echo $cleanContent.PHP_EOL; Chris@17: } Chris@17: Chris@17: $finalTokens[$newStackPtr] = [ Chris@17: 'type' => 'T_EMBEDDED_PHP', Chris@17: 'code' => T_EMBEDDED_PHP, Chris@17: 'content' => $content, Chris@17: ]; Chris@17: Chris@17: $newStackPtr++; Chris@17: continue; Chris@17: }//end if Chris@17: Chris@17: if ($token['code'] === T_GOTO_LABEL) { Chris@17: // Convert these back to T_STRING followed by T_COLON so we can Chris@17: // more easily process style definitions. Chris@17: $finalTokens[$newStackPtr] = [ Chris@17: 'type' => 'T_STRING', Chris@17: 'code' => T_STRING, Chris@17: 'content' => substr($token['content'], 0, -1), Chris@17: ]; Chris@17: $newStackPtr++; Chris@17: $finalTokens[$newStackPtr] = [ Chris@17: 'type' => 'T_COLON', Chris@17: 'code' => T_COLON, Chris@17: 'content' => ':', Chris@17: ]; Chris@17: $newStackPtr++; Chris@17: continue; Chris@17: } Chris@17: Chris@17: if ($token['code'] === T_FUNCTION) { Chris@17: // There are no functions in CSS, so convert this to a string. Chris@17: $finalTokens[$newStackPtr] = [ Chris@17: 'type' => 'T_STRING', Chris@17: 'code' => T_STRING, Chris@17: 'content' => $token['content'], Chris@17: ]; Chris@17: Chris@17: $newStackPtr++; Chris@17: continue; Chris@17: } Chris@17: Chris@17: if ($token['code'] === T_COMMENT Chris@17: && substr($token['content'], 0, 2) === '/*' Chris@17: ) { Chris@17: // Multi-line comment. Record it so we can ignore other Chris@17: // comment tags until we get out of this one. Chris@17: $multiLineComment = true; Chris@17: } Chris@17: Chris@17: if ($token['code'] === T_COMMENT Chris@17: && $multiLineComment === false Chris@17: && (substr($token['content'], 0, 2) === '//' Chris@17: || $token['content']{0} === '#') Chris@17: ) { Chris@17: $content = ltrim($token['content'], '#/'); Chris@17: Chris@17: // Guard against PHP7+ syntax errors by stripping Chris@17: // leading zeros so the content doesn't look like an invalid int. Chris@17: $leadingZero = false; Chris@17: if ($content{0} === '0') { Chris@17: $content = '1'.$content; Chris@17: $leadingZero = true; Chris@17: } Chris@17: Chris@17: $commentTokens = parent::tokenize(''); Chris@17: Chris@17: // The first and last tokens are the open/close tags. Chris@17: array_shift($commentTokens); Chris@17: array_pop($commentTokens); Chris@17: Chris@17: if ($leadingZero === true) { Chris@17: $commentTokens[0]['content'] = substr($commentTokens[0]['content'], 1); Chris@17: $content = substr($content, 1); Chris@17: } Chris@17: Chris@17: if ($token['content']{0} === '#') { Chris@17: // The # character is not a comment in CSS files, so Chris@17: // determine what it means in this context. Chris@17: $firstContent = $commentTokens[0]['content']; Chris@17: Chris@17: // If the first content is just a number, it is probably a Chris@17: // colour like 8FB7DB, which PHP splits into 8 and FB7DB. Chris@17: if (($commentTokens[0]['code'] === T_LNUMBER Chris@17: || $commentTokens[0]['code'] === T_DNUMBER) Chris@17: && $commentTokens[1]['code'] === T_STRING Chris@17: ) { Chris@17: $firstContent .= $commentTokens[1]['content']; Chris@17: array_shift($commentTokens); Chris@17: } Chris@17: Chris@17: // If the first content looks like a colour and not a class Chris@17: // definition, join the tokens together. Chris@17: if (preg_match('/^[ABCDEF0-9]+$/i', $firstContent) === 1 Chris@17: && $commentTokens[1]['content'] !== '-' Chris@17: ) { Chris@17: array_shift($commentTokens); Chris@17: // Work out what we trimmed off above and remember to re-add it. Chris@17: $trimmed = substr($token['content'], 0, (strlen($token['content']) - strlen($content))); Chris@17: $finalTokens[$newStackPtr] = [ Chris@17: 'type' => 'T_COLOUR', Chris@17: 'code' => T_COLOUR, Chris@17: 'content' => $trimmed.$firstContent, Chris@17: ]; Chris@17: } else { Chris@17: $finalTokens[$newStackPtr] = [ Chris@17: 'type' => 'T_HASH', Chris@17: 'code' => T_HASH, Chris@17: 'content' => '#', Chris@17: ]; Chris@17: } Chris@17: } else { Chris@17: $finalTokens[$newStackPtr] = [ Chris@17: 'type' => 'T_STRING', Chris@17: 'code' => T_STRING, Chris@17: 'content' => '//', Chris@17: ]; Chris@17: }//end if Chris@17: Chris@17: $newStackPtr++; Chris@17: Chris@17: array_splice($tokens, $stackPtr, 1, $commentTokens); Chris@17: $numTokens = count($tokens); Chris@17: $stackPtr--; Chris@17: continue; Chris@17: }//end if Chris@17: Chris@17: if ($token['code'] === T_COMMENT Chris@17: && substr($token['content'], -2) === '*/' Chris@17: ) { Chris@17: // Multi-line comment is done. Chris@17: $multiLineComment = false; Chris@17: } Chris@17: Chris@17: $finalTokens[$newStackPtr] = $token; Chris@17: $newStackPtr++; Chris@17: }//end for Chris@17: Chris@17: if (PHP_CODESNIFFER_VERBOSITY > 1) { Chris@17: echo "\t*** END CSS TOKENIZING 1ST PASS ***".PHP_EOL; Chris@17: echo "\t*** START CSS TOKENIZING 2ND PASS ***".PHP_EOL; Chris@17: } Chris@17: Chris@17: // A flag to indicate if we are inside a style definition, Chris@17: // which is defined using curly braces. Chris@17: $inStyleDef = false; Chris@17: Chris@17: // A flag to indicate if an At-rule like "@media" is used, which will result Chris@17: // in nested curly brackets. Chris@17: $asperandStart = false; Chris@17: Chris@17: $numTokens = count($finalTokens); Chris@17: for ($stackPtr = 0; $stackPtr < $numTokens; $stackPtr++) { Chris@17: $token = $finalTokens[$stackPtr]; Chris@17: Chris@17: if (PHP_CODESNIFFER_VERBOSITY > 1) { Chris@17: $type = $token['type']; Chris@17: $content = Util\Common::prepareForOutput($token['content']); Chris@17: echo "\tProcess token $stackPtr: $type => $content".PHP_EOL; Chris@17: } Chris@17: Chris@17: switch ($token['code']) { Chris@17: case T_OPEN_CURLY_BRACKET: Chris@17: // Opening curly brackets for an At-rule do not start a style Chris@17: // definition. We also reset the asperand flag here because the next Chris@17: // opening curly bracket could be indeed the start of a style Chris@17: // definition. Chris@17: if ($asperandStart === true) { Chris@17: if (PHP_CODESNIFFER_VERBOSITY > 1) { Chris@17: if ($inStyleDef === true) { Chris@17: echo "\t\t* style definition closed *".PHP_EOL; Chris@17: } Chris@17: Chris@17: if ($asperandStart === true) { Chris@17: echo "\t\t* at-rule definition closed *".PHP_EOL; Chris@17: } Chris@17: } Chris@17: Chris@17: $inStyleDef = false; Chris@17: $asperandStart = false; Chris@17: } else { Chris@17: $inStyleDef = true; Chris@17: if (PHP_CODESNIFFER_VERBOSITY > 1) { Chris@17: echo "\t\t* style definition opened *".PHP_EOL; Chris@17: } Chris@17: } Chris@17: break; Chris@17: case T_CLOSE_CURLY_BRACKET: Chris@17: if (PHP_CODESNIFFER_VERBOSITY > 1) { Chris@17: if ($inStyleDef === true) { Chris@17: echo "\t\t* style definition closed *".PHP_EOL; Chris@17: } Chris@17: Chris@17: if ($asperandStart === true) { Chris@17: echo "\t\t* at-rule definition closed *".PHP_EOL; Chris@17: } Chris@17: } Chris@17: Chris@17: $inStyleDef = false; Chris@17: $asperandStart = false; Chris@17: break; Chris@17: case T_MINUS: Chris@17: // Minus signs are often used instead of spaces inside Chris@17: // class names, IDs and styles. Chris@17: if ($finalTokens[($stackPtr + 1)]['code'] === T_STRING) { Chris@17: if ($finalTokens[($stackPtr - 1)]['code'] === T_STRING) { Chris@17: $newContent = $finalTokens[($stackPtr - 1)]['content'].'-'.$finalTokens[($stackPtr + 1)]['content']; Chris@17: Chris@17: if (PHP_CODESNIFFER_VERBOSITY > 1) { Chris@17: echo "\t\t* token is a string joiner; ignoring this and previous token".PHP_EOL; Chris@17: $old = Util\Common::prepareForOutput($finalTokens[($stackPtr + 1)]['content']); Chris@17: $new = Util\Common::prepareForOutput($newContent); Chris@17: echo "\t\t=> token ".($stackPtr + 1)." content changed from \"$old\" to \"$new\"".PHP_EOL; Chris@17: } Chris@17: Chris@17: $finalTokens[($stackPtr + 1)]['content'] = $newContent; Chris@17: unset($finalTokens[$stackPtr]); Chris@17: unset($finalTokens[($stackPtr - 1)]); Chris@17: } else { Chris@17: $newContent = '-'.$finalTokens[($stackPtr + 1)]['content']; Chris@17: Chris@17: $finalTokens[($stackPtr + 1)]['content'] = $newContent; Chris@17: unset($finalTokens[$stackPtr]); Chris@17: } Chris@17: } else if ($finalTokens[($stackPtr + 1)]['code'] === T_LNUMBER) { Chris@17: // They can also be used to provide negative numbers. Chris@17: if (PHP_CODESNIFFER_VERBOSITY > 1) { Chris@17: echo "\t\t* token is part of a negative number; adding content to next token and ignoring *".PHP_EOL; Chris@17: $content = Util\Common::prepareForOutput($finalTokens[($stackPtr + 1)]['content']); Chris@17: echo "\t\t=> token ".($stackPtr + 1)." content changed from \"$content\" to \"-$content\"".PHP_EOL; Chris@17: } Chris@17: Chris@17: $finalTokens[($stackPtr + 1)]['content'] = '-'.$finalTokens[($stackPtr + 1)]['content']; Chris@17: unset($finalTokens[$stackPtr]); Chris@17: }//end if Chris@17: break; Chris@17: case T_COLON: Chris@17: // Only interested in colons that are defining styles. Chris@17: if ($inStyleDef === false) { Chris@17: break; Chris@17: } Chris@17: Chris@17: for ($x = ($stackPtr - 1); $x >= 0; $x--) { Chris@17: if (isset(Util\Tokens::$emptyTokens[$finalTokens[$x]['code']]) === false) { Chris@17: break; Chris@17: } Chris@17: } Chris@17: Chris@17: if (PHP_CODESNIFFER_VERBOSITY > 1) { Chris@17: $type = $finalTokens[$x]['type']; Chris@17: echo "\t\t=> token $x changed from $type to T_STYLE".PHP_EOL; Chris@17: } Chris@17: Chris@17: $finalTokens[$x]['type'] = 'T_STYLE'; Chris@17: $finalTokens[$x]['code'] = T_STYLE; Chris@17: break; Chris@17: case T_STRING: Chris@17: if (strtolower($token['content']) === 'url') { Chris@17: // Find the next content. Chris@17: for ($x = ($stackPtr + 1); $x < $numTokens; $x++) { Chris@17: if (isset(Util\Tokens::$emptyTokens[$finalTokens[$x]['code']]) === false) { Chris@17: break; Chris@17: } Chris@17: } Chris@17: Chris@17: // Needs to be in the format "url(" for it to be a URL. Chris@17: if ($finalTokens[$x]['code'] !== T_OPEN_PARENTHESIS) { Chris@17: continue 2; Chris@17: } Chris@17: Chris@17: // Make sure the content isn't empty. Chris@17: for ($y = ($x + 1); $y < $numTokens; $y++) { Chris@17: if (isset(Util\Tokens::$emptyTokens[$finalTokens[$y]['code']]) === false) { Chris@17: break; Chris@17: } Chris@17: } Chris@17: Chris@17: if ($finalTokens[$y]['code'] === T_CLOSE_PARENTHESIS) { Chris@17: continue 2; Chris@17: } Chris@17: Chris@17: if (PHP_CODESNIFFER_VERBOSITY > 1) { Chris@17: for ($i = ($stackPtr + 1); $i <= $y; $i++) { Chris@17: $type = $finalTokens[$i]['type']; Chris@17: $content = Util\Common::prepareForOutput($finalTokens[$i]['content']); Chris@17: echo "\tProcess token $i: $type => $content".PHP_EOL; Chris@17: } Chris@17: Chris@17: echo "\t\t* token starts a URL *".PHP_EOL; Chris@17: } Chris@17: Chris@17: // Join all the content together inside the url() statement. Chris@17: $newContent = ''; Chris@17: for ($i = ($x + 2); $i < $numTokens; $i++) { Chris@17: if ($finalTokens[$i]['code'] === T_CLOSE_PARENTHESIS) { Chris@17: break; Chris@17: } Chris@17: Chris@17: $newContent .= $finalTokens[$i]['content']; Chris@17: if (PHP_CODESNIFFER_VERBOSITY > 1) { Chris@17: $content = Util\Common::prepareForOutput($finalTokens[$i]['content']); Chris@17: echo "\t\t=> token $i added to URL string and ignored: $content".PHP_EOL; Chris@17: } Chris@17: Chris@17: unset($finalTokens[$i]); Chris@17: } Chris@17: Chris@17: $stackPtr = $i; Chris@17: Chris@17: // If the content inside the "url()" is in double quotes Chris@17: // there will only be one token and so we don't have to do Chris@17: // anything except change its type. If it is not empty, Chris@17: // we need to do some token merging. Chris@17: $finalTokens[($x + 1)]['type'] = 'T_URL'; Chris@17: $finalTokens[($x + 1)]['code'] = T_URL; Chris@17: Chris@17: if ($newContent !== '') { Chris@17: $finalTokens[($x + 1)]['content'] .= $newContent; Chris@17: if (PHP_CODESNIFFER_VERBOSITY > 1) { Chris@17: $content = Util\Common::prepareForOutput($finalTokens[($x + 1)]['content']); Chris@17: echo "\t\t=> token content changed to: $content".PHP_EOL; Chris@17: } Chris@17: } Chris@17: } else if ($finalTokens[$stackPtr]['content'][0] === '-' Chris@17: && $finalTokens[($stackPtr + 1)]['code'] === T_STRING Chris@17: ) { Chris@17: if (isset($finalTokens[($stackPtr - 1)]) === true Chris@17: && $finalTokens[($stackPtr - 1)]['code'] === T_STRING Chris@17: ) { Chris@17: $newContent = $finalTokens[($stackPtr - 1)]['content'].$finalTokens[$stackPtr]['content'].$finalTokens[($stackPtr + 1)]['content']; Chris@17: Chris@17: if (PHP_CODESNIFFER_VERBOSITY > 1) { Chris@17: echo "\t\t* token is a string joiner; ignoring this and previous token".PHP_EOL; Chris@17: $old = Util\Common::prepareForOutput($finalTokens[($stackPtr + 1)]['content']); Chris@17: $new = Util\Common::prepareForOutput($newContent); Chris@17: echo "\t\t=> token ".($stackPtr + 1)." content changed from \"$old\" to \"$new\"".PHP_EOL; Chris@17: } Chris@17: Chris@17: $finalTokens[($stackPtr + 1)]['content'] = $newContent; Chris@17: unset($finalTokens[$stackPtr]); Chris@17: unset($finalTokens[($stackPtr - 1)]); Chris@17: } else { Chris@17: $newContent = $finalTokens[$stackPtr]['content'].$finalTokens[($stackPtr + 1)]['content']; Chris@17: Chris@17: $finalTokens[($stackPtr + 1)]['content'] = $newContent; Chris@17: unset($finalTokens[$stackPtr]); Chris@17: } Chris@17: }//end if Chris@17: break; Chris@17: case T_ASPERAND: Chris@17: $asperandStart = true; Chris@17: if (PHP_CODESNIFFER_VERBOSITY > 1) { Chris@17: echo "\t\t* at-rule definition opened *".PHP_EOL; Chris@17: } Chris@17: break; Chris@17: default: Chris@17: // Nothing special to be done with this token. Chris@17: break; Chris@17: }//end switch Chris@17: }//end for Chris@17: Chris@17: // Reset the array keys to avoid gaps. Chris@17: $finalTokens = array_values($finalTokens); Chris@17: $numTokens = count($finalTokens); Chris@17: Chris@17: // Blank out the content of the end tag. Chris@17: $finalTokens[($numTokens - 1)]['content'] = ''; Chris@17: Chris@17: if ($eolAdded === true) { Chris@17: // Strip off the extra EOL char we added for tokenizing. Chris@17: $finalTokens[($numTokens - 2)]['content'] = substr( Chris@17: $finalTokens[($numTokens - 2)]['content'], Chris@17: 0, Chris@17: (strlen($this->eolChar) * -1) Chris@17: ); Chris@17: Chris@17: if ($finalTokens[($numTokens - 2)]['content'] === '') { Chris@17: unset($finalTokens[($numTokens - 2)]); Chris@17: $finalTokens = array_values($finalTokens); Chris@17: $numTokens = count($finalTokens); Chris@17: } Chris@17: } Chris@17: Chris@17: if (PHP_CODESNIFFER_VERBOSITY > 1) { Chris@17: echo "\t*** END CSS TOKENIZING 2ND PASS ***".PHP_EOL; Chris@17: } Chris@17: Chris@17: return $finalTokens; Chris@17: Chris@17: }//end tokenize() Chris@17: Chris@17: Chris@17: /** Chris@17: * Performs additional processing after main tokenizing. Chris@17: * Chris@17: * @return void Chris@17: */ Chris@17: public function processAdditional() Chris@17: { Chris@17: /* Chris@17: We override this method because we don't want the PHP version to Chris@17: run during CSS processing because it is wasted processing time. Chris@17: */ Chris@17: Chris@17: }//end processAdditional() Chris@17: Chris@17: Chris@17: }//end class