lib/xmlrpc_wrappers.inc

   1 <?php\r
   2 /**\r
   3  * PHP-XMLRPC "wrapper" functions\r
   4  * Generate stubs to transparently access xmlrpc methods as php functions and viceversa\r
   5  *\r
   6  * @version $Id: xmlrpc_wrappers.inc,v 1.13 2008/09/20 01:23:47 ggiunta Exp $\r
   7  * @author Gaetano Giunta\r
   8  * @copyright (C) 2006-2009 G. Giunta\r
   9  * @license code licensed under the BSD License: http://phpxmlrpc.sourceforge.net/license.txt\r
  10  *\r
  11  * @todo separate introspection from code generation for func-2-method wrapping\r
  12  * @todo use some better templating system for code generation?\r
  13  * @todo implement method wrapping with preservation of php objs in calls\r
  14  * @todo when wrapping methods without obj rebuilding, use return_type = 'phpvals' (faster)\r
  15  * @todo implement self-parsing of php code for PHP <= 4\r
  16  */\r
  17 \r
  18         // requires: xmlrpc.inc\r
  19 \r
  20         /**\r
  21         * Given a string defining a php type or phpxmlrpc type (loosely defined: strings\r
  22         * accepted come from javadoc blocks), return corresponding phpxmlrpc type.\r
  23         * NB: for php 'resource' types returns empty string, since resources cannot be serialized;\r
  24         * for php class names returns 'struct', since php objects can be serialized as xmlrpc structs\r
  25         * @param string $phptype\r
  26         * @return string\r
  27         */\r
  28         function php_2_xmlrpc_type($phptype)\r
  29         {\r
  30                 switch(strtolower($phptype))\r
  31                 {\r
  32                         case 'string':\r
  33                                 return $GLOBALS['xmlrpcString'];\r
  34                         case 'integer':\r
  35                         case $GLOBALS['xmlrpcInt']: // 'int'\r
  36                         case $GLOBALS['xmlrpcI4']:\r
  37                                 return $GLOBALS['xmlrpcInt'];\r
  38                         case 'double':\r
  39                                 return $GLOBALS['xmlrpcDouble'];\r
  40                         case 'boolean':\r
  41                                 return $GLOBALS['xmlrpcBoolean'];\r
  42                         case 'array':\r
  43                                 return $GLOBALS['xmlrpcArray'];\r
  44                         case 'object':\r
  45                                 return $GLOBALS['xmlrpcStruct'];\r
  46                         case $GLOBALS['xmlrpcBase64']:\r
  47                         case $GLOBALS['xmlrpcStruct']:\r
  48                                 return strtolower($phptype);\r
  49                         case 'resource':\r
  50                                 return '';\r
  51                         default:\r
  52                                 if(class_exists($phptype))\r
  53                                 {\r
  54                                         return $GLOBALS['xmlrpcStruct'];\r
  55                                 }\r
  56                                 else\r
  57                                 {\r
  58                                         // unknown: might be any 'extended' xmlrpc type\r
  59                                         return $GLOBALS['xmlrpcValue'];\r
  60                                 }\r
  61                 }\r
  62         }\r
  63 \r
  64         /**\r
  65         * Given a string defining a phpxmlrpc type return corresponding php type.\r
  66         * @param string $xmlrpctype\r
  67         * @return string\r
  68         */\r
  69         function xmlrpc_2_php_type($xmlrpctype)\r
  70         {\r
  71                 switch(strtolower($xmlrpctype))\r
  72                 {\r
  73                         case 'base64':\r
  74                         case 'datetime.iso8601':\r
  75                         case 'string':\r
  76                                 return $GLOBALS['xmlrpcString'];\r
  77                         case 'int':\r
  78                         case 'i4':\r
  79                                 return 'integer';\r
  80                         case 'struct':\r
  81                         case 'array':\r
  82                                 return 'array';\r
  83                         case 'double':\r
  84                                 return 'float';\r
  85                         case 'undefined':\r
  86                                 return 'mixed';\r
  87                         case 'boolean':\r
  88                         case 'null':\r
  89                         default:\r
  90                                 // unknown: might be any xmlrpc type\r
  91                                 return strtolower($xmlrpctype);\r
  92                 }\r
  93         }\r
  94 \r
  95         /**\r
  96         * Given a user-defined PHP function, create a PHP 'wrapper' function that can\r
  97         * be exposed as xmlrpc method from an xmlrpc_server object and called from remote\r
  98         * clients (as well as its corresponding signature info).\r
  99         *\r
 100         * Since php is a typeless language, to infer types of input and output parameters,\r
 101         * it relies on parsing the javadoc-style comment block associated with the given\r
 102         * function. Usage of xmlrpc native types (such as datetime.dateTime.iso8601 and base64)\r
 103         * in the @param tag is also allowed, if you need the php function to receive/send\r
 104         * data in that particular format (note that base64 encoding/decoding is transparently\r
 105         * carried out by the lib, while datetime vals are passed around as strings)\r
 106         *\r
 107         * Known limitations:\r
 108         * - requires PHP 5.0.3 +\r
 109         * - only works for user-defined functions, not for PHP internal functions\r
 110         *   (reflection does not support retrieving number/type of params for those)\r
 111         * - functions returning php objects will generate special xmlrpc responses:\r
 112         *   when the xmlrpc decoding of those responses is carried out by this same lib, using\r
 113         *   the appropriate param in php_xmlrpc_decode, the php objects will be rebuilt.\r
 114         *   In short: php objects can be serialized, too (except for their resource members),\r
 115         *   using this function.\r
 116         *   Other libs might choke on the very same xml that will be generated in this case\r
 117         *   (i.e. it has a nonstandard attribute on struct element tags)\r
 118         * - usage of javadoc @param tags using param names in a different order from the\r
 119         *   function prototype is not considered valid (to be fixed?)\r
 120         *\r
 121         * Note that since rel. 2.0RC3 the preferred method to have the server call 'standard'\r
 122         * php functions (ie. functions not expecting a single xmlrpcmsg obj as parameter)\r
 123         * is by making use of the functions_parameters_type class member.\r
 124         *\r
 125         * @param string $funcname the name of the PHP user function to be exposed as xmlrpc method; array($obj, 'methodname') and array('class', 'methodname') are ok too\r
 126         * @param string $newfuncname (optional) name for function to be created\r
 127         * @param array $extra_options (optional) array of options for conversion. valid values include:\r
 128         *        bool  return_source when true, php code w. function definition will be returned, not evaluated\r
 129         *        bool  encode_php_objs let php objects be sent to server using the 'improved' xmlrpc notation, so server can deserialize them as php objects\r
 130         *        bool  decode_php_objs --- WARNING !!! possible security hazard. only use it with trusted servers ---\r
 131         *        bool  suppress_warnings  remove from produced xml any runtime warnings due to the php function being invoked\r
 132         * @return false on error, or an array containing the name of the new php function,\r
 133         *         its signature and docs, to be used in the server dispatch map\r
 134         *\r
 135         * @todo decide how to deal with params passed by ref: bomb out or allow?\r
 136         * @todo finish using javadoc info to build method sig if all params are named but out of order\r
 137         * @todo add a check for params of 'resource' type\r
 138         * @todo add some trigger_errors / error_log when returning false?\r
 139         * @todo what to do when the PHP function returns NULL? we are currently returning an empty string value...\r
 140         * @todo add an option to suppress php warnings in invocation of user function, similar to server debug level 3?\r
 141         * @todo if $newfuncname is empty, we could use create_user_func instead of eval, as it is possibly faster\r
 142         * @todo add a verbatim_object_copy parameter to allow avoiding the same obj instance?\r
 143         */\r
 144         function wrap_php_function($funcname, $newfuncname='', $extra_options=array())\r
 145         {\r
 146                 $buildit = isset($extra_options['return_source']) ? !($extra_options['return_source']) : true;\r
 147                 $prefix = isset($extra_options['prefix']) ? $extra_options['prefix'] : 'xmlrpc';\r
 148                 $encode_php_objects = isset($extra_options['encode_php_objs']) ? (bool)$extra_options['encode_php_objs'] : false;\r
 149                 $decode_php_objects = isset($extra_options['decode_php_objs']) ? (bool)$extra_options['decode_php_objs'] : false;\r
 150                 $catch_warnings = isset($extra_options['suppress_warnings']) && $extra_options['suppress_warnings'] ? '@' : '';\r
 151 \r
 152                 if(version_compare(phpversion(), '5.0.3') == -1)\r
 153                 {\r
 154                         // up to php 5.0.3 some useful reflection methods were missing\r
 155                         error_log('XML-RPC: cannot not wrap php functions unless running php version bigger than 5.0.3');\r
 156                         return false;\r
 157                 }\r
 158 \r
 159         $exists = false;\r
 160         if(is_array($funcname))\r
 161         {\r
 162             if(count($funcname) < 2 || (!is_string($funcname[0]) && !is_object($funcname[0])))\r
 163             {\r
 164                         error_log('XML-RPC: syntax for function to be wrapped is wrong');\r
 165                         return false;\r
 166             }\r
 167             if(is_string($funcname[0]))\r
 168             {\r
 169                 $plainfuncname = implode('::', $funcname);\r
 170             }\r
 171             elseif(is_object($funcname[0]))\r
 172             {\r
 173                 $plainfuncname = get_class($funcname[0]) . '->' . $funcname[1];\r
 174             }\r
 175             $exists = method_exists($funcname[0], $funcname[1]);\r
 176         }\r
 177         else\r
 178         {\r
 179             $plainfuncname = $funcname;\r
 180             $exists = function_exists($funcname);\r
 181         }\r
 182 \r
 183                 if(!$exists)\r
 184                 {\r
 185                         error_log('XML-RPC: function to be wrapped is not defined: '.$plainfuncname);\r
 186                         return false;\r
 187                 }\r
 188                 else\r
 189                 {\r
 190                         // determine name of new php function\r
 191                         if($newfuncname == '')\r
 192                         {\r
 193                                 if(is_array($funcname))\r
 194                                 {\r
 195                                 if(is_string($funcname[0]))\r
 196                                         $xmlrpcfuncname = "{$prefix}_".implode('_', $funcname);\r
 197                                 else\r
 198                                         $xmlrpcfuncname = "{$prefix}_".get_class($funcname[0]) . '_' . $funcname[1];\r
 199                                 }\r
 200                                 else\r
 201                                 {\r
 202                                         $xmlrpcfuncname = "{$prefix}_$funcname";\r
 203                                 }\r
 204                         }\r
 205                         else\r
 206                         {\r
 207                                 $xmlrpcfuncname = $newfuncname;\r
 208                         }\r
 209                         while($buildit && function_exists($xmlrpcfuncname))\r
 210                         {\r
 211                                 $xmlrpcfuncname .= 'x';\r
 212                         }\r
 213 \r
 214                         // start to introspect PHP code\r
 215                         if(is_array($funcname))\r
 216                         {\r
 217                         $func =& new ReflectionMethod($funcname[0], $funcname[1]);\r
 218                         if($func->isPrivate())\r
 219                         {\r
 220                                 error_log('XML-RPC: method to be wrapped is private: '.$plainfuncname);\r
 221                                 return false;\r
 222                         }\r
 223                         if($func->isProtected())\r
 224                         {\r
 225                                 error_log('XML-RPC: method to be wrapped is protected: '.$plainfuncname);\r
 226                                 return false;\r
 227                         }\r
 228                         if($func->isConstructor())\r
 229                         {\r
 230                                 error_log('XML-RPC: method to be wrapped is the constructor: '.$plainfuncname);\r
 231                                 return false;\r
 232                         }\r
 233                         if($func->isDestructor())\r
 234                         {\r
 235                                 error_log('XML-RPC: method to be wrapped is the destructor: '.$plainfuncname);\r
 236                                 return false;\r
 237                         }\r
 238                         if($func->isAbstract())\r
 239                         {\r
 240                                 error_log('XML-RPC: method to be wrapped is abstract: '.$plainfuncname);\r
 241                                 return false;\r
 242                         }\r
 243                 /// @todo add more checks for static vs. nonstatic?\r
 244             }\r
 245                         else\r
 246                         {\r
 247                         $func =& new ReflectionFunction($funcname);\r
 248             }\r
 249                         if($func->isInternal())\r
 250                         {\r
 251                                 // Note: from PHP 5.1.0 onward, we will possibly be able to use invokeargs\r
 252                                 // instead of getparameters to fully reflect internal php functions ?\r
 253                                 error_log('XML-RPC: function to be wrapped is internal: '.$plainfuncname);\r
 254                                 return false;\r
 255                         }\r
 256 \r
 257                         // retrieve parameter names, types and description from javadoc comments\r
 258 \r
 259                         // function description\r
 260                         $desc = '';\r
 261                         // type of return val: by default 'any'\r
 262                         $returns = $GLOBALS['xmlrpcValue'];\r
 263                         // desc of return val\r
 264                         $returnsDocs = '';\r
 265                         // type + name of function parameters\r
 266                         $paramDocs = array();\r
 267 \r
 268                         $docs = $func->getDocComment();\r
 269                         if($docs != '')\r
 270                         {\r
 271                                 $docs = explode("\n", $docs);\r
 272                                 $i = 0;\r
 273                                 foreach($docs as $doc)\r
 274                                 {\r
 275                                         $doc = trim($doc, " \r\t/*");\r
 276                                         if(strlen($doc) && strpos($doc, '@') !== 0 && !$i)\r
 277                                         {\r
 278                                                 if($desc)\r
 279                                                 {\r
 280                                                         $desc .= "\n";\r
 281                                                 }\r
 282                                                 $desc .= $doc;\r
 283                                         }\r
 284                                         elseif(strpos($doc, '@param') === 0)\r
 285                                         {\r
 286                                                 // syntax: @param type [$name] desc\r
 287                                                 if(preg_match('/@param\s+(\S+)(\s+\$\S+)?\s+(.+)/', $doc, $matches))\r
 288                                                 {\r
 289                                                         if(strpos($matches[1], '|'))\r
 290                                                         {\r
 291                                                                 //$paramDocs[$i]['type'] = explode('|', $matches[1]);\r
 292                                                                 $paramDocs[$i]['type'] = 'mixed';\r
 293                                                         }\r
 294                                                         else\r
 295                                                         {\r
 296                                                                 $paramDocs[$i]['type'] = $matches[1];\r
 297                                                         }\r
 298                                                         $paramDocs[$i]['name'] = trim($matches[2]);\r
 299                                                         $paramDocs[$i]['doc'] = $matches[3];\r
 300                                                 }\r
 301                                                 $i++;\r
 302                                         }\r
 303                                         elseif(strpos($doc, '@return') === 0)\r
 304                                         {\r
 305                                                 // syntax: @return type desc\r
 306                                                 //$returns = preg_split('/\s+/', $doc);\r
 307                                                 if(preg_match('/@return\s+(\S+)\s+(.+)/', $doc, $matches))\r
 308                                                 {\r
 309                                                         $returns = php_2_xmlrpc_type($matches[1]);\r
 310                                                         if(isset($matches[2]))\r
 311                                                         {\r
 312                                                                 $returnsDocs = $matches[2];\r
 313                                                         }\r
 314                                                 }\r
 315                                         }\r
 316                                 }\r
 317                         }\r
 318 \r
 319                         // execute introspection of actual function prototype\r
 320                         $params = array();\r
 321                         $i = 0;\r
 322                         foreach($func->getParameters() as $paramobj)\r
 323                         {\r
 324                                 $params[$i] = array();\r
 325                                 $params[$i]['name'] = '$'.$paramobj->getName();\r
 326                                 $params[$i]['isoptional'] = $paramobj->isOptional();\r
 327                                 $i++;\r
 328                         }\r
 329 \r
 330 \r
 331                         // start  building of PHP code to be eval'd\r
 332                         $innercode = '';\r
 333                         $i = 0;\r
 334                         $parsvariations = array();\r
 335                         $pars = array();\r
 336                         $pnum = count($params);\r
 337                         foreach($params as $param)\r
 338                         {\r
 339                                 if (isset($paramDocs[$i]['name']) && $paramDocs[$i]['name'] && strtolower($paramDocs[$i]['name']) != strtolower($param['name']))\r
 340                                 {\r
 341                                         // param name from phpdoc info does not match param definition!\r
 342                                         $paramDocs[$i]['type'] = 'mixed';\r
 343                                 }\r
 344 \r
 345                                 if($param['isoptional'])\r
 346                                 {\r
 347                                         // this particular parameter is optional. save as valid previous list of parameters\r
 348                                         $innercode .= "if (\$paramcount > $i) {\n";\r
 349                                         $parsvariations[] = $pars;\r
 350                                 }\r
 351                                 $innercode .= "\$p$i = \$msg->getParam($i);\n";\r
 352                                 if ($decode_php_objects)\r
 353                                 {\r
 354                                         $innercode .= "if (\$p{$i}->kindOf() == 'scalar') \$p$i = \$p{$i}->scalarval(); else \$p$i = php_{$prefix}_decode(\$p$i, array('decode_php_objs'));\n";\r
 355                                 }\r
 356                                 else\r
 357                                 {\r
 358                                         $innercode .= "if (\$p{$i}->kindOf() == 'scalar') \$p$i = \$p{$i}->scalarval(); else \$p$i = php_{$prefix}_decode(\$p$i);\n";\r
 359                                 }\r
 360 \r
 361                                 $pars[] = "\$p$i";\r
 362                                 $i++;\r
 363                                 if($param['isoptional'])\r
 364                                 {\r
 365                                         $innercode .= "}\n";\r
 366                                 }\r
 367                                 if($i == $pnum)\r
 368                                 {\r
 369                                         // last allowed parameters combination\r
 370                                         $parsvariations[] = $pars;\r
 371                                 }\r
 372                         }\r
 373 \r
 374                         $sigs = array();\r
 375                         $psigs = array();\r
 376                         if(count($parsvariations) == 0)\r
 377                         {\r
 378                                 // only known good synopsis = no parameters\r
 379                                 $parsvariations[] = array();\r
 380                                 $minpars = 0;\r
 381                         }\r
 382                         else\r
 383                         {\r
 384                                 $minpars = count($parsvariations[0]);\r
 385                         }\r
 386 \r
 387                         if($minpars)\r
 388                         {\r
 389                                 // add to code the check for min params number\r
 390                                 // NB: this check needs to be done BEFORE decoding param values\r
 391                                 $innercode = "\$paramcount = \$msg->getNumParams();\n" .\r
 392                                 "if (\$paramcount < $minpars) return new {$prefix}resp(0, {$GLOBALS['xmlrpcerr']['incorrect_params']}, '{$GLOBALS['xmlrpcstr']['incorrect_params']}');\n" . $innercode;\r
 393                         }\r
 394                         else\r
 395                         {\r
 396                                 $innercode = "\$paramcount = \$msg->getNumParams();\n" . $innercode;\r
 397                         }\r
 398 \r
 399                         $innercode .= "\$np = false;\n";\r
 400                         // since there are no closures in php, if we are given an object instance,\r
 401             // we store a pointer to it in a global var...\r
 402                         if ( is_array($funcname) && is_object($funcname[0]) )\r
 403                         {\r
 404                             $GLOBALS['xmlrpcWPFObjHolder'][$xmlrpcfuncname] =& $funcname[0];\r
 405                             $innercode .= "\$obj =& \$GLOBALS['xmlrpcWPFObjHolder']['$xmlrpcfuncname'];\n";\r
 406                             $realfuncname = '$obj->'.$funcname[1];\r
 407                         }\r
 408                         else\r
 409                         {\r
 410                         $realfuncname = $plainfuncname;\r
 411             }\r
 412                         foreach($parsvariations as $pars)\r
 413                         {\r
 414                                 $innercode .= "if (\$paramcount == " . count($pars) . ") \$retval = {$catch_warnings}$realfuncname(" . implode(',', $pars) . "); else\n";\r
 415                                 // build a 'generic' signature (only use an appropriate return type)\r
 416                                 $sig = array($returns);\r
 417                                 $psig = array($returnsDocs);\r
 418                                 for($i=0; $i < count($pars); $i++)\r
 419                                 {\r
 420                                         if (isset($paramDocs[$i]['type']))\r
 421                                         {\r
 422                                                 $sig[] = php_2_xmlrpc_type($paramDocs[$i]['type']);\r
 423                                         }\r
 424                                         else\r
 425                                         {\r
 426                                                 $sig[] = $GLOBALS['xmlrpcValue'];\r
 427                                         }\r
 428                                         $psig[] = isset($paramDocs[$i]['doc']) ? $paramDocs[$i]['doc'] : '';\r
 429                                 }\r
 430                                 $sigs[] = $sig;\r
 431                                 $psigs[] = $psig;\r
 432                         }\r
 433                         $innercode .= "\$np = true;\n";\r
 434                         $innercode .= "if (\$np) return new {$prefix}resp(0, {$GLOBALS['xmlrpcerr']['incorrect_params']}, '{$GLOBALS['xmlrpcstr']['incorrect_params']}'); else {\n";\r
 435                         //$innercode .= "if (\$_xmlrpcs_error_occurred) return new xmlrpcresp(0, $GLOBALS['xmlrpcerr']user, \$_xmlrpcs_error_occurred); else\n";\r
 436                         $innercode .= "if (is_a(\$retval, '{$prefix}resp')) return \$retval; else\n";\r
 437                         if($returns == $GLOBALS['xmlrpcDateTime'] || $returns == $GLOBALS['xmlrpcBase64'])\r
 438                         {\r
 439                                 $innercode .= "return new {$prefix}resp(new {$prefix}val(\$retval, '$returns'));";\r
 440                         }\r
 441                         else\r
 442                         {\r
 443                                 if ($encode_php_objects)\r
 444                                         $innercode .= "return new {$prefix}resp(php_{$prefix}_encode(\$retval, array('encode_php_objs')));\n";\r
 445                                 else\r
 446                                         $innercode .= "return new {$prefix}resp(php_{$prefix}_encode(\$retval));\n";\r
 447                         }\r
 448                         // shall we exclude functions returning by ref?\r
 449                         // if($func->returnsReference())\r
 450                         //      return false;\r
 451                         $code = "function $xmlrpcfuncname(\$msg) {\n" . $innercode . "}\n}";\r
 452                         //print_r($code);\r
 453                         if ($buildit)\r
 454                         {\r
 455                                 $allOK = 0;\r
 456                                 eval($code.'$allOK=1;');\r
 457                                 // alternative\r
 458                                 //$xmlrpcfuncname = create_function('$m', $innercode);\r
 459 \r
 460                                 if(!$allOK)\r
 461                                 {\r
 462                                         error_log('XML-RPC: could not create function '.$xmlrpcfuncname.' to wrap php function '.$plainfuncname);\r
 463                                         return false;\r
 464                                 }\r
 465                         }\r
 466 \r
 467                         /// @todo examine if $paramDocs matches $parsvariations and build array for\r
 468                         /// usage as method signature, plus put together a nice string for docs\r
 469 \r
 470                         $ret = array('function' => $xmlrpcfuncname, 'signature' => $sigs, 'docstring' => $desc, 'signature_docs' => $psigs, 'source' => $code);\r
 471                         return $ret;\r
 472                 }\r
 473         }\r
 474 \r
 475     /**\r
 476     * Given a user-defined PHP class or php object, map its methods onto a list of\r
 477         * PHP 'wrapper' functions that can be exposed as xmlrpc methods from an xmlrpc_server\r
 478         * object and called from remote clients (as well as their corresponding signature info).\r
 479         *\r
 480     * @param mixed $classname the name of the class whose methods are to be exposed as xmlrpc methods, or an object instance of that class\r
 481     * @param array $extra_options see the docs for wrap_php_method for more options\r
 482     *        string method_type 'static', 'nonstatic', 'all' and 'auto' (default); the latter will switch between static and non-static depending on wheter $classname is a class name or object instance\r
 483     * @return array or false on failure\r
 484     *\r
 485     * @todo get_class_methods will return both static and non-static methods.\r
 486     *       we have to differentiate the action, depending on wheter we recived a class name or object\r
 487     */\r
 488     function wrap_php_class($classname, $extra_options=array())\r
 489     {\r
 490                 $methodfilter = isset($extra_options['method_filter']) ? $extra_options['method_filter'] : '';\r
 491                 $methodtype = isset($extra_options['method_type']) ? $extra_options['method_type'] : 'auto';\r
 492 \r
 493         if(version_compare(phpversion(), '5.0.3') == -1)\r
 494                 {\r
 495                         // up to php 5.0.3 some useful reflection methods were missing\r
 496                         error_log('XML-RPC: cannot not wrap php functions unless running php version bigger than 5.0.3');\r
 497                         return false;\r
 498                 }\r
 499 \r
 500         $result = array();\r
 501                 $mlist = get_class_methods($classname);\r
 502                 foreach($mlist as $mname)\r
 503                 {\r
 504                 if ($methodfilter == '' || preg_match($methodfilter, $mname))\r
 505                         {\r
 506                         // echo $mlist."\n";\r
 507                         $func =& new ReflectionMethod($classname, $mname);\r
 508                         if(!$func->isPrivate() && !$func->isProtected() && !$func->isConstructor() && !$func->isDestructor() && !$func->isAbstract())\r
 509                         {\r
 510                                 if(($func->isStatic && ($methodtype == 'all' || $methodtype == 'static' || ($methodtype == 'auto' && is_string($classname)))) ||\r
 511                                 (!$func->isStatic && ($methodtype == 'all' || $methodtype == 'nonstatic' || ($methodtype == 'auto' && is_object($classname)))))\r
 512                         {\r
 513                         $methodwrap = wrap_php_function(array($classname, $mname), '', $extra_options);\r
 514                         if ( $methodwrap )\r
 515                         {\r
 516                             $result[$methodwrap['function']] = $methodwrap['function'];\r
 517                         }\r
 518                     }\r
 519                         }\r
 520                         }\r
 521                 }\r
 522         return $result;\r
 523     }\r
 524 \r
 525         /**\r
 526         * Given an xmlrpc client and a method name, register a php wrapper function\r
 527         * that will call it and return results using native php types for both\r
 528         * params and results. The generated php function will return an xmlrpcresp\r
 529         * oject for failed xmlrpc calls\r
 530         *\r
 531         * Known limitations:\r
 532         * - server must support system.methodsignature for the wanted xmlrpc method\r
 533         * - for methods that expose many signatures, only one can be picked (we\r
 534         *   could in priciple check if signatures differ only by number of params\r
 535         *   and not by type, but it would be more complication than we can spare time)\r
 536         * - nested xmlrpc params: the caller of the generated php function has to\r
 537         *   encode on its own the params passed to the php function if these are structs\r
 538         *   or arrays whose (sub)members include values of type datetime or base64\r
 539         *\r
 540         * Notes: the connection properties of the given client will be copied\r
 541         * and reused for the connection used during the call to the generated\r
 542         * php function.\r
 543         * Calling the generated php function 'might' be slow: a new xmlrpc client\r
 544         * is created on every invocation and an xmlrpc-connection opened+closed.\r
 545         * An extra 'debug' param is appended to param list of xmlrpc method, useful\r
 546         * for debugging purposes.\r
 547         *\r
 548         * @param xmlrpc_client $client     an xmlrpc client set up correctly to communicate with target server\r
 549         * @param string        $methodname the xmlrpc method to be mapped to a php function\r
 550         * @param array         $extra_options array of options that specify conversion details. valid ptions include\r
 551         *        integer       signum      the index of the method signature to use in mapping (if method exposes many sigs)\r
 552         *        integer       timeout     timeout (in secs) to be used when executing function/calling remote method\r
 553         *        string        protocol    'http' (default), 'http11' or 'https'\r
 554         *        string        new_function_name the name of php function to create. If unsepcified, lib will pick an appropriate name\r
 555         *        string        return_source if true return php code w. function definition instead fo function name\r
 556         *        bool          encode_php_objs let php objects be sent to server using the 'improved' xmlrpc notation, so server can deserialize them as php objects\r
 557         *        bool          decode_php_objs --- WARNING !!! possible security hazard. only use it with trusted servers ---\r
 558         *        mixed         return_on_fault a php value to be returned when the xmlrpc call fails/returns a fault response (by default the xmlrpcresp object is returned in this case). If a string is used, '%faultCode%' and '%faultString%' tokens will be substituted with actual error values\r
 559         *        bool          debug        set it to 1 or 2 to see debug results of querying server for method synopsis\r
 560         * @return string                   the name of the generated php function (or false) - OR AN ARRAY...\r
 561         */\r
 562         function wrap_xmlrpc_method($client, $methodname, $extra_options=0, $timeout=0, $protocol='', $newfuncname='')\r
 563         {\r
 564                 // mind numbing: let caller use sane calling convention (as per javadoc, 3 params),\r
 565                 // OR the 2.0 calling convention (no options) - we really love backward compat, don't we?\r
 566                 if (!is_array($extra_options))\r
 567                 {\r
 568                         $signum = $extra_options;\r
 569                         $extra_options = array();\r
 570                 }\r
 571                 else\r
 572                 {\r
 573                         $signum = isset($extra_options['signum']) ? (int)$extra_options['signum'] : 0;\r
 574                         $timeout = isset($extra_options['timeout']) ? (int)$extra_options['timeout'] : 0;\r
 575                         $protocol = isset($extra_options['protocol']) ? $extra_options['protocol'] : '';\r
 576                         $newfuncname = isset($extra_options['new_function_name']) ? $extra_options['new_function_name'] : '';\r
 577                 }\r
 578                 //$encode_php_objects = in_array('encode_php_objects', $extra_options);\r
 579                 //$verbatim_client_copy = in_array('simple_client_copy', $extra_options) ? 1 :\r
 580                 //      in_array('build_class_code', $extra_options) ? 2 : 0;\r
 581 \r
 582                 $encode_php_objects = isset($extra_options['encode_php_objs']) ? (bool)$extra_options['encode_php_objs'] : false;\r
 583                 $decode_php_objects = isset($extra_options['decode_php_objs']) ? (bool)$extra_options['decode_php_objs'] : false;\r
 584                 $simple_client_copy = isset($extra_options['simple_client_copy']) ? (int)($extra_options['simple_client_copy']) : 0;\r
 585                 $buildit = isset($extra_options['return_source']) ? !($extra_options['return_source']) : true;\r
 586                 $prefix = isset($extra_options['prefix']) ? $extra_options['prefix'] : 'xmlrpc';\r
 587                 if (isset($extra_options['return_on_fault']))\r
 588                 {\r
 589                         $decode_fault = true;\r
 590                         $fault_response = $extra_options['return_on_fault'];\r
 591                 }\r
 592                 else\r
 593                 {\r
 594                         $decode_fault = false;\r
 595                         $fault_response = '';\r
 596                 }\r
 597                 $debug = isset($extra_options['debug']) ? ($extra_options['debug']) : 0;\r
 598 \r
 599                 $msgclass = $prefix.'msg';\r
 600                 $valclass = $prefix.'val';\r
 601                 $decodefunc = 'php_'.$prefix.'_decode';\r
 602 \r
 603                 $msg =& new $msgclass('system.methodSignature');\r
 604                 $msg->addparam(new $valclass($methodname));\r
 605                 $client->setDebug($debug);\r
 606                 $response =& $client->send($msg, $timeout, $protocol);\r
 607                 if($response->faultCode())\r
 608                 {\r
 609                         error_log('XML-RPC: could not retrieve method signature from remote server for method '.$methodname);\r
 610                         return false;\r
 611                 }\r
 612                 else\r
 613                 {\r
 614                         $msig = $response->value();\r
 615                         if ($client->return_type != 'phpvals')\r
 616                         {\r
 617                                 $msig = $decodefunc($msig);\r
 618                         }\r
 619                         if(!is_array($msig) || count($msig) <= $signum)\r
 620                         {\r
 621                                 error_log('XML-RPC: could not retrieve method signature nr.'.$signum.' from remote server for method '.$methodname);\r
 622                                 return false;\r
 623                         }\r
 624                         else\r
 625                         {\r
 626                                 // pick a suitable name for the new function, avoiding collisions\r
 627                                 if($newfuncname != '')\r
 628                                 {\r
 629                                         $xmlrpcfuncname = $newfuncname;\r
 630                                 }\r
 631                                 else\r
 632                                 {\r
 633                                         // take care to insure that methodname is translated to valid\r
 634                                         // php function name\r
 635                                         $xmlrpcfuncname = $prefix.'_'.preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'),\r
 636                                                 array('_', ''), $methodname);\r
 637                                 }\r
 638                                 while($buildit && function_exists($xmlrpcfuncname))\r
 639                                 {\r
 640                                         $xmlrpcfuncname .= 'x';\r
 641                                 }\r
 642 \r
 643                                 $msig = $msig[$signum];\r
 644                                 $mdesc = '';\r
 645                                 // if in 'offline' mode, get method description too.\r
 646                                 // in online mode, favour speed of operation\r
 647                                 if(!$buildit)\r
 648                                 {\r
 649                                         $msg =& new $msgclass('system.methodHelp');\r
 650                                         $msg->addparam(new $valclass($methodname));\r
 651                                         $response =& $client->send($msg, $timeout, $protocol);\r
 652                                         if (!$response->faultCode())\r
 653                                         {\r
 654                                                 $mdesc = $response->value();\r
 655                                                 if ($client->return_type != 'phpvals')\r
 656                                                 {\r
 657                                                         $mdesc = $mdesc->scalarval();\r
 658                                                 }\r
 659                                         }\r
 660                                 }\r
 661 \r
 662                                 $results = build_remote_method_wrapper_code($client, $methodname,\r
 663                                         $xmlrpcfuncname, $msig, $mdesc, $timeout, $protocol, $simple_client_copy,\r
 664                                         $prefix, $decode_php_objects, $encode_php_objects, $decode_fault,\r
 665                                         $fault_response);\r
 666 \r
 667                                 //print_r($code);\r
 668                                 if ($buildit)\r
 669                                 {\r
 670                                         $allOK = 0;\r
 671                                         eval($results['source'].'$allOK=1;');\r
 672                                         // alternative\r
 673                                         //$xmlrpcfuncname = create_function('$m', $innercode);\r
 674                                         if($allOK)\r
 675                                         {\r
 676                                                 return $xmlrpcfuncname;\r
 677                                         }\r
 678                                         else\r
 679                                         {\r
 680                                                 error_log('XML-RPC: could not create function '.$xmlrpcfuncname.' to wrap remote method '.$methodname);\r
 681                                                 return false;\r
 682                                         }\r
 683                                 }\r
 684                                 else\r
 685                                 {\r
 686                                         $results['function'] = $xmlrpcfuncname;\r
 687                                         return $results;\r
 688                                 }\r
 689                         }\r
 690                 }\r
 691         }\r
 692 \r
 693         /**\r
 694         * Similar to wrap_xmlrpc_method, but will generate a php class that wraps\r
 695         * all xmlrpc methods exposed by the remote server as own methods.\r
 696         * For more details see wrap_xmlrpc_method.\r
 697         * @param xmlrpc_client $client the client obj all set to query the desired server\r
 698         * @param array $extra_options list of options for wrapped code\r
 699         * @return mixed false on error, the name of the created class if all ok or an array with code, class name and comments (if the appropriatevoption is set in extra_options)\r
 700         */\r
 701         function wrap_xmlrpc_server($client, $extra_options=array())\r
 702         {\r
 703                 $methodfilter = isset($extra_options['method_filter']) ? $extra_options['method_filter'] : '';\r
 704                 //$signum = isset($extra_options['signum']) ? (int)$extra_options['signum'] : 0;\r
 705                 $timeout = isset($extra_options['timeout']) ? (int)$extra_options['timeout'] : 0;\r
 706                 $protocol = isset($extra_options['protocol']) ? $extra_options['protocol'] : '';\r
 707                 $newclassname = isset($extra_options['new_class_name']) ? $extra_options['new_class_name'] : '';\r
 708                 $encode_php_objects = isset($extra_options['encode_php_objs']) ? (bool)$extra_options['encode_php_objs'] : false;\r
 709                 $decode_php_objects = isset($extra_options['decode_php_objs']) ? (bool)$extra_options['decode_php_objs'] : false;\r
 710                 $verbatim_client_copy = isset($extra_options['simple_client_copy']) ? !($extra_options['simple_client_copy']) : true;\r
 711                 $buildit = isset($extra_options['return_source']) ? !($extra_options['return_source']) : true;\r
 712                 $prefix = isset($extra_options['prefix']) ? $extra_options['prefix'] : 'xmlrpc';\r
 713 \r
 714                 $msgclass = $prefix.'msg';\r
 715                 //$valclass = $prefix.'val';\r
 716                 $decodefunc = 'php_'.$prefix.'_decode';\r
 717 \r
 718                 $msg =& new $msgclass('system.listMethods');\r
 719                 $response =& $client->send($msg, $timeout, $protocol);\r
 720                 if($response->faultCode())\r
 721                 {\r
 722                         error_log('XML-RPC: could not retrieve method list from remote server');\r
 723                         return false;\r
 724                 }\r
 725                 else\r
 726                 {\r
 727                         $mlist = $response->value();\r
 728                         if ($client->return_type != 'phpvals')\r
 729                         {\r
 730                                 $mlist = $decodefunc($mlist);\r
 731                         }\r
 732                         if(!is_array($mlist) || !count($mlist))\r
 733                         {\r
 734                                 error_log('XML-RPC: could not retrieve meaningful method list from remote server');\r
 735                                 return false;\r
 736                         }\r
 737                         else\r
 738                         {\r
 739                                 // pick a suitable name for the new function, avoiding collisions\r
 740                                 if($newclassname != '')\r
 741                                 {\r
 742                                         $xmlrpcclassname = $newclassname;\r
 743                                 }\r
 744                                 else\r
 745                                 {\r
 746                                         $xmlrpcclassname = $prefix.'_'.preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'),\r
 747                                                 array('_', ''), $client->server).'_client';\r
 748                                 }\r
 749                                 while($buildit && class_exists($xmlrpcclassname))\r
 750                                 {\r
 751                                         $xmlrpcclassname .= 'x';\r
 752                                 }\r
 753 \r
 754                                 /// @todo add function setdebug() to new class, to enable/disable debugging\r
 755                                 $source = "class $xmlrpcclassname\n{\nvar \$client;\n\n";\r
 756                                 $source .= "function $xmlrpcclassname()\n{\n";\r
 757                                 $source .= build_client_wrapper_code($client, $verbatim_client_copy, $prefix);\r
 758                                 $source .= "\$this->client =& \$client;\n}\n\n";\r
 759                                 $opts = array('simple_client_copy' => 2, 'return_source' => true,\r
 760                                         'timeout' => $timeout, 'protocol' => $protocol,\r
 761                                         'encode_php_objs' => $encode_php_objects, 'prefix' => $prefix,\r
 762                                         'decode_php_objs' => $decode_php_objects\r
 763                                         );\r
 764                                 /// @todo build javadoc for class definition, too\r
 765                                 foreach($mlist as $mname)\r
 766                                 {\r
 767                                         if ($methodfilter == '' || preg_match($methodfilter, $mname))\r
 768                                         {\r
 769                                                 $opts['new_function_name'] = preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'),\r
 770                                                         array('_', ''), $mname);\r
 771                                                 $methodwrap = wrap_xmlrpc_method($client, $mname, $opts);\r
 772                                                 if ($methodwrap)\r
 773                                                 {\r
 774                                                         if (!$buildit)\r
 775                                                         {\r
 776                                                                 $source .= $methodwrap['docstring'];\r
 777                                                         }\r
 778                                                         $source .= $methodwrap['source']."\n";\r
 779                                                 }\r
 780                                                 else\r
 781                                                 {\r
 782                                                         error_log('XML-RPC: will not create class method to wrap remote method '.$mname);\r
 783                                                 }\r
 784                                         }\r
 785                                 }\r
 786                                 $source .= "}\n";\r
 787                                 if ($buildit)\r
 788                                 {\r
 789                                         $allOK = 0;\r
 790                                         eval($source.'$allOK=1;');\r
 791                                         // alternative\r
 792                                         //$xmlrpcfuncname = create_function('$m', $innercode);\r
 793                                         if($allOK)\r
 794                                         {\r
 795                                                 return $xmlrpcclassname;\r
 796                                         }\r
 797                                         else\r
 798                                         {\r
 799                                                 error_log('XML-RPC: could not create class '.$xmlrpcclassname.' to wrap remote server '.$client->server);\r
 800                                                 return false;\r
 801                                         }\r
 802                                 }\r
 803                                 else\r
 804                                 {\r
 805                                         return array('class' => $xmlrpcclassname, 'code' => $source, 'docstring' => '');\r
 806                                 }\r
 807                         }\r
 808                 }\r
 809         }\r
 810 \r
 811         /**\r
 812         * Given the necessary info, build php code that creates a new function to\r
 813         * invoke a remote xmlrpc method.\r
 814         * Take care that no full checking of input parameters is done to ensure that\r
 815         * valid php code is emitted.\r
 816         * Note: real spaghetti code follows...\r
 817         * @access private\r
 818         */\r
 819         function build_remote_method_wrapper_code($client, $methodname, $xmlrpcfuncname,\r
 820                 $msig, $mdesc='', $timeout=0, $protocol='', $client_copy_mode=0, $prefix='xmlrpc',\r
 821                 $decode_php_objects=false, $encode_php_objects=false, $decode_fault=false,\r
 822                 $fault_response='')\r
 823         {\r
 824                 $code = "function $xmlrpcfuncname (";\r
 825                 if ($client_copy_mode < 2)\r
 826                 {\r
 827                         // client copy mode 0 or 1 == partial / full client copy in emitted code\r
 828                         $innercode = build_client_wrapper_code($client, $client_copy_mode, $prefix);\r
 829                         $innercode .= "\$client->setDebug(\$debug);\n";\r
 830                         $this_ = '';\r
 831                 }\r
 832                 else\r
 833                 {\r
 834                         // client copy mode 2 == no client copy in emitted code\r
 835                         $innercode = '';\r
 836                         $this_ = 'this->';\r
 837                 }\r
 838                 $innercode .= "\$msg =& new {$prefix}msg('$methodname');\n";\r
 839 \r
 840                 if ($mdesc != '')\r
 841                 {\r
 842                         // take care that PHP comment is not terminated unwillingly by method description\r
 843                         $mdesc = "/**\n* ".str_replace('*/', '* /', $mdesc)."\n";\r
 844                 }\r
 845                 else\r
 846                 {\r
 847                         $mdesc = "/**\nFunction $xmlrpcfuncname\n";\r
 848                 }\r
 849 \r
 850                 // param parsing\r
 851                 $plist = array();\r
 852                 $pcount = count($msig);\r
 853                 for($i = 1; $i < $pcount; $i++)\r
 854                 {\r
 855                         $plist[] = "\$p$i";\r
 856                         $ptype = $msig[$i];\r
 857                         if($ptype == 'i4' || $ptype == 'int' || $ptype == 'boolean' || $ptype == 'double' ||\r
 858                                 $ptype == 'string' || $ptype == 'dateTime.iso8601' || $ptype == 'base64' || $ptype == 'null')\r
 859                         {\r
 860                                 // only build directly xmlrpcvals when type is known and scalar\r
 861                                 $innercode .= "\$p$i =& new {$prefix}val(\$p$i, '$ptype');\n";\r
 862                         }\r
 863                         else\r
 864                         {\r
 865                                 if ($encode_php_objects)\r
 866                                 {\r
 867                                         $innercode .= "\$p$i =& php_{$prefix}_encode(\$p$i, array('encode_php_objs'));\n";\r
 868                                 }\r
 869                                 else\r
 870                                 {\r
 871                                         $innercode .= "\$p$i =& php_{$prefix}_encode(\$p$i);\n";\r
 872                                 }\r
 873                         }\r
 874                         $innercode .= "\$msg->addparam(\$p$i);\n";\r
 875                         $mdesc .= '* @param '.xmlrpc_2_php_type($ptype)." \$p$i\n";\r
 876                 }\r
 877                 if ($client_copy_mode < 2)\r
 878                 {\r
 879                         $plist[] = '$debug=0';\r
 880                         $mdesc .= "* @param int \$debug when 1 (or 2) will enable debugging of the underlying {$prefix} call (defaults to 0)\n";\r
 881                 }\r
 882                 $plist = implode(', ', $plist);\r
 883                 $mdesc .= '* @return '.xmlrpc_2_php_type($msig[0])." (or an {$prefix}resp obj instance if call fails)\n*/\n";\r
 884 \r
 885                 $innercode .= "\$res =& \${$this_}client->send(\$msg, $timeout, '$protocol');\n";\r
 886                 if ($decode_fault)\r
 887                 {\r
 888                         if (is_string($fault_response) && ((strpos($fault_response, '%faultCode%') !== false) || (strpos($fault_response, '%faultString%') !== false)))\r
 889                         {\r
 890                                 $respcode = "str_replace(array('%faultCode%', '%faultString%'), array(\$res->faultCode(), \$res->faultString()), '".str_replace("'", "''", $fault_response)."')";\r
 891                         }\r
 892                         else\r
 893                         {\r
 894                                 $respcode = var_export($fault_response, true);\r
 895                         }\r
 896                 }\r
 897                 else\r
 898                 {\r
 899                         $respcode = '$res';\r
 900                 }\r
 901                 if ($decode_php_objects)\r
 902                 {\r
 903                         $innercode .= "if (\$res->faultcode()) return $respcode; else return php_{$prefix}_decode(\$res->value(), array('decode_php_objs'));";\r
 904                 }\r
 905                 else\r
 906                 {\r
 907                         $innercode .= "if (\$res->faultcode()) return $respcode; else return php_{$prefix}_decode(\$res->value());";\r
 908                 }\r
 909 \r
 910                 $code = $code . $plist. ") {\n" . $innercode . "\n}\n";\r
 911 \r
 912                 return array('source' => $code, 'docstring' => $mdesc);\r
 913         }\r
 914 \r
 915         /**\r
 916         * Given necessary info, generate php code that will rebuild a client object\r
 917         * Take care that no full checking of input parameters is done to ensure that\r
 918         * valid php code is emitted.\r
 919         * @access private\r
 920         */\r
 921         function build_client_wrapper_code($client, $verbatim_client_copy, $prefix='xmlrpc')\r
 922         {\r
 923                 $code = "\$client =& new {$prefix}_client('".str_replace("'", "\'", $client->path).\r
 924                         "', '" . str_replace("'", "\'", $client->server) . "', $client->port);\n";\r
 925 \r
 926                 // copy all client fields to the client that will be generated runtime\r
 927                 // (this provides for future expansion or subclassing of client obj)\r
 928                 if ($verbatim_client_copy)\r
 929                 {\r
 930                         foreach($client as $fld => $val)\r
 931                         {\r
 932                                 if($fld != 'debug' && $fld != 'return_type')\r
 933                                 {\r
 934                                         $val = var_export($val, true);\r
 935                                         $code .= "\$client->$fld = $val;\n";\r
 936                                 }\r
 937                         }\r
 938                 }\r
 939                 // only make sure that client always returns the correct data type\r
 940                 $code .= "\$client->return_type = '{$prefix}vals';\n";\r
 941                 //$code .= "\$client->setDebug(\$debug);\n";\r
 942                 return $code;\r
 943         }\r
 944 ?>