5 use PhpXmlRpc\Helper\Http;
6 use PhpXmlRpc\Helper\XMLParser;
10 /// @todo: do these need to be public?
13 public $params = array();
15 public $content_type = 'text/xml';
17 // holds data while parsing the response. NB: Not a full Response object
18 protected $httpResponse = array();
21 * @param string $methodName the name of the method to invoke
22 * @param Value[] $params array of parameters to be passed to the method (Value objects)
24 public function __construct($methodName, $params = array())
26 $this->methodname = $methodName;
27 foreach ($params as $param) {
28 $this->addParam($param);
32 public function xml_header($charsetEncoding = '')
34 if ($charsetEncoding != '') {
35 return "<?xml version=\"1.0\" encoding=\"$charsetEncoding\" ?" . ">\n<methodCall>\n";
37 return "<?xml version=\"1.0\"?" . ">\n<methodCall>\n";
41 public function xml_footer()
43 return '</methodCall>';
46 public function createPayload($charsetEncoding = '')
48 if ($charsetEncoding != '') {
49 $this->content_type = 'text/xml; charset=' . $charsetEncoding;
51 $this->content_type = 'text/xml';
53 $this->payload = $this->xml_header($charsetEncoding);
54 $this->payload .= '<methodName>' . $this->methodname . "</methodName>\n";
55 $this->payload .= "<params>\n";
56 foreach ($this->params as $p) {
57 $this->payload .= "<param>\n" . $p->serialize($charsetEncoding) .
60 $this->payload .= "</params>\n";
61 $this->payload .= $this->xml_footer();
65 * Gets/sets the xmlrpc method to be invoked.
67 * @param string $methodName the method to be set (leave empty not to set it)
69 * @return string the method that will be invoked
71 public function method($methodName = '')
73 if ($methodName != '') {
74 $this->methodname = $methodName;
77 return $this->methodname;
81 * Returns xml representation of the message. XML prologue included.
83 * @param string $charsetEncoding
85 * @return string the xml representation of the message, xml prologue included
87 public function serialize($charsetEncoding = '')
89 $this->createPayload($charsetEncoding);
91 return $this->payload;
95 * Add a parameter to the list of parameters to be used upon method invocation.
99 * @return boolean false on failure
101 public function addParam($param)
103 // add check: do not add to self params which are not xmlrpc values
104 if (is_object($param) && is_a($param, 'PhpXmlRpc\Value')) {
105 $this->params[] = $param;
114 * Returns the nth parameter in the request. The index zero-based.
116 * @param integer $i the index of the parameter to fetch (zero based)
118 * @return Value the i-th parameter
120 public function getParam($i)
122 return $this->params[$i];
126 * Returns the number of parameters in the message.
128 * @return integer the number of parameters currently set
130 public function getNumParams()
132 return count($this->params);
136 * Given an open file handle, read all data available and parse it as an xmlrpc response.
137 * NB: the file handle is not closed by this function.
138 * NNB: might have trouble in rare cases to work on network streams, as we
139 * check for a read of 0 bytes instead of feof($fp).
140 * But since checking for feof(null) returns false, we would risk an
141 * infinite loop in that case, because we cannot trust the caller
142 * to give us a valid pointer to an open file...
144 * @param resource $fp stream pointer
148 * @todo add 2nd & 3rd param to be passed to ParseResponse() ???
150 public function parseResponseFile($fp)
153 while ($data = fread($fp, 32768)) {
156 return $this->parseResponse($ipd);
160 * Parse the xmlrpc response contained in the string $data and return a Response object.
162 * @param string $data the xmlrpc response, eventually including http headers
163 * @param bool $headersProcessed when true prevents parsing HTTP headers for interpretation of content-encoding and consequent decoding
164 * @param string $returnType decides return type, i.e. content of response->value(). Either 'xmlrpcvals', 'xml' or 'phpvals'
168 public function parseResponse($data = '', $headersProcessed = false, $returnType = 'xmlrpcvals')
171 // by maHo, replaced htmlspecialchars with htmlentities
172 $this->debugMessage("---GOT---\n$data\n---END---");
175 $this->httpResponse = array('raw_data' => $data, 'headers' => array(), 'cookies' => array());
178 error_log('XML-RPC: ' . __METHOD__ . ': no response received from server.');
179 return new Response(0, PhpXmlRpc::$xmlrpcerr['no_data'], PhpXmlRpc::$xmlrpcstr['no_data']);
182 // parse the HTTP headers of the response, if present, and separate them from data
183 if (substr($data, 0, 4) == 'HTTP') {
184 $httpParser = new Http();
186 $this->httpResponse = $httpParser->parseResponseHeaders($data, $headersProcessed, $this->debug);
187 } catch(\Exception $e) {
188 $r = new Response(0, $e->getCode(), $e->getMessage());
189 // failed processing of HTTP response headers
190 // save into response obj the full payload received, for debugging
191 $r->raw_data = $data;
198 $start = strpos($data, '<!-- SERVER DEBUG INFO (BASE64 ENCODED):');
200 $start += strlen('<!-- SERVER DEBUG INFO (BASE64 ENCODED):');
201 $end = strpos($data, '-->', $start);
202 $comments = substr($data, $start, $end - $start);
203 $this->debugMessage("---SERVER DEBUG INFO (DECODED) ---\n\t" . str_replace("\n", "\n\t", base64_decode($comments))) . "\n---END---\n</PRE>";
207 // be tolerant of extra whitespace in response body
210 /// @todo return an error msg if $data=='' ?
212 // be tolerant of junk after methodResponse (e.g. javascript ads automatically inserted by free hosts)
213 // idea from Luca Mariano <luca.mariano@email.it> originally in PEARified version of the lib
214 $pos = strrpos($data, '</methodResponse>');
215 if ($pos !== false) {
216 $data = substr($data, 0, $pos + 17);
219 // if user wants back raw xml, give it to him
220 if ($returnType == 'xml') {
221 $r = new Response($data, 0, '', 'xml');
222 $r->hdrs = $this->httpResponse['headers'];
223 $r->_cookies = $this->httpResponse['cookies'];
224 $r->raw_data = $this->httpResponse['raw_data'];
229 // try to 'guestimate' the character encoding of the received response
230 $respEncoding = XMLParser::guessEncoding(@$this->httpResponse['headers']['content-type'], $data);
232 if ($respEncoding != '') {
234 // Since parsing will fail if charset is not specified in the xml prologue,
235 // the encoding is not UTF8 and there are non-ascii chars in the text, we try to work round that...
236 // The following code might be better for mb_string enabled installs, but
237 // makes the lib about 200% slower...
238 //if (!is_valid_charset($respEncoding, array('UTF-8')))
239 if (!in_array($respEncoding, array('UTF-8', 'US-ASCII')) && !XMLParser::hasEncoding($data)) {
240 if ($respEncoding == 'ISO-8859-1') {
241 $data = utf8_encode($data);
243 if (extension_loaded('mbstring')) {
244 $data = mb_convert_encoding($data, 'UTF-8', $respEncoding);
246 error_log('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of received response: ' . $respEncoding);
252 $parser = xml_parser_create();
253 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true);
254 // G. Giunta 2005/02/13: PHP internally uses ISO-8859-1, so we have to tell
255 // the xml parser to give us back data in the expected charset.
256 // What if internal encoding is not in one of the 3 allowed?
257 // we use the broadest one, ie. utf8
258 // This allows to send data which is native in various charset,
259 // by extending xmlrpc_encode_entities() and setting xmlrpc_internalencoding
260 if (!in_array(PhpXmlRpc::$xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) {
261 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');
263 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, PhpXmlRpc::$xmlrpc_internalencoding);
266 $xmlRpcParser = new XMLParser();
267 xml_set_object($parser, $xmlRpcParser);
269 if ($returnType == 'phpvals') {
270 xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast');
272 xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee');
275 xml_set_character_data_handler($parser, 'xmlrpc_cd');
276 xml_set_default_handler($parser, 'xmlrpc_dh');
278 // first error check: xml not well formed
279 if (!xml_parse($parser, $data, count($data))) {
280 // thanks to Peter Kocks <peter.kocks@baygate.com>
281 if ((xml_get_current_line_number($parser)) == 1) {
282 $errStr = 'XML error at line 1, check URL';
284 $errStr = sprintf('XML error: %s at line %d, column %d',
285 xml_error_string(xml_get_error_code($parser)),
286 xml_get_current_line_number($parser), xml_get_current_column_number($parser));
289 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['invalid_return'], PhpXmlRpc::$xmlrpcstr['invalid_return'] . ' (' . $errStr . ')');
290 xml_parser_free($parser);
294 $r->hdrs = $this->httpResponse['headers'];
295 $r->_cookies = $this->httpResponse['cookies'];
296 $r->raw_data = $this->httpResponse['raw_data'];
300 xml_parser_free($parser);
301 // second error check: xml well formed but not xml-rpc compliant
302 if ($xmlRpcParser->_xh['isf'] > 1) {
304 /// @todo echo something for user?
307 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['invalid_return'],
308 PhpXmlRpc::$xmlrpcstr['invalid_return'] . ' ' . $xmlRpcParser->_xh['isf_reason']);
310 // third error check: parsing of the response has somehow gone boink.
311 // NB: shall we omit this check, since we trust the parsing code?
312 elseif ($returnType == 'xmlrpcvals' && !is_object($xmlRpcParser->_xh['value'])) {
313 // something odd has happened
314 // and it's time to generate a client side error
315 // indicating something odd went on
316 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['invalid_return'],
317 PhpXmlRpc::$xmlrpcstr['invalid_return']);
321 "---PARSED---\n".var_export($xmlRpcParser->_xh['value'], true)."\n---END---", false
325 // note that using =& will raise an error if $xmlRpcParser->_xh['st'] does not generate an object.
326 $v = &$xmlRpcParser->_xh['value'];
328 if ($xmlRpcParser->_xh['isf']) {
329 /// @todo we should test here if server sent an int and a string,
330 /// and/or coerce them into such...
331 if ($returnType == 'xmlrpcvals') {
332 $errNo_v = $v->structmem('faultCode');
333 $errStr_v = $v->structmem('faultString');
334 $errNo = $errNo_v->scalarval();
335 $errStr = $errStr_v->scalarval();
337 $errNo = $v['faultCode'];
338 $errStr = $v['faultString'];
342 // FAULT returned, errno needs to reflect that
346 $r = new Response(0, $errNo, $errStr);
348 $r = new Response($v, 0, '', $returnType);
352 $r->hdrs = $this->httpResponse['headers'];
353 $r->_cookies = $this->httpResponse['cookies'];
354 $r->raw_data = $this->httpResponse['raw_data'];
360 * Echoes a debug message, taking care of escaping it when not in console mode
362 * @param string $message
363 * @param bool $encodeEntities when false, escapes using htmlspecialchars instead of htmlentities
365 protected function debugMessage($message, $encodeEntities = true)
367 if (PHP_SAPI != 'cli') {
369 print "<PRE>\n".htmlentities($message)."\n</PRE>";
371 print "<PRE>\n".htmlspecialchars($message)."\n</PRE>";
373 print "\n$message\n";