From 80a5d0b0b926753f0a9f9344a7baa6c250736105 Mon Sep 17 00:00:00 2001
From: Fermin <fermin.hernandez@artica.es>
Date: Fri, 8 Feb 2019 10:32:04 +0100
Subject: [PATCH] Removed unused code and format some files

Former-commit-id: 5f8da31efc5241dd16002565fdb89d774072b7b3
---
 .../godmode/setup/setup_notifications.php     | 66 +++++++--------
 .../include/functions_notifications.php       | 80 ++++++++++---------
 2 files changed, 74 insertions(+), 72 deletions(-)

diff --git a/pandora_console/godmode/setup/setup_notifications.php b/pandora_console/godmode/setup/setup_notifications.php
index 956571aa1f..d6ce67ab90 100644
--- a/pandora_console/godmode/setup/setup_notifications.php
+++ b/pandora_console/godmode/setup/setup_notifications.php
@@ -1,18 +1,31 @@
 <?php
+/**
+ * Library. Notification system auxiliary functions.
+ *
+ * @category   UI file
+ * @package    Pandora FMS
+ * @subpackage Community
+ * @version    1.0.0
+ * @license    See below
+ *
+ *    ______                 ___                    _______ _______ ________
+ *   |   __ \.-----.--.--.--|  |.-----.----.-----. |    ___|   |   |     __|
+ *  |    __/|  _  |     |  _  ||  _  |   _|  _  | |    ___|       |__     |
+ * |___|   |___._|__|__|_____||_____|__| |___._| |___|   |__|_|__|_______|
+ *
+ * ============================================================================
+ * Copyright (c) 2005-2019 Artica Soluciones Tecnologicas
+ * Please see http://pandorafms.org for full contribution list
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation for version 2.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * ============================================================================
+ */
 
-// Pandora FMS - http://pandorafms.com
-// ==================================================
-// Copyright (c) 2005-2019 Artica Soluciones Tecnologicas
-// Please see http://pandorafms.org for full contribution list
-// This program is free software; you can redistribute it and/or
-// modify it under the terms of the GNU General Public License
-// as published by the Free Software Foundation for version 2.
-// This program is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
-// Warning: This file may be required into the metaconsole's setup
-// Load global vars
 global $config;
 
 require_once $config['homedir'].'/include/functions_notifications.php';
@@ -31,7 +44,7 @@ $users = get_parameter('users', '');
 $elements = get_parameter('elements', []);
 $is_users = $users === 'users';
 if (get_parameter('get_selection_two_ways_form', 0)) {
-    $info_selec = $is_users ? notifications_get_user_source_not_configured($source) : notifications_get_group_source_not_configured($source);
+    $info_selec = ($is_users) ? notifications_get_user_source_not_configured($source) : notifications_get_group_source_not_configured($source);
 
     echo notifications_print_two_ways_select(
         $info_selec,
@@ -42,14 +55,14 @@ if (get_parameter('get_selection_two_ways_form', 0)) {
 }
 
 if (get_parameter('add_source_to_database', 0)) {
-    $res = $is_users ? notifications_add_users_to_source($source, $elements) : notifications_add_group_to_source($source, $elements);
+    $res = ($is_users) ? notifications_add_users_to_source($source, $elements) : notifications_add_group_to_source($source, $elements);
     $result = ['result' => $res];
     echo json_encode($result);
     return;
 }
 
 if (get_parameter('remove_source_on_database', 0)) {
-    $res = $is_users ? notifications_remove_users_from_source($source, $elements) : notifications_remove_group_from_source($source, $elements);
+    $res = ($is_users) ? notifications_remove_users_from_source($source, $elements) : notifications_remove_group_from_source($source, $elements);
     $result = ['result' => $res];
     echo json_encode($result);
     return;
@@ -65,7 +78,7 @@ if (get_parameter('update_config', 0)) {
     switch ($element) {
         // All users has other action.
         case 'all_users':
-            $res = $value ? notifications_add_group_to_source($source, [0]) : notifications_remove_group_from_source($source, [0]);
+            $res = ($value) ? notifications_add_group_to_source($source, [0]) : notifications_remove_group_from_source($source, [0]);
         break;
 
         default:
@@ -89,7 +102,7 @@ $table_content->id = 'notifications-wrapper';
 $table_content->class = 'databox filters';
 $table_content->size['name'] = '30%';
 
-// Print each source configuration
+// Print each source configuration.
 $table_content->data = array_map(
     function ($source) {
         return notifications_print_global_source_configuration($source);
@@ -101,13 +114,6 @@ html_print_table($table_content);
 
 ?>
 <script>
-// Get the source id
-function notifications_get_source_id(id) {
-    var matched = id.match(/.*-(.*)/);
-    if (matched == null) return '';
-    return matched[1];
-}
-
 // Get index of two ways element dialog.
 function notifications_two_ways_element_get_dialog (id, source_id) {
     return 'global_config_notifications_dialog_add-' + id + '-' + source_id;
@@ -118,16 +124,6 @@ function notifications_two_ways_element_get_sufix (id, source_id) {
     return 'multi-' + id + '-' + source_id;
 }
 
-// Disable or enable the select seeing the checked value of notify all users
-function notifications_disable_source(event) {
-    var id = notifications_get_source_id(event.target.id);
-    var is_checked = document.getElementById(event.target.id).checked;
-    var selectors = ['groups', 'users'];
-    selectors.map(function (select) {
-        document.getElementById(notifications_two_ways_element_get_sufix(select, id)).disabled = is_checked;
-    });
-}
-
 // Open a dialog with selector of source elements.
 function add_source_dialog(users, source_id) {
     // Display the dialog
diff --git a/pandora_console/include/functions_notifications.php b/pandora_console/include/functions_notifications.php
index 768bd67b97..85f34cc2c7 100644
--- a/pandora_console/include/functions_notifications.php
+++ b/pandora_console/include/functions_notifications.php
@@ -1,5 +1,4 @@
 <?php
-
 /**
  * Library. Notification system auxiliary functions.
  *
@@ -44,9 +43,12 @@ function get_notification_source_id(string $source)
     }
 
     return db_get_value_sql(
-        "SELECT id
-            FROM `tnotification_source`
-            WHERE `description` LIKE '{$source}%'"
+        sprintf(
+            'SELECT id
+                FROM `tnotification_source`
+                WHERE lower(`description`) = lower("%s")',
+            $source
+        )
     );
 }
 
@@ -238,7 +240,7 @@ function notifications_get_group_sources($filter=[], $fields=[])
     $fields = array_map(
         function ($field) {
             if (!preg_match('/^tnsg./', $field)) {
-                $field = "tnsg.{$field}";
+                $field = 'tnsg.'.$field;
             }
 
             return $field;
@@ -254,7 +256,7 @@ function notifications_get_group_sources($filter=[], $fields=[])
         array_merge($fields, ['IFNULL(tg.nombre, "All") AS name'])
     );
 
-    // If fails or no one is selected, return empty array
+    // If fails or no one is selected, return empty array.
     if ($groups === false) {
         return [];
     }
@@ -273,12 +275,12 @@ function notifications_get_group_sources($filter=[], $fields=[])
  */
 function notifications_remove_group_from_source($source_id, $groups)
 {
-    // Source id is mandatory
+    // Source id is mandatory.
     if (!isset($source_id)) {
         return false;
     }
 
-    // Delete from database
+    // Delete from database.
     return db_process_sql_delete(
         'tnotification_source_group',
         [
@@ -299,12 +301,12 @@ function notifications_remove_group_from_source($source_id, $groups)
  */
 function notifications_remove_users_from_source($source_id, $users)
 {
-    // Source id is mandatory
+    // Source id is mandatory.
     if (!isset($source_id)) {
         return false;
     }
 
-    // Delete from database
+    // Delete from database.
     return db_process_sql_delete(
         'tnotification_source_user',
         [
@@ -360,12 +362,12 @@ function notifications_add_group_to_source($source_id, $groups)
  */
 function notifications_add_users_to_source($source_id, $users)
 {
-    // Source id is mandatory
+    // Source id is mandatory.
     if (!isset($source_id)) {
         return false;
     }
 
-    // Insert into database all groups passed
+    // Insert into database all groups passed.
     $res = true;
     $also_mail = db_get_value(
         'also_mail',
@@ -529,10 +531,14 @@ function notifications_set_user_label_status($source, $user, $label, $value)
 function notifications_print_ball()
 {
     $num_notifications = messages_get_count();
-    $class_status = $num_notifications == 0 ? 'notification-ball-no-messages' : 'notification-ball-new-messages';
-    return "<div class='notification-ball $class_status' id='notification-ball-header'>
-            $num_notifications
-        </div>";
+    $class_status = ($num_notifications == 0) ? 'notification-ball-no-messages' : 'notification-ball-new-messages';
+    return sprintf(
+        '<div class="notification-ball %s" id="notification-ball-header">
+            %s
+        </div>',
+        $class_status,
+        $num_notifications
+    );
 }
 
 
@@ -553,25 +559,25 @@ function notifications_print_global_source_configuration($source)
         'class' => 'elem-clickable',
     ];
 
-    // Search if group all is set and handle that situation
+    // Search if group all is set and handle that situation.
     $source_groups = notifications_get_group_sources_for_select($source['id']);
     $is_group_all = isset($source_groups['0']);
     if ($is_group_all) {
         unset($source_groups['0']);
     }
 
-    // Generate the title
+    // Generate the title.
     $html_title = "<div class='global-config-notification-title'>";
     $html_title .= html_print_switch($switch_values);
-    $html_title .= "<h2>{$source['description']}</h2>";
+    $html_title .= '<h2>'.$source['description'].'</h2>';
     $html_title .= '</div>';
 
-    // Generate the html for title
+    // Generate the html for title.
     $html_selectors = "<div class='global-config-notification-selectors'>";
     $html_selectors .= notifications_print_source_select_box(notifications_get_user_sources_for_select($source['id']), 'users', $source['id'], $is_group_all);
     $html_selectors .= notifications_print_source_select_box($source_groups, 'groups', $source['id'], $is_group_all);
     $html_selectors .= '</div>';
-    // Generate the checkboxes and time select
+    // Generate the checkboxes and time select.
     $html_checkboxes = "<div class='global-config-notification-checkboxes'>";
     $html_checkboxes .= '   <span>';
     $html_checkboxes .= html_print_checkbox_extended('all-'.$source['id'], 1, $is_group_all, false, '', 'class= "elem-clickable"', true, 'id="nt-'.$source['id'].'-all_users"');
@@ -585,7 +591,7 @@ function notifications_print_global_source_configuration($source)
     $html_checkboxes .= '   </span>';
     $html_checkboxes .= '</div>';
 
-    // Generate the select with the time
+    // Generate the select with the time.
     $html_select_pospone = __('Users can postpone notifications up to');
     $html_select_pospone .= html_print_select(
         [
@@ -609,7 +615,7 @@ function notifications_print_global_source_configuration($source)
         'elem-changeable'
     );
 
-    // Return all html
+    // Return all html.
     return $html_title.$html_selectors.$html_checkboxes.$html_select_pospone;
 }
 
@@ -630,20 +636,20 @@ function notifications_print_source_select_box(
     $source_id,
     $disabled
 ) {
-    $title = $id == 'users' ? __('Notified users') : __('Notified groups');
-    $add_title = $id == 'users' ? __('Add users') : __('Add groups');
-    $delete_title = $id == 'users' ? __('Delete users') : __('Delete groups');
+    $title = ($id === 'users') ? __('Notified users') : __('Notified groups');
+    $add_title = ($id === 'users') ? __('Add users') : __('Add groups');
+    $delete_title = ($id === 'users') ? __('Delete users') : __('Delete groups');
 
-    // Generate the HTML
+    // Generate the HTML.
     $html_select = "<div class='global-config-notification-single-selector'>";
     $html_select .= '   <div>';
-    $html_select .= "       <h4>$title</h4>";
-    // Put a true if empty sources to avoid to sow the 'None' value
-    $html_select .= html_print_select(empty($info_selec) ? true : $info_selec, "multi-{$id}-{$source_id}[]", 0, false, '', '', true, true, true, '', $disabled);
+    $html_select .= '       <h4>'.$title.'</h4>';
+    // Put a true if empty sources to avoid to sow the 'None' value.
+    $html_select .= html_print_select(empty($info_selec) ? true : $info_selec, 'multi-'.$id.'-'.$source_id.'[]', 0, false, '', '', true, true, true, '', $disabled);
     $html_select .= '   </div>';
     $html_select .= "   <div class='global-notifications-icons'>";
-    $html_select .= html_print_image('images/input_add.png', true, ['title' => $add_title, 'onclick' => "add_source_dialog('$id', '$source_id')"]);
-    $html_select .= html_print_image('images/input_delete.png', true, ['title' => $delete_title, 'onclick' => "remove_source_elements('$id', '$source_id')"]);
+    $html_select .= html_print_image('images/input_add.png', true, ['title' => $add_title, 'onclick' => 'add_source_dialog("'.$id.', "'.$source_id.'")"']);
+    $html_select .= html_print_image('images/input_delete.png', true, ['title' => $delete_title, 'onclick' => 'remove_source_elements("'.$id.'", "'.$source_id.'")"']);
     $html_select .= '   </div>';
     $html_select .= '</div>';
     return $html_select;
@@ -663,14 +669,14 @@ function notifications_print_source_select_box(
 function notifications_print_two_ways_select($info_selec, $users, $source_id)
 {
     $html_select = "<div class='global_config_notifications_dialog_add'>";
-    $html_select .= html_print_select(empty($info_selec) ? true : $info_selec, "all-multi-{$users}-{$source_id}[]", 0, false, '', '', true, true, true, '');
+    $html_select .= html_print_select(empty($info_selec) ? true : $info_selec, 'all-multi-'.$users.'-'.$source_id.'[]', 0, false, '', '', true, true, true, '');
     $html_select .= "<div class='global_config_notifications_two_ways_form_arrows'>";
-    $html_select .= html_print_image('images/darrowright.png', true, ['title' => $add_title, 'onclick' => "notifications_modify_two_ways_element('$users', '$source_id', 'add')"]);
-    $html_select .= html_print_image('images/darrowleft.png', true, ['title' => $add_title, 'onclick' => "notifications_modify_two_ways_element('$users', '$source_id', 'remove')"]);
+    $html_select .= html_print_image('images/darrowright.png', true, ['title' => $add_title, 'onclick' => 'notifications_modify_two_ways_element("'.$users.'", "'.$source_id.'", "add")']);
+    $html_select .= html_print_image('images/darrowleft.png', true, ['title' => $add_title, 'onclick' => 'notifications_modify_two_ways_element("'.$users.'", "'.$source_id.'", "remove")']);
     $html_select .= '</div>';
-    $html_select .= html_print_select(true, "selected-multi-{$users}-{$source_id}[]", 0, false, '', '', true, true, true, '');
+    $html_select .= html_print_select(true, 'selected-multi-'.$users.'-'.$source_id.'[]', 0, false, '', '', true, true, true, '');
     $html_select .= '</div>';
-    $html_select .= html_print_button(__('Add'), 'Add', false, "notifications_add_source_element_to_database('$users', '$source_id')", "class='sub add'", true);
+    $html_select .= html_print_button(__('Add'), 'Add', false, 'notifications_add_source_element_to_database("'.$users.'", "'.$source_id.'")', "class='sub add'", true);
 
     return $html_select;
 }