X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=src%2FEncoder.php;h=7ad2adb06d098d0086e062d2bddcb287132ca6f6;hb=b337d292eb5b5656d27a2fc9ab6796be300c59a3;hp=82deef0a3420c6442deef2734b6b084b8b4f729f;hpb=a8f93d5ce43365c83361071a847cb977f3ede519;p=plcapi.git diff --git a/src/Encoder.php b/src/Encoder.php index 82deef0..7ad2adb 100644 --- a/src/Encoder.php +++ b/src/Encoder.php @@ -8,9 +8,39 @@ use PhpXmlRpc\Helper\XMLParser; /** * A helper class to easily convert between Value objects and php native values * @todo implement an interface + * @todo add class constants for the options values */ class Encoder { + protected static $logger; + protected static $parser; + + public function getLogger() + { + if (self::$logger === null) { + self::$logger = Logger::instance(); + } + return self::$logger; + } + + public static function setLogger($logger) + { + self::$logger = $logger; + } + + public function getParser() + { + if (self::$parser === null) { + self::$parser = new XMLParser(); + } + return self::$parser; + } + + public static function setParser($parser) + { + self::$parser = $parser; + } + /** * Takes an xmlrpc value in object format and translates it into native PHP types. * @@ -22,7 +52,7 @@ class Encoder * This means that the remote communication end can decide which php code will get executed on your server, leaving * the door possibly open to 'php-injection' style of attacks (provided you have some classes defined on your server * that might wreak havoc if instances are built outside an appropriate context). - * Make sure you trust the remote server/client before eanbling this! + * Make sure you trust the remote server/client before enabling this! * * @author Dan Libby (dan@libby.com) * @@ -53,8 +83,17 @@ class Encoder 'scalar' => $val ); return (object)$xmlrpcVal; + case 'string': + if (isset($options['extension_api_encoding'])) { + $dval = @iconv('UTF-8', $options['extension_api_encoding'], $val); + if ($dval !== false) { + return $dval; + } + } + //return $val; + // break through voluntarily default: - return $xmlrpcVal->scalarval(); + return $val; } } if (in_array('dates_as_objects', $options) && $xmlrpcVal->scalartyp() == 'dateTime.iso8601') { @@ -73,15 +112,15 @@ class Encoder return $out; } } - return $xmlrpcVal->scalarval(); + case 'array': $arr = array(); foreach($xmlrpcVal as $value) { $arr[] = $this->decode($value, $options); } - return $arr; + case 'struct': // If user said so, try to rebuild php objects for specific struct vals. /// @todo should we raise a warning for class not found? @@ -94,24 +133,24 @@ class Encoder foreach ($xmlrpcVal as $key => $value) { $obj->$key = $this->decode($value, $options); } - return $obj; } else { $arr = array(); foreach ($xmlrpcVal as $key => $value) { $arr[$key] = $this->decode($value, $options); } - return $arr; } + case 'msg': $paramCount = $xmlrpcVal->getNumParams(); $arr = array(); for ($i = 0; $i < $paramCount; $i++) { $arr[] = $this->decode($xmlrpcVal->getParam($i), $options); } - return $arr; + + /// @todo throw on unsupported type } } @@ -130,7 +169,7 @@ class Encoder * @param mixed $phpVal the value to be converted into an xmlrpc value object * @param array $options can include 'encode_php_objs', 'auto_dates', 'null_extension' or 'extension_api' * - * @return \PhpXmlrpc\Value + * @return Value */ public function encode($phpVal, $options = array()) { @@ -242,13 +281,13 @@ class Encoder * Convert the xml representation of a method response, method request or single * xmlrpc value into the appropriate object (a.k.a. deserialize). * - * Q: is this a good name for this method? It does something quite different from 'decode' after all - * (returning objects vs returns plain php values)... + * @todo is this a good name/class for this method? It does something quite different from 'decode' after all + * (returning objects vs returns plain php values)... In fact it belongs rather to a Parser class * * @param string $xmlVal * @param array $options * - * @return mixed false on error, or an instance of either Value, Request or Response + * @return Value|Request|Response|false false on error, or an instance of either Value, Request or Response */ public function decodeXml($xmlVal, $options = array()) { @@ -270,7 +309,7 @@ class Encoder if (extension_loaded('mbstring')) { $xmlVal = mb_convert_encoding($xmlVal, 'UTF-8', $valEncoding); } else { - Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of xml text: ' . $valEncoding); + $this->getLogger()->errorLog('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of xml text: ' . $valEncoding); } } } @@ -278,18 +317,24 @@ class Encoder // What if internal encoding is not in one of the 3 allowed? We use the broadest one, ie. utf8! if (!in_array(PhpXmlRpc::$xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) { - $options = array(XML_OPTION_TARGET_ENCODING => 'UTF-8'); + /// @todo emit a warning + $parserOptions = array(XML_OPTION_TARGET_ENCODING => 'UTF-8'); } else { - $options = array(XML_OPTION_TARGET_ENCODING => PhpXmlRpc::$xmlrpc_internalencoding); + $parserOptions = array(XML_OPTION_TARGET_ENCODING => PhpXmlRpc::$xmlrpc_internalencoding); } - $xmlRpcParser = new XMLParser($options); - $xmlRpcParser->parse($xmlVal, XMLParser::RETURN_XMLRPCVALS, XMLParser::ACCEPT_REQUEST | XMLParser::ACCEPT_RESPONSE | XMLParser::ACCEPT_VALUE | XMLParser::ACCEPT_FAULT); + $xmlRpcParser = $this->getParser(); + $xmlRpcParser->parse( + $xmlVal, + XMLParser::RETURN_XMLRPCVALS, + XMLParser::ACCEPT_REQUEST | XMLParser::ACCEPT_RESPONSE | XMLParser::ACCEPT_VALUE | XMLParser::ACCEPT_FAULT, + $parserOptions + ); if ($xmlRpcParser->_xh['isf'] > 1) { // test that $xmlrpc->_xh['value'] is an obj, too??? - Logger::instance()->errorLog($xmlRpcParser->_xh['isf_reason']); + $this->getLogger()->errorLog($xmlRpcParser->_xh['isf_reason']); return false; } @@ -306,17 +351,18 @@ class Encoder } else { $r = new Response($v); } - return $r; + case 'methodcall': $req = new Request($xmlRpcParser->_xh['method']); for ($i = 0; $i < count($xmlRpcParser->_xh['params']); $i++) { $req->addParam($xmlRpcParser->_xh['params'][$i]); } - return $req; + case 'value': return $xmlRpcParser->_xh['value']; + case 'fault': // EPI api emulation $v = $xmlRpcParser->_xh['value']; @@ -333,5 +379,4 @@ class Encoder return false; } } - }