Add update checker functionality (#538)

* Add update checker functionality

* Update CMakeLists.txt and CMakePresets.json to disable Qt and add Foundation framework
Remove UpdateDialog.cpp and UpdateDialog.hpp
Refactor code in background-filter.cpp and enhance-filter.cpp

* Refactor code to use std::regex_replace for plugin info replacement

Author: royshil

CMakeLists.txt

@@ -80,6 +80,8 @@ endif()
 if(APPLE)
   add_subdirectory(src/update-checker/URLSessionClient)
   target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE URLSessionClient)
+  # add Foundation framework
+  target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE "-framework Foundation")
 elseif(MSVC)
   add_subdirectory(src/update-checker/WinRTHttpClient)
   target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE WinRTHttpClient)
@@ -96,7 +98,6 @@ target_sources(
           src/obs-utils/obs-config-utils.cpp
           src/update-checker/github-utils.cpp
           src/update-checker/update-checker.cpp
-          src/update-checker/UpdateDialog.cpp
           src/background-filter-info.c
           src/background-filter.cpp
           src/enhance-filter.cpp

CMakePresets.json

@@ -24,7 +24,7 @@
         "CODESIGN_IDENTITY": "$penv{CODESIGN_IDENT}",
         "CODESIGN_TEAM": "$penv{CODESIGN_TEAM}",
         "ENABLE_FRONTEND_API": true,
-        "ENABLE_QT": true
+        "ENABLE_QT": false
       }
     },
     {
@@ -54,7 +54,7 @@
         "QT_VERSION": "6",
         "CMAKE_SYSTEM_VERSION": "10.0.18363.657",
         "ENABLE_FRONTEND_API": true,
-        "ENABLE_QT": true
+        "ENABLE_QT": false
       }
     },
     {
@@ -83,7 +83,7 @@
         "CMAKE_BUILD_TYPE": "RelWithDebInfo",
         "CMAKE_POSITION_INDEPENDENT_CODE": true,
         "ENABLE_FRONTEND_API": true,
-        "ENABLE_QT": true
+        "ENABLE_QT": false
       }
     },
     {
@@ -113,7 +113,7 @@
         "CMAKE_BUILD_TYPE": "RelWithDebInfo",
         "CMAKE_POSITION_INDEPENDENT_CODE": true,
         "ENABLE_FRONTEND_API": true,
-        "ENABLE_QT": true
+        "ENABLE_QT": false
       }
     },
     {

src/background-filter.cpp

@@ -14,8 +14,7 @@
 #include <fstream>
 #include <new>
 #include <mutex>
-
-#include <QString>
+#include <regex>
 
 #include <plugin-support.h>
 #include "models/ModelSINET.h"
@@ -28,6 +27,7 @@
 #include "ort-utils/ort-session-utils.h"
 #include "obs-utils/obs-utils.h"
 #include "consts.h"
+#include "update-checker/update-checker.h"
 
 struct background_removal_filter : public filter_data {
 	bool enableThreshold = true;
@@ -224,11 +224,17 @@ obs_properties_t *background_filter_properties(void *data)
 				 OBS_GROUP_NORMAL, focal_blur_props);
 
 	// Add a informative text about the plugin
-	obs_properties_add_text(props, "info",
-				QString(PLUGIN_INFO_TEMPLATE)
-					.arg(PLUGIN_VERSION)
-					.toStdString()
-					.c_str(),
+	// replace the placeholder with the current version
+	// use std::regex_replace instead of QString::arg because the latter doesn't work on Linux
+	std::string basic_info = std::regex_replace(
+		PLUGIN_INFO_TEMPLATE, std::regex("%1"), PLUGIN_VERSION);
+	// Check for update
+	if (get_latest_version() != nullptr) {
+		basic_info += std::regex_replace(
+			PLUGIN_INFO_TEMPLATE_UPDATE_AVAILABLE, std::regex("%1"),
+			get_latest_version());
+	}
+	obs_properties_add_text(props, "info", basic_info.c_str(),
 				OBS_TEXT_INFO);
 
 	UNUSED_PARAMETER(data);

src/consts.h

@@ -28,5 +28,7 @@ const char *const PLUGIN_INFO_TEMPLATE =
 	"<a href=\"https://github.com/occ-ai/obs-backgroundremoval/\">Background Removal</a> (%1) by "
 	"<a href=\"https://github.com/occ-ai\">OCC AI</a> ❤️ "
 	"<a href=\"https://www.patreon.com/RoyShilkrot\">Support & Follow</a>";
+const char *const PLUGIN_INFO_TEMPLATE_UPDATE_AVAILABLE =
+	"<center><a href=\"https://github.com/occ-ai/obs-backgroundremoval/releases\">🚀 Update available! (%1)</a></center>";
 
 #endif /* CONSTS_H */

src/enhance-filter.cpp

@@ -14,8 +14,7 @@
 #include <fstream>
 #include <new>
 #include <mutex>
-
-#include <QString>
+#include <regex>
 
 #include <plugin-support.h>
 #include "consts.h"
@@ -24,6 +23,7 @@
 #include "models/ModelTBEFN.h"
 #include "models/ModelZeroDCE.h"
 #include "models/ModelURetinex.h"
+#include "update-checker/update-checker.h"
 
 struct enhance_filter : public filter_data {
 	cv::Mat outputBGRA;
@@ -77,11 +77,16 @@ obs_properties_t *enhance_filter_properties(void *data)
 #endif
 
 	// Add a informative text about the plugin
-	obs_properties_add_text(props, "info",
-				QString(PLUGIN_INFO_TEMPLATE)
-					.arg(PLUGIN_VERSION)
-					.toStdString()
-					.c_str(),
+	// replace the placeholder with the current version using std::regex_replace
+	std::string basic_info = std::regex_replace(
+		PLUGIN_INFO_TEMPLATE, std::regex("%1"), PLUGIN_VERSION);
+	// Check for update
+	if (get_latest_version() != nullptr) {
+		basic_info += std::regex_replace(
+			PLUGIN_INFO_TEMPLATE_UPDATE_AVAILABLE, std::regex("%1"),
+			get_latest_version());
+	}
+	obs_properties_add_text(props, "info", basic_info.c_str(),
 				OBS_TEXT_INFO);
 
 	return props;

src/update-checker/UpdateDialog.cpp

@@ -1,5 +1,4 @@
 #include "update-checker.h"
-#include "UpdateDialog.hpp"
 #include "github-utils.h"
 #include "obs-utils/obs-config-utils.h"
 
@@ -8,11 +7,9 @@
 
 #include <plugin-support.h>
 
-#include <QTimer>
-
 extern "C" const char *PLUGIN_VERSION;
 
-UpdateDialog *update_dialog = nullptr;
+static std::string latestVersionForUpdate;
 
 void check_update(void)
 {
@@ -40,26 +37,22 @@ void check_update(void)
 
 		if (info.version == PLUGIN_VERSION) {
 			// No update available, latest version is the same as the current version
+			latestVersionForUpdate.clear();
 			return;
 		}
 
-		try {
-			QTimer::singleShot(2000, [=]() {
-				QWidget *main_window = (QWidget *)
-					obs_frontend_get_main_window();
-				if (main_window == nullptr) {
-					obs_log(LOG_ERROR,
-						"Update Checker failed to get main window");
-					return;
-				}
-				update_dialog =
-					new UpdateDialog(info, main_window);
-				update_dialog->exec();
-			});
-		} catch (...) {
-			obs_log(LOG_ERROR, "Failed to construct UpdateDialog");
-		}
+		latestVersionForUpdate = info.version;
 	};
 
 	github_utils_get_release_information(callback);
 }
+
+const char *get_latest_version(void)
+{
+	obs_log(LOG_INFO, "get_latest_version: %s",
+		latestVersionForUpdate.c_str());
+	if (latestVersionForUpdate.empty()) {
+		return nullptr;
+	}
+	return latestVersionForUpdate.c_str();
+}

src/update-checker/UpdateDialog.hpp

@@ -5,6 +5,7 @@ extern "C" {
 #endif
 
 void check_update(void);
+const char *get_latest_version(void);
 
 #ifdef __cplusplus
 }