Files
fusionpbx/app/system/resources/classes/system_dashboard_service.php
frytimo 599885daf6 Fix bug by adding 'tries' counter so reading websocket data can return (#7471)
When reading web socket data, the loop will run forever if there is no more data available in a chunk. This fix will add a counter to how many times it tries to read before a timeout is reached.
Fixed a problem where the constructor parameter for permission_filter was not being fulfilled. This can cause a crash also leading to the read of web socket data to begin looping.
Added better debugging information by using the topic of the websocket_message instead of the payload data. This would cause some messages to appear empty when they were not.
Added a wait state for re-connecting to the web socket server for system status service so it would not exit immediately when the websocket server exited.
Added more PHPDoc Block information.
2025-08-27 08:02:21 -06:00

165 lines
4.2 KiB
PHP

<?php
class system_dashboard_service extends base_websocket_system_service {
const PERMISSIONS = [
'system_view_cpu',
'system_view_backup',
'system_view_database',
'system_view_hdd',
'system_view_info',
'system_view_memcache',
'system_view_ram',
'system_view_support',
];
const CPU_STATUS_TOPIC = 'cpu_status';
/**
*
* @var system_information $system_information
*/
protected static $system_information;
/**
* Settings object
* @var settings
*/
private $settings;
/**
* Integer representing the number of seconds to broadcast the CPU usage
* @var int
*/
private $cpu_status_refresh_interval;
protected function reload_settings(): void {
static::set_system_information();
// re-read the config file to get any possible changes
parent::$config->read();
// re-connect to the websocket server if required
$this->connect_to_ws_server();
// Connect to the database
$database = new database(['config' => parent::$config]);
// get the interval
$this->settings = new settings(['database' => $database]);
// get the settings from the global defaults
$this->cpu_status_refresh_interval = $this->settings->get('dashboard', 'cpu_status_refresh_interval', 3);
}
/**
* @override base_websocket_system_service
* @return void
*/
protected function on_timer(): void {
// Send the CPU status
$this->on_cpu_status();
// Reset the timer
$this->set_timer($this->cpu_status_refresh_interval);
}
/**
* Executes once
* @return void
*/
protected function register_topics(): void {
// get the settings from the global defaults
$this->reload_settings();
// Create a system information object that can tell us the cpu regardless of OS
self::$system_information = system_information::new();
// Register the call back to respond to cpu_status requests
$this->on_topic('cpu_status', [$this, 'on_cpu_status']);
// Set a timer
$this->set_timer($this->cpu_status_refresh_interval);
// Notify the user of the interval
$this->info("Broadcasting CPU Status every {$this->cpu_status_refresh_interval}s");
}
public function on_cpu_status($message = null): void {
// Get total and per-core CPU usage
$cpu_percent_total = self::$system_information->get_cpu_percent();
$cpu_percent_per_core = self::$system_information->get_cpu_percent_per_core();
// Prepare response
$response = new websocket_message();
$response
->payload([
self::CPU_STATUS_TOPIC => [
'total' => $cpu_percent_total,
'per_core' => array_values($cpu_percent_per_core)
]
])
->service_name(self::get_service_name())
->topic(self::CPU_STATUS_TOPIC);
// Include message ID if responding to a request
if ($message !== null && $message instanceof websocket_message) {
$response->id($message->id());
}
// Log for debugging
$this->debug(sprintf(
"Broadcasting CPU total %.2f%% with %d cores",
$cpu_percent_total,
count($cpu_percent_per_core)
));
$show_disconnect_message = true;
try {
// Send the broadcast
$this->respond($response);
} catch (\socket_disconnected_exception $sde) {
// wait until we connect again
while (!$this->connect_to_ws_server()) {
if ($show_disconnect_message) {
$this->warn("Websocket server disconnected");
$show_disconnect_message = false;
}
sleep(1);
}
$this->warn("Websocket server connected");
}
}
public static function get_service_name(): string {
return "dashboard.system.information";
}
public static function create_filter_chain_for(subscriber $subscriber): ?filter {
// Get the subscriber permissions
$permissions = $subscriber->get_permissions();
// Create a filter for broadcaster => permission
$permission_filter = new permission_filter([self::get_service_name() => 'system_view_cpu']);
// Match them to create a filter
foreach (self::PERMISSIONS as $permission) {
if (in_array($permission, $permissions)) {
$permission_filter->add_permission($permission);
}
}
$filter = filter_chain::and_link([$permission_filter]);
// Return the filter with user permissions to ensure they can't receive information they shouldn't
return $filter;
}
public static function set_system_information(): void {
self::$system_information = system_information::new();
}
}