Skip to content

TextStrings::getCompleteTextString(): split into three methods #320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 6, 2022
Merged

TextStrings::getCompleteTextString(): split into three methods #320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
208 changes: 150 additions & 58 deletions PHPCSUtils/Utils/TextStrings.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@

use PHP_CodeSniffer\Exceptions\RuntimeException;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Util\Tokens;
use PHPCSUtils\Tokens\Collections;
use PHPCSUtils\Utils\GetTokensAsString;

/**
* Utility functions for working with text string tokens.
Expand All @@ -33,10 +35,6 @@ class TextStrings
* where the content matching might result in false positives/false negatives if the text
* were to be examined line by line.
*
* Additionally, this method correctly handles a particular type of double quoted string
* with an embedded expression which is incorrectly tokenized in PHPCS itself prior to
* PHPCS version 3.x.x.
*
* @since 1.0.0
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
Expand All @@ -47,14 +45,64 @@ class TextStrings
* quotes off the resulting text string.
* Defaults to `true`.
*
* @return string The complete text string.
* @return string The contents of the complete text string.
*
* @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified position is not a
* valid text string token.
* @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified token is not the _first_
* token in a text string.
*/
public static function getCompleteTextString(File $phpcsFile, $stackPtr, $stripQuotes = true)
{
$tokens = $phpcsFile->getTokens();
$end = self::getEndOfCompleteTextString($phpcsFile, $stackPtr);

$stripNewline = false;
if ($tokens[$stackPtr]['code'] === \T_START_HEREDOC || $tokens[$stackPtr]['code'] === \T_START_NOWDOC) {
$stripQuotes = false;
$stripNewline = true;
$stackPtr = ($stackPtr + 1);
}

$contents = GetTokensAsString::normal($phpcsFile, $stackPtr, $end);

if ($stripNewline === true) {
// Heredoc/nowdoc: strip the new line at the end of the string to emulate how PHP sees the string.
$contents = \rtrim($contents, "\r\n");
}

if ($stripQuotes === true) {
return self::stripQuotes($contents);
}

return $contents;
}

/**
* Get the stack pointer to the end of a - potentially multi-line - text string.
*
* This method also correctly handles a particular type of double quoted string
* with an embedded expression which is incorrectly tokenized in PHPCS itself prior to
* PHPCS version 3.x.x.
*
* @see \PHPCSUtils\Utils\TextStrings::getCompleteTextString() Retrieve the contents of a complete - potentially
* multi-line - text string.
*
* @since 1.0.0-alpha4
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
* @param int $stackPtr Pointer to the first text string token
* of a - potentially multi-line - text string
* or to a Nowdoc/Heredoc opener.
*
* @return int Stack pointer to the last token in the text string.
*
* @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified position is not a
* valid text string token.
* @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified token is not the _first_
* token in a text string.
*/
public static function getEndOfCompleteTextString(File $phpcsFile, $stackPtr)
{
$tokens = $phpcsFile->getTokens();

Expand All @@ -66,30 +114,22 @@ public static function getCompleteTextString(File $phpcsFile, $stackPtr, $stripQ
);
}

if ($tokens[$stackPtr]['code'] === \T_CONSTANT_ENCAPSED_STRING
|| $tokens[$stackPtr]['code'] === \T_DOUBLE_QUOTED_STRING
) {
if (isset(Tokens::$stringTokens[$tokens[$stackPtr]['code']]) === true) {
$prev = $phpcsFile->findPrevious(\T_WHITESPACE, ($stackPtr - 1), null, true);
if ($tokens[$stackPtr]['code'] === $tokens[$prev]['code']) {
throw new RuntimeException('$stackPtr must be the start of the text string');
}
}

$stripNewline = false;

switch ($tokens[$stackPtr]['code']) {
case \T_START_HEREDOC:
$stripQuotes = false;
$stripNewline = true;
$targetType = \T_HEREDOC;
$current = ($stackPtr + 1);
$targetType = \T_HEREDOC;
$current = ($stackPtr + 1);
break;

case \T_START_NOWDOC:
$stripQuotes = false;
$stripNewline = true;
$targetType = \T_NOWDOC;
$current = ($stackPtr + 1);
$targetType = \T_NOWDOC;
$current = ($stackPtr + 1);
break;

default:
Expand All @@ -98,11 +138,11 @@ public static function getCompleteTextString(File $phpcsFile, $stackPtr, $stripQ
break;
}

$string = '';
do {
$string .= $tokens[$current]['content'];
while (isset($tokens[$current]) && $tokens[$current]['code'] === $targetType) {
++$current;
} while (isset($tokens[$current]) && $tokens[$current]['code'] === $targetType);
}

$lastPtr = ($current - 1);

if ($targetType === \T_DOUBLE_QUOTED_STRING) {
/*
Expand All @@ -111,51 +151,103 @@ public static function getCompleteTextString(File $phpcsFile, $stackPtr, $stripQ
* in a double quoted string, the embed would not be tokenized as part of the T_DOUBLE_QUOTED_STRING,
* but would still have the PHP native tokenization.
*/
if (isset($tokens[$current]) && $tokens[$current]['code'] === \T_DOLLAR_OPEN_CURLY_BRACES) {
$embeddedContent = $tokens[$current]['content'];
$nestedVars = [$current];
$foundEnd = false;

for ($current = ($current + 1); $current < $phpcsFile->numTokens; $current++) {
if ($tokens[$current]['code'] === \T_DOUBLE_QUOTED_STRING
&& empty($nestedVars) === true
) {
$embeddedContent .= self::getCompleteTextString($phpcsFile, $current, false);
$foundEnd = true;
break;
}

$embeddedContent .= $tokens[$current]['content'];

if (\strpos($tokens[$current]['content'], '{') !== false) {
$nestedVars[] = $current;
}

if (\strpos($tokens[$current]['content'], '}') !== false) {
\array_pop($nestedVars);
}
$end = self::getEndOfDoubleQuotedString($phpcsFile, $lastPtr);
if ($end !== $lastPtr) {
// Check if the double quoted string continues after the end of the embed.
if ($tokens[$end]['code'] === \T_DOUBLE_QUOTED_STRING) {
// Handles `"Text {embed} Text` followed by new line and additional text.
$end = self::getEndOfCompleteTextString($phpcsFile, $end);
} elseif ($tokens[($end + 1)]['code'] === \T_DOUBLE_QUOTED_STRING) {
// Handles `"Text {multi-line embed}` followed by additional text.
$end = self::getEndOfCompleteTextString($phpcsFile, ($end + 1));
}
}

/*
* Only accept this as one of the broken tokenizations if this is not a parse error
* or if we reached the end of the file.
*/
if ($foundEnd === true || $current === $phpcsFile->numTokens) {
$string .= $embeddedContent;
}
$lastPtr = $end;
}

return $lastPtr;
}

/**
* Get the stack pointer to the end of a (single) double quoted text string.
*
* This method provides a protection layer against a tokenizer bug in PHPCS < 3.x.x.
* When a select group of embedded variables/expressions was encountered in a double quoted string,
* PHPCS would not tokenize the double quoted string as one token per line, but instead the original
* PHP native tokens would be included in the token stream.
* This throws off the scope map (which can't be helped), but also makes examining
* the contents of double quoted strings difficult.
*
* This method can help remedy that.
*
* Note: If the embed is spread over multiple lines, the last token of the mistokenized
* part of the embed will be returned. The double quoted string _may_ still continue after that.
*
* @link https://github.com/squizlabs/PHP_CodeSniffer/pull/3604 PHPCS PR #3604
*
* @see \PHPCSUtils\Utils\GetTokensAsString Methods to retrieve the contents of the
* combined tokens.
* @see \PHPCSUtils\Utils\TextStrings::getEndOfCompleteTextString() Get the stack pointer to the end of a complete
* - potentially multi-line - text string.
* @see \PHPCSUtils\Utils\TextStrings::getCompleteTextString() Retrieve the contents of a complete -
* - potentially multi-line - text string.
*
* @since 1.0.0-alpha4
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
* @param int $stackPtr Pointer to the first text string token
* of a - potentially multi-token - double
* quoted text string.
*
* @return int Stack pointer to the last token (which may be the original stack pointer).
*
* @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified position is not a
* T_DOUBLE_QUOTED_STRING token.
*/
public static function getEndOfDoubleQuotedString(File $phpcsFile, $stackPtr)
{
$tokens = $phpcsFile->getTokens();

if (isset($tokens[$stackPtr]) === false || $tokens[$stackPtr]['code'] !== \T_DOUBLE_QUOTED_STRING) {
throw new RuntimeException('$stackPtr must be of type T_DOUBLE_QUOTED_STRING');
}

$next = ($stackPtr + 1);
if (isset($tokens[$next]) === false || $tokens[$next]['code'] !== \T_DOLLAR_OPEN_CURLY_BRACES) {
// This code is not affected by the tokenizer bug.
return $stackPtr;
}

/*
* BC for PHPCS < ??.
*/
$nestedBraces = [$next];
for ($next = ($next + 1); $next < $phpcsFile->numTokens; $next++) {
if ($tokens[$next]['code'] === \T_DOUBLE_QUOTED_STRING
&& empty($nestedBraces) === true
) {
break;
}

if (\strpos($tokens[$next]['content'], '{') !== false) {
$nestedBraces[] = $next;
}

if (\strpos($tokens[$next]['content'], '}') !== false) {
\array_pop($nestedBraces);
}
}

if ($stripNewline === true) {
// Heredoc/nowdoc: strip the new line at the end of the string to emulate how PHP sees the string.
$string = \rtrim($string, "\r\n");
if ($next === $phpcsFile->numTokens) {
return ($phpcsFile->numTokens - 1);
}

if ($stripQuotes === true) {
return self::stripQuotes($string);
if ($tokens[$next]['line'] > $tokens[$stackPtr]['line']) {
return ($next - 1);
}

return $string;
return self::getEndOfDoubleQuotedString($phpcsFile, $next);
}

/**
Expand Down
Loading