'METHODNAME' => array('METHODCALL'),\r
'PARAMS' => array('METHODCALL', 'METHODRESPONSE'),\r
'FAULT' => array('METHODRESPONSE'),\r
- 'NIL' => array('VALUE') // only used when extension activated\r
+ 'NIL' => array('VALUE'), // only used when extension activated\r
+ 'EX:NIL' => array('VALUE') // only used when extension activated\r
);\r
\r
// define extra types for supporting NULL (useful for json or <NIL/>)\r
/// @deprecated\r
$GLOBALS['xmlrpc_backslash']=chr(92).chr(92);\r
\r
- // set to TRUE to enable correct decoding of <NIL/> values\r
+ // set to TRUE to enable correct decoding of <NIL/> and <EX:NIL/> values\r
$GLOBALS['xmlrpc_null_extension']=false;\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
+\r
// used to store state during parsing\r
// quick explanation of components:\r
// ac - used to accumulate values\r
else\r
{\r
$GLOBALS['_xh']['rt'] = strtolower($name);\r
+ $GLOBALS['_xh']['rt'] = strtolower($name);\r
}\r
}\r
else\r
$GLOBALS['_xh']['vt']=null;\r
break;\r
case 'NIL':\r
+ case 'EX:NIL':\r
if ($GLOBALS['xmlrpc_null_extension'])\r
{\r
if ($GLOBALS['_xh']['vt']!='value')\r
$GLOBALS['_xh']['value'] = $curr_val['values'];\r
$GLOBALS['_xh']['vt']=strtolower($name);\r
if (isset($curr_val['php_class']))\r
+\r
{\r
$GLOBALS['_xh']['php_class'] = $curr_val['php_class'];\r
}\r
$GLOBALS['_xh']['method']=preg_replace('/^[\n\r\t ]+/', '', $GLOBALS['_xh']['ac']);\r
break;\r
case 'NIL':\r
+ case 'EX:NIL':\r
if ($GLOBALS['xmlrpc_null_extension'])\r
{\r
$GLOBALS['_xh']['vt']='null';\r
var $proxy_pass='';\r
var $proxy_authtype=1;\r
var $cookies=array();\r
+ var $extracurlopts=array();\r
+\r
/**\r
* List of http compression methods accepted by the client for responses.\r
* NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib\r
* valid strings are 'xmlrpcvals', 'phpvals' or 'xml'\r
*/\r
var $return_type = 'xmlrpcvals';\r
+ /**\r
+ * Sent to servers in http headers\r
+ */\r
+ var $user_agent;\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
$this->accepted_compression = array('gzip', 'deflate');\r
}\r
\r
- // keepalives: enabled by default ONLY for PHP >= 4.3.8\r
+ // keepalives: enabled by default\r
$this->keepalive = true;\r
\r
// by default the xml parser can support these 3 charset encodings\r
$this->accepted_charset_encodings = array('UTF-8', 'ISO-8859-1', 'US-ASCII');\r
+\r
+ // initialize user_agent string\r
+ $this->user_agent = $GLOBALS['xmlrpcName'] . ' ' . $GLOBALS['xmlrpcVersion'];\r
}\r
\r
/**\r
function setCaCertificate($cacert, $is_dir=false)\r
{\r
if ($is_dir)\r
+\r
{\r
$this->cacertdir = $cacert;\r
}\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
}\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
+ */\r
+ function SetCurlOptions( $options )\r
+ {\r
+ $this->extracurlopts = $options;\r
+ }\r
+\r
+ /**\r
+ * Set user-agent string that will be used by this client instance\r
+ * in http headers sent to the server\r
+ */\r
+ function SetUserAgent( $agentstring )\r
+ {\r
+ $this->user_agent = $agentstring;\r
+ }\r
+\r
/**\r
* Send an xmlrpc request\r
* @param mixed $msg The message object, or an array of messages for using multicall, or the complete xml representation of a request\r
$msg->debug=$this->debug;\r
\r
if($method == 'https')\r
+\r
{\r
$r =& $this->sendPayloadHTTPS(\r
$msg,\r
$credentials='Authorization: Basic ' . base64_encode($username . ':' . $password) . "\r\n";\r
if ($authtype != 1)\r
{\r
- error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth is supported with HTTP 1.0');\r
+ error_log('XML-RPC: '.__METHOD__.': warning. Only Basic auth is supported with HTTP 1.0');\r
}\r
}\r
\r
{\r
if ($proxyauthtype != 1)\r
{\r
- error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth to proxy is supported with HTTP 1.0');\r
+ error_log('XML-RPC: '.__METHOD__.': warning. Only Basic auth to proxy is supported with HTTP 1.0');\r
}\r
$proxy_credentials = 'Proxy-Authorization: Basic ' . base64_encode($proxyusername.':'.$proxypassword) . "\r\n";\r
}\r
}\r
\r
$op= 'POST ' . $uri. " HTTP/1.0\r\n" .\r
- 'User-Agent: ' . $GLOBALS['xmlrpcName'] . ' ' . $GLOBALS['xmlrpcVersion'] . "\r\n" .\r
+ 'User-Agent: ' . $this->user_agent . "\r\n" .\r
'Host: '. $server . ':' . $port . "\r\n" .\r
$credentials .\r
$proxy_credentials .\r
\r
if(!fputs($fp, $op, strlen($op)))\r
{\r
- fclose($fp);\r
+ fclose($fp);\r
$this->errstr='Write error';\r
$r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $this->errstr);\r
return $r;\r
{\r
curl_setopt($curl, CURLOPT_VERBOSE, 1);\r
}\r
- curl_setopt($curl, CURLOPT_USERAGENT, $GLOBALS['xmlrpcName'].' '.$GLOBALS['xmlrpcVersion']);\r
+ curl_setopt($curl, CURLOPT_USERAGENT, $this->user_agent);\r
// required for XMLRPC: post the data\r
curl_setopt($curl, CURLOPT_POST, 1);\r
// the data\r
}\r
else if ($authtype != 1)\r
{\r
- error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth is supported by the current PHP/curl install');\r
+ error_log('XML-RPC: '.__METHOD__.': warning. Only Basic auth is supported by the current PHP/curl install');\r
}\r
}\r
\r
}\r
else if ($proxyauthtype != 1)\r
{\r
- error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth to proxy is supported by the current PHP/curl install');\r
+ error_log('XML-RPC: '.__METHOD__.': warning. Only Basic auth to proxy is supported by the current PHP/curl install');\r
}\r
}\r
}\r
curl_setopt($curl, CURLOPT_COOKIE, substr($cookieheader, 0, -2));\r
}\r
\r
+ foreach ($this->extracurlopts as $opt => $val)\r
+ {\r
+ curl_setopt($curl, $opt, $val);\r
+ }\r
+\r
$result = curl_exec($curl);\r
\r
if ($this->debug > 1)\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
case 1:\r
if(!isset($val[0]))\r
{\r
+\r
return false; // Bad value\r
}\r
// Normal return value\r
* Given an open file handle, read all data available and parse it as axmlrpc response.\r
* NB: the file handle is not closed by this function.\r
* NNB: might have trouble in rare cases to work on network streams, as we\r
- * check for a read of 0 bytes instead of feof($fp).\r
+ * check for a read of 0 bytes instead of feof($fp).\r
* But since checking for feof(null) returns false, we would risk an\r
* infinite loop in that case, because we cannot trust the caller\r
* to give us a valid pointer to an open file...\r
}\r
else\r
{\r
- error_log('XML-RPC: xmlrpcmsg::parseResponse: HTTPS via proxy error, tunnel connection possibly failed');\r
+ error_log('XML-RPC: '.__METHOD__.': HTTPS via proxy error, tunnel connection possibly failed');\r
$r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $GLOBALS['xmlrpcstr']['http_error']. ' (HTTPS via proxy error, tunnel connection possibly failed)');\r
return $r;\r
}\r
if(!preg_match('/^HTTP\/[0-9.]+ 200 /', $data))\r
{\r
$errstr= substr($data, 0, strpos($data, "\n")-1);\r
- error_log('XML-RPC: xmlrpcmsg::parseResponse: HTTP error, got response: ' .$errstr);\r
+ error_log('XML-RPC: '.__METHOD__.': HTTP error, got response: ' .$errstr);\r
$r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $GLOBALS['xmlrpcstr']['http_error']. ' (' . $errstr . ')');\r
return $r;\r
}\r
}\r
}\r
// be tolerant to line endings, and extra empty lines\r
- $ar = split("\r?\n", trim(substr($data, 0, $pos)));\r
+ $ar = preg_split("/\r?\n/", trim(substr($data, 0, $pos)));\r
while(list(,$line) = @each($ar))\r
{\r
// take care of multi-line headers and cookies\r
{\r
if(!$data = decode_chunked($data))\r
{\r
- error_log('XML-RPC: xmlrpcmsg::parseResponse: errors occurred when trying to rebuild the chunked data received from server');\r
+ error_log('XML-RPC: '.__METHOD__.': errors occurred when trying to rebuild the chunked data received from server');\r
$r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['dechunk_fail'], $GLOBALS['xmlrpcstr']['dechunk_fail']);\r
return $r;\r
}\r
}\r
else\r
{\r
- error_log('XML-RPC: xmlrpcmsg::parseResponse: errors occurred when trying to decode the deflated data received from server');\r
+ error_log('XML-RPC: '.__METHOD__.': errors occurred when trying to decode the deflated data received from server');\r
$r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['decompress_fail'], $GLOBALS['xmlrpcstr']['decompress_fail']);\r
return $r;\r
}\r
}\r
else\r
{\r
- 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
+ error_log('XML-RPC: '.__METHOD__.': the server sent deflated data. Your php install must have the Zlib extension compiled in to support this.');\r
$r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['cannot_decompress'], $GLOBALS['xmlrpcstr']['cannot_decompress']);\r
return $r;\r
}\r
}\r
} // end of 'if needed, de-chunk, re-inflate response'\r
\r
- // real stupid hack to avoid PHP 4 complaining about returning NULL by ref\r
+ // real stupid hack to avoid PHP complaining about returning NULL by ref\r
$r = null;\r
$r =& $r;\r
return $r;\r
\r
if($data == '')\r
{\r
- error_log('XML-RPC: xmlrpcmsg::parseResponse: no response received from server.');\r
+ error_log('XML-RPC: '.__METHOD__.': no response received from server.');\r
$r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_data'], $GLOBALS['xmlrpcstr']['no_data']);\r
return $r;\r
}\r
\r
// be tolerant of junk after methodResponse (e.g. javascript ads automatically inserted by free hosts)\r
// idea from Luca Mariano <luca.mariano@email.it> originally in PEARified version of the lib\r
- $bd = false;\r
- // Poor man's version of strrpos for php 4...\r
- $pos = strpos($data, '</methodResponse>');\r
- while($pos || is_int($pos))\r
+ $pos = strrpos($data, '</methodResponse>');\r
+ if($pos !== false)\r
{\r
- $bd = $pos+17;\r
- $pos = strpos($data, '</methodResponse>', $bd);\r
- }\r
- if($bd)\r
- {\r
- $data = substr($data, 0, $bd);\r
+ $data = substr($data, 0, $pos+17);\r
}\r
\r
// if user wants back raw xml, give it to him\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: xmlrpcmsg::parseResponse: invalid charset encoding of received response: '.$resp_encoding);\r
+ error_log('XML-RPC: '.__METHOD__.': invalid charset encoding of received response: '.$resp_encoding);\r
$resp_encoding = $GLOBALS['xmlrpc_defencoding'];\r
}\r
$parser = xml_parser_create($resp_encoding);\r
$this->me['struct']=$val;\r
break;\r
default:\r
- error_log("XML-RPC: xmlrpcval::xmlrpcval: not a known type ($type)");\r
+ error_log("XML-RPC: ".__METHOD__.": not a known type ($type)");\r
}\r
/*if($type=='')\r
{\r
$typeof=@$GLOBALS['xmlrpcTypes'][$type];\r
if($typeof!=1)\r
{\r
- error_log("XML-RPC: xmlrpcval::addScalar: not a scalar type ($type)");\r
+ error_log("XML-RPC: ".__METHOD__.": not a scalar type ($type)");\r
return 0;\r
}\r
\r
// coerce booleans into correct values\r
- // NB: we should iether do it for datetimes, integers and doubles, too,\r
- // or just plain remove this check, implemnted on booleans only...\r
+ // NB: we should either do it for datetimes, integers and doubles, too,\r
+ // or just plain remove this check, implemented on booleans only...\r
if($type==$GLOBALS['xmlrpcBoolean'])\r
{\r
if(strcasecmp($val,'true')==0 || $val==1 || ($val==true && strcasecmp($val,'false')))\r
switch($this->mytype)\r
{\r
case 1:\r
- error_log('XML-RPC: xmlrpcval::addScalar: scalar xmlrpcval can have only one value');\r
+ error_log('XML-RPC: '.__METHOD__.': scalar xmlrpcval can have only one value');\r
return 0;\r
case 3:\r
- error_log('XML-RPC: xmlrpcval::addScalar: cannot add anonymous scalar to struct xmlrpcval');\r
+ error_log('XML-RPC: '.__METHOD__.': cannot add anonymous scalar to struct xmlrpcval');\r
return 0;\r
case 2:\r
// we're adding a scalar value to an array here\r
}\r
else\r
{\r
- error_log('XML-RPC: xmlrpcval::addArray: already initialized as a [' . $this->kindOf() . ']');\r
+ error_log('XML-RPC: '.__METHOD__.': already initialized as a [' . $this->kindOf() . ']');\r
return 0;\r
}\r
}\r
}\r
else\r
{\r
- error_log('XML-RPC: xmlrpcval::addStruct: already initialized as a [' . $this->kindOf() . ']');\r
+ error_log('XML-RPC: '.__METHOD__.': already initialized as a [' . $this->kindOf() . ']');\r
return 0;\r
}\r
}\r
$rs.="<${typ}>".(int)$val."</${typ}>";\r
break;\r
case $GLOBALS['xmlrpcDouble']:\r
- // avoid using standard conversion of float to string because it is locale-dependent,\r
- // and also because the xmlrpc spec forbids exponential notation\r
- // sprintf('%F') would be most likely ok but it is only available since PHP 4.3.10 and PHP 5.0.3.\r
- // The code below tries its best at keeping max precision while avoiding exp notation,\r
- // but there is of course no limit in the number of decimal places to be used...\r
- $rs.="<${typ}>".preg_replace('/\\.?0+$/','',number_format((double)$val, 128, '.', ''))."</${typ}>";\r
+ // avoid using standard conversion of float to string because it is locale-dependent,\r
+ // and also because the xmlrpc spec forbids exponential notation.\r
+ // sprintf('%F') could be most likely ok but it fails eg. on 2e-14.\r
+ // The code below tries its best at keeping max precision while avoiding exp notation,\r
+ // but there is of course no limit in the number of decimal places to be used...\r
+ $rs.="<${typ}>".preg_replace('/\\.?0+$/','',number_format((double)$val, 128, '.', ''))."</${typ}>";\r
+ break;\r
+ case $GLOBALS['xmlrpcDateTime']:\r
+ if (is_string($val))\r
+ {\r
+ $rs.="<${typ}>${val}</${typ}>";\r
+ }\r
+ else if(is_a($val, 'DateTime'))\r
+ {\r
+ $rs.="<${typ}>".$val->format('Ymd\TH:i:s')."</${typ}>";\r
+ }\r
+ else if(is_int($val))\r
+ {\r
+ $rs.="<${typ}>".strftime("%Y%m%dT%H:%M:%S", $val)."</${typ}>";\r
+ }\r
+ else\r
+ {\r
+ // not really a good idea here: but what shall we output anyway? left for backward compat...\r
+ $rs.="<${typ}>${val}</${typ}>";\r
+ }\r
break;\r
case $GLOBALS['xmlrpcNull']:\r
- $rs.="<nil/>";\r
+ if ($GLOBALS['xmlrpc_null_apache_encoding'])\r
+ {\r
+ $rs.="<ex:nil/>";\r
+ }\r
+ else\r
+ {\r
+ $rs.="<nil/>";\r
+ }\r
break;\r
default:\r
// no standard type value should arrive here, but provide a possibility\r
* @author Dan Libby (dan@libby.com)\r
*\r
* @param xmlrpcval $xmlrpc_val\r
- * @param array $options if 'decode_php_objs' is set in the options array, xmlrpc structs can be decoded into php objects\r
+ * @param array $options if 'decode_php_objs' is set in the options array, xmlrpc structs can be decoded into php objects; if 'dates_as_objects' is set xmlrpc datetimes are decoded as php DateTime objects (standard is\r
* @return mixed\r
*/\r
function php_xmlrpc_decode($xmlrpc_val, $options=array())\r
return $xmlrpc_val->scalarval();\r
}\r
}\r
+ if (in_array('dates_as_objects', $options) && $xmlrpc_val->scalartyp() == 'dateTime.iso8601')\r
+ {\r
+ // we return a Datetime object instead of a string\r
+ // since now the constructor of xmlrpcval accepts safely strings, ints and datetimes,\r
+ // we cater to all 3 cases here\r
+ $out = $xmlrpc_val->scalarval();\r
+ if (is_string($out))\r
+ {\r
+ $out = strtotime($out);\r
+ }\r
+ if (is_int($out))\r
+ {\r
+ $result = new Datetime();\r
+ $result->setTimestamp($out);\r
+ return $result;\r
+ }\r
+ elseif (is_a($out, 'Datetime'))\r
+ {\r
+ return $out;\r
+ }\r
+ }\r
return $xmlrpc_val->scalarval();\r
case 'array':\r
$size = $xmlrpc_val->arraysize();\r
* @param array $options can include 'encode_php_objs', 'auto_dates', 'null_extension' or 'extension_api'\r
* @return xmlrpcval\r
*/\r
- function &php_xmlrpc_encode($php_val, $options=array())\r
+ function php_xmlrpc_encode($php_val, $options=array())\r
{\r
$type = gettype($php_val);\r
switch($type)\r
$ko = false;\r
foreach($php_val as $key => $val)\r
{\r
- $arr[$key] =& php_xmlrpc_encode($val, $options);\r
+ $arr[$key] = php_xmlrpc_encode($val, $options);\r
if(!$ko && $key !== $j)\r
{\r
$ko = true;\r
{\r
$xmlrpc_val = $php_val;\r
}\r
+ else if(is_a($php_val, 'DateTime'))\r
+ {\r
+ $xmlrpc_val = new xmlrpcval($php_val->format('Ymd\TH:i:s'), $GLOBALS['xmlrpcStruct']);\r
+ }\r
else\r
{\r
$arr = array();\r
+ reset($php_val);\r
while(list($k,$v) = each($php_val))\r
{\r
$arr[$k] = php_xmlrpc_encode($v, $options);\r
{\r
$xmlrpc_val = new xmlrpcval('', $GLOBALS['xmlrpcString']);\r
}\r
- if (in_array('null_extension', $options))\r
+ else if (in_array('null_extension', $options))\r
{\r
$xmlrpc_val = new xmlrpcval('', $GLOBALS['xmlrpcNull']);\r
}\r
$xmlrpc_val = new xmlrpcval((int)$php_val, $GLOBALS['xmlrpcInt']);\r
}\r
else\r
+\r
{\r
$xmlrpc_val = new xmlrpcval();\r
}\r
// Note: we do not check for invalid chars in VALUE:\r
// this had better be done using pure ereg as below\r
// Note 2: we might be removing whitespace/tabs that ought to be left in if\r
- // the received charset is a quoted string. But nobody uses such charset names...\r
+ // the received charset is a quoted string. But nobody uses such charset names...\r
\r
/// @todo this test will pass if ANY header has charset specification, not only Content-Type. Fix it?\r
$matches = array();\r
}\r
elseif(preg_match('/^(\xEF\xBB\xBF)/', $xmlchunk))\r
{\r
+\r
return 'UTF-8';\r
}\r
\r
git://git.onelab.eu / plcapi.git / blobdiff