XML::canonicalizeData() - Code Metrics - Inspection of "Few psalm-fixes" - simplesamlphp/xml-security - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — php80 (d71885)

by Tim

created 2022-09-16 22:05 UTC

XML::canonicalizeData() B

↳ Parent: XML

Complexity

Conditions	10
Paths	5

Size

Total Lines	39
Code Lines	22

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
cc	10
eloc	22
c	2
b	1
f	0
nc	5
nop	4
dl	0
loc	39
rs	7.6666

How to fix Complexity

<?php

declare(strict_types=1);

namespace SimpleSAML\XMLSecurity\Utils;

use DOMElement;
use SimpleSAML\XMLSecurity\Constants as C;
use SimpleSAML\XMLSecurity\XML\ds\Transforms;

use function count;
use function is_null;

/**
 * Class with utility methods for XML manipulation.
 *
 * @package simplesamlphp/xml-security
 */
class XML
{
    /**
     * Canonicalize any given node.
     *
     * @param \DOMElement $element The DOM element that needs canonicalization.
     * @param string $c14nMethod The identifier of the canonicalization algorithm to use.
     * See \SimpleSAML\XMLSecurity\Constants.
     * @param array|null $xpaths An array of xpaths to filter the nodes by. Defaults to null (no filters).
     * @param array|null $prefixes An array of namespace prefixes to filter the nodes by. Defaults to null (no filters).
     *
     * @return string The canonical representation of the given DOM node, according to the algorithm requested.
     */
    public static function canonicalizeData(
        DOMElement $element,
        string $c14nMethod,
        array $xpaths = null,
        array $prefixes = null,
    ): string {
        $exclusive = false;

        $withComments = match ($c14nMethod) {
            C::C14N_EXCLUSIVE_WITH_COMMENTS, C::C14N_INCLUSIVE_WITH_COMMENTS => true,
            default => false,
        };
        $exclusive = match ($c14nMethod) {
            C::C14N_EXCLUSIVE_WITH_COMMENTS, C::C14N_EXCLUSIVE_WITHOUT_COMMENTS => true,
            default => false,
        };

        if (
            is_null($xpaths)
            && ($element->ownerDocument !== null)
            && ($element->ownerDocument->documentElement !== null)
            && $element->isSameNode($element->ownerDocument->documentElement)
        ) {
            // check for any PI or comments as they would have been excluded
            $current = $element;
            while ($refNode = $current->previousSibling) {
                if (
                    (($refNode->nodeType === XML_COMMENT_NODE) && $withComments)
                    || $refNode->nodeType === XML_PI_NODE
                ) {
                    break;
                }
                $current = $refNode;
            }
            if ($refNode === null) {
                $element = $element->ownerDocument;
            }
        }

        return $element->C14N($exclusive, $withComments, $xpaths, $prefixes);
    }


    /**
     * Process all transforms specified by a given Reference element.
     *
     * @param \SimpleSAML\XMLSecurity\XML\ds\Transforms $transforms The transforms to apply.
     * @param \DOMElement $data The data referenced.
     * @param bool $includeCommentNodes Whether to allow canonicalization with comments or not.
     *
     * @return string The canonicalized data after applying all transforms specified by $ref.
     *
     * @see http://www.w3.org/TR/xmldsig-core/#sec-ReferenceProcessingModel
     */
    public static function processTransforms(
        Transforms $transforms,
        DOMElement $data,
    ): string {
        $canonicalMethod = C::C14N_EXCLUSIVE_WITHOUT_COMMENTS;
        $arXPath = null;
        $prefixList = null;
        foreach ($transforms->getTransform() as $transform) {
            $canonicalMethod = $transform->getAlgorithm();
            switch ($canonicalMethod) {
                case C::C14N_EXCLUSIVE_WITHOUT_COMMENTS:
                case C::C14N_EXCLUSIVE_WITH_COMMENTS:
                    $inclusiveNamespaces = $transform->getInclusiveNamespaces();
                    if ($inclusiveNamespaces !== null) {
                        $prefixes = $inclusiveNamespaces->getPrefixes();
                        if (count($prefixes) > 0) {
                            $prefixList = $prefixes;
                        }
                    }
                    break;
                case C::XPATH_URI:
                    $xpath = $transform->getXPath();
                    if ($xpath !== null) {
                        $arXPath = [];
                        $arXPath['query'] = '(.//. | .//@* | .//namespace::*)[' . $xpath->getExpression() . ']';
                        $arXpath['namespaces'] = $xpath->getNamespaces();
                        // TODO: review if $nsnode->localName is equivalent to the keys in getNamespaces()
//                        $nslist = $xp->query('./namespace::*', $node);
//                        foreach ($nslist as $nsnode) {
//                            if ($nsnode->localName != "xml") {
//                                $arXPath['namespaces'][$nsnode->localName] = $nsnode->nodeValue;
//                            }
//                        }
                    }
                    break;
            }
        }

        return self::canonicalizeData($data, $canonicalMethod, $arXPath, $prefixList);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace SimpleSAML\XMLSecurity\Utils;
6
7			use DOMElement;
8			use SimpleSAML\XMLSecurity\Constants as C;
9			use SimpleSAML\XMLSecurity\XML\ds\Transforms;
10
11			use function count;
12			use function is_null;
13
14			/**
15			* Class with utility methods for XML manipulation.
16			*
17			* @package simplesamlphp/xml-security
18			*/
19			class XML
20			{
21			/**
22			* Canonicalize any given node.
23			*
24			* @param \DOMElement $element The DOM element that needs canonicalization.
25			* @param string $c14nMethod The identifier of the canonicalization algorithm to use.
26			* See \SimpleSAML\XMLSecurity\Constants.
27			* @param array\|null $xpaths An array of xpaths to filter the nodes by. Defaults to null (no filters).
28			* @param array\|null $prefixes An array of namespace prefixes to filter the nodes by. Defaults to null (no filters).
29			*
30			* @return string The canonical representation of the given DOM node, according to the algorithm requested.
31			*/
32			public static function canonicalizeData(
33			DOMElement $element,
34			string $c14nMethod,
35			array $xpaths = null,
36			array $prefixes = null,
37			): string {
38			$exclusive = false;
			0 ignored issues – show Unused Code introduced 2022-09-16 22:07 UTC by Report Bug Copy Issue Report The assignment to `$exclusive` is dead and can be removed. Loading history...
39			$withComments = match ($c14nMethod) {
40			C::C14N_EXCLUSIVE_WITH_COMMENTS, C::C14N_INCLUSIVE_WITH_COMMENTS => true,
41			default => false,
42			};
43			$exclusive = match ($c14nMethod) {
44			C::C14N_EXCLUSIVE_WITH_COMMENTS, C::C14N_EXCLUSIVE_WITHOUT_COMMENTS => true,
45			default => false,
46			};
47
48			if (
49			is_null($xpaths)
50			&& ($element->ownerDocument !== null)
51			&& ($element->ownerDocument->documentElement !== null)
52			&& $element->isSameNode($element->ownerDocument->documentElement)
53			) {
54			// check for any PI or comments as they would have been excluded
55			$current = $element;
56			while ($refNode = $current->previousSibling) {
57			if (
58			(($refNode->nodeType === XML_COMMENT_NODE) && $withComments)
59			\|\| $refNode->nodeType === XML_PI_NODE
60			) {
61			break;
62			}
63			$current = $refNode;
64			}
65			if ($refNode === null) {
66			$element = $element->ownerDocument;
67			}
68			}
69
70			return $element->C14N($exclusive, $withComments, $xpaths, $prefixes);
71			}
72
73
74			/**
75			* Process all transforms specified by a given Reference element.
76			*
77			* @param \SimpleSAML\XMLSecurity\XML\ds\Transforms $transforms The transforms to apply.
78			* @param \DOMElement $data The data referenced.
79			* @param bool $includeCommentNodes Whether to allow canonicalization with comments or not.
80			*
81			* @return string The canonicalized data after applying all transforms specified by $ref.
82			*
83			* @see http://www.w3.org/TR/xmldsig-core/#sec-ReferenceProcessingModel
84			*/
85			public static function processTransforms(
86			Transforms $transforms,
87			DOMElement $data,
88			): string {
89			$canonicalMethod = C::C14N_EXCLUSIVE_WITHOUT_COMMENTS;
90			$arXPath = null;
91			$prefixList = null;
92			foreach ($transforms->getTransform() as $transform) {
93			$canonicalMethod = $transform->getAlgorithm();
94			switch ($canonicalMethod) {
95			case C::C14N_EXCLUSIVE_WITHOUT_COMMENTS:
96			case C::C14N_EXCLUSIVE_WITH_COMMENTS:
97			$inclusiveNamespaces = $transform->getInclusiveNamespaces();
98			if ($inclusiveNamespaces !== null) {
99			$prefixes = $inclusiveNamespaces->getPrefixes();
100			if (count($prefixes) > 0) {
101			$prefixList = $prefixes;
102			}
103			}
104			break;
105			case C::XPATH_URI:
106			$xpath = $transform->getXPath();
107			if ($xpath !== null) {
108			$arXPath = [];
109			$arXPath['query'] = '(.//. \| .//@* \| .//namespace::*)[' . $xpath->getExpression() . ']';
110			$arXpath['namespaces'] = $xpath->getNamespaces();
111			// TODO: review if $nsnode->localName is equivalent to the keys in getNamespaces()
112			// $nslist = $xp->query('./namespace::*', $node);
113			// foreach ($nslist as $nsnode) {
114			// if ($nsnode->localName != "xml") {
115			// $arXPath['namespaces'][$nsnode->localName] = $nsnode->nodeValue;
116			// }
117			// }
118			}
119			break;
120			}
121			}
122
123			return self::canonicalizeData($data, $canonicalMethod, $arXPath, $prefixList);
124			}
125			}
126

simplesamlphp / xml-security

Branch — php80 (d71885)

XML::canonicalizeData() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like