refactor(plg): state include ServerState class

2026-02-22 08:18:39 -06:00 · 2023-11-08 16:17:06 -08:00
parent 95554e9832
commit a658206cd4
4 changed files with 163 additions and 104 deletions
--- a/plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/data/server-state.php
+++ b/plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/data/server-state.php
@@ -7,6 +7,9 @@ require_once "$docroot/webGui/include/Helpers.php";
 extract(parse_plugin_cfg('dynamix',true));
 require_once "$docroot/plugins/dynamix.my.servers/include/state.php";

+$serverStateClass = new ServerState();
+$serverStateData = $serverStateClass->getServerState();
+
 header('Content-type: application/json');

-echo json_encode($serverState);
+echo json_encode($serverStateData);
--- a/plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/include/myservers2.php
+++ b/plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/include/myservers2.php
@@ -2,6 +2,9 @@
 $docroot ??= ($_SERVER['DOCUMENT_ROOT'] ?: '/usr/local/emhttp');
 require_once("$docroot/plugins/dynamix.my.servers/include/state.php");
 require_once("$docroot/plugins/dynamix.my.servers/include/translations.php");
+
+$serverStateClass = new ServerState();
+$serverStateData = $serverStateClass->getServerState();
 ?>
 <script>
 window.LOCALE_DATA = '<?= rawurlencode(json_encode($webComponentTranslations, JSON_UNESCAPED_SLASHES, JSON_UNESCAPED_UNICODE)) ?>';
@@ -21,5 +24,5 @@ if (!document.getElementsByTagName(modalsWebComponent).length) {
 <?
 echo "
 <unraid-i18n-host>
-    <unraid-user-profile server='" . json_encode($serverState) . "'></unraid-user-profile>
+    <unraid-user-profile server='" . json_encode($serverStateData) . "'></unraid-user-profile>
 </unraid-i18n-host>";
--- a/plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/include/reboot-details.php
+++ b/plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/include/reboot-details.php
@@ -1,5 +1,4 @@
-<?
-
+<?php
 /**
 * RebootDetails class is responsible for detecting the type and version of a system reboot required in the context of an unRAID server.
 *
--- a/plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/include/state.php
+++ b/plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/include/state.php
@@ -1,105 +1,159 @@
 <?php
-$docroot ??= ($_SERVER['DOCUMENT_ROOT'] ?: '/usr/local/emhttp');
+$webguiGlobals = $GLOBALS;
+$docroot = $docroot ?? $_SERVER['DOCUMENT_ROOT'] ?: '/usr/local/emhttp';
+
 require_once "$docroot/plugins/dynamix.my.servers/include/reboot-details.php";
-
-// read flashbackup ini file
-$flashbackup_ini = '/var/local/emhttp/flashbackup.ini';
-$flashbackup_status = (file_exists($flashbackup_ini)) ? @parse_ini_file($flashbackup_ini) : [];
-
-$nginx = parse_ini_file('/var/local/emhttp/nginx.ini');
-
-// base OS only, plugin not installed • show ad for plugin
-$connectPluginInstalled = '';
-if (file_exists('/var/lib/pkgtools/packages/dynamix.unraid.net')) $connectPluginInstalled = 'dynamix.unraid.net.plg';
-if (file_exists('/var/lib/pkgtools/packages/dynamix.unraid.net.staging')) $connectPluginInstalled = 'dynamix.unraid.net.staging.plg';
-// plugin install failed if the unraid-api file doesn't fully install • append failure detected so we can show warning about failed install via UPC
-if ($connectPluginInstalled && !file_exists('/usr/local/sbin/unraid-api')) $connectPluginInstalled .= '_installFailed';
-
-$connectPluginVersion = file_exists('/var/log/plugins/dynamix.unraid.net.plg')
-    ? trim(@exec('/usr/local/sbin/plugin version /var/log/plugins/dynamix.unraid.net.plg 2>/dev/null'))
-    : (file_exists('/var/log/plugins/dynamix.unraid.net.staging.plg')
-        ? trim(@exec('/usr/local/sbin/plugin version /var/log/plugins/dynamix.unraid.net.staging.plg 2>/dev/null'))
-        : 'base-' . $var['version']);
-
-$myservers_flash_cfg_path = '/boot/config/plugins/dynamix.my.servers/myservers.cfg';
-$myservers = file_exists($myservers_flash_cfg_path) ? @parse_ini_file($myservers_flash_cfg_path,true) : [];
-
-$configErrorEnum = [
-    "error" => 'UNKNOWN_ERROR',
-    "invalid" => 'INVALID',
-    "nokeyserver" => 'NO_KEY_SERVER',
-    "withdrawn" => 'WITHDRAWN',
-];
-
-$osVersionBranch = trim(@exec('plugin category /var/log/plugins/unRAIDServer.plg') ?? 'stable');
-$registered = !empty($myservers['remote']['apikey']) && $connectPluginInstalled;
-
 /**
- * Reboot detection
+ * ServerState class encapsulates server-related information and settings.
+ *
+ * Usage:
+ * ```
+ * $serverStateClass = new ServerState();
+ * $serverStateData = $serverStateClass->getServerState();
+ * ```
 */
-// Create an instance of the RebootDetails class
-$rebootDetails = new RebootDetails();
-// Access the detected reboot type
-$rebootType = $rebootDetails->getRebootType();
+class ServerState
+{
+    protected $webguiGlobals;

-$serverState = [
-    "apiKey" => $myservers['upc']['apikey'] ?? '',
-    "apiVersion" => $myservers['api']['version'] ?? '',
-    "avatar" => (!empty($myservers['remote']['avatar']) && $connectPluginInstalled) ? $myservers['remote']['avatar'] : '',
-    "config" => [
-        'valid' => ($var['configValid'] === 'yes'),
-        /** @todo remove error key value when config is valid */
-        'error' => isset($configErrorEnum[$var['configValid']]) ? $configErrorEnum[$var['configValid']] : 'UNKNOWN_ERROR',
-    ],
-    "connectPluginInstalled" => $connectPluginInstalled,
-    "connectPluginVersion" => $connectPluginVersion,
-    "csrf" => $var['csrf_token'],
-    "dateTimeFormat" => [
-        "date" => @$display['date'] ?? '',
-        "time" => @$display['time'] ?? '',
-    ],
-    "description" => $var['COMMENT'] ? htmlspecialchars($var['COMMENT']) : '',
-    "deviceCount" => $var['deviceCount'],
-    "email" => $myservers['remote']['email'] ?? '',
-    "expireTime" => 1000 * (($var['regTy'] === 'Trial' || strstr($var['regTy'], 'expired')) ? $var['regTm2'] : 0),
-    "extraOrigins" => explode(',', $myservers['api']['extraOrigins'] ?? ''),
-    "flashProduct" => $var['flashProduct'],
-    "flashVendor" => $var['flashVendor'],
-    "flashBackupActivated" => empty($flashbackup_status['activated']) ? '' : 'true',
-    "guid" => $var['flashGUID'],
-    "hasRemoteApikey" => !empty($myservers['remote']['apikey']),
-    "internalPort" => $_SERVER['SERVER_PORT'],
-    "keyfile" => empty($var['regFILE']) ? '' : str_replace(['+', '/', '='], ['-', '_', ''], trim(base64_encode(@file_get_contents($var['regFILE'])))),
-    "lanIp" => ipaddr(),
-    "locale" => (!empty($_SESSION) && $_SESSION['locale']) ? $_SESSION['locale'] : 'en_US',
-    "model" => $var['SYS_MODEL'],
-    "name" => htmlspecialchars($var['NAME']),
-    "osVersion" => $var['version'],
-    "osVersionBranch" => $osVersionBranch,
-    "protocol" => $_SERVER['REQUEST_SCHEME'],
-    "rebootType" => $rebootType,
-    "regDev" => @(int)$var['regDev'] ?? 0,
-    "regGen" => @(int)$var['regGen'],
-    "regGuid" => @$var['regGUID'] ?? '',
-    "regTo" => @htmlspecialchars($var['regTo']) ?? '',
-    "regTm" => $var['regTm'] ? @$var['regTm'] * 1000 : '', // JS expects milliseconds
-    "regTy" => @$var['regTy'] ?? '',
-    "regExp" => $var['regExp'] ? @$var['regExp'] * 1000 : '', // JS expects milliseconds
-    "registered" => $registered,
-    "registeredTime" => $myservers['remote']['regWizTime'] ?? '',
-    "site" => $_SERVER['REQUEST_SCHEME'] . "://" . $_SERVER['HTTP_HOST'],
-    "state" => strtoupper(empty($var['regCheck']) ? $var['regTy'] : $var['regCheck']),
-    "theme" => [
-        "banner" => !empty($display['banner']),
-        "bannerGradient" => $display['showBannerGradient'] === 'yes' ?? false,
-        "bgColor" => ($display['background']) ? '#' . $display['background'] : '',
-        "descriptionShow" => (!empty($display['headerdescription']) && $display['headerdescription'] !== 'no'),
-        "metaColor" => ($display['headermetacolor'] ?? '') ? '#' . $display['headermetacolor'] : '',
-        "name" => $display['theme'],
-        "textColor" => ($display['header']) ? '#' . $display['header'] : '',
-    ],
-    "ts" => time(),
-    "uptime" => 1000 * (time() - round(strtok(exec("cat /proc/uptime"), ' '))),
-    "username" => $myservers['remote']['username'] ?? '',
-    "wanFQDN" => $nginx['NGINX_WANFQDN'] ?? '',
-];
+    private $var;
+    private $flashbackupIni;
+    private $flashbackupStatus;
+    private $nginx;
+    private $connectPluginInstalled = '';
+    private $connectPluginVersion;
+    private $myserversFlashCfgPath;
+    private $myservers;
+    private $configErrorEnum = [
+        "error" => 'UNKNOWN_ERROR',
+        "invalid" => 'INVALID',
+        "nokeyserver" => 'NO_KEY_SERVER',
+        "withdrawn" => 'WITHDRAWN',
+    ];
+    private $osVersionBranch;
+    private $registered;
+    private $rebootDetails;
+
+    /**
+     * Constructor to initialize class properties and gather server information.
+     */
+    public function __construct()
+    {
+        /**
+         * @note – necessary evil until full webgui is class based.
+         * @see - getWebguiGlobal() for usage
+         * */
+        global $webguiGlobals;
+        $this->webguiGlobals =& $webguiGlobals;
+        // echo "<pre>" . json_encode($this->webguiGlobals, JSON_PRETTY_PRINT) . "</pre>";
+
+        $this->var = (array)parse_ini_file('state/var.ini');
+
+        $this->flashbackupIni = '/var/local/emhttp/flashbackup.ini';
+        $this->flashbackupStatus = (file_exists($this->flashbackupIni)) ? @parse_ini_file($this->flashbackupIni) : [];
+        $this->nginx = parse_ini_file('/var/local/emhttp/nginx.ini');
+
+        if (file_exists('/var/lib/pkgtools/packages/dynamix.unraid.net')) {
+            $this->connectPluginInstalled = 'dynamix.unraid.net.plg';
+        }
+        if (file_exists('/var/lib/pkgtools/packages/dynamix.unraid.net.staging')) {
+            $this->connectPluginInstalled = 'dynamix.unraid.net.staging.plg';
+        }
+        if ($this->connectPluginInstalled && !file_exists('/usr/local/sbin/unraid-api')) {
+            $this->connectPluginInstalled .= '_installFailed';
+        }
+
+        $this->connectPluginVersion = file_exists('/var/log/plugins/dynamix.unraid.net.plg')
+            ? trim(@exec('/usr/local/sbin/plugin version /var/log/plugins/dynamix.unraid.net.plg 2>/dev/null'))
+            : (file_exists('/var/log/plugins/dynamix.unraid.net.staging.plg')
+                ? trim(@exec('/usr/local/sbin/plugin version /var/log/plugins/dynamix.unraid.net.staging.plg 2>/dev/null'))
+                : 'base-' . $this->var['version']);
+
+        $this->myserversFlashCfgPath = '/boot/config/plugins/dynamix.my.servers/myservers.cfg';
+        $this->myservers = file_exists($this->myserversFlashCfgPath) ? @parse_ini_file($this->myserversFlashCfgPath, true) : [];
+
+        $this->osVersionBranch = trim(@exec('plugin category /var/log/plugins/unRAIDServer.plg') ?? 'stable');
+        $this->registered = !empty($this->myservers['remote']['apikey']) && $this->connectPluginInstalled;
+
+        $this->rebootDetails = new RebootDetails();
+    }
+
+    /**
+     * Retrieve the value of a webgui global setting.
+     */
+    public function getWebguiGlobal(string $key) {
+        return $this->webguiGlobals[$key];
+    }
+
+    /**
+     * Retrieve the server information as an associative array.
+     *
+     * @return array An array containing server information.
+     */
+    public function getServerState()
+    {
+        $serverState = [
+            "apiKey" => $this->myservers['upc']['apikey'] ?? '',
+            "apiVersion" => $this->myservers['api']['version'] ?? '',
+            "avatar" => (!empty($this->myservers['remote']['avatar']) && $this->connectPluginInstalled) ? $this->myservers['remote']['avatar'] : '',
+            "config" => [
+                'valid' => ($this->var['configValid'] === 'yes'),
+                'error' => isset($this->configErrorEnum[$this->var['configValid']]) ? $this->configErrorEnum[$this->var['configValid']] : 'UNKNOWN_ERROR',
+            ],
+            "connectPluginInstalled" => $this->connectPluginInstalled,
+            "connectPluginVersion" => $this->connectPluginVersion,
+            "csrf" => $this->var['csrf_token'],
+            "dateTimeFormat" => [
+                "date" => @$this->getWebguiGlobal('display')['date'] ?? '',
+                "time" => @$this->getWebguiGlobal('display')['time'] ?? '',
+            ],
+            "description" => $this->var['COMMENT'] ? htmlspecialchars($this->var['COMMENT']) : '',
+            "deviceCount" => $this->var['deviceCount'],
+            "email" => $this->myservers['remote']['email'] ?? '',
+            "expireTime" => 1000 * (($this->var['regTy'] === 'Trial' || strstr($this->var['regTy'], 'expired')) ? $this->var['regTm2'] : 0),
+            "extraOrigins" => explode(',', $this->myservers['api']['extraOrigins'] ?? ''),
+            "flashProduct" => $this->var['flashProduct'],
+            "flashVendor" => $this->var['flashVendor'],
+            "flashBackupActivated" => empty($this->flashbackupStatus['activated']) ? '' : 'true',
+            "guid" => $this->var['flashGUID'],
+            "hasRemoteApikey" => !empty($this->myservers['remote']['apikey']),
+            "internalPort" => $_SERVER['SERVER_PORT'],
+            "keyfile" => empty($this->var['regFILE']) ? '' : str_replace(['+', '/', '='], ['-', '_', ''], trim(base64_encode(@file_get_contents($this->var['regFILE'])))),
+            "lanIp" => ipaddr(),
+            "locale" => (!empty($_SESSION) && $_SESSION['locale']) ? $_SESSION['locale'] : 'en_US',
+            "model" => $this->var['SYS_MODEL'],
+            "name" => htmlspecialchars($this->var['NAME']),
+            "osVersion" => $this->var['version'],
+            "osVersionBranch" => $this->osVersionBranch,
+            "protocol" => $_SERVER['REQUEST_SCHEME'],
+            "rebootType" => $this->rebootDetails->getRebootType(),
+            "regDev" => @(int)$this->var['regDev'] ?? 0,
+            "regGen" => @(int)$this->var['regGen'],
+            "regGuid" => @$this->var['regGUID'] ?? '',
+            "regTo" => @htmlspecialchars($this->var['regTo']) ?? '',
+            "regTm" => $this->var['regTm'] ? @$this->var['regTm'] * 1000 : '', // JS expects milliseconds
+            "regTy" => @$this->var['regTy'] ?? '',
+            "regExp" => $this->var['regExp'] ? @$this->var['regExp'] * 1000 : '', // JS expects milliseconds
+            "registered" => $this->registered,
+            "registeredTime" => $this->myservers['remote']['regWizTime'] ?? '',
+            "site" => $_SERVER['REQUEST_SCHEME'] . "://" . $_SERVER['HTTP_HOST'],
+            "state" => strtoupper(empty($this->var['regCheck']) ? $this->var['regTy'] : $this->var['regCheck']),
+            "theme" => [
+                "banner" => !empty($this->getWebguiGlobal('display')['banner']),
+                "bannerGradient" => $this->getWebguiGlobal('display')['showBannerGradient'] === 'yes' ?? false,
+                "bgColor" => ($this->getWebguiGlobal('display')['background']) ? '#' . $this->getWebguiGlobal('display')['background'] : '',
+                "descriptionShow" => (!empty($this->getWebguiGlobal('display')['headerdescription']) && $this->getWebguiGlobal('display')['headerdescription'] !== 'no'),
+                "metaColor" => ($this->getWebguiGlobal('display')['headermetacolor'] ?? '') ? '#' . $this->getWebguiGlobal('display')['headermetacolor'] : '',
+                "name" => $this->getWebguiGlobal('display')['theme'],
+                "textColor" => ($this->getWebguiGlobal('display')['header']) ? '#' . $this->getWebguiGlobal('display')['header'] : '',
+            ],
+            "ts" => time(),
+            "uptime" => 1000 * (time() - round(strtok(exec("cat /proc/uptime"), ' '))),
+            "username" => $this->myservers['remote']['username'] ?? '',
+            "wanFQDN" => $this->nginx['NGINX_WANFQDN'] ?? '',
+        ];
+
+        return $serverState;
+    }
+
+}