From 3336bba7ac3ad67fbe0643d4858eb01e20163f9e Mon Sep 17 00:00:00 2001
From: Webslice <webslice@bixels.nl>
Date: Sat, 28 Mar 2020 16:09:23 +0100
Subject: [PATCH] Load remoting classes from modules
---
interface/lib/classes/json_handler.inc.php | 40 +---------
.../lib/classes/remoting_handler_base.inc.php | 75 +++++++++++++++++++
interface/lib/classes/rest_handler.inc.php | 40 +---------
interface/lib/classes/soap_handler.inc.php | 40 +---------
interface/web/remote/index.php | 2 +-
interface/web/remote/json.php | 2 +-
interface/web/remote/rest.php | 2 +-
7 files changed, 81 insertions(+), 120 deletions(-)
create mode 100644 interface/lib/classes/remoting_handler_base.inc.php
diff --git a/interface/lib/classes/json_handler.inc.php b/interface/lib/classes/json_handler.inc.php
index de8dd5ba0d..fb0811d314 100644
--- a/interface/lib/classes/json_handler.inc.php
+++ b/interface/lib/classes/json_handler.inc.php
@@ -30,45 +30,7 @@ EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
-class ISPConfigJSONHandler {
- private $methods = array();
- private $classes = array();
-
- 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));
- }
-
+class ISPConfigJSONHandler extends ISPConfigRemotingHandlerBase {
private function _return_json($code, $message, $data = false) {
$ret = new stdClass;
$ret->code = $code;
diff --git a/interface/lib/classes/remoting_handler_base.inc.php b/interface/lib/classes/remoting_handler_base.inc.php
new file mode 100644
index 0000000000..6393959df8
--- /dev/null
+++ b/interface/lib/classes/remoting_handler_base.inc.php
@@ -0,0 +1,75 @@
+<?php
+
+/*
+Copyright (c) 2020, ISPConfig
+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 ISPConfigRemotingHandlerBase
+{
+ protected $methods = array();
+ protected $classes = array();
+
+ public function __construct()
+ {
+ global $app;
+
+ // load main remoting file
+ $app->load('remoting');
+
+ // load all remoting classes and get their methods
+ $this->load_remoting_classes(realpath(__DIR__) . '/remote.d/*.inc.php');
+
+ // load all remoting classes from modules
+ $this->load_remoting_classes(realpath(__DIR__) . '/../../web/*/lib/classes/remote.d/*.inc.php');
+
+ // 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 load_remoting_classes($glob_pattern)
+ {
+ $files = glob($glob_pattern);
+
+ foreach ($files as $file) {
+ $name = str_replace('.inc.php', '', basename($file));
+ $class_name = 'remoting_' . $name;
+
+ include_once $file;
+ 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;
+ }
+ }
+ }
+ }
+}
diff --git a/interface/lib/classes/rest_handler.inc.php b/interface/lib/classes/rest_handler.inc.php
index ceaa7c63be..ae3e443d48 100644
--- a/interface/lib/classes/rest_handler.inc.php
+++ b/interface/lib/classes/rest_handler.inc.php
@@ -30,46 +30,8 @@ EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
-class ISPConfigRESTHandler {
- private $methods = array();
- private $classes = array();
-
+class ISPConfigRESTHandler extends ISPConfigRemotingHandlerBase {
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);
diff --git a/interface/lib/classes/soap_handler.inc.php b/interface/lib/classes/soap_handler.inc.php
index 704e21b20b..16693e12c9 100644
--- a/interface/lib/classes/soap_handler.inc.php
+++ b/interface/lib/classes/soap_handler.inc.php
@@ -30,45 +30,7 @@ EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
-class ISPConfigSoapHandler {
- private $methods = array();
- private $classes = array();
-
- 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_once $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));
- }
-
+class ISPConfigSoapHandler extends ISPConfigRemotingHandlerBase {
public function __call($method, $params) {
if(array_key_exists($method, $this->methods) == false) {
throw new SoapFault('invalid_method', 'Method ' . $method . ' does not exist');
diff --git a/interface/web/remote/index.php b/interface/web/remote/index.php
index 670a9db13b..6352dfe504 100644
--- a/interface/web/remote/index.php
+++ b/interface/web/remote/index.php
@@ -8,7 +8,7 @@ require_once '../../lib/app.inc.php';
if($conf['demo_mode'] == true) $app->error('This function is disabled in demo mode.');
-$app->load('soap_handler,getconf');
+$app->load('remoting_handler_base,soap_handler,getconf');
$security_config = $app->getconf->get_security_config('permissions');
if($security_config['remote_api_allowed'] != 'yes') die('Remote API is disabled in security settings.');
diff --git a/interface/web/remote/json.php b/interface/web/remote/json.php
index 926a995395..d6eb8dcbc1 100644
--- a/interface/web/remote/json.php
+++ b/interface/web/remote/json.php
@@ -8,7 +8,7 @@ require_once '../../lib/app.inc.php';
if($conf['demo_mode'] == true) $app->error('This function is disabled in demo mode.');
-$app->load('json_handler,getconf');
+$app->load('remoting_handler_base,json_handler,getconf');
$security_config = $app->getconf->get_security_config('permissions');
if($security_config['remote_api_allowed'] != 'yes') die('Remote API is disabled in security settings.');
diff --git a/interface/web/remote/rest.php b/interface/web/remote/rest.php
index 4f202c6eee..381fd42655 100644
--- a/interface/web/remote/rest.php
+++ b/interface/web/remote/rest.php
@@ -6,7 +6,7 @@ require_once '../../lib/config.inc.php';
$conf['start_session'] = false;
require_once '../../lib/app.inc.php';
-$app->load('rest_handler,getconf');
+$app->load('remoting_handler_base,rest_handler,getconf');
$security_config = $app->getconf->get_security_config('permissions');
if($security_config['remote_api_allowed'] != 'yes') die('Remote API is disabled in security settings.');
--
GitLab