Release/1.0.0 rc9 (#23)

* Fix typo in settings window.
* Adds tool tip to Enable Maker Tools checkbox.
* Adds callback to logout endpoint when user logs out, to invalidate token.
* Updates UI copy.
* Blank slates now have 480px max width sub-text field.
* Adds 64 char max length to scene collection name, and 32 character max length to export camera name fields.
* Fixes possible unintentional freed pointer during scene collection install process.
* Improved sign in issue panel.

Author: FiniteSingularity

buildspec.json

@@ -42,7 +42,7 @@
     "versionMinor": 0,
     "versionPatch": 0,
     "buildNumber": 0,
-    "releaseType": "rc8",
+    "releaseType": "rc9",
     "author": "Elgato",
     "website": "https://elgato.com",
     "email": "support@elgato.com",

data/locale/en-US.ini

@@ -1,55 +1,56 @@
 General.SaveButton="Save"
-General.SaveChangesButton="Save Changes"
+General.SaveChangesButton="Save changes"
 General.CancelButton="Cancel"
-MarketplaceWindow.LoginButton.LogIn="Sign In"
-MarketplaceWindow.LoginButton.LogOut="Sign Out"
-MarketplaceWindow.OpenSettingsButton.Tooltip="Open Settings"
+MarketplaceWindow.LoginButton.LogIn="Sign in"
+MarketplaceWindow.LoginButton.LogOut="Sign out"
+MarketplaceWindow.OpenSettingsButton.Tooltip="Open settings"
 MarketplaceWindow.StoreButton.Tooltip="Go to Elgato Marketplace"
-MarketplaceWindow.DownloadButton.Tooltip="Click to Download"
+MarketplaceWindow.DownloadButton.Tooltip="Click to download"
 MarketplaceWindow.PurchasedTab="Products"
 MarketplaceWindow.Purchased.NoPurchasesTitle="You don't own any scene collection products yet"
 MarketplaceWindow.Purchased.NoPurchasesSubtitle="Your digital assets from Marketplace will appear here"
 MarketplaceWindow.Purchased.OpenMarketplaceButton="Explore Marketplace"
 MarketplaceWindow.LoginNeeded.Title="Sign in to get started"
 MarketplaceWindow.LoginNeeded.Subtitle="First off, let's connect your Marketplace account with OBS Studio"
-MarketplaceWindow.LoginError.Title="Login Error"
-MarketplaceWindow.LoginError.Subtitle="There was an error logging you in. Please click the Log In button above to try again."
+MarketplaceWindow.LoginError.Title="Sign in"
+MarketplaceWindow.LoginError.Subtitle="There was an issue signing you in. Please try signing in again to continue."
 MarketplaceWindow.LoggingIn.Title="Signing you in"
 MarketplaceWindow.LoggingIn.Subtitle="Please sign in using the browser window that should have appeared. If no browser window appeared, or you accidentally closed it, click below to try again."
-MarketplaceWindow.LoggingIn.TryAgain="Try Again"
-MarketplaceWindow.ConnectionError.Title="Connection Error"
+MarketplaceWindow.LoggingIn.TryAgain="Try again"
+MarketplaceWindow.ConnectionError.Title="Connection error"
 MarketplaceWindow.ConnectionError.Subtitle="Could not connect to the server. (please check your network connection)"
-MarketplaceWindow.Loading.Title="Loading Your Purchased Products..."
+MarketplaceWindow.Loading.Title="Loading your purchased products..."
 MarketplaceWindow.Settings.Title="Settings"
 MarketplaceWindow.Settings.DefaultVideoDevice.Label="Default camera"
-MarketplaceWindow.Settings.DefaultVideoDevice.NoneSelected="None Selected"
-MarketplaceWindow.Settings.DefaultVideoDevice.SettingsButton.Tooltip="Video Capture Device Settings"
+MarketplaceWindow.Settings.DefaultVideoDevice.NoneSelected="None selected"
+MarketplaceWindow.Settings.DefaultVideoDevice.SettingsButton.Tooltip="Video capture device settings"
 MarketplaceWindow.Settings.DefaultAudioDevice.Label="Default microphone"
-MarketplaceWindow.Settings.InstallLocation="Medial File Install Location"
-MarketplaceWindow.Settings.EnableMakerTools="Turn on Maker tools"
-MarketplaceWindow.Settings.MakerToolsRestartWarning.Disabled="Maker tools will be disabled after restarting OBS."
-MarketplaceWindow.Settings.MakerToolsRestartWarning.Enabled="Maker tools will be enabled after restarting OBS."
-MarketplaceWindow.DownloadProduct.NetworkError.Title="Network Connection Error"
+MarketplaceWindow.Settings.InstallLocation="Media file install location"
+MarketplaceWindow.Settings.EnableMakerTools="Turn on maker tools"
+MarketplaceWindow.Settings.EnableMakerTools.Tooltip="Enables export and import tools for makers who want to create scene collections for the Elgato Marketplace."
+MarketplaceWindow.Settings.MakerToolsRestartWarning.Disabled="Maker tools will be disabled after restarting OBS"
+MarketplaceWindow.Settings.MakerToolsRestartWarning.Enabled="Maker tools will be enabled after restarting OBS"
+MarketplaceWindow.DownloadProduct.NetworkError.Title="Network connection error"
 MarketplaceWindow.DownloadProduct.NetworkError.Subtitle="Could not connect to the Marketplace. Please try again."
-MarketplaceWindow.DownloadProduct.InvalidFiletype.Title="Invalid File Type"
-MarketplaceWindow.DownloadProduct.InvalidFiletype.Subtitle="File is not an .elgatoscene file."
+MarketplaceWindow.DownloadProduct.InvalidFiletype.Title="Invalid file type"
+MarketplaceWindow.DownloadProduct.InvalidFiletype.Subtitle="File is not an .elgatoscene file"
 ExportWizard.NextButton="Continue"
 ExportWizard.BackButton="Back"
 ExportWizard.SaveAsButton="Save as"
 ExportWizard.CloseButton="Done"
 ExportWizard.MediaFileCheck.Title="Review your export"
-ExportWizard.MediaFileCheck.Text=" media files were found to bundle."
+ExportWizard.MediaFileCheck.Text=" media files were found to bundle"
 ExportWizard.VideoSourceLabels.Title="Name video sources"
 ExportWizard.VideoSourceLabels.Text="Choose how your video sources will appear for users"
 ExportWizard.VideoSourceLabels.InputPlaceholder="Description text goes here"
-ExportWizard.VideoSourceLabels.NoCaptureSourcesText="No video capture sources found."
+ExportWizard.VideoSourceLabels.NoCaptureSourcesText="No video capture sources found"
 ExportWizard.RequiredPlugins.Title="Add required plugins"
 ExportWizard.RequiredPlugins.Text="Select any plugins needed to run this asset"
-ExportWizard.RequiredPlugins.NoPluginsFound="No installed plugins found."
+ExportWizard.RequiredPlugins.NoPluginsFound="No installed plugins found"
 ExportWizard.ExportComplete.Title="Export complete"
-ExportWizard.ExportComplete.Text="Your scene collection is now ready to test or upload to Marketplace."
+ExportWizard.ExportComplete.Text="Your scene collection is now ready to test or upload to Marketplace"
 ExportWizard.Exporting.Title="Exporting Bundle..."
-ExportWizard.Exporting.Text="Note: this can take a few minutes for scene collections with large files."
+ExportWizard.Exporting.Text="This can take a few minutes for scene collections with large files"
 SetupWizard.WindowTitle="Install Scene Collection"
 SetupWizard.NextButton="Continue"
 SetupWizard.BackButton="Back"
@@ -61,15 +62,15 @@ SetupWizard.MissingPlugins.DownloadButton="Get"
 SetupWizard.SelectInstall.Title="How do you want to install this?"
 SetupWizard.SelectInstall.NewInstallButton="New"
 SetupWizard.SelectInstall.ExistingInstallButton="Add"
-SetupWizard.CreateCollection.Title="Create Scene Collection"
-SetupWizard.CreateCollection.NewNamePlaceholder="Collection Name"
-SetupWizard.NameInUseError.Title="Name in use."
+SetupWizard.CreateCollection.Title="Create ccene collection"
+SetupWizard.CreateCollection.NewNamePlaceholder="Collection name"
+SetupWizard.NameInUseError.Title="Name in use"
 SetupWizard.NameInUseError.Text="A scene collection already exists with this name. Please provide another name."
 SetupWizard.AudioSetup.Device.Text="Select a microphone"
 SetupWizard.Loading.Title="Loading Collection..."
-SetupWizard.Loading.Text="Note: this can take some time for scene collections with large files."
+SetupWizard.Loading.Text="This can take some time for scene collections with large files"
 SetupWizard.IncompatibleFile.Title="Incompatible file"
-SetupWizard.IncompatibleFile.Text="Error: This download did not contain a valid bundleInfo.json file and cannot be installed. (note: this is a problem with the submitted scene collection file on the server)"
+SetupWizard.IncompatibleFile.Text="Error: this download did not contain a valid bundleInfo.json file and cannot be installed. (this is a problem with the submitted scene collection file on the server)"
 UpdateModal.Title="Update available"
 UpdateModal.SkipVersionButton="No thanks"
 UpdateModal.LaterButton="Ask me later"

src/api.cpp

@@ -64,6 +64,14 @@ MarketplaceApi::MarketplaceApi()
 
 void MarketplaceApi::logOut()
 {
+	std::string url = _authUrl + "/auth/realms/mp/protocol/openid-connect/logout";
+	auto ec = GetElgatoCloud();
+	auto refreshToken = ec->GetRefreshToken();
+	auto accessToken = ec->GetAccessToken();
+	if (refreshToken != "") {
+		std::string postBody = "{\"client_id\": \"elgatolink\", \"refresh_token\": \"" + refreshToken + "\" }";
+		auto resp = fetch_string_from_post(url, postBody, accessToken);
+	}
 	_loggedIn = false;
 	_hasAvatar = false;
 	_avatarReady = false;
@@ -111,11 +119,9 @@ void MarketplaceApi::setUserDetails(nlohmann::json &data)
 					std::lock_guard<std::mutex> lock(_mtx);
 					if (!_avatarDownloading) {
 						if (!os_file_exists(avatarPath.c_str())) {
-							obs_log(LOG_INFO, "Downloading avatar %s", filename.c_str());
 							_downloadAvatar();
 						}
 						else {
-							obs_log(LOG_INFO, "Avatar Exists %s", filename.c_str());
 							_avatarPath = avatarPath;
 							_avatarReady = true;
 						}

src/downloader.cpp

@@ -130,7 +130,6 @@ size_t Downloader::DownloadEntry::handle_progress(void *ptr, curl_off_t dltotal,
 	UNUSED_PARAMETER(ultotal);
 	UNUSED_PARAMETER(ulnow);
 	//double pct = (int)((double)dlnow / (double)dltotal * 100.0);
-	obs_log(LOG_INFO, "%s: %i of %i", self.url.c_str(), dlnow, dltotal);
 	return CURL_PROGRESSFUNC_CONTINUE;
 }
 
@@ -192,8 +191,6 @@ Downloader::DownloadEntry::DownloadEntry(Downloader *parent, std::string url,
 				count = count - start;
 			}
 			detectedFileName = url.substr(start, count);
-			obs_log(LOG_INFO, "Detected filename: %s",
-				detectedFileName.c_str());
 		}
 	}
 
@@ -222,8 +219,6 @@ void Downloader::DownloadEntry::Finish()
 	}
 
 	if (targetDirectory != "") {
-		obs_log(LOG_INFO, "Saving file to: %s",
-			(targetDirectory + fileName).c_str());
 		if (fileName == "") {
 			fileName = random_name();
 		}

src/elgato-cloud-config.cpp

@@ -345,7 +345,6 @@ void DefaultAVWidget::OBSVolumeLevel(void *data,
 {
 	UNUSED_PARAMETER(peak);
 	UNUSED_PARAMETER(inputPeak);
-	//obs_log(LOG_INFO, "OBS Volume Level");
 	auto config = static_cast<DefaultAVWidget *>(data);
 	float mag = magnitude[0];
 	float pk = peak[0];
@@ -548,6 +547,7 @@ ElgatoCloudConfig::ElgatoCloudConfig(QWidget *parent) : QDialog(parent)
 	checkBoxStyle.replace("${checked-img}", checkedImage.c_str());
 	checkBoxStyle.replace("${unchecked-img}", uncheckedImage.c_str());
 	_makerCheckbox->setStyleSheet(checkBoxStyle);
+	_makerCheckbox->setToolTip(obs_module_text("MarketplaceWindow.Settings.EnableMakerTools.Tooltip"));
 	layout->addWidget(_makerCheckbox);
 
 	connect(_makerCheckbox, &QCheckBox::stateChanged, [this](int state) {
@@ -630,7 +630,6 @@ void ElgatoCloudConfig::OpenConfigAudioSource()
 	for (size_t i = 0; i < obs_property_list_item_count(devices); i++) {
 		std::string name = obs_property_list_item_name(devices, i);
 		std::string id = obs_property_list_item_string(devices, i);
-		obs_log(LOG_INFO, "--- MIC: %s [%s]", name.c_str(), id.c_str());
 	}
 	obs_properties_destroy(props);
 }

src/elgato-cloud-data.cpp

@@ -105,6 +105,20 @@ std::string ElgatoCloud::GetAccessToken()
 	}
 }
 
+std::string ElgatoCloud::GetRefreshToken()
+{
+	if (!loggedIn) {
+		return "";
+	}
+	_TokenRefresh(false, false);
+	if (loggedIn) {
+		return _refreshToken;
+	}
+	else { // Our refresh token has expired, we're not really logged in.
+		return "";
+	}
+}
+
 void ElgatoCloud::_TokenRefresh(bool loadData, bool loadUserDetails)
 {
 	const auto now = std::chrono::system_clock::now();
@@ -283,21 +297,20 @@ void ElgatoCloud::StartLogin()
 		stringhash + "&code_challenge_method=S256";
 
 	authorizing = true;
-	obs_log(LOG_INFO, "Starting login process...");
-	obs_log(LOG_INFO, "Opening in browser:\n%s", url.c_str());
 	ShellExecuteA(NULL, NULL, url.c_str(), NULL, NULL, SW_SHOW);
 }
 
 void ElgatoCloud::LogOut()
 {
+	auto api = MarketplaceApi::getInstance();
+	api->logOut();
+
 	_accessToken = "";
 	_refreshToken = "";
 	_accessTokenExpiration = 0;
 	_refreshTokenExpiration = 0;
 	_SaveState();
 	loggedIn = false;
-	auto api = MarketplaceApi::getInstance();
-	api->logOut();
 
 	if (mainWindowOpen && window) {
 		window->setLoggedIn();
@@ -479,7 +492,7 @@ void ElgatoCloud::_LoadUserData(bool loadData)
 		}
 	} catch (...) {
 		obs_log(LOG_INFO, "Invalid response from server");
-		connectionError = true;
+		loginError = true;
 	}
 }
 

src/elgato-cloud-data.hpp

@@ -57,6 +57,7 @@ class ElgatoCloud {
 	void SetSkipVersion(std::string version);
 	void SaveConfig();
 	std::string GetAccessToken();
+	std::string GetRefreshToken();
 	nlohmann::json GetPurchaseDownloadLink(std::string variantId);
 
 	obs_module_t *GetModule();