/* PCSX2 - PS2 Emulator for PCs * Copyright (C) 2002-2023 PCSX2 Dev Team * * PCSX2 is free software: you can redistribute it and/or modify it under the terms * of the GNU Lesser General Public License as published by the Free Software Found- * ation, either version 3 of the License, or (at your option) any later version. * * PCSX2 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR * PURPOSE. See the GNU General Public License for more details. * * You should have received a copy of the GNU General Public License along with PCSX2. * If not, see . */ #include "PrecompiledHeader.h" #include "AutoUpdaterDialog.h" #include "MainWindow.h" #include "QtHost.h" #include "QtUtils.h" #include "pcsx2/Host.h" #include "pcsx2/SysForwardDefs.h" #include "svnrev.h" #include "updater/UpdaterExtractor.h" #include "common/CocoaTools.h" #include "common/Console.h" #include "common/FileSystem.h" #include "common/StringUtil.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include // Logic to detect whether we can use the auto updater. // We use tagged commit, because this gets set on nightly builds. #if (defined(_WIN32) || defined(__linux__) || defined(__APPLE__)) && defined(GIT_TAG_LO) #define AUTO_UPDATER_SUPPORTED 1 #if defined(_WIN32) #define UPDATE_PLATFORM_STR "Windows" #elif defined(__linux__) #define UPDATE_PLATFORM_STR "Linux" #elif defined(__APPLE__) #define UPDATE_PLATFORM_STR "MacOS" #endif #ifdef MULTI_ISA_SHARED_COMPILATION // #undef UPDATE_ADDITIONAL_TAGS #elif _M_SSE >= 0x501 #define UPDATE_ADDITIONAL_TAGS "AVX2" #else #define UPDATE_ADDITIONAL_TAGS "SSE4" #endif #endif #ifdef AUTO_UPDATER_SUPPORTED #define LATEST_RELEASE_URL "https://api.pcsx2.net/v1/%1Releases?pageSize=1" #define CHANGES_URL "https://api.github.com/repos/PCSX2/pcsx2/compare/%1...%2" // Available release channels. static const char* UPDATE_TAGS[] = {"stable", "nightly"}; // Bit annoying, because PCSX2_isReleaseVersion is a bool, but whatever. #define THIS_RELEASE_TAG (PCSX2_isReleaseVersion ? "stable" : "nightly") #endif AutoUpdaterDialog::AutoUpdaterDialog(QWidget* parent /* = nullptr */) : QDialog(parent) { m_network_access_mgr = new QNetworkAccessManager(this); m_ui.setupUi(this); setWindowFlags(windowFlags() & ~Qt::WindowContextHelpButtonHint); connect(m_ui.downloadAndInstall, &QPushButton::clicked, this, &AutoUpdaterDialog::downloadUpdateClicked); connect(m_ui.skipThisUpdate, &QPushButton::clicked, this, &AutoUpdaterDialog::skipThisUpdateClicked); connect(m_ui.remindMeLater, &QPushButton::clicked, this, &AutoUpdaterDialog::remindMeLaterClicked); } AutoUpdaterDialog::~AutoUpdaterDialog() = default; bool AutoUpdaterDialog::isSupported() { #ifdef AUTO_UPDATER_SUPPORTED #ifdef __linux__ // For Linux, we need to check whether we're running from the appimage. if (!std::getenv("APPIMAGE")) { Console.Warning("We're a tagged commit, but not running from an AppImage. Disabling automatic updater."); return false; } return true; #else // Windows, MacOS - always supported. return true; #endif #else return false; #endif } QStringList AutoUpdaterDialog::getTagList() { #ifdef AUTO_UPDATER_SUPPORTED return QStringList(std::begin(UPDATE_TAGS), std::end(UPDATE_TAGS)); #else return QStringList(); #endif } std::string AutoUpdaterDialog::getDefaultTag() { #ifdef AUTO_UPDATER_SUPPORTED return THIS_RELEASE_TAG; #else return {}; #endif } QString AutoUpdaterDialog::getCurrentVersion() { return QStringLiteral(GIT_TAG); } QString AutoUpdaterDialog::getCurrentVersionDate() { // 20220403235450ll const QDateTime current_build_date(QDateTime::fromString(QStringLiteral("%1").arg(SVN_REV), "yyyyMMddhhmmss")); return current_build_date.toString(); } QString AutoUpdaterDialog::getCurrentUpdateTag() const { #ifdef AUTO_UPDATER_SUPPORTED return QString::fromStdString(Host::GetBaseStringSettingValue("AutoUpdater", "UpdateTag", THIS_RELEASE_TAG)); #else return QString(); #endif } void AutoUpdaterDialog::reportError(const char* msg, ...) { std::va_list ap; va_start(ap, msg); std::string full_msg = StringUtil::StdStringFromFormatV(msg, ap); va_end(ap); // don't display errors when we're doing an automatic background check, it's just annoying Console.Error("Updater Error: %s", full_msg.c_str()); if (m_display_messages) QMessageBox::critical(this, tr("Updater Error"), QString::fromStdString(full_msg)); } void AutoUpdaterDialog::queueUpdateCheck(bool display_message) { m_display_messages = display_message; #ifdef AUTO_UPDATER_SUPPORTED connect(m_network_access_mgr, &QNetworkAccessManager::finished, this, &AutoUpdaterDialog::getLatestReleaseComplete); QUrl url(QStringLiteral(LATEST_RELEASE_URL).arg(getCurrentUpdateTag())); QNetworkRequest request(url); m_network_access_mgr->get(request); #else emit updateCheckCompleted(); #endif } void AutoUpdaterDialog::getLatestReleaseComplete(QNetworkReply* reply) { #ifdef AUTO_UPDATER_SUPPORTED // this might fail due to a lack of internet connection - in which case, don't spam the user with messages every time. m_network_access_mgr->disconnect(this); reply->deleteLater(); bool found_update_info = false; if (reply->error() == QNetworkReply::NoError) { const QByteArray reply_json(reply->readAll()); QJsonParseError parse_error; QJsonDocument doc(QJsonDocument::fromJson(reply_json, &parse_error)); if (doc.isObject()) { const QJsonObject doc_object(doc.object()); const QJsonArray data_array(doc_object["data"].toArray()); if (!data_array.isEmpty()) { // just take the first one, that's all we requested anyway const QJsonObject data_object(data_array.first().toObject()); const QJsonObject assets_object(data_object["assets"].toObject()); const QJsonArray platform_array(assets_object[UPDATE_PLATFORM_STR].toArray()); if (!platform_array.isEmpty()) { QJsonObject best_asset; int best_asset_score = 0; // search for usable files for (const QJsonValue& asset_value : platform_array) { const QJsonObject asset_object(asset_value.toObject()); const QJsonArray additional_tags_array(asset_object["additionalTags"].toArray()); bool is_symbols = false; bool is_avx2 = false; bool is_sse4 = false; bool is_qt_asset = false; bool is_perfect_match = false; for (const QJsonValue& additional_tag : additional_tags_array) { const QString additional_tag_str(additional_tag.toString()); if (additional_tag_str == QStringLiteral("symbols")) { // we're not interested in symbols downloads is_symbols = true; break; } else if (additional_tag_str.startsWith(QStringLiteral("Qt"))) { // found a qt build // Note: The website improperly parses macOS file names, and gives them the tag "Qt.tar" instead of "Qt" is_qt_asset = true; } else if (additional_tag_str == QStringLiteral("SSE4")) { is_sse4 = true; } else if (additional_tag_str == QStringLiteral("AVX2")) { is_avx2 = true; } #ifdef UPDATE_ADDITIONAL_TAGS if (additional_tag_str == QStringLiteral(UPDATE_ADDITIONAL_TAGS)) { // Found the same variant as what's currently running! But keep checking in case it's symbols. is_perfect_match = true; } #endif } if (!is_qt_asset || is_symbols || (!x86caps.hasAVX2 && is_avx2)) { // skip this asset continue; } int score; if (is_perfect_match) score = 4; // #1 choice is the one matching this binary else if (is_avx2) score = 3; // Prefer AVX2 over SSE4 (support test was done above) else if (is_sse4) score = 2; // Prefer SSE4 over one with no tags at all else score = 1; // Multi-ISA builds will have no tags, they'll only get picked because they're the only available build if (score > best_asset_score) { best_asset = std::move(asset_object); best_asset_score = score; } } if (best_asset_score == 0) { reportError("no matching assets found"); } else { m_latest_version = data_object["version"].toString(); m_latest_version_timestamp = QDateTime::fromString(data_object["publishedAt"].toString(), QStringLiteral("yyyy-MM-ddThh:mm:ss.zzzZ")); m_download_url = best_asset["url"].toString(); found_update_info = true; } } else { reportError("platform not found in assets array"); } } else { reportError("data is not an array"); } } else { reportError("JSON is not an object"); } } else { reportError("Failed to download latest release info: %d", static_cast(reply->error())); } if (found_update_info) checkIfUpdateNeeded(); emit updateCheckCompleted(); #endif } void AutoUpdaterDialog::queueGetChanges() { #ifdef AUTO_UPDATER_SUPPORTED connect(m_network_access_mgr, &QNetworkAccessManager::finished, this, &AutoUpdaterDialog::getChangesComplete); const QString url_string(QStringLiteral(CHANGES_URL).arg(GIT_HASH).arg(m_latest_version)); QUrl url(url_string); QNetworkRequest request(url); #if QT_VERSION < QT_VERSION_CHECK(6, 0, 0) request.setAttribute(QNetworkRequest::FollowRedirectsAttribute, true); #endif m_network_access_mgr->get(request); #endif } void AutoUpdaterDialog::getChangesComplete(QNetworkReply* reply) { #ifdef AUTO_UPDATER_SUPPORTED m_network_access_mgr->disconnect(this); reply->deleteLater(); if (reply->error() == QNetworkReply::NoError) { const QByteArray reply_json(reply->readAll()); QJsonParseError parse_error; QJsonDocument doc(QJsonDocument::fromJson(reply_json, &parse_error)); if (doc.isObject()) { const QJsonObject doc_object(doc.object()); QString changes_html = tr("

Changes:

"); changes_html += QStringLiteral("
    "); const QJsonArray commits(doc_object["commits"].toArray()); bool update_will_break_save_states = false; bool update_increases_settings_version = false; for (const QJsonValue& commit : commits) { const QJsonObject commit_obj(commit["commit"].toObject()); QString message = commit_obj["message"].toString(); QString author = commit_obj["author"].toObject()["name"].toString(); if (message.contains(QStringLiteral("[SAVEVERSION+]"))) update_will_break_save_states = true; if (message.contains(QStringLiteral("[SETTINGSVERSION+]"))) update_increases_settings_version = true; const int first_line_terminator = message.indexOf('\n'); if (first_line_terminator >= 0) message.remove(first_line_terminator, message.size() - first_line_terminator); if (!message.isEmpty()) { changes_html += QStringLiteral("
  • %1 (%2)
  • ").arg(message.toHtmlEscaped()).arg(author.toHtmlEscaped()); } } changes_html += "
"; if (update_will_break_save_states) { changes_html.prepend(tr("

Save State Warning

Installing this update will make your save states " "incompatible. Please ensure you have saved your games to a Memory Card " "before installing this update or you will lose progress.

")); } if (update_increases_settings_version) { changes_html.prepend( tr("

Settings Warning

Installing this update will reset your program configuration. Please note " "that you will have to reconfigure your settings after this update.

")); } m_ui.updateNotes->setText(changes_html); } else { reportError("Change list JSON is not an object"); } } else { reportError("Failed to download change list: %d", static_cast(reply->error())); } #endif m_ui.downloadAndInstall->setEnabled(true); } void AutoUpdaterDialog::downloadUpdateClicked() { m_display_messages = true; QUrl url(m_download_url); QNetworkRequest request(url); #if QT_VERSION < QT_VERSION_CHECK(6, 0, 0) request.setAttribute(QNetworkRequest::FollowRedirectsAttribute, true); #endif QNetworkReply* reply = m_network_access_mgr->get(request); QProgressDialog progress(tr("Downloading %1...").arg(m_download_url), tr("Cancel"), 0, 1); progress.setWindowTitle(tr("Automatic Updater")); progress.setWindowIcon(windowIcon()); progress.setAutoClose(false); connect(reply, &QNetworkReply::downloadProgress, [&progress](quint64 received, quint64 total) { progress.setRange(0, static_cast(total)); progress.setValue(static_cast(received)); }); connect(m_network_access_mgr, &QNetworkAccessManager::finished, [this, &progress](QNetworkReply* reply) { m_network_access_mgr->disconnect(); if (reply->error() != QNetworkReply::NoError) { reportError("Download failed: %s", reply->errorString().toUtf8().constData()); progress.done(-1); return; } const QByteArray data = reply->readAll(); if (data.isEmpty()) { reportError("Download failed: Update is empty"); progress.done(-1); return; } if (processUpdate(data, progress)) progress.done(1); else progress.done(-1); }); const int result = progress.exec(); if (result == 0) { // cancelled reply->abort(); } else if (result == 1) { // updater started. since we're a modal on the main window, we have to queue this. QMetaObject::invokeMethod(g_main_window, "requestExit", Qt::QueuedConnection, Q_ARG(bool, true)); done(0); } reply->deleteLater(); } void AutoUpdaterDialog::checkIfUpdateNeeded() { const QString last_checked_version( QString::fromStdString(Host::GetBaseStringSettingValue("AutoUpdater", "LastVersion"))); Console.WriteLn(Color_StrongGreen, "Current version: %s", GIT_TAG); Console.WriteLn(Color_StrongYellow, "Latest SHA: %s", m_latest_version.toUtf8().constData()); Console.WriteLn(Color_StrongOrange, "Last Checked SHA: %s", last_checked_version.toUtf8().constData()); if (m_latest_version == GIT_TAG || m_latest_version == last_checked_version) { Console.WriteLn(Color_StrongGreen, "No update needed."); if (m_display_messages) { QMessageBox::information(this, tr("Automatic Updater"), tr("No updates are currently available. Please try again later.")); } return; } Console.WriteLn(Color_StrongRed, "Update needed."); // Don't show the dialog if a game started while the update info was downloading. Some people have // really slow connections, apparently. If we're a manual triggered update check, then display // regardless. This will fall through and signal main to delete us. if (!m_display_messages && (QtHost::IsVMValid() || (g_emu_thread->isRunningFullscreenUI() && g_emu_thread->isFullscreen()))) { Console.WriteLn(Color_StrongRed, "Not showing update dialog due to active VM."); return; } m_ui.currentVersion->setText(tr("Current Version: %1 (%2)").arg(getCurrentVersion()).arg(getCurrentVersionDate())); m_ui.newVersion->setText(tr("New Version: %1 (%2)").arg(m_latest_version).arg(m_latest_version_timestamp.toString())); m_ui.updateNotes->setText(tr("Loading...")); queueGetChanges(); exec(); } void AutoUpdaterDialog::skipThisUpdateClicked() { Host::SetBaseStringSettingValue("AutoUpdater", "LastVersion", m_latest_version.toUtf8().constData()); Host::CommitBaseSettingChanges(); done(0); } void AutoUpdaterDialog::remindMeLaterClicked() { done(0); } #if defined(_WIN32) bool AutoUpdaterDialog::processUpdate(const QByteArray& update_data, QProgressDialog&) { const QString update_directory = QCoreApplication::applicationDirPath(); const QString update_zip_path = QStringLiteral("%1" FS_OSPATH_SEPARATOR_STR "%2").arg(update_directory).arg(UPDATER_ARCHIVE_NAME); const QString updater_path = QStringLiteral("%1" FS_OSPATH_SEPARATOR_STR "%2").arg(update_directory).arg(UPDATER_EXECUTABLE); Q_ASSERT(!update_zip_path.isEmpty() && !updater_path.isEmpty() && !update_directory.isEmpty()); if ((QFile::exists(update_zip_path) && !QFile::remove(update_zip_path)) || (QFile::exists(updater_path) && !QFile::remove(updater_path))) { reportError("Removing existing update zip/updater failed"); return false; } { QFile update_zip_file(update_zip_path); if (!update_zip_file.open(QIODevice::WriteOnly) || update_zip_file.write(update_data) != update_data.size()) { reportError("Writing update zip to '%s' failed", update_zip_path.toUtf8().constData()); return false; } update_zip_file.close(); } std::string updater_extract_error; if (!ExtractUpdater(update_zip_path.toUtf8().constData(), updater_path.toUtf8().constData(), &updater_extract_error)) { reportError("Extracting updater failed: %s", updater_extract_error.c_str()); return false; } if (!doUpdate(update_zip_path, updater_path, update_directory)) { reportError("Launching updater failed"); return false; } return true; } bool AutoUpdaterDialog::doUpdate(const QString& zip_path, const QString& updater_path, const QString& destination_path) { const QString program_path = QCoreApplication::applicationFilePath(); if (program_path.isEmpty()) { reportError("Failed to get current application path"); return false; } QStringList arguments; arguments << QString::number(QCoreApplication::applicationPid()); arguments << destination_path; arguments << zip_path; arguments << program_path; // this will leak, but not sure how else to handle it... QProcess* updater_process = new QProcess(); updater_process->setProgram(updater_path); updater_process->setArguments(arguments); updater_process->start(QIODevice::NotOpen); if (!updater_process->waitForStarted()) { reportError("Failed to start updater"); return false; } return true; } void AutoUpdaterDialog::cleanupAfterUpdate() { // Nothing to do on Windows for now, the updater stub cleans everything up. } #elif defined(__linux__) bool AutoUpdaterDialog::processUpdate(const QByteArray& update_data, QProgressDialog&) { const char* appimage_path = std::getenv("APPIMAGE"); if (!appimage_path || !FileSystem::FileExists(appimage_path)) { reportError("Missing APPIMAGE."); return false; } const QString qappimage_path(QString::fromUtf8(appimage_path)); if (!QFile::exists(qappimage_path)) { reportError("Current AppImage does not exist: %s", appimage_path); return false; } const QString new_appimage_path(qappimage_path + QStringLiteral(".new")); const QString backup_appimage_path(qappimage_path + QStringLiteral(".backup")); Console.WriteLn("APPIMAGE = %s", appimage_path); Console.WriteLn("Backup AppImage path = %s", backup_appimage_path.toUtf8().constData()); Console.WriteLn("New AppImage path = %s", new_appimage_path.toUtf8().constData()); // Remove old "new" appimage and existing backup appimage. if (QFile::exists(new_appimage_path) && !QFile::remove(new_appimage_path)) { reportError("Failed to remove old destination AppImage: %s", new_appimage_path.toUtf8().constData()); return false; } if (QFile::exists(backup_appimage_path) && !QFile::remove(backup_appimage_path)) { reportError("Failed to remove old backup AppImage: %s", new_appimage_path.toUtf8().constData()); return false; } // Write "new" appimage. { // We want to copy the permissions from the old appimage to the new one. QFile old_file(qappimage_path); const QFileDevice::Permissions old_permissions = old_file.permissions(); QFile new_file(new_appimage_path); if (!new_file.open(QIODevice::WriteOnly) || new_file.write(update_data) != update_data.size() || !new_file.setPermissions(old_permissions)) { QFile::remove(new_appimage_path); reportError("Failed to write new destination AppImage: %s", new_appimage_path.toUtf8().constData()); return false; } } // Rename "old" appimage. if (!QFile::rename(qappimage_path, backup_appimage_path)) { reportError("Failed to rename old AppImage to %s", backup_appimage_path.toUtf8().constData()); QFile::remove(new_appimage_path); return false; } // Rename "new" appimage. if (!QFile::rename(new_appimage_path, qappimage_path)) { reportError("Failed to rename new AppImage to %s", qappimage_path.toUtf8().constData()); return false; } // Execute new appimage. QProcess* new_process = new QProcess(); new_process->setProgram(qappimage_path); new_process->setArguments(QStringList{QStringLiteral("-updatecleanup")}); if (!new_process->startDetached()) { reportError("Failed to execute new AppImage."); return false; } // We exit once we return. return true; } void AutoUpdaterDialog::cleanupAfterUpdate() { // Remove old/backup AppImage. const char* appimage_path = std::getenv("APPIMAGE"); if (!appimage_path) return; const QString qappimage_path(QString::fromUtf8(appimage_path)); const QString backup_appimage_path(qappimage_path + QStringLiteral(".backup")); if (!QFile::exists(backup_appimage_path)) return; Console.WriteLn(Color_StrongOrange, QStringLiteral("Removing backup AppImage %1").arg(backup_appimage_path).toStdString()); if (!QFile::remove(backup_appimage_path)) Console.Error(QStringLiteral("Failed to remove backup AppImage %1").arg(backup_appimage_path).toStdString()); } #elif defined(__APPLE__) static QString UpdateVersionNumberInName(QString name, QStringView new_version) { QString current_version_string = QStringLiteral(GIT_TAG); QStringView current_version = current_version_string; if (!current_version.empty() && !new_version.empty() && current_version[0] == 'v' && new_version[0] == 'v') { current_version = current_version.mid(1); new_version = new_version.mid(1); } if (!current_version.empty() && !new_version.empty()) name.replace(current_version.data(), current_version.size(), new_version.data(), new_version.size()); return name; } bool AutoUpdaterDialog::processUpdate(const QByteArray& update_data, QProgressDialog& progress) { std::optional path = CocoaTools::GetNonTranslocatedBundlePath(); if (!path.has_value()) { reportError("Couldn't get bundle path"); return false; } QFileInfo info(QString::fromStdString(*path)); if (!info.isBundle()) { reportError("Application %s isn't a bundle", path->c_str()); return false; } if (info.suffix() != QStringLiteral("app")) { reportError("Unexpected application suffix %s on %s", info.suffix().toUtf8().constData(), path->c_str()); return false; } QString open_path; { QTemporaryDir temp_dir(info.path() + QStringLiteral("/PCSX2-UpdateStaging-XXXXXX")); if (!temp_dir.isValid()) { reportError("Failed to create update staging directory"); return false; } constexpr qsizetype chunk_size = 65536; progress.setLabelText(QStringLiteral("Unpacking update...")); progress.reset(); progress.setRange(0, static_cast((update_data.size() + chunk_size - 1) / chunk_size)); QProcess untar; untar.setProgram(QStringLiteral("/usr/bin/tar")); untar.setArguments({QStringLiteral("xC"), temp_dir.path()}); untar.start(); for (qsizetype i = 0; i < update_data.size(); i += chunk_size) { progress.setValue(static_cast(i / chunk_size)); const qsizetype amt = std::min(update_data.size() - i, chunk_size); if (progress.wasCanceled() || untar.write(update_data.data() + i, amt) != amt) { if (!progress.wasCanceled()) reportError("Failed to unpack update (write stopped short)"); untar.closeWriteChannel(); if (!untar.waitForFinished(1000)) untar.kill(); return false; } } untar.closeWriteChannel(); while (!untar.waitForFinished(1000)) { if (progress.wasCanceled()) { untar.kill(); return false; } } progress.setValue(progress.maximum()); if (untar.exitCode() != EXIT_SUCCESS) { reportError("Failed to unpack update (tar exited with %u)", untar.exitCode()); return false; } QFileInfoList temp_dir_contents = QDir(temp_dir.path()).entryInfoList(QDir::Filter::Dirs | QDir::Filter::NoDotAndDotDot); auto new_app = std::find_if(temp_dir_contents.begin(), temp_dir_contents.end(), [](const QFileInfo& file){ return file.suffix() == QStringLiteral("app"); }); if (new_app == temp_dir_contents.end()) { reportError("Couldn't find application in update package"); return false; } QString new_name = UpdateVersionNumberInName(info.completeBaseName(), m_latest_version); std::optional trashed_path = CocoaTools::MoveToTrash(*path); if (!trashed_path.has_value()) { reportError("Failed to trash old application"); return false; } open_path = info.path() + QStringLiteral("/") + new_name + QStringLiteral(".app"); if (!QFile::rename(new_app->absoluteFilePath(), open_path)) { QFile::rename(QString::fromStdString(*trashed_path), info.filePath()); reportError("Failed to move new application into place (couldn't rename '%s' to '%s')", new_app->absoluteFilePath().toUtf8().constData(), open_path.toUtf8().constData()); return false; } QDir(QString::fromStdString(*trashed_path)).removeRecursively(); } if (!CocoaTools::LaunchApplication(open_path.toStdString())) { reportError("Failed to start new application"); return false; } return true; } void AutoUpdaterDialog::cleanupAfterUpdate() { } #else bool AutoUpdaterDialog::processUpdate(const QByteArray& update_data, QProgressDialog& progress) { return false; } void AutoUpdaterDialog::cleanupAfterUpdate() { } #endif