Source code for file /phpxmlrpc/xmlrpc.php
Documentation is available at xmlrpc.php
// by Edd Dumbill (C) 1999-2002
// $Id: xmlrpc.inc,v 1.124 2006/04/22 21:34:31 ggiunta Exp $
// Copyright (c) 1999,2000,2002 Edd Dumbill.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following
// disclaimer in the documentation and/or other materials provided
// with the distribution.
// * Neither the name of the "XML-RPC for PHP" nor the names of its
// contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
// REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
// OF THE POSSIBILITY OF SUCH DAMAGE.
// For PHP 4 onward, XML functionality is always compiled-in on windows:
// no more need to dl-open it. It might have been compiled out on *nix...
// Try to be backward compat with php < 4.2 (are we not being nice ?)
// give an opportunity to user to specify where to include other files from
if(!defined('PHP_XMLRPC_COMPAT_DIR'))
define('PHP_XMLRPC_COMPAT_DIR',dirname(__FILE__
).
'/compat/');
include(PHP_XMLRPC_COMPAT_DIR.
"is_scalar.php");
include(PHP_XMLRPC_COMPAT_DIR.
"array_key_exists.php");
include(PHP_XMLRPC_COMPAT_DIR.
"version_compare.php");
include(PHP_XMLRPC_COMPAT_DIR.
"var_export.php");
include(PHP_XMLRPC_COMPAT_DIR.
"is_a.php");
// G. Giunta 2005/01/29: declare global these variables,
// so that xmlrpc.inc will work even if included from within a function
// Milosch: 2005/08/07 - explicitly request these via $GLOBALS where used.
$GLOBALS['xmlrpcI4']=
'i4';
$GLOBALS['xmlrpcInt']=
'int';
$GLOBALS['xmlrpcBoolean']=
'boolean';
$GLOBALS['xmlrpcDouble']=
'double';
$GLOBALS['xmlrpcString']=
'string';
$GLOBALS['xmlrpcDateTime']=
'dateTime.iso8601';
$GLOBALS['xmlrpcBase64']=
'base64';
$GLOBALS['xmlrpcArray']=
'array';
$GLOBALS['xmlrpcStruct']=
'struct';
$GLOBALS['xmlrpcValue']=
'undefined';
$GLOBALS['xmlrpcTypes']=
array(
$GLOBALS['xmlrpcI4'] =>
1,
$GLOBALS['xmlrpcInt'] =>
1,
$GLOBALS['xmlrpcBoolean'] =>
1,
$GLOBALS['xmlrpcString'] =>
1,
$GLOBALS['xmlrpcDouble'] =>
1,
$GLOBALS['xmlrpcDateTime'] =>
1,
$GLOBALS['xmlrpcBase64'] =>
1,
$GLOBALS['xmlrpcArray'] =>
2,
$GLOBALS['xmlrpcStruct'] =>
3
$GLOBALS['xmlrpc_valid_parents'] =
array(
'BOOLEAN' =>
array('VALUE'),
'STRING' =>
array('VALUE'),
'DOUBLE' =>
array('VALUE'),
'DATETIME.ISO8601' =>
array('VALUE'),
'BASE64' =>
array('VALUE'),
'ARRAY' =>
array('VALUE'),
'STRUCT' =>
array('VALUE'),
'PARAM' =>
array('PARAMS'),
'METHODNAME' =>
array('METHODCALL'),
'PARAMS' =>
array('METHODCALL', 'METHODRESPONSE'),
'MEMBER' =>
array('STRUCT'),
'NAME' =>
array('MEMBER'),
'DATA' =>
array('ARRAY'),
'FAULT' =>
array('METHODRESPONSE'),
'VALUE' =>
array('MEMBER', 'DATA', 'PARAM', 'FAULT'),
// define extra types for supporting NULL (useful for json or <NIL/>)
$GLOBALS['xmlrpcNull']=
'null';
$GLOBALS['xmlrpcTypes']['null']=
1;
// Not in use anymore since 2.0. Shall we remove it?
$GLOBALS['xmlEntities']=
array(
// tables used for transcoding different charsets into us-ascii xml
$GLOBALS['xml_iso88591_Entities']=
array();
$GLOBALS['xml_iso88591_Entities']['in'] =
array();
$GLOBALS['xml_iso88591_Entities']['out'] =
array();
for ($i =
0; $i <
32; $i++
)
$GLOBALS['xml_iso88591_Entities']['in'][] =
chr($i);
$GLOBALS['xml_iso88591_Entities']['out'][] =
"&#$i;";
for ($i =
160; $i <
256; $i++
)
$GLOBALS['xml_iso88591_Entities']['in'][] =
chr($i);
$GLOBALS['xml_iso88591_Entities']['out'][] =
"&#$i;";
/// @todo add to iso table the characters from cp_1252 range, i.e. 128 to 159.
/// These will NOT be present in true ISO-8859-1, but will save the unwary
/// windows user from sending junk.
'\x80'=>'€', '\x81'=>'?', '\x82'=>'‚', '\x83'=>'ƒ',
'\x84'=>'„', '\x85'=>'…', '\x86'=>'†', \x87'=>'‡',
'\x88'=>'ˆ', '\x89'=>'‰', '\x8A'=>'Š', '\x8B'=>'‹',
'\x8C'=>'Œ', '\x8D'=>'?', '\x8E'=>'Ž', '\x8F'=>'?',
'\x90'=>'?', '\x91'=>'‘', '\x92'=>'’', '\x93'=>'“',
'\x94'=>'”', '\x95'=>'•', '\x96'=>'–', '\x97'=>'—',
'\x98'=>'˜', '\x99'=>'™', '\x9A'=>'š', '\x9B'=>'›',
'\x9C'=>'œ', '\x9D'=>'?', '\x9E'=>'ž', '\x9F'=>'Ÿ'
$GLOBALS['xmlrpcerr']['unknown_method']=
1;
$GLOBALS['xmlrpcstr']['unknown_method']=
'Unknown method';
$GLOBALS['xmlrpcerr']['invalid_return']=
2;
$GLOBALS['xmlrpcstr']['invalid_return']=
'Invalid return payload: enable debugging to examine incoming payload';
$GLOBALS['xmlrpcerr']['incorrect_params']=
3;
$GLOBALS['xmlrpcstr']['incorrect_params']=
'Incorrect parameters passed to method';
$GLOBALS['xmlrpcerr']['introspect_unknown']=
4;
$GLOBALS['xmlrpcstr']['introspect_unknown']=
"Can't introspect: method unknown";
$GLOBALS['xmlrpcerr']['http_error']=
5;
$GLOBALS['xmlrpcstr']['http_error']=
"Didn't receive 200 OK from remote server.";
$GLOBALS['xmlrpcerr']['no_data']=
6;
$GLOBALS['xmlrpcstr']['no_data']=
'No data received from server.';
$GLOBALS['xmlrpcerr']['no_ssl']=
7;
$GLOBALS['xmlrpcstr']['no_ssl']=
'No SSL support compiled in.';
$GLOBALS['xmlrpcerr']['curl_fail']=
8;
$GLOBALS['xmlrpcstr']['curl_fail']=
'CURL error';
$GLOBALS['xmlrpcerr']['invalid_request']=
15;
$GLOBALS['xmlrpcstr']['invalid_request']=
'Invalid request payload';
$GLOBALS['xmlrpcerr']['no_curl']=
16;
$GLOBALS['xmlrpcstr']['no_curl']=
'No CURL support compiled in.';
$GLOBALS['xmlrpcerr']['server_error']=
17;
$GLOBALS['xmlrpcstr']['server_error']=
'Internal server error';
$GLOBALS['xmlrpcerr']['multicall_error']=
18;
$GLOBALS['xmlrpcstr']['multicall_error']=
'Received from server invalid multicall response';
$GLOBALS['xmlrpcerr']['multicall_notstruct'] =
9;
$GLOBALS['xmlrpcstr']['multicall_notstruct'] =
'system.multicall expected struct';
$GLOBALS['xmlrpcerr']['multicall_nomethod'] =
10;
$GLOBALS['xmlrpcstr']['multicall_nomethod'] =
'missing methodName';
$GLOBALS['xmlrpcerr']['multicall_notstring'] =
11;
$GLOBALS['xmlrpcstr']['multicall_notstring'] =
'methodName is not a string';
$GLOBALS['xmlrpcerr']['multicall_recursion'] =
12;
$GLOBALS['xmlrpcstr']['multicall_recursion'] =
'recursive system.multicall forbidden';
$GLOBALS['xmlrpcerr']['multicall_noparams'] =
13;
$GLOBALS['xmlrpcstr']['multicall_noparams'] =
'missing params';
$GLOBALS['xmlrpcerr']['multicall_notarray'] =
14;
$GLOBALS['xmlrpcstr']['multicall_notarray'] =
'params is not an array';
$GLOBALS['xmlrpcerr']['cannot_decompress']=
103;
$GLOBALS['xmlrpcstr']['cannot_decompress']=
'Received from server compressed HTTP and cannot decompress';
$GLOBALS['xmlrpcerr']['decompress_fail']=
104;
$GLOBALS['xmlrpcstr']['decompress_fail']=
'Received from server invalid compressed HTTP';
$GLOBALS['xmlrpcerr']['dechunk_fail']=
105;
$GLOBALS['xmlrpcstr']['dechunk_fail']=
'Received from server invalid chunked HTTP';
$GLOBALS['xmlrpcerr']['server_cannot_decompress']=
106;
$GLOBALS['xmlrpcstr']['server_cannot_decompress']=
'Received from client compressed HTTP request and cannot decompress';
$GLOBALS['xmlrpcerr']['server_decompress_fail']=
107;
$GLOBALS['xmlrpcstr']['server_decompress_fail']=
'Received from client invalid compressed HTTP request';
// The charset encoding used by the server for received messages and
// by the client for received responses when received charset cannot be determined
$GLOBALS['xmlrpc_defencoding']=
'UTF-8';
// The encoding used internally by PHP.
// String values received as xml will be converted to this, and php strings will be converted to xml
// as if having been coded with this
$GLOBALS['xmlrpc_internalencoding']=
'ISO-8859-1';
$GLOBALS['xmlrpcName']=
'XML-RPC for PHP';
$GLOBALS['xmlrpcVersion']=
'2.0';
// let user errors start at 800
$GLOBALS['xmlrpcerruser']=
800;
// let XML parse errors start at 100
$GLOBALS['xmlrpcerrxml']=
100;
// formulate backslashes for escaping regexp
// Not in use anymore since 2.0. Shall we remove it?
$GLOBALS['xmlrpc_backslash']=
chr(92).
chr(92);
// used to store state during parsing
// quick explanation of components:
// ac - used to accumulate values
// isf - used to indicate a fault
// lv - used to indicate "looking for a value": implements
// the logic to allow values with no types to be strings
// params - used to store parameters in method calls
// method - used to store method name
// stack - array with genealogy of xml elements names:
// used to validate nesting of xmlrpc elements
* Convert a string to the correct XML representation in a target charset
* To help correct communication of non-ascii chars inside strings, regardless
* of the charset used when sending requests, parsing them, sending responses
* and parsing responses, an option is to convert all non-ascii chars present in the message
* into their equivalent 'charset entity'. Charset entities enumerated this way
* are independent of the charset encoding used to transmit them, and all XML
* parsers are bound to understand them.
* Note that in the std case we are not sending a charset encoding mime type
* along with http headers, so we are bound by RFC 3023 to emit strict us-ascii.
* @todo do a bit of basic benchmarking (strtr vs. str_replace)
* @todo make usage of iconv() or recode_string() or mb_string() where available
// lame, but we know no better...
$src_encoding =
$GLOBALS['xmlrpc_internalencoding'];
//if ($dest_encoding == '')
// // lame, but we know no better...
// $dest_encoding = 'US-ASCII';
switch(strtoupper($src_encoding.
'_'.
$dest_encoding))
case 'ISO-8859-1_US-ASCII':
$escaped_data =
str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
$escaped_data =
str_replace($GLOBALS['xml_iso88591_Entities']['in'], $GLOBALS['xml_iso88591_Entities']['out'], $escaped_data);
$escaped_data =
str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
case 'ISO-8859-1_ISO-8859-1':
case 'US-ASCII_US-ASCII':
case 'US-ASCII_ISO-8859-1':
$escaped_data =
str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
// NB: this will choke on invalid UTF-8, going most likely beyond EOF
// be kind to users creating string xmlrpcvals out of different php types
for ($nn =
0; $nn <
$ns; $nn++
)
/// @todo shall we replace this with a (supposedly) faster str_replace?
$escaped_data .=
'"';
$escaped_data .=
'&';
$escaped_data .=
''';
//2 11 110bbbbb 10bbbbbb (2047)
//3 16 1110bbbb 10bbbbbb 10bbbbbb
$ii =
((($b1 *
64) +
$b2) *
64) +
$b3;
//4 21 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb
$ii =
((((($b1 *
64) +
$b2) *
64) +
$b3) *
64) +
$b4;
error_log("Converting from $src_encoding to $dest_encoding: not supported...");
// if invalid xmlrpc already detected, skip all processing
if ($GLOBALS['_xh']['isf'] <
2)
// check for correct element nesting
// top level element can only be of 2 types
if (count($GLOBALS['_xh']['stack']) ==
0)
if ($name !=
'METHODRESPONSE' &&
$name !=
'METHODCALL')
$GLOBALS['_xh']['isf'] =
2;
$GLOBALS['_xh']['isf_reason'] =
'missing top level xmlrpc element';
// not top level element: see if parent is OK
$parent =
end($GLOBALS['_xh']['stack']);
if (!array_key_exists($name, $GLOBALS['xmlrpc_valid_parents']) ||
!in_array($parent, $GLOBALS['xmlrpc_valid_parents'][$name]))
$GLOBALS['_xh']['isf'] =
2;
$GLOBALS['_xh']['isf_reason'] =
"xmlrpc element $name cannot be child of $parent";
// create an empty array to hold child values, and push it onto appropriate stack
$cur_val['values'] =
array();
$cur_val['type'] =
$name;
// check for out-of-band information to rebuild php objs
// and in case it is found, save it
if (@isset
($attrs['PHP_CLASS']))
$cur_val['php_class'] =
$attrs['PHP_CLASS'];
$GLOBALS['_xh']['valuestack'][] =
$cur_val;
// valid elements that add little to processing
$GLOBALS['_xh']['ac']=
'';
$GLOBALS['_xh']['isf']=
1;
$GLOBALS['_xh']['vt']=
'value'; // indicator: no value found yet
$GLOBALS['_xh']['ac']=
'';
$GLOBALS['_xh']['php_class']=
null;
if ($GLOBALS['_xh']['vt']!=
'value')
//two data elements inside a value: an error occurred!
$GLOBALS['_xh']['isf'] =
2;
$GLOBALS['_xh']['isf_reason'] =
"$name element following a {$GLOBALS['_xh']['vt']} element inside a single value";
$GLOBALS['_xh']['ac']=
''; // reset the accumulator
$GLOBALS['_xh']['valuestack'][count($GLOBALS['_xh']['valuestack'])-
1]['name']=
''; // set member name to null, in case we do not find in the xml later on
//$GLOBALS['_xh']['ac']='';
// Drop trough intentionally
// clear value type, so we can check later if no value has been passed for this param/member
$GLOBALS['_xh']['vt']=
null;
/// INVALID ELEMENT: RAISE ISF so that it is later recognized!!!
$GLOBALS['_xh']['isf'] =
2;
$GLOBALS['_xh']['isf_reason'] =
"found not-xmlrpc xml element $name";
// Save current element name to stack, to validate nesting
$GLOBALS['_xh']['stack'][] =
$name;
function xmlrpc_ee($parser, $name, $rebuild_xmlrpcvals =
true)
if ($GLOBALS['_xh']['isf'] <
2)
// push this element name from stack
// NB: if XML validates, correct opening/closing is guaranteed and
// we do not have to check for $name == $curr_elem.
// we also checked for proper nesting at start of elements...
$curr_elem =
array_pop($GLOBALS['_xh']['stack']);
// fetch out of stack array of values, and promote it to current value
$curr_val =
array_pop($GLOBALS['_xh']['valuestack']);
$GLOBALS['_xh']['value'] =
$curr_val['values'];
if (isset
($curr_val['php_class']))
$GLOBALS['_xh']['php_class'] =
$curr_val['php_class'];
$GLOBALS['_xh']['valuestack'][count($GLOBALS['_xh']['valuestack'])-
1]['name'] =
$GLOBALS['_xh']['ac'];
$GLOBALS['_xh']['value']=
$GLOBALS['_xh']['ac'];
elseif ($name==
'DATETIME.ISO8601')
/// @todo validate datetime values with a correct format mask?
$GLOBALS['_xh']['vt']=
$GLOBALS['xmlrpcDateTime'];
$GLOBALS['_xh']['value']=
$GLOBALS['_xh']['ac'];
/// @todo check for failure of base64 decoding / catch warnings
elseif ($name==
'BOOLEAN')
// special case here: we translate boolean 1 or 0 into PHP
// constants true or false.
// Strings 'true' and 'false' are accepted, even though the
// spec never mentions them (see eg. Blogger api docs)
// NB: this simple checks helps a lot sanitizing input, ie no
// security problems around here
if ($GLOBALS['_xh']['ac']==
'1' ||
strcasecmp($GLOBALS['_xh']['ac'], 'true') ==
0)
$GLOBALS['_xh']['value']=
true;
// log if receiveing something strange, even though we set the value to false anyway
if ($GLOBALS['_xh']['ac']!=
'0' &&
strcasecmp($_xh[$parser]['ac'], 'false') !=
0)
error_log('XML-RPC: invalid value received in BOOLEAN: '.
$GLOBALS['_xh']['ac']);
$GLOBALS['_xh']['value']=
false;
// we must check that only 0123456789-.<space> are characters here
if (!ereg("^[+-]?[eE0123456789 \\t.]+$", $GLOBALS['_xh']['ac']))
/// @todo: find a better way of throwing an error
error_log('XML-RPC: non numeric value received in DOUBLE: '.
$GLOBALS['_xh']['ac']);
$GLOBALS['_xh']['value']=
'ERROR_NON_NUMERIC_FOUND';
$GLOBALS['_xh']['value']=(double)
$GLOBALS['_xh']['ac'];
// we must check that only 0123456789-<space> are characters here
if (!ereg("^[+-]?[0123456789 \\t]+$", $GLOBALS['_xh']['ac']))
/// @todo find a better way of throwing an error
error_log('XML-RPC: non numeric value received in INT: '.
$GLOBALS['_xh']['ac']);
$GLOBALS['_xh']['value']=
'ERROR_NON_NUMERIC_FOUND';
$GLOBALS['_xh']['value']=(int)
$GLOBALS['_xh']['ac'];
$GLOBALS['_xh']['ac']=
''; // is this necessary?
$GLOBALS['_xh']['lv']=
3; // indicate we've found a value
// This if() detects if no scalar was inside <VALUE></VALUE>
if ($GLOBALS['_xh']['vt']==
'value')
$GLOBALS['_xh']['value']=
$GLOBALS['_xh']['ac'];
$GLOBALS['_xh']['vt']=
$GLOBALS['xmlrpcString'];
// build the xmlrpc val out of the data received, and substitute it
$temp =
new xmlrpcval($GLOBALS['_xh']['value'], $GLOBALS['_xh']['vt']);
// in case we got info about underlying php class, save it
// in the object we're rebuilding
if (isset
($GLOBALS['_xh']['php_class']))
$temp->_php_class =
$GLOBALS['_xh']['php_class'];
// check if we are inside an array or struct:
// if value just built is inside an array, let's move it into array on the stack
$vscount =
count($GLOBALS['_xh']['valuestack']);
if ($vscount &&
$GLOBALS['_xh']['valuestack'][$vscount-
1]['type']==
'ARRAY')
$GLOBALS['_xh']['valuestack'][$vscount-
1]['values'][] =
$temp;
$GLOBALS['_xh']['value'] =
$temp;
/// @todo this needs to treat correctly php-serialized objects,
/// since std deserializing is done by php_xmlrpc_decode,
/// which we will not be calling...
if (isset
($GLOBALS['_xh']['php_class']))
// check if we are inside an array or struct:
// if value just built is inside an array, let's move it into array on the stack
$vscount =
count($GLOBALS['_xh']['valuestack']);
if ($vscount &&
$GLOBALS['_xh']['valuestack'][$vscount-
1]['type']==
'ARRAY')
$GLOBALS['_xh']['valuestack'][$vscount-
1]['values'][] =
$GLOBALS['_xh']['value'];
$GLOBALS['_xh']['ac']=
''; // is this necessary?
// add to array in the stack the last element built,
// unless no VALUE was found
if ($GLOBALS['_xh']['vt'])
$vscount =
count($GLOBALS['_xh']['valuestack']);
$GLOBALS['_xh']['valuestack'][$vscount-
1]['values'][$GLOBALS['_xh']['valuestack'][$vscount-
1]['name']] =
$GLOBALS['_xh']['value'];
error_log('XML-RPC: missing VALUE inside STRUCT in received xml');
$GLOBALS['_xh']['ac']=
''; // is this necessary?
// add to array of params the current value,
// unless no VALUE was found
if ($GLOBALS['_xh']['vt'])
$GLOBALS['_xh']['params'][]=
$GLOBALS['_xh']['value'];
$GLOBALS['_xh']['pt'][]=
$GLOBALS['_xh']['vt'];
error_log('XML-RPC: missing VALUE inside PARAM in received xml');
$GLOBALS['_xh']['method']=
ereg_replace("^[\n\r\t ]+", '', $GLOBALS['_xh']['ac']);
// End of INVALID ELEMENT!
// shall we add an assert here for unreachable code???
//if(ereg("^[\n\r \t]+$", $data)) return;
// print "adding [${data}]\n";
// skip processing if xml fault already detected
if ($GLOBALS['_xh']['isf'] <
2)
if($GLOBALS['_xh']['lv']!=
3)
// "lookforvalue==3" means that we've found an entire value
// and should discard any further character data
if($GLOBALS['_xh']['lv']==
1)
// if we've found text and we're just in a <value> then
// say we've found a value
if(!@isset
($GLOBALS['_xh']['ac']))
$GLOBALS['_xh']['ac'] =
'';
$GLOBALS['_xh']['ac'].=
$data;
// skip processing if xml fault already detected
if ($GLOBALS['_xh']['isf'] <
2)
if(substr($data, 0, 1) ==
'&' &&
substr($data, -
1, 1) ==
';')
if($GLOBALS['_xh']['lv']==
1)
$GLOBALS['_xh']['ac'].=
$data;
* List of http compression methods accepted by the client for responses.
* NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib
* NNB: you can set it to any non-empty array for HTTP11 and HTTPS, since
* in those cases it will be up to CURL to decide the compression methods
* it supports. You might check for the presence of 'zlib' in the output of
* curl_version() to determine wheter compression is supported or not
* Name of compression scheme to be used for sending requests.
* Either null, gzip or deflate
* CURL handle: used for keep-alive connections (PHP 4.3.8 up, see:
* http://curl.haxx.se/docs/faq.html#7.3)
/// Wheter to use persistent connections for http 1.1 and https
/// Charset encodings that can be decoded without problems by the client
/// Charset encoding to be used in serializing request. NULL = use ASCII
* Decides the content of xmlrpcresp objects returned by calls to send()
* valid strings are 'xmlrpcvals', 'phpvals' or 'xml'
* @param string $path either the complete server URL or the PATH part of the xmlrc server URL, e.g. /xmlrpc/server.php
* @param string $server the server name / ip address
* @param integer $port the port the server is listening on, defaults to 80 or 443 depending on protocol used
* @param string $method the http protocol variant: defaults to 'http', 'https' and 'http11' can be used if CURL is installed
// allow user to specify all params in $path
if($server ==
'' and $port ==
'' and $method ==
'')
$server =
$parts['host'];
if(isset
($parts['query']))
$path .=
'?'.
$parts['query'];
if(isset
($parts['fragment']))
$path .=
'#'.
$parts['fragment'];
if(isset
($parts['port']))
if(isset
($parts['scheme']))
$method =
$parts['scheme'];
if(isset
($parts['user']))
if(isset
($parts['pass']))
if($path ==
'' ||
$path[0] !=
'/')
// if ZLIB is enabled, let the client by default accept compressed responses
((is_string($info) &&
strpos($info, 'zlib') !==
null) || isset
($info['libz_version'])))
// keepalives: enabled by default ONLY for PHP >= 4.3.8
// (see http://curl.haxx.se/docs/faq.html#7.3)
// by default the xml parser can support these 3 charset encodings
* Enables/disables the echoing to screen of the xmlrpc responses received
* @param integer $debug values 0, 1 and 2 are supported (2 = echo sent msg too, beside received response)
* Add some http BASIC AUTH credentials, used by the client to authenticate
* @param string $u username
* @param string $p password
* @param integer $t auth type. See curl_setopt man page for supported auth types. Defaults to CURLAUTH_BASIC (basic auth)
* Add a client-side https certificate
* @param string $certpass
* Add a CA certificate to verify server with (see man page about
* CURLOPT_CAINFO for more details
* @param string $cacert certificate file name (or dir holding certificates)
* @param bool $is_dir set to true to indicate cacert is a dir. defaults to false
* @param string $key The name of a file containing a private SSL key
* @param string $keypass The secret password needed to use the private SSL key
* NB: does not work in older php/curl installs
* Thanks to Daniel Convissor
function setKey($key, $keypass)
* @param bool $i enable/diable verification of peer certificate
* @param string $proxyhost
* @param string $proxyport Defaults to 8080 for HTTP and 443 for HTTPS
* @param string $proxyusername Leave blank if proxy has public access
* @param string $proxypassword Leave blank if proxy has public access
* @param int $proxyauthtype set to constant CURLAUTH_MTLM to use NTLM auth with proxy
function setProxy($proxyhost, $proxyport, $proxyusername =
'', $proxypassword =
'', $proxyauthtype =
1)
$this->proxy =
$proxyhost;
$this->proxy_autthtype =
$proxyauthtype;
* Enables/disables reception of compressed xmlrpc responses.
* Note that enabling reception of compressed responses merely adds some standard
* http headers to xmlrpc requests. It is up to the xmlrpc server to return
* compressed responses when receiving such requests.
* @param string $compmethod either 'gzip', 'deflate', 'any' or ''
if ($compmethod ==
'any')
* Enables/disables http compression of xmlrpc request.
* Take care when sending compressed requests: servers might not support them
* (and automatic fallback to uncompressed requests is not yet implemented)
* @param string $compmethod either 'gzip', 'deflate' or ''
* Adds a cookie to list of cookies that will be sent to server.
* NB: setting any param but name and value will turn the cookie into a 'version 1' cookie:
* do not do it unless you know what you are doing
* @todo check correctness of urlencoding cookie value (copied from php way of doing it...)
function setCookie($name, $value=
'', $path=
'', $domain=
'', $port=
null)
if ($path ||
$domain ||
$port)
$this->cookies[$name]['path'] =
$path;
$this->cookies[$name]['domain'] =
$domain;
$this->cookies[$name]['port'] =
$port;
$this->cookies[$name]['version'] =
1;
$this->cookies[$name]['version'] =
0;
* @param mixed $msg The message object, or an array of messages for using multicall, or the complete xml representation of a request
* @param integer $timeout Connection timeout, in seconds, If unspecified, a platform specific timeout will apply
* @param string $method if left unspecified, the http protocol chosen during creation of the object will be used
function& send($msg, $timeout=
0, $method=
'')
// if user deos not specify http protocol, use native method of this client
// (i.e. method set during call to constructor)
// $msg is an array of xmlrpcmsg's
$r =
$this->multicall($msg, $timeout, $method);
// where msg is an xmlrpcmsg
$msg->debug=
$this->debug;
$r =
& $this->sendPayloadHTTPS(
elseif($method ==
'http11')
$r =
& $this->sendPayloadCURL(
$r =
& $this->sendPayloadHTTP10(
function &sendPayloadHTTP10($msg, $server, $port, $timeout=
0,
$username=
'', $password=
'', $authtype=
1, $proxyhost=
'',
$proxyport=
0, $proxyusername=
'', $proxypassword=
'', $proxyauthtype=
1)
// Only create the payload if it was not created previously
$payload =
$msg->payload;
// Deflate request body and set appropriate request headers
$encoding_hdr =
"Content-Encoding: gzip\r\n";
$encoding_hdr =
"Content-Encoding: deflate\r\n";
$credentials=
'Authorization: Basic ' .
base64_encode($username .
':' .
$password) .
"\r\n";
error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth is supported with HTTP 1.0');
$connectserver =
$proxyhost;
$connectport =
$proxyport;
$uri =
'http://'.
$server.
':'.
$port.
$this->path;
error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth to proxy is supported with HTTP 1.0');
$proxy_credentials =
'Proxy-Authorization: Basic ' .
base64_encode($proxyusername.
':'.
$proxypassword) .
"\r\n";
$connectserver =
$server;
// Cookie generation, as per rfc2965 (version 1 cookies) or
// netscape's rules (version 0 cookies)
foreach ($this->cookies as $name =>
$cookie)
$cookieheader .=
'Cookie: $Version="' .
$cookie['version'] .
'"; ';
$cookieheader .=
$name .
'="' .
$cookie['value'] .
'";';
$cookieheader .=
' $Path="' .
$cookie['path'] .
'";';
$cookieheader .=
' $Domain="' .
$cookie['domain'] .
'";';
$cookieheader .=
' $Port="' .
$cookie['domain'] .
'";';
$cookieheader =
substr($cookieheader, 0, -
1) .
"\r\n";
$cookieheader .=
'Cookie: ' .
$name .
'=' .
$cookie['value'] .
"\r\n";
$op=
"POST " .
$uri.
" HTTP/1.0\r\n" .
"User-Agent: " .
$GLOBALS['xmlrpcName'] .
" " .
$GLOBALS['xmlrpcVersion'] .
"\r\n" .
"Host: ".
$server .
"\r\n" .
"Content-Type: " .
$msg->content_type .
"\r\nContent-Length: " .
strlen($payload) .
"\r\n\r\n" .
print
"<PRE>\n---SENDING---\n" .
htmlentities($op) .
"\n---END---\n</PRE>";
// let the client see this now in case http times out...
// reset errno and errstr on succesful socket connection
// G. Giunta 2005/10/24: close socket before parsing.
// should yeld slightly better execution times, and make easier recursive calls (e.g. to follow http redirects)
//$resp=&$msg->parseResponseFile($fp);
while($data=
fread($fp, 32768))
// shall we check for $data === FALSE?
// as per the manual, it signals an error
$r =
& $msg->parseResponse($ipd, false, $this->return_type);
function &sendPayloadHTTPS($msg, $server, $port, $timeout=
0, $username=
'',
$password=
'', $authtype=
1, $cert=
'',$certpass=
'', $cacert=
'', $cacertdir=
'',
$proxyhost=
'', $proxyport=
0, $proxyusername=
'', $proxypassword=
'', $proxyauthtype=
1,
$keepalive=
false, $key=
'', $keypass=
'')
$r =
& $this->sendPayloadCURL($msg, $server, $port, $timeout, $username,
$password, $authtype, $cert, $certpass, $cacert, $cacertdir, $proxyhost, $proxyport,
$proxyusername, $proxypassword, $proxyauthtype, 'https', $keepalive, $key, $keypass);
* Requires curl to be built into PHP
* NB: CURL versions before 7.11.10 cannot use proxy to talk to https servers!
function &sendPayloadCURL($msg, $server, $port, $timeout=
0, $username=
'',
$password=
'', $authtype=
1, $cert=
'', $certpass=
'', $cacert=
'', $cacertdir=
'',
$proxyhost=
'', $proxyport=
0, $proxyusername=
'', $proxypassword=
'', $proxyauthtype=
1, $method=
'https',
$keepalive=
false, $key=
'', $keypass=
'')
$this->errstr=
'CURL unavailable on this install';
$r=
&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_curl'], $GLOBALS['xmlrpcstr']['no_curl']);
$this->errstr=
'SSL unavailable on this install';
$r=
&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_ssl'], $GLOBALS['xmlrpcstr']['no_ssl']);
// Only create the payload if it was not created previously
// Deflate request body and set appropriate request headers
$payload =
$msg->payload;
$encoding_hdr =
"Content-Encoding: gzip";
$encoding_hdr =
"Content-Encoding: deflate";
print
"<PRE>\n---SENDING---\n" .
htmlentities($payload) .
"\n---END---\n</PRE>";
// let the client see this now in case http times out...
$curl =
curl_init($method .
'://' .
$server .
':' .
$port .
$this->path);
curl_setopt($curl, CURLOPT_USERAGENT, $GLOBALS['xmlrpcName'].
' '.
$GLOBALS['xmlrpcVersion']);
// required for XMLRPC: post the data
// will only work with PHP >= 5.0
// NB: if we set an empty string, CURL will add http header indicating
// ALL methods it is supporting. This is possibly a better option than
// letting the user tell what curl can / cannot do...
//curl_setopt($curl, CURLOPT_ENCODING, implode(',', $this->accepted_compression));
// empty string means 'any supported by CURL' (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
// if no keepalive is wanted, let the server know it in advance
$headers[] =
'Connection: close';
// request compression header
$headers[] =
$encoding_hdr;
curl_setopt($curl, CURLOPT_TIMEOUT, $timeout ==
1 ?
1 :
$timeout -
1);
if($username &&
$password)
curl_setopt($curl, CURLOPT_USERPWD,"$username:$password");
error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth is supported by the current PHP/curl install');
// whether to verify remote host's cert
// set ca certificates file/dir
// set key file (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
// set key password (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
// whether to verify cert's common name (CN); 0 for no, 1 to verify that it exists, and 2 to verify that it matches the hostname used
$proxyport =
8080; // NB: even for HTTPS, local connection is on port 8080
curl_setopt($curl, CURLOPT_PROXY,$proxyhost.
':'.
$proxyport);
//curl_setopt($curl, CURLOPT_PROXYPORT,$proxyport);
curl_setopt($curl, CURLOPT_PROXYUSERPWD, $proxyusername.
':'.
$proxypassword);
else if ($proxyauthtype !=
1)
error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth to proxy is supported by the current PHP/curl install');
// NB: should we build cookie http headers by hand rather than let CURL do it?
// the following code does not honour 'expires', 'path' and 'domain' cookie attributes
// set to clint obj the the user...
foreach ($this->cookies as $name =>
$cookie)
$cookieheader .=
$name .
'=' .
$cookie['value'] .
', ';
$resp=
&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['curl_fail'], $GLOBALS['xmlrpcstr']['curl_fail'].
': '.
curl_error($curl));
$resp =
& $msg->parseResponse($result, true, $this->return_type);
* Send an array of request messages and return an array of responses.
* Unless $this->no_multicall has been set to true, it will try first
* to use one single xmlrpc call to server method system.multicall, and
* revert to sending many successive calls in case of failure.
* This failure is also stored in $this->no_multicall for subsequent calls.
* Unfortunately, there is no server error code universally used to denote
* the fact that multicall is unsupported, so there is no way to reliably
* distinguish between that and a temporary failure.
* If you are sure that server supports multicall and do not want to
* fallback to using many single calls, set the fourth parameter to FALSE.
* NB: trying to shoehorn extra functionality into existing syntax has resulted
* in pretty much convoluted code...
* @param array $msgs an array of xmlrpcmsg objects
* @param integer $timeout connection timeout (in seconds)
* @param string $method the http protocol variant to be used
* @param boolen fallback When true, upon receiveing an error during multicall, multiple single calls will be attempted
function multicall($msgs, $timeout=
0, $method=
'http', $fallback=
true)
$results =
$this->_try_multicall($msgs, $timeout, $method);
// System.multicall succeeded
// either system.multicall is unsupported by server,
// or call failed for some other reason.
// Don't try it next time...
if (is_a($results, 'xmlrpcresp'))
$result =
new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['multicall_error'], $GLOBALS['xmlrpcstr']['multicall_error']);
// override fallback, in case careless user tries to do two
// opposite things at the same time
// system.multicall is (probably) unsupported by server:
// emulate multicall via multiple requests
$results[] =
& $this->send($msg, $timeout, $method);
// user does NOT want to fallback on many single calls:
// since we should always return an array of responses,
// return an array with the same error repeated n times
* Attempt to boxcar $msgs via system.multicall.
* Returns either an array of xmlrpcreponses, an xmlrpc error response
* or false (when recived response does not respect valid multiccall syntax)
function _try_multicall($msgs, $timeout, $method)
// Construct multicall message
$call['methodName'] =
new xmlrpcval($msg->method(),'string');
$numParams =
$msg->getNumParams();
for($i =
0; $i <
$numParams; $i++
)
$params[$i] =
$msg->getParam($i);
$call['params'] =
new xmlrpcval($params, 'array');
$multicall =
new xmlrpcmsg('system.multicall');
$multicall->addParam(new xmlrpcval($calls, 'array'));
$result =
& $this->send($multicall, $timeout, $method);
//if(!is_object($result))
// return ($result || 0); // transport failed
if($result->faultCode() !=
0)
// call to system.multicall failed
$rets =
$result->value();
///@todo test this code branch...
$rets =
$result->value();
return false; // bad return type from system.multicall
if($numRets !=
count($msgs))
return false; // wrong number of return values.
for($i =
0; $i <
$numRets; $i++
)
return false; // Bad value
$response[$i] =
new xmlrpcresp($val[0], 0, '', 'phpvals');
/// @todo remove usage of @: it is apparently quite slow
$code =
@$val['faultCode'];
$str =
@$val['faultString'];
else // return type == 'xmlrpcvals'
$rets =
$result->value();
if($rets->kindOf() !=
'array')
return false; // bad return type from system.multicall
$numRets =
$rets->arraysize();
if($numRets !=
count($msgs))
return false; // wrong number of return values.
for($i =
0; $i <
$numRets; $i++
)
$val =
$rets->arraymem($i);
if($val->arraysize() !=
1)
return false; // Bad value
$response[$i] =
new xmlrpcresp($val->arraymem(0));
$code =
$val->structmem('faultCode');
if($code->kindOf() !=
'scalar' ||
$code->scalartyp() !=
'int')
$str =
$val->structmem('faultString');
if($str->kindOf() !=
'scalar' ||
$str->scalartyp() !=
'string')
$response[$i] =
new xmlrpcresp(0, $code->scalarval(), $str->scalarval());
} // end class xmlrpc_client
* @param mixed $val either an xmlrpcval obj, a php value or the xml serialization of an xmlrpcval (a string)
* @param integer $fcode set it to anything but 0 to create an error response
* @param string $fstr the error string, in case of an error response
* @param string $valtyp either 'xmlrpcvals', 'phpvals' or 'xml'
* @todo add check that $val is of correct type???
* NB: as of now we do not do it, since it might be either an xmlrpcval or a plain
* php val, or a complete xml chunk, depending on usage of xmlrpc_client::send() inside which creator is called...
function xmlrpcresp($val, $fcode =
0, $fstr =
'', $valtyp=
'')
//$this->errstr = htmlspecialchars($fstr); // XXX: encoding probably shouldn't be done here; fix later.
/*elseif(!is_object($val) || !is_a($val, 'xmlrpcval'))
error_log("Invalid type '" . gettype($val) . "' (value: $val) passed to xmlrpcresp. Defaulting to empty value.");
$this->val =& new xmlrpcval();
// user did not declare type of response value: try to guess it
// user declares type of resp value: believe him
* @return integer the error code of this response (0 for not-error responses)
* @return string the error string of this response ('' for not-error responses)
* @return mixed the xmlrpcval object returned by the server. Might be an xml string or php value if the response has been created by specially configured xmlrpc_client objects
* Returns an array with the cookies received from the server.
* Array has the form: $cookiename => array ('value' => $val, $attr1 => $val1, $attr2 = $val2, ...)
* with attributes being e.g. 'expires', 'path', domain'.
* NB: cookies sent as 'expired' by the server (i.e. with an expiry date in the past)
* are still present in the array. It is up to the user-defined code to decide
* how to use the received cookies, and wheter they have to be sent back with the next
* request to the server (using xmlrpc_client::setCookie) or not
* @return array array of cookies received from the server
* Return xml representation of the response
* @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed
* @return string the xml representation of the response
if ($charset_encoding !=
'')
$this->content_type =
'text/xml; charset=' .
$charset_encoding;
$result =
"<methodResponse>\n";
// G. Giunta 2005/2/13: let non-ASCII response messages be tolerated by clients
// by xml-encoding non ascii chars
"<value>\n<struct><member><name>faultCode</name>\n<value><int>" .
$this->errno .
"</int></value>\n</member>\n<member>\n<name>faultString</name>\n<value><string>" .
"</struct>\n</value>\n</fault>";
$result .=
"<params>\n<param>\n" .
/// @todo try to build something serializable?
die('cannot serialize xmlrpcresp objects whose content is native php values');
$result .=
"<params>\n<param>\n" .
$this->val->serialize($charset_encoding) .
$result .=
"\n</methodResponse>";
* @param string $meth the name of the method to invoke
* @param array $pars array of parameters to be paased to the method (xmlrpcval objects)
for($i=
0; $i<
sizeof($pars); $i++
)
if ($charset_encoding !=
'')
return "<?xml version=\"1.0\" encoding=\"$charset_encoding\" ?" .
">\n<methodCall>\n";
return "<?xml version=\"1.0\"?" .
">\n<methodCall>\n";
if ($charset_encoding !=
'')
$this->content_type =
'text/xml; charset=' .
$charset_encoding;
// if(sizeof($this->params)) {
$this->payload.=
"<param>\n" .
$p->serialize($charset_encoding) .
//$this->payload=str_replace("\n", "\r\n", $this->payload);
* Gets/sets the xmlrpc method to be invoked
* @param string $meth the method to be set (leave empty not to set it)
* @return string the method that will be invoked
* @return string the xml representation of the message
* Add a parameter to the list of parameters to be used upon method invocation
* @return boolean false on failure
// add check: do not add to self params which are not xmlrpcvals
* @param integer $i the index of the parameter to fetch (zero based)
* @return xmlrpcval the i-th parameter
* @return integer the number of parameters currently set
* @todo add 2nd & 3rd param to be passed to ParseResponse() ???
while($data=
fread($fp, 32768))
* Parses HTTP headers and separates them from data.
function &parseResponseHeaders(&$data, $headers_processed=
false)
// Strip HTTP 1.1 100 Continue header if present
while(ereg('^HTTP/1\.1 1[0-9]{2} ', $data))
$pos =
strpos($data, 'HTTP', 12);
// server sent a Continue header without any (valid) content following...
// give the client a chance to know it
if(!$pos &&
!is_int($pos)) // works fine in php 3, 4 and 5
if(!ereg('^HTTP/[0-9.]+ 200 ', $data))
error_log('XML-RPC: xmlrpcmsg::parseResponse: HTTP error, got response: ' .
$errstr);
$r=
&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $GLOBALS['xmlrpcstr']['http_error'].
' (' .
$errstr .
')');
$GLOBALS['_xh']['headers'] =
array();
$GLOBALS['_xh']['cookies'] =
array();
// be tolerant to usage of \n instead of \r\n to separate headers and data
// (even though it is not valid http)
$pos =
strpos($data,"\r\n\r\n");
// No separation between response headers and body: fault?
// be tolerant to line endings, and extra empty lines
while(list
(,$line) =
@each($ar))
// take care of multi-line headers and cookies
/// @todo some other headers (the ones that allow a CSV list of values)
/// do allow many values to be passed using multiple header lines.
/// We should add content to $GLOBALS['_xh']['headers'][$header_name]
/// instead of replacing it for those...
if ($header_name ==
'set-cookie' ||
$header_name ==
'set-cookie2')
if ($header_name ==
'set-cookie2')
// there could be many cookies on one line, comma separated
$cookies =
array($arr[1]);
foreach ($cookies as $cookie)
// glue together all received cookies, using a comma to separate them
// (same as php does with getallheaders())
if (isset
($GLOBALS['_xh']['headers'][$header_name]))
$GLOBALS['_xh']['headers'][$header_name] .=
', ' .
trim($cookie);
$GLOBALS['_xh']['headers'][$header_name] =
trim($cookie);
// parse cookie attributes, in case user wants to coorectly honour then
// feature creep: only allow rfc-compliant cookie attributes?
foreach ($cookie as $pos =>
$val)
/// @todo with version 1 cookies, we should strip leading and trailing " chars
$GLOBALS['_xh']['cookies'][$tag] =
array();
$GLOBALS['_xh']['cookies'][$cookiename]['value'] =
urldecode($val);
$GLOBALS['_xh']['cookies'][$cookiename][$tag] =
$val;
$GLOBALS['_xh']['headers'][$header_name] =
trim($arr[1]);
elseif(isset
($header_name))
/// @todo version1 cookies might span multiple lines, thus breaking the parsing above
$GLOBALS['_xh']['headers'][$header_name] .=
' ' .
trim($line);
// rebuild full cookie set
/*if (isset($GLOBALS['_xh']['headers']['set-cookie']))
$received = explode(';', $GLOBALS['_xh']['headers']['set-cookie']);
foreach($received as $cookie)
list($name, $value) = explode('=', $cookie);
// these values are in fact attributes
if ($name != 'Comment' && $name != 'Comment' && $name != 'Comment' && $name != 'Comment' && $name != 'Comment' && $name != 'Comment')
$cookies[$name] = $value;
if($this->debug &&
count($GLOBALS['_xh']['headers']))
foreach($GLOBALS['_xh']['headers'] as $header =>
$value)
print
"HEADER: $header: $value\n";
foreach($GLOBALS['_xh']['cookies'] as $header =>
$value)
print
"COOKIE: $header={$value['value']}\n";
// if CURL was used for the call, http headers have been processed,
// and dechunking + reinflating have been carried out
// Decode chunked encoding sent by http 1.1 servers
if(isset
($GLOBALS['_xh']['headers']['transfer-encoding']) &&
$GLOBALS['_xh']['headers']['transfer-encoding'] ==
'chunked')
error_log('XML-RPC: xmlrpcmsg::parseResponse: errors occurred when trying to rebuild the chunked data received from server');
$r =
new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['dechunk_fail'], $GLOBALS['xmlrpcstr']['dechunk_fail']);
// Decode gzip-compressed stuff
// code shamelessly inspired from nusoap library by Dietrich Ayala
if(isset
($GLOBALS['_xh']['headers']['content-encoding']))
if($GLOBALS['_xh']['headers']['content-encoding'] ==
'deflate' ||
$GLOBALS['_xh']['headers']['content-encoding'] ==
'gzip')
// if decoding works, use it. else assume data wasn't gzencoded
if($GLOBALS['_xh']['headers']['content-encoding'] ==
'deflate' &&
$degzdata =
@gzinflate($data))
print
"<PRE>---INFLATED RESPONSE---[".
strlen($data).
" chars]---\n" .
htmlentities($data) .
"\n---END---</PRE>";
elseif($GLOBALS['_xh']['headers']['content-encoding'] ==
'gzip' &&
$degzdata =
@gzinflate(substr($data, 10)))
print
"<PRE>---INFLATED RESPONSE---[".
strlen($data).
" chars]---\n" .
htmlentities($data) .
"\n---END---</PRE>";
error_log('XML-RPC: xmlrpcmsg::parseResponse: errors occurred when trying to decode the deflated data received from server');
$r =
new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['decompress_fail'], $GLOBALS['xmlrpcstr']['decompress_fail']);
error_log('XML-RPC: xmlrpcmsg::parseResponse: the server sent deflated data. Your php install must have the Zlib extension compiled in to support this.');
$r =
new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['cannot_decompress'], $GLOBALS['xmlrpcstr']['cannot_decompress']);
} // end of 'if needed, de-chunk, re-inflate response'
// real stupid hack to avoid PHP 4 complaining about returning NULL by ref
* @param string $data the xmlrpc response, eventually including http headers
* @param bool $headers_processed when true prevents parsing HTTP headers for interpretation of content-encoding and conseuqent decoding
* @param string $return_type decides return type, i.e. content of response->value(). Either 'xmlrpcvals', 'xml' or 'phpvals'
function &parseResponse($data=
'', $headers_processed=
false, $return_type=
'xmlrpcvals')
//by maHo, replaced htmlspecialchars with htmlentities
print
"<PRE>---GOT---\n" .
htmlentities($data) .
"\n---END---\n</PRE>";
$start =
strpos($data, '<!-- SERVER DEBUG INFO (BASE64 ENCODED):');
$start +=
strlen('<!-- SERVER DEBUG INFO (BASE64 ENCODED):');
$end =
strpos($data, '-->', $start);
$comments =
substr($data, $start, $end-
$start);
error_log('XML-RPC: xmlrpcmsg::parseResponse: no response received from server.');
$r =
new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_data'], $GLOBALS['xmlrpcstr']['no_data']);
// parse the HTTP headers of the response, if present, and separate them from data
$r =
& $this->parseResponseHeaders($data, $headers_processed);
$GLOBALS['_xh']['headers'] =
array();
$GLOBALS['_xh']['cookies'] =
array();
// be tolerant of extra whitespace in response body
/// @todo return an error msg if $data=='' ?
// be tolerant of junk after methodResponse (e.g. javascript ads automatically inserted by free hosts)
// idea from Luca Mariano <[email protected]> originally in PEARified version of the lib
// Poor man's version of strrpos for php 4...
$pos =
strpos($data, '</methodResponse>');
$pos =
strpos($data, '</methodResponse>', $bd);
$data =
substr($data, 0, $bd);
// if user wants back raw xml, give it to him
if ($return_type ==
'xml')
$r->hdrs =
$GLOBALS['_xh']['headers'];
$r->_cookies =
$GLOBALS['_xh']['cookies'];
// try to 'guestimate' the character encoding of the received response
$resp_encoding =
guess_encoding(@$GLOBALS['_xh']['headers']['content-type'], $data);
$GLOBALS['_xh']['stack'] =
array();
$GLOBALS['_xh']['valuestack'] =
array();
$GLOBALS['_xh']['isf']=
0;
$GLOBALS['_xh']['isf_reason']=
'';
$GLOBALS['_xh']['ac']=
'';
$GLOBALS['_xh']['qt']=
'';
// if response charset encoding is not known / supported, try to use
// the default encoding and parse the xml anyway, but log a warning...
if (!in_array($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
// the following code might be better for mb_string enabled installs, but
// makes the lib about 200% slower...
//if (!is_valid_charset($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
error_log('XML-RPC: xmlrpcmsg::parseResponse: invalid charset encoding of received response: '.
$resp_encoding);
$resp_encoding =
$GLOBALS['xmlrpc_defencoding'];
// G. Giunta 2005/02/13: PHP internally uses ISO-8859-1, so we have to tell
// the xml parser to give us back data in the expected charset
if ($return_type ==
'phpvals')
// first error check: xml not well formed
$errstr =
'XML error at line 1, check URL';
$errstr =
sprintf('XML error: %s at line %d, column %d',
$r=
&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'], $GLOBALS['xmlrpcstr']['invalid_return'].
' ('.
$errstr.
')');
$r->hdrs =
$GLOBALS['_xh']['headers'];
$r->_cookies =
$GLOBALS['_xh']['cookies'];
// second error check: xml well formed but not xml-rpc compliant
if ($GLOBALS['_xh']['isf'] >
1)
/// @todo echo something for user?
$r =
new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'],
$GLOBALS['xmlrpcstr']['invalid_return'] .
' ' .
$GLOBALS['_xh']['isf_reason']);
// third error check: parsing of the response has somehow gone boink.
// NB: shall we omit this check, since we trust the parsing code?
elseif ($return_type ==
'xmlrpcvals' &&
!is_object($GLOBALS['_xh']['value']))
// something odd has happened
// and it's time to generate a client side error
// indicating something odd went on
$r=
&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'],
$GLOBALS['xmlrpcstr']['invalid_return']);
print
"<PRE>---PARSED---\n" ;
print
"\n---END---</PRE>";
// note that using =& will raise an error if $GLOBALS['_xh']['st'] does not generate an object.
$v =
& $GLOBALS['_xh']['value'];
if($GLOBALS['_xh']['isf'])
if ($return_type ==
'xmlrpcvals')
$errno_v =
$v->structmem('faultCode');
$errstr_v =
$v->structmem('faultString');
$errno =
$errno_v->scalarval();
$errstr =
$errstr_v->scalarval();
$errno =
$v['faultCode'];
$errstr =
$v['faultString'];
// FAULT returned, errno needs to reflect that
$r->hdrs =
$GLOBALS['_xh']['headers'];
$r->_cookies =
$GLOBALS['_xh']['cookies'];
if($val!==-
1 ||
$type!=
'')
if($GLOBALS['xmlrpcTypes'][$type]==
1)
elseif($GLOBALS['xmlrpcTypes'][$type]==
2)
elseif($GLOBALS['xmlrpcTypes'][$type]==
3)
$typeof=
@$GLOBALS['xmlrpcTypes'][$type];
error_log("XML-RPC: xmlrpcval::addScalar: not a scalar type ($typeof)");
// coerce booleans into correct values
// NB: shall we do it for datetimes, integers and doubles, too?
if($type==
$GLOBALS['xmlrpcBoolean'])
error_log('XML-RPC: xmlrpcval::addScalar: scalar xmlrpcval can have only one value');
error_log('XML-RPC: xmlrpcval::addScalar: cannot add anonymous scalar to struct xmlrpcval');
// we're adding a scalar value to an array here
//$ar=$this->me['array'];
//$ar[]=&new xmlrpcval($val, $type);
//$this->me['array']=$ar;
// Faster (?) avoid all the costly array-copy-by-val done here...
// a scalar, so set the value and remember we're scalar
/// @todo add some checking for $vals to be an array of xmlrpcvals?
$this->mytype=
$GLOBALS['xmlrpcTypes']['array'];
$this->me['array']=
$vals;
// we're adding to an array here
error_log('XML-RPC: xmlrpcval::addArray: already initialized as a [' .
$this->kindOf() .
']');
/// @todo add some checking for $vals to be an array?
$this->mytype=
$GLOBALS['xmlrpcTypes']['struct'];
$this->me['struct']=
$vals;
// we're adding to a struct here
error_log('XML-RPC: xmlrpcval::addStruct: already initialized as a [' .
$this->kindOf() .
']');
// poor man's version of print_r ???
foreach($ar as $key =>
$val)
echo
"$key => $val<br />";
while(list
($key2, $val2) =
each($val))
echo
"-- $key2 => $val2<br />";
switch(@$GLOBALS['xmlrpcTypes'][$typ])
$rs.=
'<struct php_class="' .
$this->_php_class .
"\">\n";
foreach($val as $key2 =>
$val2)
$rs.=
"<member><name>${key2}</name>\n";
//$rs.=$this->serializeval($val2);
$rs.=
$val2->serialize($charset_encoding);
$rs.=
"<array>\n<data>\n";
for($i=
0; $i<
sizeof($val); $i++
)
//$rs.=$this->serializeval($val[$i]);
$rs.=
$val[$i]->serialize($charset_encoding);
$rs.=
"</data>\n</array>";
case $GLOBALS['xmlrpcBase64']:
case $GLOBALS['xmlrpcBoolean']:
$rs.=
"<${typ}>" .
($val ?
'1' :
'0') .
"</${typ}>";
case $GLOBALS['xmlrpcString']:
// G. Giunta 2005/2/13: do NOT use htmlentities, since
// it will produce named html entities, which are invalid xml
$rs.=
"<${typ}>" .
xmlrpc_encode_entitites($val, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding).
"</${typ}>";
// $rs.="<${typ}>" . htmlentities($val). "</${typ}>";
case $GLOBALS['xmlrpcInt']:
case $GLOBALS['xmlrpcI4']:
$rs.=
"<${typ}>".(int)
$val.
"</${typ}>";
case $GLOBALS['xmlrpcDouble']:
$rs.=
"<${typ}>".(double)
$val.
"</${typ}>";
// no standard type value should arrive here, but provide a possibility
// for xmlrpcvals of unknown type...
$rs.=
"<${typ}>${val}</${typ}>";
* Return xml representation of the value
* @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed
// add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...
//if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))
list
($typ, $val) =
each($this->me);
return '<value>' .
$this->serializedata($typ, $val, $charset_encoding) .
"</value>\n";
// add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...
//if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))
list
($typ, $val) =
each($ar);
return '<value>' .
$this->serializedata($typ, $val) .
"</value>\n";
* Checks wheter a struct member with a given name is present.
* Works only on xmlrpcvals of type struct.
* @param string $m the name of the struct member to be looked up
* Returns the value of a given struct member (an xmlrpcval object in itself).
* Will raise a php warning if struct member of given name does not exist
* @param string $m the name of the struct member to be looked up
return $this->me['struct'][$m];
return each($this->me['struct']);
// DEPRECATED! this code looks like it is very fragile and has not been fixed
// for a long long time. Shall we remove it for 2.0?
// contributed by I Sofer, 2001-03-24
// add support for nested arrays to scalarval
// i've created a new method here, so as to
// preserve back compatibility
while(list
($id,$cont) =
@each($b))
$b[$id] =
$cont->scalarval();
// add support for structures directly encoding php objects
while(list
($id,$cont) =
@each($t))
$t[$id] =
$cont->scalarval();
while(list
($id,$cont) =
@each($t))
//@eval('$b->'.$id.' = $cont;');
* Returns the value of a scalar xmlrpcval
* Returns the type of the xmlrpcval.
* For integers, 'int' is always returned in place of 'i4'
if($a==
$GLOBALS['xmlrpcI4'])
$a=
$GLOBALS['xmlrpcInt'];
* Returns the m-th member of an xmlrpcval of struct type
* @param integer $m the index of the value to be retrieved (zero based)
return $this->me['array'][$m];
* Returns the number of members in an xmlrpcval of array type
* Returns the number of members in an xmlrpcval of struct type
// return an ISO8601 encoded string
// really, timezones ought to be supported
// but the XML-RPC spec says:
// "Don't assume a timezone. It should be specified by the server in its
// documentation what assumptions it makes about timezones."
// these routines always assume localtime unless
// $utc is set to 1, in which case UTC is assumed
// and an adjustment for locale is made when encoding
// gmstrftime doesn't exist in some versions
// return a timet in the localtime, or UTC
if(ereg("([0-9]{4})([0-9]{2})([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})", $idate, $regs))
$t=
gmmktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);
$t=
mktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);
* Takes an xmlrpc value in PHP xmlrpcval object format
* and translates it into native PHP types.
* Works with xmlrpc message objects as input, too.
* @param xmlrpcval $xmlrpc_val
* @param array $options if 'decode_php_objs' is set in the options array, xmlrpc structs can be decoded into php objects
for($i =
0; $i <
$size; $i++
)
// If user said so, try to rebuild php objects for specific struct vals.
/// @todo should we raise a warning for class not found?
// shall we check for proper subclass of xmlrpcval instead of
// presence of _php_class to detect what we can do?
while(list
($key,$value)=
$xmlrpc_val->structeach())
while(list
($key,$value)=
$xmlrpc_val->structeach())
$paramcount =
$xmlrpc_val->getNumParams();
for($i =
0; $i <
$paramcount; $i++
)
define('XMLRPC_EPI_ENABLED','1');
define('XMLRPC_EPI_ENABLED','0');
* Takes native php types and encodes them into xmlrpc PHP object format.
* It will not re-encode xmlrpcval objects.
* Feature creep -- could support more types via optional type argument
* (string => datetime support has been added, ??? => base64 not yet)
* @param mixed $php_val the value to be converted into an xmlrpcval object
* @param array $options can include 'encode_php_objs' and 'auto_dates'
// PHP arrays can be encoded to either xmlrpc structs or arrays,
// depending on wheter they are hashes or plain 0..n integer indexed
// A shorter one-liner would be
// $tmp = array_diff(array_keys($php_val), range(0, count($php_val)-1));
// but execution time skyrockets!
foreach($php_val as $key =>
$val)
if(is_a($php_val, 'xmlrpcval'))
while(list
($k,$v) =
each($php_val))
if (in_array('encode_php_objs', $options))
// let's save original class name into xmlrpcval:
// might be useful later on...
$xmlrpc_val->addScalar($php_val, $GLOBALS['xmlrpcInt']);
$xmlrpc_val->addScalar($php_val, $GLOBALS['xmlrpcDouble']);
if (in_array('auto_dates', $options) &&
ereg("^[0-9]{8}\T{1}[0-9]{2}\:[0-9]{2}\:[0-9]{2}$", $php_val))
$xmlrpc_val->addScalar($php_val, $GLOBALS['xmlrpcDateTime']);
$xmlrpc_val->addScalar($php_val, $GLOBALS['xmlrpcString']);
// Add support for encoding/decoding of booleans, since they are supported in PHP
$xmlrpc_val->addScalar($php_val, $GLOBALS['xmlrpcBoolean']);
// </G_Giunta_2001-02-29>
// catch "resource", "NULL", "user function", "unknown type"
// an empty object in case (which is already
// at this point), not a boolean.
* decode a string that is encoded w/ "chunked" transfer encoding
* as defined in rfc2068 par. 19.4.6
* code shamelessly stolen from nusoap library by Dietrich Ayala
* @param string $buffer the string to be decoded
// read chunk-size, chunk-extension (if any) and crlf
// get the position of the linebreak
$chunkend =
strpos($buffer,"\r\n") +
2;
$temp =
substr($buffer,0,$chunkend);
// while(chunk-size > 0) {
$chunkend =
strpos($buffer, "\r\n", $chunkstart +
$chunk_size);
// just in case we got a broken connection
$chunk =
substr($buffer,$chunkstart);
// append chunk-data to entity-body
// read chunk-data and crlf
$chunk =
substr($buffer,$chunkstart,$chunkend-
$chunkstart);
// append chunk-data to entity-body
// length := length + chunk-size
// read chunk-size and crlf
$chunkstart =
$chunkend +
2;
$chunkend =
strpos($buffer,"\r\n",$chunkstart)+
2;
break; //just in case we got a broken connection
$temp =
substr($buffer,$chunkstart,$chunkend-
$chunkstart);
* Given a string defining a php type or phpxmlrpc type (loosely defined: strings
* accepted come from javadoc blocks), return corresponding phpxmlrpc type.
* NB: for php 'resource' types returns empty string, since resources cannot be serialized;
* for php class names returns 'struct', since php objects can be serialized as xmlrpc structs
return $GLOBALS['xmlrpcString'];
case $GLOBALS['xmlrpcInt']:
// 'int'
case $GLOBALS['xmlrpcI4']:
return $GLOBALS['xmlrpcInt'];
return $GLOBALS['xmlrpcDouble'];
return $GLOBALS['xmlrpcBoolean'];
return $GLOBALS['xmlrpcArray'];
return $GLOBALS['xmlrpcStruct'];
case $GLOBALS['xmlrpcBase64']:
case $GLOBALS['xmlrpcStruct']:
return $GLOBALS['xmlrpcStruct'];
// unknown: might be any xmlrpc type
return $GLOBALS['xmlrpcValue'];
* Given a user-defined PHP function, create a PHP 'wrapper' function that can
* be exposed as xmlrpc method from an xmlrpc_server object and called from remote
* Since php is a typeless language, to infer types of input and output parameters,
* it relies on parsing the javadoc-style comment block associated with the given
* function. Usage of xmlrpc native types (such as datetime.dateTime.iso8601 and base64)
* in the @param tag is also allowed, if you need the php function to receive/send
* data in that particular format (note that base64 enncoding/decoding is transparently
* carried out by the lib, while datetime vals are passed around as strings)
* - only works for user-defined functions, not for PHP internal functions
* (reflection does not support retrieving number/type of params for those)
* - functions returning php objects will generate special xmlrpc responses:
* when the xmlrpc decoding of those responses is carried out by this same lib, using
* the appropriate param in php_xmlrpc_decode, the php objects will be rebuilt.
* In short: php objects can be serialized, too (except for their resource members),
* Other libs might choke on the very same xml that will be generated in this case
* (i.e. it has a nonstandard attribute on struct element tags)
* - usage of javadoc @param tags using param names in a different order from the
* function prototype is not considered valid (to be fixed?)
* Note that since rel. 2.0RC3 the preferred method to have the server call 'standard'
* php functions (ie. functions not expecting a single xmlrpcmsg obj as parameter)
* is by making use of the functions_parameters_type class member.
* @param string $funcname the name of the PHP user function to be exposed as xmlrpc method; array($obj, 'methodname') might be ok too, in the future...
* @return false on error, or an array containing the name of the new php function,
* its signature and docs, to be used in the server dispatch map
* @todo decide how to deal with params passed by ref: bomb out or allow?
* @todo finish using javadoc info to build method sig if all params are named but out of order
* @done switch to some automagic object encoding scheme
* @todo add a check for params of 'resource' type
* @todo add some trigger_errors when returning false?
* @todo what to do when the PHP function returns NULL? we are currently returning bogus responses!!!
// up to php 5.0.3 some useful reflection methods were missing
// determine name of new php function
$xmlrpcfuncname =
"xmlrpc_".
implode('_', $funcname);
$xmlrpcfuncname =
"xmlrpc_$funcname";
$xmlrpcfuncname =
$newfuncname;
$code =
"function $xmlrpcfuncname(\$msg) {\n";
// start to introspect PHP code
$func =
new ReflectionFunction($funcname);
// Note: from PHP 5.1.0 onward, we will possibly be able to use invokeargs
// instead of getparameters to fully reflect internal php functions ?
// retrieve parameter names, types and description from javadoc comments
// type of return val: by default 'any'
$returns =
$GLOBALS['xmlrpcValue'];
// type + name of function parameters
$docs =
$func->getDocComment();
$doc =
trim($doc, " \r\t/*");
elseif(strpos($doc, '@param') ===
0)
// syntax: @param type [$name] desc
if(preg_match('/@param\s+(\S+)(\s+\$\S+)?\s+(.+)/', $doc, $matches))
//$paramDocs[$i]['type'] = explode('|', $matches[1]);
$paramDocs[$i]['type'] =
'mixed';
$paramDocs[$i]['type'] =
$matches[1];
$paramDocs[$i]['name'] =
trim($matches[2]);
$paramDocs[$i]['doc'] =
$matches[3];
elseif(strpos($doc, '@return') ===
0)
// start introspection of actual function prototype and building of PHP code
$params =
$func->getParameters();
$parsvariations =
array();
foreach($params as $param)
if (isset
($paramDocs[$i]['name']) &&
$paramDocs[$i]['name'] &&
strtolower($paramDocs[$i]['name']) !=
'$'.
strtolower($param->getName()))
// param name from phpdoc info does not match param definition!
$paramDocs[$i]['type'] =
'mixed';
// this particular parameter is optional. save as valid previous list of parameters
$innercode .=
"if (\$paramcount > $i) {\n";
$parsvariations[] =
$pars;
$innercode .=
"\$p$i = \$msg->getParam($i);\n";
$innercode .=
"if (\$p{$i}->kindOf() == 'scalar') \$p$i = \$p{$i}->scalarval(); else \$p$i = php_xmlrpc_decode(\$p$i);\n";
// last allowed parameters combination
$parsvariations[] =
$pars;
if(count($parsvariations) ==
0)
// only known good synopsis = no parameters
$parsvariations[] =
array();
$minpars =
count($parsvariations[0]);
// add to code the check for min params number
// NB: this check needs to be done BEFORE decoding param values
$innercode =
"\$paramcount = \$msg->getNumParams();\n" .
"if (\$paramcount < $minpars) return new xmlrpcresp(0, {$GLOBALS['xmlrpcerr']['incorrect_params']}, '{$GLOBALS['xmlrpcstr']['incorrect_params']}');\n" .
$innercode;
$innercode =
"\$paramcount = \$msg->getNumParams();\n" .
$innercode;
$innercode .=
"\$np = false;";
foreach($parsvariations as $pars)
$innercode .=
"if (\$paramcount == " .
count($pars) .
") \$retval = $funcname(" .
implode(',', $pars) .
"); else\n";
// build a 'generic' signature (only use an appropriate return type)
for($i=
0; $i <
count($pars); $i++
)
if (isset
($paramDocs[$i]['type']))
$sig[] =
$GLOBALS['xmlrpcValue'];
$innercode .=
"\$np = true;\n";
$innercode .=
"if (\$np) return new xmlrpcresp(0, {$GLOBALS['xmlrpcerr']['incorrect_params']}, '{$GLOBALS['xmlrpcstr']['incorrect_params']}'); else\n";
//$innercode .= "if (\$_xmlrpcs_error_occurred) return new xmlrpcresp(0, $GLOBALS['xmlrpcerr']user, \$_xmlrpcs_error_occurred); else\n";
if($returns ==
$GLOBALS['xmlrpcDateTime'] ||
$returns ==
$GLOBALS['xmlrpcBase64'])
$innercode .=
"return new xmlrpcresp(new xmlrpcval(\$retval, '$returns'));";
$innercode .=
"return new xmlrpcresp(php_xmlrpc_encode(\$retval, array('encode_php_objs')));";
// shall we exclude functions returning by ref?
// if($func->returnsReference())
$code =
$code .
$innercode .
"\n}\n \$allOK=1;";
//$xmlrpcfuncname = create_function('$m', $innercode);
/// @todo examine if $paramDocs matches $parsvariations and build array for
/// usage as method signature, plus put together a nice string for docs
$ret =
array('function' =>
$xmlrpcfuncname, 'signature' =>
$sigs, 'docstring' =>
$desc);
* Given an xmlrpc client and a method name, register a php wrapper function
* that will call it and return results using native php types for both
* params and results. The generated php function will return an xmlrpcresp
* oject for failed xmlrpc calls
* - server must support system.methodsignature for the wanted xmlrpc method
* - for methods that expose many signatures, only one can be picked (we
* could in priciple check if signatures differ only by number of params
* and not by type, but it would be more complication than we can spare time)
* - nested xmlrpc params: the caller of the generated php function has to
* encode on its own the params passed to the php function if these are structs
* or arrays whose (sub)members include values of type datetime or base64
* Notes: the connection properties of the given client will be copied
* and reused for the connection used during the call to the generated
* Calling the generated php function 'might' be slow: a new xmlrpc client
* is created on every invocation and an xmlrpc-connection opened+closed.
* An extra 'debug' param is appended to param list of xmlrpc method, useful
* for debugging purposes.
* @param xmlrpc_client $client an xmlrpc client set up correctly to communicate with target server
* @param string $methodname the xmlrpc method to be mapped to a php function
* @param integer $signum the index of the method signature to use in mapping (if method exposes many sigs)
* @return string the name of the generated php function (or false)
function wrap_xmlrpc_method($client, $methodname, $signum=
0, $timeout=
0, $protocol=
'', $newfuncname=
'')
$msg =
new xmlrpcmsg('system.methodSignature');
$response =
& $client->send($msg, $timeout, $protocol);
if(!$response ||
$response->faultCode())
$desc =
$response->value();
if(($client->return_type ==
'xmlrpcvals' &&
($desc->kindOf() !=
'array' ||
$desc->arraysize() <=
$signum)) ||
($client->return_type ==
'phpvals' &&
(!is_array($desc) ||
count($desc) <=
$signum)))
$xmlrpcfuncname =
$newfuncname;
$xmlrpcfuncname =
'xmlrpc_'.
str_replace('.', '_', $methodname);
if ($client->return_type ==
'phpvals')
$code =
"function $xmlrpcfuncname (";
$innercode =
"\$client = new xmlrpc_client('$client->path', '$client->server');\n";
// copy all client fields to the client that will be generated runtime
// (this provides for future expansion of client obj)
foreach($client as $fld =>
$val)
if($fld !=
'debug' &&
$fld !=
'return_type')
$innercode .=
"\$client->$fld = $val;\n";
$innercode .=
"\$client->setDebug(\$debug);\n";
$innercode .=
"\$client->return_type = 'xmlrpcvals';\n";
$innercode .=
"\$msg = new xmlrpcmsg('$methodname');\n";
if ($client->return_type ==
'phpvals')
for($i =
1; $i <
$pcount; $i++
)
if ($client->return_type ==
'phpvals')
if($ptype ==
'dateTime.iso8601' ||
$ptype ==
'base64')
$innercode .=
"\$p$i = new xmlrpcval(\$p$i, '$ptype');\n";
$innercode .=
"\$p$i =& php_xmlrpc_encode(\$p$i);\n";
$innercode .=
"\$msg->addparam(\$p$i);\n";
$innercode .=
"\$res =& \$client->send(\$msg, $timeout, '$protocol');\n";
$innercode .=
"if (\$res->faultcode()) return \$res; else return php_xmlrpc_decode(\$res->value(), array('decode_php_objs'));";
$code =
$code .
$plist.
") {\n" .
$innercode .
"\n}\n\$allOK=1;";
//$xmlrpcfuncname = create_function('$m', $innercode);
* xml charset encoding guessing helper function.
* Tries to determine the charset encoding of an XML chunk
* NB: according to the spec (RFC 3023, if text/xml content-type is received over HTTP without a content-type,
* we SHOULD assume it is strictly US-ASCII. But we try to be more tolerant of unconforming (legacy?) clients/servers,
* which will be most probably using UTF-8 anyway...
* @param string $httpheaders the http Content-type header
* @param string $xmlchunk xml content buffer
* @param string $encoding_prefs comma separated list of character encodings to be used as default (when mb extension is enabled)
* @todo explore usage of mb_http_input(): does it detect http headers + post data? if so, use it instead of hand-detection!!!
function guess_encoding($httpheader=
'', $xmlchunk=
'', $encoding_prefs=
null)
// discussion: see http://www.yale.edu/pclt/encoding/
// 1 - test if encoding is specified in HTTP HEADERS
// token: (any char but excluded stuff)+
// header: Content-type = ...; charset=value(; ...)*
// where value is of type token, no LWS allowed between 'charset' and value
// Note: we do not check for invalid chars in VALUE:
// this had better be done using pure ereg as below
/// @todo this test will pass if ANY header has charset specification, not only Content-Type. Fix it?
if(eregi(";((\\xD\\xA)?[ \\x9]+)*charset=", $httpheader))
/// @BUG if charset is received uppercase, this line will fail!
$in =
strpos($httpheader, 'charset=')+
8;
$out =
strpos($httpheader, ';', $in) ?
strpos($httpheader, ';', $in) :
strlen($httpheader);
// 2 - scan the first bytes of the data for a UTF-16 (or other) BOM pattern
// (source: http://www.w3.org/TR/2000/REC-xml-20001006)
// NOTE: actually, according to the spec, even if we find the BOM and determine
// an encoding, we should check if there is an encoding specified
// in the xml declaration, and verify if they match.
/// @todo implement check as described above?
/// @todo implement check for first bytes of string even without a BOM? (It sure looks harder than for cases WITH a BOM)
if(@ereg("^(\\x00\\x00\\xFE\\xFF|\\xFF\\xFE\\x00\\x00|\\x00\\x00\\xFF\\xFE|\\xFE\\xFF\\x00\\x00)", $xmlchunk))
// if (preg_match("/^(\\x00\\x00\\xFE\\xFF|\\xFF\\xFE\\x00\\x00|\\x00\\x00\\xFF\\xFE|\\xFE\\xFF\\x00\\x00)/", $xmlchunk))
elseif(ereg("^(\\xFE\\xFF|\\xFF\\xFE)", $xmlchunk))
elseif(ereg("^(\\xEF\\xBB\\xBF)", $xmlchunk))
// 3 - test if encoding is specified in the xml declaration
// SPACE: (#x20 | #x9 | #xD | #xA)+ === [ \x9\xD\xA]+
// EQ: SPACE?=SPACE? === [ \x9\xD\xA]*=[ \x9\xD\xA]*
"[ \\x9\\xD\\xA]+" .
"version" .
"[ \\x9\\xD\\xA]*=[ \\x9\\xD\\xA]*" .
"((\"[a-zA-Z0-9_.:-]+\")|('[a-zA-Z0-9_.:-]+'))".
"[ \\x9\\xD\\xA]+" .
"encoding" .
"[ \\x9\\xD\\xA]*=[ \\x9\\xD\\xA]*" .
"((\"[A-Za-z][A-Za-z0-9._-]*\")|('[A-Za-z][A-Za-z0-9._-]*'))",
// 4 - if mbstring is available, let it do the guesswork
// NB: we favour finding an encoding that is compatible with what we can process
$enc =
mb_detect_encoding($xmlchunk, $encoding_prefs);
$enc =
mb_detect_encoding($xmlchunk);
// NB: mb_detect likes to call it ascii, xml parser likes to call it US_ASCII...
// IANA also likes better US-ASCII, so go with it
// no encoding specified: as per HTTP1.1 assume it is iso-8859-1?
// Both RFC 2616 (HTTP 1.1) and 1945(http 1.0) clearly state that for text/xxx content types
// this should be the standard. And we should be getting text/xml as request and response.
// BUT we have to be backward compatible with the lib, which always used UTF-8 as default...
return $GLOBALS['xmlrpc_defencoding'];
* Checks if a given charset encoding is present in a list of encodings or
* if it is a valid subset of any encoding in the list
* @param string $encoding charset to be tested
* @param mixed $validlist comma separated list of valid charsets (or array of charsets)
$charset_supersets =
array(
'US-ASCII' =>
array ('ISO-8859-1', 'ISO-8859-2', 'ISO-8859-3', 'ISO-8859-4',
'ISO-8859-5', 'ISO-8859-6', 'ISO-8859-7', 'ISO-8859-8',
'ISO-8859-9', 'ISO-8859-10', 'ISO-8859-11', 'ISO-8859-12',
'ISO-8859-13', 'ISO-8859-14', 'ISO-8859-15', 'UTF-8',
'EUC-JP', 'EUC-', 'EUC-KR', 'EUC-CN')
$validlist =
explode(',', $validlist);
foreach ($validlist as $allowed)
if (in_array($allowed, $charset_supersets[$encoding]))