cacti/sites.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');
require_once CACTI_PATH_LIBRARY . '/CactiForm.php';

$actions = [
	1 => __('Delete'),
	2 => __('Duplicate'),
	3 => __('Enable'),
	4 => __('Disable')
];

// file: sites.php, action: edit
$fields_site_edit = [
	'spacer0' => [
		'method'        => 'spacer',
		'friendly_name' => __('Site Information'),
		'collapsible'   => 'true'
	],
	'name' => [
		'method'        => 'textbox',
		'friendly_name' => __('Name'),
		'description'   => __('The primary name for the Site.'),
		'value'         => '|arg1:name|',
		'size'          => '50',
		'default'       => __('New Site'),
		'max_length'    => '100'
	],
	'disabled' => [
		'method'        => 'checkbox',
		'friendly_name' => __('Disable Site'),
		'description'   => __('Check this box to disable all checks for hosts in this site.'),
		'value'         => '|arg1:disabled|',
		'default'       => '',
		'form_id'       => false
	],
	'spacer1' => [
		'method'        => 'spacer',
		'friendly_name' => __('Address Information'),
		'collapsible'   => 'true'
	],
	'address1' => [
		'method'        => 'textbox',
		'friendly_name' => __('Address1'),
		'description'   => __('The primary address for the Site.'),
		'value'         => '|arg1:address1|',
		'placeholder'   => __('Enter the Site Address'),
		'size'          => '70',
		'max_length'    => '100'
	],
	'address2' => [
		'method'        => 'textbox',
		'friendly_name' => __('Address2'),
		'description'   => __('Additional address information for the Site.'),
		'value'         => '|arg1:address2|',
		'placeholder'   => __('Additional Site Address information'),
		'size'          => '70',
		'max_length'    => '100'
	],
	'city' => [
		'method'        => 'textbox',
		'friendly_name' => __('City'),
		'description'   => __('The city or locality for the Site.'),
		'value'         => '|arg1:city|',
		'placeholder'   => __('Enter the City or Locality'),
		'size'          => '30',
		'max_length'    => '30'
	],
	'state' => [
		'method'        => 'textbox',
		'friendly_name' => __('State'),
		'description'   => __('The state for the Site.'),
		'value'         => '|arg1:state|',
		'placeholder'   => __('Enter the state'),
		'size'          => '15',
		'max_length'    => '20'
	],
	'postal_code' => [
		'method'        => 'textbox',
		'friendly_name' => __('Postal/Zip Code'),
		'description'   => __('The postal or zip code for the Site.'),
		'value'         => '|arg1:postal_code|',
		'placeholder'   => __('Enter the postal code'),
		'size'          => '20',
		'max_length'    => '20'
	],
	'country' => [
		'method'        => 'textbox',
		'friendly_name' => __('Country'),
		'description'   => __('The country for the Site.'),
		'value'         => '|arg1:country|',
		'placeholder'   => __('Enter the country'),
		'size'          => '20',
		'max_length'    => '30'
	],
	'region' => [
		'method'        => 'textbox',
		'friendly_name' => __('Region'),
		'description'   => __('The Region of the world that this site is in.'),
		'value'         => '|arg1:region|',
		'placeholder'   => __('Enter the region of the world'),
		'size'          => '20',
		'max_length'    => '30'
	],
	'timezone' => [
		'method'        => 'drop_callback',
		'friendly_name' => __('TimeZone'),
		'description'   => __('The TimeZone for the Site.'),
		'sql'           => 'SELECT Name AS id, Name AS name FROM mysql.time_zone_name ORDER BY name',
		'action'        => 'ajax_tz',
		'id'            => '|arg1:timezone|',
		'value'         => '|arg1:timezone|'
	],
	'spacer2' => [
		'method'        => 'spacer',
		'friendly_name' => __('Geolocation Information'),
		'collapsible'   => 'true'
	],
	'latitude' => [
		'method'        => 'textbox',
		'friendly_name' => __('Latitude'),
		'description'   => __('The Latitude for this Site.'),
		'value'         => '|arg1:latitude|',
		'placeholder'   => __('example 38.889488'),
		'size'          => '20',
		'max_length'    => '30'
	],
	'longitude' => [
		'method'        => 'textbox',
		'friendly_name' => __('Longitude'),
		'description'   => __('The Longitude for this Site.'),
		'value'         => '|arg1:longitude|',
		'placeholder'   => __('example -77.0374678'),
		'size'          => '20',
		'max_length'    => '30'
	],
	'zoom' => [
		'method'        => 'textbox',
		'friendly_name' => __('Zoom'),
		'description'   => __('The default Map Zoom for this Site.  Values can be from 0 to 23. Note that some regions of the planet have a max Zoom of 15.'),
		'value'         => '|arg1:zoom|',
		'placeholder'   => __('0 - 23'),
		'default'       => '12',
		'size'          => '4',
		'max_length'    => '4'
	],
	'spacer3' => [
		'method'        => 'spacer',
		'friendly_name' => __('Additional Information'),
		'collapsible'   => 'true'
	],
	'notes' => [
		'method'        => 'textarea',
		'friendly_name' => __('Notes'),
		'textarea_rows' => '3',
		'textarea_cols' => '70',
		'description'   => __('Additional area use for random notes related to this Site.'),
		'value'         => '|arg1:notes|',
		'max_length'    => '255',
		'placeholder'   => __('Enter some useful information about the Site.'),
		'class'         => 'textAreaNotes'
	],
	'alternate_id' => [
		'method'        => 'textbox',
		'friendly_name' => __('Alternate Name'),
		'description'   => __('Used for cases where a Site has an alternate named used to describe it'),
		'value'         => '|arg1:alternate_id|',
		'placeholder'   => __('If the Site is known by another name enter it here.'),
		'size'          => '50',
		'max_length'    => '30'
	],
	'id' => [
		'method' => 'hidden_zero',
		'value'  => '|arg1:id|'
	],
	'save_component_site' => [
		'method' => 'hidden',
		'value'  => '1'
	]
];

// set default action
set_default_action();

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

		break;
	case 'actions':
		form_actions();

		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 ' . read_config_option('autocomplete_rows'),
			['%' . gnrv('term') . '%']));

		break;
	case 'edit':
		top_header();

		site_edit();

		bottom_footer();

		break;
	default:
		top_header();

		sites();

		bottom_footer();

		break;
}

function form_save() : void {
	if (isrv('save_component_site')) {
		$save['id']           = gfrv('id');
		$save['name']         = form_input_validate(gnrv('name'), 'name', '', false, 3);
		$save['disabled']     = form_input_validate(gnrv('disabled'), 'disabled', '(^on$)', true, 3);
		$save['address1']     = form_input_validate(gnrv('address1'), 'address1', '', true, 3);
		$save['address2']     = form_input_validate(gnrv('address2'), 'address2', '', true, 3);
		$save['city']         = form_input_validate(gnrv('city'), 'city', '', true, 3);
		$save['state']        = form_input_validate(gnrv('state'), 'state', '', true, 3);
		$save['postal_code']  = form_input_validate(gnrv('postal_code'), 'postal_code', '', true, 3);
		$save['country']      = form_input_validate(gnrv('country'), 'country', '', true, 3);
		$save['region']       = form_input_validate(gnrv('region'), 'region', '', true, 3);
		$save['timezone']     = form_input_validate(gnrv('timezone'), 'timezone', '', true, 3);
		$save['latitude']     = form_input_validate(gnrv('latitude'), 'latitude', '^-?[0-9]\d*(\.\d+)?$', true, 3);
		$save['longitude']    = form_input_validate(gnrv('longitude'), 'longitude', '^-?[0-9]\d*(\.\d+)?$', true, 3);
		$save['zoom']         = form_input_validate(gnrv('zoom'), 'zoom', '^[0-9]+$', true, 3);
		$save['alternate_id'] = form_input_validate(gnrv('alternate_id'), 'alternate_id', '', true, 3);
		$save['notes']        = form_input_validate(gnrv('notes'), 'notes', '', true, 3);

		if (!is_error_message()) {
			$site_id = sql_save($save, 'sites');

			if ($site_id) {
				raise_message(1);

				if (empty($save['id'])) {
					/**
					 * Save the last time a device/site was created/updated
					 * for Caching.
					 */
					set_config_option('time_last_change_site', time());
					set_config_option('time_last_change_site_device', time());
				}
			} else {
				raise_message(2);
			}
		}

		header('Location: sites.php?action=edit&id=' . (empty($site_id) ? gnrv('id') : $site_id));
	}
}

function disable_site(array $sites) : void {
	if (cacti_sizeof($sites)) {
		foreach ($sites as $id) {
			db_execute_prepared('UPDATE sites SET disabled = "on" WHERE id = ?', [$id]);
		}

		/**
		 * Save the last time a device/site was created/updated
		 * for Caching.
		 */
		set_config_option('time_last_change_site', time());
		set_config_option('time_last_change_site_device', time());
	}
}

function enable_site(array $sites) : void {
	if (cacti_sizeof($sites)) {
		foreach ($sites as $id) {
			db_execute_prepared('UPDATE sites SET disabled = "" WHERE id = ?', [$id]);
		}

		/**
		 * Save the last time a device/site was created/updated
		 * for Caching.
		 */
		set_config_option('time_last_change_site', time());
		set_config_option('time_last_change_site_device', time());
	}
}

function duplicate_site(mixed $template_id, string $name) : void {
	if (!is_array($template_id)) {
		$template_id = [$template_id];
	}

	foreach ($template_id as $id) {
		$site = db_fetch_row_prepared('SELECT *
			FROM sites
			WHERE id = ?',
			[$id]);

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

			$save['id'] = 0;

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

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

			$site_id = sql_save($save, 'sites');

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

	/**
	 * Save the last time a device/site was created/updated
	 * for Caching.
	 */
	set_config_option('time_last_change_site', time());
	set_config_option('time_last_change_site_device', time());
}

function form_actions() : void {
	global $actions;

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

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

		if ($selected_items != false) {
			if (gnrv('drp_action') == '1') { // delete
				db_execute('DELETE FROM sites WHERE ' . array_to_sql_or($selected_items, 'id'));
				db_execute('UPDATE host SET site_id=0 WHERE deleted="" AND ' . array_to_sql_or($selected_items, 'site_id'));

				/**
				 * Save the last time a device/site was created/updated
				 * for Caching.
				 */
				set_config_option('time_last_change_site', time());
				set_config_option('time_last_change_site_device', time());
			} elseif (gnrv('drp_action') == '2') { // Duplicate
				duplicate_site($selected_items, gnrv('site_name'));
			} elseif (gnrv('drp_action') == '3') { // Enable
				enable_site($selected_items);
			} elseif (gnrv('drp_action') == '4') { // Disable
				disable_site($selected_items);
			}
		}

		header('Location: sites.php');

		exit;
	} else {
		$ilist  = '';
		$iarray = [];

		// 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], 'chk[1]');
				// ====================================================

				$ilist .= '<li>' . htmle(db_fetch_cell_prepared('SELECT name FROM sites WHERE id = ?', [$matches[1]])) . '</li>';
				$iarray[] = $matches[1];
			}
		}

		$form_data = [
			'general' => [
				'page'       => 'sites.php',
				'actions'    => $actions,
				'optvar'     => 'drp_action',
				'item_array' => $iarray,
				'item_list'  => $ilist
			],
			'options' => [
				1 => [
					'smessage' => __('Click \'Continue\' to Delete the following Site.'),
					'pmessage' => __('Click \'Continue\' to Delete following Sites.'),
					'scont'    => __('Delete Site'),
					'pcont'    => __('Delete Sites')
				],
				2 => [
					'smessage' => __('Click \'Continue\' to Duplicate the following Site.'),
					'pmessage' => __('Click \'Continue\' to Duplicate following Sites.'),
					'scont'    => __('Duplicate Site'),
					'pcont'    => __('Duplicate Sites'),
					'extra'    => [
						'site_name' => [
							'method'  => 'textbox',
							'title'   => __('Site Name'),
							'default' => '<site> (1)',
							'width'   => 25
						]
					]
				],
				3 => [
					'smessage' => __('Click \'Continue\' to Enable the following Site.'),
					'pmessage' => __('Click \'Continue\' to Enable following Sites.'),
					'scont'    => __('Enable Site'),
					'pcont'    => __('Enable Sites')
				],
				4 => [
					'smessage' => __('Click \'Continue\' to Disable the following Site.'),
					'pmessage' => __('Click \'Continue\' to Disable following Sites.'),
					'scont'    => __('Disable Site'),
					'pcont'    => __('Disable Sites')
				],
			]
		];

		form_continue_confirmation($form_data);
	}
}

function site_edit() : void {
	global $fields_site_edit;

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

	if (!ierv('id')) {
		$site         = db_fetch_row_prepared('SELECT * FROM sites WHERE id = ?', [grv('id')]);
		$header_label = __esc('Site [edit: %s]', $site['name']);
	} else {
		$header_label = __('Site [new]');
	}

	form_start('sites.php', 'site');

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

	(new CactiForm($fields_site_edit))
		->withValues($site ?? [])
		->withoutFormTag()
		->render();

	html_end_box(true, true);

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

function sites() : void {
	global $actions, $item_rows;

	// create the page filter
	$pageFilter = new CactiTableFilter(__('Sites'), 'sites.php', 'form_site', 'sess_site', 'sites.php?action=edit');

	// The Sites list gains nothing from saved layouts; keep the classic legacy filter.
	$pageFilter->render_layouts = false;

	$pageFilter->rows_label = __('Sites');
	$pageFilter->render();

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

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

	$sql = "SELECT COUNT(*) FROM sites $sql_where";

	$total_rows = get_total_row_data($_SESSION[SESS_USER_ID], $sql, [], 'site');

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

	$site_list = db_fetch_assoc("SELECT sites.*, count(h.id) AS hosts
		FROM sites
		LEFT JOIN host AS h
		ON h.site_id=sites.id
		$sql_where
		GROUP BY sites.id
		$sql_order
		$sql_limit");

	$nav = html_nav_bar('sites.php?filter=' . grv('filter'), MAX_DISPLAY_PAGES, grv('page'), $rows, $total_rows, 5, __('Sites'), 'page', 'main');

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

	print $nav;

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

	$display_text = [
		'name' => [
			'display' => __('Site Name'),
			'align'   => 'left',
			'sort'    => 'ASC',
			'tip'     => __('The name of this Site.')
		],
		'id' => [
			'display' => __('ID'),
			'align'   => 'right',
			'sort'    => 'ASC',
			'tip'     => __('The unique id associated with this Site.')
		],
		'disabled' => [
			'display' => __('Monitoring State'),
			'align'   => 'right',
			'sort'    => 'DESC',
			'tip'     => __('The state of this Site.')
		],
		'hosts' => [
			'display' => __('Devices'),
			'align'   => 'right',
			'sort'    => 'DESC',
			'tip'     => __('The number of Devices associated with this Site.')
		],
		'city' => [
			'display' => __('City'),
			'align'   => 'left',
			'sort'    => 'DESC',
			'tip'     => __('The City associated with this Site.')
		],
		'state' => [
			'display' => __('State'),
			'align'   => 'left',
			'sort'    => 'DESC',
			'tip'     => __('The State associated with this Site.')
		],
		'country' => [
			'display' => __('Country'),
			'align'   => 'left',
			'sort'    => 'DESC',
			'tip'     => __('The Country associated with this Site.')
		]
	];

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

	$i = 0;

	if (cacti_sizeof($site_list)) {
		foreach ($site_list as $site) {
			$devices_url = CACTI_PATH_URL . 'host.php?reset=1&site_id=' . $site['id'];

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

			form_selectable_cell(filter_value($site['name'], grv('filter'), 'sites.php?action=edit&id=' . $site['id']), $site['id']);
			form_selectable_cell($site['id'], $site['id'], '', 'right');
			form_selectable_cell($site['disabled'] == 'on' ? __('Disabled') : __('Enabled'), $site['id'], '', 'right');
			form_selectable_cell(filter_value(number_format_i18n($site['hosts'], -1), '', $devices_url), $site['id'], '', 'right');
			form_selectable_ecell($site['city'], $site['id'], '', 'left');
			form_selectable_ecell($site['state'], $site['id'], '', 'left');
			form_selectable_ecell($site['country'], $site['id'], '', 'left');
			form_checkbox_cell($site['name'], $site['id']);

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

	html_end_box(false);

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

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

	form_end();
}