diff --git a/.github/workflows/qt5_6.yml b/.github/workflows/qt5_6.yml index 367d05061..79390fd81 100644 --- a/.github/workflows/qt5_6.yml +++ b/.github/workflows/qt5_6.yml @@ -146,15 +146,25 @@ jobs: - name: 👷 Build ${{ env.HINT }} shell: bash run: | - # Remove once issue with hombrew cache action is fixed + # Remove once issue with Homebrew cache action is fixed brew reinstall --formula cmake + # Build cmake --preset macos-${{ env.BUILD_TYPE }} ${{ steps.dependencies.outputs.cmakeArgs }} cmake --build --preset macos-${{ env.BUILD_TYPE }} # CPack workaround for macOS 13 - echo killing...; sudo pkill -9 XProtect >/dev/null || true; - echo waiting...; while pgrep XProtect; do sleep 3; done; - cd build; cpack + attempt=0 + max_attempts=5 + while [ $attempt -lt $max_attempts ]; do + if cd build && cpack; then + echo "Package created successfully" + break + else + echo "Failed to create package, retrying..." + sleep 10 + fi + attempt=$((attempt + 1)) + done env: BUILD_TYPE: ${{ inputs.event_name == 'pull_request' && 'debug' || 'release' }} HINT: ${{ steps.dependencies.outputs.cmakeArgs != '' && '(with pre-built dependencies)' || '(full build)' }} diff --git a/.gitignore b/.gitignore index 5f263fc45..e8cde0dfc 100644 --- a/.gitignore +++ b/.gitignore @@ -48,3 +48,7 @@ CMakeUserPresets.json #Configurations created under config for testing /configs + +#Config database & backups created for testing +HyperionBackup_* +hyperion.db diff --git a/.version b/.version index 0f238926d..d123e8fe8 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -2.0.17-beta.2 +2.0.17-beta.3 diff --git a/CHANGELOG.md b/CHANGELOG.md index 6d6650a4a..1ce2db672 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,23 +19,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Support gaps on Matrix Layout (#1696) - Support a configurable grabber inactive detection time interval (#1740) - 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 freely select source and target instances to be used by forwarder - 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: Limit update emission frequency: Images (25Hz), raw LED-Colors (40Hz) & LED-Device data (200Hz) - Effects: Limit the maximum update rate to 200Hz +- Systray: Support multiple instances +- UI: Validate that key ports do not overlap across editors and pages **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) - Support of `serverinfo` subcommands: `getInfo, subscribe, unsubscribe, getSubscriptions, getSubscriptionCommands` - [Overview](https://github.com/hyperion-project/hyperion.ng/blob/API_Auth/doc/development/JSON-API%20_Commands_Overview.md) of API commands and subscription updates +- Support to query for a dedicated set of configuration items for a set of instances +- Support to save a dedicated set of configuration items for a set of instances +- Limit update emission frequency: Images (25Hz), raw LED-Colors (40Hz) & LED-Device data (200Hz) - Support for requesting instance-data via JSON-API. Implemented requesting the current image in different formats or led colors. ### Changed +- Removed hard dependency on the first instance. All instances can now be freely created/removed, started or stopped - Fixed: Cross Site Scripting Vulnerability (CVE-2024-4174, CVE-2024-4175) - Fixed: hyperion-v4l2 taking screenshot failed (#1722) - Nanoleaf: Support new devices and do not restore ExtControl state @@ -46,17 +49,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Refactored: Database access layer - Refactored: Hyperion's configuration database is validated before start-up (and migrated, if required) - Refactored: Python to enable parallel effect processing under Python 3.12 +- Refactored: Forwarder +- Refactored: Flatbuffer connection- and client handling +- Refactored: Decouple Effect definitions from Instance +- Refactored: Decouple WebServer and SSDPHandler +- Refactored: Corrected thread affinity across various classes +- Refactored: Improved code resilience and error handling +- Standalone grabber do not capture screens when no connection to remote host - Fixed: Python 3.12 crashes (#1747) - osX Grabber: Use ScreenCaptureKit under macOS 15 and above - Removed maximum LED number constraint from Matrix layout schema which was not synced with the UI behaviour (#1804) - Fixed bespoke WebSocket implementation by using of QWebSockets (#1816, #1448, #1247, #1130) +- Fixed mDNS Browser deadlock, plus run in own thread now +- Fixed that LED Buffer and Layout might get out of sync. +- Fixed Screen capture error (#1824) +- Fixed Provide custom forwarding targets is not possible (#1713) **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- +- Configuration requests do not any longer require a running instance +- Fixed: Handling of IP4 addresses wrapped in IPv6 for external network connections - Fixed: Local Admin API Authentication rejects valid tokens (#1251) +- Fixed: Create a proper API response, when Effects are not part of a build ### Removed diff --git a/CMakePresets.json b/CMakePresets.json index fb2ff8b42..5a4fbe6d3 100644 --- a/CMakePresets.json +++ b/CMakePresets.json @@ -99,9 +99,17 @@ } }, { - "name": "clang", + "name": "ninja-base", "hidden": true, "generator": "Ninja", + "cacheVariables": { + "CMAKE_EXPORT_COMPILE_COMMANDS": "ON" + } + }, + { + "name": "clang", + "hidden": true, + "inherits": [ "ninja-base" ], "cacheVariables": { "CMAKE_C_COMPILER": "/usr/bin/clang", "CMAKE_CXX_COMPILER": "/usr/bin/clang++" @@ -110,7 +118,7 @@ { "name": "msvc", "hidden": true, - "generator": "Ninja", + "inherits": [ "ninja-base" ], "cacheVariables": { "CMAKE_C_COMPILER": "cl.exe", "CMAKE_CXX_COMPILER": "cl.exe" @@ -119,7 +127,7 @@ { "name": "gcc", "hidden": true, - "generator": "Ninja", + "inherits": [ "ninja-base" ], "cacheVariables": { "CMAKE_C_COMPILER": "/usr/bin/gcc", "CMAKE_CXX_COMPILER": "/usr/bin/g++" diff --git a/LICENSE b/LICENSE index 7f7a5bff5..cac427cec 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2014-2024 Hyperion Project +Copyright (c) 2014-2025 Hyperion Project Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/assets/webconfig/content/effects_configurator.html b/assets/webconfig/content/effects_configurator.html index 05396e620..002717d3f 100644 --- a/assets/webconfig/content/effects_configurator.html +++ b/assets/webconfig/content/effects_configurator.html @@ -17,7 +17,7 @@

-
+
@@ -44,7 +44,7 @@

+
@@ -52,7 +52,7 @@

- +

diff --git a/assets/webconfig/content/remote.html b/assets/webconfig/content/remote.html index 2d5a66fb8..79db2c15c 100644 --- a/assets/webconfig/content/remote.html +++ b/assets/webconfig/content/remote.html @@ -39,7 +39,7 @@

Colors/Effects
- +
@@ -66,9 +66,18 @@

+

diff --git a/assets/webconfig/i18n/en.json b/assets/webconfig/i18n/en.json index a6310652e..e834508b1 100644 --- a/assets/webconfig/i18n/en.json +++ b/assets/webconfig/i18n/en.json @@ -263,8 +263,8 @@ "edt_conf_action_record_validation_error": "The same event can trigger only one action. Clean up Actions $1", "edt_conf_audio_device_expl": "Selected audio input device", "edt_conf_audio_device_title": "Audio Device", - "edt_conf_audio_effects_expl": "Select an effect on how the audio signal is transformed to", - "edt_conf_audio_effects_title": "Audio Effects", + "edt_conf_audio_effects_expl": "Select an effect on how the audio signal is transformed to", + "edt_conf_audio_effects_title": "Audio Effects", "edt_conf_audio_effect_enum_vumeter": "VU-Meter", "edt_conf_audio_effect_hotcolor_expl": "Hot Color", "edt_conf_audio_effect_hotcolor_title": "Hot Color", @@ -433,9 +433,9 @@ "edt_conf_enum_udp_ddp": "DDP", "edt_conf_enum_udp_raw": "RAW", "edt_conf_enum_unicolor_mean": "Mean Color Image - applied to all LEDs", - "edt_conf_fbs_heading_title": "Flatbuffers Server", - "edt_conf_fbs_timeout_expl": "If no data is received for the given period, the component will be (soft) disabled.", - "edt_conf_fbs_timeout_title": "Timeout", + "edt_conf_flatbufServer_heading_title": "Flatbuffers Server", + "edt_conf_flatbufServer_timeout_expl": "If no data is received for the given period, the component will be (soft) disabled.", + "edt_conf_flatbufServer_timeout_title": "Timeout", "edt_conf_fg_display_expl": "Select which desktop should be captured (multi monitor setup)", "edt_conf_fg_display_title": "Display", "edt_conf_fg_frequency_Hz_expl": "How fast new pictures are captured, i.e. it is the sampling rate. Note: The video might be played at a higher or lower frame rate.", @@ -458,20 +458,28 @@ "edt_conf_fge_heading_title": "Boot Effect/Color", "edt_conf_fge_type_expl": "Choose between a color or effect.", "edt_conf_fge_type_title": "Type", - "edt_conf_fw_flat_expl": "One flatbuffer target per configuration item", - "edt_conf_fw_flat_itemtitle": "flatbuffer target", - "edt_conf_fw_flat_services_discovered_expl": "Hyperion servers discovered providing flatbuffer services", - "edt_conf_fw_flat_services_discovered_title": "Flatbuffer targets discovered", - "edt_conf_fw_flat_title": "List of flatbuffer targets", - "edt_conf_fw_heading_title": "Forwarder", - "edt_conf_fw_json_expl": "One JSON target per configuration item", - "edt_conf_fw_json_itemtitle": "JSON target", - "edt_conf_fw_json_services_discovered_expl": "Hyperion servers discovered providing JSON-API services", - "edt_conf_fw_json_services_discovered_title": "JSON targets discovered", - "edt_conf_fw_json_title": "List of JSON targets", - "edt_conf_fw_remote_service_discovered_none": "No remote services discovered", - "edt_conf_fw_service_name_expl": "Name of the service provider", - "edt_conf_fw_service_name_title": "Service name", + "edt_conf_forwarder_flat_expl": "One flatbuffer target per configuration item", + "edt_conf_forwarder_flat_itemtitle": "flatbuffer target", + "edt_conf_forwarder_flat_services_discovered_expl": "Hyperion servers discovered providing flatbuffer services", + "edt_conf_forwarder_flat_services_discovered_title": "Flatbuffer targets discovered", + "edt_conf_forwarder_flat_title": "List of flatbuffer targets", + "edt_conf_forwarder_heading_title": "Forwarder", + "edt_conf_forwarder_instance_expl": "Instance that will be forwarded", + "edt_conf_forwarder_instance_title": "Forwarding instance", + "edt_conf_forwarder_instance_title_info": "Select the instance which content will be forwarded", + "edt_conf_forwarder_json_expl": "One JSON target per configuration item", + "edt_conf_forwarder_json_itemtitle": "JSON target", + "edt_conf_forwarder_json_services_discovered_expl": "Hyperion servers discovered providing JSON-API services", + "edt_conf_forwarder_json_services_discovered_title": "JSON targets discovered", + "edt_conf_forwarder_json_title": "List of JSON targets", + "edt_conf_forwarder_no_instance_configured_title": "No instance(s) currently configured", + "edt_conf_forwarder_remote_service_discovered_none": "No remote services discovered", + "edt_conf_forwarder_service_name_expl": "Name of the service provider", + "edt_conf_forwarder_service_name_title": "Service name", + "edt_conf_forwarder_target_instanceID_expl": "Remote instance ID the forwardeding request should be applied to. For Instance ID = 255, the request will be applied to all instances", + "edt_conf_forwarder_target_instanceID_title": "Instance-ID", + "edt_conf_forwarder_target_instances_expl": "List of remote instance IDs the forwarding request should be applied to. For Instance ID = 255, the request will be applied to all instances", + "edt_conf_forwarder_target_instances_title": "Remote instances", "edt_conf_gen_configVersion_title": "Configuration version", "edt_conf_gen_heading_title": "General Settings", "edt_conf_gen_name_expl": "A user defined name which is used to detect Hyperion. (Helpful with more than one Hyperion instance)", @@ -504,30 +512,31 @@ "edt_conf_instCapture_heading_title": "Capture Devices", "edt_conf_instCapture_timeout_expl": "If no data are received for the given period, the component will be cleared as an input source.", "edt_conf_instCapture_timeout_title": "Input timeout", - "edt_conf_js_heading_title": "JSON Server", + "edt_conf_jsonServer_heading_title": "JSON Server", "edt_conf_log_heading_title": "Logging", "edt_conf_log_level_expl": "Depending on loglevel you see less or more messages in your log.", "edt_conf_log_level_title": "Log-Level", - "edt_conf_net_apiAuth_expl": "Enforce all applications that use the Hyperion API to authenticate themself against Hyperion (Exception: see \"Local API Authentication\"). Higher security, as you control the access and revoke it at any time.", - "edt_conf_net_heading_title": "Network", - "edt_conf_net_internetAccessAPI_expl": "Allow access to the Hyperion API/Web Interface from the Internet. Disable for increased security.", - "edt_conf_net_internetAccessAPI_title": "Internet API Access", - "edt_conf_net_ipWhitelist_expl": "Define whitelisted IP addresses from which API requests from the Internet are allowed. All other external connections will be denied.", - "edt_conf_net_ipWhitelist_title": "Whitelisted IP addresses", - "edt_conf_net_ip_itemtitle": "IP", - "edt_conf_net_localApiAuth_expl": "When disabled, API authorisation via password or token is not required for local connections. The exception is administrative commands.", - "edt_conf_net_localApiAuth_title": "Local API Authentication", - "edt_conf_net_restirctedInternetAccessAPI_expl": "You can restrict API requests over the Internet to only those IP addresses on the whitelist.", - "edt_conf_net_restirctedInternetAccessAPI_title": "Restrict to IP addresses", + "edt_conf_network_apiAuth_expl": "Enforce all applications that use the Hyperion API to authenticate themselves against Hyperion (Exception: see \"Local API Authentication\"). Higher security, as you control the access and revoke it at any time.", + "edt_conf_network_heading_title": "Network", + "edt_conf_network_internetAccessAPI_expl": "Allow access to the Hyperion API/Web Interface from the Internet. Disable for increased security.", + "edt_conf_network_internetAccessAPI_title": "Internet API Access", + "edt_conf_network_ipWhitelist_expl": "Define whitelisted IP addresses from which API requests from the Internet are allowed. All other external connections will be denied.", + "edt_conf_network_ipWhitelist_title": "Whitelisted IP addresses", + "edt_conf_network_ip_itemtitle": "IP", + "edt_conf_network_localApiAuth_expl": "When disabled, API authorisation via password or token is not required for local connections. The exception is administrative commands.", + "edt_conf_network_localApiAuth_title": "Local API Authentication", + "edt_conf_network_restirctedInternetAccessAPI_expl": "You can restrict API requests over the Internet to only those IP addresses on the whitelist.", + "edt_conf_network_restirctedInternetAccessAPI_title": "Restrict to IP addresses", + "edt_conf_network_port_validation_error": "Port cannot be the same as for $1", "edt_conf_os_events_lockEnable_title": "Listen to lock events", "edt_conf_os_events_lockEnable_expl": "Listen to screen lock/unlock events", "edt_conf_os_events_suspendEnable_title": "Listen to suspend events", "edt_conf_os_events_suspendEnable_expl": "Listen to operating system suspend/resume events", "edt_conf_os_events_suspendOnLockEnable_title": "Suspend when locked", "edt_conf_os_events_suspendOnLockEnable_expl": "Suspend when the screen is locked, otherwise go into idle mode", - "edt_conf_pbs_heading_title": "Protocol Buffers Server", - "edt_conf_pbs_timeout_expl": "If no data are received for the given period, the component will be (soft) disabled.", - "edt_conf_pbs_timeout_title": "Timeout", + "edt_conf_protoServer_heading_title": "Protocol Buffers Server", + "edt_conf_protoServer_timeout_expl": "If no data are received for the given period, the component will be (soft) disabled.", + "edt_conf_protoServer_timeout_title": "Timeout", "edt_conf_sched_actions_header_title": "Actions", "edt_conf_sched_actions_header_expl": "Define which action should take place on a point in time. The action will be scheduled daily.", "edt_conf_sched_actions_header_item_title": "Action", @@ -551,7 +560,7 @@ "edt_conf_smooth_updateFrequency_expl": "The output speed to your LED controller.", "edt_conf_smooth_updateFrequency_title": "Update frequency", "edt_conf_time_event_title": "Time", - "edt_conf_time_event_expl": "Point in time that will trigger an action", + "edt_conf_time_event_expl": "Point in time that will trigger an action", "edt_conf_v4l2_blueSignalThreshold_expl": "Darkens low blue values (recognized as black)", "edt_conf_v4l2_blueSignalThreshold_title": "Blue signal threshold", "edt_conf_v4l2_cecDetection_expl": "If enabled, USB capture will be temporarily disabled when CEC standby event received from HDMI bus.", @@ -611,19 +620,19 @@ "edt_conf_v4l2_hardware_set_defaults_tip": "Set device's default values for brightness, contrast, hue and saturation", "edt_conf_v4l2_noSignalCounterThreshold_title": "Signal Counter Threshold", "edt_conf_v4l2_noSignalCounterThreshold_expl": "Count of frames (check that with grabber's current FPS mode) after which the no signal is triggered", - "edt_conf_webc_crtPath_expl": "Path to the certification file (format should be PEM)", - "edt_conf_webc_crtPath_title": "Certificate path", - "edt_conf_webc_docroot_expl": "Local webinterface root path (just for webui developer)", - "edt_conf_webc_docroot_title": "Document Root", - "edt_conf_webc_heading_title": "Web Configuration", - "edt_conf_webc_keyPassPhrase_expl": "Optional: The key might be protected with a password", - "edt_conf_webc_keyPassPhrase_title": "Key password", - "edt_conf_webc_keyPath_expl": "Path to the key file (format PEM, encrypted with RSA)", - "edt_conf_webc_keyPath_title": "Private key path", - "edt_conf_webc_port_expl": "Port for the WebServer, RPC and WebSocket HTTP connections", - "edt_conf_webc_port_title": "HTTP Port", - "edt_conf_webc_sslport_expl": "Port for the WebServer, RPC and WebSocket HTTPS connections", - "edt_conf_webc_sslport_title": "HTTPS Port", + "edt_conf_webConfig_crtPath_expl": "Path to the certification file (format should be PEM)", + "edt_conf_webConfig_crtPath_title": "Certificate path", + "edt_conf_webConfig_docroot_expl": "Local webinterface root path (just for webui developer)", + "edt_conf_webConfig_docroot_title": "Document Root", + "edt_conf_webConfig_heading_title": "Web Configuration", + "edt_conf_webConfig_keyPassPhrase_expl": "Optional: The key might be protected with a password", + "edt_conf_webConfig_keyPassPhrase_title": "Key password", + "edt_conf_webConfig_keyPath_expl": "Path to the key file (format PEM, encrypted with RSA)", + "edt_conf_webConfig_keyPath_title": "Private key path", + "edt_conf_webConfig_port_expl": "Port for the WebServer, RPC and WebSocket HTTP connections", + "edt_conf_webConfig_port_title": "HTTP Port", + "edt_conf_webConfig_sslPort_expl": "Port for the WebServer, RPC and WebSocket HTTPS connections", + "edt_conf_webConfig_sslPort_title": "HTTPS Port", "edt_dev_auth_key_title": "Authorization Token", "edt_dev_auth_key_title_info": "Authorization Token required to acccess the device", "edt_dev_enum_sub_min_cool_adjust": "Subtract cool white", @@ -677,7 +686,7 @@ "edt_dev_spec_devices_discovery_inprogress": "Discovery in progress", "edt_dev_spec_dithering_title": "Dithering", "edt_dev_spec_dmaNumber_title": "DMA channel", - "edt_dev_spec_fullBrightnessAtStart_title": "Full brightness at start", + "edt_dev_spec_fullBrightnessAtStart_title": "Full brightness at start", "edt_dev_spec_gamma_title": "Gamma", "edt_dev_spec_globalBrightnessControlMaxLevel_title": "Max Current Level", "edt_dev_spec_globalBrightnessControlThreshold_title": "Adaptive Current Threshold", @@ -824,7 +833,7 @@ "edt_eff_ledtest_header": "LED Test", "edt_eff_ledtest_header_desc": "Rotating output: Red, Green, Blue, White, Black", "edt_eff_ledtest_seq_header": "LED Test - Sequence", - "edt_eff_ledtest_seq_header_desc": "Light up the LEDs in sequence", + "edt_eff_ledtest_seq_header_desc": "Light up the LEDs in sequence", "edt_eff_length": "Length", "edt_eff_lightclock_header": "Light Clock", "edt_eff_lightclock_header_desc": "A real clock as light! Adjust the colors of hours, minute, seconds. A optional 3/6/9/12 o'clock marker is also available. In case the clock is wrong, you need to check your system clock.", @@ -927,7 +936,7 @@ "edt_msgcust_error_hostname_ip4": "Not a valid Hostname nor IPv4", "effectsconfigurator_button_conttest": "Continuous test", "effectsconfigurator_button_deleffect": "Delete Effect", - "effectsconfigurator_button_editeffect": "Load Effect", + "effectsconfigurator_button_loadeffect": "Load Effect", "effectsconfigurator_button_saveeffect": "Save Effect", "effectsconfigurator_button_starttest": "Start test", "effectsconfigurator_button_stoptest": "Stop test", @@ -1076,6 +1085,7 @@ "remote_effects_label_picture": "Picture:", "remote_input_clearall": "Clear all Effects/Colors", "remote_input_duration": "Duration:", + "remote_input_duration_endless": "Endless", "remote_input_intro": "Hyperion uses a priority system to select a source. Everything you set has a priority (Effect/Color/Screen capture/USB capture and network sources). By default, Hyperion select sources depending on priority (lowest number reflects the current active source). Now you have the opportunity to select sources on your own. $1", "remote_input_ip": "IP:", "remote_input_label": "Source Selection", diff --git a/assets/webconfig/index.html b/assets/webconfig/index.html index 88bf52b3e..ea41a7774 100644 --- a/assets/webconfig/index.html +++ b/assets/webconfig/index.html @@ -144,18 +144,13 @@

Hyperion Web Configuration requires Javascript. Please enable Javascript in - -
  • +
    • +
  • @@ -248,7 +247,6 @@

    Hyperion Web Configuration requires Javascript. Please enable Javascript in

    • -

    + + +
    '; - instances_html += ''; - - var components = window.comps; - var hyperion_enabled = true; - components.forEach(function (obj) { - if (obj.name == "ALL") { - hyperion_enabled = obj.enabled; - } - }); + let instanceRunningStatus = isInstanceRunning(window.currentHyperionInstance); + let isInstanceEnabled = false; + const components = window.comps; - var instBtn = ''; - - instances_html += '
    '; - instances_html += '' + $.i18n('dashboard_componentbox_label_status') + '' + instBtn + '
    '; - - instances_html += ''; - instances_html += ''; - instances_html += ''; - instances_html += ''; - instances_html += ''; - instances_html += '
    '; - instances_html += ''; - instances_html += '' + $.i18n('dashboard_infobox_label_title') + ''; - instances_html += '
    ' + $.i18n('conf_leds_contr_label_contrtype') + ''; - instances_html += '' + window.serverConfig.device.type + ''; - instances_html += ''; - instances_html += '
    '; - - instances_html += ''; - instances_html += ''; - - var componentBtn = ""; - var instance_components = ""; - for (var idx = 0; idx < components.length; idx++) { - if (components[idx].name != "ALL") { - if ((components[idx].name === "FORWARDER" && window.currentHyperionInstance != 0) || - (components[idx].name === "GRABBER" && !window.serverConfig.framegrabber.enable) || - (components[idx].name === "V4L" && !window.serverConfig.grabberV4L2.enable) || - (components[idx].name === "AUDIO" && !window.serverConfig.grabberAudio.enable)) - continue; + if (instanceRunningStatus) { + isInstanceEnabled = components.some(obj => obj.name === "ALL" && obj.enabled); + } - var comp_enabled = components[idx].enabled ? "checked" : ""; - const general_comp = "general_comp_" + components[idx].name; - componentBtn = ''; - - instance_components += ''; + // Generate instance status button + let instBtn = ` + + + +`; + + // Remove existing instance elements + $("div[class*='currentInstance']").remove(); + + // Start constructing the HTML for instances + let instances_html = ` +
    +
    +
    +
    + +
    +
    + + +
    +     + +
    +
    +
    +
    '; - instances_html += ''; - instances_html += '' + $.i18n('dashboard_componentbox_label_title') + ''; - instances_html += '
    ' + $.i18n('general_comp_' + components[idx].name) + '' + componentBtn + '
    + + + + + + +
    + + ${$.i18n('dashboard_componentbox_label_status')} + + ${instBtn} +
    +`; + + instances_html += ` + + + + + + + + + + + + + +
    + + ${$.i18n('dashboard_infobox_label_title')} +
    ${$.i18n('conf_leds_contr_label_contrtype')} + ${window.serverConfig.device.type} + + +
    +`; + + // If the current instance is running, add components table + if (instanceRunningStatus) { + instances_html += ` + + + + + + + `; + + // Initialize components table body + let instance_components = ""; + + for (const element of components) { + const componentName = element.name; + + // Skip unwanted components + if (componentName === "ALL" || + (componentName === "FORWARDER" && window.currentHyperionInstance !== window.serverConfig.forwarder.instance) || + (componentName === "GRABBER" && !window.serverConfig.framegrabber.enable) || + (componentName === "V4L" && !window.serverConfig.grabberV4L2.enable) || + (componentName === "AUDIO" && !window.serverConfig.grabberAudio.enable)) { + continue; + } + + // Determine if the component is enabled + const comp_enabled = element.enabled ? "checked" : ""; + const general_comp = `general_comp_${componentName}`; + + // Create the toggle button for the component + const componentBtn = ` + + `; + + // Add row for the component + instance_components += ` + + + + + + `; } + + // Close components table + instances_html += ` + ${instance_components} +
    + + ${$.i18n('dashboard_componentbox_label_title')} +
    ${$.i18n('general_comp_' + componentName)}${componentBtn}
    + `; } - instances_html += '' + instance_components + ''; - instances_html += '

    '; + // Close the container divs + instances_html += ` +
    +
    +
    +`; + // Prepend the instances HTML to the DOM $('.instances').prepend(instances_html); - updateUiOnInstance(window.currentHyperionInstance); - updateHyperionInstanceListing(); - + //Replace buttons by Bootstrap ones $('#instanceButton').bootstrapToggle(); - $('#instanceButton').on("change", e => { - requestSetComponentState('ALL', e.currentTarget.checked); - }); - - for (var idx = 0; idx < components.length; idx++) { - if (components[idx].name != "ALL") { - $("#general_comp_" + components[idx].name).bootstrapToggle(); - $("#general_comp_" + components[idx].name).bootstrapToggle(hyperion_enabled ? "enable" : "disable"); - $("#general_comp_" + components[idx].name).on("change", e => { - requestSetComponentState(e.currentTarget.id.split('_')[2], e.currentTarget.checked); - }); + if (instanceRunningStatus) { + + $('#instanceButton').change(function () { + requestSetComponentState('ALL', $(this).prop('checked')) + }); + + for (const element of components) { + const componentName = element.name; + if (componentName !== "ALL") { + $("#general_comp_" + componentName).bootstrapToggle(); + $("#general_comp_" + componentName).bootstrapToggle(isInstanceEnabled ? "enable" : "disable"); + + $("#general_comp_" + componentName).change(function () { + const componentName = componentName; + const isChecked = $(this).prop('checked'); + requestSetComponentState(componentName, isChecked); + }); + } } } + updateUiOnInstance(window.currentHyperionInstance); + updateHyperionInstanceListing(); + } - // add more info + function updateGlobalComponents() { - var screenGrabberAvailable = (window.serverInfo.grabbers.screen.available.length !== 0); - var videoGrabberAvailable = (window.serverInfo.grabbers.video.available.length !== 0); - const audioGrabberAvailable = (window.serverInfo.grabbers.audio.available.length !== 0); + // add more info + const screenGrabberAvailable = (window.serverInfo.grabbers.screen.available.length !== 0); + const videoGrabberAvailable = (window.serverInfo.grabbers.video.available.length !== 0); + const audioGrabberAvailable = (window.serverInfo.grabbers.audio.available.length !== 0); - if (screenGrabberAvailable || videoGrabberAvailable || audioGrabberAvailable) { + if (screenGrabberAvailable || videoGrabberAvailable || audioGrabberAvailable) { - if (screenGrabberAvailable) { - var screenGrabber = window.serverConfig.framegrabber.enable ? $.i18n('general_enabled') : $.i18n('general_disabled'); - $('#dash_screen_grabber').html(screenGrabber); + if (screenGrabberAvailable) { + const screenGrabber = window.serverConfig.framegrabber.enable ? $.i18n('general_enabled') : $.i18n('general_disabled'); + $('#dash_screen_grabber').html(screenGrabber); + } else { + $("#dash_screen_grabber_row").hide(); + } + + if (videoGrabberAvailable) { + const videoGrabber = window.serverConfig.grabberV4L2.enable ? $.i18n('general_enabled') : $.i18n('general_disabled'); + $('#dash_video_grabber').html(videoGrabber); + } else { + $("#dash_video_grabber_row").hide(); + } + + if (audioGrabberAvailable) { + const audioGrabber = window.serverConfig.grabberAudio.enable ? $.i18n('general_enabled') : $.i18n('general_disabled'); + $('#dash_audio_grabber').html(audioGrabber); + } else { + $("#dash_audio_grabber_row").hide(); + } } else { - $("#dash_screen_grabber_row").hide(); + $("#dash_capture_hw").hide(); } - if (videoGrabberAvailable) { - var videoGrabber = window.serverConfig.grabberV4L2.enable ? $.i18n('general_enabled') : $.i18n('general_disabled'); - $('#dash_video_grabber').html(videoGrabber); + if (jQuery.inArray("flatbuffer", window.serverInfo.services) !== -1) { + const fbPort = window.serverConfig.flatbufServer.enable ? window.serverConfig.flatbufServer.port : $.i18n('general_disabled'); + $('#dash_fbPort').html(fbPort); } else { - $("#dash_video_grabber_row").hide(); + $("#dash_ports_flat_row").hide(); } - if (audioGrabberAvailable) { - const audioGrabber = window.serverConfig.grabberAudio.enable ? $.i18n('general_enabled') : $.i18n('general_disabled'); - $('#dash_audio_grabber').html(audioGrabber); + if (jQuery.inArray("protobuffer", window.serverInfo.services) !== -1) { + const pbPort = window.serverConfig.protoServer.enable ? window.serverConfig.protoServer.port : $.i18n('general_disabled'); + $('#dash_pbPort').html(pbPort); } else { - $("#dash_audio_grabber_row").hide(); + $("#dash_ports_proto_row").hide(); } - } else { - $("#dash_capture_hw").hide(); - } - if (jQuery.inArray("flatbuffer", window.serverInfo.services) !== -1) { - var fbPort = window.serverConfig.flatbufServer.enable ? window.serverConfig.flatbufServer.port : $.i18n('general_disabled'); - $('#dash_fbPort').html(fbPort); - } else { - $("#dash_ports_flat_row").hide(); - } + if (jQuery.inArray("boblight", window.serverInfo.services) !== -1 && window.serverConfig.boblightServer) { + const boblightPort = window.serverConfig.boblightServer.enable ? window.serverConfig.boblightServer.port : $.i18n('general_disabled'); + $('#dash_boblightPort').html(boblightPort); + } else { + $("#dash_ports_boblight_row").hide(); + } - if (jQuery.inArray("protobuffer", window.serverInfo.services) !== -1) { - var pbPort = window.serverConfig.protoServer.enable ? window.serverConfig.protoServer.port : $.i18n('general_disabled'); - $('#dash_pbPort').html(pbPort); - } else { - $("#dash_ports_proto_row").hide(); + const jsonPort = window.serverConfig.jsonServer.port; + $('#dash_jsonPort').html(jsonPort); + const wsPorts = window.serverConfig.webConfig.port + ' | ' + window.serverConfig.webConfig.sslPort; + $('#dash_wsPorts').html(wsPorts); + + + $('#dash_currv').html(window.currentVersion); + $('#dash_watchedversionbranch').html(window.serverConfig.general.watchedVersionBranch); + + getReleases(function (callback) { + if (callback) { + $('#dash_latev').html(window.latestVersion.tag_name); + + if (semverLite.gt(window.latestVersion.tag_name, window.currentVersion)) { + $('#versioninforesult').html( + `
    + + ${$.i18n('dashboard_infobox_message_updatewarning', window.latestVersion.tag_name)} + +
    ` + ); + } else { + $('#versioninforesult').html( + `
    + ${$.i18n('dashboard_infobox_message_updatesuccess')} +
    ` + ); + } + } + }); } + function updateDashboard() { - if (jQuery.inArray("boblight", window.serverInfo.services) !== -1) { - var boblightPort = window.serverConfig.boblightServer.enable ? window.serverConfig.boblightServer.port : $.i18n('general_disabled'); - $('#dash_boblightPort').html(boblightPort); - } else { - $("#dash_ports_boblight_row").hide(); + //Only show an instance, if minimum one configured + if (window.serverInfo.instance.length !== 0) { + updateInstanceComponents(); + } + updateGlobalComponents(); } - var jsonPort = window.serverConfig.jsonServer.port; - $('#dash_jsonPort').html(jsonPort); - var wsPorts = window.serverConfig.webConfig.port + ' | ' + window.serverConfig.webConfig.sslPort; - $('#dash_wsPorts').html(wsPorts); - - $('#dash_currv').html(window.currentVersion); - $('#dash_watchedversionbranch').html(window.serverConfig.general.watchedVersionBranch); - - getReleases(function (callback) { - if (callback) { - $('#dash_latev').html(window.latestVersion.tag_name); + updateDashboard(); - if (semverLite.gt(window.latestVersion.tag_name, window.currentVersion)) - $('#versioninforesult').html('
    ' + $.i18n('dashboard_infobox_message_updatewarning', window.latestVersion.tag_name) + '
    '); - else - $('#versioninforesult').html('
    ' + $.i18n('dashboard_infobox_message_updatesuccess') + '
    '); - } - }); - - //interval update - updateComponents(); - $(window.hyperion).on("components-updated", updateComponents); + $(window.hyperion).on("components-updated", updateDashboard); - if (window.showOptHelp) + if (window.showOptHelp) { createHintH("intro", $.i18n('dashboard_label_intro'), "dash_intro"); + } removeOverlay(); }); + diff --git a/assets/webconfig/js/content_effectsconfigurator.js b/assets/webconfig/js/content_effectsconfigurator.js index 0cf691f26..1e99b6ff1 100644 --- a/assets/webconfig/js/content_effectsconfigurator.js +++ b/assets/webconfig/js/content_effectsconfigurator.js @@ -14,6 +14,14 @@ $(document).ready(function () { if (window.showOptHelp) createHintH("intro", $.i18n('effectsconfigurator_label_intro'), "intro_effc"); + if (!isCurrentInstanceRunning()) { + + $("#effect_table :input").prop("disabled", true); + $("#effect_delload :input").prop("disabled", true); + + removeOverlay(); + return; + } function updateDelEffectlist() { var newDelList = window.serverInfo.effects; if (newDelList.length != oldDelList.length) { @@ -56,9 +64,9 @@ $(document).ready(function () { var args = effects_editor.getEditor('root.args'); if ($('input[type=radio][value=url]').is(':checked')) { - requestTestEffect(effectName, effectPyScript, JSON.stringify(args.getValue()), ""); + requestTestEffect(effectName, effectPyScript, args.getValue(), ""); } else { - requestTestEffect(effectName, effectPyScript, JSON.stringify(args.getValue()), imageData); + requestTestEffect(effectName, effectPyScript, args.getValue(), imageData); } }; @@ -137,10 +145,11 @@ $(document).ready(function () { // Save Effect $('#btn_write').off().on('click', function () { + const args = effects_editor.getEditor('root.args').getValue(); if ($('input[type=radio][value=url]').is(':checked')) { - requestWriteEffect(effectName, effectPyScript, JSON.stringify(effects_editor.getValue()), ""); + requestWriteEffect(effectName, effectPyScript, args, ""); } else { - requestWriteEffect(effectName, effectPyScript, JSON.stringify(effects_editor.getValue()), imageData); + requestWriteEffect(effectName, effectPyScript, args, imageData); } $(window.hyperion).one("cmd-create-effect", function (event) { @@ -183,12 +192,12 @@ $(document).ready(function () { // Disable or enable Delete Effect Button $('#effectsdellist').off().on('change', function () { var value = $(this).val(); - value == null ? $('#btn_edit').prop('disabled', true) : $('#btn_edit').prop('disabled', false); + value == null ? $('#btn_load').prop('disabled', true) : $('#btn_load').prop('disabled', false); value.startsWith("int_") ? $('#btn_delete').prop('disabled', true) : $('#btn_delete').prop('disabled', false); }); // Load Effect - $('#btn_edit').off().on('click', function () { + $('#btn_load').off().on('click', function () { var name = $("#effectsdellist").val().replace("ext_", ""); if (name.startsWith("int_")) { @@ -259,4 +268,3 @@ $(document).ready(function () { removeOverlay(); }); - diff --git a/assets/webconfig/js/content_general.js b/assets/webconfig/js/content_general.js index 6b732e467..c4ac5af77 100644 --- a/assets/webconfig/js/content_general.js +++ b/assets/webconfig/js/content_general.js @@ -1,171 +1,225 @@ $(document).ready(function () { + // Perform translation on page load performTranslation(); - var importedConf; - var confName; - var conf_editor = null; + let importedConf; + let confName; + let conf_editor = null; + // Initialize the configuration panel $('#conf_cont').append(createOptPanel('fa-wrench', $.i18n("edt_conf_gen_heading_title"), 'editor_container', 'btn_submit', 'panel-system')); + + // Show help if needed if (window.showOptHelp) { $('#conf_cont').append(createHelpTable(window.schema.general.properties, $.i18n("edt_conf_gen_heading_title"))); - } - else + } else { $('#conf_imp').appendTo('#conf_cont'); + } - conf_editor = createJsonEditor('editor_container', { - general: window.schema.general - }, true, true); + // Create JSON editor + conf_editor = createJsonEditor('editor_container', { general: window.schema.general }, true, true); + // Handle editor change conf_editor.on('change', function () { - conf_editor.validate().length || window.readOnlyMode ? $('#btn_submit').prop('disabled', true) : $('#btn_submit').prop('disabled', false); + const isValid = !conf_editor.validate().length && !window.readOnlyMode; + $('#btn_submit').prop('disabled', !isValid); }); + // Submit button click handler $('#btn_submit').off().on('click', function () { window.showOptHelp = conf_editor.getEditor("root.general.showOptHelp").getValue(); requestWriteConfig(conf_editor.getValue()); }); - // Instance handling - function handleInstanceRename(e) { - - var inst = e.currentTarget.id.split("_")[1]; - showInfoDialog('renInst', $.i18n('conf_general_inst_renreq_t'), getInstanceNameByIndex(inst)); + // Instance handling functions + function handleInstanceRename(instance) { + showInfoDialog('renInst', $.i18n('conf_general_inst_renreq_t'), getInstanceName(instance)); + // Rename button click handler $("#id_btn_ok").off().on('click', function () { - requestInstanceRename(inst, encodeHTML($('#renInst_name').val())) + requestInstanceRename(instance, encodeHTML($('#renInst_name').val())); }); + // Input handler for rename field $('#renInst_name').off().on('input', function (e) { - (e.currentTarget.value.length >= 5 && e.currentTarget.value != getInstanceNameByIndex(inst)) ? $('#id_btn_ok').prop('disabled', false) : $('#id_btn_ok').prop('disabled', true); + const isValid = e.currentTarget.value.length >= 5 && e.currentTarget.value !== getInstanceName(instance); + $('#id_btn_ok').prop('disabled', !isValid); }); } - function handleInstanceDelete(e) { - var inst = e.currentTarget.id.split("_")[1]; - showInfoDialog('delInst', $.i18n('conf_general_inst_delreq_h'), $.i18n('conf_general_inst_delreq_t', getInstanceNameByIndex(inst))); + function handleInstanceDelete(instance) { + showInfoDialog('delInst', $.i18n('conf_general_inst_delreq_h'), $.i18n('conf_general_inst_delreq_t', getInstanceName(instance))); + + // Delete button click handler $("#id_btn_yes").off().on('click', function () { - requestInstanceDelete(inst) + requestInstanceDelete(instance); }); } + // Build the instance list function buildInstanceList() { - var inst = serverInfo.instance - $('.itbody').html(""); - for (var key in inst) { - var enable_style = inst[key].running ? "checked" : ""; - var renameBtn = ''; - var startBtn = "" - var delBtn = ""; - if (inst[key].instance > 0) { - delBtn = ''; - startBtn = ''; - - } - $('.itbody').append(createTableRow([inst[key].friendly_name, startBtn, renameBtn, delBtn], false, true)); - $('#instren_' + inst[key].instance).off().on('click', handleInstanceRename); - - $('#inst_' + inst[key].instance).bootstrapToggle(); - $('#inst_' + inst[key].instance).on("change", e => { - requestInstanceStartStop(e.currentTarget.id.split('_').pop(), e.currentTarget.checked); + + const instances = serverInfo.instance; + + // Ensure .itbody exists and clear it + const $itbody = $('.itbody'); + if ($itbody.length === 0) { + console.warn("Element '.itbody' does not exist. Aborting instance list build."); + return; + } + $itbody.empty(); // Explicitly clear the content before adding new rows + + // Collect rows in a document fragment for efficient DOM updates + const $rows = $(document.createDocumentFragment()); + + for (const instance in instances) { + const instanceID = instances[instance].instance; + const enableStyle = instances[instance].running ? "checked" : ""; + const renameBtn = ``; + const delBtn = ``; + const startBtn = ``; + + // Generate a table row and add it to the document fragment + const $row = createTableRow( + [ + instances[instance].friendly_name, + startBtn, + renameBtn, + delBtn + ], + false, + true + ); + + $rows.append($row); + } + + // Append all rows to .itbody in one operation + $itbody.append($rows); + + // Reapply event listeners + for (const instance in instances) { + const instanceID = instances[instance].instance; + + const readOnly = window.readOnlyMode; + $('#instren_' + instanceID).prop('disabled', readOnly); + $('#inst_' + instanceID).prop('disabled', readOnly); + $('#instdel_' + instanceID).prop('disabled', readOnly); + + $('#instren_' + instanceID).off().on('click', function () { + handleInstanceRename(instanceID); + }); + + $('#instdel_' + instanceID).off().on('click', function () { + handleInstanceDelete(instanceID); }); - $('#instdel_' + inst[key].instance).off().on('click', handleInstanceDelete); - window.readOnlyMode ? $('#instren_' + inst[key].instance).prop('disabled', true) : $('#btn_submit').prop('disabled', false); - window.readOnlyMode ? $('#inst_' + inst[key].instance).prop('disabled', true) : $('#btn_submit').prop('disabled', false); - window.readOnlyMode ? $('#instdel_' + inst[key].instance).prop('disabled', true) : $('#btn_submit').prop('disabled', false); + $('#inst_' + instanceID).bootstrapToggle(); + $('#inst_' + instanceID).change(function () { + const isChecked = $(this).prop('checked'); + requestInstanceStartStop(instanceID, isChecked); + }); } } + // Initialize table createTable('ithead', 'itbody', 'itable'); $('.ithead').html(createTableRow([$.i18n('conf_general_inst_namehead'), "", $.i18n('conf_general_inst_actionhead'), ""], true, true)); buildInstanceList(); + // Instance name input validation $('#inst_name').off().on('input', function (e) { - (e.currentTarget.value.length >= 5) && !window.readOnlyMode ? $('#btn_create_inst').prop('disabled', false) : $('#btn_create_inst').prop('disabled', true); - if (5 - e.currentTarget.value.length >= 1 && 5 - e.currentTarget.value.length <= 4) - $('#inst_chars_needed').html(5 - e.currentTarget.value.length + " " + $.i18n('general_chars_needed')) - else - $('#inst_chars_needed').html("
    ") + const isValid = e.currentTarget.value.length >= 5 && !window.readOnlyMode; + $('#btn_create_inst').prop('disabled', !isValid); + + const charsNeeded = 5 - e.currentTarget.value.length; + $('#inst_chars_needed').html(charsNeeded >= 1 && charsNeeded <= 4 ? `${charsNeeded} ${$.i18n('general_chars_needed')}` : "
    "); }); + // Instance creation button click handler $('#btn_create_inst').off().on('click', function (e) { requestInstanceCreate(encodeHTML($('#inst_name').val())); $('#inst_name').val(""); - $('#btn_create_inst').prop('disabled', true) + $('#btn_create_inst').prop('disabled', true); }); + // Instance updated event listener $(hyperion).off("instance-updated").on("instance-updated", function (event) { - buildInstanceList() + buildInstanceList(); }); - //import + // Import handling functions function dis_imp_btn(state) { - state || window.readOnlyMode ? $('#btn_import_conf').prop('disabled', true) : $('#btn_import_conf').prop('disabled', false); + $('#btn_import_conf').prop('disabled', state || window.readOnlyMode); } function readFile(evt) { - var f = evt.target.files[0]; - + const f = evt.target.files[0]; if (f) { - var r = new FileReader(); + const r = new FileReader(); r.onload = function (e) { - var content = e.target.result.replace(/[^:]?\/\/.*/g, ''); //remove Comments + let content = e.target.result.replace(/[^:]?\/\/.*/g, ''); // Remove comments - //check file is json - var check = isJsonString(content); - if (check.length != 0) { + // Check if the content is valid JSON + const check = isJsonString(content); + if (check.length !== 0) { showInfoDialog('error', "", $.i18n('infoDialog_import_jsonerror_text', f.name, JSON.stringify(check.message))); dis_imp_btn(true); - } - else { + } else { content = JSON.parse(content); - //check for hyperion json if (typeof content.global === 'undefined' || typeof content.instances === 'undefined') { showInfoDialog('error', "", $.i18n('infoDialog_import_version_error_text', f.name)); dis_imp_btn(true); - } - else { + } else { dis_imp_btn(false); importedConf = content; confName = f.name; } } - } + }; r.readAsText(f); } } + // Import button click handler $('#btn_import_conf').off().on('click', function () { showInfoDialog('import', $.i18n('infoDialog_import_confirm_title'), $.i18n('infoDialog_import_confirm_text', confName)); - $('#id_btn_import').off().on('click', function () { + $('#id_btn_import').off().on('click', function () { requestRestoreConfig(importedConf); }); - }); + // Import file selection change handler $('#select_import_conf').off().on('change', function (e) { - if (window.File && window.FileReader && window.FileList && window.Blob) + if (window.File && window.FileReader && window.FileList && window.Blob) { readFile(e); - else + } else { showInfoDialog('error', "", $.i18n('infoDialog_import_comperror_text')); + } }); - //export - $('#btn_export_conf').off().on('click', async () => - { + // Export configuration + $('#btn_export_conf').off().on('click', async () => { const d = new Date(); const month = String(d.getMonth() + 1).padStart(2, '0'); const day = String(d.getDate()).padStart(2, '0'); const timestamp = `${d.getFullYear()}-${month}-${day}`; - const configBackup = await requestConfig(); - if (configBackup.success === true) { - download(JSON.stringify(configBackup.info, null, "\t"), 'HyperionBackup-' + timestamp + '_v' + window.currentVersion + '.json', "application/json"); + const configBackup = await requestServerConfig.async(); + if (configBackup.success) { + download(JSON.stringify(configBackup.info, null, "\t"), `HyperionBackup-${timestamp}_v${window.currentVersion}.json`, "application/json"); } }); - //create introduction + // Create introduction hints if help is shown if (window.showOptHelp) { createHint("intro", $.i18n('conf_general_intro'), "editor_container"); createHint("intro", $.i18n('conf_general_tok_desc'), "tok_desc_cont"); @@ -175,7 +229,8 @@ $(document).ready(function () { removeOverlay(); }); -$(window.hyperion).on("cmd-config-restoreconfig", function (event) { +// Command for restoring config +$(window.hyperion).on("cmd-config-restoreconfig", function () { setTimeout(initRestart, 100); }); diff --git a/assets/webconfig/js/content_grabber.js b/assets/webconfig/js/content_grabber.js index 91c5ecceb..8ebadeed4 100755 --- a/assets/webconfig/js/content_grabber.js +++ b/assets/webconfig/js/content_grabber.js @@ -321,13 +321,16 @@ $(document).ready(function () { conf_editor_screen.getEditor("root.framegrabber.fps").setValue(fps); }); - $('#btn_submit_screengrabber').off().on('click', function () { - var saveOptions = conf_editor_screen.getValue(); + let saveOptions = conf_editor_screen.getValue(); - var instCaptOptions = window.serverConfig.instCapture; - instCaptOptions.systemEnable = saveOptions.framegrabber.enable; - saveOptions.instCapture = instCaptOptions; + const currentInstance = window.currentHyperionInstance; + //If an instance exists, enable/disable grabbing in line with the global state + if (currentInstance !== null && window.serverConfig.instCapture) { + let instCaptOptions = window.serverConfig.instCapture; + instCaptOptions.systemEnable = saveOptions.framegrabber.enable; + saveOptions.instCapture = instCaptOptions; + } requestWriteConfig(saveOptions); }); @@ -670,11 +673,15 @@ $(document).ready(function () { }); $('#btn_submit_videograbber').off().on('click', function () { - var saveOptions = conf_editor_video.getValue(); + let saveOptions = conf_editor_video.getValue(); - var instCaptOptions = window.serverConfig.instCapture; - instCaptOptions.v4lEnable = saveOptions.grabberV4L2.enable; - saveOptions.instCapture = instCaptOptions; + const currentInstance = window.currentHyperionInstance; + //If an instance exists, enable/disable grabbing in line with the global state + if (currentInstance !== null && window.serverConfig.instCapture) { + let instCaptOptions = window.serverConfig.instCapture; + instCaptOptions.v4lEnable = saveOptions.grabberV4L2.enable; + saveOptions.instCapture = instCaptOptions; + } requestWriteConfig(saveOptions); }); @@ -796,11 +803,15 @@ $(document).ready(function () { }); $('#btn_submit_audiograbber').off().on('click', function () { - const saveOptions = conf_editor_audio.getValue(); + let saveOptions = conf_editor_audio.getValue(); - const instCaptOptions = window.serverConfig.instCapture; - instCaptOptions.audioEnable = saveOptions.grabberAudio.enable; - saveOptions.instCapture = instCaptOptions; + const currentInstance = window.currentHyperionInstance; + //If an instance exists, enable/disable grabbing in line with the global state + if (currentInstance !== null && window.serverConfig.instCapture) { + let instCaptOptions = window.serverConfig.instCapture; + instCaptOptions.audioEnable = saveOptions.grabberAudio.enable; + saveOptions.instCapture = instCaptOptions; + } requestWriteConfig(saveOptions); }); diff --git a/assets/webconfig/js/content_index.js b/assets/webconfig/js/content_index.js index 1cb2060fe..ae4869885 100644 --- a/assets/webconfig/js/content_index.js +++ b/assets/webconfig/js/content_index.js @@ -1,5 +1,5 @@ $(document).ready(function () { - var darkModeOverwrite = getStorage("darkModeOverwrite"); + const darkModeOverwrite = getStorage("darkModeOverwrite"); if (darkModeOverwrite == "false" || darkModeOverwrite == null) { if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) { @@ -15,11 +15,14 @@ $(document).ready(function () { handleDarkMode(); } + const isMediaStreamingSupported = !!(navigator.mediaDevices && navigator.mediaDevices.getDisplayMedia); + setStorage('mediaStreamingSupported', isMediaStreamingSupported); + loadContentTo("#container_connection_lost", "connection_lost"); loadContentTo("#container_restart", "restart"); initWebSocket(); - $(window.hyperion).on("cmd-serverinfo", function (event) { + $(window.hyperion).on("cmd-serverinfo-getInfo", function (event) { window.serverInfo = event.response.info; // comps @@ -37,16 +40,17 @@ $(document).ready(function () { }); // determine button visibility - var running = window.serverInfo.instance.filter(entry => entry.running); - if (running.length > 1) + const running = window.serverInfo.instance.filter(entry => entry.running); + if (running.length > 1) { $('#btn_hypinstanceswitch').toggle(true) - else + } else { $('#btn_hypinstanceswitch').toggle(false) + } }); // end cmd-serverinfo // Update language selection $("#language-select").on('changed.bs.select', function (e, clickedIndex, isSelected, previousValue) { - var newLang = availLang[clickedIndex]; + const newLang = availLang[clickedIndex]; if (newLang !== storedLang) { setStorage("langcode", newLang); reload(); @@ -75,14 +79,14 @@ $(document).ready(function () { $(window.hyperion).on("cmd-authorize-tokenRequest cmd-authorize-getPendingTokenRequests", function (event) { if (event.response && event.response.info !== undefined) { - var val = event.response.info; + const val = event.response.info; if (Array.isArray(event.response.info)) { if (event.response.info.length == 0) { return } - val = event.response.info[0] - if (val.comment == '') + const info = event.response.info[0] + if (info.comment == '') $('#modal_dialog').modal('hide'); } @@ -118,20 +122,65 @@ $(document).ready(function () { requestTokenInfo(); requestGetPendingTokenRequests(); - //Switch to last selected instance and load related config - var lastSelectedInstance = getStorage('lastSelectedInstance'); - if (lastSelectedInstance == null || window.serverInfo.instance && !window.serverInfo.instance[lastSelectedInstance]) { - lastSelectedInstance = 0; - } - instanceSwitch(lastSelectedInstance); - requestSysInfo(); + + const lastSelectedInstance = getStorage('lastSelectedInstance'); + // Convert to a valid number only if it's not null/undefined and a valid number + window.currentHyperionInstance = (lastSelectedInstance !== null && !isNaN(Number(lastSelectedInstance))) + ? Number(lastSelectedInstance) + : null; + getServerInformation(window.currentHyperionInstance); }); - $(window.hyperion).on("cmd-config-getconfig-old", function (event) { - window.serverConfig = event.response.info; + $(window.hyperion).on("cmd-config-getconfig", function (event) { + + // Function to reverse the transformed config into the legacy format + function reverseTransformConfig(serverConfig, instanceId) { + const { global, instances } = serverConfig; + + // Initialize the resulting legacy config + const legacyConfig = {}; + + // Add global settings to the legacy config + if (global?.settings) { + Object.assign(legacyConfig, global.settings); + } + + // Find the instance with the matching id and add its settings + const instance = instances.find(inst => inst.id === instanceId); + if (instance?.settings) { + Object.assign(legacyConfig, instance.settings); + } + + return legacyConfig; + } + + let instanceId = window.currentHyperionInstance; + const config = event.response.info; + const { instanceIds } = config; + if (instanceIds.length !== 0) { + if (!instanceIds.includes(window.currentHyperionInstance)) { + // If instanceID is not valid try to switch to the first enabled or or fall back to the first instance configured + const { instances } = config; + + const firstEnabledInstanceId = instances.find((instance) => instance.enabled)?.id; + if (firstEnabledInstanceId) { + instanceId = firstEnabledInstanceId; + instanceSwitch(instanceId); + } else { + instanceId = window.currentHyperionInstance = instanceIds[0]; + } + + } + } + + setStorage('lastSelectedInstance', instanceId); + const legacyConfig = reverseTransformConfig(config, instanceId); + window.serverConfig = legacyConfig; window.showOptHelp = window.serverConfig.general.showOptHelp; + + $(window.hyperion).trigger("serverConfig_updated"); }); $(window.hyperion).on("cmd-config-setconfig", function (event) { @@ -145,7 +194,7 @@ $(document).ready(function () { $("#top-navbar").removeAttr('style') if (window.defaultPasswordIsSet === true && getStorage("suppressDefaultPwWarning") !== "true") { - var supprPwWarnCheckbox = '
    ' + $.i18n('dashboard_message_do_not_show_again') + const supprPwWarnCheckbox = '
    ' + $.i18n('dashboard_message_do_not_show_again') + '
    ' showNotification('warning', $.i18n('dashboard_message_default_password'), $.i18n('dashboard_message_default_password_t'), '' + $.i18n('InfoDialog_changePassword_title') + '' + supprPwWarnCheckbox) @@ -169,9 +218,9 @@ $(document).ready(function () { }); $(window.hyperion).on("cmd-authorize-newPasswordRequired", function (event) { - var loginToken = getStorage("loginToken") + const loginToken = getStorage("loginToken") - if (event.response.info.newPasswordRequired == true) { + if (event.response.info.newPasswordRequired === true) { window.defaultPasswordIsSet = true; if (loginToken) @@ -196,10 +245,6 @@ $(document).ready(function () { if (event.reason == "No Authorization" && getStorage("loginToken")) { removeStorage("loginToken"); requestRequiresDefaultPasswortChange(); - } - else if (event.reason == "Selected Hyperion instance is not running") { - //Switch to default instance - instanceSwitch(0); } else { showInfoDialog("error", "Error", event.reason); } @@ -210,21 +255,21 @@ $(document).ready(function () { }); $(window.hyperion).on("ready", function (event) { - loadContent(undefined,true); + loadContent(undefined, true); //Hide capture menu entries, if no grabbers are available if ((window.serverInfo.grabbers.screen.available.length === 0) && - (window.serverInfo.grabbers.video.available.length === 0) && - (window.serverInfo.grabbers.audio.available.length === 0)) { - $("#MenuItemGrabber").attr('style', 'display:none') + (window.serverInfo.grabbers.video.available.length === 0) && + (window.serverInfo.grabbers.audio.available.length === 0)) { + $("#MenuItemGrabber").hide() if ((jQuery.inArray("boblight", window.serverInfo.services) === -1)) { - $("#MenuItemInstCapture").attr('style', 'display:none') + $("#MenuItemInstCapture").hide(); } } //Hide effectsconfigurator menu entry, if effectengine is not available if (jQuery.inArray("effectengine", window.serverInfo.services) === -1) { - $("#MenuItemEffectsConfig").attr('style', 'display:none') + $("#MenuItemEffectsConfig").hide(); } }); @@ -257,48 +302,64 @@ $(document).ready(function () { }); $(window.hyperion).on("cmd-instance-update", function (event) { - window.serverInfo.instance = event.response.data - var avail = event.response.data; + const isInstanceRunningBeforeUpdate = isCurrentInstanceRunning(); + + window.serverInfo.instance = event.response.data; + // notify the update $(window.hyperion).trigger("instance-updated"); - // if our current instance is no longer available we are at instance 0 again. - var isInData = false; - for (var key in avail) { - if (avail[key].instance == currentHyperionInstance && avail[key].running) { - isInData = true; - } - } + if (!isCurrentInstanceRunning()) { + let newInstance = getFirstRunningInstance(); + if (newInstance === null) { - if (!isInData) { - //Delete Storage information about the last used but now stopped instance - if (getStorage('lastSelectedInstance')) - removeStorage('lastSelectedInstance') + const lastSelectedInstance = getStorage('lastSelectedInstance'); - window.currentHyperionInstance = 0; - window.currentHyperionInstanceName = getInstanceNameByIndex(0); + if (doesInstanceExist(lastSelectedInstance)) { - requestServerConfigOld(); - setTimeout(requestServerInfo, 100) - setTimeout(requestTokenInfo, 200) - } + newInstance = lastSelectedInstance; + } else { + newInstance = getFirstConfiguredInstance(); + //Delete Storage information about the last used but now stopped instance + removeStorage('lastSelectedInstance'); + } + } - // determine button visibility - var running = serverInfo.instance.filter(entry => entry.running); - if (running.length > 1) - $('#btn_hypinstanceswitch').toggle(true) - else - $('#btn_hypinstanceswitch').toggle(false) + if (newInstance !== null) { + instanceSwitch(newInstance); + } else { + debugMessage("No instance is configured."); + window.currentHyperionInstance = null; + updateUiOnInstance(window.currentHyperionInstance); + } + } else if (!isInstanceRunningBeforeUpdate) { + if (window.currentHyperionInstance !== null) { + requestServerInfo(window.currentHyperionInstance); + } + } - // update listing for button - updateUiOnInstance(window.currentHyperionInstance); updateHyperionInstanceListing(); }); + async function getServerInformation(instance) { + try { + // Step 1: Request server config + await requestServerConfig.sync([], [instance], []); + + // Step 2: Request server info + await requestServerInfo(instance); + + // Step 3: Request token info + await requestTokenInfo(); + + } catch (error) { + console.error("An error occurred during getting server information:", error); + } + } + $(window.hyperion).on("cmd-instance-switchTo", function (event) { - requestServerConfigOld(); - setTimeout(requestServerInfo, 200) - setTimeout(requestTokenInfo, 400) + + getServerInformation(window.currentHyperionInstance); }); $(window.hyperion).on("cmd-effects-update", function (event) { @@ -331,7 +392,7 @@ function suppressDefaultPwWarning() { } $(function () { - var sidebar = $('#side-menu'); // cache sidebar to a variable for performance + const sidebar = $('#side-menu'); // cache sidebar to a variable for performance sidebar.on("click", 'a.inactive', function () { sidebar.find('.active').toggleClass('active inactive'); $(this).toggleClass('active inactive'); diff --git a/assets/webconfig/js/content_leds.js b/assets/webconfig/js/content_leds.js index aa468cd10..f4d716190 100755 --- a/assets/webconfig/js/content_leds.js +++ b/assets/webconfig/js/content_leds.js @@ -649,6 +649,12 @@ $(document).ready(function () { $('#led_vis_help').html('
    ' + $.i18n('conf_leds_layout_preview_l1') + '
    ' + $.i18n('conf_leds_layout_preview_l2') + '
    '); } + if (isInstanceRunning(window.currentHyperionInstance)) { + $("#leds_prev_toggle_live_video").show(); + } else { + $("#leds_prev_toggle_live_video").hide(); + } + //************************************************** // Handle LED-Layout Configuration //************************************************** @@ -1739,7 +1745,7 @@ $(document).ready(function () { optArr[6].push(ledDevices[idx]); } - $("#leddevices").append(createSel(optArr[0], $.i18n('conf_leds_optgroup_RPiSPI'))); + $("#leddevices").append(createSel(optArr[0], $.i18n('conf_leds_optgroup_SPI'))); $("#leddevices").append(createSel(optArr[1], $.i18n('conf_leds_optgroup_RPiPWM'))); $("#leddevices").append(createSel(optArr[2], $.i18n('conf_leds_optgroup_RPiGPIO'))); $("#leddevices").append(createSel(optArr[3], $.i18n('conf_leds_optgroup_network'))); @@ -2476,7 +2482,7 @@ function validateWledLedCount(hardwareLedCount) { if (!jQuery.isEmptyObject(devicesProperties)) { var host = conf_editor.getEditor("root.specificOptions.host").getValue(); - var ledDeviceProperties = devicesProperties["wled"][host]; + var ledDeviceProperties = devicesProperties["wled"]?.[host] || {}; if (ledDeviceProperties) { diff --git a/assets/webconfig/js/content_logging.js b/assets/webconfig/js/content_logging.js index a8d5fa360..3d6926edd 100644 --- a/assets/webconfig/js/content_logging.js +++ b/assets/webconfig/js/content_logging.js @@ -6,7 +6,7 @@ performTranslation(); $(document).ready(function () { - window.addEventListener('hashchange', function(event) { + window.addEventListener('hashchange', function (event) { requestLoggingStop(); }); @@ -36,64 +36,76 @@ $(document).ready(function () { }); function infoSummary() { - var info = ""; + let info = ''; - info += 'Hyperion System Summary Report (' + window.serverConfig.general.name + ')\n'; - info += 'Reported instance: [' + window.currentHyperionInstance + '] - ' + window.currentHyperionInstanceName + '\n'; + const serverConfig = window.serverConfig ?? {}; + const currentInstance = window.currentHyperionInstance; + const currentInstanceName = window.currentHyperionInstanceName ?? 'Unknown'; - info += "\n< ----- System information -------------------- >\n"; - info += getSystemInfo() + '\n'; + info += `Hyperion System Summary Report (${serverConfig.general?.name ?? 'Unknown'})\n`; - info += "\n< ----- Configured Instances ------------------ >\n"; - var instances = window.serverInfo.instance; - for (var i = 0; i < instances.length; i++) { - info += instances[i].instance + ': ' + instances[i].friendly_name + ', Running: ' + instances[i].running + '\n'; + if (currentInstance !== null) { + info += `Reported instance: [${currentInstance}] - ${currentInstanceName}\n`; } - info += "\n< ----- This instance's priorities ------------ >\n"; - var prios = window.serverInfo.priorities; + info += `\n< ----- System information -------------------- >\n`; + info += `${getSystemInfo()}\n`; - if (prios.length > 0) { + // Configured Instances + info += `\n< ----- Configured Instances ------------------ >\n`; + const instances = serverInfo.instance ?? []; - for (var i = 0; i < prios.length; i++) { + if (instances.length > 0) { + info += instances.map(inst => + `${inst.instance ?? 'Unknown Instance'}: ${inst.friendly_name ?? 'Unnamed'}, Running: ${inst.running ?? 'Unknown'}` + ).join('\n') + '\n'; - var prio = prios[i].priority.toString().padStart(3, '0'); + // Priorities (Only shown if instances exist) + info += `\n< ----- This instance's priorities ------------ >\n`; + const priorities = serverInfo.priorities ?? []; - info += prio + ': '; - if (prios[i].visible) { - info += ' VISIBLE -'; - } - else { - info += ' INVISIBLE -'; - } - info += ' (' + prios[i].componentId + ')'; - if (prios[i].owner) { - info += ' (Owner: ' + prios[i].owner + ')'; - } - info += '\n'; + if (priorities.length > 0) { + info += priorities.map(prio => { + const priorityStr = prio.priority?.toString().padStart(3, '0') ?? 'N/A'; + return `${priorityStr}: ${prio.visible ? 'VISIBLE -' : 'INVISIBLE -'} (${prio.componentId ?? 'Unknown Component'})` + + (prio.owner ? ` (Owner: ${prio.owner})` : ''); + }).join('\n') + '\n'; + } else { + info += `The current priority list is empty or unavailable!\n`; + } + + info += `Autoselect: ${serverInfo.priorities_autoselect ?? 'N/A'}\n`; + // Components Status (Only shown if instances exist) + info += `\n< ----- This instance components' status ------->\n`; + const components = serverInfo.components ?? []; + + if (components.length > 0) { + info += components.map(comp => + `${comp.name} - ${comp.enabled ?? 'Unknown'}` + ).join('\n') + '\n'; + } else { + info += `No components found or unavailable!\n`; } } else { - info += 'The current priority list is empty!\n'; + info += `No instances are configured!\n`; } - info += 'Autoselect: ' + window.serverInfo.priorities_autoselect + '\n'; - info += "\n< ----- This instance components' status ------->\n"; - var comps = window.serverInfo.components; - for (var i = 0; i < comps.length; i++) { - info += comps[i].name + ' - ' + comps[i].enabled + '\n'; + // Configuration + const config = transformConfig(serverConfig, currentInstance); + info += `\n< ----- Global configuration items------------- >\n`; + info += `${JSON.stringify(config.global, null, 2)}\n`; + + if (instances.length > 0) { + info += `\n< ----- Selected Instance configuration items-- >\n`; + info += `${JSON.stringify(config.instances, null, 2)}\n`; } - info += "\n< ----- This instance's configuration --------- >\n"; - info += JSON.stringify(window.serverConfig, null, 2) + '\n'; + // Log Messages + info += `\n< ----- Current Log --------------------------- >\n`; + const logMessages = document.getElementById("logmessages")?.textContent.trim() ?? ''; - info += "\n< ----- Current Log --------------------------- >\n"; - var logMsgs = document.getElementById("logmessages").textContent; - if (logMsgs.length !== 0) { - info += logMsgs; - } else { - info += "Log is empty!"; - } + info += logMessages.length > 0 ? logMessages : "Log is empty!"; return info; } diff --git a/assets/webconfig/js/content_network.js b/assets/webconfig/js/content_network.js index 9f9f68c34..b779c6d0b 100644 --- a/assets/webconfig/js/content_network.js +++ b/assets/webconfig/js/content_network.js @@ -1,411 +1,461 @@ $(document).ready(function () { performTranslation(); - var FORWARDER_ENABLED = (jQuery.inArray("forwarder", window.serverInfo.services) !== -1); - var FLATBUF_SERVER_ENABLED = (jQuery.inArray("flatbuffer", window.serverInfo.services) !== -1); - var PROTOTBUF_SERVER_ENABLED = (jQuery.inArray("protobuffer", window.serverInfo.services) !== -1); + const services = window.serverInfo.services; + const isServiceEnabled = (service) => services.includes(service); + const isForwarderEnabled = isServiceEnabled("forwarder"); + const isFlatbufEnabled = isServiceEnabled("flatbuffer"); + const isProtoBufEnabled = isServiceEnabled("protobuffer"); - var conf_editor_net = null; - var conf_editor_json = null; - var conf_editor_proto = null; - var conf_editor_fbs = null; - var conf_editor_forw = null; + let editors = {}; // Store JSON editors in a structured way // Service properties , 2-dimensional array of [servicetype][id] - discoveredRemoteServices = {}; + let discoveredRemoteServices = {}; addJsonEditorHostValidation(); + initializeUI(); + setupEditors(); + setupTokenManagement(); - if (window.showOptHelp) { - //network - $('#conf_cont').append(createRow('conf_cont_net')); - $('#conf_cont_net').append(createOptPanel('fa-sitemap', $.i18n("edt_conf_net_heading_title"), 'editor_container_net', 'btn_submit_net', 'panel-system')); - $('#conf_cont_net').append(createHelpTable(window.schema.network.properties, $.i18n("edt_conf_net_heading_title"))); - - //jsonserver - $('#conf_cont').append(createRow('conf_cont_json')); - $('#conf_cont_json').append(createOptPanel('fa-sitemap', $.i18n("edt_conf_js_heading_title"), 'editor_container_jsonserver', 'btn_submit_jsonserver', 'panel-system')); - $('#conf_cont_json').append(createHelpTable(window.schema.jsonServer.properties, $.i18n("edt_conf_js_heading_title"))); - - //flatbufserver - if (FLATBUF_SERVER_ENABLED) { - $('#conf_cont').append(createRow('conf_cont_flatbuf')); - $('#conf_cont_flatbuf').append(createOptPanel('fa-sitemap', $.i18n("edt_conf_fbs_heading_title"), 'editor_container_fbserver', 'btn_submit_fbserver', 'panel-system')); - $('#conf_cont_flatbuf').append(createHelpTable(window.schema.flatbufServer.properties, $.i18n("edt_conf_fbs_heading_title"), "flatbufServerHelpPanelId")); - } + removeOverlay(); - //protoserver - if (PROTOTBUF_SERVER_ENABLED) { - $('#conf_cont').append(createRow('conf_cont_proto')); - $('#conf_cont_proto').append(createOptPanel('fa-sitemap', $.i18n("edt_conf_pbs_heading_title"), 'editor_container_protoserver', 'btn_submit_protoserver', 'panel-system')); - $('#conf_cont_proto').append(createHelpTable(window.schema.protoServer.properties, $.i18n("edt_conf_pbs_heading_title"), "protoServerHelpPanelId")); + function initializeUI() { + if (window.showOptHelp) { + createSection("network", "edt_conf_network_heading_title", window.schema.network.properties); + createSection("jsonServer", "edt_conf_jsonServer_heading_title", window.schema.jsonServer.properties); + if (isFlatbufEnabled) createSection("flatbufServer", "edt_conf_flatbufServer_heading_title", window.schema.flatbufServer.properties, "flatbufServerHelpPanelId"); + if (isProtoBufEnabled) createSection("protoServer", "edt_conf_protoServer_heading_title", window.schema.protoServer.properties, "protoServerHelpPanelId"); + if (isForwarderEnabled && storedAccess !== 'default') createSection("forwarder", "edt_conf_forwarder_heading_title", window.schema.forwarder.properties, "forwarderHelpPanelId"); + } else { + $('#conf_cont').addClass('row'); + appendPanel("network", "edt_conf_network_heading_title"); + appendPanel("jsonServer", "edt_conf_jsonServer_heading_title"); + if (isFlatbufEnabled) appendPanel("flatbufServer", "edt_conf_flatbufSserver_heading_title"); + if (isProtoBufEnabled) appendPanel("protoServer", "edt_conf_protoServer_heading_title"); + if (isForwarderEnabled) appendPanel("forwarder", "edt_conf_forwarder_heading_title"); + $("#conf_cont_tok").removeClass('row'); } - //forwarder - if (FORWARDER_ENABLED) { - if (storedAccess != 'default') { - $('#conf_cont').append(createRow('conf_cont_fw')); - $('#conf_cont_fw').append(createOptPanel('fa-sitemap', $.i18n("edt_conf_fw_heading_title"), 'editor_container_forwarder', 'btn_submit_forwarder', 'panel-system')); - $('#conf_cont_fw').append(createHelpTable(window.schema.forwarder.properties, $.i18n("edt_conf_fw_heading_title"), "forwarderHelpPanelId")); - } + function createSection(id, titleKey, schemaProps, helpPanelId = null) { + const containerId = `conf_cont_${id}`; + $('#conf_cont').append(createRow(containerId)); + $(`#${containerId}`) + .append(createOptPanel('fa-sitemap', $.i18n(titleKey), `editor_container_${id}`, `btn_submit_${id}`, 'panel-system')) + .append(createHelpTable(schemaProps, $.i18n(titleKey), helpPanelId)); } - } - else { - $('#conf_cont').addClass('row'); - $('#conf_cont').append(createOptPanel('fa-sitemap', $.i18n("edt_conf_net_heading_title"), 'editor_container_net', 'btn_submit_net')); - $('#conf_cont').append(createOptPanel('fa-sitemap', $.i18n("edt_conf_js_heading_title"), 'editor_container_jsonserver', 'btn_submit_jsonserver')); - if (FLATBUF_SERVER_ENABLED) { - $('#conf_cont').append(createOptPanel('fa-sitemap', $.i18n("edt_conf_fbs_heading_title"), 'editor_container_fbserver', 'btn_submit_fbserver')); - } - if (PROTOTBUF_SERVER_ENABLED) { - $('#conf_cont').append(createOptPanel('fa-sitemap', $.i18n("edt_conf_pbs_heading_title"), 'editor_container_protoserver', 'btn_submit_protoserver')); - } - if (FORWARDER_ENABLED) { - $('#conf_cont').append(createOptPanel('fa-sitemap', $.i18n("edt_conf_fw_heading_title"), 'editor_container_forwarder', 'btn_submit_forwarder')); + + function appendPanel(id, titleKey) { + + const containerId = `conf_cont_${id}`; + + // Create the container element + const $newContainer = $('
    ', { id: containerId }); + + // Append the newly created container to #conf_cont + $('#conf_cont').append($newContainer); + + // Append the option panel inside the newly created container + $newContainer.append(createOptPanel('fa-sitemap', $.i18n(titleKey), `editor_container_${id}`, `btn_submit_${id}`, 'panel-system')); } - $("#conf_cont_tok").removeClass('row'); } - // net - conf_editor_net = createJsonEditor('editor_container_net', { - network: window.schema.network - }, true, true); + function setupEditors() { + createEditor("network", "network"); + createEditor("jsonServer", "jsonServer"); + if (isFlatbufEnabled) createEditor("flatbufServer", "flatbufServer", handleFlatbufChange); + if (isProtoBufEnabled) createEditor("protoServer", "protoServer", handleProtoBufChange); + if (isForwarderEnabled && storedAccess !== 'default') createEditor("forwarder", "forwarder", handleForwarderChange); + + const editorConfigs = [ + { key: "network", schemaKey: "network" }, + { key: "jsonServer", schemaKey: "jsonServer" }, + { key: "flatbufServer", schemaKey: "flatbufServer", enabled: isFlatbufEnabled, handler: handleFlatbufChange }, + { key: "protoServer", schemaKey: "protoServer", enabled: isProtoBufEnabled, handler: handleProtoBufChange }, + { key: "forwarder", schemaKey: "forwarder", enabled: isForwarderEnabled && storedAccess !== 'default', handler: handleForwarderChange } + ]; + + editorConfigs.forEach(({ key, schemaKey, enabled = true, handler }) => { + if (enabled) createEditor(key, schemaKey, handler); + }); - conf_editor_net.on('change', function () { - conf_editor_net.validate().length || window.readOnlyMode ? $('#btn_submit_net').prop('disabled', true) : $('#btn_submit_net').prop('disabled', false); - }); + function createEditor(container, schemaKey, changeHandler) { + editors[container] = createJsonEditor( + `editor_container_${container}`, + { [schemaKey]: window.schema[schemaKey] }, + true, + true + ); + + editors[container].on('change', function () { + const isValid = editors[container].validate().length === 0 && !window.readOnlyMode; + $(`#btn_submit_${container}`).prop('disabled', !isValid); + }); - $('#btn_submit_net').off().on('click', function () { - requestWriteConfig(conf_editor_net.getValue()); - }); + $(`#btn_submit_${container}`).off().on('click', function () { + requestWriteConfig(editors[container].getValue()); + }); - //json - conf_editor_json = createJsonEditor('editor_container_jsonserver', { - jsonServer: window.schema.jsonServer - }, true, true); + if (changeHandler) changeHandler(editors[container]); + } - conf_editor_json.on('change', function () { - conf_editor_json.validate().length || window.readOnlyMode ? $('#btn_submit_jsonserver').prop('disabled', true) : $('#btn_submit_jsonserver').prop('disabled', false); - }); + function handleFlatbufChange(editor) { + editor.on('change', () => toggleHelpPanel(editor, "flatbufServer", "flatbufServerHelpPanelId")); - $('#btn_submit_jsonserver').off().on('click', function () { - requestWriteConfig(conf_editor_json.getValue()); - }); + editor.watch('root.flatbufServer.enable', () => { + const enable = editor.getEditor("root.flatbufServer.enable").getValue(); + showInputOptionsForKey(editor, "flatbufServer", "enable", enable); + }); + } - //flatbuffer - if (FLATBUF_SERVER_ENABLED) { - conf_editor_fbs = createJsonEditor('editor_container_fbserver', { - flatbufServer: window.schema.flatbufServer - }, true, true); - - conf_editor_fbs.on('change', function () { - var flatbufServerEnable = conf_editor_fbs.getEditor("root.flatbufServer.enable").getValue(); - if (flatbufServerEnable) { - showInputOptionsForKey(conf_editor_fbs, "flatbufServer", "enable", true); - $('#flatbufServerHelpPanelId').show(); - } else { - showInputOptionsForKey(conf_editor_fbs, "flatbufServer", "enable", false); - $('#flatbufServerHelpPanelId').hide(); - } - conf_editor_fbs.validate().length || window.readOnlyMode ? $('#btn_submit_fbserver').prop('disabled', true) : $('#btn_submit_fbserver').prop('disabled', false); - }); + function handleProtoBufChange(editor) { + editor.on('change', () => toggleHelpPanel(editor, "protoServer", "protoServerHelpPanelId")); - $('#btn_submit_fbserver').off().on('click', function () { - requestWriteConfig(conf_editor_fbs.getValue()); - }); - } + editor.watch('root.protoServer.enable', () => { + const enable = editor.getEditor("root.protoServer.enable").getValue(); + showInputOptionsForKey(editor, "protoServer", "enable", enable); + }); + } + + function updateConfiguredInstancesList() { + const enumVals = []; + const enumTitelVals = []; + let enumDefaultVal = ""; + let addSelect = false; - //protobuffer - if (PROTOTBUF_SERVER_ENABLED) { - conf_editor_proto = createJsonEditor('editor_container_protoserver', { - protoServer: window.schema.protoServer - }, true, true); - - conf_editor_proto.on('change', function () { - var protoServerEnable = conf_editor_proto.getEditor("root.protoServer.enable").getValue(); - if (protoServerEnable) { - showInputOptionsForKey(conf_editor_proto, "protoServer", "enable", true); - $('#protoServerHelpPanelId').show(); + const configuredInstances = window.serverInfo.instance; + + if (!configuredInstances || Object.keys(configuredInstances).length === 0) { + enumVals.push("NONE"); + enumTitelVals.push($.i18n('edt_conf_forwarder_no_instance_configured_title')); } else { - showInputOptionsForKey(conf_editor_proto, "protoServer", "enable", false); - $('#protoServerHelpPanelId').hide(); - } - conf_editor_proto.validate().length || window.readOnlyMode ? $('#btn_submit_protoserver').prop('disabled', true) : $('#btn_submit_protoserver').prop('disabled', false); - }); + Object.values(configuredInstances).forEach(({ friendly_name, instance }) => { + enumTitelVals.push(friendly_name); + enumVals.push(instance.toString()); + }); - $('#btn_submit_protoserver').off().on('click', function () { - requestWriteConfig(conf_editor_proto.getValue()); - }); - } + const configuredInstance = window.serverConfig.forwarder.instance.toString(); - //forwarder - if (FORWARDER_ENABLED) { - if (storedAccess != 'default') { - conf_editor_forw = createJsonEditor('editor_container_forwarder', { - forwarder: window.schema.forwarder - }, true, true); + if (enumVals.includes(configuredInstance)) { + enumDefaultVal = configuredInstance; + } else { + addSelect = true; + } + } - conf_editor_forw.on('ready', function () { + if (enumVals.length > 0) { + updateJsonEditorSelection(editors["forwarder"], 'root.forwarder', + 'instanceList', {}, enumVals, enumTitelVals, enumDefaultVal, addSelect, false); + } + } + function handleForwarderChange(editor) { + editor.on('ready', () => { updateServiceCacheForwarderConfiguredItems("jsonapi"); updateServiceCacheForwarderConfiguredItems("flatbuffer"); - var forwarderEnable = conf_editor_forw.getEditor("root.forwarder.enable").getValue(); - if (forwarderEnable) { + if (editor.getEditor("root.forwarder.enable").getValue()) { + updateConfiguredInstancesList(); discoverRemoteHyperionServices("jsonapi"); discoverRemoteHyperionServices("flatbuffer"); - } - }); - - conf_editor_forw.on('change', function () { - var forwarderEnable = conf_editor_forw.getEditor("root.forwarder.enable").getValue(); - if (forwarderEnable) { - $('#forwarderHelpPanelId').show(); } else { - showInputOptionsForKey(conf_editor_forw, "forwarder", "enable", false); - $('#forwarderHelpPanelId').hide(); + showInputOptionsForKey(editor, "forwarder", "enable", false); } - conf_editor_forw.validate().length || window.readOnlyMode ? $('#btn_submit_forwarder').prop('disabled', true) : $('#btn_submit_forwarder').prop('disabled', false); }); - conf_editor_forw.watch('root.forwarder.jsonapiselect', () => { - updateForwarderServiceSections("jsonapi"); + editor.on('change', () => { + toggleHelpPanel(editor, "forwarder", "forwarderHelpPanelId"); }); - conf_editor_forw.watch('root.forwarder.flatbufferselect', () => { - updateForwarderServiceSections("flatbuffer"); + ["jsonapi", "flatbuffer"].forEach(function (type) { + editor.watch(`root.forwarder.${type}select`, () => { + updateForwarderServiceSections(type); + }); + editor.watch(`root.forwarder.${type}`, () => { + onChangeForwarderServiceSections(type); + }); }); - conf_editor_forw.watch('root.forwarder.enable', () => { + editor.watch('root.forwarder.enable', () => { + const isEnabled = editor.getEditor("root.forwarder.enable").getValue(); + if (isEnabled) { + + updateConfiguredInstancesList(); + + const instanceId = editor.getEditor("root.forwarder.instanceList").getValue(); + if (["NONE", "SELECT", "", undefined].includes(instanceId)) { + editor.getEditor("root.forwarder.instance").setValue(-1); + } - var forwarderEnable = conf_editor_forw.getEditor("root.forwarder.enable").getValue(); - if (forwarderEnable) { discoverRemoteHyperionServices("jsonapi"); discoverRemoteHyperionServices("flatbuffer"); + } else { + const instance = editor.getEditor("root.forwarder.instance").getValue(); + if (instance === -1) { + editor.getEditor("root.forwarder.instance").setValue(255); + } } + showInputOptionsForKey(editor, "forwarder", "enable", isEnabled); }); - $('#btn_submit_forwarder').off().on('click', function () { - requestWriteConfig(conf_editor_forw.getValue()); + editor.watch('root.forwarder.instanceList', () => { + const instanceId = editor.getEditor("root.forwarder.instanceList").getValue(); + if (!["NONE", "SELECT", "", undefined].includes(instanceId)) { + editor.getEditor("root.forwarder.instance").setValue(parseInt(instanceId, 10)); + } }); } - } - //create introduction - if (window.showOptHelp) { - createHint("intro", $.i18n('conf_network_net_intro'), "editor_container_net"); - createHint("intro", $.i18n('conf_network_json_intro'), "editor_container_jsonserver"); - if (FLATBUF_SERVER_ENABLED) { - createHint("intro", $.i18n('conf_network_fbs_intro'), "editor_container_fbserver"); - } - if (PROTOTBUF_SERVER_ENABLED) { - createHint("intro", $.i18n('conf_network_proto_intro'), "editor_container_protoserver"); + function toggleHelpPanel(editor, key, panelId) { + const enable = editor.getEditor(`root.${key}.enable`).getValue(); + $(`#${panelId}`).toggle(enable); } - if (FORWARDER_ENABLED) { - createHint("intro", $.i18n('conf_network_forw_intro'), "editor_container_forwarder"); - } - createHint("intro", $.i18n('conf_network_tok_intro'), "tok_desc_cont"); } - // Token handling - function buildTokenList() { - $('.tktbody').html(""); - for (var key in tokenList) { - var lastUse = (tokenList[key].last_use) ? tokenList[key].last_use : "-"; - var btn = ''; - $('.tktbody').append(createTableRow([tokenList[key].id, tokenList[key].comment, lastUse, btn], false, true)); - $('#tok' + tokenList[key].id).off().on('click', handleDeleteToken); + // Validate for conflicting ports + JSONEditor.defaults.custom_validators.push(function (schema, value, path) { + let errors = []; + + const conflictingPorts = { + "root.jsonServer.port": ["flatbufServer", "protoServer", "webConfig_port", "webConfig_sslPort"], + "root.flatbufServer.port": ["jsonServer", "protoServer", "webConfig_port", "webConfig_sslPort"], + "root.protoServer.port": ["jsonServer", "flatbufServer", "webConfig_port", "webConfig_sslPort"] + }; + + if (!(path in conflictingPorts)) { + return []; } - } - createTable('tkthead', 'tktbody', 'tktable'); - $('.tkthead').html(createTableRow([$.i18n('conf_network_tok_idhead'), $.i18n('conf_network_tok_cidhead'), $.i18n('conf_network_tok_lastuse'), $.i18n('general_btn_delete')], true, true)); - buildTokenList(); - - function handleDeleteToken(e) { - var key = e.currentTarget.id.replace("tok", ""); - requestTokenDelete(key); - $('#tok' + key).parent().parent().remove(); - // rm deleted token id - tokenList = tokenList.filter(function (obj) { - return obj.id !== key; + conflictingPorts[path].forEach(conflictKey => { + let conflictPort; + + const isWebConfigPort = conflictKey.startsWith("webConfig"); + if (isWebConfigPort) { + conflictPort = window.serverConfig?.webConfig?.[conflictKey.replace("webConfig_", "")]; + } else { + conflictPort = editors?.[conflictKey]?.getEditor(`root.${conflictKey}.port`)?.getValue(); + } + + if (conflictPort != null && value === conflictPort) { + let errorText; + + if (isWebConfigPort) { + errorText = $.i18n("edt_conf_webConfig_heading_title") + " - " + $.i18n(`edt_conf_${conflictKey}_title`); + } else { + errorText = $.i18n(`edt_conf_${conflictKey}_heading_title`); + } + + errors.push({ + path: path, + property: "port", + message: $.i18n('edt_conf_network_port_validation_error', errorText) + }); + } + }); - } - $('#btn_create_tok').off().on('click', function () { - requestToken(encodeHTML($('#tok_comment').val())) - $('#tok_comment').val("") - $('#btn_create_tok').prop('disabled', true) - }); - $('#tok_comment').off().on('input', function (e) { - (e.currentTarget.value.length >= 10) ? $('#btn_create_tok').prop('disabled', false) : $('#btn_create_tok').prop('disabled', true); - if (10 - e.currentTarget.value.length >= 1 && 10 - e.currentTarget.value.length <= 9) - $('#tok_chars_needed').html(10 - e.currentTarget.value.length + " " + $.i18n('general_chars_needed')) - else - $('#tok_chars_needed').html("
    ") - }); - $(window.hyperion).off("cmd-authorize-createToken").on("cmd-authorize-createToken", function (event) { - var val = event.response.info; - showInfoDialog("newToken", $.i18n('conf_network_tok_diaTitle'), $.i18n('conf_network_tok_diaMsg') + '
    ' + val.token + '
    ') - tokenList.push(val) - buildTokenList() + return errors; }); - //Reorder hardcoded token div after the general token setting div - $("#conf_cont_tok").insertAfter("#conf_cont_net"); + function setupTokenManagement() { + createTable('tkthead', 'tktbody', 'tktable'); + $('.tkthead').html(createTableRow([$.i18n('conf_network_tok_idhead'), $.i18n('conf_network_tok_cidhead'), $.i18n('conf_network_tok_lastuse'), $.i18n('general_btn_delete')], true, true)); - function checkApiTokenState(state) { - if (state == false) - $("#conf_cont_tok").attr('style', 'display:none') - else - $("#conf_cont_tok").removeAttr('style') - } + buildTokenList(); - $('#root_network_apiAuth').on("change", function () { - var state = $(this).is(":checked"); - checkApiTokenState(state); - }); + // Reorder hardcoded token div after the general token setting div + $("#conf_cont_tok").insertAfter("#conf_cont_network"); - checkApiTokenState(window.serverConfig.network.apiAuth); + // Initial state check based on server config + checkApiTokenState(window.serverConfig.network.internetAccessAPI || window.serverConfig.network.localApiAuth || storedAccess === 'expert'); - removeOverlay(); + // Listen for changes on the Internet access API Auth toggle + $('#root_network_internetAccessAPI').on("change", function () { + checkApiTokenState($(this).is(":checked") || $('#root_network_localApiAuth').is(":checked")); + }); - function updateForwarderServiceSections(type) { + // Listen for changes on the local API Auth toggle + $('#root_network_localApiAuth').on("change", function () { + checkApiTokenState($(this).is(":checked") || $('#root_network_internetAccessAPI').is(":checked")); + }); - var editorPath = "root.forwarder." + type; - var selectedServices = conf_editor_forw.getEditor(editorPath + "select").getValue(); + $('#btn_create_tok').off().on('click', function () { + requestToken(encodeHTML($('#tok_comment').val())); + $('#tok_comment').val("").prop('disabled', true); + }); - if (jQuery.isEmptyObject(selectedServices) || selectedServices[0] === "NONE") { - conf_editor_forw.getEditor(editorPath).setValue([]); - showInputOptionForItem(conf_editor_forw, "forwarder", type, false); - } else { + $('#tok_comment').off().on('input', function (e) { + const charsNeeded = 10 - e.currentTarget.value.length; + $('#btn_create_tok').prop('disabled', charsNeeded > 0); + $('#tok_chars_needed').html(charsNeeded > 0 ? `${charsNeeded} ${$.i18n('general_chars_needed')}` : "
    "); + }); - var newServices = []; - for (var i = 0; i < selectedServices.length; ++i) { + $(window.hyperion).off("cmd-authorize-createToken").on("cmd-authorize-createToken", function (event) { + const val = event.response.info; + showInfoDialog("newToken", $.i18n('conf_network_tok_diaTitle'), $.i18n('conf_network_tok_diaMsg') + `
    ${val.token}
    `); + tokenList.push(val); + buildTokenList(); + }); - var service = discoveredRemoteServices[type][selectedServices[i]]; - var newrecord = {}; + function buildTokenList() { + $('.tktbody').empty(); + tokenList.forEach(token => { + const lastUse = token.last_use || "-"; + const btn = ``; + $('.tktbody').append(createTableRow([token.id, token.comment, lastUse, btn], false, true)); + $(`#tok${token.id}`).off().on('click', () => handleDeleteToken(token.id)); + }); + } - newrecord.name = service.name; - newrecord.host = service.host; - newrecord.port = service.port; + function handleDeleteToken(id) { + requestTokenDelete(id); + tokenList = tokenList.filter(token => token.id !== id); + buildTokenList(); + } - newServices.push(newrecord); + function checkApiTokenState(state) { + if (!state) { + $("#conf_cont_tok").hide(); + } else { + $("#conf_cont_tok").show(); } - conf_editor_forw.getEditor(editorPath).setValue(newServices); - - showInputOptionForItem(conf_editor_forw, "forwarder", type, true); - conf_editor_forw.getEditor(editorPath).disable(); } } - function updateForwarderSelectList(type) { + function onChangeForwarderServiceSections(type) { + const editor = editors["forwarder"].getEditor(`root.forwarder.${type}`); + const configuredServices = JSON.parse(JSON.stringify(editor?.getValue('items'))); - var selectionElement = type + "select"; + configuredServices.forEach((serviceConfig, i) => { + const itemEditor = editors["forwarder"].getEditor(`root.forwarder.${type}.${i}`); + const service = discoveredRemoteServices[type]?.[serviceConfig.host]; - var enumVals = []; - var enumTitelVals = []; - var enumDefaultVals = []; + if (service?.wasDiscovered) { + itemEditor?.disable(); - for (var key in discoveredRemoteServices[type]) { + const instanceIdsEditor = editors["forwarder"].getEditor(`root.forwarder.${type}.${i}.instanceIds`); + instanceIdsEditor?.enable(); - var service = discoveredRemoteServices[type][key]; - enumVals.push(service.host); - enumTitelVals.push(service.name); + showInputOptions(`root.forwarder.${type}.${i}`, ["name"], true); + } else { + itemEditor?.enable(); + showInputOptions(`root.forwarder.${type}.${i}`, ["name"], false); + + if (!service) { + const hostEditor = editors["forwarder"].getEditor(`root.forwarder.${type}.${i}.host`); + if (hostEditor?.getValue()) { + updateServiceCacheForwarderConfiguredItems(type); + updateForwarderSelectList(type); + } + } + } + }); + } + + function updateForwarderServiceSections(type) { + const editorPath = `root.forwarder.${type}`; + const selectedServices = editors["forwarder"].getEditor(`${editorPath}select`).getValue(); + + if (!selectedServices || selectedServices.length === 0 || ["NONE", "SELECT"].includes(selectedServices[0])) { + return; + } + + const newServices = selectedServices.map((serviceKey) => { + const service = discoveredRemoteServices[type][serviceKey]; + return { + name: service.name, + host: service.host, + port: service.port, + instanceIds: service.instanceIds, + wasDiscovered: service.wasDiscovered + }; + }); + + editors["forwarder"].getEditor(editorPath).setValue(newServices); + } + + function updateForwarderSelectList(type) { + const selectionElement = `${type}select`; - if (service.inConfig == true) { + const enumVals = []; + const enumTitleVals = []; + const enumDefaultVals = []; + + Object.values(discoveredRemoteServices[type]).forEach(service => { + enumVals.push(service.host); + enumTitleVals.push(service.name); + if (service.inConfig) { enumDefaultVals.push(service.host); } - } + }); - let addSchemaElements = { - "uniqueItems": true - }; + const addSchemaElements = { "uniqueItems": true }; - if (jQuery.isEmptyObject(enumVals)) { + if (enumVals.length === 0) { enumVals.push("NONE"); - enumTitelVals.push($.i18n('edt_conf_fw_remote_service_discovered_none')); + enumTitleVals.push($.i18n('edt_conf_forwarder_remote_service_discovered_none')); } - updateJsonEditorMultiSelection(conf_editor_forw, 'root.forwarder', selectionElement, addSchemaElements, enumVals, enumTitelVals, enumDefaultVals); - }; + updateJsonEditorMultiSelection( + editors["forwarder"], + 'root.forwarder', + selectionElement, + addSchemaElements, + enumVals, + enumTitleVals, + enumDefaultVals + ); + } function updateServiceCacheForwarderConfiguredItems(serviceType) { - - var editor = conf_editor_forw.getEditor("root.forwarder." + serviceType); + const editor = editors["forwarder"].getEditor(`root.forwarder.${serviceType}`); if (editor) { if (!discoveredRemoteServices[serviceType]) { discoveredRemoteServices[serviceType] = {}; } - var configuredServices = JSON.parse(JSON.stringify(editor.getValue('items'))); - for (const service of configuredServices) { - - //Handle not named sceanrios - if (!service.name) { - service.name = service.host; - } - + const configuredServices = JSON.parse(JSON.stringify(editor.getValue('items'))); + configuredServices.forEach((service) => { service.inConfig = true; - - discoveredRemoteServices[serviceType][service.host] = service; - } + let existingService = discoveredRemoteServices[serviceType][service.host] || {}; + discoveredRemoteServices[serviceType][service.host] = { ...existingService, ...service }; + }); } } function updateRemoteServiceCache(discoveryInfo) { + Object.entries(discoveryInfo).forEach(([serviceType, discoveredServices]) => { + discoveredRemoteServices[serviceType] = discoveredRemoteServices[serviceType] || {}; - for (var serviceType in discoveryInfo) { + discoveredServices.forEach((service) => { + if (!service.sameHost) { + service.name = service.name || service.host; + service.host = service.service || service.host; + service.wasDiscovered = Boolean(service.service); - if (!discoveredRemoteServices[serviceType]) { - discoveredRemoteServices[serviceType] = {}; - } - - var discoveredServices = discoveryInfo[serviceType]; - for (const service of discoveredServices) { - - if (!service.sameHost) - { - //Handle non mDNS sceanrios - if (!service.name) { - service.name = service.host; - } else { - service.host = service.service; - } + // Might be updated when instance IDs are provided by the remote service info + service.instanceIds = []; if (discoveredRemoteServices[serviceType][service.host]) { service.inConfig = true; + service.instanceIds = discoveredRemoteServices[serviceType][service.host].instanceIds; } discoveredRemoteServices[serviceType][service.host] = service; } - } - } - }; + }); + }); + } async function discoverRemoteHyperionServices(type, params) { - const result = await requestServiceDiscovery(type, params); - var discoveryResult; - if (result && !result.error) { - discoveryResult = result.info; - } - else { - discoveryResult = { - "services": [] - }; - } + const discoveryResult = result && !result.error ? result.info : { services: [] }; - switch (type) { - case "jsonapi": - case "flatbuffer": - updateRemoteServiceCache(discoveryResult.services); - updateForwarderSelectList(type); - break; + if (["jsonapi", "flatbuffer"].includes(type)) { + updateRemoteServiceCache(discoveryResult.services); + updateForwarderSelectList(type); } - }; + } }); - diff --git a/assets/webconfig/js/content_remote.js b/assets/webconfig/js/content_remote.js index 45d7912a2..58f8ea0cc 100644 --- a/assets/webconfig/js/content_remote.js +++ b/assets/webconfig/js/content_remote.js @@ -1,25 +1,31 @@ $(document).ready(function () { + + const DEFAULT_CPCOLOR = '#B500FF'; + const BG_PRIORITY = 254; + + // Perform initial translation setup performTranslation(); - var EFFECTENGINE_ENABLED = (jQuery.inArray("effectengine", window.serverInfo.services) !== -1); + // Check if the effect engine is enabled + const EFFECTENGINE_ENABLED = (jQuery.inArray("effectengine", window.serverInfo.services) !== -1); - // update instance listing + // Update the list of Hyperion instances updateHyperionInstanceListing(); - var oldEffects = []; - var cpcolor = '#B500FF'; - var mappingList = window.serverSchema.properties.color.properties.imageToLedMappingType.enum; - var duration = ENDLESS; - var rgb = { r: 255, g: 0, b: 0 }; - var lastImgData = ""; - var lastFileName = ""; + // Initialize variables + let oldEffects = []; + const mappingList = window.serverSchema.properties.color.properties.imageToLedMappingType.enum; + let uiInputDuration_s = 0; // Endless + let rgb = { r: 255, g: 0, b: 0 }; + let lastImgData = ""; + let lastFileName = ""; - //create html + // Create initial HTML structure createTable('ssthead', 'sstbody', 'sstcont'); $('.ssthead').html(createTableRow([$.i18n('remote_input_origin'), $.i18n('remote_input_owner'), $.i18n('remote_input_priority'), $.i18n('remote_input_status')], true, true)); createTable('crthead', 'crtbody', 'adjust_content', true); - //create introduction + // Create introduction hints if the help option is enabled if (window.showOptHelp) { createHint("intro", $.i18n('remote_color_intro', $.i18n('remote_losthint')), "color_intro"); createHint("intro", $.i18n('remote_input_intro', $.i18n('remote_losthint')), "sstcont"); @@ -29,416 +35,500 @@ $(document).ready(function () { createHint("intro", $.i18n('remote_videoMode_intro', $.i18n('remote_losthint')), "videomode_intro"); } + // Hide color effect table and reset color button if current instance is not running + if (!isCurrentInstanceRunning()) { + $("#color_effect_table").hide(); + $("#reset_color").hide(); + removeOverlay(); + return; + } + + // Function to send the selected effect function sendEffect() { - var efx = $("#effect_select").val(); - if (efx != "__none__") { + const effect = $("#effect_select").val(); + if (effect !== "__none__") { requestPriorityClear(); - $(window.hyperion).one("cmd-clear", function (event) { - setTimeout(function () { requestPlayEffect(efx, duration) }, 100); + $(window.hyperion).one("cmd-clear", function () { + setTimeout(function () { requestPlayEffect(effect, uiInputDuration_s); }, 100); }); } } + // Function to send the selected color function sendColor() { - requestSetColor(rgb.r, rgb.g, rgb.b, duration); + requestSetColor(rgb.r, rgb.g, rgb.b, uiInputDuration_s); } + // Update the channel adjustments function updateChannelAdjustments() { + if (!window.serverInfo.adjustment || window.serverInfo.adjustment.length === 0) return; $('.crtbody').html(""); - var sColor = sortProperties(window.serverSchema.properties.color.properties.channelAdjustment.items.properties); - var values = window.serverInfo.adjustment[0]; - - for (var key in sColor) { - if (sColor[key].key != "id" && sColor[key].key != "leds") { - var title = ''; - var property; - var value = values[sColor[key].key]; - - if (sColor[key].type == "array") { - property = '
    '; + const sColor = sortProperties(window.serverSchema.properties.color.properties.channelAdjustment.items.properties); + const values = window.serverInfo.adjustment[0]; + + for (const key in sColor) { + if (sColor[key].key !== "id" && sColor[key].key !== "leds") { + const title = ``; + let property; + const value = values[sColor[key].key]; + + // Handle array type adjustments + if (sColor[key].type === "array") { + property = `
    + + +
    `; $('.crtbody').append(createTableRow([title, property], false, true)); - createCP('cr_' + sColor[key].key, value, function (rgb, hex, e) { - requestAdjustment(e.target.id.substr(e.target.id.indexOf("_") + 1), '[' + rgb.r + ',' + rgb.g + ',' + rgb.b + ']'); + createCP(`cr_${sColor[key].key}`, value, function (rgb, hex, e) { + const elementName = e.target.id.substr(e.target.id.indexOf("_") + 1); + requestAdjustment(elementName, [rgb.r,rgb.g,rgb.b]); }); } - else if (sColor[key].type == "boolean") { - property = '
    '; + // Handle boolean type adjustments + else if (sColor[key].type === "boolean") { + property = `
    + + +
    `; $('.crtbody').append(createTableRow([title, property], false, true)); $('#cr_' + sColor[key].key).off().on('change', function (e) { - requestAdjustment(e.target.id.substr(e.target.id.indexOf("_") + 1), e.currentTarget.checked); + const elementName = e.target.id.substr(e.target.id.indexOf("_") + 1); + requestAdjustment(elementName, e.currentTarget.checked); }); } + // Handle number type adjustments else { - if (sColor[key].key == "brightness" || - sColor[key].key == "brightnessCompensation" || - sColor[key].key == "backlightThreshold" || - sColor[key].key == "saturationGain" || - sColor[key].key == "brightnessGain" || - sColor[key].key == "temperature" ) { - - property = ''; - if (sColor[key].append && sColor[key].append !== "" ) { - property = '
    ' + property + '' + $.i18n(sColor[key].append) + '
    '; + if (["brightness", "brightnessCompensation", "backlightThreshold", "saturationGain", "brightnessGain", "temperature"].includes(sColor[key].key)) { + property = ``; + if (sColor[key].append && sColor[key].append !== "") { + property = `
    ${property}${$.i18n(sColor[key].append)}
    `; } - } - else { - property = ''; + } else { + property = ``; } $('.crtbody').append(createTableRow([title, property], false, true)); $('#cr_' + sColor[key].key).off().on('change', function (e) { - valValue(this.id, this.value, this.min, this.max); - requestAdjustment(e.target.id.substr(e.target.id.indexOf("_") + 1), e.currentTarget.value); + const elementName = e.target.id.substr(e.target.id.indexOf("_") + 1); + const value = valValue(this.id, this.value, this.min, this.max); + requestAdjustment(elementName, value); }); } } } } + // Update input select options based on priorities function updateInputSelect() { + // Clear existing elements $('.sstbody').empty(); - var prios = window.serverInfo.priorities; - var clearAll = false; - - for (var i = 0; i < prios.length; i++) { - var origin = prios[i].origin ? prios[i].origin : "System"; - origin = origin.split("@"); - var ip = origin[1]; - origin = origin[0]; - - var owner = prios[i].owner; - var active = prios[i].active; - var visible = prios[i].visible; - var priority = prios[i].priority; - var compId = prios[i].componentId; - var duration = prios[i].duration_ms / 1000; - var value = "0,0,0"; - var btn_type = "default"; - var btn_text = $.i18n('remote_input_setsource_btn'); - var btn_state = "enabled"; - - if (active) - btn_type = "primary"; - - if (priority > 254) - continue; - if (priority < 254 && (compId == "EFFECT" || compId == "COLOR" || compId == "IMAGE")) - clearAll = true; + + const prios = window.serverInfo.priorities; + let clearAll = false; + + // Iterate over priorities + for (let i = 0; i < prios.length; i++) { + let origin = prios[i].origin ? prios[i].origin : "System"; + const [originName, ip] = origin.split("@"); + origin = originName; + + let { + owner, + active, + visible, + priority, + componentId, + duration_ms + } = prios[i]; + + const remoteInputDuration_s = duration_ms / 1000; + let value = "0,0,0"; + let btnType = "default"; + let btnText = $.i18n('remote_input_setsource_btn'); + let btnState = "enabled"; + + if (active) btnType = "primary"; + if (priority > BG_PRIORITY) continue; + if (priority < BG_PRIORITY && ["EFFECT", "COLOR", "IMAGE"].includes(componentId)) clearAll = true; if (visible) { - btn_state = "disabled"; - btn_type = "success"; - btn_text = $.i18n('remote_input_sourceactiv_btn'); + btnState = "disabled"; + btnType = "success"; + btnText = $.i18n('remote_input_sourceactiv_btn'); + } + + if (ip) { + origin += `
    ${$.i18n('remote_input_ip')} ${ip}`; } - if (ip) - origin += '
    ' + $.i18n('remote_input_ip') + ' ' + ip + ''; + if ("value" in prios[i]) value = prios[i].value.RGB; - if ("value" in prios[i]) - value = prios[i].value.RGB; + // Determine owner description based on component ID + let ownerText = owner; - switch (compId) { + switch (componentId) { case "EFFECT": - owner = $.i18n('remote_effects_label_effects') + ' ' + owner; + ownerText = $.i18n('remote_effects_label_effects') + " " + owner; break; case "COLOR": - owner = $.i18n('remote_color_label_color') + ' ' + '
    '; + ownerText = $.i18n('remote_color_label_color') + ' ' + + `
    `; break; case "IMAGE": - owner = $.i18n('remote_effects_label_picture') + (owner !== undefined ? (' ' + owner) : ""); + ownerText = $.i18n('remote_effects_label_picture') + (owner ? ` ${owner}` : ""); break; case "GRABBER": - owner = $.i18n('general_comp_GRABBER') + ': (' + owner + ')'; - break; case "V4L": - owner = $.i18n('general_comp_V4L') + ': (' + owner + ')'; - break; - case "AUDIO": - owner = $.i18n('general_comp_AUDIO') + ': (' + owner + ')'; + case "AUDIO": + ownerText = `${$.i18n("general_comp_" + componentId)}: (${owner})`; break; case "BOBLIGHTSERVER": - owner = $.i18n('general_comp_BOBLIGHTSERVER'); - break; case "FLATBUFSERVER": - owner = $.i18n('general_comp_FLATBUFSERVER'); - break; - case "PROTOSERVER": - owner = $.i18n('general_comp_PROTOSERVER'); + case "PROTOSERVER": + ownerText = `${$.i18n("general_comp_" + componentId)})`; break; } - if (!(duration && duration < 0)) { - if (duration && compId != "GRABBER" && compId != "FLATBUFSERVER" && compId != "PROTOSERVER") - owner += '
    ' + $.i18n('remote_input_duration') + ' ' + duration.toFixed(0) + $.i18n('edt_append_s') + ''; + if (remoteInputDuration_s > 0 && !["GRABBER", "FLATBUFSERVER", "PROTOSERVER"].includes(componentId)) { + ownerText += `
    ${$.i18n('remote_input_duration')} + ${remoteInputDuration_s.toFixed(0)}${$.i18n('edt_append_s')}`; + } - var btn = ''; + if (!remoteInputDuration_s || remoteInputDuration_s > 0 ) { + // Create buttons + let btn = ``; - if ((compId == "EFFECT" || compId == "COLOR" || compId == "IMAGE") && priority < 254) - btn += ''; + if (["EFFECT", "COLOR", "IMAGE"].includes(componentId) && priority < BG_PRIORITY) { + btn += ``; + } - if (btn_type != 'default') - $('.sstbody').append(createTableRow([origin, owner, priority, btn], false, true)); + if (btnType !== 'default') { + $('.sstbody').append(createTableRow([origin, ownerText, priority, btn], false, true)); + } } } - var btn_auto_color = (window.serverInfo.priorities_autoselect ? "btn-success" : "btn-danger"); - var btn_auto_state = (window.serverInfo.priorities_autoselect ? "disabled" : "enabled"); - var btn_auto_text = (window.serverInfo.priorities_autoselect ? $.i18n('general_btn_on') : $.i18n('general_btn_off')); - var btn_call_state = (clearAll ? "enabled" : "disabled"); - $('#auto_btn').html(''); - $('#auto_btn').append(''); - - var max_width = 100; + + // Auto-select and Clear All buttons + const autoColor = window.serverInfo.priorities_autoselect ? "btn-success" : "btn-danger"; + const autoState = window.serverInfo.priorities_autoselect ? "disabled" : "enabled"; + const autoText = window.serverInfo.priorities_autoselect ? $.i18n('general_btn_on') : $.i18n('general_btn_off'); + const callState = clearAll ? "enabled" : "disabled"; + + $('#auto_btn').html(` + + `); + + $('#auto_btn').append(` + + `); + + // Adjust button widths + let maxWidth = 100; $('.btn_input_selection').each(function () { - if ($(this).innerWidth() > max_width) - max_width = $(this).innerWidth(); + if ($(this).innerWidth() > maxWidth) maxWidth = $(this).innerWidth(); }); - $('.btn_input_selection').css("min-width", max_width + "px"); + $('.btn_input_selection').css("min-width", maxWidth + "px"); } - function updateLedMapping() { - var mapping = window.serverInfo.imageToLedMappingType; - - $('#mappingsbutton').html(""); - for (var ix = 0; ix < mappingList.length; ix++) { - if (mapping == mappingList[ix]) - var btn_style = 'btn-success'; - else - var btn_style = 'btn-primary'; - $('#mappingsbutton').append('
    '); - } + function updateLedMapping() { + const mapping = window.serverInfo.imageToLedMappingType; + + // Clear existing mappings + $('#mappingsbutton').empty(); + + mappingList.forEach((mapType) => { + const btnStyle = (mapping === mapType) ? 'btn-success' : 'btn-primary'; + const btnText = $.i18n(`remote_maptype_label_${mapType}`); + + $('#mappingsbutton').append(` +
    + `); + }); } function initComponents() { - var components = window.comps; - var hyperionEnabled = true; - components.forEach(function (obj) { - if (obj.name == "ALL") { - hyperionEnabled = obj.enabled; + const components = window.comps; + const hyperionEnabled = components.some(comp => comp.name === "ALL" && comp.enabled); + + components.forEach((comp) => { + // Skip if component is disabled or not relevant + if (shouldSkipComponent(comp)) return; + + const compBtnId = `comp_btn_${comp.name}`; + const checkedStatus = comp.enabled ? "checked" : ""; + const componentHtml = ` + + + + `; + + // Append component toggle button if not already created + if (!$(`#${compBtnId}`).length) { + $('#componentsbutton').append(componentHtml); + $(`#${compBtnId}`).bootstrapToggle(); + $(`#${compBtnId}`).bootstrapToggle(hyperionEnabled ? "enable" : "disable"); + $(`#${compBtnId}`).on("change", e => { + const compName = $(e.currentTarget).data("name"); + requestSetComponentState(compName, e.currentTarget.checked); + }); } }); + } - for (const comp of components) { - if (comp.name === "ALL" || (comp.name === "FORWARDER" && window.currentHyperionInstance != 0) || - (comp.name === "GRABBER" && !window.serverConfig.framegrabber.enable) || - (comp.name === "V4L" && !window.serverConfig.grabberV4L2.enable) || - (comp.name === "AUDIO" && !window.serverConfig.grabberAudio.enable)) - continue; - - const enable_style = (comp.enabled ? "checked" : ""); - const comp_btn_id = "comp_btn_" + comp.name; - - if ($("#" + comp_btn_id).length === 0) { - var d = '' - + ' ' - + ''; - - $('#componentsbutton').append(d); - $(`#${comp_btn_id}`).bootstrapToggle(); - $(`#${comp_btn_id}`).bootstrapToggle((hyperionEnabled ? "enable" : "disable")); - $(`#${comp_btn_id}`).on("change", e => { - requestSetComponentState(e.currentTarget.id.split('_').pop(), e.currentTarget.checked); - }); - } - } + function shouldSkipComponent(comp) { + // Define conditions to skip certain components + const skipConditions = { + "ALL": false, + "FORWARDER": window.currentHyperionInstance !== window.serverConfig.forwarder.instance, + "GRABBER": !window.serverConfig.framegrabber.enable, + "V4L": !window.serverConfig.grabberV4L2.enable, + "AUDIO": !window.serverConfig.grabberAudio.enable + }; + + return skipConditions[comp.name] || comp.name === "ALL"; } function updateComponent(component) { - if (component.name == "ALL") { - var components = window.comps; - var hyperionEnabled = component.enabled; - for (const comp of components) { + if (component.name === "ALL") { + updateAllComponents(component.enabled); + } else { + updateSingleComponent(component); + } + } - if (comp.name === "ALL") - continue; + function updateAllComponents(enabled) { + window.comps.forEach((comp) => { + if (comp.name === "ALL") return; - const comp_btn_id = "comp_btn_" + comp.name; + const compBtnId = `comp_btn_${comp.name}`; + const toggle = $(`#${compBtnId}`).bootstrapToggle(); - if (!hyperionEnabled) { - $(`#${comp_btn_id}`).bootstrapToggle('off'); - $(`#${comp_btn_id}`).bootstrapToggle("disable"); - } - else { - $(`#${comp_btn_id}`).bootstrapToggle("enable"); - if (comp.enabled !== $(`#${comp_btn_id}`).prop("checked")) { - $(`#${comp_btn_id}`).bootstrapToggle().prop('checked', comp.enabled).change(); - } - } - } - } - else { - const comp_btn_id = "comp_btn_" + component.name; - - //console.log ("updateComponent: ", component.name, "Current Checked: ", $(`#${comp_btn_id}`).prop("checked"), "New Checked: ", component.enabled, ); - - // In case Buttons were disabled before, status may be different to component status - if (component.enabled != $(`#${comp_btn_id}`).prop("checked")) { - // console.log ("Update status to Checked = ", component.enabled); - if (component.enabled) - $(`#${comp_btn_id}`).bootstrapToggle("on"); - else - $(`#${comp_btn_id}`).bootstrapToggle("off"); + if (!enabled) { + toggle.bootstrapToggle("off"); + toggle.bootstrapToggle("disable"); + } else { + toggle.bootstrapToggle("enable"); + updateSingleComponent(comp); } + }); + } + + function updateSingleComponent(component) { + const compBtnId = `comp_btn_${component.name}`; + const toggle = $(`#${compBtnId}`).bootstrapToggle(); + + if (component.enabled !== $(`#${compBtnId}`).prop("checked")) { + toggle.bootstrapToggle(component.enabled ? "on" : "off"); } } + // Update Effect List function updateEffectlist() { - var newEffects = window.serverInfo.effects; - if (newEffects.length != oldEffects.length) { + const newEffects = window.serverInfo.effects; + + if (newEffects.length !== oldEffects.length) { $('#effect_select').html(''); - var usrEffArr = []; - var sysEffArr = []; + const usrEffArr = []; + const sysEffArr = []; + + newEffects.forEach(effect => { + const effectName = effect.name; + const effectArr = effect.file.startsWith(":") ? sysEffArr : usrEffArr; + effectArr.push(effectName); + }); + + $('#effect_select') + .append(createSel(usrEffArr, $.i18n('remote_optgroup_usreffets'))) + .append(createSel(sysEffArr, $.i18n('remote_optgroup_syseffets'))); - for (var i = 0; i < newEffects.length; i++) { - var effectName = newEffects[i].name; - if (!/^\:/.test(newEffects[i].file)) { - usrEffArr.push(effectName); - } - else { - sysEffArr.push(effectName); - } - } - $('#effect_select').append(createSel(usrEffArr, $.i18n('remote_optgroup_usreffets'))); - $('#effect_select').append(createSel(sysEffArr, $.i18n('remote_optgroup_syseffets'))); oldEffects = newEffects; } } + // Update Video Mode function updateVideoMode() { - var videoModes = ["2D", "3DSBS", "3DTAB"]; - var currVideoMode = window.serverInfo.videomode; - - $('#videomodebtns').html(""); - for (var ix = 0; ix < videoModes.length; ix++) { - if (currVideoMode == videoModes[ix]) - var btn_style = 'btn-success'; - else - var btn_style = 'btn-primary'; - $('#videomodebtns').append('
    '); - } + const videoModes = ["2D", "3DSBS", "3DTAB"]; + const currVideoMode = window.serverInfo.videomode; + + $('#videomodebtns').empty(); + videoModes.forEach(mode => { + const btnStyle = currVideoMode === mode ? 'btn-success' : 'btn-primary'; + const buttonHtml = `
    `; + + $('#videomodebtns').append(buttonHtml); + }); } - // colorpicker and effect - if (getStorage('rmcpcolor') != null) { - cpcolor = getStorage('rmcpcolor'); - rgb = hexToRgb(cpcolor); - } + // Initialize Color Picker and Effects + function initColorPickerAndEffects() { + let cpcolor = getStorage('rmcpcolor') || DEFAULT_CPCOLOR; + if (cpcolor) rgb = hexToRgb(cpcolor); - if (getStorage('rmduration') != null) { - $("#remote_duration").val(getStorage('rmduration')); - duration = getStorage('rmduration'); - if (duration == 0) { - duration = ENDLESS; + const storedDuration = getStorage('rmduration'); + if (storedDuration) { + uiInputDuration_s = Number(storedDuration); + $("#remote_duration").val(uiInputDuration_s); + updateDurationPlaceholder(); // Update the placeholder for "Endless" } + + createCP('cp2', cpcolor, function (rgbT, hex) { + rgb = rgbT; + sendColor(); + setStorage('rmcpcolor', hex); + updateInputSelect(); + }); + + setupEventListeners(); } - createCP('cp2', cpcolor, function (rgbT, hex) { - rgb = rgbT; - sendColor(); - setStorage('rmcpcolor', hex); - updateInputSelect(); - }); + // Setup Event Listeners for Controls + function setupEventListeners() { + $("#reset_color").off().on("click", resetColor); + $("#remote_duration").off().on("change", updateDuration); + $("#effect_select").off().on("change", sendEffect); + $("#remote_input_reseff, #remote_input_rescol").off().on("click", handleResetOrColor); + $("#remote_input_repimg").off().on("click", handleImageRequest); + $("#remote_input_img").on("change", handleImageChange); + } - $("#reset_color").off().on("click", function () { + // Reset Color Function + function resetColor() { requestPriorityClear(); lastImgData = ""; $("#effect_select").val("__none__"); $("#remote_input_img").val(""); - }); + } - $("#remote_duration").off().on("change", function () { - duration = valValue(this.id, this.value, this.min, this.max); - setStorage('rmduration', duration); - if (duration == 0) { - duration = ENDLESS; - } - }); + // Update Duration + function updateDuration() { + uiInputDuration_s = valValue(this.id, this.value, this.min, this.max); + setStorage('rmduration', uiInputDuration_s); + updateDurationPlaceholder(); // Ensure placeholder is updated dynamically + } - $("#effect_select").off().on("change", function (event) { - sendEffect(); - }); + // Update the placeholder or display "Endless" dynamically + function updateDurationPlaceholder() { + const remoteDuration = $("#remote_duration"); + if (Number(remoteDuration.val()) === 0) { + remoteDuration.val(""); // Clear value temporarily + remoteDuration.attr("placeholder", $.i18n('remote_input_duration_endless')); + } else { + remoteDuration.attr("placeholder", ""); + } + } - $("#remote_input_reseff, #remote_input_rescol").off().on("click", function () { - if (this.id == "remote_input_rescol") { + // Handle Reset or Color Click + function handleResetOrColor() { + if (this.id === "remote_input_rescol") { sendColor(); - } else { - if (EFFECTENGINE_ENABLED) { - sendEffect(); - } + } else if (EFFECTENGINE_ENABLED) { + sendEffect(); } - }); + } - $("#remote_input_repimg").off().on("click", function () { - if (lastImgData != "") { - requestSetImage(lastImgData, duration, lastFileName); + // Handle Image Request + function handleImageRequest() { + if (lastImgData) { + requestSetImage(lastImgData, uiInputDuration_s, lastFileName); } - }); + } - $("#remote_input_img").on("change", function () { + // Handle Image Change + function handleImageChange() { readImg(this, function (src, fileName) { lastFileName = fileName; - if (src.includes(",")) - lastImgData = src.split(",")[1]; - else - lastImgData = src; - - requestSetImage(lastImgData, duration, lastFileName); + lastImgData = src.includes(",") ? src.split(",")[1] : src; + requestSetImage(lastImgData, uiInputDuration_s, lastFileName); }); - }); - - //force first update - initComponents(); - updateInputSelect(); - updateLedMapping(); - updateVideoMode(); - updateChannelAdjustments(); - if (EFFECTENGINE_ENABLED) { - updateEffectlist(); - } else { - $('#effect_row').hide(); } - // interval updates - - $(window.hyperion).on('components-updated', function (e, comp) { - updateComponent(comp); - }); - - $(window.hyperion).on("cmd-priorities-update", function (event) { - window.serverInfo.priorities = event.response.data.priorities; - window.serverInfo.priorities_autoselect = event.response.data.priorities_autoselect; + // Force First Update + function forceFirstUpdate() { + initComponents(); updateInputSelect(); - }); - $(window.hyperion).on("cmd-imageToLedMapping-update", function (event) { - window.serverInfo.imageToLedMappingType = event.response.data.imageToLedMappingType; updateLedMapping(); - }); - - $(window.hyperion).on("cmd-videomode-update", function (event) { - window.serverInfo.videomode = event.response.data.videomode; updateVideoMode(); - }); + updateChannelAdjustments(); + + if (EFFECTENGINE_ENABLED) { + updateEffectlist(); + } else { + $('#effect_row').hide(); + } + } + + // Interval Updates and Event Handlers + function setupEventListenersForUpdates() { + $(window.hyperion).on('components-updated', (e, comp) => updateComponent(comp)); - $(window.hyperion).on("cmd-effects-update", function (event) { - window.serverInfo.effects = event.response.data.effects; - updateEffectlist(); - }); + $(window.hyperion).on("cmd-priorities-update", (event) => { + window.serverInfo.priorities = event.response.data.priorities; + window.serverInfo.priorities_autoselect = event.response.data.priorities_autoselect; + updateInputSelect(); + }); - $(window.hyperion).on("cmd-settings-update", function (event) { - if (event.response.data.color) { - window.serverInfo.imageToLedMappingType = event.response.data.color.imageToLedMappingType; + $(window.hyperion).on("cmd-imageToLedMapping-update", (event) => { + window.serverInfo.imageToLedMappingType = event.response.data.imageToLedMappingType; updateLedMapping(); + }); - window.serverInfo.adjustment = event.response.data.color.channelAdjustment; - updateChannelAdjustments(); - } - }); + $(window.hyperion).on("cmd-videomode-update", (event) => { + window.serverInfo.videomode = event.response.data.videomode; + updateVideoMode(); + }); + + $(window.hyperion).on("cmd-effects-update", (event) => { + window.serverInfo.effects = event.response.data.effects; + updateEffectlist(); + }); + + $(window.hyperion).on("cmd-settings-update", (event) => { + if (event.response.data.color) { + window.serverInfo.imageToLedMappingType = event.response.data.color.imageToLedMappingType; + updateLedMapping(); + window.serverInfo.adjustment = event.response.data.color.channelAdjustment; + updateChannelAdjustments(); + } + }); + + removeOverlay(); + } + + // Initialize everything + function init() { + initColorPickerAndEffects(); + forceFirstUpdate(); + setupEventListenersForUpdates(); + } + + init(); - removeOverlay(); }); diff --git a/assets/webconfig/js/content_webconfig.js b/assets/webconfig/js/content_webconfig.js index 71c83cfd1..a0aa96c36 100644 --- a/assets/webconfig/js/content_webconfig.js +++ b/assets/webconfig/js/content_webconfig.js @@ -1,32 +1,74 @@ - $(document).ready( function() { - performTranslation(); +$(document).ready(function () { + performTranslation(); - var conf_editor = null; + let conf_editor = null; - $('#conf_cont').append(createOptPanel('fa-wrench', $.i18n("edt_conf_webc_heading_title"), 'editor_container', 'btn_submit', 'panel-system')); - if(window.showOptHelp) - { - $('#conf_cont').append(createHelpTable(window.schema.webConfig.properties, $.i18n("edt_conf_webc_heading_title"))); - } + $('#conf_cont').append(createOptPanel('fa-wrench', $.i18n("edt_conf_webConfig_heading_title"), 'editor_container', 'btn_submit', 'panel-system')); + if (window.showOptHelp) { + $('#conf_cont').append(createHelpTable(window.schema.webConfig.properties, $.i18n("edt_conf_webConfig_heading_title"))); + } - conf_editor = createJsonEditor('editor_container', { - webConfig : window.schema.webConfig - }, true, true); + conf_editor = createJsonEditor('editor_container', { + webConfig: window.schema.webConfig + }, true, true); - conf_editor.on('change',function() { - conf_editor.validate().length || window.readOnlyMode ? $('#btn_submit').prop('disabled', true) : $('#btn_submit').prop('disabled', false); - }); + // Validate for conflicting ports + JSONEditor.defaults.custom_validators.push(function (schema, value, path) { + let errors = []; + const conflictingPorts = { + "root.webConfig.port": ["jsonServer", "flatbufServer", "protoServer", "webConfig_sslPort"], + "root.webConfig.sslPort": ["jsonServer", "flatbufServer", "protoServer", "webConfig_port"] + }; - $('#btn_submit').off().on('click',function() { - // store the last webui port for correct reconnect url (connection_lost.html) - var val = conf_editor.getValue(); - window.fastReconnect = true; - window.jsonPort = val.webConfig.port; - requestWriteConfig(val); - }); + if (!(path in conflictingPorts)) { + return []; + } - if(window.showOptHelp) - createHint("intro", $.i18n('conf_webconfig_label_intro'), "editor_container"); + conflictingPorts[path].forEach(conflictKey => { + let conflictPort; - removeOverlay(); + const isWebConfigPort = conflictKey.startsWith("webConfig"); + if (isWebConfigPort) { + conflictPort = conf_editor?.getEditor(`root.${conflictKey.replace("_", ".")}`)?.getValue(); + } else { + conflictPort = window.serverConfig?.[conflictKey]?.port; + } + + if (conflictPort != null && value === conflictPort) { + let errorText; + + if (isWebConfigPort) { + errorText = $.i18n(`edt_conf_${conflictKey}_title`); + } else { + errorText = $.i18n("main_menu_network_conf_token") + " - " + $.i18n(`edt_conf_${conflictKey}_heading_title`); + } + + errors.push({ + path: path, + property: "port", + message: $.i18n('edt_conf_network_port_validation_error', errorText) + }); + } + + }); + + return errors; + }); + + conf_editor.on('change', function () { + conf_editor.validate().length || window.readOnlyMode ? $('#btn_submit').prop('disabled', true) : $('#btn_submit').prop('disabled', false); + }); + + $('#btn_submit').off().on('click', function () { + // store the last webui port for correct reconnect url (connection_lost.html) + const val = conf_editor.getValue(); + window.fastReconnect = true; + window.jsonPort = val.webConfig.port; + requestWriteConfig(val); + }); + + if (window.showOptHelp) + createHint("intro", $.i18n('conf_webconfig_label_intro'), "editor_container"); + + removeOverlay(); }); diff --git a/assets/webconfig/js/hyperion.js b/assets/webconfig/js/hyperion.js index a06dbdaa8..6cb2e35fb 100644 --- a/assets/webconfig/js/hyperion.js +++ b/assets/webconfig/js/hyperion.js @@ -1,6 +1,10 @@ +//Constants +const INPUT = Object.freeze({ + ORIGIN: "Hyperion Web-UI", + FG_PRIORITY: 1 +}); + // global vars (read and write in window object) -window.webPrio = 1; -window.webOrigin = "Web Configuration"; window.showOptHelp = true; window.gitHubReleaseApiUrl = "https://api.github.com/repos/hyperion-project/hyperion.ng/releases"; window.currentChannel = null; @@ -26,13 +30,11 @@ window.loggingStreamActive = false; window.loggingHandlerInstalled = false; window.watchdog = 0; window.debugMessagesActive = true; -window.currentHyperionInstance = 0; +window.currentHyperionInstance = null; window.currentHyperionInstanceName = "?"; window.comps = []; window.defaultPasswordIsSet = null; -tokenList = {}; - -const ENDLESS = -1; +let tokenList = {}; function initRestart() { $(window.hyperion).off(); @@ -42,8 +44,8 @@ function initRestart() { function connectionLostDetection(type) { if (window.watchdog > 2) { - var interval_id = window.setInterval(function () { clearInterval(interval_id); }, 9999); // Get a reference to the last - for (var i = 1; i < interval_id; i++) + const interval_id = window.setInterval(function () { clearInterval(interval_id); }, 9999); // Get a reference to the last + for (let i = 1; i < interval_id; i++) window.clearInterval(i); if (type == 'restart') { $("body").html($("#container_restart").html()); @@ -86,7 +88,7 @@ function initWebSocket() { window.websocket.onclose = function (event) { // See http://tools.ietf.org/html/rfc6455#section-7.4.1 - var reason; + let reason; switch (event.code) { case 1000: reason = "Normal closure, meaning that the purpose for which the connection was established has been fulfilled."; break; case 1001: reason = "An endpoint is \"going away\", such as a server going down or a browser having navigated away from a page."; break; @@ -110,17 +112,17 @@ function initWebSocket() { window.websocket.onmessage = function (event) { try { - var response = JSON.parse(event.data); - var success = response.success; - var cmd = response.command; - var tan = response.tan + const response = JSON.parse(event.data); + const success = response.success; + const cmd = response.command; + const tan = response.tan if (success || typeof (success) == "undefined") { $(window.hyperion).trigger({ type: "cmd-" + cmd, response: response }); } - else { - // skip tan -1 error handling + else if (tan != -1) { - var error = response.hasOwnProperty("error") ? response.error : "unknown"; + // skip tan -1 error handling + const error = response.hasOwnProperty("error") ? response.error : "unknown"; if (error == "Service Unavailable") { window.location.reload(); } else { @@ -129,7 +131,6 @@ function initWebSocket() { let errorData = response.hasOwnProperty("errorData") ? response.errorData : ""; console.log("[window.websocket::onmessage] ", error, ", Description:", errorData); } - } } catch (exception_error) { $(window.hyperion).trigger({ type: "error", reason: exception_error }); @@ -146,23 +147,30 @@ function initWebSocket() { else { $(window.hyperion).trigger("error"); alert("Websocket is not supported by your browser"); - return; } } function sendToHyperion(command, subcommand, msg) { - if (typeof subcommand != 'undefined' && subcommand.length > 0) - subcommand = ',"subcommand":"' + subcommand + '"'; - else - subcommand = ""; + const tan = Math.floor(Math.random() * 1000); // Generate a transaction number - if (typeof msg != 'undefined' && msg.length > 0) - msg = "," + msg; - else - msg = ""; + // Build the base object + const message = { + command: command, + tan: tan, + }; - window.wsTan = Math.floor(Math.random() * 1000) - window.websocket.send('{"command":"' + command + '", "tan":' + window.wsTan + subcommand + msg + '}'); + // Add the subcommand if provided + if (subcommand) { + message.subcommand = subcommand; + } + + // Merge the msg object into the final message if provided + if (msg && typeof msg === "object") { + Object.assign(message, msg); + } + + // Send the serialized message over WebSocket + window.websocket.send(JSON.stringify(message)); } // Send a json message to Hyperion and wait for a matching response @@ -177,7 +185,6 @@ async function sendAsyncToHyperion(command, subcommand, data, tan = Math.floor(M if (subcommand) { Object.assign(obj, { subcommand }) } if (data) { Object.assign(obj, data) } - //if (process.env.DEV || sstore.getters['common/getDebugState']) console.log('SENDAS', obj) return __sendAsync(obj) } @@ -223,64 +230,85 @@ function requestRequiresAdminAuth() { function requestRequiresDefaultPasswortChange() { sendToHyperion("authorize", "newPasswordRequired"); } + // Change password -function requestChangePassword(oldPw, newPw) { - sendToHyperion("authorize", "newPassword", '"password": "' + oldPw + '", "newPassword":"' + newPw + '"'); +function requestChangePassword(password, newPassword) { + sendToHyperion("authorize", "newPassword", { password, newPassword }); } function requestAuthorization(password) { - sendToHyperion("authorize", "login", '"password": "' + password + '"'); + sendToHyperion("authorize", "login", { password }); } function requestTokenAuthorization(token) { - sendToHyperion("authorize", "login", '"token": "' + token + '"'); + sendToHyperion("authorize", "login", { token }); } function requestToken(comment) { - sendToHyperion("authorize", "createToken", '"comment": "' + comment + '"'); + sendToHyperion("authorize", "createToken", { comment }); } function requestTokenInfo() { - sendToHyperion("authorize", "getTokenList", ""); + sendToHyperion("authorize", "getTokenList", {}); + return Promise.resolve(); } function requestGetPendingTokenRequests(id, state) { - sendToHyperion("authorize", "getPendingTokenRequests", ""); + sendToHyperion("authorize", "getPendingTokenRequests", {}); } function requestHandleTokenRequest(id, state) { - sendToHyperion("authorize", "answerRequest", '"id":"' + id + '", "accept":' + state); + sendToHyperion("authorize", "answerRequest", { id, accept: state }); } function requestTokenDelete(id) { - sendToHyperion("authorize", "deleteToken", '"id":"' + id + '"'); + sendToHyperion("authorize", "deleteToken", { id }); } -function requestInstanceRename(inst, name) { - sendToHyperion("instance", "saveName", '"instance": ' + inst + ', "name": "' + name + '"'); +function requestInstanceRename(instance, name) { + sendToHyperion("instance", "saveName", { instance: Number(instance), name }); } -function requestInstanceStartStop(inst, start) { +function requestInstanceStartStop(instance, start) { if (start) - sendToHyperion("instance", "startInstance", '"instance": ' + inst); + sendToHyperion("instance", "startInstance", { instance: Number(instance) }); else - sendToHyperion("instance", "stopInstance", '"instance": ' + inst); + sendToHyperion("instance", "stopInstance", { instance: Number(instance) }); } -function requestInstanceDelete(inst) { - sendToHyperion("instance", "deleteInstance", '"instance": ' + inst); +function requestInstanceDelete(instance) { + sendToHyperion("instance", "deleteInstance", { instance: Number(instance) }); } function requestInstanceCreate(name) { - sendToHyperion("instance", "createInstance", '"name": "' + name + '"'); -} - -function requestInstanceSwitch(inst) { - sendToHyperion("instance", "switchTo", '"instance": ' + inst); -} + sendToHyperion("instance", "createInstance", { name }); +} + +function requestInstanceSwitch(instance) { + sendToHyperion("instance", "switchTo", { instance: Number(instance) }); +} + +function requestServerInfo(instance) { + let data = { + subscribe: [ + "components-update", + "priorities-update", + "imageToLedMapping-update", + "adjustment-update", + "videomode-update", + "effects-update", + "settings-update", + "instance-update", + "event-update" + ] + }; + + if (instance !== null && instance !== undefined && !isNaN(Number(instance))) { + data.instance = Number(instance); + } -function requestServerInfo() { - sendToHyperion("serverinfo", "", '"subscribe":["components-update", "priorities-update", "imageToLedMapping-update", "adjustment-update", "videomode-update", "effects-update", "settings-update", "instance-update"]'); + sendToHyperion("serverinfo", "getInfo", data); + return Promise.resolve(); } function requestSysInfo() { @@ -303,13 +331,41 @@ function requestServerConfigSchema() { sendToHyperion("config", "getschema"); } -function requestServerConfig() { - sendToHyperion("config", "getconfig"); -} +const requestServerConfig = { + // Shared logic encapsulated in a helper function + createFilter(globalTypes = [], instances = [], instanceTypes = []) { + const filter = { + configFilter: { + global: { types: globalTypes }, + }, + }; -function requestServerConfigOld() { - sendToHyperion("config", "getconfig-old"); -} + // Handle instances: remove "null" if present and add to filter if not empty + if (instances.length && !(instances.length === 1 && instances[0] === null)) { + filter.configFilter.instances = { ids: instances }; + } + + if (instanceTypes.length > 0) { + filter.configFilter.instances = filter.configFilter.instances || {}; + filter.configFilter.instances.types = instanceTypes; + } + + return filter; + }, + + // Synchronous function + sync(globalTypes, instances, instanceTypes) { + const filter = this.createFilter(globalTypes, instances, instanceTypes); + sendToHyperion("config", "getconfig", filter); + return Promise.resolve(); + }, + + // Asynchronous function + async async(globalTypes, instances, instanceTypes) { + const filter = this.createFilter(globalTypes, instances, instanceTypes); + return sendAsyncToHyperion("config", "getconfig", filter); + } +}; function requestServerConfigReload() { sendToHyperion("config", "reload"); @@ -335,12 +391,12 @@ function requestLedImageStop() { sendToHyperion("ledcolors", "imagestream-stop"); } -function requestPriorityClear(prio) { - if (typeof prio !== 'number') - prio = window.webPrio; +function requestPriorityClear(priority) { + if (typeof priority !== 'number') + priority = INPUT.FG_PRIORITY; $(window.hyperion).trigger({ type: "stopBrowerScreenCapture" }); - sendToHyperion("clear", "", '"priority":' + prio + ''); + sendToHyperion("clear", "", { priority }); } function requestClearAll() { @@ -348,30 +404,49 @@ function requestClearAll() { requestPriorityClear(-1) } -function requestPlayEffect(effectName, duration) { +function requestPlayEffect(name, duration) { $(window.hyperion).trigger({ type: "stopBrowerScreenCapture" }); - sendToHyperion("effect", "", '"effect":{"name":"' + effectName + '"},"priority":' + window.webPrio + ',"duration":' + validateDuration(duration) + ',"origin":"' + window.webOrigin + '"'); + const data = { + effect: { name }, + priority: INPUT.FG_PRIORITY, + duration: validateDuration(duration), + origin: INPUT.ORIGIN, + }; + sendToHyperion("effect", "", data); } function requestSetColor(r, g, b, duration) { $(window.hyperion).trigger({ type: "stopBrowerScreenCapture" }); - sendToHyperion("color", "", '"color":[' + r + ',' + g + ',' + b + '], "priority":' + window.webPrio + ',"duration":' + validateDuration(duration) + ',"origin":"' + window.webOrigin + '"'); -} - -function requestSetImage(data, duration, name) { - sendToHyperion("image", "", '"imagedata":"' + data + '", "priority":' + window.webPrio + ',"duration":' + validateDuration(duration) + ', "format":"auto", "origin":"' + window.webOrigin + '", "name":"' + name + '"'); -} - -function requestSetComponentState(comp, state) { - var state_str = state ? "true" : "false"; - sendToHyperion("componentstate", "", '"componentstate":{"component":"' + comp + '","state":' + state_str + '}'); -} - -function requestSetSource(prio) { - if (prio == "auto") - sendToHyperion("sourceselect", "", '"auto":true'); + const data = { + color: [r, g, b], + priority: INPUT.FG_PRIORITY, + duration: validateDuration(duration), + origin: INPUT.ORIGIN + }; + sendToHyperion("color", "", data); +} + +function requestSetImage(imagedata, duration, name) { + const data = { + imagedata, + priority: INPUT.FG_PRIORITY, + duration: validateDuration(duration), + format: "auto", + origin: INPUT.ORIGIN, + name + }; + sendToHyperion("image", "", data); +} + +function requestSetComponentState(component, state) { + sendToHyperion("componentstate", "", { componentstate: { component, state } }); +} + +function requestSetSource(priority) { + if (priority == "auto") + sendToHyperion("sourceselect", "", { auto: true }); else - sendToHyperion("sourceselect", "", '"priority":' + prio); + sendToHyperion("sourceselect", "", { priority }); } // Function to transform the legacy config into thee new API format @@ -424,24 +499,36 @@ function requestWriteConfig(singleInstanceConfig, full) { newConfig = transformConfig(singleInstanceConfig, instance); } - sendToHyperion("config", "setconfig", '"config":' + JSON.stringify(newConfig)); + sendToHyperion("config", "setconfig", { config: newConfig }); } -function requestRestoreConfig(config) { - sendToHyperion("config", "restoreconfig", '"config":' + JSON.stringify(config)); +function requestRestoreConfig(newConfig) { + sendToHyperion("config", "restoreconfig", { config: newConfig }); } -function requestWriteEffect(effectName, effectPy, effectArgs, data) { - var cutArgs = effectArgs.slice(1, -1); - sendToHyperion("create-effect", "", '"name":"' + effectName + '", "script":"' + effectPy + '", ' + cutArgs + ',"imageData":"' + data + '"'); +function requestWriteEffect(name, script, args, imageData) { + const data = { + name, + script, + args, + imageData + }; + sendToHyperion("create-effect", "", data); } -function requestTestEffect(effectName, effectPy, effectArgs, data) { - sendToHyperion("effect", "", '"effect":{"name":"' + effectName + '", "args":' + effectArgs + '}, "priority":' + window.webPrio + ', "origin":"' + window.webOrigin + '", "pythonScript":"' + effectPy + '", "imageData":"' + data + '"'); +function requestTestEffect(name, pythonScript, args, imageData) { + const data = { + effect: { name, args }, + priority: INPUT.FG_PRIORITY, + origin: INPUT.ORIGIN, + pythonScript, + imageData + }; + sendToHyperion("effect", "", data); } -function requestDeleteEffect(effectName) { - sendToHyperion("delete-effect", "", '"name":"' + effectName + '"'); +function requestDeleteEffect(name) { + sendToHyperion("delete-effect", "", { name }); } function requestLoggingStart() { @@ -454,63 +541,41 @@ function requestLoggingStop() { sendToHyperion("logging", "stop"); } -function requestMappingType(type) { - sendToHyperion("processing", "", '"mappingType": "' + type + '"'); +function requestMappingType(mappingType) { + sendToHyperion("processing", "", { mappingType }); } function requestVideoMode(newMode) { - sendToHyperion("videomode", "", '"videoMode": "' + newMode + '"'); + sendToHyperion("videomode", "", { videoMode: newMode }); } function requestAdjustment(type, value, complete) { if (complete === true) - sendToHyperion("adjustment", "", '"adjustment": ' + type + ''); + sendToHyperion("adjustment", "", { adjustment: type }); else - sendToHyperion("adjustment", "", '"adjustment": {"' + type + '": ' + value + '}'); -} - -async function requestLedDeviceDiscovery(type, params) { - let data = { ledDeviceType: type, params: params }; - - return sendAsyncToHyperion("leddevice", "discover", data); + sendToHyperion("adjustment", "", { adjustment: { [type]: value } }); } -async function requestLedDeviceProperties(type, params) { - let data = { ledDeviceType: type, params: params }; - - return sendAsyncToHyperion("leddevice", "getProperties", data); +async function requestLedDeviceDiscovery(ledDeviceType, params) { + return sendAsyncToHyperion("leddevice", "discover", { ledDeviceType, params }); } - -function requestLedDeviceIdentification(type, params) { - let data = { ledDeviceType: type, params: params }; - - return sendAsyncToHyperion("leddevice", "identify", data); +async function requestLedDeviceProperties(ledDeviceType, params) { + return sendAsyncToHyperion("leddevice", "getProperties", { ledDeviceType, params }); } -async function requestLedDeviceAddAuthorization(type, params) { - let data = { ledDeviceType: type, params: params }; - - return sendAsyncToHyperion("leddevice", "addAuthorization", data); +function requestLedDeviceIdentification(ledDeviceType, params) { + return sendAsyncToHyperion("leddevice", "identify", { ledDeviceType, params }); } -async function requestInputSourcesDiscovery(type, params) { - let data = { sourceType: type, params: params }; - - return sendAsyncToHyperion("inputsource", "discover", data); +async function requestLedDeviceAddAuthorization(ledDeviceType, params) { + return sendAsyncToHyperion("leddevice", "addAuthorization", { ledDeviceType, params }); } -async function requestServiceDiscovery(type, params) { - let data = { serviceType: type, params: params }; - - return sendAsyncToHyperion("service", "discover", data); +async function requestInputSourcesDiscovery(sourceType, params) { + return sendAsyncToHyperion("inputsource", "discover", { sourceType, params }); } -async function requestConfig(globalTypes, instances, instanceTypes) { - let globalFilter = { "global": { "types": globalTypes } }; - let instanceFilter = { "instances": { "ids": instances, "types": instanceTypes } }; - let filter = { "configFilter": { globalFilter, instanceFilter } }; - - return sendAsyncToHyperion("config", "getconfig", filter); +async function requestServiceDiscovery(serviceType, params) { + return sendAsyncToHyperion("service", "discover", { serviceType, params }); } - diff --git a/assets/webconfig/js/ledsim.js b/assets/webconfig/js/ledsim.js index 52a75cedf..7e95830bc 100644 --- a/assets/webconfig/js/ledsim.js +++ b/assets/webconfig/js/ledsim.js @@ -28,8 +28,8 @@ $(document).ready(function () { function create2dPaths() { twoDPaths = []; - for (var idx = 0; idx < leds.length; idx++) { - var led = leds[idx]; + for (const element of leds) { + var led = element; twoDPaths.push(build2DPath(led.hmin * canvas_width, led.vmin * canvas_height, (led.hmax - led.hmin) * canvas_width, (led.vmax - led.vmin) * canvas_height, 5)); } } @@ -128,13 +128,17 @@ $(document).ready(function () { setStorage("ledsim_height", $("#ledsim_dialog").outerHeight()); } }); - // apply new serverinfos - $(window.hyperion).on("cmd-config-getconfig-old", function (event) { - leds = event.response.info.leds; - grabberConfig = event.response.info.grabberV4L2; - updateLedLayout(); - }); - }); + // apply new configuration + $(window.hyperion).on("serverConfig_updated", function (event) { + grabberConfig = window.serverConfig?.grabberV4L2 ?? {}; + leds = window.serverConfig?.leds; + + if (Array.isArray(leds) && leds.length > 0) { + updateLedLayout(); + } else { + console.warn("LED configuration is missing or empty. Skipping updateLedLayout."); + } + }); }); function printLedsToCanvas(colors) { @@ -174,10 +178,6 @@ $(document).ready(function () { ledsCanvasNodeCtx.stroke(twoDPaths[idx]); if (toggleLedsNum) { - //ledsCanvasNodeCtx.shadowOffsetX = 1; - //ledsCanvasNodeCtx.shadowOffsetY = 1; - //ledsCanvasNodeCtx.shadowColor = "black"; - //ledsCanvasNodeCtx.shadowBlur = 4; ledsCanvasNodeCtx.fillStyle = "white"; ledsCanvasNodeCtx.textAlign = "center"; ledsCanvasNodeCtx.fillText(((led.name) ? led.name : idx), (led.hmin * canvas_width) + (((led.hmax - led.hmin) * canvas_width) / 2), (led.vmin * canvas_height) + (((led.vmax - led.vmin) * canvas_height) / 2)); @@ -199,7 +199,7 @@ $(document).ready(function () { canvas_height = $('#ledsim_dialog').outerHeight() - $('#ledsim_text').outerHeight() - $('[data-role=footer]').outerHeight() - $('[data-role=header]').outerHeight() - 40; canvas_width = $('#ledsim_dialog').outerWidth() - 30; - $("[id$=_preview_canv]").prop({"width": canvas_width, "height": canvas_height}); + $("[id$=_preview_canv]").prop({ "width": canvas_width, "height": canvas_height }); $("body").get(0).style.setProperty("--width-var", canvas_width + "px"); $("body").get(0).style.setProperty("--height-var", canvas_height + "px"); @@ -294,7 +294,6 @@ $(document).ready(function () { var obj = event.response.data if (obj.leds || obj.grabberV4L2) { - //console.log("ledsim: cmd-settings-update", event.response.data); Object.getOwnPropertyNames(obj).forEach(function (val, idx, array) { window.serverInfo[val] = obj[val]; }); @@ -305,11 +304,8 @@ $(document).ready(function () { }); $(window.hyperion).on("cmd-priorities-update", function (event) { - //console.log("cmd-priorities-update", event.response.data); - var prios = event.response.data.priorities; - if (prios.length > 0) - { + if (prios.length > 0) { //Clear image when new input if (prios[0].componentId !== activeComponent) { resetImage(); @@ -340,3 +336,4 @@ $(document).ready(function () { } } }); + diff --git a/assets/webconfig/js/streamer.js b/assets/webconfig/js/streamer.js index eb6739ac0..1ff8967e0 100644 --- a/assets/webconfig/js/streamer.js +++ b/assets/webconfig/js/streamer.js @@ -1,7 +1,7 @@ $(document).ready(function () { - // check if browser supports streaming - if (window.navigator.mediaDevices && window.navigator.mediaDevices.getDisplayMedia) { + const isMediaStreamingSupported = getStorage('mediaStreamingSupported'); + if (isMediaStreamingSupported) { $("#btn_streamer").toggle(); } diff --git a/assets/webconfig/js/ui_utils.js b/assets/webconfig/js/ui_utils.js index ace8b8300..58c693b11 100644 --- a/assets/webconfig/js/ui_utils.js +++ b/assets/webconfig/js/ui_utils.js @@ -1,4 +1,6 @@ -var prevTag; +const DURATION_ENDLESS = -1; + +let prevTag; function removeOverlay() { $("#loading_overlay").removeClass("overlay"); @@ -9,9 +11,7 @@ function reload() { } function storageComp() { - if (typeof (Storage) !== "undefined") - return true; - return false; + return typeof (Storage) !== "undefined"; } function getStorage(item) { @@ -40,34 +40,97 @@ function debugMessage(msg) { } function validateDuration(d) { - if (typeof d === "undefined" || d < 0) - return ENDLESS; - else - return d *= 1000; + if (typeof d === "undefined" || d <= 0) { + return DURATION_ENDLESS; + } else { + return d * 1000; + } } function getHashtag() { - if (getStorage('lasthashtag') != null) - return getStorage('lasthashtag'); - else { - var tag = document.URL; - tag = tag.substr(tag.indexOf("#") + 1); - if (tag == "" || typeof tag === "undefined" || tag.startsWith("http")) - tag = "dashboard" + const lastHashtag = getStorage('lasthashtag'); + if (lastHashtag !== null) { + return lastHashtag; + } else { + let tag = document.URL; + const hashIndex = tag.indexOf("#"); + if (hashIndex !== -1) { + tag = tag.slice(hashIndex + 1); + } else { + tag = ""; // No hashtag found + } + + if (tag === "" || typeof tag === "undefined" || tag.startsWith("http")) { + tag = "dashboard"; + } + return tag; } } -function loadContent(event, forceRefresh) { - var tag; +function isInstanceRunning(instanceId) { + return window.serverInfo?.instance?.some( + (instance) => instance.instance === Number(instanceId) && instance.running + ); +} + +function isCurrentInstanceRunning() { + return isInstanceRunning(window.currentHyperionInstance); +} - var lastSelectedInstance = getStorage('lastSelectedInstance'); +function getFirstRunningInstance() { - if (lastSelectedInstance && (lastSelectedInstance != window.currentHyperionInstance)) { - if (window.serverInfo.instance[lastSelectedInstance] && window.serverInfo.instance[lastSelectedInstance].running) { - instanceSwitch(lastSelectedInstance); - } else { - removeStorage('lastSelectedInstance'); + const runningInstance = window.serverInfo?.instance?.find( + (instance) => instance.running + ); + + return runningInstance ? runningInstance.instance : null; // Return instance number or null if none is running +} + +function getFirstConfiguredInstance() { + const configuredInstance = window.serverInfo?.instance?.find( + (instance) => instance.instance !== undefined + ); + + return configuredInstance ? configuredInstance.instance : null; // Return instance number or null if none exists +} + +function doesInstanceExist(instanceId) { + + if (instanceId == null) { + return false; // Return false if instanceId is null or undefined + } + + return window.serverInfo?.instance?.some( + (instance) => instance.instance === Number(instanceId) + ) || false; // Return false if serverInfo or instance is undefined +} + +function getInstanceName(instanceId) { + const instance = window.serverInfo?.instance?.find( + (instance) => instance.instance === Number(instanceId) + ); + + return instance?.friendly_name || "unknown"; +} + +function loadContent(event, forceRefresh) { + let tag; + const lastSelectedInstance = getStorage('lastSelectedInstance'); + + // Hide instance related menu entries, if no instance is available or not running + if (window.serverInfo.instance.length === 0) { + $("#MenuItemLedInstances, #MenuItemRemoteControl, #MenuItemEffectsConfig").hide(); + removeStorage('lastSelectedInstance'); + } else if (lastSelectedInstance === null) { + const newInstance = getFirstRunningInstance(); + if (newInstance !== null) { + instanceSwitch(newInstance); + } + } else { + const lastInstance = Number(lastSelectedInstance); + if (lastInstance !== window.currentHyperionInstance) { + instanceSwitch(lastInstance); } } @@ -75,9 +138,9 @@ function loadContent(event, forceRefresh) { tag = event.currentTarget.hash; tag = tag.substr(tag.indexOf("#") + 1); setStorage('lasthashtag', tag); - } - else + } else { tag = getHashtag(); + } if (forceRefresh || prevTag != tag) { prevTag = tag; @@ -90,7 +153,9 @@ function loadContent(event, forceRefresh) { $("#page-content").load("/content/" + tag + ".html", function (response, status, xhr) { if (status == "error") { - $("#page-content").html('

    ' + encode_utf8(tag) + '
    ' + $.i18n('info_404') + '

    '); + $("#page-content").html( + '

    ' + encode_utf8(tag) + '
    ' + $.i18n('info_404') + '

    ' + ); removeOverlay(); } }); @@ -100,63 +165,61 @@ function loadContent(event, forceRefresh) { } } -function getInstanceNameByIndex(index) { - var instData = window.serverInfo.instance - for (var key in instData) { - if (instData[key].instance == index) - return instData[key].friendly_name; - } - return "unknown" -} - function updateHyperionInstanceListing() { - if (window.serverInfo.instance) { - var data = window.serverInfo.instance.filter(entry => entry.running); + if (window.serverInfo.instance !== null) { + const data = window.serverInfo.instance; $('#hyp_inst_listing').html(""); - for (var key in data) { - var currInstMarker = (data[key].instance == window.currentHyperionInstance) ? "component-on" : ""; - var html = '
  • \ - \ -
    \ - \ - '+ data[key].friendly_name + ' \ -
    \ -     \ -
    • ' - - if (data.length - 1 > key) - html += '
  • ' + for (const key in data) { + const currInstMarker = (data[key].instance == window.currentHyperionInstance) ? "component-on" : ""; + + // Construct the HTML using concatenation for ES5 compatibility + let html = '
  • ' + + '' + + '
    ' + + '' + + '' + data[key].friendly_name + '' + + '
    ' + + '    ' + + '
    • '; + + if (data.length - 1 > key) { + html += '
  • '; + } $('#hyp_inst_listing').append(html); $('#hyperioninstance_' + data[key].instance).off().on("click", function (e) { - var inst = e.currentTarget.id.split("_")[1] - instanceSwitch(inst) + const inst = e.currentTarget.id.split("_")[1]; + instanceSwitch(inst); }); } } } function initLanguageSelection() { - // Initialise language selection list with languages supported - for (var i = 0; i < availLang.length; i++) { - $("#language-select").append(''); + // Initialize language selection list with supported languages + for (let i = 0; i < availLang.length; i++) { + $("#language-select").append( + '' + ); } - var langLocale = storedLang; + let langLocale = storedLang; + let langText = ''; - //Test, if language is supported by hyperion - var langIdx = availLang.indexOf(langLocale); + // Test if the language is supported by Hyperion + let langIdx = availLang.indexOf(langLocale); if (langIdx > -1) { langText = availLangText[langIdx]; } else { - // If language is not supported by hyperion, try fallback language + // If the language is not supported, try the fallback language langLocale = $.i18n().options.fallbackLocale.substring(0, 2); langIdx = availLang.indexOf(langLocale); if (langIdx > -1) { langText = availLangText[langIdx]; } else { + // Default to English if fallback language is also unsupported langLocale = 'en'; langIdx = availLang.indexOf(langLocale); if (langIdx > -1) { @@ -165,6 +228,7 @@ function initLanguageSelection() { } } + // Update the language select dropdown $('#language-select').prop('title', langText); $("#language-select").val(langIdx); $("#language-select").selectpicker("refresh"); @@ -173,27 +237,43 @@ function initLanguageSelection() { function updateUiOnInstance(inst) { window.currentHyperionInstance = inst; - window.currentHyperionInstanceName = getInstanceNameByIndex(inst); + if (inst === null) { + //No instance defined, hide all instance related menue items + $("#MenuItemLedInstances").closest("li").hide(); + $("#MenuItemRemoteControl, #MenuItemEffectsConfig, #NavMenuWizards, #btn_open_ledsim, #btn_streamer").hide(); + } else { + window.currentHyperionInstanceName = getInstanceName(inst); - $("#active_instance_friendly_name").text(getInstanceNameByIndex(inst)); - if (window.serverInfo.instance.filter(entry => entry.running).length > 1) { + $("#active_instance_friendly_name").text(getInstanceName(inst)); $('#btn_hypinstanceswitch').toggle(true); $('#active_instance_dropdown').prop('disabled', false); $('#active_instance_dropdown').css('cursor', 'pointer'); $("#active_instance_dropdown").css("pointer-events", "auto"); - } else { - $('#btn_hypinstanceswitch').toggle(false); - $('#active_instance_dropdown').prop('disabled', true); - $("#active_instance_dropdown").css('cursor', 'default'); - $("#active_instance_dropdown").css("pointer-events", "none"); + + //Allow to configure an existing instance + $("#MenuItemLedInstances").show().closest("li").show(); + + // Show menue items according to instance's running state + if (isInstanceRunning(window.currentHyperionInstance)) { + $("#MenuItemRemoteControl, #MenuItemEffectsConfig, #NavMenuWizards, #btn_open_ledsim").show(); + + const isMediaStreamingSupported = getStorage('mediaStreamingSupported'); + if (isMediaStreamingSupported) { + $('#btn_streamer').show(); + } + + } else { + $("#MenuItemRemoteControl, #MenuItemEffectsConfig, #NavMenuWizards, #btn_open_ledsim, #btn_streamer").hide(); + } } } function instanceSwitch(inst) { - requestInstanceSwitch(inst) - window.currentHyperionInstance = inst; - window.currentHyperionInstanceName = getInstanceNameByIndex(inst); - setStorage('lastSelectedInstance', inst) + const instanceID = Number(inst); + requestInstanceSwitch(instanceID) + window.currentHyperionInstance = instanceID; + window.currentHyperionInstanceName = getInstanceName(instanceID); + setStorage('lastSelectedInstance', instanceID) } function loadContentTo(containerId, fileName) { @@ -319,88 +399,148 @@ function showInfoDialog(type, header, message) { }); $(document).on('click', '[data-dismiss-modal]', function () { - var target = $(this).data('dismiss-modal'); + const target = $(this).data('dismiss-modal'); $($.find(target)).modal('hide'); }); } function createHintH(type, text, container) { type = String(type); - if (type == "intro") - tclass = "introd"; - - $('#' + container).prepend('

    ' + text + '

    '); -} - -function createHint(type, text, container, buttonid, buttontxt) { - var fe, tclass; + let tclass; if (type == "intro") { - fe = ''; - tclass = "intro-hint"; - } - else if (type == "info") { - fe = '
    Information
    '; - tclass = "info-hint"; - } - else if (type == "wizard") { - fe = '
    Information
    '; - tclass = "wizard-hint"; - } - else if (type == "warning") { - fe = '
    Information
    '; - tclass = "warning-hint"; + tclass = "introd"; } - if (buttonid) - buttonid = '

    '; - else - buttonid = ""; - - if (type == "intro") - $('#' + container).prepend('

    ' + $.i18n("conf_helptable_expl") + '

    ' + text + '
    '); - else if (type == "wizard") - $('#' + container).prepend('

    ' + $.i18n("wiz_wizavail") + '

    ' + $.i18n('wiz_guideyou', text) + buttonid + '
    '); - else { - createTable('', 'htb', container, true, tclass); - $('#' + container + ' .htb').append(createTableRow([fe, text], false, true)); + // Prepend the formatted hint to the container + $('#' + container).prepend( + '
    ' + + '

    ' + text + '

    ' + + '
    ' + + '
    ' + ); +} + +function createHint(type, text, container, buttonid) { + let fe = ''; + let tclass = ''; + let buttonHtml = ''; + + // Set up icon HTML and hint class based on type + switch (type) { + case 'intro': + tclass = 'intro-hint'; + break; + case 'info': + fe = ` +
    + +
    +
    Information
    `; + tclass = 'info-hint'; + break; + case 'wizard': + fe = ` +
    + +
    +
    Information
    `; + tclass = 'wizard-hint'; + break; + case 'warning': + fe = ` +
    + +
    +
    Information
    `; + tclass = 'warning-hint'; + break; + default: + tclass = 'info-hint'; // Default to info-hint if no match + } + + // Create button HTML if buttonid is provided + if (buttonid) { + buttonHtml = ` +

    + +

    `; + } + + // Add hint to the container based on type + switch (type) { + case 'intro': + $('#' + container).prepend(` +
    +

    ${$.i18n("conf_helptable_expl")}

    + ${text} +
    `); + break; + case 'wizard': + $('#' + container).prepend(` +
    +

    ${$.i18n("wiz_wizavail")}

    + ${$.i18n('wiz_guideyou', text)} + ${buttonHtml} +
    `); + break; + default: + createTable('', 'htb', container, true, tclass); + $('#' + container + ' .htb').append(createTableRow([fe, text], false, true)); } } + function createEffHint(title, text) { - return '

    ' + title + '

    ' + text + '
    '; + return ` +
    +

    ${title}

    + ${text} +
    + `; } function valValue(id, value, min, max) { - if (typeof max === 'undefined' || max == "") - max = 999999; + // Default max to 999999 if it's undefined or an empty string + max = (max === undefined || max === "") ? 999999 : Number(max); + + const numericValue = Number(value); + const numericMin = Number(min); - if (Number(value) > Number(max)) { + if (numericValue > max) { $('#' + id).val(max); showInfoDialog("warning", "", $.i18n('edt_msg_error_maximum_incl', max)); return max; } - else if (Number(value) < Number(min)) { - $('#' + id).val(min); - showInfoDialog("warning", "", $.i18n('edt_msg_error_minimum_incl', min)); - return min; + + if (numericValue < numericMin) { + $('#' + id).val(numericMin); + showInfoDialog("warning", "", $.i18n('edt_msg_error_minimum_incl', numericMin)); + return numericMin; } - return value; + + return numericValue; } -function readImg(input, cb) { - if (input.files && input.files[0]) { - var reader = new FileReader(); - // inject fileName property - reader.fileName = input.files[0].name +function readImg(input, callback) { + const file = input.files?.[0]; - reader.onload = function (e) { - cb(e.target.result, e.target.fileName); - } - reader.readAsDataURL(input.files[0]); + if (file) { + const reader = new FileReader(); + reader.fileName = file.name; + + // Handle file load + reader.onload = (e) => { + callback(e.target.result, e.target.fileName); + }; + + reader.readAsDataURL(file); } } + function isJsonString(str) { try { JSON.parse(str); @@ -427,11 +567,16 @@ const setObjectProperty = (object, path, value) => { function getLongPropertiesPath(path) { if (path) { - var path = path.replace('root.', ''); + // Remove 'root.' from the start of the path + path = path.replace('root.', ''); + + // Split the path into parts and append ".properties" to each part const parts = path.split('.'); parts.forEach(function (part, index) { - this[index] += ".properties"; - }, parts); + parts[index] += ".properties"; + }); + + // Join the parts back together and append a final '.' path = parts.join('.') + '.'; } return path; @@ -444,7 +589,7 @@ function createJsonEditor(container, schema, setconfig, usePanel, arrayre) { if (typeof arrayre === 'undefined') arrayre = true; - var editor = new JSONEditor(document.getElementById(container), + let editor = new JSONEditor(document.getElementById(container), { theme: 'bootstrap3', iconlib: "fontawesome4", @@ -470,329 +615,295 @@ function createJsonEditor(container, schema, setconfig, usePanel, arrayre) { } if (setconfig) { - for (var key in editor.root.editors) { - editor.getEditor("root." + key).setValue(Object.assign({}, editor.getEditor("root." + key).value, window.serverConfig[key])); + for (let key in editor.root.editors) { + editor.getEditor("root." + key).setValue({ ...editor.getEditor("root." + key).value, ...window.serverConfig[key] }); } } return editor; } -function updateJsonEditorSelection(rootEditor, path, key, addElements, newEnumVals, newTitleVals, newDefaultVal, addSelect, addCustom, addCustomAsFirst, customText) { - var editor = rootEditor.getEditor(path); - var orginalProperties = editor.schema.properties[key]; +// Update the selection for JSON Editor +function updateJsonEditorSelection( + rootEditor, path, key, addElements, newEnumVals, newTitleVals, newDefaultVal, + addSelect, addCustom, addCustomAsFirst, customText = "edt_conf_enum_custom" +) { + const editor = rootEditor.getEditor(path); + const originalProperties = editor.schema.properties[key]; + const originalWatchFunctions = rootEditor.watchlist[path + "." + key]; - var orginalWatchFunctions = rootEditor.watchlist[path + "." + key]; + // Unwatch the existing path rootEditor.unwatch(path + "." + key); - var newSchema = []; - newSchema[key] = - { - "type": "string", - "enum": [], - "required": true, - "options": { "enum_titles": [], "infoText": "" }, - "propertyOrder": 1 - }; - - //Add additional elements to overwrite defaults - for (var item in addElements) { - newSchema[key][item] = addElements[item]; - } - - if (orginalProperties) { - if (orginalProperties["title"]) { - newSchema[key]["title"] = orginalProperties["title"]; - } - - if (orginalProperties["options"] && orginalProperties["options"]["infoText"]) { - newSchema[key]["options"]["infoText"] = orginalProperties["options"]["infoText"]; + const newSchema = { + [key]: { + type: "string", + enum: [], + required: true, + options: { enum_titles: [], infoText: "" }, + propertyOrder: 1, + ...addElements, // Merge custom elements directly into schema } + }; - if (orginalProperties["propertyOrder"]) { - newSchema[key]["propertyOrder"] = orginalProperties["propertyOrder"]; - } + // Retain original properties if available + if (originalProperties) { + const { title, options, propertyOrder } = originalProperties; + newSchema[key].title = title || newSchema[key].title; + newSchema[key].options.infoText = options?.infoText || newSchema[key].options.infoText; + newSchema[key].propertyOrder = propertyOrder || newSchema[key].propertyOrder; } + // Handle custom values if (addCustom) { + if (newTitleVals.length === 0) newTitleVals = [...newEnumVals]; - if (newTitleVals.length === 0) { - newTitleVals = [...newEnumVals]; - } - - if (!!!customText) { - customText = "edt_conf_enum_custom"; - } - - if (addCustomAsFirst) { - newEnumVals.unshift("CUSTOM"); - newTitleVals.unshift(customText); - } else { - newEnumVals.push("CUSTOM"); - newTitleVals.push(customText); - } + const customPosition = addCustomAsFirst ? "unshift" : "push"; + newEnumVals[customPosition]("CUSTOM"); + newTitleVals[customPosition](customText); + // Append custom infoText if exists if (newSchema[key].options.infoText) { - var customInfoText = newSchema[key].options.infoText + "_custom"; - newSchema[key].options.infoText = customInfoText; + newSchema[key].options.infoText += "_custom"; } } + // Handle Select options if (addSelect) { newEnumVals.unshift("SELECT"); newTitleVals.unshift("edt_conf_enum_please_select"); newDefaultVal = "SELECT"; } - if (newEnumVals) { - newSchema[key]["enum"] = newEnumVals; - } - - if (newTitleVals) { - newSchema[key]["options"]["enum_titles"] = newTitleVals; - } - if (newDefaultVal) { - newSchema[key]["default"] = newDefaultVal; - } + // Set new values + if (newEnumVals) newSchema[key].enum = newEnumVals; + if (newTitleVals) newSchema[key].options.enum_titles = newTitleVals; + if (newDefaultVal) newSchema[key].default = newDefaultVal; - editor.original_schema.properties[key] = orginalProperties; + // Update the editor schema + editor.original_schema.properties[key] = originalProperties; editor.schema.properties[key] = newSchema[key]; - //Update schema properties for validator + + // Update schema for validation setObjectProperty(rootEditor.validator.schema.properties, getLongPropertiesPath(path) + key, newSchema[key]); + // Re-apply changes to the editor editor.removeObjectProperty(key); delete editor.cached_editors[key]; editor.addObjectProperty(key); - if (orginalWatchFunctions) { - for (var i = 0; i < orginalWatchFunctions.length; i++) { - rootEditor.watch(path + "." + key, orginalWatchFunctions[i]); - } + // Reapply original watch functions + if (originalWatchFunctions) { + originalWatchFunctions.forEach(element => rootEditor.watch(path + "." + key, element)); } + + // Notify watchers rootEditor.notifyWatchers(path + "." + key); } -function updateJsonEditorMultiSelection(rootEditor, path, key, addElements, newEnumVals, newTitleVals, newDefaultVal) { - var editor = rootEditor.getEditor(path); - var orginalProperties = editor.schema.properties[key]; - var orginalWatchFunctions = rootEditor.watchlist[path + "." + key]; - rootEditor.unwatch(path + "." + key); +// Handle custom values logic for enum and title values +function handleCustomValues(newEnumVals, newTitleVals, customText, addCustomAsFirst) { + if (newTitleVals.length === 0) { + newTitleVals = [...newEnumVals]; + } - var newSchema = []; - newSchema[key] = - { - "type": "array", - "format": "select", - "items": { - "type": "string", - "enum": [], - "options": { "enum_titles": [] }, - }, - "options": { "infoText": "" }, - "default": [], - "propertyOrder": 1 - }; + if (!customText) { + customText = "edt_conf_enum_custom"; + } - //Add additional elements to overwrite defaults - for (var item in addElements) { - newSchema[key][item] = addElements[item]; + if (addCustomAsFirst) { + newEnumVals.unshift("CUSTOM"); + newTitleVals.unshift(customText); + } else { + newEnumVals.push("CUSTOM"); + newTitleVals.push(customText); } - if (orginalProperties) { - if (orginalProperties["title"]) { - newSchema[key]["title"] = orginalProperties["title"]; - } + // Add infoText for custom options + if (newSchema[key].options.infoText) { + const customInfoText = newSchema[key].options.infoText + "_custom"; + newSchema[key].options.infoText = customInfoText; + } +} - if (orginalProperties["options"] && orginalProperties["options"]["infoText"]) { - newSchema[key]["options"]["infoText"] = orginalProperties["options"]["infoText"]; - } +// Update the JSON Editor for multi-selection fields +function updateJsonEditorMultiSelection(rootEditor, path, key, addElements, newEnumVals, newTitleVals, newDefaultVal) { + const editor = rootEditor.getEditor(path); + const originalProperties = editor.schema.properties[key]; + const originalWatchFunctions = rootEditor.watchlist[path + "." + key]; - if (orginalProperties["propertyOrder"]) { - newSchema[key]["propertyOrder"] = orginalProperties["propertyOrder"]; + // Unwatch the existing path + rootEditor.unwatch(path + "." + key); + + const newSchema = { + [key]: { + type: "array", + format: "select", + items: { + type: "string", + enum: [], + options: { enum_titles: [] } + }, + options: { infoText: "" }, + default: [], + propertyOrder: 1 } - } + }; - if (newEnumVals) { - newSchema[key]["items"]["enum"] = newEnumVals; - } + // Overwrite default properties with additional elements + Object.assign(newSchema[key], addElements); - if (newTitleVals) { - newSchema[key]["items"]["options"]["enum_titles"] = newTitleVals; + // Retain original properties + if (originalProperties) { + if (originalProperties.title) newSchema[key].title = originalProperties.title; + if (originalProperties?.options?.infoText) newSchema[key].options.infoText = originalProperties.options.infoText; + if (originalProperties.propertyOrder) newSchema[key].propertyOrder = originalProperties.propertyOrder; } - if (newDefaultVal) { - newSchema[key]["default"] = newDefaultVal; - } + // Set new enum and title values + if (newEnumVals) newSchema[key].items.enum = newEnumVals; + if (newTitleVals) newSchema[key].items.options.enum_titles = newTitleVals; + if (newDefaultVal) newSchema[key].default = newDefaultVal; - editor.original_schema.properties[key] = orginalProperties; + // Update the editor schema + editor.original_schema.properties[key] = originalProperties; editor.schema.properties[key] = newSchema[key]; - //Update schema properties for validator + + // Update schema for validation setObjectProperty(rootEditor.validator.schema.properties, getLongPropertiesPath(path) + key, newSchema[key]); + // Re-apply changes to the editor editor.removeObjectProperty(key); delete editor.cached_editors[key]; editor.addObjectProperty(key); - if (orginalWatchFunctions) { - for (var i = 0; i < orginalWatchFunctions.length; i++) { - rootEditor.watch(path + "." + key, orginalWatchFunctions[i]); - } + // Reapply original watch functions + if (originalWatchFunctions) { + originalWatchFunctions.forEach((element) => { + rootEditor.watch(path + "." + key, element); + }); } + + // Notify watchers rootEditor.notifyWatchers(path + "." + key); } +// Update JSON Editor Range with min, max, and step values function updateJsonEditorRange(rootEditor, path, key, minimum, maximum, defaultValue, step, clear) { - var editor = rootEditor.getEditor(path); + const editor = rootEditor.getEditor(path); + const currentValue = rootEditor.getEditor(path + "." + key).getValue(); + const originalProperties = editor.schema.properties[key]; - //Preserve current value when updating range - var currentValue = rootEditor.getEditor(path + "." + key).getValue(); - - var orginalProperties = editor.schema.properties[key]; - var newSchema = []; - newSchema[key] = orginalProperties; + // Initialize the new schema with original properties + const newSchema = { [key]: { ...originalProperties } }; + // Clear range-related properties if needed if (clear) { - delete newSchema[key]["minimum"]; - delete newSchema[key]["maximum"]; - delete newSchema[key]["default"]; - delete newSchema[key]["step"]; + delete newSchema[key].minimum; + delete newSchema[key].maximum; + delete newSchema[key].default; + delete newSchema[key].step; } - if (typeof minimum !== "undefined") { - newSchema[key]["minimum"] = minimum; - } - if (typeof maximum !== "undefined") { - newSchema[key]["maximum"] = maximum; - } + // Set the range values + if (typeof minimum !== "undefined") newSchema[key].minimum = minimum; + if (typeof maximum !== "undefined") newSchema[key].maximum = maximum; if (typeof defaultValue !== "undefined") { - newSchema[key]["default"] = defaultValue; - currentValue = defaultValue; + newSchema[key].default = defaultValue; } + if (typeof step !== "undefined") newSchema[key].step = step; - if (typeof step !== "undefined") { - newSchema[key]["step"] = step; - } - - editor.original_schema.properties[key] = orginalProperties; + // Update the editor schema + editor.original_schema.properties[key] = originalProperties; editor.schema.properties[key] = newSchema[key]; - //Update schema properties for validator + + // Update schema for validation setObjectProperty(rootEditor.validator.schema.properties, getLongPropertiesPath(path) + key, newSchema[key]); + // Re-apply changes to the editor editor.removeObjectProperty(key); delete editor.cached_editors[key]; editor.addObjectProperty(key); - // Restore current (new default) value for new range + // Restore the current value after updating the range rootEditor.getEditor(path + "." + key).setValue(currentValue); } +// Add custom host validation to JSON Editor function addJsonEditorHostValidation() { - JSONEditor.defaults.custom_validators.push(function (schema, value, path) { - var errors = []; + const errors = []; if (!jQuery.isEmptyObject(value)) { switch (schema.format) { case "hostname_or_ip": if (!isValidHostnameOrIP(value)) { - errors.push({ - path: path, - property: 'format', - message: $.i18n('edt_msgcust_error_hostname_ip') - }); + errors.push({ path, property: 'format', message: $.i18n('edt_msgcust_error_hostname_ip') }); } break; case "hostname_or_ip4": if (!isValidHostnameOrIP4(value)) { - errors.push({ - path: path, - property: 'format', - message: $.i18n('edt_msgcust_error_hostname_ip4') - }); + errors.push({ path, property: 'format', message: $.i18n('edt_msgcust_error_hostname_ip4') }); } break; - - //Remove, when new json-editor 2.x is used case "ipv4": if (!isValidIPv4(value)) { - errors.push({ - path: path, - property: 'format', - message: $.i18n('edt_msg_error_ipv4') - }); + errors.push({ path, property: 'format', message: $.i18n('edt_msg_error_ipv4') }); } break; case "ipv6": if (!isValidIPv6(value)) { - errors.push({ - path: path, - property: 'format', - message: $.i18n('edt_msg_error_ipv6') - }); + errors.push({ path, property: 'format', message: $.i18n('edt_msg_error_ipv6') }); } break; case "hostname": if (!isValidHostname(value)) { - errors.push({ - path: path, - property: 'format', - message: $.i18n('edt_msg_error_hostname') - }); + errors.push({ path, property: 'format', message: $.i18n('edt_msg_error_hostname') }); } break; - default: + break; } } + return errors; }); } +// Build a link with localization function buildWL(link, linkt, cl) { - var baseLink = "https://docs.hyperion-project.org/"; - var lang; + const baseLink = "https://docs.hyperion-project.org/"; + const lang = (storedLang === "de" || navigator.locale === "de") ? "de" : "en"; - if (typeof linkt == "undefined") - linkt = "Placeholder"; - - if (storedLang == "de" || navigator.locale == "de") - lang = "de"; - else - lang = "en"; - - if (cl === true) { + if (cl) { linkt = $.i18n(linkt); - return '

    ' + linkt + '

    ' + $.i18n('general_wiki_moreto', linkt) + ': ' + linkt + '
    ' + return `

    ${linkt}

    ${$.i18n('general_wiki_moreto', linkt)}:     ${linkt}
    `; + } else { + return `: ${linkt}`; } - else - return ': ' + linkt + ''; } +// Convert RGB values to Hex color function rgbToHex(rgb) { - if (rgb.length == 3) { - return "#" + - ("0" + parseInt(rgb[0], 10).toString(16)).slice(-2) + - ("0" + parseInt(rgb[1], 10).toString(16)).slice(-2) + - ("0" + parseInt(rgb[2], 10).toString(16)).slice(-2); - } - else + if (rgb.length === 3) { + return `#${("0" + parseInt(rgb[0], 10).toString(16)).slice(-2)}${("0" + parseInt(rgb[1], 10).toString(16)).slice(-2)}${("0" + parseInt(rgb[2], 10).toString(16)).slice(-2)}`; + } else { debugMessage('rgbToHex: Given rgb is no array or has wrong length'); + } } +// Convert Hex color to RGB function hexToRgb(hex) { - var result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex); + const result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex); return result ? { r: parseInt(result[1], 16), g: parseInt(result[2], 16), b: parseInt(result[3], 16) - } : { - r: 0, - g: 0, - b: 0 - }; + } : { r: 0, g: 0, b: 0 }; } + /* Show a notification @param type Valid types are "info","success","warning","danger" @@ -848,13 +959,17 @@ function showNotification(type, message, title = "", addhtml = "") { } function createCP(id, color, cb) { - if (Array.isArray(color)) - color = rgbToHex(color); - else if (color == "undefined") - color = "#AA3399"; + // Ensure color is valid and handle cases where it's an array or undefined + if (Array.isArray(color)) { + color = rgbToHex(color); // Convert array to hex + } else if (color === "undefined") { + color = "#AA3399"; // Default color + } + // Only proceed if the color is a valid hex color if (color.startsWith("#")) { - $('#' + id).colorpicker({ + // Initialize colorpicker with the given color + $(`#${id}`).colorpicker({ format: 'rgb', customClass: 'colorpicker-2x', color: color, @@ -868,42 +983,63 @@ function createCP(id, color, cb) { }, } }); - $('#' + id).colorpicker().on('changeColor', function (e) { - var rgb = e.color.toRGB(); - var hex = e.color.toHex(); - cb(rgb, hex, e); + + // Handle color change events + $(`#${id}`).colorpicker().on('changeColor', (e) => { + const rgb = e.color.toRGB(); + const hex = e.color.toHex(); + cb(rgb, hex, e); // Callback with updated color values }); - } - else + } else { debugMessage('createCP: Given color is not legit'); + } } -// Creates a table with thead and tbody ids -// @param string hid : a class for thead -// @param string bid : a class for tbody -// @param string cont : a container id to html() the table -// @param string bless: if true the table is borderless +// Function to create a table with thead and tbody elements +// @param {string} hid - Class name for thead +// @param {string} bid - Class name for tbody +// @param {string} cont - Container ID to append the table +// @param {boolean} bless - If true, the table is borderless +// @param {string} tclass - Additional class for the table (optional) function createTable(hid, bid, cont, bless, tclass) { - var table = document.createElement('table'); - var thead = document.createElement('thead'); - var tbody = document.createElement('tbody'); + const table = document.createElement('table'); + const thead = document.createElement('thead'); + const tbody = document.createElement('tbody'); + // Set the base class for the table table.className = "table"; - if (bless === true) - table.className += " borderless"; - if (typeof tclass !== "undefined") - table.className += " " + tclass; + + // If 'bless' is true, add the borderless class + if (bless) { + table.classList.add("borderless"); + } + + // If 'tclass' is provided, add it as a class + if (tclass) { + table.classList.add(tclass); + } + + // Remove bottom margin for the table table.style.marginBottom = "0px"; - if (hid != "") + + // Set class for thead and tbody if provided + if (hid !== "") { thead.className = hid; + } tbody.className = bid; - if (hid != "") + + // Append thead and tbody to the table + if (hid !== "") { table.appendChild(thead); + } table.appendChild(tbody); - $('#' + cont).append(table); + // Append the table to the specified container + $(`#${cont}`).append(table); } + + // Creates a table row // @param array list :innerHTML content for / // @param bool head :if null or false it's body @@ -911,29 +1047,27 @@ function createTable(hid, bid, cont, bless, tclass) { // // @return : with or as child(s) function createTableRow(list, head, align) { - var row = document.createElement('tr'); + const row = document.createElement('tr'); - for (var i = 0; i < list.length; i++) { - if (head === true) - var el = document.createElement('th'); - else - var el = document.createElement('td'); - - if (align) + for (const element of list) { + let el = head === true ? document.createElement('th') : document.createElement('td'); + if (align) { el.style.verticalAlign = "middle"; - - var purifyConfig = { + } + const purifyConfig = { ADD_TAGS: ['button'], ADD_ATTR: ['onclick'] }; - el.innerHTML = DOMPurify.sanitize(list[i], purifyConfig); + el.innerHTML = DOMPurify.sanitize(element, purifyConfig); row.appendChild(el); } + + // Return the constructed table row return row; } function createRow(id) { - var el = document.createElement('div'); + let el = document.createElement('div'); el.className = "row"; el.setAttribute('id', id); return el; @@ -942,12 +1076,12 @@ function createRow(id) { function createOptPanel(phicon, phead, bodyid, footerid, css, panelId) { phead = '' + phead; - var pfooter = document.createElement('button'); + let pfooter = document.createElement('button'); pfooter.className = "btn btn-primary"; pfooter.setAttribute("id", footerid); pfooter.innerHTML = '' + $.i18n('general_button_savesettings'); - return createPanel(phead, "", pfooter, "panel-default", bodyid, css, panelId); + return createPanel(phead, "", pfooter, bodyid, css, panelId); } function compareTwoValues(key1, key2, order = 'asc') { @@ -965,25 +1099,23 @@ function compareTwoValues(key1, key2, order = 'asc') { let comparison = 0; if (varA1 > varB1) { comparison = 1; + } else if (varA1 < varB1) { + comparison = -1; } else { - if (varA1 < varB1) { - comparison = -1; - } else { - if (!a.hasOwnProperty(key2) || !b.hasOwnProperty(key2)) { - // property key2 doesn't exist on either object - return 0; - } + if (!a.hasOwnProperty(key2) || !b.hasOwnProperty(key2)) { + // property key2 doesn't exist on either object + return 0; + } - const varA2 = (typeof a[key2] === 'string') - ? a[key2].toUpperCase() : a[key2]; - const varB2 = (typeof b[key1] === 'string') - ? b[key2].toUpperCase() : b[key2]; + const varA2 = (typeof a[key2] === 'string') + ? a[key2].toUpperCase() : a[key2]; + const varB2 = (typeof b[key1] === 'string') + ? b[key2].toUpperCase() : b[key2]; - if (varA2 > varB2) { - comparison = 1; - } else { - comparison = -1; - } + if (varA2 > varB2) { + comparison = 1; + } else { + comparison = -1; } } return ( @@ -993,97 +1125,114 @@ function compareTwoValues(key1, key2, order = 'asc') { } function sortProperties(list) { - for (var key in list) { - list[key].key = key; + // Assign the key as a property for each item in the list + for (const key in list) { + if (Object.hasOwn(list, key)) { + list[key].key = key; + } } - list = $.map(list, function (value, index) { + + // Convert the object to an array + const mappedList = $.map(list, function (value) { return [value]; }); - return list.sort(function (a, b) { - return a.propertyOrder - b.propertyOrder; - }); + + // Sort the array based on the propertyOrder + return mappedList.sort((a, b) => a.propertyOrder - b.propertyOrder); } function createHelpTable(list, phead, panelId) { - var table = document.createElement('table'); - var thead = document.createElement('thead'); - var tbody = document.createElement('tbody'); + const table = document.createElement('table'); + const thead = document.createElement('thead'); + const tbody = document.createElement('tbody'); + list = sortProperties(list); + // Update the heading with an icon and the translation phead = '' + phead + ' ' + $.i18n("conf_helptable_expl"); table.className = 'table table-hover borderless'; + // Create the table header thead.appendChild(createTableRow([$.i18n('conf_helptable_option'), $.i18n('conf_helptable_expl')], true, false)); - for (var key in list) { - if (list[key].access != 'system') { - // break one iteration (in the loop), if the schema has the entry hidden=true - if ("options" in list[key] && "hidden" in list[key].options && (list[key].options.hidden)) + // Iterate over the list and populate the table + for (const key in list) { + if (list[key].access !== 'system') { + // Skip entries if they are hidden or have access restrictions + if ("options" in list[key] && "hidden" in list[key].options && list[key].options.hidden) { continue; - if ("access" in list[key] && ((list[key].access == "advanced" && storedAccess == "default") || (list[key].access == "expert" && storedAccess != "expert"))) + } + + if ("access" in list[key] && ((list[key].access === "advanced" && storedAccess === "default") || (list[key].access === "expert" && storedAccess !== "expert"))) { continue; - var text = list[key].title.replace('title', 'expl'); + } + + const text = list[key].title.replace('title', 'expl'); tbody.appendChild(createTableRow([$.i18n(list[key].title), $.i18n(text)], false, false)); - if (list[key].items && list[key].items.properties) { - var ilist = sortProperties(list[key].items.properties); - for (var ikey in ilist) { - // break one iteration (in the loop), if the schema has the entry hidden=true - if ("options" in ilist[ikey] && "hidden" in ilist[ikey].options && (ilist[ikey].options.hidden)) + if (list[key].items?.properties) { + const ilist = sortProperties(list[key].items.properties); + for (const ikey in ilist) { + // Skip items based on hidden or access restrictions + if ("options" in ilist[ikey] && "hidden" in ilist[ikey].options && ilist[ikey].options.hidden) { continue; - if ("access" in ilist[ikey] && ((ilist[ikey].access == "advanced" && storedAccess == "default") || (ilist[ikey].access == "expert" && storedAccess != "expert"))) + } + + if ("access" in ilist[ikey] && ((ilist[ikey].access === "advanced" && storedAccess === "default") || (ilist[ikey].access === "expert" && storedAccess !== "expert"))) { continue; - var itext = ilist[ikey].title.replace('title', 'expl'); + } + + const itext = ilist[ikey].title.replace('title', 'expl'); tbody.appendChild(createTableRow([$.i18n(ilist[ikey].title), $.i18n(itext)], false, false)); } } } } + table.appendChild(thead); table.appendChild(tbody); - return createPanel(phead, table, undefined, undefined, undefined, undefined, panelId); + return createPanel(phead, table, undefined, undefined, undefined, panelId, undefined); } -function createPanel(head, body, footer, type, bodyid, css, panelId) { - var cont = document.createElement('div'); - var p = document.createElement('div'); - var phead = document.createElement('div'); - var pbody = document.createElement('div'); - var pfooter = document.createElement('div'); +function createPanel(head, body, footer, bodyid, css, panelId, type = 'panel-default') { + const cont = document.createElement('div'); + const p = document.createElement('div'); + const phead = document.createElement('div'); + const pbody = document.createElement('div'); + const pfooter = document.createElement('div'); cont.className = "col-lg-6"; - if (typeof type == 'undefined') - type = 'panel-default'; - - p.className = 'panel ' + type; - if (typeof panelId != 'undefined') { + p.className = `panel ${type}`; + if (panelId) { p.setAttribute("id", panelId); } - phead.className = 'panel-heading ' + css; + phead.className = `panel-heading ${css}`; pbody.className = 'panel-body'; pfooter.className = 'panel-footer'; phead.innerHTML = head; - if (typeof bodyid != 'undefined') { + if (bodyid) { pfooter.style.textAlign = 'right'; pbody.setAttribute("id", bodyid); } - if (typeof body != 'undefined' && body != "") + if (body) { pbody.appendChild(body); + } - if (typeof footer != 'undefined') + if (footer) { pfooter.appendChild(footer); + } p.appendChild(phead); p.appendChild(pbody); - if (typeof footer != 'undefined') { + if (footer) { pfooter.style.textAlign = "right"; p.appendChild(pfooter); } @@ -1094,160 +1243,148 @@ function createPanel(head, body, footer, type, bodyid, css, panelId) { } function createSelGroup(group) { - var el = document.createElement('optgroup'); + const el = document.createElement('optgroup'); el.setAttribute('label', group); return el; } -function createSelOpt(opt, title) { - var el = document.createElement('option'); +function createSelOpt(opt, title = opt) { + const el = document.createElement('option'); el.setAttribute('value', opt); - if (typeof title == 'undefined') - el.innerHTML = opt; - else - el.innerHTML = title; + el.textContent = title; return el; } function createSel(array, group, split) { - if (array.length != 0) { - var el = createSelGroup(group); - for (var i = 0; i < array.length; i++) { - var opt; + if (array.length !== 0) { + const el = createSelGroup(group); + for (const element of array) { + let opt; if (split) { - opt = array[i].split(":") - opt = createSelOpt(opt[0], opt[1]) + const [value, label] = element.split(":"); + opt = createSelOpt(value, label); + } else { + opt = createSelOpt(element); } - else - opt = createSelOpt(array[i]) el.appendChild(opt); } return el; } } + function performTranslation() { $('[data-i18n]').i18n(); } function encode_utf8(s) { - return unescape(encodeURIComponent(s)); + return btoa(new TextEncoder().encode(s).reduce((data, byte) => data + String.fromCharCode(byte), '')); } function getReleases(callback) { $.ajax({ url: window.gitHubReleaseApiUrl, - method: 'get', - error: function (XMLHttpRequest, textStatus, errorThrown) { + method: 'GET', + error: function () { callback(false); }, success: function (releases) { window.gitHubVersionList = releases; - var highestRelease = { - tag_name: '0.0.0' - }; - var highestAlphaRelease = { - tag_name: '0.0.0' - }; - var highestBetaRelease = { - tag_name: '0.0.0' - }; - var highestRcRelease = { - tag_name: '0.0.0' - }; - - for (var i in releases) { - //drafts will be ignored - if (releases[i].draft) - continue; - - if (releases[i].tag_name.includes('alpha')) { - if (sem = semverLite.gt(releases[i].tag_name, highestAlphaRelease.tag_name)) - highestAlphaRelease = releases[i]; - } - else if (releases[i].tag_name.includes('beta')) { - if (sem = semverLite.gt(releases[i].tag_name, highestBetaRelease.tag_name)) - highestBetaRelease = releases[i]; - } - else if (releases[i].tag_name.includes('rc')) { - if (semverLite.gt(releases[i].tag_name, highestRcRelease.tag_name)) - highestRcRelease = releases[i]; - } - else { - if (semverLite.gt(releases[i].tag_name, highestRelease.tag_name)) - highestRelease = releases[i]; + + // Initialize release categories + const defaultRelease = { tag_name: '0.0.0' }; + let highestRelease = { ...defaultRelease }; + let highestAlphaRelease = { ...defaultRelease }; + let highestBetaRelease = { ...defaultRelease }; + let highestRcRelease = { ...defaultRelease }; + + // Iterate through releases + releases.forEach((release) => { + if (release.draft) return; + + if (release.tag_name.includes('alpha') && semverLite.gt(release.tag_name, highestAlphaRelease.tag_name)) { + highestAlphaRelease = release; + } else if (release.tag_name.includes('beta') && semverLite.gt(release.tag_name, highestBetaRelease.tag_name)) { + highestBetaRelease = release; + } else if (release.tag_name.includes('rc') && semverLite.gt(release.tag_name, highestRcRelease.tag_name)) { + highestRcRelease = release; + } else if (semverLite.gt(release.tag_name, highestRelease.tag_name)) { + highestRelease = release; } - } + }); + + // Update global variables with the latest releases window.latestStableVersion = highestRelease; window.latestBetaVersion = highestBetaRelease; window.latestAlphaVersion = highestAlphaRelease; window.latestRcVersion = highestRcRelease; - if (window.serverConfig.general.watchedVersionBranch == "Beta" && semverLite.gt(highestBetaRelease.tag_name, highestRelease.tag_name)) - window.latestVersion = highestBetaRelease; - else - window.latestVersion = highestRelease; - - if (window.serverConfig.general.watchedVersionBranch == "Alpha" && semverLite.gt(highestAlphaRelease.tag_name, highestBetaRelease.tag_name)) - window.latestVersion = highestAlphaRelease; - - if (window.serverConfig.general.watchedVersionBranch == "Alpha" && semverLite.lt(highestAlphaRelease.tag_name, highestBetaRelease.tag_name)) - window.latestVersion = highestBetaRelease; + // Determine the latest version based on the watched branch + const { watchedVersionBranch } = window.serverConfig.general; - //next two if statements are only necessary if we don't have a beta or stable release. We need one alpha release at least - if (window.latestVersion.tag_name == '0.0.0' && highestBetaRelease.tag_name != '0.0.0') + if (watchedVersionBranch === "Beta" && semverLite.gt(highestBetaRelease.tag_name, highestRelease.tag_name)) { window.latestVersion = highestBetaRelease; + } else if (watchedVersionBranch === "Alpha") { + window.latestVersion = semverLite.gt(highestAlphaRelease.tag_name, highestBetaRelease.tag_name) + ? highestAlphaRelease + : highestBetaRelease; + } else { + window.latestVersion = highestRelease; + } - if (window.latestVersion.tag_name == '0.0.0' && highestAlphaRelease.tag_name != '0.0.0') - window.latestVersion = highestAlphaRelease; + // Fallback handling if no stable or beta release exists + if (window.latestVersion.tag_name === '0.0.0') { + if (highestBetaRelease.tag_name !== '0.0.0') { + window.latestVersion = highestBetaRelease; + } else if (highestAlphaRelease.tag_name !== '0.0.0') { + window.latestVersion = highestAlphaRelease; + } + } + // Execute the callback with success callback(true); } }); } function getSystemInfo() { - var sys = window.sysInfo.system; - var shy = window.sysInfo.hyperion; - - var info = "Hyperion Server:\n"; - info += '- Build: ' + shy.build + '\n'; - info += '- Build time: ' + shy.time + '\n'; - info += '- Git Remote: ' + shy.gitremote + '\n'; - info += '- Version: ' + shy.version + '\n'; - info += '- UI Lang: ' + storedLang + ' (BrowserLang: ' + navigator.language + ')\n'; - info += '- UI Access: ' + storedAccess + '\n'; - //info += '- Log lvl: ' + window.serverConfig.logger.level + '\n'; - info += '- Avail Screen Cap.: ' + window.serverInfo.grabbers.screen.available + '\n'; - info += '- Avail Video Cap.: ' + window.serverInfo.grabbers.video.available + '\n'; - info += '- Avail Audio Cap.: ' + window.serverInfo.grabbers.audio.available + '\n'; - info += '- Avail Services: ' + window.serverInfo.services + '\n'; - info += '- Config database: ' + shy.configDatabaseFile + '\n'; - info += '- Database: ' + (shy.readOnlyMode ? "ready-only" : "read/write") + '\n'; - info += '- Mode: ' + (shy.isGuiMode ? "GUI" : "Non-GUI") + '\n'; - - info += '\n'; - - info += 'Hyperion Server OS:\n'; - info += '- Distribution: ' + sys.prettyName + '\n'; - info += '- Architecture: ' + sys.architecture + '\n'; - - if (sys.cpuModelName) - info += '- CPU Model: ' + sys.cpuModelName + '\n'; - if (sys.cpuModelType) - info += '- CPU Type: ' + sys.cpuModelType + '\n'; - if (sys.cpuRevision) - info += '- CPU Revision: ' + sys.cpuRevision + '\n'; - if (sys.cpuHardware) - info += '- CPU Hardware: ' + sys.cpuHardware + '\n'; - - info += '- Kernel: ' + sys.kernelType + ' (' + sys.kernelVersion + ' (WS: ' + sys.wordSize + '))\n'; - info += '- Root/Admin: ' + sys.isUserAdmin + '\n'; - info += '- Qt Version: ' + sys.qtVersion + '\n'; - if (jQuery.inArray("effectengine", window.serverInfo.services) !== -1) { - info += '- Python Version: ' + sys.pyVersion + '\n'; - } - info += '- Browser: ' + navigator.userAgent; + const { system: sys, hyperion: shy } = window.sysInfo; + + let info = `Hyperion Server: +- Build: ${shy.build} +- Build time: ${shy.time} +- Build type: ${shy.buildType} +- Git Remote: ${shy.gitremote} +- Version: ${shy.version} +- UI Lang: ${storedLang} (BrowserLang: ${navigator.language}) +- UI Access: ${storedAccess} +- Avail Screen Cap.: ${window.serverInfo.grabbers.screen.available} +- Avail Video Cap.: ${window.serverInfo.grabbers.video.available} +- Avail Audio Cap.: ${window.serverInfo.grabbers.audio.available} +- Avail Services: ${window.serverInfo.services} +- Config database: ${shy.configDatabaseFile} +- Database: ${shy.readOnlyMode ? "read-only" : "read/write"} +- Mode: ${shy.isGuiMode ? "GUI" : "Non-GUI"} + +Hyperion Server OS: +- Distribution: ${sys.prettyName} +- Architecture: ${sys.architecture}`; + + if (sys.cpuModelName) info += `\n- CPU Model: ${sys.cpuModelName}`; + if (sys.cpuModelType) info += `\n- CPU Type: ${sys.cpuModelType}`; + if (sys.cpuRevision) info += `\n- CPU Revision: ${sys.cpuRevision}`; + if (sys.cpuHardware) info += `\n- CPU Hardware: ${sys.cpuHardware}`; + + info += `\n- Kernel: ${sys.kernelType} (${sys.kernelVersion} (WS: ${sys.wordSize})) +- Root/Admin: ${sys.isUserAdmin} +- Qt Version: ${sys.qtVersion}`; + + if (window.serverInfo.services.includes("effectengine")) { + info += `\n- Python Version: ${sys.pyVersion}`; + } + + info += `\n- Browser: ${navigator.userAgent}`; + return info; } @@ -1259,46 +1396,45 @@ function handleDarkMode() { }).appendTo("head"); setStorage("darkMode", "on"); - $('#btn_darkmode_icon').removeClass('fa fa-moon-o'); - $('#btn_darkmode_icon').addClass('mdi mdi-white-balance-sunny'); + $('#btn_darkmode_icon').removeClass('fa fa-moon-o').addClass('mdi mdi-white-balance-sunny'); $('#navbar_brand_logo').attr("src", 'img/hyperion/logo_negativ.png'); } function isAccessLevelCompliant(accessLevel) { - var isOK = true; - if (accessLevel) { - if (accessLevel === 'system') { - isOK = false; - } - else if (accessLevel === 'advanced' && storedAccess === 'default') { - isOK = false; - } - else if (accessLevel === 'expert' && storedAccess !== 'expert') { - isOK = false; - } + if (!accessLevel) return true; + + switch (accessLevel) { + case 'system': + return false; + case 'advanced': + return storedAccess !== 'default'; + case 'expert': + return storedAccess === 'expert'; + default: + return true; } - return isOK } + function showInputOptions(path, elements, state) { if (!path.startsWith("root.")) { path = ["root", path].join('.'); } - for (var i = 0; i < elements.length; i++) { - $('[data-schemapath="' + path + '.' + elements[i] + '"]').toggle(state); + for (const element of elements) { + $('[data-schemapath="' + path + '.' + element + '"]').toggle(state); } } function showInputOptionForItem(editor, path, item, state) { - //Get access level for full path and item - var accessLevel = getObjectProperty(editor.schema.properties, getLongPropertiesPath(path) + item + ".access"); - // Enable element only, if access level compliant - if (!state || isAccessLevelCompliant(accessLevel)) { + // Get access level for the full path and item + const accessLevel = getObjectProperty(editor.schema.properties, `${getLongPropertiesPath(path)}${item}.access`); + // Enable the element only if access level is compliant + if (!state || isAccessLevelCompliant(accessLevel)) { + // If path is not provided, use the editor's path if (!path) { - debugger; path = editor.path; } showInputOptions(path, [item], state); @@ -1306,41 +1442,37 @@ function showInputOptionForItem(editor, path, item, state) { } function showInputOptionsForKey(editor, item, showForKeys, state) { - var elements = []; - var keysToshow = []; + const elements = []; + let keysToShow = []; + // Determine keys to show based on input type if (Array.isArray(showForKeys)) { - keysToshow = showForKeys; + keysToShow = showForKeys; + } else if (typeof showForKeys === 'string') { + keysToShow.push(showForKeys); } else { - if (typeof showForKeys === 'string') { - keysToshow.push(showForKeys); - } else { - return; - } + return; } - for (let key in editor.schema.properties[item].properties) { - if ($.inArray(key, keysToshow) === -1) { - const accessLevel = editor.schema.properties[item].properties[key].access; + const itemProperties = editor.schema.properties[item].properties; - var hidden = false; - if (editor.schema.properties[item].properties[key].options) { - hidden = editor.schema.properties[item].properties[key].options.hidden; - if (typeof hidden === 'undefined') { - hidden = false; - } - } - //Always disable all elements, but only enable elements, if access level compliant - if (!state || isAccessLevelCompliant(accessLevel)) { - if (!hidden) { - elements.push(key); - } + for (const key in itemProperties) { + // Skip the key if it is not in the list of keys to show + if (!keysToShow.includes(key)) { + const { access, options } = itemProperties[key]; + const hidden = options?.hidden || false; + + // Always disable all elements, but enable only if access level is compliant and not hidden + if ((!state || isAccessLevelCompliant(access)) && !hidden) { + elements.push(key); } } } + showInputOptions(item, elements, state); } + function encodeHTML(s) { return s.replace(/&/g, '&').replace(/ { stop(true); }); - wiz_editor.on("change", function (e) { - const val = wiz_editor.getEditor('root.color.channelAdjustment.' + profile + '').getValue(); - const temp = JSON.parse(JSON.stringify(val)); - delete temp.leds - requestAdjustment(JSON.stringify(temp), "", true); + wiz_editor.on("change", function () { + const { leds, ...adjustments } = wiz_editor.getEditor('root.color.channelAdjustment.' + profile).getValue(); + requestAdjustment(adjustments, "", true); }); - step++ performAction(); } diff --git a/assets/webconfig/js/wizards/rgbByteOrderWizard.js b/assets/webconfig/js/wizards/rgbByteOrderWizard.js index 5d6121748..2a65f1e4f 100644 --- a/assets/webconfig/js/wizards/rgbByteOrderWizard.js +++ b/assets/webconfig/js/wizards/rgbByteOrderWizard.js @@ -12,11 +12,11 @@ const rgbByteOrderWizard = (() => { if (color == 'rgb(255, 0, 0)') { $("#wiz_canv_color").css('background-color', 'rgb(0, 255, 0)'); - requestSetColor('0', '255', '0'); + requestSetColor(0, 255, 0); } else { $("#wiz_canv_color").css('background-color', 'rgb(255, 0, 0)'); - requestSetColor('255', '0', '0'); + requestSetColor(255, 0, 0); } } @@ -90,7 +90,7 @@ const rgbByteOrderWizard = (() => { $("#wiz_g_select").html($("#wiz_r_select").html()); $("#wiz_r_select").trigger('change'); - requestSetColor('255', '0', '0'); + requestSetColor(255, 0, 0); setTimeout(requestSetSource, 100, 'auto'); setStorage("wizardactive", true); diff --git a/bin/compile.sh b/bin/compile.sh deleted file mode 100644 index d9c1ffef2..000000000 --- a/bin/compile.sh +++ /dev/null @@ -1,48 +0,0 @@ -#!/bin/sh - -# exit on error -set -e - -TARGET=${1:-hyperion} -CFG="${2:-Release}" -INST="$( [ "${3:-}" = "install" ] && echo true || echo false )" - -sudo apt-get update -sudo apt-get install \ - git \ - cmake \ - build-essential \ - qtbase5-dev \ - libqt5serialport5-dev \ - libusb-1.0-0-dev \ - libturbojpeg0-dev \ - libjpeg-dev \ - python3-dev \ - libcec-dev \ - libxcb-util0-dev \ - libxcb-randr0-dev \ - libxrandr-dev \ - libxrender-dev \ - libavahi-core-dev \ - libavahi-compat-libdnssd-dev \ - libssl-dev \ - libqt5sql5-sqlite \ - libqt5svg5-dev \ - -if [ -e /dev/vc-cma -a -e /dev/vc-mem ] -then - sudo apt-get install libraspberrypi-dev -fi - -git clone --recursive https://github.com/hyperion-project/hyperion.ng.git ${TARGET} - -rm -rf $TARGET/build -mkdir -p $TARGET/build -cd $TARGET/build -cmake -DCMAKE_BUILD_TYPE=$CFG .. -make -j $(nproc) - -# optional: install into your system -$INST && sudo make install/strip -echo "to uninstall (not very well tested, please keep that in mind):" -echo " sudo make uninstall" diff --git a/bin/copy_binaries_to_deploy.sh b/bin/copy_binaries_to_deploy.sh deleted file mode 100755 index 6452c2c7d..000000000 --- a/bin/copy_binaries_to_deploy.sh +++ /dev/null @@ -1,26 +0,0 @@ -#!/bin/sh - -if [ "$#" -ne 2 ] || ! [ -d "$1" ] || ! [ -d "$2" ]; then - echo "Usage: $0 " >&2 - exit 1 -fi - -builddir="$1" -repodir="$2" -echo build directory = $builddir -echo repository root dirrectory = $repodir - -outfile="$repodir/deploy/hyperion.tar.gz" -echo create $outfile - -tar --create --verbose --gzip --absolute-names --show-transformed-names \ - --file "$outfile" \ - --transform "s:$builddir/bin/:hyperion/bin/:" \ - --transform "s:$repodir/bin/hyperion.init.sh:hyperion/init.d/hyperion.init.sh:" \ - --transform "s://:/:g" \ - "$builddir/bin/hyperiond" \ - "$builddir/bin/hyperion-remote" \ - "$builddir/bin/hyperion-v4l2" \ - "$builddir/bin/gpio2spi" \ - "$builddir/bin/dispmanx2png" \ - "$repodir/bin/hyperion.init.sh" \ diff --git a/bin/create_all_releases.sh b/bin/create_all_releases.sh deleted file mode 100755 index 09cfc934e..000000000 --- a/bin/create_all_releases.sh +++ /dev/null @@ -1,40 +0,0 @@ -#!/bin/sh - -# make_release [] -make_release() -{ - echo - echo "--- build release for $1 ---" - echo - RELEASE=$1 - PLATFORM=$2 - shift 2 - - rm -rf build-${RELEASE} - mkdir -p build-${RELEASE} - rm -rf deploy/${RELEASE} - mkdir -p deploy/${RELEASE} - - cd build-${RELEASE} - - cmake -DCMAKE_INSTALL_PREFIX=/usr -DPLATFORM=${PLATFORM} -DCMAKE_BUILD_TYPE=Release -Wno-dev $@ .. || exit 1 - #cmake -DCMAKE_INSTALL_PREFIX=/usr -DPLATFORM=${PLATFORM} -DCMAKE_BUILD_TYPE=Debug $@ .. || exit 1 - make -j $(nproc) || exit 1 - strip bin/* - make package -j $(nproc) - mv Hyperion-* ../deploy/${RELEASE} - cd .. - bin/create_release.sh . ${RELEASE} -} - -#export QTDIR="/opt/Qt/6.2.2/gcc_64" -#export QTDIR="/opt/Qt/5.15.2/gcc_64" - -CMAKE_PROTOC_FLAG="-DIMPORT_PROTOC=../build-x86x64/protoc_export.cmake" -CMAKE_FLATC_FLAG="-DIMPORT_FLATC=../build-x86x64/flatc_export.cmake" - -make_release x86x64 x11 $@ -#make_release x32 x11 $@ -DCMAKE_TOOLCHAIN_FILE="../cmake/Toolchain-x32.cmake" ${CMAKE_PROTOC_FLAG} ${CMAKE_FLATC_FLAG} -#make_release rpi rpi $@ -DCMAKE_TOOLCHAIN_FILE="../cmake/Toolchain-rpi.cmake" ${CMAKE_PROTOC_FLAG} ${CMAKE_FLATC_FLAG} -#make_release wetek wetek $@ -DCMAKE_TOOLCHAIN_FILE="../cmake/Toolchain-rpi.cmake" ${CMAKE_PROTOC_FLAG} ${CMAKE_FLATC_FLAG} -#make_release imx6 imx6 $@ -DCMAKE_TOOLCHAIN_FILE="../cmake/Toolchain-imx6.cmake" ${CMAKE_PROTOC_FLAG} ${CMAKE_FLATC_FLAG} diff --git a/bin/create_release.sh b/bin/create_release.sh deleted file mode 100755 index bbe302fa4..000000000 --- a/bin/create_release.sh +++ /dev/null @@ -1,34 +0,0 @@ -#!/bin/sh - -if [ "$#" -ne 2 ] || ! [ -d "$1" ]; then - echo "Usage: $0 " >&2 - exit 1 -fi - -repodir="$1" -buildid="$2" -builddir=$repodir/build-$buildid -echo build directory = $builddir -echo repository root directory = $repodir -if ! [ -d "$builddir" ]; then - echo "Could not find build director" - exit 1 -fi - -outfile="$repodir/deploy/hyperion_$buildid.tar.gz" -echo create $outfile - -tar --create --gzip --absolute-names --show-transformed-names --ignore-failed-read\ - --file "$outfile" \ - --transform "s:$builddir/bin/:hyperion/bin/:" \ - --transform "s:$repodir/config/:hyperion/config/:" \ - --transform "s:$repodir/bin/service/hyperion.init:hyperion/services/hyperion.init:" \ - --transform "s:$repodir/bin/service/hyperion.systemd:hyperion/services/hyperion.systemd:" \ - --transform "s:$repodir/bin/service/hyperion.initctl:hyperion/services/hyperion.initctl:" \ - --transform "s://:/:g" \ - "$builddir/bin/hyperion"* \ - "$repodir/bin/service/hyperion.init" \ - "$repodir/bin/service/hyperion.systemd" \ - "$repodir/bin/service/hyperion.initctl" \ - "$repodir/config/hyperion.config.json.default" - diff --git a/cmake/linux/BundleLinux.cmake.in b/cmake/linux/BundleLinux.cmake.in index a2306edf7..a4e465ece 100644 --- a/cmake/linux/BundleLinux.cmake.in +++ b/cmake/linux/BundleLinux.cmake.in @@ -96,8 +96,7 @@ endforeach() file(INSTALL FILES ${PREREQUISITE_LIBS} DESTINATION "${CMAKE_INSTALL_PREFIX}/share/hyperion/lib") # Create a qt.conf file in 'share/hyperion/bin' to override hard-coded search paths in Qt plugins -file(WRITE "${CMAKE_BINARY_DIR}/qt.conf" "[Paths]\nPlugins=../lib/\n") -file(INSTALL FILES "${CMAKE_BINARY_DIR}/qt.conf" DESTINATION "${CMAKE_INSTALL_PREFIX}/share/hyperion/bin") +file(WRITE "${CMAKE_INSTALL_PREFIX}/share/hyperion/bin/qt.conf" "[Paths]\nPlugins=../lib/\n") if(NOT PYTHON_MODULES_DIR STREQUAL "" AND NOT PYTHON_VERSION STREQUAL "") # Copy Python modules to 'share/hyperion/lib/pythonMAJOR.MINOR' and ignore the unnecessary stuff listed below diff --git a/cmake/macos/BundleMacOS.cmake.in b/cmake/macos/BundleMacOS.cmake.in index 06d7d5f89..507dab63b 100644 --- a/cmake/macos/BundleMacOS.cmake.in +++ b/cmake/macos/BundleMacOS.cmake.in @@ -85,6 +85,9 @@ if(EXISTS ${MAC_BUNDLE_INSTALL_BIN_DIR}/@MAC_BUNDLE_NAME@) endif() endforeach() + # Create a qt.conf file to override hard-coded search paths in Qt plugins + file(WRITE "${MAC_BUNDLE_INSTALL_DIR}/Contents/Resources/qt.conf" "[Paths]\nPlugins=plugins\n") + include(BundleUtilities) file(GLOB_RECURSE QT_PLUGINS LIST_DIRECTORIES OFF "${MAC_BUNDLE_INSTALL_PLUGIN_DIR}/*") fixup_bundle("${MAC_BUNDLE_INSTALL_DIR}" "${QT_PLUGINS}" "${MAC_BUNDLE_INSTALL_TMP_DIR};${QT_HOST_LIBS}" IGNORE_ITEM "Python") diff --git a/cmake/windows/BundleWindows.cmake.in b/cmake/windows/BundleWindows.cmake.in index 23601bb40..35cb072ad 100644 --- a/cmake/windows/BundleWindows.cmake.in +++ b/cmake/windows/BundleWindows.cmake.in @@ -52,8 +52,7 @@ if(EXISTS @CMAKE_BINARY_DIR@/bin/@PROJECT_NAME@@CMAKE_EXECUTABLE_SUFFIX@) endwhile() # Create a qt.conf file in 'bin' to override hard-coded search paths in Qt plugins - file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/qt.conf" "[Paths]\nPlugins=../lib/\n") - file(INSTALL FILES "${CMAKE_CURRENT_BINARY_DIR}/qt.conf" DESTINATION "${CMAKE_INSTALL_PREFIX}/bin") + file(WRITE "${CMAKE_INSTALL_PREFIX}/bin/qt.conf" "[Paths]\nPlugins=../lib/\n") # Copy libjpeg-turbo to 'hyperion' if(ENABLE_MF AND NOT TurboJPEG_INCLUDE_DIR STREQUAL "") diff --git a/doc/development/JSON-API _Commands_Overview.md b/doc/development/JSON-API _Commands_Overview.md index 549c5e621..d4419e542 100644 --- a/doc/development/JSON-API _Commands_Overview.md +++ b/doc/development/JSON-API _Commands_Overview.md @@ -10,84 +10,91 @@ _Authorization (via password or bearer token)_ **Yes** - Authorization required, but can be disabled for local network calls
    **Admin**: Authorization is always required -_Instance specific_ +_Instance Cmd_ -**Yes** - A specific instance can be addressed
    +**Single** - A specific instance can be addressed
    **Multi** - Multiple instances can be addressed via one request
    **No** - The command is not instance related +_Instance must Run_ + +**No** - The instance is not required to run
    +**Yes** - The instance the command is to be applied to must be running
    + _http/s Support_ **Yes** - Command can be used by individual http/s requests
    **No** - Applies only to WebSocket or http/s sessions -| Command | Sub-Command | Authorization | Instance specific | http/s Support | -|:---------------|:------------------------|:--------------|:------------------|:---------------| -| adjustment | - | Yes | Multi | Yes | -| authorize | adminRequired | No | No | Yes | -| authorize | answerRequest | Admin | No | No | -| authorize | createToken | Admin | No | No | -| authorize | deleteToken | Admin | No | Yes | -| authorize | getPendingTokenRequests | Admin | No | No | -| authorize | getTokenList | Admin | No | Yes | -| authorize | login | No | No | No | -| authorize | logout | No | No | No | -| authorize | newPassword | Admin | No | Yes | -| authorize | newPasswordRequired | No | No | Yes | -| authorize | renameToken | Admin | No | Yes | -| authorize | requestToken | No | No | Yes | -| authorize | tokenRequired | No | No | Yes | -| clear | - | Yes | Multi | Yes | -| clearall | - | Yes | Multi | Yes | -| color | - | Yes | Multi | Yes | -| componentstate | - | Yes | Multi | Yes | -| config | getconfig | Admin | Yes | Yes | -| config | getschema | Admin | Yes | Yes | -| config | reload | Admin | Yes | Yes | -| config | restoreconfig | Admin | Yes | Yes | -| config | setconfig | Admin | Yes | Yes | -| correction | - | Yes | Yes | Yes | -| create-effect | - | Yes | Yes | Yes | -| delete-effect | - | Yes | Yes | Yes | -| effect | - | Yes | Multi | Yes | -| image | - | Yes | Multi | Yes | -| inputsource | discover | Yes | No | Yes | -| inputsource | getProperties | Yes | No | Yes | -| instance | createInstance | Admin | No | Yes | -| instance | deleteInstance | Admin | No | Yes | -| instance | saveName | Admin | No | Yes | -| instance | startInstance | Yes | No | Yes | -| instance | stopInstance | Yes | No | Yes | -| instance | switchTo | Yes | No | Yes | -| ledcolors | imagestream-start | Yes | Yes | Yes | -| ledcolors | imagestream-stop | Yes | Yes | Yes | -| ledcolors | ledstream-start | Yes | Yes | Yes | -| ledcolors | ledstream-stop | Yes | Yes | Yes | -| leddevice | addAuthorization | Yes | Yes | Yes | -| leddevice | discover | Yes | Yes | Yes | -| leddevice | getProperties | Yes | Yes | Yes | -| leddevice | identify | Yes | Yes | Yes | -| logging | start | Yes | No | Yes | -| logging | stop | Yes | No | Yes | -| processing | - | Yes | Multi | Yes | -| serverinfo | - | Yes | Yes | Yes | -| serverinfo | getInfo | Yes | Yes | Yes | -| serverinfo | subscribe | Yes | Yes | No | -| serverinfo | unsubscribe | Yes | Yes | No | -| serverinfo | getSubscriptions | Yes | Yes | No | -| serverinfo | getSubscriptionCommands | No | No | No | -| service | discover | Yes | No | Yes | -| sourceselect | - | Yes | Multi | Yes | -| sysinfo | - | Yes | No | Yes | -| system | restart | Yes | No | Yes | -| system | resume | Yes | No | Yes | -| system | suspend | Yes | No | Yes | -| system | toggleSuspend | Yes | No | Yes | -| system | idle | Yes | No | Yes | -| system | toggleIdle | Yes | No | Yes | -| temperature | - | Yes | Yes | Yes | -| transform | - | Yes | Yes | Yes | -| videomode | - | Yes | No | Yes | +| Command | Sub-Command | Authorization | Instance Cmd | Instance must Run | http/s Support | +|----------------|-------------------------|---------------|--------------|-------------------|----------------| +| adjustment | | Yes | Multi | Yes | Yes | +| authorize | adminRequired | No | No | No | Yes | +| authorize | answerRequest | Admin | No | No | No | +| authorize | createToken | Admin | No | No | No | +| authorize | deleteToken | Admin | No | No | Yes | +| authorize | getPendingTokenRequests | Admin | No | No | No | +| authorize | getTokenList | Admin | No | No | Yes | +| authorize | login | No | No | No | No | +| authorize | logout | No | No | No | No | +| authorize | newPassword | Admin | No | No | Yes | +| authorize | newPasswordRequired | No | No | No | Yes | +| authorize | renameToken | Admin | No | No | Yes | +| authorize | requestToken | No | No | No | Yes | +| authorize | tokenRequired | No | No | No | Yes | +| clear | | Yes | Multi | Yes | Yes | +| clearall | | Yes | Multi | Yes | Yes | +| color | | Yes | Multi | Yes | Yes | +| componentstate | | Yes | Multi | Yes | Yes | +| config | getconfig | Admin | No | No | Yes | +| config | getschema | Admin | No | No | Yes | +| config | reload | Admin | No | No | Yes | +| config | restoreconfig | Admin | No | No | Yes | +| config | setconfig | Admin | No | No | Yes | +| correction | | Yes | Single | Yes | Yes | +| create-effect | | Yes | Single | Yes | Yes | +| delete-effect | | Yes | Single | Yes | Yes | +| effect | | Yes | Multi | Yes | Yes | +| image | | Yes | Multi | Yes | Yes | +| inputsource | discover | Yes | No | No | Yes | +| inputsource | getProperties | Yes | No | No | Yes | +| instance | createInstance | Admin | No | No | Yes | +| instance | deleteInstance | Admin | No | No | Yes | +| instance | saveName | Admin | No | No | Yes | +| instance | startInstance | Yes | No | No | Yes | +| instance | stopInstance | Yes | No | No | Yes | +| instance | switchTo | Yes | No | No | Yes | +| instance-data | getImageSnapshot | Yes | Single | Yes | Yes | +| instance-data | getLedSnapshot | Yes | Single | Yes | Yes | +| ledcolors | imagestream-start | Yes | Single | Yes | Yes | +| ledcolors | imagestream-stop | Yes | Single | Yes | Yes | +| ledcolors | ledstream-start | Yes | Single | Yes | Yes | +| ledcolors | ledstream-stop | Yes | Single | Yes | Yes | +| leddevice | addAuthorization | Yes | Single | Yes | Yes | +| leddevice | discover | Yes | Single | Yes | Yes | +| leddevice | getProperties | Yes | Single | Yes | Yes | +| leddevice | identify | Yes | Single | Yes | Yes | +| logging | start | Yes | No | No | Yes | +| logging | stop | Yes | No | No | Yes | +| processing | | Yes | Multi | Yes | Yes | +| serverinfo | | Yes | Single | Yes | Yes | +| serverinfo | getInfo | Yes | No or Single | Yes | Yes | +| serverinfo | subscribe | Yes | No or Single | Yes | No | +| serverinfo | unsubscribe | Yes | No or Single | Yes | No | +| serverinfo | getSubscriptions | Yes | No or Single | Yes | No | +| serverinfo | getSubscriptionCommands | No | No | No | No | +| service | discover | Yes | No | No | Yes | +| sourceselect | | Yes | Multi | Yes | Yes | +| sysinfo | | Yes | No | No | Yes | +| system | restart | Yes | No | No | Yes | +| system | resume | Yes | No | No | Yes | +| system | suspend | Yes | No | No | Yes | +| system | toggleSuspend | Yes | No | No | Yes | +| system | idle | Yes | No | No | Yes | +| system | toggleIdle | Yes | No | No | Yes | +| temperature | | Yes | Single | Yes | Yes | +| transform | | Yes | Single | Yes | Yes | +| videomode | | Yes | No | No | Yes | ## Subscription updates diff --git a/include/api/API.h b/include/api/API.h index 8b6476e60..1f778bb93 100644 --- a/include/api/API.h +++ b/include/api/API.h @@ -13,6 +13,7 @@ // qt includes #include +#include class JsonCallbacks; class HyperionIManager; @@ -379,7 +380,10 @@ class API : public QObject HyperionIManager *_instanceManager; Logger *_log; - Hyperion *_hyperion; + + // current instance index + quint8 _currInstanceIndex; + QSharedPointer _hyperion; signals: /// @@ -421,7 +425,4 @@ class API : public QObject // Contains all active register call data std::map _activeRegisters; - - // current instance index - quint8 _currInstanceIndex; }; diff --git a/include/api/JsonAPI.h b/include/api/JsonAPI.h index 7b267e4a8..83c74d8dd 100644 --- a/include/api/JsonAPI.h +++ b/include/api/JsonAPI.h @@ -75,10 +75,10 @@ private slots: /// /// @brief Handle whenever the state of a instance (HyperionIManager) changes according to enum instanceState /// @param instaneState A state from enum - /// @param instance The index of instance + /// @param instanceId The index of instance /// @param name The name of the instance, just available with H_CREATED /// - void handleInstanceStateChange(InstanceState state, quint8 instance, const QString &name = QString()); + void handleInstanceStateChange(InstanceState state, quint8 instanceId, const QString &name = QString()); signals: /// @@ -89,7 +89,7 @@ private slots: /// /// Signal emits whenever a JSON-message should be forwarded /// - void forwardJsonMessage(QJsonObject); + void forwardJsonMessage(const QJsonObject, quint8); /// /// Signal emits whenever a hyperion event request for all instances should be forwarded @@ -103,11 +103,11 @@ private slots: /// /// @brief Handle the switches of Hyperion instances - /// @param instance the instance to switch - /// @param forced indicate if it was a forced switch by system + /// @param instanceId the instance to switch + /// @param forced indicate if it was a forced switch by system /// @return true on success. false if not found /// - bool handleInstanceSwitch(quint8 instance = 0, bool forced = false); + bool handleInstanceSwitch(quint8 instanceId = 0, bool forced = false); /// /// Handle an incoming JSON Color message @@ -123,7 +123,6 @@ private slots: /// void handleImageCommand(const QJsonObject &message, const JsonApiCommand& cmd); -#if defined(ENABLE_EFFECTENGINE) /// /// Handle an incoming JSON Effect message /// @@ -144,7 +143,6 @@ private slots: /// @param message the incoming message /// void handleDeleteEffectCommand(const QJsonObject &message, const JsonApiCommand& cmd); -#endif /// /// Handle an incoming JSON System info message diff --git a/include/api/JsonApiCommand.h b/include/api/JsonApiCommand.h index cbcc6b57f..6722148a1 100644 --- a/include/api/JsonApiCommand.h +++ b/include/api/JsonApiCommand.h @@ -86,7 +86,6 @@ class SubCommand { DeleteToken, Discover, GetConfig, - GetConfigOld, GetImageSnapshot, GetInfo, GetLedSnapshot, @@ -139,7 +138,6 @@ class SubCommand { case DeleteToken: return "deleteToken"; case Discover: return "discover"; case GetConfig: return "getconfig"; - case GetConfigOld: return "getconfig-old"; case GetImageSnapshot: return "getImageSnapshot"; case GetInfo: return "getInfo"; case GetLedSnapshot: return "getLedSnapshot"; @@ -204,39 +202,68 @@ class InstanceCmd { public: enum Type { No, - Yes, - Multi + No_or_Single, + No_or_Multi, + Single, + Multi, + }; + + enum MustRun { + MustRun_No, + MustRun_Yes }; + + static QString toString(Type type) { + switch (type) { + case No: return "No instance support"; + case Single: return "Support a single instance"; + case No_or_Single: return "Support no or a single instance"; + case Multi: return "Support multiple instances"; + case No_or_Multi: return "Support no or multiple instances"; + default: return "unknown"; + } + } + + static QString toString(MustRun mustRun) { + switch (mustRun) { + case MustRun_No: return "Instance not required to be running"; + case MustRun_Yes: return "Instance must be running"; + default: return "unknown"; + } + } }; class JsonApiCommand { public: - JsonApiCommand() : command(Command::Unknown), subCommand(SubCommand::Unknown), tan(0), - authorization(Authorization::Admin), - isInstanceCmd(InstanceCmd::No), + authorization( Authorization::Admin), + instanceCmdType(InstanceCmd::No), + instanceMustRun( InstanceCmd::MustRun_No), isNolistenerCmd(NoListenerCmd::Yes) {} JsonApiCommand(Command::Type command, SubCommand::Type subCommand, - Authorization::Type authorization, - InstanceCmd::Type isInstanceCmd, + Authorization::Type authorization, + InstanceCmd::Type instanceCmdType, + InstanceCmd::MustRun instanceCmdMustRun, NoListenerCmd::Type isNolistenerCmd, int tan = 0) : command(command), subCommand(subCommand), tan(tan), authorization(authorization), - isInstanceCmd(isInstanceCmd), + instanceCmdType(instanceCmdType), + instanceMustRun(instanceCmdMustRun), isNolistenerCmd(isNolistenerCmd) {} Command::Type getCommand() const { return command; } SubCommand::Type getSubCommand() const { return subCommand; } - InstanceCmd::Type instanceCmd() const { return isInstanceCmd; } + InstanceCmd::Type getInstanceCmdType() const { return instanceCmdType; } + InstanceCmd::MustRun getInstanceMustRun() const { return instanceMustRun; } int getTan() const { return tan; } QString toString() const { @@ -252,7 +279,8 @@ class JsonApiCommand { int tan; Authorization::Type authorization; - InstanceCmd::Type isInstanceCmd; + InstanceCmd::Type instanceCmdType; + InstanceCmd::MustRun instanceMustRun; NoListenerCmd::Type isNolistenerCmd; }; @@ -263,74 +291,73 @@ class ApiCommandRegister { static const CommandLookupMap& getCommandLookup() { static const CommandLookupMap commandLookup { - { {"adjustment", ""}, { Command::Adjustment, SubCommand::Empty, Authorization::Yes, InstanceCmd::Multi, NoListenerCmd::Yes} }, - { {"authorize", "adminRequired"}, { Command::Authorize, SubCommand::AdminRequired, Authorization::No, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"authorize", "answerRequest"}, { Command::Authorize, SubCommand::AnswerRequest, Authorization::Admin, InstanceCmd::No, NoListenerCmd::No} }, - { {"authorize", "createToken"}, { Command::Authorize, SubCommand::CreateToken, Authorization::Admin, InstanceCmd::No, NoListenerCmd::No} }, - { {"authorize", "deleteToken"}, { Command::Authorize, SubCommand::DeleteToken, Authorization::Admin, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"authorize", "getPendingTokenRequests"}, { Command::Authorize, SubCommand::GetPendingTokenRequests, Authorization::Admin, InstanceCmd::No, NoListenerCmd::No} }, - { {"authorize", "getTokenList"}, { Command::Authorize, SubCommand::GetTokenList, Authorization::Admin, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"authorize", "login"}, { Command::Authorize, SubCommand::Login, Authorization::No, InstanceCmd::No, NoListenerCmd::No} }, - { {"authorize", "logout"}, { Command::Authorize, SubCommand::Logout, Authorization::No, InstanceCmd::No, NoListenerCmd::No} }, - { {"authorize", "newPassword"}, { Command::Authorize, SubCommand::NewPassword, Authorization::Admin, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"authorize", "newPasswordRequired"}, { Command::Authorize, SubCommand::NewPasswordRequired, Authorization::No, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"authorize", "renameToken"}, { Command::Authorize, SubCommand::RenameToken, Authorization::Admin, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"authorize", "requestToken"}, { Command::Authorize, SubCommand::RequestToken, Authorization::No, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"authorize", "tokenRequired"}, { Command::Authorize, SubCommand::TokenRequired, Authorization::No, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"clear", ""}, { Command::Clear, SubCommand::Empty, Authorization::Yes, InstanceCmd::Multi, NoListenerCmd::Yes} }, - { {"clearall", ""}, { Command::ClearAll, SubCommand::Empty, Authorization::Yes, InstanceCmd::Multi, NoListenerCmd::Yes} }, - { {"color", ""}, { Command::Color, SubCommand::Empty, Authorization::Yes, InstanceCmd::Multi, NoListenerCmd::Yes} }, - { {"componentstate", ""}, { Command::ComponentState, SubCommand::Empty, Authorization::Yes, InstanceCmd::Multi, NoListenerCmd::Yes} }, - { {"config", "getconfig"}, { Command::Config, SubCommand::GetConfig, Authorization::Admin, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"config", "getconfig-old"}, { Command::Config, SubCommand::GetConfigOld, Authorization::Admin, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"config", "getschema"}, { Command::Config, SubCommand::GetSchema, Authorization::Admin, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"config", "reload"}, { Command::Config, SubCommand::Reload, Authorization::Admin, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"config", "restoreconfig"}, { Command::Config, SubCommand::RestoreConfig, Authorization::Admin, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"config", "setconfig"}, { Command::Config, SubCommand::SetConfig, Authorization::Admin, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"correction", ""}, { Command::Correction, SubCommand::Empty, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"create-effect", ""}, { Command::CreateEffect, SubCommand::Empty, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"delete-effect", ""}, { Command::DeleteEffect, SubCommand::Empty, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"effect", ""}, { Command::Effect, SubCommand::Empty, Authorization::Yes, InstanceCmd::Multi, NoListenerCmd::Yes} }, - { {"image", ""}, { Command::Image, SubCommand::Empty, Authorization::Yes, InstanceCmd::Multi, NoListenerCmd::Yes} }, - { {"inputsource", "discover"}, { Command::InputSource, SubCommand::Discover, Authorization::Yes, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"inputsource", "getProperties"}, { Command::InputSource, SubCommand::GetProperties, Authorization::Yes, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"instance", "createInstance"}, { Command::Instance, SubCommand::CreateInstance, Authorization::Admin, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"instance", "deleteInstance"}, { Command::Instance, SubCommand::DeleteInstance, Authorization::Admin, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"instance", "saveName"}, { Command::Instance, SubCommand::SaveName, Authorization::Admin, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"instance", "startInstance"}, { Command::Instance, SubCommand::StartInstance, Authorization::Yes, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"instance", "stopInstance"}, { Command::Instance, SubCommand::StopInstance, Authorization::Yes, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"instance", "switchTo"}, { Command::Instance, SubCommand::SwitchTo, Authorization::Yes, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"instance-data", "getImageSnapshot"}, { Command::InstanceData, SubCommand::GetImageSnapshot, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"instance-data", "getLedSnapshot"}, { Command::InstanceData, SubCommand::GetLedSnapshot, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes } }, - { {"ledcolors", "imagestream-start"}, { Command::LedColors, SubCommand::ImageStreamStart, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"ledcolors", "imagestream-stop"}, { Command::LedColors, SubCommand::ImageStreamStop, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"ledcolors", "ledstream-start"}, { Command::LedColors, SubCommand::LedStreamStart, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"ledcolors", "ledstream-stop"}, { Command::LedColors, SubCommand::LedStreamStop, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"leddevice", "addAuthorization"}, { Command::LedDevice, SubCommand::AddAuthorization, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"leddevice", "discover"}, { Command::LedDevice, SubCommand::Discover, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"leddevice", "getProperties"}, { Command::LedDevice, SubCommand::GetProperties, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"leddevice", "identify"}, { Command::LedDevice, SubCommand::Identify, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"logging", "start"}, { Command::Logging, SubCommand::Start, Authorization::Yes, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"logging", "stop"}, { Command::Logging, SubCommand::Stop, Authorization::Yes, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"processing", ""}, { Command::Processing, SubCommand::Empty, Authorization::Yes, InstanceCmd::Multi, NoListenerCmd::Yes} }, - { {"serverinfo", ""}, { Command::ServerInfo, SubCommand::Empty, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"serverinfo", "getInfo"}, { Command::ServerInfo, SubCommand::GetInfo, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"serverinfo", "subscribe"}, { Command::ServerInfo, SubCommand::Subscribe, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::No} }, - { {"serverinfo", "unsubscribe"}, { Command::ServerInfo, SubCommand::Unsubscribe, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::No} }, - { {"serverinfo", "getSubscriptions"}, { Command::ServerInfo, SubCommand::GetSubscriptions, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::No} }, - { {"serverinfo", "getSubscriptionCommands"}, { Command::ServerInfo, SubCommand::GetSubscriptionCommands, Authorization::No, InstanceCmd::No, NoListenerCmd::No} }, - { {"service", "discover"}, { Command::Service, SubCommand::Discover, Authorization::Yes, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"sourceselect", ""}, { Command::SourceSelect, SubCommand::Empty, Authorization::Yes, InstanceCmd::Multi, NoListenerCmd::Yes} }, - { {"sysinfo", ""}, { Command::SysInfo, SubCommand::Empty, Authorization::Yes, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"system", "restart"}, { Command::System, SubCommand::Restart, Authorization::Yes, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"system", "resume"}, { Command::System, SubCommand::Resume, Authorization::Yes, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"system", "suspend"}, { Command::System, SubCommand::Suspend, Authorization::Yes, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"system", "toggleSuspend"}, { Command::System, SubCommand::ToggleSuspend, Authorization::Yes, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"system", "idle"}, { Command::System, SubCommand::Idle, Authorization::Yes, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"system", "toggleIdle"}, { Command::System, SubCommand::ToggleIdle, Authorization::Yes, InstanceCmd::No, NoListenerCmd::Yes} }, - { {"temperature", ""}, { Command::Temperature, SubCommand::Empty, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"transform", ""}, { Command::Transform, SubCommand::Empty, Authorization::Yes, InstanceCmd::Yes, NoListenerCmd::Yes} }, - { {"videomode", ""}, { Command::VideoMode, SubCommand::Empty, Authorization::Yes, InstanceCmd::No, NoListenerCmd::Yes} } + // Lookup | Command | SubCommand | Authorization | InstanceCmd Type | Instance MustRun | NoListenerCmd + { {"adjustment", ""}, { Command::Adjustment, SubCommand::Empty, Authorization::Yes, InstanceCmd::Multi, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"authorize", "adminRequired"}, { Command::Authorize, SubCommand::AdminRequired, Authorization::No, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"authorize", "answerRequest"}, { Command::Authorize, SubCommand::AnswerRequest, Authorization::Admin, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::No } }, + { {"authorize", "createToken"}, { Command::Authorize, SubCommand::CreateToken, Authorization::Admin, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::No } }, + { {"authorize", "deleteToken"}, { Command::Authorize, SubCommand::DeleteToken, Authorization::Admin, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"authorize", "getPendingTokenRequests"}, { Command::Authorize, SubCommand::GetPendingTokenRequests, Authorization::Admin, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::No } }, + { {"authorize", "getTokenList"}, { Command::Authorize, SubCommand::GetTokenList, Authorization::Admin, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"authorize", "login"}, { Command::Authorize, SubCommand::Login, Authorization::No, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::No } }, + { {"authorize", "logout"}, { Command::Authorize, SubCommand::Logout, Authorization::No, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::No } }, + { {"authorize", "newPassword"}, { Command::Authorize, SubCommand::NewPassword, Authorization::Admin, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"authorize", "newPasswordRequired"}, { Command::Authorize, SubCommand::NewPasswordRequired, Authorization::No, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"authorize", "renameToken"}, { Command::Authorize, SubCommand::RenameToken, Authorization::Admin, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"authorize", "requestToken"}, { Command::Authorize, SubCommand::RequestToken, Authorization::No, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"authorize", "tokenRequired"}, { Command::Authorize, SubCommand::TokenRequired, Authorization::No, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"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 } }, + { {"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 } }, + { {"config", "restoreconfig"}, { Command::Config, SubCommand::RestoreConfig, Authorization::Admin, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"config", "setconfig"}, { Command::Config, SubCommand::SetConfig, Authorization::Admin, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"correction", ""}, { Command::Correction, SubCommand::Empty, Authorization::Yes, InstanceCmd::Single, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"create-effect", ""}, { Command::CreateEffect, SubCommand::Empty, Authorization::Yes, InstanceCmd::Single, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"delete-effect", ""}, { Command::DeleteEffect, SubCommand::Empty, Authorization::Yes, InstanceCmd::Single, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"effect", ""}, { Command::Effect, SubCommand::Empty, Authorization::Yes, InstanceCmd::Multi, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"image", ""}, { Command::Image, SubCommand::Empty, Authorization::Yes, InstanceCmd::Multi, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"inputsource", "discover"}, { Command::InputSource, SubCommand::Discover, Authorization::Yes, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"inputsource", "getProperties"}, { Command::InputSource, SubCommand::GetProperties, Authorization::Yes, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"instance", "createInstance"}, { Command::Instance, SubCommand::CreateInstance, Authorization::Admin, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"instance", "deleteInstance"}, { Command::Instance, SubCommand::DeleteInstance, Authorization::Admin, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"instance", "saveName"}, { Command::Instance, SubCommand::SaveName, Authorization::Admin, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"instance", "startInstance"}, { Command::Instance, SubCommand::StartInstance, Authorization::Yes, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"instance", "stopInstance"}, { Command::Instance, SubCommand::StopInstance, Authorization::Yes, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"instance", "switchTo"}, { Command::Instance, SubCommand::SwitchTo, Authorization::Yes, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"instance-data", "getImageSnapshot"}, { Command::InstanceData, SubCommand::GetImageSnapshot, Authorization::Yes, InstanceCmd::Single, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"instance-data", "getLedSnapshot"}, { Command::InstanceData, SubCommand::GetLedSnapshot, Authorization::Yes, InstanceCmd::Single, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"ledcolors", "imagestream-start"}, { Command::LedColors, SubCommand::ImageStreamStart, Authorization::Yes, InstanceCmd::Single, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"ledcolors", "imagestream-stop"}, { Command::LedColors, SubCommand::ImageStreamStop, Authorization::Yes, InstanceCmd::Single, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"ledcolors", "ledstream-start"}, { Command::LedColors, SubCommand::LedStreamStart, Authorization::Yes, InstanceCmd::Single, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"ledcolors", "ledstream-stop"}, { Command::LedColors, SubCommand::LedStreamStop, Authorization::Yes, InstanceCmd::Single, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"leddevice", "addAuthorization"}, { Command::LedDevice, SubCommand::AddAuthorization, Authorization::Yes, InstanceCmd::Single, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"leddevice", "discover"}, { Command::LedDevice, SubCommand::Discover, Authorization::Yes, InstanceCmd::Single, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"leddevice", "getProperties"}, { Command::LedDevice, SubCommand::GetProperties, Authorization::Yes, InstanceCmd::Single, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"leddevice", "identify"}, { Command::LedDevice, SubCommand::Identify, Authorization::Yes, InstanceCmd::Single, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"logging", "start"}, { Command::Logging, SubCommand::Start, Authorization::Yes, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"logging", "stop"}, { Command::Logging, SubCommand::Stop, Authorization::Yes, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"processing", ""}, { Command::Processing, SubCommand::Empty, Authorization::Yes, InstanceCmd::Multi, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"serverinfo", ""}, { Command::ServerInfo, SubCommand::Empty, Authorization::Yes, InstanceCmd::No_or_Single, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"serverinfo", "getInfo"}, { Command::ServerInfo, SubCommand::GetInfo, Authorization::Yes, InstanceCmd::No_or_Single, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"serverinfo", "subscribe"}, { Command::ServerInfo, SubCommand::Subscribe, Authorization::Yes, InstanceCmd::No_or_Single, InstanceCmd::MustRun_Yes, NoListenerCmd::No } }, + { {"serverinfo", "unsubscribe"}, { Command::ServerInfo, SubCommand::Unsubscribe, Authorization::Yes, InstanceCmd::No_or_Single, InstanceCmd::MustRun_Yes, NoListenerCmd::No } }, + { {"serverinfo", "getSubscriptions"}, { Command::ServerInfo, SubCommand::GetSubscriptions, Authorization::Yes, InstanceCmd::No_or_Single, InstanceCmd::MustRun_Yes, NoListenerCmd::No } }, + { {"serverinfo", "getSubscriptionCommands"}, { Command::ServerInfo, SubCommand::GetSubscriptionCommands, Authorization::No, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::No } }, + { {"service", "discover"}, { Command::Service, SubCommand::Discover, Authorization::Yes, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"sourceselect", ""}, { Command::SourceSelect, SubCommand::Empty, Authorization::Yes, InstanceCmd::Multi, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"sysinfo", ""}, { Command::SysInfo, SubCommand::Empty, Authorization::Yes, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"system", "restart"}, { Command::System, SubCommand::Restart, Authorization::Yes, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"system", "resume"}, { Command::System, SubCommand::Resume, Authorization::Yes, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"system", "suspend"}, { Command::System, SubCommand::Suspend, Authorization::Yes, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"system", "idle"}, { Command::System, SubCommand::Idle, Authorization::Yes, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"system", "toggleIdle"}, { Command::System, SubCommand::ToggleIdle, Authorization::Yes, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } }, + { {"temperature", ""}, { Command::Temperature, SubCommand::Empty, Authorization::Yes, InstanceCmd::Single, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"transform", ""}, { Command::Transform, SubCommand::Empty, Authorization::Yes, InstanceCmd::Single, InstanceCmd::MustRun_Yes, NoListenerCmd::Yes } }, + { {"videomode", ""}, { Command::VideoMode, SubCommand::Empty, Authorization::Yes, InstanceCmd::No, InstanceCmd::MustRun_No, NoListenerCmd::Yes } } }; return commandLookup; } diff --git a/include/api/JsonCallbacks.h b/include/api/JsonCallbacks.h index 14b30479f..808b90967 100644 --- a/include/api/JsonCallbacks.h +++ b/include/api/JsonCallbacks.h @@ -8,6 +8,7 @@ #include #include #include +#include #include #include @@ -86,7 +87,7 @@ class JsonCallbacks : public QObject /// /// @brief Re-apply all current subs to a new Hyperion instance, the connections to the old instance will be dropped /// - void setSubscriptionsTo(Hyperion* hyperion); + void setSubscriptionsTo(quint8 instanceID); signals: /// @@ -186,7 +187,8 @@ private slots: void doCallback(Subscription::Type cmd, const QJsonObject& data); Logger *_log; - Hyperion* _hyperion; + quint8 _instanceID; + QSharedPointer _hyperion; /// The peer address of the client QString _peerAddress; @@ -195,7 +197,7 @@ private slots: ComponentRegister* _componentRegister; /// priority muxer instance - PriorityMuxer* _prioMuxer; + QSharedPointer _prioMuxer; /// contains active subscriptions QSet _subscribedCommands; diff --git a/include/api/JsonInfo.h b/include/api/JsonInfo.h index f3a9922c5..58f0eab9a 100644 --- a/include/api/JsonInfo.h +++ b/include/api/JsonInfo.h @@ -12,10 +12,12 @@ class JsonInfo { public: + static QJsonObject getInfo(const Hyperion* hyperion, Logger* log); static QJsonArray getAdjustmentInfo(const Hyperion* hyperion, Logger* log); static QJsonArray getPrioritiestInfo(const Hyperion* hyperion); static QJsonArray getPrioritiestInfo(int currentPriority, const PriorityMuxer::InputsMap& activeInputs); - static QJsonArray getEffects(const Hyperion* hyperion); + static QJsonArray getEffects(); + static QJsonArray getEffectSchemas(); static QJsonArray getAvailableScreenGrabbers(); static QJsonArray getAvailableVideoGrabbers(); static QJsonArray getAvailableAudioGrabbers(); @@ -28,10 +30,10 @@ class JsonInfo static QJsonArray getActiveEffects(const Hyperion* hyperion); static QJsonArray getActiveColors(const Hyperion* hyperion); static QJsonArray getTransformationInfo(const Hyperion* hyperion); - static QJsonObject getSystemInfo(const Hyperion* hyperion); + static QJsonObject getSystemInfo(); QJsonObject discoverSources (const QString& sourceType, const QJsonObject& params); - static QJsonObject getConfiguration(const QList& instances = {}, const QStringList& instanceFilteredTypes = {}, const QStringList& globalFilterTypes = {} ); + static QJsonObject getConfiguration(const QList& instanceIds = {}, const QStringList& instanceFilteredTypes = {}, const QStringList& globalFilterTypes = {} ); private: diff --git a/include/commandline/ColorsOption.h b/include/commandline/ColorsOption.h index 299d44bf5..edd8a1b70 100644 --- a/include/commandline/ColorsOption.h +++ b/include/commandline/ColorsOption.h @@ -35,7 +35,7 @@ class ColorsOption: public Option {} virtual bool validate(Parser & parser, QString & value) override; - QList getColors(Parser &parser) const { return _colors; } + QList getColors(Parser & /*parser*/) const { return _colors; } }; } diff --git a/include/db/DBConfigManager.h b/include/db/DBConfigManager.h index 652e26ad6..afc703595 100644 --- a/include/db/DBConfigManager.h +++ b/include/db/DBConfigManager.h @@ -1,5 +1,5 @@ #ifndef DBCONFGMANAGER_H -#define DBConfigManager_H +#define DBCONFGMANAGER_H #include #include "db/SettingsTable.h" @@ -13,7 +13,7 @@ class DBConfigManager : public DBManager QPair importJson(const QString& configFile); bool exportJson(const QString& path = "") const; - QJsonObject getConfiguration(const QList& instances = {}, const QStringList& instanceFilteredTypes = {}, const QStringList& globalFilterTypes = {} ) const; + QJsonObject getConfiguration(const QList& instanceIdsFilter = {}, const QStringList& instanceFilteredTypes = {}, const QStringList& globalFilterTypes = {} ) const; QPair validateConfiguration(); QPair validateConfiguration(QJsonObject& config, bool doCorrections = false); diff --git a/include/db/DBManager.h b/include/db/DBManager.h index a5d858029..bbc5be9b4 100644 --- a/include/db/DBManager.h +++ b/include/db/DBManager.h @@ -72,10 +72,12 @@ class DBManager : public QObject /// /// @brief Check if at least one record exists in table with the conditions - /// @param[in] conditions The search conditions (WHERE) + /// @param[in] conditions condition to search for (WHERE) + /// @param[in] tColumns target columns to search in (optional) /// @return True on success else false /// - bool recordExists(const VectorPair& conditions) const; + bool recordExists(const VectorPair& conditions, const QStringList& tColumns = {}) const ; + bool recordExists(const QString& condition, const QVariantList& bindValues, const QStringList& tColumns = {}) const; bool recordsNotExisting(const QVariantList& testValues,const QString& column, QStringList& nonExistingRecs, const QString& condition ) const; @@ -94,7 +96,8 @@ class DBManager : public QObject /// @param[in] columns columns to update /// @return True on success else false /// - bool updateRecord(const VectorPair& conditions, const QVariantMap& columns) const; + bool updateRecord(const VectorPair& conditions, const QVariantMap& tColumns) const; + bool updateRecord(const QString& condition, const QVariantList& condBindValues, const QVariantMap& columns) const; /// /// @brief Get data of a single record, multiple records are not supported diff --git a/include/db/DBMigrationManager.h b/include/db/DBMigrationManager.h index be315cd16..f5b342070 100644 --- a/include/db/DBMigrationManager.h +++ b/include/db/DBMigrationManager.h @@ -28,6 +28,7 @@ class DBMigrationManager : public DBManager bool upgradeInstanceSettings_2_0_12(semver::version& currentVersion, quint8 instance, QJsonObject& config); bool upgradeInstanceSettings_2_0_13(semver::version& currentVersion, quint8 instance, QJsonObject& config); bool upgradeInstanceSettings_2_0_16(semver::version& currentVersion, quint8 instance, QJsonObject& config); + bool upgradeInstanceSettings_2_1_0(semver::version& currentVersion, quint8 instance, QJsonObject& config); }; #endif // DBMIGRATIONMANAGER_H diff --git a/include/db/InstanceTable.h b/include/db/InstanceTable.h index 7fbb580ee..05b7d5623 100644 --- a/include/db/InstanceTable.h +++ b/include/db/InstanceTable.h @@ -3,6 +3,8 @@ #include +#include + /// /// @brief Hyperion instance manager specific database interface. prepares also the Hyperion database for all follow up usage (Init QtSqlConnection) along with db name /// @@ -21,9 +23,9 @@ class InstanceTable : public DBManager bool createInstance(const QString& name, quint8& inst); /// - /// @brief Create first Hyperion instance entry, if index 0 is not found. + /// @brief Create first Hyperion instance entry /// - void createDefaultInstance(); + void createInitialInstance(); /// /// @brief Delete a Hyperion instance @@ -52,14 +54,14 @@ class InstanceTable : public DBManager /// @param onlyEnabled return only enabled instance IDs if true /// @return The found instances /// - QList getAllInstanceIDs (bool onlyEnabled = false); + QSet getAllInstanceIDs (bool onlyEnabled = false); /// /// @brief Test if instance record exists /// @param[in] user The user id /// @return true on success else false /// - bool instanceExist(quint8 inst); + bool doesInstanceExist(quint8 inst); /// /// @brief Get instance name by instance index diff --git a/include/db/SettingsTable.h b/include/db/SettingsTable.h index 66c6634da..d6b7911bb 100644 --- a/include/db/SettingsTable.h +++ b/include/db/SettingsTable.h @@ -41,12 +41,19 @@ class SettingsTable : public DBManager /// bool recordExist(const QString& type) const; + /// + /// @brief Get 'config' column of settings entry as QVariant + /// @param[in] type The settings type + /// @return The QVariant + /// + QVariant getSettingsRecord(const QString& type) const; + /// /// @brief Get 'config' column of settings entry as QJsonDocument /// @param[in] type The settings type /// @return The QJsonDocument /// - QJsonDocument getSettingsRecord(const QString& type) const; + QJsonDocument getSettingsRecordJson(const QString& type) const; /// /// @brief Get 'config' column of settings entry as QString diff --git a/include/effectengine/Effect.h b/include/effectengine/Effect.h index e4dc826b7..ad4419305 100644 --- a/include/effectengine/Effect.h +++ b/include/effectengine/Effect.h @@ -69,6 +69,13 @@ class Effect : public QThread QJsonObject getArgs() const { return _args; } +public slots: + + /// + /// @brief Stop the effect (triggers its interruption) + /// + void stop(); + signals: void setInput(int priority, const std::vector& ledColors, int timeout_ms, bool clearEffect); void setInputImage(int priority, const Image& image, int timeout_ms, bool clearEffect); diff --git a/include/effectengine/EffectEngine.h b/include/effectengine/EffectEngine.h index 5756345bb..41dd87a75 100644 --- a/include/effectengine/EffectEngine.h +++ b/include/effectengine/EffectEngine.h @@ -7,6 +7,7 @@ #include #include #include +#include // Hyperion includes #include @@ -15,7 +16,6 @@ #include #include #include -#include #include #include @@ -36,26 +36,6 @@ class EffectEngine : public QObject std::list getActiveEffects() const; - /// - /// Get available schemas from EffectFileHandler - /// @return all schemas - /// - std::list getEffectSchemas() const; - - /// - /// @brief Save an effect with EffectFileHandler - /// @param obj The effect args - /// @return If not empty, it contains the error - /// - QString saveEffect(const QJsonObject& obj); - - /// - /// @brief Delete an effect by name. - /// @param effectName The effect name to delete - /// @return If not empty, it contains the error - /// - QString deleteEffect(const QString& effectName); - /// /// @brief Get all init data of the running effects and stop them /// @@ -66,10 +46,18 @@ class EffectEngine : public QObject /// void startCachedEffects(); + /// + /// @brief Stop all effects + /// + void stopAllEffects(); + signals: - /// Emit when the effect list has been updated + /// Emits when the effect list has been updated void effectListUpdated(); + /// Emits when all effevts were stopped + void isStopCompleted(); + public slots: /// Run the specified effect on the given priority channel and optionally specify a timeout int runEffect(const QString &effectName, int priority, int timeout = PriorityMuxer::ENDLESS, const QString &origin="System"); @@ -93,6 +81,7 @@ public slots: private slots: void effectFinished(); + void onEffectFinished(); /// /// @brief is called whenever the EffectFileHandler emits updated effect list @@ -111,6 +100,8 @@ private slots: , const QString &imageData = "" ); + void waitForEffectsToStop(); + private: Hyperion * _hyperion; @@ -124,4 +115,7 @@ private slots: // The global effect file handler EffectFileHandler* _effectFileHandler; + + QEventLoop _eventLoop; + int _remainingEffects; }; diff --git a/include/effectengine/EffectFileHandler.h b/include/effectengine/EffectFileHandler.h index 103a35049..4e7e452e1 100644 --- a/include/effectengine/EffectFileHandler.h +++ b/include/effectengine/EffectFileHandler.h @@ -17,6 +17,10 @@ class EffectFileHandler : public QObject static EffectFileHandler* efhInstance; static EffectFileHandler* getInstance() { return efhInstance; } + QJsonObject getEffectConfig() const { return _effectConfig; }; + + QString getRootPath() const { return _rootPath; } + /// /// @brief Get all available effects /// diff --git a/include/effectengine/EffectModule.h b/include/effectengine/EffectModule.h index bccf562d3..d7c68de8d 100644 --- a/include/effectengine/EffectModule.h +++ b/include/effectengine/EffectModule.h @@ -1,8 +1,8 @@ #pragma once #undef slots -// Don't use debug Python APIs on Windows -#if defined(_MSC_VER) && defined(_DEBUG) +// Don't use debug Python APIs on Windows (GitHub Actions only) +#if defined(GITHUB_ACTIONS) && defined(_MSC_VER) && defined(_DEBUG) #if _MSC_VER >= 1930 #include #endif diff --git a/include/flatbufserver/FlatBufferConnection.h b/include/flatbufserver/FlatBufferConnection.h index 080eccad4..53dcabb45 100644 --- a/include/flatbufserver/FlatBufferConnection.h +++ b/include/flatbufserver/FlatBufferConnection.h @@ -1,4 +1,5 @@ -#pragma once +#ifndef FLATBUFFERCONNECTION_H +#define FLATBUFFERCONNECTION_H // Qt includes #include @@ -39,7 +40,7 @@ class FlatBufferConnection : public QObject /// @param port The port of the Hyperion Flatpuffer server (default is 19400) /// @param skipReply If true skip reply /// - FlatBufferConnection(const QString& origin, const QString& host, int priority, bool skipReply, quint16 port = FLATBUFFER_DEFAULT_PORT); + FlatBufferConnection(const QString& origin, const QHostAddress& host, int priority, bool skipReply, quint16 port = FLATBUFFER_DEFAULT_PORT); /// /// @brief Destructor @@ -49,37 +50,30 @@ class FlatBufferConnection : public QObject /// @brief Do not read reply messages from Hyperion if set to true void setSkipReply(bool skip); - /// - /// @brief Register a new priority with given origin - /// @param origin The user friendly origin string - /// @param priority The priority to register - /// - void setRegister(const QString& origin, int priority); - /// /// @brief Set all leds to the specified color /// @param color The color /// @param priority The priority /// @param duration The duration in milliseconds /// - void setColor(const ColorRgb & color, int priority, int duration = 1); + void setColor(const ColorRgb & color, int duration = 1); /// /// @brief Clear the given priority channel /// @param priority The priority /// - void clear(int priority); + void clearPriority(int priority); /// /// @brief Clear all priority channels /// - void clearAll(); + void clearAllPriorities(); /// - /// @brief Send a command message and receive its reply - /// @param message The message to send + /// @brief Check, if client is already registered + /// @return True, if reistered /// - void sendMessage(const uint8_t* buffer, uint32_t size); + bool isClientRegistered(); public slots: /// @@ -87,18 +81,29 @@ public slots: /// @param image The image /// void setImage(const Image &image); + void setImage(const QByteArray& imageData, int width, int height, int duration = -1); + +signals: + + void isReadyToSend(); + void isDisconnected(); + void errorOccured(const QString& error); private slots: /// /// @brief Try to connect to the Hyperion host /// - void connectToHost(); + void connectToRemoteHost(); /// /// @brief Slot called when new data has arrived /// void readData(); + void onConnected(); + void onDisconnected(); + + signals: /// @@ -108,6 +113,15 @@ private slots: private: + /// + /// @brief Register a new priority with given origin + /// @param origin The user friendly origin string + /// @param priority The priority to register + /// + void registerClient(const QString& origin, int priority); + + void sendMessage(const uint8_t* data, size_t size); + /// /// @brief Parse a reply message /// @param reply The received reply @@ -123,7 +137,7 @@ private slots: int _priority; /// Host address - QString _host; + QHostAddress _host; /// Host port uint16_t _port; @@ -132,10 +146,10 @@ private slots: QByteArray _receiveBuffer; QTimer _timer; - QAbstractSocket::SocketState _prevSocketState; - Logger * _log; - flatbuffers::FlatBufferBuilder _builder; - bool _registered; + flatbuffers::FlatBufferBuilder _builder; + bool _isRegistered; }; + +#endif // FLATBUFFERCONNECTION_H diff --git a/include/flatbufserver/FlatBufferServer.h b/include/flatbufserver/FlatBufferServer.h index 6120b8453..6fa1ef096 100644 --- a/include/flatbufserver/FlatBufferServer.h +++ b/include/flatbufserver/FlatBufferServer.h @@ -6,6 +6,7 @@ // qt #include +#include class QTcpServer; class FlatBufferClient; @@ -34,6 +35,11 @@ public slots: void initServer(); + /// + /// @brief Stop server + /// + void stop(); + signals: /// /// @emits whenever the server would like to announce its service details @@ -55,16 +61,10 @@ private slots: /// /// @brief Start the server with current _port /// - void startServer(); - - /// - /// @brief Stop server - /// - void stopServer(); - + void start(); private: - QTcpServer* _server; + QScopedPointer _server; NetOrigin* _netOrigin; Logger* _log; int _timeout; diff --git a/include/forwarder/MessageForwarder.h b/include/forwarder/MessageForwarder.h index d17add09c..cf97e5627 100644 --- a/include/forwarder/MessageForwarder.h +++ b/include/forwarder/MessageForwarder.h @@ -13,6 +13,7 @@ #include #include #include +#include // Utils includes #include @@ -22,6 +23,8 @@ #include // Hyperion includes +#include +#include #include // Forward declaration @@ -33,6 +36,7 @@ class MessageForwarderFlatbufferClientsHelper; struct TargetHost { QHostAddress host; quint16 port; + QJsonArray instanceIds; bool operator == (TargetHost const& a) const { @@ -44,7 +48,7 @@ class MessageForwarder : public QObject { Q_OBJECT public: - MessageForwarder(Hyperion* hyperion); + MessageForwarder(const QJsonDocument& config); ~MessageForwarder() override; void addJsonTarget(const QJsonObject& targetConfig); @@ -58,6 +62,12 @@ public slots: /// void handleSettingsUpdate(settings::type type, const QJsonDocument &config); + void init(); + bool connect(quint8 instanceID); + void disconnect(quint8 instanceID); + void start(); + void stop(); + private slots: /// /// @brief Handle component state change MessageForwarder @@ -76,7 +86,7 @@ private slots: /// @brief Forward message to all json target hosts /// @param message The JSON message to send /// - void forwardJsonMessage(const QJsonObject &message); + void forwardJsonMessage(const QJsonObject &message, quint8 instanceId); #if defined(ENABLE_FLATBUF_SERVER) || defined(ENABLE_PROTOBUF_SERVER) /// @@ -91,12 +101,17 @@ private slots: /// @brief Forward message to a single json target host /// @param message The JSON message to send /// @param socket The TCP-Socket with the connection to the target host + /// @param targetInstanceIds The instances the command shoulkd be applied to /// - void sendJsonMessage(const QJsonObject &message, QTcpSocket *socket); + void sendJsonMessage(const QJsonObject &message, QTcpSocket *socket, const QJsonArray& targetInstanceIds = {}); private: - void enableTargets(bool enable, const QJsonObject& config); + void handleTargets(bool enable, const QJsonObject& config = {}); + bool activateFlatbufferTargets(int priority = PriorityMuxer::LOWEST_PRIORITY); + + bool isFlatbufferComponent(int priority); + void disconnectFlatBufferComponents(int priority = PriorityMuxer::LOWEST_PRIORITY); int startJsonTargets(const QJsonObject& config); void stopJsonTargets(); @@ -104,14 +119,22 @@ private slots: int startFlatbufferTargets(const QJsonObject& config); void stopFlatbufferTargets(); - /// Hyperion instance - Hyperion *_hyperion; - /// Logger instance Logger *_log; + QJsonDocument _config; + bool _isActive = true; + const int _priority; + bool _isEnabled; + quint8 _toBeForwardedInstanceID; + + SettingsTable _settings; + + /// Hyperion instance forwarded + QSharedPointer _hyperion; + /// Muxer instance - PriorityMuxer *_muxer; + QSharedPointer _muxer; // JSON connections for forwarding QList _jsonTargets; @@ -119,12 +142,9 @@ private slots: /// Flatbuffer connection for forwarding QList _flatbufferTargets; - /// Flag if forwarder is enabled - bool _forwarder_enabled = true; + QSharedPointer _messageForwarderFlatBufHelper; - const int _priority; - - MessageForwarderFlatbufferClientsHelper* _messageForwarderFlatBufHelper; + QSharedPointer _mdnsBrowser = MdnsBrowser::getInstance(); }; class MessageForwarderFlatbufferClientsHelper : public QObject @@ -149,6 +169,7 @@ public slots: private: - QList _forwardClients; - bool _free; + QList> _forwardClients; + + bool _isFree; }; diff --git a/include/hyperion/BGEffectHandler.h b/include/hyperion/BGEffectHandler.h index f3ee80879..560c50d45 100644 --- a/include/hyperion/BGEffectHandler.h +++ b/include/hyperion/BGEffectHandler.h @@ -4,8 +4,9 @@ #include #include #include -#include -#include + +#include +#include /// /// @brief Handle the background Effect settings, reacts on runtime to settings changes @@ -15,49 +16,20 @@ class BGEffectHandler : public QObject Q_OBJECT public: - BGEffectHandler(Hyperion* hyperion) - : QObject(hyperion) - , _hyperion(hyperion) - , _prioMuxer(_hyperion->getMuxerInstance()) - , _isBgEffectEnabled(false) - , _isSuspended(false) - { - QString subComponent = parent()->property("instance").toString(); - _log = Logger::getInstance("HYPERION", subComponent); - - // listen for config changes - connect(_hyperion, &Hyperion::settingsChanged, this, [=] (settings::type type, const QJsonDocument& config) { - this->handleSettingsUpdate(type, config); - }); - - connect(_prioMuxer, &PriorityMuxer::prioritiesChanged, this, [=] { - this->handlePriorityUpdate(); - }); - - // listen for suspend/resume requests, to not start a background effect when system goes into suspend mode - connect(_hyperion, &Hyperion::suspendRequest, this, [=] (bool isSuspended) { - _isSuspended = isSuspended; - }); - - // initialization - handleSettingsUpdate(settings::BGEFFECT, _hyperion->getSetting(settings::BGEFFECT)); - } + BGEffectHandler(Hyperion* hyperion = nullptr); /// /// @brief Disconnect from connected signals - /// Disconnect should be done before other priorities invoke methods during shutdown + /// Disconnect should be done before other priorities invoke methods + /// during shutdown /// - void disconnect() - { - QObject::disconnect(_prioMuxer, &PriorityMuxer::prioritiesChanged, nullptr, nullptr); - QObject::disconnect(_hyperion, nullptr, nullptr, nullptr); - } + void disconnect(); /// /// @brief Check, if background effect processing is enabled. /// @return True, background effect processing is enabled. /// - bool _isEnabled () const { return _isBgEffectEnabled; } + bool _isEnabled () const; private slots: /// @@ -65,81 +37,19 @@ private slots: /// @param type settingType from enum /// @param config configuration object /// - void handleSettingsUpdate(settings::type type, const QJsonDocument& config) - { - if(type == settings::BGEFFECT) - { - _bgEffectConfig = config; - - const QJsonObject& BGEffectConfig = _bgEffectConfig.object(); - #define BGCONFIG_ARRAY bgColorConfig.toArray() - // clear background priority - if (_hyperion->getCurrentPriority() == PriorityMuxer::BG_PRIORITY) - { - _hyperion->clear(PriorityMuxer::BG_PRIORITY); - } - _isBgEffectEnabled = BGEffectConfig["enable"].toBool(true); - - // initial background effect/color - if (_isBgEffectEnabled) - { - #if defined(ENABLE_EFFECTENGINE) - const QString bgTypeConfig = BGEffectConfig["type"].toString("effect"); - const QString bgEffectConfig = BGEffectConfig["effect"].toString("Warm mood blobs"); - #else - const QString bgTypeConfig = "color"; - #endif - const QJsonValue bgColorConfig = BGEffectConfig["color"]; - if (bgTypeConfig.contains("color")) - { - std::vector bg_color = { - ColorRgb { - static_cast(BGCONFIG_ARRAY.at(0).toInt(0)), - static_cast(BGCONFIG_ARRAY.at(1).toInt(0)), - static_cast(BGCONFIG_ARRAY.at(2).toInt(0)) - } - }; - _hyperion->setColor(PriorityMuxer::BG_PRIORITY, bg_color); - Info(_log,"Initial background color set (%d %d %d)",bg_color.at(0).red, bg_color.at(0).green, bg_color.at(0).blue); - } - #if defined(ENABLE_EFFECTENGINE) - else - { - int result = _hyperion->setEffect(bgEffectConfig, PriorityMuxer::BG_PRIORITY, PriorityMuxer::ENDLESS); - Info(_log,"Initial background effect '%s' %s", QSTRING_CSTR(bgEffectConfig), ((result == 0) ? "started" : "failed")); - } - #endif - } - #undef BGCONFIG_ARRAY - } - } + void handleSettingsUpdate(settings::type type, const QJsonDocument& config); /// /// @brief Handle priority updates. /// In case the background effect is not current priority, stop BG-effect to save resources; otherwise start effect again. /// - void handlePriorityUpdate() - { - if (_prioMuxer->getCurrentPriority() < PriorityMuxer::BG_PRIORITY && _prioMuxer->hasPriority(PriorityMuxer::BG_PRIORITY)) - { - Debug(_log,"Stop background (color-) effect as it moved out of scope"); - _hyperion->clear(PriorityMuxer::BG_PRIORITY); - } - else if (!_isSuspended && _prioMuxer->getCurrentPriority() == PriorityMuxer::LOWEST_PRIORITY && _isBgEffectEnabled) - { - Debug(_log,"Start background (color-) effect as it moved in scope"); - emit handleSettingsUpdate (settings::BGEFFECT, _bgEffectConfig); - } - } + void handlePriorityUpdate(int currentPriority); private: /// Hyperion instance pointer Hyperion* _hyperion; Logger * _log; - /// priority muxer instance - PriorityMuxer* _prioMuxer; - QJsonDocument _bgEffectConfig; bool _isBgEffectEnabled; diff --git a/include/hyperion/Hyperion.h b/include/hyperion/Hyperion.h index 6ae9a2426..2c037ae34 100644 --- a/include/hyperion/Hyperion.h +++ b/include/hyperion/Hyperion.h @@ -12,6 +12,8 @@ #include #include #include +#include +#include #include // hyperion-utils includes @@ -27,11 +29,7 @@ #include #if defined(ENABLE_EFFECTENGINE) -// Effect engine includes -#include -#include #include -#include #endif #include @@ -41,10 +39,8 @@ // Forward class declaration class HyperionDaemon; +class HyperionIManager; class ImageProcessor; -#if defined(ENABLE_FORWARDER) -class MessageForwarder; -#endif class LinearColorSmoothing; #if defined(ENABLE_EFFECTENGINE) class EffectEngine; @@ -77,12 +73,7 @@ class Hyperion : public QObject /// ~Hyperion() override; - /// - /// free all alocated objects, should be called only from constructor or before restarting hyperion - /// - void freeObjects(); - - ImageProcessor* getImageProcessor() const { return _imageProcessor; } + ImageProcessor* getImageProcessor() const { return _imageProcessor.get(); } /// /// @brief Get instance index of this instance @@ -93,7 +84,7 @@ class Hyperion : public QObject /// /// @brief Return the size of led grid /// - QSize getLedGridSize() const { return _ledGridSize; } + QSize getLedGridSize() const { return _layoutGridSize; } /// gets the methode how image is maped to leds int getLedMappingType() const; @@ -118,6 +109,12 @@ public slots: /// void update(); + /// + /// Forces one update to the priority muxer with the current time and (re)writes the led color with applied + /// transforms. + /// + void refreshUpdate(); + /// /// Returns the number of attached leds /// @@ -186,7 +183,7 @@ public slots: /// Returns the ColorAdjustment with the given identifier /// @return The adjustment with the given identifier (or nullptr if the identifier does not exist) /// - ColorAdjustment * getAdjustment(const QString& id) const; + ColorAdjustment * getAdjustment(const QString& identifier) const; /// Tell Hyperion that the corrections have changed and the leds need to be updated void adjustmentsUpdated(); @@ -208,21 +205,7 @@ public slots: /// @brief Get a pointer to the effect engine /// @return EffectEngine instance pointer /// - EffectEngine* getEffectEngineInstance() const { return _effectEngine; } - - /// - /// @brief Save an effect - /// @param obj The effect args - /// @return Empty on success else error message - /// - QString saveEffect(const QJsonObject& obj); - - /// - /// @brief Delete an effect by name. - /// @param effectName The effect name to delete - /// @return Empty on success else error message - /// - QString deleteEffect(const QString& effectName); + EffectEngine* getEffectEngineInstance() const { return _effectEngine.get(); } /// Run the specified effect on the given priority channel and optionally specify a timeout /// @param effectName Name of the effec to run @@ -244,17 +227,10 @@ public slots: , const QString &imageData = "" ); - /// Get the list of available effects - /// @return The list of available effects - std::list getEffects() const; /// Get the list of active effects /// @return The list of active effects std::list getActiveEffects() const; - - /// Get the list of available effect schema files - /// @return The list of available effect schema files - std::list getEffectSchemas() const; #endif /// ############# @@ -263,7 +239,7 @@ public slots: /// @brief Get a pointer to the priorityMuxer instance /// @return PriorityMuxer instance pointer /// - PriorityMuxer* getMuxerInstance() { return _muxer; } + QSharedPointer getMuxerInstance() { return _muxer; } /// /// @brief enable/disable automatic/priorized source selection @@ -330,7 +306,7 @@ public slots: /// gets the current json config object from SettingsManager /// @return json config - QJsonObject getQJsonConfig() const; + QJsonObject getQJsonConfig(quint8 inst) const; /// /// @brief Save a complete json config @@ -345,7 +321,7 @@ public slots: /// @brief Get the component Register /// return Component register pointer /// - ComponentRegister* getComponentRegister() const { return _componentRegister; } + ComponentRegister* getComponentRegister() const { return _componentRegister.get(); } /// /// @brief Called from components to update their current state. DO NOT CALL FROM USERS @@ -383,8 +359,9 @@ public slots: /// /// @brief Stop the execution of this thread, helper to properly track eventing + /// @param name The instance's name for information /// - void stop(); + void stop(const QString name = ""); int getLatchTime() const; @@ -444,9 +421,6 @@ public slots: /// void currentImage(const Image & image); - /// Signal which is emitted, when a new json message should be forwarded - void forwardJsonMessage(QJsonObject); - /// Signal which is emitted, when a new system proto image should be forwarded void forwardSystemProtoMessage(const QString&, const Image&); @@ -503,13 +477,15 @@ public slots: /// /// @brief Emits before thread quit is requested /// - void finished(); + void finished(const QString& name); /// /// @brief Emits after thread has been started /// void started(); + void stopEffects(); + private slots: /// /// @brief Handle whenever the visible component changed @@ -537,51 +513,50 @@ private slots: private: friend class HyperionDaemon; - friend class HyperionIManager; /// /// @brief Constructs the Hyperion instance, just accessible for HyperionIManager /// @param instance The instance index /// - Hyperion(quint8 instance); + explicit Hyperion(quint8 instance, QObject* parent = nullptr); + + friend class HyperionIManager; // Grant HyperionIManager access to private members + + void updateLedColorAdjustment(int ledCount, const QJsonObject& colors); + void updateLedLayout(const QJsonArray& ledLayout); /// instance index const quint8 _instIndex; /// Settings manager of this instance - SettingsManager* _settingsManager; + QScopedPointer _settingsManager; /// Register that holds component states - ComponentRegister* _componentRegister; + QSharedPointer _componentRegister; /// The specifiation of the led frame construction and picture integration LedString _ledString; /// Image Processor - ImageProcessor* _imageProcessor; + QSharedPointer _imageProcessor; std::vector _ledStringColorOrder; /// The priority muxer - PriorityMuxer* _muxer; + QSharedPointer _muxer; /// The adjustment from raw colors to led colors - MultiColorAdjustment * _raw2ledAdjustment; + QScopedPointer _raw2ledAdjustment; /// The actual LedDeviceWrapper - LedDeviceWrapper* _ledDeviceWrapper; + QScopedPointer _ledDeviceWrapper; /// The smoothing LedDevice - LinearColorSmoothing * _deviceSmooth; + QScopedPointer _deviceSmooth; #if defined(ENABLE_EFFECTENGINE) /// Effect engine - EffectEngine * _effectEngine; -#endif - -#if defined(ENABLE_FORWARDER) - // Message forwarder - MessageForwarder * _messageForwarder; + QScopedPointer _effectEngine; #endif /// Logger instance @@ -589,13 +564,14 @@ private slots: /// count of hardware leds int _hwLedCount; - - QSize _ledGridSize; + int _layoutLedCount; + QString _colorOrder; + QSize _layoutGridSize; /// Background effect instance, kept active to react on setting changes - BGEffectHandler* _BGEffectHandler; + QScopedPointer _BGEffectHandler; /// Capture control for Daemon native capture - CaptureCont* _captureCont; + QScopedPointer _captureCont; /// buffer for leds (with adjustment) std::vector _ledBuffer; @@ -604,7 +580,7 @@ private slots: #if defined(ENABLE_BOBLIGHT_SERVER) /// Boblight instance - BoblightServer* _boblightServer; + QScopedPointer _boblightServer; #endif QElapsedTimer _imageTimer; // Timer for controlling image emission frequency diff --git a/include/hyperion/HyperionIManager.h b/include/hyperion/HyperionIManager.h index 60a170764..713f2351a 100644 --- a/include/hyperion/HyperionIManager.h +++ b/include/hyperion/HyperionIManager.h @@ -6,14 +6,18 @@ #include #include #include +#include // qt #include +#include +#include class Hyperion; class InstanceTable; enum class InstanceState{ + H_STARTING, H_STARTED, H_ON_STOP, H_STOPPED, @@ -39,52 +43,67 @@ class HyperionIManager : public QObject static HyperionIManager* getInstance() { return HIMinstance; } static HyperionIManager* HIMinstance; + ~HyperionIManager() override; + public slots: /// /// @brief Is given instance running? - /// @param inst The instance to check + /// @param instanceId The instance to check /// @return True when running else false /// - bool IsInstanceRunning(quint8 inst) const { return _runningInstances.contains(inst); } + bool isInstanceRunning(quint8 instanceId) const { return _runningInstances.contains(instanceId); } + + /// + /// @brief Is given instance a configred one? + /// @param instanceId The instance to check + /// @return True when existing else false + /// + bool doesInstanceExist(quint8 instanceId) const { return _instanceTable->doesInstanceExist(instanceId); } /// /// @brief Get a Hyperion instance by index - /// @param intance the index + /// @param instanceId the index /// @return Hyperion instance, if index is not found returns instance 0 /// - Hyperion* getHyperionInstance(quint8 instance = 0); + QSharedPointer getHyperionInstance(quint8 instance = 0); /// /// @brief Get instance data of all instances in db + running state /// QVector getInstanceData() const; - QString getInstanceName(quint8 inst = 0); + QString getInstanceName(quint8 instanceId = 0); /// /// @brief Get all instance indicies of running instances /// - QList getRunningInstanceIdx() const; + QSet getRunningInstanceIdx() const; + + /// + /// @brief Get the first running Hyperion instance + /// @return Hyperion instance, if none is runnning returns a nullptr + /// + QSharedPointer getFirstRunningInstance(); /// /// @brief Get all instance indicies configured /// - QList getInstanceIds() const; + QSet getInstanceIds() const; /// /// @brief Start a Hyperion instance - /// @param instance Instance index + /// @param instanceId Instance index /// @param block If true return when thread has been started /// @return Return true on success, false if not found in db /// - bool startInstance(quint8 inst, bool block = false, QObject *caller = nullptr, int tan = 0); + bool startInstance(quint8 instanceId, bool block = false, QObject *caller = nullptr, int tan = 0); /// /// @brief Stop a Hyperion instance - /// @param instance Instance index + /// @param instanceId Instance index /// @return Return true on success, false if not found in db /// - bool stopInstance(quint8 inst); + bool stopInstance(quint8 instanceId); /// /// @brief Handle an Hyperion Event @@ -108,27 +127,28 @@ public slots: /// /// @brief Delete Hyperion instance entry in db. Cleanup also all associated table data for this instance - /// @param inst The instance index + /// @param instanceId The instance index /// @return Return true on success, false if not found or not allowed /// - bool deleteInstance(quint8 inst); + bool deleteInstance(quint8 instanceId); /// /// @brief Assign a new name to the given instance - /// @param inst The instance index - /// @param name The instance name index + /// @param instanceId The instance index + /// @param name The instance name index /// @return Return true on success, false if not found /// - bool saveName(quint8 inst, const QString& name); + bool saveName(quint8 instanceId, const QString& name); signals: /// /// @brief Emits whenever the state of a instance changes according to enum instanceState /// @param instaneState A state from enum - /// @param instance The index of instance + /// @param instanceId The index of instance /// @param name The name of the instance, just available with H_CREATED /// - void instanceStateChanged(InstanceState state, quint8 instance, const QString& name = QString()); + void instanceStateChanged(InstanceState state, quint8 instanceId, const QString& name = QString()); + void started(InstanceState state, quint8 instanceId, const QString& name = QString()); /// /// @brief Emits whenever something changes, the lazy version of instanceStateChanged (- H_ON_STOP) + saveName() emit @@ -142,6 +162,10 @@ public slots: /// void startInstanceResponse(QObject *caller, const int &tan); + /// + /// @brief Emits when all instances were stopped + /// + void areAllInstancesStopped(); signals: /////////////////////////////////////// @@ -180,8 +204,9 @@ private slots: /// /// @brief handle finished signal of Hyperion instances + /// @param name The instance's name for information /// - void handleFinished(); + void handleFinished(const QString& name = ""); /// /// @brief Toggle the state of all Hyperion instances for a suspend sceanrio (user is not interacting with the system) @@ -212,18 +237,12 @@ private slots: /// void stopAll(); - /// - /// @brief check if a instance is allowed for management. Instance 0 represents the root instance - /// @apram inst The instance to check - /// - bool isInstAllowed(quint8 inst) const { return (inst > 0); } - private: Logger* _log; - InstanceTable* _instanceTable; - QMap _runningInstances; + QScopedPointer _instanceTable; + QMap> _runningInstances; + QMap> _startingInstances; - QList _startQueue; /// All pending requests QMap _pendingRequests; }; diff --git a/include/hyperion/LedString.h b/include/hyperion/LedString.h index 6a5bfc528..23593bb89 100644 --- a/include/hyperion/LedString.h +++ b/include/hyperion/LedString.h @@ -145,11 +145,11 @@ class LedString /// bool hasBlackListedLeds (); - static LedString createLedString(const QJsonArray& ledConfigArray, const ColorOrder deviceOrder); - -private: - /// The list with LED specifications - std::vector _leds; - /// The list containing IDs of blacklisted LED - std::vector _blacklistedLedIds; -}; + static LedString createLedString(const QJsonArray& ledConfigArray, const ColorOrder deviceOrder, int maxLedCount); + + private: + /// The list with LED specifications + std::vector _leds; + /// The list containing IDs of blacklisted LED + std::vector _blacklistedLedIds; + }; diff --git a/include/hyperion/LinearColorSmoothing.h b/include/hyperion/LinearColorSmoothing.h index d22c5da5e..73f1dc8b3 100644 --- a/include/hyperion/LinearColorSmoothing.h +++ b/include/hyperion/LinearColorSmoothing.h @@ -7,6 +7,8 @@ // Qt includes #include +#include +#include // hyperion includes #include @@ -135,6 +137,9 @@ public slots: /// void handleSettingsUpdate(settings::type type, const QJsonDocument &config); + void start(); + void stop(); + private slots: /// Timer callback which writes updated led values to the led device void updateLeds(); @@ -146,6 +151,11 @@ private slots: /// void componentStateChange(hyperion::Components component, bool state); + /// + /// @brief Handle priority updates. + /// + void handlePriorityUpdate(int priority); + private: /** * Pushes the colors into the output queue and popping the head to the led-device @@ -171,7 +181,7 @@ private slots: Hyperion *_hyperion; /// priority muxer instance - PriorityMuxer* _prioMuxer; + QSharedPointer _prioMuxer; /// The interval at which to update the leds (msec) int _updateInterval; @@ -180,7 +190,7 @@ private slots: int64_t _settlingTime; /// The Qt timer object - QTimer *_timer; + QScopedPointer _timer; /// The timestamp at which the target data should be fully applied int64_t _targetTime; diff --git a/include/hyperion/PriorityMuxer.h b/include/hyperion/PriorityMuxer.h index d307843b9..d26b670aa 100644 --- a/include/hyperion/PriorityMuxer.h +++ b/include/hyperion/PriorityMuxer.h @@ -7,7 +7,6 @@ // QT includes #include #include -#include #include // Utils includes @@ -16,8 +15,8 @@ #include // global defines -#define SMOOTHING_MODE_DEFAULT 0 -#define SMOOTHING_MODE_PAUSE 1 +constexpr auto SMOOTHING_MODE_DEFAULT = 0; +constexpr auto SMOOTHING_MODE_PAUSE = 1; class QTimer; class Logger; @@ -81,6 +80,16 @@ class PriorityMuxer : public QObject /// ~PriorityMuxer() override; + /// + /// @brief Start the PriorityMuxer and its timers + /// + void start(); + + /// + /// @brief Stop the PriorityMuxer and its timers + /// + void stop(); + /// /// @brief Start/Stop the PriorityMuxer update timer; On disabled no priority and timeout updates will be performend /// @param enable The new state @@ -280,8 +289,8 @@ private slots: bool _sourceAutoSelectEnabled; // Timer to update Muxer times independent - QTimer* _updateTimer; + QScopedPointer _updateTimer; - QTimer* _timer; - QTimer* _blockTimer; + QScopedPointer _timer; + QScopedPointer _blockTimer; }; diff --git a/include/leddevice/LedDevice.h b/include/leddevice/LedDevice.h index b17a0fc9f..bd4ed880f 100644 --- a/include/leddevice/LedDevice.h +++ b/include/leddevice/LedDevice.h @@ -9,6 +9,8 @@ #include #include #include +#include + // STL includes #include @@ -284,11 +286,23 @@ public slots: signals: /// - /// @brief Emits whenever the LED-Device switches between on/off. + /// @brief Emits whenever the LED-Device is enabled/disabled. + /// + /// @param[in] isEnabled The new state of the device + /// + void isEnabledChanged(bool isEnabled); + + /// + /// @brief Emits whenever the LED-Device switches on/off. + /// + /// @param[in] isOn The new state of the device /// - /// @param[in] newState The new state of the device + void isOnChanged(bool isOn); + + /// + /// @brief Emits whenever the LED-Device is stopped. /// - void enableStateChanged(bool newState); + void isStopped(); protected: @@ -422,7 +436,7 @@ public slots: /// Timer object which makes sure that LED data is written at a minimum rate /// e.g. some devices will switch off when they do not receive data at least every 15 seconds - QTimer* _refreshTimer; + QScopedPointer _refreshTimer; // Device configuration parameters @@ -486,6 +500,13 @@ protected slots: /// virtual void setInError( const QString& errorMsg, bool isRecoverable=true); +private slots: + + /// + /// @brief Retry to enable the LED-device + /// + void retryEnable(); + private: /// @brief Start a new refresh cycle @@ -495,7 +516,7 @@ protected slots: void stopRefreshTimer(); /// Timer that enables a device (used to retry enablement, if enabled failed before) - QTimer* _enableAttemptsTimer; + QScopedPointer _enableAttemptsTimer; // Device configuration parameters diff --git a/include/leddevice/LedDeviceWrapper.h b/include/leddevice/LedDeviceWrapper.h index b86c76192..1b495a41f 100644 --- a/include/leddevice/LedDeviceWrapper.h +++ b/include/leddevice/LedDeviceWrapper.h @@ -6,11 +6,7 @@ #include #include -#if (QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)) - #include -#else - #include -#endif +#include class LedDevice; class Hyperion; @@ -19,7 +15,7 @@ typedef LedDevice* ( *LedDeviceCreateFuncType ) ( const QJsonObject& ); typedef std::map LedDeviceRegistry; /// -/// @brief Creates and destroys LedDevice instances with LedDeviceFactory and moves the device to a thread. Pipes all signal/slots and methods to LedDevice instance +/// @brief Creates and destroys LedDevice instances with LedDeviceFactory and moves the device to an own thread. Pipes all signal/slots and methods to an Led-device instance /// class LedDeviceWrapper : public QObject { @@ -44,6 +40,11 @@ class LedDeviceWrapper : public QObject /// static int addToDeviceMap(QString name, LedDeviceCreateFuncType funcPtr); + /// + /// @brief Initialize the device map + /// + static void initializeDeviceMap(); + /// /// @brief Return all available device constructors /// @return device constructors @@ -51,20 +52,25 @@ class LedDeviceWrapper : public QObject static const LedDeviceRegistry& getDeviceMap(); /// - /// @brief Get the current latch time of the ledDevice + /// @brief Get the current latch time of the LED-device /// @ return latch time in ms /// int getLatchTime() const; /// - /// @brief Get the current active ledDevice type + /// @brief Get the current active LED-device type /// QString getActiveDeviceType() const; /// /// @brief Return the last enable state /// - bool enabled() const; + bool isEnabled() const; + + /// + /// @brief Return the last ON state + /// + bool isOn() const; /// /// @brief Get the current colorOrder from device @@ -74,7 +80,7 @@ class LedDeviceWrapper : public QObject /// /// @brief Get the number of LEDs from device /// - unsigned int getLedCount() const; + int getLedCount() const; public slots: /// @@ -84,6 +90,11 @@ public slots: /// void handleComponentState(hyperion::Components component, bool state); + /// + /// @brief Disables the LED-device and stops the device's thread + /// + void stopDevice(); + signals: /// /// PIPER signal for Hyperion -> LedDevice @@ -103,40 +114,60 @@ public slots: /// @brief Switch the LEDs off. /// void switchOff(); - - void stopLedDevice(); + + /// + /// @brief Enable the LED-device. + /// + void enable(); + + /// + /// @brief Disable the LED-device. + /// + void disable(); + + /// + /// @brief Stop the LED-device. + /// + void stop(); + + /// + /// @brief Emits when the LED-device stopped. + /// + void isStopped(); private slots: /// - /// @brief Is called whenever the led device switches between on/off. The led device can disable it's component state + /// @brief Is called whenever the LED-device is enabled/disabled. /// The signal comes from the LedDevice /// @param newState The new state of the device /// - void handleInternalEnableState(bool newState); + void onIsEnabledChanged(bool isEnabled); + /// + /// @brief Is called whenever the LED-device switches between on/off. + /// The signal comes from the LedDevice + /// @param newState The new state of the device + /// + void onIsOnChanged(bool isOn); protected: /// contains all available led device constructors static LedDeviceRegistry _ledDeviceMap; - -#if (QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)) - static QRecursiveMutex _ledDeviceMapLock; -#else - static QMutex _ledDeviceMapLock; -#endif -private: - /// - /// @brief switchOff() the device and Stops the device thread - /// - void stopDeviceThread(); private: + /// The common Logger instance for all LED-devices + Logger * _log; + // parent Hyperion Hyperion* _hyperion; - // Pointer of current led device - LedDevice* _ledDevice; - // the enable state - bool _enabled; + + // Pointer to the current LED-device & its thread + QScopedPointer _ledDevice; + QScopedPointer _ledDeviceThread; + + // LED-Device's states + bool _isEnabled; + bool _isOn; }; #endif // LEDEVICEWRAPPER_H diff --git a/include/mdns/MdnsBrowser.h b/include/mdns/MdnsBrowser.h index 46a0b9c3f..16f552f52 100644 --- a/include/mdns/MdnsBrowser.h +++ b/include/mdns/MdnsBrowser.h @@ -17,12 +17,11 @@ #include #include #include -#include #include +#include // Utility includes #include -#include namespace { constexpr std::chrono::milliseconds DEFAULT_DISCOVER_TIMEOUT{ 500 }; @@ -39,37 +38,36 @@ class MdnsBrowser : public QObject /// Searching for hyperion http service by default /// // Run MdnsBrowser as singleton - MdnsBrowser(QObject* parent = nullptr); + explicit MdnsBrowser(QObject* parent = nullptr); MdnsBrowser(const MdnsBrowser&) = delete; MdnsBrowser(MdnsBrowser&&) = delete; MdnsBrowser& operator=(const MdnsBrowser&) = delete; MdnsBrowser& operator=(MdnsBrowser&&) = delete; - static QScopedPointer instance; + static QSharedPointer instance; public: ~MdnsBrowser() override; - static QScopedPointer& getInstance(); + static QSharedPointer& getInstance(QThread* externalThread = nullptr); + - QMdnsEngine::Service getFirstService(const QByteArray& serviceType, const QString& filter = ".*", const std::chrono::milliseconds waitTime = DEFAULT_DISCOVER_TIMEOUT) const; - QJsonArray getServicesDiscoveredJson(const QByteArray& serviceType, const QString& filter = ".*", const std::chrono::milliseconds waitTime = std::chrono::milliseconds{ 0 }) const; + QMdnsEngine::Service getFirstService(const QByteArray& serviceType, const QString& filter = ".*", std::chrono::milliseconds waitTime = DEFAULT_DISCOVER_TIMEOUT) const; + QJsonArray getServicesDiscoveredJson(const QByteArray& serviceType, const QString& filter = ".*", std::chrono::milliseconds waitTime = std::chrono::milliseconds{ 0 }) const; void printCache(const QByteArray& name = QByteArray(), quint16 type = QMdnsEngine::ANY) const; public slots: + void stop(); // Stop _server and _cache in the right thread + /// /// @brief Browse for a service of type /// void browseForServiceType(const QByteArray& serviceType); - QHostAddress getHostFirstAddress(const QByteArray& hostname); - - void onHostNameResolved(const QHostAddress& address); + void resolveServiceInstance(const QByteArray& serviceInstance, std::chrono::milliseconds waitTime = DEFAULT_DISCOVER_TIMEOUT) const; - QMdnsEngine::Record getServiceInstanceRecord(const QByteArray& serviceInstance, const std::chrono::milliseconds waitTime = DEFAULT_DISCOVER_TIMEOUT) const; - - bool resolveAddress(Logger* log, const QString& hostname, QHostAddress& hostAddress, std::chrono::milliseconds timeout = DEFAULT_ADDRESS_RESOLVE_TIMEOUT); + void resolveFirstAddress(Logger* log, const QString& hostname, std::chrono::milliseconds timeout = DEFAULT_ADDRESS_RESOLVE_TIMEOUT); Q_SIGNALS: @@ -90,21 +88,27 @@ public slots: */ void serviceRemoved(const QMdnsEngine::Service& service); - void addressResolved(const QHostAddress address); + void isAddressResolved(QHostAddress address); + void isFirstAddressResolved(QHostAddress address); + + void isServiceRecordResolved(QMdnsEngine::Record serviceRecord) const; private slots: + void initMdns(); + void onServiceAdded(const QMdnsEngine::Service& service); void onServiceUpdated(const QMdnsEngine::Service& service); void onServiceRemoved(const QMdnsEngine::Service& service); + void onHostNameResolved(const QHostAddress& address); + private: /// The logger instance for mDNS-Service Logger* _log; - QMdnsEngine::Server _server; - QMdnsEngine::Cache _cache; - QSharedPointer _resolver; + QScopedPointer _server; + QScopedPointer _cache; QMap> _browsedServiceTypes; }; diff --git a/include/mdns/MdnsProvider.h b/include/mdns/MdnsProvider.h index c3e328c71..3282d7eb4 100644 --- a/include/mdns/MdnsProvider.h +++ b/include/mdns/MdnsProvider.h @@ -31,6 +31,11 @@ public slots: /// void init(); + /// + /// @brief Stop MdnsProvider to cleanup objects with thread affinity + /// + void stop(); + void publishService (const QString& serviceType, quint16 servicePort, const QByteArray& serviceName = ""); private slots: diff --git a/include/protoserver/ProtoServer.h b/include/protoserver/ProtoServer.h index 1834fb8fd..05697d867 100644 --- a/include/protoserver/ProtoServer.h +++ b/include/protoserver/ProtoServer.h @@ -6,6 +6,7 @@ // qt #include +#include class QTcpServer; class ProtoClientConnection; @@ -40,6 +41,11 @@ public slots: void initServer(); + /// + /// @brief Stop server + /// + void stop(); + private slots: /// /// @brief Is called whenever a new socket wants to connect @@ -55,16 +61,10 @@ private slots: /// /// @brief Start the server with current _port /// - void startServer(); - - /// - /// @brief Stop server - /// - void stopServer(); - + void start(); private: - QTcpServer* _server; + QScopedPointer _server; NetOrigin* _netOrigin; Logger* _log; int _timeout; diff --git a/include/python/PythonInit.h b/include/python/PythonInit.h index 257245d8e..30fcb32d5 100644 --- a/include/python/PythonInit.h +++ b/include/python/PythonInit.h @@ -1,8 +1,8 @@ #pragma once #undef slots -// Don't use debug Python APIs on Windows -#if defined(_MSC_VER) && defined(_DEBUG) +// Don't use debug Python APIs on Windows (GitHub Actions only) +#if defined(GITHUB_ACTIONS) && defined(_MSC_VER) && defined(_DEBUG) #if _MSC_VER >= 1930 #include #endif diff --git a/include/python/PythonProgram.h b/include/python/PythonProgram.h index ea5648c7a..6fa71a85a 100644 --- a/include/python/PythonProgram.h +++ b/include/python/PythonProgram.h @@ -4,8 +4,8 @@ #include #undef slots -// Don't use debug Python APIs on Windows -#if defined(_MSC_VER) && defined(_DEBUG) +// Don't use debug Python APIs on Windows (GitHub Actions only) +#if defined(GITHUB_ACTIONS) && defined(_MSC_VER) && defined(_DEBUG) #if _MSC_VER >= 1930 #include #endif diff --git a/include/python/PythonUtils.h b/include/python/PythonUtils.h index b6f373530..651aa752d 100644 --- a/include/python/PythonUtils.h +++ b/include/python/PythonUtils.h @@ -1,8 +1,8 @@ #pragma once #undef slots -// Don't use debug Python APIs on Windows -#if defined(_MSC_VER) && defined(_DEBUG) +// Don't use debug Python APIs on Windows (GitHub Actions only) +#if defined(GITHUB_ACTIONS) && defined(_MSC_VER) && defined(_DEBUG) #if _MSC_VER >= 1930 #include #endif diff --git a/include/ssdp/SSDPHandler.h b/include/ssdp/SSDPHandler.h index bfbce9a42..73b7d1492 100644 --- a/include/ssdp/SSDPHandler.h +++ b/include/ssdp/SSDPHandler.h @@ -2,16 +2,9 @@ #include -#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0)) -#include -#endif - // utils #include -class WebServer; -class QNetworkConfigurationManager; - /// /// Manage SSDP discovery. SimpleServiceDisoveryProtocol is the discovery subset of UPnP. Implemented is spec V1.0. /// As SSDP requires a webserver, this class depends on it @@ -22,25 +15,25 @@ class SSDPHandler : public SSDPServer { Q_OBJECT public: - SSDPHandler(WebServer* webserver, quint16 flatBufPort, quint16 protoBufPort, quint16 jsonServerPort, quint16 sslPort, const QString& name, QObject* parent = nullptr); + SSDPHandler(QObject* parent = nullptr); ~SSDPHandler() override; - /// - /// @brief Sends BYE BYE and stop server - /// - void stopServer(); - public slots: /// /// @brief Init SSDP after thread start /// void initServer(); + /// + /// @brief Sends BYE BYE and stop server + /// + void stop() override; + /// /// @brief get state changes from webserver /// @param newState true for started and false for stopped /// - void handleWebServerStateChange(bool newState); + void onStateChange(bool newState); /// /// @brief Handle settings update from Hyperion Settingsmanager emit @@ -49,11 +42,17 @@ public slots: /// void handleSettingsUpdate(settings::type type, const QJsonDocument& config); + void onPortChanged(const QString& serviceType, quint16 servicePort); + + +signals: + void descriptionUpdated(const QString& description); + private: /// /// @brief Build http url for current ip:port/desc.xml /// - QString getDescAddress() const; + QString getDescriptionAddress() const override; /// /// @brief Get the base address @@ -63,7 +62,7 @@ public slots: /// /// @brief Build the ssdp description (description.xml) /// - QString buildDesc() const; + QString getDescription() const; /// /// @brief Get the local address of interface @@ -71,6 +70,8 @@ public slots: /// QString getLocalAddress() const; + QString getInfo() const override; + /// /// @brief Send alive/byebye message based on _deviceList /// @param alive When true send alive, else byebye @@ -88,36 +89,16 @@ private slots: void handleMSearchRequest(const QString& target, const QString& mx, const QString address, quint16 port); private: - WebServer* _webserver; - QString _localAddress; - QString _uuid; + QString _localAddress; - /// Targets for announcement - std::vector _deviceList; + quint16 _httpPort; + quint16 _httpsPort; + quint16 _jsonApiPort; + quint16 _flatBufferPort; + quint16 _protoBufferPort; -//Handle elements deprecated from Qt 6.x and reported as deprecatedsince 5.15.x -#if (QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)) -QT_WARNING_PUSH -QT_WARNING_DISABLE_DEPRECATED -#endif + QString _name; -private slots: - -/// -/// @brief Handle changes in the network configuration -/// @param conig New config -/// -#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0)) - void handleNetworkConfigurationChanged(const QNetworkConfiguration& config); -#endif - -private: - -#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0)) - QNetworkConfigurationManager* _NCA; -#endif - -#if (QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)) -QT_WARNING_POP -#endif + /// Targets for announcement + std::vector _deviceList; }; diff --git a/include/ssdp/SSDPServer.h b/include/ssdp/SSDPServer.h index e932d10e7..96c75d7c2 100644 --- a/include/ssdp/SSDPServer.h +++ b/include/ssdp/SSDPServer.h @@ -12,7 +12,6 @@ class SSDPServer : public QObject Q_OBJECT public: - friend class SSDPHandler; /// /// @brief Construct the server, listen on default ssdp address/port with multicast /// @param parent The parent object @@ -20,22 +19,6 @@ class SSDPServer : public QObject SSDPServer(QObject* parent = nullptr); ~SSDPServer() override; - /// - /// @brief Prepare server after thread start - /// - void initServer(); - - /// - /// @brief Start SSDP - /// @return false if already running or bind failure - /// - bool start(); - - /// - /// @brief Stop SSDP - /// - void stop(); - /// /// @brief Send an answer to mSearch requester /// @param st the searchTarget @@ -68,6 +51,12 @@ class SSDPServer : public QObject /// void setDescriptionAddress( const QString &addr ) { _descAddress = addr; } + /// + /// @brief Get the description address + /// @return addr new address + /// + virtual QString getDescriptionAddress() const { return _descAddress; } + /// /// @brief Set uuid /// @param uuid The uuid @@ -75,52 +64,27 @@ class SSDPServer : public QObject void setUuid( const QString &uuid ) { _uuid = uuid; } /// - /// @brief set new flatbuffer server port + /// @brief Get uuid + /// @return uuid The uuid /// - void setFlatBufPort( quint16 port ){_fbsPort = QString::number( port ); } + QString getUuid() const { return _uuid; } +public slots: /// - /// @brief Get current flatbuffer server port - /// - quint16 getFlatBufPort() const - { - return _fbsPort.toInt(); - } - /// - /// @brief set new protobuf server port - /// - void setProtoBufPort( quint16 port ) { _pbsPort = QString::number( port ); } - - /// - /// @brief Get current protobuf server port - /// - quint16 getProtoBufPort() const { return _pbsPort.toInt(); } - /// - /// @brief set new json server port - /// - void setJsonServerPort( quint16 port ) { _jssPort = QString::number( port ); } - /// - /// @brief get new json server port - /// - quint16 getJsonServerPort() const { return _jssPort.toInt(); } - /// - /// @brief set new ssl server port - /// - void setSSLServerPort( quint16 port ) { _sslPort = QString::number( port ); } - /// - /// @brief get new ssl server port + /// @brief Prepare server after thread start /// - quint16 getSSLServerPort() const { return _sslPort.toInt(); } + void initServer(); /// - /// @brief set new hyperion name + /// @brief Start SSDP + /// @return false if already running or bind failure /// - void setHyperionName( const QString &name ) { _name = name; } + bool start(); /// - /// @brief get hyperion name + /// @brief Stop SSDP /// - QString getHyperionName() const { return _name; } + virtual void stop(); signals: /// @@ -135,11 +99,19 @@ class SSDPServer : public QObject const QString address, quint16 port ); -private: +protected: + + virtual QString getInfo() const { return {}; }; + Logger *_log; - QUdpSocket *_udpSocket; - QString _serverHeader, _uuid, _fbsPort, _pbsPort, _jssPort, _sslPort, _name, _descAddress; +private: + + QScopedPointer _udpSocket; + + QString _serverHeader; + QString _uuid; + QString _descAddress; bool _running; private slots: diff --git a/include/utils/ColorRgb.h b/include/utils/ColorRgb.h index 05e710931..840bd570c 100644 --- a/include/utils/ColorRgb.h +++ b/include/utils/ColorRgb.h @@ -48,6 +48,11 @@ struct ColorRgb } + ColorRgb(const QRgb rgb): ColorRgb() + { + setRgb(rgb); + } + ColorRgb operator-(const ColorRgb& b) const { ColorRgb a(*this); diff --git a/include/utils/ErrorManager.h b/include/utils/ErrorManager.h new file mode 100644 index 000000000..d9d46c4c5 --- /dev/null +++ b/include/utils/ErrorManager.h @@ -0,0 +1,17 @@ +#ifndef ERRORMANAGER_H +#define ERRORMANAGER_H + +#include + +class ErrorManager : public QObject +{ + Q_OBJECT + +public: + explicit ErrorManager(QObject *parent = nullptr) : QObject(parent) {} + +signals: + void errorOccurred(QString error); +}; + +#endif // ERRORMANAGER_H diff --git a/include/utils/GlobalSignals.h b/include/utils/GlobalSignals.h index 8fbdba298..8f0d3e995 100644 --- a/include/utils/GlobalSignals.h +++ b/include/utils/GlobalSignals.h @@ -117,4 +117,13 @@ class GlobalSignals : public QObject /// void requestSource(hyperion::Components component, int hyperionInd, bool listen); + /////////////////////////////////////// + ///////////// TO FORWARDER //////////// + /////////////////////////////////////// + + /// + /// @brief Forward message to all json target hosts + /// @param message The JSON message to send + /// + void forwardJsonMessage(const QJsonObject &message, quint8 instanceId); }; diff --git a/include/utils/NetUtils.h b/include/utils/NetUtils.h index a0f085bdd..9fe0e0139 100644 --- a/include/utils/NetUtils.h +++ b/include/utils/NetUtils.h @@ -4,6 +4,10 @@ #include #include #include +#include +#include +#include +#include #include #include @@ -14,191 +18,248 @@ namespace NetUtils { - const int MAX_PORT = 65535; +const int MAX_PORT = 65535; - /// - /// @brief Check if the port is available for listening - /// @param[in/out] port The port to test, will be incremented if port is in use - /// @param log The logger of the caller to print - /// @return True on success else false - /// - inline bool portAvailable(quint16& port, Logger* log) +/// +/// @brief Check if the port is available for listening +/// @param[in/out] port The port to test, will be incremented if port is in use +/// @param log The logger of the caller to print +/// @return True on success else false +/// +inline bool portAvailable(quint16& port, Logger* log) +{ + const quint16 prevPort = port; + QTcpServer server; + while (!server.listen(QHostAddress::Any, port)) { - const quint16 prevPort = port; - QTcpServer server; - while (!server.listen(QHostAddress::Any, port)) - { - Warning(log,"Port '%d' is already in use, will increment", port); - port ++; - } - server.close(); - if(port != prevPort) - { - Warning(log, "The requested Port '%d' is already in use, will use Port '%d' instead", prevPort, port); - return false; - } - return true; + Warning(log,"Port '%d' is already in use, will increment", port); + port ++; } + server.close(); + if(port != prevPort) + { + Warning(log, "The requested Port '%d' is already in use, will use Port '%d' instead", prevPort, port); + return false; + } + return true; +} - /// - /// @brief Check if the port is in the valid range - /// @param log The logger of the caller to print/// - /// @param[in] port The port to be tested (port = -1 is ignored for testing) - /// @param[in] host A hostname/IP-address to make reference to during logging - /// @return True on success else false - /// - inline bool isValidPort(Logger* log, int port, const QString& host) +/// +/// @brief Check if the port is in the valid range +/// @param log The logger of the caller to print/// +/// @param[in] port The port to be tested (port = -1 is ignored for testing) +/// @param[in] host A hostname/IP-address to make reference to during logging +/// @return True on success else false +/// +inline bool isValidPort(Logger* log, int port, const QString& host) +{ + if ((port <= 0 || port > MAX_PORT) && port != -1) { - if ((port <= 0 || port > MAX_PORT) && port != -1) - { - Error(log, "Invalid port [%d] for host: (%s)! - Port must be in range [1 - %d]", port, QSTRING_CSTR(host), MAX_PORT); - return false; - } - return true; + Error(log, "Invalid port [%d] for host: (%s)! - Port must be in range [1 - %d]", port, QSTRING_CSTR(host), MAX_PORT); + return false; } + return true; +} - /// - /// @brief Get host and port from an host address - /// @param[in] address Hostname or IP-address with or without port (e.g. 192.168.1.100:4711, 2003:e4:c73a:8e00:d5bb:dc3c:50cb:c76e, hyperion.fritz.box) - /// @param[in/out] host The resolved hostname or IP-address - /// @param[in/out] port The resolved port, if available. - /// @return True on success else false - /// - inline bool resolveHostPort(const QString& address, QString& host, int& port) +/// +/// @brief Get host and port from an host address +/// @param[in] address Hostname or IP-address with or without port (e.g. 192.168.1.100:4711, 2003:e4:c73a:8e00:d5bb:dc3c:50cb:c76e, hyperion.fritz.box) +/// @param[in/out] host The resolved hostname or IP-address +/// @param[in/out] port The resolved port, if available. +/// @return True on success else false +/// +inline bool resolveHostPort(const QString& address, QString& host, int& port) +{ + if (address.isEmpty()) { - if (address.isEmpty()) - { - return false; - } + return false; + } - QString testUrl; - if (address.at(0) != '[' && address.count(':') > 1) - { - testUrl = QString("http://[%1]").arg(address); - } - else - { - testUrl = QString("http://%1").arg(address); - } + QString testUrl; + if (address.at(0) != '[' && address.count(':') > 1) + { + testUrl = QString("http://[%1]").arg(address); + } + else + { + testUrl = QString("http://%1").arg(address); + } - QUrl url(testUrl); - if (!url.isValid()) - { - return false; - } + QUrl const url(testUrl); + if (!url.isValid()) + { + return false; + } - host = url.host(); - if (url.port() != -1) - { - port = url.port(); - } - return true; + host = url.host(); + if (url.port() != -1) + { + port = url.port(); } + return true; +} - /// - /// @brief Resolve a hostname (DNS/mDNS) into an IP-address. A given IP address will be passed through - /// @param[in/out] log The logger of the caller to print - /// @param[in] hostname The hostname to be resolved - /// @param[out] hostAddress The resolved IP-Address - /// @return True on success else false - /// - inline bool resolveMdDnsHostToAddress(Logger* log, const QString& hostname, QHostAddress& hostAddress) +/// +/// @brief Resolve a hostname (DNS/mDNS) into an IP-address. A given IP address will be passed through +/// @param[in/out] log The logger of the caller to print +/// @param[in] hostname The hostname to be resolved +/// @param[out] hostAddress The resolved IP-Address +/// @return True on success else false +/// +inline bool resolveMdDnsHostToAddress(Logger* log, const QString& hostname, QHostAddress& hostAddress) +{ + bool isHostAddressOK{ false }; + if (!hostname.isEmpty()) { - bool isHostAddressOK{ false }; - if (!hostname.isEmpty()) +#ifdef ENABLE_MDNS + if (hostname.endsWith(".local") || hostname.endsWith(".local.")) + { + MdnsBrowser* browser = MdnsBrowser::getInstance().get(); + QEventLoop loop; + + // Connect the signal to capture the resolved address + QObject::connect(browser, &MdnsBrowser::isFirstAddressResolved, &loop, [&](QHostAddress addr) { + hostAddress = std::move(addr); + loop.quit(); + }); + + // Call the function asynchronously in MdnsBrowser's thread + QMetaObject::invokeMethod(browser, "resolveFirstAddress", + Qt::QueuedConnection, // Ensures it runs in the correct thread + Q_ARG(Logger*, log), + Q_ARG(QString, hostname) + ); + + // Wait for the result + loop.exec(); + + if (!hostAddress.isNull()) + { + isHostAddressOK = true; + } + } + else +#endif { - #ifdef ENABLE_MDNS - if (hostname.endsWith(".local") || hostname.endsWith(".local.")) + // If it's not an mDNS hostname, resolve it normally (synchronously) + if (hostAddress.setAddress(hostname)) { - QHostAddress resolvedAddress; - QMetaObject::invokeMethod(MdnsBrowser::getInstance().data(), "resolveAddress", - Qt::BlockingQueuedConnection, - Q_RETURN_ARG(bool, isHostAddressOK), - Q_ARG(Logger*, log), Q_ARG(QString, hostname), Q_ARG(QHostAddress&, resolvedAddress)); - hostAddress = resolvedAddress; + // An IP-address is not required to be resolved + isHostAddressOK = true; } else - #endif { - if (hostAddress.setAddress(hostname)) - { - // An IP-address is not required to be resolved + QHostInfo const hostInfo = QHostInfo::fromName(hostname); + if (hostInfo.error() == QHostInfo::NoError) { + hostAddress = hostInfo.addresses().at(0); + Debug(log, "Successfully resolved hostname (%s) to IP-address (%s)", QSTRING_CSTR(hostname), QSTRING_CSTR(hostAddress.toString())); isHostAddressOK = true; - } - else - { - QHostInfo hostInfo = QHostInfo::fromName(hostname); - if (hostInfo.error() == QHostInfo::NoError) - { - hostAddress = hostInfo.addresses().at(0); - Debug(log, "Successfully resolved hostname (%s) to IP-address (%s)", QSTRING_CSTR(hostname), QSTRING_CSTR(hostAddress.toString())); - isHostAddressOK = true; - } - else - { - QString errortext = QString("Failed resolving hostname (%1) to IP-address. Error: (%2) %3").arg(hostname).arg(hostInfo.error()).arg(hostInfo.errorString()); - Error(log, "%s", QSTRING_CSTR(errortext)); - isHostAddressOK = false; - } + } else { + QString const errorText = QString("Failed resolving hostname (%1) to IP-address. Error: (%2) %3") + .arg(hostname) + .arg(hostInfo.error()) + .arg(hostInfo.errorString()); + Error(log, "%s", QSTRING_CSTR(errorText)); + isHostAddressOK = false; } } + } - return isHostAddressOK; } + return isHostAddressOK; +} - /// - /// @brief Resolve a hostname(DNS) or mDNS service name into an IP-address. A given IP address will be passed through - /// @param[in/out] log The logger of the caller to print - /// @param[in] hostname The hostname/mDNS service name to be resolved - /// @param[out] hostAddress The resolved IP-Address - /// @param[in/out] port The port provided by the mDNS service, if not mDNS the input port is returned - /// @return True on success else false - /// - inline bool resolveHostToAddress(Logger* log, const QString& hostname, QHostAddress& hostAddress, int& port) +/// +/// @brief Resolve a mDNS service name into a nmDNS serice record including mDNS hostname & port for the given service instance +/// @param[in/out] log The logger of the caller to print +/// @param[in] serviceInstance The service instance to be resolved +/// @return A service record +/// +#ifdef ENABLE_MDNS +inline QMdnsEngine::Record resolveMdDnsServiceRecord(const QByteArray& serviceInstance) +{ + QMdnsEngine::Record serviceRecord; + + + if (serviceInstance.endsWith("._tcp.local")) { - bool areHostAddressPartOK{ false }; - QString target {hostname}; + qRegisterMetaType("QMdnsEngine::Record"); + + MdnsBrowser* browser = MdnsBrowser::getInstance().get(); + QEventLoop loop; + + // Connect the signal to capture the resolved service record + QObject::connect(browser, &MdnsBrowser::isServiceRecordResolved, &loop, [&](QMdnsEngine::Record resolvedServiceRecord) { + serviceRecord = resolvedServiceRecord; + loop.quit(); + }); - #ifdef ENABLE_MDNS - if (hostname.endsWith("._tcp.local")) + // Call the function asynchronously in MdnsBrowser's thread + QMetaObject::invokeMethod(browser, "resolveServiceInstance", + Qt::QueuedConnection, // Ensures it runs in the correct thread + Q_ARG(QByteArray, serviceInstance) + ); + + // Wait for the result + loop.exec(); + } + return serviceRecord; +} +#endif + +/// +/// @brief Resolve a hostname(DNS) or mDNS service name into an IP-address. A given IP address will be passed through +/// @param[in/out] log The logger of the caller to print +/// @param[in] hostname The hostname/mDNS service name to be resolved +/// @param[out] hostAddress The resolved IP-Address +/// @param[in/out] port The port provided by the mDNS service, if not mDNS the input port is returned +/// @return True on success else false +/// +inline bool resolveHostToAddress(Logger* log, const QString& hostname, QHostAddress& hostAddress, int& port) +{ + bool areHostAddressPartOK{ false }; + QString target {hostname}; + +#ifdef ENABLE_MDNS + if (hostname.endsWith("._tcp.local")) + { + //Treat hostname as service instance name that requires to be resolved into an mDNS-Hostname first + QMdnsEngine::Record const service = resolveMdDnsServiceRecord(hostname.toUtf8()); + if (!service.target().isEmpty()) { - //Treat hostname as service instance name that requires to be resolved into an mDNS-Hostname first - QMdnsEngine::Record service = MdnsBrowser::getInstance().data()->getServiceInstanceRecord(hostname.toUtf8()); - if (!service.target().isEmpty()) - { - Info(log, "Resolved service [%s] to mDNS hostname [%s], service port [%d]", QSTRING_CSTR(hostname), service.target().constData(), service.port()); - target = service.target(); - port = service.port(); - } - else - { - Error(log, "Cannot resolve mDNS hostname for given service [%s]!", QSTRING_CSTR(hostname)); - return areHostAddressPartOK; - } + Info(log, "Resolved service [%s] to mDNS hostname [%s], service port [%d]", QSTRING_CSTR(hostname), service.target().constData(), service.port()); + target = service.target(); + port = service.port(); } - #endif - - QHostAddress resolvedAddress; - if (NetUtils::resolveMdDnsHostToAddress(log, target, resolvedAddress)) + else { - hostAddress = resolvedAddress; - if (hostname != hostAddress.toString()) - { - Info(log, "Resolved hostname (%s) to IP-address (%s)", QSTRING_CSTR(hostname), QSTRING_CSTR(hostAddress.toString())); - } - - if (NetUtils::isValidPort(log, port, hostAddress.toString())) - { - areHostAddressPartOK = true; - } + Error(log, "Cannot resolve mDNS hostname for given service [%s]!", QSTRING_CSTR(hostname)); + return areHostAddressPartOK; } - return areHostAddressPartOK; } +#endif - inline bool resolveHostToAddress(Logger* log, const QString& hostname, QHostAddress& hostAddress) + QHostAddress resolvedAddress; + if (NetUtils::resolveMdDnsHostToAddress(log, target, resolvedAddress)) { - int ignoredPort {MAX_PORT}; - return resolveHostToAddress(log, hostname, hostAddress, ignoredPort); - } + hostAddress = resolvedAddress; + if (hostname != hostAddress.toString()) + { + Info(log, "Resolved hostname (%s) to IP-address (%s)", QSTRING_CSTR(hostname), QSTRING_CSTR(hostAddress.toString())); + } + if (NetUtils::isValidPort(log, port, hostAddress.toString())) + { + areHostAddressPartOK = true; + } } + return areHostAddressPartOK; +} + +inline bool resolveHostToAddress(Logger* log, const QString& hostname, QHostAddress& hostAddress) +{ + int ignoredPort {MAX_PORT}; + return resolveHostToAddress(log, hostname, hostAddress, ignoredPort); +} + +} diff --git a/include/utils/WaitTime.h b/include/utils/WaitTime.h index 0521ed5b3..e6140f01f 100644 --- a/include/utils/WaitTime.h +++ b/include/utils/WaitTime.h @@ -9,18 +9,20 @@ inline void wait(std::chrono::milliseconds millisecondsWait) { QEventLoop loop; - QTimer t; - t.connect(&t, &QTimer::timeout, &loop, &QEventLoop::quit); - t.start(millisecondsWait.count()); + QTimer timer; + timer.setTimerType(Qt::PreciseTimer); + QTimer::connect(&timer, &QTimer::timeout, &loop, &QEventLoop::quit); + timer.start(millisecondsWait.count()); loop.exec(); } inline void wait(int millisecondsWait) { QEventLoop loop; - QTimer t; - t.connect(&t, &QTimer::timeout, &loop, &QEventLoop::quit); - t.start(millisecondsWait); + QTimer timer; + timer.setTimerType(Qt::PreciseTimer); + QTimer::connect(&timer, &QTimer::timeout, &loop, &QEventLoop::quit); + timer.start(millisecondsWait); loop.exec(); } diff --git a/include/utils/hyperion.h b/include/utils/hyperion.h index cdb0fd2f3..f6ed7e80c 100644 --- a/include/utils/hyperion.h +++ b/include/utils/hyperion.h @@ -64,9 +64,9 @@ namespace hyperion { #undef FGCONFIG_ARRAY } - static ColorOrder createColorOrder(const QJsonObject &deviceConfig) + static ColorOrder createColorOrder(const QString& colorOrder = "rgb") { - return stringToColorOrder(deviceConfig["colorOrder"].toString("rgb")); + return stringToColorOrder(colorOrder); } static RgbTransform createRgbTransform(const QJsonObject& colorConfig) diff --git a/include/utils/jsonschema/QJsonUtils.h b/include/utils/jsonschema/QJsonUtils.h index 274934c02..f37459c35 100644 --- a/include/utils/jsonschema/QJsonUtils.h +++ b/include/utils/jsonschema/QJsonUtils.h @@ -11,29 +11,37 @@ class QJsonUtils { public: - static void modify(QJsonValue& value, QStringList path, const QJsonValue& newValue = QJsonValue::Null, QString propertyName = "") + static bool modify(QJsonValue& value, QStringList path, const QJsonValue& newValue = QJsonValue::Null, QString propertyName = "") { QJsonObject result; - + bool propertyUpdated {false}; if (!path.isEmpty()) { - if (path.first() == "[root]") - path.removeFirst(); - for (QStringList::iterator it = path.begin(); it != path.end(); ++it) + if (path.first() == "[root]") { - QString current = *it; - if (current.left(1) == ".") - *it = current.mid(1, current.size()-1); + path.removeFirst(); + } + // Clean up leading periods in path elements + for (auto& current : path) { + if (current.startsWith(".")) + { + current.remove(0, 1); + } } if (! (value.toObject().isEmpty() && value.toArray().isEmpty()) ) - modifyValue(value, result, path, newValue, propertyName); + { + modifyValue(value, result, path, newValue, propertyName, propertyUpdated); + } else if (newValue != QJsonValue::Null && !propertyName.isEmpty()) + { result[propertyName] = newValue; + propertyUpdated = true; + } } - value = result; + return propertyUpdated; } static QJsonValue create(QJsonValue schema, bool ignoreRequired = false) @@ -155,152 +163,72 @@ class QJsonUtils return result; } - static void modifyValue(QJsonValue source, QJsonObject& target, QStringList path, const QJsonValue& newValue, QString& property) + static void modifyValue(QJsonValue source, QJsonValue target, QStringList path, const QJsonValue& newValue, QString& property, bool& propertyUpdated) { - QJsonObject obj = source.toObject(); - - if (!obj.isEmpty()) - { - for (QJsonObject::iterator i = obj.begin(); i != obj.end(); ++i) - { - QString propertyName = i.key(); - QJsonValue subValue = obj[propertyName]; - - if (subValue.isObject()) - { - if (!path.isEmpty()) - { - if (propertyName == path.first()) - { - path.removeFirst(); + // Ensure the path is not empty + if (path.isEmpty()) { + propertyUpdated = false; + return; + } - if (!path.isEmpty()) - { - QJsonObject tempObj; - modifyValue(subValue, tempObj, path, newValue, property); - subValue = tempObj; - } - else if (newValue != QJsonValue::Null) - subValue = newValue; - else - continue; + QString current = path.takeFirst(); - if (!subValue.toObject().isEmpty()) - target[propertyName] = subValue; - } - else - { - if (path.first() == property && newValue != QJsonValue::Null) - { - target[property] = newValue; - property = QString(); - } + // Handle object case + if (source.isObject()) { + QJsonObject obj = source.toObject(); - target[propertyName] = subValue; - } - } - else - if (!subValue.toObject().isEmpty()) - target[propertyName] = subValue; + if (!obj.contains(current)) { + // Create missing key if necessary + if (path.isEmpty()) { + obj[current] = newValue; + propertyUpdated = true; + } else { + QJsonValue emptyObj((QJsonObject())); // create an empty object + modifyValue(emptyObj, obj[current], path, newValue, property, propertyUpdated); } - else if (subValue.isArray()) - { - if (!path.isEmpty()) - { - if (propertyName == path.first()) - { - path.removeFirst(); - - int arrayLevel = -1; - if (!path.isEmpty()) - { - if ((path.first().left(1) == "[") && (path.first().right(1) == "]")) - { - arrayLevel = path.first().mid(1, path.first().size()-2).toInt(); - path.removeFirst(); - } - } - - QJsonArray array = subValue.toArray(); - QJsonArray json_array; - - for (QJsonArray::iterator i = array.begin(); i != array.end(); ++i) - { - if (!path.isEmpty()) - { - QJsonObject arr; - modifyValue(*i, arr, path, newValue, property); - subValue = arr; - } - else if (newValue != QJsonValue::Null) - subValue = newValue; - else - continue; - - if (!subValue.toObject().isEmpty()) - json_array.append(subValue); - else if (newValue != QJsonValue::Null && arrayLevel != -1) - json_array.append( (i - array.begin() == arrayLevel) ? subValue : *i ); - } - - if (!json_array.isEmpty()) - target[propertyName] = json_array; - else if (newValue != QJsonValue::Null && arrayLevel == -1) - target[propertyName] = newValue; - } - else - { - if (path.first() == property && newValue != QJsonValue::Null) - { - target[property] = newValue; - property = QString(); - } + } else { + QJsonValue existingValue = obj[current]; + modifyValue(existingValue, obj[current], path, newValue, property, propertyUpdated); + } - target[propertyName] = subValue; - } - } - else - if (!subValue.toArray().isEmpty()) - target[propertyName] = subValue; + target = obj; // Reassign modified object to target + } + // Handle array case + else if (source.isArray()) { + QJsonArray arr = source.toArray(); + bool isIndex; + int index = current.toInt(&isIndex); + + if (isIndex && index >= 0 && index < arr.size()) { + // If the path is empty, modify the element at the index + if (path.isEmpty()) { + arr[index] = newValue; + propertyUpdated = true; + } else { + QJsonValue arrayElement = arr[index]; + modifyValue(arrayElement, arr[index], path, newValue, property, propertyUpdated); } - else - { - if (!path.isEmpty()) - { - if (propertyName == path.first()) - { - path.removeFirst(); - - if (path.isEmpty()) - { - if (newValue != QJsonValue::Null && property.isEmpty()) - subValue = newValue; - else - continue; - } - - target[propertyName] = subValue; - } - else - { - if (path.first() == property && newValue != QJsonValue::Null) - { - target[property] = newValue; - property = QString(); - } + } + else { + // Expand array if index is out of bounds + while (arr.size() <= index) + arr.append(QJsonValue()); - target[propertyName] = subValue; - } - } - else - target[propertyName] = subValue; - } + QJsonValue arrayElement = arr[index]; + modifyValue(arrayElement, arr[index], path, newValue, property, propertyUpdated); } + + target = arr; // Reassign modified array to target } - else if (newValue != QJsonValue::Null && !property.isEmpty()) - { - target[property] = newValue; - property = QString(); + // Handle unsupported cases (e.g., primitive values) + else { + if (path.isEmpty()) { + QJsonObject obj; + obj[current] = newValue; + target = obj; + propertyUpdated = true; + } } } + }; diff --git a/include/utils/settings.h b/include/utils/settings.h index 10cd879b0..2db7d5c09 100644 --- a/include/utils/settings.h +++ b/include/utils/settings.h @@ -81,31 +81,31 @@ namespace settings { /// inline type stringToType(const QString& type) { - if (type == "backgroundEffect") return BGEFFECT; - else if (type == "foregroundEffect") return FGEFFECT; - else if (type == "blackborderdetector") return BLACKBORDER; - else if (type == "boblightServer") return BOBLSERVER; - else if (type == "color") return COLOR; - else if (type == "device") return DEVICE; - else if (type == "effects") return EFFECTS; - else if (type == "forwarder") return NETFORWARD; - else if (type == "framegrabber") return SYSTEMCAPTURE; - else if (type == "general") return GENERAL; - else if (type == "grabberV4L2") return V4L2; - else if (type == "grabberAudio") return AUDIO; - else if (type == "jsonServer") return JSONSERVER; - else if (type == "ledConfig") return LEDCONFIG; - else if (type == "leds") return LEDS; - else if (type == "logger") return LOGGER; - else if (type == "smoothing") return SMOOTHING; - else if (type == "webConfig") return WEBSERVER; - else if (type == "instCapture") return INSTCAPTURE; - else if (type == "network") return NETWORK; - else if (type == "flatbufServer") return FLATBUFSERVER; - else if (type == "protoServer") return PROTOSERVER; - else if (type == "osEvents") return OSEVENTS; - else if (type == "cecEvents") return CECEVENTS; - else if (type == "schedEvents") return SCHEDEVENTS; - else return INVALID; + if (type == "backgroundEffect") return BGEFFECT; + if (type == "foregroundEffect") return FGEFFECT; + if (type == "blackborderdetector") return BLACKBORDER; + if (type == "boblightServer") return BOBLSERVER; + if (type == "color") return COLOR; + if (type == "device") return DEVICE; + if (type == "effects") return EFFECTS; + if (type == "forwarder") return NETFORWARD; + if (type == "framegrabber") return SYSTEMCAPTURE; + if (type == "general") return GENERAL; + if (type == "grabberV4L2") return V4L2; + if (type == "grabberAudio") return AUDIO; + if (type == "jsonServer") return JSONSERVER; + if (type == "ledConfig") return LEDCONFIG; + if (type == "leds") return LEDS; + if (type == "logger") return LOGGER; + if (type == "smoothing") return SMOOTHING; + if (type == "webConfig") return WEBSERVER; + if (type == "instCapture") return INSTCAPTURE; + if (type == "network") return NETWORK; + if (type == "flatbufServer") return FLATBUFSERVER; + if (type == "protoServer") return PROTOSERVER; + if (type == "osEvents") return OSEVENTS; + if (type == "cecEvents") return CECEVENTS; + if (type == "schedEvents") return SCHEDEVENTS; + return INVALID; } } diff --git a/include/webserver/WebServer.h b/include/webserver/WebServer.h index e2cfef491..defdd5ae8 100644 --- a/include/webserver/WebServer.h +++ b/include/webserver/WebServer.h @@ -37,9 +37,6 @@ class WebServer : public QObject ~WebServer () override; - void start(); - void stop(); - signals: /// /// @emits whenever server is started or stopped (to sync with SSDPHandler) @@ -63,6 +60,9 @@ public slots: /// void initServer(); + void start(); + void stop(); + void onServerStopped (); void onServerStarted (quint16 port); void onServerError (const QString& msg); @@ -77,7 +77,7 @@ public slots: /// /// @brief Set a new description, if empty the description is NotFound for clients /// - void setSSDPDescription(const QString & desc); + void onSsdpDescriptionUpdated(const QString & desc); /// check if server has been inited bool isInited() const { return _inited; } diff --git a/libsrc/api/API.cpp b/libsrc/api/API.cpp index b34ec5083..a6f69e980 100644 --- a/libsrc/api/API.cpp +++ b/libsrc/api/API.cpp @@ -1,4 +1,5 @@ // project includes +#include "db/SettingsTable.h" #include // stl includes @@ -13,8 +14,10 @@ #include #include #include +#include // hyperion includes +#include #include #include #include @@ -36,7 +39,12 @@ const int IMAGE_SCALE = 2000; } API::API(Logger *log, bool localConnection, QObject *parent) - : QObject(parent) + : QObject(parent), + _currInstanceIndex (GLOABL_INSTANCE_ID) + , _hyperion (nullptr) + , _authorized (false) + , _adminAuthorized (false) + , _localConnection(localConnection) { qRegisterMetaType("int64_t"); qRegisterMetaType("VideoMode"); @@ -46,12 +54,6 @@ API::API(Logger *log, bool localConnection, QObject *parent) _log = log; _authManager = AuthManager::getInstance(); _instanceManager = HyperionIManager::getInstance(); - _localConnection = localConnection; - - _authorized = false; - _adminAuthorized = false; - - _currInstanceIndex = 0; // connect to possible token responses that has been requested connect(_authManager, &AuthManager::tokenResponse, this, [=] (bool success, const QObject *caller, const QString &token, const QString &comment, const QString &tokenId, const int &tan) @@ -73,7 +75,6 @@ API::API(Logger *log, bool localConnection, QObject *parent) void API::init() { - _hyperion = _instanceManager->getHyperionInstance(0); _authorized = false; // For security we block external connections, if default PW is set @@ -102,7 +103,8 @@ void API::setColor(int priority, const std::vector &ledColors, int time { fledColors.emplace_back(ColorRgb{ledColors[i], ledColors[i + 1], ledColors[i + 2]}); } - QMetaObject::invokeMethod(_hyperion, "setColor", Qt::QueuedConnection, Q_ARG(int, priority), Q_ARG(std::vector, fledColors), Q_ARG(int, timeout_ms), Q_ARG(QString, origin)); + + QMetaObject::invokeMethod(_hyperion.get(), "setColor", Qt::QueuedConnection, Q_ARG(int, priority), Q_ARG(std::vector, fledColors), Q_ARG(int, timeout_ms), Q_ARG(QString, origin)); } } @@ -192,8 +194,8 @@ bool API::setImage(ImageCmdData &data, hyperion::Components comp, QString &reply Image image(data.width, data.height); memcpy(image.memptr(), data.data.data(), static_cast(data.data.size())); - QMetaObject::invokeMethod(_hyperion, "registerInput", Qt::QueuedConnection, Q_ARG(int, data.priority), Q_ARG(hyperion::Components, comp), Q_ARG(QString, data.origin), Q_ARG(QString, data.imgName)); - QMetaObject::invokeMethod(_hyperion, "setInputImage", Qt::QueuedConnection, Q_ARG(int, data.priority), Q_ARG(Image, image), Q_ARG(int64_t, data.duration)); + QMetaObject::invokeMethod(_hyperion.get(), "registerInput", Qt::QueuedConnection, Q_ARG(int, data.priority), Q_ARG(hyperion::Components, comp), Q_ARG(QString, data.origin), Q_ARG(QString, data.imgName)); + QMetaObject::invokeMethod(_hyperion.get(), "setInputImage", Qt::QueuedConnection, Q_ARG(int, data.priority), Q_ARG(Image, image), Q_ARG(int64_t, data.duration)); return true; } @@ -202,7 +204,7 @@ bool API::clearPriority(int priority, QString &replyMsg, hyperion::Components /* { if (priority < 0 || (priority > 0 && priority < PriorityMuxer::BG_PRIORITY)) { - QMetaObject::invokeMethod(_hyperion, "clear", Qt::QueuedConnection, Q_ARG(int, priority)); + QMetaObject::invokeMethod(_hyperion.get(), "clear", Qt::QueuedConnection, Q_ARG(int, priority)); } else { @@ -218,7 +220,7 @@ bool API::setComponentState(const QString &comp, bool &compState, QString &reply if (component != COMP_INVALID) { - QMetaObject::invokeMethod(_hyperion, "compStateChangeRequest", Qt::QueuedConnection, Q_ARG(hyperion::Components, component), Q_ARG(bool, compState)); + QMetaObject::invokeMethod(_hyperion.get(), "compStateChangeRequest", Qt::QueuedConnection, Q_ARG(hyperion::Components, component), Q_ARG(bool, compState)); return true; } replyMsg = QString("Unknown component name: %1").arg(comp); @@ -227,12 +229,12 @@ bool API::setComponentState(const QString &comp, bool &compState, QString &reply void API::setLedMappingType(int type, hyperion::Components /*callerComp*/) { - QMetaObject::invokeMethod(_hyperion, "setLedMappingType", Qt::QueuedConnection, Q_ARG(int, type)); + QMetaObject::invokeMethod(_hyperion.get(), "setLedMappingType", Qt::QueuedConnection, Q_ARG(int, type)); } void API::setVideoMode(VideoMode mode, hyperion::Components /*callerComp*/) { - QMetaObject::invokeMethod(_hyperion, "setVideoMode", Qt::QueuedConnection, Q_ARG(VideoMode, mode)); + QMetaObject::invokeMethod(_hyperion.get(), "setVideoMode", Qt::QueuedConnection, Q_ARG(VideoMode, mode)); } #if defined(ENABLE_EFFECTENGINE) @@ -241,11 +243,11 @@ bool API::setEffect(const EffectCmdData &dat, hyperion::Components /*callerComp* int isStarted; if (!dat.args.isEmpty()) { - QMetaObject::invokeMethod(_hyperion, "setEffect", Qt::BlockingQueuedConnection, Q_RETURN_ARG(int, isStarted), Q_ARG(QString, dat.effectName), Q_ARG(QJsonObject, dat.args), Q_ARG(int, dat.priority), Q_ARG(int, dat.duration), Q_ARG(QString, dat.pythonScript), Q_ARG(QString, dat.origin), Q_ARG(QString, dat.data)); + QMetaObject::invokeMethod(_hyperion.get(), "setEffect", Qt::BlockingQueuedConnection, Q_RETURN_ARG(int, isStarted), Q_ARG(QString, dat.effectName), Q_ARG(QJsonObject, dat.args), Q_ARG(int, dat.priority), Q_ARG(int, dat.duration), Q_ARG(QString, dat.pythonScript), Q_ARG(QString, dat.origin), Q_ARG(QString, dat.data)); } else { - QMetaObject::invokeMethod(_hyperion, "setEffect", Qt::BlockingQueuedConnection, Q_RETURN_ARG(int, isStarted), Q_ARG(QString, dat.effectName), Q_ARG(int, dat.priority), Q_ARG(int, dat.duration), Q_ARG(QString, dat.origin)); + QMetaObject::invokeMethod(_hyperion.get(), "setEffect", Qt::BlockingQueuedConnection, Q_RETURN_ARG(int, isStarted), Q_ARG(QString, dat.effectName), Q_ARG(int, dat.priority), Q_ARG(int, dat.duration), Q_ARG(QString, dat.origin)); } return isStarted >= 0; @@ -254,12 +256,12 @@ bool API::setEffect(const EffectCmdData &dat, hyperion::Components /*callerComp* void API::setSourceAutoSelect(bool state, hyperion::Components /*callerComp*/) { - QMetaObject::invokeMethod(_hyperion, "setSourceAutoSelect", Qt::QueuedConnection, Q_ARG(bool, state)); + QMetaObject::invokeMethod(_hyperion.get(), "setSourceAutoSelect", Qt::QueuedConnection, Q_ARG(bool, state)); } void API::setVisiblePriority(int priority, hyperion::Components /*callerComp*/) { - QMetaObject::invokeMethod(_hyperion, "setVisiblePriority", Qt::QueuedConnection, Q_ARG(int, priority)); + QMetaObject::invokeMethod(_hyperion.get(), "setVisiblePriority", Qt::QueuedConnection, Q_ARG(int, priority)); } void API::registerInput(int priority, hyperion::Components component, const QString &origin, const QString &owner, hyperion::Components callerComp) @@ -271,7 +273,7 @@ void API::registerInput(int priority, hyperion::Components component, const QStr _activeRegisters.insert({priority, registerData{component, origin, owner, callerComp}}); - QMetaObject::invokeMethod(_hyperion, "registerInput", Qt::QueuedConnection, Q_ARG(int, priority), Q_ARG(hyperion::Components, component), Q_ARG(QString, origin), Q_ARG(QString, owner)); + QMetaObject::invokeMethod(_hyperion.get(), "registerInput", Qt::QueuedConnection, Q_ARG(int, priority), Q_ARG(hyperion::Components, component), Q_ARG(QString, origin), Q_ARG(QString, owner)); } void API::unregisterInput(int priority) @@ -289,23 +291,21 @@ bool API::setHyperionInstance(quint8 inst) return true; } - bool isRunning; - QMetaObject::invokeMethod(_instanceManager, "IsInstanceRunning", Qt::DirectConnection, Q_RETURN_ARG(bool, isRunning), Q_ARG(quint8, inst)); - if (!isRunning) + if (_hyperion.get() != nullptr) { - return false; + disconnect(_hyperion.get(), nullptr, this, nullptr); } - disconnect(_hyperion, nullptr, this, nullptr); - QMetaObject::invokeMethod(_instanceManager, "getHyperionInstance", Qt::DirectConnection, Q_RETURN_ARG(Hyperion *, _hyperion), Q_ARG(quint8, inst)); + QMetaObject::invokeMethod(_instanceManager, "getHyperionInstance", Qt::DirectConnection, Q_RETURN_ARG(QSharedPointer, _hyperion), Q_ARG(quint8, inst)); _currInstanceIndex = inst; + return true; } bool API::isHyperionEnabled() { int isEnabled; - QMetaObject::invokeMethod(_hyperion, "isComponentEnabled", Qt::BlockingQueuedConnection, Q_RETURN_ARG(int, isEnabled), Q_ARG(hyperion::Components, hyperion::COMP_ALL)); + QMetaObject::invokeMethod(_hyperion.get(), "isComponentEnabled", Qt::BlockingQueuedConnection, Q_RETURN_ARG(int, isEnabled), Q_ARG(hyperion::Components, hyperion::COMP_ALL)); return isEnabled > 0; } @@ -373,7 +373,7 @@ QString API::deleteEffect(const QString &name) if (_adminAuthorized) { QString res; - QMetaObject::invokeMethod(_hyperion, "deleteEffect", Qt::BlockingQueuedConnection, Q_RETURN_ARG(QString, res), Q_ARG(QString, name)); + QMetaObject::invokeMethod(_hyperion.get(), "deleteEffect", Qt::BlockingQueuedConnection, Q_RETURN_ARG(QString, res), Q_ARG(QString, name)); return res; } return NO_AUTHORIZATION; @@ -384,7 +384,7 @@ QString API::saveEffect(const QJsonObject &data) if (_adminAuthorized) { QString res; - QMetaObject::invokeMethod(_hyperion, "saveEffect", Qt::BlockingQueuedConnection, Q_RETURN_ARG(QString, res), Q_ARG(QJsonObject, data)); + QMetaObject::invokeMethod(_hyperion.get(), "saveEffect", Qt::BlockingQueuedConnection, Q_RETURN_ARG(QString, res), Q_ARG(QJsonObject, data)); return res; } return NO_AUTHORIZATION; diff --git a/libsrc/api/JSONRPC_schema/schema-config.json b/libsrc/api/JSONRPC_schema/schema-config.json index 50937242b..ceefac031 100644 --- a/libsrc/api/JSONRPC_schema/schema-config.json +++ b/libsrc/api/JSONRPC_schema/schema-config.json @@ -10,7 +10,7 @@ "subcommand": { "type" : "string", "required" : true, - "enum" : ["getconfig","getconfig-old","getschema","setconfig","restoreconfig","reload"] + "enum" : ["getconfig","getschema","setconfig","restoreconfig","reload"] }, "tan" : { "type" : "integer" diff --git a/libsrc/api/JsonAPI.cpp b/libsrc/api/JsonAPI.cpp index c26b9e36e..187051418 100644 --- a/libsrc/api/JsonAPI.cpp +++ b/libsrc/api/JsonAPI.cpp @@ -1,4 +1,5 @@ // project includes +#include "hyperion/SettingsManager.h" #include #include @@ -25,12 +26,14 @@ #include #include +#include #include #include #include #include #include #include +#include // ledmapping int <> string transform methods #include @@ -105,28 +108,31 @@ void JsonAPI::initialize() // listen for killed instances connect(_instanceManager, &HyperionIManager::instanceStateChanged, this, &JsonAPI::handleInstanceStateChange); - // notify hyperion about a jsonMessageForward - if (_hyperion != nullptr) - { - // Initialise jsonCB with current instance - _jsonCB->setSubscriptionsTo(_hyperion); - connect(this, &JsonAPI::forwardJsonMessage, _hyperion, &Hyperion::forwardJsonMessage); - } - //notify eventhadler on suspend/resume/idle requests connect(this, &JsonAPI::signalEvent, EventHandler::getInstance().data(), &EventHandler::handleEvent); + + _jsonCB->setSubscriptionsTo(_currInstanceIndex); + +#if defined(ENABLE_FORWARDER) + // notify the forwarder about a jsonMessageForward request + QObject::connect(this, &JsonAPI::forwardJsonMessage, GlobalSignals::getInstance(), &GlobalSignals::forwardJsonMessage, Qt::UniqueConnection); +#endif } -bool JsonAPI::handleInstanceSwitch(quint8 inst, bool /*forced*/) +bool JsonAPI::handleInstanceSwitch(quint8 instanceID, bool /*forced*/) { - if (API::setHyperionInstance(inst)) + if ( instanceID != _currInstanceIndex ) { - Debug(_log, "Client '%s' switch to Hyperion instance %d", QSTRING_CSTR(_peerAddress), inst); - // the JsonCB creates json messages you can subscribe to e.g. data change events - _jsonCB->setSubscriptionsTo(_hyperion); - return true; + if (API::setHyperionInstance(instanceID)) + { + Debug(_log, "Client '%s' switch to Hyperion instance %d", QSTRING_CSTR(_peerAddress), instanceID); + // the JsonCB creates json messages you can subscribe to e.g. data change events + _jsonCB->setSubscriptionsTo(instanceID); + return true; + } + return false; } - return false; + return true; } void JsonAPI::handleMessage(const QString &messageString, const QString &httpAuthHeader) @@ -135,12 +141,12 @@ void JsonAPI::handleMessage(const QString &messageString, const QString &httpAut QJsonObject message; //parse the message - QPair parsingResult = JsonUtils::parse(ident, messageString, message, _log); + QPair const parsingResult = JsonUtils::parse(ident, messageString, message, _log); if (!parsingResult.first) { //Try to find command and tan, even parsing failed - QString command = findCommand(messageString); - int tan = findTan(messageString); + QString const command = findCommand(messageString); + int const tan = findTan(messageString); sendErrorReply("Parse error", parsingResult.second, command, tan); return; @@ -203,7 +209,7 @@ void JsonAPI::handleMessage(const QString &messageString, const QString &httpAut return; } - QString cToken =httpAuthHeader.mid(bearTokenLenght).trimmed(); + QString const cToken =httpAuthHeader.mid(bearTokenLenght).trimmed(); API::isTokenAuthorized(cToken); // _authorized && _adminAuthorized are set } @@ -232,13 +238,14 @@ void JsonAPI::handleMessage(const QString &messageString, const QString &httpAut return; } - if (_hyperion == nullptr) - { - sendErrorReply("Service Unavailable", cmd); - return; - } + DebugIf(verbose, _log, "Request [%s, %s] - Type: %s - %s", + QSTRING_CSTR(Command::toString(cmd.command)), + QSTRING_CSTR(SubCommand::toString(cmd.subCommand)), + QSTRING_CSTR(InstanceCmd::toString(cmd.getInstanceCmdType())), + QSTRING_CSTR(InstanceCmd::toString(cmd.getInstanceMustRun())) + ); - if (!message.contains("instance") || cmd.isInstanceCmd == InstanceCmd::No) + if (cmd.getInstanceCmdType() == InstanceCmd::No) { handleCommand(cmd, message); } @@ -250,68 +257,94 @@ void JsonAPI::handleMessage(const QString &messageString, const QString &httpAut void JsonAPI::handleInstanceCommand(const JsonApiCommand& cmd, const QJsonObject &message) { - const QJsonValue instanceElement = message.value("instance"); QJsonArray instances; - if (instanceElement.isDouble()) - { - instances.append(instanceElement); - } else if (instanceElement.isArray()) + const QJsonValue instanceElement = message.value("instance"); + + // Extract instance(s) from the message + if (!(instanceElement.isUndefined() && instanceElement.isNull())) { - instances = instanceElement.toArray(); + if (instanceElement.isDouble()) + { + instances.append(instanceElement); + } else if (instanceElement.isArray()) + { + instances = instanceElement.toArray(); + } } - QList runningInstanceIdxs = _instanceManager->getRunningInstanceIdx(); - - QList instanceIdxList; + InstanceCmd::MustRun const isRunningInstanceRequired = cmd.getInstanceMustRun(); + QSet const runningInstanceIds = _instanceManager->getRunningInstanceIdx(); + QSet instanceIds; QStringList errorDetails; - if (instances.contains("all")) + + // Determine instance IDs, if not provided or "all" is given + if (instanceElement.isUndefined() || instanceElement.isNull() || instances.contains("all")) { - for (const auto& instanceIdx : runningInstanceIdxs) - { - instanceIdxList.append(instanceIdx); - } + instanceIds = (isRunningInstanceRequired == InstanceCmd::MustRun_Yes) ? runningInstanceIds : _instanceManager->getInstanceIds(); } else { - for (const auto &instance : std::as_const(instances)) { + //Resolve instances provided and test, if they need to be running + for (const auto &instance : std::as_const(instances)) + { + if (!instance.isDouble()) + { + errorDetails.append("Not a valid instance: " + instance.toVariant().toString()); + continue; + } + + quint8 const instanceId = static_cast(instance.toInt()); - quint8 instanceIdx = static_cast(instance.toInt()); - if (instance.isDouble() && runningInstanceIdxs.contains(instanceIdx)) + if (isRunningInstanceRequired == InstanceCmd::MustRun_Yes && !runningInstanceIds.contains(instanceId)) { - instanceIdxList.append(instanceIdx); + errorDetails.append(QString("Instance [%1] is not running, but the (sub-) command requires a running instance.").arg(instance.toVariant().toString())); } else { - errorDetails.append("Not a running or valid instance: " + instance.toVariant().toString()); + instanceIds.insert(instanceId); } } } - if (instanceIdxList.isEmpty() || !errorDetails.isEmpty() ) - { - sendErrorReply("Invalid instance(s) given", errorDetails, cmd); - return; - } - - quint8 currentInstanceIdx = getCurrentInstanceIndex(); - if (instanceIdxList.size() > 1) + // Handle cases where no valid instances are found + if (instanceIds.isEmpty()) { - if (cmd.isInstanceCmd != InstanceCmd::Multi) + if (errorDetails.isEmpty() && (cmd.getInstanceCmdType() == InstanceCmd::No_or_Single || cmd.getInstanceCmdType() == InstanceCmd::No_or_Multi) ) { - sendErrorReply("Command does not support multiple instances", cmd); + handleCommand(cmd, message); return; } + errorDetails.append("No instance(s) provided, but required"); + } + + // Check if multiple instances are allowed + if (instanceIds.size() > 1 && cmd.getInstanceCmdType() != InstanceCmd::Multi) + { + errorDetails.append("Command does not support multiple instances"); } - for (const auto &instanceIdx : instanceIdxList) + // If there are errors, send a response and exit + if ( !errorDetails.isEmpty() ) { - if (setHyperionInstance(instanceIdx)) + sendErrorReply("Errors for instance(s) given", errorDetails, cmd); + return; + } + + // Execute the command for each valid instance + for (const auto &instanceId : std::as_const(instanceIds)) + { + if (isRunningInstanceRequired == InstanceCmd::MustRun_Yes || _currInstanceIndex == GLOABL_INSTANCE_ID) + { + if (handleInstanceSwitch(instanceId)) + { + handleCommand(cmd, message); + } + } + else { handleCommand(cmd, message); } } - - setHyperionInstance(currentInstanceIdx); } void JsonAPI::handleCommand(const JsonApiCommand& cmd, const QJsonObject &message) @@ -326,7 +359,6 @@ void JsonAPI::handleCommand(const JsonApiCommand& cmd, const QJsonObject &messag case Command::Image: handleImageCommand(message, cmd); break; -#if defined(ENABLE_EFFECTENGINE) case Command::Effect: handleEffectCommand(message, cmd); break; @@ -336,7 +368,6 @@ void JsonAPI::handleCommand(const JsonApiCommand& cmd, const QJsonObject &messag case Command::DeleteEffect: handleDeleteEffectCommand(message, cmd); break; -#endif case Command::SysInfo: handleSysInfoCommand(message, cmd); break; @@ -405,8 +436,14 @@ void JsonAPI::handleCommand(const JsonApiCommand& cmd, const QJsonObject &messag void JsonAPI::handleGetImageSnapshotCommand(const QJsonObject &message, const JsonApiCommand &cmd) { + if (_hyperion.isNull()) + { + sendErrorReply("Failed to create snapshot. No instance provided.", cmd); + return; + } + QString replyMsg; - QString imageFormat = message["format"].toString("PNG"); + QString const imageFormat = message["format"].toString("PNG"); const PriorityMuxer::InputInfo priorityInfo = _hyperion->getPriorityInfo(_hyperion->getCurrentPriority()); Image image = priorityInfo.image; QImage snapshot(reinterpret_cast(image.memptr()), image.width(), image.height(), qsizetype(3) * image.width(), QImage::Format_RGB888); @@ -420,7 +457,7 @@ void JsonAPI::handleGetImageSnapshotCommand(const QJsonObject &message, const Js sendErrorReply(replyMsg, cmd); return; } - QByteArray base64Image = byteArray.toBase64(); + QByteArray const base64Image = byteArray.toBase64(); QJsonObject info; info["format"] = imageFormat; @@ -432,6 +469,12 @@ void JsonAPI::handleGetImageSnapshotCommand(const QJsonObject &message, const Js void JsonAPI::handleGetLedSnapshotCommand(const QJsonObject& /*message*/, const JsonApiCommand &cmd) { + if (_hyperion.isNull()) + { + sendErrorReply("Failed to create snapshot. No instance not.", cmd); + return; + } + std::vector ledColors; QEventLoop loop; QTimer timer; @@ -445,10 +488,10 @@ void JsonAPI::handleGetLedSnapshotCommand(const QJsonObject& /*message*/, const // Capture LED colors when the LED data signal is emitted (execute only once) std::unique_ptr context{new QObject}; QObject* pcontext = context.get(); - connect(_hyperion, &Hyperion::ledDeviceData, pcontext, + QObject::connect(_hyperion.get(), &Hyperion::ledDeviceData, pcontext, [this, &loop, context = std::move(context), &ledColors, cmd](std::vector ledColorsUpdate) mutable { ledColors = ledColorsUpdate; - loop.quit(); // ✅ Ensure the event loop quits immediately when data is received + loop.quit(); // Ensure the event loop quits immediately when data is received QJsonArray ledRgbColorsArray; for (const auto &color : ledColors) @@ -474,7 +517,7 @@ void JsonAPI::handleGetLedSnapshotCommand(const QJsonObject& /*message*/, const // If no data was received, return an error if (ledColors.empty()) { - QString replyMsg = QString("No LED color data available, i.e.no LED update was done within the last %1 ms").arg(LED_DATA_TIMEOUT.count()); + QString const replyMsg = QString("No LED color data available, i.e.no LED update was done within the last %1 ms").arg(LED_DATA_TIMEOUT.count()); sendErrorReply(replyMsg, cmd); return; } @@ -498,9 +541,9 @@ void JsonAPI::handleInstanceDataCommand(const QJsonObject &message, const JsonAp void JsonAPI::handleColorCommand(const QJsonObject &message, const JsonApiCommand& cmd) { - emit forwardJsonMessage(message); - int priority = message["priority"].toInt(); - int duration = message["duration"].toInt(-1); + emit forwardJsonMessage(message, _currInstanceIndex); + int const priority = message["priority"].toInt(); + int const duration = message["duration"].toInt(-1); const QString origin = message["origin"].toString("JsonRpc") + "@" + _peerAddress; const QJsonArray &jsonColor = message["color"].toArray(); @@ -516,7 +559,7 @@ void JsonAPI::handleColorCommand(const QJsonObject &message, const JsonApiComman void JsonAPI::handleImageCommand(const QJsonObject &message, const JsonApiCommand& cmd) { - emit forwardJsonMessage(message); + emit forwardJsonMessage(message, _currInstanceIndex); API::ImageCmdData idata; idata.priority = message["priority"].toInt(); @@ -537,10 +580,12 @@ void JsonAPI::handleImageCommand(const QJsonObject &message, const JsonApiComman } } -#if defined(ENABLE_EFFECTENGINE) void JsonAPI::handleEffectCommand(const QJsonObject &message, const JsonApiCommand& cmd) { - emit forwardJsonMessage(message); +#if !defined(ENABLE_EFFECTENGINE) + sendErrorReply("Effects are not supported by this installation!", cmd); +#else + emit forwardJsonMessage(message, _currInstanceIndex); EffectCmdData dat; dat.priority = message["priority"].toInt(); @@ -556,24 +601,32 @@ void JsonAPI::handleEffectCommand(const QJsonObject &message, const JsonApiComma } else { sendErrorReply("Effect '" + dat.effectName + "' not found", cmd); } +#endif } void JsonAPI::handleCreateEffectCommand(const QJsonObject &message, const JsonApiCommand& cmd) { - const QString resultMsg = API::saveEffect(message); +#if !defined(ENABLE_EFFECTENGINE) + sendErrorReply("Effects are not supported by this installation!", cmd); +#else + const QString resultMsg = EffectFileHandler::getInstance()->saveEffect(message); resultMsg.isEmpty() ? sendSuccessReply(cmd) : sendErrorReply(resultMsg, cmd); +#endif } void JsonAPI::handleDeleteEffectCommand(const QJsonObject &message, const JsonApiCommand& cmd) { - const QString res = API::deleteEffect(message["name"].toString()); - res.isEmpty() ? sendSuccessReply(cmd) : sendErrorReply(res, cmd); -} +#if !defined(ENABLE_EFFECTENGINE) + sendErrorReply("Effects are not supported by this installation!", cmd); +#else + const QString resultMsg = EffectFileHandler::getInstance()->deleteEffect(message["name"].toString()); + resultMsg.isEmpty() ? sendSuccessReply(cmd) : sendErrorReply(resultMsg, cmd); #endif +} void JsonAPI::handleSysInfoCommand(const QJsonObject & /*unused*/, const JsonApiCommand& cmd) { - sendSuccessDataReply(JsonInfo::getSystemInfo(_hyperion), cmd); + sendSuccessDataReply(JsonInfo::getSystemInfo(), cmd); } void JsonAPI::handleServerInfoCommand(const QJsonObject &message, const JsonApiCommand& cmd) @@ -584,33 +637,13 @@ void JsonAPI::handleServerInfoCommand(const QJsonObject &message, const JsonApiC switch (cmd.getSubCommand()) { case SubCommand::Empty: case SubCommand::GetInfo: - info["priorities"] = JsonInfo::getPrioritiestInfo(_hyperion); - info["priorities_autoselect"] = _hyperion->sourceAutoSelectEnabled(); - info["adjustment"] = JsonInfo::getAdjustmentInfo(_hyperion, _log); - info["ledDevices"] = JsonInfo::getAvailableLedDevices(); - info["grabbers"] = JsonInfo::getGrabbers(_hyperion); - info["videomode"] = QString(videoMode2String(_hyperion->getCurrentVideoMode())); - info["cec"] = JsonInfo::getCecInfo(); - info["services"] = JsonInfo::getServices(); - info["components"] = JsonInfo::getComponents(_hyperion); - info["imageToLedMappingType"] = ImageProcessor::mappingTypeToStr(_hyperion->getLedMappingType()); - info["instance"] = JsonInfo::getInstanceInfo(); - info["leds"] = _hyperion->getSetting(settings::LEDS).array(); - info["activeLedColor"] = JsonInfo::getActiveColors(_hyperion); - -#if defined(ENABLE_EFFECTENGINE) - info["effects"] = JsonInfo::getEffects(_hyperion); - info["activeEffects"] = JsonInfo::getActiveEffects(_hyperion); -#endif - - // BEGIN | The following entries are deprecated but used to ensure backward compatibility with hyperion Classic or up to Hyperion 2.0.16 - info["hostname"] = QHostInfo::localHostName(); - info["transform"] = JsonInfo::getTransformationInfo(_hyperion); + // Global information + info = JsonInfo::getInfo(_hyperion.get(),_log); if (!_noListener && message.contains("subscribe")) { const QJsonArray &subscriptions = message["subscribe"].toArray(); - QStringList invaliCommands = _jsonCB->subscribe(subscriptions); + QStringList const invaliCommands = _jsonCB->subscribe(subscriptions); if (!invaliCommands.isEmpty()) { errorDetails.append("subscribe - Invalid commands provided: " + invaliCommands.join(',')); @@ -664,8 +697,8 @@ void JsonAPI::handleServerInfoCommand(const QJsonObject &message, const JsonApiC void JsonAPI::handleClearCommand(const QJsonObject &message, const JsonApiCommand& cmd) { - emit forwardJsonMessage(message); - int priority = message["priority"].toInt(); + emit forwardJsonMessage(message, _currInstanceIndex); + int const priority = message["priority"].toInt(); QString replyMsg; if (!API::clearPriority(priority, replyMsg)) @@ -678,7 +711,7 @@ void JsonAPI::handleClearCommand(const QJsonObject &message, const JsonApiComman void JsonAPI::handleClearallCommand(const QJsonObject &message, const JsonApiCommand& cmd) { - emit forwardJsonMessage(message); + emit forwardJsonMessage(message, _currInstanceIndex); QString replyMsg; API::clearPriority(-1, replyMsg); sendSuccessReply(cmd); @@ -724,8 +757,8 @@ void JsonAPI::applyColorAdjustment(const QString &colorName, const QJsonObject & const QJsonArray &values = adjustment[colorName].toArray(); if (values.size() >= 3) { rgbAdjustment.setAdjustment(static_cast(values[0U].toInt()), - static_cast(values[1U].toInt()), - static_cast(values[2U].toInt())); + static_cast(values[1U].toInt()), + static_cast(values[2U].toInt())); } } } @@ -810,14 +843,10 @@ void JsonAPI::handleConfigCommand(const QJsonObject& message, const JsonApiComma handleSchemaGetCommand(message, cmd); break; - case SubCommand::GetConfig: + case SubCommand::GetConfig: handleConfigGetCommand(message, cmd); break; - case SubCommand::GetConfigOld: - sendSuccessDataReply(_hyperion->getQJsonConfig(), cmd); - break; - case SubCommand::SetConfig: handleConfigSetCommand(message, cmd); break; @@ -859,14 +888,14 @@ void JsonAPI::handleConfigSetCommand(const QJsonObject &message, const JsonApiCo const QJsonArray instances = config["instances"].toArray(); if (!instances.isEmpty()) { - QList configuredInstanceIds = _instanceManager->getInstanceIds(); + QSet const configuredInstanceIds = _instanceManager->getInstanceIds(); for (const auto &instance : instances) { QJsonObject instanceObject = instance.toObject(); const QJsonValue idx = instanceObject["id"]; if (idx.isDouble()) { - quint8 instanceId = static_cast(idx.toInt()); + quint8 const instanceId = static_cast(idx.toInt()); if (configuredInstanceIds.contains(instanceId)) { instancesNewConfigs.insert(instanceId,instanceObject.value("settings").toObject()); @@ -882,18 +911,29 @@ void JsonAPI::handleConfigSetCommand(const QJsonObject &message, const JsonApiCo const QJsonObject globalSettings = config["global"].toObject().value("settings").toObject(); if (!globalSettings.isEmpty()) { - const QJsonObject instanceZeroConfig = instancesNewConfigs.value(0); - instancesNewConfigs.insert(0, JsonUtils::mergeJsonObjects(instanceZeroConfig, globalSettings)); + const QJsonObject instanceZeroConfig = instancesNewConfigs.value(GLOABL_INSTANCE_ID); + instancesNewConfigs.insert(GLOABL_INSTANCE_ID, JsonUtils::mergeJsonObjects(instanceZeroConfig, globalSettings)); } - QMapIterator i (instancesNewConfigs); - while (i.hasNext()) { - i.next(); + QMapIterator iter (instancesNewConfigs); + while (iter.hasNext()) { + iter.next(); + + quint8 const idx = iter.key(); - quint8 idx = i.key(); - Hyperion* instance = HyperionIManager::getInstance()->getHyperionInstance(idx); + QPair isSaved; + if ( HyperionIManager::getInstance()->isInstanceRunning(idx) ) + { + QSharedPointer const instance = HyperionIManager::getInstance()->getHyperionInstance(idx); + isSaved = instance->saveSettings(iter.value()); + } + else + { + SettingsManager settingMgr (idx); + connect(&settingMgr, &SettingsManager::settingsChanged, HyperionIManager::getInstance(),&HyperionIManager::settingsChanged); + isSaved = settingMgr.saveSettings(iter.value()); + } - QPair isSaved = instance->saveSettings(i.value()); errorDetails.append(isSaved.second); } @@ -933,11 +973,11 @@ void JsonAPI::handleConfigGetCommand(const QJsonObject &message, const JsonApiCo const QJsonObject instances = filter["instances"].toObject(); if (!instances.isEmpty()) { - QList configuredInstanceIds = _instanceManager->getInstanceIds(); + QSet const configuredInstanceIds = _instanceManager->getInstanceIds(); const QJsonArray instanceIds = instances["ids"].toArray(); for (const auto &idx : instanceIds) { if (idx.isDouble()) { - quint8 instanceId = static_cast(idx.toInt()); + quint8 const instanceId = static_cast(idx.toInt()); if (configuredInstanceIds.contains(instanceId)) { instanceListFilter.append(instanceId); @@ -978,25 +1018,19 @@ void JsonAPI::handleConfigGetCommand(const QJsonObject &message, const JsonApiCo void JsonAPI::handleConfigRestoreCommand(const QJsonObject &message, const JsonApiCommand& cmd) { QJsonObject config = message["config"].toObject(); - if (API::isHyperionEnabled()) + + DBConfigManager configManager; + QPair const result = configManager.updateConfiguration(config, false); + if (result.first) { - DBConfigManager configManager; - QPair result = configManager.updateConfiguration(config, false); - if (result.first) - { - QString infoMsg {"Restarting after importing configuration successfully."}; - sendSuccessDataReply(infoMsg, cmd); - Info(_log, "%s", QSTRING_CSTR(infoMsg)); - emit signalEvent(Event::Restart); - } - else - { - sendErrorReply("Restore configuration failed", result.second, cmd); - } + QString const infoMsg {"Restarting after importing configuration successfully."}; + sendSuccessDataReply(infoMsg, cmd); + Info(_log, "%s", QSTRING_CSTR(infoMsg)); + emit signalEvent(Event::Restart); } else { - sendErrorReply("Restoring configuration while Hyperion is disabled is not possible", cmd); + sendErrorReply("Restore configuration failed", result.second, cmd); } } @@ -1011,7 +1045,7 @@ void JsonAPI::handleSchemaGetCommand(const QJsonObject& /*message*/, const JsonA Q_INIT_RESOURCE(resource); // read the hyperion json schema from the resource - QString schemaFile = SETTINGS_UI_SCHEMA_FILE; + QString const schemaFile = SETTINGS_UI_SCHEMA_FILE; try { @@ -1031,7 +1065,7 @@ void JsonAPI::handleSchemaGetCommand(const QJsonObject& /*message*/, const JsonA QJsonObject settingTypes; QJsonArray globalSettingTypes; - SettingsTable settingsTable; + SettingsTable const settingsTable; for (const QString &type : settingsTable.getGlobalSettingTypes()) { globalSettingTypes.append(type); @@ -1046,28 +1080,7 @@ void JsonAPI::handleSchemaGetCommand(const QJsonObject& /*message*/, const JsonA settingTypes.insert("instanceProperties", instanceSettingTypes); properties.insert("propertiesTypes", settingTypes); -#if defined(ENABLE_EFFECTENGINE) - // collect all available effect schemas - QJsonArray schemaList; - const std::list& effectsSchemas = _hyperion->getEffectSchemas(); - for (const EffectSchema& effectSchema : effectsSchemas) - { - QJsonObject schema; - schema.insert("script", effectSchema.pyFile); - schema.insert("schemaLocation", effectSchema.schemaFile); - schema.insert("schemaContent", effectSchema.pySchema); - if (effectSchema.pyFile.startsWith(':')) - { - schema.insert("type", "system"); - } - else - { - schema.insert("type", "custom"); - } - schemaList.append(schema); - } - properties.insert("effectSchemas", schemaList); -#endif + properties.insert("effectSchemas", JsonInfo::getEffectSchemas()); schemaJson.insert("properties", properties); @@ -1078,7 +1091,7 @@ void JsonAPI::handleSchemaGetCommand(const QJsonObject& /*message*/, const JsonA void JsonAPI::handleComponentStateCommand(const QJsonObject &message, const JsonApiCommand& cmd) { const QJsonObject &componentState = message["componentstate"].toObject(); - QString comp = componentState["component"].toString("invalid"); + QString const comp = componentState["component"].toString("invalid"); bool compState = componentState["state"].toBool(true); QString replyMsg; @@ -1094,8 +1107,11 @@ void JsonAPI::handleLedColorsCommand(const QJsonObject& /*message*/, const JsonA switch (cmd.subCommand) { case SubCommand::LedStreamStart: _jsonCB->subscribe( Subscription::LedColorsUpdate); - // push once - _hyperion->update(); + if (!_hyperion.isNull()) + { + // push once + _hyperion->update(); + } sendSuccessReply(cmd); break; @@ -1198,20 +1214,20 @@ void JsonAPI::handleAuthorizeCommand(const QJsonObject &message, const JsonApiCo void JsonAPI::handleTokenRequired(const JsonApiCommand& cmd) { bool isTokenRequired = !islocalConnection() || _authManager->isLocalAuthRequired(); - QJsonObject response { { "required", isTokenRequired} }; + QJsonObject const response { { "required", isTokenRequired} }; sendSuccessDataReply(response, cmd); } void JsonAPI::handleAdminRequired(const JsonApiCommand& cmd) { bool isAdminAuthRequired = true; - QJsonObject response { { "adminRequired", isAdminAuthRequired} }; + QJsonObject const response { { "adminRequired", isAdminAuthRequired} }; sendSuccessDataReply(response, cmd); } void JsonAPI::handleNewPasswordRequired(const JsonApiCommand& cmd) { - QJsonObject response { { "newPasswordRequired", API::hasHyperionDefaultPw() } }; + QJsonObject const response { { "newPasswordRequired", API::hasHyperionDefaultPw() } }; sendSuccessDataReply(response, cmd); } @@ -1369,7 +1385,7 @@ void JsonAPI::handleLogin(const QJsonObject &message, const JsonApiCommand& cmd) if (API::isUserAuthorized(password) && API::getUserToken(userTokenRep)) { // Return the current valid Hyperion user token - QJsonObject response { { "token", userTokenRep } }; + QJsonObject const response { { "token", userTokenRep } }; sendSuccessDataReply(response, cmd); } else @@ -1411,43 +1427,62 @@ void JsonAPI::handleTokenResponse(bool success, const QString &token, const QStr void JsonAPI::handleInstanceCommand(const QJsonObject &message, const JsonApiCommand& cmd) { QString replyMsg; + QStringList errorDetails; - const quint8 inst = static_cast(message["instance"].toInt()); + const quint8 instanceID = static_cast(message["instance"].toInt()); + const QString instanceName = _instanceManager->getInstanceName(instanceID); const QString &name = message["name"].toString(); + if(cmd.subCommand != SubCommand::CreateInstance && !_instanceManager->doesInstanceExist(instanceID)) + { + sendErrorReply( QString("Hyperion instance [%1] does not exist.").arg(instanceID), cmd); + return; + } switch (cmd.subCommand) { case SubCommand::SwitchTo: - if (handleInstanceSwitch(inst)) + if (handleInstanceSwitch(instanceID)) { - QJsonObject response { { "instance", inst } }; + QJsonObject const response { { "instance", instanceID } }; sendSuccessDataReply(response, cmd); } else { - sendErrorReply("Selected Hyperion instance is not running", cmd); + sendErrorReply(QString("Switching to Hyperion instance [%1] - %2 failed.").arg(instanceID).arg(instanceName), cmd); } break; case SubCommand::StartInstance: + if (_instanceManager->isInstanceRunning(instanceID)) + { + errorDetails.append(QString("Hyperion instance [%1] - '%2' is already running.").arg(instanceID).arg(instanceName)); + sendSuccessDataReplyWithError({}, cmd, errorDetails); + return; + } //Only send update once weakConnect(this, &API::onStartInstanceResponse, [this, cmd] () { sendSuccessReply(cmd); }); - if (!API::startInstance(inst, cmd.tan)) + if (!API::startInstance(instanceID, cmd.tan)) { - sendErrorReply("Cannot start Hyperion instance index " + QString::number(inst), cmd); + sendErrorReply(QString("Starting Hyperion instance [%1] - '%2' failed.").arg(instanceID).arg(instanceName), cmd); } break; case SubCommand::StopInstance: + if (!_instanceManager->isInstanceRunning(instanceID)) + { + errorDetails.append(QString("Hyperion instance [%1] - '%2' is not running.").arg(instanceID).arg(instanceName)); + sendSuccessDataReplyWithError({},cmd, errorDetails); + return; + } // silent fail - API::stopInstance(inst); + API::stopInstance(instanceID); sendSuccessReply(cmd); break; case SubCommand::DeleteInstance: - if (API::deleteInstance(inst, replyMsg)) + if (API::deleteInstance(instanceID, replyMsg)) { sendSuccessReply(cmd); } @@ -1468,7 +1503,7 @@ void JsonAPI::handleInstanceCommand(const QJsonObject &message, const JsonApiCom if (cmd.subCommand == SubCommand::CreateInstance) { replyMsg = API::createInstance(name); } else { - replyMsg = API::setInstanceName(inst, name); + replyMsg = API::setInstanceName(instanceID, name); } if (replyMsg.isEmpty()) { @@ -1492,8 +1527,8 @@ void JsonAPI::handleLedDeviceCommand(const QJsonObject &message, const JsonApiCo return; } - QJsonObject config { { "type", devType } }; - LedDevice* ledDevice = LedDeviceFactory::construct(config); + QJsonObject const config { { "type", devType } }; + QScopedPointer const ledDevice(LedDeviceFactory::construct(config)); switch (cmd.subCommand) { case SubCommand::Discover: @@ -1511,8 +1546,6 @@ void JsonAPI::handleLedDeviceCommand(const QJsonObject &message, const JsonApiCo default: break; } - - delete ledDevice; } void JsonAPI::handleLedDeviceDiscover(LedDevice& ledDevice, const QJsonObject& message, const JsonApiCommand& cmd) @@ -1557,7 +1590,7 @@ void JsonAPI::handleInputSourceCommand(const QJsonObject& message, const JsonApi if (cmd.subCommand == SubCommand::Discover) { const QJsonObject& params = message["params"].toObject(); - QJsonObject inputSourcesDiscovered = JsonInfo().discoverSources(sourceType, params); + QJsonObject const inputSourcesDiscovered = JsonInfo().discoverSources(sourceType, params); DebugIf(verbose, _log, "response: [%s]", QJsonDocument(inputSourcesDiscovered).toJson(QJsonDocument::Compact).constData()); @@ -1572,7 +1605,7 @@ void JsonAPI::handleServiceCommand(const QJsonObject &message, const JsonApiComm QByteArray serviceType; const QString type = message["serviceType"].toString().trimmed(); #ifdef ENABLE_MDNS - QString discoveryMethod("mDNS"); + QString const discoveryMethod("mDNS"); serviceType = MdnsServiceRegister::getServiceType(type); #else QString discoveryMethod("ssdp"); @@ -1581,10 +1614,10 @@ void JsonAPI::handleServiceCommand(const QJsonObject &message, const JsonApiComm { QJsonArray serviceList; #ifdef ENABLE_MDNS - QMetaObject::invokeMethod(MdnsBrowser::getInstance().data(), "browseForServiceType", + QMetaObject::invokeMethod(MdnsBrowser::getInstance().get(), "browseForServiceType", Qt::QueuedConnection, Q_ARG(QByteArray, serviceType)); - serviceList = MdnsBrowser::getInstance().data()->getServicesDiscoveredJson(serviceType, MdnsServiceRegister::getServiceNameFilter(type), DEFAULT_DISCOVER_TIMEOUT); + serviceList = MdnsBrowser::getInstance()->getServicesDiscoveredJson(serviceType, MdnsServiceRegister::getServiceNameFilter(type), DEFAULT_DISCOVER_TIMEOUT); #endif QJsonObject servicesDiscovered; QJsonObject servicesOfType; @@ -1630,48 +1663,52 @@ void JsonAPI::handleSystemCommand(const QJsonObject& /*message*/, const JsonApiC sendSuccessReply(cmd); } -QJsonObject JsonAPI::getBasicCommandReply(bool success, const QString &command, int tan, InstanceCmd::Type isInstanceCmd) const +QJsonObject JsonAPI::getBasicCommandReply(bool success, const QString &command, int tan, InstanceCmd::Type instanceCmdType) const { QJsonObject reply; reply["success"] = success; reply["command"] = command; reply["tan"] = tan; - if (isInstanceCmd == InstanceCmd::Yes || ( isInstanceCmd == InstanceCmd::Multi && !_noListener)) + if ((_currInstanceIndex != GLOABL_INSTANCE_ID) && instanceCmdType != InstanceCmd::No) { - reply["instance"] = _hyperion->getInstanceIndex(); + reply["instance"] = _currInstanceIndex; } return reply; } void JsonAPI::sendSuccessReply(const JsonApiCommand& cmd) { - sendSuccessReply(cmd.toString(), cmd.tan, cmd.isInstanceCmd); + sendSuccessReply(cmd.toString(), cmd.tan, cmd.instanceCmdType); } -void JsonAPI::sendSuccessReply(const QString &command, int tan, InstanceCmd::Type isInstanceCmd) +void JsonAPI::sendSuccessReply(const QString &command, int tan, InstanceCmd::Type instanceCmdType) { - emit callbackReady(getBasicCommandReply(true, command, tan , isInstanceCmd)); + QJsonObject const reply {getBasicCommandReply(true, command, tan , instanceCmdType)}; + + DebugIf(verbose, _log, "%s", QSTRING_CSTR(JsonUtils::jsonValueToQString(reply))); + + emit callbackReady(reply); } void JsonAPI::sendSuccessDataReply(const QJsonValue &infoData, const JsonApiCommand& cmd) { - sendSuccessDataReplyWithError(infoData, cmd.toString(), cmd.tan, {}, cmd.isInstanceCmd); + sendSuccessDataReplyWithError(infoData, cmd.toString(), cmd.tan, {}, cmd.instanceCmdType); } -void JsonAPI::sendSuccessDataReply(const QJsonValue &infoData, const QString &command, int tan, InstanceCmd::Type isInstanceCmd) +void JsonAPI::sendSuccessDataReply(const QJsonValue &infoData, const QString &command, int tan, InstanceCmd::Type instanceCmdType) { - sendSuccessDataReplyWithError(infoData, command, tan, {}, isInstanceCmd); + sendSuccessDataReplyWithError(infoData, command, tan, {}, instanceCmdType); } void JsonAPI::sendSuccessDataReplyWithError(const QJsonValue &infoData, const JsonApiCommand& cmd, const QStringList& errorDetails) { - sendSuccessDataReplyWithError(infoData, cmd.toString(), cmd.tan, errorDetails, cmd.isInstanceCmd); + sendSuccessDataReplyWithError(infoData, cmd.toString(), cmd.tan, errorDetails, cmd.instanceCmdType); } -void JsonAPI::sendSuccessDataReplyWithError(const QJsonValue &infoData, const QString &command, int tan, const QStringList& errorDetails, InstanceCmd::Type isInstanceCmd) +void JsonAPI::sendSuccessDataReplyWithError(const QJsonValue &infoData, const QString &command, int tan, const QStringList& errorDetails, InstanceCmd::Type instanceCmdType) { - QJsonObject reply {getBasicCommandReply(true, command, tan , isInstanceCmd)}; + QJsonObject reply {getBasicCommandReply(true, command, tan , instanceCmdType)}; reply["info"] = infoData; if (!errorDetails.isEmpty()) @@ -1686,22 +1723,24 @@ void JsonAPI::sendSuccessDataReplyWithError(const QJsonValue &infoData, const QS reply["errorData"] = errorsArray; } + DebugIf(verbose, _log, "%s", QSTRING_CSTR(JsonUtils::jsonValueToQString(reply))); + emit callbackReady(reply); } void JsonAPI::sendErrorReply(const QString &error, const JsonApiCommand& cmd) { - sendErrorReply(error, {}, cmd.toString(), cmd.tan, cmd.isInstanceCmd); + sendErrorReply(error, {}, cmd.toString(), cmd.tan, cmd.instanceCmdType); } void JsonAPI::sendErrorReply(const QString &error, const QStringList& errorDetails, const JsonApiCommand& cmd) { - sendErrorReply(error, errorDetails, cmd.toString(), cmd.tan, cmd.isInstanceCmd); + sendErrorReply(error, errorDetails, cmd.toString(), cmd.tan, cmd.instanceCmdType); } -void JsonAPI::sendErrorReply(const QString &error, const QStringList& errorDetails, const QString &command, int tan, InstanceCmd::Type isInstanceCmd) +void JsonAPI::sendErrorReply(const QString &error, const QStringList& errorDetails, const QString &command, int tan, InstanceCmd::Type instanceCmdType) { - QJsonObject reply {getBasicCommandReply(false, command, tan , isInstanceCmd)}; + QJsonObject reply {getBasicCommandReply(false, command, tan , instanceCmdType)}; reply["error"] = error; if (!errorDetails.isEmpty()) { @@ -1715,20 +1754,22 @@ void JsonAPI::sendErrorReply(const QString &error, const QStringList& errorDetai reply["errorData"] = errorsArray; } + DebugIf(verbose, _log, "%s", QSTRING_CSTR(JsonUtils::jsonValueToQString(reply))); + emit callbackReady(reply); } void JsonAPI::sendNewRequest(const QJsonValue &infoData, const JsonApiCommand& cmd) { - sendSuccessDataReplyWithError(infoData, cmd.toString(), cmd.isInstanceCmd); + sendSuccessDataReplyWithError(infoData, cmd.toString(), cmd.instanceCmdType); } -void JsonAPI::sendNewRequest(const QJsonValue &infoData, const QString &command, InstanceCmd::Type isInstanceCmd) +void JsonAPI::sendNewRequest(const QJsonValue &infoData, const QString &command, InstanceCmd::Type instanceCmdType) { QJsonObject request; request["command"] = command; - if (isInstanceCmd != InstanceCmd::No) + if (instanceCmdType != InstanceCmd::No) { request["instance"] = _hyperion->getInstanceIndex(); } @@ -1743,18 +1784,30 @@ void JsonAPI::sendNoAuthorization(const JsonApiCommand& cmd) sendErrorReply(NO_AUTHORIZATION, cmd); } -void JsonAPI::handleInstanceStateChange(InstanceState state, quint8 instance, const QString& /*name */) +void JsonAPI::handleInstanceStateChange(InstanceState state, quint8 instanceID, const QString& /*name */) { switch (state) { case InstanceState::H_ON_STOP: - if (_hyperion->getInstanceIndex() == instance) + { + if (!_hyperion.isNull() && _hyperion->getInstanceIndex() == instanceID) { - handleInstanceSwitch(); + _hyperion.reset(nullptr); + _jsonCB->setSubscriptionsTo(GLOABL_INSTANCE_ID); } + } break; + case InstanceState::H_STARTING: case InstanceState::H_STARTED: + { + quint8 const currentInstance = _currInstanceIndex; + if (instanceID == currentInstance) + { + _hyperion = _instanceManager->getHyperionInstance(instanceID); + _jsonCB->setSubscriptionsTo(instanceID); + } + } case InstanceState::H_STOPPED: case InstanceState::H_CREATED: case InstanceState::H_DELETED: diff --git a/libsrc/api/JsonCallbacks.cpp b/libsrc/api/JsonCallbacks.cpp index 44369cac1..1edd86a3a 100644 --- a/libsrc/api/JsonCallbacks.cpp +++ b/libsrc/api/JsonCallbacks.cpp @@ -9,6 +9,8 @@ #include #include #include +#include +#include #include #include @@ -31,36 +33,25 @@ JsonCallbacks::JsonCallbacks(Logger *log, const QString& peerAddress, QObject* p bool JsonCallbacks::subscribe(const Subscription::Type cmd) { + if (_subscribedCommands.contains(cmd)) + { + return true; + } + switch (cmd) { - case Subscription::AdjustmentUpdate: - connect(_hyperion, &Hyperion::adjustmentChanged, this, &JsonCallbacks::handleAdjustmentChange); - break; - case Subscription::ComponentsUpdate: - connect(_componentRegister, &ComponentRegister::updatedComponentState, this, &JsonCallbacks::handleComponentState); - break; + + // Global subscriptions #if defined(ENABLE_EFFECTENGINE) case Subscription::EffectsUpdate: - connect(_hyperion, &Hyperion::effectListUpdated, this, &JsonCallbacks::handleEffectListChange); + connect(EffectFileHandler::getInstance(), &EffectFileHandler::effectListChanged, this, &JsonCallbacks::handleEffectListChange); break; #endif case Subscription::EventUpdate: connect(EventHandler::getInstance().data(), &EventHandler::signalEvent, this, &JsonCallbacks::handleEventUpdate); break; - case Subscription::ImageToLedMappingUpdate: - connect(_hyperion, &Hyperion::imageToLedsMappingChanged, this, &JsonCallbacks::handleImageToLedsMappingChange); - break; - case Subscription::ImageUpdate: - connect(_hyperion, &Hyperion::currentImage, this, &JsonCallbacks::handleImageUpdate); - break; case Subscription::InstanceUpdate: connect(HyperionIManager::getInstance(), &HyperionIManager::change, this, &JsonCallbacks::handleInstanceChange); break; - case Subscription::LedColorsUpdate: - connect(_hyperion, &Hyperion::rawLedColors, this, &JsonCallbacks::handleLedColorUpdate); - break; - case Subscription::LedsUpdate: - connect(_hyperion, &Hyperion::settingsChanged, this, &JsonCallbacks::handleLedsConfigChange); - break; case Subscription::LogMsgUpdate: if (!_islogMsgStreamingActive) { @@ -70,17 +61,45 @@ bool JsonCallbacks::subscribe(const Subscription::Type cmd) } connect(LoggerManager::getInstance().data(), &LoggerManager::newLogMessage, this, &JsonCallbacks::handleLogMessageUpdate); break; - case Subscription::PrioritiesUpdate: - connect(_prioMuxer, &PriorityMuxer::prioritiesChanged, this, &JsonCallbacks::handlePriorityUpdate); - break; case Subscription::SettingsUpdate: - connect(_hyperion, &Hyperion::settingsChanged, this, &JsonCallbacks::handleSettingsChange); + connect(HyperionIManager::getInstance(), &HyperionIManager::settingsChanged, this, &JsonCallbacks::handleSettingsChange); break; case Subscription::TokenUpdate: connect(AuthManager::getInstance(), &AuthManager::tokenChange, this, &JsonCallbacks::handleTokenChange, Qt::AutoConnection); break; + + // Instance specific subscriptions + case Subscription::AdjustmentUpdate: + if (!_hyperion.isNull()) + connect(_hyperion.get(), &Hyperion::adjustmentChanged, this, &JsonCallbacks::handleAdjustmentChange); + break; + case Subscription::ComponentsUpdate: + if (_componentRegister != nullptr) + connect(_componentRegister, &ComponentRegister::updatedComponentState, this, &JsonCallbacks::handleComponentState); + break; + case Subscription::ImageToLedMappingUpdate: + if (!_hyperion.isNull()) + connect(_hyperion.get(), &Hyperion::imageToLedsMappingChanged, this, &JsonCallbacks::handleImageToLedsMappingChange); + break; + case Subscription::ImageUpdate: + if (!_hyperion.isNull()) + connect(_hyperion.get(), &Hyperion::currentImage, this, &JsonCallbacks::handleImageUpdate); + break; + case Subscription::LedColorsUpdate: + if (!_hyperion.isNull()) + connect(_hyperion.get(), &Hyperion::rawLedColors, this, &JsonCallbacks::handleLedColorUpdate); + break; + case Subscription::LedsUpdate: + if (!_hyperion.isNull()) + connect(_hyperion.get(), &Hyperion::settingsChanged, this, &JsonCallbacks::handleLedsConfigChange); + break; + case Subscription::PrioritiesUpdate: + if (!_prioMuxer.isNull()) + connect(_prioMuxer.get(), &PriorityMuxer::prioritiesChanged, this, &JsonCallbacks::handlePriorityUpdate); + break; case Subscription::VideomodeUpdate: - connect(_hyperion, &Hyperion::newVideoMode, this, &JsonCallbacks::handleVideoModeChange); + if (!_hyperion.isNull()) + connect(_hyperion.get(), &Hyperion::newVideoMode, this, &JsonCallbacks::handleVideoModeChange); break; default: @@ -131,38 +150,27 @@ QStringList JsonCallbacks::subscribe(const QJsonArray& subscriptions) bool JsonCallbacks::unsubscribe(const Subscription::Type cmd) { + if (!_subscribedCommands.contains(cmd)) + { + return true; + } + _subscribedCommands.remove(cmd); switch (cmd) { - case Subscription::AdjustmentUpdate: - disconnect(_hyperion, &Hyperion::adjustmentChanged, this, &JsonCallbacks::handleAdjustmentChange); - break; - case Subscription::ComponentsUpdate: - disconnect(_componentRegister, &ComponentRegister::updatedComponentState, this, &JsonCallbacks::handleComponentState); - break; + + // Global subscriptions #if defined(ENABLE_EFFECTENGINE) case Subscription::EffectsUpdate: - disconnect(_hyperion, &Hyperion::effectListUpdated, this, &JsonCallbacks::handleEffectListChange); + disconnect(EffectFileHandler::getInstance(), &EffectFileHandler::effectListChanged, this, &JsonCallbacks::handleEffectListChange); break; #endif case Subscription::EventUpdate: disconnect(EventHandler::getInstance().data(), &EventHandler::signalEvent, this, &JsonCallbacks::handleEventUpdate); break; - case Subscription::ImageToLedMappingUpdate: - disconnect(_hyperion, &Hyperion::imageToLedsMappingChanged, this, &JsonCallbacks::handleImageToLedsMappingChange); - break; - case Subscription::ImageUpdate: - disconnect(_hyperion, &Hyperion::currentImage, this, &JsonCallbacks::handleImageUpdate); - break; case Subscription::InstanceUpdate: disconnect(HyperionIManager::getInstance(), &HyperionIManager::change, this, &JsonCallbacks::handleInstanceChange); break; - case Subscription::LedColorsUpdate: - disconnect(_hyperion, &Hyperion::rawLedColors, this, &JsonCallbacks::handleLedColorUpdate); - break; - case Subscription::LedsUpdate: - disconnect(_hyperion, &Hyperion::settingsChanged, this, &JsonCallbacks::handleLedsConfigChange); - break; case Subscription::LogMsgUpdate: disconnect(LoggerManager::getInstance().data(), &LoggerManager::newLogMessage, this, &JsonCallbacks::handleLogMessageUpdate); if (_islogMsgStreamingActive) @@ -171,17 +179,46 @@ bool JsonCallbacks::unsubscribe(const Subscription::Type cmd) Debug(_log, "log streaming deactivated for client %s", _peerAddress.toStdString().c_str()); } break; - case Subscription::PrioritiesUpdate: - disconnect(_prioMuxer, &PriorityMuxer::prioritiesChanged, this, &JsonCallbacks::handlePriorityUpdate); - break; case Subscription::SettingsUpdate: - disconnect(_hyperion, &Hyperion::settingsChanged, this, &JsonCallbacks::handleSettingsChange); + disconnect(HyperionIManager::getInstance(), &HyperionIManager::settingsChanged, this, &JsonCallbacks::handleSettingsChange); break; case Subscription::TokenUpdate: disconnect(AuthManager::getInstance(), &AuthManager::tokenChange, this, &JsonCallbacks::handleTokenChange); break; + + // Instance specific subscriptions + case Subscription::AdjustmentUpdate: + if (!_hyperion.isNull()) + disconnect(_hyperion.get(), &Hyperion::adjustmentChanged, this, &JsonCallbacks::handleAdjustmentChange); + break; + case Subscription::ComponentsUpdate: + if (_componentRegister != nullptr) + disconnect(_componentRegister, &ComponentRegister::updatedComponentState, this, &JsonCallbacks::handleComponentState); + break; + + case Subscription::ImageToLedMappingUpdate: + if (!_hyperion.isNull()) + disconnect(_hyperion.get(), &Hyperion::imageToLedsMappingChanged, this, &JsonCallbacks::handleImageToLedsMappingChange); + break; + case Subscription::ImageUpdate: + if (!_hyperion.isNull()) + disconnect(_hyperion.get(), &Hyperion::currentImage, this, &JsonCallbacks::handleImageUpdate); + break; + case Subscription::LedColorsUpdate: + if (!_hyperion.isNull()) + disconnect(_hyperion.get(), &Hyperion::rawLedColors, this, &JsonCallbacks::handleLedColorUpdate); + break; + case Subscription::LedsUpdate: + if (!_hyperion.isNull()) + disconnect(_hyperion.get(), &Hyperion::settingsChanged, this, &JsonCallbacks::handleLedsConfigChange); + break; + case Subscription::PrioritiesUpdate: + if (!_prioMuxer.isNull()) + disconnect(_prioMuxer.get(), &PriorityMuxer::prioritiesChanged, this, &JsonCallbacks::handlePriorityUpdate); + break; case Subscription::VideomodeUpdate: - disconnect(_hyperion, &Hyperion::newVideoMode, this, &JsonCallbacks::handleVideoModeChange); + if (!_hyperion.isNull()) + disconnect(_hyperion.get(), &Hyperion::newVideoMode, this, &JsonCallbacks::handleVideoModeChange); break; default: @@ -236,22 +273,25 @@ void JsonCallbacks::resetSubscriptions() } } -void JsonCallbacks::setSubscriptionsTo(Hyperion* hyperion) +void JsonCallbacks::setSubscriptionsTo(quint8 instanceID) { - assert(hyperion); - - // get current subs + // get current subscriptions const QSet currSubs(_subscribedCommands); // stop subs resetSubscriptions(); + _instanceID = instanceID; // update pointer - _hyperion = hyperion; - _componentRegister = _hyperion->getComponentRegister(); - _prioMuxer = _hyperion->getMuxerInstance(); + QSharedPointer const hyperion = HyperionIManager::getInstance()->getHyperionInstance(instanceID); + if (!hyperion.isNull() && hyperion != _hyperion) + { + _hyperion = hyperion; + _componentRegister = _hyperion->getComponentRegister(); + _prioMuxer = _hyperion->getMuxerInstance(); + } - // re-apply subs + // re-apply subscriptions for(const auto & entry : currSubs) { subscribe(entry); @@ -300,7 +340,10 @@ void JsonCallbacks::doCallback(Subscription::Type cmd, const QJsonArray& data) if (Subscription::isInstanceSpecific(cmd)) { - obj.insert("instance", _hyperion->getInstanceIndex()); + if (_instanceID != GLOABL_INSTANCE_ID) + { + obj.insert("instance", _instanceID); + } } obj.insert("data", data); @@ -314,7 +357,10 @@ void JsonCallbacks::doCallback(Subscription::Type cmd, const QJsonObject& data) if (Subscription::isInstanceSpecific(cmd)) { - obj.insert("instance", _hyperion->getInstanceIndex()); + if (_instanceID != GLOABL_INSTANCE_ID) + { + obj.insert("instance", _instanceID); + } } obj.insert("data", data); @@ -349,7 +395,7 @@ void JsonCallbacks::handleImageToLedsMappingChange(int mappingType) void JsonCallbacks::handleAdjustmentChange() { - doCallback(Subscription::AdjustmentUpdate, JsonInfo::getAdjustmentInfo(_hyperion,_log)); + doCallback(Subscription::AdjustmentUpdate, JsonInfo::getAdjustmentInfo(_hyperion.get(),_log)); } void JsonCallbacks::handleVideoModeChange(VideoMode mode) @@ -363,7 +409,7 @@ void JsonCallbacks::handleVideoModeChange(VideoMode mode) void JsonCallbacks::handleEffectListChange() { QJsonObject effects; - effects["effects"] = JsonInfo::getEffects(_hyperion); + effects["effects"] = JsonInfo::getEffects(); doCallback(Subscription::EffectsUpdate, effects); } #endif diff --git a/libsrc/api/JsonInfo.cpp b/libsrc/api/JsonInfo.cpp index baab3862e..2b8709804 100644 --- a/libsrc/api/JsonInfo.cpp +++ b/libsrc/api/JsonInfo.cpp @@ -1,23 +1,75 @@ +#include "hyperion/ImageProcessor.h" #include #include #include #include -#include #include #include #include #include #include +#include #include // Required to determine the cmake options #include #include +#if defined(ENABLE_EFFECTENGINE) +#include +#endif + +QJsonObject JsonInfo::getInfo(const Hyperion* hyperion, Logger* log) +{ + QJsonObject info {}; + + // Global information + info["ledDevices"] = JsonInfo::getAvailableLedDevices(); + info["cec"] = JsonInfo::getCecInfo(); + info["services"] = JsonInfo::getServices(); + info["instance"] = JsonInfo::getInstanceInfo(); + info["effects"] = JsonInfo::getEffects(); + + // Global/Instance specific information + info["grabbers"] = JsonInfo::getGrabbers(hyperion); + info["components"] = JsonInfo::getComponents(hyperion); + + // Instance specific information + info["priorities"] = JsonInfo::getPrioritiestInfo(hyperion); + info["adjustment"] = JsonInfo::getAdjustmentInfo(hyperion, log); + info["activeLedColor"] = JsonInfo::getActiveColors(hyperion); +#if defined(ENABLE_EFFECTENGINE) + info["activeEffects"] = JsonInfo::getActiveEffects(hyperion); +#endif + if (hyperion != nullptr) + { + info["priorities_autoselect"] = hyperion->sourceAutoSelectEnabled(); + info["videomode"] = QString(videoMode2String(hyperion->getCurrentVideoMode())); + info["imageToLedMappingType"] = ImageProcessor::mappingTypeToStr(0); + info["leds"] = hyperion->getSetting(settings::LEDS).array(); + } + else + { + info["priorities_autoselect"] = false; + info["videomode"] = QString(videoMode2String(VideoMode::VIDEO_2D)); + info["imageToLedMappingType"] = ImageProcessor::mappingTypeToStr(0); + info["leds"] = QJsonArray(); + } + + // BEGIN | The following entries are deprecated but used to ensure backward compatibility with hyperion Classic or up to Hyperion 2.0.16 + info["hostname"] = QHostInfo::localHostName(); + info["transform"] = JsonInfo::getTransformationInfo(hyperion); + return info; +} QJsonArray JsonInfo::getAdjustmentInfo(const Hyperion* hyperion, Logger* log) { + if (hyperion == nullptr) + { + return QJsonArray(); + } + QJsonArray adjustmentArray; for (const QString &adjustmentId : hyperion->getAdjustmentIds()) { @@ -93,6 +145,11 @@ QJsonArray JsonInfo::getAdjustmentInfo(const Hyperion* hyperion, Logger* log) QJsonArray JsonInfo::getPrioritiestInfo(const Hyperion* hyperion) { + if (hyperion == nullptr) + { + return QJsonArray(); + } + return getPrioritiestInfo(hyperion->getCurrentPriority(), hyperion->getPriorityInfo()); } @@ -164,13 +221,12 @@ QJsonArray JsonInfo::getPrioritiestInfo(int currentPriority, const PriorityMuxer return priorities; } -QJsonArray JsonInfo::getEffects(const Hyperion* hyperion) +QJsonArray JsonInfo::getEffects() { QJsonArray effects; #if defined(ENABLE_EFFECTENGINE) - // collect effect info - const std::list &effectsDefinitions = hyperion->getEffects(); + const std::list effectsDefinitions = EffectFileHandler::getInstance()->getEffects(); for (const EffectDefinition &effectDefinition : effectsDefinitions) { QJsonObject effect; @@ -184,11 +240,37 @@ QJsonArray JsonInfo::getEffects(const Hyperion* hyperion) return effects; } +QJsonArray JsonInfo::getEffectSchemas() +{ + QJsonArray schemaList; +#if defined(ENABLE_EFFECTENGINE) + const std::list& effectsSchemas = EffectFileHandler::getInstance()->getEffectSchemas(); + for (const EffectSchema& effectSchema : effectsSchemas) + { + QJsonObject schema; + schema.insert("script", effectSchema.pyFile); + schema.insert("schemaLocation", effectSchema.schemaFile); + schema.insert("schemaContent", effectSchema.pySchema); + if (effectSchema.pyFile.startsWith(':')) + { + schema.insert("type", "system"); + } + else + { + schema.insert("type", "custom"); + } + schemaList.append(schema); + } +#endif + return schemaList; +} + QJsonObject JsonInfo::getAvailableLedDevices() { // get available led devices QJsonObject ledDevices; QJsonArray availableLedDevices; + for (const auto& dev : LedDeviceWrapper::getDeviceMap()) { availableLedDevices.append(dev.first); @@ -231,11 +313,18 @@ QJsonArray JsonInfo::getAvailableAudioGrabbers() QJsonObject JsonInfo::getGrabbers(const Hyperion* hyperion) { QJsonObject grabbers; + + quint8 idx { GLOABL_INSTANCE_ID }; + if (hyperion != nullptr) + { + idx = hyperion->getInstanceIndex(); + } + // SCREEN QJsonObject screenGrabbers; if (GrabberWrapper::getInstance() != nullptr) { - const QStringList activeGrabbers = GrabberWrapper::getInstance()->getActive(hyperion->getInstanceIndex(), GrabberTypeFilter::SCREEN); + const QStringList activeGrabbers = GrabberWrapper::getInstance()->getActive(idx, GrabberTypeFilter::SCREEN); QJsonArray activeGrabberNames; for (const auto& grabberName : activeGrabbers) { @@ -250,7 +339,7 @@ QJsonObject JsonInfo::getGrabbers(const Hyperion* hyperion) QJsonObject videoGrabbers; if (GrabberWrapper::getInstance() != nullptr) { - const QStringList activeGrabbers = GrabberWrapper::getInstance()->getActive(hyperion->getInstanceIndex(), GrabberTypeFilter::VIDEO); + const QStringList activeGrabbers = GrabberWrapper::getInstance()->getActive(idx, GrabberTypeFilter::VIDEO); QJsonArray activeGrabberNames; for (const auto& grabberName : activeGrabbers) { @@ -265,7 +354,7 @@ QJsonObject JsonInfo::getGrabbers(const Hyperion* hyperion) QJsonObject audioGrabbers; if (GrabberWrapper::getInstance() != nullptr) { - const QStringList activeGrabbers = GrabberWrapper::getInstance()->getActive(hyperion->getInstanceIndex(), GrabberTypeFilter::AUDIO); + const QStringList activeGrabbers = GrabberWrapper::getInstance()->getActive(idx, GrabberTypeFilter::AUDIO); QJsonArray activeGrabberNames; for (const auto& grabberName : activeGrabbers) @@ -340,8 +429,19 @@ QJsonArray JsonInfo::getComponents(const Hyperion* hyperion) { // get available components QJsonArray component; - std::map components = hyperion->getComponentRegister()->getRegister(); - for (auto comp : components) + std::map components; + + if (hyperion!= nullptr) + { + components = hyperion->getComponentRegister()->getRegister(); + } + else + { + ComponentRegister componentRegister(nullptr); + components = componentRegister.getRegister(); + } + + for (const auto& comp : components) { QJsonObject item; item["name"] = QString::fromStdString(hyperion::componentToIdString(comp.first)); @@ -370,6 +470,12 @@ QJsonArray JsonInfo::getTransformationInfo(const Hyperion* hyperion) { // TRANSFORM INFORMATION (DEFAULT VALUES) QJsonArray transformArray; + + if (hyperion == nullptr) + { + return transformArray; + } + for (const QString &transformId : hyperion->getAdjustmentIds()) { QJsonObject transform; @@ -407,6 +513,12 @@ QJsonArray JsonInfo::getActiveEffects(const Hyperion* hyperion) { // ACTIVE EFFECT INFO QJsonArray activeEffects; + + if (hyperion == nullptr) + { + return activeEffects; + } + #if defined(ENABLE_EFFECTENGINE) for (const ActiveEffectDefinition &activeEffectDefinition : hyperion->getActiveEffects()) { @@ -429,6 +541,12 @@ QJsonArray JsonInfo::getActiveColors(const Hyperion* hyperion) { // ACTIVE STATIC LED COLOR QJsonArray activeLedColors; + + if (hyperion == nullptr) + { + return activeLedColors; + } + const Hyperion::InputInfo &priorityInfo = hyperion->getPriorityInfo(hyperion->getCurrentPriority()); if (priorityInfo.componentId == hyperion::COMP_COLOR && !priorityInfo.ledColors.empty()) { @@ -469,7 +587,7 @@ QJsonArray JsonInfo::getActiveColors(const Hyperion* hyperion) return activeLedColors; } -QJsonObject JsonInfo::getSystemInfo(const Hyperion* hyperion) +QJsonObject JsonInfo::getSystemInfo() { QJsonObject info; @@ -498,6 +616,11 @@ QJsonObject JsonInfo::getSystemInfo(const Hyperion* hyperion) QJsonObject hyperionInfo; hyperionInfo["version"] = QString(HYPERION_VERSION); hyperionInfo["build"] = QString(HYPERION_BUILD_ID); +#ifdef NDEBUG + hyperionInfo["buildType"] = "Release"; +#else + hyperionInfo["buildType"] = "Debug"; +#endif hyperionInfo["gitremote"] = QString(HYPERION_GIT_REMOTE); hyperionInfo["time"] = QString(__DATE__ " " __TIME__); hyperionInfo["id"] = AuthManager::getInstance()->getID(); @@ -534,7 +657,7 @@ QJsonObject JsonInfo::discoverSources(const QString& sourceType, const QJsonObje template void JsonInfo::discoverGrabber(QJsonArray& inputs, const QJsonObject& params) const { - GrabberType grabber; + GrabberType grabber{}; QJsonValue discoveryResult = grabber.discover(params); if (discoveryResult.isArray()) @@ -626,8 +749,8 @@ QJsonArray JsonInfo::discoverScreenInputs(const QJsonObject& params) const return screenInputs; } -QJsonObject JsonInfo::getConfiguration(const QList& instancesfilter, const QStringList& instanceFilteredTypes, const QStringList& globalFilterTypes ) +QJsonObject JsonInfo::getConfiguration(const QList& instanceIdsfilter, const QStringList& instanceFilteredTypes, const QStringList& globalFilterTypes ) { DBConfigManager configManager; - return configManager.getConfiguration(instancesfilter, instanceFilteredTypes, globalFilterTypes ); + return configManager.getConfiguration(instanceIdsfilter, instanceFilteredTypes, globalFilterTypes ); } diff --git a/libsrc/boblightserver/BoblightServer.cpp b/libsrc/boblightserver/BoblightServer.cpp index f6acccf82..1cd413456 100644 --- a/libsrc/boblightserver/BoblightServer.cpp +++ b/libsrc/boblightserver/BoblightServer.cpp @@ -52,7 +52,7 @@ void BoblightServer::start() if (NetUtils::portAvailable(_port, _log)) _server->listen(QHostAddress::Any, _port); - Info(_log, "Started on port: %d", _port); + Info(_log, "Boblight service started on port: %d", _port); _hyperion->setNewComponentState(COMP_BOBLIGHTSERVER, _server->isListening()); } @@ -67,7 +67,7 @@ void BoblightServer::stop() _server->close(); - Info(_log, "Stopped"); + Info(_log, "Boblight service stopped"); _hyperion->setNewComponentState(COMP_BOBLIGHTSERVER, _server->isListening()); } diff --git a/libsrc/commandline/ColorsOption.cpp b/libsrc/commandline/ColorsOption.cpp index ab26b5854..ceec57798 100644 --- a/libsrc/commandline/ColorsOption.cpp +++ b/libsrc/commandline/ColorsOption.cpp @@ -38,7 +38,7 @@ bool ColorsOption::validate(Parser & parser, QString & value) return true; } - _error = QString("Invalid color. A color is specified by a six lettered RRGGBB hex getColors or one of the following names:\n\t- %1").arg(QColor::colorNames().join("\n\t- ")); + _error = QString("Invalid color. A color is specified by a six lettered RRGGBB hex value string or one of the following names:\n\t- %1").arg(QColor::colorNames().join("\n\t- ")); return false; } diff --git a/libsrc/db/DBConfigManager.cpp b/libsrc/db/DBConfigManager.cpp index 24f22b2ed..a817169da 100644 --- a/libsrc/db/DBConfigManager.cpp +++ b/libsrc/db/DBConfigManager.cpp @@ -18,6 +18,7 @@ #include #include #include +#include namespace { const char SETTINGS_FULL_SCHEMA_FILE[] = ":/schema-settings-full.json"; @@ -68,7 +69,7 @@ bool DBConfigManager::exportJson(const QString& path) const const QJsonObject generalSettings = configurtion.value("global").toObject().value("settings").toObject().value("general").toObject(); const QString configVersion = generalSettings.value("configVersion").toString(); - jsonFile = exportPath.absoluteFilePath(QString("HyperionBackup_%1_v%2.json").arg(QDateTime::currentDateTime().toString("yyyy-MM-dd_hh:mm:ss:zzz"), configVersion )); + jsonFile = exportPath.absoluteFilePath(QString("HyperionBackup_%1_v%2.json").arg(QDateTime::currentDateTime().toString("yyyy-MM-dd-hhmmss-zzz"), configVersion )); if (FileUtils::writeFile(jsonFile, QJsonDocument(configurtion).toJson(QJsonDocument::Indented), _log)) { isExported = true; @@ -154,10 +155,10 @@ QPair DBConfigManager::addMissingDefaults() InstanceTable instanceTable; - //Ensure that first instance as default one exists - instanceTable.createDefaultInstance(); + //Ensure that one initial instance exists + instanceTable.createInitialInstance(); - const QList instances = instanceTable.getAllInstanceIDs(); + const QSet instances = instanceTable.getAllInstanceIDs(); for (const auto &instanceIdx : instances) { SettingsTable instanceSettingsTable(instanceIdx); @@ -199,7 +200,7 @@ QPair DBConfigManager::updateConfiguration(QJsonObject& confi // Clear existing tables and import the new configuration. bool errorOccurred = false; - if (!deleteTable("instances") && deleteTable("settings")) + if (!(deleteTable("instances") && deleteTable("settings"))) { errorOccurred = true; logErrorAndAppend("Failed to clear tables before import", errorList); @@ -274,11 +275,6 @@ bool DBConfigManager::importInstance(InstanceTable& instanceTable, const QJsonOb QString instanceName = instanceConfig.value("name").toString(QString("Instance %1").arg(instanceIdx)); bool isInstanceEnabled = instanceConfig.value("enabled").toBool(true); - if (instanceIdx == 0) - { - isInstanceEnabled = true; // The first instance must be enabled. - } - if (!instanceTable.createInstance(instanceName, instanceIdx) || !instanceTable.setEnable(instanceIdx, isInstanceEnabled)) { @@ -307,7 +303,7 @@ bool DBConfigManager::importInstanceSettings(SettingsTable& settingsTable, const return !errorOccurred; } -QJsonObject DBConfigManager::getConfiguration(const QList& instancesFilter, const QStringList& instanceFilteredTypes, const QStringList& globalFilterTypes ) const +QJsonObject DBConfigManager::getConfiguration(const QList& instanceIdsFilter, const QStringList& instanceFilteredTypes, const QStringList& globalFilterTypes ) const { QSqlDatabase idb = getDB(); @@ -317,37 +313,45 @@ QJsonObject DBConfigManager::getConfiguration(const QList& instancesFilt } InstanceTable instanceTable; - SettingsTable settingsTable; + SettingsTable const settingsTable; QJsonObject config; QJsonObject globalConfig; - MetaTable metaTable; + MetaTable const metaTable; globalConfig.insert("uuid", metaTable.getUUID()); globalConfig.insert("settings", settingsTable.getSettings(globalFilterTypes)); config.insert("global", globalConfig); - QList instances {instancesFilter}; - if (instances.isEmpty()) +#if (QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)) + QSet instanceIds(instanceIdsFilter.begin(), instanceIdsFilter.end()); +#else + QSet instanceIds; + for (const auto &id : instanceIdsFilter) { + instanceIds.insert(id); + } +#endif + + if (instanceIds.isEmpty()) { - instances = instanceTable.getAllInstanceIDs(); + instanceIds = instanceTable.getAllInstanceIDs(); } - QList sortedInstances = instances; - std::sort(sortedInstances.begin(), sortedInstances.end()); + QList sortedInstanceIds = instanceIds.values(); + std::sort(sortedInstanceIds.begin(), sortedInstanceIds.end()); QJsonArray instanceIdList; QJsonArray configInstanceList; - for (const quint8 instanceIdx : sortedInstances) + for (const quint8 instanceId : std::as_const(sortedInstanceIds)) { QJsonObject instanceConfig; - instanceConfig.insert("id",instanceIdx); - instanceConfig.insert("name", instanceTable.getNamebyIndex(instanceIdx)); - instanceConfig.insert("enabled", instanceTable.isEnabled(instanceIdx)); - instanceConfig.insert("settings", settingsTable.getSettings(static_cast(instanceIdx), instanceFilteredTypes)); + instanceConfig.insert("id",instanceId); + instanceConfig.insert("name", instanceTable.getNamebyIndex(instanceId)); + instanceConfig.insert("enabled", instanceTable.isEnabled(instanceId)); + instanceConfig.insert("settings", settingsTable.getSettings(static_cast(instanceId), instanceFilteredTypes)); configInstanceList.append(instanceConfig); - instanceIdList.append(instanceIdx); + instanceIdList.append(instanceId); } config.insert("instanceIds", instanceIdList); diff --git a/libsrc/db/DBManager.cpp b/libsrc/db/DBManager.cpp index 6163e2f5e..23b5f3411 100644 --- a/libsrc/db/DBManager.cpp +++ b/libsrc/db/DBManager.cpp @@ -11,15 +11,15 @@ #include #ifdef _WIN32 - #include +#include #endif #define NO_SQLQUERY_LOGGING // Constants namespace { - const char DATABASE_DIRECTORYNAME[] = "db"; - const char DATABASE_FILENAME[] = "hyperion.db"; +const char DATABASE_DIRECTORYNAME[] = "db"; +const char DATABASE_FILENAME[] = "hyperion.db"; } //End of constants @@ -56,26 +56,26 @@ QSqlDatabase DBManager::getDB() const { return _databasePool.localData(); } - auto database = QSqlDatabase::addDatabase("QSQLITE", QUuid::createUuid().toString()); + auto database = QSqlDatabase::addDatabase("QSQLITE", QUuid::createUuid().toString()); - if (isReadOnly()) - { - database.setConnectOptions("QSQLITE_OPEN_READONLY"); - } + if (isReadOnly()) + { + database.setConnectOptions("QSQLITE_OPEN_READONLY"); + } #ifdef SQLQUERY_LOGGING - Debug(Logger::getInstance("DB"), "Database is opened in %s mode", _isReadOnly ? "read-only" : "read/write"); + Debug(Logger::getInstance("DB"), "Database is opened in %s mode", _isReadOnly ? "read-only" : "read/write"); #endif - _databasePool.setLocalData(database); - database.setDatabaseName(_databaseFile.absoluteFilePath()); - if(!database.open()) - { - Error(_log, "%s", QSTRING_CSTR(database.lastError().text())); - throw std::runtime_error("Failed to open database connection!"); - } + _databasePool.setLocalData(database); + database.setDatabaseName(_databaseFile.absoluteFilePath()); + if(!database.open()) + { + Error(_log, "%s", QSTRING_CSTR(database.lastError().text())); + throw std::runtime_error("Failed to open database connection!"); + } - return database; + return database; } bool DBManager::createRecord(const VectorPair& conditions, const QVariantMap& columns) const @@ -123,29 +123,50 @@ bool DBManager::createRecord(const VectorPair& conditions, const QVariantMap& co return executeQuery(query); } -bool DBManager::recordExists(const VectorPair& conditions) const +bool DBManager::recordExists(const VectorPair& conditions, const QStringList& tColumns) const { - if(conditions.isEmpty()) + // prep conditions + QStringList conditionList; + QVariantList bindValues; + + for(const auto& pair : conditions) { - return false; + conditionList << pair.first; + if (pair.second.isNull()) + { + conditionList << "IS NULL"; + } + else + { + conditionList << "= ?"; + bindValues << pair.second; + } } + return recordExists(conditionList.join((" ")), bindValues, tColumns); +} + +bool DBManager::recordExists(const QString& condition, const QVariantList& bindValues, const QStringList& tColumns) const +{ QSqlDatabase idb = getDB(); QSqlQuery query(idb); query.setForwardOnly(true); - QStringList prepCond; - QVariantList bindVal; - prepCond << "WHERE"; + QString sColumns("*"); + if(!tColumns.isEmpty()) + { + sColumns = tColumns.join(", "); + } - for(const auto& pair : conditions) + // prep conditions + QString prepCond; + if(!condition.isEmpty()) { - prepCond << pair.first+"= ?"; - bindVal << pair.second; + prepCond = QString("WHERE %1").arg(condition); } - query.prepare(QString("SELECT * FROM %1 %2").arg(_table,prepCond.join(" "))); - addBindValues(query, bindVal); + query.prepare(QString("SELECT %1 FROM %2 %3").arg(sColumns,_table, prepCond)); + addBindValues(query, bindValues); if (!executeQuery(query)) { return false; @@ -195,7 +216,30 @@ bool DBManager::recordsNotExisting(const QVariantList& testValues,const QString& return true; } -bool DBManager::updateRecord(const VectorPair& conditions, const QVariantMap& columns) const +bool DBManager::updateRecord(const VectorPair& conditions, const QVariantMap& tColumns) const +{ + // prep conditions + QStringList conditionList; + QVariantList bindValues; + + for(const auto& pair : conditions) + { + conditionList << pair.first; + if (pair.second.isNull()) + { + conditionList << "IS NULL"; + } + else + { + conditionList << "= ?"; + bindValues << pair.second; + } + } + + return updateRecord(conditionList.join((" ")), bindValues, tColumns); +} + +bool DBManager::updateRecord(const QString& condition, const QVariantList& condBindValues, const QVariantMap& columns) const { if (isReadOnly()) { @@ -218,24 +262,18 @@ bool DBManager::updateRecord(const VectorPair& conditions, const QVariantMap& co ++columnIter; } - // prepare condition values - QStringList prepCond; - QVariantList prepBindVal; - if(!conditions.isEmpty()) { - prepCond << "WHERE"; - } - - for(const auto& pair : conditions) + // prep conditions + QString prepCond; + if(!condition.isEmpty()) { - prepCond << pair.first+"= ?"; - prepBindVal << pair.second; + prepCond = QString("WHERE %1").arg(condition); } - query.prepare(QString("UPDATE %1 SET %2 %3").arg(_table,prep.join(", "), prepCond.join(" "))); + query.prepare(QString("UPDATE %1 SET %2 %3").arg(_table,prep.join(", "), prepCond)); // add column values addBindValues(query, values); // add condition values - addBindValues(query, prepBindVal); + addBindValues(query, condBindValues); return executeQuery(query); } @@ -458,11 +496,18 @@ QString DBManager::constructExecutedQuery(const QSqlQuery& query) const QString valueStr; if (value.canConvert()) { - valueStr = value.toString(); + valueStr = QString("'%1'").arg(value.toString()); } else { - valueStr = "Unkown"; + if (value.isNull()) + { + valueStr = "NULL"; + } + else + { + valueStr = "Unkown"; + } } executedQuery.replace(executedQuery.indexOf('?'), 1, valueStr); } diff --git a/libsrc/db/DBMigrationManager.cpp b/libsrc/db/DBMigrationManager.cpp index c2c92e3ff..fb16009b1 100644 --- a/libsrc/db/DBMigrationManager.cpp +++ b/libsrc/db/DBMigrationManager.cpp @@ -63,7 +63,6 @@ bool DBMigrationManager::migrateSettings(QJsonObject& config) // Extract, modify, and reinsert the global settings QJsonObject globalSettings = config.value("global").toObject().value("settings").toObject(); upgradeGlobalSettings(currentVersion, globalSettings); - QJsonObject globalConfig = config.value("global").toObject(); globalConfig.insert("settings", globalSettings); config.insert("global", globalConfig); @@ -132,6 +131,8 @@ bool DBMigrationManager::upgradeInstanceSettings(const semver::version& currentV upgradeInstanceSettings_2_0_13(migratedVersion, instance, config); //Migration step for versions < 2.0.16 upgradeInstanceSettings_2_0_16(migratedVersion, instance, config); + //Migration step for versions < 2.0.17 + upgradeInstanceSettings_2_1_0(migratedVersion, instance, config); return migrated; } @@ -403,6 +404,16 @@ bool DBMigrationManager::upgradeGlobalSettings_2_1_0(semver::version& currentVer Info(_log, "Global settings: Migrate from version [%s] to version [%s] or later", currentVersion.getVersion().c_str(), targetVersion.getVersion().c_str()); currentVersion = targetVersion; + SettingsTable instanceSettingsTable(0); + QJsonObject effectsSettings = instanceSettingsTable.getSettings(QStringList("effects")); + if (!effectsSettings.isEmpty()) + { + config.insert("effects", effectsSettings.value("effects")); + + Debug(_log, "Effect settings migrated"); + migrated = true; + } + if (config.contains("general")) { QJsonObject newGeneralConfig = config["general"].toObject(); @@ -423,7 +434,6 @@ bool DBMigrationManager::upgradeGlobalSettings_2_1_0(semver::version& currentVer Debug(_log, "Network settings migrated"); migrated = true; } - } //Remove wrong instance 255 configuration records, created by the global instance #255 @@ -562,7 +572,7 @@ bool DBMigrationManager::upgradeInstanceSettings_alpha_9(semver::version& curren if (migrated) { config["device"] = newDeviceConfig; - Debug(_log, "LED-Device records migrated"); + Debug(_log, "Instance [%u] - LED-Device records migrated", instance); } } } @@ -624,7 +634,7 @@ bool DBMigrationManager::upgradeInstanceSettings_2_0_12(semver::version& current if (migrated) { config["device"] = newDeviceConfig; - Debug(_log, "LED-Device records migrated"); + Debug(_log, "Instance [%u] - LED-Device records migrated", instance); } } @@ -684,7 +694,7 @@ bool DBMigrationManager::upgradeInstanceSettings_2_0_13(semver::version& current if (migrated) { config["device"] = newDeviceConfig; - Debug(_log, "LED-Device records migrated"); + Debug(_log, "Instance [%u] - LED-Device records migrated", instance); } } } @@ -758,10 +768,29 @@ bool DBMigrationManager::upgradeInstanceSettings_2_0_16(semver::version& current if (migrated) { config["device"] = newDeviceConfig; - Debug(_log, "LED-Device records migrated"); + Debug(_log, "Instance [%u] - LED-Device records migrated", instance); } } return migrated; } +bool DBMigrationManager::upgradeInstanceSettings_2_1_0(semver::version& currentVersion, quint8 instance, QJsonObject& config) +{ + bool migrated = false; + const semver::version targetVersion{ "2.0.17-beta.2" }; + + if (currentVersion < targetVersion) + + Info(_log, "Settings instance [%u]: Migrate from version [%s] to version [%s] or later", instance, currentVersion.getVersion().c_str(), targetVersion.getVersion().c_str()); + currentVersion = targetVersion; + + if (config.contains("effects")) + { + config.remove("effects"); + + Debug(_log, "Instance [%u] - Effects settings migrated", instance); + migrated = true; + } + return migrated; +} diff --git a/libsrc/db/InstanceTable.cpp b/libsrc/db/InstanceTable.cpp index 702e124a0..5d93d80ad 100644 --- a/libsrc/db/InstanceTable.cpp +++ b/libsrc/db/InstanceTable.cpp @@ -19,7 +19,7 @@ bool InstanceTable::createInstance(const QString& name, quint8& inst) // check duplicate if(!recordExists({{"friendly_name", name}})) { - QList instanceList = getAllInstanceIDs(false); + QSet const instanceList = getAllInstanceIDs(false); inst = 0; while (instanceList.contains(inst)) @@ -31,7 +31,7 @@ bool InstanceTable::createInstance(const QString& name, quint8& inst) QVariantMap data; data["friendly_name"] = name; data["instance"] = inst; - return createRecord({}, data); + return createRecord({{"instance", inst}}, data); } return false; @@ -55,7 +55,7 @@ bool InstanceTable::saveName(quint8 inst, const QString& name) // check duplicate if(!recordExists({{"friendly_name", name}})) { - if(instanceExist(inst)) + if(doesInstanceExist(inst)) { return updateRecord({{"instance",inst}}, {{"friendly_name", name}}); } @@ -76,19 +76,19 @@ QVector InstanceTable::getAllInstances(bool onlyEnabled) return results; } -QList InstanceTable::getAllInstanceIDs (bool onlyEnabled) +QSet InstanceTable::getAllInstanceIDs (bool onlyEnabled) { QVector instanceList = getAllInstances(onlyEnabled); - QList instanceIds; + QSet instanceIds; for (const QVariantMap &idx : std::as_const(instanceList)) { - instanceIds.append(static_cast(idx.value("instance").toInt())); + instanceIds.insert(static_cast(idx.value("instance").toInt())); } return instanceIds; } -bool InstanceTable::instanceExist(quint8 inst) +bool InstanceTable::doesInstanceExist(quint8 inst) { return recordExists({{"instance",inst}}); } @@ -98,7 +98,7 @@ QString InstanceTable::getNamebyIndex(quint8 index) QVariantMap results; getRecord({{"instance", index}}, results, {"friendly_name"}); - QString name = results["friendly_name"].toString(); + QString const name = results["friendly_name"].toString(); return name.isEmpty() ? "NOT FOUND" : name; } @@ -120,13 +120,10 @@ bool InstanceTable::isEnabled(quint8 inst) return results["enabled"].toBool(); } -void InstanceTable::createDefaultInstance() +void InstanceTable::createInitialInstance() { - if(instanceExist(0)) - { - setEnable(0, true); - } - else + QSet const instanceIDs = getAllInstanceIDs(false); + if(instanceIDs.isEmpty()) { if(createRecord({{"instance", 0}}, {{"friendly_name", "First LED Hardware instance"}})) { diff --git a/libsrc/db/SettingsTable.cpp b/libsrc/db/SettingsTable.cpp index 573524da5..333bef401 100644 --- a/libsrc/db/SettingsTable.cpp +++ b/libsrc/db/SettingsTable.cpp @@ -116,17 +116,21 @@ QJsonObject SettingsTable::initializeDefaultSettings() const bool SettingsTable::createSettingsRecord(const QString& type, const QString& config) const { - QVariantMap map; - map["config"] = config; - map["updated_at"] = QDateTime::currentDateTimeUtc().toString(Qt::ISODate); - VectorPair cond; cond.append(CPair("type",type)); - // when a setting is not global we are searching also for the instance + + QVariant instance {}; if(!isGlobalSettingType(type)) { - cond.append(CPair("AND hyperion_inst",_instance)); + instance = _instance; } + cond.append(CPair("AND hyperion_inst", instance)); + + QVariantMap map; + map.insert("config", config); + map.insert("updated_at", QDateTime::currentDateTimeUtc().toString(Qt::ISODate)); + map.insert("hyperion_inst", instance); + return createRecord(cond, map); } @@ -134,40 +138,42 @@ bool SettingsTable::recordExist(const QString& type) const { VectorPair cond; cond.append(CPair("type",type)); - // when a setting is not global we are searching also for the instance + + QVariant instance {}; if(!isGlobalSettingType(type)) { - cond.append(CPair("AND hyperion_inst",_instance)); + instance = _instance; } + cond.append(CPair("AND hyperion_inst", instance)); + return recordExists(cond); } -QJsonDocument SettingsTable::getSettingsRecord(const QString& type) const +QVariant SettingsTable::getSettingsRecord(const QString& type) const { QVariantMap results; VectorPair cond; cond.append(CPair("type",type)); - // when a setting is not global we are searching also for the instance + + QVariant instance {}; if(!isGlobalSettingType(type)) { - cond.append(CPair("AND hyperion_inst",_instance)); + instance.setValue(static_cast(_instance)); } + cond.append(CPair("AND hyperion_inst", instance)); + getRecord(cond, results, QStringList("config")); - return QJsonDocument::fromJson(results["config"].toByteArray()); + return results.value("config"); +} + +QJsonDocument SettingsTable::getSettingsRecordJson(const QString& type) const +{ + return QJsonDocument::fromJson(getSettingsRecord(type).toByteArray()); } QString SettingsTable::getSettingsRecordString(const QString& type) const { - QVariantMap results; - VectorPair cond; - cond.append(CPair("type",type)); - // when a setting is not global we are searching also for the instance - if(!isGlobalSettingType(type)) - { - cond.append(CPair("AND hyperion_inst",_instance)); - } - getRecord(cond, results, QStringList("config")); - return results["config"].toString(); + return getSettingsRecord(type).toString(); } QJsonObject SettingsTable::getSettings(const QStringList& filteredTypes ) const @@ -275,7 +281,7 @@ QPair SettingsTable::addMissingDefaults() const QStringList missingTypes = nonExtingTypes(); if (missingTypes.empty()) { - Debug(_log, "Instance [%u]: No missing configuration items identified", _instance); + Debug(_log, "%s settings: No missing configuration items identified", _instance == GLOABL_INSTANCE_ID ? "Global" : QSTRING_CSTR(QString("Instance [%1]").arg(_instance)) ); return qMakePair (true, errorList ); } @@ -288,7 +294,7 @@ QPair SettingsTable::addMissingDefaults() bool errorOccured {false}; - Info(_log, "Instance [%u]: Add default settings for %d missing configuration items",_instance, missingTypes.size()); + Info(_log, "%s settings: Add default settings for %d missing configuration items", _instance == GLOABL_INSTANCE_ID ? "Global" : QSTRING_CSTR(QString("Instance [%1]").arg(_instance)), missingTypes.size() ); for (const auto &missingType: missingTypes) { if (!createSettingsRecord(missingType, JsonUtils::jsonValueToQString(defaultSettings.value(missingType)))) @@ -299,7 +305,7 @@ QPair SettingsTable::addMissingDefaults() if (errorOccured) { - QString errorText = "Errors occured while adding missing settings to instance configuration items"; + QString errorText = "Errors occured while adding missing settings to configuration items"; Error(_log, "'%s'", QSTRING_CSTR(errorText)); errorList.append(errorText); @@ -315,7 +321,7 @@ QPair SettingsTable::addMissingDefaults() if(errorList.isEmpty()) { - Debug(_log, "Instance [%u]: Successfully defaulted settings for %d missing configuration items", _instance, missingTypes.size()); + Debug(_log, "%s settings: Successfully defaulted settings for %d missing configuration items", _instance == GLOABL_INSTANCE_ID ? "Global" : QSTRING_CSTR(QString("Instance [%1]").arg(_instance)), missingTypes.size() ); } return qMakePair (errorList.isEmpty(), errorList ); @@ -349,7 +355,7 @@ QString SettingsTable::fixVersion(const QString& version) bool SettingsTable::resolveConfigVersion() { - QJsonObject generalConfig = getSettingsRecord({"general"}).object(); + QJsonObject generalConfig = getSettingsRecordJson({"general"}).object(); return resolveConfigVersion(generalConfig); } diff --git a/libsrc/effectengine/Effect.cpp b/libsrc/effectengine/Effect.cpp index b4fcc1dac..ad0745e84 100644 --- a/libsrc/effectengine/Effect.cpp +++ b/libsrc/effectengine/Effect.cpp @@ -49,9 +49,6 @@ Effect::Effect(Hyperion *hyperion, int priority, int timeout, const QString &scr Effect::~Effect() { - requestInterruption(); - wait(); - delete _painter; _imageStack.clear(); } @@ -162,3 +159,9 @@ void Effect::run() } file.close(); } + +void Effect::stop() +{ + requestInterruption(); + Debug(_log,"Effect \"%s\" stopped", QSTRING_CSTR(_name)); +} diff --git a/libsrc/effectengine/EffectEngine.cpp b/libsrc/effectengine/EffectEngine.cpp index 84d21e9f9..06ace054f 100644 --- a/libsrc/effectengine/EffectEngine.cpp +++ b/libsrc/effectengine/EffectEngine.cpp @@ -1,5 +1,5 @@ -// Don't use debug Python APIs on Windows -#if defined(_MSC_VER) && defined(_DEBUG) +// Don't use debug Python APIs on Windows (GitHub Actions only) +#if defined(GITHUB_ACTIONS) && defined(_MSC_VER) && defined(_DEBUG) #if _MSC_VER >= 1930 #include #endif @@ -50,21 +50,6 @@ EffectEngine::EffectEngine(Hyperion * hyperion) EffectEngine::~EffectEngine() { - for (Effect * effect : _activeEffects) - { - effect->wait(); - delete effect; - } -} - -QString EffectEngine::saveEffect(const QJsonObject& obj) -{ - return _effectFileHandler->saveEffect(obj); -} - -QString EffectEngine::deleteEffect(const QString& effectName) -{ - return _effectFileHandler->deleteEffect(effectName); } std::list EffectEngine::getActiveEffects() const @@ -85,11 +70,6 @@ std::list EffectEngine::getActiveEffects() const return availableActiveEffects; } -std::list EffectEngine::getEffectSchemas() const -{ - return _effectFileHandler->getEffectSchemas(); -} - void EffectEngine::cacheRunningEffects() { _cachedActiveEffects.clear(); @@ -219,11 +199,10 @@ int EffectEngine::runEffectScript(const QString &script, const QString &name, co connect(effect, &Effect::setInput, _hyperion, &Hyperion::setInput, Qt::QueuedConnection); connect(effect, &Effect::setInputImage, _hyperion, &Hyperion::setInputImage, Qt::QueuedConnection); connect(effect, &QThread::finished, this, &EffectEngine::effectFinished); - connect(_hyperion, &Hyperion::finished, effect, &Effect::requestInterruption, Qt::DirectConnection); _activeEffects.push_back(effect); // start the effect - Debug(_log, "Start the effect: name [%s]", QSTRING_CSTR(name)); + Debug(_log, "Start the effect: \"%s\"", QSTRING_CSTR(name)); _hyperion->registerInput(priority, hyperion::COMP_EFFECT, origin, name ,smoothCfg); effect->start(); @@ -252,25 +231,92 @@ void EffectEngine::allChannelsCleared() } } +void EffectEngine::stopAllEffects() +{ + _remainingEffects = _activeEffects.size(); + + for (auto it = _activeEffects.begin(); it != _activeEffects.end();) + { + Effect* effect = *it; + + Debug(_log, "Currently active effects: %d", _remainingEffects); + + if (effect) + { + connect(effect, &Effect::finished, this, &EffectEngine::onEffectFinished, Qt::QueuedConnection); + QMetaObject::invokeMethod(effect, "stop", Qt::QueuedConnection); + + effect->requestInterruption(); + + // Wait for the thread to finish + if (effect->isRunning()) + { + effect->wait(); + } + + // Check if the effect has already been cleaned up in effectFinished + if (std::find(_activeEffects.begin(), _activeEffects.end(), effect) != _activeEffects.end()) + { + // Remove from list, cleanup handled in effectFinished + it = _activeEffects.erase(it); + } + else + { + ++it; // Effect was already handled, move to the next + } + } + else + { + ++it; + } + } + + // Wait until all instances have finished + waitForEffectsToStop(); + + Debug(_log, "All effects are stopped"); +} + void EffectEngine::effectFinished() { Effect* effect = qobject_cast(sender()); - if (!effect->isInterruptionRequested()) + if (!effect) + return; + + Info(_log, "Effect \"%s\" finished", QSTRING_CSTR(effect->getName())); + + auto it = std::find(_activeEffects.begin(), _activeEffects.end(), effect); + if (it != _activeEffects.end()) { - // effect stopped by itself. Clear the channel - _hyperion->clear(effect->getPriority()); + _activeEffects.erase(it); + effect->deleteLater(); } +} - Info( _log, "Effect [%s] finished", QSTRING_CSTR(effect->getName())); - for (auto effectIt = _activeEffects.begin(); effectIt != _activeEffects.end(); ++effectIt) +void EffectEngine::onEffectFinished() +{ + // Decrement the count of remaining effects + if (--_remainingEffects == 0) { - if (*effectIt == effect) - { - _activeEffects.erase(effectIt); - break; - } + // All effects have finished, exit the loop + _eventLoop.quit(); + } - // cleanup the effect - effect->deleteLater(); + emit isStopCompleted(); +} + +void EffectEngine::waitForEffectsToStop() +{ + // Only wait if there are instances to wait for + if (_remainingEffects > 0) + { + Debug(_log, "%d effect(s) still running. Wait for completion...", _remainingEffects); + _eventLoop.exec(); // Blocks until all effects are done + } + else + { + Debug(_log, "No effects currently running"); + emit isStopCompleted(); + } } diff --git a/libsrc/effectengine/EffectFileHandler.cpp b/libsrc/effectengine/EffectFileHandler.cpp index 5d441b7de..7cb81e755 100644 --- a/libsrc/effectengine/EffectFileHandler.cpp +++ b/libsrc/effectengine/EffectFileHandler.cpp @@ -30,6 +30,16 @@ void EffectFileHandler::handleSettingsUpdate(settings::type type, const QJsonDoc if (type == settings::EFFECTS) { _effectConfig = config.object(); + + QJsonArray effectPathArray = _effectConfig["paths"].toArray(); + + // TODO: Remove workaround and move effect config to global settings + if (effectPathArray.empty()) + { + effectPathArray.append("$ROOT/custom-effects"); + } + _effectConfig["paths"] = effectPathArray; + // update effects and schemas updateEffects(); } diff --git a/libsrc/effectengine/EffectModule.cpp b/libsrc/effectengine/EffectModule.cpp index 4a15b545d..c6ba1881f 100644 --- a/libsrc/effectengine/EffectModule.cpp +++ b/libsrc/effectengine/EffectModule.cpp @@ -1110,7 +1110,5 @@ PyObject* EffectModule::wrapImageResetT(PyObject* self, PyObject* args) PyObject* EffectModule::wrapLowestUpdateInterval(PyObject* self, PyObject* args) { - qDebug() << "_lowestUpdateIntervalInSeconds: " << getEffect()->_lowestUpdateIntervalInSeconds; - return Py_BuildValue("d", getEffect()->_lowestUpdateIntervalInSeconds); } diff --git a/libsrc/flatbufserver/FlatBufferClient.cpp b/libsrc/flatbufserver/FlatBufferClient.cpp index f1659585b..5ca102a72 100644 --- a/libsrc/flatbufserver/FlatBufferClient.cpp +++ b/libsrc/flatbufserver/FlatBufferClient.cpp @@ -3,25 +3,37 @@ // qt #include -#include #include #include +#include +#include + +#include "hyperion_reply_generated.h" + +// Constants +namespace { +const int FLATBUFFER_PRIORITY_MIN = 100; +const int FLATBUFFER_PRIORITY_MAX = 199; +const int FLATBUFFER_MAX_MSG_LENGTH = 10'000'000; +} //End of constants FlatBufferClient::FlatBufferClient(QTcpSocket* socket, int timeout, QObject *parent) : QObject(parent) , _log(Logger::getInstance("FLATBUFSERVER")) , _socket(socket) - , _clientAddress("@"+socket->peerAddress().toString()) - , _timeoutTimer(new QTimer(this)) + , _clientAddress(socket->peerAddress().toString()) + , _timeoutTimer(nullptr) , _timeout(timeout * 1000) , _priority() + , _processingMessage(false) { _imageResampler.setPixelDecimation(1); // timer setup + _timeoutTimer.reset(new QTimer(this)); _timeoutTimer->setSingleShot(true); _timeoutTimer->setInterval(_timeout); - connect(_timeoutTimer, &QTimer::timeout, this, &FlatBufferClient::forceClose); + connect(_timeoutTimer.get(), &QTimer::timeout, this, &FlatBufferClient::noDataReceived); // connect socket signals connect(_socket, &QTcpSocket::readyRead, this, &FlatBufferClient::readyRead); @@ -35,37 +47,75 @@ void FlatBufferClient::setPixelDecimation(int decimator) void FlatBufferClient::readyRead() { - _timeoutTimer->start(); + if (_socket == nullptr) { return; } - _receiveBuffer += _socket->readAll(); + while (_socket->bytesAvailable() > 0) + { + _timeoutTimer->start(); + _receiveBuffer += _socket->readAll(); + processNextMessage(); + } +} - // check if we can read a header - while(_receiveBuffer.size() >= 4) +void FlatBufferClient::processNextMessage() +{ + if (_processingMessage) { return; } // Avoid re-entrancy + + // Wait for at least 4 bytes to read the message size + if (_receiveBuffer.size() < 4) { + return; + } + + _processingMessage = true; + + uint32_t messageSize; + memcpy(&messageSize, _receiveBuffer.constData(), sizeof(uint32_t)); + messageSize = qFromBigEndian(messageSize); + + // Validate message size + if (messageSize == 0 || messageSize > FLATBUFFER_MAX_MSG_LENGTH) { - uint32_t messageSize = - ((_receiveBuffer[0]<<24) & 0xFF000000) | - ((_receiveBuffer[1]<<16) & 0x00FF0000) | - ((_receiveBuffer[2]<< 8) & 0x0000FF00) | - ((_receiveBuffer[3] ) & 0x000000FF); + Warning(_log, "Invalid message size: %d - dropping received data", messageSize); + _receiveBuffer.clear(); + _processingMessage = false; + return; + } - // check if we can read a complete message - if((uint32_t) _receiveBuffer.size() < messageSize + 4) return; + // Wait for full message + if (_receiveBuffer.size() < static_cast(messageSize + 4)) + { + _processingMessage = false; + return; + } - // extract message only and remove header + msg from buffer :: QByteArray::remove() does not return the removed data - const QByteArray msg = _receiveBuffer.mid(4, messageSize); - _receiveBuffer.remove(0, messageSize + 4); + // Extract the message and remove it from the buffer + _lastMessage = _receiveBuffer.mid(4, messageSize); + _receiveBuffer.remove(0, messageSize + 4); - const auto* msgData = reinterpret_cast(msg.constData()); - flatbuffers::Verifier verifier(msgData, messageSize); + const uint8_t* msgData = reinterpret_cast(_lastMessage.constData()); + flatbuffers::Verifier verifier(msgData, messageSize); - if (hyperionnet::VerifyRequestBuffer(verifier)) - { - auto message = hyperionnet::GetRequest(msgData); - handleMessage(message); - continue; - } - sendErrorReply("Unable to parse message"); + if (!hyperionnet::VerifyRequestBuffer(verifier)) { + Error(_log, "Invalid FlatBuffer message received"); + sendErrorReply("Invalid FlatBuffer message received"); + _processingMessage = false; + QMetaObject::invokeMethod(this, &FlatBufferClient::processNextMessage, Qt::QueuedConnection); + return; } + + // Invoke message handling + QMetaObject::invokeMethod(this, [this]() { + const auto* msgData = reinterpret_cast(_lastMessage.constData()); + handleMessage(hyperionnet::GetRequest(msgData)); + _processingMessage = false; + QMetaObject::invokeMethod(this, &FlatBufferClient::processNextMessage, Qt::QueuedConnection); + }); +} + +void FlatBufferClient::noDataReceived() +{ + Error(_log,"No data received for %dms - drop connection with client \"%s\"",_timeout, QSTRING_CSTR(QString("%1@%2").arg(_origin, _clientAddress))); + forceClose(); } void FlatBufferClient::forceClose() @@ -75,35 +125,50 @@ void FlatBufferClient::forceClose() void FlatBufferClient::disconnected() { - Debug(_log, "Socket Closed"); + Debug(_log, "Disconnected client \"%s\"", QSTRING_CSTR(QString("%1@%2").arg(_origin, _clientAddress))); _socket->deleteLater(); - if (_priority != 0 && _priority >= 100 && _priority < 200) + if (_priority != 0 && _priority >= FLATBUFFER_PRIORITY_MIN && _priority <= FLATBUFFER_PRIORITY_MAX) + { emit clearGlobalInput(_priority); + } emit clientDisconnected(); } -void FlatBufferClient::handleMessage(const hyperionnet::Request * req) +void FlatBufferClient::handleMessage(const hyperionnet::Request* req) { - const void* reqPtr; - if ((reqPtr = req->command_as_Color()) != nullptr) { - handleColorCommand(static_cast(reqPtr)); - } else if ((reqPtr = req->command_as_Image()) != nullptr) { - handleImageCommand(static_cast(reqPtr)); - } else if ((reqPtr = req->command_as_Clear()) != nullptr) { - handleClearCommand(static_cast(reqPtr)); - } else if ((reqPtr = req->command_as_Register()) != nullptr) { - handleRegisterCommand(static_cast(reqPtr)); - } else { + if (req == nullptr) { + sendErrorReply("Received null or invalid request."); + return; + } + + // Check command type and handle accordingly + if (req->command_as_Color() != nullptr) + { + handleColorCommand(req->command_as_Color()); + } + else if (req->command_as_Image() != nullptr) + { + handleImageCommand(req->command_as_Image()); + } + else if (req->command_as_Clear() != nullptr) + { + handleClearCommand(req->command_as_Clear()); + } + else if (req->command_as_Register() != nullptr) + { + handleRegisterCommand(req->command_as_Register()); + } + else + { sendErrorReply("Received invalid packet."); } } - void FlatBufferClient::handleColorCommand(const hyperionnet::Color *colorReq) { // extract parameters const int32_t rgbData = colorReq->data(); - std::vector color{ ColorRgb{ uint8_t(qRed(rgbData)), uint8_t(qGreen(rgbData)), uint8_t(qBlue(rgbData)) } }; + std::vector const color{ ColorRgb{ uint8_t(qRed(rgbData)), uint8_t(qGreen(rgbData)), uint8_t(qBlue(rgbData)) } }; // set output emit setGlobalInputColor(_priority, color, colorReq->duration()); @@ -112,39 +177,26 @@ void FlatBufferClient::handleColorCommand(const hyperionnet::Color *colorReq) sendSuccessReply(); } -void FlatBufferClient::registationRequired(int priority) -{ - if (_priority == priority) - { - auto reply = hyperionnet::CreateReplyDirect(_builder, nullptr, -1, -1); - _builder.Finish(reply); - - // send reply - sendMessage(); - - _builder.Clear(); - } -} - void FlatBufferClient::handleRegisterCommand(const hyperionnet::Register *regReq) { - if (regReq->priority() < 100 || regReq->priority() >= 200) + if (regReq->priority() < FLATBUFFER_PRIORITY_MIN || regReq->priority() > FLATBUFFER_PRIORITY_MAX) { - Error(_log, "Register request from client %s contains invalid priority %d. Valid priority for Flatbuffer connections is between 100 and 199.", QSTRING_CSTR(_clientAddress), regReq->priority()); - sendErrorReply("The priority " + std::to_string(regReq->priority()) + " is not in the priority range between 100 and 199."); + Error(_log, "Register request from client \"%s\" contains invalid priority %d. Valid priority for Flatbuffer connections is between %d and %d.", QSTRING_CSTR(_clientAddress), regReq->priority(), FLATBUFFER_PRIORITY_MIN, FLATBUFFER_PRIORITY_MAX); + + QString const errorText = QString("The priority %1 is not in the priority range between %2 and %3").arg(regReq->priority(), FLATBUFFER_PRIORITY_MIN, FLATBUFFER_PRIORITY_MAX); + sendErrorReply(errorText); return; } _priority = regReq->priority(); - emit registerGlobalInput(_priority, hyperion::COMP_FLATBUFSERVER, regReq->origin()->c_str()+_clientAddress); + _origin = regReq->origin()->c_str(); + emit registerGlobalInput(_priority, hyperion::COMP_FLATBUFSERVER, QSTRING_CSTR(QString("%1@%2").arg(_origin, _clientAddress))); - auto reply = hyperionnet::CreateReplyDirect(_builder, nullptr, -1, (_priority ? _priority : -1)); + _builder.Clear(); + auto reply = hyperionnet::CreateReplyDirect(_builder, nullptr, -1, ((_priority != 0) ? _priority : -1)); _builder.Finish(reply); - // send reply - sendMessage(); - - _builder.Clear(); + sendMessage(_builder.GetBufferPointer(), _builder.GetSize()); } void FlatBufferClient::handleImageCommand(const hyperionnet::Image *image) @@ -152,11 +204,10 @@ void FlatBufferClient::handleImageCommand(const hyperionnet::Image *image) Image imageRGB; // extract parameters - int duration = image->duration(); - const void* reqPtr; - if ((reqPtr = image->data_as_RawImage()) != nullptr) + int const duration = image->duration(); + if (image->data_as_RawImage() != nullptr) { - const auto* img = static_cast(reqPtr); + const auto* img = static_cast(image->data_as_RawImage()); hyperionnet::RawImageT rawImageNative; img->UnPackTo(&rawImageNative); @@ -171,7 +222,7 @@ void FlatBufferClient::handleImageCommand(const hyperionnet::Image *image) } // check consistency of the size of the received data - int bytesPerPixel = rawImageNative.data.size() / (width * height); + int const bytesPerPixel = rawImageNative.data.size() / (width * height); if (bytesPerPixel != 3 && bytesPerPixel != 4) { sendErrorReply("Size of image data does not match with the width and height"); @@ -181,9 +232,9 @@ void FlatBufferClient::handleImageCommand(const hyperionnet::Image *image) imageRGB.resize(width, height); processRawImage(rawImageNative, bytesPerPixel, _imageResampler, imageRGB); } - else if ((reqPtr = image->data_as_NV12Image()) != nullptr) + else if (image->data_as_NV12Image() != nullptr) { - const auto* img = static_cast(reqPtr); + const auto* img = static_cast(image->data_as_NV12Image()); hyperionnet::NV12ImageT nv12ImageNative; img->UnPackTo(&nv12ImageNative); @@ -199,7 +250,6 @@ void FlatBufferClient::handleImageCommand(const hyperionnet::Image *image) imageRGB.resize(width, height); processNV12Image(nv12ImageNative, _imageResampler, imageRGB); - } else { @@ -220,7 +270,8 @@ void FlatBufferClient::handleClearCommand(const hyperionnet::Clear *clear) const int priority = clear->priority(); // Check if we are clearing ourselves. - if (priority == _priority) { + if (priority == _priority) + { _priority = -1; } @@ -234,82 +285,83 @@ void FlatBufferClient::handleNotImplemented() sendErrorReply("Command not implemented"); } -void FlatBufferClient::sendMessage() +void FlatBufferClient::sendMessage(const uint8_t* data, size_t size) { - auto size = _builder.GetSize(); - const uint8_t* buffer = _builder.GetBufferPointer(); - uint8_t sizeData[] = {uint8_t(size >> 24), uint8_t(size >> 16), uint8_t(size >> 8), uint8_t(size)}; - _socket->write((const char *) sizeData, sizeof(sizeData)); - _socket->write((const char *)buffer, size); + _timeoutTimer->start(); + const uint8_t header[4] = { + uint8_t((size >> 24) & 0xFF), + uint8_t((size >> 16) & 0xFF), + uint8_t((size >> 8) & 0xFF), + uint8_t((size ) & 0xFF) + }; + + // write message + _socket->write(reinterpret_cast(header), sizeof(header)); + _socket->write(reinterpret_cast(data), size); _socket->flush(); } void FlatBufferClient::sendSuccessReply() { - auto reply = hyperionnet::CreateReplyDirect(_builder); + _builder.Clear(); + auto reply = hyperionnet::CreateReplyDirect(_builder, nullptr, -1, ((_priority != 0) ? _priority : -1)); _builder.Finish(reply); - // send reply - sendMessage(); - - _builder.Clear(); + sendMessage(_builder.GetBufferPointer(), _builder.GetSize()); } -void FlatBufferClient::sendErrorReply(const std::string &error) +void FlatBufferClient::sendErrorReply(const QString& error) { - // create reply - auto reply = hyperionnet::CreateReplyDirect(_builder, error.c_str()); + _builder.Clear(); + auto reply = hyperionnet::CreateReplyDirect(_builder, QSTRING_CSTR(error)); _builder.Finish(reply); - // send reply - sendMessage(); - - _builder.Clear(); + sendMessage(_builder.GetBufferPointer(), _builder.GetSize()); } inline void FlatBufferClient::processRawImage(const hyperionnet::RawImageT& raw_image, int bytesPerPixel, ImageResampler& resampler, Image& outputImage) { - int width = raw_image.width; - int height = raw_image.height; + int const width = raw_image.width; + int const height = raw_image.height; - int lineLength = width * bytesPerPixel; - PixelFormat pixelFormat = (bytesPerPixel == 4) ? PixelFormat::RGB32 : PixelFormat::RGB24; + int const lineLength = width * bytesPerPixel; + PixelFormat const pixelFormat = (bytesPerPixel == 4) ? PixelFormat::RGB32 : PixelFormat::RGB24; // Process the image resampler.processImage( - raw_image.data.data(), // Raw RGB/RGBA buffer - width, // Image width - height, // Image height - lineLength, // Line length - pixelFormat, // Pixel format (RGB24/RGB32) - outputImage // Output image - ); + raw_image.data.data(), // Raw RGB/RGBA buffer + width, // Image width + height, // Image height + lineLength, // Line length + pixelFormat, // Pixel format (RGB24/RGB32) + outputImage // Output image + ); } inline void FlatBufferClient::processNV12Image(const hyperionnet::NV12ImageT& nv12_image, ImageResampler& resampler, Image& outputImage) { // Combine data_y and data_uv into a single buffer - int width = nv12_image.width; - int height = nv12_image.height; + int const width = nv12_image.width; + int const height = nv12_image.height; - size_t y_size = nv12_image.data_y.size(); - size_t uv_size = nv12_image.data_uv.size(); + size_t const y_size = nv12_image.data_y.size(); + size_t const uv_size = nv12_image.data_uv.size(); std::vector combined_buffer(y_size + uv_size); std::memcpy(combined_buffer.data(), nv12_image.data_y.data(), y_size); std::memcpy(combined_buffer.data() + y_size, nv12_image.data_uv.data(), uv_size); // Determine line length (stride_y) - int lineLength = nv12_image.stride_y > 0 ? nv12_image.stride_y : width; + int const lineLength = nv12_image.stride_y > 0 ? nv12_image.stride_y : width; - PixelFormat pixelFormat = PixelFormat::NV12; + PixelFormat const pixelFormat = PixelFormat::NV12; // Process the image resampler.processImage( - combined_buffer.data(), // Combined NV12 buffer - width, // Image width - height, // Image height - lineLength, // Line length for Y plane - pixelFormat, // Pixel format (NV12) - outputImage // Output image - ); -} \ No newline at end of file + combined_buffer.data(), // Combined NV12 buffer + width, // Image width + height, // Image height + lineLength, // Line length for Y plane + pixelFormat, // Pixel format (NV12) + outputImage // Output image + ); +} diff --git a/libsrc/flatbufserver/FlatBufferClient.h b/libsrc/flatbufserver/FlatBufferClient.h index 24eca77b8..d6064349e 100644 --- a/libsrc/flatbufserver/FlatBufferClient.h +++ b/libsrc/flatbufserver/FlatBufferClient.h @@ -1,19 +1,19 @@ -#pragma once +#ifndef FLATBUFFERCLIENT_H +#define FLATBUFFERCLIENT_H // util #include #include #include -#include #include #include "utils/ImageResampler.h" // flatbuffer FBS -#include "hyperion_reply_generated.h" #include "hyperion_request_generated.h" -class QTcpSocket; -class QTimer; +#include +#include +#include namespace flatbuf { class HyperionRequest; @@ -68,21 +68,20 @@ class FlatBufferClient : public QObject void clientDisconnected(); public slots: - /// - /// @brief Requests a registration from the client - /// - void registationRequired(int priority); /// /// @brief close the socket and call disconnected() /// void forceClose(); + void noDataReceived(); + private slots: /// /// @brief Is called whenever the socket got new data to read /// void readyRead(); + void processNextMessage(); /// /// @brief Is called when the socket closed the connection, also requests thread exit @@ -126,8 +125,10 @@ private slots: /// /// Send a message to the connected client + /// @param data to be send + /// @param size /// - void sendMessage(); + void sendMessage(const uint8_t* data, size_t size); /// /// Send a standard reply indicating success @@ -139,16 +140,17 @@ private slots: /// /// @param error String describing the error /// - void sendErrorReply(const std::string & error); + void sendErrorReply(const QString& error); void processRawImage(const hyperionnet::RawImageT& raw_image, int bytesPerPixel, ImageResampler& resampler, Image& outputImage); void processNV12Image(const hyperionnet::NV12ImageT& nv12_image, ImageResampler& resampler, Image& outputImage); private: - Logger *_log; - QTcpSocket *_socket; + Logger * _log; + QTcpSocket * _socket; + QString _origin; const QString _clientAddress; - QTimer *_timeoutTimer; + QScopedPointer _timeoutTimer; int _timeout; int _priority; @@ -158,4 +160,8 @@ private slots: // Flatbuffers builder flatbuffers::FlatBufferBuilder _builder; + bool _processingMessage; + QByteArray _lastMessage; }; + +#endif // FLATBUFFERCLIENT_H diff --git a/libsrc/flatbufserver/FlatBufferConnection.cpp b/libsrc/flatbufserver/FlatBufferConnection.cpp index c33889dec..fcba8ffaa 100644 --- a/libsrc/flatbufserver/FlatBufferConnection.cpp +++ b/libsrc/flatbufserver/FlatBufferConnection.cpp @@ -1,5 +1,4 @@ // stl includes -#include // Qt includes #include @@ -11,184 +10,195 @@ #include "hyperion_reply_generated.h" #include "hyperion_request_generated.h" -FlatBufferConnection::FlatBufferConnection(const QString& origin, const QString& host, int priority, bool skipReply, quint16 port) +FlatBufferConnection::FlatBufferConnection(const QString& origin, const QHostAddress& host, int priority, bool skipReply, quint16 port) : _socket() , _origin(origin) , _priority(priority) , _host(host) , _port(port) - , _prevSocketState(QAbstractSocket::UnconnectedState) , _log(Logger::getInstance("FLATBUFCONN")) - , _registered(false) + , _builder(1024) + , _isRegistered(false) { + connect(&_socket, &QTcpSocket::connected, this, &FlatBufferConnection::onConnected); + connect(&_socket, &QTcpSocket::disconnected, this, &FlatBufferConnection::onDisconnected); if(!skipReply) + { connect(&_socket, &QTcpSocket::readyRead, this, &FlatBufferConnection::readData, Qt::UniqueConnection); + } // init connect - Info(_log, "Connecting to Hyperion: %s:%u", QSTRING_CSTR(_host), _port); - connectToHost(); + connectToRemoteHost(); // start the connection timer _timer.setInterval(5000); - connect(&_timer, &QTimer::timeout, this, &FlatBufferConnection::connectToHost); + connect(&_timer, &QTimer::timeout, this, &FlatBufferConnection::connectToRemoteHost); _timer.start(); } FlatBufferConnection::~FlatBufferConnection() { - Debug(_log, "Closing connection to: %s:%u", QSTRING_CSTR(_host), _port); _timer.stop(); + Debug(_log, "Closing connection with host: %s, port [%u]", QSTRING_CSTR(_host.toString()), _port); _socket.close(); } -void FlatBufferConnection::readData() +void FlatBufferConnection::connectToRemoteHost() { - _receiveBuffer += _socket.readAll(); - - // check if we can read a header - while(_receiveBuffer.size() >= 4) + if (_socket.state() == QAbstractSocket::UnconnectedState) { - uint32_t messageSize = - ((_receiveBuffer[0]<<24) & 0xFF000000) | - ((_receiveBuffer[1]<<16) & 0x00FF0000) | - ((_receiveBuffer[2]<< 8) & 0x0000FF00) | - ((_receiveBuffer[3] ) & 0x000000FF); - - // check if we can read a complete message - if((uint32_t) _receiveBuffer.size() < messageSize + 4) return; - - // extract message only and remove header + msg from buffer :: QByteArray::remove() does not return the removed data - const QByteArray msg = _receiveBuffer.mid(4, messageSize); - _receiveBuffer.remove(0, messageSize + 4); - - const uint8_t* msgData = reinterpret_cast(msg.constData()); - flatbuffers::Verifier verifier(msgData, messageSize); - - if (hyperionnet::VerifyReplyBuffer(verifier)) - { - parseReply(hyperionnet::GetReply(msgData)); - continue; - } - Error(_log, "Unable to parse reply"); + Info(_log, "Connecting to target host: %s, port [%u]", QSTRING_CSTR(_host.toString()), _port); + _socket.connectToHost(_host, _port); } } -void FlatBufferConnection::setSkipReply(bool skip) +void FlatBufferConnection::onDisconnected() { - if(skip) - disconnect(&_socket, &QTcpSocket::readyRead, 0, 0); - else - connect(&_socket, &QTcpSocket::readyRead, this, &FlatBufferConnection::readData, Qt::UniqueConnection); + _isRegistered = false, + Info(_log, "Disconnected from target host: %s, port [%u]", QSTRING_CSTR(_host.toString()), _port); + emit isDisconnected(); + _timer.start(); } -void FlatBufferConnection::setRegister(const QString& origin, int priority) + +void FlatBufferConnection::onConnected() { - auto registerReq = hyperionnet::CreateRegister(_builder, _builder.CreateString(QSTRING_CSTR(origin)), priority); - auto req = hyperionnet::CreateRequest(_builder, hyperionnet::Command_Register, registerReq.Union()); + Info(_log, "Connected to target host: %s, port [%u]", QSTRING_CSTR(_host.toString()), _port); + if (!isClientRegistered()) + { + registerClient(_origin, _priority); + } +} - _builder.Finish(req); - uint32_t size = _builder.GetSize(); - const uint8_t header[] = { +void FlatBufferConnection::sendMessage(const uint8_t* data, size_t size) +{ + const uint8_t header[4] = { uint8_t((size >> 24) & 0xFF), uint8_t((size >> 16) & 0xFF), uint8_t((size >> 8) & 0xFF), - uint8_t((size ) & 0xFF)}; + uint8_t((size ) & 0xFF)}; // write message - int count = 0; - count += _socket.write(reinterpret_cast(header), 4); - count += _socket.write(reinterpret_cast(_builder.GetBufferPointer()), size); + _socket.write(reinterpret_cast(header), sizeof(header)); + _socket.write(reinterpret_cast(data), size); _socket.flush(); +} + +void FlatBufferConnection::registerClient(const QString& origin, int priority) +{ + Debug(_log, "Register client \"%s\" with to host: %s, port [%u]", QSTRING_CSTR(_origin), QSTRING_CSTR(_host.toString()), _port); + _builder.Clear(); + auto registerReq = hyperionnet::CreateRegister(_builder, _builder.CreateString(QSTRING_CSTR(origin)), priority); + auto req = hyperionnet::CreateRequest(_builder, hyperionnet::Command_Register, registerReq.Union()); + + _builder.Finish(req); + sendMessage(_builder.GetBufferPointer(), _builder.GetSize()); +} + +bool FlatBufferConnection::isClientRegistered() +{ + DebugIf(!_isRegistered,_log,"Client \"%s\" is not registered with target host: %s, port [%u]", QSTRING_CSTR(_origin), QSTRING_CSTR(_host.toString()), _port); + return _isRegistered; } -void FlatBufferConnection::setColor(const ColorRgb & color, int priority, int duration) +void FlatBufferConnection::setColor(const ColorRgb& color, int duration) { + if (!isClientRegistered()) return; + + _builder.Clear(); auto colorReq = hyperionnet::CreateColor(_builder, (color.red << 16) | (color.green << 8) | color.blue, duration); auto req = hyperionnet::CreateRequest(_builder, hyperionnet::Command_Color, colorReq.Union()); _builder.Finish(req); sendMessage(_builder.GetBufferPointer(), _builder.GetSize()); - _builder.Clear(); } void FlatBufferConnection::setImage(const Image &image) { - auto imgData = _builder.CreateVector(reinterpret_cast(image.memptr()), image.size()); - auto rawImg = hyperionnet::CreateRawImage(_builder, imgData, image.width(), image.height()); - auto imageReq = hyperionnet::CreateImage(_builder, hyperionnet::ImageType_RawImage, rawImg.Union(), -1); - auto req = hyperionnet::CreateRequest(_builder,hyperionnet::Command_Image,imageReq.Union()); + if (!isClientRegistered()) return; + + const uint8_t* buffer = reinterpret_cast(image.memptr()); + size_t bufferSize = image.size(); + + // Convert the buffer into QByteArray + QByteArray imageData = QByteArray::fromRawData(reinterpret_cast(buffer), static_cast(bufferSize)); + setImage(imageData, image.width(), image.height()); +} + +void FlatBufferConnection::setImage(const QByteArray& imageData, int width, int height, int duration) +{ + if (!isClientRegistered()) return; + + _builder.Clear(); + auto imageDataVector = _builder.CreateVector(reinterpret_cast(imageData.constData()), imageData.size()); + auto rawImage = hyperionnet::CreateRawImage(_builder, imageDataVector, width, height); + auto image = hyperionnet::CreateImage(_builder, hyperionnet::ImageType_RawImage, rawImage.Union(), duration); + auto req = hyperionnet::CreateRequest(_builder, hyperionnet::Command_Image, image.Union()); _builder.Finish(req); sendMessage(_builder.GetBufferPointer(), _builder.GetSize()); - _builder.Clear(); } -void FlatBufferConnection::clear(int priority) +void FlatBufferConnection::clearPriority(int priority) { + if (!isClientRegistered()) return; + + _builder.Clear(); auto clearReq = hyperionnet::CreateClear(_builder, priority); auto req = hyperionnet::CreateRequest(_builder,hyperionnet::Command_Clear, clearReq.Union()); _builder.Finish(req); sendMessage(_builder.GetBufferPointer(), _builder.GetSize()); - _builder.Clear(); } -void FlatBufferConnection::clearAll() +void FlatBufferConnection::clearAllPriorities() { - clear(-1); + clearPriority(-1); } -void FlatBufferConnection::connectToHost() +void FlatBufferConnection::readData() { - // try connection only when - if (_socket.state() == QAbstractSocket::UnconnectedState) - _socket.connectToHost(_host, _port); -} + _receiveBuffer += _socket.readAll(); -void FlatBufferConnection::sendMessage(const uint8_t* buffer, uint32_t size) -{ - // print out connection message only when state is changed - if (_socket.state() != _prevSocketState ) + // check if we can read a header + while(_receiveBuffer.size() >= 4) { - _registered = false; - switch (_socket.state() ) - { - case QAbstractSocket::UnconnectedState: - Info(_log, "No connection to Hyperion: %s:%u", QSTRING_CSTR(_host), _port); - break; - case QAbstractSocket::ConnectedState: - Info(_log, "Connected to Hyperion: %s:%u", QSTRING_CSTR(_host), _port); - break; - default: - Debug(_log, "Connecting to Hyperion: %s:%u", QSTRING_CSTR(_host), _port); - break; - } - _prevSocketState = _socket.state(); - } + uint32_t messageSize = + ((_receiveBuffer[0]<<24) & 0xFF000000) | + ((_receiveBuffer[1]<<16) & 0x00FF0000) | + ((_receiveBuffer[2]<< 8) & 0x0000FF00) | + ((_receiveBuffer[3] ) & 0x000000FF); + // check if we can read a complete message + if((uint32_t) _receiveBuffer.size() < messageSize + 4) return; - if (_socket.state() != QAbstractSocket::ConnectedState) - return; + // extract message only and remove header + msg from buffer :: QByteArray::remove() does not return the removed data + const QByteArray msg = _receiveBuffer.mid(4, messageSize); + _receiveBuffer.remove(0, messageSize + 4); + const uint8_t* msgData = reinterpret_cast(msg.constData()); + flatbuffers::Verifier verifier(msgData, messageSize); - if(!_registered) - { - setRegister(_origin, _priority); - return; + if (hyperionnet::VerifyReplyBuffer(verifier)) + { + parseReply(hyperionnet::GetReply(msgData)); + continue; + } + Error(_log, "Unable to parse reply"); } +} - const uint8_t header[] = { - uint8_t((size >> 24) & 0xFF), - uint8_t((size >> 16) & 0xFF), - uint8_t((size >> 8) & 0xFF), - uint8_t((size ) & 0xFF)}; - - // write message - int count = 0; - count += _socket.write(reinterpret_cast(header), 4); - count += _socket.write(reinterpret_cast(buffer), size); - _socket.flush(); +void FlatBufferConnection::setSkipReply(bool skip) +{ + if(skip) + { + disconnect(&_socket, &QTcpSocket::readyRead, 0, 0); + } + else + { + connect(&_socket, &QTcpSocket::readyRead, this, &FlatBufferConnection::readData, Qt::UniqueConnection); + } } bool FlatBufferConnection::parseReply(const hyperionnet::Reply *reply) @@ -197,23 +207,38 @@ bool FlatBufferConnection::parseReply(const hyperionnet::Reply *reply) { // no error set must be a success or registered or video const auto videoMode = reply->video(); - const auto registered = reply->registered(); + if (videoMode != -1) { // We got a video reply. emit setVideoMode(static_cast(videoMode)); return true; } - // We got a registered reply. - if (registered == -1 || registered != _priority) - _registered = false; - else - _registered = true; + const auto registered = reply->registered(); + if (!_isRegistered) + { + // We got a client is registered reply. + if (registered == -1 || registered != _priority) + { + registerClient(_origin, _priority); + } + else + { + _timer.stop(); + _isRegistered = true; + Debug(_log,"Client \"%s\" registered successfully with target host: %s, port [%u]", QSTRING_CSTR(_origin), QSTRING_CSTR(_host.toString()), _port); + emit isReadyToSend(); + } + } return true; } else - throw std::runtime_error(reply->error()->str()); - + { + _timer.stop(); + QString error = reply->error()->c_str(); + Error(_log, "Reply error: %s", QSTRING_CSTR(error)); + emit errorOccured(error); + } return false; } diff --git a/libsrc/flatbufserver/FlatBufferServer.cpp b/libsrc/flatbufserver/FlatBufferServer.cpp index cbddf78e0..c33412ed2 100644 --- a/libsrc/flatbufserver/FlatBufferServer.cpp +++ b/libsrc/flatbufserver/FlatBufferServer.cpp @@ -20,24 +20,22 @@ const char SERVICE_TYPE[] = "flatbuffer"; FlatBufferServer::FlatBufferServer(const QJsonDocument& config, QObject* parent) : QObject(parent) - , _server(new QTcpServer(this)) + , _server(nullptr) , _log(Logger::getInstance("FLATBUFSERVER")) , _timeout(5000) , _config(config) { - } FlatBufferServer::~FlatBufferServer() { - stopServer(); - delete _server; } void FlatBufferServer::initServer() { + _server.reset(new QTcpServer()); _netOrigin = NetOrigin::getInstance(); - connect(_server, &QTcpServer::newConnection, this, &FlatBufferServer::newConnection); + connect(_server.get(), &QTcpServer::newConnection, this, &FlatBufferServer::newConnection); // apply config handleSettingsUpdate(settings::FLATBUFSERVER, _config); @@ -54,14 +52,14 @@ void FlatBufferServer::handleSettingsUpdate(settings::type type, const QJsonDocu // port check if(_server->serverPort() != port) { - stopServer(); + stop(); _port = port; } // new timeout just for new connections _timeout = obj["timeout"].toInt(5000); // enable check - obj["enable"].toBool(true) ? startServer() : stopServer(); + obj["enable"].toBool(true) ? start() : stop(); _pixelDecimation = obj["pixelDecimation"].toInt(1); for (const auto& client : _openConnections) @@ -91,7 +89,6 @@ void FlatBufferServer::newConnection() connect(client, &FlatBufferClient::setGlobalInputImage, GlobalSignals::getInstance(), &GlobalSignals::setGlobalImage); connect(client, &FlatBufferClient::setGlobalInputColor, GlobalSignals::getInstance(), &GlobalSignals::setGlobalColor); connect(client, &FlatBufferClient::setBufferImage, GlobalSignals::getInstance(), &GlobalSignals::setBufferImage); - connect(GlobalSignals::getInstance(), &GlobalSignals::globalRegRequired, client, &FlatBufferClient::registationRequired); _openConnections.append(client); } else @@ -107,7 +104,7 @@ void FlatBufferServer::clientDisconnected() _openConnections.removeAll(client); } -void FlatBufferServer::startServer() +void FlatBufferServer::start() { if(!_server->isListening()) { @@ -124,7 +121,7 @@ void FlatBufferServer::startServer() } } -void FlatBufferServer::stopServer() +void FlatBufferServer::stop() { if(_server->isListening()) { @@ -133,6 +130,7 @@ void FlatBufferServer::stopServer() { client->forceClose(); } + _openConnections.clear(); _server->close(); Info(_log, "FlatBuffer-Server stopped"); } diff --git a/libsrc/forwarder/MessageForwarder.cpp b/libsrc/forwarder/MessageForwarder.cpp index 88322b294..07278236a 100644 --- a/libsrc/forwarder/MessageForwarder.cpp +++ b/libsrc/forwarder/MessageForwarder.cpp @@ -1,4 +1,5 @@ // STL includes +#include "hyperion/HyperionIManager.h" #include // project includes @@ -9,7 +10,9 @@ // utils includes #include +#include #include +#include // qt includes #include @@ -28,177 +31,327 @@ // Constants namespace { -const int DEFAULT_FORWARDER_FLATBUFFFER_PRIORITY = 140; - -constexpr std::chrono::milliseconds CONNECT_TIMEOUT{500}; // JSON-socket connect timeout in ms + const bool verbose = false; + const int DEFAULT_FORWARDER_FLATBUFFFER_PRIORITY = 140; + constexpr std::chrono::milliseconds JSON_SOCKET_CONNECT_TIMEOUT{ 500 }; } //End of constants -MessageForwarder::MessageForwarder(Hyperion* hyperion) - : _hyperion(hyperion) - , _log(nullptr) - , _muxer(_hyperion->getMuxerInstance()) - , _forwarder_enabled(false) - , _priority(DEFAULT_FORWARDER_FLATBUFFFER_PRIORITY) - , _messageForwarderFlatBufHelper(nullptr) +MessageForwarder::MessageForwarder(const QJsonDocument& config) + : + _log(Logger::getInstance("NETFORWARDER")) + , _config(config) + , _isActive(false) + , _priority(DEFAULT_FORWARDER_FLATBUFFFER_PRIORITY) + , _isEnabled(false) + , _toBeForwardedInstanceID(GLOABL_INSTANCE_ID) + , _hyperion(nullptr) + , _muxer(nullptr) + , _messageForwarderFlatBufHelper(nullptr) { - QString subComponent = hyperion->property("instance").toString(); - _log= Logger::getInstance("NETFORWARDER", subComponent); - qRegisterMetaType("TargetHost"); +} + +MessageForwarder::~MessageForwarder() +{ +} +void MessageForwarder::init() +{ #ifdef ENABLE_MDNS - QMetaObject::invokeMethod(MdnsBrowser::getInstance().data(), "browseForServiceType", - Qt::QueuedConnection, Q_ARG(QByteArray, MdnsServiceRegister::getServiceType("jsonapi"))); + QMetaObject::invokeMethod(_mdnsBrowser.get(), "browseForServiceType", + Qt::QueuedConnection, Q_ARG(QByteArray, MdnsServiceRegister::getServiceType("jsonapi"))); #endif - // get settings updates - connect(_hyperion, &Hyperion::settingsChanged, this, &MessageForwarder::handleSettingsUpdate); + handleSettingsUpdate(settings::NETFORWARD, _config); +} + +void MessageForwarder::start() +{ + if (_isEnabled) + { + handleTargets(true, _config.object()); + } +} - // component changes - connect(_hyperion, &Hyperion::compStateChangeRequest, this, &MessageForwarder::handleCompStateChangeRequest); +void MessageForwarder::stop() +{ + if (!_hyperion.isNull()) + { + disconnect(_toBeForwardedInstanceID); - // connect with Muxer visible priority changes - connect(_muxer, &PriorityMuxer::visiblePriorityChanged, this, &MessageForwarder::handlePriorityChanges); + Info(_log, "Forwarding service stopped"); + } } -MessageForwarder::~MessageForwarder() +bool MessageForwarder::connect(quint8 instanceID) { - stopJsonTargets(); - stopFlatbufferTargets(); + bool isConnected{ false }; + + if (instanceID == _toBeForwardedInstanceID) + { + if (HyperionIManager::getInstance()->isInstanceRunning(_toBeForwardedInstanceID)) + { + Info(_log, "Connect forwarder to instance [%u]", _toBeForwardedInstanceID); + + _hyperion = HyperionIManager::getInstance()->getHyperionInstance(_toBeForwardedInstanceID); + _muxer = _hyperion->getMuxerInstance(); + + // component changes + QObject::connect(_hyperion.get(), &Hyperion::compStateChangeRequest, this, &MessageForwarder::handleCompStateChangeRequest); + + // connect with Muxer visible priority changes + QObject::connect(_muxer.get(), &PriorityMuxer::visiblePriorityChanged, this, &MessageForwarder::handlePriorityChanges); + +#if defined(ENABLE_FLATBUF_SERVER) || defined(ENABLE_PROTOBUF_SERVER) + QObject::connect(GlobalSignals::getInstance(), &GlobalSignals::setBufferImage, _hyperion.get(), &Hyperion::forwardBufferMessage); +#endif + isConnected = true; + } + else + { + Debug(_log, "Forwarder not connected as instance [%u] is not running", _toBeForwardedInstanceID); + } + } + return isConnected; } +void MessageForwarder::disconnect(quint8 instanceID) +{ + if (instanceID == _toBeForwardedInstanceID && !_hyperion.isNull()) + { + Debug(_log, "Disconnect forwarder from instance [%u]", instanceID); + +#if defined(ENABLE_FLATBUF_SERVER) || defined(ENABLE_PROTOBUF_SERVER) + QObject::disconnect(GlobalSignals::getInstance(), &GlobalSignals::setBufferImage, _hyperion.get(), &Hyperion::forwardBufferMessage); +#endif + + handleTargets(false, _config.object()); + + _hyperion.clear(); + _muxer.clear(); + } +} void MessageForwarder::handleSettingsUpdate(settings::type type, const QJsonDocument& config) { - if (type == settings::NETFORWARD) + if (type != settings::NETFORWARD) return; + + quint8 const newInstanceID = config["instance"].toInt(GLOABL_INSTANCE_ID); + if (newInstanceID != _toBeForwardedInstanceID) { - const QJsonObject& obj = config.object(); + disconnect(_toBeForwardedInstanceID); + _toBeForwardedInstanceID = newInstanceID; + } - bool isForwarderEnabledinSettings = obj["enable"].toBool(false); - enableTargets(isForwarderEnabledinSettings, obj); + _config = config; + _isEnabled = config["enable"].toBool(false);; + + if (_isEnabled && connect(_toBeForwardedInstanceID)) + { + start(); + } + else + { + stop(); } } void MessageForwarder::handleCompStateChangeRequest(hyperion::Components component, bool enable) { - if (component == hyperion::COMP_FORWARDER && _forwarder_enabled != enable) + if (component == hyperion::COMP_FORWARDER && _isActive != enable) { - Info(_log, "Forwarder is %s", (enable ? "enabled" : "disabled")); - QJsonDocument config {_hyperion->getSetting(settings::type::NETFORWARD)}; - enableTargets(enable, config.object()); + Info(_log, "Forwarding of instance [%u] is %s", _toBeForwardedInstanceID, (enable ? "active" : "inactive")); + + if (enable) + { + if (_hyperion.isNull()) + { + connect(_toBeForwardedInstanceID); + } + handleTargets(true, _config.object()); + } + else + { + handleTargets(false, _config.object()); + } } } -void MessageForwarder::enableTargets(bool enable, const QJsonObject& config) +bool MessageForwarder::isFlatbufferComponent(int priority) { - if (!enable) - { - _forwarder_enabled = false; - stopJsonTargets(); - stopFlatbufferTargets(); + bool isFlatbufferComponent{ false }; + hyperion::Components const activeCompId = _hyperion->getPriorityInfo(priority).componentId; + switch (activeCompId) { + case hyperion::COMP_GRABBER: + case hyperion::COMP_V4L: + case hyperion::COMP_AUDIO: +#if defined(ENABLE_FLATBUF_SERVER) + case hyperion::COMP_FLATBUFSERVER: +#endif +#if defined(ENABLE_PROTOBUF_SERVER) + case hyperion::COMP_PROTOSERVER: +#endif +#if defined(ENABLE_FLATBUF_SERVER) || defined(ENABLE_PROTOBUF_SERVER) + isFlatbufferComponent = true; + break; +#endif + default: + break; } - else - { - int jsonTargetNum = startJsonTargets(config); - int flatbufTargetNum = startFlatbufferTargets(config); + return isFlatbufferComponent; +} + +bool MessageForwarder::activateFlatbufferTargets(int priority) +{ + int startedFlatbufTargets{ 0 }; - if (flatbufTargetNum > 0) + if (priority != PriorityMuxer::LOWEST_PRIORITY) + { + if (isFlatbufferComponent(priority)) { - hyperion::Components activeCompId = _hyperion->getPriorityInfo(_hyperion->getCurrentPriority()).componentId; - - switch (activeCompId) { - case hyperion::COMP_GRABBER: - connect(_hyperion, &Hyperion::forwardSystemProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage, Qt::UniqueConnection); - break; - case hyperion::COMP_V4L: - connect(_hyperion, &Hyperion::forwardV4lProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage, Qt::UniqueConnection); - break; - case hyperion::COMP_AUDIO: - connect(_hyperion, &Hyperion::forwardAudioProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage, Qt::UniqueConnection); - break; + startedFlatbufTargets = startFlatbufferTargets(_config.object()); + if (startedFlatbufTargets > 0) + { + hyperion::Components const activeCompId = _hyperion->getPriorityInfo(priority).componentId; + switch (activeCompId) { + case hyperion::COMP_GRABBER: + QObject::connect(_hyperion.get(), &Hyperion::forwardSystemProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage, Qt::UniqueConnection); + break; + case hyperion::COMP_V4L: + QObject::connect(_hyperion.get(), &Hyperion::forwardV4lProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage, Qt::UniqueConnection); + break; + case hyperion::COMP_AUDIO: + QObject::connect(_hyperion.get(), &Hyperion::forwardAudioProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage, Qt::UniqueConnection); + break; #if defined(ENABLE_FLATBUF_SERVER) - case hyperion::COMP_FLATBUFSERVER: + case hyperion::COMP_FLATBUFSERVER: #endif #if defined(ENABLE_PROTOBUF_SERVER) - case hyperion::COMP_PROTOSERVER: + case hyperion::COMP_PROTOSERVER: #endif #if defined(ENABLE_FLATBUF_SERVER) || defined(ENABLE_PROTOBUF_SERVER) - connect(_hyperion, &Hyperion::forwardBufferMessage, this, &MessageForwarder::forwardFlatbufferMessage, Qt::UniqueConnection); - break; + QObject::connect(_hyperion.get(), &Hyperion::forwardBufferMessage, this, &MessageForwarder::forwardFlatbufferMessage, Qt::UniqueConnection); + break; #endif - default: - break; + default: + break; + } } } + } - if (jsonTargetNum > 0 || flatbufTargetNum > 0) - { - _forwarder_enabled = true; - } - else + return (startedFlatbufTargets > 0); +} + +void MessageForwarder::handleTargets(bool start, const QJsonObject& config) +{ + _isActive = false; + stopJsonTargets(); + stopFlatbufferTargets(); + + if (start) + { + int const jsonTargetNum = startJsonTargets(config); + + if (!_hyperion.isNull()) { - _forwarder_enabled = false; - Warning(_log,"No JSON- nor Flatbuffer-Forwarder configured -> Forwarding disabled"); + int const currentPriority = _hyperion->getCurrentPriority(); + bool const isActiveFlatbufferTarget = activateFlatbufferTargets(currentPriority); + + if (jsonTargetNum > 0 || isActiveFlatbufferTarget) + { + _isActive = true; + } + else + { + _isActive = false; + Warning(_log, "No JSON- nor Flatbuffer targets configured/active -> Forwarding deactivated"); + } } } - _hyperion->setNewComponentState(hyperion::COMP_FORWARDER, _forwarder_enabled); + + if (!_hyperion.isNull()) + { + _hyperion->setNewComponentState(hyperion::COMP_FORWARDER, _isActive); + } } -void MessageForwarder::handlePriorityChanges(int priority) +void MessageForwarder::disconnectFlatBufferComponents(int priority) { - if (priority != 0 && _forwarder_enabled) + if (_hyperion.isNull()) { - hyperion::Components activeCompId = _hyperion->getPriorityInfo(priority).componentId; + return; + } + + hyperion::Components const activeCompId = _hyperion->getPriorityInfo(priority).componentId; - switch (activeCompId) { - case hyperion::COMP_GRABBER: - disconnect(_hyperion, &Hyperion::forwardV4lProtoMessage, nullptr, nullptr); - disconnect(_hyperion, &Hyperion::forwardAudioProtoMessage, nullptr, nullptr); + switch (activeCompId) { + case hyperion::COMP_GRABBER: + QObject::disconnect(_hyperion.get(), &Hyperion::forwardV4lProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage); + QObject::disconnect(_hyperion.get(), &Hyperion::forwardAudioProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage); #if defined(ENABLE_FLATBUF_SERVER) || defined(ENABLE_PROTOBUF_SERVER) - disconnect(_hyperion, &Hyperion::forwardBufferMessage, nullptr, nullptr); + QObject::disconnect(_hyperion.get(), &Hyperion::forwardBufferMessage, this, &MessageForwarder::forwardFlatbufferMessage); #endif - connect(_hyperion, &Hyperion::forwardSystemProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage, Qt::UniqueConnection); - break; - case hyperion::COMP_V4L: - disconnect(_hyperion, &Hyperion::forwardSystemProtoMessage, nullptr, nullptr); - disconnect(_hyperion, &Hyperion::forwardAudioProtoMessage, nullptr, nullptr); + break; + case hyperion::COMP_V4L: + QObject::disconnect(_hyperion.get(), &Hyperion::forwardSystemProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage); + QObject::disconnect(_hyperion.get(), &Hyperion::forwardAudioProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage); #if defined(ENABLE_FLATBUF_SERVER) || defined(ENABLE_PROTOBUF_SERVER) - disconnect(_hyperion, &Hyperion::forwardBufferMessage, nullptr, nullptr); + QObject::disconnect(_hyperion.get(), &Hyperion::forwardBufferMessage, this, &MessageForwarder::forwardFlatbufferMessage); #endif - connect(_hyperion, &Hyperion::forwardV4lProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage, Qt::UniqueConnection); - break; - case hyperion::COMP_AUDIO: - disconnect(_hyperion, &Hyperion::forwardSystemProtoMessage, nullptr, nullptr); - disconnect(_hyperion, &Hyperion::forwardV4lProtoMessage, nullptr, nullptr); + break; + case hyperion::COMP_AUDIO: + QObject::disconnect(_hyperion.get(), &Hyperion::forwardSystemProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage); + QObject::disconnect(_hyperion.get(), &Hyperion::forwardV4lProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage); #if defined(ENABLE_FLATBUF_SERVER) || defined(ENABLE_PROTOBUF_SERVER) - disconnect(_hyperion, &Hyperion::forwardBufferMessage, nullptr, nullptr); + QObject::disconnect(_hyperion.get(), &Hyperion::forwardBufferMessage, this, &MessageForwarder::forwardFlatbufferMessage); #endif - connect(_hyperion, &Hyperion::forwardAudioProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage, Qt::UniqueConnection); - break; + break; #if defined(ENABLE_FLATBUF_SERVER) - case hyperion::COMP_FLATBUFSERVER: + case hyperion::COMP_FLATBUFSERVER: #endif #if defined(ENABLE_PROTOBUF_SERVER) - case hyperion::COMP_PROTOSERVER: + case hyperion::COMP_PROTOSERVER: #endif #if defined(ENABLE_FLATBUF_SERVER) || defined(ENABLE_PROTOBUF_SERVER) - disconnect(_hyperion, &Hyperion::forwardAudioProtoMessage, nullptr, nullptr); - disconnect(_hyperion, &Hyperion::forwardSystemProtoMessage, nullptr, nullptr); - disconnect(_hyperion, &Hyperion::forwardV4lProtoMessage, nullptr, nullptr); - connect(_hyperion, &Hyperion::forwardBufferMessage, this, &MessageForwarder::forwardFlatbufferMessage, Qt::UniqueConnection); - break; + QObject::disconnect(_hyperion.get(), &Hyperion::forwardAudioProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage); + QObject::disconnect(_hyperion.get(), &Hyperion::forwardSystemProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage); + QObject::disconnect(_hyperion.get(), &Hyperion::forwardV4lProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage); + break; #endif - default: - disconnect(_hyperion, &Hyperion::forwardSystemProtoMessage, nullptr, nullptr); - disconnect(_hyperion, &Hyperion::forwardV4lProtoMessage, nullptr, nullptr); - disconnect(_hyperion, &Hyperion::forwardAudioProtoMessage, nullptr, nullptr); + default: + QObject::disconnect(_hyperion.get(), &Hyperion::forwardSystemProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage); + QObject::disconnect(_hyperion.get(), &Hyperion::forwardV4lProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage); + QObject::disconnect(_hyperion.get(), &Hyperion::forwardAudioProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage); #if defined(ENABLE_FLATBUF_SERVER) || defined(ENABLE_PROTOBUF_SERVER) - disconnect(_hyperion, &Hyperion::forwardBufferMessage, nullptr, nullptr); + QObject::disconnect(_hyperion.get(), &Hyperion::forwardBufferMessage, this, &MessageForwarder::forwardFlatbufferMessage); #endif - break; + break; + } +} + +void MessageForwarder::handlePriorityChanges(int priority) +{ + if (priority != 0) + { + disconnectFlatBufferComponents(priority); + if (!isFlatbufferComponent(priority) || priority == PriorityMuxer::LOWEST_PRIORITY) + { + stopFlatbufferTargets(); + } + else + { + if (_isActive) + { + activateFlatbufferTargets(priority); + } + else + { + start(); + } } } } @@ -207,25 +360,30 @@ void MessageForwarder::addJsonTarget(const QJsonObject& targetConfig) { TargetHost targetHost; - QString hostName = targetConfig["host"].toString(); + QString const hostName = targetConfig["host"].toString(); int port = targetConfig["port"].toInt(); if (!hostName.isEmpty()) { + if (_hyperion.isNull()) + { + return; + } + if (NetUtils::resolveHostToAddress(_log, hostName, targetHost.host, port)) { - QString address = targetHost.host.toString(); + QString const address = targetHost.host.toString(); if (hostName != address) { - Info(_log, "Resolved hostname [%s] to address [%s]", QSTRING_CSTR(hostName), QSTRING_CSTR(address)); + Debug(_log, "Resolved hostname [%s] to address [%s]", QSTRING_CSTR(hostName), QSTRING_CSTR(address)); } if (NetUtils::isValidPort(_log, port, targetHost.host.toString())) { targetHost.port = static_cast(port); - // verify loop with JSON-server - const QJsonObject& obj = _hyperion->getSetting(settings::JSONSERVER).object(); + // check for loop with JSON-server + const QJsonObject& obj = _settings.getSettings(settings::JSONSERVER); if ((QNetworkInterface::allAddresses().indexOf(targetHost.host) != -1) && targetHost.port == static_cast(obj["port"].toInt())) { Error(_log, "Loop between JSON-Server and Forwarder! Configuration for host: %s, port: %d is ignored.", QSTRING_CSTR(targetHost.host.toString()), port); @@ -234,7 +392,18 @@ void MessageForwarder::addJsonTarget(const QJsonObject& targetConfig) { if (_jsonTargets.indexOf(targetHost) == -1) { - Debug(_log, "JSON-Forwarder settings: Adding target host: %s port: %u", QSTRING_CSTR(targetHost.host.toString()), targetHost.port); + QJsonArray const targetInstanceIds = targetConfig["instanceIds"].toArray(); + + if (targetInstanceIds.contains(255)) + { + targetHost.instanceIds = { "all" }; + } + else + { + targetHost.instanceIds = targetInstanceIds; + } + + Debug(_log, "JSON-Forwarder settings: Adding target host: %s port: %u, instance-IDs: %s", QSTRING_CSTR(targetHost.host.toString()), targetHost.port, QSTRING_CSTR(JsonUtils::jsonValueToQString(targetHost.instanceIds))); _jsonTargets << targetHost; } else @@ -257,8 +426,7 @@ int MessageForwarder::startJsonTargets(const QJsonObject& config) #ifdef ENABLE_MDNS if (!addr.isEmpty()) { - QMetaObject::invokeMethod(MdnsBrowser::getInstance().data(), "browseForServiceType", - Qt::QueuedConnection, Q_ARG(QByteArray, MdnsServiceRegister::getServiceType("jsonapi"))); + QMetaObject::invokeMethod(MdnsBrowser::getInstance().get(), "browseForServiceType", Q_ARG(QByteArray, MdnsServiceRegister::getServiceType("jsonapi"))); } #endif @@ -271,10 +439,9 @@ int MessageForwarder::startJsonTargets(const QJsonObject& config) { for (const auto& targetHost : std::as_const(_jsonTargets)) { - Info(_log, "Forwarding now to JSON-target host: %s port: %u", QSTRING_CSTR(targetHost.host.toString()), targetHost.port); + Info(_log, "Forwarding instance [%u] now to JSON-target host: %s port: %u", _toBeForwardedInstanceID, QSTRING_CSTR(targetHost.host.toString()), targetHost.port); } - - connect(_hyperion, &Hyperion::forwardJsonMessage, this, &MessageForwarder::forwardJsonMessage, Qt::UniqueConnection); + QObject::connect(GlobalSignals::getInstance(), &GlobalSignals::forwardJsonMessage, this, &MessageForwarder::forwardJsonMessage, Qt::UniqueConnection); } } return _jsonTargets.size(); @@ -285,10 +452,10 @@ void MessageForwarder::stopJsonTargets() { if (!_jsonTargets.isEmpty()) { - disconnect(_hyperion, &Hyperion::forwardJsonMessage, nullptr, nullptr); + QObject::disconnect(GlobalSignals::getInstance(), &GlobalSignals::forwardJsonMessage, this, &MessageForwarder::forwardJsonMessage); for (const auto& targetHost : std::as_const(_jsonTargets)) { - Info(_log, "Stopped forwarding to JSON-target host: %s port: %u", QSTRING_CSTR(targetHost.host.toString()), targetHost.port); + Info(_log, "Stopped instance [%u] forwarding to JSON-target host: %s port: %u", _toBeForwardedInstanceID, QSTRING_CSTR(targetHost.host.toString()), targetHost.port); } _jsonTargets.clear(); } @@ -298,25 +465,30 @@ void MessageForwarder::addFlatbufferTarget(const QJsonObject& targetConfig) { TargetHost targetHost; - QString hostName = targetConfig["host"].toString(); + QString const hostName = targetConfig["host"].toString(); int port = targetConfig["port"].toInt(); if (!hostName.isEmpty()) { + if (_hyperion.isNull()) + { + return; + } + if (NetUtils::resolveHostToAddress(_log, hostName, targetHost.host, port)) { - QString address = targetHost.host.toString(); + QString const address = targetHost.host.toString(); if (hostName != address) { - Info(_log, "Resolved hostname [%s] to address [%s]", QSTRING_CSTR(hostName), QSTRING_CSTR(address)); + Debug(_log, "Resolved hostname [%s] to address [%s]", QSTRING_CSTR(hostName), QSTRING_CSTR(address)); } if (NetUtils::isValidPort(_log, port, targetHost.host.toString())) { targetHost.port = static_cast(port); - // verify loop with Flatbuffer-server - const QJsonObject& obj = _hyperion->getSetting(settings::FLATBUFSERVER).object(); + // check for loop with Flatbuffer-server + const QJsonObject& obj = _settings.getSettings(settings::FLATBUFSERVER); if ((QNetworkInterface::allAddresses().indexOf(targetHost.host) != -1) && targetHost.port == static_cast(obj["port"].toInt())) { Error(_log, "Loop between Flatbuffer-Server and Forwarder! Configuration for host: %s, port: %d is ignored.", QSTRING_CSTR(targetHost.host.toString()), port); @@ -347,9 +519,9 @@ int MessageForwarder::startFlatbufferTargets(const QJsonObject& config) { if (!config["flatbuffer"].isNull()) { - if (_messageForwarderFlatBufHelper == nullptr) + if (_messageForwarderFlatBufHelper.isNull()) { - _messageForwarderFlatBufHelper = new MessageForwarderFlatbufferClientsHelper(); + _messageForwarderFlatBufHelper = QSharedPointer::create(); } else { @@ -362,8 +534,7 @@ int MessageForwarder::startFlatbufferTargets(const QJsonObject& config) #ifdef ENABLE_MDNS if (!addr.isEmpty()) { - QMetaObject::invokeMethod(MdnsBrowser::getInstance().data(), "browseForServiceType", - Qt::QueuedConnection, Q_ARG(QByteArray, MdnsServiceRegister::getServiceType("flatbuffer"))); + QMetaObject::invokeMethod(MdnsBrowser::getInstance().get(), "browseForServiceType", Q_ARG(QByteArray, MdnsServiceRegister::getServiceType("flatbuffer"))); } #endif for (const auto& entry : addr) @@ -375,7 +546,7 @@ int MessageForwarder::startFlatbufferTargets(const QJsonObject& config) { for (const auto& targetHost : std::as_const(_flatbufferTargets)) { - Info(_log, "Forwarding now to Flatbuffer-target host: %s port: %u", QSTRING_CSTR(targetHost.host.toString()), targetHost.port); + Info(_log, "Forwarding instance [%u] now to Flatbuffer-target host: %s port: %u", _toBeForwardedInstanceID, QSTRING_CSTR(targetHost.host.toString()), targetHost.port); } } } @@ -386,39 +557,40 @@ void MessageForwarder::stopFlatbufferTargets() { if (!_flatbufferTargets.isEmpty()) { - disconnect(_hyperion, &Hyperion::forwardSystemProtoMessage, nullptr, nullptr); - disconnect(_hyperion, &Hyperion::forwardV4lProtoMessage, nullptr, nullptr); - disconnect(_hyperion, &Hyperion::forwardAudioProtoMessage, nullptr, nullptr); + if (!_hyperion.isNull()) + { + QObject::disconnect(_hyperion.get(), &Hyperion::forwardSystemProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage); + QObject::disconnect(_hyperion.get(), &Hyperion::forwardV4lProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage); + QObject::disconnect(_hyperion.get(), &Hyperion::forwardAudioProtoMessage, this, &MessageForwarder::forwardFlatbufferMessage); #if defined(ENABLE_FLATBUF_SERVER) || defined(ENABLE_PROTOBUF_SERVER) - disconnect(_hyperion, &Hyperion::forwardBufferMessage, nullptr, nullptr); + QObject::disconnect(_hyperion.get(), &Hyperion::forwardBufferMessage, this, &MessageForwarder::forwardFlatbufferMessage); #endif - - if (_messageForwarderFlatBufHelper != nullptr) - { - delete _messageForwarderFlatBufHelper; - _messageForwarderFlatBufHelper = nullptr; } + emit _messageForwarderFlatBufHelper->clearClients(); for (const auto& targetHost : std::as_const(_flatbufferTargets)) { - Info(_log, "Stopped forwarding to Flatbuffer-target host: %s port: %u", QSTRING_CSTR(targetHost.host.toString()), targetHost.port); + Info(_log, "Stopped instance [%u] forwarding to Flatbuffer-target host: %s port: %u", _toBeForwardedInstanceID, QSTRING_CSTR(targetHost.host.toString()), targetHost.port); } _flatbufferTargets.clear(); } } -void MessageForwarder::forwardJsonMessage(const QJsonObject& message) +void MessageForwarder::forwardJsonMessage(const QJsonObject& message, quint8 instanceId) { - if (_forwarder_enabled) + if (_isActive) { - QTcpSocket client; - for (const auto& targetHost : std::as_const(_jsonTargets)) + if (instanceId == _toBeForwardedInstanceID) { - client.connectToHost(targetHost.host, targetHost.port); - if (client.waitForConnected(CONNECT_TIMEOUT.count())) + QTcpSocket client; + for (const auto& targetHost : std::as_const(_jsonTargets)) { - sendJsonMessage(message, &client); - client.close(); + client.connectToHost(targetHost.host, targetHost.port); + if (client.waitForConnected(JSON_SOCKET_CONNECT_TIMEOUT.count())) + { + sendJsonMessage(message, &client, targetHost.instanceIds); + client.close(); + } } } } @@ -426,18 +598,18 @@ void MessageForwarder::forwardJsonMessage(const QJsonObject& message) void MessageForwarder::forwardFlatbufferMessage(const QString& /*name*/, const Image& image) { - if (_messageForwarderFlatBufHelper != nullptr) + if (_messageForwarderFlatBufHelper) { - bool isfree = _messageForwarderFlatBufHelper->isFree(); + bool const isfree = _messageForwarderFlatBufHelper->isFree(); - if (isfree && _forwarder_enabled) + if (isfree && _isActive) { - QMetaObject::invokeMethod(_messageForwarderFlatBufHelper, "forwardImage", Qt::QueuedConnection, Q_ARG(Image, image)); + QMetaObject::invokeMethod(_messageForwarderFlatBufHelper.get(), "forwardImage", Qt::QueuedConnection, Q_ARG(Image, image)); } } } -void MessageForwarder::sendJsonMessage(const QJsonObject& message, QTcpSocket* socket) +void MessageForwarder::sendJsonMessage(const QJsonObject& message, QTcpSocket* socket, const QJsonArray& targetInstanceIds) { // for hyperion classic compatibility QJsonObject jsonMessage = message; @@ -446,9 +618,16 @@ void MessageForwarder::sendJsonMessage(const QJsonObject& message, QTcpSocket* s jsonMessage["tan"] = 100; } + if (!targetInstanceIds.empty()) + { + jsonMessage["instance"] = targetInstanceIds; + } + // serialize message - QJsonDocument writer(jsonMessage); - QByteArray serializedMessage = writer.toJson(QJsonDocument::Compact) + "\n"; + QJsonDocument const writer(jsonMessage); + DebugIf(verbose, _log, "Source instance [%u], JSON-Request: [%s]", _toBeForwardedInstanceID, writer.toJson(QJsonDocument::Compact).constData()); + + QByteArray const serializedMessage = writer.toJson(QJsonDocument::Compact) + "\n"; // write message socket->write(serializedMessage); @@ -465,21 +644,46 @@ void MessageForwarder::sendJsonMessage(const QJsonObject& message, QTcpSocket* s // receive reply if (!socket->waitForReadyRead()) { - Debug(_log, "Error while writing data from host"); + Debug(_log, "Error while reading data from host"); return; } serializedReply += socket->readAll(); } + QList const replies = serializedReply.trimmed().split('\n'); // parse reply data - QJsonParseError error; - /* QJsonDocument reply = */ QJsonDocument::fromJson(serializedReply, &error); + QJsonObject response; + const QString ident = "JsonForwarderTarget@" + socket->peerAddress().toString(); + bool isParsingError{ false }; + QList errorList; - if (error.error != QJsonParseError::NoError) + for (const QByteArray& reply : replies) { - Error(_log, "Error while parsing reply: invalid JSON"); - return; + QPair const parsingResult = JsonUtils::parse(ident, reply, response, _log); + if (!parsingResult.first) + { + DebugIf(verbose, _log, "Response: [%s]", QJsonDocument(response).toJson(QJsonDocument::Compact).constData()); + isParsingError = true; + errorList.append(parsingResult.second); + } + else + { + QString reason = "No error info"; + bool const success = response["success"].toBool(false); + if (!success) + { + Debug(_log, "Source instance [%u], JSON-Request: [%s]", _toBeForwardedInstanceID, writer.toJson(QJsonDocument::Compact).constData()); + reason = response["error"].toString(reason); + Error(_log, "Request to %s failed with error: %s", QSTRING_CSTR(ident), QSTRING_CSTR(reason)); + } + } + } + + if (isParsingError) + { + QString const errorText = errorList.join(";");; + Error(_log, "Error parsing response(s. Errors: %s", QSTRING_CSTR(errorText)); } } @@ -490,22 +694,19 @@ MessageForwarderFlatbufferClientsHelper::MessageForwarderFlatbufferClientsHelper this->moveToThread(mainThread); mainThread->start(); - _free = true; - connect(this, &MessageForwarderFlatbufferClientsHelper::addClient, this, &MessageForwarderFlatbufferClientsHelper::addClientHandler); - connect(this, &MessageForwarderFlatbufferClientsHelper::clearClients, this, &MessageForwarderFlatbufferClientsHelper::clearClientsHandler); + _isFree = true; + + QObject::connect(this, &MessageForwarderFlatbufferClientsHelper::addClient, this, &MessageForwarderFlatbufferClientsHelper::addClientHandler); + QObject::connect(this, &MessageForwarderFlatbufferClientsHelper::clearClients, this, &MessageForwarderFlatbufferClientsHelper::clearClientsHandler); + } MessageForwarderFlatbufferClientsHelper::~MessageForwarderFlatbufferClientsHelper() { - _free=false; - while (!_forwardClients.isEmpty()) - { - _forwardClients.takeFirst()->deleteLater(); - } - + clearClientsHandler(); QThread* oldThread = this->thread(); - disconnect(oldThread, nullptr, nullptr, nullptr); + QObject::disconnect(oldThread, nullptr, nullptr, nullptr); oldThread->quit(); oldThread->wait(); delete oldThread; @@ -513,33 +714,33 @@ MessageForwarderFlatbufferClientsHelper::~MessageForwarderFlatbufferClientsHelpe void MessageForwarderFlatbufferClientsHelper::addClientHandler(const QString& origin, const TargetHost& targetHost, int priority, bool skipReply) { - FlatBufferConnection* flatbuf = new FlatBufferConnection(origin, targetHost.host.toString(), priority, skipReply, targetHost.port); - _forwardClients << flatbuf; - _free = true; + QSharedPointer flatbufClient = QSharedPointer::create(origin, targetHost.host, priority, skipReply, targetHost.port); + _forwardClients.append(flatbufClient); + _isFree = true; } void MessageForwarderFlatbufferClientsHelper::clearClientsHandler() { - while (!_forwardClients.isEmpty()) - { - delete _forwardClients.takeFirst(); - } - _free = false; + _forwardClients.clear(); + _isFree = false; } bool MessageForwarderFlatbufferClientsHelper::isFree() const { - return _free; + return _isFree; } void MessageForwarderFlatbufferClientsHelper::forwardImage(const Image& image) { - _free = false; + _isFree = false; for (int i = 0; i < _forwardClients.size(); i++) { - _forwardClients.at(i)->setImage(image); + if (_forwardClients.at(i)->isClientRegistered()) + { + _forwardClients.at(i)->setImage(image); + } } - _free = true; + _isFree = true; } diff --git a/libsrc/hyperion/BGEffectHandler.cpp b/libsrc/hyperion/BGEffectHandler.cpp new file mode 100644 index 000000000..2920c241e --- /dev/null +++ b/libsrc/hyperion/BGEffectHandler.cpp @@ -0,0 +1,98 @@ +#include + +#include + +BGEffectHandler::BGEffectHandler(Hyperion* hyperion) + : QObject(hyperion) + , _hyperion(hyperion) + , _isBgEffectEnabled(false) + , _isSuspended(false) +{ + QString subComponent = parent()->property("instance").toString(); + _log = Logger::getInstance("HYPERION", subComponent); + + QObject::connect(_hyperion, &Hyperion::settingsChanged, this, &BGEffectHandler::handleSettingsUpdate); + QObject::connect(_hyperion->getMuxerInstance().get(), &PriorityMuxer::prioritiesChanged, this, &BGEffectHandler::handlePriorityUpdate); + + // listen for suspend/resume requests, to not start a background effect when system goes into suspend mode + connect(_hyperion, &Hyperion::suspendRequest, this, [=] (bool isSuspended) { + _isSuspended = isSuspended; + }); + + // initialization + handleSettingsUpdate(settings::BGEFFECT, _hyperion->getSetting(settings::BGEFFECT)); +} + +void BGEffectHandler::disconnect() +{ + QObject::disconnect(_hyperion->getMuxerInstance().get(), &PriorityMuxer::prioritiesChanged, this, &BGEffectHandler::handlePriorityUpdate); + QObject::disconnect(_hyperion, &Hyperion::settingsChanged, this, &BGEffectHandler::handleSettingsUpdate); +} + +bool BGEffectHandler::_isEnabled () const +{ + return _isBgEffectEnabled; +} + +void BGEffectHandler::handleSettingsUpdate(settings::type type, const QJsonDocument& config) +{ + if(type == settings::BGEFFECT) + { + _bgEffectConfig = config; + + const QJsonObject& BGEffectConfig = _bgEffectConfig.object(); +#define BGCONFIG_ARRAY bgColorConfig.toArray() + // clear background priority + if (_hyperion->getCurrentPriority() == PriorityMuxer::BG_PRIORITY) + { + _hyperion->clear(PriorityMuxer::BG_PRIORITY); + } + _isBgEffectEnabled = BGEffectConfig["enable"].toBool(true); + + // initial background effect/color + if (_isBgEffectEnabled) + { +#if defined(ENABLE_EFFECTENGINE) + const QString bgTypeConfig = BGEffectConfig["type"].toString("effect"); + const QString bgEffectConfig = BGEffectConfig["effect"].toString("Warm mood blobs"); +#else + const QString bgTypeConfig = "color"; +#endif + const QJsonValue bgColorConfig = BGEffectConfig["color"]; + if (bgTypeConfig.contains("color")) + { + std::vector bg_color = { + ColorRgb { + static_cast(BGCONFIG_ARRAY.at(0).toInt(0)), + static_cast(BGCONFIG_ARRAY.at(1).toInt(0)), + static_cast(BGCONFIG_ARRAY.at(2).toInt(0)) + } + }; + _hyperion->setColor(PriorityMuxer::BG_PRIORITY, bg_color); + Info(_log,"Initial background color set (%d %d %d)",bg_color.at(0).red, bg_color.at(0).green, bg_color.at(0).blue); + } +#if defined(ENABLE_EFFECTENGINE) + else + { + int result = _hyperion->setEffect(bgEffectConfig, PriorityMuxer::BG_PRIORITY, PriorityMuxer::ENDLESS); + Info(_log,"Initial background effect '%s' %s", QSTRING_CSTR(bgEffectConfig), ((result == 0) ? "started" : "failed")); + } +#endif + } +#undef BGCONFIG_ARRAY + } +} + +void BGEffectHandler::handlePriorityUpdate(int currentPriority) +{ + if (currentPriority < PriorityMuxer::BG_PRIORITY && _hyperion->getMuxerInstance()->hasPriority(PriorityMuxer::BG_PRIORITY)) + { + Debug(_log,"Stop background (color-) effect as it moved out of scope"); + _hyperion->clear(PriorityMuxer::BG_PRIORITY); + } + else if (!_isSuspended && currentPriority == PriorityMuxer::LOWEST_PRIORITY && _isBgEffectEnabled) + { + Debug(_log,"Start background (color-) effect as it moved in scope"); + emit handleSettingsUpdate (settings::BGEFFECT, _bgEffectConfig); + } +} diff --git a/libsrc/hyperion/CMakeLists.txt b/libsrc/hyperion/CMakeLists.txt index b073dcf4b..903463d56 100644 --- a/libsrc/hyperion/CMakeLists.txt +++ b/libsrc/hyperion/CMakeLists.txt @@ -4,6 +4,7 @@ add_library(hyperion ${CMAKE_SOURCE_DIR}/libsrc/hyperion/AuthManager.cpp # Background Effect Handler ${CMAKE_SOURCE_DIR}/include/hyperion/BGEffectHandler.h + ${CMAKE_SOURCE_DIR}/libsrc/hyperion/BGEffectHandler.cpp # Capture Control class ${CMAKE_SOURCE_DIR}/include/hyperion/CaptureCont.h ${CMAKE_SOURCE_DIR}/libsrc/hyperion/CaptureCont.cpp diff --git a/libsrc/hyperion/ComponentRegister.cpp b/libsrc/hyperion/ComponentRegister.cpp index 9a040caf8..f6b72cb1c 100644 --- a/libsrc/hyperion/ComponentRegister.cpp +++ b/libsrc/hyperion/ComponentRegister.cpp @@ -11,7 +11,11 @@ ComponentRegister::ComponentRegister(Hyperion* hyperion) : _hyperion(hyperion) , _log(nullptr) { - QString subComponent = hyperion->property("instance").toString(); + QString subComponent {"__"}; + if (_hyperion != nullptr) + { + subComponent = hyperion->property("instance").toString(); + } _log= Logger::getInstance("COMPONENTREG", subComponent); // init all comps to false @@ -66,8 +70,11 @@ ComponentRegister::ComponentRegister(Hyperion* hyperion) _componentStates.emplace(e, (e == COMP_ALL)); } + if (hyperion != nullptr) + { connect(_hyperion, &Hyperion::compStateChangeRequest, this, &ComponentRegister::handleCompStateChangeRequest); connect(_hyperion, &Hyperion::compStateChangeRequestAll, this, &ComponentRegister::handleCompStateChangeRequestAll); + } } ComponentRegister::~ComponentRegister() diff --git a/libsrc/hyperion/Hyperion.cpp b/libsrc/hyperion/Hyperion.cpp index 83273209b..70077cfda 100644 --- a/libsrc/hyperion/Hyperion.cpp +++ b/libsrc/hyperion/Hyperion.cpp @@ -1,6 +1,5 @@ // STL includes -#include -#include +#include // QT includes #include @@ -11,10 +10,6 @@ // hyperion include #include -#if defined(ENABLE_FORWARDER) -#include -#endif - #include #include @@ -23,6 +18,7 @@ #include #include #include +#include "utils/WaitTime.h" // LedDevice includes #include @@ -56,29 +52,25 @@ namespace { constexpr std::chrono::milliseconds DEFAULT_MAX_LED_DEVICE_DATA_EMISSION_INTERVAL{ 5 }; // 200 Hz } //End of constants -Hyperion::Hyperion(quint8 instance) - : QObject() +Hyperion::Hyperion(quint8 instance, QObject* parent) + : QObject(parent) , _instIndex(instance) - , _settingsManager(new SettingsManager(instance, this)) + , _settingsManager(nullptr) , _componentRegister(nullptr) - , _ledString(LedString::createLedString(getSetting(settings::LEDS).array(), hyperion::createColorOrder(getSetting(settings::DEVICE).object()))) , _imageProcessor(nullptr) , _muxer(nullptr) - , _raw2ledAdjustment(hyperion::createLedColorsAdjustment(static_cast(_ledString.leds().size()), getSetting(settings::COLOR).object())) + , _raw2ledAdjustment(nullptr) , _ledDeviceWrapper(nullptr) , _deviceSmooth(nullptr) #if defined(ENABLE_EFFECTENGINE) , _effectEngine(nullptr) -#endif -#if defined(ENABLE_FORWARDER) - , _messageForwarder(nullptr) #endif , _log(nullptr) - , _hwLedCount() - , _ledGridSize(hyperion::getLedLayoutGridSize(getSetting(settings::LEDS).array())) + , _hwLedCount(0) + , _layoutLedCount(0) + , _colorOrder("rgb") , _BGEffectHandler(nullptr) , _captureCont(nullptr) - , _ledBuffer(_ledString.leds().size(), ColorRgb::BLACK) #if defined(ENABLE_BOBLIGHT_SERVER) , _boblightServer(nullptr) #endif @@ -91,105 +83,82 @@ Hyperion::Hyperion(quint8 instance) { qRegisterMetaType("ComponentList"); - QString subComponent = "I"+QString::number(instance); - this->setProperty("instance", (QString) subComponent); + QString const subComponent = "I"+QString::number(_instIndex); + this->setProperty("instance", QVariant::fromValue(subComponent)); _log= Logger::getInstance("HYPERION", subComponent); - - _componentRegister = new ComponentRegister(this); - _imageProcessor = new ImageProcessor(_ledString, this); - _muxer = new PriorityMuxer(static_cast(_ledString.leds().size()), this); } Hyperion::~Hyperion() { - freeObjects(); } void Hyperion::start() { - // forward settings changed to Hyperion - connect(_settingsManager, &SettingsManager::settingsChanged, this, &Hyperion::settingsChanged); + Debug(_log, "Hyperion instance starting..."); - // get newVideoMode from HyperionIManager - connect(this, &Hyperion::newVideoMode, this, &Hyperion::handleNewVideoMode); - - if (!_raw2ledAdjustment->verifyAdjustments()) - { - Warning(_log, "At least one led has no color calibration, please add all leds from your led layout to an 'LED index' field!"); - } + _settingsManager.reset(new SettingsManager(_instIndex, this)); - // handle hwLedCount - _hwLedCount = getSetting(settings::DEVICE).object()["hardwareLedCount"].toInt(getLedCount()); + // link settings changed with the current Hyperion instance + connect(_settingsManager.get(), &SettingsManager::settingsChanged, this, &Hyperion::settingsChanged); + // listen for settings updates of this instance (LEDS & COLOR) + connect(_settingsManager.get(), &SettingsManager::settingsChanged, this, &Hyperion::handleSettingsUpdate); + _componentRegister.reset(new ComponentRegister(this)); + // get newVideoMode from HyperionIManager + connect(this, &Hyperion::newVideoMode, this, &Hyperion::handleNewVideoMode); - // Initialize colororder vector - for (const Led& led : _ledString.leds()) - { - _ledStringColorOrder.push_back(led.colorOrder); - } + // handle hwLedCount + _hwLedCount = getSetting(settings::DEVICE).object()["hardwareLedCount"].toInt(1); + _colorOrder = getSetting(settings::DEVICE).object()["colorOrder"].toString("rgb"); + _muxer.reset(new PriorityMuxer(_hwLedCount, this)); // connect Hyperion::update with Muxer visible priority changes as muxer updates independent - connect(_muxer, &PriorityMuxer::visiblePriorityChanged, this, &Hyperion::update); - connect(_muxer, &PriorityMuxer::visiblePriorityChanged, this, &Hyperion::handleSourceAvailability); - connect(_muxer, &PriorityMuxer::visibleComponentChanged, this, &Hyperion::handleVisibleComponentChanged); - - // listen for suspend/resume, idle requests to perform core activation/deactivation actions - connect(this, &Hyperion::suspendRequest, this, &Hyperion::setSuspend); - connect(this, &Hyperion::idleRequest, this, &Hyperion::setIdle); + connect(_muxer.get(), &PriorityMuxer::visiblePriorityChanged, this, &Hyperion::update); + connect(_muxer.get(), &PriorityMuxer::visiblePriorityChanged, this, &Hyperion::handleSourceAvailability); + connect(_muxer.get(), &PriorityMuxer::visibleComponentChanged, this, &Hyperion::handleVisibleComponentChanged); - // listen for settings updates of this instance (LEDS & COLOR) - connect(_settingsManager, &SettingsManager::settingsChanged, this, &Hyperion::handleSettingsUpdate); + QJsonArray const ledLayout = getSetting(settings::LEDS).array(); + updateLedLayout(ledLayout); + _ledBuffer = std::vector(static_cast(_hwLedCount), ColorRgb::BLACK); - #if 0 - // set color correction activity state - const QJsonObject color = getSetting(settings::COLOR).object(); - #endif + // smoothing + _deviceSmooth.reset(new LinearColorSmoothing(getSetting(settings::SMOOTHING), this)); + connect(this, &Hyperion::settingsChanged, _deviceSmooth.get(), &LinearColorSmoothing::handleSettingsUpdate); + _deviceSmooth->start(); // initialize LED-devices - QJsonObject ledDevice = getSetting(settings::DEVICE).object(); - ledDevice["currentLedCount"] = _hwLedCount; // Inject led count info + QJsonObject const ledDeviceSettings = getSetting(settings::DEVICE).object(); - _ledDeviceWrapper = new LedDeviceWrapper(this); - connect(this, &Hyperion::compStateChangeRequest, _ledDeviceWrapper, &LedDeviceWrapper::handleComponentState); - connect(this, &Hyperion::ledDeviceData, _ledDeviceWrapper, &LedDeviceWrapper::updateLeds); - _ledDeviceWrapper->createLedDevice(ledDevice); - - // smoothing - _deviceSmooth = new LinearColorSmoothing(getSetting(settings::SMOOTHING), this); - connect(this, &Hyperion::settingsChanged, _deviceSmooth, &LinearColorSmoothing::handleSettingsUpdate); + _ledDeviceWrapper.reset(new LedDeviceWrapper(this)); + connect(this, &Hyperion::compStateChangeRequest, _ledDeviceWrapper.get(), &LedDeviceWrapper::handleComponentState); + connect(this, &Hyperion::ledDeviceData, _ledDeviceWrapper.get(), &LedDeviceWrapper::updateLeds); - //Start in pause mode, a new priority will activate smoothing (either start-effect or grabber) - _deviceSmooth->setPause(true); + _ledDeviceWrapper->createLedDevice(ledDeviceSettings); -#if defined(ENABLE_FORWARDER) - // create the message forwarder only on main instance - if (_instIndex == 0) - { - _messageForwarder = new MessageForwarder(this); - _messageForwarder->handleSettingsUpdate(settings::NETFORWARD, getSetting(settings::NETFORWARD)); - #if defined(ENABLE_FLATBUF_SERVER) || defined(ENABLE_PROTOBUF_SERVER) - connect(GlobalSignals::getInstance(), &GlobalSignals::setBufferImage, this, &Hyperion::forwardBufferMessage); - #endif - } -#endif + // listen for suspend/resume, idle requests to perform core activation/deactivation actions + connect(this, &Hyperion::suspendRequest, this, &Hyperion::setSuspend); + connect(this, &Hyperion::idleRequest, this, &Hyperion::setIdle); + + _muxer->start(); #if defined(ENABLE_EFFECTENGINE) // create the effect engine; needs to be initialized after smoothing! - _effectEngine = new EffectEngine(this); - connect(_effectEngine, &EffectEngine::effectListUpdated, this, &Hyperion::effectListUpdated); + _effectEngine.reset(new EffectEngine(this)); + connect(_effectEngine.get(), &EffectEngine::effectListUpdated, this, &Hyperion::effectListUpdated); + connect(this, &Hyperion::stopEffects, _effectEngine.get(), &EffectEngine::stopAllEffects); #endif // initial startup effect hyperion::handleInitialEffect(this, getSetting(settings::FGEFFECT).object()); // handle background effect - _BGEffectHandler = new BGEffectHandler(this); + _BGEffectHandler.reset(new BGEffectHandler(this)); // create the Daemon capture interface - _captureCont = new CaptureCont(this); + _captureCont.reset(new CaptureCont(this)); - // forwards global signals to the corresponding slots + // link global signals with the corresponding slots connect(GlobalSignals::getInstance(), &GlobalSignals::registerGlobalInput, this, &Hyperion::registerInput); connect(GlobalSignals::getInstance(), &GlobalSignals::clearGlobalInput, this, &Hyperion::clear); connect(GlobalSignals::getInstance(), &GlobalSignals::setGlobalColor, this, &Hyperion::setColor); @@ -205,144 +174,120 @@ void Hyperion::start() _ledDeviceDataTimer.start(); // Start the elapsed timer for LED-Device data throttling // if there is no startup / background effect and no sending capture interface we probably want to push once BLACK (as PrioMuxer won't emit a priority change) - update(); + refreshUpdate(); #if defined(ENABLE_BOBLIGHT_SERVER) // boblight, can't live in global scope as it depends on layout - _boblightServer = new BoblightServer(this, getSetting(settings::BOBLSERVER)); - connect(this, &Hyperion::settingsChanged, _boblightServer, &BoblightServer::handleSettingsUpdate); + _boblightServer.reset(new BoblightServer(this, getSetting(settings::BOBLSERVER))); + connect(this, &Hyperion::settingsChanged, _boblightServer.get(), &BoblightServer::handleSettingsUpdate); #endif // instance initiated, enter thread event loop emit started(); } -void Hyperion::stop() +void Hyperion::stop(const QString name) { - emit finished(); - thread()->wait(); -} + Debug(_log, "Hyperion instance [%u] - %s is stopping.", _instIndex, QSTRING_CSTR(name)); -void Hyperion::freeObjects() -{ //Disconnect Background effect first that it does not kick in when other priorities are stopped _BGEffectHandler->disconnect(); - //Remove all priorities to switch off all leds - clear(-1,true); - - // delete components on exit of hyperion core - - delete _BGEffectHandler; - #if defined(ENABLE_BOBLIGHT_SERVER) - delete _boblightServer; + _boblightServer->stop(); #endif - delete _captureCont; + //Remove all priorities + _muxer->clearAll(true); #if defined(ENABLE_EFFECTENGINE) - delete _effectEngine; -#endif + _effectEngine->stopAllEffects(); + #endif - delete _raw2ledAdjustment; + _ledDeviceWrapper->stopDevice(); + _deviceSmooth->stop(); + _muxer->stop(); -#if defined(ENABLE_FORWARDER) - delete _messageForwarder; -#endif - - delete _settingsManager; - delete _ledDeviceWrapper; - - delete _imageProcessor; - delete _muxer; - delete _componentRegister; + emit finished(name); } void Hyperion::handleSettingsUpdate(settings::type type, const QJsonDocument& config) { if(type == settings::COLOR) { - const QJsonObject obj = config.object(); - // change in color recreate ledAdjustments - delete _raw2ledAdjustment; - _raw2ledAdjustment = hyperion::createLedColorsAdjustment(static_cast(_ledString.leds().size()), obj); - if (!_raw2ledAdjustment->verifyAdjustments()) - { - Warning(_log, "At least one led has no color calibration, please add all leds from your led layout to an 'LED index' field!"); - } + updateLedColorAdjustment(_layoutLedCount, config.object()); + refreshUpdate(); } else if(type == settings::LEDS) { - const QJsonArray leds = config.array(); - #if defined(ENABLE_EFFECTENGINE) // stop and cache all running effects, as effects depend heavily on LED-layout _effectEngine->cacheRunningEffects(); #endif - // ledstring, img processor, muxer, ledGridSize (effect-engine image based effects), _ledBuffer and ByteOrder of ledstring - _ledString = LedString::createLedString(leds, hyperion::createColorOrder(getSetting(settings::DEVICE).object())); - _imageProcessor->setLedString(_ledString); - _muxer->updateLedColorsLength(static_cast(_ledString.leds().size())); - _ledGridSize = hyperion::getLedLayoutGridSize(leds); - - std::vector color(_ledString.leds().size(), ColorRgb{0,0,0}); - _ledBuffer = color; - - - _ledStringColorOrder.clear(); - for (const Led& led : _ledString.leds()) - { - _ledStringColorOrder.push_back(led.colorOrder); - } - - // handle hwLedCount update - _hwLedCount = getSetting(settings::DEVICE).object()["hardwareLedCount"].toInt(getLedCount()); - - // Limit LED data emission, if high rumber of LEDs configured - _rawLedDataEmissionInterval = (_ledString.leds().size() > 1000) ? 2 * DEFAULT_MAX_RAW_LED_DATA_EMISSION_INTERVAL : DEFAULT_MAX_RAW_LED_DATA_EMISSION_INTERVAL; - _ledDeviceDataEmissionInterval = (_hwLedCount > 1000) ? 2 * DEFAULT_MAX_LED_DEVICE_DATA_EMISSION_INTERVAL : DEFAULT_MAX_LED_DEVICE_DATA_EMISSION_INTERVAL; - - // change in leds are also reflected in adjustment - delete _raw2ledAdjustment; - _raw2ledAdjustment = hyperion::createLedColorsAdjustment(static_cast(_ledString.leds().size()), getSetting(settings::COLOR).object()); + updateLedLayout(config.array()); #if defined(ENABLE_EFFECTENGINE) // start cached effects _effectEngine->startCachedEffects(); #endif + + refreshUpdate(); } else if(type == settings::DEVICE) { - QJsonObject dev = config.object(); + QJsonObject const deviceConfig = config.object(); - // handle hwLedCount update - _hwLedCount = dev["hardwareLedCount"].toInt(getLedCount()); + // Recreate LED-Device with new configuration + _ledDeviceWrapper->createLedDevice(deviceConfig); + _hwLedCount = _ledDeviceWrapper->getLedCount(); + _colorOrder = _ledDeviceWrapper->getColorOrder(); - // force ledString update, if device ByteOrder changed - if(_ledDeviceWrapper->getColorOrder() != dev["colorOrder"].toString("rgb")) - { - _ledString = LedString::createLedString(getSetting(settings::LEDS).array(), hyperion::createColorOrder(dev)); - _imageProcessor->setLedString(_ledString); + updateLedLayout(getSetting(settings::LEDS).array()); + _ledBuffer.resize(static_cast::size_type>(_hwLedCount), ColorRgb::BLACK); + } +} - _ledStringColorOrder.clear(); - for (const Led& led : _ledString.leds()) - { - _ledStringColorOrder.push_back(led.colorOrder); - } - } +void Hyperion::updateLedColorAdjustment(int ledCount, const QJsonObject& colors) +{ + // change in LEDs are also reflected in adjustment + _raw2ledAdjustment.reset(hyperion::createLedColorsAdjustment(ledCount, colors)); + if (!_raw2ledAdjustment->verifyAdjustments()) + { + Warning(_log, "At least one LED has no color calibration, please add all LEDs from your LED layout to an 'LED index' field!"); + } +} - // do always reinit until the led devices can handle dynamic changes - dev["currentLedCount"] = _hwLedCount; // Inject led count info - _ledDeviceWrapper->createLedDevice(dev); +void Hyperion::updateLedLayout(const QJsonArray& ledLayout) +{ + _ledString = LedString::createLedString(ledLayout, hyperion::createColorOrder(_colorOrder), _hwLedCount); + _layoutLedCount = static_cast(_ledString.leds().size()); + _layoutGridSize = hyperion::getLedLayoutGridSize(ledLayout); - // TODO: Check, if framegrabber frequency is lower than latchtime..., if yes, stop + _ledStringColorOrder.clear(); + for (const Led& led : _ledString.leds()) + { + _ledStringColorOrder.push_back(led.colorOrder); } - // update once to push single color sets / adjustments/ ledlayout resizes and update ledBuffer color - update(); + updateLedColorAdjustment(_layoutLedCount, getSetting(settings::COLOR).object()); + + if (_imageProcessor.isNull()) + { + _imageProcessor.reset(new ImageProcessor(_ledString, this)); + } + else + { + _imageProcessor->setLedString(_ledString); + } + + _muxer->updateLedColorsLength(_layoutLedCount); + + if (_layoutLedCount < static_cast(_ledBuffer.size())) + { + std::fill(_ledBuffer.begin() + _layoutLedCount, _ledBuffer.end(), ColorRgb{0, 0, 0}); + } } QJsonDocument Hyperion::getSetting(settings::type type) const @@ -351,9 +296,9 @@ QJsonDocument Hyperion::getSetting(settings::type type) const } // TODO: Remove function, if UI is able to handle full configuration -QJsonObject Hyperion::getQJsonConfig() const +QJsonObject Hyperion::getQJsonConfig(quint8 inst) const { - const QJsonObject instanceConfig = _settingsManager->getSettings(); + const QJsonObject instanceConfig = _settingsManager->getSettings(inst); const QJsonObject globalConfig = _settingsManager->getSettings({},QStringList()); return JsonUtils::mergeJsonObjects(instanceConfig, globalConfig); } @@ -380,7 +325,7 @@ unsigned Hyperion::updateSmoothingConfig(unsigned id, int settlingTime_ms, doubl int Hyperion::getLedCount() const { - return static_cast(_ledString.leds().size()); + return _layoutLedCount; } void Hyperion::setSourceAutoSelect(bool state) @@ -415,7 +360,7 @@ int Hyperion::isComponentEnabled(hyperion::Components comp) const void Hyperion::setSuspend(bool isSuspend) { - bool enable = !isSuspend; + bool const enable = !isSuspend; emit compStateChangeRequestAll(enable); } @@ -423,7 +368,7 @@ void Hyperion::setIdle(bool isIdle) { clear(-1); - bool enable = !isIdle; + bool const enable = !isIdle; emit compStateChangeRequestAll(enable, {hyperion::COMP_LEDDEVICE, hyperion::COMP_SMOOTHING} ); } @@ -447,7 +392,7 @@ bool Hyperion::setInput(int priority, const std::vector& ledColors, in // if this priority is visible, update immediately if(priority == _muxer->getCurrentPriority()) { - update(); + refreshUpdate(); } return true; @@ -476,7 +421,7 @@ bool Hyperion::setInputImage(int priority, const Image& image, int64_t // if this priority is visible, update immediately if(priority == _muxer->getCurrentPriority()) { - update(); + refreshUpdate(); } return true; @@ -500,20 +445,34 @@ void Hyperion::setColor(int priority, const std::vector &ledColors, in #endif // create full led vector from single/multiple colors - size_t size = _ledString.leds().size(); std::vector newLedColors; - while (true) + + size_t const size = static_cast(_layoutLedCount); + newLedColors.reserve(size); + + if (ledColors.size() == 1) { - for (const auto &entry : ledColors) + // Special case: single color, fill the entire vector + newLedColors.resize(size, ledColors[0]); + } + else + { + // General case: multiple colors + size_t const fullCopies = size / ledColors.size(); + size_t const remainder = size % ledColors.size(); + + // Add full copies of `ledColors` + for (size_t i = 0; i < fullCopies; ++i) { - newLedColors.emplace_back(entry); - if (newLedColors.size() == size) - { - goto end; - } + newLedColors.insert(newLedColors.end(), ledColors.begin(), ledColors.end()); + } + + // Add remaining elements + if (remainder > 0) + { + newLedColors.insert(newLedColors.end(), ledColors.begin(), ledColors.begin() + remainder); } } -end: // register color registerInput(priority, hyperion::COMP_COLOR, origin); @@ -527,15 +486,15 @@ QStringList Hyperion::getAdjustmentIds() const return _raw2ledAdjustment->getAdjustmentIds(); } -ColorAdjustment * Hyperion::getAdjustment(const QString& id) const +ColorAdjustment * Hyperion::getAdjustment(const QString& identifier) const { - return _raw2ledAdjustment->getAdjustment(id); + return _raw2ledAdjustment->getAdjustment(identifier); } void Hyperion::adjustmentsUpdated() { emit adjustmentChanged(); - update(); + refreshUpdate(); } bool Hyperion::clear(int priority, bool forceClearAll) @@ -570,7 +529,7 @@ bool Hyperion::clear(int priority, bool forceClearAll) int Hyperion::getCurrentPriority() const { - return _muxer->getCurrentPriority(); + return _muxer.isNull() ? PriorityMuxer::LOWEST_PRIORITY : _muxer->getCurrentPriority(); } bool Hyperion::isCurrentPriority(int priority) const @@ -594,31 +553,11 @@ Hyperion::InputInfo Hyperion::getPriorityInfo(int priority) const } #if defined(ENABLE_EFFECTENGINE) -QString Hyperion::saveEffect(const QJsonObject& obj) -{ - return _effectEngine->saveEffect(obj); -} - -QString Hyperion::deleteEffect(const QString& effectName) -{ - return _effectEngine->deleteEffect(effectName); -} - -std::list Hyperion::getEffects() const -{ - return _effectEngine->getEffects(); -} - std::list Hyperion::getActiveEffects() const { return _effectEngine->getActiveEffects(); } -std::list Hyperion::getEffectSchemas() const -{ - return _effectEngine->getEffectSchemas(); -} - int Hyperion::setEffect(const QString &effectName, int priority, int timeout, const QString & origin) { return _effectEngine->runEffect(effectName, priority, timeout, origin); @@ -668,7 +607,7 @@ void Hyperion::handleVisibleComponentChanged(hyperion::Components comp) void Hyperion::handleSourceAvailability(int priority) { - int previousPriority = _muxer->getPreviousPriority(); + int const previousPriority = _muxer->getPreviousPriority(); if ( priority == PriorityMuxer::LOWEST_PRIORITY) { @@ -677,28 +616,43 @@ void Hyperion::handleSourceAvailability(int priority) { Debug(_log,"No source left -> Pause output processing and switch LED-Device off"); emit _ledDeviceWrapper->switchOff(); - emit _deviceSmooth->setPause(true); + _deviceSmooth->setPause(true); } } else { if ( previousPriority == PriorityMuxer::LOWEST_PRIORITY ) { - Debug(_log,"new source available -> Resume output processing and switch LED-Device on"); - emit _ledDeviceWrapper->switchOn(); - emit _deviceSmooth->setPause(false); + if(_ledDeviceWrapper->isEnabled()) + { + Debug(_log,"new source available -> LED-Device is enabled, switch LED-device on and resume output processing"); + emit _ledDeviceWrapper->switchOn(); + } + else + { + Debug(_log,"new source available -> LED-Device not enabled, cannot switch on LED-device"); + } + _deviceSmooth->setPause(false); } } } +void Hyperion::refreshUpdate() +{ + wait(_ledDeviceWrapper->getLatchTime()); + update(); +} + void Hyperion::update() { // Obtain the current priority channel - int priority = _muxer->getCurrentPriority(); + int const priority = _muxer->getCurrentPriority(); const PriorityMuxer::InputInfo priorityInfo = _muxer->getInputInfo(priority); + std::vector ledColors; + // copy image & process OR copy ledColors from muxer - Image image = priorityInfo.image; + Image const image = priorityInfo.image; if (image.width() > 1 || image.height() > 1) { _imageEmissionInterval = (image.width() > 1280) ? 2 * DEFAULT_MAX_IMAGE_EMISSION_INTERVAL : DEFAULT_MAX_IMAGE_EMISSION_INTERVAL; @@ -709,21 +663,20 @@ void Hyperion::update() _lastImageEmission = elapsedImageEmissionTime; emit currentImage(image); // Emit the image signal at the controlled rate } - _ledBuffer = _imageProcessor->process(image); + ledColors = _imageProcessor->process(image); } else { - _ledBuffer = priorityInfo.ledColors; - + ledColors = priorityInfo.ledColors; if (_ledString.hasBlackListedLeds()) { - for (unsigned long id : _ledString.blacklistedLedIds()) + for (unsigned long const id : _ledString.blacklistedLedIds()) { - if (id > _ledBuffer.size()-1) + if (id > ledColors.size()-1) { break; } - _ledBuffer.at(id) = ColorRgb::BLACK; + ledColors.at(id) = ColorRgb::BLACK; } } } @@ -733,15 +686,18 @@ void Hyperion::update() if (elapsedRawLedDataEmissionTime - _lastRawLedDataEmission >= _rawLedDataEmissionInterval.count()) { _lastRawLedDataEmission = elapsedRawLedDataEmissionTime; - emit rawLedColors(_ledBuffer); // Emit the rawLedColors signal at the controlled rate + emit rawLedColors(ledColors); // Emit the rawLedColors signal at the controlled rate } // Start transformations - _raw2ledAdjustment->applyAdjustment(_ledBuffer); + _raw2ledAdjustment->applyAdjustment(ledColors); - int i = 0; - for (ColorRgb& color : _ledBuffer) + assert(ledColors.size() >= _ledStringColorOrder.size()); + + // Only apply color order for LEDs defined by layout + for (size_t i=0; i < _ledStringColorOrder.size(); ++i) { + ColorRgb& color = ledColors.at(i); // correct the color byte order switch (_ledStringColorOrder.at(i)) { @@ -767,17 +723,12 @@ void Hyperion::update() std::swap(color.green, color.blue); break; } - i++; } - // fill additional hardware LEDs with black - if ( _hwLedCount > static_cast(_ledBuffer.size()) ) - { - _ledBuffer.resize(_hwLedCount, ColorRgb::BLACK); - } + // Copy elements from ledColors to _ledBuffer up to the size of _ledBuffer + std::copy_n(ledColors.begin(), std::min(_ledBuffer.size(), ledColors.size()), _ledBuffer.begin()); - // Write the data to the device - if (_ledDeviceWrapper->enabled()) + if (_ledDeviceWrapper->isOn()) { // Smoothing is disabled if (! _deviceSmooth->enabled()) diff --git a/libsrc/hyperion/HyperionIManager.cpp b/libsrc/hyperion/HyperionIManager.cpp index 254d1bf09..2b31ca16c 100644 --- a/libsrc/hyperion/HyperionIManager.cpp +++ b/libsrc/hyperion/HyperionIManager.cpp @@ -3,6 +3,7 @@ // hyperion #include #include +#include // qt #include @@ -12,23 +13,32 @@ HyperionIManager* HyperionIManager::HIMinstance; HyperionIManager::HyperionIManager(QObject* parent) : QObject(parent) , _log(Logger::getInstance("HYPERION-INSTMGR")) - , _instanceTable( new InstanceTable()) + , _instanceTable(new InstanceTable(this)) { HIMinstance = this; qRegisterMetaType("InstanceState"); - _instanceTable->createDefaultInstance(); + + _instanceTable->createInitialInstance(); } -Hyperion* HyperionIManager::getHyperionInstance(quint8 instance) +HyperionIManager::~HyperionIManager() { - Hyperion* pInstance {nullptr}; - if(_runningInstances.contains(instance)) - return _runningInstances.value(instance); +} + +QSharedPointer HyperionIManager::getHyperionInstance(quint8 instanceId) +{ + QSharedPointer pInstance {nullptr}; + if(_runningInstances.contains(instanceId)) + { + return _runningInstances.value(instanceId); + } if (!_runningInstances.isEmpty()) { - Warning(_log,"The requested instance index '%d' with name '%s' isn't running, return main instance", instance, QSTRING_CSTR(_instanceTable->getNamebyIndex(instance))); - pInstance = _runningInstances.value(0); + if (instanceId != GLOABL_INSTANCE_ID ) + { + Warning(_log,"The requested instance index '%d' with name '%s' isn't running", instanceId, QSTRING_CSTR(_instanceTable->getNamebyIndex(instanceId))); + } } return pInstance; } @@ -39,30 +49,49 @@ QVector HyperionIManager::getInstanceData() const for( auto & entry : instances) { // add running state - entry["running"] = _runningInstances.contains(entry["instance"].toInt()); + entry["running"] = _runningInstances.contains(static_cast(entry["instance"].toInt())); } return instances; } -QString HyperionIManager::getInstanceName(quint8 inst) +QString HyperionIManager::getInstanceName(quint8 instanceId) { - return _instanceTable->getNamebyIndex(inst); + return _instanceTable->getNamebyIndex(instanceId); } -QList HyperionIManager::getRunningInstanceIdx() const +QSet HyperionIManager::getRunningInstanceIdx() const { - return _runningInstances.keys(); + const auto runningInstances = _runningInstances.keys(); + +#if (QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)) + QSet instanceIds (runningInstances.begin(), runningInstances.end()); +#else + QSet instanceIds; + for (const auto &id : runningInstances) { + instanceIds.insert(id); + } +#endif + return instanceIds; } -QList HyperionIManager::getInstanceIds() const +QSharedPointer HyperionIManager::getFirstRunningInstance() { - return _instanceTable->getAllInstanceIDs(); + QSharedPointer hyperion {nullptr}; + if (!_runningInstances.isEmpty()) + { + hyperion = _runningInstances.first(); + } + return hyperion; } +QSet HyperionIManager::getInstanceIds() const +{ + return _instanceTable->getAllInstanceIDs(); +} void HyperionIManager::startAll() { - const QVector instances = _instanceTable->getAllInstances(true); + QVector const instances = _instanceTable->getAllInstances(true); if (instances.isEmpty()) { Error(_log, "No enabled instances found to be started"); @@ -71,17 +100,27 @@ void HyperionIManager::startAll() for(const auto & entry : instances) { - startInstance(entry["instance"].toInt()); + startInstance(static_cast(entry["instance"].toInt())); } } void HyperionIManager::stopAll() { - // copy the instances due to loop corruption, even with .erase() return next iter - QMap instCopy = _runningInstances; - for(auto *const instance : instCopy) + Debug(_log, "Running instances: %d, starting instances: %d" + , _runningInstances.size() + , _startingInstances.size()); + + if( _runningInstances.empty()) + { + QMetaObject::invokeMethod(this, "handleFinished", Qt::QueuedConnection); + return; + } + + QMap> const instCopy = _runningInstances; + for(auto const &instance : instCopy) { - instance->stop(); + QString const instanceName = _instanceTable->getNamebyIndex(instance->getInstanceIndex()); + QMetaObject::invokeMethod(instance.get(), "stop", Q_ARG(QString, instanceName)); } } @@ -91,30 +130,29 @@ void HyperionIManager::handleEvent(Event event) switch (event) { case Event::Suspend: toggleSuspend(true); - break; + break; case Event::Resume: toggleSuspend(false); - break; + break; case Event::Idle: toggleIdle(true); - break; + break; case Event::ResumeIdle: toggleIdle(false); - break; + break; default: - break; + break; } } void HyperionIManager::toggleSuspend(bool isSuspend) { Info(_log,"Put all instances in %s state", isSuspend ? "suspend" : "working"); - QMap instCopy = _runningInstances; - for(const auto instance : instCopy) + for(const auto& instance : std::as_const(_runningInstances)) { emit instance->suspendRequest(isSuspend); } @@ -123,8 +161,7 @@ void HyperionIManager::toggleSuspend(bool isSuspend) void HyperionIManager::toggleIdle(bool isIdle) { Info(_log,"Put all instances in %s state", isIdle ? "idle" : "working"); - QMap instCopy = _runningInstances; - for(const auto instance : instCopy) + for(const auto& instance : std::as_const(_runningInstances)) { emit instance->idleRequest(isIdle); } @@ -133,122 +170,118 @@ void HyperionIManager::toggleIdle(bool isIdle) void HyperionIManager::toggleStateAllInstances(bool enable) { // copy the instances due to loop corruption, even with .erase() return next iter - QMap instCopy = _runningInstances; - for(const auto instance : instCopy) + for(const auto& instance : std::as_const(_runningInstances)) { emit instance->compStateChangeRequest(hyperion::COMP_ALL, enable); } } -bool HyperionIManager::startInstance(quint8 inst, bool block, QObject* caller, int tan) +bool HyperionIManager::startInstance(quint8 instanceId, bool block, QObject* caller, int tan) { - if(_instanceTable->instanceExist(inst)) + if(_instanceTable->doesInstanceExist(instanceId)) { - if(!_runningInstances.contains(inst) && !_startQueue.contains(inst)) + if(!_runningInstances.contains(instanceId) && !_startingInstances.contains(instanceId)) { - QThread* hyperionThread = new QThread(); + QSharedPointer const hyperion(new Hyperion(instanceId), &QObject::deleteLater); + + QThread* hyperionThread = new QThread(this); hyperionThread->setObjectName("HyperionThread"); - Hyperion* hyperion = new Hyperion(inst); + hyperion->moveToThread(hyperionThread); // setup thread management - connect(hyperionThread, &QThread::started, hyperion, &Hyperion::start); - connect(hyperion, &Hyperion::started, this, &HyperionIManager::handleStarted); - connect(hyperion, &Hyperion::finished, this, &HyperionIManager::handleFinished); - connect(hyperion, &Hyperion::finished, hyperionThread, &QThread::quit, Qt::DirectConnection); + connect(hyperionThread, &QThread::started, hyperion.get(), &Hyperion::start); + connect(hyperion.get(), &Hyperion::started, this, &HyperionIManager::handleStarted); + connect(hyperion.get(), &Hyperion::finished, this, &HyperionIManager::handleFinished); // setup further connections // from Hyperion - connect(hyperion, &Hyperion::settingsChanged, this, &HyperionIManager::settingsChanged); - connect(hyperion, &Hyperion::videoMode, this, &HyperionIManager::requestVideoMode); + connect(hyperion.get(), &Hyperion::settingsChanged, this, &HyperionIManager::settingsChanged); + connect(hyperion.get(), &Hyperion::videoMode, this, &HyperionIManager::requestVideoMode); // to Hyperion - connect(this, &HyperionIManager::newVideoMode, hyperion, &Hyperion::newVideoMode); + connect(this, &HyperionIManager::newVideoMode, hyperion.get(), &Hyperion::newVideoMode); // add to queue and start - _startQueue << inst; + _startingInstances.insert(instanceId, hyperion); hyperionThread->start(); // update db - _instanceTable->setLastUse(inst); - _instanceTable->setEnable(inst, true); + _instanceTable->setLastUse(instanceId); + _instanceTable->setEnable(instanceId, true); if(block) { while(!hyperionThread->isRunning()){} } - if (!_pendingRequests.contains(inst) && caller != nullptr) + if (!_pendingRequests.contains(instanceId) && caller != nullptr) { - PendingRequests newDef{caller, tan}; - _pendingRequests[inst] = newDef; + PendingRequests const newDef{caller, tan}; + _pendingRequests[instanceId] = newDef; } return true; } - Debug(_log,"Can't start Hyperion instance index '%d' with name '%s' it's already running or queued for start", inst, QSTRING_CSTR(_instanceTable->getNamebyIndex(inst))); + Debug(_log,"Cannot start Hyperion instance (%u) - '%s'. It is already running or queued for start.",instanceId,QSTRING_CSTR(_instanceTable->getNamebyIndex(instanceId))); return false; } - Debug(_log,"Can't start Hyperion instance index '%d' it doesn't exist in DB", inst); + Debug(_log,"Cannot start Hyperion instance (%u).It is not configured.", instanceId); return false; } -bool HyperionIManager::stopInstance(quint8 inst) +bool HyperionIManager::stopInstance(quint8 instanceId) { - // inst 0 can't be stopped - if(!isInstAllowed(inst)) - return false; - - if(_instanceTable->instanceExist(inst)) + if(_instanceTable->doesInstanceExist(instanceId)) { - if(_runningInstances.contains(inst)) + QString const instanceName = _instanceTable->getNamebyIndex(instanceId); + if(_runningInstances.contains(instanceId)) { // notify a ON_STOP rather sooner than later, queued signal listener should have some time to drop the pointer before it's deleted - emit instanceStateChanged(InstanceState::H_ON_STOP, inst); - Hyperion* hyperion = _runningInstances.value(inst); - hyperion->stop(); + emit instanceStateChanged(InstanceState::H_ON_STOP, instanceId); + QSharedPointer const hyperion = _runningInstances.value(instanceId); + QMetaObject::invokeMethod(hyperion.get(), "stop", Q_ARG(QString, instanceName)); // update db - _instanceTable->setEnable(inst, false); + _instanceTable->setEnable(instanceId, false); return true; } - Debug(_log,"Can't stop Hyperion instance index '%d' with name '%s' it's not running'", inst, QSTRING_CSTR(_instanceTable->getNamebyIndex(inst))); + Debug(_log,"Cannot stop Hyperion instance [%u] - '%s'. It is not running.'",instanceId,QSTRING_CSTR(instanceName)); return false; } - Debug(_log,"Can't stop Hyperion instance index '%d' it doesn't exist in DB", inst); + Debug(_log,"Cannot stop Hyperion instance [%u]. It is not configured.", instanceId); return false; } bool HyperionIManager::createInstance(const QString& name, bool start) { - quint8 inst = 0; - if(_instanceTable->createInstance(name, inst)) + quint8 instanceId = 0; + if(_instanceTable->createInstance(name, instanceId)) { - Info(_log,"New Hyperion instance [%d] created with name '%s'", inst, QSTRING_CSTR(name)); - emit instanceStateChanged(InstanceState::H_CREATED, inst, name); + SettingsTable settingsTable(instanceId); + settingsTable.addMissingDefaults(); + Info(_log,"New Hyperion instance [%u] created with name '%s'", instanceId, QSTRING_CSTR(name)); + emit instanceStateChanged(InstanceState::H_CREATED, instanceId, name); emit change(); if(start) - startInstance(inst); + { + startInstance(instanceId); + } + return true; } return false; } -bool HyperionIManager::deleteInstance(quint8 inst) +bool HyperionIManager::deleteInstance(quint8 instanceId) { - // inst 0 can't be deleted - if(!isInstAllowed(inst)) - { - return false; - } + stopInstance(instanceId); - // stop it if required as blocking and wait - stopInstance(inst); - - if(_instanceTable->deleteInstance(inst)) + QString const instanceName = _instanceTable->getNamebyIndex(instanceId); + if(_instanceTable->deleteInstance(instanceId)) { - Info(_log,"Hyperion instance with index '%d' has been deleted", inst); - emit instanceStateChanged(InstanceState::H_DELETED, inst); + Info(_log,"Hyperion instance [%u] - '%s' was deleted.", instanceId, QSTRING_CSTR(instanceName)); + emit instanceStateChanged(InstanceState::H_DELETED, instanceId); emit change(); return true; @@ -256,9 +289,9 @@ bool HyperionIManager::deleteInstance(quint8 inst) return false; } -bool HyperionIManager::saveName(quint8 inst, const QString& name) +bool HyperionIManager::saveName(quint8 instanceId, const QString& name) { - if(_instanceTable->saveName(inst, name)) + if(_instanceTable->saveName(instanceId, name)) { emit change(); return true; @@ -266,36 +299,63 @@ bool HyperionIManager::saveName(quint8 inst, const QString& name) return false; } -void HyperionIManager::handleFinished() +void HyperionIManager::handleFinished(const QString& name) { Hyperion* hyperion = qobject_cast(sender()); - quint8 instance = hyperion->getInstanceIndex(); + if (hyperion != nullptr) + { + quint8 const instanceId = hyperion->getInstanceIndex(); + + // Manually stop the thread and cleanup + QThread* thread = hyperion->thread(); + if (thread != nullptr) + { + thread->quit(); + thread->wait(); + } + + Info(_log,"Hyperion instance [%u] - '%s' stopped.", instanceId, QSTRING_CSTR(name)); - Info(_log,"Hyperion instance '%s' stopped", QSTRING_CSTR(_instanceTable->getNamebyIndex(instance))); + _startingInstances.remove(instanceId); + _runningInstances.remove(instanceId); - _runningInstances.remove(instance); - hyperion->thread()->deleteLater(); - hyperion->deleteLater(); - emit instanceStateChanged(InstanceState::H_STOPPED, instance); - emit change(); + emit instanceStateChanged(InstanceState::H_STOPPED, instanceId); + emit change(); + } + + if ( _runningInstances.isEmpty()) + { + Info(_log,"All Hyperion instances are stopped now."); + emit areAllInstancesStopped(); + } } void HyperionIManager::handleStarted() { - Hyperion* hyperion = qobject_cast(sender()); - quint8 instance = hyperion->getInstanceIndex(); + Hyperion* const hyperion = qobject_cast(sender()); + quint8 const instanceId = hyperion->getInstanceIndex(); - Info(_log,"Hyperion instance '%s' has been started", QSTRING_CSTR(_instanceTable->getNamebyIndex(instance))); + if (_startingInstances.contains(instanceId)) + { + Info(_log,"Hyperion instance [%u] - '%s' started.", instanceId, QSTRING_CSTR(_instanceTable->getNamebyIndex(instanceId))); + + QSharedPointer const hyperionInstance = _startingInstances.value(instanceId); + _runningInstances.insert(instanceId, hyperionInstance); + _startingInstances.remove(instanceId); - _startQueue.removeAll(instance); - _runningInstances.insert(instance, hyperion); - emit instanceStateChanged(InstanceState::H_STARTED, instance); - emit change(); + emit instanceStateChanged(InstanceState::H_STARTED, instanceId); + emit change(); - if (_pendingRequests.contains(instance)) + if (_pendingRequests.contains(instanceId)) + { + PendingRequests const def = _pendingRequests.take(instanceId); + emit startInstanceResponse(def.caller, def.tan); + _pendingRequests.remove(instanceId); + } + } + else { - PendingRequests def = _pendingRequests.take(instance); - emit startInstanceResponse(def.caller, def.tan); - _pendingRequests.remove(instance); + Error(_log, "Cannot find instance [%u] - '%s' in the starting list.", + instanceId, QSTRING_CSTR(_instanceTable->getNamebyIndex(instanceId))); } } diff --git a/libsrc/hyperion/ImageProcessor.cpp b/libsrc/hyperion/ImageProcessor.cpp index 6f9c62221..54fd90706 100644 --- a/libsrc/hyperion/ImageProcessor.cpp +++ b/libsrc/hyperion/ImageProcessor.cpp @@ -142,7 +142,6 @@ void ImageProcessor::setSize(int width, int height) void ImageProcessor::setLedString(const LedString& ledString) { - Debug(_log,""); if ( !_imageToLedColors.isNull() ) { _ledString = ledString; diff --git a/libsrc/hyperion/LedString.cpp b/libsrc/hyperion/LedString.cpp index 172504c4b..cc2dc3b17 100644 --- a/libsrc/hyperion/LedString.cpp +++ b/libsrc/hyperion/LedString.cpp @@ -5,6 +5,7 @@ // hyperion includes #include +#include // QT includes #include @@ -47,14 +48,24 @@ bool LedString::hasBlackListedLeds() * ordering of the RGB channels * @param ledsConfig The configuration of the led areas * @param deviceOrder The default RGB channel ordering + * @param ledsUsed The maximum number of LEDs used from the configuration * @return The constructed ledstring */ -LedString LedString::createLedString(const QJsonArray& ledConfigArray, const ColorOrder deviceOrder) +LedString LedString::createLedString(const QJsonArray& ledConfigArray, const ColorOrder deviceOrder, int maxLeds) { LedString ledString; const QString deviceOrderStr = colorOrderToString(deviceOrder); - for (signed i = 0; i < ledConfigArray.size(); ++i) + int configuredLeds = static_cast(ledConfigArray.size()); + int ledsUsed = configuredLeds; + + if (ledsUsed > maxLeds) + { + ledsUsed = maxLeds; + Warning(Logger::getInstance("HYPERION"),"More LEDs configured [%d] via the layout than supported by the device [%d]. Using first [%d] layout entries", configuredLeds, maxLeds, ledsUsed); + } + + for (signed i = 0; i < ledsUsed; ++i) { const QJsonObject& ledConfig = ledConfigArray[i].toObject(); Led led; diff --git a/libsrc/hyperion/LinearColorSmoothing.cpp b/libsrc/hyperion/LinearColorSmoothing.cpp index 06edc4982..835c2ffa5 100644 --- a/libsrc/hyperion/LinearColorSmoothing.cpp +++ b/libsrc/hyperion/LinearColorSmoothing.cpp @@ -60,27 +60,23 @@ using namespace hyperion; LinearColorSmoothing::LinearColorSmoothing(const QJsonDocument &config, Hyperion *hyperion) : QObject(hyperion) - , _log(nullptr) - , _hyperion(hyperion) - , _prioMuxer(_hyperion->getMuxerInstance()) - , _updateInterval(DEFAULT_UPDATEINTERVALL.count()) - , _settlingTime(DEFAULT_SETTLINGTIME) - , _timer(nullptr) - , _outputDelay(DEFAULT_OUTPUTDEPLAY) - , _pause(false) - , _currentConfigId(SmoothingConfigID::SYSTEM) - , _enabled(false) - , _enabledSystemCfg(false) - , _smoothingType(SmoothingType::Linear) - , tempValues(std::vector()) + , _log(nullptr) + , _hyperion(hyperion) + , _prioMuxer(_hyperion->getMuxerInstance()) + , _updateInterval(DEFAULT_UPDATEINTERVALL.count()) + , _settlingTime(DEFAULT_SETTLINGTIME) + , _timer(nullptr) + , _outputDelay(DEFAULT_OUTPUTDEPLAY) + , _pause(false) + , _currentConfigId(SmoothingConfigID::SYSTEM) + , _enabled(false) + , _enabledSystemCfg(false) + , _smoothingType(SmoothingType::Linear) + , tempValues(std::vector()) { QString subComponent = hyperion->property("instance").toString(); _log= Logger::getInstance("SMOOTHING", subComponent); - // timer - _timer = new QTimer(this); - _timer->setTimerType(Qt::PreciseTimer); - // init cfg (default) updateConfig(SmoothingConfigID::SYSTEM, DEFAULT_SETTLINGTIME, DEFAULT_UPDATEFREQUENCY, DEFAULT_OUTPUTDEPLAY); handleSettingsUpdate(settings::SMOOTHING, config); @@ -88,24 +84,36 @@ LinearColorSmoothing::LinearColorSmoothing(const QJsonDocument &config, Hyperion // add pause on cfg 1 SmoothingCfg cfg {true, 0, 0}; _cfgList.append(std::move(cfg)); +} +LinearColorSmoothing::~LinearColorSmoothing() +{ +} - // listen for comp changes - connect(_hyperion, &Hyperion::compStateChangeRequest, this, &LinearColorSmoothing::componentStateChange); - connect(_timer, &QTimer::timeout, this, &LinearColorSmoothing::updateLeds); +void LinearColorSmoothing::start() +{ + Info(_log, "LinearColorSmoothing starting..."); - connect(_prioMuxer, &PriorityMuxer::prioritiesChanged, this, [=] (int priority){ - const PriorityMuxer::InputInfo priorityInfo = _prioMuxer->getInputInfo(priority); - int smooth_cfg = priorityInfo.smooth_cfg; - if (smooth_cfg != _currentConfigId || smooth_cfg == SmoothingConfigID::EFFECT_DYNAMIC) - { - this->selectConfig(smooth_cfg, false); - } - }); + _timer.reset(new QTimer(this)); + _timer->setTimerType(Qt::PreciseTimer); + + //Start in pause mode, a new priority will activate smoothing (either start-effect or grabber) + setPause(true); + + // listen for comp changes + QObject::connect(_hyperion, &Hyperion::compStateChangeRequest, this, &LinearColorSmoothing::componentStateChange); + QObject::connect(_prioMuxer.get(), &PriorityMuxer::prioritiesChanged, this, &LinearColorSmoothing::handlePriorityUpdate); + connect(_timer.get(), &QTimer::timeout, this, &LinearColorSmoothing::updateLeds); } -LinearColorSmoothing::~LinearColorSmoothing() +void LinearColorSmoothing::stop() { - delete _timer; + Debug(_log, "LinearColorSmoothing stopping..."); + + QObject::disconnect(_prioMuxer.get(), &PriorityMuxer::prioritiesChanged, this, &LinearColorSmoothing::handlePriorityUpdate); + setEnable(false); + _timer->stop(); + + Info(_log, "LinearColorSmoothing stopped"); } void LinearColorSmoothing::handleSettingsUpdate(settings::type type, const QJsonDocument &config) @@ -149,6 +157,16 @@ void LinearColorSmoothing::handleSettingsUpdate(settings::type type, const QJson } } +void LinearColorSmoothing::handlePriorityUpdate(int priority) +{ + const PriorityMuxer::InputInfo priorityInfo = _prioMuxer->getInputInfo(priority); + int smooth_cfg = priorityInfo.smooth_cfg; + if (smooth_cfg != _currentConfigId || smooth_cfg == SmoothingConfigID::EFFECT_DYNAMIC) + { + this->selectConfig(smooth_cfg, false); + } +} + int LinearColorSmoothing::write(const std::vector &ledValues) { _targetTime = micros() + (MS_PER_MICRO * _settlingTime); @@ -419,12 +437,12 @@ void LinearColorSmoothing::performDecay(const int64_t now) { if ((now > (_renderedStatTime + 30 * 1000000)) && (_renderedCounter > _renderedStatCounter)) { Debug(_log, "decay - rendered frames [%d] (%f/s), interpolated frames [%d] (%f/s) in [%f ms]" - , _renderedCounter - _renderedStatCounter - , (1.0F * (_renderedCounter - _renderedStatCounter) / ((now - _renderedStatTime) / 1000000.0F)) - , _interpolationCounter - _interpolationStatCounter - , (1.0F * (_interpolationCounter - _interpolationStatCounter) / ((now - _renderedStatTime) / 1000000.0F)) - , (now - _renderedStatTime) / 1000.0F - ); + , _renderedCounter - _renderedStatCounter + , (1.0F * (_renderedCounter - _renderedStatCounter) / ((now - _renderedStatTime) / 1000000.0F)) + , _interpolationCounter - _interpolationStatCounter + , (1.0F * (_interpolationCounter - _interpolationStatCounter) / ((now - _renderedStatTime) / 1000000.0F)) + , (now - _renderedStatTime) / 1000.0F + ); _renderedStatTime = now; _renderedStatCounter = _renderedCounter; _interpolationStatCounter = _interpolationCounter; @@ -468,12 +486,12 @@ void LinearColorSmoothing::updateLeds() { case SmoothingType::Decay: performDecay(now); - break; + break; case SmoothingType::Linear: default: performLinear(now); - break; + break; } } @@ -749,22 +767,22 @@ QString LinearColorSmoothing::getConfig(int cfgID) } LinearColorSmoothing::SmoothingCfg::SmoothingCfg() : - _pause(false), - _settlingTime(DEFAULT_SETTLINGTIME), - _updateInterval(DEFAULT_UPDATEFREQUENCY), - _type(SmoothingType::Linear) + _pause(false), + _settlingTime(DEFAULT_SETTLINGTIME), + _updateInterval(DEFAULT_UPDATEFREQUENCY), + _type(SmoothingType::Linear) { } LinearColorSmoothing::SmoothingCfg::SmoothingCfg(bool pause, int64_t settlingTime, int updateInterval, SmoothingType type, double interpolationRate, unsigned outputDelay, bool dithering, double decay) : - _pause(pause), - _settlingTime(settlingTime), - _updateInterval(updateInterval), - _type(type), - _interpolationRate(interpolationRate), - _outputDelay(outputDelay), - _dithering(dithering), - _decay(decay) + _pause(pause), + _settlingTime(settlingTime), + _updateInterval(updateInterval), + _type(type), + _interpolationRate(interpolationRate), + _outputDelay(outputDelay), + _dithering(dithering), + _decay(decay) { } diff --git a/libsrc/hyperion/PriorityMuxer.cpp b/libsrc/hyperion/PriorityMuxer.cpp index 91024744c..34cb47326 100644 --- a/libsrc/hyperion/PriorityMuxer.cpp +++ b/libsrc/hyperion/PriorityMuxer.cpp @@ -1,5 +1,4 @@ // STL includes -#include #include // qt incl @@ -47,21 +46,43 @@ PriorityMuxer::PriorityMuxer(int ledCount, QObject * parent) _lowestPriorityInfo.smooth_cfg = 0; _activeInputs[PriorityMuxer::LOWEST_PRIORITY] = _lowestPriorityInfo; +} + +PriorityMuxer::~PriorityMuxer() +{ +} + +void PriorityMuxer::start() +{ + Info(_log, "Priority-Muxer starting..."); // adapt to 1s interval for COLOR and EFFECT timeouts > -1 (endless) - connect(_timer, &QTimer::timeout, this, &PriorityMuxer::timeTrigger); + _timer.reset(new QTimer(this)); + connect(_timer.get(), &QTimer::timeout, this, &PriorityMuxer::timeTrigger); _timer->setSingleShot(true); + + _blockTimer.reset(new QTimer(this)); _blockTimer->setSingleShot(true); + connect(this, &PriorityMuxer::signalTimeTrigger, this, &PriorityMuxer::timeTrigger); // start muxer timer - connect(_updateTimer, &QTimer::timeout, this, &PriorityMuxer::updatePriorities); + _updateTimer.reset(new QTimer(this)); + connect(_updateTimer.get(), &QTimer::timeout, this, &PriorityMuxer::updatePriorities); _updateTimer->setInterval(250); _updateTimer->start(); } -PriorityMuxer::~PriorityMuxer() +void PriorityMuxer::stop() { + Debug(_log, "Priority-Muxer is stopping..."); + + setEnable(false); + _timer->stop(); + _blockTimer->stop(); + _updateTimer->stop(); + + Info(_log, "Priority-Muxer stopped"); } void PriorityMuxer::setEnable(bool enable) @@ -116,6 +137,12 @@ void PriorityMuxer::updateLedColorsLength(int ledCount) } ++infoIt; } + + if (_lowestPriorityInfo.ledColors.size() != static_cast(ledCount)) + { + _lowestPriorityInfo.ledColors.resize(static_cast::size_type>(ledCount), ColorRgb::BLACK); + _activeInputs[PriorityMuxer::LOWEST_PRIORITY].ledColors = _lowestPriorityInfo.ledColors; + } } QList PriorityMuxer::getPriorities() const @@ -351,7 +378,7 @@ void PriorityMuxer::updatePriorities() _activeInputs.contains(0) ? newPriority = 0 : newPriority = PriorityMuxer::LOWEST_PRIORITY; - bool timeTrigger {false}; + bool timeElapsed {false}; QMutableMapIterator i(_activeInputs); while (i.hasNext()) { i.next(); @@ -393,13 +420,13 @@ void PriorityMuxer::updatePriorities() ) ) { - timeTrigger = true; + timeElapsed = true; } } } } - if (timeTrigger) + if (timeElapsed) { emit signalTimeTrigger(); // signal to prevent Threading issues } diff --git a/libsrc/hyperion/SettingsManager.cpp b/libsrc/hyperion/SettingsManager.cpp index eb37308f6..ae2ca60c4 100644 --- a/libsrc/hyperion/SettingsManager.cpp +++ b/libsrc/hyperion/SettingsManager.cpp @@ -25,7 +25,7 @@ QJsonDocument SettingsManager::getSetting(settings::type type) const QJsonDocument SettingsManager::getSetting(const QString& type) const { - return _sTable->getSettingsRecord(type); + return _sTable->getSettingsRecordJson(type); } QJsonObject SettingsManager::getSettings(const QStringList& filteredTypes ) const diff --git a/libsrc/hyperion/schema/schema-flatbufServer.json b/libsrc/hyperion/schema/schema-flatbufServer.json index dc7fe85fa..981310994 100644 --- a/libsrc/hyperion/schema/schema-flatbufServer.json +++ b/libsrc/hyperion/schema/schema-flatbufServer.json @@ -1,6 +1,6 @@ { - "type" : "object", - "title" : "edt_conf_fbs_heading_title", + "type": "object", + "title": "edt_conf_flatbufServer_heading_title", "properties": { "enable": { "type": "boolean", @@ -21,7 +21,7 @@ "timeout": { "type": "integer", "required": true, - "title": "edt_conf_fbs_timeout_title", + "title": "edt_conf_flatbufServer_timeout_title", "append": "edt_append_s", "minimum": 1, "default": 5, @@ -38,5 +38,5 @@ "propertyOrder": 4 } }, - "additionalProperties" : false + "additionalProperties": false } diff --git a/libsrc/hyperion/schema/schema-forwarder.json b/libsrc/hyperion/schema/schema-forwarder.json index 307321b51..4db433bb7 100644 --- a/libsrc/hyperion/schema/schema-forwarder.json +++ b/libsrc/hyperion/schema/schema-forwarder.json @@ -1,105 +1,145 @@ { "type": "object", - "title": "edt_conf_fw_heading_title", + "title": "edt_conf_forwarder_heading_title", "properties": { - "enable": { - "type": "boolean", - "title": "edt_conf_general_enable_title", - "required": true, - "default": false, - "propertyOrder": 1 - }, - "jsonapiselect": { - "type": "array", - "uniqueItems": true, - "format": "select", - "title": "edt_conf_fw_json_services_discovered_title", - "propertyOrder": 2 - }, - "jsonapi": { - "type": "array", - "title": "edt_conf_fw_json_title", - "uniqueItems": true, - "access": "expert", - "items": { - "type": "object", - "title": "edt_conf_fw_json_itemtitle", - "properties": { - "name": { - "type": "string", - "title": "edt_conf_fw_service_name_title", - "required": true, - "access": "expert", - "propertyOrder": 1 - }, - "host": { - "type": "string", - "format": "hostname_or_ip", - "minLength": 7, - "title": "edt_dev_spec_targetIpHost_title", - "required": true, - "access": "expert", - "propertyOrder": 2 - }, - "port": { - "type": "integer", - "minimum": 1, - "maximum": 65535, - "title": "edt_dev_spec_port_title", - "required": true, - "access": "expert", - "propertyOrder": 3 - } - } - }, - "propertyOrder": 3 - }, - "flatbufferselect": { - "type": "array", - "uniqueItems": true, - "format": "select", - "title": "edt_conf_fw_flat_services_discovered_title", - "propertyOrder": 4 - }, - "flatbuffer": { - "type": "array", - "title": "edt_conf_fw_flat_title", - "uniqueItems": true, - "access": "expert", - "items": { - "type": "object", - "title": "edt_conf_fw_flat_itemtitle", - "properties": { - "name": { - "type": "string", - "title": "edt_conf_fw_service_name_title", - "access": "expert", - "propertyOrder": 1 - }, - "host": { - "type": "string", - "format": "hostname_or_ip", - "minLength": 7, - "title": "edt_dev_spec_targetIpHost_title", - "required": true, - "access": "expert", - "propertyOrder": 2 - }, - "port": { - "type": "integer", - "minimum": 1, - "maximum": 65535, - "default": 19400, - "title": "edt_dev_spec_port_title", - "required": true, - "access": "expert", - "propertyOrder": 3 - } - } - }, - "propertyOrder": 5 - } + "enable": { + "type": "boolean", + "title": "edt_conf_general_enable_title", + "required": true, + "default": false, + "propertyOrder": 1 + }, + "instanceList": { + "type": "string", + "title": "edt_conf_forwarder_instance_title", + "required": true, + "default": "NONE", + "options": { + "infoText": "edt_conf_forwarder_instance_title_info" + }, + "propertyOrder": 2 + }, + "instance": { + "type": "integer", + "title": "edt_conf_forwarder_instance_title", + "required": true, + "default": 255, + "minimum": 0, + "maximum": 255, + "options": { + "hidden": true + }, + "comment": "The instance-ID is dynamically inserted", + "propertyOrder": 3 + }, + "jsonapiselect": { + "type": "array", + "uniqueItems": true, + "format": "select", + "title": "edt_conf_forwarder_json_services_discovered_title", + "propertyOrder": 4 + }, + "jsonapi": { + "type": "array", + "title": "edt_conf_forwarder_json_title", + "allowEmptyArray": true, + "uniqueItems": true, + "access": "expert", + "items": { + "type": "object", + "title": "edt_conf_forwarder_json_itemtitle", + "properties": { + "name": { + "type": "string", + "title": "edt_conf_forwarder_service_name_title", + "required": true, + "access": "expert", + "propertyOrder": 1 + }, + "host": { + "type": "string", + "format": "hostname_or_ip", + "minLength": 7, + "title": "edt_dev_spec_targetIpHost_title", + "required": true, + "access": "expert", + "propertyOrder": 2 + }, + "port": { + "type": "integer", + "minimum": 1, + "maximum": 65535, + "default": 19444, + "title": "edt_dev_spec_port_title", + "required": true, + "access": "expert", + "propertyOrder": 3 + }, + "instanceIds": { + "title": "edt_conf_forwarder_target_instances_title", + "type": "array", + "required": false, + "uniqueItems": true, + "items": { + "title": "edt_conf_forwarder_target_instanceID_title", + "required": true, + "type": "integer", + "minimum": 0, + "maximum": 255, + "default": 255 + }, + "propertyOrder": 4 + } + } + }, + "propertyOrder": 5 + }, + "flatbufferselect": { + "type": "array", + "uniqueItems": true, + "format": "select", + "title": "edt_conf_forwarder_flat_services_discovered_title", + "propertyOrder": 6 + }, + "flatbuffer": { + "type": "array", + "title": "edt_conf_forwarder_flat_title", + "uniqueItems": true, + "access": "expert", + "items": { + "type": "object", + "title": "edt_conf_forwarder_flat_itemtitle", + "allowEmptyArray": true, + "properties": { + "name": { + "type": "string", + "title": "edt_conf_forwarder_service_name_title", + "access": "expert", + "propertyOrder": 1 + }, + "host": { + "type": "string", + "format": "hostname_or_ip", + "minLength": 7, + "title": "edt_dev_spec_targetIpHost_title", + "required": true, + "access": "expert", + "propertyOrder": 2 + }, + "port": { + "type": "integer", + "minimum": 1, + "maximum": 65535, + "default": 19400, + "title": "edt_dev_spec_port_title", + "required": true, + "access": "expert", + "propertyOrder": 3 + } + } + }, + "propertyOrder": 7 + } }, "additionalProperties": false } - diff --git a/libsrc/hyperion/schema/schema-jsonServer.json b/libsrc/hyperion/schema/schema-jsonServer.json index e25229ae0..aba222fff 100644 --- a/libsrc/hyperion/schema/schema-jsonServer.json +++ b/libsrc/hyperion/schema/schema-jsonServer.json @@ -1,17 +1,15 @@ { - "type" : "object", - "title" : "edt_conf_js_heading_title", - "properties" : - { - "port" : - { - "type" : "integer", - "required" : true, - "title" : "edt_conf_general_port_title", - "minimum" : 1024, - "maximum" : 65535, - "default" : 19444 + "type": "object", + "title": "edt_conf_jsonServer_heading_title", + "properties": { + "port": { + "type": "integer", + "required": true, + "title": "edt_conf_general_port_title", + "minimum": 1024, + "maximum": 65535, + "default": 19444 } }, - "additionalProperties" : false + "additionalProperties": false } diff --git a/libsrc/hyperion/schema/schema-network.json b/libsrc/hyperion/schema/schema-network.json index 0d72f7bec..c1c83516d 100644 --- a/libsrc/hyperion/schema/schema-network.json +++ b/libsrc/hyperion/schema/schema-network.json @@ -1,59 +1,49 @@ { - "type" : "object", - "title" : "edt_conf_net_heading_title", - "properties" : - { - "internetAccessAPI" : - { - "type" : "boolean", - "title" : "edt_conf_net_internetAccessAPI_title", - "required" : true, - "default" : false, - "propertyOrder" : 1 + "type": "object", + "title": "edt_conf_network_heading_title", + "properties": { + "internetAccessAPI": { + "type": "boolean", + "title": "edt_conf_network_internetAccessAPI_title", + "required": true, + "default": false, + "propertyOrder": 1 }, - "restirctedInternetAccessAPI" : - { - "type" : "boolean", - "title" : "edt_conf_net_restirctedInternetAccessAPI_title", - "required" : true, - "default" : false, + "restirctedInternetAccessAPI": { + "type": "boolean", + "title": "edt_conf_network_restirctedInternetAccessAPI_title", + "required": true, + "default": false, "options": { "dependencies": { "internetAccessAPI": true } }, - "propertyOrder" : 2 + "propertyOrder": 2 }, - "ipWhitelist" : - { - "type" : "array", - "title" : "edt_conf_net_ipWhitelist_title", - "required" : true, - "items" : { + "ipWhitelist": { + "type": "array", + "title": "edt_conf_network_ipWhitelist_title", + "required": true, + "items": { "type": "string", - "title" : "edt_conf_net_ip_itemtitle", - "allowEmptyArray" : true + "title": "edt_conf_network_ip_itemtitle", + "allowEmptyArray": true }, "options": { "dependencies": { "restirctedInternetAccessAPI": true } }, - "propertyOrder" : 3 + "propertyOrder": 3 }, - "localApiAuth" : - { - "type" : "boolean", - "title" : "edt_conf_net_localApiAuth_title", - "required" : true, - "default" : false, - "options": { - "dependencies": { - "apiAuth": true - } - }, - "propertyOrder" : 4 + "localApiAuth": { + "type": "boolean", + "title": "edt_conf_network_localApiAuth_title", + "required": true, + "default": false, + "propertyOrder": 4 } }, - "additionalProperties" : false + "additionalProperties": false } diff --git a/libsrc/hyperion/schema/schema-protoServer.json b/libsrc/hyperion/schema/schema-protoServer.json index d7d391e4d..11cde60f7 100644 --- a/libsrc/hyperion/schema/schema-protoServer.json +++ b/libsrc/hyperion/schema/schema-protoServer.json @@ -1,35 +1,31 @@ { - "type" : "object", - "title" : "edt_conf_pbs_heading_title", - "properties" : - { - "enable" : - { - "type" : "boolean", - "required" : true, - "title" : "edt_conf_general_enable_title", - "default" : true, - "propertyOrder" : 1 + "type": "object", + "title": "edt_conf_protoServer_heading_title", + "properties": { + "enable": { + "type": "boolean", + "required": true, + "title": "edt_conf_general_enable_title", + "default": true, + "propertyOrder": 1 }, - "port" : - { - "type" : "integer", - "required" : true, - "title" : "edt_conf_general_port_title", - "minimum" : 1024, - "maximum" : 65535, - "default" : 19445 + "port": { + "type": "integer", + "required": true, + "title": "edt_conf_general_port_title", + "minimum": 1024, + "maximum": 65535, + "default": 19445 }, - "timeout" : - { - "type" : "integer", - "required" : true, - "title" : "edt_conf_pbs_timeout_title", - "append" : "edt_append_s", - "minimum" : 1, - "default" : 5, - "propertyOrder" : 3 + "timeout": { + "type": "integer", + "required": true, + "title": "edt_conf_protoServer_timeout_title", + "append": "edt_append_s", + "minimum": 1, + "default": 5, + "propertyOrder": 3 } }, - "additionalProperties" : false + "additionalProperties": false } diff --git a/libsrc/hyperion/schema/schema-settings-full-relaxed.json b/libsrc/hyperion/schema/schema-settings-full-relaxed.json index dc7576a94..41e8d6801 100644 --- a/libsrc/hyperion/schema/schema-settings-full-relaxed.json +++ b/libsrc/hyperion/schema/schema-settings-full-relaxed.json @@ -25,7 +25,7 @@ "items":{ "type":"integer" }, - "minItems":1 + "minItems":0 }, "instances":{ "type":"array", diff --git a/libsrc/hyperion/schema/schema-settings-full.json b/libsrc/hyperion/schema/schema-settings-full.json index f1b35f9c4..c0597b86b 100644 --- a/libsrc/hyperion/schema/schema-settings-full.json +++ b/libsrc/hyperion/schema/schema-settings-full.json @@ -25,7 +25,7 @@ "items":{ "type":"integer" }, - "minItems":1 + "minItems":0 }, "instances":{ "type":"array", diff --git a/libsrc/hyperion/schema/schema-settings-global-relaxed.json b/libsrc/hyperion/schema/schema-settings-global-relaxed.json index 53070b91c..fe7489d04 100644 --- a/libsrc/hyperion/schema/schema-settings-global-relaxed.json +++ b/libsrc/hyperion/schema/schema-settings-global-relaxed.json @@ -5,6 +5,10 @@ "required":false, "$ref":"schema-cecEvents.json" }, + "effects":{ + "required":false, + "$ref":"schema-effects.json" + }, "flatbufServer":{ "required":false, "$ref":"schema-flatbufServer.json" diff --git a/libsrc/hyperion/schema/schema-settings-global.json b/libsrc/hyperion/schema/schema-settings-global.json index 6b1f3b858..99968784e 100644 --- a/libsrc/hyperion/schema/schema-settings-global.json +++ b/libsrc/hyperion/schema/schema-settings-global.json @@ -5,6 +5,10 @@ "required":true, "$ref":"schema-cecEvents.json" }, + "effects":{ + "required":true, + "$ref":"schema-effects.json" + }, "flatbufServer":{ "required":true, "$ref":"schema-flatbufServer.json" diff --git a/libsrc/hyperion/schema/schema-settings-instance-relaxed.json b/libsrc/hyperion/schema/schema-settings-instance-relaxed.json index 250e7c4e0..b514080f2 100644 --- a/libsrc/hyperion/schema/schema-settings-instance-relaxed.json +++ b/libsrc/hyperion/schema/schema-settings-instance-relaxed.json @@ -21,10 +21,6 @@ "required":false, "$ref":"schema-device.json" }, - "effects":{ - "required":false, - "$ref":"schema-effects.json" - }, "foregroundEffect":{ "required":false, "$ref":"schema-foregroundEffect.json" diff --git a/libsrc/hyperion/schema/schema-settings-instance.json b/libsrc/hyperion/schema/schema-settings-instance.json index 7bf78f499..9e79e1691 100644 --- a/libsrc/hyperion/schema/schema-settings-instance.json +++ b/libsrc/hyperion/schema/schema-settings-instance.json @@ -21,11 +21,7 @@ "required":true, "$ref":"schema-device.json" }, - "effects":{ - "required":true, - "$ref":"schema-effects.json" - }, - "foregroundEffect":{ + "foregroundEffect":{ "required":true, "$ref":"schema-foregroundEffect.json" }, diff --git a/libsrc/hyperion/schema/schema-webConfig.json b/libsrc/hyperion/schema/schema-webConfig.json index 6101dc762..398242e8c 100644 --- a/libsrc/hyperion/schema/schema-webConfig.json +++ b/libsrc/hyperion/schema/schema-webConfig.json @@ -1,19 +1,19 @@ { "type" : "object", - "title" : "edt_conf_webc_heading_title", + "title" : "edt_conf_webConfig_heading_title", "properties" : { "document_root" : { "type" : "string", - "title" : "edt_conf_webc_docroot_title", + "title" : "edt_conf_webConfig_docroot_title", "access" : "expert", "propertyOrder" : 2 }, "port" : { "type" : "integer", - "title" : "edt_conf_webc_port_title", + "title" : "edt_conf_webConfig_port_title", "minimum" : 80, "maximum" : 65535, "default" : 8090, @@ -22,7 +22,7 @@ "sslPort" : { "type" : "integer", - "title" : "edt_conf_webc_sslport_title", + "title" : "edt_conf_webConfig_sslPort_title", "required" : true, "minimum" : 80, "maximum" : 65535, @@ -32,7 +32,7 @@ "crtPath" : { "type" : "string", - "title" : "edt_conf_webc_crtPath_title", + "title" : "edt_conf_webConfig_crtPath_title", "required" : true, "default" : "", "propertyOrder" : 5 @@ -40,7 +40,7 @@ "keyPath" : { "type" : "string", - "title" : "edt_conf_webc_keyPath_title", + "title" : "edt_conf_webConfig_keyPath_title", "required" : true, "default" : "", "propertyOrder" : 6 @@ -48,7 +48,7 @@ "keyPassPhrase" : { "type" : "string", - "title" : "edt_conf_webc_keyPassPhrase_title", + "title" : "edt_conf_webConfig_keyPassPhrase_title", "required" : true, "default" : "", "propertyOrder" : 7 diff --git a/libsrc/leddevice/LedDevice.cpp b/libsrc/leddevice/LedDevice.cpp index 5772ce27f..0bd3135e9 100644 --- a/libsrc/leddevice/LedDevice.cpp +++ b/libsrc/leddevice/LedDevice.cpp @@ -11,6 +11,7 @@ #include "hyperion/Hyperion.h" #include +#include //std includes #include @@ -21,7 +22,7 @@ namespace { // Configuration settings - const char CONFIG_CURRENT_LED_COUNT[] = "currentLedCount"; + const char CONFIG_HARDWARE_LED_COUNT[] = "hardwareLedCount"; const char CONFIG_COLOR_ORDER[] = "colorOrder"; const char CONFIG_AUTOSTART[] = "autoStart"; const char CONFIG_LATCH_TIME[] = "latchTime"; @@ -101,6 +102,7 @@ void LedDevice::stop() this->disable(); this->stopRefreshTimer(); Info(_log, "Stopped LedDevice '%s'", QSTRING_CSTR(_activeDeviceType)); + emit isStopped(); } int LedDevice::open() @@ -132,7 +134,7 @@ void LedDevice::setInError(const QString& errorMsg, bool isRecoverable) _isDeviceRecoverable = isRecoverable; } Error(_log, "Device disabled, device '%s' signals error: '%s'", QSTRING_CSTR(_activeDeviceType), QSTRING_CSTR(errorMsg)); - emit enableStateChanged(_isEnabled); + emit isEnabledChanged(_isEnabled); } void LedDevice::enable() @@ -167,28 +169,32 @@ void LedDevice::enable() stopEnableAttemptsTimer(); _isEnabled = true; isEnableFailed = false; - emit enableStateChanged(_isEnabled); + emit isEnabledChanged(_isEnabled); Info(_log, "LedDevice '%s' enabled", QSTRING_CSTR(_activeDeviceType)); } } if (isEnableFailed) { - emit enableStateChanged(false); - - if (_maxEnableAttempts > 0 && _isDeviceRecoverable) - { - Debug(_log, "Device's enablement failed - Start retry timer. Retried already done [%d], isEnabled: [%d]", _enableAttempts, _isEnabled); - startEnableAttemptsTimer(); - } - else - { - Debug(_log, "Device's enablement failed"); - } + emit isEnabledChanged(false); + QMetaObject::invokeMethod(this, "retryEnable", Qt::QueuedConnection); } } } +void LedDevice::retryEnable() +{ + if (_maxEnableAttempts > 0 && _isDeviceRecoverable) + { + Debug(_log, "Device's enablement failed - Start retry timer. Retried already done [%d], isEnabled: [%d]", _enableAttempts, _isEnabled); + startEnableAttemptsTimer(); + } + else + { + Debug(_log, "Device's enablement failed"); + } +} + void LedDevice::disable() { Debug(_log, "Disable device %s'", QSTRING_CSTR(_activeDeviceType)); @@ -201,7 +207,7 @@ void LedDevice::disable() switchOff(); close(); - emit enableStateChanged(_isEnabled); + emit isEnabledChanged(_isEnabled); } } @@ -214,7 +220,7 @@ bool LedDevice::init(const QJsonObject& deviceConfig) { Debug(_log, "deviceConfig: [%s]", QString(QJsonDocument(_devConfig).toJson(QJsonDocument::Compact)).toUtf8().constData()); - setLedCount(deviceConfig[CONFIG_CURRENT_LED_COUNT].toInt(DEFAULT_LED_COUNT)); // property injected to reflect real led count + setLedCount(deviceConfig[CONFIG_HARDWARE_LED_COUNT].toInt(DEFAULT_LED_COUNT)); // property injected to reflect real led count setColorOrder(deviceConfig[CONFIG_COLOR_ORDER].toString(DEFAULT_COLOR_ORDER)); setLatchTime(deviceConfig[CONFIG_LATCH_TIME].toInt(_latchTime_ms)); setRewriteTime(deviceConfig[CONFIG_REWRITE_TIME].toInt(_refreshTimerInterval_ms)); @@ -235,9 +241,9 @@ void LedDevice::startRefreshTimer() // setup refreshTimer if (_refreshTimer == nullptr) { - _refreshTimer = new QTimer(this); + _refreshTimer.reset(new QTimer(this)); _refreshTimer->setTimerType(Qt::PreciseTimer); - connect(_refreshTimer, &QTimer::timeout, this, &LedDevice::rewriteLEDs); + connect(_refreshTimer.get(), &QTimer::timeout, this, &LedDevice::rewriteLEDs); } _refreshTimer->setInterval(_refreshTimerInterval_ms); _refreshTimer->start(); @@ -254,8 +260,6 @@ void LedDevice::stopRefreshTimer() if (_refreshTimer != nullptr) { _refreshTimer->stop(); - delete _refreshTimer; - _refreshTimer = nullptr; } } @@ -272,9 +276,9 @@ void LedDevice::startEnableAttemptsTimer() // setup enable retry timer if (_enableAttemptsTimer == nullptr) { - _enableAttemptsTimer = new QTimer(this); + _enableAttemptsTimer.reset(new QTimer(this)); _enableAttemptsTimer->setTimerType(Qt::PreciseTimer); - connect(_enableAttemptsTimer, &QTimer::timeout, this, &LedDevice::enable); + connect(_enableAttemptsTimer.get(), &QTimer::timeout, this, &LedDevice::enable); } _enableAttemptsTimer->setInterval(static_cast(_enableAttemptTimerInterval.count() * 1000)); //NOLINT @@ -296,8 +300,6 @@ void LedDevice::stopEnableAttemptsTimer() { Debug(_log, "Stopping enable retry timer"); _enableAttemptsTimer->stop(); - delete _enableAttemptsTimer; - _enableAttemptsTimer = nullptr; _enableAttempts = 0; } } @@ -366,16 +368,14 @@ int LedDevice::writeBlack(int numberOfWrites) int LedDevice::writeColor(const ColorRgb& color, int numberOfWrites) { + Debug(_log,"Writes: [%d]", numberOfWrites); int rc = -1; for (int i = 0; i < numberOfWrites; i++) { if (_latchTime_ms > 0) { - // Wait latch time before writing black - QEventLoop loop; - QTimer::singleShot(_latchTime_ms, &loop, &QEventLoop::quit); - loop.exec(); + wait(_latchTime_ms); } _lastLedValues = std::vector(static_cast(_ledCount), color); rc = write(_lastLedValues); @@ -403,7 +403,6 @@ bool LedDevice::switchOn() { Info(_log, "Device %s is ON", QSTRING_CSTR(_activeDeviceType)); _isOn = true; - emit enableStateChanged(_isEnabled); rc = true; } else @@ -412,6 +411,7 @@ bool LedDevice::switchOn() } } } + emit isOnChanged(_isOn); } return rc; } @@ -455,6 +455,7 @@ bool LedDevice::switchOff() } } } + emit isOnChanged(_isOn); } return rc; } diff --git a/libsrc/leddevice/LedDeviceWrapper.cpp b/libsrc/leddevice/LedDeviceWrapper.cpp index 535320745..52b738390 100644 --- a/libsrc/leddevice/LedDeviceWrapper.cpp +++ b/libsrc/leddevice/LedDeviceWrapper.cpp @@ -1,5 +1,7 @@ #include +#include + #include #include @@ -11,71 +13,59 @@ #include // qt -#include +#include #include #include +#include LedDeviceRegistry LedDeviceWrapper::_ledDeviceMap {}; - -#if (QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)) - QRecursiveMutex LedDeviceWrapper::_ledDeviceMapLock; -#else - QMutex LedDeviceWrapper::_ledDeviceMapLock{ QMutex::Recursive }; -#endif +static std::once_flag initFlag; LedDeviceWrapper::LedDeviceWrapper(Hyperion* hyperion) : QObject(hyperion) + , _log(nullptr) , _hyperion(hyperion) , _ledDevice(nullptr) - , _enabled(false) + , _isEnabled(false) + , _isOn(false) { - // prepare the device constructor map - #define REGISTER(className) LedDeviceWrapper::addToDeviceMap(QString(#className).toLower(), LedDevice##className::construct); - - // the REGISTER() calls are auto-generated by cmake. - #include "LedDevice_register.cpp" - - #undef REGISTER + QString const subComponent = parent()->property("instance").toString(); + _log = Logger::getInstance("LEDDEVICE", subComponent); _hyperion->setNewComponentState(hyperion::COMP_LEDDEVICE, false); } LedDeviceWrapper::~LedDeviceWrapper() { - stopDeviceThread(); } void LedDeviceWrapper::createLedDevice(const QJsonObject& config) { - if(_ledDevice != nullptr) + if (_ledDevice != nullptr) { - stopDeviceThread(); + stopDevice(); } - // create thread and device - QThread* thread = new QThread(this); - thread->setObjectName("LedDeviceThread"); - _ledDevice = LedDeviceFactory::construct(config); - - QString subComponent = parent()->property("instance").toString(); - _ledDevice->setLogger(Logger::getInstance("LEDDEVICE", subComponent)); - - _ledDevice->moveToThread(thread); - // setup thread management - connect(thread, &QThread::started, _ledDevice, &LedDevice::start); + _ledDeviceThread.reset(new QThread()); + _ledDeviceThread->setObjectName("LedDeviceThread"); + _ledDevice.reset(LedDeviceFactory::construct(config)); + _ledDevice->setLogger(_log); - // further signals - connect(this, &LedDeviceWrapper::updateLeds, _ledDevice, &LedDevice::updateLeds, Qt::BlockingQueuedConnection); + _ledDevice->moveToThread(_ledDeviceThread.get()); - connect(this, &LedDeviceWrapper::switchOn, _ledDevice, &LedDevice::switchOn, Qt::BlockingQueuedConnection); - connect(this, &LedDeviceWrapper::switchOff, _ledDevice, &LedDevice::switchOff, Qt::BlockingQueuedConnection); + connect(_ledDeviceThread.get(), &QThread::started, _ledDevice.get(), &LedDevice::start); + connect(this, &LedDeviceWrapper::updateLeds, _ledDevice.get(), &LedDevice::updateLeds); + connect(this, &LedDeviceWrapper::switchOn, _ledDevice.get(), &LedDevice::switchOn); + connect(this, &LedDeviceWrapper::switchOff, _ledDevice.get(), &LedDevice::switchOff); + connect(this, &LedDeviceWrapper::enable, _ledDevice.get(), &LedDevice::enable); + connect(this, &LedDeviceWrapper::disable, _ledDevice.get(), &LedDevice::disable); + connect(this, &LedDeviceWrapper::stop, _ledDevice.get(), &LedDevice::stop ); - connect(this, &LedDeviceWrapper::stopLedDevice, _ledDevice, &LedDevice::stop, Qt::BlockingQueuedConnection); + //Handle LED-device state changes + connect(_ledDevice.get(), &LedDevice::isEnabledChanged, this, &LedDeviceWrapper::onIsEnabledChanged); + connect(_ledDevice.get(), &LedDevice::isOnChanged, this, &LedDeviceWrapper::onIsOnChanged); - connect(_ledDevice, &LedDevice::enableStateChanged, this, &LedDeviceWrapper::handleInternalEnableState, Qt::QueuedConnection); - - // start the thread - thread->start(); + _ledDeviceThread->start(); } void LedDeviceWrapper::handleComponentState(hyperion::Components component, bool state) @@ -84,91 +74,114 @@ void LedDeviceWrapper::handleComponentState(hyperion::Components component, bool { if (state) { - QMetaObject::invokeMethod(_ledDevice, "enable", Qt::BlockingQueuedConnection); + emit enable(); } else { - QMetaObject::invokeMethod(_ledDevice, "disable", Qt::BlockingQueuedConnection); + emit disable(); } - - QMetaObject::invokeMethod(_ledDevice, "componentState", Qt::BlockingQueuedConnection, Q_RETURN_ARG(bool, _enabled)); } } -void LedDeviceWrapper::handleInternalEnableState(bool newState) +void LedDeviceWrapper::onIsEnabledChanged(bool isEnabled) { - _hyperion->setNewComponentState(hyperion::COMP_LEDDEVICE, newState); - _enabled = newState; + _hyperion->setNewComponentState(hyperion::COMP_LEDDEVICE, isEnabled); + _isEnabled = isEnabled; +} - if (_enabled) +void LedDeviceWrapper::onIsOnChanged(bool isOn) +{ + _isOn = isOn; + if (_isOn) { - _hyperion->update(); + _hyperion->refreshUpdate(); } } -void LedDeviceWrapper::stopDeviceThread() +void LedDeviceWrapper::stopDevice() { - // turns the LEDs off & stop refresh timers - emit stopLedDevice(); - - // get current thread - QThread* oldThread = _ledDevice->thread(); - disconnect(oldThread, nullptr, nullptr, nullptr); - oldThread->quit(); - oldThread->wait(); - delete oldThread; + Debug(_log, "Stop LED-Device thread"); + + //Disable updates to the LedDevice + disconnect(this, &LedDeviceWrapper::updateLeds, _ledDevice.get(), &LedDevice::updateLeds); + disconnect(this, &LedDeviceWrapper::switchOff, _ledDevice.get(), &LedDevice::switchOff); + disconnect(this, &LedDeviceWrapper::disable, _ledDevice.get(), &LedDevice::disable); + disconnect(this, &LedDeviceWrapper::enable, _ledDevice.get(), &LedDevice::enable); + disconnect(this, &LedDeviceWrapper::switchOn, _ledDevice.get(), &LedDevice::switchOn); + + // Create a local event loop to wait for the LedDevice isStopped signal + QEventLoop loop; + connect(_ledDevice.get(), &LedDevice::isStopped, &loop, &QEventLoop::quit); + // Turn the LEDs off & stops refresh timers + emit stop(); + loop.exec(); + + if (!_ledDeviceThread.isNull()) + { + if (_ledDeviceThread->isRunning()) + { + _ledDeviceThread->quit(); + _ledDeviceThread->wait(); + } + } - disconnect(_ledDevice, nullptr, nullptr, nullptr); - delete _ledDevice; - _ledDevice = nullptr; + Debug(_log, "LED-Device thread stopped"); + emit isStopped(); } QString LedDeviceWrapper::getActiveDeviceType() const { - QString value = 0; - QMetaObject::invokeMethod(_ledDevice, "getActiveDeviceType", Qt::BlockingQueuedConnection, Q_RETURN_ARG(QString, value)); + QString value = nullptr; + QMetaObject::invokeMethod(_ledDevice.get(), "getActiveDeviceType", Q_RETURN_ARG(QString, value)); return value; } -unsigned int LedDeviceWrapper::getLedCount() const +int LedDeviceWrapper::getLedCount() const { - int value = 0; - QMetaObject::invokeMethod(_ledDevice, "getLedCount", Qt::BlockingQueuedConnection, Q_RETURN_ARG(int, value)); - return value; + int count = 0; + QMetaObject::invokeMethod(_ledDevice.get(), "getLedCount", Qt::BlockingQueuedConnection, Q_RETURN_ARG(int, count)); + return count; } QString LedDeviceWrapper::getColorOrder() const { QString value; - QMetaObject::invokeMethod(_ledDevice, "getColorOrder", Qt::BlockingQueuedConnection, Q_RETURN_ARG(QString, value)); + QMetaObject::invokeMethod(_ledDevice.get(), "getColorOrder", Qt::BlockingQueuedConnection, Q_RETURN_ARG(QString, value)); return value; } int LedDeviceWrapper::getLatchTime() const { int value = 0; - QMetaObject::invokeMethod(_ledDevice, "getLatchTime", Qt::BlockingQueuedConnection, Q_RETURN_ARG(int, value)); + QMetaObject::invokeMethod(_ledDevice.get(), "getLatchTime", Qt::BlockingQueuedConnection, Q_RETURN_ARG(int, value)); return value; } -bool LedDeviceWrapper::enabled() const +bool LedDeviceWrapper::isEnabled() const { - return _enabled; + return _isEnabled; } -int LedDeviceWrapper::addToDeviceMap(QString name, LedDeviceCreateFuncType funcPtr) +bool LedDeviceWrapper::isOn() const { - QMutexLocker lock(&_ledDeviceMapLock); + return _isOn; +} - _ledDeviceMap.emplace(name,funcPtr); +void LedDeviceWrapper::initializeDeviceMap() +{ + std::call_once(initFlag, []() { + // Initialize the map once +#define REGISTER(className) _ledDeviceMap.emplace(QString(#className).toLower(), LedDevice##className::construct); - return 0; +#include "LedDevice_register.cpp" + +#undef REGISTER + }); } const LedDeviceRegistry& LedDeviceWrapper::getDeviceMap() { - QMutexLocker lock(&_ledDeviceMapLock); - + initializeDeviceMap(); // Ensure it is initialized before returning return _ledDeviceMap; } @@ -178,13 +191,14 @@ QJsonObject LedDeviceWrapper::getLedDeviceSchemas() Q_INIT_RESOURCE(LedDeviceSchemas); // read the JSON schema from the resource - QDir dir(":/leddevices/"); - QJsonObject result, schemaJson; + QDir const dir(":/leddevices/"); + QJsonObject result; + QJsonObject schemaJson; for(QString &item : dir.entryList()) { - QString schemaPath(QString(":/leddevices/")+item); - QString devName = item.remove("schema-"); + QString const schemaPath(QString(":/leddevices/")+item); + QString const devName = item.remove("schema-"); QString data; if(!FileUtils::readFile(schemaPath, data, Logger::getInstance("LEDDEVICE"))) @@ -193,10 +207,10 @@ QJsonObject LedDeviceWrapper::getLedDeviceSchemas() } QJsonObject schema; - QPair parsingResult = JsonUtils::parse(schemaPath, data, schema, Logger::getInstance("LEDDEVICE")); + QPair const parsingResult = JsonUtils::parse(schemaPath, data, schema, Logger::getInstance("LEDDEVICE")); if (!parsingResult.first) { - QStringList errorList = parsingResult.second; + QStringList const errorList = parsingResult.second; for (const auto& errorMessage : errorList) { Debug(Logger::getInstance("LEDDEVICE"), "JSON parse error: %s ", QSTRING_CSTR(errorMessage)); } diff --git a/libsrc/leddevice/dev_net/LedDevicePhilipsHue.cpp b/libsrc/leddevice/dev_net/LedDevicePhilipsHue.cpp index 54d7bd612..db1a1000a 100644 --- a/libsrc/leddevice/dev_net/LedDevicePhilipsHue.cpp +++ b/libsrc/leddevice/dev_net/LedDevicePhilipsHue.cpp @@ -1561,7 +1561,6 @@ bool PhilipsHueLight::isBusy() void PhilipsHueLight::setBlack() { - Debug(_log,""); CiColor black; black.bri = 0; black.x = 0; @@ -2647,7 +2646,7 @@ bool LedDevicePhilipsHue::switchOn() if (_isOn) { Info(_log, "Device %s is ON", QSTRING_CSTR(_activeDeviceType)); - emit enableStateChanged(_isEnabled); + emit isEnabledChanged(_isEnabled); rc =true; } else diff --git a/libsrc/leddevice/dev_net/LedDeviceRazer.cpp b/libsrc/leddevice/dev_net/LedDeviceRazer.cpp index 26a116a82..f80c4b31a 100644 --- a/libsrc/leddevice/dev_net/LedDeviceRazer.cpp +++ b/libsrc/leddevice/dev_net/LedDeviceRazer.cpp @@ -60,7 +60,7 @@ bool LedDeviceRazer::init(const QJsonObject& deviceConfig) { bool isInitOK = false; setRewriteTime(HEARTBEAT_INTERVALL.count()); - connect(_refreshTimer, &QTimer::timeout, this, &LedDeviceRazer::rewriteLEDs); + connect(_refreshTimer.get(), &QTimer::timeout, this, &LedDeviceRazer::rewriteLEDs); // Initialise sub-class if (LedDevice::init(deviceConfig)) diff --git a/libsrc/leddevice/dev_net/LedDeviceYeelight.cpp b/libsrc/leddevice/dev_net/LedDeviceYeelight.cpp index 327a7182a..408dc53d6 100644 --- a/libsrc/leddevice/dev_net/LedDeviceYeelight.cpp +++ b/libsrc/leddevice/dev_net/LedDeviceYeelight.cpp @@ -1041,7 +1041,7 @@ bool LedDeviceYeelight::init(const QJsonObject &deviceConfig) if ( deviceConfig[ CONFIG_COLOR_MODEL ].isString() ) { - _outputColorModel = deviceConfig[ CONFIG_COLOR_MODEL ].toString(QString(QChar(MODEL_RGB))).toInt(); + _outputColorModel = deviceConfig[ CONFIG_COLOR_MODEL ].toString(QString::number(MODEL_RGB)).toInt(); } else { @@ -1050,7 +1050,7 @@ bool LedDeviceYeelight::init(const QJsonObject &deviceConfig) if ( deviceConfig[ CONFIG_TRANS_EFFECT ].isString() ) { - _transitionEffect = static_cast( deviceConfig[ CONFIG_TRANS_EFFECT ].toString(QString(QChar(YeelightLight::API_EFFECT_SMOOTH))).toInt() ); + _transitionEffect = static_cast( deviceConfig[ CONFIG_TRANS_EFFECT ].toString(QString::number(YeelightLight::API_EFFECT_SMOOTH)).toInt() ); } else { diff --git a/libsrc/leddevice/dev_other/LedDeviceFile.cpp b/libsrc/leddevice/dev_other/LedDeviceFile.cpp index cc7ddd2d3..d84fc9307 100644 --- a/libsrc/leddevice/dev_other/LedDeviceFile.cpp +++ b/libsrc/leddevice/dev_other/LedDeviceFile.cpp @@ -3,6 +3,7 @@ // Qt includes #include #include +#include LedDeviceFile::LedDeviceFile(const QJsonObject &deviceConfig) : LedDevice(deviceConfig) @@ -13,7 +14,6 @@ LedDeviceFile::LedDeviceFile(const QJsonObject &deviceConfig) LedDeviceFile::~LedDeviceFile() { - delete _file; } LedDevice* LedDeviceFile::construct(const QJsonObject &deviceConfig) @@ -45,7 +45,7 @@ void LedDeviceFile::initFile(const QString &fileName) { if ( _file == nullptr ) { - _file = new QFile(fileName, this); + _file.reset(new QFile(fileName)); } } @@ -89,9 +89,20 @@ int LedDeviceFile::close() return retval; } +bool LedDeviceFile::powerOff() +{ + // Simulate power-off by writing a final "Black" to have a defined outcome + bool rc = false; + if ( writeBlack( 5 ) >= 0 ) + { + rc = true; + } + return rc; +} + int LedDeviceFile::write(const std::vector & ledValues) { - QTextStream out(_file); + QTextStream out(_file.get()); if ( _printTimeStamp ) { QDateTime now = QDateTime::currentDateTime(); diff --git a/libsrc/leddevice/dev_other/LedDeviceFile.h b/libsrc/leddevice/dev_other/LedDeviceFile.h index 950170073..dc80d7860 100644 --- a/libsrc/leddevice/dev_other/LedDeviceFile.h +++ b/libsrc/leddevice/dev_other/LedDeviceFile.h @@ -6,7 +6,7 @@ // Qt includes #include -#include +#include /// /// Implementation of the LedDevice that write the LED-colors to an @@ -59,6 +59,15 @@ class LedDeviceFile : public LedDevice /// int close() override; + /// + /// @brief Power-/turn off a file-device + /// + /// The off-state is simulated by writing "Black to LED" + /// + /// @return True, if success + /// + bool powerOff() override; + /// /// @brief Writes the RGB-Color values to the LEDs. /// @@ -68,7 +77,7 @@ class LedDeviceFile : public LedDevice int write(const std::vector & ledValues) override; /// The outputstream - QFile* _file; + QScopedPointer _file; private: diff --git a/libsrc/mdns/MdnsBrowser.cpp b/libsrc/mdns/MdnsBrowser.cpp index b0faa39e7..00a8fd7c8 100644 --- a/libsrc/mdns/MdnsBrowser.cpp +++ b/libsrc/mdns/MdnsBrowser.cpp @@ -15,31 +15,64 @@ #include #include #include +#include namespace { - const bool verboseBrowser = false; - const int SERVICE_LOOKUP_RETRIES = 5; +const bool verboseBrowser = false; +const int SERVICE_LOOKUP_RETRIES = 5; } // End of constants -QScopedPointer MdnsBrowser::instance; +QSharedPointer MdnsBrowser::instance; MdnsBrowser::MdnsBrowser(QObject* parent) : QObject(parent) , _log(Logger::getInstance("MDNS")) + , _server(nullptr) + , _cache(nullptr) { + qRegisterMetaType("QMdnsEngine::Message"); qRegisterMetaType("QHostAddress"); } MdnsBrowser::~MdnsBrowser() +{ +} + +void MdnsBrowser::initMdns() +{ + if (!_server) // Ensure it only initializes once + { + _server.reset(new QMdnsEngine::Server()); + _cache.reset(new QMdnsEngine::Cache()); + } +} + +void MdnsBrowser::stop() { _browsedServiceTypes.clear(); + _cache.reset(); + _server.reset(); } -QScopedPointer& MdnsBrowser::getInstance() +QSharedPointer& MdnsBrowser::getInstance(QThread* externalThread) { - if (!instance) + static QSharedPointer instance; + + if (instance.isNull()) { instance.reset(new MdnsBrowser()); + + if (externalThread != nullptr) // Move to existing thread if provided + { + instance->moveToThread(externalThread); + + // Ensure _server and _cache are initialized inside externalThread + QMetaObject::invokeMethod(instance.get(), "initMdns", Qt::QueuedConnection); + } + else + { + instance->initMdns(); // Run in the same thread + } } return instance; @@ -50,7 +83,7 @@ void MdnsBrowser::browseForServiceType(const QByteArray& serviceType) if (!_browsedServiceTypes.contains(serviceType)) { DebugIf(verboseBrowser, _log, "Start new mDNS browser for serviceType [%s], Thread: %s", serviceType.constData(), QSTRING_CSTR(QThread::currentThread()->objectName())); - QSharedPointer newBrowser = QSharedPointer::create(&_server, serviceType, &_cache); + QSharedPointer const newBrowser = QSharedPointer::create(_server.get(), serviceType, _cache.get()); QObject::connect(newBrowser.get(), &QMdnsEngine::Browser::serviceAdded, this, &MdnsBrowser::onServiceAdded); QObject::connect(newBrowser.get(), &QMdnsEngine::Browser::serviceUpdated, this, &MdnsBrowser::onServiceUpdated); @@ -81,69 +114,6 @@ void MdnsBrowser::onServiceRemoved(const QMdnsEngine::Service& service) emit serviceRemoved(service); } -QHostAddress MdnsBrowser::getHostFirstAddress(const QByteArray& hostname) -{ - DebugIf(verboseBrowser, _log, "for hostname [%s], Thread: %s", hostname.constData(), QSTRING_CSTR(QThread::currentThread()->objectName())); - QByteArray toBeResolvedHostName {hostname}; - - QHostAddress hostAddress; - - if (toBeResolvedHostName.endsWith(".local")) - { - toBeResolvedHostName.append('.'); - } - if (toBeResolvedHostName.endsWith(".local.")) - { - QList aRecords; - if (_cache.lookupRecords(toBeResolvedHostName, QMdnsEngine::A, aRecords)) - { - foreach(QMdnsEngine::Record record, aRecords) - { - // Do not publish link local addresses -#if (QT_VERSION >= QT_VERSION_CHECK(5, 11, 0)) - if (!record.address().isLinkLocal()) -#else - if (!record.address().toString().startsWith("fe80")) -#endif - { - hostAddress = record.address(); - DebugIf(verboseBrowser, _log, "Hostname [%s] translates to IPv4-address [%s]", toBeResolvedHostName.constData(), QSTRING_CSTR(hostAddress.toString())); - break; - } - } - } - else - { - QList aaaaRecords; - if (_cache.lookupRecords(toBeResolvedHostName, QMdnsEngine::AAAA, aaaaRecords)) - { - foreach(QMdnsEngine::Record record, aaaaRecords) - { - // Do not publish link local addresses -#if (QT_VERSION >= QT_VERSION_CHECK(5, 11, 0)) - if (!record.address().isLinkLocal()) -#else - if (!record.address().toString().startsWith("fe80")) -#endif - { - hostAddress = record.address(); - DebugIf(verboseBrowser, _log, "Hostname [%s] translates to IPv6-address [%s]", toBeResolvedHostName.constData(), QSTRING_CSTR(hostAddress.toString())); - break; - } - } - } - else - { - DebugIf(verboseBrowser, _log, "IP-address for hostname [%s] not yet in cache, start resolver.", toBeResolvedHostName.constData()); - qRegisterMetaType("Message"); - _resolver.reset(new QMdnsEngine::Resolver(&_server, toBeResolvedHostName, &_cache)); - connect(_resolver.get(), &QMdnsEngine::Resolver::resolved, this, &MdnsBrowser::onHostNameResolved); - } - } - } - return hostAddress; -} - void MdnsBrowser::onHostNameResolved(const QHostAddress& address) { DebugIf(verboseBrowser, _log, "for address [%s], Thread: %s", QSTRING_CSTR(address.toString()), QSTRING_CSTR(QThread::currentThread()->objectName())); @@ -155,61 +125,68 @@ void MdnsBrowser::onHostNameResolved(const QHostAddress& address) if (!address.toString().startsWith("fe80")) #endif { - emit addressResolved(address); + emit isAddressResolved(address); } } -bool MdnsBrowser::resolveAddress(Logger* log, const QString& hostname, QHostAddress& hostAddress, std::chrono::milliseconds timeout) +void MdnsBrowser::resolveFirstAddress(Logger* log, const QString& hostname, std::chrono::milliseconds timeout) { - DebugIf(verboseBrowser, log, "Get address for hostname [%s], Thread: %s", QSTRING_CSTR(hostname), QSTRING_CSTR(QThread::currentThread()->objectName())); + qRegisterMetaType("Message"); + + QHostAddress resolvedAddress; - bool isHostAddressOK{ false }; if (hostname.endsWith(".local") || hostname.endsWith(".local.")) { - hostAddress = getHostFirstAddress(hostname.toUtf8()); + QMdnsEngine::Resolver const resolver (_server.get(), hostname.toUtf8(), _cache.get()); + connect(&resolver, &QMdnsEngine::Resolver::resolved, this, &MdnsBrowser::onHostNameResolved); - if (hostAddress.isNull()) - { - DebugIf(verboseBrowser, log, "Wait for resolver on hostname [%s]", QSTRING_CSTR(hostname)); + DebugIf(verboseBrowser, log, "Wait for resolver on hostname [%s]", QSTRING_CSTR(hostname)); - QEventLoop loop; - QTimer timer; + QEventLoop loop; + QTimer timer; - QObject::connect(MdnsBrowser::getInstance().data(), &MdnsBrowser::addressResolved, &loop, &QEventLoop::quit); - weakConnect(MdnsBrowser::getInstance().data(), &MdnsBrowser::addressResolved, - [&hostAddress, hostname, log](const QHostAddress& resolvedAddress) { - DebugIf(verboseBrowser, log, "Resolver resolved hostname [%s] to address [%s], Thread: %s", QSTRING_CSTR(hostname), QSTRING_CSTR(resolvedAddress.toString()), QSTRING_CSTR(QThread::currentThread()->objectName())); - hostAddress = resolvedAddress; - }); + timer.setSingleShot(true); + connect(&timer, &QTimer::timeout, this, [&loop]() { + loop.quit(); // Stop waiting if timeout occurs + }); - QTimer::connect(&timer, &QTimer::timeout, &loop, &QEventLoop::quit); - timer.start(static_cast(timeout.count())); - loop.exec(); - } + std::unique_ptr context{new QObject}; + QObject* pcontext = context.get(); + connect(this, &MdnsBrowser::isAddressResolved, pcontext, [ &loop, &resolvedAddress, context = std::move(context)](const QHostAddress &address) mutable { + resolvedAddress = address; + loop.quit(); + context.reset(); + }); - if (!hostAddress.isNull()) + timer.start(timeout); + loop.exec(); + + if (!resolvedAddress.isNull()) { - Debug(log, "Resolved mDNS hostname [%s] to address [%s]", QSTRING_CSTR(hostname), QSTRING_CSTR(hostAddress.toString())); - isHostAddressOK = true; + Debug(log, "Resolved mDNS hostname [%s] to address [%s]", QSTRING_CSTR(hostname), QSTRING_CSTR(resolvedAddress.toString())); } else { - QObject::disconnect(MdnsBrowser::getInstance().data(), &MdnsBrowser::addressResolved, nullptr, nullptr); - Error(log, "Resolved mDNS hostname [%s] timed out", QSTRING_CSTR(hostname)); + Error(log, "Failed to resolve mDNS hostname [%s]", QSTRING_CSTR(hostname)); } } else { Error(log, "Hostname [%s] is not an mDNS hostname.", QSTRING_CSTR(hostname)); - isHostAddressOK = false; } - return isHostAddressOK; + + emit isFirstAddressResolved(resolvedAddress); } -QMdnsEngine::Record MdnsBrowser::getServiceInstanceRecord(const QByteArray& serviceInstance, const std::chrono::milliseconds waitTime) const +void MdnsBrowser::resolveServiceInstance(const QByteArray& serviceInstance, const std::chrono::milliseconds waitTime) const { DebugIf(verboseBrowser, _log, "Get service instance [%s] details, Thread: %s",serviceInstance.constData(), QSTRING_CSTR(QThread::currentThread()->objectName())); + if (_cache.isNull()) + { + return; + } + QByteArray service{ serviceInstance }; if (!service.endsWith('.')) @@ -220,9 +197,10 @@ QMdnsEngine::Record MdnsBrowser::getServiceInstanceRecord(const QByteArray& serv QMdnsEngine::Record srvRecord; bool found { false }; int retries { SERVICE_LOOKUP_RETRIES }; - do + + while (!found && retries >= 0) { - if (_cache.lookupRecord(service, QMdnsEngine::SRV, srvRecord)) + if (!_cache.isNull() && _cache->lookupRecord(service, QMdnsEngine::SRV, srvRecord)) { found = true; } @@ -231,95 +209,90 @@ QMdnsEngine::Record MdnsBrowser::getServiceInstanceRecord(const QByteArray& serv wait(waitTime); --retries; } + } - } while (!found && retries >= 0); - - if (found) + if (!_server.isNull()) { - DebugIf(verboseBrowser, _log, "Service record found for service instance [%s]", service.constData()); + if (found) + { + DebugIf(verboseBrowser, _log, "Service record found for service instance [%s]", service.constData()); + } + else + { + Debug(_log, "No service record found for service instance [%s]", service.constData()); + } } - else - { - Debug(_log, "No service record found for service instance [%s]", service.constData()); - } - return srvRecord; + emit isServiceRecordResolved(srvRecord); } QMdnsEngine::Service MdnsBrowser::getFirstService(const QByteArray& serviceType, const QString& filter, const std::chrono::milliseconds waitTime) const { - DebugIf(verboseBrowser,_log, "Get first service of type [%s], matching name: [%s]", QSTRING_CSTR(QString(serviceType)), QSTRING_CSTR(filter)); + DebugIf(verboseBrowser, _log, "Get first service of type [%s], matching name: [%s]", QSTRING_CSTR(QString(serviceType)), QSTRING_CSTR(filter)); + + if (_cache.isNull()) + { + return {}; + } QMdnsEngine::Service service; + QRegularExpression const regEx(filter); - QRegularExpression regEx(filter); if (!regEx.isValid()) { QString errorString = regEx.errorString(); - int errorOffset = regEx.patternErrorOffset(); + qsizetype const errorOffset = regEx.patternErrorOffset(); Error(_log, "Filtering regular expression [%s] error [%d]:[%s]", QSTRING_CSTR(filter), errorOffset, QSTRING_CSTR(errorString)); + return service; } - else - { - QList ptrRecords; - bool found {false}; - int retries = 3; - do + bool found { false }; + int retries = 3; + QList ptrRecords; + + while (!found && retries >= 0) + { + if (!_cache.isNull() && _cache->lookupRecords(serviceType, QMdnsEngine::PTR, ptrRecords)) { - if (_cache.lookupRecords(serviceType, QMdnsEngine::PTR, ptrRecords)) + for (const auto& ptrRecord : std::as_const(ptrRecords)) { - for (int ptrCounter = 0; ptrCounter < ptrRecords.size(); ++ptrCounter) - { - QByteArray serviceNameFull = ptrRecords.at(ptrCounter).target(); + QByteArray const serviceNameFull = ptrRecord.target(); - QRegularExpressionMatch match = regEx.match(serviceNameFull.constData()); - if (match.hasMatch()) + if (regEx.match(serviceNameFull.constData()).hasMatch()) + { + QMdnsEngine::Record srvRecord; + if (_cache->lookupRecord(serviceNameFull, QMdnsEngine::SRV, srvRecord)) { - QMdnsEngine::Record srvRecord; - if (!_cache.lookupRecord(serviceNameFull, QMdnsEngine::SRV, srvRecord)) - { - DebugIf(verboseBrowser, _log, "No SRV record for [%s] found, skip entry", serviceNameFull.constData()); - } - else - { - if (serviceNameFull.endsWith("." + serviceType)) - { - service.setName(serviceNameFull.left(serviceNameFull.length() - serviceType.length() - 1)); - } - else - { - service.setName(srvRecord.name()); - } - service.setPort(srvRecord.port()); + service.setName(serviceNameFull.endsWith("." + serviceType) + ? serviceNameFull.left(serviceNameFull.length() - serviceType.length() - 1) + : srvRecord.name()); - QByteArray hostName = srvRecord.target(); - //Remove trailing dot - hostName.chop(1); - service.setHostname(hostName); - service.setAttributes(srvRecord.attributes()); - found = true; - } + service.setPort(srvRecord.port()); + + QByteArray hostName = srvRecord.target(); + hostName.chop(1); // Remove trailing dot + service.setHostname(hostName); + service.setAttributes(srvRecord.attributes()); + found = true; } } } - else - { - wait(waitTime); - --retries; - } - - } while (!found && retries >= 0); + } - if (found) + if (!found) { - DebugIf(verboseBrowser,_log, "Service of type [%s] found", serviceType.constData()); + wait(waitTime); // Uses your existing wait function with event loop + --retries; } - else - { - Debug(_log, "No service of type [%s] found", serviceType.constData()); + } - } + if (found) + { + DebugIf(verboseBrowser, _log, "Service of type [%s] found", serviceType.constData()); + } + else + { + Debug(_log, "No service of type [%s] found", serviceType.constData()); } return service; @@ -329,12 +302,17 @@ QJsonArray MdnsBrowser::getServicesDiscoveredJson(const QByteArray& serviceType, { DebugIf(verboseBrowser,_log, "Get services of type [%s], matching name: [%s], Thread: %s", QSTRING_CSTR(QString(serviceType)), QSTRING_CSTR(filter), QSTRING_CSTR(QThread::currentThread()->objectName())); + if (_cache.isNull()) + { + return {}; + } + QJsonArray result; - QRegularExpression regEx(filter); + QRegularExpression const regEx(filter); if (!regEx.isValid()) { - QString errorString = regEx.errorString(); - int errorOffset = regEx.patternErrorOffset(); + QString const errorString = regEx.errorString(); + qsizetype const errorOffset = regEx.patternErrorOffset(); Error(_log, "Filtering regular expression [%s] error [%d]:[%s]", QSTRING_CSTR(filter), errorOffset, QSTRING_CSTR(errorString)); } @@ -345,24 +323,22 @@ QJsonArray MdnsBrowser::getServicesDiscoveredJson(const QByteArray& serviceType, int retries = 3; do { - if (_cache.lookupRecords(serviceType, QMdnsEngine::PTR, ptrRecords)) + if (!_cache.isNull() && _cache->lookupRecords(serviceType, QMdnsEngine::PTR, ptrRecords)) { - for (int ptrCounter = 0; ptrCounter < ptrRecords.size(); ++ptrCounter) + for (const auto& ptrRecord : std::as_const(ptrRecords)) { - QByteArray serviceName = ptrRecords.at(ptrCounter).target(); - - QRegularExpressionMatch match = regEx.match(serviceName.constData()); - if (match.hasMatch()) + QByteArray const serviceName = ptrRecord.target(); + if (regEx.match(serviceName.constData()).hasMatch()) { QMdnsEngine::Record srvRecord; - if (!_cache.lookupRecord(serviceName, QMdnsEngine::SRV, srvRecord)) + if (!_cache->lookupRecord(serviceName, QMdnsEngine::SRV, srvRecord)) { Debug(_log, "No SRV record for [%s] found, skip entry", serviceName.constData()); } else { QJsonObject obj; - QString domain = "local."; + QString const domain = "local."; obj.insert("id", serviceName.constData()); @@ -396,13 +372,13 @@ QJsonArray MdnsBrowser::getServicesDiscoveredJson(const QByteArray& serviceType, } obj.insert("sameHost", isSameHost); - quint16 port = srvRecord.port(); + quint16 const port = srvRecord.port(); obj.insert("port", port); QMdnsEngine::Record txtRecord; - if (_cache.lookupRecord(serviceName, QMdnsEngine::TXT, txtRecord)) + if (_cache->lookupRecord(serviceName, QMdnsEngine::TXT, txtRecord)) { - QMap txtAttributes = txtRecord.attributes(); + QMap const txtAttributes = txtRecord.attributes(); QVariantMap txtMap; QMapIterator iterator(txtAttributes); @@ -428,7 +404,7 @@ QJsonArray MdnsBrowser::getServicesDiscoveredJson(const QByteArray& serviceType, if (!result.isEmpty()) { - DebugIf(verboseBrowser,_log, "result: [%s]", QString(QJsonDocument(result).toJson(QJsonDocument::Compact)).toUtf8().constData()); + DebugIf(verboseBrowser,_log, "result: [%s]", QSTRING_CSTR(JsonUtils::jsonValueToQString(result))); } else { @@ -444,36 +420,37 @@ void MdnsBrowser::printCache(const QByteArray& name, quint16 type) const { DebugIf(verboseBrowser,_log, "for type: %s", QSTRING_CSTR(QMdnsEngine::typeName(type))); QList records; - if (_cache.lookupRecords(name, type, records)) + if (!_cache.isNull() && _cache->lookupRecords(name, type, records)) { - qDebug() << ""; - foreach(QMdnsEngine::Record record, records) + foreach(QMdnsEngine::Record const record, records) { qDebug() << QMdnsEngine::typeName(record.type()) << "," << record.name() << "], ttl : " << record.ttl(); switch (record.type()) { case QMdnsEngine::PTR: qDebug() << QMdnsEngine::typeName(record.type()) << "," << record.name() << ", target : " << record.target(); - break; + break; case QMdnsEngine::SRV: qDebug() << QMdnsEngine::typeName(record.type()) << "," << record.name() << ", target : " << record.target(); qDebug() << QMdnsEngine::typeName(record.type()) << "," << record.name() << ", port : " << record.port(); qDebug() << QMdnsEngine::typeName(record.type()) << "," << record.name() << ", priority : " << record.priority(); qDebug() << QMdnsEngine::typeName(record.type()) << "," << record.name() << ", weight : " << record.weight(); - break; + break; case QMdnsEngine::TXT: qDebug() << QMdnsEngine::typeName(record.type()) << "," << record.name() << ", attributes: " << record.attributes(); - break; + break; case QMdnsEngine::NSEC: qDebug() << QMdnsEngine::typeName(record.type()) << "," << record.name() << ", nextDomNam: " << record.nextDomainName(); - break; + break; case QMdnsEngine::A: case QMdnsEngine::AAAA: qDebug() << QMdnsEngine::typeName(record.type()) << "," << record.name() << ", address : " << record.address(); - break; + break; + default: + break; } } } diff --git a/libsrc/mdns/MdnsProvider.cpp b/libsrc/mdns/MdnsProvider.cpp index eaaffb7f9..b5df49dbe 100644 --- a/libsrc/mdns/MdnsProvider.cpp +++ b/libsrc/mdns/MdnsProvider.cpp @@ -22,6 +22,10 @@ MdnsProvider::MdnsProvider(QObject* parent) { } +MdnsProvider::~MdnsProvider() +{ +} + void MdnsProvider::init() { _server.reset(new QMdnsEngine::Server()); @@ -31,9 +35,11 @@ void MdnsProvider::init() DebugIf(verboseProvider, _log, "Hostname [%s], isRegistered [%d]", _hostname->hostname().constData(), _hostname->isRegistered()); } -MdnsProvider::~MdnsProvider() +void MdnsProvider::stop() { _providedServiceTypes.clear(); + _server.reset(); + _hostname.reset(); Info(_log, "mDNS info service stopped"); } @@ -49,7 +55,6 @@ void MdnsProvider::publishService(const QString& serviceType, quint16 servicePor { QSharedPointer newProvider = QSharedPointer::create(_server.data(), _hostname.data()); _providedServiceTypes.insert(type, newProvider); - } QSharedPointer provider = _providedServiceTypes.value(type); diff --git a/libsrc/protoserver/ProtoServer.cpp b/libsrc/protoserver/ProtoServer.cpp index aa8061259..0300d868b 100644 --- a/libsrc/protoserver/ProtoServer.cpp +++ b/libsrc/protoserver/ProtoServer.cpp @@ -19,24 +19,22 @@ const char SERVICE_TYPE[] = "protobuffer"; ProtoServer::ProtoServer(const QJsonDocument& config, QObject* parent) : QObject(parent) - , _server(new QTcpServer(this)) + , _server(nullptr) , _log(Logger::getInstance("PROTOSERVER")) , _timeout(5000) , _config(config) { - } ProtoServer::~ProtoServer() { - stopServer(); - delete _server; } void ProtoServer::initServer() { + _server.reset(new QTcpServer()); _netOrigin = NetOrigin::getInstance(); - connect(_server, &QTcpServer::newConnection, this, &ProtoServer::newConnection); + connect(_server.get(), &QTcpServer::newConnection, this, &ProtoServer::newConnection); // apply config handleSettingsUpdate(settings::PROTOSERVER, _config); @@ -53,14 +51,14 @@ void ProtoServer::handleSettingsUpdate(settings::type type, const QJsonDocument& // port check if(_server->serverPort() != port) { - stopServer(); + stop(); _port = port; } // new timeout just for new connections _timeout = obj["timeout"].toInt(5000); // enable check - obj["enable"].toBool(true) ? startServer() : stopServer(); + obj["enable"].toBool(true) ? start() : stop(); } } @@ -97,7 +95,7 @@ void ProtoServer::clientDisconnected() _openConnections.removeAll(client); } -void ProtoServer::startServer() +void ProtoServer::start() { if(!_server->isListening()) { @@ -113,7 +111,7 @@ void ProtoServer::startServer() } } -void ProtoServer::stopServer() +void ProtoServer::stop() { if(_server->isListening()) { @@ -122,7 +120,8 @@ void ProtoServer::stopServer() { client->forceClose(); } + _openConnections.clear(); _server->close(); - Info(_log, "Stopped"); + Info(_log, "ProtocolBuffer-Server stopped"); } } diff --git a/libsrc/python/CMakeLists.txt b/libsrc/python/CMakeLists.txt index 63710c5c1..ba5b199a2 100644 --- a/libsrc/python/CMakeLists.txt +++ b/libsrc/python/CMakeLists.txt @@ -47,3 +47,7 @@ target_compile_definitions(python PRIVATE PYTHON_VERSION_MAJOR=${PYTHON_VERSION_MAJOR} PYTHON_VERSION_MINOR=${PYTHON_VERSION_MINOR} ) + +if(DEFINED ENV{GITHUB_ACTIONS}) + target_compile_definitions(python PUBLIC GITHUB_ACTIONS) +endif() diff --git a/libsrc/ssdp/SSDPHandler.cpp b/libsrc/ssdp/SSDPHandler.cpp index 5f2dd021f..7271d01bc 100644 --- a/libsrc/ssdp/SSDPHandler.cpp +++ b/libsrc/ssdp/SSDPHandler.cpp @@ -1,71 +1,51 @@ #include -#include #include "SSDPDescription.h" #include #include #include #include -#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0)) -#include -#endif #if (QT_VERSION >= QT_VERSION_CHECK(5, 10, 0)) #include #endif +const char HTTP_SERVICE_TYPE[] = "http"; +const char HTTPS_SERVICE_TYPE[] = "https"; +const char JSONAPI_SERVICE_TYPE[] = "jsonapi"; +const char FLATBUFFER_SERVICE_TYPE[] = "flatbuffer"; +const char PROTOBUFFER_SERVICE_TYPE[] = "protobuffer"; + static const QString SSDP_IDENTIFIER("urn:hyperion-project.org:device:basic:1"); -SSDPHandler::SSDPHandler(WebServer* webserver, quint16 flatBufPort, quint16 protoBufPort, quint16 jsonServerPort, quint16 sslPort, const QString& name, QObject* parent) +SSDPHandler::SSDPHandler(QObject* parent) : SSDPServer(parent) - , _webserver(webserver) -#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0)) - , _NCA(nullptr) -#endif + , _httpPort(8090) + , _httpsPort(8092) + , _jsonApiPort(19444) + , _flatBufferPort(19400) + , _protoBufferPort(19445) { - setFlatBufPort(flatBufPort); - setProtoBufPort(protoBufPort); - setJsonServerPort(jsonServerPort); - setSSLServerPort(sslPort); - setHyperionName(name); - Debug(_log, "SSDP info service created"); } SSDPHandler::~SSDPHandler() { - stopServer(); } void SSDPHandler::initServer() { MetaTable metaTable; - _uuid = metaTable.getUUID(); - SSDPServer::setUuid(_uuid); - + setUuid(metaTable.getUUID()); // announce targets _deviceList.push_back("upnp:rootdevice"); - _deviceList.push_back("uuid:" + _uuid); + _deviceList.push_back("uuid:" + getUuid()); _deviceList.push_back(SSDP_IDENTIFIER); // prep server SSDPServer::initServer(); -#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0)) - #if (QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)) - QT_WARNING_PUSH - QT_WARNING_DISABLE_DEPRECATED - #endif - - _NCA = new QNetworkConfigurationManager(this); - connect(_NCA, &QNetworkConfigurationManager::configurationChanged, this, &SSDPHandler::handleNetworkConfigurationChanged); - - #if (QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)) - QT_WARNING_POP - #endif -#endif - // listen for mSearchRequestes connect(this, &SSDPServer::msearchRequestReceived, this, &SSDPHandler::handleMSearchRequest); @@ -74,18 +54,9 @@ void SSDPHandler::initServer() { _localAddress = getLocalAddress(); } - - // startup if localAddress is found - bool isInited = false; - QMetaObject::invokeMethod(_webserver, "isInited", Qt::BlockingQueuedConnection, Q_RETURN_ARG(bool, isInited)); - - if (!_localAddress.isEmpty() && isInited) - { - handleWebServerStateChange(true); - } } -void SSDPHandler::stopServer() +void SSDPHandler::stop() { sendAnnounceList(false); SSDPServer::stop(); @@ -94,92 +65,114 @@ void SSDPHandler::stopServer() void SSDPHandler::handleSettingsUpdate(settings::type type, const QJsonDocument& config) { + bool isSsdpInfoUpdated {false}; const QJsonObject& obj = config.object(); - if (type == settings::FLATBUFSERVER) + switch (type) { + case settings::FLATBUFSERVER: { - if (obj["port"].toInt() != SSDPServer::getFlatBufPort()) + int port = (obj["port"].toInt()); + if ( port != _flatBufferPort) { - SSDPServer::setFlatBufPort(obj["port"].toInt()); + _flatBufferPort = port; + isSsdpInfoUpdated = true; } } - - if (type == settings::PROTOSERVER) + break; + case settings::PROTOSERVER: { - if (obj["port"].toInt() != SSDPServer::getProtoBufPort()) + int port = (obj["port"].toInt()); + if ( port != _protoBufferPort) { - SSDPServer::setProtoBufPort(obj["port"].toInt()); + _protoBufferPort = port; + isSsdpInfoUpdated = true; } } - - if (type == settings::JSONSERVER) + break; + case settings::JSONSERVER: { - if (obj["port"].toInt() != SSDPServer::getJsonServerPort()) + int port = (obj["port"].toInt()); + if ( port != _jsonApiPort) { - SSDPServer::setJsonServerPort(obj["port"].toInt()); + _jsonApiPort = port; + isSsdpInfoUpdated = true; } } - - if (type == settings::WEBSERVER) + break; + case settings::WEBSERVER: { - if (obj["sslPort"].toInt() != SSDPServer::getSSLServerPort()) + int httpPort = (obj["port"].toInt()); + int httpsPort = (obj["sslPort"].toInt()); + + if ( httpPort != _httpPort || httpsPort != _httpPort) { - SSDPServer::setSSLServerPort(obj["sslPort"].toInt()); + _httpPort = httpPort; + setDescriptionAddress(getDescriptionAddress()); + + _httpsPort = httpsPort; + isSsdpInfoUpdated = true; } } - - if (type == settings::GENERAL) + break; + case settings::GENERAL: { - if (obj["name"].toString() != SSDPServer::getHyperionName()) + QString name = (obj["name"].toString()); + if ( name != _name) { - SSDPServer::setHyperionName(obj["name"].toString()); + _name = name; + isSsdpInfoUpdated = true; } } + break; + default: + break; + } + + if (isSsdpInfoUpdated) + { + emit descriptionUpdated(getDescription()); + } } -void SSDPHandler::handleWebServerStateChange(bool newState) +void SSDPHandler::onPortChanged(const QString& serviceType, quint16 servicePort) { - if (newState) + if (serviceType == HTTP_SERVICE_TYPE) { - // refresh info - QMetaObject::invokeMethod(_webserver, "setSSDPDescription", Qt::BlockingQueuedConnection, Q_ARG(QString, buildDesc())); - setDescriptionAddress(getDescAddress()); - if (start()) - sendAnnounceList(true); + _httpPort = servicePort; } - else + else if (serviceType == HTTPS_SERVICE_TYPE) { - QMetaObject::invokeMethod(_webserver, "setSSDPDescription", Qt::BlockingQueuedConnection, Q_ARG(QString, "")); - sendAnnounceList(false); - stop(); + _httpsPort = servicePort; } + else if (serviceType == JSONAPI_SERVICE_TYPE) + { + _jsonApiPort = servicePort; + } + else if (serviceType == FLATBUFFER_SERVICE_TYPE) + { + _flatBufferPort = servicePort; + } + else if (serviceType == PROTOBUFFER_SERVICE_TYPE) + { + _protoBufferPort = servicePort; + } + emit descriptionUpdated(getDescription()); } -#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0)) -#if (QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)) -QT_WARNING_PUSH -QT_WARNING_DISABLE_DEPRECATED -#endif -void SSDPHandler::handleNetworkConfigurationChanged(const QNetworkConfiguration& config) +void SSDPHandler::onStateChange(bool state) { - // get localAddress from interface - QString localAddress = getLocalAddress(); - if (!localAddress.isEmpty() && _localAddress != localAddress) + if (state) { - // revoke old ip - sendAnnounceList(false); - - // update desc & notify new ip - _localAddress = localAddress; - QMetaObject::invokeMethod(_webserver, "setSSDPDescription", Qt::BlockingQueuedConnection, Q_ARG(QString, buildDesc())); - setDescriptionAddress(getDescAddress()); - sendAnnounceList(true); + if (start()) + { + sendAnnounceList(true); + } + } + else + { + stop(); } } -#if (QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)) -QT_WARNING_POP -#endif -#endif QString SSDPHandler::getLocalAddress() const { @@ -225,19 +218,17 @@ void SSDPHandler::handleMSearchRequest(const QString& target, const QString& mx, } } -QString SSDPHandler::getDescAddress() const +QString SSDPHandler::getDescriptionAddress() const { return getBaseAddress() + "description.xml"; } QString SSDPHandler::getBaseAddress() const { - quint16 port = 0; - QMetaObject::invokeMethod(_webserver, "getPort", Qt::BlockingQueuedConnection, Q_RETURN_ARG(quint16, port)); - return QString("http://%1:%2/").arg(_localAddress).arg(port); + return QString("http://%1:%2/").arg(_localAddress).arg(_httpPort); } -QString SSDPHandler::buildDesc() const +QString SSDPHandler::getDescription() const { /// %1 base url http://192.168.0.177:8090/ /// %2 friendly name Hyperion (192.168.0.177) @@ -252,18 +243,31 @@ QString SSDPHandler::buildDesc() const getBaseAddress(), QString("Hyperion (%1)").arg(_localAddress), QString(HYPERION_VERSION), - _uuid, - QString::number(SSDPServer::getJsonServerPort()), - QString::number(SSDPServer::getSSLServerPort()), - QString::number(SSDPServer::getProtoBufPort()), - QString::number(SSDPServer::getFlatBufPort()) + getUuid(), + QString::number(_jsonApiPort), + QString::number(_httpsPort), + QString::number(_protoBufferPort), + QString::number(_flatBufferPort) ); } +QString SSDPHandler::getInfo() const +{ + QString hyperionServicesInfo; + hyperionServicesInfo.append(QString("HYPERION-NAME: %1\r\n").arg(_name)); + hyperionServicesInfo.append(QString("HYPERION-JSS-PORT: %1\r\n").arg(_jsonApiPort)); +#if defined(ENABLE_FLATBUF_SERVER) + hyperionServicesInfo.append(QString("HYPERION-FBS-PORT: %1\r\n").arg(_flatBufferPort)); +#endif +#if defined(ENABLE_PROTOBUF_SERVER) + hyperionServicesInfo.append(QString("HYPERION-PBS-PORT: %1\r\n").arg(_protoBufferPort)); +#endif + return hyperionServicesInfo; +} + void SSDPHandler::sendAnnounceList(bool alive) { for (const auto& entry : _deviceList) { alive ? SSDPServer::sendAlive(entry) : SSDPServer::sendByeBye(entry); } } - diff --git a/libsrc/ssdp/SSDPServer.cpp b/libsrc/ssdp/SSDPServer.cpp index 5fba01f38..9bb65af66 100644 --- a/libsrc/ssdp/SSDPServer.cpp +++ b/libsrc/ssdp/SSDPServer.cpp @@ -27,11 +27,7 @@ static const QString UPNP_ALIVE_MESSAGE = "NOTIFY * HTTP/1.1\r\n" "NTS: ssdp:alive\r\n" "SERVER: %4\r\n" "USN: uuid:%5\r\n" -#if defined(ENABLE_FLATBUF_SERVER) - "HYPERION-FBS-PORT: %6\r\n" -#endif - "HYPERION-JSS-PORT: %7\r\n" - "HYPERION-NAME: %8\r\n" + "%6" "\r\n"; // Implement ssdp:update as per spec 1.1, section 1.2.4 @@ -73,12 +69,8 @@ static const QString UPNP_MSEARCH_RESPONSE = "HTTP/1.1 200 OK\r\n" "LOCATION: %3\r\n" "SERVER: %4\r\n" "ST: %5\r\n" - "USN: uuid:%6\r\n" -#if defined(ENABLE_FLATBUF_SERVER) - "HYPERION-FBS-PORT: %7\r\n" -#endif - "HYPERION-JSS-PORT: %8\r\n" - "HYPERION-NAME: %9\r\n" + "USN: uuid:%6\r\n" + "%7" "\r\n"; SSDPServer::SSDPServer(QObject * parent) @@ -87,17 +79,15 @@ SSDPServer::SSDPServer(QObject * parent) , _udpSocket(nullptr) , _running(false) { - } SSDPServer::~SSDPServer() { - stop(); } void SSDPServer::initServer() { - _udpSocket = new QUdpSocket(this); + _udpSocket.reset(new QUdpSocket()); // get system info SysInfo::HyperionSysInfo data = SysInfo::get(); @@ -106,7 +96,7 @@ void SSDPServer::initServer() _serverHeader = QString("%1/%2 UPnP/1.0 Hyperion/%3") .arg(data.prettyName, data.productVersion, HYPERION_VERSION); - connect(_udpSocket, &QUdpSocket::readyRead, this, &SSDPServer::readPendingDatagrams); + connect(_udpSocket.get(), &QUdpSocket::readyRead, this, &SSDPServer::readPendingDatagrams); } bool SSDPServer::start() @@ -174,15 +164,11 @@ void SSDPServer::sendMSearchResponse(const QString& st, const QString& senderIp, { QString message = UPNP_MSEARCH_RESPONSE.arg(SSDP_MAX_AGE , QDateTime::currentDateTimeUtc().toString("ddd, dd MMM yyyy HH:mm:ss GMT") - , _descAddress + , getDescriptionAddress() , _serverHeader , st , _uuid -#if defined(ENABLE_FLATBUF_SERVER) - , _fbsPort -#endif - , _jssPort - , _name ); + , getInfo()); _udpSocket->writeDatagram(message.toUtf8(), QHostAddress(senderIp), senderPort); } @@ -203,15 +189,11 @@ void SSDPServer::sendAlive(const QString& st) const QString tempUSN = (st == "upnp:rootdevice ") ? _uuid+"::"+st : _uuid; QString message = UPNP_ALIVE_MESSAGE.arg(SSDP_MAX_AGE - , _descAddress + , getDescriptionAddress() , st , _serverHeader , tempUSN -#if defined(ENABLE_FLATBUF_SERVER) - , _fbsPort -#endif - , _jssPort - , _name ); + , getInfo()); // we repeat 3 times quint8 rep = 0; @@ -222,7 +204,7 @@ void SSDPServer::sendAlive(const QString& st) void SSDPServer::sendUpdate(const QString& st) { - QString message = UPNP_UPDATE_MESSAGE.arg(_descAddress + QString message = UPNP_UPDATE_MESSAGE.arg(getDescriptionAddress() , st , _uuid+"::"+st ); diff --git a/libsrc/utils/CMakeLists.txt b/libsrc/utils/CMakeLists.txt index 83a177f1b..2e7078fdd 100644 --- a/libsrc/utils/CMakeLists.txt +++ b/libsrc/utils/CMakeLists.txt @@ -6,6 +6,8 @@ add_library(hyperion-utils # Global defines/signal sharing ${CMAKE_SOURCE_DIR}/include/utils/global_defines.h ${CMAKE_SOURCE_DIR}/include/utils/GlobalSignals.h + # Error signal handler + ${CMAKE_SOURCE_DIR}/include/utils/ErrorManager.h # JSON Schema Checker ${CMAKE_SOURCE_DIR}/include/utils/jsonschema/QJsonFactory.h ${CMAKE_SOURCE_DIR}/include/utils/jsonschema/QJsonUtils.h diff --git a/libsrc/utils/DefaultSignalHandler.cpp b/libsrc/utils/DefaultSignalHandler.cpp index e8afa969d..378099bcc 100644 --- a/libsrc/utils/DefaultSignalHandler.cpp +++ b/libsrc/utils/DefaultSignalHandler.cpp @@ -124,7 +124,8 @@ void signal_handler(int signum, siginfo_t * /*info*/, void * /*context*/) } write_to_stderr("\n"); - write_to_stderr("Hyperion caught signal :"); + write_to_stderr(QCoreApplication::applicationName().toLocal8Bit()); + write_to_stderr(" caught signal :"); write_to_stderr(name); write_to_stderr("\n"); diff --git a/libsrc/utils/FileUtils.cpp b/libsrc/utils/FileUtils.cpp index 0784ef884..401fd678b 100644 --- a/libsrc/utils/FileUtils.cpp +++ b/libsrc/utils/FileUtils.cpp @@ -95,7 +95,8 @@ namespace FileUtils { void resolveFileError(const QFile& file, Logger* log) { QFile::FileError error = file.error(); - const char* fn = QSTRING_CSTR(file.fileName()); + QByteArray fileNameUtf8 = file.fileName().toUtf8(); + const char* fn = fileNameUtf8.constData(); switch(error) { case QFileDevice::NoError: diff --git a/libsrc/utils/SysInfo.cpp b/libsrc/utils/SysInfo.cpp index f05e47ab4..d206b0c76 100644 --- a/libsrc/utils/SysInfo.cpp +++ b/libsrc/utils/SysInfo.cpp @@ -1,8 +1,8 @@ #include "HyperionConfig.h" #if defined(ENABLE_EFFECTENGINE) -// Don't use debug Python APIs on Windows -#if defined(_MSC_VER) && defined(_DEBUG) +// Don't use debug Python APIs on Windows (GitHub Actions only) +#if defined(GITHUB_ACTIONS) && defined(_MSC_VER) && defined(_DEBUG) #if _MSC_VER >= 1930 #include #endif @@ -14,6 +14,7 @@ #endif #endif + #include "utils/SysInfo.h" #include "utils/FileUtils.h" diff --git a/libsrc/utils/jsonschema/QJsonSchemaChecker.cpp b/libsrc/utils/jsonschema/QJsonSchemaChecker.cpp index 04bb0a813..5191583cd 100644 --- a/libsrc/utils/jsonschema/QJsonSchemaChecker.cpp +++ b/libsrc/utils/jsonschema/QJsonSchemaChecker.cpp @@ -250,8 +250,9 @@ void QJsonSchemaChecker::checkProperties(const QJsonObject& value, const QJsonOb if (_correct == "create") { - QJsonUtils::modify(_autoCorrected, _currentPath, QJsonUtils::create(propertyValue, _ignoreRequired), property); - setMessage("Create property: " + property + " with value: " + QJsonUtils::getDefaultValue(propertyValue)); + QString workingProperty = property; + setMessage("Create property: " + workingProperty + " with value: " + QJsonUtils::getDefaultValue(propertyValue)); + QJsonUtils::modify(_autoCorrected, _currentPath, QJsonUtils::create(propertyValue, _ignoreRequired), workingProperty); } if (_correct == "") diff --git a/libsrc/webserver/CgiHandler.cpp b/libsrc/webserver/CgiHandler.cpp index 7e5da8d33..4731165f5 100644 --- a/libsrc/webserver/CgiHandler.cpp +++ b/libsrc/webserver/CgiHandler.cpp @@ -32,18 +32,25 @@ void CgiHandler::exec(const QStringList & args, QtHttpRequest * request, QtHttpR _request = request; _reply = reply; - if ( _args.at(0) == "cfg_jsonserver" ) + if (!_args.isEmpty()) { - cmd_cfg_jsonserver(); - } - else if ( _args.at(0) == "run" ) - { - cmd_runscript(); - } - else + if ( _args.at(0) == "cfg_jsonserver" ) + { + cmd_cfg_jsonserver(); + } + else if ( _args.at(0) == "run" ) + { + cmd_runscript(); + } + else + { + throw std::runtime_error("CGI command not found"); + } + } else { - throw std::runtime_error("CGI command not found"); + throw std::runtime_error("CGI command not provided"); } + } void CgiHandler::cmd_cfg_jsonserver() diff --git a/libsrc/webserver/QtHttpServer.cpp b/libsrc/webserver/QtHttpServer.cpp index 24e6b4b7a..d48aa4848 100644 --- a/libsrc/webserver/QtHttpServer.cpp +++ b/libsrc/webserver/QtHttpServer.cpp @@ -38,6 +38,7 @@ QtHttpServer::QtHttpServer (QObject * parent) , m_useSsl (false) , m_serverName (QStringLiteral ("The Qt6 HTTP Server")) , m_netOrigin (NetOrigin::getInstance()) + , m_sockServer (nullptr) { m_sockServer = new QtHttpServerWrapper (this); connect (m_sockServer, &QtHttpServerWrapper::newConnection, this, &QtHttpServer::onClientConnected, Qt::UniqueConnection); @@ -55,18 +56,20 @@ void QtHttpServer::start (quint16 port) void QtHttpServer::stop (void) { - if (m_sockServer->isListening ()) + if (m_sockServer != nullptr) { - m_sockServer->close (); - // disconnect clients - const QList socks = m_socksClientsHash.keys(); - for(auto sock : socks) + if (m_sockServer->isListening ()) { - sock->close(); + m_sockServer->close (); + // disconnect clients + const QList socks = m_socksClientsHash.keys(); + for(auto *sock : socks) + { + sock->close(); + } } - - emit stopped (); } + emit stopped (); } void QtHttpServer::setUseSecure (const bool ssl) diff --git a/libsrc/webserver/WebServer.cpp b/libsrc/webserver/WebServer.cpp index c40aa6a0c..daf9063d5 100644 --- a/libsrc/webserver/WebServer.cpp +++ b/libsrc/webserver/WebServer.cpp @@ -31,12 +31,13 @@ WebServer::WebServer(const QJsonDocument& config, bool useSsl, QObject* parent) , _useSsl(useSsl) , _log(Logger::getInstance("WEBSERVER")) , _port(WEBSERVER_DEFAULT_PORT) + , _staticFileServing (nullptr) + , _server(nullptr) { } WebServer::~WebServer() { - stop(); } void WebServer::initServer() @@ -226,10 +227,13 @@ void WebServer::start() void WebServer::stop() { - _server->stop(); + if (_server != nullptr) + { + _server->stop(); + } } -void WebServer::setSSDPDescription(const QString& desc) +void WebServer::onSsdpDescriptionUpdated(const QString& desc) { _staticFileServing->setSSDPDescription(desc); } diff --git a/settings/hyperion.settings.json.default b/settings/hyperion.settings.json.default index 6e6293914..b059db23b 100644 --- a/settings/hyperion.settings.json.default +++ b/settings/hyperion.settings.json.default @@ -13,6 +13,12 @@ ], "enable":false }, + "effects":{ + "paths":[ + "$ROOT/custom-effects" + ], + "disable":[""] + }, "flatbufServer":{ "enable":true, "port":19400, @@ -20,12 +26,10 @@ }, "forwarder":{ "enable":false, - "jsonapi":[ - - ], - "flatbuffer":[ - - ] + "instance":255, + "instanceList": "NONE", + "jsonapi":[], + "flatbuffer":[] }, "framegrabber":{ "enable":false, @@ -111,9 +115,7 @@ "network":{ "internetAccessAPI":false, "restirctedInternetAccessAPI":false, - "ipWhitelist":[ - - ], + "ipWhitelist":[], "localApiAuth":false }, "osEvents":{ @@ -227,14 +229,6 @@ "enableAttempts":6, "enableAttemptsInterval":15 }, - "effects":{ - "paths":[ - "$ROOT/custom-effects" - ], - "disable":[ - "" - ] - }, "foregroundEffect":{ "enable":true, "type":"effect", diff --git a/src/hyperion-aml/hyperion-aml.cpp b/src/hyperion-aml/hyperion-aml.cpp index c0a3cafff..1fdb3b02e 100644 --- a/src/hyperion-aml/hyperion-aml.cpp +++ b/src/hyperion-aml/hyperion-aml.cpp @@ -1,14 +1,20 @@ // QT includes #include +#include +#include #include -#include -#include "AmlogicWrapper.h" +#include +#include #include "HyperionConfig.h" #include +#include "AmlogicWrapper.h" +#include +#include + #ifdef ENABLE_MDNS // mDNS discover #include @@ -19,153 +25,162 @@ #endif #include -#include +#include using namespace commandline; +namespace { +inline const QString CAPTURE_TYPE = QStringLiteral("Amlogic"); +} // save the image as screenshot -void saveScreenshot(QString filename, const Image & image) +void saveScreenshot(const QString& filename, const Image & image) { // store as PNG - QImage pngImage((const uint8_t *) image.memptr(), image.width(), image.height(), 3*image.width(), QImage::Format_RGB888); + QImage const pngImage(reinterpret_cast(image.memptr()), image.width(), static_cast(image.height()), static_cast(3*image.width()), QImage::Format_RGB888); pngImage.save(filename); } int main(int argc, char ** argv) { - Logger *log = Logger::getInstance("AMLOGIC"); + DefaultSignalHandler::install(); + ErrorManager errorManager; + + Logger *log = Logger::getInstance(CAPTURE_TYPE.toUpper()); Logger::setLogLevel(Logger::INFO); - std::cout - << "hyperion-aml:" << std::endl - << "\tVersion : " << HYPERION_VERSION << " (" << HYPERION_BUILD_ID << ")" << std::endl - << "\tbuild time: " << __DATE__ << " " << __TIME__ << std::endl; + QCoreApplication const app(argc, argv); - DefaultSignalHandler::install(); + QString const baseName = QCoreApplication::applicationName(); + std::cout << baseName.toStdString() << ":\n" + << "\tVersion : " << HYPERION_VERSION << " (" << HYPERION_BUILD_ID << ")\n" + << "\tbuild time: " << __DATE__ << " " << __TIME__ << "\n"; - QCoreApplication app(argc, argv); + QObject::connect(&errorManager, &ErrorManager::errorOccurred, [&](const QString& error) { + Error(log, "Error occured: %s", QSTRING_CSTR(error)); + QTimer::singleShot(0, [&app]() { app.quit(); }); + }); - try - { - // create the option parser and initialize all parser - Parser parser("AmLogic capture application for Hyperion. Will automatically search a Hyperion server if -a option isn't used. Please note that if you have more than one server running it's more or less random which one will be used."); + // create the option parser and initialize all parser + Parser parser( CAPTURE_TYPE + " capture application for Hyperion. Will automatically search a Hyperion server if -a option is not used. Please note that if you have more than one server running it's more or less random which one will be used."); - IntOption & argFps = parser.add ('f', "framerate", QString("Capture frame rate. Range %1-%2fps").arg(GrabberWrapper::DEFAULT_MIN_GRAB_RATE_HZ).arg(GrabberWrapper::DEFAULT_MAX_GRAB_RATE_HZ), QString::number(GrabberWrapper::DEFAULT_RATE_HZ), GrabberWrapper::DEFAULT_MIN_GRAB_RATE_HZ, GrabberWrapper::DEFAULT_MAX_GRAB_RATE_HZ); - IntOption & argSizeDecimation = parser.add ('s', "size-decimator", "Decimation factor for the output image size [default=%1]", QString::number(GrabberWrapper::DEFAULT_PIXELDECIMATION), 1); + IntOption & argFps = parser.add ('f', "framerate", QString("Capture frame rate. Range %1-%2fps").arg(GrabberWrapper::DEFAULT_MIN_GRAB_RATE_HZ).arg(GrabberWrapper::DEFAULT_MAX_GRAB_RATE_HZ), QString::number(GrabberWrapper::DEFAULT_RATE_HZ), GrabberWrapper::DEFAULT_MIN_GRAB_RATE_HZ, GrabberWrapper::DEFAULT_MAX_GRAB_RATE_HZ); + IntOption & argSizeDecimation = parser.add ('s', "size-decimator", "Decimation factor for the output image size [default=%1]", QString::number(GrabberWrapper::DEFAULT_PIXELDECIMATION), 1); - IntOption & argCropLeft = parser.add (0x0, "crop-left", "Number of pixels to crop from the left of the picture before decimation"); - IntOption & argCropRight = parser.add (0x0, "crop-right", "Number of pixels to crop from the right of the picture before decimation"); - IntOption & argCropTop = parser.add (0x0, "crop-top", "Number of pixels to crop from the top of the picture before decimation"); - IntOption & argCropBottom = parser.add (0x0, "crop-bottom", "Number of pixels to crop from the bottom of the picture before decimation"); - BooleanOption & arg3DSBS = parser.add(0x0, "3DSBS", "Interpret the incoming video stream as 3D side-by-side"); - BooleanOption & arg3DTAB = parser.add(0x0, "3DTAB", "Interpret the incoming video stream as 3D top-and-bottom"); + IntOption & argCropLeft = parser.add (0x0, "crop-left", "Number of pixels to crop from the left of the picture before decimation"); + IntOption & argCropRight = parser.add (0x0, "crop-right", "Number of pixels to crop from the right of the picture before decimation"); + IntOption & argCropTop = parser.add (0x0, "crop-top", "Number of pixels to crop from the top of the picture before decimation"); + IntOption & argCropBottom = parser.add (0x0, "crop-bottom", "Number of pixels to crop from the bottom of the picture before decimation"); + BooleanOption & arg3DSBS = parser.add(0x0, "3DSBS", "Interpret the incoming video stream as 3D side-by-side"); + BooleanOption & arg3DTAB = parser.add(0x0, "3DTAB", "Interpret the incoming video stream as 3D top-and-bottom"); - Option & argAddress = parser.add