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 // G. Giunta 2005/01/29: declare global these variables,
\r
49 // so that xmlrpc.inc will work even if included from within a function
\r
50 // Milosch: 2005/08/07 - explicitly request these via $GLOBALS where used.
\r
51 $GLOBALS['xmlrpcI4']='i4';
\r
52 $GLOBALS['xmlrpcInt']='int';
\r
53 $GLOBALS['xmlrpcBoolean']='boolean';
\r
54 $GLOBALS['xmlrpcDouble']='double';
\r
55 $GLOBALS['xmlrpcString']='string';
\r
56 $GLOBALS['xmlrpcDateTime']='dateTime.iso8601';
\r
57 $GLOBALS['xmlrpcBase64']='base64';
\r
58 $GLOBALS['xmlrpcArray']='array';
\r
59 $GLOBALS['xmlrpcStruct']='struct';
\r
60 $GLOBALS['xmlrpcValue']='undefined';
\r
62 $GLOBALS['xmlrpcTypes']=array(
\r
63 $GLOBALS['xmlrpcI4'] => 1,
\r
64 $GLOBALS['xmlrpcInt'] => 1,
\r
65 $GLOBALS['xmlrpcBoolean'] => 1,
\r
66 $GLOBALS['xmlrpcString'] => 1,
\r
67 $GLOBALS['xmlrpcDouble'] => 1,
\r
68 $GLOBALS['xmlrpcDateTime'] => 1,
\r
69 $GLOBALS['xmlrpcBase64'] => 1,
\r
70 $GLOBALS['xmlrpcArray'] => 2,
\r
71 $GLOBALS['xmlrpcStruct'] => 3
\r
74 $GLOBALS['xmlrpc_valid_parents'] = array(
\r
75 'VALUE' => array('MEMBER', 'DATA', 'PARAM', 'FAULT'),
\r
76 'BOOLEAN' => array('VALUE'),
\r
77 'I4' => array('VALUE'),
\r
78 'INT' => array('VALUE'),
\r
79 'STRING' => array('VALUE'),
\r
80 'DOUBLE' => array('VALUE'),
\r
81 'DATETIME.ISO8601' => array('VALUE'),
\r
82 'BASE64' => array('VALUE'),
\r
83 'MEMBER' => array('STRUCT'),
\r
84 'NAME' => array('MEMBER'),
\r
85 'DATA' => array('ARRAY'),
\r
86 'ARRAY' => array('VALUE'),
\r
87 'STRUCT' => array('VALUE'),
\r
88 'PARAM' => array('PARAMS'),
\r
89 'METHODNAME' => array('METHODCALL'),
\r
90 'PARAMS' => array('METHODCALL', 'METHODRESPONSE'),
\r
91 'FAULT' => array('METHODRESPONSE'),
\r
92 'NIL' => array('VALUE'), // only used when extension activated
\r
93 'EX:NIL' => array('VALUE') // only used when extension activated
\r
96 // define extra types for supporting NULL (useful for json or <NIL/>)
\r
97 $GLOBALS['xmlrpcNull']='null';
\r
98 $GLOBALS['xmlrpcTypes']['null']=1;
\r
100 // Not in use anymore since 2.0. Shall we remove it?
\r
102 $GLOBALS['xmlEntities']=array(
\r
110 // tables used for transcoding different charsets into us-ascii xml
\r
112 $GLOBALS['xml_iso88591_Entities']=array();
\r
113 $GLOBALS['xml_iso88591_Entities']['in'] = array();
\r
114 $GLOBALS['xml_iso88591_Entities']['out'] = array();
\r
115 for ($i = 0; $i < 32; $i++)
\r
117 $GLOBALS['xml_iso88591_Entities']['in'][] = chr($i);
\r
118 $GLOBALS['xml_iso88591_Entities']['out'][] = '&#'.$i.';';
\r
120 for ($i = 160; $i < 256; $i++)
\r
122 $GLOBALS['xml_iso88591_Entities']['in'][] = chr($i);
\r
123 $GLOBALS['xml_iso88591_Entities']['out'][] = '&#'.$i.';';
\r
126 /// @todo add to iso table the characters from cp_1252 range, i.e. 128 to 159?
\r
127 /// These will NOT be present in true ISO-8859-1, but will save the unwary
\r
128 /// windows user from sending junk (though no luck when reciving them...)
\r
130 $GLOBALS['xml_cp1252_Entities']=array();
\r
131 for ($i = 128; $i < 160; $i++)
\r
133 $GLOBALS['xml_cp1252_Entities']['in'][] = chr($i);
\r
135 $GLOBALS['xml_cp1252_Entities']['out'] = array(
\r
136 '€', '?', '‚', 'ƒ',
\r
137 '„', '…', '†', '‡',
\r
138 'ˆ', '‰', 'Š', '‹',
\r
139 'Œ', '?', 'Ž', '?',
\r
140 '?', '‘', '’', '“',
\r
141 '”', '•', '–', '—',
\r
142 '˜', '™', 'š', '›',
\r
143 'œ', '?', 'ž', 'Ÿ'
\r
147 $GLOBALS['xmlrpcerr'] = array(
\r
148 'unknown_method'=>1,
\r
149 'invalid_return'=>2,
\r
150 'incorrect_params'=>3,
\r
151 'introspect_unknown'=>4,
\r
156 'invalid_request'=>15,
\r
158 'server_error'=>17,
\r
159 'multicall_error'=>18,
\r
160 'multicall_notstruct'=>9,
\r
161 'multicall_nomethod'=>10,
\r
162 'multicall_notstring'=>11,
\r
163 'multicall_recursion'=>12,
\r
164 'multicall_noparams'=>13,
\r
165 'multicall_notarray'=>14,
\r
167 'cannot_decompress'=>103,
\r
168 'decompress_fail'=>104,
\r
169 'dechunk_fail'=>105,
\r
170 'server_cannot_decompress'=>106,
\r
171 'server_decompress_fail'=>107
\r
174 $GLOBALS['xmlrpcstr'] = array(
\r
175 'unknown_method'=>'Unknown method',
\r
176 'invalid_return'=>'Invalid return payload: enable debugging to examine incoming payload',
\r
177 'incorrect_params'=>'Incorrect parameters passed to method',
\r
178 'introspect_unknown'=>"Can't introspect: method unknown",
\r
179 'http_error'=>"Didn't receive 200 OK from remote server.",
\r
180 'no_data'=>'No data received from server.',
\r
181 'no_ssl'=>'No SSL support compiled in.',
\r
182 'curl_fail'=>'CURL error',
\r
183 'invalid_request'=>'Invalid request payload',
\r
184 'no_curl'=>'No CURL support compiled in.',
\r
185 'server_error'=>'Internal server error',
\r
186 'multicall_error'=>'Received from server invalid multicall response',
\r
187 'multicall_notstruct'=>'system.multicall expected struct',
\r
188 'multicall_nomethod'=>'missing methodName',
\r
189 'multicall_notstring'=>'methodName is not a string',
\r
190 'multicall_recursion'=>'recursive system.multicall forbidden',
\r
191 'multicall_noparams'=>'missing params',
\r
192 'multicall_notarray'=>'params is not an array',
\r
194 'cannot_decompress'=>'Received from server compressed HTTP and cannot decompress',
\r
195 'decompress_fail'=>'Received from server invalid compressed HTTP',
\r
196 'dechunk_fail'=>'Received from server invalid chunked HTTP',
\r
197 'server_cannot_decompress'=>'Received from client compressed HTTP request and cannot decompress',
\r
198 'server_decompress_fail'=>'Received from client invalid compressed HTTP request'
\r
201 // The charset encoding used by the server for received messages and
\r
202 // by the client for received responses when received charset cannot be determined
\r
203 // or is not supported
\r
204 $GLOBALS['xmlrpc_defencoding']='UTF-8';
\r
206 // The encoding used internally by PHP.
\r
207 // String values received as xml will be converted to this, and php strings will be converted to xml
\r
208 // as if having been coded with this
\r
209 $GLOBALS['xmlrpc_internalencoding']='ISO-8859-1';
\r
211 $GLOBALS['xmlrpcName']='XML-RPC for PHP';
\r
212 $GLOBALS['xmlrpcVersion']='3.0.0.beta';
\r
214 // let user errors start at 800
\r
215 $GLOBALS['xmlrpcerruser']=800;
\r
216 // let XML parse errors start at 100
\r
217 $GLOBALS['xmlrpcerrxml']=100;
\r
219 // formulate backslashes for escaping regexp
\r
220 // Not in use anymore since 2.0. Shall we remove it?
\r
222 $GLOBALS['xmlrpc_backslash']=chr(92).chr(92);
\r
224 // set to TRUE to enable correct decoding of <NIL/> and <EX:NIL/> values
\r
225 $GLOBALS['xmlrpc_null_extension']=false;
\r
227 // set to TRUE to enable encoding of php NULL values to <EX:NIL/> instead of <NIL/>
\r
228 $GLOBALS['xmlrpc_null_apache_encoding']=false;
\r
230 // used to store state during parsing
\r
231 // quick explanation of components:
\r
232 // ac - used to accumulate values
\r
233 // isf - used to indicate a parsing fault (2) or xmlrpcresp fault (1)
\r
234 // isf_reason - used for storing xmlrpcresp fault string
\r
235 // lv - used to indicate "looking for a value": implements
\r
236 // the logic to allow values with no types to be strings
\r
237 // params - used to store parameters in method calls
\r
238 // method - used to store method name
\r
239 // stack - array with genealogy of xml elements names:
\r
240 // used to validate nesting of xmlrpc elements
\r
241 $GLOBALS['_xh']=null;
\r
244 * Convert a string to the correct XML representation in a target charset
\r
245 * To help correct communication of non-ascii chars inside strings, regardless
\r
246 * of the charset used when sending requests, parsing them, sending responses
\r
247 * and parsing responses, an option is to convert all non-ascii chars present in the message
\r
248 * into their equivalent 'charset entity'. Charset entities enumerated this way
\r
249 * are independent of the charset encoding used to transmit them, and all XML
\r
250 * parsers are bound to understand them.
\r
251 * Note that in the std case we are not sending a charset encoding mime type
\r
252 * along with http headers, so we are bound by RFC 3023 to emit strict us-ascii.
\r
254 * @todo do a bit of basic benchmarking (strtr vs. str_replace)
\r
255 * @todo make usage of iconv() or recode_string() or mb_string() where available
\r
257 function xmlrpc_encode_entitites($data, $src_encoding='', $dest_encoding='')
\r
259 if ($src_encoding == '')
\r
261 // lame, but we know no better...
\r
262 $src_encoding = $GLOBALS['xmlrpc_internalencoding'];
\r
265 switch(strtoupper($src_encoding.'_'.$dest_encoding))
\r
267 case 'ISO-8859-1_':
\r
268 case 'ISO-8859-1_US-ASCII':
\r
269 $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
\r
270 $escaped_data = str_replace($GLOBALS['xml_iso88591_Entities']['in'], $GLOBALS['xml_iso88591_Entities']['out'], $escaped_data);
\r
272 case 'ISO-8859-1_UTF-8':
\r
273 $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
\r
274 $escaped_data = utf8_encode($escaped_data);
\r
276 case 'ISO-8859-1_ISO-8859-1':
\r
277 case 'US-ASCII_US-ASCII':
\r
278 case 'US-ASCII_UTF-8':
\r
280 case 'US-ASCII_ISO-8859-1':
\r
281 case 'UTF-8_UTF-8':
\r
282 //case 'CP1252_CP1252':
\r
283 $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
\r
286 case 'UTF-8_US-ASCII':
\r
287 case 'UTF-8_ISO-8859-1':
\r
288 // NB: this will choke on invalid UTF-8, going most likely beyond EOF
\r
289 $escaped_data = '';
\r
290 // be kind to users creating string xmlrpcvals out of different php types
\r
291 $data = (string) $data;
\r
292 $ns = strlen ($data);
\r
293 for ($nn = 0; $nn < $ns; $nn++)
\r
297 //1 7 0bbbbbbb (127)
\r
300 /// @todo shall we replace this with a (supposedly) faster str_replace?
\r
303 $escaped_data .= '"';
\r
306 $escaped_data .= '&';
\r
309 $escaped_data .= ''';
\r
312 $escaped_data .= '<';
\r
315 $escaped_data .= '>';
\r
318 $escaped_data .= $ch;
\r
321 //2 11 110bbbbb 10bbbbbb (2047)
\r
322 else if ($ii>>5 == 6)
\r
325 $ii = ord($data[$nn+1]);
\r
327 $ii = ($b1 * 64) + $b2;
\r
328 $ent = sprintf ('&#%d;', $ii);
\r
329 $escaped_data .= $ent;
\r
332 //3 16 1110bbbb 10bbbbbb 10bbbbbb
\r
333 else if ($ii>>4 == 14)
\r
336 $ii = ord($data[$nn+1]);
\r
338 $ii = ord($data[$nn+2]);
\r
340 $ii = ((($b1 * 64) + $b2) * 64) + $b3;
\r
341 $ent = sprintf ('&#%d;', $ii);
\r
342 $escaped_data .= $ent;
\r
345 //4 21 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb
\r
346 else if ($ii>>3 == 30)
\r
349 $ii = ord($data[$nn+1]);
\r
351 $ii = ord($data[$nn+2]);
\r
353 $ii = ord($data[$nn+3]);
\r
355 $ii = ((((($b1 * 64) + $b2) * 64) + $b3) * 64) + $b4;
\r
356 $ent = sprintf ('&#%d;', $ii);
\r
357 $escaped_data .= $ent;
\r
364 case 'CP1252_US-ASCII':
\r
365 $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
\r
366 $escaped_data = str_replace($GLOBALS['xml_iso88591_Entities']['in'], $GLOBALS['xml_iso88591_Entities']['out'], $escaped_data);
\r
367 $escaped_data = str_replace($GLOBALS['xml_cp1252_Entities']['in'], $GLOBALS['xml_cp1252_Entities']['out'], $escaped_data);
\r
369 case 'CP1252_UTF-8':
\r
370 $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
\r
371 /// @todo we could use real UTF8 chars here instead of xml entities... (note that utf_8 encode all allone will NOT convert them)
\r
372 $escaped_data = str_replace($GLOBALS['xml_cp1252_Entities']['in'], $GLOBALS['xml_cp1252_Entities']['out'], $escaped_data);
\r
373 $escaped_data = utf8_encode($escaped_data);
\r
375 case 'CP1252_ISO-8859-1':
\r
376 $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
\r
377 // 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
378 $escaped_data = str_replace($GLOBALS['xml_cp1252_Entities']['in'], $GLOBALS['xml_cp1252_Entities']['out'], $escaped_data);
\r
382 $escaped_data = '';
\r
383 error_log("Converting from $src_encoding to $dest_encoding: not supported...");
\r
385 return $escaped_data;
\r
388 /// xml parser handler function for opening element tags
\r
389 function xmlrpc_se($parser, $name, $attrs, $accept_single_vals=false)
\r
391 // if invalid xmlrpc already detected, skip all processing
\r
392 if ($GLOBALS['_xh']['isf'] < 2)
\r
394 // check for correct element nesting
\r
395 // top level element can only be of 2 types
\r
396 /// @todo optimization creep: save this check into a bool variable, instead of using count() every time:
\r
397 /// there is only a single top level element in xml anyway
\r
398 if (count($GLOBALS['_xh']['stack']) == 0)
\r
400 if ($name != 'METHODRESPONSE' && $name != 'METHODCALL' && (
\r
401 $name != 'VALUE' && !$accept_single_vals))
\r
403 $GLOBALS['_xh']['isf'] = 2;
\r
404 $GLOBALS['_xh']['isf_reason'] = 'missing top level xmlrpc element';
\r
409 $GLOBALS['_xh']['rt'] = strtolower($name);
\r
410 $GLOBALS['_xh']['rt'] = strtolower($name);
\r
415 // not top level element: see if parent is OK
\r
416 $parent = end($GLOBALS['_xh']['stack']);
\r
417 if (!array_key_exists($name, $GLOBALS['xmlrpc_valid_parents']) || !in_array($parent, $GLOBALS['xmlrpc_valid_parents'][$name]))
\r
419 $GLOBALS['_xh']['isf'] = 2;
\r
420 $GLOBALS['_xh']['isf_reason'] = "xmlrpc element $name cannot be child of $parent";
\r
427 // optimize for speed switch cases: most common cases first
\r
429 /// @todo we could check for 2 VALUE elements inside a MEMBER or PARAM element
\r
430 $GLOBALS['_xh']['vt']='value'; // indicator: no value found yet
\r
431 $GLOBALS['_xh']['ac']='';
\r
432 $GLOBALS['_xh']['lv']=1;
\r
433 $GLOBALS['_xh']['php_class']=null;
\r
440 case 'DATETIME.ISO8601':
\r
442 if ($GLOBALS['_xh']['vt']!='value')
\r
444 //two data elements inside a value: an error occurred!
\r
445 $GLOBALS['_xh']['isf'] = 2;
\r
446 $GLOBALS['_xh']['isf_reason'] = "$name element following a {$GLOBALS['_xh']['vt']} element inside a single value";
\r
449 $GLOBALS['_xh']['ac']=''; // reset the accumulator
\r
453 if ($GLOBALS['_xh']['vt']!='value')
\r
455 //two data elements inside a value: an error occurred!
\r
456 $GLOBALS['_xh']['isf'] = 2;
\r
457 $GLOBALS['_xh']['isf_reason'] = "$name element following a {$GLOBALS['_xh']['vt']} element inside a single value";
\r
460 // create an empty array to hold child values, and push it onto appropriate stack
\r
461 $cur_val = array();
\r
462 $cur_val['values'] = array();
\r
463 $cur_val['type'] = $name;
\r
464 // check for out-of-band information to rebuild php objs
\r
465 // and in case it is found, save it
\r
466 if (@isset($attrs['PHP_CLASS']))
\r
468 $cur_val['php_class'] = $attrs['PHP_CLASS'];
\r
470 $GLOBALS['_xh']['valuestack'][] = $cur_val;
\r
471 $GLOBALS['_xh']['vt']='data'; // be prepared for a data element next
\r
474 if ($GLOBALS['_xh']['vt']!='data')
\r
476 //two data elements inside a value: an error occurred!
\r
477 $GLOBALS['_xh']['isf'] = 2;
\r
478 $GLOBALS['_xh']['isf_reason'] = "found two data elements inside an array element";
\r
482 case 'METHODRESPONSE':
\r
484 // valid elements that add little to processing
\r
488 /// @todo we could check for 2 NAME elements inside a MEMBER element
\r
489 $GLOBALS['_xh']['ac']='';
\r
492 $GLOBALS['_xh']['isf']=1;
\r
495 $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
496 //$GLOBALS['_xh']['ac']='';
\r
497 // Drop trough intentionally
\r
499 // clear value type, so we can check later if no value has been passed for this param/member
\r
500 $GLOBALS['_xh']['vt']=null;
\r
504 if ($GLOBALS['xmlrpc_null_extension'])
\r
506 if ($GLOBALS['_xh']['vt']!='value')
\r
508 //two data elements inside a value: an error occurred!
\r
509 $GLOBALS['_xh']['isf'] = 2;
\r
510 $GLOBALS['_xh']['isf_reason'] = "$name element following a {$GLOBALS['_xh']['vt']} element inside a single value";
\r
513 $GLOBALS['_xh']['ac']=''; // reset the accumulator
\r
516 // we do not support the <NIL/> extension, so
\r
517 // drop through intentionally
\r
519 /// INVALID ELEMENT: RAISE ISF so that it is later recognized!!!
\r
520 $GLOBALS['_xh']['isf'] = 2;
\r
521 $GLOBALS['_xh']['isf_reason'] = "found not-xmlrpc xml element $name";
\r
525 // Save current element name to stack, to validate nesting
\r
526 $GLOBALS['_xh']['stack'][] = $name;
\r
528 /// @todo optimization creep: move this inside the big switch() above
\r
531 $GLOBALS['_xh']['lv']=0;
\r
536 /// Used in decoding xml chunks that might represent single xmlrpc values
\r
537 function xmlrpc_se_any($parser, $name, $attrs)
\r
539 xmlrpc_se($parser, $name, $attrs, true);
\r
542 /// xml parser handler function for close element tags
\r
543 function xmlrpc_ee($parser, $name, $rebuild_xmlrpcvals = true)
\r
545 if ($GLOBALS['_xh']['isf'] < 2)
\r
547 // push this element name from stack
\r
548 // NB: if XML validates, correct opening/closing is guaranteed and
\r
549 // we do not have to check for $name == $curr_elem.
\r
550 // we also checked for proper nesting at start of elements...
\r
551 $curr_elem = array_pop($GLOBALS['_xh']['stack']);
\r
556 // This if() detects if no scalar was inside <VALUE></VALUE>
\r
557 if ($GLOBALS['_xh']['vt']=='value')
\r
559 $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac'];
\r
560 $GLOBALS['_xh']['vt']=$GLOBALS['xmlrpcString'];
\r
563 if ($rebuild_xmlrpcvals)
\r
565 // build the xmlrpc val out of the data received, and substitute it
\r
566 $temp = new xmlrpcval($GLOBALS['_xh']['value'], $GLOBALS['_xh']['vt']);
\r
567 // in case we got info about underlying php class, save it
\r
568 // in the object we're rebuilding
\r
569 if (isset($GLOBALS['_xh']['php_class']))
\r
570 $temp->_php_class = $GLOBALS['_xh']['php_class'];
\r
571 // check if we are inside an array or struct:
\r
572 // if value just built is inside an array, let's move it into array on the stack
\r
573 $vscount = count($GLOBALS['_xh']['valuestack']);
\r
574 if ($vscount && $GLOBALS['_xh']['valuestack'][$vscount-1]['type']=='ARRAY')
\r
576 $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][] = $temp;
\r
580 $GLOBALS['_xh']['value'] = $temp;
\r
585 /// @todo this needs to treat correctly php-serialized objects,
\r
586 /// since std deserializing is done by php_xmlrpc_decode,
\r
587 /// which we will not be calling...
\r
588 if (isset($GLOBALS['_xh']['php_class']))
\r
592 // check if we are inside an array or struct:
\r
593 // if value just built is inside an array, let's move it into array on the stack
\r
594 $vscount = count($GLOBALS['_xh']['valuestack']);
\r
595 if ($vscount && $GLOBALS['_xh']['valuestack'][$vscount-1]['type']=='ARRAY')
\r
597 $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][] = $GLOBALS['_xh']['value'];
\r
606 case 'DATETIME.ISO8601':
\r
608 $GLOBALS['_xh']['vt']=strtolower($name);
\r
609 /// @todo: optimization creep - remove the if/elseif cycle below
\r
610 /// since the case() in which we are already did that
\r
611 if ($name=='STRING')
\r
613 $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac'];
\r
615 elseif ($name=='DATETIME.ISO8601')
\r
617 if (!preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $GLOBALS['_xh']['ac']))
\r
619 error_log('XML-RPC: invalid value received in DATETIME: '.$GLOBALS['_xh']['ac']);
\r
621 $GLOBALS['_xh']['vt']=$GLOBALS['xmlrpcDateTime'];
\r
622 $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac'];
\r
624 elseif ($name=='BASE64')
\r
626 /// @todo check for failure of base64 decoding / catch warnings
\r
627 $GLOBALS['_xh']['value']=base64_decode($GLOBALS['_xh']['ac']);
\r
629 elseif ($name=='BOOLEAN')
\r
631 // special case here: we translate boolean 1 or 0 into PHP
\r
632 // constants true or false.
\r
633 // Strings 'true' and 'false' are accepted, even though the
\r
634 // spec never mentions them (see eg. Blogger api docs)
\r
635 // NB: this simple checks helps a lot sanitizing input, ie no
\r
636 // security problems around here
\r
637 if ($GLOBALS['_xh']['ac']=='1' || strcasecmp($GLOBALS['_xh']['ac'], 'true') == 0)
\r
639 $GLOBALS['_xh']['value']=true;
\r
643 // log if receiveing something strange, even though we set the value to false anyway
\r
644 if ($GLOBALS['_xh']['ac']!='0' && strcasecmp($GLOBALS['_xh']['ac'], 'false') != 0)
\r
645 error_log('XML-RPC: invalid value received in BOOLEAN: '.$GLOBALS['_xh']['ac']);
\r
646 $GLOBALS['_xh']['value']=false;
\r
649 elseif ($name=='DOUBLE')
\r
651 // we have a DOUBLE
\r
652 // we must check that only 0123456789-.<space> are characters here
\r
653 // NOTE: regexp could be much stricter than this...
\r
654 if (!preg_match('/^[+-eE0123456789 \t.]+$/', $GLOBALS['_xh']['ac']))
\r
656 /// @todo: find a better way of throwing an error than this!
\r
657 error_log('XML-RPC: non numeric value received in DOUBLE: '.$GLOBALS['_xh']['ac']);
\r
658 $GLOBALS['_xh']['value']='ERROR_NON_NUMERIC_FOUND';
\r
662 // it's ok, add it on
\r
663 $GLOBALS['_xh']['value']=(double)$GLOBALS['_xh']['ac'];
\r
668 // we have an I4/INT
\r
669 // we must check that only 0123456789-<space> are characters here
\r
670 if (!preg_match('/^[+-]?[0123456789 \t]+$/', $GLOBALS['_xh']['ac']))
\r
672 /// @todo find a better way of throwing an error than this!
\r
673 error_log('XML-RPC: non numeric value received in INT: '.$GLOBALS['_xh']['ac']);
\r
674 $GLOBALS['_xh']['value']='ERROR_NON_NUMERIC_FOUND';
\r
678 // it's ok, add it on
\r
679 $GLOBALS['_xh']['value']=(int)$GLOBALS['_xh']['ac'];
\r
682 //$GLOBALS['_xh']['ac']=''; // is this necessary?
\r
683 $GLOBALS['_xh']['lv']=3; // indicate we've found a value
\r
686 $GLOBALS['_xh']['valuestack'][count($GLOBALS['_xh']['valuestack'])-1]['name'] = $GLOBALS['_xh']['ac'];
\r
689 //$GLOBALS['_xh']['ac']=''; // is this necessary?
\r
690 // add to array in the stack the last element built,
\r
691 // unless no VALUE was found
\r
692 if ($GLOBALS['_xh']['vt'])
\r
694 $vscount = count($GLOBALS['_xh']['valuestack']);
\r
695 $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][$GLOBALS['_xh']['valuestack'][$vscount-1]['name']] = $GLOBALS['_xh']['value'];
\r
697 error_log('XML-RPC: missing VALUE inside STRUCT in received xml');
\r
700 //$GLOBALS['_xh']['ac']=''; // is this necessary?
\r
701 $GLOBALS['_xh']['vt']=null; // reset this to check for 2 data elements in a row - even if they're empty
\r
705 // fetch out of stack array of values, and promote it to current value
\r
706 $curr_val = array_pop($GLOBALS['_xh']['valuestack']);
\r
707 $GLOBALS['_xh']['value'] = $curr_val['values'];
\r
708 $GLOBALS['_xh']['vt']=strtolower($name);
\r
709 if (isset($curr_val['php_class']))
\r
711 $GLOBALS['_xh']['php_class'] = $curr_val['php_class'];
\r
715 // add to array of params the current value,
\r
716 // unless no VALUE was found
\r
717 if ($GLOBALS['_xh']['vt'])
\r
719 $GLOBALS['_xh']['params'][]=$GLOBALS['_xh']['value'];
\r
720 $GLOBALS['_xh']['pt'][]=$GLOBALS['_xh']['vt'];
\r
723 error_log('XML-RPC: missing VALUE inside PARAM in received xml');
\r
726 $GLOBALS['_xh']['method']=preg_replace('/^[\n\r\t ]+/', '', $GLOBALS['_xh']['ac']);
\r
730 if ($GLOBALS['xmlrpc_null_extension'])
\r
732 $GLOBALS['_xh']['vt']='null';
\r
733 $GLOBALS['_xh']['value']=null;
\r
734 $GLOBALS['_xh']['lv']=3;
\r
737 // drop through intentionally if nil extension not enabled
\r
741 case 'METHORESPONSE':
\r
744 // End of INVALID ELEMENT!
\r
745 // shall we add an assert here for unreachable code???
\r
751 /// Used in decoding xmlrpc requests/responses without rebuilding xmlrpc values
\r
752 function xmlrpc_ee_fast($parser, $name)
\r
754 xmlrpc_ee($parser, $name, false);
\r
757 /// xml parser handler function for character data
\r
758 function xmlrpc_cd($parser, $data)
\r
760 // skip processing if xml fault already detected
\r
761 if ($GLOBALS['_xh']['isf'] < 2)
\r
763 // "lookforvalue==3" means that we've found an entire value
\r
764 // and should discard any further character data
\r
765 if($GLOBALS['_xh']['lv']!=3)
\r
767 // G. Giunta 2006-08-23: useless change of 'lv' from 1 to 2
\r
768 //if($GLOBALS['_xh']['lv']==1)
\r
770 // if we've found text and we're just in a <value> then
\r
771 // say we've found a value
\r
772 //$GLOBALS['_xh']['lv']=2;
\r
774 // we always initialize the accumulator before starting parsing, anyway...
\r
775 //if(!@isset($GLOBALS['_xh']['ac']))
\r
777 // $GLOBALS['_xh']['ac'] = '';
\r
779 $GLOBALS['_xh']['ac'].=$data;
\r
784 /// xml parser handler function for 'other stuff', ie. not char data or
\r
785 /// element start/end tag. In fact it only gets called on unknown entities...
\r
786 function xmlrpc_dh($parser, $data)
\r
788 // skip processing if xml fault already detected
\r
789 if ($GLOBALS['_xh']['isf'] < 2)
\r
791 if(substr($data, 0, 1) == '&' && substr($data, -1, 1) == ';')
\r
793 // G. Giunta 2006-08-25: useless change of 'lv' from 1 to 2
\r
794 //if($GLOBALS['_xh']['lv']==1)
\r
796 // $GLOBALS['_xh']['lv']=2;
\r
798 $GLOBALS['_xh']['ac'].=$data;
\r
804 class xmlrpc_client
\r
809 var $method='http';
\r
822 var $verifypeer=true;
\r
824 var $no_multicall=false;
\r
827 var $proxy_user='';
\r
828 var $proxy_pass='';
\r
829 var $proxy_authtype=1;
\r
830 var $cookies=array();
\r
832 * List of http compression methods accepted by the client for responses.
\r
833 * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib
\r
835 * NNB: you can set it to any non-empty array for HTTP11 and HTTPS, since
\r
836 * in those cases it will be up to CURL to decide the compression methods
\r
837 * it supports. You might check for the presence of 'zlib' in the output of
\r
838 * curl_version() to determine wheter compression is supported or not
\r
840 var $accepted_compression = array();
\r
842 * Name of compression scheme to be used for sending requests.
\r
843 * Either null, gzip or deflate
\r
845 var $request_compression = '';
\r
847 * CURL handle: used for keep-alive connections (PHP 4.3.8 up, see:
\r
848 * http://curl.haxx.se/docs/faq.html#7.3)
\r
850 var $xmlrpc_curl_handle = null;
\r
851 /// Wheter to use persistent connections for http 1.1 and https
\r
852 var $keepalive = false;
\r
853 /// Charset encodings that can be decoded without problems by the client
\r
854 var $accepted_charset_encodings = array();
\r
855 /// Charset encoding to be used in serializing request. NULL = use ASCII
\r
856 var $request_charset_encoding = '';
\r
858 * Decides the content of xmlrpcresp objects returned by calls to send()
\r
859 * valid strings are 'xmlrpcvals', 'phpvals' or 'xml'
\r
861 var $return_type = 'xmlrpcvals';
\r
864 * @param string $path either the complete server URL or the PATH part of the xmlrc server URL, e.g. /xmlrpc/server.php
\r
865 * @param string $server the server name / ip address
\r
866 * @param integer $port the port the server is listening on, defaults to 80 or 443 depending on protocol used
\r
867 * @param string $method the http protocol variant: defaults to 'http', 'https' and 'http11' can be used if CURL is installed
\r
869 function xmlrpc_client($path, $server='', $port='', $method='')
\r
871 // allow user to specify all params in $path
\r
872 if($server == '' and $port == '' and $method == '')
\r
874 $parts = parse_url($path);
\r
875 $server = $parts['host'];
\r
876 $path = isset($parts['path']) ? $parts['path'] : '';
\r
877 if(isset($parts['query']))
\r
879 $path .= '?'.$parts['query'];
\r
881 if(isset($parts['fragment']))
\r
883 $path .= '#'.$parts['fragment'];
\r
885 if(isset($parts['port']))
\r
887 $port = $parts['port'];
\r
889 if(isset($parts['scheme']))
\r
891 $method = $parts['scheme'];
\r
893 if(isset($parts['user']))
\r
895 $this->username = $parts['user'];
\r
897 if(isset($parts['pass']))
\r
899 $this->password = $parts['pass'];
\r
902 if($path == '' || $path[0] != '/')
\r
904 $this->path='/'.$path;
\r
910 $this->server=$server;
\r
917 $this->method=$method;
\r
920 // if ZLIB is enabled, let the client by default accept compressed responses
\r
921 if(function_exists('gzinflate') || (
\r
922 function_exists('curl_init') && (($info = curl_version()) &&
\r
923 ((is_string($info) && strpos($info, 'zlib') !== null) || isset($info['libz_version'])))
\r
926 $this->accepted_compression = array('gzip', 'deflate');
\r
929 // keepalives: enabled by default ONLY for PHP >= 4.3.8
\r
930 $this->keepalive = true;
\r
932 // by default the xml parser can support these 3 charset encodings
\r
933 $this->accepted_charset_encodings = array('UTF-8', 'ISO-8859-1', 'US-ASCII');
\r
937 * Enables/disables the echoing to screen of the xmlrpc responses received
\r
938 * @param integer $debug values 0, 1 and 2 are supported (2 = echo sent msg too, before received response)
\r
941 function setDebug($in)
\r
947 * Add some http BASIC AUTH credentials, used by the client to authenticate
\r
948 * @param string $u username
\r
949 * @param string $p password
\r
950 * @param integer $t auth type. See curl_setopt man page for supported auth types. Defaults to CURLAUTH_BASIC (basic auth)
\r
953 function setCredentials($u, $p, $t=1)
\r
955 $this->username=$u;
\r
956 $this->password=$p;
\r
957 $this->authtype=$t;
\r
961 * Add a client-side https certificate
\r
962 * @param string $cert
\r
963 * @param string $certpass
\r
966 function setCertificate($cert, $certpass)
\r
968 $this->cert = $cert;
\r
969 $this->certpass = $certpass;
\r
973 * Add a CA certificate to verify server with (see man page about
\r
974 * CURLOPT_CAINFO for more details
\r
975 * @param string $cacert certificate file name (or dir holding certificates)
\r
976 * @param bool $is_dir set to true to indicate cacert is a dir. defaults to false
\r
979 function setCaCertificate($cacert, $is_dir=false)
\r
983 $this->cacertdir = $cacert;
\r
987 $this->cacert = $cacert;
\r
992 * Set attributes for SSL communication: private SSL key
\r
993 * NB: does not work in older php/curl installs
\r
994 * Thanks to Daniel Convissor
\r
995 * @param string $key The name of a file containing a private SSL key
\r
996 * @param string $keypass The secret password needed to use the private SSL key
\r
999 function setKey($key, $keypass)
\r
1001 $this->key = $key;
\r
1002 $this->keypass = $keypass;
\r
1006 * Set attributes for SSL communication: verify server certificate
\r
1007 * @param bool $i enable/disable verification of peer certificate
\r
1010 function setSSLVerifyPeer($i)
\r
1012 $this->verifypeer = $i;
\r
1016 * Set attributes for SSL communication: verify match of server cert w. hostname
\r
1020 function setSSLVerifyHost($i)
\r
1022 $this->verifyhost = $i;
\r
1027 * @param string $proxyhost
\r
1028 * @param string $proxyport Defaults to 8080 for HTTP and 443 for HTTPS
\r
1029 * @param string $proxyusername Leave blank if proxy has public access
\r
1030 * @param string $proxypassword Leave blank if proxy has public access
\r
1031 * @param int $proxyauthtype set to constant CURLAUTH_NTLM to use NTLM auth with proxy
\r
1034 function setProxy($proxyhost, $proxyport, $proxyusername = '', $proxypassword = '', $proxyauthtype = 1)
\r
1036 $this->proxy = $proxyhost;
\r
1037 $this->proxyport = $proxyport;
\r
1038 $this->proxy_user = $proxyusername;
\r
1039 $this->proxy_pass = $proxypassword;
\r
1040 $this->proxy_authtype = $proxyauthtype;
\r
1044 * Enables/disables reception of compressed xmlrpc responses.
\r
1045 * Note that enabling reception of compressed responses merely adds some standard
\r
1046 * http headers to xmlrpc requests. It is up to the xmlrpc server to return
\r
1047 * compressed responses when receiving such requests.
\r
1048 * @param string $compmethod either 'gzip', 'deflate', 'any' or ''
\r
1051 function setAcceptedCompression($compmethod)
\r
1053 if ($compmethod == 'any')
\r
1054 $this->accepted_compression = array('gzip', 'deflate');
\r
1056 $this->accepted_compression = array($compmethod);
\r
1060 * Enables/disables http compression of xmlrpc request.
\r
1061 * Take care when sending compressed requests: servers might not support them
\r
1062 * (and automatic fallback to uncompressed requests is not yet implemented)
\r
1063 * @param string $compmethod either 'gzip', 'deflate' or ''
\r
1066 function setRequestCompression($compmethod)
\r
1068 $this->request_compression = $compmethod;
\r
1072 * Adds a cookie to list of cookies that will be sent to server.
\r
1073 * NB: setting any param but name and value will turn the cookie into a 'version 1' cookie:
\r
1074 * do not do it unless you know what you are doing
\r
1075 * @param string $name
\r
1076 * @param string $value
\r
1077 * @param string $path
\r
1078 * @param string $domain
\r
1079 * @param int $port
\r
1082 * @todo check correctness of urlencoding cookie value (copied from php way of doing it...)
\r
1084 function setCookie($name, $value='', $path='', $domain='', $port=null)
\r
1086 $this->cookies[$name]['value'] = urlencode($value);
\r
1087 if ($path || $domain || $port)
\r
1089 $this->cookies[$name]['path'] = $path;
\r
1090 $this->cookies[$name]['domain'] = $domain;
\r
1091 $this->cookies[$name]['port'] = $port;
\r
1092 $this->cookies[$name]['version'] = 1;
\r
1096 $this->cookies[$name]['version'] = 0;
\r
1101 * Send an xmlrpc request
\r
1102 * @param mixed $msg The message object, or an array of messages for using multicall, or the complete xml representation of a request
\r
1103 * @param integer $timeout Connection timeout, in seconds, If unspecified, a platform specific timeout will apply
\r
1104 * @param string $method if left unspecified, the http protocol chosen during creation of the object will be used
\r
1105 * @return xmlrpcresp
\r
1108 function& send($msg, $timeout=0, $method='')
\r
1110 // if user deos not specify http protocol, use native method of this client
\r
1111 // (i.e. method set during call to constructor)
\r
1114 $method = $this->method;
\r
1117 if(is_array($msg))
\r
1119 // $msg is an array of xmlrpcmsg's
\r
1120 $r = $this->multicall($msg, $timeout, $method);
\r
1123 elseif(is_string($msg))
\r
1125 $n = new xmlrpcmsg('');
\r
1126 $n->payload = $msg;
\r
1130 // where msg is an xmlrpcmsg
\r
1131 $msg->debug=$this->debug;
\r
1133 if($method == 'https')
\r
1135 $r =& $this->sendPayloadHTTPS(
\r
1149 $this->proxy_user,
\r
1150 $this->proxy_pass,
\r
1151 $this->proxy_authtype,
\r
1157 elseif($method == 'http11')
\r
1159 $r =& $this->sendPayloadCURL(
\r
1173 $this->proxy_user,
\r
1174 $this->proxy_pass,
\r
1175 $this->proxy_authtype,
\r
1182 $r =& $this->sendPayloadHTTP10(
\r
1192 $this->proxy_user,
\r
1193 $this->proxy_pass,
\r
1194 $this->proxy_authtype
\r
1204 function &sendPayloadHTTP10($msg, $server, $port, $timeout=0,
\r
1205 $username='', $password='', $authtype=1, $proxyhost='',
\r
1206 $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1)
\r
1213 // Only create the payload if it was not created previously
\r
1214 if(empty($msg->payload))
\r
1216 $msg->createPayload($this->request_charset_encoding);
\r
1219 $payload = $msg->payload;
\r
1220 // Deflate request body and set appropriate request headers
\r
1221 if(function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate'))
\r
1223 if($this->request_compression == 'gzip')
\r
1225 $a = @gzencode($payload);
\r
1229 $encoding_hdr = "Content-Encoding: gzip\r\n";
\r
1234 $a = @gzcompress($payload);
\r
1238 $encoding_hdr = "Content-Encoding: deflate\r\n";
\r
1244 $encoding_hdr = '';
\r
1247 // thanks to Grant Rauscher <grant7@firstworld.net> for this
\r
1251 $credentials='Authorization: Basic ' . base64_encode($username . ':' . $password) . "\r\n";
\r
1252 if ($authtype != 1)
\r
1254 error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth is supported with HTTP 1.0');
\r
1258 $accepted_encoding = '';
\r
1259 if(is_array($this->accepted_compression) && count($this->accepted_compression))
\r
1261 $accepted_encoding = 'Accept-Encoding: ' . implode(', ', $this->accepted_compression) . "\r\n";
\r
1264 $proxy_credentials = '';
\r
1267 if($proxyport == 0)
\r
1269 $proxyport = 8080;
\r
1271 $connectserver = $proxyhost;
\r
1272 $connectport = $proxyport;
\r
1273 $uri = 'http://'.$server.':'.$port.$this->path;
\r
1274 if($proxyusername != '')
\r
1276 if ($proxyauthtype != 1)
\r
1278 error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth to proxy is supported with HTTP 1.0');
\r
1280 $proxy_credentials = 'Proxy-Authorization: Basic ' . base64_encode($proxyusername.':'.$proxypassword) . "\r\n";
\r
1285 $connectserver = $server;
\r
1286 $connectport = $port;
\r
1287 $uri = $this->path;
\r
1290 // Cookie generation, as per rfc2965 (version 1 cookies) or
\r
1291 // netscape's rules (version 0 cookies)
\r
1293 if (count($this->cookies))
\r
1296 foreach ($this->cookies as $name => $cookie)
\r
1298 if ($cookie['version'])
\r
1300 $version = ' $Version="' . $cookie['version'] . '";';
\r
1301 $cookieheader .= ' ' . $name . '="' . $cookie['value'] . '";';
\r
1302 if ($cookie['path'])
\r
1303 $cookieheader .= ' $Path="' . $cookie['path'] . '";';
\r
1304 if ($cookie['domain'])
\r
1305 $cookieheader .= ' $Domain="' . $cookie['domain'] . '";';
\r
1306 if ($cookie['port'])
\r
1307 $cookieheader .= ' $Port="' . $cookie['port'] . '";';
\r
1311 $cookieheader .= ' ' . $name . '=' . $cookie['value'] . ";";
\r
1314 $cookieheader = 'Cookie:' . $version . substr($cookieheader, 0, -1) . "\r\n";
\r
1317 $op= 'POST ' . $uri. " HTTP/1.0\r\n" .
\r
1318 'User-Agent: ' . $GLOBALS['xmlrpcName'] . ' ' . $GLOBALS['xmlrpcVersion'] . "\r\n" .
\r
1319 'Host: '. $server . ':' . $port . "\r\n" .
\r
1321 $proxy_credentials .
\r
1322 $accepted_encoding .
\r
1324 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings) . "\r\n" .
\r
1326 'Content-Type: ' . $msg->content_type . "\r\nContent-Length: " .
\r
1327 strlen($payload) . "\r\n\r\n" .
\r
1330 if($this->debug > 1)
\r
1332 print "<PRE>\n---SENDING---\n" . htmlentities($op) . "\n---END---\n</PRE>";
\r
1333 // let the client see this now in case http times out...
\r
1339 $fp=@fsockopen($connectserver, $connectport, $this->errno, $this->errstr, $timeout);
\r
1343 $fp=@fsockopen($connectserver, $connectport, $this->errno, $this->errstr);
\r
1347 if($timeout>0 && function_exists('stream_set_timeout'))
\r
1349 stream_set_timeout($fp, $timeout);
\r
1354 $this->errstr='Connect error: '.$this->errstr;
\r
1355 $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $this->errstr . ' (' . $this->errno . ')');
\r
1359 if(!fputs($fp, $op, strlen($op)))
\r
1362 $this->errstr='Write error';
\r
1363 $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $this->errstr);
\r
1368 // reset errno and errstr on succesful socket connection
\r
1369 $this->errstr = '';
\r
1371 // G. Giunta 2005/10/24: close socket before parsing.
\r
1372 // should yeld slightly better execution times, and make easier recursive calls (e.g. to follow http redirects)
\r
1376 // shall we check for $data === FALSE?
\r
1377 // as per the manual, it signals an error
\r
1378 $ipd.=fread($fp, 32768);
\r
1379 } while(!feof($fp));
\r
1381 $r =& $msg->parseResponse($ipd, false, $this->return_type);
\r
1389 function &sendPayloadHTTPS($msg, $server, $port, $timeout=0, $username='',
\r
1390 $password='', $authtype=1, $cert='',$certpass='', $cacert='', $cacertdir='',
\r
1391 $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1,
\r
1392 $keepalive=false, $key='', $keypass='')
\r
1394 $r =& $this->sendPayloadCURL($msg, $server, $port, $timeout, $username,
\r
1395 $password, $authtype, $cert, $certpass, $cacert, $cacertdir, $proxyhost, $proxyport,
\r
1396 $proxyusername, $proxypassword, $proxyauthtype, 'https', $keepalive, $key, $keypass);
\r
1401 * Contributed by Justin Miller <justin@voxel.net>
\r
1402 * Requires curl to be built into PHP
\r
1403 * NB: CURL versions before 7.11.10 cannot use proxy to talk to https servers!
\r
1406 function &sendPayloadCURL($msg, $server, $port, $timeout=0, $username='',
\r
1407 $password='', $authtype=1, $cert='', $certpass='', $cacert='', $cacertdir='',
\r
1408 $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1, $method='https',
\r
1409 $keepalive=false, $key='', $keypass='')
\r
1411 if(!function_exists('curl_init'))
\r
1413 $this->errstr='CURL unavailable on this install';
\r
1414 $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_curl'], $GLOBALS['xmlrpcstr']['no_curl']);
\r
1417 if($method == 'https')
\r
1419 if(($info = curl_version()) &&
\r
1420 ((is_string($info) && strpos($info, 'OpenSSL') === null) || (is_array($info) && !isset($info['ssl_version']))))
\r
1422 $this->errstr='SSL unavailable on this install';
\r
1423 $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_ssl'], $GLOBALS['xmlrpcstr']['no_ssl']);
\r
1430 if($method == 'http')
\r
1440 // Only create the payload if it was not created previously
\r
1441 if(empty($msg->payload))
\r
1443 $msg->createPayload($this->request_charset_encoding);
\r
1446 // Deflate request body and set appropriate request headers
\r
1447 $payload = $msg->payload;
\r
1448 if(function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate'))
\r
1450 if($this->request_compression == 'gzip')
\r
1452 $a = @gzencode($payload);
\r
1456 $encoding_hdr = 'Content-Encoding: gzip';
\r
1461 $a = @gzcompress($payload);
\r
1465 $encoding_hdr = 'Content-Encoding: deflate';
\r
1471 $encoding_hdr = '';
\r
1474 if($this->debug > 1)
\r
1476 print "<PRE>\n---SENDING---\n" . htmlentities($payload) . "\n---END---\n</PRE>";
\r
1477 // let the client see this now in case http times out...
\r
1481 if(!$keepalive || !$this->xmlrpc_curl_handle)
\r
1483 $curl = curl_init($method . '://' . $server . ':' . $port . $this->path);
\r
1486 $this->xmlrpc_curl_handle = $curl;
\r
1491 $curl = $this->xmlrpc_curl_handle;
\r
1494 // results into variable
\r
1495 curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
\r
1499 curl_setopt($curl, CURLOPT_VERBOSE, 1);
\r
1501 curl_setopt($curl, CURLOPT_USERAGENT, $GLOBALS['xmlrpcName'].' '.$GLOBALS['xmlrpcVersion']);
\r
1502 // required for XMLRPC: post the data
\r
1503 curl_setopt($curl, CURLOPT_POST, 1);
\r
1505 curl_setopt($curl, CURLOPT_POSTFIELDS, $payload);
\r
1507 // return the header too
\r
1508 curl_setopt($curl, CURLOPT_HEADER, 1);
\r
1510 // will only work with PHP >= 5.0
\r
1511 // NB: if we set an empty string, CURL will add http header indicating
\r
1512 // ALL methods it is supporting. This is possibly a better option than
\r
1513 // letting the user tell what curl can / cannot do...
\r
1514 if(is_array($this->accepted_compression) && count($this->accepted_compression))
\r
1516 //curl_setopt($curl, CURLOPT_ENCODING, implode(',', $this->accepted_compression));
\r
1517 // empty string means 'any supported by CURL' (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
\r
1518 if (count($this->accepted_compression) == 1)
\r
1520 curl_setopt($curl, CURLOPT_ENCODING, $this->accepted_compression[0]);
\r
1523 curl_setopt($curl, CURLOPT_ENCODING, '');
\r
1526 $headers = array('Content-Type: ' . $msg->content_type , 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings));
\r
1527 // if no keepalive is wanted, let the server know it in advance
\r
1530 $headers[] = 'Connection: close';
\r
1532 // request compression header
\r
1535 $headers[] = $encoding_hdr;
\r
1538 curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
\r
1539 // timeout is borked
\r
1542 curl_setopt($curl, CURLOPT_TIMEOUT, $timeout == 1 ? 1 : $timeout - 1);
\r
1545 if($username && $password)
\r
1547 curl_setopt($curl, CURLOPT_USERPWD, $username.':'.$password);
\r
1548 if (defined('CURLOPT_HTTPAUTH'))
\r
1550 curl_setopt($curl, CURLOPT_HTTPAUTH, $authtype);
\r
1552 else if ($authtype != 1)
\r
1554 error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth is supported by the current PHP/curl install');
\r
1558 if($method == 'https')
\r
1563 curl_setopt($curl, CURLOPT_SSLCERT, $cert);
\r
1565 // set cert password
\r
1568 curl_setopt($curl, CURLOPT_SSLCERTPASSWD, $certpass);
\r
1570 // whether to verify remote host's cert
\r
1571 curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, $this->verifypeer);
\r
1572 // set ca certificates file/dir
\r
1575 curl_setopt($curl, CURLOPT_CAINFO, $cacert);
\r
1579 curl_setopt($curl, CURLOPT_CAPATH, $cacertdir);
\r
1581 // set key file (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
\r
1584 curl_setopt($curl, CURLOPT_SSLKEY, $key);
\r
1586 // set key password (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
\r
1589 curl_setopt($curl, CURLOPT_SSLKEYPASSWD, $keypass);
\r
1591 // 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
1592 curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, $this->verifyhost);
\r
1598 if($proxyport == 0)
\r
1600 $proxyport = 8080; // NB: even for HTTPS, local connection is on port 8080
\r
1602 curl_setopt($curl, CURLOPT_PROXY, $proxyhost.':'.$proxyport);
\r
1603 //curl_setopt($curl, CURLOPT_PROXYPORT,$proxyport);
\r
1604 if($proxyusername)
\r
1606 curl_setopt($curl, CURLOPT_PROXYUSERPWD, $proxyusername.':'.$proxypassword);
\r
1607 if (defined('CURLOPT_PROXYAUTH'))
\r
1609 curl_setopt($curl, CURLOPT_PROXYAUTH, $proxyauthtype);
\r
1611 else if ($proxyauthtype != 1)
\r
1613 error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth to proxy is supported by the current PHP/curl install');
\r
1618 // NB: should we build cookie http headers by hand rather than let CURL do it?
\r
1619 // the following code does not honour 'expires', 'path' and 'domain' cookie attributes
\r
1620 // set to client obj the the user...
\r
1621 if (count($this->cookies))
\r
1623 $cookieheader = '';
\r
1624 foreach ($this->cookies as $name => $cookie)
\r
1626 $cookieheader .= $name . '=' . $cookie['value'] . '; ';
\r
1628 curl_setopt($curl, CURLOPT_COOKIE, substr($cookieheader, 0, -2));
\r
1631 $result = curl_exec($curl);
\r
1633 if ($this->debug > 1)
\r
1635 print "<PRE>\n---CURL INFO---\n";
\r
1636 foreach(curl_getinfo($curl) as $name => $val)
\r
1637 print $name . ': ' . htmlentities($val). "\n";
\r
1638 print "---END---\n</PRE>";
\r
1641 if(!$result) /// @todo we should use a better check here - what if we get back '' or '0'?
\r
1643 $this->errstr='no response';
\r
1644 $resp=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['curl_fail'], $GLOBALS['xmlrpcstr']['curl_fail']. ': '. curl_error($curl));
\r
1645 curl_close($curl);
\r
1648 $this->xmlrpc_curl_handle = null;
\r
1655 curl_close($curl);
\r
1657 $resp =& $msg->parseResponse($result, true, $this->return_type);
\r
1663 * Send an array of request messages and return an array of responses.
\r
1664 * Unless $this->no_multicall has been set to true, it will try first
\r
1665 * to use one single xmlrpc call to server method system.multicall, and
\r
1666 * revert to sending many successive calls in case of failure.
\r
1667 * This failure is also stored in $this->no_multicall for subsequent calls.
\r
1668 * Unfortunately, there is no server error code universally used to denote
\r
1669 * the fact that multicall is unsupported, so there is no way to reliably
\r
1670 * distinguish between that and a temporary failure.
\r
1671 * If you are sure that server supports multicall and do not want to
\r
1672 * fallback to using many single calls, set the fourth parameter to FALSE.
\r
1674 * NB: trying to shoehorn extra functionality into existing syntax has resulted
\r
1675 * in pretty much convoluted code...
\r
1677 * @param array $msgs an array of xmlrpcmsg objects
\r
1678 * @param integer $timeout connection timeout (in seconds)
\r
1679 * @param string $method the http protocol variant to be used
\r
1680 * @param boolean fallback When true, upon receiveing an error during multicall, multiple single calls will be attempted
\r
1684 function multicall($msgs, $timeout=0, $method='', $fallback=true)
\r
1686 if ($method == '')
\r
1688 $method = $this->method;
\r
1690 if(!$this->no_multicall)
\r
1692 $results = $this->_try_multicall($msgs, $timeout, $method);
\r
1693 if(is_array($results))
\r
1695 // System.multicall succeeded
\r
1700 // either system.multicall is unsupported by server,
\r
1701 // or call failed for some other reason.
\r
1704 // Don't try it next time...
\r
1705 $this->no_multicall = true;
\r
1709 if (is_a($results, 'xmlrpcresp'))
\r
1711 $result = $results;
\r
1715 $result = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['multicall_error'], $GLOBALS['xmlrpcstr']['multicall_error']);
\r
1722 // override fallback, in case careless user tries to do two
\r
1723 // opposite things at the same time
\r
1727 $results = array();
\r
1730 // system.multicall is (probably) unsupported by server:
\r
1731 // emulate multicall via multiple requests
\r
1732 foreach($msgs as $msg)
\r
1734 $results[] =& $this->send($msg, $timeout, $method);
\r
1739 // user does NOT want to fallback on many single calls:
\r
1740 // since we should always return an array of responses,
\r
1741 // return an array with the same error repeated n times
\r
1742 foreach($msgs as $msg)
\r
1744 $results[] = $result;
\r
1751 * Attempt to boxcar $msgs via system.multicall.
\r
1752 * Returns either an array of xmlrpcreponses, an xmlrpc error response
\r
1753 * or false (when received response does not respect valid multicall syntax)
\r
1756 function _try_multicall($msgs, $timeout, $method)
\r
1758 // Construct multicall message
\r
1760 foreach($msgs as $msg)
\r
1762 $call['methodName'] = new xmlrpcval($msg->method(),'string');
\r
1763 $numParams = $msg->getNumParams();
\r
1764 $params = array();
\r
1765 for($i = 0; $i < $numParams; $i++)
\r
1767 $params[$i] = $msg->getParam($i);
\r
1769 $call['params'] = new xmlrpcval($params, 'array');
\r
1770 $calls[] = new xmlrpcval($call, 'struct');
\r
1772 $multicall = new xmlrpcmsg('system.multicall');
\r
1773 $multicall->addParam(new xmlrpcval($calls, 'array'));
\r
1775 // Attempt RPC call
\r
1776 $result =& $this->send($multicall, $timeout, $method);
\r
1778 if($result->faultCode() != 0)
\r
1780 // call to system.multicall failed
\r
1784 // Unpack responses.
\r
1785 $rets = $result->value();
\r
1787 if ($this->return_type == 'xml')
\r
1791 else if ($this->return_type == 'phpvals')
\r
1793 ///@todo test this code branch...
\r
1794 $rets = $result->value();
\r
1795 if(!is_array($rets))
\r
1797 return false; // bad return type from system.multicall
\r
1799 $numRets = count($rets);
\r
1800 if($numRets != count($msgs))
\r
1802 return false; // wrong number of return values.
\r
1805 $response = array();
\r
1806 for($i = 0; $i < $numRets; $i++)
\r
1809 if (!is_array($val)) {
\r
1812 switch(count($val))
\r
1815 if(!isset($val[0]))
\r
1817 return false; // Bad value
\r
1819 // Normal return value
\r
1820 $response[$i] = new xmlrpcresp($val[0], 0, '', 'phpvals');
\r
1823 /// @todo remove usage of @: it is apparently quite slow
\r
1824 $code = @$val['faultCode'];
\r
1825 if(!is_int($code))
\r
1829 $str = @$val['faultString'];
\r
1830 if(!is_string($str))
\r
1834 $response[$i] = new xmlrpcresp(0, $code, $str);
\r
1842 else // return type == 'xmlrpcvals'
\r
1844 $rets = $result->value();
\r
1845 if($rets->kindOf() != 'array')
\r
1847 return false; // bad return type from system.multicall
\r
1849 $numRets = $rets->arraysize();
\r
1850 if($numRets != count($msgs))
\r
1852 return false; // wrong number of return values.
\r
1855 $response = array();
\r
1856 for($i = 0; $i < $numRets; $i++)
\r
1858 $val = $rets->arraymem($i);
\r
1859 switch($val->kindOf())
\r
1862 if($val->arraysize() != 1)
\r
1864 return false; // Bad value
\r
1866 // Normal return value
\r
1867 $response[$i] = new xmlrpcresp($val->arraymem(0));
\r
1870 $code = $val->structmem('faultCode');
\r
1871 if($code->kindOf() != 'scalar' || $code->scalartyp() != 'int')
\r
1875 $str = $val->structmem('faultString');
\r
1876 if($str->kindOf() != 'scalar' || $str->scalartyp() != 'string')
\r
1880 $response[$i] = new xmlrpcresp(0, $code->scalarval(), $str->scalarval());
\r
1889 } // end class xmlrpc_client
\r
1898 var $hdrs = array();
\r
1899 var $_cookies = array();
\r
1900 var $content_type = 'text/xml';
\r
1901 var $raw_data = '';
\r
1904 * @param mixed $val either an xmlrpcval obj, a php value or the xml serialization of an xmlrpcval (a string)
\r
1905 * @param integer $fcode set it to anything but 0 to create an error response
\r
1906 * @param string $fstr the error string, in case of an error response
\r
1907 * @param string $valtyp either 'xmlrpcvals', 'phpvals' or 'xml'
\r
1909 * @todo add check that $val / $fcode / $fstr is of correct type???
\r
1910 * NB: as of now we do not do it, since it might be either an xmlrpcval or a plain
\r
1911 * php val, or a complete xml chunk, depending on usage of xmlrpc_client::send() inside which creator is called...
\r
1913 function xmlrpcresp($val, $fcode = 0, $fstr = '', $valtyp='')
\r
1918 $this->errno = $fcode;
\r
1919 $this->errstr = $fstr;
\r
1920 //$this->errstr = htmlspecialchars($fstr); // XXX: encoding probably shouldn't be done here; fix later.
\r
1924 // successful response
\r
1925 $this->val = $val;
\r
1926 if ($valtyp == '')
\r
1928 // user did not declare type of response value: try to guess it
\r
1929 if (is_object($this->val) && is_a($this->val, 'xmlrpcval'))
\r
1931 $this->valtyp = 'xmlrpcvals';
\r
1933 else if (is_string($this->val))
\r
1935 $this->valtyp = 'xml';
\r
1940 $this->valtyp = 'phpvals';
\r
1945 // user declares type of resp value: believe him
\r
1946 $this->valtyp = $valtyp;
\r
1952 * Returns the error code of the response.
\r
1953 * @return integer the error code of this response (0 for not-error responses)
\r
1956 function faultCode()
\r
1958 return $this->errno;
\r
1962 * Returns the error code of the response.
\r
1963 * @return string the error string of this response ('' for not-error responses)
\r
1966 function faultString()
\r
1968 return $this->errstr;
\r
1972 * Returns the value received by the server.
\r
1973 * @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
1978 return $this->val;
\r
1982 * Returns an array with the cookies received from the server.
\r
1983 * Array has the form: $cookiename => array ('value' => $val, $attr1 => $val1, $attr2 = $val2, ...)
\r
1984 * with attributes being e.g. 'expires', 'path', domain'.
\r
1985 * NB: cookies sent as 'expired' by the server (i.e. with an expiry date in the past)
\r
1986 * are still present in the array. It is up to the user-defined code to decide
\r
1987 * how to use the received cookies, and wheter they have to be sent back with the next
\r
1988 * request to the server (using xmlrpc_client::setCookie) or not
\r
1989 * @return array array of cookies received from the server
\r
1992 function cookies()
\r
1994 return $this->_cookies;
\r
1998 * Returns xml representation of the response. XML prologue not included
\r
1999 * @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed
\r
2000 * @return string the xml representation of the response
\r
2003 function serialize($charset_encoding='')
\r
2005 if ($charset_encoding != '')
\r
2006 $this->content_type = 'text/xml; charset=' . $charset_encoding;
\r
2008 $this->content_type = 'text/xml';
\r
2009 $result = "<methodResponse>\n";
\r
2012 // G. Giunta 2005/2/13: let non-ASCII response messages be tolerated by clients
\r
2013 // by xml-encoding non ascii chars
\r
2014 $result .= "<fault>\n" .
\r
2015 "<value>\n<struct><member><name>faultCode</name>\n<value><int>" . $this->errno .
\r
2016 "</int></value>\n</member>\n<member>\n<name>faultString</name>\n<value><string>" .
\r
2017 xmlrpc_encode_entitites($this->errstr, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding) . "</string></value>\n</member>\n" .
\r
2018 "</struct>\n</value>\n</fault>";
\r
2022 if(!is_object($this->val) || !is_a($this->val, 'xmlrpcval'))
\r
2024 if (is_string($this->val) && $this->valtyp == 'xml')
\r
2026 $result .= "<params>\n<param>\n" .
\r
2028 "</param>\n</params>";
\r
2032 /// @todo try to build something serializable?
\r
2033 die('cannot serialize xmlrpcresp objects whose content is native php values');
\r
2038 $result .= "<params>\n<param>\n" .
\r
2039 $this->val->serialize($charset_encoding) .
\r
2040 "</param>\n</params>";
\r
2043 $result .= "\n</methodResponse>";
\r
2044 $this->payload = $result;
\r
2053 var $params=array();
\r
2055 var $content_type = 'text/xml';
\r
2058 * @param string $meth the name of the method to invoke
\r
2059 * @param array $pars array of parameters to be paased to the method (xmlrpcval objects)
\r
2061 function xmlrpcmsg($meth, $pars=0)
\r
2063 $this->methodname=$meth;
\r
2064 if(is_array($pars) && count($pars)>0)
\r
2066 for($i=0; $i<count($pars); $i++)
\r
2068 $this->addParam($pars[$i]);
\r
2076 function xml_header($charset_encoding='')
\r
2078 if ($charset_encoding != '')
\r
2080 return "<?xml version=\"1.0\" encoding=\"$charset_encoding\" ?" . ">\n<methodCall>\n";
\r
2084 return "<?xml version=\"1.0\"?" . ">\n<methodCall>\n";
\r
2091 function xml_footer()
\r
2093 return '</methodCall>';
\r
2107 function createPayload($charset_encoding='')
\r
2109 if ($charset_encoding != '')
\r
2110 $this->content_type = 'text/xml; charset=' . $charset_encoding;
\r
2112 $this->content_type = 'text/xml';
\r
2113 $this->payload=$this->xml_header($charset_encoding);
\r
2114 $this->payload.='<methodName>' . $this->methodname . "</methodName>\n";
\r
2115 $this->payload.="<params>\n";
\r
2116 for($i=0; $i<count($this->params); $i++)
\r
2118 $p=$this->params[$i];
\r
2119 $this->payload.="<param>\n" . $p->serialize($charset_encoding) .
\r
2122 $this->payload.="</params>\n";
\r
2123 $this->payload.=$this->xml_footer();
\r
2127 * Gets/sets the xmlrpc method to be invoked
\r
2128 * @param string $meth the method to be set (leave empty not to set it)
\r
2129 * @return string the method that will be invoked
\r
2132 function method($meth='')
\r
2136 $this->methodname=$meth;
\r
2138 return $this->methodname;
\r
2142 * Returns xml representation of the message. XML prologue included
\r
2143 * @return string the xml representation of the message, xml prologue included
\r
2146 function serialize($charset_encoding='')
\r
2148 $this->createPayload($charset_encoding);
\r
2149 return $this->payload;
\r
2153 * Add a parameter to the list of parameters to be used upon method invocation
\r
2154 * @param xmlrpcval $par
\r
2155 * @return boolean false on failure
\r
2158 function addParam($par)
\r
2160 // add check: do not add to self params which are not xmlrpcvals
\r
2161 if(is_object($par) && is_a($par, 'xmlrpcval'))
\r
2163 $this->params[]=$par;
\r
2173 * Returns the nth parameter in the message. The index zero-based.
\r
2174 * @param integer $i the index of the parameter to fetch (zero based)
\r
2175 * @return xmlrpcval the i-th parameter
\r
2178 function getParam($i) { return $this->params[$i]; }
\r
2181 * Returns the number of parameters in the messge.
\r
2182 * @return integer the number of parameters currently set
\r
2185 function getNumParams() { return count($this->params); }
\r
2188 * Given an open file handle, read all data available and parse it as axmlrpc response.
\r
2189 * NB: the file handle is not closed by this function.
\r
2190 * NNB: might have trouble in rare cases to work on network streams, as we
\r
2191 * check for a read of 0 bytes instead of feof($fp).
\r
2192 * But since checking for feof(null) returns false, we would risk an
\r
2193 * infinite loop in that case, because we cannot trust the caller
\r
2194 * to give us a valid pointer to an open file...
\r
2196 * @return xmlrpcresp
\r
2197 * @todo add 2nd & 3rd param to be passed to ParseResponse() ???
\r
2199 function &parseResponseFile($fp)
\r
2202 while($data=fread($fp, 32768))
\r
2207 $r =& $this->parseResponse($ipd);
\r
2212 * Parses HTTP headers and separates them from data.
\r
2215 function &parseResponseHeaders(&$data, $headers_processed=false)
\r
2217 // Support "web-proxy-tunelling" connections for https through proxies
\r
2218 if(preg_match('/^HTTP\/1\.[0-1] 200 Connection established/', $data))
\r
2220 // Look for CR/LF or simple LF as line separator,
\r
2221 // (even though it is not valid http)
\r
2222 $pos = strpos($data,"\r\n\r\n");
\r
2223 if($pos || is_int($pos))
\r
2229 $pos = strpos($data,"\n\n");
\r
2230 if($pos || is_int($pos))
\r
2236 // No separation between response headers and body: fault?
\r
2242 // this filters out all http headers from proxy.
\r
2243 // maybe we could take them into account, too?
\r
2244 $data = substr($data, $bd);
\r
2248 error_log('XML-RPC: xmlrpcmsg::parseResponse: HTTPS via proxy error, tunnel connection possibly failed');
\r
2249 $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $GLOBALS['xmlrpcstr']['http_error']. ' (HTTPS via proxy error, tunnel connection possibly failed)');
\r
2254 // Strip HTTP 1.1 100 Continue header if present
\r
2255 while(preg_match('/^HTTP\/1\.1 1[0-9]{2} /', $data))
\r
2257 $pos = strpos($data, 'HTTP', 12);
\r
2258 // server sent a Continue header without any (valid) content following...
\r
2259 // give the client a chance to know it
\r
2260 if(!$pos && !is_int($pos)) // works fine in php 3, 4 and 5
\r
2264 $data = substr($data, $pos);
\r
2266 if(!preg_match('/^HTTP\/[0-9.]+ 200 /', $data))
\r
2268 $errstr= substr($data, 0, strpos($data, "\n")-1);
\r
2269 error_log('XML-RPC: xmlrpcmsg::parseResponse: HTTP error, got response: ' .$errstr);
\r
2270 $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $GLOBALS['xmlrpcstr']['http_error']. ' (' . $errstr . ')');
\r
2274 $GLOBALS['_xh']['headers'] = array();
\r
2275 $GLOBALS['_xh']['cookies'] = array();
\r
2277 // be tolerant to usage of \n instead of \r\n to separate headers and data
\r
2278 // (even though it is not valid http)
\r
2279 $pos = strpos($data,"\r\n\r\n");
\r
2280 if($pos || is_int($pos))
\r
2286 $pos = strpos($data,"\n\n");
\r
2287 if($pos || is_int($pos))
\r
2293 // No separation between response headers and body: fault?
\r
2294 // we could take some action here instead of going on...
\r
2298 // be tolerant to line endings, and extra empty lines
\r
2299 $ar = preg_split("/\r?\n/", trim(substr($data, 0, $pos)));
\r
2300 while(list(,$line) = @each($ar))
\r
2302 // take care of multi-line headers and cookies
\r
2303 $arr = explode(':',$line,2);
\r
2304 if(count($arr) > 1)
\r
2306 $header_name = strtolower(trim($arr[0]));
\r
2307 /// @todo some other headers (the ones that allow a CSV list of values)
\r
2308 /// do allow many values to be passed using multiple header lines.
\r
2309 /// We should add content to $GLOBALS['_xh']['headers'][$header_name]
\r
2310 /// instead of replacing it for those...
\r
2311 if ($header_name == 'set-cookie' || $header_name == 'set-cookie2')
\r
2313 if ($header_name == 'set-cookie2')
\r
2315 // version 2 cookies:
\r
2316 // there could be many cookies on one line, comma separated
\r
2317 $cookies = explode(',', $arr[1]);
\r
2321 $cookies = array($arr[1]);
\r
2323 foreach ($cookies as $cookie)
\r
2325 // glue together all received cookies, using a comma to separate them
\r
2326 // (same as php does with getallheaders())
\r
2327 if (isset($GLOBALS['_xh']['headers'][$header_name]))
\r
2328 $GLOBALS['_xh']['headers'][$header_name] .= ', ' . trim($cookie);
\r
2330 $GLOBALS['_xh']['headers'][$header_name] = trim($cookie);
\r
2331 // parse cookie attributes, in case user wants to correctly honour them
\r
2332 // feature creep: only allow rfc-compliant cookie attributes?
\r
2333 // @todo support for server sending multiple time cookie with same name, but using different PATHs
\r
2334 $cookie = explode(';', $cookie);
\r
2335 foreach ($cookie as $pos => $val)
\r
2337 $val = explode('=', $val, 2);
\r
2338 $tag = trim($val[0]);
\r
2339 $val = trim(@$val[1]);
\r
2340 /// @todo with version 1 cookies, we should strip leading and trailing " chars
\r
2343 $cookiename = $tag;
\r
2344 $GLOBALS['_xh']['cookies'][$tag] = array();
\r
2345 $GLOBALS['_xh']['cookies'][$cookiename]['value'] = urldecode($val);
\r
2349 if ($tag != 'value')
\r
2351 $GLOBALS['_xh']['cookies'][$cookiename][$tag] = $val;
\r
2359 $GLOBALS['_xh']['headers'][$header_name] = trim($arr[1]);
\r
2362 elseif(isset($header_name))
\r
2364 /// @todo version1 cookies might span multiple lines, thus breaking the parsing above
\r
2365 $GLOBALS['_xh']['headers'][$header_name] .= ' ' . trim($line);
\r
2369 $data = substr($data, $bd);
\r
2371 if($this->debug && count($GLOBALS['_xh']['headers']))
\r
2374 foreach($GLOBALS['_xh']['headers'] as $header => $value)
\r
2376 print htmlentities("HEADER: $header: $value\n");
\r
2378 foreach($GLOBALS['_xh']['cookies'] as $header => $value)
\r
2380 print htmlentities("COOKIE: $header={$value['value']}\n");
\r
2385 // if CURL was used for the call, http headers have been processed,
\r
2386 // and dechunking + reinflating have been carried out
\r
2387 if(!$headers_processed)
\r
2389 // Decode chunked encoding sent by http 1.1 servers
\r
2390 if(isset($GLOBALS['_xh']['headers']['transfer-encoding']) && $GLOBALS['_xh']['headers']['transfer-encoding'] == 'chunked')
\r
2392 if(!$data = decode_chunked($data))
\r
2394 error_log('XML-RPC: xmlrpcmsg::parseResponse: errors occurred when trying to rebuild the chunked data received from server');
\r
2395 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['dechunk_fail'], $GLOBALS['xmlrpcstr']['dechunk_fail']);
\r
2400 // Decode gzip-compressed stuff
\r
2401 // code shamelessly inspired from nusoap library by Dietrich Ayala
\r
2402 if(isset($GLOBALS['_xh']['headers']['content-encoding']))
\r
2404 $GLOBALS['_xh']['headers']['content-encoding'] = str_replace('x-', '', $GLOBALS['_xh']['headers']['content-encoding']);
\r
2405 if($GLOBALS['_xh']['headers']['content-encoding'] == 'deflate' || $GLOBALS['_xh']['headers']['content-encoding'] == 'gzip')
\r
2407 // if decoding works, use it. else assume data wasn't gzencoded
\r
2408 if(function_exists('gzinflate'))
\r
2410 if($GLOBALS['_xh']['headers']['content-encoding'] == 'deflate' && $degzdata = @gzuncompress($data))
\r
2412 $data = $degzdata;
\r
2414 print "<PRE>---INFLATED RESPONSE---[".strlen($data)." chars]---\n" . htmlentities($data) . "\n---END---</PRE>";
\r
2416 elseif($GLOBALS['_xh']['headers']['content-encoding'] == 'gzip' && $degzdata = @gzinflate(substr($data, 10)))
\r
2418 $data = $degzdata;
\r
2420 print "<PRE>---INFLATED RESPONSE---[".strlen($data)." chars]---\n" . htmlentities($data) . "\n---END---</PRE>";
\r
2424 error_log('XML-RPC: xmlrpcmsg::parseResponse: errors occurred when trying to decode the deflated data received from server');
\r
2425 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['decompress_fail'], $GLOBALS['xmlrpcstr']['decompress_fail']);
\r
2431 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
2432 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['cannot_decompress'], $GLOBALS['xmlrpcstr']['cannot_decompress']);
\r
2437 } // end of 'if needed, de-chunk, re-inflate response'
\r
2439 // real stupid hack to avoid PHP 4 complaining about returning NULL by ref
\r
2446 * Parse the xmlrpc response contained in the string $data and return an xmlrpcresp object.
\r
2447 * @param string $data the xmlrpc response, eventually including http headers
\r
2448 * @param bool $headers_processed when true prevents parsing HTTP headers for interpretation of content-encoding and consequent decoding
\r
2449 * @param string $return_type decides return type, i.e. content of response->value(). Either 'xmlrpcvals', 'xml' or 'phpvals'
\r
2450 * @return xmlrpcresp
\r
2453 function &parseResponse($data='', $headers_processed=false, $return_type='xmlrpcvals')
\r
2457 //by maHo, replaced htmlspecialchars with htmlentities
\r
2458 print "<PRE>---GOT---\n" . htmlentities($data) . "\n---END---\n</PRE>";
\r
2463 error_log('XML-RPC: xmlrpcmsg::parseResponse: no response received from server.');
\r
2464 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_data'], $GLOBALS['xmlrpcstr']['no_data']);
\r
2468 $GLOBALS['_xh']=array();
\r
2470 $raw_data = $data;
\r
2471 // parse the HTTP headers of the response, if present, and separate them from data
\r
2472 if(substr($data, 0, 4) == 'HTTP')
\r
2474 $r =& $this->parseResponseHeaders($data, $headers_processed);
\r
2477 // failed processing of HTTP response headers
\r
2478 // save into response obj the full payload received, for debugging
\r
2479 $r->raw_data = $data;
\r
2485 $GLOBALS['_xh']['headers'] = array();
\r
2486 $GLOBALS['_xh']['cookies'] = array();
\r
2491 $start = strpos($data, '<!-- SERVER DEBUG INFO (BASE64 ENCODED):');
\r
2494 $start += strlen('<!-- SERVER DEBUG INFO (BASE64 ENCODED):');
\r
2495 $end = strpos($data, '-->', $start);
\r
2496 $comments = substr($data, $start, $end-$start);
\r
2497 print "<PRE>---SERVER DEBUG INFO (DECODED) ---\n\t".htmlentities(str_replace("\n", "\n\t", base64_decode($comments)))."\n---END---\n</PRE>";
\r
2501 // be tolerant of extra whitespace in response body
\r
2502 $data = trim($data);
\r
2504 /// @todo return an error msg if $data=='' ?
\r
2506 // be tolerant of junk after methodResponse (e.g. javascript ads automatically inserted by free hosts)
\r
2507 // idea from Luca Mariano <luca.mariano@email.it> originally in PEARified version of the lib
\r
2509 // Poor man's version of strrpos for php 4...
\r
2510 $pos = strpos($data, '</methodResponse>');
\r
2511 while($pos || is_int($pos))
\r
2514 $pos = strpos($data, '</methodResponse>', $bd);
\r
2518 $data = substr($data, 0, $bd);
\r
2521 // if user wants back raw xml, give it to him
\r
2522 if ($return_type == 'xml')
\r
2524 $r = new xmlrpcresp($data, 0, '', 'xml');
\r
2525 $r->hdrs = $GLOBALS['_xh']['headers'];
\r
2526 $r->_cookies = $GLOBALS['_xh']['cookies'];
\r
2527 $r->raw_data = $raw_data;
\r
2531 // try to 'guestimate' the character encoding of the received response
\r
2532 $resp_encoding = guess_encoding(@$GLOBALS['_xh']['headers']['content-type'], $data);
\r
2534 $GLOBALS['_xh']['ac']='';
\r
2535 //$GLOBALS['_xh']['qt']=''; //unused...
\r
2536 $GLOBALS['_xh']['stack'] = array();
\r
2537 $GLOBALS['_xh']['valuestack'] = array();
\r
2538 $GLOBALS['_xh']['isf']=0; // 0 = OK, 1 for xmlrpc fault responses, 2 = invalid xmlrpc
\r
2539 $GLOBALS['_xh']['isf_reason']='';
\r
2540 $GLOBALS['_xh']['rt']=''; // 'methodcall or 'methodresponse'
\r
2542 // if response charset encoding is not known / supported, try to use
\r
2543 // the default encoding and parse the xml anyway, but log a warning...
\r
2544 if (!in_array($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
\r
2545 // the following code might be better for mb_string enabled installs, but
\r
2546 // makes the lib about 200% slower...
\r
2547 //if (!is_valid_charset($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
\r
2549 error_log('XML-RPC: xmlrpcmsg::parseResponse: invalid charset encoding of received response: '.$resp_encoding);
\r
2550 $resp_encoding = $GLOBALS['xmlrpc_defencoding'];
\r
2552 $parser = xml_parser_create($resp_encoding);
\r
2553 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true);
\r
2554 // G. Giunta 2005/02/13: PHP internally uses ISO-8859-1, so we have to tell
\r
2555 // the xml parser to give us back data in the expected charset.
\r
2556 // What if internal encoding is not in one of the 3 allowed?
\r
2557 // we use the broadest one, ie. utf8
\r
2558 // This allows to send data which is native in various charset,
\r
2559 // by extending xmlrpc_encode_entitites() and setting xmlrpc_internalencoding
\r
2560 if (!in_array($GLOBALS['xmlrpc_internalencoding'], array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
\r
2562 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');
\r
2566 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $GLOBALS['xmlrpc_internalencoding']);
\r
2569 if ($return_type == 'phpvals')
\r
2571 xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast');
\r
2575 xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee');
\r
2578 xml_set_character_data_handler($parser, 'xmlrpc_cd');
\r
2579 xml_set_default_handler($parser, 'xmlrpc_dh');
\r
2581 // first error check: xml not well formed
\r
2582 if(!xml_parse($parser, $data, count($data)))
\r
2584 // thanks to Peter Kocks <peter.kocks@baygate.com>
\r
2585 if((xml_get_current_line_number($parser)) == 1)
\r
2587 $errstr = 'XML error at line 1, check URL';
\r
2591 $errstr = sprintf('XML error: %s at line %d, column %d',
\r
2592 xml_error_string(xml_get_error_code($parser)),
\r
2593 xml_get_current_line_number($parser), xml_get_current_column_number($parser));
\r
2595 error_log($errstr);
\r
2596 $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'], $GLOBALS['xmlrpcstr']['invalid_return'].' ('.$errstr.')');
\r
2597 xml_parser_free($parser);
\r
2602 $r->hdrs = $GLOBALS['_xh']['headers'];
\r
2603 $r->_cookies = $GLOBALS['_xh']['cookies'];
\r
2604 $r->raw_data = $raw_data;
\r
2607 xml_parser_free($parser);
\r
2608 // second error check: xml well formed but not xml-rpc compliant
\r
2609 if ($GLOBALS['_xh']['isf'] > 1)
\r
2613 /// @todo echo something for user?
\r
2616 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'],
\r
2617 $GLOBALS['xmlrpcstr']['invalid_return'] . ' ' . $GLOBALS['_xh']['isf_reason']);
\r
2619 // third error check: parsing of the response has somehow gone boink.
\r
2620 // NB: shall we omit this check, since we trust the parsing code?
\r
2621 elseif ($return_type == 'xmlrpcvals' && !is_object($GLOBALS['_xh']['value']))
\r
2623 // something odd has happened
\r
2624 // and it's time to generate a client side error
\r
2625 // indicating something odd went on
\r
2626 $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'],
\r
2627 $GLOBALS['xmlrpcstr']['invalid_return']);
\r
2633 print "<PRE>---PARSED---\n";
\r
2634 // somehow htmlentities chokes on var_export, and some full html string...
\r
2635 //print htmlentitites(var_export($GLOBALS['_xh']['value'], true));
\r
2636 print htmlspecialchars(var_export($GLOBALS['_xh']['value'], true));
\r
2637 print "\n---END---</PRE>";
\r
2640 // note that using =& will raise an error if $GLOBALS['_xh']['st'] does not generate an object.
\r
2641 $v =& $GLOBALS['_xh']['value'];
\r
2643 if($GLOBALS['_xh']['isf'])
\r
2645 /// @todo we should test here if server sent an int and a string,
\r
2646 /// and/or coerce them into such...
\r
2647 if ($return_type == 'xmlrpcvals')
\r
2649 $errno_v = $v->structmem('faultCode');
\r
2650 $errstr_v = $v->structmem('faultString');
\r
2651 $errno = $errno_v->scalarval();
\r
2652 $errstr = $errstr_v->scalarval();
\r
2656 $errno = $v['faultCode'];
\r
2657 $errstr = $v['faultString'];
\r
2662 // FAULT returned, errno needs to reflect that
\r
2666 $r = new xmlrpcresp(0, $errno, $errstr);
\r
2670 $r=new xmlrpcresp($v, 0, '', $return_type);
\r
2674 $r->hdrs = $GLOBALS['_xh']['headers'];
\r
2675 $r->_cookies = $GLOBALS['_xh']['cookies'];
\r
2676 $r->raw_data = $raw_data;
\r
2685 var $_php_class=null;
\r
2688 * @param mixed $val
\r
2689 * @param string $type any valid xmlrpc type name (lowercase). If null, 'string' is assumed
\r
2691 function xmlrpcval($val=-1, $type='')
\r
2693 /// @todo: optimization creep - do not call addXX, do it all inline.
\r
2694 /// downside: booleans will not be coerced anymore
\r
2695 if($val!==-1 || $type!='')
\r
2697 // optimization creep: inlined all work done by constructor
\r
2702 $this->me['string']=$val;
\r
2709 case 'dateTime.iso8601':
\r
2713 $this->me[$type]=$val;
\r
2717 $this->me['array']=$val;
\r
2721 $this->me['struct']=$val;
\r
2724 error_log("XML-RPC: xmlrpcval::xmlrpcval: not a known type ($type)");
\r
2730 if($GLOBALS['xmlrpcTypes'][$type]==1)
\r
2732 $this->addScalar($val,$type);
\r
2734 elseif($GLOBALS['xmlrpcTypes'][$type]==2)
\r
2736 $this->addArray($val);
\r
2738 elseif($GLOBALS['xmlrpcTypes'][$type]==3)
\r
2740 $this->addStruct($val);
\r
2746 * Add a single php value to an (unitialized) xmlrpcval
\r
2747 * @param mixed $val
\r
2748 * @param string $type
\r
2749 * @return int 1 or 0 on failure
\r
2751 function addScalar($val, $type='string')
\r
2753 $typeof=@$GLOBALS['xmlrpcTypes'][$type];
\r
2756 error_log("XML-RPC: xmlrpcval::addScalar: not a scalar type ($type)");
\r
2760 // coerce booleans into correct values
\r
2761 // NB: we should either do it for datetimes, integers and doubles, too,
\r
2762 // or just plain remove this check, implemented on booleans only...
\r
2763 if($type==$GLOBALS['xmlrpcBoolean'])
\r
2765 if(strcasecmp($val,'true')==0 || $val==1 || ($val==true && strcasecmp($val,'false')))
\r
2775 switch($this->mytype)
\r
2778 error_log('XML-RPC: xmlrpcval::addScalar: scalar xmlrpcval can have only one value');
\r
2781 error_log('XML-RPC: xmlrpcval::addScalar: cannot add anonymous scalar to struct xmlrpcval');
\r
2784 // we're adding a scalar value to an array here
\r
2785 //$ar=$this->me['array'];
\r
2786 //$ar[]=new xmlrpcval($val, $type);
\r
2787 //$this->me['array']=$ar;
\r
2788 // Faster (?) avoid all the costly array-copy-by-val done here...
\r
2789 $this->me['array'][]=new xmlrpcval($val, $type);
\r
2792 // a scalar, so set the value and remember we're scalar
\r
2793 $this->me[$type]=$val;
\r
2794 $this->mytype=$typeof;
\r
2800 * Add an array of xmlrpcval objects to an xmlrpcval
\r
2801 * @param array $vals
\r
2802 * @return int 1 or 0 on failure
\r
2805 * @todo add some checking for $vals to be an array of xmlrpcvals?
\r
2807 function addArray($vals)
\r
2809 if($this->mytype==0)
\r
2811 $this->mytype=$GLOBALS['xmlrpcTypes']['array'];
\r
2812 $this->me['array']=$vals;
\r
2815 elseif($this->mytype==2)
\r
2817 // we're adding to an array here
\r
2818 $this->me['array'] = array_merge($this->me['array'], $vals);
\r
2823 error_log('XML-RPC: xmlrpcval::addArray: already initialized as a [' . $this->kindOf() . ']');
\r
2829 * Add an array of named xmlrpcval objects to an xmlrpcval
\r
2830 * @param array $vals
\r
2831 * @return int 1 or 0 on failure
\r
2834 * @todo add some checking for $vals to be an array?
\r
2836 function addStruct($vals)
\r
2838 if($this->mytype==0)
\r
2840 $this->mytype=$GLOBALS['xmlrpcTypes']['struct'];
\r
2841 $this->me['struct']=$vals;
\r
2844 elseif($this->mytype==3)
\r
2846 // we're adding to a struct here
\r
2847 $this->me['struct'] = array_merge($this->me['struct'], $vals);
\r
2852 error_log('XML-RPC: xmlrpcval::addStruct: already initialized as a [' . $this->kindOf() . ']');
\r
2857 // poor man's version of print_r ???
\r
2859 function dump($ar)
\r
2861 foreach($ar as $key => $val)
\r
2863 echo "$key => $val<br />";
\r
2864 if($key == 'array')
\r
2866 while(list($key2, $val2) = each($val))
\r
2868 echo "-- $key2 => $val2<br />";
\r
2875 * Returns a string containing "struct", "array" or "scalar" describing the base type of the value
\r
2881 switch($this->mytype)
\r
2900 function serializedata($typ, $val, $charset_encoding='')
\r
2903 switch(@$GLOBALS['xmlrpcTypes'][$typ])
\r
2908 case $GLOBALS['xmlrpcBase64']:
\r
2909 $rs.="<${typ}>" . base64_encode($val) . "</${typ}>";
\r
2911 case $GLOBALS['xmlrpcBoolean']:
\r
2912 $rs.="<${typ}>" . ($val ? '1' : '0') . "</${typ}>";
\r
2914 case $GLOBALS['xmlrpcString']:
\r
2915 // G. Giunta 2005/2/13: do NOT use htmlentities, since
\r
2916 // it will produce named html entities, which are invalid xml
\r
2917 $rs.="<${typ}>" . xmlrpc_encode_entitites($val, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding). "</${typ}>";
\r
2919 case $GLOBALS['xmlrpcInt']:
\r
2920 case $GLOBALS['xmlrpcI4']:
\r
2921 $rs.="<${typ}>".(int)$val."</${typ}>";
\r
2923 case $GLOBALS['xmlrpcDouble']:
\r
2924 // avoid using standard conversion of float to string because it is locale-dependent,
\r
2925 // and also because the xmlrpc spec forbids exponential notation
\r
2926 // sprintf('%F') would be most likely ok but it is only available since PHP 4.3.10 and PHP 5.0.3.
\r
2927 // The code below tries its best at keeping max precision while avoiding exp notation,
\r
2928 // but there is of course no limit in the number of decimal places to be used...
\r
2929 $rs.="<${typ}>".preg_replace('/\\.?0+$/','',number_format((double)$val, 128, '.', ''))."</${typ}>";
\r
2931 case $GLOBALS['xmlrpcDateTime']:
\r
2932 if (is_string($val))
\r
2934 $rs.="<${typ}>${val}</${typ}>";
\r
2936 else if(is_a($val, 'DateTime'))
\r
2938 $rs.="<${typ}>".$val->format('Ymd\TH:i:s')."</${typ}>";
\r
2940 else if(is_int($val))
\r
2942 $rs.="<${typ}>".strftime("%Y%m%dT%H:%M:%S", $val)."</${typ}>";
\r
2946 // not really a good idea here: but what shall we output anyway? left for backward compat...
\r
2947 $rs.="<${typ}>${val}</${typ}>";
\r
2950 case $GLOBALS['xmlrpcNull']:
\r
2951 if ($GLOBALS['xmlrpc_null_apache_encoding'])
\r
2961 // no standard type value should arrive here, but provide a possibility
\r
2962 // for xmlrpcvals of unknown type...
\r
2963 $rs.="<${typ}>${val}</${typ}>";
\r
2968 if ($this->_php_class)
\r
2970 $rs.='<struct php_class="' . $this->_php_class . "\">\n";
\r
2974 $rs.="<struct>\n";
\r
2976 foreach($val as $key2 => $val2)
\r
2978 $rs.='<member><name>'.xmlrpc_encode_entitites($key2, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding)."</name>\n";
\r
2979 //$rs.=$this->serializeval($val2);
\r
2980 $rs.=$val2->serialize($charset_encoding);
\r
2981 $rs.="</member>\n";
\r
2987 $rs.="<array>\n<data>\n";
\r
2988 for($i=0; $i<count($val); $i++)
\r
2990 //$rs.=$this->serializeval($val[$i]);
\r
2991 $rs.=$val[$i]->serialize($charset_encoding);
\r
2993 $rs.="</data>\n</array>";
\r
3002 * Returns xml representation of the value. XML prologue not included
\r
3003 * @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed
\r
3007 function serialize($charset_encoding='')
\r
3009 // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...
\r
3010 //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))
\r
3013 list($typ, $val) = each($this->me);
\r
3014 return '<value>' . $this->serializedata($typ, $val, $charset_encoding) . "</value>\n";
\r
3019 function serializeval($o)
\r
3021 // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...
\r
3022 //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))
\r
3026 list($typ, $val) = each($ar);
\r
3027 return '<value>' . $this->serializedata($typ, $val) . "</value>\n";
\r
3032 * Checks wheter a struct member with a given name is present.
\r
3033 * Works only on xmlrpcvals of type struct.
\r
3034 * @param string $m the name of the struct member to be looked up
\r
3038 function structmemexists($m)
\r
3040 return array_key_exists($m, $this->me['struct']);
\r
3044 * Returns the value of a given struct member (an xmlrpcval object in itself).
\r
3045 * Will raise a php warning if struct member of given name does not exist
\r
3046 * @param string $m the name of the struct member to be looked up
\r
3047 * @return xmlrpcval
\r
3050 function structmem($m)
\r
3052 return $this->me['struct'][$m];
\r
3056 * Reset internal pointer for xmlrpcvals of type struct.
\r
3059 function structreset()
\r
3061 reset($this->me['struct']);
\r
3065 * Return next member element for xmlrpcvals of type struct.
\r
3066 * @return xmlrpcval
\r
3069 function structeach()
\r
3071 return each($this->me['struct']);
\r
3074 // DEPRECATED! this code looks like it is very fragile and has not been fixed
\r
3075 // for a long long time. Shall we remove it for 2.0?
\r
3080 list($a,$b)=each($this->me);
\r
3081 // contributed by I Sofer, 2001-03-24
\r
3082 // add support for nested arrays to scalarval
\r
3083 // i've created a new method here, so as to
\r
3084 // preserve back compatibility
\r
3089 while(list($id,$cont) = @each($b))
\r
3091 $b[$id] = $cont->scalarval();
\r
3095 // add support for structures directly encoding php objects
\r
3098 $t = get_object_vars($b);
\r
3100 while(list($id,$cont) = @each($t))
\r
3102 $t[$id] = $cont->scalarval();
\r
3105 while(list($id,$cont) = @each($t))
\r
3115 * Returns the value of a scalar xmlrpcval
\r
3119 function scalarval()
\r
3122 list(,$b)=each($this->me);
\r
3127 * Returns the type of the xmlrpcval.
\r
3128 * For integers, 'int' is always returned in place of 'i4'
\r
3132 function scalartyp()
\r
3135 list($a,)=each($this->me);
\r
3136 if($a==$GLOBALS['xmlrpcI4'])
\r
3138 $a=$GLOBALS['xmlrpcInt'];
\r
3144 * Returns the m-th member of an xmlrpcval of struct type
\r
3145 * @param integer $m the index of the value to be retrieved (zero based)
\r
3146 * @return xmlrpcval
\r
3149 function arraymem($m)
\r
3151 return $this->me['array'][$m];
\r
3155 * Returns the number of members in an xmlrpcval of array type
\r
3159 function arraysize()
\r
3161 return count($this->me['array']);
\r
3165 * Returns the number of members in an xmlrpcval of struct type
\r
3169 function structsize()
\r
3171 return count($this->me['struct']);
\r
3179 * Given a timestamp, return the corresponding ISO8601 encoded string.
\r
3181 * Really, timezones ought to be supported
\r
3182 * but the XML-RPC spec says:
\r
3184 * "Don't assume a timezone. It should be specified by the server in its
\r
3185 * documentation what assumptions it makes about timezones."
\r
3187 * These routines always assume localtime unless
\r
3188 * $utc is set to 1, in which case UTC is assumed
\r
3189 * and an adjustment for locale is made when encoding
\r
3191 * @param int $timet (timestamp)
\r
3192 * @param int $utc (0 or 1)
\r
3195 function iso8601_encode($timet, $utc=0)
\r
3199 $t=strftime("%Y%m%dT%H:%M:%S", $timet);
\r
3203 if(function_exists('gmstrftime'))
\r
3205 // gmstrftime doesn't exist in some versions
\r
3207 $t=gmstrftime("%Y%m%dT%H:%M:%S", $timet);
\r
3211 $t=strftime("%Y%m%dT%H:%M:%S", $timet-date('Z'));
\r
3218 * Given an ISO8601 date string, return a timet in the localtime, or UTC
\r
3219 * @param string $idate
\r
3220 * @param int $utc either 0 or 1
\r
3221 * @return int (datetime)
\r
3223 function iso8601_decode($idate, $utc=0)
\r
3226 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
3230 $t=gmmktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);
\r
3234 $t=mktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);
\r
3241 * Takes an xmlrpc value in PHP xmlrpcval object format and translates it into native PHP types.
\r
3243 * Works with xmlrpc message objects as input, too.
\r
3245 * Given proper options parameter, can rebuild generic php object instances
\r
3246 * (provided those have been encoded to xmlrpc format using a corresponding
\r
3247 * option in php_xmlrpc_encode())
\r
3248 * PLEASE NOTE that rebuilding php objects involves calling their constructor function.
\r
3249 * This means that the remote communication end can decide which php code will
\r
3250 * get executed on your server, leaving the door possibly open to 'php-injection'
\r
3251 * style of attacks (provided you have some classes defined on your server that
\r
3252 * might wreak havoc if instances are built outside an appropriate context).
\r
3253 * Make sure you trust the remote server/client before eanbling this!
\r
3255 * @author Dan Libby (dan@libby.com)
\r
3257 * @param xmlrpcval $xmlrpc_val
\r
3258 * @param array $options if 'decode_php_objs' is set in the options array, xmlrpc structs can be decoded into php objects; if 'dates_as_objects' is set xmlrpc datetimes are decoded as php DateTime objects (standard is
\r
3261 function php_xmlrpc_decode($xmlrpc_val, $options=array())
\r
3263 switch($xmlrpc_val->kindOf())
\r
3266 if (in_array('extension_api', $options))
\r
3268 reset($xmlrpc_val->me);
\r
3269 list($typ,$val) = each($xmlrpc_val->me);
\r
3272 case 'dateTime.iso8601':
\r
3273 $xmlrpc_val->scalar = $val;
\r
3274 $xmlrpc_val->xmlrpc_type = 'datetime';
\r
3275 $xmlrpc_val->timestamp = iso8601_decode($val);
\r
3276 return $xmlrpc_val;
\r
3278 $xmlrpc_val->scalar = $val;
\r
3279 $xmlrpc_val->type = $typ;
\r
3280 return $xmlrpc_val;
\r
3282 return $xmlrpc_val->scalarval();
\r
3285 if (in_array('dates_as_objects', $options) && $xmlrpc_val->scalartyp() == 'dateTime.iso8601')
\r
3287 // we return a Datetime object instead of a string
\r
3288 // since now the constructor of xmlrpcval accepts safely strings, ints and datetimes,
\r
3289 // we cater to all 3 cases here
\r
3290 $out = $xmlrpc_val->scalarval();
\r
3291 if (is_string($out))
\r
3293 $out= strtotime($out);
\r
3297 $result = new Datetime();
\r
3298 $result->setTimestamp($out);
\r
3301 elseif (is_a($out, 'Datetime'))
\r
3306 return $xmlrpc_val->scalarval();
\r
3308 $size = $xmlrpc_val->arraysize();
\r
3310 for($i = 0; $i < $size; $i++)
\r
3312 $arr[] = php_xmlrpc_decode($xmlrpc_val->arraymem($i), $options);
\r
3316 $xmlrpc_val->structreset();
\r
3317 // If user said so, try to rebuild php objects for specific struct vals.
\r
3318 /// @todo should we raise a warning for class not found?
\r
3319 // shall we check for proper subclass of xmlrpcval instead of
\r
3320 // presence of _php_class to detect what we can do?
\r
3321 if (in_array('decode_php_objs', $options) && $xmlrpc_val->_php_class != ''
\r
3322 && class_exists($xmlrpc_val->_php_class))
\r
3324 $obj = @new $xmlrpc_val->_php_class;
\r
3325 while(list($key,$value)=$xmlrpc_val->structeach())
\r
3327 $obj->$key = php_xmlrpc_decode($value, $options);
\r
3334 while(list($key,$value)=$xmlrpc_val->structeach())
\r
3336 $arr[$key] = php_xmlrpc_decode($value, $options);
\r
3341 $paramcount = $xmlrpc_val->getNumParams();
\r
3343 for($i = 0; $i < $paramcount; $i++)
\r
3345 $arr[] = php_xmlrpc_decode($xmlrpc_val->getParam($i));
\r
3351 // This constant left here only for historical reasons...
\r
3352 // it was used to decide if we have to define xmlrpc_encode on our own, but
\r
3353 // we do not do it anymore
\r
3354 if(function_exists('xmlrpc_decode'))
\r
3356 define('XMLRPC_EPI_ENABLED','1');
\r
3360 define('XMLRPC_EPI_ENABLED','0');
\r
3364 * Takes native php types and encodes them into xmlrpc PHP object format.
\r
3365 * It will not re-encode xmlrpcval objects.
\r
3367 * Feature creep -- could support more types via optional type argument
\r
3368 * (string => datetime support has been added, ??? => base64 not yet)
\r
3370 * If given a proper options parameter, php object instances will be encoded
\r
3371 * into 'special' xmlrpc values, that can later be decoded into php objects
\r
3372 * by calling php_xmlrpc_decode() with a corresponding option
\r
3374 * @author Dan Libby (dan@libby.com)
\r
3376 * @param mixed $php_val the value to be converted into an xmlrpcval object
\r
3377 * @param array $options can include 'encode_php_objs', 'auto_dates', 'null_extension' or 'extension_api'
\r
3378 * @return xmlrpcval
\r
3380 function &php_xmlrpc_encode($php_val, $options=array())
\r
3382 $type = gettype($php_val);
\r
3386 if (in_array('auto_dates', $options) && preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $php_val))
\r
3387 $xmlrpc_val = new xmlrpcval($php_val, $GLOBALS['xmlrpcDateTime']);
\r
3389 $xmlrpc_val = new xmlrpcval($php_val, $GLOBALS['xmlrpcString']);
\r
3392 $xmlrpc_val = new xmlrpcval($php_val, $GLOBALS['xmlrpcInt']);
\r
3395 $xmlrpc_val = new xmlrpcval($php_val, $GLOBALS['xmlrpcDouble']);
\r
3397 // <G_Giunta_2001-02-29>
\r
3398 // Add support for encoding/decoding of booleans, since they are supported in PHP
\r
3400 $xmlrpc_val = new xmlrpcval($php_val, $GLOBALS['xmlrpcBoolean']);
\r
3402 // </G_Giunta_2001-02-29>
\r
3404 // PHP arrays can be encoded to either xmlrpc structs or arrays,
\r
3405 // depending on wheter they are hashes or plain 0..n integer indexed
\r
3406 // A shorter one-liner would be
\r
3407 // $tmp = array_diff(array_keys($php_val), range(0, count($php_val)-1));
\r
3408 // but execution time skyrockets!
\r
3412 foreach($php_val as $key => $val)
\r
3414 $arr[$key] =& php_xmlrpc_encode($val, $options);
\r
3415 if(!$ko && $key !== $j)
\r
3423 $xmlrpc_val = new xmlrpcval($arr, $GLOBALS['xmlrpcStruct']);
\r
3427 $xmlrpc_val = new xmlrpcval($arr, $GLOBALS['xmlrpcArray']);
\r
3431 if(is_a($php_val, 'xmlrpcval'))
\r
3433 $xmlrpc_val = $php_val;
\r
3435 else if(is_a($php_val, 'DateTime'))
\r
3437 $xmlrpc_val = new xmlrpcval($php_val->format('Ymd\TH:i:s'), $GLOBALS['xmlrpcStruct']);
\r
3442 while(list($k,$v) = each($php_val))
\r
3444 $arr[$k] = php_xmlrpc_encode($v, $options);
\r
3446 $xmlrpc_val = new xmlrpcval($arr, $GLOBALS['xmlrpcStruct']);
\r
3447 if (in_array('encode_php_objs', $options))
\r
3449 // let's save original class name into xmlrpcval:
\r
3450 // might be useful later on...
\r
3451 $xmlrpc_val->_php_class = get_class($php_val);
\r
3456 if (in_array('extension_api', $options))
\r
3458 $xmlrpc_val = new xmlrpcval('', $GLOBALS['xmlrpcString']);
\r
3460 else if (in_array('null_extension', $options))
\r
3462 $xmlrpc_val = new xmlrpcval('', $GLOBALS['xmlrpcNull']);
\r
3466 $xmlrpc_val = new xmlrpcval();
\r
3470 if (in_array('extension_api', $options))
\r
3472 $xmlrpc_val = new xmlrpcval((int)$php_val, $GLOBALS['xmlrpcInt']);
\r
3476 $xmlrpc_val = new xmlrpcval();
\r
3478 // catch "user function", "unknown type"
\r
3480 // giancarlo pinerolo <ping@alt.it>
\r
3481 // it has to return
\r
3482 // an empty object in case, not a boolean.
\r
3483 $xmlrpc_val = new xmlrpcval();
\r
3486 return $xmlrpc_val;
\r
3490 * Convert the xml representation of a method response, method request or single
\r
3491 * xmlrpc value into the appropriate object (a.k.a. deserialize)
\r
3492 * @param string $xml_val
\r
3493 * @param array $options
\r
3494 * @return mixed false on error, or an instance of either xmlrpcval, xmlrpcmsg or xmlrpcresp
\r
3496 function php_xmlrpc_decode_xml($xml_val, $options=array())
\r
3498 $GLOBALS['_xh'] = array();
\r
3499 $GLOBALS['_xh']['ac'] = '';
\r
3500 $GLOBALS['_xh']['stack'] = array();
\r
3501 $GLOBALS['_xh']['valuestack'] = array();
\r
3502 $GLOBALS['_xh']['params'] = array();
\r
3503 $GLOBALS['_xh']['pt'] = array();
\r
3504 $GLOBALS['_xh']['isf'] = 0;
\r
3505 $GLOBALS['_xh']['isf_reason'] = '';
\r
3506 $GLOBALS['_xh']['method'] = false;
\r
3507 $GLOBALS['_xh']['rt'] = '';
\r
3508 /// @todo 'guestimate' encoding
\r
3509 $parser = xml_parser_create();
\r
3510 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true);
\r
3511 // What if internal encoding is not in one of the 3 allowed?
\r
3512 // we use the broadest one, ie. utf8!
\r
3513 if (!in_array($GLOBALS['xmlrpc_internalencoding'], array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
\r
3515 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');
\r
3519 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $GLOBALS['xmlrpc_internalencoding']);
\r
3521 xml_set_element_handler($parser, 'xmlrpc_se_any', 'xmlrpc_ee');
\r
3522 xml_set_character_data_handler($parser, 'xmlrpc_cd');
\r
3523 xml_set_default_handler($parser, 'xmlrpc_dh');
\r
3524 if(!xml_parse($parser, $xml_val, 1))
\r
3526 $errstr = sprintf('XML error: %s at line %d, column %d',
\r
3527 xml_error_string(xml_get_error_code($parser)),
\r
3528 xml_get_current_line_number($parser), xml_get_current_column_number($parser));
\r
3529 error_log($errstr);
\r
3530 xml_parser_free($parser);
\r
3533 xml_parser_free($parser);
\r
3534 if ($GLOBALS['_xh']['isf'] > 1) // test that $GLOBALS['_xh']['value'] is an obj, too???
\r
3536 error_log($GLOBALS['_xh']['isf_reason']);
\r
3539 switch ($GLOBALS['_xh']['rt'])
\r
3541 case 'methodresponse':
\r
3542 $v =& $GLOBALS['_xh']['value'];
\r
3543 if ($GLOBALS['_xh']['isf'] == 1)
\r
3545 $vc = $v->structmem('faultCode');
\r
3546 $vs = $v->structmem('faultString');
\r
3547 $r = new xmlrpcresp(0, $vc->scalarval(), $vs->scalarval());
\r
3551 $r = new xmlrpcresp($v);
\r
3554 case 'methodcall':
\r
3555 $m = new xmlrpcmsg($GLOBALS['_xh']['method']);
\r
3556 for($i=0; $i < count($GLOBALS['_xh']['params']); $i++)
\r
3558 $m->addParam($GLOBALS['_xh']['params'][$i]);
\r
3562 return $GLOBALS['_xh']['value'];
\r
3569 * decode a string that is encoded w/ "chunked" transfer encoding
\r
3570 * as defined in rfc2068 par. 19.4.6
\r
3571 * code shamelessly stolen from nusoap library by Dietrich Ayala
\r
3573 * @param string $buffer the string to be decoded
\r
3576 function decode_chunked($buffer)
\r
3582 // read chunk-size, chunk-extension (if any) and crlf
\r
3583 // get the position of the linebreak
\r
3584 $chunkend = strpos($buffer,"\r\n") + 2;
\r
3585 $temp = substr($buffer,0,$chunkend);
\r
3586 $chunk_size = hexdec( trim($temp) );
\r
3587 $chunkstart = $chunkend;
\r
3588 while($chunk_size > 0)
\r
3590 $chunkend = strpos($buffer, "\r\n", $chunkstart + $chunk_size);
\r
3592 // just in case we got a broken connection
\r
3593 if($chunkend == false)
\r
3595 $chunk = substr($buffer,$chunkstart);
\r
3596 // append chunk-data to entity-body
\r
3598 $length += strlen($chunk);
\r
3602 // read chunk-data and crlf
\r
3603 $chunk = substr($buffer,$chunkstart,$chunkend-$chunkstart);
\r
3604 // append chunk-data to entity-body
\r
3606 // length := length + chunk-size
\r
3607 $length += strlen($chunk);
\r
3608 // read chunk-size and crlf
\r
3609 $chunkstart = $chunkend + 2;
\r
3611 $chunkend = strpos($buffer,"\r\n",$chunkstart)+2;
\r
3612 if($chunkend == false)
\r
3614 break; //just in case we got a broken connection
\r
3616 $temp = substr($buffer,$chunkstart,$chunkend-$chunkstart);
\r
3617 $chunk_size = hexdec( trim($temp) );
\r
3618 $chunkstart = $chunkend;
\r
3624 * xml charset encoding guessing helper function.
\r
3625 * Tries to determine the charset encoding of an XML chunk received over HTTP.
\r
3626 * NB: according to the spec (RFC 3023), if text/xml content-type is received over HTTP without a content-type,
\r
3627 * we SHOULD assume it is strictly US-ASCII. But we try to be more tolerant of unconforming (legacy?) clients/servers,
\r
3628 * which will be most probably using UTF-8 anyway...
\r
3630 * @param string $httpheaders the http Content-type header
\r
3631 * @param string $xmlchunk xml content buffer
\r
3632 * @param string $encoding_prefs comma separated list of character encodings to be used as default (when mb extension is enabled)
\r
3634 * @todo explore usage of mb_http_input(): does it detect http headers + post data? if so, use it instead of hand-detection!!!
\r
3636 function guess_encoding($httpheader='', $xmlchunk='', $encoding_prefs=null)
\r
3638 // discussion: see http://www.yale.edu/pclt/encoding/
\r
3639 // 1 - test if encoding is specified in HTTP HEADERS
\r
3642 // LWS: (\13\10)?( |\t)+
\r
3643 // token: (any char but excluded stuff)+
\r
3644 // quoted string: " (any char but double quotes and cointrol chars)* "
\r
3645 // header: Content-type = ...; charset=value(; ...)*
\r
3646 // where value is of type token, no LWS allowed between 'charset' and value
\r
3647 // Note: we do not check for invalid chars in VALUE:
\r
3648 // this had better be done using pure ereg as below
\r
3649 // Note 2: we might be removing whitespace/tabs that ought to be left in if
\r
3650 // the received charset is a quoted string. But nobody uses such charset names...
\r
3652 /// @todo this test will pass if ANY header has charset specification, not only Content-Type. Fix it?
\r
3653 $matches = array();
\r
3654 if(preg_match('/;\s*charset\s*=([^;]+)/i', $httpheader, $matches))
\r
3656 return strtoupper(trim($matches[1], " \t\""));
\r
3659 // 2 - scan the first bytes of the data for a UTF-16 (or other) BOM pattern
\r
3660 // (source: http://www.w3.org/TR/2000/REC-xml-20001006)
\r
3661 // NOTE: actually, according to the spec, even if we find the BOM and determine
\r
3662 // an encoding, we should check if there is an encoding specified
\r
3663 // in the xml declaration, and verify if they match.
\r
3664 /// @todo implement check as described above?
\r
3665 /// @todo implement check for first bytes of string even without a BOM? (It sure looks harder than for cases WITH a BOM)
\r
3666 if(preg_match('/^(\x00\x00\xFE\xFF|\xFF\xFE\x00\x00|\x00\x00\xFF\xFE|\xFE\xFF\x00\x00)/', $xmlchunk))
\r
3670 elseif(preg_match('/^(\xFE\xFF|\xFF\xFE)/', $xmlchunk))
\r
3674 elseif(preg_match('/^(\xEF\xBB\xBF)/', $xmlchunk))
\r
3679 // 3 - test if encoding is specified in the xml declaration
\r
3681 // SPACE: (#x20 | #x9 | #xD | #xA)+ === [ \x9\xD\xA]+
\r
3682 // EQ: SPACE?=SPACE? === [ \x9\xD\xA]*=[ \x9\xD\xA]*
\r
3683 if (preg_match('/^<\?xml\s+version\s*=\s*'. "((?:\"[a-zA-Z0-9_.:-]+\")|(?:'[a-zA-Z0-9_.:-]+'))".
\r
3684 '\s+encoding\s*=\s*' . "((?:\"[A-Za-z][A-Za-z0-9._-]*\")|(?:'[A-Za-z][A-Za-z0-9._-]*'))/",
\r
3685 $xmlchunk, $matches))
\r
3687 return strtoupper(substr($matches[2], 1, -1));
\r
3690 // 4 - if mbstring is available, let it do the guesswork
\r
3691 // NB: we favour finding an encoding that is compatible with what we can process
\r
3692 if(extension_loaded('mbstring'))
\r
3694 if($encoding_prefs)
\r
3696 $enc = mb_detect_encoding($xmlchunk, $encoding_prefs);
\r
3700 $enc = mb_detect_encoding($xmlchunk);
\r
3702 // NB: mb_detect likes to call it ascii, xml parser likes to call it US_ASCII...
\r
3703 // IANA also likes better US-ASCII, so go with it
\r
3704 if($enc == 'ASCII')
\r
3706 $enc = 'US-'.$enc;
\r
3712 // no encoding specified: as per HTTP1.1 assume it is iso-8859-1?
\r
3713 // Both RFC 2616 (HTTP 1.1) and 1945 (HTTP 1.0) clearly state that for text/xxx content types
\r
3714 // this should be the standard. And we should be getting text/xml as request and response.
\r
3715 // BUT we have to be backward compatible with the lib, which always used UTF-8 as default...
\r
3716 return $GLOBALS['xmlrpc_defencoding'];
\r
3721 * Checks if a given charset encoding is present in a list of encodings or
\r
3722 * if it is a valid subset of any encoding in the list
\r
3723 * @param string $encoding charset to be tested
\r
3724 * @param mixed $validlist comma separated list of valid charsets (or array of charsets)
\r
3726 function is_valid_charset($encoding, $validlist)
\r
3728 $charset_supersets = array(
\r
3729 'US-ASCII' => array ('ISO-8859-1', 'ISO-8859-2', 'ISO-8859-3', 'ISO-8859-4',
\r
3730 'ISO-8859-5', 'ISO-8859-6', 'ISO-8859-7', 'ISO-8859-8',
\r
3731 'ISO-8859-9', 'ISO-8859-10', 'ISO-8859-11', 'ISO-8859-12',
\r
3732 'ISO-8859-13', 'ISO-8859-14', 'ISO-8859-15', 'UTF-8',
\r
3733 'EUC-JP', 'EUC-', 'EUC-KR', 'EUC-CN')
\r
3735 if (is_string($validlist))
\r
3736 $validlist = explode(',', $validlist);
\r
3737 if (@in_array(strtoupper($encoding), $validlist))
\r
3741 if (array_key_exists($encoding, $charset_supersets))
\r
3742 foreach ($validlist as $allowed)
\r
3743 if (in_array($allowed, $charset_supersets[$encoding]))
\r
git://git.onelab.eu / plcapi.git / blob