Preview: UnusedVariableSniff.php
Size: 19.79 KB
/opt/cpanel/ea-wappspector/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/UnusedVariableSniff.php
<?php declare(strict_types = 1);
namespace SlevomatCodingStandard\Sniffs\Variables;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Util\Tokens;
use SlevomatCodingStandard\Helpers\ParameterHelper;
use SlevomatCodingStandard\Helpers\PropertyHelper;
use SlevomatCodingStandard\Helpers\ScopeHelper;
use SlevomatCodingStandard\Helpers\TokenHelper;
use SlevomatCodingStandard\Helpers\VariableHelper;
use function array_key_exists;
use function array_keys;
use function array_merge;
use function array_reverse;
use function in_array;
use function sprintf;
use const T_AND_EQUAL;
use const T_AS;
use const T_BITWISE_AND;
use const T_CLOSE_CURLY_BRACKET;
use const T_CLOSE_SHORT_ARRAY;
use const T_CLOSURE;
use const T_COMMA;
use const T_CONCAT_EQUAL;
use const T_DEC;
use const T_DIV_EQUAL;
use const T_DO;
use const T_DOUBLE_ARROW;
use const T_DOUBLE_COLON;
use const T_DOUBLE_QUOTED_STRING;
use const T_ECHO;
use const T_ELSEIF;
use const T_EMPTY;
use const T_EQUAL;
use const T_EVAL;
use const T_EXIT;
use const T_FOR;
use const T_FOREACH;
use const T_GLOBAL;
use const T_HEREDOC;
use const T_IF;
use const T_INC;
use const T_INLINE_ELSE;
use const T_LIST;
use const T_MINUS_EQUAL;
use const T_MOD_EQUAL;
use const T_MUL_EQUAL;
use const T_OBJECT_OPERATOR;
use const T_OPEN_PARENTHESIS;
use const T_OPEN_SHORT_ARRAY;
use const T_OPEN_SQUARE_BRACKET;
use const T_OPEN_TAG;
use const T_OR_EQUAL;
use const T_PLUS_EQUAL;
use const T_POW_EQUAL;
use const T_PRINT;
use const T_RETURN;
use const T_SL_EQUAL;
use const T_SR_EQUAL;
use const T_STATIC;
use const T_STRING;
use const T_STRING_CONCAT;
use const T_USE;
use const T_VARIABLE;
use const T_WHILE;
use const T_XOR_EQUAL;
use const T_YIELD;
class UnusedVariableSniff implements Sniff
{
public const CODE_UNUSED_VARIABLE = 'UnusedVariable';
public bool $ignoreUnusedValuesWhenOnlyKeysAreUsedInForeach = false;
/**
* @return array<int, (int|string)>
*/
public function register(): array
{
return [
T_VARIABLE,
];
}
/**
* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
* @param int $pointer
*/
public function process(File $phpcsFile, $pointer): void
{
if (!$this->isAssignment($phpcsFile, $pointer)) {
return;
}
$tokens = $phpcsFile->getTokens();
$variableName = $tokens[$pointer]['content'];
if (in_array($variableName, [
'$this',
'$GLOBALS',
'$_SERVER',
'$_GET',
'$_POST',
'$_FILES',
'$_COOKIE',
'$_SESSION',
'$_REQUEST',
'$_ENV',
], true)) {
return;
}
$previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $pointer - 1);
if (in_array($tokens[$previousPointer]['code'], [T_OBJECT_OPERATOR, T_DOUBLE_COLON], true)) {
// Property
return;
}
if (in_array($tokens[$previousPointer]['code'], Tokens::$castTokens, true)) {
$previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $previousPointer - 1);
}
if (in_array($tokens[$previousPointer]['code'], [
T_EQUAL,
T_PLUS_EQUAL,
T_MINUS_EQUAL,
T_MUL_EQUAL,
T_DIV_EQUAL,
T_POW_EQUAL,
T_MOD_EQUAL,
T_AND_EQUAL,
T_OR_EQUAL,
T_XOR_EQUAL,
T_SL_EQUAL,
T_SR_EQUAL,
T_CONCAT_EQUAL,
T_YIELD,
], true)) {
return;
}
if ($this->isUsedAsParameter($phpcsFile, $pointer)) {
return;
}
if ($this->isUsedInForLoopCondition($phpcsFile, $pointer, $variableName)) {
return;
}
if ($this->isDefinedInDoConditionAndUsedInLoop($phpcsFile, $pointer, $variableName)) {
return;
}
if ($this->isUsedInLoopCycle($phpcsFile, $pointer, $variableName)) {
return;
}
if ($this->isUsedAsKeyOrValueInArray($phpcsFile, $pointer)) {
return;
}
if ($this->isValueInForeachAndErrorIsIgnored($phpcsFile, $pointer)) {
return;
}
$scopeOwnerPointer = ScopeHelper::getRootPointer($phpcsFile, $pointer - 1);
foreach (array_reverse($tokens[$pointer]['conditions'], true) as $conditionPointer => $conditionTokenCode) {
if (in_array($conditionTokenCode, TokenHelper::FUNCTION_TOKEN_CODES, true)) {
$scopeOwnerPointer = $conditionPointer;
break;
}
}
if (in_array($tokens[$scopeOwnerPointer]['code'], TokenHelper::FUNCTION_TOKEN_CODES, true)) {
if ($this->isStaticOrGlobalVariable($phpcsFile, $scopeOwnerPointer, $variableName)) {
return;
}
if ($this->isParameterPassedByReference($phpcsFile, $scopeOwnerPointer, $variableName)) {
return;
}
if (
$tokens[$scopeOwnerPointer]['code'] === T_CLOSURE
&& $this->isInheritedVariablePassedByReference($phpcsFile, $scopeOwnerPointer, $variableName)
) {
return;
}
}
if ($this->isReference($phpcsFile, $scopeOwnerPointer, $pointer)) {
return;
}
if (VariableHelper::isUsedInScopeAfterPointer($phpcsFile, $scopeOwnerPointer, $pointer, $pointer + 1)) {
return;
}
if ($this->isPartOfStatementAndWithIncrementOrDecrementOperator($phpcsFile, $pointer)) {
return;
}
$phpcsFile->addError(
sprintf('Unused variable %s.', $variableName),
$pointer,
self::CODE_UNUSED_VARIABLE,
);
}
private function isAssignment(File $phpcsFile, int $variablePointer): bool
{
$tokens = $phpcsFile->getTokens();
$nextPointer = TokenHelper::findNextEffective($phpcsFile, $variablePointer + 1);
if (in_array($tokens[$nextPointer]['code'], [
T_EQUAL,
T_PLUS_EQUAL,
T_MINUS_EQUAL,
T_MUL_EQUAL,
T_DIV_EQUAL,
T_POW_EQUAL,
T_MOD_EQUAL,
T_AND_EQUAL,
T_OR_EQUAL,
T_XOR_EQUAL,
T_SL_EQUAL,
T_SR_EQUAL,
T_CONCAT_EQUAL,
], true)) {
if ($tokens[$nextPointer]['code'] === T_EQUAL) {
if (PropertyHelper::isProperty($phpcsFile, $variablePointer)) {
return false;
}
if (ParameterHelper::isParameter($phpcsFile, $variablePointer)) {
return false;
}
}
return true;
}
$actualPointer = $variablePointer;
do {
$parenthesisOpenerPointer = $this->findOpenerOfNestedParentheses($phpcsFile, $actualPointer);
$parenthesisOwnerPointer = $this->findOwnerOfNestedParentheses($phpcsFile, $actualPointer);
if ($parenthesisOpenerPointer === null) {
break;
}
$actualPointer = $parenthesisOpenerPointer;
} while ($parenthesisOwnerPointer === null && isset($tokens[$actualPointer]['nested_parenthesis']));
$previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $variablePointer - 1);
if (
in_array($tokens[$nextPointer]['code'], [T_INC, T_DEC], true)
|| in_array($tokens[$previousPointer]['code'], [T_INC, T_DEC], true)
) {
if ($parenthesisOwnerPointer === null) {
return true;
}
return !in_array($tokens[$parenthesisOwnerPointer]['code'], [T_FOR, T_WHILE, T_IF, T_ELSEIF], true);
}
if ($parenthesisOwnerPointer !== null && $tokens[$parenthesisOwnerPointer]['code'] === T_FOREACH) {
$pointerBeforeVariable = TokenHelper::findPreviousEffective($phpcsFile, $variablePointer - 1);
return in_array($tokens[$pointerBeforeVariable]['code'], [T_AS, T_DOUBLE_ARROW], true);
}
if ($parenthesisOpenerPointer !== null) {
$pointerBeforeParenthesisOpener = TokenHelper::findPreviousEffective($phpcsFile, $parenthesisOpenerPointer - 1);
if ($tokens[$pointerBeforeParenthesisOpener]['code'] === T_LIST) {
return true;
}
}
$possibleShortListCloserPointer = TokenHelper::findNextExcluding(
$phpcsFile,
[...TokenHelper::INEFFECTIVE_TOKEN_CODES, T_VARIABLE, T_COMMA],
$variablePointer + 1,
);
if ($tokens[$possibleShortListCloserPointer]['code'] === T_CLOSE_SHORT_ARRAY) {
return $tokens[TokenHelper::findNextEffective($phpcsFile, $possibleShortListCloserPointer + 1)]['code'] === T_EQUAL;
}
return false;
}
private function isUsedAsParameter(File $phpcsFile, int $variablePointer): bool
{
$parenthesisOpenerPointer = $this->findOpenerOfNestedParentheses($phpcsFile, $variablePointer);
if ($parenthesisOpenerPointer === null) {
return false;
}
if (!ScopeHelper::isInSameScope($phpcsFile, $parenthesisOpenerPointer, $variablePointer)) {
return false;
}
return $phpcsFile->getTokens()[TokenHelper::findPreviousEffective($phpcsFile, $parenthesisOpenerPointer - 1)]['code'] === T_STRING;
}
private function isUsedInForLoopCondition(File $phpcsFile, int $variablePointer, string $variableName): bool
{
$tokens = $phpcsFile->getTokens();
$parenthesisOpenerPointer = $this->findOpenerOfNestedParentheses($phpcsFile, $variablePointer);
if ($parenthesisOpenerPointer === null) {
return false;
}
$parenthesisOwnerPointer = $this->findOwnerOfNestedParentheses($phpcsFile, $variablePointer);
if ($parenthesisOwnerPointer === null) {
return false;
}
if ($tokens[$parenthesisOwnerPointer]['code'] !== T_FOR) {
return false;
}
for ($i = $parenthesisOpenerPointer + 1; $i < $tokens[$parenthesisOwnerPointer]['parenthesis_closer']; $i++) {
if ($i === $variablePointer) {
continue;
}
if ($tokens[$i]['code'] !== T_VARIABLE) {
continue;
}
if ($tokens[$i]['content'] !== $variableName) {
continue;
}
return true;
}
return false;
}
private function isDefinedInDoConditionAndUsedInLoop(File $phpcsFile, int $variablePointer, string $variableName): bool
{
$tokens = $phpcsFile->getTokens();
$parenthesisOpener = TokenHelper::findPrevious($phpcsFile, T_OPEN_PARENTHESIS, $variablePointer - 1);
if ($parenthesisOpener === null || $tokens[$parenthesisOpener]['parenthesis_closer'] < $variablePointer) {
return false;
}
$whilePointer = TokenHelper::findPreviousEffective($phpcsFile, $parenthesisOpener - 1);
if ($tokens[$whilePointer]['code'] !== T_WHILE) {
return false;
}
$loopCloserPointer = TokenHelper::findPreviousEffective($phpcsFile, $whilePointer - 1);
if ($tokens[$loopCloserPointer]['code'] !== T_CLOSE_CURLY_BRACKET) {
return false;
}
$doPointer = TokenHelper::findPreviousEffective($phpcsFile, $tokens[$loopCloserPointer]['bracket_opener'] - 1);
if ($tokens[$doPointer]['code'] !== T_DO) {
return false;
}
return TokenHelper::findNextContent(
$phpcsFile,
T_VARIABLE,
$variableName,
$tokens[$loopCloserPointer]['bracket_opener'] + 1,
$loopCloserPointer,
) !== null;
}
private function isUsedInLoopCycle(File $phpcsFile, int $variablePointer, string $variableName): bool
{
$tokens = $phpcsFile->getTokens();
$loopPointer = null;
foreach (array_reverse($tokens[$variablePointer]['conditions'], true) as $conditionPointer => $conditionTokenCode) {
if (in_array($conditionTokenCode, TokenHelper::FUNCTION_TOKEN_CODES, true)) {
break;
}
if (!in_array($conditionTokenCode, [T_FOREACH, T_FOR, T_DO, T_WHILE], true)) {
continue;
}
$loopPointer = $conditionPointer;
$loopConditionPointer = $conditionTokenCode === T_DO
? TokenHelper::findNextEffective($phpcsFile, $tokens[$loopPointer]['scope_closer'] + 1)
: $loopPointer;
$variableUsedInLoopConditionPointer = TokenHelper::findNextContent(
$phpcsFile,
T_VARIABLE,
$variableName,
$tokens[$loopConditionPointer]['parenthesis_opener'] + 1,
$tokens[$loopConditionPointer]['parenthesis_closer'],
);
if (
$variableUsedInLoopConditionPointer === null
|| $variableUsedInLoopConditionPointer === $variablePointer
) {
continue;
}
if ($conditionTokenCode !== T_FOREACH) {
return true;
}
$pointerBeforeVariableUsedInLoopCondition = TokenHelper::findPreviousEffective(
$phpcsFile,
$variableUsedInLoopConditionPointer - 1,
);
if ($tokens[$pointerBeforeVariableUsedInLoopCondition]['code'] === T_BITWISE_AND) {
return true;
}
}
if ($loopPointer === null) {
return false;
}
for ($i = $tokens[$loopPointer]['scope_opener'] + 1; $i < $tokens[$loopPointer]['scope_closer']; $i++) {
if (
in_array($tokens[$i]['code'], [T_DOUBLE_QUOTED_STRING, T_HEREDOC], true)
&& VariableHelper::isUsedInScopeInString($phpcsFile, $variableName, $i)
) {
return true;
}
if ($tokens[$i]['code'] !== T_VARIABLE) {
continue;
}
if ($tokens[$i]['content'] !== $variableName) {
continue;
}
if (!$this->isAssignment($phpcsFile, $i)) {
return true;
}
$nextPointer = TokenHelper::findNextEffective($phpcsFile, $i + 1);
if (!in_array($tokens[$nextPointer]['code'], [
T_INC,
T_DEC,
T_PLUS_EQUAL,
T_MINUS_EQUAL,
T_MUL_EQUAL,
T_DIV_EQUAL,
T_POW_EQUAL,
T_MOD_EQUAL,
T_AND_EQUAL,
T_OR_EQUAL,
T_XOR_EQUAL,
T_SL_EQUAL,
T_SR_EQUAL,
T_CONCAT_EQUAL,
], true)) {
continue;
}
$previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $i - 1);
if ($tokens[$previousPointer]['code'] === T_INLINE_ELSE) {
return true;
}
$parenthesisOwnerPointer = $this->findNestedParenthesisWithOwner($phpcsFile, $i);
if (
$parenthesisOwnerPointer !== null
&& in_array($tokens[$parenthesisOwnerPointer]['code'], [T_IF, T_ELSEIF], true)
) {
return true;
}
}
return false;
}
private function isUsedAsKeyOrValueInArray(File $phpcsFile, int $variablePointer): bool
{
$tokens = $phpcsFile->getTokens();
$squareBracketOpenerPointer = TokenHelper::findPrevious($phpcsFile, T_OPEN_SQUARE_BRACKET, $variablePointer - 1);
if (
$squareBracketOpenerPointer !== null
&& $tokens[$squareBracketOpenerPointer]['bracket_closer'] > $variablePointer
) {
return true;
}
$arrayOpenerPointer = TokenHelper::findPrevious($phpcsFile, T_OPEN_SHORT_ARRAY, $variablePointer - 1);
if ($arrayOpenerPointer === null) {
return false;
}
$arrayCloserPointer = $tokens[$arrayOpenerPointer]['bracket_closer'];
if ($arrayCloserPointer < $variablePointer) {
return false;
}
$pointerAfterArrayCloser = TokenHelper::findNextEffective($phpcsFile, $arrayCloserPointer + 1);
if ($tokens[$pointerAfterArrayCloser]['code'] === T_EQUAL) {
return false;
}
$pointerBeforeVariable = TokenHelper::findPreviousEffective($phpcsFile, $variablePointer - 1);
if (in_array($tokens[$pointerBeforeVariable]['code'], [T_INC, T_DEC], true)) {
$pointerBeforeVariable = TokenHelper::findPreviousEffective($phpcsFile, $pointerBeforeVariable - 1);
}
return in_array($tokens[$pointerBeforeVariable]['code'], [T_OPEN_SHORT_ARRAY, T_COMMA, T_DOUBLE_ARROW], true);
}
private function isValueInForeachAndErrorIsIgnored(File $phpcsFile, int $variablePointer): bool
{
$tokens = $phpcsFile->getTokens();
$parenthesisOwnerPointer = $this->findNestedParenthesisWithOwner($phpcsFile, $variablePointer);
$isInForeach = $parenthesisOwnerPointer !== null && $tokens[$parenthesisOwnerPointer]['code'] === T_FOREACH;
if (!$isInForeach) {
return false;
}
$pointerAfterVariable = TokenHelper::findNextEffective($phpcsFile, $variablePointer + 1);
if ($pointerAfterVariable !== null && $tokens[$pointerAfterVariable]['code'] === T_DOUBLE_ARROW) {
return false;
}
return $this->ignoreUnusedValuesWhenOnlyKeysAreUsedInForeach;
}
private function isStaticOrGlobalVariable(File $phpcsFile, int $functionPointer, string $variableName): bool
{
$tokens = $phpcsFile->getTokens();
for ($i = $tokens[$functionPointer]['scope_opener'] + 1; $i < $tokens[$functionPointer]['scope_closer']; $i++) {
if ($tokens[$i]['code'] !== T_VARIABLE) {
continue;
}
if ($tokens[$i]['content'] !== $variableName) {
continue;
}
$pointerBeforeParameter = TokenHelper::findPreviousEffective($phpcsFile, $i - 1);
if (in_array($tokens[$pointerBeforeParameter]['code'], [T_STATIC, T_GLOBAL], true)) {
return true;
}
}
return false;
}
private function isParameterPassedByReference(File $phpcsFile, int $functionPointer, string $variableName): bool
{
$tokens = $phpcsFile->getTokens();
for ($i = $tokens[$functionPointer]['parenthesis_opener'] + 1; $i < $tokens[$functionPointer]['parenthesis_closer']; $i++) {
if ($tokens[$i]['code'] !== T_VARIABLE) {
continue;
}
if ($tokens[$i]['content'] !== $variableName) {
continue;
}
$pointerBeforeParameter = TokenHelper::findPreviousEffective($phpcsFile, $i - 1);
if ($tokens[$pointerBeforeParameter]['code'] === T_BITWISE_AND) {
return true;
}
}
return false;
}
private function isInheritedVariablePassedByReference(File $phpcsFile, int $functionPointer, string $variableName): bool
{
$tokens = $phpcsFile->getTokens();
$usePointer = TokenHelper::findNextEffective($phpcsFile, $tokens[$functionPointer]['parenthesis_closer'] + 1);
if ($tokens[$usePointer]['code'] !== T_USE) {
return false;
}
$useParenthesisOpener = TokenHelper::findNextEffective($phpcsFile, $usePointer + 1);
for ($i = $useParenthesisOpener + 1; $i < $tokens[$useParenthesisOpener]['parenthesis_closer']; $i++) {
if ($tokens[$i]['code'] !== T_VARIABLE) {
continue;
}
if ($tokens[$i]['content'] !== $variableName) {
continue;
}
$pointerBeforeInheritedVariable = TokenHelper::findPreviousEffective($phpcsFile, $i - 1);
if ($tokens[$pointerBeforeInheritedVariable]['code'] === T_BITWISE_AND) {
return true;
}
}
return false;
}
private function isReference(File $phpcsFile, int $scopeOwnerPointer, int $variablePointer): bool
{
$tokens = $phpcsFile->getTokens();
$scopeOpenerPointer = $tokens[$scopeOwnerPointer]['code'] === T_OPEN_TAG
? $scopeOwnerPointer
: $tokens[$scopeOwnerPointer]['scope_opener'];
for ($i = $scopeOpenerPointer + 1; $i < $variablePointer; $i++) {
if ($tokens[$i]['code'] !== T_VARIABLE) {
continue;
}
if ($tokens[$i]['content'] !== $tokens[$variablePointer]['content']) {
continue;
}
$assignmentPointer = TokenHelper::findNextEffective($phpcsFile, $i + 1);
if ($tokens[$assignmentPointer]['code'] !== T_EQUAL) {
continue;
}
$referencePointer = TokenHelper::findNextEffective($phpcsFile, $assignmentPointer + 1);
if ($tokens[$referencePointer]['code'] === T_BITWISE_AND) {
return true;
}
}
return false;
}
private function isPartOfStatementAndWithIncrementOrDecrementOperator(File $phpcsFile, int $variablePointer): bool
{
$tokens = $phpcsFile->getTokens();
$previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $variablePointer - 1);
$nextPointer = TokenHelper::findNextEffective($phpcsFile, $variablePointer + 1);
if (in_array($tokens[$previousPointer]['code'], [T_DEC, T_INC], true)) {
$previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $previousPointer - 1);
} elseif ($nextPointer !== null && in_array($tokens[$nextPointer]['code'], [T_DEC, T_INC], true)) {
// Nothing
} else {
return false;
}
if ($tokens[$previousPointer]['code'] === T_OPEN_PARENTHESIS) {
$previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $previousPointer - 1);
}
return in_array(
$tokens[$previousPointer]['code'],
array_merge(
[T_STRING_CONCAT, T_ECHO, T_RETURN, T_EXIT, T_PRINT, T_COMMA, T_EMPTY, T_EVAL, T_YIELD],
Tokens::$operators,
Tokens::$assignmentTokens,
Tokens::$booleanOperators,
Tokens::$castTokens,
),
true,
);
}
private function findNestedParenthesisWithOwner(File $phpcsFile, int $pointer): ?int
{
$tokens = $phpcsFile->getTokens();
if (!array_key_exists('nested_parenthesis', $tokens[$pointer])) {
return null;
}
foreach (array_reverse(array_keys($tokens[$pointer]['nested_parenthesis'])) as $nestedParenthesisOpener) {
if (array_key_exists('parenthesis_owner', $tokens[$nestedParenthesisOpener])) {
return $tokens[$nestedParenthesisOpener]['parenthesis_owner'];
}
}
return null;
}
private function findOpenerOfNestedParentheses(File $phpcsFile, int $pointer): ?int
{
$tokens = $phpcsFile->getTokens();
if (!array_key_exists('nested_parenthesis', $tokens[$pointer])) {
return null;
}
return array_reverse(array_keys($tokens[$pointer]['nested_parenthesis']))[0];
}
private function findOwnerOfNestedParentheses(File $phpcsFile, int $pointer): ?int
{
$tokens = $phpcsFile->getTokens();
$parenthesisOpenerPointer = $this->findOpenerOfNestedParentheses($phpcsFile, $pointer);
if ($parenthesisOpenerPointer === null) {
return null;
}
return array_key_exists('parenthesis_owner', $tokens[$parenthesisOpenerPointer])
? $tokens[$parenthesisOpenerPointer]['parenthesis_owner']
: null;
}
}
Directory Contents
Dirs: 0 × Files: 5