5 use PhpXmlRpc\Helper\XMLParser;
8 * A helper class to easily convert between Value objects and php native values
13 * Takes an xmlrpc value in object format and translates it into native PHP types.
15 * Works with xmlrpc requests objects as input, too.
17 * Given proper options parameter, can rebuild generic php object instances
18 * (provided those have been encoded to xmlrpc format using a corresponding
19 * 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
22 * get executed on your server, leaving the door possibly open to 'php-injection'
23 * style of attacks (provided you have some classes defined on your server that
24 * might wreak havoc if instances are built outside an appropriate context).
25 * Make sure you trust the remote server/client before eanbling this!
27 * @author Dan Libby (dan@libby.com)
29 * @param Value|Request $xmlrpcVal
30 * @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
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
59 // since now the constructor of xmlrpc value accepts safely strings, ints and datetimes,
60 // we cater to all 3 cases here
61 $out = $xmlrpcVal->scalarval();
62 if (is_string($out)) {
63 $out = strtotime($out);
66 $result = new \DateTime();
67 $result->setTimestamp($out);
70 } elseif (is_a($out, 'DateTimeInterface')) {
75 return $xmlrpcVal->scalarval();
78 foreach($xmlrpcVal as $value) {
79 $arr[] = $this->decode($value, $options);
84 // If user said so, try to rebuild php objects for specific struct vals.
85 /// @todo should we raise a warning for class not found?
86 // shall we check for proper subclass of xmlrpc value instead of
87 // presence of _php_class to detect what we can do?
88 if (in_array('decode_php_objs', $options) && $xmlrpcVal->_php_class != ''
89 && class_exists($xmlrpcVal->_php_class)
91 $obj = @new $xmlrpcVal->_php_class();
92 foreach ($xmlrpcVal as $key => $value) {
93 $obj->$key = $this->decode($value, $options);
99 foreach ($xmlrpcVal as $key => $value) {
100 $arr[$key] = $this->decode($value, $options);
106 $paramCount = $xmlrpcVal->getNumParams();
108 for ($i = 0; $i < $paramCount; $i++) {
109 $arr[] = $this->decode($xmlrpcVal->getParam($i), $options);
117 * Takes native php types and encodes them into xmlrpc PHP object format.
118 * It will not re-encode xmlrpc value objects.
120 * Feature creep -- could support more types via optional type argument
121 * (string => datetime support has been added, ??? => base64 not yet)
123 * If given a proper options parameter, php object instances will be encoded
124 * into 'special' xmlrpc values, that can later be decoded into php objects
125 * by calling php_xmlrpc_decode() with a corresponding option
127 * @author Dan Libby (dan@libby.com)
129 * @param mixed $phpVal the value to be converted into an xmlrpc value object
130 * @param array $options can include 'encode_php_objs', 'auto_dates', 'null_extension' or 'extension_api'
132 * @return \PhpXmlrpc\Value
134 public function encode($phpVal, $options = array())
136 $type = gettype($phpVal);
139 if (in_array('auto_dates', $options) && preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $phpVal)) {
140 $xmlrpcVal = new Value($phpVal, Value::$xmlrpcDateTime);
142 $xmlrpcVal = new Value($phpVal, Value::$xmlrpcString);
146 $xmlrpcVal = new Value($phpVal, Value::$xmlrpcInt);
149 $xmlrpcVal = new Value($phpVal, Value::$xmlrpcDouble);
151 // <G_Giunta_2001-02-29>
152 // Add support for encoding/decoding of booleans, since they are supported in PHP
154 $xmlrpcVal = new Value($phpVal, Value::$xmlrpcBoolean);
156 // </G_Giunta_2001-02-29>
158 // PHP arrays can be encoded to either xmlrpc structs or arrays,
159 // depending on wheter they are hashes or plain 0..n integer indexed
160 // A shorter one-liner would be
161 // $tmp = array_diff(array_keys($phpVal), range(0, count($phpVal)-1));
162 // but execution time skyrockets!
166 foreach ($phpVal as $key => $val) {
167 $arr[$key] = $this->encode($val, $options);
168 if (!$ko && $key !== $j) {
174 $xmlrpcVal = new Value($arr, Value::$xmlrpcStruct);
176 $xmlrpcVal = new Value($arr, Value::$xmlrpcArray);
180 if (is_a($phpVal, 'PhpXmlRpc\Value')) {
181 $xmlrpcVal = $phpVal;
182 } elseif (is_a($phpVal, 'DateTimeInterface')) {
183 $xmlrpcVal = new Value($phpVal->format('Ymd\TH:i:s'), Value::$xmlrpcStruct);
186 foreach($phpVal as $k => $v) {
187 $arr[$k] = $this->encode($v, $options);
189 $xmlrpcVal = new Value($arr, Value::$xmlrpcStruct);
190 if (in_array('encode_php_objs', $options)) {
191 // let's save original class name into xmlrpc value:
192 // might be useful later on...
193 $xmlrpcVal->_php_class = get_class($phpVal);
198 if (in_array('extension_api', $options)) {
199 $xmlrpcVal = new Value('', Value::$xmlrpcString);
200 } elseif (in_array('null_extension', $options)) {
201 $xmlrpcVal = new Value('', Value::$xmlrpcNull);
203 $xmlrpcVal = new Value();
207 if (in_array('extension_api', $options)) {
208 $xmlrpcVal = new Value((int)$phpVal, Value::$xmlrpcInt);
210 $xmlrpcVal = new Value();
212 // catch "user function", "unknown type"
214 // giancarlo pinerolo <ping@alt.it>
216 // an empty object in case, not a boolean.
217 $xmlrpcVal = new Value();
225 * Convert the xml representation of a method response, method request or single
226 * xmlrpc value into the appropriate object (a.k.a. deserialize).
228 * @param string $xmlVal
229 * @param array $options
231 * @return mixed false on error, or an instance of either Value, Request or Response
233 public function decodeXml($xmlVal, $options = array())
235 // 'guestimate' encoding
236 $valEncoding = XMLParser::guessEncoding('', $xmlVal);
237 if ($valEncoding != '') {
239 // Since parsing will fail if charset is not specified in the xml prologue,
240 // the encoding is not UTF8 and there are non-ascii chars in the text, we try to work round that...
241 // The following code might be better for mb_string enabled installs, but
242 // makes the lib about 200% slower...
243 //if (!is_valid_charset($valEncoding, array('UTF-8'))
244 if (!in_array($valEncoding, array('UTF-8', 'US-ASCII')) && !XMLParser::hasEncoding($xmlVal)) {
245 if ($valEncoding == 'ISO-8859-1') {
246 $xmlVal = utf8_encode($xmlVal);
248 if (extension_loaded('mbstring')) {
249 $xmlVal = mb_convert_encoding($xmlVal, 'UTF-8', $valEncoding);
251 error_log('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of xml text: ' . $valEncoding);
257 $parser = xml_parser_create();
258 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true);
259 // What if internal encoding is not in one of the 3 allowed?
260 // we use the broadest one, ie. utf8!
261 if (!in_array(PhpXmlRpc::$xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) {
262 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');
264 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, PhpXmlRpc::$xmlrpc_internalencoding);
267 $xmlRpcParser = new XMLParser();
268 xml_set_object($parser, $xmlRpcParser);
270 xml_set_element_handler($parser, 'xmlrpc_se_any', 'xmlrpc_ee');
271 xml_set_character_data_handler($parser, 'xmlrpc_cd');
272 xml_set_default_handler($parser, 'xmlrpc_dh');
273 if (!xml_parse($parser, $xmlVal, 1)) {
274 $errstr = sprintf('XML error: %s at line %d, column %d',
275 xml_error_string(xml_get_error_code($parser)),
276 xml_get_current_line_number($parser), xml_get_current_column_number($parser));
278 xml_parser_free($parser);
282 xml_parser_free($parser);
283 if ($xmlRpcParser->_xh['isf'] > 1) {
284 // test that $xmlrpc->_xh['value'] is an obj, too???
286 error_log($xmlRpcParser->_xh['isf_reason']);
290 switch ($xmlRpcParser->_xh['rt']) {
291 case 'methodresponse':
292 $v = &$xmlRpcParser->_xh['value'];
293 if ($xmlRpcParser->_xh['isf'] == 1) {
294 $vc = $v['faultCode'];
295 $vs = $v['faultString'];
296 $r = new Response(0, $vc->scalarval(), $vs->scalarval());
298 $r = new Response($v);
303 $req = new Request($xmlRpcParser->_xh['method']);
304 for ($i = 0; $i < count($xmlRpcParser->_xh['params']); $i++) {
305 $req->addParam($xmlRpcParser->_xh['params'][$i]);
310 return $xmlRpcParser->_xh['value'];