frontend: Adjust application shutdown logic

Author: Warchamp7

frontend/OBSApp.cpp

@@ -42,9 +42,8 @@
 #include <QFile>
 #endif
 
-#ifdef _WIN32
 #include <QSessionManager>
-#else
+#ifndef _WIN32
 #include <QSocketNotifier>
 #endif
 
@@ -78,6 +77,7 @@ extern string opt_starting_profile;
 
 #ifndef _WIN32
 int OBSApp::sigintFd[2];
+int OBSApp::sigtermFd[2];
 #endif
 
 // GPU hint exports for AMD/NVIDIA laptops
@@ -280,6 +280,54 @@ string CurrentDateTimeString()
 	return buf;
 }
 
+bool OBSNativeEventFilter::nativeEventFilter(const QByteArray &eventType, void *message, qintptr *result)
+{
+	if (eventType == "windows_generic_MSG") {
+#ifdef _WIN32
+		MSG *msg = static_cast<MSG *>(message);
+
+		OBSBasic *main = OBSBasic::Get();
+		if (!main) {
+			return false;
+		}
+
+		switch (msg->message) {
+		case WM_QUERYENDSESSION:
+			main->saveAll();
+			if (msg->lParam == ENDSESSION_CRITICAL) {
+				break;
+			}
+
+			if (main->shouldPromptForClose()) {
+				*result = FALSE;
+				return true;
+			}
+
+			return false;
+		case WM_ENDSESSION:
+			if (msg->wParam == TRUE) {
+				// Session is ending, start closing the main window now with no checks or prompts.
+				main->closeWindow();
+			} else {
+				/* Session is no longer ending. If OBS is still open, odds are it is what held
+				 * up the session end due to it's higher than default priority. We call the
+				 * close method to trigger the confirmation window flow. We do this after the fact
+				 * to avoid blocking the main window event loop prior to this message.
+				 * Otherwise OBS is already gone and invoking this does nothing */
+				main->close();
+			}
+
+			return true;
+		}
+#else
+		UNUSED_PARAMETER(message);
+		UNUSED_PARAMETER(result);
+#endif
+	}
+
+	return false;
+}
+
 #define DEFAULT_LANG "en-US"
 
 bool OBSApp::InitGlobalConfigDefaults()
@@ -868,6 +916,8 @@ OBSApp::OBSApp(int &argc, char **argv, profiler_name_store_t *store)
 	  profilerNameStore(store),
 	  appLaunchUUID_(QUuid::createUuid())
 {
+	installNativeEventFilter(new OBSNativeEventFilter);
+
 	/* fix float handling */
 #if defined(Q_OS_UNIX)
 	if (!setlocale(LC_NUMERIC, "C"))
@@ -879,9 +929,14 @@ OBSApp::OBSApp(int &argc, char **argv, profiler_name_store_t *store)
 	socketpair(AF_UNIX, SOCK_STREAM, 0, sigintFd);
 	snInt = new QSocketNotifier(sigintFd[1], QSocketNotifier::Read, this);
 	connect(snInt, &QSocketNotifier::activated, this, &OBSApp::ProcessSigInt);
-#else
-	connect(qApp, &QGuiApplication::commitDataRequest, this, &OBSApp::commitData);
+
+	/* Handle SIGTERM */
+	socketpair(AF_UNIX, SOCK_STREAM, 0, sigtermFd);
+	snTerm = new QSocketNotifier(sigtermFd[1], QSocketNotifier::Read, this);
+	connect(snTerm, &QSocketNotifier::activated, this, &OBSApp::ProcessSigTerm);
 #endif
+	connect(qApp, &QGuiApplication::commitDataRequest, this, &OBSApp::commitData, Qt::DirectConnection);
+
 	if (multi) {
 		crashHandler_ = std::make_unique<OBS::CrashHandler>();
 	} else {
@@ -1229,7 +1284,20 @@ bool OBSApp::OBSInit()
 	mainWindow = new OBSBasic();
 
 	mainWindow->setAttribute(Qt::WA_DeleteOnClose, true);
-	connect(mainWindow, &OBSBasic::destroyed, this, &OBSApp::quit);
+
+	connect(QApplication::instance(), &QApplication::aboutToQuit, this, [this]() {
+		crashHandler_->applicationShutdownHandler();
+
+		/* Ensure OBSMainWindow gets closed */
+		if (mainWindow) {
+			mainWindow->close();
+			delete mainWindow;
+		}
+
+		if (libobs_initialized) {
+			applicationShutdown();
+		}
+	});
 
 	mainWindow->OBSInit();
 
@@ -1748,6 +1816,14 @@ void OBSApp::SigIntSignalHandler(int s)
 	char a = 1;
 	send(sigintFd[0], &a, sizeof(a), 0);
 }
+
+void OBSApp::SigTermSignalHandler(int s)
+{
+	UNUSED_PARAMETER(s);
+
+	char a = 1;
+	send(sigtermFd[0], &a, sizeof(a), 0);
+}
 #endif
 
 void OBSApp::ProcessSigInt(void)
@@ -1759,20 +1835,39 @@ void OBSApp::ProcessSigInt(void)
 	recv(sigintFd[1], &tmp, sizeof(tmp), 0);
 
 	OBSBasic *main = OBSBasic::Get();
-	if (main)
+	if (main) {
+		main->saveAll();
 		main->close();
+	}
+#endif
+}
+
+void OBSApp::ProcessSigTerm(void)
+{
+#ifndef _WIN32
+	char tmp;
+	recv(sigtermFd[1], &tmp, sizeof(tmp), 0);
+
+	OBSBasic *main = OBSBasic::Get();
+	if (main) {
+		main->saveAll();
+	}
+
+	quit();
 #endif
 }
 
-#ifdef _WIN32
 void OBSApp::commitData(QSessionManager &manager)
 {
-	if (auto main = App()->GetMainWindow()) {
-		QMetaObject::invokeMethod(main, "close", Qt::QueuedConnection);
-		manager.cancel();
+	OBSBasic *main = OBSBasic::Get();
+	if (main) {
+		main->saveAll();
+
+		if (manager.allowsInteraction() && main->shouldPromptForClose()) {
+			manager.cancel();
+		}
 	}
 }
-#endif
 
 void OBSApp::applicationShutdown() noexcept
 {
@@ -1784,6 +1879,10 @@ void OBSApp::applicationShutdown() noexcept
 	delete snInt;
 	close(sigintFd[0]);
 	close(sigintFd[1]);
+
+	delete snTerm;
+	close(sigtermFd[0]);
+	close(sigtermFd[1]);
 #endif
 
 #ifdef __APPLE__

frontend/OBSApp.hpp

@@ -25,6 +25,7 @@
 #include <util/profiler.hpp>
 #include <util/util.hpp>
 
+#include <QAbstractNativeEventFilter>
 #include <QApplication>
 #include <QPalette>
 #include <QPointer>
@@ -58,9 +59,16 @@ struct UpdateBranch {
 	bool is_visible;
 };
 
+class OBSNativeEventFilter : public QAbstractNativeEventFilter {
+public:
+	bool nativeEventFilter(const QByteArray &eventType, void *message, qintptr *result);
+};
+
 class OBSApp : public QApplication {
 	Q_OBJECT
 
+	friend class OBSNativeEventFilter;
+
 private:
 	QUuid appLaunchUUID_;
 	std::unique_ptr<OBS::CrashHandler> crashHandler_;
@@ -117,12 +125,13 @@ class OBSApp : public QApplication {
 #ifndef _WIN32
 	static int sigintFd[2];
 	QSocketNotifier *snInt = nullptr;
-#else
-private slots:
-	void commitData(QSessionManager &manager);
+
+	static int sigtermFd[2];
+	QSocketNotifier *snTerm = nullptr;
 #endif
 
 private slots:
+	void commitData(QSessionManager &manager);
 	void addLogLine(int logLevel, const QString &message);
 	void themeFileChanged(const QString &);
 	void applicationShutdown() noexcept;
@@ -212,6 +221,7 @@ private slots:
 	inline void PopUITranslation() { translatorHooks.pop_front(); }
 #ifndef _WIN32
 	static void SigIntSignalHandler(int);
+	static void SigTermSignalHandler(int);
 #endif
 
 	void loadAppModules(struct obs_module_failure_info &mfi);
@@ -222,6 +232,7 @@ private slots:
 public slots:
 	void Exec(VoidFunc func);
 	void ProcessSigInt();
+	void ProcessSigTerm();
 
 signals:
 	void logLineAdded(int logLevel, const QString &message);

frontend/docks/OBSDock.cpp

@@ -28,7 +28,7 @@ void OBSDock::closeEvent(QCloseEvent *event)
 	};
 
 	bool warned = config_get_bool(App()->GetUserConfig(), "General", "WarnedAboutClosingDocks");
-	if (!OBSBasic::Get()->Closing() && !warned) {
+	if (!OBSBasic::Get()->isClosing() && !warned) {
 		QMetaObject::invokeMethod(App(), "Exec", Qt::QueuedConnection, Q_ARG(VoidFunc, msgBox));
 	}
 

frontend/obs-main.cpp

@@ -858,13 +858,22 @@ int main(int argc, char *argv[])
 #ifndef _WIN32
 	signal(SIGPIPE, SIG_IGN);
 
-	struct sigaction sig_handler;
+	struct sigaction sigint_handler;
 
-	sig_handler.sa_handler = OBSApp::SigIntSignalHandler;
-	sigemptyset(&sig_handler.sa_mask);
-	sig_handler.sa_flags = 0;
+	sigint_handler.sa_handler = OBSApp::SigIntSignalHandler;
+	sigemptyset(&sigint_handler.sa_mask);
+	sigint_handler.sa_flags = 0;
 
-	sigaction(SIGINT, &sig_handler, NULL);
+	sigaction(SIGINT, &sigint_handler, NULL);
+
+	struct sigaction sigterm_handler;
+
+	sigterm_handler.sa_handler = OBSApp::SigTermSignalHandler;
+	sigemptyset(&sigterm_handler.sa_mask);
+	sigterm_handler.sa_flags = 0;
+
+	sigaction(SIGTERM, &sigterm_handler, NULL);
+	sigaction(SIGHUP, &sigterm_handler, NULL);
 
 	/* Block SIGPIPE in all threads, this can happen if a thread calls write on
 	a closed pipe. */
@@ -890,6 +899,14 @@ int main(int argc, char *argv[])
 	load_debug_privilege();
 	base_set_crash_handler(main_crash_handler, nullptr);
 
+	/* Shutdown priority value is a range from 0 - 4FF with higher values getting first priority.
+	 * 000 - 0FF and 400 - 4FF are reserved system ranges.
+	 * Processes start at shutdown level 0x280 by default.
+	 * We set the main OBS application to a higher priority to ensure it tries to close before
+	 * any subprocesses such as CEF.
+	 */
+	SetProcessShutdownParameters(0x300, SHUTDOWN_NORETRY);
+
 	const HMODULE hRtwq = LoadLibrary(L"RTWorkQ.dll");
 	if (hRtwq) {
 		typedef HRESULT(STDAPICALLTYPE * PFN_RtwqStartup)();