X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=src%2FRequest.php;h=52a3b975db8e512ac3b2dc7e063ad93e9e3c53be;hb=a48c09b3cc49bc7f603cd5b06de74ee2d2878ca4;hp=17aae840049b093a12f2d11a333d55595780db58;hpb=9ff27b2483717ec728dda6a9045d2146e85bde86;p=plcapi.git

diff --git a/src/Request.php b/src/Request.php
index 17aae84..52a3b97 100644
--- a/src/Request.php
+++ b/src/Request.php
@@ -2,7 +2,9 @@
 
 namespace PhpXmlRpc;
 
+use PhpXmlRpc\Helper\Charset;
 use PhpXmlRpc\Helper\Http;
+use PhpXmlRpc\Helper\Logger;
 use PhpXmlRpc\Helper\XMLParser;
 
 class Request
@@ -29,10 +31,10 @@ class Request
         }
     }
 
-    public function xml_header($charset_encoding = '')
+    public function xml_header($charsetEncoding = '')
     {
-        if ($charset_encoding != '') {
-            return "<?xml version=\"1.0\" encoding=\"$charset_encoding\" ?" . ">\n<methodCall>\n";
+        if ($charsetEncoding != '') {
+            return "<?xml version=\"1.0\" encoding=\"$charsetEncoding\" ?" . ">\n<methodCall>\n";
         } else {
             return "<?xml version=\"1.0\"?" . ">\n<methodCall>\n";
         }
@@ -43,18 +45,18 @@ class Request
         return '</methodCall>';
     }
 
-    public function createPayload($charset_encoding = '')
+    public function createPayload($charsetEncoding = '')
     {
-        if ($charset_encoding != '') {
-            $this->content_type = 'text/xml; charset=' . $charset_encoding;
+        if ($charsetEncoding != '') {
+            $this->content_type = 'text/xml; charset=' . $charsetEncoding;
         } else {
             $this->content_type = 'text/xml';
         }
-        $this->payload = $this->xml_header($charset_encoding);
-        $this->payload .= '<methodName>' . $this->methodname . "</methodName>\n";
+        $this->payload = $this->xml_header($charsetEncoding);
+        $this->payload .= '<methodName>' . Charset::instance()->encodeEntities($this->methodname, PhpXmlRpc::$xmlrpc_internalencoding, $charsetEncoding) . "</methodName>\n";
         $this->payload .= "<params>\n";
         foreach ($this->params as $p) {
-            $this->payload .= "<param>\n" . $p->serialize($charset_encoding) .
+            $this->payload .= "<param>\n" . $p->serialize($charsetEncoding) .
                 "</param>\n";
         }
         $this->payload .= "</params>\n";
@@ -80,13 +82,13 @@ class Request
     /**
      * Returns xml representation of the message. XML prologue included.
      *
-     * @param string $charset_encoding
+     * @param string $charsetEncoding
      *
      * @return string the xml representation of the message, xml prologue included
      */
-    public function serialize($charset_encoding = '')
+    public function serialize($charsetEncoding = '')
     {
-        $this->createPayload($charset_encoding);
+        $this->createPayload($charsetEncoding);
 
         return $this->payload;
     }
@@ -100,7 +102,7 @@ class Request
      */
     public function addParam($param)
     {
-        // add check: do not add to self params which are not xmlrpcvals
+        // add check: do not add to self params which are not xmlrpc values
         if (is_object($param) && is_a($param, 'PhpXmlRpc\Value')) {
             $this->params[] = $param;
 
@@ -160,16 +162,15 @@ class Request
      * Parse the xmlrpc response contained in the string $data and return a Response object.
      *
      * @param string $data the xmlrpc response, eventually including http headers
-     * @param bool $headers_processed when true prevents parsing HTTP headers for interpretation of content-encoding and consequent decoding
-     * @param string $return_type decides return type, i.e. content of response->value(). Either 'xmlrpcvals', 'xml' or 'phpvals'
+     * @param bool $headersProcessed when true prevents parsing HTTP headers for interpretation of content-encoding and consequent decoding
+     * @param string $returnType decides return type, i.e. content of response->value(). Either 'xmlrpcvals', 'xml' or 'phpvals'
      *
      * @return Response
      */
-    public function parseResponse($data = '', $headers_processed = false, $return_type = 'xmlrpcvals')
+    public function parseResponse($data = '', $headersProcessed = false, $returnType = 'xmlrpcvals')
     {
         if ($this->debug) {
-            // by maHo, replaced htmlspecialchars with htmlentities
-            $this->debugMessage("---GOT---\n$data\n---END---");
+            Logger::instance()->debugMessage("---GOT---\n$data\n---END---");
         }
 
         $this->httpResponse = array('raw_data' => $data, 'headers' => array(), 'cookies' => array());
@@ -183,7 +184,7 @@ class Request
         if (substr($data, 0, 4) == 'HTTP') {
             $httpParser = new Http();
             try {
-                $this->httpResponse = $httpParser->parseResponseHeaders($data, $headers_processed, $this->debug);
+                $this->httpResponse = $httpParser->parseResponseHeaders($data, $headersProcessed, $this->debug);
             } catch(\Exception $e) {
                 $r = new Response(0, $e->getCode(), $e->getMessage());
                 // failed processing of HTTP response headers
@@ -194,16 +195,6 @@ class Request
             }
         }
 
-        if ($this->debug) {
-            $start = strpos($data, '<!-- SERVER DEBUG INFO (BASE64 ENCODED):');
-            if ($start) {
-                $start += strlen('<!-- SERVER DEBUG INFO (BASE64 ENCODED):');
-                $end = strpos($data, '-->', $start);
-                $comments = substr($data, $start, $end - $start);
-                $this->debugMessage("---SERVER DEBUG INFO (DECODED) ---\n\t" . str_replace("\n", "\n\t", base64_decode($comments))) . "\n---END---\n</PRE>";
-            }
-        }
-
         // be tolerant of extra whitespace in response body
         $data = trim($data);
 
@@ -216,8 +207,22 @@ class Request
             $data = substr($data, 0, $pos + 17);
         }
 
+        // try to 'guestimate' the character encoding of the received response
+        $respEncoding = XMLParser::guessEncoding(@$this->httpResponse['headers']['content-type'], $data);
+
+        if ($this->debug) {
+            $start = strpos($data, '<!-- SERVER DEBUG INFO (BASE64 ENCODED):');
+            if ($start) {
+                $start += strlen('<!-- SERVER DEBUG INFO (BASE64 ENCODED):');
+                $end = strpos($data, '-->', $start);
+                $comments = substr($data, $start, $end - $start);
+                Logger::instance()->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 ($return_type == 'xml') {
+        if ($returnType == 'xml') {
             $r = new Response($data, 0, '', 'xml');
             $r->hdrs = $this->httpResponse['headers'];
             $r->_cookies = $this->httpResponse['cookies'];
@@ -226,20 +231,27 @@ class Request
             return $r;
         }
 
-        // try to 'guestimate' the character encoding of the received response
-        $resp_encoding = Encoder::guess_encoding(@$this->httpResponse['headers']['content-type'], $data);
+        if ($respEncoding != '') {
 
-        // if response charset encoding is not known / supported, try to use
-        // the default encoding and parse the xml anyway, but log a warning...
-        if (!in_array($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) {
-            // the following code might be better for mb_string enabled installs, but
+            // 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($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
-
-            error_log('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of received response: ' . $resp_encoding);
-            $resp_encoding = PhpXmlRpc::$xmlrpc_defencoding;
+            //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);
+                    }
+                }
+            }
         }
-        $parser = xml_parser_create($resp_encoding);
+
+        $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.
@@ -256,7 +268,7 @@ class Request
         $xmlRpcParser = new XMLParser();
         xml_set_object($parser, $xmlRpcParser);
 
-        if ($return_type == 'phpvals') {
+        if ($returnType == 'phpvals') {
             xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast');
         } else {
             xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee');
@@ -269,17 +281,17 @@ class Request
         if (!xml_parse($parser, $data, count($data))) {
             // thanks to Peter Kocks <peter.kocks@baygate.com>
             if ((xml_get_current_line_number($parser)) == 1) {
-                $errstr = 'XML error at line 1, check URL';
+                $errStr = 'XML error at line 1, check URL';
             } else {
-                $errstr = sprintf('XML error: %s at line %d, column %d',
+                $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 . ')');
+            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 $errStr;
             }
             $r->hdrs = $this->httpResponse['headers'];
             $r->_cookies = $this->httpResponse['cookies'];
@@ -299,16 +311,16 @@ class Request
         }
         // third error check: parsing of the response has somehow gone boink.
         // NB: shall we omit this check, since we trust the parsing code?
-        elseif ($return_type == 'xmlrpcvals' && !is_object($xmlRpcParser->_xh['value'])) {
+        elseif ($returnType == 'xmlrpcvals' && !is_object($xmlRpcParser->_xh['value'])) {
             // something odd has happened
             // and it's time to generate a client side error
             // indicating something odd went on
             $r = new Response(0, PhpXmlRpc::$xmlrpcerr['invalid_return'],
                 PhpXmlRpc::$xmlrpcstr['invalid_return']);
         } else {
-            if ($this->debug) {
-                $this->debugMessage(
-                    "---PARSED---\n".var_export($xmlRpcParser->_xh['value'], true)."\n---END---", false
+            if ($this->debug > 1) {
+                Logger::instance()->debugMessage(
+                    "---PARSED---\n".var_export($xmlRpcParser->_xh['value'], true)."\n---END---"
                 );
             }
 
@@ -316,26 +328,25 @@ class Request
             $v = &$xmlRpcParser->_xh['value'];
 
             if ($xmlRpcParser->_xh['isf']) {
-                /// @todo we should test here if server sent an int and a string,
-                /// and/or coerce them into such...
-                if ($return_type == 'xmlrpcvals') {
-                    $errno_v = $v->structmem('faultCode');
-                    $errstr_v = $v->structmem('faultString');
-                    $errno = $errno_v->scalarval();
-                    $errstr = $errstr_v->scalarval();
+                /// @todo we should test here if server sent an int and a string, and/or coerce them into such...
+                if ($returnType == 'xmlrpcvals') {
+                    $errNo_v = $v['faultCode'];
+                    $errStr_v = $v['faultString'];
+                    $errNo = $errNo_v->scalarval();
+                    $errStr = $errStr_v->scalarval();
                 } else {
-                    $errno = $v['faultCode'];
-                    $errstr = $v['faultString'];
+                    $errNo = $v['faultCode'];
+                    $errStr = $v['faultString'];
                 }
 
-                if ($errno == 0) {
+                if ($errNo == 0) {
                     // FAULT returned, errno needs to reflect that
-                    $errno = -1;
+                    $errNo = -1;
                 }
 
-                $r = new Response(0, $errno, $errstr);
+                $r = new Response(0, $errNo, $errStr);
             } else {
-                $r = new Response($v, 0, '', $return_type);
+                $r = new Response($v, 0, '', $returnType);
             }
         }
 
@@ -347,20 +358,22 @@ class Request
     }
 
     /**
-     * Echoes a debug message, taking care of escaping it when not in console mode
+     * Kept the old name even if Request class was renamed, for compatibility.
      *
-     * @param string $message
+     * @return string
      */
-    protected function debugMessage($message, $encodeEntities = true)
+    public function kindOf()
     {
-        if (PHP_SAPI != 'cli') {
-            if ($encodeEntities)
-                print "<PRE>\n".htmlentities($message)."\n</PRE>";
-            else
-                print "<PRE>\n".htmlspecialchars($message)."\n</PRE>";
-        }
-        else {
-            print "\n$message\n";
-        }
+        return 'msg';
+    }
+
+    /**
+     * Enables/disables the echoing to screen of the xmlrpc responses received.
+     *
+     * @param integer $in values 0, 1, 2 are supported
+     */
+    public function setDebug($in)
+    {
+        $this->debug = $in;
     }
 }