1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-15 10:57:08 +01:00
psalm/src/Psalm/Config.php

992 lines
28 KiB
PHP
Raw Normal View History

2016-06-06 07:07:50 +02:00
<?php
2016-07-26 00:37:44 +02:00
namespace Psalm;
2016-06-06 07:07:50 +02:00
use Composer\Autoload\ClassLoader;
use Psalm\Checker\ClassLikeChecker;
use Psalm\Checker\ProjectChecker;
2016-12-30 02:07:42 +01:00
use Psalm\Config\IssueHandler;
use Psalm\Config\ProjectFileFilter;
2016-11-02 07:29:00 +01:00
use Psalm\Exception\ConfigException;
2018-01-21 18:44:46 +01:00
use Psalm\Scanner\FileScanner;
2016-06-10 00:08:25 +02:00
use SimpleXMLElement;
2016-06-06 07:07:50 +02:00
class Config
{
2016-07-26 00:39:36 +02:00
const DEFAULT_FILE_NAME = 'psalm.xml';
2016-06-25 00:18:11 +02:00
const REPORT_INFO = 'info';
const REPORT_ERROR = 'error';
2016-06-26 19:45:20 +02:00
const REPORT_SUPPRESS = 'suppress';
2016-06-25 00:18:11 +02:00
2016-11-02 07:29:00 +01:00
/**
* @var array<string>
*/
2016-06-27 21:10:13 +02:00
public static $ERROR_LEVELS = [
2016-06-25 00:18:11 +02:00
self::REPORT_INFO,
self::REPORT_ERROR,
2017-05-27 02:05:57 +02:00
self::REPORT_SUPPRESS,
2016-06-25 00:18:11 +02:00
];
/**
* @var array
*/
protected static $MIXED_ISSUES = [
'MixedArgument',
'MixedArrayAccess',
'MixedArrayAssignment',
'MixedArrayOffset',
'MixedAssignment',
'MixedInferredReturnType',
'MixedMethodCall',
'MixedOperand',
'MixedPropertyFetch',
'MixedPropertyAssignment',
'MixedReturnStatement',
2017-05-27 02:05:57 +02:00
'MixedStringOffsetAssignment',
'MixedTypeCoercion',
];
2016-11-02 07:29:00 +01:00
/**
* @var self|null
*/
private static $instance;
2016-06-10 00:08:25 +02:00
/**
* Whether or not to use types as defined in docblocks
2016-11-01 05:39:41 +01:00
*
2017-05-27 02:16:18 +02:00
* @var bool
*/
2016-08-24 06:22:38 +02:00
public $use_docblock_types = true;
2016-06-10 00:08:25 +02:00
/**
* Whether or not to use types as defined in property docblocks.
* This is distinct from the above because you may want to use
* property docblocks, but not function docblocks.
*
* @var bool
*/
public $use_docblock_property_types = true;
/**
* Whether or not to throw an exception on first error
2016-11-01 05:39:41 +01:00
*
2017-05-27 02:16:18 +02:00
* @var bool
*/
public $throw_exception = false;
/**
2016-11-04 22:45:12 +01:00
* The directory to store PHP Parser (and other) caches
*
* @var string
*/
public $cache_directory;
2016-11-04 22:45:12 +01:00
/**
* Whether or not to care about casing of file names
*
2017-05-27 02:16:18 +02:00
* @var bool
*/
public $use_case_sensitive_file_names = false;
2016-11-04 22:45:12 +01:00
/**
* Path to the autoader
2016-11-01 05:39:41 +01:00
*
* @var string|null
*/
public $autoloader;
2016-11-02 07:29:00 +01:00
/**
2016-12-30 02:07:42 +01:00
* @var ProjectFileFilter|null
2016-11-02 07:29:00 +01:00
*/
2017-07-25 23:04:58 +02:00
protected $project_files;
2016-06-10 00:08:25 +02:00
/**
* The base directory of this config file
2016-11-01 05:39:41 +01:00
*
* @var string
*/
2017-07-25 23:04:58 +02:00
protected $base_dir;
2016-06-06 07:07:50 +02:00
2016-11-02 07:29:00 +01:00
/**
* @var array<int, string>
*/
private $file_extensions = ['php'];
2016-11-02 07:29:00 +01:00
/**
* @var array<string, string>
2016-11-02 07:29:00 +01:00
*/
private $filetype_scanners = [];
/**
* @var array<string, string>
*/
private $filetype_checkers = [];
/**
* @var array<string, string>
*/
private $filetype_scanner_paths = [];
/**
* @var array<string, string>
*/
private $filetype_checker_paths = [];
2016-09-09 22:21:49 +02:00
/**
2016-12-30 02:07:42 +01:00
* @var array<string, IssueHandler>
2016-09-09 22:21:49 +02:00
*/
private $issue_handlers = [];
2016-11-02 07:29:00 +01:00
/**
* @var array<int, string>
*/
private $mock_classes = [];
2016-06-06 07:07:50 +02:00
2017-02-01 01:21:33 +01:00
/**
* @var array<int, string>
*/
private $stub_files = [];
2017-02-01 01:21:33 +01:00
/**
* @var bool
*/
public $cache_file_hashes_during_run = true;
2016-11-02 07:29:00 +01:00
/**
2017-05-27 02:16:18 +02:00
* @var bool
2016-11-02 07:29:00 +01:00
*/
public $hide_external_errors = true;
2016-12-07 00:27:22 +01:00
/** @var bool */
public $allow_includes = true;
/** @var bool */
public $totally_typed = false;
/** @var bool */
public $strict_binary_operands = false;
/** @var bool */
public $add_void_docblocks = true;
2017-01-28 21:17:14 +01:00
/**
* If true, assert() calls can be used to check types of variables
*
2017-05-27 02:16:18 +02:00
* @var bool
2017-01-28 21:17:14 +01:00
*/
public $use_assert_for_type = false;
/**
2017-05-27 02:16:18 +02:00
* @var bool
*/
public $remember_property_assignments_after_call = true;
/** @var bool */
public $use_igbinary = false;
/**
* @var bool
*/
public $allow_phpstorm_generics = false;
/**
* @var bool
*/
public $allow_coercion_from_string_to_class_const = true;
/**
* @var bool
*/
public $allow_string_standin_for_class = true;
2016-06-18 20:45:55 +02:00
/**
* @var string[]
*/
private $plugin_paths = [];
/**
* Static methods to be called after method checks have completed
*
* @var string[]
*/
public $after_method_checks = [];
/**
* Static methods to be called after expression checks have completed
2016-11-02 07:29:00 +01:00
*
* @var string[]
2016-06-18 20:45:55 +02:00
*/
public $after_expression_checks = [];
/**
* Static methods to be called after statement checks have completed
*
* @var string[]
*/
public $after_statement_checks = [];
/**
* Static methods to be called after classlike exists checks have completed
*
* @var string[]
*/
public $after_classlike_exists_checks = [];
/**
* Static methods to be called after classlikes have been scanned
*
* @var string[]
*/
public $after_visit_classlikes = [];
2016-06-18 20:45:55 +02:00
2016-11-21 03:49:06 +01:00
/** @var array<string, mixed> */
private $predefined_constants;
2016-11-21 03:49:06 +01:00
/** @var array<string, bool> */
private $predefined_functions = [];
/** @var ClassLoader|null */
private $composer_class_loader;
2016-12-14 18:28:38 +01:00
protected function __construct()
2016-06-06 07:07:50 +02:00
{
self::$instance = $this;
2016-06-06 07:07:50 +02:00
}
/**
* Gets a Config object from an XML file.
*
* Searches up a folder hierarchy for the most immediate config.
*
* @param string $path
* @param string $base_dir
* @param string $output_format
*
* @throws ConfigException if a config path is not found
*
* @return Config
*/
public static function getConfigForPath($path, $base_dir, $output_format)
{
$dir_path = realpath($path);
if ($dir_path === false) {
throw new ConfigException('Config not found for path ' . $path);
}
if (!is_dir($dir_path)) {
$dir_path = dirname($dir_path);
}
$config = null;
do {
$maybe_path = $dir_path . DIRECTORY_SEPARATOR . Config::DEFAULT_FILE_NAME;
if (file_exists($maybe_path)) {
$config = self::loadFromXMLFile($maybe_path, $base_dir);
break;
}
$dir_path = dirname($dir_path);
} while (dirname($dir_path) !== $dir_path);
if (!$config) {
if ($output_format === ProjectChecker::TYPE_CONSOLE) {
exit(
'Could not locate a config XML file in path ' . $path . '. Have you run \'psalm --init\' ?' .
PHP_EOL
);
}
throw new ConfigException('Config not found for path ' . $path);
}
return $config;
}
2016-06-26 19:45:20 +02:00
/**
* Creates a new config object from the file
2016-11-02 07:29:00 +01:00
*
2017-02-01 01:21:33 +01:00
* @param string $file_path
* @param string $base_dir
2017-05-27 02:16:18 +02:00
*
2016-12-29 16:24:10 +01:00
* @return self
*/
public static function loadFromXMLFile($file_path, $base_dir)
2016-12-29 16:24:10 +01:00
{
$file_contents = file_get_contents($file_path);
if ($file_contents === false) {
throw new \InvalidArgumentException('Cannot open ' . $file_path);
}
2018-01-28 18:43:19 +01:00
return self::loadFromXML($base_dir, $file_contents);
2016-12-29 16:24:10 +01:00
}
/**
* Creates a new config object from an XML string
*
* @param string $base_dir
2017-02-01 01:21:33 +01:00
* @param string $file_contents
2017-05-27 02:16:18 +02:00
*
2016-11-01 05:39:41 +01:00
* @return self
2016-11-05 02:14:04 +01:00
* @psalm-suppress MixedArgument
* @psalm-suppress MixedPropertyFetch
* @psalm-suppress MixedMethodCall
2016-12-17 06:48:31 +01:00
* @psalm-suppress MixedAssignment
2016-12-24 12:03:55 +01:00
* @psalm-suppress MixedOperand
* @psalm-suppress MixedPropertyAssignment
2016-06-26 19:45:20 +02:00
*/
2018-01-28 18:43:19 +01:00
public static function loadFromXML($base_dir, $file_contents)
2016-06-10 00:08:25 +02:00
{
2017-02-01 01:21:33 +01:00
$config = new static();
$config->base_dir = $base_dir;
$schema_path = dirname(dirname(__DIR__)) . '/config.xsd';
if (!file_exists($schema_path)) {
throw new ConfigException('Cannot locate config schema');
}
$dom_document = new \DOMDocument();
$dom_document->loadXML($file_contents);
// Enable user error handling
libxml_use_internal_errors(true);
if (!$dom_document->schemaValidate($schema_path)) {
$errors = libxml_get_errors();
foreach ($errors as $error) {
if ($error->level === LIBXML_ERR_FATAL || $error->level === LIBXML_ERR_ERROR) {
throw new ConfigException(
'Error parsing file ' . $error->file . ' on line ' . $error->line . ': ' . $error->message
);
}
}
libxml_clear_errors();
}
2016-06-10 00:08:25 +02:00
$config_xml = new SimpleXMLElement($file_contents);
2016-06-25 00:18:11 +02:00
if (isset($config_xml['useDocblockTypes'])) {
$attribute_text = (string) $config_xml['useDocblockTypes'];
$config->use_docblock_types = $attribute_text === 'true' || $attribute_text === '1';
2016-06-10 00:08:25 +02:00
}
if (isset($config_xml['useDocblockPropertyTypes'])) {
$attribute_text = (string) $config_xml['useDocblockPropertyTypes'];
$config->use_docblock_property_types = $attribute_text === 'true' || $attribute_text === '1';
}
if (isset($config_xml['throwExceptionOnError'])) {
$attribute_text = (string) $config_xml['throwExceptionOnError'];
$config->throw_exception = $attribute_text === 'true' || $attribute_text === '1';
}
if (isset($config_xml['hideExternalErrors'])) {
$attribute_text = (string) $config_xml['hideExternalErrors'];
$config->hide_external_errors = $attribute_text === 'true' || $attribute_text === '1';
}
if (isset($config_xml['autoloader'])) {
$config->autoloader = (string) $config_xml['autoloader'];
}
2016-11-04 22:45:12 +01:00
if (isset($config_xml['cacheDirectory'])) {
$config->cache_directory = (string)$config_xml['cacheDirectory'];
} else {
$config->cache_directory = sys_get_temp_dir() . '/psalm';
2016-11-04 22:45:12 +01:00
}
if (@mkdir($config->cache_directory, 0777, true) === false && is_dir($config->cache_directory) === false) {
trigger_error('Could not create cache directory: ' . $config->cache_directory, E_USER_ERROR);
}
if (isset($config_xml['allowFileIncludes'])) {
$attribute_text = (string) $config_xml['allowFileIncludes'];
$config->allow_includes = $attribute_text === 'true' || $attribute_text === '1';
}
if (isset($config_xml['totallyTyped'])) {
$attribute_text = (string) $config_xml['totallyTyped'];
$config->totally_typed = $attribute_text === 'true' || $attribute_text === '1';
}
if (isset($config_xml['strictBinaryOperands'])) {
$attribute_text = (string) $config_xml['strictBinaryOperands'];
$config->strict_binary_operands = $attribute_text === 'true' || $attribute_text === '1';
}
if (isset($config_xml['requireVoidReturnType'])) {
$attribute_text = (string) $config_xml['requireVoidReturnType'];
$config->add_void_docblocks = $attribute_text === 'true' || $attribute_text === '1';
}
2017-01-28 21:17:14 +01:00
if (isset($config_xml['useAssertForType'])) {
$attribute_text = (string) $config_xml['useAssertForType'];
$config->use_assert_for_type = $attribute_text === 'true' || $attribute_text === '1';
}
if (isset($config_xml['cacheFileContentHashes'])) {
$attribute_text = (string) $config_xml['cacheFileContentHashes'];
$config->cache_file_hashes_during_run = $attribute_text === 'true' || $attribute_text === '1';
}
if (isset($config_xml['rememberPropertyAssignmentsAfterCall'])) {
$attribute_text = (string) $config_xml['rememberPropertyAssignmentsAfterCall'];
$config->remember_property_assignments_after_call = $attribute_text === 'true' || $attribute_text === '1';
}
if (isset($config_xml['serializer'])) {
$attribute_text = (string) $config_xml['serializer'];
$config->use_igbinary = $attribute_text === 'igbinary';
} elseif ($igbinary_version = phpversion('igbinary')) {
$config->use_igbinary = version_compare($igbinary_version, '2.0.5') >= 0;
}
if (isset($config_xml['allowPhpStormGenerics'])) {
$attribute_text = (string) $config_xml['allowPhpStormGenerics'];
$config->allow_phpstorm_generics = $attribute_text === 'true' || $attribute_text === '1';
}
if (isset($config_xml['allowCoercionFromStringToClassConst'])) {
$attribute_text = (string) $config_xml['allowCoercionFromStringToClassConst'];
$config->allow_coercion_from_string_to_class_const = $attribute_text === 'true' || $attribute_text === '1';
}
if (isset($config_xml['allowStringToStandInForClass'])) {
$attribute_text = (string) $config_xml['allowCoercionFromStringToClassConst'];
$config->allow_string_standin_for_class = $attribute_text === 'true' || $attribute_text === '1';
}
2016-12-29 14:42:39 +01:00
if (isset($config_xml->projectFiles)) {
$config->project_files = ProjectFileFilter::loadFromXMLElement($config_xml->projectFiles, $base_dir, true);
2016-06-10 00:08:25 +02:00
}
if (isset($config_xml->fileExtensions)) {
$config->file_extensions = [];
$config->loadFileExtensions($config_xml->fileExtensions->extension);
}
if (isset($config_xml->mockClasses) && isset($config_xml->mockClasses->class)) {
/** @var \SimpleXMLElement $mock_class */
foreach ($config_xml->mockClasses->class as $mock_class) {
2017-06-13 06:51:16 +02:00
$config->mock_classes[] = (string)$mock_class['name'];
2016-06-10 00:08:25 +02:00
}
}
2017-02-01 01:21:33 +01:00
if (isset($config_xml->stubs) && isset($config_xml->stubs->file)) {
/** @var \SimpleXMLElement $stub_file */
foreach ($config_xml->stubs->file as $stub_file) {
$file_path = realpath($config->base_dir . DIRECTORY_SEPARATOR . $stub_file['name']);
2017-02-01 01:21:33 +01:00
if (!$file_path) {
throw new Exception\ConfigException(
'Cannot resolve stubfile path ' . $config->base_dir . DIRECTORY_SEPARATOR . $stub_file['name']
);
2017-02-01 01:21:33 +01:00
}
$config->stub_files[] = $file_path;
}
}
2016-06-18 20:45:55 +02:00
// this plugin loading system borrows heavily from etsy/phan
if (isset($config_xml->plugins) && isset($config_xml->plugins->plugin)) {
/** @var \SimpleXMLElement $plugin */
2016-06-18 20:45:55 +02:00
foreach ($config_xml->plugins->plugin as $plugin) {
$plugin_file_name = $plugin['filename'];
$path = $config->base_dir . $plugin_file_name;
$config->addPluginPath($path);
2016-06-18 20:45:55 +02:00
}
}
2016-12-30 02:07:42 +01:00
if (isset($config_xml->issueHandlers)) {
/** @var \SimpleXMLElement $issue_handler */
2016-12-30 02:07:42 +01:00
foreach ($config_xml->issueHandlers->children() as $key => $issue_handler) {
/** @var string $key */
$config->issue_handlers[$key] = IssueHandler::loadFromXMLElement($issue_handler, $base_dir);
2016-06-10 00:08:25 +02:00
}
}
2016-06-26 19:45:20 +02:00
2017-02-01 01:21:33 +01:00
if ($config->autoloader) {
/** @psalm-suppress UnresolvableInclude */
require_once($base_dir . DIRECTORY_SEPARATOR . $config->autoloader);
2017-02-01 01:21:33 +01:00
}
$config->collectPredefinedConstants();
$config->collectPredefinedFunctions();
2016-06-26 19:45:20 +02:00
return $config;
2016-06-10 00:08:25 +02:00
}
/**
* @return $this
*/
2016-06-06 07:07:50 +02:00
public static function getInstance()
{
if (self::$instance) {
return self::$instance;
2016-06-06 07:07:50 +02:00
}
throw new \UnexpectedValueException('No config initialized');
2016-06-06 07:07:50 +02:00
}
2018-03-03 21:25:35 +01:00
/**
* @return void
*/
public function setComposerClassLoader(ClassLoader $loader)
{
$this->composer_class_loader = $loader;
}
/**
* @param string $issue_key
* @param string $error_level
2017-05-27 02:16:18 +02:00
*
* @return void
*/
public function setCustomErrorLevel($issue_key, $error_level)
{
2016-12-30 02:07:42 +01:00
$this->issue_handlers[$issue_key] = new IssueHandler();
$this->issue_handlers[$issue_key]->setErrorLevel($error_level);
}
2016-10-30 17:46:18 +01:00
/**
* @param array<SimpleXMLElement> $extensions
2017-05-27 02:16:18 +02:00
*
* @throws ConfigException if a Config file could not be found
*
2016-10-30 17:46:18 +01:00
* @return void
*/
private function loadFileExtensions($extensions)
{
foreach ($extensions as $extension) {
2016-11-05 02:14:04 +01:00
$extension_name = preg_replace('/^\.?/', '', (string)$extension['name']);
$this->file_extensions[] = $extension_name;
if (isset($extension['scanner'])) {
$path = $this->base_dir . (string)$extension['scanner'];
if (!file_exists($path)) {
throw new Exception\ConfigException('Error parsing config: cannot find file ' . $path);
}
$this->filetype_scanner_paths[$extension_name] = $path;
}
if (isset($extension['checker'])) {
$path = $this->base_dir . (string)$extension['checker'];
if (!file_exists($path)) {
2016-06-20 07:05:44 +02:00
throw new Exception\ConfigException('Error parsing config: cannot find file ' . $path);
}
$this->filetype_checker_paths[$extension_name] = $path;
}
}
}
/**
* @param string $path
*
* @return void
*/
public function addPluginPath($path)
{
if (!file_exists($path)) {
throw new \InvalidArgumentException('Cannot find plugin file ' . $path);
}
$this->plugin_paths[] = $path;
}
/**
* Initialises all the plugins (done once the config is fully loaded)
2017-05-27 02:16:18 +02:00
*
* @return void
* @psalm-suppress MixedArrayAccess
* @psalm-suppress MixedAssignment
* @psalm-suppress MixedOperand
*/
public function initializePlugins(ProjectChecker $project_checker)
{
$codebase = $project_checker->codebase;
foreach ($this->filetype_scanner_paths as $extension => $path) {
$fq_class_name = $this->getPluginClassForPath($project_checker, $path, 'Psalm\\Scanner\\FileScanner');
$this->filetype_scanners[$extension] = $fq_class_name;
/** @psalm-suppress UnresolvableInclude */
require_once($path);
}
foreach ($this->filetype_checker_paths as $extension => $path) {
$fq_class_name = $this->getPluginClassForPath($project_checker, $path, 'Psalm\\Checker\\FileChecker');
$this->filetype_checkers[$extension] = $fq_class_name;
/** @psalm-suppress UnresolvableInclude */
require_once($path);
}
foreach ($this->plugin_paths as $path) {
$fq_class_name = $this->getPluginClassForPath($project_checker, $path, 'Psalm\\Plugin');
/** @psalm-suppress UnresolvableInclude */
require_once($path);
if ($codebase->methods->methodExists($fq_class_name . '::afterMethodCallCheck')) {
$this->after_method_checks[$fq_class_name] = $fq_class_name;
}
if ($codebase->methods->methodExists($fq_class_name . '::afterExpressionCheck')) {
$this->after_expression_checks[$fq_class_name] = $fq_class_name;
}
if ($codebase->methods->methodExists($fq_class_name . '::afterStatementCheck')) {
$this->after_statement_checks[$fq_class_name] = $fq_class_name;
}
if ($codebase->methods->methodExists($fq_class_name . '::afterClassLikeExistsCheck')) {
$this->after_classlike_exists_checks[$fq_class_name] = $fq_class_name;
}
if ($codebase->methods->methodExists($fq_class_name . '::afterVisitClassLike')) {
$this->after_visit_classlikes[$fq_class_name] = $fq_class_name;
}
}
}
/**
* @param string $path
* @param string $must_extend
*
* @return string
*/
private function getPluginClassForPath(ProjectChecker $project_checker, $path, $must_extend)
{
$codebase = $project_checker->codebase;
$file_storage = $codebase->createFileStorageForPath($path);
$file_to_scan = new FileScanner($path, $this->shortenFileName($path), true);
$file_to_scan->scan(
$codebase,
$file_storage
);
$declared_classes = ClassLikeChecker::getClassesForFile($project_checker, $path);
if (count($declared_classes) !== 1) {
throw new \InvalidArgumentException(
'Plugins must have exactly one class in the file - ' . $path . ' has ' .
count($declared_classes)
);
}
$fq_class_name = reset($declared_classes);
if (!$codebase->classExtends(
$fq_class_name,
$must_extend
)
) {
throw new \InvalidArgumentException(
'This plugin must extend ' . $must_extend . ' - ' . $path . ' does not'
);
}
return $fq_class_name;
}
2016-10-09 23:55:21 +02:00
/**
* @param string $file_name
2017-05-27 02:16:18 +02:00
*
2016-10-09 23:55:21 +02:00
* @return string
*/
public function shortenFileName($file_name)
{
2017-01-18 04:10:21 +01:00
return preg_replace('/^' . preg_quote($this->base_dir, DIRECTORY_SEPARATOR) . '/', '', $file_name);
}
2016-11-02 07:29:00 +01:00
/**
* @param string $issue_type
* @param string $file_path
2017-05-27 02:16:18 +02:00
*
2016-11-02 07:29:00 +01:00
* @return bool
*/
public function reportIssueInFile($issue_type, $file_path)
2016-06-10 00:08:25 +02:00
{
2017-05-27 02:05:57 +02:00
if (!$this->totally_typed && in_array($issue_type, self::$MIXED_ISSUES, true)) {
return false;
}
if ($this->hide_external_errors) {
$codebase = ProjectChecker::getInstance()->codebase;
2018-02-04 00:52:35 +01:00
if (!$codebase->analyzer->canReportIssues($file_path)) {
return false;
2016-08-05 21:11:20 +02:00
}
}
if ($this->getReportingLevelForFile($issue_type, $file_path) === self::REPORT_SUPPRESS) {
return false;
}
2016-06-10 00:08:25 +02:00
return true;
2016-06-10 00:08:25 +02:00
}
2016-11-02 07:29:00 +01:00
/**
* @param string $file_path
2017-05-27 02:16:18 +02:00
*
2016-11-02 07:29:00 +01:00
* @return bool
*/
public function isInProjectDirs($file_path)
{
return $this->project_files && $this->project_files->allows($file_path);
}
2016-11-02 07:29:00 +01:00
/**
* @param string $issue_type
* @param string $file_path
2017-05-27 02:16:18 +02:00
*
2016-11-02 07:29:00 +01:00
* @return string
*/
public function getReportingLevelForFile($issue_type, $file_path)
{
2016-12-30 02:07:42 +01:00
if (isset($this->issue_handlers[$issue_type])) {
return $this->issue_handlers[$issue_type]->getReportingLevelForFile($file_path);
}
return self::REPORT_ERROR;
}
2016-10-15 06:12:57 +02:00
/**
* @return array<string>
*/
2016-12-29 16:24:10 +01:00
public function getProjectDirectories()
2016-06-10 00:08:25 +02:00
{
2016-12-29 14:42:39 +01:00
if (!$this->project_files) {
2016-08-07 02:27:13 +02:00
return [];
}
2016-12-29 16:24:10 +01:00
return $this->project_files->getDirectories();
2016-06-13 21:33:18 +02:00
}
2016-06-10 00:08:25 +02:00
2016-10-15 06:12:57 +02:00
/**
* @return array<string>
*/
2016-06-13 21:33:18 +02:00
public function getFileExtensions()
{
return $this->file_extensions;
2016-06-10 00:08:25 +02:00
}
2016-11-02 07:29:00 +01:00
/**
* @return array<string, string>
2016-11-02 07:29:00 +01:00
*/
public function getFiletypeScanners()
{
return $this->filetype_scanners;
}
/**
* @return array<string, string>
*/
public function getFiletypeCheckers()
{
return $this->filetype_checkers;
}
2016-10-09 23:55:21 +02:00
/**
2016-11-01 05:39:41 +01:00
* @return array<int, string>
2016-10-09 23:55:21 +02:00
*/
public function getMockClasses()
{
return $this->mock_classes;
}
2016-06-18 20:45:55 +02:00
2017-02-01 01:21:33 +01:00
/**
* @return void
*/
public function visitStubFiles(Codebase $codebase)
2017-02-01 01:21:33 +01:00
{
$codebase->register_global_functions = true;
// note: don't realpath $generic_stubs_path, or phar version will fail
$generic_stubs_path = __DIR__ . '/Stubs/CoreGenericFunctions.php';
if (!file_exists($generic_stubs_path)) {
throw new \UnexpectedValueException('Cannot locate core generic stubs');
}
// note: don't realpath $generic_classes_path, or phar version will fail
2018-03-09 00:01:12 +01:00
$generic_classes_path = __DIR__ . '/Stubs/CoreGenericClasses.php';
2018-02-01 05:27:25 +01:00
if (!file_exists($generic_classes_path)) {
2018-02-01 05:27:25 +01:00
throw new \UnexpectedValueException('Cannot locate core generic classes');
}
$stub_files = array_merge([$generic_stubs_path, $generic_classes_path], $this->stub_files);
foreach ($stub_files as $stub_file_path) {
$file_storage = $codebase->createFileStorageForPath($stub_file_path);
2018-01-21 18:44:46 +01:00
$file_to_scan = new FileScanner($stub_file_path, $this->shortenFileName($stub_file_path), false);
$file_to_scan->scan(
$codebase,
2018-01-21 18:44:46 +01:00
$file_storage
);
2017-02-01 01:21:33 +01:00
}
$codebase->register_global_functions = false;
2017-02-01 01:21:33 +01:00
}
2016-11-04 22:45:12 +01:00
/**
2016-11-05 02:14:04 +01:00
* @return string
2016-11-04 22:45:12 +01:00
*/
public function getCacheDirectory()
{
return $this->cache_directory;
}
2016-11-21 05:45:10 +01:00
/**
* @return array<string, mixed>
*/
2016-11-21 03:49:06 +01:00
public function getPredefinedConstants()
{
return $this->predefined_constants;
}
2016-11-21 05:45:10 +01:00
/**
* @return void
* @psalm-suppress MixedTypeCoercion
2016-11-21 05:45:10 +01:00
*/
2016-11-21 03:49:06 +01:00
public function collectPredefinedConstants()
{
$this->predefined_constants = get_defined_constants();
}
/**
* @return array<string, bool>
*/
public function getPredefinedFunctions()
{
return $this->predefined_functions;
}
/**
* @return void
* @psalm-suppress InvalidPropertyAssignment
* @psalm-suppress MixedAssignment
* @psalm-suppress MixedArrayOffset
*/
public function collectPredefinedFunctions()
{
$defined_functions = get_defined_functions();
if (isset($defined_functions['user'])) {
foreach ($defined_functions['user'] as $function_name) {
$this->predefined_functions[$function_name] = true;
}
}
if (isset($defined_functions['internal'])) {
foreach ($defined_functions['internal'] as $function_name) {
$this->predefined_functions[$function_name] = true;
}
}
}
/**
* @return void
*
* @psalm-suppress MixedAssignment
* @psalm-suppress MixedArrayAccess
*/
public function visitComposerAutoloadFiles(ProjectChecker $project_checker)
{
$composer_json_path = $this->base_dir . 'composer.json'; // this should ideally not be hardcoded
if (!file_exists($composer_json_path)) {
return;
}
/** @psalm-suppress PossiblyFalseArgument */
if (!$composer_json = json_decode(file_get_contents($composer_json_path), true)) {
throw new \UnexpectedValueException('Invalid composer.json at ' . $composer_json_path);
}
if (isset($composer_json['autoload']['files'])) {
$codebase = $project_checker->codebase;
$codebase->register_global_functions = true;
/** @var string[] */
$files = $composer_json['autoload']['files'];
foreach ($files as $file) {
$file_path = realpath($this->base_dir . $file);
if (!$file_path) {
continue;
}
$file_storage = $codebase->createFileStorageForPath($file_path);
$file_to_scan = new \Psalm\Scanner\FileScanner($file_path, $this->shortenFileName($file_path), false);
2018-01-21 18:44:46 +01:00
$file_to_scan->scan(
$codebase,
2018-01-21 18:44:46 +01:00
$file_storage
);
}
$project_checker->codebase->register_global_functions = false;
}
}
/**
* @param string $fq_classlike_name
2018-02-22 00:59:31 +01:00
*
* @return string|false
*/
public function getComposerFilePathForClassLike($fq_classlike_name)
{
if (!$this->composer_class_loader) {
return false;
}
return $this->composer_class_loader->findFile($fq_classlike_name);
}
/**
* @param string $dir
*
* @return void
*/
public static function removeCacheDirectory($dir)
{
if (is_dir($dir)) {
$objects = scandir($dir);
if ($objects === false) {
throw new \UnexpectedValueException('Not expecting false here');
}
foreach ($objects as $object) {
if ($object != '.' && $object != '..') {
if (filetype($dir . '/' . $object) == 'dir') {
self::removeCacheDirectory($dir . '/' . $object);
} else {
unlink($dir . '/' . $object);
}
}
}
reset($objects);
rmdir($dir);
}
}
2016-06-06 07:07:50 +02:00
}