mactrack_macwatch.php

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

chdir('../../');
require('./include/auth.php');
require_once('./plugins/mactrack/lib/mactrack_functions.php');

$macw_actions = [
	1 => __('Delete', 'mactrack'),
	2 => __('Disable', 'mactrack')
];

set_default_action();

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

		break;
	case 'actions':
		form_actions();

		break;
	case 'edit':
		top_header();
		mactrack_macw_edit();
		bottom_footer();

		break;
	default:
		top_header();
		mactrack_macw();
		bottom_footer();

		break;
}

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

/**
 * Validates and saves the MAC watch edit form's submitted fields via
 * api_mactrack_macw_save(), then redirects back to the edit form for
 * the saved (or original) mac id. Called from this script's main
 * request-dispatch switch when action=save.
 *
 * @return void
 */
function form_save(): void {
	if ((isset_request_var('save_component_macw')) && (isempty_request_var('add_dq_y'))) {
		$mac_id = api_mactrack_macw_save(get_nfilter_request_var('mac_id'),
			get_nfilter_request_var('mac_address'), get_nfilter_request_var('name'),
			get_nfilter_request_var('ticket_number'), get_nfilter_request_var('description'),
			get_nfilter_request_var('notify_schedule'), get_nfilter_request_var('email_addresses'));

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

		header('Location: mactrack_macwatch.php?action=edit&header=false&id=' . (empty($mac_id) ? get_request_var('mac_id') : $mac_id));
	}
}

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

/**
 * Handles the bulk-action confirmation page/submission for the MAC
 * watch list: on confirmed submission with selected_items set,
 * performs the requested action (currently delete) for each selected
 * entry; on first display, renders a confirmation box listing the
 * selected entries. Called from this script's main request-dispatch
 * switch when action=actions.
 *
 * @return void
 *
 * @global array $config                     Cacti global configuration
 *                                           array (declared but not
 *                                           used directly here).
 * @global array $macw_actions               Map of drp_action value =>
 *                                           action label, used for the
 *                                           bulk-actions confirmation
 *                                           display.
 * @global array $fields_mactrack_macw_edit  Reserved/declared for
 *                                           parity with other functions
 *                                           in this file; not used
 *                                           directly here.
 */
function form_actions(): void {
	global $config, $macw_actions, $fields_mactrack_macw_edit;

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

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

		if ($selected_items != false) {
			if (get_request_var('drp_action') == '1') { // delete
				for ($i = 0; $i < cacti_sizeof($selected_items); $i++) {
					api_mactrack_macw_remove($selected_items[$i]);
				}
			}

			header('Location: mactrack_macwatch.php');
			exit;
		}
	}

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

	// loop through each of the mac watch items 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]);
			// ====================================================

			$macw_info = db_fetch_cell_prepared('SELECT name
				FROM mac_track_macwatch
				WHERE mac_id = ?',
				[$matches[1]]);

			$macw_list .= '<li>' . $macw_info . '</li>';
			$macw_array[$i] = $matches[1];
			$i++;
		}
	}

	top_header();

	form_start('mactrack_macwatch.php');

	html_start_box($macw_actions[get_request_var('drp_action')], '60%', '', '3', 'center', '');

	if (!isset($macw_array)) {
		raise_message(40);
		header('Location: mactrack_macwatch.php');
		exit;
	} else {
		$save_html = "<button type='submit' name='save' class='ui-button ui-corner-all ui-widget ui-state-active'>" . __esc('Continue', 'mactrack') . '</button>';

		if (get_request_var('drp_action') == '1') { // delete
			print "<tr>
				<td class='textArea'>
					<p>" . __('Click \'Continue\' to delete the following watched Mac\'s?', 'mactrack') . "</p>
					<ul>$macw_list</ul>
				</td>
			</tr>";
		}
	}

	print "<tr>
		<td align='right' class='saveRow'>
			<input type='hidden' name='action' value='actions'>
			<input type='hidden' name='selected_items' value='" . serialize($macw_array) . "'>
			<input type='hidden' name='drp_action' value='" . get_request_var('drp_action') . "'>" . ($save_html != '' ? "
			<button type='button' class='ui-button ui-corner-all ui-widget' onClick='cactiReturnTo()'>" . __esc('Cancel', 'mactrack') . "</button>
			$save_html" : "<button type='button' class='ui-button ui-corner-all ui-widget' onClick='cactiReturnTo()'>" . __esc('Return', 'mactrack') . '</button>') . '
		</td>
	</tr>';

	html_end_box();

	form_end();

	bottom_footer();
}

/**
 * Validates and saves a MAC watch record's fields (MAC address, name,
 * ticket number, description, notification schedule, and notification
 * email addresses).
 *
 * @param int    $mac_id           The mac watch record id (0 for a new
 *                                record).
 * @param string $mac_address      The MAC address (or prefix) to
 *                                watch.
 * @param string $name             A display name for the watch entry.
 * @param string $ticket_number    An associated ticket/reference
 *                                number.
 * @param string $description      A free-form description for the
 *                                entry.
 * @param string $notify_schedule  The notification schedule setting.
 * @param string $email_addresses  Comma/semicolon-delimited email
 *                                addresses to notify when the watched
 *                                MAC is seen.
 *
 * @return int The saved mac_id, or 0 if validation/save failed.
 */
function api_mactrack_macw_save($mac_id, $mac_address, $name, $ticket_number, $description, $notify_schedule, $email_addresses): int {
	$save['mac_id']          = $mac_id;
	$save['mac_address']     = form_input_validate($mac_address, 'mac_address', '', false, 3);
	$save['name']            = form_input_validate($name, 'name', '', false, 3);
	$save['ticket_number']   = form_input_validate($ticket_number, 'ticket_number', '', false, 3);
	$save['description']     = form_input_validate($description, 'description', '', false, 3);
	$save['notify_schedule'] = form_input_validate($notify_schedule, 'notify_schedule', '', false, 3);
	$save['email_addresses'] = form_input_validate($email_addresses, 'email_addresses', '', false, 3);

	$mac_id = 0;

	if (!is_error_message()) {
		$mac_id = sql_save($save, 'mac_track_macwatch', 'mac_address', false);

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

	return $mac_id;
}

/**
 * Deletes a MAC watch record.
 *
 * @param int $mac_id The mac watch record id to remove.
 *
 * @return void
 */
function api_mactrack_macw_remove($mac_id): void {
	db_execute_prepared('DELETE FROM mac_track_macwatch WHERE mac_id = ?', [$mac_id]);
}

/* ---------------------
	MacWatch Functions
   --------------------- */

/**
 * Builds and executes the SQL query for the MAC watch list view,
 * applying the current filter text request variable, sort order, and
 * optional row limits.
 *
 * @param string &$sql_where   Receives the generated SQL WHERE clause.
 * @param int    $rows         Number of rows per page, used to compute
 *                            the SQL LIMIT clause when $apply_limits
 *                            is true.
 * @param bool   $apply_limits Whether to apply a SQL LIMIT clause
 *                            (default true).
 *
 * @return array The matching MAC watch records.
 */
function mactrack_macw_get_macw_records(&$sql_where, $rows, $apply_limits = true): array {
	$sql_where = '';

	// form the 'where' clause for our main sql query
	if (get_request_var('filter') != '') {
		$sql_where = 'WHERE (mac_address LIKE ' . db_qstr('%' . get_request_var('filter') . '%') . ' OR ' .
			'name LIKE ' . db_qstr('%' . get_request_var('filter') . '%') . ' OR ' .
			'ticket_number LIKE ' . db_qstr('%' . get_request_var('filter') . '%') . ' OR ' .
			'description LIKE ' . db_qstr('%' . get_request_var('filter') . '%') . ')';
	}

	$sql_order = get_order_string();

	if ($apply_limits) {
		$sql_limit = ' LIMIT ' . ($rows * (get_request_var('page') - 1)) . ',' . $rows;
	} else {
		$sql_limit = '';
	}

	$query_string = "SELECT *
		FROM mac_track_macwatch
		$sql_where
		$sql_order
		$sql_limit";

	return db_fetch_assoc($query_string);
}

/**
 * Renders the add/edit form for a MAC watch record (MAC address, name,
 * ticket number, description, notification schedule, notification
 * email addresses).
 *
 * @return void
 *
 * @global array $fields_mactrack_macw_edit The MAC watch edit form's
 *                                         field definitions.
 */
function mactrack_macw_edit(): void {
	global $fields_mactrack_macw_edit;

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

	if (!isempty_request_var('mac_id')) {
		$mac_record = (array) db_fetch_row_prepared('SELECT *
			FROM mac_track_macwatch
			WHERE mac_id = ?',
			[get_request_var('mac_id')]);

		$header_label = __('Mactrack MacWatch [edit: %s]', $mac_record['name'], 'mactrack');
	} else {
		$header_label = __('Mactrack MacWatch [new]', 'mactrack');
	}

	form_start('mactrack_macwatch.php', 'mactrack_macwatch');

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

	draw_edit_form(
		[
			'config' => ['no_form_tag' => true],
			'fields' => inject_form_variables($fields_mactrack_macw_edit, ($mac_record ?? []))
		]
	);

	html_end_box();

	form_save_button('mactrack_macwatch.php', 'return');
}

/**
 * Renders the main MAC watch list page: validates/stores this view's
 * filter request variables, displays the filter form, then displays a
 * filtered, sorted, paginated table of watched MAC addresses with a
 * bulk-actions dropdown. Called from this script's main
 * request-dispatch switch as the default view.
 *
 * @return void
 *
 * @global array $macw_actions Map of drp_action value => action label,
 *                            used for the bulk-actions dropdown.
 * @global array $config      Cacti global configuration array (declared
 *                            but not used directly here).
 * @global int   $item_rows   Default number of rows per page from
 *                            Cacti settings.
 */
function mactrack_macw(): void {
	global $macw_actions, $config, $item_rows;

	// ================= input validation and session storage =================
	$filters = [
		'rows' => [
			'filter'  => FILTER_VALIDATE_INT,
			'pageset' => true,
			'default' => '-1'
			],
		'page' => [
			'filter'  => FILTER_VALIDATE_INT,
			'default' => '1'
			],
		'filter' => [
			'filter'  => FILTER_CALLBACK,
			'pageset' => true,
			'default' => '',
			'options' => ['options' => 'sanitize_search_string']
			],
		'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_mt_macw');
	// ================= input validation =================

	$rows = plugin_get_rows_per_page();

	html_start_box(__('Mactrack MacWatch Filters', 'mactrack'), '100%', '', '3', 'center', 'mactrack_macwatch.php?action=edit');
	mactrack_macw_filter();
	html_end_box();

	$sql_where = '';

	$macw = mactrack_macw_get_macw_records($sql_where, $rows);

	$total_rows = db_fetch_cell("SELECT count(*) FROM mac_track_macwatch $sql_where");

	$display_text = [
		'name' => [
			'display' => __('Watch Name', 'mactrack'),
			'sort'    => 'ASC'
		],
		'mac_address' => [
			'display' => __('Mac Address', 'mactrack'),
			'sort'    => 'ASC'
		],
		'ticket_number' => [
			'display' => __('Ticket Number', 'mactrack'),
			'sort'    => 'ASC'
		],
		'date_first_seen' => [
			'display' => __('First Seen', 'mactrack'),
			'sort'    => 'ASC'
		],
		'date_last_seen'  => [
			'display' => __('Last Seen', 'mactrack'),
			'sort'    => 'ASC'
		]
	];

	$columns = cacti_sizeof($display_text) + 1;

	$nav = html_nav_bar('mactrack_macwatch.php?filter=' . get_request_var('filter'), MAX_DISPLAY_PAGES, get_request_var('page'), $rows, $total_rows, $columns, __('Watches', 'mactrack'), 'page', 'main');

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

	print $nav;

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

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

	$i = 0;

	if (cacti_sizeof($macw)) {
		foreach ($macw as $mac) {
			form_alternate_row('line' . $mac['mac_id'], true);

			form_selectable_cell(filter_value($mac['name'], get_request_var('filter'), 'mactrack_macwatch.php?action=edit&mac_id=' . $mac['mac_id']), $mac['mac_id']);
			form_selectable_cell(filter_value($mac['mac_address'], get_request_var('filter')), $mac['mac_id']);
			form_selectable_cell(filter_value($mac['ticket_number'], get_request_var('filter')), $mac['mac_id']);
			form_selectable_cell($mac['date_first_seen'] == '0000-00-00 00:00:00' ? __('N/A', 'mactrack') : $mac['date_first_seen'], $mac['mac_id']);
			form_selectable_cell($mac['date_last_seen'] == '0000-00-00 00:00:00' ? __('N/A', 'mactrack') : $mac['date_last_seen'], $mac['mac_id']);
			form_checkbox_cell($mac['name'], $mac['mac_id']);

			form_end_row();
		}
	} else {
		print '<tr><td colspan="' . $columns . '"><em>' . __('No Mactrack Watched Macs Found', 'mactrack') . '</em></td></tr>';
	}

	html_end_box(false);

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

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

	form_end();
}

/**
 * Renders the search/rows filter form controls for the MAC watch list
 * view.
 *
 * @return void
 *
 * @global array $item_rows Rows-per-page option list used to populate
 *                         the rows dropdown.
 */
function mactrack_macw_filter(): void {
	global $item_rows;

	?>
	<tr class='even'>
		<td>
			<form id='mactrack'>
			<table class='filterTable'>
				<tr>
					<td>
						<?php print __('Search', 'mactrack'); ?>
					</td>
					<td>
						<input type='text' id='filter' size='25' value='<?php print html_escape_request_var('filter'); ?>'>
					</td>
					<td>
						<?php print __('Watches', 'mactrack'); ?>
					</td>
					<td>
						<select id='rows' onChange='applyFilter()'>
							<option value='-1'<?php if (get_request_var('rows') == '-1') {?> selected<?php }?>><?php print __('Default', 'mactrack'); ?></option>
							<?php
							if (cacti_sizeof($item_rows)) {
								foreach ($item_rows as $key => $value) {
									print "<option value='" . $key . "'";

									if (get_request_var('rows') == $key) {
										print ' selected';
									} print '>' . $value . '</option>';
								}
							}
	?>
						</select>
					</td>
					<td>
						<span class='nowrap'>
							<button type='submit' id='go' class='ui-button ui-corner-all ui-widget ui-state-active'><?php print __esc('Go', 'mactrack'); ?></button>
							<button type='button' id='clear' class='ui-button ui-corner-all ui-widget'><?php print __esc('Clear', 'mactrack'); ?></button>
						</span>
					</td>
				</tr>
			</table>
			<input type='hidden' id='page' value='<?php print html_escape_request_var('page'); ?>'>
			</form>
			<script type='text/javascript' <?php print plugin_mactrack_csp_nonce(); ?>>

			function applyFilter() {
				strURL  = urlPath+'plugins/mactrack/mactrack_macwatch.php?header=false';
				strURL += '&filter=' + $('#filter').val();
				strURL += '&rows=' + $('#rows').val();
				loadPageNoHeader(strURL);
			}

			function clearFilter() {
				strURL  = urlPath+'plugins/mactrack/mactrack_macwatch.php?header=false&clear=true';
				loadPageNoHeader(strURL);
			}

			$(function() {
				$('#mactrack').on('submit', function(event) {
					event.preventDefault();
					applyFilter();
				});

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

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