Page MenuHomePhorge
Files F117752016

kolab_client_api.php
No OneTemporary
Actions

Authored By
Unknown
Size
6 KB
Referenced Files
None
Subscribers
None

kolab_client_api.php
View Options

<?php
/*
+--------------------------------------------------------------------------+
| This file is part of the Kolab Web Admin Panel |
| |
| Copyright (C) 2011-2012, Kolab Systems AG |
| |
| This program is free software: you can redistribute it and/or modify |
| it under the terms of the GNU Affero General Public License as published |
| by the Free Software Foundation, either version 3 of the License, or |
| (at your option) any later version. |
| |
| This program 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 Affero General Public License for more details. |
| |
| You should have received a copy of the GNU Affero General Public License |
| along with this program. If not, see <http://www.gnu.org/licenses/> |
+--------------------------------------------------------------------------+
| Author: Aleksander Machniak <machniak@kolabsys.com> |
+--------------------------------------------------------------------------+
*/
/**
* Helper class to connect to the API
*/
class kolab_client_api
{
/**
* @var HTTP_Request2
*/
private $request;
/**
* @var string
*/
private $base_url;
const STATUS_OK = 0;
const STATUS_ERROR = 1;
const ERROR_INTERNAL = 100;
const ERROR_CONNECTION = 200;
/**
* Class constructor.
*
* @param string $base_url Base URL of the Kolab API
*/
public function __construct($base_url)
{
$this->base_url = $base_url;
$this->init();
}
/**
* Initializes HTTP Request object.
*/
public function init()
{
$this->request = new HTTP_Request2();
// Configure connection options
$config = Conf::get_instance();
$options = array(
'ssl_verify_peer' => Conf::BOOL,
'ssl_verify_host' => Conf::BOOL,
'ssl_cafile' => Conf::STRING,
'ssl_capath' => Conf::STRING,
'ssl_local_cert' => Conf::STRING,
'ssl_passphrase' => Conf::STRING,
);
foreach ($options as $optname => $opttype) {
if (($optvalue = $config->get('kolab_wap', $optname, $opttype)) !== null) {
try {
$this->request->setConfig($optname, $optvalue);
}
catch (Exception $e) {
write_log('errors', $e->getMessage());
}
}
}
}
/**
* Logs specified user into the API
*
* @param string $username User name
* @param string $password User password
*
* @return kolab_client_api_result Request response
*/
public function login($username, $password)
{
$query = array(
'username' => $username,
'password' => $password
);
$response = $this->post('system.authenticate', null, $query);
return $response;
}
/**
* Logs specified user out of the API
*
* @return bool True on success, False on failure
*/
public function logout()
{
$response = $this->get('system.quit');
return $response->get_error_code() ? false : true;
}
/**
* Sets session token value.
*
* @param string $token Token string
*/
public function set_session_token($token)
{
$this->request->setHeader('X-Session-Token', $token);
}
/**
* Gets capabilities of the API (according to logged in user).
*
* @return kolab_client_api_result Capabilities response
*/
public function get_capabilities()
{
$this->get('system.capabilities');
}
/**
* API's GET request.
*
* @param string $action Action name
* @param array $args Request arguments
*
* @return kolab_client_api_result Response
*/
public function get($action, $args = array())
{
$url = $this->build_url($action, $args);
$this->request->setMethod(HTTP_Request2::METHOD_GET);
//console("GET", $url);
return $this->get_response($url);
}
/**
* API's POST request.
*
* @param string $action Action name
* @param array $url_args URL arguments
* @param array $post POST arguments
*
* @return kolab_client_api_result Response
*/
public function post($action, $url_args = array(), $post = array())
{
$url = $this->build_url($action, $url_args);
$this->request->setMethod(HTTP_Request2::METHOD_POST);
$this->request->setBody(@json_encode($post));
//console("POST", $url, $post);
return $this->get_response($url);
}
/**
* @param string $action Action GET parameter
* @param array $args GET parameters (hash array: name => value)
*
* @return Net_URL2 URL object
*/
private function build_url($action, $args)
{
$url = $this->base_url;
if ($action) {
$url .= '/' . urlencode($action);
}
$url = new Net_URL2($url);
if (!empty($args)) {
$url->setQueryVariables($args);
}
return $url;
}
/**
* HTTP Response handler.
*
* @param Net_URL2 $url URL object
*
* @return kolab_client_api_result Response object
*/
private function get_response($url)
{
try {
$this->request->setUrl($url);
$response = $this->request->send();
}
catch (Exception $e) {
return new kolab_client_api_result(null,
self::ERROR_CONNECTION, $e->getMessage());
}
try {
$body = $response->getBody();
}
catch (Exception $e) {
return new kolab_client_api_result(null,
self::ERROR_INTERNAL, $e->getMessage());
}
$body = @json_decode($body, true);
$err_code = null;
$err_str = null;
if (is_array($body) && (empty($body['status']) || $body['status'] != 'OK')) {
$err_code = !empty($body['code']) ? $body['code'] : self::ERROR_INTERNAL;
$err_str = !empty($body['reason']) ? $body['reason'] : 'Unknown error';
}
else if (!is_array($body)) {
$err_code = self::ERROR_INTERNAL;
$err_str = 'Unable to decode response';
}
return new kolab_client_api_result($body, $err_code, $err_str);
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Apr 4, 3:41 AM (7 h, 55 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
94/1d/a4e46e9349308645ccfcbfd983d5
Default Alt Text
kolab_client_api.php (6 KB)

Event Timeline