- get rid of SoapFault dependency when using json/rest remoting endpoint

Author: Marius Burkard

interface/lib/classes/json_handler.inc.php

@@ -115,11 +115,17 @@ public function run() {
 
 		try {
 			$this->_return_json('ok', '', call_user_func_array(array($this->classes[$class_name], $method), $params));
-		} catch(SoapFault $e) {
+		} catch(ISPConfigRemoteException $e) {
 			$this->_return_json('remote_fault', $e->getMessage());
 		}
 	}
 
 }
 
-?>
+if(!class_exists('ISPConfigRemoteException')) {
+	class ISPConfigRemoteException extends Exception {
+		public function __construct($code = '', $message = '') {
+			parent::__construct($message . ' (' . $code . ')', 0);
+		}
+	}
+}

interface/lib/classes/remote.d/admin.inc.php

@@ -52,7 +52,7 @@ public function update_record_permissions($session_id, $tablename, $index_field,
 		global $app;
 
 		if(!$this->checkPerm($session_id, 'admin_record_permissions')) {
-			throw new SoapFault('permission_denied', 'You do not have the permissions to access this function.');
+			throw new ISPConfigRemoteException('permission_denied', 'You do not have the permissions to access this function.');
 			return false;
 		}
 
@@ -62,7 +62,7 @@ public function update_record_permissions($session_id, $tablename, $index_field,
 					// check if userid is valid
 					$check = $app->db->queryOneRecord('SELECT userid FROM sys_user WHERE userid = ?', $app->functions->intval($value));
 					if(!$check || !$check['userid']) {
-						throw new SoapFault('invalid parameters', $value . ' is no valid sys_userid.');
+						throw new ISPConfigRemoteException('invalid parameters', $value . ' is no valid sys_userid.');
 						return false;
 					}
 					$permissions[$key] = $app->functions->intval($value);
@@ -71,7 +71,7 @@ public function update_record_permissions($session_id, $tablename, $index_field,
 					// check if groupid is valid
 					$check = $app->db->queryOneRecord('SELECT groupid FROM sys_group WHERE groupid = ?', $app->functions->intval($value));
 					if(!$check || !$check['groupid']) {
-						throw new SoapFault('invalid parameters', $value . ' is no valid sys_groupid.');
+						throw new ISPConfigRemoteException('invalid parameters', $value . ' is no valid sys_groupid.');
 						return false;
 					}
 					$permissions[$key] = $app->functions->intval($value);
@@ -81,7 +81,7 @@ public function update_record_permissions($session_id, $tablename, $index_field,
 					// check if permissions are valid
 					$value = strtolower($value);
 					if(!preg_match('/^[riud]+$/', $value)) {
-						throw new SoapFault('invalid parameters', $value . ' is no valid permission string.');
+						throw new ISPConfigRemoteException('invalid parameters', $value . ' is no valid permission string.');
 						return false;
 					}
 
@@ -95,7 +95,7 @@ public function update_record_permissions($session_id, $tablename, $index_field,
 
 					break;
 				default:
-					throw new SoapFault('invalid parameters', 'Only sys_userid, sys_groupid, sys_perm_user and sys_perm_group parameters can be changed with this function.');
+					throw new ISPConfigRemoteException('invalid parameters', 'Only sys_userid, sys_groupid, sys_perm_user and sys_perm_group parameters can be changed with this function.');
 					break;
 			}
 		}
@@ -113,7 +113,7 @@ public function update_record_permissions($session_id, $tablename, $index_field,
 	public function system_config_set($session_id, $section, $key, $value) {
 		global $app;
 		if(!$this->checkPerm($session_id, 'system_config_set')) {
-			throw new SoapFault('permission_denied', 'You do not have the permissions to access this function.');
+			throw new ISPConfigRemoteException('permission_denied', 'You do not have the permissions to access this function.');
 			return false;
 		}
 		if ($section != '' && $key != '') {
@@ -123,7 +123,7 @@ public function system_config_set($session_id, $section, $key, $value) {
 			$system_config_str = $app->ini_parser->get_ini_string($system_config_array);
 			return $app->db->datalogUpdate('sys_ini', array("config" => $system_config_str), 'sysini_id', 1);
 		} else {
-			throw new SoapFault('invalid_function_parameter', 'Invalid function parameter.');
+			throw new ISPConfigRemoteException('invalid_function_parameter', 'Invalid function parameter.');
 			return false;
 		}
 	}
@@ -138,7 +138,7 @@ public function system_config_set($session_id, $section, $key, $value) {
 	public function system_config_get($session_id, $section, $key) {
 		global $app;
 		if(!$this->checkPerm($session_id, 'system_config_get')) {
-			throw new SoapFault('permission_denied', 'You do not have the permissions to access this function.');
+			throw new ISPConfigRemoteException('permission_denied', 'You do not have the permissions to access this function.');
 			return false;
 		}
 		if ($section != '') {
@@ -152,7 +152,7 @@ public function system_config_get($session_id, $section, $key) {
 				else return false;
 			}
 		} else {
-			throw new SoapFault('invalid_function_parameter', 'Invalid function parameter.');
+			throw new ISPConfigRemoteException('invalid_function_parameter', 'Invalid function parameter.');
 			return false;
 		}
 	}
@@ -165,13 +165,13 @@ public function config_value_get($session_id, $group, $name)
 		global $app;
 
 		if(!$this->checkPerm($session_id, 'config_value_get')) {
-			throw new SoapFault('permission_denied', 'You do not have the permissions to access this function.');
+			throw new ISPConfigRemoteException('permission_denied', 'You do not have the permissions to access this function.');
 			return false;
 		}
 
 		// validate fields
 		if($group == '' || $name == '') {
-			throw new SoapFault('field_empty_error', 'Group and name parameter may not be empty.');
+			throw new ISPConfigRemoteException('field_empty_error', 'Group and name parameter may not be empty.');
 			return false;
 		}
 
@@ -184,18 +184,18 @@ public function config_value_add($session_id, $group, $name, $value)
 		global $app;
 
 		if(!$this->checkPerm($session_id, 'config_value_add')) {
-			throw new SoapFault('permission_denied', 'You do not have the permissions to access this function.');
+			throw new ISPConfigRemoteException('permission_denied', 'You do not have the permissions to access this function.');
 			return false;
 		}
 
 		// validate fields
 		if($group == '' || $name == '' || $value == '') {
-			throw new SoapFault('field_empty_error', 'Group, name, and value parameter may not be empty.');
+			throw new ISPConfigRemoteException('field_empty_error', 'Group, name, and value parameter may not be empty.');
 			return false;
 		}
 
 		if(is_array($app->db->queryOneRecord('SELECT * FROM sys_config WHERE `group` = ? AND `name` = ?', $group, $name))) {
-			throw new SoapFault('record_unique_error', 'Group plus name field combination is not unique.');
+			throw new ISPConfigRemoteException('record_unique_error', 'Group plus name field combination is not unique.');
 			return false;
 		}
 
@@ -208,18 +208,18 @@ public function config_value_update($session_id, $group, $name, $value)
 		global $app;
 
 		if(!$this->checkPerm($session_id, 'config_value_update')) {
-			throw new SoapFault('permission_denied', 'You do not have the permissions to access this function.');
+			throw new ISPConfigRemoteException('permission_denied', 'You do not have the permissions to access this function.');
 			return false;
 		}
 
 		// validate fields
 		if($group == '' || $name == '' || $value == '') {
-			throw new SoapFault('field_empty_error', 'Group, name, and value parameter may not be empty.');
+			throw new ISPConfigRemoteException('field_empty_error', 'Group, name, and value parameter may not be empty.');
 			return false;
 		}
 
 		if(!is_array($app->db->queryOneRecord('SELECT * FROM sys_config WHERE `group` = ? AND `name` = ?', $group, $name))) {
-			throw new SoapFault('record_nonexist_error', 'There is no record with this group plus name field combination.');
+			throw new ISPConfigRemoteException('record_nonexist_error', 'There is no record with this group plus name field combination.');
 			return false;
 		}
 
@@ -232,13 +232,13 @@ public function config_value_replace($session_id, $group, $name, $value)
 		global $app;
 
 		if(!$this->checkPerm($session_id, 'config_value_replace')) {
-			throw new SoapFault('permission_denied', 'You do not have the permissions to access this function.');
+			throw new ISPConfigRemoteException('permission_denied', 'You do not have the permissions to access this function.');
 			return false;
 		}
 
 		// validate fields
 		if($group == '' || $name == '' || $value == '') {
-			throw new SoapFault('field_empty_error', 'Group, name, and value parameter may not be empty.');
+			throw new ISPConfigRemoteException('field_empty_error', 'Group, name, and value parameter may not be empty.');
 			return false;
 		}
 
@@ -255,18 +255,18 @@ public function config_value_delete($session_id, $group, $name)
 		global $app;
 
 		if(!$this->checkPerm($session_id, 'config_value_delete')) {
-			throw new SoapFault('permission_denied', 'You do not have the permissions to access this function.');
+			throw new ISPConfigRemoteException('permission_denied', 'You do not have the permissions to access this function.');
 			return false;
 		}
 
 		// validate fields
 		if($group == '' || $name == '') {
-			throw new SoapFault('field_empty_error', 'Group and name parameter may not be empty.');
+			throw new ISPConfigRemoteException('field_empty_error', 'Group and name parameter may not be empty.');
 			return false;
 		}
 
 		if(!is_array($app->db->queryOneRecord('SELECT * FROM sys_config WHERE `group` = ? AND `name` = ?', $group, $name))) {
-			throw new SoapFault('record_nonexist_error', 'There is no record with this group plus name field combination.');
+			throw new ISPConfigRemoteException('record_nonexist_error', 'There is no record with this group plus name field combination.');
 			return false;
 		}