5 use PhpXmlRpc\Helper\XMLParser;
8 * A helper class to easily convert between Value objects and php native values
9 * @todo implement an interface
14 * Takes an xmlrpc value in object format and translates it into native PHP types.
16 * Works with xmlrpc requests objects as input, too.
18 * Given proper options parameter, can rebuild generic php object instances (provided those have been encoded to
19 * xmlrpc format using a corresponding option in php_xmlrpc_encode())
20 * PLEASE NOTE that rebuilding php objects involves calling their constructor function.
21 * This means that the remote communication end can decide which php code will get executed on your server, leaving
22 * the door possibly open to 'php-injection' style of attacks (provided you have some classes defined on your server
23 * that might wreak havoc if instances are built outside an appropriate context).
24 * Make sure you trust the remote server/client before eanbling this!
26 * @author Dan Libby (dan@libby.com)
28 * @param Value|Request $xmlrpcVal
29 * @param array $options if 'decode_php_objs' is set in the options array, xmlrpc structs can be decoded into php
30 * objects; if 'dates_as_objects' is set xmlrpc datetimes are decoded as php DateTime objects
34 public function decode($xmlrpcVal, $options = array())
36 switch ($xmlrpcVal->kindOf()) {
38 if (in_array('extension_api', $options)) {
39 $val = reset($xmlrpcVal->me);
40 $typ = key($xmlrpcVal->me);
42 case 'dateTime.iso8601':
43 $xmlrpcVal->scalar = $val;
44 $xmlrpcVal->type = 'datetime';
45 $xmlrpcVal->timestamp = \PhpXmlRpc\Helper\Date::iso8601Decode($val);
49 $xmlrpcVal->scalar = $val;
50 $xmlrpcVal->type = $typ;
54 return $xmlrpcVal->scalarval();
57 if (in_array('dates_as_objects', $options) && $xmlrpcVal->scalartyp() == 'dateTime.iso8601') {
58 // we return a Datetime object instead of a string since now the constructor of xmlrpc value accepts
59 // safely strings, ints and datetimes, we cater to all 3 cases here
60 $out = $xmlrpcVal->scalarval();
61 if (is_string($out)) {
62 $out = strtotime($out);
65 $result = new \DateTime();
66 $result->setTimestamp($out);
69 } elseif (is_a($out, 'DateTimeInterface')) {
74 return $xmlrpcVal->scalarval();
77 foreach($xmlrpcVal as $value) {
78 $arr[] = $this->decode($value, $options);
83 // If user said so, try to rebuild php objects for specific struct vals.
84 /// @todo should we raise a warning for class not found?
85 // shall we check for proper subclass of xmlrpc value instead of presence of _php_class to detect
87 if (in_array('decode_php_objs', $options) && $xmlrpcVal->_php_class != ''
88 && class_exists($xmlrpcVal->_php_class)
90 $obj = @new $xmlrpcVal->_php_class();
91 foreach ($xmlrpcVal as $key => $value) {
92 $obj->$key = $this->decode($value, $options);
98 foreach ($xmlrpcVal as $key => $value) {
99 $arr[$key] = $this->decode($value, $options);
105 $paramCount = $xmlrpcVal->getNumParams();
107 for ($i = 0; $i < $paramCount; $i++) {
108 $arr[] = $this->decode($xmlrpcVal->getParam($i), $options);
116 * Takes native php types and encodes them into xmlrpc PHP object format.
117 * It will not re-encode xmlrpc value objects.
119 * Feature creep -- could support more types via optional type argument
120 * (string => datetime support has been added, ??? => base64 not yet)
122 * If given a proper options parameter, php object instances will be encoded into 'special' xmlrpc values, that can
123 * later be decoded into php objects by calling php_xmlrpc_decode() with a corresponding option
125 * @author Dan Libby (dan@libby.com)
127 * @param mixed $phpVal the value to be converted into an xmlrpc value object
128 * @param array $options can include 'encode_php_objs', 'auto_dates', 'null_extension' or 'extension_api'
130 * @return \PhpXmlrpc\Value
132 public function encode($phpVal, $options = array())
134 $type = gettype($phpVal);
137 if (in_array('auto_dates', $options) && preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $phpVal)) {
138 $xmlrpcVal = new Value($phpVal, Value::$xmlrpcDateTime);
140 $xmlrpcVal = new Value($phpVal, Value::$xmlrpcString);
144 $xmlrpcVal = new Value($phpVal, Value::$xmlrpcInt);
147 $xmlrpcVal = new Value($phpVal, Value::$xmlrpcDouble);
149 // Add support for encoding/decoding of booleans, since they are supported in PHP
151 $xmlrpcVal = new Value($phpVal, Value::$xmlrpcBoolean);
154 // PHP arrays can be encoded to either xmlrpc structs or arrays, depending on whether they are hashes
155 // or plain 0..n integer indexed
156 // A shorter one-liner would be
157 // $tmp = array_diff(array_keys($phpVal), range(0, count($phpVal)-1));
158 // but execution time skyrockets!
162 foreach ($phpVal as $key => $val) {
163 $arr[$key] = $this->encode($val, $options);
164 if (!$ko && $key !== $j) {
170 $xmlrpcVal = new Value($arr, Value::$xmlrpcStruct);
172 $xmlrpcVal = new Value($arr, Value::$xmlrpcArray);
176 if (is_a($phpVal, 'PhpXmlRpc\Value')) {
177 $xmlrpcVal = $phpVal;
178 } elseif (is_a($phpVal, 'DateTimeInterface')) {
179 $xmlrpcVal = new Value($phpVal->format('Ymd\TH:i:s'), Value::$xmlrpcStruct);
182 foreach($phpVal as $k => $v) {
183 $arr[$k] = $this->encode($v, $options);
185 $xmlrpcVal = new Value($arr, Value::$xmlrpcStruct);
186 if (in_array('encode_php_objs', $options)) {
187 // let's save original class name into xmlrpc value:
188 // might be useful later on...
189 $xmlrpcVal->_php_class = get_class($phpVal);
194 if (in_array('extension_api', $options)) {
195 $xmlrpcVal = new Value('', Value::$xmlrpcString);
196 } elseif (in_array('null_extension', $options)) {
197 $xmlrpcVal = new Value('', Value::$xmlrpcNull);
199 $xmlrpcVal = new Value();
203 if (in_array('extension_api', $options)) {
204 $xmlrpcVal = new Value((int)$phpVal, Value::$xmlrpcInt);
206 $xmlrpcVal = new Value();
209 // catch "user function", "unknown type"
211 // giancarlo pinerolo <ping@alt.it>
212 // it has to return an empty object in case, not a boolean.
213 $xmlrpcVal = new Value();
221 * Convert the xml representation of a method response, method request or single
222 * xmlrpc value into the appropriate object (a.k.a. deserialize).
224 * Q: is this a good name for this method? It does something quite different from 'decode' after all
225 * (returning objects vs returns plain php values)...
227 * @param string $xmlVal
228 * @param array $options
230 * @return mixed false on error, or an instance of either Value, Request or Response
232 public function decodeXml($xmlVal, $options = array())
234 // 'guestimate' encoding
235 $valEncoding = XMLParser::guessEncoding('', $xmlVal);
236 if ($valEncoding != '') {
238 // Since parsing will fail if charset is not specified in the xml prologue,
239 // the encoding is not UTF8 and there are non-ascii chars in the text, we try to work round that...
240 // The following code might be better for mb_string enabled installs, but makes the lib about 200% slower...
241 //if (!is_valid_charset($valEncoding, array('UTF-8'))
242 if (!in_array($valEncoding, array('UTF-8', 'US-ASCII')) && !XMLParser::hasEncoding($xmlVal)) {
243 if ($valEncoding == 'ISO-8859-1') {
244 $xmlVal = utf8_encode($xmlVal);
246 if (extension_loaded('mbstring')) {
247 $xmlVal = mb_convert_encoding($xmlVal, 'UTF-8', $valEncoding);
249 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of xml text: ' . $valEncoding);
255 // What if internal encoding is not in one of the 3 allowed? We use the broadest one, ie. utf8!
256 if (!in_array(PhpXmlRpc::$xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) {
257 $options = array(XML_OPTION_TARGET_ENCODING => 'UTF-8');
259 $options = array(XML_OPTION_TARGET_ENCODING => PhpXmlRpc::$xmlrpc_internalencoding);
262 $xmlRpcParser = new XMLParser($options);
263 $xmlRpcParser->parse($xmlVal, XMLParser::RETURN_XMLRPCVALS, XMLParser::ACCEPT_REQUEST | XMLParser::ACCEPT_RESPONSE | XMLParser::ACCEPT_VALUE);
265 if ($xmlRpcParser->_xh['isf'] > 1) {
266 // test that $xmlrpc->_xh['value'] is an obj, too???
268 Logger::instance()->errorLog($xmlRpcParser->_xh['isf_reason']);
273 switch ($xmlRpcParser->_xh['rt']) {
274 case 'methodresponse':
275 $v = $xmlRpcParser->_xh['value'];
276 if ($xmlRpcParser->_xh['isf'] == 1) {
277 /** @var Value $vc */
278 $vc = $v['faultCode'];
279 /** @var Value $vs */
280 $vs = $v['faultString'];
281 $r = new Response(0, $vc->scalarval(), $vs->scalarval());
283 $r = new Response($v);
288 $req = new Request($xmlRpcParser->_xh['method']);
289 for ($i = 0; $i < count($xmlRpcParser->_xh['params']); $i++) {
290 $req->addParam($xmlRpcParser->_xh['params'][$i]);
295 return $xmlRpcParser->_xh['value'];