Your IP : 216.73.216.43
<?php
/**
* This file is part of PHP Mess Detector.
*
* Copyright (c) Manuel Pichler <mapi@phpmd.org>.
* All rights reserved.
*
* Licensed under BSD License
* For full copyright and license information, please see the LICENSE file.
* Redistributions of files must retain the above copyright notice.
*
* @author Lukas Bestle <project-phpmd@lukasbestle.com>
* @copyright Manuel Pichler. All rights reserved.
* @license https://opensource.org/licenses/bsd-license.php BSD License
* @link http://phpmd.org/
*/
namespace PHPMD\Renderer;
use PHPMD\PHPMD;
use PHPMD\Report;
use PHPMD\Renderer\JSONRenderer;
/**
* This class will render a SARIF (Static Analysis
* Results Interchange Format) report.
*/
class SARIFRenderer extends JSONRenderer
{
/**
* Create report data and add renderer meta properties
*
* @return array
*/
protected function initReportData()
{
$data = array(
'version' => '2.1.0',
'$schema' =>
'https://raw.githubusercontent.com/oasis-tcs/' .
'sarif-spec/master/Schemata/sarif-schema-2.1.0.json',
'runs' => array(
array(
'tool' => array(
'driver' => array(
'name' => 'PHPMD',
'informationUri' => 'https://phpmd.org',
'version' => PHPMD::VERSION,
'rules' => array(),
),
),
'originalUriBaseIds' => array(
'WORKINGDIR' => array(
'uri' => static::pathToUri(getcwd()) . '/',
),
),
'results' => array(),
),
),
);
return $data;
}
/**
* Add violations, if any, to the report data
*
* @param Report $report The report with potential violations.
* @param array $data The report output to add the violations to.
* @return array The report output with violations, if any.
*/
protected function addViolationsToReport(Report $report, array $data)
{
$rules = array();
$results = array();
$ruleIndices = array();
/** @var RuleViolation $violation */
foreach ($report->getRuleViolations() as $violation) {
$rule = $violation->getRule();
$ruleRef = str_replace(' ', '', $rule->getRuleSetName()) . '/' . $rule->getName();
if (!isset($ruleIndices[$ruleRef])) {
$ruleIndices[$ruleRef] = count($rules);
$ruleData = array(
'id' => $ruleRef,
'name' => $rule->getName(),
'shortDescription' => array(
'text' => $rule->getRuleSetName() . ': ' . $rule->getName(),
),
'messageStrings' => array(
'default' => array(
'text' => trim($rule->getMessage()),
),
),
'help' => array(
'text' => trim(str_replace("\n", ' ', $rule->getDescription())),
),
'helpUri' => $rule->getExternalInfoUrl(),
'properties' => array(
'ruleSet' => $rule->getRuleSetName(),
'priority' => $rule->getPriority(),
),
);
$examples = $rule->getExamples();
if (!empty($examples)) {
$ruleData['help']['markdown'] =
$ruleData['help']['text'] .
"\n\n### Example\n\n```php\n" .
implode("\n```\n\n```php\n", array_map('trim', $examples)) . "\n```";
}
$since = $rule->getSince();
if ($since) {
$ruleData['properties']['since'] = 'PHPMD ' . $since;
}
$rules[] = $ruleData;
}
$arguments = $violation->getArgs();
if ($arguments === null) {
$arguments = array();
}
$results[] = array(
'ruleId' => $ruleRef,
'ruleIndex' => $ruleIndices[$ruleRef],
'message' => array(
'id' => 'default',
'arguments' => array_map('strval', $arguments),
'text' => $violation->getDescription(),
),
'locations' => array(
array(
'physicalLocation' => array(
'artifactLocation' => static::pathToArtifactLocation($violation->getFileName()),
'region' => array(
'startLine' => $violation->getBeginLine(),
'endLine' => $violation->getEndLine(),
),
),
)
),
);
}
$data['runs'][0]['tool']['driver']['rules'] = $rules;
$data['runs'][0]['results'] = array_merge($data['runs'][0]['results'], $results);
return $data;
}
/**
* Add errors, if any, to the report data
*
* @param Report $report The report with potential errors.
* @param array $data The report output to add the errors to.
* @return array The report output with errors, if any.
*/
protected function addErrorsToReport(Report $report, array $data)
{
$errors = $report->getErrors();
if ($errors) {
foreach ($errors as $error) {
$data['runs'][0]['results'][] = array(
'level' => 'error',
'message' => array(
'text' => $error->getMessage(),
),
'locations' => array(
array(
'physicalLocation' => array(
'artifactLocation' => static::pathToArtifactLocation($error->getFile()),
),
)
),
);
}
}
return $data;
}
/**
* Makes an absolute path relative to the working directory
* if possible, otherwise prepends the `file://` protocol
* and returns the result as a SARIF `artifactLocation`
*
* @param string $path
* @return array
*/
protected static function pathToArtifactLocation($path)
{
$workingDir = getcwd();
if (substr($path, 0, strlen($workingDir)) === $workingDir) {
// relative path
return array(
'uri' => substr($path, strlen($workingDir) + 1),
'uriBaseId' => 'WORKINGDIR',
);
}
// absolute path with protocol
return array(
'uri' => static::pathToUri($path),
);
}
/**
* Converts an absolute path to a file:// URI
*
* @param string $path
* @return string
*/
protected static function pathToUri($path)
{
$path = str_replace(DIRECTORY_SEPARATOR, '/', $path);
// file:///C:/... on Windows systems
if (substr($path, 0, 1) !== '/') {
$path = '/' . $path;
}
return 'file://' . $path;
}
}