3 * @author Gaetano Giunta
4 * @copyright (C) 2006-2020 G. Giunta
5 * @license code licensed under the BSD License: see file license.txt
10 use PhpXmlRpc\Helper\Logger;
13 * PHP-XMLRPC "wrapper" class - generate stubs to transparently access xmlrpc methods as php functions and vice-versa.
14 * Note: this class implements the PROXY pattern, but it is not named so to avoid confusion with http proxies.
16 * @todo use some better templating system for code generation?
17 * @todo implement method wrapping with preservation of php objs in calls
18 * @todo when wrapping methods without obj rebuilding, use return_type = 'phpvals' (faster)
22 /// used to hold a reference to object instances whose methods get wrapped by wrapPhpFunction(), in 'create source' mode
23 public static $objHolder = array();
26 * Given a string defining a php type or phpxmlrpc type (loosely defined: strings
27 * accepted come from javadoc blocks), return corresponding phpxmlrpc type.
29 * - for php 'resource' types returns empty string, since resources cannot be serialized;
30 * - for php class names returns 'struct', since php objects can be serialized as xmlrpc structs
31 * - for php arrays always return array, even though arrays sometimes serialize as json structs
32 * - for 'void' and 'null' returns 'undefined'
34 * @param string $phpType
38 public function php2XmlrpcType($phpType)
40 switch (strtolower($phpType)) {
42 return Value::$xmlrpcString;
44 case Value::$xmlrpcInt: // 'int'
45 case Value::$xmlrpcI4:
46 case Value::$xmlrpcI8:
47 return Value::$xmlrpcInt;
48 case Value::$xmlrpcDouble: // 'double'
49 return Value::$xmlrpcDouble;
51 case Value::$xmlrpcBoolean: // 'boolean'
54 return Value::$xmlrpcBoolean;
55 case Value::$xmlrpcArray: // 'array':
56 return Value::$xmlrpcArray;
58 case Value::$xmlrpcStruct: // 'struct'
59 return Value::$xmlrpcStruct;
60 case Value::$xmlrpcBase64:
61 return Value::$xmlrpcBase64;
65 if (class_exists($phpType)) {
66 return Value::$xmlrpcStruct;
68 // unknown: might be any 'extended' xmlrpc type
69 return Value::$xmlrpcValue;
75 * Given a string defining a phpxmlrpc type return the corresponding php type.
77 * @param string $xmlrpcType
81 public function xmlrpc2PhpType($xmlrpcType)
83 switch (strtolower($xmlrpcType)) {
85 case 'datetime.iso8601':
87 return Value::$xmlrpcString;
102 // unknown: might be any xmlrpc type
103 return strtolower($xmlrpcType);
108 * Given a user-defined PHP function, create a PHP 'wrapper' function that can
109 * be exposed as xmlrpc method from an xmlrpc server object and called from remote
110 * clients (as well as its corresponding signature info).
112 * Since php is a typeless language, to infer types of input and output parameters,
113 * it relies on parsing the javadoc-style comment block associated with the given
114 * function. Usage of xmlrpc native types (such as datetime.dateTime.iso8601 and base64)
115 * in the '@param' tag is also allowed, if you need the php function to receive/send
116 * data in that particular format (note that base64 encoding/decoding is transparently
117 * carried out by the lib, while datetime vals are passed around as strings)
120 * - only works for user-defined functions, not for PHP internal functions
121 * (reflection does not support retrieving number/type of params for those)
122 * - functions returning php objects will generate special structs in xmlrpc responses:
123 * when the xmlrpc decoding of those responses is carried out by this same lib, using
124 * the appropriate param in php_xmlrpc_decode, the php objects will be rebuilt.
125 * In short: php objects can be serialized, too (except for their resource members),
126 * using this function.
127 * Other libs might choke on the very same xml that will be generated in this case
128 * (i.e. it has a nonstandard attribute on struct element tags)
130 * Note that since rel. 2.0RC3 the preferred method to have the server call 'standard'
131 * php functions (ie. functions not expecting a single Request obj as parameter)
132 * is by making use of the functions_parameters_type class member.
134 * @param callable $callable the PHP user function to be exposed as xmlrpc method/ a closure, function name, array($obj, 'methodname') or array('class', 'methodname') are ok
135 * @param string $newFuncName (optional) name for function to be created. Used only when return_source in $extraOptions is true
136 * @param array $extraOptions (optional) array of options for conversion. valid values include:
137 * - bool return_source when true, php code w. function definition will be returned, instead of a closure
138 * - bool encode_php_objs let php objects be sent to server using the 'improved' xmlrpc notation, so server can deserialize them as php objects
139 * - bool decode_php_objs --- WARNING !!! possible security hazard. only use it with trusted servers ---
140 * - bool suppress_warnings remove from produced xml any warnings generated at runtime by the php function being invoked
142 * @return array|false false on error, or an array containing the name of the new php function,
143 * its signature and docs, to be used in the server dispatch map
145 * @todo decide how to deal with params passed by ref in function definition: bomb out or allow?
146 * @todo finish using phpdoc info to build method sig if all params are named but out of order
147 * @todo add a check for params of 'resource' type
148 * @todo add some trigger_errors / error_log when returning false?
149 * @todo what to do when the PHP function returns NULL? We are currently returning an empty string value...
150 * @todo add an option to suppress php warnings in invocation of user function, similar to server debug level 3?
151 * @todo add a verbatim_object_copy parameter to allow avoiding usage the same obj instance?
152 * @todo add an option to allow generated function to skip validation of number of parameters, as that is done by the server anyway
154 public function wrapPhpFunction($callable, $newFuncName = '', $extraOptions = array())
156 $buildIt = isset($extraOptions['return_source']) ? !($extraOptions['return_source']) : true;
158 if (is_string($callable) && strpos($callable, '::') !== false) {
159 $callable = explode('::', $callable);
161 if (is_array($callable)) {
162 if (count($callable) < 2 || (!is_string($callable[0]) && !is_object($callable[0]))) {
163 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': syntax for function to be wrapped is wrong');
166 if (is_string($callable[0])) {
167 $plainFuncName = implode('::', $callable);
168 } elseif (is_object($callable[0])) {
169 $plainFuncName = get_class($callable[0]) . '->' . $callable[1];
171 $exists = method_exists($callable[0], $callable[1]);
172 } else if ($callable instanceof \Closure) {
173 // we do not support creating code which wraps closures, as php does not allow to serialize them
175 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': a closure can not be wrapped in generated source code');
179 $plainFuncName = 'Closure';
182 $plainFuncName = $callable;
183 $exists = function_exists($callable);
187 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': function to be wrapped is not defined: ' . $plainFuncName);
191 $funcDesc = $this->introspectFunction($callable, $plainFuncName);
196 $funcSigs = $this->buildMethodSignatures($funcDesc);
199 $callable = $this->buildWrapFunctionClosure($callable, $extraOptions, $plainFuncName, $funcDesc);
201 $newFuncName = $this->newFunctionName($callable, $newFuncName, $extraOptions);
202 $code = $this->buildWrapFunctionSource($callable, $newFuncName, $extraOptions, $plainFuncName, $funcDesc);
206 'function' => $callable,
207 'signature' => $funcSigs['sigs'],
208 'docstring' => $funcDesc['desc'],
209 'signature_docs' => $funcSigs['sigsDocs'],
212 $ret['function'] = $newFuncName;
213 $ret['source'] = $code;
219 * Introspect a php callable and its phpdoc block and extract information about its signature
221 * @param callable $callable
222 * @param string $plainFuncName
223 * @return array|false
225 protected function introspectFunction($callable, $plainFuncName)
227 // start to introspect PHP code
228 if (is_array($callable)) {
229 $func = new \ReflectionMethod($callable[0], $callable[1]);
230 if ($func->isPrivate()) {
231 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': method to be wrapped is private: ' . $plainFuncName);
234 if ($func->isProtected()) {
235 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': method to be wrapped is protected: ' . $plainFuncName);
238 if ($func->isConstructor()) {
239 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': method to be wrapped is the constructor: ' . $plainFuncName);
242 if ($func->isDestructor()) {
243 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': method to be wrapped is the destructor: ' . $plainFuncName);
246 if ($func->isAbstract()) {
247 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': method to be wrapped is abstract: ' . $plainFuncName);
250 /// @todo add more checks for static vs. nonstatic?
252 $func = new \ReflectionFunction($callable);
254 if ($func->isInternal()) {
255 // Note: from PHP 5.1.0 onward, we will possibly be able to use invokeargs
256 // instead of getparameters to fully reflect internal php functions ?
257 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': function to be wrapped is internal: ' . $plainFuncName);
261 // retrieve parameter names, types and description from javadoc comments
263 // function description
265 // type of return val: by default 'any'
266 $returns = Value::$xmlrpcValue;
267 // desc of return val
269 // type + name of function parameters
270 $paramDocs = array();
272 $docs = $func->getDocComment();
274 $docs = explode("\n", $docs);
276 foreach ($docs as $doc) {
277 $doc = trim($doc, " \r\t/*");
278 if (strlen($doc) && strpos($doc, '@') !== 0 && !$i) {
283 } elseif (strpos($doc, '@param') === 0) {
284 // syntax: @param type $name [desc]
285 if (preg_match('/@param\s+(\S+)\s+(\$\S+)\s*(.+)?/', $doc, $matches)) {
286 $name = strtolower(trim($matches[2]));
287 //$paramDocs[$name]['name'] = trim($matches[2]);
288 $paramDocs[$name]['doc'] = isset($matches[3]) ? $matches[3] : '';
289 $paramDocs[$name]['type'] = $matches[1];
292 } elseif (strpos($doc, '@return') === 0) {
293 // syntax: @return type [desc]
294 if (preg_match('/@return\s+(\S+)(\s+.+)?/', $doc, $matches)) {
295 $returns = $matches[1];
296 if (isset($matches[2])) {
297 $returnsDocs = trim($matches[2]);
304 // execute introspection of actual function prototype
307 foreach ($func->getParameters() as $paramObj) {
308 $params[$i] = array();
309 $params[$i]['name'] = '$' . $paramObj->getName();
310 $params[$i]['isoptional'] = $paramObj->isOptional();
317 'params' => $params, // array, positionally indexed
318 'paramDocs' => $paramDocs, // array, indexed by name
319 'returns' => $returns,
320 'returnsDocs' =>$returnsDocs,
325 * Given the method description given by introspection, create method signature data
327 * @todo support better docs with multiple types separated by pipes by creating multiple signatures
328 * (this is questionable, as it might produce a big matrix of possible signatures with many such occurrences)
330 * @param array $funcDesc as generated by self::introspectFunction()
334 protected function buildMethodSignatures($funcDesc)
337 $parsVariations = array();
339 $pNum = count($funcDesc['params']);
340 foreach ($funcDesc['params'] as $param) {
341 /* // match by name real param and documented params
342 $name = strtolower($param['name']);
343 if (!isset($funcDesc['paramDocs'][$name])) {
344 $funcDesc['paramDocs'][$name] = array();
346 if (!isset($funcDesc['paramDocs'][$name]['type'])) {
347 $funcDesc['paramDocs'][$name]['type'] = 'mixed';
350 if ($param['isoptional']) {
351 // this particular parameter is optional. save as valid previous list of parameters
352 $parsVariations[] = $pars;
358 // last allowed parameters combination
359 $parsVariations[] = $pars;
363 if (count($parsVariations) == 0) {
364 // only known good synopsis = no parameters
365 $parsVariations[] = array();
370 foreach ($parsVariations as $pars) {
372 $sig = array($this->php2XmlrpcType($funcDesc['returns']));
373 $pSig = array($funcDesc['returnsDocs']);
374 for ($i = 0; $i < count($pars); $i++) {
375 $name = strtolower($funcDesc['params'][$i]['name']);
376 if (isset($funcDesc['paramDocs'][$name]['type'])) {
377 $sig[] = $this->php2XmlrpcType($funcDesc['paramDocs'][$name]['type']);
379 $sig[] = Value::$xmlrpcValue;
381 $pSig[] = isset($funcDesc['paramDocs'][$name]['doc']) ? $funcDesc['paramDocs'][$name]['doc'] : '';
389 'sigsDocs' => $sigsDocs
394 * Creates a closure that will execute $callable
395 * @todo validate params? In theory all validation is left to the dispatch map...
396 * @todo add support for $catchWarnings
399 * @param array $extraOptions
400 * @param string $plainFuncName
401 * @param array $funcDesc
404 protected function buildWrapFunctionClosure($callable, $extraOptions, $plainFuncName, $funcDesc)
407 * @param Request $req
410 $function = function($req) use($callable, $extraOptions, $funcDesc)
412 $nameSpace = '\\PhpXmlRpc\\';
413 $encoderClass = $nameSpace.'Encoder';
414 $responseClass = $nameSpace.'Response';
415 $valueClass = $nameSpace.'Value';
417 // validate number of parameters received
418 // this should be optional really, as we assume the server does the validation
419 $minPars = count($funcDesc['params']);
421 foreach ($funcDesc['params'] as $i => $param) {
422 if ($param['isoptional']) {
423 // this particular parameter is optional. We assume later ones are as well
428 $numPars = $req->getNumParams();
429 if ($numPars < $minPars || $numPars > $maxPars) {
430 return new $responseClass(0, 3, 'Incorrect parameters passed to method');
433 $encoder = new $encoderClass();
435 if (isset($extraOptions['decode_php_objs']) && $extraOptions['decode_php_objs']) {
436 $options[] = 'decode_php_objs';
438 $params = $encoder->decode($req, $options);
440 $result = call_user_func_array($callable, $params);
442 if (! is_a($result, $responseClass)) {
443 if ($funcDesc['returns'] == Value::$xmlrpcDateTime || $funcDesc['returns'] == Value::$xmlrpcBase64) {
444 $result = new $valueClass($result, $funcDesc['returns']);
447 if (isset($extraOptions['encode_php_objs']) && $extraOptions['encode_php_objs']) {
448 $options[] = 'encode_php_objs';
451 $result = $encoder->encode($result, $options);
453 $result = new $responseClass($result);
463 * Return a name for a new function, based on $callable, insuring its uniqueness
464 * @param mixed $callable a php callable, or the name of an xmlrpc method
465 * @param string $newFuncName when not empty, it is used instead of the calculated version
468 protected function newFunctionName($callable, $newFuncName, $extraOptions)
470 // determine name of new php function
472 $prefix = isset($extraOptions['prefix']) ? $extraOptions['prefix'] : 'xmlrpc';
474 if ($newFuncName == '') {
475 if (is_array($callable)) {
476 if (is_string($callable[0])) {
477 $xmlrpcFuncName = "{$prefix}_" . implode('_', $callable);
479 $xmlrpcFuncName = "{$prefix}_" . get_class($callable[0]) . '_' . $callable[1];
482 if ($callable instanceof \Closure) {
483 $xmlrpcFuncName = "{$prefix}_closure";
485 $callable = preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'),
486 array('_', ''), $callable);
487 $xmlrpcFuncName = "{$prefix}_$callable";
491 $xmlrpcFuncName = $newFuncName;
494 while (function_exists($xmlrpcFuncName)) {
495 $xmlrpcFuncName .= 'x';
498 return $xmlrpcFuncName;
503 * @param string $newFuncName
504 * @param array $extraOptions
505 * @param string $plainFuncName
506 * @param array $funcDesc
509 * @todo add a nice phpdoc block in the generated source
511 protected function buildWrapFunctionSource($callable, $newFuncName, $extraOptions, $plainFuncName, $funcDesc)
513 $namespace = '\\PhpXmlRpc\\';
515 $encodePhpObjects = isset($extraOptions['encode_php_objs']) ? (bool)$extraOptions['encode_php_objs'] : false;
516 $decodePhpObjects = isset($extraOptions['decode_php_objs']) ? (bool)$extraOptions['decode_php_objs'] : false;
517 $catchWarnings = isset($extraOptions['suppress_warnings']) && $extraOptions['suppress_warnings'] ? '@' : '';
520 $parsVariations = array();
522 $pNum = count($funcDesc['params']);
523 foreach ($funcDesc['params'] as $param) {
525 if ($param['isoptional']) {
526 // this particular parameter is optional. save as valid previous list of parameters
527 $parsVariations[] = $pars;
533 // last allowed parameters combination
534 $parsVariations[] = $pars;
538 if (count($parsVariations) == 0) {
539 // only known good synopsis = no parameters
540 $parsVariations[] = array();
544 $minPars = count($parsVariations[0]);
545 $maxPars = count($parsVariations[count($parsVariations)-1]);
548 // build body of new function
550 $innerCode = "\$paramCount = \$req->getNumParams();\n";
551 $innerCode .= "if (\$paramCount < $minPars || \$paramCount > $maxPars) return new {$namespace}Response(0, " . PhpXmlRpc::$xmlrpcerr['incorrect_params'] . ", '" . PhpXmlRpc::$xmlrpcstr['incorrect_params'] . "');\n";
553 $innerCode .= "\$encoder = new {$namespace}Encoder();\n";
554 if ($decodePhpObjects) {
555 $innerCode .= "\$p = \$encoder->decode(\$req, array('decode_php_objs'));\n";
557 $innerCode .= "\$p = \$encoder->decode(\$req);\n";
560 // since we are building source code for later use, if we are given an object instance,
561 // we go out of our way and store a pointer to it in a static class var var...
562 if (is_array($callable) && is_object($callable[0])) {
563 self::$objHolder[$newFuncName] = $callable[0];
564 $innerCode .= "\$obj = PhpXmlRpc\\Wrapper::\$objHolder['$newFuncName'];\n";
565 $realFuncName = '$obj->' . $callable[1];
567 $realFuncName = $plainFuncName;
569 foreach ($parsVariations as $i => $pars) {
570 $innerCode .= "if (\$paramCount == " . count($pars) . ") \$retval = {$catchWarnings}$realFuncName(" . implode(',', $pars) . ");\n";
571 if ($i < (count($parsVariations) - 1))
572 $innerCode .= "else\n";
574 $innerCode .= "if (is_a(\$retval, '{$namespace}Response')) return \$retval; else\n";
575 if ($funcDesc['returns'] == Value::$xmlrpcDateTime || $funcDesc['returns'] == Value::$xmlrpcBase64) {
576 $innerCode .= "return new {$namespace}Response(new {$namespace}Value(\$retval, '{$funcDesc['returns']}'));";
578 if ($encodePhpObjects) {
579 $innerCode .= "return new {$namespace}Response(\$encoder->encode(\$retval, array('encode_php_objs')));\n";
581 $innerCode .= "return new {$namespace}Response(\$encoder->encode(\$retval));\n";
584 // shall we exclude functions returning by ref?
585 // if($func->returnsReference())
588 $code = "function $newFuncName(\$req) {\n" . $innerCode . "\n}";
594 * Given a user-defined PHP class or php object, map its methods onto a list of
595 * PHP 'wrapper' functions that can be exposed as xmlrpc methods from an xmlrpc server
596 * object and called from remote clients (as well as their corresponding signature info).
598 * @param string|object $className the name of the class whose methods are to be exposed as xmlrpc methods, or an object instance of that class
599 * @param array $extraOptions see the docs for wrapPhpMethod for basic options, plus
600 * - 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
601 * - string method_filter a regexp used to filter methods to wrap based on their names
602 * - string prefix used for the names of the xmlrpc methods created
604 * @return array|false false on failure
606 public function wrapPhpClass($className, $extraOptions = array())
608 $methodFilter = isset($extraOptions['method_filter']) ? $extraOptions['method_filter'] : '';
609 $methodType = isset($extraOptions['method_type']) ? $extraOptions['method_type'] : 'auto';
610 $prefix = isset($extraOptions['prefix']) ? $extraOptions['prefix'] : '';
613 $mList = get_class_methods($className);
614 foreach ($mList as $mName) {
615 if ($methodFilter == '' || preg_match($methodFilter, $mName)) {
616 $func = new \ReflectionMethod($className, $mName);
617 if (!$func->isPrivate() && !$func->isProtected() && !$func->isConstructor() && !$func->isDestructor() && !$func->isAbstract()) {
618 if (($func->isStatic() && ($methodType == 'all' || $methodType == 'static' || ($methodType == 'auto' && is_string($className)))) ||
619 (!$func->isStatic() && ($methodType == 'all' || $methodType == 'nonstatic' || ($methodType == 'auto' && is_object($className))))
621 $methodWrap = $this->wrapPhpFunction(array($className, $mName), '', $extraOptions);
623 if (is_object($className)) {
624 $realClassName = get_class($className);
626 $realClassName = $className;
628 $results[$prefix."$realClassName.$mName"] = $methodWrap;
639 * Given an xmlrpc client and a method name, register a php wrapper function
640 * that will call it and return results using native php types for both
641 * params and results. The generated php function will return a Response
642 * object for failed xmlrpc calls.
645 * - server must support system.methodsignature for the wanted xmlrpc method
646 * - for methods that expose many signatures, only one can be picked (we
647 * could in principle check if signatures differ only by number of params
648 * and not by type, but it would be more complication than we can spare time)
649 * - nested xmlrpc params: the caller of the generated php function has to
650 * encode on its own the params passed to the php function if these are structs
651 * or arrays whose (sub)members include values of type datetime or base64
653 * Notes: the connection properties of the given client will be copied
654 * and reused for the connection used during the call to the generated
656 * Calling the generated php function 'might' be slow: a new xmlrpc client
657 * is created on every invocation and an xmlrpc-connection opened+closed.
658 * An extra 'debug' param is appended to param list of xmlrpc method, useful
659 * for debugging purposes.
661 * @todo allow caller to give us the method signature instead of querying for it, or just say 'skip it'
662 * @todo if we can not retrieve method signature, create a php function with varargs
663 * @todo allow the created function to throw exceptions on method calls failures
664 * @todo if caller did not specify a specific sig, shall we support all of them?
665 * It might be hard (hence slow) to match based on type and number of arguments...
667 * @param Client $client an xmlrpc client set up correctly to communicate with target server
668 * @param string $methodName the xmlrpc method to be mapped to a php function
669 * @param array $extraOptions array of options that specify conversion details. Valid options include
670 * - integer signum the index of the method signature to use in mapping (if method exposes many sigs)
671 * - integer timeout timeout (in secs) to be used when executing function/calling remote method
672 * - string protocol 'http' (default), 'http11' or 'https'
673 * - string new_function_name the name of php function to create, when return_source is used. If unspecified, lib will pick an appropriate name
674 * - string return_source if true return php code w. function definition instead of function itself (closure)
675 * - bool encode_php_objs let php objects be sent to server using the 'improved' xmlrpc notation, so server can deserialize them as php objects
676 * - bool decode_php_objs --- WARNING !!! possible security hazard. only use it with trusted servers ---
677 * - 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
678 * - bool debug set it to 1 or 2 to see debug results of querying server for method synopsis
679 * - int simple_client_copy set it to 1 to have a lightweight copy of the $client object made in the generated code (only used when return_source = true)
681 * @return \closure|string[]|false false on failure, closure by default and array for return_source = true
683 public function wrapXmlrpcMethod($client, $methodName, $extraOptions = array())
685 $newFuncName = isset($extraOptions['new_function_name']) ? $extraOptions['new_function_name'] : '';
687 $buildIt = isset($extraOptions['return_source']) ? !($extraOptions['return_source']) : true;
689 $mSig = $this->retrieveMethodSignature($client, $methodName, $extraOptions);
695 return $this->buildWrapMethodClosure($client, $methodName, $extraOptions, $mSig);
697 // if in 'offline' mode, retrieve method description too.
698 // in online mode, favour speed of operation
699 $mDesc = $this->retrieveMethodHelp($client, $methodName, $extraOptions);
701 $newFuncName = $this->newFunctionName($methodName, $newFuncName, $extraOptions);
703 $results = $this->buildWrapMethodSource($client, $methodName, $extraOptions, $newFuncName, $mSig, $mDesc);
704 /* was: $results = $this->build_remote_method_wrapper_code($client, $methodName,
705 $newFuncName, $mSig, $mDesc, $timeout, $protocol, $simpleClientCopy,
706 $prefix, $decodePhpObjects, $encodePhpObjects, $decodeFault,
707 $faultResponse, $namespace);*/
709 $results['function'] = $newFuncName;
717 * Retrieves an xmlrpc method signature from a server which supports system.methodSignature
718 * @param Client $client
719 * @param string $methodName
720 * @param array $extraOptions
721 * @return false|array
723 protected function retrieveMethodSignature($client, $methodName, array $extraOptions = array())
725 $namespace = '\\PhpXmlRpc\\';
726 $reqClass = $namespace . 'Request';
727 $valClass = $namespace . 'Value';
728 $decoderClass = $namespace . 'Encoder';
730 $debug = isset($extraOptions['debug']) ? ($extraOptions['debug']) : 0;
731 $timeout = isset($extraOptions['timeout']) ? (int)$extraOptions['timeout'] : 0;
732 $protocol = isset($extraOptions['protocol']) ? $extraOptions['protocol'] : '';
733 $sigNum = isset($extraOptions['signum']) ? (int)$extraOptions['signum'] : 0;
735 $req = new $reqClass('system.methodSignature');
736 $req->addparam(new $valClass($methodName));
737 $client->setDebug($debug);
738 $response = $client->send($req, $timeout, $protocol);
739 if ($response->faultCode()) {
740 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': could not retrieve method signature from remote server for method ' . $methodName);
744 $mSig = $response->value();
745 if ($client->return_type != 'phpvals') {
746 $decoder = new $decoderClass();
747 $mSig = $decoder->decode($mSig);
750 if (!is_array($mSig) || count($mSig) <= $sigNum) {
751 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': could not retrieve method signature nr.' . $sigNum . ' from remote server for method ' . $methodName);
755 return $mSig[$sigNum];
759 * @param Client $client
760 * @param string $methodName
761 * @param array $extraOptions
762 * @return string in case of any error, an empty string is returned, no warnings generated
764 protected function retrieveMethodHelp($client, $methodName, array $extraOptions = array())
766 $namespace = '\\PhpXmlRpc\\';
767 $reqClass = $namespace . 'Request';
768 $valClass = $namespace . 'Value';
770 $debug = isset($extraOptions['debug']) ? ($extraOptions['debug']) : 0;
771 $timeout = isset($extraOptions['timeout']) ? (int)$extraOptions['timeout'] : 0;
772 $protocol = isset($extraOptions['protocol']) ? $extraOptions['protocol'] : '';
776 $req = new $reqClass('system.methodHelp');
777 $req->addparam(new $valClass($methodName));
778 $client->setDebug($debug);
779 $response = $client->send($req, $timeout, $protocol);
780 if (!$response->faultCode()) {
781 $mDesc = $response->value();
782 if ($client->return_type != 'phpvals') {
783 $mDesc = $mDesc->scalarval();
791 * @param Client $client
792 * @param string $methodName
793 * @param array $extraOptions
797 * @todo should we allow usage of parameter simple_client_copy to mean 'do not clone' in this case?
799 protected function buildWrapMethodClosure($client, $methodName, array $extraOptions, $mSig)
801 // we clone the client, so that we can modify it a bit independently of the original
802 $clientClone = clone $client;
803 $function = function() use($clientClone, $methodName, $extraOptions, $mSig)
805 $timeout = isset($extraOptions['timeout']) ? (int)$extraOptions['timeout'] : 0;
806 $protocol = isset($extraOptions['protocol']) ? $extraOptions['protocol'] : '';
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 if (isset($extraOptions['return_on_fault'])) {
811 $faultResponse = $extraOptions['return_on_fault'];
813 $decodeFault = false;
816 $namespace = '\\PhpXmlRpc\\';
817 $reqClass = $namespace . 'Request';
818 $encoderClass = $namespace . 'Encoder';
819 $valueClass = $namespace . 'Value';
821 $encoder = new $encoderClass();
822 $encodeOptions = array();
823 if ($encodePhpObjects) {
824 $encodeOptions[] = 'encode_php_objs';
826 $decodeOptions = array();
827 if ($decodePhpObjects) {
828 $decodeOptions[] = 'decode_php_objs';
831 /// @todo check for insufficient nr. of args besides excess ones? note that 'source' version does not...
833 // support one extra parameter: debug
834 $maxArgs = count($mSig)-1; // 1st element is the return type
835 $currentArgs = func_get_args();
836 if (func_num_args() == ($maxArgs+1)) {
837 $debug = array_pop($currentArgs);
838 $clientClone->setDebug($debug);
841 $xmlrpcArgs = array();
842 foreach($currentArgs as $i => $arg) {
843 if ($i == $maxArgs) {
846 $pType = $mSig[$i+1];
847 if ($pType == 'i4' || $pType == 'i8' || $pType == 'int' || $pType == 'boolean' || $pType == 'double' ||
848 $pType == 'string' || $pType == 'dateTime.iso8601' || $pType == 'base64' || $pType == 'null'
850 // by building directly xmlrpc values when type is known and scalar (instead of encode() calls),
851 // we make sure to honour the xmlrpc signature
852 $xmlrpcArgs[] = new $valueClass($arg, $pType);
854 $xmlrpcArgs[] = $encoder->encode($arg, $encodeOptions);
858 $req = new $reqClass($methodName, $xmlrpcArgs);
859 // use this to get the maximum decoding flexibility
860 $clientClone->return_type = 'xmlrpcvals';
861 $resp = $clientClone->send($req, $timeout, $protocol);
862 if ($resp->faultcode()) {
864 if (is_string($faultResponse) && ((strpos($faultResponse, '%faultCode%') !== false) ||
865 (strpos($faultResponse, '%faultString%') !== false))) {
866 $faultResponse = str_replace(array('%faultCode%', '%faultString%'),
867 array($resp->faultCode(), $resp->faultString()), $faultResponse);
869 return $faultResponse;
874 return $encoder->decode($resp->value(), $decodeOptions);
882 * @param Client $client
883 * @param string $methodName
884 * @param array $extraOptions
885 * @param string $newFuncName
887 * @param string $mDesc
888 * @return string[] keys: source, docstring
890 public function buildWrapMethodSource($client, $methodName, array $extraOptions, $newFuncName, $mSig, $mDesc='')
892 $timeout = isset($extraOptions['timeout']) ? (int)$extraOptions['timeout'] : 0;
893 $protocol = isset($extraOptions['protocol']) ? $extraOptions['protocol'] : '';
894 $encodePhpObjects = isset($extraOptions['encode_php_objs']) ? (bool)$extraOptions['encode_php_objs'] : false;
895 $decodePhpObjects = isset($extraOptions['decode_php_objs']) ? (bool)$extraOptions['decode_php_objs'] : false;
896 $clientCopyMode = isset($extraOptions['simple_client_copy']) ? (int)($extraOptions['simple_client_copy']) : 0;
897 $prefix = isset($extraOptions['prefix']) ? $extraOptions['prefix'] : 'xmlrpc';
898 if (isset($extraOptions['return_on_fault'])) {
900 $faultResponse = $extraOptions['return_on_fault'];
902 $decodeFault = false;
906 $namespace = '\\PhpXmlRpc\\';
908 $code = "function $newFuncName (";
909 if ($clientCopyMode < 2) {
910 // client copy mode 0 or 1 == full / partial client copy in emitted code
911 $verbatimClientCopy = !$clientCopyMode;
912 $innerCode = $this->buildClientWrapperCode($client, $verbatimClientCopy, $prefix, $namespace);
913 $innerCode .= "\$client->setDebug(\$debug);\n";
916 // client copy mode 2 == no client copy in emitted code
920 $innerCode .= "\$req = new {$namespace}Request('$methodName');\n";
923 // take care that PHP comment is not terminated unwillingly by method description
924 $mDesc = "/**\n* " . str_replace('*/', '* /', $mDesc) . "\n";
926 $mDesc = "/**\nFunction $newFuncName\n";
930 $innerCode .= "\$encoder = new {$namespace}Encoder();\n";
932 $pCount = count($mSig);
933 for ($i = 1; $i < $pCount; $i++) {
936 if ($pType == 'i4' || $pType == 'i8' || $pType == 'int' || $pType == 'boolean' || $pType == 'double' ||
937 $pType == 'string' || $pType == 'dateTime.iso8601' || $pType == 'base64' || $pType == 'null'
939 // only build directly xmlrpc values when type is known and scalar
940 $innerCode .= "\$p$i = new {$namespace}Value(\$p$i, '$pType');\n";
942 if ($encodePhpObjects) {
943 $innerCode .= "\$p$i = \$encoder->encode(\$p$i, array('encode_php_objs'));\n";
945 $innerCode .= "\$p$i = \$encoder->encode(\$p$i);\n";
948 $innerCode .= "\$req->addparam(\$p$i);\n";
949 $mDesc .= '* @param ' . $this->xmlrpc2PhpType($pType) . " \$p$i\n";
951 if ($clientCopyMode < 2) {
952 $plist[] = '$debug=0';
953 $mDesc .= "* @param int \$debug when 1 (or 2) will enable debugging of the underlying {$prefix} call (defaults to 0)\n";
955 $plist = implode(', ', $plist);
956 $mDesc .= '* @return ' . $this->xmlrpc2PhpType($mSig[0]) . " (or an {$namespace}Response obj instance if call fails)\n*/\n";
958 $innerCode .= "\$res = \${$this_}client->send(\$req, $timeout, '$protocol');\n";
960 if (is_string($faultResponse) && ((strpos($faultResponse, '%faultCode%') !== false) || (strpos($faultResponse, '%faultString%') !== false))) {
961 $respCode = "str_replace(array('%faultCode%', '%faultString%'), array(\$res->faultCode(), \$res->faultString()), '" . str_replace("'", "''", $faultResponse) . "')";
963 $respCode = var_export($faultResponse, true);
968 if ($decodePhpObjects) {
969 $innerCode .= "if (\$res->faultcode()) return $respCode; else return \$encoder->decode(\$res->value(), array('decode_php_objs'));";
971 $innerCode .= "if (\$res->faultcode()) return $respCode; else return \$encoder->decode(\$res->value());";
974 $code = $code . $plist . ") {\n" . $innerCode . "\n}\n";
976 return array('source' => $code, 'docstring' => $mDesc);
980 * Similar to wrapXmlrpcMethod, but will generate a php class that wraps
981 * all xmlrpc methods exposed by the remote server as own methods.
982 * For more details see wrapXmlrpcMethod.
984 * For a slimmer alternative, see the code in demo/client/proxy.php
986 * Note that unlike wrapXmlrpcMethod, we always have to generate php code here. It seems that php 7 will have anon classes...
988 * @param Client $client the client obj all set to query the desired server
989 * @param array $extraOptions list of options for wrapped code. See the ones from wrapXmlrpcMethod plus
990 * - string method_filter regular expression
991 * - string new_class_name
993 * - bool simple_client_copy set it to true to avoid copying all properties of $client into the copy made in the new class
995 * @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 appropriate option is set in extra_options)
997 public function wrapXmlrpcServer($client, $extraOptions = array())
999 $methodFilter = isset($extraOptions['method_filter']) ? $extraOptions['method_filter'] : '';
1000 $timeout = isset($extraOptions['timeout']) ? (int)$extraOptions['timeout'] : 0;
1001 $protocol = isset($extraOptions['protocol']) ? $extraOptions['protocol'] : '';
1002 $newClassName = isset($extraOptions['new_class_name']) ? $extraOptions['new_class_name'] : '';
1003 $encodePhpObjects = isset($extraOptions['encode_php_objs']) ? (bool)$extraOptions['encode_php_objs'] : false;
1004 $decodePhpObjects = isset($extraOptions['decode_php_objs']) ? (bool)$extraOptions['decode_php_objs'] : false;
1005 $verbatimClientCopy = isset($extraOptions['simple_client_copy']) ? !($extraOptions['simple_client_copy']) : true;
1006 $buildIt = isset($extraOptions['return_source']) ? !($extraOptions['return_source']) : true;
1007 $prefix = isset($extraOptions['prefix']) ? $extraOptions['prefix'] : 'xmlrpc';
1008 $namespace = '\\PhpXmlRpc\\';
1010 $reqClass = $namespace . 'Request';
1011 $decoderClass = $namespace . 'Encoder';
1013 $req = new $reqClass('system.listMethods');
1014 $response = $client->send($req, $timeout, $protocol);
1015 if ($response->faultCode()) {
1016 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': could not retrieve method list from remote server');
1020 $mList = $response->value();
1021 if ($client->return_type != 'phpvals') {
1022 $decoder = new $decoderClass();
1023 $mList = $decoder->decode($mList);
1025 if (!is_array($mList) || !count($mList)) {
1026 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': could not retrieve meaningful method list from remote server');
1030 // pick a suitable name for the new function, avoiding collisions
1031 if ($newClassName != '') {
1032 $xmlrpcClassName = $newClassName;
1034 $xmlrpcClassName = $prefix . '_' . preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'),
1035 array('_', ''), $client->server) . '_client';
1037 while ($buildIt && class_exists($xmlrpcClassName)) {
1038 $xmlrpcClassName .= 'x';
1041 /// @todo add function setdebug() to new class, to enable/disable debugging
1042 $source = "class $xmlrpcClassName\n{\npublic \$client;\n\n";
1043 $source .= "function __construct()\n{\n";
1044 $source .= $this->buildClientWrapperCode($client, $verbatimClientCopy, $prefix, $namespace);
1045 $source .= "\$this->client = \$client;\n}\n\n";
1047 'return_source' => true,
1048 'simple_client_copy' => 2, // do not produce code to copy the client object
1049 'timeout' => $timeout,
1050 'protocol' => $protocol,
1051 'encode_php_objs' => $encodePhpObjects,
1052 'decode_php_objs' => $decodePhpObjects,
1053 'prefix' => $prefix,
1055 /// @todo build phpdoc for class definition, too
1056 foreach ($mList as $mName) {
1057 if ($methodFilter == '' || preg_match($methodFilter, $mName)) {
1058 // note: this will fail if server exposes 2 methods called f.e. do.something and do_something
1059 $opts['new_function_name'] = preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'),
1060 array('_', ''), $mName);
1061 $methodWrap = $this->wrapXmlrpcMethod($client, $mName, $opts);
1064 $source .= $methodWrap['docstring'];
1066 $source .= $methodWrap['source'] . "\n";
1068 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': will not create class method to wrap remote method ' . $mName);
1075 eval($source . '$allOK=1;');
1077 return $xmlrpcClassName;
1079 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': could not create class ' . $xmlrpcClassName . ' to wrap remote server ' . $client->server);
1083 return array('class' => $xmlrpcClassName, 'code' => $source, 'docstring' => '');
1090 * Given necessary info, generate php code that will build a client object just like the given one.
1091 * Take care that no full checking of input parameters is done to ensure that
1092 * valid php code is emitted.
1093 * @param Client $client
1094 * @param bool $verbatimClientCopy when true, copy all of the state of the client, except for 'debug' and 'return_type'
1095 * @param string $prefix used for the return_type of the created client
1096 * @param string $namespace
1100 protected function buildClientWrapperCode($client, $verbatimClientCopy, $prefix = 'xmlrpc', $namespace = '\\PhpXmlRpc\\' )
1102 $code = "\$client = new {$namespace}Client('" . str_replace("'", "\'", $client->path) .
1103 "', '" . str_replace("'", "\'", $client->server) . "', $client->port);\n";
1105 // copy all client fields to the client that will be generated runtime
1106 // (this provides for future expansion or subclassing of client obj)
1107 if ($verbatimClientCopy) {
1108 foreach ($client as $fld => $val) {
1109 /// @todo in php 8.0, curl handles became objects, but they have no __set_state, thus var_export will
1110 /// fail for xmlrpc_curl_handle. So we disabled copying it.
1111 /// We should examine in depth if this change can have side effects - at first sight if the
1112 /// client's curl handle is not set, all curl options are (re)set on each http call, so there
1113 /// should be no loss of state...
1114 if ($fld != 'debug' && $fld != 'return_type' && $fld != 'xmlrpc_curl_handle') {
1115 $val = var_export($val, true);
1116 $code .= "\$client->$fld = $val;\n";
1120 // only make sure that client always returns the correct data type
1121 $code .= "\$client->return_type = '{$prefix}vals';\n";
1122 //$code .= "\$client->setDebug(\$debug);\n";