Portions created by the Initial Developer are Copyright (C) 2008-2023 the Initial Developer. All Rights Reserved. Contributor(s): Mark J Crane */ //define the sip profiles class class sip_profiles { /** * declare constant variables */ const app_name = 'sip_profiles'; const app_uuid = 'a6a7c4c5-340a-43ce-bcbc-2ed9bab8659d'; /** * 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; /** * declare public variables */ public $sip_profile_uuid; /** * 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 = 'sip_profile_'; $this->list_page = 'sip_profiles.php'; $this->table = 'sip_profiles'; $this->uuid_prefix = 'sip_profile_'; $this->toggle_field = 'sip_profile_enabled'; $this->toggle_values = ['true', 'false']; } /** * 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 (is_array($records) && @sizeof($records) != 0) { //filter out unchecked sip profiles, build where clause for below foreach ($records as $x => $record) { if (!empty($record['checked']) && $record['checked'] == 'true' && is_uuid($record['uuid'])) { $uuids[] = "'" . $record['uuid'] . "'"; } } //get necessary sip profile details $sql = "select " . $this->uuid_prefix . "uuid as uuid, sip_profile_name, sip_profile_hostname from v_" . $this->table . " "; $sql .= "where " . $this->uuid_prefix . "uuid in (" . implode(', ', $uuids) . ") "; $rows = $this->database->select($sql, $parameters ?? null, 'all'); if (is_array($rows) && @sizeof($rows) != 0) { foreach ($rows as $row) { $sip_profiles[$row['uuid']]['name'] = $row['sip_profile_name']; $sip_profiles[$row['uuid']]['hostname'] = $row['sip_profile_hostname']; } } unset($sql, $parameters, $rows, $row); //build the delete array $x = 0; foreach ($sip_profiles as $sip_profile_uuid => $sip_profile) { $array[$this->table][$x][$this->uuid_prefix . 'uuid'] = $sip_profile_uuid; $array['sip_profile_domains'][$x][$this->uuid_prefix . 'uuid'] = $sip_profile_uuid; $array['sip_profile_settings'][$x][$this->uuid_prefix . 'uuid'] = $sip_profile_uuid; $x++; } //delete the checked rows if (is_array($array) && @sizeof($array) != 0) { //grant temporary permissions $p = permissions::new(); $p->add('sip_profile_domain_delete', 'temp'); $p->add('sip_profile_setting_delete', 'temp'); //execute delete $this->database->delete($array); unset($array); //revoke temporary permissions $p->delete('sip_profile_domain_delete', 'temp'); $p->delete('sip_profile_setting_delete', 'temp'); //delete the xml sip profile and directory $switch_conf_dir = $this->settings->get('switch', 'conf'); foreach ($sip_profiles as $sip_profile_uuid => $sip_profile) { @unlink($switch_conf_dir . "/sip_profiles/" . $sip_profile['name'] . ".xml"); @unlink($switch_conf_dir . "/sip_profiles/" . $sip_profile['name']); } //save the sip profile xml save_sip_profile_xml(); //apply settings reminder $_SESSION["reload_xml"] = true; //determine hostnames, get system hostname if necessary $empty_hostname = false; foreach ($sip_profiles as $sip_profile_uuid => $sip_profile) { if ($sip_profile['hostname'] != '') { $hostnames[] = $sip_profile['hostname']; } else { $empty_hostname = true; } } if ($empty_hostname) { $hostnames[] = gethostname(); } //clear the cache if (is_array($hostnames) && @sizeof($hostnames) != 0) { $hostnames = array_unique($hostnames); $cache = new cache; foreach ($hostnames as $hostname) { $cache->delete($hostname . ":configuration:sofia.conf"); } } //set message message::add($text['message-delete']); } unset($records, $sip_profiles); } } } /** * Deletes specified domains from the system. * * @param array $records An array of records to be deleted, each containing 'checked' and 'uuid' keys. * * @return void */ public function delete_domains($records) { //assign private variables $this->permission_prefix = 'sip_profile_domain_'; $this->list_page = 'sip_profile_edit.php?id=' . $this->sip_profile_uuid; $this->table = 'sip_profile_domains'; $this->uuid_prefix = 'sip_profile_domain_'; 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 (is_array($records) && @sizeof($records) != 0) { //filter out unchecked sip profiles, build the delete array foreach ($records as $x => $record) { if (!empty($record['checked']) && $record['checked'] == 'true' && is_uuid($record['uuid'])) { $array[$this->table][$x][$this->uuid_prefix . 'uuid'] = $record['uuid']; $array[$this->table][$x]['sip_profile_uuid'] = $this->sip_profile_uuid; } } //get necessary sip profile details if (!empty($this->sip_profile_uuid) && is_uuid($this->sip_profile_uuid)) { $sql = "select sip_profile_hostname from v_sip_profiles "; $sql .= "where sip_profile_uuid = :sip_profile_uuid "; $parameters['sip_profile_uuid'] = $this->sip_profile_uuid; $sip_profile_hostname = $this->database->select($sql, $parameters, 'column'); unset($sql, $parameters); } //delete the checked rows if (!empty($array) && @sizeof($array) != 0) { //execute delete $this->database->delete($array); unset($array); //save the sip profile xml save_sip_profile_xml(); //apply settings reminder $_SESSION["reload_xml"] = true; //get system hostname if necessary if (empty($sip_profile_hostname)) { $sip_profile_hostname = gethostname(); } //clear the cache if (!empty($sip_profile_hostname)) { $cache = new cache; $cache->delete($sip_profile_hostname . ":configuration:sofia.conf"); } } unset($records); } } } /** * Deletes settings for one or more sip profiles. * * @param array $records An associative array containing the records to delete, where each record is an associative array * with 'uuid' and optionally 'checked' keys. Defaults to an empty array. * * @return void */ public function delete_settings($records) { //assign private variables $this->permission_prefix = 'sip_profile_setting_'; $this->list_page = 'sip_profile_edit.php?id=' . $this->sip_profile_uuid; $this->table = 'sip_profile_settings'; $this->uuid_prefix = 'sip_profile_setting_'; 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) && @sizeof($records) != 0) { //filter out unchecked sip profiles, build the delete array foreach ($records as $x => $record) { if (!empty($record['checked']) && $record['checked'] == 'true' && is_uuid($record['uuid'])) { $array[$this->table][$x][$this->uuid_prefix . 'uuid'] = $record['uuid']; $array[$this->table][$x]['sip_profile_uuid'] = $this->sip_profile_uuid; } } //get necessary sip profile details if (!empty($this->sip_profile_uuid) && is_uuid($this->sip_profile_uuid)) { $sql = "select sip_profile_hostname from v_sip_profiles "; $sql .= "where sip_profile_uuid = :sip_profile_uuid "; $parameters['sip_profile_uuid'] = $this->sip_profile_uuid; $sip_profile_hostname = $this->database->select($sql, $parameters, 'column'); unset($sql, $parameters); } //delete the checked rows if (!empty($array) && @sizeof($array) != 0) { //execute delete $this->database->delete($array); unset($array); //save the sip profile xml save_sip_profile_xml(); //apply settings reminder $_SESSION["reload_xml"] = true; //get system hostname if necessary if (empty($sip_profile_hostname)) { $sip_profile_hostname = gethostname(); } //clear the cache if (!empty($sip_profile_hostname)) { $cache = new cache; $cache->delete($sip_profile_hostname . ":configuration:sofia.conf"); } } 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 (is_array($records) && @sizeof($records) != 0) { //get current toggle state foreach ($records as $x => $record) { if (!empty($record['checked']) && $record['checked'] == 'true' && is_uuid($record['uuid'])) { $uuids[] = "'" . $record['uuid'] . "'"; } } if (!empty($uuids) && @sizeof($uuids) != 0) { $sql = "select " . $this->uuid_prefix . "uuid as uuid, " . $this->toggle_field . " as toggle, sip_profile_hostname from v_" . $this->table . " "; $sql .= "where " . $this->uuid_prefix . "uuid in (" . implode(', ', $uuids) . ") "; $rows = $this->database->select($sql, $parameters ?? null, 'all'); if (is_array($rows) && @sizeof($rows) != 0) { foreach ($rows as $row) { $sip_profiles[$row['uuid']]['state'] = $row['toggle']; $sip_profiles[$row['uuid']]['hostname'] = $row['sip_profile_hostname']; } } unset($sql, $parameters, $rows, $row); } //build update array $x = 0; foreach ($sip_profiles as $uuid => $sip_profile) { $array[$this->table][$x][$this->uuid_prefix . 'uuid'] = $uuid; $array[$this->table][$x][$this->toggle_field] = $sip_profile['state'] == $this->toggle_values[0] ? $this->toggle_values[1] : $this->toggle_values[0]; $x++; } //save the changes if (!empty($array) && @sizeof($array) != 0) { //save the array $this->database->save($array); unset($array); //determine hostnames, get system hostname if necessary $empty_hostname = false; foreach ($sip_profiles as $sip_profile_uuid => $sip_profile) { if ($sip_profile['hostname'] != '') { $hostnames[] = $sip_profile['hostname']; } else { $empty_hostname = true; } } if ($empty_hostname) { $esl = event_socket::create(); if ($esl->is_connected()) { $hostnames[] = gethostname(); } } //clear the cache if (!empty($hostnames) && @sizeof($hostnames) != 0) { $hostnames = array_unique($hostnames); $cache = new cache; foreach ($hostnames as $hostname) { $cache->delete($hostname . ":configuration:sofia.conf"); } } //save the sip profile xml save_sip_profile_xml(); //apply settings reminder $_SESSION["reload_xml"] = true; //set message message::add($text['message-toggle']); } unset($records, $states); } } } }