index 54f98096ca7a8ed6d86a71b410b1802f883a41b5..12bb2af727e989d6c9d9579cd3dd5580c14952e5 100644 (file)
<?php
+
+
class jsonRPC {
private $curlHandler = NULL;
- private $debug;
- private $url;
+ private $config;
private $id;
+ private $lastStats = array();
+ private $lastAction = "none";
+
+
+ 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;
- public function __construct($url,$debug = false) {
+ // Get connection data
+ $this->connectUrl = $connectUrl;
+ $this->username = $username;
+ $this->userPassword = $userPassword;
+ $this->authModeDigest = $authModeDigest;
- $this->url = $url;
- $this->dbug = $debug;
- $this->id = 1;
+ // 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()
+ {
// 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');
- 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'));
+ $this->curlHandler = curl_init($this->connectUrl);
+
+ // Set curl options
+ 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
+ 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);
+ }
}
- public function __call($method,$params) {
- if (!is_scalar($method)) trigger_error('jsonRPC::__call requires a scalar value as first parameter!');
+ /*! \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){
+ return($this->getHttpStatusCodeMessage($this->lastStats['http_code']));
+ }else{
+ return(curl_error($this->curlHandler));
+ }
+ }
+
+
+ /*! \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);
+ }
+ }
+
+ /*! \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();
+ }
+
+ // Start request
+ DEBUG (DEBUG_RPC, __LINE__, __FUNCTION__, __FILE__,"{$method}", "Calling: ");
+ $response = $this->request($method,$params);
+ if($this->success()){
+ 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
+ $this->lastAction = $method;
+
+ // 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)) {
$params = array_values($params);
} else {
$response = curl_exec($this->curlHandler);
$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'].')');
- }
+ // Set current result stats.
+ $this->lastStats = curl_getinfo($this->curlHandler);
- return($response['result']);
+ 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' => '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));
}
}
?>