BooleanNode.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Fluid\Core\Parser\SyntaxTree;

/*                                                                        *
 * This script is backported from the TYPO3 Flow package "TYPO3.Fluid".   *
 *                                                                        *
 * It is free software; you can redistribute it and/or modify it under    *
 * the terms of the GNU Lesser General Public License, either version 3   *
 *  of the License, or (at your option) any later version.                *
 *                                                                        *
 * The TYPO3 project - inspiring people to share!                         *
 *                                                                        */

class BooleanNode extends \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\AbstractNode {

    static protected $comparators = array('==', '!=', '%', '>=', '>', '<=', '<');

    static protected $booleanExpressionTextNodeCheckerRegularExpression = '/
        ^                 # Start with first input symbol
        (?:               # start repeat
            COMPARATORS   # We allow all comparators
            |\s*          # Arbitary spaces
            |-?           # Numbers, possibly with the "minus" symbol in front.
                [0-9]+    # some digits
                (?:       # and optionally a dot, followed by some more digits
                    \\.
                    [0-9]+
                )?
            |\'[^\'\\\\]* # single quoted string literals with possibly escaped single quotes
                (?:
                    \\\\.      # escaped character
                    [^\'\\\\]* # unrolled loop following Jeffrey E.F. Friedl
                )*\'
            |"[^"\\\\]*   # double quoted string literals with possibly escaped double quotes
                (?:
                    \\\\.     # escaped character
                    [^"\\\\]* # unrolled loop following Jeffrey E.F. Friedl
                )*"
        )*
        $/x';

    protected $leftSide;

    protected $rightSide;

    protected $comparator;

    protected $syntaxTreeNode;

    public function __construct(\TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\AbstractNode $syntaxTreeNode) {
        $childNodes = $syntaxTreeNode->getChildNodes();
        if (count($childNodes) > 3) {
            throw new \TYPO3\CMS\Fluid\Core\Parser\Exception('A boolean expression has more than three parts.', 1244201848);
        } elseif (count($childNodes) === 0) {
            // In this case, we do not have child nodes; i.e. the current SyntaxTreeNode
            // is a text node with a literal comparison like "1 == 1"
            $childNodes = array($syntaxTreeNode);
        }

        $this->leftSide = new \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\RootNode();
        $this->rightSide = new \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\RootNode();
        $this->comparator = NULL;
        foreach ($childNodes as $childNode) {
            if ($childNode instanceof \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\TextNode && !preg_match(str_replace('COMPARATORS', implode('|', self::$comparators), self::$booleanExpressionTextNodeCheckerRegularExpression), $childNode->getText())) {
                // $childNode is text node, and no comparator found.
                $this->comparator = NULL;
                // skip loop and fall back to classical to boolean conversion.
                break;
            }

            if ($this->comparator !== NULL) {
                // comparator already set, we are evaluating the right side of the comparator
                $this->rightSide->addChildNode($childNode);
            } elseif ($childNode instanceof \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\TextNode
                && ($this->comparator = $this->getComparatorFromString($childNode->getText()))) {
                // comparator in current string segment
                $explodedString = explode($this->comparator, $childNode->getText());
                if (isset($explodedString[0]) && trim($explodedString[0]) !== '') {
                    $value = trim($explodedString[0]);
                    if (is_numeric($value)) {
                        $this->leftSide->addChildNode(new \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\NumericNode($value));
                    } else {
                        $this->leftSide->addChildNode(new \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\TextNode(preg_replace('/(^[\'"]|[\'"]$)/', '', $value)));
                    }
                }
                if (isset($explodedString[1]) && trim($explodedString[1]) !== '') {
                    $value = trim($explodedString[1]);
                    if (is_numeric($value)) {
                        $this->rightSide->addChildNode(new \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\NumericNode($value));
                    } else {
                        $this->rightSide->addChildNode(new \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\TextNode(preg_replace('/(^[\'"]|[\'"]$)/', '', $value)));
                    }
                }
            } else {
                // comparator not found yet, on the left side of the comparator
                $this->leftSide->addChildNode($childNode);
            }
        }

        if ($this->comparator === NULL) {
            // No Comparator found, we need to evaluate the given syntax tree node manually
            $this->syntaxTreeNode = $syntaxTreeNode;
        }
    }

    public function getComparator() {
        return $this->comparator;
    }

    public function getSyntaxTreeNode() {
        return $this->syntaxTreeNode;
    }

    public function getLeftSide() {
        return $this->leftSide;
    }

    public function getRightSide() {
        return $this->rightSide;
    }

    public function evaluate(\TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext) {
        if ($this->comparator !== NULL) {
            return self::evaluateComparator($this->comparator, $this->leftSide->evaluate($renderingContext), $this->rightSide->evaluate($renderingContext));
        } else {
            $value = $this->syntaxTreeNode->evaluate($renderingContext);
            return self::convertToBoolean($value);
        }
    }

    static public function evaluateComparator($comparator, $evaluatedLeftSide, $evaluatedRightSide) {
        switch ($comparator) {
            case '==':
                if (is_object($evaluatedLeftSide) || is_object($evaluatedRightSide)) {
                    return ($evaluatedLeftSide === $evaluatedRightSide);
                } else {
                    return ($evaluatedLeftSide == $evaluatedRightSide);
                }
            case '!=':
                if (is_object($evaluatedLeftSide) || is_object($evaluatedRightSide)) {
                    return ($evaluatedLeftSide !== $evaluatedRightSide);
                } else {
                    return ($evaluatedLeftSide != $evaluatedRightSide);
                }
            case '%':
                if (!self::isComparable($evaluatedLeftSide, $evaluatedRightSide)) {
                    return FALSE;
                }
                return (boolean) ((int)$evaluatedLeftSide % (int)$evaluatedRightSide);
            case '>':
                if (!self::isComparable($evaluatedLeftSide, $evaluatedRightSide)) {
                    return FALSE;
                }
                return $evaluatedLeftSide > $evaluatedRightSide;
            case '>=':
                if (!self::isComparable($evaluatedLeftSide, $evaluatedRightSide)) {
                    return FALSE;
                }
                return $evaluatedLeftSide >= $evaluatedRightSide;
            case '<':
                if (!self::isComparable($evaluatedLeftSide, $evaluatedRightSide)) {
                    return FALSE;
                }
                return $evaluatedLeftSide < $evaluatedRightSide;
            case '<=':
                if (!self::isComparable($evaluatedLeftSide, $evaluatedRightSide)) {
                    return FALSE;
                }
                return $evaluatedLeftSide <= $evaluatedRightSide;
            default:
                throw new \TYPO3\CMS\Fluid\Core\Parser\Exception('Comparator "' . $comparator . '" is not implemented.', 1244234398);
        }
    }

    static protected function isComparable($evaluatedLeftSide, $evaluatedRightSide) {
        if ((is_null($evaluatedLeftSide) || is_string($evaluatedLeftSide))
            && is_string($evaluatedRightSide)) {
            return TRUE;
        }
        if (is_bool($evaluatedLeftSide) || is_null($evaluatedLeftSide)) {
            return TRUE;
        }
        if (is_object($evaluatedLeftSide) && is_object($evaluatedRightSide)) {
            return TRUE;
        }
        if ((is_string($evaluatedLeftSide) || is_resource($evaluatedLeftSide) || is_numeric($evaluatedLeftSide))
            && (is_string($evaluatedRightSide) || is_resource($evaluatedRightSide) || is_numeric($evaluatedRightSide))) {
            return TRUE;
        }
        if (is_array($evaluatedLeftSide) && is_array($evaluatedRightSide)) {
            return TRUE;
        }
        return FALSE;
    }

    protected function getComparatorFromString($string) {
        foreach (self::$comparators as $comparator) {
            if (strpos($string, $comparator) !== FALSE) {
                return $comparator;
            }
        }
        return NULL;
    }

    static public function convertToBoolean($value) {
        if (is_bool($value)) {
            return $value;
        }

        if (is_integer($value) || is_float($value)) {
            return !empty($value);
        }

        if (is_numeric($value)) {
            return ($value != 0);
        }

        if (is_string($value)) {
            return (!empty($value) && strtolower($value) !== 'false');
        }
        if (is_array($value) || (is_object($value) && $value instanceof \Countable)) {
            return (bool) count($value);
        }
        if (is_object($value)) {
            return TRUE;
        }

        return FALSE;
    }
}