From 27d58effdfb86cc64b92832b353baceabeb5aefc Mon Sep 17 00:00:00 2001 From: Alex Tselegidis Date: Tue, 26 Jul 2022 16:38:58 +0300 Subject: [PATCH] Add API settings page --- application/controllers/Api_settings.php | 105 ++++++++++++++++++++ application/views/pages/api_settings.php | 52 ++++++++++ assets/js/http/api_settings_http_client.js | 39 ++++++++ assets/js/pages/api_settings.js | 107 +++++++++++++++++++++ 4 files changed, 303 insertions(+) create mode 100644 application/controllers/Api_settings.php create mode 100644 application/views/pages/api_settings.php create mode 100644 assets/js/http/api_settings_http_client.js create mode 100644 assets/js/pages/api_settings.js diff --git a/application/controllers/Api_settings.php b/application/controllers/Api_settings.php new file mode 100644 index 00000000..63e7d592 --- /dev/null +++ b/application/controllers/Api_settings.php @@ -0,0 +1,105 @@ + + * @copyright Copyright (c) Alex Tselegidis + * @license https://opensource.org/licenses/GPL-3.0 - GPLv3 + * @link https://easyappointments.org + * @since v1.5.0 + * ---------------------------------------------------------------------------- */ + +/** + * API settings controller. + * + * Handles API settings related operations. + * + * @package Controllers + */ +class Api_settings extends EA_Controller { + /** + * Calendar constructor. + */ + public function __construct() + { + parent::__construct(); + + $this->load->model('settings_model'); + + $this->load->library('accounts'); + } + + /** + * Render the settings page. + */ + public function index() + { + session(['dest_url' => site_url('api_settings')]); + + $user_id = session('user_id'); + + if (cannot('view', PRIV_SYSTEM_SETTINGS)) + { + if ($user_id) + { + abort(403, 'Forbidden'); + } + + redirect('login'); + + return; + } + + $role_slug = session('role_slug'); + + script_vars([ + 'user_id' => $user_id, + 'role_slug' => $role_slug, + 'api_settings' => $this->settings_model->get('name like "api_%"'), + ]); + + html_vars([ + 'page_title' => lang('api'), + 'active_menu' => PRIV_SYSTEM_SETTINGS, + 'user_display_name' => $this->accounts->get_user_display_name($user_id), + ]); + + $this->load->view('pages/api_settings'); + } + + /** + * Save general settings. + */ + public function save() + { + try + { + if (cannot('edit', PRIV_SYSTEM_SETTINGS)) + { + throw new RuntimeException('You do not have the required permissions for this task.'); + } + + $settings = request('api_settings', []); + + foreach ($settings as $setting) + { + $existing_setting = $this->settings_model->query()->where('name', $setting['name'])->get()->row_array(); + + if ( ! empty($existing_setting)) + { + $setting['id'] = $existing_setting['id']; + } + + $this->settings_model->save($setting); + } + + response(); + } + catch (Throwable $e) + { + json_exception($e); + } + } +} diff --git a/application/views/pages/api_settings.php b/application/views/pages/api_settings.php new file mode 100644 index 00000000..952965df --- /dev/null +++ b/application/views/pages/api_settings.php @@ -0,0 +1,52 @@ + + + + +
+
+
+
+
+
+ + + + + + + + +
+
+
+ + +
+ + + +
+
+
+
+
+
+
+
+
+
+ + + + + + + + + + diff --git a/assets/js/http/api_settings_http_client.js b/assets/js/http/api_settings_http_client.js new file mode 100644 index 00000000..e3f93a1a --- /dev/null +++ b/assets/js/http/api_settings_http_client.js @@ -0,0 +1,39 @@ +/* ---------------------------------------------------------------------------- + * Easy!Appointments - Online Appointment Scheduler + * + * @package EasyAppointments + * @author A.Tselegidis + * @copyright Copyright (c) Alex Tselegidis + * @license https://opensource.org/licenses/GPL-3.0 - GPLv3 + * @link https://easyappointments.org + * @since v1.5.0 + * ---------------------------------------------------------------------------- */ + +/** + * API Settings HTTP client. + * + * This module implements the API settings related HTTP requests. + */ +App.Http.ApiSettings = (function () { + /** + * Save API settings. + * + * @param {Object} apiSettings + * + * @return {Object} + */ + function save(apiSettings) { + const url = App.Utils.Url.siteUrl('api_settings/save'); + + const data = { + csrf_token: vars('csrf_token'), + api_settings: apiSettings + }; + + return $.post(url, data); + } + + return { + save + }; +})(); diff --git a/assets/js/pages/api_settings.js b/assets/js/pages/api_settings.js new file mode 100644 index 00000000..ad7bfe83 --- /dev/null +++ b/assets/js/pages/api_settings.js @@ -0,0 +1,107 @@ +/* ---------------------------------------------------------------------------- + * Easy!Appointments - Online Appointment Scheduler + * + * @package EasyAppointments + * @author A.Tselegidis + * @copyright Copyright (c) Alex Tselegidis + * @license https://opensource.org/licenses/GPL-3.0 - GPLv3 + * @link https://easyappointments.org + * @since v1.5.0 + * ---------------------------------------------------------------------------- */ + +/** + * API settings page. + * + * This module implements the functionality of the API settings page. + */ +App.Pages.ApiSettings = (function () { + const $saveSettings = $('#save-settings'); + + /** + * Check if the form has invalid values. + * + * @return {Boolean} + */ + function isInvalid() { + try { + $('#api-settings .is-invalid').removeClass('is-invalid'); + + // Validate required fields. + + let missingRequiredFields = false; + + $('#api-settings .required').each((index, requiredField) => { + const $requiredField = $(requiredField); + + if (!$requiredField.val()) { + $requiredField.addClass('is-invalid'); + missingRequiredFields = true; + } + }); + + if (missingRequiredFields) { + throw new Error(lang('fields_are_required')); + } + + return false; + } catch (error) { + App.Layouts.Backend.displayNotification(error.message); + return true; + } + } + + function deserialize(apiSettings) { + apiSettings.forEach((apiSetting) => { + $('[data-field="' + apiSetting.name + '"]').val(apiSetting.value); + }); + } + + function serialize() { + const apiSettings = []; + + $('[data-field]').each((index, field) => { + const $field = $(field); + + apiSettings.push({ + name: $field.data('field'), + value: $field.val() + }); + }); + + return apiSettings; + } + + /** + * Save the account information. + */ + function onSaveSettingsClick() { + if (isInvalid()) { + App.Layouts.Backend.displayNotification(lang('settings_are_invalid')); + + return; + } + + const apiSettings = serialize(); + + App.Http.ApiSettings.save(apiSettings).done(() => { + App.Layouts.Backend.displayNotification(lang('settings_saved')); + }); + } + + /** + * Initialize the module. + */ + function initialize() { + $saveSettings.on('click', onSaveSettingsClick); + + const apiSettings = vars('api_settings'); + + deserialize(apiSettings); + + App.Layouts.Backend.placeFooterToBottom(); + } + + document.addEventListener('DOMContentLoaded', initialize); + + return {}; +})();