* fixed: the function decode_xml() would not decode an xml with character set declaration in the xml prologue
+* improved: echo all debug messages even when there are characters in them which php deems in a wrong encoding
+ (this is visible e.g. in the debugger)
+
XML-RPC for PHP version 3.0.0 - 2014/6/15
namespace PhpXmlRpc;
+use PhpXmlRpc\Helper\Logger;
+
class Client
{
/// @todo: do these need to be public?
$payload;
if ($this->debug > 1) {
- $this->debugMessage("---SENDING---\n$op\n---END---");
+ Logger::debugMessage("---SENDING---\n$op\n---END---");
}
if ($timeout > 0) {
}
if ($this->debug > 1) {
- $this->debugMessage("---SENDING---\n$payload\n---END---");
- // let the client see this now in case http times out...
- flush();
+ Logger::debugMessage("---SENDING---\n$payload\n---END---");
}
if (!$keepAlive || !$this->xmlrpc_curl_handle) {
$message .= $name . ': ' . $val . "\n";
}
$message .= "---END---";
- $this->debugMessage($message);
+ Logger::debugMessage($message);
}
if (!$result) {
if ($this->return_type == 'xml') {
return $rets;
} elseif ($this->return_type == 'phpvals') {
- ///@todo test this code branch...
+ /// @todo test this code branch...
$rets = $result->value();
if (!is_array($rets)) {
return false; // bad return type from system.multicall
return $response;
}
}
-
- /**
- * Echoes a debug message, taking care of escaping it when not in console mode
- *
- * @param string $message
- */
- protected function debugMessage($message)
- {
- if (PHP_SAPI != 'cli') {
- print "<PRE>\n".htmlentities($message)."\n</PRE>";
- } else {
- print "\n$message\n";
- }
- // let the client see this now in case http times out...
- flush();
- }
}
namespace PhpXmlRpc\Helper;
use PhpXmlRpc\PhpXmlRpc;
+use PhpXmlRpc\Helper\Logger;
class Http
{
foreach ($httpResponse['cookies'] as $header => $value) {
$msg .= "COOKIE: $header={$value['value']}\n";
}
- $this->debugMessage($msg);
+ Logger::debugMessage($msg);
}
// if CURL was used for the call, http headers have been processed,
if ($httpResponse['headers']['content-encoding'] == 'deflate' && $degzdata = @gzuncompress($data)) {
$data = $degzdata;
if ($debug) {
- $this->debugMessage("---INFLATED RESPONSE---[" . strlen($data) . " chars]---\n$data\n---END---");
+ Logger::debugMessage("---INFLATED RESPONSE---[" . strlen($data) . " chars]---\n$data\n---END---");
}
} elseif ($httpResponse['headers']['content-encoding'] == 'gzip' && $degzdata = @gzinflate(substr($data, 10))) {
$data = $degzdata;
if ($debug) {
- $this->debugMessage("---INFLATED RESPONSE---[" . strlen($data) . " chars]---\n$data\n---END---");
+ Logger::debugMessage("---INFLATED RESPONSE---[" . strlen($data) . " chars]---\n$data\n---END---");
}
} else {
error_log('XML-RPC: ' . __METHOD__ . ': errors occurred when trying to decode the deflated data received from server');
return $httpResponse;
}
-
- /**
- * Echoes a debug message, taking care of escaping it when not in console mode
- *
- * @param string $message
- */
- protected function debugMessage($message)
- {
- if (PHP_SAPI != 'cli') {
- print "<PRE>\n".htmlentities($message)."\n</PRE>";
- } else {
- print "\n$message\n";
- }
- }
}
--- /dev/null
+<?php
+/**
+ * Created by PhpStorm.
+ * User: gg
+ * Date: 12/04/2015
+ * Time: 12:11
+ */
+
+namespace PhpXmlRpc\Helper;
+
+
+class Logger
+{
+ /**
+ * Echoes a debug message, taking care of escaping it when not in console mode.
+ * NB: if the encoding of the message is not known or wrong, and we are working in web mode, there is no guarantee
+ * of 100% accuracy, which kind of defeats the purpose of debugging
+ *
+ * @param string $message
+ * @param string $encoding
+ */
+ public static function debugMessage($message, $encoding=null)
+ {
+ if (PHP_SAPI != 'cli') {
+ $flags = ENT_COMPAT | ENT_HTML401 | ENT_SUBSTITUTE;
+ if ($encoding != null) {
+ print "<PRE>\n".htmlentities($message, $flags, $encoding)."\n</PRE>";
+ } else {
+ print "<PRE>\n".htmlentities($message, $flags)."\n</PRE>";
+ }
+ } else {
+ print "\n$message\n";
+ }
+
+ // let the user see this now in case there's a time out later...
+ flush();
+ }
+}
\ No newline at end of file
// The encoding used internally by PHP.
// String values received as xml will be converted to this, and php strings will be converted to xml
// as if having been coded with this
- public static $xmlrpc_internalencoding = "ISO-8859-1"; // TODO: maybe this would be better as UTF-8, or at least configurable?
+ public static $xmlrpc_internalencoding = "ISO-8859-1"; // TODO: maybe this would be better as UTF-8
public static $xmlrpcName = "XML-RPC for PHP";
public static $xmlrpcVersion = "4.0.0.beta";
}
}
}
+
}
use PhpXmlRpc\Helper\Http;
use PhpXmlRpc\Helper\XMLParser;
+use PhpXmlRpc\Helper\Logger;
class Request
{
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::debugMessage("---GOT---\n$data\n---END---");
}
$this->httpResponse = array('raw_data' => $data, 'headers' => array(), 'cookies' => array());
}
}
- 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);
$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::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 ($returnType == 'xml') {
$r = new Response($data, 0, '', 'xml');
return $r;
}
- // try to 'guestimate' the character encoding of the received response
- $respEncoding = XMLParser::guessEncoding(@$this->httpResponse['headers']['content-type'], $data);
-
if ($respEncoding != '') {
// Since parsing will fail if charset is not specified in the xml prologue,
PhpXmlRpc::$xmlrpcstr['invalid_return']);
} else {
if ($this->debug) {
- $this->debugMessage(
- "---PARSED---\n".var_export($xmlRpcParser->_xh['value'], true)."\n---END---", false
+ Logger::debugMessage(
+ "---PARSED---\n".var_export($xmlRpcParser->_xh['value'], true)."\n---END---"
);
}
$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...
+ /// @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->structmem('faultCode');
$errStr_v = $v->structmem('faultString');
return $r;
}
-
- /**
- * Echoes a debug message, taking care of escaping it when not in console mode
- *
- * @param string $message
- * @param bool $encodeEntities when false, escapes using htmlspecialchars instead of htmlentities
- */
- protected function debugMessage($message, $encodeEntities = true)
- {
- 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";
- }
- }
}
git://git.onelab.eu / plcapi.git / commitdiff