lib/xmlrpc.inc

   1 <?php\r
   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
   5 \r
   6 // Copyright (c) 1999,2000,2002 Edd Dumbill.\r
   7 // All rights reserved.\r
   8 //\r
   9 // Redistribution and use in source and binary forms, with or without\r
  10 // modification, are permitted provided that the following conditions\r
  11 // are met:\r
  12 //\r
  13 //    * Redistributions of source code must retain the above copyright\r
  14 //      notice, this list of conditions and the following disclaimer.\r
  15 //\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
  20 //\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
  24 //\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
  37 \r
  38         if(!function_exists('xml_parser_create'))\r
  39         {\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
  43                 {\r
  44                         dl('xml.so');\r
  45                 }\r
  46         }\r
  47 \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
  61 \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
  72         );\r
  73 \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
  94         );\r
  95 \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
  99 \r
 100         // Not in use anymore since 2.0. Shall we remove it?\r
 101         /// @deprecated\r
 102         $GLOBALS['xmlEntities']=array(\r
 103                 'amp'  => '&',\r
 104                 'quot' => '"',\r
 105                 'lt'   => '<',\r
 106                 'gt'   => '>',\r
 107                 'apos' => "'"\r
 108         );\r
 109 \r
 110         // tables used for transcoding different charsets into us-ascii xml\r
 111 \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
 116         {\r
 117                 $GLOBALS['xml_iso88591_Entities']['in'][] = chr($i);\r
 118                 $GLOBALS['xml_iso88591_Entities']['out'][] = '&#'.$i.';';\r
 119         }\r
 120         for ($i = 160; $i < 256; $i++)\r
 121         {\r
 122                 $GLOBALS['xml_iso88591_Entities']['in'][] = chr($i);\r
 123                 $GLOBALS['xml_iso88591_Entities']['out'][] = '&#'.$i.';';\r
 124         }\r
 125 \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
 129   /*\r
 130         $GLOBALS['xml_cp1252_Entities']=array();\r
 131         for ($i = 128; $i < 160; $i++)\r
 132         {\r
 133                 $GLOBALS['xml_cp1252_Entities']['in'][] = chr($i);\r
 134         }\r
 135         $GLOBALS['xml_cp1252_Entities']['out'] = array(\r
 136                 '&#x20AC;', '?',        '&#x201A;', '&#x0192;',\r
 137                 '&#x201E;', '&#x2026;', '&#x2020;', '&#x2021;',\r
 138                 '&#x02C6;', '&#x2030;', '&#x0160;', '&#x2039;',\r
 139                 '&#x0152;', '?',        '&#x017D;', '?',\r
 140                 '?',        '&#x2018;', '&#x2019;', '&#x201C;',\r
 141                 '&#x201D;', '&#x2022;', '&#x2013;', '&#x2014;',\r
 142                 '&#x02DC;', '&#x2122;', '&#x0161;', '&#x203A;',\r
 143                 '&#x0153;', '?',        '&#x017E;', '&#x0178;'\r
 144         );\r
 145   */\r
 146 \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
 152         'http_error'=>5,\r
 153         'no_data'=>6,\r
 154         'no_ssl'=>7,\r
 155         'curl_fail'=>8,\r
 156         'invalid_request'=>15,\r
 157         'no_curl'=>16,\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
 166 \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
 172         );\r
 173 \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
 193 \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
 199         );\r
 200 \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
 205 \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
 210 \r
 211         $GLOBALS['xmlrpcName']='XML-RPC for PHP';\r
 212         $GLOBALS['xmlrpcVersion']='3.0.0.beta';\r
 213 \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
 218 \r
 219         // formulate backslashes for escaping regexp\r
 220         // Not in use anymore since 2.0. Shall we remove it?\r
 221         /// @deprecated\r
 222         $GLOBALS['xmlrpc_backslash']=chr(92).chr(92);\r
 223 \r
 224         // set to TRUE to enable correct decoding of <NIL/> and <EX:NIL/> values\r
 225         $GLOBALS['xmlrpc_null_extension']=false;\r
 226 \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
 229 \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
 242 \r
 243         /**\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
 253         *\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
 256         */\r
 257         function xmlrpc_encode_entitites($data, $src_encoding='', $dest_encoding='')\r
 258         {\r
 259                 if ($src_encoding == '')\r
 260                 {\r
 261                         // lame, but we know no better...\r
 262                         $src_encoding = $GLOBALS['xmlrpc_internalencoding'];\r
 263                 }\r
 264 \r
 265                 switch(strtoupper($src_encoding.'_'.$dest_encoding))\r
 266                 {\r
 267                         case 'ISO-8859-1_':\r
 268                         case 'ISO-8859-1_US-ASCII':\r
 269                                 $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&amp;', '&quot;', '&apos;', '&lt;', '&gt;'), $data);\r
 270                                 $escaped_data = str_replace($GLOBALS['xml_iso88591_Entities']['in'], $GLOBALS['xml_iso88591_Entities']['out'], $escaped_data);\r
 271                                 break;\r
 272                         case 'ISO-8859-1_UTF-8':\r
 273                                 $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&amp;', '&quot;', '&apos;', '&lt;', '&gt;'), $data);\r
 274                                 $escaped_data = utf8_encode($escaped_data);\r
 275                                 break;\r
 276                         case 'ISO-8859-1_ISO-8859-1':\r
 277                         case 'US-ASCII_US-ASCII':\r
 278                         case 'US-ASCII_UTF-8':\r
 279                         case 'US-ASCII_':\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('&amp;', '&quot;', '&apos;', '&lt;', '&gt;'), $data);\r
 284                                 break;\r
 285                         case 'UTF-8_':\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
 294         {\r
 295                 $ch = $data[$nn];\r
 296                 $ii = ord($ch);\r
 297                 //1 7 0bbbbbbb (127)\r
 298                 if ($ii < 128)\r
 299                 {\r
 300                         /// @todo shall we replace this with a (supposedly) faster str_replace?\r
 301                         switch($ii){\r
 302                                 case 34:\r
 303                                         $escaped_data .= '&quot;';\r
 304                                         break;\r
 305                                 case 38:\r
 306                                         $escaped_data .= '&amp;';\r
 307                                         break;\r
 308                                 case 39:\r
 309                                         $escaped_data .= '&apos;';\r
 310                                         break;\r
 311                                 case 60:\r
 312                                         $escaped_data .= '&lt;';\r
 313                                         break;\r
 314                                 case 62:\r
 315                                         $escaped_data .= '&gt;';\r
 316                                         break;\r
 317                                 default:\r
 318                                         $escaped_data .= $ch;\r
 319                         } // switch\r
 320                 }\r
 321                 //2 11 110bbbbb 10bbbbbb (2047)\r
 322                 else if ($ii>>5 == 6)\r
 323                 {\r
 324                         $b1 = ($ii & 31);\r
 325                         $ii = ord($data[$nn+1]);\r
 326                         $b2 = ($ii & 63);\r
 327                         $ii = ($b1 * 64) + $b2;\r
 328                         $ent = sprintf ('&#%d;', $ii);\r
 329                         $escaped_data .= $ent;\r
 330                         $nn += 1;\r
 331                 }\r
 332                 //3 16 1110bbbb 10bbbbbb 10bbbbbb\r
 333                 else if ($ii>>4 == 14)\r
 334                 {\r
 335                         $b1 = ($ii & 15);\r
 336                         $ii = ord($data[$nn+1]);\r
 337                         $b2 = ($ii & 63);\r
 338                         $ii = ord($data[$nn+2]);\r
 339                         $b3 = ($ii & 63);\r
 340                         $ii = ((($b1 * 64) + $b2) * 64) + $b3;\r
 341                         $ent = sprintf ('&#%d;', $ii);\r
 342                         $escaped_data .= $ent;\r
 343                         $nn += 2;\r
 344                 }\r
 345                 //4 21 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb\r
 346                 else if ($ii>>3 == 30)\r
 347                 {\r
 348                         $b1 = ($ii & 7);\r
 349                         $ii = ord($data[$nn+1]);\r
 350                         $b2 = ($ii & 63);\r
 351                         $ii = ord($data[$nn+2]);\r
 352                         $b3 = ($ii & 63);\r
 353                         $ii = ord($data[$nn+3]);\r
 354                         $b4 = ($ii & 63);\r
 355                         $ii = ((((($b1 * 64) + $b2) * 64) + $b3) * 64) + $b4;\r
 356                         $ent = sprintf ('&#%d;', $ii);\r
 357                         $escaped_data .= $ent;\r
 358                         $nn += 3;\r
 359                 }\r
 360         }\r
 361                                 break;\r
 362 /*\r
 363                         case 'CP1252_':\r
 364                         case 'CP1252_US-ASCII':\r
 365                                 $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&amp;', '&quot;', '&apos;', '&lt;', '&gt;'), $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
 368                                 break;\r
 369                         case 'CP1252_UTF-8':\r
 370                                 $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&amp;', '&quot;', '&apos;', '&lt;', '&gt;'), $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
 374                                 break;\r
 375                         case 'CP1252_ISO-8859-1':\r
 376                                 $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&amp;', '&quot;', '&apos;', '&lt;', '&gt;'), $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
 379                                 break;\r
 380 */\r
 381                         default:\r
 382                                 $escaped_data = '';\r
 383                                 error_log("Converting from $src_encoding to $dest_encoding: not supported...");\r
 384                 }\r
 385                 return $escaped_data;\r
 386         }\r
 387 \r
 388         /// xml parser handler function for opening element tags\r
 389         function xmlrpc_se($parser, $name, $attrs, $accept_single_vals=false)\r
 390         {\r
 391                 // if invalid xmlrpc already detected, skip all processing\r
 392                 if ($GLOBALS['_xh']['isf'] < 2)\r
 393                 {\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
 399                         {\r
 400                                 if ($name != 'METHODRESPONSE' && $name != 'METHODCALL' && (\r
 401                                         $name != 'VALUE' && !$accept_single_vals))\r
 402                                 {\r
 403                                         $GLOBALS['_xh']['isf'] = 2;\r
 404                                         $GLOBALS['_xh']['isf_reason'] = 'missing top level xmlrpc element';\r
 405                                         return;\r
 406                                 }\r
 407                                 else\r
 408                                 {\r
 409                                         $GLOBALS['_xh']['rt'] = strtolower($name);\r
 410                                 }\r
 411                         }\r
 412                         else\r
 413                         {\r
 414                                 // not top level element: see if parent is OK\r
 415                                 $parent = end($GLOBALS['_xh']['stack']);\r
 416                                 if (!array_key_exists($name, $GLOBALS['xmlrpc_valid_parents']) || !in_array($parent, $GLOBALS['xmlrpc_valid_parents'][$name]))\r
 417                                 {\r
 418                                         $GLOBALS['_xh']['isf'] = 2;\r
 419                                         $GLOBALS['_xh']['isf_reason'] = "xmlrpc element $name cannot be child of $parent";\r
 420                                         return;\r
 421                                 }\r
 422                         }\r
 423 \r
 424                         switch($name)\r
 425                         {\r
 426                                 // optimize for speed switch cases: most common cases first\r
 427                                 case 'VALUE':\r
 428                                         /// @todo we could check for 2 VALUE elements inside a MEMBER or PARAM element\r
 429                                         $GLOBALS['_xh']['vt']='value'; // indicator: no value found yet\r
 430                                         $GLOBALS['_xh']['ac']='';\r
 431                                         $GLOBALS['_xh']['lv']=1;\r
 432                                         $GLOBALS['_xh']['php_class']=null;\r
 433                                         break;\r
 434                                 case 'I4':\r
 435                                 case 'INT':\r
 436                                 case 'STRING':\r
 437                                 case 'BOOLEAN':\r
 438                                 case 'DOUBLE':\r
 439                                 case 'DATETIME.ISO8601':\r
 440                                 case 'BASE64':\r
 441                                         if ($GLOBALS['_xh']['vt']!='value')\r
 442                                         {\r
 443                                                 //two data elements inside a value: an error occurred!\r
 444                                                 $GLOBALS['_xh']['isf'] = 2;\r
 445                                                 $GLOBALS['_xh']['isf_reason'] = "$name element following a {$GLOBALS['_xh']['vt']} element inside a single value";\r
 446                                                 return;\r
 447                                         }\r
 448                                         $GLOBALS['_xh']['ac']=''; // reset the accumulator\r
 449                                         break;\r
 450                                 case 'STRUCT':\r
 451                                 case 'ARRAY':\r
 452                                         if ($GLOBALS['_xh']['vt']!='value')\r
 453                                         {\r
 454                                                 //two data elements inside a value: an error occurred!\r
 455                                                 $GLOBALS['_xh']['isf'] = 2;\r
 456                                                 $GLOBALS['_xh']['isf_reason'] = "$name element following a {$GLOBALS['_xh']['vt']} element inside a single value";\r
 457                                                 return;\r
 458                                         }\r
 459                                         // create an empty array to hold child values, and push it onto appropriate stack\r
 460                                         $cur_val = array();\r
 461                                         $cur_val['values'] = array();\r
 462                                         $cur_val['type'] = $name;\r
 463                                         // check for out-of-band information to rebuild php objs\r
 464                                         // and in case it is found, save it\r
 465                                         if (@isset($attrs['PHP_CLASS']))\r
 466                                         {\r
 467                                                 $cur_val['php_class'] = $attrs['PHP_CLASS'];\r
 468                                         }\r
 469                                         $GLOBALS['_xh']['valuestack'][] = $cur_val;\r
 470                                         $GLOBALS['_xh']['vt']='data'; // be prepared for a data element next\r
 471                                         break;\r
 472                                 case 'DATA':\r
 473                                         if ($GLOBALS['_xh']['vt']!='data')\r
 474                                         {\r
 475                                                 //two data elements inside a value: an error occurred!\r
 476                                                 $GLOBALS['_xh']['isf'] = 2;\r
 477                                                 $GLOBALS['_xh']['isf_reason'] = "found two data elements inside an array element";\r
 478                                                 return;\r
 479                                         }\r
 480                                 case 'METHODCALL':\r
 481                                 case 'METHODRESPONSE':\r
 482                                 case 'PARAMS':\r
 483                                         // valid elements that add little to processing\r
 484                                         break;\r
 485                                 case 'METHODNAME':\r
 486                                 case 'NAME':\r
 487                                         /// @todo we could check for 2 NAME elements inside a MEMBER element\r
 488                                         $GLOBALS['_xh']['ac']='';\r
 489                                         break;\r
 490                                 case 'FAULT':\r
 491                                         $GLOBALS['_xh']['isf']=1;\r
 492                                         break;\r
 493                                 case 'MEMBER':\r
 494                                         $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
 495                                         //$GLOBALS['_xh']['ac']='';\r
 496                                         // Drop trough intentionally\r
 497                                 case 'PARAM':\r
 498                                         // clear value type, so we can check later if no value has been passed for this param/member\r
 499                                         $GLOBALS['_xh']['vt']=null;\r
 500                                         break;\r
 501                                 case 'NIL':\r
 502                                 case 'EX:NIL':\r
 503                                         if ($GLOBALS['xmlrpc_null_extension'])\r
 504                                         {\r
 505                                                 if ($GLOBALS['_xh']['vt']!='value')\r
 506                                                 {\r
 507                                                         //two data elements inside a value: an error occurred!\r
 508                                                         $GLOBALS['_xh']['isf'] = 2;\r
 509                                                         $GLOBALS['_xh']['isf_reason'] = "$name element following a {$GLOBALS['_xh']['vt']} element inside a single value";\r
 510                                                         return;\r
 511                                                 }\r
 512                                                 $GLOBALS['_xh']['ac']=''; // reset the accumulator\r
 513                                                 break;\r
 514                                         }\r
 515                                         // we do not support the <NIL/> extension, so\r
 516                                         // drop through intentionally\r
 517                                 default:\r
 518                                         /// INVALID ELEMENT: RAISE ISF so that it is later recognized!!!\r
 519                                         $GLOBALS['_xh']['isf'] = 2;\r
 520                                         $GLOBALS['_xh']['isf_reason'] = "found not-xmlrpc xml element $name";\r
 521                                         break;\r
 522                         }\r
 523 \r
 524                         // Save current element name to stack, to validate nesting\r
 525                         $GLOBALS['_xh']['stack'][] = $name;\r
 526 \r
 527                         /// @todo optimization creep: move this inside the big switch() above\r
 528                         if($name!='VALUE')\r
 529                         {\r
 530                                 $GLOBALS['_xh']['lv']=0;\r
 531                         }\r
 532                 }\r
 533         }\r
 534 \r
 535         /// Used in decoding xml chunks that might represent single xmlrpc values\r
 536         function xmlrpc_se_any($parser, $name, $attrs)\r
 537         {\r
 538                 xmlrpc_se($parser, $name, $attrs, true);\r
 539         }\r
 540 \r
 541         /// xml parser handler function for close element tags\r
 542         function xmlrpc_ee($parser, $name, $rebuild_xmlrpcvals = true)\r
 543         {\r
 544                 if ($GLOBALS['_xh']['isf'] < 2)\r
 545                 {\r
 546                         // push this element name from stack\r
 547                         // NB: if XML validates, correct opening/closing is guaranteed and\r
 548                         // we do not have to check for $name == $curr_elem.\r
 549                         // we also checked for proper nesting at start of elements...\r
 550                         $curr_elem = array_pop($GLOBALS['_xh']['stack']);\r
 551 \r
 552                         switch($name)\r
 553                         {\r
 554                                 case 'VALUE':\r
 555                                         // This if() detects if no scalar was inside <VALUE></VALUE>\r
 556                                         if ($GLOBALS['_xh']['vt']=='value')\r
 557                                         {\r
 558                                                 $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac'];\r
 559                                                 $GLOBALS['_xh']['vt']=$GLOBALS['xmlrpcString'];\r
 560                                         }\r
 561 \r
 562                                         if ($rebuild_xmlrpcvals)\r
 563                                         {\r
 564                                                 // build the xmlrpc val out of the data received, and substitute it\r
 565                                                 $temp = new xmlrpcval($GLOBALS['_xh']['value'], $GLOBALS['_xh']['vt']);\r
 566                                                 // in case we got info about underlying php class, save it\r
 567                                                 // in the object we're rebuilding\r
 568                                                 if (isset($GLOBALS['_xh']['php_class']))\r
 569                                                         $temp->_php_class = $GLOBALS['_xh']['php_class'];\r
 570                                                 // check if we are inside an array or struct:\r
 571                                                 // if value just built is inside an array, let's move it into array on the stack\r
 572                                                 $vscount = count($GLOBALS['_xh']['valuestack']);\r
 573                                                 if ($vscount && $GLOBALS['_xh']['valuestack'][$vscount-1]['type']=='ARRAY')\r
 574                                                 {\r
 575                                                         $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][] = $temp;\r
 576                                                 }\r
 577                                                 else\r
 578                                                 {\r
 579                                                         $GLOBALS['_xh']['value'] = $temp;\r
 580                                                 }\r
 581                                         }\r
 582                                         else\r
 583                                         {\r
 584                                                 /// @todo this needs to treat correctly php-serialized objects,\r
 585                                                 /// since std deserializing is done by php_xmlrpc_decode,\r
 586                                                 /// which we will not be calling...\r
 587                                                 if (isset($GLOBALS['_xh']['php_class']))\r
 588                                                 {\r
 589                                                 }\r
 590 \r
 591                                                 // check if we are inside an array or struct:\r
 592                                                 // if value just built is inside an array, let's move it into array on the stack\r
 593                                                 $vscount = count($GLOBALS['_xh']['valuestack']);\r
 594                                                 if ($vscount && $GLOBALS['_xh']['valuestack'][$vscount-1]['type']=='ARRAY')\r
 595                                                 {\r
 596                                                         $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][] = $GLOBALS['_xh']['value'];\r
 597                                                 }\r
 598                                         }\r
 599                                         break;\r
 600                                 case 'BOOLEAN':\r
 601                                 case 'I4':\r
 602                                 case 'INT':\r
 603                                 case 'STRING':\r
 604                                 case 'DOUBLE':\r
 605                                 case 'DATETIME.ISO8601':\r
 606                                 case 'BASE64':\r
 607                                         $GLOBALS['_xh']['vt']=strtolower($name);\r
 608                                         /// @todo: optimization creep - remove the if/elseif cycle below\r
 609                                         /// since the case() in which we are already did that\r
 610                                         if ($name=='STRING')\r
 611                                         {\r
 612                                                 $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac'];\r
 613                                         }\r
 614                                         elseif ($name=='DATETIME.ISO8601')\r
 615                                         {\r
 616                                                 if (!preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $GLOBALS['_xh']['ac']))\r
 617                                                 {\r
 618                                                         error_log('XML-RPC: invalid value received in DATETIME: '.$GLOBALS['_xh']['ac']);\r
 619                                                 }\r
 620                                                 $GLOBALS['_xh']['vt']=$GLOBALS['xmlrpcDateTime'];\r
 621                                                 $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac'];\r
 622                                         }\r
 623                                         elseif ($name=='BASE64')\r
 624                                         {\r
 625                                                 /// @todo check for failure of base64 decoding / catch warnings\r
 626                                                 $GLOBALS['_xh']['value']=base64_decode($GLOBALS['_xh']['ac']);\r
 627                                         }\r
 628                                         elseif ($name=='BOOLEAN')\r
 629                                         {\r
 630                                                 // special case here: we translate boolean 1 or 0 into PHP\r
 631                                                 // constants true or false.\r
 632                                                 // Strings 'true' and 'false' are accepted, even though the\r
 633                                                 // spec never mentions them (see eg. Blogger api docs)\r
 634                                                 // NB: this simple checks helps a lot sanitizing input, ie no\r
 635                                                 // security problems around here\r
 636                                                 if ($GLOBALS['_xh']['ac']=='1' || strcasecmp($GLOBALS['_xh']['ac'], 'true') == 0)\r
 637                                                 {\r
 638                                                         $GLOBALS['_xh']['value']=true;\r
 639                                                 }\r
 640                                                 else\r
 641                                                 {\r
 642                                                         // log if receiveing something strange, even though we set the value to false anyway\r
 643                                                         if ($GLOBALS['_xh']['ac']!='0' && strcasecmp($GLOBALS['_xh']['ac'], 'false') != 0)\r
 644                                                                 error_log('XML-RPC: invalid value received in BOOLEAN: '.$GLOBALS['_xh']['ac']);\r
 645                                                         $GLOBALS['_xh']['value']=false;\r
 646                                                 }\r
 647                                         }\r
 648                                         elseif ($name=='DOUBLE')\r
 649                                         {\r
 650                                                 // we have a DOUBLE\r
 651                                                 // we must check that only 0123456789-.<space> are characters here\r
 652                                                 // NOTE: regexp could be much stricter than this...\r
 653                                                 if (!preg_match('/^[+-eE0123456789 \t.]+$/', $GLOBALS['_xh']['ac']))\r
 654                                                 {\r
 655                                                         /// @todo: find a better way of throwing an error than this!\r
 656                                                         error_log('XML-RPC: non numeric value received in DOUBLE: '.$GLOBALS['_xh']['ac']);\r
 657                                                         $GLOBALS['_xh']['value']='ERROR_NON_NUMERIC_FOUND';\r
 658                                                 }\r
 659                                                 else\r
 660                                                 {\r
 661                                                         // it's ok, add it on\r
 662                                                         $GLOBALS['_xh']['value']=(double)$GLOBALS['_xh']['ac'];\r
 663                                                 }\r
 664                                         }\r
 665                                         else\r
 666                                         {\r
 667                                                 // we have an I4/INT\r
 668                                                 // we must check that only 0123456789-<space> are characters here\r
 669                                                 if (!preg_match('/^[+-]?[0123456789 \t]+$/', $GLOBALS['_xh']['ac']))\r
 670                                                 {\r
 671                                                         /// @todo find a better way of throwing an error than this!\r
 672                                                         error_log('XML-RPC: non numeric value received in INT: '.$GLOBALS['_xh']['ac']);\r
 673                                                         $GLOBALS['_xh']['value']='ERROR_NON_NUMERIC_FOUND';\r
 674                                                 }\r
 675                                                 else\r
 676                                                 {\r
 677                                                         // it's ok, add it on\r
 678                                                         $GLOBALS['_xh']['value']=(int)$GLOBALS['_xh']['ac'];\r
 679                                                 }\r
 680                                         }\r
 681                                         //$GLOBALS['_xh']['ac']=''; // is this necessary?\r
 682                                         $GLOBALS['_xh']['lv']=3; // indicate we've found a value\r
 683                                         break;\r
 684                                 case 'NAME':\r
 685                                         $GLOBALS['_xh']['valuestack'][count($GLOBALS['_xh']['valuestack'])-1]['name'] = $GLOBALS['_xh']['ac'];\r
 686                                         break;\r
 687                                 case 'MEMBER':\r
 688                                         //$GLOBALS['_xh']['ac']=''; // is this necessary?\r
 689                                         // add to array in the stack the last element built,\r
 690                                         // unless no VALUE was found\r
 691                                         if ($GLOBALS['_xh']['vt'])\r
 692                                         {\r
 693                                                 $vscount = count($GLOBALS['_xh']['valuestack']);\r
 694                                                 $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][$GLOBALS['_xh']['valuestack'][$vscount-1]['name']] = $GLOBALS['_xh']['value'];\r
 695                                         } else\r
 696                                                 error_log('XML-RPC: missing VALUE inside STRUCT in received xml');\r
 697                                         break;\r
 698                                 case 'DATA':\r
 699                                         //$GLOBALS['_xh']['ac']=''; // is this necessary?\r
 700                                         $GLOBALS['_xh']['vt']=null; // reset this to check for 2 data elements in a row - even if they're empty\r
 701                                         break;\r
 702                                 case 'STRUCT':\r
 703                                 case 'ARRAY':\r
 704                                         // fetch out of stack array of values, and promote it to current value\r
 705                                         $curr_val = array_pop($GLOBALS['_xh']['valuestack']);\r
 706                                         $GLOBALS['_xh']['value'] = $curr_val['values'];\r
 707                                         $GLOBALS['_xh']['vt']=strtolower($name);\r
 708                                         if (isset($curr_val['php_class']))\r
 709                                         {\r
 710                                                 $GLOBALS['_xh']['php_class'] = $curr_val['php_class'];\r
 711                                         }\r
 712                                         break;\r
 713                                 case 'PARAM':\r
 714                                         // add to array of params the current value,\r
 715                                         // unless no VALUE was found\r
 716                                         if ($GLOBALS['_xh']['vt'])\r
 717                                         {\r
 718                                                 $GLOBALS['_xh']['params'][]=$GLOBALS['_xh']['value'];\r
 719                                                 $GLOBALS['_xh']['pt'][]=$GLOBALS['_xh']['vt'];\r
 720                                         }\r
 721                                         else\r
 722                                                 error_log('XML-RPC: missing VALUE inside PARAM in received xml');\r
 723                                         break;\r
 724                                 case 'METHODNAME':\r
 725                                         $GLOBALS['_xh']['method']=preg_replace('/^[\n\r\t ]+/', '', $GLOBALS['_xh']['ac']);\r
 726                                         break;\r
 727                                 case 'NIL':\r
 728                                 case 'EX:NIL':\r
 729                                         if ($GLOBALS['xmlrpc_null_extension'])\r
 730                                         {\r
 731                                                 $GLOBALS['_xh']['vt']='null';\r
 732                                                 $GLOBALS['_xh']['value']=null;\r
 733                                                 $GLOBALS['_xh']['lv']=3;\r
 734                                                 break;\r
 735                                         }\r
 736                                         // drop through intentionally if nil extension not enabled\r
 737                                 case 'PARAMS':\r
 738                                 case 'FAULT':\r
 739                                 case 'METHODCALL':\r
 740                                 case 'METHORESPONSE':\r
 741                                         break;\r
 742                                 default:\r
 743                                         // End of INVALID ELEMENT!\r
 744                                         // shall we add an assert here for unreachable code???\r
 745                                         break;\r
 746                         }\r
 747                 }\r
 748         }\r
 749 \r
 750         /// Used in decoding xmlrpc requests/responses without rebuilding xmlrpc values\r
 751         function xmlrpc_ee_fast($parser, $name)\r
 752         {\r
 753                 xmlrpc_ee($parser, $name, false);\r
 754         }\r
 755 \r
 756         /// xml parser handler function for character data\r
 757         function xmlrpc_cd($parser, $data)\r
 758         {\r
 759                 // skip processing if xml fault already detected\r
 760                 if ($GLOBALS['_xh']['isf'] < 2)\r
 761                 {\r
 762                         // "lookforvalue==3" means that we've found an entire value\r
 763                         // and should discard any further character data\r
 764                         if($GLOBALS['_xh']['lv']!=3)\r
 765                         {\r
 766                                 // G. Giunta 2006-08-23: useless change of 'lv' from 1 to 2\r
 767                                 //if($GLOBALS['_xh']['lv']==1)\r
 768                                 //{\r
 769                                         // if we've found text and we're just in a <value> then\r
 770                                         // say we've found a value\r
 771                                         //$GLOBALS['_xh']['lv']=2;\r
 772                                 //}\r
 773                                 // we always initialize the accumulator before starting parsing, anyway...\r
 774                                 //if(!@isset($GLOBALS['_xh']['ac']))\r
 775                                 //{\r
 776                                 //      $GLOBALS['_xh']['ac'] = '';\r
 777                                 //}\r
 778                                 $GLOBALS['_xh']['ac'].=$data;\r
 779                         }\r
 780                 }\r
 781         }\r
 782 \r
 783         /// xml parser handler function for 'other stuff', ie. not char data or\r
 784         /// element start/end tag. In fact it only gets called on unknown entities...\r
 785         function xmlrpc_dh($parser, $data)\r
 786         {\r
 787                 // skip processing if xml fault already detected\r
 788                 if ($GLOBALS['_xh']['isf'] < 2)\r
 789                 {\r
 790                         if(substr($data, 0, 1) == '&' && substr($data, -1, 1) == ';')\r
 791                         {\r
 792                                 // G. Giunta 2006-08-25: useless change of 'lv' from 1 to 2\r
 793                                 //if($GLOBALS['_xh']['lv']==1)\r
 794                                 //{\r
 795                                 //      $GLOBALS['_xh']['lv']=2;\r
 796                                 //}\r
 797                                 $GLOBALS['_xh']['ac'].=$data;\r
 798                         }\r
 799                 }\r
 800                 return true;\r
 801         }\r
 802 \r
 803         class xmlrpc_client\r
 804         {\r
 805                 var $path;\r
 806                 var $server;\r
 807                 var $port=0;\r
 808                 var $method='http';\r
 809                 var $errno;\r
 810                 var $errstr;\r
 811                 var $debug=0;\r
 812                 var $username='';\r
 813                 var $password='';\r
 814                 var $authtype=1;\r
 815                 var $cert='';\r
 816                 var $certpass='';\r
 817                 var $cacert='';\r
 818                 var $cacertdir='';\r
 819                 var $key='';\r
 820                 var $keypass='';\r
 821                 var $verifypeer=true;\r
 822                 var $verifyhost=1;\r
 823                 var $no_multicall=false;\r
 824                 var $proxy='';\r
 825                 var $proxyport=0;\r
 826                 var $proxy_user='';\r
 827                 var $proxy_pass='';\r
 828                 var $proxy_authtype=1;\r
 829                 var $cookies=array();\r
 830                 /**\r
 831                 * List of http compression methods accepted by the client for responses.\r
 832                 * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib\r
 833                 *\r
 834                 * NNB: you can set it to any non-empty array for HTTP11 and HTTPS, since\r
 835                 * in those cases it will be up to CURL to decide the compression methods\r
 836                 * it supports. You might check for the presence of 'zlib' in the output of\r
 837                 * curl_version() to determine wheter compression is supported or not\r
 838                 */\r
 839                 var $accepted_compression = array();\r
 840                 /**\r
 841                 * Name of compression scheme to be used for sending requests.\r
 842                 * Either null, gzip or deflate\r
 843                 */\r
 844                 var $request_compression = '';\r
 845                 /**\r
 846                 * CURL handle: used for keep-alive connections (PHP 4.3.8 up, see:\r
 847                 * http://curl.haxx.se/docs/faq.html#7.3)\r
 848                 */\r
 849                 var $xmlrpc_curl_handle = null;\r
 850                 /// Wheter to use persistent connections for http 1.1 and https\r
 851                 var $keepalive = false;\r
 852                 /// Charset encodings that can be decoded without problems by the client\r
 853                 var $accepted_charset_encodings = array();\r
 854                 /// Charset encoding to be used in serializing request. NULL = use ASCII\r
 855                 var $request_charset_encoding = '';\r
 856                 /**\r
 857                 * Decides the content of xmlrpcresp objects returned by calls to send()\r
 858                 * valid strings are 'xmlrpcvals', 'phpvals' or 'xml'\r
 859                 */\r
 860                 var $return_type = 'xmlrpcvals';\r
 861 \r
 862                 /**\r
 863                 * @param string $path either the complete server URL or the PATH part of the xmlrc server URL, e.g. /xmlrpc/server.php\r
 864                 * @param string $server the server name / ip address\r
 865                 * @param integer $port the port the server is listening on, defaults to 80 or 443 depending on protocol used\r
 866                 * @param string $method the http protocol variant: defaults to 'http', 'https' and 'http11' can be used if CURL is installed\r
 867                 */\r
 868                 function xmlrpc_client($path, $server='', $port='', $method='')\r
 869                 {\r
 870                         // allow user to specify all params in $path\r
 871                         if($server == '' and $port == '' and $method == '')\r
 872                         {\r
 873                                 $parts = parse_url($path);\r
 874                                 $server = $parts['host'];\r
 875                                 $path = isset($parts['path']) ? $parts['path'] : '';\r
 876                                 if(isset($parts['query']))\r
 877                                 {\r
 878                                         $path .= '?'.$parts['query'];\r
 879                                 }\r
 880                                 if(isset($parts['fragment']))\r
 881                                 {\r
 882                                         $path .= '#'.$parts['fragment'];\r
 883                                 }\r
 884                                 if(isset($parts['port']))\r
 885                                 {\r
 886                                         $port = $parts['port'];\r
 887                                 }\r
 888                                 if(isset($parts['scheme']))\r
 889                                 {\r
 890                                         $method = $parts['scheme'];\r
 891                                 }\r
 892                                 if(isset($parts['user']))\r
 893                                 {\r
 894                                         $this->username = $parts['user'];\r
 895                                 }\r
 896                                 if(isset($parts['pass']))\r
 897                                 {\r
 898                                         $this->password = $parts['pass'];\r
 899                                 }\r
 900                         }\r
 901                         if($path == '' || $path[0] != '/')\r
 902                         {\r
 903                                 $this->path='/'.$path;\r
 904                         }\r
 905                         else\r
 906                         {\r
 907                                 $this->path=$path;\r
 908                         }\r
 909                         $this->server=$server;\r
 910                         if($port != '')\r
 911                         {\r
 912                                 $this->port=$port;\r
 913                         }\r
 914                         if($method != '')\r
 915                         {\r
 916                                 $this->method=$method;\r
 917                         }\r
 918 \r
 919                         // if ZLIB is enabled, let the client by default accept compressed responses\r
 920                         if(function_exists('gzinflate') || (\r
 921                                 function_exists('curl_init') && (($info = curl_version()) &&\r
 922                                 ((is_string($info) && strpos($info, 'zlib') !== null) || isset($info['libz_version'])))\r
 923                         ))\r
 924                         {\r
 925                                 $this->accepted_compression = array('gzip', 'deflate');\r
 926                         }\r
 927 \r
 928                         // keepalives: enabled by default ONLY for PHP >= 4.3.8\r
 929                         $this->keepalive = true;\r
 930 \r
 931                         // by default the xml parser can support these 3 charset encodings\r
 932                         $this->accepted_charset_encodings = array('UTF-8', 'ISO-8859-1', 'US-ASCII');\r
 933                 }\r
 934 \r
 935                 /**\r
 936                 * Enables/disables the echoing to screen of the xmlrpc responses received\r
 937                 * @param integer $debug values 0, 1 and 2 are supported (2 = echo sent msg too, before received response)\r
 938                 * @access public\r
 939                 */\r
 940                 function setDebug($in)\r
 941                 {\r
 942                         $this->debug=$in;\r
 943                 }\r
 944 \r
 945                 /**\r
 946                 * Add some http BASIC AUTH credentials, used by the client to authenticate\r
 947                 * @param string $u username\r
 948                 * @param string $p password\r
 949                 * @param integer $t auth type. See curl_setopt man page for supported auth types. Defaults to CURLAUTH_BASIC (basic auth)\r
 950                 * @access public\r
 951                 */\r
 952                 function setCredentials($u, $p, $t=1)\r
 953                 {\r
 954                         $this->username=$u;\r
 955                         $this->password=$p;\r
 956                         $this->authtype=$t;\r
 957                 }\r
 958 \r
 959                 /**\r
 960                 * Add a client-side https certificate\r
 961                 * @param string $cert\r
 962                 * @param string $certpass\r
 963                 * @access public\r
 964                 */\r
 965                 function setCertificate($cert, $certpass)\r
 966                 {\r
 967                         $this->cert = $cert;\r
 968                         $this->certpass = $certpass;\r
 969                 }\r
 970 \r
 971                 /**\r
 972                 * Add a CA certificate to verify server with (see man page about\r
 973                 * CURLOPT_CAINFO for more details\r
 974                 * @param string $cacert certificate file name (or dir holding certificates)\r
 975                 * @param bool $is_dir set to true to indicate cacert is a dir. defaults to false\r
 976                 * @access public\r
 977                 */\r
 978                 function setCaCertificate($cacert, $is_dir=false)\r
 979                 {\r
 980                         if ($is_dir)\r
 981                         {\r
 982                                 $this->cacertdir = $cacert;\r
 983                         }\r
 984                         else\r
 985                         {\r
 986                                 $this->cacert = $cacert;\r
 987                         }\r
 988                 }\r
 989 \r
 990                 /**\r
 991                 * Set attributes for SSL communication: private SSL key\r
 992                 * NB: does not work in older php/curl installs\r
 993                 * Thanks to Daniel Convissor\r
 994                 * @param string $key The name of a file containing a private SSL key\r
 995                 * @param string $keypass The secret password needed to use the private SSL key\r
 996                 * @access public\r
 997                 */\r
 998                 function setKey($key, $keypass)\r
 999                 {\r
1000                         $this->key = $key;\r
1001                         $this->keypass = $keypass;\r
1002                 }\r
1003 \r
1004                 /**\r
1005                 * Set attributes for SSL communication: verify server certificate\r
1006                 * @param bool $i enable/disable verification of peer certificate\r
1007                 * @access public\r
1008                 */\r
1009                 function setSSLVerifyPeer($i)\r
1010                 {\r
1011                         $this->verifypeer = $i;\r
1012                 }\r
1013 \r
1014                 /**\r
1015                 * Set attributes for SSL communication: verify match of server cert w. hostname\r
1016                 * @param int $i\r
1017                 * @access public\r
1018                 */\r
1019                 function setSSLVerifyHost($i)\r
1020                 {\r
1021                         $this->verifyhost = $i;\r
1022                 }\r
1023 \r
1024                 /**\r
1025                 * Set proxy info\r
1026                 * @param string $proxyhost\r
1027                 * @param string $proxyport Defaults to 8080 for HTTP and 443 for HTTPS\r
1028                 * @param string $proxyusername Leave blank if proxy has public access\r
1029                 * @param string $proxypassword Leave blank if proxy has public access\r
1030                 * @param int $proxyauthtype set to constant CURLAUTH_NTLM to use NTLM auth with proxy\r
1031                 * @access public\r
1032                 */\r
1033                 function setProxy($proxyhost, $proxyport, $proxyusername = '', $proxypassword = '', $proxyauthtype = 1)\r
1034                 {\r
1035                         $this->proxy = $proxyhost;\r
1036                         $this->proxyport = $proxyport;\r
1037                         $this->proxy_user = $proxyusername;\r
1038                         $this->proxy_pass = $proxypassword;\r
1039                         $this->proxy_authtype = $proxyauthtype;\r
1040                 }\r
1041 \r
1042                 /**\r
1043                 * Enables/disables reception of compressed xmlrpc responses.\r
1044                 * Note that enabling reception of compressed responses merely adds some standard\r
1045                 * http headers to xmlrpc requests. It is up to the xmlrpc server to return\r
1046                 * compressed responses when receiving such requests.\r
1047                 * @param string $compmethod either 'gzip', 'deflate', 'any' or ''\r
1048                 * @access public\r
1049                 */\r
1050                 function setAcceptedCompression($compmethod)\r
1051                 {\r
1052                         if ($compmethod == 'any')\r
1053                                 $this->accepted_compression = array('gzip', 'deflate');\r
1054                         else\r
1055                                 $this->accepted_compression = array($compmethod);\r
1056                 }\r
1057 \r
1058                 /**\r
1059                 * Enables/disables http compression of xmlrpc request.\r
1060                 * Take care when sending compressed requests: servers might not support them\r
1061                 * (and automatic fallback to uncompressed requests is not yet implemented)\r
1062                 * @param string $compmethod either 'gzip', 'deflate' or ''\r
1063                 * @access public\r
1064                 */\r
1065                 function setRequestCompression($compmethod)\r
1066                 {\r
1067                         $this->request_compression = $compmethod;\r
1068                 }\r
1069 \r
1070                 /**\r
1071                 * Adds a cookie to list of cookies that will be sent to server.\r
1072                 * NB: setting any param but name and value will turn the cookie into a 'version 1' cookie:\r
1073                 * do not do it unless you know what you are doing\r
1074                 * @param string $name\r
1075                 * @param string $value\r
1076                 * @param string $path\r
1077                 * @param string $domain\r
1078                 * @param int $port\r
1079                 * @access public\r
1080                 *\r
1081                 * @todo check correctness of urlencoding cookie value (copied from php way of doing it...)\r
1082                 */\r
1083                 function setCookie($name, $value='', $path='', $domain='', $port=null)\r
1084                 {\r
1085                         $this->cookies[$name]['value'] = urlencode($value);\r
1086                         if ($path || $domain || $port)\r
1087                         {\r
1088                                 $this->cookies[$name]['path'] = $path;\r
1089                                 $this->cookies[$name]['domain'] = $domain;\r
1090                                 $this->cookies[$name]['port'] = $port;\r
1091                                 $this->cookies[$name]['version'] = 1;\r
1092                         }\r
1093                         else\r
1094                         {\r
1095                                 $this->cookies[$name]['version'] = 0;\r
1096                         }\r
1097                 }\r
1098 \r
1099                 /**\r
1100                 * Send an xmlrpc request\r
1101                 * @param mixed $msg The message object, or an array of messages for using multicall, or the complete xml representation of a request\r
1102                 * @param integer $timeout Connection timeout, in seconds, If unspecified, a platform specific timeout will apply\r
1103                 * @param string $method if left unspecified, the http protocol chosen during creation of the object will be used\r
1104                 * @return xmlrpcresp\r
1105                 * @access public\r
1106                 */\r
1107                 function& send($msg, $timeout=0, $method='')\r
1108                 {\r
1109                         // if user deos not specify http protocol, use native method of this client\r
1110                         // (i.e. method set during call to constructor)\r
1111                         if($method == '')\r
1112                         {\r
1113                                 $method = $this->method;\r
1114                         }\r
1115 \r
1116                         if(is_array($msg))\r
1117                         {\r
1118                                 // $msg is an array of xmlrpcmsg's\r
1119                                 $r = $this->multicall($msg, $timeout, $method);\r
1120                                 return $r;\r
1121                         }\r
1122                         elseif(is_string($msg))\r
1123                         {\r
1124                                 $n = new xmlrpcmsg('');\r
1125                                 $n->payload = $msg;\r
1126                                 $msg = $n;\r
1127                         }\r
1128 \r
1129                         // where msg is an xmlrpcmsg\r
1130                         $msg->debug=$this->debug;\r
1131 \r
1132                         if($method == 'https')\r
1133                         {\r
1134                                 $r =& $this->sendPayloadHTTPS(\r
1135                                         $msg,\r
1136                                         $this->server,\r
1137                                         $this->port,\r
1138                                         $timeout,\r
1139                                         $this->username,\r
1140                                         $this->password,\r
1141                                         $this->authtype,\r
1142                                         $this->cert,\r
1143                                         $this->certpass,\r
1144                                         $this->cacert,\r
1145                                         $this->cacertdir,\r
1146                                         $this->proxy,\r
1147                                         $this->proxyport,\r
1148                                         $this->proxy_user,\r
1149                                         $this->proxy_pass,\r
1150                                         $this->proxy_authtype,\r
1151                                         $this->keepalive,\r
1152                                         $this->key,\r
1153                                         $this->keypass\r
1154                                 );\r
1155                         }\r
1156                         elseif($method == 'http11')\r
1157                         {\r
1158                                 $r =& $this->sendPayloadCURL(\r
1159                                         $msg,\r
1160                                         $this->server,\r
1161                                         $this->port,\r
1162                                         $timeout,\r
1163                                         $this->username,\r
1164                                         $this->password,\r
1165                                         $this->authtype,\r
1166                                         null,\r
1167                                         null,\r
1168                                         null,\r
1169                                         null,\r
1170                                         $this->proxy,\r
1171                                         $this->proxyport,\r
1172                                         $this->proxy_user,\r
1173                                         $this->proxy_pass,\r
1174                                         $this->proxy_authtype,\r
1175                                         'http',\r
1176                                         $this->keepalive\r
1177                                 );\r
1178                         }\r
1179                         else\r
1180                         {\r
1181                                 $r =& $this->sendPayloadHTTP10(\r
1182                                         $msg,\r
1183                                         $this->server,\r
1184                                         $this->port,\r
1185                                         $timeout,\r
1186                                         $this->username,\r
1187                                         $this->password,\r
1188                                         $this->authtype,\r
1189                                         $this->proxy,\r
1190                                         $this->proxyport,\r
1191                                         $this->proxy_user,\r
1192                                         $this->proxy_pass,\r
1193                                         $this->proxy_authtype\r
1194                                 );\r
1195                         }\r
1196 \r
1197                         return $r;\r
1198                 }\r
1199 \r
1200                 /**\r
1201                 * @access private\r
1202                 */\r
1203                 function &sendPayloadHTTP10($msg, $server, $port, $timeout=0,\r
1204                         $username='', $password='', $authtype=1, $proxyhost='',\r
1205                         $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1)\r
1206                 {\r
1207                         if($port==0)\r
1208                         {\r
1209                                 $port=80;\r
1210                         }\r
1211 \r
1212                         // Only create the payload if it was not created previously\r
1213                         if(empty($msg->payload))\r
1214                         {\r
1215                                 $msg->createPayload($this->request_charset_encoding);\r
1216                         }\r
1217 \r
1218                         $payload = $msg->payload;\r
1219                         // Deflate request body and set appropriate request headers\r
1220                         if(function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate'))\r
1221                         {\r
1222                                 if($this->request_compression == 'gzip')\r
1223                                 {\r
1224                                         $a = @gzencode($payload);\r
1225                                         if($a)\r
1226                                         {\r
1227                                                 $payload = $a;\r
1228                                                 $encoding_hdr = "Content-Encoding: gzip\r\n";\r
1229                                         }\r
1230                                 }\r
1231                                 else\r
1232                                 {\r
1233                                         $a = @gzcompress($payload);\r
1234                                         if($a)\r
1235                                         {\r
1236                                                 $payload = $a;\r
1237                                                 $encoding_hdr = "Content-Encoding: deflate\r\n";\r
1238                                         }\r
1239                                 }\r
1240                         }\r
1241                         else\r
1242                         {\r
1243                                 $encoding_hdr = '';\r
1244                         }\r
1245 \r
1246                         // thanks to Grant Rauscher <grant7@firstworld.net> for this\r
1247                         $credentials='';\r
1248                         if($username!='')\r
1249                         {\r
1250                                 $credentials='Authorization: Basic ' . base64_encode($username . ':' . $password) . "\r\n";\r
1251                                 if ($authtype != 1)\r
1252                                 {\r
1253                                         error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth is supported with HTTP 1.0');\r
1254                                 }\r
1255                         }\r
1256 \r
1257                         $accepted_encoding = '';\r
1258                         if(is_array($this->accepted_compression) && count($this->accepted_compression))\r
1259                         {\r
1260                                 $accepted_encoding = 'Accept-Encoding: ' . implode(', ', $this->accepted_compression) . "\r\n";\r
1261                         }\r
1262 \r
1263                         $proxy_credentials = '';\r
1264                         if($proxyhost)\r
1265                         {\r
1266                                 if($proxyport == 0)\r
1267                                 {\r
1268                                         $proxyport = 8080;\r
1269                                 }\r
1270                                 $connectserver = $proxyhost;\r
1271                                 $connectport = $proxyport;\r
1272                                 $uri = 'http://'.$server.':'.$port.$this->path;\r
1273                                 if($proxyusername != '')\r
1274                                 {\r
1275                                         if ($proxyauthtype != 1)\r
1276                                         {\r
1277                                                 error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth to proxy is supported with HTTP 1.0');\r
1278                                         }\r
1279                                         $proxy_credentials = 'Proxy-Authorization: Basic ' . base64_encode($proxyusername.':'.$proxypassword) . "\r\n";\r
1280                                 }\r
1281                         }\r
1282                         else\r
1283                         {\r
1284                                 $connectserver = $server;\r
1285                                 $connectport = $port;\r
1286                                 $uri = $this->path;\r
1287                         }\r
1288 \r
1289                         // Cookie generation, as per rfc2965 (version 1 cookies) or\r
1290                         // netscape's rules (version 0 cookies)\r
1291                         $cookieheader='';\r
1292                         if (count($this->cookies))\r
1293                         {\r
1294                                 $version = '';\r
1295                                 foreach ($this->cookies as $name => $cookie)\r
1296                                 {\r
1297                                         if ($cookie['version'])\r
1298                                         {\r
1299                                                 $version = ' $Version="' . $cookie['version'] . '";';\r
1300                                                 $cookieheader .= ' ' . $name . '="' . $cookie['value'] . '";';\r
1301                                                 if ($cookie['path'])\r
1302                                                         $cookieheader .= ' $Path="' . $cookie['path'] . '";';\r
1303                                                 if ($cookie['domain'])\r
1304                                                         $cookieheader .= ' $Domain="' . $cookie['domain'] . '";';\r
1305                                                 if ($cookie['port'])\r
1306                                                         $cookieheader .= ' $Port="' . $cookie['port'] . '";';\r
1307                                         }\r
1308                                         else\r
1309                                         {\r
1310                                                 $cookieheader .= ' ' . $name . '=' . $cookie['value'] . ";";\r
1311                                         }\r
1312                                 }\r
1313                                 $cookieheader = 'Cookie:' . $version . substr($cookieheader, 0, -1) . "\r\n";\r
1314                         }\r
1315 \r
1316                         $op= 'POST ' . $uri. " HTTP/1.0\r\n" .\r
1317                                 'User-Agent: ' . $GLOBALS['xmlrpcName'] . ' ' . $GLOBALS['xmlrpcVersion'] . "\r\n" .\r
1318                                 'Host: '. $server . ':' . $port . "\r\n" .\r
1319                                 $credentials .\r
1320                                 $proxy_credentials .\r
1321                                 $accepted_encoding .\r
1322                                 $encoding_hdr .\r
1323                                 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings) . "\r\n" .\r
1324                                 $cookieheader .\r
1325                                 'Content-Type: ' . $msg->content_type . "\r\nContent-Length: " .\r
1326                                 strlen($payload) . "\r\n\r\n" .\r
1327                                 $payload;\r
1328 \r
1329                         if($this->debug > 1)\r
1330                         {\r
1331                                 print "<PRE>\n---SENDING---\n" . htmlentities($op) . "\n---END---\n</PRE>";\r
1332                                 // let the client see this now in case http times out...\r
1333                                 flush();\r
1334                         }\r
1335 \r
1336                         if($timeout>0)\r
1337                         {\r
1338                                 $fp=@fsockopen($connectserver, $connectport, $this->errno, $this->errstr, $timeout);\r
1339                         }\r
1340                         else\r
1341                         {\r
1342                                 $fp=@fsockopen($connectserver, $connectport, $this->errno, $this->errstr);\r
1343                         }\r
1344                         if($fp)\r
1345                         {\r
1346                                 if($timeout>0 && function_exists('stream_set_timeout'))\r
1347                                 {\r
1348                                         stream_set_timeout($fp, $timeout);\r
1349                                 }\r
1350                         }\r
1351                         else\r
1352                         {\r
1353                                 $this->errstr='Connect error: '.$this->errstr;\r
1354                                 $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $this->errstr . ' (' . $this->errno . ')');\r
1355                                 return $r;\r
1356                         }\r
1357 \r
1358                         if(!fputs($fp, $op, strlen($op)))\r
1359                         {\r
1360                         fclose($fp);\r
1361                                 $this->errstr='Write error';\r
1362                                 $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $this->errstr);\r
1363                                 return $r;\r
1364                         }\r
1365                         else\r
1366                         {\r
1367                                 // reset errno and errstr on succesful socket connection\r
1368                                 $this->errstr = '';\r
1369                         }\r
1370                         // G. Giunta 2005/10/24: close socket before parsing.\r
1371                         // should yeld slightly better execution times, and make easier recursive calls (e.g. to follow http redirects)\r
1372                         $ipd='';\r
1373                         do\r
1374                         {\r
1375                                 // shall we check for $data === FALSE?\r
1376                                 // as per the manual, it signals an error\r
1377                                 $ipd.=fread($fp, 32768);\r
1378                         } while(!feof($fp));\r
1379                         fclose($fp);\r
1380                         $r =& $msg->parseResponse($ipd, false, $this->return_type);\r
1381                         return $r;\r
1382 \r
1383                 }\r
1384 \r
1385                 /**\r
1386                 * @access private\r
1387                 */\r
1388                 function &sendPayloadHTTPS($msg, $server, $port, $timeout=0, $username='',\r
1389                         $password='', $authtype=1, $cert='',$certpass='', $cacert='', $cacertdir='',\r
1390                         $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1,\r
1391                         $keepalive=false, $key='', $keypass='')\r
1392                 {\r
1393                         $r =& $this->sendPayloadCURL($msg, $server, $port, $timeout, $username,\r
1394                                 $password, $authtype, $cert, $certpass, $cacert, $cacertdir, $proxyhost, $proxyport,\r
1395                                 $proxyusername, $proxypassword, $proxyauthtype, 'https', $keepalive, $key, $keypass);\r
1396                         return $r;\r
1397                 }\r
1398 \r
1399                 /**\r
1400                 * Contributed by Justin Miller <justin@voxel.net>\r
1401                 * Requires curl to be built into PHP\r
1402                 * NB: CURL versions before 7.11.10 cannot use proxy to talk to https servers!\r
1403                 * @access private\r
1404                 */\r
1405                 function &sendPayloadCURL($msg, $server, $port, $timeout=0, $username='',\r
1406                         $password='', $authtype=1, $cert='', $certpass='', $cacert='', $cacertdir='',\r
1407                         $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1, $method='https',\r
1408                         $keepalive=false, $key='', $keypass='')\r
1409                 {\r
1410                         if(!function_exists('curl_init'))\r
1411                         {\r
1412                                 $this->errstr='CURL unavailable on this install';\r
1413                                 $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_curl'], $GLOBALS['xmlrpcstr']['no_curl']);\r
1414                                 return $r;\r
1415                         }\r
1416                         if($method == 'https')\r
1417                         {\r
1418                                 if(($info = curl_version()) &&\r
1419                                         ((is_string($info) && strpos($info, 'OpenSSL') === null) || (is_array($info) && !isset($info['ssl_version']))))\r
1420                                 {\r
1421                                         $this->errstr='SSL unavailable on this install';\r
1422                                         $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_ssl'], $GLOBALS['xmlrpcstr']['no_ssl']);\r
1423                                         return $r;\r
1424                                 }\r
1425                         }\r
1426 \r
1427                         if($port == 0)\r
1428                         {\r
1429                                 if($method == 'http')\r
1430                                 {\r
1431                                         $port = 80;\r
1432                                 }\r
1433                                 else\r
1434                                 {\r
1435                                         $port = 443;\r
1436                                 }\r
1437                         }\r
1438 \r
1439                         // Only create the payload if it was not created previously\r
1440                         if(empty($msg->payload))\r
1441                         {\r
1442                                 $msg->createPayload($this->request_charset_encoding);\r
1443                         }\r
1444 \r
1445                         // Deflate request body and set appropriate request headers\r
1446                         $payload = $msg->payload;\r
1447                         if(function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate'))\r
1448                         {\r
1449                                 if($this->request_compression == 'gzip')\r
1450                                 {\r
1451                                         $a = @gzencode($payload);\r
1452                                         if($a)\r
1453                                         {\r
1454                                                 $payload = $a;\r
1455                                                 $encoding_hdr = 'Content-Encoding: gzip';\r
1456                                         }\r
1457                                 }\r
1458                                 else\r
1459                                 {\r
1460                                         $a = @gzcompress($payload);\r
1461                                         if($a)\r
1462                                         {\r
1463                                                 $payload = $a;\r
1464                                                 $encoding_hdr = 'Content-Encoding: deflate';\r
1465                                         }\r
1466                                 }\r
1467                         }\r
1468                         else\r
1469                         {\r
1470                                 $encoding_hdr = '';\r
1471                         }\r
1472 \r
1473                         if($this->debug > 1)\r
1474                         {\r
1475                                 print "<PRE>\n---SENDING---\n" . htmlentities($payload) . "\n---END---\n</PRE>";\r
1476                                 // let the client see this now in case http times out...\r
1477                                 flush();\r
1478                         }\r
1479 \r
1480                         if(!$keepalive || !$this->xmlrpc_curl_handle)\r
1481                         {\r
1482                                 $curl = curl_init($method . '://' . $server . ':' . $port . $this->path);\r
1483                                 if($keepalive)\r
1484                                 {\r
1485                                         $this->xmlrpc_curl_handle = $curl;\r
1486                                 }\r
1487                         }\r
1488                         else\r
1489                         {\r
1490                                 $curl = $this->xmlrpc_curl_handle;\r
1491                         }\r
1492 \r
1493                         // results into variable\r
1494                         curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);\r
1495 \r
1496                         if($this->debug)\r
1497                         {\r
1498                                 curl_setopt($curl, CURLOPT_VERBOSE, 1);\r
1499                         }\r
1500                         curl_setopt($curl, CURLOPT_USERAGENT, $GLOBALS['xmlrpcName'].' '.$GLOBALS['xmlrpcVersion']);\r
1501                         // required for XMLRPC: post the data\r
1502                         curl_setopt($curl, CURLOPT_POST, 1);\r
1503                         // the data\r
1504                         curl_setopt($curl, CURLOPT_POSTFIELDS, $payload);\r
1505 \r
1506                         // return the header too\r
1507                         curl_setopt($curl, CURLOPT_HEADER, 1);\r
1508 \r
1509                         // will only work with PHP >= 5.0\r
1510                         // NB: if we set an empty string, CURL will add http header indicating\r
1511                         // ALL methods it is supporting. This is possibly a better option than\r
1512                         // letting the user tell what curl can / cannot do...\r
1513                         if(is_array($this->accepted_compression) && count($this->accepted_compression))\r
1514                         {\r
1515                                 //curl_setopt($curl, CURLOPT_ENCODING, implode(',', $this->accepted_compression));\r
1516                                 // empty string means 'any supported by CURL' (shall we catch errors in case CURLOPT_SSLKEY undefined ?)\r
1517                                 if (count($this->accepted_compression) == 1)\r
1518                                 {\r
1519                                         curl_setopt($curl, CURLOPT_ENCODING, $this->accepted_compression[0]);\r
1520                                 }\r
1521                                 else\r
1522                                         curl_setopt($curl, CURLOPT_ENCODING, '');\r
1523                         }\r
1524                         // extra headers\r
1525                         $headers = array('Content-Type: ' . $msg->content_type , 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings));\r
1526                         // if no keepalive is wanted, let the server know it in advance\r
1527                         if(!$keepalive)\r
1528                         {\r
1529                                 $headers[] = 'Connection: close';\r
1530                         }\r
1531                         // request compression header\r
1532                         if($encoding_hdr)\r
1533                         {\r
1534                                 $headers[] = $encoding_hdr;\r
1535                         }\r
1536 \r
1537                         curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);\r
1538                         // timeout is borked\r
1539                         if($timeout)\r
1540                         {\r
1541                                 curl_setopt($curl, CURLOPT_TIMEOUT, $timeout == 1 ? 1 : $timeout - 1);\r
1542                         }\r
1543 \r
1544                         if($username && $password)\r
1545                         {\r
1546                                 curl_setopt($curl, CURLOPT_USERPWD, $username.':'.$password);\r
1547                                 if (defined('CURLOPT_HTTPAUTH'))\r
1548                                 {\r
1549                                         curl_setopt($curl, CURLOPT_HTTPAUTH, $authtype);\r
1550                                 }\r
1551                                 else if ($authtype != 1)\r
1552                                 {\r
1553                                         error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth is supported by the current PHP/curl install');\r
1554                                 }\r
1555                         }\r
1556 \r
1557                         if($method == 'https')\r
1558                         {\r
1559                                 // set cert file\r
1560                                 if($cert)\r
1561                                 {\r
1562                                         curl_setopt($curl, CURLOPT_SSLCERT, $cert);\r
1563                                 }\r
1564                                 // set cert password\r
1565                                 if($certpass)\r
1566                                 {\r
1567                                         curl_setopt($curl, CURLOPT_SSLCERTPASSWD, $certpass);\r
1568                                 }\r
1569                                 // whether to verify remote host's cert\r
1570                                 curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, $this->verifypeer);\r
1571                                 // set ca certificates file/dir\r
1572                                 if($cacert)\r
1573                                 {\r
1574                                         curl_setopt($curl, CURLOPT_CAINFO, $cacert);\r
1575                                 }\r
1576                                 if($cacertdir)\r
1577                                 {\r
1578                                         curl_setopt($curl, CURLOPT_CAPATH, $cacertdir);\r
1579                                 }\r
1580                                 // set key file (shall we catch errors in case CURLOPT_SSLKEY undefined ?)\r
1581                                 if($key)\r
1582                                 {\r
1583                                         curl_setopt($curl, CURLOPT_SSLKEY, $key);\r
1584                                 }\r
1585                                 // set key password (shall we catch errors in case CURLOPT_SSLKEY undefined ?)\r
1586                                 if($keypass)\r
1587                                 {\r
1588                                         curl_setopt($curl, CURLOPT_SSLKEYPASSWD, $keypass);\r
1589                                 }\r
1590                                 // 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
1591                                 curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, $this->verifyhost);\r
1592                         }\r
1593 \r
1594                         // proxy info\r
1595                         if($proxyhost)\r
1596                         {\r
1597                                 if($proxyport == 0)\r
1598                                 {\r
1599                                         $proxyport = 8080; // NB: even for HTTPS, local connection is on port 8080\r
1600                                 }\r
1601                                 curl_setopt($curl, CURLOPT_PROXY, $proxyhost.':'.$proxyport);\r
1602                                 //curl_setopt($curl, CURLOPT_PROXYPORT,$proxyport);\r
1603                                 if($proxyusername)\r
1604                                 {\r
1605                                         curl_setopt($curl, CURLOPT_PROXYUSERPWD, $proxyusername.':'.$proxypassword);\r
1606                                         if (defined('CURLOPT_PROXYAUTH'))\r
1607                                         {\r
1608                                                 curl_setopt($curl, CURLOPT_PROXYAUTH, $proxyauthtype);\r
1609                                         }\r
1610                                         else if ($proxyauthtype != 1)\r
1611                                         {\r
1612                                                 error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth to proxy is supported by the current PHP/curl install');\r
1613                                         }\r
1614                                 }\r
1615                         }\r
1616 \r
1617                         // NB: should we build cookie http headers by hand rather than let CURL do it?\r
1618                         // the following code does not honour 'expires', 'path' and 'domain' cookie attributes\r
1619                         // set to client obj the the user...\r
1620                         if (count($this->cookies))\r
1621                         {\r
1622                                 $cookieheader = '';\r
1623                                 foreach ($this->cookies as $name => $cookie)\r
1624                                 {\r
1625                                         $cookieheader .= $name . '=' . $cookie['value'] . '; ';\r
1626                                 }\r
1627                                 curl_setopt($curl, CURLOPT_COOKIE, substr($cookieheader, 0, -2));\r
1628                         }\r
1629 \r
1630                         $result = curl_exec($curl);\r
1631 \r
1632                         if ($this->debug > 1)\r
1633                         {\r
1634                                 print "<PRE>\n---CURL INFO---\n";\r
1635                                 foreach(curl_getinfo($curl) as $name => $val)\r
1636                                          print $name . ': ' . htmlentities($val). "\n";\r
1637                                 print "---END---\n</PRE>";\r
1638                         }\r
1639 \r
1640                         if(!$result) /// @todo we should use a better check here - what if we get back '' or '0'?\r
1641                         {\r
1642                                 $this->errstr='no response';\r
1643                                 $resp=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['curl_fail'], $GLOBALS['xmlrpcstr']['curl_fail']. ': '. curl_error($curl));\r
1644                                 curl_close($curl);\r
1645                                 if($keepalive)\r
1646                                 {\r
1647                                         $this->xmlrpc_curl_handle = null;\r
1648                                 }\r
1649                         }\r
1650                         else\r
1651                         {\r
1652                                 if(!$keepalive)\r
1653                                 {\r
1654                                         curl_close($curl);\r
1655                                 }\r
1656                                 $resp =& $msg->parseResponse($result, true, $this->return_type);\r
1657                         }\r
1658                         return $resp;\r
1659                 }\r
1660 \r
1661                 /**\r
1662                 * Send an array of request messages and return an array of responses.\r
1663                 * Unless $this->no_multicall has been set to true, it will try first\r
1664                 * to use one single xmlrpc call to server method system.multicall, and\r
1665                 * revert to sending many successive calls in case of failure.\r
1666                 * This failure is also stored in $this->no_multicall for subsequent calls.\r
1667                 * Unfortunately, there is no server error code universally used to denote\r
1668                 * the fact that multicall is unsupported, so there is no way to reliably\r
1669                 * distinguish between that and a temporary failure.\r
1670                 * If you are sure that server supports multicall and do not want to\r
1671                 * fallback to using many single calls, set the fourth parameter to FALSE.\r
1672                 *\r
1673                 * NB: trying to shoehorn extra functionality into existing syntax has resulted\r
1674                 * in pretty much convoluted code...\r
1675                 *\r
1676                 * @param array $msgs an array of xmlrpcmsg objects\r
1677                 * @param integer $timeout connection timeout (in seconds)\r
1678                 * @param string $method the http protocol variant to be used\r
1679                 * @param boolean fallback When true, upon receiveing an error during multicall, multiple single calls will be attempted\r
1680                 * @return array\r
1681                 * @access public\r
1682                 */\r
1683                 function multicall($msgs, $timeout=0, $method='', $fallback=true)\r
1684                 {\r
1685                         if ($method == '')\r
1686                         {\r
1687                                 $method = $this->method;\r
1688                         }\r
1689                         if(!$this->no_multicall)\r
1690                         {\r
1691                                 $results = $this->_try_multicall($msgs, $timeout, $method);\r
1692                                 if(is_array($results))\r
1693                                 {\r
1694                                         // System.multicall succeeded\r
1695                                         return $results;\r
1696                                 }\r
1697                                 else\r
1698                                 {\r
1699                                         // either system.multicall is unsupported by server,\r
1700                                         // or call failed for some other reason.\r
1701                                         if ($fallback)\r
1702                                         {\r
1703                                                 // Don't try it next time...\r
1704                                                 $this->no_multicall = true;\r
1705                                         }\r
1706                                         else\r
1707                                         {\r
1708                                                 if (is_a($results, 'xmlrpcresp'))\r
1709                                                 {\r
1710                                                         $result = $results;\r
1711                                                 }\r
1712                                                 else\r
1713                                                 {\r
1714                                                         $result = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['multicall_error'], $GLOBALS['xmlrpcstr']['multicall_error']);\r
1715                                                 }\r
1716                                         }\r
1717                                 }\r
1718                         }\r
1719                         else\r
1720                         {\r
1721                                 // override fallback, in case careless user tries to do two\r
1722                                 // opposite things at the same time\r
1723                                 $fallback = true;\r
1724                         }\r
1725 \r
1726                         $results = array();\r
1727                         if ($fallback)\r
1728                         {\r
1729                                 // system.multicall is (probably) unsupported by server:\r
1730                                 // emulate multicall via multiple requests\r
1731                                 foreach($msgs as $msg)\r
1732                                 {\r
1733                                         $results[] =& $this->send($msg, $timeout, $method);\r
1734                                 }\r
1735                         }\r
1736                         else\r
1737                         {\r
1738                                 // user does NOT want to fallback on many single calls:\r
1739                                 // since we should always return an array of responses,\r
1740                                 // return an array with the same error repeated n times\r
1741                                 foreach($msgs as $msg)\r
1742                                 {\r
1743                                         $results[] = $result;\r
1744                                 }\r
1745                         }\r
1746                         return $results;\r
1747                 }\r
1748 \r
1749                 /**\r
1750                 * Attempt to boxcar $msgs via system.multicall.\r
1751                 * Returns either an array of xmlrpcreponses, an xmlrpc error response\r
1752                 * or false (when received response does not respect valid multicall syntax)\r
1753                 * @access private\r
1754                 */\r
1755                 function _try_multicall($msgs, $timeout, $method)\r
1756                 {\r
1757                         // Construct multicall message\r
1758                         $calls = array();\r
1759                         foreach($msgs as $msg)\r
1760                         {\r
1761                                 $call['methodName'] = new xmlrpcval($msg->method(),'string');\r
1762                                 $numParams = $msg->getNumParams();\r
1763                                 $params = array();\r
1764                                 for($i = 0; $i < $numParams; $i++)\r
1765                                 {\r
1766                                         $params[$i] = $msg->getParam($i);\r
1767                                 }\r
1768                                 $call['params'] = new xmlrpcval($params, 'array');\r
1769                                 $calls[] = new xmlrpcval($call, 'struct');\r
1770                         }\r
1771                         $multicall = new xmlrpcmsg('system.multicall');\r
1772                         $multicall->addParam(new xmlrpcval($calls, 'array'));\r
1773 \r
1774                         // Attempt RPC call\r
1775                         $result =& $this->send($multicall, $timeout, $method);\r
1776 \r
1777                         if($result->faultCode() != 0)\r
1778                         {\r
1779                                 // call to system.multicall failed\r
1780                                 return $result;\r
1781                         }\r
1782 \r
1783                         // Unpack responses.\r
1784                         $rets = $result->value();\r
1785 \r
1786                         if ($this->return_type == 'xml')\r
1787                         {\r
1788                                         return $rets;\r
1789                         }\r
1790                         else if ($this->return_type == 'phpvals')\r
1791                         {\r
1792                                 ///@todo test this code branch...\r
1793                                 $rets = $result->value();\r
1794                                 if(!is_array($rets))\r
1795                                 {\r
1796                                         return false;           // bad return type from system.multicall\r
1797                                 }\r
1798                                 $numRets = count($rets);\r
1799                                 if($numRets != count($msgs))\r
1800                                 {\r
1801                                         return false;           // wrong number of return values.\r
1802                                 }\r
1803 \r
1804                                 $response = array();\r
1805                                 for($i = 0; $i < $numRets; $i++)\r
1806                                 {\r
1807                                         $val = $rets[$i];\r
1808                                         if (!is_array($val)) {\r
1809                                                 return false;\r
1810                                         }\r
1811                                         switch(count($val))\r
1812                                         {\r
1813                                                 case 1:\r
1814                                                         if(!isset($val[0]))\r
1815                                                         {\r
1816                                                                 return false;           // Bad value\r
1817                                                         }\r
1818                                                         // Normal return value\r
1819                                                         $response[$i] = new xmlrpcresp($val[0], 0, '', 'phpvals');\r
1820                                                         break;\r
1821                                                 case 2:\r
1822                                                         ///     @todo remove usage of @: it is apparently quite slow\r
1823                                                         $code = @$val['faultCode'];\r
1824                                                         if(!is_int($code))\r
1825                                                         {\r
1826                                                                 return false;\r
1827                                                         }\r
1828                                                         $str = @$val['faultString'];\r
1829                                                         if(!is_string($str))\r
1830                                                         {\r
1831                                                                 return false;\r
1832                                                         }\r
1833                                                         $response[$i] = new xmlrpcresp(0, $code, $str);\r
1834                                                         break;\r
1835                                                 default:\r
1836                                                         return false;\r
1837                                         }\r
1838                                 }\r
1839                                 return $response;\r
1840                         }\r
1841                         else // return type == 'xmlrpcvals'\r
1842                         {\r
1843                                 $rets = $result->value();\r
1844                                 if($rets->kindOf() != 'array')\r
1845                                 {\r
1846                                         return false;           // bad return type from system.multicall\r
1847                                 }\r
1848                                 $numRets = $rets->arraysize();\r
1849                                 if($numRets != count($msgs))\r
1850                                 {\r
1851                                         return false;           // wrong number of return values.\r
1852                                 }\r
1853 \r
1854                                 $response = array();\r
1855                                 for($i = 0; $i < $numRets; $i++)\r
1856                                 {\r
1857                                         $val = $rets->arraymem($i);\r
1858                                         switch($val->kindOf())\r
1859                                         {\r
1860                                                 case 'array':\r
1861                                                         if($val->arraysize() != 1)\r
1862                                                         {\r
1863                                                                 return false;           // Bad value\r
1864                                                         }\r
1865                                                         // Normal return value\r
1866                                                         $response[$i] = new xmlrpcresp($val->arraymem(0));\r
1867                                                         break;\r
1868                                                 case 'struct':\r
1869                                                         $code = $val->structmem('faultCode');\r
1870                                                         if($code->kindOf() != 'scalar' || $code->scalartyp() != 'int')\r
1871                                                         {\r
1872                                                                 return false;\r
1873                                                         }\r
1874                                                         $str = $val->structmem('faultString');\r
1875                                                         if($str->kindOf() != 'scalar' || $str->scalartyp() != 'string')\r
1876                                                         {\r
1877                                                                 return false;\r
1878                                                         }\r
1879                                                         $response[$i] = new xmlrpcresp(0, $code->scalarval(), $str->scalarval());\r
1880                                                         break;\r
1881                                                 default:\r
1882                                                         return false;\r
1883                                         }\r
1884                                 }\r
1885                                 return $response;\r
1886                         }\r
1887                 }\r
1888         } // end class xmlrpc_client\r
1889 \r
1890         class xmlrpcresp\r
1891         {\r
1892                 var $val = 0;\r
1893                 var $valtyp;\r
1894                 var $errno = 0;\r
1895                 var $errstr = '';\r
1896                 var $payload;\r
1897                 var $hdrs = array();\r
1898                 var $_cookies = array();\r
1899                 var $content_type = 'text/xml';\r
1900                 var $raw_data = '';\r
1901 \r
1902                 /**\r
1903                 * @param mixed $val either an xmlrpcval obj, a php value or the xml serialization of an xmlrpcval (a string)\r
1904                 * @param integer $fcode set it to anything but 0 to create an error response\r
1905                 * @param string $fstr the error string, in case of an error response\r
1906                 * @param string $valtyp either 'xmlrpcvals', 'phpvals' or 'xml'\r
1907                 *\r
1908                 * @todo add check that $val / $fcode / $fstr is of correct type???\r
1909                 * NB: as of now we do not do it, since it might be either an xmlrpcval or a plain\r
1910                 * php val, or a complete xml chunk, depending on usage of xmlrpc_client::send() inside which creator is called...\r
1911                 */\r
1912                 function xmlrpcresp($val, $fcode = 0, $fstr = '', $valtyp='')\r
1913                 {\r
1914                         if($fcode != 0)\r
1915                         {\r
1916                                 // error response\r
1917                                 $this->errno = $fcode;\r
1918                                 $this->errstr = $fstr;\r
1919                                 //$this->errstr = htmlspecialchars($fstr); // XXX: encoding probably shouldn't be done here; fix later.\r
1920                         }\r
1921                         else\r
1922                         {\r
1923                                 // successful response\r
1924                                 $this->val = $val;\r
1925                                 if ($valtyp == '')\r
1926                                 {\r
1927                                         // user did not declare type of response value: try to guess it\r
1928                                         if (is_object($this->val) && is_a($this->val, 'xmlrpcval'))\r
1929                                         {\r
1930                                                 $this->valtyp = 'xmlrpcvals';\r
1931                                         }\r
1932                                         else if (is_string($this->val))\r
1933                                         {\r
1934                                                 $this->valtyp = 'xml';\r
1935 \r
1936                                         }\r
1937                                         else\r
1938                                         {\r
1939                                                 $this->valtyp = 'phpvals';\r
1940                                         }\r
1941                                 }\r
1942                                 else\r
1943                                 {\r
1944                                         // user declares type of resp value: believe him\r
1945                                         $this->valtyp = $valtyp;\r
1946                                 }\r
1947                         }\r
1948                 }\r
1949 \r
1950                 /**\r
1951                 * Returns the error code of the response.\r
1952                 * @return integer the error code of this response (0 for not-error responses)\r
1953                 * @access public\r
1954                 */\r
1955                 function faultCode()\r
1956                 {\r
1957                         return $this->errno;\r
1958                 }\r
1959 \r
1960                 /**\r
1961                 * Returns the error code of the response.\r
1962                 * @return string the error string of this response ('' for not-error responses)\r
1963                 * @access public\r
1964                 */\r
1965                 function faultString()\r
1966                 {\r
1967                         return $this->errstr;\r
1968                 }\r
1969 \r
1970                 /**\r
1971                 * Returns the value received by the server.\r
1972                 * @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
1973                 * @access public\r
1974                 */\r
1975                 function value()\r
1976                 {\r
1977                         return $this->val;\r
1978                 }\r
1979 \r
1980                 /**\r
1981                 * Returns an array with the cookies received from the server.\r
1982                 * Array has the form: $cookiename => array ('value' => $val, $attr1 => $val1, $attr2 = $val2, ...)\r
1983                 * with attributes being e.g. 'expires', 'path', domain'.\r
1984                 * NB: cookies sent as 'expired' by the server (i.e. with an expiry date in the past)\r
1985                 * are still present in the array. It is up to the user-defined code to decide\r
1986                 * how to use the received cookies, and wheter they have to be sent back with the next\r
1987                 * request to the server (using xmlrpc_client::setCookie) or not\r
1988                 * @return array array of cookies received from the server\r
1989                 * @access public\r
1990                 */\r
1991                 function cookies()\r
1992                 {\r
1993                         return $this->_cookies;\r
1994                 }\r
1995 \r
1996                 /**\r
1997                 * Returns xml representation of the response. XML prologue not included\r
1998                 * @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed\r
1999                 * @return string the xml representation of the response\r
2000                 * @access public\r
2001                 */\r
2002                 function serialize($charset_encoding='')\r
2003                 {\r
2004                         if ($charset_encoding != '')\r
2005                                 $this->content_type = 'text/xml; charset=' . $charset_encoding;\r
2006                         else\r
2007                                 $this->content_type = 'text/xml';\r
2008                         $result = "<methodResponse>\n";\r
2009                         if($this->errno)\r
2010                         {\r
2011                                 // G. Giunta 2005/2/13: let non-ASCII response messages be tolerated by clients\r
2012                                 // by xml-encoding non ascii chars\r
2013                                 $result .= "<fault>\n" .\r
2014 "<value>\n<struct><member><name>faultCode</name>\n<value><int>" . $this->errno .\r
2015 "</int></value>\n</member>\n<member>\n<name>faultString</name>\n<value><string>" .\r
2016 xmlrpc_encode_entitites($this->errstr, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding) . "</string></value>\n</member>\n" .\r
2017 "</struct>\n</value>\n</fault>";\r
2018                         }\r
2019                         else\r
2020                         {\r
2021                                 if(!is_object($this->val) || !is_a($this->val, 'xmlrpcval'))\r
2022                                 {\r
2023                                         if (is_string($this->val) && $this->valtyp == 'xml')\r
2024                                         {\r
2025                                                 $result .= "<params>\n<param>\n" .\r
2026                                                         $this->val .\r
2027                                                         "</param>\n</params>";\r
2028                                         }\r
2029                                         else\r
2030                                         {\r
2031                                                 /// @todo try to build something serializable?\r
2032                                                 die('cannot serialize xmlrpcresp objects whose content is native php values');\r
2033                                         }\r
2034                                 }\r
2035                                 else\r
2036                                 {\r
2037                                         $result .= "<params>\n<param>\n" .\r
2038                                                 $this->val->serialize($charset_encoding) .\r
2039                                                 "</param>\n</params>";\r
2040                                 }\r
2041                         }\r
2042                         $result .= "\n</methodResponse>";\r
2043                         $this->payload = $result;\r
2044                         return $result;\r
2045                 }\r
2046         }\r
2047 \r
2048         class xmlrpcmsg\r
2049         {\r
2050                 var $payload;\r
2051                 var $methodname;\r
2052                 var $params=array();\r
2053                 var $debug=0;\r
2054                 var $content_type = 'text/xml';\r
2055 \r
2056                 /**\r
2057                 * @param string $meth the name of the method to invoke\r
2058                 * @param array $pars array of parameters to be paased to the method (xmlrpcval objects)\r
2059                 */\r
2060                 function xmlrpcmsg($meth, $pars=0)\r
2061                 {\r
2062                         $this->methodname=$meth;\r
2063                         if(is_array($pars) && count($pars)>0)\r
2064                         {\r
2065                                 for($i=0; $i<count($pars); $i++)\r
2066                                 {\r
2067                                         $this->addParam($pars[$i]);\r
2068                                 }\r
2069                         }\r
2070                 }\r
2071 \r
2072                 /**\r
2073                 * @access private\r
2074                 */\r
2075                 function xml_header($charset_encoding='')\r
2076                 {\r
2077                         if ($charset_encoding != '')\r
2078                         {\r
2079                                 return "<?xml version=\"1.0\" encoding=\"$charset_encoding\" ?" . ">\n<methodCall>\n";\r
2080                         }\r
2081                         else\r
2082                         {\r
2083                                 return "<?xml version=\"1.0\"?" . ">\n<methodCall>\n";\r
2084                         }\r
2085                 }\r
2086 \r
2087                 /**\r
2088                 * @access private\r
2089                 */\r
2090                 function xml_footer()\r
2091                 {\r
2092                         return '</methodCall>';\r
2093                 }\r
2094 \r
2095                 /**\r
2096                 * @access private\r
2097                 */\r
2098                 function kindOf()\r
2099                 {\r
2100                         return 'msg';\r
2101                 }\r
2102 \r
2103                 /**\r
2104                 * @access private\r
2105                 */\r
2106                 function createPayload($charset_encoding='')\r
2107                 {\r
2108                         if ($charset_encoding != '')\r
2109                                 $this->content_type = 'text/xml; charset=' . $charset_encoding;\r
2110                         else\r
2111                                 $this->content_type = 'text/xml';\r
2112                         $this->payload=$this->xml_header($charset_encoding);\r
2113                         $this->payload.='<methodName>' . $this->methodname . "</methodName>\n";\r
2114                         $this->payload.="<params>\n";\r
2115                         for($i=0; $i<count($this->params); $i++)\r
2116                         {\r
2117                                 $p=$this->params[$i];\r
2118                                 $this->payload.="<param>\n" . $p->serialize($charset_encoding) .\r
2119                                 "</param>\n";\r
2120                         }\r
2121                         $this->payload.="</params>\n";\r
2122                         $this->payload.=$this->xml_footer();\r
2123                 }\r
2124 \r
2125                 /**\r
2126                 * Gets/sets the xmlrpc method to be invoked\r
2127                 * @param string $meth the method to be set (leave empty not to set it)\r
2128                 * @return string the method that will be invoked\r
2129                 * @access public\r
2130                 */\r
2131                 function method($meth='')\r
2132                 {\r
2133                         if($meth!='')\r
2134                         {\r
2135                                 $this->methodname=$meth;\r
2136                         }\r
2137                         return $this->methodname;\r
2138                 }\r
2139 \r
2140                 /**\r
2141                 * Returns xml representation of the message. XML prologue included\r
2142                 * @return string the xml representation of the message, xml prologue included\r
2143                 * @access public\r
2144                 */\r
2145                 function serialize($charset_encoding='')\r
2146                 {\r
2147                         $this->createPayload($charset_encoding);\r
2148                         return $this->payload;\r
2149                 }\r
2150 \r
2151                 /**\r
2152                 * Add a parameter to the list of parameters to be used upon method invocation\r
2153                 * @param xmlrpcval $par\r
2154                 * @return boolean false on failure\r
2155                 * @access public\r
2156                 */\r
2157                 function addParam($par)\r
2158                 {\r
2159                         // add check: do not add to self params which are not xmlrpcvals\r
2160                         if(is_object($par) && is_a($par, 'xmlrpcval'))\r
2161                         {\r
2162                                 $this->params[]=$par;\r
2163                                 return true;\r
2164                         }\r
2165                         else\r
2166                         {\r
2167                                 return false;\r
2168                         }\r
2169                 }\r
2170 \r
2171                 /**\r
2172                 * Returns the nth parameter in the message. The index zero-based.\r
2173                 * @param integer $i the index of the parameter to fetch (zero based)\r
2174                 * @return xmlrpcval the i-th parameter\r
2175                 * @access public\r
2176                 */\r
2177                 function getParam($i) { return $this->params[$i]; }\r
2178 \r
2179                 /**\r
2180                 * Returns the number of parameters in the messge.\r
2181                 * @return integer the number of parameters currently set\r
2182                 * @access public\r
2183                 */\r
2184                 function getNumParams() { return count($this->params); }\r
2185 \r
2186                 /**\r
2187                 * Given an open file handle, read all data available and parse it as axmlrpc response.\r
2188                 * NB: the file handle is not closed by this function.\r
2189                 * NNB: might have trouble in rare cases to work on network streams, as we\r
2190         *      check for a read of 0 bytes instead of feof($fp).\r
2191                 *      But since checking for feof(null) returns false, we would risk an\r
2192                 *      infinite loop in that case, because we cannot trust the caller\r
2193                 *      to give us a valid pointer to an open file...\r
2194                 * @access public\r
2195                 * @return xmlrpcresp\r
2196                 * @todo add 2nd & 3rd param to be passed to ParseResponse() ???\r
2197                 */\r
2198                 function &parseResponseFile($fp)\r
2199                 {\r
2200                         $ipd='';\r
2201                         while($data=fread($fp, 32768))\r
2202                         {\r
2203                                 $ipd.=$data;\r
2204                         }\r
2205                         //fclose($fp);\r
2206                         $r =& $this->parseResponse($ipd);\r
2207                         return $r;\r
2208                 }\r
2209 \r
2210                 /**\r
2211                 * Parses HTTP headers and separates them from data.\r
2212                 * @access private\r
2213                 */\r
2214                 function &parseResponseHeaders(&$data, $headers_processed=false)\r
2215                 {\r
2216                                 // Support "web-proxy-tunelling" connections for https through proxies\r
2217                                 if(preg_match('/^HTTP\/1\.[0-1] 200 Connection established/', $data))\r
2218                                 {\r
2219                                         // Look for CR/LF or simple LF as line separator,\r
2220                                         // (even though it is not valid http)\r
2221                                         $pos = strpos($data,"\r\n\r\n");\r
2222                                         if($pos || is_int($pos))\r
2223                                         {\r
2224                                                 $bd = $pos+4;\r
2225                                         }\r
2226                                         else\r
2227                                         {\r
2228                                                 $pos = strpos($data,"\n\n");\r
2229                                                 if($pos || is_int($pos))\r
2230                                                 {\r
2231                                                         $bd = $pos+2;\r
2232                                                 }\r
2233                                                 else\r
2234                                                 {\r
2235                                                         // No separation between response headers and body: fault?\r
2236                                                         $bd = 0;\r
2237                                                 }\r
2238                                         }\r
2239                                         if ($bd)\r
2240                                         {\r
2241                                                 // this filters out all http headers from proxy.\r
2242                                                 // maybe we could take them into account, too?\r
2243                                                 $data = substr($data, $bd);\r
2244                                         }\r
2245                                         else\r
2246                                         {\r
2247                                                 error_log('XML-RPC: xmlrpcmsg::parseResponse: HTTPS via proxy error, tunnel connection possibly failed');\r
2248                                                 $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $GLOBALS['xmlrpcstr']['http_error']. ' (HTTPS via proxy error, tunnel connection possibly failed)');\r
2249                                                 return $r;\r
2250                                         }\r
2251                                 }\r
2252 \r
2253                                 // Strip HTTP 1.1 100 Continue header if present\r
2254                                 while(preg_match('/^HTTP\/1\.1 1[0-9]{2} /', $data))\r
2255                                 {\r
2256                                         $pos = strpos($data, 'HTTP', 12);\r
2257                                         // server sent a Continue header without any (valid) content following...\r
2258                                         // give the client a chance to know it\r
2259                                         if(!$pos && !is_int($pos)) // works fine in php 3, 4 and 5\r
2260                                         {\r
2261                                                 break;\r
2262                                         }\r
2263                                         $data = substr($data, $pos);\r
2264                                 }\r
2265                                 if(!preg_match('/^HTTP\/[0-9.]+ 200 /', $data))\r
2266                                 {\r
2267                                         $errstr= substr($data, 0, strpos($data, "\n")-1);\r
2268                                         error_log('XML-RPC: xmlrpcmsg::parseResponse: HTTP error, got response: ' .$errstr);\r
2269                                         $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $GLOBALS['xmlrpcstr']['http_error']. ' (' . $errstr . ')');\r
2270                                         return $r;\r
2271                                 }\r
2272 \r
2273                                 $GLOBALS['_xh']['headers'] = array();\r
2274                                 $GLOBALS['_xh']['cookies'] = array();\r
2275 \r
2276                                 // be tolerant to usage of \n instead of \r\n to separate headers and data\r
2277                                 // (even though it is not valid http)\r
2278                                 $pos = strpos($data,"\r\n\r\n");\r
2279                                 if($pos || is_int($pos))\r
2280                                 {\r
2281                                         $bd = $pos+4;\r
2282                                 }\r
2283                                 else\r
2284                                 {\r
2285                                         $pos = strpos($data,"\n\n");\r
2286                                         if($pos || is_int($pos))\r
2287                                         {\r
2288                                                 $bd = $pos+2;\r
2289                                         }\r
2290                                         else\r
2291                                         {\r
2292                                                 // No separation between response headers and body: fault?\r
2293                                                 // we could take some action here instead of going on...\r
2294                                                 $bd = 0;\r
2295                                         }\r
2296                                 }\r
2297                                 // be tolerant to line endings, and extra empty lines\r
2298                                 $ar = preg_split("/\r?\n/", trim(substr($data, 0, $pos)));\r
2299                                 while(list(,$line) = @each($ar))\r
2300                                 {\r
2301                                         // take care of multi-line headers and cookies\r
2302                                         $arr = explode(':',$line,2);\r
2303                                         if(count($arr) > 1)\r
2304                                         {\r
2305                                                 $header_name = strtolower(trim($arr[0]));\r
2306                                                 /// @todo some other headers (the ones that allow a CSV list of values)\r
2307                                                 /// do allow many values to be passed using multiple header lines.\r
2308                                                 /// We should add content to $GLOBALS['_xh']['headers'][$header_name]\r
2309                                                 /// instead of replacing it for those...\r
2310                                                 if ($header_name == 'set-cookie' || $header_name == 'set-cookie2')\r
2311                                                 {\r
2312                                                         if ($header_name == 'set-cookie2')\r
2313                                                         {\r
2314                                                                 // version 2 cookies:\r
2315                                                                 // there could be many cookies on one line, comma separated\r
2316                                                                 $cookies = explode(',', $arr[1]);\r
2317                                                         }\r
2318                                                         else\r
2319                                                         {\r
2320                                                                 $cookies = array($arr[1]);\r
2321                                                         }\r
2322                                                         foreach ($cookies as $cookie)\r
2323                                                         {\r
2324                                                                 // glue together all received cookies, using a comma to separate them\r
2325                                                                 // (same as php does with getallheaders())\r
2326                                                                 if (isset($GLOBALS['_xh']['headers'][$header_name]))\r
2327                                                                         $GLOBALS['_xh']['headers'][$header_name] .= ', ' . trim($cookie);\r
2328                                                                 else\r
2329                                                                         $GLOBALS['_xh']['headers'][$header_name] = trim($cookie);\r
2330                                                                 // parse cookie attributes, in case user wants to correctly honour them\r
2331                                                                 // feature creep: only allow rfc-compliant cookie attributes?\r
2332                                                                 // @todo support for server sending multiple time cookie with same name, but using different PATHs\r
2333                                                                 $cookie = explode(';', $cookie);\r
2334                                                                 foreach ($cookie as $pos => $val)\r
2335                                                                 {\r
2336                                                                         $val = explode('=', $val, 2);\r
2337                                                                         $tag = trim($val[0]);\r
2338                                                                         $val = trim(@$val[1]);\r
2339                                                                         /// @todo with version 1 cookies, we should strip leading and trailing " chars\r
2340                                                                         if ($pos == 0)\r
2341                                                                         {\r
2342                                                                                 $cookiename = $tag;\r
2343                                                                                 $GLOBALS['_xh']['cookies'][$tag] = array();\r
2344                                                                                 $GLOBALS['_xh']['cookies'][$cookiename]['value'] = urldecode($val);\r
2345                                                                         }\r
2346                                                                         else\r
2347                                                                         {\r
2348                                                                                 if ($tag != 'value')\r
2349                                                                                 {\r
2350                                                                                   $GLOBALS['_xh']['cookies'][$cookiename][$tag] = $val;\r
2351                                                                                 }\r
2352                                                                         }\r
2353                                                                 }\r
2354                                                         }\r
2355                                                 }\r
2356                                                 else\r
2357                                                 {\r
2358                                                         $GLOBALS['_xh']['headers'][$header_name] = trim($arr[1]);\r
2359                                                 }\r
2360                                         }\r
2361                                         elseif(isset($header_name))\r
2362                                         {\r
2363                                                 ///     @todo version1 cookies might span multiple lines, thus breaking the parsing above\r
2364                                                 $GLOBALS['_xh']['headers'][$header_name] .= ' ' . trim($line);\r
2365                                         }\r
2366                                 }\r
2367 \r
2368                                 $data = substr($data, $bd);\r
2369 \r
2370                                 if($this->debug && count($GLOBALS['_xh']['headers']))\r
2371                                 {\r
2372                                         print '<PRE>';\r
2373                                         foreach($GLOBALS['_xh']['headers'] as $header => $value)\r
2374                                         {\r
2375                                                 print htmlentities("HEADER: $header: $value\n");\r
2376                                         }\r
2377                                         foreach($GLOBALS['_xh']['cookies'] as $header => $value)\r
2378                                         {\r
2379                                                 print htmlentities("COOKIE: $header={$value['value']}\n");\r
2380                                         }\r
2381                                         print "</PRE>\n";\r
2382                                 }\r
2383 \r
2384                                 // if CURL was used for the call, http headers have been processed,\r
2385                                 // and dechunking + reinflating have been carried out\r
2386                                 if(!$headers_processed)\r
2387                                 {\r
2388                                         // Decode chunked encoding sent by http 1.1 servers\r
2389                                         if(isset($GLOBALS['_xh']['headers']['transfer-encoding']) && $GLOBALS['_xh']['headers']['transfer-encoding'] == 'chunked')\r
2390                                         {\r
2391                                                 if(!$data = decode_chunked($data))\r
2392                                                 {\r
2393                                                         error_log('XML-RPC: xmlrpcmsg::parseResponse: errors occurred when trying to rebuild the chunked data received from server');\r
2394                                                         $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['dechunk_fail'], $GLOBALS['xmlrpcstr']['dechunk_fail']);\r
2395                                                         return $r;\r
2396                                                 }\r
2397                                         }\r
2398 \r
2399                                         // Decode gzip-compressed stuff\r
2400                                         // code shamelessly inspired from nusoap library by Dietrich Ayala\r
2401                                         if(isset($GLOBALS['_xh']['headers']['content-encoding']))\r
2402                                         {\r
2403                                                 $GLOBALS['_xh']['headers']['content-encoding'] = str_replace('x-', '', $GLOBALS['_xh']['headers']['content-encoding']);\r
2404                                                 if($GLOBALS['_xh']['headers']['content-encoding'] == 'deflate' || $GLOBALS['_xh']['headers']['content-encoding'] == 'gzip')\r
2405                                                 {\r
2406                                                         // if decoding works, use it. else assume data wasn't gzencoded\r
2407                                                         if(function_exists('gzinflate'))\r
2408                                                         {\r
2409                                                                 if($GLOBALS['_xh']['headers']['content-encoding'] == 'deflate' && $degzdata = @gzuncompress($data))\r
2410                                                                 {\r
2411                                                                         $data = $degzdata;\r
2412                                                                         if($this->debug)\r
2413                                                                         print "<PRE>---INFLATED RESPONSE---[".strlen($data)." chars]---\n" . htmlentities($data) . "\n---END---</PRE>";\r
2414                                                                 }\r
2415                                                                 elseif($GLOBALS['_xh']['headers']['content-encoding'] == 'gzip' && $degzdata = @gzinflate(substr($data, 10)))\r
2416                                                                 {\r
2417                                                                         $data = $degzdata;\r
2418                                                                         if($this->debug)\r
2419                                                                         print "<PRE>---INFLATED RESPONSE---[".strlen($data)." chars]---\n" . htmlentities($data) . "\n---END---</PRE>";\r
2420                                                                 }\r
2421                                                                 else\r
2422                                                                 {\r
2423                                                                         error_log('XML-RPC: xmlrpcmsg::parseResponse: errors occurred when trying to decode the deflated data received from server');\r
2424                                                                         $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['decompress_fail'], $GLOBALS['xmlrpcstr']['decompress_fail']);\r
2425                                                                         return $r;\r
2426                                                                 }\r
2427                                                         }\r
2428                                                         else\r
2429                                                         {\r
2430                                                                 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
2431                                                                 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['cannot_decompress'], $GLOBALS['xmlrpcstr']['cannot_decompress']);\r
2432                                                                 return $r;\r
2433                                                         }\r
2434                                                 }\r
2435                                         }\r
2436                                 } // end of 'if needed, de-chunk, re-inflate response'\r
2437 \r
2438                                 // real stupid hack to avoid PHP 4 complaining about returning NULL by ref\r
2439                                 $r = null;\r
2440                                 $r =& $r;\r
2441                                 return $r;\r
2442                 }\r
2443 \r
2444                 /**\r
2445                 * Parse the xmlrpc response contained in the string $data and return an xmlrpcresp object.\r
2446                 * @param string $data the xmlrpc response, eventually including http headers\r
2447                 * @param bool $headers_processed when true prevents parsing HTTP headers for interpretation of content-encoding and consequent decoding\r
2448                 * @param string $return_type decides return type, i.e. content of response->value(). Either 'xmlrpcvals', 'xml' or 'phpvals'\r
2449                 * @return xmlrpcresp\r
2450                 * @access public\r
2451                 */\r
2452                 function &parseResponse($data='', $headers_processed=false, $return_type='xmlrpcvals')\r
2453                 {\r
2454                         if($this->debug)\r
2455                         {\r
2456                                 //by maHo, replaced htmlspecialchars with htmlentities\r
2457                                 print "<PRE>---GOT---\n" . htmlentities($data) . "\n---END---\n</PRE>";\r
2458                         }\r
2459 \r
2460                         if($data == '')\r
2461                         {\r
2462                                 error_log('XML-RPC: xmlrpcmsg::parseResponse: no response received from server.');\r
2463                                 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_data'], $GLOBALS['xmlrpcstr']['no_data']);\r
2464                                 return $r;\r
2465                         }\r
2466 \r
2467                         $GLOBALS['_xh']=array();\r
2468 \r
2469                         $raw_data = $data;\r
2470                         // parse the HTTP headers of the response, if present, and separate them from data\r
2471                         if(substr($data, 0, 4) == 'HTTP')\r
2472                         {\r
2473                                 $r =& $this->parseResponseHeaders($data, $headers_processed);\r
2474                                 if ($r)\r
2475                                 {\r
2476                                         // failed processing of HTTP response headers\r
2477                                         // save into response obj the full payload received, for debugging\r
2478                                         $r->raw_data = $data;\r
2479                                         return $r;\r
2480                                 }\r
2481                         }\r
2482                         else\r
2483                         {\r
2484                                 $GLOBALS['_xh']['headers'] = array();\r
2485                                 $GLOBALS['_xh']['cookies'] = array();\r
2486                         }\r
2487 \r
2488                         if($this->debug)\r
2489                         {\r
2490                                 $start = strpos($data, '<!-- SERVER DEBUG INFO (BASE64 ENCODED):');\r
2491                                 if ($start)\r
2492                                 {\r
2493                                         $start += strlen('<!-- SERVER DEBUG INFO (BASE64 ENCODED):');\r
2494                                         $end = strpos($data, '-->', $start);\r
2495                                         $comments = substr($data, $start, $end-$start);\r
2496                                         print "<PRE>---SERVER DEBUG INFO (DECODED) ---\n\t".htmlentities(str_replace("\n", "\n\t", base64_decode($comments)))."\n---END---\n</PRE>";\r
2497                                 }\r
2498                         }\r
2499 \r
2500                         // be tolerant of extra whitespace in response body\r
2501                         $data = trim($data);\r
2502 \r
2503                         /// @todo return an error msg if $data=='' ?\r
2504 \r
2505                         // be tolerant of junk after methodResponse (e.g. javascript ads automatically inserted by free hosts)\r
2506                         // idea from Luca Mariano <luca.mariano@email.it> originally in PEARified version of the lib\r
2507                         $bd = false;\r
2508                         // Poor man's version of strrpos for php 4...\r
2509                         $pos = strpos($data, '</methodResponse>');\r
2510                         while($pos || is_int($pos))\r
2511                         {\r
2512                                 $bd = $pos+17;\r
2513                                 $pos = strpos($data, '</methodResponse>', $bd);\r
2514                         }\r
2515                         if($bd)\r
2516                         {\r
2517                                 $data = substr($data, 0, $bd);\r
2518                         }\r
2519 \r
2520                         // if user wants back raw xml, give it to him\r
2521                         if ($return_type == 'xml')\r
2522                         {\r
2523                                 $r = new xmlrpcresp($data, 0, '', 'xml');\r
2524                                 $r->hdrs = $GLOBALS['_xh']['headers'];\r
2525                                 $r->_cookies = $GLOBALS['_xh']['cookies'];\r
2526                                 $r->raw_data = $raw_data;\r
2527                                 return $r;\r
2528                         }\r
2529 \r
2530                         // try to 'guestimate' the character encoding of the received response\r
2531                         $resp_encoding = guess_encoding(@$GLOBALS['_xh']['headers']['content-type'], $data);\r
2532 \r
2533                         $GLOBALS['_xh']['ac']='';\r
2534                         //$GLOBALS['_xh']['qt']=''; //unused...\r
2535                         $GLOBALS['_xh']['stack'] = array();\r
2536                         $GLOBALS['_xh']['valuestack'] = array();\r
2537                         $GLOBALS['_xh']['isf']=0; // 0 = OK, 1 for xmlrpc fault responses, 2 = invalid xmlrpc\r
2538                         $GLOBALS['_xh']['isf_reason']='';\r
2539                         $GLOBALS['_xh']['rt']=''; // 'methodcall or 'methodresponse'\r
2540 \r
2541                         // if response charset encoding is not known / supported, try to use\r
2542                         // the default encoding and parse the xml anyway, but log a warning...\r
2543                         if (!in_array($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))\r
2544                         // the following code might be better for mb_string enabled installs, but\r
2545                         // makes the lib about 200% slower...\r
2546                         //if (!is_valid_charset($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))\r
2547                         {\r
2548                                 error_log('XML-RPC: xmlrpcmsg::parseResponse: invalid charset encoding of received response: '.$resp_encoding);\r
2549                                 $resp_encoding = $GLOBALS['xmlrpc_defencoding'];\r
2550                         }\r
2551                         $parser = xml_parser_create($resp_encoding);\r
2552                         xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true);\r
2553                         // G. Giunta 2005/02/13: PHP internally uses ISO-8859-1, so we have to tell\r
2554                         // the xml parser to give us back data in the expected charset.\r
2555                         // What if internal encoding is not in one of the 3 allowed?\r
2556                         // we use the broadest one, ie. utf8\r
2557                         // This allows to send data which is native in various charset,\r
2558                         // by extending xmlrpc_encode_entitites() and setting xmlrpc_internalencoding\r
2559                         if (!in_array($GLOBALS['xmlrpc_internalencoding'], array('UTF-8', 'ISO-8859-1', 'US-ASCII')))\r
2560                         {\r
2561                                 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');\r
2562                         }\r
2563                         else\r
2564                         {\r
2565                                 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $GLOBALS['xmlrpc_internalencoding']);\r
2566                         }\r
2567 \r
2568                         if ($return_type == 'phpvals')\r
2569                         {\r
2570                                 xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast');\r
2571                         }\r
2572                         else\r
2573                         {\r
2574                                 xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee');\r
2575                         }\r
2576 \r
2577                         xml_set_character_data_handler($parser, 'xmlrpc_cd');\r
2578                         xml_set_default_handler($parser, 'xmlrpc_dh');\r
2579 \r
2580                         // first error check: xml not well formed\r
2581                         if(!xml_parse($parser, $data, count($data)))\r
2582                         {\r
2583                                 // thanks to Peter Kocks <peter.kocks@baygate.com>\r
2584                                 if((xml_get_current_line_number($parser)) == 1)\r
2585                                 {\r
2586                                         $errstr = 'XML error at line 1, check URL';\r
2587                                 }\r
2588                                 else\r
2589                                 {\r
2590                                         $errstr = sprintf('XML error: %s at line %d, column %d',\r
2591                                                 xml_error_string(xml_get_error_code($parser)),\r
2592                                                 xml_get_current_line_number($parser), xml_get_current_column_number($parser));\r
2593                                 }\r
2594                                 error_log($errstr);\r
2595                                 $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'], $GLOBALS['xmlrpcstr']['invalid_return'].' ('.$errstr.')');\r
2596                                 xml_parser_free($parser);\r
2597                                 if($this->debug)\r
2598                                 {\r
2599                                         print $errstr;\r
2600                                 }\r
2601                                 $r->hdrs = $GLOBALS['_xh']['headers'];\r
2602                                 $r->_cookies = $GLOBALS['_xh']['cookies'];\r
2603                                 $r->raw_data = $raw_data;\r
2604                                 return $r;\r
2605                         }\r
2606                         xml_parser_free($parser);\r
2607                         // second error check: xml well formed but not xml-rpc compliant\r
2608                         if ($GLOBALS['_xh']['isf'] > 1)\r
2609                         {\r
2610                                 if ($this->debug)\r
2611                                 {\r
2612                                         /// @todo echo something for user?\r
2613                                 }\r
2614 \r
2615                                 $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'],\r
2616                                 $GLOBALS['xmlrpcstr']['invalid_return'] . ' ' . $GLOBALS['_xh']['isf_reason']);\r
2617                         }\r
2618                         // third error check: parsing of the response has somehow gone boink.\r
2619                         // NB: shall we omit this check, since we trust the parsing code?\r
2620                         elseif ($return_type == 'xmlrpcvals' && !is_object($GLOBALS['_xh']['value']))\r
2621                         {\r
2622                                 // something odd has happened\r
2623                                 // and it's time to generate a client side error\r
2624                                 // indicating something odd went on\r
2625                                 $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'],\r
2626                                         $GLOBALS['xmlrpcstr']['invalid_return']);\r
2627                         }\r
2628                         else\r
2629                         {\r
2630                                 if ($this->debug)\r
2631                                 {\r
2632                                         print "<PRE>---PARSED---\n";\r
2633                                         // somehow htmlentities chokes on var_export, and some full html string...\r
2634                                         //print htmlentitites(var_export($GLOBALS['_xh']['value'], true));\r
2635                                         print htmlspecialchars(var_export($GLOBALS['_xh']['value'], true));\r
2636                                         print "\n---END---</PRE>";\r
2637                                 }\r
2638 \r
2639                                 // note that using =& will raise an error if $GLOBALS['_xh']['st'] does not generate an object.\r
2640                                 $v =& $GLOBALS['_xh']['value'];\r
2641 \r
2642                                 if($GLOBALS['_xh']['isf'])\r
2643                                 {\r
2644                                         /// @todo we should test here if server sent an int and a string,\r
2645                                         /// and/or coerce them into such...\r
2646                                         if ($return_type == 'xmlrpcvals')\r
2647                                         {\r
2648                                                 $errno_v = $v->structmem('faultCode');\r
2649                                                 $errstr_v = $v->structmem('faultString');\r
2650                                                 $errno = $errno_v->scalarval();\r
2651                                                 $errstr = $errstr_v->scalarval();\r
2652                                         }\r
2653                                         else\r
2654                                         {\r
2655                                                 $errno = $v['faultCode'];\r
2656                                                 $errstr = $v['faultString'];\r
2657                                         }\r
2658 \r
2659                                         if($errno == 0)\r
2660                                         {\r
2661                                                 // FAULT returned, errno needs to reflect that\r
2662                                                 $errno = -1;\r
2663                                         }\r
2664 \r
2665                                         $r = new xmlrpcresp(0, $errno, $errstr);\r
2666                                 }\r
2667                                 else\r
2668                                 {\r
2669                                         $r=new xmlrpcresp($v, 0, '', $return_type);\r
2670                                 }\r
2671                         }\r
2672 \r
2673                         $r->hdrs = $GLOBALS['_xh']['headers'];\r
2674                         $r->_cookies = $GLOBALS['_xh']['cookies'];\r
2675                         $r->raw_data = $raw_data;\r
2676                         return $r;\r
2677                 }\r
2678         }\r
2679 \r
2680         class xmlrpcval\r
2681         {\r
2682                 var $me=array();\r
2683                 var $mytype=0;\r
2684                 var $_php_class=null;\r
2685 \r
2686                 /**\r
2687                 * @param mixed $val\r
2688                 * @param string $type any valid xmlrpc type name (lowercase). If null, 'string' is assumed\r
2689                 */\r
2690                 function xmlrpcval($val=-1, $type='')\r
2691                 {\r
2692                         /// @todo: optimization creep - do not call addXX, do it all inline.\r
2693                         /// downside: booleans will not be coerced anymore\r
2694                         if($val!==-1 || $type!='')\r
2695                         {\r
2696                                 // optimization creep: inlined all work done by constructor\r
2697                                 switch($type)\r
2698                                 {\r
2699                                         case '':\r
2700                                                 $this->mytype=1;\r
2701                                                 $this->me['string']=$val;\r
2702                                                 break;\r
2703                                         case 'i4':\r
2704                                         case 'int':\r
2705                                         case 'double':\r
2706                                         case 'string':\r
2707                                         case 'boolean':\r
2708                                         case 'dateTime.iso8601':\r
2709                                         case 'base64':\r
2710                                         case 'null':\r
2711                                                 $this->mytype=1;\r
2712                                                 $this->me[$type]=$val;\r
2713                                                 break;\r
2714                                         case 'array':\r
2715                                                 $this->mytype=2;\r
2716                                                 $this->me['array']=$val;\r
2717                                                 break;\r
2718                                         case 'struct':\r
2719                                                 $this->mytype=3;\r
2720                                                 $this->me['struct']=$val;\r
2721                                                 break;\r
2722                                         default:\r
2723                                                 error_log("XML-RPC: xmlrpcval::xmlrpcval: not a known type ($type)");\r
2724                                 }\r
2725                                 /*if($type=='')\r
2726                                 {\r
2727                                         $type='string';\r
2728                                 }\r
2729                                 if($GLOBALS['xmlrpcTypes'][$type]==1)\r
2730                                 {\r
2731                                         $this->addScalar($val,$type);\r
2732                                 }\r
2733                                 elseif($GLOBALS['xmlrpcTypes'][$type]==2)\r
2734                                 {\r
2735                                         $this->addArray($val);\r
2736                                 }\r
2737                                 elseif($GLOBALS['xmlrpcTypes'][$type]==3)\r
2738                                 {\r
2739                                         $this->addStruct($val);\r
2740                                 }*/\r
2741                         }\r
2742                 }\r
2743 \r
2744                 /**\r
2745                 * Add a single php value to an (unitialized) xmlrpcval\r
2746                 * @param mixed $val\r
2747                 * @param string $type\r
2748                 * @return int 1 or 0 on failure\r
2749                 */\r
2750                 function addScalar($val, $type='string')\r
2751                 {\r
2752                         $typeof=@$GLOBALS['xmlrpcTypes'][$type];\r
2753                         if($typeof!=1)\r
2754                         {\r
2755                                 error_log("XML-RPC: xmlrpcval::addScalar: not a scalar type ($type)");\r
2756                                 return 0;\r
2757                         }\r
2758 \r
2759                         // coerce booleans into correct values\r
2760                         // NB: we should iether do it for datetimes, integers and doubles, too,\r
2761                         // or just plain remove this check, implemnted on booleans only...\r
2762                         if($type==$GLOBALS['xmlrpcBoolean'])\r
2763                         {\r
2764                                 if(strcasecmp($val,'true')==0 || $val==1 || ($val==true && strcasecmp($val,'false')))\r
2765                                 {\r
2766                                         $val=true;\r
2767                                 }\r
2768                                 else\r
2769                                 {\r
2770                                         $val=false;\r
2771                                 }\r
2772                         }\r
2773 \r
2774                         switch($this->mytype)\r
2775                         {\r
2776                                 case 1:\r
2777                                         error_log('XML-RPC: xmlrpcval::addScalar: scalar xmlrpcval can have only one value');\r
2778                                         return 0;\r
2779                                 case 3:\r
2780                                         error_log('XML-RPC: xmlrpcval::addScalar: cannot add anonymous scalar to struct xmlrpcval');\r
2781                                         return 0;\r
2782                                 case 2:\r
2783                                         // we're adding a scalar value to an array here\r
2784                                         //$ar=$this->me['array'];\r
2785                                         //$ar[]=new xmlrpcval($val, $type);\r
2786                                         //$this->me['array']=$ar;\r
2787                                         // Faster (?) avoid all the costly array-copy-by-val done here...\r
2788                                         $this->me['array'][]=new xmlrpcval($val, $type);\r
2789                                         return 1;\r
2790                                 default:\r
2791                                         // a scalar, so set the value and remember we're scalar\r
2792                                         $this->me[$type]=$val;\r
2793                                         $this->mytype=$typeof;\r
2794                                         return 1;\r
2795                         }\r
2796                 }\r
2797 \r
2798                 /**\r
2799                 * Add an array of xmlrpcval objects to an xmlrpcval\r
2800                 * @param array $vals\r
2801                 * @return int 1 or 0 on failure\r
2802                 * @access public\r
2803                 *\r
2804                 * @todo add some checking for $vals to be an array of xmlrpcvals?\r
2805                 */\r
2806                 function addArray($vals)\r
2807                 {\r
2808                         if($this->mytype==0)\r
2809                         {\r
2810                                 $this->mytype=$GLOBALS['xmlrpcTypes']['array'];\r
2811                                 $this->me['array']=$vals;\r
2812                                 return 1;\r
2813                         }\r
2814                         elseif($this->mytype==2)\r
2815                         {\r
2816                                 // we're adding to an array here\r
2817                                 $this->me['array'] = array_merge($this->me['array'], $vals);\r
2818                                 return 1;\r
2819                         }\r
2820                         else\r
2821                         {\r
2822                                 error_log('XML-RPC: xmlrpcval::addArray: already initialized as a [' . $this->kindOf() . ']');\r
2823                                 return 0;\r
2824                         }\r
2825                 }\r
2826 \r
2827                 /**\r
2828                 * Add an array of named xmlrpcval objects to an xmlrpcval\r
2829                 * @param array $vals\r
2830                 * @return int 1 or 0 on failure\r
2831                 * @access public\r
2832                 *\r
2833                 * @todo add some checking for $vals to be an array?\r
2834                 */\r
2835                 function addStruct($vals)\r
2836                 {\r
2837                         if($this->mytype==0)\r
2838                         {\r
2839                                 $this->mytype=$GLOBALS['xmlrpcTypes']['struct'];\r
2840                                 $this->me['struct']=$vals;\r
2841                                 return 1;\r
2842                         }\r
2843                         elseif($this->mytype==3)\r
2844                         {\r
2845                                 // we're adding to a struct here\r
2846                                 $this->me['struct'] = array_merge($this->me['struct'], $vals);\r
2847                                 return 1;\r
2848                         }\r
2849                         else\r
2850                         {\r
2851                                 error_log('XML-RPC: xmlrpcval::addStruct: already initialized as a [' . $this->kindOf() . ']');\r
2852                                 return 0;\r
2853                         }\r
2854                 }\r
2855 \r
2856                 // poor man's version of print_r ???\r
2857                 // DEPRECATED!\r
2858                 function dump($ar)\r
2859                 {\r
2860                         foreach($ar as $key => $val)\r
2861                         {\r
2862                                 echo "$key => $val<br />";\r
2863                                 if($key == 'array')\r
2864                                 {\r
2865                                         while(list($key2, $val2) = each($val))\r
2866                                         {\r
2867                                                 echo "-- $key2 => $val2<br />";\r
2868                                         }\r
2869                                 }\r
2870                         }\r
2871                 }\r
2872 \r
2873                 /**\r
2874                 * Returns a string containing "struct", "array" or "scalar" describing the base type of the value\r
2875                 * @return string\r
2876                 * @access public\r
2877                 */\r
2878                 function kindOf()\r
2879                 {\r
2880                         switch($this->mytype)\r
2881                         {\r
2882                                 case 3:\r
2883                                         return 'struct';\r
2884                                         break;\r
2885                                 case 2:\r
2886                                         return 'array';\r
2887                                         break;\r
2888                                 case 1:\r
2889                                         return 'scalar';\r
2890                                         break;\r
2891                                 default:\r
2892                                         return 'undef';\r
2893                         }\r
2894                 }\r
2895 \r
2896                 /**\r
2897                 * @access private\r
2898                 */\r
2899                 function serializedata($typ, $val, $charset_encoding='')\r
2900                 {\r
2901                         $rs='';\r
2902                         switch(@$GLOBALS['xmlrpcTypes'][$typ])\r
2903                         {\r
2904                                 case 1:\r
2905                                         switch($typ)\r
2906                                         {\r
2907                                                 case $GLOBALS['xmlrpcBase64']:\r
2908                                                         $rs.="<${typ}>" . base64_encode($val) . "</${typ}>";\r
2909                                                         break;\r
2910                                                 case $GLOBALS['xmlrpcBoolean']:\r
2911                                                         $rs.="<${typ}>" . ($val ? '1' : '0') . "</${typ}>";\r
2912                                                         break;\r
2913                                                 case $GLOBALS['xmlrpcString']:\r
2914                                                         // G. Giunta 2005/2/13: do NOT use htmlentities, since\r
2915                                                         // it will produce named html entities, which are invalid xml\r
2916                                                         $rs.="<${typ}>" . xmlrpc_encode_entitites($val, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding). "</${typ}>";\r
2917                                                         break;\r
2918                                                 case $GLOBALS['xmlrpcInt']:\r
2919                                                 case $GLOBALS['xmlrpcI4']:\r
2920                                                         $rs.="<${typ}>".(int)$val."</${typ}>";\r
2921                                                         break;\r
2922                                                 case $GLOBALS['xmlrpcDouble']:\r
2923                                                 // avoid using standard conversion of float to string because it is locale-dependent,\r
2924                                                 // and also because the xmlrpc spec forbids exponential notation\r
2925                                                 // sprintf('%F') would be most likely ok but it is only available since PHP 4.3.10 and PHP 5.0.3.\r
2926                                                 // The code below tries its best at keeping max precision while avoiding exp notation,\r
2927                                                 // but there is of course no limit in the number of decimal places to be used...\r
2928                                                 $rs.="<${typ}>".preg_replace('/\\.?0+$/','',number_format((double)$val, 128, '.', ''))."</${typ}>";\r
2929                                                         break;\r
2930                                                 case $GLOBALS['xmlrpcNull']:\r
2931                                                     if ($GLOBALS['xmlrpc_null_apache_encoding'])\r
2932                                                     {\r
2933                                                         $rs.="<ex:nil/>";\r
2934                                                     }\r
2935                                                     else\r
2936                             {\r
2937                                 $rs.="<nil/>";\r
2938                             }\r
2939                                                         break;\r
2940                                                 default:\r
2941                                                         // no standard type value should arrive here, but provide a possibility\r
2942                                                         // for xmlrpcvals of unknown type...\r
2943                                                         $rs.="<${typ}>${val}</${typ}>";\r
2944                                         }\r
2945                                         break;\r
2946                                 case 3:\r
2947                                         // struct\r
2948                                         if ($this->_php_class)\r
2949                                         {\r
2950                                                 $rs.='<struct php_class="' . $this->_php_class . "\">\n";\r
2951                                         }\r
2952                                         else\r
2953                                         {\r
2954                                                 $rs.="<struct>\n";\r
2955                                         }\r
2956                                         foreach($val as $key2 => $val2)\r
2957                                         {\r
2958                                                 $rs.='<member><name>'.xmlrpc_encode_entitites($key2, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding)."</name>\n";\r
2959                                                 //$rs.=$this->serializeval($val2);\r
2960                                                 $rs.=$val2->serialize($charset_encoding);\r
2961                                                 $rs.="</member>\n";\r
2962                                         }\r
2963                                         $rs.='</struct>';\r
2964                                         break;\r
2965                                 case 2:\r
2966                                         // array\r
2967                                         $rs.="<array>\n<data>\n";\r
2968                                         for($i=0; $i<count($val); $i++)\r
2969                                         {\r
2970                                                 //$rs.=$this->serializeval($val[$i]);\r
2971                                                 $rs.=$val[$i]->serialize($charset_encoding);\r
2972                                         }\r
2973                                         $rs.="</data>\n</array>";\r
2974                                         break;\r
2975                                 default:\r
2976                                         break;\r
2977                         }\r
2978                         return $rs;\r
2979                 }\r
2980 \r
2981                 /**\r
2982                 * Returns xml representation of the value. XML prologue not included\r
2983                 * @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed\r
2984                 * @return string\r
2985                 * @access public\r
2986                 */\r
2987                 function serialize($charset_encoding='')\r
2988                 {\r
2989                         // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...\r
2990                         //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))\r
2991                         //{\r
2992                                 reset($this->me);\r
2993                                 list($typ, $val) = each($this->me);\r
2994                                 return '<value>' . $this->serializedata($typ, $val, $charset_encoding) . "</value>\n";\r
2995                         //}\r
2996                 }\r
2997 \r
2998                 // DEPRECATED\r
2999                 function serializeval($o)\r
3000                 {\r
3001                         // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...\r
3002                         //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))\r
3003                         //{\r
3004                                 $ar=$o->me;\r
3005                                 reset($ar);\r
3006                                 list($typ, $val) = each($ar);\r
3007                                 return '<value>' . $this->serializedata($typ, $val) . "</value>\n";\r
3008                         //}\r
3009                 }\r
3010 \r
3011                 /**\r
3012                 * Checks wheter a struct member with a given name is present.\r
3013                 * Works only on xmlrpcvals of type struct.\r
3014                 * @param string $m the name of the struct member to be looked up\r
3015                 * @return boolean\r
3016                 * @access public\r
3017                 */\r
3018                 function structmemexists($m)\r
3019                 {\r
3020                         return array_key_exists($m, $this->me['struct']);\r
3021                 }\r
3022 \r
3023                 /**\r
3024                 * Returns the value of a given struct member (an xmlrpcval object in itself).\r
3025                 * Will raise a php warning if struct member of given name does not exist\r
3026                 * @param string $m the name of the struct member to be looked up\r
3027                 * @return xmlrpcval\r
3028                 * @access public\r
3029                 */\r
3030                 function structmem($m)\r
3031                 {\r
3032                         return $this->me['struct'][$m];\r
3033                 }\r
3034 \r
3035                 /**\r
3036                 * Reset internal pointer for xmlrpcvals of type struct.\r
3037                 * @access public\r
3038                 */\r
3039                 function structreset()\r
3040                 {\r
3041                         reset($this->me['struct']);\r
3042                 }\r
3043 \r
3044                 /**\r
3045                 * Return next member element for xmlrpcvals of type struct.\r
3046                 * @return xmlrpcval\r
3047                 * @access public\r
3048                 */\r
3049                 function structeach()\r
3050                 {\r
3051                         return each($this->me['struct']);\r
3052                 }\r
3053 \r
3054                 // DEPRECATED! this code looks like it is very fragile and has not been fixed\r
3055                 // for a long long time. Shall we remove it for 2.0?\r
3056                 function getval()\r
3057                 {\r
3058                         // UNSTABLE\r
3059                         reset($this->me);\r
3060                         list($a,$b)=each($this->me);\r
3061                         // contributed by I Sofer, 2001-03-24\r
3062                         // add support for nested arrays to scalarval\r
3063                         // i've created a new method here, so as to\r
3064                         // preserve back compatibility\r
3065 \r
3066                         if(is_array($b))\r
3067                         {\r
3068                                 @reset($b);\r
3069                                 while(list($id,$cont) = @each($b))\r
3070                                 {\r
3071                                         $b[$id] = $cont->scalarval();\r
3072                                 }\r
3073                         }\r
3074 \r
3075                         // add support for structures directly encoding php objects\r
3076                         if(is_object($b))\r
3077                         {\r
3078                                 $t = get_object_vars($b);\r
3079                                 @reset($t);\r
3080                                 while(list($id,$cont) = @each($t))\r
3081                                 {\r
3082                                         $t[$id] = $cont->scalarval();\r
3083                                 }\r
3084                                 @reset($t);\r
3085                                 while(list($id,$cont) = @each($t))\r
3086                                 {\r
3087                                         @$b->$id = $cont;\r
3088                                 }\r
3089                         }\r
3090                         // end contrib\r
3091                         return $b;\r
3092                 }\r
3093 \r
3094                 /**\r
3095                 * Returns the value of a scalar xmlrpcval\r
3096                 * @return mixed\r
3097                 * @access public\r
3098                 */\r
3099                 function scalarval()\r
3100                 {\r
3101                         reset($this->me);\r
3102                         list(,$b)=each($this->me);\r
3103                         return $b;\r
3104                 }\r
3105 \r
3106                 /**\r
3107                 * Returns the type of the xmlrpcval.\r
3108                 * For integers, 'int' is always returned in place of 'i4'\r
3109                 * @return string\r
3110                 * @access public\r
3111                 */\r
3112                 function scalartyp()\r
3113                 {\r
3114                         reset($this->me);\r
3115                         list($a,)=each($this->me);\r
3116                         if($a==$GLOBALS['xmlrpcI4'])\r
3117                         {\r
3118                                 $a=$GLOBALS['xmlrpcInt'];\r
3119                         }\r
3120                         return $a;\r
3121                 }\r
3122 \r
3123                 /**\r
3124                 * Returns the m-th member of an xmlrpcval of struct type\r
3125                 * @param integer $m the index of the value to be retrieved (zero based)\r
3126                 * @return xmlrpcval\r
3127                 * @access public\r
3128                 */\r
3129                 function arraymem($m)\r
3130                 {\r
3131                         return $this->me['array'][$m];\r
3132                 }\r
3133 \r
3134                 /**\r
3135                 * Returns the number of members in an xmlrpcval of array type\r
3136                 * @return integer\r
3137                 * @access public\r
3138                 */\r
3139                 function arraysize()\r
3140                 {\r
3141                         return count($this->me['array']);\r
3142                 }\r
3143 \r
3144                 /**\r
3145                 * Returns the number of members in an xmlrpcval of struct type\r
3146                 * @return integer\r
3147                 * @access public\r
3148                 */\r
3149                 function structsize()\r
3150                 {\r
3151                         return count($this->me['struct']);\r
3152                 }\r
3153         }\r
3154 \r
3155 \r
3156         // date helpers\r
3157 \r
3158         /**\r
3159         * Given a timestamp, return the corresponding ISO8601 encoded string.\r
3160         *\r
3161         * Really, timezones ought to be supported\r
3162         * but the XML-RPC spec says:\r
3163         *\r
3164         * "Don't assume a timezone. It should be specified by the server in its\r
3165         * documentation what assumptions it makes about timezones."\r
3166         *\r
3167         * These routines always assume localtime unless\r
3168         * $utc is set to 1, in which case UTC is assumed\r
3169         * and an adjustment for locale is made when encoding\r
3170         *\r
3171         * @param int $timet (timestamp)\r
3172         * @param int $utc (0 or 1)\r
3173         * @return string\r
3174         */\r
3175         function iso8601_encode($timet, $utc=0)\r
3176         {\r
3177                 if(!$utc)\r
3178                 {\r
3179                         $t=strftime("%Y%m%dT%H:%M:%S", $timet);\r
3180                 }\r
3181                 else\r
3182                 {\r
3183                         if(function_exists('gmstrftime'))\r
3184                         {\r
3185                                 // gmstrftime doesn't exist in some versions\r
3186                                 // of PHP\r
3187                                 $t=gmstrftime("%Y%m%dT%H:%M:%S", $timet);\r
3188                         }\r
3189                         else\r
3190                         {\r
3191                                 $t=strftime("%Y%m%dT%H:%M:%S", $timet-date('Z'));\r
3192                         }\r
3193                 }\r
3194                 return $t;\r
3195         }\r
3196 \r
3197         /**\r
3198         * Given an ISO8601 date string, return a timet in the localtime, or UTC\r
3199         * @param string $idate\r
3200         * @param int $utc either 0 or 1\r
3201         * @return int (datetime)\r
3202         */\r
3203         function iso8601_decode($idate, $utc=0)\r
3204         {\r
3205                 $t=0;\r
3206                 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
3207                 {\r
3208                         if($utc)\r
3209                         {\r
3210                                 $t=gmmktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);\r
3211                         }\r
3212                         else\r
3213                         {\r
3214                                 $t=mktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);\r
3215                         }\r
3216                 }\r
3217                 return $t;\r
3218         }\r
3219 \r
3220         /**\r
3221         * Takes an xmlrpc value in PHP xmlrpcval object format and translates it into native PHP types.\r
3222         *\r
3223         * Works with xmlrpc message objects as input, too.\r
3224         *\r
3225         * Given proper options parameter, can rebuild generic php object instances\r
3226         * (provided those have been encoded to xmlrpc format using a corresponding\r
3227         * option in php_xmlrpc_encode())\r
3228         * PLEASE NOTE that rebuilding php objects involves calling their constructor function.\r
3229         * This means that the remote communication end can decide which php code will\r
3230         * get executed on your server, leaving the door possibly open to 'php-injection'\r
3231         * style of attacks (provided you have some classes defined on your server that\r
3232         * might wreak havoc if instances are built outside an appropriate context).\r
3233         * Make sure you trust the remote server/client before eanbling this!\r
3234         *\r
3235         * @author Dan Libby (dan@libby.com)\r
3236         *\r
3237         * @param xmlrpcval $xmlrpc_val\r
3238         * @param array $options if 'decode_php_objs' is set in the options array, xmlrpc structs can be decoded into php objects\r
3239         * @return mixed\r
3240         */\r
3241         function php_xmlrpc_decode($xmlrpc_val, $options=array())\r
3242         {\r
3243                 switch($xmlrpc_val->kindOf())\r
3244                 {\r
3245                         case 'scalar':\r
3246                                 if (in_array('extension_api', $options))\r
3247                                 {\r
3248                                         reset($xmlrpc_val->me);\r
3249                                         list($typ,$val) = each($xmlrpc_val->me);\r
3250                                         switch ($typ)\r
3251                                         {\r
3252                                                 case 'dateTime.iso8601':\r
3253                                                         $xmlrpc_val->scalar = $val;\r
3254                                                         $xmlrpc_val->xmlrpc_type = 'datetime';\r
3255                                                         $xmlrpc_val->timestamp = iso8601_decode($val);\r
3256                                                         return $xmlrpc_val;\r
3257                                                 case 'base64':\r
3258                                                         $xmlrpc_val->scalar = $val;\r
3259                                                         $xmlrpc_val->type = $typ;\r
3260                                                         return $xmlrpc_val;\r
3261                                                 default:\r
3262                                                         return $xmlrpc_val->scalarval();\r
3263                                         }\r
3264                                 }\r
3265                                 return $xmlrpc_val->scalarval();\r
3266                         case 'array':\r
3267                                 $size = $xmlrpc_val->arraysize();\r
3268                                 $arr = array();\r
3269                                 for($i = 0; $i < $size; $i++)\r
3270                                 {\r
3271                                         $arr[] = php_xmlrpc_decode($xmlrpc_val->arraymem($i), $options);\r
3272                                 }\r
3273                                 return $arr;\r
3274                         case 'struct':\r
3275                                 $xmlrpc_val->structreset();\r
3276                                 // If user said so, try to rebuild php objects for specific struct vals.\r
3277                                 /// @todo should we raise a warning for class not found?\r
3278                                 // shall we check for proper subclass of xmlrpcval instead of\r
3279                                 // presence of _php_class to detect what we can do?\r
3280                                 if (in_array('decode_php_objs', $options) && $xmlrpc_val->_php_class != ''\r
3281                                         && class_exists($xmlrpc_val->_php_class))\r
3282                                 {\r
3283                                         $obj = @new $xmlrpc_val->_php_class;\r
3284                                         while(list($key,$value)=$xmlrpc_val->structeach())\r
3285                                         {\r
3286                                                 $obj->$key = php_xmlrpc_decode($value, $options);\r
3287                                         }\r
3288                                         return $obj;\r
3289                                 }\r
3290                                 else\r
3291                                 {\r
3292                                         $arr = array();\r
3293                                         while(list($key,$value)=$xmlrpc_val->structeach())\r
3294                                         {\r
3295                                                 $arr[$key] = php_xmlrpc_decode($value, $options);\r
3296                                         }\r
3297                                         return $arr;\r
3298                                 }\r
3299                         case 'msg':\r
3300                                 $paramcount = $xmlrpc_val->getNumParams();\r
3301                                 $arr = array();\r
3302                                 for($i = 0; $i < $paramcount; $i++)\r
3303                                 {\r
3304                                         $arr[] = php_xmlrpc_decode($xmlrpc_val->getParam($i));\r
3305                                 }\r
3306                                 return $arr;\r
3307                         }\r
3308         }\r
3309 \r
3310         // This constant left here only for historical reasons...\r
3311         // it was used to decide if we have to define xmlrpc_encode on our own, but\r
3312         // we do not do it anymore\r
3313         if(function_exists('xmlrpc_decode'))\r
3314         {\r
3315                 define('XMLRPC_EPI_ENABLED','1');\r
3316         }\r
3317         else\r
3318         {\r
3319                 define('XMLRPC_EPI_ENABLED','0');\r
3320         }\r
3321 \r
3322         /**\r
3323         * Takes native php types and encodes them into xmlrpc PHP object format.\r
3324         * It will not re-encode xmlrpcval objects.\r
3325         *\r
3326         * Feature creep -- could support more types via optional type argument\r
3327         * (string => datetime support has been added, ??? => base64 not yet)\r
3328         *\r
3329         * If given a proper options parameter, php object instances will be encoded\r
3330         * into 'special' xmlrpc values, that can later be decoded into php objects\r
3331         * by calling php_xmlrpc_decode() with a corresponding option\r
3332         *\r
3333         * @author Dan Libby (dan@libby.com)\r
3334         *\r
3335         * @param mixed $php_val the value to be converted into an xmlrpcval object\r
3336         * @param array $options can include 'encode_php_objs', 'auto_dates', 'null_extension' or 'extension_api'\r
3337         * @return xmlrpcval\r
3338         */\r
3339         function &php_xmlrpc_encode($php_val, $options=array())\r
3340         {\r
3341                 $type = gettype($php_val);\r
3342                 switch($type)\r
3343                 {\r
3344                         case 'string':\r
3345                                 if (in_array('auto_dates', $options) && preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $php_val))\r
3346                                         $xmlrpc_val = new xmlrpcval($php_val, $GLOBALS['xmlrpcDateTime']);\r
3347                                 else\r
3348                                         $xmlrpc_val = new xmlrpcval($php_val, $GLOBALS['xmlrpcString']);\r
3349                                 break;\r
3350                         case 'integer':\r
3351                                 $xmlrpc_val = new xmlrpcval($php_val, $GLOBALS['xmlrpcInt']);\r
3352                                 break;\r
3353                         case 'double':\r
3354                                 $xmlrpc_val = new xmlrpcval($php_val, $GLOBALS['xmlrpcDouble']);\r
3355                                 break;\r
3356                                 // <G_Giunta_2001-02-29>\r
3357                                 // Add support for encoding/decoding of booleans, since they are supported in PHP\r
3358                         case 'boolean':\r
3359                                 $xmlrpc_val = new xmlrpcval($php_val, $GLOBALS['xmlrpcBoolean']);\r
3360                                 break;\r
3361                                 // </G_Giunta_2001-02-29>\r
3362                         case 'array':\r
3363                                 // PHP arrays can be encoded to either xmlrpc structs or arrays,\r
3364                                 // depending on wheter they are hashes or plain 0..n integer indexed\r
3365                                 // A shorter one-liner would be\r
3366                                 // $tmp = array_diff(array_keys($php_val), range(0, count($php_val)-1));\r
3367                                 // but execution time skyrockets!\r
3368                                 $j = 0;\r
3369                                 $arr = array();\r
3370                                 $ko = false;\r
3371                                 foreach($php_val as $key => $val)\r
3372                                 {\r
3373                                         $arr[$key] =& php_xmlrpc_encode($val, $options);\r
3374                                         if(!$ko && $key !== $j)\r
3375                                         {\r
3376                                                 $ko = true;\r
3377                                         }\r
3378                                         $j++;\r
3379                                 }\r
3380                                 if($ko)\r
3381                                 {\r
3382                                         $xmlrpc_val = new xmlrpcval($arr, $GLOBALS['xmlrpcStruct']);\r
3383                                 }\r
3384                                 else\r
3385                                 {\r
3386                                         $xmlrpc_val = new xmlrpcval($arr, $GLOBALS['xmlrpcArray']);\r
3387                                 }\r
3388                                 break;\r
3389                         case 'object':\r
3390                                 if(is_a($php_val, 'xmlrpcval'))\r
3391                                 {\r
3392                                         $xmlrpc_val = $php_val;\r
3393                                 }\r
3394                                 else\r
3395                                 {\r
3396                                         $arr = array();\r
3397                                         while(list($k,$v) = each($php_val))\r
3398                                         {\r
3399                                                 $arr[$k] = php_xmlrpc_encode($v, $options);\r
3400                                         }\r
3401                                         $xmlrpc_val = new xmlrpcval($arr, $GLOBALS['xmlrpcStruct']);\r
3402                                         if (in_array('encode_php_objs', $options))\r
3403                                         {\r
3404                                                 // let's save original class name into xmlrpcval:\r
3405                                                 // might be useful later on...\r
3406                                                 $xmlrpc_val->_php_class = get_class($php_val);\r
3407                                         }\r
3408                                 }\r
3409                                 break;\r
3410                         case 'NULL':\r
3411                                 if (in_array('extension_api', $options))\r
3412                                 {\r
3413                                         $xmlrpc_val = new xmlrpcval('', $GLOBALS['xmlrpcString']);\r
3414                                 }\r
3415                                 else if (in_array('null_extension', $options))\r
3416                                 {\r
3417                                         $xmlrpc_val = new xmlrpcval('', $GLOBALS['xmlrpcNull']);\r
3418                                 }\r
3419                                 else\r
3420                                 {\r
3421                                         $xmlrpc_val = new xmlrpcval();\r
3422                                 }\r
3423                                 break;\r
3424                         case 'resource':\r
3425                                 if (in_array('extension_api', $options))\r
3426                                 {\r
3427                                         $xmlrpc_val = new xmlrpcval((int)$php_val, $GLOBALS['xmlrpcInt']);\r
3428                                 }\r
3429                                 else\r
3430                                 {\r
3431                                         $xmlrpc_val = new xmlrpcval();\r
3432                                 }\r
3433                         // catch "user function", "unknown type"\r
3434                         default:\r
3435                                 // giancarlo pinerolo <ping@alt.it>\r
3436                                 // it has to return\r
3437                                 // an empty object in case, not a boolean.\r
3438                                 $xmlrpc_val = new xmlrpcval();\r
3439                                 break;\r
3440                         }\r
3441                         return $xmlrpc_val;\r
3442         }\r
3443 \r
3444         /**\r
3445         * Convert the xml representation of a method response, method request or single\r
3446         * xmlrpc value into the appropriate object (a.k.a. deserialize)\r
3447         * @param string $xml_val\r
3448         * @param array $options\r
3449         * @return mixed false on error, or an instance of either xmlrpcval, xmlrpcmsg or xmlrpcresp\r
3450         */\r
3451         function php_xmlrpc_decode_xml($xml_val, $options=array())\r
3452         {\r
3453                 $GLOBALS['_xh'] = array();\r
3454                 $GLOBALS['_xh']['ac'] = '';\r
3455                 $GLOBALS['_xh']['stack'] = array();\r
3456                 $GLOBALS['_xh']['valuestack'] = array();\r
3457                 $GLOBALS['_xh']['params'] = array();\r
3458                 $GLOBALS['_xh']['pt'] = array();\r
3459                 $GLOBALS['_xh']['isf'] = 0;\r
3460                 $GLOBALS['_xh']['isf_reason'] = '';\r
3461                 $GLOBALS['_xh']['method'] = false;\r
3462                 $GLOBALS['_xh']['rt'] = '';\r
3463                 /// @todo 'guestimate' encoding\r
3464                 $parser = xml_parser_create();\r
3465                 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true);\r
3466                 // What if internal encoding is not in one of the 3 allowed?\r
3467                 // we use the broadest one, ie. utf8!\r
3468                 if (!in_array($GLOBALS['xmlrpc_internalencoding'], array('UTF-8', 'ISO-8859-1', 'US-ASCII')))\r
3469                 {\r
3470                         xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');\r
3471                 }\r
3472                 else\r
3473                 {\r
3474                         xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $GLOBALS['xmlrpc_internalencoding']);\r
3475                 }\r
3476                 xml_set_element_handler($parser, 'xmlrpc_se_any', 'xmlrpc_ee');\r
3477                 xml_set_character_data_handler($parser, 'xmlrpc_cd');\r
3478                 xml_set_default_handler($parser, 'xmlrpc_dh');\r
3479                 if(!xml_parse($parser, $xml_val, 1))\r
3480                 {\r
3481                         $errstr = sprintf('XML error: %s at line %d, column %d',\r
3482                                                 xml_error_string(xml_get_error_code($parser)),\r
3483                                                 xml_get_current_line_number($parser), xml_get_current_column_number($parser));\r
3484                         error_log($errstr);\r
3485                         xml_parser_free($parser);\r
3486                         return false;\r
3487                 }\r
3488                 xml_parser_free($parser);\r
3489                 if ($GLOBALS['_xh']['isf'] > 1) // test that $GLOBALS['_xh']['value'] is an obj, too???\r
3490                 {\r
3491                         error_log($GLOBALS['_xh']['isf_reason']);\r
3492                         return false;\r
3493                 }\r
3494                 switch ($GLOBALS['_xh']['rt'])\r
3495                 {\r
3496                         case 'methodresponse':\r
3497                                 $v =& $GLOBALS['_xh']['value'];\r
3498                                 if ($GLOBALS['_xh']['isf'] == 1)\r
3499                                 {\r
3500                                         $vc = $v->structmem('faultCode');\r
3501                                         $vs = $v->structmem('faultString');\r
3502                                         $r = new xmlrpcresp(0, $vc->scalarval(), $vs->scalarval());\r
3503                                 }\r
3504                                 else\r
3505                                 {\r
3506                                         $r = new xmlrpcresp($v);\r
3507                                 }\r
3508                                 return $r;\r
3509                         case 'methodcall':\r
3510                                 $m = new xmlrpcmsg($GLOBALS['_xh']['method']);\r
3511                                 for($i=0; $i < count($GLOBALS['_xh']['params']); $i++)\r
3512                                 {\r
3513                                         $m->addParam($GLOBALS['_xh']['params'][$i]);\r
3514                                 }\r
3515                                 return $m;\r
3516                         case 'value':\r
3517                                 return $GLOBALS['_xh']['value'];\r
3518                         default:\r
3519                                 return false;\r
3520                 }\r
3521         }\r
3522 \r
3523         /**\r
3524         * decode a string that is encoded w/ "chunked" transfer encoding\r
3525         * as defined in rfc2068 par. 19.4.6\r
3526         * code shamelessly stolen from nusoap library by Dietrich Ayala\r
3527         *\r
3528         * @param string $buffer the string to be decoded\r
3529         * @return string\r
3530         */\r
3531         function decode_chunked($buffer)\r
3532         {\r
3533                 // length := 0\r
3534                 $length = 0;\r
3535                 $new = '';\r
3536 \r
3537                 // read chunk-size, chunk-extension (if any) and crlf\r
3538                 // get the position of the linebreak\r
3539                 $chunkend = strpos($buffer,"\r\n") + 2;\r
3540                 $temp = substr($buffer,0,$chunkend);\r
3541                 $chunk_size = hexdec( trim($temp) );\r
3542                 $chunkstart = $chunkend;\r
3543                 while($chunk_size > 0)\r
3544                 {\r
3545                         $chunkend = strpos($buffer, "\r\n", $chunkstart + $chunk_size);\r
3546 \r
3547                         // just in case we got a broken connection\r
3548                         if($chunkend == false)\r
3549                         {\r
3550                                 $chunk = substr($buffer,$chunkstart);\r
3551                                 // append chunk-data to entity-body\r
3552                                 $new .= $chunk;\r
3553                                 $length += strlen($chunk);\r
3554                                 break;\r
3555                         }\r
3556 \r
3557                         // read chunk-data and crlf\r
3558                         $chunk = substr($buffer,$chunkstart,$chunkend-$chunkstart);\r
3559                         // append chunk-data to entity-body\r
3560                         $new .= $chunk;\r
3561                         // length := length + chunk-size\r
3562                         $length += strlen($chunk);\r
3563                         // read chunk-size and crlf\r
3564                         $chunkstart = $chunkend + 2;\r
3565 \r
3566                         $chunkend = strpos($buffer,"\r\n",$chunkstart)+2;\r
3567                         if($chunkend == false)\r
3568                         {\r
3569                                 break; //just in case we got a broken connection\r
3570                         }\r
3571                         $temp = substr($buffer,$chunkstart,$chunkend-$chunkstart);\r
3572                         $chunk_size = hexdec( trim($temp) );\r
3573                         $chunkstart = $chunkend;\r
3574                 }\r
3575                 return $new;\r
3576         }\r
3577 \r
3578         /**\r
3579         * xml charset encoding guessing helper function.\r
3580         * Tries to determine the charset encoding of an XML chunk received over HTTP.\r
3581         * NB: according to the spec (RFC 3023), if text/xml content-type is received over HTTP without a content-type,\r
3582         * we SHOULD assume it is strictly US-ASCII. But we try to be more tolerant of unconforming (legacy?) clients/servers,\r
3583         * which will be most probably using UTF-8 anyway...\r
3584         *\r
3585         * @param string $httpheaders the http Content-type header\r
3586         * @param string $xmlchunk xml content buffer\r
3587         * @param string $encoding_prefs comma separated list of character encodings to be used as default (when mb extension is enabled)\r
3588         *\r
3589         * @todo explore usage of mb_http_input(): does it detect http headers + post data? if so, use it instead of hand-detection!!!\r
3590         */\r
3591         function guess_encoding($httpheader='', $xmlchunk='', $encoding_prefs=null)\r
3592         {\r
3593                 // discussion: see http://www.yale.edu/pclt/encoding/\r
3594                 // 1 - test if encoding is specified in HTTP HEADERS\r
3595 \r
3596                 //Details:\r
3597                 // LWS:           (\13\10)?( |\t)+\r
3598                 // token:         (any char but excluded stuff)+\r
3599                 // quoted string: " (any char but double quotes and cointrol chars)* "\r
3600                 // header:        Content-type = ...; charset=value(; ...)*\r
3601                 //   where value is of type token, no LWS allowed between 'charset' and value\r
3602                 // Note: we do not check for invalid chars in VALUE:\r
3603                 //   this had better be done using pure ereg as below\r
3604                 // Note 2: we might be removing whitespace/tabs that ought to be left in if\r
3605         //   the received charset is a quoted string. But nobody uses such charset names...\r
3606 \r
3607                 /// @todo this test will pass if ANY header has charset specification, not only Content-Type. Fix it?\r
3608                 $matches = array();\r
3609                 if(preg_match('/;\s*charset\s*=([^;]+)/i', $httpheader, $matches))\r
3610                 {\r
3611                         return strtoupper(trim($matches[1], " \t\""));\r
3612                 }\r
3613 \r
3614                 // 2 - scan the first bytes of the data for a UTF-16 (or other) BOM pattern\r
3615                 //     (source: http://www.w3.org/TR/2000/REC-xml-20001006)\r
3616                 //     NOTE: actually, according to the spec, even if we find the BOM and determine\r
3617                 //     an encoding, we should check if there is an encoding specified\r
3618                 //     in the xml declaration, and verify if they match.\r
3619                 /// @todo implement check as described above?\r
3620                 /// @todo implement check for first bytes of string even without a BOM? (It sure looks harder than for cases WITH a BOM)\r
3621                 if(preg_match('/^(\x00\x00\xFE\xFF|\xFF\xFE\x00\x00|\x00\x00\xFF\xFE|\xFE\xFF\x00\x00)/', $xmlchunk))\r
3622                 {\r
3623                         return 'UCS-4';\r
3624                 }\r
3625                 elseif(preg_match('/^(\xFE\xFF|\xFF\xFE)/', $xmlchunk))\r
3626                 {\r
3627                         return 'UTF-16';\r
3628                 }\r
3629                 elseif(preg_match('/^(\xEF\xBB\xBF)/', $xmlchunk))\r
3630                 {\r
3631                         return 'UTF-8';\r
3632                 }\r
3633 \r
3634                 // 3 - test if encoding is specified in the xml declaration\r
3635                 // Details:\r
3636                 // SPACE:         (#x20 | #x9 | #xD | #xA)+ === [ \x9\xD\xA]+\r
3637                 // EQ:            SPACE?=SPACE? === [ \x9\xD\xA]*=[ \x9\xD\xA]*\r
3638                 if (preg_match('/^<\?xml\s+version\s*=\s*'. "((?:\"[a-zA-Z0-9_.:-]+\")|(?:'[a-zA-Z0-9_.:-]+'))".\r
3639                         '\s+encoding\s*=\s*' . "((?:\"[A-Za-z][A-Za-z0-9._-]*\")|(?:'[A-Za-z][A-Za-z0-9._-]*'))/",\r
3640                         $xmlchunk, $matches))\r
3641                 {\r
3642                         return strtoupper(substr($matches[2], 1, -1));\r
3643                 }\r
3644 \r
3645                 // 4 - if mbstring is available, let it do the guesswork\r
3646                 // NB: we favour finding an encoding that is compatible with what we can process\r
3647                 if(extension_loaded('mbstring'))\r
3648                 {\r
3649                         if($encoding_prefs)\r
3650                         {\r
3651                                 $enc = mb_detect_encoding($xmlchunk, $encoding_prefs);\r
3652                         }\r
3653                         else\r
3654                         {\r
3655                                 $enc = mb_detect_encoding($xmlchunk);\r
3656                         }\r
3657                         // NB: mb_detect likes to call it ascii, xml parser likes to call it US_ASCII...\r
3658                         // IANA also likes better US-ASCII, so go with it\r
3659                         if($enc == 'ASCII')\r
3660                         {\r
3661                                 $enc = 'US-'.$enc;\r
3662                         }\r
3663                         return $enc;\r
3664                 }\r
3665                 else\r
3666                 {\r
3667                         // no encoding specified: as per HTTP1.1 assume it is iso-8859-1?\r
3668                         // Both RFC 2616 (HTTP 1.1) and 1945 (HTTP 1.0) clearly state that for text/xxx content types\r
3669                         // this should be the standard. And we should be getting text/xml as request and response.\r
3670                         // BUT we have to be backward compatible with the lib, which always used UTF-8 as default...\r
3671                         return $GLOBALS['xmlrpc_defencoding'];\r
3672                 }\r
3673         }\r
3674 \r
3675         /**\r
3676         * Checks if a given charset encoding is present in a list of encodings or\r
3677         * if it is a valid subset of any encoding in the list\r
3678         * @param string $encoding charset to be tested\r
3679         * @param mixed $validlist comma separated list of valid charsets (or array of charsets)\r
3680         */\r
3681         function is_valid_charset($encoding, $validlist)\r
3682         {\r
3683                 $charset_supersets = array(\r
3684                         'US-ASCII' => array ('ISO-8859-1', 'ISO-8859-2', 'ISO-8859-3', 'ISO-8859-4',\r
3685                                 'ISO-8859-5', 'ISO-8859-6', 'ISO-8859-7', 'ISO-8859-8',\r
3686                                 'ISO-8859-9', 'ISO-8859-10', 'ISO-8859-11', 'ISO-8859-12',\r
3687                                 'ISO-8859-13', 'ISO-8859-14', 'ISO-8859-15', 'UTF-8',\r
3688                                 'EUC-JP', 'EUC-', 'EUC-KR', 'EUC-CN')\r
3689                 );\r
3690                 if (is_string($validlist))\r
3691                         $validlist = explode(',', $validlist);\r
3692                 if (@in_array(strtoupper($encoding), $validlist))\r
3693                         return true;\r
3694                 else\r
3695                 {\r
3696                         if (array_key_exists($encoding, $charset_supersets))\r
3697                                 foreach ($validlist as $allowed)\r
3698                                         if (in_array($allowed, $charset_supersets[$encoding]))\r
3699                                                 return true;\r
3700                                 return false;\r
3701                 }\r
3702         }\r
3703 \r
3704 ?>