From c985f80452f62b485af56556acf9bc953364b767 Mon Sep 17 00:00:00 2001 From: Mike Koch Date: Thu, 9 Nov 2017 13:04:10 -0500 Subject: [PATCH 01/21] Working on moving service messages to an API endpoint --- admin/service_messages.php | 14 ------ .../ServiceMessages/ServiceMessage.php | 33 ++++++++++++++ .../ServiceMessages/ServiceMessageHandler.php | 22 ++++++++++ .../ServiceMessages/ServiceMessageStyle.php | 44 +++++++++++++++++++ .../ServiceMessagesController.php | 38 ++++++++++++++++ .../ServiceMessagesGateway.php | 43 ++++++++++++++++++ 6 files changed, 180 insertions(+), 14 deletions(-) create mode 100644 api/BusinessLogic/ServiceMessages/ServiceMessage.php create mode 100644 api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php create mode 100644 api/BusinessLogic/ServiceMessages/ServiceMessageStyle.php create mode 100644 api/Controllers/ServiceMessages/ServiceMessagesController.php create mode 100644 api/DataAccess/ServiceMessages/ServiceMessagesGateway.php diff --git a/admin/service_messages.php b/admin/service_messages.php index 580d0012..9ba0b9a9 100644 --- a/admin/service_messages.php +++ b/admin/service_messages.php @@ -687,21 +687,7 @@ function new_sm() exit; } - // Get the latest service message order - $res = hesk_dbQuery("SELECT `order` FROM `" . hesk_dbEscape($hesk_settings['db_pfix']) . "service_messages` ORDER BY `order` DESC LIMIT 1"); - $row = hesk_dbFetchRow($res); - $my_order = intval($row[0]) + 10; - // Insert service message into database - hesk_dbQuery("INSERT INTO `" . hesk_dbEscape($hesk_settings['db_pfix']) . "service_messages` (`author`,`title`,`message`,`style`,`type`,`order`, `icon`) VALUES ( - '" . intval($_SESSION['id']) . "', - '" . hesk_dbEscape($title) . "', - '" . hesk_dbEscape($message) . "', - '{$style}', - '{$type}', - '{$my_order}', - '{$icon}' - )"); $_SESSION['smord'] = hesk_dbInsertID(); hesk_process_messages($hesklang['sm_added'], 'service_messages.php', 'SUCCESS'); diff --git a/api/BusinessLogic/ServiceMessages/ServiceMessage.php b/api/BusinessLogic/ServiceMessages/ServiceMessage.php new file mode 100644 index 00000000..1951b672 --- /dev/null +++ b/api/BusinessLogic/ServiceMessages/ServiceMessage.php @@ -0,0 +1,33 @@ +serviceMessageGateway = $serviceMessagesGateway; + } + + function createServiceMessage($serviceMessage, $heskSettings) { + // TODO Validate + + return $this->serviceMessageGateway->createServiceMessage($serviceMessage, $heskSettings); + } +} \ No newline at end of file diff --git a/api/BusinessLogic/ServiceMessages/ServiceMessageStyle.php b/api/BusinessLogic/ServiceMessages/ServiceMessageStyle.php new file mode 100644 index 00000000..4dc3e388 --- /dev/null +++ b/api/BusinessLogic/ServiceMessages/ServiceMessageStyle.php @@ -0,0 +1,44 @@ + self::NONE, + 1 => self::SUCCESS, + 2 => self::INFO, + 3 => self::NOTICE, + 4 => self::ERROR + ); + + if (!isset($styles[$id])) { + throw new \Exception("Style {$id} is not a valid service message style."); + } + + return $styles[$id]; + } + + static function getIdForStyle($style) { + $styles = array( + self::NONE => 0, + self::SUCCESS => 1, + self::INFO => 2, + self::NOTICE => 3, + self::ERROR => 4 + ); + + if (!isset($styles[$style])) { + throw new \Exception("Style {$style} is not a valid service message style."); + } + + return $styles[$style]; + } +} \ No newline at end of file diff --git a/api/Controllers/ServiceMessages/ServiceMessagesController.php b/api/Controllers/ServiceMessages/ServiceMessagesController.php new file mode 100644 index 00000000..2e9e83c8 --- /dev/null +++ b/api/Controllers/ServiceMessages/ServiceMessagesController.php @@ -0,0 +1,38 @@ +get(ServiceMessageHandler::clazz()); + + $data = JsonRetriever::getJsonData(); + $element = $handler->createServiceMessage($this->buildElementModel($data, $userContext), $hesk_settings); + + return output($element, 201); + } + + /** + * @param $data array + * @param $userContext UserContext + * @return ServiceMessage + */ + private function buildElementModel($data, $userContext) { + $serviceMessage = new ServiceMessage(); + $serviceMessage->createdBy = $userContext->id; + $serviceMessage->icon = $data['icon']; + $serviceMessage->message = $data['message']; + $serviceMessage->published = $data['published']; + $serviceMessage->style = $data['style']; + + return $serviceMessage; + } +} \ No newline at end of file diff --git a/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php b/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php new file mode 100644 index 00000000..9e6adc39 --- /dev/null +++ b/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php @@ -0,0 +1,43 @@ +init(); + + // Get the latest service message order + $res = hesk_dbQuery("SELECT `order` FROM `" . hesk_dbEscape($heskSettings['db_pfix']) . "service_messages` ORDER BY `order` DESC LIMIT 1"); + $row = hesk_dbFetchRow($res); + $myOrder = intval($row[0]) + 10; + + $style = ServiceMessageStyle::getIdForStyle($serviceMessage->style); + $type = $serviceMessage->published ? 0 : 1; + + // Insert service message into database + hesk_dbQuery("INSERT INTO `" . hesk_dbEscape($heskSettings['db_pfix']) . "service_messages` (`author`,`title`,`message`,`style`,`type`,`order`, `icon`) VALUES ( + '" . intval($serviceMessage->createdBy) . "', + '" . hesk_dbEscape($serviceMessage->title) . "', + '" . hesk_dbEscape($serviceMessage->message) . "', + '" . hesk_dbEscape($style) . "', + '{$type}', + '{$myOrder}', + '" . hesk_dbEscape($serviceMessage->icon) . "' + )"); + + $serviceMessage->id = hesk_dbInsertID(); + + $this->close(); + + return $serviceMessage; + } +} \ No newline at end of file From d305ccf9b3a162210ac68ab09a7108acf334ad87 Mon Sep 17 00:00:00 2001 From: Mike Koch Date: Thu, 9 Nov 2017 22:02:26 -0500 Subject: [PATCH 02/21] Add POST endpoint for creating service messages --- .../ServiceMessages/ServiceMessageHandler.php | 37 ++++++++++++++++++- api/index.php | 2 + 2 files changed, 38 insertions(+), 1 deletion(-) diff --git a/api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php b/api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php index 474beb51..a1563807 100644 --- a/api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php +++ b/api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php @@ -4,6 +4,8 @@ namespace BusinessLogic\ServiceMessages; // TODO Test +use BusinessLogic\Exceptions\ValidationException; +use BusinessLogic\ValidationModel; use DataAccess\ServiceMessages\ServiceMessagesGateway; class ServiceMessageHandler extends \BaseClass { @@ -15,8 +17,41 @@ class ServiceMessageHandler extends \BaseClass { } function createServiceMessage($serviceMessage, $heskSettings) { - // TODO Validate + $this->validate($serviceMessage); return $this->serviceMessageGateway->createServiceMessage($serviceMessage, $heskSettings); } + + /** + * @param $serviceMessage ServiceMessage + * @throws ValidationException + */ + private function validate($serviceMessage) { + $validationModel = new ValidationModel(); + if ($serviceMessage->createdBy < 1) { + $validationModel->errorKeys[] = 'MISSING_CREATOR'; + } + if ($serviceMessage->icon === null || trim($serviceMessage->icon) === '') { + $validationModel->errorKeys[] = 'MISSING_ICON'; + } + if ($serviceMessage->message === null || trim($serviceMessage->message) === '') { + $validationModel->errorKeys[] = 'MISSING_MESSAGE'; + } + if ($serviceMessage->title === null || trim($serviceMessage->title) === '') { + $validationModel->errorKeys[] = 'MISSING_TITLE'; + } + if ($serviceMessage->style === null || trim($serviceMessage->style) === '') { + $validationModel->errorKeys[] = 'MISSING_STYLE'; + } + try { + ServiceMessageStyle::getIdForStyle($serviceMessage->style); + } catch (\Exception $e) { + $validationModel->errorKeys[] = 'INVALID_STYLE'; + } + + if (count($validationModel->errorKeys) > 0) { + // Validation failed + throw new ValidationException($validationModel); + } + } } \ No newline at end of file diff --git a/api/index.php b/api/index.php index 4766701c..6700fa56 100644 --- a/api/index.php +++ b/api/index.php @@ -202,6 +202,8 @@ Link::all(array( '/v1/statuses' => action(\Controllers\Statuses\StatusController::clazz(), RequestMethod::all()), // Settings '/v1/settings' => action(\Controllers\Settings\SettingsController::clazz(), RequestMethod::all()), + // Service Messages + '/v1/service-messages' => action(\Controllers\ServiceMessages\ServiceMessagesController::clazz(), array(RequestMethod::POST)), /* Internal use only routes */ // Resend email response From 311a48487d1081a5b20eb7c14bddca043882dbfa Mon Sep 17 00:00:00 2001 From: Mike Koch Date: Sat, 11 Nov 2017 16:33:43 -0500 Subject: [PATCH 03/21] Add POST service-messages endpoint --- .../ServiceMessages/ServiceMessageHandler.php | 23 ++++++++++++++++--- .../ServiceMessagesController.php | 1 + .../ServiceMessagesGateway.php | 8 +++++++ inc/common.inc.php | 3 ++- 4 files changed, 31 insertions(+), 4 deletions(-) diff --git a/api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php b/api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php index a1563807..88bcd978 100644 --- a/api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php +++ b/api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php @@ -19,6 +19,26 @@ class ServiceMessageHandler extends \BaseClass { function createServiceMessage($serviceMessage, $heskSettings) { $this->validate($serviceMessage); + if ($serviceMessage->icon === null) { + switch ($serviceMessage->style) { + case ServiceMessageStyle::NONE: + $serviceMessage->icon = ''; + break; + case ServiceMessageStyle::INFO: + $serviceMessage->icon = 'fa fa-comment'; + break; + case ServiceMessageStyle::NOTICE: + $serviceMessage->icon = 'fa fa-exclamation-triangle'; + break; + case ServiceMessageStyle::ERROR: + $serviceMessage->icon = 'fa fa-times-circle'; + break; + case ServiceMessageStyle::SUCCESS: + $serviceMessage->icon = 'fa fa-check-circle'; + break; + } + } + return $this->serviceMessageGateway->createServiceMessage($serviceMessage, $heskSettings); } @@ -31,9 +51,6 @@ class ServiceMessageHandler extends \BaseClass { if ($serviceMessage->createdBy < 1) { $validationModel->errorKeys[] = 'MISSING_CREATOR'; } - if ($serviceMessage->icon === null || trim($serviceMessage->icon) === '') { - $validationModel->errorKeys[] = 'MISSING_ICON'; - } if ($serviceMessage->message === null || trim($serviceMessage->message) === '') { $validationModel->errorKeys[] = 'MISSING_MESSAGE'; } diff --git a/api/Controllers/ServiceMessages/ServiceMessagesController.php b/api/Controllers/ServiceMessages/ServiceMessagesController.php index 2e9e83c8..d6960764 100644 --- a/api/Controllers/ServiceMessages/ServiceMessagesController.php +++ b/api/Controllers/ServiceMessages/ServiceMessagesController.php @@ -28,6 +28,7 @@ class ServiceMessagesController extends \BaseClass { private function buildElementModel($data, $userContext) { $serviceMessage = new ServiceMessage(); $serviceMessage->createdBy = $userContext->id; + $serviceMessage->title = $data['title']; $serviceMessage->icon = $data['icon']; $serviceMessage->message = $data['message']; $serviceMessage->published = $data['published']; diff --git a/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php b/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php index 9e6adc39..82d9e6b8 100644 --- a/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php +++ b/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php @@ -3,6 +3,7 @@ namespace DataAccess\ServiceMessages; +use BusinessLogic\DateTimeHelpers; use BusinessLogic\ServiceMessages\ServiceMessage; use BusinessLogic\ServiceMessages\ServiceMessageStyle; use DataAccess\CommonDao; @@ -36,6 +37,13 @@ class ServiceMessagesGateway extends CommonDao { $serviceMessage->id = hesk_dbInsertID(); + // Get the autogenerated fields + $rs = hesk_dbQuery("SELECT `dt`, `order` FROM `" . hesk_dbEscape($heskSettings['db_pfix']) . "service_messages` + WHERE `id` = " . intval($serviceMessage->id)); + $row = hesk_dbFetchAssoc($rs); + $serviceMessage->dateCreated = $row['dt']; + $serviceMessage->order = $row['order']; + $this->close(); return $serviceMessage; diff --git a/inc/common.inc.php b/inc/common.inc.php index be8f07eb..802e44da 100644 --- a/inc/common.inc.php +++ b/inc/common.inc.php @@ -185,7 +185,8 @@ function hesk_service_message($sm) ?>
'; ?> - +
+

Date: Sat, 11 Nov 2017 22:16:25 -0500 Subject: [PATCH 04/21] Add more endpoints for service messages --- .../ServiceMessages/ServiceMessageHandler.php | 35 +++++++++++- .../ServiceMessagesController.php | 34 +++++++++++- .../ServiceMessagesGateway.php | 54 ++++++++++++++++++- api/index.php | 2 +- 4 files changed, 119 insertions(+), 6 deletions(-) diff --git a/api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php b/api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php index 88bcd978..d70f142f 100644 --- a/api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php +++ b/api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php @@ -42,13 +42,44 @@ class ServiceMessageHandler extends \BaseClass { return $this->serviceMessageGateway->createServiceMessage($serviceMessage, $heskSettings); } + function getServiceMessages($heskSettings) { + return $this->serviceMessageGateway->getServiceMessages($heskSettings); + } + + function editServiceMessage($serviceMessage, $heskSettings) { + $this->validate($serviceMessage, false); + + if ($serviceMessage->icon === null) { + switch ($serviceMessage->style) { + case ServiceMessageStyle::NONE: + $serviceMessage->icon = ''; + break; + case ServiceMessageStyle::INFO: + $serviceMessage->icon = 'fa fa-comment'; + break; + case ServiceMessageStyle::NOTICE: + $serviceMessage->icon = 'fa fa-exclamation-triangle'; + break; + case ServiceMessageStyle::ERROR: + $serviceMessage->icon = 'fa fa-times-circle'; + break; + case ServiceMessageStyle::SUCCESS: + $serviceMessage->icon = 'fa fa-check-circle'; + break; + } + } + + return $this->serviceMessageGateway->updateServiceMessage($serviceMessage, $heskSettings); + } + /** * @param $serviceMessage ServiceMessage + * @param bool $isNew * @throws ValidationException */ - private function validate($serviceMessage) { + private function validate($serviceMessage, $isNew = true) { $validationModel = new ValidationModel(); - if ($serviceMessage->createdBy < 1) { + if ($isNew && $serviceMessage->createdBy < 1) { $validationModel->errorKeys[] = 'MISSING_CREATOR'; } if ($serviceMessage->message === null || trim($serviceMessage->message) === '') { diff --git a/api/Controllers/ServiceMessages/ServiceMessagesController.php b/api/Controllers/ServiceMessages/ServiceMessagesController.php index d6960764..f17d6e14 100644 --- a/api/Controllers/ServiceMessages/ServiceMessagesController.php +++ b/api/Controllers/ServiceMessages/ServiceMessagesController.php @@ -8,6 +8,15 @@ use BusinessLogic\ServiceMessages\ServiceMessageHandler; use Controllers\JsonRetriever; class ServiceMessagesController extends \BaseClass { + function get() { + global $applicationContext, $hesk_settings; + + /* @var $handler ServiceMessageHandler */ + $handler = $applicationContext->get(ServiceMessageHandler::clazz()); + + return output($handler->getServiceMessages($hesk_settings)); + } + function post() { global $applicationContext, $userContext, $hesk_settings; @@ -20,14 +29,35 @@ class ServiceMessagesController extends \BaseClass { return output($element, 201); } + function put() { + global $applicationContext, $hesk_settings; + + /* @var $handler ServiceMessageHandler */ + $handler = $applicationContext->get(ServiceMessageHandler::clazz()); + + $data = JsonRetriever::getJsonData(); + $element = $handler->editServiceMessage($this->buildElementModel($data, null, false), $hesk_settings); + + return output($element); + } + /** * @param $data array * @param $userContext UserContext * @return ServiceMessage */ - private function buildElementModel($data, $userContext) { + private function buildElementModel($data, $userContext, $creating = true) { $serviceMessage = new ServiceMessage(); - $serviceMessage->createdBy = $userContext->id; + + if (!$creating) { + $serviceMessage->id = $data['id']; + $serviceMessage->order = $data['order']; + } + + if ($creating) { + $serviceMessage->createdBy = $userContext->id; + } + $serviceMessage->title = $data['title']; $serviceMessage->icon = $data['icon']; $serviceMessage->message = $data['message']; diff --git a/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php b/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php index 82d9e6b8..9dfb1796 100644 --- a/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php +++ b/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php @@ -42,7 +42,59 @@ class ServiceMessagesGateway extends CommonDao { WHERE `id` = " . intval($serviceMessage->id)); $row = hesk_dbFetchAssoc($rs); $serviceMessage->dateCreated = $row['dt']; - $serviceMessage->order = $row['order']; + $serviceMessage->order = intval($row['order']); + + $this->close(); + + return $serviceMessage; + } + + function getServiceMessages($heskSettings) { + $this->init(); + + $serviceMessages = array(); + + $rs = hesk_dbQuery("SELECT * FROM `". hesk_dbEscape($heskSettings['db_pfix']) . "service_messages` ORDER BY `id`"); + while ($row = hesk_dbFetchAssoc($rs)) { + $serviceMessage = new ServiceMessage(); + $serviceMessage->id = $row['id']; + $serviceMessage->published = intval($row['type']) !== 1; + $serviceMessage->createdBy = intval($row['author']); + $serviceMessage->order = intval($row['order']); + $serviceMessage->dateCreated = $row['dt']; + $serviceMessage->title = $row['title']; + $serviceMessage->message = $row['message']; + $serviceMessage->style = ServiceMessageStyle::getStyleById($row['style']); + $serviceMessage->icon = $row['icon']; + $serviceMessages[] = $serviceMessage; + } + + $this->close(); + + return $serviceMessages; + } + + function updateServiceMessage($serviceMessage, $heskSettings) { + $this->init(); + + $style = ServiceMessageStyle::getIdForStyle($serviceMessage->style); + $type = $serviceMessage->published ? 0 : 1; + + hesk_dbQuery("UPDATE `" . hesk_dbEscape($heskSettings['db_pfix']) . "service_messages` + SET `title` = '" . hesk_dbEscape($serviceMessage->title) . "', + `message` = '" . hesk_dbEscape($serviceMessage->message) . "', + `style` = '" . intval($style) . "', + `type` = " . intval($type) . ", + `icon` = '" . hesk_dbEscape($serviceMessage->icon) . "' + WHERE `id` = " . intval($serviceMessage->id)); + + $otherFieldsRs = hesk_dbQuery("SELECT `dt`, `author`, `order` FROM `" . hesk_dbEscape($heskSettings['db_pfix']) . "service_messages` + WHERE `id` = " . intval($serviceMessage->id)); + $otherFields = hesk_dbFetchAssoc($otherFieldsRs); + + $serviceMessage->order = intval($otherFields['order']); + $serviceMessage->createdBy = intval($otherFields['author']); + $serviceMessage->dateCreated = $otherFields['dt']; $this->close(); diff --git a/api/index.php b/api/index.php index 6700fa56..afa70f70 100644 --- a/api/index.php +++ b/api/index.php @@ -203,7 +203,7 @@ Link::all(array( // Settings '/v1/settings' => action(\Controllers\Settings\SettingsController::clazz(), RequestMethod::all()), // Service Messages - '/v1/service-messages' => action(\Controllers\ServiceMessages\ServiceMessagesController::clazz(), array(RequestMethod::POST)), + '/v1/service-messages' => action(\Controllers\ServiceMessages\ServiceMessagesController::clazz(), array(RequestMethod::GET, RequestMethod::POST, RequestMethod::PUT)), /* Internal use only routes */ // Resend email response From c00d5641e426b37145135bbe60e5121018917297 Mon Sep 17 00:00:00 2001 From: Mike Koch Date: Sun, 12 Nov 2017 22:22:28 -0500 Subject: [PATCH 05/21] Service messages page can now retrieve service messages via AJAX --- admin/service_messages.php | 872 +++++------------- .../ServiceMessages/ServiceMessageHandler.php | 40 +- .../ServiceMessagesController.php | 12 + .../ServiceMessagesGateway.php | 32 +- api/autoload.php | 1 + api/index.php | 10 +- internal-api/js/service-messages.js | 362 ++++++++ 7 files changed, 707 insertions(+), 622 deletions(-) create mode 100644 internal-api/js/service-messages.js diff --git a/admin/service_messages.php b/admin/service_messages.php index 9ba0b9a9..b83d9378 100644 --- a/admin/service_messages.php +++ b/admin/service_messages.php @@ -15,6 +15,7 @@ define('IN_SCRIPT', 1); define('HESK_PATH', '../'); define('PAGE_TITLE', 'ADMIN_SERVICE_MESSAGES'); define('MFH_PAGE_LAYOUT', 'TOP_ONLY'); +define('EXTRA_JS', ''); /* Get all the required files and functions */ require(HESK_PATH . 'hesk_settings.inc.php'); @@ -31,26 +32,8 @@ hesk_isLoggedIn(); hesk_checkPermission('can_service_msg'); // Define required constants -define('LOAD_TABS', 1); define('WYSIWYG', 1); -// What should we do? -if ($action = hesk_REQUEST('a')) { - if ($action == 'edit_sm') { - edit_sm(); - } elseif (defined('HESK_DEMO')) { - hesk_process_messages($hesklang['ddemo'], 'service_messages.php', 'NOTICE'); - } elseif ($action == 'new_sm') { - new_sm(); - } elseif ($action == 'save_sm') { - save_sm(); - } elseif ($action == 'order_sm') { - order_sm(); - } elseif ($action == 'remove_sm') { - remove_sm(); - } -} - /* Print header */ require_once(HESK_PATH . 'inc/headerAdmin.inc.php'); @@ -60,638 +43,293 @@ require_once(HESK_PATH . 'inc/show_admin_nav.inc.php');
+
+

+ +

+
+ +
+
-
+var users = [];'; +$usersRs = hesk_dbQuery("SELECT `id`, `name` FROM `" . hesk_dbEscape($hesk_settings['db_pfix']) . "users` WHERE `active` = '1'"); +$users = array(); +while ($row = hesk_dbFetchAssoc($usersRs)) { + $users[] = $row; + echo "users[" . $row['id'] . "] = { + id: ".$row['id'].", + name: '".$row['name']."' + }\n"; +} +echo ''; +?> + + + 4 || $style < 0) { - $style = 0; - } - - $type = empty($_POST['type']) ? 0 : 1; - $icon = hesk_POST('icon'); - $title = hesk_input(hesk_POST('title')) or $hesk_error_buffer[] = $hesklang['sm_e_title']; - $message = hesk_getHTML(hesk_POST('message')); - - // Clean the HTML code - require(HESK_PATH . 'inc/htmlpurifier/HeskHTMLPurifier.php'); - $purifier = new HeskHTMLPurifier($hesk_settings['cache_dir']); - $message = $purifier->heskPurify($message); - - // Any errors? - if (count($hesk_error_buffer)) { - $_SESSION['edit_sm'] = true; - - $_SESSION['new_sm'] = array( - 'id' => $id, - 'style' => $style, - 'type' => $type, - 'title' => $title, - 'icon' => $icon, - 'message' => hesk_input(hesk_POST('message')), - ); - - $tmp = ''; - foreach ($hesk_error_buffer as $error) { - $tmp .= "
  • $error
  • \n"; - } - $hesk_error_buffer = $tmp; - - $hesk_error_buffer = $hesklang['rfm'] . '

      ' . $hesk_error_buffer . '
    '; - hesk_process_messages($hesk_error_buffer, 'service_messages.php'); - } - - // Just preview the message? - if (isset($_POST['sm_preview'])) { - $_SESSION['preview_sm'] = true; - $_SESSION['edit_sm'] = true; - - $_SESSION['new_sm'] = array( - 'id' => $id, - 'style' => $style, - 'type' => $type, - 'title' => $title, - 'message' => $message, - 'icon' => $icon, - ); - - header('Location: service_messages.php'); - exit; - } - - // Update the service message in the database - hesk_dbQuery("UPDATE `" . hesk_dbEscape($hesk_settings['db_pfix']) . "service_messages` SET - `author` = '" . intval($_SESSION['id']) . "', - `title` = '" . hesk_dbEscape($title) . "', - `message` = '" . hesk_dbEscape($message) . "', - `style` = '{$style}', - `type` = '{$type}', - `icon` = '{$icon}' - WHERE `id`={$id}"); - - $_SESSION['smord'] = $id; - hesk_process_messages($hesklang['sm_mdf'], 'service_messages.php', 'SUCCESS'); - -} // End save_sm() - - -function edit_sm() -{ - global $hesk_settings, $hesklang; - - // Get service messageID - $id = intval(hesk_GET('id')) or hesk_error($hesklang['sm_e_id']); - - // Get details from the database - $res = hesk_dbQuery("SELECT * FROM `" . hesk_dbEscape($hesk_settings['db_pfix']) . "service_messages` WHERE `id`={$id} LIMIT 1"); - if (hesk_dbNumRows($res) != 1) { - hesk_error($hesklang['sm_not_found']); - } - $sm = hesk_dbFetchAssoc($res); - - $_SESSION['new_sm'] = $sm; - $_SESSION['edit_sm'] = true; - -} // End edit_sm() - - -function order_sm() -{ - global $hesk_settings, $hesklang; - - // A security check - hesk_token_check(); - - // Get ID and move parameters - $id = intval(hesk_GET('id')) or hesk_error($hesklang['sm_e_id']); - $move = intval(hesk_GET('move')); - $_SESSION['smord'] = $id; - - // Update article details - hesk_dbQuery("UPDATE `" . hesk_dbEscape($hesk_settings['db_pfix']) . "service_messages` SET `order`=`order`+" . intval($move) . " WHERE `id`={$id}"); - - // Update order of all service messages - update_sm_order(); - - // Finish - header('Location: service_messages.php'); - exit(); - -} // End order_sm() - - -function update_sm_order() -{ - global $hesk_settings, $hesklang; - - // Get list of current service messages - $res = hesk_dbQuery("SELECT `id` FROM `" . hesk_dbEscape($hesk_settings['db_pfix']) . "service_messages` ORDER BY `order` ASC"); - - // Update database - $i = 10; - while ($sm = hesk_dbFetchAssoc($res)) { - hesk_dbQuery("UPDATE `" . hesk_dbEscape($hesk_settings['db_pfix']) . "service_messages` SET `order`=" . intval($i) . " WHERE `id`='" . intval($sm['id']) . "'"); - $i += 10; - } - - return true; - -} // END update_sm_order() - - -function remove_sm() -{ - global $hesk_settings, $hesklang; - - // A security check - hesk_token_check(); - - // Get ID - $id = intval(hesk_GET('id')) or hesk_error($hesklang['sm_e_id']); - - // Delete the service message - hesk_dbQuery("DELETE FROM `" . hesk_dbEscape($hesk_settings['db_pfix']) . "service_messages` WHERE `id`={$id}"); - - // Were we successful? - if (hesk_dbAffectedRows() == 1) { - hesk_process_messages($hesklang['sm_deleted'], './service_messages.php', 'SUCCESS'); - } else { - hesk_process_messages($hesklang['sm_not_found'], './service_messages.php'); - } - -} // End remove_sm() - - -function new_sm() -{ - global $hesk_settings, $hesklang, $listBox; - global $hesk_error_buffer; - - // A security check - # hesk_token_check('POST'); - - $hesk_error_buffer = array(); - - $style = intval(hesk_POST('style', 0)); - if ($style > 4 || $style < 0) { - $style = 0; - } - - $type = empty($_POST['type']) ? 0 : 1; - $icon = hesk_POST('icon'); - $title = hesk_input(hesk_POST('title')) or $hesk_error_buffer[] = $hesklang['sm_e_title']; - $message = hesk_getHTML(hesk_POST('message')); - - // Clean the HTML code - require(HESK_PATH . 'inc/htmlpurifier/HeskHTMLPurifier.php'); - $purifier = new HeskHTMLPurifier($hesk_settings['cache_dir']); - $message = $purifier->heskPurify($message); - - // Any errors? - if (count($hesk_error_buffer)) { - $_SESSION['new_sm'] = array( - 'style' => $style, - 'type' => $type, - 'title' => $title, - 'icon' => $icon, - 'message' => hesk_input(hesk_POST('message')), - ); - - $tmp = ''; - foreach ($hesk_error_buffer as $error) { - $tmp .= "
  • $error
  • \n"; - } - $hesk_error_buffer = $tmp; - - $hesk_error_buffer = $hesklang['rfm'] . '

      ' . $hesk_error_buffer . '
    '; - hesk_process_messages($hesk_error_buffer, 'service_messages.php'); - } - - // Just preview the message? - if (isset($_POST['sm_preview'])) { - $_SESSION['preview_sm'] = true; - - $_SESSION['new_sm'] = array( - 'style' => $style, - 'type' => $type, - 'title' => $title, - 'icon' => $icon, - 'message' => $message, - ); - - header('Location: service_messages.php'); - exit; - } - - - - $_SESSION['smord'] = hesk_dbInsertID(); - hesk_process_messages($hesklang['sm_added'], 'service_messages.php', 'SUCCESS'); - -} // End new_sm() - ?> diff --git a/api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php b/api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php index d70f142f..9e70ceda 100644 --- a/api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php +++ b/api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php @@ -5,6 +5,7 @@ namespace BusinessLogic\ServiceMessages; // TODO Test use BusinessLogic\Exceptions\ValidationException; +use BusinessLogic\Navigation\Direction; use BusinessLogic\ValidationModel; use DataAccess\ServiceMessages\ServiceMessagesGateway; @@ -17,7 +18,7 @@ class ServiceMessageHandler extends \BaseClass { } function createServiceMessage($serviceMessage, $heskSettings) { - $this->validate($serviceMessage); + $this->validate($serviceMessage, $heskSettings); if ($serviceMessage->icon === null) { switch ($serviceMessage->style) { @@ -47,7 +48,7 @@ class ServiceMessageHandler extends \BaseClass { } function editServiceMessage($serviceMessage, $heskSettings) { - $this->validate($serviceMessage, false); + $this->validate($serviceMessage, $heskSettings, false); if ($serviceMessage->icon === null) { switch ($serviceMessage->style) { @@ -72,19 +73,52 @@ class ServiceMessageHandler extends \BaseClass { return $this->serviceMessageGateway->updateServiceMessage($serviceMessage, $heskSettings); } + function deleteServiceMessage($id, $heskSettings) { + $this->serviceMessageGateway->deleteServiceMessage($id, $heskSettings); + } + + function sortServiceMessage($id, $direction, $heskSettings) { + $serviceMessages = $this->serviceMessageGateway->getServiceMessages($heskSettings); + $serviceMessage = null; + foreach ($serviceMessages as $innerServiceMessage) { + if ($innerServiceMessage->id === intval($id)) { + $serviceMessage = $innerServiceMessage; + break; + } + } + + if ($serviceMessage === null) { + throw new \BaseException("Could not find category with ID {$id}!"); + } + + if ($direction === Direction::UP) { + $serviceMessage->order -= 15; + } else { + $serviceMessage->order += 15; + } + + $this->serviceMessageGateway->updateServiceMessage($serviceMessage, $heskSettings); + $this->serviceMessageGateway->resortAllServiceMessages($heskSettings); + } + /** * @param $serviceMessage ServiceMessage * @param bool $isNew * @throws ValidationException */ - private function validate($serviceMessage, $isNew = true) { + private function validate($serviceMessage, $heskSettings, $isNew = true) { $validationModel = new ValidationModel(); if ($isNew && $serviceMessage->createdBy < 1) { $validationModel->errorKeys[] = 'MISSING_CREATOR'; } + if ($serviceMessage->message === null || trim($serviceMessage->message) === '') { $validationModel->errorKeys[] = 'MISSING_MESSAGE'; + } else { + $htmlPurifier = new \HeskHTMLPurifier($heskSettings['cache_dir']); + $serviceMessage->message = $htmlPurifier->heskPurify($serviceMessage->message); } + if ($serviceMessage->title === null || trim($serviceMessage->title) === '') { $validationModel->errorKeys[] = 'MISSING_TITLE'; } diff --git a/api/Controllers/ServiceMessages/ServiceMessagesController.php b/api/Controllers/ServiceMessages/ServiceMessagesController.php index f17d6e14..94ff9776 100644 --- a/api/Controllers/ServiceMessages/ServiceMessagesController.php +++ b/api/Controllers/ServiceMessages/ServiceMessagesController.php @@ -6,6 +6,7 @@ use BusinessLogic\Security\UserContext; use BusinessLogic\ServiceMessages\ServiceMessage; use BusinessLogic\ServiceMessages\ServiceMessageHandler; use Controllers\JsonRetriever; +use Symfony\Component\EventDispatcher\Tests\Service; class ServiceMessagesController extends \BaseClass { function get() { @@ -41,6 +42,17 @@ class ServiceMessagesController extends \BaseClass { return output($element); } + function delete($id) { + global $applicationContext, $hesk_settings; + + /* @var $handler ServiceMessageHandler */ + $handler = $applicationContext->get(ServiceMessageHandler::clazz()); + + $handler->deleteServiceMessage($id, $hesk_settings); + + return http_response_code(204); + } + /** * @param $data array * @param $userContext UserContext diff --git a/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php b/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php index 9dfb1796..b2539d12 100644 --- a/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php +++ b/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php @@ -3,7 +3,6 @@ namespace DataAccess\ServiceMessages; -use BusinessLogic\DateTimeHelpers; use BusinessLogic\ServiceMessages\ServiceMessage; use BusinessLogic\ServiceMessages\ServiceMessageStyle; use DataAccess\CommonDao; @@ -49,6 +48,10 @@ class ServiceMessagesGateway extends CommonDao { return $serviceMessage; } + /** + * @param $heskSettings + * @return ServiceMessage[] + */ function getServiceMessages($heskSettings) { $this->init(); @@ -100,4 +103,31 @@ class ServiceMessagesGateway extends CommonDao { return $serviceMessage; } + + function deleteServiceMessage($id, $heskSettings) { + $this->init(); + + hesk_dbQuery("DELETE FROM `" . hesk_dbEscape($heskSettings['db_pfix']) . "service_messages` + WHERE `id` = " . intval($id)); + + $this->close(); + } + + function resortAllServiceMessages($heskSettings) { + $this->init(); + + $rs = hesk_dbQuery("SELECT `id` FROM `" . hesk_dbEscape($heskSettings['db_pfix']) . "service_messages` + ORDER BY `order` ASC"); + + $sortValue = 10; + while ($row = hesk_dbFetchAssoc($rs)) { + hesk_dbQuery("UPDATE `" . hesk_dbEscape($heskSettings['db_pfix']) . "service_messages` + SET `order` = " . intval($sortValue) . " + WHERE `id` = " . intval($row['id'])); + + $sortValue += 10; + } + + $this->close(); + } } \ No newline at end of file diff --git a/api/autoload.php b/api/autoload.php index 0f14ff20..cf548485 100644 --- a/api/autoload.php +++ b/api/autoload.php @@ -12,6 +12,7 @@ require_once(__DIR__ . '/Core/output.php'); require_once(__DIR__ . '/../hesk_settings.inc.php'); require_once(__DIR__ . '/http_response_code.php'); require_once(__DIR__ . '/../inc/admin_functions.inc.php'); +require_once(__DIR__ . '/../inc/htmlpurifier/HeskHTMLPurifier.php'); hesk_load_api_database_functions(); diff --git a/api/index.php b/api/index.php index afa70f70..9c4b3e35 100644 --- a/api/index.php +++ b/api/index.php @@ -203,7 +203,15 @@ Link::all(array( // Settings '/v1/settings' => action(\Controllers\Settings\SettingsController::clazz(), RequestMethod::all()), // Service Messages - '/v1/service-messages' => action(\Controllers\ServiceMessages\ServiceMessagesController::clazz(), array(RequestMethod::GET, RequestMethod::POST, RequestMethod::PUT)), + '/v1/service-messages' => action(\Controllers\ServiceMessages\ServiceMessagesController::clazz(), + array(RequestMethod::GET, RequestMethod::POST, RequestMethod::PUT), + SecurityHandler::INTERNAL_OR_AUTH_TOKEN), + '/v1/service-messages/{i}' => action(\Controllers\ServiceMessages\ServiceMessagesController::clazz(), + array(RequestMethod::DELETE), + SecurityHandler::INTERNAL_OR_AUTH_TOKEN), + '/v1/service-messages/{i}/sort/{s}' => action(\Controllers\ServiceMessages\ServiceMessagesController::clazz() . '::sort', + array(RequestMethod::POST), + SecurityHandler::INTERNAL), /* Internal use only routes */ // Resend email response diff --git a/internal-api/js/service-messages.js b/internal-api/js/service-messages.js new file mode 100644 index 00000000..a2c3f950 --- /dev/null +++ b/internal-api/js/service-messages.js @@ -0,0 +1,362 @@ +var serviceMessages = []; + +$(document).ready(function() { + loadTable(); + bindEditModal(); + bindModalCancelCallback(); + bindFormSubmit(); + bindDeleteButton(); + bindCreateModal(); + bindSortButtons(); +}); + + +function loadTable() { + $('#overlay').show(); + var heskUrl = $('p#hesk-path').text(); + var $tableBody = $('#table-body'); + + $.ajax({ + method: 'GET', + url: heskUrl + 'api/index.php/v1/service-messages', + headers: { 'X-Internal-Call': true }, + success: function(data) { + $tableBody.html(''); + + if (data.length === 0) { + // TODO "No Service Messages Found" + $('#overlay').hide(); + return; + } + + var first = true; + var lastElement = null; + $.each(data, function() { + var $template = $($('#service-message-template').html()); + + $template.find('span[data-property="id"]').attr('data-value', this.id); + $template.find('span[data-property="title"]').html( + getFormattedTitle(this.icon, this.title, this.style)); + $template.find('span[data-property="author"]').text(users[this.createdBy].name); + if (this.published) { + $template.find('span[data-property="type"]').text(mfhLang.text('sm_published')); + } else { + $template.find('span[data-property="type"]').text(mfhLang.text('sm_draft')); + } + + $tableBody.append($template); + + serviceMessages[this.id] = this; + + lastElement = this; + + if (first) { + $template.find('[data-direction="up"]').css('visibility', 'hidden'); + first = false; + } + }); + + if (lastElement) { + //-- Hide the down arrow on the last element + $('[data-value="' + lastElement.id + '"]').parent().parent() + .find('[data-direction="down"]').css('visibility', 'hidden'); + } + }, + error: function(data) { + mfhAlert.errorWithLog(mfhLang.text('error_retrieving_categories'), data.responseJSON); + console.error(data); + }, + complete: function() { + refreshBackgroundVolatileItems(); + $('[data-toggle="popover"]').popover({ + trigger: 'hover', + container: 'body' + }); + $('#overlay').hide(); + } + }); +} + +function getFormattedTitle(icon, title, style) { + var $template = $($('#service-message-title-template').html()); + + var alertClass = 'none'; + switch (style) { + case 'ERROR': + alertClass = 'alert alert-danger'; + break; + case 'NOTICE': + alertClass = 'alert alert-warning'; + break; + case 'INFO': + alertClass = 'alert alert-info'; + break; + case 'SUCCESS': + alertClass = 'alert alert-success'; + break; + } + $template.addClass(alertClass) + .find('[data-property="icon"]').addClass(icon).end() + .find('[data-property="title"]').text(title); + + return $template; +} + +function getServiceMessagePreview(icon, title, message, style) { + var $template = $('#service-message-preview-template').html(); + + var alertClass = 'none'; + switch (style) { + case 'ERROR': + alertClass = 'alert alert-danger'; + break; + case 'NOTICE': + alertClass = 'alert alert-warning'; + break; + case 'INFO': + alertClass = 'alert alert-info'; + break; + case 'SUCCESS': + alertClass = 'alert alert-success'; + break; + } + $template = $template.replace('none', alertClass) + .replace('{{TITLE}}', title) + .replace('{{MESSAGE}}', message); + $template = $($template); + if (icon !== '') { + $template.find('i.fa').removeClass('fa').addClass(icon); + } + + return $template; +} + +function bindEditModal() { + $(document).on('click', '[data-action="edit"]', function() { + var element = categories[$(this).parent().parent().find('[data-property="id"]').text()]; + var $modal = $('#category-modal'); + + $modal.find('#edit-label').show(); + $modal.find('#create-label').hide(); + + $modal.find('input[name="name"]').val(element.name).end() + .find('select[name="priority"]').val(element.priority).end() + .find('select[name="manager"]').val(element.manager === null ? 0 : element.manager).end() + .find('input[name="id"]').val(element.id).end() + .find('select[name="usage"]').val(element.usage).end() + .find('input[name="display-border"][value="' + (element.displayBorder ? 1 : 0) + '"]') + .prop('checked', 'checked').end(); + + var backgroundColor = element.backgroundColor; + var foregroundColor = element.foregroundColor; + var colorpickerOptions = { + format: 'hex', + color: backgroundColor + }; + $modal.find('input[name="background-color"]') + .colorpicker(colorpickerOptions).end().modal('show'); + + colorpickerOptions = { + format: 'hex' + }; + if (foregroundColor != '' && foregroundColor !== 'AUTO') { + colorpickerOptions.color = foregroundColor; + } + + $modal.find('input[name="foreground-color"]') + .colorpicker(colorpickerOptions).end().modal('show'); + + if (foregroundColor === '' || foregroundColor === 'AUTO') { + $modal.find('input[name="foreground-color"]').colorpicker('setValue', '#fff'); + $modal.find('input[name="foreground-color"]').val(''); + } + + $modal.find('input[name="cat-order"]').val(element.catOrder); + $modal.find('input[name="autoassign"][value="' + (element.autoAssign ? 1 : 0) + '"]') + .prop('checked', 'checked'); + $modal.find('input[name="type"][value="' + (element.type ? 1 : 0) + '"]') + .prop('checked', 'checked'); + $modal.find('textarea[name="description"]').val(element.description === null ? '' : element.description); + + $modal.modal('show'); + }); +} + +function bindCreateModal() { + $('#create-button').click(function() { + var $modal = $('#category-modal'); + $modal.find('#edit-label').hide(); + $modal.find('#create-label').show(); + + $modal.find('input[name="name"]').val(''); + $modal.find('select[name="priority"]').val(3); // Low priority + $modal.find('select[name="usage"]').val(0); // Tickets and events + $modal.find('input[name="id"]').val(-1); + $modal.find('textarea[name="description"]').val(''); + $modal.find('input[name="cat-order"]').val(''); + $modal.find('input[name="type"][value="0"]').prop('checked', 'checked'); + $modal.find('input[name="autoassign"][value="0"]').prop('checked', 'checked'); + $modal.find('input[name="display-border"][value="0"]') + .prop('checked', 'checked'); + + var colorpickerOptions = { + format: 'hex', + color: '#fff' + }; + $modal.find('input[name="background-color"]') + .colorpicker(colorpickerOptions).end().modal('show'); + $modal.find('input[name="background-color"]').val(''); + $modal.find('input[name="foreground-color"]') + .colorpicker(colorpickerOptions).end().modal('show'); + $modal.find('input[name="foreground-color"]').val(''); + + $modal.modal('show'); + }); +} + +function bindModalCancelCallback() { + $('.cancel-callback').click(function() { + var $editCategoryModal = $('#category-modal'); + + $editCategoryModal.find('input[name="background-color"]').val('').colorpicker('destroy').end(); + $editCategoryModal.find('input[name="foreground-color"]').val('').colorpicker('destroy').end(); + $editCategoryModal.find('input[name="display-border"][value="1"]').prop('checked'); + $editCategoryModal.find('input[name="display-border"][value="0"]').prop('checked'); + $editCategoryModal.find('input[name="autoassign"][value="1"]').prop('checked'); + $editCategoryModal.find('input[name="autoassign"][value="0"]').prop('checked'); + }); +} + +function bindFormSubmit() { + $('form#manage-category').submit(function(e) { + e.preventDefault(); + var heskUrl = $('p#hesk-path').text(); + + var $modal = $('#category-modal'); + + var foregroundColor = $modal.find('input[name="foreground-color"]').val(); + var manager = parseInt($modal.find('select[name="manager"]').val()); + var data = { + autoassign: $modal.find('input[name="autoassign"]').val() === 'true', + backgroundColor: $modal.find('input[name="background-color"]').val(), + description: $modal.find('textarea[name="description"]').val(), + displayBorder: $modal.find('input[name="display-border"]:checked').val() === '1', + foregroundColor: foregroundColor === '' ? 'AUTO' : foregroundColor, + name: $modal.find('input[name="name"]').val(), + priority: parseInt($modal.find('select[name="priority"]').val()), + manager: manager === 0 ? null : manager, + type: parseInt($modal.find('input[name="type"]:checked').val()), + usage: parseInt($modal.find('select[name="usage"]').val()), + catOrder: parseInt($modal.find('input[name="cat-order"]').val()) + }; + + var url = heskUrl + 'api/index.php/v1/categories/'; + var method = 'POST'; + + var categoryId = parseInt($modal.find('input[name="id"]').val()); + if (categoryId !== -1) { + url += categoryId; + method = 'PUT'; + } + + $modal.find('#action-buttons').find('.cancel-button').attr('disabled', 'disabled'); + $modal.find('#action-buttons').find('.save-button').attr('disabled', 'disabled'); + + $.ajax({ + method: 'POST', + url: url, + headers: { + 'X-Internal-Call': true, + 'X-HTTP-Method-Override': method + }, + data: JSON.stringify(data), + success: function(data) { + var format = undefined; + if (categoryId === -1) { + format = mfhLang.html('cat_name_added'); + mfhAlert.success(format.replace('%s', data.name)); + } else { + format = mfhLang.html('category_updated'); + mfhAlert.success(format.replace('%s', data.name)); + } + $modal.modal('hide'); + loadTable(); + }, + error: function(data) { + mfhAlert.errorWithLog(mfhLang.text('error_saving_updating_category'), data.responseJSON); + console.error(data); + }, + complete: function(data) { + $modal.find('#action-buttons').find('.cancel-button').removeAttr('disabled'); + $modal.find('#action-buttons').find('.save-button').removeAttr('disabled'); + } + }); + }); +} + +function bindDeleteButton() { + $(document).on('click', '[data-action="delete"]', function() { + $('#overlay').show(); + + var heskUrl = $('p#hesk-path').text(); + var element = categories[$(this).parent().parent().find('[data-property="id"]').text()]; + + $.ajax({ + method: 'POST', + url: heskUrl + 'api/index.php/v1/categories/' + element.id, + headers: { + 'X-Internal-Call': true, + 'X-HTTP-Method-Override': 'DELETE' + }, + success: function() { + mfhAlert.success(mfhLang.text('cat_removed')); + loadTable(); + }, + error: function(data) { + $('#overlay').hide(); + mfhAlert.errorWithLog(mfhLang.text('error_deleting_category'), data.responseJSON); + console.error(data); + } + }); + }); +} + +function bindGenerateLinkModal() { + var $modal = $('#generate-link-modal'); + + $modal.find('.input-group-addon').click(function() { + clipboard.copy($modal.find('input[type="text"]').val()); + mfhAlert.success(mfhLang.text('copied_to_clipboard')); + }); + + $(document).on('click', '[data-property="generate-link"] i.fa-code', function () { + var heskUrl = $('p#hesk-url').text(); + + var url = heskUrl + '/index.php?a=add&catid=' + $(this).parent().data('category-id'); + + $modal.find('input[type="text"]').val(url).end().modal('show'); + }); +} + +function bindSortButtons() { + $(document).on('click', '[data-action="sort"]', function() { + $('#overlay').show(); + var heskUrl = $('p#hesk-path').text(); + var direction = $(this).data('direction'); + var element = categories[$(this).parent().parent().parent().find('[data-property="id"]').text()]; + + $.ajax({ + method: 'POST', + url: heskUrl + 'api/index.php/v1-internal/categories/' + element.id + '/sort/' + direction, + headers: { 'X-Internal-Call': true }, + success: function() { + loadTable(); + }, + error: function(data) { + mfhAlert.errorWithLog(mfhLang.text('error_sorting_categories'), data.responseJSON); + console.error(data); + $('#overlay').hide(); + } + }) + }); +} \ No newline at end of file From a8abfcd4a11216a3af59e205c3398a7b7e69338d Mon Sep 17 00:00:00 2001 From: Mike Koch Date: Mon, 13 Nov 2017 13:07:19 -0500 Subject: [PATCH 06/21] More progress on service messages --- admin/service_messages.php | 309 +++++++++--------- .../ServiceMessagesController.php | 1 - internal-api/js/service-messages.js | 56 +--- language/en/text.php | 3 + 4 files changed, 165 insertions(+), 204 deletions(-) diff --git a/admin/service_messages.php b/admin/service_messages.php index b83d9378..6368b572 100644 --- a/admin/service_messages.php +++ b/admin/service_messages.php @@ -57,6 +57,12 @@ require_once(HESK_PATH . 'inc/show_admin_nav.inc.php');
    +
    + +
    -
    -
    -

    -
    -
    -
    -
    - - -
    -
    - -
    -
    -
    -
    - -
    -
    -
    -
    - -
    -
    -
    -
    - -
    -
    -
    -
    - -
    -
    -
    -
    - - -
    - - - - - - -
    -
    -
    -
    - - -
    -
    - -
    -
    -
    -
    - -
    -
    -
    -
    - - -
    - data-error="" required> -
    -
    -
    -
    - - -
    - -
    -
    -
    - ' : ''; ?> - - -
    -
    - - -
    -
    -
    -
    -
    -
    @@ -262,10 +111,156 @@ require_once(HESK_PATH . 'inc/show_admin_nav.inc.php'); + var users = [];'; diff --git a/api/Controllers/ServiceMessages/ServiceMessagesController.php b/api/Controllers/ServiceMessages/ServiceMessagesController.php index 94ff9776..faf9f568 100644 --- a/api/Controllers/ServiceMessages/ServiceMessagesController.php +++ b/api/Controllers/ServiceMessages/ServiceMessagesController.php @@ -6,7 +6,6 @@ use BusinessLogic\Security\UserContext; use BusinessLogic\ServiceMessages\ServiceMessage; use BusinessLogic\ServiceMessages\ServiceMessageHandler; use Controllers\JsonRetriever; -use Symfony\Component\EventDispatcher\Tests\Service; class ServiceMessagesController extends \BaseClass { function get() { diff --git a/internal-api/js/service-messages.js b/internal-api/js/service-messages.js index a2c3f950..fc3754af 100644 --- a/internal-api/js/service-messages.js +++ b/internal-api/js/service-messages.js @@ -3,7 +3,6 @@ var serviceMessages = []; $(document).ready(function() { loadTable(); bindEditModal(); - bindModalCancelCallback(); bindFormSubmit(); bindDeleteButton(); bindCreateModal(); @@ -24,7 +23,7 @@ function loadTable() { $tableBody.html(''); if (data.length === 0) { - // TODO "No Service Messages Found" + $tableBody.append('' + mfhLang.text('no_sm') + ''); $('#overlay').hide(); return; } @@ -63,15 +62,10 @@ function loadTable() { } }, error: function(data) { - mfhAlert.errorWithLog(mfhLang.text('error_retrieving_categories'), data.responseJSON); + mfhAlert.errorWithLog(mfhLang.text('error_retrieving_sm'), data.responseJSON); console.error(data); }, complete: function() { - refreshBackgroundVolatileItems(); - $('[data-toggle="popover"]').popover({ - trigger: 'hover', - container: 'body' - }); $('#overlay').hide(); } }); @@ -184,49 +178,19 @@ function bindEditModal() { function bindCreateModal() { $('#create-button').click(function() { - var $modal = $('#category-modal'); - $modal.find('#edit-label').hide(); - $modal.find('#create-label').show(); - - $modal.find('input[name="name"]').val(''); - $modal.find('select[name="priority"]').val(3); // Low priority - $modal.find('select[name="usage"]').val(0); // Tickets and events - $modal.find('input[name="id"]').val(-1); - $modal.find('textarea[name="description"]').val(''); - $modal.find('input[name="cat-order"]').val(''); - $modal.find('input[name="type"][value="0"]').prop('checked', 'checked'); - $modal.find('input[name="autoassign"][value="0"]').prop('checked', 'checked'); - $modal.find('input[name="display-border"][value="0"]') - .prop('checked', 'checked'); - - var colorpickerOptions = { - format: 'hex', - color: '#fff' - }; - $modal.find('input[name="background-color"]') - .colorpicker(colorpickerOptions).end().modal('show'); - $modal.find('input[name="background-color"]').val(''); - $modal.find('input[name="foreground-color"]') - .colorpicker(colorpickerOptions).end().modal('show'); - $modal.find('input[name="foreground-color"]').val(''); + var $modal = $('#service-message-modal'); + $modal.find('#edit-label').hide().end() + .find('#create-label').show().end() + .find('input[name="style"][value="0"]').prop('checked', 'checked').end() // "None" style + .find('input[name="type"][value="0"]').prop('checked', 'checked').end() // Published + .find('input[name="title"]').val('').end(); + setIcon(''); + tinyMCE.get('content').setContent(''); $modal.modal('show'); }); } -function bindModalCancelCallback() { - $('.cancel-callback').click(function() { - var $editCategoryModal = $('#category-modal'); - - $editCategoryModal.find('input[name="background-color"]').val('').colorpicker('destroy').end(); - $editCategoryModal.find('input[name="foreground-color"]').val('').colorpicker('destroy').end(); - $editCategoryModal.find('input[name="display-border"][value="1"]').prop('checked'); - $editCategoryModal.find('input[name="display-border"][value="0"]').prop('checked'); - $editCategoryModal.find('input[name="autoassign"][value="1"]').prop('checked'); - $editCategoryModal.find('input[name="autoassign"][value="0"]').prop('checked'); - }); -} - function bindFormSubmit() { $('form#manage-category').submit(function(e) { e.preventDefault(); diff --git a/language/en/text.php b/language/en/text.php index d543ccd3..833551f5 100644 --- a/language/en/text.php +++ b/language/en/text.php @@ -2215,5 +2215,8 @@ $hesklang['audit_due_date_changed'] = '%s changed due date to %s'; $hesklang['audit_linked_ticket'] = '%s linked ticket %s to this ticket'; $hesklang['audit_unlinked_ticket'] = '%s unlinked ticket %s'; +// Added or modified in Mods for HESK 3.3.0 +$hesklang['error_retrieving_sm'] = 'An error occurred retrieving service messages!'; + // DO NOT CHANGE BELOW if (!defined('IN_SCRIPT')) die('PHP syntax OK!'); From d897fa2a4bacb07d310d73c4a709f4af0826ebbd Mon Sep 17 00:00:00 2001 From: Mike Koch Date: Mon, 13 Nov 2017 22:13:55 -0500 Subject: [PATCH 07/21] More progress' --- admin/service_messages.php | 10 +-- internal-api/js/service-messages.js | 100 +++++++++++----------------- 2 files changed, 46 insertions(+), 64 deletions(-) diff --git a/admin/service_messages.php b/admin/service_messages.php index 6368b572..8602f3ee 100644 --- a/admin/service_messages.php +++ b/admin/service_messages.php @@ -93,6 +93,7 @@ require_once(HESK_PATH . 'inc/show_admin_nav.inc.php'); + @@ -121,7 +122,7 @@ require_once(HESK_PATH . 'inc/show_admin_nav.inc.php'); - + +
    + +
    +
    Customer Pages
    +
    + Homepage +
    +
    + Knowledgebase Home +
    +
    + View Knowledgebase Article +
    +
    + Submit Ticket +
    +
    + View Ticket +
    +
    +
    +
    Staff Pages
    +
    + Login Page +
    +
    + Homepage +
    +
    + Knowledgebase Home +
    +
    + View Knowledgebase Article +
    +
    + Submit Ticket +
    +
    + View Ticket +
    +
    +
    diff --git a/install/migrations/v330/UpdateExistingServiceMessagesLocations.php b/install/migrations/v330/UpdateExistingServiceMessagesLocations.php new file mode 100644 index 00000000..899909dc --- /dev/null +++ b/install/migrations/v330/UpdateExistingServiceMessagesLocations.php @@ -0,0 +1,19 @@ +executeQuery("INSERT INTO `" . hesk_dbEscape($hesk_settings['db_pfix']) . "mfh_service_message_to_location` (`service_message_id`, `location`) + SELECT `id`, '" . hesk_dbEscape(ServiceMessageLocation::CUSTOMER_HOME) . "' FROM `" . hesk_dbEscape($hesk_settings['db_pfix']) . "service_messages`"); + } + + function innerDown($hesk_settings) { + $this->executeQuery("DELETE FROM `" . hesk_dbEscape($hesk_settings['db_pfix']) . "mfh_service_message_to_location` + WHERE `service_message_id` IN (SELECT `id` FROM `" . hesk_dbEscape($hesk_settings['db_pfix']) . "service_messages`)"); + } +} \ No newline at end of file diff --git a/internal-api/js/service-messages.js b/internal-api/js/service-messages.js index 050c864a..ebe79766 100644 --- a/internal-api/js/service-messages.js +++ b/internal-api/js/service-messages.js @@ -137,7 +137,8 @@ function bindEditModal() { $(document).on('click', '[data-action="edit"]', function() { var element = serviceMessages[$(this).parent().parent().find('[data-property="id"]').data('value')]; var $modal = $('#service-message-modal'); - $modal.find('#preview-pane').html(''); + $modal.find('#preview-pane').html('').end() + .find('input[name="location[]"]').prop('checked', false); $modal.find('#edit-label').show(); $modal.find('#create-label').hide(); @@ -150,6 +151,10 @@ function bindEditModal() { .find('input[name="order"]').val(element.order).end(); setIcon(element.icon); + $.each(element.locations, function() { + $modal.find('input[name="location[]"][value="' + this + '"]').prop('checked', 'checked'); + }); + if ($('input[name="kb_wysiwyg"]').val() === "1") { tinyMCE.get('content').setContent(element.message); } else { @@ -171,7 +176,8 @@ function bindCreateModal() { .find('input[name="title"]').val('').end() .find('input[name="id"]').val(-1).end() .find('input[name="order"]').val('').end() - .find('#preview-pane').html('').end(); + .find('#preview-pane').html('').end() + .find('input[name="location[]"]').prop('checked', false); setIcon(''); if ($('input[name="kb_wysiwyg"]').val() === "1") { @@ -198,13 +204,21 @@ function bindFormSubmit() { styles[3] = "NOTICE"; styles[4] = "ERROR"; + var domLocations = $modal.find('input[name="location[]"]:checked'); + + var locations = []; + $.each(domLocations, function() { + locations.push($(this).val()); + }); + var data = { icon: $modal.find('input[name="icon"]').val(), title: $modal.find('input[name="title"]').val(), message: getMessage(), published: $modal.find('input[name="type"]:checked').val() === "0", style: styles[$modal.find('input[name="style"]:checked').val()], - order: $modal.find('input[name="order"]').val() + order: $modal.find('input[name="order"]').val(), + locations: locations }; var url = heskUrl + 'api/index.php/v1/service-messages/'; From 3e82065fa4010c92098bbee2967f97c9a9ec8f0f Mon Sep 17 00:00:00 2001 From: Mike Koch Date: Sat, 18 Nov 2017 22:05:11 -0500 Subject: [PATCH 14/21] Working on adding a language option to service messages --- admin/service_messages.php | 330 ++++++++++-------- install/migrations/core.php | 4 +- .../AddLanguageColumnToServiceMessages.php | 17 + .../CreateServiceMessageToLocationTable.php | 2 +- ...UpdateExistingServiceMessagesLocations.php | 2 +- 5 files changed, 213 insertions(+), 142 deletions(-) create mode 100644 install/migrations/v330/ServiceMessagesImprovements/AddLanguageColumnToServiceMessages.php rename install/migrations/v330/{ => ServiceMessagesImprovements}/CreateServiceMessageToLocationTable.php (91%) rename install/migrations/v330/{ => ServiceMessagesImprovements}/UpdateExistingServiceMessagesLocations.php (94%) diff --git a/admin/service_messages.php b/admin/service_messages.php index 93ad7a5c..8d13ea0a 100644 --- a/admin/service_messages.php +++ b/admin/service_messages.php @@ -130,150 +130,202 @@ require_once(HESK_PATH . 'inc/show_admin_nav.inc.php');
    + @@ -131,11 +132,11 @@ require_once(HESK_PATH . 'inc/show_admin_nav.inc.php'); +
    diff --git a/api/BusinessLogic/ServiceMessages/ServiceMessage.php b/api/BusinessLogic/ServiceMessages/ServiceMessage.php index 9a5aff94..f40e9b9c 100644 --- a/api/BusinessLogic/ServiceMessages/ServiceMessage.php +++ b/api/BusinessLogic/ServiceMessages/ServiceMessage.php @@ -33,4 +33,7 @@ class ServiceMessage extends \BaseClass { /* @var $locations string[] */ public $locations; + + /* @var $language string */ + public $language; } \ No newline at end of file diff --git a/api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php b/api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php index e852f4cf..2cf31892 100644 --- a/api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php +++ b/api/BusinessLogic/ServiceMessages/ServiceMessageHandler.php @@ -118,6 +118,20 @@ class ServiceMessageHandler extends \BaseClass { $htmlPurifier = new \HeskHTMLPurifier($heskSettings['cache_dir']); $serviceMessage->message = $htmlPurifier->heskPurify($serviceMessage->message); } + if ($serviceMessage->language === null || trim($serviceMessage->language) === '') { + $validationModel->errorKeys[] = 'MISSING_LANGUAGE'; + } + + $languageFound = false; + foreach ($heskSettings['languages'] as $key => $value) { + if ($value['folder'] === $serviceMessage->language || $serviceMessage->language === 'ALL') { + $languageFound = true; + break; + } + } + if (!$languageFound) { + $validationModel->errorKeys[] = 'LANGUAGE_NOT_INSTALLED'; + } if ($serviceMessage->title === null || trim($serviceMessage->title) === '') { $validationModel->errorKeys[] = 'MISSING_TITLE'; diff --git a/api/Controllers/ServiceMessages/ServiceMessagesController.php b/api/Controllers/ServiceMessages/ServiceMessagesController.php index 481c10a6..bf6c26de 100644 --- a/api/Controllers/ServiceMessages/ServiceMessagesController.php +++ b/api/Controllers/ServiceMessages/ServiceMessagesController.php @@ -76,6 +76,7 @@ class ServiceMessagesController extends \BaseClass { $serviceMessage->message = Helpers::safeArrayGet($data, 'message'); $serviceMessage->published = Helpers::safeArrayGet($data, 'published'); $serviceMessage->style = Helpers::safeArrayGet($data, 'style'); + $serviceMessage->language = Helpers::safeArrayGet($data, 'language'); $jsonLocations = Helpers::safeArrayGet($data, 'locations'); diff --git a/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php b/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php index 6a58b070..371089a9 100644 --- a/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php +++ b/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php @@ -24,14 +24,15 @@ class ServiceMessagesGateway extends CommonDao { $type = $serviceMessage->published ? 0 : 1; // Insert service message into database - hesk_dbQuery("INSERT INTO `" . hesk_dbEscape($heskSettings['db_pfix']) . "service_messages` (`author`,`title`,`message`,`style`,`type`,`order`, `icon`) VALUES ( + hesk_dbQuery("INSERT INTO `" . hesk_dbEscape($heskSettings['db_pfix']) . "service_messages` (`author`,`title`,`message`,`style`,`type`,`order`, `icon`, `mfh_language`) VALUES ( '" . intval($serviceMessage->createdBy) . "', '" . hesk_dbEscape($serviceMessage->title) . "', '" . hesk_dbEscape($serviceMessage->message) . "', '" . hesk_dbEscape($style) . "', '{$type}', '{$myOrder}', - '" . hesk_dbEscape($serviceMessage->icon) . "' + '" . hesk_dbEscape($serviceMessage->icon) . "', + '" . hesk_dbEscape($serviceMessage->language) . "', )"); $serviceMessage->id = hesk_dbInsertID(); @@ -74,6 +75,7 @@ class ServiceMessagesGateway extends CommonDao { $serviceMessage->message = $row['message']; $serviceMessage->style = ServiceMessageStyle::getStyleById($row['style']); $serviceMessage->icon = $row['icon']; + $serviceMessage->language = $row['mfh_language']; $serviceMessage->locations = array(); $locationsRs = hesk_dbQuery("SELECT `location` FROM `" . hesk_dbEscape($heskSettings['db_pfix']) . "mfh_service_message_to_location` @@ -102,7 +104,8 @@ class ServiceMessagesGateway extends CommonDao { `style` = '" . intval($style) . "', `type` = " . intval($type) . ", `icon` = '" . hesk_dbEscape($serviceMessage->icon) . "', - `order` = " . intval($serviceMessage->order) . " + `order` = " . intval($serviceMessage->order) . ", + `mfh_language` = '" . hesk_dbEscape($serviceMessage->language) . "' WHERE `id` = " . intval($serviceMessage->id)); hesk_dbQuery("DELETE FROM `" . hesk_dbEscape($heskSettings['db_pfix']) . "mfh_service_message_to_location` diff --git a/internal-api/js/service-messages.js b/internal-api/js/service-messages.js index ebe79766..e75719eb 100644 --- a/internal-api/js/service-messages.js +++ b/internal-api/js/service-messages.js @@ -50,6 +50,9 @@ function loadTable() { } else { $template.find('span[data-property="type"]').text(mfhLang.text('sm_draft')); } + $template.find('[data-property="language"]').text(this.language === 'ALL' ? + mfhLang.text('all') : + languages[this.language]); $tableBody.append($template); @@ -148,7 +151,8 @@ function bindEditModal() { .prop('checked', 'checked').end() .find('input[name="title"]').val(element.title).end() .find('input[name="id"]').val(element.id).end() - .find('input[name="order"]').val(element.order).end(); + .find('input[name="order"]').val(element.order).end() + .find('select[name="language"]').val(element.language).end(); setIcon(element.icon); $.each(element.locations, function() { @@ -161,6 +165,11 @@ function bindEditModal() { $('textarea[name="message"]').val(element.message); } + $('.tab-pane#sm-contents').addClass('active'); + $('.tab-pane#properties').removeClass('active'); + $('.nav-tabs > li').removeClass('active'); + $('.nav-tabs > li:first').addClass('active'); + $modal.modal('show'); }); @@ -177,7 +186,8 @@ function bindCreateModal() { .find('input[name="id"]').val(-1).end() .find('input[name="order"]').val('').end() .find('#preview-pane').html('').end() - .find('input[name="location[]"]').prop('checked', false); + .find('input[name="location[]"]').prop('checked', false) + .find('select[name="language"]').val('ALL'); setIcon(''); if ($('input[name="kb_wysiwyg"]').val() === "1") { @@ -186,6 +196,11 @@ function bindCreateModal() { $('textarea[name="message"]').val(''); } + $('.tab-pane#sm-contents').addClass('active'); + $('.tab-pane#properties').removeClass('active'); + $('.nav-tabs > li').removeClass('active'); + $('.nav-tabs > li:first').addClass('active'); + $modal.modal('show'); }); } @@ -218,6 +233,7 @@ function bindFormSubmit() { published: $modal.find('input[name="type"]:checked').val() === "0", style: styles[$modal.find('input[name="style"]:checked').val()], order: $modal.find('input[name="order"]').val(), + language: $modal.find('select[name="language"]').val(), locations: locations }; From 3bff7fd30b3efbd10fcc3a6ab23979670b524f7b Mon Sep 17 00:00:00 2001 From: Mike Koch Date: Mon, 27 Nov 2017 12:22:41 -0500 Subject: [PATCH 16/21] Contentified some strings --- admin/service_messages.php | 36 ++++++++++++++++++------------------ language/en/text.php | 9 +++++++++ 2 files changed, 27 insertions(+), 18 deletions(-) diff --git a/admin/service_messages.php b/admin/service_messages.php index 935a09c1..cb08371a 100644 --- a/admin/service_messages.php +++ b/admin/service_messages.php @@ -259,71 +259,71 @@ require_once(HESK_PATH . 'inc/show_admin_nav.inc.php');
    - +
    -
    Customer Pages
    +
    - Select All +
    - Deselect All +
    Homepage + name="location[]" value="CUSTOMER_HOME">
    Knowledgebase Home + name="location[]" value="CUSTOMER_KB_HOME">
    View Knowledgebase Article + name="location[]" value="CUSTOMER_VIEW_KB_ARTICLE">
    Submit Ticket + name="location[]" value="CUSTOMER_SUBMIT_TICKET">
    View Ticket + name="location[]" value="CUSTOMER_VIEW_TICKET">
    -
    Staff Pages
    +
    - Select All +
    - Deselect All +
    Login Page + name="location[]" value="STAFF_LOGIN">
    Homepage + name="location[]" value="STAFF_HOME">
    Knowledgebase Home + name="location[]" value="STAFF_KB_HOME">
    View Knowledgebase Article + name="location[]" value="STAFF_VIEW_KB_ARTICLE">
    Submit Ticket + name="location[]" value="STAFF_SUBMIT_TICKET">
    View Ticket + name="location[]" value="STAFF_VIEW_TICKET">
    diff --git a/language/en/text.php b/language/en/text.php index a360ef74..7d62e3f3 100644 --- a/language/en/text.php +++ b/language/en/text.php @@ -2219,6 +2219,15 @@ $hesklang['error_retrieving_sm'] = 'An error occurred retrieving service message $hesklang['error_saving_updating_sm'] = 'An error occurred creating / saving the service message!'; $hesklang['error_deleting_sm'] = 'An error occurred when trying to delete the service message.'; $hesklang['error_sorting_sm'] = 'An error occurred sorting service messages!'; +$hesklang['sm_location'] = 'Location'; // Location for service messages +$hesklang['sm_customer_pages'] = 'Customer Pages'; +$hesklang['sm_staff_pages'] = 'Staff Pages'; +$hesklang['sm_homepage'] = 'Homepage'; +$hesklang['sm_kb_home'] = 'Knowledgebase Home'; +$hesklang['sm_view_kb_article'] = 'View Knowledgebase Article'; +$hesklang['sm_submit_ticket'] = 'Submit Ticket'; +$hesklang['sm_view_ticket'] = 'View Ticket'; +$hesklang['sm_login_page'] = 'Login Page'; // DO NOT CHANGE BELOW if (!defined('IN_SCRIPT')) die('PHP syntax OK!'); From 902f3edcf6c2ab3e5febffd41299cf80a2dc3045 Mon Sep 17 00:00:00 2001 From: Mike Koch Date: Mon, 27 Nov 2017 12:51:34 -0500 Subject: [PATCH 17/21] Only show locations that are active --- admin/service_messages.php | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/admin/service_messages.php b/admin/service_messages.php index cb08371a..052e0eb4 100644 --- a/admin/service_messages.php +++ b/admin/service_messages.php @@ -50,11 +50,6 @@ require_once(HESK_PATH . 'inc/show_admin_nav.inc.php'); title="" data-placement="bottom"> -
    - -
    @@ -274,6 +269,7 @@ require_once(HESK_PATH . 'inc/show_admin_nav.inc.php');
    + 0): ?>
    @@ -282,6 +278,7 @@ require_once(HESK_PATH . 'inc/show_admin_nav.inc.php');
    +
    @@ -290,6 +287,7 @@ require_once(HESK_PATH . 'inc/show_admin_nav.inc.php');
    +
    @@ -309,6 +307,7 @@ require_once(HESK_PATH . 'inc/show_admin_nav.inc.php');
    + 0): ?>
    @@ -317,6 +316,7 @@ require_once(HESK_PATH . 'inc/show_admin_nav.inc.php');
    +
    @@ -325,6 +325,7 @@ require_once(HESK_PATH . 'inc/show_admin_nav.inc.php');
    + From 2faac6be1a44e84425ca65e291b153ce9579c707 Mon Sep 17 00:00:00 2001 From: Mike Koch Date: Mon, 27 Nov 2017 13:00:35 -0500 Subject: [PATCH 18/21] Fixed type not being stored, working on display locations --- api/DataAccess/ServiceMessages/ServiceMessagesGateway.php | 4 ++-- index.php | 7 ++++++- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php b/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php index 371089a9..d9d8985a 100644 --- a/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php +++ b/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php @@ -32,7 +32,7 @@ class ServiceMessagesGateway extends CommonDao { '{$type}', '{$myOrder}', '" . hesk_dbEscape($serviceMessage->icon) . "', - '" . hesk_dbEscape($serviceMessage->language) . "', + '" . hesk_dbEscape($serviceMessage->language) . "' )"); $serviceMessage->id = hesk_dbInsertID(); @@ -102,7 +102,7 @@ class ServiceMessagesGateway extends CommonDao { SET `title` = '" . hesk_dbEscape($serviceMessage->title) . "', `message` = '" . hesk_dbEscape($serviceMessage->message) . "', `style` = '" . intval($style) . "', - `type` = " . intval($type) . ", + `type` = '{$type}', `icon` = '" . hesk_dbEscape($serviceMessage->icon) . "', `order` = " . intval($serviceMessage->order) . ", `mfh_language` = '" . hesk_dbEscape($serviceMessage->language) . "' diff --git a/index.php b/index.php index e9082980..ad824f67 100644 --- a/index.php +++ b/index.php @@ -1315,7 +1315,12 @@ function print_start() 0) { ?> From 3e8085110ff464b269fe96d9ab0e4efd4c15c98b Mon Sep 17 00:00:00 2001 From: Mike Koch Date: Tue, 28 Nov 2017 13:03:06 -0500 Subject: [PATCH 19/21] Service messages now appear in their proper locations --- admin/admin_main.php | 10 +++++++++- admin/admin_ticket.php | 5 +++++ admin/index.php | 6 ++++++ admin/knowledgebase_private.php | 19 ++++++++++++++++++- admin/manage_knowledgebase.php | 6 ++++++ admin/new_ticket.php | 5 +++++ inc/common.inc.php | 21 +++++++++++++++++++++ index.php | 21 ++++++++++----------- knowledgebase.php | 15 +++++++++++---- ticket.php | 13 +++++++++++++ 10 files changed, 104 insertions(+), 17 deletions(-) diff --git a/admin/admin_main.php b/admin/admin_main.php index 0d6dcefc..59898d18 100644 --- a/admin/admin_main.php +++ b/admin/admin_main.php @@ -54,7 +54,15 @@ else { ?>
    - +

    diff --git a/admin/admin_ticket.php b/admin/admin_ticket.php index 150b54e6..36804051 100644 --- a/admin/admin_ticket.php +++ b/admin/admin_ticket.php @@ -939,6 +939,11 @@ require_once(HESK_PATH . 'inc/show_admin_nav.inc.php'); /* This will handle error, success and notice messages */ hesk_handle_messages(); + $service_messages = mfh_get_service_messages('STAFF_VIEW_TICKET'); + foreach ($service_messages as $sm) { + hesk_service_message($sm); + } + // Prepare special custom fields foreach ($hesk_settings['custom_fields'] as $k=>$v) { if ($v['use'] && hesk_is_custom_field_in_category($k, $ticket['category']) ) { diff --git a/admin/index.php b/admin/index.php index aec1e374..f623d4a0 100644 --- a/admin/index.php +++ b/admin/index.php @@ -278,6 +278,12 @@ function print_login()

    '; } // END hesk_kb_header() @@ -214,7 +216,15 @@ function hesk_show_kb_article($artid) ?>
    - + '; + $service_messages = mfh_get_service_messages('STAFF_VIEW_KB_ARTICLE'); + foreach ($service_messages as $sm) { + hesk_service_message($sm); + } + echo '
    '; + ?>
    @@ -397,6 +407,13 @@ function hesk_show_kb_category($catid, $is_search = 0) { { /* Print header */ hesk_kb_header($hesk_settings['kb_link'], $catid); + + echo '
    '; + $service_messages = mfh_get_service_messages('STAFF_KB_HOME'); + foreach ($service_messages as $sm) { + hesk_service_message($sm); + } + echo '
    '; } ?>
    diff --git a/admin/manage_knowledgebase.php b/admin/manage_knowledgebase.php index b126a326..03e4ba6f 100644 --- a/admin/manage_knowledgebase.php +++ b/admin/manage_knowledgebase.php @@ -270,6 +270,12 @@ if (!isset($_SESSION['hide']['treemenu']))
    diff --git a/inc/common.inc.php b/inc/common.inc.php index b510e92b..b6ce26f9 100644 --- a/inc/common.inc.php +++ b/inc/common.inc.php @@ -192,6 +192,27 @@ function hesk_service_message($sm)
    -

    @@ -322,6 +321,13 @@ function print_add_ticket()

    +
    @@ -1315,20 +1321,13 @@ function print_start() 0) - { + $service_messages = mfh_get_service_messages('CUSTOMER_HOME'); + if (count($service_messages) > 0) { ?>
    diff --git a/knowledgebase.php b/knowledgebase.php index fdb2a3a4..22e86586 100644 --- a/knowledgebase.php +++ b/knowledgebase.php @@ -254,6 +254,13 @@ if (!$show['show']) { require_once(HESK_PATH . 'inc/header.inc.php'); hesk_kb_header($hesk_settings['kb_link']); + + // Service messages + $service_messages = mfh_get_service_messages('CUSTOMER_VIEW_KB_ARTICLE'); + foreach ($service_messages as $sm) { + hesk_service_message($sm); + } + // Update views by 1 - exclude known bots and reloads because of ratings if (!isset($_GET['rated']) && !hesk_detect_bots()) { hesk_dbQuery("UPDATE `" . hesk_dbEscape($hesk_settings['db_pfix']) . "kb_articles` SET `views`=`views`+1 WHERE `id`={$artid}"); @@ -406,11 +413,11 @@ if (!$show['show']) { hesk_kb_header($hesk_settings['kb_link']); } - // If we are in "Knowledgebase only" mode show system messages - if ($catid == 1 && hesk_check_kb_only(false)) { + // Display service messages on the default category + if ($catid == 1) { // Service messages - $res = hesk_dbQuery('SELECT `title`, `message`, `style` FROM `' . hesk_dbEscape($hesk_settings['db_pfix']) . "service_messages` WHERE `type`='0' ORDER BY `order` ASC"); - while ($sm = hesk_dbFetchAssoc($res)) { + $service_messages = mfh_get_service_messages('CUSTOMER_KB_HOME'); + foreach ($service_messages as $sm) { hesk_service_message($sm); } } diff --git a/ticket.php b/ticket.php index cb7ef11b..316dac96 100644 --- a/ticket.php +++ b/ticket.php @@ -215,6 +215,13 @@ if (!$show['show']) {
    From 0a2e37320aef3a7cd9c4f8670772ba051c249a00 Mon Sep 17 00:00:00 2001 From: Mike Koch Date: Fri, 1 Dec 2017 12:56:23 -0500 Subject: [PATCH 20/21] Working on adding controller security --- api/BusinessLogic/Security/UserPrivilege.php | 1 + .../ServiceMessagesController.php | 17 ++++++++++++++++- api/Core/json_error.php | 6 +++++- api/index.php | 2 +- 4 files changed, 23 insertions(+), 3 deletions(-) diff --git a/api/BusinessLogic/Security/UserPrivilege.php b/api/BusinessLogic/Security/UserPrivilege.php index 353e8e43..8cd1eee4 100644 --- a/api/BusinessLogic/Security/UserPrivilege.php +++ b/api/BusinessLogic/Security/UserPrivilege.php @@ -15,4 +15,5 @@ class UserPrivilege extends \BaseClass { const CAN_EDIT_TICKETS = 'can_edit_tickets'; const CAN_DELETE_TICKETS = 'can_del_tickets'; const CAN_MANAGE_CATEGORIES = 'can_man_cat'; + const CAN_MANAGE_SERVICE_MESSAGES = 'can_service_msg'; } \ No newline at end of file diff --git a/api/Controllers/ServiceMessages/ServiceMessagesController.php b/api/Controllers/ServiceMessages/ServiceMessagesController.php index bf6c26de..b147f123 100644 --- a/api/Controllers/ServiceMessages/ServiceMessagesController.php +++ b/api/Controllers/ServiceMessages/ServiceMessagesController.php @@ -2,15 +2,30 @@ namespace Controllers\ServiceMessages; +use BusinessLogic\Exceptions\ApiFriendlyException; use BusinessLogic\Helpers; use BusinessLogic\Security\UserContext; +use BusinessLogic\Security\UserPrivilege; use BusinessLogic\ServiceMessages\ServiceMessage; use BusinessLogic\ServiceMessages\ServiceMessageHandler; +use Controllers\ControllerWithSecurity; use Controllers\JsonRetriever; class ServiceMessagesController extends \BaseClass { + /** + * @param $userContext UserContext + * @throws ApiFriendlyException + */ + function checkSecurity($userContext) { + if (!in_array(UserPrivilege::CAN_MANAGE_SERVICE_MESSAGES, $userContext->permissions)) { + throw new ApiFriendlyException("User does not have permission to access the following URI: " . $_SERVER['REQUEST_URI'], "Access Forbidden", 403); + } + } + function get() { - global $applicationContext, $hesk_settings; + global $applicationContext, $hesk_settings, $userContext; + + $this->checkSecurity($userContext); /* @var $handler ServiceMessageHandler */ $handler = $applicationContext->get(ServiceMessageHandler::clazz()); diff --git a/api/Core/json_error.php b/api/Core/json_error.php index 1ff438c0..c9ea1b61 100644 --- a/api/Core/json_error.php +++ b/api/Core/json_error.php @@ -7,7 +7,11 @@ function print_error($title, $message, $logId = null, $response_code = 500) { $error['type'] = 'ERROR'; $error['title'] = $title; $error['message'] = $message; - $error['logId'] = $logId; + + if ($logId !== null) { + $error['logId'] = $logId; + } + print output($error, $response_code); return; diff --git a/api/index.php b/api/index.php index d7fa3656..8502e108 100644 --- a/api/index.php +++ b/api/index.php @@ -105,7 +105,7 @@ function exceptionHandler($exception) { /* @var $castedException \BusinessLogic\Exceptions\ApiFriendlyException */ $castedException = $exception; - print_error($castedException->title, $castedException->getMessage(), $castedException->httpResponseCode); + print_error($castedException->title, $castedException->getMessage(), null, $castedException->httpResponseCode); } elseif (exceptionIsOfType($exception, \Core\Exceptions\SQLException::clazz())) { /* @var $castedException \Core\Exceptions\SQLException */ $castedException = $exception; From 39e61b85c46643aa1ae508e568513391701de1ee Mon Sep 17 00:00:00 2001 From: Mike Koch Date: Mon, 4 Dec 2017 12:56:09 -0500 Subject: [PATCH 21/21] Fixed some issues with the service messages endpoints: --- .../MissingAuthenticationTokenException.php | 4 +- api/BusinessLogic/Security/UserContext.php | 4 ++ .../GetServiceMessagesFilter.php | 12 ++++++ .../ServiceMessages/ServiceMessageHandler.php | 8 ++-- .../ServiceMessagesController.php | 38 +++++++++++++++---- .../ServiceMessagesGateway.php | 31 +++++++++++++-- api/index.php | 13 +++++-- 7 files changed, 90 insertions(+), 20 deletions(-) create mode 100644 api/BusinessLogic/ServiceMessages/GetServiceMessagesFilter.php diff --git a/api/BusinessLogic/Exceptions/MissingAuthenticationTokenException.php b/api/BusinessLogic/Exceptions/MissingAuthenticationTokenException.php index 596839ff..267a82c0 100644 --- a/api/BusinessLogic/Exceptions/MissingAuthenticationTokenException.php +++ b/api/BusinessLogic/Exceptions/MissingAuthenticationTokenException.php @@ -4,8 +4,8 @@ namespace BusinessLogic\Exceptions; class MissingAuthenticationTokenException extends ApiFriendlyException { function __construct() { - parent::__construct("An 'X-Auth-Token' is required for all requests", + parent::__construct("An 'X-Auth-Token' is required for this request", 'Security Exception', - 400); + 401); } } \ No newline at end of file diff --git a/api/BusinessLogic/Security/UserContext.php b/api/BusinessLogic/Security/UserContext.php index 3055b4ff..6ce0fba0 100644 --- a/api/BusinessLogic/Security/UserContext.php +++ b/api/BusinessLogic/Security/UserContext.php @@ -57,6 +57,10 @@ class UserContext extends \BaseClass { /* @var $active bool */ public $active; + function isAnonymousUser() { + return $this->id === -1; + } + static function buildAnonymousUser() { $userContext = new UserContext(); $userContext->id = -1; diff --git a/api/BusinessLogic/ServiceMessages/GetServiceMessagesFilter.php b/api/BusinessLogic/ServiceMessages/GetServiceMessagesFilter.php new file mode 100644 index 00000000..a8f381d6 --- /dev/null +++ b/api/BusinessLogic/ServiceMessages/GetServiceMessagesFilter.php @@ -0,0 +1,12 @@ +serviceMessageGateway->createServiceMessage($serviceMessage, $heskSettings); } - function getServiceMessages($heskSettings) { - return $this->serviceMessageGateway->getServiceMessages($heskSettings); + function getServiceMessages($heskSettings, $searchFilter) { + return $this->serviceMessageGateway->getServiceMessages($heskSettings, $searchFilter); } function editServiceMessage($serviceMessage, $heskSettings) { @@ -78,7 +78,7 @@ class ServiceMessageHandler extends \BaseClass { } function sortServiceMessage($id, $direction, $heskSettings) { - $serviceMessages = $this->serviceMessageGateway->getServiceMessages($heskSettings); + $serviceMessages = $this->serviceMessageGateway->getServiceMessages($heskSettings, new GetServiceMessagesFilter()); $serviceMessage = null; foreach ($serviceMessages as $innerServiceMessage) { if (intval($innerServiceMessage->id) === intval($id)) { @@ -129,7 +129,7 @@ class ServiceMessageHandler extends \BaseClass { break; } } - if (!$languageFound) { + if (!$languageFound && !in_array('MISSING_LANGUAGE', $validationModel->errorKeys)) { $validationModel->errorKeys[] = 'LANGUAGE_NOT_INSTALLED'; } diff --git a/api/Controllers/ServiceMessages/ServiceMessagesController.php b/api/Controllers/ServiceMessages/ServiceMessagesController.php index b147f123..48da1a7d 100644 --- a/api/Controllers/ServiceMessages/ServiceMessagesController.php +++ b/api/Controllers/ServiceMessages/ServiceMessagesController.php @@ -6,6 +6,7 @@ use BusinessLogic\Exceptions\ApiFriendlyException; use BusinessLogic\Helpers; use BusinessLogic\Security\UserContext; use BusinessLogic\Security\UserPrivilege; +use BusinessLogic\ServiceMessages\GetServiceMessagesFilter; use BusinessLogic\ServiceMessages\ServiceMessage; use BusinessLogic\ServiceMessages\ServiceMessageHandler; use Controllers\ControllerWithSecurity; @@ -17,25 +18,41 @@ class ServiceMessagesController extends \BaseClass { * @throws ApiFriendlyException */ function checkSecurity($userContext) { - if (!in_array(UserPrivilege::CAN_MANAGE_SERVICE_MESSAGES, $userContext->permissions)) { + if (!$userContext->admin && !in_array(UserPrivilege::CAN_MANAGE_SERVICE_MESSAGES, $userContext->permissions)) { + throw new ApiFriendlyException("User does not have permission to access the following URI: " . $_SERVER['REQUEST_URI'], "Access Forbidden", 403); + } + } + + static function staticCheckSecurity($userContext) { + if (!$userContext->admin && !in_array(UserPrivilege::CAN_MANAGE_SERVICE_MESSAGES, $userContext->permissions)) { throw new ApiFriendlyException("User does not have permission to access the following URI: " . $_SERVER['REQUEST_URI'], "Access Forbidden", 403); } } function get() { + /* @var $userContext UserContext */ + /* @var $hesk_settings array */ global $applicationContext, $hesk_settings, $userContext; - $this->checkSecurity($userContext); + $searchFilter = new GetServiceMessagesFilter(); + if ($userContext->isAnonymousUser()) { + $searchFilter->includeDrafts = false; + $searchFilter->includeStaffServiceMessages = false; + } elseif (!$userContext->admin && !in_array(UserPrivilege::CAN_MANAGE_SERVICE_MESSAGES, $userContext->permissions)) { + $searchFilter->includeDrafts = false; + } /* @var $handler ServiceMessageHandler */ $handler = $applicationContext->get(ServiceMessageHandler::clazz()); - return output($handler->getServiceMessages($hesk_settings)); + return output($handler->getServiceMessages($hesk_settings, $searchFilter)); } function post() { global $applicationContext, $userContext, $hesk_settings; + $this->checkSecurity($userContext); + /* @var $handler ServiceMessageHandler */ $handler = $applicationContext->get(ServiceMessageHandler::clazz()); @@ -46,7 +63,9 @@ class ServiceMessagesController extends \BaseClass { } function put($id) { - global $applicationContext, $hesk_settings; + global $applicationContext, $hesk_settings, $userContext; + + $this->checkSecurity($userContext); /* @var $handler ServiceMessageHandler */ $handler = $applicationContext->get(ServiceMessageHandler::clazz()); @@ -60,7 +79,9 @@ class ServiceMessagesController extends \BaseClass { } function delete($id) { - global $applicationContext, $hesk_settings; + global $applicationContext, $hesk_settings, $userContext; + + $this->checkSecurity($userContext); /* @var $handler ServiceMessageHandler */ $handler = $applicationContext->get(ServiceMessageHandler::clazz()); @@ -79,7 +100,7 @@ class ServiceMessagesController extends \BaseClass { $serviceMessage = new ServiceMessage(); if (!$creating) { - $serviceMessage->order = $data['order']; + $serviceMessage->order = Helpers::safeArrayGet($data, 'order'); } if ($creating) { @@ -105,7 +126,10 @@ class ServiceMessagesController extends \BaseClass { } static function sort($id, $direction) { - global $applicationContext, $hesk_settings; + /* @var $userContext UserContext */ + global $applicationContext, $hesk_settings, $userContext; + + self::staticCheckSecurity($userContext); /* @var $handler ServiceMessageHandler */ $handler = $applicationContext->get(ServiceMessageHandler::clazz()); diff --git a/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php b/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php index d9d8985a..e15a593e 100644 --- a/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php +++ b/api/DataAccess/ServiceMessages/ServiceMessagesGateway.php @@ -3,7 +3,9 @@ namespace DataAccess\ServiceMessages; +use BusinessLogic\ServiceMessages\GetServiceMessagesFilter; use BusinessLogic\ServiceMessages\ServiceMessage; +use BusinessLogic\ServiceMessages\ServiceMessageLocation; use BusinessLogic\ServiceMessages\ServiceMessageStyle; use DataAccess\CommonDao; @@ -56,14 +58,29 @@ class ServiceMessagesGateway extends CommonDao { /** * @param $heskSettings + * @param $searchFilter GetServiceMessagesFilter * @return ServiceMessage[] */ - function getServiceMessages($heskSettings) { + function getServiceMessages($heskSettings, $searchFilter) { $this->init(); $serviceMessages = array(); - $rs = hesk_dbQuery("SELECT * FROM `". hesk_dbEscape($heskSettings['db_pfix']) . "service_messages` ORDER BY `order`"); + $sql = "SELECT DISTINCT `service_messages`.* FROM `". hesk_dbEscape($heskSettings['db_pfix']) . "service_messages` AS `service_messages` "; + + if (!$searchFilter->includeStaffServiceMessages) { + $sql .= "INNER JOIN `" . hesk_dbEscape($heskSettings['db_pfix']) . "mfh_service_message_to_location` AS `location` + ON `location`.`service_message_id` = `service_messages`.`id` AND `location`.`location` LIKE 'CUSTOMER%' "; + } + + if (!$searchFilter->includeDrafts) { + $sql .= "WHERE `type` = '0' "; + } + + $sql .= "ORDER BY `order`"; + + + $rs = hesk_dbQuery($sql); while ($row = hesk_dbFetchAssoc($rs)) { $serviceMessage = new ServiceMessage(); $serviceMessage->id = $row['id']; @@ -78,8 +95,14 @@ class ServiceMessagesGateway extends CommonDao { $serviceMessage->language = $row['mfh_language']; $serviceMessage->locations = array(); - $locationsRs = hesk_dbQuery("SELECT `location` FROM `" . hesk_dbEscape($heskSettings['db_pfix']) . "mfh_service_message_to_location` - WHERE `service_message_id` = " . intval($serviceMessage->id)); + $locationSql = "SELECT `location` FROM `" . hesk_dbEscape($heskSettings['db_pfix']) . "mfh_service_message_to_location` + WHERE `service_message_id` = " . intval($serviceMessage->id); + + if (!$searchFilter->includeStaffServiceMessages) { + $locationSql .= " AND `location` LIKE 'CUSTOMER%'"; + } + + $locationsRs = hesk_dbQuery($locationSql); while ($innerRow = hesk_dbFetchAssoc($locationsRs)) { $serviceMessage->locations[] = $innerRow['location']; } diff --git a/api/index.php b/api/index.php index 8502e108..3a67c362 100644 --- a/api/index.php +++ b/api/index.php @@ -45,8 +45,15 @@ function internalOrAuthHandler() { function publicHandler() { global $userContext; - //-- Create an "anonymous" UserContext - $userContext = \BusinessLogic\Security\UserContext::buildAnonymousUser(); + // Check if we passed in a X-Auth-Token or X-Internal-Call header. Those take priority + if (\BusinessLogic\Helpers::getHeader('X-INTERNAL-CALL') === 'true') { + internalHandler(); + } elseif (\BusinessLogic\Helpers::getHeader('X-AUTH-TOKEN') !== null) { + authTokenHandler(); + } else { + //-- Create an "anonymous" UserContext + $userContext = \BusinessLogic\Security\UserContext::buildAnonymousUser(); + } } function assertApiIsEnabled() { @@ -205,7 +212,7 @@ Link::all(array( // Service Messages '/v1/service-messages' => action(\Controllers\ServiceMessages\ServiceMessagesController::clazz(), array(RequestMethod::GET, RequestMethod::POST), - SecurityHandler::INTERNAL_OR_AUTH_TOKEN), + SecurityHandler::OPEN), '/v1/service-messages/{i}' => action(\Controllers\ServiceMessages\ServiceMessagesController::clazz(), array(RequestMethod::PUT, RequestMethod::DELETE), SecurityHandler::INTERNAL_OR_AUTH_TOKEN),