Skip to content

Verify parameter names of function aliases #6335

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

Closed
wants to merge 9 commits into from
Closed

Verify parameter names of function aliases #6335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ec7a0ad
Verify parameter names of function aliases
kocsismate Oct 13, 2020
27d957a
Refactor tri-state Context::forceRegeneration to two booleans
kocsismate Oct 13, 2020
f73d492
Mark aliases in ext/bz2 as implementation-alias
kocsismate Oct 13, 2020
f07e817
Remove useless condition
kocsismate Oct 13, 2020
295eddd
Fix test
kocsismate Oct 13, 2020
7404770
Add more strict verification
kocsismate Oct 14, 2020
f695ad3
Address another round of review comments + fix tests
kocsismate Oct 14, 2020
1ccc8d3
Improve gen_stub.php
kocsismate Oct 15, 2020
614f681
Revert arginfo generation behaviour change
kocsismate Oct 15, 2020
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
211 changes: 185 additions & 26 deletions build/gen_stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,30 @@

error_reporting(E_ALL);

function processDirectory(string $dir, Context $context) {
/**
* @return FileInfo[]
*/
function processDirectory(string $dir, Context $context): array {
$fileInfos = [];

$it = new RecursiveIteratorIterator(
new RecursiveDirectoryIterator($dir),
RecursiveIteratorIterator::LEAVES_ONLY
);
foreach ($it as $file) {
$pathName = $file->getPathName();
if (preg_match('/\.stub\.php$/', $pathName)) {
processStubFile($pathName, $context);
$fileInfo = processStubFile($pathName, $context);
if ($fileInfo) {
$fileInfos[] = $fileInfo;
}
}
}

return $fileInfos;
}

function processStubFile(string $stubFile, Context $context) {
function processStubFile(string $stubFile, Context $context): ?FileInfo {
try {
if (!file_exists($stubFile)) {
throw new Exception("File $stubFile does not exist");
Expand All @@ -37,15 +47,15 @@ function processStubFile(string $stubFile, Context $context) {
$stubCode = file_get_contents($stubFile);
$stubHash = computeStubHash($stubCode);
$oldStubHash = extractStubHash($arginfoFile);
if ($stubHash === $oldStubHash && $context->forceRegeneration === false) {
if ($stubHash === $oldStubHash && !$context->forceParse) {
/* Stub file did not change, do not regenerate. */
return;
return null;
}

initPhpParser();
$fileInfo = parseStubFile($stubCode);
$arginfoCode = generateArgInfoCode($fileInfo, $stubHash);
if (file_put_contents($arginfoFile, $arginfoCode)) {
if (($context->forceRegeneration || $stubHash !== $oldStubHash) && file_put_contents($arginfoFile, $arginfoCode)) {
echo "Saved $arginfoFile\n";
}

Expand All @@ -54,20 +64,12 @@ function processStubFile(string $stubFile, Context $context) {
$funcInfo->discardInfoForOldPhpVersions();
}
$arginfoCode = generateArgInfoCode($fileInfo, $stubHash);
if (file_put_contents($legacyFile, $arginfoCode)) {
if (($context->forceRegeneration || $stubHash !== $oldStubHash) && file_put_contents($legacyFile, $arginfoCode)) {
echo "Saved $legacyFile\n";
}
}

// Collect parameter name statistics.
foreach ($fileInfo->getAllFuncInfos() as $funcInfo) {
foreach ($funcInfo->args as $argInfo) {
if (!isset($context->parameterStats[$argInfo->name])) {
$context->parameterStats[$argInfo->name] = 0;
}
$context->parameterStats[$argInfo->name]++;
}
}
return $fileInfo;
} catch (Exception $e) {
echo "In $stubFile:\n{$e->getMessage()}\n";
exit(1);
Expand All @@ -92,10 +94,10 @@ function extractStubHash(string $arginfoFile): ?string {
}

class Context {
/** @var bool */
public $forceParse = false;
/** @var bool */
public $forceRegeneration = false;
/** @var array */
public $parameterStats = [];
}

class SimpleType {
Expand Down Expand Up @@ -358,6 +360,8 @@ public function getDeclaration(): string;
public function getArgInfoName(): string;
public function __toString(): string;
public function isMagicMethod(): bool;
public function isMethod(): bool;
public function isConstructor(): bool;
}

class FunctionName implements FunctionOrMethodName {
Expand Down Expand Up @@ -402,6 +406,14 @@ public function __toString(): string {
public function isMagicMethod(): bool {
return false;
}

public function isMethod(): bool {
return false;
}

public function isConstructor(): bool {
return false;
}
}

class MethodName implements FunctionOrMethodName {
Expand Down Expand Up @@ -434,6 +446,14 @@ public function __toString(): string {
public function isMagicMethod(): bool {
return strpos($this->methodName, '__') === 0;
}

public function isMethod(): bool {
return true;
}

public function isConstructor(): bool {
return $this->methodName === "__construct";
}
}

class ReturnInfo {
Expand All @@ -457,13 +477,17 @@ class FuncInfo {
/** @var FunctionOrMethodName */
public $name;
/** @var int */
public $classFlags;
/** @var int */
public $flags;
/** @var string|null */
public $aliasType;
/** @var FunctionName|null */
public $alias;
/** @var bool */
public $isDeprecated;
/** @var bool */
public $verify;
/** @var ArgInfo[] */
public $args;
/** @var ReturnInfo */
Expand All @@ -475,26 +499,45 @@ class FuncInfo {

public function __construct(
FunctionOrMethodName $name,
int $classFlags,
int $flags,
?string $aliasType,
?FunctionOrMethodName $alias,
bool $isDeprecated,
bool $verify,
array $args,
ReturnInfo $return,
int $numRequiredArgs,
?string $cond
) {
$this->name = $name;
$this->classFlags = $classFlags;
$this->flags = $flags;
$this->aliasType = $aliasType;
$this->alias = $alias;
$this->isDeprecated = $isDeprecated;
$this->verify = $verify;
$this->args = $args;
$this->return = $return;
$this->numRequiredArgs = $numRequiredArgs;
$this->cond = $cond;
}

public function isMethod(): bool
{
return $this->name->isMethod();
}

public function isFinalMethod(): bool
{
return ($this->flags & Class_::MODIFIER_FINAL) || ($this->classFlags & Class_::MODIFIER_FINAL);
}

public function isInstanceMethod(): bool
{
return !($this->flags & Class_::MODIFIER_STATIC) && $this->isMethod() && !$this->name->isConstructor();
}

public function equalsApartFromName(FuncInfo $other): bool {
if (count($this->args) !== count($other->args)) {
return false;
Expand Down Expand Up @@ -732,6 +775,7 @@ function parseDocComment(DocComment $comment): array {
function parseFunctionLike(
PrettyPrinterAbstract $prettyPrinter,
FunctionOrMethodName $name,
int $classFlags,
int $flags,
Node\FunctionLike $func,
?string $cond
Expand All @@ -741,6 +785,7 @@ function parseFunctionLike(
$aliasType = null;
$alias = null;
$isDeprecated = false;
$verify = true;
$haveDocReturnType = false;
$docParamTypes = [];

Expand All @@ -763,6 +808,8 @@ function parseFunctionLike(
}
} else if ($tag->name === 'deprecated') {
$isDeprecated = true;
} else if ($tag->name === 'no-verify') {
$verify = false;
} else if ($tag->name === 'return') {
$haveDocReturnType = true;
} else if ($tag->name === 'param') {
Expand Down Expand Up @@ -843,10 +890,12 @@ function parseFunctionLike(

return new FuncInfo(
$name,
$classFlags,
$flags,
$aliasType,
$alias,
$isDeprecated,
$verify,
$args,
$return,
$numRequiredArgs,
Expand Down Expand Up @@ -917,6 +966,7 @@ function handleStatements(FileInfo $fileInfo, array $stmts, PrettyPrinterAbstrac
$prettyPrinter,
new FunctionName($stmt->namespacedName),
0,
0,
$stmt,
$cond
);
Expand All @@ -936,6 +986,11 @@ function handleStatements(FileInfo $fileInfo, array $stmts, PrettyPrinterAbstrac
throw new Exception("Not implemented {$classStmt->getType()}");
}

$classFlags = 0;
if ($stmt instanceof Class_) {
$classFlags = $stmt->flags;
}

$flags = $classStmt->flags;
if ($stmt instanceof Stmt\Interface_) {
$flags |= Class_::MODIFIER_ABSTRACT;
Expand All @@ -948,6 +1003,7 @@ function handleStatements(FileInfo $fileInfo, array $stmts, PrettyPrinterAbstrac
$methodInfos[] = parseFunctionLike(
$prettyPrinter,
new MethodName($className, $classStmt->name->toString()),
$classFlags,
$flags,
$classStmt,
$cond
Expand Down Expand Up @@ -1262,29 +1318,132 @@ function initPhpParser() {
}

$optind = null;
$options = getopt("fh", ["force-regeneration", "parameter-stats", "help"], $optind);
$options = getopt("fh", ["force-regeneration", "parameter-stats", "help", "verify"], $optind);

$context = new Context;
$printParameterStats = isset($options["parameter-stats"]);
$context->forceRegeneration =
isset($options["f"]) || isset($options["force-regeneration"]) || $printParameterStats;
$verify = isset($options["verify"]);
$context->forceRegeneration = isset($options["f"]) || isset($options["force-regeneration"]);
$context->forceParse = $context->forceRegeneration || $printParameterStats || $verify;

if (isset($options["h"]) || isset($options["help"])) {
die("\nusage: gen-stub.php [ -f | --force-regeneration ] [ --parameter-stats ] [ -h | --help ] [ name.stub.php | directory ]\n\n");
die("\nusage: gen-stub.php [ -f | --force-regeneration ] [ --parameter-stats ] [ --verify ] [ -h | --help ] [ name.stub.php | directory ]\n\n");
}

$fileInfos = [];
$location = $argv[$optind] ?? ".";
if (is_file($location)) {
// Generate single file.
processStubFile($location, $context);
$fileInfo = processStubFile($location, $context);
if ($fileInfo) {
$fileInfos[] = $fileInfo;
}
} else if (is_dir($location)) {
processDirectory($location, $context);
$fileInfos = processDirectory($location, $context);
} else {
echo "$location is neither a file nor a directory.\n";
exit(1);
}

if ($printParameterStats) {
arsort($context->parameterStats);
echo json_encode($context->parameterStats, JSON_PRETTY_PRINT), "\n";
$parameterStats = [];

foreach ($fileInfos as $fileInfo) {
foreach ($fileInfo->getAllFuncInfos() as $funcInfo) {
foreach ($funcInfo->args as $argInfo) {
if (!isset($context->parameterStats[$argInfo->name])) {
$parameterStats[$argInfo->name] = 0;
}
$parameterStats[$argInfo->name]++;
}
}
}

arsort($parameterStats);
echo json_encode($parameterStats, JSON_PRETTY_PRINT), "\n";
}

if ($verify) {
$errors = [];
$funcMap = [];
$aliases = [];

foreach ($fileInfos as $fileInfo) {
foreach ($fileInfo->getAllFuncInfos() as $funcInfo) {
/** @var FuncInfo $funcInfo */
$funcMap[$funcInfo->name->__toString()] = $funcInfo;

if ($funcInfo->aliasType === "alias") {
$aliases[] = $funcInfo;
}
}
}

foreach ($aliases as $aliasFunc) {
if (!isset($funcMap[$aliasFunc->alias->__toString()])) {
$errors[] = "Aliased function {$aliasFunc->alias}() cannot be found";
continue;
}

if ($aliasFunc->verify === false) {
continue;
}

$aliasedFunc = $funcMap[$aliasFunc->alias->__toString()];
$aliasedArgs = $aliasedFunc->args;
$aliasArgs = $aliasFunc->args;

if ($aliasFunc->isInstanceMethod() !== $aliasedFunc->isInstanceMethod()) {
if ($aliasFunc->isInstanceMethod()) {
$aliasedArgs = array_slice($aliasedArgs, 1);
}

if ($aliasedFunc->isInstanceMethod()) {
$aliasArgs = array_slice($aliasArgs, 1);
}
}

array_map(
function(?ArgInfo $aliasArg, ?ArgInfo $aliasedArg) use ($aliasFunc, $aliasedFunc, &$errors) {
if ($aliasArg === null) {
assert($aliasedArg !== null);
$errors[] = "{$aliasFunc->name}(): Argument \$$aliasedArg->name of aliased function {$aliasedFunc->name}() is missing";
return null;
}

if ($aliasedArg === null) {
assert($aliasArg !== null);
$errors[] = "{$aliasedFunc->name}(): Argument \$$aliasArg->name of alias function {$aliasFunc->name}() is missing";
return null;
}

if ($aliasArg->name !== $aliasedArg->name) {
$errors[] = "{$aliasFunc->name}(): Argument \$$aliasArg->name and argument \$$aliasedArg->name of aliased function {$aliasedFunc->name}() must have the same name";
return null;
}

if ($aliasArg->type != $aliasedArg->type) {
$errors[] = "{$aliasFunc->name}(): Argument \$$aliasArg->name and argument \$$aliasedArg->name of aliased function {$aliasedFunc->name}() must have the same type";
}

if ($aliasArg->defaultValue !== $aliasedArg->defaultValue) {
$errors[] = "{$aliasFunc->name}(): Argument \$$aliasArg->name and argument \$$aliasedArg->name of aliased function {$aliasedFunc->name}() must have the same default value";
}
},
$aliasArgs, $aliasedArgs
);

if ((!$aliasedFunc->isMethod() || $aliasedFunc->isFinalMethod()) &&
(!$aliasFunc->isMethod() || $aliasFunc->isFinalMethod()) &&
$aliasFunc->return != $aliasedFunc->return
) {
$errors[] = "{$aliasFunc->name}() and {$aliasedFunc->name}() must have the same return type";
}
}

echo implode("\n", $errors);
if (!empty($errors)) {
echo "\n";
exit(1);
}
}
Loading