IXR_Message

💡 云策文档标注

概述

IXR_Message 是 WordPress 中用于处理 XML-RPC 消息的类，负责解析 XML 数据并提取方法调用、响应或错误信息。它支持 PHP4 和 PHP5 构造函数，并包含用于解析 XML 和处理不同类型标签的方法。

关键要点

IXR_Message 类用于解析 XML-RPC 消息，支持 methodCall、methodResponse 和 fault 类型。
包含属性如 message、messageType、faultCode、faultString、methodName 和 params 来存储解析结果。
提供 parse() 方法进行 XML 解析，使用 xml_parser_create 并设置回调函数处理标签和数据。
支持多种数据类型（如 int、string、boolean、base64 等）的解析和转换。
使用内部栈（如 _arraystructs、_arraystructstypes）管理数组和结构体的嵌套。
包含 PHP4 和 PHP5 构造函数，确保向后兼容性。
从 WordPress 1.5.0 版本引入。

代码示例

// 示例：创建 IXR_Message 对象并解析 XML 消息
$message = new IXR_Message($xml_string);
if ($message->parse()) {
    echo $message->methodName; // 输出方法名
    print_r($message->params); // 输出参数数组
} else {
    echo '解析失败';
}

注意事项

解析前需确保 PHP 的 XML 扩展可用，否则会触发错误。
使用 xmlrpc_chunk_parsing_size 过滤器可调整解析块大小以优化内存使用。
在 PHP 5.2.11 及以上版本中，解析器会自动释放资源。

📄 原文内容

IXR_MESSAGE

Methods

Name	Description
IXR_Message::__construct	PHP5 constructor.
IXR_Message::cdata	–
IXR_Message::IXR_Message	PHP4 constructor.
IXR_Message::parse	–
IXR_Message::tag_close	–
IXR_Message::tag_open	–

Source

class IXR_Message
{
    var $message     = false;
    var $messageType = false;  // methodCall / methodResponse / fault
    var $faultCode   = false;
    var $faultString = false;
    var $methodName  = '';
    var $params      = array();

    // Current variable stacks
    var $_arraystructs = array();   // The stack used to keep track of the current array/struct
    var $_arraystructstypes = array(); // Stack keeping track of if things are structs or array
    var $_currentStructName = array();  // A stack as well
    var $_param;
    var $_value;
    var $_currentTag;
    var $_currentTagContents;
    // The XML parser
    var $_parser;

	/**
	 * PHP5 constructor.
	 */
    function __construct( $message )
    {
        $this->message =& $message;
    }

	/**
	 * PHP4 constructor.
	 */
	public function IXR_Message( $message ) {
		self::__construct( $message );
	}

    function parse()
    {
        if ( ! function_exists( 'xml_parser_create' ) ) {
            trigger_error( __( "PHP's XML extension is not available. Please contact your hosting provider to enable PHP's XML extension." ) );
            return false;
        }

        // first remove the XML declaration
        // merged from WP #10698 - this method avoids the RAM usage of preg_replace on very large messages
        $header = preg_replace( '/<?xml.*??'.'>/s', '', substr( $this->message, 0, 100 ), 1 );
        $this->message = trim( substr_replace( $this->message, $header, 0, 100 ) );
        if ( '' == $this->message ) {
            return false;
        }

        // Then remove the DOCTYPE
        $header = preg_replace( '/^]*+>/i', '', substr( $this->message, 0, 200 ), 1 );
        $this->message = trim( substr_replace( $this->message, $header, 0, 200 ) );
        if ( '' == $this->message ) {
            return false;
        }

        // Check that the root tag is valid
        $root_tag = substr( $this->message, 0, strcspn( substr( $this->message, 0, 20 ), "> trn" ) );
        if ( 'message, '<' ) ) {
            return false;
        }

        $this->_parser = xml_parser_create();
        // Set XML parser to take the case of tags in to account
        xml_parser_set_option($this->_parser, XML_OPTION_CASE_FOLDING, false);
        // Set XML parser callback functions
        xml_set_element_handler($this->_parser, array($this, 'tag_open'), array($this, 'tag_close'));
        xml_set_character_data_handler($this->_parser, array($this, 'cdata'));

        // 256Kb, parse in chunks to avoid the RAM usage on very large messages
        $chunk_size = 262144;

        /**
         * Filters the chunk size that can be used to parse an XML-RPC response message.
         *
         * @since 4.4.0
         *
         * @param int $chunk_size Chunk size to parse in bytes.
         */
        $chunk_size = apply_filters( 'xmlrpc_chunk_parsing_size', $chunk_size );

        $final = false;

        do {
            if (strlen($this->message) <= $chunk_size) {
                $final = true;
            }

            $part = substr($this->message, 0, $chunk_size);
            $this->message = substr($this->message, $chunk_size);

            if (!xml_parse($this->_parser, $part, $final)) {
                if (PHP_VERSION_ID < 80000) { // xml_parser_free() has no effect as of PHP 8.0.
                    xml_parser_free($this->_parser);
                }

                unset($this->_parser);
                return false;
            }

            if ($final) {
                break;
            }
        } while (true);

        if (PHP_VERSION_ID < 80000) { // xml_parser_free() has no effect as of PHP 8.0.
            xml_parser_free($this->_parser);
        }

        unset($this->_parser);

        // Grab the error messages, if any
        if ($this->messageType == 'fault') {
            $this->faultCode = $this->params[0]['faultCode'];
            $this->faultString = $this->params[0]['faultString'];
        }
        return true;
    }

    function tag_open($parser, $tag, $attr)
    {
        $this->_currentTagContents = '';
        $this->_currentTag = $tag;
        switch($tag) {
            case 'methodCall':
            case 'methodResponse':
            case 'fault':
                $this->messageType = $tag;
                break;
                /* Deal with stacks of arrays and structs */
            case 'data':    // data is to all intents and puposes more interesting than array
                $this->_arraystructstypes[] = 'array';
                $this->_arraystructs[] = array();
                break;
            case 'struct':
                $this->_arraystructstypes[] = 'struct';
                $this->_arraystructs[] = array();
                break;
        }
    }

    function cdata($parser, $cdata)
    {
        $this->_currentTagContents .= $cdata;
    }

    function tag_close($parser, $tag)
    {
        $valueFlag = false;
        switch($tag) {
            case 'int':
            case 'i4':
                $value = (int)trim($this->_currentTagContents);
                $valueFlag = true;
                break;
            case 'double':
                $value = (float)trim($this->_currentTagContents);
                $valueFlag = true;
                break;
            case 'string':
                $value = (string)trim($this->_currentTagContents);
                $valueFlag = true;
                break;
            case 'dateTime.iso8601':
                $value = new IXR_Date(trim($this->_currentTagContents));
                $valueFlag = true;
                break;
            case 'value':
                // "If no type is indicated, the type is string."
                if (trim($this->_currentTagContents) != '') {
                    $value = (string)$this->_currentTagContents;
                    $valueFlag = true;
                }
                break;
            case 'boolean':
                $value = (bool)trim($this->_currentTagContents);
                $valueFlag = true;
                break;
            case 'base64':
                $value = base64_decode($this->_currentTagContents);
                $valueFlag = true;
                break;
                /* Deal with stacks of arrays and structs */
            case 'data':
            case 'struct':
                $value = array_pop($this->_arraystructs);
                array_pop($this->_arraystructstypes);
                $valueFlag = true;
                break;
            case 'member':
                array_pop($this->_currentStructName);
                break;
            case 'name':
                $this->_currentStructName[] = trim($this->_currentTagContents);
                break;
            case 'methodName':
                $this->methodName = trim($this->_currentTagContents);
                break;
        }

        if ($valueFlag) {
            if (count($this->_arraystructs) > 0) {
                // Add value to struct or array
                if ($this->_arraystructstypes[count($this->_arraystructstypes)-1] == 'struct') {
                    // Add to struct
                    $this->_arraystructs[count($this->_arraystructs)-1][$this->_currentStructName[count($this->_currentStructName)-1]] = $value;
                } else {
                    // Add to array
                    $this->_arraystructs[count($this->_arraystructs)-1][] = $value;
                }
            } else {
                // Just add as a parameter
                $this->params[] = $value;
            }
        }
        $this->_currentTagContents = '';
    }
}

View all references View on Trac View on GitHub

Changelog

Version	Description
1.5.0	Introduced.

云策 WordPress 开发者社区

类文档

IXR_Message

概述

关键要点

代码示例

注意事项

Methods

Source

Changelog