router-backups.php

<?php

declare(strict_types = 1);
/*
 +-------------------------------------------------------------------------+
 | 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(__DIR__ . '/includes/functions.php');

set_default_action();

switch (get_nfilter_request_var('action')) {
	case 'viewconfig':
		view_device_config();

		break;
	default:
		if (read_config_option('routerconfigs_presentation') == 'console') {
			top_header();
		} else {
			general_header();
		}

		display_tabs();
		show_devices();

		bottom_footer();

		break;
}

/**
 * Displays the raw content of a single stored backup configuration file.
 * Invoked from this file's dispatcher when the request's 'action' is
 * 'viewconfig'.
 *
 * @return void Outputs the backup file content via
 *              plugin_routerconfigs_view_device_config().
 */
function view_device_config() {
	// ================= input validation =================
	get_filter_request_var('id');
	get_filter_request_var('device');
	// ====================================================

	plugin_routerconfigs_view_device_config(get_filter_request_var('id'), get_filter_request_var('device'), 'router-backups.php');
}

/**
 * Validates and stores the Backups list's filter/sort/pagination
 * variables (device, free-text search, sort column/direction) in the
 * session. Called from show_devices() before rendering the list.
 *
 * @return void
 */
function backups_validate_vars() {
	// ================= 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' => 'hostname',
			'options' => ['options' => 'sanitize_search_string']
		],
		'sort_direction' => [
			'filter'  => FILTER_CALLBACK,
			'default' => 'ASC',
			'options' => ['options' => 'sanitize_search_string']
		],
		'device' => [
			'filter'  => FILTER_VALIDATE_INT,
			'pageset' => true,
			'default' => '-1'
		],
	];

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

/**
 * Renders the main Backups list page: validates the request, draws the
 * device/free-text filter toolbar, and prints the paginated, sortable
 * table of stored backup files across all devices. Invoked from this
 * file's dispatcher for the default (no 'action') request.
 *
 * @return void Outputs the list page HTML directly.
 *
 * @global mixed $action     Reserved/declared for parity with other
 *                           functions in this file; not used directly
 *                           here.
 * @global mixed $device     Reserved/declared for parity with other
 *                           functions in this file; not used directly
 *                           here.
 * @global array $config     Cacti global configuration array (declared
 *                           but not directly used here).
 * @global array $item_rows  Rows-per-page options offered by Cacti
 *                           core, used to populate the 'rows' select
 *                           list.
 */
function show_devices() {
	global $action, $device, $config, $item_rows;

	backups_validate_vars();

	// if the number of rows is -1, set it to the default
	if (get_request_var('rows') == -1) {
		$num_rows = read_config_option('num_rows_table');
	} else {
		$num_rows = get_request_var('rows');
	}

	if (get_filter_request_var('page') > 0) {
		$page = get_request_var('page');
	} else {
		$page = 1;
	}

	$sql_where  = '';
	$sql_params = [];
	$sql_order  = get_order_string();
	$sql_limit  = 'LIMIT ' . ($num_rows * (get_request_var('page') - 1)) . ', ' . $num_rows;

	if (get_request_var('device') > 0) {
		$sql_where    = 'WHERE prb.device = ?';
		$sql_params[] = get_request_var('device');
	}

	if (get_request_var('filter') != '') {
		$sql_where .= ($sql_where != '' ? ' AND ' : 'WHERE ') .
			' (prd.hostname LIKE ? OR prd.ipaddress LIKE ? OR prb.id LIKE ? OR prb.lastuser LIKE ? OR
				prb.directory LIKE ? OR prb.filename LIKE ? OR prb.device LIKE ?)';

		$sql_params[] = '%' . get_request_var('filter') . '%';
		$sql_params[] = '%' . get_request_var('filter') . '%';
		$sql_params[] = '%' . get_request_var('filter') . '%';
		$sql_params[] = '%' . get_request_var('filter') . '%';
		$sql_params[] = '%' . get_request_var('filter') . '%';
		$sql_params[] = '%' . get_request_var('filter') . '%';
		$sql_params[] = '%' . get_request_var('filter') . '%';
	}

	$result = db_fetch_assoc_prepared("SELECT prd.hostname, prd.ipaddress, prb.id,
		prb.lastuser, prb.lastchange, prb.btime, prb.device, prb.directory,
		prb.filename, prd.lastbackup
		FROM plugin_routerconfigs_devices AS prd
		INNER JOIN plugin_routerconfigs_backups AS prb
		ON prd.id = prb.device
		$sql_where
		$sql_order
		$sql_limit",
		$sql_params);

	$total_rows = db_fetch_cell_prepared("SELECT COUNT(*)
		FROM plugin_routerconfigs_devices AS prd
		INNER JOIN plugin_routerconfigs_backups AS prb
		ON prd.id = prb.device
		$sql_where",
		$sql_params);

	?>
	<script type='text/javascript' <?php print plugin_routerconfigs_csp_nonce(); ?>>

	function applyFilter() {
		var strURL  = urlPath + 'plugins/routerconfigs/router-backups.php';
		strURL += '?device=' + $('#device').val();
		strURL += '&rows=' + $('#rows').val();
		strURL += '&filter=' + $('#filter').val();
		strURL += '&header=false';

		loadPageNoHeader(strURL);
	}

	function clearFilter() {
		var strURL = 'router-backups.php?clear=1&header=false';

		loadPageNoHeader(strURL);
	}

	$(function() {
		$('#rows, #device, #filter').change(function() {
			applyFilter();
		});

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

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

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

	</script>
	<?php

	html_start_box(__('Router Backups', 'routerconfigs'), '100%', false, 4, 'center', '');

	?>
	<tr class='even noprint'>
		<td>
		<form id='form_devices' action='router-backups.php'>
			<table class='filterTable'>
				<tr>
					<td>
						<select id='device'>
							<option value='-1'<?php if (get_request_var('device') == '-1') {?> selected<?php }?>><?php print __('Any','routerconfigs'); ?></option>
							<?php
							$devices = db_fetch_assoc('SELECT id, hostname FROM plugin_routerconfigs_devices ORDER BY hostname');

	if (cacti_sizeof($devices)) {
		foreach ($devices as $device) {
			print "<option value='" . $device['id'] . "'";

			if (get_request_var('device') == $device['id']) {
				print ' selected';
			} print '>' . html_escape($device['hostname']) . '</option>';
		}
	}
	?>
						</select>
					</td>
					<td>
						<?php print __('Search','routerconfigs'); ?>
					</td>
					<td>
						<input id='filter' type='text' size='25' value='<?php print html_escape_request_var('filter'); ?>'>
					</td>
					<td>
						<select id='rows'>
							<option value='-1'<?php print (get_request_var('rows') == '-1' ? ' selected>' : '>') . __('Default'); ?></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 '>' . html_escape($value) . '</option>';
		}
	}
	?>
						</select>
					</td>
					<td>
						<span>
							<input type='button' id='refresh' value='<?php print __('Go','routerconfigs'); ?>' title='<?php print __esc('Set/Refresh Filters','routerconfigs'); ?>'>
							<input type='button' id='clear' value='<?php print __('Clear','routerconfigs'); ?>' title='<?php print __esc('Clear Filters','routerconfigs'); ?>'>
						</span>
					</td>
				</tr>
			</table>
		</form>
		</td>
	</tr>
	<?php

	html_end_box();

	$display_text = [
		'hostname' => [
			'display' => __('Hostname', 'routerconfigs'),
			'align'   => 'left',
			'sort'    => 'ASC',
			'tip'     => __('Either an IP address, or hostname.  If a hostname, it must be resolvable by either DNS, or from your hosts file.', 'routerconfigs')
		],
		'id' => [
			'display' => __('ID','routerconfigs'),
			'align'   => 'right',
			'sort'    => 'ASC',
			'tip'     => __('The internal database ID for this Device.  Useful when performing automation or debugging.', 'routerconfigs')
		],
		'functions' => [
			'display' => __('Functions', 'routerconfigs'),
			'align'   => 'center',
			'sort'    => 'ASC',
			'tip'     => __('Perform functions against this backup','routerconfigs')
		],
		'directory' => [
			'display' => __('Directory', 'routerconfigs'),
			'align'   => 'left',
			'sort'    => 'ASC',
			'tip'     => __('The directory of the stored device backups', 'routerconfigs')
		],
		'btime' => [
			'display' => __('Backup Time'),
			'align'   => 'left',
			'sort'    => 'DESC',
			'tip'     => __('The last Backup time of the device')
		],
		'lastchange' => [
			'display' => __('Last Change'),
			'align'   => 'left',
			'sort'    => 'DESC',
			'tip'     => __('The last Change time of the device')
		],
		'lastuser' => [
			'display' => __('Changed By'),
			'align'   => 'left',
			'sort'    => 'ASC',
			'tip'     => __('The last person to change the configuration of the device')
		],
		'filename' => [
			'display' => __('Filename'),
			'align'   => 'left',
			'sort'    => 'ASC',
			'tip'     => __('The filename of the stored device backups')
		],
	];

	form_start('router-backups.php', 'chk');

	$nav = html_nav_bar('router-backups.php', MAX_DISPLAY_PAGES, get_request_var('page'), $num_rows, $total_rows, 7, 'Backups', 'page', 'main');

	print $nav;

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

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

	if (cacti_sizeof($result)) {
		$r      = db_fetch_assoc('SELECT device, id FROM plugin_routerconfigs_backups ORDER BY btime ASC');
		$latest = [];

		if (cacti_count($r)) {
			foreach ($r as $s) {
				$latest[$s['device']] = $s['id'];
			}
		}

		$c = 0;

		foreach ($result as $row) {
			$lastchange = plugin_routerconfigs_date_from_time_with_na($row['lastchange']);
			$lastbackup = plugin_routerconfigs_date_from_time_with_na($row['btime']);

			form_alternate_row('line' . $row['id'], true);

			form_selectable_cell(filter_value($row['hostname'], get_request_var('filter'), 'router-devices.php?action=edit&id=' . $row['device']), $row['device']);
			form_selectable_cell($row['id'], $row['id'], null, 'text-align: right');

			form_selectable_cell(
				"<a class='hyperLink' href='router-backups.php?action=viewconfig&id=" . $row['id'] . "'>" . __('View Config', 'routerconfigs') .
				'</a> - ' .
				"<a class='hyperLink' href='router-compare.php?device1=" . $row['device'] . '&device2=' . $row['device'] . '&file1=' . $row['id'] . '&file2=' . $latest[$row['device']] . "'>" . __('Compare', 'routerconfigs') . '</a></td>', $row['device']);

			form_selectable_cell(filter_value($row['directory'], get_request_var('filter')),$row['device']);
			form_selectable_cell(filter_value($lastbackup, get_request_var('filter')),$row['device']);
			form_selectable_cell(filter_value($lastchange, get_request_var('filter')),$row['device']);
			form_selectable_cell(filter_value($row['lastuser'], get_request_var('filter')),$row['device']);
			form_selectable_cell(filter_value($row['filename'], get_request_var('filter')),$row['device']);

			form_end_row();
		}
	} else {
		print "<tr class='tableRow'><td colspan='11'><em>" . __('No Router Backups Found', 'routerconfigs') . '</em></td></tr>';
	}

	html_end_box(false);

	form_end();

	bottom_footer();
}