AlgoWeb\ODataMetadata\Edm\Validation\Internal\ValidationHelper

Complexity

Total Complexity

55

Size/Duplication

Total Lines	284
Duplicated Lines	0 %

Importance

Changes	4
Bugs	1	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	checkExistsCore()	0	5	4
A	checkFunctionOrNameReference()	0	11	2
A	checkItemReference()	0	7	2
A	isEdmSystemNamespace()	0	4	2
A	functionOrNameExistsInReferencedModel()	0	13	3
B	typeIndirectlyContainsTarget()	0	37	9
A	allPropertiesAreNullable()	0	9	2
A	propertySetIsSubset()	0	3	1
C	validateValueCanBeWrittenAsXmlElementAnnotation()	0	78	15
A	propertySetsAreEquivalent()	0	11	4
A	hasNullableProperty()	0	9	2
A	isInterfaceCritical()	0	6	2
A	addMemberNameToHashSet()	0	18	4
A	itemExistsInReferencedModel()	0	12	3

<?php

declare(strict_types=1);


namespace AlgoWeb\ODataMetadata\Edm\Validation\Internal;

use AlgoWeb\ODataMetadata\Edm\Validation\EdmError;
use AlgoWeb\ODataMetadata\Edm\Validation\EdmErrorCode;
use AlgoWeb\ODataMetadata\Edm\Validation\ValidationContext;
use AlgoWeb\ODataMetadata\EdmConstants;
use AlgoWeb\ODataMetadata\EdmUtil;
use AlgoWeb\ODataMetadata\Exception\InvalidOperationException;
use AlgoWeb\ODataMetadata\Interfaces\IEntityType;
use AlgoWeb\ODataMetadata\Interfaces\IFunction;
use AlgoWeb\ODataMetadata\Interfaces\IModel;
use AlgoWeb\ODataMetadata\Interfaces\INamedElement;
use AlgoWeb\ODataMetadata\Interfaces\ISchemaElement;
use AlgoWeb\ODataMetadata\Interfaces\IStructuralProperty;
use AlgoWeb\ODataMetadata\Interfaces\Values\IStringValue;
use AlgoWeb\ODataMetadata\Interfaces\Values\IValue;
use AlgoWeb\ODataMetadata\StringConst;
use AlgoWeb\ODataMetadata\Structure\HashSetInternal;
use Exception;
use SplObjectStorage;
use Throwable;
use XMLReader;

abstract class ValidationHelper
{
    public static function isEdmSystemNamespace(string $namespaceName): bool
    {
        return ($namespaceName == EdmConstants::TransientNamespace ||
        $namespaceName == EdmConstants::EdmNamespace);
    }

    public static function addMemberNameToHashSet(
        INamedElement $item,
        HashSetInternal $memberNameList,
        ValidationContext $context,
        EdmErrorCode $errorCode,
        string $errorString,
        bool $suppressError
    ) {
        $name = $item instanceof ISchemaElement ? $item->fullName() : $item->getName();
        if ($memberNameList->add($name)) {
            if (!$suppressError) {
                EdmUtil::checkArgumentNull($item->location(), 'item->Location');
                $context->addError($item->location(), $errorCode, $errorString);
            }
            return false;
        }

        return true;
    }

    /**
     * @param  IStructuralProperty[] $properties
     * @return bool
     */
    public static function allPropertiesAreNullable(array $properties): bool
    {
        return count(array_filter($properties, function (IStructuralProperty $item) {
            try {
                return $item->getType()->getNullable();
            } catch (Throwable $e) {
                throw new InvalidOperationException($e->getMessage());
            }
        })) === count($properties);
    }

    /**
     * @param  IStructuralProperty[] $properties
     * @return bool
     */
    public static function hasNullableProperty(array $properties): bool
    {
        return count(array_filter($properties, function (IStructuralProperty $item) {
            try {
                return $item->getType()->getNullable();
            } catch (Throwable $e) {
                throw new InvalidOperationException($e->getMessage());
            }
        })) > 0;
    }

    /**
     * @param  IStructuralProperty[] $set
     * @param  IStructuralProperty[] $subset
     * @return bool
     */
    public static function propertySetIsSubset(array $set, array $subset): bool
    {
        return count(array_diff($subset, $set)) === 0;
    }

    /**
     * @param  IStructuralProperty[] $set1
     * @param  IStructuralProperty[] $set2
     * @return bool
     */
    public static function propertySetsAreEquivalent(array $set1, array $set2): bool
    {
        if (count($set1) != count($set2)) {
            return false;
        }
        for ($i = count($set1) -1; $i > -1; --$i) {
            if ($set1[$i] !== $set2[$i]) {
                return false;
            }
        }
        return true;
    }

    public static function validateValueCanBeWrittenAsXmlElementAnnotation(
        IValue $value,
        ?string $annotationNamespace,
        ?string $annotationName,
        ?EdmError &$error
    ): bool {
        if (!($value instanceof IStringValue)) {
            $error = new EdmError(
                $value->location(),
                EdmErrorCode::InvalidElementAnnotation(),
                StringConst::EdmModel_Validator_Semantic_InvalidElementAnnotationNotIEdmStringValue()
            );
            return false;
        }

        $rawString = $value->getValue();
        $reader    = new XMLReader();
        $reader->XML($rawString);
        try {
            $eof = true;
            // Skip to root element.
            if ($reader->nodeType != XMLReader::ELEMENT) {
                while ($reader->read() && $reader->nodeType != XMLReader::ELEMENT) {
                    if ($reader->nodeType == XMLReader::ELEMENT) {
                        $eof = false;
                        break;
                    }
                }
            }

            // The annotation must be an element.
            if ($eof) {
                $error = new EdmError(
                    $value->location(),
                    EdmErrorCode::InvalidElementAnnotation(),
                    StringConst::EdmModel_Validator_Semantic_InvalidElementAnnotationValueInvalidXml()
                );
                return false;
            }

            // The root element must correspond to the term of the annotation
            $elementNamespace = $reader->namespaceURI;
            $elementName      = $reader->localName;

            if (EdmUtil::isNullOrWhiteSpaceInternal($elementNamespace) ||
                EdmUtil::isNullOrWhiteSpaceInternal($elementName)) {
                $error = new EdmError(
                    $value->location(),
                    EdmErrorCode::InvalidElementAnnotation(),
                    StringConst::EdmModel_Validator_Semantic_InvalidElementAnnotationNullNamespaceOrName()
                );
                return false;
            }

            if (!((null === $annotationNamespace || $elementNamespace == $annotationNamespace) &&
                  (null === $annotationName || $elementName == $annotationName))) {
                $error = new EdmError(
                    $value->location(),
                    EdmErrorCode::InvalidElementAnnotation(),
                    StringConst::EdmModel_Validator_Semantic_InvalidElementAnnotationMismatchedTerm()
                );
                return false;
            }

            // Parse the entire fragment to determine if the XML is valid
            /* @noinspection PhpStatementHasEmptyBodyInspection */
            while ($reader->read()) {
            }

            $error = null;
            return true;
        } catch (Exception $e) {
            $error = new EdmError(
                $value->location(),
                EdmErrorCode::InvalidElementAnnotation(),
                StringConst::EdmModel_Validator_Semantic_InvalidElementAnnotationValueInvalidXml()
            );
            return false;
        }
    }

    public static function isInterfaceCritical(EdmError $error): bool
    {
        $errVal = $error->getErrorCode()->getValue();

        return $errVal >= EdmErrorCode::InterfaceCriticalPropertyValueMustNotBeNull()->getValue() &&
               $errVal <= EdmErrorCode::InterfaceCriticalCycleInTypeHierarchy()->getValue();
    }

    public static function itemExistsInReferencedModel(
        IModel $model,
        string $fullName,
        bool $checkEntityContainer
    ): bool {
        foreach ($model->getReferencedModels() as $referenced) {
            if (self::checkItemReference($fullName, $checkEntityContainer, $referenced)) {
                return true;
            }
        }

        return false;
    }

    // Take function name to avoid recomputing it
    public static function functionOrNameExistsInReferencedModel(
        IModel $model,
        IFunction $function,
        string $functionFullName,
        bool $checkEntityContainer
    ): bool {
        foreach ($model->getReferencedModels() as $referenced) {
            if (self::checkFunctionOrNameReference($function, $functionFullName, $checkEntityContainer, $referenced)) {
                return true;
            }
        }

        return false;
    }

    public static function typeIndirectlyContainsTarget(
        IEntityType $source,
        IEntityType $target,
        SplObjectStorage $visited,
        IModel $context
    ): bool {
        if (!$visited->offsetExists($source)) {
            $visited->offsetSet($source, true);
            $visited[$source] = true;
            if ($source->isOrInheritsFrom($target)) {
                return true;
            }

            foreach ($source->navigationProperties() as $navProp) {
                if ($navProp->containsTarget() && self::typeIndirectlyContainsTarget(
                    $navProp->toEntityType(),
                    $target,
                    $visited,
                    $context
                )) {
                    return true;
                }
            }

            foreach ($context->findAllDerivedTypes($source) as $derived) {
                if ($derived instanceof IEntityType && self::typeIndirectlyContainsTarget(
                    $derived,
                    $target,
                    $visited,
                    $context
                )) {
                    return true;
                }
            }
        }

        return false;
    }

    /**
     * @param  string $fullName
     * @param  bool   $checkEntityContainer
     * @param  IModel $referenced
     * @return bool
     */
    protected static function checkItemReference(string $fullName, bool $checkEntityContainer, IModel $referenced): bool
    {
        if (self::checkExistsCore($referenced, $fullName, $checkEntityContainer)) {
            return true;
        }
        $functionList = $referenced->findDeclaredFunctions($fullName) ?? [];
        return 0 != count($functionList);
    }

    /**
     * @param  IFunction $function
     * @param  string    $functionFullName
     * @param  bool      $checkEntityContainer
     * @param  IModel    $referenced
     * @return bool
     */
    protected static function checkFunctionOrNameReference(
        IFunction $function,
        string $functionFullName,
        bool $checkEntityContainer,
        IModel $referenced
    ): bool {
        if (self::checkExistsCore($referenced, $functionFullName, $checkEntityContainer)) {
            return true;
        }
        $functionList = $referenced->findDeclaredFunctions($functionFullName) ?? [];
        return 0 < count(array_filter($functionList, [$function, 'IsFunctionSignatureEquivalentTo']));
    }

    protected static function checkExistsCore(IModel $referenced, string $fullName, bool $checkEntityContainer): bool
    {
        return $referenced->findDeclaredType($fullName) != null ||
               $referenced->findDeclaredValueTerm($fullName) != null ||
               ($checkEntityContainer && $referenced->findDeclaredEntityContainer($fullName) != null);
    }
}