Code

Updated RPC client
authorhickert <hickert@594d385d-05f5-0310-b6e9-bd551577e9d8>
Fri, 28 May 2010 14:10:22 +0000 (14:10 +0000)
committerhickert <hickert@594d385d-05f5-0310-b6e9-bd551577e9d8>
Fri, 28 May 2010 14:10:22 +0000 (14:10 +0000)
git-svn-id: https://oss.gonicus.de/repositories/gosa/trunk@18789 594d385d-05f5-0310-b6e9-bd551577e9d8

gosa-core/include/class_jsonRPC.inc

index bcfe9467e929fd153d3a5e95ce5226dacb34f74f..54f98096ca7a8ed6d86a71b410b1802f883a41b5 100644 (file)
 <?php
-/*
-                                       COPYRIGHT
+class jsonRPC {
 
-Copyright 2007 Sergio Vaccaro <sergio@inservibile.org>
-
-This file is part of JSON-RPC PHP.
-
-JSON-RPC PHP is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-JSON-RPC PHP is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+    private $curlHandler = NULL;
+    private $debug;
+    private $url;
+    private $id;
 
-You should have received a copy of the GNU General Public License
-along with JSON-RPC PHP; if not, write to the Free Software
-Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-*/
+    public function __construct($url,$debug = false) {
 
-/**
- * The object of this class are generic jsonRPC 1.0 clients
- * http://json-rpc.org/wiki/specification
- *
- * @author sergio <jsonrpcphp@inservibile.org>
- */
-class jsonRPCClient {
+        $this->url = $url;
+        $this->dbug = $debug;
+        $this->id = 1;
 
-    private $curlHandler = NULL;
-       
-       /**
-        * Debug state
-        *
-        * @var boolean
-        */
-       private $debug;
-       
-       /**
-        * The server URL
-        *
-        * @var string
-        */
-       private $url;
-       /**
-        * The request id
-        *
-        * @var integer
-        */
-       private $id;
-       /**
-        * If true, notifications are performed instead of requests
-        *
-        * @var boolean
-        */
-       private $notification = false;
-       
-       /**
-        * Takes the connection parameters
-        *
-        * @param string $url
-        * @param boolean $debug
-        */
-       public function __construct($url,$debug = false) {
-               // server URL
-               $this->url = $url;
-               // proxy
-               empty($proxy) ? $this->proxy = '' : $this->proxy = $proxy;
-               // debug state
-               empty($debug) ? $this->debug = false : $this->debug = true;
-               // message id
-               $this->id = 1;
-        
         // Init Curl handler
         $this->curlHandler = curl_init($this->url);
         curl_setopt($this->curlHandler, CURLOPT_URL , $this->url);
         curl_setopt($this->curlHandler, CURLOPT_COOKIESESSION , TRUE);
         curl_setopt($this->curlHandler, CURLOPT_COOKIEFILE, 'cookiefile.txt'); 
-       }
-       
-       /**
-        * Sets the notification state of the object. In this state, notifications are performed, instead of requests.
-        *
-        * @param boolean $notification
-        */
-       public function setRPCNotification($notification) {
-               empty($notification) ?
-                                                       $this->notification = false
-                                                       :
-                                                       $this->notification = true;
-       }
-       
-       /**
-        * Performs a jsonRCP request and gets the results as an array
-        *
-        * @param string $method
-        * @param array $params
-        * @return array
-        */
-       public function __call($method,$params) {
-               
-               // check
-               if (!is_scalar($method)) {
-                       throw new Exception('Method name has no scalar value');
-               }
-               
-               // check
-               if (is_array($params)) {
-                       // no keys
-                       $params = array_values($params);
-               } else {
-                       throw new Exception('Params must be given as array');
-               }
-               
-               // sets notification or request task
-               if ($this->notification) {
-                       $currentId = NULL;
-               } else {
-                       $currentId = $this->id;
-               }
-               
-               // prepares the request
-               $request = array(
-                                               'method' => $method,
-                                               'params' => $params,
-                                               'id' => $currentId
-                                               );
-               $request = json_encode($request);
-               $this->debug && $this->debug.='***** Request *****'."\n".$request."\n".'***** End Of request *****'."\n\n";
-       
         curl_setopt($this->curlHandler, CURLOPT_POST , TRUE);
-        curl_setopt($this->curlHandler, CURLOPT_POSTFIELDS , $request);
         curl_setopt($this->curlHandler, CURLOPT_RETURNTRANSFER , TRUE);
         curl_setopt($this->curlHandler, CURLOPT_HTTPHEADER , array('Content-Type: application/json'));
+    }
+
+    public function __call($method,$params) {
+
+        if (!is_scalar($method))  trigger_error('jsonRPC::__call requires a scalar value as first parameter!');
+
+        if (is_array($params)) {
+            $params = array_values($params);
+        } else {
+            trigger_error('jsonRPC::__call requires an array value as second parameter!');
+        }
+
+        // prepares the request
+        $this->id ++;
+        $request = json_encode(array('method' => $method,'params' => $params,'id' => $this->id));
+
+        // Set curl options
+        curl_setopt($this->curlHandler, CURLOPT_POSTFIELDS , $request);
         $response = curl_exec($this->curlHandler);        
-               $this->debug && $this->debug.='***** Server response *****'."\n".$response.'***** End of server response *****'."\n";
-         $response = json_decode($response,true);
+        $response = json_decode($response,true);
+
+        // Check responce id
+        if ($response['id'] != $this->id){
+            trigger_error('jsonPRC returned incorrect response id (request id: '.$this->id.', response id: '.$response['id'].')');
+        }
 
-               // debug output
-               if ($this->debug) {
-                       echo nl2br($debug);
-               }
-               
-               // final checks and return
-               if (!$this->notification) {
-                       // check
-                       if ($response['id'] != $currentId) {
-                               throw new Exception('Incorrect response id (request id: '.$currentId.', response id: '.$response['id'].')');
-                       }
-                       if (!is_null($response['error'])) {
-                               throw new Exception('Request error: '.$response['error']);
-                       }
-                       
-                       return $response['result'];
-                       
-               } else {
-                       return true;
-               }
-       }
+        return($response['result']);
+    }
 }
 ?>