Git-Mirrors/keepassxc
1
0
Fork 0
mirror of https://github.com/keepassxreboot/keepassxc.git synced 2024-10-01 01:26:01 -04:00
Code Issues Packages Projects Releases Wiki Activity

Enhance update checker

Browse Source 
* Reduce initial update check notification to 500 ms to prevent inappropriately stealing focus from user
* Add build flag WITH_XC_UPDATECHECK which defaults to ON
* Update checks are resolved every 7 days instead of every time the application is started
* Better checks for beta builds; ignore snapshots
* Increase test cases
This commit is contained in:
Jonathan White 2019-04-09 21:06:13 -04:00
parent 53a57ee8c7
commit 2ffefc95ae
11 changed files with 139 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CMakeLists.txt
View File

@ -49,6 +49,7 @@ option(WITH_XC_YUBIKEY "Include YubiKey support." OFF)
option(WITH_XC_SSHAGENT "Include SSH agent support." OFF)
option(WITH_XC_KEESHARE "Sharing integration with KeeShare" OFF)
option(WITH_XC_KEESHARE_SECURE "Sharing integration with secured KeeShare containers" OFF)
option(WITH_XC_UPDATECHECK "Include automatic update checks; disable for controlled distributions" ON)
if(APPLE)
option(WITH_XC_TOUCHID "Include TouchID support for macOS." OFF)
endif()
@ -76,6 +77,10 @@ else()
set(WITH_XC_CRYPTO_SSH OFF)
endif()
if(WITH_XC_UPDATECHECK)
set(WITH_XC_NETWORKING ON)
endif()
set(KEEPASSXC_VERSION_MAJOR "2")
set(KEEPASSXC_VERSION_MINOR "4")
set(KEEPASSXC_VERSION_PATCH "0")

1
src/CMakeLists.txt
View File

@ -195,6 +195,7 @@ add_feature_info(SSHAgent WITH_XC_SSHAGENT "SSH agent integration compatible wit
add_feature_info(KeeShare WITH_XC_KEESHARE "Sharing integration with KeeShare")
add_feature_info(KeeShare-Secure WITH_XC_KEESHARE_SECURE "Sharing integration with KeeShare with secure sources")
add_feature_info(YubiKey WITH_XC_YUBIKEY "YubiKey HMAC-SHA1 challenge-response")
add_feature_info(UpdateCheck WITH_XC_UPDATECHECK "Automatic update checking")
if(APPLE)
add_feature_info(TouchID WITH_XC_TOUCHID "TouchID integration")
endif()

1
src/config-keepassx.h.cmake
View File

@ -20,6 +20,7 @@
#cmakedefine WITH_XC_KEESHARE
#cmakedefine WITH_XC_KEESHARE_INSECURE
#cmakedefine WITH_XC_KEESHARE_SECURE
#cmakedefine WITH_XC_UPDATECHECK
#cmakedefine WITH_XC_TOUCHID
#cmakedefine KEEPASSXC_BUILD_TYPE "@KEEPASSXC_BUILD_TYPE@"

1
src/core/Clock.cpp
View File

@ -30,6 +30,7 @@ QDateTime Clock::currentDateTime()
uint Clock::currentSecondsSinceEpoch()
{
// TODO: change to toSecsSinceEpoch() when min Qt >= 5.8
return instance().currentDateTimeImpl().toTime_t();
}

14
src/gui/ApplicationSettingsWidget.cpp
View File

@ -92,8 +92,15 @@ ApplicationSettingsWidget::ApplicationSettingsWidget(QWidget* parent)
m_secUi->touchIDResetSpinBox, SLOT(setEnabled(bool)));
// clang-format on
#ifndef WITH_XC_NETWORKING
#ifdef WITH_XC_UPDATECHECK
connect(m_generalUi->checkForUpdatesOnStartupCheckBox, SIGNAL(toggled(bool)), SLOT(checkUpdatesToggled(bool)));
#else
m_generalUi->checkForUpdatesOnStartupCheckBox->setVisible(false);
m_generalUi->checkForUpdatesIncludeBetasCheckBox->setVisible(false);
m_generalUi->checkUpdatesSpacer->changeSize(0,0, QSizePolicy::Fixed, QSizePolicy::Fixed);
#endif
#ifndef WITH_XC_NETWORKING
m_secUi->privacy->setVisible(false);
#endif
@ -350,3 +357,8 @@ void ApplicationSettingsWidget::rememberDatabasesToggled(bool checked)
m_generalUi->rememberLastKeyFilesCheckBox->setEnabled(checked);
m_generalUi->openPreviousDatabasesOnStartupCheckBox->setEnabled(checked);
}
void ApplicationSettingsWidget::checkUpdatesToggled(bool checked)
{
m_generalUi->checkForUpdatesIncludeBetasCheckBox->setEnabled(checked);
}

1
src/gui/ApplicationSettingsWidget.h
View File

@ -57,6 +57,7 @@ private slots:
void systrayToggled(bool checked);
void toolbarSettingsToggled(bool checked);
void rememberDatabasesToggled(bool checked);
void checkUpdatesToggled(bool checked);
private:
QWidget* const m_secWidget;

39
src/gui/ApplicationSettingsWidgetGeneral.ui
View File

@ -141,10 +141,40 @@
<item>
<widget class="QCheckBox" name="checkForUpdatesOnStartupCheckBox">
<property name="text">
<string>Check for updates at application startup</string>
<string>Check for updates at application startup once per week</string>
</property>
</widget>
</item>
<item>
<layout class="QHBoxLayout" name="checkUpdatesSubLayout">
<property name="spacing">
<number>0</number>
</property>
<item>
<spacer name="checkUpdatesSpacer">
<property name="orientation">
<enum>Qt::Horizontal</enum>
</property>
<property name="sizeType">
<enum>QSizePolicy::Fixed</enum>
</property>
<property name="sizeHint" stdset="0">
<size>
<width>20</width>
<height>20</height>
</size>
</property>
</spacer>
</item>
<item>
<widget class="QCheckBox" name="checkForUpdatesIncludeBetasCheckBox">
<property name="text">
<string>Include beta releases when checking for updates</string>
</property>
</widget>
</item>
</layout>
</item>
</layout>
</widget>
</item>
@ -241,13 +271,6 @@
<string>General</string>
</property>
<layout class="QVBoxLayout" name="verticalLayout_7">
<item>
<widget class="QCheckBox" name="checkForUpdatesIncludeBetasCheckBox">
<property name="text">
<string>Include pre-releases when checking for updates</string>
</property>
</widget>
</item>
<item>
<widget class="QCheckBox" name="toolbarHideCheckBox">
<property name="text">

12
src/gui/MainWindow.cpp
View File

@ -41,7 +41,7 @@
#include "keys/FileKey.h"
#include "keys/PasswordKey.h"
#ifdef WITH_XC_NETWORKING
#ifdef WITH_XC_UPDATECHECK
#include "gui/MessageBox.h"
#include "gui/UpdateCheckDialog.h"
#include "updatecheck/UpdateChecker.h"
@ -372,12 +372,12 @@ MainWindow::MainWindow()
setUnifiedTitleAndToolBarOnMac(true);
#endif
#ifdef WITH_XC_NETWORKING
#ifdef WITH_XC_UPDATECHECK
connect(m_ui->actionCheckForUpdates, SIGNAL(triggered()), SLOT(showUpdateCheckDialog()));
connect(UpdateChecker::instance(),
SIGNAL(updateCheckFinished(bool, QString, bool)),
SLOT(hasUpdateAvailable(bool, QString, bool)));
QTimer::singleShot(3000, this, SLOT(showUpdateCheckStartup()));
QTimer::singleShot(500, this, SLOT(showUpdateCheckStartup()));
#else
m_ui->actionCheckForUpdates->setVisible(false);
#endif
@ -670,7 +670,7 @@ void MainWindow::showAboutDialog()
void MainWindow::showUpdateCheckStartup()
{
#ifdef WITH_XC_NETWORKING
#ifdef WITH_XC_UPDATECHECK
if (!config()->get("UpdateCheckMessageShown", false).toBool()) {
auto result =
MessageBox::question(this,
@ -693,7 +693,7 @@ void MainWindow::showUpdateCheckStartup()
void MainWindow::hasUpdateAvailable(bool hasUpdate, const QString& version, bool isManuallyRequested)
{
#ifdef WITH_XC_NETWORKING
#ifdef WITH_XC_UPDATECHECK
if (hasUpdate && !isManuallyRequested) {
auto* updateCheckDialog = new UpdateCheckDialog(this);
updateCheckDialog->showUpdateCheckResponse(hasUpdate, version);
@ -708,7 +708,7 @@ void MainWindow::hasUpdateAvailable(bool hasUpdate, const QString& version, bool
void MainWindow::showUpdateCheckDialog()
{
#ifdef WITH_XC_NETWORKING
#ifdef WITH_XC_UPDATECHECK
updateCheck()->checkForUpdates(true);
auto* updateCheckDialog = new UpdateCheckDialog(this);
updateCheckDialog->show();

87
src/updatecheck/UpdateChecker.cpp
View File

@ -17,6 +17,7 @@
#include "UpdateChecker.h"
#include "config-keepassx.h"
#include "core/Clock.h"
#include "core/Config.h"
#include <QJsonObject>
#include <QNetworkAccessManager>
@ -38,24 +39,28 @@ UpdateChecker::~UpdateChecker()
void UpdateChecker::checkForUpdates(bool manuallyRequested)
{
auto nextCheck = config()->get("GUI/CheckForUpdatesNextCheck", 0).toULongLong();
m_isManuallyRequested = manuallyRequested;
m_bytesReceived.clear();
QString apiUrlStr = QString("https://api.github.com/repos/keepassxreboot/keepassxc/releases");
if (m_isManuallyRequested || Clock::currentSecondsSinceEpoch() >= nextCheck) {
m_bytesReceived.clear();
if (!config()->get("GUI/CheckForUpdatesIncludeBetas", false).toBool()) {
apiUrlStr += "/latest";
QString apiUrlStr = QString("https://api.github.com/repos/keepassxreboot/keepassxc/releases");
if (!config()->get("GUI/CheckForUpdatesIncludeBetas", false).toBool()) {
apiUrlStr += "/latest";
}
QUrl apiUrl = QUrl(apiUrlStr);
QNetworkRequest request(apiUrl);
request.setRawHeader("Accept", "application/json");
m_reply = m_netMgr->get(request);
connect(m_reply, &QNetworkReply::finished, this, &UpdateChecker::fetchFinished);
connect(m_reply, &QIODevice::readyRead, this, &UpdateChecker::fetchReadyRead);
}
QUrl apiUrl = QUrl(apiUrlStr);
QNetworkRequest request(apiUrl);
request.setRawHeader("Accept", "application/json");
m_reply = m_netMgr->get(request);
connect(m_reply, &QNetworkReply::finished, this, &UpdateChecker::fetchFinished);
connect(m_reply, &QIODevice::readyRead, this, &UpdateChecker::fetchReadyRead);
}
void UpdateChecker::fetchReadyRead()
@ -84,8 +89,12 @@ void UpdateChecker::fetchFinished()
if (!jsonObject.value("tag_name").isUndefined()) {
version = jsonObject.value("tag_name").toString();
hasNewVersion = compareVersions(version, QString(KEEPASSXC_VERSION));
hasNewVersion = compareVersions(QString(KEEPASSXC_VERSION), version);
}
// Check again in 7 days
// TODO: change to toSecsSinceEpoch() when min Qt >= 5.8
config()->set("GUI/CheckForUpdatesNextCheck", Clock::currentDateTime().addDays(7).toTime_t());
} else {
version = "error";
}
@ -93,38 +102,46 @@ void UpdateChecker::fetchFinished()
emit updateCheckFinished(hasNewVersion, version, m_isManuallyRequested);
}
bool UpdateChecker::compareVersions(const QString& remoteVersion, const QString& localVersion)
bool UpdateChecker::compareVersions(const QString& localVersion, const QString& remoteVersion)
{
// Quick full-string equivalence check
if (localVersion == remoteVersion) {
return false; // Currently using updated version
return false;
}
QRegularExpression verRegex("^(\\d+(\\.\\d+){0,2})(-\\w+)?$", QRegularExpression::CaseInsensitiveOption);
QRegularExpression verRegex(R"(^((?:\d+\.){2}\d+)(?:-(\w+?)(\d+)?)?$)");
QRegularExpressionMatch lmatch = verRegex.match(localVersion);
QRegularExpressionMatch rmatch = verRegex.match(remoteVersion);
auto lmatch = verRegex.match(localVersion);
auto rmatch = verRegex.match(remoteVersion);
if (!lmatch.captured(1).isNull() && !rmatch.captured(1).isNull()) {
if (lmatch.captured(1) == rmatch.captured(1) && !lmatch.captured(3).isNull()) {
// Same version, but installed version has snapshot/beta suffix and should be updated to stable
return true;
auto lVersion = lmatch.captured(1).split(".");
auto lSuffix = lmatch.captured(2);
auto lBetaNum = lmatch.captured(3);
auto rVersion = rmatch.captured(1).split(".");
auto rSuffix = rmatch.captured(2);
auto rBetaNum = rmatch.captured(3);
if (!lVersion.isEmpty() && !rVersion.isEmpty()) {
if (lSuffix.compare("snapshot", Qt::CaseInsensitive) == 0) {
// Snapshots are not checked for version updates
return false;
}
QStringList lparts = lmatch.captured(1).split(".");
QStringList rparts = rmatch.captured(1).split(".");
if (lparts.length() < 3)
lparts << "0";
if (rparts.length() < 3)
rparts << "0";
// Check "-beta[X]" versions
if (lVersion == rVersion && !lSuffix.isEmpty()) {
// Check if stable version has been released or new beta is available
// otherwise the version numbers are equal
return rSuffix.isEmpty() || lBetaNum.toInt() < rBetaNum.toInt();
}
for (int i = 0; i < 3; i++) {
int l = lparts[i].toInt();
int r = rparts[i].toInt();
int l = lVersion[i].toInt();
int r = rVersion[i].toInt();
if (l == r)
if (l == r) {
continue;
}
if (l > r) {
return false; // Installed version is newer than release

2
src/updatecheck/UpdateChecker.h
View File

@ -31,7 +31,7 @@ public:
~UpdateChecker() override;
void checkForUpdates(bool manuallyRequested);
static bool compareVersions(const QString& remoteVersion, const QString& localVersion);
static bool compareVersions(const QString& localVersion, const QString& remoteVersion);
static UpdateChecker* instance();
signals:

35
tests/TestUpdateCheck.cpp
View File

@ -29,13 +29,32 @@ void TestUpdateCheck::initTestCase()
void TestUpdateCheck::testCompareVersion()
{
// Remote Version , Installed Version
QCOMPARE(UpdateChecker::compareVersions(QString("2.4.0"), QString("2.3.4")), true);
QCOMPARE(UpdateChecker::compareVersions(QString("2.3.0"), QString("2.4.0")), false);
// No upgrade
QCOMPARE(UpdateChecker::compareVersions(QString("2.3.0"), QString("2.3.0")), false);
QCOMPARE(UpdateChecker::compareVersions(QString("2.3.0"), QString("2.3.0-beta1")), true);
QCOMPARE(UpdateChecker::compareVersions(QString("2.3.0-beta2"), QString("2.3.0-beta1")), true);
QCOMPARE(UpdateChecker::compareVersions(QString("2.3.4"), QString("2.4.0-snapshot")), false);
QCOMPARE(UpdateChecker::compareVersions(QString("invalid"), QString("2.4.0")), false);
QCOMPARE(UpdateChecker::compareVersions(QString(""), QString("2.4.0")), false);
// First digit upgrade
QCOMPARE(UpdateChecker::compareVersions(QString("2.4.0"), QString("3.0.0")), true);
QCOMPARE(UpdateChecker::compareVersions(QString("3.0.0"), QString("2.4.0")), false);
// Second digit upgrade
QCOMPARE(UpdateChecker::compareVersions(QString("2.3.4"), QString("2.4.0")), true);
QCOMPARE(UpdateChecker::compareVersions(QString("2.4.0"), QString("2.3.4")), false);
// Third digit upgrade
QCOMPARE(UpdateChecker::compareVersions(QString("2.3.0"), QString("2.3.1")), true);
QCOMPARE(UpdateChecker::compareVersions(QString("2.3.1"), QString("2.3.0")), false);
// Beta builds
QCOMPARE(UpdateChecker::compareVersions(QString("2.3.0"), QString("2.3.0-beta1")), false);
QCOMPARE(UpdateChecker::compareVersions(QString("2.3.0"), QString("2.3.1-beta1")), true);
QCOMPARE(UpdateChecker::compareVersions(QString("2.3.0-beta1"), QString("2.3.0")), true);
QCOMPARE(UpdateChecker::compareVersions(QString("2.3.0-beta"), QString("2.3.0-beta1")), true);
QCOMPARE(UpdateChecker::compareVersions(QString("2.3.0-beta1"), QString("2.3.0-beta")), false);
QCOMPARE(UpdateChecker::compareVersions(QString("2.3.0-beta1"), QString("2.3.0-beta2")), true);
QCOMPARE(UpdateChecker::compareVersions(QString("2.3.0-beta2"), QString("2.3.0-beta1")), false);
// Snapshot and invalid data
QCOMPARE(UpdateChecker::compareVersions(QString("2.3.4-snapshot"), QString("2.4.0")), false);
QCOMPARE(UpdateChecker::compareVersions(QString("2.4.0"), QString("invalid")), false);
QCOMPARE(UpdateChecker::compareVersions(QString("2.4.0"), QString("")), false);
}