<?php\r
// by Edd Dumbill (C) 1999-2002\r
// <edd@usefulinc.com>\r
-// $Id: xmlrpc.inc,v 1.174 2009/03/16 19:36:38 ggiunta Exp $\r
\r
// Copyright (c) 1999,2000,2002 Edd Dumbill.\r
// All rights reserved.\r
$GLOBALS['xmlrpc_internalencoding']='ISO-8859-1';\r
\r
$GLOBALS['xmlrpcName']='XML-RPC for PHP';\r
- $GLOBALS['xmlrpcVersion']='3.0.0.beta';\r
+ $GLOBALS['xmlrpcVersion']='3.0.1';\r
\r
// let user errors start at 800\r
$GLOBALS['xmlrpcerruser']=800;\r
\r
// set to TRUE to enable encoding of php NULL values to <EX:NIL/> instead of <NIL/>\r
$GLOBALS['xmlrpc_null_apache_encoding']=false;\r
+ $GLOBALS['xmlrpc_null_apache_encoding_ns']='http://ws.apache.org/xmlrpc/namespaces/extensions';\r
\r
// used to store state during parsing\r
// quick explanation of components:\r
* http://curl.haxx.se/docs/faq.html#7.3)\r
*/\r
var $xmlrpc_curl_handle = null;\r
- /// Wheter to use persistent connections for http 1.1 and https\r
+ /// Whether to use persistent connections for http 1.1 and https\r
var $keepalive = false;\r
/// Charset encodings that can be decoded without problems by the client\r
var $accepted_charset_encodings = array();\r
*/\r
var $user_agent;\r
\r
+ /**\r
+ * @deprecated\r
+ */\r
+ function xmlrpc_client($path, $server='', $port='', $method='')\r
+ {\r
+ self::__construct($path, $server, $port, $method);\r
+ }\r
+\r
/**\r
* @param string $path either the complete server URL or the PATH part of the xmlrc server URL, e.g. /xmlrpc/server.php\r
* @param string $server the server name / ip address\r
* @param integer $port the port the server is listening on, defaults to 80 or 443 depending on protocol used\r
* @param string $method the http protocol variant: defaults to 'http', 'https' and 'http11' can be used if CURL is installed\r
*/\r
- function xmlrpc_client($path, $server='', $port='', $method='')\r
+ function __construct($path, $server='', $port='', $method='')\r
{\r
// allow user to specify all params in $path\r
if($server == '' and $port == '' and $method == '')\r
\r
/**\r
* Enables/disables the echoing to screen of the xmlrpc responses received\r
- * @param integer $debug values 0, 1 and 2 are supported (2 = echo sent msg too, before received response)\r
+ * @param integer $in values 0, 1 and 2 are supported (2 = echo sent msg too, before received response)\r
* @access public\r
*/\r
function setDebug($in)\r
\r
/**\r
* Add a CA certificate to verify server with (see man page about\r
- * CURLOPT_CAINFO for more details\r
+ * CURLOPT_CAINFO for more details)\r
* @param string $cacert certificate file name (or dir holding certificates)\r
* @param bool $is_dir set to true to indicate cacert is a dir. defaults to false\r
* @access public\r
if ($compmethod == 'any')\r
$this->accepted_compression = array('gzip', 'deflate');\r
else\r
- $this->accepted_compression = array($compmethod);\r
+ if ($compmethod == false )\r
+ $this->accepted_compression = array();\r
+ else\r
+ $this->accepted_compression = array($compmethod);\r
}\r
\r
/**\r
/**\r
* Directly set cURL options, for extra flexibility\r
* It allows eg. to bind client to a specific IP interface / address\r
- * @param $options array\r
+ * @param array $options\r
*/\r
function SetCurlOptions( $options )\r
{\r
$cookieheader = 'Cookie:' . $version . substr($cookieheader, 0, -1) . "\r\n";\r
}\r
\r
+ // omit port if 80\r
+ $port = ($port == 80) ? '' : (':' . $port);\r
+\r
$op= 'POST ' . $uri. " HTTP/1.0\r\n" .\r
'User-Agent: ' . $this->user_agent . "\r\n" .\r
- 'Host: '. $server . ':' . $port . "\r\n" .\r
+ 'Host: '. $server . $port . "\r\n" .\r
$credentials .\r
$proxy_credentials .\r
$accepted_encoding .\r
}\r
else\r
{\r
- // reset errno and errstr on succesful socket connection\r
+ // reset errno and errstr on successful socket connection\r
$this->errstr = '';\r
}\r
// G. Giunta 2005/10/24: close socket before parsing.\r
- // should yeld slightly better execution times, and make easier recursive calls (e.g. to follow http redirects)\r
+ // should yield slightly better execution times, and make easier recursive calls (e.g. to follow http redirects)\r
$ipd='';\r
do\r
{\r
// return the header too\r
curl_setopt($curl, CURLOPT_HEADER, 1);\r
\r
- // will only work with PHP >= 5.0\r
// NB: if we set an empty string, CURL will add http header indicating\r
// ALL methods it is supporting. This is possibly a better option than\r
// letting the user tell what curl can / cannot do...\r
{\r
curl_setopt($curl, CURLOPT_SSLKEYPASSWD, $keypass);\r
}\r
+\r
+ // Upgrade transparently to more stringent check for versions of php which do not support otherwise.\r
+ // Doing it in constructor would be cleaner; doing it here saves us a couple of function calls\r
+ if($this->verifyhost == 1 && $info = curl_version() && version_compare($info['version'], '7.28.1') >= 0)\r
+ {\r
+ $this->verifyhost = 2;\r
+ }\r
// 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\r
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, $this->verifyhost);\r
}\r
{\r
print "<PRE>\n---CURL INFO---\n";\r
foreach(curl_getinfo($curl) as $name => $val)\r
- print $name . ': ' . htmlentities($val). "\n";\r
+ {\r
+ if (is_array($val))\r
+ {\r
+ $val = implode("\n", $val);\r
+ }\r
+ print $name . ': ' . htmlentities($val) . "\n";\r
+ }\r
+\r
print "---END---\n</PRE>";\r
}\r
\r
curl_close($curl);\r
}\r
$resp =& $msg->parseResponse($result, true, $this->return_type);\r
+ // if we got back a 302, we can not reuse the curl handle for later calls\r
+ if($resp->faultCode() == $GLOBALS['xmlrpcerr']['http_error'] && $keepalive)\r
+ {\r
+ curl_close($curl);\r
+ $this->xmlrpc_curl_handle = null;\r
+ }\r
}\r
return $resp;\r
}\r
* @param array $msgs an array of xmlrpcmsg objects\r
* @param integer $timeout connection timeout (in seconds)\r
* @param string $method the http protocol variant to be used\r
- * @param boolean fallback When true, upon receiveing an error during multicall, multiple single calls will be attempted\r
+ * @param boolean fallback When true, upon receiving an error during multicall, multiple single calls will be attempted\r
* @return array\r
* @access public\r
*/\r
var $content_type = 'text/xml';\r
var $raw_data = '';\r
\r
+ /**\r
+ * @deprecated\r
+ */\r
+ function xmlrpcresp($val, $fcode = 0, $fstr = '', $valtyp='')\r
+ {\r
+ self::__construct($val, $fcode, $fstr, $valtyp);\r
+ }\r
+\r
/**\r
* @param mixed $val either an xmlrpcval obj, a php value or the xml serialization of an xmlrpcval (a string)\r
* @param integer $fcode set it to anything but 0 to create an error response\r
* NB: as of now we do not do it, since it might be either an xmlrpcval or a plain\r
* php val, or a complete xml chunk, depending on usage of xmlrpc_client::send() inside which creator is called...\r
*/\r
- function xmlrpcresp($val, $fcode = 0, $fstr = '', $valtyp='')\r
+ function __construct($val, $fcode = 0, $fstr = '', $valtyp='')\r
{\r
if($fcode != 0)\r
{\r
* with attributes being e.g. 'expires', 'path', domain'.\r
* NB: cookies sent as 'expired' by the server (i.e. with an expiry date in the past)\r
* are still present in the array. It is up to the user-defined code to decide\r
- * how to use the received cookies, and wheter they have to be sent back with the next\r
+ * how to use the received cookies, and whether they have to be sent back with the next\r
* request to the server (using xmlrpc_client::setCookie) or not\r
* @return array array of cookies received from the server\r
* @access public\r
$this->content_type = 'text/xml; charset=' . $charset_encoding;\r
else\r
$this->content_type = 'text/xml';\r
+ if ($GLOBALS['xmlrpc_null_apache_encoding'])\r
+ {\r
+ $result = "<methodResponse xmlns:ex=\"".$GLOBALS['xmlrpc_null_apache_encoding_ns']."\">\n";\r
+ }\r
+ else\r
+ {\r
$result = "<methodResponse>\n";\r
+ }\r
if($this->errno)\r
{\r
// G. Giunta 2005/2/13: let non-ASCII response messages be tolerated by clients\r
var $content_type = 'text/xml';\r
\r
/**\r
- * @param string $meth the name of the method to invoke\r
- * @param array $pars array of parameters to be paased to the method (xmlrpcval objects)\r
+ * @deprecated\r
*/\r
function xmlrpcmsg($meth, $pars=0)\r
+ {\r
+ self::__construct($meth, $pars);\r
+ }\r
+\r
+ /**\r
+ * @param string $meth the name of the method to invoke\r
+ * @param array $pars array of parameters to be passed to the method (xmlrpcval objects)\r
+ */\r
+ function __construct($meth, $pars=0)\r
{\r
$this->methodname=$meth;\r
if(is_array($pars) && count($pars)>0)\r
else\r
$this->content_type = 'text/xml';\r
$this->payload=$this->xml_header($charset_encoding);\r
- $this->payload.='<methodName>' . $this->methodname . "</methodName>\n";\r
+ $this->payload.='<methodName>' . xmlrpc_encode_entitites($this->methodname, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding) . "</methodName>\n";\r
$this->payload.="<params>\n";\r
for($i=0; $i<count($this->params); $i++)\r
{\r
\r
/**\r
* Returns xml representation of the message. XML prologue included\r
+ * @param string $charset_encoding\r
* @return string the xml representation of the message, xml prologue included\r
* @access public\r
*/\r
* infinite loop in that case, because we cannot trust the caller\r
* to give us a valid pointer to an open file...\r
* @access public\r
+ * @param resource $fp stream pointer\r
* @return xmlrpcresp\r
* @todo add 2nd & 3rd param to be passed to ParseResponse() ???\r
*/\r
{\r
if ($tag != 'value')\r
{\r
- $GLOBALS['_xh']['cookies'][$cookiename][$tag] = $val;\r
+ $GLOBALS['_xh']['cookies'][$cookiename][$tag] = $val;\r
}\r
}\r
}\r
$GLOBALS['_xh']['isf_reason']='';\r
$GLOBALS['_xh']['rt']=''; // 'methodcall or 'methodresponse'\r
\r
- // if response charset encoding is not known / supported, try to use\r
- // the default encoding and parse the xml anyway, but log a warning...\r
- if (!in_array($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))\r
- // the following code might be better for mb_string enabled installs, but\r
+ // Since parsing will fail if charset is not specified in the xml prologue,\r
+ // the encoding is not UTF8 and there are non-ascii chars in the text, we try to work round that...\r
+ // The following code might be better for mb_string enabled installs, but\r
// makes the lib about 200% slower...\r
- //if (!is_valid_charset($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))\r
- {\r
- error_log('XML-RPC: '.__METHOD__.': invalid charset encoding of received response: '.$resp_encoding);\r
- $resp_encoding = $GLOBALS['xmlrpc_defencoding'];\r
+ //if (!is_valid_charset($resp_encoding, array('UTF-8')))\r
+ if (!in_array($resp_encoding, array('UTF-8', 'US-ASCII')) && !has_encoding($data)) {\r
+ if ($resp_encoding == 'ISO-8859-1') {\r
+ $data = utf8_encode($data);\r
+ } else {\r
+ if (extension_loaded('mbstring')) {\r
+ $data = mb_convert_encoding($data, 'UTF-8', $resp_encoding);\r
+ } else {\r
+ error_log('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of received request: ' . $resp_encoding);\r
+ }\r
+ }\r
}\r
- $parser = xml_parser_create($resp_encoding);\r
+\r
+ $parser = xml_parser_create();\r
xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true);\r
// G. Giunta 2005/02/13: PHP internally uses ISO-8859-1, so we have to tell\r
// the xml parser to give us back data in the expected charset.\r
var $mytype=0;\r
var $_php_class=null;\r
\r
+ /**\r
+ * @deprecated\r
+ */\r
+ function xmlrpcval($val=-1, $type='')\r
+ {\r
+ self::__construct($val, $type);\r
+ }\r
+\r
/**\r
* @param mixed $val\r
* @param string $type any valid xmlrpc type name (lowercase). If null, 'string' is assumed\r
*/\r
- function xmlrpcval($val=-1, $type='')\r
+ function __construct($val=-1, $type='')\r
{\r
/// @todo: optimization creep - do not call addXX, do it all inline.\r
/// downside: booleans will not be coerced anymore\r
}\r
\r
/**\r
- * Checks wheter a struct member with a given name is present.\r
+ * Checks whether a struct member with a given name is present.\r
* Works only on xmlrpcvals of type struct.\r
* @param string $m the name of the struct member to be looked up\r
* @return boolean\r
$GLOBALS['_xh']['isf_reason'] = '';\r
$GLOBALS['_xh']['method'] = false;\r
$GLOBALS['_xh']['rt'] = '';\r
- /// @todo 'guestimate' encoding\r
+\r
+ // 'guestimate' encoding\r
+ $val_encoding = guess_encoding('', $xml_val);\r
+\r
+ // Since parsing will fail if charset is not specified in the xml prologue,\r
+ // the encoding is not UTF8 and there are non-ascii chars in the text, we try to work round that...\r
+ // The following code might be better for mb_string enabled installs, but\r
+ // makes the lib about 200% slower...\r
+ //if (!is_valid_charset($val_encoding, array('UTF-8')))\r
+ if (!in_array($val_encoding, array('UTF-8', 'US-ASCII')) && !has_encoding($xml_val)) {\r
+ if ($val_encoding == 'ISO-8859-1') {\r
+ $xml_val = utf8_encode($xml_val);\r
+ } else {\r
+ if (extension_loaded('mbstring')) {\r
+ $xml_val = mb_convert_encoding($xml_val, 'UTF-8', $val_encoding);\r
+ } else {\r
+ error_log('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of received request: ' . $val_encoding);\r
+ }\r
+ }\r
+ }\r
+\r
$parser = xml_parser_create();\r
xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true);\r
// What if internal encoding is not in one of the 3 allowed?\r
* we SHOULD assume it is strictly US-ASCII. But we try to be more tolerant of unconforming (legacy?) clients/servers,\r
* which will be most probably using UTF-8 anyway...\r
*\r
- * @param string $httpheaders the http Content-type header\r
+ * @param string $httpheader the http Content-type header\r
* @param string $xmlchunk xml content buffer\r
* @param string $encoding_prefs comma separated list of character encodings to be used as default (when mb extension is enabled)\r
+ * @return string\r
*\r
* @todo explore usage of mb_http_input(): does it detect http headers + post data? if so, use it instead of hand-detection!!!\r
*/\r
}\r
}\r
\r
+ /**\r
+ * Helper function: checks if an xml chunk as a charset declaration (BOM or in the xml declaration)\r
+ *\r
+ * @param string $xmlChunk\r
+ * @return bool\r
+ */\r
+ function has_encoding($xmlChunk)\r
+ {\r
+ // scan the first bytes of the data for a UTF-16 (or other) BOM pattern\r
+ // (source: http://www.w3.org/TR/2000/REC-xml-20001006)\r
+ if (preg_match('/^(\x00\x00\xFE\xFF|\xFF\xFE\x00\x00|\x00\x00\xFF\xFE|\xFE\xFF\x00\x00)/', $xmlChunk))\r
+ {\r
+ return true;\r
+ }\r
+ elseif (preg_match('/^(\xFE\xFF|\xFF\xFE)/', $xmlChunk))\r
+ {\r
+ return true;\r
+ }\r
+ elseif (preg_match('/^(\xEF\xBB\xBF)/', $xmlChunk))\r
+ {\r
+ return true;\r
+ }\r
+\r
+ // test if encoding is specified in the xml declaration\r
+ // Details:\r
+ // SPACE: (#x20 | #x9 | #xD | #xA)+ === [ \x9\xD\xA]+\r
+ // EQ: SPACE?=SPACE? === [ \x9\xD\xA]*=[ \x9\xD\xA]*\r
+ if (preg_match('/^<\?xml\s+version\s*=\s*' . "((?:\"[a-zA-Z0-9_.:-]+\")|(?:'[a-zA-Z0-9_.:-]+'))" .\r
+ '\s+encoding\s*=\s*' . "((?:\"[A-Za-z][A-Za-z0-9._-]*\")|(?:'[A-Za-z][A-Za-z0-9._-]*'))/",\r
+ $xmlChunk, $matches))\r
+ {\r
+ return true;\r
+ }\r
+\r
+ return false;\r
+ }\r
+\r
/**\r
* Checks if a given charset encoding is present in a list of encodings or\r
* if it is a valid subset of any encoding in the list\r
* @param string $encoding charset to be tested\r
* @param mixed $validlist comma separated list of valid charsets (or array of charsets)\r
+ * @return bool\r
*/\r
function is_valid_charset($encoding, $validlist)\r
{\r
foreach ($validlist as $allowed)\r
if (in_array($allowed, $charset_supersets[$encoding]))\r
return true;\r
- return false;\r
+ return false;\r
}\r
}\r
\r