fusionpbx/app/devices/devices.php

<?php
/*
	FusionPBX
	Version: MPL 1.1

	The contents of this file are subject to the Mozilla Public License Version
	1.1 (the "License"); you may not use this file except in compliance with
	the License. You may obtain a copy of the License at
	http://www.mozilla.org/MPL/

	Software distributed under the License is distributed on an "AS IS" basis,
	WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
	for the specific language governing rights and limitations under the
	License.

	The Original Code is FusionPBX

	The Initial Developer of the Original Code is
	Mark J Crane <markjcrane@fusionpbx.com>
	Portions created by the Initial Developer are Copyright (C) 2008-2024
	the Initial Developer. All Rights Reserved.

	Contributor(s):
	Mark J Crane <markjcrane@fusionpbx.com>
*/

//includes files
	require_once dirname(__DIR__, 2) . "/resources/require.php";
	require_once "resources/check_auth.php";
	require_once "resources/paging.php";

//check permissions
	if (permission_exists('device_view')) {
		//access granted
	}
	else {
		echo "access denied";
		exit;
	}

//set the current domain and user information
	$domain_name = $_SESSION['domain_name'] ?? '';
	$domain_uuid = $_SESSION['domain_uuid'] ?? '';
	$user_uuid = $_SESSION['user_uuid'] ?? '';
	$user_name = $_SESSION['username'] ?? '';

//create database connection and settings object
	$database = database::new();
	$settings = new settings(['database' => $database, 'domain_uuid' => $domain_uuid, 'user_uuid' => $user_uuid]);

//add multi-lingual support
	$language = new text;
	$text = $language->get();

//get posted data
	if (!empty($_POST['devices']) && is_array($_POST['devices'])) {
		$action = $_POST['action'];
		$devices = $_POST['devices'];
	}

//get the search
	$search = strtolower($_REQUEST["search"] ?? '');
	$fields = strtolower($_REQUEST["fields"] ?? '');

//process the http post data by action
	if (!empty($action) && !empty($devices) && is_array($devices) && @sizeof($devices) != 0) {
		switch ($action) {
			case 'toggle':
				if (permission_exists('device_edit')) {
					$obj = new device;
					$obj->toggle($devices);
				}
				break;
			case 'delete':
				if (permission_exists('device_delete')) {
					$obj = new device;
					$obj->delete($devices);
				}
				break;
		}

		header('Location: devices.php'.($search != '' ? '?search='.urlencode($search).'&fields='.urlencode($fields) : null));
		exit;
	}

//get order and order by and sanatize the values
	$order_by = $_GET["order_by"] ?? '';
	$order = $_GET["order"] ?? '';

//set the time zone
	$time_zone = $settings->get('domain', 'time_zone', date_default_timezone_get());

//get total devices count from the database
	$sql = "select count(*) from v_devices ";
	$sql .= "where domain_uuid = :domain_uuid ";
	if (!permission_exists('device_all') && !permission_exists('device_domain_all')) {
		$sql .= "and device_user_uuid = :user_uuid ";
		$parameters['user_uuid'] = $user_uuid;
	}
	$parameters['domain_uuid'] = $domain_uuid;
	$total_devices = $database->select($sql, $parameters, 'column');
	unset($sql, $parameters);

//get the devices profiles
	$sql = "select * from v_device_profiles ";
	$sql .= "where true ";
	if (!permission_exists('device_profile_all')) {
		$sql .= "and (domain_uuid = :domain_uuid or domain_uuid is null) ";
		$parameters['domain_uuid'] = $domain_uuid;
	}
	$device_profiles = $database->select($sql, $parameters, 'all');
	unset($sql, $parameters);

//prepare to page the results
	$sql = "select count(*) from v_devices as d ";
	if (isset($_GET['show']) && $_GET['show'] == "all" && permission_exists('device_all')) {
		if (!empty($search)) {
			$sql .= "where ";
		}
	}
	else {
		$sql .= "where (";
		$sql .= "	d.domain_uuid = :domain_uuid ";
		if (permission_exists('device_all')) {
			$sql .= "	or d.domain_uuid is null ";
		}
		$sql .= ") ";
		if (!empty($search)) {
			$sql .= "and ";
		}
		$parameters['domain_uuid'] = $domain_uuid;
	}
	if (!empty($search)) {
		$sql .= "(";
		$sql .= "	lower(d.device_address) like :search ";
		$sql .= "	or lower(d.device_label) like :search ";
		$sql .= "	or lower(d.device_vendor) like :search ";
		$sql .= "	or lower(d.device_template) like :search ";
		$sql .= "	or lower(d.device_description) like :search ";
		$sql .= "	or lower(d.device_provisioned_method) like :search ";
		$sql .= "	or lower(d.device_provisioned_ip) like :search ";
		if ($fields == 'all' || $fields == 'lines') {
			$sql .= "	or d.device_uuid in ( ";
			$sql .= "		select dl.device_uuid from v_device_lines as dl ";
			$sql .= "		where dl.display_name like :search ";
			$sql .= "		or dl.user_id like :search ";
			$sql .= "		or dl.auth_id like :search ";
			$sql .= "	) ";
		}
		if ($fields == 'all' || $fields == 'keys') {
			$sql .= "	or d.device_uuid in ( ";
			$sql .= "		select dk.device_uuid from v_device_keys as dk ";
			$sql .= "		where dk.device_key_value like :search ";
			$sql .= "		or dk.device_key_label like :search ";
			$sql .= "	) ";
		}
		if ($fields == 'all' || $fields == 'settings') {
			$sql .= "	or d.device_uuid in ( ";
			$sql .= "		select ds.device_uuid from v_device_settings as ds ";
			$sql .= "		where ds.device_setting_subcategory like :search ";
			$sql .= "		or ds.device_setting_value like :search ";
			$sql .= "		or ds.device_setting_description like :search ";
			$sql .= "	) ";
		}
		$sql .= ") ";
		$parameters['search'] = '%'.strtolower($search).'%';
	}
	$num_rows = $database->select($sql, $parameters ?? null, 'column');
	unset($sql, $parameters);

//prepare to page the results
	$rows_per_page = intval($settings->get('domain', 'paging', 50));
	$param = '';
	if ($search) {
		$param = "&search=".$search;
		$param .= "&fields=".$fields;
	}
	if (!empty($_GET['show']) && $_GET['show'] == "all" && permission_exists('device_all')) {
		$param .= "&show=all";
	}
	$page = $_GET['page'] ?? 0;
	list($paging_controls, $rows_per_page) = paging($num_rows, $param ?? '', $rows_per_page);
	list($paging_controls_mini, $rows_per_page) = paging($num_rows, $param ?? '', $rows_per_page, true);
	$offset = $rows_per_page * $page;

//get the list
	$sql = "select ";
	if (isset($_GET['show']) && $_GET['show'] == "all" && permission_exists('device_all')) {
		$sql .= "d3.domain_name, ";
	}
	$sql .= "d.device_uuid, ";
	$sql .= "d.domain_uuid, ";
	$sql .= "d.device_address, ";
	$sql .= "d.device_label, ";
	$sql .= "d.device_vendor, ";
	$sql .= "d.device_model, ";
	$sql .= "d.device_firmware_version, ";
	$sql .= "d.device_template, ";
	$sql .= "d.device_username, ";
	$sql .= "d.device_password, ";
	$sql .= "d.device_time_zone, ";
	$sql .= "d.device_description, ";
	$sql .= "d.device_profile_uuid, ";
	$sql .= "d.device_uuid_alternate, ";
	$sql .= "d.device_user_uuid, ";
	$sql .= "d.device_provisioned_date, ";
	$sql .= "d.device_provisioned_method, ";
	$sql .= "d.device_provisioned_ip, ";
	$sql .= "d.device_enabled_date, ";
	$sql .= "d.device_provisioned_agent, ";
	$sql .= "d.device_location, ";
	$sql .= "d.device_serial_number, ";
	$sql .= "cast(d.device_enabled as text), ";
	$sql .= "d2.device_label as alternate_label, ";
	$sql .= "to_char(timezone(:time_zone, d.device_provisioned_date), 'DD Mon YYYY') as provisioned_date_formatted, \n";
	$sql .= "to_char(timezone(:time_zone, d.device_provisioned_date), 'HH12:MI:SS am') as provisioned_time_formatted \n";
	$sql .= "from v_devices as d, v_devices as d2 ";
	if (isset($_GET['show']) && $_GET['show'] == "all" && permission_exists('device_all')) {
		$sql .= ", v_domains as d3 ";
	}
	$sql .= "where ( ";
	$sql .= "	d.device_uuid_alternate = d2.device_uuid  ";
	$sql .= "	or ( ";
	$sql .= "		d.device_uuid_alternate is null and ";
	$sql .= "		d.device_uuid = d2.device_uuid ";
	$sql .= "	) ";
	$sql .= ") ";
	if (isset($_GET['show']) && $_GET['show'] == "all" && permission_exists('device_all')) {
		$sql .= " and d.domain_uuid = d3.domain_uuid ";
	}
	else {
		$sql .= "and (";
		$sql .= "	d.domain_uuid = :domain_uuid ";
		if (permission_exists('device_all')) {
			$sql .= "	or d.domain_uuid is null ";
		}
		$sql .= ") ";
		$parameters['domain_uuid'] = $domain_uuid;
	}
	if (!permission_exists('device_all') && !permission_exists('device_domain_all')) {
		$sql .= "and d.device_user_uuid = :user_uuid ";
		$parameters['user_uuid'] = $user_uuid;
	}
	if (!empty($search)) {
		$sql .= "and (";
		$sql .= "	lower(d.device_address) like :search ";
		$sql .= "	or lower(d.device_label) like :search ";
		$sql .= "	or lower(d.device_vendor) like :search ";
		$sql .= "	or lower(d.device_template) like :search ";
		$sql .= "	or lower(d.device_description) like :search ";
		$sql .= "	or lower(d.device_provisioned_method) like :search ";
		$sql .= "	or lower(d.device_provisioned_ip) like :search ";
		if ($fields == 'all' || $fields == 'lines') {
			$sql .= "	or d.device_uuid in ( ";
			$sql .= "		select dl.device_uuid from v_device_lines as dl ";
			$sql .= "		where dl.display_name like :search ";
			$sql .= "		or dl.user_id like :search ";
			$sql .= "		or dl.auth_id like :search ";
			$sql .= "	) ";
		}
		if ($fields == 'all' || $fields == 'keys') {
			$sql .= "	or d.device_uuid in ( ";
			$sql .= "		select dk.device_uuid from v_device_keys as dk ";
			$sql .= "		where dk.device_key_value like :search ";
			$sql .= "		or dk.device_key_label like :search ";
			$sql .= "	) ";
		}
		if ($fields == 'all' || $fields == 'settings') {
			$sql .= "	or d.device_uuid in ( ";
			$sql .= "		select ds.device_uuid from v_device_settings as ds ";
			$sql .= "		where ds.device_setting_subcategory like :search ";
			$sql .= "		or ds.device_setting_value like :search ";
			$sql .= "		or ds.device_setting_description like :search ";
			$sql .= "	) ";
		}
		$sql .= ") ";
		$parameters['search'] = '%'.strtolower($search).'%';
	}
	if (empty($order_by)) {
		$sql .= "order by d.device_label, d.device_description asc ";
	}
	else {
		$sql .= "order by $order_by $order ";
	}
	$sql .= limit_offset($rows_per_page, $offset);
	$parameters['time_zone'] = $time_zone;
	$devices = $database->select($sql, $parameters, 'all');
	unset($sql, $parameters);

//alternate_found
	$device_alternate = false;
	if (is_array($devices)) {
		foreach($devices as $row) {
			if (is_uuid($row['device_uuid_alternate'])) {
				$device_alternate = true;
				break;
			}
		}
	}

//create token
	$object = new token;
	$token = $object->create($_SERVER['PHP_SELF']);

//include the header
	$document['title'] = $text['title-devices'];
	require_once "resources/header.php";

//show the content
	echo "<div class='action_bar' id='action_bar'>\n";
	echo "	<div class='heading'><b>".$text['header-devices']."</b><div class='count'>".number_format($num_rows)."</div></div>\n";
	echo "	<div class='actions'>\n";
	if (permission_exists('device_import')) {
		echo button::create(['type'=>'button','label'=>$text['button-import'],'icon'=>$settings->get('theme', 'button_icon_import'),'link'=>'device_imports.php']);
	}
	if (permission_exists('device_export')) {
		echo button::create(['type'=>'button','label'=>$text['button-export'],'icon'=>$settings->get('theme', 'button_icon_export'),'link'=>'device_download.php']);
	}
	if (permission_exists('device_vendor_view')) {
		echo button::create(['type'=>'button','label'=>$text['button-vendors'],'icon'=>'fax','link'=>'device_vendors.php']);
	}
	if (permission_exists('device_profile_view')) {
		echo button::create(['type'=>'button','label'=>$text['button-profiles'],'icon'=>'clone','link'=>'device_profiles.php']);
	}
	$margin_left = permission_exists('device_import') || permission_exists('device_export') || permission_exists('device_vendor_view') || permission_exists('device_profile_view') ? "margin-left: 15px;" : null;
	if (permission_exists('device_add') && (empty($_SESSION['limit']['devices']['numeric']) || ($total_devices < $_SESSION['limit']['devices']['numeric']))) {
		echo button::create(['type'=>'button','label'=>$text['button-add'],'icon'=>$settings->get('theme', 'button_icon_add'),'id'=>'btn_add','style'=>$margin_left,'link'=>'device_edit.php']);
		unset($margin_left);
	}
	if (permission_exists('device_edit') && $devices) {
		echo button::create(['type'=>'button','label'=>$text['button-toggle'],'icon'=>$settings->get('theme', 'button_icon_toggle'),'id'=>'btn_toggle','name'=>'btn_toggle','style'=>'display: none; '.($margin_left ?? null),'onclick'=>"modal_open('modal-toggle','btn_toggle');"]);
		unset($margin_left);
	}
	if (permission_exists('device_delete') && $devices) {
		echo button::create(['type'=>'button','label'=>$text['button-delete'],'icon'=>$settings->get('theme', 'button_icon_delete'),'id'=>'btn_delete','name'=>'btn_delete','style'=>'display: none; '.($margin_left ?? null),'onclick'=>"modal_open('modal-delete','btn_delete');"]);
		unset($margin_left);
	}
	echo 		"<form id='form_search' class='inline' method='get'>\n";
	if (permission_exists('device_all')) {
		if (!empty($_GET['show']) && $_GET['show'] == 'all') {
			echo "		<input type='hidden' name='show' value='all'>";
		}
		else {
			echo button::create(['type'=>'button','label'=>$text['button-show_all'],'icon'=>$settings->get('theme','button_icon_all'),'link'=>'?show=all']);
		}
	}

	echo 		"<select class='formfld' name='fields' id='select_fields' style='width: auto; margin-left: 15px;' onchange=\"if (document.getElementById('search').value != '') { this.form.submit(); }\">\n";
	echo "			<option value='' selected='selected' disabled hidden>".$text['label-fields']."...</option>\n";
	echo "			<option value=''></option>\n";
	echo "			<option value=''>".$text['label-default']."</option>\n";
	echo "			<option value='lines' ".($fields == 'lines' ? " selected='selected'" : null).">".$text['label-lines']."</option>\n";
	echo "			<option value='keys' ".($fields == 'keys' ? " selected='selected'" : null).">".$text['label-keys']."</option>\n";
	echo "			<option value='settings' ".($fields == 'settings' ? " selected='selected'" : null).">".$text['label-settings']."</option>\n";
	echo "			<option value='all' ".($fields == 'all' ? " selected='selected'" : null).">".$text['label-all']."</option>\n";
	echo "		</select>";
	echo 		"<input type='text' class='txt list-search' name='search' id='search' style='margin-left: 0 !important;' value=\"".escape($search)."\" placeholder=\"".$text['label-search']."\" onkeydown=''>";
	echo button::create(['label'=>$text['button-search'],'icon'=>$settings->get('theme', 'button_icon_search'),'type'=>'submit','id'=>'btn_search']);
	//echo button::create(['label'=>$text['button-reset'],'icon'=>$settings->get('theme', 'button_icon_reset'),'type'=>'button','id'=>'btn_reset','link'=>'devices.php','style'=>($search == '' ? 'display: none;' : null)]);
	if ($paging_controls_mini != '') {
		echo 	"<span style='margin-left: 15px;'>".$paging_controls_mini."</span>";
	}
	echo "		</form>\n";
	echo "	</div>\n";
	echo "	<div style='clear: both;'></div>\n";
	echo "</div>\n";

	if (permission_exists('device_edit') && $devices) {
		echo modal::create(['id'=>'modal-toggle','type'=>'toggle','actions'=>button::create(['type'=>'button','label'=>$text['button-continue'],'icon'=>'check','id'=>'btn_toggle','style'=>'float: right; margin-left: 15px;','collapse'=>'never','onclick'=>"modal_close(); list_action_set('toggle'); list_form_submit('form_list');"])]);
	}
	if (permission_exists('device_delete') && $devices) {
		echo modal::create(['id'=>'modal-delete','type'=>'delete','actions'=>button::create(['type'=>'button','label'=>$text['button-continue'],'icon'=>'check','id'=>'btn_delete','style'=>'float: right; margin-left: 15px;','collapse'=>'never','onclick'=>"modal_close(); list_action_set('delete'); list_form_submit('form_list');"])]);
	}

	echo $text['description-devices']."\n";
	echo "<br /><br />\n";

	echo "<form id='form_list' method='post'>\n";
	echo "<input type='hidden' id='action' name='action' value=''>\n";
	echo "<input type='hidden' name='search' value=\"".escape($search)."\">\n";
	echo "<input type='hidden' name='fields' value=\"".escape($fields)."\">\n";

	echo "<div class='card'>\n";
	echo "<table class='list'>\n";
	echo "<tr class='list-header'>\n";
	if (permission_exists('device_edit') || permission_exists('device_delete')) {
		echo "	<th class='checkbox'>\n";
		echo "		<input type='checkbox' id='checkbox_all' name='checkbox_all' onclick='list_all_toggle(); checkbox_on_change(this);' ".(empty($devices) ? "style='visibility: hidden;'" : null).">\n";
		echo "	</th>\n";
	}
	if (!empty($_GET['show']) && $_GET['show'] == "all" && permission_exists('device_all')) {
		echo th_order_by('domain_name', $text['label-domain'], $order_by, $order, null, null, $param);
	}
	echo th_order_by('device_address', $text['label-device_address'], $order_by, $order, null, null, $param ?? null);
	echo th_order_by('device_label', $text['label-device_label'], $order_by, $order, null, null, $param ?? null);
	if ($device_alternate) {
		echo th_order_by('device_template', $text['label-device_uuid_alternate'], $order_by, $order, null, null, $param ?? null);
	}
	echo th_order_by('device_vendor', $text['label-device_vendor'], $order_by, $order, null, null, $param ?? null);
	echo th_order_by('device_template', $text['label-device_template'], $order_by, $order, null, null, $param ?? null);
	echo "<th>". $text['label-device_profiles']."</th>\n";
	echo th_order_by('device_enabled', $text['label-device_enabled'], $order_by, $order, null, "class='center'", $param ?? null);
	echo th_order_by('device_provisioned_date', $text['label-device_status'], $order_by, $order, null, null, $param ?? null);
	echo th_order_by('device_description', $text['label-device_description'], $order_by, $order, null, "class='hide-sm-dn'", $param ?? null);
	if (permission_exists('device_edit') && $settings->get('theme', 'list_row_edit_button', false)) {
		echo "	<td class='action-button'>&nbsp;</td>\n";
	}
	echo "</tr>\n";

	if (!empty($devices) && @sizeof($devices) != 0) {
		$x = 0;
		foreach($devices as $row) {

			$device_profile_name = '';
			foreach($device_profiles as $profile) {
				if ($profile['device_profile_uuid'] == $row['device_profile_uuid']) {
					$device_profile_name = $profile['device_profile_name'];
				}
			}

			$list_row_url = '';
			if (permission_exists('device_edit')) {
				$list_row_url = "device_edit.php?id=".urlencode($row['device_uuid']);
				if ($row['domain_uuid'] != $_SESSION['domain_uuid'] && permission_exists('domain_select')) {
					$list_row_url .= '&domain_uuid='.urlencode($row['domain_uuid']).'&domain_change=true';
				}
			}

			$device_provisioned_method = '';
			if (isset($row['device_provisioned_method']) && ($row['device_provisioned_method'] == 'http' || $row['device_provisioned_method'] == 'https')) {
				$device_provisioned_method = $row['device_provisioned_method'];
			}

			$device_provisioned_ip = '';
			if (isset($row['device_provisioned_ip']) && filter_var($row['device_provisioned_ip'], FILTER_VALIDATE_IP)) {
				$device_provisioned_ip = $row['device_provisioned_ip'];
			}

			echo "<tr class='list-row' href='".$list_row_url."'>\n";
			if (permission_exists('device_edit') || permission_exists('device_delete')) {
				echo "	<td class='checkbox'>\n";
				echo "		<input type='checkbox' name='devices[$x][checked]' id='checkbox_".$x."' value='true' onclick=\"checkbox_on_change(this); if (!this.checked) { document.getElementById('checkbox_all').checked = false; }\">\n";
				echo "		<input type='hidden' name='devices[$x][uuid]' value='".escape($row['device_uuid'])."' />\n";
				echo "	</td>\n";
			}
			if (!empty($_GET['show']) && $_GET['show'] == "all" && permission_exists('device_all')) {
				echo "	<td>".escape($row['domain_name'])."</td>\n";
			}
			echo "	<td class='no-wrap'>";
			echo permission_exists('device_edit') ? "<a href='".$list_row_url."'>".escape(format_device_address($row['device_address']))."</a>" : escape(format_device_address($row['device_address']));
			echo "	</td>\n";
			echo "	<td>".escape($row['device_label'])."&nbsp;</td>\n";
			if ($device_alternate) {
				if (!empty($row['device_uuid_alternate'])) {
					echo "	<td class='no-link'>\n";
					echo "		<a href='device_edit.php?id=".urlencode($row['device_uuid_alternate'])."'>".escape($row['alternate_label'])."</a>\n";
					echo "	</td>\n";
				}
				else {
					echo "	<td>&nbsp;</td>\n";
				}
			}
			echo "	<td>".escape($row['device_vendor'])."&nbsp;</td>\n";
			echo "	<td>".escape($row['device_template'])."&nbsp;</td>\n";
			echo "	<td>".escape($device_profile_name)."&nbsp;</td>\n";
			if (permission_exists('device_edit')) {
				echo "	<td class='no-link center'>";
				echo button::create(['type'=>'submit','class'=>'link','label'=>$text['label-'.$row['device_enabled']],'title'=>$text['button-toggle'],'onclick'=>"list_self_check('checkbox_".$x."'); list_action_set('toggle'); list_form_submit('form_list')"]);
			}
			else {
				echo "	<td class='center'>";
				echo $text['label-'.$row['device_enabled']];
			}
			echo "	</td>\n";
			echo "	<td class='no-link'><a title='".escape($row['device_provisioned_agent'])."' href='javascript:void(0)'>".escape($row['provisioned_date_formatted'])." ".escape($row['provisioned_time_formatted'])."</a> &nbsp; ".escape($device_provisioned_method)." &nbsp; <a href='".escape($device_provisioned_method)."://".escape($row['device_provisioned_ip'])."' target='_blank'>".escape($row['device_provisioned_ip'])."</a>&nbsp;</td>\n";
			echo "	<td class='description overflow hide-sm-dn'>".escape($row['device_description'])."&nbsp;</td>\n";
			if (permission_exists('device_edit')  && $settings->get('theme', 'list_row_edit_button', false)) {
				echo "	<td class='action-button'>";
				echo button::create(['type'=>'button','title'=>$text['button-edit'],'icon'=>$settings->get('theme','button_icon_edit'),'link'=>$list_row_url]);
				echo "	</td>\n";
			}
			echo "</tr>\n";
			$x++;
		}
	}
	unset($devices);

	echo "</table>\n";
	echo "</div>\n";
	echo "<br />\n";
	echo "<div align='center'>".$paging_controls."</div>\n";

	echo "<input type='hidden' name='".$token['name']."' value='".$token['hash']."'>\n";

	echo "</form>\n";

//include the footer
	require_once "resources/footer.php";

?>