2 // by Edd Dumbill (C) 1999-2002
\r
3 // <edd@usefulinc.com>
\r
4 // $Id: xmlrpc.inc,v 1.174 2009/03/16 19:36:38 ggiunta Exp $
\r
6 // Copyright (c) 1999,2000,2002 Edd Dumbill.
\r
7 // All rights reserved.
\r
9 // Redistribution and use in source and binary forms, with or without
\r
10 // modification, are permitted provided that the following conditions
\r
13 // * Redistributions of source code must retain the above copyright
\r
14 // notice, this list of conditions and the following disclaimer.
\r
16 // * Redistributions in binary form must reproduce the above
\r
17 // copyright notice, this list of conditions and the following
\r
18 // disclaimer in the documentation and/or other materials provided
\r
19 // with the distribution.
\r
21 // * Neither the name of the "XML-RPC for PHP" nor the names of its
\r
22 // contributors may be used to endorse or promote products derived
\r
23 // from this software without specific prior written permission.
\r
25 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
\r
26 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
\r
27 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
\r
28 // FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
\r
29 // REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
\r
30 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
\r
31 // (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
\r
32 // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
\r
33 // HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
\r
34 // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
\r
35 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
\r
36 // OF THE POSSIBILITY OF SUCH DAMAGE.
\r
38 if(!function_exists('xml_parser_create'))
\r
40 // For PHP 4 onward, XML functionality is always compiled-in on windows:
\r
41 // no more need to dl-open it. It might have been compiled out on *nix...
\r
42 if(strtoupper(substr(PHP_OS, 0, 3) != 'WIN'))
\r
48 // Try to be backward compat with php < 4.2 (are we not being nice ?)
\r
49 $phpversion = phpversion();
\r
50 if($phpversion[0] == '4' && $phpversion[2] < 2)
\r
52 // give an opportunity to user to specify where to include other files from
\r
53 if(!defined('PHP_XMLRPC_COMPAT_DIR'))
\r
55 define('PHP_XMLRPC_COMPAT_DIR',dirname(__FILE__).'/compat/');
\r
57 if($phpversion[2] == '0')
\r
59 if($phpversion[4] < 6)
\r
61 include(PHP_XMLRPC_COMPAT_DIR.'is_callable.php');
\r
63 include(PHP_XMLRPC_COMPAT_DIR.'is_scalar.php');
\r
64 include(PHP_XMLRPC_COMPAT_DIR.'array_key_exists.php');
\r
65 include(PHP_XMLRPC_COMPAT_DIR.'version_compare.php');
\r
67 include(PHP_XMLRPC_COMPAT_DIR.'var_export.php');
\r
68 include(PHP_XMLRPC_COMPAT_DIR.'is_a.php');
\r
71 // G. Giunta 2005/01/29: declare global these variables,
\r
72 // so that xmlrpc.inc will work even if included from within a function
\r
73 // Milosch: 2005/08/07 - explicitly request these via $GLOBALS where used.
\r
74 $GLOBALS['xmlrpcI4']='i4';
\r
75 $GLOBALS['xmlrpcInt']='int';
\r
76 $GLOBALS['xmlrpcBoolean']='boolean';
\r
77 $GLOBALS['xmlrpcDouble']='double';
\r
78 $GLOBALS['xmlrpcString']='string';
\r
79 $GLOBALS['xmlrpcDateTime']='dateTime.iso8601';
\r
80 $GLOBALS['xmlrpcBase64']='base64';
\r
81 $GLOBALS['xmlrpcArray']='array';
\r
82 $GLOBALS['xmlrpcStruct']='struct';
\r
83 $GLOBALS['xmlrpcValue']='undefined';
\r
85 $GLOBALS['xmlrpcTypes']=array(
\r
86 $GLOBALS['xmlrpcI4'] => 1,
\r
87 $GLOBALS['xmlrpcInt'] => 1,
\r
88 $GLOBALS['xmlrpcBoolean'] => 1,
\r
89 $GLOBALS['xmlrpcString'] => 1,
\r
90 $GLOBALS['xmlrpcDouble'] => 1,
\r
91 $GLOBALS['xmlrpcDateTime'] => 1,
\r
92 $GLOBALS['xmlrpcBase64'] => 1,
\r
93 $GLOBALS['xmlrpcArray'] => 2,
\r
94 $GLOBALS['xmlrpcStruct'] => 3
\r
97 $GLOBALS['xmlrpc_valid_parents'] = array(
\r
98 'VALUE' => array('MEMBER', 'DATA', 'PARAM', 'FAULT'),
\r
99 'BOOLEAN' => array('VALUE'),
\r
100 'I4' => array('VALUE'),
\r
101 'INT' => array('VALUE'),
\r
102 'STRING' => array('VALUE'),
\r
103 'DOUBLE' => array('VALUE'),
\r
104 'DATETIME.ISO8601' => array('VALUE'),
\r
105 'BASE64' => array('VALUE'),
\r
106 'MEMBER' => array('STRUCT'),
\r
107 'NAME' => array('MEMBER'),
\r
108 'DATA' => array('ARRAY'),
\r
109 'ARRAY' => array('VALUE'),
\r
110 'STRUCT' => array('VALUE'),
\r
111 'PARAM' => array('PARAMS'),
\r
112 'METHODNAME' => array('METHODCALL'),
\r
113 'PARAMS' => array('METHODCALL', 'METHODRESPONSE'),
\r
114 'FAULT' => array('METHODRESPONSE'),
\r
115 'NIL' => array('VALUE') // only used when extension activated
\r
118 // define extra types for supporting NULL (useful for json or <NIL/>)
\r
119 $GLOBALS['xmlrpcNull']='null';
\r
120 $GLOBALS['xmlrpcTypes']['null']=1;
\r
122 // Not in use anymore since 2.0. Shall we remove it?
\r
124 $GLOBALS['xmlEntities']=array(
\r
132 // tables used for transcoding different charsets into us-ascii xml
\r
134 $GLOBALS['xml_iso88591_Entities']=array();
\r
135 $GLOBALS['xml_iso88591_Entities']['in'] = array();
\r
136 $GLOBALS['xml_iso88591_Entities']['out'] = array();
\r
137 for ($i = 0; $i < 32; $i++)
\r
139 $GLOBALS['xml_iso88591_Entities']['in'][] = chr($i);
\r
140 $GLOBALS['xml_iso88591_Entities']['out'][] = '&#'.$i.';';
\r
142 for ($i = 160; $i < 256; $i++)
\r
144 $GLOBALS['xml_iso88591_Entities']['in'][] = chr($i);
\r
145 $GLOBALS['xml_iso88591_Entities']['out'][] = '&#'.$i.';';
\r
148 /// @todo add to iso table the characters from cp_1252 range, i.e. 128 to 159?
\r
149 /// These will NOT be present in true ISO-8859-1, but will save the unwary
\r
150 /// windows user from sending junk (though no luck when reciving them...)
\r
152 $GLOBALS['xml_cp1252_Entities']=array();
\r
153 for ($i = 128; $i < 160; $i++)
\r
155 $GLOBALS['xml_cp1252_Entities']['in'][] = chr($i);
\r
157 $GLOBALS['xml_cp1252_Entities']['out'] = array(
\r
158 '€', '?', '‚', 'ƒ',
\r
159 '„', '…', '†', '‡',
\r
160 'ˆ', '‰', 'Š', '‹',
\r
161 'Œ', '?', 'Ž', '?',
\r
162 '?', '‘', '’', '“',
\r
163 '”', '•', '–', '—',
\r
164 '˜', '™', 'š', '›',
\r
165 'œ', '?', 'ž', 'Ÿ'
\r
169 $GLOBALS['xmlrpcerr'] = array(
\r
170 'unknown_method'=>1,
\r
171 'invalid_return'=>2,
\r
172 'incorrect_params'=>3,
\r
173 'introspect_unknown'=>4,
\r
178 'invalid_request'=>15,
\r
180 'server_error'=>17,
\r
181 'multicall_error'=>18,
\r
182 'multicall_notstruct'=>9,
\r
183 'multicall_nomethod'=>10,
\r
184 'multicall_notstring'=>11,
\r
185 'multicall_recursion'=>12,
\r
186 'multicall_noparams'=>13,
\r
187 'multicall_notarray'=>14,
\r
189 'cannot_decompress'=>103,
\r
190 'decompress_fail'=>104,
\r
191 'dechunk_fail'=>105,
\r
192 'server_cannot_decompress'=>106,
\r
193 'server_decompress_fail'=>107
\r
196 $GLOBALS['xmlrpcstr'] = array(
\r
197 'unknown_method'=>'Unknown method',
\r
198 'invalid_return'=>'Invalid return payload: enable debugging to examine incoming payload',
\r
199 'incorrect_params'=>'Incorrect parameters passed to method',
\r
200 'introspect_unknown'=>"Can't introspect: method unknown",
\r
201 'http_error'=>"Didn't receive 200 OK from remote server.",
\r
202 'no_data'=>'No data received from server.',
\r
203 'no_ssl'=>'No SSL support compiled in.',
\r
204 'curl_fail'=>'CURL error',
\r
205 'invalid_request'=>'Invalid request payload',
\r
206 'no_curl'=>'No CURL support compiled in.',
\r
207 'server_error'=>'Internal server error',
\r
208 'multicall_error'=>'Received from server invalid multicall response',
\r
209 'multicall_notstruct'=>'system.multicall expected struct',
\r
210 'multicall_nomethod'=>'missing methodName',
\r
211 'multicall_notstring'=>'methodName is not a string',
\r
212 'multicall_recursion'=>'recursive system.multicall forbidden',
\r
213 'multicall_noparams'=>'missing params',
\r
214 'multicall_notarray'=>'params is not an array',
\r
216 'cannot_decompress'=>'Received from server compressed HTTP and cannot decompress',
\r
217 'decompress_fail'=>'Received from server invalid compressed HTTP',
\r
218 'dechunk_fail'=>'Received from server invalid chunked HTTP',
\r
219 'server_cannot_decompress'=>'Received from client compressed HTTP request and cannot decompress',
\r
220 'server_decompress_fail'=>'Received from client invalid compressed HTTP request'
\r
223 // The charset encoding used by the server for received messages and
\r
224 // by the client for received responses when received charset cannot be determined
\r
225 // or is not supported
\r
226 $GLOBALS['xmlrpc_defencoding']='UTF-8';
\r
228 // The encoding used internally by PHP.
\r
229 // String values received as xml will be converted to this, and php strings will be converted to xml
\r
230 // as if having been coded with this
\r
231 $GLOBALS['xmlrpc_internalencoding']='ISO-8859-1';
\r
233 $GLOBALS['xmlrpcName']='XML-RPC for PHP';
\r
234 $GLOBALS['xmlrpcVersion']='2.2.2';
\r
236 // let user errors start at 800
\r
237 $GLOBALS['xmlrpcerruser']=800;
\r
238 // let XML parse errors start at 100
\r
239 $GLOBALS['xmlrpcerrxml']=100;
\r
241 // formulate backslashes for escaping regexp
\r
242 // Not in use anymore since 2.0. Shall we remove it?
\r
244 $GLOBALS['xmlrpc_backslash']=chr(92).chr(92);
\r
246 // set to TRUE to enable correct decoding of <NIL/> values
\r
247 $GLOBALS['xmlrpc_null_extension']=false;
\r
249 // used to store state during parsing
\r
250 // quick explanation of components:
\r
251 // ac - used to accumulate values
\r
252 // isf - used to indicate a parsing fault (2) or xmlrpcresp fault (1)
\r
253 // isf_reason - used for storing xmlrpcresp fault string
\r
254 // lv - used to indicate "looking for a value": implements
\r
255 // the logic to allow values with no types to be strings
\r
256 // params - used to store parameters in method calls
\r
257 // method - used to store method name
\r
258 // stack - array with genealogy of xml elements names:
\r
259 // used to validate nesting of xmlrpc elements
\r
260 $GLOBALS['_xh']=null;
\r
263 * Convert a string to the correct XML representation in a target charset
\r
264 * To help correct communication of non-ascii chars inside strings, regardless
\r
265 * of the charset used when sending requests, parsing them, sending responses
\r
266 * and parsing responses, an option is to convert all non-ascii chars present in the message
\r
267 * into their equivalent 'charset entity'. Charset entities enumerated this way
\r
268 * are independent of the charset encoding used to transmit them, and all XML
\r
269 * parsers are bound to understand them.
\r
270 * Note that in the std case we are not sending a charset encoding mime type
\r
271 * along with http headers, so we are bound by RFC 3023 to emit strict us-ascii.
\r
273 * @todo do a bit of basic benchmarking (strtr vs. str_replace)
\r
274 * @todo make usage of iconv() or recode_string() or mb_string() where available
\r
276 function xmlrpc_encode_entitites($data, $src_encoding='', $dest_encoding='')
\r
278 if ($src_encoding == '')
\r
280 // lame, but we know no better...
\r
281 $src_encoding = $GLOBALS['xmlrpc_internalencoding'];
\r
284 switch(strtoupper($src_encoding.'_'.$dest_encoding))
\r
286 case 'ISO-8859-1_':
\r
287 case 'ISO-8859-1_US-ASCII':
\r
288 $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
\r
289 $escaped_data = str_replace($GLOBALS['xml_iso88591_Entities']['in'], $GLOBALS['xml_iso88591_Entities']['out'], $escaped_data);
\r
291 case 'ISO-8859-1_UTF-8':
\r
292 $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
\r
293 $escaped_data = utf8_encode($escaped_data);
\r
295 case 'ISO-8859-1_ISO-8859-1':
\r
296 case 'US-ASCII_US-ASCII':
\r
297 case 'US-ASCII_UTF-8':
\r
299 case 'US-ASCII_ISO-8859-1':
\r
300 case 'UTF-8_UTF-8':
\r
301 //case 'CP1252_CP1252':
\r
302 $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
\r
305 case 'UTF-8_US-ASCII':
\r
306 case 'UTF-8_ISO-8859-1':
\r
307 // NB: this will choke on invalid UTF-8, going most likely beyond EOF
\r
308 $escaped_data = '';
\r
309 // be kind to users creating string xmlrpcvals out of different php types
\r
310 $data = (string) $data;
\r
311 $ns = strlen ($data);
\r
312 for ($nn = 0; $nn < $ns; $nn++)
\r
316 //1 7 0bbbbbbb (127)
\r
319 /// @todo shall we replace this with a (supposedly) faster str_replace?
\r
322 $escaped_data .= '"';
\r
325 $escaped_data .= '&';
\r
328 $escaped_data .= ''';
\r
331 $escaped_data .= '<';
\r
334 $escaped_data .= '>';
\r
337 $escaped_data .= $ch;
\r
340 //2 11 110bbbbb 10bbbbbb (2047)
\r
341 else if ($ii>>5 == 6)
\r
344 $ii = ord($data[$nn+1]);
\r
346 $ii = ($b1 * 64) + $b2;
\r
347 $ent = sprintf ('&#%d;', $ii);
\r
348 $escaped_data .= $ent;
\r
351 //3 16 1110bbbb 10bbbbbb 10bbbbbb
\r
352 else if ($ii>>4 == 14)
\r
355 $ii = ord($data[$nn+1]);
\r
357 $ii = ord($data[$nn+2]);
\r
359 $ii = ((($b1 * 64) + $b2) * 64) + $b3;
\r
360 $ent = sprintf ('&#%d;', $ii);
\r
361 $escaped_data .= $ent;
\r
364 //4 21 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb
\r
365 else if ($ii>>3 == 30)
\r
368 $ii = ord($data[$nn+1]);
\r
370 $ii = ord($data[$nn+2]);
\r
372 $ii = ord($data[$nn+3]);
\r
374 $ii = ((((($b1 * 64) + $b2) * 64) + $b3) * 64) + $b4;
\r
375 $ent = sprintf ('&#%d;', $ii);
\r
376 $escaped_data .= $ent;
\r
383 case 'CP1252_US-ASCII':
\r
384 $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
\r
385 $escaped_data = str_replace($GLOBALS['xml_iso88591_Entities']['in'], $GLOBALS['xml_iso88591_Entities']['out'], $escaped_data);
\r
386 $escaped_data = str_replace($GLOBALS['xml_cp1252_Entities']['in'], $GLOBALS['xml_cp1252_Entities']['out'], $escaped_data);
\r
388 case 'CP1252_UTF-8':
\r
389 $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
\r
390 /// @todo we could use real UTF8 chars here instead of xml entities... (note that utf_8 encode all allone will NOT convert them)
\r
391 $escaped_data = str_replace($GLOBALS['xml_cp1252_Entities']['in'], $GLOBALS['xml_cp1252_Entities']['out'], $escaped_data);
\r
392 $escaped_data = utf8_encode($escaped_data);
\r
394 case 'CP1252_ISO-8859-1':
\r
395 $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
\r
396 // we might as well replave all funky chars with a '?' here, but we are kind and leave it to the receiving application layer to decide what to do with these weird entities...
\r
397 $escaped_data = str_replace($GLOBALS['xml_cp1252_Entities']['in'], $GLOBALS['xml_cp1252_Entities']['out'], $escaped_data);
\r
401 $escaped_data = '';
\r
402 error_log("Converting from $src_encoding to $dest_encoding: not supported...");
\r
404 return $escaped_data;
\r
407 /// xml parser handler function for opening element tags
\r
408 function xmlrpc_se($parser, $name, $attrs, $accept_single_vals=false)
\r
410 // if invalid xmlrpc already detected, skip all processing
\r
411 if ($GLOBALS['_xh']['isf'] < 2)
\r
413 // check for correct element nesting
\r
414 // top level element can only be of 2 types
\r
415 /// @todo optimization creep: save this check into a bool variable, instead of using count() every time:
\r
416 /// there is only a single top level element in xml anyway
\r
417 if (count($GLOBALS['_xh']['stack']) == 0)
\r
419 if ($name != 'METHODRESPONSE' && $name != 'METHODCALL' && (
\r
420 $name != 'VALUE' && !$accept_single_vals))
\r
422 $GLOBALS['_xh']['isf'] = 2;
\r
423 $GLOBALS['_xh']['isf_reason'] = 'missing top level xmlrpc element';
\r
428 $GLOBALS['_xh']['rt'] = strtolower($name);
\r
433 // not top level element: see if parent is OK
\r
434 $parent = end($GLOBALS['_xh']['stack']);
\r
435 if (!array_key_exists($name, $GLOBALS['xmlrpc_valid_parents']) || !in_array($parent, $GLOBALS['xmlrpc_valid_parents'][$name]))
\r
437 $GLOBALS['_xh']['isf'] = 2;
\r
438 $GLOBALS['_xh']['isf_reason'] = "xmlrpc element $name cannot be child of $parent";
\r
445 // optimize for speed switch cases: most common cases first
\r
447 /// @todo we could check for 2 VALUE elements inside a MEMBER or PARAM element
\r
448 $GLOBALS['_xh']['vt']='value'; // indicator: no value found yet
\r
449 $GLOBALS['_xh']['ac']='';
\r
450 $GLOBALS['_xh']['lv']=1;
\r
451 $GLOBALS['_xh']['php_class']=null;
\r
458 case 'DATETIME.ISO8601':
\r
460 if ($GLOBALS['_xh']['vt']!='value')
\r
462 //two data elements inside a value: an error occurred!
\r
463 $GLOBALS['_xh']['isf'] = 2;
\r
464 $GLOBALS['_xh']['isf_reason'] = "$name element following a {$GLOBALS['_xh']['vt']} element inside a single value";
\r
467 $GLOBALS['_xh']['ac']=''; // reset the accumulator
\r
471 if ($GLOBALS['_xh']['vt']!='value')
\r
473 //two data elements inside a value: an error occurred!
\r
474 $GLOBALS['_xh']['isf'] = 2;
\r
475 $GLOBALS['_xh']['isf_reason'] = "$name element following a {$GLOBALS['_xh']['vt']} element inside a single value";
\r
478 // create an empty array to hold child values, and push it onto appropriate stack
\r
479 $cur_val = array();
\r
480 $cur_val['values'] = array();
\r
481 $cur_val['type'] = $name;
\r
482 // check for out-of-band information to rebuild php objs
\r
483 // and in case it is found, save it
\r
484 if (@isset($attrs['PHP_CLASS']))
\r
486 $cur_val['php_class'] = $attrs['PHP_CLASS'];
\r
488 $GLOBALS['_xh']['valuestack'][] = $cur_val;
\r
489 $GLOBALS['_xh']['vt']='data'; // be prepared for a data element next
\r
492 if ($GLOBALS['_xh']['vt']!='data')
\r
494 //two data elements inside a value: an error occurred!
\r
495 $GLOBALS['_xh']['isf'] = 2;
\r
496 $GLOBALS['_xh']['isf_reason'] = "found two data elements inside an array element";
\r
500 case 'METHODRESPONSE':
\r
502 // valid elements that add little to processing
\r
506 /// @todo we could check for 2 NAME elements inside a MEMBER element
\r
507 $GLOBALS['_xh']['ac']='';
\r
510 $GLOBALS['_xh']['isf']=1;
\r
513 $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
514 //$GLOBALS['_xh']['ac']='';
\r
515 // Drop trough intentionally
\r
517 // clear value type, so we can check later if no value has been passed for this param/member
\r
518 $GLOBALS['_xh']['vt']=null;
\r
521 if ($GLOBALS['xmlrpc_null_extension'])
\r
523 if ($GLOBALS['_xh']['vt']!='value')
\r
525 //two data elements inside a value: an error occurred!
\r
526 $GLOBALS['_xh']['isf'] = 2;
\r
527 $GLOBALS['_xh']['isf_reason'] = "$name element following a {$GLOBALS['_xh']['vt']} element inside a single value";
\r
530 $GLOBALS['_xh']['ac']=''; // reset the accumulator
\r
533 // we do not support the <NIL/> extension, so
\r
534 // drop through intentionally
\r
536 /// INVALID ELEMENT: RAISE ISF so that it is later recognized!!!
\r
537 $GLOBALS['_xh']['isf'] = 2;
\r
538 $GLOBALS['_xh']['isf_reason'] = "found not-xmlrpc xml element $name";
\r
542 // Save current element name to stack, to validate nesting
\r
543 $GLOBALS['_xh']['stack'][] = $name;
\r
545 /// @todo optimization creep: move this inside the big switch() above
\r
548 $GLOBALS['_xh']['lv']=0;
\r
553 /// Used in decoding xml chunks that might represent single xmlrpc values
\r
554 function xmlrpc_se_any($parser, $name, $attrs)
\r
556 xmlrpc_se($parser, $name, $attrs, true);
\r
559 /// xml parser handler function for close element tags
\r
560 function xmlrpc_ee($parser, $name, $rebuild_xmlrpcvals = true)
\r
562 if ($GLOBALS['_xh']['isf'] < 2)
\r
564 // push this element name from stack
\r
565 // NB: if XML validates, correct opening/closing is guaranteed and
\r
566 // we do not have to check for $name == $curr_elem.
\r
567 // we also checked for proper nesting at start of elements...
\r
568 $curr_elem = array_pop($GLOBALS['_xh']['stack']);
\r
573 // This if() detects if no scalar was inside <VALUE></VALUE>
\r
574 if ($GLOBALS['_xh']['vt']=='value')
\r
576 $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac'];
\r
577 $GLOBALS['_xh']['vt']=$GLOBALS['xmlrpcString'];
\r
580 if ($rebuild_xmlrpcvals)
\r
582 // build the xmlrpc val out of the data received, and substitute it
\r
583 $temp =& new xmlrpcval($GLOBALS['_xh']['value'], $GLOBALS['_xh']['vt']);
\r
584 // in case we got info about underlying php class, save it
\r
585 // in the object we're rebuilding
\r
586 if (isset($GLOBALS['_xh']['php_class']))
\r
587 $temp->_php_class = $GLOBALS['_xh']['php_class'];
\r
588 // check if we are inside an array or struct:
\r
589 // if value just built is inside an array, let's move it into array on the stack
\r
590 $vscount = count($GLOBALS['_xh']['valuestack']);
\r
591 if ($vscount && $GLOBALS['_xh']['valuestack'][$vscount-1]['type']=='ARRAY')
\r
593 $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][] = $temp;
\r
597 $GLOBALS['_xh']['value'] = $temp;
\r
602 /// @todo this needs to treat correctly php-serialized objects,
\r
603 /// since std deserializing is done by php_xmlrpc_decode,
\r
604 /// which we will not be calling...
\r
605 if (isset($GLOBALS['_xh']['php_class']))
\r
609 // check if we are inside an array or struct:
\r
610 // if value just built is inside an array, let's move it into array on the stack
\r
611 $vscount = count($GLOBALS['_xh']['valuestack']);
\r
612 if ($vscount && $GLOBALS['_xh']['valuestack'][$vscount-1]['type']=='ARRAY')
\r
614 $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][] = $GLOBALS['_xh']['value'];
\r
623 case 'DATETIME.ISO8601':
\r
625 $GLOBALS['_xh']['vt']=strtolower($name);
\r
626 /// @todo: optimization creep - remove the if/elseif cycle below
\r
627 /// since the case() in which we are already did that
\r
628 if ($name=='STRING')
\r
630 $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac'];
\r
632 elseif ($name=='DATETIME.ISO8601')
\r
634 if (!preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $GLOBALS['_xh']['ac']))
\r
636 error_log('XML-RPC: invalid value received in DATETIME: '.$GLOBALS['_xh']['ac']);
\r
638 $GLOBALS['_xh']['vt']=$GLOBALS['xmlrpcDateTime'];
\r
639 $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac'];
\r
641 elseif ($name=='BASE64')
\r
643 /// @todo check for failure of base64 decoding / catch warnings
\r
644 $GLOBALS['_xh']['value']=base64_decode($GLOBALS['_xh']['ac']);
\r
646 elseif ($name=='BOOLEAN')
\r
648 // special case here: we translate boolean 1 or 0 into PHP
\r
649 // constants true or false.
\r
650 // Strings 'true' and 'false' are accepted, even though the
\r
651 // spec never mentions them (see eg. Blogger api docs)
\r
652 // NB: this simple checks helps a lot sanitizing input, ie no
\r
653 // security problems around here
\r
654 if ($GLOBALS['_xh']['ac']=='1' || strcasecmp($GLOBALS['_xh']['ac'], 'true') == 0)
\r
656 $GLOBALS['_xh']['value']=true;
\r
660 // log if receiveing something strange, even though we set the value to false anyway
\r
661 if ($GLOBALS['_xh']['ac']!='0' && strcasecmp($GLOBALS['_xh']['ac'], 'false') != 0)
\r
662 error_log('XML-RPC: invalid value received in BOOLEAN: '.$GLOBALS['_xh']['ac']);
\r
663 $GLOBALS['_xh']['value']=false;
\r
666 elseif ($name=='DOUBLE')
\r
668 // we have a DOUBLE
\r
669 // we must check that only 0123456789-.<space> are characters here
\r
670 // NOTE: regexp could be much stricter than this...
\r
671 if (!preg_match('/^[+-eE0123456789 \t.]+$/', $GLOBALS['_xh']['ac']))
\r
673 /// @todo: find a better way of throwing an error than this!
\r
674 error_log('XML-RPC: non numeric value received in DOUBLE: '.$GLOBALS['_xh']['ac']);
\r
675 $GLOBALS['_xh']['value']='ERROR_NON_NUMERIC_FOUND';
\r
679 // it's ok, add it on
\r
680 $GLOBALS['_xh']['value']=(double)$GLOBALS['_xh']['ac'];
\r
685 // we have an I4/INT
\r
686 // we must check that only 0123456789-<space> are characters here
\r
687 if (!preg_match('/^[+-]?[0123456789 \t]+$/', $GLOBALS['_xh']['ac']))
\r
689 /// @todo find a better way of throwing an error than this!
\r
690 error_log('XML-RPC: non numeric value received in INT: '.$GLOBALS['_xh']['ac']);
\r
691 $GLOBALS['_xh']['value']='ERROR_NON_NUMERIC_FOUND';
\r
695 // it's ok, add it on
\r
696 $GLOBALS['_xh']['value']=(int)$GLOBALS['_xh']['ac'];
\r
699 //$GLOBALS['_xh']['ac']=''; // is this necessary?
\r
700 $GLOBALS['_xh']['lv']=3; // indicate we've found a value
\r
703 $GLOBALS['_xh']['valuestack'][count($GLOBALS['_xh']['valuestack'])-1]['name'] = $GLOBALS['_xh']['ac'];
\r
706 //$GLOBALS['_xh']['ac']=''; // is this necessary?
\r
707 // add to array in the stack the last element built,
\r
708 // unless no VALUE was found
\r
709 if ($GLOBALS['_xh']['vt'])
\r
711 $vscount = count($GLOBALS['_xh']['valuestack']);
\r
712 $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][$GLOBALS['_xh']['valuestack'][$vscount-1]['name']] = $GLOBALS['_xh']['value'];
\r
714 error_log('XML-RPC: missing VALUE inside STRUCT in received xml');
\r
717 //$GLOBALS['_xh']['ac']=''; // is this necessary?
\r
718 $GLOBALS['_xh']['vt']=null; // reset this to check for 2 data elements in a row - even if they're empty
\r
722 // fetch out of stack array of values, and promote it to current value
\r
723 $curr_val = array_pop($GLOBALS['_xh']['valuestack']);
\r
724 $GLOBALS['_xh']['value'] = $curr_val['values'];
\r
725 $GLOBALS['_xh']['vt']=strtolower($name);
\r
726 if (isset($curr_val['php_class']))
\r
728 $GLOBALS['_xh']['php_class'] = $curr_val['php_class'];
\r
732 // add to array of params the current value,
\r
733 // unless no VALUE was found
\r
734 if ($GLOBALS['_xh']['vt'])
\r
736 $GLOBALS['_xh']['params'][]=$GLOBALS['_xh']['value'];
\r
737 $GLOBALS['_xh']['pt'][]=$GLOBALS['_xh']['vt'];
\r
740 error_log('XML-RPC: missing VALUE inside PARAM in received xml');
\r
743 $GLOBALS['_xh']['method']=preg_replace('/^[\n\r\t ]+/', '', $GLOBALS['_xh']['ac']);
\r
746 if ($GLOBALS['xmlrpc_null_extension'])
\r
748 $GLOBALS['_xh']['vt']='null';
\r
749 $GLOBALS['_xh']['value']=null;
\r
750 $GLOBALS['_xh']['lv']=3;
\r
753 // drop through intentionally if nil extension not enabled
\r
757 case 'METHORESPONSE':
\r
760 // End of INVALID ELEMENT!
\r
761 // shall we add an assert here for unreachable code???
\r
767 /// Used in decoding xmlrpc requests/responses without rebuilding xmlrpc values
\r
768 function xmlrpc_ee_fast($parser, $name)
\r
770 xmlrpc_ee($parser, $name, false);
\r
773 /// xml parser handler function for character data
\r
774 function xmlrpc_cd($parser, $data)
\r
776 // skip processing if xml fault already detected
\r
777 if ($GLOBALS['_xh']['isf'] < 2)
\r
779 // "lookforvalue==3" means that we've found an entire value
\r
780 // and should discard any further character data
\r
781 if($GLOBALS['_xh']['lv']!=3)
\r
783 // G. Giunta 2006-08-23: useless change of 'lv' from 1 to 2
\r
784 //if($GLOBALS['_xh']['lv']==1)
\r
786 // if we've found text and we're just in a <value> then
\r
787 // say we've found a value
\r
788 //$GLOBALS['_xh']['lv']=2;
\r
790 // we always initialize the accumulator before starting parsing, anyway...
\r
791 //if(!@isset($GLOBALS['_xh']['ac']))
\r
793 // $GLOBALS['_xh']['ac'] = '';
\r
795 $GLOBALS['_xh']['ac'].=$data;
\r
800 /// xml parser handler function for 'other stuff', ie. not char data or
\r
801 /// element start/end tag. In fact it only gets called on unknown entities...
\r
802 function xmlrpc_dh($parser, $data)
\r
804 // skip processing if xml fault already detected
\r
805 if ($GLOBALS['_xh']['isf'] < 2)
\r
807 if(substr($data, 0, 1) == '&' && substr($data, -1, 1) == ';')
\r
809 // G. Giunta 2006-08-25: useless change of 'lv' from 1 to 2
\r
810 //if($GLOBALS['_xh']['lv']==1)
\r
812 // $GLOBALS['_xh']['lv']=2;
\r
814 $GLOBALS['_xh']['ac'].=$data;
\r
820 class xmlrpc_client
\r
825 var $method='http';
\r
838 var $verifypeer=true;
\r
840 var $no_multicall=false;
\r
843 var $proxy_user='';
\r
844 var $proxy_pass='';
\r
845 var $proxy_authtype=1;
\r
846 var $cookies=array();
\r
848 * List of http compression methods accepted by the client for responses.
\r
849 * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib
\r
851 * NNB: you can set it to any non-empty array for HTTP11 and HTTPS, since
\r
852 * in those cases it will be up to CURL to decide the compression methods
\r
853 * it supports. You might check for the presence of 'zlib' in the output of
\r
854 * curl_version() to determine wheter compression is supported or not
\r
856 var $accepted_compression = array();
\r
858 * Name of compression scheme to be used for sending requests.
\r
859 * Either null, gzip or deflate
\r
861 var $request_compression = '';
\r
863 * CURL handle: used for keep-alive connections (PHP 4.3.8 up, see:
\r
864 * http://curl.haxx.se/docs/faq.html#7.3)
\r
866 var $xmlrpc_curl_handle = null;
\r
867 /// Wheter to use persistent connections for http 1.1 and https
\r
868 var $keepalive = false;
\r
869 /// Charset encodings that can be decoded without problems by the client
\r
870 var $accepted_charset_encodings = array();
\r
871 /// Charset encoding to be used in serializing request. NULL = use ASCII
\r
872 var $request_charset_encoding = '';
\r
874 * Decides the content of xmlrpcresp objects returned by calls to send()
\r
875 * valid strings are 'xmlrpcvals', 'phpvals' or 'xml'
\r
877 var $return_type = 'xmlrpcvals';
\r
880 * @param string $path either the complete server URL or the PATH part of the xmlrc server URL, e.g. /xmlrpc/server.php
\r
881 * @param string $server the server name / ip address
\r
882 * @param integer $port the port the server is listening on, defaults to 80 or 443 depending on protocol used
\r
883 * @param string $method the http protocol variant: defaults to 'http', 'https' and 'http11' can be used if CURL is installed
\r
885 function xmlrpc_client($path, $server='', $port='', $method='')
\r
887 // allow user to specify all params in $path
\r
888 if($server == '' and $port == '' and $method == '')
\r
890 $parts = parse_url($path);
\r
891 $server = $parts['host'];
\r
892 $path = isset($parts['path']) ? $parts['path'] : '';
\r
893 if(isset($parts['query']))
\r
895 $path .= '?'.$parts['query'];
\r
897 if(isset($parts['fragment']))
\r
899 $path .= '#'.$parts['fragment'];
\r
901 if(isset($parts['port']))
\r
903 $port = $parts['port'];
\r
905 if(isset($parts['scheme']))
\r
907 $method = $parts['scheme'];
\r
909 if(isset($parts['user']))
\r
911 $this->username = $parts['user'];
\r
913 if(isset($parts['pass']))
\r
915 $this->password = $parts['pass'];
\r
918 if($path == '' || $path[0] != '/')
\r
920 $this->path='/'.$path;
\r
926 $this->server=$server;
\r
933 $this->method=$method;
\r
936 // if ZLIB is enabled, let the client by default accept compressed responses
\r
937 if(function_exists('gzinflate') || (
\r
938 function_exists('curl_init') && (($info = curl_version()) &&
\r
939 ((is_string($info) && strpos($info, 'zlib') !== null) || isset($info['libz_version'])))
\r
942 $this->accepted_compression = array('gzip', 'deflate');
\r
945 // keepalives: enabled by default ONLY for PHP >= 4.3.8
\r
946 // (see http://curl.haxx.se/docs/faq.html#7.3)
\r
947 if(version_compare(phpversion(), '4.3.8') >= 0)
\r
949 $this->keepalive = true;
\r
952 // by default the xml parser can support these 3 charset encodings
\r
953 $this->accepted_charset_encodings = array('UTF-8', 'ISO-8859-1', 'US-ASCII');
\r
957 * Enables/disables the echoing to screen of the xmlrpc responses received
\r
958 * @param integer $debug values 0, 1 and 2 are supported (2 = echo sent msg too, before received response)
\r
961 function setDebug($in)
\r
967 * Add some http BASIC AUTH credentials, used by the client to authenticate
\r
968 * @param string $u username
\r
969 * @param string $p password
\r
970 * @param integer $t auth type. See curl_setopt man page for supported auth types. Defaults to CURLAUTH_BASIC (basic auth)
\r
973 function setCredentials($u, $p, $t=1)
\r
975 $this->username=$u;
\r
976 $this->password=$p;
\r
977 $this->authtype=$t;
\r
981 * Add a client-side https certificate
\r
982 * @param string $cert
\r
983 * @param string $certpass
\r
986 function setCertificate($cert, $certpass)
\r
988 $this->cert = $cert;
\r
989 $this->certpass = $certpass;
\r
993 * Add a CA certificate to verify server with (see man page about
\r
994 * CURLOPT_CAINFO for more details
\r
995 * @param string $cacert certificate file name (or dir holding certificates)
\r
996 * @param bool $is_dir set to true to indicate cacert is a dir. defaults to false
\r
999 function setCaCertificate($cacert, $is_dir=false)
\r
1003 $this->cacertdir = $cacert;
\r
1007 $this->cacert = $cacert;
\r
1012 * Set attributes for SSL communication: private SSL key
\r
1013 * NB: does not work in older php/curl installs
\r
1014 * Thanks to Daniel Convissor
\r
1015 * @param string $key The name of a file containing a private SSL key
\r
1016 * @param string $keypass The secret password needed to use the private SSL key
\r
1019 function setKey($key, $keypass)
\r
1021 $this->key = $key;
\r
1022 $this->keypass = $keypass;
\r
1026 * Set attributes for SSL communication: verify server certificate
\r
1027 * @param bool $i enable/disable verification of peer certificate
\r
1030 function setSSLVerifyPeer($i)
\r
1032 $this->verifypeer = $i;
\r
1036 * Set attributes for SSL communication: verify match of server cert w. hostname
\r
1040 function setSSLVerifyHost($i)
\r
1042 $this->verifyhost = $i;
\r
1047 * @param string $proxyhost
\r
1048 * @param string $proxyport Defaults to 8080 for HTTP and 443 for HTTPS
\r
1049 * @param string $proxyusername Leave blank if proxy has public access
\r
1050 * @param string $proxypassword Leave blank if proxy has public access
\r
1051 * @param int $proxyauthtype set to constant CURLAUTH_NTLM to use NTLM auth with proxy
\r
1054 function setProxy($proxyhost, $proxyport, $proxyusername = '', $proxypassword = '', $proxyauthtype = 1)
\r
1056 $this->proxy = $proxyhost;
\r
1057 $this->proxyport = $proxyport;
\r
1058 $this->proxy_user = $proxyusername;
\r
1059 $this->proxy_pass = $proxypassword;
\r
1060 $this->proxy_authtype = $proxyauthtype;
\r
1064 * Enables/disables reception of compressed xmlrpc responses.
\r
1065 * Note that enabling reception of compressed responses merely adds some standard
\r
1066 * http headers to xmlrpc requests. It is up to the xmlrpc server to return
\r
1067 * compressed responses when receiving such requests.
\r
1068 * @param string $compmethod either 'gzip', 'deflate', 'any' or ''
\r
1071 function setAcceptedCompression($compmethod)
\r
1073 if ($compmethod == 'any')
\r
1074 $this->accepted_compression = array('gzip', 'deflate');
\r
1076 $this->accepted_compression = array($compmethod);
\r
1080 * Enables/disables http compression of xmlrpc request.
\r
1081 * Take care when sending compressed requests: servers might not support them
\r
1082 * (and automatic fallback to uncompressed requests is not yet implemented)
\r
1083 * @param string $compmethod either 'gzip', 'deflate' or ''
\r
1086 function setRequestCompression($compmethod)
\r
1088 $this->request_compression = $compmethod;
\r
1092 * Adds a cookie to list of cookies that will be sent to server.
\r
1093 * NB: setting any param but name and value will turn the cookie into a 'version 1' cookie:
\r
1094 * do not do it unless you know what you are doing
\r
1095 * @param string $name
\r
1096 * @param string $value
\r
1097 * @param string $path
\r
1098 * @param string $domain
\r
1099 * @param int $port
\r
1102 * @todo check correctness of urlencoding cookie value (copied from php way of doing it...)
\r
1104 function setCookie($name, $value='', $path='', $domain='', $port=null)
\r
1106 $this->cookies[$name]['value'] = urlencode($value);
\r
1107 if ($path || $domain || $port)
\r
1109 $this->cookies[$name]['path'] = $path;
\r
1110 $this->cookies[$name]['domain'] = $domain;
\r
1111 $this->cookies[$name]['port'] = $port;
\r
1112 $this->cookies[$name]['version'] = 1;
\r
1116 $this->cookies[$name]['version'] = 0;
\r
1121 * Send an xmlrpc request
\r
1122 * @param mixed $msg The message object, or an array of messages for using multicall, or the complete xml representation of a request
\r
1123 * @param integer $timeout Connection timeout, in seconds, If unspecified, a platform specific timeout will apply
\r
1124 * @param string $method if left unspecified, the http protocol chosen during creation of the object will be used
\r
1125 * @return xmlrpcresp
\r
1128 function& send($msg, $timeout=0, $method='')
\r
1130 // if user deos not specify http protocol, use native method of this client
\r
1131 // (i.e. method set during call to constructor)
\r
1134 $method = $this->method;
\r
1137 if(is_array($msg))
\r
1139 // $msg is an array of xmlrpcmsg's
\r
1140 $r = $this->multicall($msg, $timeout, $method);
\r
1143 elseif(is_string($msg))
\r
1145 $n =& new xmlrpcmsg('');
\r
1146 $n->payload = $msg;
\r
1150 // where msg is an xmlrpcmsg
\r
1151 $msg->debug=$this->debug;
\r
1153 if($method == 'https')
\r
1155 $r =& $this->sendPayloadHTTPS(
\r
1169 $this->proxy_user,
\r
1170 $this->proxy_pass,
\r
1171 $this->proxy_authtype,
\r
1177 elseif($method == 'http11')
\r
1179 $r =& $this->sendPayloadCURL(
\r
1193 $this->proxy_user,
\r
1194 $this->proxy_pass,
\r
1195 $this->proxy_authtype,
\r
1202 $r =& $this->sendPayloadHTTP10(
\r
1212 $this->proxy_user,
\r
1213 $this->proxy_pass,
\r
1214 $this->proxy_authtype
\r
1224 function &sendPayloadHTTP10($msg, $server, $port, $timeout=0,
\r
1225 $username='', $password='', $authtype=1, $proxyhost='',
\r
1226 $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1)
\r
1233 // Only create the payload if it was not created previously
\r
1234 if(empty($msg->payload))
\r
1236 $msg->createPayload($this->request_charset_encoding);
\r
1239 $payload = $msg->payload;
\r
1240 // Deflate request body and set appropriate request headers
\r
1241 if(function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate'))
\r
1243 if($this->request_compression == 'gzip')
\r
1245 $a = @gzencode($payload);
\r
1249 $encoding_hdr = "Content-Encoding: gzip\r\n";
\r
1254 $a = @gzcompress($payload);
\r
1258 $encoding_hdr = "Content-Encoding: deflate\r\n";
\r
1264 $encoding_hdr = '';
\r
1267 // thanks to Grant Rauscher <grant7@firstworld.net> for this
\r
1271 $credentials='Authorization: Basic ' . base64_encode($username . ':' . $password) . "\r\n";
\r
1272 if ($authtype != 1)
\r
1274 error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth is supported with HTTP 1.0');
\r
1278 $accepted_encoding = '';
\r
1279 if(is_array($this->accepted_compression) && count($this->accepted_compression))
\r
1281 $accepted_encoding = 'Accept-Encoding: ' . implode(', ', $this->accepted_compression) . "\r\n";
\r
1284 $proxy_credentials = '';
\r
1287 if($proxyport == 0)
\r
1289 $proxyport = 8080;
\r
1291 $connectserver = $proxyhost;
\r
1292 $connectport = $proxyport;
\r
1293 $uri = 'http://'.$server.':'.$port.$this->path;
\r
1294 if($proxyusername != '')
\r
1296 if ($proxyauthtype != 1)
\r
1298 error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth to proxy is supported with HTTP 1.0');
\r
1300 $proxy_credentials = 'Proxy-Authorization: Basic ' . base64_encode($proxyusername.':'.$proxypassword) . "\r\n";
\r
1305 $connectserver = $server;
\r
1306 $connectport = $port;
\r
1307 $uri = $this->path;
\r
1310 // Cookie generation, as per rfc2965 (version 1 cookies) or
\r
1311 // netscape's rules (version 0 cookies)
\r
1313 if (count($this->cookies))
\r
1316 foreach ($this->cookies as $name => $cookie)
\r
1318 if ($cookie['version'])
\r
1320 $version = ' $Version="' . $cookie['version'] . '";';
\r
1321 $cookieheader .= ' ' . $name . '="' . $cookie['value'] . '";';
\r
1322 if ($cookie['path'])
\r
1323 $cookieheader .= ' $Path="' . $cookie['path'] . '";';
\r
1324 if ($cookie['domain'])
\r
1325 $cookieheader .= ' $Domain="' . $cookie['domain'] . '";';
\r
1326 if ($cookie['port'])
\r
1327 $cookieheader .= ' $Port="' . $cookie['port'] . '";';
\r
1331 $cookieheader .= ' ' . $name . '=' . $cookie['value'] . ";";
\r
1334 $cookieheader = 'Cookie:' . $version . substr($cookieheader, 0, -1) . "\r\n";
\r
1337 $op= 'POST ' . $uri. " HTTP/1.0\r\n" .
\r
1338 'User-Agent: ' . $GLOBALS['xmlrpcName'] . ' ' . $GLOBALS['xmlrpcVersion'] . "\r\n" .
\r
1339 'Host: '. $server . ':' . $port . "\r\n" .
\r
1341 $proxy_credentials .
\r
1342 $accepted_encoding .
\r
1344 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings) . "\r\n" .
\r
1346 'Content-Type: ' . $msg->content_type . "\r\nContent-Length: " .
\r
1347 strlen($payload) . "\r\n\r\n" .
\r
1350 if($this->debug > 1)
\r
1352 print "<PRE>\n---SENDING---\n" . htmlentities($op) . "\n---END---\n</PRE>";
\r
1353 // let the client see this now in case http times out...
\r
1359 $fp=@fsockopen($connectserver, $connectport, $this->errno, $this->errstr, $timeout);
\r
1363 $fp=@fsockopen($connectserver, $connectport, $this->errno, $this->errstr);
\r
1367 if($timeout>0 && function_exists('stream_set_timeout'))
\r
1369 stream_set_timeout($fp, $timeout);
\r
1374 $this->errstr='Connect error: '.$this->errstr;
\r
1375 $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $this->errstr . ' (' . $this->errno . ')');
\r
1379 if(!fputs($fp, $op, strlen($op)))
\r
1382 $this->errstr='Write error';
\r
1383 $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $this->errstr);
\r
1388 // reset errno and errstr on succesful socket connection
\r
1389 $this->errstr = '';
\r
1391 // G. Giunta 2005/10/24: close socket before parsing.
\r
1392 // should yeld slightly better execution times, and make easier recursive calls (e.g. to follow http redirects)
\r
1396 // shall we check for $data === FALSE?
\r
1397 // as per the manual, it signals an error
\r
1398 $ipd.=fread($fp, 32768);
\r
1399 } while(!feof($fp));
\r
1401 $r =& $msg->parseResponse($ipd, false, $this->return_type);
\r
1409 function &sendPayloadHTTPS($msg, $server, $port, $timeout=0, $username='',
\r
1410 $password='', $authtype=1, $cert='',$certpass='', $cacert='', $cacertdir='',
\r
1411 $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1,
\r
1412 $keepalive=false, $key='', $keypass='')
\r
1414 $r =& $this->sendPayloadCURL($msg, $server, $port, $timeout, $username,
\r
1415 $password, $authtype, $cert, $certpass, $cacert, $cacertdir, $proxyhost, $proxyport,
\r
1416 $proxyusername, $proxypassword, $proxyauthtype, 'https', $keepalive, $key, $keypass);
\r
1421 * Contributed by Justin Miller <justin@voxel.net>
\r
1422 * Requires curl to be built into PHP
\r
1423 * NB: CURL versions before 7.11.10 cannot use proxy to talk to https servers!
\r
1426 function &sendPayloadCURL($msg, $server, $port, $timeout=0, $username='',
\r
1427 $password='', $authtype=1, $cert='', $certpass='', $cacert='', $cacertdir='',
\r
1428 $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1, $method='https',
\r
1429 $keepalive=false, $key='', $keypass='')
\r
1431 if(!function_exists('curl_init'))
\r
1433 $this->errstr='CURL unavailable on this install';
\r
1434 $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_curl'], $GLOBALS['xmlrpcstr']['no_curl']);
\r
1437 if($method == 'https')
\r
1439 if(($info = curl_version()) &&
\r
1440 ((is_string($info) && strpos($info, 'OpenSSL') === null) || (is_array($info) && !isset($info['ssl_version']))))
\r
1442 $this->errstr='SSL unavailable on this install';
\r
1443 $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_ssl'], $GLOBALS['xmlrpcstr']['no_ssl']);
\r
1450 if($method == 'http')
\r
1460 // Only create the payload if it was not created previously
\r
1461 if(empty($msg->payload))
\r
1463 $msg->createPayload($this->request_charset_encoding);
\r
1466 // Deflate request body and set appropriate request headers
\r
1467 $payload = $msg->payload;
\r
1468 if(function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate'))
\r
1470 if($this->request_compression == 'gzip')
\r
1472 $a = @gzencode($payload);
\r
1476 $encoding_hdr = 'Content-Encoding: gzip';
\r
1481 $a = @gzcompress($payload);
\r
1485 $encoding_hdr = 'Content-Encoding: deflate';
\r
1491 $encoding_hdr = '';
\r
1494 if($this->debug > 1)
\r
1496 print "<PRE>\n---SENDING---\n" . htmlentities($payload) . "\n---END---\n</PRE>";
\r
1497 // let the client see this now in case http times out...
\r
1501 if(!$keepalive || !$this->xmlrpc_curl_handle)
\r
1503 $curl = curl_init($method . '://' . $server . ':' . $port . $this->path);
\r
1506 $this->xmlrpc_curl_handle = $curl;
\r
1511 $curl = $this->xmlrpc_curl_handle;
\r
1514 // results into variable
\r
1515 curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
\r
1519 curl_setopt($curl, CURLOPT_VERBOSE, 1);
\r
1521 curl_setopt($curl, CURLOPT_USERAGENT, $GLOBALS['xmlrpcName'].' '.$GLOBALS['xmlrpcVersion']);
\r
1522 // required for XMLRPC: post the data
\r
1523 curl_setopt($curl, CURLOPT_POST, 1);
\r
1525 curl_setopt($curl, CURLOPT_POSTFIELDS, $payload);
\r
1527 // return the header too
\r
1528 curl_setopt($curl, CURLOPT_HEADER, 1);
\r
1530 // will only work with PHP >= 5.0
\r
1531 // NB: if we set an empty string, CURL will add http header indicating
\r
1532 // ALL methods it is supporting. This is possibly a better option than
\r
1533 // letting the user tell what curl can / cannot do...
\r
1534 if(is_array($this->accepted_compression) && count($this->accepted_compression))
\r
1536 //curl_setopt($curl, CURLOPT_ENCODING, implode(',', $this->accepted_compression));
\r
1537 // empty string means 'any supported by CURL' (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
\r
1538 if (count($this->accepted_compression) == 1)
\r
1540 curl_setopt($curl, CURLOPT_ENCODING, $this->accepted_compression[0]);
\r
1543 curl_setopt($curl, CURLOPT_ENCODING, '');
\r
1546 $headers = array('Content-Type: ' . $msg->content_type , 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings));
\r
1547 // if no keepalive is wanted, let the server know it in advance
\r
1550 $headers[] = 'Connection: close';
\r
1552 // request compression header
\r
1555 $headers[] = $encoding_hdr;
\r
1558 curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
\r
1559 // timeout is borked
\r
1562 curl_setopt($curl, CURLOPT_TIMEOUT, $timeout == 1 ? 1 : $timeout - 1);
\r
1565 if($username && $password)
\r
1567 curl_setopt($curl, CURLOPT_USERPWD, $username.':'.$password);
\r
1568 if (defined('CURLOPT_HTTPAUTH'))
\r
1570 curl_setopt($curl, CURLOPT_HTTPAUTH, $authtype);
\r
1572 else if ($authtype != 1)
\r
1574 error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth is supported by the current PHP/curl install');
\r
1578 if($method == 'https')
\r
1583 curl_setopt($curl, CURLOPT_SSLCERT, $cert);
\r
1585 // set cert password
\r
1588 curl_setopt($curl, CURLOPT_SSLCERTPASSWD, $certpass);
\r
1590 // whether to verify remote host's cert
\r
1591 curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, $this->verifypeer);
\r
1592 // set ca certificates file/dir
\r
1595 curl_setopt($curl, CURLOPT_CAINFO, $cacert);
\r
1599 curl_setopt($curl, CURLOPT_CAPATH, $cacertdir);
\r
1601 // set key file (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
\r
1604 curl_setopt($curl, CURLOPT_SSLKEY, $key);
\r
1606 // set key password (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
\r
1609 curl_setopt($curl, CURLOPT_SSLKEYPASSWD, $keypass);
\r
1611 // 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
1612 curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, $this->verifyhost);
\r
1618 if($proxyport == 0)
\r
1620 $proxyport = 8080; // NB: even for HTTPS, local connection is on port 8080
\r
1622 curl_setopt($curl, CURLOPT_PROXY, $proxyhost.':'.$proxyport);
\r
1623 //curl_setopt($curl, CURLOPT_PROXYPORT,$proxyport);
\r
1624 if($proxyusername)
\r
1626 curl_setopt($curl, CURLOPT_PROXYUSERPWD, $proxyusername.':'.$proxypassword);
\r
1627 if (defined('CURLOPT_PROXYAUTH'))
\r
1629 curl_setopt($curl, CURLOPT_PROXYAUTH, $proxyauthtype);
\r
1631 else if ($proxyauthtype != 1)
\r
1633 error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth to proxy is supported by the current PHP/curl install');
\r
1638 // NB: should we build cookie http headers by hand rather than let CURL do it?
\r
1639 // the following code does not honour 'expires', 'path' and 'domain' cookie attributes
\r
1640 // set to client obj the the user...
\r
1641 if (count($this->cookies))
\r
1643 $cookieheader = '';
\r
1644 foreach ($this->cookies as $name => $cookie)
\r
1646 $cookieheader .= $name . '=' . $cookie['value'] . '; ';
\r
1648 curl_setopt($curl, CURLOPT_COOKIE, substr($cookieheader, 0, -2));
\r
1651 $result = curl_exec($curl);
\r
1653 if ($this->debug > 1)
\r
1655 print "<PRE>\n---CURL INFO---\n";
\r
1656 foreach(curl_getinfo($curl) as $name => $val)
\r
1657 print $name . ': ' . htmlentities($val). "\n";
\r
1658 print "---END---\n</PRE>";
\r
1661 if(!$result) /// @todo we should use a better check here - what if we get back '' or '0'?
\r
1663 $this->errstr='no response';
\r
1664 $resp=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['curl_fail'], $GLOBALS['xmlrpcstr']['curl_fail']. ': '. curl_error($curl));
\r
1665 curl_close($curl);
\r
1668 $this->xmlrpc_curl_handle = null;
\r
1675 curl_close($curl);
\r
1677 $resp =& $msg->parseResponse($result, true, $this->return_type);
\r
1683 * Send an array of request messages and return an array of responses.
\r
1684 * Unless $this->no_multicall has been set to true, it will try first
\r
1685 * to use one single xmlrpc call to server method system.multicall, and
\r
1686 * revert to sending many successive calls in case of failure.
\r
1687 * This failure is also stored in $this->no_multicall for subsequent calls.
\r
1688 * Unfortunately, there is no server error code universally used to denote
\r
1689 * the fact that multicall is unsupported, so there is no way to reliably
\r
1690 * distinguish between that and a temporary failure.
\r
1691 * If you are sure that server supports multicall and do not want to
\r
1692 * fallback to using many single calls, set the fourth parameter to FALSE.
\r
1694 * NB: trying to shoehorn extra functionality into existing syntax has resulted
\r
1695 * in pretty much convoluted code...
\r
1697 * @param array $msgs an array of xmlrpcmsg objects
\r
1698 * @param integer $timeout connection timeout (in seconds)
\r
1699 * @param string $method the http protocol variant to be used
\r
1700 * @param boolean fallback When true, upon receiveing an error during multicall, multiple single calls will be attempted
\r
1704 function multicall($msgs, $timeout=0, $method='', $fallback=true)
\r
1706 if ($method == '')
\r
1708 $method = $this->method;
\r
1710 if(!$this->no_multicall)
\r
1712 $results = $this->_try_multicall($msgs, $timeout, $method);
\r
1713 if(is_array($results))
\r
1715 // System.multicall succeeded
\r
1720 // either system.multicall is unsupported by server,
\r
1721 // or call failed for some other reason.
\r
1724 // Don't try it next time...
\r
1725 $this->no_multicall = true;
\r
1729 if (is_a($results, 'xmlrpcresp'))
\r
1731 $result = $results;
\r
1735 $result =& new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['multicall_error'], $GLOBALS['xmlrpcstr']['multicall_error']);
\r
1742 // override fallback, in case careless user tries to do two
\r
1743 // opposite things at the same time
\r
1747 $results = array();
\r
1750 // system.multicall is (probably) unsupported by server:
\r
1751 // emulate multicall via multiple requests
\r
1752 foreach($msgs as $msg)
\r
1754 $results[] =& $this->send($msg, $timeout, $method);
\r
1759 // user does NOT want to fallback on many single calls:
\r
1760 // since we should always return an array of responses,
\r
1761 // return an array with the same error repeated n times
\r
1762 foreach($msgs as $msg)
\r
1764 $results[] = $result;
\r
1771 * Attempt to boxcar $msgs via system.multicall.
\r
1772 * Returns either an array of xmlrpcreponses, an xmlrpc error response
\r
1773 * or false (when received response does not respect valid multicall syntax)
\r
1776 function _try_multicall($msgs, $timeout, $method)
\r
1778 // Construct multicall message
\r
1780 foreach($msgs as $msg)
\r
1782 $call['methodName'] =& new xmlrpcval($msg->method(),'string');
\r
1783 $numParams = $msg->getNumParams();
\r
1784 $params = array();
\r
1785 for($i = 0; $i < $numParams; $i++)
\r
1787 $params[$i] = $msg->getParam($i);
\r
1789 $call['params'] =& new xmlrpcval($params, 'array');
\r
1790 $calls[] =& new xmlrpcval($call, 'struct');
\r
1792 $multicall =& new xmlrpcmsg('system.multicall');
\r
1793 $multicall->addParam(new xmlrpcval($calls, 'array'));
\r
1795 // Attempt RPC call
\r
1796 $result =& $this->send($multicall, $timeout, $method);
\r
1798 if($result->faultCode() != 0)
\r
1800 // call to system.multicall failed
\r
1804 // Unpack responses.
\r
1805 $rets = $result->value();
\r
1807 if ($this->return_type == 'xml')
\r
1811 else if ($this->return_type == 'phpvals')
\r
1813 ///@todo test this code branch...
\r
1814 $rets = $result->value();
\r
1815 if(!is_array($rets))
\r
1817 return false; // bad return type from system.multicall
\r
1819 $numRets = count($rets);
\r
1820 if($numRets != count($msgs))
\r
1822 return false; // wrong number of return values.
\r
1825 $response = array();
\r
1826 for($i = 0; $i < $numRets; $i++)
\r
1829 if (!is_array($val)) {
\r
1832 switch(count($val))
\r
1835 if(!isset($val[0]))
\r
1837 return false; // Bad value
\r
1839 // Normal return value
\r
1840 $response[$i] =& new xmlrpcresp($val[0], 0, '', 'phpvals');
\r
1843 /// @todo remove usage of @: it is apparently quite slow
\r
1844 $code = @$val['faultCode'];
\r
1845 if(!is_int($code))
\r
1849 $str = @$val['faultString'];
\r
1850 if(!is_string($str))
\r
1854 $response[$i] =& new xmlrpcresp(0, $code, $str);
\r
1862 else // return type == 'xmlrpcvals'
\r
1864 $rets = $result->value();
\r
1865 if($rets->kindOf() != 'array')
\r
1867 return false; // bad return type from system.multicall
\r
1869 $numRets = $rets->arraysize();
\r
1870 if($numRets != count($msgs))
\r
1872 return false; // wrong number of return values.
\r
1875 $response = array();
\r
1876 for($i = 0; $i < $numRets; $i++)
\r
1878 $val = $rets->arraymem($i);
\r
1879 switch($val->kindOf())
\r
1882 if($val->arraysize() != 1)
\r
1884 return false; // Bad value
\r
1886 // Normal return value
\r
1887 $response[$i] =& new xmlrpcresp($val->arraymem(0));
\r
1890 $code = $val->structmem('faultCode');
\r
1891 if($code->kindOf() != 'scalar' || $code->scalartyp() != 'int')
\r
1895 $str = $val->structmem('faultString');
\r
1896 if($str->kindOf() != 'scalar' || $str->scalartyp() != 'string')
\r
1900 $response[$i] =& new xmlrpcresp(0, $code->scalarval(), $str->scalarval());
\r
1909 } // end class xmlrpc_client
\r
1918 var $hdrs = array();
\r
1919 var $_cookies = array();
\r
1920 var $content_type = 'text/xml';
\r
1921 var $raw_data = '';
\r
1924 * @param mixed $val either an xmlrpcval obj, a php value or the xml serialization of an xmlrpcval (a string)
\r
1925 * @param integer $fcode set it to anything but 0 to create an error response
\r
1926 * @param string $fstr the error string, in case of an error response
\r
1927 * @param string $valtyp either 'xmlrpcvals', 'phpvals' or 'xml'
\r
1929 * @todo add check that $val / $fcode / $fstr is of correct type???
\r
1930 * NB: as of now we do not do it, since it might be either an xmlrpcval or a plain
\r
1931 * php val, or a complete xml chunk, depending on usage of xmlrpc_client::send() inside which creator is called...
\r
1933 function xmlrpcresp($val, $fcode = 0, $fstr = '', $valtyp='')
\r
1938 $this->errno = $fcode;
\r
1939 $this->errstr = $fstr;
\r
1940 //$this->errstr = htmlspecialchars($fstr); // XXX: encoding probably shouldn't be done here; fix later.
\r
1944 // successful response
\r
1945 $this->val = $val;
\r
1946 if ($valtyp == '')
\r
1948 // user did not declare type of response value: try to guess it
\r
1949 if (is_object($this->val) && is_a($this->val, 'xmlrpcval'))
\r
1951 $this->valtyp = 'xmlrpcvals';
\r
1953 else if (is_string($this->val))
\r
1955 $this->valtyp = 'xml';
\r
1960 $this->valtyp = 'phpvals';
\r
1965 // user declares type of resp value: believe him
\r
1966 $this->valtyp = $valtyp;
\r
1972 * Returns the error code of the response.
\r
1973 * @return integer the error code of this response (0 for not-error responses)
\r
1976 function faultCode()
\r
1978 return $this->errno;
\r
1982 * Returns the error code of the response.
\r
1983 * @return string the error string of this response ('' for not-error responses)
\r
1986 function faultString()
\r
1988 return $this->errstr;
\r
1992 * Returns the value received by the server.
\r
1993 * @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
1998 return $this->val;
\r
2002 * Returns an array with the cookies received from the server.
\r
2003 * Array has the form: $cookiename => array ('value' => $val, $attr1 => $val1, $attr2 = $val2, ...)
\r
2004 * with attributes being e.g. 'expires', 'path', domain'.
\r
2005 * NB: cookies sent as 'expired' by the server (i.e. with an expiry date in the past)
\r
2006 * are still present in the array. It is up to the user-defined code to decide
\r
2007 * how to use the received cookies, and wheter they have to be sent back with the next
\r
2008 * request to the server (using xmlrpc_client::setCookie) or not
\r
2009 * @return array array of cookies received from the server
\r
2012 function cookies()
\r
2014 return $this->_cookies;
\r
2018 * Returns xml representation of the response. XML prologue not included
\r
2019 * @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed
\r
2020 * @return string the xml representation of the response
\r
2023 function serialize($charset_encoding='')
\r
2025 if ($charset_encoding != '')
\r
2026 $this->content_type = 'text/xml; charset=' . $charset_encoding;
\r
2028 $this->content_type = 'text/xml';
\r
2029 $result = "<methodResponse>\n";
\r
2032 // G. Giunta 2005/2/13: let non-ASCII response messages be tolerated by clients
\r
2033 // by xml-encoding non ascii chars
\r
2034 $result .= "<fault>\n" .
\r
2035 "<value>\n<struct><member><name>faultCode</name>\n<value><int>" . $this->errno .
\r
2036 "</int></value>\n</member>\n<member>\n<name>faultString</name>\n<value><string>" .
\r
2037 xmlrpc_encode_entitites($this->errstr, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding) . "</string></value>\n</member>\n" .
\r
2038 "</struct>\n</value>\n</fault>";
\r
2042 if(!is_object($this->val) || !is_a($this->val, 'xmlrpcval'))
\r
2044 if (is_string($this->val) && $this->valtyp == 'xml')
\r
2046 $result .= "<params>\n<param>\n" .
\r
2048 "</param>\n</params>";
\r
2052 /// @todo try to build something serializable?
\r
2053 die('cannot serialize xmlrpcresp objects whose content is native php values');
\r
2058 $result .= "<params>\n<param>\n" .
\r
2059 $this->val->serialize($charset_encoding) .
\r
2060 "</param>\n</params>";
\r
2063 $result .= "\n</methodResponse>";
\r
2064 $this->payload = $result;
\r
2073 var $params=array();
\r
2075 var $content_type = 'text/xml';
\r
2078 * @param string $meth the name of the method to invoke
\r
2079 * @param array $pars array of parameters to be paased to the method (xmlrpcval objects)
\r
2081 function xmlrpcmsg($meth, $pars=0)
\r
2083 $this->methodname=$meth;
\r
2084 if(is_array($pars) && count($pars)>0)
\r
2086 for($i=0; $i<count($pars); $i++)
\r
2088 $this->addParam($pars[$i]);
\r
2096 function xml_header($charset_encoding='')
\r
2098 if ($charset_encoding != '')
\r
2100 return "<?xml version=\"1.0\" encoding=\"$charset_encoding\" ?" . ">\n<methodCall>\n";
\r
2104 return "<?xml version=\"1.0\"?" . ">\n<methodCall>\n";
\r
2111 function xml_footer()
\r
2113 return '</methodCall>';
\r
2127 function createPayload($charset_encoding='')
\r
2129 if ($charset_encoding != '')
\r
2130 $this->content_type = 'text/xml; charset=' . $charset_encoding;
\r
2132 $this->content_type = 'text/xml';
\r
2133 $this->payload=$this->xml_header($charset_encoding);
\r
2134 $this->payload.='<methodName>' . $this->methodname . "</methodName>\n";
\r
2135 $this->payload.="<params>\n";
\r
2136 for($i=0; $i<count($this->params); $i++)
\r
2138 $p=$this->params[$i];
\r
2139 $this->payload.="<param>\n" . $p->serialize($charset_encoding) .
\r
2142 $this->payload.="</params>\n";
\r
2143 $this->payload.=$this->xml_footer();
\r
2147 * Gets/sets the xmlrpc method to be invoked
\r
2148 * @param string $meth the method to be set (leave empty not to set it)
\r
2149 * @return string the method that will be invoked
\r
2152 function method($meth='')
\r
2156 $this->methodname=$meth;
\r
2158 return $this->methodname;
\r
2162 * Returns xml representation of the message. XML prologue included
\r
2163 * @return string the xml representation of the message, xml prologue included
\r
2166 function serialize($charset_encoding='')
\r
2168 $this->createPayload($charset_encoding);
\r
2169 return $this->payload;
\r
2173 * Add a parameter to the list of parameters to be used upon method invocation
\r
2174 * @param xmlrpcval $par
\r
2175 * @return boolean false on failure
\r
2178 function addParam($par)
\r
2180 // add check: do not add to self params which are not xmlrpcvals
\r
2181 if(is_object($par) && is_a($par, 'xmlrpcval'))
\r
2183 $this->params[]=$par;
\r
2193 * Returns the nth parameter in the message. The index zero-based.
\r
2194 * @param integer $i the index of the parameter to fetch (zero based)
\r
2195 * @return xmlrpcval the i-th parameter
\r
2198 function getParam($i) { return $this->params[$i]; }
\r
2201 * Returns the number of parameters in the messge.
\r
2202 * @return integer the number of parameters currently set
\r
2205 function getNumParams() { return count($this->params); }
\r
2208 * Given an open file handle, read all data available and parse it as axmlrpc response.
\r
2209 * NB: the file handle is not closed by this function.
\r
2210 * NNB: might have trouble in rare cases to work on network streams, as we
\r
2211 * check for a read of 0 bytes instead of feof($fp).
\r
2212 * But since checking for feof(null) returns false, we would risk an
\r
2213 * infinite loop in that case, because we cannot trust the caller
\r
2214 * to give us a valid pointer to an open file...
\r
2216 * @return xmlrpcresp
\r
2217 * @todo add 2nd & 3rd param to be passed to ParseResponse() ???
\r
2219 function &parseResponseFile($fp)
\r
2222 while($data=fread($fp, 32768))
\r
2227 $r =& $this->parseResponse($ipd);
\r
2232 * Parses HTTP headers and separates them from data.
\r
2235 function &parseResponseHeaders(&$data, $headers_processed=false)
\r
2237 // Support "web-proxy-tunelling" connections for https through proxies
\r
2238 if(preg_match('/^HTTP\/1\.[0-1] 200 Connection established/', $data))
\r
2240 // Look for CR/LF or simple LF as line separator,
\r
2241 // (even though it is not valid http)
\r
2242 $pos = strpos($data,"\r\n\r\n");
\r
2243 if($pos || is_int($pos))
\r
2249 $pos = strpos($data,"\n\n");
\r
2250 if($pos || is_int($pos))
\r
2256 // No separation between response headers and body: fault?
\r
2262 // this filters out all http headers from proxy.
\r
2263 // maybe we could take them into account, too?
\r
2264 $data = substr($data, $bd);
\r
2268 error_log('XML-RPC: xmlrpcmsg::parseResponse: HTTPS via proxy error, tunnel connection possibly failed');
\r
2269 $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $GLOBALS['xmlrpcstr']['http_error']. ' (HTTPS via proxy error, tunnel connection possibly failed)');
\r
2274 // Strip HTTP 1.1 100 Continue header if present
\r
2275 while(preg_match('/^HTTP\/1\.1 1[0-9]{2} /', $data))
\r
2277 $pos = strpos($data, 'HTTP', 12);
\r
2278 // server sent a Continue header without any (valid) content following...
\r
2279 // give the client a chance to know it
\r
2280 if(!$pos && !is_int($pos)) // works fine in php 3, 4 and 5
\r
2284 $data = substr($data, $pos);
\r
2286 if(!preg_match('/^HTTP\/[0-9.]+ 200 /', $data))
\r
2288 $errstr= substr($data, 0, strpos($data, "\n")-1);
\r
2289 error_log('XML-RPC: xmlrpcmsg::parseResponse: HTTP error, got response: ' .$errstr);
\r
2290 $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $GLOBALS['xmlrpcstr']['http_error']. ' (' . $errstr . ')');
\r
2294 $GLOBALS['_xh']['headers'] = array();
\r
2295 $GLOBALS['_xh']['cookies'] = array();
\r
2297 // be tolerant to usage of \n instead of \r\n to separate headers and data
\r
2298 // (even though it is not valid http)
\r
2299 $pos = strpos($data,"\r\n\r\n");
\r
2300 if($pos || is_int($pos))
\r
2306 $pos = strpos($data,"\n\n");
\r
2307 if($pos || is_int($pos))
\r
2313 // No separation between response headers and body: fault?
\r
2314 // we could take some action here instead of going on...
\r
2318 // be tolerant to line endings, and extra empty lines
\r
2319 $ar = split("\r?\n", trim(substr($data, 0, $pos)));
\r
2320 while(list(,$line) = @each($ar))
\r
2322 // take care of multi-line headers and cookies
\r
2323 $arr = explode(':',$line,2);
\r
2324 if(count($arr) > 1)
\r
2326 $header_name = strtolower(trim($arr[0]));
\r
2327 /// @todo some other headers (the ones that allow a CSV list of values)
\r
2328 /// do allow many values to be passed using multiple header lines.
\r
2329 /// We should add content to $GLOBALS['_xh']['headers'][$header_name]
\r
2330 /// instead of replacing it for those...
\r
2331 if ($header_name == 'set-cookie' || $header_name == 'set-cookie2')
\r
2333 if ($header_name == 'set-cookie2')
\r
2335 // version 2 cookies:
\r
2336 // there could be many cookies on one line, comma separated
\r
2337 $cookies = explode(',', $arr[1]);
\r
2341 $cookies = array($arr[1]);
\r
2343 foreach ($cookies as $cookie)
\r
2345 // glue together all received cookies, using a comma to separate them
\r
2346 // (same as php does with getallheaders())
\r
2347 if (isset($GLOBALS['_xh']['headers'][$header_name]))
\r
2348 $GLOBALS['_xh']['headers'][$header_name] .= ', ' . trim($cookie);
\r
2350 $GLOBALS['_xh']['headers'][$header_name] = trim($cookie);
\r
2351 // parse cookie attributes, in case user wants to correctly honour them
\r
2352 // feature creep: only allow rfc-compliant cookie attributes?
\r
2353 // @todo support for server sending multiple time cookie with same name, but using different PATHs
\r
2354 $cookie = explode(';', $cookie);
\r
2355 foreach ($cookie as $pos => $val)
\r
2357 $val = explode('=', $val, 2);
\r
2358 $tag = trim($val[0]);
\r
2359 $val = trim(@$val[1]);
\r
2360 /// @todo with version 1 cookies, we should strip leading and trailing " chars
\r
2363 $cookiename = $tag;
\r
2364 $GLOBALS['_xh']['cookies'][$tag] = array();
\r
2365 $GLOBALS['_xh']['cookies'][$cookiename]['value'] = urldecode($val);
\r
2369 if ($tag != 'value')
\r
2371 $GLOBALS['_xh']['cookies'][$cookiename][$tag] = $val;
\r
2379 $GLOBALS['_xh']['headers'][$header_name] = trim($arr[1]);
\r
2382 elseif(isset($header_name))
\r
2384 /// @todo version1 cookies might span multiple lines, thus breaking the parsing above
\r
2385 $GLOBALS['_xh']['headers'][$header_name] .= ' ' . trim($line);
\r
2389 $data = substr($data, $bd);
\r
2391 if($this->debug && count($GLOBALS['_xh']['headers']))
\r
2394 foreach($GLOBALS['_xh']['headers'] as $header => $value)
\r
2396 print htmlentities("HEADER: $header: $value\n");
\r
2398 foreach($GLOBALS['_xh']['cookies'] as $header => $value)
\r
2400 print htmlentities("COOKIE: $header={$value['value']}\n");
\r
2405 // if CURL was used for the call, http headers have been processed,
\r
2406 // and dechunking + reinflating have been carried out
\r
2407 if(!$headers_processed)
\r
2409 // Decode chunked encoding sent by http 1.1 servers
\r
2410 if(isset($GLOBALS['_xh']['headers']['transfer-encoding']) && $GLOBALS['_xh']['headers']['transfer-encoding'] == 'chunked')
\r
2412 if(!$data = decode_chunked($data))
\r
2414 error_log('XML-RPC: xmlrpcmsg::parseResponse: errors occurred when trying to rebuild the chunked data received from server');
\r
2415 $r =& new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['dechunk_fail'], $GLOBALS['xmlrpcstr']['dechunk_fail']);
\r
2420 // Decode gzip-compressed stuff
\r
2421 // code shamelessly inspired from nusoap library by Dietrich Ayala
\r
2422 if(isset($GLOBALS['_xh']['headers']['content-encoding']))
\r
2424 $GLOBALS['_xh']['headers']['content-encoding'] = str_replace('x-', '', $GLOBALS['_xh']['headers']['content-encoding']);
\r
2425 if($GLOBALS['_xh']['headers']['content-encoding'] == 'deflate' || $GLOBALS['_xh']['headers']['content-encoding'] == 'gzip')
\r
2427 // if decoding works, use it. else assume data wasn't gzencoded
\r
2428 if(function_exists('gzinflate'))
\r
2430 if($GLOBALS['_xh']['headers']['content-encoding'] == 'deflate' && $degzdata = @gzuncompress($data))
\r
2432 $data = $degzdata;
\r
2434 print "<PRE>---INFLATED RESPONSE---[".strlen($data)." chars]---\n" . htmlentities($data) . "\n---END---</PRE>";
\r
2436 elseif($GLOBALS['_xh']['headers']['content-encoding'] == 'gzip' && $degzdata = @gzinflate(substr($data, 10)))
\r
2438 $data = $degzdata;
\r
2440 print "<PRE>---INFLATED RESPONSE---[".strlen($data)." chars]---\n" . htmlentities($data) . "\n---END---</PRE>";
\r
2444 error_log('XML-RPC: xmlrpcmsg::parseResponse: errors occurred when trying to decode the deflated data received from server');
\r
2445 $r =& new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['decompress_fail'], $GLOBALS['xmlrpcstr']['decompress_fail']);
\r
2451 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
2452 $r =& new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['cannot_decompress'], $GLOBALS['xmlrpcstr']['cannot_decompress']);
\r
2457 } // end of 'if needed, de-chunk, re-inflate response'
\r
2459 // real stupid hack to avoid PHP 4 complaining about returning NULL by ref
\r
2466 * Parse the xmlrpc response contained in the string $data and return an xmlrpcresp object.
\r
2467 * @param string $data the xmlrpc response, eventually including http headers
\r
2468 * @param bool $headers_processed when true prevents parsing HTTP headers for interpretation of content-encoding and consequent decoding
\r
2469 * @param string $return_type decides return type, i.e. content of response->value(). Either 'xmlrpcvals', 'xml' or 'phpvals'
\r
2470 * @return xmlrpcresp
\r
2473 function &parseResponse($data='', $headers_processed=false, $return_type='xmlrpcvals')
\r
2477 //by maHo, replaced htmlspecialchars with htmlentities
\r
2478 print "<PRE>---GOT---\n" . htmlentities($data) . "\n---END---\n</PRE>";
\r
2483 error_log('XML-RPC: xmlrpcmsg::parseResponse: no response received from server.');
\r
2484 $r =& new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_data'], $GLOBALS['xmlrpcstr']['no_data']);
\r
2488 $GLOBALS['_xh']=array();
\r
2490 $raw_data = $data;
\r
2491 // parse the HTTP headers of the response, if present, and separate them from data
\r
2492 if(substr($data, 0, 4) == 'HTTP')
\r
2494 $r =& $this->parseResponseHeaders($data, $headers_processed);
\r
2497 // failed processing of HTTP response headers
\r
2498 // save into response obj the full payload received, for debugging
\r
2499 $r->raw_data = $data;
\r
2505 $GLOBALS['_xh']['headers'] = array();
\r
2506 $GLOBALS['_xh']['cookies'] = array();
\r
2511 $start = strpos($data, '<!-- SERVER DEBUG INFO (BASE64 ENCODED):');
\r
2514 $start += strlen('<!-- SERVER DEBUG INFO (BASE64 ENCODED):');
\r
2515 $end = strpos($data, '-->', $start);
\r
2516 $comments = substr($data, $start, $end-$start);
\r
2517 print "<PRE>---SERVER DEBUG INFO (DECODED) ---\n\t".htmlentities(str_replace("\n", "\n\t", base64_decode($comments)))."\n---END---\n</PRE>";
\r
2521 // be tolerant of extra whitespace in response body
\r
2522 $data = trim($data);
\r
2524 /// @todo return an error msg if $data=='' ?
\r
2526 // be tolerant of junk after methodResponse (e.g. javascript ads automatically inserted by free hosts)
\r
2527 // idea from Luca Mariano <luca.mariano@email.it> originally in PEARified version of the lib
\r
2529 // Poor man's version of strrpos for php 4...
\r
2530 $pos = strpos($data, '</methodResponse>');
\r
2531 while($pos || is_int($pos))
\r
2534 $pos = strpos($data, '</methodResponse>', $bd);
\r
2538 $data = substr($data, 0, $bd);
\r
2541 // if user wants back raw xml, give it to him
\r
2542 if ($return_type == 'xml')
\r
2544 $r =& new xmlrpcresp($data, 0, '', 'xml');
\r
2545 $r->hdrs = $GLOBALS['_xh']['headers'];
\r
2546 $r->_cookies = $GLOBALS['_xh']['cookies'];
\r
2547 $r->raw_data = $raw_data;
\r
2551 // try to 'guestimate' the character encoding of the received response
\r
2552 $resp_encoding = guess_encoding(@$GLOBALS['_xh']['headers']['content-type'], $data);
\r
2554 $GLOBALS['_xh']['ac']='';
\r
2555 //$GLOBALS['_xh']['qt']=''; //unused...
\r
2556 $GLOBALS['_xh']['stack'] = array();
\r
2557 $GLOBALS['_xh']['valuestack'] = array();
\r
2558 $GLOBALS['_xh']['isf']=0; // 0 = OK, 1 for xmlrpc fault responses, 2 = invalid xmlrpc
\r
2559 $GLOBALS['_xh']['isf_reason']='';
\r
2560 $GLOBALS['_xh']['rt']=''; // 'methodcall or 'methodresponse'
\r
2562 // if response charset encoding is not known / supported, try to use
\r
2563 // the default encoding and parse the xml anyway, but log a warning...
\r
2564 if (!in_array($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
\r
2565 // the following code might be better for mb_string enabled installs, but
\r
2566 // makes the lib about 200% slower...
\r
2567 //if (!is_valid_charset($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
\r
2569 error_log('XML-RPC: xmlrpcmsg::parseResponse: invalid charset encoding of received response: '.$resp_encoding);
\r
2570 $resp_encoding = $GLOBALS['xmlrpc_defencoding'];
\r
2572 $parser = xml_parser_create($resp_encoding);
\r
2573 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true);
\r
2574 // G. Giunta 2005/02/13: PHP internally uses ISO-8859-1, so we have to tell
\r
2575 // the xml parser to give us back data in the expected charset.
\r
2576 // What if internal encoding is not in one of the 3 allowed?
\r
2577 // we use the broadest one, ie. utf8
\r
2578 // This allows to send data which is native in various charset,
\r
2579 // by extending xmlrpc_encode_entitites() and setting xmlrpc_internalencoding
\r
2580 if (!in_array($GLOBALS['xmlrpc_internalencoding'], array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
\r
2582 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');
\r
2586 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $GLOBALS['xmlrpc_internalencoding']);
\r
2589 if ($return_type == 'phpvals')
\r
2591 xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast');
\r
2595 xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee');
\r
2598 xml_set_character_data_handler($parser, 'xmlrpc_cd');
\r
2599 xml_set_default_handler($parser, 'xmlrpc_dh');
\r
2601 // first error check: xml not well formed
\r
2602 if(!xml_parse($parser, $data, count($data)))
\r
2604 // thanks to Peter Kocks <peter.kocks@baygate.com>
\r
2605 if((xml_get_current_line_number($parser)) == 1)
\r
2607 $errstr = 'XML error at line 1, check URL';
\r
2611 $errstr = sprintf('XML error: %s at line %d, column %d',
\r
2612 xml_error_string(xml_get_error_code($parser)),
\r
2613 xml_get_current_line_number($parser), xml_get_current_column_number($parser));
\r
2615 error_log($errstr);
\r
2616 $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'], $GLOBALS['xmlrpcstr']['invalid_return'].' ('.$errstr.')');
\r
2617 xml_parser_free($parser);
\r
2622 $r->hdrs = $GLOBALS['_xh']['headers'];
\r
2623 $r->_cookies = $GLOBALS['_xh']['cookies'];
\r
2624 $r->raw_data = $raw_data;
\r
2627 xml_parser_free($parser);
\r
2628 // second error check: xml well formed but not xml-rpc compliant
\r
2629 if ($GLOBALS['_xh']['isf'] > 1)
\r
2633 /// @todo echo something for user?
\r
2636 $r =& new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'],
\r
2637 $GLOBALS['xmlrpcstr']['invalid_return'] . ' ' . $GLOBALS['_xh']['isf_reason']);
\r
2639 // third error check: parsing of the response has somehow gone boink.
\r
2640 // NB: shall we omit this check, since we trust the parsing code?
\r
2641 elseif ($return_type == 'xmlrpcvals' && !is_object($GLOBALS['_xh']['value']))
\r
2643 // something odd has happened
\r
2644 // and it's time to generate a client side error
\r
2645 // indicating something odd went on
\r
2646 $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'],
\r
2647 $GLOBALS['xmlrpcstr']['invalid_return']);
\r
2653 print "<PRE>---PARSED---\n";
\r
2654 // somehow htmlentities chokes on var_export, and some full html string...
\r
2655 //print htmlentitites(var_export($GLOBALS['_xh']['value'], true));
\r
2656 print htmlspecialchars(var_export($GLOBALS['_xh']['value'], true));
\r
2657 print "\n---END---</PRE>";
\r
2660 // note that using =& will raise an error if $GLOBALS['_xh']['st'] does not generate an object.
\r
2661 $v =& $GLOBALS['_xh']['value'];
\r
2663 if($GLOBALS['_xh']['isf'])
\r
2665 /// @todo we should test here if server sent an int and a string,
\r
2666 /// and/or coerce them into such...
\r
2667 if ($return_type == 'xmlrpcvals')
\r
2669 $errno_v = $v->structmem('faultCode');
\r
2670 $errstr_v = $v->structmem('faultString');
\r
2671 $errno = $errno_v->scalarval();
\r
2672 $errstr = $errstr_v->scalarval();
\r
2676 $errno = $v['faultCode'];
\r
2677 $errstr = $v['faultString'];
\r
2682 // FAULT returned, errno needs to reflect that
\r
2686 $r =& new xmlrpcresp(0, $errno, $errstr);
\r
2690 $r=&new xmlrpcresp($v, 0, '', $return_type);
\r
2694 $r->hdrs = $GLOBALS['_xh']['headers'];
\r
2695 $r->_cookies = $GLOBALS['_xh']['cookies'];
\r
2696 $r->raw_data = $raw_data;
\r
2705 var $_php_class=null;
\r
2708 * @param mixed $val
\r
2709 * @param string $type any valid xmlrpc type name (lowercase). If null, 'string' is assumed
\r
2711 function xmlrpcval($val=-1, $type='')
\r
2713 /// @todo: optimization creep - do not call addXX, do it all inline.
\r
2714 /// downside: booleans will not be coerced anymore
\r
2715 if($val!==-1 || $type!='')
\r
2717 // optimization creep: inlined all work done by constructor
\r
2722 $this->me['string']=$val;
\r
2729 case 'dateTime.iso8601':
\r
2733 $this->me[$type]=$val;
\r
2737 $this->me['array']=$val;
\r
2741 $this->me['struct']=$val;
\r
2744 error_log("XML-RPC: xmlrpcval::xmlrpcval: not a known type ($type)");
\r
2750 if($GLOBALS['xmlrpcTypes'][$type]==1)
\r
2752 $this->addScalar($val,$type);
\r
2754 elseif($GLOBALS['xmlrpcTypes'][$type]==2)
\r
2756 $this->addArray($val);
\r
2758 elseif($GLOBALS['xmlrpcTypes'][$type]==3)
\r
2760 $this->addStruct($val);
\r
2766 * Add a single php value to an (unitialized) xmlrpcval
\r
2767 * @param mixed $val
\r
2768 * @param string $type
\r
2769 * @return int 1 or 0 on failure
\r
2771 function addScalar($val, $type='string')
\r
2773 $typeof=@$GLOBALS['xmlrpcTypes'][$type];
\r
2776 error_log("XML-RPC: xmlrpcval::addScalar: not a scalar type ($type)");
\r
2780 // coerce booleans into correct values
\r
2781 // NB: we should iether do it for datetimes, integers and doubles, too,
\r
2782 // or just plain remove this check, implemnted on booleans only...
\r
2783 if($type==$GLOBALS['xmlrpcBoolean'])
\r
2785 if(strcasecmp($val,'true')==0 || $val==1 || ($val==true && strcasecmp($val,'false')))
\r
2795 switch($this->mytype)
\r
2798 error_log('XML-RPC: xmlrpcval::addScalar: scalar xmlrpcval can have only one value');
\r
2801 error_log('XML-RPC: xmlrpcval::addScalar: cannot add anonymous scalar to struct xmlrpcval');
\r
2804 // we're adding a scalar value to an array here
\r
2805 //$ar=$this->me['array'];
\r
2806 //$ar[]=&new xmlrpcval($val, $type);
\r
2807 //$this->me['array']=$ar;
\r
2808 // Faster (?) avoid all the costly array-copy-by-val done here...
\r
2809 $this->me['array'][]=&new xmlrpcval($val, $type);
\r
2812 // a scalar, so set the value and remember we're scalar
\r
2813 $this->me[$type]=$val;
\r
2814 $this->mytype=$typeof;
\r
2820 * Add an array of xmlrpcval objects to an xmlrpcval
\r
2821 * @param array $vals
\r
2822 * @return int 1 or 0 on failure
\r
2825 * @todo add some checking for $vals to be an array of xmlrpcvals?
\r
2827 function addArray($vals)
\r
2829 if($this->mytype==0)
\r
2831 $this->mytype=$GLOBALS['xmlrpcTypes']['array'];
\r
2832 $this->me['array']=$vals;
\r
2835 elseif($this->mytype==2)
\r
2837 // we're adding to an array here
\r
2838 $this->me['array'] = array_merge($this->me['array'], $vals);
\r
2843 error_log('XML-RPC: xmlrpcval::addArray: already initialized as a [' . $this->kindOf() . ']');
\r
2849 * Add an array of named xmlrpcval objects to an xmlrpcval
\r
2850 * @param array $vals
\r
2851 * @return int 1 or 0 on failure
\r
2854 * @todo add some checking for $vals to be an array?
\r
2856 function addStruct($vals)
\r
2858 if($this->mytype==0)
\r
2860 $this->mytype=$GLOBALS['xmlrpcTypes']['struct'];
\r
2861 $this->me['struct']=$vals;
\r
2864 elseif($this->mytype==3)
\r
2866 // we're adding to a struct here
\r
2867 $this->me['struct'] = array_merge($this->me['struct'], $vals);
\r
2872 error_log('XML-RPC: xmlrpcval::addStruct: already initialized as a [' . $this->kindOf() . ']');
\r
2877 // poor man's version of print_r ???
\r
2879 function dump($ar)
\r
2881 foreach($ar as $key => $val)
\r
2883 echo "$key => $val<br />";
\r
2884 if($key == 'array')
\r
2886 while(list($key2, $val2) = each($val))
\r
2888 echo "-- $key2 => $val2<br />";
\r
2895 * Returns a string containing "struct", "array" or "scalar" describing the base type of the value
\r
2901 switch($this->mytype)
\r
2920 function serializedata($typ, $val, $charset_encoding='')
\r
2923 switch(@$GLOBALS['xmlrpcTypes'][$typ])
\r
2928 case $GLOBALS['xmlrpcBase64']:
\r
2929 $rs.="<${typ}>" . base64_encode($val) . "</${typ}>";
\r
2931 case $GLOBALS['xmlrpcBoolean']:
\r
2932 $rs.="<${typ}>" . ($val ? '1' : '0') . "</${typ}>";
\r
2934 case $GLOBALS['xmlrpcString']:
\r
2935 // G. Giunta 2005/2/13: do NOT use htmlentities, since
\r
2936 // it will produce named html entities, which are invalid xml
\r
2937 $rs.="<${typ}>" . xmlrpc_encode_entitites($val, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding). "</${typ}>";
\r
2939 case $GLOBALS['xmlrpcInt']:
\r
2940 case $GLOBALS['xmlrpcI4']:
\r
2941 $rs.="<${typ}>".(int)$val."</${typ}>";
\r
2943 case $GLOBALS['xmlrpcDouble']:
\r
2944 // avoid using standard conversion of float to string because it is locale-dependent,
\r
2945 // and also because the xmlrpc spec forbids exponential notation
\r
2946 // sprintf('%F') would be most likely ok but it is only available since PHP 4.3.10 and PHP 5.0.3.
\r
2947 // The code below tries its best at keeping max precision while avoiding exp notation,
\r
2948 // but there is of course no limit in the number of decimal places to be used...
\r
2949 $rs.="<${typ}>".preg_replace('/\\.?0+$/','',number_format((double)$val, 128, '.', ''))."</${typ}>";
\r
2951 case $GLOBALS['xmlrpcNull']:
\r
2955 // no standard type value should arrive here, but provide a possibility
\r
2956 // for xmlrpcvals of unknown type...
\r
2957 $rs.="<${typ}>${val}</${typ}>";
\r
2962 if ($this->_php_class)
\r
2964 $rs.='<struct php_class="' . $this->_php_class . "\">\n";
\r
2968 $rs.="<struct>\n";
\r
2970 foreach($val as $key2 => $val2)
\r
2972 $rs.='<member><name>'.xmlrpc_encode_entitites($key2, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding)."</name>\n";
\r
2973 //$rs.=$this->serializeval($val2);
\r
2974 $rs.=$val2->serialize($charset_encoding);
\r
2975 $rs.="</member>\n";
\r
2981 $rs.="<array>\n<data>\n";
\r
2982 for($i=0; $i<count($val); $i++)
\r
2984 //$rs.=$this->serializeval($val[$i]);
\r
2985 $rs.=$val[$i]->serialize($charset_encoding);
\r
2987 $rs.="</data>\n</array>";
\r
2996 * Returns xml representation of the value. XML prologue not included
\r
2997 * @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed
\r
3001 function serialize($charset_encoding='')
\r
3003 // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...
\r
3004 //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))
\r
3007 list($typ, $val) = each($this->me);
\r
3008 return '<value>' . $this->serializedata($typ, $val, $charset_encoding) . "</value>\n";
\r
3013 function serializeval($o)
\r
3015 // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...
\r
3016 //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))
\r
3020 list($typ, $val) = each($ar);
\r
3021 return '<value>' . $this->serializedata($typ, $val) . "</value>\n";
\r
3026 * Checks wheter a struct member with a given name is present.
\r
3027 * Works only on xmlrpcvals of type struct.
\r
3028 * @param string $m the name of the struct member to be looked up
\r
3032 function structmemexists($m)
\r
3034 return array_key_exists($m, $this->me['struct']);
\r
3038 * Returns the value of a given struct member (an xmlrpcval object in itself).
\r
3039 * Will raise a php warning if struct member of given name does not exist
\r
3040 * @param string $m the name of the struct member to be looked up
\r
3041 * @return xmlrpcval
\r
3044 function structmem($m)
\r
3046 return $this->me['struct'][$m];
\r
3050 * Reset internal pointer for xmlrpcvals of type struct.
\r
3053 function structreset()
\r
3055 reset($this->me['struct']);
\r
3059 * Return next member element for xmlrpcvals of type struct.
\r
3060 * @return xmlrpcval
\r
3063 function structeach()
\r
3065 return each($this->me['struct']);
\r
3068 // DEPRECATED! this code looks like it is very fragile and has not been fixed
\r
3069 // for a long long time. Shall we remove it for 2.0?
\r
3074 list($a,$b)=each($this->me);
\r
3075 // contributed by I Sofer, 2001-03-24
\r
3076 // add support for nested arrays to scalarval
\r
3077 // i've created a new method here, so as to
\r
3078 // preserve back compatibility
\r
3083 while(list($id,$cont) = @each($b))
\r
3085 $b[$id] = $cont->scalarval();
\r
3089 // add support for structures directly encoding php objects
\r
3092 $t = get_object_vars($b);
\r
3094 while(list($id,$cont) = @each($t))
\r
3096 $t[$id] = $cont->scalarval();
\r
3099 while(list($id,$cont) = @each($t))
\r
3109 * Returns the value of a scalar xmlrpcval
\r
3113 function scalarval()
\r
3116 list(,$b)=each($this->me);
\r
3121 * Returns the type of the xmlrpcval.
\r
3122 * For integers, 'int' is always returned in place of 'i4'
\r
3126 function scalartyp()
\r
3129 list($a,)=each($this->me);
\r
3130 if($a==$GLOBALS['xmlrpcI4'])
\r
3132 $a=$GLOBALS['xmlrpcInt'];
\r
3138 * Returns the m-th member of an xmlrpcval of struct type
\r
3139 * @param integer $m the index of the value to be retrieved (zero based)
\r
3140 * @return xmlrpcval
\r
3143 function arraymem($m)
\r
3145 return $this->me['array'][$m];
\r
3149 * Returns the number of members in an xmlrpcval of array type
\r
3153 function arraysize()
\r
3155 return count($this->me['array']);
\r
3159 * Returns the number of members in an xmlrpcval of struct type
\r
3163 function structsize()
\r
3165 return count($this->me['struct']);
\r
3173 * Given a timestamp, return the corresponding ISO8601 encoded string.
\r
3175 * Really, timezones ought to be supported
\r
3176 * but the XML-RPC spec says:
\r
3178 * "Don't assume a timezone. It should be specified by the server in its
\r
3179 * documentation what assumptions it makes about timezones."
\r
3181 * These routines always assume localtime unless
\r
3182 * $utc is set to 1, in which case UTC is assumed
\r
3183 * and an adjustment for locale is made when encoding
\r
3185 * @param int $timet (timestamp)
\r
3186 * @param int $utc (0 or 1)
\r
3189 function iso8601_encode($timet, $utc=0)
\r
3193 $t=strftime("%Y%m%dT%H:%M:%S", $timet);
\r
3197 if(function_exists('gmstrftime'))
\r
3199 // gmstrftime doesn't exist in some versions
\r
3201 $t=gmstrftime("%Y%m%dT%H:%M:%S", $timet);
\r
3205 $t=strftime("%Y%m%dT%H:%M:%S", $timet-date('Z'));
\r
3212 * Given an ISO8601 date string, return a timet in the localtime, or UTC
\r
3213 * @param string $idate
\r
3214 * @param int $utc either 0 or 1
\r
3215 * @return int (datetime)
\r
3217 function iso8601_decode($idate, $utc=0)
\r
3220 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
3224 $t=gmmktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);
\r
3228 $t=mktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);
\r
3235 * Takes an xmlrpc value in PHP xmlrpcval object format and translates it into native PHP types.
\r
3237 * Works with xmlrpc message objects as input, too.
\r
3239 * Given proper options parameter, can rebuild generic php object instances
\r
3240 * (provided those have been encoded to xmlrpc format using a corresponding
\r
3241 * option in php_xmlrpc_encode())
\r
3242 * PLEASE NOTE that rebuilding php objects involves calling their constructor function.
\r
3243 * This means that the remote communication end can decide which php code will
\r
3244 * get executed on your server, leaving the door possibly open to 'php-injection'
\r
3245 * style of attacks (provided you have some classes defined on your server that
\r
3246 * might wreak havoc if instances are built outside an appropriate context).
\r
3247 * Make sure you trust the remote server/client before eanbling this!
\r
3249 * @author Dan Libby (dan@libby.com)
\r
3251 * @param xmlrpcval $xmlrpc_val
\r
3252 * @param array $options if 'decode_php_objs' is set in the options array, xmlrpc structs can be decoded into php objects
\r
3255 function php_xmlrpc_decode($xmlrpc_val, $options=array())
\r
3257 switch($xmlrpc_val->kindOf())
\r
3260 if (in_array('extension_api', $options))
\r
3262 reset($xmlrpc_val->me);
\r
3263 list($typ,$val) = each($xmlrpc_val->me);
\r
3266 case 'dateTime.iso8601':
\r
3267 $xmlrpc_val->scalar = $val;
\r
3268 $xmlrpc_val->xmlrpc_type = 'datetime';
\r
3269 $xmlrpc_val->timestamp = iso8601_decode($val);
\r
3270 return $xmlrpc_val;
\r
3272 $xmlrpc_val->scalar = $val;
\r
3273 $xmlrpc_val->type = $typ;
\r
3274 return $xmlrpc_val;
\r
3276 return $xmlrpc_val->scalarval();
\r
3279 return $xmlrpc_val->scalarval();
\r
3281 $size = $xmlrpc_val->arraysize();
\r
3283 for($i = 0; $i < $size; $i++)
\r
3285 $arr[] = php_xmlrpc_decode($xmlrpc_val->arraymem($i), $options);
\r
3289 $xmlrpc_val->structreset();
\r
3290 // If user said so, try to rebuild php objects for specific struct vals.
\r
3291 /// @todo should we raise a warning for class not found?
\r
3292 // shall we check for proper subclass of xmlrpcval instead of
\r
3293 // presence of _php_class to detect what we can do?
\r
3294 if (in_array('decode_php_objs', $options) && $xmlrpc_val->_php_class != ''
\r
3295 && class_exists($xmlrpc_val->_php_class))
\r
3297 $obj = @new $xmlrpc_val->_php_class;
\r
3298 while(list($key,$value)=$xmlrpc_val->structeach())
\r
3300 $obj->$key = php_xmlrpc_decode($value, $options);
\r
3307 while(list($key,$value)=$xmlrpc_val->structeach())
\r
3309 $arr[$key] = php_xmlrpc_decode($value, $options);
\r
3314 $paramcount = $xmlrpc_val->getNumParams();
\r
3316 for($i = 0; $i < $paramcount; $i++)
\r
3318 $arr[] = php_xmlrpc_decode($xmlrpc_val->getParam($i));
\r
3324 // This constant left here only for historical reasons...
\r
3325 // it was used to decide if we have to define xmlrpc_encode on our own, but
\r
3326 // we do not do it anymore
\r
3327 if(function_exists('xmlrpc_decode'))
\r
3329 define('XMLRPC_EPI_ENABLED','1');
\r
3333 define('XMLRPC_EPI_ENABLED','0');
\r
3337 * Takes native php types and encodes them into xmlrpc PHP object format.
\r
3338 * It will not re-encode xmlrpcval objects.
\r
3340 * Feature creep -- could support more types via optional type argument
\r
3341 * (string => datetime support has been added, ??? => base64 not yet)
\r
3343 * If given a proper options parameter, php object instances will be encoded
\r
3344 * into 'special' xmlrpc values, that can later be decoded into php objects
\r
3345 * by calling php_xmlrpc_decode() with a corresponding option
\r
3347 * @author Dan Libby (dan@libby.com)
\r
3349 * @param mixed $php_val the value to be converted into an xmlrpcval object
\r
3350 * @param array $options can include 'encode_php_objs', 'auto_dates', 'null_extension' or 'extension_api'
\r
3351 * @return xmlrpcval
\r
3353 function &php_xmlrpc_encode($php_val, $options=array())
\r
3355 $type = gettype($php_val);
\r
3359 if (in_array('auto_dates', $options) && preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $php_val))
\r
3360 $xmlrpc_val =& new xmlrpcval($php_val, $GLOBALS['xmlrpcDateTime']);
\r
3362 $xmlrpc_val =& new xmlrpcval($php_val, $GLOBALS['xmlrpcString']);
\r
3365 $xmlrpc_val =& new xmlrpcval($php_val, $GLOBALS['xmlrpcInt']);
\r
3368 $xmlrpc_val =& new xmlrpcval($php_val, $GLOBALS['xmlrpcDouble']);
\r
3370 // <G_Giunta_2001-02-29>
\r
3371 // Add support for encoding/decoding of booleans, since they are supported in PHP
\r
3373 $xmlrpc_val =& new xmlrpcval($php_val, $GLOBALS['xmlrpcBoolean']);
\r
3375 // </G_Giunta_2001-02-29>
\r
3377 // PHP arrays can be encoded to either xmlrpc structs or arrays,
\r
3378 // depending on wheter they are hashes or plain 0..n integer indexed
\r
3379 // A shorter one-liner would be
\r
3380 // $tmp = array_diff(array_keys($php_val), range(0, count($php_val)-1));
\r
3381 // but execution time skyrockets!
\r
3385 foreach($php_val as $key => $val)
\r
3387 $arr[$key] =& php_xmlrpc_encode($val, $options);
\r
3388 if(!$ko && $key !== $j)
\r
3396 $xmlrpc_val =& new xmlrpcval($arr, $GLOBALS['xmlrpcStruct']);
\r
3400 $xmlrpc_val =& new xmlrpcval($arr, $GLOBALS['xmlrpcArray']);
\r
3404 if(is_a($php_val, 'xmlrpcval'))
\r
3406 $xmlrpc_val = $php_val;
\r
3411 while(list($k,$v) = each($php_val))
\r
3413 $arr[$k] = php_xmlrpc_encode($v, $options);
\r
3415 $xmlrpc_val =& new xmlrpcval($arr, $GLOBALS['xmlrpcStruct']);
\r
3416 if (in_array('encode_php_objs', $options))
\r
3418 // let's save original class name into xmlrpcval:
\r
3419 // might be useful later on...
\r
3420 $xmlrpc_val->_php_class = get_class($php_val);
\r
3425 if (in_array('extension_api', $options))
\r
3427 $xmlrpc_val =& new xmlrpcval('', $GLOBALS['xmlrpcString']);
\r
3429 if (in_array('null_extension', $options))
\r
3431 $xmlrpc_val =& new xmlrpcval('', $GLOBALS['xmlrpcNull']);
\r
3435 $xmlrpc_val =& new xmlrpcval();
\r
3439 if (in_array('extension_api', $options))
\r
3441 $xmlrpc_val =& new xmlrpcval((int)$php_val, $GLOBALS['xmlrpcInt']);
\r
3445 $xmlrpc_val =& new xmlrpcval();
\r
3447 // catch "user function", "unknown type"
\r
3449 // giancarlo pinerolo <ping@alt.it>
\r
3450 // it has to return
\r
3451 // an empty object in case, not a boolean.
\r
3452 $xmlrpc_val =& new xmlrpcval();
\r
3455 return $xmlrpc_val;
\r
3459 * Convert the xml representation of a method response, method request or single
\r
3460 * xmlrpc value into the appropriate object (a.k.a. deserialize)
\r
3461 * @param string $xml_val
\r
3462 * @param array $options
\r
3463 * @return mixed false on error, or an instance of either xmlrpcval, xmlrpcmsg or xmlrpcresp
\r
3465 function php_xmlrpc_decode_xml($xml_val, $options=array())
\r
3467 $GLOBALS['_xh'] = array();
\r
3468 $GLOBALS['_xh']['ac'] = '';
\r
3469 $GLOBALS['_xh']['stack'] = array();
\r
3470 $GLOBALS['_xh']['valuestack'] = array();
\r
3471 $GLOBALS['_xh']['params'] = array();
\r
3472 $GLOBALS['_xh']['pt'] = array();
\r
3473 $GLOBALS['_xh']['isf'] = 0;
\r
3474 $GLOBALS['_xh']['isf_reason'] = '';
\r
3475 $GLOBALS['_xh']['method'] = false;
\r
3476 $GLOBALS['_xh']['rt'] = '';
\r
3477 /// @todo 'guestimate' encoding
\r
3478 $parser = xml_parser_create();
\r
3479 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true);
\r
3480 // What if internal encoding is not in one of the 3 allowed?
\r
3481 // we use the broadest one, ie. utf8!
\r
3482 if (!in_array($GLOBALS['xmlrpc_internalencoding'], array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
\r
3484 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');
\r
3488 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $GLOBALS['xmlrpc_internalencoding']);
\r
3490 xml_set_element_handler($parser, 'xmlrpc_se_any', 'xmlrpc_ee');
\r
3491 xml_set_character_data_handler($parser, 'xmlrpc_cd');
\r
3492 xml_set_default_handler($parser, 'xmlrpc_dh');
\r
3493 if(!xml_parse($parser, $xml_val, 1))
\r
3495 $errstr = sprintf('XML error: %s at line %d, column %d',
\r
3496 xml_error_string(xml_get_error_code($parser)),
\r
3497 xml_get_current_line_number($parser), xml_get_current_column_number($parser));
\r
3498 error_log($errstr);
\r
3499 xml_parser_free($parser);
\r
3502 xml_parser_free($parser);
\r
3503 if ($GLOBALS['_xh']['isf'] > 1) // test that $GLOBALS['_xh']['value'] is an obj, too???
\r
3505 error_log($GLOBALS['_xh']['isf_reason']);
\r
3508 switch ($GLOBALS['_xh']['rt'])
\r
3510 case 'methodresponse':
\r
3511 $v =& $GLOBALS['_xh']['value'];
\r
3512 if ($GLOBALS['_xh']['isf'] == 1)
\r
3514 $vc = $v->structmem('faultCode');
\r
3515 $vs = $v->structmem('faultString');
\r
3516 $r =& new xmlrpcresp(0, $vc->scalarval(), $vs->scalarval());
\r
3520 $r =& new xmlrpcresp($v);
\r
3523 case 'methodcall':
\r
3524 $m =& new xmlrpcmsg($GLOBALS['_xh']['method']);
\r
3525 for($i=0; $i < count($GLOBALS['_xh']['params']); $i++)
\r
3527 $m->addParam($GLOBALS['_xh']['params'][$i]);
\r
3531 return $GLOBALS['_xh']['value'];
\r
3538 * decode a string that is encoded w/ "chunked" transfer encoding
\r
3539 * as defined in rfc2068 par. 19.4.6
\r
3540 * code shamelessly stolen from nusoap library by Dietrich Ayala
\r
3542 * @param string $buffer the string to be decoded
\r
3545 function decode_chunked($buffer)
\r
3551 // read chunk-size, chunk-extension (if any) and crlf
\r
3552 // get the position of the linebreak
\r
3553 $chunkend = strpos($buffer,"\r\n") + 2;
\r
3554 $temp = substr($buffer,0,$chunkend);
\r
3555 $chunk_size = hexdec( trim($temp) );
\r
3556 $chunkstart = $chunkend;
\r
3557 while($chunk_size > 0)
\r
3559 $chunkend = strpos($buffer, "\r\n", $chunkstart + $chunk_size);
\r
3561 // just in case we got a broken connection
\r
3562 if($chunkend == false)
\r
3564 $chunk = substr($buffer,$chunkstart);
\r
3565 // append chunk-data to entity-body
\r
3567 $length += strlen($chunk);
\r
3571 // read chunk-data and crlf
\r
3572 $chunk = substr($buffer,$chunkstart,$chunkend-$chunkstart);
\r
3573 // append chunk-data to entity-body
\r
3575 // length := length + chunk-size
\r
3576 $length += strlen($chunk);
\r
3577 // read chunk-size and crlf
\r
3578 $chunkstart = $chunkend + 2;
\r
3580 $chunkend = strpos($buffer,"\r\n",$chunkstart)+2;
\r
3581 if($chunkend == false)
\r
3583 break; //just in case we got a broken connection
\r
3585 $temp = substr($buffer,$chunkstart,$chunkend-$chunkstart);
\r
3586 $chunk_size = hexdec( trim($temp) );
\r
3587 $chunkstart = $chunkend;
\r
3593 * xml charset encoding guessing helper function.
\r
3594 * Tries to determine the charset encoding of an XML chunk received over HTTP.
\r
3595 * NB: according to the spec (RFC 3023), if text/xml content-type is received over HTTP without a content-type,
\r
3596 * we SHOULD assume it is strictly US-ASCII. But we try to be more tolerant of unconforming (legacy?) clients/servers,
\r
3597 * which will be most probably using UTF-8 anyway...
\r
3599 * @param string $httpheaders the http Content-type header
\r
3600 * @param string $xmlchunk xml content buffer
\r
3601 * @param string $encoding_prefs comma separated list of character encodings to be used as default (when mb extension is enabled)
\r
3603 * @todo explore usage of mb_http_input(): does it detect http headers + post data? if so, use it instead of hand-detection!!!
\r
3605 function guess_encoding($httpheader='', $xmlchunk='', $encoding_prefs=null)
\r
3607 // discussion: see http://www.yale.edu/pclt/encoding/
\r
3608 // 1 - test if encoding is specified in HTTP HEADERS
\r
3611 // LWS: (\13\10)?( |\t)+
\r
3612 // token: (any char but excluded stuff)+
\r
3613 // quoted string: " (any char but double quotes and cointrol chars)* "
\r
3614 // header: Content-type = ...; charset=value(; ...)*
\r
3615 // where value is of type token, no LWS allowed between 'charset' and value
\r
3616 // Note: we do not check for invalid chars in VALUE:
\r
3617 // this had better be done using pure ereg as below
\r
3618 // Note 2: we might be removing whitespace/tabs that ought to be left in if
\r
3619 // the received charset is a quoted string. But nobody uses such charset names...
\r
3621 /// @todo this test will pass if ANY header has charset specification, not only Content-Type. Fix it?
\r
3622 $matches = array();
\r
3623 if(preg_match('/;\s*charset\s*=([^;]+)/i', $httpheader, $matches))
\r
3625 return strtoupper(trim($matches[1], " \t\""));
\r
3628 // 2 - scan the first bytes of the data for a UTF-16 (or other) BOM pattern
\r
3629 // (source: http://www.w3.org/TR/2000/REC-xml-20001006)
\r
3630 // NOTE: actually, according to the spec, even if we find the BOM and determine
\r
3631 // an encoding, we should check if there is an encoding specified
\r
3632 // in the xml declaration, and verify if they match.
\r
3633 /// @todo implement check as described above?
\r
3634 /// @todo implement check for first bytes of string even without a BOM? (It sure looks harder than for cases WITH a BOM)
\r
3635 if(preg_match('/^(\x00\x00\xFE\xFF|\xFF\xFE\x00\x00|\x00\x00\xFF\xFE|\xFE\xFF\x00\x00)/', $xmlchunk))
\r
3639 elseif(preg_match('/^(\xFE\xFF|\xFF\xFE)/', $xmlchunk))
\r
3643 elseif(preg_match('/^(\xEF\xBB\xBF)/', $xmlchunk))
\r
3648 // 3 - test if encoding is specified in the xml declaration
\r
3650 // SPACE: (#x20 | #x9 | #xD | #xA)+ === [ \x9\xD\xA]+
\r
3651 // EQ: SPACE?=SPACE? === [ \x9\xD\xA]*=[ \x9\xD\xA]*
\r
3652 if (preg_match('/^<\?xml\s+version\s*=\s*'. "((?:\"[a-zA-Z0-9_.:-]+\")|(?:'[a-zA-Z0-9_.:-]+'))".
\r
3653 '\s+encoding\s*=\s*' . "((?:\"[A-Za-z][A-Za-z0-9._-]*\")|(?:'[A-Za-z][A-Za-z0-9._-]*'))/",
\r
3654 $xmlchunk, $matches))
\r
3656 return strtoupper(substr($matches[2], 1, -1));
\r
3659 // 4 - if mbstring is available, let it do the guesswork
\r
3660 // NB: we favour finding an encoding that is compatible with what we can process
\r
3661 if(extension_loaded('mbstring'))
\r
3663 if($encoding_prefs)
\r
3665 $enc = mb_detect_encoding($xmlchunk, $encoding_prefs);
\r
3669 $enc = mb_detect_encoding($xmlchunk);
\r
3671 // NB: mb_detect likes to call it ascii, xml parser likes to call it US_ASCII...
\r
3672 // IANA also likes better US-ASCII, so go with it
\r
3673 if($enc == 'ASCII')
\r
3675 $enc = 'US-'.$enc;
\r
3681 // no encoding specified: as per HTTP1.1 assume it is iso-8859-1?
\r
3682 // Both RFC 2616 (HTTP 1.1) and 1945 (HTTP 1.0) clearly state that for text/xxx content types
\r
3683 // this should be the standard. And we should be getting text/xml as request and response.
\r
3684 // BUT we have to be backward compatible with the lib, which always used UTF-8 as default...
\r
3685 return $GLOBALS['xmlrpc_defencoding'];
\r
3690 * Checks if a given charset encoding is present in a list of encodings or
\r
3691 * if it is a valid subset of any encoding in the list
\r
3692 * @param string $encoding charset to be tested
\r
3693 * @param mixed $validlist comma separated list of valid charsets (or array of charsets)
\r
3695 function is_valid_charset($encoding, $validlist)
\r
3697 $charset_supersets = array(
\r
3698 'US-ASCII' => array ('ISO-8859-1', 'ISO-8859-2', 'ISO-8859-3', 'ISO-8859-4',
\r
3699 'ISO-8859-5', 'ISO-8859-6', 'ISO-8859-7', 'ISO-8859-8',
\r
3700 'ISO-8859-9', 'ISO-8859-10', 'ISO-8859-11', 'ISO-8859-12',
\r
3701 'ISO-8859-13', 'ISO-8859-14', 'ISO-8859-15', 'UTF-8',
\r
3702 'EUC-JP', 'EUC-', 'EUC-KR', 'EUC-CN')
\r
3704 if (is_string($validlist))
\r
3705 $validlist = explode(',', $validlist);
\r
3706 if (@in_array(strtoupper($encoding), $validlist))
\r
3710 if (array_key_exists($encoding, $charset_supersets))
\r
3711 foreach ($validlist as $allowed)
\r
3712 if (in_array($allowed, $charset_supersets[$encoding]))
\r
git://git.onelab.eu / plcapi.git / blob