856 lines
25 KiB
PHP
856 lines
25 KiB
PHP
<?php
|
|
/* vim: set noexpandtab tabstop=2 softtabstop=2 shiftwidth=2: */
|
|
|
|
/*
|
|
IXR - The Incutio XML-RPC Library - (c) Incutio Ltd 2002
|
|
Version 1.61 - Simon Willison, 11th July 2003 (htmlentities -> htmlspecialchars)
|
|
Site: http://scripts.incutio.com/xmlrpc/
|
|
Manual: http://scripts.incutio.com/xmlrpc/manual.php
|
|
Errors: http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php
|
|
Made available under the Artistic License: http://www.opensource.org/licenses/artistic-license.php
|
|
|
|
Modified to support protocol 'GbxRemote 2' ('GbxRemote 1')
|
|
This version is for LittleEndian (e.g. Intel PC) machines. For BegEndian
|
|
machines use GbxRemote.bem.php as GbxRemote.inc.php instead.
|
|
|
|
Release 2007-09-22 - Slig:
|
|
Modified to support >256KB received data (and now >2MB data produce a specific error message)
|
|
Modified readCB() to wait the initial timeout only before first read packet
|
|
Modified readCB() to return true if there is data to get with getCBResponses()
|
|
Modified to support amd64 (for $recvhandle)
|
|
Modified IXR_ClientMulticall_Gbx::addCall() to fit Aseco 0.6.1
|
|
Added IXR_Client_Gbx::bytes_sent & bytes_received counters
|
|
Fix for a changed feature since php5.1.1 about reference parameter assignment (was used in stream_select)
|
|
Workaround for stream_select return value bug with amd64
|
|
|
|
Release 2008-01-20 - Slig / Xymph / Assembler Maniac:
|
|
Workaround for fread delay bug in some cases
|
|
Added IXR_Client_Gbx::resetError() method (by Xymph)
|
|
Some comments and strings code cleanup (by Xymph)
|
|
Fix stream_set_timeout($this->socket,...) (thx to CavalierDeVache)
|
|
Added a default timeout value to IXR_Client_Gbx::readCB($timeout)
|
|
Changed calls with timeout on a stream to use microseconds instead of seconds (by AM)
|
|
Removed IXR_Client_Gbx::bytes_sent & bytes_received counters - not used (by AM)
|
|
|
|
Release 2008-02-05 - Slig:
|
|
Changed some socket read/write timeouts back to seconds to avoid 'transport error'
|
|
Changed max data received from 2MB to 4MB
|
|
|
|
Release 2008-05-20 - Xymph:
|
|
Prevented unpack() warnings in IXR_Client_Gbx::query() when the connection dies
|
|
Changed IXR_Client_Gbx::resetError() to assign 'false' for correct isError()
|
|
Tweaked some 'transport error' messages
|
|
|
|
Release 2009-04-08 - Gou1:
|
|
Added method IXR_Client_Gbx::queryIgnoreResult()
|
|
Added methods IXR_Client_Gbx::sendRequest() & IXR_Client_Gbx::getResult()
|
|
IXR_Client_Gbx::queryIgnoreResult checks if the request is larger than 512KB to avoid errors
|
|
If larger than 512KB and method is system.multicall, try to divide the request into
|
|
two separate requests with two separate IXR_Client_Gbx::queryIgnoreResult() calls
|
|
|
|
Release 2009-06-03 - Xymph:
|
|
Suppress possible repetitive CRT warning at stream_select
|
|
|
|
Release 2011-04-09 - Xymph / La beuze:
|
|
Added optional timeout mechanism to IXR_Client_Gbx::InitWithIp()
|
|
|
|
Release 2011-05-22 - Xymph:
|
|
Added non-error (true) return status to IXR_Client_Gbx::queryIgnoreResult()
|
|
Updated status codes and messages for transport/endian errors
|
|
Prevented possible PHP warning in IXR_Client_Gbx::getErrorCode() and getErrorMessage()
|
|
*/
|
|
|
|
if (!defined('LF')) {
|
|
define('LF', "\n");
|
|
}
|
|
|
|
class IXR_Value {
|
|
public $data;
|
|
public $type;
|
|
|
|
function IXR_Value ($data, $type = false) {
|
|
$this->data = $data;
|
|
if (!$type) {
|
|
$type = $this->calculateType();
|
|
}
|
|
$this->type = $type;
|
|
if ($type == 'struct') {
|
|
// Turn all the values in the array into new IXR_Value objects
|
|
foreach ($this->data as $key => $value) {
|
|
$this->data[$key] = new IXR_Value($value);
|
|
}
|
|
}
|
|
if ($type == 'array') {
|
|
for ($i = 0, $j = count($this->data); $i < $j; $i++) {
|
|
$this->data[$i] = new IXR_Value($this->data[$i]);
|
|
}
|
|
}
|
|
}
|
|
|
|
function calculateType() {
|
|
if ($this->data === true || $this->data === false) {
|
|
return 'boolean';
|
|
}
|
|
if (is_integer($this->data)) {
|
|
return 'int';
|
|
}
|
|
if (is_double($this->data)) {
|
|
return 'double';
|
|
}
|
|
// Deal with IXR object types base64 and date
|
|
if (is_object($this->data) && is_a($this->data, 'IXR_Date')) {
|
|
return 'date';
|
|
}
|
|
if (is_object($this->data) && is_a($this->data, 'IXR_Base64')) {
|
|
return 'base64';
|
|
}
|
|
// If it is a normal PHP object convert it into a struct
|
|
if (is_object($this->data)) {
|
|
$this->data = get_object_vars($this->data);
|
|
return 'struct';
|
|
}
|
|
if (!is_array($this->data)) {
|
|
return 'string';
|
|
}
|
|
// We have an array - is it an array or a struct?
|
|
if ($this->isStruct($this->data)) {
|
|
return 'struct';
|
|
} else {
|
|
return 'array';
|
|
}
|
|
}
|
|
|
|
function getXml() {
|
|
// Return XML for this value
|
|
switch ($this->type) {
|
|
case 'boolean':
|
|
return '<boolean>' . ($this->data ? '1' : '0') . '</boolean>';
|
|
break;
|
|
case 'int':
|
|
return '<int>' . $this->data . '</int>';
|
|
break;
|
|
case 'double':
|
|
return '<double>' . $this->data . '</double>';
|
|
break;
|
|
case 'string':
|
|
return '<string>' . htmlspecialchars($this->data) . '</string>';
|
|
break;
|
|
case 'array':
|
|
$return = '<array><data>' . LF;
|
|
foreach ($this->data as $item) {
|
|
$return .= ' <value>' . $item->getXml() . '</value>' . LF;
|
|
}
|
|
$return .= '</data></array>';
|
|
return $return;
|
|
break;
|
|
case 'struct':
|
|
$return = '<struct>' . LF;
|
|
foreach ($this->data as $name => $value) {
|
|
$return .= ' <member><name>' . $name . '</name><value>';
|
|
$return .= $value->getXml() . '</value></member>' . LF;
|
|
}
|
|
$return .= '</struct>';
|
|
return $return;
|
|
break;
|
|
case 'date':
|
|
case 'base64':
|
|
return $this->data->getXml();
|
|
break;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
function isStruct($array) {
|
|
// Nasty function to check if an array is a struct or not
|
|
$expected = 0;
|
|
foreach ($array as $key => $value) {
|
|
if ((string)$key != (string)$expected) {
|
|
return true;
|
|
}
|
|
$expected++;
|
|
}
|
|
return false;
|
|
}
|
|
}
|
|
|
|
|
|
class IXR_Message {
|
|
public $message;
|
|
public $messageType; // methodCall / methodResponse / fault
|
|
public $faultCode;
|
|
public $faultString;
|
|
public $methodName;
|
|
public $params;
|
|
// Current variable stacks
|
|
protected $_arraystructs = array(); // Stack to keep track of the current array/struct
|
|
protected $_arraystructstypes = array(); // Stack to keep track of whether things are structs or array
|
|
protected $_currentStructName = array(); // A stack as well
|
|
protected $_param;
|
|
protected $_value;
|
|
protected $_currentTag;
|
|
protected $_currentTagContents;
|
|
// The XML parser
|
|
protected $_parser;
|
|
|
|
function IXR_Message ($message) {
|
|
$this->message = $message;
|
|
}
|
|
|
|
function parse() {
|
|
// first remove the XML declaration
|
|
$this->message = preg_replace('/<\?xml(.*)?\?'.'>/', '', $this->message);
|
|
if (trim($this->message) == '') {
|
|
return false;
|
|
}
|
|
$this->_parser = xml_parser_create();
|
|
// Set XML parser to take the case of tags into account
|
|
xml_parser_set_option($this->_parser, XML_OPTION_CASE_FOLDING, false);
|
|
// Set XML parser callback functions
|
|
xml_set_object($this->_parser, $this);
|
|
xml_set_element_handler($this->_parser, 'tag_open', 'tag_close');
|
|
xml_set_character_data_handler($this->_parser, 'cdata');
|
|
if (!xml_parse($this->_parser, $this->message)) {
|
|
/* die(sprintf('GbxRemote XML error: %s at line %d',
|
|
xml_error_string(xml_get_error_code($this->_parser)),
|
|
xml_get_current_line_number($this->_parser))); */
|
|
return false;
|
|
}
|
|
xml_parser_free($this->_parser);
|
|
// Grab the error messages, if any
|
|
if ($this->messageType == 'fault') {
|
|
$this->faultCode = $this->params[0]['faultCode'];
|
|
$this->faultString = $this->params[0]['faultString'];
|
|
}
|
|
return true;
|
|
}
|
|
|
|
function tag_open($parser, $tag, $attr) {
|
|
$this->currentTag = $tag;
|
|
switch ($tag) {
|
|
case 'methodCall':
|
|
case 'methodResponse':
|
|
case 'fault':
|
|
$this->messageType = $tag;
|
|
break;
|
|
// Deal with stacks of arrays and structs
|
|
case 'data': // data is to all intents and purposes more interesting than array
|
|
$this->_arraystructstypes[] = 'array';
|
|
$this->_arraystructs[] = array();
|
|
break;
|
|
case 'struct':
|
|
$this->_arraystructstypes[] = 'struct';
|
|
$this->_arraystructs[] = array();
|
|
break;
|
|
}
|
|
}
|
|
|
|
function cdata($parser, $cdata) {
|
|
$this->_currentTagContents .= $cdata;
|
|
}
|
|
|
|
function tag_close($parser, $tag) {
|
|
$valueFlag = false;
|
|
switch ($tag) {
|
|
case 'int':
|
|
case 'i4':
|
|
$value = (int)trim($this->_currentTagContents);
|
|
$this->_currentTagContents = '';
|
|
$valueFlag = true;
|
|
break;
|
|
case 'double':
|
|
$value = (double)trim($this->_currentTagContents);
|
|
$this->_currentTagContents = '';
|
|
$valueFlag = true;
|
|
break;
|
|
case 'string':
|
|
$value = (string)trim($this->_currentTagContents);
|
|
$this->_currentTagContents = '';
|
|
$valueFlag = true;
|
|
break;
|
|
case 'dateTime.iso8601':
|
|
$value = new IXR_Date(trim($this->_currentTagContents));
|
|
// $value = $iso->getTimestamp();
|
|
$this->_currentTagContents = '';
|
|
$valueFlag = true;
|
|
break;
|
|
case 'value':
|
|
// If no type is indicated, the type is string
|
|
if (trim($this->_currentTagContents) != '') {
|
|
$value = (string)$this->_currentTagContents;
|
|
$this->_currentTagContents = '';
|
|
$valueFlag = true;
|
|
}
|
|
break;
|
|
case 'boolean':
|
|
$value = (boolean)trim($this->_currentTagContents);
|
|
$this->_currentTagContents = '';
|
|
$valueFlag = true;
|
|
break;
|
|
case 'base64':
|
|
$value = base64_decode($this->_currentTagContents);
|
|
$this->_currentTagContents = '';
|
|
$valueFlag = true;
|
|
break;
|
|
// Deal with stacks of arrays and structs
|
|
case 'data':
|
|
case 'struct':
|
|
$value = array_pop($this->_arraystructs);
|
|
array_pop($this->_arraystructstypes);
|
|
$valueFlag = true;
|
|
break;
|
|
case 'member':
|
|
array_pop($this->_currentStructName);
|
|
break;
|
|
case 'name':
|
|
$this->_currentStructName[] = trim($this->_currentTagContents);
|
|
$this->_currentTagContents = '';
|
|
break;
|
|
case 'methodName':
|
|
$this->methodName = trim($this->_currentTagContents);
|
|
$this->_currentTagContents = '';
|
|
break;
|
|
}
|
|
|
|
if ($valueFlag) {
|
|
/*
|
|
if (!is_array($value) && !is_object($value)) {
|
|
$value = trim($value);
|
|
}
|
|
*/
|
|
if (count($this->_arraystructs) > 0) {
|
|
// Add value to struct or array
|
|
if ($this->_arraystructstypes[count($this->_arraystructstypes)-1] == 'struct') {
|
|
// Add to struct
|
|
$this->_arraystructs[count($this->_arraystructs)-1][$this->_currentStructName[count($this->_currentStructName)-1]] = $value;
|
|
} else {
|
|
// Add to array
|
|
$this->_arraystructs[count($this->_arraystructs)-1][] = $value;
|
|
}
|
|
} else {
|
|
// Just add as a paramater
|
|
$this->params[] = $value;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
class IXR_Request {
|
|
public $method;
|
|
public $args;
|
|
public $xml;
|
|
|
|
function IXR_Request($method, $args) {
|
|
$this->method = $method;
|
|
$this->args = $args;
|
|
$this->xml = '<?xml version="1.0" encoding="utf-8" ?><methodCall><methodName>' . $this->method . '</methodName><params>';
|
|
foreach ($this->args as $arg) {
|
|
$this->xml .= '<param><value>';
|
|
$v = new IXR_Value($arg);
|
|
$this->xml .= $v->getXml();
|
|
$this->xml .= '</value></param>' . LF;
|
|
}
|
|
$this->xml .= '</params></methodCall>';
|
|
}
|
|
|
|
function getLength() {
|
|
return strlen($this->xml);
|
|
}
|
|
|
|
function getXml() {
|
|
return $this->xml;
|
|
}
|
|
}
|
|
|
|
|
|
class IXR_Error {
|
|
public $code;
|
|
public $message;
|
|
|
|
function IXR_Error($code, $message) {
|
|
$this->code = $code;
|
|
$this->message = $message;
|
|
}
|
|
|
|
function getXml() {
|
|
$xml = <<<EOD
|
|
<methodResponse>
|
|
<fault>
|
|
<value>
|
|
<struct>
|
|
<member>
|
|
<name>faultCode</name>
|
|
<value><int>{$this->code}</int></value>
|
|
</member>
|
|
<member>
|
|
<name>faultString</name>
|
|
<value><string>{$this->message}</string></value>
|
|
</member>
|
|
</struct>
|
|
</value>
|
|
</fault>
|
|
</methodResponse>
|
|
EOD;
|
|
return $xml;
|
|
}
|
|
}
|
|
|
|
|
|
class IXR_Date {
|
|
public $year;
|
|
public $month;
|
|
public $day;
|
|
public $hour;
|
|
public $minute;
|
|
public $second;
|
|
|
|
function IXR_Date($time) {
|
|
// $time can be a PHP timestamp or an ISO one
|
|
if (is_numeric($time)) {
|
|
$this->parseTimestamp($time);
|
|
} else {
|
|
$this->parseIso($time);
|
|
}
|
|
}
|
|
|
|
function parseTimestamp($timestamp) {
|
|
$this->year = date('Y', $timestamp);
|
|
$this->month = date('Y', $timestamp);
|
|
$this->day = date('Y', $timestamp);
|
|
$this->hour = date('H', $timestamp);
|
|
$this->minute = date('i', $timestamp);
|
|
$this->second = date('s', $timestamp);
|
|
}
|
|
|
|
function parseIso($iso) {
|
|
$this->year = substr($iso, 0, 4);
|
|
$this->month = substr($iso, 4, 2);
|
|
$this->day = substr($iso, 6, 2);
|
|
$this->hour = substr($iso, 9, 2);
|
|
$this->minute = substr($iso, 12, 2);
|
|
$this->second = substr($iso, 15, 2);
|
|
}
|
|
|
|
function getIso() {
|
|
return $this->year.$this->month.$this->day.'T'.$this->hour.':'.$this->minute.':'.$this->second;
|
|
}
|
|
|
|
function getXml() {
|
|
return '<dateTime.iso8601>'.$this->getIso().'</dateTime.iso8601>';
|
|
}
|
|
|
|
function getTimestamp() {
|
|
return mktime($this->hour, $this->minute, $this->second, $this->month, $this->day, $this->year);
|
|
}
|
|
}
|
|
|
|
|
|
class IXR_Base64 {
|
|
public $data;
|
|
|
|
function IXR_Base64($data) {
|
|
$this->data = $data;
|
|
}
|
|
|
|
function getXml() {
|
|
return '<base64>'.base64_encode($this->data).'</base64>';
|
|
}
|
|
}
|
|
|
|
|
|
//////////////////////////////////////////////////////////
|
|
// Nadeo modifications //
|
|
// (many thanks to slig for adding callback support) //
|
|
//////////////////////////////////////////////////////////
|
|
class IXR_Client_Gbx {
|
|
public $socket;
|
|
public $message = false;
|
|
public $cb_message = array();
|
|
public $reqhandle;
|
|
public $protocol = 0;
|
|
// Storage place for an error message
|
|
public $error = false;
|
|
|
|
function bigEndianTest() {
|
|
list($endiantest) = array_values(unpack('L1L', pack('V', 1)));
|
|
if ($endiantest != 1) {
|
|
echo "Machine reports itself as BigEndian, float handling must be altered\r\n";
|
|
echo "Overwrite GbxRemote.inc.php with GbxRemote.bem.php\r\n";
|
|
die('App Terminated');
|
|
return false;
|
|
}
|
|
return true;
|
|
} // bigEndianTest
|
|
|
|
function IXR_Client_Gbx() {
|
|
$this->socket = false;
|
|
$this->reqhandle = 0x80000000;
|
|
}
|
|
|
|
function InitWithIp($ip, $port, $timeout = null) {
|
|
|
|
if (!$this->bigEndianTest()) {
|
|
$this->error = new IXR_Error(-31999, 'endian error - script doesn\'t match machine type');
|
|
return false;
|
|
}
|
|
|
|
// open connection, with timeout if specified
|
|
if (!isset($timeout)) {
|
|
$this->socket = @fsockopen($ip, $port, $errno, $errstr);
|
|
} else {
|
|
$init_time = microtime(true);
|
|
$init_timeout = 5; // retry every 5s
|
|
while (true) {
|
|
$this->socket = @fsockopen($ip, $port, $errno, $errstr, $init_timeout);
|
|
if ($this->socket || (microtime(true) - $init_time >= $timeout))
|
|
break;
|
|
}
|
|
}
|
|
if (!$this->socket) {
|
|
$this->error = new IXR_Error(-32300, "transport error - could not open socket (error: $errno, $errstr)");
|
|
return false;
|
|
}
|
|
// handshake
|
|
$array_result = unpack('Vsize', fread($this->socket, 4));
|
|
$size = $array_result['size'];
|
|
if ($size > 64) {
|
|
$this->error = new IXR_Error(-32300, 'transport error - wrong lowlevel protocol header');
|
|
return false;
|
|
}
|
|
$handshake = fread($this->socket, $size);
|
|
if ($handshake == 'GBXRemote 1') {
|
|
$this->protocol = 1;
|
|
} else if ($handshake == 'GBXRemote 2') {
|
|
$this->protocol = 2;
|
|
} else {
|
|
$this->error = new IXR_Error(-32300, 'transport error - wrong lowlevel protocol version');
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
function Init($port) {
|
|
return $this->InitWithIp('localhost', $port);
|
|
}
|
|
|
|
function Terminate() {
|
|
if ($this->socket) {
|
|
fclose($this->socket);
|
|
$this->socket = false;
|
|
}
|
|
}
|
|
|
|
protected function sendRequest(IXR_Request $request) {
|
|
$xml = $request->getXml();
|
|
|
|
@stream_set_timeout($this->socket, 20); // timeout 20s (to write the request)
|
|
// send request
|
|
$this->reqhandle++;
|
|
if ($this->protocol == 1) {
|
|
$bytes = pack('Va*', strlen($xml), $xml);
|
|
} else {
|
|
$bytes = pack('VVa*', strlen($xml), $this->reqhandle, $xml);
|
|
}
|
|
|
|
$bytes_to_write = strlen($bytes);
|
|
while ($bytes_to_write > 0) {
|
|
$r = @fwrite($this->socket, $bytes);
|
|
if ($r === false || $r == 0) {
|
|
// connection interrupted
|
|
return false; // or die?
|
|
}
|
|
|
|
$bytes_to_write -= $r;
|
|
if ($bytes_to_write == 0)
|
|
break;
|
|
|
|
$bytes = substr($bytes, $r);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
protected function getResult() {
|
|
$contents = '';
|
|
$contents_length = 0;
|
|
do {
|
|
$size = 0;
|
|
$recvhandle = 0;
|
|
@stream_set_timeout($this->socket, 20); // timeout 20s (to read the reply header)
|
|
// Get result
|
|
if ($this->protocol == 1) {
|
|
$contents = fread($this->socket, 4);
|
|
if (strlen($contents) == 0) {
|
|
$this->error = new IXR_Error(-32300, 'transport error - cannot read size');
|
|
return false;
|
|
}
|
|
$array_result = unpack('Vsize', $contents);
|
|
$size = $array_result['size'];
|
|
$recvhandle = $this->reqhandle;
|
|
} else {
|
|
$contents = fread($this->socket, 8);
|
|
if (strlen($contents) == 0) {
|
|
$this->error = new IXR_Error(-32300, 'transport error - cannot read size/handle');
|
|
return false;
|
|
}
|
|
$array_result = unpack('Vsize/Vhandle', $contents);
|
|
$size = $array_result['size'];
|
|
$recvhandle = $array_result['handle'];
|
|
// -- amd64 support --
|
|
$bits = sprintf('%b', $recvhandle);
|
|
if (strlen($bits) == 64) {
|
|
$recvhandle = bindec(substr($bits, 32));
|
|
}
|
|
}
|
|
|
|
if ($recvhandle == 0 || $size == 0) {
|
|
$this->error = new IXR_Error(-32300, 'transport error - connection interrupted!');
|
|
return false;
|
|
}
|
|
if ($size > 4096*1024) {
|
|
$this->error = new IXR_Error(-32300, "transport error - response too large ($size)");
|
|
return false;
|
|
}
|
|
|
|
$contents = '';
|
|
$contents_length = 0;
|
|
@stream_set_timeout($this->socket, 0, 10000); // timeout 10 ms (for successive reads until end)
|
|
while ($contents_length < $size) {
|
|
$contents .= fread($this->socket, $size-$contents_length);
|
|
$contents_length = strlen($contents);
|
|
}
|
|
|
|
if (($recvhandle & 0x80000000) == 0) {
|
|
// this is a callback, not our answer! handle= $recvhandle, xml-rpc= $contents
|
|
// just add it to the message list for the user to read
|
|
$new_cb_message = new IXR_Message($contents);
|
|
if ($new_cb_message->parse() && $new_cb_message->messageType != 'fault') {
|
|
array_push($this->cb_message, array($new_cb_message->methodName, $new_cb_message->params));
|
|
}
|
|
}
|
|
} while ((int)$recvhandle != (int)$this->reqhandle);
|
|
|
|
$this->message = new IXR_Message($contents);
|
|
if (!$this->message->parse()) {
|
|
// XML error
|
|
$this->error = new IXR_Error(-32700, 'parse error. not well formed');
|
|
return false;
|
|
}
|
|
// Is the message a fault?
|
|
if ($this->message->messageType == 'fault') {
|
|
$this->error = new IXR_Error($this->message->faultCode, $this->message->faultString);
|
|
return false;
|
|
}
|
|
// Message must be OK
|
|
return true;
|
|
}
|
|
|
|
|
|
function query() {
|
|
$args = func_get_args();
|
|
$method = array_shift($args);
|
|
|
|
if (!$this->socket || $this->protocol == 0) {
|
|
$this->error = new IXR_Error(-32300, 'transport error - client not initialized');
|
|
return false;
|
|
}
|
|
|
|
$request = new IXR_Request($method, $args);
|
|
|
|
// Check if request is larger than 512 Kbytes
|
|
if (($size = $request->getLength()) > 512*1024-8) {
|
|
$this->error = new IXR_Error(-32300, "transport error - request too large ($size)");
|
|
return false;
|
|
}
|
|
|
|
// Send request
|
|
$ok = $this->sendRequest($request);
|
|
if (!$ok) {
|
|
$this->error = new IXR_Error(-32300, 'transport error - connection interrupted!');
|
|
return false;
|
|
}
|
|
|
|
// Get result
|
|
return $this->getResult();
|
|
}
|
|
|
|
// Non-blocking query method: doesn't read the response
|
|
function queryIgnoreResult() {
|
|
$args = func_get_args();
|
|
$method = array_shift($args);
|
|
|
|
if (!$this->socket || $this->protocol == 0) {
|
|
$this->error = new IXR_Error(-32300, 'transport error - client not initialized');
|
|
return false;
|
|
}
|
|
|
|
$request = new IXR_Request($method, $args);
|
|
|
|
// Check if the request is greater than 512 Kbytes to avoid errors
|
|
// If the method is system.multicall, make two calls (possibly recursively)
|
|
if (($size = $request->getLength()) > 512*1024-8) {
|
|
if ($method = 'system.multicall' && isset($args[0])) {
|
|
$count = count($args[0]);
|
|
// If count is 1, query cannot be reduced
|
|
if ($count < 2) {
|
|
$this->error = new IXR_Error(-32300, "transport error - request too large ($size)");
|
|
return false;
|
|
}
|
|
$length = floor($count/2);
|
|
$args1 = array_slice($args[0], 0, $length);
|
|
$args2 = array_slice($args[0], $length, ($count-$length));
|
|
|
|
$res1 = $this->queryIgnoreResult('system.multicall', $args1);
|
|
$res2 = $this->queryIgnoreResult('system.multicall', $args2);
|
|
return ($res1 && $res2);
|
|
}
|
|
// If the method is not a multicall, just stop
|
|
else {
|
|
$this->error = new IXR_Error(-32300, "transport error - request too large ($size)");
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// Send request
|
|
$ok = $this->sendRequest($request);
|
|
if (!$ok) {
|
|
$this->error = new IXR_Error(-32300, 'transport error - connection interrupted!');
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
function readCB($timeout = 2000) { // timeout 2 ms
|
|
if (!$this->socket || $this->protocol == 0) {
|
|
$this->error = new IXR_Error(-32300, 'transport error - client not initialized');
|
|
return false;
|
|
}
|
|
if ($this->protocol == 1)
|
|
return false;
|
|
|
|
$something_received = count($this->cb_message)>0;
|
|
$contents = '';
|
|
$contents_length = 0;
|
|
|
|
@stream_set_timeout($this->socket, 0, 10000); // timeout 10 ms (to read available data)
|
|
// (assignment in arguments is forbidden since php 5.1.1)
|
|
$read = array($this->socket);
|
|
$write = NULL;
|
|
$except = NULL;
|
|
$nb = @stream_select($read, $write, $except, 0, $timeout);
|
|
// workaround for stream_select bug with amd64
|
|
if ($nb !== false)
|
|
$nb = count($read);
|
|
|
|
while ($nb !== false && $nb > 0) {
|
|
$timeout = 0; // we don't want to wait for the full time again, just flush the available data
|
|
|
|
$size = 0;
|
|
$recvhandle = 0;
|
|
// Get result
|
|
$contents = fread($this->socket, 8);
|
|
if (strlen($contents) == 0) {
|
|
$this->error = new IXR_Error(-32300, 'transport error - cannot read size/handle');
|
|
return false;
|
|
}
|
|
$array_result = unpack('Vsize/Vhandle', $contents);
|
|
$size = $array_result['size'];
|
|
$recvhandle = $array_result['handle'];
|
|
|
|
if ($recvhandle == 0 || $size == 0) {
|
|
$this->error = new IXR_Error(-32300, 'transport error - connection interrupted!');
|
|
return false;
|
|
}
|
|
if ($size > 4096*1024) {
|
|
$this->error = new IXR_Error(-32300, "transport error - response too large ($size)");
|
|
return false;
|
|
}
|
|
|
|
$contents = '';
|
|
$contents_length = 0;
|
|
while ($contents_length < $size) {
|
|
$contents .= fread($this->socket, $size-$contents_length);
|
|
$contents_length = strlen($contents);
|
|
}
|
|
|
|
if (($recvhandle & 0x80000000) == 0) {
|
|
// this is a callback. handle= $recvhandle, xml-rpc= $contents
|
|
//echo 'CALLBACK('.$contents_length.')[ '.$contents.' ]' . LF;
|
|
$new_cb_message = new IXR_Message($contents);
|
|
if ($new_cb_message->parse() && $new_cb_message->messageType != 'fault') {
|
|
array_push($this->cb_message, array($new_cb_message->methodName, $new_cb_message->params));
|
|
}
|
|
$something_received = true;
|
|
}
|
|
|
|
// (assignment in arguments is forbidden since php 5.1.1)
|
|
$read = array($this->socket);
|
|
$write = NULL;
|
|
$except = NULL;
|
|
$nb = @stream_select($read, $write, $except, 0, $timeout);
|
|
// workaround for stream_select bug with amd64
|
|
if ($nb !== false)
|
|
$nb = count($read);
|
|
}
|
|
return $something_received;
|
|
}
|
|
|
|
function getResponse() {
|
|
// methodResponses can only have one param - return that
|
|
return $this->message->params[0];
|
|
}
|
|
|
|
function getCBResponses() {
|
|
// (look at the end of basic.php for an example)
|
|
$messages = $this->cb_message;
|
|
$this->cb_message = array();
|
|
return $messages;
|
|
}
|
|
|
|
function isError() {
|
|
return is_object($this->error);
|
|
}
|
|
|
|
function resetError() {
|
|
$this->error = false;
|
|
}
|
|
|
|
function getErrorCode() {
|
|
if ($this->isError())
|
|
return $this->error->code;
|
|
else
|
|
return 0;
|
|
}
|
|
|
|
function getErrorMessage() {
|
|
if ($this->isError())
|
|
return $this->error->message;
|
|
else
|
|
return '';
|
|
}
|
|
}
|
|
|
|
|
|
class IXR_ClientMulticall_Gbx extends IXR_Client_Gbx {
|
|
public $calls = array();
|
|
|
|
function addCall($methodName, $args) {
|
|
$struct = array('methodName' => $methodName, 'params' => $args);
|
|
$this->calls[] = $struct;
|
|
|
|
return (count($this->calls) - 1);
|
|
}
|
|
|
|
function multiquery($ignoreResult = false) {
|
|
// Prepare multicall, then call the parent::query() (or queryIgnoreResult) method
|
|
if ($ignoreResult) {
|
|
$result = parent::queryIgnoreResult('system.multicall', $this->calls);
|
|
} else {
|
|
$result = parent::query('system.multicall', $this->calls);
|
|
}
|
|
$this->calls = array(); // reset for next calls
|
|
return $result;
|
|
}
|
|
}
|
|
|