sysPass/lib/SP/Http/XMLRPCResponseParse.php

<?php
/**
 * sysPass
 *
 * @author    nuxsmin
 * @link      https://syspass.org
 * @copyright 2012-2018, Rubén Domínguez nuxsmin@$syspass.org
 *
 * This file is part of sysPass.
 *
 * sysPass is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * sysPass is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 *  along with sysPass.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace SP\Http;

use DOMDocument;
use DOMElement;
use DOMNode;
use DOMNodeList;
use InvalidArgumentException;

/**
 * Class XMLRPCResponseParse para el parseo de respuestas HTTP en formato XML-RPC
 *
 * @package SP\Http
 */
abstract class XMLRPCResponseParse
{
    /**
     * @var DOMElement
     */
    private $root;
    /**
     * @var string
     */
    private $xml;
    /**
     * @var array
     */
    private $data = [];

    /**
     * Constructor
     *
     * @param string $xml El documento XML
     *
     * @throws \InvalidArgumentException
     */
    public function __construct($xml)
    {
        try {
            $this->xml = $xml;

            $dom = new DOMDocument();
            $dom->loadXML($xml);

            if ($dom->getElementsByTagName('methodResponse')->length === 0) {
                throw new \DOMException(__u('Respuesta XML-RPC inválida'));
            }

            $this->root = $dom->documentElement;
        } catch (\DOMException $e) {
            throw new InvalidArgumentException($e->getMessage(), $e->getCode());
        }
    }

    /**
     * Obtener los datos del error
     *
     * @return array
     */
    public function getError()
    {
        return $this->parseNodes($this->root->getElementsByTagName('fault'));
    }

    /**
     * Obtener los nodos recursivamente y almacenar los datos en el atributo
     * de la clase _data
     *
     * @param DOMNodeList $nodes
     *
     * @return array
     */
    private function parseNodes(DOMNodeList $nodes)
    {
        if ($nodes->length > 0) {
            foreach ($nodes as $node) {
                if ($node instanceof DOMElement) {
                    /**
                     * @var $node DOMElement
                     */
                    switch ($node->nodeName) {
                        case 'struct':
                            return $this->parseStruct($node);
                        case 'array':
                            return $this->parseArray($node);
                        case 'fault':
                            return $this->parseFault($node);
                        case 'value':
                            $this->data = $this->parseValues($node);
                            break;
                        default:
                            $this->parseNodes($node->childNodes);
                    }
                }
            }
        }
    }

    /**
     * Procesar nodos del tipo struct
     *
     * @param DOMElement $xmlStruct
     *
     * @return array
     */
    private function parseStruct(DOMElement $xmlStruct)
    {
        $dataStruct = [];
        $nStruct = 0;

        foreach ($xmlStruct->childNodes as $struct) {
            if ($struct instanceof DOMElement) {
                foreach ($struct->childNodes as $member) {
                    /**
                     * @var $member DOMNode
                     */
                    switch ($member->nodeName) {
                        case 'name':
                            $name = $member->nodeValue;
                            break;
                        case 'value':
                            $dataStruct[$name] = $this->parseNodeType($member->firstChild);
                            break;
                    }
                }
                $nStruct++;
            }
        }

        return $dataStruct;
    }

    /**
     * @param DOMNode $node
     *
     * @return bool|int|string|null
     */
    private function parseNodeType(DOMNode $node)
    {
        switch ($node->nodeName) {
            case 'int' :
            case 'i4' :
                return (int)$node->nodeValue;
            case 'string' :
                return $node->nodeValue;
            case 'dateTime.iso8601' :
                return date('d M y H:i:s', strtotime($node->nodeValue));
            case 'boolean' :
                return (bool)$node->nodeValue;
            default :
                return null;
        }
    }

    /**
     * Procesar nodos del tipo array
     *
     * @param DOMElement $xmlArray
     *
     * @return array
     */
    private function parseArray(DOMElement $xmlArray)
    {
        $arrayData = [];

        foreach ($xmlArray->childNodes as $array) {
            foreach ($array->childNodes as $data) {
                /**
                 * @var $data DOMElement
                 */
                if ($data instanceof DOMElement && $data->nodeName === 'value') {
                    $values = $this->parseValues($data);

                    if (is_array($values)) {
                        $arrayData[] = $values;
                    }
                }
            }
        }

        return $arrayData;
    }

    /**
     * Procesar nodos del tipo value
     *
     * @param DOMElement $xmlValues
     *
     * @return array
     */
    private function parseValues(DOMElement $xmlValues)
    {
        $valuesData = [];

        foreach ($xmlValues->childNodes as $xmlValue) {
            if ($xmlValue instanceof DOMElement) {
                $val = $this->parseNodeType($xmlValue);

                if (null === $val) {
                    return $this->parseNodes($xmlValues->childNodes);
                } else {
                    $valuesData[] = $val;
                }
            }
        }

        return $valuesData;
    }

    /**
     * Procesar nodos del tipo fault
     *
     * @param DOMElement $xmlFault
     *
     * @return array
     */
    private function parseFault(DOMElement $xmlFault)
    {
        $faultData = [];

        foreach ($xmlFault->childNodes as $fault) {
            /**
             * @var $fault DOMElement
             */
            if ($fault instanceof DOMElement && $fault->nodeName === 'value') {
                $values = $this->parseValues($fault);

                if (is_array($values)) {
                    return $values;
                }
            }
        }

        return $faultData;
    }

    /**
     * Obtener los datos de la respuesta
     */
    public function parseParams()
    {
        $this->parseNodes($this->root->getElementsByTagName('params'));

        return $this->data;
    }

    /**
     * Devolver el documento XML
     *
     * @return string
     */
    public function getXml()
    {
        return $this->xml;
    }
}