X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=src%2FRequest.php;h=01fc9d660c186cf0047e29d806fe41f4bb72f1dd;hb=b337d292eb5b5656d27a2fc9ab6796be300c59a3;hp=b3b8112afc0ef1d16248a8ddc7c12ed5329dc938;hpb=7fbd194478e080d624bab075d189bf3ba215325d;p=plcapi.git diff --git a/src/Request.php b/src/Request.php index b3b8112..01fc9d6 100644 --- a/src/Request.php +++ b/src/Request.php @@ -13,9 +13,15 @@ use PhpXmlRpc\Helper\XMLParser; */ class Request { + protected static $logger; + protected static $parser; + protected static $charsetEncoder; + /// @todo: do these need to be public? public $payload; + /** @internal */ public $methodname; + /** @internal */ public $params = array(); public $debug = 0; public $content_type = 'text/xml'; @@ -23,6 +29,45 @@ class Request // holds data while parsing the response. NB: Not a full Response object protected $httpResponse = array(); + 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; + } + + public function getCharsetEncoder() + { + if (self::$charsetEncoder === null) { + self::$charsetEncoder = Charset::instance(); + } + return self::$charsetEncoder; + } + + public function setCharsetEncoder($charsetEncoder) + { + self::$charsetEncoder = $charsetEncoder; + } + /** * @param string $methodName the name of the method to invoke * @param Value[] $params array of parameters to be passed to the method (NB: Value objects, not plain php values) @@ -35,6 +80,11 @@ class Request } } + /** + * @internal this function will become protected in the future + * @param string $charsetEncoding + * @return string + */ public function xml_header($charsetEncoding = '') { if ($charsetEncoding != '') { @@ -44,11 +94,19 @@ class Request } } + /** + * @internal this function will become protected in the future + * @return string + */ public function xml_footer() { return ''; } + /** + * @internal this function will become protected in the future + * @param string $charsetEncoding + */ public function createPayload($charsetEncoding = '') { if ($charsetEncoding != '') { @@ -57,7 +115,7 @@ class Request $this->content_type = 'text/xml'; } $this->payload = $this->xml_header($charsetEncoding); - $this->payload .= '' . Charset::instance()->encodeEntities( + $this->payload .= '' . $this->getCharsetEncoder()->encodeEntities( $this->methodname, PhpXmlRpc::$xmlrpc_internalencoding, $charsetEncoding) . "\n"; $this->payload .= "\n"; foreach ($this->params as $p) { @@ -150,18 +208,18 @@ class Request * because we cannot trust the caller to give us a valid pointer to an open file... * * @param resource $fp stream pointer + * @param bool $headersProcessed + * @param string $returnType * * @return Response - * - * @todo add 2nd & 3rd param to be passed to ParseResponse() ??? */ - public function parseResponseFile($fp) + public function parseResponseFile($fp, $headersProcessed = false, $returnType = 'xmlrpcvals') { $ipd = ''; while ($data = fread($fp, 32768)) { $ipd .= $data; } - return $this->parseResponse($ipd); + return $this->parseResponse($ipd, $headersProcessed, $returnType); } /** @@ -176,17 +234,19 @@ class Request * 'phpvals' * * @return Response + * + * @todo parsing Responses is not really the responsibility of the Request class. Maybe of the Client... */ public function parseResponse($data = '', $headersProcessed = false, $returnType = 'xmlrpcvals') { if ($this->debug) { - Logger::instance()->debugMessage("---GOT---\n$data\n---END---"); + $this->getLogger()->debugMessage("---GOT---\n$data\n---END---"); } $this->httpResponse = array('raw_data' => $data, 'headers' => array(), 'cookies' => array()); if ($data == '') { - error_log('XML-RPC: ' . __METHOD__ . ': no response received from server.'); + $this->getLogger()->errorLog('XML-RPC: ' . __METHOD__ . ': no response received from server.'); return new Response(0, PhpXmlRpc::$xmlrpcerr['no_data'], PhpXmlRpc::$xmlrpcstr['no_data']); } @@ -208,7 +268,7 @@ class Request // be tolerant of extra whitespace in response body $data = trim($data); - /// @todo return an error msg if $data=='' ? + /// @todo return an error msg if $data == '' ? // be tolerant of junk after methodResponse (e.g. javascript ads automatically inserted by free hosts) // idea from Luca Mariano originally in PEARified version of the lib @@ -226,12 +286,12 @@ class Request $start += strlen('', $start); $comments = substr($data, $start, $end - $start); - Logger::instance()->debugMessage("---SERVER DEBUG INFO (DECODED) ---\n\t" . + $this->getLogger()->debugMessage("---SERVER DEBUG INFO (DECODED) ---\n\t" . str_replace("\n", "\n\t", base64_decode($comments)) . "\n---END---", $respEncoding); } } - // if user wants back raw xml, give it to him + // if user wants back raw xml, give it to her if ($returnType == 'xml') { $r = new Response($data, 0, '', 'xml'); $r->hdrs = $this->httpResponse['headers']; @@ -245,82 +305,59 @@ class Request // 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... + // The following code might be better for mb_string enabled installs, but makes the lib about 200% slower... //if (!is_valid_charset($respEncoding, array('UTF-8'))) if (!in_array($respEncoding, array('UTF-8', 'US-ASCII')) && !XMLParser::hasEncoding($data)) { if ($respEncoding == 'ISO-8859-1') { $data = utf8_encode($data); } else { + if (extension_loaded('mbstring')) { $data = mb_convert_encoding($data, 'UTF-8', $respEncoding); } else { - error_log('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of received response: ' . $respEncoding); + $this->getLogger()->errorLog('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of received response: ' . $respEncoding); } } } } - $parser = xml_parser_create(); - xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true); - // G. Giunta 2005/02/13: PHP internally uses ISO-8859-1, so we have to tell - // the xml parser to give us back data in the expected charset. - // What if internal encoding is not in one of the 3 allowed? - // we use the broadest one, ie. utf8 - // This allows to send data which is native in various charset, - // by extending xmlrpc_encode_entities() and setting xmlrpc_internalencoding + // PHP internally might use ISO-8859-1, so we have to tell the xml parser to give us back data in the expected charset. + // What if internal encoding is not in one of the 3 allowed? We use the broadest one, ie. utf8 + // This allows to send data which is native in various charset, by extending xmlrpc_encode_entities() and + // setting xmlrpc_internalencoding 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 + $options = array(XML_OPTION_TARGET_ENCODING => 'UTF-8'); } else { - xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, PhpXmlRpc::$xmlrpc_internalencoding); + $options = array(XML_OPTION_TARGET_ENCODING => PhpXmlRpc::$xmlrpc_internalencoding); } - $xmlRpcParser = new XMLParser(); - xml_set_object($parser, $xmlRpcParser); + $xmlRpcParser = $this->getParser(); + $xmlRpcParser->parse($data, $returnType, XMLParser::ACCEPT_RESPONSE, $options); - if ($returnType == 'phpvals') { - xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast'); - } else { - xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee'); - } + // first error check: xml not well formed + if ($xmlRpcParser->_xh['isf'] > 2) { - xml_set_character_data_handler($parser, 'xmlrpc_cd'); - xml_set_default_handler($parser, 'xmlrpc_dh'); + // BC break: in the past for some cases we used the error message: 'XML error at line 1, check URL' + + $r = new Response(0, PhpXmlRpc::$xmlrpcerr['invalid_return'], + PhpXmlRpc::$xmlrpcstr['invalid_return'] . ' ' . $xmlRpcParser->_xh['isf_reason']); - // first error check: xml not well formed - if (!xml_parse($parser, $data, 1)) { - // thanks to Peter Kocks - if ((xml_get_current_line_number($parser)) == 1) { - $errStr = 'XML error at line 1, check URL'; - } else { - $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); - $r = new Response(0, PhpXmlRpc::$xmlrpcerr['invalid_return'], PhpXmlRpc::$xmlrpcstr['invalid_return'] . ' ' . $errStr); - xml_parser_free($parser); if ($this->debug) { - print $errStr; + print $xmlRpcParser->_xh['isf_reason']; } - $r->hdrs = $this->httpResponse['headers']; - $r->_cookies = $this->httpResponse['cookies']; - $r->raw_data = $this->httpResponse['raw_data']; - - return $r; } - xml_parser_free($parser); // second error check: xml well formed but not xml-rpc compliant - if ($xmlRpcParser->_xh['isf'] > 1) { + elseif ($xmlRpcParser->_xh['isf'] == 2) { + $r = new Response(0, PhpXmlRpc::$xmlrpcerr['invalid_return'], + PhpXmlRpc::$xmlrpcstr['invalid_return'] . ' ' . $xmlRpcParser->_xh['isf_reason']); + if ($this->debug) { /// @todo echo something for user? } - - $r = new Response(0, PhpXmlRpc::$xmlrpcerr['invalid_return'], - PhpXmlRpc::$xmlrpcstr['invalid_return'] . ' ' . $xmlRpcParser->_xh['isf_reason']); } // third error check: parsing of the response has somehow gone boink. - // NB: shall we omit this check, since we trust the parsing code? + /// @todo shall we omit this check, since we trust the parsing code? elseif ($returnType == 'xmlrpcvals' && !is_object($xmlRpcParser->_xh['value'])) { // something odd has happened // and it's time to generate a client side error @@ -329,7 +366,7 @@ class Request PhpXmlRpc::$xmlrpcstr['invalid_return']); } else { if ($this->debug > 1) { - Logger::instance()->debugMessage( + $this->getLogger()->debugMessage( "---PARSED---\n".var_export($xmlRpcParser->_xh['value'], true)."\n---END---" ); }