X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=gosa-core%2Finclude%2Fclass_jsonRPC.inc;h=12bb2af727e989d6c9d9579cd3dd5580c14952e5;hb=f04b7b95f6468a806353f05cdd3faf97dd744d5c;hp=54cb8b72db43bdd8d9bce88eb917493d4b7f3896;hpb=07660565702bcabac10263deaa54ac89a5eca391;p=gosa.git

diff --git a/gosa-core/include/class_jsonRPC.inc b/gosa-core/include/class_jsonRPC.inc
index 54cb8b72d..12bb2af72 100644
--- a/gosa-core/include/class_jsonRPC.inc
+++ b/gosa-core/include/class_jsonRPC.inc
@@ -1,4 +1,6 @@
 <?php
+
+
 class jsonRPC {
 
     private $curlHandler = NULL;
@@ -7,46 +9,83 @@ class jsonRPC {
     private $lastStats = array();
     private $lastAction = "none";
 
-    public function __construct($config) 
+
+    private $connectUrl = "";
+    private $username = "";
+    private $userPassword = "";
+    private $authModeDigest = FALSE; 
+
+
+    /*! \brief      Constructs a new jsonRPC handle which is connected to a given URL.
+     *              It can either connect using a rpc method or via auth method digest.
+     *  @param      object      The gosa configuration object (class_config)
+     *  @param      string      The url to connect to. 
+     *  @param      string      The username for authentication
+     *  @param      string      The password to use for authentication
+     *  @param      boolean     Whether to use DIGEST authentication or not.
+     *  @return     
+     */
+    public function __construct($config, $connectUrl, $username, $userPassword, $authModeDigest=FALSE) 
     {
         $this->config = $config;
         $this->id = 0;
+
+        // Get connection data
+        $this->connectUrl     = $connectUrl; 
+        $this->username       = $username; 
+        $this->userPassword   = $userPassword; 
+        $this->authModeDigest = $authModeDigest;
+
+        // Put some usefull info in the logs 
+        DEBUG (DEBUG_RPC, __LINE__, __FUNCTION__, __FILE__,bold($this->connectUrl), "Initiated RPC "); 
+        DEBUG (DEBUG_RPC, __LINE__, __FUNCTION__, __FILE__,bold($this->username), "RPC user: "); 
+        DEBUG (DEBUG_RPC, __LINE__, __FUNCTION__, __FILE__,bold($this->userPassword),"RPC password: "); 
+        DEBUG (DEBUG_RPC, __LINE__, __FUNCTION__, __FILE__,bold($this->authModeDigest),"Digest Auth (0: No, 1: Yes): "); 
+
         $this->__login();
     }
 
+
+    /*! \brief          
+     *  @param      
+     *  @return     
+     */
     private function __login()
     {
-        // Get connection data
-        $url    =  $this->config->get_cfg_value('core','gosaRpcServer');
-        $user   =  $this->config->get_cfg_value('core','gosaRpcUser');
-        $passwd =  $this->config->get_cfg_value('core','gosaRpcPassword');
-
-        DEBUG (DEBUG_RPC, __LINE__, __FUNCTION__, __FILE__,bold($url), "Initiated RPC "); 
-        DEBUG (DEBUG_RPC, __LINE__, __FUNCTION__, __FILE__,bold($user), "RPC user: "); 
-        DEBUG (DEBUG_RPC, __LINE__, __FUNCTION__, __FILE__,bold($passwd),"RPC password: "); 
-
         // Init Curl handler
-        $this->curlHandler = curl_init($url);
+        $this->curlHandler = curl_init($this->connectUrl);
 
         // Set curl options
-        curl_setopt($this->curlHandler, CURLOPT_URL , $url);
-        curl_setopt($this->curlHandler, CURLOPT_COOKIESESSION , TRUE);
-        curl_setopt($this->curlHandler, CURLOPT_COOKIEFILE, 'cookiefile.txt'); 
-        curl_setopt($this->curlHandler, CURLOPT_POST , TRUE);
-        curl_setopt($this->curlHandler, CURLOPT_RETURNTRANSFER , TRUE);
-        curl_setopt($this->curlHandler, CURLOPT_HTTPHEADER , array('Content-Type: application/json'));
+        curl_setopt($this->curlHandler, CURLOPT_URL ,           $this->connectUrl);
+        curl_setopt($this->curlHandler, CURLOPT_POST ,          TRUE);
+        curl_setopt($this->curlHandler, CURLOPT_RETURNTRANSFER ,TRUE);
+        curl_setopt($this->curlHandler, CURLOPT_HTTPHEADER ,    array('Content-Type: application/json'));
+        curl_setopt($this->curlHandler, CURLOPT_SSL_VERIFYPEER, FALSE);
 
         // Try to login 
-        $this->login($user, $passwd);
-       
+        if($this->authModeDigest){
+            curl_setopt($this->curlHandler, CURLOPT_USERPWD , "{$this->username}:{$this->userPassword}");
+            curl_setopt($this->curlHandler, CURLOPT_HTTPAUTH , CURLAUTH_ANYSAFE);
+        }else{
+            curl_setopt($this->curlHandler, CURLOPT_COOKIESESSION , TRUE);
+            curl_setopt($this->curlHandler, CURLOPT_COOKIEFILE, 'cookiefile.txt'); 
+            $this->login($this->username, $this->userPassword);
+        }
     }
-        
 
+
+    /*! \brief      Returns the last HTTP status code.  
+     *  @return     int         The last status code.          
+     */
     public function getHTTPstatusCode()
     {
         return((isset($this->lastStats['http_code']))? $this->lastStats['http_code'] : -1 );
     }
 
+
+    /*! \brief      Returns the last error string. 
+     *  @return     string      The last error message.
+     */
     public function get_error()
     {
         if($this->lastStats['http_code'] != 200){
@@ -56,38 +95,61 @@ class jsonRPC {
         }
     }
 
+
+    /*! \brief      Returns TRUE if the last action was successfull else FALSE.
+     *  @return     boolean     TRUE on success else FALSE. 
+     */
     public function success()
     {
         return(curl_errno($this->curlHandler) == 0 && $this->lastStats['http_code'] == 200);
     }
 
+
+    /*! \brief      The class destructor, it destroys open rpc handles if needed.
+     */
     public function __destruct()
     {
         if($this->curlHandler){
-             curl_close($this->curlHandler);
+            curl_close($this->curlHandler);
         }
     }
 
+
+    /*! \brief      This is some kind of catch-all method, all unknown method names will 
+     *               will be interpreted as rpc request. 
+     *              If you call "$this->blafasel" this method will initiate an rpc request 
+     *               for method 'blafasel'.
+     *  @param      string  method   The rpc method to execute.
+     *  @param      params  array    The parameter to use.
+     *  @return     mixed            The request result.
+     */
     public function __call($method,$params) 
     {
         // Check if handle is still valid!
         if(!$this->curlHandler && $this->lastAction != 'login'){
-             $this->__login();
+            $this->__login();
         }
 
         // Start request
         DEBUG (DEBUG_RPC, __LINE__, __FUNCTION__, __FILE__,"{$method}", "Calling: "); 
         $response = $this->request($method,$params);
         if($this->success()){
-            DEBUG (DEBUG_RPC, __LINE__, __FUNCTION__, __FILE__,bold($response['result']), "Result: "); 
+            DEBUG (DEBUG_RPC, __LINE__, __FUNCTION__, __FILE__,
+                    (is_array($response['result']))?$response['result']:bold($response['result']), "Result: "); 
         }else{
             DEBUG (DEBUG_RPC, __LINE__, __FUNCTION__, __FILE__,bold($this->get_error())."<br>".$response, "Result (FAILED): "); 
         }
-
+        if(isset($response['error']) && !empty($response['error']))  print_a(array($response));
         return($response['result']);
     }
 
-    
+
+    /*! \brief      This method finally initiates the real RPC requests and handles 
+     *               the result from the server.
+     *  @param      string  method      The method to call 
+     *  @param      array   params      The paramter to use.
+     *  @return     mixed   The server response. 
+     */
     private function request($method, $params)
     {
         // Set last action 
@@ -95,7 +157,7 @@ class jsonRPC {
 
         // Reset stats of last request.
         $this->lastStats = array();
-   
+
         // Validate input  values
         if (!is_scalar($method))  trigger_error('jsonRPC::__call requires a scalar value as first parameter!');
         if (is_array($params)) {
@@ -115,67 +177,71 @@ class jsonRPC {
 
         // Set current result stats.
         $this->lastStats = curl_getinfo($this->curlHandler);
-    
+
         return($response);
     }
-    
 
+
+    /*! \brief      Returns the HTTP status message for a given HTTP status code.        
+     *  @param      int     code    The status to code to return a message for. 
+     *  @return     string  The corresponding status message. 
+     */
     public static function getHttpStatusCodeMessage($code)
     {
         $codes  = array(
-                '100' =>_('Continue'),
-                '101' =>_('Switching Protocols'),
-                '102' =>_('Processing'),
-                '200' =>_('OK'),
-                '201' =>_('Created'),
-                '202' =>_('Accepted'),
-                '203' =>_('Non-Authoritative Information'),
-                '204' =>_('No Content'),
-                '205' =>_('Reset Content'),
-                '206' =>_('Partial Content'),
-                '207' =>_('Multi-Status'),
-                '300' =>_('Multiple Choice'),
-                '301' =>_('Moved Permanently'),
-                '302' =>_('Found'),
-                '303' =>_('See Other'),
-                '304' =>_('Not Modified'),
-                '305' =>_('Use Proxy'),
-                '306' =>_('(reserviert)'),
-                '307' =>_('Temporary Redirect'),
-                '400' =>_('Bad Request'),
-                '401' =>_('Unauthorized'),
-                '402' =>_('Payment Required'),
-                '403' =>_('Forbidden'),
-                '404' =>_('Not Found'),
-                '405' =>_('Method Not Allowed'),
-                '406' =>_('Not Acceptable'),
-                '407' =>_('Proxy Authentication Required'),
-                '408' =>_('Request Time-out'),
-                '409' =>_('Conflict'),
-                '410' =>_('Gone'),
-                '411' =>_('Length Required'),
-                '412' =>_('Precondition Failed'),
-                '413' =>_('Request Entity Too Large'),
-                '414' =>_('Request-URI Too Long'),
-                '415' =>_('Unsupported Media Type'),
-                '416' =>_('Requested range not satisfiable'),
-                '417' =>_('Expectation Failed'),
-                '421' =>_('There are too many connections from your internet address'),
-                '422' =>_('Unprocessable Entity'),
-                '423' =>_('Locked'),
-                '424' =>_('Failed Dependency'),
-                '425' =>_('Unordered Collection'),
-                '426' =>_('Upgrade Required'),
-                '500' =>_('Internal Server Error'),
-                '501' =>_('Not Implemented'),
-                '502' =>_('Bad Gateway'),
-                '503' =>_('Service Unavailable'),
-                '504' =>_('Gateway Time-out'),
-                '505' =>_('HTTP Version not supported'),
-                '506' =>_('Variant Also Negotiates'),
-                '507' =>_('Insufficient Storage'),
-                '509' =>_('Bandwidth Limit Exceeded'),
-                '510' =>_('Not Extended'));
+                '100' =>  'Continue',
+                '101' =>  'Switching Protocols',
+                '102' =>  'Processing',
+                '200' =>  'OK',
+                '201' =>  'Created',
+                '202' =>  'Accepted',
+                '203' =>  'Non-Authoritative Information',
+                '204' =>  'No Content',
+                '205' =>  'Reset Content',
+                '206' =>  'Partial Content',
+                '207' =>  'Multi-Status',
+                '300' =>  'Multiple Choice',
+                '301' =>  'Moved Permanently',
+                '302' =>  'Found',
+                '303' =>  'See Other',
+                '304' =>  'Not Modified',
+                '305' =>  'Use Proxy',
+                '306' =>  'reserved',
+                '307' =>  'Temporary Redirect',
+                '400' =>  'Bad Request',
+                '401' =>  'Unauthorized',
+                '402' =>  'Payment Required',
+                '403' =>  'Forbidden',
+                '404' =>  'Not Found',
+                '405' =>  'Method Not Allowed',
+                '406' =>  'Not Acceptable',
+                '407' =>  'Proxy Authentication Required',
+                '408' =>  'Request Time-out',
+                '409' =>  'Conflict',
+                '410' =>  'Gone',
+                '411' =>  'Length Required',
+                '412' =>  'Precondition Failed',
+                '413' =>  'Request Entity Too Large',
+                '414' =>  'Request-URI Too Long',
+                '415' =>  'Unsupported Media Type',
+                '416' =>  'Requested range not satisfiable',
+                '417' =>  'Expectation Failed',
+                '421' =>  'There are too many connections from your internet address',
+                '422' =>  'Unprocessable Entity',
+                '423' =>  'Locked',
+                '424' =>  'Failed Dependency',
+                '425' =>  'Unordered Collection',
+                '426' =>  'Upgrade Required',
+                '500' =>  'Internal Server Error',
+                '501' =>  'Not Implemented',
+                '502' =>  'Bad Gateway',
+                '503' =>  'Service Unavailable',
+                '504' =>  'Gateway Time-out',
+                '505' =>  'HTTP Version not supported',
+                '506' =>  'Variant Also Negotiates',
+                '507' =>  'Insufficient Storage',
+                '509' =>  'Bandwidth Limit Exceeded',
+                '510' =>  'Not Extended');
         return((isset($codes[$code]))? $codes[$code] : sprintf(_("Unknown HTTP status code '%s'!"), $code));
     }
 }