namespace PhpXmlRpc;
+use PhpXmlRpc\Helper\Logger;
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
{
/**
*
* Works with xmlrpc requests objects as input, too.
*
- * Given proper options parameter, can rebuild generic php object instances
- * (provided those have been encoded to xmlrpc format using a corresponding
- * option in php_xmlrpc_encode())
+ * Given proper options parameter, can rebuild generic php object instances (provided those have been encoded to
+ * xmlrpc format using a corresponding option in php_xmlrpc_encode())
* PLEASE NOTE that rebuilding php objects involves calling their constructor function.
- * 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!
+ * 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 enabling this!
*
* @author Dan Libby (dan@libby.com)
*
* @param Value|Request $xmlrpcVal
- * @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
+ * @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
*
* @return mixed
*/
switch ($xmlrpcVal->kindOf()) {
case 'scalar':
if (in_array('extension_api', $options)) {
- reset($xmlrpcVal->me);
- list($typ, $val) = each($xmlrpcVal->me);
+ $val = reset($xmlrpcVal->me);
+ $typ = key($xmlrpcVal->me);
switch ($typ) {
case 'dateTime.iso8601':
- $xmlrpcVal->scalar = $val;
- $xmlrpcVal->type = 'datetime';
- $xmlrpcVal->timestamp = \PhpXmlRpc\Helper\Date::iso8601_decode($val);
-
- return $xmlrpcVal;
+ $xmlrpcVal = array(
+ 'xmlrpc_type' => 'datetime',
+ 'scalar' => $val,
+ 'timestamp' => \PhpXmlRpc\Helper\Date::iso8601Decode($val)
+ );
+ return (object)$xmlrpcVal;
case 'base64':
- $xmlrpcVal->scalar = $val;
- $xmlrpcVal->type = $typ;
-
- return $xmlrpcVal;
+ $xmlrpcVal = array(
+ 'xmlrpc_type' => 'base64',
+ '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') {
- // we return a Datetime object instead of a string
- // since now the constructor of xmlrpc value accepts safely strings, ints and datetimes,
- // we cater to all 3 cases here
+ // we return a Datetime object instead of a string since now the constructor of xmlrpc value accepts
+ // safely strings, ints and datetimes, we cater to all 3 cases here
$out = $xmlrpcVal->scalarval();
if (is_string($out)) {
$out = strtotime($out);
}
if (is_int($out)) {
- $result = new \Datetime();
+ $result = new \DateTime();
$result->setTimestamp($out);
return $result;
- } elseif (is_a($out, 'Datetime')) {
+ } elseif (is_a($out, 'DateTimeInterface')) {
return $out;
}
}
-
return $xmlrpcVal->scalarval();
+
case 'array':
- $size = $xmlrpcVal->arraysize();
$arr = array();
- for ($i = 0; $i < $size; $i++) {
- $arr[] = $this->decode($xmlrpcVal->arraymem($i), $options);
+ foreach($xmlrpcVal as $value) {
+ $arr[] = $this->decode($value, $options);
}
-
return $arr;
+
case 'struct':
- $xmlrpcVal->structreset();
// If user said so, try to rebuild php objects for specific struct vals.
/// @todo should we raise a warning for class not found?
- // shall we check for proper subclass of xmlrpc value instead of
- // presence of _php_class to detect what we can do?
+ // shall we check for proper subclass of xmlrpc value instead of presence of _php_class to detect
+ // what we can do?
if (in_array('decode_php_objs', $options) && $xmlrpcVal->_php_class != ''
&& class_exists($xmlrpcVal->_php_class)
) {
$obj = @new $xmlrpcVal->_php_class();
- while (list($key, $value) = $xmlrpcVal->structeach()) {
+ foreach ($xmlrpcVal as $key => $value) {
$obj->$key = $this->decode($value, $options);
}
-
return $obj;
} else {
$arr = array();
- while (list($key, $value) = $xmlrpcVal->structeach()) {
+ 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));
+ $arr[] = $this->decode($xmlrpcVal->getParam($i), $options);
}
-
return $arr;
+
+ /// @todo throw on unsupported type
}
}
* Feature creep -- could support more types via optional type argument
* (string => datetime support has been added, ??? => base64 not yet)
*
- * If given a proper options parameter, php object instances will be encoded
- * into 'special' xmlrpc values, that can later be decoded into php objects
- * by calling php_xmlrpc_decode() with a corresponding option
+ * If given a proper options parameter, php object instances will be encoded into 'special' xmlrpc values, that can
+ * later be decoded into php objects by calling php_xmlrpc_decode() with a corresponding option
*
* @author Dan Libby (dan@libby.com)
*
- * @param mixed $php_val the value to be converted into an xmlrpc value object
+ * @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())
{
$type = gettype($phpVal);
switch ($type) {
case 'string':
+ /// @todo should we be stricter in the accepted dates (ie. reject more of invalid days & times)?
if (in_array('auto_dates', $options) && preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $phpVal)) {
$xmlrpcVal = new Value($phpVal, Value::$xmlrpcDateTime);
} else {
case 'double':
$xmlrpcVal = new Value($phpVal, Value::$xmlrpcDouble);
break;
- // <G_Giunta_2001-02-29>
// Add support for encoding/decoding of booleans, since they are supported in PHP
case 'boolean':
$xmlrpcVal = new Value($phpVal, Value::$xmlrpcBoolean);
break;
- // </G_Giunta_2001-02-29>
case 'array':
- // PHP arrays can be encoded to either xmlrpc structs or arrays,
- // depending on wheter they are hashes or plain 0..n integer indexed
+ // PHP arrays can be encoded to either xmlrpc structs or arrays, depending on whether they are hashes
+ // or plain 0..n integer indexed
// A shorter one-liner would be
// $tmp = array_diff(array_keys($phpVal), range(0, count($phpVal)-1));
// but execution time skyrockets!
case 'object':
if (is_a($phpVal, 'PhpXmlRpc\Value')) {
$xmlrpcVal = $phpVal;
- } elseif (is_a($phpVal, 'DateTime')) {
- $xmlrpcVal = new Value($phpVal->format('Ymd\TH:i:s'), Value::$xmlrpcStruct);
+ } elseif (is_a($phpVal, 'DateTimeInterface')) {
+ $xmlrpcVal = new Value($phpVal->format('Ymd\TH:i:s'), Value::$xmlrpcDateTime);
+ } elseif (in_array('extension_api', $options) && $phpVal instanceof \stdClass && isset($phpVal->xmlrpc_type)) {
+ // Handle the 'pre-converted' base64 and datetime values
+ if (isset($phpVal->scalar)) {
+ switch ($phpVal->xmlrpc_type) {
+ case 'base64':
+ $xmlrpcVal = new Value($phpVal->scalar, Value::$xmlrpcBase64);
+ break;
+ case 'datetime':
+ $xmlrpcVal = new Value($phpVal->scalar, Value::$xmlrpcDateTime);
+ break;
+ default:
+ $xmlrpcVal = new Value();
+ }
+ } else {
+ $xmlrpcVal = new Value();
+ }
+
} else {
$arr = array();
- reset($phpVal);
- while (list($k, $v) = each($phpVal)) {
+ foreach($phpVal as $k => $v) {
$arr[$k] = $this->encode($v, $options);
}
$xmlrpcVal = new Value($arr, Value::$xmlrpcStruct);
} else {
$xmlrpcVal = new Value();
}
+ break;
// catch "user function", "unknown type"
default:
// giancarlo pinerolo <ping@alt.it>
- // it has to return
- // an empty object in case, not a boolean.
+ // it has to return an empty object in case, not a boolean.
$xmlrpcVal = new Value();
break;
}
* Convert the xml representation of a method response, method request or single
* xmlrpc value into the appropriate object (a.k.a. deserialize).
*
+ * @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 decode_xml($xmlVal, $options = array())
+ public function decodeXml($xmlVal, $options = array())
{
+ // 'guestimate' encoding
+ $valEncoding = XMLParser::guessEncoding('', $xmlVal);
+ if ($valEncoding != '') {
+
+ // Since parsing will fail if
+ // - charset is not specified in the xml prologue,
+ // - the encoding is not UTF8 and
+ // - there are non-ascii chars in the text,
+ // we try to work round that...
+ // The following code might be better for mb_string enabled installs, but makes the lib about 200% slower...
+ //if (!is_valid_charset($valEncoding, array('UTF-8'))
+ if (!in_array($valEncoding, array('UTF-8', 'US-ASCII')) && !XMLParser::hasEncoding($xmlVal)) {
+ if ($valEncoding == 'ISO-8859-1') {
+ $xmlVal = utf8_encode($xmlVal);
+ } else {
+ 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);
+ }
+ }
+ }
+ }
- /// @todo 'guestimate' encoding
- $parser = xml_parser_create();
- xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true);
- // What if internal encoding is not in one of the 3 allowed?
- // we use the broadest one, ie. utf8!
+ // 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'))) {
- xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');
+ /// @todo emit a warning
+ $parserOptions = array(XML_OPTION_TARGET_ENCODING => 'UTF-8');
} else {
- xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, PhpXmlRpc::$xmlrpc_internalencoding);
+ $parserOptions = array(XML_OPTION_TARGET_ENCODING => PhpXmlRpc::$xmlrpc_internalencoding);
}
- $xmlRpcParser = new XMLParser();
- xml_set_object($parser, $xmlRpcParser);
-
- xml_set_element_handler($parser, 'xmlrpc_se_any', 'xmlrpc_ee');
- xml_set_character_data_handler($parser, 'xmlrpc_cd');
- xml_set_default_handler($parser, 'xmlrpc_dh');
- if (!xml_parse($parser, $xmlVal, 1)) {
- $errstr = sprintf('XML error: %s at line %d, column %d',
- xml_error_string(xml_get_error_code($parser)),
- xml_get_current_line_number($parser), xml_get_current_column_number($parser));
- error_log($errstr);
- xml_parser_free($parser);
+ $xmlRpcParser = new XMLParser($parserOptions);
+ $xmlRpcParser->parse($xmlVal, XMLParser::RETURN_XMLRPCVALS, XMLParser::ACCEPT_REQUEST | XMLParser::ACCEPT_RESPONSE | XMLParser::ACCEPT_VALUE | XMLParser::ACCEPT_FAULT);
- return false;
- }
- xml_parser_free($parser);
if ($xmlRpcParser->_xh['isf'] > 1) {
// test that $xmlrpc->_xh['value'] is an obj, too???
- error_log($xmlRpcParser->_xh['isf_reason']);
+ Logger::instance()->errorLog($xmlRpcParser->_xh['isf_reason']);
return false;
}
+
switch ($xmlRpcParser->_xh['rt']) {
case 'methodresponse':
- $v = &$xmlRpcParser->_xh['value'];
+ $v = $xmlRpcParser->_xh['value'];
if ($xmlRpcParser->_xh['isf'] == 1) {
- $vc = $v->structmem('faultCode');
- $vs = $v->structmem('faultString');
+ /** @var Value $vc */
+ $vc = $v['faultCode'];
+ /** @var Value $vs */
+ $vs = $v['faultString'];
$r = new Response(0, $vc->scalarval(), $vs->scalarval());
} else {
$r = new Response($v);
}
-
return $r;
+
case 'methodcall':
- $m = new Request($xmlRpcParser->_xh['method']);
+ $req = new Request($xmlRpcParser->_xh['method']);
for ($i = 0; $i < count($xmlRpcParser->_xh['params']); $i++) {
- $m->addParam($xmlRpcParser->_xh['params'][$i]);
+ $req->addParam($xmlRpcParser->_xh['params'][$i]);
}
+ return $req;
- return $m;
case 'value':
return $xmlRpcParser->_xh['value'];
+
+ case 'fault':
+ // EPI api emulation
+ $v = $xmlRpcParser->_xh['value'];
+ // use a known error code
+ /** @var Value $vc */
+ $vc = isset($v['faultCode']) ? $v['faultCode']->scalarval() : PhpXmlRpc::$xmlrpcerr['invalid_return'];
+ /** @var Value $vs */
+ $vs = isset($v['faultString']) ? $v['faultString']->scalarval() : '';
+ if (!is_int($vc) || $vc == 0) {
+ $vc = PhpXmlRpc::$xmlrpcerr['invalid_return'];
+ }
+ return new Response(0, $vc, $vs);
default:
return false;
}
}
-
- /**
- * xml charset encoding guessing helper function.
- * Tries to determine the charset encoding of an XML chunk received over HTTP.
- * NB: according to the spec (RFC 3023), if text/xml content-type is received over HTTP without a content-type,
- * we SHOULD assume it is strictly US-ASCII. But we try to be more tolerant of unconforming (legacy?) clients/servers,
- * which will be most probably using UTF-8 anyway...
- *
- * @param string $httpHeader the http Content-type header
- * @param string $xmlChunk xml content buffer
- * @param string $encodingPrefs comma separated list of character encodings to be used as default (when mb extension is enabled)
- * @return string
- *
- * @todo explore usage of mb_http_input(): does it detect http headers + post data? if so, use it instead of hand-detection!!!
- */
- public static function guess_encoding($httpHeader = '', $xmlChunk = '', $encodingPrefs = null)
- {
- // discussion: see http://www.yale.edu/pclt/encoding/
- // 1 - test if encoding is specified in HTTP HEADERS
-
- //Details:
- // LWS: (\13\10)?( |\t)+
- // token: (any char but excluded stuff)+
- // quoted string: " (any char but double quotes and cointrol chars)* "
- // header: Content-type = ...; charset=value(; ...)*
- // where value is of type token, no LWS allowed between 'charset' and value
- // Note: we do not check for invalid chars in VALUE:
- // this had better be done using pure ereg as below
- // Note 2: we might be removing whitespace/tabs that ought to be left in if
- // the received charset is a quoted string. But nobody uses such charset names...
-
- /// @todo this test will pass if ANY header has charset specification, not only Content-Type. Fix it?
- $matches = array();
- if (preg_match('/;\s*charset\s*=([^;]+)/i', $httpHeader, $matches)) {
- return strtoupper(trim($matches[1], " \t\""));
- }
-
- // 2 - scan the first bytes of the data for a UTF-16 (or other) BOM pattern
- // (source: http://www.w3.org/TR/2000/REC-xml-20001006)
- // NOTE: actually, according to the spec, even if we find the BOM and determine
- // an encoding, we should check if there is an encoding specified
- // in the xml declaration, and verify if they match.
- /// @todo implement check as described above?
- /// @todo implement check for first bytes of string even without a BOM? (It sure looks harder than for cases WITH a BOM)
- if (preg_match('/^(\x00\x00\xFE\xFF|\xFF\xFE\x00\x00|\x00\x00\xFF\xFE|\xFE\xFF\x00\x00)/', $xmlChunk)) {
- return 'UCS-4';
- } elseif (preg_match('/^(\xFE\xFF|\xFF\xFE)/', $xmlChunk)) {
- return 'UTF-16';
- } elseif (preg_match('/^(\xEF\xBB\xBF)/', $xmlChunk)) {
- return 'UTF-8';
- }
-
- // 3 - test if encoding is specified in the xml declaration
- // Details:
- // SPACE: (#x20 | #x9 | #xD | #xA)+ === [ \x9\xD\xA]+
- // EQ: SPACE?=SPACE? === [ \x9\xD\xA]*=[ \x9\xD\xA]*
- if (preg_match('/^<\?xml\s+version\s*=\s*' . "((?:\"[a-zA-Z0-9_.:-]+\")|(?:'[a-zA-Z0-9_.:-]+'))" .
- '\s+encoding\s*=\s*' . "((?:\"[A-Za-z][A-Za-z0-9._-]*\")|(?:'[A-Za-z][A-Za-z0-9._-]*'))/",
- $xmlChunk, $matches)) {
- return strtoupper(substr($matches[2], 1, -1));
- }
-
- // 4 - if mbstring is available, let it do the guesswork
- // NB: we favour finding an encoding that is compatible with what we can process
- if (extension_loaded('mbstring')) {
- if ($encodingPrefs) {
- $enc = mb_detect_encoding($xmlChunk, $encodingPrefs);
- } else {
- $enc = mb_detect_encoding($xmlChunk);
- }
- // NB: mb_detect likes to call it ascii, xml parser likes to call it US_ASCII...
- // IANA also likes better US-ASCII, so go with it
- if ($enc == 'ASCII') {
- $enc = 'US-' . $enc;
- }
-
- return $enc;
- } else {
- // no encoding specified: as per HTTP1.1 assume it is iso-8859-1?
- // Both RFC 2616 (HTTP 1.1) and 1945 (HTTP 1.0) clearly state that for text/xxx content types
- // this should be the standard. And we should be getting text/xml as request and response.
- // BUT we have to be backward compatible with the lib, which always used UTF-8 as default...
- return PhpXmlRpc::$xmlrpc_defencoding;
- }
- }
}
git://git.onelab.eu / plcapi.git / blobdiff