2018-01-14 18:09:40 +01:00
|
|
|
<?php
|
|
|
|
namespace Psalm\Checker\Statements\Expression;
|
|
|
|
|
|
|
|
use PhpParser;
|
|
|
|
use Psalm\Checker\Statements\ExpressionChecker;
|
|
|
|
use Psalm\Checker\StatementsChecker;
|
|
|
|
use Psalm\CodeLocation;
|
|
|
|
use Psalm\Config;
|
|
|
|
use Psalm\Context;
|
|
|
|
use Psalm\Exception\FileIncludeException;
|
|
|
|
use Psalm\Issue\MissingFile;
|
|
|
|
use Psalm\Issue\UnresolvableInclude;
|
|
|
|
use Psalm\IssueBuffer;
|
|
|
|
|
|
|
|
class IncludeChecker
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* @return false|null
|
|
|
|
*/
|
|
|
|
public static function analyze(
|
|
|
|
StatementsChecker $statements_checker,
|
|
|
|
PhpParser\Node\Expr\Include_ $stmt,
|
2018-05-23 05:38:27 +02:00
|
|
|
Context $context,
|
|
|
|
Context $global_context = null
|
2018-01-14 18:09:40 +01:00
|
|
|
) {
|
|
|
|
$config = Config::getInstance();
|
|
|
|
|
|
|
|
if (!$config->allow_includes) {
|
|
|
|
throw new FileIncludeException(
|
|
|
|
'File includes are not allowed per your Psalm config - check the allowFileIncludes flag.'
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (ExpressionChecker::analyze($statements_checker, $stmt->expr, $context) === false) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($stmt->expr instanceof PhpParser\Node\Scalar\String_) {
|
2018-04-12 02:56:11 +02:00
|
|
|
$path_to_file = str_replace('/', DIRECTORY_SEPARATOR, $stmt->expr->value);
|
2018-01-14 18:09:40 +01:00
|
|
|
|
|
|
|
// attempts to resolve using get_include_path dirs
|
2018-05-30 22:19:18 +02:00
|
|
|
$include_path = self::resolveIncludePath($path_to_file, dirname($statements_checker->getFileName()));
|
2018-01-14 18:09:40 +01:00
|
|
|
$path_to_file = $include_path ? $include_path : $path_to_file;
|
|
|
|
|
2018-04-12 21:15:57 +02:00
|
|
|
if (DIRECTORY_SEPARATOR === '/') {
|
|
|
|
$is_path_relative = $path_to_file[0] !== DIRECTORY_SEPARATOR;
|
|
|
|
} else {
|
|
|
|
$is_path_relative = !preg_match('~^[A-Z]:\\\\~i', $path_to_file);
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($is_path_relative) {
|
2018-01-14 18:09:40 +01:00
|
|
|
$path_to_file = getcwd() . DIRECTORY_SEPARATOR . $path_to_file;
|
|
|
|
}
|
|
|
|
} else {
|
2018-05-30 22:19:18 +02:00
|
|
|
$path_to_file = self::getPathTo($stmt->expr, $statements_checker->getFileName());
|
2018-01-14 18:09:40 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
if ($path_to_file) {
|
2018-04-12 02:56:11 +02:00
|
|
|
$slash = preg_quote(DIRECTORY_SEPARATOR, '/');
|
|
|
|
$reduce_pattern = '/' . $slash . '[^' . $slash . ']+' . $slash . '\.\.' . $slash . '/';
|
2018-01-14 18:09:40 +01:00
|
|
|
|
|
|
|
while (preg_match($reduce_pattern, $path_to_file)) {
|
|
|
|
$path_to_file = preg_replace($reduce_pattern, DIRECTORY_SEPARATOR, $path_to_file);
|
|
|
|
}
|
|
|
|
|
|
|
|
// if the file is already included, we can't check much more
|
2018-04-12 21:15:57 +02:00
|
|
|
if (in_array(realpath($path_to_file), get_included_files(), true)) {
|
2018-01-14 18:09:40 +01:00
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
$current_file_checker = $statements_checker->getFileChecker();
|
|
|
|
|
|
|
|
if ($current_file_checker->project_checker->fileExists($path_to_file)) {
|
2018-05-23 05:38:27 +02:00
|
|
|
$codebase = $current_file_checker->project_checker->codebase;
|
|
|
|
|
2018-05-30 22:19:18 +02:00
|
|
|
if ($statements_checker->hasParentFilePath($path_to_file)
|
|
|
|
|| ($statements_checker->hasAlreadyRequiredFilePath($path_to_file)
|
2018-05-23 05:38:27 +02:00
|
|
|
&& !$codebase->file_storage_provider->get($path_to_file)->has_extra_statements)
|
|
|
|
) {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
2018-05-30 22:19:18 +02:00
|
|
|
$current_file_checker->addRequiredFilePath($path_to_file);
|
|
|
|
|
2018-05-23 05:38:27 +02:00
|
|
|
$file_name = $config->shortenFileName($path_to_file);
|
|
|
|
|
2018-05-30 22:19:18 +02:00
|
|
|
if ($current_file_checker->project_checker->debug_output) {
|
|
|
|
$nesting = $statements_checker->getRequireNesting() + 1;
|
|
|
|
echo (str_repeat(' ', $nesting) . 'checking ' . $file_name . PHP_EOL);
|
|
|
|
}
|
|
|
|
|
|
|
|
$include_file_checker = new \Psalm\Checker\FileChecker(
|
|
|
|
$current_file_checker->project_checker,
|
|
|
|
$path_to_file,
|
|
|
|
$file_name
|
|
|
|
);
|
|
|
|
|
|
|
|
$include_file_checker->setRootFilePath(
|
|
|
|
$current_file_checker->getRootFilePath(),
|
|
|
|
$current_file_checker->getRootFileName()
|
|
|
|
);
|
|
|
|
|
|
|
|
$include_file_checker->addParentFilePath($current_file_checker->getFilePath());
|
|
|
|
$include_file_checker->addRequiredFilePath($current_file_checker->getFilePath());
|
|
|
|
|
|
|
|
foreach ($current_file_checker->getRequiredFilePaths() as $required_file_path) {
|
|
|
|
$include_file_checker->addRequiredFilePath($required_file_path);
|
|
|
|
}
|
|
|
|
|
|
|
|
foreach ($current_file_checker->getParentFilePaths() as $parent_file_path) {
|
|
|
|
$include_file_checker->addParentFilePath($parent_file_path);
|
|
|
|
}
|
|
|
|
|
|
|
|
$include_file_checker->analyze(
|
|
|
|
$context,
|
|
|
|
false,
|
|
|
|
$global_context
|
|
|
|
);
|
|
|
|
|
|
|
|
foreach ($include_file_checker->getRequiredFilePaths() as $required_file_path) {
|
|
|
|
$current_file_checker->addRequiredFilePath($required_file_path);
|
2018-01-14 18:09:40 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
$source = $statements_checker->getSource();
|
|
|
|
|
|
|
|
if (IssueBuffer::accepts(
|
|
|
|
new MissingFile(
|
|
|
|
'Cannot find file ' . $path_to_file . ' to include',
|
|
|
|
new CodeLocation($source, $stmt)
|
|
|
|
),
|
|
|
|
$source->getSuppressedIssues()
|
|
|
|
)) {
|
|
|
|
// fall through
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
$source = $statements_checker->getSource();
|
|
|
|
|
|
|
|
if (IssueBuffer::accepts(
|
|
|
|
new UnresolvableInclude(
|
|
|
|
'Cannot resolve the given expression to a file path',
|
|
|
|
new CodeLocation($source, $stmt)
|
|
|
|
),
|
|
|
|
$source->getSuppressedIssues()
|
|
|
|
)) {
|
|
|
|
// fall through
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
$context->check_classes = false;
|
|
|
|
$context->check_variables = false;
|
|
|
|
$context->check_functions = false;
|
|
|
|
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param PhpParser\Node\Expr $stmt
|
|
|
|
* @param string $file_name
|
|
|
|
*
|
|
|
|
* @return string|null
|
|
|
|
* @psalm-suppress MixedAssignment
|
|
|
|
*/
|
|
|
|
public static function getPathTo(PhpParser\Node\Expr $stmt, $file_name)
|
|
|
|
{
|
2018-04-12 21:15:57 +02:00
|
|
|
if (DIRECTORY_SEPARATOR === '/') {
|
|
|
|
$is_path_relative = $file_name[0] !== DIRECTORY_SEPARATOR;
|
|
|
|
} else {
|
|
|
|
$is_path_relative = !preg_match('~^[A-Z]:\\\\~i', $file_name);
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($is_path_relative) {
|
2018-01-14 18:09:40 +01:00
|
|
|
$file_name = getcwd() . DIRECTORY_SEPARATOR . $file_name;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($stmt instanceof PhpParser\Node\Scalar\String_) {
|
|
|
|
return $stmt->value;
|
|
|
|
} elseif ($stmt instanceof PhpParser\Node\Expr\BinaryOp\Concat) {
|
|
|
|
$left_string = self::getPathTo($stmt->left, $file_name);
|
|
|
|
$right_string = self::getPathTo($stmt->right, $file_name);
|
|
|
|
|
|
|
|
if ($left_string && $right_string) {
|
|
|
|
return $left_string . $right_string;
|
|
|
|
}
|
|
|
|
} elseif ($stmt instanceof PhpParser\Node\Expr\FuncCall &&
|
|
|
|
$stmt->name instanceof PhpParser\Node\Name &&
|
|
|
|
$stmt->name->parts === ['dirname']
|
|
|
|
) {
|
|
|
|
if ($stmt->args) {
|
2018-07-22 02:22:42 +02:00
|
|
|
$dir_level = 1;
|
|
|
|
|
|
|
|
if (isset($stmt->args[1])) {
|
|
|
|
if ($stmt->args[1]->value instanceof PhpParser\Node\Scalar\LNumber) {
|
|
|
|
$dir_level = $stmt->args[1]->value->value;
|
|
|
|
} else {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-01-14 18:09:40 +01:00
|
|
|
$evaled_path = self::getPathTo($stmt->args[0]->value, $file_name);
|
|
|
|
|
|
|
|
if (!$evaled_path) {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
2018-07-22 02:22:42 +02:00
|
|
|
return dirname($evaled_path, $dir_level);
|
2018-01-14 18:09:40 +01:00
|
|
|
}
|
|
|
|
} elseif ($stmt instanceof PhpParser\Node\Expr\ConstFetch && $stmt->name instanceof PhpParser\Node\Name) {
|
|
|
|
$const_name = implode('', $stmt->name->parts);
|
|
|
|
|
|
|
|
if (defined($const_name)) {
|
|
|
|
$constant_value = constant($const_name);
|
|
|
|
|
|
|
|
if (is_string($constant_value)) {
|
|
|
|
return $constant_value;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
} elseif ($stmt instanceof PhpParser\Node\Scalar\MagicConst\Dir) {
|
|
|
|
return dirname($file_name);
|
|
|
|
} elseif ($stmt instanceof PhpParser\Node\Scalar\MagicConst\File) {
|
|
|
|
return $file_name;
|
|
|
|
}
|
|
|
|
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param string $file_name
|
|
|
|
* @param string $current_directory
|
|
|
|
*
|
|
|
|
* @return string|null
|
|
|
|
*/
|
|
|
|
public static function resolveIncludePath($file_name, $current_directory)
|
|
|
|
{
|
|
|
|
if (!$current_directory) {
|
|
|
|
return $file_name;
|
|
|
|
}
|
|
|
|
|
|
|
|
$paths = PATH_SEPARATOR == ':'
|
|
|
|
? preg_split('#(?<!phar):#', get_include_path())
|
|
|
|
: explode(PATH_SEPARATOR, get_include_path());
|
|
|
|
|
|
|
|
foreach ($paths as $prefix) {
|
|
|
|
$ds = substr($prefix, -1) == DIRECTORY_SEPARATOR ? '' : DIRECTORY_SEPARATOR;
|
|
|
|
|
|
|
|
if ($prefix === '.') {
|
|
|
|
$prefix = $current_directory;
|
|
|
|
}
|
|
|
|
|
|
|
|
$file = $prefix . $ds . $file_name;
|
|
|
|
|
|
|
|
if (file_exists($file)) {
|
|
|
|
return $file;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
}
|