5 use PhpXmlRpc\Helper\Charset;
6 use PhpXmlRpc\Helper\Http;
7 use PhpXmlRpc\Helper\Logger;
8 use PhpXmlRpc\Helper\XMLParser;
12 /// @todo: do these need to be public?
15 public $params = array();
17 public $content_type = 'text/xml';
19 // holds data while parsing the response. NB: Not a full Response object
20 protected $httpResponse = array();
23 * @param string $methodName the name of the method to invoke
24 * @param Value[] $params array of parameters to be passed to the method (Value objects)
26 public function __construct($methodName, $params = array())
28 $this->methodname = $methodName;
29 foreach ($params as $param) {
30 $this->addParam($param);
34 public function xml_header($charsetEncoding = '')
36 if ($charsetEncoding != '') {
37 return "<?xml version=\"1.0\" encoding=\"$charsetEncoding\" ?" . ">\n<methodCall>\n";
39 return "<?xml version=\"1.0\"?" . ">\n<methodCall>\n";
43 public function xml_footer()
45 return '</methodCall>';
48 public function createPayload($charsetEncoding = '')
50 if ($charsetEncoding != '') {
51 $this->content_type = 'text/xml; charset=' . $charsetEncoding;
53 $this->content_type = 'text/xml';
55 $this->payload = $this->xml_header($charsetEncoding);
56 $this->payload .= '<methodName>' . Charset::instance()->encodeEntities($this->methodname, PhpXmlRpc::$xmlrpc_internalencoding, $charsetEncoding) . "</methodName>\n";
57 $this->payload .= "<params>\n";
58 foreach ($this->params as $p) {
59 $this->payload .= "<param>\n" . $p->serialize($charsetEncoding) .
62 $this->payload .= "</params>\n";
63 $this->payload .= $this->xml_footer();
67 * Gets/sets the xmlrpc method to be invoked.
69 * @param string $methodName the method to be set (leave empty not to set it)
71 * @return string the method that will be invoked
73 public function method($methodName = '')
75 if ($methodName != '') {
76 $this->methodname = $methodName;
79 return $this->methodname;
83 * Returns xml representation of the message. XML prologue included.
85 * @param string $charsetEncoding
87 * @return string the xml representation of the message, xml prologue included
89 public function serialize($charsetEncoding = '')
91 $this->createPayload($charsetEncoding);
93 return $this->payload;
97 * Add a parameter to the list of parameters to be used upon method invocation.
101 * @return boolean false on failure
103 public function addParam($param)
105 // add check: do not add to self params which are not xmlrpc values
106 if (is_object($param) && is_a($param, 'PhpXmlRpc\Value')) {
107 $this->params[] = $param;
116 * Returns the nth parameter in the request. The index zero-based.
118 * @param integer $i the index of the parameter to fetch (zero based)
120 * @return Value the i-th parameter
122 public function getParam($i)
124 return $this->params[$i];
128 * Returns the number of parameters in the message.
130 * @return integer the number of parameters currently set
132 public function getNumParams()
134 return count($this->params);
138 * Given an open file handle, read all data available and parse it as an xmlrpc response.
139 * NB: the file handle is not closed by this function.
140 * NNB: might have trouble in rare cases to work on network streams, as we
141 * check for a read of 0 bytes instead of feof($fp).
142 * But since checking for feof(null) returns false, we would risk an
143 * infinite loop in that case, because we cannot trust the caller
144 * to give us a valid pointer to an open file...
146 * @param resource $fp stream pointer
150 * @todo add 2nd & 3rd param to be passed to ParseResponse() ???
152 public function parseResponseFile($fp)
155 while ($data = fread($fp, 32768)) {
158 return $this->parseResponse($ipd);
162 * Parse the xmlrpc response contained in the string $data and return a Response object.
164 * @param string $data the xmlrpc response, eventually including http headers
165 * @param bool $headersProcessed when true prevents parsing HTTP headers for interpretation of content-encoding and consequent decoding
166 * @param string $returnType decides return type, i.e. content of response->value(). Either 'xmlrpcvals', 'xml' or 'phpvals'
170 public function parseResponse($data = '', $headersProcessed = false, $returnType = 'xmlrpcvals')
173 Logger::instance()->debugMessage("---GOT---\n$data\n---END---");
176 $this->httpResponse = array('raw_data' => $data, 'headers' => array(), 'cookies' => array());
179 error_log('XML-RPC: ' . __METHOD__ . ': no response received from server.');
180 return new Response(0, PhpXmlRpc::$xmlrpcerr['no_data'], PhpXmlRpc::$xmlrpcstr['no_data']);
183 // parse the HTTP headers of the response, if present, and separate them from data
184 if (substr($data, 0, 4) == 'HTTP') {
185 $httpParser = new Http();
187 $this->httpResponse = $httpParser->parseResponseHeaders($data, $headersProcessed, $this->debug);
188 } catch(\Exception $e) {
189 $r = new Response(0, $e->getCode(), $e->getMessage());
190 // failed processing of HTTP response headers
191 // save into response obj the full payload received, for debugging
192 $r->raw_data = $data;
198 // be tolerant of extra whitespace in response body
201 /// @todo return an error msg if $data=='' ?
203 // be tolerant of junk after methodResponse (e.g. javascript ads automatically inserted by free hosts)
204 // idea from Luca Mariano <luca.mariano@email.it> originally in PEARified version of the lib
205 $pos = strrpos($data, '</methodResponse>');
206 if ($pos !== false) {
207 $data = substr($data, 0, $pos + 17);
210 // try to 'guestimate' the character encoding of the received response
211 $respEncoding = XMLParser::guessEncoding(@$this->httpResponse['headers']['content-type'], $data);
214 $start = strpos($data, '<!-- SERVER DEBUG INFO (BASE64 ENCODED):');
216 $start += strlen('<!-- SERVER DEBUG INFO (BASE64 ENCODED):');
217 $end = strpos($data, '-->', $start);
218 $comments = substr($data, $start, $end - $start);
219 Logger::instance()->debugMessage("---SERVER DEBUG INFO (DECODED) ---\n\t" .
220 str_replace("\n", "\n\t", base64_decode($comments)) . "\n---END---", $respEncoding);
224 // if user wants back raw xml, give it to him
225 if ($returnType == 'xml') {
226 $r = new Response($data, 0, '', 'xml');
227 $r->hdrs = $this->httpResponse['headers'];
228 $r->_cookies = $this->httpResponse['cookies'];
229 $r->raw_data = $this->httpResponse['raw_data'];
234 if ($respEncoding != '') {
236 // Since parsing will fail if charset is not specified in the xml prologue,
237 // the encoding is not UTF8 and there are non-ascii chars in the text, we try to work round that...
238 // The following code might be better for mb_string enabled installs, but
239 // makes the lib about 200% slower...
240 //if (!is_valid_charset($respEncoding, array('UTF-8')))
241 if (!in_array($respEncoding, array('UTF-8', 'US-ASCII')) && !XMLParser::hasEncoding($data)) {
242 if ($respEncoding == 'ISO-8859-1') {
243 $data = utf8_encode($data);
245 if (extension_loaded('mbstring')) {
246 $data = mb_convert_encoding($data, 'UTF-8', $respEncoding);
248 error_log('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of received response: ' . $respEncoding);
254 $parser = xml_parser_create();
255 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true);
256 // G. Giunta 2005/02/13: PHP internally uses ISO-8859-1, so we have to tell
257 // the xml parser to give us back data in the expected charset.
258 // What if internal encoding is not in one of the 3 allowed?
259 // we use the broadest one, ie. utf8
260 // This allows to send data which is native in various charset,
261 // by extending xmlrpc_encode_entities() and setting xmlrpc_internalencoding
262 if (!in_array(PhpXmlRpc::$xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) {
263 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');
265 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, PhpXmlRpc::$xmlrpc_internalencoding);
268 $xmlRpcParser = new XMLParser();
269 xml_set_object($parser, $xmlRpcParser);
271 if ($returnType == 'phpvals') {
272 xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast');
274 xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee');
277 xml_set_character_data_handler($parser, 'xmlrpc_cd');
278 xml_set_default_handler($parser, 'xmlrpc_dh');
280 // first error check: xml not well formed
281 if (!xml_parse($parser, $data, count($data))) {
282 // thanks to Peter Kocks <peter.kocks@baygate.com>
283 if ((xml_get_current_line_number($parser)) == 1) {
284 $errStr = 'XML error at line 1, check URL';
286 $errStr = sprintf('XML error: %s at line %d, column %d',
287 xml_error_string(xml_get_error_code($parser)),
288 xml_get_current_line_number($parser), xml_get_current_column_number($parser));
291 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['invalid_return'], PhpXmlRpc::$xmlrpcstr['invalid_return'] . ' (' . $errStr . ')');
292 xml_parser_free($parser);
296 $r->hdrs = $this->httpResponse['headers'];
297 $r->_cookies = $this->httpResponse['cookies'];
298 $r->raw_data = $this->httpResponse['raw_data'];
302 xml_parser_free($parser);
303 // second error check: xml well formed but not xml-rpc compliant
304 if ($xmlRpcParser->_xh['isf'] > 1) {
306 /// @todo echo something for user?
309 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['invalid_return'],
310 PhpXmlRpc::$xmlrpcstr['invalid_return'] . ' ' . $xmlRpcParser->_xh['isf_reason']);
312 // third error check: parsing of the response has somehow gone boink.
313 // NB: shall we omit this check, since we trust the parsing code?
314 elseif ($returnType == 'xmlrpcvals' && !is_object($xmlRpcParser->_xh['value'])) {
315 // something odd has happened
316 // and it's time to generate a client side error
317 // indicating something odd went on
318 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['invalid_return'],
319 PhpXmlRpc::$xmlrpcstr['invalid_return']);
321 if ($this->debug > 1) {
322 Logger::instance()->debugMessage(
323 "---PARSED---\n".var_export($xmlRpcParser->_xh['value'], true)."\n---END---"
327 // note that using =& will raise an error if $xmlRpcParser->_xh['st'] does not generate an object.
328 $v = &$xmlRpcParser->_xh['value'];
330 if ($xmlRpcParser->_xh['isf']) {
331 /// @todo we should test here if server sent an int and a string, and/or coerce them into such...
332 if ($returnType == 'xmlrpcvals') {
333 $errNo_v = $v->structmem('faultCode');
334 $errStr_v = $v->structmem('faultString');
335 $errNo = $errNo_v->scalarval();
336 $errStr = $errStr_v->scalarval();
338 $errNo = $v['faultCode'];
339 $errStr = $v['faultString'];
343 // FAULT returned, errno needs to reflect that
347 $r = new Response(0, $errNo, $errStr);
349 $r = new Response($v, 0, '', $returnType);
353 $r->hdrs = $this->httpResponse['headers'];
354 $r->_cookies = $this->httpResponse['cookies'];
355 $r->raw_data = $this->httpResponse['raw_data'];
361 * Kept the old name even if Request class was renamed, for compatibility.
365 public function kindOf()
371 * Enables/disables the echoing to screen of the xmlrpc responses received.
373 * @param integer $in values 0, 1, 2 are supported
375 public function setDebug($in)