PhpXmlRpc\Helper\XMLParser::parse()

Complexity

Conditions	15
Paths	706

Size

Total Lines	107
Code Lines	72

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	54
CRAP Score	15.225

Importance

Changes	1
Bugs	0	Features	0

<?php
    public function parse($data, $returnType = self::RETURN_XMLRPCVALS, $accept = 3, $options = array())
    {
        $this->_xh = array(
            'ac' => '',
            'stack' => array(),
            'valuestack' => array(),
            'isf' => 0,
            'isf_reason' => '',
            'value' => null,
            'method' => false, // so we can check later if we got a methodname or not
            'params' => array(),
            'pt' => array(),
            'rt' => '',
        );

        $len = strlen($data);

        // we test for empty documents here to save on resource allocation and simply the chunked-parsing loop below
        if ($len == 0) {
            $this->_xh['isf'] = 3;
            $this->_xh['isf_reason'] = 'XML error 5: empty document';
            return;
        }

        $prevAccept = $this->accept;
        $this->accept = $accept;

        $this->callbacks = array();
        foreach ($options as $key => $val) {
            if (is_string($key)) {
                switch($key) {
                    case 'methodname_callback':
                        if (!is_callable($val)) {
                            $this->_xh['isf'] = 4;
                            $this->_xh['isf_reason'] = "Callback passed as 'methodname_callback' is not callable";
                            return;
                        } else {
                            $this->callbacks['methodname'] = $val;
                        }
                        break;
                    default:
                        $this->getLogger()->errorLog('XML-RPC: ' . __METHOD__ . ": unsupported option: $key");
                }
                unset($options[$key]);
            }
        }

        // NB: we use '' instead of null to force charset detection from the xml declaration
        $parser = xml_parser_create('');

        foreach ($this->parsing_options as $key => $val) {
            xml_parser_set_option($parser, $key, $val);
        }
        foreach ($options as $key => $val) {
            xml_parser_set_option($parser, $key, $val);
        }
        // always set this, in case someone tries to disable it via options...
        xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 1);

        xml_set_object($parser, $this);

        switch ($returnType) {
            case self::RETURN_PHP:
                xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast');
                break;
            case self::RETURN_EPIVALS:
                xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_epi');
                break;
            /// @todo log a warning on unsupported return type
            case XMLParser::RETURN_XMLRPCVALS:
            default:
                xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee');
        }

        xml_set_character_data_handler($parser, 'xmlrpc_cd');
        xml_set_default_handler($parser, 'xmlrpc_dh');

        try {
            // @see ticket #70 - we have to parse big xml docs in chunks to avoid errors
            for ($offset = 0; $offset < $len; $offset += $this->maxChunkLength) {
                $chunk = substr($data, $offset, $this->maxChunkLength);
                // error handling: xml not well formed
                if (!xml_parse($parser, $chunk, $offset + $this->maxChunkLength >= $len)) {
                    $errCode = xml_get_error_code($parser);
                    $errStr = sprintf('XML error %s: %s at line %d, column %d', $errCode, xml_error_string($errCode),
                        xml_get_current_line_number($parser), xml_get_current_column_number($parser));

                    $this->_xh['isf'] = 3;
                    $this->_xh['isf_reason'] = $errStr;
                    break;
                }
                // no need to parse further if we already have a fatal error
                if ($this->_xh['isf'] >= 2) {
                    break;
                }
            }
        } catch (\Exception $e) {
            xml_parser_free($parser);
            $this->callbacks = array();
            $this->accept = $prevAccept;
            /// @todo should we set $this->_xh['isf'] and $this->_xh['isf_reason'] ?
            throw $e;
        }

        xml_parser_free($parser);
        $this->callbacks = array();
        $this->accept = $prevAccept;
    }