web/wp-includes/class-IXR.php
author ymh
Fri, 12 Mar 2010 13:29:04 +0000
changeset 1 0d28b7c10758
permissions -rw-r--r--
First commit
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1
0d28b7c10758 First commit
ymh
parents:
diff changeset
     1
<?php
0d28b7c10758 First commit
ymh
parents:
diff changeset
     2
/**
0d28b7c10758 First commit
ymh
parents:
diff changeset
     3
 * IXR - The Inutio XML-RPC Library
0d28b7c10758 First commit
ymh
parents:
diff changeset
     4
 *
0d28b7c10758 First commit
ymh
parents:
diff changeset
     5
 * @package IXR
0d28b7c10758 First commit
ymh
parents:
diff changeset
     6
 * @since 1.5
0d28b7c10758 First commit
ymh
parents:
diff changeset
     7
 *
0d28b7c10758 First commit
ymh
parents:
diff changeset
     8
 * @copyright Incutio Ltd 2002-2005
0d28b7c10758 First commit
ymh
parents:
diff changeset
     9
 * @version 1.7 (beta) 23rd May 2005
0d28b7c10758 First commit
ymh
parents:
diff changeset
    10
 * @author Simon Willison
0d28b7c10758 First commit
ymh
parents:
diff changeset
    11
 * @link http://scripts.incutio.com/xmlrpc/ Site
0d28b7c10758 First commit
ymh
parents:
diff changeset
    12
 * @link http://scripts.incutio.com/xmlrpc/manual.php Manual
0d28b7c10758 First commit
ymh
parents:
diff changeset
    13
 * @license BSD License http://www.opensource.org/licenses/bsd-license.php
0d28b7c10758 First commit
ymh
parents:
diff changeset
    14
 */
0d28b7c10758 First commit
ymh
parents:
diff changeset
    15
0d28b7c10758 First commit
ymh
parents:
diff changeset
    16
/**
0d28b7c10758 First commit
ymh
parents:
diff changeset
    17
 * IXR_Value
0d28b7c10758 First commit
ymh
parents:
diff changeset
    18
 *
0d28b7c10758 First commit
ymh
parents:
diff changeset
    19
 * @package IXR
0d28b7c10758 First commit
ymh
parents:
diff changeset
    20
 * @since 1.5
0d28b7c10758 First commit
ymh
parents:
diff changeset
    21
 */
0d28b7c10758 First commit
ymh
parents:
diff changeset
    22
class IXR_Value {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    23
    var $data;
0d28b7c10758 First commit
ymh
parents:
diff changeset
    24
    var $type;
0d28b7c10758 First commit
ymh
parents:
diff changeset
    25
0d28b7c10758 First commit
ymh
parents:
diff changeset
    26
    function IXR_Value ($data, $type = false) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    27
        $this->data = $data;
0d28b7c10758 First commit
ymh
parents:
diff changeset
    28
        if (!$type) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    29
            $type = $this->calculateType();
0d28b7c10758 First commit
ymh
parents:
diff changeset
    30
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    31
        $this->type = $type;
0d28b7c10758 First commit
ymh
parents:
diff changeset
    32
        if ($type == 'struct') {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    33
            /* Turn all the values in the array in to new IXR_Value objects */
0d28b7c10758 First commit
ymh
parents:
diff changeset
    34
            foreach ($this->data as $key => $value) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    35
                $this->data[$key] = new IXR_Value($value);
0d28b7c10758 First commit
ymh
parents:
diff changeset
    36
            }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    37
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    38
        if ($type == 'array') {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    39
            for ($i = 0, $j = count($this->data); $i < $j; $i++) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    40
                $this->data[$i] = new IXR_Value($this->data[$i]);
0d28b7c10758 First commit
ymh
parents:
diff changeset
    41
            }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    42
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    43
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    44
0d28b7c10758 First commit
ymh
parents:
diff changeset
    45
    function calculateType() {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    46
        if ($this->data === true || $this->data === false) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    47
            return 'boolean';
0d28b7c10758 First commit
ymh
parents:
diff changeset
    48
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    49
        if (is_integer($this->data)) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    50
            return 'int';
0d28b7c10758 First commit
ymh
parents:
diff changeset
    51
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    52
        if (is_double($this->data)) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    53
            return 'double';
0d28b7c10758 First commit
ymh
parents:
diff changeset
    54
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    55
        // Deal with IXR object types base64 and date
0d28b7c10758 First commit
ymh
parents:
diff changeset
    56
        if (is_object($this->data) && is_a($this->data, 'IXR_Date')) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    57
            return 'date';
0d28b7c10758 First commit
ymh
parents:
diff changeset
    58
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    59
        if (is_object($this->data) && is_a($this->data, 'IXR_Base64')) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    60
            return 'base64';
0d28b7c10758 First commit
ymh
parents:
diff changeset
    61
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    62
        // If it is a normal PHP object convert it in to a struct
0d28b7c10758 First commit
ymh
parents:
diff changeset
    63
        if (is_object($this->data)) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    64
0d28b7c10758 First commit
ymh
parents:
diff changeset
    65
            $this->data = get_object_vars($this->data);
0d28b7c10758 First commit
ymh
parents:
diff changeset
    66
            return 'struct';
0d28b7c10758 First commit
ymh
parents:
diff changeset
    67
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    68
        if (!is_array($this->data)) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    69
            return 'string';
0d28b7c10758 First commit
ymh
parents:
diff changeset
    70
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    71
        /* We have an array - is it an array or a struct ? */
0d28b7c10758 First commit
ymh
parents:
diff changeset
    72
        if ($this->isStruct($this->data)) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    73
            return 'struct';
0d28b7c10758 First commit
ymh
parents:
diff changeset
    74
        } else {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    75
            return 'array';
0d28b7c10758 First commit
ymh
parents:
diff changeset
    76
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    77
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    78
0d28b7c10758 First commit
ymh
parents:
diff changeset
    79
    function getXml() {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    80
        /* Return XML for this value */
0d28b7c10758 First commit
ymh
parents:
diff changeset
    81
        switch ($this->type) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    82
            case 'boolean':
0d28b7c10758 First commit
ymh
parents:
diff changeset
    83
                return '<boolean>'.(($this->data) ? '1' : '0').'</boolean>';
0d28b7c10758 First commit
ymh
parents:
diff changeset
    84
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
    85
            case 'int':
0d28b7c10758 First commit
ymh
parents:
diff changeset
    86
                return '<int>'.$this->data.'</int>';
0d28b7c10758 First commit
ymh
parents:
diff changeset
    87
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
    88
            case 'double':
0d28b7c10758 First commit
ymh
parents:
diff changeset
    89
                return '<double>'.$this->data.'</double>';
0d28b7c10758 First commit
ymh
parents:
diff changeset
    90
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
    91
            case 'string':
0d28b7c10758 First commit
ymh
parents:
diff changeset
    92
                return '<string>'.htmlspecialchars($this->data).'</string>';
0d28b7c10758 First commit
ymh
parents:
diff changeset
    93
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
    94
            case 'array':
0d28b7c10758 First commit
ymh
parents:
diff changeset
    95
                $return = '<array><data>'."\n";
0d28b7c10758 First commit
ymh
parents:
diff changeset
    96
                foreach ($this->data as $item) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    97
                    $return .= '  <value>'.$item->getXml()."</value>\n";
0d28b7c10758 First commit
ymh
parents:
diff changeset
    98
                }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    99
                $return .= '</data></array>';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   100
                return $return;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   101
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   102
            case 'struct':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   103
                $return = '<struct>'."\n";
0d28b7c10758 First commit
ymh
parents:
diff changeset
   104
                foreach ($this->data as $name => $value) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   105
					$name = htmlspecialchars($name);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   106
                    $return .= "  <member><name>$name</name><value>";
0d28b7c10758 First commit
ymh
parents:
diff changeset
   107
                    $return .= $value->getXml()."</value></member>\n";
0d28b7c10758 First commit
ymh
parents:
diff changeset
   108
                }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   109
                $return .= '</struct>';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   110
                return $return;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   111
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   112
            case 'date':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   113
            case 'base64':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   114
                return $this->data->getXml();
0d28b7c10758 First commit
ymh
parents:
diff changeset
   115
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   116
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   117
        return false;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   118
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   119
0d28b7c10758 First commit
ymh
parents:
diff changeset
   120
    function isStruct($array) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   121
        /* Nasty function to check if an array is a struct or not */
0d28b7c10758 First commit
ymh
parents:
diff changeset
   122
        $expected = 0;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   123
        foreach ($array as $key => $value) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   124
            if ((string)$key != (string)$expected) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   125
                return true;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   126
            }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   127
            $expected++;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   128
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   129
        return false;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   130
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   131
}
0d28b7c10758 First commit
ymh
parents:
diff changeset
   132
0d28b7c10758 First commit
ymh
parents:
diff changeset
   133
/**
0d28b7c10758 First commit
ymh
parents:
diff changeset
   134
 * IXR_Message
0d28b7c10758 First commit
ymh
parents:
diff changeset
   135
 *
0d28b7c10758 First commit
ymh
parents:
diff changeset
   136
 * @package IXR
0d28b7c10758 First commit
ymh
parents:
diff changeset
   137
 * @since 1.5
0d28b7c10758 First commit
ymh
parents:
diff changeset
   138
 */
0d28b7c10758 First commit
ymh
parents:
diff changeset
   139
class IXR_Message {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   140
    var $message;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   141
    var $messageType;  // methodCall / methodResponse / fault
0d28b7c10758 First commit
ymh
parents:
diff changeset
   142
    var $faultCode;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   143
    var $faultString;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   144
    var $methodName;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   145
    var $params;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   146
    // Current variable stacks
0d28b7c10758 First commit
ymh
parents:
diff changeset
   147
    var $_arraystructs = array();   // The stack used to keep track of the current array/struct
0d28b7c10758 First commit
ymh
parents:
diff changeset
   148
    var $_arraystructstypes = array(); // Stack keeping track of if things are structs or array
0d28b7c10758 First commit
ymh
parents:
diff changeset
   149
    var $_currentStructName = array();  // A stack as well
0d28b7c10758 First commit
ymh
parents:
diff changeset
   150
    var $_param;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   151
    var $_value;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   152
    var $_currentTag;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   153
    var $_currentTagContents;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   154
    // The XML parser
0d28b7c10758 First commit
ymh
parents:
diff changeset
   155
    var $_parser;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   156
    function IXR_Message (&$message) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   157
        $this->message = &$message;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   158
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   159
    function parse() {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   160
		// first remove the XML declaration
0d28b7c10758 First commit
ymh
parents:
diff changeset
   161
		// this method avoids the RAM usage of preg_replace on very large messages
0d28b7c10758 First commit
ymh
parents:
diff changeset
   162
		$header = preg_replace( '/<\?xml.*?\?'.'>/', '', substr( $this->message, 0, 100 ), 1 );
0d28b7c10758 First commit
ymh
parents:
diff changeset
   163
		$this->message = substr_replace($this->message, $header, 0, 100);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   164
        if (trim($this->message) == '') {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   165
            return false;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   166
		}
0d28b7c10758 First commit
ymh
parents:
diff changeset
   167
        $this->_parser = xml_parser_create();
0d28b7c10758 First commit
ymh
parents:
diff changeset
   168
        // Set XML parser to take the case of tags in to account
0d28b7c10758 First commit
ymh
parents:
diff changeset
   169
        xml_parser_set_option($this->_parser, XML_OPTION_CASE_FOLDING, false);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   170
        // Set XML parser callback functions
0d28b7c10758 First commit
ymh
parents:
diff changeset
   171
        xml_set_object($this->_parser, $this);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   172
        xml_set_element_handler($this->_parser, 'tag_open', 'tag_close');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   173
		xml_set_character_data_handler($this->_parser, 'cdata');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   174
		$chunk_size = 262144; // 256Kb, parse in chunks to avoid the RAM usage on very large messages
0d28b7c10758 First commit
ymh
parents:
diff changeset
   175
		do {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   176
			if ( strlen($this->message) <= $chunk_size )
0d28b7c10758 First commit
ymh
parents:
diff changeset
   177
				$final=true;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   178
			$part = substr( $this->message, 0, $chunk_size );
0d28b7c10758 First commit
ymh
parents:
diff changeset
   179
			$this->message = substr( $this->message, $chunk_size );
0d28b7c10758 First commit
ymh
parents:
diff changeset
   180
			if ( !xml_parse( $this->_parser, $part, $final ) )
0d28b7c10758 First commit
ymh
parents:
diff changeset
   181
				return false;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   182
			if ( $final )
0d28b7c10758 First commit
ymh
parents:
diff changeset
   183
				break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   184
		} while ( true );
0d28b7c10758 First commit
ymh
parents:
diff changeset
   185
		xml_parser_free($this->_parser);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   186
        // Grab the error messages, if any
0d28b7c10758 First commit
ymh
parents:
diff changeset
   187
        if ($this->messageType == 'fault') {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   188
            $this->faultCode = $this->params[0]['faultCode'];
0d28b7c10758 First commit
ymh
parents:
diff changeset
   189
            $this->faultString = $this->params[0]['faultString'];
0d28b7c10758 First commit
ymh
parents:
diff changeset
   190
		}
0d28b7c10758 First commit
ymh
parents:
diff changeset
   191
        return true;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   192
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   193
    function tag_open($parser, $tag, $attr) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   194
        $this->_currentTagContents = '';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   195
        $this->currentTag = $tag;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   196
        switch($tag) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   197
            case 'methodCall':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   198
            case 'methodResponse':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   199
            case 'fault':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   200
                $this->messageType = $tag;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   201
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   202
            /* Deal with stacks of arrays and structs */
0d28b7c10758 First commit
ymh
parents:
diff changeset
   203
            case 'data':    // data is to all intents and puposes more interesting than array
0d28b7c10758 First commit
ymh
parents:
diff changeset
   204
                $this->_arraystructstypes[] = 'array';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   205
                $this->_arraystructs[] = array();
0d28b7c10758 First commit
ymh
parents:
diff changeset
   206
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   207
            case 'struct':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   208
                $this->_arraystructstypes[] = 'struct';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   209
                $this->_arraystructs[] = array();
0d28b7c10758 First commit
ymh
parents:
diff changeset
   210
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   211
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   212
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   213
    function cdata($parser, $cdata) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   214
        $this->_currentTagContents .= $cdata;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   215
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   216
    function tag_close($parser, $tag) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   217
        $valueFlag = false;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   218
        switch($tag) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   219
            case 'int':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   220
            case 'i4':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   221
                $value = (int) trim($this->_currentTagContents);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   222
                $valueFlag = true;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   223
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   224
            case 'double':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   225
                $value = (double) trim($this->_currentTagContents);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   226
                $valueFlag = true;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   227
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   228
            case 'string':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   229
                $value = $this->_currentTagContents;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   230
                $valueFlag = true;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   231
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   232
            case 'dateTime.iso8601':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   233
                $value = new IXR_Date(trim($this->_currentTagContents));
0d28b7c10758 First commit
ymh
parents:
diff changeset
   234
                // $value = $iso->getTimestamp();
0d28b7c10758 First commit
ymh
parents:
diff changeset
   235
                $valueFlag = true;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   236
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   237
            case 'value':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   238
                // "If no type is indicated, the type is string."
0d28b7c10758 First commit
ymh
parents:
diff changeset
   239
                if (trim($this->_currentTagContents) != '') {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   240
                    $value = (string)$this->_currentTagContents;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   241
                    $valueFlag = true;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   242
                }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   243
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   244
            case 'boolean':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   245
                $value = (boolean) trim($this->_currentTagContents);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   246
                $valueFlag = true;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   247
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   248
            case 'base64':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   249
                $value = base64_decode( trim( $this->_currentTagContents ) );
0d28b7c10758 First commit
ymh
parents:
diff changeset
   250
                $valueFlag = true;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   251
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   252
            /* Deal with stacks of arrays and structs */
0d28b7c10758 First commit
ymh
parents:
diff changeset
   253
            case 'data':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   254
            case 'struct':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   255
                $value = array_pop($this->_arraystructs);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   256
                array_pop($this->_arraystructstypes);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   257
                $valueFlag = true;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   258
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   259
            case 'member':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   260
                array_pop($this->_currentStructName);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   261
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   262
            case 'name':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   263
                $this->_currentStructName[] = trim($this->_currentTagContents);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   264
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   265
            case 'methodName':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   266
                $this->methodName = trim($this->_currentTagContents);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   267
                break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   268
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   269
        if ($valueFlag) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   270
            if (count($this->_arraystructs) > 0) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   271
                // Add value to struct or array
0d28b7c10758 First commit
ymh
parents:
diff changeset
   272
                if ($this->_arraystructstypes[count($this->_arraystructstypes)-1] == 'struct') {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   273
                    // Add to struct
0d28b7c10758 First commit
ymh
parents:
diff changeset
   274
                    $this->_arraystructs[count($this->_arraystructs)-1][$this->_currentStructName[count($this->_currentStructName)-1]] = $value;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   275
                } else {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   276
                    // Add to array
0d28b7c10758 First commit
ymh
parents:
diff changeset
   277
                    $this->_arraystructs[count($this->_arraystructs)-1][] = $value;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   278
                }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   279
            } else {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   280
                // Just add as a paramater
0d28b7c10758 First commit
ymh
parents:
diff changeset
   281
                $this->params[] = $value;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   282
            }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   283
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   284
        $this->_currentTagContents = '';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   285
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   286
}
0d28b7c10758 First commit
ymh
parents:
diff changeset
   287
0d28b7c10758 First commit
ymh
parents:
diff changeset
   288
/**
0d28b7c10758 First commit
ymh
parents:
diff changeset
   289
 * IXR_Server
0d28b7c10758 First commit
ymh
parents:
diff changeset
   290
 *
0d28b7c10758 First commit
ymh
parents:
diff changeset
   291
 * @package IXR
0d28b7c10758 First commit
ymh
parents:
diff changeset
   292
 * @since 1.5
0d28b7c10758 First commit
ymh
parents:
diff changeset
   293
 */
0d28b7c10758 First commit
ymh
parents:
diff changeset
   294
class IXR_Server {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   295
    var $data;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   296
    var $callbacks = array();
0d28b7c10758 First commit
ymh
parents:
diff changeset
   297
    var $message;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   298
    var $capabilities;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   299
    function IXR_Server($callbacks = false, $data = false) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   300
        $this->setCapabilities();
0d28b7c10758 First commit
ymh
parents:
diff changeset
   301
        if ($callbacks) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   302
            $this->callbacks = $callbacks;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   303
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   304
        $this->setCallbacks();
0d28b7c10758 First commit
ymh
parents:
diff changeset
   305
        $this->serve($data);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   306
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   307
    function serve($data = false) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   308
        if (!$data) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   309
            global $HTTP_RAW_POST_DATA;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   310
            if (!$HTTP_RAW_POST_DATA) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   311
               header( 'Content-Type: text/plain' );
0d28b7c10758 First commit
ymh
parents:
diff changeset
   312
               die('XML-RPC server accepts POST requests only.');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   313
            }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   314
            $data = &$HTTP_RAW_POST_DATA;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   315
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   316
        $this->message = new IXR_Message($data);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   317
        if (!$this->message->parse()) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   318
            $this->error(-32700, 'parse error. not well formed');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   319
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   320
        if ($this->message->messageType != 'methodCall') {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   321
            $this->error(-32600, 'server error. invalid xml-rpc. not conforming to spec. Request must be a methodCall');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   322
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   323
        $result = $this->call($this->message->methodName, $this->message->params);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   324
        // Is the result an error?
0d28b7c10758 First commit
ymh
parents:
diff changeset
   325
        if (is_a($result, 'IXR_Error')) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   326
            $this->error($result);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   327
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   328
        // Encode the result
0d28b7c10758 First commit
ymh
parents:
diff changeset
   329
        $r = new IXR_Value($result);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   330
        $resultxml = $r->getXml();
0d28b7c10758 First commit
ymh
parents:
diff changeset
   331
        // Create the XML
0d28b7c10758 First commit
ymh
parents:
diff changeset
   332
        $xml = <<<EOD
0d28b7c10758 First commit
ymh
parents:
diff changeset
   333
<methodResponse>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   334
  <params>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   335
    <param>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   336
      <value>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   337
        $resultxml
0d28b7c10758 First commit
ymh
parents:
diff changeset
   338
      </value>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   339
    </param>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   340
  </params>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   341
</methodResponse>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   342
0d28b7c10758 First commit
ymh
parents:
diff changeset
   343
EOD;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   344
        // Send it
0d28b7c10758 First commit
ymh
parents:
diff changeset
   345
        $this->output($xml);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   346
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   347
    function call($methodname, $args) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   348
        if (!$this->hasMethod($methodname)) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   349
            return new IXR_Error(-32601, 'server error. requested method '.
0d28b7c10758 First commit
ymh
parents:
diff changeset
   350
                $methodname.' does not exist.');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   351
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   352
        $method = $this->callbacks[$methodname];
0d28b7c10758 First commit
ymh
parents:
diff changeset
   353
        // Perform the callback and send the response
0d28b7c10758 First commit
ymh
parents:
diff changeset
   354
        if (count($args) == 1) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   355
            // If only one paramater just send that instead of the whole array
0d28b7c10758 First commit
ymh
parents:
diff changeset
   356
            $args = $args[0];
0d28b7c10758 First commit
ymh
parents:
diff changeset
   357
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   358
        // Are we dealing with a function or a method?
0d28b7c10758 First commit
ymh
parents:
diff changeset
   359
        if (substr($method, 0, 5) == 'this:') {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   360
            // It's a class method - check it exists
0d28b7c10758 First commit
ymh
parents:
diff changeset
   361
            $method = substr($method, 5);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   362
            if (!method_exists($this, $method)) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   363
                return new IXR_Error(-32601, 'server error. requested class method "'.
0d28b7c10758 First commit
ymh
parents:
diff changeset
   364
                    $method.'" does not exist.');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   365
            }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   366
            // Call the method
0d28b7c10758 First commit
ymh
parents:
diff changeset
   367
            $result = $this->$method($args);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   368
        } else {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   369
            // It's a function - does it exist?
0d28b7c10758 First commit
ymh
parents:
diff changeset
   370
            if (is_array($method)) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   371
                if (!method_exists($method[0], $method[1])) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   372
                    return new IXR_Error(-32601, 'server error. requested object method "'.
0d28b7c10758 First commit
ymh
parents:
diff changeset
   373
                        $method[1].'" does not exist.');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   374
                }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   375
            } else if (!function_exists($method)) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   376
                return new IXR_Error(-32601, 'server error. requested function "'.
0d28b7c10758 First commit
ymh
parents:
diff changeset
   377
                    $method.'" does not exist.');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   378
            }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   379
            // Call the function
0d28b7c10758 First commit
ymh
parents:
diff changeset
   380
            $result = call_user_func($method, $args);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   381
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   382
        return $result;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   383
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   384
0d28b7c10758 First commit
ymh
parents:
diff changeset
   385
    function error($error, $message = false) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   386
        // Accepts either an error object or an error code and message
0d28b7c10758 First commit
ymh
parents:
diff changeset
   387
        if ($message && !is_object($error)) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   388
            $error = new IXR_Error($error, $message);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   389
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   390
        $this->output($error->getXml());
0d28b7c10758 First commit
ymh
parents:
diff changeset
   391
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   392
    function output($xml) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   393
        $xml = '<?xml version="1.0"?>'."\n".$xml;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   394
        $length = strlen($xml);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   395
        header('Connection: close');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   396
        header('Content-Length: '.$length);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   397
        header('Content-Type: text/xml');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   398
        header('Date: '.date('r'));
0d28b7c10758 First commit
ymh
parents:
diff changeset
   399
        echo $xml;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   400
        exit;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   401
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   402
    function hasMethod($method) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   403
        return in_array($method, array_keys($this->callbacks));
0d28b7c10758 First commit
ymh
parents:
diff changeset
   404
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   405
    function setCapabilities() {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   406
        // Initialises capabilities array
0d28b7c10758 First commit
ymh
parents:
diff changeset
   407
        $this->capabilities = array(
0d28b7c10758 First commit
ymh
parents:
diff changeset
   408
            'xmlrpc' => array(
0d28b7c10758 First commit
ymh
parents:
diff changeset
   409
                'specUrl' => 'http://www.xmlrpc.com/spec',
0d28b7c10758 First commit
ymh
parents:
diff changeset
   410
                'specVersion' => 1
0d28b7c10758 First commit
ymh
parents:
diff changeset
   411
            ),
0d28b7c10758 First commit
ymh
parents:
diff changeset
   412
            'faults_interop' => array(
0d28b7c10758 First commit
ymh
parents:
diff changeset
   413
                'specUrl' => 'http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php',
0d28b7c10758 First commit
ymh
parents:
diff changeset
   414
                'specVersion' => 20010516
0d28b7c10758 First commit
ymh
parents:
diff changeset
   415
            ),
0d28b7c10758 First commit
ymh
parents:
diff changeset
   416
            'system.multicall' => array(
0d28b7c10758 First commit
ymh
parents:
diff changeset
   417
                'specUrl' => 'http://www.xmlrpc.com/discuss/msgReader$1208',
0d28b7c10758 First commit
ymh
parents:
diff changeset
   418
                'specVersion' => 1
0d28b7c10758 First commit
ymh
parents:
diff changeset
   419
            ),
0d28b7c10758 First commit
ymh
parents:
diff changeset
   420
        );
0d28b7c10758 First commit
ymh
parents:
diff changeset
   421
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   422
    function getCapabilities($args) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   423
        return $this->capabilities;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   424
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   425
    function setCallbacks() {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   426
        $this->callbacks['system.getCapabilities'] = 'this:getCapabilities';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   427
        $this->callbacks['system.listMethods'] = 'this:listMethods';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   428
        $this->callbacks['system.multicall'] = 'this:multiCall';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   429
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   430
    function listMethods($args) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   431
        // Returns a list of methods - uses array_reverse to ensure user defined
0d28b7c10758 First commit
ymh
parents:
diff changeset
   432
        // methods are listed before server defined methods
0d28b7c10758 First commit
ymh
parents:
diff changeset
   433
        return array_reverse(array_keys($this->callbacks));
0d28b7c10758 First commit
ymh
parents:
diff changeset
   434
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   435
    function multiCall($methodcalls) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   436
        // See http://www.xmlrpc.com/discuss/msgReader$1208
0d28b7c10758 First commit
ymh
parents:
diff changeset
   437
        $return = array();
0d28b7c10758 First commit
ymh
parents:
diff changeset
   438
        foreach ($methodcalls as $call) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   439
            $method = $call['methodName'];
0d28b7c10758 First commit
ymh
parents:
diff changeset
   440
            $params = $call['params'];
0d28b7c10758 First commit
ymh
parents:
diff changeset
   441
            if ($method == 'system.multicall') {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   442
                $result = new IXR_Error(-32600, 'Recursive calls to system.multicall are forbidden');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   443
            } else {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   444
                $result = $this->call($method, $params);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   445
            }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   446
            if (is_a($result, 'IXR_Error')) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   447
                $return[] = array(
0d28b7c10758 First commit
ymh
parents:
diff changeset
   448
                    'faultCode' => $result->code,
0d28b7c10758 First commit
ymh
parents:
diff changeset
   449
                    'faultString' => $result->message
0d28b7c10758 First commit
ymh
parents:
diff changeset
   450
                );
0d28b7c10758 First commit
ymh
parents:
diff changeset
   451
            } else {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   452
                $return[] = array($result);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   453
            }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   454
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   455
        return $return;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   456
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   457
}
0d28b7c10758 First commit
ymh
parents:
diff changeset
   458
0d28b7c10758 First commit
ymh
parents:
diff changeset
   459
/**
0d28b7c10758 First commit
ymh
parents:
diff changeset
   460
 * IXR_Request
0d28b7c10758 First commit
ymh
parents:
diff changeset
   461
 *
0d28b7c10758 First commit
ymh
parents:
diff changeset
   462
 * @package IXR
0d28b7c10758 First commit
ymh
parents:
diff changeset
   463
 * @since 1.5
0d28b7c10758 First commit
ymh
parents:
diff changeset
   464
 */
0d28b7c10758 First commit
ymh
parents:
diff changeset
   465
class IXR_Request {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   466
    var $method;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   467
    var $args;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   468
    var $xml;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   469
    function IXR_Request($method, $args) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   470
        $this->method = $method;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   471
        $this->args = $args;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   472
        $this->xml = <<<EOD
0d28b7c10758 First commit
ymh
parents:
diff changeset
   473
<?xml version="1.0"?>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   474
<methodCall>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   475
<methodName>{$this->method}</methodName>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   476
<params>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   477
0d28b7c10758 First commit
ymh
parents:
diff changeset
   478
EOD;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   479
        foreach ($this->args as $arg) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   480
            $this->xml .= '<param><value>';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   481
            $v = new IXR_Value($arg);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   482
            $this->xml .= $v->getXml();
0d28b7c10758 First commit
ymh
parents:
diff changeset
   483
            $this->xml .= "</value></param>\n";
0d28b7c10758 First commit
ymh
parents:
diff changeset
   484
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   485
        $this->xml .= '</params></methodCall>';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   486
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   487
    function getLength() {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   488
        return strlen($this->xml);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   489
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   490
    function getXml() {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   491
        return $this->xml;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   492
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   493
}
0d28b7c10758 First commit
ymh
parents:
diff changeset
   494
0d28b7c10758 First commit
ymh
parents:
diff changeset
   495
/**
0d28b7c10758 First commit
ymh
parents:
diff changeset
   496
 * IXR_Client
0d28b7c10758 First commit
ymh
parents:
diff changeset
   497
 *
0d28b7c10758 First commit
ymh
parents:
diff changeset
   498
 * @package IXR
0d28b7c10758 First commit
ymh
parents:
diff changeset
   499
 * @since 1.5
0d28b7c10758 First commit
ymh
parents:
diff changeset
   500
 */
0d28b7c10758 First commit
ymh
parents:
diff changeset
   501
class IXR_Client {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   502
    var $server;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   503
    var $port;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   504
    var $path;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   505
    var $useragent;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   506
	var $headers;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   507
    var $response;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   508
    var $message = false;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   509
    var $debug = false;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   510
    var $timeout;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   511
    // Storage place for an error message
0d28b7c10758 First commit
ymh
parents:
diff changeset
   512
    var $error = false;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   513
    function IXR_Client($server, $path = false, $port = 80, $timeout = false) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   514
        if (!$path) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   515
            // Assume we have been given a URL instead
0d28b7c10758 First commit
ymh
parents:
diff changeset
   516
            $bits = parse_url($server);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   517
            $this->server = $bits['host'];
0d28b7c10758 First commit
ymh
parents:
diff changeset
   518
            $this->port = isset($bits['port']) ? $bits['port'] : 80;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   519
            $this->path = isset($bits['path']) ? $bits['path'] : '/';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   520
            // Make absolutely sure we have a path
0d28b7c10758 First commit
ymh
parents:
diff changeset
   521
            if (!$this->path) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   522
                $this->path = '/';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   523
            }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   524
        } else {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   525
            $this->server = $server;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   526
            $this->path = $path;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   527
            $this->port = $port;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   528
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   529
        $this->useragent = 'The Incutio XML-RPC PHP Library';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   530
        $this->timeout = $timeout;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   531
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   532
    function query() {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   533
        $args = func_get_args();
0d28b7c10758 First commit
ymh
parents:
diff changeset
   534
        $method = array_shift($args);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   535
        $request = new IXR_Request($method, $args);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   536
        $length = $request->getLength();
0d28b7c10758 First commit
ymh
parents:
diff changeset
   537
        $xml = $request->getXml();
0d28b7c10758 First commit
ymh
parents:
diff changeset
   538
        $r = "\r\n";
0d28b7c10758 First commit
ymh
parents:
diff changeset
   539
        $request  = "POST {$this->path} HTTP/1.0$r";
0d28b7c10758 First commit
ymh
parents:
diff changeset
   540
0d28b7c10758 First commit
ymh
parents:
diff changeset
   541
		$this->headers['Host']			= $this->server;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   542
		$this->headers['Content-Type']	= 'text/xml';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   543
		$this->headers['User-Agent']	= $this->useragent;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   544
		$this->headers['Content-Length']= $length;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   545
0d28b7c10758 First commit
ymh
parents:
diff changeset
   546
		foreach( $this->headers as $header => $value ) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   547
			$request .= "{$header}: {$value}{$r}";
0d28b7c10758 First commit
ymh
parents:
diff changeset
   548
		}
0d28b7c10758 First commit
ymh
parents:
diff changeset
   549
		$request .= $r;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   550
0d28b7c10758 First commit
ymh
parents:
diff changeset
   551
        $request .= $xml;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   552
        // Now send the request
0d28b7c10758 First commit
ymh
parents:
diff changeset
   553
        if ($this->debug) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   554
            echo '<pre class="ixr_request">'.htmlspecialchars($request)."\n</pre>\n\n";
0d28b7c10758 First commit
ymh
parents:
diff changeset
   555
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   556
        if ($this->timeout) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   557
            $fp = @fsockopen($this->server, $this->port, $errno, $errstr, $this->timeout);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   558
        } else {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   559
            $fp = @fsockopen($this->server, $this->port, $errno, $errstr);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   560
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   561
        if (!$fp) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   562
            $this->error = new IXR_Error(-32300, "transport error - could not open socket: $errno $errstr");
0d28b7c10758 First commit
ymh
parents:
diff changeset
   563
            return false;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   564
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   565
        fputs($fp, $request);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   566
        $contents = '';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   567
        $debug_contents = '';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   568
        $gotFirstLine = false;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   569
        $gettingHeaders = true;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   570
        while (!feof($fp)) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   571
            $line = fgets($fp, 4096);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   572
            if (!$gotFirstLine) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   573
                // Check line for '200'
0d28b7c10758 First commit
ymh
parents:
diff changeset
   574
                if (strstr($line, '200') === false) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   575
                    $this->error = new IXR_Error(-32301, 'transport error - HTTP status code was not 200');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   576
                    return false;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   577
                }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   578
                $gotFirstLine = true;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   579
            }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   580
            if (trim($line) == '') {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   581
                $gettingHeaders = false;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   582
            }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   583
            if (!$gettingHeaders) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   584
                $contents .= trim($line);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   585
            }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   586
            if ($this->debug) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   587
                $debug_contents .= $line;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   588
            }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   589
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   590
        if ($this->debug) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   591
            echo '<pre class="ixr_response">'.htmlspecialchars($debug_contents)."\n</pre>\n\n";
0d28b7c10758 First commit
ymh
parents:
diff changeset
   592
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   593
        // Now parse what we've got back
0d28b7c10758 First commit
ymh
parents:
diff changeset
   594
        $this->message = new IXR_Message($contents);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   595
        if (!$this->message->parse()) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   596
            // XML error
0d28b7c10758 First commit
ymh
parents:
diff changeset
   597
            $this->error = new IXR_Error(-32700, 'parse error. not well formed');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   598
            return false;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   599
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   600
        // Is the message a fault?
0d28b7c10758 First commit
ymh
parents:
diff changeset
   601
        if ($this->message->messageType == 'fault') {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   602
            $this->error = new IXR_Error($this->message->faultCode, $this->message->faultString);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   603
            return false;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   604
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   605
        // Message must be OK
0d28b7c10758 First commit
ymh
parents:
diff changeset
   606
        return true;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   607
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   608
    function getResponse() {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   609
        // methodResponses can only have one param - return that
0d28b7c10758 First commit
ymh
parents:
diff changeset
   610
        return $this->message->params[0];
0d28b7c10758 First commit
ymh
parents:
diff changeset
   611
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   612
    function isError() {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   613
        return (is_object($this->error));
0d28b7c10758 First commit
ymh
parents:
diff changeset
   614
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   615
    function getErrorCode() {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   616
        return $this->error->code;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   617
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   618
    function getErrorMessage() {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   619
        return $this->error->message;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   620
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   621
}
0d28b7c10758 First commit
ymh
parents:
diff changeset
   622
0d28b7c10758 First commit
ymh
parents:
diff changeset
   623
/**
0d28b7c10758 First commit
ymh
parents:
diff changeset
   624
 * IXR_Error
0d28b7c10758 First commit
ymh
parents:
diff changeset
   625
 *
0d28b7c10758 First commit
ymh
parents:
diff changeset
   626
 * @package IXR
0d28b7c10758 First commit
ymh
parents:
diff changeset
   627
 * @since 1.5
0d28b7c10758 First commit
ymh
parents:
diff changeset
   628
 */
0d28b7c10758 First commit
ymh
parents:
diff changeset
   629
class IXR_Error {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   630
    var $code;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   631
    var $message;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   632
    function IXR_Error($code, $message) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   633
        $this->code = $code;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   634
        // WP adds htmlspecialchars(). See #5666
0d28b7c10758 First commit
ymh
parents:
diff changeset
   635
        $this->message = htmlspecialchars($message);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   636
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   637
    function getXml() {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   638
        $xml = <<<EOD
0d28b7c10758 First commit
ymh
parents:
diff changeset
   639
<methodResponse>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   640
  <fault>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   641
    <value>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   642
      <struct>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   643
        <member>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   644
          <name>faultCode</name>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   645
          <value><int>{$this->code}</int></value>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   646
        </member>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   647
        <member>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   648
          <name>faultString</name>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   649
          <value><string>{$this->message}</string></value>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   650
        </member>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   651
      </struct>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   652
    </value>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   653
  </fault>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   654
</methodResponse>
0d28b7c10758 First commit
ymh
parents:
diff changeset
   655
0d28b7c10758 First commit
ymh
parents:
diff changeset
   656
EOD;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   657
        return $xml;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   658
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   659
}
0d28b7c10758 First commit
ymh
parents:
diff changeset
   660
0d28b7c10758 First commit
ymh
parents:
diff changeset
   661
/**
0d28b7c10758 First commit
ymh
parents:
diff changeset
   662
 * IXR_Date
0d28b7c10758 First commit
ymh
parents:
diff changeset
   663
 *
0d28b7c10758 First commit
ymh
parents:
diff changeset
   664
 * @package IXR
0d28b7c10758 First commit
ymh
parents:
diff changeset
   665
 * @since 1.5
0d28b7c10758 First commit
ymh
parents:
diff changeset
   666
 */
0d28b7c10758 First commit
ymh
parents:
diff changeset
   667
class IXR_Date {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   668
    var $year;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   669
    var $month;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   670
    var $day;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   671
    var $hour;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   672
    var $minute;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   673
    var $second;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   674
    var $timezone;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   675
    function IXR_Date($time) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   676
        // $time can be a PHP timestamp or an ISO one
0d28b7c10758 First commit
ymh
parents:
diff changeset
   677
        if (is_numeric($time)) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   678
            $this->parseTimestamp($time);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   679
        } else {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   680
            $this->parseIso($time);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   681
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   682
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   683
    function parseTimestamp($timestamp) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   684
        $this->year = date('Y', $timestamp);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   685
        $this->month = date('m', $timestamp);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   686
        $this->day = date('d', $timestamp);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   687
        $this->hour = date('H', $timestamp);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   688
        $this->minute = date('i', $timestamp);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   689
        $this->second = date('s', $timestamp);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   690
        // WP adds timezone. See #2036
0d28b7c10758 First commit
ymh
parents:
diff changeset
   691
        $this->timezone = '';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   692
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   693
    function parseIso($iso) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   694
        $this->year = substr($iso, 0, 4);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   695
        $this->month = substr($iso, 4, 2);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   696
        $this->day = substr($iso, 6, 2);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   697
        $this->hour = substr($iso, 9, 2);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   698
        $this->minute = substr($iso, 12, 2);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   699
        $this->second = substr($iso, 15, 2);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   700
        // WP adds timezone. See #2036
0d28b7c10758 First commit
ymh
parents:
diff changeset
   701
        $this->timezone = substr($iso, 17);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   702
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   703
    function getIso() {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   704
    	// WP adds timezone. See #2036
0d28b7c10758 First commit
ymh
parents:
diff changeset
   705
        return $this->year.$this->month.$this->day.'T'.$this->hour.':'.$this->minute.':'.$this->second.$this->timezone;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   706
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   707
    function getXml() {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   708
        return '<dateTime.iso8601>'.$this->getIso().'</dateTime.iso8601>';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   709
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   710
    function getTimestamp() {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   711
        return mktime($this->hour, $this->minute, $this->second, $this->month, $this->day, $this->year);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   712
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   713
}
0d28b7c10758 First commit
ymh
parents:
diff changeset
   714
0d28b7c10758 First commit
ymh
parents:
diff changeset
   715
/**
0d28b7c10758 First commit
ymh
parents:
diff changeset
   716
 * IXR_Base64
0d28b7c10758 First commit
ymh
parents:
diff changeset
   717
 *
0d28b7c10758 First commit
ymh
parents:
diff changeset
   718
 * @package IXR
0d28b7c10758 First commit
ymh
parents:
diff changeset
   719
 * @since 1.5
0d28b7c10758 First commit
ymh
parents:
diff changeset
   720
 */
0d28b7c10758 First commit
ymh
parents:
diff changeset
   721
class IXR_Base64 {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   722
    var $data;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   723
    function IXR_Base64($data) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   724
        $this->data = $data;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   725
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   726
    function getXml() {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   727
        return '<base64>'.base64_encode($this->data).'</base64>';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   728
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   729
}
0d28b7c10758 First commit
ymh
parents:
diff changeset
   730
0d28b7c10758 First commit
ymh
parents:
diff changeset
   731
/**
0d28b7c10758 First commit
ymh
parents:
diff changeset
   732
 * IXR_IntrospectionServer
0d28b7c10758 First commit
ymh
parents:
diff changeset
   733
 *
0d28b7c10758 First commit
ymh
parents:
diff changeset
   734
 * @package IXR
0d28b7c10758 First commit
ymh
parents:
diff changeset
   735
 * @since 1.5
0d28b7c10758 First commit
ymh
parents:
diff changeset
   736
 */
0d28b7c10758 First commit
ymh
parents:
diff changeset
   737
class IXR_IntrospectionServer extends IXR_Server {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   738
    var $signatures;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   739
    var $help;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   740
    function IXR_IntrospectionServer() {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   741
        $this->setCallbacks();
0d28b7c10758 First commit
ymh
parents:
diff changeset
   742
        $this->setCapabilities();
0d28b7c10758 First commit
ymh
parents:
diff changeset
   743
        $this->capabilities['introspection'] = array(
0d28b7c10758 First commit
ymh
parents:
diff changeset
   744
            'specUrl' => 'http://xmlrpc.usefulinc.com/doc/reserved.html',
0d28b7c10758 First commit
ymh
parents:
diff changeset
   745
            'specVersion' => 1
0d28b7c10758 First commit
ymh
parents:
diff changeset
   746
        );
0d28b7c10758 First commit
ymh
parents:
diff changeset
   747
        $this->addCallback(
0d28b7c10758 First commit
ymh
parents:
diff changeset
   748
            'system.methodSignature',
0d28b7c10758 First commit
ymh
parents:
diff changeset
   749
            'this:methodSignature',
0d28b7c10758 First commit
ymh
parents:
diff changeset
   750
            array('array', 'string'),
0d28b7c10758 First commit
ymh
parents:
diff changeset
   751
            'Returns an array describing the return type and required parameters of a method'
0d28b7c10758 First commit
ymh
parents:
diff changeset
   752
        );
0d28b7c10758 First commit
ymh
parents:
diff changeset
   753
        $this->addCallback(
0d28b7c10758 First commit
ymh
parents:
diff changeset
   754
            'system.getCapabilities',
0d28b7c10758 First commit
ymh
parents:
diff changeset
   755
            'this:getCapabilities',
0d28b7c10758 First commit
ymh
parents:
diff changeset
   756
            array('struct'),
0d28b7c10758 First commit
ymh
parents:
diff changeset
   757
            'Returns a struct describing the XML-RPC specifications supported by this server'
0d28b7c10758 First commit
ymh
parents:
diff changeset
   758
        );
0d28b7c10758 First commit
ymh
parents:
diff changeset
   759
        $this->addCallback(
0d28b7c10758 First commit
ymh
parents:
diff changeset
   760
            'system.listMethods',
0d28b7c10758 First commit
ymh
parents:
diff changeset
   761
            'this:listMethods',
0d28b7c10758 First commit
ymh
parents:
diff changeset
   762
            array('array'),
0d28b7c10758 First commit
ymh
parents:
diff changeset
   763
            'Returns an array of available methods on this server'
0d28b7c10758 First commit
ymh
parents:
diff changeset
   764
        );
0d28b7c10758 First commit
ymh
parents:
diff changeset
   765
        $this->addCallback(
0d28b7c10758 First commit
ymh
parents:
diff changeset
   766
            'system.methodHelp',
0d28b7c10758 First commit
ymh
parents:
diff changeset
   767
            'this:methodHelp',
0d28b7c10758 First commit
ymh
parents:
diff changeset
   768
            array('string', 'string'),
0d28b7c10758 First commit
ymh
parents:
diff changeset
   769
            'Returns a documentation string for the specified method'
0d28b7c10758 First commit
ymh
parents:
diff changeset
   770
        );
0d28b7c10758 First commit
ymh
parents:
diff changeset
   771
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   772
    function addCallback($method, $callback, $args, $help) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   773
        $this->callbacks[$method] = $callback;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   774
        $this->signatures[$method] = $args;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   775
        $this->help[$method] = $help;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   776
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   777
    function call($methodname, $args) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   778
        // Make sure it's in an array
0d28b7c10758 First commit
ymh
parents:
diff changeset
   779
        if ($args && !is_array($args)) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   780
            $args = array($args);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   781
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   782
        // Over-rides default call method, adds signature check
0d28b7c10758 First commit
ymh
parents:
diff changeset
   783
        if (!$this->hasMethod($methodname)) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   784
            return new IXR_Error(-32601, 'server error. requested method "'.$this->message->methodName.'" not specified.');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   785
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   786
        $method = $this->callbacks[$methodname];
0d28b7c10758 First commit
ymh
parents:
diff changeset
   787
        $signature = $this->signatures[$methodname];
0d28b7c10758 First commit
ymh
parents:
diff changeset
   788
        $returnType = array_shift($signature);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   789
        // Check the number of arguments
0d28b7c10758 First commit
ymh
parents:
diff changeset
   790
        if (count($args) != count($signature)) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   791
            return new IXR_Error(-32602, 'server error. wrong number of method parameters');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   792
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   793
        // Check the argument types
0d28b7c10758 First commit
ymh
parents:
diff changeset
   794
        $ok = true;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   795
        $argsbackup = $args;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   796
        for ($i = 0, $j = count($args); $i < $j; $i++) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   797
            $arg = array_shift($args);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   798
            $type = array_shift($signature);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   799
            switch ($type) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   800
                case 'int':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   801
                case 'i4':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   802
                    if (is_array($arg) || !is_int($arg)) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   803
                        $ok = false;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   804
                    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   805
                    break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   806
                case 'base64':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   807
                case 'string':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   808
                    if (!is_string($arg)) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   809
                        $ok = false;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   810
                    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   811
                    break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   812
                case 'boolean':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   813
                    if ($arg !== false && $arg !== true) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   814
                        $ok = false;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   815
                    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   816
                    break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   817
                case 'float':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   818
                case 'double':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   819
                    if (!is_float($arg)) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   820
                        $ok = false;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   821
                    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   822
                    break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   823
                case 'date':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   824
                case 'dateTime.iso8601':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   825
                    if (!is_a($arg, 'IXR_Date')) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   826
                        $ok = false;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   827
                    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   828
                    break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   829
            }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   830
            if (!$ok) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   831
                return new IXR_Error(-32602, 'server error. invalid method parameters');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   832
            }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   833
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   834
        // It passed the test - run the "real" method call
0d28b7c10758 First commit
ymh
parents:
diff changeset
   835
        return parent::call($methodname, $argsbackup);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   836
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   837
    function methodSignature($method) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   838
        if (!$this->hasMethod($method)) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   839
            return new IXR_Error(-32601, 'server error. requested method "'.$method.'" not specified.');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   840
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   841
        // We should be returning an array of types
0d28b7c10758 First commit
ymh
parents:
diff changeset
   842
        $types = $this->signatures[$method];
0d28b7c10758 First commit
ymh
parents:
diff changeset
   843
        $return = array();
0d28b7c10758 First commit
ymh
parents:
diff changeset
   844
        foreach ($types as $type) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   845
            switch ($type) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   846
                case 'string':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   847
                    $return[] = 'string';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   848
                    break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   849
                case 'int':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   850
                case 'i4':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   851
                    $return[] = 42;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   852
                    break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   853
                case 'double':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   854
                    $return[] = 3.1415;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   855
                    break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   856
                case 'dateTime.iso8601':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   857
                    $return[] = new IXR_Date(time());
0d28b7c10758 First commit
ymh
parents:
diff changeset
   858
                    break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   859
                case 'boolean':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   860
                    $return[] = true;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   861
                    break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   862
                case 'base64':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   863
                    $return[] = new IXR_Base64('base64');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   864
                    break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   865
                case 'array':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   866
                    $return[] = array('array');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   867
                    break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   868
                case 'struct':
0d28b7c10758 First commit
ymh
parents:
diff changeset
   869
                    $return[] = array('struct' => 'struct');
0d28b7c10758 First commit
ymh
parents:
diff changeset
   870
                    break;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   871
            }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   872
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   873
        return $return;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   874
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   875
    function methodHelp($method) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   876
        return $this->help[$method];
0d28b7c10758 First commit
ymh
parents:
diff changeset
   877
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   878
}
0d28b7c10758 First commit
ymh
parents:
diff changeset
   879
0d28b7c10758 First commit
ymh
parents:
diff changeset
   880
/**
0d28b7c10758 First commit
ymh
parents:
diff changeset
   881
 * IXR_ClientMulticall
0d28b7c10758 First commit
ymh
parents:
diff changeset
   882
 *
0d28b7c10758 First commit
ymh
parents:
diff changeset
   883
 * @package IXR
0d28b7c10758 First commit
ymh
parents:
diff changeset
   884
 * @since 1.5
0d28b7c10758 First commit
ymh
parents:
diff changeset
   885
 */
0d28b7c10758 First commit
ymh
parents:
diff changeset
   886
class IXR_ClientMulticall extends IXR_Client {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   887
    var $calls = array();
0d28b7c10758 First commit
ymh
parents:
diff changeset
   888
    function IXR_ClientMulticall($server, $path = false, $port = 80) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   889
        parent::IXR_Client($server, $path, $port);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   890
        $this->useragent = 'The Incutio XML-RPC PHP Library (multicall client)';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   891
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   892
    function addCall() {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   893
        $args = func_get_args();
0d28b7c10758 First commit
ymh
parents:
diff changeset
   894
        $methodName = array_shift($args);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   895
        $struct = array(
0d28b7c10758 First commit
ymh
parents:
diff changeset
   896
            'methodName' => $methodName,
0d28b7c10758 First commit
ymh
parents:
diff changeset
   897
            'params' => $args
0d28b7c10758 First commit
ymh
parents:
diff changeset
   898
        );
0d28b7c10758 First commit
ymh
parents:
diff changeset
   899
        $this->calls[] = $struct;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   900
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   901
    function query() {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   902
        // Prepare multicall, then call the parent::query() method
0d28b7c10758 First commit
ymh
parents:
diff changeset
   903
        return parent::query('system.multicall', $this->calls);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   904
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   905
}
0d28b7c10758 First commit
ymh
parents:
diff changeset
   906
0d28b7c10758 First commit
ymh
parents:
diff changeset
   907
?>