<?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-2025
 the Initial Developer. All Rights Reserved.

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

//define the gateways class
class gateways {

	/**
	 * declare constant variables
	 */
	const app_name = 'gateways';
	const app_uuid = '297ab33e-2c2f-8196-552c-f3567d2caaf8';

	/**
	 * Set in the constructor. Must be a database object and cannot be null.
	 *
	 * @var database Database Object
	 */
	private $database;

	/**
	 * Settings object set in the constructor. Must be a settings object and cannot be null.
	 *
	 * @var settings Settings Object
	 */
	private $settings;

	/**
	 * User UUID set in the constructor. This can be passed in through the $settings_array associative array or set in
	 * the session global array
	 *
	 * @var string
	 */
	private $user_uuid;

	/**
	 * Domain UUID set in the constructor. This can be passed in through the $settings_array associative array or set
	 * in the session global array
	 *
	 * @var string
	 */
	private $domain_uuid;

	/**
	 * declare private variables
	 */
	private $permission_prefix;
	private $list_page;
	private $table;
	private $uuid_prefix;
	private $toggle_field;
	private $toggle_values;

	/**
	 * Initializes the object with setting array.
	 *
	 * @param array $setting_array An array containing settings for domain, user, and database connections. Defaults to
	 *                             an empty array.
	 *
	 * @return void
	 */
	public function __construct(array $setting_array = []) {
		//set domain and user UUIDs
		$this->domain_uuid = $setting_array['domain_uuid'] ?? $_SESSION['domain_uuid'] ?? '';
		$this->user_uuid   = $setting_array['user_uuid'] ?? $_SESSION['user_uuid'] ?? '';

		//set objects
		$this->database = $setting_array['database'] ?? database::new();
		$this->settings = $setting_array['settings'] ?? new settings(['database' => $this->database, 'domain_uuid' => $this->domain_uuid, 'user_uuid' => $this->user_uuid]);

		//assign private variables
		$this->permission_prefix = 'gateway_';
		$this->list_page         = 'gateways.php';
		$this->table             = 'gateways';
		$this->uuid_prefix       = 'gateway_';
		$this->toggle_field      = 'enabled';
		$this->toggle_values     = ['true', 'false'];
	}

	/**
	 * Starts the checked gateways.
	 *
	 * This method checks for permission to edit and validates the token. It then
	 * filters out unchecked gateways and retrieves their details from the database.
	 * If necessary, it creates an event socket connection and starts the gateways.
	 *
	 * @param array $records A list of gateway records.
	 *
	 * @return void
	 */
	public function start($records) {
		if (permission_exists($this->permission_prefix . 'edit')) {

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

			//validate the token
			$token = new token;
			if (!$token->validate($_SERVER['PHP_SELF'])) {
				message::add($text['message-invalid_token'], 'negative');
				header('Location: ' . $this->list_page);
				exit;
			}

			//start the checked gateways
			if (!empty($records) && is_array($records) && @sizeof($records) != 0) {

				//filter out unchecked gateways, build where clause for below
				foreach ($records as $record) {
					if (!empty($record['checked']) && $record['checked'] == 'true' && is_uuid($record['uuid'])) {
						$uuids[] = "'" . $record['uuid'] . "'";
					}
				}

				//get necessary gateway details
				if (!empty($uuids) && is_array($uuids) && @sizeof($uuids) != 0) {
					$sql = "select " . $this->uuid_prefix . "uuid as uuid, gateway, profile, enabled from v_" . $this->table . " ";
					if (permission_exists('gateway_all')) {
						$sql .= "where " . $this->uuid_prefix . "uuid in (" . implode(', ', $uuids) . ") ";
					} else {
						$sql                       .= "where (domain_uuid = :domain_uuid) ";
						$sql                       .= "and " . $this->uuid_prefix . "uuid in (" . implode(', ', $uuids) . ") ";
						$parameters['domain_uuid'] = $this->domain_uuid;
					}
					$rows = $this->database->select($sql, $parameters ?? null, 'all');
					if (!empty($rows) && is_array($rows) && @sizeof($rows) != 0) {
						foreach ($rows as $row) {
							$gateways[$row['uuid']]['name']    = $row['gateway'];
							$gateways[$row['uuid']]['profile'] = $row['profile'];
							$gateways[$row['uuid']]['enabled'] = $row['enabled'];
						}
					}
					unset($sql, $parameters, $rows, $row);
				}

				if (!empty($gateways) && is_array($gateways) && @sizeof($gateways) != 0) {
					//create the event socket connection
					$esl = event_socket::create();
					if ($esl->is_connected()) {
						//start gateways
						foreach ($gateways as $gateway_uuid => $gateway) {
							if ($gateway['enabled'] == 'true') {
								//start gateways
								foreach ($gateways as $gateway_uuid => $gateway) {
									if ($gateway['enabled'] == 'true') {
										$cmd                                 = 'sofia profile ' . $gateway['profile'] . ' startgw ' . $gateway_uuid;
										$responses[$gateway_uuid]['gateway'] = $gateway['name'];
										$responses[$gateway_uuid]['message'] = trim(event_socket::api($cmd));
									}
								}
								//old method used to start gateways
								//$cmd = 'sofia profile '.$gateway['profile'].' rescan';
								//$responses[$gateway_uuid]['gateway'] = $gateway['name'];
								//$responses[$gateway_uuid]['message'] = trim(event_socket::api($cmd));
							}
						}

						//set message
						if (!empty($responses) && is_array($responses) && @sizeof($responses) != 0) {
							$message = $text['message-gateway_started'];
							foreach ($responses as $response) {
								$message .= "<br><strong>" . $response['gateway'] . "</strong>: " . $response['message'];
							}
							message::add($message, 'positive', 7000);
						}
					}
				}
			}

		}
	}

	/**
	 * Stops the checked gateways.
	 *
	 * This method checks for permission to edit and validates the token. It then
	 * filters out unchecked gateways and retrieves their details from the database.
	 * If necessary, it creates an event socket connection and stops the gateways.
	 *
	 * @param array $records A list of gateway records.
	 *
	 * @return void
	 */
	public function stop($records) {
		if (permission_exists($this->permission_prefix . 'edit')) {

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

			//validate the token
			$token = new token;
			if (!$token->validate($_SERVER['PHP_SELF'])) {
				message::add($text['message-invalid_token'], 'negative');
				header('Location: ' . $this->list_page);
				exit;
			}

			//stop the checked gateways
			if (!empty($records) && is_array($records) && @sizeof($records) != 0) {

				//filter out unchecked gateways, build where clause for below
				foreach ($records as $record) {
					if (!empty($record['checked']) && $record['checked'] == 'true' && is_uuid($record['uuid'])) {
						$uuids[] = "'" . $record['uuid'] . "'";
					}
				}

				//get necessary gateway details
				if (!empty($uuids) && is_array($uuids) && @sizeof($uuids) != 0) {
					$sql = "select " . $this->uuid_prefix . "uuid as uuid, gateway, profile, enabled from v_" . $this->table . " ";
					if (permission_exists('gateway_all')) {
						$sql .= "where " . $this->uuid_prefix . "uuid in (" . implode(', ', $uuids) . ") ";
					} else {
						$sql                       .= "where (domain_uuid = :domain_uuid) ";
						$sql                       .= "and " . $this->uuid_prefix . "uuid in (" . implode(', ', $uuids) . ") ";
						$parameters['domain_uuid'] = $this->domain_uuid;
					}
					$rows = $this->database->select($sql, $parameters ?? null, 'all');
					if (is_array($rows) && @sizeof($rows) != 0) {
						foreach ($rows as $row) {
							$gateways[$row['uuid']]['name']    = $row['gateway'];
							$gateways[$row['uuid']]['profile'] = $row['profile'];
							$gateways[$row['uuid']]['enabled'] = $row['enabled'];
						}
					}
					unset($sql, $parameters, $rows, $row);
				}

				if (!empty($gateways) && is_array($gateways) && @sizeof($gateways) != 0) {
					//create the event socket connection
					$esl = event_socket::create();
					if ($esl->is_connected()) {
						//stop gateways
						foreach ($gateways as $gateway_uuid => $gateway) {
							if ($gateway['enabled'] == 'true') {
								$cmd                                 = 'sofia profile ' . $gateway['profile'] . ' killgw ' . $gateway_uuid;
								$responses[$gateway_uuid]['gateway'] = $gateway['name'];
								$responses[$gateway_uuid]['message'] = trim(event_socket::api($cmd));
							}
						}
						//set message
						if (!empty($responses) && is_array($responses) && @sizeof($responses) != 0) {
							$message = $text['message-gateway_stopped'];
							foreach ($responses as $response) {
								$message .= "<br><strong>" . $response['gateway'] . "</strong>: " . $response['message'];
							}
							message::add($message, 'positive', 7000);
						}
					}
				}
			}

		}
	}

	/**
	 * Deletes one or more records.
	 *
	 * @param array $records An array of record IDs to delete, where each ID is an associative array
	 *                       containing 'uuid' and 'checked' keys. The 'checked' value indicates
	 *                       whether the corresponding checkbox was checked for deletion.
	 *
	 * @return void No return value; this method modifies the database state and sets a message.
	 */
	public function delete($records) {
		if (permission_exists($this->permission_prefix . 'delete')) {

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

			//validate the token
			$token = new token;
			if (!$token->validate($_SERVER['PHP_SELF'])) {
				message::add($text['message-invalid_token'], 'negative');
				header('Location: ' . $this->list_page);
				exit;
			}

			//delete multiple records
			if (!empty($records) && is_array($records) && @sizeof($records) != 0) {

				//filter out unchecked gateways, build where clause for below
				foreach ($records as $record) {
					if (!empty($record['checked']) == 'true' && is_uuid($record['uuid'])) {
						$uuids[] = "'" . $record['uuid'] . "'";
					}
				}

				//get necessary gateway details
				if (!empty($uuids) && is_array($uuids) && @sizeof($uuids) != 0) {
					$sql = "select " . $this->uuid_prefix . "uuid as uuid, gateway, profile from v_" . $this->table . " ";
					if (permission_exists('gateway_all')) {
						$sql .= "where " . $this->uuid_prefix . "uuid in (" . implode(', ', $uuids) . ") ";
					} else {
						$sql                       .= "where (domain_uuid = :domain_uuid) ";
						$sql                       .= "and " . $this->uuid_prefix . "uuid in (" . implode(', ', $uuids) . ") ";
						$parameters['domain_uuid'] = $this->domain_uuid;
					}
					$rows = $this->database->select($sql, $parameters ?? null, 'all');
					if (!empty($rows) && is_array($rows) && @sizeof($rows) != 0) {
						foreach ($rows as $row) {
							$gateways[$row['uuid']]['name']    = $row['gateway'];
							$gateways[$row['uuid']]['profile'] = $row['profile'];
						}
					}
					unset($sql, $parameters, $rows, $row);
				}

				//create the event socket connection
				$esl = event_socket::create();

				//loop through gateways
				$x = 0;
				foreach ($gateways as $gateway_uuid => $gateway) {

					//remove gateway from session variable
					unset($_SESSION['gateways'][$gateway_uuid]);

					//remove the xml file (if any)
					if (!empty($this->settings->get('switch', 'sip_profiles'))) {
						$gateway_xml_file = $this->settings->get('switch', 'sip_profiles') . "/" . $gateway['profile'] . "/v_" . $gateway_uuid . ".xml";
						if (file_exists($gateway_xml_file)) {
							unlink($gateway_xml_file);
						}
					}

					//send the api command to stop the gateway
					if ($esl->is_connected()) {
						$cmd      = 'sofia profile ' . $gateway['profile'] . ' killgw ' . $gateway_uuid;
						$response = event_socket::api($cmd);
						unset($cmd);
					}

					//build delete array
					$array[$this->table][$x][$this->uuid_prefix . 'uuid'] = $gateway_uuid;
					$x++;

				}

				//delete the checked rows
				if (!empty($array) && is_array($array) && @sizeof($array) != 0) {

					//execute delete
					$this->database->delete($array);
					unset($array);

					//synchronize the xml config
					save_gateway_xml();

					//clear the cache

					$cache = new cache;
					$cache->delete(gethostname() . ":configuration:sofia.conf");

					//rescan the sip profile to look for new or stopped gateways
					$esl = event_socket::create();
					if ($esl->is_connected()) {
						//get distinct profiles from gateways
						foreach ($gateways as $gateway) {
							$array[] = $gateway['profile'];
						}
						$profiles = array_unique($array);

						//send the api command to rescan each profile
						foreach ($profiles as $profile) {
							$response = event_socket::api("sofia profile $profile rescan");
						}
					}
					usleep(1000);

					//clear the apply settings reminder
					$_SESSION["reload_xml"] = false;

					//set message
					message::add($text['message-delete']);
				}
				unset($records);
			}
		}
	}

	/**
	 * Toggles the state of one or more records.
	 *
	 * @param array $records  An array of record IDs to delete, where each ID is an associative array
	 *                        containing 'uuid' and 'checked' keys. The 'checked' value indicates
	 *                        whether the corresponding checkbox was checked for deletion.
	 *
	 * @return void No return value; this method modifies the database state and sets a message.
	 */
	public function toggle($records) {
		if (permission_exists($this->permission_prefix . 'edit')) {

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

			//validate the token
			$token = new token;
			if (!$token->validate($_SERVER['PHP_SELF'])) {
				message::add($text['message-invalid_token'], 'negative');
				header('Location: ' . $this->list_page);
				exit;
			}

			//toggle the checked records
			if (!empty($records) && is_array($records) && @sizeof($records) != 0) {

				//get current toggle state
				foreach ($records as $record) {
					if (!empty($record['checked']) && $record['checked'] == 'true' && is_uuid($record['uuid'])) {
						$uuids[] = "'" . $record['uuid'] . "'";
					}
				}
				if (!empty($uuids) && is_array($uuids) && @sizeof($uuids) != 0) {
					$sql = "select " . $this->uuid_prefix . "uuid as uuid, " . $this->toggle_field . " as state, gateway, profile from v_" . $this->table . " ";
					if (permission_exists('gateway_all')) {
						$sql .= "where " . $this->uuid_prefix . "uuid in (" . implode(', ', $uuids) . ") ";
					} else {
						$sql                       .= "where (domain_uuid = :domain_uuid) ";
						$sql                       .= "and " . $this->uuid_prefix . "uuid in (" . implode(', ', $uuids) . ") ";
						$parameters['domain_uuid'] = $this->domain_uuid;
					}
					$rows = $this->database->select($sql, $parameters ?? null, 'all');
					if (!empty($rows) && is_array($rows) && @sizeof($rows) != 0) {
						foreach ($rows as $row) {
							$gateways[$row['uuid']]['state']   = $row['state'];
							$gateways[$row['uuid']]['name']    = $row['gateway'];
							$gateways[$row['uuid']]['profile'] = $row['profile'];
						}
					}
					unset($sql, $parameters, $rows, $row);
				}

				//build update array
				$x = 0;
				foreach ($gateways as $uuid => $gateway) {
					$array[$this->table][$x][$this->uuid_prefix . 'uuid'] = $uuid;
					$array[$this->table][$x][$this->toggle_field]         = $gateway['state'] == $this->toggle_values[0] ? $this->toggle_values[1] : $this->toggle_values[0];
					$x++;
				}

				//save the changes
				if (!empty($array) && is_array($array) && @sizeof($array) != 0) {

					//save the array

					$this->database->save($array);
					unset($array);

					//update gateway session variables or remove xml files (if necessary)
					foreach ($gateways as $gateway_uuid => $gateway) {
						if ($gateway['state'] == 'true') {
							$_SESSION['gateways'][$gateway_uuid] = $gateway['name'];
						} else {
							unset($_SESSION['gateways'][$gateway_uuid]);

							//remove the xml file (if any)
							if (!empty($this->settings->get('switch', 'sip_profiles'))) {
								$gateway_xml_file = $this->settings->get('switch', 'sip_profiles') . "/" . $gateway['profile'] . "/v_" . $gateway_uuid . ".xml";
								if (file_exists($gateway_xml_file)) {
									unlink($gateway_xml_file);
								}
							}
						}
					}

					//synchronize the xml config
					save_gateway_xml();

					//clear the cache
					$cache = new cache;
					$cache->delete(gethostname() . ":configuration:sofia.conf");

					//create the event socket connection
					$esl = event_socket::create();

					//rescan the sip profile to look for new or stopped gateways
					if ($esl->is_connected()) {
						//get distinct profiles from gateways
						foreach ($gateways as $gateway) {
							$array[] = $gateway['profile'];
						}
						$profiles = array_unique($array);

						//send the api command to rescan each profile
						foreach ($profiles as $profile) {
							event_socket::api("sofia profile $profile rescan");
						}
					}
					usleep(1000);

					//clear the apply settings reminder
					$_SESSION["reload_xml"] = false;

					//set message
					message::add($text['message-toggle']);
				}
				unset($records, $gateways);
			}

		}
	}

	/**
	 * Copies one or more records
	 *
	 * @param array $records  An array of record IDs to delete, where each ID is an associative array
	 *                        containing 'uuid' and 'checked' keys. The 'checked' value indicates
	 *                        whether the corresponding checkbox was checked for deletion.
	 *
	 * @return void No return value; this method modifies the database state and sets a message.
	 */
	public function copy($records) {
		if (permission_exists($this->permission_prefix . 'add')) {

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

			//validate the token
			$token = new token;
			if (!$token->validate($_SERVER['PHP_SELF'])) {
				message::add($text['message-invalid_token'], 'negative');
				header('Location: ' . $this->list_page);
				exit;
			}

			//copy the checked records
			if (!empty($records) && is_array($records) && @sizeof($records) != 0) {

				//get checked records
				foreach ($records as $record) {
					if (!empty($record['checked']) && $record['checked'] == 'true' && is_uuid($record['uuid'])) {
						$uuids[] = "'" . $record['uuid'] . "'";
					}
				}

				//create insert array from existing data
				if (!empty($uuids) && is_array($uuids) && @sizeof($uuids) != 0) {
					$sql = "select * from v_" . $this->table . " ";
					if (permission_exists('gateway_all')) {
						$sql .= "where " . $this->uuid_prefix . "uuid in (" . implode(', ', $uuids) . ") ";
					} else {
						$sql                       .= "where (domain_uuid = :domain_uuid) ";
						$sql                       .= "and " . $this->uuid_prefix . "uuid in (" . implode(', ', $uuids) . ") ";
						$parameters['domain_uuid'] = $this->domain_uuid;
					}
					$rows = $this->database->select($sql, $parameters ?? null, 'all');
					if (!empty($rows) && is_array($rows) && @sizeof($rows) != 0) {
						foreach ($rows as $x => $row) {
							$primary_uuid = uuid();

							//convert boolean values to a string
							foreach ($row as $key => $value) {
								if (gettype($value) == 'boolean') {
									$value     = $value ? 'true' : 'false';
									$row[$key] = $value;
								}
							}

							//copy data
							$array[$this->table][$x] = $row;

							//overwrite
							$array[$this->table][$x][$this->uuid_prefix . 'uuid'] = $primary_uuid;
							$array[$this->table][$x]['description']               = trim($row['description'] . ' (' . $text['label-copy'] . ')');
							unset($array[$this->table][$x]['channels']);

							//defaults
							if (empty($row['expire_seconds'])) {
								$array[$this->table][$x]['expire_seconds'] = '800';
							}
							if (empty($row['retry_seconds'])) {
								$array[$this->table][$x]['retry_seconds'] = '30';
							}

							//array of new gateways
							if ($row['enabled'] == 'true') {
								$gateways[$primary_uuid]['name'] = $row['gateway'];
							}
						}
					}
					unset($sql, $parameters, $rows, $row);
				}

				//save the changes and set the message
				if (!empty($array) && is_array($array) && @sizeof($array) != 0) {

					//save the array

					$this->database->save($array);
					unset($array);

					//add new gateways to session variables
					if (!empty($gateways) && is_array($gateways) && @sizeof($gateways) != 0) {
						foreach ($gateways as $gateway_uuid => $gateway) {
							$_SESSION['gateways'][$gateway_uuid] = $gateway['name'];
						}
					}

					//synchronize the xml config
					save_gateway_xml();

					//clear the cache
					$cache = new cache;
					$cache->delete(gethostname() . ":configuration:sofia.conf");

					//set message
					message::add($text['message-copy']);

				}
				unset($records, $gateways);
			}

		}
	}

}