X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=src%2FServer.php;h=382630e4df89b7434daea3f3eb352df4d671a36e;hb=9d4cfc9508b03a579dd62a28c0e9e428b5052f9b;hp=8a2f5117feb5a18c68596c99b43cde9ce115de4d;hpb=749bcf1b412822e08dbcab366cfbf7ad1cb77db0;p=plcapi.git

diff --git a/src/Server.php b/src/Server.php
index 8a2f511..382630e 100644
--- a/src/Server.php
+++ b/src/Server.php
@@ -5,18 +5,23 @@ namespace PhpXmlRpc;
 use PhpXmlRpc\Helper\XMLParser;
 use PhpXmlRpc\Helper\Charset;
 
+/**
+ * Allows effortless implementation of XML-RPC servers
+ */
 class Server
 {
     /**
      * Array defining php functions exposed as xmlrpc methods by this server.
      */
     protected $dmap = array();
+
     /**
      * Defines how functions in dmap will be invoked: either using an xmlrpc request object
      * or plain php values.
      * Valid strings are 'xmlrpcvals', 'phpvals' or 'epivals'
      */
     public $functions_parameters_type = 'xmlrpcvals';
+
     /**
      * Option used for fine-tuning the encoding the php values returned from
      * functions registered in the dispatch map when the functions_parameters_types
@@ -24,11 +29,13 @@ class Server
      * @see Encoder::encode for a list of values
      */
     public $phpvals_encoding_options = array('auto_dates');
+
     /**
      * Controls whether the server is going to echo debugging messages back to the client as comments in response body.
      * Valid values: 0,1,2,3
      */
     public $debug = 1;
+
     /**
      * Controls behaviour of server when the invoked user function throws an exception:
      * 0 = catch it and return an 'internal error' xmlrpc response (default)
@@ -36,26 +43,32 @@ class Server
      * 2 = allow the exception to float to the upper layers
      */
     public $exception_handling = 0;
+
     /**
      * When set to true, it will enable HTTP compression of the response, in case
      * the client has declared its support for compression in the request.
      * Set at constructor time.
      */
     public $compress_response = false;
+
     /**
      * List of http compression methods accepted by the server for requests. Set at constructor time.
      * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib
      */
     public $accepted_compression = array();
-    /// shall we serve calls to system.* methods?
+
+    /// Shall we serve calls to system.* methods?
     public $allow_system_funcs = true;
+
     /**
      * List of charset encodings natively accepted for requests.
-     *  Set at constructor time.
+     * Set at constructor time.
+     * UNUSED so far...
      */
     public $accepted_charset_encodings = array();
+
     /**
-     * charset encoding to be used for response.
+     * Charset encoding to be used for response.
      * NB: if we can, we will convert the generated response from internal_encoding to the intended one.
      * Can be: a supported xml encoding (only UTF-8 and ISO-8859-1 at present, unless mbstring is enabled),
      * null (leave unspecified in response, convert output stream to US_ASCII),
@@ -64,10 +77,12 @@ class Server
      * NB: pretty dangerous if you accept every charset and do not have mbstring enabled)
      */
     public $response_charset_encoding = '';
+
     /**
      * Storage for internal debug info.
      */
     protected $debug_info = '';
+
     /**
      * Extra data passed at runtime to method handling functions. Used only by EPI layer
      */
@@ -75,7 +90,7 @@ class Server
 
     protected static $_xmlrpc_debuginfo = '';
     protected static $_xmlrpcs_occurred_errors = '';
-    public static $_xmlrpcs_prev_ehandler = '';
+    protected static $_xmlrpcs_prev_ehandler = '';
 
     /**
      * @param array $dispatchMap the dispatch map with definition of exposed services
@@ -179,7 +194,9 @@ class Server
      * @param string $data the request body. If null, the http POST request will be examined
      * @param bool $returnPayload When true, return the response but do not echo it or any http header
      *
-     * @return Response the response object (usually not used by caller...)
+     * @return Response|string the response object (usually not used by caller...) or its xml serialization
+     *
+     * @throws \Exception in case the executed method does throw an exception (and depending on server configuration)
      */
     public function service($data = null, $returnPayload = false)
     {
@@ -191,13 +208,14 @@ class Server
         // reset internal debug info
         $this->debug_info = '';
 
-        // Echo back what we received, before parsing it
+        // Save what we received, before parsing it
         if ($this->debug > 1) {
             $this->debugmsg("+++GOT+++\n" . $data . "\n+++END+++");
         }
 
         $r = $this->parseRequestHeaders($data, $reqCharset, $respCharset, $respEncoding);
         if (!$r) {
+            // this actually executes the request
             $r = $this->parseRequest($data, $reqCharset);
         }
 
@@ -344,7 +362,7 @@ class Server
     /**
      * Parse http headers received along with xmlrpc request. If needed, inflate request.
      *
-     * @return mixed null on success or a Response
+     * @return mixed Response|null on success or an error Response
      */
     protected function parseRequestHeaders(&$data, &$reqEncoding, &$respEncoding, &$respCompression)
     {
@@ -390,7 +408,6 @@ class Server
                         return $r;
                     }
                 } else {
-                    //error_log('The server sent deflated data. Your php install must have the Zlib extension compiled in to support this.');
                     $r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_cannot_decompress'], PhpXmlRpc::$xmlrpcstr['server_cannot_decompress']);
 
                     return $r;
@@ -447,6 +464,8 @@ class Server
      * @param string $reqEncoding (optional) the charset encoding of the xml request
      *
      * @return Response
+     *
+     * @throws \Exception in case the executed method does throw an exception (and depending on server configuration)
      */
     public function parseRequest($data, $reqEncoding = '')
     {
@@ -546,10 +565,13 @@ class Server
      *
      * @return Response
      *
-     * @throws \Exception in case the executed method does throw an exception (and depending on )
+     * @throws \Exception in case the executed method does throw an exception (and depending on server configuration)
      */
     protected function execute($req, $params = null, $paramTypes = null)
     {
+        static::$_xmlrpcs_occurred_errors = '';
+        static::$_xmlrpc_debuginfo = '';
+
         if (is_object($req)) {
             $methName = $req->method();
         } else {
@@ -604,7 +626,6 @@ class Server
         // verify that function to be invoked is in fact callable
         if (!is_callable($func)) {
             error_log("XML-RPC: " . __METHOD__ . ": function '$funcName' registered as method handler is not callable");
-
             return new Response(
                 0,
                 PhpXmlRpc::$xmlrpcerr['server_error'],
@@ -615,8 +636,9 @@ class Server
         // If debug level is 3, we should catch all errors generated during
         // processing of user function, and log them as part of response
         if ($this->debug > 2) {
-            $GLOBALS['_xmlrpcs_prev_ehandler'] = set_error_handler(array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler'));
+            self::$_xmlrpcs_prev_ehandler = set_error_handler(array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler'));
         }
+
         try {
             // Allow mixed-convention servers
             if (is_object($req)) {
@@ -671,6 +693,13 @@ class Server
             // in the called function, we wrap it in a proper error-response
             switch ($this->exception_handling) {
                 case 2:
+                    if ($this->debug > 2) {
+                        if (self::$_xmlrpcs_prev_ehandler) {
+                            set_error_handler(self::$_xmlrpcs_prev_ehandler);
+                        } else {
+                            restore_error_handler();
+                        }
+                    }
                     throw $e;
                     break;
                 case 1:
@@ -683,8 +712,8 @@ class Server
         if ($this->debug > 2) {
             // note: restore the error handler we found before calling the
             // user func, even if it has been changed inside the func itself
-            if ($GLOBALS['_xmlrpcs_prev_ehandler']) {
-                set_error_handler($GLOBALS['_xmlrpcs_prev_ehandler']);
+            if (self::$_xmlrpcs_prev_ehandler) {
+                set_error_handler(self::$_xmlrpcs_prev_ehandler);
             } else {
                 restore_error_handler();
             }
@@ -694,7 +723,7 @@ class Server
     }
 
     /**
-     * add a string to the 'internal debug message' (separate from 'user debug message').
+     * Add a string to the 'internal debug message' (separate from 'user debug message').
      *
      * @param string $string
      */
@@ -703,6 +732,10 @@ class Server
         $this->debug_info .= $string . "\n";
     }
 
+    /**
+     * @param string $charsetEncoding
+     * @return string
+     */
     protected function xml_header($charsetEncoding = '')
     {
         if ($charsetEncoding != '') {
@@ -714,6 +747,9 @@ class Server
 
     /* Functions that implement system.XXX methods of xmlrpc servers */
 
+    /**
+     * @return array
+     */
     public function getSystemDispatchMap()
     {
         return array(
@@ -752,36 +788,45 @@ class Server
         );
     }
 
-    public static function _xmlrpcs_getCapabilities($server, $req = null)
+    /**
+     * @return array
+     */
+    public function getCapabilities()
     {
         $outAr = array(
             // xmlrpc spec: always supported
-            'xmlrpc' => new Value(array(
-                'specUrl' => new Value('http://www.xmlrpc.com/spec', 'string'),
-                'specVersion' => new Value(1, 'int'),
-            ), 'struct'),
+            'xmlrpc' => array(
+                'specUrl' => 'http://www.xmlrpc.com/spec',
+                'specVersion' => 1
+            ),
             // if we support system.xxx functions, we always support multicall, too...
             // Note that, as of 2006/09/17, the following URL does not respond anymore
-            'system.multicall' => new Value(array(
-                'specUrl' => new Value('http://www.xmlrpc.com/discuss/msgReader$1208', 'string'),
-                'specVersion' => new Value(1, 'int'),
-            ), 'struct'),
+            'system.multicall' => array(
+                'specUrl' => 'http://www.xmlrpc.com/discuss/msgReader$1208',
+                'specVersion' => 1
+            ),
             // introspection: version 2! we support 'mixed', too
-            'introspection' => new Value(array(
-                'specUrl' => new Value('http://phpxmlrpc.sourceforge.net/doc-2/ch10.html', 'string'),
-                'specVersion' => new Value(2, 'int'),
-            ), 'struct'),
+            'introspection' => array(
+                'specUrl' => 'http://phpxmlrpc.sourceforge.net/doc-2/ch10.html',
+                'specVersion' => 2,
+            ),
         );
 
         // NIL extension
         if (PhpXmlRpc::$xmlrpc_null_extension) {
-            $outAr['nil'] = new Value(array(
-                'specUrl' => new Value('http://www.ontosys.com/xml-rpc/extensions.php', 'string'),
-                'specVersion' => new Value(1, 'int'),
-            ), 'struct');
+            $outAr['nil'] = array(
+                'specUrl' => 'http://www.ontosys.com/xml-rpc/extensions.php',
+                'specVersion' => 1
+            );
         }
 
-        return new Response(new Value($outAr, 'struct'));
+        return $outAr;
+    }
+
+    public static function _xmlrpcs_getCapabilities($server, $req = null)
+    {
+        $encoder = new Encoder();
+        return new Response($encoder->encode($server->getCapabilities()));
     }
 
     public static function _xmlrpcs_listMethods($server, $req = null) // if called in plain php values mode, second param is missing
@@ -884,7 +929,7 @@ class Server
         if ($call->kindOf() != 'struct') {
             return static::_xmlrpcs_multicall_error('notstruct');
         }
-        $methName = @$call->structmem('methodName');
+        $methName = @$call['methodName'];
         if (!$methName) {
             return static::_xmlrpcs_multicall_error('nomethod');
         }
@@ -895,20 +940,18 @@ class Server
             return static::_xmlrpcs_multicall_error('recursion');
         }
 
-        $params = @$call->structmem('params');
+        $params = @$call['params'];
         if (!$params) {
             return static::_xmlrpcs_multicall_error('noparams');
         }
         if ($params->kindOf() != 'array') {
             return static::_xmlrpcs_multicall_error('notarray');
         }
-        $numParams = $params->arraysize();
 
         $req = new Request($methName->scalarval());
-        for ($i = 0; $i < $numParams; $i++) {
-            if (!$req->addParam($params->arraymem($i))) {
-                $i++;
-
+        foreach($params as $i => $param) {
+            if (!$req->addParam($param)) {
+                $i++; // for error message, we count params from 1
                 return static::_xmlrpcs_multicall_error(new Response(0,
                     PhpXmlRpc::$xmlrpcerr['incorrect_params'],
                     PhpXmlRpc::$xmlrpcstr['incorrect_params'] . ": probable xml error in param " . $i));
@@ -951,7 +994,7 @@ class Server
         $pt = array();
         $wrapper = new Wrapper();
         foreach ($call['params'] as $val) {
-            $pt[] = $wrapper->php_2_xmlrpc_type(gettype($val));
+            $pt[] = $wrapper->php2XmlrpcType(gettype($val));
         }
 
         $result = $server->execute($call['methodName'], $call['params'], $pt);
@@ -969,10 +1012,8 @@ class Server
         // let accept a plain list of php parameters, beside a single xmlrpc msg object
         if (is_object($req)) {
             $calls = $req->getParam(0);
-            $numCalls = $calls->arraysize();
-            for ($i = 0; $i < $numCalls; $i++) {
-                $call = $calls->arraymem($i);
-                $result[$i] = static::_xmlrpcs_multicall_do_call($server, $call);
+            foreach($calls as $call) {
+                $result[] = static::_xmlrpcs_multicall_do_call($server, $call);
             }
         } else {
             $numCalls = count($req);
@@ -1005,7 +1046,7 @@ class Server
         }
         // Try to avoid as much as possible disruption to the previous error handling
         // mechanism in place
-        if ($GLOBALS['_xmlrpcs_prev_ehandler'] == '') {
+        if (self::$_xmlrpcs_prev_ehandler == '') {
             // The previous error handler was the default: all we should do is log error
             // to the default error log (if level high enough)
             if (ini_get('log_errors') && (intval(ini_get('error_reporting')) & $errCode)) {
@@ -1013,12 +1054,13 @@ class Server
             }
         } else {
             // Pass control on to previous error handler, trying to avoid loops...
-            if ($GLOBALS['_xmlrpcs_prev_ehandler'] != array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler')) {
-                if (is_array($GLOBALS['_xmlrpcs_prev_ehandler'])) {
+            if (self::$_xmlrpcs_prev_ehandler != array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler')) {
+                if (is_array(self::$_xmlrpcs_prev_ehandler)) {
                     // the following works both with static class methods and plain object methods as error handler
-                    call_user_func_array($GLOBALS['_xmlrpcs_prev_ehandler'], array($errCode, $errString, $filename, $lineNo, $context));
+                    call_user_func_array(self::$_xmlrpcs_prev_ehandler, array($errCode, $errString, $filename, $lineNo, $context));
                 } else {
-                    $GLOBALS['_xmlrpcs_prev_ehandler']($errCode, $errString, $filename, $lineNo, $context);
+                    $method = self::$_xmlrpcs_prev_ehandler;
+                    $method($errCode, $errString, $filename, $lineNo, $context);
                 }
             }
         }