Skip to content

I
ISPConfig 3
Commit a2bc35c5 authored by Marius Burkard's avatar Marius Burkard
Browse files
Options

- implemented REST handler

parent 06e64403
Hide whitespace changes
Inline Side-by-side
Showing with 193 additions and 0 deletions
interface/lib/classes/rest_handler.inc.php 0 → 100644
View file @ a2bc35c5
<?php
/*
Copyright (c) 2017, Marius Burkard, pixcept KG
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of ISPConfig nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
class ISPConfigRESTHandler {
private $methods = array();
private $classes = array();
private $api_version = 1;
public function __construct() {
global $app;
// load main remoting file
$app->load('remoting');
// load all remote classes and get their methods
$dir = dirname(realpath(__FILE__)) . '/remote.d';
$d = opendir($dir);
while($f = readdir($d)) {
if($f == '.' || $f == '..') continue;
if(!is_file($dir . '/' . $f) || substr($f, strrpos($f, '.')) != '.php') continue;
$name = substr($f, 0, strpos($f, '.'));
include $dir . '/' . $f;
$class_name = 'remoting_' . $name;
if(class_exists($class_name, false)) {
$this->classes[$class_name] = new $class_name();
foreach(get_class_methods($this->classes[$class_name]) as $method) {
$this->methods[$method] = $class_name;
}
}
}
closedir($d);
// add main methods
$this->methods['login'] = 'remoting';
$this->methods['logout'] = 'remoting';
$this->methods['get_function_list'] = 'remoting';
// create main class
$this->classes['remoting'] = new remoting(array_keys($this->methods));
}
private function _return_error($code, $codename, $message) {
header('HTTP/1.1 ' . $code . ' ' . $codename);
print '<!DOCTYPE html>
<html lang="en">
<head>
<title>
ERROR ' . $code . ': ' . $codename . '
</title>
</head>
<body>
<h1>' . $code . ': ' . $codename . '</h1>
<p>' . htmlentities($message, ENT_QUOTES, 'UTF-8') . '</p>
</body>
</html>';
exit;
}
private function _return_json($code, $data = '') {
header('HTTP/1.1 ' . $code . ' OK');
if(!is_array($data) && !is_object($data)) {
header('Content-Type: text/plain; charset="utf-8"');
print $data;
} else {
header('Content-Type: application/json; charset="utf-8"');
print json_encode($data);
}
exit;
}
public function run() {
// check called http method
$method = '';
$return_code = 0;
$http_method = (isset($_SERVER['REQUEST_METHOD']) ? $_SERVER['REQUEST_METHOD'] : '');
if($http_method == 'POST') {
$method = 'add';
$return_code = 201;
} elseif($http_method == 'GET') {
$method = 'get';
$return_code = 200;
} elseif($http_method == 'PUT') {
$method = 'update';
$return_code = 204;
} elseif($http_method == 'DELETE') {
$method = 'delete';
$return_code = 204;
} else {
$this->_return_error(400, 'INVALID REQUEST', 'Invalid request');
}
$params = array();
if($http_method == 'POST' || $http_method == 'PUT') {
$raw = file_get_contents("php://input");
$json = json_decode($raw, true);
if(!is_array($json)) $this->_return_error(400, 'INVALID REQUEST', 'The JSON data sent to the api is invalid');
}
// get URL
$url_path = (isset($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : '');
if(!preg_match('^\/?remote\/api\/v(\d+)\/(\w+)(?:\/(\d+)|\/)?(?:\?.*)$/', $url_path, $parts)) {
$this->_return_error(400, 'INVALID REQUEST', 'The url you called is not a valid REST url.');
}
$this->api_version = $parts[1];
if($this->api_version != 1) {
$this->_return_error(400, 'INVALID REQUEST', 'Invalid API version called.');
}
$section = $parts[2];
$primary_id = (isset($parts[3]) ? $parts[3] : 0);
$qry = (isset($_SERVER['QUERY_STRING']) ? $_SERVER['QUERY_STRING'] : '');
$get = array();
parse_str($qry, $get);
$method = $section . '_' . $method;
if(array_key_exists($method, $this->methods) == false) {
$this->_return_error(400, 'INVALID REQUEST', 'Method ' . $method . ' does not exist');
}
$class_name = $this->methods[$method];
if(array_key_exists($class_name, $this->classes) == false) {
$this->_return_error(400, 'INVALID REQUEST', 'Class ' . $class_name . ' does not exist');
}
if(method_exists($this->classes[$class_name], $method) == false) {
$this->_return_error(400, 'INVALID REQUEST', 'Method ' . $method . ' does not exist in the class it was expected (' . $class_name . ')');
}
$methObj = new ReflectionMethod($this->classes[$class_name], $method);
foreach($methObj->getParameters() as $param) {
$pname = $param->name;
if($pname == 'session_id') $params[] = (isset($get['session_id']) ? $get['session_id'] : '');
elseif($pname == 'primary_id' && $primary_id) $params[] = $primary_id;
elseif(isset($json[$pname])) $params[] = $json[$pname];
else $params[] = null;
}
try {
$this->_return_json($return_code, call_user_func_array(array($this->classes[$class_name], $method), $params));
} catch(SoapFault $e) {
$this->_return_error(500, 'REQUEST ERROR', $e->getMessage());
}
}
}
?>
interface/web/remote/rest.php 0 → 100644
View file @ a2bc35c5
<?php
require_once '../../lib/config.inc.php';
$conf['start_session'] = false;
require_once '../../lib/app.inc.php';
$app->load('rest_handler');
$rest_handler = new ISPConfigRESTHandler();
$rest_handler->run();
?>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment