1
0
mirror of https://github.com/danog/psalm.git synced 2025-01-22 13:51:54 +01:00

Escape GHA output

Refs Roave/BackwardCompatibilityCheck#342

Thanks @staabm for highlighting this issue.
This commit is contained in:
Bruce Weirdan 2021-11-29 04:47:47 +02:00
parent f1d47cc662
commit 99d3d5e811
No known key found for this signature in database
GPG Key ID: CFC3AAB181751B0D

View File

@ -5,6 +5,7 @@ use Psalm\Config;
use Psalm\Report;
use function sprintf;
use function strtr;
class GithubActionsReport extends Report
{
@ -13,17 +14,58 @@ class GithubActionsReport extends Report
$output = '';
foreach ($this->issues_data as $issue_data) {
$issue_reference = $issue_data->link ? ' (see ' . $issue_data->link . ')' : '';
$output .= sprintf(
'::%1$s file=%2$s,line=%3$s,col=%4$s,title=%5$s::%2$s:%3$s:%4$s: %5$s: %6$s',
($issue_data->severity === Config::REPORT_ERROR ? 'error' : 'warning'),
$properties = sprintf(
'file=%1$s,line=%2$d,col=%3$d,title=%4$s',
$this->escapeProperty($issue_data->file_name),
$this->escapeProperty($issue_data->line_from),
$this->escapeProperty($issue_data->column_from),
$this->escapeProperty($issue_data->type)
);
$data = $this->escapeData(sprintf(
'%1$s:%2$d:%3$d: %4$s: %5$s',
$issue_data->file_name,
$issue_data->line_from,
$issue_data->column_from,
$issue_data->type,
$issue_data->message . $issue_reference
));
$output .= sprintf(
'::%1$s %2$s::%3$s',
($issue_data->severity === Config::REPORT_ERROR ? 'error' : 'warning'),
$properties,
$data
) . "\n";
}
return $output;
}
private function escapeData(string $data): string
{
return strtr(
$data,
[
'%' => '%25',
"\r" => '%0D',
"\n" => '%0A',
]
);
}
/** @param mixed $value */
private function escapeProperty($value): string
{
return strtr(
(string) $value,
[
'%' => '%25',
"\r" => '%0D',
"\n" => '%0A',
':' => '%3A',
',' => '%2C',
]
);
}
}