Escape::getInterceptionPoints() - Code Metrics - Inspection of "[WIP] Sequencer to replace regular expressions" - TYPO3/Fluid - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#457)

by Claus

created 2019-06-21 08:22 UTC

Escape::getInterceptionPoints() A

↳ Parent: Escape

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	9
rs	9.9666
c	0
b	0
f	0

<?php
namespace TYPO3Fluid\Fluid\Core\Parser\Interceptor;

/*
 * This file belongs to the package "TYPO3 Fluid".
 * See LICENSE.txt that was shipped with this package.
 */

use TYPO3Fluid\Fluid\Core\Parser\InterceptorInterface;
use TYPO3Fluid\Fluid\Core\Parser\ParsingState;
use TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\EscapingNode;
use TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\Expression\ExpressionNodeInterface;
use TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\NodeInterface;
use TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\ObjectAccessorNode;
use TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\ViewHelperNode;

/**
 * An interceptor adding the "Htmlspecialchars" viewhelper to the suitable places.
 */
class Escape implements InterceptorInterface
{

    /**
     * Is the interceptor enabled right now for child nodes?
     *
     * @var boolean
     */
    protected $childrenEscapingEnabled = true;

    /**
     * A stack of ViewHelperNodes which currently disable the interceptor.
     * Needed to enable the interceptor again.
     *
     * @var NodeInterface[]
     */
    protected $viewHelperNodesWhichDisableTheInterceptor = [];

    /**
     * Adds a ViewHelper node using the Format\HtmlspecialcharsViewHelper to the given node.
     * If "escapingInterceptorEnabled" in the ViewHelper is FALSE, will disable itself inside the ViewHelpers body.
     *
     * @param NodeInterface $node
     * @param integer $interceptorPosition One of the INTERCEPT_* constants for the current interception point
     * @param ParsingState $parsingState the current parsing state. Not needed in this interceptor.
     * @return NodeInterface
     */
    public function process(NodeInterface $node, $interceptorPosition, ParsingState $parsingState)
    {
        $viewHelper = $node instanceof ViewHelperNode ? $node->getUninitializedViewHelper() : $node;
        if ($interceptorPosition === InterceptorInterface::INTERCEPT_OPENING_VIEWHELPER) {
            /** @var ViewHelperNode $node */
            if (!$viewHelper->isChildrenEscapingEnabled()) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                $this->childrenEscapingEnabled = false;
                $this->viewHelperNodesWhichDisableTheInterceptor[] = $node;
            }
        } elseif ($interceptorPosition === InterceptorInterface::INTERCEPT_CLOSING_VIEWHELPER) {
            if (end($this->viewHelperNodesWhichDisableTheInterceptor) === $node) {
                array_pop($this->viewHelperNodesWhichDisableTheInterceptor);
                if (count($this->viewHelperNodesWhichDisableTheInterceptor) === 0) {
                    $this->childrenEscapingEnabled = true;
                }
            }
            /** @var ViewHelperNode $node */
            if ($this->childrenEscapingEnabled && $viewHelper->isOutputEscapingEnabled()) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                $node = new EscapingNode($node);
            }
        } elseif ($this->childrenEscapingEnabled && ($node instanceof ObjectAccessorNode || $node instanceof ExpressionNodeInterface)) {
            $node = new EscapingNode($node);
        }
        return $node;
    }

    /**
     * This interceptor wants to hook into object accessor creation, and opening / closing ViewHelpers.
     *
     * @return array Array of INTERCEPT_* constants
     */
    public function getInterceptionPoints()
    {
        return [
            InterceptorInterface::INTERCEPT_OPENING_VIEWHELPER,
            InterceptorInterface::INTERCEPT_CLOSING_VIEWHELPER,
            InterceptorInterface::INTERCEPT_OBJECTACCESSOR,
            InterceptorInterface::INTERCEPT_EXPRESSION,
        ];
    }
}


1			<?php
2			namespace TYPO3Fluid\Fluid\Core\Parser\Interceptor;
3
4			/*
5			* This file belongs to the package "TYPO3 Fluid".
6			* See LICENSE.txt that was shipped with this package.
7			*/
8
9			use TYPO3Fluid\Fluid\Core\Parser\InterceptorInterface;
10			use TYPO3Fluid\Fluid\Core\Parser\ParsingState;
11			use TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\EscapingNode;
12			use TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\Expression\ExpressionNodeInterface;
13			use TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\NodeInterface;
14			use TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\ObjectAccessorNode;
15			use TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\ViewHelperNode;
16
17			/**
18			* An interceptor adding the "Htmlspecialchars" viewhelper to the suitable places.
19			*/
20			class Escape implements InterceptorInterface
21			{
22
23			/**
24			* Is the interceptor enabled right now for child nodes?
25			*
26			* @var boolean
27			*/
28			protected $childrenEscapingEnabled = true;
29
30			/**
31			* A stack of ViewHelperNodes which currently disable the interceptor.
32			* Needed to enable the interceptor again.
33			*
34			* @var NodeInterface[]
35			*/
36			protected $viewHelperNodesWhichDisableTheInterceptor = [];
37
38			/**
39			* Adds a ViewHelper node using the Format\HtmlspecialcharsViewHelper to the given node.
40			* If "escapingInterceptorEnabled" in the ViewHelper is FALSE, will disable itself inside the ViewHelpers body.
41			*
42			* @param NodeInterface $node
43			* @param integer $interceptorPosition One of the INTERCEPT_* constants for the current interception point
44			* @param ParsingState $parsingState the current parsing state. Not needed in this interceptor.
45			* @return NodeInterface
46			*/
47			public function process(NodeInterface $node, $interceptorPosition, ParsingState $parsingState)
48			{
49			$viewHelper = $node instanceof ViewHelperNode ? $node->getUninitializedViewHelper() : $node;
50			if ($interceptorPosition === InterceptorInterface::INTERCEPT_OPENING_VIEWHELPER) {
51			/** @var ViewHelperNode $node */
52			if (!$viewHelper->isChildrenEscapingEnabled()) {
			0 ignored issues – show Bug introduced 2019-06-03 11:55 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `TYPO3Fluid\Fluid\Core\Pa...yntaxTree\NodeInterface` as the method `isChildrenEscapingEnabled()` does only exist in the following implementations of said interface: `TYPO3Fluid\FluidExample\...elpers\CustomViewHelper`, `TYPO3Fluid\Fluid\Core\Vi...ractConditionViewHelper`, `TYPO3Fluid\Fluid\Core\Vi...tractTagBasedViewHelper`, `TYPO3Fluid\Fluid\Core\Vi...lper\AbstractViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\AliasViewHelper`, `TYPO3Fluid\Fluid\ViewHel...Cache\DisableViewHelper`, `TYPO3Fluid\Fluid\ViewHel...\Cache\StaticViewHelper`, `TYPO3Fluid\Fluid\ViewHel...\Cache\WarmupViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\CaseViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\CommentViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\CountViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\CycleViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\DebugViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\DefaultCaseViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\ElseViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\ForViewHelper`, `TYPO3Fluid\Fluid\ViewHel...\Format\CdataViewHelper`, `TYPO3Fluid\Fluid\ViewHel...lspecialcharsViewHelper`, `TYPO3Fluid\Fluid\ViewHel...Format\PrintfViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\Format\RawViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\GroupedForViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\IfViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\InlineViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\LayoutViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\OrViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\RenderViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\SectionViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\SpacelessViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\SwitchViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\ThenViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\VariableViewHelper`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
53			$this->childrenEscapingEnabled = false;
54			$this->viewHelperNodesWhichDisableTheInterceptor[] = $node;
55			}
56			} elseif ($interceptorPosition === InterceptorInterface::INTERCEPT_CLOSING_VIEWHELPER) {
57			if (end($this->viewHelperNodesWhichDisableTheInterceptor) === $node) {
58			array_pop($this->viewHelperNodesWhichDisableTheInterceptor);
59			if (count($this->viewHelperNodesWhichDisableTheInterceptor) === 0) {
60			$this->childrenEscapingEnabled = true;
61			}
62			}
63			/** @var ViewHelperNode $node */
64			if ($this->childrenEscapingEnabled && $viewHelper->isOutputEscapingEnabled()) {
			0 ignored issues – show Bug introduced 2019-06-03 11:55 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `TYPO3Fluid\Fluid\Core\Pa...yntaxTree\NodeInterface` as the method `isOutputEscapingEnabled()` does only exist in the following implementations of said interface: `TYPO3Fluid\FluidExample\...elpers\CustomViewHelper`, `TYPO3Fluid\Fluid\Core\Vi...ractConditionViewHelper`, `TYPO3Fluid\Fluid\Core\Vi...tractTagBasedViewHelper`, `TYPO3Fluid\Fluid\Core\Vi...lper\AbstractViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\AliasViewHelper`, `TYPO3Fluid\Fluid\ViewHel...Cache\DisableViewHelper`, `TYPO3Fluid\Fluid\ViewHel...\Cache\StaticViewHelper`, `TYPO3Fluid\Fluid\ViewHel...\Cache\WarmupViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\CaseViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\CommentViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\CountViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\CycleViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\DebugViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\DefaultCaseViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\ElseViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\ForViewHelper`, `TYPO3Fluid\Fluid\ViewHel...\Format\CdataViewHelper`, `TYPO3Fluid\Fluid\ViewHel...lspecialcharsViewHelper`, `TYPO3Fluid\Fluid\ViewHel...Format\PrintfViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\Format\RawViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\GroupedForViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\IfViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\InlineViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\LayoutViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\OrViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\RenderViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\SectionViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\SpacelessViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\SwitchViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\ThenViewHelper`, `TYPO3Fluid\Fluid\ViewHelpers\VariableViewHelper`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
65			$node = new EscapingNode($node);
66			}
67			} elseif ($this->childrenEscapingEnabled && ($node instanceof ObjectAccessorNode \|\| $node instanceof ExpressionNodeInterface)) {
68			$node = new EscapingNode($node);
69			}
70			return $node;
71			}
72
73			/**
74			* This interceptor wants to hook into object accessor creation, and opening / closing ViewHelpers.
75			*
76			* @return array Array of INTERCEPT_* constants
77			*/
78			public function getInterceptionPoints()
79			{
80			return [
81			InterceptorInterface::INTERCEPT_OPENING_VIEWHELPER,
82			InterceptorInterface::INTERCEPT_CLOSING_VIEWHELPER,
83			InterceptorInterface::INTERCEPT_OBJECTACCESSOR,
84			InterceptorInterface::INTERCEPT_EXPRESSION,
85			];
86			}
87			}
88

TYPO3 / Fluid

Pull Request — master (#457)

Escape::getInterceptionPoints() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like