Skip to content

Fix htmlspecialchars and htmlentities being not-empty-string without ENT_SUBSTITUTE flag #3710

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
Dec 9, 2024
Merged

Fix htmlspecialchars and htmlentities being not-empty-string without ENT_SUBSTITUTE flag #3710

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
30 changes: 30 additions & 0 deletions src/Type/Php/NonEmptyStringFunctionsReturnTypeExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,20 @@

namespace PHPStan\Type\Php;

use PhpParser\Node\Arg;
use PhpParser\Node\Expr\FuncCall;
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\FunctionReflection;
use PHPStan\Type\Accessory\AccessoryNonEmptyStringType;
use PHPStan\Type\Accessory\AccessoryNonFalsyStringType;
use PHPStan\Type\Constant\ConstantIntegerType;
use PHPStan\Type\DynamicFunctionReturnTypeExtension;
use PHPStan\Type\IntersectionType;
use PHPStan\Type\StringType;
use PHPStan\Type\Type;
use function count;
use function in_array;
use const ENT_SUBSTITUTE;

final class NonEmptyStringFunctionsReturnTypeExtension implements DynamicFunctionReturnTypeExtension
{
Expand Down Expand Up @@ -45,6 +48,15 @@ public function getTypeFromFunctionCall(
return null;
}

if (in_array($functionReflection->getName(), [
'htmlspecialchars',
'htmlentities',
], true)) {
if (!$this->isSubstituteFlagSet($args, $scope)) {
return new StringType();
}
}

$argType = $scope->getType($args[0]->value);
if ($argType->isNonFalsyString()->yes()) {
return new IntersectionType([
Expand All @@ -62,4 +74,22 @@ public function getTypeFromFunctionCall(
return new StringType();
}

/**
* @param Arg[] $args
*/
private function isSubstituteFlagSet(
array $args,
Scope $scope,
): bool
{
if (!isset($args[1])) {
return true;
}
$flagsType = $scope->getType($args[1]->value);
if (!$flagsType instanceof ConstantIntegerType) {
return false;
}
return (bool) ($flagsType->getValue() & ENT_SUBSTITUTE);
}

}
9 changes: 9 additions & 0 deletions tests/PHPStan/Analyser/nsrt/non-empty-string.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
use function strtolower;
use function strtoupper;
use function ucfirst;
use const ENT_SUBSTITUTE;

class Foo
{
Expand Down Expand Up @@ -333,9 +334,17 @@ public function doFoo(string $s, string $nonEmpty, string $nonFalsy, int $i, boo
assertType('string', ucwords($s));
assertType('non-empty-string', ucwords($nonEmpty));
assertType('string', htmlspecialchars($s));
assertType('string', htmlspecialchars($s, ENT_SUBSTITUTE));
assertType('string', htmlspecialchars($s, 0));
assertType('non-empty-string', htmlspecialchars($nonEmpty));
assertType('non-empty-string', htmlspecialchars($nonEmpty, ENT_SUBSTITUTE));
assertType('string', htmlspecialchars($nonEmpty, 0));
assertType('string', htmlentities($s));
assertType('string', htmlentities($s, ENT_SUBSTITUTE));
assertType('string', htmlentities($s, 0));
assertType('non-empty-string', htmlentities($nonEmpty));
assertType('non-empty-string', htmlentities($nonEmpty, ENT_SUBSTITUTE));
assertType('string', htmlentities($nonEmpty, 0));

assertType('string', urlencode($s));
assertType('non-empty-string', urlencode($nonEmpty));
Expand Down
5 changes: 5 additions & 0 deletions tests/PHPStan/Analyser/nsrt/non-falsy-string.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace NonFalseyString;

use function PHPStan\Testing\assertType;
use const ENT_SUBSTITUTE;

class Foo {
/**
Expand Down Expand Up @@ -95,7 +96,11 @@ function stringFunctions(string $s, $nonFalsey, $arrayOfNonFalsey, $nonEmptyArra
assertType('non-falsy-string', ucfirst($nonFalsey));
assertType('non-falsy-string', ucwords($nonFalsey));
assertType('non-falsy-string', htmlspecialchars($nonFalsey));
assertType('non-falsy-string', htmlspecialchars($nonFalsey, ENT_SUBSTITUTE));
assertType('string', htmlspecialchars($nonFalsey, 0));
assertType('non-falsy-string', htmlentities($nonFalsey));
assertType('non-falsy-string', htmlentities($nonFalsey, ENT_SUBSTITUTE));
assertType('string', htmlentities($nonFalsey, 0));

assertType('non-falsy-string', urlencode($nonFalsey));
assertType('non-falsy-string', urldecode($nonFalsey));
Expand Down
Loading