\r
class Xmlrpc {\r
\r
- public $xmlrpcI4 = "i4";\r
- public $xmlrpcInt = "int";\r
- public $xmlrpcBoolean = "boolean";\r
- public $xmlrpcDouble = "double";\r
- public $xmlrpcString = "string";\r
- public $xmlrpcDateTime = "dateTime.iso8601";\r
- public $xmlrpcBase64 = "base64";\r
- public $xmlrpcArray = "array";\r
- public $xmlrpcStruct = "struct";\r
- public $xmlrpcValue = "undefined";\r
- public $xmlrpcNull = "null";\r
-\r
- public $xmlrpcTypes;\r
-\r
- public $xmlrpc_valid_parents = array(\r
- 'VALUE' => array('MEMBER', 'DATA', 'PARAM', 'FAULT'),\r
- 'BOOLEAN' => array('VALUE'),\r
- 'I4' => array('VALUE'),\r
- 'INT' => array('VALUE'),\r
- 'STRING' => array('VALUE'),\r
- 'DOUBLE' => array('VALUE'),\r
- 'DATETIME.ISO8601' => array('VALUE'),\r
- 'BASE64' => array('VALUE'),\r
- 'MEMBER' => array('STRUCT'),\r
- 'NAME' => array('MEMBER'),\r
- 'DATA' => array('ARRAY'),\r
- 'ARRAY' => array('VALUE'),\r
- 'STRUCT' => array('VALUE'),\r
- 'PARAM' => array('PARAMS'),\r
- 'METHODNAME' => array('METHODCALL'),\r
- 'PARAMS' => array('METHODCALL', 'METHODRESPONSE'),\r
- 'FAULT' => array('METHODRESPONSE'),\r
- 'NIL' => array('VALUE'), // only used when extension activated\r
- 'EX:NIL' => array('VALUE') // only used when extension activated\r
- );\r
-\r
- // tables used for transcoding different charsets into us-ascii xml\r
- public $xml_iso88591_Entities = array("in" => array(), "out" => array());\r
-\r
- /// @todo add to iso table the characters from cp_1252 range, i.e. 128 to 159?\r
- /// These will NOT be present in true ISO-8859-1, but will save the unwary\r
- /// windows user from sending junk (though no luck when reciving them...)\r
- /*\r
- $GLOBALS['xml_cp1252_Entities']=array();\r
- for ($i = 128; $i < 160; $i++)\r
- {\r
- $GLOBALS['xml_cp1252_Entities']['in'][] = chr($i);\r
- }\r
- $GLOBALS['xml_cp1252_Entities']['out'] = array(\r
- '€', '?', '‚', 'ƒ',\r
- '„', '…', '†', '‡',\r
- 'ˆ', '‰', 'Š', '‹',\r
- 'Œ', '?', 'Ž', '?',\r
- '?', '‘', '’', '“',\r
- '”', '•', '–', '—',\r
- '˜', '™', 'š', '›',\r
- 'œ', '?', 'ž', 'Ÿ'\r
- );\r
- */\r
-\r
- public $xmlrpcerr = array(\r
- 'unknown_method'=>1,\r
- 'invalid_return'=>2,\r
- 'incorrect_params'=>3,\r
- 'introspect_unknown'=>4,\r
- 'http_error'=>5,\r
- 'no_data'=>6,\r
- 'no_ssl'=>7,\r
- 'curl_fail'=>8,\r
- 'invalid_request'=>15,\r
- 'no_curl'=>16,\r
- 'server_error'=>17,\r
- 'multicall_error'=>18,\r
- 'multicall_notstruct'=>9,\r
- 'multicall_nomethod'=>10,\r
- 'multicall_notstring'=>11,\r
- 'multicall_recursion'=>12,\r
- 'multicall_noparams'=>13,\r
- 'multicall_notarray'=>14,\r
-\r
- 'cannot_decompress'=>103,\r
- 'decompress_fail'=>104,\r
- 'dechunk_fail'=>105,\r
- 'server_cannot_decompress'=>106,\r
- 'server_decompress_fail'=>107\r
- );\r
-\r
- public $xmlrpcstr = array(\r
- 'unknown_method'=>'Unknown method',\r
- 'invalid_return'=>'Invalid return payload: enable debugging to examine incoming payload',\r
- 'incorrect_params'=>'Incorrect parameters passed to method',\r
- 'introspect_unknown'=>"Can't introspect: method unknown",\r
- 'http_error'=>"Didn't receive 200 OK from remote server.",\r
- 'no_data'=>'No data received from server.',\r
- 'no_ssl'=>'No SSL support compiled in.',\r
- 'curl_fail'=>'CURL error',\r
- 'invalid_request'=>'Invalid request payload',\r
- 'no_curl'=>'No CURL support compiled in.',\r
- 'server_error'=>'Internal server error',\r
- 'multicall_error'=>'Received from server invalid multicall response',\r
- 'multicall_notstruct'=>'system.multicall expected struct',\r
- 'multicall_nomethod'=>'missing methodName',\r
- 'multicall_notstring'=>'methodName is not a string',\r
- 'multicall_recursion'=>'recursive system.multicall forbidden',\r
- 'multicall_noparams'=>'missing params',\r
- 'multicall_notarray'=>'params is not an array',\r
-\r
- 'cannot_decompress'=>'Received from server compressed HTTP and cannot decompress',\r
- 'decompress_fail'=>'Received from server invalid compressed HTTP',\r
- 'dechunk_fail'=>'Received from server invalid chunked HTTP',\r
- 'server_cannot_decompress'=>'Received from client compressed HTTP request and cannot decompress',\r
- 'server_decompress_fail'=>'Received from client invalid compressed HTTP request'\r
- );\r
-\r
- // The charset encoding used by the server for received messages and\r
- // by the client for received responses when received charset cannot be determined\r
- // or is not supported\r
- public $xmlrpc_defencoding = "UTF-8";\r
-\r
- // The encoding used internally by PHP.\r
- // String values received as xml will be converted to this, and php strings will be converted to xml\r
- // as if having been coded with this\r
- public $xmlrpc_internalencoding = "ISO-8859-1"; // TODO: maybe this would be better as UTF-8, or atleast configurable?\r
-\r
- public $xmlrpcName = "XML-RPC for PHP";\r
- public $xmlrpcVersion = "3.0.0.beta";\r
-\r
- // let user errors start at 800\r
- public $xmlrpcerruser = 800;\r
- // let XML parse errors start at 100\r
- public $xmlrpcerrxml = 100;\r
-\r
- // set to TRUE to enable correct decoding of <NIL/> and <EX:NIL/> values\r
- public $xmlrpc_null_extension = false;\r
-\r
- // set to TRUE to enable encoding of php NULL values to <EX:NIL/> instead of <NIL/>\r
- public $xmlrpc_null_apache_encoding = false;\r
-\r
- public $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
- // ac - used to accumulate values\r
- // isf - used to indicate a parsing fault (2) or xmlrpcresp fault (1)\r
- // isf_reason - used for storing xmlrpcresp fault string\r
- // lv - used to indicate "looking for a value": implements\r
- // the logic to allow values with no types to be strings\r
- // params - used to store parameters in method calls\r
- // method - used to store method name\r
- // stack - array with genealogy of xml elements names:\r
- // used to validate nesting of xmlrpc elements\r
- public $_xh = null;\r
-\r
- private static $instance = null;\r
-\r
- private function __construct() {\r
- $this->xmlrpcTypes = array(\r
- $this->xmlrpcI4 => 1,\r
- $this->xmlrpcInt => 1,\r
- $this->xmlrpcBoolean => 1,\r
- $this->xmlrpcDouble => 1,\r
- $this->xmlrpcString => 1,\r
- $this->xmlrpcDateTime => 1,\r
- $this->xmlrpcBase64 => 1,\r
- $this->xmlrpcArray => 2,\r
- $this->xmlrpcStruct => 3,\r
- $this->xmlrpcNull => 1\r
- );\r
-\r
- for($i = 0; $i < 32; $i++) {\r
- $this->xml_iso88591_Entities["in"][] = chr($i);\r
- $this->xml_iso88591_Entities["out"][] = "&#{$i};";\r
- }\r
-\r
- for($i = 160; $i < 256; $i++) {\r
- $this->xml_iso88591_Entities["in"][] = chr($i);\r
- $this->xml_iso88591_Entities["out"][] = "&#{$i};";\r
- }\r
- }\r
-\r
- /**\r
- * This class is singleton for performance reasons: this way the ASCII array needs to be done only once.\r
- */\r
- public static function instance() {\r
- if(Xmlrpc::$instance === null) {\r
- Xmlrpc::$instance = new Xmlrpc();\r
- }\r
-\r
- return Xmlrpc::$instance;\r
- }\r
+ public $xmlrpcI4 = "i4";\r
+ public $xmlrpcInt = "int";\r
+ public $xmlrpcBoolean = "boolean";\r
+ public $xmlrpcDouble = "double";\r
+ public $xmlrpcString = "string";\r
+ public $xmlrpcDateTime = "dateTime.iso8601";\r
+ public $xmlrpcBase64 = "base64";\r
+ public $xmlrpcArray = "array";\r
+ public $xmlrpcStruct = "struct";\r
+ public $xmlrpcValue = "undefined";\r
+ public $xmlrpcNull = "null";\r
+\r
+ public $xmlrpcTypes;\r
+\r
+ public $xmlrpc_valid_parents = array(\r
+ 'VALUE' => array('MEMBER', 'DATA', 'PARAM', 'FAULT'),\r
+ 'BOOLEAN' => array('VALUE'),\r
+ 'I4' => array('VALUE'),\r
+ 'INT' => array('VALUE'),\r
+ 'STRING' => array('VALUE'),\r
+ 'DOUBLE' => array('VALUE'),\r
+ 'DATETIME.ISO8601' => array('VALUE'),\r
+ 'BASE64' => array('VALUE'),\r
+ 'MEMBER' => array('STRUCT'),\r
+ 'NAME' => array('MEMBER'),\r
+ 'DATA' => array('ARRAY'),\r
+ 'ARRAY' => array('VALUE'),\r
+ 'STRUCT' => array('VALUE'),\r
+ 'PARAM' => array('PARAMS'),\r
+ 'METHODNAME' => array('METHODCALL'),\r
+ 'PARAMS' => array('METHODCALL', 'METHODRESPONSE'),\r
+ 'FAULT' => array('METHODRESPONSE'),\r
+ 'NIL' => array('VALUE'), // only used when extension activated\r
+ 'EX:NIL' => array('VALUE') // only used when extension activated\r
+ );\r
+\r
+ // tables used for transcoding different charsets into us-ascii xml\r
+ public $xml_iso88591_Entities = array("in" => array(), "out" => array());\r
+\r
+ /// @todo add to iso table the characters from cp_1252 range, i.e. 128 to 159?\r
+ /// These will NOT be present in true ISO-8859-1, but will save the unwary\r
+ /// windows user from sending junk (though no luck when reciving them...)\r
+ /*\r
+ $GLOBALS['xml_cp1252_Entities']=array();\r
+ for ($i = 128; $i < 160; $i++)\r
+ {\r
+ $GLOBALS['xml_cp1252_Entities']['in'][] = chr($i);\r
+ }\r
+ $GLOBALS['xml_cp1252_Entities']['out'] = array(\r
+ '€', '?', '‚', 'ƒ',\r
+ '„', '…', '†', '‡',\r
+ 'ˆ', '‰', 'Š', '‹',\r
+ 'Œ', '?', 'Ž', '?',\r
+ '?', '‘', '’', '“',\r
+ '”', '•', '–', '—',\r
+ '˜', '™', 'š', '›',\r
+ 'œ', '?', 'ž', 'Ÿ'\r
+ );\r
+ */\r
+\r
+ public $xmlrpcerr = array(\r
+ 'unknown_method'=>1,\r
+ 'invalid_return'=>2,\r
+ 'incorrect_params'=>3,\r
+ 'introspect_unknown'=>4,\r
+ 'http_error'=>5,\r
+ 'no_data'=>6,\r
+ 'no_ssl'=>7,\r
+ 'curl_fail'=>8,\r
+ 'invalid_request'=>15,\r
+ 'no_curl'=>16,\r
+ 'server_error'=>17,\r
+ 'multicall_error'=>18,\r
+ 'multicall_notstruct'=>9,\r
+ 'multicall_nomethod'=>10,\r
+ 'multicall_notstring'=>11,\r
+ 'multicall_recursion'=>12,\r
+ 'multicall_noparams'=>13,\r
+ 'multicall_notarray'=>14,\r
+\r
+ 'cannot_decompress'=>103,\r
+ 'decompress_fail'=>104,\r
+ 'dechunk_fail'=>105,\r
+ 'server_cannot_decompress'=>106,\r
+ 'server_decompress_fail'=>107\r
+ );\r
+\r
+ public $xmlrpcstr = array(\r
+ 'unknown_method'=>'Unknown method',\r
+ 'invalid_return'=>'Invalid return payload: enable debugging to examine incoming payload',\r
+ 'incorrect_params'=>'Incorrect parameters passed to method',\r
+ 'introspect_unknown'=>"Can't introspect: method unknown",\r
+ 'http_error'=>"Didn't receive 200 OK from remote server.",\r
+ 'no_data'=>'No data received from server.',\r
+ 'no_ssl'=>'No SSL support compiled in.',\r
+ 'curl_fail'=>'CURL error',\r
+ 'invalid_request'=>'Invalid request payload',\r
+ 'no_curl'=>'No CURL support compiled in.',\r
+ 'server_error'=>'Internal server error',\r
+ 'multicall_error'=>'Received from server invalid multicall response',\r
+ 'multicall_notstruct'=>'system.multicall expected struct',\r
+ 'multicall_nomethod'=>'missing methodName',\r
+ 'multicall_notstring'=>'methodName is not a string',\r
+ 'multicall_recursion'=>'recursive system.multicall forbidden',\r
+ 'multicall_noparams'=>'missing params',\r
+ 'multicall_notarray'=>'params is not an array',\r
+\r
+ 'cannot_decompress'=>'Received from server compressed HTTP and cannot decompress',\r
+ 'decompress_fail'=>'Received from server invalid compressed HTTP',\r
+ 'dechunk_fail'=>'Received from server invalid chunked HTTP',\r
+ 'server_cannot_decompress'=>'Received from client compressed HTTP request and cannot decompress',\r
+ 'server_decompress_fail'=>'Received from client invalid compressed HTTP request'\r
+ );\r
+\r
+ // The charset encoding used by the server for received messages and\r
+ // by the client for received responses when received charset cannot be determined\r
+ // or is not supported\r
+ public $xmlrpc_defencoding = "UTF-8";\r
+\r
+ // The encoding used internally by PHP.\r
+ // String values received as xml will be converted to this, and php strings will be converted to xml\r
+ // as if having been coded with this\r
+ public $xmlrpc_internalencoding = "ISO-8859-1"; // TODO: maybe this would be better as UTF-8, or atleast configurable?\r
+\r
+ public $xmlrpcName = "XML-RPC for PHP";\r
+ public $xmlrpcVersion = "3.0.0.beta";\r
+\r
+ // let user errors start at 800\r
+ public $xmlrpcerruser = 800;\r
+ // let XML parse errors start at 100\r
+ public $xmlrpcerrxml = 100;\r
+\r
+ // set to TRUE to enable correct decoding of <NIL/> and <EX:NIL/> values\r
+ public $xmlrpc_null_extension = false;\r
+\r
+ // set to TRUE to enable encoding of php NULL values to <EX:NIL/> instead of <NIL/>\r
+ public $xmlrpc_null_apache_encoding = false;\r
+\r
+ public $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
+ // ac - used to accumulate values\r
+ // isf - used to indicate a parsing fault (2) or xmlrpcresp fault (1)\r
+ // isf_reason - used for storing xmlrpcresp fault string\r
+ // lv - used to indicate "looking for a value": implements\r
+ // the logic to allow values with no types to be strings\r
+ // params - used to store parameters in method calls\r
+ // method - used to store method name\r
+ // stack - array with genealogy of xml elements names:\r
+ // used to validate nesting of xmlrpc elements\r
+ public $_xh = null;\r
+\r
+ private static $instance = null;\r
+\r
+ private function __construct() {\r
+ $this->xmlrpcTypes = array(\r
+ $this->xmlrpcI4 => 1,\r
+ $this->xmlrpcInt => 1,\r
+ $this->xmlrpcBoolean => 1,\r
+ $this->xmlrpcDouble => 1,\r
+ $this->xmlrpcString => 1,\r
+ $this->xmlrpcDateTime => 1,\r
+ $this->xmlrpcBase64 => 1,\r
+ $this->xmlrpcArray => 2,\r
+ $this->xmlrpcStruct => 3,\r
+ $this->xmlrpcNull => 1\r
+ );\r
+\r
+ for($i = 0; $i < 32; $i++) {\r
+ $this->xml_iso88591_Entities["in"][] = chr($i);\r
+ $this->xml_iso88591_Entities["out"][] = "&#{$i};";\r
+ }\r
+\r
+ for($i = 160; $i < 256; $i++) {\r
+ $this->xml_iso88591_Entities["in"][] = chr($i);\r
+ $this->xml_iso88591_Entities["out"][] = "&#{$i};";\r
+ }\r
+ }\r
+\r
+ /**\r
+ * This class is singleton for performance reasons: this way the ASCII array needs to be done only once.\r
+ */\r
+ public static function instance() {\r
+ if(Xmlrpc::$instance === null) {\r
+ Xmlrpc::$instance = new Xmlrpc();\r
+ }\r
+\r
+ return Xmlrpc::$instance;\r
+ }\r
}\r
\r
- /**\r
- * Convert a string to the correct XML representation in a target charset\r
- * To help correct communication of non-ascii chars inside strings, regardless\r
- * of the charset used when sending requests, parsing them, sending responses\r
- * and parsing responses, an option is to convert all non-ascii chars present in the message\r
- * into their equivalent 'charset entity'. Charset entities enumerated this way\r
- * are independent of the charset encoding used to transmit them, and all XML\r
- * parsers are bound to understand them.\r
- * Note that in the std case we are not sending a charset encoding mime type\r
- * along with http headers, so we are bound by RFC 3023 to emit strict us-ascii.\r
- *\r
- * @todo do a bit of basic benchmarking (strtr vs. str_replace)\r
- * @todo make usage of iconv() or recode_string() or mb_string() where available\r
- */\r
- function xmlrpc_encode_entitites($data, $src_encoding='', $dest_encoding='')\r
- {\r
- $xmlrpc = Xmlrpc::instance();\r
- if ($src_encoding == '')\r
- {\r
- // lame, but we know no better...\r
- $src_encoding = $xmlrpc->xmlrpc_internalencoding;\r
- }\r
-\r
- switch(strtoupper($src_encoding.'_'.$dest_encoding))\r
- {\r
- case 'ISO-8859-1_':\r
- case 'ISO-8859-1_US-ASCII':\r
- $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);\r
- $escaped_data = str_replace($xmlrpc->xml_iso88591_Entities['in'], $xmlrpc->xml_iso88591_Entities['out'], $escaped_data);\r
- break;\r
- case 'ISO-8859-1_UTF-8':\r
- $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);\r
- $escaped_data = utf8_encode($escaped_data);\r
- break;\r
- case 'ISO-8859-1_ISO-8859-1':\r
- case 'US-ASCII_US-ASCII':\r
- case 'US-ASCII_UTF-8':\r
- case 'US-ASCII_':\r
- case 'US-ASCII_ISO-8859-1':\r
- case 'UTF-8_UTF-8':\r
- //case 'CP1252_CP1252':\r
- $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);\r
- break;\r
- case 'UTF-8_':\r
- case 'UTF-8_US-ASCII':\r
- case 'UTF-8_ISO-8859-1':\r
- // NB: this will choke on invalid UTF-8, going most likely beyond EOF\r
- $escaped_data = '';\r
- // be kind to users creating string xmlrpcvals out of different php types\r
- $data = (string) $data;\r
- $ns = strlen ($data);\r
- for ($nn = 0; $nn < $ns; $nn++)\r
- {\r
- $ch = $data[$nn];\r
- $ii = ord($ch);\r
- //1 7 0bbbbbbb (127)\r
- if ($ii < 128)\r
- {\r
- /// @todo shall we replace this with a (supposedly) faster str_replace?\r
- switch($ii){\r
- case 34:\r
- $escaped_data .= '"';\r
- break;\r
- case 38:\r
- $escaped_data .= '&';\r
- break;\r
- case 39:\r
- $escaped_data .= ''';\r
- break;\r
- case 60:\r
- $escaped_data .= '<';\r
- break;\r
- case 62:\r
- $escaped_data .= '>';\r
- break;\r
- default:\r
- $escaped_data .= $ch;\r
- } // switch\r
- }\r
- //2 11 110bbbbb 10bbbbbb (2047)\r
- else if ($ii>>5 == 6)\r
- {\r
- $b1 = ($ii & 31);\r
- $ii = ord($data[$nn+1]);\r
- $b2 = ($ii & 63);\r
- $ii = ($b1 * 64) + $b2;\r
- $ent = sprintf ('&#%d;', $ii);\r
- $escaped_data .= $ent;\r
- $nn += 1;\r
- }\r
- //3 16 1110bbbb 10bbbbbb 10bbbbbb\r
- else if ($ii>>4 == 14)\r
- {\r
- $b1 = ($ii & 15);\r
- $ii = ord($data[$nn+1]);\r
- $b2 = ($ii & 63);\r
- $ii = ord($data[$nn+2]);\r
- $b3 = ($ii & 63);\r
- $ii = ((($b1 * 64) + $b2) * 64) + $b3;\r
- $ent = sprintf ('&#%d;', $ii);\r
- $escaped_data .= $ent;\r
- $nn += 2;\r
- }\r
- //4 21 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb\r
- else if ($ii>>3 == 30)\r
- {\r
- $b1 = ($ii & 7);\r
- $ii = ord($data[$nn+1]);\r
- $b2 = ($ii & 63);\r
- $ii = ord($data[$nn+2]);\r
- $b3 = ($ii & 63);\r
- $ii = ord($data[$nn+3]);\r
- $b4 = ($ii & 63);\r
- $ii = ((((($b1 * 64) + $b2) * 64) + $b3) * 64) + $b4;\r
- $ent = sprintf ('&#%d;', $ii);\r
- $escaped_data .= $ent;\r
- $nn += 3;\r
- }\r
- }\r
- break;\r
+\r
+/**\r
+ * Convert a string to the correct XML representation in a target charset\r
+ * To help correct communication of non-ascii chars inside strings, regardless\r
+ * of the charset used when sending requests, parsing them, sending responses\r
+ * and parsing responses, an option is to convert all non-ascii chars present in the message\r
+ * into their equivalent 'charset entity'. Charset entities enumerated this way\r
+ * are independent of the charset encoding used to transmit them, and all XML\r
+ * parsers are bound to understand them.\r
+ * Note that in the std case we are not sending a charset encoding mime type\r
+ * along with http headers, so we are bound by RFC 3023 to emit strict us-ascii.\r
+ *\r
+ * @todo do a bit of basic benchmarking (strtr vs. str_replace)\r
+ * @todo make usage of iconv() or recode_string() or mb_string() where available\r
+ */\r
+function xmlrpc_encode_entitites($data, $src_encoding='', $dest_encoding='')\r
+{\r
+ $xmlrpc = Xmlrpc::instance();\r
+ if ($src_encoding == '')\r
+ {\r
+ // lame, but we know no better...\r
+ $src_encoding = $xmlrpc->xmlrpc_internalencoding;\r
+ }\r
+\r
+ switch(strtoupper($src_encoding.'_'.$dest_encoding))\r
+ {\r
+ case 'ISO-8859-1_':\r
+ case 'ISO-8859-1_US-ASCII':\r
+ $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);\r
+ $escaped_data = str_replace($xmlrpc->xml_iso88591_Entities['in'], $xmlrpc->xml_iso88591_Entities['out'], $escaped_data);\r
+ break;\r
+ case 'ISO-8859-1_UTF-8':\r
+ $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);\r
+ $escaped_data = utf8_encode($escaped_data);\r
+ break;\r
+ case 'ISO-8859-1_ISO-8859-1':\r
+ case 'US-ASCII_US-ASCII':\r
+ case 'US-ASCII_UTF-8':\r
+ case 'US-ASCII_':\r
+ case 'US-ASCII_ISO-8859-1':\r
+ case 'UTF-8_UTF-8':\r
+ //case 'CP1252_CP1252':\r
+ $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);\r
+ break;\r
+ case 'UTF-8_':\r
+ case 'UTF-8_US-ASCII':\r
+ case 'UTF-8_ISO-8859-1':\r
+// NB: this will choke on invalid UTF-8, going most likely beyond EOF\r
+$escaped_data = '';\r
+// be kind to users creating string xmlrpcvals out of different php types\r
+$data = (string) $data;\r
+$ns = strlen ($data);\r
+for ($nn = 0; $nn < $ns; $nn++)\r
+{\r
+ $ch = $data[$nn];\r
+ $ii = ord($ch);\r
+ //1 7 0bbbbbbb (127)\r
+ if ($ii < 128)\r
+ {\r
+ /// @todo shall we replace this with a (supposedly) faster str_replace?\r
+ switch($ii){\r
+ case 34:\r
+ $escaped_data .= '"';\r
+ break;\r
+ case 38:\r
+ $escaped_data .= '&';\r
+ break;\r
+ case 39:\r
+ $escaped_data .= ''';\r
+ break;\r
+ case 60:\r
+ $escaped_data .= '<';\r
+ break;\r
+ case 62:\r
+ $escaped_data .= '>';\r
+ break;\r
+ default:\r
+ $escaped_data .= $ch;\r
+ } // switch\r
+ }\r
+ //2 11 110bbbbb 10bbbbbb (2047)\r
+ else if ($ii>>5 == 6)\r
+ {\r
+ $b1 = ($ii & 31);\r
+ $ii = ord($data[$nn+1]);\r
+ $b2 = ($ii & 63);\r
+ $ii = ($b1 * 64) + $b2;\r
+ $ent = sprintf ('&#%d;', $ii);\r
+ $escaped_data .= $ent;\r
+ $nn += 1;\r
+ }\r
+ //3 16 1110bbbb 10bbbbbb 10bbbbbb\r
+ else if ($ii>>4 == 14)\r
+ {\r
+ $b1 = ($ii & 15);\r
+ $ii = ord($data[$nn+1]);\r
+ $b2 = ($ii & 63);\r
+ $ii = ord($data[$nn+2]);\r
+ $b3 = ($ii & 63);\r
+ $ii = ((($b1 * 64) + $b2) * 64) + $b3;\r
+ $ent = sprintf ('&#%d;', $ii);\r
+ $escaped_data .= $ent;\r
+ $nn += 2;\r
+ }\r
+ //4 21 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb\r
+ else if ($ii>>3 == 30)\r
+ {\r
+ $b1 = ($ii & 7);\r
+ $ii = ord($data[$nn+1]);\r
+ $b2 = ($ii & 63);\r
+ $ii = ord($data[$nn+2]);\r
+ $b3 = ($ii & 63);\r
+ $ii = ord($data[$nn+3]);\r
+ $b4 = ($ii & 63);\r
+ $ii = ((((($b1 * 64) + $b2) * 64) + $b3) * 64) + $b4;\r
+ $ent = sprintf ('&#%d;', $ii);\r
+ $escaped_data .= $ent;\r
+ $nn += 3;\r
+ }\r
+}\r
+ break;\r
/*\r
- case 'CP1252_':\r
- case 'CP1252_US-ASCII':\r
- $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);\r
- $escaped_data = str_replace($GLOBALS['xml_iso88591_Entities']['in'], $GLOBALS['xml_iso88591_Entities']['out'], $escaped_data);\r
- $escaped_data = str_replace($GLOBALS['xml_cp1252_Entities']['in'], $GLOBALS['xml_cp1252_Entities']['out'], $escaped_data);\r
- break;\r
- case 'CP1252_UTF-8':\r
- $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);\r
- /// @todo we could use real UTF8 chars here instead of xml entities... (note that utf_8 encode all allone will NOT convert them)\r
- $escaped_data = str_replace($GLOBALS['xml_cp1252_Entities']['in'], $GLOBALS['xml_cp1252_Entities']['out'], $escaped_data);\r
- $escaped_data = utf8_encode($escaped_data);\r
- break;\r
- case 'CP1252_ISO-8859-1':\r
- $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);\r
- // we might as well replave all funky chars with a '?' here, but we are kind and leave it to the receiving application layer to decide what to do with these weird entities...\r
- $escaped_data = str_replace($GLOBALS['xml_cp1252_Entities']['in'], $GLOBALS['xml_cp1252_Entities']['out'], $escaped_data);\r
- break;\r
+ case 'CP1252_':\r
+ case 'CP1252_US-ASCII':\r
+ $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);\r
+ $escaped_data = str_replace($GLOBALS['xml_iso88591_Entities']['in'], $GLOBALS['xml_iso88591_Entities']['out'], $escaped_data);\r
+ $escaped_data = str_replace($GLOBALS['xml_cp1252_Entities']['in'], $GLOBALS['xml_cp1252_Entities']['out'], $escaped_data);\r
+ break;\r
+ case 'CP1252_UTF-8':\r
+ $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);\r
+ /// @todo we could use real UTF8 chars here instead of xml entities... (note that utf_8 encode all allone will NOT convert them)\r
+ $escaped_data = str_replace($GLOBALS['xml_cp1252_Entities']['in'], $GLOBALS['xml_cp1252_Entities']['out'], $escaped_data);\r
+ $escaped_data = utf8_encode($escaped_data);\r
+ break;\r
+ case 'CP1252_ISO-8859-1':\r
+ $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);\r
+ // we might as well replave all funky chars with a '?' here, but we are kind and leave it to the receiving application layer to decide what to do with these weird entities...\r
+ $escaped_data = str_replace($GLOBALS['xml_cp1252_Entities']['in'], $GLOBALS['xml_cp1252_Entities']['out'], $escaped_data);\r
+ break;\r
*/\r
- default:\r
- $escaped_data = '';\r
- error_log("Converting from $src_encoding to $dest_encoding: not supported...");\r
- }\r
- return $escaped_data;\r
- }\r
-\r
- /// xml parser handler function for opening element tags\r
- function xmlrpc_se($parser, $name, $attrs, $accept_single_vals=false)\r
- {\r
- $xmlrpc = Xmlrpc::instance();\r
- // if invalid xmlrpc already detected, skip all processing\r
- if ($xmlrpc->_xh['isf'] < 2)\r
- {\r
- // check for correct element nesting\r
- // top level element can only be of 2 types\r
- /// @todo optimization creep: save this check into a bool variable, instead of using count() every time:\r
- /// there is only a single top level element in xml anyway\r
- if (count($xmlrpc->_xh['stack']) == 0)\r
- {\r
- if ($name != 'METHODRESPONSE' && $name != 'METHODCALL' && (\r
- $name != 'VALUE' && !$accept_single_vals))\r
- {\r
- $xmlrpc->_xh['isf'] = 2;\r
- $xmlrpc->_xh['isf_reason'] = 'missing top level xmlrpc element';\r
- return;\r
- }\r
- else\r
- {\r
- $xmlrpc->_xh['rt'] = strtolower($name);\r
- $xmlrpc->_xh['rt'] = strtolower($name);\r
- }\r
- }\r
- else\r
- {\r
- // not top level element: see if parent is OK\r
- $parent = end($xmlrpc->_xh['stack']);\r
- if (!array_key_exists($name, $xmlrpc->xmlrpc_valid_parents) || !in_array($parent, $xmlrpc->xmlrpc_valid_parents[$name]))\r
- {\r
- $xmlrpc->_xh['isf'] = 2;\r
- $xmlrpc->_xh['isf_reason'] = "xmlrpc element $name cannot be child of $parent";\r
- return;\r
- }\r
- }\r
-\r
- switch($name)\r
- {\r
- // optimize for speed switch cases: most common cases first\r
- case 'VALUE':\r
- /// @todo we could check for 2 VALUE elements inside a MEMBER or PARAM element\r
- $xmlrpc->_xh['vt']='value'; // indicator: no value found yet\r
- $xmlrpc->_xh['ac']='';\r
- $xmlrpc->_xh['lv']=1;\r
- $xmlrpc->_xh['php_class']=null;\r
- break;\r
- case 'I4':\r
- case 'INT':\r
- case 'STRING':\r
- case 'BOOLEAN':\r
- case 'DOUBLE':\r
- case 'DATETIME.ISO8601':\r
- case 'BASE64':\r
- if ($xmlrpc->_xh['vt']!='value')\r
- {\r
- //two data elements inside a value: an error occurred!\r
- $xmlrpc->_xh['isf'] = 2;\r
- $xmlrpc->_xh['isf_reason'] = "$name element following a {$xmlrpc->_xh['vt']} element inside a single value";\r
- return;\r
- }\r
- $xmlrpc->_xh['ac']=''; // reset the accumulator\r
- break;\r
- case 'STRUCT':\r
- case 'ARRAY':\r
- if ($xmlrpc->_xh['vt']!='value')\r
- {\r
- //two data elements inside a value: an error occurred!\r
- $xmlrpc->_xh['isf'] = 2;\r
- $xmlrpc->_xh['isf_reason'] = "$name element following a {$xmlrpc->_xh['vt']} element inside a single value";\r
- return;\r
- }\r
- // create an empty array to hold child values, and push it onto appropriate stack\r
- $cur_val = array();\r
- $cur_val['values'] = array();\r
- $cur_val['type'] = $name;\r
- // check for out-of-band information to rebuild php objs\r
- // and in case it is found, save it\r
- if (@isset($attrs['PHP_CLASS']))\r
- {\r
- $cur_val['php_class'] = $attrs['PHP_CLASS'];\r
- }\r
- $xmlrpc->_xh['valuestack'][] = $cur_val;\r
- $xmlrpc->_xh['vt']='data'; // be prepared for a data element next\r
- break;\r
- case 'DATA':\r
- if ($xmlrpc->_xh['vt']!='data')\r
- {\r
- //two data elements inside a value: an error occurred!\r
- $xmlrpc->_xh['isf'] = 2;\r
- $xmlrpc->_xh['isf_reason'] = "found two data elements inside an array element";\r
- return;\r
- }\r
- case 'METHODCALL':\r
- case 'METHODRESPONSE':\r
- case 'PARAMS':\r
- // valid elements that add little to processing\r
- break;\r
- case 'METHODNAME':\r
- case 'NAME':\r
- /// @todo we could check for 2 NAME elements inside a MEMBER element\r
- $xmlrpc->_xh['ac']='';\r
- break;\r
- case 'FAULT':\r
- $xmlrpc->_xh['isf']=1;\r
- break;\r
- case 'MEMBER':\r
- $xmlrpc->_xh['valuestack'][count($xmlrpc->_xh['valuestack'])-1]['name']=''; // set member name to null, in case we do not find in the xml later on\r
- //$xmlrpc->_xh['ac']='';\r
- // Drop trough intentionally\r
- case 'PARAM':\r
- // clear value type, so we can check later if no value has been passed for this param/member\r
- $xmlrpc->_xh['vt']=null;\r
- break;\r
- case 'NIL':\r
- case 'EX:NIL':\r
- if ($xmlrpc->xmlrpc_null_extension)\r
- {\r
- if ($xmlrpc->_xh['vt']!='value')\r
- {\r
- //two data elements inside a value: an error occurred!\r
- $xmlrpc->_xh['isf'] = 2;\r
- $xmlrpc->_xh['isf_reason'] = "$name element following a {$xmlrpc->_xh['vt']} element inside a single value";\r
- return;\r
- }\r
- $xmlrpc->_xh['ac']=''; // reset the accumulator\r
- break;\r
- }\r
- // we do not support the <NIL/> extension, so\r
- // drop through intentionally\r
- default:\r
- /// INVALID ELEMENT: RAISE ISF so that it is later recognized!!!\r
- $xmlrpc->_xh['isf'] = 2;\r
- $xmlrpc->_xh['isf_reason'] = "found not-xmlrpc xml element $name";\r
- break;\r
- }\r
-\r
- // Save current element name to stack, to validate nesting\r
- $xmlrpc->_xh['stack'][] = $name;\r
-\r
- /// @todo optimization creep: move this inside the big switch() above\r
- if($name!='VALUE')\r
- {\r
- $xmlrpc->_xh['lv']=0;\r
- }\r
- }\r
- }\r
-\r
- /// Used in decoding xml chunks that might represent single xmlrpc values\r
- function xmlrpc_se_any($parser, $name, $attrs)\r
- {\r
- xmlrpc_se($parser, $name, $attrs, true);\r
- }\r
-\r
- /// xml parser handler function for close element tags\r
- function xmlrpc_ee($parser, $name, $rebuild_xmlrpcvals = true)\r
- {\r
- $xmlrpc = Xmlrpc::instance();\r
-\r
- if ($xmlrpc->_xh['isf'] < 2)\r
- {\r
- // push this element name from stack\r
- // NB: if XML validates, correct opening/closing is guaranteed and\r
- // we do not have to check for $name == $curr_elem.\r
- // we also checked for proper nesting at start of elements...\r
- $curr_elem = array_pop($xmlrpc->_xh['stack']);\r
-\r
- switch($name)\r
- {\r
- case 'VALUE':\r
- // This if() detects if no scalar was inside <VALUE></VALUE>\r
- if ($xmlrpc->_xh['vt']=='value')\r
- {\r
- $xmlrpc->_xh['value']=$xmlrpc->_xh['ac'];\r
- $xmlrpc->_xh['vt']=$xmlrpc->xmlrpcString;\r
- }\r
-\r
- if ($rebuild_xmlrpcvals)\r
- {\r
- // build the xmlrpc val out of the data received, and substitute it\r
- $temp = new xmlrpcval($xmlrpc->_xh['value'], $xmlrpc->_xh['vt']);\r
- // in case we got info about underlying php class, save it\r
- // in the object we're rebuilding\r
- if (isset($xmlrpc->_xh['php_class']))\r
- $temp->_php_class = $xmlrpc->_xh['php_class'];\r
- // check if we are inside an array or struct:\r
- // if value just built is inside an array, let's move it into array on the stack\r
- $vscount = count($xmlrpc->_xh['valuestack']);\r
- if ($vscount && $xmlrpc->_xh['valuestack'][$vscount-1]['type']=='ARRAY')\r
- {\r
- $xmlrpc->_xh['valuestack'][$vscount-1]['values'][] = $temp;\r
- }\r
- else\r
- {\r
- $xmlrpc->_xh['value'] = $temp;\r
- }\r
- }\r
- else\r
- {\r
- /// @todo this needs to treat correctly php-serialized objects,\r
- /// since std deserializing is done by php_xmlrpc_decode,\r
- /// which we will not be calling...\r
- if (isset($xmlrpc->_xh['php_class']))\r
- {\r
- }\r
-\r
- // check if we are inside an array or struct:\r
- // if value just built is inside an array, let's move it into array on the stack\r
- $vscount = count($xmlrpc->_xh['valuestack']);\r
- if ($vscount && $xmlrpc->_xh['valuestack'][$vscount-1]['type']=='ARRAY')\r
- {\r
- $xmlrpc->_xh['valuestack'][$vscount-1]['values'][] = $xmlrpc->_xh['value'];\r
- }\r
- }\r
- break;\r
- case 'BOOLEAN':\r
- case 'I4':\r
- case 'INT':\r
- case 'STRING':\r
- case 'DOUBLE':\r
- case 'DATETIME.ISO8601':\r
- case 'BASE64':\r
- $xmlrpc->_xh['vt']=strtolower($name);\r
- /// @todo: optimization creep - remove the if/elseif cycle below\r
- /// since the case() in which we are already did that\r
- if ($name=='STRING')\r
- {\r
- $xmlrpc->_xh['value']=$xmlrpc->_xh['ac'];\r
- }\r
- elseif ($name=='DATETIME.ISO8601')\r
- {\r
- if (!preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $xmlrpc->_xh['ac']))\r
- {\r
- error_log('XML-RPC: invalid value received in DATETIME: '.$xmlrpc->_xh['ac']);\r
- }\r
- $xmlrpc->_xh['vt']=$xmlrpc->xmlrpcDateTime;\r
- $xmlrpc->_xh['value']=$xmlrpc->_xh['ac'];\r
- }\r
- elseif ($name=='BASE64')\r
- {\r
- /// @todo check for failure of base64 decoding / catch warnings\r
- $xmlrpc->_xh['value']=base64_decode($xmlrpc->_xh['ac']);\r
- }\r
- elseif ($name=='BOOLEAN')\r
- {\r
- // special case here: we translate boolean 1 or 0 into PHP\r
- // constants true or false.\r
- // Strings 'true' and 'false' are accepted, even though the\r
- // spec never mentions them (see eg. Blogger api docs)\r
- // NB: this simple checks helps a lot sanitizing input, ie no\r
- // security problems around here\r
- if ($xmlrpc->_xh['ac']=='1' || strcasecmp($xmlrpc->_xh['ac'], 'true') == 0)\r
- {\r
- $xmlrpc->_xh['value']=true;\r
- }\r
- else\r
- {\r
- // log if receiveing something strange, even though we set the value to false anyway\r
- if ($xmlrpc->_xh['ac']!='0' && strcasecmp($xmlrpc->_xh['ac'], 'false') != 0)\r
- error_log('XML-RPC: invalid value received in BOOLEAN: '.$xmlrpc->_xh['ac']);\r
- $xmlrpc->_xh['value']=false;\r
- }\r
- }\r
- elseif ($name=='DOUBLE')\r
- {\r
- // we have a DOUBLE\r
- // we must check that only 0123456789-.<space> are characters here\r
- // NOTE: regexp could be much stricter than this...\r
- if (!preg_match('/^[+-eE0123456789 \t.]+$/', $xmlrpc->_xh['ac']))\r
- {\r
- /// @todo: find a better way of throwing an error than this!\r
- error_log('XML-RPC: non numeric value received in DOUBLE: '.$xmlrpc->_xh['ac']);\r
- $xmlrpc->_xh['value']='ERROR_NON_NUMERIC_FOUND';\r
- }\r
- else\r
- {\r
- // it's ok, add it on\r
- $xmlrpc->_xh['value']=(double)$xmlrpc->_xh['ac'];\r
- }\r
- }\r
- else\r
- {\r
- // we have an I4/INT\r
- // we must check that only 0123456789-<space> are characters here\r
- if (!preg_match('/^[+-]?[0123456789 \t]+$/', $xmlrpc->_xh['ac']))\r
- {\r
- /// @todo find a better way of throwing an error than this!\r
- error_log('XML-RPC: non numeric value received in INT: '.$xmlrpc->_xh['ac']);\r
- $xmlrpc->_xh['value']='ERROR_NON_NUMERIC_FOUND';\r
- }\r
- else\r
- {\r
- // it's ok, add it on\r
- $xmlrpc->_xh['value']=(int)$xmlrpc->_xh['ac'];\r
- }\r
- }\r
- //$xmlrpc->_xh['ac']=''; // is this necessary?\r
- $xmlrpc->_xh['lv']=3; // indicate we've found a value\r
- break;\r
- case 'NAME':\r
- $xmlrpc->_xh['valuestack'][count($xmlrpc->_xh['valuestack'])-1]['name'] = $xmlrpc->_xh['ac'];\r
- break;\r
- case 'MEMBER':\r
- //$xmlrpc->_xh['ac']=''; // is this necessary?\r
- // add to array in the stack the last element built,\r
- // unless no VALUE was found\r
- if ($xmlrpc->_xh['vt'])\r
- {\r
- $vscount = count($xmlrpc->_xh['valuestack']);\r
- $xmlrpc->_xh['valuestack'][$vscount-1]['values'][$xmlrpc->_xh['valuestack'][$vscount-1]['name']] = $xmlrpc->_xh['value'];\r
- } else\r
- error_log('XML-RPC: missing VALUE inside STRUCT in received xml');\r
- break;\r
- case 'DATA':\r
- //$xmlrpc->_xh['ac']=''; // is this necessary?\r
- $xmlrpc->_xh['vt']=null; // reset this to check for 2 data elements in a row - even if they're empty\r
- break;\r
- case 'STRUCT':\r
- case 'ARRAY':\r
- // fetch out of stack array of values, and promote it to current value\r
- $curr_val = array_pop($xmlrpc->_xh['valuestack']);\r
- $xmlrpc->_xh['value'] = $curr_val['values'];\r
- $xmlrpc->_xh['vt']=strtolower($name);\r
- if (isset($curr_val['php_class']))\r
- {\r
- $xmlrpc->_xh['php_class'] = $curr_val['php_class'];\r
- }\r
- break;\r
- case 'PARAM':\r
- // add to array of params the current value,\r
- // unless no VALUE was found\r
- if ($xmlrpc->_xh['vt'])\r
- {\r
- $xmlrpc->_xh['params'][]=$xmlrpc->_xh['value'];\r
- $xmlrpc->_xh['pt'][]=$xmlrpc->_xh['vt'];\r
- }\r
- else\r
- error_log('XML-RPC: missing VALUE inside PARAM in received xml');\r
- break;\r
- case 'METHODNAME':\r
- $xmlrpc->_xh['method']=preg_replace('/^[\n\r\t ]+/', '', $xmlrpc->_xh['ac']);\r
- break;\r
- case 'NIL':\r
- case 'EX:NIL':\r
- if ($xmlrpc->xmlrpc_null_extension)\r
- {\r
- $xmlrpc->_xh['vt']='null';\r
- $xmlrpc->_xh['value']=null;\r
- $xmlrpc->_xh['lv']=3;\r
- break;\r
- }\r
- // drop through intentionally if nil extension not enabled\r
- case 'PARAMS':\r
- case 'FAULT':\r
- case 'METHODCALL':\r
- case 'METHORESPONSE':\r
- break;\r
- default:\r
- // End of INVALID ELEMENT!\r
- // shall we add an assert here for unreachable code???\r
- break;\r
- }\r
- }\r
- }\r
-\r
- /// Used in decoding xmlrpc requests/responses without rebuilding xmlrpc values\r
- function xmlrpc_ee_fast($parser, $name)\r
- {\r
- xmlrpc_ee($parser, $name, false);\r
- }\r
-\r
- /// xml parser handler function for character data\r
- function xmlrpc_cd($parser, $data)\r
- {\r
- $xmlrpc = Xmlrpc::instance();\r
- // skip processing if xml fault already detected\r
- if ($xmlrpc->_xh['isf'] < 2)\r
- {\r
- // "lookforvalue==3" means that we've found an entire value\r
- // and should discard any further character data\r
- if($xmlrpc->_xh['lv']!=3)\r
- {\r
- // G. Giunta 2006-08-23: useless change of 'lv' from 1 to 2\r
- //if($xmlrpc->_xh['lv']==1)\r
- //{\r
- // if we've found text and we're just in a <value> then\r
- // say we've found a value\r
- //$xmlrpc->_xh['lv']=2;\r
- //}\r
- // we always initialize the accumulator before starting parsing, anyway...\r
- //if(!@isset($xmlrpc->_xh['ac']))\r
- //{\r
- // $xmlrpc->_xh['ac'] = '';\r
- //}\r
- $xmlrpc->_xh['ac'].=$data;\r
- }\r
- }\r
- }\r
-\r
- /// xml parser handler function for 'other stuff', ie. not char data or\r
- /// element start/end tag. In fact it only gets called on unknown entities...\r
- function xmlrpc_dh($parser, $data)\r
- {\r
- $xmlrpc = Xmlrpc::instance();\r
- // skip processing if xml fault already detected\r
- if ($xmlrpc->_xh['isf'] < 2)\r
- {\r
- if(substr($data, 0, 1) == '&' && substr($data, -1, 1) == ';')\r
- {\r
- // G. Giunta 2006-08-25: useless change of 'lv' from 1 to 2\r
- //if($xmlrpc->_xh['lv']==1)\r
- //{\r
- // $xmlrpc->_xh['lv']=2;\r
- //}\r
- $xmlrpc->_xh['ac'].=$data;\r
- }\r
- }\r
- return true;\r
- }\r
-\r
- class xmlrpc_client\r
- {\r
- var $path;\r
- var $server;\r
- var $port=0;\r
- var $method='http';\r
- var $errno;\r
- var $errstr;\r
- var $debug=0;\r
- var $username='';\r
- var $password='';\r
- var $authtype=1;\r
- var $cert='';\r
- var $certpass='';\r
- var $cacert='';\r
- var $cacertdir='';\r
- var $key='';\r
- var $keypass='';\r
- var $verifypeer=true;\r
- var $verifyhost=2;\r
- var $no_multicall=false;\r
- var $proxy='';\r
- var $proxyport=0;\r
- var $proxy_user='';\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
- *\r
- * NNB: you can set it to any non-empty array for HTTP11 and HTTPS, since\r
- * in those cases it will be up to CURL to decide the compression methods\r
- * it supports. You might check for the presence of 'zlib' in the output of\r
- * curl_version() to determine wheter compression is supported or not\r
- */\r
- var $accepted_compression = array();\r
- /**\r
- * Name of compression scheme to be used for sending requests.\r
- * Either null, gzip or deflate\r
- */\r
- var $request_compression = '';\r
- /**\r
- * CURL handle: used for keep-alive connections (PHP 4.3.8 up, see:\r
- * http://curl.haxx.se/docs/faq.html#7.3)\r
- */\r
- var $xmlrpc_curl_handle = null;\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
- /// Charset encoding to be used in serializing request. NULL = use ASCII\r
- var $request_charset_encoding = '';\r
- /**\r
- * Decides the content of xmlrpcresp objects returned by calls to send()\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
- * @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
- {\r
- $xmlrpc = Xmlrpc::instance();\r
-\r
- // allow user to specify all params in $path\r
- if($server == '' and $port == '' and $method == '')\r
- {\r
- $parts = parse_url($path);\r
- $server = $parts['host'];\r
- $path = isset($parts['path']) ? $parts['path'] : '';\r
- if(isset($parts['query']))\r
- {\r
- $path .= '?'.$parts['query'];\r
- }\r
- if(isset($parts['fragment']))\r
- {\r
- $path .= '#'.$parts['fragment'];\r
- }\r
- if(isset($parts['port']))\r
- {\r
- $port = $parts['port'];\r
- }\r
- if(isset($parts['scheme']))\r
- {\r
- $method = $parts['scheme'];\r
- }\r
- if(isset($parts['user']))\r
- {\r
- $this->username = $parts['user'];\r
- }\r
- if(isset($parts['pass']))\r
- {\r
- $this->password = $parts['pass'];\r
- }\r
- }\r
- if($path == '' || $path[0] != '/')\r
- {\r
- $this->path='/'.$path;\r
- }\r
- else\r
- {\r
- $this->path=$path;\r
- }\r
- $this->server=$server;\r
- if($port != '')\r
- {\r
- $this->port=$port;\r
- }\r
- if($method != '')\r
- {\r
- $this->method=$method;\r
- }\r
-\r
- // if ZLIB is enabled, let the client by default accept compressed responses\r
- if(function_exists('gzinflate') || (\r
- function_exists('curl_init') && (($info = curl_version()) &&\r
- ((is_string($info) && strpos($info, 'zlib') !== null) || isset($info['libz_version'])))\r
- ))\r
- {\r
- $this->accepted_compression = array('gzip', 'deflate');\r
- }\r
-\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 = $xmlrpc->xmlrpcName . ' ' . $xmlrpc->xmlrpcVersion;\r
- }\r
-\r
- /**\r
- * Enables/disables the echoing to screen of the xmlrpc responses received\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
- $this->debug=$in;\r
- }\r
-\r
- /**\r
- * Add some http BASIC AUTH credentials, used by the client to authenticate\r
- * @param string $u username\r
- * @param string $p password\r
- * @param integer $t auth type. See curl_setopt man page for supported auth types. Defaults to CURLAUTH_BASIC (basic auth)\r
- * @access public\r
- */\r
- function setCredentials($u, $p, $t=1)\r
- {\r
- $this->username=$u;\r
- $this->password=$p;\r
- $this->authtype=$t;\r
- }\r
-\r
- /**\r
- * Add a client-side https certificate\r
- * @param string $cert\r
- * @param string $certpass\r
- * @access public\r
- */\r
- function setCertificate($cert, $certpass)\r
- {\r
- $this->cert = $cert;\r
- $this->certpass = $certpass;\r
- }\r
-\r
- /**\r
- * Add a CA certificate to verify server with (see man page about\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
- */\r
- function setCaCertificate($cacert, $is_dir=false)\r
- {\r
- if ($is_dir)\r
- {\r
- $this->cacertdir = $cacert;\r
- }\r
- else\r
- {\r
- $this->cacert = $cacert;\r
- }\r
- }\r
-\r
- /**\r
- * Set attributes for SSL communication: private SSL key\r
- * NB: does not work in older php/curl installs\r
- * Thanks to Daniel Convissor\r
- * @param string $key The name of a file containing a private SSL key\r
- * @param string $keypass The secret password needed to use the private SSL key\r
- * @access public\r
- */\r
- function setKey($key, $keypass)\r
- {\r
- $this->key = $key;\r
- $this->keypass = $keypass;\r
- }\r
-\r
- /**\r
- * Set attributes for SSL communication: verify server certificate\r
- * @param bool $i enable/disable verification of peer certificate\r
- * @access public\r
- */\r
- function setSSLVerifyPeer($i)\r
- {\r
- $this->verifypeer = $i;\r
- }\r
-\r
- /**\r
- * Set attributes for SSL communication: verify match of server cert w. hostname\r
- * @param int $i\r
- * @access public\r
- */\r
- function setSSLVerifyHost($i)\r
- {\r
- $this->verifyhost = $i;\r
- }\r
-\r
- /**\r
- * Set proxy info\r
- * @param string $proxyhost\r
- * @param string $proxyport Defaults to 8080 for HTTP and 443 for HTTPS\r
- * @param string $proxyusername Leave blank if proxy has public access\r
- * @param string $proxypassword Leave blank if proxy has public access\r
- * @param int $proxyauthtype set to constant CURLAUTH_NTLM to use NTLM auth with proxy\r
- * @access public\r
- */\r
- function setProxy($proxyhost, $proxyport, $proxyusername = '', $proxypassword = '', $proxyauthtype = 1)\r
- {\r
- $this->proxy = $proxyhost;\r
- $this->proxyport = $proxyport;\r
- $this->proxy_user = $proxyusername;\r
- $this->proxy_pass = $proxypassword;\r
- $this->proxy_authtype = $proxyauthtype;\r
- }\r
-\r
- /**\r
- * Enables/disables reception of compressed xmlrpc responses.\r
- * Note that enabling reception of compressed responses merely adds some standard\r
- * http headers to xmlrpc requests. It is up to the xmlrpc server to return\r
- * compressed responses when receiving such requests.\r
- * @param string $compmethod either 'gzip', 'deflate', 'any' or ''\r
- * @access public\r
- */\r
- function setAcceptedCompression($compmethod)\r
- {\r
- if ($compmethod == 'any')\r
- $this->accepted_compression = array('gzip', 'deflate');\r
- else\r
- if ($compmethod == false )\r
- $this->accepted_compression = array();\r
- else\r
- $this->accepted_compression = array($compmethod);\r
- }\r
-\r
- /**\r
- * Enables/disables http compression of xmlrpc request.\r
- * Take care when sending compressed requests: servers might not support them\r
- * (and automatic fallback to uncompressed requests is not yet implemented)\r
- * @param string $compmethod either 'gzip', 'deflate' or ''\r
- * @access public\r
- */\r
- function setRequestCompression($compmethod)\r
- {\r
- $this->request_compression = $compmethod;\r
- }\r
-\r
- /**\r
- * Adds a cookie to list of cookies that will be sent to server.\r
- * NB: setting any param but name and value will turn the cookie into a 'version 1' cookie:\r
- * do not do it unless you know what you are doing\r
- * @param string $name\r
- * @param string $value\r
- * @param string $path\r
- * @param string $domain\r
- * @param int $port\r
- * @access public\r
- *\r
- * @todo check correctness of urlencoding cookie value (copied from php way of doing it...)\r
- */\r
- function setCookie($name, $value='', $path='', $domain='', $port=null)\r
- {\r
- $this->cookies[$name]['value'] = urlencode($value);\r
- if ($path || $domain || $port)\r
- {\r
- $this->cookies[$name]['path'] = $path;\r
- $this->cookies[$name]['domain'] = $domain;\r
- $this->cookies[$name]['port'] = $port;\r
- $this->cookies[$name]['version'] = 1;\r
- }\r
- else\r
- {\r
- $this->cookies[$name]['version'] = 0;\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 array $options\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
- * @param integer $timeout Connection timeout, in seconds, If unspecified, a platform specific timeout will apply\r
- * @param string $method if left unspecified, the http protocol chosen during creation of the object will be used\r
- * @return xmlrpcresp\r
- * @access public\r
- */\r
- function& send($msg, $timeout=0, $method='')\r
- {\r
- // if user deos not specify http protocol, use native method of this client\r
- // (i.e. method set during call to constructor)\r
- if($method == '')\r
- {\r
- $method = $this->method;\r
- }\r
-\r
- if(is_array($msg))\r
- {\r
- // $msg is an array of xmlrpcmsg's\r
- $r = $this->multicall($msg, $timeout, $method);\r
- return $r;\r
- }\r
- elseif(is_string($msg))\r
- {\r
- $n = new xmlrpcmsg('');\r
- $n->payload = $msg;\r
- $msg = $n;\r
- }\r
-\r
- // where msg is an xmlrpcmsg\r
- $msg->debug=$this->debug;\r
-\r
- if($method == 'https')\r
- {\r
- $r =& $this->sendPayloadHTTPS(\r
- $msg,\r
- $this->server,\r
- $this->port,\r
- $timeout,\r
- $this->username,\r
- $this->password,\r
- $this->authtype,\r
- $this->cert,\r
- $this->certpass,\r
- $this->cacert,\r
- $this->cacertdir,\r
- $this->proxy,\r
- $this->proxyport,\r
- $this->proxy_user,\r
- $this->proxy_pass,\r
- $this->proxy_authtype,\r
- $this->keepalive,\r
- $this->key,\r
- $this->keypass\r
- );\r
- }\r
- elseif($method == 'http11')\r
- {\r
- $r =& $this->sendPayloadCURL(\r
- $msg,\r
- $this->server,\r
- $this->port,\r
- $timeout,\r
- $this->username,\r
- $this->password,\r
- $this->authtype,\r
- null,\r
- null,\r
- null,\r
- null,\r
- $this->proxy,\r
- $this->proxyport,\r
- $this->proxy_user,\r
- $this->proxy_pass,\r
- $this->proxy_authtype,\r
- 'http',\r
- $this->keepalive\r
- );\r
- }\r
- else\r
- {\r
- $r =& $this->sendPayloadHTTP10(\r
- $msg,\r
- $this->server,\r
- $this->port,\r
- $timeout,\r
- $this->username,\r
- $this->password,\r
- $this->authtype,\r
- $this->proxy,\r
- $this->proxyport,\r
- $this->proxy_user,\r
- $this->proxy_pass,\r
- $this->proxy_authtype\r
- );\r
- }\r
-\r
- return $r;\r
- }\r
-\r
- /**\r
- * @access private\r
- */\r
- function &sendPayloadHTTP10($msg, $server, $port, $timeout=0,\r
- $username='', $password='', $authtype=1, $proxyhost='',\r
- $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1)\r
- {\r
- $xmlrpc = Xmlrpc::instance();\r
-\r
- if($port==0)\r
- {\r
- $port=80;\r
- }\r
-\r
- // Only create the payload if it was not created previously\r
- if(empty($msg->payload))\r
- {\r
- $msg->createPayload($this->request_charset_encoding);\r
- }\r
-\r
- $payload = $msg->payload;\r
- // Deflate request body and set appropriate request headers\r
- if(function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate'))\r
- {\r
- if($this->request_compression == 'gzip')\r
- {\r
- $a = @gzencode($payload);\r
- if($a)\r
- {\r
- $payload = $a;\r
- $encoding_hdr = "Content-Encoding: gzip\r\n";\r
- }\r
- }\r
- else\r
- {\r
- $a = @gzcompress($payload);\r
- if($a)\r
- {\r
- $payload = $a;\r
- $encoding_hdr = "Content-Encoding: deflate\r\n";\r
- }\r
- }\r
- }\r
- else\r
- {\r
- $encoding_hdr = '';\r
- }\r
-\r
- // thanks to Grant Rauscher <grant7@firstworld.net> for this\r
- $credentials='';\r
- if($username!='')\r
- {\r
- $credentials='Authorization: Basic ' . base64_encode($username . ':' . $password) . "\r\n";\r
- if ($authtype != 1)\r
- {\r
- error_log('XML-RPC: '.__METHOD__.': warning. Only Basic auth is supported with HTTP 1.0');\r
- }\r
- }\r
-\r
- $accepted_encoding = '';\r
- if(is_array($this->accepted_compression) && count($this->accepted_compression))\r
- {\r
- $accepted_encoding = 'Accept-Encoding: ' . implode(', ', $this->accepted_compression) . "\r\n";\r
- }\r
-\r
- $proxy_credentials = '';\r
- if($proxyhost)\r
- {\r
- if($proxyport == 0)\r
- {\r
- $proxyport = 8080;\r
- }\r
- $connectserver = $proxyhost;\r
- $connectport = $proxyport;\r
- $uri = 'http://'.$server.':'.$port.$this->path;\r
- if($proxyusername != '')\r
- {\r
- if ($proxyauthtype != 1)\r
- {\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
- else\r
- {\r
- $connectserver = $server;\r
- $connectport = $port;\r
- $uri = $this->path;\r
- }\r
-\r
- // Cookie generation, as per rfc2965 (version 1 cookies) or\r
- // netscape's rules (version 0 cookies)\r
- $cookieheader='';\r
- if (count($this->cookies))\r
- {\r
- $version = '';\r
- foreach ($this->cookies as $name => $cookie)\r
- {\r
- if ($cookie['version'])\r
- {\r
- $version = ' $Version="' . $cookie['version'] . '";';\r
- $cookieheader .= ' ' . $name . '="' . $cookie['value'] . '";';\r
- if ($cookie['path'])\r
- $cookieheader .= ' $Path="' . $cookie['path'] . '";';\r
- if ($cookie['domain'])\r
- $cookieheader .= ' $Domain="' . $cookie['domain'] . '";';\r
- if ($cookie['port'])\r
- $cookieheader .= ' $Port="' . $cookie['port'] . '";';\r
- }\r
- else\r
- {\r
- $cookieheader .= ' ' . $name . '=' . $cookie['value'] . ";";\r
- }\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
- $credentials .\r
- $proxy_credentials .\r
- $accepted_encoding .\r
- $encoding_hdr .\r
- 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings) . "\r\n" .\r
- $cookieheader .\r
- 'Content-Type: ' . $msg->content_type . "\r\nContent-Length: " .\r
- strlen($payload) . "\r\n\r\n" .\r
- $payload;\r
-\r
- if($this->debug > 1)\r
- {\r
-
print "<PRE>\n---SENDING---\n" . htmlentities($op) . "\n---END---\n</PRE>";
\r- // let the client see this now in case http times out...\r
- flush();\r
- }\r
-\r
- if($timeout>0)\r
- {\r
- $fp=@fsockopen($connectserver, $connectport, $this->errno, $this->errstr, $timeout);\r
- }\r
- else\r
- {\r
- $fp=@fsockopen($connectserver, $connectport, $this->errno, $this->errstr);\r
- }\r
- if($fp)\r
- {\r
- if($timeout>0 && function_exists('stream_set_timeout'))\r
- {\r
- stream_set_timeout($fp, $timeout);\r
- }\r
- }\r
- else\r
- {\r
- $this->errstr='Connect error: '.$this->errstr;\r
- $r=new xmlrpcresp(0, $xmlrpc->xmlrpcerr['http_error'], $this->errstr . ' (' . $this->errno . ')');\r
- return $r;\r
- }\r
-\r
- if(!fputs($fp, $op, strlen($op)))\r
- {\r
- fclose($fp);\r
- $this->errstr='Write error';\r
- $r=new xmlrpcresp(0, $xmlrpc->xmlrpcerr['http_error'], $this->errstr);\r
- return $r;\r
- }\r
- else\r
- {\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 yield slightly better execution times, and make easier recursive calls (e.g. to follow http redirects)\r
- $ipd='';\r
- do\r
- {\r
- // shall we check for $data === FALSE?\r
- // as per the manual, it signals an error\r
- $ipd.=fread($fp, 32768);\r
- } while(!feof($fp));\r
- fclose($fp);\r
- $r =& $msg->parseResponse($ipd, false, $this->return_type);\r
- return $r;\r
-\r
- }\r
-\r
- /**\r
- * @access private\r
- */\r
- function &sendPayloadHTTPS($msg, $server, $port, $timeout=0, $username='',\r
- $password='', $authtype=1, $cert='',$certpass='', $cacert='', $cacertdir='',\r
- $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1,\r
- $keepalive=false, $key='', $keypass='')\r
- {\r
- $r =& $this->sendPayloadCURL($msg, $server, $port, $timeout, $username,\r
- $password, $authtype, $cert, $certpass, $cacert, $cacertdir, $proxyhost, $proxyport,\r
- $proxyusername, $proxypassword, $proxyauthtype, 'https', $keepalive, $key, $keypass);\r
- return $r;\r
- }\r
-\r
- /**\r
- * Contributed by Justin Miller <justin@voxel.net>\r
- * Requires curl to be built into PHP\r
- * NB: CURL versions before 7.11.10 cannot use proxy to talk to https servers!\r
- * @access private\r
- */\r
- function &sendPayloadCURL($msg, $server, $port, $timeout=0, $username='',\r
- $password='', $authtype=1, $cert='', $certpass='', $cacert='', $cacertdir='',\r
- $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1, $method='https',\r
- $keepalive=false, $key='', $keypass='')\r
- {\r
- $xmlrpc = Xmlrpc::instance();\r
-\r
- if(!function_exists('curl_init'))\r
- {\r
- $this->errstr='CURL unavailable on this install';\r
- $r=new xmlrpcresp(0, $xmlrpc->xmlrpcerr['no_curl'], $xmlrpc->xmlrpcstr['no_curl']);\r
- return $r;\r
- }\r
- if($method == 'https')\r
- {\r
- if(($info = curl_version()) &&\r
- ((is_string($info) && strpos($info, 'OpenSSL') === null) || (is_array($info) && !isset($info['ssl_version']))))\r
- {\r
- $this->errstr='SSL unavailable on this install';\r
- $r=new xmlrpcresp(0, $xmlrpc->xmlrpcerr['no_ssl'], $xmlrpc->xmlrpcstr['no_ssl']);\r
- return $r;\r
- }\r
- }\r
-\r
- if($port == 0)\r
- {\r
- if($method == 'http')\r
- {\r
- $port = 80;\r
- }\r
- else\r
- {\r
- $port = 443;\r
- }\r
- }\r
-\r
- // Only create the payload if it was not created previously\r
- if(empty($msg->payload))\r
- {\r
- $msg->createPayload($this->request_charset_encoding);\r
- }\r
-\r
- // Deflate request body and set appropriate request headers\r
- $payload = $msg->payload;\r
- if(function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate'))\r
- {\r
- if($this->request_compression == 'gzip')\r
- {\r
- $a = @gzencode($payload);\r
- if($a)\r
- {\r
- $payload = $a;\r
- $encoding_hdr = 'Content-Encoding: gzip';\r
- }\r
- }\r
- else\r
- {\r
- $a = @gzcompress($payload);\r
- if($a)\r
- {\r
- $payload = $a;\r
- $encoding_hdr = 'Content-Encoding: deflate';\r
- }\r
- }\r
- }\r
- else\r
- {\r
- $encoding_hdr = '';\r
- }\r
-\r
- if($this->debug > 1)\r
- {\r
-
print "<PRE>\n---SENDING---\n" . htmlentities($payload) . "\n---END---\n</PRE>";
\r- // let the client see this now in case http times out...\r
- flush();\r
- }\r
-\r
- if(!$keepalive || !$this->xmlrpc_curl_handle)\r
- {\r
- $curl = curl_init($method . '://' . $server . ':' . $port . $this->path);\r
- if($keepalive)\r
- {\r
- $this->xmlrpc_curl_handle = $curl;\r
- }\r
- }\r
- else\r
- {\r
- $curl = $this->xmlrpc_curl_handle;\r
- }\r
-\r
- // results into variable\r
- curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);\r
-\r
- if($this->debug)\r
- {\r
- curl_setopt($curl, CURLOPT_VERBOSE, 1);\r
- }\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
- curl_setopt($curl, CURLOPT_POSTFIELDS, $payload);\r
-\r
- // return the header too\r
- curl_setopt($curl, CURLOPT_HEADER, 1);\r
-\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
- if(is_array($this->accepted_compression) && count($this->accepted_compression))\r
- {\r
- //curl_setopt($curl, CURLOPT_ENCODING, implode(',', $this->accepted_compression));\r
- // empty string means 'any supported by CURL' (shall we catch errors in case CURLOPT_SSLKEY undefined ?)\r
- if (count($this->accepted_compression) == 1)\r
- {\r
- curl_setopt($curl, CURLOPT_ENCODING, $this->accepted_compression[0]);\r
- }\r
- else\r
- curl_setopt($curl, CURLOPT_ENCODING, '');\r
- }\r
- // extra headers\r
- $headers = array('Content-Type: ' . $msg->content_type , 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings));\r
- // if no keepalive is wanted, let the server know it in advance\r
- if(!$keepalive)\r
- {\r
- $headers[] = 'Connection: close';\r
- }\r
- // request compression header\r
- if($encoding_hdr)\r
- {\r
- $headers[] = $encoding_hdr;\r
- }\r
-\r
- curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);\r
- // timeout is borked\r
- if($timeout)\r
- {\r
- curl_setopt($curl, CURLOPT_TIMEOUT, $timeout == 1 ? 1 : $timeout - 1);\r
- }\r
-\r
- if($username && $password)\r
- {\r
- curl_setopt($curl, CURLOPT_USERPWD, $username.':'.$password);\r
- if (defined('CURLOPT_HTTPAUTH'))\r
- {\r
- curl_setopt($curl, CURLOPT_HTTPAUTH, $authtype);\r
- }\r
- else if ($authtype != 1)\r
- {\r
- error_log('XML-RPC: '.__METHOD__.': warning. Only Basic auth is supported by the current PHP/curl install');\r
- }\r
- }\r
-\r
- if($method == 'https')\r
- {\r
- // set cert file\r
- if($cert)\r
- {\r
- curl_setopt($curl, CURLOPT_SSLCERT, $cert);\r
- }\r
- // set cert password\r
- if($certpass)\r
- {\r
- curl_setopt($curl, CURLOPT_SSLCERTPASSWD, $certpass);\r
- }\r
- // whether to verify remote host's cert\r
- curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, $this->verifypeer);\r
- // set ca certificates file/dir\r
- if($cacert)\r
- {\r
- curl_setopt($curl, CURLOPT_CAINFO, $cacert);\r
- }\r
- if($cacertdir)\r
- {\r
- curl_setopt($curl, CURLOPT_CAPATH, $cacertdir);\r
- }\r
- // set key file (shall we catch errors in case CURLOPT_SSLKEY undefined ?)\r
- if($key)\r
- {\r
- curl_setopt($curl, CURLOPT_SSLKEY, $key);\r
- }\r
- // set key password (shall we catch errors in case CURLOPT_SSLKEY undefined ?)\r
- if($keypass)\r
- {\r
- curl_setopt($curl, CURLOPT_SSLKEYPASSWD, $keypass);\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
- // proxy info\r
- if($proxyhost)\r
- {\r
- if($proxyport == 0)\r
- {\r
- $proxyport = 8080; // NB: even for HTTPS, local connection is on port 8080\r
- }\r
- curl_setopt($curl, CURLOPT_PROXY, $proxyhost.':'.$proxyport);\r
- //curl_setopt($curl, CURLOPT_PROXYPORT,$proxyport);\r
- if($proxyusername)\r
- {\r
- curl_setopt($curl, CURLOPT_PROXYUSERPWD, $proxyusername.':'.$proxypassword);\r
- if (defined('CURLOPT_PROXYAUTH'))\r
- {\r
- curl_setopt($curl, CURLOPT_PROXYAUTH, $proxyauthtype);\r
- }\r
- else if ($proxyauthtype != 1)\r
- {\r
- error_log('XML-RPC: '.__METHOD__.': warning. Only Basic auth to proxy is supported by the current PHP/curl install');\r
- }\r
- }\r
- }\r
-\r
- // NB: should we build cookie http headers by hand rather than let CURL do it?\r
- // the following code does not honour 'expires', 'path' and 'domain' cookie attributes\r
- // set to client obj the the user...\r
- if (count($this->cookies))\r
- {\r
- $cookieheader = '';\r
- foreach ($this->cookies as $name => $cookie)\r
- {\r
- $cookieheader .= $name . '=' . $cookie['value'] . '; ';\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
- {\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
- if(!$result) /// @todo we should use a better check here - what if we get back '' or '0'?\r
- {\r
- $this->errstr='no response';\r
- $resp=new xmlrpcresp(0, $xmlrpc->xmlrpcerr['curl_fail'], $xmlrpc->xmlrpcstr['curl_fail']. ': '. curl_error($curl));\r
- curl_close($curl);\r
- if($keepalive)\r
- {\r
- $this->xmlrpc_curl_handle = null;\r
- }\r
- }\r
- else\r
- {\r
- if(!$keepalive)\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() == $xmlrpc->xmlrpcerr['http_error'] && $keepalive)\r
- {\r
- curl_close($curl);\r
- $this->xmlrpc_curl_handle = null;\r
- }\r
- }\r
- return $resp;\r
- }\r
-\r
- /**\r
- * Send an array of request messages and return an array of responses.\r
- * Unless $this->no_multicall has been set to true, it will try first\r
- * to use one single xmlrpc call to server method system.multicall, and\r
- * revert to sending many successive calls in case of failure.\r
- * This failure is also stored in $this->no_multicall for subsequent calls.\r
- * Unfortunately, there is no server error code universally used to denote\r
- * the fact that multicall is unsupported, so there is no way to reliably\r
- * distinguish between that and a temporary failure.\r
- * If you are sure that server supports multicall and do not want to\r
- * fallback to using many single calls, set the fourth parameter to FALSE.\r
- *\r
- * NB: trying to shoehorn extra functionality into existing syntax has resulted\r
- * in pretty much convoluted code...\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 receiving an error during multicall, multiple single calls will be attempted\r
- * @return array\r
- * @access public\r
- */\r
- function multicall($msgs, $timeout=0, $method='', $fallback=true)\r
- {\r
- $xmlrpc = Xmlrpc::instance();\r
-\r
- if ($method == '')\r
- {\r
- $method = $this->method;\r
- }\r
- if(!$this->no_multicall)\r
- {\r
- $results = $this->_try_multicall($msgs, $timeout, $method);\r
- if(is_array($results))\r
- {\r
- // System.multicall succeeded\r
- return $results;\r
- }\r
- else\r
- {\r
- // either system.multicall is unsupported by server,\r
- // or call failed for some other reason.\r
- if ($fallback)\r
- {\r
- // Don't try it next time...\r
- $this->no_multicall = true;\r
- }\r
- else\r
- {\r
- if (is_a($results, 'xmlrpcresp'))\r
- {\r
- $result = $results;\r
- }\r
- else\r
- {\r
- $result = new xmlrpcresp(0, $xmlrpc->xmlrpcerr['multicall_error'], $xmlrpc->xmlrpcstr['multicall_error']);\r
- }\r
- }\r
- }\r
- }\r
- else\r
- {\r
- // override fallback, in case careless user tries to do two\r
- // opposite things at the same time\r
- $fallback = true;\r
- }\r
-\r
- $results = array();\r
- if ($fallback)\r
- {\r
- // system.multicall is (probably) unsupported by server:\r
- // emulate multicall via multiple requests\r
- foreach($msgs as $msg)\r
- {\r
- $results[] =& $this->send($msg, $timeout, $method);\r
- }\r
- }\r
- else\r
- {\r
- // user does NOT want to fallback on many single calls:\r
- // since we should always return an array of responses,\r
- // return an array with the same error repeated n times\r
- foreach($msgs as $msg)\r
- {\r
- $results[] = $result;\r
- }\r
- }\r
- return $results;\r
- }\r
-\r
- /**\r
- * Attempt to boxcar $msgs via system.multicall.\r
- * Returns either an array of xmlrpcreponses, an xmlrpc error response\r
- * or false (when received response does not respect valid multicall syntax)\r
- * @access private\r
- */\r
- function _try_multicall($msgs, $timeout, $method)\r
- {\r
- // Construct multicall message\r
- $calls = array();\r
- foreach($msgs as $msg)\r
- {\r
- $call['methodName'] = new xmlrpcval($msg->method(),'string');\r
- $numParams = $msg->getNumParams();\r
- $params = array();\r
- for($i = 0; $i < $numParams; $i++)\r
- {\r
- $params[$i] = $msg->getParam($i);\r
- }\r
- $call['params'] = new xmlrpcval($params, 'array');\r
- $calls[] = new xmlrpcval($call, 'struct');\r
- }\r
- $multicall = new xmlrpcmsg('system.multicall');\r
- $multicall->addParam(new xmlrpcval($calls, 'array'));\r
-\r
- // Attempt RPC call\r
- $result =& $this->send($multicall, $timeout, $method);\r
-\r
- if($result->faultCode() != 0)\r
- {\r
- // call to system.multicall failed\r
- return $result;\r
- }\r
-\r
- // Unpack responses.\r
- $rets = $result->value();\r
-\r
- if ($this->return_type == 'xml')\r
- {\r
- return $rets;\r
- }\r
- else if ($this->return_type == 'phpvals')\r
- {\r
- ///@todo test this code branch...\r
- $rets = $result->value();\r
- if(!is_array($rets))\r
- {\r
- return false; // bad return type from system.multicall\r
- }\r
- $numRets = count($rets);\r
- if($numRets != count($msgs))\r
- {\r
- return false; // wrong number of return values.\r
- }\r
-\r
- $response = array();\r
- for($i = 0; $i < $numRets; $i++)\r
- {\r
- $val = $rets[$i];\r
- if (!is_array($val)) {\r
- return false;\r
- }\r
- switch(count($val))\r
- {\r
- case 1:\r
- if(!isset($val[0]))\r
- {\r
- return false; // Bad value\r
- }\r
- // Normal return value\r
- $response[$i] = new xmlrpcresp($val[0], 0, '', 'phpvals');\r
- break;\r
- case 2:\r
- /// @todo remove usage of @: it is apparently quite slow\r
- $code = @$val['faultCode'];\r
- if(!is_int($code))\r
- {\r
- return false;\r
- }\r
- $str = @$val['faultString'];\r
- if(!is_string($str))\r
- {\r
- return false;\r
- }\r
- $response[$i] = new xmlrpcresp(0, $code, $str);\r
- break;\r
- default:\r
- return false;\r
- }\r
- }\r
- return $response;\r
- }\r
- else // return type == 'xmlrpcvals'\r
- {\r
- $rets = $result->value();\r
- if($rets->kindOf() != 'array')\r
- {\r
- return false; // bad return type from system.multicall\r
- }\r
- $numRets = $rets->arraysize();\r
- if($numRets != count($msgs))\r
- {\r
- return false; // wrong number of return values.\r
- }\r
-\r
- $response = array();\r
- for($i = 0; $i < $numRets; $i++)\r
- {\r
- $val = $rets->arraymem($i);\r
- switch($val->kindOf())\r
- {\r
- case 'array':\r
- if($val->arraysize() != 1)\r
- {\r
- return false; // Bad value\r
- }\r
- // Normal return value\r
- $response[$i] = new xmlrpcresp($val->arraymem(0));\r
- break;\r
- case 'struct':\r
- $code = $val->structmem('faultCode');\r
- if($code->kindOf() != 'scalar' || $code->scalartyp() != 'int')\r
- {\r
- return false;\r
- }\r
- $str = $val->structmem('faultString');\r
- if($str->kindOf() != 'scalar' || $str->scalartyp() != 'string')\r
- {\r
- return false;\r
- }\r
- $response[$i] = new xmlrpcresp(0, $code->scalarval(), $str->scalarval());\r
- break;\r
- default:\r
- return false;\r
- }\r
- }\r
- return $response;\r
- }\r
- }\r
- } // end class xmlrpc_client\r
-\r
- class xmlrpcresp\r
- {\r
- var $val = 0;\r
- var $valtyp;\r
- var $errno = 0;\r
- var $errstr = '';\r
- var $payload;\r
- var $hdrs = array();\r
- var $_cookies = array();\r
- var $content_type = 'text/xml';\r
- var $raw_data = '';\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
- * @param string $fstr the error string, in case of an error response\r
- * @param string $valtyp either 'xmlrpcvals', 'phpvals' or 'xml'\r
- *\r
- * @todo add check that $val / $fcode / $fstr is of correct type???\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
- {\r
- if($fcode != 0)\r
- {\r
- // error response\r
- $this->errno = $fcode;\r
- $this->errstr = $fstr;\r
- //$this->errstr = htmlspecialchars($fstr); // XXX: encoding probably shouldn't be done here; fix later.\r
- }\r
- else\r
- {\r
- // successful response\r
- $this->val = $val;\r
- if ($valtyp == '')\r
- {\r
- // user did not declare type of response value: try to guess it\r
- if (is_object($this->val) && is_a($this->val, 'xmlrpcval'))\r
- {\r
- $this->valtyp = 'xmlrpcvals';\r
- }\r
- else if (is_string($this->val))\r
- {\r
- $this->valtyp = 'xml';\r
-\r
- }\r
- else\r
- {\r
- $this->valtyp = 'phpvals';\r
- }\r
- }\r
- else\r
- {\r
- // user declares type of resp value: believe him\r
- $this->valtyp = $valtyp;\r
- }\r
- }\r
- }\r
-\r
- /**\r
- * Returns the error code of the response.\r
- * @return integer the error code of this response (0 for not-error responses)\r
- * @access public\r
- */\r
- function faultCode()\r
- {\r
- return $this->errno;\r
- }\r
-\r
- /**\r
- * Returns the error code of the response.\r
- * @return string the error string of this response ('' for not-error responses)\r
- * @access public\r
- */\r
- function faultString()\r
- {\r
- return $this->errstr;\r
- }\r
-\r
- /**\r
- * Returns the value received by the server.\r
- * @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\r
- * @access public\r
- */\r
- function value()\r
- {\r
- return $this->val;\r
- }\r
-\r
- /**\r
- * Returns an array with the cookies received from the server.\r
- * Array has the form: $cookiename => array ('value' => $val, $attr1 => $val1, $attr2 = $val2, ...)\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 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
- */\r
- function cookies()\r
- {\r
- return $this->_cookies;\r
- }\r
-\r
- /**\r
- * Returns xml representation of the response. XML prologue not included\r
- * @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed\r
- * @return string the xml representation of the response\r
- * @access public\r
- */\r
- function serialize($charset_encoding='')\r
- {\r
- $xmlrpc = Xmlrpc::instance();\r
-\r
- if ($charset_encoding != '')\r
- $this->content_type = 'text/xml; charset=' . $charset_encoding;\r
- else\r
- $this->content_type = 'text/xml';\r
- if ($xmlrpc->xmlrpc_null_apache_encoding)\r
- {\r
- $result = "<methodResponse xmlns:ex=\"".$xmlrpc->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
- // by xml-encoding non ascii chars\r
- $result .= "<fault>\n" .\r
+ default:\r
+ $escaped_data = '';\r
+ error_log("Converting from $src_encoding to $dest_encoding: not supported...");\r
+ }\r
+ return $escaped_data;\r
+}\r
+\r
+/// xml parser handler function for opening element tags\r
+function xmlrpc_se($parser, $name, $attrs, $accept_single_vals=false)\r
+{\r
+ $xmlrpc = Xmlrpc::instance();\r
+ // if invalid xmlrpc already detected, skip all processing\r
+ if ($xmlrpc->_xh['isf'] < 2)\r
+ {\r
+ // check for correct element nesting\r
+ // top level element can only be of 2 types\r
+ /// @todo optimization creep: save this check into a bool variable, instead of using count() every time:\r
+ /// there is only a single top level element in xml anyway\r
+ if (count($xmlrpc->_xh['stack']) == 0)\r
+ {\r
+ if ($name != 'METHODRESPONSE' && $name != 'METHODCALL' && (\r
+ $name != 'VALUE' && !$accept_single_vals))\r
+ {\r
+ $xmlrpc->_xh['isf'] = 2;\r
+ $xmlrpc->_xh['isf_reason'] = 'missing top level xmlrpc element';\r
+ return;\r
+ }\r
+ else\r
+ {\r
+ $xmlrpc->_xh['rt'] = strtolower($name);\r
+ $xmlrpc->_xh['rt'] = strtolower($name);\r
+ }\r
+ }\r
+ else\r
+ {\r
+ // not top level element: see if parent is OK\r
+ $parent = end($xmlrpc->_xh['stack']);\r
+ if (!array_key_exists($name, $xmlrpc->xmlrpc_valid_parents) || !in_array($parent, $xmlrpc->xmlrpc_valid_parents[$name]))\r
+ {\r
+ $xmlrpc->_xh['isf'] = 2;\r
+ $xmlrpc->_xh['isf_reason'] = "xmlrpc element $name cannot be child of $parent";\r
+ return;\r
+ }\r
+ }\r
+\r
+ switch($name)\r
+ {\r
+ // optimize for speed switch cases: most common cases first\r
+ case 'VALUE':\r
+ /// @todo we could check for 2 VALUE elements inside a MEMBER or PARAM element\r
+ $xmlrpc->_xh['vt']='value'; // indicator: no value found yet\r
+ $xmlrpc->_xh['ac']='';\r
+ $xmlrpc->_xh['lv']=1;\r
+ $xmlrpc->_xh['php_class']=null;\r
+ break;\r
+ case 'I4':\r
+ case 'INT':\r
+ case 'STRING':\r
+ case 'BOOLEAN':\r
+ case 'DOUBLE':\r
+ case 'DATETIME.ISO8601':\r
+ case 'BASE64':\r
+ if ($xmlrpc->_xh['vt']!='value')\r
+ {\r
+ //two data elements inside a value: an error occurred!\r
+ $xmlrpc->_xh['isf'] = 2;\r
+ $xmlrpc->_xh['isf_reason'] = "$name element following a {$xmlrpc->_xh['vt']} element inside a single value";\r
+ return;\r
+ }\r
+ $xmlrpc->_xh['ac']=''; // reset the accumulator\r
+ break;\r
+ case 'STRUCT':\r
+ case 'ARRAY':\r
+ if ($xmlrpc->_xh['vt']!='value')\r
+ {\r
+ //two data elements inside a value: an error occurred!\r
+ $xmlrpc->_xh['isf'] = 2;\r
+ $xmlrpc->_xh['isf_reason'] = "$name element following a {$xmlrpc->_xh['vt']} element inside a single value";\r
+ return;\r
+ }\r
+ // create an empty array to hold child values, and push it onto appropriate stack\r
+ $cur_val = array();\r
+ $cur_val['values'] = array();\r
+ $cur_val['type'] = $name;\r
+ // check for out-of-band information to rebuild php objs\r
+ // and in case it is found, save it\r
+ if (@isset($attrs['PHP_CLASS']))\r
+ {\r
+ $cur_val['php_class'] = $attrs['PHP_CLASS'];\r
+ }\r
+ $xmlrpc->_xh['valuestack'][] = $cur_val;\r
+ $xmlrpc->_xh['vt']='data'; // be prepared for a data element next\r
+ break;\r
+ case 'DATA':\r
+ if ($xmlrpc->_xh['vt']!='data')\r
+ {\r
+ //two data elements inside a value: an error occurred!\r
+ $xmlrpc->_xh['isf'] = 2;\r
+ $xmlrpc->_xh['isf_reason'] = "found two data elements inside an array element";\r
+ return;\r
+ }\r
+ case 'METHODCALL':\r
+ case 'METHODRESPONSE':\r
+ case 'PARAMS':\r
+ // valid elements that add little to processing\r
+ break;\r
+ case 'METHODNAME':\r
+ case 'NAME':\r
+ /// @todo we could check for 2 NAME elements inside a MEMBER element\r
+ $xmlrpc->_xh['ac']='';\r
+ break;\r
+ case 'FAULT':\r
+ $xmlrpc->_xh['isf']=1;\r
+ break;\r
+ case 'MEMBER':\r
+ $xmlrpc->_xh['valuestack'][count($xmlrpc->_xh['valuestack'])-1]['name']=''; // set member name to null, in case we do not find in the xml later on\r
+ //$xmlrpc->_xh['ac']='';\r
+ // Drop trough intentionally\r
+ case 'PARAM':\r
+ // clear value type, so we can check later if no value has been passed for this param/member\r
+ $xmlrpc->_xh['vt']=null;\r
+ break;\r
+ case 'NIL':\r
+ case 'EX:NIL':\r
+ if ($xmlrpc->xmlrpc_null_extension)\r
+ {\r
+ if ($xmlrpc->_xh['vt']!='value')\r
+ {\r
+ //two data elements inside a value: an error occurred!\r
+ $xmlrpc->_xh['isf'] = 2;\r
+ $xmlrpc->_xh['isf_reason'] = "$name element following a {$xmlrpc->_xh['vt']} element inside a single value";\r
+ return;\r
+ }\r
+ $xmlrpc->_xh['ac']=''; // reset the accumulator\r
+ break;\r
+ }\r
+ // we do not support the <NIL/> extension, so\r
+ // drop through intentionally\r
+ default:\r
+ /// INVALID ELEMENT: RAISE ISF so that it is later recognized!!!\r
+ $xmlrpc->_xh['isf'] = 2;\r
+ $xmlrpc->_xh['isf_reason'] = "found not-xmlrpc xml element $name";\r
+ break;\r
+ }\r
+\r
+ // Save current element name to stack, to validate nesting\r
+ $xmlrpc->_xh['stack'][] = $name;\r
+\r
+ /// @todo optimization creep: move this inside the big switch() above\r
+ if($name!='VALUE')\r
+ {\r
+ $xmlrpc->_xh['lv']=0;\r
+ }\r
+ }\r
+}\r
+\r
+/// Used in decoding xml chunks that might represent single xmlrpc values\r
+function xmlrpc_se_any($parser, $name, $attrs)\r
+{\r
+ xmlrpc_se($parser, $name, $attrs, true);\r
+}\r
+\r
+/// xml parser handler function for close element tags\r
+function xmlrpc_ee($parser, $name, $rebuild_xmlrpcvals = true)\r
+{\r
+ $xmlrpc = Xmlrpc::instance();\r
+\r
+ if ($xmlrpc->_xh['isf'] < 2)\r
+ {\r
+ // push this element name from stack\r
+ // NB: if XML validates, correct opening/closing is guaranteed and\r
+ // we do not have to check for $name == $curr_elem.\r
+ // we also checked for proper nesting at start of elements...\r
+ $curr_elem = array_pop($xmlrpc->_xh['stack']);\r
+\r
+ switch($name)\r
+ {\r
+ case 'VALUE':\r
+ // This if() detects if no scalar was inside <VALUE></VALUE>\r
+ if ($xmlrpc->_xh['vt']=='value')\r
+ {\r
+ $xmlrpc->_xh['value']=$xmlrpc->_xh['ac'];\r
+ $xmlrpc->_xh['vt']=$xmlrpc->xmlrpcString;\r
+ }\r
+\r
+ if ($rebuild_xmlrpcvals)\r
+ {\r
+ // build the xmlrpc val out of the data received, and substitute it\r
+ $temp = new xmlrpcval($xmlrpc->_xh['value'], $xmlrpc->_xh['vt']);\r
+ // in case we got info about underlying php class, save it\r
+ // in the object we're rebuilding\r
+ if (isset($xmlrpc->_xh['php_class']))\r
+ $temp->_php_class = $xmlrpc->_xh['php_class'];\r
+ // check if we are inside an array or struct:\r
+ // if value just built is inside an array, let's move it into array on the stack\r
+ $vscount = count($xmlrpc->_xh['valuestack']);\r
+ if ($vscount && $xmlrpc->_xh['valuestack'][$vscount-1]['type']=='ARRAY')\r
+ {\r
+ $xmlrpc->_xh['valuestack'][$vscount-1]['values'][] = $temp;\r
+ }\r
+ else\r
+ {\r
+ $xmlrpc->_xh['value'] = $temp;\r
+ }\r
+ }\r
+ else\r
+ {\r
+ /// @todo this needs to treat correctly php-serialized objects,\r
+ /// since std deserializing is done by php_xmlrpc_decode,\r
+ /// which we will not be calling...\r
+ if (isset($xmlrpc->_xh['php_class']))\r
+ {\r
+ }\r
+\r
+ // check if we are inside an array or struct:\r
+ // if value just built is inside an array, let's move it into array on the stack\r
+ $vscount = count($xmlrpc->_xh['valuestack']);\r
+ if ($vscount && $xmlrpc->_xh['valuestack'][$vscount-1]['type']=='ARRAY')\r
+ {\r
+ $xmlrpc->_xh['valuestack'][$vscount-1]['values'][] = $xmlrpc->_xh['value'];\r
+ }\r
+ }\r
+ break;\r
+ case 'BOOLEAN':\r
+ case 'I4':\r
+ case 'INT':\r
+ case 'STRING':\r
+ case 'DOUBLE':\r
+ case 'DATETIME.ISO8601':\r
+ case 'BASE64':\r
+ $xmlrpc->_xh['vt']=strtolower($name);\r
+ /// @todo: optimization creep - remove the if/elseif cycle below\r
+ /// since the case() in which we are already did that\r
+ if ($name=='STRING')\r
+ {\r
+ $xmlrpc->_xh['value']=$xmlrpc->_xh['ac'];\r
+ }\r
+ elseif ($name=='DATETIME.ISO8601')\r
+ {\r
+ if (!preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $xmlrpc->_xh['ac']))\r
+ {\r
+ error_log('XML-RPC: invalid value received in DATETIME: '.$xmlrpc->_xh['ac']);\r
+ }\r
+ $xmlrpc->_xh['vt']=$xmlrpc->xmlrpcDateTime;\r
+ $xmlrpc->_xh['value']=$xmlrpc->_xh['ac'];\r
+ }\r
+ elseif ($name=='BASE64')\r
+ {\r
+ /// @todo check for failure of base64 decoding / catch warnings\r
+ $xmlrpc->_xh['value']=base64_decode($xmlrpc->_xh['ac']);\r
+ }\r
+ elseif ($name=='BOOLEAN')\r
+ {\r
+ // special case here: we translate boolean 1 or 0 into PHP\r
+ // constants true or false.\r
+ // Strings 'true' and 'false' are accepted, even though the\r
+ // spec never mentions them (see eg. Blogger api docs)\r
+ // NB: this simple checks helps a lot sanitizing input, ie no\r
+ // security problems around here\r
+ if ($xmlrpc->_xh['ac']=='1' || strcasecmp($xmlrpc->_xh['ac'], 'true') == 0)\r
+ {\r
+ $xmlrpc->_xh['value']=true;\r
+ }\r
+ else\r
+ {\r
+ // log if receiveing something strange, even though we set the value to false anyway\r
+ if ($xmlrpc->_xh['ac']!='0' && strcasecmp($xmlrpc->_xh['ac'], 'false') != 0)\r
+ error_log('XML-RPC: invalid value received in BOOLEAN: '.$xmlrpc->_xh['ac']);\r
+ $xmlrpc->_xh['value']=false;\r
+ }\r
+ }\r
+ elseif ($name=='DOUBLE')\r
+ {\r
+ // we have a DOUBLE\r
+ // we must check that only 0123456789-.<space> are characters here\r
+ // NOTE: regexp could be much stricter than this...\r
+ if (!preg_match('/^[+-eE0123456789 \t.]+$/', $xmlrpc->_xh['ac']))\r
+ {\r
+ /// @todo: find a better way of throwing an error than this!\r
+ error_log('XML-RPC: non numeric value received in DOUBLE: '.$xmlrpc->_xh['ac']);\r
+ $xmlrpc->_xh['value']='ERROR_NON_NUMERIC_FOUND';\r
+ }\r
+ else\r
+ {\r
+ // it's ok, add it on\r
+ $xmlrpc->_xh['value']=(double)$xmlrpc->_xh['ac'];\r
+ }\r
+ }\r
+ else\r
+ {\r
+ // we have an I4/INT\r
+ // we must check that only 0123456789-<space> are characters here\r
+ if (!preg_match('/^[+-]?[0123456789 \t]+$/', $xmlrpc->_xh['ac']))\r
+ {\r
+ /// @todo find a better way of throwing an error than this!\r
+ error_log('XML-RPC: non numeric value received in INT: '.$xmlrpc->_xh['ac']);\r
+ $xmlrpc->_xh['value']='ERROR_NON_NUMERIC_FOUND';\r
+ }\r
+ else\r
+ {\r
+ // it's ok, add it on\r
+ $xmlrpc->_xh['value']=(int)$xmlrpc->_xh['ac'];\r
+ }\r
+ }\r
+ //$xmlrpc->_xh['ac']=''; // is this necessary?\r
+ $xmlrpc->_xh['lv']=3; // indicate we've found a value\r
+ break;\r
+ case 'NAME':\r
+ $xmlrpc->_xh['valuestack'][count($xmlrpc->_xh['valuestack'])-1]['name'] = $xmlrpc->_xh['ac'];\r
+ break;\r
+ case 'MEMBER':\r
+ //$xmlrpc->_xh['ac']=''; // is this necessary?\r
+ // add to array in the stack the last element built,\r
+ // unless no VALUE was found\r
+ if ($xmlrpc->_xh['vt'])\r
+ {\r
+ $vscount = count($xmlrpc->_xh['valuestack']);\r
+ $xmlrpc->_xh['valuestack'][$vscount-1]['values'][$xmlrpc->_xh['valuestack'][$vscount-1]['name']] = $xmlrpc->_xh['value'];\r
+ } else\r
+ error_log('XML-RPC: missing VALUE inside STRUCT in received xml');\r
+ break;\r
+ case 'DATA':\r
+ //$xmlrpc->_xh['ac']=''; // is this necessary?\r
+ $xmlrpc->_xh['vt']=null; // reset this to check for 2 data elements in a row - even if they're empty\r
+ break;\r
+ case 'STRUCT':\r
+ case 'ARRAY':\r
+ // fetch out of stack array of values, and promote it to current value\r
+ $curr_val = array_pop($xmlrpc->_xh['valuestack']);\r
+ $xmlrpc->_xh['value'] = $curr_val['values'];\r
+ $xmlrpc->_xh['vt']=strtolower($name);\r
+ if (isset($curr_val['php_class']))\r
+ {\r
+ $xmlrpc->_xh['php_class'] = $curr_val['php_class'];\r
+ }\r
+ break;\r
+ case 'PARAM':\r
+ // add to array of params the current value,\r
+ // unless no VALUE was found\r
+ if ($xmlrpc->_xh['vt'])\r
+ {\r
+ $xmlrpc->_xh['params'][]=$xmlrpc->_xh['value'];\r
+ $xmlrpc->_xh['pt'][]=$xmlrpc->_xh['vt'];\r
+ }\r
+ else\r
+ error_log('XML-RPC: missing VALUE inside PARAM in received xml');\r
+ break;\r
+ case 'METHODNAME':\r
+ $xmlrpc->_xh['method']=preg_replace('/^[\n\r\t ]+/', '', $xmlrpc->_xh['ac']);\r
+ break;\r
+ case 'NIL':\r
+ case 'EX:NIL':\r
+ if ($xmlrpc->xmlrpc_null_extension)\r
+ {\r
+ $xmlrpc->_xh['vt']='null';\r
+ $xmlrpc->_xh['value']=null;\r
+ $xmlrpc->_xh['lv']=3;\r
+ break;\r
+ }\r
+ // drop through intentionally if nil extension not enabled\r
+ case 'PARAMS':\r
+ case 'FAULT':\r
+ case 'METHODCALL':\r
+ case 'METHORESPONSE':\r
+ break;\r
+ default:\r
+ // End of INVALID ELEMENT!\r
+ // shall we add an assert here for unreachable code???\r
+ break;\r
+ }\r
+ }\r
+}\r
+\r
+/// Used in decoding xmlrpc requests/responses without rebuilding xmlrpc values\r
+function xmlrpc_ee_fast($parser, $name)\r
+{\r
+ xmlrpc_ee($parser, $name, false);\r
+}\r
+\r
+/// xml parser handler function for character data\r
+function xmlrpc_cd($parser, $data)\r
+{\r
+ $xmlrpc = Xmlrpc::instance();\r
+ // skip processing if xml fault already detected\r
+ if ($xmlrpc->_xh['isf'] < 2)\r
+ {\r
+ // "lookforvalue==3" means that we've found an entire value\r
+ // and should discard any further character data\r
+ if($xmlrpc->_xh['lv']!=3)\r
+ {\r
+ // G. Giunta 2006-08-23: useless change of 'lv' from 1 to 2\r
+ //if($xmlrpc->_xh['lv']==1)\r
+ //{\r
+ // if we've found text and we're just in a <value> then\r
+ // say we've found a value\r
+ //$xmlrpc->_xh['lv']=2;\r
+ //}\r
+ // we always initialize the accumulator before starting parsing, anyway...\r
+ //if(!@isset($xmlrpc->_xh['ac']))\r
+ //{\r
+ // $xmlrpc->_xh['ac'] = '';\r
+ //}\r
+ $xmlrpc->_xh['ac'].=$data;\r
+ }\r
+ }\r
+}\r
+\r
+/// xml parser handler function for 'other stuff', ie. not char data or\r
+/// element start/end tag. In fact it only gets called on unknown entities...\r
+function xmlrpc_dh($parser, $data)\r
+{\r
+ $xmlrpc = Xmlrpc::instance();\r
+ // skip processing if xml fault already detected\r
+ if ($xmlrpc->_xh['isf'] < 2)\r
+ {\r
+ if(substr($data, 0, 1) == '&' && substr($data, -1, 1) == ';')\r
+ {\r
+ // G. Giunta 2006-08-25: useless change of 'lv' from 1 to 2\r
+ //if($xmlrpc->_xh['lv']==1)\r
+ //{\r
+ // $xmlrpc->_xh['lv']=2;\r
+ //}\r
+ $xmlrpc->_xh['ac'].=$data;\r
+ }\r
+ }\r
+ return true;\r
+}\r
+\r
+class xmlrpc_client\r
+{\r
+ var $path;\r
+ var $server;\r
+ var $port=0;\r
+ var $method='http';\r
+ var $errno;\r
+ var $errstr;\r
+ var $debug=0;\r
+ var $username='';\r
+ var $password='';\r
+ var $authtype=1;\r
+ var $cert='';\r
+ var $certpass='';\r
+ var $cacert='';\r
+ var $cacertdir='';\r
+ var $key='';\r
+ var $keypass='';\r
+ var $verifypeer=true;\r
+ var $verifyhost=2;\r
+ var $no_multicall=false;\r
+ var $proxy='';\r
+ var $proxyport=0;\r
+ var $proxy_user='';\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
+ *\r
+ * NNB: you can set it to any non-empty array for HTTP11 and HTTPS, since\r
+ * in those cases it will be up to CURL to decide the compression methods\r
+ * it supports. You might check for the presence of 'zlib' in the output of\r
+ * curl_version() to determine wheter compression is supported or not\r
+ */\r
+ var $accepted_compression = array();\r
+ /**\r
+ * Name of compression scheme to be used for sending requests.\r
+ * Either null, gzip or deflate\r
+ */\r
+ var $request_compression = '';\r
+ /**\r
+ * CURL handle: used for keep-alive connections (PHP 4.3.8 up, see:\r
+ * http://curl.haxx.se/docs/faq.html#7.3)\r
+ */\r
+ var $xmlrpc_curl_handle = null;\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
+ /// Charset encoding to be used in serializing request. NULL = use ASCII\r
+ var $request_charset_encoding = '';\r
+ /**\r
+ * Decides the content of xmlrpcresp objects returned by calls to send()\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
+ * @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
+ {\r
+ $xmlrpc = Xmlrpc::instance();\r
+\r
+ // allow user to specify all params in $path\r
+ if($server == '' and $port == '' and $method == '')\r
+ {\r
+ $parts = parse_url($path);\r
+ $server = $parts['host'];\r
+ $path = isset($parts['path']) ? $parts['path'] : '';\r
+ if(isset($parts['query']))\r
+ {\r
+ $path .= '?'.$parts['query'];\r
+ }\r
+ if(isset($parts['fragment']))\r
+ {\r
+ $path .= '#'.$parts['fragment'];\r
+ }\r
+ if(isset($parts['port']))\r
+ {\r
+ $port = $parts['port'];\r
+ }\r
+ if(isset($parts['scheme']))\r
+ {\r
+ $method = $parts['scheme'];\r
+ }\r
+ if(isset($parts['user']))\r
+ {\r
+ $this->username = $parts['user'];\r
+ }\r
+ if(isset($parts['pass']))\r
+ {\r
+ $this->password = $parts['pass'];\r
+ }\r
+ }\r
+ if($path == '' || $path[0] != '/')\r
+ {\r
+ $this->path='/'.$path;\r
+ }\r
+ else\r
+ {\r
+ $this->path=$path;\r
+ }\r
+ $this->server=$server;\r
+ if($port != '')\r
+ {\r
+ $this->port=$port;\r
+ }\r
+ if($method != '')\r
+ {\r
+ $this->method=$method;\r
+ }\r
+\r
+ // if ZLIB is enabled, let the client by default accept compressed responses\r
+ if(function_exists('gzinflate') || (\r
+ function_exists('curl_init') && (($info = curl_version()) &&\r
+ ((is_string($info) && strpos($info, 'zlib') !== null) || isset($info['libz_version'])))\r
+ ))\r
+ {\r
+ $this->accepted_compression = array('gzip', 'deflate');\r
+ }\r
+\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 = $xmlrpc->xmlrpcName . ' ' . $xmlrpc->xmlrpcVersion;\r
+ }\r
+\r
+ /**\r
+ * Enables/disables the echoing to screen of the xmlrpc responses received\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
+ $this->debug=$in;\r
+ }\r
+\r
+ /**\r
+ * Add some http BASIC AUTH credentials, used by the client to authenticate\r
+ * @param string $u username\r
+ * @param string $p password\r
+ * @param integer $t auth type. See curl_setopt man page for supported auth types. Defaults to CURLAUTH_BASIC (basic auth)\r
+ * @access public\r
+ */\r
+ function setCredentials($u, $p, $t=1)\r
+ {\r
+ $this->username=$u;\r
+ $this->password=$p;\r
+ $this->authtype=$t;\r
+ }\r
+\r
+ /**\r
+ * Add a client-side https certificate\r
+ * @param string $cert\r
+ * @param string $certpass\r
+ * @access public\r
+ */\r
+ function setCertificate($cert, $certpass)\r
+ {\r
+ $this->cert = $cert;\r
+ $this->certpass = $certpass;\r
+ }\r
+\r
+ /**\r
+ * Add a CA certificate to verify server with (see man page about\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
+ */\r
+ function setCaCertificate($cacert, $is_dir=false)\r
+ {\r
+ if ($is_dir)\r
+ {\r
+ $this->cacertdir = $cacert;\r
+ }\r
+ else\r
+ {\r
+ $this->cacert = $cacert;\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Set attributes for SSL communication: private SSL key\r
+ * NB: does not work in older php/curl installs\r
+ * Thanks to Daniel Convissor\r
+ * @param string $key The name of a file containing a private SSL key\r
+ * @param string $keypass The secret password needed to use the private SSL key\r
+ * @access public\r
+ */\r
+ function setKey($key, $keypass)\r
+ {\r
+ $this->key = $key;\r
+ $this->keypass = $keypass;\r
+ }\r
+\r
+ /**\r
+ * Set attributes for SSL communication: verify server certificate\r
+ * @param bool $i enable/disable verification of peer certificate\r
+ * @access public\r
+ */\r
+ function setSSLVerifyPeer($i)\r
+ {\r
+ $this->verifypeer = $i;\r
+ }\r
+\r
+ /**\r
+ * Set attributes for SSL communication: verify match of server cert w. hostname\r
+ * @param int $i\r
+ * @access public\r
+ */\r
+ function setSSLVerifyHost($i)\r
+ {\r
+ $this->verifyhost = $i;\r
+ }\r
+\r
+ /**\r
+ * Set proxy info\r
+ * @param string $proxyhost\r
+ * @param string $proxyport Defaults to 8080 for HTTP and 443 for HTTPS\r
+ * @param string $proxyusername Leave blank if proxy has public access\r
+ * @param string $proxypassword Leave blank if proxy has public access\r
+ * @param int $proxyauthtype set to constant CURLAUTH_NTLM to use NTLM auth with proxy\r
+ * @access public\r
+ */\r
+ function setProxy($proxyhost, $proxyport, $proxyusername = '', $proxypassword = '', $proxyauthtype = 1)\r
+ {\r
+ $this->proxy = $proxyhost;\r
+ $this->proxyport = $proxyport;\r
+ $this->proxy_user = $proxyusername;\r
+ $this->proxy_pass = $proxypassword;\r
+ $this->proxy_authtype = $proxyauthtype;\r
+ }\r
+\r
+ /**\r
+ * Enables/disables reception of compressed xmlrpc responses.\r
+ * Note that enabling reception of compressed responses merely adds some standard\r
+ * http headers to xmlrpc requests. It is up to the xmlrpc server to return\r
+ * compressed responses when receiving such requests.\r
+ * @param string $compmethod either 'gzip', 'deflate', 'any' or ''\r
+ * @access public\r
+ */\r
+ function setAcceptedCompression($compmethod)\r
+ {\r
+ if ($compmethod == 'any')\r
+ $this->accepted_compression = array('gzip', 'deflate');\r
+ else\r
+ if ($compmethod == false )\r
+ $this->accepted_compression = array();\r
+ else\r
+ $this->accepted_compression = array($compmethod);\r
+ }\r
+\r
+ /**\r
+ * Enables/disables http compression of xmlrpc request.\r
+ * Take care when sending compressed requests: servers might not support them\r
+ * (and automatic fallback to uncompressed requests is not yet implemented)\r
+ * @param string $compmethod either 'gzip', 'deflate' or ''\r
+ * @access public\r
+ */\r
+ function setRequestCompression($compmethod)\r
+ {\r
+ $this->request_compression = $compmethod;\r
+ }\r
+\r
+ /**\r
+ * Adds a cookie to list of cookies that will be sent to server.\r
+ * NB: setting any param but name and value will turn the cookie into a 'version 1' cookie:\r
+ * do not do it unless you know what you are doing\r
+ * @param string $name\r
+ * @param string $value\r
+ * @param string $path\r
+ * @param string $domain\r
+ * @param int $port\r
+ * @access public\r
+ *\r
+ * @todo check correctness of urlencoding cookie value (copied from php way of doing it...)\r
+ */\r
+ function setCookie($name, $value='', $path='', $domain='', $port=null)\r
+ {\r
+ $this->cookies[$name]['value'] = urlencode($value);\r
+ if ($path || $domain || $port)\r
+ {\r
+ $this->cookies[$name]['path'] = $path;\r
+ $this->cookies[$name]['domain'] = $domain;\r
+ $this->cookies[$name]['port'] = $port;\r
+ $this->cookies[$name]['version'] = 1;\r
+ }\r
+ else\r
+ {\r
+ $this->cookies[$name]['version'] = 0;\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 array $options\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
+ * @param integer $timeout Connection timeout, in seconds, If unspecified, a platform specific timeout will apply\r
+ * @param string $method if left unspecified, the http protocol chosen during creation of the object will be used\r
+ * @return xmlrpcresp\r
+ * @access public\r
+ */\r
+ function& send($msg, $timeout=0, $method='')\r
+ {\r
+ // if user deos not specify http protocol, use native method of this client\r
+ // (i.e. method set during call to constructor)\r
+ if($method == '')\r
+ {\r
+ $method = $this->method;\r
+ }\r
+\r
+ if(is_array($msg))\r
+ {\r
+ // $msg is an array of xmlrpcmsg's\r
+ $r = $this->multicall($msg, $timeout, $method);\r
+ return $r;\r
+ }\r
+ elseif(is_string($msg))\r
+ {\r
+ $n = new xmlrpcmsg('');\r
+ $n->payload = $msg;\r
+ $msg = $n;\r
+ }\r
+\r
+ // where msg is an xmlrpcmsg\r
+ $msg->debug=$this->debug;\r
+\r
+ if($method == 'https')\r
+ {\r
+ $r =& $this->sendPayloadHTTPS(\r
+ $msg,\r
+ $this->server,\r
+ $this->port,\r
+ $timeout,\r
+ $this->username,\r
+ $this->password,\r
+ $this->authtype,\r
+ $this->cert,\r
+ $this->certpass,\r
+ $this->cacert,\r
+ $this->cacertdir,\r
+ $this->proxy,\r
+ $this->proxyport,\r
+ $this->proxy_user,\r
+ $this->proxy_pass,\r
+ $this->proxy_authtype,\r
+ $this->keepalive,\r
+ $this->key,\r
+ $this->keypass\r
+ );\r
+ }\r
+ elseif($method == 'http11')\r
+ {\r
+ $r =& $this->sendPayloadCURL(\r
+ $msg,\r
+ $this->server,\r
+ $this->port,\r
+ $timeout,\r
+ $this->username,\r
+ $this->password,\r
+ $this->authtype,\r
+ null,\r
+ null,\r
+ null,\r
+ null,\r
+ $this->proxy,\r
+ $this->proxyport,\r
+ $this->proxy_user,\r
+ $this->proxy_pass,\r
+ $this->proxy_authtype,\r
+ 'http',\r
+ $this->keepalive\r
+ );\r
+ }\r
+ else\r
+ {\r
+ $r =& $this->sendPayloadHTTP10(\r
+ $msg,\r
+ $this->server,\r
+ $this->port,\r
+ $timeout,\r
+ $this->username,\r
+ $this->password,\r
+ $this->authtype,\r
+ $this->proxy,\r
+ $this->proxyport,\r
+ $this->proxy_user,\r
+ $this->proxy_pass,\r
+ $this->proxy_authtype\r
+ );\r
+ }\r
+\r
+ return $r;\r
+ }\r
+\r
+ /**\r
+ * @access private\r
+ */\r
+ function &sendPayloadHTTP10($msg, $server, $port, $timeout=0,\r
+ $username='', $password='', $authtype=1, $proxyhost='',\r
+ $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1)\r
+ {\r
+ $xmlrpc = Xmlrpc::instance();\r
+\r
+ if($port==0)\r
+ {\r
+ $port=80;\r
+ }\r
+\r
+ // Only create the payload if it was not created previously\r
+ if(empty($msg->payload))\r
+ {\r
+ $msg->createPayload($this->request_charset_encoding);\r
+ }\r
+\r
+ $payload = $msg->payload;\r
+ // Deflate request body and set appropriate request headers\r
+ if(function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate'))\r
+ {\r
+ if($this->request_compression == 'gzip')\r
+ {\r
+ $a = @gzencode($payload);\r
+ if($a)\r
+ {\r
+ $payload = $a;\r
+ $encoding_hdr = "Content-Encoding: gzip\r\n";\r
+ }\r
+ }\r
+ else\r
+ {\r
+ $a = @gzcompress($payload);\r
+ if($a)\r
+ {\r
+ $payload = $a;\r
+ $encoding_hdr = "Content-Encoding: deflate\r\n";\r
+ }\r
+ }\r
+ }\r
+ else\r
+ {\r
+ $encoding_hdr = '';\r
+ }\r
+\r
+ // thanks to Grant Rauscher <grant7@firstworld.net> for this\r
+ $credentials='';\r
+ if($username!='')\r
+ {\r
+ $credentials='Authorization: Basic ' . base64_encode($username . ':' . $password) . "\r\n";\r
+ if ($authtype != 1)\r
+ {\r
+ error_log('XML-RPC: '.__METHOD__.': warning. Only Basic auth is supported with HTTP 1.0');\r
+ }\r
+ }\r
+\r
+ $accepted_encoding = '';\r
+ if(is_array($this->accepted_compression) && count($this->accepted_compression))\r
+ {\r
+ $accepted_encoding = 'Accept-Encoding: ' . implode(', ', $this->accepted_compression) . "\r\n";\r
+ }\r
+\r
+ $proxy_credentials = '';\r
+ if($proxyhost)\r
+ {\r
+ if($proxyport == 0)\r
+ {\r
+ $proxyport = 8080;\r
+ }\r
+ $connectserver = $proxyhost;\r
+ $connectport = $proxyport;\r
+ $uri = 'http://'.$server.':'.$port.$this->path;\r
+ if($proxyusername != '')\r
+ {\r
+ if ($proxyauthtype != 1)\r
+ {\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
+ else\r
+ {\r
+ $connectserver = $server;\r
+ $connectport = $port;\r
+ $uri = $this->path;\r
+ }\r
+\r
+ // Cookie generation, as per rfc2965 (version 1 cookies) or\r
+ // netscape's rules (version 0 cookies)\r
+ $cookieheader='';\r
+ if (count($this->cookies))\r
+ {\r
+ $version = '';\r
+ foreach ($this->cookies as $name => $cookie)\r
+ {\r
+ if ($cookie['version'])\r
+ {\r
+ $version = ' $Version="' . $cookie['version'] . '";';\r
+ $cookieheader .= ' ' . $name . '="' . $cookie['value'] . '";';\r
+ if ($cookie['path'])\r
+ $cookieheader .= ' $Path="' . $cookie['path'] . '";';\r
+ if ($cookie['domain'])\r
+ $cookieheader .= ' $Domain="' . $cookie['domain'] . '";';\r
+ if ($cookie['port'])\r
+ $cookieheader .= ' $Port="' . $cookie['port'] . '";';\r
+ }\r
+ else\r
+ {\r
+ $cookieheader .= ' ' . $name . '=' . $cookie['value'] . ";";\r
+ }\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
+ $credentials .\r
+ $proxy_credentials .\r
+ $accepted_encoding .\r
+ $encoding_hdr .\r
+ 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings) . "\r\n" .\r
+ $cookieheader .\r
+ 'Content-Type: ' . $msg->content_type . "\r\nContent-Length: " .\r
+ strlen($payload) . "\r\n\r\n" .\r
+ $payload;\r
+\r
+ if($this->debug > 1)\r
+ {\r
+ print "<PRE>\n---SENDING---\n" . htmlentities($op) . "\n---END---\n</PRE>";\r
+ // let the client see this now in case http times out...\r
+ flush();\r
+ }\r
+\r
+ if($timeout>0)\r
+ {\r
+ $fp=@fsockopen($connectserver, $connectport, $this->errno, $this->errstr, $timeout);\r
+ }\r
+ else\r
+ {\r
+ $fp=@fsockopen($connectserver, $connectport, $this->errno, $this->errstr);\r
+ }\r
+ if($fp)\r
+ {\r
+ if($timeout>0 && function_exists('stream_set_timeout'))\r
+ {\r
+ stream_set_timeout($fp, $timeout);\r
+ }\r
+ }\r
+ else\r
+ {\r
+ $this->errstr='Connect error: '.$this->errstr;\r
+ $r=new xmlrpcresp(0, $xmlrpc->xmlrpcerr['http_error'], $this->errstr . ' (' . $this->errno . ')');\r
+ return $r;\r
+ }\r
+\r
+ if(!fputs($fp, $op, strlen($op)))\r
+ {\r
+ fclose($fp);\r
+ $this->errstr='Write error';\r
+ $r=new xmlrpcresp(0, $xmlrpc->xmlrpcerr['http_error'], $this->errstr);\r
+ return $r;\r
+ }\r
+ else\r
+ {\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 yield slightly better execution times, and make easier recursive calls (e.g. to follow http redirects)\r
+ $ipd='';\r
+ do\r
+ {\r
+ // shall we check for $data === FALSE?\r
+ // as per the manual, it signals an error\r
+ $ipd.=fread($fp, 32768);\r
+ } while(!feof($fp));\r
+ fclose($fp);\r
+ $r =& $msg->parseResponse($ipd, false, $this->return_type);\r
+ return $r;\r
+\r
+ }\r
+\r
+ /**\r
+ * @access private\r
+ */\r
+ function &sendPayloadHTTPS($msg, $server, $port, $timeout=0, $username='',\r
+ $password='', $authtype=1, $cert='',$certpass='', $cacert='', $cacertdir='',\r
+ $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1,\r
+ $keepalive=false, $key='', $keypass='')\r
+ {\r
+ $r =& $this->sendPayloadCURL($msg, $server, $port, $timeout, $username,\r
+ $password, $authtype, $cert, $certpass, $cacert, $cacertdir, $proxyhost, $proxyport,\r
+ $proxyusername, $proxypassword, $proxyauthtype, 'https', $keepalive, $key, $keypass);\r
+ return $r;\r
+ }\r
+\r
+ /**\r
+ * Contributed by Justin Miller <justin@voxel.net>\r
+ * Requires curl to be built into PHP\r
+ * NB: CURL versions before 7.11.10 cannot use proxy to talk to https servers!\r
+ * @access private\r
+ */\r
+ function &sendPayloadCURL($msg, $server, $port, $timeout=0, $username='',\r
+ $password='', $authtype=1, $cert='', $certpass='', $cacert='', $cacertdir='',\r
+ $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1, $method='https',\r
+ $keepalive=false, $key='', $keypass='')\r
+ {\r
+ $xmlrpc = Xmlrpc::instance();\r
+\r
+ if(!function_exists('curl_init'))\r
+ {\r
+ $this->errstr='CURL unavailable on this install';\r
+ $r=new xmlrpcresp(0, $xmlrpc->xmlrpcerr['no_curl'], $xmlrpc->xmlrpcstr['no_curl']);\r
+ return $r;\r
+ }\r
+ if($method == 'https')\r
+ {\r
+ if(($info = curl_version()) &&\r
+ ((is_string($info) && strpos($info, 'OpenSSL') === null) || (is_array($info) && !isset($info['ssl_version']))))\r
+ {\r
+ $this->errstr='SSL unavailable on this install';\r
+ $r=new xmlrpcresp(0, $xmlrpc->xmlrpcerr['no_ssl'], $xmlrpc->xmlrpcstr['no_ssl']);\r
+ return $r;\r
+ }\r
+ }\r
+\r
+ if($port == 0)\r
+ {\r
+ if($method == 'http')\r
+ {\r
+ $port = 80;\r
+ }\r
+ else\r
+ {\r
+ $port = 443;\r
+ }\r
+ }\r
+\r
+ // Only create the payload if it was not created previously\r
+ if(empty($msg->payload))\r
+ {\r
+ $msg->createPayload($this->request_charset_encoding);\r
+ }\r
+\r
+ // Deflate request body and set appropriate request headers\r
+ $payload = $msg->payload;\r
+ if(function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate'))\r
+ {\r
+ if($this->request_compression == 'gzip')\r
+ {\r
+ $a = @gzencode($payload);\r
+ if($a)\r
+ {\r
+ $payload = $a;\r
+ $encoding_hdr = 'Content-Encoding: gzip';\r
+ }\r
+ }\r
+ else\r
+ {\r
+ $a = @gzcompress($payload);\r
+ if($a)\r
+ {\r
+ $payload = $a;\r
+ $encoding_hdr = 'Content-Encoding: deflate';\r
+ }\r
+ }\r
+ }\r
+ else\r
+ {\r
+ $encoding_hdr = '';\r
+ }\r
+\r
+ if($this->debug > 1)\r
+ {\r
+ print "<PRE>\n---SENDING---\n" . htmlentities($payload) . "\n---END---\n</PRE>";\r
+ // let the client see this now in case http times out...\r
+ flush();\r
+ }\r
+\r
+ if(!$keepalive || !$this->xmlrpc_curl_handle)\r
+ {\r
+ $curl = curl_init($method . '://' . $server . ':' . $port . $this->path);\r
+ if($keepalive)\r
+ {\r
+ $this->xmlrpc_curl_handle = $curl;\r
+ }\r
+ }\r
+ else\r
+ {\r
+ $curl = $this->xmlrpc_curl_handle;\r
+ }\r
+\r
+ // results into variable\r
+ curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);\r
+\r
+ if($this->debug)\r
+ {\r
+ curl_setopt($curl, CURLOPT_VERBOSE, 1);\r
+ }\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
+ curl_setopt($curl, CURLOPT_POSTFIELDS, $payload);\r
+\r
+ // return the header too\r
+ curl_setopt($curl, CURLOPT_HEADER, 1);\r
+\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
+ if(is_array($this->accepted_compression) && count($this->accepted_compression))\r
+ {\r
+ //curl_setopt($curl, CURLOPT_ENCODING, implode(',', $this->accepted_compression));\r
+ // empty string means 'any supported by CURL' (shall we catch errors in case CURLOPT_SSLKEY undefined ?)\r
+ if (count($this->accepted_compression) == 1)\r
+ {\r
+ curl_setopt($curl, CURLOPT_ENCODING, $this->accepted_compression[0]);\r
+ }\r
+ else\r
+ curl_setopt($curl, CURLOPT_ENCODING, '');\r
+ }\r
+ // extra headers\r
+ $headers = array('Content-Type: ' . $msg->content_type , 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings));\r
+ // if no keepalive is wanted, let the server know it in advance\r
+ if(!$keepalive)\r
+ {\r
+ $headers[] = 'Connection: close';\r
+ }\r
+ // request compression header\r
+ if($encoding_hdr)\r
+ {\r
+ $headers[] = $encoding_hdr;\r
+ }\r
+\r
+ curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);\r
+ // timeout is borked\r
+ if($timeout)\r
+ {\r
+ curl_setopt($curl, CURLOPT_TIMEOUT, $timeout == 1 ? 1 : $timeout - 1);\r
+ }\r
+\r
+ if($username && $password)\r
+ {\r
+ curl_setopt($curl, CURLOPT_USERPWD, $username.':'.$password);\r
+ if (defined('CURLOPT_HTTPAUTH'))\r
+ {\r
+ curl_setopt($curl, CURLOPT_HTTPAUTH, $authtype);\r
+ }\r
+ else if ($authtype != 1)\r
+ {\r
+ error_log('XML-RPC: '.__METHOD__.': warning. Only Basic auth is supported by the current PHP/curl install');\r
+ }\r
+ }\r
+\r
+ if($method == 'https')\r
+ {\r
+ // set cert file\r
+ if($cert)\r
+ {\r
+ curl_setopt($curl, CURLOPT_SSLCERT, $cert);\r
+ }\r
+ // set cert password\r
+ if($certpass)\r
+ {\r
+ curl_setopt($curl, CURLOPT_SSLCERTPASSWD, $certpass);\r
+ }\r
+ // whether to verify remote host's cert\r
+ curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, $this->verifypeer);\r
+ // set ca certificates file/dir\r
+ if($cacert)\r
+ {\r
+ curl_setopt($curl, CURLOPT_CAINFO, $cacert);\r
+ }\r
+ if($cacertdir)\r
+ {\r
+ curl_setopt($curl, CURLOPT_CAPATH, $cacertdir);\r
+ }\r
+ // set key file (shall we catch errors in case CURLOPT_SSLKEY undefined ?)\r
+ if($key)\r
+ {\r
+ curl_setopt($curl, CURLOPT_SSLKEY, $key);\r
+ }\r
+ // set key password (shall we catch errors in case CURLOPT_SSLKEY undefined ?)\r
+ if($keypass)\r
+ {\r
+ curl_setopt($curl, CURLOPT_SSLKEYPASSWD, $keypass);\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
+ // proxy info\r
+ if($proxyhost)\r
+ {\r
+ if($proxyport == 0)\r
+ {\r
+ $proxyport = 8080; // NB: even for HTTPS, local connection is on port 8080\r
+ }\r
+ curl_setopt($curl, CURLOPT_PROXY, $proxyhost.':'.$proxyport);\r
+ //curl_setopt($curl, CURLOPT_PROXYPORT,$proxyport);\r
+ if($proxyusername)\r
+ {\r
+ curl_setopt($curl, CURLOPT_PROXYUSERPWD, $proxyusername.':'.$proxypassword);\r
+ if (defined('CURLOPT_PROXYAUTH'))\r
+ {\r
+ curl_setopt($curl, CURLOPT_PROXYAUTH, $proxyauthtype);\r
+ }\r
+ else if ($proxyauthtype != 1)\r
+ {\r
+ error_log('XML-RPC: '.__METHOD__.': warning. Only Basic auth to proxy is supported by the current PHP/curl install');\r
+ }\r
+ }\r
+ }\r
+\r
+ // NB: should we build cookie http headers by hand rather than let CURL do it?\r
+ // the following code does not honour 'expires', 'path' and 'domain' cookie attributes\r
+ // set to client obj the the user...\r
+ if (count($this->cookies))\r
+ {\r
+ $cookieheader = '';\r
+ foreach ($this->cookies as $name => $cookie)\r
+ {\r
+ $cookieheader .= $name . '=' . $cookie['value'] . '; ';\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
+ {\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
+ if(!$result) /// @todo we should use a better check here - what if we get back '' or '0'?\r
+ {\r
+ $this->errstr='no response';\r
+ $resp=new xmlrpcresp(0, $xmlrpc->xmlrpcerr['curl_fail'], $xmlrpc->xmlrpcstr['curl_fail']. ': '. curl_error($curl));\r
+ curl_close($curl);\r
+ if($keepalive)\r
+ {\r
+ $this->xmlrpc_curl_handle = null;\r
+ }\r
+ }\r
+ else\r
+ {\r
+ if(!$keepalive)\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() == $xmlrpc->xmlrpcerr['http_error'] && $keepalive)\r
+ {\r
+ curl_close($curl);\r
+ $this->xmlrpc_curl_handle = null;\r
+ }\r
+ }\r
+ return $resp;\r
+ }\r
+\r
+ /**\r
+ * Send an array of request messages and return an array of responses.\r
+ * Unless $this->no_multicall has been set to true, it will try first\r
+ * to use one single xmlrpc call to server method system.multicall, and\r
+ * revert to sending many successive calls in case of failure.\r
+ * This failure is also stored in $this->no_multicall for subsequent calls.\r
+ * Unfortunately, there is no server error code universally used to denote\r
+ * the fact that multicall is unsupported, so there is no way to reliably\r
+ * distinguish between that and a temporary failure.\r
+ * If you are sure that server supports multicall and do not want to\r
+ * fallback to using many single calls, set the fourth parameter to FALSE.\r
+ *\r
+ * NB: trying to shoehorn extra functionality into existing syntax has resulted\r
+ * in pretty much convoluted code...\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 receiving an error during multicall, multiple single calls will be attempted\r
+ * @return array\r
+ * @access public\r
+ */\r
+ function multicall($msgs, $timeout=0, $method='', $fallback=true)\r
+ {\r
+ $xmlrpc = Xmlrpc::instance();\r
+\r
+ if ($method == '')\r
+ {\r
+ $method = $this->method;\r
+ }\r
+ if(!$this->no_multicall)\r
+ {\r
+ $results = $this->_try_multicall($msgs, $timeout, $method);\r
+ if(is_array($results))\r
+ {\r
+ // System.multicall succeeded\r
+ return $results;\r
+ }\r
+ else\r
+ {\r
+ // either system.multicall is unsupported by server,\r
+ // or call failed for some other reason.\r
+ if ($fallback)\r
+ {\r
+ // Don't try it next time...\r
+ $this->no_multicall = true;\r
+ }\r
+ else\r
+ {\r
+ if (is_a($results, 'xmlrpcresp'))\r
+ {\r
+ $result = $results;\r
+ }\r
+ else\r
+ {\r
+ $result = new xmlrpcresp(0, $xmlrpc->xmlrpcerr['multicall_error'], $xmlrpc->xmlrpcstr['multicall_error']);\r
+ }\r
+ }\r
+ }\r
+ }\r
+ else\r
+ {\r
+ // override fallback, in case careless user tries to do two\r
+ // opposite things at the same time\r
+ $fallback = true;\r
+ }\r
+\r
+ $results = array();\r
+ if ($fallback)\r
+ {\r
+ // system.multicall is (probably) unsupported by server:\r
+ // emulate multicall via multiple requests\r
+ foreach($msgs as $msg)\r
+ {\r
+ $results[] =& $this->send($msg, $timeout, $method);\r
+ }\r
+ }\r
+ else\r
+ {\r
+ // user does NOT want to fallback on many single calls:\r
+ // since we should always return an array of responses,\r
+ // return an array with the same error repeated n times\r
+ foreach($msgs as $msg)\r
+ {\r
+ $results[] = $result;\r
+ }\r
+ }\r
+ return $results;\r
+ }\r
+\r
+ /**\r
+ * Attempt to boxcar $msgs via system.multicall.\r
+ * Returns either an array of xmlrpcreponses, an xmlrpc error response\r
+ * or false (when received response does not respect valid multicall syntax)\r
+ * @access private\r
+ */\r
+ function _try_multicall($msgs, $timeout, $method)\r
+ {\r
+ // Construct multicall message\r
+ $calls = array();\r
+ foreach($msgs as $msg)\r
+ {\r
+ $call['methodName'] = new xmlrpcval($msg->method(),'string');\r
+ $numParams = $msg->getNumParams();\r
+ $params = array();\r
+ for($i = 0; $i < $numParams; $i++)\r
+ {\r
+ $params[$i] = $msg->getParam($i);\r
+ }\r
+ $call['params'] = new xmlrpcval($params, 'array');\r
+ $calls[] = new xmlrpcval($call, 'struct');\r
+ }\r
+ $multicall = new xmlrpcmsg('system.multicall');\r
+ $multicall->addParam(new xmlrpcval($calls, 'array'));\r
+\r
+ // Attempt RPC call\r
+ $result =& $this->send($multicall, $timeout, $method);\r
+\r
+ if($result->faultCode() != 0)\r
+ {\r
+ // call to system.multicall failed\r
+ return $result;\r
+ }\r
+\r
+ // Unpack responses.\r
+ $rets = $result->value();\r
+\r
+ if ($this->return_type == 'xml')\r
+ {\r
+ return $rets;\r
+ }\r
+ else if ($this->return_type == 'phpvals')\r
+ {\r
+ ///@todo test this code branch...\r
+ $rets = $result->value();\r
+ if(!is_array($rets))\r
+ {\r
+ return false; // bad return type from system.multicall\r
+ }\r
+ $numRets = count($rets);\r
+ if($numRets != count($msgs))\r
+ {\r
+ return false; // wrong number of return values.\r
+ }\r
+\r
+ $response = array();\r
+ for($i = 0; $i < $numRets; $i++)\r
+ {\r
+ $val = $rets[$i];\r
+ if (!is_array($val)) {\r
+ return false;\r
+ }\r
+ switch(count($val))\r
+ {\r
+ case 1:\r
+ if(!isset($val[0]))\r
+ {\r
+ return false; // Bad value\r
+ }\r
+ // Normal return value\r
+ $response[$i] = new xmlrpcresp($val[0], 0, '', 'phpvals');\r
+ break;\r
+ case 2:\r
+ /// @todo remove usage of @: it is apparently quite slow\r
+ $code = @$val['faultCode'];\r
+ if(!is_int($code))\r
+ {\r
+ return false;\r
+ }\r
+ $str = @$val['faultString'];\r
+ if(!is_string($str))\r
+ {\r
+ return false;\r
+ }\r
+ $response[$i] = new xmlrpcresp(0, $code, $str);\r
+ break;\r
+ default:\r
+ return false;\r
+ }\r
+ }\r
+ return $response;\r
+ }\r
+ else // return type == 'xmlrpcvals'\r
+ {\r
+ $rets = $result->value();\r
+ if($rets->kindOf() != 'array')\r
+ {\r
+ return false; // bad return type from system.multicall\r
+ }\r
+ $numRets = $rets->arraysize();\r
+ if($numRets != count($msgs))\r
+ {\r
+ return false; // wrong number of return values.\r
+ }\r
+\r
+ $response = array();\r
+ for($i = 0; $i < $numRets; $i++)\r
+ {\r
+ $val = $rets->arraymem($i);\r
+ switch($val->kindOf())\r
+ {\r
+ case 'array':\r
+ if($val->arraysize() != 1)\r
+ {\r
+ return false; // Bad value\r
+ }\r
+ // Normal return value\r
+ $response[$i] = new xmlrpcresp($val->arraymem(0));\r
+ break;\r
+ case 'struct':\r
+ $code = $val->structmem('faultCode');\r
+ if($code->kindOf() != 'scalar' || $code->scalartyp() != 'int')\r
+ {\r
+ return false;\r
+ }\r
+ $str = $val->structmem('faultString');\r
+ if($str->kindOf() != 'scalar' || $str->scalartyp() != 'string')\r
+ {\r
+ return false;\r
+ }\r
+ $response[$i] = new xmlrpcresp(0, $code->scalarval(), $str->scalarval());\r
+ break;\r
+ default:\r
+ return false;\r
+ }\r
+ }\r
+ return $response;\r
+ }\r
+ }\r
+} // end class xmlrpc_client\r
+\r
+class xmlrpcresp\r
+{\r
+ var $val = 0;\r
+ var $valtyp;\r
+ var $errno = 0;\r
+ var $errstr = '';\r
+ var $payload;\r
+ var $hdrs = array();\r
+ var $_cookies = array();\r
+ var $content_type = 'text/xml';\r
+ var $raw_data = '';\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
+ * @param string $fstr the error string, in case of an error response\r
+ * @param string $valtyp either 'xmlrpcvals', 'phpvals' or 'xml'\r
+ *\r
+ * @todo add check that $val / $fcode / $fstr is of correct type???\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
+ {\r
+ if($fcode != 0)\r
+ {\r
+ // error response\r
+ $this->errno = $fcode;\r
+ $this->errstr = $fstr;\r
+ //$this->errstr = htmlspecialchars($fstr); // XXX: encoding probably shouldn't be done here; fix later.\r
+ }\r
+ else\r
+ {\r
+ // successful response\r
+ $this->val = $val;\r
+ if ($valtyp == '')\r
+ {\r
+ // user did not declare type of response value: try to guess it\r
+ if (is_object($this->val) && is_a($this->val, 'xmlrpcval'))\r
+ {\r
+ $this->valtyp = 'xmlrpcvals';\r
+ }\r
+ else if (is_string($this->val))\r
+ {\r
+ $this->valtyp = 'xml';\r
+\r
+ }\r
+ else\r
+ {\r
+ $this->valtyp = 'phpvals';\r
+ }\r
+ }\r
+ else\r
+ {\r
+ // user declares type of resp value: believe him\r
+ $this->valtyp = $valtyp;\r
+ }\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Returns the error code of the response.\r
+ * @return integer the error code of this response (0 for not-error responses)\r
+ * @access public\r
+ */\r
+ function faultCode()\r
+ {\r
+ return $this->errno;\r
+ }\r
+\r
+ /**\r
+ * Returns the error code of the response.\r
+ * @return string the error string of this response ('' for not-error responses)\r
+ * @access public\r
+ */\r
+ function faultString()\r
+ {\r
+ return $this->errstr;\r
+ }\r
+\r
+ /**\r
+ * Returns the value received by the server.\r
+ * @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\r
+ * @access public\r
+ */\r
+ function value()\r
+ {\r
+ return $this->val;\r
+ }\r
+\r
+ /**\r
+ * Returns an array with the cookies received from the server.\r
+ * Array has the form: $cookiename => array ('value' => $val, $attr1 => $val1, $attr2 = $val2, ...)\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 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
+ */\r
+ function cookies()\r
+ {\r
+ return $this->_cookies;\r
+ }\r
+\r
+ /**\r
+ * Returns xml representation of the response. XML prologue not included\r
+ * @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed\r
+ * @return string the xml representation of the response\r
+ * @access public\r
+ */\r
+ function serialize($charset_encoding='')\r
+ {\r
+ $xmlrpc = Xmlrpc::instance();\r
+\r
+ if ($charset_encoding != '')\r
+ $this->content_type = 'text/xml; charset=' . $charset_encoding;\r
+ else\r
+ $this->content_type = 'text/xml';\r
+ if ($xmlrpc->xmlrpc_null_apache_encoding)\r
+ {\r
+ $result = "<methodResponse xmlns:ex=\"".$xmlrpc->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
+ // by xml-encoding non ascii chars\r
+ $result .= "<fault>\n" .\r
"<value>\n<struct><member><name>faultCode</name>\n<value><int>" . $this->errno .\r
"</int></value>\n</member>\n<member>\n<name>faultString</name>\n<value><string>" .\r
xmlrpc_encode_entitites($this->errstr, $xmlrpc->xmlrpc_internalencoding, $charset_encoding) . "</string></value>\n</member>\n" .\r
"</struct>\n</value>\n</fault>";\r
- }\r
- else\r
- {\r
- if(!is_object($this->val) || !is_a($this->val, 'xmlrpcval'))\r
- {\r
- if (is_string($this->val) && $this->valtyp == 'xml')\r
- {\r
-
$result .= "<params>\n<param>\n" .
\r- $this->val .\r
- "</param>\n</params>";\r
- }\r
- else\r
- {\r
- /// @todo try to build something serializable?\r
- die('cannot serialize xmlrpcresp objects whose content is native php values');\r
- }\r
- }\r
- else\r
- {\r
-
$result .= "<params>\n<param>\n" .
\r- $this->val->serialize($charset_encoding) .\r
- "</param>\n</params>";\r
- }\r
- }\r
- $result .= "\n</methodResponse>";\r
- $this->payload = $result;\r
- return $result;\r
- }\r
- }\r
-\r
- class xmlrpcmsg\r
- {\r
- var $payload;\r
- var $methodname;\r
- var $params=array();\r
- var $debug=0;\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 passed to the method (xmlrpcval objects)\r
- */\r
- function xmlrpcmsg($meth, $pars=0)\r
- {\r
- $this->methodname=$meth;\r
- if(is_array($pars) && count($pars)>0)\r
- {\r
- for($i=0; $i<count($pars); $i++)\r
- {\r
- $this->addParam($pars[$i]);\r
- }\r
- }\r
- }\r
-\r
- /**\r
- * @access private\r
- */\r
- function xml_header($charset_encoding='')\r
- {\r
- if ($charset_encoding != '')\r
- {\r
- return "<?xml version=\"1.0\" encoding=\"$charset_encoding\" ?" . ">\n<methodCall>\n";\r
- }\r
- else\r
- {\r
- return "<?xml version=\"1.0\"?" . ">\n<methodCall>\n";\r
- }\r
- }\r
-\r
- /**\r
- * @access private\r
- */\r
- function xml_footer()\r
- {\r
- return '</methodCall>';\r
- }\r
-\r
- /**\r
- * @access private\r
- */\r
- function kindOf()\r
- {\r
- return 'msg';\r
- }\r
-\r
- /**\r
- * @access private\r
- */\r
- function createPayload($charset_encoding='')\r
- {\r
- if ($charset_encoding != '')\r
- $this->content_type = 'text/xml; charset=' . $charset_encoding;\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.="<params>\n";
\r- for($i=0; $i<count($this->params); $i++)\r
- {\r
- $p=$this->params[$i];\r
-
$this->payload.="<param>\n" . $p->serialize($charset_encoding) .
\r- "</param>\n";\r
- }\r
- $this->payload.="</params>\n";\r
- $this->payload.=$this->xml_footer();\r
- }\r
-\r
- /**\r
- * Gets/sets the xmlrpc method to be invoked\r
- * @param string $meth the method to be set (leave empty not to set it)\r
- * @return string the method that will be invoked\r
- * @access public\r
- */\r
- function method($meth='')\r
- {\r
- if($meth!='')\r
- {\r
- $this->methodname=$meth;\r
- }\r
- return $this->methodname;\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
- function serialize($charset_encoding='')\r
- {\r
- $this->createPayload($charset_encoding);\r
- return $this->payload;\r
- }\r
-\r
- /**\r
- * Add a parameter to the list of parameters to be used upon method invocation\r
- * @param xmlrpcval $par\r
- * @return boolean false on failure\r
- * @access public\r
- */\r
- function addParam($par)\r
- {\r
- // add check: do not add to self params which are not xmlrpcvals\r
- if(is_object($par) && is_a($par, 'xmlrpcval'))\r
- {\r
- $this->params[]=$par;\r
- return true;\r
- }\r
- else\r
- {\r
- return false;\r
- }\r
- }\r
-\r
- /**\r
- * Returns the nth parameter in the message. The index zero-based.\r
- * @param integer $i the index of the parameter to fetch (zero based)\r
- * @return xmlrpcval the i-th parameter\r
- * @access public\r
- */\r
- function getParam($i) { return $this->params[$i]; }\r
-\r
- /**\r
- * Returns the number of parameters in the messge.\r
- * @return integer the number of parameters currently set\r
- * @access public\r
- */\r
- function getNumParams() { return count($this->params); }\r
-\r
- /**\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
- * 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
- * @access public\r
- * @param resource $fp stream pointer\r
- * @return xmlrpcresp\r
- * @todo add 2nd & 3rd param to be passed to ParseResponse() ???\r
- */\r
- function &parseResponseFile($fp)\r
- {\r
- $ipd='';\r
- while($data=fread($fp, 32768))\r
- {\r
- $ipd.=$data;\r
- }\r
- //fclose($fp);\r
- $r =& $this->parseResponse($ipd);\r
- return $r;\r
- }\r
-\r
- /**\r
- * Parses HTTP headers and separates them from data.\r
- * @access private\r
- */\r
- function &parseResponseHeaders(&$data, $headers_processed=false)\r
- {\r
- $xmlrpc = Xmlrpc::instance();\r
- // Support "web-proxy-tunelling" connections for https through proxies\r
- if(preg_match('/^HTTP\/1\.[0-1] 200 Connection established/', $data))\r
- {\r
- // Look for CR/LF or simple LF as line separator,\r
- // (even though it is not valid http)\r
- $pos = strpos($data,"\r\n\r\n");\r
- if($pos || is_int($pos))\r
- {\r
- $bd = $pos+4;\r
- }\r
- else\r
- {\r
- $pos = strpos($data,"\n\n");\r
- if($pos || is_int($pos))\r
- {\r
- $bd = $pos+2;\r
- }\r
- else\r
- {\r
- // No separation between response headers and body: fault?\r
- $bd = 0;\r
- }\r
- }\r
- if ($bd)\r
- {\r
- // this filters out all http headers from proxy.\r
- // maybe we could take them into account, too?\r
- $data = substr($data, $bd);\r
- }\r
- else\r
- {\r
- error_log('XML-RPC: '.__METHOD__.': HTTPS via proxy error, tunnel connection possibly failed');\r
- $r=new xmlrpcresp(0, $xmlrpc->xmlrpcerr['http_error'], $xmlrpc->xmlrpcstr['http_error']. ' (HTTPS via proxy error, tunnel connection possibly failed)');\r
- return $r;\r
- }\r
- }\r
-\r
- // Strip HTTP 1.1 100 Continue header if present\r
- while(preg_match('/^HTTP\/1\.1 1[0-9]{2} /', $data))\r
- {\r
- $pos = strpos($data, 'HTTP', 12);\r
- // server sent a Continue header without any (valid) content following...\r
- // give the client a chance to know it\r
- if(!$pos && !is_int($pos)) // works fine in php 3, 4 and 5\r
- {\r
- break;\r
- }\r
- $data = substr($data, $pos);\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: '.__METHOD__.': HTTP error, got response: ' .$errstr);\r
- $r=new xmlrpcresp(0, $xmlrpc->xmlrpcerr['http_error'], $xmlrpc->xmlrpcstr['http_error']. ' (' . $errstr . ')');\r
- return $r;\r
- }\r
-\r
- $xmlrpc->_xh['headers'] = array();\r
- $xmlrpc->_xh['cookies'] = array();\r
-\r
- // be tolerant to usage of \n instead of \r\n to separate headers and data\r
- // (even though it is not valid http)\r
- $pos = strpos($data,"\r\n\r\n");\r
- if($pos || is_int($pos))\r
- {\r
- $bd = $pos+4;\r
- }\r
- else\r
- {\r
- $pos = strpos($data,"\n\n");\r
- if($pos || is_int($pos))\r
- {\r
- $bd = $pos+2;\r
- }\r
- else\r
- {\r
- // No separation between response headers and body: fault?\r
- // we could take some action here instead of going on...\r
- $bd = 0;\r
- }\r
- }\r
- // be tolerant to line endings, and extra empty lines\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
- $arr = explode(':',$line,2);\r
- if(count($arr) > 1)\r
- {\r
- $header_name = strtolower(trim($arr[0]));\r
- /// @todo some other headers (the ones that allow a CSV list of values)\r
- /// do allow many values to be passed using multiple header lines.\r
- /// We should add content to $xmlrpc->_xh['headers'][$header_name]\r
- /// instead of replacing it for those...\r
- if ($header_name == 'set-cookie' || $header_name == 'set-cookie2')\r
- {\r
- if ($header_name == 'set-cookie2')\r
- {\r
- // version 2 cookies:\r
- // there could be many cookies on one line, comma separated\r
- $cookies = explode(',', $arr[1]);\r
- }\r
- else\r
- {\r
- $cookies = array($arr[1]);\r
- }\r
- foreach ($cookies as $cookie)\r
- {\r
- // glue together all received cookies, using a comma to separate them\r
- // (same as php does with getallheaders())\r
- if (isset($xmlrpc->_xh['headers'][$header_name]))\r
- $xmlrpc->_xh['headers'][$header_name] .= ', ' . trim($cookie);\r
- else\r
- $xmlrpc->_xh['headers'][$header_name] = trim($cookie);\r
- // parse cookie attributes, in case user wants to correctly honour them\r
- // feature creep: only allow rfc-compliant cookie attributes?\r
- // @todo support for server sending multiple time cookie with same name, but using different PATHs\r
- $cookie = explode(';', $cookie);\r
- foreach ($cookie as $pos => $val)\r
- {\r
- $val = explode('=', $val, 2);\r
- $tag = trim($val[0]);\r
- $val = trim(@$val[1]);\r
- /// @todo with version 1 cookies, we should strip leading and trailing " chars\r
- if ($pos == 0)\r
- {\r
- $cookiename = $tag;\r
- $xmlrpc->_xh['cookies'][$tag] = array();\r
- $xmlrpc->_xh['cookies'][$cookiename]['value'] = urldecode($val);\r
- }\r
- else\r
- {\r
- if ($tag != 'value')\r
- {\r
- $xmlrpc->_xh['cookies'][$cookiename][$tag] = $val;\r
- }\r
- }\r
- }\r
- }\r
- }\r
- else\r
- {\r
- $xmlrpc->_xh['headers'][$header_name] = trim($arr[1]);\r
- }\r
- }\r
- elseif(isset($header_name))\r
- {\r
- /// @todo version1 cookies might span multiple lines, thus breaking the parsing above\r
- $xmlrpc->_xh['headers'][$header_name] .= ' ' . trim($line);\r
- }\r
- }\r
-\r
- $data = substr($data, $bd);\r
-\r
- if($this->debug && count($xmlrpc->_xh['headers']))\r
- {\r
- foreach($xmlrpc->_xh['headers'] as $header => $value)\r
- {\r
- print htmlentities("HEADER: $header: $value\n");\r
- }\r
- foreach($xmlrpc->_xh['cookies'] as $header => $value)\r
- {\r
- print htmlentities("COOKIE: $header={$value['value']}\n");\r
- }\r
- print "</PRE>\n";\r
- }\r
-\r
- // if CURL was used for the call, http headers have been processed,\r
- // and dechunking + reinflating have been carried out\r
- if(!$headers_processed)\r
- {\r
- // Decode chunked encoding sent by http 1.1 servers\r
- if(isset($xmlrpc->_xh['headers']['transfer-encoding']) && $xmlrpc->_xh['headers']['transfer-encoding'] == 'chunked')\r
- {\r
- if(!$data = decode_chunked($data))\r
- {\r
- error_log('XML-RPC: '.__METHOD__.': errors occurred when trying to rebuild the chunked data received from server');\r
- $r = new xmlrpcresp(0, $xmlrpc->xmlrpcerr['dechunk_fail'], $xmlrpc->xmlrpcstr['dechunk_fail']);\r
- return $r;\r
- }\r
- }\r
-\r
- // Decode gzip-compressed stuff\r
- // code shamelessly inspired from nusoap library by Dietrich Ayala\r
- if(isset($xmlrpc->_xh['headers']['content-encoding']))\r
- {\r
- $xmlrpc->_xh['headers']['content-encoding'] = str_replace('x-', '', $xmlrpc->_xh['headers']['content-encoding']);\r
- if($xmlrpc->_xh['headers']['content-encoding'] == 'deflate' || $xmlrpc->_xh['headers']['content-encoding'] == 'gzip')\r
- {\r
- // if decoding works, use it. else assume data wasn't gzencoded\r
- if(function_exists('gzinflate'))\r
- {\r
- if($xmlrpc->_xh['headers']['content-encoding'] == 'deflate' && $degzdata = @gzuncompress($data))\r
- {\r
- $data = $degzdata;\r
- if($this->debug)\r
-
print "<PRE>---INFLATED RESPONSE---[".strlen($data)." chars]---\n" . htmlentities($data) . "\n---END---</PRE>";
\r- }\r
- elseif($xmlrpc->_xh['headers']['content-encoding'] == 'gzip' && $degzdata = @gzinflate(substr($data, 10)))\r
- {\r
- $data = $degzdata;\r
- if($this->debug)\r
-
print "<PRE>---INFLATED RESPONSE---[".strlen($data)." chars]---\n" . htmlentities($data) . "\n---END---</PRE>";
\r- }\r
- else\r
- {\r
- error_log('XML-RPC: '.__METHOD__.': errors occurred when trying to decode the deflated data received from server');\r
- $r = new xmlrpcresp(0, $xmlrpc->xmlrpcerr['decompress_fail'], $xmlrpc->xmlrpcstr['decompress_fail']);\r
- return $r;\r
- }\r
- }\r
- else\r
- {\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, $xmlrpc->xmlrpcerr['cannot_decompress'], $xmlrpc->xmlrpcstr['cannot_decompress']);\r
- return $r;\r
- }\r
- }\r
- }\r
- } // end of 'if needed, de-chunk, re-inflate response'\r
-\r
- // real stupid hack to avoid PHP complaining about returning NULL by ref\r
- $r = null;\r
- $r =& $r;\r
- return $r;\r
- }\r
-\r
- /**\r
- * Parse the xmlrpc response contained in the string $data and return an xmlrpcresp object.\r
- * @param string $data the xmlrpc response, eventually including http headers\r
- * @param bool $headers_processed when true prevents parsing HTTP headers for interpretation of content-encoding and consequent decoding\r
- * @param string $return_type decides return type, i.e. content of response->value(). Either 'xmlrpcvals', 'xml' or 'phpvals'\r
- * @return xmlrpcresp\r
- * @access public\r
- */\r
- function &parseResponse($data='', $headers_processed=false, $return_type='xmlrpcvals')\r
- {\r
- $xmlrpc = Xmlrpc::instance();\r
-\r
- if($this->debug)\r
- {\r
- //by maHo, replaced htmlspecialchars with htmlentities\r
-
print "<PRE>---GOT---\n" . htmlentities($data) . "\n---END---\n</PRE>";
\r- }\r
-\r
- if($data == '')\r
- {\r
- error_log('XML-RPC: '.__METHOD__.': no response received from server.');\r
- $r = new xmlrpcresp(0, $xmlrpc->xmlrpcerr['no_data'], $xmlrpc->xmlrpcstr['no_data']);\r
- return $r;\r
- }\r
-\r
- $xmlrpc->_xh=array();\r
-\r
- $raw_data = $data;\r
- // parse the HTTP headers of the response, if present, and separate them from data\r
- if(substr($data, 0, 4) == 'HTTP')\r
- {\r
- $r =& $this->parseResponseHeaders($data, $headers_processed);\r
- if ($r)\r
- {\r
- // failed processing of HTTP response headers\r
- // save into response obj the full payload received, for debugging\r
- $r->raw_data = $data;\r
- return $r;\r
- }\r
- }\r
- else\r
- {\r
- $xmlrpc->_xh['headers'] = array();\r
- $xmlrpc->_xh['cookies'] = array();\r
- }\r
-\r
- if($this->debug)\r
- {\r
- $start = strpos($data, '<!-- SERVER DEBUG INFO (BASE64 ENCODED):');\r
- if ($start)\r
- {\r
- $start += strlen('<!-- SERVER DEBUG INFO (BASE64 ENCODED):');\r
- $end = strpos($data, '-->', $start);\r
- $comments = substr($data, $start, $end-$start);\r
-
print "<PRE>---SERVER DEBUG INFO (DECODED) ---\n\t".htmlentities(str_replace("\n", "\n\t", base64_decode($comments)))."\n---END---\n</PRE>";
\r- }\r
- }\r
-\r
- // be tolerant of extra whitespace in response body\r
- $data = trim($data);\r
-\r
- /// @todo return an error msg if $data=='' ?\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
- $pos = strrpos($data, '</methodResponse>');\r
- if($pos !== false)\r
- {\r
- $data = substr($data, 0, $pos+17);\r
- }\r
-\r
- // if user wants back raw xml, give it to him\r
- if ($return_type == 'xml')\r
- {\r
- $r = new xmlrpcresp($data, 0, '', 'xml');\r
- $r->hdrs = $xmlrpc->_xh['headers'];\r
- $r->_cookies = $xmlrpc->_xh['cookies'];\r
- $r->raw_data = $raw_data;\r
- return $r;\r
- }\r
-\r
- // try to 'guestimate' the character encoding of the received response\r
- $resp_encoding = guess_encoding(@$xmlrpc->_xh['headers']['content-type'], $data);\r
-\r
- $xmlrpc->_xh['ac']='';\r
- //$xmlrpc->_xh['qt']=''; //unused...\r
- $xmlrpc->_xh['stack'] = array();\r
- $xmlrpc->_xh['valuestack'] = array();\r
- $xmlrpc->_xh['isf']=0; // 0 = OK, 1 for xmlrpc fault responses, 2 = invalid xmlrpc\r
- $xmlrpc->_xh['isf_reason']='';\r
- $xmlrpc->_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
- // 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 = $xmlrpc->xmlrpc_defencoding;\r
- }\r
- $parser = xml_parser_create($resp_encoding);\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
- // What if internal encoding is not in one of the 3 allowed?\r
- // we use the broadest one, ie. utf8\r
- // This allows to send data which is native in various charset,\r
- // by extending xmlrpc_encode_entitites() and setting xmlrpc_internalencoding\r
- if (!in_array($xmlrpc->xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))\r
- {\r
- xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');\r
- }\r
- else\r
- {\r
- xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $xmlrpc->xmlrpc_internalencoding);\r
- }\r
-\r
- if ($return_type == 'phpvals')\r
- {\r
- xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast');\r
- }\r
- else\r
- {\r
- xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee');\r
- }\r
-\r
- xml_set_character_data_handler($parser, 'xmlrpc_cd');\r
- xml_set_default_handler($parser, 'xmlrpc_dh');\r
-\r
- // first error check: xml not well formed\r
- if(!xml_parse($parser, $data, count($data)))\r
- {\r
-
// thanks to Peter Kocks <peter.kocks@baygate.com>
\r- if((xml_get_current_line_number($parser)) == 1)\r
- {\r
- $errstr = 'XML error at line 1, check URL';\r
- }\r
- else\r
- {\r
- $errstr = sprintf('XML error: %s at line %d, column %d',\r
- xml_error_string(xml_get_error_code($parser)),\r
- xml_get_current_line_number($parser), xml_get_current_column_number($parser));\r
- }\r
- error_log($errstr);\r
- $r=new xmlrpcresp(0, $xmlrpc->xmlrpcerr['invalid_return'], $xmlrpc->xmlrpcstr['invalid_return'].' ('.$errstr.')');\r
- xml_parser_free($parser);\r
- if($this->debug)\r
- {\r
- print $errstr;\r
- }\r
- $r->hdrs = $xmlrpc->_xh['headers'];\r
- $r->_cookies = $xmlrpc->_xh['cookies'];\r
- $r->raw_data = $raw_data;\r
- return $r;\r
- }\r
- xml_parser_free($parser);\r
- // second error check: xml well formed but not xml-rpc compliant\r
- if ($xmlrpc->_xh['isf'] > 1)\r
- {\r
- if ($this->debug)\r
- {\r
- /// @todo echo something for user?\r
- }\r
-\r
- $r = new xmlrpcresp(0, $xmlrpc->xmlrpcerr['invalid_return'],\r
- $xmlrpc->xmlrpcstr['invalid_return'] . ' ' . $xmlrpc->_xh['isf_reason']);\r
- }\r
- // third error check: parsing of the response has somehow gone boink.\r
- // NB: shall we omit this check, since we trust the parsing code?\r
- elseif ($return_type == 'xmlrpcvals' && !is_object($xmlrpc->_xh['value']))\r
- {\r
- // something odd has happened\r
- // and it's time to generate a client side error\r
- // indicating something odd went on\r
- $r=new xmlrpcresp(0, $xmlrpc->xmlrpcerr['invalid_return'],\r
- $xmlrpc->xmlrpcstr['invalid_return']);\r
- }\r
- else\r
- {\r
- if ($this->debug)\r
- {\r
-
print "<PRE>---PARSED---\n";
\r- // somehow htmlentities chokes on var_export, and some full html string...\r
- //print htmlentitites(var_export($xmlrpc->_xh['value'], true));\r
- print htmlspecialchars(var_export($xmlrpc->_xh['value'], true));\r
- print "\n---END---</PRE>";\r
- }\r
-\r
- // note that using =& will raise an error if $xmlrpc->_xh['st'] does not generate an object.\r
- $v =& $xmlrpc->_xh['value'];\r
-\r
- if($xmlrpc->_xh['isf'])\r
- {\r
- /// @todo we should test here if server sent an int and a string,\r
- /// and/or coerce them into such...\r
- if ($return_type == 'xmlrpcvals')\r
- {\r
- $errno_v = $v->structmem('faultCode');\r
- $errstr_v = $v->structmem('faultString');\r
- $errno = $errno_v->scalarval();\r
- $errstr = $errstr_v->scalarval();\r
- }\r
- else\r
- {\r
- $errno = $v['faultCode'];\r
- $errstr = $v['faultString'];\r
- }\r
-\r
- if($errno == 0)\r
- {\r
- // FAULT returned, errno needs to reflect that\r
- $errno = -1;\r
- }\r
-\r
- $r = new xmlrpcresp(0, $errno, $errstr);\r
- }\r
- else\r
- {\r
- $r=new xmlrpcresp($v, 0, '', $return_type);\r
- }\r
- }\r
-\r
- $r->hdrs = $xmlrpc->_xh['headers'];\r
- $r->_cookies = $xmlrpc->_xh['cookies'];\r
- $r->raw_data = $raw_data;\r
- return $r;\r
- }\r
- }\r
-\r
- class xmlrpcval\r
- {\r
- var $me=array();\r
- var $mytype=0;\r
- var $_php_class=null;\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
- {\r
- /// @todo: optimization creep - do not call addXX, do it all inline.\r
- /// downside: booleans will not be coerced anymore\r
- if($val!==-1 || $type!='')\r
- {\r
- // optimization creep: inlined all work done by constructor\r
- switch($type)\r
- {\r
- case '':\r
- $this->mytype=1;\r
- $this->me['string']=$val;\r
- break;\r
- case 'i4':\r
- case 'int':\r
- case 'double':\r
- case 'string':\r
- case 'boolean':\r
- case 'dateTime.iso8601':\r
- case 'base64':\r
- case 'null':\r
- $this->mytype=1;\r
- $this->me[$type]=$val;\r
- break;\r
- case 'array':\r
- $this->mytype=2;\r
- $this->me['array']=$val;\r
- break;\r
- case 'struct':\r
- $this->mytype=3;\r
- $this->me['struct']=$val;\r
- break;\r
- default:\r
- error_log("XML-RPC: ".__METHOD__.": not a known type ($type)");\r
- }\r
- /*if($type=='')\r
- {\r
- $type='string';\r
- }\r
- if($GLOBALS['xmlrpcTypes'][$type]==1)\r
- {\r
- $this->addScalar($val,$type);\r
- }\r
- elseif($GLOBALS['xmlrpcTypes'][$type]==2)\r
- {\r
- $this->addArray($val);\r
- }\r
- elseif($GLOBALS['xmlrpcTypes'][$type]==3)\r
- {\r
- $this->addStruct($val);\r
- }*/\r
- }\r
- }\r
-\r
- /**\r
- * Add a single php value to an (unitialized) xmlrpcval\r
- * @param mixed $val\r
- * @param string $type\r
- * @return int 1 or 0 on failure\r
- */\r
- function addScalar($val, $type='string')\r
- {\r
- $xmlrpc = Xmlrpc::instance();\r
-\r
- $typeof = null;\r
- if(isset($xmlrpc->xmlrpcTypes[$type])) {\r
- $typeof = $xmlrpc->xmlrpcTypes[$type];\r
- }\r
-\r
- if($typeof!=1)\r
- {\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 either do it for datetimes, integers and doubles, too,\r
- // or just plain remove this check, implemented on booleans only...\r
- if($type==$xmlrpc->xmlrpcBoolean)\r
- {\r
- if(strcasecmp($val,'true')==0 || $val==1 || ($val==true && strcasecmp($val,'false')))\r
- {\r
- $val=true;\r
- }\r
- else\r
- {\r
- $val=false;\r
- }\r
- }\r
-\r
- switch($this->mytype)\r
- {\r
- case 1:\r
- error_log('XML-RPC: '.__METHOD__.': scalar xmlrpcval can have only one value');\r
- return 0;\r
- case 3:\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
- //$ar=$this->me['array'];\r
- //$ar[]=new xmlrpcval($val, $type);\r
- //$this->me['array']=$ar;\r
- // Faster (?) avoid all the costly array-copy-by-val done here...\r
- $this->me['array'][]=new xmlrpcval($val, $type);\r
- return 1;\r
- default:\r
- // a scalar, so set the value and remember we're scalar\r
- $this->me[$type]=$val;\r
- $this->mytype=$typeof;\r
- return 1;\r
- }\r
- }\r
-\r
- /**\r
- * Add an array of xmlrpcval objects to an xmlrpcval\r
- * @param array $vals\r
- * @return int 1 or 0 on failure\r
- * @access public\r
- *\r
- * @todo add some checking for $vals to be an array of xmlrpcvals?\r
- */\r
- function addArray($vals)\r
- {\r
- $xmlrpc = Xmlrpc::instance();\r
- if($this->mytype==0)\r
- {\r
- $this->mytype=$xmlrpc->xmlrpcTypes['array'];\r
- $this->me['array']=$vals;\r
- return 1;\r
- }\r
- elseif($this->mytype==2)\r
- {\r
- // we're adding to an array here\r
- $this->me['array'] = array_merge($this->me['array'], $vals);\r
- return 1;\r
- }\r
- else\r
- {\r
- error_log('XML-RPC: '.__METHOD__.': already initialized as a [' . $this->kindOf() . ']');\r
- return 0;\r
- }\r
- }\r
-\r
- /**\r
- * Add an array of named xmlrpcval objects to an xmlrpcval\r
- * @param array $vals\r
- * @return int 1 or 0 on failure\r
- * @access public\r
- *\r
- * @todo add some checking for $vals to be an array?\r
- */\r
- function addStruct($vals)\r
- {\r
- $xmlrpc = Xmlrpc::instance();\r
-\r
- if($this->mytype==0)\r
- {\r
- $this->mytype=$xmlrpc->xmlrpcTypes['struct'];\r
- $this->me['struct']=$vals;\r
- return 1;\r
- }\r
- elseif($this->mytype==3)\r
- {\r
- // we're adding to a struct here\r
- $this->me['struct'] = array_merge($this->me['struct'], $vals);\r
- return 1;\r
- }\r
- else\r
- {\r
- error_log('XML-RPC: '.__METHOD__.': already initialized as a [' . $this->kindOf() . ']');\r
- return 0;\r
- }\r
- }\r
-\r
- // poor man's version of print_r ???\r
- // DEPRECATED!\r
- function dump($ar)\r
- {\r
- foreach($ar as $key => $val)\r
- {\r
- echo "$key => $val<br />";\r
- if($key == 'array')\r
- {\r
- while(list($key2, $val2) = each($val))\r
- {\r
- echo "-- $key2 => $val2<br />";\r
- }\r
- }\r
- }\r
- }\r
-\r
- /**\r
- * Returns a string containing "struct", "array" or "scalar" describing the base type of the value\r
- * @return string\r
- * @access public\r
- */\r
- function kindOf()\r
- {\r
- switch($this->mytype)\r
- {\r
- case 3:\r
- return 'struct';\r
- break;\r
- case 2:\r
- return 'array';\r
- break;\r
- case 1:\r
- return 'scalar';\r
- break;\r
- default:\r
- return 'undef';\r
- }\r
- }\r
-\r
- /**\r
- * @access private\r
- */\r
- function serializedata($typ, $val, $charset_encoding='')\r
- {\r
- $xmlrpc = Xmlrpc::instance();\r
- $rs='';\r
-\r
- if(!isset($xmlrpc->xmlrpcTypes[$typ])) {\r
- return $rs;\r
- }\r
-\r
- switch($xmlrpc->xmlrpcTypes[$typ])\r
- {\r
- case 1:\r
- switch($typ)\r
- {\r
- case $xmlrpc->xmlrpcBase64:\r
- $rs.="<${typ}>" . base64_encode($val) . "</${typ}>";\r
- break;\r
- case $xmlrpc->xmlrpcBoolean:\r
- $rs.="<${typ}>" . ($val ? '1' : '0') . "</${typ}>";\r
- break;\r
- case $xmlrpc->xmlrpcString:\r
- // G. Giunta 2005/2/13: do NOT use htmlentities, since\r
- // it will produce named html entities, which are invalid xml\r
- $rs.="<${typ}>" . xmlrpc_encode_entitites($val, $xmlrpc->xmlrpc_internalencoding, $charset_encoding). "</${typ}>";\r
- break;\r
- case $xmlrpc->xmlrpcInt:\r
- case $xmlrpc->xmlrpcI4:\r
- $rs.="<${typ}>".(int)$val."</${typ}>";\r
- break;\r
- case $xmlrpc->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') 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 $xmlrpc->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 $xmlrpc->xmlrpcNull:\r
- if ($xmlrpc->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
- // for xmlrpcvals of unknown type...\r
- $rs.="<${typ}>${val}</${typ}>";\r
- }\r
- break;\r
- case 3:\r
- // struct\r
- if ($this->_php_class)\r
- {\r
- $rs.='<struct php_class="' . $this->_php_class . "\">\n";\r
- }\r
- else\r
- {\r
- $rs.="<struct>\n";\r
- }\r
- foreach($val as $key2 => $val2)\r
- {\r
- $rs.='<member><name>'.xmlrpc_encode_entitites($key2, $xmlrpc->xmlrpc_internalencoding, $charset_encoding)."</name>\n";\r
- //$rs.=$this->serializeval($val2);\r
- $rs.=$val2->serialize($charset_encoding);\r
- $rs.="</member>\n";\r
- }\r
- $rs.='</struct>';\r
- break;\r
- case 2:\r
- // array\r
-
$rs.="<array>\n<data>\n";
\r- for($i=0; $i<count($val); $i++)\r
- {\r
- //$rs.=$this->serializeval($val[$i]);\r
- $rs.=$val[$i]->serialize($charset_encoding);\r
- }\r
- $rs.="</data>\n</array>";\r
- break;\r
- default:\r
- break;\r
- }\r
- return $rs;\r
- }\r
-\r
- /**\r
- * Returns xml representation of the value. XML prologue not included\r
- * @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed\r
- * @return string\r
- * @access public\r
- */\r
- function serialize($charset_encoding='')\r
- {\r
- // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...\r
- //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))\r
- //{\r
- reset($this->me);\r
- list($typ, $val) = each($this->me);\r
- return '<value>' . $this->serializedata($typ, $val, $charset_encoding) . "</value>\n";\r
- //}\r
- }\r
-\r
- // DEPRECATED\r
- function serializeval($o)\r
- {\r
- // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...\r
- //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))\r
- //{\r
- $ar=$o->me;\r
- reset($ar);\r
- list($typ, $val) = each($ar);\r
- return '<value>' . $this->serializedata($typ, $val) . "</value>\n";\r
- //}\r
- }\r
-\r
- /**\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
- * @access public\r
- */\r
- function structmemexists($m)\r
- {\r
- return array_key_exists($m, $this->me['struct']);\r
- }\r
-\r
- /**\r
- * Returns the value of a given struct member (an xmlrpcval object in itself).\r
- * Will raise a php warning if struct member of given name does not exist\r
- * @param string $m the name of the struct member to be looked up\r
- * @return xmlrpcval\r
- * @access public\r
- */\r
- function structmem($m)\r
- {\r
- return $this->me['struct'][$m];\r
- }\r
-\r
- /**\r
- * Reset internal pointer for xmlrpcvals of type struct.\r
- * @access public\r
- */\r
- function structreset()\r
- {\r
- reset($this->me['struct']);\r
- }\r
-\r
- /**\r
- * Return next member element for xmlrpcvals of type struct.\r
- * @return xmlrpcval\r
- * @access public\r
- */\r
- function structeach()\r
- {\r
- return each($this->me['struct']);\r
- }\r
-\r
- // DEPRECATED! this code looks like it is very fragile and has not been fixed\r
- // for a long long time. Shall we remove it for 2.0?\r
- function getval()\r
- {\r
- // UNSTABLE\r
- reset($this->me);\r
- list($a,$b)=each($this->me);\r
- // contributed by I Sofer, 2001-03-24\r
- // add support for nested arrays to scalarval\r
- // i've created a new method here, so as to\r
- // preserve back compatibility\r
-\r
- if(is_array($b))\r
- {\r
- @reset($b);\r
- while(list($id,$cont) = @each($b))\r
- {\r
- $b[$id] = $cont->scalarval();\r
- }\r
- }\r
-\r
- // add support for structures directly encoding php objects\r
- if(is_object($b))\r
- {\r
- $t = get_object_vars($b);\r
- @reset($t);\r
- while(list($id,$cont) = @each($t))\r
- {\r
- $t[$id] = $cont->scalarval();\r
- }\r
- @reset($t);\r
- while(list($id,$cont) = @each($t))\r
- {\r
- @$b->$id = $cont;\r
- }\r
- }\r
- // end contrib\r
- return $b;\r
- }\r
-\r
- /**\r
- * Returns the value of a scalar xmlrpcval\r
- * @return mixed\r
- * @access public\r
- */\r
- function scalarval()\r
- {\r
- reset($this->me);\r
- list(,$b)=each($this->me);\r
- return $b;\r
- }\r
-\r
- /**\r
- * Returns the type of the xmlrpcval.\r
- * For integers, 'int' is always returned in place of 'i4'\r
- * @return string\r
- * @access public\r
- */\r
- function scalartyp()\r
- {\r
- $xmlrpc = Xmlrpc::instance();\r
-\r
- reset($this->me);\r
- list($a,)=each($this->me);\r
- if($a==$xmlrpc->xmlrpcI4)\r
- {\r
- $a=$xmlrpc->xmlrpcInt;\r
- }\r
- return $a;\r
- }\r
-\r
- /**\r
- * Returns the m-th member of an xmlrpcval of struct type\r
- * @param integer $m the index of the value to be retrieved (zero based)\r
- * @return xmlrpcval\r
- * @access public\r
- */\r
- function arraymem($m)\r
- {\r
- return $this->me['array'][$m];\r
- }\r
-\r
- /**\r
- * Returns the number of members in an xmlrpcval of array type\r
- * @return integer\r
- * @access public\r
- */\r
- function arraysize()\r
- {\r
- return count($this->me['array']);\r
- }\r
-\r
- /**\r
- * Returns the number of members in an xmlrpcval of struct type\r
- * @return integer\r
- * @access public\r
- */\r
- function structsize()\r
- {\r
- return count($this->me['struct']);\r
- }\r
- }\r
-\r
-\r
- // date helpers\r
-\r
- /**\r
- * Given a timestamp, return the corresponding ISO8601 encoded string.\r
- *\r
- * Really, timezones ought to be supported\r
- * but the XML-RPC spec says:\r
- *\r
- * "Don't assume a timezone. It should be specified by the server in its\r
- * documentation what assumptions it makes about timezones."\r
- *\r
- * These routines always assume localtime unless\r
- * $utc is set to 1, in which case UTC is assumed\r
- * and an adjustment for locale is made when encoding\r
- *\r
- * @param int $timet (timestamp)\r
- * @param int $utc (0 or 1)\r
- * @return string\r
- */\r
- function iso8601_encode($timet, $utc=0)\r
- {\r
- if(!$utc)\r
- {\r
- $t=strftime("%Y%m%dT%H:%M:%S", $timet);\r
- }\r
- else\r
- {\r
- if(function_exists('gmstrftime'))\r
- {\r
- // gmstrftime doesn't exist in some versions\r
- // of PHP\r
- $t=gmstrftime("%Y%m%dT%H:%M:%S", $timet);\r
- }\r
- else\r
- {\r
- $t=strftime("%Y%m%dT%H:%M:%S", $timet-date('Z'));\r
- }\r
- }\r
- return $t;\r
- }\r
-\r
- /**\r
- * Given an ISO8601 date string, return a timet in the localtime, or UTC\r
- * @param string $idate\r
- * @param int $utc either 0 or 1\r
- * @return int (datetime)\r
- */\r
- function iso8601_decode($idate, $utc=0)\r
- {\r
- $t=0;\r
- if(preg_match('/([0-9]{4})([0-9]{2})([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})/', $idate, $regs))\r
- {\r
- if($utc)\r
- {\r
- $t=gmmktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);\r
- }\r
- else\r
- {\r
- $t=mktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);\r
- }\r
- }\r
- return $t;\r
- }\r
-\r
- /**\r
- * Takes an xmlrpc value in PHP xmlrpcval object format and translates it into native PHP types.\r
- *\r
- * Works with xmlrpc message objects as input, too.\r
- *\r
- * Given proper options parameter, can rebuild generic php object instances\r
- * (provided those have been encoded to xmlrpc format using a corresponding\r
- * option in php_xmlrpc_encode())\r
- * PLEASE NOTE that rebuilding php objects involves calling their constructor function.\r
- * This means that the remote communication end can decide which php code will\r
- * get executed on your server, leaving the door possibly open to 'php-injection'\r
- * style of attacks (provided you have some classes defined on your server that\r
- * might wreak havoc if instances are built outside an appropriate context).\r
- * Make sure you trust the remote server/client before eanbling this!\r
- *\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; 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
- {\r
- switch($xmlrpc_val->kindOf())\r
- {\r
- case 'scalar':\r
- if (in_array('extension_api', $options))\r
- {\r
- reset($xmlrpc_val->me);\r
- list($typ,$val) = each($xmlrpc_val->me);\r
- switch ($typ)\r
- {\r
- case 'dateTime.iso8601':\r
- $xmlrpc_val->scalar = $val;\r
- $xmlrpc_val->xmlrpc_type = 'datetime';\r
- $xmlrpc_val->timestamp = iso8601_decode($val);\r
- return $xmlrpc_val;\r
- case 'base64':\r
- $xmlrpc_val->scalar = $val;\r
- $xmlrpc_val->type = $typ;\r
- return $xmlrpc_val;\r
- default:\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
- $arr = array();\r
- for($i = 0; $i < $size; $i++)\r
- {\r
- $arr[] = php_xmlrpc_decode($xmlrpc_val->arraymem($i), $options);\r
- }\r
- return $arr;\r
- case 'struct':\r
- $xmlrpc_val->structreset();\r
- // If user said so, try to rebuild php objects for specific struct vals.\r
- /// @todo should we raise a warning for class not found?\r
- // shall we check for proper subclass of xmlrpcval instead of\r
- // presence of _php_class to detect what we can do?\r
- if (in_array('decode_php_objs', $options) && $xmlrpc_val->_php_class != ''\r
- && class_exists($xmlrpc_val->_php_class))\r
- {\r
- $obj = @new $xmlrpc_val->_php_class;\r
- while(list($key,$value)=$xmlrpc_val->structeach())\r
- {\r
- $obj->$key = php_xmlrpc_decode($value, $options);\r
- }\r
- return $obj;\r
- }\r
- else\r
- {\r
- $arr = array();\r
- while(list($key,$value)=$xmlrpc_val->structeach())\r
- {\r
- $arr[$key] = php_xmlrpc_decode($value, $options);\r
- }\r
- return $arr;\r
- }\r
- case 'msg':\r
- $paramcount = $xmlrpc_val->getNumParams();\r
- $arr = array();\r
- for($i = 0; $i < $paramcount; $i++)\r
- {\r
- $arr[] = php_xmlrpc_decode($xmlrpc_val->getParam($i));\r
- }\r
- return $arr;\r
- }\r
- }\r
-\r
- // This constant left here only for historical reasons...\r
- // it was used to decide if we have to define xmlrpc_encode on our own, but\r
- // we do not do it anymore\r
- if(function_exists('xmlrpc_decode'))\r
- {\r
- define('XMLRPC_EPI_ENABLED','1');\r
- }\r
- else\r
- {\r
- define('XMLRPC_EPI_ENABLED','0');\r
- }\r
-\r
- /**\r
- * Takes native php types and encodes them into xmlrpc PHP object format.\r
- * It will not re-encode xmlrpcval objects.\r
- *\r
- * Feature creep -- could support more types via optional type argument\r
- * (string => datetime support has been added, ??? => base64 not yet)\r
- *\r
- * If given a proper options parameter, php object instances will be encoded\r
- * into 'special' xmlrpc values, that can later be decoded into php objects\r
- * by calling php_xmlrpc_decode() with a corresponding option\r
- *\r
- * @author Dan Libby (dan@libby.com)\r
- *\r
- * @param mixed $php_val the value to be converted into an xmlrpcval object\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
- {\r
- $xmlrpc = Xmlrpc::instance();\r
- $type = gettype($php_val);\r
- switch($type)\r
- {\r
- case 'string':\r
- if (in_array('auto_dates', $options) && preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $php_val))\r
- $xmlrpc_val = new xmlrpcval($php_val, $xmlrpc->xmlrpcDateTime);\r
- else\r
- $xmlrpc_val = new xmlrpcval($php_val, $xmlrpc->xmlrpcString);\r
- break;\r
- case 'integer':\r
- $xmlrpc_val = new xmlrpcval($php_val, $xmlrpc->xmlrpcInt);\r
- break;\r
- case 'double':\r
- $xmlrpc_val = new xmlrpcval($php_val, $xmlrpc->xmlrpcDouble);\r
- break;\r
- // <G_Giunta_2001-02-29>\r
- // Add support for encoding/decoding of booleans, since they are supported in PHP\r
- case 'boolean':\r
- $xmlrpc_val = new xmlrpcval($php_val, $xmlrpc->xmlrpcBoolean);\r
- break;\r
- // </G_Giunta_2001-02-29>\r
- case 'array':\r
- // PHP arrays can be encoded to either xmlrpc structs or arrays,\r
- // depending on wheter they are hashes or plain 0..n integer indexed\r
- // A shorter one-liner would be\r
- // $tmp = array_diff(array_keys($php_val), range(0, count($php_val)-1));\r
- // but execution time skyrockets!\r
- $j = 0;\r
- $arr = array();\r
- $ko = false;\r
- foreach($php_val as $key => $val)\r
- {\r
- $arr[$key] = php_xmlrpc_encode($val, $options);\r
- if(!$ko && $key !== $j)\r
- {\r
- $ko = true;\r
- }\r
- $j++;\r
- }\r
- if($ko)\r
- {\r
- $xmlrpc_val = new xmlrpcval($arr, $xmlrpc->xmlrpcStruct);\r
- }\r
- else\r
- {\r
- $xmlrpc_val = new xmlrpcval($arr, $xmlrpc->xmlrpcArray);\r
- }\r
- break;\r
- case 'object':\r
- if(is_a($php_val, 'xmlrpcval'))\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'), $xmlrpc->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($arr, $xmlrpc->xmlrpcStruct);\r
- if (in_array('encode_php_objs', $options))\r
- {\r
- // let's save original class name into xmlrpcval:\r
- // might be useful later on...\r
- $xmlrpc_val->_php_class = get_class($php_val);\r
- }\r
- }\r
- break;\r
- case 'NULL':\r
- if (in_array('extension_api', $options))\r
- {\r
- $xmlrpc_val = new xmlrpcval('', $xmlrpc->xmlrpcString);\r
- }\r
- else if (in_array('null_extension', $options))\r
- {\r
- $xmlrpc_val = new xmlrpcval('', $xmlrpc->xmlrpcNull);\r
- }\r
- else\r
- {\r
- $xmlrpc_val = new xmlrpcval();\r
- }\r
- break;\r
- case 'resource':\r
- if (in_array('extension_api', $options))\r
- {\r
- $xmlrpc_val = new xmlrpcval((int)$php_val, $xmlrpc->xmlrpcInt);\r
- }\r
- else\r
- {\r
- $xmlrpc_val = new xmlrpcval();\r
- }\r
- // catch "user function", "unknown type"\r
- default:\r
-
// giancarlo pinerolo <ping@alt.it>
\r- // it has to return\r
- // an empty object in case, not a boolean.\r
- $xmlrpc_val = new xmlrpcval();\r
- break;\r
- }\r
- return $xmlrpc_val;\r
- }\r
-\r
- /**\r
- * Convert the xml representation of a method response, method request or single\r
- * xmlrpc value into the appropriate object (a.k.a. deserialize)\r
- * @param string $xml_val\r
- * @param array $options\r
- * @return mixed false on error, or an instance of either xmlrpcval, xmlrpcmsg or xmlrpcresp\r
- */\r
- function php_xmlrpc_decode_xml($xml_val, $options=array())\r
- {\r
- $xmlrpc = Xmlrpc::instance();\r
-\r
- $xmlrpc->_xh = array();\r
- $xmlrpc->_xh['ac'] = '';\r
- $xmlrpc->_xh['stack'] = array();\r
- $xmlrpc->_xh['valuestack'] = array();\r
- $xmlrpc->_xh['params'] = array();\r
- $xmlrpc->_xh['pt'] = array();\r
- $xmlrpc->_xh['isf'] = 0;\r
- $xmlrpc->_xh['isf_reason'] = '';\r
- $xmlrpc->_xh['method'] = false;\r
- $xmlrpc->_xh['rt'] = '';\r
- /// @todo 'guestimate' encoding\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 use the broadest one, ie. utf8!\r
- if (!in_array($xmlrpc->xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))\r
- {\r
- xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');\r
- }\r
- else\r
- {\r
- xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $xmlrpc->xmlrpc_internalencoding);\r
- }\r
- xml_set_element_handler($parser, 'xmlrpc_se_any', 'xmlrpc_ee');\r
- xml_set_character_data_handler($parser, 'xmlrpc_cd');\r
- xml_set_default_handler($parser, 'xmlrpc_dh');\r
- if(!xml_parse($parser, $xml_val, 1))\r
- {\r
- $errstr = sprintf('XML error: %s at line %d, column %d',\r
- xml_error_string(xml_get_error_code($parser)),\r
- xml_get_current_line_number($parser), xml_get_current_column_number($parser));\r
- error_log($errstr);\r
- xml_parser_free($parser);\r
- return false;\r
- }\r
- xml_parser_free($parser);\r
- if ($xmlrpc->_xh['isf'] > 1) // test that $xmlrpc->_xh['value'] is an obj, too???\r
- {\r
- error_log($xmlrpc->_xh['isf_reason']);\r
- return false;\r
- }\r
- switch ($xmlrpc->_xh['rt'])\r
- {\r
- case 'methodresponse':\r
- $v =& $xmlrpc->_xh['value'];\r
- if ($xmlrpc->_xh['isf'] == 1)\r
- {\r
- $vc = $v->structmem('faultCode');\r
- $vs = $v->structmem('faultString');\r
- $r = new xmlrpcresp(0, $vc->scalarval(), $vs->scalarval());\r
- }\r
- else\r
- {\r
- $r = new xmlrpcresp($v);\r
- }\r
- return $r;\r
- case 'methodcall':\r
- $m = new xmlrpcmsg($xmlrpc->_xh['method']);\r
- for($i=0; $i < count($xmlrpc->_xh['params']); $i++)\r
- {\r
- $m->addParam($xmlrpc->_xh['params'][$i]);\r
- }\r
- return $m;\r
- case 'value':\r
- return $xmlrpc->_xh['value'];\r
- default:\r
- return false;\r
- }\r
- }\r
-\r
- /**\r
- * decode a string that is encoded w/ "chunked" transfer encoding\r
- * as defined in rfc2068 par. 19.4.6\r
- * code shamelessly stolen from nusoap library by Dietrich Ayala\r
- *\r
- * @param string $buffer the string to be decoded\r
- * @return string\r
- */\r
- function decode_chunked($buffer)\r
- {\r
- // length := 0\r
- $length = 0;\r
- $new = '';\r
-\r
- // read chunk-size, chunk-extension (if any) and crlf\r
- // get the position of the linebreak\r
- $chunkend = strpos($buffer,"\r\n") + 2;\r
- $temp = substr($buffer,0,$chunkend);\r
- $chunk_size = hexdec( trim($temp) );\r
- $chunkstart = $chunkend;\r
- while($chunk_size > 0)\r
- {\r
- $chunkend = strpos($buffer, "\r\n", $chunkstart + $chunk_size);\r
-\r
- // just in case we got a broken connection\r
- if($chunkend == false)\r
- {\r
- $chunk = substr($buffer,$chunkstart);\r
- // append chunk-data to entity-body\r
- $new .= $chunk;\r
- $length += strlen($chunk);\r
- break;\r
- }\r
-\r
- // read chunk-data and crlf\r
- $chunk = substr($buffer,$chunkstart,$chunkend-$chunkstart);\r
- // append chunk-data to entity-body\r
- $new .= $chunk;\r
- // length := length + chunk-size\r
- $length += strlen($chunk);\r
- // read chunk-size and crlf\r
- $chunkstart = $chunkend + 2;\r
-\r
- $chunkend = strpos($buffer,"\r\n",$chunkstart)+2;\r
- if($chunkend == false)\r
- {\r
- break; //just in case we got a broken connection\r
- }\r
- $temp = substr($buffer,$chunkstart,$chunkend-$chunkstart);\r
- $chunk_size = hexdec( trim($temp) );\r
- $chunkstart = $chunkend;\r
- }\r
- return $new;\r
- }\r
-\r
- /**\r
- * xml charset encoding guessing helper function.\r
- * Tries to determine the charset encoding of an XML chunk received over HTTP.\r
- * NB: according to the spec (RFC 3023), if text/xml content-type is received over HTTP without a content-type,\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 $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
- function guess_encoding($httpheader='', $xmlchunk='', $encoding_prefs=null)\r
- {\r
- $xmlrpc = Xmlrpc::instance();\r
-\r
- // discussion: see http://www.yale.edu/pclt/encoding/\r
- // 1 - test if encoding is specified in HTTP HEADERS\r
-\r
- //Details:\r
- // LWS: (\13\10)?( |\t)+\r
- // token: (any char but excluded stuff)+\r
- // quoted string: " (any char but double quotes and cointrol chars)* "\r
- // header: Content-type = ...; charset=value(; ...)*\r
- // where value is of type token, no LWS allowed between 'charset' and value\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
-\r
- /// @todo this test will pass if ANY header has charset specification, not only Content-Type. Fix it?\r
- $matches = array();\r
- if(preg_match('/;\s*charset\s*=([^;]+)/i', $httpheader, $matches))\r
- {\r
- return strtoupper(trim($matches[1], " \t\""));\r
- }\r
-\r
- // 2 - 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
- // NOTE: actually, according to the spec, even if we find the BOM and determine\r
- // an encoding, we should check if there is an encoding specified\r
- // in the xml declaration, and verify if they match.\r
- /// @todo implement check as described above?\r
- /// @todo implement check for first bytes of string even without a BOM? (It sure looks harder than for cases WITH a BOM)\r
- if(preg_match('/^(\x00\x00\xFE\xFF|\xFF\xFE\x00\x00|\x00\x00\xFF\xFE|\xFE\xFF\x00\x00)/', $xmlchunk))\r
- {\r
- return 'UCS-4';\r
- }\r
- elseif(preg_match('/^(\xFE\xFF|\xFF\xFE)/', $xmlchunk))\r
- {\r
- return 'UTF-16';\r
- }\r
- elseif(preg_match('/^(\xEF\xBB\xBF)/', $xmlchunk))\r
- {\r
- return 'UTF-8';\r
- }\r
-\r
- // 3 - 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 strtoupper(substr($matches[2], 1, -1));\r
- }\r
-\r
- // 4 - if mbstring is available, let it do the guesswork\r
- // NB: we favour finding an encoding that is compatible with what we can process\r
- if(extension_loaded('mbstring'))\r
- {\r
- if($encoding_prefs)\r
- {\r
- $enc = mb_detect_encoding($xmlchunk, $encoding_prefs);\r
- }\r
- else\r
- {\r
- $enc = mb_detect_encoding($xmlchunk);\r
- }\r
- // NB: mb_detect likes to call it ascii, xml parser likes to call it US_ASCII...\r
- // IANA also likes better US-ASCII, so go with it\r
- if($enc == 'ASCII')\r
- {\r
- $enc = 'US-'.$enc;\r
- }\r
- return $enc;\r
- }\r
- else\r
- {\r
- // no encoding specified: as per HTTP1.1 assume it is iso-8859-1?\r
- // Both RFC 2616 (HTTP 1.1) and 1945 (HTTP 1.0) clearly state that for text/xxx content types\r
- // this should be the standard. And we should be getting text/xml as request and response.\r
- // BUT we have to be backward compatible with the lib, which always used UTF-8 as default...\r
- return $xmlrpc->xmlrpc_defencoding;\r
- }\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
- $charset_supersets = array(\r
- 'US-ASCII' => array ('ISO-8859-1', 'ISO-8859-2', 'ISO-8859-3', 'ISO-8859-4',\r
- 'ISO-8859-5', 'ISO-8859-6', 'ISO-8859-7', 'ISO-8859-8',\r
- 'ISO-8859-9', 'ISO-8859-10', 'ISO-8859-11', 'ISO-8859-12',\r
- 'ISO-8859-13', 'ISO-8859-14', 'ISO-8859-15', 'UTF-8',\r
- 'EUC-JP', 'EUC-', 'EUC-KR', 'EUC-CN')\r
- );\r
- if (is_string($validlist))\r
- $validlist = explode(',', $validlist);\r
- if (@in_array(strtoupper($encoding), $validlist))\r
- return true;\r
- else\r
- {\r
- if (array_key_exists($encoding, $charset_supersets))\r
- foreach ($validlist as $allowed)\r
- if (in_array($allowed, $charset_supersets[$encoding]))\r
- return true;\r
- return false;\r
- }\r
- }\r
+ }\r
+ else\r
+ {\r
+ if(!is_object($this->val) || !is_a($this->val, 'xmlrpcval'))\r
+ {\r
+ if (is_string($this->val) && $this->valtyp == 'xml')\r
+ {\r
+ $result .= "<params>\n<param>\n" .\r
+ $this->val .\r
+ "</param>\n</params>";\r
+ }\r
+ else\r
+ {\r
+ /// @todo try to build something serializable?\r
+ die('cannot serialize xmlrpcresp objects whose content is native php values');\r
+ }\r
+ }\r
+ else\r
+ {\r
+ $result .= "<params>\n<param>\n" .\r
+ $this->val->serialize($charset_encoding) .\r
+ "</param>\n</params>";\r
+ }\r
+ }\r
+ $result .= "\n</methodResponse>";\r
+ $this->payload = $result;\r
+ return $result;\r
+ }\r
+}\r
+\r
+class xmlrpcmsg\r
+{\r
+ var $payload;\r
+ var $methodname;\r
+ var $params=array();\r
+ var $debug=0;\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 passed to the method (xmlrpcval objects)\r
+ */\r
+ function xmlrpcmsg($meth, $pars=0)\r
+ {\r
+ $this->methodname=$meth;\r
+ if(is_array($pars) && count($pars)>0)\r
+ {\r
+ for($i=0; $i<count($pars); $i++)\r
+ {\r
+ $this->addParam($pars[$i]);\r
+ }\r
+ }\r
+ }\r
+\r
+ /**\r
+ * @access private\r
+ */\r
+ function xml_header($charset_encoding='')\r
+ {\r
+ if ($charset_encoding != '')\r
+ {\r
+ return "<?xml version=\"1.0\" encoding=\"$charset_encoding\" ?" . ">\n<methodCall>\n";\r
+ }\r
+ else\r
+ {\r
+ return "<?xml version=\"1.0\"?" . ">\n<methodCall>\n";\r
+ }\r
+ }\r
+\r
+ /**\r
+ * @access private\r
+ */\r
+ function xml_footer()\r
+ {\r
+ return '</methodCall>';\r
+ }\r
+\r
+ /**\r
+ * @access private\r
+ */\r
+ function kindOf()\r
+ {\r
+ return 'msg';\r
+ }\r
+\r
+ /**\r
+ * @access private\r
+ */\r
+ function createPayload($charset_encoding='')\r
+ {\r
+ if ($charset_encoding != '')\r
+ $this->content_type = 'text/xml; charset=' . $charset_encoding;\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.="<params>\n";\r
+ for($i=0; $i<count($this->params); $i++)\r
+ {\r
+ $p=$this->params[$i];\r
+ $this->payload.="<param>\n" . $p->serialize($charset_encoding) .\r
+ "</param>\n";\r
+ }\r
+ $this->payload.="</params>\n";\r
+ $this->payload.=$this->xml_footer();\r
+ }\r
+\r
+ /**\r
+ * Gets/sets the xmlrpc method to be invoked\r
+ * @param string $meth the method to be set (leave empty not to set it)\r
+ * @return string the method that will be invoked\r
+ * @access public\r
+ */\r
+ function method($meth='')\r
+ {\r
+ if($meth!='')\r
+ {\r
+ $this->methodname=$meth;\r
+ }\r
+ return $this->methodname;\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
+ function serialize($charset_encoding='')\r
+ {\r
+ $this->createPayload($charset_encoding);\r
+ return $this->payload;\r
+ }\r
+\r
+ /**\r
+ * Add a parameter to the list of parameters to be used upon method invocation\r
+ * @param xmlrpcval $par\r
+ * @return boolean false on failure\r
+ * @access public\r
+ */\r
+ function addParam($par)\r
+ {\r
+ // add check: do not add to self params which are not xmlrpcvals\r
+ if(is_object($par) && is_a($par, 'xmlrpcval'))\r
+ {\r
+ $this->params[]=$par;\r
+ return true;\r
+ }\r
+ else\r
+ {\r
+ return false;\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Returns the nth parameter in the message. The index zero-based.\r
+ * @param integer $i the index of the parameter to fetch (zero based)\r
+ * @return xmlrpcval the i-th parameter\r
+ * @access public\r
+ */\r
+ function getParam($i) { return $this->params[$i]; }\r
+\r
+ /**\r
+ * Returns the number of parameters in the messge.\r
+ * @return integer the number of parameters currently set\r
+ * @access public\r
+ */\r
+ function getNumParams() { return count($this->params); }\r
+\r
+ /**\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
+ * 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
+ * @access public\r
+ * @param resource $fp stream pointer\r
+ * @return xmlrpcresp\r
+ * @todo add 2nd & 3rd param to be passed to ParseResponse() ???\r
+ */\r
+ function &parseResponseFile($fp)\r
+ {\r
+ $ipd='';\r
+ while($data=fread($fp, 32768))\r
+ {\r
+ $ipd.=$data;\r
+ }\r
+ //fclose($fp);\r
+ $r =& $this->parseResponse($ipd);\r
+ return $r;\r
+ }\r
+\r
+ /**\r
+ * Parses HTTP headers and separates them from data.\r
+ * @access private\r
+ */\r
+ function &parseResponseHeaders(&$data, $headers_processed=false)\r
+ {\r
+ $xmlrpc = Xmlrpc::instance();\r
+ // Support "web-proxy-tunelling" connections for https through proxies\r
+ if(preg_match('/^HTTP\/1\.[0-1] 200 Connection established/', $data))\r
+ {\r
+ // Look for CR/LF or simple LF as line separator,\r
+ // (even though it is not valid http)\r
+ $pos = strpos($data,"\r\n\r\n");\r
+ if($pos || is_int($pos))\r
+ {\r
+ $bd = $pos+4;\r
+ }\r
+ else\r
+ {\r
+ $pos = strpos($data,"\n\n");\r
+ if($pos || is_int($pos))\r
+ {\r
+ $bd = $pos+2;\r
+ }\r
+ else\r
+ {\r
+ // No separation between response headers and body: fault?\r
+ $bd = 0;\r
+ }\r
+ }\r
+ if ($bd)\r
+ {\r
+ // this filters out all http headers from proxy.\r
+ // maybe we could take them into account, too?\r
+ $data = substr($data, $bd);\r
+ }\r
+ else\r
+ {\r
+ error_log('XML-RPC: '.__METHOD__.': HTTPS via proxy error, tunnel connection possibly failed');\r
+ $r=new xmlrpcresp(0, $xmlrpc->xmlrpcerr['http_error'], $xmlrpc->xmlrpcstr['http_error']. ' (HTTPS via proxy error, tunnel connection possibly failed)');\r
+ return $r;\r
+ }\r
+ }\r
+\r
+ // Strip HTTP 1.1 100 Continue header if present\r
+ while(preg_match('/^HTTP\/1\.1 1[0-9]{2} /', $data))\r
+ {\r
+ $pos = strpos($data, 'HTTP', 12);\r
+ // server sent a Continue header without any (valid) content following...\r
+ // give the client a chance to know it\r
+ if(!$pos && !is_int($pos)) // works fine in php 3, 4 and 5\r
+ {\r
+ break;\r
+ }\r
+ $data = substr($data, $pos);\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: '.__METHOD__.': HTTP error, got response: ' .$errstr);\r
+ $r=new xmlrpcresp(0, $xmlrpc->xmlrpcerr['http_error'], $xmlrpc->xmlrpcstr['http_error']. ' (' . $errstr . ')');\r
+ return $r;\r
+ }\r
+\r
+ $xmlrpc->_xh['headers'] = array();\r
+ $xmlrpc->_xh['cookies'] = array();\r
+\r
+ // be tolerant to usage of \n instead of \r\n to separate headers and data\r
+ // (even though it is not valid http)\r
+ $pos = strpos($data,"\r\n\r\n");\r
+ if($pos || is_int($pos))\r
+ {\r
+ $bd = $pos+4;\r
+ }\r
+ else\r
+ {\r
+ $pos = strpos($data,"\n\n");\r
+ if($pos || is_int($pos))\r
+ {\r
+ $bd = $pos+2;\r
+ }\r
+ else\r
+ {\r
+ // No separation between response headers and body: fault?\r
+ // we could take some action here instead of going on...\r
+ $bd = 0;\r
+ }\r
+ }\r
+ // be tolerant to line endings, and extra empty lines\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
+ $arr = explode(':',$line,2);\r
+ if(count($arr) > 1)\r
+ {\r
+ $header_name = strtolower(trim($arr[0]));\r
+ /// @todo some other headers (the ones that allow a CSV list of values)\r
+ /// do allow many values to be passed using multiple header lines.\r
+ /// We should add content to $xmlrpc->_xh['headers'][$header_name]\r
+ /// instead of replacing it for those...\r
+ if ($header_name == 'set-cookie' || $header_name == 'set-cookie2')\r
+ {\r
+ if ($header_name == 'set-cookie2')\r
+ {\r
+ // version 2 cookies:\r
+ // there could be many cookies on one line, comma separated\r
+ $cookies = explode(',', $arr[1]);\r
+ }\r
+ else\r
+ {\r
+ $cookies = array($arr[1]);\r
+ }\r
+ foreach ($cookies as $cookie)\r
+ {\r
+ // glue together all received cookies, using a comma to separate them\r
+ // (same as php does with getallheaders())\r
+ if (isset($xmlrpc->_xh['headers'][$header_name]))\r
+ $xmlrpc->_xh['headers'][$header_name] .= ', ' . trim($cookie);\r
+ else\r
+ $xmlrpc->_xh['headers'][$header_name] = trim($cookie);\r
+ // parse cookie attributes, in case user wants to correctly honour them\r
+ // feature creep: only allow rfc-compliant cookie attributes?\r
+ // @todo support for server sending multiple time cookie with same name, but using different PATHs\r
+ $cookie = explode(';', $cookie);\r
+ foreach ($cookie as $pos => $val)\r
+ {\r
+ $val = explode('=', $val, 2);\r
+ $tag = trim($val[0]);\r
+ $val = trim(@$val[1]);\r
+ /// @todo with version 1 cookies, we should strip leading and trailing " chars\r
+ if ($pos == 0)\r
+ {\r
+ $cookiename = $tag;\r
+ $xmlrpc->_xh['cookies'][$tag] = array();\r
+ $xmlrpc->_xh['cookies'][$cookiename]['value'] = urldecode($val);\r
+ }\r
+ else\r
+ {\r
+ if ($tag != 'value')\r
+ {\r
+ $xmlrpc->_xh['cookies'][$cookiename][$tag] = $val;\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+ else\r
+ {\r
+ $xmlrpc->_xh['headers'][$header_name] = trim($arr[1]);\r
+ }\r
+ }\r
+ elseif(isset($header_name))\r
+ {\r
+ /// @todo version1 cookies might span multiple lines, thus breaking the parsing above\r
+ $xmlrpc->_xh['headers'][$header_name] .= ' ' . trim($line);\r
+ }\r
+ }\r
+\r
+ $data = substr($data, $bd);\r
+\r
+ if($this->debug && count($xmlrpc->_xh['headers']))\r
+ {\r
+ print '<PRE>';\r
+ foreach($xmlrpc->_xh['headers'] as $header => $value)\r
+ {\r
+ print htmlentities("HEADER: $header: $value\n");\r
+ }\r
+ foreach($xmlrpc->_xh['cookies'] as $header => $value)\r
+ {\r
+ print htmlentities("COOKIE: $header={$value['value']}\n");\r
+ }\r
+ print "</PRE>\n";\r
+ }\r
+\r
+ // if CURL was used for the call, http headers have been processed,\r
+ // and dechunking + reinflating have been carried out\r
+ if(!$headers_processed)\r
+ {\r
+ // Decode chunked encoding sent by http 1.1 servers\r
+ if(isset($xmlrpc->_xh['headers']['transfer-encoding']) && $xmlrpc->_xh['headers']['transfer-encoding'] == 'chunked')\r
+ {\r
+ if(!$data = decode_chunked($data))\r
+ {\r
+ error_log('XML-RPC: '.__METHOD__.': errors occurred when trying to rebuild the chunked data received from server');\r
+ $r = new xmlrpcresp(0, $xmlrpc->xmlrpcerr['dechunk_fail'], $xmlrpc->xmlrpcstr['dechunk_fail']);\r
+ return $r;\r
+ }\r
+ }\r
+\r
+ // Decode gzip-compressed stuff\r
+ // code shamelessly inspired from nusoap library by Dietrich Ayala\r
+ if(isset($xmlrpc->_xh['headers']['content-encoding']))\r
+ {\r
+ $xmlrpc->_xh['headers']['content-encoding'] = str_replace('x-', '', $xmlrpc->_xh['headers']['content-encoding']);\r
+ if($xmlrpc->_xh['headers']['content-encoding'] == 'deflate' || $xmlrpc->_xh['headers']['content-encoding'] == 'gzip')\r
+ {\r
+ // if decoding works, use it. else assume data wasn't gzencoded\r
+ if(function_exists('gzinflate'))\r
+ {\r
+ if($xmlrpc->_xh['headers']['content-encoding'] == 'deflate' && $degzdata = @gzuncompress($data))\r
+ {\r
+ $data = $degzdata;\r
+ if($this->debug)\r
+ print "<PRE>---INFLATED RESPONSE---[".strlen($data)." chars]---\n" . htmlentities($data) . "\n---END---</PRE>";\r
+ }\r
+ elseif($xmlrpc->_xh['headers']['content-encoding'] == 'gzip' && $degzdata = @gzinflate(substr($data, 10)))\r
+ {\r
+ $data = $degzdata;\r
+ if($this->debug)\r
+ print "<PRE>---INFLATED RESPONSE---[".strlen($data)." chars]---\n" . htmlentities($data) . "\n---END---</PRE>";\r
+ }\r
+ else\r
+ {\r
+ error_log('XML-RPC: '.__METHOD__.': errors occurred when trying to decode the deflated data received from server');\r
+ $r = new xmlrpcresp(0, $xmlrpc->xmlrpcerr['decompress_fail'], $xmlrpc->xmlrpcstr['decompress_fail']);\r
+ return $r;\r
+ }\r
+ }\r
+ else\r
+ {\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, $xmlrpc->xmlrpcerr['cannot_decompress'], $xmlrpc->xmlrpcstr['cannot_decompress']);\r
+ return $r;\r
+ }\r
+ }\r
+ }\r
+ } // end of 'if needed, de-chunk, re-inflate response'\r
+\r
+ // real stupid hack to avoid PHP complaining about returning NULL by ref\r
+ $r = null;\r
+ $r =& $r;\r
+ return $r;\r
+ }\r
+\r
+ /**\r
+ * Parse the xmlrpc response contained in the string $data and return an xmlrpcresp object.\r
+ * @param string $data the xmlrpc response, eventually including http headers\r
+ * @param bool $headers_processed when true prevents parsing HTTP headers for interpretation of content-encoding and consequent decoding\r
+ * @param string $return_type decides return type, i.e. content of response->value(). Either 'xmlrpcvals', 'xml' or 'phpvals'\r
+ * @return xmlrpcresp\r
+ * @access public\r
+ */\r
+ function &parseResponse($data='', $headers_processed=false, $return_type='xmlrpcvals')\r
+ {\r
+ $xmlrpc = Xmlrpc::instance();\r
+\r
+ if($this->debug)\r
+ {\r
+ //by maHo, replaced htmlspecialchars with htmlentities\r
+ print "<PRE>---GOT---\n" . htmlentities($data) . "\n---END---\n</PRE>";\r
+ }\r
+\r
+ if($data == '')\r
+ {\r
+ error_log('XML-RPC: '.__METHOD__.': no response received from server.');\r
+ $r = new xmlrpcresp(0, $xmlrpc->xmlrpcerr['no_data'], $xmlrpc->xmlrpcstr['no_data']);\r
+ return $r;\r
+ }\r
+\r
+ $xmlrpc->_xh=array();\r
+\r
+ $raw_data = $data;\r
+ // parse the HTTP headers of the response, if present, and separate them from data\r
+ if(substr($data, 0, 4) == 'HTTP')\r
+ {\r
+ $r =& $this->parseResponseHeaders($data, $headers_processed);\r
+ if ($r)\r
+ {\r
+ // failed processing of HTTP response headers\r
+ // save into response obj the full payload received, for debugging\r
+ $r->raw_data = $data;\r
+ return $r;\r
+ }\r
+ }\r
+ else\r
+ {\r
+ $xmlrpc->_xh['headers'] = array();\r
+ $xmlrpc->_xh['cookies'] = array();\r
+ }\r
+\r
+ if($this->debug)\r
+ {\r
+ $start = strpos($data, '<!-- SERVER DEBUG INFO (BASE64 ENCODED):');\r
+ if ($start)\r
+ {\r
+ $start += strlen('<!-- SERVER DEBUG INFO (BASE64 ENCODED):');\r
+ $end = strpos($data, '-->', $start);\r
+ $comments = substr($data, $start, $end-$start);\r
+ print "<PRE>---SERVER DEBUG INFO (DECODED) ---\n\t".htmlentities(str_replace("\n", "\n\t", base64_decode($comments)))."\n---END---\n</PRE>";\r
+ }\r
+ }\r
+\r
+ // be tolerant of extra whitespace in response body\r
+ $data = trim($data);\r
+\r
+ /// @todo return an error msg if $data=='' ?\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
+ $pos = strrpos($data, '</methodResponse>');\r
+ if($pos !== false)\r
+ {\r
+ $data = substr($data, 0, $pos+17);\r
+ }\r
+\r
+ // if user wants back raw xml, give it to him\r
+ if ($return_type == 'xml')\r
+ {\r
+ $r = new xmlrpcresp($data, 0, '', 'xml');\r
+ $r->hdrs = $xmlrpc->_xh['headers'];\r
+ $r->_cookies = $xmlrpc->_xh['cookies'];\r
+ $r->raw_data = $raw_data;\r
+ return $r;\r
+ }\r
+\r
+ // try to 'guestimate' the character encoding of the received response\r
+ $resp_encoding = guess_encoding(@$xmlrpc->_xh['headers']['content-type'], $data);\r
+\r
+ $xmlrpc->_xh['ac']='';\r
+ //$xmlrpc->_xh['qt']=''; //unused...\r
+ $xmlrpc->_xh['stack'] = array();\r
+ $xmlrpc->_xh['valuestack'] = array();\r
+ $xmlrpc->_xh['isf']=0; // 0 = OK, 1 for xmlrpc fault responses, 2 = invalid xmlrpc\r
+ $xmlrpc->_xh['isf_reason']='';\r
+ $xmlrpc->_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
+ // 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 = $xmlrpc->xmlrpc_defencoding;\r
+ }\r
+ $parser = xml_parser_create($resp_encoding);\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
+ // What if internal encoding is not in one of the 3 allowed?\r
+ // we use the broadest one, ie. utf8\r
+ // This allows to send data which is native in various charset,\r
+ // by extending xmlrpc_encode_entitites() and setting xmlrpc_internalencoding\r
+ if (!in_array($xmlrpc->xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))\r
+ {\r
+ xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');\r
+ }\r
+ else\r
+ {\r
+ xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $xmlrpc->xmlrpc_internalencoding);\r
+ }\r
+\r
+ if ($return_type == 'phpvals')\r
+ {\r
+ xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast');\r
+ }\r
+ else\r
+ {\r
+ xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee');\r
+ }\r
+\r
+ xml_set_character_data_handler($parser, 'xmlrpc_cd');\r
+ xml_set_default_handler($parser, 'xmlrpc_dh');\r
+\r
+ // first error check: xml not well formed\r
+ if(!xml_parse($parser, $data, count($data)))\r
+ {\r
+ // thanks to Peter Kocks <peter.kocks@baygate.com>\r
+ if((xml_get_current_line_number($parser)) == 1)\r
+ {\r
+ $errstr = 'XML error at line 1, check URL';\r
+ }\r
+ else\r
+ {\r
+ $errstr = sprintf('XML error: %s at line %d, column %d',\r
+ xml_error_string(xml_get_error_code($parser)),\r
+ xml_get_current_line_number($parser), xml_get_current_column_number($parser));\r
+ }\r
+ error_log($errstr);\r
+ $r=new xmlrpcresp(0, $xmlrpc->xmlrpcerr['invalid_return'], $xmlrpc->xmlrpcstr['invalid_return'].' ('.$errstr.')');\r
+ xml_parser_free($parser);\r
+ if($this->debug)\r
+ {\r
+ print $errstr;\r
+ }\r
+ $r->hdrs = $xmlrpc->_xh['headers'];\r
+ $r->_cookies = $xmlrpc->_xh['cookies'];\r
+ $r->raw_data = $raw_data;\r
+ return $r;\r
+ }\r
+ xml_parser_free($parser);\r
+ // second error check: xml well formed but not xml-rpc compliant\r
+ if ($xmlrpc->_xh['isf'] > 1)\r
+ {\r
+ if ($this->debug)\r
+ {\r
+ /// @todo echo something for user?\r
+ }\r
+\r
+ $r = new xmlrpcresp(0, $xmlrpc->xmlrpcerr['invalid_return'],\r
+ $xmlrpc->xmlrpcstr['invalid_return'] . ' ' . $xmlrpc->_xh['isf_reason']);\r
+ }\r
+ // third error check: parsing of the response has somehow gone boink.\r
+ // NB: shall we omit this check, since we trust the parsing code?\r
+ elseif ($return_type == 'xmlrpcvals' && !is_object($xmlrpc->_xh['value']))\r
+ {\r
+ // something odd has happened\r
+ // and it's time to generate a client side error\r
+ // indicating something odd went on\r
+ $r=new xmlrpcresp(0, $xmlrpc->xmlrpcerr['invalid_return'],\r
+ $xmlrpc->xmlrpcstr['invalid_return']);\r
+ }\r
+ else\r
+ {\r
+ if ($this->debug)\r
+ {\r
+ print "<PRE>---PARSED---\n";\r
+ // somehow htmlentities chokes on var_export, and some full html string...\r
+ //print htmlentitites(var_export($xmlrpc->_xh['value'], true));\r
+ print htmlspecialchars(var_export($xmlrpc->_xh['value'], true));\r
+ print "\n---END---</PRE>";\r
+ }\r
+\r
+ // note that using =& will raise an error if $xmlrpc->_xh['st'] does not generate an object.\r
+ $v =& $xmlrpc->_xh['value'];\r
+\r
+ if($xmlrpc->_xh['isf'])\r
+ {\r
+ /// @todo we should test here if server sent an int and a string,\r
+ /// and/or coerce them into such...\r
+ if ($return_type == 'xmlrpcvals')\r
+ {\r
+ $errno_v = $v->structmem('faultCode');\r
+ $errstr_v = $v->structmem('faultString');\r
+ $errno = $errno_v->scalarval();\r
+ $errstr = $errstr_v->scalarval();\r
+ }\r
+ else\r
+ {\r
+ $errno = $v['faultCode'];\r
+ $errstr = $v['faultString'];\r
+ }\r
+\r
+ if($errno == 0)\r
+ {\r
+ // FAULT returned, errno needs to reflect that\r
+ $errno = -1;\r
+ }\r
+\r
+ $r = new xmlrpcresp(0, $errno, $errstr);\r
+ }\r
+ else\r
+ {\r
+ $r=new xmlrpcresp($v, 0, '', $return_type);\r
+ }\r
+ }\r
+\r
+ $r->hdrs = $xmlrpc->_xh['headers'];\r
+ $r->_cookies = $xmlrpc->_xh['cookies'];\r
+ $r->raw_data = $raw_data;\r
+ return $r;\r
+ }\r
+}\r
+\r
+class xmlrpcval\r
+{\r
+ var $me=array();\r
+ var $mytype=0;\r
+ var $_php_class=null;\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
+ {\r
+ /// @todo: optimization creep - do not call addXX, do it all inline.\r
+ /// downside: booleans will not be coerced anymore\r
+ if($val!==-1 || $type!='')\r
+ {\r
+ // optimization creep: inlined all work done by constructor\r
+ switch($type)\r
+ {\r
+ case '':\r
+ $this->mytype=1;\r
+ $this->me['string']=$val;\r
+ break;\r
+ case 'i4':\r
+ case 'int':\r
+ case 'double':\r
+ case 'string':\r
+ case 'boolean':\r
+ case 'dateTime.iso8601':\r
+ case 'base64':\r
+ case 'null':\r
+ $this->mytype=1;\r
+ $this->me[$type]=$val;\r
+ break;\r
+ case 'array':\r
+ $this->mytype=2;\r
+ $this->me['array']=$val;\r
+ break;\r
+ case 'struct':\r
+ $this->mytype=3;\r
+ $this->me['struct']=$val;\r
+ break;\r
+ default:\r
+ error_log("XML-RPC: ".__METHOD__.": not a known type ($type)");\r
+ }\r
+ /*if($type=='')\r
+ {\r
+ $type='string';\r
+ }\r
+ if($GLOBALS['xmlrpcTypes'][$type]==1)\r
+ {\r
+ $this->addScalar($val,$type);\r
+ }\r
+ elseif($GLOBALS['xmlrpcTypes'][$type]==2)\r
+ {\r
+ $this->addArray($val);\r
+ }\r
+ elseif($GLOBALS['xmlrpcTypes'][$type]==3)\r
+ {\r
+ $this->addStruct($val);\r
+ }*/\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Add a single php value to an (unitialized) xmlrpcval\r
+ * @param mixed $val\r
+ * @param string $type\r
+ * @return int 1 or 0 on failure\r
+ */\r
+ function addScalar($val, $type='string')\r
+ {\r
+ $xmlrpc = Xmlrpc::instance();\r
+\r
+ $typeof = null;\r
+ if(isset($xmlrpc->xmlrpcTypes[$type])) {\r
+ $typeof = $xmlrpc->xmlrpcTypes[$type];\r
+ }\r
+\r
+ if($typeof!=1)\r
+ {\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 either do it for datetimes, integers and doubles, too,\r
+ // or just plain remove this check, implemented on booleans only...\r
+ if($type==$xmlrpc->xmlrpcBoolean)\r
+ {\r
+ if(strcasecmp($val,'true')==0 || $val==1 || ($val==true && strcasecmp($val,'false')))\r
+ {\r
+ $val=true;\r
+ }\r
+ else\r
+ {\r
+ $val=false;\r
+ }\r
+ }\r
+\r
+ switch($this->mytype)\r
+ {\r
+ case 1:\r
+ error_log('XML-RPC: '.__METHOD__.': scalar xmlrpcval can have only one value');\r
+ return 0;\r
+ case 3:\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
+ //$ar=$this->me['array'];\r
+ //$ar[]=new xmlrpcval($val, $type);\r
+ //$this->me['array']=$ar;\r
+ // Faster (?) avoid all the costly array-copy-by-val done here...\r
+ $this->me['array'][]=new xmlrpcval($val, $type);\r
+ return 1;\r
+ default:\r
+ // a scalar, so set the value and remember we're scalar\r
+ $this->me[$type]=$val;\r
+ $this->mytype=$typeof;\r
+ return 1;\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Add an array of xmlrpcval objects to an xmlrpcval\r
+ * @param array $vals\r
+ * @return int 1 or 0 on failure\r
+ * @access public\r
+ *\r
+ * @todo add some checking for $vals to be an array of xmlrpcvals?\r
+ */\r
+ function addArray($vals)\r
+ {\r
+ $xmlrpc = Xmlrpc::instance();\r
+ if($this->mytype==0)\r
+ {\r
+ $this->mytype=$xmlrpc->xmlrpcTypes['array'];\r
+ $this->me['array']=$vals;\r
+ return 1;\r
+ }\r
+ elseif($this->mytype==2)\r
+ {\r
+ // we're adding to an array here\r
+ $this->me['array'] = array_merge($this->me['array'], $vals);\r
+ return 1;\r
+ }\r
+ else\r
+ {\r
+ error_log('XML-RPC: '.__METHOD__.': already initialized as a [' . $this->kindOf() . ']');\r
+ return 0;\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Add an array of named xmlrpcval objects to an xmlrpcval\r
+ * @param array $vals\r
+ * @return int 1 or 0 on failure\r
+ * @access public\r
+ *\r
+ * @todo add some checking for $vals to be an array?\r
+ */\r
+ function addStruct($vals)\r
+ {\r
+ $xmlrpc = Xmlrpc::instance();\r
+\r
+ if($this->mytype==0)\r
+ {\r
+ $this->mytype=$xmlrpc->xmlrpcTypes['struct'];\r
+ $this->me['struct']=$vals;\r
+ return 1;\r
+ }\r
+ elseif($this->mytype==3)\r
+ {\r
+ // we're adding to a struct here\r
+ $this->me['struct'] = array_merge($this->me['struct'], $vals);\r
+ return 1;\r
+ }\r
+ else\r
+ {\r
+ error_log('XML-RPC: '.__METHOD__.': already initialized as a [' . $this->kindOf() . ']');\r
+ return 0;\r
+ }\r
+ }\r
+\r
+ // poor man's version of print_r ???\r
+ // DEPRECATED!\r
+ function dump($ar)\r
+ {\r
+ foreach($ar as $key => $val)\r
+ {\r
+ echo "$key => $val<br />";\r
+ if($key == 'array')\r
+ {\r
+ while(list($key2, $val2) = each($val))\r
+ {\r
+ echo "-- $key2 => $val2<br />";\r
+ }\r
+ }\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Returns a string containing "struct", "array" or "scalar" describing the base type of the value\r
+ * @return string\r
+ * @access public\r
+ */\r
+ function kindOf()\r
+ {\r
+ switch($this->mytype)\r
+ {\r
+ case 3:\r
+ return 'struct';\r
+ break;\r
+ case 2:\r
+ return 'array';\r
+ break;\r
+ case 1:\r
+ return 'scalar';\r
+ break;\r
+ default:\r
+ return 'undef';\r
+ }\r
+ }\r
+\r
+ /**\r
+ * @access private\r
+ */\r
+ function serializedata($typ, $val, $charset_encoding='')\r
+ {\r
+ $xmlrpc = Xmlrpc::instance();\r
+ $rs='';\r
+\r
+ if(!isset($xmlrpc->xmlrpcTypes[$typ])) {\r
+ return $rs;\r
+ }\r
+\r
+ switch($xmlrpc->xmlrpcTypes[$typ])\r
+ {\r
+ case 1:\r
+ switch($typ)\r
+ {\r
+ case $xmlrpc->xmlrpcBase64:\r
+ $rs.="<${typ}>" . base64_encode($val) . "</${typ}>";\r
+ break;\r
+ case $xmlrpc->xmlrpcBoolean:\r
+ $rs.="<${typ}>" . ($val ? '1' : '0') . "</${typ}>";\r
+ break;\r
+ case $xmlrpc->xmlrpcString:\r
+ // G. Giunta 2005/2/13: do NOT use htmlentities, since\r
+ // it will produce named html entities, which are invalid xml\r
+ $rs.="<${typ}>" . xmlrpc_encode_entitites($val, $xmlrpc->xmlrpc_internalencoding, $charset_encoding). "</${typ}>";\r
+ break;\r
+ case $xmlrpc->xmlrpcInt:\r
+ case $xmlrpc->xmlrpcI4:\r
+ $rs.="<${typ}>".(int)$val."</${typ}>";\r
+ break;\r
+ case $xmlrpc->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') 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 $xmlrpc->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 $xmlrpc->xmlrpcNull:\r
+ if ($xmlrpc->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
+ // for xmlrpcvals of unknown type...\r
+ $rs.="<${typ}>${val}</${typ}>";\r
+ }\r
+ break;\r
+ case 3:\r
+ // struct\r
+ if ($this->_php_class)\r
+ {\r
+ $rs.='<struct php_class="' . $this->_php_class . "\">\n";\r
+ }\r
+ else\r
+ {\r
+ $rs.="<struct>\n";\r
+ }\r
+ foreach($val as $key2 => $val2)\r
+ {\r
+ $rs.='<member><name>'.xmlrpc_encode_entitites($key2, $xmlrpc->xmlrpc_internalencoding, $charset_encoding)."</name>\n";\r
+ //$rs.=$this->serializeval($val2);\r
+ $rs.=$val2->serialize($charset_encoding);\r
+ $rs.="</member>\n";\r
+ }\r
+ $rs.='</struct>';\r
+ break;\r
+ case 2:\r
+ // array\r
+ $rs.="<array>\n<data>\n";\r
+ for($i=0; $i<count($val); $i++)\r
+ {\r
+ //$rs.=$this->serializeval($val[$i]);\r
+ $rs.=$val[$i]->serialize($charset_encoding);\r
+ }\r
+ $rs.="</data>\n</array>";\r
+ break;\r
+ default:\r
+ break;\r
+ }\r
+ return $rs;\r
+ }\r
+\r
+ /**\r
+ * Returns xml representation of the value. XML prologue not included\r
+ * @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed\r
+ * @return string\r
+ * @access public\r
+ */\r
+ function serialize($charset_encoding='')\r
+ {\r
+ // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...\r
+ //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))\r
+ //{\r
+ reset($this->me);\r
+ list($typ, $val) = each($this->me);\r
+ return '<value>' . $this->serializedata($typ, $val, $charset_encoding) . "</value>\n";\r
+ //}\r
+ }\r
+\r
+ // DEPRECATED\r
+ function serializeval($o)\r
+ {\r
+ // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...\r
+ //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))\r
+ //{\r
+ $ar=$o->me;\r
+ reset($ar);\r
+ list($typ, $val) = each($ar);\r
+ return '<value>' . $this->serializedata($typ, $val) . "</value>\n";\r
+ //}\r
+ }\r
+\r
+ /**\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
+ * @access public\r
+ */\r
+ function structmemexists($m)\r
+ {\r
+ return array_key_exists($m, $this->me['struct']);\r
+ }\r
+\r
+ /**\r
+ * Returns the value of a given struct member (an xmlrpcval object in itself).\r
+ * Will raise a php warning if struct member of given name does not exist\r
+ * @param string $m the name of the struct member to be looked up\r
+ * @return xmlrpcval\r
+ * @access public\r
+ */\r
+ function structmem($m)\r
+ {\r
+ return $this->me['struct'][$m];\r
+ }\r
+\r
+ /**\r
+ * Reset internal pointer for xmlrpcvals of type struct.\r
+ * @access public\r
+ */\r
+ function structreset()\r
+ {\r
+ reset($this->me['struct']);\r
+ }\r
+\r
+ /**\r
+ * Return next member element for xmlrpcvals of type struct.\r
+ * @return xmlrpcval\r
+ * @access public\r
+ */\r
+ function structeach()\r
+ {\r
+ return each($this->me['struct']);\r
+ }\r
+\r
+ // DEPRECATED! this code looks like it is very fragile and has not been fixed\r
+ // for a long long time. Shall we remove it for 2.0?\r
+ function getval()\r
+ {\r
+ // UNSTABLE\r
+ reset($this->me);\r
+ list($a,$b)=each($this->me);\r
+ // contributed by I Sofer, 2001-03-24\r
+ // add support for nested arrays to scalarval\r
+ // i've created a new method here, so as to\r
+ // preserve back compatibility\r
+\r
+ if(is_array($b))\r
+ {\r
+ @reset($b);\r
+ while(list($id,$cont) = @each($b))\r
+ {\r
+ $b[$id] = $cont->scalarval();\r
+ }\r
+ }\r
+\r
+ // add support for structures directly encoding php objects\r
+ if(is_object($b))\r
+ {\r
+ $t = get_object_vars($b);\r
+ @reset($t);\r
+ while(list($id,$cont) = @each($t))\r
+ {\r
+ $t[$id] = $cont->scalarval();\r
+ }\r
+ @reset($t);\r
+ while(list($id,$cont) = @each($t))\r
+ {\r
+ @$b->$id = $cont;\r
+ }\r
+ }\r
+ // end contrib\r
+ return $b;\r
+ }\r
+\r
+ /**\r
+ * Returns the value of a scalar xmlrpcval\r
+ * @return mixed\r
+ * @access public\r
+ */\r
+ function scalarval()\r
+ {\r
+ reset($this->me);\r
+ list(,$b)=each($this->me);\r
+ return $b;\r
+ }\r
+\r
+ /**\r
+ * Returns the type of the xmlrpcval.\r
+ * For integers, 'int' is always returned in place of 'i4'\r
+ * @return string\r
+ * @access public\r
+ */\r
+ function scalartyp()\r
+ {\r
+ $xmlrpc = Xmlrpc::instance();\r
+\r
+ reset($this->me);\r
+ list($a,)=each($this->me);\r
+ if($a==$xmlrpc->xmlrpcI4)\r
+ {\r
+ $a=$xmlrpc->xmlrpcInt;\r
+ }\r
+ return $a;\r
+ }\r
+\r
+ /**\r
+ * Returns the m-th member of an xmlrpcval of struct type\r
+ * @param integer $m the index of the value to be retrieved (zero based)\r
+ * @return xmlrpcval\r
+ * @access public\r
+ */\r
+ function arraymem($m)\r
+ {\r
+ return $this->me['array'][$m];\r
+ }\r
+\r
+ /**\r
+ * Returns the number of members in an xmlrpcval of array type\r
+ * @return integer\r
+ * @access public\r
+ */\r
+ function arraysize()\r
+ {\r
+ return count($this->me['array']);\r
+ }\r
+\r
+ /**\r
+ * Returns the number of members in an xmlrpcval of struct type\r
+ * @return integer\r
+ * @access public\r
+ */\r
+ function structsize()\r
+ {\r
+ return count($this->me['struct']);\r
+ }\r
+}\r
+\r
+\r
+// date helpers\r
+\r
+/**\r
+ * Given a timestamp, return the corresponding ISO8601 encoded string.\r
+ *\r
+ * Really, timezones ought to be supported\r
+ * but the XML-RPC spec says:\r
+ *\r
+ * "Don't assume a timezone. It should be specified by the server in its\r
+ * documentation what assumptions it makes about timezones."\r
+ *\r
+ * These routines always assume localtime unless\r
+ * $utc is set to 1, in which case UTC is assumed\r
+ * and an adjustment for locale is made when encoding\r
+ *\r
+ * @param int $timet (timestamp)\r
+ * @param int $utc (0 or 1)\r
+ * @return string\r
+ */\r
+function iso8601_encode($timet, $utc=0)\r
+{\r
+ if(!$utc)\r
+ {\r
+ $t=strftime("%Y%m%dT%H:%M:%S", $timet);\r
+ }\r
+ else\r
+ {\r
+ if(function_exists('gmstrftime'))\r
+ {\r
+ // gmstrftime doesn't exist in some versions\r
+ // of PHP\r
+ $t=gmstrftime("%Y%m%dT%H:%M:%S", $timet);\r
+ }\r
+ else\r
+ {\r
+ $t=strftime("%Y%m%dT%H:%M:%S", $timet-date('Z'));\r
+ }\r
+ }\r
+ return $t;\r
+}\r
+\r
+/**\r
+ * Given an ISO8601 date string, return a timet in the localtime, or UTC\r
+ * @param string $idate\r
+ * @param int $utc either 0 or 1\r
+ * @return int (datetime)\r
+ */\r
+function iso8601_decode($idate, $utc=0)\r
+{\r
+ $t=0;\r
+ if(preg_match('/([0-9]{4})([0-9]{2})([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})/', $idate, $regs))\r
+ {\r
+ if($utc)\r
+ {\r
+ $t=gmmktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);\r
+ }\r
+ else\r
+ {\r
+ $t=mktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);\r
+ }\r
+ }\r
+ return $t;\r
+}\r
+\r
+/**\r
+ * Takes an xmlrpc value in PHP xmlrpcval object format and translates it into native PHP types.\r
+ *\r
+ * Works with xmlrpc message objects as input, too.\r
+ *\r
+ * Given proper options parameter, can rebuild generic php object instances\r
+ * (provided those have been encoded to xmlrpc format using a corresponding\r
+ * option in php_xmlrpc_encode())\r
+ * PLEASE NOTE that rebuilding php objects involves calling their constructor function.\r
+ * This means that the remote communication end can decide which php code will\r
+ * get executed on your server, leaving the door possibly open to 'php-injection'\r
+ * style of attacks (provided you have some classes defined on your server that\r
+ * might wreak havoc if instances are built outside an appropriate context).\r
+ * Make sure you trust the remote server/client before eanbling this!\r
+ *\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; 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
+{\r
+ switch($xmlrpc_val->kindOf())\r
+ {\r
+ case 'scalar':\r
+ if (in_array('extension_api', $options))\r
+ {\r
+ reset($xmlrpc_val->me);\r
+ list($typ,$val) = each($xmlrpc_val->me);\r
+ switch ($typ)\r
+ {\r
+ case 'dateTime.iso8601':\r
+ $xmlrpc_val->scalar = $val;\r
+ $xmlrpc_val->xmlrpc_type = 'datetime';\r
+ $xmlrpc_val->timestamp = iso8601_decode($val);\r
+ return $xmlrpc_val;\r
+ case 'base64':\r
+ $xmlrpc_val->scalar = $val;\r
+ $xmlrpc_val->type = $typ;\r
+ return $xmlrpc_val;\r
+ default:\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
+ $arr = array();\r
+ for($i = 0; $i < $size; $i++)\r
+ {\r
+ $arr[] = php_xmlrpc_decode($xmlrpc_val->arraymem($i), $options);\r
+ }\r
+ return $arr;\r
+ case 'struct':\r
+ $xmlrpc_val->structreset();\r
+ // If user said so, try to rebuild php objects for specific struct vals.\r
+ /// @todo should we raise a warning for class not found?\r
+ // shall we check for proper subclass of xmlrpcval instead of\r
+ // presence of _php_class to detect what we can do?\r
+ if (in_array('decode_php_objs', $options) && $xmlrpc_val->_php_class != ''\r
+ && class_exists($xmlrpc_val->_php_class))\r
+ {\r
+ $obj = @new $xmlrpc_val->_php_class;\r
+ while(list($key,$value)=$xmlrpc_val->structeach())\r
+ {\r
+ $obj->$key = php_xmlrpc_decode($value, $options);\r
+ }\r
+ return $obj;\r
+ }\r
+ else\r
+ {\r
+ $arr = array();\r
+ while(list($key,$value)=$xmlrpc_val->structeach())\r
+ {\r
+ $arr[$key] = php_xmlrpc_decode($value, $options);\r
+ }\r
+ return $arr;\r
+ }\r
+ case 'msg':\r
+ $paramcount = $xmlrpc_val->getNumParams();\r
+ $arr = array();\r
+ for($i = 0; $i < $paramcount; $i++)\r
+ {\r
+ $arr[] = php_xmlrpc_decode($xmlrpc_val->getParam($i));\r
+ }\r
+ return $arr;\r
+ }\r
+}\r
+\r
+// This constant left here only for historical reasons...\r
+// it was used to decide if we have to define xmlrpc_encode on our own, but\r
+// we do not do it anymore\r
+if(function_exists('xmlrpc_decode'))\r
+{\r
+ define('XMLRPC_EPI_ENABLED','1');\r
+}\r
+else\r
+{\r
+ define('XMLRPC_EPI_ENABLED','0');\r
+}\r
+\r
+/**\r
+ * Takes native php types and encodes them into xmlrpc PHP object format.\r
+ * It will not re-encode xmlrpcval objects.\r
+ *\r
+ * Feature creep -- could support more types via optional type argument\r
+ * (string => datetime support has been added, ??? => base64 not yet)\r
+ *\r
+ * If given a proper options parameter, php object instances will be encoded\r
+ * into 'special' xmlrpc values, that can later be decoded into php objects\r
+ * by calling php_xmlrpc_decode() with a corresponding option\r
+ *\r
+ * @author Dan Libby (dan@libby.com)\r
+ *\r
+ * @param mixed $php_val the value to be converted into an xmlrpcval object\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
+{\r
+ $xmlrpc = Xmlrpc::instance();\r
+ $type = gettype($php_val);\r
+ switch($type)\r
+ {\r
+ case 'string':\r
+ if (in_array('auto_dates', $options) && preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $php_val))\r
+ $xmlrpc_val = new xmlrpcval($php_val, $xmlrpc->xmlrpcDateTime);\r
+ else\r
+ $xmlrpc_val = new xmlrpcval($php_val, $xmlrpc->xmlrpcString);\r
+ break;\r
+ case 'integer':\r
+ $xmlrpc_val = new xmlrpcval($php_val, $xmlrpc->xmlrpcInt);\r
+ break;\r
+ case 'double':\r
+ $xmlrpc_val = new xmlrpcval($php_val, $xmlrpc->xmlrpcDouble);\r
+ break;\r
+ // <G_Giunta_2001-02-29>\r
+ // Add support for encoding/decoding of booleans, since they are supported in PHP\r
+ case 'boolean':\r
+ $xmlrpc_val = new xmlrpcval($php_val, $xmlrpc->xmlrpcBoolean);\r
+ break;\r
+ // </G_Giunta_2001-02-29>\r
+ case 'array':\r
+ // PHP arrays can be encoded to either xmlrpc structs or arrays,\r
+ // depending on wheter they are hashes or plain 0..n integer indexed\r
+ // A shorter one-liner would be\r
+ // $tmp = array_diff(array_keys($php_val), range(0, count($php_val)-1));\r
+ // but execution time skyrockets!\r
+ $j = 0;\r
+ $arr = array();\r
+ $ko = false;\r
+ foreach($php_val as $key => $val)\r
+ {\r
+ $arr[$key] = php_xmlrpc_encode($val, $options);\r
+ if(!$ko && $key !== $j)\r
+ {\r
+ $ko = true;\r
+ }\r
+ $j++;\r
+ }\r
+ if($ko)\r
+ {\r
+ $xmlrpc_val = new xmlrpcval($arr, $xmlrpc->xmlrpcStruct);\r
+ }\r
+ else\r
+ {\r
+ $xmlrpc_val = new xmlrpcval($arr, $xmlrpc->xmlrpcArray);\r
+ }\r
+ break;\r
+ case 'object':\r
+ if(is_a($php_val, 'xmlrpcval'))\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'), $xmlrpc->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($arr, $xmlrpc->xmlrpcStruct);\r
+ if (in_array('encode_php_objs', $options))\r
+ {\r
+ // let's save original class name into xmlrpcval:\r
+ // might be useful later on...\r
+ $xmlrpc_val->_php_class = get_class($php_val);\r
+ }\r
+ }\r
+ break;\r
+ case 'NULL':\r
+ if (in_array('extension_api', $options))\r
+ {\r
+ $xmlrpc_val = new xmlrpcval('', $xmlrpc->xmlrpcString);\r
+ }\r
+ else if (in_array('null_extension', $options))\r
+ {\r
+ $xmlrpc_val = new xmlrpcval('', $xmlrpc->xmlrpcNull);\r
+ }\r
+ else\r
+ {\r
+ $xmlrpc_val = new xmlrpcval();\r
+ }\r
+ break;\r
+ case 'resource':\r
+ if (in_array('extension_api', $options))\r
+ {\r
+ $xmlrpc_val = new xmlrpcval((int)$php_val, $xmlrpc->xmlrpcInt);\r
+ }\r
+ else\r
+ {\r
+ $xmlrpc_val = new xmlrpcval();\r
+ }\r
+ // catch "user function", "unknown type"\r
+ default:\r
+ // giancarlo pinerolo <ping@alt.it>\r
+ // it has to return\r
+ // an empty object in case, not a boolean.\r
+ $xmlrpc_val = new xmlrpcval();\r
+ break;\r
+ }\r
+ return $xmlrpc_val;\r
+}\r
+\r
+/**\r
+ * Convert the xml representation of a method response, method request or single\r
+ * xmlrpc value into the appropriate object (a.k.a. deserialize)\r
+ * @param string $xml_val\r
+ * @param array $options\r
+ * @return mixed false on error, or an instance of either xmlrpcval, xmlrpcmsg or xmlrpcresp\r
+ */\r
+function php_xmlrpc_decode_xml($xml_val, $options=array())\r
+{\r
+ $xmlrpc = Xmlrpc::instance();\r
+\r
+ $xmlrpc->_xh = array();\r
+ $xmlrpc->_xh['ac'] = '';\r
+ $xmlrpc->_xh['stack'] = array();\r
+ $xmlrpc->_xh['valuestack'] = array();\r
+ $xmlrpc->_xh['params'] = array();\r
+ $xmlrpc->_xh['pt'] = array();\r
+ $xmlrpc->_xh['isf'] = 0;\r
+ $xmlrpc->_xh['isf_reason'] = '';\r
+ $xmlrpc->_xh['method'] = false;\r
+ $xmlrpc->_xh['rt'] = '';\r
+ /// @todo 'guestimate' encoding\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 use the broadest one, ie. utf8!\r
+ if (!in_array($xmlrpc->xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))\r
+ {\r
+ xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');\r
+ }\r
+ else\r
+ {\r
+ xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $xmlrpc->xmlrpc_internalencoding);\r
+ }\r
+ xml_set_element_handler($parser, 'xmlrpc_se_any', 'xmlrpc_ee');\r
+ xml_set_character_data_handler($parser, 'xmlrpc_cd');\r
+ xml_set_default_handler($parser, 'xmlrpc_dh');\r
+ if(!xml_parse($parser, $xml_val, 1))\r
+ {\r
+ $errstr = sprintf('XML error: %s at line %d, column %d',\r
+ xml_error_string(xml_get_error_code($parser)),\r
+ xml_get_current_line_number($parser), xml_get_current_column_number($parser));\r
+ error_log($errstr);\r
+ xml_parser_free($parser);\r
+ return false;\r
+ }\r
+ xml_parser_free($parser);\r
+ if ($xmlrpc->_xh['isf'] > 1) // test that $xmlrpc->_xh['value'] is an obj, too???\r
+ {\r
+ error_log($xmlrpc->_xh['isf_reason']);\r
+ return false;\r
+ }\r
+ switch ($xmlrpc->_xh['rt'])\r
+ {\r
+ case 'methodresponse':\r
+ $v =& $xmlrpc->_xh['value'];\r
+ if ($xmlrpc->_xh['isf'] == 1)\r
+ {\r
+ $vc = $v->structmem('faultCode');\r
+ $vs = $v->structmem('faultString');\r
+ $r = new xmlrpcresp(0, $vc->scalarval(), $vs->scalarval());\r
+ }\r
+ else\r
+ {\r
+ $r = new xmlrpcresp($v);\r
+ }\r
+ return $r;\r
+ case 'methodcall':\r
+ $m = new xmlrpcmsg($xmlrpc->_xh['method']);\r
+ for($i=0; $i < count($xmlrpc->_xh['params']); $i++)\r
+ {\r
+ $m->addParam($xmlrpc->_xh['params'][$i]);\r
+ }\r
+ return $m;\r
+ case 'value':\r
+ return $xmlrpc->_xh['value'];\r
+ default:\r
+ return false;\r
+ }\r
+}\r
+\r
+/**\r
+ * decode a string that is encoded w/ "chunked" transfer encoding\r
+ * as defined in rfc2068 par. 19.4.6\r
+ * code shamelessly stolen from nusoap library by Dietrich Ayala\r
+ *\r
+ * @param string $buffer the string to be decoded\r
+ * @return string\r
+ */\r
+function decode_chunked($buffer)\r
+{\r
+ // length := 0\r
+ $length = 0;\r
+ $new = '';\r
+\r
+ // read chunk-size, chunk-extension (if any) and crlf\r
+ // get the position of the linebreak\r
+ $chunkend = strpos($buffer,"\r\n") + 2;\r
+ $temp = substr($buffer,0,$chunkend);\r
+ $chunk_size = hexdec( trim($temp) );\r
+ $chunkstart = $chunkend;\r
+ while($chunk_size > 0)\r
+ {\r
+ $chunkend = strpos($buffer, "\r\n", $chunkstart + $chunk_size);\r
+\r
+ // just in case we got a broken connection\r
+ if($chunkend == false)\r
+ {\r
+ $chunk = substr($buffer,$chunkstart);\r
+ // append chunk-data to entity-body\r
+ $new .= $chunk;\r
+ $length += strlen($chunk);\r
+ break;\r
+ }\r
+\r
+ // read chunk-data and crlf\r
+ $chunk = substr($buffer,$chunkstart,$chunkend-$chunkstart);\r
+ // append chunk-data to entity-body\r
+ $new .= $chunk;\r
+ // length := length + chunk-size\r
+ $length += strlen($chunk);\r
+ // read chunk-size and crlf\r
+ $chunkstart = $chunkend + 2;\r
+\r
+ $chunkend = strpos($buffer,"\r\n",$chunkstart)+2;\r
+ if($chunkend == false)\r
+ {\r
+ break; //just in case we got a broken connection\r
+ }\r
+ $temp = substr($buffer,$chunkstart,$chunkend-$chunkstart);\r
+ $chunk_size = hexdec( trim($temp) );\r
+ $chunkstart = $chunkend;\r
+ }\r
+ return $new;\r
+}\r
+\r
+/**\r
+ * xml charset encoding guessing helper function.\r
+ * Tries to determine the charset encoding of an XML chunk received over HTTP.\r
+ * NB: according to the spec (RFC 3023), if text/xml content-type is received over HTTP without a content-type,\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 $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
+function guess_encoding($httpheader='', $xmlchunk='', $encoding_prefs=null)\r
+{\r
+ $xmlrpc = Xmlrpc::instance();\r
+\r
+ // discussion: see http://www.yale.edu/pclt/encoding/\r
+ // 1 - test if encoding is specified in HTTP HEADERS\r
+\r
+ //Details:\r
+ // LWS: (\13\10)?( |\t)+\r
+ // token: (any char but excluded stuff)+\r
+ // quoted string: " (any char but double quotes and cointrol chars)* "\r
+ // header: Content-type = ...; charset=value(; ...)*\r
+ // where value is of type token, no LWS allowed between 'charset' and value\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
+\r
+ /// @todo this test will pass if ANY header has charset specification, not only Content-Type. Fix it?\r
+ $matches = array();\r
+ if(preg_match('/;\s*charset\s*=([^;]+)/i', $httpheader, $matches))\r
+ {\r
+ return strtoupper(trim($matches[1], " \t\""));\r
+ }\r
+\r
+ // 2 - 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
+ // NOTE: actually, according to the spec, even if we find the BOM and determine\r
+ // an encoding, we should check if there is an encoding specified\r
+ // in the xml declaration, and verify if they match.\r
+ /// @todo implement check as described above?\r
+ /// @todo implement check for first bytes of string even without a BOM? (It sure looks harder than for cases WITH a BOM)\r
+ if(preg_match('/^(\x00\x00\xFE\xFF|\xFF\xFE\x00\x00|\x00\x00\xFF\xFE|\xFE\xFF\x00\x00)/', $xmlchunk))\r
+ {\r
+ return 'UCS-4';\r
+ }\r
+ elseif(preg_match('/^(\xFE\xFF|\xFF\xFE)/', $xmlchunk))\r
+ {\r
+ return 'UTF-16';\r
+ }\r
+ elseif(preg_match('/^(\xEF\xBB\xBF)/', $xmlchunk))\r
+ {\r
+ return 'UTF-8';\r
+ }\r
+\r
+ // 3 - 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 strtoupper(substr($matches[2], 1, -1));\r
+ }\r
+\r
+ // 4 - if mbstring is available, let it do the guesswork\r
+ // NB: we favour finding an encoding that is compatible with what we can process\r
+ if(extension_loaded('mbstring'))\r
+ {\r
+ if($encoding_prefs)\r
+ {\r
+ $enc = mb_detect_encoding($xmlchunk, $encoding_prefs);\r
+ }\r
+ else\r
+ {\r
+ $enc = mb_detect_encoding($xmlchunk);\r
+ }\r
+ // NB: mb_detect likes to call it ascii, xml parser likes to call it US_ASCII...\r
+ // IANA also likes better US-ASCII, so go with it\r
+ if($enc == 'ASCII')\r
+ {\r
+ $enc = 'US-'.$enc;\r
+ }\r
+ return $enc;\r
+ }\r
+ else\r
+ {\r
+ // no encoding specified: as per HTTP1.1 assume it is iso-8859-1?\r
+ // Both RFC 2616 (HTTP 1.1) and 1945 (HTTP 1.0) clearly state that for text/xxx content types\r
+ // this should be the standard. And we should be getting text/xml as request and response.\r
+ // BUT we have to be backward compatible with the lib, which always used UTF-8 as default...\r
+ return $xmlrpc->xmlrpc_defencoding;\r
+ }\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
+ $charset_supersets = array(\r
+ 'US-ASCII' => array ('ISO-8859-1', 'ISO-8859-2', 'ISO-8859-3', 'ISO-8859-4',\r
+ 'ISO-8859-5', 'ISO-8859-6', 'ISO-8859-7', 'ISO-8859-8',\r
+ 'ISO-8859-9', 'ISO-8859-10', 'ISO-8859-11', 'ISO-8859-12',\r
+ 'ISO-8859-13', 'ISO-8859-14', 'ISO-8859-15', 'UTF-8',\r
+ 'EUC-JP', 'EUC-', 'EUC-KR', 'EUC-CN')\r
+ );\r
+ if (is_string($validlist))\r
+ $validlist = explode(',', $validlist);\r
+ if (@in_array(strtoupper($encoding), $validlist))\r
+ return true;\r
+ else\r
+ {\r
+ if (array_key_exists($encoding, $charset_supersets))\r
+ foreach ($validlist as $allowed)\r
+ if (in_array($allowed, $charset_supersets[$encoding]))\r
+ return true;\r
+ return false;\r
+ }\r
+}\r
\r
?>
\ No newline at end of file
* @todo implement self-parsing of php code for PHP <= 4\r
*/\r
\r
- // requires: xmlrpc.inc\r
-\r
- /**\r
- * Given a string defining a php type or phpxmlrpc type (loosely defined: strings\r
- * accepted come from javadoc blocks), return corresponding phpxmlrpc type.\r
- * NB: for php 'resource' types returns empty string, since resources cannot be serialized;\r
- * for php class names returns 'struct', since php objects can be serialized as xmlrpc structs\r
- * for php arrays always return array, even though arrays sometiles serialize as json structs\r
- * @param string $phptype\r
- * @return string\r
- */\r
- function php_2_xmlrpc_type($phptype)\r
- {\r
- switch(strtolower($phptype))\r
- {\r
- case 'string':\r
- return $GLOBALS['xmlrpcString'];\r
- case 'integer':\r
- case $GLOBALS['xmlrpcInt']: // 'int'\r
- case $GLOBALS['xmlrpcI4']:\r
- return $GLOBALS['xmlrpcInt'];\r
- case 'double':\r
- return $GLOBALS['xmlrpcDouble'];\r
- case 'boolean':\r
- return $GLOBALS['xmlrpcBoolean'];\r
- case 'array':\r
- return $GLOBALS['xmlrpcArray'];\r
- case 'object':\r
- return $GLOBALS['xmlrpcStruct'];\r
- case $GLOBALS['xmlrpcBase64']:\r
- case $GLOBALS['xmlrpcStruct']:\r
- return strtolower($phptype);\r
- case 'resource':\r
- return '';\r
- default:\r
- if(class_exists($phptype))\r
- {\r
- return $GLOBALS['xmlrpcStruct'];\r
- }\r
- else\r
- {\r
- // unknown: might be any 'extended' xmlrpc type\r
- return $GLOBALS['xmlrpcValue'];\r
- }\r
- }\r
- }\r
-\r
- /**\r
- * Given a string defining a phpxmlrpc type return corresponding php type.\r
- * @param string $xmlrpctype\r
- * @return string\r
- */\r
- function xmlrpc_2_php_type($xmlrpctype)\r
- {\r
- switch(strtolower($xmlrpctype))\r
- {\r
- case 'base64':\r
- case 'datetime.iso8601':\r
- case 'string':\r
- return $GLOBALS['xmlrpcString'];\r
- case 'int':\r
- case 'i4':\r
- return 'integer';\r
- case 'struct':\r
- case 'array':\r
- return 'array';\r
- case 'double':\r
- return 'float';\r
- case 'undefined':\r
- return 'mixed';\r
- case 'boolean':\r
- case 'null':\r
- default:\r
- // unknown: might be any xmlrpc type\r
- return strtolower($xmlrpctype);\r
- }\r
- }\r
-\r
- /**\r
- * Given a user-defined PHP function, create a PHP 'wrapper' function that can\r
- * be exposed as xmlrpc method from an xmlrpc_server object and called from remote\r
- * clients (as well as its corresponding signature info).\r
- *\r
- * Since php is a typeless language, to infer types of input and output parameters,\r
- * it relies on parsing the javadoc-style comment block associated with the given\r
- * function. Usage of xmlrpc native types (such as datetime.dateTime.iso8601 and base64)\r
- * in the @param tag is also allowed, if you need the php function to receive/send\r
- * data in that particular format (note that base64 encoding/decoding is transparently\r
- * carried out by the lib, while datetime vals are passed around as strings)\r
- *\r
- * Known limitations:\r
- * - only works for user-defined functions, not for PHP internal functions\r
- * (reflection does not support retrieving number/type of params for those)\r
- * - functions returning php objects will generate special xmlrpc responses:\r
- * when the xmlrpc decoding of those responses is carried out by this same lib, using\r
- * the appropriate param in php_xmlrpc_decode, the php objects will be rebuilt.\r
- * In short: php objects can be serialized, too (except for their resource members),\r
- * using this function.\r
- * Other libs might choke on the very same xml that will be generated in this case\r
- * (i.e. it has a nonstandard attribute on struct element tags)\r
- * - usage of javadoc @param tags using param names in a different order from the\r
- * function prototype is not considered valid (to be fixed?)\r
- *\r
- * Note that since rel. 2.0RC3 the preferred method to have the server call 'standard'\r
- * php functions (ie. functions not expecting a single xmlrpcmsg obj as parameter)\r
- * is by making use of the functions_parameters_type class member.\r
- *\r
- * @param string $funcname the name of the PHP user function to be exposed as xmlrpc method; array($obj, 'methodname') and array('class', 'methodname') are ok too\r
- * @param string $newfuncname (optional) name for function to be created\r
- * @param array $extra_options (optional) array of options for conversion. valid values include:\r
- * bool return_source when true, php code w. function definition will be returned, not evaluated\r
- * bool encode_php_objs let php objects be sent to server using the 'improved' xmlrpc notation, so server can deserialize them as php objects\r
- * bool decode_php_objs --- WARNING !!! possible security hazard. only use it with trusted servers ---\r
- * bool suppress_warnings remove from produced xml any runtime warnings due to the php function being invoked\r
- * @return false on error, or an array containing the name of the new php function,\r
- * its signature and docs, to be used in the server dispatch map\r
- *\r
- * @todo decide how to deal with params passed by ref: bomb out or allow?\r
- * @todo finish using javadoc info to build method sig if all params are named but out of order\r
- * @todo add a check for params of 'resource' type\r
- * @todo add some trigger_errors / error_log when returning false?\r
- * @todo what to do when the PHP function returns NULL? we are currently returning an empty string value...\r
- * @todo add an option to suppress php warnings in invocation of user function, similar to server debug level 3?\r
- * @todo if $newfuncname is empty, we could use create_user_func instead of eval, as it is possibly faster\r
- * @todo add a verbatim_object_copy parameter to allow avoiding the same obj instance?\r
- */\r
- function wrap_php_function($funcname, $newfuncname='', $extra_options=array())\r
- {\r
- $buildit = isset($extra_options['return_source']) ? !($extra_options['return_source']) : true;\r
- $prefix = isset($extra_options['prefix']) ? $extra_options['prefix'] : 'xmlrpc';\r
- $encode_php_objects = isset($extra_options['encode_php_objs']) ? (bool)$extra_options['encode_php_objs'] : false;\r
- $decode_php_objects = isset($extra_options['decode_php_objs']) ? (bool)$extra_options['decode_php_objs'] : false;\r
- $catch_warnings = isset($extra_options['suppress_warnings']) && $extra_options['suppress_warnings'] ? '@' : '';\r
-\r
- $exists = false;\r
- if (is_string($funcname) && strpos($funcname, '::') !== false)\r
- {\r
- $funcname = explode('::', $funcname);\r
- }\r
+// requires: xmlrpc.inc\r
+\r
+/**\r
+* Given a string defining a php type or phpxmlrpc type (loosely defined: strings\r
+* accepted come from javadoc blocks), return corresponding phpxmlrpc type.\r
+* NB: for php 'resource' types returns empty string, since resources cannot be serialized;\r
+* for php class names returns 'struct', since php objects can be serialized as xmlrpc structs\r
+* for php arrays always return array, even though arrays sometiles serialize as json structs\r
+* @param string $phptype\r
+* @return string\r
+*/\r
+function php_2_xmlrpc_type($phptype)\r
+{\r
+ switch(strtolower($phptype))\r
+ {\r
+ case 'string':\r
+ return $GLOBALS['xmlrpcString'];\r
+ case 'integer':\r
+ case $GLOBALS['xmlrpcInt']: // 'int'\r
+ case $GLOBALS['xmlrpcI4']:\r
+ return $GLOBALS['xmlrpcInt'];\r
+ case 'double':\r
+ return $GLOBALS['xmlrpcDouble'];\r
+ case 'boolean':\r
+ return $GLOBALS['xmlrpcBoolean'];\r
+ case 'array':\r
+ return $GLOBALS['xmlrpcArray'];\r
+ case 'object':\r
+ return $GLOBALS['xmlrpcStruct'];\r
+ case $GLOBALS['xmlrpcBase64']:\r
+ case $GLOBALS['xmlrpcStruct']:\r
+ return strtolower($phptype);\r
+ case 'resource':\r
+ return '';\r
+ default:\r
+ if(class_exists($phptype))\r
+ {\r
+ return $GLOBALS['xmlrpcStruct'];\r
+ }\r
+ else\r
+ {\r
+ // unknown: might be any 'extended' xmlrpc type\r
+ return $GLOBALS['xmlrpcValue'];\r
+ }\r
+ }\r
+}\r
+\r
+/**\r
+* Given a string defining a phpxmlrpc type return corresponding php type.\r
+* @param string $xmlrpctype\r
+* @return string\r
+*/\r
+function xmlrpc_2_php_type($xmlrpctype)\r
+{\r
+ switch(strtolower($xmlrpctype))\r
+ {\r
+ case 'base64':\r
+ case 'datetime.iso8601':\r
+ case 'string':\r
+ return $GLOBALS['xmlrpcString'];\r
+ case 'int':\r
+ case 'i4':\r
+ return 'integer';\r
+ case 'struct':\r
+ case 'array':\r
+ return 'array';\r
+ case 'double':\r
+ return 'float';\r
+ case 'undefined':\r
+ return 'mixed';\r
+ case 'boolean':\r
+ case 'null':\r
+ default:\r
+ // unknown: might be any xmlrpc type\r
+ return strtolower($xmlrpctype);\r
+ }\r
+}\r
+\r
+/**\r
+* Given a user-defined PHP function, create a PHP 'wrapper' function that can\r
+* be exposed as xmlrpc method from an xmlrpc_server object and called from remote\r
+* clients (as well as its corresponding signature info).\r
+*\r
+* Since php is a typeless language, to infer types of input and output parameters,\r
+* it relies on parsing the javadoc-style comment block associated with the given\r
+* function. Usage of xmlrpc native types (such as datetime.dateTime.iso8601 and base64)\r
+* in the @param tag is also allowed, if you need the php function to receive/send\r
+* data in that particular format (note that base64 encoding/decoding is transparently\r
+* carried out by the lib, while datetime vals are passed around as strings)\r
+*\r
+* Known limitations:\r
+* - only works for user-defined functions, not for PHP internal functions\r
+* (reflection does not support retrieving number/type of params for those)\r
+* - functions returning php objects will generate special xmlrpc responses:\r
+* when the xmlrpc decoding of those responses is carried out by this same lib, using\r
+* the appropriate param in php_xmlrpc_decode, the php objects will be rebuilt.\r
+* In short: php objects can be serialized, too (except for their resource members),\r
+* using this function.\r
+* Other libs might choke on the very same xml that will be generated in this case\r
+* (i.e. it has a nonstandard attribute on struct element tags)\r
+* - usage of javadoc @param tags using param names in a different order from the\r
+* function prototype is not considered valid (to be fixed?)\r
+*\r
+* Note that since rel. 2.0RC3 the preferred method to have the server call 'standard'\r
+* php functions (ie. functions not expecting a single xmlrpcmsg obj as parameter)\r
+* is by making use of the functions_parameters_type class member.\r
+*\r
+* @param string $funcname the name of the PHP user function to be exposed as xmlrpc method; array($obj, 'methodname') and array('class', 'methodname') are ok too\r
+* @param string $newfuncname (optional) name for function to be created\r
+* @param array $extra_options (optional) array of options for conversion. valid values include:\r
+* bool return_source when true, php code w. function definition will be returned, not evaluated\r
+* bool encode_php_objs let php objects be sent to server using the 'improved' xmlrpc notation, so server can deserialize them as php objects\r
+* bool decode_php_objs --- WARNING !!! possible security hazard. only use it with trusted servers ---\r
+* bool suppress_warnings remove from produced xml any runtime warnings due to the php function being invoked\r
+* @return false on error, or an array containing the name of the new php function,\r
+* its signature and docs, to be used in the server dispatch map\r
+*\r
+* @todo decide how to deal with params passed by ref: bomb out or allow?\r
+* @todo finish using javadoc info to build method sig if all params are named but out of order\r
+* @todo add a check for params of 'resource' type\r
+* @todo add some trigger_errors / error_log when returning false?\r
+* @todo what to do when the PHP function returns NULL? we are currently returning an empty string value...\r
+* @todo add an option to suppress php warnings in invocation of user function, similar to server debug level 3?\r
+* @todo if $newfuncname is empty, we could use create_user_func instead of eval, as it is possibly faster\r
+* @todo add a verbatim_object_copy parameter to allow avoiding the same obj instance?\r
+*/\r
+function wrap_php_function($funcname, $newfuncname='', $extra_options=array())\r
+{\r
+ $buildit = isset($extra_options['return_source']) ? !($extra_options['return_source']) : true;\r
+ $prefix = isset($extra_options['prefix']) ? $extra_options['prefix'] : 'xmlrpc';\r
+ $encode_php_objects = isset($extra_options['encode_php_objs']) ? (bool)$extra_options['encode_php_objs'] : false;\r
+ $decode_php_objects = isset($extra_options['decode_php_objs']) ? (bool)$extra_options['decode_php_objs'] : false;\r
+ $catch_warnings = isset($extra_options['suppress_warnings']) && $extra_options['suppress_warnings'] ? '@' : '';\r
+\r
+ $exists = false;\r
+ if (is_string($funcname) && strpos($funcname, '::') !== false)\r
+ {\r
+ $funcname = explode('::', $funcname);\r
+ }\r
+ if(is_array($funcname))\r
+ {\r
+ if(count($funcname) < 2 || (!is_string($funcname[0]) && !is_object($funcname[0])))\r
+ {\r
+ error_log('XML-RPC: syntax for function to be wrapped is wrong');\r
+ return false;\r
+ }\r
+ if(is_string($funcname[0]))\r
+ {\r
+ $plainfuncname = implode('::', $funcname);\r
+ }\r
+ elseif(is_object($funcname[0]))\r
+ {\r
+ $plainfuncname = get_class($funcname[0]) . '->' . $funcname[1];\r
+ }\r
+ $exists = method_exists($funcname[0], $funcname[1]);\r
+ }\r
+ else\r
+ {\r
+ $plainfuncname = $funcname;\r
+ $exists = function_exists($funcname);\r
+ }\r
+\r
+ if(!$exists)\r
+ {\r
+ error_log('XML-RPC: function to be wrapped is not defined: '.$plainfuncname);\r
+ return false;\r
+ }\r
+ else\r
+ {\r
+ // determine name of new php function\r
+ if($newfuncname == '')\r
+ {\r
+ if(is_array($funcname))\r
+ {\r
+ if(is_string($funcname[0]))\r
+ $xmlrpcfuncname = "{$prefix}_".implode('_', $funcname);\r
+ else\r
+ $xmlrpcfuncname = "{$prefix}_".get_class($funcname[0]) . '_' . $funcname[1];\r
+ }\r
+ else\r
+ {\r
+ $xmlrpcfuncname = "{$prefix}_$funcname";\r
+ }\r
+ }\r
+ else\r
+ {\r
+ $xmlrpcfuncname = $newfuncname;\r
+ }\r
+ while($buildit && function_exists($xmlrpcfuncname))\r
+ {\r
+ $xmlrpcfuncname .= 'x';\r
+ }\r
+\r
+ // start to introspect PHP code\r
if(is_array($funcname))\r
{\r
- if(count($funcname) < 2 || (!is_string($funcname[0]) && !is_object($funcname[0])))\r
+ $func = new ReflectionMethod($funcname[0], $funcname[1]);\r
+ if($func->isPrivate())\r
+ {\r
+ error_log('XML-RPC: method to be wrapped is private: '.$plainfuncname);\r
+ return false;\r
+ }\r
+ if($func->isProtected())\r
+ {\r
+ error_log('XML-RPC: method to be wrapped is protected: '.$plainfuncname);\r
+ return false;\r
+ }\r
+ if($func->isConstructor())\r
{\r
- error_log('XML-RPC: syntax for function to be wrapped is wrong');\r
- return false;\r
+ error_log('XML-RPC: method to be wrapped is the constructor: '.$plainfuncname);\r
+ return false;\r
}\r
- if(is_string($funcname[0]))\r
+ if($func->isDestructor())\r
+ {\r
+ error_log('XML-RPC: method to be wrapped is the destructor: '.$plainfuncname);\r
+ return false;\r
+ }\r
+ if($func->isAbstract())\r
+ {\r
+ error_log('XML-RPC: method to be wrapped is abstract: '.$plainfuncname);\r
+ return false;\r
+ }\r
+ /// @todo add more checks for static vs. nonstatic?\r
+ }\r
+ else\r
+ {\r
+ $func = new ReflectionFunction($funcname);\r
+ }\r
+ if($func->isInternal())\r
+ {\r
+ // Note: from PHP 5.1.0 onward, we will possibly be able to use invokeargs\r
+ // instead of getparameters to fully reflect internal php functions ?\r
+ error_log('XML-RPC: function to be wrapped is internal: '.$plainfuncname);\r
+ return false;\r
+ }\r
+\r
+ // retrieve parameter names, types and description from javadoc comments\r
+\r
+ // function description\r
+ $desc = '';\r
+ // type of return val: by default 'any'\r
+ $returns = $GLOBALS['xmlrpcValue'];\r
+ // desc of return val\r
+ $returnsDocs = '';\r
+ // type + name of function parameters\r
+ $paramDocs = array();\r
+\r
+ $docs = $func->getDocComment();\r
+ if($docs != '')\r
+ {\r
+ $docs = explode("\n", $docs);\r
+ $i = 0;\r
+ foreach($docs as $doc)\r
+ {\r
+ $doc = trim($doc, " \r\t/*");\r
+ if(strlen($doc) && strpos($doc, '@') !== 0 && !$i)\r
+ {\r
+ if($desc)\r
+ {\r
+ $desc .= "\n";\r
+ }\r
+ $desc .= $doc;\r
+ }\r
+ elseif(strpos($doc, '@param') === 0)\r
+ {\r
+ // syntax: @param type [$name] desc\r
+ if(preg_match('/@param\s+(\S+)(\s+\$\S+)?\s+(.+)/', $doc, $matches))\r
+ {\r
+ if(strpos($matches[1], '|'))\r
+ {\r
+ //$paramDocs[$i]['type'] = explode('|', $matches[1]);\r
+ $paramDocs[$i]['type'] = 'mixed';\r
+ }\r
+ else\r
+ {\r
+ $paramDocs[$i]['type'] = $matches[1];\r
+ }\r
+ $paramDocs[$i]['name'] = trim($matches[2]);\r
+ $paramDocs[$i]['doc'] = $matches[3];\r
+ }\r
+ $i++;\r
+ }\r
+ elseif(strpos($doc, '@return') === 0)\r
+ {\r
+ // syntax: @return type desc\r
+ //$returns = preg_split('/\s+/', $doc);\r
+ if(preg_match('/@return\s+(\S+)\s+(.+)/', $doc, $matches))\r
+ {\r
+ $returns = php_2_xmlrpc_type($matches[1]);\r
+ if(isset($matches[2]))\r
+ {\r
+ $returnsDocs = $matches[2];\r
+ }\r
+ }\r
+ }\r
+ }\r
+ }\r
+\r
+ // execute introspection of actual function prototype\r
+ $params = array();\r
+ $i = 0;\r
+ foreach($func->getParameters() as $paramobj)\r
+ {\r
+ $params[$i] = array();\r
+ $params[$i]['name'] = '$'.$paramobj->getName();\r
+ $params[$i]['isoptional'] = $paramobj->isOptional();\r
+ $i++;\r
+ }\r
+\r
+\r
+ // start building of PHP code to be eval'd\r
+ $innercode = '';\r
+ $i = 0;\r
+ $parsvariations = array();\r
+ $pars = array();\r
+ $pnum = count($params);\r
+ foreach($params as $param)\r
+ {\r
+ if (isset($paramDocs[$i]['name']) && $paramDocs[$i]['name'] && strtolower($paramDocs[$i]['name']) != strtolower($param['name']))\r
+ {\r
+ // param name from phpdoc info does not match param definition!\r
+ $paramDocs[$i]['type'] = 'mixed';\r
+ }\r
+\r
+ if($param['isoptional'])\r
+ {\r
+ // this particular parameter is optional. save as valid previous list of parameters\r
+ $innercode .= "if (\$paramcount > $i) {\n";\r
+ $parsvariations[] = $pars;\r
+ }\r
+ $innercode .= "\$p$i = \$msg->getParam($i);\n";\r
+ if ($decode_php_objects)\r
+ {\r
+ $innercode .= "if (\$p{$i}->kindOf() == 'scalar') \$p$i = \$p{$i}->scalarval(); else \$p$i = php_{$prefix}_decode(\$p$i, array('decode_php_objs'));\n";\r
+ }\r
+ else\r
+ {\r
+ $innercode .= "if (\$p{$i}->kindOf() == 'scalar') \$p$i = \$p{$i}->scalarval(); else \$p$i = php_{$prefix}_decode(\$p$i);\n";\r
+ }\r
+\r
+ $pars[] = "\$p$i";\r
+ $i++;\r
+ if($param['isoptional'])\r
+ {\r
+ $innercode .= "}\n";\r
+ }\r
+ if($i == $pnum)\r
+ {\r
+ // last allowed parameters combination\r
+ $parsvariations[] = $pars;\r
+ }\r
+ }\r
+\r
+ $sigs = array();\r
+ $psigs = array();\r
+ if(count($parsvariations) == 0)\r
+ {\r
+ // only known good synopsis = no parameters\r
+ $parsvariations[] = array();\r
+ $minpars = 0;\r
+ }\r
+ else\r
+ {\r
+ $minpars = count($parsvariations[0]);\r
+ }\r
+\r
+ if($minpars)\r
+ {\r
+ // add to code the check for min params number\r
+ // NB: this check needs to be done BEFORE decoding param values\r
+ $innercode = "\$paramcount = \$msg->getNumParams();\n" .\r
+ "if (\$paramcount < $minpars) return new {$prefix}resp(0, {$GLOBALS['xmlrpcerr']['incorrect_params']}, '{$GLOBALS['xmlrpcstr']['incorrect_params']}');\n" . $innercode;\r
+ }\r
+ else\r
+ {\r
+ $innercode = "\$paramcount = \$msg->getNumParams();\n" . $innercode;\r
+ }\r
+\r
+ $innercode .= "\$np = false;\n";\r
+ // since there are no closures in php, if we are given an object instance,\r
+ // we store a pointer to it in a global var...\r
+ if ( is_array($funcname) && is_object($funcname[0]) )\r
+ {\r
+ $GLOBALS['xmlrpcWPFObjHolder'][$xmlrpcfuncname] =& $funcname[0];\r
+ $innercode .= "\$obj =& \$GLOBALS['xmlrpcWPFObjHolder']['$xmlrpcfuncname'];\n";\r
+ $realfuncname = '$obj->'.$funcname[1];\r
+ }\r
+ else\r
+ {\r
+ $realfuncname = $plainfuncname;\r
+ }\r
+ foreach($parsvariations as $pars)\r
+ {\r
+ $innercode .= "if (\$paramcount == " . count($pars) . ") \$retval = {$catch_warnings}$realfuncname(" . implode(',', $pars) . "); else\n";\r
+ // build a 'generic' signature (only use an appropriate return type)\r
+ $sig = array($returns);\r
+ $psig = array($returnsDocs);\r
+ for($i=0; $i < count($pars); $i++)\r
+ {\r
+ if (isset($paramDocs[$i]['type']))\r
+ {\r
+ $sig[] = php_2_xmlrpc_type($paramDocs[$i]['type']);\r
+ }\r
+ else\r
+ {\r
+ $sig[] = $GLOBALS['xmlrpcValue'];\r
+ }\r
+ $psig[] = isset($paramDocs[$i]['doc']) ? $paramDocs[$i]['doc'] : '';\r
+ }\r
+ $sigs[] = $sig;\r
+ $psigs[] = $psig;\r
+ }\r
+ $innercode .= "\$np = true;\n";\r
+ $innercode .= "if (\$np) return new {$prefix}resp(0, {$GLOBALS['xmlrpcerr']['incorrect_params']}, '{$GLOBALS['xmlrpcstr']['incorrect_params']}'); else {\n";\r
+ //$innercode .= "if (\$_xmlrpcs_error_occurred) return new xmlrpcresp(0, $GLOBALS['xmlrpcerr']user, \$_xmlrpcs_error_occurred); else\n";\r
+ $innercode .= "if (is_a(\$retval, '{$prefix}resp')) return \$retval; else\n";\r
+ if($returns == $GLOBALS['xmlrpcDateTime'] || $returns == $GLOBALS['xmlrpcBase64'])\r
+ {\r
+ $innercode .= "return new {$prefix}resp(new {$prefix}val(\$retval, '$returns'));";\r
+ }\r
+ else\r
+ {\r
+ if ($encode_php_objects)\r
+ $innercode .= "return new {$prefix}resp(php_{$prefix}_encode(\$retval, array('encode_php_objs')));\n";\r
+ else\r
+ $innercode .= "return new {$prefix}resp(php_{$prefix}_encode(\$retval));\n";\r
+ }\r
+ // shall we exclude functions returning by ref?\r
+ // if($func->returnsReference())\r
+ // return false;\r
+ $code = "function $xmlrpcfuncname(\$msg) {\n" . $innercode . "}\n}";\r
+ //print_r($code);\r
+ if ($buildit)\r
+ {\r
+ $allOK = 0;\r
+ eval($code.'$allOK=1;');\r
+ // alternative\r
+ //$xmlrpcfuncname = create_function('$m', $innercode);\r
+\r
+ if(!$allOK)\r
{\r
- $plainfuncname = implode('::', $funcname);\r
+ error_log('XML-RPC: could not create function '.$xmlrpcfuncname.' to wrap php function '.$plainfuncname);\r
+ return false;\r
}\r
- elseif(is_object($funcname[0]))\r
+ }\r
+\r
+ /// @todo examine if $paramDocs matches $parsvariations and build array for\r
+ /// usage as method signature, plus put together a nice string for docs\r
+\r
+ $ret = array('function' => $xmlrpcfuncname, 'signature' => $sigs, 'docstring' => $desc, 'signature_docs' => $psigs, 'source' => $code);\r
+ return $ret;\r
+ }\r
+}\r
+\r
+/**\r
+* Given a user-defined PHP class or php object, map its methods onto a list of\r
+* PHP 'wrapper' functions that can be exposed as xmlrpc methods from an xmlrpc_server\r
+* object and called from remote clients (as well as their corresponding signature info).\r
+*\r
+* @param mixed $classname the name of the class whose methods are to be exposed as xmlrpc methods, or an object instance of that class\r
+* @param array $extra_options see the docs for wrap_php_method for more options\r
+* string method_type 'static', 'nonstatic', 'all' and 'auto' (default); the latter will switch between static and non-static depending on wheter $classname is a class name or object instance\r
+* @return array or false on failure\r
+*\r
+* @todo get_class_methods will return both static and non-static methods.\r
+* we have to differentiate the action, depending on wheter we recived a class name or object\r
+*/\r
+function wrap_php_class($classname, $extra_options=array())\r
+{\r
+ $methodfilter = isset($extra_options['method_filter']) ? $extra_options['method_filter'] : '';\r
+ $methodtype = isset($extra_options['method_type']) ? $extra_options['method_type'] : 'auto';\r
+\r
+ $result = array();\r
+ $mlist = get_class_methods($classname);\r
+ foreach($mlist as $mname)\r
+ {\r
+ if ($methodfilter == '' || preg_match($methodfilter, $mname))\r
+ {\r
+ // echo $mlist."\n";\r
+ $func = new ReflectionMethod($classname, $mname);\r
+ if(!$func->isPrivate() && !$func->isProtected() && !$func->isConstructor() && !$func->isDestructor() && !$func->isAbstract())\r
{\r
- $plainfuncname = get_class($funcname[0]) . '->' . $funcname[1];\r
+ if(($func->isStatic && ($methodtype == 'all' || $methodtype == 'static' || ($methodtype == 'auto' && is_string($classname)))) ||\r
+ (!$func->isStatic && ($methodtype == 'all' || $methodtype == 'nonstatic' || ($methodtype == 'auto' && is_object($classname)))))\r
+ {\r
+ $methodwrap = wrap_php_function(array($classname, $mname), '', $extra_options);\r
+ if ( $methodwrap )\r
+ {\r
+ $result[$methodwrap['function']] = $methodwrap['function'];\r
+ }\r
+ }\r
}\r
- $exists = method_exists($funcname[0], $funcname[1]);\r
+ }\r
+ }\r
+ return $result;\r
+}\r
+\r
+/**\r
+* Given an xmlrpc client and a method name, register a php wrapper function\r
+* that will call it and return results using native php types for both\r
+* params and results. The generated php function will return an xmlrpcresp\r
+* oject for failed xmlrpc calls\r
+*\r
+* Known limitations:\r
+* - server must support system.methodsignature for the wanted xmlrpc method\r
+* - for methods that expose many signatures, only one can be picked (we\r
+* could in priciple check if signatures differ only by number of params\r
+* and not by type, but it would be more complication than we can spare time)\r
+* - nested xmlrpc params: the caller of the generated php function has to\r
+* encode on its own the params passed to the php function if these are structs\r
+* or arrays whose (sub)members include values of type datetime or base64\r
+*\r
+* Notes: the connection properties of the given client will be copied\r
+* and reused for the connection used during the call to the generated\r
+* php function.\r
+* Calling the generated php function 'might' be slow: a new xmlrpc client\r
+* is created on every invocation and an xmlrpc-connection opened+closed.\r
+* An extra 'debug' param is appended to param list of xmlrpc method, useful\r
+* for debugging purposes.\r
+*\r
+* @param xmlrpc_client $client an xmlrpc client set up correctly to communicate with target server\r
+* @param string $methodname the xmlrpc method to be mapped to a php function\r
+* @param array $extra_options array of options that specify conversion details. valid ptions include\r
+* integer signum the index of the method signature to use in mapping (if method exposes many sigs)\r
+* integer timeout timeout (in secs) to be used when executing function/calling remote method\r
+* string protocol 'http' (default), 'http11' or 'https'\r
+* string new_function_name the name of php function to create. If unsepcified, lib will pick an appropriate name\r
+* string return_source if true return php code w. function definition instead fo function name\r
+* bool encode_php_objs let php objects be sent to server using the 'improved' xmlrpc notation, so server can deserialize them as php objects\r
+* bool decode_php_objs --- WARNING !!! possible security hazard. only use it with trusted servers ---\r
+* mixed return_on_fault a php value to be returned when the xmlrpc call fails/returns a fault response (by default the xmlrpcresp object is returned in this case). If a string is used, '%faultCode%' and '%faultString%' tokens will be substituted with actual error values\r
+* bool debug set it to 1 or 2 to see debug results of querying server for method synopsis\r
+* @return string the name of the generated php function (or false) - OR AN ARRAY...\r
+*/\r
+function wrap_xmlrpc_method($client, $methodname, $extra_options=0, $timeout=0, $protocol='', $newfuncname='')\r
+{\r
+ // mind numbing: let caller use sane calling convention (as per javadoc, 3 params),\r
+ // OR the 2.0 calling convention (no options) - we really love backward compat, don't we?\r
+ if (!is_array($extra_options))\r
+ {\r
+ $signum = $extra_options;\r
+ $extra_options = array();\r
+ }\r
+ else\r
+ {\r
+ $signum = isset($extra_options['signum']) ? (int)$extra_options['signum'] : 0;\r
+ $timeout = isset($extra_options['timeout']) ? (int)$extra_options['timeout'] : 0;\r
+ $protocol = isset($extra_options['protocol']) ? $extra_options['protocol'] : '';\r
+ $newfuncname = isset($extra_options['new_function_name']) ? $extra_options['new_function_name'] : '';\r
+ }\r
+ //$encode_php_objects = in_array('encode_php_objects', $extra_options);\r
+ //$verbatim_client_copy = in_array('simple_client_copy', $extra_options) ? 1 :\r
+ // in_array('build_class_code', $extra_options) ? 2 : 0;\r
+\r
+ $encode_php_objects = isset($extra_options['encode_php_objs']) ? (bool)$extra_options['encode_php_objs'] : false;\r
+ $decode_php_objects = isset($extra_options['decode_php_objs']) ? (bool)$extra_options['decode_php_objs'] : false;\r
+ $simple_client_copy = isset($extra_options['simple_client_copy']) ? (int)($extra_options['simple_client_copy']) : 0;\r
+ $buildit = isset($extra_options['return_source']) ? !($extra_options['return_source']) : true;\r
+ $prefix = isset($extra_options['prefix']) ? $extra_options['prefix'] : 'xmlrpc';\r
+ if (isset($extra_options['return_on_fault']))\r
+ {\r
+ $decode_fault = true;\r
+ $fault_response = $extra_options['return_on_fault'];\r
+ }\r
+ else\r
+ {\r
+ $decode_fault = false;\r
+ $fault_response = '';\r
+ }\r
+ $debug = isset($extra_options['debug']) ? ($extra_options['debug']) : 0;\r
+\r
+ $msgclass = $prefix.'msg';\r
+ $valclass = $prefix.'val';\r
+ $decodefunc = 'php_'.$prefix.'_decode';\r
+\r
+ $msg = new $msgclass('system.methodSignature');\r
+ $msg->addparam(new $valclass($methodname));\r
+ $client->setDebug($debug);\r
+ $response =& $client->send($msg, $timeout, $protocol);\r
+ if($response->faultCode())\r
+ {\r
+ error_log('XML-RPC: could not retrieve method signature from remote server for method '.$methodname);\r
+ return false;\r
+ }\r
+ else\r
+ {\r
+ $msig = $response->value();\r
+ if ($client->return_type != 'phpvals')\r
+ {\r
+ $msig = $decodefunc($msig);\r
+ }\r
+ if(!is_array($msig) || count($msig) <= $signum)\r
+ {\r
+ error_log('XML-RPC: could not retrieve method signature nr.'.$signum.' from remote server for method '.$methodname);\r
+ return false;\r
}\r
else\r
{\r
- $plainfuncname = $funcname;\r
- $exists = function_exists($funcname);\r
- }\r
-\r
- if(!$exists)\r
- {\r
- error_log('XML-RPC: function to be wrapped is not defined: '.$plainfuncname);\r
- return false;\r
- }\r
- else\r
- {\r
- // determine name of new php function\r
- if($newfuncname == '')\r
- {\r
- if(is_array($funcname))\r
- {\r
- if(is_string($funcname[0]))\r
- $xmlrpcfuncname = "{$prefix}_".implode('_', $funcname);\r
- else\r
- $xmlrpcfuncname = "{$prefix}_".get_class($funcname[0]) . '_' . $funcname[1];\r
- }\r
- else\r
- {\r
- $xmlrpcfuncname = "{$prefix}_$funcname";\r
- }\r
- }\r
- else\r
- {\r
- $xmlrpcfuncname = $newfuncname;\r
- }\r
- while($buildit && function_exists($xmlrpcfuncname))\r
- {\r
- $xmlrpcfuncname .= 'x';\r
- }\r
-\r
- // start to introspect PHP code\r
- if(is_array($funcname))\r
- {\r
- $func = new ReflectionMethod($funcname[0], $funcname[1]);\r
- if($func->isPrivate())\r
- {\r
- error_log('XML-RPC: method to be wrapped is private: '.$plainfuncname);\r
- return false;\r
- }\r
- if($func->isProtected())\r
- {\r
- error_log('XML-RPC: method to be wrapped is protected: '.$plainfuncname);\r
- return false;\r
- }\r
- if($func->isConstructor())\r
- {\r
- error_log('XML-RPC: method to be wrapped is the constructor: '.$plainfuncname);\r
- return false;\r
- }\r
- if($func->isDestructor())\r
- {\r
- error_log('XML-RPC: method to be wrapped is the destructor: '.$plainfuncname);\r
- return false;\r
- }\r
- if($func->isAbstract())\r
- {\r
- error_log('XML-RPC: method to be wrapped is abstract: '.$plainfuncname);\r
- return false;\r
- }\r
- /// @todo add more checks for static vs. nonstatic?\r
- }\r
- else\r
- {\r
- $func = new ReflectionFunction($funcname);\r
- }\r
- if($func->isInternal())\r
- {\r
- // Note: from PHP 5.1.0 onward, we will possibly be able to use invokeargs\r
- // instead of getparameters to fully reflect internal php functions ?\r
- error_log('XML-RPC: function to be wrapped is internal: '.$plainfuncname);\r
- return false;\r
- }\r
-\r
- // retrieve parameter names, types and description from javadoc comments\r
-\r
- // function description\r
- $desc = '';\r
- // type of return val: by default 'any'\r
- $returns = $GLOBALS['xmlrpcValue'];\r
- // desc of return val\r
- $returnsDocs = '';\r
- // type + name of function parameters\r
- $paramDocs = array();\r
-\r
- $docs = $func->getDocComment();\r
- if($docs != '')\r
- {\r
- $docs = explode("\n", $docs);\r
- $i = 0;\r
- foreach($docs as $doc)\r
- {\r
- $doc = trim($doc, " \r\t/*");\r
- if(strlen($doc) && strpos($doc, '@') !== 0 && !$i)\r
- {\r
- if($desc)\r
- {\r
- $desc .= "\n";\r
- }\r
- $desc .= $doc;\r
- }\r
- elseif(strpos($doc, '@param') === 0)\r
- {\r
- // syntax: @param type [$name] desc\r
- if(preg_match('/@param\s+(\S+)(\s+\$\S+)?\s+(.+)/', $doc, $matches))\r
- {\r
- if(strpos($matches[1], '|'))\r
- {\r
- //$paramDocs[$i]['type'] = explode('|', $matches[1]);\r
- $paramDocs[$i]['type'] = 'mixed';\r
- }\r
- else\r
- {\r
- $paramDocs[$i]['type'] = $matches[1];\r
- }\r
- $paramDocs[$i]['name'] = trim($matches[2]);\r
- $paramDocs[$i]['doc'] = $matches[3];\r
- }\r
- $i++;\r
- }\r
- elseif(strpos($doc, '@return') === 0)\r
- {\r
- // syntax: @return type desc\r
- //$returns = preg_split('/\s+/', $doc);\r
- if(preg_match('/@return\s+(\S+)\s+(.+)/', $doc, $matches))\r
- {\r
- $returns = php_2_xmlrpc_type($matches[1]);\r
- if(isset($matches[2]))\r
- {\r
- $returnsDocs = $matches[2];\r
- }\r
- }\r
- }\r
- }\r
- }\r
-\r
- // execute introspection of actual function prototype\r
- $params = array();\r
- $i = 0;\r
- foreach($func->getParameters() as $paramobj)\r
- {\r
- $params[$i] = array();\r
- $params[$i]['name'] = '$'.$paramobj->getName();\r
- $params[$i]['isoptional'] = $paramobj->isOptional();\r
- $i++;\r
- }\r
-\r
-\r
- // start building of PHP code to be eval'd\r
- $innercode = '';\r
- $i = 0;\r
- $parsvariations = array();\r
- $pars = array();\r
- $pnum = count($params);\r
- foreach($params as $param)\r
- {\r
- if (isset($paramDocs[$i]['name']) && $paramDocs[$i]['name'] && strtolower($paramDocs[$i]['name']) != strtolower($param['name']))\r
- {\r
- // param name from phpdoc info does not match param definition!\r
- $paramDocs[$i]['type'] = 'mixed';\r
- }\r
-\r
- if($param['isoptional'])\r
- {\r
- // this particular parameter is optional. save as valid previous list of parameters\r
- $innercode .= "if (\$paramcount > $i) {\n";\r
- $parsvariations[] = $pars;\r
- }\r
- $innercode .= "\$p$i = \$msg->getParam($i);\n";\r
- if ($decode_php_objects)\r
- {\r
- $innercode .= "if (\$p{$i}->kindOf() == 'scalar') \$p$i = \$p{$i}->scalarval(); else \$p$i = php_{$prefix}_decode(\$p$i, array('decode_php_objs'));\n";\r
- }\r
- else\r
- {\r
- $innercode .= "if (\$p{$i}->kindOf() == 'scalar') \$p$i = \$p{$i}->scalarval(); else \$p$i = php_{$prefix}_decode(\$p$i);\n";\r
- }\r
-\r
- $pars[] = "\$p$i";\r
- $i++;\r
- if($param['isoptional'])\r
- {\r
- $innercode .= "}\n";\r
- }\r
- if($i == $pnum)\r
- {\r
- // last allowed parameters combination\r
- $parsvariations[] = $pars;\r
- }\r
- }\r
-\r
- $sigs = array();\r
- $psigs = array();\r
- if(count($parsvariations) == 0)\r
- {\r
- // only known good synopsis = no parameters\r
- $parsvariations[] = array();\r
- $minpars = 0;\r
- }\r
- else\r
- {\r
- $minpars = count($parsvariations[0]);\r
- }\r
-\r
- if($minpars)\r
- {\r
- // add to code the check for min params number\r
- // NB: this check needs to be done BEFORE decoding param values\r
- $innercode = "\$paramcount = \$msg->getNumParams();\n" .\r
- "if (\$paramcount < $minpars) return new {$prefix}resp(0, {$GLOBALS['xmlrpcerr']['incorrect_params']}, '{$GLOBALS['xmlrpcstr']['incorrect_params']}');\n" . $innercode;\r
- }\r
- else\r
- {\r
- $innercode = "\$paramcount = \$msg->getNumParams();\n" . $innercode;\r
- }\r
-\r
- $innercode .= "\$np = false;\n";\r
- // since there are no closures in php, if we are given an object instance,\r
- // we store a pointer to it in a global var...\r
- if ( is_array($funcname) && is_object($funcname[0]) )\r
- {\r
- $GLOBALS['xmlrpcWPFObjHolder'][$xmlrpcfuncname] =& $funcname[0];\r
- $innercode .= "\$obj =& \$GLOBALS['xmlrpcWPFObjHolder']['$xmlrpcfuncname'];\n";\r
- $realfuncname = '$obj->'.$funcname[1];\r
- }\r
- else\r
- {\r
- $realfuncname = $plainfuncname;\r
- }\r
- foreach($parsvariations as $pars)\r
- {\r
- $innercode .= "if (\$paramcount == " . count($pars) . ") \$retval = {$catch_warnings}$realfuncname(" . implode(',', $pars) . "); else\n";\r
- // build a 'generic' signature (only use an appropriate return type)\r
- $sig = array($returns);\r
- $psig = array($returnsDocs);\r
- for($i=0; $i < count($pars); $i++)\r
- {\r
- if (isset($paramDocs[$i]['type']))\r
- {\r
- $sig[] = php_2_xmlrpc_type($paramDocs[$i]['type']);\r
- }\r
- else\r
- {\r
- $sig[] = $GLOBALS['xmlrpcValue'];\r
- }\r
- $psig[] = isset($paramDocs[$i]['doc']) ? $paramDocs[$i]['doc'] : '';\r
- }\r
- $sigs[] = $sig;\r
- $psigs[] = $psig;\r
- }\r
- $innercode .= "\$np = true;\n";\r
- $innercode .= "if (\$np) return new {$prefix}resp(0, {$GLOBALS['xmlrpcerr']['incorrect_params']}, '{$GLOBALS['xmlrpcstr']['incorrect_params']}'); else {\n";\r
- //$innercode .= "if (\$_xmlrpcs_error_occurred) return new xmlrpcresp(0, $GLOBALS['xmlrpcerr']user, \$_xmlrpcs_error_occurred); else\n";\r
- $innercode .= "if (is_a(\$retval, '{$prefix}resp')) return \$retval; else\n";\r
- if($returns == $GLOBALS['xmlrpcDateTime'] || $returns == $GLOBALS['xmlrpcBase64'])\r
- {\r
- $innercode .= "return new {$prefix}resp(new {$prefix}val(\$retval, '$returns'));";\r
- }\r
- else\r
- {\r
- if ($encode_php_objects)\r
- $innercode .= "return new {$prefix}resp(php_{$prefix}_encode(\$retval, array('encode_php_objs')));\n";\r
- else\r
- $innercode .= "return new {$prefix}resp(php_{$prefix}_encode(\$retval));\n";\r
- }\r
- // shall we exclude functions returning by ref?\r
- // if($func->returnsReference())\r
- // return false;\r
- $code = "function $xmlrpcfuncname(\$msg) {\n" . $innercode . "}\n}";\r
- //print_r($code);\r
- if ($buildit)\r
- {\r
- $allOK = 0;\r
- eval($code.'$allOK=1;');\r
- // alternative\r
- //$xmlrpcfuncname = create_function('$m', $innercode);\r
-\r
- if(!$allOK)\r
- {\r
- error_log('XML-RPC: could not create function '.$xmlrpcfuncname.' to wrap php function '.$plainfuncname);\r
- return false;\r
- }\r
- }\r
-\r
- /// @todo examine if $paramDocs matches $parsvariations and build array for\r
- /// usage as method signature, plus put together a nice string for docs\r
-\r
- $ret = array('function' => $xmlrpcfuncname, 'signature' => $sigs, 'docstring' => $desc, 'signature_docs' => $psigs, 'source' => $code);\r
- return $ret;\r
- }\r
- }\r
-\r
- /**\r
- * Given a user-defined PHP class or php object, map its methods onto a list of\r
- * PHP 'wrapper' functions that can be exposed as xmlrpc methods from an xmlrpc_server\r
- * object and called from remote clients (as well as their corresponding signature info).\r
- *\r
- * @param mixed $classname the name of the class whose methods are to be exposed as xmlrpc methods, or an object instance of that class\r
- * @param array $extra_options see the docs for wrap_php_method for more options\r
- * string method_type 'static', 'nonstatic', 'all' and 'auto' (default); the latter will switch between static and non-static depending on wheter $classname is a class name or object instance\r
- * @return array or false on failure\r
- *\r
- * @todo get_class_methods will return both static and non-static methods.\r
- * we have to differentiate the action, depending on wheter we recived a class name or object\r
- */\r
- function wrap_php_class($classname, $extra_options=array())\r
+ // pick a suitable name for the new function, avoiding collisions\r
+ if($newfuncname != '')\r
+ {\r
+ $xmlrpcfuncname = $newfuncname;\r
+ }\r
+ else\r
+ {\r
+ // take care to insure that methodname is translated to valid\r
+ // php function name\r
+ $xmlrpcfuncname = $prefix.'_'.preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'),\r
+ array('_', ''), $methodname);\r
+ }\r
+ while($buildit && function_exists($xmlrpcfuncname))\r
+ {\r
+ $xmlrpcfuncname .= 'x';\r
+ }\r
+\r
+ $msig = $msig[$signum];\r
+ $mdesc = '';\r
+ // if in 'offline' mode, get method description too.\r
+ // in online mode, favour speed of operation\r
+ if(!$buildit)\r
+ {\r
+ $msg = new $msgclass('system.methodHelp');\r
+ $msg->addparam(new $valclass($methodname));\r
+ $response =& $client->send($msg, $timeout, $protocol);\r
+ if (!$response->faultCode())\r
+ {\r
+ $mdesc = $response->value();\r
+ if ($client->return_type != 'phpvals')\r
+ {\r
+ $mdesc = $mdesc->scalarval();\r
+ }\r
+ }\r
+ }\r
+\r
+ $results = build_remote_method_wrapper_code($client, $methodname,\r
+ $xmlrpcfuncname, $msig, $mdesc, $timeout, $protocol, $simple_client_copy,\r
+ $prefix, $decode_php_objects, $encode_php_objects, $decode_fault,\r
+ $fault_response);\r
+\r
+ //print_r($code);\r
+ if ($buildit)\r
+ {\r
+ $allOK = 0;\r
+ eval($results['source'].'$allOK=1;');\r
+ // alternative\r
+ //$xmlrpcfuncname = create_function('$m', $innercode);\r
+ if($allOK)\r
+ {\r
+ return $xmlrpcfuncname;\r
+ }\r
+ else\r
+ {\r
+ error_log('XML-RPC: could not create function '.$xmlrpcfuncname.' to wrap remote method '.$methodname);\r
+ return false;\r
+ }\r
+ }\r
+ else\r
+ {\r
+ $results['function'] = $xmlrpcfuncname;\r
+ return $results;\r
+ }\r
+ }\r
+ }\r
+}\r
+\r
+/**\r
+* Similar to wrap_xmlrpc_method, but will generate a php class that wraps\r
+* all xmlrpc methods exposed by the remote server as own methods.\r
+* For more details see wrap_xmlrpc_method.\r
+* @param xmlrpc_client $client the client obj all set to query the desired server\r
+* @param array $extra_options list of options for wrapped code\r
+* @return mixed false on error, the name of the created class if all ok or an array with code, class name and comments (if the appropriatevoption is set in extra_options)\r
+*/\r
+function wrap_xmlrpc_server($client, $extra_options=array())\r
+{\r
+ $methodfilter = isset($extra_options['method_filter']) ? $extra_options['method_filter'] : '';\r
+ //$signum = isset($extra_options['signum']) ? (int)$extra_options['signum'] : 0;\r
+ $timeout = isset($extra_options['timeout']) ? (int)$extra_options['timeout'] : 0;\r
+ $protocol = isset($extra_options['protocol']) ? $extra_options['protocol'] : '';\r
+ $newclassname = isset($extra_options['new_class_name']) ? $extra_options['new_class_name'] : '';\r
+ $encode_php_objects = isset($extra_options['encode_php_objs']) ? (bool)$extra_options['encode_php_objs'] : false;\r
+ $decode_php_objects = isset($extra_options['decode_php_objs']) ? (bool)$extra_options['decode_php_objs'] : false;\r
+ $verbatim_client_copy = isset($extra_options['simple_client_copy']) ? !($extra_options['simple_client_copy']) : true;\r
+ $buildit = isset($extra_options['return_source']) ? !($extra_options['return_source']) : true;\r
+ $prefix = isset($extra_options['prefix']) ? $extra_options['prefix'] : 'xmlrpc';\r
+\r
+ $msgclass = $prefix.'msg';\r
+ //$valclass = $prefix.'val';\r
+ $decodefunc = 'php_'.$prefix.'_decode';\r
+\r
+ $msg = new $msgclass('system.listMethods');\r
+ $response =& $client->send($msg, $timeout, $protocol);\r
+ if($response->faultCode())\r
{\r
- $methodfilter = isset($extra_options['method_filter']) ? $extra_options['method_filter'] : '';\r
- $methodtype = isset($extra_options['method_type']) ? $extra_options['method_type'] : 'auto';\r
-\r
- $result = array();\r
- $mlist = get_class_methods($classname);\r
- foreach($mlist as $mname)\r
- {\r
- if ($methodfilter == '' || preg_match($methodfilter, $mname))\r
- {\r
- // echo $mlist."\n";\r
- $func = new ReflectionMethod($classname, $mname);\r
- if(!$func->isPrivate() && !$func->isProtected() && !$func->isConstructor() && !$func->isDestructor() && !$func->isAbstract())\r
- {\r
- if(($func->isStatic && ($methodtype == 'all' || $methodtype == 'static' || ($methodtype == 'auto' && is_string($classname)))) ||\r
- (!$func->isStatic && ($methodtype == 'all' || $methodtype == 'nonstatic' || ($methodtype == 'auto' && is_object($classname)))))\r
- {\r
- $methodwrap = wrap_php_function(array($classname, $mname), '', $extra_options);\r
- if ( $methodwrap )\r
+ error_log('XML-RPC: could not retrieve method list from remote server');\r
+ return false;\r
+ }\r
+ else\r
+ {\r
+ $mlist = $response->value();\r
+ if ($client->return_type != 'phpvals')\r
+ {\r
+ $mlist = $decodefunc($mlist);\r
+ }\r
+ if(!is_array($mlist) || !count($mlist))\r
+ {\r
+ error_log('XML-RPC: could not retrieve meaningful method list from remote server');\r
+ return false;\r
+ }\r
+ else\r
+ {\r
+ // pick a suitable name for the new function, avoiding collisions\r
+ if($newclassname != '')\r
+ {\r
+ $xmlrpcclassname = $newclassname;\r
+ }\r
+ else\r
+ {\r
+ $xmlrpcclassname = $prefix.'_'.preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'),\r
+ array('_', ''), $client->server).'_client';\r
+ }\r
+ while($buildit && class_exists($xmlrpcclassname))\r
+ {\r
+ $xmlrpcclassname .= 'x';\r
+ }\r
+\r
+ /// @todo add function setdebug() to new class, to enable/disable debugging\r
+ $source = "class $xmlrpcclassname\n{\nvar \$client;\n\n";\r
+ $source .= "function $xmlrpcclassname()\n{\n";\r
+ $source .= build_client_wrapper_code($client, $verbatim_client_copy, $prefix);\r
+ $source .= "\$this->client =& \$client;\n}\n\n";\r
+ $opts = array('simple_client_copy' => 2, 'return_source' => true,\r
+ 'timeout' => $timeout, 'protocol' => $protocol,\r
+ 'encode_php_objs' => $encode_php_objects, 'prefix' => $prefix,\r
+ 'decode_php_objs' => $decode_php_objects\r
+ );\r
+ /// @todo build javadoc for class definition, too\r
+ foreach($mlist as $mname)\r
+ {\r
+ if ($methodfilter == '' || preg_match($methodfilter, $mname))\r
+ {\r
+ $opts['new_function_name'] = preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'),\r
+ array('_', ''), $mname);\r
+ $methodwrap = wrap_xmlrpc_method($client, $mname, $opts);\r
+ if ($methodwrap)\r
+ {\r
+ if (!$buildit)\r
{\r
- $result[$methodwrap['function']] = $methodwrap['function'];\r
+ $source .= $methodwrap['docstring'];\r
}\r
+ $source .= $methodwrap['source']."\n";\r
+ }\r
+ else\r
+ {\r
+ error_log('XML-RPC: will not create class method to wrap remote method '.$mname);\r
}\r
- }\r
- }\r
- }\r
- return $result;\r
+ }\r
+ }\r
+ $source .= "}\n";\r
+ if ($buildit)\r
+ {\r
+ $allOK = 0;\r
+ eval($source.'$allOK=1;');\r
+ // alternative\r
+ //$xmlrpcfuncname = create_function('$m', $innercode);\r
+ if($allOK)\r
+ {\r
+ return $xmlrpcclassname;\r
+ }\r
+ else\r
+ {\r
+ error_log('XML-RPC: could not create class '.$xmlrpcclassname.' to wrap remote server '.$client->server);\r
+ return false;\r
+ }\r
+ }\r
+ else\r
+ {\r
+ return array('class' => $xmlrpcclassname, 'code' => $source, 'docstring' => '');\r
+ }\r
+ }\r
+ }\r
+}\r
+\r
+/**\r
+* Given the necessary info, build php code that creates a new function to\r
+* invoke a remote xmlrpc method.\r
+* Take care that no full checking of input parameters is done to ensure that\r
+* valid php code is emitted.\r
+* Note: real spaghetti code follows...\r
+* @access private\r
+*/\r
+function build_remote_method_wrapper_code($client, $methodname, $xmlrpcfuncname,\r
+ $msig, $mdesc='', $timeout=0, $protocol='', $client_copy_mode=0, $prefix='xmlrpc',\r
+ $decode_php_objects=false, $encode_php_objects=false, $decode_fault=false,\r
+ $fault_response='')\r
+{\r
+ $code = "function $xmlrpcfuncname (";\r
+ if ($client_copy_mode < 2)\r
+ {\r
+ // client copy mode 0 or 1 == partial / full client copy in emitted code\r
+ $innercode = build_client_wrapper_code($client, $client_copy_mode, $prefix);\r
+ $innercode .= "\$client->setDebug(\$debug);\n";\r
+ $this_ = '';\r
+ }\r
+ else\r
+ {\r
+ // client copy mode 2 == no client copy in emitted code\r
+ $innercode = '';\r
+ $this_ = 'this->';\r
+ }\r
+ $innercode .= "\$msg = new {$prefix}msg('$methodname');\n";\r
+\r
+ if ($mdesc != '')\r
+ {\r
+ // take care that PHP comment is not terminated unwillingly by method description\r
+ $mdesc = "/**\n* ".str_replace('*/', '* /', $mdesc)."\n";\r
+ }\r
+ else\r
+ {\r
+ $mdesc = "/**\nFunction $xmlrpcfuncname\n";\r
+ }\r
+\r
+ // param parsing\r
+ $plist = array();\r
+ $pcount = count($msig);\r
+ for($i = 1; $i < $pcount; $i++)\r
+ {\r
+ $plist[] = "\$p$i";\r
+ $ptype = $msig[$i];\r
+ if($ptype == 'i4' || $ptype == 'int' || $ptype == 'boolean' || $ptype == 'double' ||\r
+ $ptype == 'string' || $ptype == 'dateTime.iso8601' || $ptype == 'base64' || $ptype == 'null')\r
+ {\r
+ // only build directly xmlrpcvals when type is known and scalar\r
+ $innercode .= "\$p$i = new {$prefix}val(\$p$i, '$ptype');\n";\r
+ }\r
+ else\r
+ {\r
+ if ($encode_php_objects)\r
+ {\r
+ $innercode .= "\$p$i =& php_{$prefix}_encode(\$p$i, array('encode_php_objs'));\n";\r
+ }\r
+ else\r
+ {\r
+ $innercode .= "\$p$i =& php_{$prefix}_encode(\$p$i);\n";\r
+ }\r
+ }\r
+ $innercode .= "\$msg->addparam(\$p$i);\n";\r
+ $mdesc .= '* @param '.xmlrpc_2_php_type($ptype)." \$p$i\n";\r
+ }\r
+ if ($client_copy_mode < 2)\r
+ {\r
+ $plist[] = '$debug=0';\r
+ $mdesc .= "* @param int \$debug when 1 (or 2) will enable debugging of the underlying {$prefix} call (defaults to 0)\n";\r
+ }\r
+ $plist = implode(', ', $plist);\r
+ $mdesc .= '* @return '.xmlrpc_2_php_type($msig[0])." (or an {$prefix}resp obj instance if call fails)\n*/\n";\r
+\r
+ $innercode .= "\$res =& \${$this_}client->send(\$msg, $timeout, '$protocol');\n";\r
+ if ($decode_fault)\r
+ {\r
+ if (is_string($fault_response) && ((strpos($fault_response, '%faultCode%') !== false) || (strpos($fault_response, '%faultString%') !== false)))\r
+ {\r
+ $respcode = "str_replace(array('%faultCode%', '%faultString%'), array(\$res->faultCode(), \$res->faultString()), '".str_replace("'", "''", $fault_response)."')";\r
+ }\r
+ else\r
+ {\r
+ $respcode = var_export($fault_response, true);\r
+ }\r
}\r
+ else\r
+ {\r
+ $respcode = '$res';\r
+ }\r
+ if ($decode_php_objects)\r
+ {\r
+ $innercode .= "if (\$res->faultcode()) return $respcode; else return php_{$prefix}_decode(\$res->value(), array('decode_php_objs'));";\r
+ }\r
+ else\r
+ {\r
+ $innercode .= "if (\$res->faultcode()) return $respcode; else return php_{$prefix}_decode(\$res->value());";\r
+ }\r
+\r
+ $code = $code . $plist. ") {\n" . $innercode . "\n}\n";\r
+\r
+ return array('source' => $code, 'docstring' => $mdesc);\r
+}\r
\r
- /**\r
- * Given an xmlrpc client and a method name, register a php wrapper function\r
- * that will call it and return results using native php types for both\r
- * params and results. The generated php function will return an xmlrpcresp\r
- * oject for failed xmlrpc calls\r
- *\r
- * Known limitations:\r
- * - server must support system.methodsignature for the wanted xmlrpc method\r
- * - for methods that expose many signatures, only one can be picked (we\r
- * could in priciple check if signatures differ only by number of params\r
- * and not by type, but it would be more complication than we can spare time)\r
- * - nested xmlrpc params: the caller of the generated php function has to\r
- * encode on its own the params passed to the php function if these are structs\r
- * or arrays whose (sub)members include values of type datetime or base64\r
- *\r
- * Notes: the connection properties of the given client will be copied\r
- * and reused for the connection used during the call to the generated\r
- * php function.\r
- * Calling the generated php function 'might' be slow: a new xmlrpc client\r
- * is created on every invocation and an xmlrpc-connection opened+closed.\r
- * An extra 'debug' param is appended to param list of xmlrpc method, useful\r
- * for debugging purposes.\r
- *\r
- * @param xmlrpc_client $client an xmlrpc client set up correctly to communicate with target server\r
- * @param string $methodname the xmlrpc method to be mapped to a php function\r
- * @param array $extra_options array of options that specify conversion details. valid ptions include\r
- * integer signum the index of the method signature to use in mapping (if method exposes many sigs)\r
- * integer timeout timeout (in secs) to be used when executing function/calling remote method\r
- * string protocol 'http' (default), 'http11' or 'https'\r
- * string new_function_name the name of php function to create. If unsepcified, lib will pick an appropriate name\r
- * string return_source if true return php code w. function definition instead fo function name\r
- * bool encode_php_objs let php objects be sent to server using the 'improved' xmlrpc notation, so server can deserialize them as php objects\r
- * bool decode_php_objs --- WARNING !!! possible security hazard. only use it with trusted servers ---\r
- * mixed return_on_fault a php value to be returned when the xmlrpc call fails/returns a fault response (by default the xmlrpcresp object is returned in this case). If a string is used, '%faultCode%' and '%faultString%' tokens will be substituted with actual error values\r
- * bool debug set it to 1 or 2 to see debug results of querying server for method synopsis\r
- * @return string the name of the generated php function (or false) - OR AN ARRAY...\r
- */\r
- function wrap_xmlrpc_method($client, $methodname, $extra_options=0, $timeout=0, $protocol='', $newfuncname='')\r
- {\r
- // mind numbing: let caller use sane calling convention (as per javadoc, 3 params),\r
- // OR the 2.0 calling convention (no options) - we really love backward compat, don't we?\r
- if (!is_array($extra_options))\r
- {\r
- $signum = $extra_options;\r
- $extra_options = array();\r
- }\r
- else\r
- {\r
- $signum = isset($extra_options['signum']) ? (int)$extra_options['signum'] : 0;\r
- $timeout = isset($extra_options['timeout']) ? (int)$extra_options['timeout'] : 0;\r
- $protocol = isset($extra_options['protocol']) ? $extra_options['protocol'] : '';\r
- $newfuncname = isset($extra_options['new_function_name']) ? $extra_options['new_function_name'] : '';\r
- }\r
- //$encode_php_objects = in_array('encode_php_objects', $extra_options);\r
- //$verbatim_client_copy = in_array('simple_client_copy', $extra_options) ? 1 :\r
- // in_array('build_class_code', $extra_options) ? 2 : 0;\r
-\r
- $encode_php_objects = isset($extra_options['encode_php_objs']) ? (bool)$extra_options['encode_php_objs'] : false;\r
- $decode_php_objects = isset($extra_options['decode_php_objs']) ? (bool)$extra_options['decode_php_objs'] : false;\r
- $simple_client_copy = isset($extra_options['simple_client_copy']) ? (int)($extra_options['simple_client_copy']) : 0;\r
- $buildit = isset($extra_options['return_source']) ? !($extra_options['return_source']) : true;\r
- $prefix = isset($extra_options['prefix']) ? $extra_options['prefix'] : 'xmlrpc';\r
- if (isset($extra_options['return_on_fault']))\r
- {\r
- $decode_fault = true;\r
- $fault_response = $extra_options['return_on_fault'];\r
- }\r
- else\r
- {\r
- $decode_fault = false;\r
- $fault_response = '';\r
- }\r
- $debug = isset($extra_options['debug']) ? ($extra_options['debug']) : 0;\r
-\r
- $msgclass = $prefix.'msg';\r
- $valclass = $prefix.'val';\r
- $decodefunc = 'php_'.$prefix.'_decode';\r
-\r
- $msg = new $msgclass('system.methodSignature');\r
- $msg->addparam(new $valclass($methodname));\r
- $client->setDebug($debug);\r
- $response =& $client->send($msg, $timeout, $protocol);\r
- if($response->faultCode())\r
- {\r
- error_log('XML-RPC: could not retrieve method signature from remote server for method '.$methodname);\r
- return false;\r
- }\r
- else\r
- {\r
- $msig = $response->value();\r
- if ($client->return_type != 'phpvals')\r
- {\r
- $msig = $decodefunc($msig);\r
- }\r
- if(!is_array($msig) || count($msig) <= $signum)\r
- {\r
- error_log('XML-RPC: could not retrieve method signature nr.'.$signum.' from remote server for method '.$methodname);\r
- return false;\r
- }\r
- else\r
- {\r
- // pick a suitable name for the new function, avoiding collisions\r
- if($newfuncname != '')\r
- {\r
- $xmlrpcfuncname = $newfuncname;\r
- }\r
- else\r
- {\r
- // take care to insure that methodname is translated to valid\r
- // php function name\r
- $xmlrpcfuncname = $prefix.'_'.preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'),\r
- array('_', ''), $methodname);\r
- }\r
- while($buildit && function_exists($xmlrpcfuncname))\r
- {\r
- $xmlrpcfuncname .= 'x';\r
- }\r
-\r
- $msig = $msig[$signum];\r
- $mdesc = '';\r
- // if in 'offline' mode, get method description too.\r
- // in online mode, favour speed of operation\r
- if(!$buildit)\r
- {\r
- $msg = new $msgclass('system.methodHelp');\r
- $msg->addparam(new $valclass($methodname));\r
- $response =& $client->send($msg, $timeout, $protocol);\r
- if (!$response->faultCode())\r
- {\r
- $mdesc = $response->value();\r
- if ($client->return_type != 'phpvals')\r
- {\r
- $mdesc = $mdesc->scalarval();\r
- }\r
- }\r
- }\r
-\r
- $results = build_remote_method_wrapper_code($client, $methodname,\r
- $xmlrpcfuncname, $msig, $mdesc, $timeout, $protocol, $simple_client_copy,\r
- $prefix, $decode_php_objects, $encode_php_objects, $decode_fault,\r
- $fault_response);\r
-\r
- //print_r($code);\r
- if ($buildit)\r
- {\r
- $allOK = 0;\r
- eval($results['source'].'$allOK=1;');\r
- // alternative\r
- //$xmlrpcfuncname = create_function('$m', $innercode);\r
- if($allOK)\r
- {\r
- return $xmlrpcfuncname;\r
- }\r
- else\r
- {\r
- error_log('XML-RPC: could not create function '.$xmlrpcfuncname.' to wrap remote method '.$methodname);\r
- return false;\r
- }\r
- }\r
- else\r
- {\r
- $results['function'] = $xmlrpcfuncname;\r
- return $results;\r
- }\r
- }\r
- }\r
- }\r
-\r
- /**\r
- * Similar to wrap_xmlrpc_method, but will generate a php class that wraps\r
- * all xmlrpc methods exposed by the remote server as own methods.\r
- * For more details see wrap_xmlrpc_method.\r
- * @param xmlrpc_client $client the client obj all set to query the desired server\r
- * @param array $extra_options list of options for wrapped code\r
- * @return mixed false on error, the name of the created class if all ok or an array with code, class name and comments (if the appropriatevoption is set in extra_options)\r
- */\r
- function wrap_xmlrpc_server($client, $extra_options=array())\r
- {\r
- $methodfilter = isset($extra_options['method_filter']) ? $extra_options['method_filter'] : '';\r
- //$signum = isset($extra_options['signum']) ? (int)$extra_options['signum'] : 0;\r
- $timeout = isset($extra_options['timeout']) ? (int)$extra_options['timeout'] : 0;\r
- $protocol = isset($extra_options['protocol']) ? $extra_options['protocol'] : '';\r
- $newclassname = isset($extra_options['new_class_name']) ? $extra_options['new_class_name'] : '';\r
- $encode_php_objects = isset($extra_options['encode_php_objs']) ? (bool)$extra_options['encode_php_objs'] : false;\r
- $decode_php_objects = isset($extra_options['decode_php_objs']) ? (bool)$extra_options['decode_php_objs'] : false;\r
- $verbatim_client_copy = isset($extra_options['simple_client_copy']) ? !($extra_options['simple_client_copy']) : true;\r
- $buildit = isset($extra_options['return_source']) ? !($extra_options['return_source']) : true;\r
- $prefix = isset($extra_options['prefix']) ? $extra_options['prefix'] : 'xmlrpc';\r
-\r
- $msgclass = $prefix.'msg';\r
- //$valclass = $prefix.'val';\r
- $decodefunc = 'php_'.$prefix.'_decode';\r
-\r
- $msg = new $msgclass('system.listMethods');\r
- $response =& $client->send($msg, $timeout, $protocol);\r
- if($response->faultCode())\r
- {\r
- error_log('XML-RPC: could not retrieve method list from remote server');\r
- return false;\r
- }\r
- else\r
- {\r
- $mlist = $response->value();\r
- if ($client->return_type != 'phpvals')\r
- {\r
- $mlist = $decodefunc($mlist);\r
- }\r
- if(!is_array($mlist) || !count($mlist))\r
- {\r
- error_log('XML-RPC: could not retrieve meaningful method list from remote server');\r
- return false;\r
- }\r
- else\r
- {\r
- // pick a suitable name for the new function, avoiding collisions\r
- if($newclassname != '')\r
- {\r
- $xmlrpcclassname = $newclassname;\r
- }\r
- else\r
- {\r
- $xmlrpcclassname = $prefix.'_'.preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'),\r
- array('_', ''), $client->server).'_client';\r
- }\r
- while($buildit && class_exists($xmlrpcclassname))\r
- {\r
- $xmlrpcclassname .= 'x';\r
- }\r
-\r
- /// @todo add function setdebug() to new class, to enable/disable debugging\r
- $source = "class $xmlrpcclassname\n{\nvar \$client;\n\n";\r
- $source .= "function $xmlrpcclassname()\n{\n";\r
- $source .= build_client_wrapper_code($client, $verbatim_client_copy, $prefix);\r
- $source .= "\$this->client =& \$client;\n}\n\n";\r
- $opts = array('simple_client_copy' => 2, 'return_source' => true,\r
- 'timeout' => $timeout, 'protocol' => $protocol,\r
- 'encode_php_objs' => $encode_php_objects, 'prefix' => $prefix,\r
- 'decode_php_objs' => $decode_php_objects\r
- );\r
- /// @todo build javadoc for class definition, too\r
- foreach($mlist as $mname)\r
- {\r
- if ($methodfilter == '' || preg_match($methodfilter, $mname))\r
- {\r
- $opts['new_function_name'] = preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'),\r
- array('_', ''), $mname);\r
- $methodwrap = wrap_xmlrpc_method($client, $mname, $opts);\r
- if ($methodwrap)\r
- {\r
- if (!$buildit)\r
- {\r
- $source .= $methodwrap['docstring'];\r
- }\r
- $source .= $methodwrap['source']."\n";\r
- }\r
- else\r
- {\r
- error_log('XML-RPC: will not create class method to wrap remote method '.$mname);\r
- }\r
- }\r
- }\r
- $source .= "}\n";\r
- if ($buildit)\r
- {\r
- $allOK = 0;\r
- eval($source.'$allOK=1;');\r
- // alternative\r
- //$xmlrpcfuncname = create_function('$m', $innercode);\r
- if($allOK)\r
- {\r
- return $xmlrpcclassname;\r
- }\r
- else\r
- {\r
- error_log('XML-RPC: could not create class '.$xmlrpcclassname.' to wrap remote server '.$client->server);\r
- return false;\r
- }\r
- }\r
- else\r
- {\r
- return array('class' => $xmlrpcclassname, 'code' => $source, 'docstring' => '');\r
- }\r
- }\r
- }\r
- }\r
-\r
- /**\r
- * Given the necessary info, build php code that creates a new function to\r
- * invoke a remote xmlrpc method.\r
- * Take care that no full checking of input parameters is done to ensure that\r
- * valid php code is emitted.\r
- * Note: real spaghetti code follows...\r
- * @access private\r
- */\r
- function build_remote_method_wrapper_code($client, $methodname, $xmlrpcfuncname,\r
- $msig, $mdesc='', $timeout=0, $protocol='', $client_copy_mode=0, $prefix='xmlrpc',\r
- $decode_php_objects=false, $encode_php_objects=false, $decode_fault=false,\r
- $fault_response='')\r
- {\r
- $code = "function $xmlrpcfuncname (";\r
- if ($client_copy_mode < 2)\r
- {\r
- // client copy mode 0 or 1 == partial / full client copy in emitted code\r
- $innercode = build_client_wrapper_code($client, $client_copy_mode, $prefix);\r
- $innercode .= "\$client->setDebug(\$debug);\n";\r
- $this_ = '';\r
- }\r
- else\r
- {\r
- // client copy mode 2 == no client copy in emitted code\r
- $innercode = '';\r
- $this_ = 'this->';\r
- }\r
- $innercode .= "\$msg = new {$prefix}msg('$methodname');\n";\r
-\r
- if ($mdesc != '')\r
- {\r
- // take care that PHP comment is not terminated unwillingly by method description\r
- $mdesc = "/**\n* ".str_replace('*/', '* /', $mdesc)."\n";\r
- }\r
- else\r
- {\r
- $mdesc = "/**\nFunction $xmlrpcfuncname\n";\r
- }\r
-\r
- // param parsing\r
- $plist = array();\r
- $pcount = count($msig);\r
- for($i = 1; $i < $pcount; $i++)\r
- {\r
- $plist[] = "\$p$i";\r
- $ptype = $msig[$i];\r
- if($ptype == 'i4' || $ptype == 'int' || $ptype == 'boolean' || $ptype == 'double' ||\r
- $ptype == 'string' || $ptype == 'dateTime.iso8601' || $ptype == 'base64' || $ptype == 'null')\r
- {\r
- // only build directly xmlrpcvals when type is known and scalar\r
- $innercode .= "\$p$i = new {$prefix}val(\$p$i, '$ptype');\n";\r
- }\r
- else\r
- {\r
- if ($encode_php_objects)\r
- {\r
- $innercode .= "\$p$i =& php_{$prefix}_encode(\$p$i, array('encode_php_objs'));\n";\r
- }\r
- else\r
- {\r
- $innercode .= "\$p$i =& php_{$prefix}_encode(\$p$i);\n";\r
- }\r
- }\r
- $innercode .= "\$msg->addparam(\$p$i);\n";\r
- $mdesc .= '* @param '.xmlrpc_2_php_type($ptype)." \$p$i\n";\r
- }\r
- if ($client_copy_mode < 2)\r
- {\r
- $plist[] = '$debug=0';\r
- $mdesc .= "* @param int \$debug when 1 (or 2) will enable debugging of the underlying {$prefix} call (defaults to 0)\n";\r
- }\r
- $plist = implode(', ', $plist);\r
- $mdesc .= '* @return '.xmlrpc_2_php_type($msig[0])." (or an {$prefix}resp obj instance if call fails)\n*/\n";\r
-\r
- $innercode .= "\$res =& \${$this_}client->send(\$msg, $timeout, '$protocol');\n";\r
- if ($decode_fault)\r
- {\r
- if (is_string($fault_response) && ((strpos($fault_response, '%faultCode%') !== false) || (strpos($fault_response, '%faultString%') !== false)))\r
- {\r
- $respcode = "str_replace(array('%faultCode%', '%faultString%'), array(\$res->faultCode(), \$res->faultString()), '".str_replace("'", "''", $fault_response)."')";\r
- }\r
- else\r
- {\r
- $respcode = var_export($fault_response, true);\r
- }\r
- }\r
- else\r
- {\r
- $respcode = '$res';\r
- }\r
- if ($decode_php_objects)\r
- {\r
- $innercode .= "if (\$res->faultcode()) return $respcode; else return php_{$prefix}_decode(\$res->value(), array('decode_php_objs'));";\r
- }\r
- else\r
- {\r
- $innercode .= "if (\$res->faultcode()) return $respcode; else return php_{$prefix}_decode(\$res->value());";\r
- }\r
-\r
- $code = $code . $plist. ") {\n" . $innercode . "\n}\n";\r
-\r
- return array('source' => $code, 'docstring' => $mdesc);\r
- }\r
-\r
- /**\r
- * Given necessary info, generate php code that will rebuild a client object\r
- * Take care that no full checking of input parameters is done to ensure that\r
- * valid php code is emitted.\r
- * @access private\r
- */\r
- function build_client_wrapper_code($client, $verbatim_client_copy, $prefix='xmlrpc')\r
- {\r
- $code = "\$client = new {$prefix}_client('".str_replace("'", "\'", $client->path).\r
- "', '" . str_replace("'", "\'", $client->server) . "', $client->port);\n";\r
-\r
- // copy all client fields to the client that will be generated runtime\r
- // (this provides for future expansion or subclassing of client obj)\r
- if ($verbatim_client_copy)\r
- {\r
- foreach($client as $fld => $val)\r
- {\r
- if($fld != 'debug' && $fld != 'return_type')\r
- {\r
- $val = var_export($val, true);\r
- $code .= "\$client->$fld = $val;\n";\r
- }\r
- }\r
- }\r
- // only make sure that client always returns the correct data type\r
- $code .= "\$client->return_type = '{$prefix}vals';\n";\r
- //$code .= "\$client->setDebug(\$debug);\n";\r
- return $code;\r
- }\r
+/**\r
+* Given necessary info, generate php code that will rebuild a client object\r
+* Take care that no full checking of input parameters is done to ensure that\r
+* valid php code is emitted.\r
+* @access private\r
+*/\r
+function build_client_wrapper_code($client, $verbatim_client_copy, $prefix='xmlrpc')\r
+{\r
+ $code = "\$client = new {$prefix}_client('".str_replace("'", "\'", $client->path).\r
+ "', '" . str_replace("'", "\'", $client->server) . "', $client->port);\n";\r
+\r
+ // copy all client fields to the client that will be generated runtime\r
+ // (this provides for future expansion or subclassing of client obj)\r
+ if ($verbatim_client_copy)\r
+ {\r
+ foreach($client as $fld => $val)\r
+ {\r
+ if($fld != 'debug' && $fld != 'return_type')\r
+ {\r
+ $val = var_export($val, true);\r
+ $code .= "\$client->$fld = $val;\n";\r
+ }\r
+ }\r
+ }\r
+ // only make sure that client always returns the correct data type\r
+ $code .= "\$client->return_type = '{$prefix}vals';\n";\r
+ //$code .= "\$client->setDebug(\$debug);\n";\r
+ return $code;\r
+}\r
?>
\ No newline at end of file
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED\r
// OF THE POSSIBILITY OF SUCH DAMAGE.\r
\r
- // XML RPC Server class\r
- // requires: xmlrpc.inc\r
-\r
- $GLOBALS['xmlrpcs_capabilities'] = array(\r
- // xmlrpc spec: always supported\r
- 'xmlrpc' => new xmlrpcval(array(\r
- 'specUrl' => new xmlrpcval('http://www.xmlrpc.com/spec', 'string'),\r
- 'specVersion' => new xmlrpcval(1, 'int')\r
- ), 'struct'),\r
- // if we support system.xxx functions, we always support multicall, too...\r
- // Note that, as of 2006/09/17, the following URL does not respond anymore\r
- 'system.multicall' => new xmlrpcval(array(\r
- 'specUrl' => new xmlrpcval('http://www.xmlrpc.com/discuss/msgReader$1208', 'string'),\r
- 'specVersion' => new xmlrpcval(1, 'int')\r
- ), 'struct'),\r
- // introspection: version 2! we support 'mixed', too\r
- 'introspection' => new xmlrpcval(array(\r
- 'specUrl' => new xmlrpcval('http://phpxmlrpc.sourceforge.net/doc-2/ch10.html', 'string'),\r
- 'specVersion' => new xmlrpcval(2, 'int')\r
- ), 'struct')\r
- );\r
-\r
- /* Functions that implement system.XXX methods of xmlrpc servers */\r
- $_xmlrpcs_getCapabilities_sig=array(array($GLOBALS['xmlrpcStruct']));\r
- $_xmlrpcs_getCapabilities_doc='This method lists all the capabilites that the XML-RPC server has: the (more or less standard) extensions to the xmlrpc spec that it adheres to';\r
- $_xmlrpcs_getCapabilities_sdoc=array(array('list of capabilities, described as structs with a version number and url for the spec'));\r
- function _xmlrpcs_getCapabilities($server, $m=null)\r
- {\r
- $outAr = $GLOBALS['xmlrpcs_capabilities'];\r
- // NIL extension\r
- if ($GLOBALS['xmlrpc_null_extension']) {\r
- $outAr['nil'] = new xmlrpcval(array(\r
- 'specUrl' => new xmlrpcval('http://www.ontosys.com/xml-rpc/extensions.php', 'string'),\r
- 'specVersion' => new xmlrpcval(1, 'int')\r
- ), 'struct');\r
- }\r
- return new xmlrpcresp(new xmlrpcval($outAr, 'struct'));\r
- }\r
-\r
- // listMethods: signature was either a string, or nothing.\r
- // The useless string variant has been removed\r
- $_xmlrpcs_listMethods_sig=array(array($GLOBALS['xmlrpcArray']));\r
- $_xmlrpcs_listMethods_doc='This method lists all the methods that the XML-RPC server knows how to dispatch';\r
- $_xmlrpcs_listMethods_sdoc=array(array('list of method names'));\r
- function _xmlrpcs_listMethods($server, $m=null) // if called in plain php values mode, second param is missing\r
- {\r
-\r
- $outAr=array();\r
- foreach($server->dmap as $key => $val)\r
- {\r
- $outAr[]=new xmlrpcval($key, 'string');\r
- }\r
- if($server->allow_system_funcs)\r
- {\r
- foreach($GLOBALS['_xmlrpcs_dmap'] as $key => $val)\r
- {\r
- $outAr[]=new xmlrpcval($key, 'string');\r
- }\r
- }\r
- return new xmlrpcresp(new xmlrpcval($outAr, 'array'));\r
- }\r
-\r
- $_xmlrpcs_methodSignature_sig=array(array($GLOBALS['xmlrpcArray'], $GLOBALS['xmlrpcString']));\r
- $_xmlrpcs_methodSignature_doc='Returns an array of known signatures (an array of arrays) for the method name passed. If no signatures are known, returns a none-array (test for type != array to detect missing signature)';\r
- $_xmlrpcs_methodSignature_sdoc=array(array('list of known signatures, each sig being an array of xmlrpc type names', 'name of method to be described'));\r
- function _xmlrpcs_methodSignature($server, $m)\r
- {\r
- // let accept as parameter both an xmlrpcval or string\r
- if (is_object($m))\r
- {\r
- $methName=$m->getParam(0);\r
- $methName=$methName->scalarval();\r
- }\r
- else\r
- {\r
- $methName=$m;\r
- }\r
- if(strpos($methName, "system.") === 0)\r
- {\r
- $dmap=$GLOBALS['_xmlrpcs_dmap']; $sysCall=1;\r
- }\r
- else\r
- {\r
- $dmap=$server->dmap; $sysCall=0;\r
- }\r
- if(isset($dmap[$methName]))\r
- {\r
- if(isset($dmap[$methName]['signature']))\r
- {\r
- $sigs=array();\r
- foreach($dmap[$methName]['signature'] as $inSig)\r
- {\r
- $cursig=array();\r
- foreach($inSig as $sig)\r
- {\r
- $cursig[]=new xmlrpcval($sig, 'string');\r
- }\r
- $sigs[]=new xmlrpcval($cursig, 'array');\r
- }\r
- $r=new xmlrpcresp(new xmlrpcval($sigs, 'array'));\r
- }\r
- else\r
- {\r
- // NB: according to the official docs, we should be returning a\r
- // "none-array" here, which means not-an-array\r
- $r=new xmlrpcresp(new xmlrpcval('undef', 'string'));\r
- }\r
- }\r
- else\r
- {\r
- $r=new xmlrpcresp(0,$GLOBALS['xmlrpcerr']['introspect_unknown'], $GLOBALS['xmlrpcstr']['introspect_unknown']);\r
- }\r
- return $r;\r
- }\r
-\r
- $_xmlrpcs_methodHelp_sig=array(array($GLOBALS['xmlrpcString'], $GLOBALS['xmlrpcString']));\r
- $_xmlrpcs_methodHelp_doc='Returns help text if defined for the method passed, otherwise returns an empty string';\r
- $_xmlrpcs_methodHelp_sdoc=array(array('method description', 'name of the method to be described'));\r
- function _xmlrpcs_methodHelp($server, $m)\r
- {\r
- // let accept as parameter both an xmlrpcval or string\r
- if (is_object($m))\r
- {\r
- $methName=$m->getParam(0);\r
- $methName=$methName->scalarval();\r
- }\r
- else\r
- {\r
- $methName=$m;\r
- }\r
- if(strpos($methName, "system.") === 0)\r
- {\r
- $dmap=$GLOBALS['_xmlrpcs_dmap']; $sysCall=1;\r
- }\r
- else\r
- {\r
- $dmap=$server->dmap; $sysCall=0;\r
- }\r
- if(isset($dmap[$methName]))\r
- {\r
- if(isset($dmap[$methName]['docstring']))\r
- {\r
- $r=new xmlrpcresp(new xmlrpcval($dmap[$methName]['docstring']), 'string');\r
- }\r
- else\r
- {\r
- $r=new xmlrpcresp(new xmlrpcval('', 'string'));\r
- }\r
- }\r
- else\r
- {\r
- $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['introspect_unknown'], $GLOBALS['xmlrpcstr']['introspect_unknown']);\r
- }\r
- return $r;\r
- }\r
-\r
- $_xmlrpcs_multicall_sig = array(array($GLOBALS['xmlrpcArray'], $GLOBALS['xmlrpcArray']));\r
- $_xmlrpcs_multicall_doc = 'Boxcar multiple RPC calls in one request. See http://www.xmlrpc.com/discuss/msgReader$1208 for details';\r
- $_xmlrpcs_multicall_sdoc = array(array('list of response structs, where each struct has the usual members', 'list of calls, with each call being represented as a struct, with members "methodname" and "params"'));\r
- function _xmlrpcs_multicall_error($err)\r
- {\r
- if(is_string($err))\r
- {\r
- $str = $GLOBALS['xmlrpcstr']["multicall_${err}"];\r
- $code = $GLOBALS['xmlrpcerr']["multicall_${err}"];\r
- }\r
- else\r
- {\r
- $code = $err->faultCode();\r
- $str = $err->faultString();\r
- }\r
- $struct = array();\r
- $struct['faultCode'] = new xmlrpcval($code, 'int');\r
- $struct['faultString'] = new xmlrpcval($str, 'string');\r
- return new xmlrpcval($struct, 'struct');\r
- }\r
-\r
- function _xmlrpcs_multicall_do_call($server, $call)\r
- {\r
- if($call->kindOf() != 'struct')\r
- {\r
- return _xmlrpcs_multicall_error('notstruct');\r
- }\r
- $methName = @$call->structmem('methodName');\r
- if(!$methName)\r
- {\r
- return _xmlrpcs_multicall_error('nomethod');\r
- }\r
- if($methName->kindOf() != 'scalar' || $methName->scalartyp() != 'string')\r
- {\r
- return _xmlrpcs_multicall_error('notstring');\r
- }\r
- if($methName->scalarval() == 'system.multicall')\r
- {\r
- return _xmlrpcs_multicall_error('recursion');\r
- }\r
-\r
- $params = @$call->structmem('params');\r
- if(!$params)\r
- {\r
- return _xmlrpcs_multicall_error('noparams');\r
- }\r
- if($params->kindOf() != 'array')\r
- {\r
- return _xmlrpcs_multicall_error('notarray');\r
- }\r
- $numParams = $params->arraysize();\r
-\r
- $msg = new xmlrpcmsg($methName->scalarval());\r
- for($i = 0; $i < $numParams; $i++)\r
- {\r
- if(!$msg->addParam($params->arraymem($i)))\r
- {\r
- $i++;\r
- return _xmlrpcs_multicall_error(new xmlrpcresp(0,\r
- $GLOBALS['xmlrpcerr']['incorrect_params'],\r
- $GLOBALS['xmlrpcstr']['incorrect_params'] . ": probable xml error in param " . $i));\r
- }\r
- }\r
-\r
- $result = $server->execute($msg);\r
-\r
- if($result->faultCode() != 0)\r
- {\r
- return _xmlrpcs_multicall_error($result); // Method returned fault.\r
- }\r
-\r
- return new xmlrpcval(array($result->value()), 'array');\r
- }\r
-\r
- function _xmlrpcs_multicall_do_call_phpvals($server, $call)\r
- {\r
- if(!is_array($call))\r
- {\r
- return _xmlrpcs_multicall_error('notstruct');\r
- }\r
- if(!array_key_exists('methodName', $call))\r
- {\r
- return _xmlrpcs_multicall_error('nomethod');\r
- }\r
- if (!is_string($call['methodName']))\r
- {\r
- return _xmlrpcs_multicall_error('notstring');\r
- }\r
- if($call['methodName'] == 'system.multicall')\r
- {\r
- return _xmlrpcs_multicall_error('recursion');\r
- }\r
- if(!array_key_exists('params', $call))\r
- {\r
- return _xmlrpcs_multicall_error('noparams');\r
- }\r
- if(!is_array($call['params']))\r
- {\r
- return _xmlrpcs_multicall_error('notarray');\r
- }\r
-\r
- // this is a real dirty and simplistic hack, since we might have received a\r
- // base64 or datetime values, but they will be listed as strings here...\r
- $numParams = count($call['params']);\r
- $pt = array();\r
- foreach($call['params'] as $val)\r
- $pt[] = php_2_xmlrpc_type(gettype($val));\r
-\r
- $result = $server->execute($call['methodName'], $call['params'], $pt);\r
-\r
- if($result->faultCode() != 0)\r
- {\r
- return _xmlrpcs_multicall_error($result); // Method returned fault.\r
- }\r
-\r
- return new xmlrpcval(array($result->value()), 'array');\r
- }\r
-\r
- function _xmlrpcs_multicall($server, $m)\r
- {\r
- $result = array();\r
- // let accept a plain list of php parameters, beside a single xmlrpc msg object\r
- if (is_object($m))\r
- {\r
- $calls = $m->getParam(0);\r
- $numCalls = $calls->arraysize();\r
- for($i = 0; $i < $numCalls; $i++)\r
- {\r
- $call = $calls->arraymem($i);\r
- $result[$i] = _xmlrpcs_multicall_do_call($server, $call);\r
- }\r
- }\r
- else\r
- {\r
- $numCalls=count($m);\r
- for($i = 0; $i < $numCalls; $i++)\r
- {\r
- $result[$i] = _xmlrpcs_multicall_do_call_phpvals($server, $m[$i]);\r
- }\r
- }\r
-\r
- return new xmlrpcresp(new xmlrpcval($result, 'array'));\r
- }\r
-\r
- $GLOBALS['_xmlrpcs_dmap']=array(\r
- 'system.listMethods' => array(\r
- 'function' => '_xmlrpcs_listMethods',\r
- 'signature' => $_xmlrpcs_listMethods_sig,\r
- 'docstring' => $_xmlrpcs_listMethods_doc,\r
- 'signature_docs' => $_xmlrpcs_listMethods_sdoc),\r
- 'system.methodHelp' => array(\r
- 'function' => '_xmlrpcs_methodHelp',\r
- 'signature' => $_xmlrpcs_methodHelp_sig,\r
- 'docstring' => $_xmlrpcs_methodHelp_doc,\r
- 'signature_docs' => $_xmlrpcs_methodHelp_sdoc),\r
- 'system.methodSignature' => array(\r
- 'function' => '_xmlrpcs_methodSignature',\r
- 'signature' => $_xmlrpcs_methodSignature_sig,\r
- 'docstring' => $_xmlrpcs_methodSignature_doc,\r
- 'signature_docs' => $_xmlrpcs_methodSignature_sdoc),\r
- 'system.multicall' => array(\r
- 'function' => '_xmlrpcs_multicall',\r
- 'signature' => $_xmlrpcs_multicall_sig,\r
- 'docstring' => $_xmlrpcs_multicall_doc,\r
- 'signature_docs' => $_xmlrpcs_multicall_sdoc),\r
- 'system.getCapabilities' => array(\r
- 'function' => '_xmlrpcs_getCapabilities',\r
- 'signature' => $_xmlrpcs_getCapabilities_sig,\r
- 'docstring' => $_xmlrpcs_getCapabilities_doc,\r
- 'signature_docs' => $_xmlrpcs_getCapabilities_sdoc)\r
- );\r
-\r
- $GLOBALS['_xmlrpcs_occurred_errors'] = '';\r
- $GLOBALS['_xmlrpcs_prev_ehandler'] = '';\r
-\r
- /**\r
- * Error handler used to track errors that occur during server-side execution of PHP code.\r
- * This allows to report back to the client whether an internal error has occurred or not\r
- * using an xmlrpc response object, instead of letting the client deal with the html junk\r
- * that a PHP execution error on the server generally entails.\r
- *\r
- * NB: in fact a user defined error handler can only handle WARNING, NOTICE and USER_* errors.\r
- *\r
- */\r
- function _xmlrpcs_errorHandler($errcode, $errstring, $filename=null, $lineno=null, $context=null)\r
- {\r
- // obey the @ protocol\r
- if (error_reporting() == 0)\r
- return;\r
-\r
- //if($errcode != E_NOTICE && $errcode != E_WARNING && $errcode != E_USER_NOTICE && $errcode != E_USER_WARNING)\r
- if($errcode != E_STRICT)\r
- {\r
- $GLOBALS['_xmlrpcs_occurred_errors'] = $GLOBALS['_xmlrpcs_occurred_errors'] . $errstring . "\n";\r
- }\r
- // Try to avoid as much as possible disruption to the previous error handling\r
- // mechanism in place\r
- if($GLOBALS['_xmlrpcs_prev_ehandler'] == '')\r
- {\r
- // The previous error handler was the default: all we should do is log error\r
- // to the default error log (if level high enough)\r
- if(ini_get('log_errors') && (intval(ini_get('error_reporting')) & $errcode))\r
- {\r
- error_log($errstring);\r
- }\r
- }\r
- else\r
- {\r
- // Pass control on to previous error handler, trying to avoid loops...\r
- if($GLOBALS['_xmlrpcs_prev_ehandler'] != '_xmlrpcs_errorHandler')\r
- {\r
- // NB: this code will NOT work on php < 4.0.2: only 2 params were used for error handlers\r
- if(is_array($GLOBALS['_xmlrpcs_prev_ehandler']))\r
- {\r
- // the following works both with static class methods and plain object methods as error handler\r
- call_user_func_array($GLOBALS['_xmlrpcs_prev_ehandler'], array($errcode, $errstring, $filename, $lineno, $context));\r
- }\r
- else\r
- {\r
- $GLOBALS['_xmlrpcs_prev_ehandler']($errcode, $errstring, $filename, $lineno, $context);\r
- }\r
- }\r
- }\r
- }\r
-\r
- $GLOBALS['_xmlrpc_debuginfo']='';\r
-\r
- /**\r
- * Add a string to the debug info that can be later seralized by the server\r
- * as part of the response message.\r
- * Note that for best compatibility, the debug string should be encoded using\r
- * the $GLOBALS['xmlrpc_internalencoding'] character set.\r
- * @param string $m\r
- * @access public\r
- */\r
- function xmlrpc_debugmsg($m)\r
- {\r
- $GLOBALS['_xmlrpc_debuginfo'] .= $m . "\n";\r
- }\r
-\r
- class xmlrpc_server\r
- {\r
- /**\r
- * Array defining php functions exposed as xmlrpc methods by this server\r
- * @access private\r
- */\r
- var $dmap=array();\r
- /**\r
- * Defines how functions in dmap will be invoked: either using an xmlrpc msg object\r
- * or plain php values.\r
- * valid strings are 'xmlrpcvals', 'phpvals' or 'epivals'\r
- */\r
- var $functions_parameters_type='xmlrpcvals';\r
- /**\r
- * Option used for fine-tuning the encoding the php values returned from\r
- * functions registered in the dispatch map when the functions_parameters_types\r
- * member is set to 'phpvals'\r
- * @see php_xmlrpc_encode for a list of values\r
- */\r
- var $phpvals_encoding_options = array( 'auto_dates' );\r
- /// controls whether the server is going to echo debugging messages back to the client as comments in response body. valid values: 0,1,2,3\r
- var $debug = 1;\r
- /**\r
- * Controls behaviour of server when invoked user function throws an exception:\r
- * 0 = catch it and return an 'internal error' xmlrpc response (default)\r
- * 1 = catch it and return an xmlrpc response with the error corresponding to the exception\r
- * 2 = allow the exception to float to the upper layers\r
- */\r
- var $exception_handling = 0;\r
- /**\r
- * When set to true, it will enable HTTP compression of the response, in case\r
- * the client has declared its support for compression in the request.\r
- */\r
- var $compress_response = false;\r
- /**\r
- * List of http compression methods accepted by the server for requests.\r
- * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib\r
- */\r
- var $accepted_compression = array();\r
- /// shall we serve calls to system.* methods?\r
- var $allow_system_funcs = true;\r
- /// list of charset encodings natively accepted for requests\r
- var $accepted_charset_encodings = array();\r
- /**\r
- * charset encoding to be used for response.\r
- * NB: if we can, we will convert the generated response from internal_encoding to the intended one.\r
- * can be: a supported xml encoding (only UTF-8 and ISO-8859-1 at present, unless mbstring is enabled),\r
- * null (leave unspecified in response, convert output stream to US_ASCII),\r
- * 'default' (use xmlrpc library default as specified in xmlrpc.inc, convert output stream if needed),\r
- * or 'auto' (use client-specified charset encoding or same as request if request headers do not specify it (unless request is US-ASCII: then use library default anyway).\r
- * NB: pretty dangerous if you accept every charset and do not have mbstring enabled)\r
- */\r
- var $response_charset_encoding = '';\r
- /**\r
- * Storage for internal debug info\r
- * @access private\r
- */\r
- var $debug_info = '';\r
- /**\r
- * Extra data passed at runtime to method handling functions. Used only by EPI layer\r
- */\r
- var $user_data = null;\r
-\r
- /**\r
- * @param array $dispmap the dispatch map with definition of exposed services\r
- * @param boolean $servicenow set to false to prevent the server from running upon construction\r
- */\r
- function xmlrpc_server($dispMap=null, $serviceNow=true)\r
- {\r
- // if ZLIB is enabled, let the server by default accept compressed requests,\r
- // and compress responses sent to clients that support them\r
- if(function_exists('gzinflate'))\r
- {\r
- $this->accepted_compression = array('gzip', 'deflate');\r
- $this->compress_response = true;\r
- }\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
- // dispMap is a dispatch array of methods\r
- // mapped to function names and signatures\r
- // if a method\r
- // doesn't appear in the map then an unknown\r
- // method error is generated\r
- /* milosch - changed to make passing dispMap optional.\r
- * instead, you can use the class add_to_map() function\r
- * to add functions manually (borrowed from SOAPX4)\r
- */\r
- if($dispMap)\r
- {\r
- $this->dmap = $dispMap;\r
- if($serviceNow)\r
- {\r
- $this->service();\r
- }\r
- }\r
- }\r
-\r
- /**\r
- * Set debug level of server.\r
- * @param integer $in debug lvl: determines info added to xmlrpc responses (as xml comments)\r
- * 0 = no debug info,\r
- * 1 = msgs set from user with debugmsg(),\r
- * 2 = add complete xmlrpc request (headers and body),\r
- * 3 = add also all processing warnings happened during method processing\r
- * (NB: this involves setting a custom error handler, and might interfere\r
- * with the standard processing of the php function exposed as method. In\r
- * particular, triggering an USER_ERROR level error will not halt script\r
- * execution anymore, but just end up logged in the xmlrpc response)\r
- * Note that info added at level 2 and 3 will be base64 encoded\r
- * @access public\r
- */\r
- function setDebug($in)\r
- {\r
- $this->debug=$in;\r
- }\r
-\r
- /**\r
- * Return a string with the serialized representation of all debug info\r
- * @param string $charset_encoding the target charset encoding for the serialization\r
- * @return string an XML comment (or two)\r
- */\r
- function serializeDebug($charset_encoding='')\r
- {\r
- // Tough encoding problem: which internal charset should we assume for debug info?\r
- // It might contain a copy of raw data received from client, ie with unknown encoding,\r
- // intermixed with php generated data and user generated data...\r
- // so we split it: system debug is base 64 encoded,\r
- // user debug info should be encoded by the end user using the INTERNAL_ENCODING\r
- $out = '';\r
- if ($this->debug_info != '')\r
- {\r
- $out .= "<!-- SERVER DEBUG INFO (BASE64 ENCODED):\n".base64_encode($this->debug_info)."\n-->\n";\r
- }\r
- if($GLOBALS['_xmlrpc_debuginfo']!='')\r
- {\r
-\r
- $out .= "<!-- DEBUG INFO:\n" . xmlrpc_encode_entitites(str_replace('--', '_-', $GLOBALS['_xmlrpc_debuginfo']), $GLOBALS['xmlrpc_internalencoding'], $charset_encoding) . "\n-->\n";\r
- // NB: a better solution MIGHT be to use CDATA, but we need to insert it\r
- // into return payload AFTER the beginning tag\r
- //$out .= "<![CDATA[ DEBUG INFO:\n\n" . str_replace(']]>', ']_]_>', $GLOBALS['_xmlrpc_debuginfo']) . "\n]]>\n";\r
- }\r
- return $out;\r
- }\r
-\r
- /**\r
- * Execute the xmlrpc request, printing the response\r
- * @param string $data the request body. If null, the http POST request will be examined\r
- * @return xmlrpcresp the response object (usually not used by caller...)\r
- * @access public\r
- */\r
- function service($data=null, $return_payload=false)\r
- {\r
- if ($data === null)\r
- {\r
- // workaround for a known bug in php ver. 5.2.2 that broke $HTTP_RAW_POST_DATA\r
- $data = file_get_contents('php://input');\r
- }\r
- $raw_data = $data;\r
-\r
- // reset internal debug info\r
- $this->debug_info = '';\r
-\r
- // Echo back what we received, before parsing it\r
- if($this->debug > 1)\r
- {\r
- $this->debugmsg("+++GOT+++\n" . $data . "\n+++END+++");\r
- }\r
-\r
- $r = $this->parseRequestHeaders($data, $req_charset, $resp_charset, $resp_encoding);\r
- if (!$r)\r
- {\r
- $r=$this->parseRequest($data, $req_charset);\r
- }\r
-\r
- // save full body of request into response, for more debugging usages\r
- $r->raw_data = $raw_data;\r
-\r
- if($this->debug > 2 && $GLOBALS['_xmlrpcs_occurred_errors'])\r
- {\r
- $this->debugmsg("+++PROCESSING ERRORS AND WARNINGS+++\n" .\r
- $GLOBALS['_xmlrpcs_occurred_errors'] . "+++END+++");\r
- }\r
-\r
- $payload=$this->xml_header($resp_charset);\r
- if($this->debug > 0)\r
- {\r
- $payload = $payload . $this->serializeDebug($resp_charset);\r
- }\r
-\r
- // G. Giunta 2006-01-27: do not create response serialization if it has\r
- // already happened. Helps building json magic\r
- if (empty($r->payload))\r
- {\r
- $r->serialize($resp_charset);\r
- }\r
- $payload = $payload . $r->payload;\r
-\r
- if ($return_payload)\r
- {\r
- return $payload;\r
- }\r
-\r
- // if we get a warning/error that has output some text before here, then we cannot\r
- // add a new header. We cannot say we are sending xml, either...\r
- if(!headers_sent())\r
- {\r
- header('Content-Type: '.$r->content_type);\r
- // we do not know if client actually told us an accepted charset, but if he did\r
- // we have to tell him what we did\r
- header("Vary: Accept-Charset");\r
-\r
- // http compression of output: only\r
- // if we can do it, and we want to do it, and client asked us to,\r
- // and php ini settings do not force it already\r
- $php_no_self_compress = !ini_get('zlib.output_compression') && (ini_get('output_handler') != 'ob_gzhandler');\r
- if($this->compress_response && function_exists('gzencode') && $resp_encoding != ''\r
- && $php_no_self_compress)\r
- {\r
- if(strpos($resp_encoding, 'gzip') !== false)\r
- {\r
- $payload = gzencode($payload);\r
- header("Content-Encoding: gzip");\r
- header("Vary: Accept-Encoding");\r
- }\r
- elseif (strpos($resp_encoding, 'deflate') !== false)\r
- {\r
- $payload = gzcompress($payload);\r
- header("Content-Encoding: deflate");\r
- header("Vary: Accept-Encoding");\r
- }\r
- }\r
-\r
- // do not ouput content-length header if php is compressing output for us:\r
- // it will mess up measurements\r
- if($php_no_self_compress)\r
- {\r
- header('Content-Length: ' . (int)strlen($payload));\r
- }\r
- }\r
- else\r
- {\r
- error_log('XML-RPC: '.__METHOD__.': http headers already sent before response is fully generated. Check for php warning or error messages');\r
- }\r
-\r
- print $payload;\r
-\r
- // return request, in case subclasses want it\r
- return $r;\r
- }\r
-\r
- /**\r
- * Add a method to the dispatch map\r
- * @param string $methodname the name with which the method will be made available\r
- * @param string $function the php function that will get invoked\r
- * @param array $sig the array of valid method signatures\r
- * @param string $doc method documentation\r
- * @param array $sigdoc the array of valid method signatures docs (one string per param, one for return type)\r
- * @access public\r
- */\r
- function add_to_map($methodname,$function,$sig=null,$doc=false,$sigdoc=false)\r
- {\r
- $this->dmap[$methodname] = array(\r
- 'function' => $function,\r
- 'docstring' => $doc\r
- );\r
- if ($sig)\r
- {\r
- $this->dmap[$methodname]['signature'] = $sig;\r
- }\r
- if ($sigdoc)\r
- {\r
- $this->dmap[$methodname]['signature_docs'] = $sigdoc;\r
- }\r
- }\r
-\r
- /**\r
- * Verify type and number of parameters received against a list of known signatures\r
- * @param array $in array of either xmlrpcval objects or xmlrpc type definitions\r
- * @param array $sig array of known signatures to match against\r
- * @return array\r
- * @access private\r
- */\r
- function verifySignature($in, $sig)\r
- {\r
- // check each possible signature in turn\r
- if (is_object($in))\r
- {\r
- $numParams = $in->getNumParams();\r
- }\r
- else\r
- {\r
- $numParams = count($in);\r
- }\r
- foreach($sig as $cursig)\r
- {\r
- if(count($cursig)==$numParams+1)\r
- {\r
- $itsOK=1;\r
- for($n=0; $n<$numParams; $n++)\r
- {\r
- if (is_object($in))\r
- {\r
- $p=$in->getParam($n);\r
- if($p->kindOf() == 'scalar')\r
- {\r
- $pt=$p->scalartyp();\r
- }\r
- else\r
- {\r
- $pt=$p->kindOf();\r
- }\r
- }\r
- else\r
- {\r
- $pt= $in[$n] == 'i4' ? 'int' : strtolower($in[$n]); // dispatch maps never use i4...\r
- }\r
-\r
- // param index is $n+1, as first member of sig is return type\r
- if($pt != $cursig[$n+1] && $cursig[$n+1] != $GLOBALS['xmlrpcValue'])\r
- {\r
- $itsOK=0;\r
- $pno=$n+1;\r
- $wanted=$cursig[$n+1];\r
- $got=$pt;\r
- break;\r
- }\r
- }\r
- if($itsOK)\r
- {\r
- return array(1,'');\r
- }\r
- }\r
- }\r
- if(isset($wanted))\r
- {\r
- return array(0, "Wanted ${wanted}, got ${got} at param ${pno}");\r
- }\r
- else\r
- {\r
- return array(0, "No method signature matches number of parameters");\r
- }\r
- }\r
-\r
- /**\r
- * Parse http headers received along with xmlrpc request. If needed, inflate request\r
- * @return mixed null on success or an xmlrpcresp\r
- * @access private\r
- */\r
- function parseRequestHeaders(&$data, &$req_encoding, &$resp_encoding, &$resp_compression)\r
- {\r
- // check if $_SERVER is populated: it might have been disabled via ini file\r
- // (this is true even when in CLI mode)\r
- if (count($_SERVER) == 0)\r
- {\r
- error_log('XML-RPC: '.__METHOD__.': cannot parse request headers as $_SERVER is not populated');\r
- }\r
-\r
- if($this->debug > 1)\r
- {\r
- if(function_exists('getallheaders'))\r
- {\r
- $this->debugmsg(''); // empty line\r
- foreach(getallheaders() as $name => $val)\r
- {\r
- $this->debugmsg("HEADER: $name: $val");\r
- }\r
- }\r
-\r
- }\r
-\r
- if(isset($_SERVER['HTTP_CONTENT_ENCODING']))\r
- {\r
- $content_encoding = str_replace('x-', '', $_SERVER['HTTP_CONTENT_ENCODING']);\r
- }\r
- else\r
- {\r
- $content_encoding = '';\r
- }\r
-\r
- // check if request body has been compressed and decompress it\r
- if($content_encoding != '' && strlen($data))\r
- {\r
- if($content_encoding == 'deflate' || $content_encoding == 'gzip')\r
- {\r
- // if decoding works, use it. else assume data wasn't gzencoded\r
- if(function_exists('gzinflate') && in_array($content_encoding, $this->accepted_compression))\r
- {\r
- if($content_encoding == 'deflate' && $degzdata = @gzuncompress($data))\r
- {\r
- $data = $degzdata;\r
- if($this->debug > 1)\r
- {\r
- $this->debugmsg("\n+++INFLATED REQUEST+++[".strlen($data)." chars]+++\n" . $data . "\n+++END+++");\r
- }\r
- }\r
- elseif($content_encoding == 'gzip' && $degzdata = @gzinflate(substr($data, 10)))\r
- {\r
- $data = $degzdata;\r
- if($this->debug > 1)\r
- $this->debugmsg("+++INFLATED REQUEST+++[".strlen($data)." chars]+++\n" . $data . "\n+++END+++");\r
- }\r
- else\r
- {\r
- $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['server_decompress_fail'], $GLOBALS['xmlrpcstr']['server_decompress_fail']);\r
- return $r;\r
- }\r
- }\r
- else\r
- {\r
- //error_log('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']['server_cannot_decompress'], $GLOBALS['xmlrpcstr']['server_cannot_decompress']);\r
- return $r;\r
- }\r
- }\r
- }\r
-\r
- // check if client specified accepted charsets, and if we know how to fulfill\r
- // the request\r
- if ($this->response_charset_encoding == 'auto')\r
- {\r
- $resp_encoding = '';\r
- if (isset($_SERVER['HTTP_ACCEPT_CHARSET']))\r
- {\r
- // here we should check if we can match the client-requested encoding\r
- // with the encodings we know we can generate.\r
- /// @todo we should parse q=0.x preferences instead of getting first charset specified...\r
- $client_accepted_charsets = explode(',', strtoupper($_SERVER['HTTP_ACCEPT_CHARSET']));\r
- // Give preference to internal encoding\r
- $known_charsets = array($GLOBALS['xmlrpc_internalencoding'], 'UTF-8', 'ISO-8859-1', 'US-ASCII');\r
- foreach ($known_charsets as $charset)\r
- {\r
- foreach ($client_accepted_charsets as $accepted)\r
- if (strpos($accepted, $charset) === 0)\r
- {\r
- $resp_encoding = $charset;\r
- break;\r
- }\r
- if ($resp_encoding)\r
- break;\r
- }\r
- }\r
- }\r
- else\r
- {\r
- $resp_encoding = $this->response_charset_encoding;\r
- }\r
-\r
- if (isset($_SERVER['HTTP_ACCEPT_ENCODING']))\r
- {\r
- $resp_compression = $_SERVER['HTTP_ACCEPT_ENCODING'];\r
- }\r
- else\r
- {\r
- $resp_compression = '';\r
- }\r
-\r
- // 'guestimate' request encoding\r
- /// @todo check if mbstring is enabled and automagic input conversion is on: it might mingle with this check???\r
- $req_encoding = guess_encoding(isset($_SERVER['CONTENT_TYPE']) ? $_SERVER['CONTENT_TYPE'] : '',\r
- $data);\r
-\r
- return null;\r
- }\r
-\r
- /**\r
- * Parse an xml chunk containing an xmlrpc request and execute the corresponding\r
- * php function registered with the server\r
- * @param string $data the xml request\r
- * @param string $req_encoding (optional) the charset encoding of the xml request\r
- * @return xmlrpcresp\r
- * @access private\r
- */\r
- function parseRequest($data, $req_encoding='')\r
- {\r
- // 2005/05/07 commented and moved into caller function code\r
- //if($data=='')\r
- //{\r
- // $data=$GLOBALS['HTTP_RAW_POST_DATA'];\r
- //}\r
-\r
- // G. Giunta 2005/02/13: we do NOT expect to receive html entities\r
- // so we do not try to convert them into xml character entities\r
- //$data = xmlrpc_html_entity_xlate($data);\r
-\r
- $GLOBALS['_xh']=array();\r
- $GLOBALS['_xh']['ac']='';\r
- $GLOBALS['_xh']['stack']=array();\r
- $GLOBALS['_xh']['valuestack'] = array();\r
- $GLOBALS['_xh']['params']=array();\r
- $GLOBALS['_xh']['pt']=array();\r
- $GLOBALS['_xh']['isf']=0;\r
- $GLOBALS['_xh']['isf_reason']='';\r
- $GLOBALS['_xh']['method']=false; // so we can check later if we got a methodname or not\r
- $GLOBALS['_xh']['rt']='';\r
-\r
- // decompose incoming XML into request structure\r
- if ($req_encoding != '')\r
- {\r
- if (!in_array($req_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))\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($req_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))\r
- {\r
- error_log('XML-RPC: '.__METHOD__.': invalid charset encoding of received request: '.$req_encoding);\r
- $req_encoding = $GLOBALS['xmlrpc_defencoding'];\r
- }\r
- /// @BUG this will fail on PHP 5 if charset is not specified in the xml prologue,\r
- // the encoding is not UTF8 and there are non-ascii chars in the text...\r
- /// @todo use an empty string for php 5 ???\r
- $parser = xml_parser_create($req_encoding);\r
- }\r
- else\r
- {\r
- $parser = xml_parser_create();\r
- }\r
-\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
- // What if internal encoding is not in one of the 3 allowed?\r
- // we use the broadest one, ie. utf8\r
- // This allows to send data which is native in various charset,\r
- // by extending xmlrpc_encode_entitites() and setting xmlrpc_internalencoding\r
- if (!in_array($GLOBALS['xmlrpc_internalencoding'], array('UTF-8', 'ISO-8859-1', 'US-ASCII')))\r
- {\r
- xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');\r
- }\r
- else\r
- {\r
- xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $GLOBALS['xmlrpc_internalencoding']);\r
- }\r
-\r
- if ($this->functions_parameters_type != 'xmlrpcvals')\r
- xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast');\r
- else\r
- xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee');\r
- xml_set_character_data_handler($parser, 'xmlrpc_cd');\r
- xml_set_default_handler($parser, 'xmlrpc_dh');\r
- if(!xml_parse($parser, $data, 1))\r
- {\r
- // return XML error as a faultCode\r
- $r=new xmlrpcresp(0,\r
- $GLOBALS['xmlrpcerrxml']+xml_get_error_code($parser),\r
- sprintf('XML error: %s at line %d, column %d',\r
- xml_error_string(xml_get_error_code($parser)),\r
- xml_get_current_line_number($parser), xml_get_current_column_number($parser)));\r
- xml_parser_free($parser);\r
- }\r
- elseif ($GLOBALS['_xh']['isf'])\r
- {\r
- xml_parser_free($parser);\r
- $r=new xmlrpcresp(0,\r
- $GLOBALS['xmlrpcerr']['invalid_request'],\r
- $GLOBALS['xmlrpcstr']['invalid_request'] . ' ' . $GLOBALS['_xh']['isf_reason']);\r
- }\r
- else\r
- {\r
- xml_parser_free($parser);\r
- // small layering violation in favor of speed and memory usage:\r
- // we should allow the 'execute' method handle this, but in the\r
- // most common scenario (xmlrpcvals type server with some methods\r
- // registered as phpvals) that would mean a useless encode+decode pass\r
- if ($this->functions_parameters_type != 'xmlrpcvals' || (isset($this->dmap[$GLOBALS['_xh']['method']]['parameters_type']) && ($this->dmap[$GLOBALS['_xh']['method']]['parameters_type'] == 'phpvals')))\r
- {\r
- if($this->debug > 1)\r
- {\r
- $this->debugmsg("\n+++PARSED+++\n".var_export($GLOBALS['_xh']['params'], true)."\n+++END+++");\r
- }\r
- $r = $this->execute($GLOBALS['_xh']['method'], $GLOBALS['_xh']['params'], $GLOBALS['_xh']['pt']);\r
- }\r
- else\r
- {\r
- // build an xmlrpcmsg object with data parsed from xml\r
- $m=new xmlrpcmsg($GLOBALS['_xh']['method']);\r
- // now add parameters in\r
- for($i=0; $i<count($GLOBALS['_xh']['params']); $i++)\r
- {\r
- $m->addParam($GLOBALS['_xh']['params'][$i]);\r
- }\r
-\r
- if($this->debug > 1)\r
- {\r
- $this->debugmsg("\n+++PARSED+++\n".var_export($m, true)."\n+++END+++");\r
- }\r
- $r = $this->execute($m);\r
- }\r
- }\r
- return $r;\r
- }\r
-\r
- /**\r
- * Execute a method invoked by the client, checking parameters used\r
- * @param mixed $m either an xmlrpcmsg obj or a method name\r
- * @param array $params array with method parameters as php types (if m is method name only)\r
- * @param array $paramtypes array with xmlrpc types of method parameters (if m is method name only)\r
- * @return xmlrpcresp\r
- * @access private\r
- */\r
- function execute($m, $params=null, $paramtypes=null)\r
- {\r
- if (is_object($m))\r
- {\r
- $methName = $m->method();\r
- }\r
- else\r
- {\r
- $methName = $m;\r
- }\r
- $sysCall = $this->allow_system_funcs && (strpos($methName, "system.") === 0);\r
- $dmap = $sysCall ? $GLOBALS['_xmlrpcs_dmap'] : $this->dmap;\r
-\r
- if(!isset($dmap[$methName]['function']))\r
- {\r
- // No such method\r
- return new xmlrpcresp(0,\r
- $GLOBALS['xmlrpcerr']['unknown_method'],\r
- $GLOBALS['xmlrpcstr']['unknown_method']);\r
- }\r
-\r
- // Check signature\r
- if(isset($dmap[$methName]['signature']))\r
- {\r
- $sig = $dmap[$methName]['signature'];\r
- if (is_object($m))\r
- {\r
- list($ok, $errstr) = $this->verifySignature($m, $sig);\r
- }\r
- else\r
- {\r
- list($ok, $errstr) = $this->verifySignature($paramtypes, $sig);\r
- }\r
- if(!$ok)\r
- {\r
- // Didn't match.\r
- return new xmlrpcresp(\r
- 0,\r
- $GLOBALS['xmlrpcerr']['incorrect_params'],\r
- $GLOBALS['xmlrpcstr']['incorrect_params'] . ": ${errstr}"\r
- );\r
- }\r
- }\r
-\r
- $func = $dmap[$methName]['function'];\r
- // let the 'class::function' syntax be accepted in dispatch maps\r
- if(is_string($func) && strpos($func, '::'))\r
- {\r
- $func = explode('::', $func);\r
- }\r
- // verify that function to be invoked is in fact callable\r
- if(!is_callable($func))\r
- {\r
- error_log("XML-RPC: ".__METHOD__.": function $func registered as method handler is not callable");\r
- return new xmlrpcresp(\r
- 0,\r
- $GLOBALS['xmlrpcerr']['server_error'],\r
- $GLOBALS['xmlrpcstr']['server_error'] . ": no function matches method"\r
- );\r
- }\r
-\r
- // If debug level is 3, we should catch all errors generated during\r
- // processing of user function, and log them as part of response\r
- if($this->debug > 2)\r
- {\r
- $GLOBALS['_xmlrpcs_prev_ehandler'] = set_error_handler('_xmlrpcs_errorHandler');\r
- }\r
- try\r
- {\r
- // Allow mixed-convention servers\r
- if (is_object($m))\r
- {\r
- if($sysCall)\r
- {\r
- $r = call_user_func($func, $this, $m);\r
- }\r
- else\r
- {\r
- $r = call_user_func($func, $m);\r
- }\r
- if (!is_a($r, 'xmlrpcresp'))\r
- {\r
- error_log("XML-RPC: ".__METHOD__.": function $func registered as method handler does not return an xmlrpcresp object");\r
- if (is_a($r, 'xmlrpcval'))\r
- {\r
- $r = new xmlrpcresp($r);\r
- }\r
- else\r
- {\r
- $r = new xmlrpcresp(\r
- 0,\r
- $GLOBALS['xmlrpcerr']['server_error'],\r
- $GLOBALS['xmlrpcstr']['server_error'] . ": function does not return xmlrpcresp object"\r
- );\r
- }\r
- }\r
- }\r
- else\r
- {\r
- // call a 'plain php' function\r
- if($sysCall)\r
- {\r
- array_unshift($params, $this);\r
- $r = call_user_func_array($func, $params);\r
- }\r
- else\r
- {\r
- // 3rd API convention for method-handling functions: EPI-style\r
- if ($this->functions_parameters_type == 'epivals')\r
- {\r
- $r = call_user_func_array($func, array($methName, $params, $this->user_data));\r
- // mimic EPI behaviour: if we get an array that looks like an error, make it\r
- // an eror response\r
- if (is_array($r) && array_key_exists('faultCode', $r) && array_key_exists('faultString', $r))\r
- {\r
- $r = new xmlrpcresp(0, (integer)$r['faultCode'], (string)$r['faultString']);\r
- }\r
- else\r
- {\r
- // functions using EPI api should NOT return resp objects,\r
- // so make sure we encode the return type correctly\r
- $r = new xmlrpcresp(php_xmlrpc_encode($r, array('extension_api')));\r
- }\r
- }\r
- else\r
- {\r
- $r = call_user_func_array($func, $params);\r
- }\r
- }\r
- // the return type can be either an xmlrpcresp object or a plain php value...\r
- if (!is_a($r, 'xmlrpcresp'))\r
- {\r
- // what should we assume here about automatic encoding of datetimes\r
- // and php classes instances???\r
- $r = new xmlrpcresp(php_xmlrpc_encode($r, $this->phpvals_encoding_options));\r
- }\r
- }\r
- }\r
- catch(Exception $e)\r
- {\r
- // (barring errors in the lib) an uncatched exception happened\r
- // in the called function, we wrap it in a proper error-response\r
- switch($this->exception_handling)\r
- {\r
- case 2:\r
- throw $e;\r
- break;\r
- case 1:\r
- $r = new xmlrpcresp(0, $e->getCode(), $e->getMessage());\r
- break;\r
- default:\r
- $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['server_error'], $GLOBALS['xmlrpcstr']['server_error']);\r
- }\r
- }\r
- if($this->debug > 2)\r
- {\r
- // note: restore the error handler we found before calling the\r
- // user func, even if it has been changed inside the func itself\r
- if($GLOBALS['_xmlrpcs_prev_ehandler'])\r
- {\r
- set_error_handler($GLOBALS['_xmlrpcs_prev_ehandler']);\r
- }\r
- else\r
- {\r
- restore_error_handler();\r
- }\r
- }\r
- return $r;\r
- }\r
-\r
- /**\r
- * add a string to the 'internal debug message' (separate from 'user debug message')\r
- * @param string $string\r
- * @access private\r
- */\r
- function debugmsg($string)\r
- {\r
- $this->debug_info .= $string."\n";\r
- }\r
-\r
- /**\r
- * @access private\r
- */\r
- function xml_header($charset_encoding='')\r
- {\r
- if ($charset_encoding != '')\r
- {\r
- return "<?xml version=\"1.0\" encoding=\"$charset_encoding\"?" . ">\n";\r
- }\r
- else\r
- {\r
- return "<?xml version=\"1.0\"?" . ">\n";\r
- }\r
- }\r
-\r
- /**\r
- * A debugging routine: just echoes back the input packet as a string value\r
- * DEPRECATED!\r
- */\r
- function echoInput()\r
- {\r
- $r=new xmlrpcresp(new xmlrpcval( "'Aha said I: '" . $GLOBALS['HTTP_RAW_POST_DATA'], 'string'));\r
- print $r->serialize();\r
- }\r
- }\r
+\r
+// XML RPC Server class\r
+// requires: xmlrpc.inc\r
+\r
+$GLOBALS['xmlrpcs_capabilities'] = array(\r
+ // xmlrpc spec: always supported\r
+ 'xmlrpc' => new xmlrpcval(array(\r
+ 'specUrl' => new xmlrpcval('http://www.xmlrpc.com/spec', 'string'),\r
+ 'specVersion' => new xmlrpcval(1, 'int')\r
+ ), 'struct'),\r
+ // if we support system.xxx functions, we always support multicall, too...\r
+ // Note that, as of 2006/09/17, the following URL does not respond anymore\r
+ 'system.multicall' => new xmlrpcval(array(\r
+ 'specUrl' => new xmlrpcval('http://www.xmlrpc.com/discuss/msgReader$1208', 'string'),\r
+ 'specVersion' => new xmlrpcval(1, 'int')\r
+ ), 'struct'),\r
+ // introspection: version 2! we support 'mixed', too\r
+ 'introspection' => new xmlrpcval(array(\r
+ 'specUrl' => new xmlrpcval('http://phpxmlrpc.sourceforge.net/doc-2/ch10.html', 'string'),\r
+ 'specVersion' => new xmlrpcval(2, 'int')\r
+ ), 'struct')\r
+);\r
+\r
+/* Functions that implement system.XXX methods of xmlrpc servers */\r
+$_xmlrpcs_getCapabilities_sig=array(array($GLOBALS['xmlrpcStruct']));\r
+$_xmlrpcs_getCapabilities_doc='This method lists all the capabilites that the XML-RPC server has: the (more or less standard) extensions to the xmlrpc spec that it adheres to';\r
+$_xmlrpcs_getCapabilities_sdoc=array(array('list of capabilities, described as structs with a version number and url for the spec'));\r
+function _xmlrpcs_getCapabilities($server, $m=null)\r
+{\r
+ $outAr = $GLOBALS['xmlrpcs_capabilities'];\r
+ // NIL extension\r
+ if ($GLOBALS['xmlrpc_null_extension']) {\r
+ $outAr['nil'] = new xmlrpcval(array(\r
+ 'specUrl' => new xmlrpcval('http://www.ontosys.com/xml-rpc/extensions.php', 'string'),\r
+ 'specVersion' => new xmlrpcval(1, 'int')\r
+ ), 'struct');\r
+ }\r
+ return new xmlrpcresp(new xmlrpcval($outAr, 'struct'));\r
+}\r
+\r
+// listMethods: signature was either a string, or nothing.\r
+// The useless string variant has been removed\r
+$_xmlrpcs_listMethods_sig=array(array($GLOBALS['xmlrpcArray']));\r
+$_xmlrpcs_listMethods_doc='This method lists all the methods that the XML-RPC server knows how to dispatch';\r
+$_xmlrpcs_listMethods_sdoc=array(array('list of method names'));\r
+function _xmlrpcs_listMethods($server, $m=null) // if called in plain php values mode, second param is missing\r
+{\r
+\r
+ $outAr=array();\r
+ foreach($server->dmap as $key => $val)\r
+ {\r
+ $outAr[]=new xmlrpcval($key, 'string');\r
+ }\r
+ if($server->allow_system_funcs)\r
+ {\r
+ foreach($GLOBALS['_xmlrpcs_dmap'] as $key => $val)\r
+ {\r
+ $outAr[]=new xmlrpcval($key, 'string');\r
+ }\r
+ }\r
+ return new xmlrpcresp(new xmlrpcval($outAr, 'array'));\r
+}\r
+\r
+$_xmlrpcs_methodSignature_sig=array(array($GLOBALS['xmlrpcArray'], $GLOBALS['xmlrpcString']));\r
+$_xmlrpcs_methodSignature_doc='Returns an array of known signatures (an array of arrays) for the method name passed. If no signatures are known, returns a none-array (test for type != array to detect missing signature)';\r
+$_xmlrpcs_methodSignature_sdoc=array(array('list of known signatures, each sig being an array of xmlrpc type names', 'name of method to be described'));\r
+function _xmlrpcs_methodSignature($server, $m)\r
+{\r
+ // let accept as parameter both an xmlrpcval or string\r
+ if (is_object($m))\r
+ {\r
+ $methName=$m->getParam(0);\r
+ $methName=$methName->scalarval();\r
+ }\r
+ else\r
+ {\r
+ $methName=$m;\r
+ }\r
+ if(strpos($methName, "system.") === 0)\r
+ {\r
+ $dmap=$GLOBALS['_xmlrpcs_dmap']; $sysCall=1;\r
+ }\r
+ else\r
+ {\r
+ $dmap=$server->dmap; $sysCall=0;\r
+ }\r
+ if(isset($dmap[$methName]))\r
+ {\r
+ if(isset($dmap[$methName]['signature']))\r
+ {\r
+ $sigs=array();\r
+ foreach($dmap[$methName]['signature'] as $inSig)\r
+ {\r
+ $cursig=array();\r
+ foreach($inSig as $sig)\r
+ {\r
+ $cursig[]=new xmlrpcval($sig, 'string');\r
+ }\r
+ $sigs[]=new xmlrpcval($cursig, 'array');\r
+ }\r
+ $r=new xmlrpcresp(new xmlrpcval($sigs, 'array'));\r
+ }\r
+ else\r
+ {\r
+ // NB: according to the official docs, we should be returning a\r
+ // "none-array" here, which means not-an-array\r
+ $r=new xmlrpcresp(new xmlrpcval('undef', 'string'));\r
+ }\r
+ }\r
+ else\r
+ {\r
+ $r=new xmlrpcresp(0,$GLOBALS['xmlrpcerr']['introspect_unknown'], $GLOBALS['xmlrpcstr']['introspect_unknown']);\r
+ }\r
+ return $r;\r
+}\r
+\r
+$_xmlrpcs_methodHelp_sig=array(array($GLOBALS['xmlrpcString'], $GLOBALS['xmlrpcString']));\r
+$_xmlrpcs_methodHelp_doc='Returns help text if defined for the method passed, otherwise returns an empty string';\r
+$_xmlrpcs_methodHelp_sdoc=array(array('method description', 'name of the method to be described'));\r
+function _xmlrpcs_methodHelp($server, $m)\r
+{\r
+ // let accept as parameter both an xmlrpcval or string\r
+ if (is_object($m))\r
+ {\r
+ $methName=$m->getParam(0);\r
+ $methName=$methName->scalarval();\r
+ }\r
+ else\r
+ {\r
+ $methName=$m;\r
+ }\r
+ if(strpos($methName, "system.") === 0)\r
+ {\r
+ $dmap=$GLOBALS['_xmlrpcs_dmap']; $sysCall=1;\r
+ }\r
+ else\r
+ {\r
+ $dmap=$server->dmap; $sysCall=0;\r
+ }\r
+ if(isset($dmap[$methName]))\r
+ {\r
+ if(isset($dmap[$methName]['docstring']))\r
+ {\r
+ $r=new xmlrpcresp(new xmlrpcval($dmap[$methName]['docstring']), 'string');\r
+ }\r
+ else\r
+ {\r
+ $r=new xmlrpcresp(new xmlrpcval('', 'string'));\r
+ }\r
+ }\r
+ else\r
+ {\r
+ $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['introspect_unknown'], $GLOBALS['xmlrpcstr']['introspect_unknown']);\r
+ }\r
+ return $r;\r
+}\r
+\r
+$_xmlrpcs_multicall_sig = array(array($GLOBALS['xmlrpcArray'], $GLOBALS['xmlrpcArray']));\r
+$_xmlrpcs_multicall_doc = 'Boxcar multiple RPC calls in one request. See http://www.xmlrpc.com/discuss/msgReader$1208 for details';\r
+$_xmlrpcs_multicall_sdoc = array(array('list of response structs, where each struct has the usual members', 'list of calls, with each call being represented as a struct, with members "methodname" and "params"'));\r
+function _xmlrpcs_multicall_error($err)\r
+{\r
+ if(is_string($err))\r
+ {\r
+ $str = $GLOBALS['xmlrpcstr']["multicall_${err}"];\r
+ $code = $GLOBALS['xmlrpcerr']["multicall_${err}"];\r
+ }\r
+ else\r
+ {\r
+ $code = $err->faultCode();\r
+ $str = $err->faultString();\r
+ }\r
+ $struct = array();\r
+ $struct['faultCode'] = new xmlrpcval($code, 'int');\r
+ $struct['faultString'] = new xmlrpcval($str, 'string');\r
+ return new xmlrpcval($struct, 'struct');\r
+}\r
+\r
+function _xmlrpcs_multicall_do_call($server, $call)\r
+{\r
+ if($call->kindOf() != 'struct')\r
+ {\r
+ return _xmlrpcs_multicall_error('notstruct');\r
+ }\r
+ $methName = @$call->structmem('methodName');\r
+ if(!$methName)\r
+ {\r
+ return _xmlrpcs_multicall_error('nomethod');\r
+ }\r
+ if($methName->kindOf() != 'scalar' || $methName->scalartyp() != 'string')\r
+ {\r
+ return _xmlrpcs_multicall_error('notstring');\r
+ }\r
+ if($methName->scalarval() == 'system.multicall')\r
+ {\r
+ return _xmlrpcs_multicall_error('recursion');\r
+ }\r
+\r
+ $params = @$call->structmem('params');\r
+ if(!$params)\r
+ {\r
+ return _xmlrpcs_multicall_error('noparams');\r
+ }\r
+ if($params->kindOf() != 'array')\r
+ {\r
+ return _xmlrpcs_multicall_error('notarray');\r
+ }\r
+ $numParams = $params->arraysize();\r
+\r
+ $msg = new xmlrpcmsg($methName->scalarval());\r
+ for($i = 0; $i < $numParams; $i++)\r
+ {\r
+ if(!$msg->addParam($params->arraymem($i)))\r
+ {\r
+ $i++;\r
+ return _xmlrpcs_multicall_error(new xmlrpcresp(0,\r
+ $GLOBALS['xmlrpcerr']['incorrect_params'],\r
+ $GLOBALS['xmlrpcstr']['incorrect_params'] . ": probable xml error in param " . $i));\r
+ }\r
+ }\r
+\r
+ $result = $server->execute($msg);\r
+\r
+ if($result->faultCode() != 0)\r
+ {\r
+ return _xmlrpcs_multicall_error($result); // Method returned fault.\r
+ }\r
+\r
+ return new xmlrpcval(array($result->value()), 'array');\r
+}\r
+\r
+function _xmlrpcs_multicall_do_call_phpvals($server, $call)\r
+{\r
+ if(!is_array($call))\r
+ {\r
+ return _xmlrpcs_multicall_error('notstruct');\r
+ }\r
+ if(!array_key_exists('methodName', $call))\r
+ {\r
+ return _xmlrpcs_multicall_error('nomethod');\r
+ }\r
+ if (!is_string($call['methodName']))\r
+ {\r
+ return _xmlrpcs_multicall_error('notstring');\r
+ }\r
+ if($call['methodName'] == 'system.multicall')\r
+ {\r
+ return _xmlrpcs_multicall_error('recursion');\r
+ }\r
+ if(!array_key_exists('params', $call))\r
+ {\r
+ return _xmlrpcs_multicall_error('noparams');\r
+ }\r
+ if(!is_array($call['params']))\r
+ {\r
+ return _xmlrpcs_multicall_error('notarray');\r
+ }\r
+\r
+ // this is a real dirty and simplistic hack, since we might have received a\r
+ // base64 or datetime values, but they will be listed as strings here...\r
+ $numParams = count($call['params']);\r
+ $pt = array();\r
+ foreach($call['params'] as $val)\r
+ $pt[] = php_2_xmlrpc_type(gettype($val));\r
+\r
+ $result = $server->execute($call['methodName'], $call['params'], $pt);\r
+\r
+ if($result->faultCode() != 0)\r
+ {\r
+ return _xmlrpcs_multicall_error($result); // Method returned fault.\r
+ }\r
+\r
+ return new xmlrpcval(array($result->value()), 'array');\r
+}\r
+\r
+function _xmlrpcs_multicall($server, $m)\r
+{\r
+ $result = array();\r
+ // let accept a plain list of php parameters, beside a single xmlrpc msg object\r
+ if (is_object($m))\r
+ {\r
+ $calls = $m->getParam(0);\r
+ $numCalls = $calls->arraysize();\r
+ for($i = 0; $i < $numCalls; $i++)\r
+ {\r
+ $call = $calls->arraymem($i);\r
+ $result[$i] = _xmlrpcs_multicall_do_call($server, $call);\r
+ }\r
+ }\r
+ else\r
+ {\r
+ $numCalls=count($m);\r
+ for($i = 0; $i < $numCalls; $i++)\r
+ {\r
+ $result[$i] = _xmlrpcs_multicall_do_call_phpvals($server, $m[$i]);\r
+ }\r
+ }\r
+\r
+ return new xmlrpcresp(new xmlrpcval($result, 'array'));\r
+}\r
+\r
+$GLOBALS['_xmlrpcs_dmap']=array(\r
+ 'system.listMethods' => array(\r
+ 'function' => '_xmlrpcs_listMethods',\r
+ 'signature' => $_xmlrpcs_listMethods_sig,\r
+ 'docstring' => $_xmlrpcs_listMethods_doc,\r
+ 'signature_docs' => $_xmlrpcs_listMethods_sdoc),\r
+ 'system.methodHelp' => array(\r
+ 'function' => '_xmlrpcs_methodHelp',\r
+ 'signature' => $_xmlrpcs_methodHelp_sig,\r
+ 'docstring' => $_xmlrpcs_methodHelp_doc,\r
+ 'signature_docs' => $_xmlrpcs_methodHelp_sdoc),\r
+ 'system.methodSignature' => array(\r
+ 'function' => '_xmlrpcs_methodSignature',\r
+ 'signature' => $_xmlrpcs_methodSignature_sig,\r
+ 'docstring' => $_xmlrpcs_methodSignature_doc,\r
+ 'signature_docs' => $_xmlrpcs_methodSignature_sdoc),\r
+ 'system.multicall' => array(\r
+ 'function' => '_xmlrpcs_multicall',\r
+ 'signature' => $_xmlrpcs_multicall_sig,\r
+ 'docstring' => $_xmlrpcs_multicall_doc,\r
+ 'signature_docs' => $_xmlrpcs_multicall_sdoc),\r
+ 'system.getCapabilities' => array(\r
+ 'function' => '_xmlrpcs_getCapabilities',\r
+ 'signature' => $_xmlrpcs_getCapabilities_sig,\r
+ 'docstring' => $_xmlrpcs_getCapabilities_doc,\r
+ 'signature_docs' => $_xmlrpcs_getCapabilities_sdoc)\r
+);\r
+\r
+$GLOBALS['_xmlrpcs_occurred_errors'] = '';\r
+$GLOBALS['_xmlrpcs_prev_ehandler'] = '';\r
+\r
+/**\r
+* Error handler used to track errors that occur during server-side execution of PHP code.\r
+* This allows to report back to the client whether an internal error has occurred or not\r
+* using an xmlrpc response object, instead of letting the client deal with the html junk\r
+* that a PHP execution error on the server generally entails.\r
+*\r
+* NB: in fact a user defined error handler can only handle WARNING, NOTICE and USER_* errors.\r
+*\r
+*/\r
+function _xmlrpcs_errorHandler($errcode, $errstring, $filename=null, $lineno=null, $context=null)\r
+{\r
+ // obey the @ protocol\r
+ if (error_reporting() == 0)\r
+ return;\r
+\r
+ //if($errcode != E_NOTICE && $errcode != E_WARNING && $errcode != E_USER_NOTICE && $errcode != E_USER_WARNING)\r
+ if($errcode != E_STRICT)\r
+ {\r
+ $GLOBALS['_xmlrpcs_occurred_errors'] = $GLOBALS['_xmlrpcs_occurred_errors'] . $errstring . "\n";\r
+ }\r
+ // Try to avoid as much as possible disruption to the previous error handling\r
+ // mechanism in place\r
+ if($GLOBALS['_xmlrpcs_prev_ehandler'] == '')\r
+ {\r
+ // The previous error handler was the default: all we should do is log error\r
+ // to the default error log (if level high enough)\r
+ if(ini_get('log_errors') && (intval(ini_get('error_reporting')) & $errcode))\r
+ {\r
+ error_log($errstring);\r
+ }\r
+ }\r
+ else\r
+ {\r
+ // Pass control on to previous error handler, trying to avoid loops...\r
+ if($GLOBALS['_xmlrpcs_prev_ehandler'] != '_xmlrpcs_errorHandler')\r
+ {\r
+ // NB: this code will NOT work on php < 4.0.2: only 2 params were used for error handlers\r
+ if(is_array($GLOBALS['_xmlrpcs_prev_ehandler']))\r
+ {\r
+ // the following works both with static class methods and plain object methods as error handler\r
+ call_user_func_array($GLOBALS['_xmlrpcs_prev_ehandler'], array($errcode, $errstring, $filename, $lineno, $context));\r
+ }\r
+ else\r
+ {\r
+ $GLOBALS['_xmlrpcs_prev_ehandler']($errcode, $errstring, $filename, $lineno, $context);\r
+ }\r
+ }\r
+ }\r
+}\r
+\r
+$GLOBALS['_xmlrpc_debuginfo']='';\r
+\r
+/**\r
+* Add a string to the debug info that can be later seralized by the server\r
+* as part of the response message.\r
+* Note that for best compatibility, the debug string should be encoded using\r
+* the $GLOBALS['xmlrpc_internalencoding'] character set.\r
+* @param string $m\r
+* @access public\r
+*/\r
+function xmlrpc_debugmsg($m)\r
+{\r
+ $GLOBALS['_xmlrpc_debuginfo'] .= $m . "\n";\r
+}\r
+\r
+class xmlrpc_server\r
+{\r
+ /**\r
+ * Array defining php functions exposed as xmlrpc methods by this server\r
+ * @access private\r
+ */\r
+ var $dmap=array();\r
+ /**\r
+ * Defines how functions in dmap will be invoked: either using an xmlrpc msg object\r
+ * or plain php values.\r
+ * valid strings are 'xmlrpcvals', 'phpvals' or 'epivals'\r
+ */\r
+ var $functions_parameters_type='xmlrpcvals';\r
+ /**\r
+ * Option used for fine-tuning the encoding the php values returned from\r
+ * functions registered in the dispatch map when the functions_parameters_types\r
+ * member is set to 'phpvals'\r
+ * @see php_xmlrpc_encode for a list of values\r
+ */\r
+ var $phpvals_encoding_options = array( 'auto_dates' );\r
+ /// controls whether the server is going to echo debugging messages back to the client as comments in response body. valid values: 0,1,2,3\r
+ var $debug = 1;\r
+ /**\r
+ * Controls behaviour of server when invoked user function throws an exception:\r
+ * 0 = catch it and return an 'internal error' xmlrpc response (default)\r
+ * 1 = catch it and return an xmlrpc response with the error corresponding to the exception\r
+ * 2 = allow the exception to float to the upper layers\r
+ */\r
+ var $exception_handling = 0;\r
+ /**\r
+ * When set to true, it will enable HTTP compression of the response, in case\r
+ * the client has declared its support for compression in the request.\r
+ */\r
+ var $compress_response = false;\r
+ /**\r
+ * List of http compression methods accepted by the server for requests.\r
+ * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib\r
+ */\r
+ var $accepted_compression = array();\r
+ /// shall we serve calls to system.* methods?\r
+ var $allow_system_funcs = true;\r
+ /// list of charset encodings natively accepted for requests\r
+ var $accepted_charset_encodings = array();\r
+ /**\r
+ * charset encoding to be used for response.\r
+ * NB: if we can, we will convert the generated response from internal_encoding to the intended one.\r
+ * can be: a supported xml encoding (only UTF-8 and ISO-8859-1 at present, unless mbstring is enabled),\r
+ * null (leave unspecified in response, convert output stream to US_ASCII),\r
+ * 'default' (use xmlrpc library default as specified in xmlrpc.inc, convert output stream if needed),\r
+ * or 'auto' (use client-specified charset encoding or same as request if request headers do not specify it (unless request is US-ASCII: then use library default anyway).\r
+ * NB: pretty dangerous if you accept every charset and do not have mbstring enabled)\r
+ */\r
+ var $response_charset_encoding = '';\r
+ /**\r
+ * Storage for internal debug info\r
+ * @access private\r
+ */\r
+ var $debug_info = '';\r
+ /**\r
+ * Extra data passed at runtime to method handling functions. Used only by EPI layer\r
+ */\r
+ var $user_data = null;\r
+\r
+ /**\r
+ * @param array $dispmap the dispatch map with definition of exposed services\r
+ * @param boolean $servicenow set to false to prevent the server from running upon construction\r
+ */\r
+ function xmlrpc_server($dispMap=null, $serviceNow=true)\r
+ {\r
+ // if ZLIB is enabled, let the server by default accept compressed requests,\r
+ // and compress responses sent to clients that support them\r
+ if(function_exists('gzinflate'))\r
+ {\r
+ $this->accepted_compression = array('gzip', 'deflate');\r
+ $this->compress_response = true;\r
+ }\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
+ // dispMap is a dispatch array of methods\r
+ // mapped to function names and signatures\r
+ // if a method\r
+ // doesn't appear in the map then an unknown\r
+ // method error is generated\r
+ /* milosch - changed to make passing dispMap optional.\r
+ * instead, you can use the class add_to_map() function\r
+ * to add functions manually (borrowed from SOAPX4)\r
+ */\r
+ if($dispMap)\r
+ {\r
+ $this->dmap = $dispMap;\r
+ if($serviceNow)\r
+ {\r
+ $this->service();\r
+ }\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Set debug level of server.\r
+ * @param integer $in debug lvl: determines info added to xmlrpc responses (as xml comments)\r
+ * 0 = no debug info,\r
+ * 1 = msgs set from user with debugmsg(),\r
+ * 2 = add complete xmlrpc request (headers and body),\r
+ * 3 = add also all processing warnings happened during method processing\r
+ * (NB: this involves setting a custom error handler, and might interfere\r
+ * with the standard processing of the php function exposed as method. In\r
+ * particular, triggering an USER_ERROR level error will not halt script\r
+ * execution anymore, but just end up logged in the xmlrpc response)\r
+ * Note that info added at level 2 and 3 will be base64 encoded\r
+ * @access public\r
+ */\r
+ function setDebug($in)\r
+ {\r
+ $this->debug=$in;\r
+ }\r
+\r
+ /**\r
+ * Return a string with the serialized representation of all debug info\r
+ * @param string $charset_encoding the target charset encoding for the serialization\r
+ * @return string an XML comment (or two)\r
+ */\r
+ function serializeDebug($charset_encoding='')\r
+ {\r
+ // Tough encoding problem: which internal charset should we assume for debug info?\r
+ // It might contain a copy of raw data received from client, ie with unknown encoding,\r
+ // intermixed with php generated data and user generated data...\r
+ // so we split it: system debug is base 64 encoded,\r
+ // user debug info should be encoded by the end user using the INTERNAL_ENCODING\r
+ $out = '';\r
+ if ($this->debug_info != '')\r
+ {\r
+ $out .= "<!-- SERVER DEBUG INFO (BASE64 ENCODED):\n".base64_encode($this->debug_info)."\n-->\n";\r
+ }\r
+ if($GLOBALS['_xmlrpc_debuginfo']!='')\r
+ {\r
+\r
+ $out .= "<!-- DEBUG INFO:\n" . xmlrpc_encode_entitites(str_replace('--', '_-', $GLOBALS['_xmlrpc_debuginfo']), $GLOBALS['xmlrpc_internalencoding'], $charset_encoding) . "\n-->\n";\r
+ // NB: a better solution MIGHT be to use CDATA, but we need to insert it\r
+ // into return payload AFTER the beginning tag\r
+ //$out .= "<![CDATA[ DEBUG INFO:\n\n" . str_replace(']]>', ']_]_>', $GLOBALS['_xmlrpc_debuginfo']) . "\n]]>\n";\r
+ }\r
+ return $out;\r
+ }\r
+\r
+ /**\r
+ * Execute the xmlrpc request, printing the response\r
+ * @param string $data the request body. If null, the http POST request will be examined\r
+ * @return xmlrpcresp the response object (usually not used by caller...)\r
+ * @access public\r
+ */\r
+ function service($data=null, $return_payload=false)\r
+ {\r
+ if ($data === null)\r
+ {\r
+ // workaround for a known bug in php ver. 5.2.2 that broke $HTTP_RAW_POST_DATA\r
+ $data = file_get_contents('php://input');\r
+ }\r
+ $raw_data = $data;\r
+\r
+ // reset internal debug info\r
+ $this->debug_info = '';\r
+\r
+ // Echo back what we received, before parsing it\r
+ if($this->debug > 1)\r
+ {\r
+ $this->debugmsg("+++GOT+++\n" . $data . "\n+++END+++");\r
+ }\r
+\r
+ $r = $this->parseRequestHeaders($data, $req_charset, $resp_charset, $resp_encoding);\r
+ if (!$r)\r
+ {\r
+ $r=$this->parseRequest($data, $req_charset);\r
+ }\r
+\r
+ // save full body of request into response, for more debugging usages\r
+ $r->raw_data = $raw_data;\r
+\r
+ if($this->debug > 2 && $GLOBALS['_xmlrpcs_occurred_errors'])\r
+ {\r
+ $this->debugmsg("+++PROCESSING ERRORS AND WARNINGS+++\n" .\r
+ $GLOBALS['_xmlrpcs_occurred_errors'] . "+++END+++");\r
+ }\r
+\r
+ $payload=$this->xml_header($resp_charset);\r
+ if($this->debug > 0)\r
+ {\r
+ $payload = $payload . $this->serializeDebug($resp_charset);\r
+ }\r
+\r
+ // G. Giunta 2006-01-27: do not create response serialization if it has\r
+ // already happened. Helps building json magic\r
+ if (empty($r->payload))\r
+ {\r
+ $r->serialize($resp_charset);\r
+ }\r
+ $payload = $payload . $r->payload;\r
+\r
+ if ($return_payload)\r
+ {\r
+ return $payload;\r
+ }\r
+\r
+ // if we get a warning/error that has output some text before here, then we cannot\r
+ // add a new header. We cannot say we are sending xml, either...\r
+ if(!headers_sent())\r
+ {\r
+ header('Content-Type: '.$r->content_type);\r
+ // we do not know if client actually told us an accepted charset, but if he did\r
+ // we have to tell him what we did\r
+ header("Vary: Accept-Charset");\r
+\r
+ // http compression of output: only\r
+ // if we can do it, and we want to do it, and client asked us to,\r
+ // and php ini settings do not force it already\r
+ $php_no_self_compress = !ini_get('zlib.output_compression') && (ini_get('output_handler') != 'ob_gzhandler');\r
+ if($this->compress_response && function_exists('gzencode') && $resp_encoding != ''\r
+ && $php_no_self_compress)\r
+ {\r
+ if(strpos($resp_encoding, 'gzip') !== false)\r
+ {\r
+ $payload = gzencode($payload);\r
+ header("Content-Encoding: gzip");\r
+ header("Vary: Accept-Encoding");\r
+ }\r
+ elseif (strpos($resp_encoding, 'deflate') !== false)\r
+ {\r
+ $payload = gzcompress($payload);\r
+ header("Content-Encoding: deflate");\r
+ header("Vary: Accept-Encoding");\r
+ }\r
+ }\r
+\r
+ // do not ouput content-length header if php is compressing output for us:\r
+ // it will mess up measurements\r
+ if($php_no_self_compress)\r
+ {\r
+ header('Content-Length: ' . (int)strlen($payload));\r
+ }\r
+ }\r
+ else\r
+ {\r
+ error_log('XML-RPC: '.__METHOD__.': http headers already sent before response is fully generated. Check for php warning or error messages');\r
+ }\r
+\r
+ print $payload;\r
+\r
+ // return request, in case subclasses want it\r
+ return $r;\r
+ }\r
+\r
+ /**\r
+ * Add a method to the dispatch map\r
+ * @param string $methodname the name with which the method will be made available\r
+ * @param string $function the php function that will get invoked\r
+ * @param array $sig the array of valid method signatures\r
+ * @param string $doc method documentation\r
+ * @param array $sigdoc the array of valid method signatures docs (one string per param, one for return type)\r
+ * @access public\r
+ */\r
+ function add_to_map($methodname,$function,$sig=null,$doc=false,$sigdoc=false)\r
+ {\r
+ $this->dmap[$methodname] = array(\r
+ 'function' => $function,\r
+ 'docstring' => $doc\r
+ );\r
+ if ($sig)\r
+ {\r
+ $this->dmap[$methodname]['signature'] = $sig;\r
+ }\r
+ if ($sigdoc)\r
+ {\r
+ $this->dmap[$methodname]['signature_docs'] = $sigdoc;\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Verify type and number of parameters received against a list of known signatures\r
+ * @param array $in array of either xmlrpcval objects or xmlrpc type definitions\r
+ * @param array $sig array of known signatures to match against\r
+ * @return array\r
+ * @access private\r
+ */\r
+ function verifySignature($in, $sig)\r
+ {\r
+ // check each possible signature in turn\r
+ if (is_object($in))\r
+ {\r
+ $numParams = $in->getNumParams();\r
+ }\r
+ else\r
+ {\r
+ $numParams = count($in);\r
+ }\r
+ foreach($sig as $cursig)\r
+ {\r
+ if(count($cursig)==$numParams+1)\r
+ {\r
+ $itsOK=1;\r
+ for($n=0; $n<$numParams; $n++)\r
+ {\r
+ if (is_object($in))\r
+ {\r
+ $p=$in->getParam($n);\r
+ if($p->kindOf() == 'scalar')\r
+ {\r
+ $pt=$p->scalartyp();\r
+ }\r
+ else\r
+ {\r
+ $pt=$p->kindOf();\r
+ }\r
+ }\r
+ else\r
+ {\r
+ $pt= $in[$n] == 'i4' ? 'int' : strtolower($in[$n]); // dispatch maps never use i4...\r
+ }\r
+\r
+ // param index is $n+1, as first member of sig is return type\r
+ if($pt != $cursig[$n+1] && $cursig[$n+1] != $GLOBALS['xmlrpcValue'])\r
+ {\r
+ $itsOK=0;\r
+ $pno=$n+1;\r
+ $wanted=$cursig[$n+1];\r
+ $got=$pt;\r
+ break;\r
+ }\r
+ }\r
+ if($itsOK)\r
+ {\r
+ return array(1,'');\r
+ }\r
+ }\r
+ }\r
+ if(isset($wanted))\r
+ {\r
+ return array(0, "Wanted ${wanted}, got ${got} at param ${pno}");\r
+ }\r
+ else\r
+ {\r
+ return array(0, "No method signature matches number of parameters");\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Parse http headers received along with xmlrpc request. If needed, inflate request\r
+ * @return mixed null on success or an xmlrpcresp\r
+ * @access private\r
+ */\r
+ function parseRequestHeaders(&$data, &$req_encoding, &$resp_encoding, &$resp_compression)\r
+ {\r
+ // check if $_SERVER is populated: it might have been disabled via ini file\r
+ // (this is true even when in CLI mode)\r
+ if (count($_SERVER) == 0)\r
+ {\r
+ error_log('XML-RPC: '.__METHOD__.': cannot parse request headers as $_SERVER is not populated');\r
+ }\r
+\r
+ if($this->debug > 1)\r
+ {\r
+ if(function_exists('getallheaders'))\r
+ {\r
+ $this->debugmsg(''); // empty line\r
+ foreach(getallheaders() as $name => $val)\r
+ {\r
+ $this->debugmsg("HEADER: $name: $val");\r
+ }\r
+ }\r
+\r
+ }\r
+\r
+ if(isset($_SERVER['HTTP_CONTENT_ENCODING']))\r
+ {\r
+ $content_encoding = str_replace('x-', '', $_SERVER['HTTP_CONTENT_ENCODING']);\r
+ }\r
+ else\r
+ {\r
+ $content_encoding = '';\r
+ }\r
+\r
+ // check if request body has been compressed and decompress it\r
+ if($content_encoding != '' && strlen($data))\r
+ {\r
+ if($content_encoding == 'deflate' || $content_encoding == 'gzip')\r
+ {\r
+ // if decoding works, use it. else assume data wasn't gzencoded\r
+ if(function_exists('gzinflate') && in_array($content_encoding, $this->accepted_compression))\r
+ {\r
+ if($content_encoding == 'deflate' && $degzdata = @gzuncompress($data))\r
+ {\r
+ $data = $degzdata;\r
+ if($this->debug > 1)\r
+ {\r
+ $this->debugmsg("\n+++INFLATED REQUEST+++[".strlen($data)." chars]+++\n" . $data . "\n+++END+++");\r
+ }\r
+ }\r
+ elseif($content_encoding == 'gzip' && $degzdata = @gzinflate(substr($data, 10)))\r
+ {\r
+ $data = $degzdata;\r
+ if($this->debug > 1)\r
+ $this->debugmsg("+++INFLATED REQUEST+++[".strlen($data)." chars]+++\n" . $data . "\n+++END+++");\r
+ }\r
+ else\r
+ {\r
+ $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['server_decompress_fail'], $GLOBALS['xmlrpcstr']['server_decompress_fail']);\r
+ return $r;\r
+ }\r
+ }\r
+ else\r
+ {\r
+ //error_log('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']['server_cannot_decompress'], $GLOBALS['xmlrpcstr']['server_cannot_decompress']);\r
+ return $r;\r
+ }\r
+ }\r
+ }\r
+\r
+ // check if client specified accepted charsets, and if we know how to fulfill\r
+ // the request\r
+ if ($this->response_charset_encoding == 'auto')\r
+ {\r
+ $resp_encoding = '';\r
+ if (isset($_SERVER['HTTP_ACCEPT_CHARSET']))\r
+ {\r
+ // here we should check if we can match the client-requested encoding\r
+ // with the encodings we know we can generate.\r
+ /// @todo we should parse q=0.x preferences instead of getting first charset specified...\r
+ $client_accepted_charsets = explode(',', strtoupper($_SERVER['HTTP_ACCEPT_CHARSET']));\r
+ // Give preference to internal encoding\r
+ $known_charsets = array($GLOBALS['xmlrpc_internalencoding'], 'UTF-8', 'ISO-8859-1', 'US-ASCII');\r
+ foreach ($known_charsets as $charset)\r
+ {\r
+ foreach ($client_accepted_charsets as $accepted)\r
+ if (strpos($accepted, $charset) === 0)\r
+ {\r
+ $resp_encoding = $charset;\r
+ break;\r
+ }\r
+ if ($resp_encoding)\r
+ break;\r
+ }\r
+ }\r
+ }\r
+ else\r
+ {\r
+ $resp_encoding = $this->response_charset_encoding;\r
+ }\r
+\r
+ if (isset($_SERVER['HTTP_ACCEPT_ENCODING']))\r
+ {\r
+ $resp_compression = $_SERVER['HTTP_ACCEPT_ENCODING'];\r
+ }\r
+ else\r
+ {\r
+ $resp_compression = '';\r
+ }\r
+\r
+ // 'guestimate' request encoding\r
+ /// @todo check if mbstring is enabled and automagic input conversion is on: it might mingle with this check???\r
+ $req_encoding = guess_encoding(isset($_SERVER['CONTENT_TYPE']) ? $_SERVER['CONTENT_TYPE'] : '',\r
+ $data);\r
+\r
+ return null;\r
+ }\r
+\r
+ /**\r
+ * Parse an xml chunk containing an xmlrpc request and execute the corresponding\r
+ * php function registered with the server\r
+ * @param string $data the xml request\r
+ * @param string $req_encoding (optional) the charset encoding of the xml request\r
+ * @return xmlrpcresp\r
+ * @access private\r
+ */\r
+ function parseRequest($data, $req_encoding='')\r
+ {\r
+ // 2005/05/07 commented and moved into caller function code\r
+ //if($data=='')\r
+ //{\r
+ // $data=$GLOBALS['HTTP_RAW_POST_DATA'];\r
+ //}\r
+\r
+ // G. Giunta 2005/02/13: we do NOT expect to receive html entities\r
+ // so we do not try to convert them into xml character entities\r
+ //$data = xmlrpc_html_entity_xlate($data);\r
+\r
+ $GLOBALS['_xh']=array();\r
+ $GLOBALS['_xh']['ac']='';\r
+ $GLOBALS['_xh']['stack']=array();\r
+ $GLOBALS['_xh']['valuestack'] = array();\r
+ $GLOBALS['_xh']['params']=array();\r
+ $GLOBALS['_xh']['pt']=array();\r
+ $GLOBALS['_xh']['isf']=0;\r
+ $GLOBALS['_xh']['isf_reason']='';\r
+ $GLOBALS['_xh']['method']=false; // so we can check later if we got a methodname or not\r
+ $GLOBALS['_xh']['rt']='';\r
+\r
+ // decompose incoming XML into request structure\r
+ if ($req_encoding != '')\r
+ {\r
+ if (!in_array($req_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))\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($req_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))\r
+ {\r
+ error_log('XML-RPC: '.__METHOD__.': invalid charset encoding of received request: '.$req_encoding);\r
+ $req_encoding = $GLOBALS['xmlrpc_defencoding'];\r
+ }\r
+ /// @BUG this will fail on PHP 5 if charset is not specified in the xml prologue,\r
+ // the encoding is not UTF8 and there are non-ascii chars in the text...\r
+ /// @todo use an empty string for php 5 ???\r
+ $parser = xml_parser_create($req_encoding);\r
+ }\r
+ else\r
+ {\r
+ $parser = xml_parser_create();\r
+ }\r
+\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
+ // What if internal encoding is not in one of the 3 allowed?\r
+ // we use the broadest one, ie. utf8\r
+ // This allows to send data which is native in various charset,\r
+ // by extending xmlrpc_encode_entitites() and setting xmlrpc_internalencoding\r
+ if (!in_array($GLOBALS['xmlrpc_internalencoding'], array('UTF-8', 'ISO-8859-1', 'US-ASCII')))\r
+ {\r
+ xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');\r
+ }\r
+ else\r
+ {\r
+ xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $GLOBALS['xmlrpc_internalencoding']);\r
+ }\r
+\r
+ if ($this->functions_parameters_type != 'xmlrpcvals')\r
+ xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast');\r
+ else\r
+ xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee');\r
+ xml_set_character_data_handler($parser, 'xmlrpc_cd');\r
+ xml_set_default_handler($parser, 'xmlrpc_dh');\r
+ if(!xml_parse($parser, $data, 1))\r
+ {\r
+ // return XML error as a faultCode\r
+ $r=new xmlrpcresp(0,\r
+ $GLOBALS['xmlrpcerrxml']+xml_get_error_code($parser),\r
+ sprintf('XML error: %s at line %d, column %d',\r
+ xml_error_string(xml_get_error_code($parser)),\r
+ xml_get_current_line_number($parser), xml_get_current_column_number($parser)));\r
+ xml_parser_free($parser);\r
+ }\r
+ elseif ($GLOBALS['_xh']['isf'])\r
+ {\r
+ xml_parser_free($parser);\r
+ $r=new xmlrpcresp(0,\r
+ $GLOBALS['xmlrpcerr']['invalid_request'],\r
+ $GLOBALS['xmlrpcstr']['invalid_request'] . ' ' . $GLOBALS['_xh']['isf_reason']);\r
+ }\r
+ else\r
+ {\r
+ xml_parser_free($parser);\r
+ // small layering violation in favor of speed and memory usage:\r
+ // we should allow the 'execute' method handle this, but in the\r
+ // most common scenario (xmlrpcvals type server with some methods\r
+ // registered as phpvals) that would mean a useless encode+decode pass\r
+ if ($this->functions_parameters_type != 'xmlrpcvals' || (isset($this->dmap[$GLOBALS['_xh']['method']]['parameters_type']) && ($this->dmap[$GLOBALS['_xh']['method']]['parameters_type'] == 'phpvals')))\r
+ {\r
+ if($this->debug > 1)\r
+ {\r
+ $this->debugmsg("\n+++PARSED+++\n".var_export($GLOBALS['_xh']['params'], true)."\n+++END+++");\r
+ }\r
+ $r = $this->execute($GLOBALS['_xh']['method'], $GLOBALS['_xh']['params'], $GLOBALS['_xh']['pt']);\r
+ }\r
+ else\r
+ {\r
+ // build an xmlrpcmsg object with data parsed from xml\r
+ $m=new xmlrpcmsg($GLOBALS['_xh']['method']);\r
+ // now add parameters in\r
+ for($i=0; $i<count($GLOBALS['_xh']['params']); $i++)\r
+ {\r
+ $m->addParam($GLOBALS['_xh']['params'][$i]);\r
+ }\r
+\r
+ if($this->debug > 1)\r
+ {\r
+ $this->debugmsg("\n+++PARSED+++\n".var_export($m, true)."\n+++END+++");\r
+ }\r
+ $r = $this->execute($m);\r
+ }\r
+ }\r
+ return $r;\r
+ }\r
+\r
+ /**\r
+ * Execute a method invoked by the client, checking parameters used\r
+ * @param mixed $m either an xmlrpcmsg obj or a method name\r
+ * @param array $params array with method parameters as php types (if m is method name only)\r
+ * @param array $paramtypes array with xmlrpc types of method parameters (if m is method name only)\r
+ * @return xmlrpcresp\r
+ * @access private\r
+ */\r
+ function execute($m, $params=null, $paramtypes=null)\r
+ {\r
+ if (is_object($m))\r
+ {\r
+ $methName = $m->method();\r
+ }\r
+ else\r
+ {\r
+ $methName = $m;\r
+ }\r
+ $sysCall = $this->allow_system_funcs && (strpos($methName, "system.") === 0);\r
+ $dmap = $sysCall ? $GLOBALS['_xmlrpcs_dmap'] : $this->dmap;\r
+\r
+ if(!isset($dmap[$methName]['function']))\r
+ {\r
+ // No such method\r
+ return new xmlrpcresp(0,\r
+ $GLOBALS['xmlrpcerr']['unknown_method'],\r
+ $GLOBALS['xmlrpcstr']['unknown_method']);\r
+ }\r
+\r
+ // Check signature\r
+ if(isset($dmap[$methName]['signature']))\r
+ {\r
+ $sig = $dmap[$methName]['signature'];\r
+ if (is_object($m))\r
+ {\r
+ list($ok, $errstr) = $this->verifySignature($m, $sig);\r
+ }\r
+ else\r
+ {\r
+ list($ok, $errstr) = $this->verifySignature($paramtypes, $sig);\r
+ }\r
+ if(!$ok)\r
+ {\r
+ // Didn't match.\r
+ return new xmlrpcresp(\r
+ 0,\r
+ $GLOBALS['xmlrpcerr']['incorrect_params'],\r
+ $GLOBALS['xmlrpcstr']['incorrect_params'] . ": ${errstr}"\r
+ );\r
+ }\r
+ }\r
+\r
+ $func = $dmap[$methName]['function'];\r
+ // let the 'class::function' syntax be accepted in dispatch maps\r
+ if(is_string($func) && strpos($func, '::'))\r
+ {\r
+ $func = explode('::', $func);\r
+ }\r
+ // verify that function to be invoked is in fact callable\r
+ if(!is_callable($func))\r
+ {\r
+ error_log("XML-RPC: ".__METHOD__.": function $func registered as method handler is not callable");\r
+ return new xmlrpcresp(\r
+ 0,\r
+ $GLOBALS['xmlrpcerr']['server_error'],\r
+ $GLOBALS['xmlrpcstr']['server_error'] . ": no function matches method"\r
+ );\r
+ }\r
+\r
+ // If debug level is 3, we should catch all errors generated during\r
+ // processing of user function, and log them as part of response\r
+ if($this->debug > 2)\r
+ {\r
+ $GLOBALS['_xmlrpcs_prev_ehandler'] = set_error_handler('_xmlrpcs_errorHandler');\r
+ }\r
+ try\r
+ {\r
+ // Allow mixed-convention servers\r
+ if (is_object($m))\r
+ {\r
+ if($sysCall)\r
+ {\r
+ $r = call_user_func($func, $this, $m);\r
+ }\r
+ else\r
+ {\r
+ $r = call_user_func($func, $m);\r
+ }\r
+ if (!is_a($r, 'xmlrpcresp'))\r
+ {\r
+ error_log("XML-RPC: ".__METHOD__.": function $func registered as method handler does not return an xmlrpcresp object");\r
+ if (is_a($r, 'xmlrpcval'))\r
+ {\r
+ $r = new xmlrpcresp($r);\r
+ }\r
+ else\r
+ {\r
+ $r = new xmlrpcresp(\r
+ 0,\r
+ $GLOBALS['xmlrpcerr']['server_error'],\r
+ $GLOBALS['xmlrpcstr']['server_error'] . ": function does not return xmlrpcresp object"\r
+ );\r
+ }\r
+ }\r
+ }\r
+ else\r
+ {\r
+ // call a 'plain php' function\r
+ if($sysCall)\r
+ {\r
+ array_unshift($params, $this);\r
+ $r = call_user_func_array($func, $params);\r
+ }\r
+ else\r
+ {\r
+ // 3rd API convention for method-handling functions: EPI-style\r
+ if ($this->functions_parameters_type == 'epivals')\r
+ {\r
+ $r = call_user_func_array($func, array($methName, $params, $this->user_data));\r
+ // mimic EPI behaviour: if we get an array that looks like an error, make it\r
+ // an eror response\r
+ if (is_array($r) && array_key_exists('faultCode', $r) && array_key_exists('faultString', $r))\r
+ {\r
+ $r = new xmlrpcresp(0, (integer)$r['faultCode'], (string)$r['faultString']);\r
+ }\r
+ else\r
+ {\r
+ // functions using EPI api should NOT return resp objects,\r
+ // so make sure we encode the return type correctly\r
+ $r = new xmlrpcresp(php_xmlrpc_encode($r, array('extension_api')));\r
+ }\r
+ }\r
+ else\r
+ {\r
+ $r = call_user_func_array($func, $params);\r
+ }\r
+ }\r
+ // the return type can be either an xmlrpcresp object or a plain php value...\r
+ if (!is_a($r, 'xmlrpcresp'))\r
+ {\r
+ // what should we assume here about automatic encoding of datetimes\r
+ // and php classes instances???\r
+ $r = new xmlrpcresp(php_xmlrpc_encode($r, $this->phpvals_encoding_options));\r
+ }\r
+ }\r
+ }\r
+ catch(Exception $e)\r
+ {\r
+ // (barring errors in the lib) an uncatched exception happened\r
+ // in the called function, we wrap it in a proper error-response\r
+ switch($this->exception_handling)\r
+ {\r
+ case 2:\r
+ throw $e;\r
+ break;\r
+ case 1:\r
+ $r = new xmlrpcresp(0, $e->getCode(), $e->getMessage());\r
+ break;\r
+ default:\r
+ $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['server_error'], $GLOBALS['xmlrpcstr']['server_error']);\r
+ }\r
+ }\r
+ if($this->debug > 2)\r
+ {\r
+ // note: restore the error handler we found before calling the\r
+ // user func, even if it has been changed inside the func itself\r
+ if($GLOBALS['_xmlrpcs_prev_ehandler'])\r
+ {\r
+ set_error_handler($GLOBALS['_xmlrpcs_prev_ehandler']);\r
+ }\r
+ else\r
+ {\r
+ restore_error_handler();\r
+ }\r
+ }\r
+ return $r;\r
+ }\r
+\r
+ /**\r
+ * add a string to the 'internal debug message' (separate from 'user debug message')\r
+ * @param string $string\r
+ * @access private\r
+ */\r
+ function debugmsg($string)\r
+ {\r
+ $this->debug_info .= $string."\n";\r
+ }\r
+\r
+ /**\r
+ * @access private\r
+ */\r
+ function xml_header($charset_encoding='')\r
+ {\r
+ if ($charset_encoding != '')\r
+ {\r
+ return "<?xml version=\"1.0\" encoding=\"$charset_encoding\"?" . ">\n";\r
+ }\r
+ else\r
+ {\r
+ return "<?xml version=\"1.0\"?" . ">\n";\r
+ }\r
+ }\r
+\r
+ /**\r
+ * A debugging routine: just echoes back the input packet as a string value\r
+ * DEPRECATED!\r
+ */\r
+ function echoInput()\r
+ {\r
+ $r=new xmlrpcresp(new xmlrpcval( "'Aha said I: '" . $GLOBALS['HTTP_RAW_POST_DATA'], 'string'));\r
+ print $r->serialize();\r
+ }\r
+}\r
?>
\ No newline at end of file
git://git.onelab.eu / plcapi.git / commitdiff