";
+}
+
+/**
+ * Render wrapper header for names view table.
+ *
+ * @return string
+ */
+function renderHeaderNames(): string
+{
+ return "";
+}
+
+/**
+ * Render wrapper header for icon tile view.
+ *
+ * @return string
+ */
+function renderHeaderTiles(): string
+{
+ return renderHeaderDefault();
+}
+
+/**
+ * Render wrapper header for advanced tile view.
+ *
+ * @return string
+ */
+function renderHeaderTilesadt(): string
+{
+ return renderHeaderDefault();
+}
+
+/**
+ * Render header and sortable column bar for list view.
+ *
+ * @param int $total_rows Total rows matching active filters.
+ * @param int $rows Page row limit.
+ *
+ * @return string
+ */
+function renderHeaderList(int $total_rows = 0, int $rows = 0): string
+{
+ $display_text = [
+ 'hostname' => [
+ 'display' => __('Hostname', 'monitor'),
+ 'sort' => 'ASC',
+ 'align' => 'left', 'tip' => __('Hostname of device', 'monitor')
+ ],
+ 'id' => [
+ 'display' => __('ID', 'monitor'),
+ 'sort' => 'ASC',
+ 'align' => 'left'
+ ],
+ 'description' => [
+ 'display' => __('Description', 'monitor'),
+ 'sort' => 'ASC',
+ 'align' => 'left'
+ ],
+ 'site_name' => [
+ 'display' => __('Site', 'monitor'),
+ 'sort' => 'ASC',
+ 'align' => 'left'
+ ],
+ 'monitor_criticality' => [
+ 'display' => __('Criticality', 'monitor'),
+ 'sort' => 'ASC',
+ 'align' => 'left'
+ ],
+ 'status' => [
+ 'display' => __('Status', 'monitor'),
+ 'sort' => 'DESC',
+ 'align' => 'center'
+ ],
+ 'instate' => [
+ 'display' => __('Length in Status', 'monitor'),
+ 'sort' => 'ASC',
+ 'align' => 'center'
+ ],
+ 'avg_time' => [
+ 'display' => __('Averages', 'monitor'),
+ 'sort' => 'DESC',
+ 'align' => 'left'
+ ],
+ 'monitor_warn' => [
+ 'display' => __('Warning', 'monitor'),
+ 'sort' => 'DESC',
+ 'align' => 'left'
+ ],
+ 'monitor_text' => [
+ 'display' => __('Admin', 'monitor'),
+ 'sort' => 'ASC',
+ 'tip' => __('Monitor Text Column represents \'Admin\'', 'monitor'),
+ 'align' => 'left'
+ ],
+ 'notes' => [
+ 'display' => __('Notes', 'monitor'),
+ 'sort' => 'ASC',
+ 'align' => 'left'
+ ],
+ 'availability' => [
+ 'display' => __('Availability', 'monitor'),
+ 'sort' => 'DESC',
+ 'align' => 'right'
+ ],
+ 'status_fail_date' => [
+ 'display' => __('Last Fail', 'monitor'),
+ 'sort' => 'DESC',
+ 'align' => 'right'
+ ],
+ ];
+
+ ob_start();
+
+ $nav = html_nav_bar('monitor.php?rfilter=' . get_request_var('rfilter'), MAX_DISPLAY_PAGES, get_request_var('page'), $rows, $total_rows, 12, __('Devices'), 'page', 'main');
+
+ html_start_box(__('Monitored Devices', 'monitor'), '100%', false, '3', 'center', '');
+
+ print $nav;
+
+ html_header_sort($display_text, get_request_var('sort_column'), get_request_var('sort_direction'), false);
+
+ $output = ob_get_contents();
+
+ ob_end_clean();
+
+ return $output;
+}
+
+/**
+ * Indicate whether grouped section headers are suppressed for list view.
+ *
+ * @return bool
+ */
+function renderSuppressgroupsList(): bool
+{
+ return true;
+}
+
+/**
+ * Render wrapper footer for default/tile monitor views.
+ *
+ * @return string
+ */
+function renderFooterDefault(): string
+{
+ return '';
+}
+
+/**
+ * Render footer row for names view including trailing empty cells.
+ *
+ * @return string
+ */
+function renderFooterNames(): string
+{
+ $col = 7 - $_SESSION['names'];
+
+ if ($col == 0) {
+ return '
';
+ } else {
+ return '";
+
+ $url = $host['anchor'];
+
+ form_selectable_cell(filter_value($host['hostname'], '', $url), $host['id'], '', 'left');
+ form_selectable_cell($host['id'], $host['id'], '', 'left');
+ form_selectable_cell($host['description'], $host['id'], '', 'left');
+ form_selectable_cell($host['site_name'], $host['id'], '', 'left');
+ form_selectable_cell($host_crit, $host['id'], '', 'left');
+ form_selectable_cell($sdisplay, $host['id'], '', 'center');
+ form_selectable_cell($dt, $host['id'], '', 'center');
+ form_selectable_cell($host_avg, $host['id'], '', 'left');
+ form_selectable_cell($host_warn, $host['id'], '', 'left');
+ form_selectable_cell($host_admin, $host['id'], '', 'white-space:pre-wrap;text-align:left');
+ form_selectable_cell(str_replace(["\n", "\r"], [' ', ''], $host['notes']), $host['id'], '', 'white-space:pre-wrap;text-align:left');
+ form_selectable_cell(round($host['availability'], 2) . ' %', $host['id'], '', 'right');
+ form_selectable_cell($host_datefail, $host['id'], '', 'right');
+
+ form_end_row();
+
+ $result = ob_get_contents();
+
+ ob_end_clean();
+
+ return $result;
+}
+
+/**
+ * Render one host cell in names view grid.
+ *
+ * @param array $host Host row data.
+ *
+ * @return string
+ */
+function renderHostNames(array $host): string
+{
+ $fclass = get_request_var('size');
+
+ $result = '';
+
+ $maxlen = getMonitorTrimLength(100);
+
+ if ($_SESSION['names'] == 0) {
+ $result .= ' ';
+ }
+
+ if ($host['status'] <= 2 || $host['status'] == 5) {
+ $result .= "" . title_trim(html_escape($host['description']), $maxlen) . ' ';
+ } else {
+ $result .= "" . title_trim(html_escape($host['description']), $maxlen) . ' ';
+ }
+
+ $_SESSION['names']++;
+
+ if ($_SESSION['names'] > 7) {
+ $result .= ' ';
+ $_SESSION['names'] = 0;
+ }
+
+ return $result;
+}
+
+/**
+ * Render one host icon tile.
+ *
+ * @param array $host Host row data.
+ *
+ * @return string
+ */
+function renderHostTiles(array $host): string
+{
+ $class = getStatusIcon($host['status'], $host['monitor_icon']);
+ $fclass = get_request_var('size');
+
+ return "";
+}
+
+/**
+ * Render one advanced host tile including time-in-state/uptime text.
+ *
+ * @param array $host Host row data.
+ *
+ * @return string
+ */
+function renderHostTilesadt(array $host): string
+{
+ $tis = '';
+
+ $class = getStatusIcon($host['status'], $host['monitor_icon']);
+ $fclass = get_request_var('size');
+
+ if ($host['status'] < 2 || $host['status'] == 5) {
+ $tis = get_timeinstate($host);
+
+ return "";
+ } else {
+ $tis = get_uptime($host);
+
+ return "";
+ }
+}
+
+
+/**
+ * Apply monitor trim setting to a computed source field length.
+ *
+ * @param int $fieldlen Initial field length.
+ *
+ * @return int
+ */
+function getMonitorTrimLength(int $fieldlen): int
+{
+ global $maxchars;
+
+ if (get_request_var('view') == 'default' || get_request_var('view') == 'names') {
+ $maxlen = $maxchars;
+
+ if (get_request_var('trim') < 0) {
+ $maxlen = 4000;
+ } elseif (get_request_var('trim') > 0) {
+ $maxlen = get_request_var('trim');
+ }
+
+ if ($fieldlen > $maxlen) {
+ $fieldlen = $maxlen;
+ }
+ }
+
+ return $fieldlen;
+}
diff --git a/poller_functions.php b/poller_functions.php
new file mode 100644
index 0000000..b05c540
--- /dev/null
+++ b/poller_functions.php
@@ -0,0 +1,1111 @@
+ 0 && isset($notification_lists[$notify_list])) {
+ $emails = explode(',', $notification_lists[$notify_list]);
+ monitorAddEmails($reboot_emails, $emails, $host_id);
+ }
+}
+
+/**
+ * Fetch the configured global alert email list.
+ *
+ * @return array
+ */
+function getAlertEmails(): array
+{
+ $alert_email = read_config_option('alert_email');
+
+ return ($alert_email != '') ? explode(',', $alert_email) : [];
+}
+
+/**
+ * Delete monitor table rows that reference missing hosts.
+ *
+ * @param string $table_name Monitor table to purge.
+ *
+ * @return void
+ */
+function purgeOrphanMonitorRows(string $table_name): void
+{
+ $removed_hosts = db_fetch_assoc("SELECT mu.host_id
+ FROM $table_name AS mu
+ LEFT JOIN host AS h
+ ON h.id = mu.host_id
+ WHERE h.id IS NULL");
+
+ if (cacti_sizeof($removed_hosts)) {
+ db_execute("DELETE mu
+ FROM $table_name AS mu
+ LEFT JOIN host AS h
+ ON h.id = mu.host_id
+ WHERE h.id IS NULL");
+ }
+}
+
+/**
+ * Get monitored hosts whose uptime indicates a reboot.
+ *
+ * @return array
+ */
+function getRebootedHosts(): array
+{
+ return db_fetch_assoc('SELECT h.id, h.description,
+ h.hostname, h.snmp_sysUpTimeInstance, mu.uptime
+ FROM host AS h
+ LEFT JOIN plugin_monitor_uptime AS mu
+ ON h.id = mu.host_id
+ WHERE h.snmp_version > 0
+ AND status IN (2,3)
+ AND h.deleted = ""
+ AND h.monitor = "on"
+ AND (mu.uptime IS NULL OR mu.uptime > h.snmp_sysUpTimeInstance)
+ AND h.snmp_sysUpTimeInstance > 0');
+}
+
+/**
+ * Fetch notification lists and map id to email string.
+ *
+ * @return array
+ */
+function getNotificationListsMap(): array
+{
+ return array_rekey(
+ db_fetch_assoc('SELECT id, emails
+ FROM plugin_notification_lists
+ ORDER BY id'),
+ 'id',
+ 'emails'
+ );
+}
+
+/**
+ * Add reboot recipients based on host threshold notification settings.
+ *
+ * @param array $reboot_emails Recipient map keyed by email, then host id.
+ * @param int $host_id Host id being processed.
+ * @param array $alert_emails Global alert email list.
+ * @param array $notification_lists Map of notification list id to emails.
+ *
+ * @return void
+ */
+function addTholdRebootRecipients(array &$reboot_emails, int|string $host_id, array $alert_emails, array $notification_lists): void
+{
+ $notify = db_fetch_row_prepared(
+ 'SELECT thold_send_email, thold_host_email
+ FROM host
+ WHERE id = ?',
+ [$host_id]
+ );
+
+ if (!cacti_sizeof($notify)) {
+ return;
+ }
+
+ switch ($notify['thold_send_email']) {
+ case '1':
+ monitorAddEmails($reboot_emails, $alert_emails, $host_id);
+
+ break;
+ case '2':
+ monitorAddNotificationList($reboot_emails, $notify['thold_host_email'], $host_id, $notification_lists);
+
+ break;
+ case '3':
+ monitorAddEmails($reboot_emails, $alert_emails, $host_id);
+ monitorAddNotificationList($reboot_emails, $notify['thold_host_email'], $host_id, $notification_lists);
+
+ break;
+ default:
+ break;
+ }
+}
+
+/**
+ * Build reboot recipient map and persist reboot history rows.
+ *
+ * @param array $rebooted_hosts Rebooted host rows.
+ * @param array $alert_emails Global alert email list.
+ *
+ * @return array
+ */
+function buildRebootEmailMap(array $rebooted_hosts, array $alert_emails): array
+{
+ $reboot_emails = [];
+ $notification_lists = getNotificationListsMap();
+ $monitor_list = read_config_option('monitor_list');
+ $monitor_thold = read_config_option('monitor_reboot_thold');
+
+ foreach ($rebooted_hosts as $host) {
+ db_execute_prepared(
+ 'INSERT INTO plugin_monitor_reboot_history
+ (host_id, reboot_time)
+ VALUES (?, ?)',
+ [$host['id'], date(MONITOR_DATE_TIME_FORMAT, time() - intval($host['snmp_sysUpTimeInstance']))]
+ );
+
+ monitorAddNotificationList($reboot_emails, $monitor_list, $host['id'], $notification_lists);
+
+ if ($monitor_thold == 'on') {
+ addTholdRebootRecipients($reboot_emails, $host['id'], $alert_emails, $notification_lists);
+ }
+ }
+
+ return $reboot_emails;
+}
+
+/**
+ * Dispatch reboot notifications per-recipient or as a single batched email.
+ *
+ * @param array $reboot_emails Recipient map keyed by email, then host id.
+ *
+ * @return void
+ */
+function sendRebootNotifications(array $reboot_emails): void
+{
+ $monitor_send_one_email = read_config_option('monitor_send_one_email');
+
+ if (!cacti_sizeof($reboot_emails)) {
+ return;
+ }
+
+ $all_hosts = [];
+ $to_email = '';
+
+ foreach ($reboot_emails as $email => $hosts) {
+ if ($email == '') {
+ monitorDebug('Unable to process reboot notification due to empty Email address.');
+
+ continue;
+ }
+
+ $to_email .= ($to_email != '' ? ',' : '') . $email;
+ $all_hosts = array_unique(array_merge($all_hosts, array_values($hosts)));
+
+ if ($monitor_send_one_email !== 'on') {
+ monitorDebug('Processing the Email address: ' . $email);
+ processRebootEmail($email, $hosts);
+ }
+ }
+
+ if ($monitor_send_one_email == 'on' && $to_email !== '') {
+ monitorDebug('Processing the Email address: ' . $to_email);
+ processRebootEmail($to_email, $all_hosts);
+ }
+}
+
+/**
+ * Process reboot detection, uptime refresh, and down-event history logging.
+ *
+ * @return array{int, int} Reboot count and recent down count.
+ */
+function monitorUptimeChecker(): array
+{
+ monitorDebug('Checking for Uptime of Devices');
+
+ $alert_emails = getAlertEmails();
+
+ purgeOrphanMonitorRows('plugin_monitor_uptime');
+ purgeOrphanMonitorRows('plugin_monitor_reboot_history');
+
+ $rebooted_hosts = getRebootedHosts();
+
+ if (cacti_sizeof($rebooted_hosts)) {
+ $reboot_emails = buildRebootEmailMap($rebooted_hosts, $alert_emails);
+ sendRebootNotifications($reboot_emails);
+ }
+
+ // Freshen the uptimes
+ db_execute('REPLACE INTO plugin_monitor_uptime
+ (host_id, uptime)
+ SELECT id, snmp_sysUpTimeInstance
+ FROM host
+ WHERE snmp_version > 0
+ AND status IN(2,3)
+ AND deleted = ""
+ AND monitor = "on"
+ AND snmp_sysUpTimeInstance > 0');
+
+ // Log Recently Down
+ db_execute('INSERT IGNORE INTO plugin_monitor_notify_history
+ (host_id, notify_type, notification_time, notes)
+ SELECT h.id, "3" AS notify_type, status_fail_date AS notification_time, status_last_error AS notes
+ FROM host AS h
+ WHERE status = 1
+ AND deleted = ""
+ AND monitor = "on"
+ AND status_event_count = 1');
+
+ $recent = db_affected_rows();
+
+ return [cacti_sizeof($rebooted_hosts), $recent];
+}
+
+/**
+ * Build reboot details table/text and capture the last resolved host row.
+ *
+ * @param array $hosts Host ids to include.
+ *
+ * @return array{string, string, array}
+ */
+function buildRebootDetails(array $hosts): array
+{
+ $body_txt = '';
+ $last_host = [];
+
+ $body = '' . PHP_EOL;
+ $body .= '
' . PHP_EOL;
+
+ return [$body, $body_txt, $last_host];
+}
+
+/**
+ * Build reboot notification subject from host count and delivery mode.
+ *
+ * @param array $hosts Host id list.
+ * @param array $last_host Last host row seen while building details.
+ *
+ * @return string
+ */
+function buildRebootSubject(array $hosts, array $last_host): string
+{
+ $subject = read_config_option('monitor_subject');
+ $monitor_send_one_email = read_config_option('monitor_send_one_email');
+
+ if ($monitor_send_one_email == 'on' && cacti_sizeof($last_host)) {
+ return $subject . ' ' . $last_host['description'] . ' (' . $last_host['hostname'] . ')';
+ }
+
+ if (cacti_sizeof($hosts) == 1 && cacti_sizeof($last_host)) {
+ return $subject . ' 1 device - ' . $last_host['description'] . ' (' . $last_host['hostname'] . ')';
+ }
+
+ return $subject . ' ' . cacti_sizeof($hosts) . ' devices';
+}
+
+/**
+ * Wrap body output with report format template and build mail headers.
+ *
+ * @param string $body HTML body content.
+ * @param string $body_txt Plain text body content.
+ *
+ * @return array{string, string, array}
+ */
+function prepareReportOutput(string $body, string $body_txt): array
+{
+ $output = '';
+
+ $report_tag = '';
+ $theme = 'modern';
+
+ monitorDebug('Loading Format File');
+
+ $format_ok = reports_load_format_file(read_config_option('monitor_format_file'), $output, $report_tag, $theme);
+
+ monitorDebug('Format File Loaded, Format is ' . ($format_ok ? 'Ok' : 'Not Ok') . ', Report Tag is ' . $report_tag);
+
+ if ($format_ok) {
+ if ($report_tag) {
+ $output = str_replace('', $body, $output);
+ } else {
+ $output = $output . PHP_EOL . $body;
+ }
+ } else {
+ $output = $body;
+ }
+
+ monitorDebug('HTML Processed');
+
+ if (defined('CACTI_VERSION')) {
+ $version = CACTI_VERSION;
+ } else {
+ $version = get_cacti_version();
+ }
+
+ $headers = ['User-Agent' => 'Cacti-Monitor-v' . $version];
+
+ return [$output, $body_txt, $headers];
+}
+
+/**
+ * Render and send one reboot notification email payload.
+ *
+ * @param string $email Recipient email address string.
+ * @param array $hosts Host ids to include in the message.
+ *
+ * @return void
+ */
+function processRebootEmail(string $email, array $hosts): void
+{
+ monitorDebug("Reboot Processing for $email starting");
+
+ [$body, $body_txt, $last_host] = buildRebootDetails($hosts);
+ $subject = buildRebootSubject($hosts, $last_host);
+
+ $template_output = read_config_option('monitor_body');
+ $template_output = str_replace('
| ' . __('Description', 'monitor') . ' | ' . + '' . __('Hostname', 'monitor') . ' | ' . PHP_EOL; + $body .= '
|---|---|
| ' . $host['description'] . ' | ' . + '' . $host['hostname'] . ' | ' . + '
', $body, $template_output) . PHP_EOL;
+
+ if (strpos($template_output, '
') !== false) {
+ $toutput = str_replace('
', $body_txt, $template_output) . PHP_EOL;
+ } else {
+ $toutput = $body_txt;
+ }
+
+ if (read_config_option('monitor_reboot_notify') != 'on') {
+ return;
+ }
+
+ [$output, $toutput, $headers] = prepareReportOutput($body, $toutput);
+
+ processSendEmail($email, $subject, $output, $toutput, $headers, 'Reboot Notifications');
+}
+
+/**
+ * Resolve alert/warn host ids for requested global/list subscription scopes.
+ *
+ * @param array $lists Requested scopes (`global` or list ids).
+ * @param array $global_list Flattened global notification host ids by severity.
+ * @param array $notify_list Flattened list notification host ids by severity.
+ *
+ * @return array{array, array}
+ */
+function collectNotificationHosts(array $lists, array $global_list, array $notify_list): array
+{
+ $alert_hosts = [];
+ $warn_hosts = [];
+
+ foreach ($lists as $list) {
+ if ($list === 'global') {
+ if (isset($global_list['alert'])) {
+ $alert_hosts = array_merge($alert_hosts, explode(',', $global_list['alert']));
+ }
+
+ if (isset($global_list['warn'])) {
+ $warn_hosts = array_merge($warn_hosts, explode(',', $global_list['warn']));
+ }
+
+ continue;
+ }
+
+ if (isset($notify_list[$list]['alert'])) {
+ $alert_hosts = array_merge($alert_hosts, explode(',', $notify_list[$list]['alert']));
+ }
+
+ if (isset($notify_list[$list]['warn'])) {
+ $warn_hosts = array_merge($warn_hosts, explode(',', $notify_list[$list]['warn']));
+ }
+ }
+
+ return [$alert_hosts, $warn_hosts];
+}
+
+/**
+ * De-duplicate alert/warn host ids and log notification history entries.
+ *
+ * @param array $alert_hosts Alert host ids; normalized in place.
+ * @param array $warn_hosts Warning host ids; normalized in place.
+ *
+ * @return void
+ */
+function normalizeAndLogNotificationHosts(array &$alert_hosts, array &$warn_hosts): void
+{
+ if (cacti_sizeof($alert_hosts)) {
+ $alert_hosts = array_unique($alert_hosts, SORT_NUMERIC);
+ logMessages('alert', $alert_hosts);
+ }
+
+ if (cacti_sizeof($warn_hosts)) {
+ $warn_hosts = array_unique($warn_hosts, SORT_NUMERIC);
+ logMessages('warn', $warn_hosts);
+ }
+}
+
+/**
+ * Build shared intro copy for ping threshold email and text output.
+ *
+ * @param int $freq Resend frequency in minutes.
+ *
+ * @return array{string, string}
+ */
+function buildPingNotificationIntro(int|string $freq): array
+{
+ $body = '' . PHP_EOL;
+ $body .= '
' . PHP_EOL;
+}
+
+/**
+ * Build log-friendly summary text for alert/warn delivery counts.
+ *
+ * @param array $alert_hosts Alert host ids.
+ * @param array $warn_hosts Warning host ids.
+ *
+ * @return string
+ */
+function buildNotificationStatus(array $alert_hosts, array $warn_hosts): string
+{
+ $status = '';
+
+ if (cacti_sizeof($alert_hosts)) {
+ $status = sizeof($alert_hosts) . ' Alert Notifications';
+ }
+
+ if (cacti_sizeof($warn_hosts)) {
+ if ($status !== '') {
+ $status .= ', and ';
+ }
+
+ $status .= sizeof($warn_hosts) . ' Warning Notifications';
+ }
+
+ return $status;
+}
+
+/**
+ * Build and send a ping-threshold notification for one recipient.
+ *
+ * @param string $email Recipient email.
+ * @param array $lists Requested scopes (`global` or list ids).
+ * @param array $global_list Flattened global host ids by severity.
+ * @param array $notify_list Flattened list host ids by severity.
+ *
+ * @return void
+ */
+function processEmail(string $email, array $lists, array $global_list, array $notify_list): void
+{
+ monitorDebug('Into Processing');
+
+ $criticalities = [
+ 0 => __('Disabled', 'monitor'),
+ 1 => __('Low', 'monitor'),
+ 2 => __('Medium', 'monitor'),
+ 3 => __('High', 'monitor'),
+ 4 => __('Mission Critical', 'monitor')
+ ];
+
+ [$alert_hosts, $warn_hosts] = collectNotificationHosts($lists, $global_list, $notify_list);
+ monitorDebug('Lists Processed');
+
+ normalizeAndLogNotificationHosts($alert_hosts, $warn_hosts);
+ monitorDebug('Found ' . sizeof($alert_hosts) . ' Alert Hosts, and ' . sizeof($warn_hosts) . ' Warn Hosts');
+
+ if (!cacti_sizeof($alert_hosts) && !cacti_sizeof($warn_hosts)) {
+ return;
+ }
+
+ monitorDebug('Formatting Email');
+
+ $freq = read_config_option('monitor_resend_frequency');
+ $subject = __(MONITOR_PING_NOTIFICATION_SUBJECT, 'monitor');
+ [$body, $body_txt] = buildPingNotificationIntro($freq);
+
+ appendThresholdSection(
+ $body,
+ $body_txt,
+ $alert_hosts,
+ $criticalities,
+ 'The following Devices have breached their Alert Notification Threshold.',
+ 'monitor_alert'
+ );
+
+ appendThresholdSection(
+ $body,
+ $body_txt,
+ $warn_hosts,
+ $criticalities,
+ 'The following Devices have breached their Warning Notification Threshold.',
+ 'monitor_warn'
+ );
+
+ [$output, $toutput, $headers] = prepareReportOutput($body, $body_txt);
+ $status = buildNotificationStatus($alert_hosts, $warn_hosts);
+
+ processSendEmail($email, $subject, $output, $toutput, $headers, $status);
+}
+
+/**
+ * Send an email through Cacti mailer with configured sender fallbacks.
+ *
+ * @param string $email Recipient email string.
+ * @param string $subject Message subject.
+ * @param string $output HTML output body.
+ * @param string $toutput Plain text output body.
+ * @param array $headers Extra headers passed to mailer.
+ * @param string $status Status text used in logs.
+ *
+ * @return void
+ */
+function processSendEmail(string $email, string $subject, string $output, string $toutput, array $headers, string $status): void
+{
+ $from_email = read_config_option('monitor_fromemail');
+
+ if ($from_email == '') {
+ $from_email = read_config_option('settings_from_email');
+
+ if ($from_email == '') {
+ $from_email = 'Cacti@cacti.net';
+ }
+ }
+
+ $from_name = read_config_option('monitor_fromname');
+
+ if ($from_name == '') {
+ $from_name = read_config_option('settings_from_name');
+
+ if ($from_name == '') {
+ $from_name = 'Cacti Reporting';
+ }
+ }
+
+ $html = true;
+
+ if (read_config_option('thold_send_text_only') == 'on') {
+ $output = monitorText($toutput);
+ $html = false;
+ }
+
+ monitorDebug("Sending Email to '$email' for $status");
+
+ $error = mailer(
+ [$from_email, $from_name],
+ $email,
+ '',
+ '',
+ '',
+ $subject,
+ $output,
+ monitorText($toutput),
+ null,
+ $headers,
+ $html
+ );
+
+ monitorDebug("The return from the mailer was '$error'");
+
+ if (strlen($error)) {
+ cacti_log("WARNING: Monitor had problems sending to '$email' for $status. The error was '$error'", false, 'MONITOR');
+ } else {
+ cacti_log("NOTICE: Email Notification Sent to '$email' for $status.", false, 'MONITOR');
+ }
+}
+
+/**
+ * Convert HTML-ish report content into plain text line output.
+ *
+ * @param string $output HTML or mixed output.
+ *
+ * @return string
+ */
+function monitorText(string $output): string
+{
+ $output = explode(PHP_EOL, $output);
+
+ $new_output = '';
+
+ if (cacti_sizeof($output)) {
+ foreach ($output as $line) {
+ $line = str_replace('
', PHP_EOL, $line); + $line = str_replace('
', PHP_EOL, $line); + $line = trim(strip_tags($line)); + $new_output .= $line . PHP_EOL; + } + } + + return $new_output; +} + +/** + * Persist alert or warning notification history rows once per host. + * + * @param string $type Severity type (`alert` or `warn`). + * @param array $alert_hosts Host ids to log for the severity. + * + * @return void + */ +function logMessages(string $type, array $alert_hosts): void +{ + global $start_date; + + static $processed = []; + + if ($type == 'warn') { + $type = '0'; + $column = 'monitor_warn'; + } elseif ($type == 'alert') { + $type = '1'; + $column = 'monitor_alert'; + } + + foreach ($alert_hosts as $id) { + if (!isset($processed[$id])) { + db_execute_prepared( + "INSERT INTO plugin_monitor_notify_history + (host_id, notify_type, ping_time, ping_threshold, notification_time) + SELECT id, '$type' AS notify_type, cur_time, $column, '$start_date' AS notification_time + FROM host + WHERE deleted = '' + AND monitor = 'on' + AND id = ?", + [$id] + ); + } + + $processed[$id] = true; + } +} + +/** + * Add grouped host ids to global/list collections by host email mode. + * + * @param string $type Severity key (`alert` or `warn`). + * @param array $entry Grouped SQL row containing mode/list/ids. + * @param array $global_list Global grouped bucket, updated in place. + * @param array $notify_list Per-list grouped bucket, updated in place. + * @param array $lists Set of list ids used for recipient lookups. + * + * @return void + */ +function addGroupedNotificationEntry(string $type, array $entry, array &$global_list, array &$notify_list, array &$lists): void +{ + if ($entry['thold_send_email'] == '1' || $entry['thold_send_email'] == '3') { + $global_list[$type][] = $entry; + } + + if (($entry['thold_send_email'] == '2' || $entry['thold_send_email'] == '3') && $entry['thold_host_email'] > 0) { + $notify_list[$type][$entry['thold_host_email']][] = $entry; + $lists[$entry['thold_host_email']] = $entry['thold_host_email']; + } +} + +/** + * Query and group threshold-breached hosts for one severity type. + * + * @param string $type Severity key (`alert` or `warn`). + * @param int $criticality Minimum criticality threshold. + * @param array $global_list Global grouped bucket, updated in place. + * @param array $notify_list Per-list grouped bucket, updated in place. + * @param array $lists Set of notification list ids, updated in place. + * + * @return void + */ +function getHostsByListType(string $type, int|string $criticality, array &$global_list, array &$notify_list, array &$lists): void +{ + $last_time = date(MONITOR_DATE_TIME_FORMAT, time() - read_config_option('monitor_resend_frequency') * 60); + + $hosts = db_fetch_cell_prepared( + "SELECT COUNT(*) + FROM host + WHERE status = 3 + AND deleted = '' + AND monitor = 'on' + AND thold_send_email > 0 + AND monitor_criticality >= ? + AND cur_time > monitor_$type", + [$criticality] + ); + + if ($hosts <= 0) { + return; + } + + $htype = ($type == 'warn') ? 1 : 0; + + $groups = db_fetch_assoc_prepared( + "SELECT + thold_send_email, thold_host_email, GROUP_CONCAT(host.id) AS id + FROM host + LEFT JOIN ( + SELECT host_id, MAX(notification_time) AS notification_time + FROM plugin_monitor_notify_history + WHERE notify_type = ? + GROUP BY host_id + ) AS nh + ON host.id=nh.host_id + WHERE status = 3 + AND deleted = '' + AND monitor = 'on' + AND thold_send_email > 0 + AND monitor_criticality >= ? + AND cur_time > monitor_$type " . ($type == 'warn' ? ' AND cur_time < monitor_alert' : '') . ' + AND (notification_time < ? OR notification_time IS NULL) + AND host.total_polls > 1 + GROUP BY thold_host_email, thold_send_email + ORDER BY thold_host_email, thold_send_email', + [$htype, $criticality, $last_time] + ); + + if (!cacti_sizeof($groups)) { + return; + } + + foreach ($groups as $entry) { + addGroupedNotificationEntry($type, $entry, $global_list, $notify_list, $lists); + } +} + +/** + * Flatten grouped host id chunks for a single severity bucket. + * + * @param array $list Grouped rows, each row containing a CSV `id` field. + * + * @return string + */ +function flattenGroupSeverityList(array $list): string +{ + $flattened = ''; + + foreach ($list as $item) { + $flattened .= ($flattened !== '' ? ',' : '') . $item['id']; + } + + return $flattened; +} + +/** + * Flatten grouped host ids for each notification list id. + * + * @param array $lists Grouped entries keyed by notification list id. + * + * @return array + */ +function flattenNotifySeverityLists(array $lists): array +{ + $flattened = []; + + foreach ($lists as $id => $list) { + $flattened[$id] = flattenGroupSeverityList($list); + } + + return $flattened; +} + +/** + * Flatten grouped global and per-list structures into CSV host id strings. + * + * @param array $global_list Global grouped structure, updated in place. + * @param array $notify_list Per-list grouped structure, updated in place. + * + * @return void + */ +function flattenLists(array &$global_list, array &$notify_list): void +{ + if (cacti_sizeof($global_list)) { + $new_global = []; + + foreach ($global_list as $severity => $list) { + $new_global[$severity] = flattenGroupSeverityList($list); + } + + $global_list = $new_global; + } + + if (cacti_sizeof($notify_list)) { + $new_list = []; + + foreach ($notify_list as $severity => $lists) { + $new_list[$severity] = flattenNotifySeverityLists($lists); + } + + $notify_list = $new_list; + } +} + +/** + * Add email addresses into the recipient scope map. + * + * @param array $notification_emails Recipient map, updated in place. + * @param array $emails Raw email values to normalize. + * @param string|int $scope_key Scope key (`global` or list id). + * + * @return void + */ +function addEmailsToNotificationMap(array &$notification_emails, array $emails, string|int $scope_key): void +{ + foreach ($emails as $user) { + $user = trim($user); + + if ($user !== '') { + $notification_emails[$user][$scope_key] = true; + } + } +} + +/** + * Build recipient map for global and notification list subscriptions. + * + * @param array $lists Notification list ids to resolve. + * + * @return array + */ +function getEmailsAndLists(array $lists): array +{ + $notification_emails = []; + + $alert_email = read_config_option('alert_email'); + $global_emails = ($alert_email != '') ? explode(',', $alert_email) : []; + + if (cacti_sizeof($global_emails)) { + addEmailsToNotificationMap($notification_emails, $global_emails, 'global'); + } + + if (!cacti_sizeof($lists)) { + return $notification_emails; + } + + $list_emails = db_fetch_assoc('SELECT id, emails + FROM plugin_notification_lists + WHERE id IN (' . implode(',', $lists) . ')'); + + if (!cacti_sizeof($list_emails)) { + return $notification_emails; + } + + foreach ($list_emails as $email) { + addEmailsToNotificationMap($notification_emails, explode(',', $email['emails']), $email['id']); + } + + return $notification_emails; +} + +/** + * Purge notification and reboot history records older than configured retention. + * + * @return array{int, int} Purged notify count and purged reboot count. + */ +function purgeEventRecords(): array +{ + // Purge old records + $days = read_config_option('monitor_log_storage'); + + if (empty($days)) { + $days = 120; + } + + db_execute_prepared( + 'DELETE FROM plugin_monitor_notify_history + WHERE notification_time < FROM_UNIXTIME(UNIX_TIMESTAMP() - (? * 86400))', + [$days] + ); + + $purge_n = db_affected_rows(); + + db_execute_prepared( + 'DELETE FROM plugin_monitor_reboot_history + WHERE log_time < FROM_UNIXTIME(UNIX_TIMESTAMP() - (? * 86400))', + [$days] + ); + + $purge_r = db_affected_rows(); + + return [$purge_n, $purge_r]; +} + +/** + * Print a debug line when poller debug mode is enabled. + * + * @param string $message Debug message. + * + * @return void + */ +function monitorDebug(string $message): void +{ + global $debug; + + if ($debug) { + print trim($message) . PHP_EOL; + } +} + +/** + * Print monitor poller version information. + * + * @return void + */ +function displayVersion(): void +{ + global $config; + + if (!function_exists('pluginMonitorVersion')) { + include_once $config['base_path'] . '/plugins/monitor/setup.php'; + } + + $info = pluginMonitorVersion(); + print 'Cacti Monitor Poller, Version ' . $info['version'] . ', ' . COPYRIGHT_YEARS . PHP_EOL; +} + +/** + * Print CLI help output for this poller entrypoint. + * + * @return void + */ +function displayHelp(): void +{ + displayVersion(); + + print PHP_EOL; + print 'usage: poller_monitor.php [--debug]' . PHP_EOL . PHP_EOL; + print ' --debug - debug execution, e.g. for testing' . PHP_EOL . PHP_EOL; +} diff --git a/poller_monitor.php b/poller_monitor.php index 433da8a..756ef64 100644 --- a/poller_monitor.php +++ b/poller_monitor.php @@ -1,4 +1,7 @@ 0 || $alert_criticality > 0) { - monitor_debug('Monitor Notification Enabled for Devices'); + monitorDebug('Monitor Notification Enabled for Devices'); - // Get hosts that are above threshold. Start with Alert, and then Warning - if ($alert_criticality) { - get_hosts_by_list_type('alert', $alert_criticality, $global_list, $notify_list, $lists); - } + // Get hosts that are above threshold. Start with Alert, and then Warning. + if ($alert_criticality) { + getHostsByListType('alert', $alert_criticality, $global_list, $notify_list, $lists); + } - if ($warning_criticality) { - get_hosts_by_list_type('warn', $warning_criticality, $global_list, $notify_list, $lists); - } + if ($warning_criticality) { + getHostsByListType('warn', $warning_criticality, $global_list, $notify_list, $lists); + } - flatten_lists($global_list, $notify_list); + flattenLists($global_list, $notify_list); - monitor_debug('Lists Flattened there are ' . sizeof($global_list) . ' Global Notifications and ' . sizeof($notify_list) . ' Notification List Notifications.'); + monitorDebug('Lists Flattened there are ' . sizeof($global_list) . ' Global Notifications and ' . sizeof($notify_list) . ' Notification List Notifications.'); - if (strlen(read_config_option('alert_email')) == 0) { - monitor_debug('WARNING: No Global List Defined. Please set under Settings -> Thresholds'); - cacti_log('WARNING: No Global Notification List defined. Please set under Settings -> Thresholds', false, 'MONITOR'); - } + if (strlen(read_config_option('alert_email')) == 0) { + monitorDebug('WARNING: No Global List Defined. Please set under Settings -> Thresholds'); + cacti_log('WARNING: No Global Notification List defined. Please set under Settings -> Thresholds', false, 'MONITOR'); + } - if (cacti_sizeof($global_list) || sizeof($notify_list)) { - // array of email[list|'g'] = true; - $notification_emails = get_emails_and_lists($lists); + if (cacti_sizeof($global_list) || sizeof($notify_list)) { + // array of email[list|'g'] = true; + $notification_emails = getEmailsAndLists($lists); - // Send out emails to each emails address with all notifications in one - if (cacti_sizeof($notification_emails)) { - foreach ($notification_emails as $email => $lists) { - monitor_debug('Processing the email address: ' . $email); - process_email($email, $lists, $global_list, $notify_list); + // Send out emails to each emails address with all notifications in one + if (cacti_sizeof($notification_emails)) { + foreach ($notification_emails as $email => $lists) { + monitorDebug('Processing the email address: ' . $email); + processEmail($email, $lists, $global_list, $notify_list); - $notifications++; - } - } - } + $notifications++; + } + } + } } else { - monitor_debug('Both Warning and Alert Notification are Disabled.'); + monitorDebug('Both Warning and Alert Notification are Disabled.'); } -[$purge_n, $purge_r] = purge_event_records(); +[$purge_n, $purge_r] = purgeEventRecords(); $poller_end = microtime(true); $stats = - 'Time:' . round($poller_end - $poller_start, 2) . - ' Reboots:' . $reboots . - ' DownDevices:' . $recent_down . - ' Notifications:' . $notifications . - ' Purges:' . ($purge_n + $purge_r); + 'Time:' . round($poller_end - $poller_start, 2) . + ' Reboots:' . $reboots . + ' DownDevices:' . $recent_down . + ' Notifications:' . $notifications . + ' Purges:' . ($purge_n + $purge_r); cacti_log('MONITOR STATS: ' . $stats, false, 'SYSTEM'); set_config_option('stats_monitor', $stats); exit; - -function monitor_addemails(&$reboot_emails, $alert_emails, $host_id) { - if (cacti_sizeof($alert_emails)) { - foreach ($alert_emails as $email) { - $reboot_emails[trim(strtolower($email))][$host_id] = $host_id; - } - } -} - -function monitor_addnotificationlist(&$reboot_emails, $notify_list, $host_id, $notification_lists) { - if ($notify_list > 0) { - if (isset($notification_lists[$notify_list])) { - $emails = explode(',', $notification_lists[$notify_list]); - monitor_addemails($reboot_emails, $emails, $host_id); - } - } -} - -function monitor_uptime_checker() { - monitor_debug('Checking for Uptime of Devices'); - - $start = date('Y-m-d H:i:s'); - - $reboot_emails = []; - - $alert_email = read_config_option('alert_email'); - - if ($alert_email != '') { - $alert_emails = explode(',', $alert_email); - } else { - $alert_emails = []; - } - - // Remove unneeded device records in associated tables - $removed_hosts = db_fetch_assoc('SELECT mu.host_id - FROM plugin_monitor_uptime AS mu - LEFT JOIN host AS h - ON h.id = mu.host_id - WHERE h.id IS NULL'); - - if (cacti_sizeof($removed_hosts)) { - db_execute('DELETE mu - FROM plugin_monitor_uptime AS mu - LEFT JOIN host AS h - ON h.id = mu.host_id - WHERE h.id IS NULL'); - } - - $removed_hosts = db_fetch_assoc('SELECT mu.host_id - FROM plugin_monitor_reboot_history AS mu - LEFT JOIN host AS h - ON h.id = mu.host_id - WHERE h.id IS NULL'); - - if (cacti_sizeof($removed_hosts)) { - db_execute('DELETE mu - FROM plugin_monitor_reboot_history AS mu - LEFT JOIN host AS h - ON h.id = mu.host_id - WHERE h.id IS NULL'); - } - - // Get the rebooted devices - $rebooted_hosts = db_fetch_assoc('SELECT h.id, h.description, - h.hostname, h.snmp_sysUpTimeInstance, mu.uptime - FROM host AS h - LEFT JOIN plugin_monitor_uptime AS mu - ON h.id = mu.host_id - WHERE h.snmp_version > 0 - AND status IN (2,3) - AND h.deleted = "" - AND h.monitor = "on" - AND (mu.uptime IS NULL OR mu.uptime > h.snmp_sysUpTimeInstance) - AND h.snmp_sysUpTimeInstance > 0'); - - if (cacti_sizeof($rebooted_hosts)) { - $notification_lists = array_rekey( - db_fetch_assoc('SELECT id, emails - FROM plugin_notification_lists - ORDER BY id'), - 'id', 'emails' - ); - - $monitor_list = read_config_option('monitor_list'); - $monitor_thold = read_config_option('monitor_reboot_thold'); - - foreach ($rebooted_hosts as $host) { - db_execute_prepared('INSERT INTO plugin_monitor_reboot_history - (host_id, reboot_time) - VALUES (?, ?)', - [$host['id'], date('Y-m-d H:i:s', time() - intval($host['snmp_sysUpTimeInstance']))]); - - monitor_addnotificationlist($reboot_emails, $monitor_list, $host['id'], $notification_lists); - - if ($monitor_thold == 'on') { - $notify = db_fetch_row_prepared('SELECT thold_send_email, thold_host_email - FROM host - WHERE id = ?', - [$host['id']]); - - if (cacti_sizeof($notify)) { - switch($notify['thold_send_email']) { - case '0': // Disabled - break; - case '1': // Global List - monitor_addemails($reboot_emails, $alert_emails, $host['id']); - - break; - case '2': // Nofitication List - monitor_addnotificationlist($reboot_emails, $notify['thold_host_email'], - $host['id'], $notification_lists); - - break; - case '3': // Both Global and Nofication list - monitor_addemails($reboot_emails, $alert_emails, $host['id']); - monitor_addnotificationlist($reboot_emails, $notify['thold_host_email'], - $host['id'], $notification_lists); - - break; - } - } - } - } - - $monitor_send_one_email = read_config_option('monitor_send_one_email'); - $to_email = ''; - - if (cacti_sizeof($reboot_emails)) { - foreach ($reboot_emails as $email => $hosts) { - if ($email != '') { - $to_email .= ($to_email != '' ? ',' : '') . $email; - - if ($monitor_send_one_email !== 'on') { - monitor_debug('Processing the Email address: ' . $email); - process_reboot_email($email, $hosts); - } - } else { - monitor_debug('Unable to process reboot notification due to empty Email address.'); - } - } - - if ($monitor_send_one_email == 'on') { - monitor_debug('Processing the Email address: ' . $to_email); - process_reboot_email($to_email, $hosts); - } - } - } - - // Freshen the uptimes - db_execute('REPLACE INTO plugin_monitor_uptime - (host_id, uptime) - SELECT id, snmp_sysUpTimeInstance - FROM host - WHERE snmp_version > 0 - AND status IN(2,3) - AND deleted = "" - AND monitor = "on" - AND snmp_sysUpTimeInstance > 0'); - - // Log Recently Down - db_execute('INSERT IGNORE INTO plugin_monitor_notify_history - (host_id, notify_type, notification_time, notes) - SELECT h.id, "3" AS notify_type, status_fail_date AS notification_time, status_last_error AS notes - FROM host AS h - WHERE status = 1 - AND deleted = "" - AND monitor = "on" - AND status_event_count = 1'); - - $recent = db_affected_rows(); - - return [cacti_sizeof($rebooted_hosts), $recent]; -} - -function process_reboot_email($email, $hosts) { - monitor_debug("Reboot Processing for $email starting"); - - $body_txt = ''; - - $body = '' . PHP_EOL;
- $body .= '
' . PHP_EOL;
-
- $subject = read_config_option('monitor_subject');
- $monitor_send_one_email = read_config_option('monitor_send_one_email');
-
- if ($monitor_send_one_email == 'on') {
- $subject .= ' ' . $host['description'] . ' (' . $host['hostname'] . ')';
- } else {
- if (cacti_sizeof($hosts) == 1) {
- $subject .= ' 1 device - ' . $host['description'] . ' (' . $host['hostname'] . ')';
- } else {
- $subject .= ' ' . cacti_sizeof($hosts) . ' devices';
- }
- }
-
- $output = read_config_option('monitor_body');
- $output = str_replace('
' . __(MONITOR_PING_NOTIFICATION_SUBJECT, 'monitor') . '
' . PHP_EOL; + $body_txt = __(MONITOR_PING_NOTIFICATION_SUBJECT, 'monitor') . PHP_EOL; + + $message = __('The following report will identify Devices that have eclipsed their ping latency thresholds. You are receiving this report since you are subscribed to a Device associated with the Cacti system located at the following URL below.'); + + $body .= '' . $message . '
' . PHP_EOL; + $body_txt .= $message . PHP_EOL; + + $body .= 'Cacti Monitoring Site
' . PHP_EOL; + $body_txt .= __('Cacti Monitoring Site', 'monitor') . PHP_EOL; + + if ($freq > 0) { + $body .= '' . __('You will receive notifications every %d minutes if the Device is above its threshold.', $freq, 'monitor') . '
' . PHP_EOL; + $body_txt .= __('You will receive notifications every %d minutes if the Device is above its threshold.', $freq, 'monitor') . PHP_EOL; + } else { + $body .= '' . __('You will receive notifications every time the Device is above its threshold.', 'monitor') . '
' . PHP_EOL; + $body_txt .= __('You will receive notifications every time the Device is above its threshold.', 'monitor') . PHP_EOL; + } + + return [$body, $body_txt]; +} + +/** + * Append one severity section for breached host thresholds. + * + * @param string $body HTML body output buffer. + * @param string $body_txt Plain text output buffer. + * @param array $host_ids Host ids for the section. + * @param array $criticalities Criticality label map. + * @param string $section_text Section heading text. + * @param string $threshold_field Host threshold field name. + * + * @return void + */ +function appendThresholdSection(string &$body, string &$body_txt, array $host_ids, array $criticalities, string $section_text, string $threshold_field): void +{ + global $config; + + if (!cacti_sizeof($host_ids)) { + return; + } + + $body .= '' . __($section_text, 'monitor') . '
' . PHP_EOL; + $body_txt .= __($section_text, 'monitor') . PHP_EOL; + + $body .= '| ' . __('Hostname', 'monitor') . ' | ' . + '' . __('Criticality', 'monitor') . ' | ' . + '' . __(MONITOR_ALERT_PING_LABEL, 'monitor') . ' | ' . + '' . __(MONITOR_CURRENT_PING_LABEL, 'monitor') . ' | ' . PHP_EOL; + $body .= '
|---|---|---|---|
| ' . $host['description'] . ' | ' . PHP_EOL; + $body .= '' . $criticalities[$host['monitor_criticality']] . ' | ' . PHP_EOL; + $body .= '' . number_format_i18n($host[$threshold_field], 2) . ' ms | ' . PHP_EOL; + $body .= '' . number_format_i18n($host['cur_time'], 2) . ' ms | ' . PHP_EOL; + $body .= '
', PHP_EOL, $line); + $line = str_replace('
', PHP_EOL, $line); + $line = trim(strip_tags($line)); + $new_output .= $line . PHP_EOL; + } + } + + return $new_output; +} + +/** + * Persist alert or warning notification history rows once per host. + * + * @param string $type Severity type (`alert` or `warn`). + * @param array $alert_hosts Host ids to log for the severity. + * + * @return void + */ +function logMessages(string $type, array $alert_hosts): void +{ + global $start_date; + + static $processed = []; + + if ($type == 'warn') { + $type = '0'; + $column = 'monitor_warn'; + } elseif ($type == 'alert') { + $type = '1'; + $column = 'monitor_alert'; + } + + foreach ($alert_hosts as $id) { + if (!isset($processed[$id])) { + db_execute_prepared( + "INSERT INTO plugin_monitor_notify_history + (host_id, notify_type, ping_time, ping_threshold, notification_time) + SELECT id, '$type' AS notify_type, cur_time, $column, '$start_date' AS notification_time + FROM host + WHERE deleted = '' + AND monitor = 'on' + AND id = ?", + [$id] + ); + } + + $processed[$id] = true; + } +} + +/** + * Add grouped host ids to global/list collections by host email mode. + * + * @param string $type Severity key (`alert` or `warn`). + * @param array $entry Grouped SQL row containing mode/list/ids. + * @param array $global_list Global grouped bucket, updated in place. + * @param array $notify_list Per-list grouped bucket, updated in place. + * @param array $lists Set of list ids used for recipient lookups. + * + * @return void + */ +function addGroupedNotificationEntry(string $type, array $entry, array &$global_list, array &$notify_list, array &$lists): void +{ + if ($entry['thold_send_email'] == '1' || $entry['thold_send_email'] == '3') { + $global_list[$type][] = $entry; + } + + if (($entry['thold_send_email'] == '2' || $entry['thold_send_email'] == '3') && $entry['thold_host_email'] > 0) { + $notify_list[$type][$entry['thold_host_email']][] = $entry; + $lists[$entry['thold_host_email']] = $entry['thold_host_email']; + } +} + +/** + * Query and group threshold-breached hosts for one severity type. + * + * @param string $type Severity key (`alert` or `warn`). + * @param int $criticality Minimum criticality threshold. + * @param array $global_list Global grouped bucket, updated in place. + * @param array $notify_list Per-list grouped bucket, updated in place. + * @param array $lists Set of notification list ids, updated in place. + * + * @return void + */ +function getHostsByListType(string $type, int|string $criticality, array &$global_list, array &$notify_list, array &$lists): void +{ + $last_time = date(MONITOR_DATE_TIME_FORMAT, time() - read_config_option('monitor_resend_frequency') * 60); + + $hosts = db_fetch_cell_prepared( + "SELECT COUNT(*) + FROM host + WHERE status = 3 + AND deleted = '' + AND monitor = 'on' + AND thold_send_email > 0 + AND monitor_criticality >= ? + AND cur_time > monitor_$type", + [$criticality] + ); + + if ($hosts <= 0) { + return; + } + + $htype = ($type == 'warn') ? 1 : 0; + + $groups = db_fetch_assoc_prepared( + "SELECT + thold_send_email, thold_host_email, GROUP_CONCAT(host.id) AS id + FROM host + LEFT JOIN ( + SELECT host_id, MAX(notification_time) AS notification_time + FROM plugin_monitor_notify_history + WHERE notify_type = ? + GROUP BY host_id + ) AS nh + ON host.id=nh.host_id + WHERE status = 3 + AND deleted = '' + AND monitor = 'on' + AND thold_send_email > 0 + AND monitor_criticality >= ? + AND cur_time > monitor_$type " . ($type == 'warn' ? ' AND cur_time < monitor_alert' : '') . ' + AND (notification_time < ? OR notification_time IS NULL) + AND host.total_polls > 1 + GROUP BY thold_host_email, thold_send_email + ORDER BY thold_host_email, thold_send_email', + [$htype, $criticality, $last_time] + ); + + if (!cacti_sizeof($groups)) { + return; + } + + foreach ($groups as $entry) { + addGroupedNotificationEntry($type, $entry, $global_list, $notify_list, $lists); + } +} + +/** + * Flatten grouped host id chunks for a single severity bucket. + * + * @param array $list Grouped rows, each row containing a CSV `id` field. + * + * @return string + */ +function flattenGroupSeverityList(array $list): string +{ + $flattened = ''; + + foreach ($list as $item) { + $flattened .= ($flattened !== '' ? ',' : '') . $item['id']; + } + + return $flattened; +} + +/** + * Flatten grouped host ids for each notification list id. + * + * @param array $lists Grouped entries keyed by notification list id. + * + * @return array + */ +function flattenNotifySeverityLists(array $lists): array +{ + $flattened = []; + + foreach ($lists as $id => $list) { + $flattened[$id] = flattenGroupSeverityList($list); + } + + return $flattened; +} + +/** + * Flatten grouped global and per-list structures into CSV host id strings. + * + * @param array $global_list Global grouped structure, updated in place. + * @param array $notify_list Per-list grouped structure, updated in place. + * + * @return void + */ +function flattenLists(array &$global_list, array &$notify_list): void +{ + if (cacti_sizeof($global_list)) { + $new_global = []; + + foreach ($global_list as $severity => $list) { + $new_global[$severity] = flattenGroupSeverityList($list); + } + + $global_list = $new_global; + } + + if (cacti_sizeof($notify_list)) { + $new_list = []; + + foreach ($notify_list as $severity => $lists) { + $new_list[$severity] = flattenNotifySeverityLists($lists); + } + + $notify_list = $new_list; + } +} + +/** + * Add email addresses into the recipient scope map. + * + * @param array $notification_emails Recipient map, updated in place. + * @param array $emails Raw email values to normalize. + * @param string|int $scope_key Scope key (`global` or list id). + * + * @return void + */ +function addEmailsToNotificationMap(array &$notification_emails, array $emails, string|int $scope_key): void +{ + foreach ($emails as $user) { + $user = trim($user); + + if ($user !== '') { + $notification_emails[$user][$scope_key] = true; + } + } +} + +/** + * Build recipient map for global and notification list subscriptions. + * + * @param array $lists Notification list ids to resolve. + * + * @return array + */ +function getEmailsAndLists(array $lists): array +{ + $notification_emails = []; + + $alert_email = read_config_option('alert_email'); + $global_emails = ($alert_email != '') ? explode(',', $alert_email) : []; + + if (cacti_sizeof($global_emails)) { + addEmailsToNotificationMap($notification_emails, $global_emails, 'global'); + } + + if (!cacti_sizeof($lists)) { + return $notification_emails; + } + + $list_emails = db_fetch_assoc('SELECT id, emails + FROM plugin_notification_lists + WHERE id IN (' . implode(',', $lists) . ')'); + + if (!cacti_sizeof($list_emails)) { + return $notification_emails; + } + + foreach ($list_emails as $email) { + addEmailsToNotificationMap($notification_emails, explode(',', $email['emails']), $email['id']); + } + + return $notification_emails; +} + +/** + * Purge notification and reboot history records older than configured retention. + * + * @return array{int, int} Purged notify count and purged reboot count. + */ +function purgeEventRecords(): array +{ + // Purge old records + $days = read_config_option('monitor_log_storage'); + + if (empty($days)) { + $days = 120; + } + + db_execute_prepared( + 'DELETE FROM plugin_monitor_notify_history + WHERE notification_time < FROM_UNIXTIME(UNIX_TIMESTAMP() - (? * 86400))', + [$days] + ); + + $purge_n = db_affected_rows(); + + db_execute_prepared( + 'DELETE FROM plugin_monitor_reboot_history + WHERE log_time < FROM_UNIXTIME(UNIX_TIMESTAMP() - (? * 86400))', + [$days] + ); + + $purge_r = db_affected_rows(); + + return [$purge_n, $purge_r]; +} + +/** + * Print a debug line when poller debug mode is enabled. + * + * @param string $message Debug message. + * + * @return void + */ +function monitorDebug(string $message): void +{ + global $debug; + + if ($debug) { + print trim($message) . PHP_EOL; + } +} + +/** + * Print monitor poller version information. + * + * @return void + */ +function displayVersion(): void +{ + global $config; + + if (!function_exists('pluginMonitorVersion')) { + include_once $config['base_path'] . '/plugins/monitor/setup.php'; + } + + $info = pluginMonitorVersion(); + print 'Cacti Monitor Poller, Version ' . $info['version'] . ', ' . COPYRIGHT_YEARS . PHP_EOL; +} + +/** + * Print CLI help output for this poller entrypoint. + * + * @return void + */ +function displayHelp(): void +{ + displayVersion(); + + print PHP_EOL; + print 'usage: poller_monitor.php [--debug]' . PHP_EOL . PHP_EOL; + print ' --debug - debug execution, e.g. for testing' . PHP_EOL . PHP_EOL; +} diff --git a/poller_monitor.php b/poller_monitor.php index 433da8a..756ef64 100644 --- a/poller_monitor.php +++ b/poller_monitor.php @@ -1,4 +1,7 @@ 0 || $alert_criticality > 0) { - monitor_debug('Monitor Notification Enabled for Devices'); + monitorDebug('Monitor Notification Enabled for Devices'); - // Get hosts that are above threshold. Start with Alert, and then Warning - if ($alert_criticality) { - get_hosts_by_list_type('alert', $alert_criticality, $global_list, $notify_list, $lists); - } + // Get hosts that are above threshold. Start with Alert, and then Warning. + if ($alert_criticality) { + getHostsByListType('alert', $alert_criticality, $global_list, $notify_list, $lists); + } - if ($warning_criticality) { - get_hosts_by_list_type('warn', $warning_criticality, $global_list, $notify_list, $lists); - } + if ($warning_criticality) { + getHostsByListType('warn', $warning_criticality, $global_list, $notify_list, $lists); + } - flatten_lists($global_list, $notify_list); + flattenLists($global_list, $notify_list); - monitor_debug('Lists Flattened there are ' . sizeof($global_list) . ' Global Notifications and ' . sizeof($notify_list) . ' Notification List Notifications.'); + monitorDebug('Lists Flattened there are ' . sizeof($global_list) . ' Global Notifications and ' . sizeof($notify_list) . ' Notification List Notifications.'); - if (strlen(read_config_option('alert_email')) == 0) { - monitor_debug('WARNING: No Global List Defined. Please set under Settings -> Thresholds'); - cacti_log('WARNING: No Global Notification List defined. Please set under Settings -> Thresholds', false, 'MONITOR'); - } + if (strlen(read_config_option('alert_email')) == 0) { + monitorDebug('WARNING: No Global List Defined. Please set under Settings -> Thresholds'); + cacti_log('WARNING: No Global Notification List defined. Please set under Settings -> Thresholds', false, 'MONITOR'); + } - if (cacti_sizeof($global_list) || sizeof($notify_list)) { - // array of email[list|'g'] = true; - $notification_emails = get_emails_and_lists($lists); + if (cacti_sizeof($global_list) || sizeof($notify_list)) { + // array of email[list|'g'] = true; + $notification_emails = getEmailsAndLists($lists); - // Send out emails to each emails address with all notifications in one - if (cacti_sizeof($notification_emails)) { - foreach ($notification_emails as $email => $lists) { - monitor_debug('Processing the email address: ' . $email); - process_email($email, $lists, $global_list, $notify_list); + // Send out emails to each emails address with all notifications in one + if (cacti_sizeof($notification_emails)) { + foreach ($notification_emails as $email => $lists) { + monitorDebug('Processing the email address: ' . $email); + processEmail($email, $lists, $global_list, $notify_list); - $notifications++; - } - } - } + $notifications++; + } + } + } } else { - monitor_debug('Both Warning and Alert Notification are Disabled.'); + monitorDebug('Both Warning and Alert Notification are Disabled.'); } -[$purge_n, $purge_r] = purge_event_records(); +[$purge_n, $purge_r] = purgeEventRecords(); $poller_end = microtime(true); $stats = - 'Time:' . round($poller_end - $poller_start, 2) . - ' Reboots:' . $reboots . - ' DownDevices:' . $recent_down . - ' Notifications:' . $notifications . - ' Purges:' . ($purge_n + $purge_r); + 'Time:' . round($poller_end - $poller_start, 2) . + ' Reboots:' . $reboots . + ' DownDevices:' . $recent_down . + ' Notifications:' . $notifications . + ' Purges:' . ($purge_n + $purge_r); cacti_log('MONITOR STATS: ' . $stats, false, 'SYSTEM'); set_config_option('stats_monitor', $stats); exit; - -function monitor_addemails(&$reboot_emails, $alert_emails, $host_id) { - if (cacti_sizeof($alert_emails)) { - foreach ($alert_emails as $email) { - $reboot_emails[trim(strtolower($email))][$host_id] = $host_id; - } - } -} - -function monitor_addnotificationlist(&$reboot_emails, $notify_list, $host_id, $notification_lists) { - if ($notify_list > 0) { - if (isset($notification_lists[$notify_list])) { - $emails = explode(',', $notification_lists[$notify_list]); - monitor_addemails($reboot_emails, $emails, $host_id); - } - } -} - -function monitor_uptime_checker() { - monitor_debug('Checking for Uptime of Devices'); - - $start = date('Y-m-d H:i:s'); - - $reboot_emails = []; - - $alert_email = read_config_option('alert_email'); - - if ($alert_email != '') { - $alert_emails = explode(',', $alert_email); - } else { - $alert_emails = []; - } - - // Remove unneeded device records in associated tables - $removed_hosts = db_fetch_assoc('SELECT mu.host_id - FROM plugin_monitor_uptime AS mu - LEFT JOIN host AS h - ON h.id = mu.host_id - WHERE h.id IS NULL'); - - if (cacti_sizeof($removed_hosts)) { - db_execute('DELETE mu - FROM plugin_monitor_uptime AS mu - LEFT JOIN host AS h - ON h.id = mu.host_id - WHERE h.id IS NULL'); - } - - $removed_hosts = db_fetch_assoc('SELECT mu.host_id - FROM plugin_monitor_reboot_history AS mu - LEFT JOIN host AS h - ON h.id = mu.host_id - WHERE h.id IS NULL'); - - if (cacti_sizeof($removed_hosts)) { - db_execute('DELETE mu - FROM plugin_monitor_reboot_history AS mu - LEFT JOIN host AS h - ON h.id = mu.host_id - WHERE h.id IS NULL'); - } - - // Get the rebooted devices - $rebooted_hosts = db_fetch_assoc('SELECT h.id, h.description, - h.hostname, h.snmp_sysUpTimeInstance, mu.uptime - FROM host AS h - LEFT JOIN plugin_monitor_uptime AS mu - ON h.id = mu.host_id - WHERE h.snmp_version > 0 - AND status IN (2,3) - AND h.deleted = "" - AND h.monitor = "on" - AND (mu.uptime IS NULL OR mu.uptime > h.snmp_sysUpTimeInstance) - AND h.snmp_sysUpTimeInstance > 0'); - - if (cacti_sizeof($rebooted_hosts)) { - $notification_lists = array_rekey( - db_fetch_assoc('SELECT id, emails - FROM plugin_notification_lists - ORDER BY id'), - 'id', 'emails' - ); - - $monitor_list = read_config_option('monitor_list'); - $monitor_thold = read_config_option('monitor_reboot_thold'); - - foreach ($rebooted_hosts as $host) { - db_execute_prepared('INSERT INTO plugin_monitor_reboot_history - (host_id, reboot_time) - VALUES (?, ?)', - [$host['id'], date('Y-m-d H:i:s', time() - intval($host['snmp_sysUpTimeInstance']))]); - - monitor_addnotificationlist($reboot_emails, $monitor_list, $host['id'], $notification_lists); - - if ($monitor_thold == 'on') { - $notify = db_fetch_row_prepared('SELECT thold_send_email, thold_host_email - FROM host - WHERE id = ?', - [$host['id']]); - - if (cacti_sizeof($notify)) { - switch($notify['thold_send_email']) { - case '0': // Disabled - break; - case '1': // Global List - monitor_addemails($reboot_emails, $alert_emails, $host['id']); - - break; - case '2': // Nofitication List - monitor_addnotificationlist($reboot_emails, $notify['thold_host_email'], - $host['id'], $notification_lists); - - break; - case '3': // Both Global and Nofication list - monitor_addemails($reboot_emails, $alert_emails, $host['id']); - monitor_addnotificationlist($reboot_emails, $notify['thold_host_email'], - $host['id'], $notification_lists); - - break; - } - } - } - } - - $monitor_send_one_email = read_config_option('monitor_send_one_email'); - $to_email = ''; - - if (cacti_sizeof($reboot_emails)) { - foreach ($reboot_emails as $email => $hosts) { - if ($email != '') { - $to_email .= ($to_email != '' ? ',' : '') . $email; - - if ($monitor_send_one_email !== 'on') { - monitor_debug('Processing the Email address: ' . $email); - process_reboot_email($email, $hosts); - } - } else { - monitor_debug('Unable to process reboot notification due to empty Email address.'); - } - } - - if ($monitor_send_one_email == 'on') { - monitor_debug('Processing the Email address: ' . $to_email); - process_reboot_email($to_email, $hosts); - } - } - } - - // Freshen the uptimes - db_execute('REPLACE INTO plugin_monitor_uptime - (host_id, uptime) - SELECT id, snmp_sysUpTimeInstance - FROM host - WHERE snmp_version > 0 - AND status IN(2,3) - AND deleted = "" - AND monitor = "on" - AND snmp_sysUpTimeInstance > 0'); - - // Log Recently Down - db_execute('INSERT IGNORE INTO plugin_monitor_notify_history - (host_id, notify_type, notification_time, notes) - SELECT h.id, "3" AS notify_type, status_fail_date AS notification_time, status_last_error AS notes - FROM host AS h - WHERE status = 1 - AND deleted = "" - AND monitor = "on" - AND status_event_count = 1'); - - $recent = db_affected_rows(); - - return [cacti_sizeof($rebooted_hosts), $recent]; -} - -function process_reboot_email($email, $hosts) { - monitor_debug("Reboot Processing for $email starting"); - - $body_txt = ''; - - $body = '
| ' . __('Description', 'monitor') . ' | ' . - '' . __('Hostname', 'monitor') . ' | ' . PHP_EOL; - - $body .= '
|---|---|
| ' . $host['description'] . ' | ' . - '' . $host['hostname'] . ' | ' . - '
', $body, $output) . PHP_EOL;
-
- if (strpos($output, '
') !== false) {
- $toutput = str_replace('
', $body_txt, $output) . PHP_EOL;
- } else {
- $toutput = $body_txt;
- }
-
- if (read_config_option('monitor_reboot_notify') == 'on') {
- $report_tag = '';
- $theme = 'modern';
-
- monitor_debug('Loading Format File');
-
- $format_ok = reports_load_format_file(read_config_option('monitor_format_file'), $output, $report_tag, $theme);
-
- monitor_debug('Format File Loaded, Format is ' . ($format_ok ? 'Ok' : 'Not Ok') . ', Report Tag is ' . $report_tag);
-
- if ($format_ok) {
- if ($report_tag) {
- $output = str_replace('', $body, $output);
- } else {
- $output = $output . PHP_EOL . $body;
- }
- } else {
- $output = $body;
- }
-
- monitor_debug('HTML Processed');
-
- if (defined('CACTI_VERSION')) {
- $version = CACTI_VERSION;
- } else {
- $version = get_cacti_version();
- }
-
- $headers['User-Agent'] = 'Cacti-Monitor-v' . $version;
-
- $status = 'Reboot Notifications';
-
- process_send_email($email, $subject, $output, $toutput, $headers, $status);
- }
-}
-
-function process_email($email, $lists, $global_list, $notify_list) {
- global $config;
-
- monitor_debug('Into Processing');
-
- $alert_hosts = [];
- $warn_hosts = [];
-
- $criticalities = [
- 0 => __('Disabled', 'monnitor'),
- 1 => __('Low', 'monnitor'),
- 2 => __('Medium', 'monnitor'),
- 3 => __('High', 'monnitor'),
- 4 => __('Mission Critical', 'monnitor')
- ];
-
- foreach ($lists as $list) {
- switch($list) {
- case 'global':
- $hosts = [];
-
- if (isset($global_list['alert'])) {
- $alert_hosts += explode(',', $global_list['alert']);
- }
-
- if (isset($global_list['warn'])) {
- $warn_hosts += explode(',', $global_list['warn']);
- }
-
- break;
- default:
- if (isset($notify_list[$list]['alert'])) {
- $alert_hosts = explode(',', $notify_list[$list]['alert']);
- }
-
- if (isset($notify_list[$list]['warn'])) {
- $warn_hosts = explode(',', $notify_list[$list]['warn']);
- }
-
- break;
- }
- }
-
- monitor_debug('Lists Processed');
-
- if (cacti_sizeof($alert_hosts)) {
- $alert_hosts = array_unique($alert_hosts, SORT_NUMERIC);
-
- log_messages('alert', $alert_hosts);
- }
-
- if (cacti_sizeof($warn_hosts)) {
- $warn_hosts = array_unique($warn_hosts, SORT_NUMERIC);
-
- log_messages('warn', $alert_hosts);
- }
-
- monitor_debug('Found ' . sizeof($alert_hosts) . ' Alert Hosts, and ' . sizeof($warn_hosts) . ' Warn Hosts');
-
- if (cacti_sizeof($alert_hosts) || sizeof($warn_hosts)) {
- monitor_debug('Formatting Email');
-
- $freq = read_config_option('monitor_resend_frequency');
- $subject = __('Cacti Monitor Plugin Ping Threshold Notification', 'monitor');
-
- $body = '' . PHP_EOL;
- $body .= '
' . PHP_EOL;
- }
-
- if (cacti_sizeof($warn_hosts)) {
- $body .= '' . PHP_EOL;
- $body .= '
' . PHP_EOL;
- }
-
- $output = '';
- $toutput = $body_txt;
- $report_tag = '';
- $theme = 'modern';
-
- monitor_debug('Loading Format File');
-
- $format_ok = reports_load_format_file(read_config_option('monitor_format_file'), $output, $report_tag, $theme);
-
- monitor_debug('Format File Loaded, Format is ' . ($format_ok ? 'Ok' : 'Not Ok') . ', Report Tag is ' . $report_tag);
-
- if ($format_ok) {
- if ($report_tag) {
- $output = str_replace('', $body, $output);
- } else {
- $output = $output . PHP_EOL . $body;
- }
- } else {
- $output = $body;
- }
-
- monitor_debug('HTML Processed');
-
- if (defined('CACTI_VERSION')) {
- $version = CACTI_VERSION;
- } else {
- $version = get_cacti_version();
- }
-
- $headers['User-Agent'] = 'Cacti-Monitor-v' . $version;
-
- $status = (cacti_sizeof($alert_hosts) ? sizeof($alert_hosts) . ' Alert Notifications' : '') .
- (cacti_sizeof($warn_hosts) ? (cacti_sizeof($alert_hosts) ? ', and ' : '') .
- sizeof($warn_hosts) . ' Warning Notifications' : '');
-
- process_send_email($email, $subject, $output, $toutput, $headers, $status);
- }
-}
-
-function process_send_email($email, $subject, $output, $toutput, $headers, $status) {
- $from_email = read_config_option('monitor_fromemail');
-
- if ($from_email == '') {
- $from_email = read_config_option('settings_from_email');
-
- if ($from_email == '') {
- $from_email = 'Cacti@cacti.net';
- }
- }
-
- $from_name = read_config_option('monitor_fromname');
-
- if ($from_name != '') {
- $from_name = read_config_option('settings_from_name');
-
- if ($from_name == '') {
- $from_name = 'Cacti Reporting';
- }
- }
-
- $html = true;
-
- if (read_config_option('thold_send_text_only') == 'on') {
- $output = monitor_text($toutput);
- $html = false;
- }
-
- monitor_debug("Sending Email to '$email' for $status");
-
- $error = mailer(
- [$from_email, $from_name],
- $email,
- '',
- '',
- '',
- $subject,
- $output,
- monitor_text($toutput),
- null,
- $headers,
- $html
- );
-
- monitor_debug("The return from the mailer was '$error'");
-
- if (strlen($error)) {
- cacti_log("WARNING: Monitor had problems sending to '$email' for $status. The error was '$error'", false, 'MONITOR');
- } else {
- cacti_log("NOTICE: Email Notification Sent to '$email' for $status.", false, 'MONITOR');
- }
-}
-
-function monitor_text($output) {
- $output = explode(PHP_EOL, $output);
-
- $new_output = '';
-
- if (cacti_sizeof($output)) {
- foreach ($output as $line) {
- $line = str_replace('
', PHP_EOL, $line); - $line = str_replace('
', PHP_EOL, $line); - $line = trim(strip_tags($line)); - $new_output .= $line . PHP_EOL; - } - } - - return $new_output; -} - -function log_messages($type, $alert_hosts) { - global $start_date; - - static $processed = []; - - if ($type == 'warn') { - $type = '0'; - $column = 'monitor_warn'; - } elseif ($type == 'alert') { - $type = '1'; - $column = 'monitor_alert'; - } - - foreach ($alert_hosts as $id) { - if (!isset($processed[$id])) { - db_execute_prepared("INSERT INTO plugin_monitor_notify_history - (host_id, notify_type, ping_time, ping_threshold, notification_time) - SELECT id, '$type' AS notify_type, cur_time, $column, '$start_date' AS notification_time - FROM host - WHERE deleted = '' - AND monitor = 'on' - AND id = ?", - [$id]); - } - - $processed[$id] = true; - } -} - -function get_hosts_by_list_type($type, $criticality, &$global_list, &$notify_list, &$lists) { - global $force; - - $last_time = date('Y-m-d H:i:s', time() - read_config_option('monitor_resend_frequency') * 60); - - $hosts = db_fetch_cell_prepared("SELECT COUNT(*) - FROM host - WHERE status = 3 - AND deleted = '' - AND monitor = 'on' - AND thold_send_email > 0 - AND monitor_criticality >= ? - AND cur_time > monitor_$type", - [$criticality]); - - if ($type == 'warn') { - $htype = 1; - } else { - $htype = 0; - } - - if ($hosts > 0) { - $groups = db_fetch_assoc_prepared("SELECT - thold_send_email, thold_host_email, GROUP_CONCAT(host.id) AS id - FROM host - LEFT JOIN ( - SELECT host_id, MAX(notification_time) AS notification_time - FROM plugin_monitor_notify_history - WHERE notify_type = ? - GROUP BY host_id - ) AS nh - ON host.id=nh.host_id - WHERE status = 3 - AND deleted = '' - AND monitor = 'on' - AND thold_send_email > 0 - AND monitor_criticality >= ? - AND cur_time > monitor_$type " . ($type == 'warn' ? ' AND cur_time < monitor_alert' : '') . ' - AND (notification_time < ? OR notification_time IS NULL) - AND host.total_polls > 1 - GROUP BY thold_host_email, thold_send_email - ORDER BY thold_host_email, thold_send_email', - [$htype, $criticality, $last_time]); - - if (cacti_sizeof($groups)) { - foreach ($groups as $entry) { - switch($entry['thold_send_email']) { - case '1': // Global List - $global_list[$type][] = $entry; - - break; - case '2': // Notification List - if ($entry['thold_host_email'] > 0) { - $notify_list[$type][$entry['thold_host_email']][] = $entry; - $lists[$entry['thold_host_email']] = $entry['thold_host_email']; - } - - break; - case '3': // Both Notification and Global - $global_list[$type][] = $entry; - - if ($entry['thold_host_email'] > 0) { - $notify_list[$type][$entry['thold_host_email']][] = $entry; - $lists[$entry['thold_host_email']] = $entry['thold_host_email']; - } - - break; - } - } - } - } -} - -function flatten_lists(&$global_list, &$notify_list) { - if (cacti_sizeof($global_list)) { - foreach ($global_list as $severity => $list) { - foreach ($list as $item) { - $new_global[$severity] = (isset($new_global[$severity]) ? $new_global[$severity] . ',' : '') . $item['id']; - } - } - $global_list = $new_global; - } - - if (cacti_sizeof($notify_list)) { - foreach ($notify_list as $severity => $lists) { - foreach ($lists as $id => $list) { - foreach ($list as $item) { - $new_list[$severity][$id] = (isset($new_list[$severity][$id]) ? $new_list[$severity][$id] . ',' : '') . $item['id']; - } - } - } - $notify_list = $new_list; - } -} - -function get_emails_and_lists($lists) { - $notification_emails = []; - - $alert_email = read_config_option('alert_email'); - - if ($alert_email != '') { - $global_emails = explode(',', $alert_email); - } else { - $global_emails = []; - } - - if (cacti_sizeof($global_emails)) { - foreach ($global_emails as $index => $user) { - if (trim($user) != '') { - $notification_emails[trim($user)]['global'] = true; - } - } - } - - if (cacti_sizeof($lists)) { - $list_emails = db_fetch_assoc('SELECT id, emails - FROM plugin_notification_lists - WHERE id IN (' . implode(',', $lists) . ')'); - - if (cacti_sizeof($list_emails)) { - foreach ($list_emails as $email) { - $emails = explode(',', $email['emails']); - - foreach ($emails as $user) { - if (trim($user) != '') { - $notification_emails[trim($user)][$email['id']] = true; - } - } - } - } - } - - return $notification_emails; -} - -function purge_event_records() { - // Purge old records - $days = read_config_option('monitor_log_storage'); - - if (empty($days)) { - $days = 120; - } - - db_execute_prepared('DELETE FROM plugin_monitor_notify_history - WHERE notification_time < FROM_UNIXTIME(UNIX_TIMESTAMP() - (? * 86400))', - [$days]); - - $purge_n = db_affected_rows(); - - db_execute_prepared('DELETE FROM plugin_monitor_reboot_history - WHERE log_time < FROM_UNIXTIME(UNIX_TIMESTAMP() - (? * 86400))', - [$days]); - - $purge_r = db_affected_rows(); - - return [$purge_n, $purge_r]; -} - -function monitor_debug($message) { - global $debug; - - if ($debug) { - print trim($message) . PHP_EOL; - } -} - -function display_version() { - global $config; - - if (!function_exists('plugin_monitor_version')) { - include_once($config['base_path'] . '/plugins/monitor/setup.php'); - } - - $info = plugin_monitor_version(); - print 'Cacti Monitor Poller, Version ' . $info['version'] . ', ' . COPYRIGHT_YEARS . PHP_EOL; -} - -/* - * display_help - * displays the usage of the function - */ -function display_help() { - display_version(); - - print PHP_EOL; - print 'usage: poller_monitor.php [--force] [--debug]' . PHP_EOL . PHP_EOL; - print ' --force - force execution, e.g. for testing' . PHP_EOL; - print ' --debug - debug execution, e.g. for testing' . PHP_EOL . PHP_EOL; -} diff --git a/setup.php b/setup.php index 8304a92..f939999 100644 --- a/setup.php +++ b/setup.php @@ -1,4 +1,6 @@ __('Any', 'monitor'), - '0' => __('None', 'monitor'), - '1' => __('Low', 'monitor'), - '2' => __('Medium', 'monitor'), - '3' => __('High', 'monitor'), - '4' => __('Mission Critical', 'monitor') - ]; - - $filters['criticality'] = [ - 'friendly_name' => __('Criticality', 'monitor'), - 'method' => 'drop_array', - 'filter' => FILTER_VALIDATE_INT, - 'pageset' => true, - 'default' => '-1', - 'array' => $criticalities, - 'value' => '-1' - ]; - - return $filters; +/** + * Determine whether current runtime satisfies plugin PHP requirement. + * + * @return bool + */ +function monitorHasSupportedPhpVersion(): bool +{ + return version_compare(PHP_VERSION, monitorGetMinimumPhpVersion(), '>='); } -function monitor_device_sql_where($sql_where) { - if (get_request_var('criticality') >= 0) { - $sql_where .= ($sql_where != '' ? ' AND ' : 'WHERE ') . ' monitor_criticality = ' . get_request_var('criticality'); - } +/** + * Enforce plugin minimum PHP version and optionally raise a UI message. + * + * @param bool $raise_message Whether to raise a Cacti UI error message. + * + * @return bool + */ +function monitorEnsureSupportedPhpVersion(bool $raise_message = true): bool +{ + if (monitorHasSupportedPhpVersion()) { + return true; + } + + $message = sprintf( + 'Monitor plugin requires PHP %s or newer. Current runtime: %s', + monitorGetMinimumPhpVersion(), + PHP_VERSION + ); + + cacti_log($message, false, 'MONITOR'); + + if ($raise_message) { + raise_message('monitor_php_version', $message, MESSAGE_LEVEL_ERROR); + } + + return false; +} - return $sql_where; +/** + * Register monitor plugin hooks, realm, defaults, and schema. + * + * @return void + */ +function pluginMonitorInstall(): void +{ + if (!monitorEnsureSupportedPhpVersion()) { + return; + } + + // core plugin functionality + api_plugin_register_hook('monitor', 'top_header_tabs', 'monitorShowTab', 'setup.php'); + api_plugin_register_hook('monitor', 'top_graph_header_tabs', 'monitorShowTab', 'setup.php'); + api_plugin_register_hook('monitor', 'top_graph_refresh', 'monitorTopGraphRefresh', 'setup.php'); + + api_plugin_register_hook('monitor', 'draw_navigation_text', 'monitorDrawNavigationText', 'setup.php'); + api_plugin_register_hook('monitor', 'config_form', 'monitorConfigForm', 'setup.php'); + api_plugin_register_hook('monitor', 'config_settings', 'monitorConfigSettings', 'setup.php'); + api_plugin_register_hook('monitor', 'config_arrays', 'monitorConfigArrays', 'setup.php'); + api_plugin_register_hook('monitor', 'poller_bottom', 'monitorPollerBottom', 'setup.php'); + api_plugin_register_hook('monitor', 'page_head', 'pluginMonitorPageHead', 'setup.php'); + + // device actions and interaction + api_plugin_register_hook('monitor', 'api_device_save', 'monitorApiDeviceSave', 'setup.php'); + api_plugin_register_hook('monitor', 'device_action_array', 'monitorDeviceActionArray', 'setup.php'); + api_plugin_register_hook('monitor', 'device_action_execute', 'monitorDeviceActionExecute', 'setup.php'); + api_plugin_register_hook('monitor', 'device_action_prepare', 'monitorDeviceActionPrepare', 'setup.php'); + api_plugin_register_hook('monitor', 'device_remove', 'monitorDeviceRemove', 'setup.php'); + + // add new filter for device + api_plugin_register_hook('monitor', 'device_filters', 'monitorDeviceFilters', 'setup.php'); + api_plugin_register_hook('monitor', 'device_sql_where', 'monitorDeviceSqlWhere', 'setup.php'); + api_plugin_register_hook('monitor', 'device_table_bottom', 'monitorDeviceTableBottom', 'setup.php'); + + api_plugin_register_realm('monitor', 'monitor.php', 'View Monitoring Dashboard', 1); + + set_config_option('monitor_view', 'default'); + set_config_option('monitor_grouping', 'default'); + set_config_option('monitor_trim', '4000'); + set_config_option('monitor_rows', 100); + + monitorSetupTable(); } -function monitor_device_table_bottom() { - $criticalities = [ - '-1' => __('Any', 'monitor'), - '0' => __('None', 'monitor'), - '1' => __('Low', 'monitor'), - '2' => __('Medium', 'monitor'), - '3' => __('High', 'monitor'), - '4' => __('Mission Critical', 'monitor') - ]; - - if (version_compare(CACTI_VERSION, '1.3.0', '<')) { - $select = '' . __('Criticality') . ' ' . __('Criticality') . '
+/**
+ * Render confirmation/edit UI for monitor-specific bulk device actions.
+ *
+ * @param array $save Bulk action context payload.
+ *
+ * @return array
+ */
+function monitorDeviceActionPrepare(array $save): array
+{
+ global $host_list, $fields_host_edit;
+
+ if (!isset($save['drp_action'])) {
+ return $save;
+ } else {
+ $action = $save['drp_action'];
+
+ if ($action != 'monitor_enable' && $action != 'monitor_disable' && $action != 'monitor_settings') {
+ return $save;
+ }
+
+ if ($action == 'monitor_enable' || $action == 'monitor_disable') {
+ if ($action == 'monitor_enable') {
+ $action_description = 'enable';
+ } elseif ($action == 'monitor_disable') {
+ $action_description = 'disable';
+ }
+
+ print "
';
- } else {
- print "
+ } else {
+ print "
';
- $form_array = [];
- $fields = [
- 'monitor',
- 'monitor_text',
- 'monitor_criticality',
- 'monitor_warn',
- 'monitor_alert',
- 'monitor_warn_baseline',
- 'monitor_alert_baseline',
- 'monitor_icon'
- ];
-
- foreach ($fields as $field) {
- $form_array += [$field => $fields_host_edit[$field]];
-
- $form_array[$field]['value'] = '';
- $form_array[$field]['form_id'] = 0;
- $form_array[$field]['sub_checkbox'] = [
- 'name' => 't_' . $field,
- 'friendly_name' => __('Update this Field', 'monitor'),
- 'value' => ''
- ];
- }
-
- draw_edit_form(
- [
- 'config' => ['no_form_tag' => true],
- 'fields' => $form_array
- ]
- );
- }
-
- return $save;
- }
+ $form_array = [];
+ $fields = [
+ 'monitor',
+ 'monitor_text',
+ 'monitor_criticality',
+ 'monitor_warn',
+ 'monitor_alert',
+ 'monitor_warn_baseline',
+ 'monitor_alert_baseline',
+ 'monitor_icon'
+ ];
+
+ foreach ($fields as $field) {
+ $form_array += [$field => $fields_host_edit[$field]];
+
+ $form_array[$field]['value'] = '';
+ $form_array[$field]['form_id'] = 0;
+ $form_array[$field]['sub_checkbox'] = [
+ 'name' => 't_' . $field,
+ 'friendly_name' => __('Update this Field', 'monitor'),
+ 'value' => ''
+ ];
+ }
+
+ draw_edit_form(
+ [
+ 'config' => ['no_form_tag' => true],
+ 'fields' => $form_array
+ ]
+ );
+ }
+
+ return $save;
+ }
}
-function monitor_device_action_array($device_action_array) {
- $device_action_array['monitor_settings'] = __('Change Monitoring Options', 'monitor');
- $device_action_array['monitor_enable'] = __('Enable Monitoring', 'monitor');
- $device_action_array['monitor_disable'] = __('Disable Monitoring', 'monitor');
-
- return $device_action_array;
+/**
+ * Register monitor-specific entries in device action dropdown.
+ *
+ * @param array $device_action_array Existing action map.
+ *
+ * @return array
+ */
+function monitorDeviceActionArray(array $device_action_array): array
+{
+ $device_action_array['monitor_settings'] = __('Change Monitoring Options', 'monitor');
+ $device_action_array['monitor_enable'] = __('Enable Monitoring', 'monitor');
+ $device_action_array['monitor_disable'] = __('Disable Monitoring', 'monitor');
+
+ return $device_action_array;
}
-function monitor_scan_dir() {
- global $config;
-
- $ext = ['.wav', '.mp3'];
- $d = dir($config['base_path'] . '/plugins/monitor/sounds/');
- $files = [];
-
- while (false !== ($entry = $d->read())) {
- if ($entry != '.' && $entry != '..' && in_array(strtolower(substr($entry,-4)),$ext, true)) {
- $files[$entry] = $entry;
- }
- }
- $d->close();
- asort($files); // sort the files
- array_unshift($files, 'None'); // prepend the None option
-
- return $files;
+/**
+ * Scan monitor sounds directory and return selectable alarm files.
+ *
+ * @return array
+ */
+function monitorScanDir(): array
+{
+ global $config;
+
+ $ext = ['.wav', '.mp3'];
+ $d = dir($config['base_path'] . '/plugins/monitor/sounds/');
+ $files = [];
+
+ while (false !== ($entry = $d->read())) {
+ if ($entry != '.' && $entry != '..' && in_array(strtolower(substr($entry, -4)), $ext, true)) {
+ $files[$entry] = $entry;
+ }
+ }
+ $d->close();
+ asort($files); // sort the files
+ array_unshift($files, 'None'); // prepend the None option
+
+ return $files;
}
-function monitor_config_settings() {
- global $tabs, $formats, $settings, $criticalities, $page_refresh_interval, $config, $settings_user, $tabs_graphs;
-
- include_once($config['base_path'] . '/lib/reports.php');
-
- if (get_nfilter_request_var('tab') == 'monitor') {
- $formats = reports_get_format_files();
- } elseif (empty($formats)) {
- $formats = [];
- }
-
- $criticalities = [
- 0 => __('Disabled', 'monitor'),
- 1 => __('Low', 'monitor'),
- 2 => __('Medium', 'monitor'),
- 3 => __('High', 'monitor'),
- 4 => __('Mission Critical', 'monitor')
- ];
-
- $log_retentions = [
- '-1' => __('Indefinitely', 'monitor'),
- '31' => __('%d Month', 1, 'monitor'),
- '62' => __('%d Months', 2, 'monitor'),
- '93' => __('%d Months', 3, 'monitor'),
- '124' => __('%d Months', 4, 'monitor'),
- '186' => __('%d Months', 6, 'monitor'),
- '365' => __('%d Year', 1, 'monitor')
- ];
-
- $font_sizes = [
- '20' => '20px',
- '30' => '30px',
- '40' => '40px',
- '50' => '50px',
- '60' => '60px',
- '70' => '70px'
- ];
-
- if (function_exists('auth_augment_roles')) {
- auth_augment_roles(__('Normal User'), ['monitor.php']);
- }
-
- $tabs_graphs += ['monitor' => __('Monitor Settings', 'monitor')];
-
- $settings_user += [
- 'monitor' => [
- 'monitor_sound' => [
- 'friendly_name' => __('Alarm Sound', 'monitor'),
- 'description' => __('This is the sound file that will be played when a Device goes down.', 'monitor'),
- 'method' => 'drop_array',
- 'array' => monitor_scan_dir(),
- 'default' => 'attn-noc.wav',
- ],
- 'monitor_sound_loop' => [
- 'friendly_name' => __('Loop Alarm Sound', 'monitor'),
- 'description' => __('Play the above sound on a loop when a Device goes down.', 'monitor'),
- 'method' => 'checkbox',
- ],
- 'monitor_legend' => [
- 'friendly_name' => __('Show Icon Legend', 'monitor'),
- 'description' => __('Check this to show an icon legend on the Monitor display', 'monitor'),
- 'method' => 'checkbox',
- ],
- 'monitor_uptime' => [
- 'friendly_name' => __('Show Uptime', 'monitor'),
- 'description' => __('Check this to show Uptime on the Monitor display', 'monitor'),
- 'method' => 'checkbox',
- ],
- 'monitor_error_zoom' => [
- 'friendly_name' => __('Zoom to Errors', 'monitor'),
- 'description' => __('Check this to zoom to errored items on the Monitor display', 'monitor'),
- 'method' => 'checkbox',
- ],
- 'monitor_error_background' => [
- 'friendly_name' => __('Zoom Background', 'monitor'),
- 'description' => __('Background Color for Zoomed Errors on the Monitor display', 'monitor'),
- 'method' => 'drop_color',
- ],
- 'monitor_error_fontsize' => [
- 'friendly_name' => __('Zoom Fontsize', 'monitor'),
- 'description' => __('Check this to zoom to errored items on the Monitor display', 'monitor'),
- 'method' => 'drop_array',
- 'default' => '50',
- 'array' => $font_sizes
- ]
- ]
- ];
-
- if (get_current_page() != 'settings.php') {
- return;
- }
-
- $tabs['monitor'] = __('Monitor', 'monitor');
-
- $temp = [
- 'monitor_header' => [
- 'friendly_name' => __('Monitor Settings', 'monitor'),
- 'method' => 'spacer',
- 'collapsible' => 'true'
- ],
- 'monitor_new_enabled' => [
- 'friendly_name' => __('Enable on new devices', 'monitor'),
- 'description' => __('Check this to automatically enable monitoring when creating new devices', 'monitor'),
- 'method' => 'checkbox',
- ],
- 'monitor_log_storage' => [
- 'friendly_name' => __('Notification/Reboot Log Retention', 'monitor'),
- 'description' => __('Keep Notification and Reboot Logs for this number of days.', 'monitor'),
- 'method' => 'drop_array',
- 'default' => '31',
- 'array' => $log_retentions
- ],
- 'monitor_sound' => [
- 'friendly_name' => __('Alarm Sound', 'monitor'),
- 'description' => __('This is the sound file that will be played when a Device goes down.', 'monitor'),
- 'method' => 'drop_array',
- 'array' => monitor_scan_dir(),
- 'default' => 'attn-noc.wav',
- ],
- 'monitor_sound_loop' => [
- 'friendly_name' => __('Loop Alarm Sound', 'monitor'),
- 'description' => __('Play the above sound on a loop when a Device goes down.', 'monitor'),
- 'method' => 'checkbox',
- ],
- 'monitor_refresh' => [
- 'friendly_name' => __('Refresh Interval', 'monitor'),
- 'description' => __('This is the time in seconds before the page refreshes. (1 - 300)', 'monitor'),
- 'method' => 'drop_array',
- 'default' => '60',
- 'array' => $page_refresh_interval
- ],
- 'monitor_legend' => [
- 'friendly_name' => __('Show Icon Legend', 'monitor'),
- 'description' => __('Check this to show an icon legend on the Monitor display', 'monitor'),
- 'method' => 'checkbox',
- ],
- 'monitor_grouping' => [
- 'friendly_name' => __('Grouping', 'monitor'),
- 'description' => __('This is how monitor will Group Devices.', 'monitor'),
- 'method' => 'drop_array',
- 'default' => 'default',
- 'array' => [
- 'default' => __('Default', 'monitor'),
- 'default_by_permissions' => __('Default with permissions', 'monitor'),
- 'group_by_tree' => __('Tree', 'monitor'),
- 'group_by_device_template' => __('Device Template', 'monitor'),
- ]
- ],
- 'monitor_view' => [
- 'friendly_name' => __('View', 'monitor'),
- 'description' => __('This is how monitor will render Devices.', 'monitor'),
- 'method' => 'drop_array',
- 'default' => 'default',
- 'array' => [
- 'default' => __('Default', 'monitor'),
- 'list' => __('List', 'monitor'),
- 'names' => __('Names only', 'monitor'),
- 'tiles' => __('Tiles', 'monitor'),
- 'tilesadt' => __('Tiles & Downtime', 'monitor')
- ]
- ],
- 'monitor_format_header' => [
- 'friendly_name' => __('Notification Report Format', 'monitor'),
- 'method' => 'spacer',
- 'collapsible' => 'true'
- ],
- 'monitor_format_file' => [
- 'friendly_name' => __('Format File to Use', 'monitor'),
- 'method' => 'drop_array',
- 'default' => 'default.format',
- 'description' => __('Choose the custom html wrapper and CSS file to use. This file contains both html and CSS to wrap around your report. If it contains more than simply CSS, you need to place a special tag inside of the file. This format tag will be replaced by the report content. These files are located in the \'formats\' directory.', 'monitor'),
- 'array' => $formats
- ],
- 'monitor_threshold' => [
- 'friendly_name' => __('Ping Threshold Notifications', 'monitor'),
- 'method' => 'spacer',
- 'collapsible' => 'true'
- ],
- 'monitor_warn_criticality' => [
- 'friendly_name' => __('Warning Latency Notification', 'monitor'),
- 'description' => __('If a Device has a Round Trip Ping Latency above the Warning Threshold and above the Criticality below, subscribing emails to the Device will receive an email notification. Select \'Disabled\' to Disable. The Thold Plugin is required to enable this feature.', 'monitor'),
- 'method' => 'drop_array',
- 'default' => '0',
- 'array' => $criticalities
- ],
- 'monitor_alert_criticality' => [
- 'friendly_name' => __('Alert Latency Notification', 'monitor'),
- 'description' => __('If a Device has a Round Trip Ping Latency above the Alert Threshold and above the Criticality below, subscribing emails to the Device will receive an email notification. Select \'Disabled\' to Disable. The Thold Plugin is required to enable this feature.', 'monitor'),
- 'method' => 'drop_array',
- 'default' => '0',
- 'array' => $criticalities
- ],
- 'monitor_resend_frequency' => [
- 'friendly_name' => __('How Often to Resend Emails', 'monitor'),
- 'description' => __('How often should emails notifications be sent to subscribers for these Devices if they are exceeding their latency thresholds', 'monitor'),
- 'method' => 'drop_array',
- 'default' => '0',
- 'array' => [
- '0' => __('Every Occurrence', 'monitor'),
- '20' => __('Every %d Minutes', 20, 'monitor'),
- '30' => __('Every %d Minutes', 30, 'monitor'),
- '60' => __('Every Hour', 'monitor'),
- '120' => __('Every %d Hours', 2, 'monitor'),
- '240' => __('Every %d Hours', 4, 'monitor')
- ]
- ],
- 'monitor_reboot' => [
- 'friendly_name' => __('Reboot Notifications', 'monitor'),
- 'method' => 'spacer',
- 'collapsible' => 'true'
- ],
- 'monitor_reboot_notify' => [
- 'friendly_name' => __('Send Reboot Notifications', 'monitor'),
- 'method' => 'checkbox',
- 'description' => __('Should Device Reboot Notifications be sent to users?', 'monitor'),
- 'default' => 'on',
- ],
- 'monitor_send_one_email' => [
- 'friendly_name' => __('Send one Email to all addresses', 'monitor'),
- 'description' => __('If checked, the system will send one Email only to all addresses.', 'monitor'),
- 'method' => 'checkbox',
- 'default' => 'on'
- ],
- 'monitor_reboot_thold' => [
- 'friendly_name' => __('Include Threshold Alert Lists', 'monitor'),
- 'method' => 'checkbox',
- 'description' => __('Should Threshold Alert Lists also receive Notification', 'monitor'),
- 'default' => 'on',
- ],
- 'monitor_subject' => [
- 'friendly_name' => __('Subject', 'monitor'),
- 'description' => __('Enter a Reboot message subject for the Reboot Notification.', 'monitor'),
- 'method' => 'textbox',
- 'default' => __('Cacti Device Reboot Notification', 'monitor'),
- 'size' => 60,
- 'max_length' => 60
- ],
- 'monitor_body' => [
- 'friendly_name' => __('Email Body', 'monitor'),
- 'description' => __('Enter an Email body to include in the Reboot Notification message. Currently, the only supported replacement tag accepted is <DETAILS>', 'monitor'),
- 'method' => 'textarea',
- 'textarea_rows' => 4,
- 'textarea_cols' => 80,
- 'default' => __('
' . __('Cacti Monitor Plugin Ping Threshold Notification', 'monitor') . '
' . PHP_EOL; - $body_txt = __('Cacti Monitor Plugin Ping Threshold Notification', 'monitor') . PHP_EOL; - - $body .= '' . __('The following report will identify Devices that have eclipsed their ping latency thresholds. You are receiving this report since you are subscribed to a Device associated with the Cacti system located at the following URL below.') . '
' . PHP_EOL; - - $body_txt .= __('The following report will identify Devices that have eclipsed their ping latency thresholds. You are receiving this report since you are subscribed to a Device associated with the Cacti system located at the following URL below.') . PHP_EOL; - - $body .= 'Cacti Monitoring Site
' . PHP_EOL; - - $body_txt .= __('Cacti Monitoring Site', 'monitor') . PHP_EOL; - - if ($freq > 0) { - $body .= '' . __('You will receive notifications every %d minutes if the Device is above its threshold.', $freq, 'monitor') . '
' . PHP_EOL; - - $body_txt .= __('You will receive notifications every %d minutes if the Device is above its threshold.', $freq, 'monitor') . PHP_EOL; - } else { - $body .= '' . __('You will receive notifications every time the Device is above its threshold.', 'monitor') . '
' . PHP_EOL; - - $body_txt .= __('You will receive notifications every time the Device is above its threshold.', 'monitor') . PHP_EOL; - } - - if (cacti_sizeof($alert_hosts)) { - $body .= '' . __('The following Devices have breached their Alert Notification Threshold.', 'monitor') . '
' . PHP_EOL; - - $body_txt .= __('The following Devices have breached their Alert Notification Threshold.', 'monitor') . PHP_EOL; - - $body .= '| ' . __('Hostname', 'monitor') . ' | ' . - '' . __('Criticality', 'monitor') . ' | ' . - '' . __('Alert Ping', 'monitor') . ' | ' . - '' . __('Current Ping', 'monitor') . ' | ' . PHP_EOL; - - $body_txt .= - __('Hostname', 'monitor') . "\t" . - __('Criticality', 'monitor') . "\t" . - __('Alert Ping', 'monitor') . "\t" . - __('Current Ping', 'monitor') . PHP_EOL; - - $body .= '
|---|---|---|---|
| ' . $host['description'] . ' | ' . PHP_EOL; - - $body .= '' . $criticalities[$host['monitor_criticality']] . ' | ' . PHP_EOL; - $body .= '' . number_format_i18n($host['monitor_alert'],2) . ' ms | ' . PHP_EOL; - $body .= '' . number_format_i18n($host['cur_time'],2) . ' ms | ' . PHP_EOL; - - $body_txt .= - $host['description'] . "\t" . - $criticalities[$host['monitor_criticality']] . "\t" . - number_format_i18n($host['monitor_alert'],2) . " ms\t" . - number_format_i18n($host['cur_time'],2) . ' ms' . PHP_EOL; - - $body .= '
' . __('The following Devices have breached their Warning Notification Threshold.', 'monitor') . '
' . PHP_EOL; - - $body_txt .= __('The following Devices have breached their Warning Notification Threshold.', 'monitor') . PHP_EOL; - - $body .= '| ' . __('Hostname', 'monitor') . ' | ' . - '' . __('Criticality', 'monitor') . ' | ' . - '' . __('Alert Ping', 'monitor') . ' | ' . - '' . __('Current Ping', 'monitor') . ' | ' . PHP_EOL; - - $body_txt .= - __('Hostname', 'monitor') . "\t" . - __('Criticality', 'monitor') . "\t" . - __('Alert Ping', 'monitor') . "\t" . - __('Current Ping', 'monitor') . PHP_EOL; - - $body .= '
|---|---|---|---|
| ' . $host['description'] . ' | ' . PHP_EOL; - - $body .= '' . $criticalities[$host['monitor_criticality']] . ' | ' . PHP_EOL; - $body .= '' . number_format_i18n($host['monitor_warn'],2) . ' ms | ' . PHP_EOL; - $body .= '' . number_format_i18n($host['cur_time'],2) . ' ms | ' . PHP_EOL; - - $body_txt .= - $host['description'] . "\t" . - $criticalities[$host['monitor_criticality']] . "\t" . - number_format_i18n($host['monitor_alert'],2) . " ms\t" . - number_format_i18n($host['cur_time'],2) . ' ms' . PHP_EOL; - - $body .= '
', PHP_EOL, $line); - $line = str_replace('
', PHP_EOL, $line); - $line = trim(strip_tags($line)); - $new_output .= $line . PHP_EOL; - } - } - - return $new_output; -} - -function log_messages($type, $alert_hosts) { - global $start_date; - - static $processed = []; - - if ($type == 'warn') { - $type = '0'; - $column = 'monitor_warn'; - } elseif ($type == 'alert') { - $type = '1'; - $column = 'monitor_alert'; - } - - foreach ($alert_hosts as $id) { - if (!isset($processed[$id])) { - db_execute_prepared("INSERT INTO plugin_monitor_notify_history - (host_id, notify_type, ping_time, ping_threshold, notification_time) - SELECT id, '$type' AS notify_type, cur_time, $column, '$start_date' AS notification_time - FROM host - WHERE deleted = '' - AND monitor = 'on' - AND id = ?", - [$id]); - } - - $processed[$id] = true; - } -} - -function get_hosts_by_list_type($type, $criticality, &$global_list, &$notify_list, &$lists) { - global $force; - - $last_time = date('Y-m-d H:i:s', time() - read_config_option('monitor_resend_frequency') * 60); - - $hosts = db_fetch_cell_prepared("SELECT COUNT(*) - FROM host - WHERE status = 3 - AND deleted = '' - AND monitor = 'on' - AND thold_send_email > 0 - AND monitor_criticality >= ? - AND cur_time > monitor_$type", - [$criticality]); - - if ($type == 'warn') { - $htype = 1; - } else { - $htype = 0; - } - - if ($hosts > 0) { - $groups = db_fetch_assoc_prepared("SELECT - thold_send_email, thold_host_email, GROUP_CONCAT(host.id) AS id - FROM host - LEFT JOIN ( - SELECT host_id, MAX(notification_time) AS notification_time - FROM plugin_monitor_notify_history - WHERE notify_type = ? - GROUP BY host_id - ) AS nh - ON host.id=nh.host_id - WHERE status = 3 - AND deleted = '' - AND monitor = 'on' - AND thold_send_email > 0 - AND monitor_criticality >= ? - AND cur_time > monitor_$type " . ($type == 'warn' ? ' AND cur_time < monitor_alert' : '') . ' - AND (notification_time < ? OR notification_time IS NULL) - AND host.total_polls > 1 - GROUP BY thold_host_email, thold_send_email - ORDER BY thold_host_email, thold_send_email', - [$htype, $criticality, $last_time]); - - if (cacti_sizeof($groups)) { - foreach ($groups as $entry) { - switch($entry['thold_send_email']) { - case '1': // Global List - $global_list[$type][] = $entry; - - break; - case '2': // Notification List - if ($entry['thold_host_email'] > 0) { - $notify_list[$type][$entry['thold_host_email']][] = $entry; - $lists[$entry['thold_host_email']] = $entry['thold_host_email']; - } - - break; - case '3': // Both Notification and Global - $global_list[$type][] = $entry; - - if ($entry['thold_host_email'] > 0) { - $notify_list[$type][$entry['thold_host_email']][] = $entry; - $lists[$entry['thold_host_email']] = $entry['thold_host_email']; - } - - break; - } - } - } - } -} - -function flatten_lists(&$global_list, &$notify_list) { - if (cacti_sizeof($global_list)) { - foreach ($global_list as $severity => $list) { - foreach ($list as $item) { - $new_global[$severity] = (isset($new_global[$severity]) ? $new_global[$severity] . ',' : '') . $item['id']; - } - } - $global_list = $new_global; - } - - if (cacti_sizeof($notify_list)) { - foreach ($notify_list as $severity => $lists) { - foreach ($lists as $id => $list) { - foreach ($list as $item) { - $new_list[$severity][$id] = (isset($new_list[$severity][$id]) ? $new_list[$severity][$id] . ',' : '') . $item['id']; - } - } - } - $notify_list = $new_list; - } -} - -function get_emails_and_lists($lists) { - $notification_emails = []; - - $alert_email = read_config_option('alert_email'); - - if ($alert_email != '') { - $global_emails = explode(',', $alert_email); - } else { - $global_emails = []; - } - - if (cacti_sizeof($global_emails)) { - foreach ($global_emails as $index => $user) { - if (trim($user) != '') { - $notification_emails[trim($user)]['global'] = true; - } - } - } - - if (cacti_sizeof($lists)) { - $list_emails = db_fetch_assoc('SELECT id, emails - FROM plugin_notification_lists - WHERE id IN (' . implode(',', $lists) . ')'); - - if (cacti_sizeof($list_emails)) { - foreach ($list_emails as $email) { - $emails = explode(',', $email['emails']); - - foreach ($emails as $user) { - if (trim($user) != '') { - $notification_emails[trim($user)][$email['id']] = true; - } - } - } - } - } - - return $notification_emails; -} - -function purge_event_records() { - // Purge old records - $days = read_config_option('monitor_log_storage'); - - if (empty($days)) { - $days = 120; - } - - db_execute_prepared('DELETE FROM plugin_monitor_notify_history - WHERE notification_time < FROM_UNIXTIME(UNIX_TIMESTAMP() - (? * 86400))', - [$days]); - - $purge_n = db_affected_rows(); - - db_execute_prepared('DELETE FROM plugin_monitor_reboot_history - WHERE log_time < FROM_UNIXTIME(UNIX_TIMESTAMP() - (? * 86400))', - [$days]); - - $purge_r = db_affected_rows(); - - return [$purge_n, $purge_r]; -} - -function monitor_debug($message) { - global $debug; - - if ($debug) { - print trim($message) . PHP_EOL; - } -} - -function display_version() { - global $config; - - if (!function_exists('plugin_monitor_version')) { - include_once($config['base_path'] . '/plugins/monitor/setup.php'); - } - - $info = plugin_monitor_version(); - print 'Cacti Monitor Poller, Version ' . $info['version'] . ', ' . COPYRIGHT_YEARS . PHP_EOL; -} - -/* - * display_help - * displays the usage of the function - */ -function display_help() { - display_version(); - - print PHP_EOL; - print 'usage: poller_monitor.php [--force] [--debug]' . PHP_EOL . PHP_EOL; - print ' --force - force execution, e.g. for testing' . PHP_EOL; - print ' --debug - debug execution, e.g. for testing' . PHP_EOL . PHP_EOL; -} diff --git a/setup.php b/setup.php index 8304a92..f939999 100644 --- a/setup.php +++ b/setup.php @@ -1,4 +1,6 @@ __('Any', 'monitor'), - '0' => __('None', 'monitor'), - '1' => __('Low', 'monitor'), - '2' => __('Medium', 'monitor'), - '3' => __('High', 'monitor'), - '4' => __('Mission Critical', 'monitor') - ]; - - $filters['criticality'] = [ - 'friendly_name' => __('Criticality', 'monitor'), - 'method' => 'drop_array', - 'filter' => FILTER_VALIDATE_INT, - 'pageset' => true, - 'default' => '-1', - 'array' => $criticalities, - 'value' => '-1' - ]; - - return $filters; +/** + * Determine whether current runtime satisfies plugin PHP requirement. + * + * @return bool + */ +function monitorHasSupportedPhpVersion(): bool +{ + return version_compare(PHP_VERSION, monitorGetMinimumPhpVersion(), '>='); } -function monitor_device_sql_where($sql_where) { - if (get_request_var('criticality') >= 0) { - $sql_where .= ($sql_where != '' ? ' AND ' : 'WHERE ') . ' monitor_criticality = ' . get_request_var('criticality'); - } +/** + * Enforce plugin minimum PHP version and optionally raise a UI message. + * + * @param bool $raise_message Whether to raise a Cacti UI error message. + * + * @return bool + */ +function monitorEnsureSupportedPhpVersion(bool $raise_message = true): bool +{ + if (monitorHasSupportedPhpVersion()) { + return true; + } + + $message = sprintf( + 'Monitor plugin requires PHP %s or newer. Current runtime: %s', + monitorGetMinimumPhpVersion(), + PHP_VERSION + ); + + cacti_log($message, false, 'MONITOR'); + + if ($raise_message) { + raise_message('monitor_php_version', $message, MESSAGE_LEVEL_ERROR); + } + + return false; +} - return $sql_where; +/** + * Register monitor plugin hooks, realm, defaults, and schema. + * + * @return void + */ +function pluginMonitorInstall(): void +{ + if (!monitorEnsureSupportedPhpVersion()) { + return; + } + + // core plugin functionality + api_plugin_register_hook('monitor', 'top_header_tabs', 'monitorShowTab', 'setup.php'); + api_plugin_register_hook('monitor', 'top_graph_header_tabs', 'monitorShowTab', 'setup.php'); + api_plugin_register_hook('monitor', 'top_graph_refresh', 'monitorTopGraphRefresh', 'setup.php'); + + api_plugin_register_hook('monitor', 'draw_navigation_text', 'monitorDrawNavigationText', 'setup.php'); + api_plugin_register_hook('monitor', 'config_form', 'monitorConfigForm', 'setup.php'); + api_plugin_register_hook('monitor', 'config_settings', 'monitorConfigSettings', 'setup.php'); + api_plugin_register_hook('monitor', 'config_arrays', 'monitorConfigArrays', 'setup.php'); + api_plugin_register_hook('monitor', 'poller_bottom', 'monitorPollerBottom', 'setup.php'); + api_plugin_register_hook('monitor', 'page_head', 'pluginMonitorPageHead', 'setup.php'); + + // device actions and interaction + api_plugin_register_hook('monitor', 'api_device_save', 'monitorApiDeviceSave', 'setup.php'); + api_plugin_register_hook('monitor', 'device_action_array', 'monitorDeviceActionArray', 'setup.php'); + api_plugin_register_hook('monitor', 'device_action_execute', 'monitorDeviceActionExecute', 'setup.php'); + api_plugin_register_hook('monitor', 'device_action_prepare', 'monitorDeviceActionPrepare', 'setup.php'); + api_plugin_register_hook('monitor', 'device_remove', 'monitorDeviceRemove', 'setup.php'); + + // add new filter for device + api_plugin_register_hook('monitor', 'device_filters', 'monitorDeviceFilters', 'setup.php'); + api_plugin_register_hook('monitor', 'device_sql_where', 'monitorDeviceSqlWhere', 'setup.php'); + api_plugin_register_hook('monitor', 'device_table_bottom', 'monitorDeviceTableBottom', 'setup.php'); + + api_plugin_register_realm('monitor', 'monitor.php', 'View Monitoring Dashboard', 1); + + set_config_option('monitor_view', 'default'); + set_config_option('monitor_grouping', 'default'); + set_config_option('monitor_trim', '4000'); + set_config_option('monitor_rows', 100); + + monitorSetupTable(); } -function monitor_device_table_bottom() { - $criticalities = [ - '-1' => __('Any', 'monitor'), - '0' => __('None', 'monitor'), - '1' => __('Low', 'monitor'), - '2' => __('Medium', 'monitor'), - '3' => __('High', 'monitor'), - '4' => __('Mission Critical', 'monitor') - ]; - - if (version_compare(CACTI_VERSION, '1.3.0', '<')) { - $select = '
" . __('Click \'Continue\' to %s monitoring on these Device(s)', $action_description, 'monitor') . "
- " . $save['host_list'] . '
" . __('Click \'Continue\' to Change the Monitoring settings for the following Device(s). Remember to check \'Update this Field\' to indicate which columns to update.', 'monitor') . "
- " . $save['host_list'] . '
Monitor Reboot Notification
The following Device\'s were Rebooted. See details below for additional information.
', 'monitor')
- ],
- 'monitor_email_header' => [
- 'friendly_name' => __('Notification Email Addresses', 'monitor'),
- 'method' => 'spacer',
- 'collapsible' => 'true'
- ],
- 'monitor_fromname' => [
- 'friendly_name' => __('From Name', 'monitor'),
- 'description' => __('Enter the Email Name to send the notifications from', 'monitor'),
- 'method' => 'textbox',
- 'size' => '60',
- 'max_length' => '255'
- ],
- 'monitor_fromemail' => [
- 'friendly_name' => __('From Address', 'monitor'),
- 'description' => __('Enter the Email Address to send the notification from', 'monitor'),
- 'method' => 'textbox',
- 'size' => '60',
- 'max_length' => '255'
- ],
- 'monitor_list' => [
- 'friendly_name' => __('Notification List', 'thold'),
- 'description' => __('Select a Notification List below. All Emails subscribed to the notification list will be notified.', 'thold'),
- 'method' => 'drop_sql',
- 'sql' => 'SELECT id, name FROM plugin_notification_lists ORDER BY name',
- 'default' => '',
- 'none_value' => __('None', 'monitor')
- ],
- 'monitor_emails' => [
- 'friendly_name' => __('Email Addresses', 'monitor'),
- 'description' => __('Enter a comma delimited list of Email addresses to inform of a reboot event.', 'monitor'),
- 'method' => 'textarea',
- 'textarea_rows' => 2,
- 'textarea_cols' => 80,
- 'default' => ''
- ]
- ];
-
- if (isset($settings['monitor'])) {
- $settings['monitor'] = array_merge($settings['monitor'], $temp);
- } else {
- $settings['monitor'] = $temp;
- }
+/**
+ * Register monitor plugin settings and user preference definitions.
+ *
+ * @return void
+ */
+function monitorConfigSettings(): void
+{
+ global $tabs, $formats, $settings, $criticalities, $page_refresh_interval, $config, $settings_user, $tabs_graphs;
+
+ include_once($config['base_path'] . '/lib/reports.php');
+
+ if (get_nfilter_request_var('tab') == 'monitor') {
+ $formats = reports_get_format_files();
+ } elseif (empty($formats)) {
+ $formats = [];
+ }
+
+ $criticalities = [
+ 0 => __('Disabled', 'monitor'),
+ 1 => __('Low', 'monitor'),
+ 2 => __('Medium', 'monitor'),
+ 3 => __('High', 'monitor'),
+ 4 => __('Mission Critical', 'monitor')
+ ];
+
+ $log_retentions = [
+ '-1' => __('Indefinitely', 'monitor'),
+ '31' => __('%d Month', 1, 'monitor'),
+ '62' => __('%d Months', 2, 'monitor'),
+ '93' => __('%d Months', 3, 'monitor'),
+ '124' => __('%d Months', 4, 'monitor'),
+ '186' => __('%d Months', 6, 'monitor'),
+ '365' => __('%d Year', 1, 'monitor')
+ ];
+
+ $font_sizes = [
+ '20' => '20px',
+ '30' => '30px',
+ '40' => '40px',
+ '50' => '50px',
+ '60' => '60px',
+ '70' => '70px'
+ ];
+
+ if (function_exists('auth_augment_roles')) {
+ auth_augment_roles(__('Normal User'), ['monitor.php']);
+ }
+
+ $tabs_graphs += ['monitor' => __('Monitor Settings', 'monitor')];
+
+ $settings_user += [
+ 'monitor' => [
+ 'monitor_sound' => [
+ 'friendly_name' => __('Alarm Sound', 'monitor'),
+ 'description' => __('This is the sound file that will be played when a Device goes down.', 'monitor'),
+ 'method' => 'drop_array',
+ 'array' => monitorScanDir(),
+ 'default' => 'attn-noc.wav',
+ ],
+ 'monitor_sound_loop' => [
+ 'friendly_name' => __('Loop Alarm Sound', 'monitor'),
+ 'description' => __('Play the above sound on a loop when a Device goes down.', 'monitor'),
+ 'method' => 'checkbox',
+ ],
+ 'monitor_legend' => [
+ 'friendly_name' => __('Show Icon Legend', 'monitor'),
+ 'description' => __('Check this to show an icon legend on the Monitor display', 'monitor'),
+ 'method' => 'checkbox',
+ ],
+ 'monitor_uptime' => [
+ 'friendly_name' => __('Show Uptime', 'monitor'),
+ 'description' => __('Check this to show Uptime on the Monitor display', 'monitor'),
+ 'method' => 'checkbox',
+ ],
+ 'monitor_error_zoom' => [
+ 'friendly_name' => __('Zoom to Errors', 'monitor'),
+ 'description' => __('Check this to zoom to errored items on the Monitor display', 'monitor'),
+ 'method' => 'checkbox',
+ ],
+ 'monitor_error_background' => [
+ 'friendly_name' => __('Zoom Background', 'monitor'),
+ 'description' => __('Background Color for Zoomed Errors on the Monitor display', 'monitor'),
+ 'method' => 'drop_color',
+ ],
+ 'monitor_error_fontsize' => [
+ 'friendly_name' => __('Zoom Fontsize', 'monitor'),
+ 'description' => __('Check this to zoom to errored items on the Monitor display', 'monitor'),
+ 'method' => 'drop_array',
+ 'default' => '50',
+ 'array' => $font_sizes
+ ]
+ ]
+ ];
+
+ if (get_current_page() != 'settings.php') {
+ return;
+ }
+
+ $tabs['monitor'] = __('Monitor', 'monitor');
+
+ $temp = [
+ 'monitor_header' => [
+ 'friendly_name' => __('Monitor Settings', 'monitor'),
+ 'method' => 'spacer',
+ 'collapsible' => 'true'
+ ],
+ 'monitor_new_enabled' => [
+ 'friendly_name' => __('Enable on new devices', 'monitor'),
+ 'description' => __('Check this to automatically enable monitoring when creating new devices', 'monitor'),
+ 'method' => 'checkbox',
+ ],
+ 'monitor_log_storage' => [
+ 'friendly_name' => __('Notification/Reboot Log Retention', 'monitor'),
+ 'description' => __('Keep Notification and Reboot Logs for this number of days.', 'monitor'),
+ 'method' => 'drop_array',
+ 'default' => '31',
+ 'array' => $log_retentions
+ ],
+ 'monitor_sound' => [
+ 'friendly_name' => __('Alarm Sound', 'monitor'),
+ 'description' => __('This is the sound file that will be played when a Device goes down.', 'monitor'),
+ 'method' => 'drop_array',
+ 'array' => monitorScanDir(),
+ 'default' => 'attn-noc.wav',
+ ],
+ 'monitor_sound_loop' => [
+ 'friendly_name' => __('Loop Alarm Sound', 'monitor'),
+ 'description' => __('Play the above sound on a loop when a Device goes down.', 'monitor'),
+ 'method' => 'checkbox',
+ ],
+ 'monitor_refresh' => [
+ 'friendly_name' => __('Refresh Interval', 'monitor'),
+ 'description' => __('This is the time in seconds before the page refreshes. (1 - 300)', 'monitor'),
+ 'method' => 'drop_array',
+ 'default' => '60',
+ 'array' => $page_refresh_interval
+ ],
+ 'monitor_legend' => [
+ 'friendly_name' => __('Show Icon Legend', 'monitor'),
+ 'description' => __('Check this to show an icon legend on the Monitor display', 'monitor'),
+ 'method' => 'checkbox',
+ ],
+ 'monitor_grouping' => [
+ 'friendly_name' => __('Grouping', 'monitor'),
+ 'description' => __('This is how monitor will Group Devices.', 'monitor'),
+ 'method' => 'drop_array',
+ 'default' => 'default',
+ 'array' => [
+ 'default' => __('Default', 'monitor'),
+ 'default_by_permissions' => __('Default with permissions', 'monitor'),
+ 'group_by_tree' => __('Tree', 'monitor'),
+ 'group_by_device_template' => __('Device Template', 'monitor'),
+ ]
+ ],
+ 'monitor_view' => [
+ 'friendly_name' => __('View', 'monitor'),
+ 'description' => __('This is how monitor will render Devices.', 'monitor'),
+ 'method' => 'drop_array',
+ 'default' => 'default',
+ 'array' => [
+ 'default' => __('Default', 'monitor'),
+ 'list' => __('List', 'monitor'),
+ 'names' => __('Names only', 'monitor'),
+ 'tiles' => __('Tiles', 'monitor'),
+ 'tilesadt' => __('Tiles & Downtime', 'monitor')
+ ]
+ ],
+ 'monitor_format_header' => [
+ 'friendly_name' => __('Notification Report Format', 'monitor'),
+ 'method' => 'spacer',
+ 'collapsible' => 'true'
+ ],
+ 'monitor_format_file' => [
+ 'friendly_name' => __('Format File to Use', 'monitor'),
+ 'method' => 'drop_array',
+ 'default' => 'default.format',
+ 'description' => __('Choose the custom html wrapper and CSS file to use. This file contains both html and CSS to wrap around your report. If it contains more than simply CSS, you need to place a special tag inside of the file. This format tag will be replaced by the report content. These files are located in the \'formats\' directory.', 'monitor'),
+ 'array' => $formats
+ ],
+ 'monitor_threshold' => [
+ 'friendly_name' => __('Ping Threshold Notifications', 'monitor'),
+ 'method' => 'spacer',
+ 'collapsible' => 'true'
+ ],
+ 'monitor_warn_criticality' => [
+ 'friendly_name' => __('Warning Latency Notification', 'monitor'),
+ 'description' => __('If a Device has a Round Trip Ping Latency above the Warning Threshold and above the Criticality below, subscribing emails to the Device will receive an email notification. Select \'Disabled\' to Disable. The Thold Plugin is required to enable this feature.', 'monitor'),
+ 'method' => 'drop_array',
+ 'default' => '0',
+ 'array' => $criticalities
+ ],
+ 'monitor_alert_criticality' => [
+ 'friendly_name' => __('Alert Latency Notification', 'monitor'),
+ 'description' => __('If a Device has a Round Trip Ping Latency above the Alert Threshold and above the Criticality below, subscribing emails to the Device will receive an email notification. Select \'Disabled\' to Disable. The Thold Plugin is required to enable this feature.', 'monitor'),
+ 'method' => 'drop_array',
+ 'default' => '0',
+ 'array' => $criticalities
+ ],
+ 'monitor_resend_frequency' => [
+ 'friendly_name' => __('How Often to Resend Emails', 'monitor'),
+ 'description' => __('How often should emails notifications be sent to subscribers for these Devices if they are exceeding their latency thresholds', 'monitor'),
+ 'method' => 'drop_array',
+ 'default' => '0',
+ 'array' => [
+ '0' => __('Every Occurrence', 'monitor'),
+ '20' => __('Every %d Minutes', 20, 'monitor'),
+ '30' => __('Every %d Minutes', 30, 'monitor'),
+ '60' => __('Every Hour', 'monitor'),
+ '120' => __('Every %d Hours', 2, 'monitor'),
+ '240' => __('Every %d Hours', 4, 'monitor')
+ ]
+ ],
+ 'monitor_reboot' => [
+ 'friendly_name' => __('Reboot Notifications', 'monitor'),
+ 'method' => 'spacer',
+ 'collapsible' => 'true'
+ ],
+ 'monitor_reboot_notify' => [
+ 'friendly_name' => __('Send Reboot Notifications', 'monitor'),
+ 'method' => 'checkbox',
+ 'description' => __('Should Device Reboot Notifications be sent to users?', 'monitor'),
+ 'default' => 'on',
+ ],
+ 'monitor_send_one_email' => [
+ 'friendly_name' => __('Send one Email to all addresses', 'monitor'),
+ 'description' => __('If checked, the system will send one Email only to all addresses.', 'monitor'),
+ 'method' => 'checkbox',
+ 'default' => 'on'
+ ],
+ 'monitor_reboot_thold' => [
+ 'friendly_name' => __('Include Threshold Alert Lists', 'monitor'),
+ 'method' => 'checkbox',
+ 'description' => __('Should Threshold Alert Lists also receive Notification', 'monitor'),
+ 'default' => 'on',
+ ],
+ 'monitor_subject' => [
+ 'friendly_name' => __('Subject', 'monitor'),
+ 'description' => __('Enter a Reboot message subject for the Reboot Notification.', 'monitor'),
+ 'method' => 'textbox',
+ 'default' => __('Cacti Device Reboot Notification', 'monitor'),
+ 'size' => 60,
+ 'max_length' => 60
+ ],
+ 'monitor_body' => [
+ 'friendly_name' => __('Email Body', 'monitor'),
+ 'description' => __('Enter an Email body to include in the Reboot Notification message. Currently, the only supported replacement tag accepted is <DETAILS>', 'monitor'),
+ 'method' => 'textarea',
+ 'textarea_rows' => 4,
+ 'textarea_cols' => 80,
+ 'default' => __('
Monitor Reboot Notification
The following Device\'s were Rebooted. See details below for additional information.
', 'monitor')
+ ],
+ 'monitor_email_header' => [
+ 'friendly_name' => __('Notification Email Addresses', 'monitor'),
+ 'method' => 'spacer',
+ 'collapsible' => 'true'
+ ],
+ 'monitor_fromname' => [
+ 'friendly_name' => __('From Name', 'monitor'),
+ 'description' => __('Enter the Email Name to send the notifications from', 'monitor'),
+ 'method' => 'textbox',
+ 'size' => '60',
+ 'max_length' => '255'
+ ],
+ 'monitor_fromemail' => [
+ 'friendly_name' => __('From Address', 'monitor'),
+ 'description' => __('Enter the Email Address to send the notification from', 'monitor'),
+ 'method' => 'textbox',
+ 'size' => '60',
+ 'max_length' => '255'
+ ],
+ 'monitor_list' => [
+ 'friendly_name' => __('Notification List', 'thold'),
+ 'description' => __('Select a Notification List below. All Emails subscribed to the notification list will be notified.', 'thold'),
+ 'method' => 'drop_sql',
+ 'sql' => 'SELECT id, name FROM plugin_notification_lists ORDER BY name',
+ 'default' => '',
+ 'none_value' => __('None', 'monitor')
+ ],
+ 'monitor_emails' => [
+ 'friendly_name' => __('Email Addresses', 'monitor'),
+ 'description' => __('Enter a comma delimited list of Email addresses to inform of a reboot event.', 'monitor'),
+ 'method' => 'textarea',
+ 'textarea_rows' => 2,
+ 'textarea_cols' => 80,
+ 'default' => ''
+ ]
+ ];
+
+ if (isset($settings['monitor'])) {
+ $settings['monitor'] = array_merge($settings['monitor'], $temp);
+ } else {
+ $settings['monitor'] = $temp;
+ }
}
-function monitor_config_arrays() {
- global $fa_icons;
-
- $fa_icons = [
- 'server' => [
- 'display' => __('Server', 'monitor'),
- 'class' => 'fa fa-server deviceUp',
- 'style' => ''
- ],
- 'print' => [
- 'display' => __('Printer', 'monitor'),
- 'class' => 'fa fa-print deviceUp',
- 'style' => ''
- ],
- 'desktop' => [
- 'display' => __('Desktop PC', 'monitor'),
- 'class' => 'fa fa-desktop deviceUp',
- 'style' => ''
- ],
- 'laptop' => [
- 'display' => __('Laptop/notebook', 'monitor'),
- 'class' => 'fa fa-laptop deviceUp',
- 'style' => ''
- ],
- 'wifi' => [
- 'display' => __('Wifi', 'monitor'),
- 'class' => 'fa fa-wifi deviceUp',
- 'style' => ''
- ],
- 'network-wired' => [
- 'display' => __('Wired network', 'monitor'),
- 'class' => 'fa fa-network-wired deviceUp',
- 'style' => ''
- ],
- 'database' => [
- 'display' => __('Database', 'monitor'),
- 'class' => 'fa fa-database deviceUp',
- 'style' => ''
- ],
- 'clock' => [
- 'display' => __('Clock', 'monitor'),
- 'class' => 'fa fa-clock deviceUp',
- 'style' => ''
- ],
- 'asterisk' => [
- 'display' => __('Asterisk', 'monitor'),
- 'class' => 'fas fa-asterisk deviceUp',
- 'style' => ''
- ],
- 'hdd' => [
- 'display' => __('Harddisk', 'monitor'),
- 'class' => 'fa fa-hdd deviceUp',
- 'style' => ''
- ],
- 'boxes' => [
- 'display' => __('Boxes', 'monitor'),
- 'class' => 'fa fa-boxes deviceUp',
- 'style' => ''
- ],
- 'phone' => [
- 'display' => __('Phone', 'monitor'),
- 'class' => 'fa fa-phone deviceUp',
- 'style' => ''
- ],
- 'cloud' => [
- 'display' => __('Cloud', 'monitor'),
- 'class' => 'fa fa-cloud deviceUp',
- 'style' => ''
- ]
- ];
-
- if (!function_exists('form_dropicon')) {
- foreach ($fa_icons as $key => $data) {
- $nfa_icons[$key] = $data['display'];
- }
-
- $fa_icons = $nfa_icons;
- }
-
- monitor_check_upgrade();
+/**
+ * Build monitor icon option arrays and normalize legacy format fallback.
+ *
+ * @return void
+ */
+function monitorConfigArrays(): void
+{
+ global $fa_icons;
+
+ $fa_icons = [
+ 'server' => [
+ 'display' => __('Server', 'monitor'),
+ 'class' => 'fa fa-server deviceUp',
+ 'style' => ''
+ ],
+ 'print' => [
+ 'display' => __('Printer', 'monitor'),
+ 'class' => 'fa fa-print deviceUp',
+ 'style' => ''
+ ],
+ 'desktop' => [
+ 'display' => __('Desktop PC', 'monitor'),
+ 'class' => 'fa fa-desktop deviceUp',
+ 'style' => ''
+ ],
+ 'laptop' => [
+ 'display' => __('Laptop/notebook', 'monitor'),
+ 'class' => 'fa fa-laptop deviceUp',
+ 'style' => ''
+ ],
+ 'wifi' => [
+ 'display' => __('Wifi', 'monitor'),
+ 'class' => 'fa fa-wifi deviceUp',
+ 'style' => ''
+ ],
+ 'network-wired' => [
+ 'display' => __('Wired network', 'monitor'),
+ 'class' => 'fa fa-network-wired deviceUp',
+ 'style' => ''
+ ],
+ 'database' => [
+ 'display' => __('Database', 'monitor'),
+ 'class' => 'fa fa-database deviceUp',
+ 'style' => ''
+ ],
+ 'clock' => [
+ 'display' => __('Clock', 'monitor'),
+ 'class' => 'fa fa-clock deviceUp',
+ 'style' => ''
+ ],
+ 'asterisk' => [
+ 'display' => __('Asterisk', 'monitor'),
+ 'class' => 'fas fa-asterisk deviceUp',
+ 'style' => ''
+ ],
+ 'hdd' => [
+ 'display' => __('Harddisk', 'monitor'),
+ 'class' => 'fa fa-hdd deviceUp',
+ 'style' => ''
+ ],
+ 'boxes' => [
+ 'display' => __('Boxes', 'monitor'),
+ 'class' => 'fa fa-boxes deviceUp',
+ 'style' => ''
+ ],
+ 'phone' => [
+ 'display' => __('Phone', 'monitor'),
+ 'class' => 'fa fa-phone deviceUp',
+ 'style' => ''
+ ],
+ 'cloud' => [
+ 'display' => __('Cloud', 'monitor'),
+ 'class' => 'fa fa-cloud deviceUp',
+ 'style' => ''
+ ]
+ ];
+
+ if (!function_exists('form_dropicon')) {
+ foreach ($fa_icons as $key => $data) {
+ $nfa_icons[$key] = $data['display'];
+ }
+
+ $fa_icons = $nfa_icons;
+ }
+
+ monitorCheckUpgrade();
}
-function monitor_top_graph_refresh($refresh) {
- if (get_current_page() != 'monitor.php') {
- return $refresh;
- }
-
- $r = read_config_option('monitor_refresh');
-
- if ($r == '' || $r < 1) {
- return $refresh;
- }
-
- return $r;
+/**
+ * Override top-graph refresh interval when on monitor page.
+ *
+ * @param int|string $refresh Existing refresh interval.
+ *
+ * @return int|string
+ */
+function monitorTopGraphRefresh(mixed $refresh): mixed
+{
+ if (get_current_page() != 'monitor.php') {
+ return $refresh;
+ }
+
+ $r = read_config_option('monitor_refresh');
+
+ if ($r == '' || $r < 1) {
+ return $refresh;
+ }
+
+ return $r;
}
-function monitor_show_tab() {
- global $config;
-
- monitor_check_upgrade();
-
- if (api_user_realm_auth('monitor.php')) {
- if (substr_count($_SERVER['REQUEST_URI'], 'monitor.php')) {
- print '
';
- } else {
- print '
';
- }
- }
+/**
+ * Render monitor navigation tab icon for authorized users.
+ *
+ * @return void
+ */
+function monitorShowTab(): void
+{
+ global $config;
+
+ monitorCheckUpgrade();
+
+ if (api_user_realm_auth('monitor.php')) {
+ if (substr_count($_SERVER['REQUEST_URI'], 'monitor.php')) {
+ print '';
+ } else {
+ print '';
+ }
+ }
}
-function monitor_config_form() {
- global $config, $fields_host_edit, $criticalities, $fa_icons;
-
- $baselines = [
- '0' => __('Do not Change', 'monitor'),
- '1.20' => __('%d Percent Above Average', 20, 'monitor'),
- '1.30' => __('%d Percent Above Average', 30, 'monitor'),
- '1.40' => __('%d Percent Above Average', 40, 'monitor'),
- '1.50' => __('%d Percent Above Average', 50, 'monitor'),
- '1.60' => __('%d Percent Above Average', 60, 'monitor'),
- '1.70' => __('%d Percent Above Average', 70, 'monitor'),
- '1.80' => __('%d Percent Above Average', 80, 'monitor'),
- '1.90' => __('%d Percent Above Average', 90, 'monitor'),
- '2.00' => __('%d Percent Above Average', 100, 'monitor'),
- '2.20' => __('%d Percent Above Average', 120, 'monitor'),
- '2.40' => __('%d Percent Above Average', 140, 'monitor'),
- '2.50' => __('%d Percent Above Average', 150, 'monitor'),
- '3.00' => __('%d Percent Above Average', 200, 'monitor'),
- '4.00' => __('%d Percent Above Average', 300, 'monitor'),
- '5.00' => __('%d Percent Above Average', 400, 'monitor'),
- '6.00' => __('%d Percent Above Average', 500, 'monitor')
- ];
-
- $fields_host_edit2 = $fields_host_edit;
- $fields_host_edit3 = [];
-
- if (array_key_exists('bulk_walk_size', $fields_host_edit2)) {
- $insert_field = 'bulk_walk_size';
- } else {
- $insert_field = 'disabled';
- }
-
- foreach ($fields_host_edit2 as $f => $a) {
- $fields_host_edit3[$f] = $a;
-
- if ($f == $insert_field) {
- $fields_host_edit3['monitor_header'] = [
- 'friendly_name' => __('Device Monitoring Settings', 'monitor'),
- 'method' => 'spacer',
- 'collapsible' => 'true'
- ];
-
- $fields_host_edit3['monitor'] = [
- 'method' => 'checkbox',
- 'friendly_name' => __('Monitor Device', 'monitor'),
- 'description' => __('Check this box to monitor this Device on the Monitor Tab.', 'monitor'),
- 'value' => '|arg1:monitor|',
- 'form_id' => false
- ];
-
- $host_id = get_nfilter_request_var('id');
-
- if (empty($host_id) || !is_numeric($host_id)) {
- $fields_host_edit3['monitor']['default'] = monitor_get_default($host_id);
- }
-
- $fields_host_edit3['monitor_criticality'] = [
- 'friendly_name' => __('Device Criticality', 'monitor'),
- 'description' => __('What is the Criticality of this Device.', 'monitor'),
- 'method' => 'drop_array',
- 'array' => $criticalities,
- 'value' => '|arg1:monitor_criticality|',
- 'default' => '0',
- ];
-
- $fields_host_edit3['monitor_warn'] = [
- 'friendly_name' => __('Ping Warning Threshold', 'monitor'),
- 'description' => __('If the round-trip latency via any of the predefined Cacti ping methods raises above this threshold, log a warning or send email based upon the Devices Criticality and Monitor setting. The unit is in milliseconds. Setting to 0 disables. The Thold Plugin is required to leverage this functionality.', 'monitor'),
- 'method' => 'textbox',
- 'size' => '10',
- 'max_length' => '5',
- 'placeholder' => __('milliseconds', 'monitor'),
- 'value' => '|arg1:monitor_warn|',
- 'default' => '',
- ];
-
- $fields_host_edit3['monitor_alert'] = [
- 'friendly_name' => __('Ping Alert Threshold', 'monitor'),
- 'description' => __('If the round-trip latency via any of the predefined Cacti ping methods raises above this threshold, log an alert or send an email based upon the Devices Criticality and Monitor setting. The unit is in milliseconds. Setting to 0 disables. The Thold Plugin is required to leverage this functionality.', 'monitor'),
- 'method' => 'textbox',
- 'size' => '10',
- 'max_length' => '5',
- 'placeholder' => __('milliseconds', 'monitor'),
- 'value' => '|arg1:monitor_alert|',
- 'default' => '',
- ];
-
- $fields_host_edit3['monitor_warn_baseline'] = [
- 'friendly_name' => __('Re-Baseline Warning', 'monitor'),
- 'description' => __('The percentage above the current average ping time to consider a Warning Threshold. If updated, this will automatically adjust the Ping Warning Threshold.', 'monitor'),
- 'method' => 'drop_array',
- 'default' => '0',
- 'value' => '0',
- 'array' => $baselines
- ];
-
- $fields_host_edit3['monitor_alert_baseline'] = [
- 'friendly_name' => __('Re-Baseline Alert', 'monitor'),
- 'description' => __('The percentage above the current average ping time to consider a Alert Threshold. If updated, this will automatically adjust the Ping Alert Threshold.', 'monitor'),
- 'method' => 'drop_array',
- 'default' => '0',
- 'value' => '0',
- 'array' => $baselines
- ];
-
- $fields_host_edit3['monitor_text'] = [
- 'friendly_name' => __('Down Device Message', 'monitor'),
- 'description' => __('This is the message that will be displayed when this Device is reported as down.', 'monitor'),
- 'method' => 'textarea',
- 'max_length' => 1000,
- 'textarea_rows' => 2,
- 'textarea_cols' => 80,
- 'value' => '|arg1:monitor_text|',
- 'default' => '',
- ];
-
- if (function_exists('form_dropicon')) {
- $method = 'drop_icon';
- } else {
- $method = 'drop_array';
- }
-
- $fields_host_edit3['monitor_icon'] = [
- 'friendly_name' => __('Device icon', 'monitor'),
- 'description' => __('You can select device icon.', 'monitor'),
- 'method' => $method,
- 'default' => '0',
- 'value' => '|arg1:monitor_icon|',
- 'array' => $fa_icons,
- ];
- }
- }
-
- $fields_host_edit = $fields_host_edit3;
+/**
+ * Inject monitor fields into device edit form configuration.
+ *
+ * @return void
+ */
+function monitorConfigForm(): void
+{
+ global $config, $fields_host_edit, $criticalities, $fa_icons;
+
+ $baselines = [
+ '0' => __('Do not Change', 'monitor'),
+ '1.20' => __('%d Percent Above Average', 20, 'monitor'),
+ '1.30' => __('%d Percent Above Average', 30, 'monitor'),
+ '1.40' => __('%d Percent Above Average', 40, 'monitor'),
+ '1.50' => __('%d Percent Above Average', 50, 'monitor'),
+ '1.60' => __('%d Percent Above Average', 60, 'monitor'),
+ '1.70' => __('%d Percent Above Average', 70, 'monitor'),
+ '1.80' => __('%d Percent Above Average', 80, 'monitor'),
+ '1.90' => __('%d Percent Above Average', 90, 'monitor'),
+ '2.00' => __('%d Percent Above Average', 100, 'monitor'),
+ '2.20' => __('%d Percent Above Average', 120, 'monitor'),
+ '2.40' => __('%d Percent Above Average', 140, 'monitor'),
+ '2.50' => __('%d Percent Above Average', 150, 'monitor'),
+ '3.00' => __('%d Percent Above Average', 200, 'monitor'),
+ '4.00' => __('%d Percent Above Average', 300, 'monitor'),
+ '5.00' => __('%d Percent Above Average', 400, 'monitor'),
+ '6.00' => __('%d Percent Above Average', 500, 'monitor')
+ ];
+
+ $fields_host_edit2 = $fields_host_edit;
+ $fields_host_edit3 = [];
+
+ if (array_key_exists('bulk_walk_size', $fields_host_edit2)) {
+ $insert_field = 'bulk_walk_size';
+ } else {
+ $insert_field = 'disabled';
+ }
+
+ foreach ($fields_host_edit2 as $f => $a) {
+ $fields_host_edit3[$f] = $a;
+
+ if ($f == $insert_field) {
+ $fields_host_edit3['monitor_header'] = [
+ 'friendly_name' => __('Device Monitoring Settings', 'monitor'),
+ 'method' => 'spacer',
+ 'collapsible' => 'true'
+ ];
+
+ $fields_host_edit3['monitor'] = [
+ 'method' => 'checkbox',
+ 'friendly_name' => __('Monitor Device', 'monitor'),
+ 'description' => __('Check this box to monitor this Device on the Monitor Tab.', 'monitor'),
+ 'value' => '|arg1:monitor|',
+ 'form_id' => false
+ ];
+
+ $host_id = get_nfilter_request_var('id');
+
+ if (empty($host_id) || !is_numeric($host_id)) {
+ $fields_host_edit3['monitor']['default'] = monitorGetDefault($host_id);
+ }
+
+ $fields_host_edit3['monitor_criticality'] = [
+ 'friendly_name' => __('Device Criticality', 'monitor'),
+ 'description' => __('What is the Criticality of this Device.', 'monitor'),
+ 'method' => 'drop_array',
+ 'array' => $criticalities,
+ 'value' => '|arg1:monitor_criticality|',
+ 'default' => '0',
+ ];
+
+ $fields_host_edit3['monitor_warn'] = [
+ 'friendly_name' => __('Ping Warning Threshold', 'monitor'),
+ 'description' => __('If the round-trip latency via any of the predefined Cacti ping methods raises above this threshold, log a warning or send email based upon the Devices Criticality and Monitor setting. The unit is in milliseconds. Setting to 0 disables. The Thold Plugin is required to leverage this functionality.', 'monitor'),
+ 'method' => 'textbox',
+ 'size' => '10',
+ 'max_length' => '5',
+ 'placeholder' => __('milliseconds', 'monitor'),
+ 'value' => '|arg1:monitor_warn|',
+ 'default' => '',
+ ];
+
+ $fields_host_edit3['monitor_alert'] = [
+ 'friendly_name' => __('Ping Alert Threshold', 'monitor'),
+ 'description' => __('If the round-trip latency via any of the predefined Cacti ping methods raises above this threshold, log an alert or send an email based upon the Devices Criticality and Monitor setting. The unit is in milliseconds. Setting to 0 disables. The Thold Plugin is required to leverage this functionality.', 'monitor'),
+ 'method' => 'textbox',
+ 'size' => '10',
+ 'max_length' => '5',
+ 'placeholder' => __('milliseconds', 'monitor'),
+ 'value' => '|arg1:monitor_alert|',
+ 'default' => '',
+ ];
+
+ $fields_host_edit3['monitor_warn_baseline'] = [
+ 'friendly_name' => __('Re-Baseline Warning', 'monitor'),
+ 'description' => __('The percentage above the current average ping time to consider a Warning Threshold. If updated, this will automatically adjust the Ping Warning Threshold.', 'monitor'),
+ 'method' => 'drop_array',
+ 'default' => '0',
+ 'value' => '0',
+ 'array' => $baselines
+ ];
+
+ $fields_host_edit3['monitor_alert_baseline'] = [
+ 'friendly_name' => __('Re-Baseline Alert', 'monitor'),
+ 'description' => __('The percentage above the current average ping time to consider a Alert Threshold. If updated, this will automatically adjust the Ping Alert Threshold.', 'monitor'),
+ 'method' => 'drop_array',
+ 'default' => '0',
+ 'value' => '0',
+ 'array' => $baselines
+ ];
+
+ $fields_host_edit3['monitor_text'] = [
+ 'friendly_name' => __('Down Device Message', 'monitor'),
+ 'description' => __('This is the message that will be displayed when this Device is reported as down.', 'monitor'),
+ 'method' => 'textarea',
+ 'max_length' => 1000,
+ 'textarea_rows' => 2,
+ 'textarea_cols' => 80,
+ 'value' => '|arg1:monitor_text|',
+ 'default' => '',
+ ];
+
+ if (function_exists('form_dropicon')) {
+ $method = 'drop_icon';
+ } else {
+ $method = 'drop_array';
+ }
+
+ $fields_host_edit3['monitor_icon'] = [
+ 'friendly_name' => __('Device icon', 'monitor'),
+ 'description' => __('You can select device icon.', 'monitor'),
+ 'method' => $method,
+ 'default' => '0',
+ 'value' => '|arg1:monitor_icon|',
+ 'array' => $fa_icons,
+ ];
+ }
+ }
+
+ $fields_host_edit = $fields_host_edit3;
}
-function monitor_get_default($host_id) {
- $monitor_new_device = '';
-
- if ($host_id <= 0) {
- $monitor_new_device = read_config_option('monitor_new_enabled');
- }
-
- return $monitor_new_device;
+/**
+ * Resolve default monitor enabled state for new devices.
+ *
+ * @param int|string $host_id Host identifier.
+ *
+ * @return string
+ */
+function monitorGetDefault(int|string $host_id): string
+{
+ $monitor_new_device = '';
+
+ if ($host_id <= 0) {
+ $monitor_new_device = read_config_option('monitor_new_enabled');
+ }
+
+ return $monitor_new_device;
}
-function monitor_api_device_save($save) {
- global $fa_icons;
-
- $monitor_default = monitor_get_default($save['id']);
-
- if (isset_request_var('monitor')) {
- $save['monitor'] = form_input_validate(get_nfilter_request_var('monitor'), 'monitor', $monitor_default, true, 3);
- } else {
- $save['monitor'] = form_input_validate($monitor_default, 'monitor', '', true, 3);
- }
-
- if (isset_request_var('monitor_text')) {
- $save['monitor_text'] = form_input_validate(get_nfilter_request_var('monitor_text'), 'monitor_text', '', true, 3);
- } else {
- $save['monitor_text'] = form_input_validate('', 'monitor_text', '', true, 3);
- }
-
- if (isset_request_var('monitor_criticality')) {
- $save['monitor_criticality'] = form_input_validate(get_nfilter_request_var('monitor_criticality'), 'monitor_criticality', '^[0-9]+$', true, 3);
- } else {
- $save['monitor_criticality'] = form_input_validate('', 'monitor_criticality', '', true, 3);
- }
-
- if (isset_request_var('monitor_warn')) {
- $save['monitor_warn'] = form_input_validate(get_nfilter_request_var('monitor_warn'), 'monitor_warn', '^[0-9]+$', true, 3);
- } else {
- $save['monitor_warn'] = form_input_validate('', 'monitor_warn', '', true, 3);
- }
-
- if (isset_request_var('monitor_alert')) {
- $save['monitor_alert'] = form_input_validate(get_nfilter_request_var('monitor_alert'), 'monitor_alert', '^[0-9]+$', true, 3);
- } else {
- $save['monitor_alert'] = form_input_validate('', 'monitor_alert', '', true, 3);
- }
-
- if (isset_request_var('monitor_icon') && array_key_exists(get_nfilter_request_var('monitor_icon'), $fa_icons)) {
- $save['monitor_icon'] = get_nfilter_request_var('monitor_icon');
- } else {
- $save['monitor_icon'] = '';
- }
-
- if (!isempty_request_var('monitor_alert_baseline') && !empty($save['id'])) {
- $cur_time = db_fetch_cell_prepared('SELECT cur_time
+/**
+ * Validate and map monitor-specific host fields during device save.
+ *
+ * @param array $save Device save payload.
+ *
+ * @return array
+ */
+function monitorApiDeviceSave(array $save): array
+{
+ global $fa_icons;
+
+ $monitor_default = monitorGetDefault($save['id']);
+
+ if (isset_request_var('monitor')) {
+ $save['monitor'] = form_input_validate(get_nfilter_request_var('monitor'), 'monitor', $monitor_default, true, 3);
+ } else {
+ $save['monitor'] = form_input_validate($monitor_default, 'monitor', '', true, 3);
+ }
+
+ if (isset_request_var('monitor_text')) {
+ $save['monitor_text'] = form_input_validate(get_nfilter_request_var('monitor_text'), 'monitor_text', '', true, 3);
+ } else {
+ $save['monitor_text'] = form_input_validate('', 'monitor_text', '', true, 3);
+ }
+
+ if (isset_request_var('monitor_criticality')) {
+ $save['monitor_criticality'] = form_input_validate(get_nfilter_request_var('monitor_criticality'), 'monitor_criticality', '^[0-9]+$', true, 3);
+ } else {
+ $save['monitor_criticality'] = form_input_validate('', 'monitor_criticality', '', true, 3);
+ }
+
+ if (isset_request_var('monitor_warn')) {
+ $save['monitor_warn'] = form_input_validate(get_nfilter_request_var('monitor_warn'), 'monitor_warn', '^[0-9]+$', true, 3);
+ } else {
+ $save['monitor_warn'] = form_input_validate('', 'monitor_warn', '', true, 3);
+ }
+
+ if (isset_request_var('monitor_alert')) {
+ $save['monitor_alert'] = form_input_validate(get_nfilter_request_var('monitor_alert'), 'monitor_alert', '^[0-9]+$', true, 3);
+ } else {
+ $save['monitor_alert'] = form_input_validate('', 'monitor_alert', '', true, 3);
+ }
+
+ if (isset_request_var('monitor_icon') && array_key_exists(get_nfilter_request_var('monitor_icon'), $fa_icons)) {
+ $save['monitor_icon'] = get_nfilter_request_var('monitor_icon');
+ } else {
+ $save['monitor_icon'] = '';
+ }
+
+ if (!isempty_request_var('monitor_alert_baseline') && !empty($save['id'])) {
+ $cur_time = db_fetch_cell_prepared(
+ 'SELECT cur_time
FROM host
WHERE id = ?',
- [$save['id']]);
+ [$save['id']]
+ );
- if ($cur_time > 0) {
- $save['monitor_alert'] = ceil($cur_time * get_nfilter_request_var('monitor_alert_baseline'));
- }
- }
+ if ($cur_time > 0) {
+ $save['monitor_alert'] = ceil($cur_time * get_nfilter_request_var('monitor_alert_baseline'));
+ }
+ }
- if (!isempty_request_var('monitor_warn_baseline') && !empty($save['id'])) {
- $cur_time = db_fetch_cell_prepared('SELECT cur_time
+ if (!isempty_request_var('monitor_warn_baseline') && !empty($save['id'])) {
+ $cur_time = db_fetch_cell_prepared(
+ 'SELECT cur_time
FROM host
WHERE id = ?',
- [$save['id']]);
+ [$save['id']]
+ );
- if ($cur_time > 0) {
- $save['monitor_warn'] = ceil($cur_time * get_nfilter_request_var('monitor_alert_baseline'));
- }
- }
+ if ($cur_time > 0) {
+ $save['monitor_warn'] = ceil($cur_time * get_nfilter_request_var('monitor_alert_baseline'));
+ }
+ }
- return $save;
+ return $save;
}
-function monitor_draw_navigation_text($nav) {
- $nav['monitor.php:'] = ['title' => __('Monitoring', 'monitor'), 'mapping' => '', 'url' => 'monitor.php', 'level' => '0'];
-
- return $nav;
+/**
+ * Add monitor page breadcrumb/nav metadata.
+ *
+ * @param array $nav Existing navigation mapping.
+ *
+ * @return array
+ */
+function monitorDrawNavigationText(array $nav): array
+{
+ $nav['monitor.php:'] = ['title' => __('Monitoring', 'monitor'), 'mapping' => '', 'url' => 'monitor.php', 'level' => '0'];
+
+ return $nav;
}
-function monitor_setup_table() {
- if (!db_table_exists('plugin_monitor_notify_history')) {
- db_execute("CREATE TABLE IF NOT EXISTS plugin_monitor_notify_history (
+/**
+ * Create/upgrade monitor plugin tables and host columns.
+ *
+ * @return void
+ */
+function monitorSetupTable(): void
+{
+ if (!db_table_exists('plugin_monitor_notify_history')) {
+ db_execute("CREATE TABLE IF NOT EXISTS plugin_monitor_notify_history (
id int(10) unsigned NOT NULL AUTO_INCREMENT,
host_id int(10) unsigned DEFAULT NULL,
notify_type tinyint(3) unsigned DEFAULT NULL,
@@ -1053,10 +1299,10 @@ function monitor_setup_table() {
UNIQUE KEY unique_key (host_id,notify_type,notification_time))
ENGINE=InnoDB
COMMENT='Stores Notification Event History'");
- }
+ }
- if (!db_table_exists('plugin_monitor_reboot_history')) {
- db_execute("CREATE TABLE IF NOT EXISTS plugin_monitor_reboot_history (
+ if (!db_table_exists('plugin_monitor_reboot_history')) {
+ db_execute("CREATE TABLE IF NOT EXISTS plugin_monitor_reboot_history (
id int(10) unsigned NOT NULL AUTO_INCREMENT,
host_id int(10) unsigned DEFAULT NULL,
reboot_time timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
@@ -1067,20 +1313,20 @@ function monitor_setup_table() {
KEY reboot_time (reboot_time))
ENGINE=InnoDB
COMMENT='Keeps Track of Device Reboot Times'");
- }
+ }
- if (!db_table_exists('plugin_monitor_uptime')) {
- db_execute("CREATE TABLE IF NOT EXISTS plugin_monitor_uptime (
+ if (!db_table_exists('plugin_monitor_uptime')) {
+ db_execute("CREATE TABLE IF NOT EXISTS plugin_monitor_uptime (
host_id int(10) unsigned DEFAULT '0',
uptime bigint(20) unsigned DEFAULT '0',
PRIMARY KEY (host_id),
KEY uptime (uptime))
ENGINE=InnoDB
COMMENT='Keeps Track of the Devices last uptime to track agent restarts and reboots'");
- }
+ }
- if (!db_table_exists('plugin_monitor_dashboards')) {
- db_execute("CREATE TABLE IF NOT EXISTS plugin_monitor_dashboards (
+ if (!db_table_exists('plugin_monitor_dashboards')) {
+ db_execute("CREATE TABLE IF NOT EXISTS plugin_monitor_dashboards (
id int(10) unsigned auto_increment,
user_id int(10) unsigned DEFAULT '0',
name varchar(128) DEFAULT '',
@@ -1089,30 +1335,36 @@ function monitor_setup_table() {
KEY user_id (user_id))
ENGINE=InnoDB
COMMENT='Stores predefined dashboard information for a user or users'");
- }
-
- api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor', 'type' => 'char(3)', 'NULL' => true, 'default' => 'on', 'after' => 'disabled']);
- api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor_text', 'type' => 'varchar(1024)', 'default' => '', 'NULL' => false, 'after' => 'monitor']);
- api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor_criticality', 'type' => 'tinyint', 'unsigned' => true, 'NULL' => false, 'default' => '0', 'after' => 'monitor_text']);
- api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor_warn', 'type' => 'double', 'NULL' => false, 'default' => '0', 'after' => 'monitor_criticality']);
- api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor_alert', 'type' => 'double', 'NULL' => false, 'default' => '0', 'after' => 'monitor_warn']);
- api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor_icon', 'type' => 'varchar(30)', 'NULL' => false, 'default' => '', 'after' => 'monitor_alert']);
+ }
+
+ api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor', 'type' => 'char(3)', 'NULL' => true, 'default' => 'on', 'after' => 'disabled']);
+ api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor_text', 'type' => 'varchar(1024)', 'default' => '', 'NULL' => false, 'after' => 'monitor']);
+ api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor_criticality', 'type' => 'tinyint', 'unsigned' => true, 'NULL' => false, 'default' => '0', 'after' => 'monitor_text']);
+ api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor_warn', 'type' => 'double', 'NULL' => false, 'default' => '0', 'after' => 'monitor_criticality']);
+ api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor_alert', 'type' => 'double', 'NULL' => false, 'default' => '0', 'after' => 'monitor_warn']);
+ api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor_icon', 'type' => 'varchar(30)', 'NULL' => false, 'default' => '', 'after' => 'monitor_alert']);
}
-function monitor_poller_bottom() {
- global $config;
+/**
+ * Trigger monitor poller script from primary poller process.
+ *
+ * @return void
+ */
+function monitorPollerBottom(): void
+{
+ global $config;
- if ($config['poller_id'] == 1) {
- include_once($config['library_path'] . '/poller.php');
+ if ($config['poller_id'] == 1) {
+ include_once($config['library_path'] . '/poller.php');
- $command_string = trim(read_config_option('path_php_binary'));
+ $command_string = trim(read_config_option('path_php_binary'));
- if (trim($command_string) == '') {
- $command_string = 'php';
- }
+ if (trim($command_string) == '') {
+ $command_string = 'php';
+ }
- $extra_args = ' -q ' . $config['base_path'] . '/plugins/monitor/poller_monitor.php';
+ $extra_args = ' -q ' . $config['base_path'] . '/plugins/monitor/poller_monitor.php';
- exec_background($command_string, $extra_args);
- }
+ exec_background($command_string, $extra_args);
+ }
}
diff --git a/sounds/index.php b/sounds/index.php
index 828ecbe..362957c 100644
--- a/sounds/index.php
+++ b/sounds/index.php
@@ -1,4 +1,5 @@
';
- } else {
- print '';
- }
- }
+/**
+ * Render monitor navigation tab icon for authorized users.
+ *
+ * @return void
+ */
+function monitorShowTab(): void
+{
+ global $config;
+
+ monitorCheckUpgrade();
+
+ if (api_user_realm_auth('monitor.php')) {
+ if (substr_count($_SERVER['REQUEST_URI'], 'monitor.php')) {
+ print '';
+ } else {
+ print '';
+ }
+ }
}
-function monitor_config_form() {
- global $config, $fields_host_edit, $criticalities, $fa_icons;
-
- $baselines = [
- '0' => __('Do not Change', 'monitor'),
- '1.20' => __('%d Percent Above Average', 20, 'monitor'),
- '1.30' => __('%d Percent Above Average', 30, 'monitor'),
- '1.40' => __('%d Percent Above Average', 40, 'monitor'),
- '1.50' => __('%d Percent Above Average', 50, 'monitor'),
- '1.60' => __('%d Percent Above Average', 60, 'monitor'),
- '1.70' => __('%d Percent Above Average', 70, 'monitor'),
- '1.80' => __('%d Percent Above Average', 80, 'monitor'),
- '1.90' => __('%d Percent Above Average', 90, 'monitor'),
- '2.00' => __('%d Percent Above Average', 100, 'monitor'),
- '2.20' => __('%d Percent Above Average', 120, 'monitor'),
- '2.40' => __('%d Percent Above Average', 140, 'monitor'),
- '2.50' => __('%d Percent Above Average', 150, 'monitor'),
- '3.00' => __('%d Percent Above Average', 200, 'monitor'),
- '4.00' => __('%d Percent Above Average', 300, 'monitor'),
- '5.00' => __('%d Percent Above Average', 400, 'monitor'),
- '6.00' => __('%d Percent Above Average', 500, 'monitor')
- ];
-
- $fields_host_edit2 = $fields_host_edit;
- $fields_host_edit3 = [];
-
- if (array_key_exists('bulk_walk_size', $fields_host_edit2)) {
- $insert_field = 'bulk_walk_size';
- } else {
- $insert_field = 'disabled';
- }
-
- foreach ($fields_host_edit2 as $f => $a) {
- $fields_host_edit3[$f] = $a;
-
- if ($f == $insert_field) {
- $fields_host_edit3['monitor_header'] = [
- 'friendly_name' => __('Device Monitoring Settings', 'monitor'),
- 'method' => 'spacer',
- 'collapsible' => 'true'
- ];
-
- $fields_host_edit3['monitor'] = [
- 'method' => 'checkbox',
- 'friendly_name' => __('Monitor Device', 'monitor'),
- 'description' => __('Check this box to monitor this Device on the Monitor Tab.', 'monitor'),
- 'value' => '|arg1:monitor|',
- 'form_id' => false
- ];
-
- $host_id = get_nfilter_request_var('id');
-
- if (empty($host_id) || !is_numeric($host_id)) {
- $fields_host_edit3['monitor']['default'] = monitor_get_default($host_id);
- }
-
- $fields_host_edit3['monitor_criticality'] = [
- 'friendly_name' => __('Device Criticality', 'monitor'),
- 'description' => __('What is the Criticality of this Device.', 'monitor'),
- 'method' => 'drop_array',
- 'array' => $criticalities,
- 'value' => '|arg1:monitor_criticality|',
- 'default' => '0',
- ];
-
- $fields_host_edit3['monitor_warn'] = [
- 'friendly_name' => __('Ping Warning Threshold', 'monitor'),
- 'description' => __('If the round-trip latency via any of the predefined Cacti ping methods raises above this threshold, log a warning or send email based upon the Devices Criticality and Monitor setting. The unit is in milliseconds. Setting to 0 disables. The Thold Plugin is required to leverage this functionality.', 'monitor'),
- 'method' => 'textbox',
- 'size' => '10',
- 'max_length' => '5',
- 'placeholder' => __('milliseconds', 'monitor'),
- 'value' => '|arg1:monitor_warn|',
- 'default' => '',
- ];
-
- $fields_host_edit3['monitor_alert'] = [
- 'friendly_name' => __('Ping Alert Threshold', 'monitor'),
- 'description' => __('If the round-trip latency via any of the predefined Cacti ping methods raises above this threshold, log an alert or send an email based upon the Devices Criticality and Monitor setting. The unit is in milliseconds. Setting to 0 disables. The Thold Plugin is required to leverage this functionality.', 'monitor'),
- 'method' => 'textbox',
- 'size' => '10',
- 'max_length' => '5',
- 'placeholder' => __('milliseconds', 'monitor'),
- 'value' => '|arg1:monitor_alert|',
- 'default' => '',
- ];
-
- $fields_host_edit3['monitor_warn_baseline'] = [
- 'friendly_name' => __('Re-Baseline Warning', 'monitor'),
- 'description' => __('The percentage above the current average ping time to consider a Warning Threshold. If updated, this will automatically adjust the Ping Warning Threshold.', 'monitor'),
- 'method' => 'drop_array',
- 'default' => '0',
- 'value' => '0',
- 'array' => $baselines
- ];
-
- $fields_host_edit3['monitor_alert_baseline'] = [
- 'friendly_name' => __('Re-Baseline Alert', 'monitor'),
- 'description' => __('The percentage above the current average ping time to consider a Alert Threshold. If updated, this will automatically adjust the Ping Alert Threshold.', 'monitor'),
- 'method' => 'drop_array',
- 'default' => '0',
- 'value' => '0',
- 'array' => $baselines
- ];
-
- $fields_host_edit3['monitor_text'] = [
- 'friendly_name' => __('Down Device Message', 'monitor'),
- 'description' => __('This is the message that will be displayed when this Device is reported as down.', 'monitor'),
- 'method' => 'textarea',
- 'max_length' => 1000,
- 'textarea_rows' => 2,
- 'textarea_cols' => 80,
- 'value' => '|arg1:monitor_text|',
- 'default' => '',
- ];
-
- if (function_exists('form_dropicon')) {
- $method = 'drop_icon';
- } else {
- $method = 'drop_array';
- }
-
- $fields_host_edit3['monitor_icon'] = [
- 'friendly_name' => __('Device icon', 'monitor'),
- 'description' => __('You can select device icon.', 'monitor'),
- 'method' => $method,
- 'default' => '0',
- 'value' => '|arg1:monitor_icon|',
- 'array' => $fa_icons,
- ];
- }
- }
-
- $fields_host_edit = $fields_host_edit3;
+/**
+ * Inject monitor fields into device edit form configuration.
+ *
+ * @return void
+ */
+function monitorConfigForm(): void
+{
+ global $config, $fields_host_edit, $criticalities, $fa_icons;
+
+ $baselines = [
+ '0' => __('Do not Change', 'monitor'),
+ '1.20' => __('%d Percent Above Average', 20, 'monitor'),
+ '1.30' => __('%d Percent Above Average', 30, 'monitor'),
+ '1.40' => __('%d Percent Above Average', 40, 'monitor'),
+ '1.50' => __('%d Percent Above Average', 50, 'monitor'),
+ '1.60' => __('%d Percent Above Average', 60, 'monitor'),
+ '1.70' => __('%d Percent Above Average', 70, 'monitor'),
+ '1.80' => __('%d Percent Above Average', 80, 'monitor'),
+ '1.90' => __('%d Percent Above Average', 90, 'monitor'),
+ '2.00' => __('%d Percent Above Average', 100, 'monitor'),
+ '2.20' => __('%d Percent Above Average', 120, 'monitor'),
+ '2.40' => __('%d Percent Above Average', 140, 'monitor'),
+ '2.50' => __('%d Percent Above Average', 150, 'monitor'),
+ '3.00' => __('%d Percent Above Average', 200, 'monitor'),
+ '4.00' => __('%d Percent Above Average', 300, 'monitor'),
+ '5.00' => __('%d Percent Above Average', 400, 'monitor'),
+ '6.00' => __('%d Percent Above Average', 500, 'monitor')
+ ];
+
+ $fields_host_edit2 = $fields_host_edit;
+ $fields_host_edit3 = [];
+
+ if (array_key_exists('bulk_walk_size', $fields_host_edit2)) {
+ $insert_field = 'bulk_walk_size';
+ } else {
+ $insert_field = 'disabled';
+ }
+
+ foreach ($fields_host_edit2 as $f => $a) {
+ $fields_host_edit3[$f] = $a;
+
+ if ($f == $insert_field) {
+ $fields_host_edit3['monitor_header'] = [
+ 'friendly_name' => __('Device Monitoring Settings', 'monitor'),
+ 'method' => 'spacer',
+ 'collapsible' => 'true'
+ ];
+
+ $fields_host_edit3['monitor'] = [
+ 'method' => 'checkbox',
+ 'friendly_name' => __('Monitor Device', 'monitor'),
+ 'description' => __('Check this box to monitor this Device on the Monitor Tab.', 'monitor'),
+ 'value' => '|arg1:monitor|',
+ 'form_id' => false
+ ];
+
+ $host_id = get_nfilter_request_var('id');
+
+ if (empty($host_id) || !is_numeric($host_id)) {
+ $fields_host_edit3['monitor']['default'] = monitorGetDefault($host_id);
+ }
+
+ $fields_host_edit3['monitor_criticality'] = [
+ 'friendly_name' => __('Device Criticality', 'monitor'),
+ 'description' => __('What is the Criticality of this Device.', 'monitor'),
+ 'method' => 'drop_array',
+ 'array' => $criticalities,
+ 'value' => '|arg1:monitor_criticality|',
+ 'default' => '0',
+ ];
+
+ $fields_host_edit3['monitor_warn'] = [
+ 'friendly_name' => __('Ping Warning Threshold', 'monitor'),
+ 'description' => __('If the round-trip latency via any of the predefined Cacti ping methods raises above this threshold, log a warning or send email based upon the Devices Criticality and Monitor setting. The unit is in milliseconds. Setting to 0 disables. The Thold Plugin is required to leverage this functionality.', 'monitor'),
+ 'method' => 'textbox',
+ 'size' => '10',
+ 'max_length' => '5',
+ 'placeholder' => __('milliseconds', 'monitor'),
+ 'value' => '|arg1:monitor_warn|',
+ 'default' => '',
+ ];
+
+ $fields_host_edit3['monitor_alert'] = [
+ 'friendly_name' => __('Ping Alert Threshold', 'monitor'),
+ 'description' => __('If the round-trip latency via any of the predefined Cacti ping methods raises above this threshold, log an alert or send an email based upon the Devices Criticality and Monitor setting. The unit is in milliseconds. Setting to 0 disables. The Thold Plugin is required to leverage this functionality.', 'monitor'),
+ 'method' => 'textbox',
+ 'size' => '10',
+ 'max_length' => '5',
+ 'placeholder' => __('milliseconds', 'monitor'),
+ 'value' => '|arg1:monitor_alert|',
+ 'default' => '',
+ ];
+
+ $fields_host_edit3['monitor_warn_baseline'] = [
+ 'friendly_name' => __('Re-Baseline Warning', 'monitor'),
+ 'description' => __('The percentage above the current average ping time to consider a Warning Threshold. If updated, this will automatically adjust the Ping Warning Threshold.', 'monitor'),
+ 'method' => 'drop_array',
+ 'default' => '0',
+ 'value' => '0',
+ 'array' => $baselines
+ ];
+
+ $fields_host_edit3['monitor_alert_baseline'] = [
+ 'friendly_name' => __('Re-Baseline Alert', 'monitor'),
+ 'description' => __('The percentage above the current average ping time to consider a Alert Threshold. If updated, this will automatically adjust the Ping Alert Threshold.', 'monitor'),
+ 'method' => 'drop_array',
+ 'default' => '0',
+ 'value' => '0',
+ 'array' => $baselines
+ ];
+
+ $fields_host_edit3['monitor_text'] = [
+ 'friendly_name' => __('Down Device Message', 'monitor'),
+ 'description' => __('This is the message that will be displayed when this Device is reported as down.', 'monitor'),
+ 'method' => 'textarea',
+ 'max_length' => 1000,
+ 'textarea_rows' => 2,
+ 'textarea_cols' => 80,
+ 'value' => '|arg1:monitor_text|',
+ 'default' => '',
+ ];
+
+ if (function_exists('form_dropicon')) {
+ $method = 'drop_icon';
+ } else {
+ $method = 'drop_array';
+ }
+
+ $fields_host_edit3['monitor_icon'] = [
+ 'friendly_name' => __('Device icon', 'monitor'),
+ 'description' => __('You can select device icon.', 'monitor'),
+ 'method' => $method,
+ 'default' => '0',
+ 'value' => '|arg1:monitor_icon|',
+ 'array' => $fa_icons,
+ ];
+ }
+ }
+
+ $fields_host_edit = $fields_host_edit3;
}
-function monitor_get_default($host_id) {
- $monitor_new_device = '';
-
- if ($host_id <= 0) {
- $monitor_new_device = read_config_option('monitor_new_enabled');
- }
-
- return $monitor_new_device;
+/**
+ * Resolve default monitor enabled state for new devices.
+ *
+ * @param int|string $host_id Host identifier.
+ *
+ * @return string
+ */
+function monitorGetDefault(int|string $host_id): string
+{
+ $monitor_new_device = '';
+
+ if ($host_id <= 0) {
+ $monitor_new_device = read_config_option('monitor_new_enabled');
+ }
+
+ return $monitor_new_device;
}
-function monitor_api_device_save($save) {
- global $fa_icons;
-
- $monitor_default = monitor_get_default($save['id']);
-
- if (isset_request_var('monitor')) {
- $save['monitor'] = form_input_validate(get_nfilter_request_var('monitor'), 'monitor', $monitor_default, true, 3);
- } else {
- $save['monitor'] = form_input_validate($monitor_default, 'monitor', '', true, 3);
- }
-
- if (isset_request_var('monitor_text')) {
- $save['monitor_text'] = form_input_validate(get_nfilter_request_var('monitor_text'), 'monitor_text', '', true, 3);
- } else {
- $save['monitor_text'] = form_input_validate('', 'monitor_text', '', true, 3);
- }
-
- if (isset_request_var('monitor_criticality')) {
- $save['monitor_criticality'] = form_input_validate(get_nfilter_request_var('monitor_criticality'), 'monitor_criticality', '^[0-9]+$', true, 3);
- } else {
- $save['monitor_criticality'] = form_input_validate('', 'monitor_criticality', '', true, 3);
- }
-
- if (isset_request_var('monitor_warn')) {
- $save['monitor_warn'] = form_input_validate(get_nfilter_request_var('monitor_warn'), 'monitor_warn', '^[0-9]+$', true, 3);
- } else {
- $save['monitor_warn'] = form_input_validate('', 'monitor_warn', '', true, 3);
- }
-
- if (isset_request_var('monitor_alert')) {
- $save['monitor_alert'] = form_input_validate(get_nfilter_request_var('monitor_alert'), 'monitor_alert', '^[0-9]+$', true, 3);
- } else {
- $save['monitor_alert'] = form_input_validate('', 'monitor_alert', '', true, 3);
- }
-
- if (isset_request_var('monitor_icon') && array_key_exists(get_nfilter_request_var('monitor_icon'), $fa_icons)) {
- $save['monitor_icon'] = get_nfilter_request_var('monitor_icon');
- } else {
- $save['monitor_icon'] = '';
- }
-
- if (!isempty_request_var('monitor_alert_baseline') && !empty($save['id'])) {
- $cur_time = db_fetch_cell_prepared('SELECT cur_time
+/**
+ * Validate and map monitor-specific host fields during device save.
+ *
+ * @param array $save Device save payload.
+ *
+ * @return array
+ */
+function monitorApiDeviceSave(array $save): array
+{
+ global $fa_icons;
+
+ $monitor_default = monitorGetDefault($save['id']);
+
+ if (isset_request_var('monitor')) {
+ $save['monitor'] = form_input_validate(get_nfilter_request_var('monitor'), 'monitor', $monitor_default, true, 3);
+ } else {
+ $save['monitor'] = form_input_validate($monitor_default, 'monitor', '', true, 3);
+ }
+
+ if (isset_request_var('monitor_text')) {
+ $save['monitor_text'] = form_input_validate(get_nfilter_request_var('monitor_text'), 'monitor_text', '', true, 3);
+ } else {
+ $save['monitor_text'] = form_input_validate('', 'monitor_text', '', true, 3);
+ }
+
+ if (isset_request_var('monitor_criticality')) {
+ $save['monitor_criticality'] = form_input_validate(get_nfilter_request_var('monitor_criticality'), 'monitor_criticality', '^[0-9]+$', true, 3);
+ } else {
+ $save['monitor_criticality'] = form_input_validate('', 'monitor_criticality', '', true, 3);
+ }
+
+ if (isset_request_var('monitor_warn')) {
+ $save['monitor_warn'] = form_input_validate(get_nfilter_request_var('monitor_warn'), 'monitor_warn', '^[0-9]+$', true, 3);
+ } else {
+ $save['monitor_warn'] = form_input_validate('', 'monitor_warn', '', true, 3);
+ }
+
+ if (isset_request_var('monitor_alert')) {
+ $save['monitor_alert'] = form_input_validate(get_nfilter_request_var('monitor_alert'), 'monitor_alert', '^[0-9]+$', true, 3);
+ } else {
+ $save['monitor_alert'] = form_input_validate('', 'monitor_alert', '', true, 3);
+ }
+
+ if (isset_request_var('monitor_icon') && array_key_exists(get_nfilter_request_var('monitor_icon'), $fa_icons)) {
+ $save['monitor_icon'] = get_nfilter_request_var('monitor_icon');
+ } else {
+ $save['monitor_icon'] = '';
+ }
+
+ if (!isempty_request_var('monitor_alert_baseline') && !empty($save['id'])) {
+ $cur_time = db_fetch_cell_prepared(
+ 'SELECT cur_time
FROM host
WHERE id = ?',
- [$save['id']]);
+ [$save['id']]
+ );
- if ($cur_time > 0) {
- $save['monitor_alert'] = ceil($cur_time * get_nfilter_request_var('monitor_alert_baseline'));
- }
- }
+ if ($cur_time > 0) {
+ $save['monitor_alert'] = ceil($cur_time * get_nfilter_request_var('monitor_alert_baseline'));
+ }
+ }
- if (!isempty_request_var('monitor_warn_baseline') && !empty($save['id'])) {
- $cur_time = db_fetch_cell_prepared('SELECT cur_time
+ if (!isempty_request_var('monitor_warn_baseline') && !empty($save['id'])) {
+ $cur_time = db_fetch_cell_prepared(
+ 'SELECT cur_time
FROM host
WHERE id = ?',
- [$save['id']]);
+ [$save['id']]
+ );
- if ($cur_time > 0) {
- $save['monitor_warn'] = ceil($cur_time * get_nfilter_request_var('monitor_alert_baseline'));
- }
- }
+ if ($cur_time > 0) {
+ $save['monitor_warn'] = ceil($cur_time * get_nfilter_request_var('monitor_alert_baseline'));
+ }
+ }
- return $save;
+ return $save;
}
-function monitor_draw_navigation_text($nav) {
- $nav['monitor.php:'] = ['title' => __('Monitoring', 'monitor'), 'mapping' => '', 'url' => 'monitor.php', 'level' => '0'];
-
- return $nav;
+/**
+ * Add monitor page breadcrumb/nav metadata.
+ *
+ * @param array $nav Existing navigation mapping.
+ *
+ * @return array
+ */
+function monitorDrawNavigationText(array $nav): array
+{
+ $nav['monitor.php:'] = ['title' => __('Monitoring', 'monitor'), 'mapping' => '', 'url' => 'monitor.php', 'level' => '0'];
+
+ return $nav;
}
-function monitor_setup_table() {
- if (!db_table_exists('plugin_monitor_notify_history')) {
- db_execute("CREATE TABLE IF NOT EXISTS plugin_monitor_notify_history (
+/**
+ * Create/upgrade monitor plugin tables and host columns.
+ *
+ * @return void
+ */
+function monitorSetupTable(): void
+{
+ if (!db_table_exists('plugin_monitor_notify_history')) {
+ db_execute("CREATE TABLE IF NOT EXISTS plugin_monitor_notify_history (
id int(10) unsigned NOT NULL AUTO_INCREMENT,
host_id int(10) unsigned DEFAULT NULL,
notify_type tinyint(3) unsigned DEFAULT NULL,
@@ -1053,10 +1299,10 @@ function monitor_setup_table() {
UNIQUE KEY unique_key (host_id,notify_type,notification_time))
ENGINE=InnoDB
COMMENT='Stores Notification Event History'");
- }
+ }
- if (!db_table_exists('plugin_monitor_reboot_history')) {
- db_execute("CREATE TABLE IF NOT EXISTS plugin_monitor_reboot_history (
+ if (!db_table_exists('plugin_monitor_reboot_history')) {
+ db_execute("CREATE TABLE IF NOT EXISTS plugin_monitor_reboot_history (
id int(10) unsigned NOT NULL AUTO_INCREMENT,
host_id int(10) unsigned DEFAULT NULL,
reboot_time timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
@@ -1067,20 +1313,20 @@ function monitor_setup_table() {
KEY reboot_time (reboot_time))
ENGINE=InnoDB
COMMENT='Keeps Track of Device Reboot Times'");
- }
+ }
- if (!db_table_exists('plugin_monitor_uptime')) {
- db_execute("CREATE TABLE IF NOT EXISTS plugin_monitor_uptime (
+ if (!db_table_exists('plugin_monitor_uptime')) {
+ db_execute("CREATE TABLE IF NOT EXISTS plugin_monitor_uptime (
host_id int(10) unsigned DEFAULT '0',
uptime bigint(20) unsigned DEFAULT '0',
PRIMARY KEY (host_id),
KEY uptime (uptime))
ENGINE=InnoDB
COMMENT='Keeps Track of the Devices last uptime to track agent restarts and reboots'");
- }
+ }
- if (!db_table_exists('plugin_monitor_dashboards')) {
- db_execute("CREATE TABLE IF NOT EXISTS plugin_monitor_dashboards (
+ if (!db_table_exists('plugin_monitor_dashboards')) {
+ db_execute("CREATE TABLE IF NOT EXISTS plugin_monitor_dashboards (
id int(10) unsigned auto_increment,
user_id int(10) unsigned DEFAULT '0',
name varchar(128) DEFAULT '',
@@ -1089,30 +1335,36 @@ function monitor_setup_table() {
KEY user_id (user_id))
ENGINE=InnoDB
COMMENT='Stores predefined dashboard information for a user or users'");
- }
-
- api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor', 'type' => 'char(3)', 'NULL' => true, 'default' => 'on', 'after' => 'disabled']);
- api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor_text', 'type' => 'varchar(1024)', 'default' => '', 'NULL' => false, 'after' => 'monitor']);
- api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor_criticality', 'type' => 'tinyint', 'unsigned' => true, 'NULL' => false, 'default' => '0', 'after' => 'monitor_text']);
- api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor_warn', 'type' => 'double', 'NULL' => false, 'default' => '0', 'after' => 'monitor_criticality']);
- api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor_alert', 'type' => 'double', 'NULL' => false, 'default' => '0', 'after' => 'monitor_warn']);
- api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor_icon', 'type' => 'varchar(30)', 'NULL' => false, 'default' => '', 'after' => 'monitor_alert']);
+ }
+
+ api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor', 'type' => 'char(3)', 'NULL' => true, 'default' => 'on', 'after' => 'disabled']);
+ api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor_text', 'type' => 'varchar(1024)', 'default' => '', 'NULL' => false, 'after' => 'monitor']);
+ api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor_criticality', 'type' => 'tinyint', 'unsigned' => true, 'NULL' => false, 'default' => '0', 'after' => 'monitor_text']);
+ api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor_warn', 'type' => 'double', 'NULL' => false, 'default' => '0', 'after' => 'monitor_criticality']);
+ api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor_alert', 'type' => 'double', 'NULL' => false, 'default' => '0', 'after' => 'monitor_warn']);
+ api_plugin_db_add_column('monitor', 'host', ['name' => 'monitor_icon', 'type' => 'varchar(30)', 'NULL' => false, 'default' => '', 'after' => 'monitor_alert']);
}
-function monitor_poller_bottom() {
- global $config;
+/**
+ * Trigger monitor poller script from primary poller process.
+ *
+ * @return void
+ */
+function monitorPollerBottom(): void
+{
+ global $config;
- if ($config['poller_id'] == 1) {
- include_once($config['library_path'] . '/poller.php');
+ if ($config['poller_id'] == 1) {
+ include_once($config['library_path'] . '/poller.php');
- $command_string = trim(read_config_option('path_php_binary'));
+ $command_string = trim(read_config_option('path_php_binary'));
- if (trim($command_string) == '') {
- $command_string = 'php';
- }
+ if (trim($command_string) == '') {
+ $command_string = 'php';
+ }
- $extra_args = ' -q ' . $config['base_path'] . '/plugins/monitor/poller_monitor.php';
+ $extra_args = ' -q ' . $config['base_path'] . '/plugins/monitor/poller_monitor.php';
- exec_background($command_string, $extra_args);
- }
+ exec_background($command_string, $extra_args);
+ }
}
diff --git a/sounds/index.php b/sounds/index.php
index 828ecbe..362957c 100644
--- a/sounds/index.php
+++ b/sounds/index.php
@@ -1,4 +1,5 @@