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