1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-14 02:07:37 +01:00
psalm/src/Psalm/IssueBuffer.php

207 lines
5.5 KiB
PHP
Raw Normal View History

<?php
2016-07-26 00:37:44 +02:00
namespace Psalm;
use Psalm\Checker\ProjectChecker;
2016-06-26 21:18:40 +02:00
class IssueBuffer
{
2016-12-08 04:38:57 +01:00
/**
* @var array<int, array>
*/
protected static $issue_data = [];
2016-11-02 07:29:00 +01:00
/**
* @var array<int, string>
*/
protected static $errors = [];
2016-11-01 05:39:41 +01:00
2016-11-02 07:29:00 +01:00
/**
* @var array<string, bool>
*/
2016-10-19 00:55:53 +02:00
protected static $emitted = [];
2016-11-02 07:29:00 +01:00
/**
* @param Issue\CodeIssue $e
* @param array $suppressed_issues
* @return bool
*/
public static function accepts(Issue\CodeIssue $e, array $suppressed_issues = [])
{
2016-06-10 00:08:25 +02:00
$config = Config::getInstance();
$fqcn_parts = explode('\\', get_class($e));
$issue_type = array_pop($fqcn_parts);
if (in_array($issue_type, $suppressed_issues)) {
return false;
}
if ($config->excludeIssueInFile($issue_type, $e->getFileName())) {
2016-06-10 00:08:25 +02:00
return false;
}
2016-08-08 20:36:18 +02:00
return self::add($e);
}
2016-11-02 07:29:00 +01:00
/**
* @param Issue\CodeIssue $e
* @return bool
* @throws Exception\CodeException
*/
public static function add(Issue\CodeIssue $e)
{
$config = Config::getInstance();
2016-12-08 04:38:57 +01:00
$project_checker = ProjectChecker::getInstance();
$fqcn_parts = explode('\\', get_class($e));
$issue_type = array_pop($fqcn_parts);
2016-06-17 23:34:52 +02:00
2016-12-08 04:38:57 +01:00
$error_message = $issue_type . ' - ' . $e->getShortLocation() . ' - ' . $e->getMessage();
$reporting_level = $config->getReportingLevel($issue_type);
2016-06-27 04:03:37 +02:00
if ($reporting_level === Config::REPORT_SUPPRESS) {
return false;
}
if ($reporting_level === Config::REPORT_INFO) {
2016-12-08 04:38:57 +01:00
if ($project_checker->show_info && !self::alreadyEmitted($error_message)) {
switch ($project_checker->output_format) {
case ProjectChecker::TYPE_CONSOLE:
echo 'INFO: ' . $error_message . PHP_EOL;
break;
case ProjectChecker::TYPE_JSON:
self::$issue_data[] = self::getIssueArray($e, Config::REPORT_INFO);
break;
}
}
return false;
}
if ($config->throw_exception) {
throw new Exception\CodeException($error_message);
}
2016-10-19 00:55:53 +02:00
if (!self::alreadyEmitted($error_message)) {
2016-12-08 04:38:57 +01:00
switch ($project_checker->output_format) {
case ProjectChecker::TYPE_CONSOLE:
echo ($project_checker->use_color ? "\e[0;31mERROR\e[0m" : 'ERROR') .
': ' . $error_message . PHP_EOL;
echo self::getSnippet($e, $project_checker->use_color) . PHP_EOL . PHP_EOL;
2016-12-08 04:38:57 +01:00
break;
case ProjectChecker::TYPE_JSON:
self::$issue_data[] = self::getIssueArray($e);
break;
}
2016-10-19 00:55:53 +02:00
}
2016-06-17 01:02:29 +02:00
if ($config->stop_on_first_error) {
exit(1);
}
self::$errors[] = $error_message;
2016-08-08 20:36:18 +02:00
return true;
}
2016-12-08 04:38:57 +01:00
/**
* @param Issue\CodeIssue $e
* @param string $severity
* @return array
*/
protected static function getIssueArray(Issue\CodeIssue $e, $severity = Config::REPORT_ERROR)
{
$location = $e->getLocation();
$selection_bounds = $location->getSelectionBounds();
return [
'type' => $severity,
'line_number' => $location->getLineNumber(),
'message' => $e->getMessage(),
'file_name' => $location->file_name,
'file_path' => $location->file_path,
'snippet' => $location->getSnippet(),
'from' => $selection_bounds[0],
'to' => $selection_bounds[1],
];
}
/**
* @return array<int, array>
*/
public static function getIssueData()
{
return self::$issue_data;
}
/**
* @param Issue\CodeIssue $e
* @param boolean $use_color
* @return string
*/
protected static function getSnippet(Issue\CodeIssue $e, $use_color = true)
{
$location = $e->getLocation();
$snippet = $location->getSnippet();
if (!$use_color) {
return $snippet;
}
$snippet_bounds = $location->getSnippetBounds();
$selection_bounds = $location->getSelectionBounds();
$selection_start = $selection_bounds[0] - $snippet_bounds[0];
$selection_length = $selection_bounds[1] - $selection_bounds[0] + 1;
return substr($snippet, 0, $selection_start) .
"\e[97;41m" . substr($snippet, $selection_start, $selection_length) .
"\e[0m" . substr($snippet, $selection_length + $selection_start) . PHP_EOL;
}
2016-11-02 07:29:00 +01:00
/**
* @param bool $is_full
* @param int|null $start_time
2016-11-02 07:29:00 +01:00
* @return void
*/
public static function finish($is_full = false, $start_time = null)
{
Checker\FileChecker::updateReferenceCache();
if (count(self::$errors)) {
2016-12-08 04:38:57 +01:00
$project_checker = ProjectChecker::getInstance();
if ($project_checker->output_format === ProjectChecker::TYPE_JSON) {
echo json_encode(self::$issue_data) . PHP_EOL;
}
exit(1);
}
2016-10-07 06:58:08 +02:00
if ($is_full && $start_time) {
Checker\FileChecker::goodRun($start_time);
2016-10-07 06:58:08 +02:00
}
}
2016-10-19 00:55:53 +02:00
2016-10-30 17:46:18 +01:00
/**
* @param string $message
* @return bool
*/
2016-10-19 00:55:53 +02:00
protected static function alreadyEmitted($message)
{
$sham = sha1($message);
if (isset(self::$emitted[$sham])) {
return true;
}
self::$emitted[$sham] = true;
return false;
}
}