diegods/homelabdspbx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Create more documentation (#7627)

Browse Source 
* Documentation, format class, no modification.
This commit is contained in:
frytimo
2025-11-18 21:33:07 -04:00
committed by GitHub
parent e619c97ce6
commit adfc4cc469
104 changed files with 24461 additions and 21721 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app/recordings/recordings.php
+10 -3
View File
@@ -328,8 +328,8 @@
}
$param .= "&order_by=".$order_by."&order=".$order;
$page = isset($_GET['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);
[$paging_controls, $rows_per_page] = paging($num_rows, $param, $rows_per_page);
[$paging_controls_mini, $rows_per_page] = paging($num_rows, $param, $rows_per_page, true);
$offset = $rows_per_page * $page;
//set the time zone
@@ -622,6 +622,13 @@
require_once "resources/footer.php";
//define the download function (helps safari play audio sources)
/**
* Downloads a file in range mode, allowing the client to request specific byte ranges.
*
* @param string $file Path to the file being downloaded
*
* @return void
*/
function range_download($file) {
$fp = @fopen($file, 'rb');
@@ -650,7 +657,7 @@
$c_start = $start;
$c_end = $end;
// Extract the range string
list(, $range) = explode('=', $_SERVER['HTTP_RANGE'], 2);
[, $range] = explode('=', $_SERVER['HTTP_RANGE'], 2);
// Make sure the client hasn't sent us a multibyte range
if (strpos($range, ',') !== false) {
// (?) Shoud this be issued here, or should the first
app/recordings/resources/classes/switch_recordings.php
+170 -145
View File
@@ -26,164 +26,189 @@
*/
//define the switch_recordings class
class switch_recordings {
class switch_recordings {
/**
* declare constant variables
*/
const app_name = 'recordings';
const app_uuid = '83913217-c7a2-9e90-925d-a866eb40b60e';
/**
* declare constant variables
*/
const app_name = 'recordings';
const app_uuid = '83913217-c7a2-9e90-925d-a866eb40b60e';
/**
* 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
*/
public $domain_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
*/
public $domain_uuid;
/**
* Set in the constructor. Must be a database object and cannot be null.
* @var database Database Object
*/
private $database;
/**
* 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;
/**
* 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;
/**
* 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 name 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_name;
/**
* Domain name 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_name;
/**
* declare private variables
*/
private $permission_prefix;
private $list_page;
private $table;
private $uuid_prefix;
private $toggle_field;
private $toggle_values;
/**
* declare private variables
*/
private $permission_prefix;
private $list_page;
private $table;
private $uuid_prefix;
private $toggle_field;
private $toggle_values;
/**
* called when the object is created
*/
public function __construct(array $setting_array = []) {
//set domain and user UUIDs
$this->domain_uuid = $setting_array['domain_uuid'] ?? $_SESSION['domain_uuid'] ?? '';
$this->domain_name = $setting_array['domain_name'] ?? $_SESSION['domain_name'] ?? '';
$this->user_uuid = $setting_array['user_uuid'] ?? $_SESSION['user_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->domain_name = $setting_array['domain_name'] ?? $_SESSION['domain_name'] ?? '';
$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]);
//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 = 'recording_';
$this->list_page = 'recordings.php';
$this->table = 'recordings';
$this->uuid_prefix = 'recording_';
//assign private variables
$this->permission_prefix = 'recording_';
$this->list_page = 'recordings.php';
$this->table = 'recordings';
$this->uuid_prefix = 'recording_';
}
/**
* Retrieves a list of recordings.
*
* This method queries the database for recordings associated with the current domain UUID
* and populates an array with the recording filenames. The array keys are constructed using
* the directory path specified in the 'switch' settings, relative to the domain name.
*
* @return array|false An array of recording filenames where the keys represent the file paths on disk,
* or false if no recordings were found.
*/
public function list_recordings() {
$sql = "select recording_uuid, recording_filename ";
$sql .= "from v_recordings ";
$sql .= "where domain_uuid = :domain_uuid ";
$parameters['domain_uuid'] = $this->domain_uuid;
$result = $this->database->select($sql, $parameters, 'all');
if (!empty($result)) {
$switch_recordings_domain_dir = $this->settings->get('switch', 'recordings') . '/' . $this->domain_name;
foreach ($result as $row) {
$recordings[$switch_recordings_domain_dir . "/" . $row['recording_filename']] = $row['recording_filename'];
}
} else {
$recordings = false;
}
unset($sql, $parameters, $result, $row);
return $recordings;
}
/**
* list recordings
*/
public function list_recordings() {
$sql = "select recording_uuid, recording_filename ";
$sql .= "from v_recordings ";
$sql .= "where domain_uuid = :domain_uuid ";
$parameters['domain_uuid'] = $this->domain_uuid;
$result = $this->database->select($sql, $parameters, 'all');
if (!empty($result)) {
$switch_recordings_domain_dir = $this->settings->get('switch', 'recordings').'/'.$this->domain_name;
foreach ($result as $row) {
$recordings[$switch_recordings_domain_dir."/".$row['recording_filename']] = $row['recording_filename'];
/**
* 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) {
//get recording filename, build delete array
foreach ($records as $x => $record) {
if (!empty($record['checked']) && $record['checked'] == 'true' && !empty($record['uuid'])) {
//get filename
$sql = "select recording_filename from v_recordings ";
$sql .= "where domain_uuid = :domain_uuid ";
$sql .= "and recording_uuid = :recording_uuid ";
$parameters['domain_uuid'] = $this->domain_uuid;
$parameters['recording_uuid'] = $record['uuid'];
$filenames[] = $this->database->select($sql, $parameters, 'column');
unset($sql, $parameters);
//build delete array
$array[$this->table][$x][$this->uuid_prefix . 'uuid'] = $record['uuid'];
$array[$this->table][$x]['domain_uuid'] = $this->domain_uuid;
}
}
//delete the checked rows
if (is_array($array) && @sizeof($array) != 0) {
//execute delete
$this->database->delete($array);
unset($array);
//delete recording files
if (is_array($filenames) && @sizeof($filenames) != 0) {
$switch_recordings_domain_dir = $this->settings->get('switch', 'recordings') . "/" . $this->domain_name;
foreach ($filenames as $filename) {
if (!empty($filename) && file_exists($switch_recordings_domain_dir . "/" . $filename)) {
@unlink($switch_recordings_domain_dir . "/" . $filename);
}
}
}
//clear the destinations session array
if (isset($_SESSION['destinations']['array'])) {
unset($_SESSION['destinations']['array']);
}
//set message
message::add($text['message-delete']);
}
unset($records);
}
else {
$recordings = false;
}
unset($sql, $parameters, $result, $row);
return $recordings;
}
/**
* delete records
*/
public function delete($records) {
if (permission_exists($this->permission_prefix.'delete')) {
} //method
//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) {
//get recording filename, build delete array
foreach ($records as $x => $record) {
if (!empty($record['checked']) && $record['checked'] == 'true' && !empty($record['uuid'])) {
//get filename
$sql = "select recording_filename from v_recordings ";
$sql .= "where domain_uuid = :domain_uuid ";
$sql .= "and recording_uuid = :recording_uuid ";
$parameters['domain_uuid'] = $this->domain_uuid;
$parameters['recording_uuid'] = $record['uuid'];
$filenames[] = $this->database->select($sql, $parameters, 'column');
unset($sql, $parameters);
//build delete array
$array[$this->table][$x][$this->uuid_prefix.'uuid'] = $record['uuid'];
$array[$this->table][$x]['domain_uuid'] = $this->domain_uuid;
}
}
//delete the checked rows
if (is_array($array) && @sizeof($array) != 0) {
//execute delete
$this->database->delete($array);
unset($array);
//delete recording files
if (is_array($filenames) && @sizeof($filenames) != 0) {
$switch_recordings_domain_dir = $this->settings->get('switch', 'recordings')."/".$this->domain_name;
foreach ($filenames as $filename) {
if (!empty($filename) && file_exists($switch_recordings_domain_dir."/".$filename)) {
@unlink($switch_recordings_domain_dir."/".$filename);
}
}
}
//clear the destinations session array
if (isset($_SESSION['destinations']['array'])) {
unset($_SESSION['destinations']['array']);
}
//set message
message::add($text['message-delete']);
}
unset($records);
}
}
} //method
} //class
} //class