sites.php

<?php
/*
 +-------------------------------------------------------------------------+
 | Copyright (C) 2004-2023 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/                                                   |
 +-------------------------------------------------------------------------+
*/

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

$site_actions = array(
	1 => __('Delete'),
	2 => __('Duplicate')
);

/* file: sites.php, action: edit */
$fields_site_edit = array(
	'spacer0' => array(
		'method'        => 'spacer',
		'friendly_name' => __('Site Information'),
		'collapsible'   => 'true'
	),
	'name' => array(
		'method'        => 'textbox',
		'friendly_name' => __('Name'),
		'description'   => __('The primary name for the Site.'),
		'value'         => '|arg1:name|',
		'size'          => '50',
		'default'       => __('New Site'),
		'max_length'    => '100'
	),
	'disabled' => array(
		'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' => array(
		'method'        => 'spacer',
		'friendly_name' => __('Address Information'),
		'collapsible'   => 'true'
	),
	'address1' => array(
		'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' => array(
		'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' => array(
		'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' => array(
		'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' => array(
		'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' => array(
		'method'        => 'textbox',
		'friendly_name' => __('Country'),
		'description'   => __('The country for the Site.'),
		'value'         => '|arg1:country|',
		'placeholder'   => __('Enter the country'),
		'size'          => '20',
		'max_length'    => '30'
	),
	'timezone' => array(
		'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' => array(
		'method'        => 'spacer',
		'friendly_name' => __('Geolocation Information'),
		'collapsible'   => 'true'
	),
	'latitude' => array(
		'method'        => 'textbox',
		'friendly_name' => __('Latitude'),
		'description'   => __('The Latitude for this Site.'),
		'value'         => '|arg1:latitude|',
		'placeholder'   => __('example 38.889488'),
		'size'          => '20',
		'max_length'    => '30'
	),
	'longitude' => array(
		'method'        => 'textbox',
		'friendly_name' => __('Longitude'),
		'description'   => __('The Longitude for this Site.'),
		'value'         => '|arg1:longitude|',
		'placeholder'   => __('example -77.0374678'),
		'size'          => '20',
		'max_length'    => '30'
	),
	'zoom' => array(
		'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' => array(
		'method'        => 'spacer',
		'friendly_name' => __('Additional Information'),
		'collapsible'   => 'true'
	),
	'notes' => array(
		'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' => array(
		'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' => array(
		'method' => 'hidden_zero',
		'value'  => '|arg1:id|'
	),
	'save_component_site' => array(
		'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_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'),
			array('%' . get_nfilter_request_var('term') . '%')));

		break;
	case 'edit':
		top_header();

		site_edit();

		bottom_footer();

		break;

	default:
		top_header();

		sites();

		bottom_footer();

		break;
}

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

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

function form_save() {
	if (isset_request_var('save_component_site')) {
		$save['id']           = get_filter_request_var('id');
		$save['name']         = form_input_validate(get_nfilter_request_var('name'), 'name', '', false, 3);
		$save['disabled']     = form_input_validate(get_nfilter_request_var('disabled'), 'disabled', '(^on$)', true, 3);
		$save['address1']     = form_input_validate(get_nfilter_request_var('address1'), 'address1', '', true, 3);
		$save['address2']     = form_input_validate(get_nfilter_request_var('address2'), 'address2', '', true, 3);
		$save['city']         = form_input_validate(get_nfilter_request_var('city'), 'city', '', true, 3);
		$save['state']        = form_input_validate(get_nfilter_request_var('state'), 'state', '', true, 3);
		$save['postal_code']  = form_input_validate(get_nfilter_request_var('postal_code'), 'postal_code', '', true, 3);
		$save['country']      = form_input_validate(get_nfilter_request_var('country'), 'country', '', true, 3);
		$save['timezone']     = form_input_validate(get_nfilter_request_var('timezone'), 'timezone', '', true, 3);
		$save['latitude']     = form_input_validate(get_nfilter_request_var('latitude'), 'latitude', '^-?[0-9]\d*(\.\d+)?$', true, 3);
		$save['longitude']    = form_input_validate(get_nfilter_request_var('longitude'), 'longitude', '^-?[0-9]\d*(\.\d+)?$', true, 3);
		$save['zoom']         = form_input_validate(get_nfilter_request_var('zoom'), 'zoom', '^[0-9]+$', true, 3);
		$save['alternate_id'] = form_input_validate(get_nfilter_request_var('alternate_id'), 'alternate_id', '', true, 3);
		$save['notes']        = form_input_validate(get_nfilter_request_var('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) ? get_nfilter_request_var('id') : $site_id));
	}
}

function duplicate_site($template_id, $name) {
	if (!is_array($template_id)) {
		$template_id = array($template_id);
	}

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

		if (cacti_sizeof($site)) {
			$save = array();

			$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());
}

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

function form_actions() {
	global $site_actions;

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

	/* 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_nfilter_request_var('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 (get_nfilter_request_var('drp_action') == '2') { /* Duplicate */
				duplicate_site($selected_items, get_nfilter_request_var('site_name'));
			}
		}

		header('Location: sites.php');

		exit;
	}

	/* setup some variables */
	$site_list = '';
	$i         = 0;

	/* 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]');
			/* ==================================================== */

			$site_list .= '<li>' . html_escape(db_fetch_cell_prepared('SELECT name FROM sites WHERE id = ?', array($matches[1]))) . '</li>';
			$site_array[$i] = $matches[1];

			$i++;
		}
	}

	top_header();

	form_start('sites.php');

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

	if (isset($site_array) && cacti_sizeof($site_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 Site.  Note, all Devices will be disassociated from this site.', 'Click \'Continue\' to delete all following Sites.  Note, all devices will be disassociated from this site.', cacti_sizeof($site_array)) . "</p>
					<div class='itemlist'><ul>$site_list</ul></div>
				</td>
			</tr>\n";

			$save_html = "<input type='button' class='ui-button ui-corner-all ui-widget' value='" . __esc('Cancel') . "' onClick='cactiReturnTo()'>&nbsp;<input type='submit' class='ui-button ui-corner-all ui-widget' value='" . __esc('Continue') . "' title='" . __n('Delete Site', 'Delete Sites', cacti_sizeof($site_array)) . "'>";
		} elseif (get_nfilter_request_var('drp_action') == '2') { /* duplicate */
			print "<tr>
				<td class='textArea' class='odd'>
					<p>" . __n('Click \'Continue\' to Duplicate the following Site.', 'Click \'Continue\' to Duplicate all following Sites.', cacti_sizeof($site_array)) . "</p>
					<div class='itemlist'><ul>$site_list</ul></div>
					<p><strong>" . __('Site Name:'). '</strong><br>';
			form_text_box('site_name', '<site> (1)', '', '255', '30', 'text');
			print "</p>
				</td>
			</tr>\n";

			$save_html = "<input type='button' class='ui-button ui-corner-all ui-widget' value='" . __esc('Cancel') . "' onClick='cactiReturnTo()'>&nbsp;<input type='submit' class='ui-button ui-corner-all ui-widget' value='" . __esc('Continue') . "' title='" . __n('Duplicate Site', 'Duplicate Sites', cacti_sizeof($site_array)) . "'>";
		}
	} else {
		raise_message(40);
		header('Location: sites.php');

		exit;
	}

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

	html_end_box();

	form_end();

	bottom_footer();
}

/* ---------------------
	Site Functions
   --------------------- */

function site_edit() {
	global $fields_site_edit;

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

	if (!isempty_request_var('id')) {
		$site         = db_fetch_row_prepared('SELECT * FROM sites WHERE id = ?', array(get_request_var('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', '');

	draw_edit_form(
		array(
			'config' => array('no_form_tag' => true),
			'fields' => inject_form_variables($fields_site_edit, (isset($site) ? $site : array()))
		)
	);

	html_end_box(true, true);

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

function sites() {
	global $site_actions, $item_rows, $config;

	/* ================= input validation and session storage ================= */
	$filters = array(
		'rows' => array(
			'filter'  => FILTER_VALIDATE_INT,
			'pageset' => true,
			'default' => '-1'
			),
		'page' => array(
			'filter'  => FILTER_VALIDATE_INT,
			'default' => '1'
			),
		'filter' => array(
			'filter'  => FILTER_DEFAULT,
			'pageset' => true,
			'default' => ''
			),
		'sort_column' => array(
			'filter'  => FILTER_CALLBACK,
			'default' => 'name',
			'options' => array('options' => 'sanitize_search_string')
			),
		'sort_direction' => array(
			'filter'  => FILTER_CALLBACK,
			'default' => 'ASC',
			'options' => array('options' => 'sanitize_search_string')
			)
	);

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

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

	html_start_box(__('Sites'), '100%', '', '3', 'center', 'sites.php?action=edit');

	?>
	<tr class='even'>
		<td>
			<form id='form_site' action='sites.php'>
			<table class='filterTable'>
				<tr>
					<td>
						<?php print __('Search');?>
					</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 __('Sites');?>
					</td>
					<td>
						<select id='rows' onChange='applyFilter()'>
							<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>\n";
								}
							}
	?>
						</select>
					</td>
					<td>
						<span>
							<input type='button' class='ui-button ui-corner-all ui-widget' id='refresh' value='<?php print __esc('Go');?>' title='<?php print __esc('Set/Refresh Filters');?>'>
							<input type='button' class='ui-button ui-corner-all ui-widget' id='clear' value='<?php print __esc('Clear');?>' title='<?php print __esc('Clear Filters');?>'>
						</span>
					</td>
				</tr>
			</table>
			</form>
			<script type='text/javascript'>

			function applyFilter() {
				strURL  = 'sites.php';
				strURL += '?filter='+$('#filter').val();
				strURL += '&rows='+$('#rows').val();
				loadUrl({url:strURL})
			}

			function clearFilter() {
				strURL = 'sites.php?clear=1';
				loadUrl({url:strURL})
			}

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

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

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

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

	html_end_box();

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

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

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

	$sql_order = get_order_string();
	$sql_limit = ' LIMIT ' . ($rows * (get_request_var('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=' . get_request_var('filter'), MAX_DISPLAY_PAGES, get_request_var('page'), $rows, $total_rows, 5, __('Sites'), 'page', 'main');

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

	print $nav;

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

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

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

	$i = 0;

	if (cacti_sizeof($site_list)) {
		foreach ($site_list as $site) {
			$devices_url = html_escape(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'], get_request_var('filter'), 'sites.php?action=edit&id=' . $site['id']), $site['id']);
			form_selectable_cell($site['id'], $site['id'], '', 'right');
			form_checkbox_cell('Site ' . ($site['disabled'] == 'on' ? 'dis':'en') . 'abled', $site['id'], false, $site['disabled'] == 'on');
			form_selectable_cell('<a class="linkEditMain" href="' . $devices_url . '">' . number_format_i18n($site['hosts'], '-1') . '</a>', $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'><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($site_actions);

	form_end();
}