upses.php

<?php
/*
 +-------------------------------------------------------------------------+
 | Copyright (C) 2004-2026 The Cacti Group                                 |
 |                                                                         |
 | This program is free software; you can redistribute it and/or           |
 | modify it under the terms of the GNU General Public License             |
 | as published by the Free Software Foundation; either version 2          |
 | of the License, or (at your option) any later version.                  |
 |                                                                         |
 | This program is distributed in the hope that it will be useful,         |
 | but WITHOUT ANY WARRANTY; without even the implied warranty of          |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the           |
 | GNU General Public License for more details.                            |
 +-------------------------------------------------------------------------+
 | Cacti: The Complete RRDtool-based Graphing Solution                     |
 +-------------------------------------------------------------------------+
 | This code is designed, written, and maintained by the Cacti Group. See  |
 | about.php and/or the AUTHORS file for specific developer information.   |
 +-------------------------------------------------------------------------+
 | http://www.cacti.net/                                                   |
 +-------------------------------------------------------------------------+
*/

require('../../include/auth.php');

/** @var array<string,mixed> $config */
require_once($config['base_path'] . '/lib/api_graph.php');
require_once($config['base_path'] . '/lib/api_data_source.php');
require_once($config['base_path'] . '/lib/poller.php');
require_once($config['base_path'] . '/lib/utility.php');
require_once($config['base_path'] . '/lib/rrd.php');
require_once(__DIR__ . '/includes/functions.php');
require_once(__DIR__ . '/includes/helpers.php');
require_once(__DIR__ . '/includes/dashboard.php');

$ups_actions = [
	1 => __('Delete', 'apcupsd'),
	2 => __('Duplicate', 'apcupsd'),
	3 => __('Reset Detection', 'apcupsd')
];

$ups_types = [
	1 => __('APC UPSD Based', 'apcupsd'),
	2 => __('SNMP Based', 'apcupsd')
];

global $fields_snmp_item;

// file: upses.php, action: edit
$fields_ups_edit = [
	'spacer0' => [
		'method'        => 'spacer',
		'friendly_name' => __('UPS Information', 'apcupsd'),
		'collapsible'   => 'true'
	],
	'name' => [
		'method'        => 'textbox',
		'friendly_name' => __('UPS Name', 'apcupsd'),
		'description'   => __('The Name you would like to give this UPS.  For APCUPSD Devices, a corresponding Cacti Device will be created automatically for the UPS using this name.  For SNMP based UPS\'s, you must create the Cacti Device first.', 'apcupsd'),
		'value'         => '|arg1:name|',
		'size'          => '50',
		'default'       => __('New UPS', 'apcupsd'),
		'max_length'    => '100'
	],
	'description' => [
		'method'        => 'textarea',
		'friendly_name' => __('UPS Description', 'apcupsd'),
		'description'   => __('A more detailed Description of this UPS if required.', 'apcupsd'),
		'value'         => '|arg1:description|',
		'textarea_rows' => '3',
		'textarea_cols' => '80'
	],
	'type_id' => [
		'method'        => 'drop_array',
		'friendly_name' => __('UPS Type', 'apcupsd'),
		'description'   => __('The Type of UPS you are monitoring.', 'apcupsd'),
		'value'         => '|arg1:type_id|',
		'array'         => $ups_types
	],
	'poller_id' => [
		'method'        => 'drop_sql',
		'friendly_name' => __('Poller ID', 'apcupsd'),
		'description'   => __('The Poller that this UPS exists in is monitored by', 'apcupsd'),
		'value'         => '|arg1:poller_id|',
		'sql'           => 'SELECT id, name FROM poller ORDER BY name',
		'default'       => 1
	],
	'site_id' => [
		'method'        => 'drop_sql',
		'friendly_name' => __('Site Name', 'apcupsd'),
		'description'   => __('The Site that this UPS exists in.', 'apcupsd'),
		'value'         => '|arg1:site_id|',
		'sql'           => 'SELECT id, name FROM sites ORDER BY name',
		'none_value'    => __('None', 'apcupsd')
	],
	'location' => [
		'method'        => 'drop_callback',
		'friendly_name' => __('Location'),
		'description'   => __('The physical location of the Device.  This free form text can be a room, rack location, etc.'),
		'none_value'    => __('None'),
		'sql'           => 'SELECT DISTINCT location AS id, location AS name FROM host ORDER BY location',
		'action'        => 'ajax_locations',
		'id'            => '|arg1:location|',
		'value'         => '|arg1:location|',
	],
	'host_id' => [
		'method'        => 'drop_callback',
		'friendly_name' => __('Cacti Device', 'apcupsd'),
		'description'   => __('For SNMP Based UPS\', select the Cacti Device to use for SNMP credentials.  Otherwise, select None, and the UPS plugin will create the Device for you automatically.', 'apcupsd'),
		'sql'           => 'SELECT id, description AS name FROM host ORDER BY name',
		'action'        => 'ajax_hosts_noany',
		'id'            => '|arg1:host_id|',
		'value'         => __('Autocreate on First Poll', 'apcupsd'),
		'none_value'    => __('Autocreate on First Poll', 'apcupsd')
	],
	'enabled' => [
		'method'        => 'checkbox',
		'friendly_name' => __('Enabled', 'apcupsd'),
		'description'   => __('Check to immediately start polling for data.', 'apcupsd'),
		'value'         => '|arg1:enabled|',
		'default'       => 'on'
	],
	'spacer1' => [
		'method'        => 'spacer',
		'friendly_name' => __('APC UPSD Information', 'apcupsd'),
		'collapsible'   => 'true'
	],
	'hostname' => [
		'method'        => 'textbox',
		'friendly_name' => __('Hostname', 'apcupsd'),
		'description'   => __('The hostname of the host running apcupsd.', 'apcupsd'),
		'value'         => '|arg1:hostname|',
		'size'          => '70',
		'max_length'    => '100'
	],
	'port' => [
		'method'        => 'textbox',
		'friendly_name' => __('TCP Port', 'apcupsd'),
		'description'   => __('Enter the TCP Port for this UPS.', 'apcupsd'),
		'value'         => '|arg1:port|',
		'size'          => '10',
		'placeholder'   => '3551',
		'max_length'    => '10'
	],
	'host_snmp_head' => [
		'method'        => 'spacer',
		'friendly_name' => __('SNMP Options'),
	],
	'snmp_hostname' => [
		'method'        => 'textbox',
		'friendly_name' => __('Hostname', 'apcupsd'),
		'description'   => __('The hostname where the snmp agent is located.', 'apcupsd'),
		'value'         => '|arg1:hostname|',
		'size'          => '70',
		'max_length'    => '100'
	],
	] + $fields_snmp_item + [
	'id' => [
		'method' => 'hidden_zero',
		'value'  => '|arg1:id|'
	],
	'save_component_ups' => [
		'method' => 'hidden',
		'value'  => '1'
	]
];

// set default action
set_default_action();

switch (get_request_var('action')) {
	case 'save':
		form_save();

		break;
	case 'actions':
		form_actions();

		break;
	case 'ajax_hosts':
		get_filter_request_var('site_id', FILTER_VALIDATE_INT);
		get_allowed_ajax_hosts(false, false, apcupsd_get_site_sql_where(get_request_var('site_id')));

		break;
	case 'ajax_hosts_noany':
		get_filter_request_var('site_id', FILTER_VALIDATE_INT);
		get_allowed_ajax_hosts(false, true, apcupsd_get_site_sql_where(get_request_var('site_id')));

		break;
	case 'ajax_locations':
		get_site_locations();

		break;
	case 'dashboard_card':
		header('Content-Type: application/json; charset=UTF-8');
		print apcupsd_dashboard_card_ajax();

		break;
	case 'dashboard_layout':
		header('Content-Type: application/json; charset=UTF-8');
		print apcupsd_dashboard_layout_save();

		break;
	case 'dashboard_refresh':
		header('Content-Type: application/json; charset=UTF-8');
		print apcupsd_dashboard_refresh_save();

		break;
	case 'summary_card':
		header('Content-Type: application/json; charset=UTF-8');
		print apcupsd_fleet_card_ajax();

		break;
	case 'summary_layout':
		header('Content-Type: application/json; charset=UTF-8');
		print apcupsd_fleet_layout_save();

		break;
	case 'summary_refresh':
		header('Content-Type: application/json; charset=UTF-8');
		print apcupsd_fleet_refresh_save();

		break;
	case 'ajax_tz':
		print json_encode(db_fetch_assoc_prepared('SELECT Name AS label, Name AS `value`
			FROM mysql.time_zone_name
			WHERE Name LIKE ?
			ORDER BY Name
			LIMIT ' . apcupsd_get_autocomplete_rows_limit(read_config_option('autocomplete_rows')),
			['%' . get_nfilter_request_var('term') . '%']));

		break;
	case 'edit':
		apcupsd_render_with_layout('ups_edit');

		break;
	case 'view':
		apcupsd_render_with_layout('apcupsd_dashboard');

		break;
	case 'dashboard':
		apcupsd_render_with_layout('apcupsd_fleet_dashboard');

		break;
	default:
		apcupsd_render_with_layout('upses');

		break;
}

/* --------------------------
	Global Form Functions
   -------------------------- */

/* --------------------------
	The Save Function
   -------------------------- */

/**
 * Validates and saves a single UPS record (name, type, poller, site,
 * location, apcupsd/SNMP connection details) from the submitted edit
 * form, and propagates name/location/site/SNMP-credential changes onto
 * the UPS's linked Cacti device (including regenerating any dependent
 * graph/data source titles when the name changes). Invoked from this
 * file's dispatcher when the request's 'action' is 'save'.
 *
 * @return void Redirects back to the edit form for this UPS; does not
 *              return a value.
 */
function form_save(): void {
	if (isset_request_var('save_component_ups')) {
		$save['id']           = get_filter_request_var('id');
		$save['host_id']      = form_input_validate(get_nfilter_request_var('host_id'), 'host_id', '', true, 3);
		$save['type_id']      = form_input_validate(get_nfilter_request_var('type_id'), 'type_id', '', true, 3);
		$save['name']         = form_input_validate(get_nfilter_request_var('name'), 'name', '', false, 3);
		$save['description']  = form_input_validate(get_nfilter_request_var('description'), 'description', '', true, 3);
		$save['site_id']      = form_input_validate(get_nfilter_request_var('site_id'), 'site_id', '^[0-9]+$', true, 3);

		if ($save['type_id'] == 1) {
			$save['hostname'] = form_input_validate(get_nfilter_request_var('hostname'), 'hostname', '', true, 3);
		} else {
			$save['hostname'] = form_input_validate(get_nfilter_request_var('snmp_hostname'), 'snmp_hostname', '', true, 3);
		}

		$save['port']         = form_input_validate(get_nfilter_request_var('port'), 'port', '^[0-9]+$', true, 3);
		$save['enabled']      = isset_request_var('enabled') ? 'on' : '';

		$save['snmp_version']   = form_input_validate(get_nfilter_request_var('snmp_version'), 'snmp_version', '', true, 3);
		$save['snmp_community'] = form_input_validate(get_nfilter_request_var('snmp_community'), 'snmp_community', '', true, 3);

		$save['snmp_username']        = form_input_validate(get_nfilter_request_var('snmp_username'), 'snmp_username', '', true, 3);
		$save['snmp_password']        = form_input_validate(get_nfilter_request_var('snmp_password'), 'snmp_password', '', true, 3);
		$save['snmp_auth_protocol']   = form_input_validate(get_nfilter_request_var('snmp_auth_protocol'), 'snmp_auth_protocol', '', true, 3);
		$save['snmp_priv_protocol']   = form_input_validate(get_nfilter_request_var('snmp_priv_protocol'), 'snmp_priv_protocol', '', true, 3);
		$save['snmp_priv_passphrase'] = form_input_validate(get_nfilter_request_var('snmp_priv_passphrase'), 'snmp_priv_passphrase', '', true, 3);
		$save['snmp_context']         = form_input_validate(get_nfilter_request_var('snmp_context'), 'snmp_context', '', true, 3);
		$save['snmp_engine_id']       = form_input_validate(get_nfilter_request_var('snmp_engine_id'), 'snmp_engine_id', '', true, 3);

		$save['snmp_port']            = form_input_validate(get_nfilter_request_var('snmp_port'), 'snmp_port', '^[0-9]+$', true, 3);
		$save['snmp_timeout']         = form_input_validate(get_nfilter_request_var('snmp_timeout'), 'snmp_timeout', '', true, 3);

		if ($save['host_id'] > 0) {
			$host = db_fetch_row_prepared('SELECT * FROM host WHERE id = ?', [$save['host_id']]);
			$host = is_array($host) ? $host : [];
		} else {
			$host = [];
		}

		if (!is_error_message()) {
			$ups_id = sql_save($save, 'apcupsd_ups');

			if ($ups_id) {
				raise_message(1);
			} else {
				raise_message(2);
			}

			if (cacti_sizeof($host)) {
				$changed          = false;
				$name_changed     = false;
				$location_changed = false;

				if ($host['description'] != $save['name']) {
					$ns['description'] = $save['name'];

					$changed      = true;
					$name_changed = true;
				}

				if ($host['location'] != get_request_var('location')) {
					$ns['location'] = get_request_var('location');

					$location_changed = true;
					$changed          = true;
				}

				if ($host['site_id'] != $save['site_id']) {
					$ns['site_id'] = $save['site_id'];

					$changed = true;
				}

				// SNMP columns
				if ($save['type_id'] == 2) {
					$columns = [
						'hostname',
						'snmp_version',
						'snmp_community',
						'snmp_username',
						'snmp_password',
						'snmp_auth_protocol',
						'snmp_priv_protocol',
						'snmp_priv_passphrase',
						'snmp_context',
						'snmp_engine_id',
						'snmp_port',
						'snmp_timeout',
					];

					foreach ($columns as $c) {
						if ($save[$c] != $host[$c]) {
							$ns[$c]  = $save[$c];
							$changed = true;
						}
					}
				}

				if ($changed) {
					$ns['id'] = $save['host_id'];
					$host_id  = sql_save($ns, 'host');
					push_out_host($host_id);

					if ($name_changed) {
						$graphs = array_rekey(
							db_fetch_assoc_prepared('SELECT id FROM graph_local WHERE host_id = ?', [$host_id]),
							'id', 'id'
						);

						$data_sources = array_rekey(
							db_fetch_assoc_prepared('SELECT id FROM data_local WHERE host_id = ?', [$host_id]),
							'id', 'id'
						);

						if (cacti_sizeof($graphs)) {
							foreach ($graphs as $id) {
								api_reapply_suggested_graph_title($id);
								update_graph_title_cache($id);
							}
						}

						if (cacti_sizeof($data_sources)) {
							foreach ($data_sources as $id) {
								api_reapply_suggested_data_source_data($id);
								update_data_source_title_cache($id);
							}
						}
					}
				}
			}
		}

		header('Location: upses.php?header=false&action=edit&id=' . (empty($ups_id) ? get_nfilter_request_var('id') : $ups_id));
		exit;
	}
}

/**
 * Creates one or more copies of an existing UPS record (by id), renaming
 * each copy by substituting the '<ups>' placeholder in the given name
 * pattern with the original UPS's name, while preserving all other
 * configured settings. Called from form_actions() when the 'Duplicate'
 * bulk action is confirmed.
 *
 * @param int|array $template_id The apcupsd_ups.id (or array of ids) to
 *                               duplicate.
 * @param string    $name        The new UPS name pattern; '<ups>' is a
 *                               placeholder that this function replaces
 *                               with the original UPS's name.
 *
 * @return void
 */
function duplicate_ups($template_id, $name): void {
	if (!is_array($template_id)) {
		$template_id = [$template_id];
	}

	foreach ($template_id as $id) {
		$ups = db_fetch_row_prepared('SELECT *
			FROM apcupsd_ups
			WHERE id = ?',
			[$id]);
		$ups = is_array($ups) ? $ups : [];

		if (cacti_sizeof($ups)) {
			$save = [];

			$save['id'] = 0;

			foreach ($ups as $column => $value) {
				if ($column == 'id') {
					continue;
				}

				if ($column == 'name') {
					$save['name'] = str_replace('<ups>', $value, $name);
				} else {
					$save[$column] = $value;
				}
			}

			$ups_id = sql_save($save, 'apcupsd_ups');

			if ($ups_id > 0) {
				raise_message(1);
			} else {
				raise_message(2);
			}
		} else {
			raise_message('ups_error', __('Template UPS was not found! Unable to duplicate.'), MESSAGE_LEVEL_ERROR);
		}
	}
}

/* ------------------------
	The 'actions' function
   ------------------------ */

/**
 * Handles the bulk-actions form for the UPSes list (delete/duplicate/
 * reset detection). On first display, renders the confirmation dialog
 * listing the selected UPSes (with a name field for duplication); once
 * confirmed, applies the chosen action to each selected row. Invoked
 * from this file's dispatcher when the request's 'action' is 'actions'.
 *
 * @return void Either redirects back to this page after applying the
 *              action, or prints the confirmation dialog and returns
 *              nothing.
 *
 * @global array $ups_actions Map of bulk-action ids to their display
 *                             labels, used for the confirmation dialog
 *                             title.
 */
function form_actions(): void {
	global $ups_actions;

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

	if (!in_array(get_nfilter_request_var('drp_action'), ['1', '2', '3'], true)) {
		header('Location: upses.php?header=false');
		exit;
	}

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

		if ($selected_items != false && cacti_sizeof($selected_items)) {
			$selected_items        = array_values($selected_items);
			$selected_placeholders = implode(',', array_fill(0, cacti_sizeof($selected_items), '?'));

			if (get_nfilter_request_var('drp_action') == '1') { // delete
				db_execute_prepared("DELETE FROM apcupsd_ups
					WHERE id IN ($selected_placeholders)",
					$selected_items);
			} elseif (get_nfilter_request_var('drp_action') == '2') { // Duplicate
				duplicate_ups($selected_items, get_nfilter_request_var('ups_name'));
			} elseif (get_nfilter_request_var('drp_action') == '3') { // Reset Detection
				db_execute_prepared("UPDATE apcupsd_ups
					SET snmp_skipped = ''
					WHERE id IN ($selected_placeholders)",
					$selected_items);
			}
		}

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

	// setup some variables
	$ups_list  = '';
	$i         = 0;
	$ups_array = [];

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

			$name = db_fetch_cell_prepared('SELECT name FROM apcupsd_ups WHERE id = ?', [$matches[1]]);

			$ups_list .= '<li>' . html_escape($name) . '</li>';
			$ups_array[$i] = $matches[1];

			$i++;
		}
	}

	top_header();

	form_start('upses.php');

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

	if (cacti_sizeof($ups_array)) {
		if (get_nfilter_request_var('drp_action') == '1') { // delete
			print "<tr>
				<td class='textArea' class='odd'>
					<p>" . __n('Click \'Continue\' to Delete the following UPS.  Note, all Devices will be disassociated from this UPS.', 'Click \'Continue\' to Delete all following UPSes.  Note, all devices will be disassociated from this UPS.', cacti_sizeof($ups_array), 'apcupsd') . "</p>
					<div class='itemlist'><ul>$ups_list</ul></div>
				</td>
			</tr>";

			$save_html = "<button type='button' class='ui-button ui-corner-all ui-widget cactiReturnTo' data-url='upses.php'>" . __esc('Cancel', 'apcupsd') . "</button>
				<button type='submit' class='ui-button ui-corner-all ui-widget ui-state-active' title='" . __n('Delete UPS', 'Delete UPSes', cacti_sizeof($ups_array), 'apcupsd') . "'>" . __('Continue', 'apcupsd') . '</button>';
		} elseif (get_nfilter_request_var('drp_action') == '2') { // duplicate
			print "<tr>
				<td class='textArea' class='odd'>
					<p>" . __n('Click \'Continue\' to Duplicate the following UPS.', 'Click \'Continue\' to Duplicate all following UPSes.', cacti_sizeof($ups_array), 'apcupsd') . "</p>
					<div class='itemlist'><ul>$ups_list</ul></div>
					<p><strong>" . __('UPS Name:', 'apcupsd') . '</strong><br>';
			form_text_box('ups_name', '<ups> (1)', '', '255', '30', 'text');
			print '</p>
				</td>
			</tr>';

			$save_html = "<button type='button' class='ui-button ui-corner-all ui-widget cactiReturnTo' data-url='upses.php'>" . __esc('Cancel', 'apcupsd') . "</button>
				<button type='submit' class='ui-button ui-corner-all ui-widget ui-state-active' title='" . __n('Duplicate UPS', 'Duplicate UPSes', cacti_sizeof($ups_array), 'apcupsd') . "'>" . __esc('Continue', 'apcupsd') . '</button>';
		} elseif (get_nfilter_request_var('drp_action') == '3') { // reset
			print "<tr>
				<td class='textArea' class='odd'>
					<p>" . __n('Click \'Continue\' to Reset Discovery the following UPS.  Note, this only applies for SNMPD type UPSes.', 'Click \'Continue\' to Reset Discovery for the following UPSes.  Note, this only applies for SNMPD type UPSes.', cacti_sizeof($ups_array), 'apcupsd') . "</p>
					<div class='itemlist'><ul>$ups_list</ul></div>
				</td>
			</tr>";

			$save_html = "<button type='button' class='ui-button ui-corner-all ui-widget cactiReturnTo' data-url='upses.php'>" . __esc('Cancel', 'apcupsd') . "</button>
				<input type='submit' class='ui-button ui-corner-all ui-widget ui-state-active' title='" . __n('Reset UPS', 'Reset UPSes', cacti_sizeof($ups_array), 'apcupsd') . "'>" . __esc('Continue', 'apcupsd') . '</button>';
		}
	} else {
		raise_message(40);
		header('Location: upses.php?header=false');
		exit;
	}

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

	html_end_box();

	form_end();

	bottom_footer();
}

/**
 * Renders the add/edit form for a single UPS, pre-populating its fields
 * (including the linked Cacti device's description/location) when
 * editing an existing UPS, and wiring up the client-side JavaScript that
 * toggles the apcupsd/SNMP-specific field groups based on the selected
 * UPS type. Invoked from this file's dispatcher when the request's
 * 'action' is 'edit'.
 *
 * @return void Outputs the edit form HTML and JavaScript directly.
 *
 * @global array $fields_ups_edit The edit form's field definitions,
 *                                 populated here with the UPS's current
 *                                 values.
 */
function ups_edit(): void {
	global $fields_ups_edit;

	// ================= input validation =================
	get_filter_request_var('id');
	// ====================================================

	if (get_request_var('id') > 0) {
		$ups          = db_fetch_row_prepared('SELECT * FROM apcupsd_ups WHERE id = ?', [get_request_var('id')]);
		$ups          = is_array($ups) ? $ups : [];
		$header_label = __esc('UPS [edit: %s]', $ups['name'] ?? '', 'apcupsd');
	} else {
		$ups          = [];
		$header_label = __('UPS [new]', 'apcupsd');
	}

	if (isset($ups['host_id']) && $ups['host_id'] > 0) {
		$fields_ups_edit['host_id']['value']  = db_fetch_cell_prepared('SELECT description FROM host WHERE id = ?', [$ups['host_id']]);
		$fields_ups_edit['location']['value'] = db_fetch_cell_prepared('SELECT location FROM host WHERE id = ?', [$ups['host_id']]);
		$fields_ups_edit['location']['id']    = db_fetch_cell_prepared('SELECT location FROM host WHERE id = ?', [$ups['host_id']]);
	} else {
		unset($fields_ups_edit['location']);
	}

	// setup the callback for the form
	$_SESSION['cur_device_id'] = get_request_var('id');

	form_start('upses.php', 'ups');

	html_start_box($header_label, '100%', true, 3, 'center', '');

	draw_edit_form(
		[
			'config' => ['no_form_tag' => true],
			'fields' => inject_form_variables($fields_ups_edit, $ups)
		]
	);

	html_end_box(true, true);

	form_save_button('upses.php', 'return');

	?>
	<script type='text/javascript' <?php print plugin_apcupsd_csp_nonce(); ?>>
	var showHost = false;

	// default snmp information
	var snmp_community       = $('#snmp_community').val();
	var snmp_username        = $('#snmp_username').val();
	var snmp_password        = $('#snmp_password').val();
	var snmp_auth_protocol   = $('#snmp_auth_protocol').val();
	var snmp_priv_passphrase = $('#snmp_priv_passphrase').val();
	var snmp_priv_protocol   = $('#snmp_priv_protocol').val();
	var snmp_context         = $('#snmp_context').val();
	var snmp_engine_id       = $('#snmp_engine_id').val();
	var snmp_port            = $('#snmp_port').val();
	var snmp_timeout         = $('#snmp_timeout').val();

	function changeType() {
		if ($('#type_id').val() == 1) {
			$('#row_spacer1').show();
			$('#row_hostname').show();
			$('#row_port').show();
			$('#row_host_snmp_head').hide();
			$('[id^="row_snmp"]').hide();
		} else if ($('#type_id').val() == 2) {
			$('#row_host_id').show();
			$('#row_spacer1').hide();
			$('#row_hostname').hide();
			$('#row_port').hide();
			$('#row_host_snmp_head').show();
			$('[id^="row_snmp"]').show();
			setSNMP();
		} else {
			$('#row_spacer1').show();
			$('#row_hostname').show();
			$('#row_port').show();
		}
	}

	$(function() {
		$('#type_id').change(function() {
			changeType();
		});

		$('#snmp_version').change(function() {
			setSNMP();
		});

		setSNMP();
		changeType();
	});
	</script>
	<?php
}

/**
 * Renders the main UPSes list page: warns when the APCUPSD host template
 * hasn't been imported yet, draws the search/filter toolbar, queries
 * apcupsd_ups with the current filter/sort/pagination settings, and
 * prints the paginated results table with each UPS's status. Invoked
 * from this file's dispatcher for the default (no 'action') request.
 *
 * @return void Outputs the list page HTML directly.
 *
 * @global array $ups_actions Map of bulk-action ids to their display
 *                             labels, used to populate the actions
 *                             dropdown.
 * @global array $item_rows   Rows-per-page options offered by Cacti core,
 *                             used to populate the 'rows' select list.
 * @global array $config      Cacti global configuration array; used
 *                             throughout list rendering.
 */
function upses(): void {
	global $ups_actions, $item_rows, $config;

	apcupsd_dashboard_tabs('list');

	if (!apcupsd_host_template_imported()) {
		raise_message('apcupsd_template_missing', __('The APCUPSD Device Template has not been imported.  Device automation will not happen until it is imported!', 'apcupsd'), MESSAGE_LEVEL_ERROR);
	}

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

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

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

	html_start_box(__('UPSes', 'apcupsd'), '100%', false, 3, 'center', 'upses.php?action=edit');

	?>
	<tr class='even'>
		<td>
			<form id='form_ups' action='upses.php'>
			<table class='filterTable'>
				<tr>
					<td>
						<?php print __('Search', 'apcupsd'); ?>
					</td>
					<td>
						<input type='text' class='ui-state-default ui-corner-all' id='filter' size='25' value='<?php print html_escape_request_var('filter'); ?>'>
					</td>
					<td>
						<?php print __('Site', 'apcupsd'); ?>
					</td>
					<td>
						<select id='site_id'>
							<option value='-1'<?php print (get_request_var('site_id') == '-1' ? ' selected>' : '>') . __('All', 'apcupsd'); ?></option>
							<option value='-2'<?php print (get_request_var('site_id') == '-2' ? ' selected>' : '>') . __('None', 'apcupsd'); ?></option>
							<?php
							$sites = array_rekey(
								db_fetch_assoc_prepared('SELECT s.id, s.name
									FROM sites AS s
									INNER JOIN apcupsd_ups AS u
									ON s.id = u.site_id
									ORDER BY s.name',
									[]),
								'id', 'name'
							);

	if (cacti_sizeof($sites)) {
		foreach ($sites as $key => $value) {
			print "<option value='" . $key . "'" . (get_request_var('site_id') == $key ? ' selected' : '') . '>' . html_escape($value) . '</option>';
		}
	}
	?>
						</select>
					</td>
					<td>
						<?php print __('Location', 'apcupsd'); ?>
					</td>
					<td>
						<select id='location'>
							<option value='-1'<?php print (get_request_var('location') == '-1' ? ' selected>' : '>') . __('All', 'apcupsd'); ?></option>
							<option value='-2'<?php print (get_request_var('location') == '-2' ? ' selected>' : '>') . __('None', 'apcupsd'); ?></option>
							<?php
	$locations = array_rekey(
		db_fetch_assoc_prepared('SELECT DISTINCT h.location AS id, h.location AS name
									FROM host AS h
									INNER JOIN apcupsd_ups AS u
									ON h.id = u.host_id
									ORDER BY h.location',
			[]),
		'id', 'name'
	);

	if (cacti_sizeof($locations)) {
		foreach ($locations as $key => $value) {
			print "<option value='" . $key . "'" . (get_request_var('location') == $key ? ' selected' : '') . '>' . html_escape($value) . '</option>';
		}
	}
	?>
						</select>
					</td>
					<td>
						<?php print __('UPSes', 'apcupsd'); ?>
					</td>
					<td>
						<select id='rows'>
							<option value='-1'<?php print (get_request_var('rows') == '-1' ? ' selected>' : '>') . __('Default', 'apcupsd'); ?></option>
							<?php
	if (cacti_sizeof($item_rows)) {
		foreach ($item_rows as $key => $value) {
			print "<option value='" . $key . "'" . (get_request_var('rows') == $key ? ' selected' : '') . '>' . html_escape($value) . '</option>';
		}
	}
	?>
						</select>
					</td>
					<td>
						<span>
							<button type='submit' class='ui-button ui-corner-all ui-widget' id='refresh' title='<?php print __esc('Set/Refresh Filters', 'apcupsd'); ?>'><?php print __esc('Go', 'apcupsd'); ?></button>
							<button type='button' class='ui-button ui-corner-all ui-widget' id='clear' title='<?php print __esc('Clear Filters', 'apcupsd'); ?>'><?php print __esc('Clear', 'apcupsd'); ?></button>
						</span>
					</td>
				</tr>
			</table>
			</form>
			<script type='text/javascript' <?php print plugin_apcupsd_csp_nonce(); ?>>

			function applyFilter() {
				strURL  = 'upses.php?header=false';
				strURL += '&filter='+$('#filter').val();
				strURL += '&site_id='+$('#site_id').val();
				strURL += '&location='+$('#location').val();
				strURL += '&rows='+$('#rows').val();
				loadPageNoHeader(strURL);
			}

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

			$(function() {
				$('#site_id, #location, #rows').change(function() {
					applyFilter();
				});

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

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

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

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

	html_end_box();

	$sql_where  = '';
	$sql_params = [];

	// form the 'where' clause for our main sql query
	if (get_request_var('filter') != '') {
		$sql_where    = 'WHERE ups.name LIKE ?';
		$sql_params[] = '%' . get_request_var('filter') . '%';
	}

	if (get_request_var('site_id') > 0) {
		$sql_where .= ($sql_where != '' ? ' AND ' : 'WHERE ') . ' ups.site_id = ?';
		$sql_params[] = get_request_var('site_id');
	} elseif (get_request_var('site_id') == -2) {
		$sql_where .= ($sql_where != '' ? ' AND ' : 'WHERE ') . ' ups.site_id = 0';
	}

	if (get_request_var('location') == -2) {
		$sql_where .= ($sql_where != '' ? ' AND ' : 'WHERE ') . ' h.location = ""';
	} elseif (get_request_var('location') != -1) {
		$sql_where .= ($sql_where != '' ? ' AND ' : 'WHERE ') . ' h.location = ?';
		$sql_params[] = get_request_var('location');
	}

	$total_rows = db_fetch_cell_prepared("SELECT COUNT(*)
		FROM apcupsd_ups AS ups
		LEFT JOIN apcupsd_ups_stats AS stats
		ON ups.id = stats.ups_id
		LEFT JOIN host AS h
		ON h.id = ups.host_id
		$sql_where",
		$sql_params);

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

	$ups_list = db_fetch_assoc_prepared("SELECT ups.*, stats.*
		FROM apcupsd_ups AS ups
		LEFT JOIN apcupsd_ups_stats AS stats
		ON ups.id = stats.ups_id
		LEFT JOIN host AS h
		ON h.id = ups.host_id
		$sql_where
		$sql_order
		$sql_limit",
		$sql_params);

	$display_text = [
		'name' => [
			'display' => __('UPS Name', 'apcupsd'),
			'align'   => 'left',
			'sort'    => 'ASC',
			'tip'     => __('The Name of this UPS.', 'apcupsd')
		],
		'id' => [
			'display' => __('ID', 'apcupsd'),
			'align'   => 'center',
			'sort'    => 'ASC',
			'tip'     => __('The unique id associated with this UPS.', 'apcupsd')
		],
		'host_id' => [
			'display' => __('DID', 'apcupsd'),
			'align'   => 'center',
			'sort'    => 'ASC',
			'tip'     => __('The Cacti Device ID.', 'apcupsd')
		],
		'status' => [
			'display' => __('Status', 'apcupsd'),
			'align'   => 'center',
			'sort'    => 'ASC',
			'tip'     => __('The Status of the apcupsd daemon on the target Host.', 'apcupsd')
		],
		'type_id' => [
			'display' => __('Collector', 'apcupsd'),
			'align'   => 'left',
			'sort'    => 'ASC',
			'tip'     => __('The Type of Collector.  Currently APCUPSD and SNMP are supported.', 'apcupsd')
		],
		'ups_status' => [
			'display' => __('UPS Status', 'apcupsd'),
			'align'   => 'left',
			'sort'    => 'ASC',
			'tip'     => __('The Status of the monitored UPS on the target Host.', 'apcupsd')
		],
		'ups_model' => [
			'display' => __('UPS Model', 'apcupsd'),
			'align'   => 'left',
			'sort'    => 'ASC',
			'tip'     => __('The Model of the monitored UPS on the target Host.', 'apcupsd')
		],
		'ups_line_voltage' => [
			'display' => __('Line Voltage', 'apcupsd'),
			'align'   => 'right',
			'sort'    => 'DESC',
			'tip'     => __('The Line Voltage of the monitored UPS on the target Host.', 'apcupsd')
		],
		'ups_load_percent' => [
			'display' => __('Load Percent', 'apcupsd'),
			'align'   => 'right',
			'sort'    => 'DESC',
			'tip'     => __('The Load Percent of the monitored UPS on the target Host.', 'apcupsd')
		],
		'ups_timeleft' => [
			'display' => __('Time Left', 'apcupsd'),
			'align'   => 'right',
			'sort'    => 'DESC',
			'tip'     => __('The minutes of available UPS charge of the monitored UPS on the target Host.', 'apcupsd')
		],
		'nosort' => [
			'display' => __('Hostname:Port', 'apcupsd'),
			'align'   => 'right',
			'sort'    => 'DESC',
			'tip'     => __('The Hostname:Port that is running the apcupsd daemon.', 'apcupsd')
		],
		'enabled' => [
			'display' => __('Enabled', 'apcupsd'),
			'align'   => 'right',
			'sort'    => 'DESC',
			'tip'     => __('If this UPS is being monitored or not.', 'apcupsd')
		],
		'last_updated' => [
			'display' => __('Last Updated', 'apcupsd'),
			'align'   => 'right',
			'sort'    => 'DESC',
			'tip'     => __('The last time this UPS was samples or found up.', 'apcupsd')
		]
	];

	$nav = html_nav_bar('upses.php?filter=' . get_request_var('filter'), MAX_DISPLAY_PAGES, get_request_var('page'), $rows, $total_rows, cacti_sizeof($display_text) + 1, __('UPSes', 'apcupsd'), 'page', 'main');

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

	print $nav;

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

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

	$i = 0;

	if (cacti_sizeof($ups_list)) {
		foreach ($ups_list as $ups) {
			form_alternate_row('line' . $ups['id'], true);

			form_selectable_cell("<a class='apcupsdDashGlyph' href='upses.php?action=view&id=" . $ups['id'] . "' title='" . __esc('View UPS Dashboard', 'apcupsd') . "'><i class='fas fa-tachometer-alt'></i></a> " . filter_value($ups['name'], get_request_var('filter'), 'upses.php?action=edit&id=' . $ups['id']), $ups['id']);
			form_selectable_cell($ups['id'], $ups['id'], '', 'center');
			form_selectable_cell($ups['host_id'], $ups['id'], '', 'center');
			form_selectable_cell(get_colored_device_status(($ups['enabled'] == '' ? true : false), $ups['status']), $ups['id'], '', 'center');
			form_selectable_ecell($ups['type_id'] == 1 ? 'APCUPSD' : 'SNMPD', $ups['id'], '', 'left');
			form_selectable_ecell($ups['ups_status'], $ups['id'], '', 'left');
			form_selectable_ecell($ups['ups_model'], $ups['id'], '', 'left');
			form_selectable_ecell(checkNullandReturn($ups['ups_line_voltage']), $ups['id'], '', 'right');
			form_selectable_ecell(checkNullandReturn($ups['ups_load_percent']), $ups['id'], '', 'right');
			form_selectable_ecell(round((float)($ups['ups_timeleft'] ?? 0), 2), $ups['id'], '', 'right');

			if ($ups['type_id'] == 1) {
				form_selectable_ecell($ups['hostname'] . ':' . $ups['port'], $ups['id'], '', 'right');
			} else {
				form_selectable_ecell($ups['hostname'] . ':' . $ups['snmp_port'], $ups['id'], '', 'right');
			}

			form_selectable_ecell($ups['enabled'] == 'on' ? __('Yes', 'apcupsd') : __('No', 'apcupsd'), $ups['id'], '', 'right');
			form_selectable_ecell($ups['last_updated'], $ups['id'], '', 'right');

			form_checkbox_cell($ups['name'], $ups['id']);

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

	html_end_box(false);

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

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

	form_end();
}

/**
 * Returns a display-friendly placeholder for a possibly-null UPS reading
 * value. Called from upses() while rendering the UPS list's stat values
 * that may not yet have been polled.
 *
 * @param mixed $value The value to check.
 *
 * @return mixed The localized 'Not Avail' string when $value is null;
 *               otherwise $value unchanged.
 */
function checkNullandReturn($value) {
	if ($value === null) {
		return __('Not Avail', 'apcupsd');
	} else {
		return $value;
	}
}

/**
 * Returns Cacti host 'location' values matching an autocomplete search
 * term as a JSON array, optionally restricted to the current device's
 * site when the 'site_location_filter' setting is enabled. Invoked from
 * this file's dispatcher when the request's 'action' is 'ajax_locations',
 * used by the edit form's Location autocomplete field.
 *
 * @return void Outputs a JSON-encoded array of matching locations
 *              directly.
 */
function get_site_locations(): void {
	$return  = [];
	$term    = get_nfilter_request_var('term');
	$host_id = $_SESSION['cur_device_id'];

	$args  = ["%$term%"];
	$where = '';

	if (read_config_option('site_location_filter') && $_SESSION['cur_device_id']) {
		$site_id = db_fetch_cell_prepared('SELECT site_id
			FROM host
			WHERE id = ?',
			[$host_id]);
		$args[] = $site_id;
		$where  = 'AND site_id = ?';
	}

	$locations = db_fetch_assoc_prepared("SELECT DISTINCT location
		FROM host
		WHERE location LIKE ?
		AND location != ''
		AND location IS NOT NULL
		$where
		ORDER BY location",
		$args);

	if (cacti_sizeof($locations)) {
		foreach ($locations as $l) {
			$return[] = ['label' => $l['location'], 'value' => $l['location'], 'id' => $l['location']];
		}
	}

	if (!cacti_sizeof($return)) {
		$return[] = ['label' => __('None', 'apcupsd'), 'value' => '', 'id' => __('None', 'apcupsd')];
	}

	print json_encode($return);
}