2 // by Edd Dumbill (C) 1999-2002
\r
3 // <edd@usefulinc.com>
\r
4 // $Original: xmlrpc.inc,v 1.158 2007/03/01 21:21:02 ggiunta Exp $
\r
5 // $Id: xmlrpc.inc.php 1624 2012-01-09 11:36:20Z sakamocchi $
\r
8 // Copyright (c) 1999,2000,2002 Edd Dumbill.
\r
9 // All rights reserved.
\r
11 // Redistribution and use in source and binary forms, with or without
\r
12 // modification, are permitted provided that the following conditions
\r
15 // * Redistributions of source code must retain the above copyright
\r
16 // notice, this list of conditions and the following disclaimer.
\r
18 // * Redistributions in binary form must reproduce the above
\r
19 // copyright notice, this list of conditions and the following
\r
20 // disclaimer in the documentation and/or other materials provided
\r
21 // with the distribution.
\r
23 // * Neither the name of the "XML-RPC for PHP" nor the names of its
\r
24 // contributors may be used to endorse or promote products derived
\r
25 // from this software without specific prior written permission.
\r
27 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
\r
28 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
\r
29 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
\r
30 // FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
\r
31 // REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
\r
32 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
\r
33 // (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
\r
34 // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
\r
35 // HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
\r
36 // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
\r
37 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
\r
38 // OF THE POSSIBILITY OF SUCH DAMAGE.
\r
40 if(!function_exists('xml_parser_create'))
\r
42 // For PHP 4 onward, XML functionality is always compiled-in on windows:
\r
43 // no more need to dl-open it. It might have been compiled out on *nix...
\r
44 //if(strtoupper(substr(PHP_OS, 0, 3) != 'WIN'))
\r
45 $phpver = phpversion();
\r
46 if (!extension_loaded('xml') && version_compare($phpver,'5.3.0','<'))
\r
52 // Try to be backward compat with php < 4.2 (are we not being nice ?)
\r
53 $phpversion = phpversion();
\r
54 if($phpversion[0] == '4' && $phpversion[2] < 2)
\r
56 // give an opportunity to user to specify where to include other files from
\r
57 if(!defined('PHP_XMLRPC_COMPAT_DIR'))
\r
59 define('PHP_XMLRPC_COMPAT_DIR',dirname(__FILE__).'/compat/');
\r
61 if($phpversion[2] == '0')
\r
63 if($phpversion[4] < 6)
\r
65 include(PHP_XMLRPC_COMPAT_DIR.'is_callable.php');
\r
67 include(PHP_XMLRPC_COMPAT_DIR.'is_scalar.php');
\r
68 include(PHP_XMLRPC_COMPAT_DIR.'array_key_exists.php');
\r
69 include(PHP_XMLRPC_COMPAT_DIR.'version_compare.php');
\r
71 include(PHP_XMLRPC_COMPAT_DIR.'var_export.php');
\r
72 include(PHP_XMLRPC_COMPAT_DIR.'is_a.php');
\r
75 // G. Giunta 2005/01/29: declare global these variables,
\r
76 // so that xmlrpc.inc will work even if included from within a function
\r
77 // Milosch: 2005/08/07 - explicitly request these via $GLOBALS where used.
\r
78 $GLOBALS['xmlrpcI4']='i4';
\r
79 $GLOBALS['xmlrpcInt']='int';
\r
80 $GLOBALS['xmlrpcBoolean']='boolean';
\r
81 $GLOBALS['xmlrpcDouble']='double';
\r
82 $GLOBALS['xmlrpcString']='string';
\r
83 $GLOBALS['xmlrpcDateTime']='dateTime.iso8601';
\r
84 $GLOBALS['xmlrpcBase64']='base64';
\r
85 $GLOBALS['xmlrpcArray']='array';
\r
86 $GLOBALS['xmlrpcStruct']='struct';
\r
87 $GLOBALS['xmlrpcValue']='undefined';
\r
89 $GLOBALS['xmlrpcTypes']=array(
\r
90 $GLOBALS['xmlrpcI4'] => 1,
\r
91 $GLOBALS['xmlrpcInt'] => 1,
\r
92 $GLOBALS['xmlrpcBoolean'] => 1,
\r
93 $GLOBALS['xmlrpcString'] => 1,
\r
94 $GLOBALS['xmlrpcDouble'] => 1,
\r
95 $GLOBALS['xmlrpcDateTime'] => 1,
\r
96 $GLOBALS['xmlrpcBase64'] => 1,
\r
97 $GLOBALS['xmlrpcArray'] => 2,
\r
98 $GLOBALS['xmlrpcStruct'] => 3
\r
101 $GLOBALS['xmlrpc_valid_parents'] = array(
\r
102 'VALUE' => array('MEMBER', 'DATA', 'PARAM', 'FAULT'),
\r
103 'BOOLEAN' => array('VALUE'),
\r
104 'I4' => array('VALUE'),
\r
105 'INT' => array('VALUE'),
\r
106 'STRING' => array('VALUE'),
\r
107 'DOUBLE' => array('VALUE'),
\r
108 'DATETIME.ISO8601' => array('VALUE'),
\r
109 'BASE64' => array('VALUE'),
\r
110 'MEMBER' => array('STRUCT'),
\r
111 'NAME' => array('MEMBER'),
\r
112 'DATA' => array('ARRAY'),
\r
113 'ARRAY' => array('VALUE'),
\r
114 'STRUCT' => array('VALUE'),
\r
115 'PARAM' => array('PARAMS'),
\r
116 'METHODNAME' => array('METHODCALL'),
\r
117 'PARAMS' => array('METHODCALL', 'METHODRESPONSE'),
\r
118 'FAULT' => array('METHODRESPONSE'),
\r
119 'NIL' => array('VALUE') // only used when extension activated
\r
122 // define extra types for supporting NULL (useful for json or <NIL/>)
\r
123 $GLOBALS['xmlrpcNull']='null';
\r
124 $GLOBALS['xmlrpcTypes']['null']=1;
\r
126 // Not in use anymore since 2.0. Shall we remove it?
\r
128 $GLOBALS['xmlEntities']=array(
\r
136 // tables used for transcoding different charsets into us-ascii xml
\r
138 $GLOBALS['xml_iso88591_Entities']=array();
\r
139 $GLOBALS['xml_iso88591_Entities']['in'] = array();
\r
140 $GLOBALS['xml_iso88591_Entities']['out'] = array();
\r
141 for ($i = 0; $i < 32; $i++)
\r
143 $GLOBALS['xml_iso88591_Entities']['in'][] = chr($i);
\r
144 $GLOBALS['xml_iso88591_Entities']['out'][] = '&#'.$i.';';
\r
146 for ($i = 160; $i < 256; $i++)
\r
148 $GLOBALS['xml_iso88591_Entities']['in'][] = chr($i);
\r
149 $GLOBALS['xml_iso88591_Entities']['out'][] = '&#'.$i.';';
\r
152 /// @todo add to iso table the characters from cp_1252 range, i.e. 128 to 159.
\r
153 /// These will NOT be present in true ISO-8859-1, but will save the unwary
\r
154 /// windows user from sending junk.
\r
156 $cp1252_to_xmlent =
\r
158 '\x80'=>'€', '\x81'=>'?', '\x82'=>'‚', '\x83'=>'ƒ',
\r
159 '\x84'=>'„', '\x85'=>'…', '\x86'=>'†', \x87'=>'‡',
\r
160 '\x88'=>'ˆ', '\x89'=>'‰', '\x8A'=>'Š', '\x8B'=>'‹',
\r
161 '\x8C'=>'Œ', '\x8D'=>'?', '\x8E'=>'Ž', '\x8F'=>'?',
\r
162 '\x90'=>'?', '\x91'=>'‘', '\x92'=>'’', '\x93'=>'“',
\r
163 '\x94'=>'”', '\x95'=>'•', '\x96'=>'–', '\x97'=>'—',
\r
164 '\x98'=>'˜', '\x99'=>'™', '\x9A'=>'š', '\x9B'=>'›',
\r
165 '\x9C'=>'œ', '\x9D'=>'?', '\x9E'=>'ž', '\x9F'=>'Ÿ'
\r
169 $GLOBALS['xmlrpcerr']['unknown_method']=1;
\r
170 $GLOBALS['xmlrpcstr']['unknown_method']='Unknown method';
\r
171 $GLOBALS['xmlrpcerr']['invalid_return']=2;
\r
172 $GLOBALS['xmlrpcstr']['invalid_return']='Invalid return payload: enable debugging to examine incoming payload';
\r
173 $GLOBALS['xmlrpcerr']['incorrect_params']=3;
\r
174 $GLOBALS['xmlrpcstr']['incorrect_params']='Incorrect parameters passed to method';
\r
175 $GLOBALS['xmlrpcerr']['introspect_unknown']=4;
\r
176 $GLOBALS['xmlrpcstr']['introspect_unknown']="Can't introspect: method unknown";
\r
177 $GLOBALS['xmlrpcerr']['http_error']=5;
\r
178 $GLOBALS['xmlrpcstr']['http_error']="Didn't receive 200 OK from remote server.";
\r
179 $GLOBALS['xmlrpcerr']['no_data']=6;
\r
180 $GLOBALS['xmlrpcstr']['no_data']='No data received from server.';
\r
181 $GLOBALS['xmlrpcerr']['no_ssl']=7;
\r
182 $GLOBALS['xmlrpcstr']['no_ssl']='No SSL support compiled in.';
\r
183 $GLOBALS['xmlrpcerr']['curl_fail']=8;
\r
184 $GLOBALS['xmlrpcstr']['curl_fail']='CURL error';
\r
185 $GLOBALS['xmlrpcerr']['invalid_request']=15;
\r
186 $GLOBALS['xmlrpcstr']['invalid_request']='Invalid request payload';
\r
187 $GLOBALS['xmlrpcerr']['no_curl']=16;
\r
188 $GLOBALS['xmlrpcstr']['no_curl']='No CURL support compiled in.';
\r
189 $GLOBALS['xmlrpcerr']['server_error']=17;
\r
190 $GLOBALS['xmlrpcstr']['server_error']='Internal server error';
\r
191 $GLOBALS['xmlrpcerr']['multicall_error']=18;
\r
192 $GLOBALS['xmlrpcstr']['multicall_error']='Received from server invalid multicall response';
\r
194 $GLOBALS['xmlrpcerr']['multicall_notstruct'] = 9;
\r
195 $GLOBALS['xmlrpcstr']['multicall_notstruct'] = 'system.multicall expected struct';
\r
196 $GLOBALS['xmlrpcerr']['multicall_nomethod'] = 10;
\r
197 $GLOBALS['xmlrpcstr']['multicall_nomethod'] = 'missing methodName';
\r
198 $GLOBALS['xmlrpcerr']['multicall_notstring'] = 11;
\r
199 $GLOBALS['xmlrpcstr']['multicall_notstring'] = 'methodName is not a string';
\r
200 $GLOBALS['xmlrpcerr']['multicall_recursion'] = 12;
\r
201 $GLOBALS['xmlrpcstr']['multicall_recursion'] = 'recursive system.multicall forbidden';
\r
202 $GLOBALS['xmlrpcerr']['multicall_noparams'] = 13;
\r
203 $GLOBALS['xmlrpcstr']['multicall_noparams'] = 'missing params';
\r
204 $GLOBALS['xmlrpcerr']['multicall_notarray'] = 14;
\r
205 $GLOBALS['xmlrpcstr']['multicall_notarray'] = 'params is not an array';
\r
207 $GLOBALS['xmlrpcerr']['cannot_decompress']=103;
\r
208 $GLOBALS['xmlrpcstr']['cannot_decompress']='Received from server compressed HTTP and cannot decompress';
\r
209 $GLOBALS['xmlrpcerr']['decompress_fail']=104;
\r
210 $GLOBALS['xmlrpcstr']['decompress_fail']='Received from server invalid compressed HTTP';
\r
211 $GLOBALS['xmlrpcerr']['dechunk_fail']=105;
\r
212 $GLOBALS['xmlrpcstr']['dechunk_fail']='Received from server invalid chunked HTTP';
\r
213 $GLOBALS['xmlrpcerr']['server_cannot_decompress']=106;
\r
214 $GLOBALS['xmlrpcstr']['server_cannot_decompress']='Received from client compressed HTTP request and cannot decompress';
\r
215 $GLOBALS['xmlrpcerr']['server_decompress_fail']=107;
\r
216 $GLOBALS['xmlrpcstr']['server_decompress_fail']='Received from client invalid compressed HTTP request';
\r
218 // The charset encoding used by the server for received messages and
\r
219 // by the client for received responses when received charset cannot be determined
\r
220 // or is not supported
\r
221 $GLOBALS['xmlrpc_defencoding']='UTF-8';
\r
223 // The encoding used internally by PHP.
\r
224 // String values received as xml will be converted to this, and php strings will be converted to xml
\r
225 // as if having been coded with this
\r
226 $GLOBALS['xmlrpc_internalencoding']='ISO-8859-1';
\r
228 $GLOBALS['xmlrpcName']='XML-RPC for PHP';
\r
229 $GLOBALS['xmlrpcVersion']='2.2';
\r
231 // let user errors start at 800
\r
232 $GLOBALS['xmlrpcerruser']=800;
\r
233 // let XML parse errors start at 100
\r
234 $GLOBALS['xmlrpcerrxml']=100;
\r
236 // formulate backslashes for escaping regexp
\r
237 // Not in use anymore since 2.0. Shall we remove it?
\r
239 $GLOBALS['xmlrpc_backslash']=chr(92).chr(92);
\r
241 // set to TRUE to enable correct decoding of <NIL/> values
\r
242 $GLOBALS['xmlrpc_null_extension']=false;
\r
244 // used to store state during parsing
\r
245 // quick explanation of components:
\r
246 // ac - used to accumulate values
\r
247 // isf - used to indicate a parsing fault (2) or xmlrpcresp fault (1)
\r
248 // isf_reason - used for storing xmlrpcresp fault string
\r
249 // lv - used to indicate "looking for a value": implements
\r
250 // the logic to allow values with no types to be strings
\r
251 // params - used to store parameters in method calls
\r
252 // method - used to store method name
\r
253 // stack - array with genealogy of xml elements names:
\r
254 // used to validate nesting of xmlrpc elements
\r
255 $GLOBALS['_xh']=null;
\r
258 * Convert a string to the correct XML representation in a target charset
\r
259 * To help correct communication of non-ascii chars inside strings, regardless
\r
260 * of the charset used when sending requests, parsing them, sending responses
\r
261 * and parsing responses, an option is to convert all non-ascii chars present in the message
\r
262 * into their equivalent 'charset entity'. Charset entities enumerated this way
\r
263 * are independent of the charset encoding used to transmit them, and all XML
\r
264 * parsers are bound to understand them.
\r
265 * Note that in the std case we are not sending a charset encoding mime type
\r
266 * along with http headers, so we are bound by RFC 3023 to emit strict us-ascii.
\r
268 * @todo do a bit of basic benchmarking (strtr vs. str_replace)
\r
269 * @todo make usage of iconv() or recode_string() or mb_string() where available
\r
271 function xmlrpc_encode_entitites($data, $src_encoding='', $dest_encoding='')
\r
273 if ($src_encoding == '')
\r
275 // lame, but we know no better...
\r
276 $src_encoding = $GLOBALS['xmlrpc_internalencoding'];
\r
279 switch(strtoupper($src_encoding.'_'.$dest_encoding))
\r
281 case 'ISO-8859-1_':
\r
282 case 'ISO-8859-1_US-ASCII':
\r
283 $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
\r
284 $escaped_data = str_replace($GLOBALS['xml_iso88591_Entities']['in'], $GLOBALS['xml_iso88591_Entities']['out'], $escaped_data);
\r
286 case 'ISO-8859-1_UTF-8':
\r
287 $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
\r
288 $escaped_data = utf8_encode($escaped_data);
\r
290 case 'ISO-8859-1_ISO-8859-1':
\r
291 case 'US-ASCII_US-ASCII':
\r
292 case 'US-ASCII_UTF-8':
\r
294 case 'US-ASCII_ISO-8859-1':
\r
295 case 'UTF-8_UTF-8':
\r
296 $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
\r
299 case 'UTF-8_US-ASCII':
\r
300 case 'UTF-8_ISO-8859-1':
\r
301 // NB: this will choke on invalid UTF-8, going most likely beyond EOF
\r
302 $escaped_data = '';
\r
303 // be kind to users creating string xmlrpcvals out of different php types
\r
304 $data = (string) $data;
\r
305 $ns = i18n::strlen ($data);
\r
306 for ($nn = 0; $nn < $ns; $nn++)
\r
310 //1 7 0bbbbbbb (127)
\r
313 /// @todo shall we replace this with a (supposedly) faster str_replace?
\r
316 $escaped_data .= '"';
\r
319 $escaped_data .= '&';
\r
322 $escaped_data .= ''';
\r
325 $escaped_data .= '<';
\r
328 $escaped_data .= '>';
\r
331 $escaped_data .= $ch;
\r
334 //2 11 110bbbbb 10bbbbbb (2047)
\r
335 else if ($ii>>5 == 6)
\r
338 $ii = ord($data[$nn+1]);
\r
340 $ii = ($b1 * 64) + $b2;
\r
341 $ent = sprintf ('&#%d;', $ii);
\r
342 $escaped_data .= $ent;
\r
345 //3 16 1110bbbb 10bbbbbb 10bbbbbb
\r
346 else if ($ii>>4 == 14)
\r
349 $ii = ord($data[$nn+1]);
\r
351 $ii = ord($data[$nn+2]);
\r
353 $ii = ((($b1 * 64) + $b2) * 64) + $b3;
\r
354 $ent = sprintf ('&#%d;', $ii);
\r
355 $escaped_data .= $ent;
\r
358 //4 21 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb
\r
359 else if ($ii>>3 == 30)
\r
362 $ii = ord($data[$nn+1]);
\r
364 $ii = ord($data[$nn+2]);
\r
366 $ii = ord($data[$nn+3]);
\r
368 $ii = ((((($b1 * 64) + $b2) * 64) + $b3) * 64) + $b4;
\r
369 $ent = sprintf ('&#%d;', $ii);
\r
370 $escaped_data .= $ent;
\r
376 $escaped_data = '';
\r
377 error_log("Converting from $src_encoding to $dest_encoding: not supported...");
\r
379 return $escaped_data;
\r
382 /// xml parser handler function for opening element tags
\r
383 function xmlrpc_se($parser, $name, $attrs, $accept_single_vals=false)
\r
385 // if invalid xmlrpc already detected, skip all processing
\r
386 if ($GLOBALS['_xh']['isf'] < 2)
\r
388 // check for correct element nesting
\r
389 // top level element can only be of 2 types
\r
390 /// @todo optimization creep: save this check into a bool variable, instead of using count() every time:
\r
391 /// there is only a single top level element in xml anyway
\r
392 if (count($GLOBALS['_xh']['stack']) == 0)
\r
394 if ($name != 'METHODRESPONSE' && $name != 'METHODCALL' && (
\r
395 $name != 'VALUE' && !$accept_single_vals))
\r
397 $GLOBALS['_xh']['isf'] = 2;
\r
398 $GLOBALS['_xh']['isf_reason'] = 'missing top level xmlrpc element';
\r
403 $GLOBALS['_xh']['rt'] = strtolower($name);
\r
408 // not top level element: see if parent is OK
\r
409 $parent = end($GLOBALS['_xh']['stack']);
\r
410 if (!array_key_exists($name, $GLOBALS['xmlrpc_valid_parents']) || !in_array($parent, $GLOBALS['xmlrpc_valid_parents'][$name]))
\r
412 $GLOBALS['_xh']['isf'] = 2;
\r
413 $GLOBALS['_xh']['isf_reason'] = "xmlrpc element $name cannot be child of $parent";
\r
420 // optimize for speed switch cases: most common cases first
\r
422 /// @todo we could check for 2 VALUE elements inside a MEMBER or PARAM element
\r
423 $GLOBALS['_xh']['vt']='value'; // indicator: no value found yet
\r
424 $GLOBALS['_xh']['ac']='';
\r
425 $GLOBALS['_xh']['lv']=1;
\r
426 $GLOBALS['_xh']['php_class']=null;
\r
433 case 'DATETIME.ISO8601':
\r
435 if ($GLOBALS['_xh']['vt']!='value')
\r
437 //two data elements inside a value: an error occurred!
\r
438 $GLOBALS['_xh']['isf'] = 2;
\r
439 $GLOBALS['_xh']['isf_reason'] = "$name element following a {$GLOBALS['_xh']['vt']} element inside a single value";
\r
442 $GLOBALS['_xh']['ac']=''; // reset the accumulator
\r
446 if ($GLOBALS['_xh']['vt']!='value')
\r
448 //two data elements inside a value: an error occurred!
\r
449 $GLOBALS['_xh']['isf'] = 2;
\r
450 $GLOBALS['_xh']['isf_reason'] = "$name element following a {$GLOBALS['_xh']['vt']} element inside a single value";
\r
453 // create an empty array to hold child values, and push it onto appropriate stack
\r
454 $cur_val = array();
\r
455 $cur_val['values'] = array();
\r
456 $cur_val['type'] = $name;
\r
457 // check for out-of-band information to rebuild php objs
\r
458 // and in case it is found, save it
\r
459 if (@isset($attrs['PHP_CLASS']))
\r
461 $cur_val['php_class'] = $attrs['PHP_CLASS'];
\r
463 $GLOBALS['_xh']['valuestack'][] = $cur_val;
\r
464 $GLOBALS['_xh']['vt']='data'; // be prepared for a data element next
\r
467 if ($GLOBALS['_xh']['vt']!='data')
\r
469 //two data elements inside a value: an error occurred!
\r
470 $GLOBALS['_xh']['isf'] = 2;
\r
471 $GLOBALS['_xh']['isf_reason'] = "found two data elements inside an array element";
\r
475 case 'METHODRESPONSE':
\r
477 // valid elements that add little to processing
\r
481 /// @todo we could check for 2 NAME elements inside a MEMBER element
\r
482 $GLOBALS['_xh']['ac']='';
\r
485 $GLOBALS['_xh']['isf']=1;
\r
488 $GLOBALS['_xh']['valuestack'][count($GLOBALS['_xh']['valuestack'])-1]['name']=''; // set member name to null, in case we do not find in the xml later on
\r
489 //$GLOBALS['_xh']['ac']='';
\r
490 // Drop trough intentionally
\r
492 // clear value type, so we can check later if no value has been passed for this param/member
\r
493 $GLOBALS['_xh']['vt']=null;
\r
496 if ($GLOBALS['xmlrpc_null_extension'])
\r
498 if ($GLOBALS['_xh']['vt']!='value')
\r
500 //two data elements inside a value: an error occurred!
\r
501 $GLOBALS['_xh']['isf'] = 2;
\r
502 $GLOBALS['_xh']['isf_reason'] = "$name element following a {$GLOBALS['_xh']['vt']} element inside a single value";
\r
505 $GLOBALS['_xh']['ac']=''; // reset the accumulator
\r
508 // we do not support the <NIL/> extension, so
\r
509 // drop through intentionally
\r
511 /// INVALID ELEMENT: RAISE ISF so that it is later recognized!!!
\r
512 $GLOBALS['_xh']['isf'] = 2;
\r
513 $GLOBALS['_xh']['isf_reason'] = "found not-xmlrpc xml element $name";
\r
517 // Save current element name to stack, to validate nesting
\r
518 $GLOBALS['_xh']['stack'][] = $name;
\r
520 /// @todo optimization creep: move this inside the big switch() above
\r
523 $GLOBALS['_xh']['lv']=0;
\r
528 /// Used in decoding xml chunks that might represent single xmlrpc values
\r
529 function xmlrpc_se_any($parser, $name, $attrs)
\r
531 xmlrpc_se($parser, $name, $attrs, true);
\r
534 /// xml parser handler function for close element tags
\r
535 function xmlrpc_ee($parser, $name, $rebuild_xmlrpcvals = true)
\r
537 if ($GLOBALS['_xh']['isf'] < 2)
\r
539 // push this element name from stack
\r
540 // NB: if XML validates, correct opening/closing is guaranteed and
\r
541 // we do not have to check for $name == $curr_elem.
\r
542 // we also checked for proper nesting at start of elements...
\r
543 $curr_elem = array_pop($GLOBALS['_xh']['stack']);
\r
548 // This if() detects if no scalar was inside <VALUE></VALUE>
\r
549 if ($GLOBALS['_xh']['vt']=='value')
\r
551 $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac'];
\r
552 $GLOBALS['_xh']['vt']=$GLOBALS['xmlrpcString'];
\r
555 if ($rebuild_xmlrpcvals)
\r
557 // build the xmlrpc val out of the data received, and substitute it
\r
558 $temp = new xmlrpcval($GLOBALS['_xh']['value'], $GLOBALS['_xh']['vt']);
\r
559 // in case we got info about underlying php class, save it
\r
560 // in the object we're rebuilding
\r
561 if (isset($GLOBALS['_xh']['php_class']))
\r
562 $temp->_php_class = $GLOBALS['_xh']['php_class'];
\r
563 // check if we are inside an array or struct:
\r
564 // if value just built is inside an array, let's move it into array on the stack
\r
565 $vscount = count($GLOBALS['_xh']['valuestack']);
\r
566 if ($vscount && $GLOBALS['_xh']['valuestack'][$vscount-1]['type']=='ARRAY')
\r
568 $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][] = $temp;
\r
572 $GLOBALS['_xh']['value'] = $temp;
\r
577 /// @todo this needs to treat correctly php-serialized objects,
\r
578 /// since std deserializing is done by php_xmlrpc_decode,
\r
579 /// which we will not be calling...
\r
580 if (isset($GLOBALS['_xh']['php_class']))
\r
584 // check if we are inside an array or struct:
\r
585 // if value just built is inside an array, let's move it into array on the stack
\r
586 $vscount = count($GLOBALS['_xh']['valuestack']);
\r
587 if ($vscount && $GLOBALS['_xh']['valuestack'][$vscount-1]['type']=='ARRAY')
\r
589 $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][] = $GLOBALS['_xh']['value'];
\r
598 case 'DATETIME.ISO8601':
\r
600 $GLOBALS['_xh']['vt']=strtolower($name);
\r
601 /// @todo: optimization creep - remove the if/elseif cycle below
\r
602 /// since the case() in which we are already did that
\r
603 if ($name=='STRING')
\r
605 $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac'];
\r
607 elseif ($name=='DATETIME.ISO8601')
\r
609 if (!preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $GLOBALS['_xh']['ac']))
\r
611 error_log('XML-RPC: invalid value received in DATETIME: '.$GLOBALS['_xh']['ac']);
\r
613 $GLOBALS['_xh']['vt']=$GLOBALS['xmlrpcDateTime'];
\r
614 $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac'];
\r
616 elseif ($name=='BASE64')
\r
618 /// @todo check for failure of base64 decoding / catch warnings
\r
619 $GLOBALS['_xh']['value']=base64_decode($GLOBALS['_xh']['ac']);
\r
621 elseif ($name=='BOOLEAN')
\r
623 // special case here: we translate boolean 1 or 0 into PHP
\r
624 // constants true or false.
\r
625 // Strings 'true' and 'false' are accepted, even though the
\r
626 // spec never mentions them (see eg. Blogger api docs)
\r
627 // NB: this simple checks helps a lot sanitizing input, ie no
\r
628 // security problems around here
\r
629 if ($GLOBALS['_xh']['ac']=='1' || strcasecmp($GLOBALS['_xh']['ac'], 'true') == 0)
\r
631 $GLOBALS['_xh']['value']=true;
\r
635 // log if receiveing something strange, even though we set the value to false anyway
\r
636 if ($GLOBALS['_xh']['ac']!='0' && strcasecmp($_xh[$parser]['ac'], 'false') != 0)
\r
637 error_log('XML-RPC: invalid value received in BOOLEAN: '.$GLOBALS['_xh']['ac']);
\r
638 $GLOBALS['_xh']['value']=false;
\r
641 elseif ($name=='DOUBLE')
\r
643 // we have a DOUBLE
\r
644 // we must check that only 0123456789-.<space> are characters here
\r
645 if (!preg_match('/^[+-]?[eE0123456789 \t.]+$/', $GLOBALS['_xh']['ac']))
\r
647 /// @todo: find a better way of throwing an error
\r
649 error_log('XML-RPC: non numeric value received in DOUBLE: '.$GLOBALS['_xh']['ac']);
\r
650 $GLOBALS['_xh']['value']='ERROR_NON_NUMERIC_FOUND';
\r
654 // it's ok, add it on
\r
655 $GLOBALS['_xh']['value']=(double)$GLOBALS['_xh']['ac'];
\r
660 // we have an I4/INT
\r
661 // we must check that only 0123456789-<space> are characters here
\r
662 if (!preg_match('/^[+-]?[0123456789 \t]+$/', $GLOBALS['_xh']['ac']))
\r
664 /// @todo find a better way of throwing an error
\r
666 error_log('XML-RPC: non numeric value received in INT: '.$GLOBALS['_xh']['ac']);
\r
667 $GLOBALS['_xh']['value']='ERROR_NON_NUMERIC_FOUND';
\r
671 // it's ok, add it on
\r
672 $GLOBALS['_xh']['value']=(int)$GLOBALS['_xh']['ac'];
\r
675 //$GLOBALS['_xh']['ac']=''; // is this necessary?
\r
676 $GLOBALS['_xh']['lv']=3; // indicate we've found a value
\r
679 $GLOBALS['_xh']['valuestack'][count($GLOBALS['_xh']['valuestack'])-1]['name'] = $GLOBALS['_xh']['ac'];
\r
682 //$GLOBALS['_xh']['ac']=''; // is this necessary?
\r
683 // add to array in the stack the last element built,
\r
684 // unless no VALUE was found
\r
685 if ($GLOBALS['_xh']['vt'])
\r
687 $vscount = count($GLOBALS['_xh']['valuestack']);
\r
688 $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][$GLOBALS['_xh']['valuestack'][$vscount-1]['name']] = $GLOBALS['_xh']['value'];
\r
690 error_log('XML-RPC: missing VALUE inside STRUCT in received xml');
\r
693 //$GLOBALS['_xh']['ac']=''; // is this necessary?
\r
694 $GLOBALS['_xh']['vt']=null; // reset this to check for 2 data elements in a row - even if they're empty
\r
698 // fetch out of stack array of values, and promote it to current value
\r
699 $curr_val = array_pop($GLOBALS['_xh']['valuestack']);
\r
700 $GLOBALS['_xh']['value'] = $curr_val['values'];
\r
701 $GLOBALS['_xh']['vt']=strtolower($name);
\r
702 if (isset($curr_val['php_class']))
\r
704 $GLOBALS['_xh']['php_class'] = $curr_val['php_class'];
\r
708 // add to array of params the current value,
\r
709 // unless no VALUE was found
\r
710 if ($GLOBALS['_xh']['vt'])
\r
712 $GLOBALS['_xh']['params'][]=$GLOBALS['_xh']['value'];
\r
713 $GLOBALS['_xh']['pt'][]=$GLOBALS['_xh']['vt'];
\r
716 error_log('XML-RPC: missing VALUE inside PARAM in received xml');
\r
719 $GLOBALS['_xh']['method']=preg_replace('/^[\n\r\t ]+/', '', $GLOBALS['_xh']['ac']);
\r
722 if ($GLOBALS['xmlrpc_null_extension'])
\r
724 $GLOBALS['_xh']['vt']='null';
\r
725 $GLOBALS['_xh']['value']=null;
\r
726 $GLOBALS['_xh']['lv']=3;
\r
729 // drop through intentionally if nil extension not enabled
\r
733 case 'METHORESPONSE':
\r
736 // End of INVALID ELEMENT!
\r
737 // shall we add an assert here for unreachable code???
\r
743 /// Used in decoding xmlrpc requests/responses without rebuilding xmlrpc values
\r
744 function xmlrpc_ee_fast($parser, $name)
\r
746 xmlrpc_ee($parser, $name, false);
\r
749 /// xml parser handler function for character data
\r
750 function xmlrpc_cd($parser, $data)
\r
752 // skip processing if xml fault already detected
\r
753 if ($GLOBALS['_xh']['isf'] < 2)
\r
755 // "lookforvalue==3" means that we've found an entire value
\r
756 // and should discard any further character data
\r
757 if($GLOBALS['_xh']['lv']!=3)
\r
759 // G. Giunta 2006-08-23: useless change of 'lv' from 1 to 2
\r
760 //if($GLOBALS['_xh']['lv']==1)
\r
762 // if we've found text and we're just in a <value> then
\r
763 // say we've found a value
\r
764 //$GLOBALS['_xh']['lv']=2;
\r
766 // we always initialize the accumulator before starting parsing, anyway...
\r
767 //if(!@isset($GLOBALS['_xh']['ac']))
\r
769 // $GLOBALS['_xh']['ac'] = '';
\r
771 $GLOBALS['_xh']['ac'].=$data;
\r
776 /// xml parser handler function for 'other stuff', ie. not char data or
\r
777 /// element start/end tag. In fact it only gets called on unknown entities...
\r
778 function xmlrpc_dh($parser, $data)
\r
780 // skip processing if xml fault already detected
\r
781 if ($GLOBALS['_xh']['isf'] < 2)
\r
783 if(i18n::substr($data, 0, 1) == '&' && i18n::substr($data, -1, 1) == ';')
\r
785 // G. Giunta 2006-08-25: useless change of 'lv' from 1 to 2
\r
786 //if($GLOBALS['_xh']['lv']==1)
\r
788 // $GLOBALS['_xh']['lv']=2;
\r
790 $GLOBALS['_xh']['ac'].=$data;
\r
796 class xmlrpc_client
\r
801 var $method='http';
\r
814 var $verifypeer=true;
\r
816 var $no_multicall=false;
\r
819 var $proxy_user='';
\r
820 var $proxy_pass='';
\r
821 var $proxy_authtype=1;
\r
822 var $cookies=array();
\r
824 * List of http compression methods accepted by the client for responses.
\r
825 * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib
\r
827 * NNB: you can set it to any non-empty array for HTTP11 and HTTPS, since
\r
828 * in those cases it will be up to CURL to decide the compression methods
\r
829 * it supports. You might check for the presence of 'zlib' in the output of
\r
830 * curl_version() to determine wheter compression is supported or not
\r
832 var $accepted_compression = array();
\r
834 * Name of compression scheme to be used for sending requests.
\r
835 * Either null, gzip or deflate
\r
837 var $request_compression = '';
\r
839 * CURL handle: used for keep-alive connections (PHP 4.3.8 up, see:
\r
840 * http://curl.haxx.se/docs/faq.html#7.3)
\r
842 var $xmlrpc_curl_handle = null;
\r
843 /// Wheter to use persistent connections for http 1.1 and https
\r
844 var $keepalive = false;
\r
845 /// Charset encodings that can be decoded without problems by the client
\r
846 var $accepted_charset_encodings = array();
\r
847 /// Charset encoding to be used in serializing request. NULL = use ASCII
\r
848 var $request_charset_encoding = '';
\r
850 * Decides the content of xmlrpcresp objects returned by calls to send()
\r
851 * valid strings are 'xmlrpcvals', 'phpvals' or 'xml'
\r
853 var $return_type = 'xmlrpcvals';
\r
856 * @param string $path either the complete server URL or the PATH part of the xmlrc server URL, e.g. /xmlrpc/server.php
\r
857 * @param string $server the server name / ip address
\r
858 * @param integer $port the port the server is listening on, defaults to 80 or 443 depending on protocol used
\r
859 * @param string $method the http protocol variant: defaults to 'http', 'https' and 'http11' can be used if CURL is installed
\r
861 function xmlrpc_client($path, $server='', $port='', $method='')
\r
863 // allow user to specify all params in $path
\r
864 if($server == '' and $port == '' and $method == '')
\r
866 $parts = parse_url($path);
\r
867 $server = $parts['host'];
\r
868 $path = $parts['path'];
\r
869 if(isset($parts['query']))
\r
871 $path .= '?'.$parts['query'];
\r
873 if(isset($parts['fragment']))
\r
875 $path .= '#'.$parts['fragment'];
\r
877 if(isset($parts['port']))
\r
879 $port = $parts['port'];
\r
881 if(isset($parts['scheme']))
\r
883 $method = $parts['scheme'];
\r
885 if(isset($parts['user']))
\r
887 $this->username = $parts['user'];
\r
889 if(isset($parts['pass']))
\r
891 $this->password = $parts['pass'];
\r
894 if($path == '' || $path[0] != '/')
\r
896 $this->path='/'.$path;
\r
902 $this->server=$server;
\r
909 $this->method=$method;
\r
912 // if ZLIB is enabled, let the client by default accept compressed responses
\r
913 if(function_exists('gzinflate') || (
\r
914 function_exists('curl_init') && (($info = curl_version()) &&
\r
915 ((is_string($info) && i18n::strpos($info, 'zlib') !== null) || isset($info['libz_version'])))
\r
918 $this->accepted_compression = array('gzip', 'deflate');
\r
921 // keepalives: enabled by default ONLY for PHP >= 4.3.8
\r
922 // (see http://curl.haxx.se/docs/faq.html#7.3)
\r
923 if(version_compare(phpversion(), '4.3.8') >= 0)
\r
925 $this->keepalive = true;
\r
928 // by default the xml parser can support these 3 charset encodings
\r
929 $this->accepted_charset_encodings = array('UTF-8', 'ISO-8859-1', 'US-ASCII');
\r
933 * Enables/disables the echoing to screen of the xmlrpc responses received
\r
934 * @param integer $debug values 0, 1 and 2 are supported (2 = echo sent msg too, before received response)
\r
937 function setDebug($in)
\r
943 * Add some http BASIC AUTH credentials, used by the client to authenticate
\r
944 * @param string $u username
\r
945 * @param string $p password
\r
946 * @param integer $t auth type. See curl_setopt man page for supported auth types. Defaults to CURLAUTH_BASIC (basic auth)
\r
949 function setCredentials($u, $p, $t=1)
\r
951 $this->username=$u;
\r
952 $this->password=$p;
\r
953 $this->authtype=$t;
\r
957 * Add a client-side https certificate
\r
958 * @param string $cert
\r
959 * @param string $certpass
\r
962 function setCertificate($cert, $certpass)
\r
964 $this->cert = $cert;
\r
965 $this->certpass = $certpass;
\r
969 * Add a CA certificate to verify server with (see man page about
\r
970 * CURLOPT_CAINFO for more details
\r
971 * @param string $cacert certificate file name (or dir holding certificates)
\r
972 * @param bool $is_dir set to true to indicate cacert is a dir. defaults to false
\r
975 function setCaCertificate($cacert, $is_dir=false)
\r
979 $this->cacert = $cacert;
\r
983 $this->cacertdir = $cacert;
\r
988 * Set attributes for SSL communication: private SSL key
\r
989 * @param string $key The name of a file containing a private SSL key
\r
990 * @param string $keypass The secret password needed to use the private SSL key
\r
992 * NB: does not work in older php/curl installs
\r
993 * Thanks to Daniel Convissor
\r
995 function setKey($key, $keypass)
\r
998 $this->keypass = $keypass;
\r
1002 * Set attributes for SSL communication: verify server certificate
\r
1003 * @param bool $i enable/disable verification of peer certificate
\r
1006 function setSSLVerifyPeer($i)
\r
1008 $this->verifypeer = $i;
\r
1012 * Set attributes for SSL communication: verify match of server cert w. hostname
\r
1016 function setSSLVerifyHost($i)
\r
1018 $this->verifyhost = $i;
\r
1023 * @param string $proxyhost
\r
1024 * @param string $proxyport Defaults to 8080 for HTTP and 443 for HTTPS
\r
1025 * @param string $proxyusername Leave blank if proxy has public access
\r
1026 * @param string $proxypassword Leave blank if proxy has public access
\r
1027 * @param int $proxyauthtype set to constant CURLAUTH_NTLM to use NTLM auth with proxy
\r
1030 function setProxy($proxyhost, $proxyport, $proxyusername = '', $proxypassword = '', $proxyauthtype = 1)
\r
1032 $this->proxy = $proxyhost;
\r
1033 $this->proxyport = $proxyport;
\r
1034 $this->proxy_user = $proxyusername;
\r
1035 $this->proxy_pass = $proxypassword;
\r
1036 $this->proxy_authtype = $proxyauthtype;
\r
1040 * Enables/disables reception of compressed xmlrpc responses.
\r
1041 * Note that enabling reception of compressed responses merely adds some standard
\r
1042 * http headers to xmlrpc requests. It is up to the xmlrpc server to return
\r
1043 * compressed responses when receiving such requests.
\r
1044 * @param string $compmethod either 'gzip', 'deflate', 'any' or ''
\r
1047 function setAcceptedCompression($compmethod)
\r
1049 if ($compmethod == 'any')
\r
1050 $this->accepted_compression = array('gzip', 'deflate');
\r
1052 $this->accepted_compression = array($compmethod);
\r
1056 * Enables/disables http compression of xmlrpc request.
\r
1057 * Take care when sending compressed requests: servers might not support them
\r
1058 * (and automatic fallback to uncompressed requests is not yet implemented)
\r
1059 * @param string $compmethod either 'gzip', 'deflate' or ''
\r
1062 function setRequestCompression($compmethod)
\r
1064 $this->request_compression = $compmethod;
\r
1068 * Adds a cookie to list of cookies that will be sent to server.
\r
1069 * NB: setting any param but name and value will turn the cookie into a 'version 1' cookie:
\r
1070 * do not do it unless you know what you are doing
\r
1071 * @param string $name
\r
1072 * @param string $value
\r
1073 * @param string $path
\r
1074 * @param string $domain
\r
1075 * @param int $port
\r
1078 * @todo check correctness of urlencoding cookie value (copied from php way of doing it...)
\r
1080 function setCookie($name, $value='', $path='', $domain='', $port=null)
\r
1082 $this->cookies[$name]['value'] = urlencode($value);
\r
1083 if ($path || $domain || $port)
\r
1085 $this->cookies[$name]['path'] = $path;
\r
1086 $this->cookies[$name]['domain'] = $domain;
\r
1087 $this->cookies[$name]['port'] = $port;
\r
1088 $this->cookies[$name]['version'] = 1;
\r
1092 $this->cookies[$name]['version'] = 0;
\r
1097 * Send an xmlrpc request
\r
1098 * @param mixed $msg The message object, or an array of messages for using multicall, or the complete xml representation of a request
\r
1099 * @param integer $timeout Connection timeout, in seconds, If unspecified, a platform specific timeout will apply
\r
1100 * @param string $method if left unspecified, the http protocol chosen during creation of the object will be used
\r
1101 * @return xmlrpcresp
\r
1104 function& send($msg, $timeout=0, $method='')
\r
1106 // if user deos not specify http protocol, use native method of this client
\r
1107 // (i.e. method set during call to constructor)
\r
1110 $method = $this->method;
\r
1113 if(is_array($msg))
\r
1115 // $msg is an array of xmlrpcmsg's
\r
1116 $r = $this->multicall($msg, $timeout, $method);
\r
1119 elseif(is_string($msg))
\r
1121 $n = new xmlrpcmsg('');
\r
1122 $n->payload = $msg;
\r
1126 // where msg is an xmlrpcmsg
\r
1127 $msg->debug=$this->debug;
\r
1129 if($method == 'https')
\r
1131 $r =& $this->sendPayloadHTTPS(
\r
1145 $this->proxy_user,
\r
1146 $this->proxy_pass,
\r
1147 $this->proxy_authtype,
\r
1153 elseif($method == 'http11')
\r
1155 $r =& $this->sendPayloadCURL(
\r
1169 $this->proxy_user,
\r
1170 $this->proxy_pass,
\r
1171 $this->proxy_authtype,
\r
1178 $r =& $this->sendPayloadHTTP10(
\r
1188 $this->proxy_user,
\r
1189 $this->proxy_pass,
\r
1190 $this->proxy_authtype
\r
1200 function &sendPayloadHTTP10($msg, $server, $port, $timeout=0,
\r
1201 $username='', $password='', $authtype=1, $proxyhost='',
\r
1202 $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1)
\r
1209 // Only create the payload if it was not created previously
\r
1210 if(empty($msg->payload))
\r
1212 $msg->createPayload($this->request_charset_encoding);
\r
1215 $payload = $msg->payload;
\r
1216 // Deflate request body and set appropriate request headers
\r
1217 if(function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate'))
\r
1219 if($this->request_compression == 'gzip')
\r
1221 $a = @gzencode($payload);
\r
1225 $encoding_hdr = "Content-Encoding: gzip\r\n";
\r
1230 $a = @gzcompress($payload);
\r
1234 $encoding_hdr = "Content-Encoding: deflate\r\n";
\r
1240 $encoding_hdr = '';
\r
1243 // thanks to Grant Rauscher <grant7@firstworld.net> for this
\r
1247 $credentials='Authorization: Basic ' . base64_encode($username . ':' . $password) . "\r\n";
\r
1248 if ($authtype != 1)
\r
1250 error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth is supported with HTTP 1.0');
\r
1254 $accepted_encoding = '';
\r
1255 if(is_array($this->accepted_compression) && count($this->accepted_compression))
\r
1257 $accepted_encoding = 'Accept-Encoding: ' . implode(', ', $this->accepted_compression) . "\r\n";
\r
1260 $proxy_credentials = '';
\r
1263 if($proxyport == 0)
\r
1265 $proxyport = 8080;
\r
1267 $connectserver = $proxyhost;
\r
1268 $connectport = $proxyport;
\r
1269 $uri = 'http://'.$server.':'.$port.$this->path;
\r
1270 if($proxyusername != '')
\r
1272 if ($proxyauthtype != 1)
\r
1274 error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth to proxy is supported with HTTP 1.0');
\r
1276 $proxy_credentials = 'Proxy-Authorization: Basic ' . base64_encode($proxyusername.':'.$proxypassword) . "\r\n";
\r
1281 $connectserver = $server;
\r
1282 $connectport = $port;
\r
1283 $uri = $this->path;
\r
1286 // Cookie generation, as per rfc2965 (version 1 cookies) or
\r
1287 // netscape's rules (version 0 cookies)
\r
1289 foreach ($this->cookies as $name => $cookie)
\r
1291 if ($cookie['version'])
\r
1293 $cookieheader .= 'Cookie: $Version="' . $cookie['version'] . '"; ';
\r
1294 $cookieheader .= $name . '="' . $cookie['value'] . '";';
\r
1295 if ($cookie['path'])
\r
1296 $cookieheader .= ' $Path="' . $cookie['path'] . '";';
\r
1297 if ($cookie['domain'])
\r
1298 $cookieheader .= ' $Domain="' . $cookie['domain'] . '";';
\r
1299 if ($cookie['port'])
\r
1300 $cookieheader .= ' $Port="' . $cookie['domain'] . '";';
\r
1301 $cookieheader = i18n::substr($cookieheader, 0, -1) . "\r\n";
\r
1305 $cookieheader .= 'Cookie: ' . $name . '=' . $cookie['value'] . "\r\n";
\r
1309 $op= 'POST ' . $uri. " HTTP/1.0\r\n" .
\r
1310 'User-Agent: ' . $GLOBALS['xmlrpcName'] . ' ' . $GLOBALS['xmlrpcVersion'] . "\r\n" .
\r
1311 'Host: '. $server . ':' . $port . "\r\n" .
\r
1313 $proxy_credentials .
\r
1314 $accepted_encoding .
\r
1316 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings) . "\r\n" .
\r
1318 'Content-Type: ' . $msg->content_type . "\r\nContent-Length: " .
\r
1319 i18n::strlen($payload) . "\r\n\r\n" .
\r
1322 if($this->debug > 1)
\r
1324 print "<PRE>\n---SENDING---\n" . Entity::hen($op) . "\n---END---\n</PRE>";
\r
1325 // let the client see this now in case http times out...
\r
1331 $fp=@fsockopen($connectserver, $connectport, $this->errno, $this->errstr, $timeout);
\r
1335 $fp=@fsockopen($connectserver, $connectport, $this->errno, $this->errstr);
\r
1339 if($timeout>0 && function_exists('stream_set_timeout'))
\r
1341 stream_set_timeout($fp, $timeout);
\r
1346 $this->errstr='Connect error: '.$this->errstr;
\r
1347 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $this->errstr . ' (' . $this->errno . ')');
\r
1351 if(!fputs($fp, $op, i18n::strlen($op)))
\r
1353 $this->errstr='Write error';
\r
1354 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $this->errstr);
\r
1359 // reset errno and errstr on succesful socket connection
\r
1360 $this->errstr = '';
\r
1362 // G. Giunta 2005/10/24: close socket before parsing.
\r
1363 // should yeld slightly better execution times, and make easier recursive calls (e.g. to follow http redirects)
\r
1365 while($data=fread($fp, 32768))
\r
1367 // shall we check for $data === FALSE?
\r
1368 // as per the manual, it signals an error
\r
1372 $r =& $msg->parseResponse($ipd, false, $this->return_type);
\r
1380 function &sendPayloadHTTPS($msg, $server, $port, $timeout=0, $username='',
\r
1381 $password='', $authtype=1, $cert='',$certpass='', $cacert='', $cacertdir='',
\r
1382 $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1,
\r
1383 $keepalive=false, $key='', $keypass='')
\r
1385 $r =& $this->sendPayloadCURL($msg, $server, $port, $timeout, $username,
\r
1386 $password, $authtype, $cert, $certpass, $cacert, $cacertdir, $proxyhost, $proxyport,
\r
1387 $proxyusername, $proxypassword, $proxyauthtype, 'https', $keepalive, $key, $keypass);
\r
1392 * Contributed by Justin Miller <justin@voxel.net>
\r
1393 * Requires curl to be built into PHP
\r
1394 * NB: CURL versions before 7.11.10 cannot use proxy to talk to https servers!
\r
1397 function &sendPayloadCURL($msg, $server, $port, $timeout=0, $username='',
\r
1398 $password='', $authtype=1, $cert='', $certpass='', $cacert='', $cacertdir='',
\r
1399 $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1, $method='https',
\r
1400 $keepalive=false, $key='', $keypass='')
\r
1402 if(!function_exists('curl_init'))
\r
1404 $this->errstr='CURL unavailable on this install';
\r
1405 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_curl'], $GLOBALS['xmlrpcstr']['no_curl']);
\r
1408 if($method == 'https')
\r
1410 if(($info = curl_version()) &&
\r
1411 ((is_string($info) && i18n::strpos($info, 'OpenSSL') === null) || (is_array($info) && !isset($info['ssl_version']))))
\r
1413 $this->errstr='SSL unavailable on this install';
\r
1414 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_ssl'], $GLOBALS['xmlrpcstr']['no_ssl']);
\r
1421 if($method == 'http')
\r
1431 // Only create the payload if it was not created previously
\r
1432 if(empty($msg->payload))
\r
1434 $msg->createPayload($this->request_charset_encoding);
\r
1437 // Deflate request body and set appropriate request headers
\r
1438 $payload = $msg->payload;
\r
1439 if(function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate'))
\r
1441 if($this->request_compression == 'gzip')
\r
1443 $a = @gzencode($payload);
\r
1447 $encoding_hdr = 'Content-Encoding: gzip';
\r
1452 $a = @gzcompress($payload);
\r
1456 $encoding_hdr = 'Content-Encoding: deflate';
\r
1462 $encoding_hdr = '';
\r
1465 if($this->debug > 1)
\r
1467 print "<PRE>\n---SENDING---\n" . Entity::hen($payload) . "\n---END---\n</PRE>";
\r
1468 // let the client see this now in case http times out...
\r
1472 if(!$keepalive || !$this->xmlrpc_curl_handle)
\r
1474 $curl = curl_init($method . '://' . $server . ':' . $port . $this->path);
\r
1477 $this->xmlrpc_curl_handle = $curl;
\r
1482 $curl = $this->xmlrpc_curl_handle;
\r
1485 // results into variable
\r
1486 curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
\r
1490 curl_setopt($curl, CURLOPT_VERBOSE, 1);
\r
1492 curl_setopt($curl, CURLOPT_USERAGENT, $GLOBALS['xmlrpcName'].' '.$GLOBALS['xmlrpcVersion']);
\r
1493 // required for XMLRPC: post the data
\r
1494 curl_setopt($curl, CURLOPT_POST, 1);
\r
1496 curl_setopt($curl, CURLOPT_POSTFIELDS, $payload);
\r
1498 // return the header too
\r
1499 curl_setopt($curl, CURLOPT_HEADER, 1);
\r
1501 // will only work with PHP >= 5.0
\r
1502 // NB: if we set an empty string, CURL will add http header indicating
\r
1503 // ALL methods it is supporting. This is possibly a better option than
\r
1504 // letting the user tell what curl can / cannot do...
\r
1505 if(is_array($this->accepted_compression) && count($this->accepted_compression))
\r
1507 //curl_setopt($curl, CURLOPT_ENCODING, implode(',', $this->accepted_compression));
\r
1508 // empty string means 'any supported by CURL' (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
\r
1509 if (count($this->accepted_compression) == 1)
\r
1511 curl_setopt($curl, CURLOPT_ENCODING, $this->accepted_compression[0]);
\r
1514 curl_setopt($curl, CURLOPT_ENCODING, '');
\r
1517 $headers = array('Content-Type: ' . $msg->content_type , 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings));
\r
1518 // if no keepalive is wanted, let the server know it in advance
\r
1521 $headers[] = 'Connection: close';
\r
1523 // request compression header
\r
1526 $headers[] = $encoding_hdr;
\r
1529 curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
\r
1530 // timeout is borked
\r
1533 curl_setopt($curl, CURLOPT_TIMEOUT, $timeout == 1 ? 1 : $timeout - 1);
\r
1536 if($username && $password)
\r
1538 curl_setopt($curl, CURLOPT_USERPWD, $username.':'.$password);
\r
1539 if (defined('CURLOPT_HTTPAUTH'))
\r
1541 curl_setopt($curl, CURLOPT_HTTPAUTH, $authtype);
\r
1543 else if ($authtype != 1)
\r
1545 error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth is supported by the current PHP/curl install');
\r
1549 if($method == 'https')
\r
1554 curl_setopt($curl, CURLOPT_SSLCERT, $cert);
\r
1556 // set cert password
\r
1559 curl_setopt($curl, CURLOPT_SSLCERTPASSWD, $certpass);
\r
1561 // whether to verify remote host's cert
\r
1562 curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, $this->verifypeer);
\r
1563 // set ca certificates file/dir
\r
1566 curl_setopt($curl, CURLOPT_CAINFO, $cacert);
\r
1570 curl_setopt($curl, CURLOPT_CAPATH, $cacertdir);
\r
1572 // set key file (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
\r
1575 curl_setopt($curl, CURLOPT_SSLKEY, $key);
\r
1577 // set key password (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
\r
1580 curl_setopt($curl, CURLOPT_SSLKEYPASSWD, $keypass);
\r
1582 // whether to verify cert's common name (CN); 0 for no, 1 to verify that it exists, and 2 to verify that it matches the hostname used
\r
1583 curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, $this->verifyhost);
\r
1589 if($proxyport == 0)
\r
1591 $proxyport = 8080; // NB: even for HTTPS, local connection is on port 8080
\r
1593 curl_setopt($curl, CURLOPT_PROXY,$proxyhost.':'.$proxyport);
\r
1594 //curl_setopt($curl, CURLOPT_PROXYPORT,$proxyport);
\r
1595 if($proxyusername)
\r
1597 curl_setopt($curl, CURLOPT_PROXYUSERPWD, $proxyusername.':'.$proxypassword);
\r
1598 if (defined('CURLOPT_PROXYAUTH'))
\r
1600 curl_setopt($curl, CURLOPT_PROXYAUTH, $proxyauthtype);
\r
1602 else if ($proxyauthtype != 1)
\r
1604 error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth to proxy is supported by the current PHP/curl install');
\r
1609 // NB: should we build cookie http headers by hand rather than let CURL do it?
\r
1610 // the following code does not honour 'expires', 'path' and 'domain' cookie attributes
\r
1611 // set to clint obj the the user...
\r
1612 if (count($this->cookies))
\r
1614 $cookieheader = '';
\r
1615 foreach ($this->cookies as $name => $cookie)
\r
1617 $cookieheader .= $name . '=' . $cookie['value'] . ', ';
\r
1619 curl_setopt($curl, CURLOPT_COOKIE, i18n::substr($cookieheader, 0, -2));
\r
1622 $result = curl_exec($curl);
\r
1626 $this->errstr='no response';
\r
1627 $resp = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['curl_fail'], $GLOBALS['xmlrpcstr']['curl_fail']. ': '. curl_error($curl));
\r
1630 curl_close($curl);
\r
1637 curl_close($curl);
\r
1639 $resp =& $msg->parseResponse($result, true, $this->return_type);
\r
1645 * Send an array of request messages and return an array of responses.
\r
1646 * Unless $this->no_multicall has been set to true, it will try first
\r
1647 * to use one single xmlrpc call to server method system.multicall, and
\r
1648 * revert to sending many successive calls in case of failure.
\r
1649 * This failure is also stored in $this->no_multicall for subsequent calls.
\r
1650 * Unfortunately, there is no server error code universally used to denote
\r
1651 * the fact that multicall is unsupported, so there is no way to reliably
\r
1652 * distinguish between that and a temporary failure.
\r
1653 * If you are sure that server supports multicall and do not want to
\r
1654 * fallback to using many single calls, set the fourth parameter to FALSE.
\r
1656 * NB: trying to shoehorn extra functionality into existing syntax has resulted
\r
1657 * in pretty much convoluted code...
\r
1659 * @param array $msgs an array of xmlrpcmsg objects
\r
1660 * @param integer $timeout connection timeout (in seconds)
\r
1661 * @param string $method the http protocol variant to be used
\r
1662 * @param boolean fallback When true, upon receiveing an error during multicall, multiple single calls will be attempted
\r
1666 function multicall($msgs, $timeout=0, $method='', $fallback=true)
\r
1668 if ($method == '')
\r
1670 $method = $this->method;
\r
1672 if(!$this->no_multicall)
\r
1674 $results = $this->_try_multicall($msgs, $timeout, $method);
\r
1675 if(is_array($results))
\r
1677 // System.multicall succeeded
\r
1682 // either system.multicall is unsupported by server,
\r
1683 // or call failed for some other reason.
\r
1686 // Don't try it next time...
\r
1687 $this->no_multicall = true;
\r
1691 if (is_a($results, 'xmlrpcresp'))
\r
1693 $result = $results;
\r
1697 $result = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['multicall_error'], $GLOBALS['xmlrpcstr']['multicall_error']);
\r
1704 // override fallback, in case careless user tries to do two
\r
1705 // opposite things at the same time
\r
1709 $results = array();
\r
1712 // system.multicall is (probably) unsupported by server:
\r
1713 // emulate multicall via multiple requests
\r
1714 foreach($msgs as $msg)
\r
1716 $results[] =& $this->send($msg, $timeout, $method);
\r
1721 // user does NOT want to fallback on many single calls:
\r
1722 // since we should always return an array of responses,
\r
1723 // return an array with the same error repeated n times
\r
1724 foreach($msgs as $msg)
\r
1726 $results[] = $result;
\r
1733 * Attempt to boxcar $msgs via system.multicall.
\r
1734 * Returns either an array of xmlrpcreponses, an xmlrpc error response
\r
1735 * or false (when received response does not respect valid multicall syntax)
\r
1738 function _try_multicall($msgs, $timeout, $method)
\r
1740 // Construct multicall message
\r
1742 foreach($msgs as $msg)
\r
1744 $call['methodName'] = new xmlrpcval($msg->method(),'string');
\r
1745 $numParams = $msg->getNumParams();
\r
1746 $params = array();
\r
1747 for($i = 0; $i < $numParams; $i++)
\r
1749 $params[$i] = $msg->getParam($i);
\r
1751 $call['params'] = new xmlrpcval($params, 'array');
\r
1752 $calls[] = new xmlrpcval($call, 'struct');
\r
1754 $multicall = new xmlrpcmsg('system.multicall');
\r
1755 $multicall->addParam(new xmlrpcval($calls, 'array'));
\r
1757 // Attempt RPC call
\r
1758 $result =& $this->send($multicall, $timeout, $method);
\r
1760 if($result->faultCode() != 0)
\r
1762 // call to system.multicall failed
\r
1766 // Unpack responses.
\r
1767 $rets = $result->value();
\r
1769 if ($this->return_type == 'xml')
\r
1773 else if ($this->return_type == 'phpvals')
\r
1775 ///@todo test this code branch...
\r
1776 $rets = $result->value();
\r
1777 if(!is_array($rets))
\r
1779 return false; // bad return type from system.multicall
\r
1781 $numRets = count($rets);
\r
1782 if($numRets != count($msgs))
\r
1784 return false; // wrong number of return values.
\r
1787 $response = array();
\r
1788 for($i = 0; $i < $numRets; $i++)
\r
1791 if (!is_array($val)) {
\r
1794 switch(count($val))
\r
1797 if(!isset($val[0]))
\r
1799 return false; // Bad value
\r
1801 // Normal return value
\r
1802 $response[$i] = new xmlrpcresp($val[0], 0, '', 'phpvals');
\r
1805 /// @todo remove usage of @: it is apparently quite slow
\r
1806 $code = @$val['faultCode'];
\r
1807 if(!is_int($code))
\r
1811 $str = @$val['faultString'];
\r
1812 if(!is_string($str))
\r
1816 $response[$i] = new xmlrpcresp(0, $code, $str);
\r
1824 else // return type == 'xmlrpcvals'
\r
1826 $rets = $result->value();
\r
1827 if($rets->kindOf() != 'array')
\r
1829 return false; // bad return type from system.multicall
\r
1831 $numRets = $rets->arraysize();
\r
1832 if($numRets != count($msgs))
\r
1834 return false; // wrong number of return values.
\r
1837 $response = array();
\r
1838 for($i = 0; $i < $numRets; $i++)
\r
1840 $val = $rets->arraymem($i);
\r
1841 switch($val->kindOf())
\r
1844 if($val->arraysize() != 1)
\r
1846 return false; // Bad value
\r
1848 // Normal return value
\r
1849 $response[$i] = new xmlrpcresp($val->arraymem(0));
\r
1852 $code = $val->structmem('faultCode');
\r
1853 if($code->kindOf() != 'scalar' || $code->scalartyp() != 'int')
\r
1857 $str = $val->structmem('faultString');
\r
1858 if($str->kindOf() != 'scalar' || $str->scalartyp() != 'string')
\r
1862 $response[$i] = new xmlrpcresp(0, $code->scalarval(), $str->scalarval());
\r
1871 } // end class xmlrpc_client
\r
1880 var $hdrs = array();
\r
1881 var $_cookies = array();
\r
1882 var $content_type = 'text/xml';
\r
1883 var $raw_data = '';
\r
1886 * @param mixed $val either an xmlrpcval obj, a php value or the xml serialization of an xmlrpcval (a string)
\r
1887 * @param integer $fcode set it to anything but 0 to create an error response
\r
1888 * @param string $fstr the error string, in case of an error response
\r
1889 * @param string $valtyp either 'xmlrpcvals', 'phpvals' or 'xml'
\r
1891 * @todo add check that $val / $fcode / $fstr is of correct type???
\r
1892 * NB: as of now we do not do it, since it might be either an xmlrpcval or a plain
\r
1893 * php val, or a complete xml chunk, depending on usage of xmlrpc_client::send() inside which creator is called...
\r
1895 function xmlrpcresp($val, $fcode = 0, $fstr = '', $valtyp='')
\r
1900 $this->errno = $fcode;
\r
1901 $this->errstr = $fstr;
\r
1902 //$this->errstr = Entity::hsc($fstr); // XXX: encoding probably shouldn't be done here; fix later.
\r
1906 // successful response
\r
1907 $this->val = $val;
\r
1908 if ($valtyp == '')
\r
1910 // user did not declare type of response value: try to guess it
\r
1911 if (is_object($this->val) && is_a($this->val, 'xmlrpcval'))
\r
1913 $this->valtyp = 'xmlrpcvals';
\r
1915 else if (is_string($this->val))
\r
1917 $this->valtyp = 'xml';
\r
1922 $this->valtyp = 'phpvals';
\r
1927 // user declares type of resp value: believe him
\r
1928 $this->valtyp = $valtyp;
\r
1934 * Returns the error code of the response.
\r
1935 * @return integer the error code of this response (0 for not-error responses)
\r
1938 function faultCode()
\r
1940 return $this->errno;
\r
1944 * Returns the error code of the response.
\r
1945 * @return string the error string of this response ('' for not-error responses)
\r
1948 function faultString()
\r
1950 return $this->errstr;
\r
1954 * Returns the value received by the server.
\r
1955 * @return mixed the xmlrpcval object returned by the server. Might be an xml string or php value if the response has been created by specially configured xmlrpc_client objects
\r
1960 return $this->val;
\r
1964 * Returns an array with the cookies received from the server.
\r
1965 * Array has the form: $cookiename => array ('value' => $val, $attr1 => $val1, $attr2 = $val2, ...)
\r
1966 * with attributes being e.g. 'expires', 'path', domain'.
\r
1967 * NB: cookies sent as 'expired' by the server (i.e. with an expiry date in the past)
\r
1968 * are still present in the array. It is up to the user-defined code to decide
\r
1969 * how to use the received cookies, and wheter they have to be sent back with the next
\r
1970 * request to the server (using xmlrpc_client::setCookie) or not
\r
1971 * @return array array of cookies received from the server
\r
1974 function cookies()
\r
1976 return $this->_cookies;
\r
1980 * Returns xml representation of the response. XML prologue not included
\r
1981 * @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed
\r
1982 * @return string the xml representation of the response
\r
1985 function serialize($charset_encoding='')
\r
1987 if ($charset_encoding != '')
\r
1988 $this->content_type = 'text/xml; charset=' . $charset_encoding;
\r
1990 $this->content_type = 'text/xml';
\r
1991 $result = "<methodResponse>\n";
\r
1994 // G. Giunta 2005/2/13: let non-ASCII response messages be tolerated by clients
\r
1995 // by xml-encoding non ascii chars
\r
1996 $result .= "<fault>\n" .
\r
1997 "<value>\n<struct><member><name>faultCode</name>\n<value><int>" . $this->errno .
\r
1998 "</int></value>\n</member>\n<member>\n<name>faultString</name>\n<value><string>" .
\r
1999 xmlrpc_encode_entitites($this->errstr, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding) . "</string></value>\n</member>\n" .
\r
2000 "</struct>\n</value>\n</fault>";
\r
2004 if(!is_object($this->val) || !is_a($this->val, 'xmlrpcval'))
\r
2006 if (is_string($this->val) && $this->valtyp == 'xml')
\r
2008 $result .= "<params>\n<param>\n" .
\r
2010 "</param>\n</params>";
\r
2014 /// @todo try to build something serializable?
\r
2015 die('cannot serialize xmlrpcresp objects whose content is native php values');
\r
2020 $result .= "<params>\n<param>\n" .
\r
2021 $this->val->serialize($charset_encoding) .
\r
2022 "</param>\n</params>";
\r
2025 $result .= "\n</methodResponse>";
\r
2026 $this->payload = $result;
\r
2035 var $params=array();
\r
2037 var $content_type = 'text/xml';
\r
2040 * @param string $meth the name of the method to invoke
\r
2041 * @param array $pars array of parameters to be paased to the method (xmlrpcval objects)
\r
2043 function xmlrpcmsg($meth, $pars=0)
\r
2045 $this->methodname=$meth;
\r
2046 if(is_array($pars) && count($pars)>0)
\r
2048 for($i=0; $i<count($pars); $i++)
\r
2050 $this->addParam($pars[$i]);
\r
2058 function xml_header($charset_encoding='')
\r
2060 if ($charset_encoding != '')
\r
2062 return "<?xml version=\"1.0\" encoding=\"$charset_encoding\" ?" . ">\n<methodCall>\n";
\r
2066 return "<?xml version=\"1.0\"?" . ">\n<methodCall>\n";
\r
2073 function xml_footer()
\r
2075 return '</methodCall>';
\r
2089 function createPayload($charset_encoding='')
\r
2091 if ($charset_encoding != '')
\r
2092 $this->content_type = 'text/xml; charset=' . $charset_encoding;
\r
2094 $this->content_type = 'text/xml';
\r
2095 $this->payload=$this->xml_header($charset_encoding);
\r
2096 $this->payload.='<methodName>' . $this->methodname . "</methodName>\n";
\r
2097 $this->payload.="<params>\n";
\r
2098 for($i=0; $i<count($this->params); $i++)
\r
2100 $p=$this->params[$i];
\r
2101 $this->payload.="<param>\n" . $p->serialize($charset_encoding) .
\r
2104 $this->payload.="</params>\n";
\r
2105 $this->payload.=$this->xml_footer();
\r
2109 * Gets/sets the xmlrpc method to be invoked
\r
2110 * @param string $meth the method to be set (leave empty not to set it)
\r
2111 * @return string the method that will be invoked
\r
2114 function method($meth='')
\r
2118 $this->methodname=$meth;
\r
2120 return $this->methodname;
\r
2124 * Returns xml representation of the message. XML prologue included
\r
2125 * @return string the xml representation of the message, xml prologue included
\r
2128 function serialize($charset_encoding='')
\r
2130 $this->createPayload($charset_encoding);
\r
2131 return $this->payload;
\r
2135 * Add a parameter to the list of parameters to be used upon method invocation
\r
2136 * @param xmlrpcval $par
\r
2137 * @return boolean false on failure
\r
2140 function addParam($par)
\r
2142 // add check: do not add to self params which are not xmlrpcvals
\r
2143 if(is_object($par) && is_a($par, 'xmlrpcval'))
\r
2145 $this->params[]=$par;
\r
2155 * Returns the nth parameter in the message. The index zero-based.
\r
2156 * @param integer $i the index of the parameter to fetch (zero based)
\r
2157 * @return xmlrpcval the i-th parameter
\r
2160 function getParam($i) { return $this->params[$i]; }
\r
2163 * Returns the number of parameters in the messge.
\r
2164 * @return integer the number of parameters currently set
\r
2167 function getNumParams() { return count($this->params); }
\r
2170 * Given an open file handle, read all data available and parse it as axmlrpc response.
\r
2171 * NB: the file handle is not closed by this function.
\r
2173 * @return xmlrpcresp
\r
2174 * @todo add 2nd & 3rd param to be passed to ParseResponse() ???
\r
2176 function &parseResponseFile($fp)
\r
2179 while($data=fread($fp, 32768))
\r
2184 $r =& $this->parseResponse($ipd);
\r
2189 * Parses HTTP headers and separates them from data.
\r
2192 function &parseResponseHeaders(&$data, $headers_processed=false)
\r
2194 // Support "web-proxy-tunelling" connections for https through proxies
\r
2195 if(preg_match('/^HTTP\/1\.[0-1] 200 Connection established/', $data))
\r
2197 // Look for CR/LF or simple LF as line separator,
\r
2198 // (even though it is not valid http)
\r
2199 $pos = i18n::strpos($data,"\r\n\r\n");
\r
2200 if($pos || is_int($pos))
\r
2206 $pos = i18n::strpos($data,"\n\n");
\r
2207 if($pos || is_int($pos))
\r
2213 // No separation between response headers and body: fault?
\r
2219 // this filters out all http headers from proxy.
\r
2220 // maybe we could take them into account, too?
\r
2221 $data = i18n::substr($data, $bd);
\r
2225 error_log('XML-RPC: xmlrpcmsg::parseResponse: HTTPS via proxy error, tunnel connection possibly failed');
\r
2226 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $GLOBALS['xmlrpcstr']['http_error']. ' (HTTPS via proxy error, tunnel connection possibly failed)');
\r
2231 // Strip HTTP 1.1 100 Continue header if present
\r
2232 while(preg_match('/^HTTP\/1\.1 1[0-9]{2} /', $data))
\r
2234 $pos = i18n::strpos($data, 'HTTP', 12);
\r
2235 // server sent a Continue header without any (valid) content following...
\r
2236 // give the client a chance to know it
\r
2237 if(!$pos && !is_int($pos)) // works fine in php 3, 4 and 5
\r
2241 $data = i18n::substr($data, $pos);
\r
2243 if(!preg_match('/^HTTP\/[0-9.]+ 200 /', $data))
\r
2245 $errstr= i18n::substr($data, 0, i18n::strpos($data, "\n")-1);
\r
2246 error_log('XML-RPC: xmlrpcmsg::parseResponse: HTTP error, got response: ' .$errstr);
\r
2247 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $GLOBALS['xmlrpcstr']['http_error']. ' (' . $errstr . ')');
\r
2251 $GLOBALS['_xh']['headers'] = array();
\r
2252 $GLOBALS['_xh']['cookies'] = array();
\r
2254 // be tolerant to usage of \n instead of \r\n to separate headers and data
\r
2255 // (even though it is not valid http)
\r
2256 $pos = i18n::strpos($data,"\r\n\r\n");
\r
2257 if($pos || is_int($pos))
\r
2263 $pos = i18n::strpos($data,"\n\n");
\r
2264 if($pos || is_int($pos))
\r
2270 // No separation between response headers and body: fault?
\r
2271 // we could take some action here instead of going on...
\r
2275 // be tolerant to line endings, and extra empty lines
\r
2276 //$ar = split("\r?\n", trim(substr($data, 0, $pos))); //split() is deprecated
\r
2277 $ar = preg_split("/\r?\n/", trim(i18n::substr($data, 0, $pos)));
\r
2278 while(list(,$line) = @each($ar))
\r
2280 // take care of multi-line headers and cookies
\r
2281 $arr = preg_split('#:#',$line,2);
\r
2282 if(count($arr) > 1)
\r
2284 $header_name = strtolower(trim($arr[0]));
\r
2285 /// @todo some other headers (the ones that allow a CSV list of values)
\r
2286 /// do allow many values to be passed using multiple header lines.
\r
2287 /// We should add content to $GLOBALS['_xh']['headers'][$header_name]
\r
2288 /// instead of replacing it for those...
\r
2289 if ($header_name == 'set-cookie' || $header_name == 'set-cookie2')
\r
2291 if ($header_name == 'set-cookie2')
\r
2293 // version 2 cookies:
\r
2294 // there could be many cookies on one line, comma separated
\r
2295 $cookies = preg_split('#,#', $arr[1]);
\r
2299 $cookies = array($arr[1]);
\r
2301 foreach ($cookies as $cookie)
\r
2303 // glue together all received cookies, using a comma to separate them
\r
2304 // (same as php does with getallheaders())
\r
2305 if (isset($GLOBALS['_xh']['headers'][$header_name]))
\r
2306 $GLOBALS['_xh']['headers'][$header_name] .= ', ' . trim($cookie);
\r
2308 $GLOBALS['_xh']['headers'][$header_name] = trim($cookie);
\r
2309 // parse cookie attributes, in case user wants to correctly honour them
\r
2310 // feature creep: only allow rfc-compliant cookie attributes?
\r
2311 $cookie = preg_split('#;#', $cookie);
\r
2312 foreach ($cookie as $pos => $val)
\r
2314 $val = preg_split('#=#', $val, 2);
\r
2315 $tag = trim($val[0]);
\r
2316 $val = trim(@$val[1]);
\r
2317 /// @todo with version 1 cookies, we should strip leading and trailing " chars
\r
2320 $cookiename = $tag;
\r
2321 $GLOBALS['_xh']['cookies'][$tag] = array();
\r
2322 $GLOBALS['_xh']['cookies'][$cookiename]['value'] = urldecode($val);
\r
2326 $GLOBALS['_xh']['cookies'][$cookiename][$tag] = $val;
\r
2333 $GLOBALS['_xh']['headers'][$header_name] = trim($arr[1]);
\r
2336 elseif(isset($header_name))
\r
2338 /// @todo version1 cookies might span multiple lines, thus breaking the parsing above
\r
2339 $GLOBALS['_xh']['headers'][$header_name] .= ' ' . trim($line);
\r
2343 $data = i18n::substr($data, $bd);
\r
2345 if($this->debug && count($GLOBALS['_xh']['headers']))
\r
2348 foreach($GLOBALS['_xh']['headers'] as $header => $value)
\r
2350 print Entity::hen("HEADER: $header: $value\n");
\r
2352 foreach($GLOBALS['_xh']['cookies'] as $header => $value)
\r
2354 print Entity::hen("COOKIE: $header={$value['value']}\n");
\r
2359 // if CURL was used for the call, http headers have been processed,
\r
2360 // and dechunking + reinflating have been carried out
\r
2361 if(!$headers_processed)
\r
2363 // Decode chunked encoding sent by http 1.1 servers
\r
2364 if(isset($GLOBALS['_xh']['headers']['transfer-encoding']) && $GLOBALS['_xh']['headers']['transfer-encoding'] == 'chunked')
\r
2366 if(!$data = decode_chunked($data))
\r
2368 error_log('XML-RPC: xmlrpcmsg::parseResponse: errors occurred when trying to rebuild the chunked data received from server');
\r
2369 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['dechunk_fail'], $GLOBALS['xmlrpcstr']['dechunk_fail']);
\r
2374 // Decode gzip-compressed stuff
\r
2375 // code shamelessly inspired from nusoap library by Dietrich Ayala
\r
2376 if(isset($GLOBALS['_xh']['headers']['content-encoding']))
\r
2378 $GLOBALS['_xh']['headers']['content-encoding'] = str_replace('x-', '', $GLOBALS['_xh']['headers']['content-encoding']);
\r
2379 if($GLOBALS['_xh']['headers']['content-encoding'] == 'deflate' || $GLOBALS['_xh']['headers']['content-encoding'] == 'gzip')
\r
2381 // if decoding works, use it. else assume data wasn't gzencoded
\r
2382 if(function_exists('gzinflate'))
\r
2384 if($GLOBALS['_xh']['headers']['content-encoding'] == 'deflate' && $degzdata = @gzuncompress($data))
\r
2386 $data = $degzdata;
\r
2388 print "<PRE>---INFLATED RESPONSE---[".i18n::strlen($data)." chars]---\n" . Entity::hen($data) . "\n---END---</PRE>";
\r
2390 elseif($GLOBALS['_xh']['headers']['content-encoding'] == 'gzip' && $degzdata = @gzinflate(i18n::substr($data, 10)))
\r
2392 $data = $degzdata;
\r
2394 print "<PRE>---INFLATED RESPONSE---[".i18n::strlen($data)." chars]---\n" . Entity::hen($data) . "\n---END---</PRE>";
\r
2398 error_log('XML-RPC: xmlrpcmsg::parseResponse: errors occurred when trying to decode the deflated data received from server');
\r
2399 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['decompress_fail'], $GLOBALS['xmlrpcstr']['decompress_fail']);
\r
2405 error_log('XML-RPC: xmlrpcmsg::parseResponse: the server sent deflated data. Your php install must have the Zlib extension compiled in to support this.');
\r
2406 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['cannot_decompress'], $GLOBALS['xmlrpcstr']['cannot_decompress']);
\r
2411 } // end of 'if needed, de-chunk, re-inflate response'
\r
2413 // real stupid hack to avoid PHP 4 complaining about returning NULL by ref
\r
2420 * Parse the xmlrpc response contained in the string $data and return an xmlrpcresp object.
\r
2421 * @param string $data the xmlrpc response, eventually including http headers
\r
2422 * @param bool $headers_processed when true prevents parsing HTTP headers for interpretation of content-encoding and consequent decoding
\r
2423 * @param string $return_type decides return type, i.e. content of response->value(). Either 'xmlrpcvals', 'xml' or 'phpvals'
\r
2424 * @return xmlrpcresp
\r
2427 function &parseResponse($data='', $headers_processed=false, $return_type='xmlrpcvals')
\r
2431 print "<PRE>---GOT---\n" . Entity::hen($data) . "\n---END---\n</PRE>";
\r
2436 error_log('XML-RPC: xmlrpcmsg::parseResponse: no response received from server.');
\r
2437 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_data'], $GLOBALS['xmlrpcstr']['no_data']);
\r
2441 $GLOBALS['_xh']=array();
\r
2443 $raw_data = $data;
\r
2444 // parse the HTTP headers of the response, if present, and separate them from data
\r
2445 if(i18n::substr($data, 0, 4) == 'HTTP')
\r
2447 $r =& $this->parseResponseHeaders($data, $headers_processed);
\r
2450 // failed processing of HTTP response headers
\r
2451 // save into response obj the full payload received, for debugging
\r
2452 $r->raw_data = $data;
\r
2458 $GLOBALS['_xh']['headers'] = array();
\r
2459 $GLOBALS['_xh']['cookies'] = array();
\r
2464 $start = i18n::strpos($data, '<!-- SERVER DEBUG INFO (BASE64 ENCODED):');
\r
2467 $start += i18n::strlen('<!-- SERVER DEBUG INFO (BASE64 ENCODED):');
\r
2468 $end = i18n::strpos($data, '-->', $start);
\r
2469 $comments = i18n::substr($data, $start, $end-$start);
\r
2470 print "<PRE>---SERVER DEBUG INFO (DECODED) ---\n\t".Entity::hen(str_replace("\n", "\n\t", base64_decode($comments)))."\n---END---\n</PRE>";
\r
2474 // be tolerant of extra whitespace in response body
\r
2475 $data = trim($data);
\r
2477 /// @todo return an error msg if $data=='' ?
\r
2479 // be tolerant of junk after methodResponse (e.g. javascript ads automatically inserted by free hosts)
\r
2480 // idea from Luca Mariano <luca.mariano@email.it> originally in PEARified version of the lib
\r
2482 // Poor man's version of strrpos for php 4...
\r
2483 $pos = i18n::strpos($data, '</methodResponse>');
\r
2484 while($pos || is_int($pos))
\r
2487 $pos = i18n::strpos($data, '</methodResponse>', $bd);
\r
2491 $data = i18n::substr($data, 0, $bd);
\r
2494 // if user wants back raw xml, give it to him
\r
2495 if ($return_type == 'xml')
\r
2497 $r = new xmlrpcresp($data, 0, '', 'xml');
\r
2498 $r->hdrs = $GLOBALS['_xh']['headers'];
\r
2499 $r->_cookies = $GLOBALS['_xh']['cookies'];
\r
2500 $r->raw_data = $raw_data;
\r
2504 // try to 'guestimate' the character encoding of the received response
\r
2505 $resp_encoding = guess_encoding(@$GLOBALS['_xh']['headers']['content-type'], $data);
\r
2507 $GLOBALS['_xh']['ac']='';
\r
2508 //$GLOBALS['_xh']['qt']=''; //unused...
\r
2509 $GLOBALS['_xh']['stack'] = array();
\r
2510 $GLOBALS['_xh']['valuestack'] = array();
\r
2511 $GLOBALS['_xh']['isf']=0; // 0 = OK, 1 for xmlrpc fault responses, 2 = invalid xmlrpc
\r
2512 $GLOBALS['_xh']['isf_reason']='';
\r
2513 $GLOBALS['_xh']['rt']=''; // 'methodcall or 'methodresponse'
\r
2515 // if response charset encoding is not known / supported, try to use
\r
2516 // the default encoding and parse the xml anyway, but log a warning...
\r
2517 if (!in_array($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
\r
2518 // the following code might be better for mb_string enabled installs, but
\r
2519 // makes the lib about 200% slower...
\r
2520 //if (!is_valid_charset($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
\r
2522 error_log('XML-RPC: xmlrpcmsg::parseResponse: invalid charset encoding of received response: '.$resp_encoding);
\r
2523 $resp_encoding = $GLOBALS['xmlrpc_defencoding'];
\r
2525 $parser = xml_parser_create($resp_encoding);
\r
2526 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true);
\r
2527 // G. Giunta 2005/02/13: PHP internally uses ISO-8859-1, so we have to tell
\r
2528 // the xml parser to give us back data in the expected charset
\r
2529 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $GLOBALS['xmlrpc_internalencoding']);
\r
2531 if ($return_type == 'phpvals')
\r
2533 xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast');
\r
2537 xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee');
\r
2540 xml_set_character_data_handler($parser, 'xmlrpc_cd');
\r
2541 xml_set_default_handler($parser, 'xmlrpc_dh');
\r
2543 // first error check: xml not well formed
\r
2544 if(!xml_parse($parser, $data, count($data)))
\r
2546 // thanks to Peter Kocks <peter.kocks@baygate.com>
\r
2547 if((xml_get_current_line_number($parser)) == 1)
\r
2549 $errstr = 'XML error at line 1, check URL';
\r
2553 $errstr = sprintf('XML error: %s at line %d, column %d',
\r
2554 xml_error_string(xml_get_error_code($parser)),
\r
2555 xml_get_current_line_number($parser), xml_get_current_column_number($parser));
\r
2557 error_log($errstr);
\r
2558 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'], $GLOBALS['xmlrpcstr']['invalid_return'].' ('.$errstr.')');
\r
2559 xml_parser_free($parser);
\r
2564 $r->hdrs = $GLOBALS['_xh']['headers'];
\r
2565 $r->_cookies = $GLOBALS['_xh']['cookies'];
\r
2566 $r->raw_data = $raw_data;
\r
2569 xml_parser_free($parser);
\r
2570 // second error check: xml well formed but not xml-rpc compliant
\r
2571 if ($GLOBALS['_xh']['isf'] > 1)
\r
2575 /// @todo echo something for user?
\r
2578 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'],
\r
2579 $GLOBALS['xmlrpcstr']['invalid_return'] . ' ' . $GLOBALS['_xh']['isf_reason']);
\r
2581 // third error check: parsing of the response has somehow gone boink.
\r
2582 // NB: shall we omit this check, since we trust the parsing code?
\r
2583 elseif ($return_type == 'xmlrpcvals' && !is_object($GLOBALS['_xh']['value']))
\r
2585 // something odd has happened
\r
2586 // and it's time to generate a client side error
\r
2587 // indicating something odd went on
\r
2588 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'],
\r
2589 $GLOBALS['xmlrpcstr']['invalid_return']);
\r
2595 print "<PRE>---PARSED---\n";
\r
2596 print Entity::hsc(var_export($GLOBALS['_xh']['value'], true));
\r
2597 print "\n---END---</PRE>";
\r
2600 // note that using =& will raise an error if $GLOBALS['_xh']['st'] does not generate an object.
\r
2601 $v =& $GLOBALS['_xh']['value'];
\r
2603 if($GLOBALS['_xh']['isf'])
\r
2605 /// @todo we should test here if server sent an int and a string,
\r
2606 /// and/or coerce them into such...
\r
2607 if ($return_type == 'xmlrpcvals')
\r
2609 $errno_v = $v->structmem('faultCode');
\r
2610 $errstr_v = $v->structmem('faultString');
\r
2611 $errno = $errno_v->scalarval();
\r
2612 $errstr = $errstr_v->scalarval();
\r
2616 $errno = $v['faultCode'];
\r
2617 $errstr = $v['faultString'];
\r
2622 // FAULT returned, errno needs to reflect that
\r
2626 $r = new xmlrpcresp(0, $errno, $errstr);
\r
2630 $r = new xmlrpcresp($v, 0, '', $return_type);
\r
2634 $r->hdrs = $GLOBALS['_xh']['headers'];
\r
2635 $r->_cookies = $GLOBALS['_xh']['cookies'];
\r
2636 $r->raw_data = $raw_data;
\r
2645 var $_php_class=null;
\r
2648 * @param mixed $val
\r
2649 * @param string $type any valid xmlrpc type name (lowercase). If null, 'string' is assumed
\r
2651 function xmlrpcval($val=-1, $type='')
\r
2653 /// @todo: optimization creep - do not call addXX, do it all inline.
\r
2654 /// downside: booleans will not be coerced anymore
\r
2655 if($val!==-1 || $type!='')
\r
2657 // optimization creep: inlined all work done by constructor
\r
2662 $this->me['string']=$val;
\r
2669 case 'dateTime.iso8601':
\r
2673 $this->me[$type]=$val;
\r
2677 $this->me['array']=$val;
\r
2681 $this->me['struct']=$val;
\r
2684 error_log("XML-RPC: xmlrpcval::xmlrpcval: not a known type ($type)");
\r
2690 if($GLOBALS['xmlrpcTypes'][$type]==1)
\r
2692 $this->addScalar($val,$type);
\r
2694 elseif($GLOBALS['xmlrpcTypes'][$type]==2)
\r
2696 $this->addArray($val);
\r
2698 elseif($GLOBALS['xmlrpcTypes'][$type]==3)
\r
2700 $this->addStruct($val);
\r
2706 * Add a single php value to an (unitialized) xmlrpcval
\r
2707 * @param mixed $val
\r
2708 * @param string $type
\r
2709 * @return int 1 or 0 on failure
\r
2711 function addScalar($val, $type='string')
\r
2713 $typeof=@$GLOBALS['xmlrpcTypes'][$type];
\r
2716 error_log("XML-RPC: xmlrpcval::addScalar: not a scalar type ($type)");
\r
2720 // coerce booleans into correct values
\r
2721 // NB: we should iether do it for datetimes, integers and doubles, too,
\r
2722 // or just plain remove this check, implemnted on booleans only...
\r
2723 if($type==$GLOBALS['xmlrpcBoolean'])
\r
2725 if(strcasecmp($val,'true')==0 || $val==1 || ($val==true && strcasecmp($val,'false')))
\r
2735 switch($this->mytype)
\r
2738 error_log('XML-RPC: xmlrpcval::addScalar: scalar xmlrpcval can have only one value');
\r
2741 error_log('XML-RPC: xmlrpcval::addScalar: cannot add anonymous scalar to struct xmlrpcval');
\r
2744 // we're adding a scalar value to an array here
\r
2745 //$ar=$this->me['array'];
\r
2746 //$ar[] = new xmlrpcval($val, $type);
\r
2747 //$this->me['array']=$ar;
\r
2748 // Faster (?) avoid all the costly array-copy-by-val done here...
\r
2749 $this->me['array'][] = new xmlrpcval($val, $type);
\r
2752 // a scalar, so set the value and remember we're scalar
\r
2753 $this->me[$type]=$val;
\r
2754 $this->mytype=$typeof;
\r
2760 * Add an array of xmlrpcval objects to an xmlrpcval
\r
2761 * @param array $vals
\r
2762 * @return int 1 or 0 on failure
\r
2765 * @todo add some checking for $vals to be an array of xmlrpcvals?
\r
2767 function addArray($vals)
\r
2769 if($this->mytype==0)
\r
2771 $this->mytype=$GLOBALS['xmlrpcTypes']['array'];
\r
2772 $this->me['array']=$vals;
\r
2775 elseif($this->mytype==2)
\r
2777 // we're adding to an array here
\r
2778 $this->me['array'] = array_merge($this->me['array'], $vals);
\r
2783 error_log('XML-RPC: xmlrpcval::addArray: already initialized as a [' . $this->kindOf() . ']');
\r
2789 * Add an array of named xmlrpcval objects to an xmlrpcval
\r
2790 * @param array $vals
\r
2791 * @return int 1 or 0 on failure
\r
2794 * @todo add some checking for $vals to be an array?
\r
2796 function addStruct($vals)
\r
2798 if($this->mytype==0)
\r
2800 $this->mytype=$GLOBALS['xmlrpcTypes']['struct'];
\r
2801 $this->me['struct']=$vals;
\r
2804 elseif($this->mytype==3)
\r
2806 // we're adding to a struct here
\r
2807 $this->me['struct'] = array_merge($this->me['struct'], $vals);
\r
2812 error_log('XML-RPC: xmlrpcval::addStruct: already initialized as a [' . $this->kindOf() . ']');
\r
2817 // poor man's version of print_r ???
\r
2819 function dump($ar)
\r
2821 foreach($ar as $key => $val)
\r
2823 echo "$key => $val<br />";
\r
2824 if($key == 'array')
\r
2826 while(list($key2, $val2) = each($val))
\r
2828 echo "-- $key2 => $val2<br />";
\r
2835 * Returns a string containing "struct", "array" or "scalar" describing the base type of the value
\r
2841 switch($this->mytype)
\r
2860 function serializedata($typ, $val, $charset_encoding='')
\r
2863 switch(@$GLOBALS['xmlrpcTypes'][$typ])
\r
2868 case $GLOBALS['xmlrpcBase64']:
\r
2869 $rs.="<${typ}>" . base64_encode($val) . "</${typ}>";
\r
2871 case $GLOBALS['xmlrpcBoolean']:
\r
2872 $rs.="<${typ}>" . ($val ? '1' : '0') . "</${typ}>";
\r
2874 case $GLOBALS['xmlrpcString']:
\r
2875 // G. Giunta 2005/2/13: do NOT use htmlentities, since
\r
2876 // it will produce named html entities, which are invalid xml
\r
2877 $rs.="<${typ}>" . xmlrpc_encode_entitites($val, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding). "</${typ}>";
\r
2879 case $GLOBALS['xmlrpcInt']:
\r
2880 case $GLOBALS['xmlrpcI4']:
\r
2881 $rs.="<${typ}>".(int)$val."</${typ}>";
\r
2883 case $GLOBALS['xmlrpcDouble']:
\r
2884 $rs.="<${typ}>".(double)$val."</${typ}>";
\r
2886 case $GLOBALS['xmlrpcNull']:
\r
2890 // no standard type value should arrive here, but provide a possibility
\r
2891 // for xmlrpcvals of unknown type...
\r
2892 $rs.="<${typ}>${val}</${typ}>";
\r
2897 if ($this->_php_class)
\r
2899 $rs.='<struct php_class="' . $this->_php_class . "\">\n";
\r
2903 $rs.="<struct>\n";
\r
2905 foreach($val as $key2 => $val2)
\r
2907 $rs.='<member><name>'.xmlrpc_encode_entitites($key2, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding)."</name>\n";
\r
2908 //$rs.=$this->serializeval($val2);
\r
2909 $rs.=$val2->serialize($charset_encoding);
\r
2910 $rs.="</member>\n";
\r
2916 $rs.="<array>\n<data>\n";
\r
2917 for($i=0; $i<count($val); $i++)
\r
2919 //$rs.=$this->serializeval($val[$i]);
\r
2920 $rs.=$val[$i]->serialize($charset_encoding);
\r
2922 $rs.="</data>\n</array>";
\r
2931 * Returns xml representation of the value. XML prologue not included
\r
2932 * @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed
\r
2936 function serialize($charset_encoding='')
\r
2938 // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...
\r
2939 //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))
\r
2942 list($typ, $val) = each($this->me);
\r
2943 return '<value>' . $this->serializedata($typ, $val, $charset_encoding) . "</value>\n";
\r
2948 function serializeval($o)
\r
2950 // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...
\r
2951 //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))
\r
2955 list($typ, $val) = each($ar);
\r
2956 return '<value>' . $this->serializedata($typ, $val) . "</value>\n";
\r
2961 * Checks wheter a struct member with a given name is present.
\r
2962 * Works only on xmlrpcvals of type struct.
\r
2963 * @param string $m the name of the struct member to be looked up
\r
2967 function structmemexists($m)
\r
2969 return array_key_exists($m, $this->me['struct']);
\r
2973 * Returns the value of a given struct member (an xmlrpcval object in itself).
\r
2974 * Will raise a php warning if struct member of given name does not exist
\r
2975 * @param string $m the name of the struct member to be looked up
\r
2976 * @return xmlrpcval
\r
2979 function structmem($m)
\r
2981 return $this->me['struct'][$m];
\r
2985 * Reset internal pointer for xmlrpcvals of type struct.
\r
2988 function structreset()
\r
2990 reset($this->me['struct']);
\r
2994 * Return next member element for xmlrpcvals of type struct.
\r
2995 * @return xmlrpcval
\r
2998 function structeach()
\r
3000 return each($this->me['struct']);
\r
3003 // DEPRECATED! this code looks like it is very fragile and has not been fixed
\r
3004 // for a long long time. Shall we remove it for 2.0?
\r
3009 list($a,$b)=each($this->me);
\r
3010 // contributed by I Sofer, 2001-03-24
\r
3011 // add support for nested arrays to scalarval
\r
3012 // i've created a new method here, so as to
\r
3013 // preserve back compatibility
\r
3018 while(list($id,$cont) = @each($b))
\r
3020 $b[$id] = $cont->scalarval();
\r
3024 // add support for structures directly encoding php objects
\r
3027 $t = get_object_vars($b);
\r
3029 while(list($id,$cont) = @each($t))
\r
3031 $t[$id] = $cont->scalarval();
\r
3034 while(list($id,$cont) = @each($t))
\r
3044 * Returns the value of a scalar xmlrpcval
\r
3048 function scalarval()
\r
3051 list(,$b)=each($this->me);
\r
3056 * Returns the type of the xmlrpcval.
\r
3057 * For integers, 'int' is always returned in place of 'i4'
\r
3061 function scalartyp()
\r
3064 list($a,)=each($this->me);
\r
3065 if($a==$GLOBALS['xmlrpcI4'])
\r
3067 $a=$GLOBALS['xmlrpcInt'];
\r
3073 * Returns the m-th member of an xmlrpcval of struct type
\r
3074 * @param integer $m the index of the value to be retrieved (zero based)
\r
3075 * @return xmlrpcval
\r
3078 function arraymem($m)
\r
3080 return $this->me['array'][$m];
\r
3084 * Returns the number of members in an xmlrpcval of array type
\r
3088 function arraysize()
\r
3090 return count($this->me['array']);
\r
3094 * Returns the number of members in an xmlrpcval of struct type
\r
3098 function structsize()
\r
3100 return count($this->me['struct']);
\r
3108 * Given a timestamp, return the corresponding ISO8601 encoded string.
\r
3110 * Really, timezones ought to be supported
\r
3111 * but the XML-RPC spec says:
\r
3113 * "Don't assume a timezone. It should be specified by the server in its
\r
3114 * documentation what assumptions it makes about timezones."
\r
3116 * These routines always assume localtime unless
\r
3117 * $utc is set to 1, in which case UTC is assumed
\r
3118 * and an adjustment for locale is made when encoding
\r
3120 * @param int $timet (timestamp)
\r
3121 * @param int $utc (0 or 1)
\r
3124 function iso8601_encode($timet, $utc=0)
\r
3128 $t=i18n::formatted_datetime('iso8601UTC', $timet);
\r
3132 $t=i18n::formatted_datetime('iso8601UTC', $timet-date('Z'));
\r
3138 * Given an ISO8601 date string, return a timet in the localtime, or UTC
\r
3139 * @param string $idate
\r
3140 * @param int $utc either 0 or 1
\r
3141 * @return int (datetime)
\r
3143 function iso8601_decode($idate, $utc=0)
\r
3146 if(preg_match('/([0-9]{4})([0-9]{2})([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})/', $idate, $regs))
\r
3150 $t=gmmktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);
\r
3154 $t=mktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);
\r
3161 * Takes an xmlrpc value in PHP xmlrpcval object format and translates it into native PHP types.
\r
3163 * Works with xmlrpc message objects as input, too.
\r
3165 * Given proper options parameter, can rebuild generic php object instances
\r
3166 * (provided those have been encoded to xmlrpc format using a corresponding
\r
3167 * option in php_xmlrpc_encode())
\r
3168 * PLEASE NOTE that rebuilding php objects involves calling their constructor function.
\r
3169 * This means that the remote communication end can decide which php code will
\r
3170 * get executed on your server, leaving the door possibly open to 'php-injection'
\r
3171 * style of attacks (provided you have some classes defined on your server that
\r
3172 * might wreak havoc if instances are built outside an appropriate context).
\r
3173 * Make sure you trust the remote server/client before eanbling this!
\r
3175 * @author Dan Libby (dan@libby.com)
\r
3177 * @param xmlrpcval $xmlrpc_val
\r
3178 * @param array $options if 'decode_php_objs' is set in the options array, xmlrpc structs can be decoded into php objects
\r
3181 function php_xmlrpc_decode($xmlrpc_val, $options=array())
\r
3183 switch($xmlrpc_val->kindOf())
\r
3186 if (in_array('extension_api', $options))
\r
3188 reset($xmlrpc_val->me);
\r
3189 list($typ,$val) = each($xmlrpc_val->me);
\r
3192 case 'dateTime.iso8601':
\r
3193 $xmlrpc_val->scalar = $val;
\r
3194 $xmlrpc_val->xmlrpc_type = 'datetime';
\r
3195 $xmlrpc_val->timestamp = iso8601_decode($val);
\r
3196 return $xmlrpc_val;
\r
3198 $xmlrpc_val->scalar = $val;
\r
3199 $xmlrpc_val->type = $typ;
\r
3200 return $xmlrpc_val;
\r
3202 return $xmlrpc_val->scalarval();
\r
3205 return $xmlrpc_val->scalarval();
\r
3207 $size = $xmlrpc_val->arraysize();
\r
3209 for($i = 0; $i < $size; $i++)
\r
3211 $arr[] = php_xmlrpc_decode($xmlrpc_val->arraymem($i), $options);
\r
3215 $xmlrpc_val->structreset();
\r
3216 // If user said so, try to rebuild php objects for specific struct vals.
\r
3217 /// @todo should we raise a warning for class not found?
\r
3218 // shall we check for proper subclass of xmlrpcval instead of
\r
3219 // presence of _php_class to detect what we can do?
\r
3220 if (in_array('decode_php_objs', $options) && $xmlrpc_val->_php_class != ''
\r
3221 && class_exists($xmlrpc_val->_php_class))
\r
3223 $obj = @new $xmlrpc_val->_php_class;
\r
3224 while(list($key,$value)=$xmlrpc_val->structeach())
\r
3226 $obj->$key = php_xmlrpc_decode($value, $options);
\r
3233 while(list($key,$value)=$xmlrpc_val->structeach())
\r
3235 $arr[$key] = php_xmlrpc_decode($value, $options);
\r
3240 $paramcount = $xmlrpc_val->getNumParams();
\r
3242 for($i = 0; $i < $paramcount; $i++)
\r
3244 $arr[] = php_xmlrpc_decode($xmlrpc_val->getParam($i));
\r
3250 // This constant left here only for historical reasons...
\r
3251 // it was used to decide if we have to define xmlrpc_encode on our own, but
\r
3252 // we do not do it anymore
\r
3253 if(function_exists('xmlrpc_decode'))
\r
3255 define('XMLRPC_EPI_ENABLED','1');
\r
3259 define('XMLRPC_EPI_ENABLED','0');
\r
3263 * Takes native php types and encodes them into xmlrpc PHP object format.
\r
3264 * It will not re-encode xmlrpcval objects.
\r
3266 * Feature creep -- could support more types via optional type argument
\r
3267 * (string => datetime support has been added, ??? => base64 not yet)
\r
3269 * If given a proper options parameter, php object instances will be encoded
\r
3270 * into 'special' xmlrpc values, that can later be decoded into php objects
\r
3271 * by calling php_xmlrpc_decode() with a corresponding option
\r
3273 * @author Dan Libby (dan@libby.com)
\r
3275 * @param mixed $php_val the value to be converted into an xmlrpcval object
\r
3276 * @param array $options can include 'encode_php_objs', 'auto_dates', 'null_extension' or 'extension_api'
\r
3277 * @return xmlrpcval
\r
3279 function &php_xmlrpc_encode($php_val, $options=array())
\r
3281 $type = gettype($php_val);
\r
3285 if (in_array('auto_dates', $options) && preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $php_val))
\r
3286 $xmlrpc_val = new xmlrpcval($php_val, $GLOBALS['xmlrpcDateTime']);
\r
3288 $xmlrpc_val = new xmlrpcval($php_val, $GLOBALS['xmlrpcString']);
\r
3291 $xmlrpc_val = new xmlrpcval($php_val, $GLOBALS['xmlrpcInt']);
\r
3294 $xmlrpc_val = new xmlrpcval($php_val, $GLOBALS['xmlrpcDouble']);
\r
3296 // <G_Giunta_2001-02-29>
\r
3297 // Add support for encoding/decoding of booleans, since they are supported in PHP
\r
3299 $xmlrpc_val = new xmlrpcval($php_val, $GLOBALS['xmlrpcBoolean']);
\r
3301 // </G_Giunta_2001-02-29>
\r
3303 // PHP arrays can be encoded to either xmlrpc structs or arrays,
\r
3304 // depending on wheter they are hashes or plain 0..n integer indexed
\r
3305 // A shorter one-liner would be
\r
3306 // $tmp = array_diff(array_keys($php_val), range(0, count($php_val)-1));
\r
3307 // but execution time skyrockets!
\r
3311 foreach($php_val as $key => $val)
\r
3313 $arr[$key] =& php_xmlrpc_encode($val, $options);
\r
3314 if(!$ko && $key !== $j)
\r
3322 $xmlrpc_val = new xmlrpcval($arr, $GLOBALS['xmlrpcStruct']);
\r
3326 $xmlrpc_val = new xmlrpcval($arr, $GLOBALS['xmlrpcArray']);
\r
3330 if(is_a($php_val, 'xmlrpcval'))
\r
3332 $xmlrpc_val = $php_val;
\r
3337 while(list($k,$v) = each($php_val))
\r
3339 $arr[$k] = php_xmlrpc_encode($v, $options);
\r
3341 $xmlrpc_val = new xmlrpcval($arr, $GLOBALS['xmlrpcStruct']);
\r
3342 if (in_array('encode_php_objs', $options))
\r
3344 // let's save original class name into xmlrpcval:
\r
3345 // might be useful later on...
\r
3346 $xmlrpc_val->_php_class = get_class($php_val);
\r
3351 if (in_array('extension_api', $options))
\r
3353 $xmlrpc_val = new xmlrpcval('', $GLOBALS['xmlrpcString']);
\r
3355 if (in_array('null_extension', $options))
\r
3357 $xmlrpc_val = new xmlrpcval('', $GLOBALS['xmlrpcNull']);
\r
3361 $xmlrpc_val = new xmlrpcval();
\r
3365 if (in_array('extension_api', $options))
\r
3367 $xmlrpc_val = new xmlrpcval((int)$php_val, $GLOBALS['xmlrpcInt']);
\r
3371 $xmlrpc_val = new xmlrpcval();
\r
3373 // catch "user function", "unknown type"
\r
3375 // giancarlo pinerolo <ping@alt.it>
\r
3376 // it has to return
\r
3377 // an empty object in case, not a boolean.
\r
3378 $xmlrpc_val = new xmlrpcval();
\r
3381 return $xmlrpc_val;
\r
3385 * Convert the xml representation of a method response, method request or single
\r
3386 * xmlrpc value into the appropriate object (a.k.a. deserialize)
\r
3387 * @param string $xml_val
\r
3388 * @param array $options
\r
3389 * @return mixed false on error, or an instance of either xmlrpcval, xmlrpcmsg or xmlrpcresp
\r
3391 function php_xmlrpc_decode_xml($xml_val, $options=array())
\r
3393 $GLOBALS['_xh'] = array();
\r
3394 $GLOBALS['_xh']['ac'] = '';
\r
3395 $GLOBALS['_xh']['stack'] = array();
\r
3396 $GLOBALS['_xh']['valuestack'] = array();
\r
3397 $GLOBALS['_xh']['params'] = array();
\r
3398 $GLOBALS['_xh']['pt'] = array();
\r
3399 $GLOBALS['_xh']['isf'] = 0;
\r
3400 $GLOBALS['_xh']['isf_reason'] = '';
\r
3401 $GLOBALS['_xh']['method'] = false;
\r
3402 $GLOBALS['_xh']['rt'] = '';
\r
3403 /// @todo 'guestimate' encoding
\r
3404 $parser = xml_parser_create();
\r
3405 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true);
\r
3406 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $GLOBALS['xmlrpc_internalencoding']);
\r
3407 xml_set_element_handler($parser, 'xmlrpc_se_any', 'xmlrpc_ee');
\r
3408 xml_set_character_data_handler($parser, 'xmlrpc_cd');
\r
3409 xml_set_default_handler($parser, 'xmlrpc_dh');
\r
3410 if(!xml_parse($parser, $xml_val, 1))
\r
3412 $errstr = sprintf('XML error: %s at line %d, column %d',
\r
3413 xml_error_string(xml_get_error_code($parser)),
\r
3414 xml_get_current_line_number($parser), xml_get_current_column_number($parser));
\r
3415 error_log($errstr);
\r
3416 xml_parser_free($parser);
\r
3419 xml_parser_free($parser);
\r
3420 if ($GLOBALS['_xh']['isf'] > 1) // test that $GLOBALS['_xh']['value'] is an obj, too???
\r
3422 error_log($GLOBALS['_xh']['isf_reason']);
\r
3425 switch ($GLOBALS['_xh']['rt'])
\r
3427 case 'methodresponse':
\r
3428 $v =& $GLOBALS['_xh']['value'];
\r
3429 if ($GLOBALS['_xh']['isf'] == 1)
\r
3431 $vc = $v->structmem('faultCode');
\r
3432 $vs = $v->structmem('faultString');
\r
3433 $r = new xmlrpcresp(0, $vc->scalarval(), $vs->scalarval());
\r
3437 $r = new xmlrpcresp($v);
\r
3440 case 'methodcall':
\r
3441 $m = new xmlrpcmsg($GLOBALS['_xh']['method']);
\r
3442 for($i=0; $i < count($GLOBALS['_xh']['params']); $i++)
\r
3444 $m->addParam($GLOBALS['_xh']['params'][$i]);
\r
3448 return $GLOBALS['_xh']['value'];
\r
3455 * decode a string that is encoded w/ "chunked" transfer encoding
\r
3456 * as defined in rfc2068 par. 19.4.6
\r
3457 * code shamelessly stolen from nusoap library by Dietrich Ayala
\r
3459 * @param string $buffer the string to be decoded
\r
3462 function decode_chunked($buffer)
\r
3468 // read chunk-size, chunk-extension (if any) and crlf
\r
3469 // get the position of the linebreak
\r
3470 $chunkend = i18n::strpos($buffer,"\r\n") + 2;
\r
3471 $temp = i18n::substr($buffer,0,$chunkend);
\r
3472 $chunk_size = hexdec( trim($temp) );
\r
3473 $chunkstart = $chunkend;
\r
3474 while($chunk_size > 0)
\r
3476 $chunkend = i18n::strpos($buffer, "\r\n", $chunkstart + $chunk_size);
\r
3478 // just in case we got a broken connection
\r
3479 if($chunkend == false)
\r
3481 $chunk = i18n::substr($buffer,$chunkstart);
\r
3482 // append chunk-data to entity-body
\r
3484 $length += i18n::strlen($chunk);
\r
3488 // read chunk-data and crlf
\r
3489 $chunk = i18n::substr($buffer,$chunkstart,$chunkend-$chunkstart);
\r
3490 // append chunk-data to entity-body
\r
3492 // length := length + chunk-size
\r
3493 $length += i18n::strlen($chunk);
\r
3494 // read chunk-size and crlf
\r
3495 $chunkstart = $chunkend + 2;
\r
3497 $chunkend = i18n::strpos($buffer,"\r\n",$chunkstart)+2;
\r
3498 if($chunkend == false)
\r
3500 break; //just in case we got a broken connection
\r
3502 $temp = i18n::substr($buffer,$chunkstart,$chunkend-$chunkstart);
\r
3503 $chunk_size = hexdec( trim($temp) );
\r
3504 $chunkstart = $chunkend;
\r
3510 * xml charset encoding guessing helper function.
\r
3511 * Tries to determine the charset encoding of an XML chunk
\r
3512 * received over HTTP.
\r
3513 * NB: according to the spec (RFC 3023, if text/xml content-type is received over HTTP without a content-type,
\r
3514 * we SHOULD assume it is strictly US-ASCII. But we try to be more tolerant of unconforming (legacy?) clients/servers,
\r
3515 * which will be most probably using UTF-8 anyway...
\r
3517 * @param string $httpheaders the http Content-type header
\r
3518 * @param string $xmlchunk xml content buffer
\r
3519 * @param string $encoding_prefs comma separated list of character encodings to be used as default (when mb extension is enabled)
\r
3521 * @todo explore usage of mb_http_input(): does it detect http headers + post data? if so, use it instead of hand-detection!!!
\r
3523 function guess_encoding($httpheader='', $xmlchunk='', $encoding_prefs=null)
\r
3525 // discussion: see http://www.yale.edu/pclt/encoding/
\r
3526 // 1 - test if encoding is specified in HTTP HEADERS
\r
3529 // LWS: (\13\10)?( |\t)+
\r
3530 // token: (any char but excluded stuff)+
\r
3531 // header: Content-type = ...; charset=value(; ...)*
\r
3532 // where value is of type token, no LWS allowed between 'charset' and value
\r
3533 // Note: we do not check for invalid chars in VALUE:
\r
3534 // this had better be done using pure ereg as below
\r
3536 /// @todo this test will pass if ANY header has charset specification, not only Content-Type. Fix it?
\r
3537 $matches = array();
\r
3538 if(preg_match('/;\s*charset=([^;]+)/i', $httpheader, $matches))
\r
3540 return strtoupper(trim($matches[1]));
\r
3543 // 2 - scan the first bytes of the data for a UTF-16 (or other) BOM pattern
\r
3544 // (source: http://www.w3.org/TR/2000/REC-xml-20001006)
\r
3545 // NOTE: actually, according to the spec, even if we find the BOM and determine
\r
3546 // an encoding, we should check if there is an encoding specified
\r
3547 // in the xml declaration, and verify if they match.
\r
3548 /// @todo implement check as described above?
\r
3549 /// @todo implement check for first bytes of string even without a BOM? (It sure looks harder than for cases WITH a BOM)
\r
3550 if(preg_match('/^(\x00\x00\xFE\xFF|\xFF\xFE\x00\x00|\x00\x00\xFF\xFE|\xFE\xFF\x00\x00)/', $xmlchunk))
\r
3554 elseif(preg_match('/^(\xFE\xFF|\xFF\xFE)/', $xmlchunk))
\r
3558 elseif(preg_match('/^(\xEF\xBB\xBF)/', $xmlchunk))
\r
3563 // 3 - test if encoding is specified in the xml declaration
\r
3565 // SPACE: (#x20 | #x9 | #xD | #xA)+ === [ \x9\xD\xA]+
\r
3566 // EQ: SPACE?=SPACE? === [ \x9\xD\xA]*=[ \x9\xD\xA]*
\r
3567 if (preg_match('/^<\?xml\s+version\s*=\s*'. "((?:\"[a-zA-Z0-9_.:-]+\")|(?:'[a-zA-Z0-9_.:-]+'))".
\r
3568 '\s+encoding\s*=\s*' . "((?:\"[A-Za-z][A-Za-z0-9._-]*\")|(?:'[A-Za-z][A-Za-z0-9._-]*'))/",
\r
3569 $xmlchunk, $matches))
\r
3571 return strtoupper(i18n::substr($matches[2], 1, -1));
\r
3574 // 4 - if mbstring is available, let it do the guesswork
\r
3575 // NB: we favour finding an encoding that is compatible with what we can process
\r
3576 if(extension_loaded('mbstring'))
\r
3578 if($encoding_prefs)
\r
3580 $enc = mb_detect_encoding($xmlchunk, $encoding_prefs);
\r
3584 $enc = mb_detect_encoding($xmlchunk);
\r
3586 // NB: mb_detect likes to call it ascii, xml parser likes to call it US_ASCII...
\r
3587 // IANA also likes better US-ASCII, so go with it
\r
3588 if($enc == 'ASCII')
\r
3590 $enc = 'US-'.$enc;
\r
3596 // no encoding specified: as per HTTP1.1 assume it is iso-8859-1?
\r
3597 // Both RFC 2616 (HTTP 1.1) and 1945(http 1.0) clearly state that for text/xxx content types
\r
3598 // this should be the standard. And we should be getting text/xml as request and response.
\r
3599 // BUT we have to be backward compatible with the lib, which always used UTF-8 as default...
\r
3600 return $GLOBALS['xmlrpc_defencoding'];
\r
3605 * Checks if a given charset encoding is present in a list of encodings or
\r
3606 * if it is a valid subset of any encoding in the list
\r
3607 * @param string $encoding charset to be tested
\r
3608 * @param mixed $validlist comma separated list of valid charsets (or array of charsets)
\r
3610 function is_valid_charset($encoding, $validlist)
\r
3612 $charset_supersets = array(
\r
3613 'US-ASCII' => array ('ISO-8859-1', 'ISO-8859-2', 'ISO-8859-3', 'ISO-8859-4',
\r
3614 'ISO-8859-5', 'ISO-8859-6', 'ISO-8859-7', 'ISO-8859-8',
\r
3615 'ISO-8859-9', 'ISO-8859-10', 'ISO-8859-11', 'ISO-8859-12',
\r
3616 'ISO-8859-13', 'ISO-8859-14', 'ISO-8859-15', 'UTF-8',
\r
3617 'EUC-JP', 'EUC-', 'EUC-KR', 'EUC-CN')
\r
3619 if (is_string($validlist))
\r
3620 $validlist = preg_split('#,#', $validlist);
\r
3621 if (@in_array(strtoupper($encoding), $validlist))
\r
3625 if (array_key_exists($encoding, $charset_supersets))
\r
3626 foreach ($validlist as $allowed)
\r
3627 if (in_array($allowed, $charset_supersets[$encoding]))
\r
OSDN Git Service
