Skip to content

Add support for lowercase string on parse_url #3493

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 2 commits into from
Sep 26, 2024
Merged

Add support for lowercase string on parse_url #3493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5870420
Add support for lowercase string on parse_url
VincentLanglet Sep 26, 2024
0d941ec
Fix
VincentLanglet Sep 26, 2024
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
94 changes: 79 additions & 15 deletions src/Type/Php/ParseUrlFunctionDynamicReturnTypeExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\FunctionReflection;
use PHPStan\ShouldNotHappenException;
use PHPStan\Type\Accessory\AccessoryLowercaseStringType;
use PHPStan\Type\Constant\ConstantArrayTypeBuilder;
use PHPStan\Type\Constant\ConstantBooleanType;
use PHPStan\Type\Constant\ConstantIntegerType;
use PHPStan\Type\Constant\ConstantStringType;
use PHPStan\Type\DynamicFunctionReturnTypeExtension;
use PHPStan\Type\IntegerRangeType;
use PHPStan\Type\IntersectionType;
use PHPStan\Type\NullType;
use PHPStan\Type\StringType;
use PHPStan\Type\Type;
Expand All @@ -37,8 +39,16 @@ final class ParseUrlFunctionDynamicReturnTypeExtension implements DynamicFunctio
/** @var array<string,Type>|null */
private ?array $componentTypesPairedStrings = null;

/** @var array<int,Type>|null */
private ?array $componentTypesPairedConstantsForLowercaseString = null;

/** @var array<string,Type>|null */
private ?array $componentTypesPairedStringsForLowercaseString = null;

private ?Type $allComponentsTogetherType = null;

private ?Type $allComponentsTogetherTypeForLowercaseString = null;

public function isFunctionSupported(FunctionReflection $functionReflection): bool
{
return $functionReflection->getName() === 'parse_url';
Expand All @@ -52,23 +62,22 @@ public function getTypeFromFunctionCall(FunctionReflection $functionReflection,

$this->cacheReturnTypes();

$urlType = $scope->getType($functionCall->getArgs()[0]->value);
if (count($functionCall->getArgs()) > 1) {
$componentType = $scope->getType($functionCall->getArgs()[1]->value);

if (!$componentType->isConstantValue()->yes()) {
return $this->createAllComponentsReturnType();
return $this->createAllComponentsReturnType($urlType->isLowercaseString()->yes());
}

$componentType = $componentType->toInteger();

if (!$componentType instanceof ConstantIntegerType) {
return $this->createAllComponentsReturnType();
return $this->createAllComponentsReturnType($urlType->isLowercaseString()->yes());
}
} else {
$componentType = new ConstantIntegerType(-1);
}

$urlType = $scope->getType($functionCall->getArgs()[0]->value);
if (count($urlType->getConstantStrings()) > 0) {
$types = [];
foreach ($urlType->getConstantStrings() as $constantString) {
Expand All @@ -86,21 +95,44 @@ public function getTypeFromFunctionCall(FunctionReflection $functionReflection,
}

if ($componentType->getValue() === -1) {
return TypeCombinator::union($this->createComponentsArray(), new ConstantBooleanType(false));
return TypeCombinator::union(
$this->createComponentsArray($urlType->isLowercaseString()->yes()),
new ConstantBooleanType(false)
);
}

if ($urlType->isLowercaseString()->yes()) {
return $this->componentTypesPairedConstantsForLowercaseString[$componentType->getValue()] ?? new ConstantBooleanType(false);
}

return $this->componentTypesPairedConstants[$componentType->getValue()] ?? new ConstantBooleanType(false);
}

private function createAllComponentsReturnType(): Type
private function createAllComponentsReturnType(bool $urlIsLowercase): Type
{
if ($urlIsLowercase) {
if ($this->allComponentsTogetherTypeForLowercaseString === null) {
$returnTypes = [
new ConstantBooleanType(false),
new NullType(),
IntegerRangeType::fromInterval(0, 65535),
new IntersectionType([new StringType(), new AccessoryLowercaseStringType()]),
$this->createComponentsArray(true),
];

$this->allComponentsTogetherTypeForLowercaseString = TypeCombinator::union(...$returnTypes);
}

return $this->allComponentsTogetherTypeForLowercaseString;
}

if ($this->allComponentsTogetherType === null) {
$returnTypes = [
new ConstantBooleanType(false),
new NullType(),
IntegerRangeType::fromInterval(0, 65535),
new StringType(),
$this->createComponentsArray(),
$this->createComponentsArray(false),
];

$this->allComponentsTogetherType = TypeCombinator::union(...$returnTypes);
Expand All @@ -109,19 +141,29 @@ private function createAllComponentsReturnType(): Type
return $this->allComponentsTogetherType;
}

private function createComponentsArray(): Type
private function createComponentsArray(bool $urlIsLowercase): Type
{
$builder = ConstantArrayTypeBuilder::createEmpty();
$builder = ConstantArrayTypeBuilder::createEmpty();

if ($this->componentTypesPairedStrings === null) {
throw new ShouldNotHappenException();
}
if ($urlIsLowercase) {
if ($this->componentTypesPairedStringsForLowercaseString === null) {
throw new ShouldNotHappenException();
}

foreach ($this->componentTypesPairedStringsForLowercaseString as $componentName => $componentValueType) {
$builder->setOffsetValueType(new ConstantStringType($componentName), $componentValueType, true);
}
} else {
if ($this->componentTypesPairedStrings === null) {
throw new ShouldNotHappenException();
}

foreach ($this->componentTypesPairedStrings as $componentName => $componentValueType) {
$builder->setOffsetValueType(new ConstantStringType($componentName), $componentValueType, true);
foreach ($this->componentTypesPairedStrings as $componentName => $componentValueType) {
$builder->setOffsetValueType(new ConstantStringType($componentName), $componentValueType, true);
}
}

return $builder->getArray();
return $builder->getArray();
}

private function cacheReturnTypes(): void
Expand All @@ -131,11 +173,13 @@ private function cacheReturnTypes(): void
}

$string = new StringType();
$lowercaseString = new IntersectionType([new StringType(), new AccessoryLowercaseStringType()]);
$port = IntegerRangeType::fromInterval(0, 65535);
$false = new ConstantBooleanType(false);
$null = new NullType();

$stringOrFalseOrNull = TypeCombinator::union($string, $false, $null);
$lowercaseStringOrFalseOrNull = TypeCombinator::union($lowercaseString, $false, $null);
$portOrFalseOrNull = TypeCombinator::union($port, $false, $null);

$this->componentTypesPairedConstants = [
Expand All @@ -148,6 +192,16 @@ private function cacheReturnTypes(): void
PHP_URL_QUERY => $stringOrFalseOrNull,
PHP_URL_FRAGMENT => $stringOrFalseOrNull,
];
$this->componentTypesPairedConstantsForLowercaseString = [
PHP_URL_SCHEME => $lowercaseStringOrFalseOrNull,
PHP_URL_HOST => $lowercaseStringOrFalseOrNull,
PHP_URL_PORT => $portOrFalseOrNull,
PHP_URL_USER => $lowercaseStringOrFalseOrNull,
PHP_URL_PASS => $lowercaseStringOrFalseOrNull,
PHP_URL_PATH => $lowercaseStringOrFalseOrNull,
PHP_URL_QUERY => $lowercaseStringOrFalseOrNull,
PHP_URL_FRAGMENT => $lowercaseStringOrFalseOrNull,
];

$this->componentTypesPairedStrings = [
'scheme' => $string,
Expand All @@ -159,6 +213,16 @@ private function cacheReturnTypes(): void
'query' => $string,
'fragment' => $string,
];
$this->componentTypesPairedStringsForLowercaseString = [
'scheme' => $lowercaseString,
'host' => $lowercaseString,
'port' => $port,
'user' => $lowercaseString,
'pass' => $lowercaseString,
'path' => $lowercaseString,
'query' => $lowercaseString,
'fragment' => $lowercaseString,
];
}

}
2 changes: 1 addition & 1 deletion tests/PHPStan/Analyser/LegacyNodeScopeResolverTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5492,7 +5492,7 @@ public function dataFunctions(): array
'$parseUrlConstantUrlWithoutComponent2',
],
[
'array{scheme?: string, host?: string, port?: int<0, 65535>, user?: string, pass?: string, path?: string, query?: string, fragment?: string}|int<0, 65535>|string|false|null',
'array{scheme?: lowercase-string, host?: lowercase-string, port?: int<0, 65535>, user?: lowercase-string, pass?: lowercase-string, path?: lowercase-string, query?: lowercase-string, fragment?: lowercase-string}|int<0, 65535>|lowercase-string|false|null',
'$parseUrlConstantUrlUnknownComponent',
],
[
Expand Down
26 changes: 26 additions & 0 deletions tests/PHPStan/Analyser/nsrt/lowercase-string-parse-url.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?php

namespace LowercaseStringParseUrl;

use function PHPStan\Testing\assertType;

class Foo
{

/**
* @param lowercase-string $lowercase
*/
public function doParseUrl(string $lowercase): void
{
assertType('array{scheme?: lowercase-string, host?: lowercase-string, port?: int<0, 65535>, user?: lowercase-string, pass?: lowercase-string, path?: lowercase-string, query?: lowercase-string, fragment?: lowercase-string}|false', parse_url($lowercase));
assertType('lowercase-string|false|null', parse_url($lowercase, PHP_URL_SCHEME));
assertType('lowercase-string|false|null', parse_url($lowercase, PHP_URL_HOST));
assertType('int<0, 65535>|false|null', parse_url($lowercase, PHP_URL_PORT));
assertType('lowercase-string|false|null', parse_url($lowercase, PHP_URL_USER));
assertType('lowercase-string|false|null', parse_url($lowercase, PHP_URL_PASS));
assertType('lowercase-string|false|null', parse_url($lowercase, PHP_URL_PATH));
assertType('lowercase-string|false|null', parse_url($lowercase, PHP_URL_QUERY));
assertType('lowercase-string|false|null', parse_url($lowercase, PHP_URL_FRAGMENT));
}

}
Loading