Fixing configuration migration issues (#1855)

* Show effectsconfigurator menu entry, only if effectengine is available

* Update schemas to accept empty arrays

* Correct JSON processing

* JSON getconfig API - allow filter to exclude all elements via "null" value

* JSON API getconfig, exclude global and instances on higher level too

* Stop WebServer before JSON API to avoid blocking calls by UI

* Correct command scope

Author: Lord-Grey

assets/webconfig/js/ui_utils.js

@@ -255,7 +255,12 @@ function updateUiOnInstance(inst) {
 
     // Show menue items according to instance's running state
     if (isInstanceRunning(window.currentHyperionInstance)) {
-      $("#MenuItemRemoteControl, #MenuItemEffectsConfig, #NavMenuWizards, #btn_open_ledsim").show();
+      $("#MenuItemRemoteControl, #NavMenuWizards, #btn_open_ledsim").show();
+      
+      //Show effectsconfigurator menu entry, only if effectengine is available
+      if (jQuery.inArray("effectengine", window.serverInfo.services) !== -1) {
+        $("#MenuItemEffectsConfig").show();
+      }
 
       const isMediaStreamingSupported = getStorage('mediaStreamingSupported');
       if (isMediaStreamingSupported) {

doc/development/JSON-API _Commands_Overview.md

@@ -45,7 +45,7 @@ _http/s Support_
 | clear          |                         | Yes           | Multi        | Yes               | Yes            |
 | clearall       |                         | Yes           | Multi        | Yes               | Yes            |
 | color          |                         | Yes           | Multi        | Yes               | Yes            |
-| componentstate |                         | Yes           | Multi        | Yes               | Yes            |
+| componentstate |                         | Yes           | No or Multi  | Yes               | Yes            |
 | config         | getconfig               | Admin         | No           | No                | Yes            |
 | config         | getschema               | Admin         | No           | No                | Yes            |
 | config         | reload                  | Admin         | No           | No                | Yes            |

include/api/JsonApiCommand.h

@@ -309,7 +309,7 @@ class ApiCommandRegister {
 			{ {"clear", ""},                             { Command::Clear,          SubCommand::Empty,                   Authorization::Yes,    InstanceCmd::Multi,        InstanceCmd::MustRun_Yes,    NoListenerCmd::Yes } },
 			{ {"clearall", ""},                          { Command::ClearAll,       SubCommand::Empty,                   Authorization::Yes,    InstanceCmd::Multi,        InstanceCmd::MustRun_Yes,    NoListenerCmd::Yes } },
 			{ {"color", ""},                             { Command::Color,          SubCommand::Empty,                   Authorization::Yes,    InstanceCmd::Multi,        InstanceCmd::MustRun_Yes,    NoListenerCmd::Yes } },
-			{ {"componentstate", ""},                    { Command::ComponentState, SubCommand::Empty,                   Authorization::Yes,    InstanceCmd::Multi,        InstanceCmd::MustRun_Yes,    NoListenerCmd::Yes } },
+			{ {"componentstate", ""},                    { Command::ComponentState, SubCommand::Empty,                   Authorization::Yes,    InstanceCmd::No_or_Multi,  InstanceCmd::MustRun_Yes,    NoListenerCmd::Yes } },
 			{ {"config", "getconfig"},                   { Command::Config,         SubCommand::GetConfig,               Authorization::Admin,  InstanceCmd::No,           InstanceCmd::MustRun_No,     NoListenerCmd::Yes } },
 			{ {"config", "getschema"},                   { Command::Config,         SubCommand::GetSchema,               Authorization::Admin,  InstanceCmd::No,           InstanceCmd::MustRun_No,     NoListenerCmd::Yes } },
 			{ {"config", "reload"},                      { Command::Config,         SubCommand::Reload,                  Authorization::Admin,  InstanceCmd::No,           InstanceCmd::MustRun_No,     NoListenerCmd::Yes } },

include/db/SettingsTable.h

@@ -12,7 +12,7 @@
 
 #include <QJsonDocument>
 
-const int GLOABL_INSTANCE_ID = std::numeric_limits<quint8>::max();;
+const int NO_INSTANCE_ID = std::numeric_limits<quint8>::max();;
 const char DEFAULT_CONFIG_VERSION[] = "2.0.0-alpha.8";
 
 ///
@@ -23,7 +23,7 @@ class SettingsTable : public DBManager
 
 public:
 	/// construct wrapper with settings table
-	SettingsTable(quint8 instance = GLOABL_INSTANCE_ID, QObject* parent = nullptr);
+	SettingsTable(quint8 instance = NO_INSTANCE_ID, QObject* parent = nullptr);
 
 	///
 	/// @brief      Create or update a settings record

include/hyperion/SettingsManager.h

@@ -23,7 +23,7 @@ class SettingsManager : public QObject
 	/// @params  instance   Instance index of HyperionInstanceManager
 	/// @params  parent    The parent hyperion instance
 	///
-	SettingsManager(quint8 instance = GLOABL_INSTANCE_ID, QObject* parent = nullptr);
+	SettingsManager(quint8 instance = NO_INSTANCE_ID, QObject* parent = nullptr);
 
 	///
 	/// @brief Save a complete JSON configuration