Fix #1671 (#1672)

* Refactor to fix #1671

* Add GUI/NonGUI mode to info page

* Do not show lock config, if in non-UI mode

* Updae Changelog

* Correct includes

* Remove unused variable

* use ninja generator under macos

---------

Co-authored-by: Paulchen-Panther <16664240+Paulchen-Panther@users.noreply.github.com>

CHANGELOG.md

@@ -52,6 +52,7 @@ Note: The wizard will configure an APIv2 capable bridge always with Entertainmen
 - Fixed that the Matrix effect finds its image - Thanks @lsellens
 - MDNSBrower - Fixed, if timeout while resolving host occurs
 - Non image updates ignored blacklisted LEDs (#1634)
+- Fixed that Windows OsEvents failed in non-GUI mode (#1671)
 
 ##### LED-Devices
 

assets/webconfig/js/content_events.js

@@ -1,6 +1,7 @@
 $(document).ready(function () {
   performTranslation();
 
+  let isGuiMode = window.sysInfo.hyperion.isGuiMode;
   const CEC_ENABLED = (jQuery.inArray("cec", window.serverInfo.services) !== -1);
 
   let conf_editor_osEvents = null;
@@ -76,6 +77,12 @@ $(document).ready(function () {
     osEvents: window.schema.osEvents
   }, true, true);
 
+  conf_editor_osEvents.on('ready', function () {
+    if (!isGuiMode) {
+      showInputOptionsForKey(conf_editor_osEvents, "osEvents", "suspendEnable", false);
+    }
+  });
+
   conf_editor_osEvents.on('change', function () {
     conf_editor_osEvents.validate().length || window.readOnlyMode ? $('#btn_submit_os_events').prop('disabled', true) : $('#btn_submit_os_events').prop('disabled', false);
   });

assets/webconfig/js/ui_utils.js

@@ -1224,6 +1224,7 @@ function getSystemInfo() {
   info += '- Avail Services:    ' + window.serverInfo.services + '\n';
   info += '- Config path:       ' + shy.rootPath + '\n';
   info += '- Database:          ' + (shy.readOnlyMode ? "ready-only" : "read/write") + '\n';
+  info += '- Mode:              ' + (shy.isGuiMode ? "GUI" : "Non-GUI") + '\n';
 
   info += '\n';
 

include/events/OsEventHandler.h

@@ -10,6 +10,7 @@
 #include <QAbstractEventDispatcher>
 #include <QWidget>
 #include <windows.h>
+#include <powrprof.h>
 #endif
 
 #include <utils/settings.h>
@@ -21,8 +22,9 @@ class OsEventHandlerBase : public QObject
 	Q_OBJECT
 
 public:
+
 	OsEventHandlerBase();
-	~OsEventHandlerBase() override;
+	virtual ~OsEventHandlerBase();
 
 public slots:
 	void suspend(bool sleep);
@@ -46,17 +48,20 @@ protected:
 	bool _isSuspendRegistered;
 	bool _isLockRegistered;
 
-	Logger * _log {};
+	bool _isService;
+
+	Logger* _log{};
 };
 
 #if defined(_WIN32)
 
 class OsEventHandlerWindows : public OsEventHandlerBase, public QAbstractNativeEventFilter
 {
-
 public:
 	OsEventHandlerWindows();
-	~OsEventHandlerWindows() override;
+	~OsEventHandlerWindows();
+
+	void handleSuspendResumeEvent(bool sleep);
 
 protected:
 #if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
@@ -65,13 +70,17 @@ protected:
 	bool nativeEventFilter(const QByteArray& eventType, void* message, long int* result) override;
 #endif
 
-private:
 	bool registerOsEventHandler() override;
 	void unregisterOsEventHandler() override;
 	bool registerLockHandler() override;
 	void unregisterLockHandler() override;
 
-	QWidget			_widget;
+private:
+	static OsEventHandlerWindows* getInstance();
+
+	static DEVICE_NOTIFY_CALLBACK_ROUTINE handlePowerNotifications;
+
+	QWidget* _widget;
 	HPOWERNOTIFY	_notifyHandle;
 };
 
@@ -90,7 +99,7 @@ class OsEventHandlerLinux : public OsEventHandlerBase
 public:
 	OsEventHandlerLinux();
 
-	void handleSignal (int signum);
+	void handleSignal(int signum);
 
 private:
 	static OsEventHandlerLinux* getInstance();
@@ -119,8 +128,8 @@ private:
 	bool registerLockHandler() override;
 	void unregisterLockHandler() override;
 
-	void *_sleepEventHandler;
+	void* _sleepEventHandler;
-	void *_lockEventHandler;
+	void* _lockEventHandler;
 };
 
 using OsEventHandler = OsEventHandlerMacOS;

libsrc/api/JsonAPI.cpp

@@ -10,6 +10,8 @@
 #include <QTimer>
 #include <QHostInfo>
 #include <QMultiMap>
+#include <QCoreApplication>
+#include <QApplication>
 
 // hyperion includes
 #include <leddevice/LedDeviceWrapper.h>
@@ -389,6 +391,9 @@ void JsonAPI::handleSysInfoCommand(const QJsonObject &, const QString &command,
 	hyperion["rootPath"] = _instanceManager->getRootPath();
 	hyperion["readOnlyMode"] = _hyperion->getReadOnlyMode();
 
+	QCoreApplication* app = QCoreApplication::instance();
+	hyperion["isGuiMode"] = qobject_cast<QApplication*>(app) ? true : false;
+
 	info["hyperion"] = hyperion;
 
 	// send the result

libsrc/events/OsEventHandler.cpp

@@ -3,19 +3,22 @@
 #include <QtGlobal>
 #include <QJsonDocument>
 #include <QJsonObject>
+#include <QCoreApplication>
+#include <QApplication>
 
 #include <events/EventHandler.h>
 #include <utils/Logger.h>
 
-#include <iostream>
-
 #if defined(_WIN32)
-#include <QCoreApplication>
+
 #include <QWidget>
 #include <windows.h>
 #include <wtsapi32.h>
+#include <powerbase.h>
 
 #pragma comment( lib, "wtsapi32.lib" )
+#pragma comment(lib, "PowrProf.lib")
+
 #elif defined(__APPLE__)
 #include <AppKit/AppKit.h>
 #endif
@@ -26,10 +29,16 @@ OsEventHandlerBase::OsEventHandlerBase()
 	, _isSuspendOnLock(false)
 	, _isSuspendRegistered(false)
 	, _isLockRegistered(false)
+	, _isService(false)
 {
 	qRegisterMetaType<Event>("Event");
 	_log = Logger::getInstance("EVENTS-OS");
 
+	QCoreApplication* app = QCoreApplication::instance();
+	if (!qobject_cast<QApplication*>(app))
+	{
+		_isService = true;
+	}
 	QObject::connect(this, &OsEventHandlerBase::signalEvent, EventHandler::getInstance(), &EventHandler::handleEvent);
 }
 
@@ -45,7 +54,7 @@ OsEventHandlerBase::~OsEventHandlerBase()
 
 void OsEventHandlerBase::handleSettingsUpdate(settings::type type, const QJsonDocument& config)
 {
-	if(type == settings::OSEVENTS)
+	if (type == settings::OSEVENTS)
 	{
 		const QJsonObject& obj = config.object();
 
@@ -65,6 +74,8 @@ void OsEventHandlerBase::handleSettingsUpdate(settings::type type, const QJsonDo
 			unregisterOsEventHandler();
 		}
 
+		if (!_isService)
+		{
 			_isLockEnabled = obj["lockEnable"].toBool(true);
 			if (_isLockEnabled || _isSuspendOnLock != prevIsSuspendOnLock)
 			{
@@ -76,6 +87,7 @@ void OsEventHandlerBase::handleSettingsUpdate(settings::type type, const QJsonDo
 				unregisterLockHandler();
 			}
 		}
+	}
 }
 
 void OsEventHandlerBase::suspend(bool sleep)
@@ -118,8 +130,15 @@ void OsEventHandlerBase::lock(bool isLocked)
 
 #if defined(_WIN32)
 
+OsEventHandlerWindows* OsEventHandlerWindows::getInstance()
+{
+	static OsEventHandlerWindows instance;
+	return &instance;
+}
+
 OsEventHandlerWindows::OsEventHandlerWindows()
-	: _notifyHandle(NULL)
+	: _notifyHandle(NULL),
+	_widget(nullptr)
 {
 }
 
@@ -127,6 +146,8 @@ OsEventHandlerWindows::~OsEventHandlerWindows()
 {
 	unregisterLockHandler();
 	unregisterOsEventHandler();
+
+	delete _widget;
 }
 
 #if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
@@ -135,8 +156,8 @@ bool OsEventHandlerWindows::nativeEventFilter(const QByteArray& eventType, void*
 bool OsEventHandlerWindows::nativeEventFilter(const QByteArray& eventType, void* message, long int* /*result*/)
 #endif
 {
-	MSG* msg = static_cast<MSG*>(message);
 
+	MSG* msg = static_cast<MSG*>(message);
 	switch (msg->message)
 	{
 	case WM_WTSSESSION_CHANGE:
@@ -152,34 +173,45 @@ bool OsEventHandlerWindows::nativeEventFilter(const QByteArray& eventType, void*
 			break;
 		}
 		break;
-
-	case WM_POWERBROADCAST:
-		switch (msg->wParam)
-		{
-		case PBT_APMRESUMESUSPEND:
-			emit suspend(false);
-			return true;
-			break;
-		case PBT_APMSUSPEND:
-			emit suspend(true);
-			return true;
-			break;
-		}
-		break;
 	}
 	return false;
 }
 
+void OsEventHandlerWindows::handleSuspendResumeEvent(bool sleep)
+{
+	if (sleep)
+	{
+		suspend(true);
+	}
+	else
+	{
+		suspend(false);
+	}
+}
+
+ULONG OsEventHandlerWindows::handlePowerNotifications(PVOID Context, ULONG Type, PVOID Setting)
+{
+	switch (Type)
+	{
+	case PBT_APMRESUMESUSPEND:
+		getInstance()->handleSuspendResumeEvent(false);
+		break;
+	case PBT_APMSUSPEND:
+		getInstance()->handleSuspendResumeEvent(true);
+		break;
+	}
+	return S_OK;
+}
+
 bool OsEventHandlerWindows::registerOsEventHandler()
 {
 	bool isRegistered{ _isSuspendRegistered };
 	if (!_isSuspendRegistered)
 	{
-		auto handle = reinterpret_cast<HWND> (_widget.winId());
+		DEVICE_NOTIFY_SUBSCRIBE_PARAMETERS notificationsParameters = { handlePowerNotifications, NULL };
-		_notifyHandle = RegisterSuspendResumeNotification(handle, DEVICE_NOTIFY_WINDOW_HANDLE);
+		if (PowerRegisterSuspendResumeNotification(DEVICE_NOTIFY_CALLBACK, (HANDLE)&notificationsParameters, &_notifyHandle) == ERROR_SUCCESS)
-		if (_notifyHandle != NULL)
 		{
-			QCoreApplication::instance()->installNativeEventFilter(this);
+			isRegistered = true;
 		}
 		else
 		{
@@ -200,8 +232,7 @@ void OsEventHandlerWindows::unregisterOsEventHandler()
 	{
 		if (_notifyHandle != NULL)
 		{
-			QCoreApplication::instance()->removeNativeEventFilter(this);
+			PowerUnregisterSuspendResumeNotification(_notifyHandle);
-			UnregisterSuspendResumeNotification(_notifyHandle);
 		}
 		_notifyHandle = NULL;
 		_isSuspendRegistered = false;
@@ -213,17 +244,23 @@ bool OsEventHandlerWindows::registerLockHandler()
 	bool isRegistered{ _isLockRegistered };
 	if (!_isLockRegistered)
 	{
-		auto handle = reinterpret_cast<HWND> (_widget.winId());
+		if (!_isService)
+		{
+			_widget = new QWidget();
+			if (_widget)
+			{
+				auto handle = reinterpret_cast<HWND> (_widget->winId());
 				if (WTSRegisterSessionNotification(handle, NOTIFY_FOR_THIS_SESSION))
 				{
+					QCoreApplication::instance()->installNativeEventFilter(this);
 					isRegistered = true;
 				}
 				else
 				{
 					Error(_log, "Could not register for lock/unlock events!");
 				}
-
+			}
-
+		}
 	}
 
 	if (isRegistered)
@@ -237,10 +274,14 @@ void OsEventHandlerWindows::unregisterLockHandler()
 {
 	if (_isLockRegistered)
 	{
-		auto handle = reinterpret_cast<HWND> (_widget.winId());
+		if (!_isService)
+		{
+			auto handle = reinterpret_cast<HWND> (_widget->winId());
+			QCoreApplication::instance()->removeNativeEventFilter(this);
 			WTSUnRegisterSessionNotification(handle);
 			_isLockRegistered = false;
 		}
+	}
 }
 
 #elif defined(__linux__)
@@ -259,7 +300,7 @@ OsEventHandlerLinux::OsEventHandlerLinux()
 	signal(SIGUSR2, static_signaleHandler);
 }
 
-void OsEventHandlerLinux::handleSignal (int signum)
+void OsEventHandlerLinux::handleSignal(int signum)
 {
 	if (signum == SIGUSR1)
 	{
@@ -286,20 +327,20 @@ typedef QMultiMap<QString, dBusSignals> DbusSignalsMap;
 
 // Constants
 namespace {
-const DbusSignalsMap dbusSignals = {
+	const DbusSignalsMap dbusSignals = {
 		//system signals
 		{"Suspend", {"org.freedesktop.login1","/org/freedesktop/login1","org.freedesktop.login1.Manager","PrepareForSleep"}},
 
 		//Session signals
 		{"ScreenSaver", {"org.freedesktop.ScreenSaver","/org/freedesktop/ScreenSaver","org.freedesktop.ScreenSaver","ActiveChanged"}},
 		{"ScreenSaver", {"org.gnome.ScreenSaver","/org/gnome/ScreenSaver","org.gnome.ScreenSaver","ActiveChanged"}},
-};
+	};
 } //End of constants
 
 bool OsEventHandlerLinux::registerOsEventHandler()
 {
 
-	bool isRegistered {_isSuspendRegistered};
+	bool isRegistered{ _isSuspendRegistered };
 	if (!_isSuspendRegistered)
 	{
 		QDBusConnection systemBus = QDBusConnection::systemBus();
@@ -365,7 +406,7 @@ void OsEventHandlerLinux::unregisterOsEventHandler()
 
 bool OsEventHandlerLinux::registerLockHandler()
 {
-	bool isRegistered {_isLockRegistered};
+	bool isRegistered{ _isLockRegistered };
 
 	if (!_isLockRegistered)
 	{
@@ -409,7 +450,7 @@ bool OsEventHandlerLinux::registerLockHandler()
 
 void OsEventHandlerLinux::unregisterLockHandler()
 {
-	bool isUnregistered {false};
+	bool isUnregistered{ false };
 
 	if (_isLockRegistered)
 	{
@@ -459,20 +500,20 @@ OsEventHandlerMacOS::OsEventHandlerMacOS()
 
 @interface SleepEvents : NSObject
 {
-	OsEventHandlerMacOS *_eventHandler;
+	OsEventHandlerMacOS* _eventHandler;
 }
-- (id)initSleepEvents:(OsEventHandlerMacOS *)osEventHandler;
+- (id)initSleepEvents : (OsEventHandlerMacOS*)osEventHandler;
 @end
 
 @implementation SleepEvents
-- (id)initSleepEvents:(OsEventHandlerMacOS *)osEventHandler
+- (id)initSleepEvents:(OsEventHandlerMacOS*)osEventHandler
 {
 	if ((self = [super init]))
 	{
 		_eventHandler = osEventHandler;
-	   	id notifCenter = [[NSWorkspace sharedWorkspace] notificationCenter];
+		id notifCenter = [[NSWorkspace sharedWorkspace]notificationCenter];
-		[notifCenter addObserver:self selector:@selector(receiveSleepWake:) name:NSWorkspaceWillSleepNotification object:nil];
+		[notifCenter addObserver : self selector : @selector(receiveSleepWake:) name:NSWorkspaceWillSleepNotification object : nil] ;
-		[notifCenter addObserver:self selector:@selector(receiveSleepWake:) name:NSWorkspaceDidWakeNotification object:nil];
+		[notifCenter addObserver : self selector : @selector(receiveSleepWake:) name:NSWorkspaceDidWakeNotification object : nil] ;
 	}
 
 	return self;
@@ -480,12 +521,12 @@ OsEventHandlerMacOS::OsEventHandlerMacOS()
 
 - (void)dealloc
 {
-    [[[NSWorkspace sharedWorkspace] notificationCenter] removeObserver:self];
+	[[[NSWorkspace sharedWorkspace]notificationCenter] removeObserver:self];
 	_eventHandler = nullptr;
-    [super dealloc];
+	[super dealloc] ;
 }
 
-- (void) receiveSleepWake:(NSNotification*)notification
+- (void)receiveSleepWake:(NSNotification*)notification
 {
 	if (!_eventHandler) return;
 	if (notification.name == NSWorkspaceWillSleepNotification)
@@ -501,10 +542,10 @@ OsEventHandlerMacOS::OsEventHandlerMacOS()
 
 bool OsEventHandlerMacOS::registerOsEventHandler()
 {
-	bool isRegistered {_isSuspendRegistered};
+	bool isRegistered{ _isSuspendRegistered };
 	if (!_isSuspendRegistered)
 	{
-		_sleepEventHandler = [[SleepEvents alloc] initSleepEvents:this];
+		_sleepEventHandler = [[SleepEvents alloc]initSleepEvents:this];
 		if (_sleepEventHandler)
 		{
 			Debug(_log, "Registered for suspend/resume events");
@@ -527,7 +568,7 @@ void OsEventHandlerMacOS::unregisterOsEventHandler()
 {
 	if (_isSuspendRegistered && _sleepEventHandler)
 	{
-		[(SleepEvents *)_sleepEventHandler release], _sleepEventHandler = nil;
+		[(SleepEvents*)_sleepEventHandler release] , _sleepEventHandler = nil;
 		if (!_sleepEventHandler)
 		{
 			Debug(_log, "Unregistered for suspend/resume events");
@@ -542,20 +583,20 @@ void OsEventHandlerMacOS::unregisterOsEventHandler()
 
 @interface LockEvents : NSObject
 {
-	OsEventHandlerMacOS *_eventHandler;
+	OsEventHandlerMacOS* _eventHandler;
 }
-- (id)initLockEvents:(OsEventHandlerMacOS *)osEventHandler;
+- (id)initLockEvents : (OsEventHandlerMacOS*)osEventHandler;
 @end
 
 @implementation LockEvents
-- (id)initLockEvents:(OsEventHandlerMacOS *)osEventHandler
+- (id)initLockEvents:(OsEventHandlerMacOS*)osEventHandler
 {
 	if ((self = [super init]))
 	{
 		_eventHandler = osEventHandler;
 		id defCenter = [NSDistributedNotificationCenter defaultCenter];
-		[defCenter addObserver:self selector:@selector(receiveLockUnlock:) name:@"com.apple.screenIsLocked" object:nil];
+		[defCenter addObserver : self selector : @selector(receiveLockUnlock:) name:@"com.apple.screenIsLocked" object:nil] ;
-		[defCenter addObserver:self selector:@selector(receiveLockUnlock:) name:@"com.apple.screenIsUnlocked" object:nil];
+		[defCenter addObserver : self selector : @selector(receiveLockUnlock:) name:@"com.apple.screenIsUnlocked" object:nil] ;
 	}
 
 	return self;
@@ -563,12 +604,12 @@ void OsEventHandlerMacOS::unregisterOsEventHandler()
 
 - (void)dealloc
 {
-    [[[NSWorkspace sharedWorkspace] notificationCenter] removeObserver:self];
+	[[[NSWorkspace sharedWorkspace]notificationCenter] removeObserver:self];
 	_eventHandler = nullptr;
-    [super dealloc];
+	[super dealloc] ;
 }
 
-- (void) receiveLockUnlock:(NSNotification*)notification
+- (void)receiveLockUnlock:(NSNotification*)notification
 {
 	if (!_eventHandler) return;
 	if (CFEqual(notification.name, CFSTR("com.apple.screenIsLocked")))
@@ -587,7 +628,7 @@ bool OsEventHandlerMacOS::registerLockHandler()
 	bool isRegistered{ _isLockRegistered };
 	if (!_isLockRegistered)
 	{
-		_lockEventHandler = [[LockEvents alloc] initLockEvents:this];
+		_lockEventHandler = [[LockEvents alloc]initLockEvents:this];
 		if (_lockEventHandler)
 		{
 			Debug(_log, "Registered for lock/unlock events");
@@ -610,7 +651,7 @@ void OsEventHandlerMacOS::unregisterLockHandler()
 {
 	if (_isLockRegistered && _lockEventHandler)
 	{
-		[(LockEvents *)_lockEventHandler release], _lockEventHandler = nil;
+		[(LockEvents*)_lockEventHandler release] , _lockEventHandler = nil;
 		if (!_lockEventHandler)
 		{
 			Debug(_log, "Unregistered for lock/unlock events");