namespace PhpXmlRpc;
+use PhpXmlRpc\Exception\HttpException;
+use PhpXmlRpc\Helper\Charset;
use PhpXmlRpc\Helper\Http;
+use PhpXmlRpc\Helper\Logger;
use PhpXmlRpc\Helper\XMLParser;
+/**
+ * This class provides the representation of a request to an XML-RPC server.
+ * A client sends a PhpXmlrpc\Request to a server, and receives back an PhpXmlrpc\Response.
+ */
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';
// holds data while parsing the response. NB: Not a full Response object
+ /** @deprecated will be removed in a future release */
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 (Value objects)
+ * @param Value[] $params array of parameters to be passed to the method (NB: Value objects, not plain php values)
*/
public function __construct($methodName, $params = array())
{
}
}
- public function xml_header($charset_encoding = '')
+ /**
+ * @internal this function will become protected in the future
+ * @param string $charsetEncoding
+ * @return string
+ */
+ 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";
}
}
+ /**
+ * @internal this function will become protected in the future
+ * @return string
+ */
public function xml_footer()
{
return '</methodCall>';
}
- public function createPayload($charset_encoding = '')
+ /**
+ * @internal this function will become protected in the future
+ * @param string $charsetEncoding
+ */
+ 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>' . $this->getCharsetEncoder()->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";
/**
* 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;
}
/**
* Add a parameter to the list of parameters to be used upon method invocation.
*
+ * Checks that $params is actually a Value object and not a plain php value.
+ *
* @param Value $param
*
* @return boolean false on failure
*/
public function addParam($param)
{
- // add check: do not add to self params which are not xmlrpcvals
+ // check: do not add to self params which are not xmlrpc values
if (is_object($param) && is_a($param, 'PhpXmlRpc\Value')) {
$this->params[] = $param;
/**
* Given an open file handle, read all data available and parse it as an xmlrpc response.
+ *
* NB: the file handle is not closed by this function.
- * NNB: might have trouble in rare cases to work on network streams, as we
- * check for a read of 0 bytes instead of feof($fp).
- * But since checking for feof(null) returns false, we would risk an
- * infinite loop in that case, because we cannot trust the caller
- * to give us a valid pointer to an open file...
+ * NNB: might have trouble in rare cases to work on network streams, as we check for a read of 0 bytes instead of
+ * feof($fp). But since checking for feof(null) returns false, we would risk an infinite loop in that case,
+ * 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);
}
/**
* 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'
+ * When $this->debug has been set to a value greater than 0, will echo debug messages to screen while decoding.
+ *
+ * @param string $data the xmlrpc response, possibly including http headers
+ * @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
+ *
+ * @todo parsing Responses is not really the responsibility of the Request class. Maybe of the Client...
*/
- public function parseResponse($data = '', $headers_processed = false, $return_type = 'xmlrpcvals')
+ public function parseResponse($data = '', $headersProcessed = false, $returnType = XMLParser::RETURN_XMLRPCVALS)
{
if ($this->debug) {
- // by maHo, replaced htmlspecialchars with htmlentities
- $this->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']);
}
if (substr($data, 0, 4) == 'HTTP') {
$httpParser = new Http();
try {
- $this->httpResponse = $httpParser->parseResponseHeaders($data, $headers_processed, $this->debug);
- } catch(\Exception $e) {
- $r = new Response(0, $e->getCode(), $e->getMessage());
+ $this->httpResponse = $httpParser->parseResponseHeaders($data, $headersProcessed, $this->debug);
+ } catch (HttpException $e) {
// failed processing of HTTP response headers
// save into response obj the full payload received, for debugging
- $r->raw_data = $data;
-
- return $r;
- }
- }
-
- 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>";
+ return new Response(0, $e->getCode(), $e->getMessage(), '', array('raw_data' => $data, 'status_code', $e->statusCode()));
+ } catch(\Exception $e) {
+ return new Response(0, $e->getCode(), $e->getMessage(), '', array('raw_data' => $data));
}
}
// 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 <luca.mariano@email.it> originally in PEARified version of the lib
$data = substr($data, 0, $pos + 17);
}
- // if user wants back raw xml, give it to him
- if ($return_type == 'xml') {
- $r = new Response($data, 0, '', 'xml');
- $r->hdrs = $this->httpResponse['headers'];
- $r->_cookies = $this->httpResponse['cookies'];
- $r->raw_data = $this->httpResponse['raw_data'];
+ // try to 'guestimate' the character encoding of the received response
+ $respEncoding = XMLParser::guessEncoding(@$this->httpResponse['headers']['content-type'], $data);
- return $r;
+ 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->getLogger()->debugMessage("---SERVER DEBUG INFO (DECODED) ---\n\t" .
+ str_replace("\n", "\n\t", base64_decode($comments)) . "\n---END---", $respEncoding);
+ }
}
- // try to 'guestimate' the character encoding of the received response
- $resp_encoding = Encoder::guess_encoding(@$this->httpResponse['headers']['content-type'], $data);
+ // if user wants back raw xml, give it to her
+ if ($returnType == 'xml') {
+ return new Response($data, 0, '', 'xml', $this->httpResponse);
+ }
- // 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
- // makes the lib about 200% slower...
- //if (!is_valid_charset($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
+ if ($respEncoding != '') {
- error_log('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of received response: ' . $resp_encoding);
- $resp_encoding = PhpXmlRpc::$xmlrpc_defencoding;
+ // 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($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 {
+ $this->getLogger()->errorLog('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of received response: ' . $respEncoding);
+ }
+ }
+ }
}
- $parser = xml_parser_create($resp_encoding);
- 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 ($return_type == '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'], '',
+ $this->httpResponse
+ );
- // first error check: xml not well formed
- 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';
- } 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'], '',
+ $this->httpResponse
+ );
+
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?
- elseif ($return_type == 'xmlrpcvals' && !is_object($xmlRpcParser->_xh['value'])) {
+ /// @todo shall we omit this check, since we trust the parsing code?
+ elseif ($returnType == XMLParser::RETURN_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']);
+ $r = new Response(0, PhpXmlRpc::$xmlrpcerr['invalid_return'], PhpXmlRpc::$xmlrpcstr['invalid_return'],
+ '', $this->httpResponse
+ );
} else {
- if ($this->debug) {
- $this->debugMessage(
- "---PARSED---\n".var_export($xmlRpcParser->_xh['value'], true)."\n---END---", false
+ if ($this->debug > 1) {
+ $this->getLogger()->debugMessage(
+ "---PARSED---\n".var_export($xmlRpcParser->_xh['value'], true)."\n---END---"
);
}
- // note that using =& will raise an error if $xmlRpcParser->_xh['st'] does not generate an object.
- $v = &$xmlRpcParser->_xh['value'];
+ $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 == XMLParser::RETURN_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, '', $this->httpResponse);
} else {
- $r = new Response($v, 0, '', $return_type);
+ $r = new Response($v, 0, '', $returnType, $this->httpResponse);
}
}
- $r->hdrs = $this->httpResponse['headers'];
- $r->_cookies = $this->httpResponse['cookies'];
- $r->raw_data = $this->httpResponse['raw_data'];
-
return $r;
}
/**
- * 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 $level values 0, 1, 2 are supported
+ */
+ public function setDebug($level)
+ {
+ $this->debug = $level;
}
}