notify_queue.php

<?php
/*
 +-------------------------------------------------------------------------+
 | Copyright (C) 2004-2026 The Cacti Group                                 |
 |                                                                         |
 | 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; either version 2          |
 | of the License, or (at your option) any later version.                  |
 |                                                                         |
 | 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.                            |
 +-------------------------------------------------------------------------+
 | Cacti: The Complete RRDtool-based Graphing Solution                     |
 +-------------------------------------------------------------------------+
 | This code is designed, written, and maintained by the Cacti Group. See  |
 | about.php and/or the AUTHORS file for specific developer information.   |
 +-------------------------------------------------------------------------+
 | http://www.cacti.net/                                                   |
 +-------------------------------------------------------------------------+
*/

chdir('../../');
include_once('./include/auth.php');

require_once($config['base_path'] . '/lib/rrd.php');
include_once($config['base_path'] . '/plugins/thold/includes/functions.php');
include_once($config['base_path'] . '/plugins/thold/setup.php');
include_once($config['base_path'] . '/plugins/thold/includes/database.php');
include($config['base_path'] . '/plugins/thold/includes/arrays.php');

$actions = [
	1 => __('Delete', 'thold')
];

// set default action
set_default_action();

switch (get_request_var('action')) {
	case 'actions':
		form_actions();

		break;
	case 'suspend':
		$user_id = $_SESSION['sess_user_id'];
		$user    = get_username($_SESSION['sess_user_id']);

		set_config_option('thold_notification_suspended', 1);
		set_config_option('thold_notification_suspended_by', $user);
		set_config_option('thold_notification_suspended_time', time());

		raise_message('notify_suspend', __('Notification has been Suspended.  Press the Resume button to resume it', 'thold'), MESSAGE_LEVEL_INFO);
		debounce_run_notification('notify_suspend_by_' . $user_id, sprintf('WARNING: User %s [%d] has Suspended THOLD notifications!', $user, $user_id), 300);

		header('Location: notify_queue.php');
		exit();

		break;
	case 'resume':
		$user = get_username($_SESSION['sess_user_id']);

		set_config_option('thold_notification_suspended', 0);
		set_config_option('thold_notification_resumed_by', $user);
		set_config_option('thold_notification_resumed_time', time());

		raise_message('notify_suspend', __('Notification has been Resumed.  Press the Suspend button to suspend it', 'thold'), MESSAGE_LEVEL_INFO);
		cacti_log(sprintf('WARNING: User %s [%d] has Resumed THOLD notifications!', $user, $_SESSION['sess_user_id']), false, 'THOLD');

		header('Location: notify_queue.php');
		exit();

		break;
	case 'purge':
		$user = get_username($_SESSION['sess_user_id']);

		set_config_option('thold_notification_purged_by', $user);
		set_config_option('thold_notification_purged_time', time());

		db_execute('DELETE FROM notification_queue WHERE event_processed = 0');

		raise_message('notify_purge', __('Pending Notifications have been removed from the database.  Previously sent notification not purged will remain until they age out.', 'thold'), MESSAGE_LEVEL_INFO);
		cacti_log(sprintf('WARNING: User %s [%d] has Purged THOLD notifications!', $user, $_SESSION['sess_user_id']), false, 'THOLD');

		header('Location: notify_queue.php');
		exit();

		break;
	default:
		top_header();

		notify_queue();

		bottom_footer();

		break;
}

/**
 * Handles the bulk-action confirmation page/submission for the
 * notification queue list (delete): on confirmed submission with
 * selected_items set, deletes the selected notification_queue rows; on
 * first display, renders a confirmation box listing the selected
 * notifications. Called from this script's main request-dispatch
 * switch when action=actions.
 *
 * @return void
 *
 * @global array $actions Map of drp_action value => action label, used
 *                       for the bulk-actions confirmation display.
 */
function form_actions() {
	global $actions;

	// ================= input validation =================
	get_filter_request_var('drp_action', FILTER_VALIDATE_REGEXP, ['options' => ['regexp' => '/^([a-zA-Z0-9_]+)$/']]);
	// ====================================================

	// if we are to save this form, instead of display it
	if (isset_request_var('selected_items')) {
		$selected_items = sanitize_unserialize_selected_items(get_nfilter_request_var('selected_items'));

		if ($selected_items != false) {
			if (get_nfilter_request_var('drp_action') == '1') { // delete
				$placeholders = implode(', ', array_fill(0, cacti_sizeof($selected_items), '?'));
				$params       = array_map('intval', array_values($selected_items));

				db_execute_prepared(
					"DELETE FROM notification_queue WHERE id IN ($placeholders)",
					$params
				);
			}
		}

		header('Location: notify_queue.php?header=false');
		exit;
	}

	// setup some variables
	$notify_list = '';
	$i           = 0;

	// loop through each of the graphs selected on the previous page and get more info about them
	foreach ($_POST as $var => $val) {
		if (preg_match('/^chk_([0-9]+)$/', $var, $matches)) {
			// ================= input validation =================
			input_validate_input_number($matches[1]);
			// ====================================================

			$notify_list .= '<li>' . html_escape(db_fetch_cell_prepared('SELECT CONCAT(UPPER(topic), ": ", object_name) AS name FROM notification_queue WHERE id = ?', [$matches[1]])) . '</li>';
			$notify_array[$i] = $matches[1];

			$i++;
		}
	}

	top_header();

	form_start('notify_queue.php');

	html_start_box($actions[get_nfilter_request_var('drp_action')], '60%', '', '3', 'center', '');

	if (isset($notify_array) && cacti_sizeof($notify_array)) {
		if (get_nfilter_request_var('drp_action') == '1') { // delete
			print "<tr>
				<td class='textArea'>
					<p>" . __n('Click \'Continue\' to delete the following Notification.', 'Click \'Continue\' to delete all following Notifications.', cacti_sizeof($notify_array)) . "</p>
					<div class='itemlist'><ul>$notify_list</ul></div>
				</td>
			</tr>";

			$save_html = "<input type='button' class='ui-button ui-corner-all ui-widget cactiReturnTo' value='" . __esc('Cancel') . "'>&nbsp;<input type='submit' class='ui-button ui-corner-all ui-widget' value='" . __esc('Continue') . "' title='" . __n('Delete Notification', 'Delete Notifications', cacti_sizeof($notify_array)) . "'>";
		}
	} else {
		raise_message(40);
		header('Location: notify_queue.php?header=false');
		exit;
	}

	print "<tr>
		<td class='saveRow'>
			<input type='hidden' name='action' value='actions'>
			<input type='hidden' name='selected_items' value='" . (isset($notify_array) ? serialize($notify_array) : '') . "'>
			<input type='hidden' name='drp_action' value='" . html_escape(get_nfilter_request_var('drp_action')) . "'>
			$save_html
		</td>
	</tr>";

	html_end_box();

	form_end();

	bottom_footer();
}

/**
 * Renders the main notification queue list page: validates/stores this
 * view's filter request variables, displays the filter form, then
 * displays a filtered, sorted, paginated table of pending/sent
 * notifications with a bulk-actions dropdown. Called from this
 * script's main request-dispatch switch as the default view.
 *
 * @return void
 *
 * @global array $actions                    Map of drp_action value =>
 *                                           action label, used for the
 *                                           bulk-actions dropdown.
 * @global array $item_rows                  Default number of rows per
 *                                           page from Cacti settings.
 * @global array $thold_notification_topics  Notification topic option
 *                                           list used by the filter
 *                                           form.
 */
function notify_queue() {
	global $actions, $item_rows, $thold_notification_topics;

	// ================= input validation and session storage =================
	$filters = [
		'rows' => [
			'filter'  => FILTER_VALIDATE_INT,
			'pageset' => true,
			'default' => '-1'
		],
		'processed' => [
			'filter'  => FILTER_VALIDATE_INT,
			'pageset' => true,
			'default' => '-1'
		],
		'page' => [
			'filter'  => FILTER_VALIDATE_INT,
			'default' => '1'
		],
		'filter' => [
			'filter'  => FILTER_DEFAULT,
			'pageset' => true,
			'default' => ''
		],
		'topic' => [
			'filter'  => FILTER_CALLBACK,
			'pageset' => true,
			'default' => '-1',
			'options' => ['options' => 'sanitize_search_string']
		],
		'sort_column' => [
			'filter'  => FILTER_CALLBACK,
			'default' => 'object_name',
			'options' => ['options' => 'sanitize_search_string']
		],
		'sort_direction' => [
			'filter'  => FILTER_CALLBACK,
			'default' => 'ASC',
			'options' => ['options' => 'sanitize_search_string']
		]
	];

	validate_store_request_vars($filters, 'sess_notify_queue');
	// ================= input validation =================

	if (get_request_var('rows') == '-1') {
		$rows = read_config_option('num_rows_table');
	} else {
		$rows = get_request_var('rows');
	}

	$state = read_config_option('thold_notification_suspended', true);
	$suser = read_config_option('thold_notification_suspended_by', true);
	$sdate = read_config_option('thold_notification_suspended_time', true);

	if ($state == 1) {
		$ctime = time();

		if ($sdate > 0) {
			$ago = get_daysfromtime(time() - $sdate, true, ' ', DAYS_FORMAT_LONG);
		}

		html_start_box(__('Event Notifications [ Notifications Suspended by User: %s, %s ago ]', $suser, $ago, 'thold'), '100%', '', '3', 'center', '');
	} else {
		html_start_box(__('Event Notifications', 'thold'), '100%', '', '3', 'center', '');
	}

	?>
	<tr class='even'>
		<td>
			<form id='form_notify' action='notify_queue.php'>
			<table class='filterTable'>
				<tr>
					<td>
						<?php print __('Search', 'thold'); ?>
					</td>
					<td>
						<input type='text' class='ui-state-default ui-corner-all' id='filter' size='25' value='<?php print html_escape_request_var('filter'); ?>'>
					</td>
					<td>
						<?php print __('Topic', 'thold'); ?>
					</td>
					<td>
						<select id='topic'>
							<option value='-1'<?php print (get_request_var('topic') == '-1' ? ' selected>' : '>') . __('All', 'thold'); ?></option>
							<?php
							if (cacti_sizeof($thold_notification_topics)) {
								foreach ($thold_notification_topics as $key => $value) {
									print "<option value='" . $key . "'";

									if (get_request_var('topic') == $key) {
										print ' selected';
									} print '>' . html_escape($value) . '</option>';
								}
							}
	?>
						</select>
					</td>
					<td>
						<?php print __('Processed', 'thold'); ?>
					</td>
					<td>
						<select id='processed'>
							<option value='-1'<?php print (get_request_var('processed') == '-1' ? ' selected>' : '>') . __('All', 'thold'); ?></option>
							<option value='0'<?php print (get_request_var('processed') == '0' ? ' selected>' : '>') . __('No', 'thold'); ?></option>
							<option value='1'<?php print (get_request_var('processed') == '1' ? ' selected>' : '>') . __('Yes', 'thold'); ?></option>
						</select>
					</td>
					<td>
						<?php print __('Rows', 'thold'); ?>
					</td>
					<td>
						<select id='rows'>
							<option value='-1'<?php print (get_request_var('rows') == '-1' ? ' selected>' : '>') . __('Default', 'thold'); ?></option>
							<?php
	if (cacti_sizeof($item_rows) > 0) {
		foreach ($item_rows as $key => $value) {
			print "<option value='" . $key . "'";

			if (get_request_var('rows') == $key) {
				print ' selected';
			} print '>' . html_escape($value) . '</option>';
		}
	}
	?>
						</select>
					</td>
					<td>
						<span>
							<input type='button' class='ui-button ui-corner-all ui-widget' id='refresh' value='<?php print __esc('Go'); ?>' title='<?php print __esc('Set/Refresh Filters'); ?>'>
							<input type='button' class='ui-button ui-corner-all ui-widget' id='clear' value='<?php print __esc('Clear'); ?>' title='<?php print __esc('Clear Filters'); ?>'>
							<?php if ($state == 0) {?><input type='button' class='ui-button ui-corner-all ui-widget' id='suspend' value='<?php print __esc('Suspend'); ?>' title='<?php print __esc('Suspend Notification Processing'); ?>'><?php } else {?>
							<input type='button' class='ui-button ui-corner-all ui-widget' id='resume' value='<?php print __esc('Resume'); ?>' title='<?php print __esc('Resume Notification Processing'); ?>'><?php }?>
							<input type='button' class='ui-button ui-corner-all ui-widget' id='purge' value='<?php print __esc('Purge'); ?>' title='<?php print __esc('Purge Notification Queue'); ?>'>
						</span>
					</td>
				</tr>
			</table>
			</form>
			<script type='text/javascript' <?php print plugin_thold_csp_nonce(); ?>>

			function applyFilter() {
				strURL  = 'notify_queue.php?header=false';
				strURL += '&filter='+encodeURIComponent($('#filter').val());
				strURL += '&rows='+encodeURIComponent($('#rows').val());
				strURL += '&processed='+encodeURIComponent($('#processed').val());
				strURL += '&topic='+encodeURIComponent($('#topic').val());
				loadPageNoHeader(strURL);
			}

			function clearFilter() {
				strURL = 'notify_queue.php?clear=1&header=false';
				loadPageNoHeader(strURL);
			}

			$(function() {
				$('#topic, #processed, #rows').change(function() {
					applyFilter();
				});

				$('#refresh').click(function() {
					applyFilter();
				});

				$('#clear').click(function() {
					clearFilter();
				});

				$('#suspend').click(function() {
					strURL = 'notify_queue.php?action=suspend';
					loadPage(strURL);
				});

				$('#resume').click(function() {
					strURL = 'notify_queue.php?action=resume';
					loadPage(strURL);
				});

				$('#purge').click(function() {
					strURL = 'notify_queue.php?action=purge';
					loadPage(strURL);
				});

				$('#form_notify').submit(function(event) {
					event.preventDefault();
					applyFilter();
				});
			});

			</script>
		</td>
	</tr>
	<?php

	html_end_box();

	$sql_where = '';

	if (get_request_var('filter') != '') {
		$sql_where = 'WHERE (nq.object_name LIKE ' . db_qstr('%' . get_request_var('filter') . '%') . ' OR ' .
			'h.hostname LIKE ' . db_qstr('%' . get_request_var('filter') . '%') . ' OR ' .
			'nq.hostname LIKE ' . db_qstr('%' . get_request_var('filter') . '%') . ')';
	}

	if (get_request_var('topic') != '' && get_request_var('topic') != '-1') {
		$sql_where .= ($sql_where != '' ? ' AND ' : 'WHERE ') . ' topic = ' . db_qstr(get_request_var('topic'));
	}

	if (get_request_var('processed') == 1) {
		$sql_where .= ($sql_where != '' ? ' AND ' : 'WHERE ') . ' event_processed = 1';
	} elseif (get_request_var('processed') == 0) {
		$sql_where .= ($sql_where != '' ? ' AND ' : 'WHERE ') . ' event_processed = 0';
	}

	$total_rows = db_fetch_cell("SELECT COUNT(*)
		FROM notification_queue AS nq
		LEFT JOIN host AS h
		ON h.id = nq.host_id
		$sql_where");

	$sql_order = get_order_string();
	$sql_limit = ' LIMIT ' . ($rows * (intval(get_request_var('page')) - 1)) . ',' . $rows;

	$notifications = db_fetch_assoc("SELECT nq.*, h.hostname
		FROM notification_queue AS nq
		LEFT JOIN host AS h
		ON h.id = nq.host_id
		$sql_where
		$sql_order
		$sql_limit");

	$lists = array_rekey(
		db_fetch_assoc('SELECT id, name
			FROM plugin_notification_lists
			ORDER BY id'),
		'id', 'name'
	);

	$nav = html_nav_bar('notify_queue.php?filter=' . get_request_var('filter'), MAX_DISPLAY_PAGES, get_request_var('page'), $rows, $total_rows, 5, __('Notifications', 'thold'), 'page', 'main');

	form_start('notify_queue.php', 'chk');

	print $nav;

	html_start_box('', '100%', '', '3', 'center', '');

	$display_text = [
		'topic' => [
			'display' => __('Topic', 'thold'),
			'align'   => 'left',
			'sort'    => 'ASC',
			'tip'     => __('The supported notification topic.', 'thold')
		],
		'object_name' => [
			'display' => __('Event Description', 'thold'),
			'align'   => 'left',
			'tip'     => __('The name of the object as defined by the caller.', 'thold')
		],
		'hostname' => [
			'display' => __('Hostname', 'thold'),
			'align'   => 'left',
			'tip'     => __('The hostname that was the source of this event.', 'thold')
		],
		'nosort' => [
			'display' => __('Notification List', 'thold'),
			'align'   => 'left',
			'tip'     => __('The Notification List used if any.', 'thold')
		],
		'object_id' => [
			'display' => __('Object ID', 'thold'),
			'align'   => 'right',
			'sort'    => 'DESC',
			'tip'     => __('The Object ID defined by the caller.  Generally its unique \'id\'.', 'thold')
		],
		'event_time' => [
			'display' => __('Event Time', 'thold'),
			'align'   => 'right',
			'sort'    => 'DESC',
			'tip'     => __('The time of the event as defined by the caller.', 'thold')
		],
		'event_processed' => [
			'display' => __('Processed', 'thold'),
			'align'   => 'right',
			'sort'    => 'DESC',
			'tip'     => __('Has the Notification Event been processed.', 'thold')
		],
		'error_code' => [
			'display' => __('Errors', 'thold'),
			'align'   => 'right',
			'sort'    => 'DESC',
			'tip'     => __('Did this notification result in an error.  Hover on the error column for details.', 'thold')
		],
		'attempt_count' => [
			'display' => __('Attempts', 'thold'),
			'align'   => 'right',
			'sort'    => 'DESC',
			'tip'     => __('The number of delivery attempts made for this notification.', 'thold')
		],
		'next_attempt' => [
			'display' => __('Next Attempt', 'thold'),
			'align'   => 'right',
			'sort'    => 'DESC',
			'tip'     => __('When a failed notification is eligible for its next retry.', 'thold')
		],
		'event_processed_runtime' => [
			'display' => __('Run Time', 'thold'),
			'align'   => 'right',
			'sort'    => 'DESC',
			'tip'     => __('The time in seconds it took to process the event.', 'thold')
		]
	];

	html_header_sort_checkbox($display_text, get_request_var('sort_column'), get_request_var('sort_direction'), false);

	if (cacti_sizeof($notifications)) {
		foreach ($notifications as $n) {
			$data = json_decode($n['event_data'], true);

			form_alternate_row('line' . $n['id'], false);

			form_selectable_cell($thold_notification_topics[$n['topic']], $n['id']);
			form_selectable_cell(html_escape($n['object_name']), $n['id']);
			form_selectable_cell(html_escape($n['hostname']), $n['id']);

			if (isset($lists[$n['notification_list_id']])) {
				form_selectable_cell(html_escape($lists[$n['notification_list_id']]), $n['id']);
			} else {
				form_selectable_cell(__('Not Specified', 'thold'), $n['id']);
			}

			form_selectable_cell($n['id'], $n['id'], '', 'right');
			form_selectable_cell($n['event_time'], $n['id'], '', 'right');

			foreach (thold_notification_queue_status_cells($n) as $cell) {
				form_selectable_cell($cell, $n['id'], '', 'right');
			}

			form_checkbox_cell($n['object_name'], $n['id']);

			form_end_row();
		}
	} else {
		print "<tr class='tableRow'><td colspan='" . (cacti_sizeof($display_text) + 1) . "'><em>" . __('No Notifications', 'thold') . '</em></td></tr>';
	}

	html_end_box(false);

	if (cacti_sizeof($notifications)) {
		print $nav;
	}

	// draw the dropdown containing a list of available actions for this form
	draw_actions_dropdown($actions);

	form_end();
}