Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/magento/magento-coding-standard/Magento2/Sniffs/Html/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento2\Sniffs\Html;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
/**
* Sniff for invalid directive usage in HTML templates
*/
class HtmlDirectiveSniff implements Sniff
{
private const CONSTRUCTION_DEPEND_PATTERN = '/{{depend\s*(.*?)}}(.*?){{\\/depend\s*}}/si';
private const CONSTRUCTION_IF_PATTERN = '/{{if\s*(.*?)}}(.*?)({{else}}(.*?))?{{\\/if\s*}}/si';
private const LOOP_PATTERN = '/{{for(?P<loopItem>.*? )(in)(?P<loopData>.*?)}}(?P<loopBody>.*?){{\/for}}/si';
private const CONSTRUCTION_PATTERN = '/{{([a-z]{0,10})(.*?)}}(?:(.*?)(?:{{\/(?:\\1)}}))?/si';
/**
* @var array
*/
private $usedVariables = [];
/**
* @var array
*/
private $unfilteredVariables = [];
/**
* @inheritDoc
*/
public function register()
{
return [T_INLINE_HTML];
}
/**
* Detect invalid usage of template filter directives
*
* @param File $phpcsFile
* @param int $stackPtr
* @return int|void
*/
public function process(File $phpcsFile, $stackPtr)
{
$this->usedVariables = [];
$this->unfilteredVariables = [];
if ($stackPtr !== 0) {
return;
}
$html = $phpcsFile->getTokensAsString($stackPtr, count($phpcsFile->getTokens()));
if (empty($html)) {
return;
}
$html = $this->processIfDirectives($html, $phpcsFile);
$html = $this->processDependDirectives($html, $phpcsFile);
$html = $this->processForDirectives($html, $phpcsFile);
$html = $this->processVarDirectivesAndParams($html, $phpcsFile);
$this->validateDefinedVariables($phpcsFile, $html);
}
/**
* Process the {{if}} directives in the file
*
* @param string $html
* @param File $phpcsFile
* @return string The processed template
*/
private function processIfDirectives(string $html, File $phpcsFile): string
{
if (preg_match_all(self::CONSTRUCTION_IF_PATTERN, $html, $constructions, PREG_SET_ORDER)) {
foreach ($constructions as $construction) {
// validate {{if <var>}}
$this->validateVariableUsage($phpcsFile, $construction[1]);
$html = str_replace($construction[0], $construction[2] . ($construction[4] ?? ''), $html);
}
}
return $html;
}
/**
* Process the {{depend}} directives in the file
*
* @param string $html
* @param File $phpcsFile
* @return string The processed template
*/
private function processDependDirectives(string $html, File $phpcsFile): string
{
if (preg_match_all(self::CONSTRUCTION_DEPEND_PATTERN, $html, $constructions, PREG_SET_ORDER)) {
foreach ($constructions as $construction) {
// validate {{depend <var>}}
$this->validateVariableUsage($phpcsFile, $construction[1]);
$html = str_replace($construction[0], $construction[2], $html);
}
}
return $html;
}
/**
* Process the {{for}} directives in the file
*
* @param string $html
* @param File $phpcsFile
* @return string The processed template
*/
private function processForDirectives(string $html, File $phpcsFile): string
{
if (preg_match_all(self::LOOP_PATTERN, $html, $constructions, PREG_SET_ORDER)) {
foreach ($constructions as $construction) {
// validate {{for in <var>}}
$this->validateVariableUsage($phpcsFile, $construction['loopData']);
$html = str_replace($construction[0], $construction['loopBody'], $html);
}
}
return $html;
}
/**
* Process the all var directives and var directive params in the file
*
* @param string $html
* @param File $phpcsFile
* @return string The processed template
*/
private function processVarDirectivesAndParams(string $html, File $phpcsFile): string
{
if (preg_match_all(self::CONSTRUCTION_PATTERN, $html, $constructions, PREG_SET_ORDER)) {
foreach ($constructions as $construction) {
if (empty($construction[2])) {
continue;
}
if ($construction[1] === 'var') {
$this->validateVariableUsage($phpcsFile, $construction[2]);
} else {
$this->validateDirectiveBody($phpcsFile, $construction[2]);
}
}
}
return $html;
}
/**
* Validate directive body is valid. e.g. {{somedir <directive body>}}
*
* @param File $phpcsFile
* @param string $body
*/
private function validateDirectiveBody(File $phpcsFile, string $body): void
{
$parameterTokenizer = new \Magento2\Helpers\Tokenizer\Parameter();
$parameterTokenizer->setString($body);
$params = $parameterTokenizer->tokenize();
foreach ($params as $param) {
if (substr($param, 0, 1) === '$') {
$this->validateVariableUsage($phpcsFile, substr($param, 1));
}
}
}
/**
* Validate directive variable usage is valid. e.g. {{var <variable body>}} or {{somedir some_param="$foo.bar()"}}
*
* @param File $phpcsFile
* @param string $body
*/
private function validateVariableUsage(File $phpcsFile, string $body): void
{
$this->usedVariables[] = 'var ' . trim($body);
if (strpos($body, '|') !== false) {
$this->unfilteredVariables[] = 'var ' . trim(explode('|', $body, 2)[0]);
}
$variableTokenizer = new \Magento2\Helpers\Tokenizer\Variable();
$variableTokenizer->setString($body);
$stack = $variableTokenizer->tokenize();
if (empty($stack)) {
return;
}
foreach ($stack as $token) {
// As a static analyzer there are no data types to know if this is a DataObject so allow all get* methods
if ($token['type'] === 'method' && substr($token['name'], 0, 3) !== 'get') {
$phpcsFile->addError(
'Template directives may not invoke methods. Only scalar array access is allowed.' . PHP_EOL
. 'Found "' . trim($body) . '"',
null,
'HtmlTemplatesProhibitedMethodCall'
);
}
}
}
/**
* Validate the variables defined in the template comment block match the variables actually used in the template
*
* @param File $phpcsFile
* @param string $templateText
*/
private function validateDefinedVariables(File $phpcsFile, string $templateText): void
{
preg_match('/<!--@vars\s*((?:.)*?)\s*@-->/us', $templateText, $matches);
$definedVariables = [];
if (!empty($matches[1])) {
$definedVariables = json_decode(str_replace("\n", '', $matches[1]), true);
if (json_last_error()) {
$phpcsFile->addError(
'Template @vars comment block contains invalid JSON.',
null,
'HtmlTemplatesInvalidVarsJSON'
);
return;
}
foreach ($definedVariables as $var => $label) {
if (empty($label)) {
$phpcsFile->addError(
'Template @vars comment block contains invalid label.' . PHP_EOL
. 'Label for variable "' . $var . '" is empty.',
null,
'HtmlTemplatesInvalidVariableLabel'
);
}
}
$definedVariables = array_keys($definedVariables);
foreach ($definedVariables as $definedVariable) {
if (strpos($definedVariable, '|') !== false) {
$definedVariables[] = trim(explode('|', $definedVariable, 2)[0]);
}
}
}
$undefinedVariables = array_diff($this->usedVariables, $definedVariables, $this->unfilteredVariables);
foreach ($undefinedVariables as $undefinedVariable) {
$phpcsFile->addError(
'Template @vars comment block is missing a variable used in the template.' . PHP_EOL
. 'Missing variable: ' . $undefinedVariable,
null,
'HtmlTemplatesUndefinedVariable'
);
}
}
}