Merge pull request #1600 from zackspear/master

update os feedback and refactors

emhttp/plugins/dynamix.my.servers/include/state.php

@@ -15,6 +15,7 @@ $webguiGlobals = $GLOBALS;
 $docroot = $docroot ?? $_SERVER['DOCUMENT_ROOT'] ?: '/usr/local/emhttp';
 
 require_once "$docroot/plugins/dynamix.my.servers/include/reboot-details.php";
+require_once "$docroot/plugins/dynamix.plugin.manager/include/UnraidCheck.php";
 /**
  * ServerState class encapsulates server-related information and settings.
  *
@@ -47,7 +48,10 @@ class ServerState
     private $rebootDetails;
     private $caseModel = '';
     private $keyfileBase64UrlSafe = '';
+    private $updateOsCheck;
+    private $updateOsNotificationsEnabled = false;
     private $updateOsResponse;
+    private $updateOsIgnoredReleases = [];
 
     public $myServersFlashCfg = [];
     public $myServersMemoryCfg = [];
@@ -164,10 +168,10 @@ class ServerState
           $this->keyfileBase64UrlSafe = str_replace(['+', '/', '='], ['-', '_', ''], trim($this->keyfileBase64));
         }
 
-        /**
-         * updateOsResponse is provided by the dynamix.plugin.manager/scripts/unraidcheck script saving to /tmp/unraidcheck/result.json
-         */
-        $this->updateOsResponse = @json_decode(@file_get_contents('/tmp/unraidcheck/result.json'), true);
+        $this->updateOsCheck = new UnraidOsCheck();
+        $this->updateOsIgnoredReleases = $this->updateOsCheck->getIgnoredReleases();
+        $this->updateOsNotificationsEnabled = !empty(@$this->getWebguiGlobal('notify')['unraidos']);
+        $this->updateOsResponse = $this->updateOsCheck->getUnraidOSCheckResult();
     }
 
     /**
@@ -249,6 +253,14 @@ class ServerState
             $serverState['combinedKnownOrigins'] = $this->combinedKnownOrigins;
         }
 
+        if ($this->updateOsIgnoredReleases) {
+            $serverState['updateOsIgnoredReleases'] = $this->updateOsIgnoredReleases;
+        }
+
+        if ($this->updateOsNotificationsEnabled) {
+            $serverState['updateOsNotificationsEnabled'] = $this->updateOsNotificationsEnabled;
+        }
+
         if ($this->updateOsResponse) {
             $serverState['updateOsResponse'] = $this->updateOsResponse;
         }

emhttp/plugins/dynamix.my.servers/unraid-components/manifest.json

@@ -1,13 +1,13 @@
 {
   ".nuxt/nuxt-custom-elements/entries/unraid-components.client.css": {
-    "file": "_nuxt/unraid-components.client-b74ef392.css",
+    "file": "_nuxt/unraid-components.client-fad7c220.css",
     "src": ".nuxt/nuxt-custom-elements/entries/unraid-components.client.css"
   },
   ".nuxt/nuxt-custom-elements/entries/unraid-components.client.mjs": {
     "css": [
-      "_nuxt/unraid-components.client-b74ef392.css"
+      "_nuxt/unraid-components.client-fad7c220.css"
     ],
-    "file": "_nuxt/unraid-components.client-b620404a.js",
+    "file": "_nuxt/unraid-components.client-e6cfc5d4.js",
     "isEntry": true,
     "src": ".nuxt/nuxt-custom-elements/entries/unraid-components.client.mjs"
   }

emhttp/plugins/dynamix.plugin.manager/include/UnraidCheck.php

@@ -0,0 +1,266 @@
+<?php
+/* Copyright 2005-2023, Lime Technology
+ * Copyright 2012-2023, Bergware International.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License version 2,
+ * as published by the Free Software Foundation.
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ */
+/**
+ * Abstracting this code into a separate file allows us to use it in multiple places without duplicating code.
+ * 1. unraidcheck script can call this
+ * require_once "$docroot/plugins/dynamix.plugin.manager/include/UnraidCheck.php";
+ * $unraidOsCheck = new UnraidOsCheck();
+ * $unraidOsCheck->checkForUpdate();
+ *
+ * 2. Unraid webgui web components can GET this file with action params to get updates, ignore updates, etc.
+ * - EX: Unraid webgui web components can check for updates via a GET request and receive a response with the json file directly
+ *  - this is useful for the UPC to check for updates and display a model based on the value
+ *  - `/plugins/dynamix.plugin.manager/scripts/unraidcheck.php?json=true`
+ *  - note the json=true query param to receive a json response
+ * 
+ * @param action {'check'|'removeAllIgnored'|'removeIgnoredVersion'|'ignoreVersion'} - the action to perform
+ * @param version {string} - the version to ignore or remove
+ * @param json {string} - if set to true, will return the json response from the external request
+ * @param altUrl {URL} - if set, will use this url instead of the default
+ */
+$docroot ??= ($_SERVER['DOCUMENT_ROOT'] ?: '/usr/local/emhttp');
+require_once "$docroot/webGui/include/Wrappers.php";
+require_once "$docroot/plugins/dynamix.plugin.manager/include/PluginHelpers.php";
+
+class UnraidOsCheck
+{
+    private const BASE_RELEASES_URL = 'https://releases.unraid.net/os';
+    private const JSON_FILE_IGNORED = '/tmp/unraidcheck/ignored.json';
+    private const JSON_FILE_IGNORED_KEY = 'updateOsIgnoredReleases';
+    private const JSON_FILE_RESULT = '/tmp/unraidcheck/result.json';
+    private const PLG_PATH = '/var/log/plugins/unRAIDServer.plg';
+
+    public function __construct()
+    {
+        $isGetRequest = !empty($_SERVER) && isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'GET';
+        $getHasAction = $_GET !== null && !empty($_GET) && isset($_GET['action']);
+
+        if ($isGetRequest && $getHasAction) {
+            $this->handleGetRequestWithActions();
+        }
+    }
+
+    private function handleGetRequestWithActions()
+    {
+        switch ($_GET['action']) {
+            case 'check':
+                $this->checkForUpdate();
+                break;
+
+            case 'removeAllIgnored':
+                $this->removeAllIgnored();
+                break;
+
+            case 'removeIgnoredVersion':
+                if (isset($_GET['version'])) {
+                    $this->removeIgnoredVersion($_GET['version']);
+                }
+                break;
+
+            case 'ignoreVersion':
+                if (isset($_GET['version'])) {
+                    $this->ignoreVersion($_GET['version']);
+                }
+                break;
+
+            default:
+                $this->respondWithError(400, "Unhandled action");
+                break;
+        }
+    }
+
+    public function getUnraidOSCheckResult()
+    {
+        if (file_exists(self::JSON_FILE_RESULT)) {
+            return $this->readJsonFile(self::JSON_FILE_RESULT);
+        }
+    }
+
+    public function getIgnoredReleases()
+    {
+        if (!file_exists(self::JSON_FILE_IGNORED)) {
+            return [];
+        }
+
+        $ignoredData = $this->readJsonFile(self::JSON_FILE_IGNORED);
+
+        if (is_array($ignoredData) && array_key_exists(self::JSON_FILE_IGNORED_KEY, $ignoredData)) {
+            return $ignoredData[self::JSON_FILE_IGNORED_KEY];
+        }
+
+        return [];
+    }
+
+    /** @todo clean up this method to be more extensible */
+    public function checkForUpdate()
+    {
+        // Multi-language support
+        if (!function_exists('_')) {
+            function _($text) {return $text;}
+        }
+
+        extract(parse_plugin_cfg('dynamix', true));
+
+        $var = (array)@parse_ini_file('/var/local/emhttp/var.ini');
+
+        $params  = [];
+        $params['branch']          = plugin('category', self::PLG_PATH, 'stable');
+        $params['current_version'] = plugin('version', self::PLG_PATH) ?: _var($var,'version');
+        if (_var($var,'regExp')) $params['update_exp'] = date('m-d-Y', _var($var,'regExp')*1);
+        $defaultUrl = self::BASE_RELEASES_URL;
+        // pass a param of altUrl to use the provided url instead of the default
+        $parsedAltUrl = (array_key_exists('altUrl',$_GET) && $_GET['altUrl']) ? $_GET['altUrl'] : null;
+        // if $parsedAltUrl pass to params
+        if ($parsedAltUrl) $params['altUrl'] = $parsedAltUrl;
+
+        $urlbase = $parsedAltUrl ?? $defaultUrl;
+        $url     = $urlbase.'?'.http_build_query($params);
+
+        $response = "";
+        // use error handler to convert warnings from file_get_contents to errors so they can be captured
+        function warning_as_error($severity, $message, $filename, $lineno) {
+            throw new ErrorException($message, 0, $severity, $filename, $lineno);
+        }
+        set_error_handler("warning_as_error");
+        try {
+            $response = file_get_contents($url);
+        } catch (Exception $e) {
+            $response = json_encode(array('error' => $e->getMessage()), JSON_PRETTY_PRINT);
+        }
+        restore_error_handler();
+
+        $responseMutated = json_decode($response, true);
+        if (!$responseMutated) {
+            $response = json_encode(array('error' => 'Invalid response from '.$urlbase), JSON_PRETTY_PRINT);
+            $responseMutated = json_decode($response, true);
+        }
+
+        // add params that were used for debugging
+        $responseMutated['params'] = $params;
+
+        // store locally for UPC to access
+        $this->writeJsonFile(self::JSON_FILE_RESULT, $responseMutated);
+
+        // if we have a query param of json=true then just output the json
+        if (array_key_exists('json',$_GET) && $_GET['json']) {
+            header('Content-Type: application/json');
+            echo $response;
+            exit(0);
+        }
+
+        // send notification if a newer version is available and not ignored
+        $isNewerVersion = array_key_exists('isNewer',$responseMutated) ? $responseMutated['isNewer'] : false;
+        $isReleaseIgnored = in_array($responseMutated['version'], $this->getIgnoredReleases());
+
+        if ($responseMutated && $isNewerVersion && !$isReleaseIgnored) {
+            $output  = _var($notify,'plugin');
+            $server  = strtoupper(_var($var,'NAME','server'));
+            $newver = (array_key_exists('version',$responseMutated) && $responseMutated['version']) ? $responseMutated['version'] : 'unknown';
+            $script  = '/usr/local/emhttp/webGui/scripts/notify';
+            exec("$script -e ".escapeshellarg("System - Unraid [$newver]")." -s ".escapeshellarg("Notice [$server] - Version update $newver")." -d ".escapeshellarg("A new version of Unraid is available")." -i ".escapeshellarg("normal $output")." -l '/Tools/Update' -x");
+        }
+
+        exit(0);
+    }
+
+    private function removeAllIgnored()
+    {
+        if (file_exists(self::JSON_FILE_IGNORED)) {
+            $this->deleteJsonFile(self::JSON_FILE_IGNORED);
+            $this->respondWithSuccess([]);
+        }
+        // fail silently if file doesn't exist
+    }
+
+    private function removeIgnoredVersion($removeVersion)
+    {
+        if ($this->isValidSemVerFormat($removeVersion)) {
+            if (file_exists(self::JSON_FILE_IGNORED)) {
+                $existingData = $this->readJsonFile(self::JSON_FILE_IGNORED);
+
+                if (isset($existingData[self::JSON_FILE_IGNORED_KEY])) {
+                    $existingData[self::JSON_FILE_IGNORED_KEY] = array_diff($existingData[self::JSON_FILE_IGNORED_KEY], [$removeVersion]);
+                    $this->writeJsonFile(self::JSON_FILE_IGNORED, $existingData);
+                    $this->respondWithSuccess($existingData);
+                } else {
+                    $this->respondWithError(400, "No versions to remove in the JSON file");
+                }
+            } else {
+                $this->respondWithError(400, "No JSON file found");
+            }
+        } else {
+            $this->respondWithError(400, "Invalid removeVersion format");
+        }
+    }
+
+    private function ignoreVersion($version)
+    {
+        if ($this->isValidSemVerFormat($version)) {
+            $newData = [$this::JSON_FILE_IGNORED_KEY => [$version]];
+            $existingData = file_exists(self::JSON_FILE_IGNORED) ? $this->readJsonFile(self::JSON_FILE_IGNORED) : [];
+
+            if (isset($existingData[self::JSON_FILE_IGNORED_KEY])) {
+                $existingData[self::JSON_FILE_IGNORED_KEY][] = $version;
+            } else {
+                $existingData[self::JSON_FILE_IGNORED_KEY] = [$version];
+            }
+
+            $this->writeJsonFile(self::JSON_FILE_IGNORED, $existingData);
+            $this->respondWithSuccess($existingData);
+        } else {
+            $this->respondWithError(400, "Invalid version format");
+        }
+    }
+
+    private function isValidSemVerFormat($version)
+    {
+        return preg_match('/^\d+\.\d+(\.\d+)?(-.+)?$/', $version);
+    }
+
+    private function readJsonFile($file)
+    {
+        return @json_decode(@file_get_contents($file), true) ?? [];
+    }
+
+    private function writeJsonFile($file, $data)
+    {
+        if (!is_dir(dirname($file))) { // prevents errors when directory doesn't exist
+            mkdir(dirname($file));
+        }
+        file_put_contents($file, json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
+    }
+
+    private function deleteJsonFile($file)
+    {
+        unlink($file);
+    }
+
+    private function respondWithError($statusCode, $message)
+    {
+        http_response_code($statusCode);
+        echo $message;
+    }
+
+    private function respondWithSuccess($data)
+    {
+        http_response_code(200);
+        header('Content-Type: application/json');
+        echo json_encode($data, JSON_PRETTY_PRINT);
+    }
+}
+
+// Instantiate and handle the request for GET requests with actions – vars are duplicated here for multi-use of this file
+$isGetRequest = !empty($_SERVER) && isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'GET';
+$getHasAction = $_GET !== null && !empty($_GET) && isset($_GET['action']);
+if ($isGetRequest && $getHasAction) {
+    new UnraidOsCheck();
+}

emhttp/plugins/dynamix.plugin.manager/scripts/unraidcheck

@@ -13,60 +13,7 @@
 ?>
 <?
 $docroot ??= ($_SERVER['DOCUMENT_ROOT'] ?: '/usr/local/emhttp');
-require_once "$docroot/webGui/include/Wrappers.php";
-require_once "$docroot/plugins/dynamix.plugin.manager/include/PluginHelpers.php";
+require_once "$docroot/plugins/dynamix.plugin.manager/include/UnraidCheck.php";
 
-// Multi-language support
-if (!function_exists('_')) {
-  function _($text) {return $text;}
-}
-
-extract(parse_plugin_cfg('dynamix', true));
-
-$var     = (array)@parse_ini_file('/var/local/emhttp/var.ini');
-$script  = "$docroot/webGui/scripts/notify";
-$server  = strtoupper(_var($var,'NAME','server'));
-$output  = _var($notify,'plugin');
-$plg     = '/var/log/plugins/unRAIDServer.plg';
-
-$params  = [];
-$params['branch']          = plugin('category', $plg, 'stable');
-$params['current_version'] = plugin('version', $plg) ?: _var($var,'version');
-if (_var($var,'regExp')) $params['update_exp'] = date('m-d-Y', _var($var,'regExp')*1);
-$urlbase = 'https://releases.unraid.net/os';
-$url     = $urlbase.'?'.http_build_query($params);
-
-$response = "";
-// use error handler to convert warnings from file_get_contents to errors so they can be captured
-function warning_as_error($severity, $message, $filename, $lineno) {
-  throw new ErrorException($message, 0, $severity, $filename, $lineno);
-}
-set_error_handler("warning_as_error");
-try {
-  $response = file_get_contents($url);
-} catch (Exception $e) {
-  $response = json_encode(array('error' => $e->getMessage()), JSON_PRETTY_PRINT);
-}
-restore_error_handler();
-
-$json = json_decode($response, true);
-if (!$json) {
-  $response = json_encode(array('error' => 'Invalid response from '.$urlbase), JSON_PRETTY_PRINT);
-  $json = json_decode($response, true);
-}
-
-// add params that were sent to $urlbase
-$json['params']  = $params;
-
-// store locally for UPC to access
-$file = '/tmp/unraidcheck/result.json';
-if (!is_dir(dirname($file))) mkdir(dirname($file));
-file_put_contents($file, json_encode($json, JSON_PRETTY_PRINT));
-
-// send notification if a newer version is available
-if ($json && array_key_exists('isNewer',$json) && $json['isNewer']) {
-  $newver = (array_key_exists('version',$json) && $json['version']) ? $json['version'] : 'unknown';
-  exec("$script -e ".escapeshellarg("System - Unraid [$newver]")." -s ".escapeshellarg("Notice [$server] - Version update $newver")." -d ".escapeshellarg("A new version of Unraid is available")." -i ".escapeshellarg("normal $output")." -l '/Tools/Update' -x");
-}
-exit(0);
-?>
+$unraidOsCheck = new UnraidOsCheck();
+$unraidOsCheck->checkForUpdate();