maketank/Froxlor
2
0
Fork 0
Code Pull Requests Releases Activity

add new api-module to output list of possible modules/functions

Browse Source 
Signed-off-by: Michael Kaufmann (d00p) <d00p@froxlor.org>
This commit is contained in:
Michael Kaufmann (d00p)
2018-02-18 10:19:17 +01:00
parent bdfd601dae
commit 532551263d
6 changed files with 272 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
lib/classes/api/abstract.ApiCommand.php
View File

@@ -213,16 +213,6 @@ abstract class ApiCommand
return $json_response;
}
public abstract function list();
public abstract function get();
public abstract function add();
public abstract function update();
public abstract function delete();
private function readUserData($header = null)
{
$sel_stmt = Database::prepare("SELECT * FROM `api_keys` WHERE `apikey` = :ak AND `secret` = :as");

31
lib/classes/api/commands/class.Customers.php
View File

@@ -1,8 +1,13 @@
<?php
class Customers extends ApiCommand
class Customers extends ApiCommand implements ResourceEntity
{
/**
* lists all customer entries
*
* @return array count|list
*/
public function list()
{
if ($this->isAdmin()) {
@@ -32,6 +37,14 @@ class Customers extends ApiCommand
throw new Exception("Not allowed to execute given command.", 403);
}
/**
* return a customer entry by id
*
* @param int $id customer-id
*
* @throws Exception
* @return array
*/
public function get()
{
if ($this->isAdmin()) {
@@ -655,6 +668,14 @@ class Customers extends ApiCommand
throw new Exception("Not allowed to execute given command.", 403);
}
/**
* delete a customer entry by id
*
* @param int $id customer-id
*
* @throws Exception
* @return array
*/
public function delete()
{
if ($this->isAdmin()) {
@@ -880,6 +901,14 @@ class Customers extends ApiCommand
throw new Exception("Not allowed to execute given command.", 403);
}
/**
* unlock a locked customer by id
*
* @param int $id customer-id
*
* @throws Exception
* @return array
*/
public function unlock()
{
if ($this->isAdmin()) {

24
lib/classes/api/commands/class.Domains.php
View File

@@ -1,8 +1,13 @@
<?php
class Domains extends ApiCommand
class Domains extends ApiCommand implements ResourceEntity
{
/**
* lists all domain entries
*
* @return array count|list
*/
public function list()
{
if ($this->isAdmin()) {
@@ -32,6 +37,15 @@ class Domains extends ApiCommand
throw new Exception("Not allowed to execute given command.", 403);
}
/**
* return a domain entry by id
*
* @param int $id domain-id
* @param boolean $no_std_subdomain optional, default false
*
* @throws Exception
* @return array
*/
public function get()
{
if ($this->isAdmin()) {
@@ -1503,6 +1517,14 @@ class Domains extends ApiCommand
throw new Exception("Not allowed to execute given command.", 403);
}
/**
* delete a domain entry by id
*
* @param int $id domain-id
*
* @throws Exception
* @return array
*/
public function delete()
{
if ($this->isAdmin()) {

182
lib/classes/api/commands/class.Froxlor.php Normal file
View File

@@ -0,0 +1,182 @@
<?php
class Froxlor extends ApiCommand
{
/**
* returns a list of all available api functions
*
* @param string $module optional, return list of functions for a specific module
*
* @throws Exception
* @return array
*/
public function listFunctions()
{
$module = $this->getParam('module');
$functions = array();
if ($module != null) {
// check existence
$this->requireModules($module);
// now get all static functions
$reflection = new \ReflectionClass($module);
$_functions = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
foreach ($_functions as $func) {
if ($func->class == $module && $func->isPublic()) {
array_push($functions, array_merge(array(
'module' => $module,
'function' => $func->name
), $this->_getParamListFromDoc($module, $func->name)));
}
}
} else {
// check all the modules
$path = FROXLOR_INSTALL_DIR . '/lib/classes/api/commands/';
// valid directory?
if (is_dir($path)) {
// create RecursiveIteratorIterator
$its = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($path));
// check every file
foreach ($its as $fullFileName => $it) {
// does it match the Filename pattern?
$matches = array();
if (preg_match("/^class\.(.+)\.php$/i", $it->getFilename(), $matches)) {
// check for existence
try {
// set the module to be in our namespace
$mod = $matches[1];
$this->requireModules($mod);
} catch (Exception $e) {
// @todo log?
continue;
}
// now get all static functions
$reflection = new \ReflectionClass($mod);
$_functions = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
foreach ($_functions as $func) {
if ($func->class == $mod && $func->isPublic()) {
array_push($functions, array_merge(array(
'module' => $matches[1],
'function' => $func->name
), $this->_getParamListFromDoc($matches[1], $func->name)));
}
}
}
}
} else {
// yikes - no valid directory to check
throw new Exception("Cannot search directory '" . $path . "'. No such directory.", 500);
}
}
// return the list
return $this->response(200, "successfull", $functions);
}
/**
* generate an api-response to list all parameters and the return-value of
* a given module.function-combination
*
* @param string $module
* @param string $function
*
* @throws Exception
* @return array|bool
*/
private function _getParamListFromDoc($module = null, $function = null)
{
try {
// set the module to be in our namespace
$cls = new \ReflectionMethod($module, $function);
$comment = $cls->getDocComment();
if ($comment == false) {
return array(
'head' => 'There is no comment-block for "' . $module . '.' . $function . '"'
);
}
$clines = explode("\n", $comment);
$result = array();
$result['params'] = array();
foreach ($clines as $c) {
$c = trim($c);
// check param-section
if (strpos($c, '@param')) {
preg_match('/^\*\s\@param\s(.+)\s(\$\w+)(\s.*)?/', $c, $r);
// cut $ off the parameter-name as it is not wanted in the api-request
$result['params'][] = array(
'parameter' => substr($r[2], 1),
'type' => $r[1],
'desc' => (isset($r[3]) ? trim($r['3']) : '')
);
} // check return-section
elseif (strpos($c, '@return')) {
preg_match('/^\*\s\@return\s(\w+)(\s.*)?/', $c, $r);
if (! isset($r[0]) || empty($r[0])) {
$r[1] = 'null';
$r[2] = 'This function has no return value given';
}
$result['return'] = array(
'type' => $r[1],
'desc' => (isset($r[2]) ? trim($r[2]) : '')
);
} else if (! empty($c) && strpos($c, '@throws') === false) {
if (substr($c, 0, 3) == "/**")
continue;
if (substr($c, 0, 2) == "*/")
continue;
if (substr($c, 0, 1) == "*")
$c = trim(substr($c, 1));
if (empty($c))
continue;
if (! isset($result['head']) || empty($result['head'])) {
$result['head'] = $c . " ";
} else {
$result['head'] .= $c . " ";
}
}
}
return $result;
} catch (\ReflectionException $e) {
return array();
}
}
/**
* this functions is used to check the availability
* of a given list of modules.
* If either one of
* them are not found, throw an Exception
*
* @param string|array $modules
*
* @throws Exception
*/
private function requireModules($modules = null)
{
if ($modules != null) {
// no array -> create one
if (! is_array($modules)) {
$modules = array(
$modules
);
}
// check all the modules
foreach ($modules as $module) {
try {
// can we use the class?
if (class_exists($module)) {
continue;
} else {
throw new Exception('The required class "' . $module . '" could not be found but the module-file exists', 404);
}
} catch (Exception $e) {
// The autoloader will throw an Exception
// that the required class could not be found
// but we want a nicer error-message for this here
throw new Exception('The required module "' . $module . '" could not be found', 404);
}
}
}
}
}

23
lib/classes/api/commands/class.IpsAndPorts.php
View File

@@ -1,8 +1,13 @@
<?php
class IpsAndPorts extends ApiCommand
class IpsAndPorts extends ApiCommand implements ResourceEntity
{
/**
* lists all ip/port entries
*
* @return array count|list
*/
public function list()
{
if ($this->isAdmin() && $this->getUserDetail('change_serversettings')) {
@@ -23,6 +28,14 @@ class IpsAndPorts extends ApiCommand
throw new Exception("Not allowed to execute given command.", 403);
}
/**
* return an ip/port entry by id
*
* @param int $id ip-port-id
*
* @throws Exception
* @return array
*/
public function get()
{
if ($this->isAdmin() && $this->getUserDetail('change_serversettings')) {
@@ -314,6 +327,14 @@ class IpsAndPorts extends ApiCommand
throw new Exception("Not allowed to execute given command.", 403);
}
/**
* delete an ip/port entry by id
*
* @param int $id ip-port-id
*
* @throws Exception
* @return array
*/
public function delete()
{
if ($this->isAdmin() && $this->getUserDetail('change_serversettings')) {

15
lib/classes/api/interface.ResourceEntity.php Normal file
View File

@@ -0,0 +1,15 @@
<?php
interface ResourceEntity
{
public function list();
public function get();
public function add();
public function update();
public function delete();
}