General::check_and_parse_request_node() - Code Metrics - Inspection of "refactor parse_request_data() in all classes of Pr..." - dshovchko/php_EasyPay - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 067925...6361e3 )

by Dmitry

created 2017-11-27 12:05 UTC

General::check_and_parse_request_node() A

↳ Parent: General

Complexity

Conditions	2
Paths	2

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	2
c	0
b	0
f	0
nc	2
nop	2
dl	0
loc	5
rs	9.4285

<?php

/**
 *      General class for all request types
 *
 *      @package php_EasyPay
 *      @version 1.1
 *      @author Dmitry Shovchko <[email protected]>
 *
 */

namespace EasyPay\Provider31\Request;

use EasyPay\Log as Log;
use EasyPay\Exception;
use EasyPay\Key as Key;
use EasyPay\OpenSSL as OpenSSL;

class General
{
    /**
     *      @var string raw request
     */
    protected $raw_request;

    /**
     *      @var string 'DateTime' node
     */
    protected $DateTime;

    /**
     *      @var string 'Sign' node
     */
    protected $Sign;

    /**
     *      @var string 'Operation' type
     */
    protected $Operation;

    /**
     *      @var string 'ServiceId' node
     */
    protected $ServiceId;

    /**
     *      @var array list of possible operations
     */
    protected $operations = array('Check','Payment','Confirm','Cancel');

    /**
     *      General constructor
     *
     *      @param string $raw Raw request data
     */
    public function __construct($raw)
    {
        $this->raw_request = strval($raw);

        $this->parse_request_data();
    }

    /**
     *      Get DateTime
     *
     *      @return string
     */
    public function DateTime()
    {
        return $this->DateTime;
    }

    /**
     *      Get Sign
     *
     *      @return string
     */
    public function Sign()
    {
        return $this->Sign;
    }

    /**
     *      Get Operation type
     *
     *      @return string
     */
    public function Operation()
    {
        return $this->Operation;
    }

    /**
     *      Get ServiceId
     *
     *      @return string
     */
    public function ServiceId()
    {
        return $this->ServiceId;
    }

    /**
     *      Parse xml-request, which was previously "extracted" from the body of the http request
     *
     *      @throws Exception\Structure
     */
    protected function parse_request_data()
    {
        if (empty($this->raw_request))
        {
            throw new Exception\Structure('An empty xml request', -50);
        }

        libxml_use_internal_errors(true);
        $doc = new \DOMDocument();
        if ( ! $doc->loadXML($this->raw_request))
        {
            foreach(libxml_get_errors() as $e){
                Log::instance()->error($e->message);
            }
            throw new Exception\Structure('The wrong XML is received', -51);
        }

        // process <Request> group
        $r = $this->getNodes($doc, 'Request');

        if (count($r) < 1)
        {
            throw new Exception\Structure('The xml-query does not contain any element Request!', -52);
        }

        foreach ($r[0]->childNodes as $child)
        {
            $this->check_and_parse_request_node($child, 'DateTime');
            $this->check_and_parse_request_node($child, 'Sign');

            if (in_array($child->nodeName, $this->operations))
            {
                if ( ! isset($this->Operation))
                {
                    $this->Operation = $child->nodeName;
                }
                else
                {
                    throw new Exception\Structure('There is more than one Operation type element in the xml-query!', -53);
                }
            }
        }

        if ( ! isset($this->Operation))
        {
            throw new Exception\Structure('There is no Operation type element in the xml request!', -55);
        }

        // process <Operation> group
        $r = $this->getNodes($doc, $this->Operation);

        foreach ($r[0]->childNodes as $child)
        {
            $this->check_and_parse_request_node($child, 'ServiceId');
        }
    }

    /**
     *      Check if present node of request and then parse it
     *
     *      @param \DOMNode $n
     *      @param string $name
     */
    protected function check_and_parse_request_node($n, $name)
    {
        if ($n->nodeName == $name)
        {
            $this->parse_request_node($n, $name);
        }
    }

    /**
     *      Parse node of request
     *
     *      @param \DOMNode $n
     *      @param string $name
     *
     *      @throws Exception\Structure
     */
    protected function parse_request_node($n, $name)
    {
        if ( ! isset($this->$name))
        {
            $this->$name = $n->nodeValue;
        }
        else
        {
            throw new Exception\Structure('There is more than one '.$name.' element in the xml-query!', -56);
        }
    }

    /**
     *      "Rough" validation of the received xml request
     *
     *      @param array $options
     *      @throws Exception\Data
     *      @throws Exception\Structure
     */
    public function validate_request($options)
    {
        $this->validate_element('DateTime');
        $this->validate_element('Sign');
        $this->validate_element('ServiceId');

        // compare received value ServiceId with option ServiceId
        if (intval($options['ServiceId']) != intval($this->ServiceId))
        {
            throw new Exception\Data('This request is not for our ServiceId!', -58);
        }
    }

    /**
     *      Validation of xml-element
     *
     *      @param string $name
     */
    public function validate_element($name)
    {
        if ( ! isset($this->$name))
        {
            throw new Exception\Structure('There is no '.$name.' element in the xml request!', -57);
        }
    }

    /**
     *      Verify signature of request
     *
     *      @param array $options
     */
    public function verify_sign($options)
    {
        if (isset($options['UseSign']) && ($options['UseSign'] === true))
        {
            $this->check_verify_sign_result(
                $result = (new OpenSSL())->verify(
                    str_replace($this->Sign, '', $this->raw_request),
                    pack("H*", $this->Sign),
                    (new OpenSSL())->get_pub_key($this->get_pub_key($options))
                )
            );
        }
    }

    /**
     *      load file with easysoft public key
     *
     *      @param array $options
     *      @throws Exception\Runtime
     *      @return string
     */
    protected function get_pub_key($options)
    {
        if ( ! isset($options['EasySoftPKey']))
        {
            throw new Exception\Runtime('The parameter EasySoftPKey is not set!', -94);
        }

        return (new Key())->get($options['EasySoftPKey'], 'public');
    }

    /**
     *      check result of openssl verify signature
     *
     *      @param integer $result
     *      @throws Exception\Sign
     */
    protected function check_verify_sign_result($result)
    {
        if ($result == -1)
        {
            throw new Exception\Sign('Error verify signature of request!', -96);
        }
        elseif ($result == 0)
        {
            throw new Exception\Sign('Signature of request is incorrect!', -95);
        }
    }

    /**
     *      Selects nodes by name
     *
     *      @param \DOMDocument $dom
     *      @param string $name
     *      @param array $ret
     *
     *      @return array nodes with the name
     */
    protected function getNodes($dom, $name, $ret=array())
    {
        foreach($dom->childNodes as $child)
        {
            if ($child->nodeName == $name)
            {
                array_push($ret, $child);
            }
            else
            {
                if (count($child->childNodes) > 0)
                {
                    $ret = $this->getNodes($child, $name, $ret);
                }
            }
        }

        return $ret;
    }

}


1			<?php
2
3			/**
4			* General class for all request types
5			*
6			* @package php_EasyPay
7			* @version 1.1
8			* @author Dmitry Shovchko <[email protected]>
9			*
10			*/
11
12			namespace EasyPay\Provider31\Request;
13
14			use EasyPay\Log as Log;
15			use EasyPay\Exception;
16			use EasyPay\Key as Key;
17			use EasyPay\OpenSSL as OpenSSL;
18
19			class General
20			{
21			/**
22			* @var string raw request
23			*/
24			protected $raw_request;
25
26			/**
27			* @var string 'DateTime' node
28			*/
29			protected $DateTime;
30
31			/**
32			* @var string 'Sign' node
33			*/
34			protected $Sign;
35
36			/**
37			* @var string 'Operation' type
38			*/
39			protected $Operation;
40
41			/**
42			* @var string 'ServiceId' node
43			*/
44			protected $ServiceId;
45
46			/**
47			* @var array list of possible operations
48			*/
49			protected $operations = array('Check','Payment','Confirm','Cancel');
50
51			/**
52			* General constructor
53			*
54			* @param string $raw Raw request data
55			*/
56			public function __construct($raw)
57			{
58			$this->raw_request = strval($raw);
59
60			$this->parse_request_data();
61			}
62
63			/**
64			* Get DateTime
65			*
66			* @return string
67			*/
68			public function DateTime()
69			{
70			return $this->DateTime;
71			}
72
73			/**
74			* Get Sign
75			*
76			* @return string
77			*/
78			public function Sign()
79			{
80			return $this->Sign;
81			}
82
83			/**
84			* Get Operation type
85			*
86			* @return string
87			*/
88			public function Operation()
89			{
90			return $this->Operation;
91			}
92
93			/**
94			* Get ServiceId
95			*
96			* @return string
97			*/
98			public function ServiceId()
99			{
100			return $this->ServiceId;
101			}
102
103			/**
104			* Parse xml-request, which was previously "extracted" from the body of the http request
105			*
106			* @throws Exception\Structure
107			*/
108			protected function parse_request_data()
109			{
110			if (empty($this->raw_request))
111			{
112			throw new Exception\Structure('An empty xml request', -50);
113			}
114
115			libxml_use_internal_errors(true);
116			$doc = new \DOMDocument();
117			if ( ! $doc->loadXML($this->raw_request))
118			{
119			foreach(libxml_get_errors() as $e){
120			Log::instance()->error($e->message);
121			}
122			throw new Exception\Structure('The wrong XML is received', -51);
123			}
124
125			// process <Request> group
126			$r = $this->getNodes($doc, 'Request');
127
128			if (count($r) < 1)
129			{
130			throw new Exception\Structure('The xml-query does not contain any element Request!', -52);
131			}
132
133			foreach ($r[0]->childNodes as $child)
134			{
135			$this->check_and_parse_request_node($child, 'DateTime');
136			$this->check_and_parse_request_node($child, 'Sign');
137
138			if (in_array($child->nodeName, $this->operations))
139			{
140			if ( ! isset($this->Operation))
141			{
142			$this->Operation = $child->nodeName;
143			}
144			else
145			{
146			throw new Exception\Structure('There is more than one Operation type element in the xml-query!', -53);
147			}
148			}
149			}
150
151			if ( ! isset($this->Operation))
152			{
153			throw new Exception\Structure('There is no Operation type element in the xml request!', -55);
154			}
155
156			// process <Operation> group
157			$r = $this->getNodes($doc, $this->Operation);
158
159			foreach ($r[0]->childNodes as $child)
160			{
161			$this->check_and_parse_request_node($child, 'ServiceId');
162			}
163			}
164
165			/**
166			* Check if present node of request and then parse it
167			*
168			* @param \DOMNode $n
169			* @param string $name
170			*/
171			protected function check_and_parse_request_node($n, $name)
172			{
173			if ($n->nodeName == $name)
174			{
175			$this->parse_request_node($n, $name);
176			}
177			}
178
179			/**
180			* Parse node of request
181			*
182			* @param \DOMNode $n
183			* @param string $name
184			*
185			* @throws Exception\Structure
186			*/
187			protected function parse_request_node($n, $name)
188			{
189			if ( ! isset($this->$name))
190			{
191			$this->$name = $n->nodeValue;
192			}
193			else
194			{
195			throw new Exception\Structure('There is more than one '.$name.' element in the xml-query!', -56);
196			}
197			}
198
199			/**
200			* "Rough" validation of the received xml request
201			*
202			* @param array $options
203			* @throws Exception\Data
204			* @throws Exception\Structure
205			*/
206			public function validate_request($options)
207			{
208			$this->validate_element('DateTime');
209			$this->validate_element('Sign');
210			$this->validate_element('ServiceId');
211
212			// compare received value ServiceId with option ServiceId
213			if (intval($options['ServiceId']) != intval($this->ServiceId))
214			{
215			throw new Exception\Data('This request is not for our ServiceId!', -58);
216			}
217			}
218
219			/**
220			* Validation of xml-element
221			*
222			* @param string $name
223			*/
224			public function validate_element($name)
225			{
226			if ( ! isset($this->$name))
227			{
228			throw new Exception\Structure('There is no '.$name.' element in the xml request!', -57);
229			}
230			}
231
232			/**
233			* Verify signature of request
234			*
235			* @param array $options
236			*/
237			public function verify_sign($options)
238			{
239			if (isset($options['UseSign']) && ($options['UseSign'] === true))
240			{
241			$this->check_verify_sign_result(
242			$result = (new OpenSSL())->verify(
243			str_replace($this->Sign, '', $this->raw_request),
244			pack("H*", $this->Sign),
245			(new OpenSSL())->get_pub_key($this->get_pub_key($options))
246			)
247			);
248			}
249			}
250
251			/**
252			* load file with easysoft public key
253			*
254			* @param array $options
255			* @throws Exception\Runtime
256			* @return string
257			*/
258			protected function get_pub_key($options)
259			{
260			if ( ! isset($options['EasySoftPKey']))
261			{
262			throw new Exception\Runtime('The parameter EasySoftPKey is not set!', -94);
263			}
264
265			return (new Key())->get($options['EasySoftPKey'], 'public');
266			}
267
268			/**
269			* check result of openssl verify signature
270			*
271			* @param integer $result
272			* @throws Exception\Sign
273			*/
274			protected function check_verify_sign_result($result)
275			{
276			if ($result == -1)
277			{
278			throw new Exception\Sign('Error verify signature of request!', -96);
279			}
280			elseif ($result == 0)
281			{
282			throw new Exception\Sign('Signature of request is incorrect!', -95);
283			}
284			}
285
286			/**
287			* Selects nodes by name
288			*
289			* @param \DOMDocument $dom
290			* @param string $name
291			* @param array $ret
292			*
293			* @return array nodes with the name
294			*/
295			protected function getNodes($dom, $name, $ret=array())
296			{
297			foreach($dom->childNodes as $child)
298			{
299			if ($child->nodeName == $name)
300			{
301			array_push($ret, $child);
302			}
303			else
304			{
305			if (count($child->childNodes) > 0)
306			{
307			$ret = $this->getNodes($child, $name, $ret);
308			}
309			}
310			}
311
312			return $ret;
313			}
314
315			}
316

dshovchko / php_EasyPay

Push — master ( 067925...6361e3 )

General::check_and_parse_request_node() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like