etc/obs-StreamFX
0
0
Fork 0
mirror of https://github.com/Xaymar/obs-StreamFX synced 2024-11-27 22:03:01 +00:00
Code Issues Projects Releases Packages Wiki Activity
obs-StreamFX/source/ui/ui-updater.cpp
Michael Fabian 'Xaymar' Dirks e9283aec37 project: Add support for multi stage release cycles 
To ensure better stability of future releases, we need to adopt multiple stages in the release cycle. As we already label Alpha, Beta, Candidate and Stable differently, simply adopting this classification system already does everything for us. This also allows us to maintain compatibility with the existing system, while offering something new entirely.
2023-04-05 18:58:27 +02:00

316 lines
11 KiB
C++
Raw Blame History

// Copyright (c) 2020 Michael Fabian Dirks <info@xaymar.com>
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
#include "ui-updater.hpp"
#include "common.hpp"
#include "util/util-logging.hpp"
#ifdef _DEBUG
#define ST_PREFIX "<%s> "
#define D_LOG_ERROR(x, ...) P_LOG_ERROR(ST_PREFIX##x, __FUNCTION_SIG__, __VA_ARGS__)
#define D_LOG_WARNING(x, ...) P_LOG_WARN(ST_PREFIX##x, __FUNCTION_SIG__, __VA_ARGS__)
#define D_LOG_INFO(x, ...) P_LOG_INFO(ST_PREFIX##x, __FUNCTION_SIG__, __VA_ARGS__)
#define D_LOG_DEBUG(x, ...) P_LOG_DEBUG(ST_PREFIX##x, __FUNCTION_SIG__, __VA_ARGS__)
#else
#define ST_PREFIX "<ui::updater> "
#define D_LOG_ERROR(...) P_LOG_ERROR(ST_PREFIX __VA_ARGS__)
#define D_LOG_WARNING(...) P_LOG_WARN(ST_PREFIX __VA_ARGS__)
#define D_LOG_INFO(...) P_LOG_INFO(ST_PREFIX __VA_ARGS__)
#define D_LOG_DEBUG(...) P_LOG_DEBUG(ST_PREFIX __VA_ARGS__)
#endif
#define D_I18N_MENU_CHECKFORUPDATES "UI.Updater.Menu.CheckForUpdates"
#define D_I18N_MENU_CHECKFORUPDATES_AUTOMATICALLY "UI.Updater.Menu.CheckForUpdates.Automatically"
#define D_I18N_MENU_CHANNEL "UI.Updater.Menu.Channel"
#define D_I18N_MENU_CHANNEL_STABLE "UI.Updater.Menu.Channel.Stable"
#define D_I18N_MENU_CHANNEL_CANDIDATE "UI.Updater.Menu.Channel.Candidate"
#define D_I18N_MENU_CHANNEL_BETA "UI.Updater.Menu.Channel.Beta"
#define D_I18N_MENU_CHANNEL_ALPHA "UI.Updater.Menu.Channel.Alpha"
#define D_I18N_DIALOG_TITLE "UI.Updater.Dialog.Title"
#define D_I18N_GITHUBPERMISSION_TITLE "UI.Updater.GitHubPermission.Title"
#define D_I18N_GITHUBPERMISSION_TEXT "UI.Updater.GitHubPermission.Text"
streamfx::ui::updater_dialog::updater_dialog() : QDialog(reinterpret_cast<QWidget*>(obs_frontend_get_main_window()))
{
setupUi(this);
setWindowFlag(Qt::WindowContextHelpButtonHint, false);
setWindowFlag(Qt::WindowMinimizeButtonHint, false);
setWindowFlag(Qt::WindowMaximizeButtonHint, false);
setAttribute(Qt::WA_DeleteOnClose, false); // Do not delete on close.
connect(ok, &QPushButton::clicked, this, &streamfx::ui::updater_dialog::on_ok);
connect(cancel, &QPushButton::clicked, this, &streamfx::ui::updater_dialog::on_cancel);
}
streamfx::ui::updater_dialog::~updater_dialog() {}
void streamfx::ui::updater_dialog::show(streamfx::version_info current, streamfx::version_info update)
{
currentVersion->setText(QString::fromStdString(static_cast<std::string>(current)));
latestVersion->setText(QString::fromStdString(static_cast<std::string>(update)));
{
std::string buf = latestVersion->text().toStdString();
std::vector<char> buf2;
buf2.resize(static_cast<size_t>(snprintf(nullptr, 0, D_TRANSLATE(D_I18N_DIALOG_TITLE), buf.data())) + 1);
snprintf(buf2.data(), buf2.size(), D_TRANSLATE(D_I18N_DIALOG_TITLE), buf.data());
setWindowTitle(QString::fromUtf8(buf2.data()));
}
_update_url = QUrl(QString::fromStdString(update.url));
this->setModal(true);
QDialog::show();
}
void streamfx::ui::updater_dialog::hide()
{
QDialog::hide();
this->setModal(false);
}
void streamfx::ui::updater_dialog::on_ok()
{
QDesktopServices::openUrl(_update_url);
hide();
accept();
}
void streamfx::ui::updater_dialog::on_cancel()
{
hide();
reject();
}
streamfx::ui::updater::updater(QMenu* menu)
: _updater(), _dialog(nullptr), _gdpr(nullptr), _cfu(nullptr), _cfu_auto(nullptr), _channel(nullptr),
_channel_menu(nullptr), _channel_stable(nullptr), _channel_candidate(nullptr), _channel_beta(nullptr),
_channel_alpha(nullptr), _channel_group(nullptr)
{
// Create dialog.
_dialog = new updater_dialog();
{ // Create the necessary menu entries.
menu->addSeparator();
// Check for Updates
_cfu = menu->addAction(QString::fromUtf8(D_TRANSLATE(D_I18N_MENU_CHECKFORUPDATES)));
_cfu->setMenuRole(QAction::NoRole);
connect(_cfu, &QAction::triggered, this, &streamfx::ui::updater::on_cfu_triggered);
// Automatically check for Updates
_cfu_auto = menu->addAction(QString::fromUtf8(D_TRANSLATE(D_I18N_MENU_CHECKFORUPDATES_AUTOMATICALLY)));
_cfu_auto->setMenuRole(QAction::NoRole);
_cfu_auto->setCheckable(true);
connect(_cfu_auto, &QAction::toggled, this, &streamfx::ui::updater::on_cfu_auto_toggled);
// Update Channel
_channel_menu = menu->addMenu(QString::fromUtf8(D_TRANSLATE(D_I18N_MENU_CHANNEL)));
_channel_menu->menuAction()->setMenuRole(QAction::NoRole);
_channel_stable = _channel_menu->addAction(QString::fromUtf8(D_TRANSLATE(D_I18N_MENU_CHANNEL_STABLE)));
_channel_stable->setMenuRole(QAction::NoRole);
_channel_stable->setCheckable(true);
_channel_candidate = _channel_menu->addAction(QString::fromUtf8(D_TRANSLATE(D_I18N_MENU_CHANNEL_CANDIDATE)));
_channel_candidate->setMenuRole(QAction::NoRole);
_channel_candidate->setCheckable(true);
_channel_beta = _channel_menu->addAction(QString::fromUtf8(D_TRANSLATE(D_I18N_MENU_CHANNEL_BETA)));
_channel_beta->setMenuRole(QAction::NoRole);
_channel_beta->setCheckable(true);
_channel_alpha = _channel_menu->addAction(QString::fromUtf8(D_TRANSLATE(D_I18N_MENU_CHANNEL_ALPHA)));
_channel_alpha->setMenuRole(QAction::NoRole);
_channel_alpha->setCheckable(true);
_channel_group = new QActionGroup(_channel_menu);
_channel_group->addAction(_channel_stable);
_channel_group->addAction(_channel_candidate);
_channel_group->addAction(_channel_beta);
_channel_group->addAction(_channel_alpha);
connect(_channel_group, &QActionGroup::triggered, this, &streamfx::ui::updater::on_channel_group_triggered);
}
// Connect internal signals.
connect(this, &streamfx::ui::updater::autoupdate_changed, this, &streamfx::ui::updater::on_autoupdate_changed,
Qt::QueuedConnection);
connect(this, &streamfx::ui::updater::channel_changed, this, &streamfx::ui::updater::on_channel_changed,
Qt::QueuedConnection);
connect(this, &streamfx::ui::updater::update_detected, this, &streamfx::ui::updater::on_update_detected,
Qt::QueuedConnection);
connect(this, &streamfx::ui::updater::check_active, this, &streamfx::ui::updater::on_check_active,
Qt::QueuedConnection);
{ // Retrieve the updater object and listen to it.
_updater = streamfx::updater::instance();
_updater->events.automation_changed.add(std::bind(&streamfx::ui::updater::on_updater_automation_changed, this,
std::placeholders::_1, std::placeholders::_2));
_updater->events.channel_changed.add(std::bind(&streamfx::ui::updater::on_updater_channel_changed, this,
std::placeholders::_1, std::placeholders::_2));
_updater->events.refreshed.add(
std::bind(&streamfx::ui::updater::on_updater_refreshed, this, std::placeholders::_1));
// Sync with updater information.
emit autoupdate_changed(_updater->is_automated());
emit channel_changed(_updater->get_channel());
}
}
streamfx::ui::updater::~updater() {}
void streamfx::ui::updater::on_updater_automation_changed(streamfx::updater&, bool value)
{
emit autoupdate_changed(value);
}
void streamfx::ui::updater::on_updater_channel_changed(streamfx::updater&, streamfx::version_stage channel)
{
emit channel_changed(channel);
}
void streamfx::ui::updater::on_updater_refreshed(streamfx::updater&)
{
emit check_active(false);
if (!_updater->is_update_available())
return;
emit update_detected();
}
void streamfx::ui::updater::obs_ready()
{
if (_updater->is_automated()) {
if (_updater->is_data_sharing_allowed()) {
_updater->refresh();
} else {
create_gdpr_box();
_gdpr->exec();
}
}
}
void streamfx::ui::updater::on_channel_changed(streamfx::version_stage ch)
{
QSignalBlocker bgroup(_channel_group);
QSignalBlocker bs(_channel_stable);
QSignalBlocker bc(_channel_candidate);
QSignalBlocker bb(_channel_beta);
QSignalBlocker ba(_channel_alpha);
_channel_stable->setChecked(ch == streamfx::version_stage::STABLE);
_channel_candidate->setChecked(ch == streamfx::version_stage::CANDIDATE);
_channel_beta->setChecked(ch == streamfx::version_stage::BETA);
_channel_alpha->setChecked(ch == streamfx::version_stage::ALPHA);
}
void streamfx::ui::updater::on_update_detected()
{
_dialog->show(_updater->get_current_info(), _updater->get_update_info());
}
void streamfx::ui::updater::on_autoupdate_changed(bool enabled)
{
QSignalBlocker blocker(_cfu_auto);
_cfu_auto->setChecked(enabled);
}
void streamfx::ui::updater::on_gdpr_button(QAbstractButton* btn)
{
if (_gdpr->standardButton(btn) == QMessageBox::Ok) {
_updater->set_data_sharing_allowed(true);
emit check_active(true);
_updater->refresh();
} else {
_updater->set_data_sharing_allowed(false);
_updater->set_automation(false);
}
}
void streamfx::ui::updater::on_cfu_triggered(bool)
{
if (!_updater->is_data_sharing_allowed()) {
create_gdpr_box();
_gdpr->exec();
} else {
emit check_active(true);
_updater->refresh();
}
}
void streamfx::ui::updater::on_cfu_auto_toggled(bool flag)
{
_updater->set_automation(flag);
}
void streamfx::ui::updater::on_channel_group_triggered(QAction* action)
{
if (action == _channel_alpha) {
_updater->set_channel(streamfx::version_stage::ALPHA);
} else if (action == _channel_beta) {
_updater->set_channel(streamfx::version_stage::BETA);
} else if (action == _channel_candidate) {
_updater->set_channel(streamfx::version_stage::CANDIDATE);
} else {
_updater->set_channel(streamfx::version_stage::STABLE);
}
}
std::shared_ptr<streamfx::ui::updater> streamfx::ui::updater::instance(QMenu* menu)
{
static std::weak_ptr<streamfx::ui::updater> _instance;
static std::mutex _lock;
auto lock = std::lock_guard<std::mutex>(_lock);
if (_instance.expired() && menu) {
auto ptr = std::make_shared<streamfx::ui::updater>(menu);
_instance = ptr;
return ptr;
} else {
return _instance.lock();
}
}
void streamfx::ui::updater::on_check_active(bool active)
{
_cfu->setEnabled(!active);
_channel_group->setEnabled(!active);
_channel_alpha->setEnabled(!active);
_channel_beta->setEnabled(!active);
_channel_candidate->setEnabled(!active);
_channel_stable->setEnabled(!active);
_channel_menu->setEnabled(!active);
}
void streamfx::ui::updater::create_gdpr_box()
{
if (_gdpr) {
_gdpr->deleteLater();
_gdpr = nullptr;
}
// Create GitHub message box.
_gdpr = new QMessageBox(reinterpret_cast<QWidget*>(obs_frontend_get_main_window()));
_gdpr->setWindowTitle(QString::fromUtf8(D_TRANSLATE(D_I18N_GITHUBPERMISSION_TITLE)));
_gdpr->setTextFormat(Qt::TextFormat::RichText);
_gdpr->setText(QString::fromUtf8(D_TRANSLATE(D_I18N_GITHUBPERMISSION_TEXT)));
_gdpr->setStandardButtons(QMessageBox::Ok | QMessageBox::Cancel);
connect(_gdpr, &QMessageBox::buttonClicked, this, &streamfx::ui::updater::on_gdpr_button);
}
Reference in a new issue View git blame Copy permalink