Refactor Settings DB and Handling (hyperion-project#1786)

* Refactor config API * Corrections * Test Qt 6.8 * Revert "Test Qt 6.8" This reverts commit eceebec. * Corrections 2 * Update Changelog * Add configFilter element for getconfig call * Do not create errors for DB updates when in read-only mode * Have configuration migration and validation before Hyperion starts * Correct Tests * Corrections * Add migration items * Correct windows build * Ensure that first instance as default one exists * Remove dependency between AuthManager and SSDPHandler * Correct typos * Address CodeQL findings * Replace CamkeSettings by Presets and provide debug scenarios
Lord-Grey · Sep 30, 2024 · ecceb4e · ecceb4e
1 parent aed4abc
commit ecceb4e
Show file tree

Hide file tree

Showing 88 changed files with 4,378 additions and 2,443 deletions.
diff --git a/.gitignore b/.gitignore
@@ -39,3 +39,15 @@ NULL
 
 # Docker deploy folder
 deploy/*
+
+# ccache/buildcache
+.*cache/
+
+# release-deps/debug-deps
+*-deps/
+
+# User defined CMake preset file.
+CMakeUserPresets.json
+
+#Configurations created under config for testing
+/configs
diff --git a/.version b/.version
@@ -1 +1 @@
-2.0.17-beta.1
+2.0.17-beta.2
diff --git a/.vs/launch.vs.json b/.vs/launch.vs.json
@@ -6,12 +6,42 @@
       "type": "default",
       "project": "CMakeLists.txt",
       "projectTarget": "hyperiond.exe (bin\\hyperiond.exe)",
-      "name": "Run hyperion with debug option and external console",
+      "name": "Run Hyperion"
+    },
+    {
+      "type": "default",
+      "project": "CMakeLists.txt",
+      "projectTarget": "hyperiond.exe (bin\\hyperiond.exe)",
+      "name": "Run hyperion with debug logging and external console",
       "args": [
         "-d",
         "-c"
       ],
       "externalConsole": true
+    },
+    {
+      "type": "default",
+      "project": "CMakeLists.txt",
+      "projectTarget": "hyperiond.exe (bin\\hyperiond.exe)",
+      "name": "Run hyperion with verbose logging with external console",
+      "args": [
+        "-v",
+        "-c"
+      ],
+      "externalConsole": true
+    },
+    {
+      "type": "default",
+      "project": "CMakeLists.txt",
+      "projectTarget": "hyperiond.exe (bin\\hyperiond.exe)",
+      "name": "Run hyperion with debug logging and a test configuration DB",
+      "args": [
+        "-d",
+        "-c",
+        "-u",
+        "${workspaceRoot}\\configs\\testConfig"
+      ],
+      "externalConsole": true
     }
   ]
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 **JSON-API**
 - Align JSON subscription update elements. `ledcolors-imagestream-update, ledcolors-ledstream-update, logmsg-update` now return data via `data` and not `result
+- Global global configuration elements are now separated form instance specific ones
 
 ### Added
 
@@ -18,6 +19,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Support gaps on Matrix Layout (#1696)
 - Windows: Added a new grabber that uses the DXGI DDA (Desktop Duplication API). This has much better performance than the DX grabber as it does more of its work on the GPU.
 
+- Support to import, export and backup Hyperion's full configuration via the UI, JSON-API and commandline (`--importConfig, --exportConfig`) (#804)
+- Allow to force starting Hyperion in read-only mode (`--readonlyMode`)
+- JSON-API: Support to query for a dedicated set of configuration items for a set of instances
+- JSON-API: Support to save a dedicated set of configuration items for a set of instances
+
 **JSON-API**
 - New subscription support for event updates, i.e. `Suspend, Resume, Idle, idleResume, Restart, Quit`.
 - Support direct or multiple instance addressing via single requests (#809)
@@ -33,12 +39,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixed: Kodi Color Calibration, Refactor Wizards (#1674)
 - Fixed: Token Dialog not closing
 - Fixed: Philip Hue APIv2 support without Entertainment group defined (#1742)
+- Refactored: Database access layer
+- Refactored: Hyperion's configuration database is validated before start-up (and migrated, if required)
 
 **JSON-API**
 - Refactored JSON-API to ensure consistent authorization behaviour across sessions and single requests with token authorization.
 - Provide additional error details with API responses, esp. on JSON parsing, validation or token errors.
 - Generate random TANs for every API request from the Hyperion UI
 - Fixed: Handling of IP4 addresses wrapped in IPv6 for external network connections-
+- Fixed: Local Admin API Authentication rejects valid tokens (#1251)
 
 ### Removed
 

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -20,11 +20,10 @@ PROJECT(hyperion)
 include (${CMAKE_CURRENT_SOURCE_DIR}/cmake/version.cmake)
 file (STRINGS ".version" HYPERION_VERSION)
 SetVersionNumber(HYPERION ${HYPERION_VERSION})
-set(DEFAULT_JSON_CONFIG_FILE ${CMAKE_CURRENT_SOURCE_DIR}/config/hyperion.config.json.default)
+set(DEFAULT_JSON_CONFIG_FILE ${CMAKE_CURRENT_SOURCE_DIR}/settings/hyperion.settings.json.default)
 file(READ ${DEFAULT_JSON_CONFIG_FILE} DEFAULT_JSON_CONFIG_VAR)
 string(REPLACE "configVersionValue" ${HYPERION_VERSION} DEFAULT_JSON_CONFIG_VAR "${DEFAULT_JSON_CONFIG_VAR}")
-string(REPLACE "previousVersionValue" ${HYPERION_VERSION} DEFAULT_JSON_CONFIG_VAR "${DEFAULT_JSON_CONFIG_VAR}")
-file(WRITE ${CMAKE_BINARY_DIR}/config/hyperion.config.json.default "${DEFAULT_JSON_CONFIG_VAR}")
+file(WRITE ${CMAKE_BINARY_DIR}/settings/hyperion.settings.json.default "${DEFAULT_JSON_CONFIG_VAR}")
 
 # Instruct CMake to run moc automatically when needed.
 set(CMAKE_AUTOMOC ON)
@@ -227,7 +226,7 @@ message(STATUS "HYPERION_LIGHT = ${HYPERION_LIGHT}")
 
 if(HYPERION_LIGHT)
 	message(STATUS "HYPERION_LIGHT: Hyperion is build with a reduced set of functionality.")
-	# Disable Grabbers
+	# Disable Screen/Video Grabbers
 	SET ( DEFAULT_AMLOGIC                     OFF )
 	SET ( DEFAULT_DISPMANX                    OFF )
 	SET ( DEFAULT_DX                          OFF )
@@ -240,22 +239,37 @@ if(HYPERION_LIGHT)
 	SET ( DEFAULT_X11                         OFF )
 	SET ( DEFAULT_XCB                         OFF )
 
+	# Disable Audio Grabbers
 	SET ( DEFAULT_AUDIO                       OFF )
 
+	# LED-Devices
+	#SET ( DEFAULT_DEV_NETWORK                 OFF )
+	#SET ( DEFAULT_DEV_FTDI                    OFF )
+	#SET ( DEFAULT_DEV_SERIAL                  OFF )
+	#SET ( DEFAULT_DEV_SPI                     OFF )
+	#SET ( DEFAULT_DEV_TINKERFORGE             OFF )
+	#SET ( DEFAULT_DEV_USB_HID                 OFF )
+	#SET ( DEFAULT_DEV_WS281XPWM               OFF )
+
 	# Disable Input Servers
-	set(DEFAULT_BOBLIGHT_SERVER             OFF)
-	set(DEFAULT_CEC                         OFF)
-	set(DEFAULT_FLATBUF_SERVER              OFF)
-	set(DEFAULT_PROTOBUF_SERVER             OFF)
+	SET ( DEFAULT_BOBLIGHT_SERVER             OFF )
+	SET ( DEFAULT_CEC                         OFF )
+	SET ( DEFAULT_FLATBUF_SERVER              OFF )
+	SET ( DEFAULT_PROTOBUF_SERVER             OFF )
 
 	# Disable Output Connectors
-	set(DEFAULT_FORWARDER                   OFF)
-	set(DEFAULT_FLATBUF_CONNECT             OFF)
+	SET ( DEFAULT_FORWARDER                   OFF )
+	SET ( DEFAULT_FLATBUF_CONNECT             OFF )
 
 	# Disable Services
-	set(DEFAULT_EFFECTENGINE                OFF)
+	SET ( DEFAULT_EFFECTENGINE                OFF )
+	#SET ( DEFAULT_EXPERIMENTAL                OFF )
+	#SET ( DEFAULT_MDNS                        OFF )
+	#SET ( DEFAULT_REMOTE_CTL                  OFF )
+
+	#SET ( ENABLE_JSONCHECKS                    OFF )
+	#SET ( ENABLE_DEPLOY_DEPENDENCIES          OFF )
 endif()
-
 message(STATUS "Grabber options:")
 
 addIndent(" - ")
@@ -430,7 +444,7 @@ endif()
 if(ENABLE_JSONCHECKS)
 	# check all json files
 	file (GLOB_RECURSE HYPERION_SCHEMAS RELATIVE ${CMAKE_SOURCE_DIR} ${CMAKE_SOURCE_DIR}/libsrc/*schema*.json)
-	set(JSON_FILES ${CMAKE_BINARY_DIR}/config/hyperion.config.json.default	${HYPERION_SCHEMAS})
+	set(JSON_FILES ${CMAKE_BINARY_DIR}/settings/hyperion.settings.json.default	${HYPERION_SCHEMAS})
 
 	execute_process (
 		COMMAND ${PYTHON_EXECUTABLE} test/jsonchecks/checkjson.py ${JSON_FILES}
@@ -453,7 +467,7 @@ if(ENABLE_JSONCHECKS)
 	endif()
 
 	execute_process (
-		COMMAND ${PYTHON_EXECUTABLE} test/jsonchecks/checkschema.py ${CMAKE_BINARY_DIR}/config/hyperion.config.json.default libsrc/hyperion/hyperion.schema.json
+		COMMAND ${PYTHON_EXECUTABLE} test/jsonchecks/checkschema.py ${CMAKE_BINARY_DIR}/settings/hyperion.settings.json.default libsrc/hyperion/schema/schema-settings-default.json
 		WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
 		RESULT_VARIABLE CHECK_CONFIG_FAILED
 	)