X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=src%2FWrapper.php;h=6cd2538cd0c6ea1f2faceaf79a8963cadcc427c8;hb=749bcf1b412822e08dbcab366cfbf7ad1cb77db0;hp=71abda58f2dc4b2ec92c24e94b8d76acfec5abae;hpb=779732528b1a39798fbebc2443ea8f2e0b562e3f;p=plcapi.git diff --git a/src/Wrapper.php b/src/Wrapper.php index 71abda5..6cd2538 100644 --- a/src/Wrapper.php +++ b/src/Wrapper.php @@ -12,7 +12,6 @@ namespace PhpXmlRpc; * Generate stubs to transparently access xmlrpc methods as php functions and vice-versa. * Note: this class implements the PROXY pattern, but it is not named so to avoid confusion with http proxies. * - * @todo separate introspection from code generation for func-2-method wrapping * @todo use some better templating system for code generation? * @todo implement method wrapping with preservation of php objs in calls * @todo when wrapping methods without obj rebuilding, use return_type = 'phpvals' (faster) @@ -123,295 +122,468 @@ class Wrapper * php functions (ie. functions not expecting a single Request obj as parameter) * is by making use of the functions_parameters_type class member. * - * @param string $funcName the name of the PHP user function to be exposed as xmlrpc method; array($obj, 'methodname') and array('class', 'methodname') are ok too - * @param string $newFuncName (optional) name for function to be created + * @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 + * @param string $newFuncName (optional) name for function to be created. Used only when return_source in $extraOptions is true * @param array $extraOptions (optional) array of options for conversion. valid values include: - * bool return_source when true, php code w. function definition will be returned, not evaluated - * bool encode_php_objs let php objects be sent to server using the 'improved' xmlrpc notation, so server can deserialize them as php objects - * bool decode_php_objs --- WARNING !!! possible security hazard. only use it with trusted servers --- - * bool suppress_warnings remove from produced xml any runtime warnings due to the php function being invoked + * bool return_source when true, php code w. function definition will be returned, not evaluated + * bool encode_php_objs let php objects be sent to server using the 'improved' xmlrpc notation, so server can deserialize them as php objects + * bool decode_php_objs --- WARNING !!! possible security hazard. only use it with trusted servers --- + * bool suppress_warnings remove from produced xml any runtime warnings due to the php function being invoked * - * @return false on error, or an array containing the name of the new php function, - * its signature and docs, to be used in the server dispatch map + * @return array|false false on error, or an array containing the name of the new php function, + * its signature and docs, to be used in the server dispatch map * * @todo decide how to deal with params passed by ref: bomb out or allow? - * @todo finish using javadoc info to build method sig if all params are named but out of order + * @todo finish using phpdoc info to build method sig if all params are named but out of order * @todo add a check for params of 'resource' type * @todo add some trigger_errors / error_log when returning false? - * @todo what to do when the PHP function returns NULL? we are currently returning an empty string value... + * @todo what to do when the PHP function returns NULL? We are currently returning an empty string value... * @todo add an option to suppress php warnings in invocation of user function, similar to server debug level 3? * @todo if $newFuncName is empty, we could use create_user_func instead of eval, as it is possibly faster * @todo add a verbatim_object_copy parameter to allow avoiding the same obj instance? */ - public function wrap_php_function($funcName, $newFuncName = '', $extraOptions = array()) + public function wrap_php_function($callable, $newFuncName = '', $extraOptions = array()) { $buildIt = isset($extraOptions['return_source']) ? !($extraOptions['return_source']) : true; - $prefix = isset($extraOptions['prefix']) ? $extraOptions['prefix'] : 'xmlrpc'; - $namespace = '\\PhpXmlRpc\\'; - $encodePhpObjects = isset($extraOptions['encode_php_objs']) ? (bool)$extraOptions['encode_php_objs'] : false; - $decodePhpObjects = isset($extraOptions['decode_php_objs']) ? (bool)$extraOptions['decode_php_objs'] : false; - $catchWarnings = isset($extraOptions['suppress_warnings']) && $extraOptions['suppress_warnings'] ? '@' : ''; - if (is_string($funcName) && strpos($funcName, '::') !== false) { - $funcName = explode('::', $funcName); + if (is_string($callable) && strpos($callable, '::') !== false) { + $callable = explode('::', $callable); } - if (is_array($funcName)) { - if (count($funcName) < 2 || (!is_string($funcName[0]) && !is_object($funcName[0]))) { + if (is_array($callable)) { + if (count($callable) < 2 || (!is_string($callable[0]) && !is_object($callable[0]))) { error_log('XML-RPC: syntax for function to be wrapped is wrong'); - return false; } - if (is_string($funcName[0])) { - $plainFuncName = implode('::', $funcName); - } elseif (is_object($funcName[0])) { - $plainFuncName = get_class($funcName[0]) . '->' . $funcName[1]; + if (is_string($callable[0])) { + $plainFuncName = implode('::', $callable); + } elseif (is_object($callable[0])) { + $plainFuncName = get_class($callable[0]) . '->' . $callable[1]; } - $exists = method_exists($funcName[0], $funcName[1]); - } else { - $plainFuncName = $funcName; - $exists = function_exists($funcName); + $exists = method_exists($callable[0], $callable[1]); + } else if ($callable instanceof \Closure) { + $plainFuncName = 'Closure'; + $exists = true; + } + else { + $plainFuncName = $callable; + $exists = function_exists($callable); } if (!$exists) { error_log('XML-RPC: function to be wrapped is not defined: ' . $plainFuncName); + return false; + } + $funcDesc = $this->introspectFunction($callable, $plainFuncName); + if (!$funcDesc) { return false; + } + + $funcSigs = $this->buildMethodSignatures($funcDesc); + + if ($buildIt) { + /*$allOK = 0; + eval($code . '$allOK=1;'); + // alternative + //$xmlrpcFuncName = create_function('$m', $innerCode); + + if (!$allOK) { + error_log('XML-RPC: could not create function ' . $xmlrpcFuncName . ' to wrap php function ' . $plainFuncName); + + return false; + }*/ + $callable = $this->buildWrapFunctionClosure($callable, $extraOptions, null, null); + $code = ''; } else { - // determine name of new php function - if ($newFuncName == '') { - if (is_array($funcName)) { - if (is_string($funcName[0])) { - $xmlrpcFuncName = "{$prefix}_" . implode('_', $funcName); - } else { - $xmlrpcFuncName = "{$prefix}_" . get_class($funcName[0]) . '_' . $funcName[1]; - } - } else { - $xmlrpcFuncName = "{$prefix}_$funcName"; - } - } else { - $xmlrpcFuncName = $newFuncName; - } - while ($buildIt && function_exists($xmlrpcFuncName)) { - $xmlrpcFuncName .= 'x'; - } + $newFuncName = $this->newFunctionName($callable, $newFuncName, $extraOptions); + $code = $this->buildWrapFunctionSource($callable, $newFuncName, $extraOptions, $plainFuncName, $funcDesc); + // replace the original callable to be set in the results + $callable = $newFuncName; + } - // start to introspect PHP code - if (is_array($funcName)) { - $func = new \ReflectionMethod($funcName[0], $funcName[1]); - if ($func->isPrivate()) { - error_log('XML-RPC: method to be wrapped is private: ' . $plainFuncName); + /// @todo examine if $paramDocs matches $parsVariations and build array for + /// usage as method signature, plus put together a nice string for docs - return false; - } - if ($func->isProtected()) { - error_log('XML-RPC: method to be wrapped is protected: ' . $plainFuncName); + $ret = array( + 'function' => $callable, + 'signature' => $funcSigs['sigs'], + 'docstring' => $funcDesc['desc'], + 'signature_docs' => $funcSigs['sigsDocs'], + 'source' => $code + ); - return false; - } - if ($func->isConstructor()) { - error_log('XML-RPC: method to be wrapped is the constructor: ' . $plainFuncName); + return $ret; + } - return false; - } - if ($func->isDestructor()) { - error_log('XML-RPC: method to be wrapped is the destructor: ' . $plainFuncName); + /** + * Introspect a php callable and its phpdoc block and extract information about its signature + * + * @param callable $callable + * @param string $plainFuncName + * @return array|false + */ + protected function introspectFunction($callable, $plainFuncName) + { + // start to introspect PHP code + if (is_array($callable)) { + $func = new \ReflectionMethod($callable[0], $callable[1]); + if ($func->isPrivate()) { + error_log('XML-RPC: method to be wrapped is private: ' . $plainFuncName); - return false; - } - if ($func->isAbstract()) { - error_log('XML-RPC: method to be wrapped is abstract: ' . $plainFuncName); + return false; + } + if ($func->isProtected()) { + error_log('XML-RPC: method to be wrapped is protected: ' . $plainFuncName); - return false; - } - /// @todo add more checks for static vs. nonstatic? - } else { - $func = new \ReflectionFunction($funcName); + return false; } - if ($func->isInternal()) { - // Note: from PHP 5.1.0 onward, we will possibly be able to use invokeargs - // instead of getparameters to fully reflect internal php functions ? - error_log('XML-RPC: function to be wrapped is internal: ' . $plainFuncName); + if ($func->isConstructor()) { + error_log('XML-RPC: method to be wrapped is the constructor: ' . $plainFuncName); return false; } + if ($func->isDestructor()) { + error_log('XML-RPC: method to be wrapped is the destructor: ' . $plainFuncName); - // retrieve parameter names, types and description from javadoc comments - - // function description - $desc = ''; - // type of return val: by default 'any' - $returns = Value::$xmlrpcValue; - // desc of return val - $returnsDocs = ''; - // type + name of function parameters - $paramDocs = array(); - - $docs = $func->getDocComment(); - if ($docs != '') { - $docs = explode("\n", $docs); - $i = 0; - foreach ($docs as $doc) { - $doc = trim($doc, " \r\t/*"); - if (strlen($doc) && strpos($doc, '@') !== 0 && !$i) { - if ($desc) { - $desc .= "\n"; - } - $desc .= $doc; - } elseif (strpos($doc, '@param') === 0) { - // syntax: @param type [$name] desc - if (preg_match('/@param\s+(\S+)(\s+\$\S+)?\s+(.+)/', $doc, $matches)) { - if (strpos($matches[1], '|')) { - //$paramDocs[$i]['type'] = explode('|', $matches[1]); - $paramDocs[$i]['type'] = 'mixed'; - } else { - $paramDocs[$i]['type'] = $matches[1]; - } - $paramDocs[$i]['name'] = trim($matches[2]); - $paramDocs[$i]['doc'] = $matches[3]; + return false; + } + if ($func->isAbstract()) { + error_log('XML-RPC: method to be wrapped is abstract: ' . $plainFuncName); + + return false; + } + /// @todo add more checks for static vs. nonstatic? + } else { + $func = new \ReflectionFunction($callable); + } + if ($func->isInternal()) { + // Note: from PHP 5.1.0 onward, we will possibly be able to use invokeargs + // instead of getparameters to fully reflect internal php functions ? + error_log('XML-RPC: function to be wrapped is internal: ' . $plainFuncName); + + return false; + } + + // retrieve parameter names, types and description from javadoc comments + + // function description + $desc = ''; + // type of return val: by default 'any' + $returns = Value::$xmlrpcValue; + // desc of return val + $returnsDocs = ''; + // type + name of function parameters + $paramDocs = array(); + + $docs = $func->getDocComment(); + if ($docs != '') { + $docs = explode("\n", $docs); + $i = 0; + foreach ($docs as $doc) { + $doc = trim($doc, " \r\t/*"); + if (strlen($doc) && strpos($doc, '@') !== 0 && !$i) { + if ($desc) { + $desc .= "\n"; + } + $desc .= $doc; + } elseif (strpos($doc, '@param') === 0) { + // syntax: @param type [$name] desc + if (preg_match('/@param\s+(\S+)(\s+\$\S+)?\s+(.+)/', $doc, $matches)) { + if ($matches[2] == '' && substr($matches[3], 0, 1) == '$') { + // syntax: @param type $name + $name = strtolower(trim($matches[3])); + $paramDocs[$name]['name'] = trim($matches[3]); + $paramDocs[$name]['doc'] = ''; + } else { + $name = strtolower(trim($matches[2])); + $paramDocs[$name]['name'] = trim($matches[2]); + $paramDocs[$name]['doc'] = $matches[3]; } - $i++; - } elseif (strpos($doc, '@return') === 0) { - // syntax: @return type desc - //$returns = preg_split('/\s+/', $doc); - if (preg_match('/@return\s+(\S+)\s+(.+)/', $doc, $matches)) { - $returns = php_2_xmlrpc_type($matches[1]); - if (isset($matches[2])) { - $returnsDocs = $matches[2]; - } + + $paramDocs[$name]['type'] = $matches[1]; + } + $i++; + } elseif (strpos($doc, '@return') === 0) { + // syntax: @return type [desc] + if (preg_match('/@return\s+(\S+)(\s+.+)?/', $doc, $matches)) { + $returns = $matches[1]; + if (isset($matches[2])) { + $returnsDocs = trim($matches[2]); } } } } + } - // execute introspection of actual function prototype - $params = array(); - $i = 0; - foreach ($func->getParameters() as $paramObj) { - $params[$i] = array(); - $params[$i]['name'] = '$' . $paramObj->getName(); - $params[$i]['isoptional'] = $paramObj->isOptional(); - $i++; + // execute introspection of actual function prototype + $params = array(); + $i = 0; + foreach ($func->getParameters() as $paramObj) { + $params[$i] = array(); + $params[$i]['name'] = '$' . $paramObj->getName(); + $params[$i]['isoptional'] = $paramObj->isOptional(); + $i++; + } + + return array( + 'desc' => $desc, + 'docs' => $docs, + 'params' => $params, + 'paramDocs' => $paramDocs, + 'returns' => $returns, + 'returnsDocs' =>$returnsDocs, + ); + } + + /** + * Given the method description given by introspection, create method signature data + * + * @todo support better docs with multiple types separated by pipes by creating multiple signatures + * + * @param array $funcDesc as generated by self::introspectFunction() + * + * @return array + */ + protected function buildMethodSignatures($funcDesc) + { + $i = 0; + $parsVariations = array(); + $pars = array(); + $pNum = count($funcDesc['params']); + foreach ($funcDesc['params'] as $param) { + /* // match by name real param and documented params + $name = strtolower($param['name']); + if (!isset($funcDesc['paramDocs'][$name])) { + $funcDesc['paramDocs'][$name] = array(); } + if (!isset($funcDesc['paramDocs'][$name]['type'])) { + $funcDesc['paramDocs'][$name]['type'] = 'mixed'; + }*/ - // start building of PHP code to be eval'd + if ($param['isoptional']) { + // this particular parameter is optional. save as valid previous list of parameters + $parsVariations[] = $pars; + } - $innerCode = "\$encoder = new {$namespace}Encoder();\n"; - $i = 0; - $parsVariations = array(); - $pars = array(); - $pNum = count($params); - foreach ($params as $param) { - if (isset($paramDocs[$i]['name']) && $paramDocs[$i]['name'] && strtolower($paramDocs[$i]['name']) != strtolower($param['name'])) { - // param name from phpdoc info does not match param definition! - $paramDocs[$i]['type'] = 'mixed'; - } + $pars[] = "\$p$i"; + $i++; + if ($i == $pNum) { + // last allowed parameters combination + $parsVariations[] = $pars; + } + } - if ($param['isoptional']) { - // this particular parameter is optional. save as valid previous list of parameters - $innerCode .= "if (\$paramcount > $i) {\n"; - $parsVariations[] = $pars; - } - $innerCode .= "\$p$i = \$msg->getParam($i);\n"; - if ($decodePhpObjects) { - $innerCode .= "if (\$p{$i}->kindOf() == 'scalar') \$p$i = \$p{$i}->scalarval(); else \$p$i = \$encoder->decode(\$p$i, array('decode_php_objs'));\n"; + if (count($parsVariations) == 0) { + // only known good synopsis = no parameters + $parsVariations[] = array(); + } + + $sigs = array(); + $sigsDocs = array(); + foreach ($parsVariations as $pars) { + // build a signature + $sig = array($this->php_2_xmlrpc_type($funcDesc['returns'])); + $pSig = array($funcDesc['returnsDocs']); + for ($i = 0; $i < count($pars); $i++) { + $name = strtolower($funcDesc['params'][$i]['name']); + if (isset($funcDesc['paramDocs'][$name]['type'])) { + $sig[] = $this->php_2_xmlrpc_type($funcDesc['paramDocs'][$name]['type']); } else { - $innerCode .= "if (\$p{$i}->kindOf() == 'scalar') \$p$i = \$p{$i}->scalarval(); else \$p$i = \$encoder->decode(\$p$i);\n"; + $sig[] = Value::$xmlrpcValue; } + $pSig[] = isset($funcDesc['paramDocs'][$name]['doc']) ? $funcDesc['paramDocs'][$name]['doc'] : ''; + } + $sigs[] = $sig; + $sigsDocs[] = $pSig; + } - $pars[] = "\$p$i"; - $i++; - if ($param['isoptional']) { - $innerCode .= "}\n"; - } - if ($i == $pNum) { - // last allowed parameters combination - $parsVariations[] = $pars; - } + return array( + 'sigs' => $sigs, + 'sigsDocs' => $sigsDocs + ); + } + + /** + * Creates a closure that will execute $callable + * @todo validate params + * + * @param $callable + * @param array $extraOptions + * @param string $plainFuncName + * @param string $funcDesc + * @return callable + */ + protected function buildWrapFunctionClosure($callable, $extraOptions, $plainFuncName, $funcDesc) + { + $function = function($req) use($callable, $extraOptions) + { + $nameSpace = '\\PhpXmlRpc\\'; + $encoderClass = $nameSpace.'Encoder'; + $responseClass = $nameSpace.'Response'; + + $encoder = new $encoderClass(); + $options = array(); + if (isset($extraOptions['decode_php_objs']) && $extraOptions['decode_php_objs']) { + $options[] = 'decode_php_objs'; } + $params = $encoder->decode($req, $options); - $sigs = array(); - $pSigs = array(); - if (count($parsVariations) == 0) { - // only known good synopsis = no parameters - $parsVariations[] = array(); - $minPars = 0; - } else { - $minPars = count($parsVariations[0]); + $result = call_user_func_array($callable, $params); + + if (! is_a($result, $responseClass)) { + $options = array(); + if (isset($extraOptions['encode_php_objs']) && $extraOptions['encode_php_objs']) { + $options[] = 'encode_php_objs'; + } + $result = new $responseClass($encoder->encode($result, $options)); } - if ($minPars) { - // add to code the check for min params number - // NB: this check needs to be done BEFORE decoding param values - $innerCode = "\$paramcount = \$msg->getNumParams();\n" . - "if (\$paramcount < $minPars) return new {$namespace}Response(0, " . PhpXmlRpc::$xmlrpcerr['incorrect_params'] . ", '" . PhpXmlRpc::$xmlrpcerr['incorrect_params'] . "');\n" . $innerCode; + return $result; + }; + + return $function; + } + + /** + * Return a name for the new function + * @param $callable + * @param string $newFuncName + * @return string + */ + protected function newFunctionName($callable, $newFuncName, $extraOptions) + { + // determine name of new php function + + $prefix = isset($extraOptions['prefix']) ? $extraOptions['prefix'] : 'xmlrpc'; + + if ($newFuncName == '') { + if (is_array($callable)) { + if (is_string($callable[0])) { + $xmlrpcFuncName = "{$prefix}_" . implode('_', $callable); + } else { + $xmlrpcFuncName = "{$prefix}_" . get_class($callable[0]) . '_' . $callable[1]; + } } else { - $innerCode = "\$paramcount = \$msg->getNumParams();\n" . $innerCode; + if ($callable instanceof \Closure) { + $xmlrpcFuncName = "{$prefix}_closure"; + } else { + $xmlrpcFuncName = "{$prefix}_$callable"; + } } + } else { + $xmlrpcFuncName = $newFuncName; + } - $innerCode .= "\$np = false;\n"; - // since there are no closures in php, if we are given an object instance, - // we store a pointer to it in a global var... - if (is_array($funcName) && is_object($funcName[0])) { - $GLOBALS['xmlrpcWPFObjHolder'][$xmlrpcFuncName] = &$funcName[0]; - $innerCode .= "\$obj =& \$GLOBALS['xmlrpcWPFObjHolder']['$xmlrpcFuncName'];\n"; - $realFuncName = '$obj->' . $funcName[1]; - } else { - $realFuncName = $plainFuncName; + while (function_exists($xmlrpcFuncName)) { + $xmlrpcFuncName .= 'x'; + } + + return $xmlrpcFuncName; + } + + /** + * @param $callable + * @param string $newFuncName + * @param array $extraOptions + * @param string $plainFuncName + * @param array $funcDesc + * @return array + */ + protected function buildWrapFunctionSource($callable, $newFuncName, $extraOptions, $plainFuncName, $funcDesc) + { + $namespace = '\\PhpXmlRpc\\'; + $prefix = isset($extraOptions['prefix']) ? $extraOptions['prefix'] : 'xmlrpc'; + $encodePhpObjects = isset($extraOptions['encode_php_objs']) ? (bool)$extraOptions['encode_php_objs'] : false; + $decodePhpObjects = isset($extraOptions['decode_php_objs']) ? (bool)$extraOptions['decode_php_objs'] : false; + $catchWarnings = isset($extraOptions['suppress_warnings']) && $extraOptions['suppress_warnings'] ? '@' : ''; + + // build body of new function + + $innerCode = "\$encoder = new {$namespace}Encoder();\n"; + $i = 0; + $parsVariations = array(); + $pars = array(); + $pNum = count($funcDesc['params']); + foreach ($funcDesc['params'] as $param) { + if (isset($funcDesc['paramDocs'][$i]['name']) && $funcDesc['paramDocs'][$i]['name'] && + strtolower($funcDesc['paramDocs'][$i]['name']) != strtolower($param['name'])) { + // param name from phpdoc info does not match param definition! + $funcDesc['paramDocs'][$i]['type'] = 'mixed'; } - foreach ($parsVariations as $pars) { - $innerCode .= "if (\$paramcount == " . count($pars) . ") \$retval = {$catchWarnings}$realFuncName(" . implode(',', $pars) . "); else\n"; - // build a 'generic' signature (only use an appropriate return type) - $sig = array($returns); - $pSig = array($returnsDocs); - for ($i = 0; $i < count($pars); $i++) { - if (isset($paramDocs[$i]['type'])) { - $sig[] = $this->php_2_xmlrpc_type($paramDocs[$i]['type']); - } else { - $sig[] = Value::$xmlrpcValue; - } - $pSig[] = isset($paramDocs[$i]['doc']) ? $paramDocs[$i]['doc'] : ''; - } - $sigs[] = $sig; - $pSigs[] = $pSig; + + if ($param['isoptional']) { + // this particular parameter is optional. save as valid previous list of parameters + $innerCode .= "if (\$paramcount > $i) {\n"; + $parsVariations[] = $pars; } - $innerCode .= "\$np = true;\n"; - $innerCode .= "if (\$np) return new {$namespace}Response(0, " . PhpXmlRpc::$xmlrpcerr['incorrect_params'] . ", '" . PhpXmlRpc::$xmlrpcerr['incorrect_params'] . "'); else {\n"; - //$innerCode .= "if (\$_xmlrpcs_error_occurred) return new Response(0, $GLOBALS['xmlrpcerr']user, \$_xmlrpcs_error_occurred); else\n"; - $innerCode .= "if (is_a(\$retval, '{$namespace}Response')) return \$retval; else\n"; - if ($returns == Value::$xmlrpcDateTime || $returns == Value::$xmlrpcBase64) { - $innerCode .= "return new {$namespace}Response(new {$namespace}Value(\$retval, '$returns'));"; + $innerCode .= "\$p$i = \$req->getParam($i);\n"; + if ($decodePhpObjects) { + $innerCode .= "if (\$p{$i}->kindOf() == 'scalar') \$p$i = \$p{$i}->scalarval(); else \$p$i = \$encoder->decode(\$p$i, array('decode_php_objs'));\n"; } else { - if ($encodePhpObjects) { - $innerCode .= "return new {$namespace}Response(\$encoder->encode(\$retval, array('encode_php_objs')));\n"; - } else { - $innerCode .= "return new {$namespace}Response(\$encoder->encode(\$retval));\n"; - } + $innerCode .= "if (\$p{$i}->kindOf() == 'scalar') \$p$i = \$p{$i}->scalarval(); else \$p$i = \$encoder->decode(\$p$i);\n"; } - // shall we exclude functions returning by ref? - // if($func->returnsReference()) - // return false; - $code = "function $xmlrpcFuncName(\$msg) {\n" . $innerCode . "}\n}"; - //print_r($code); - if ($buildIt) { - $allOK = 0; - eval($code . '$allOK=1;'); - // alternative - //$xmlrpcFuncName = create_function('$m', $innerCode); - - if (!$allOK) { - error_log('XML-RPC: could not create function ' . $xmlrpcFuncName . ' to wrap php function ' . $plainFuncName); - - return false; - } + + $pars[] = "\$p$i"; + $i++; + if ($param['isoptional']) { + $innerCode .= "}\n"; } + if ($i == $pNum) { + // last allowed parameters combination + $parsVariations[] = $pars; + } + } - /// @todo examine if $paramDocs matches $parsVariations and build array for - /// usage as method signature, plus put together a nice string for docs + if (count($parsVariations) == 0) { + // only known good synopsis = no parameters + $parsVariations[] = array(); + $minPars = 0; + } else { + $minPars = count($parsVariations[0]); + } - $ret = array('function' => $xmlrpcFuncName, 'signature' => $sigs, 'docstring' => $desc, 'signature_docs' => $pSigs, 'source' => $code); + if ($minPars) { + // add to code the check for min params number + // NB: this check needs to be done BEFORE decoding param values + $innerCode = "\$paramcount = \$req->getNumParams();\n" . + "if (\$paramcount < $minPars) return new {$namespace}Response(0, " . PhpXmlRpc::$xmlrpcerr['incorrect_params'] . ", '" . PhpXmlRpc::$xmlrpcstr['incorrect_params'] . "');\n" . $innerCode; + } else { + $innerCode = "\$paramcount = \$req->getNumParams();\n" . $innerCode; + } - return $ret; + $innerCode .= "\$np = false;\n"; + // since there are no closures in php, if we are given an object instance, + // we store a pointer to it in a global var... + if (is_array($callable) && is_object($callable[0])) { + $GLOBALS['xmlrpcWPFObjHolder'][$newFuncName] = &$callable[0]; + $innerCode .= "\$obj =& \$GLOBALS['xmlrpcWPFObjHolder']['$newFuncName'];\n"; + $realFuncName = '$obj->' . $callable[1]; + } else { + $realFuncName = $plainFuncName; + } + foreach ($parsVariations as $pars) { + $innerCode .= "if (\$paramcount == " . count($pars) . ") \$retval = {$catchWarnings}$realFuncName(" . implode(',', $pars) . "); else\n"; + } + $innerCode .= "\$np = true;\n"; + $innerCode .= "if (\$np) return new {$namespace}Response(0, " . PhpXmlRpc::$xmlrpcerr['incorrect_params'] . ", '" . PhpXmlRpc::$xmlrpcstr['incorrect_params'] . "'); else {\n"; + //$innerCode .= "if (\$_xmlrpcs_error_occurred) return new Response(0, $GLOBALS['xmlrpcerr']user, \$_xmlrpcs_error_occurred); else\n"; + $innerCode .= "if (is_a(\$retval, '{$namespace}Response')) return \$retval; else\n"; + if ($funcDesc['returns'] == Value::$xmlrpcDateTime || $funcDesc['returns'] == Value::$xmlrpcBase64) { + $innerCode .= "return new {$namespace}Response(new {$namespace}Value(\$retval, '{$funcDesc['returns']}'));"; + } else { + if ($encodePhpObjects) { + $innerCode .= "return new {$namespace}Response(\$encoder->encode(\$retval, array('encode_php_objs')));\n"; + } else { + $innerCode .= "return new {$namespace}Response(\$encoder->encode(\$retval));\n"; + } } + // shall we exclude functions returning by ref? + // if($func->returnsReference()) + // return false; + + $code = "function $newFuncName(\$req) {\n" . $innerCode . "}\n}"; + + return $code; } /** @@ -419,40 +591,47 @@ class Wrapper * PHP 'wrapper' functions that can be exposed as xmlrpc methods from an xmlrpc server * object and called from remote clients (as well as their corresponding signature info). * - * @param mixed $classname the name of the class whose methods are to be exposed as xmlrpc methods, or an object instance of that class - * @param array $extraOptions see the docs for wrap_php_method for more options - * string method_type 'static', 'nonstatic', 'all' and 'auto' (default); the latter will switch between static and non-static depending on wheter $classname is a class name or object instance + * @param mixed $className the name of the class whose methods are to be exposed as xmlrpc methods, or an object instance of that class + * @param array $extraOptions see the docs for wrap_php_method for basic options, plus + * - 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 + * - string method_filter: a regexp used to filter methods to wrap based on their names + * - string $prefix/ used for the names of the xmlrpc methods created * * @return array or false on failure * * @todo get_class_methods will return both static and non-static methods. - * we have to differentiate the action, depending on wheter we recived a class name or object + * we have to differentiate the action, depending on whether we received a class name or object */ - public function wrap_php_class($classname, $extraOptions = array()) + public function wrap_php_class($className, $extraOptions = array()) { - $methodfilter = isset($extraOptions['method_filter']) ? $extraOptions['method_filter'] : ''; - $methodtype = isset($extraOptions['method_type']) ? $extraOptions['method_type'] : 'auto'; - - $result = array(); - $mlist = get_class_methods($classname); - foreach ($mlist as $mname) { - if ($methodfilter == '' || preg_match($methodfilter, $mname)) { - // echo $mlist."\n"; - $func = new \ReflectionMethod($classname, $mname); + $methodFilter = isset($extraOptions['method_filter']) ? $extraOptions['method_filter'] : ''; + $methodType = isset($extraOptions['method_type']) ? $extraOptions['method_type'] : 'auto'; + $prefix = isset($extraOptions['prefix']) ? $extraOptions['prefix'] : ''; + + $results = array(); + $mList = get_class_methods($className); + foreach ($mList as $mName) { + if ($methodFilter == '' || preg_match($methodFilter, $mName)) { + $func = new \ReflectionMethod($className, $mName); if (!$func->isPrivate() && !$func->isProtected() && !$func->isConstructor() && !$func->isDestructor() && !$func->isAbstract()) { - if (($func->isStatic && ($methodtype == 'all' || $methodtype == 'static' || ($methodtype == 'auto' && is_string($classname)))) || - (!$func->isStatic && ($methodtype == 'all' || $methodtype == 'nonstatic' || ($methodtype == 'auto' && is_object($classname)))) + if (($func->isStatic() && ($methodType == 'all' || $methodType == 'static' || ($methodType == 'auto' && is_string($className)))) || + (!$func->isStatic() && ($methodType == 'all' || $methodType == 'nonstatic' || ($methodType == 'auto' && is_object($className)))) ) { - $methodwrap = $this->wrap_php_function(array($classname, $mname), '', $extraOptions); - if ($methodwrap) { - $result[$methodwrap['function']] = $methodwrap['function']; + $methodWrap = $this->wrap_php_function(array($className, $mName), '', $extraOptions); + if ($methodWrap) { + if (is_object($className)) { + $realClassName = get_class($className); + }else { + $realClassName = $className; + } + $results[$prefix."$realClassName.$mName"] = $methodWrap; } } } } } - return $result; + return $results; } /** @@ -478,6 +657,8 @@ class Wrapper * An extra 'debug' param is appended to param list of xmlrpc method, useful * for debugging purposes. * + * @todo in case user wants back a function, return a closure instead of using eval + * * @param Client $client an xmlrpc client set up correctly to communicate with target server * @param string $methodName the xmlrpc method to be mapped to a php function * @param array $extraOptions array of options that specify conversion details. valid options include @@ -498,10 +679,10 @@ class Wrapper // mind numbing: let caller use sane calling convention (as per javadoc, 3 params), // OR the 2.0 calling convention (no options) - we really love backward compat, don't we? if (!is_array($extraOptions)) { - $signum = $extraOptions; + $sigNum = $extraOptions; $extraOptions = array(); } else { - $signum = isset($extraOptions['signum']) ? (int)$extraOptions['signum'] : 0; + $sigNum = isset($extraOptions['signum']) ? (int)$extraOptions['signum'] : 0; $timeout = isset($extraOptions['timeout']) ? (int)$extraOptions['timeout'] : 0; $protocol = isset($extraOptions['protocol']) ? $extraOptions['protocol'] : ''; $newFuncName = isset($extraOptions['new_function_name']) ? $extraOptions['new_function_name'] : ''; @@ -526,26 +707,26 @@ class Wrapper } $debug = isset($extraOptions['debug']) ? ($extraOptions['debug']) : 0; - $msgclass = $namespace . 'Request'; - $valclass = $namespace . 'Value'; + $reqClass = $namespace . 'Request'; + $valClass = $namespace . 'Value'; $decoderClass = $namespace . 'Encoder'; - $msg = new $msgclass('system.methodSignature'); - $msg->addparam(new $valclass($methodName)); + $req = new $reqClass('system.methodSignature'); + $req->addparam(new $valClass($methodName)); $client->setDebug($debug); - $response = $client->send($msg, $timeout, $protocol); + $response = $client->send($req, $timeout, $protocol); if ($response->faultCode()) { error_log('XML-RPC: could not retrieve method signature from remote server for method ' . $methodName); return false; } else { - $msig = $response->value(); + $mSig = $response->value(); if ($client->return_type != 'phpvals') { $decoder = new $decoderClass(); - $msig = $decoder->decode($msig); + $mSig = $decoder->decode($mSig); } - if (!is_array($msig) || count($msig) <= $signum) { - error_log('XML-RPC: could not retrieve method signature nr.' . $signum . ' from remote server for method ' . $methodName); + if (!is_array($mSig) || count($mSig) <= $sigNum) { + error_log('XML-RPC: could not retrieve method signature nr.' . $sigNum . ' from remote server for method ' . $methodName); return false; } else { @@ -562,27 +743,27 @@ class Wrapper $xmlrpcFuncName .= 'x'; } - $msig = $msig[$signum]; - $mdesc = ''; + $mSig = $mSig[$sigNum]; + $mDesc = ''; // if in 'offline' mode, get method description too. // in online mode, favour speed of operation if (!$buildIt) { - $msg = new $msgclass('system.methodHelp'); - $msg->addparam(new $valclass($methodName)); - $response = $client->send($msg, $timeout, $protocol); + $req = new $reqClass('system.methodHelp'); + $req->addparam(new $valClass($methodName)); + $response = $client->send($req, $timeout, $protocol); if (!$response->faultCode()) { - $mdesc = $response->value(); + $mDesc = $response->value(); if ($client->return_type != 'phpvals') { - $mdesc = $mdesc->scalarval(); + $mDesc = $mDesc->scalarval(); } } } $results = $this->build_remote_method_wrapper_code($client, $methodName, - $xmlrpcFuncName, $msig, $mdesc, $timeout, $protocol, $simpleClientCopy, + $xmlrpcFuncName, $mSig, $mDesc, $timeout, $protocol, $simpleClientCopy, $prefix, $decodePhpObjects, $encodePhpObjects, $decodeFault, $faultResponse, $namespace); - //print_r($code); + if ($buildIt) { $allOK = 0; eval($results['source'] . '$allOK=1;'); @@ -609,18 +790,29 @@ class Wrapper * all xmlrpc methods exposed by the remote server as own methods. * For more details see wrap_xmlrpc_method. * + * NB: for a slimmer alternative, see the code in demo/client/proxy.php + * * @param Client $client the client obj all set to query the desired server * @param array $extraOptions list of options for wrapped code + * - method_filter + * - timeout + * - protocol + * - new_class_name + * - encode_php_objs + * - decode_php_objs + * - simple_client_copy + * - return_source + * - prefix * * @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) */ public function wrap_xmlrpc_server($client, $extraOptions = array()) { - $methodfilter = isset($extraOptions['method_filter']) ? $extraOptions['method_filter'] : ''; - //$signum = isset($extraOptions['signum']) ? (int)$extraOptions['signum'] : 0; + $methodFilter = isset($extraOptions['method_filter']) ? $extraOptions['method_filter'] : ''; + //$sigNum = isset($extraOptions['signum']) ? (int)$extraOptions['signum'] : 0; $timeout = isset($extraOptions['timeout']) ? (int)$extraOptions['timeout'] : 0; $protocol = isset($extraOptions['protocol']) ? $extraOptions['protocol'] : ''; - $newclassname = isset($extraOptions['new_class_name']) ? $extraOptions['new_class_name'] : ''; + $newClassName = isset($extraOptions['new_class_name']) ? $extraOptions['new_class_name'] : ''; $encodePhpObjects = isset($extraOptions['encode_php_objs']) ? (bool)$extraOptions['encode_php_objs'] : false; $decodePhpObjects = isset($extraOptions['decode_php_objs']) ? (bool)$extraOptions['decode_php_objs'] : false; $verbatimClientCopy = isset($extraOptions['simple_client_copy']) ? !($extraOptions['simple_client_copy']) : true; @@ -628,30 +820,30 @@ class Wrapper $prefix = isset($extraOptions['prefix']) ? $extraOptions['prefix'] : 'xmlrpc'; $namespace = '\\PhpXmlRpc\\'; - $msgclass = $namespace . 'Request'; - //$valclass = $prefix.'val'; + $reqClass = $namespace . 'Request'; + //$valClass = $prefix.'val'; $decoderClass = $namespace . 'Encoder'; - $msg = new $msgclass('system.listMethods'); - $response = $client->send($msg, $timeout, $protocol); + $req = new $reqClass('system.listMethods'); + $response = $client->send($req, $timeout, $protocol); if ($response->faultCode()) { error_log('XML-RPC: could not retrieve method list from remote server'); return false; } else { - $mlist = $response->value(); + $mList = $response->value(); if ($client->return_type != 'phpvals') { $decoder = new $decoderClass(); - $mlist = $decoder->decode($mlist); + $mList = $decoder->decode($mList); } - if (!is_array($mlist) || !count($mlist)) { + if (!is_array($mList) || !count($mList)) { error_log('XML-RPC: could not retrieve meaningful method list from remote server'); return false; } else { // pick a suitable name for the new function, avoiding collisions - if ($newclassname != '') { - $xmlrpcClassName = $newclassname; + if ($newClassName != '') { + $xmlrpcClassName = $newClassName; } else { $xmlrpcClassName = $prefix . '_' . preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'), array('_', ''), $client->server) . '_client'; @@ -670,19 +862,20 @@ class Wrapper 'encode_php_objs' => $encodePhpObjects, 'prefix' => $prefix, 'decode_php_objs' => $decodePhpObjects, ); - /// @todo build javadoc for class definition, too - foreach ($mlist as $mname) { - if ($methodfilter == '' || preg_match($methodfilter, $mname)) { + /// @todo build phpdoc for class definition, too + foreach ($mList as $mName) { + if ($methodFilter == '' || preg_match($methodFilter, $mName)) { + // note: this will fail if server exposes 2 methods called f.e. do.something and do_something $opts['new_function_name'] = preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'), - array('_', ''), $mname); - $methodwrap = $this->wrap_xmlrpc_method($client, $mname, $opts); - if ($methodwrap) { + array('_', ''), $mName); + $methodWrap = $this->wrap_xmlrpc_method($client, $mName, $opts); + if ($methodWrap) { if (!$buildIt) { - $source .= $methodwrap['docstring']; + $source .= $methodWrap['docstring']; } - $source .= $methodwrap['source'] . "\n"; + $source .= $methodWrap['source'] . "\n"; } else { - error_log('XML-RPC: will not create class method to wrap remote method ' . $mname); + error_log('XML-RPC: will not create class method to wrap remote method ' . $mName); } } } @@ -714,8 +907,8 @@ class Wrapper * Note: real spaghetti code follows... */ public function build_remote_method_wrapper_code($client, $methodName, $xmlrpcFuncName, - $msig, $mdesc = '', $timeout = 0, $protocol = '', $clientCopyMode = 0, $prefix = 'xmlrpc', - $decodePhpObjects = false, $encodePhpObjects = false, $decdoeFault = false, + $mSig, $mDesc = '', $timeout = 0, $protocol = '', $clientCopyMode = 0, $prefix = 'xmlrpc', + $decodePhpObjects = false, $encodePhpObjects = false, $decodeFault = false, $faultResponse = '', $namespace = '\\PhpXmlRpc\\') { $code = "function $xmlrpcFuncName ("; @@ -729,22 +922,22 @@ class Wrapper $innerCode = ''; $this_ = 'this->'; } - $innerCode .= "\$msg = new {$namespace}Request('$methodName');\n"; + $innerCode .= "\$req = new {$namespace}Request('$methodName');\n"; - if ($mdesc != '') { + if ($mDesc != '') { // take care that PHP comment is not terminated unwillingly by method description - $mdesc = "/**\n* " . str_replace('*/', '* /', $mdesc) . "\n"; + $mDesc = "/**\n* " . str_replace('*/', '* /', $mDesc) . "\n"; } else { - $mdesc = "/**\nFunction $xmlrpcFuncName\n"; + $mDesc = "/**\nFunction $xmlrpcFuncName\n"; } // param parsing $innerCode .= "\$encoder = new {$namespace}Encoder();\n"; $plist = array(); - $pcount = count($msig); + $pcount = count($mSig); for ($i = 1; $i < $pcount; $i++) { $plist[] = "\$p$i"; - $ptype = $msig[$i]; + $ptype = $mSig[$i]; if ($ptype == 'i4' || $ptype == 'int' || $ptype == 'boolean' || $ptype == 'double' || $ptype == 'string' || $ptype == 'dateTime.iso8601' || $ptype == 'base64' || $ptype == 'null' ) { @@ -757,18 +950,18 @@ class Wrapper $innerCode .= "\$p$i = \$encoder->encode(\$p$i);\n"; } } - $innerCode .= "\$msg->addparam(\$p$i);\n"; - $mdesc .= '* @param ' . $this->xmlrpc_2_php_type($ptype) . " \$p$i\n"; + $innerCode .= "\$req->addparam(\$p$i);\n"; + $mDesc .= '* @param ' . $this->xmlrpc_2_php_type($ptype) . " \$p$i\n"; } if ($clientCopyMode < 2) { $plist[] = '$debug=0'; - $mdesc .= "* @param int \$debug when 1 (or 2) will enable debugging of the underlying {$prefix} call (defaults to 0)\n"; + $mDesc .= "* @param int \$debug when 1 (or 2) will enable debugging of the underlying {$prefix} call (defaults to 0)\n"; } $plist = implode(', ', $plist); - $mdesc .= '* @return ' . $this->xmlrpc_2_php_type($msig[0]) . " (or an {$namespace}Response obj instance if call fails)\n*/\n"; + $mDesc .= '* @return ' . $this->xmlrpc_2_php_type($mSig[0]) . " (or an {$namespace}Response obj instance if call fails)\n*/\n"; - $innerCode .= "\$res = \${$this_}client->send(\$msg, $timeout, '$protocol');\n"; - if ($decdoeFault) { + $innerCode .= "\$res = \${$this_}client->send(\$req, $timeout, '$protocol');\n"; + if ($decodeFault) { if (is_string($faultResponse) && ((strpos($faultResponse, '%faultCode%') !== false) || (strpos($faultResponse, '%faultString%') !== false))) { $respCode = "str_replace(array('%faultCode%', '%faultString%'), array(\$res->faultCode(), \$res->faultString()), '" . str_replace("'", "''", $faultResponse) . "')"; } else { @@ -785,7 +978,7 @@ class Wrapper $code = $code . $plist . ") {\n" . $innerCode . "\n}\n"; - return array('source' => $code, 'docstring' => $mdesc); + return array('source' => $code, 'docstring' => $mDesc); } /** @@ -796,6 +989,7 @@ class Wrapper * @param bool $verbatimClientCopy * @param string $prefix * @param string $namespace + * * @return string */ protected function build_client_wrapper_code($client, $verbatimClientCopy, $prefix = 'xmlrpc', $namespace = '\\PhpXmlRpc\\' )