src/Wrapper.php

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