add changelog to update dialog (#373)

Author: royshil

CMakeLists.txt

@@ -76,6 +76,7 @@ target_sources(
   PRIVATE src/plugin-main.c
           src/ort-utils/ort-session-utils.cpp
           src/obs-utils/obs-utils.cpp
+          src/obs-utils/obs-config-utils.cpp
           src/update-checker/github-utils.cpp
           src/update-checker/update-checker.cpp
           src/update-checker/UpdateDialog.cpp

buildspec.json

@@ -45,7 +45,7 @@
         }
     },
     "name": "obs-backgroundremoval",
-    "version": "1.0.3",
+    "version": "1.1.0",
     "author": "Roy Shilkrot",
     "website": "https://github.com/royshil/obs-backgroundremoval",
     "email": "[email protected]",
@@ -54,4 +54,4 @@
         "macosInstaller": "368f7535-4e71-4587-952b-33ad935bf9f3",
         "windowsApp": "1527c9ec-2638-4e3b-94d7-cc25d27cd725"
     }
-}
+}

src/obs-utils/obs-config-utils.cpp

@@ -0,0 +1,49 @@
+#include "obs-config-utils.h"
+
+#include <obs-module.h>
+
+int getFlagFromConfig(const char *name, bool *returnValue)
+{
+	// Check configuration to see if update checks are disabled
+	char *config_file = obs_module_file("config.json");
+	if (!config_file) {
+		blog(LOG_INFO, "Unable to find config file");
+		return OBS_BGREMOVAL_CONFIG_FAIL;
+	}
+
+	obs_data_t *data = obs_data_create_from_json_file(config_file);
+	if (!data) {
+		blog(LOG_INFO, "Failed to parse config file");
+		return OBS_BGREMOVAL_CONFIG_FAIL;
+	}
+
+	*returnValue = obs_data_get_bool(data, name);
+	obs_data_release(data);
+
+	return OBS_BGREMOVAL_CONFIG_SUCCESS;
+}
+
+int setFlagFromConfig(const char *name, const bool value)
+{
+	// Get the config file
+	char *config_file = obs_module_file("config.json");
+	if (!config_file) {
+		blog(LOG_INFO, "Unable to find config file");
+		return OBS_BGREMOVAL_CONFIG_FAIL;
+	}
+
+	// Parse the config file
+	obs_data_t *json_data = obs_data_create_from_json_file(config_file);
+	if (!json_data) {
+		blog(LOG_INFO, "Failed to parse config file");
+		return OBS_BGREMOVAL_CONFIG_FAIL;
+	}
+
+	// Update the config
+	obs_data_set_bool(json_data, name, value);
+	obs_data_save_json(json_data, config_file);
+
+	obs_data_release(json_data);
+
+	return OBS_BGREMOVAL_CONFIG_SUCCESS;
+}

src/obs-utils/obs-config-utils.h

@@ -0,0 +1,29 @@
+#ifndef OBS_CONFIG_UTILS_H
+#define OBS_CONFIG_UTILS_H
+
+enum {
+	OBS_BGREMOVAL_CONFIG_SUCCESS = 0,
+	OBS_BGREMOVAL_CONFIG_FAIL = 1,
+};
+
+/**
+ * Get a boolean flasg from the module configuration file.
+ *
+ * @param name The name of the config item.
+ * @param returnValue The value of the config item.
+ * @return OBS_BGREMOVAL_CONFIG_SUCCESS if the config item was found,
+ * OBS_BGREMOVAL_CONFIG_FAIL otherwise.
+ */
+int getFlagFromConfig(const char *name, bool *returnValue);
+
+/**
+ * Set a boolean flag in the module configuration file.
+ *
+ * @param name The name of the config item.
+ * @param value The value of the config item.
+ * @return OBS_BGREMOVAL_CONFIG_SUCCESS if the config item was found,
+ * OBS_BGREMOVAL_CONFIG_FAIL otherwise.
+ */
+int setFlagFromConfig(const char *name, const bool value);
+
+#endif /* OBS_CONFIG_UTILS_H */

src/plugin-main.c

@@ -40,11 +40,18 @@ bool obs_module_load(void)
 	obs_register_source(&enhance_filter_info);
 	obs_log(LOG_INFO, "plugin loaded successfully (version %s)",
 		PLUGIN_VERSION);
-	const char *latestRelease = github_utils_get_release();
-	if (latestRelease != NULL) {
-		obs_log(LOG_INFO, "latest release is %s", latestRelease);
+
+	const struct github_utils_release_information latestRelease =
+		github_utils_get_release_information();
+	if (latestRelease.responseCode == OBS_BGREMOVAL_GITHUB_UTILS_SUCCESS) {
+		obs_log(LOG_INFO, "Latest release is %s",
+			latestRelease.version);
 		check_update(latestRelease);
+	} else {
+		obs_log(LOG_INFO, "failed to get latest release information");
 	}
+	github_utils_release_information_free(latestRelease);
+
 	return true;
 }
 

src/update-checker/UpdateDialog.cpp

@@ -1,4 +1,5 @@
 #include "UpdateDialog.hpp"
+#include "obs-utils/obs-config-utils.h"
 
 #include <obs.h>
 #include <obs-module.h>
@@ -8,6 +9,7 @@
 #include <QString>
 
 static QString dialogContent =
+	"<h1>Background Removal - Update available! 🚀</h1>"
 	"<p>A new version of the Background Removal plugin (<a "
 	"href=\"https://github.com/royshil/obs-backgroundremoval/releases\">v{version}</a>) is "
 	"now available for download. We've made some exciting updates and improvements that we think "
@@ -18,53 +20,43 @@ static QString dialogContent =
 	"uninstall the previous version.</p>"
 	"<p>If you have any questions or need assistance during the update process, feel free to reach out"
 	" to our <a href=\"https://github.com/royshil/obs-backgroundremoval/issues\">support team</a>.</p>"
-	"<p>Thank you for using our plugin and we hope you enjoy the latest release! 🙏</p>";
+	"<p>Thank you for using our plugin and we hope you enjoy the latest release! 🙏</p>"
+	"<h2>Changelog</h2>";
 
-UpdateDialog::UpdateDialog(const char *latestVersion, QWidget *parent)
+UpdateDialog::UpdateDialog(
+	struct github_utils_release_information latestVersion, QWidget *parent)
 	: QDialog(parent), layout(new QVBoxLayout)
 {
 	setWindowTitle("Background Removal - Update available! 🚀");
 	setLayout(layout);
 	QLabel *label = new QLabel(dialogContent.replace(
-		QString("{version}"), QString(latestVersion)));
+		QString("{version}"), QString(latestVersion.version)));
 	label->setOpenExternalLinks(true);
 	label->setTextInteractionFlags(Qt::TextBrowserInteraction);
 	label->setTextFormat(Qt::RichText);
 	label->setWordWrap(true);
 	layout->addWidget(label);
+
+	QScrollArea *scrollArea = new QScrollArea;
+	QLabel *scrollAreaLabel =
+		new QLabel(QString(latestVersion.responseBody));
+	scrollAreaLabel->setOpenExternalLinks(true);
+	scrollAreaLabel->setTextInteractionFlags(Qt::TextBrowserInteraction);
+	scrollAreaLabel->setTextFormat(Qt::MarkdownText);
+	scrollAreaLabel->setWordWrap(true);
+	scrollArea->setWidget(scrollAreaLabel);
+	scrollArea->setWidgetResizable(true);
+	layout->addWidget(scrollArea);
+
 	// Add a checkbox to disable update checks
 	QCheckBox *disableCheckbox = new QCheckBox("Disable update checks");
 	layout->addWidget(disableCheckbox);
-	connect(disableCheckbox, &QCheckBox::stateChanged, this,
-		&UpdateDialog::disableUpdateChecks);
+	connect(disableCheckbox, &QCheckBox::stateChanged, this, [](int state) {
+		setFlagFromConfig("check_for_updates", state == Qt::Unchecked);
+	});
+
 	// Add a button to close the dialog
 	QPushButton *closeButton = new QPushButton("Close");
 	layout->addWidget(closeButton);
 	connect(closeButton, &QPushButton::clicked, this, &QDialog::close);
 }
-
-void UpdateDialog::disableUpdateChecks(int state)
-{
-	UNUSED_PARAMETER(state);
-
-	// Get the config file
-	char *config_file = obs_module_file("config.json");
-	if (!config_file) {
-		blog(LOG_INFO, "Unable to find config file");
-		return;
-	}
-
-	// Parse the config file
-	obs_data_t *json_data = obs_data_create_from_json_file(config_file);
-	if (!json_data) {
-		blog(LOG_INFO, "Failed to parse config file");
-		return;
-	}
-
-	// Update the config
-	obs_data_set_bool(json_data, "check_for_updates",
-			  state == Qt::Unchecked);
-	obs_data_save_json(json_data, config_file);
-
-	obs_data_release(json_data);
-}

src/update-checker/UpdateDialog.hpp

@@ -1,11 +1,13 @@
 #include <QtWidgets>
 
+#include "github-utils.h"
+
 class UpdateDialog : public QDialog {
 	Q_OBJECT
 public:
-	UpdateDialog(const char *latestVersion, QWidget *parent = nullptr);
+	UpdateDialog(struct github_utils_release_information latestVersion,
+		     QWidget *parent = nullptr);
 
 private:
 	QVBoxLayout *layout;
-	void disableUpdateChecks(int state);
 };

src/update-checker/github-utils.cpp

@@ -23,12 +23,13 @@ std::size_t writeFunctionStdString(void *ptr, std::size_t size, size_t nmemb,
 	return size * nmemb;
 }
 
-const char *github_utils_get_release(void)
+struct github_utils_release_information
+github_utils_get_release_information(void)
 {
 	CURL *curl = curl_easy_init();
 	if (!curl) {
 		blog(LOG_INFO, "Failed to initialize curl");
-		return NULL;
+		return {OBS_BGREMOVAL_GITHUB_UTILS_ERROR, NULL, NULL};
 	}
 	CURLcode code;
 	curl_easy_setopt(curl, CURLOPT_URL, GITHUB_LATEST_RELEASE_URL.c_str());
@@ -40,26 +41,38 @@ const char *github_utils_get_release(void)
 	curl_easy_cleanup(curl);
 	if (code != CURLE_OK) {
 		blog(LOG_INFO, "Failed to get latest release info");
-		return NULL;
+		return {OBS_BGREMOVAL_GITHUB_UTILS_ERROR, NULL, NULL};
 	}
 
 	// Parse the JSON response
 	obs_data_t *data = obs_data_create_from_json(responseBody.c_str());
 	if (!data) {
 		blog(LOG_INFO, "Failed to parse latest release info");
-		return NULL;
+		return {OBS_BGREMOVAL_GITHUB_UTILS_ERROR, NULL, NULL};
 	}
 
 	// The version is in the "tag_name" property
 	char *version = strdup(obs_data_get_string(data, "tag_name"));
+	char *body = strdup(obs_data_get_string(data, "body"));
 	obs_data_release(data);
 
-	// remove the "v" prefix, if it exists
+	// remove the "v" prefix in version, if it exists
 	if (version[0] == 'v') {
-		char *newVersion = strdup(version + 1);
+		char *newVersion = (char *)malloc(strlen(version) - 1);
+		strcpy(newVersion, version + 1);
 		free(version);
 		version = newVersion;
 	}
 
-	return version;
+	return {OBS_BGREMOVAL_GITHUB_UTILS_SUCCESS, body, version};
+}
+
+void github_utils_release_information_free(
+	struct github_utils_release_information info)
+{
+	if (info.responseBody != NULL)
+		free(info.responseBody);
+	if (info.version != NULL)
+		free(info.version);
+	info.responseCode = OBS_BGREMOVAL_GITHUB_UTILS_ERROR;
 }

src/update-checker/github-utils.h

@@ -4,7 +4,22 @@
 extern "C" {
 #endif
 
-const char *github_utils_get_release(void);
+enum {
+	OBS_BGREMOVAL_GITHUB_UTILS_SUCCESS = 0,
+	OBS_BGREMOVAL_GITHUB_UTILS_ERROR = -1,
+};
+
+struct github_utils_release_information {
+	int responseCode;
+	char *responseBody;
+	char *version;
+};
+
+struct github_utils_release_information
+github_utils_get_release_information(void);
+
+void github_utils_release_information_free(
+	struct github_utils_release_information info);
 
 #ifdef __cplusplus
 }

src/update-checker/update-checker.cpp

@@ -1,5 +1,7 @@
 #include "update-checker.h"
 #include "UpdateDialog.hpp"
+#include "github-utils.h"
+#include "obs-utils/obs-config-utils.h"
 
 #include <obs-frontend-api.h>
 #include <obs-module.h>
@@ -10,30 +12,21 @@ UpdateDialog *update_dialog;
 
 extern "C" const char *PLUGIN_VERSION;
 
-void check_update(const char *latestRelease)
+void check_update(struct github_utils_release_information latestRelease)
 {
-	// Check configuration to see if update checks are disabled
-	char *config_file = obs_module_file("config.json");
-	if (!config_file) {
-		blog(LOG_INFO, "Unable to find config file");
-		return;
-	}
-
-	obs_data_t *data = obs_data_create_from_json_file(config_file);
-	if (!data) {
-		blog(LOG_INFO, "Failed to parse config file");
-		return;
+	bool shouldCheckForUpdates = false;
+	if (getFlagFromConfig("check_for_updates", &shouldCheckForUpdates) !=
+	    OBS_BGREMOVAL_CONFIG_SUCCESS) {
+		// Failed to get the config value, assume it's enabled
+		shouldCheckForUpdates = true;
 	}
 
-	bool shouldCheckForUpdates =
-		obs_data_get_bool(data, "check_for_updates");
-	obs_data_release(data);
 	if (!shouldCheckForUpdates) {
 		// Update checks are disabled
 		return;
 	}
 
-	if (strcmp(latestRelease, PLUGIN_VERSION) == 0) {
+	if (strcmp(latestRelease.version, PLUGIN_VERSION) == 0) {
 		// No update available, latest version is the same as the current version
 		return;
 	}

src/update-checker/update-checker.h

@@ -1,10 +1,12 @@
 #pragma once
 
+#include "github-utils.h"
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-void check_update(const char *latestRelease);
+void check_update(struct github_utils_release_information latestRelease);
 
 #ifdef __cplusplus
 }